*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Gnus 5.4 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @iftex
9 @finalout
10 @end iftex
11 @setchapternewpage odd
12
13 @iftex
14 @iflatex
15 \documentclass[twoside,a4paper,openright]{book}
16 \usepackage[latin1]{inputenc}
17 \usepackage{pagestyle}
18 \usepackage{epsfig}
19 \fontfamily{bembo}\selectfont
20
21 \makeindex
22 \begin{document}
23
24 \newcommand{\gnuschaptername}{}
25 \newcommand{\gnussectionname}{}
26
27 \newcommand{\gnusbackslash}{/}
28
29 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
30 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
31
32 \newcommand{\gnuskindex}[1]{\index{#1}}
33 \newcommand{\gnusindex}[1]{\index{#1}}
34
35 \newcommand{\gnustt}[1]{{\textbf{\textsf{#1}}}}
36 \newcommand{\gnuscode}[1]{\gnustt{#1}}
37 \newcommand{\gnussamp}[1]{``\gnustt{#1}''}
38 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
39 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
40 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
41 \newcommand{\gnusdfn}[1]{\textit{#1}}
42 \newcommand{\gnusi}[1]{\textit{#1}}
43 \newcommand{\gnusstrong}[1]{\textbf{#1}}
44 \newcommand{\gnusemph}[1]{\textit{#1}}
45 \newcommand{\gnusvar}[1]{\textsl{\textsf{#1}}}
46 \newcommand{\gnussc}[1]{\textsc{#1}}
47 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
48 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
49
50 \newcommand{\gnusbullet}{{${\bullet}$}}
51 \newcommand{\gnusdollar}{\$}
52 \newcommand{\gnusampersand}{\&}
53 \newcommand{\gnuspercent}{\%}
54 \newcommand{\gnushash}{\#}
55 \newcommand{\gnushat}{\symbol{"5E}}
56 \newcommand{\gnusunderline}{\symbol{"5F}}
57 \newcommand{\gnusnot}{$\neg$}
58 \newcommand{\gnustilde}{\symbol{"7E}}
59 \newcommand{\gnusless}{{$<$}}
60 \newcommand{\gnusgreater}{{$>$}}
61
62 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=gnus-head.eps,height=1cm}}}
63 \newcommand{\gnusinteresting}{
64 \marginpar[\hspace{2.5cm}\gnushead]{\gnushead}
65 }
66
67 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
68
69 \newcommand{\gnuspagechapter}[1]{
70 {\mbox{}}
71 }
72
73 \newdimen{\gnusdimen}
74 \gnusdimen 0pt
75
76 \newcommand{\gnuschapter}[2]{
77 \gnuscleardoublepage
78 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
79 \chapter{#2}
80 \renewcommand{\gnussectionname}{}
81 \renewcommand{\gnuschaptername}{#2}
82 \thispagestyle{empty}
83 \hspace*{-2cm}
84 \begin{picture}(500,500)(0,0)
85 \put(0,0){\makebox(480,350)[tr]{#1}}
86 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
87 \end{picture}
88 \clearpage
89 }
90
91 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
92
93 \newcommand{\gnussection}[1]{
94 \renewcommand{\gnussectionname}{#1}
95 \section{#1}
96 }
97
98 \newenvironment{codelist}%
99 {\begin{list}{}{
100 }
101 }{\end{list}}
102
103 \newenvironment{kbdlist}%
104 {\begin{list}{}{
105 \labelwidth=0cm
106 }
107 }{\end{list}}
108
109 \newenvironment{dfnlist}%
110 {\begin{list}{}{
111 }
112 }{\end{list}}
113
114 \newenvironment{stronglist}%
115 {\begin{list}{}{
116 }
117 }{\end{list}}
118
119 \newenvironment{samplist}%
120 {\begin{list}{}{
121 }
122 }{\end{list}}
123
124 \newenvironment{varlist}%
125 {\begin{list}{}{
126 }
127 }{\end{list}}
128
129 \newenvironment{emphlist}%
130 {\begin{list}{}{
131 }
132 }{\end{list}}
133
134 \newlength\gnusheadtextwidth
135 \setlength{\gnusheadtextwidth}{\headtextwidth}
136 \addtolength{\gnusheadtextwidth}{1cm}
137
138 \newpagestyle{gnuspreamble}%
139 {
140 {
141 \ifodd\count0
142 {
143 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
144 }
145 \else
146 {
147 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
148 }
149 }
150 \fi
151 }
152 }
153 {
154 \ifodd\count0
155 \mbox{} \hfill 
156 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
157 \else
158 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
159 \hfill \mbox{}
160 \fi
161 }
162
163 \newpagestyle{gnusindex}%
164 {
165 {
166 \ifodd\count0
167 {
168 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
169 }
170 \else
171 {
172 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
173 }
174 \fi
175 }
176 }
177 {
178 \ifodd\count0
179 \mbox{} \hfill 
180 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
181 \else
182 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
183 \hfill \mbox{}
184 \fi
185 }
186
187 \newpagestyle{gnus}%
188 {
189 {
190 \ifodd\count0
191 {
192 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}
193 }
194 \else
195 {
196 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
197 }
198 \fi
199 }
200 }
201 {
202 \ifodd\count0
203 \mbox{} \hfill 
204 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
205 \else
206 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
207 \hfill \mbox{}
208 \fi
209 }
210
211 \pagenumbering{roman}
212 \pagestyle{gnuspreamble}
213
214 @end iflatex
215 @end iftex
216
217 @iftex
218 @iflatex
219 \begin{titlepage}
220 {
221
222 %\addtolength{\oddsidemargin}{-5cm}
223 %\addtolength{\evensidemargin}{-5cm}
224 \parindent=0cm
225 \addtolength{\textheight}{2cm}
226
227 \gnustitle{\gnustitlename}\\
228 \rule{15cm}{1mm}\\
229 \vfill
230 \hspace*{-1cm}\epsfig{figure=gnus-big-logo.eps,height=15cm}
231 \vfill
232 \rule{15cm}{1mm}\\
233 \gnusauthor{by Lars Magne Ingebrigtsen}
234 \newpage
235 }
236
237 \mbox{}
238 \vfill
239
240 \thispagestyle{empty}
241
242 Copyright \copyright{} 1995,96 Free Software Foundation, Inc. 
243
244 Permission is granted to make and distribute verbatim copies of
245 this manual provided the copyright notice and this permission notice
246 are preserved on all copies.
247
248 Permission is granted to copy and distribute modified versions of this
249 manual under the conditions for verbatim copying, provided that the
250 entire resulting derived work is distributed under the terms of a
251 permission notice identical to this one.
252
253 Permission is granted to copy and distribute translations of this manual
254 into another language, under the above conditions for modified versions.
255
256 \newpage
257 \end{titlepage}
258 @end iflatex
259 @end iftex
260
261 @ifinfo
262
263 This file documents Gnus, the GNU Emacs newsreader.
264
265 Copyright (C) 1995,96 Free Software Foundation, Inc.
266
267 Permission is granted to make and distribute verbatim copies of
268 this manual provided the copyright notice and this permission notice
269 are preserved on all copies.
270
271 @ignore
272 Permission is granted to process this file through Tex and print the
273 results, provided the printed document carries copying permission
274 notice identical to this one except for the removal of this paragraph
275 (this paragraph not being relevant to the printed manual).
276
277 @end ignore
278 Permission is granted to copy and distribute modified versions of this
279 manual under the conditions for verbatim copying, provided also that the
280 entire resulting derived work is distributed under the terms of a
281 permission notice identical to this one.
282
283 Permission is granted to copy and distribute translations of this manual
284 into another language, under the above conditions for modified versions.
285 @end ifinfo
286
287 @tex
288
289 @titlepage
290 @title Gnus 5.4 Manual
291
292 @author by Lars Magne Ingebrigtsen
293 @page
294
295 @vskip 0pt plus 1filll
296 Copyright @copyright{} 1995,96 Free Software Foundation, Inc. 
297
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
301
302 Permission is granted to copy and distribute modified versions of this
303 manual under the conditions for verbatim copying, provided that the
304 entire resulting derived work is distributed under the terms of a
305 permission notice identical to this one.
306
307 Permission is granted to copy and distribute translations of this manual
308 into another language, under the above conditions for modified versions.
309
310 @end titlepage
311 @page
312
313 @end tex
314
315
316 @node Top
317 @top The Gnus Newsreader
318
319 @ifinfo
320
321 You can read news (and mail) from within Emacs by using Gnus.  The news
322 can be gotten by any nefarious means you can think of---@sc{nntp}, local
323 spool or your mbox file.  All at the same time, if you want to push your
324 luck.
325
326 This manual corresponds to Gnus 5.4.
327
328 @end ifinfo
329
330 @iftex
331
332 @iflatex
333 \tableofcontents
334 \gnuscleardoublepage
335 @end iflatex
336
337 Gnus is the advanced, self-documenting, customizable, extensible
338 unreal-time newsreader for GNU Emacs.  
339
340 Oops.  That sounds oddly familiar, so let's start over again to avoid
341 being accused of plagiarism:
342
343 Gnus is a message-reading laboratory.  It will let you look at just
344 about anything as if it were a newsgroup.  You can read mail with it,
345 you can browse directories with it, you can @code{ftp} with it---you can
346 even read news with it!
347
348 Gnus tries to empower people who read news the same way Emacs empowers
349 people who edit text.  Gnus sets no limits to what the user should be
350 allowed to do.  Users are encouraged to extend Gnus to make it behave
351 like they want it to behave.  A program should not control people;
352 people should be empowered to do what they want by using (or abusing)
353 the program.
354
355 @end iftex
356
357
358 @menu
359 * Starting Up::           Finding news can be a pain.
360 * The Group Buffer::      Selecting, subscribing and killing groups.
361 * The Summary Buffer::    Reading, saving and posting articles.
362 * The Article Buffer::    Displaying and handling articles.
363 * Composing Messages::    Information on sending mail and news.
364 * Select Methods::        Gnus reads all messages from various select methods.
365 * Scoring::               Assigning values to articles.
366 * Various::               General purpose settings.
367 * The End::               Farewell and goodbye.
368 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
369 * Index::                 Variable, function and concept index.
370 * Key Index::             Key Index.
371 @end menu
372
373 @node Starting Up
374 @chapter Starting Gnus
375 @cindex starting up
376
377 @kindex M-x gnus
378 @findex gnus
379 If your system administrator has set things up properly, starting Gnus
380 and reading news is extremely easy---you just type @kbd{M-x gnus} in
381 your Emacs. 
382
383 @findex gnus-other-frame
384 @kindex M-x gnus-other-frame
385 If you want to start Gnus in a different frame, you can use the command
386 @kbd{M-x gnus-other-frame} instead.
387
388 If things do not go smoothly at startup, you have to twiddle some
389 variables. 
390
391 @menu
392 * Finding the News::    Choosing a method for getting news.
393 * The First Time::      What does Gnus do the first time you start it?
394 * The Server is Down::  How can I read my mail then?
395 * Slave Gnusae::        You can have more than one Gnus active at a time.
396 * Fetching a Group::    Starting Gnus just to read a group.
397 * New Groups::          What is Gnus supposed to do with new groups?
398 * Startup Files::       Those pesky startup files---@file{.newsrc}.
399 * Auto Save::           Recovering from a crash.
400 * The Active File::     Reading the active file over a slow line Takes Time.
401 * Changing Servers::    You may want to move from one server to another.
402 * Startup Variables::   Other variables you might change.
403 @end menu
404
405
406 @node Finding the News
407 @section Finding the News
408 @cindex finding news
409
410 @vindex gnus-select-method
411 @c @head
412 The @code{gnus-select-method} variable says where Gnus should look for
413 news.  This variable should be a list where the first element says
414 @dfn{how} and the second element says @dfn{where}.  This method is your
415 native method.  All groups that are not fetched with this method are
416 foreign groups.
417
418 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
419 you want to get your daily dosage of news from, you'd say:
420
421 @lisp
422 (setq gnus-select-method '(nntp "news.somewhere.edu"))
423 @end lisp
424
425 If you want to read directly from the local spool, say:
426
427 @lisp
428 (setq gnus-select-method '(nnspool ""))
429 @end lisp
430
431 If you can use a local spool, you probably should, as it will almost
432 certainly be much faster.
433
434 @vindex gnus-nntpserver-file
435 @cindex NNTPSERVER
436 @cindex @sc{nntp} server
437 If this variable is not set, Gnus will take a look at the
438 @code{NNTPSERVER} environment variable.  If that variable isn't set,
439 Gnus will see whether @code{gnus-nntpserver-file}
440 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
441 that fails as well, Gnus will will try to use the machine that is
442 running Emacs as an @sc{nntp} server.  That's a long shot, though.
443
444 @vindex gnus-nntp-server
445 If @code{gnus-nntp-server} is set, this variable will override
446 @code{gnus-select-method}.  You should therefore set
447 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
448
449 @vindex gnus-secondary-servers
450 You can also make Gnus prompt you interactively for the name of an
451 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
452 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
453 in the @code{gnus-secondary-servers} list (if any).  You can also just
454 type in the name of any server you feel like visiting.
455
456 @findex gnus-group-browse-foreign-server
457 @kindex B (Group)
458 However, if you use one @sc{nntp} server regularly and are just
459 interested in a couple of groups from a different server, you would be
460 better served by using the @kbd{B} command in the group buffer.  It will
461 let you have a look at what groups are available, and you can subscribe
462 to any of the groups you want to.  This also makes @file{.newsrc}
463 maintenance much tidier.  @xref{Foreign Groups}.
464
465 @vindex gnus-secondary-select-methods
466 @c @head
467 A slightly different approach to foreign groups is to set the
468 @code{gnus-secondary-select-methods} variable.  The select methods
469 listed in this variable are in many ways just as native as the
470 @code{gnus-select-method} server.  They will also be queried for active
471 files during startup (if that's required), and new newsgroups that
472 appear on these servers will be subscribed (or not) just as native
473 groups are.
474
475 For instance, if you use the @code{nnmbox} backend to read your mail, you
476 would typically set this variable to
477
478 @lisp
479 (setq gnus-secondary-select-methods '((nnmbox "")))
480 @end lisp
481
482
483 @node The First Time
484 @section The First Time
485 @cindex first time usage
486
487 If no startup files exist, Gnus will try to determine what groups should
488 be subscribed by default.
489
490 @vindex gnus-default-subscribed-newsgroups
491 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
492 will subscribe you to just those groups in that list, leaving the rest
493 killed.  Your system administrator should have set this variable to
494 something useful.
495
496 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
497 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is here
498 defined as @dfn{whatever Lars thinks you should read}.)
499
500 You'll also be subscribed to the Gnus documentation group, which should
501 help you with most common problems.  
502
503 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
504 use the normal functions for handling new groups, and not do anything
505 special.
506
507
508 @node The Server is Down
509 @section The Server is Down
510 @cindex server errors
511
512 If the default server is down, Gnus will understandably have some
513 problems starting.  However, if you have some mail groups in addition to
514 the news groups, you may want to start Gnus anyway.
515
516 Gnus, being the trusting sort of program, will ask whether to proceed
517 without a native select method if that server can't be contacted.  This
518 will happen whether the server doesn't actually exist (i.e., you have
519 given the wrong address) or the server has just momentarily taken ill
520 for some reason or other.  If you decide to continue and have no foreign
521 groups, you'll find it difficult to actually do anything in the group
522 buffer.  But, hey, that's your problem.  Blllrph!
523
524 @findex gnus-no-server
525 @kindex M-x gnus-no-server
526 @c @head
527 If you know that the server is definitely down, or you just want to read
528 your mail without bothering with the server at all, you can use the
529 @code{gnus-no-server} command to start Gnus.  That might come in handy
530 if you're in a hurry as well.  This command will not attempt to contact
531 your primary server---instead, it will just activate all groups on level
532 1 and 2.  (You should preferably keep no native groups on those two
533 levels.)
534
535
536 @node Slave Gnusae
537 @section Slave Gnusae
538 @cindex slave
539
540 You might want to run more than one Emacs with more than one Gnus at the
541 same time.  If you are using different @file{.newsrc} files (e.g., if you
542 are using the two different Gnusae to read from two different servers),
543 that is no problem whatsoever.  You just do it.
544
545 The problem appears when you want to run two Gnusae that use the same
546 @code{.newsrc} file.
547
548 To work around that problem some, we here at the Think-Tank at the Gnus
549 Towers have come up with a new concept: @dfn{Masters} and
550 @dfn{slaves}.  (We have applied for a patent on this concept, and have
551 taken out a copyright on those words.  If you wish to use those words in
552 conjunction with each other, you have to send $1 per usage instance to
553 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
554 Applications}) will be much more expensive, of course.)
555
556 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
557 however you do it).  Each subsequent slave Gnusae should be started with
558 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
559 files, but instead save @dfn{slave files} that contain information only
560 on what groups have been read in the slave session.  When a master Gnus
561 starts, it will read (and delete) these slave files, incorporating all
562 information from them.  (The slave files will be read in the sequence
563 they were created, so the latest changes will have precedence.)
564
565 Information from the slave files has, of course, precedence over the
566 information in the normal (i.e., master) @code{.newsrc} file.
567
568
569 @node Fetching a Group
570 @section Fetching a Group
571 @cindex fetching a group
572
573 @findex gnus-fetch-group
574 It it sometimes convenient to be able to just say ``I want to read this
575 group and I don't care whether Gnus has been started or not''.  This is
576 perhaps more useful for people who write code than for users, but the
577 command @code{gnus-fetch-group} provides this functionality in any case.
578 It takes the group name as a parameter.
579
580
581 @node New Groups
582 @section New Groups
583 @cindex new groups
584 @cindex subscription
585
586 @vindex gnus-check-new-newsgroups
587 If you are satisfied that you really never want to see any new groups,
588 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
589 also save you some time at startup.  Even if this variable is
590 @code{nil}, you can always subscribe to the new groups just by pressing
591 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
592 is @code{t} by default.  If you set this variable to @code{always}, then
593 Gnus will query the backends for new groups even when you do the @kbd{g}
594 command (@pxref{Scanning New Messages}).
595
596 @menu
597 * Checking New Groups::      Determining what groups are new.
598 * Subscription Methods::     What Gnus should do with new groups.
599 * Filtering New Groups::     Making Gnus ignore certain new groups.
600 @end menu
601
602
603 @node Checking New Groups
604 @subsection Checking New Groups
605
606 Gnus normally determines whether a group is new or not by comparing the
607 list of groups from the active file(s) with the lists of subscribed and
608 dead groups.  This isn't a particularly fast method.  If
609 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
610 server for new groups since the last time.  This is both faster and
611 cheaper.  This also means that you can get rid of the list of killed
612 groups altogether, so you may set @code{gnus-save-killed-list} to
613 @code{nil}, which will save time both at startup, at exit, and all over.
614 Saves disk space, too.  Why isn't this the default, then?
615 Unfortunately, not all servers support this command. 
616
617 I bet I know what you're thinking now: How do I find out whether my
618 server supports @code{ask-server}?  No?  Good, because I don't have a
619 fail-safe answer.  I would suggest just setting this variable to
620 @code{ask-server} and see whether any new groups appear within the next
621 few days.  If any do, then it works.  If none do, then it doesn't
622 work.  I could write a function to make Gnus guess whether the server
623 supports @code{ask-server}, but it would just be a guess.  So I won't.
624 You could @code{telnet} to the server and say @code{HELP} and see
625 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
626 it does, then it might work.  (But there are servers that lists
627 @samp{NEWGROUPS} without supporting the function properly.)
628
629 This variable can also be a list of select methods.  If so, Gnus will
630 issue an @code{ask-server} command to each of the select methods, and
631 subscribe them (or not) using the normal methods.  This might be handy
632 if you are monitoring a few servers for new groups.  A side effect is
633 that startup will take much longer, so you can meditate while waiting.
634 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
635
636
637 @node Subscription Methods
638 @subsection Subscription Methods
639
640 @vindex gnus-subscribe-newsgroup-method
641 What Gnus does when it encounters a new group is determined by the
642 @code{gnus-subscribe-newsgroup-method} variable.
643
644 This variable should contain a function.  Some handy pre-fab values
645 are:
646
647 @table @code
648
649 @item gnus-subscribe-zombies
650 @vindex gnus-subscribe-zombies
651 Make all new groups zombies.  This is the default.  You can browse the
652 zombies later (with @kbd{A z}) and either kill them all off properly
653 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
654
655 @item gnus-subscribe-randomly
656 @vindex gnus-subscribe-randomly
657 Subscribe all new groups randomly.
658
659 @item gnus-subscribe-alphabetically
660 @vindex gnus-subscribe-alphabetically
661 Subscribe all new groups alphabetically.
662
663 @item gnus-subscribe-hierarchically
664 @vindex gnus-subscribe-hierarchically
665 Subscribe all new groups hierarchically.  The difference between this
666 function and @code{gnus-subscribe-alphabetically} is slight.
667 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
668 alphabetical fashion, while this function will enter groups into it's
669 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
670 @samp{comp} hierarchy, this function will not mess that configuration
671 up.  Or something like that.
672
673 @item gnus-subscribe-interactively
674 @vindex gnus-subscribe-interactively
675 Subscribe new groups interactively.  This means that Gnus will ask
676 you about @strong{all} new groups.
677
678 @item gnus-subscribe-killed
679 @vindex gnus-subscribe-killed
680 Kill all new groups.
681
682 @end table
683
684 @vindex gnus-subscribe-hierarchical-interactive
685 A closely related variable is
686 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
687 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
688 hierarchical fashion whether to subscribe to new groups or not.  Gnus
689 will ask you for each sub-hierarchy whether you want to descend the
690 hierarchy or not.  
691
692 One common mistake is to set the variable a few paragraphs above to
693 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
694 will not work.  This is ga-ga.  So don't do it.
695
696
697 @node Filtering New Groups
698 @subsection Filtering New Groups
699
700 A nice and portable way to control which new newsgroups should be
701 subscribed (or ignored) is to put an @dfn{options} line at the start of
702 the @file{.newsrc} file.  Here's an example:
703
704 @example
705 options -n !alt.all !rec.all sci.all
706 @end example
707
708 @vindex gnus-subscribe-options-newsgroup-method
709 This line obviously belongs to a serious-minded intellectual scientific
710 person (or she may just be plain old boring), because it says that all
711 groups that have names beginning with @samp{alt} and @samp{rec} should
712 be ignored, and all groups with names beginning with @samp{sci} should
713 be subscribed.  Gnus will not use the normal subscription method for
714 subscribing these groups.
715 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
716 variable defaults to @code{gnus-subscribe-alphabetically}.
717
718 @vindex gnus-options-not-subscribe
719 @vindex gnus-options-subscribe
720 If you don't want to mess with your @file{.newsrc} file, you can just
721 set the two variables @code{gnus-options-subscribe} and
722 @code{gnus-options-not-subscribe}.  These two variables do exactly the
723 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
724 and if the the new group matches the former, it will be unconditionally
725 subscribed, and if it matches the latter, it will be ignored.
726
727 @vindex gnus-auto-subscribed-groups
728 Yet another variable that meddles here is
729 @code{gnus-auto-subscribed-groups}.  It works exactly like
730 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
731 thought it would be nice to have two of these.  This variable is more
732 meant for setting some ground rules, while the other variable is used
733 more for user fiddling.  By default this variable makes all new groups
734 that come from mail backends (@code{nnml}, @code{nnbabyl},
735 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
736 don't like that, just set this variable to @code{nil}.
737
738 New groups that match this regexp are subscribed using
739 @code{gnus-subscribe-options-newsgroup-method}.
740
741
742 @node Changing Servers
743 @section Changing Servers
744 @cindex changing servers
745
746 Sometimes it is necessary to move from one @sc{nntp} server to another.
747 This happens very rarely, but perhaps you change jobs, or one server is
748 very flaky and you want to use another.  
749
750 Changing the server is pretty easy, right?  You just change
751 @code{gnus-select-method} to point to the new server?  
752
753 @emph{Wrong!}
754
755 Article numbers are not (in any way) kept synchronized between different
756 @sc{nntp} servers, and the only way Gnus keeps track of what articles
757 you have read is by keeping track of article numbers.  So when you
758 change @code{gnus-select-method}, your @file{.newsrc} file becomes
759 worthless.  
760
761 Gnus provides a few functions to attempt to translate a @file{.newsrc}
762 file from one server to another.  They all have one thing in
763 common---they take a looong time to run.  You don't want to use these
764 functions more than absolutely necessary.
765
766 @kindex M-x gnus-change-server
767 @findex gnus-change-server
768 If you have access to both servers, Gnus can request the headers for all
769 the articles you have read and compare @code{Message-ID}s and map the
770 article numbers of the read articles and article marks.  The @kbd{M-x
771 gnus-change-server} command will do this for all your native groups.  It
772 will prompt for the method you want to move to.
773
774 @kindex M-x gnus-group-move-group-to-server
775 @findex gnus-group-move-group-to-server
776 You can also move individual groups with the @kbd{M-x
777 gnus-group-move-group-to-server} command.  This is useful if you want to
778 move a (foreign) group from one server to another.
779
780 @kindex M-x gnus-group-clear-data-on-native-groups
781 @findex gnus-group-clear-data-on-native-groups
782 If you don't have access to both the old and new server, all your marks
783 and read ranges have become worthless.  You can use the @kbd{M-x
784 gnus-group-clear-data-on-native-groups} command to clear out all data
785 that you have on your native groups.  Use with caution.
786
787
788 @node Startup Files
789 @section Startup Files
790 @cindex startup files
791 @cindex .newsrc
792 @cindex .newsrc.el
793 @cindex .newsrc.eld
794
795 Now, you all know about the @file{.newsrc} file.  All subscription
796 information is traditionally stored in this file.
797
798 Things got a bit more complicated with @sc{gnus}.  In addition to
799 keeping the @file{.newsrc} file updated, it also used a file called
800 @file{.newsrc.el} for storing all the information that didn't fit into
801 the @file{.newsrc} file.  (Actually, it also duplicated everything in
802 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
803 files was the most recently saved, which enabled people to swap between
804 @sc{gnus} and other newsreaders.
805
806 That was kinda silly, so Gnus went one better: In addition to the
807 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
808 @file{.newsrc.eld}.  It will read whichever of these files that are most
809 recent, but it will never write a @file{.newsrc.el} file.
810
811 @vindex gnus-save-newsrc-file
812 You can turn off writing the @file{.newsrc} file by setting
813 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
814 the file and save some space, as well as making exit from Gnus faster.
815 However, this will make it impossible to use other newsreaders than
816 Gnus.  But hey, who would want to, right?
817
818 @vindex gnus-save-killed-list
819 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
820 will not save the list of killed groups to the startup file.  This will
821 save both time (when starting and quitting) and space (on disk).  It
822 will also mean that Gnus has no record of what groups are new or old,
823 so the automatic new groups subscription methods become meaningless.
824 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
825 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
826 Groups}).  This variable can also be a regular expression.  If that's
827 the case, remove all groups that do not match this regexp before
828 saving.  This can be useful in certain obscure situations that involve
829 several servers where not all servers support @code{ask-server}.
830
831 @vindex gnus-startup-file
832 The @code{gnus-startup-file} variable says where the startup files are.
833 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
834 file being whatever that one is with a @samp{.eld} appended.
835
836 @vindex gnus-save-newsrc-hook
837 @vindex gnus-save-quick-newsrc-hook
838 @vindex gnus-save-standard-newsrc-hook
839 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
840 files, while @code{gnus-save-quick-newsrc-hook} is called just before
841 saving the @file{.newsrc.eld} file, and
842 @code{gnus-save-standard-newsrc-hook} is called just before saving the
843 @file{.newsrc} file.  The latter two are commonly used to turn version
844 control on or off.  Version control is on by default when saving the
845 startup files.  If you want to turn backup creation off, say something like: 
846
847 @lisp
848 (defun turn-off-backup ()
849   (set (make-local-variable 'backup-inhibited) t))
850
851 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
852 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
853 @end lisp
854
855 @vindex gnus-init-file
856 When Gnus starts, it will read the @code{gnus-site-init-file}
857 (@file{.../site-lisp/gnus} 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 paratere 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} and @code{forward}.  If you run this command without a
1820 prefix, Gnus will guess at the file type.  @xref{Document Groups}.
1821
1822 @item G w
1823 @kindex G w (Group)
1824 @findex gnus-group-make-web-group
1825 @cindex DejaNews
1826 @cindex Alta Vista
1827 @cindex InReference
1828 @cindex nnweb
1829 Make an ephemeral group based on a web search
1830 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1831 command, make a solid group instead.  You will be prompted for the
1832 search engine type and the search string.  Legal search engine types
1833 include @code{dejanews}, @code{altavista} and @code{reference}.
1834 @xref{Web Searches}.
1835
1836 @item G DEL
1837 @kindex G DEL (Group)
1838 @findex gnus-group-delete-group
1839 This function will delete the current group
1840 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1841 actually delete all the articles in the group, and forcibly remove the
1842 group itself from the face of the Earth.  Use a prefix only if you are
1843 absolutely sure of what you are doing.
1844
1845 @item G V
1846 @kindex G V (Group)
1847 @findex gnus-group-make-empty-virtual
1848 Make a new, fresh, empty @code{nnvirtual} group
1849 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1850
1851 @item G v
1852 @kindex G v (Group)
1853 @findex gnus-group-add-to-virtual
1854 Add the current group to an @code{nnvirtual} group
1855 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1856 @end table
1857
1858 @xref{Select Methods} for more information on the various select
1859 methods. 
1860
1861 @vindex gnus-activate-foreign-newsgroups
1862 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1863 Gnus will check all foreign groups with this level or lower at startup.
1864 This might take quite a while, especially if you subscribe to lots of
1865 groups from different @sc{nntp} servers.
1866
1867
1868 @node Group Parameters
1869 @section Group Parameters
1870 @cindex group parameters
1871
1872 The group parameters store information local to a particular group:
1873
1874 @table @code
1875 @item to-address
1876 @cindex to-address
1877 If the group parameter list contains an element that looks like
1878 @code{(to-address .  "some@@where.com")}, that address will be used by
1879 the backend when doing followups and posts.  This is primarily useful in
1880 mail groups that represent closed mailing lists---mailing lists where
1881 it's expected that everybody that writes to the mailing list is
1882 subscribed to it.  Since using this parameter ensures that the mail only
1883 goes to the mailing list itself, it means that members won't receive two
1884 copies of your followups.
1885
1886 Using @code{to-address} will actually work whether the group is foreign
1887 or not.  Let's say there's a group on the server that is called
1888 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1889 the articles from a mail-to-news gateway.  Posting directly to this
1890 group is therefore impossible---you have to send mail to the mailing
1891 list address instead. 
1892
1893 @item to-list
1894 @cindex to-list
1895 If the group parameter list has an element that looks like
1896 @code{(to-list . "some@@where.com")}, that address will be used when
1897 doing a @kbd{a} in any group.  It is totally ignored when doing a
1898 followup---except that if it is present in a news group, you'll get mail
1899 group semantics when doing @kbd{f}.
1900
1901 @item broken-reply-to
1902 @cindex broken-reply-to
1903 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1904 headers in this group are to be ignored.  This can be useful if you're
1905 reading a mailing list group where the listserv has inserted
1906 @code{Reply-To} headers that point back to the listserv itself.  This is
1907 broken behavior.  So there!
1908
1909 @item to-group
1910 @cindex to-group
1911 Elements like @code{(to-group . "some.group.name")} means that all
1912 posts in that group will be sent to @code{some.group.name}.  
1913
1914 @item newsgroup
1915 @cindex newsgroup
1916 If this symbol is present in the group parameter list, Gnus will treat
1917 all responses as if they were responses to news articles.  This can be
1918 useful if you have a mail group that's really a mirror of a news group. 
1919
1920 @item gcc-self
1921 @cindex gcc-self
1922 If this symbol is present in the group parameter list and set to
1923 @code{t}, new composed messages will be @code{Gcc}'d to the current
1924 group. If it is present and set to @code{none}, no @code{Gcc:} header
1925 will be generated, if it is present and a string, this string will be
1926 inserted literally as a @code{gcc} header (this symbol takes precedence over
1927 any default @code{Gcc} rules as described later).
1928
1929 @item auto-expire
1930 @cindex auto-expire
1931 If the group parameter has an element that looks like @code{(auto-expire
1932 . t)}, , all articles that are read will be marked as expirable.  For an
1933 alternative approach, @pxref{Expiring Mail}.
1934
1935 @item total-expire
1936 @cindex total-expire
1937 If the group parameter has an element that looks like
1938 @code{(total-expire . t)}, all read articles will be put through the
1939 expiry process, even if they are not marked as expirable.  Use with
1940 caution.
1941
1942 @item expiry-wait
1943 @cindex expiry-wait
1944 @vindex nnmail-expiry-wait-function
1945 If the group parameter has an element that looks like @code{(expiry-wait
1946 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1947 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1948 The value can either be a number of days (not necessarily an integer) or
1949 the symbols @code{never} or @code{immediate}.
1950
1951 @item score-file
1952 @cindex score file group parameter
1953 Elements that look like @code{(score-file . "file")} will make
1954 @file{file} into the current score file for the group in question.  This
1955 means that all score commands you issue will end up in that file. 
1956
1957 @item adapt-file
1958 @cindex adapt file group parameter
1959 Elements that look like @code{(adapt-file . "file")} will make
1960 @file{file} into the current adaptive file for the group in question.
1961 All adaptive score entries will be put into this file.
1962
1963 @item admin-address
1964 When unsubscribing to a mailing list you should never send the
1965 unsubscription notice to the mailing list itself.  Instead, you'd send
1966 messages to the administrative address.  This parameter allows you to
1967 put the admin address somewhere convenient.
1968
1969 @item display
1970 Elements that look like @code{(display . MODE)} says which articles to
1971 display on entering the group.  Legal values are:
1972
1973 @table @code
1974 @item all
1975 Display all articles, both read and unread.
1976
1977 @item default
1978 Display the default visible articles, which normally includes unread and
1979 ticked articles.
1980 @end table
1981
1982 @item comment
1983 Elements that look like @code{(comment . "This is a comment")}
1984 are arbitrary comments on the group.  They are currently ignored by
1985 Gnus, but provide a place for you to store information on particular
1986 groups. 
1987
1988 @item @var{(variable form)}
1989 You can use the group parameters to set variables local to the group you
1990 are entering.  If you want to turn threading off in @samp{news.answers},
1991 you could put @code{(gnus-show-threads nil)} in the group parameters of
1992 that group.  @code{gnus-show-threads} will be made into a local variable
1993 in the summary buffer you enter, and the form @code{nil} will be
1994 @code{eval}ed there.
1995
1996 This can also be used as a group-specific hook function, if you'd like.
1997 If you want to hear a beep when you enter a group, you could put
1998 something like @code{(dummy-variable (ding))} in the parameters of that
1999 group.  @code{dummy-variable} will be set to the result of the
2000 @code{(ding)} form, but who cares?
2001
2002 @end table
2003
2004 Use the @kbd{G p} command to edit group parameters of a group.
2005
2006 Also @pxref{Topic Parameters}.
2007
2008 Here's an example group parameter list:
2009
2010 @example
2011 ((to-address . "ding@ifi.uio.no")
2012  (auto-expiry . t))
2013 @end example
2014
2015
2016 @node Listing Groups
2017 @section Listing Groups
2018 @cindex group listing
2019
2020 These commands all list various slices of the groups that are available.
2021
2022 @table @kbd
2023
2024 @item l
2025 @itemx A s
2026 @kindex A s (Group)
2027 @kindex l (Group)
2028 @findex gnus-group-list-groups
2029 List all groups that have unread articles
2030 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2031 command will list only groups of level ARG and lower.  By default, it
2032 only lists groups of level five (i. e.,
2033 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2034 groups).
2035
2036 @item L
2037 @itemx A u
2038 @kindex A u (Group)
2039 @kindex L (Group)
2040 @findex gnus-group-list-all-groups
2041 List all groups, whether they have unread articles or not
2042 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2043 this command will list only groups of level ARG and lower.  By default,
2044 it lists groups of level seven or lower (i.e., just subscribed and
2045 unsubscribed groups).
2046
2047 @item A l
2048 @kindex A l (Group)
2049 @findex gnus-group-list-level
2050 List all unread groups on a specific level
2051 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2052 with no unread articles.
2053
2054 @item A k
2055 @kindex A k (Group)
2056 @findex gnus-group-list-killed
2057 List all killed groups (@code{gnus-group-list-killed}).  If given a
2058 prefix argument, really list all groups that are available, but aren't
2059 currently (un)subscribed.  This could entail reading the active file
2060 from the server.
2061
2062 @item A z
2063 @kindex A z (Group)
2064 @findex gnus-group-list-zombies
2065 List all zombie groups (@code{gnus-group-list-zombies}).
2066
2067 @item A m
2068 @kindex A m (Group)
2069 @findex gnus-group-list-matching
2070 List all unread, subscribed groups with names that match a regexp
2071 (@code{gnus-group-list-matching}). 
2072
2073 @item A M
2074 @kindex A M (Group)
2075 @findex gnus-group-list-all-matching
2076 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2077
2078 @item A A
2079 @kindex A A (Group)
2080 @findex gnus-group-list-active
2081 List absolutely all groups that are in the active file(s) of the
2082 server(s) you are connected to (@code{gnus-group-list-active}).  This
2083 might very well take quite a while.  It might actually be a better idea
2084 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2085 thing to match on.  Also note that this command may list group that
2086 don't exist (yet)---these will be listed as if they are killed groups.
2087 Take the output with some grains of salt.
2088
2089 @item A a
2090 @kindex A a (Group)
2091 @findex gnus-group-apropos
2092 List all groups that have names that match a regexp
2093 (@code{gnus-group-apropos}).
2094
2095 @item A d
2096 @kindex A d (Group)
2097 @findex gnus-group-description-apropos
2098 List all groups that have names or descriptions that match a regexp
2099 (@code{gnus-group-description-apropos}).
2100
2101 @end table
2102
2103 @vindex gnus-permanently-visible-groups
2104 @cindex visible group parameter
2105 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2106 always be shown, whether they have unread articles or not.  You can also
2107 add the @code{visible} element to the group parameters in question to
2108 get the same effect.
2109
2110 @vindex gnus-list-groups-with-ticked-articles
2111 Groups that have just ticked articles in it are normally listed in the
2112 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2113 @code{nil}, these groups will be treated just like totally empty
2114 groups.  It is @code{t} by default.
2115
2116
2117 @node Sorting Groups
2118 @section Sorting Groups
2119 @cindex sorting groups
2120
2121 @kindex C-c C-s (Group)
2122 @findex gnus-group-sort-groups
2123 @vindex gnus-group-sort-function
2124 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2125 group buffer according to the function(s) given by the
2126 @code{gnus-group-sort-function} variable.  Available sorting functions
2127 include: 
2128
2129 @table @code
2130
2131 @item gnus-group-sort-by-alphabet
2132 @findex gnus-group-sort-by-alphabet
2133 Sort the group names alphabetically.  This is the default.
2134
2135 @item gnus-group-sort-by-real-name
2136 @findex gnus-group-sort-by-real-name
2137 Sort the group alphabetically on the real (unprefixed) group names.
2138
2139 @item gnus-group-sort-by-level
2140 @findex gnus-group-sort-by-level
2141 Sort by group level.
2142
2143 @item gnus-group-sort-by-score
2144 @findex gnus-group-sort-by-score
2145 Sort by group score.
2146
2147 @item gnus-group-sort-by-rank
2148 @findex gnus-group-sort-by-rank
2149 Sort by group score and then the group level.  The level and the score
2150 are, when taken together, the group's @dfn{rank}. 
2151
2152 @item gnus-group-sort-by-unread
2153 @findex gnus-group-sort-by-unread
2154 Sort by number of unread articles.
2155
2156 @item gnus-group-sort-by-method
2157 @findex gnus-group-sort-by-method
2158 Sort alphabetically on the select method.
2159
2160
2161 @end table
2162
2163 @code{gnus-group-sort-function} can also be a list of sorting
2164 functions.  In that case, the most significant sort key function must be
2165 the last one.
2166
2167
2168 There are also a number of commands for sorting directly according to
2169 some sorting criteria:
2170
2171 @table @kbd
2172 @item G S a
2173 @kindex G S a (Group)
2174 @findex gnus-group-sort-groups-by-alphabet
2175 Sort the group buffer alphabetically by group name
2176 (@code{gnus-group-sort-groups-by-alphabet}). 
2177
2178 @item G S u
2179 @kindex G S u (Group)
2180 @findex gnus-group-sort-groups-by-unread
2181 Sort the group buffer by the number of unread articles
2182 (@code{gnus-group-sort-groups-by-unread}).
2183
2184 @item G S l
2185 @kindex G S l (Group)
2186 @findex gnus-group-sort-groups-by-level
2187 Sort the group buffer by group level
2188 (@code{gnus-group-sort-groups-by-level}). 
2189
2190 @item G S v
2191 @kindex G S v (Group)
2192 @findex gnus-group-sort-groups-by-score
2193 Sort the group buffer by group score
2194 (@code{gnus-group-sort-groups-by-score}). 
2195
2196 @item G S r
2197 @kindex G S r (Group)
2198 @findex gnus-group-sort-groups-by-rank
2199 Sort the group buffer by group rank
2200 (@code{gnus-group-sort-groups-by-rank}). 
2201
2202 @item G S m
2203 @kindex G S m (Group)
2204 @findex gnus-group-sort-groups-by-method
2205 Sort the group buffer alphabetically by backend name
2206 (@code{gnus-group-sort-groups-by-method}). 
2207
2208 @end table
2209
2210 When given a prefix, all these commands will sort in reverse order. 
2211
2212 You can also sort a subset of the groups:
2213
2214 @table @kbd
2215 @item G P a
2216 @kindex G P a (Group)
2217 @findex gnus-group-sort-selected-groups-by-alphabet
2218 Sort the process/prefixed groups in the group buffer alphabetically by
2219 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2220
2221 @item G P u
2222 @kindex G P u (Group)
2223 @findex gnus-group-sort-selected-groups-by-unread
2224 Sort the process/prefixed groups in the group buffer by the number of
2225 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2226
2227 @item G P l
2228 @kindex G P l (Group)
2229 @findex gnus-group-sort-selected-groups-by-level
2230 Sort the process/prefixed groups in the group buffer by group level
2231 (@code{gnus-group-sort-selected-groups-by-level}).
2232
2233 @item G P v
2234 @kindex G P v (Group)
2235 @findex gnus-group-sort-selected-groups-by-score
2236 Sort the process/prefixed groups in the group buffer by group score
2237 (@code{gnus-group-sort-selected-groups-by-score}).
2238
2239 @item G P r
2240 @kindex G P r (Group)
2241 @findex gnus-group-sort-selected-groups-by-rank
2242 Sort the process/prefixed groups in the group buffer by group rank
2243 (@code{gnus-group-sort-selected-groups-by-rank}).
2244
2245 @item G P m
2246 @kindex G P m (Group)
2247 @findex gnus-group-sort-selected-groups-by-method
2248 Sort the process/prefixed groups in the group buffer alphabetically by
2249 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2250
2251 @end table
2252
2253
2254
2255 @node Group Maintenance
2256 @section Group Maintenance
2257 @cindex bogus groups
2258
2259 @table @kbd
2260 @item b
2261 @kindex b (Group)
2262 @findex gnus-group-check-bogus-groups
2263 Find bogus groups and delete them
2264 (@code{gnus-group-check-bogus-groups}).
2265
2266 @item F
2267 @kindex F (Group)
2268 @findex gnus-find-new-newsgroups
2269 Find new groups and process them (@code{gnus-find-new-newsgroups}).  If
2270 given a prefix, use the @code{ask-server} method to query the server for
2271 new groups.
2272
2273 @item C-c C-x
2274 @kindex C-c C-x (Group)
2275 @findex gnus-group-expire-articles
2276 Run all expirable articles in the current group through the expiry
2277 process (if any) (@code{gnus-group-expire-articles}).
2278
2279 @item C-c M-C-x
2280 @kindex C-c M-C-x (Group)
2281 @findex gnus-group-expire-all-groups
2282 Run all articles in all groups through the expiry process
2283 (@code{gnus-group-expire-all-groups}).
2284
2285 @end table
2286
2287
2288 @node Browse Foreign Server
2289 @section Browse Foreign Server
2290 @cindex foreign servers
2291 @cindex browsing servers
2292
2293 @table @kbd
2294 @item B
2295 @kindex B (Group)
2296 @findex gnus-group-browse-foreign-server
2297 You will be queried for a select method and a server name.  Gnus will
2298 then attempt to contact this server and let you browse the groups there
2299 (@code{gnus-group-browse-foreign-server}).
2300 @end table
2301
2302 @findex gnus-browse-mode
2303 A new buffer with a list of available groups will appear.  This buffer
2304 will be use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2305 a lot) like a normal group buffer.
2306
2307 Here's a list of keystrokes available in the browse mode:
2308
2309 @table @kbd
2310 @item n
2311 @kindex n (Browse)
2312 @findex gnus-group-next-group
2313 Go to the next group (@code{gnus-group-next-group}).
2314
2315 @item p
2316 @kindex p (Browse)
2317 @findex gnus-group-prev-group
2318 Go to the previous group (@code{gnus-group-prev-group}).
2319
2320 @item SPACE
2321 @kindex SPACE (Browse)
2322 @findex gnus-browse-read-group
2323 Enter the current group and display the first article
2324 (@code{gnus-browse-read-group}). 
2325
2326 @item RET
2327 @kindex RET (Browse)
2328 @findex gnus-browse-select-group
2329 Enter the current group (@code{gnus-browse-select-group}). 
2330
2331 @item u
2332 @kindex u (Browse)
2333 @findex gnus-browse-unsubscribe-current-group
2334 Unsubscribe to the current group, or, as will be the case here,
2335 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
2336
2337 @item l
2338 @itemx q
2339 @kindex q (Browse)
2340 @kindex l (Browse)
2341 @findex gnus-browse-exit
2342 Exit browse mode (@code{gnus-browse-exit}).
2343
2344 @item ?
2345 @kindex ? (Browse)
2346 @findex gnus-browse-describe-briefly
2347 Describe browse mode briefly (well, there's not much to describe, is
2348 there) (@code{gnus-browse-describe-briefly}).
2349 @end table
2350
2351
2352 @node Exiting Gnus
2353 @section Exiting Gnus
2354 @cindex exiting Gnus
2355
2356 Yes, Gnus is ex(c)iting.
2357
2358 @table @kbd
2359 @item z
2360 @kindex z (Group)
2361 @findex gnus-group-suspend
2362 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2363 but it kills all buffers except the Group buffer.  I'm not sure why this
2364 is a gain, but then who am I to judge?
2365
2366 @item q
2367 @kindex q (Group)
2368 @findex gnus-group-exit
2369 Quit Gnus (@code{gnus-group-exit}).
2370
2371 @item Q
2372 @kindex Q (Group)
2373 @findex gnus-group-quit
2374 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2375 The dribble file will be saved, though (@pxref{Auto Save}).
2376 @end table
2377
2378 @vindex gnus-exit-gnus-hook
2379 @vindex gnus-suspend-gnus-hook
2380 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2381 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2382 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2383 exiting Gnus.
2384
2385 @findex gnus-unload
2386 @cindex unloading
2387 If you wish to completely unload Gnus and all its adherents, you can use
2388 the @code{gnus-unload} command.  This command is also very handy when
2389 trying to customize meta-variables.
2390
2391 Note:
2392
2393 @quotation
2394 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2395 numbly heavy and herself fall into a hazy trance as the boy sitting
2396 behind her drew repeated lines with his pencil across the back of her
2397 plastic chair.
2398 @end quotation
2399
2400
2401 @node Group Topics
2402 @section Group Topics
2403 @cindex topics
2404
2405 If you read lots and lots of groups, it might be convenient to group
2406 them hierarchically according to topics.  You put your Emacs groups over
2407 here, your sex groups over there, and the rest (what, two groups or so?)
2408 you put in some misc section that you never bother with anyway.  You can
2409 even group the Emacs sex groups as a sub-topic to either the Emacs
2410 groups or the sex groups---or both!  Go wild!
2411
2412 Here's an example:
2413
2414 @example
2415 Gnus
2416   Emacs -- I wuw it!
2417      3: comp.emacs
2418      2: alt.religion.emacs
2419     Naughty Emacs
2420      452: alt.sex.emacs
2421        0: comp.talk.emacs.recovery
2422   Misc
2423      8: comp.binaries.fractals
2424     13: comp.sources.unix
2425 @end example
2426
2427 @findex gnus-topic-mode
2428 @kindex t (Group)
2429 To get this @emph{fab} functionality you simply turn on (ooh!) the
2430 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2431 is a toggling command.)
2432
2433 Go ahead, just try it.  I'll still be here when you get back.  La de
2434 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2435 press @kbd{l}.  There.  All your groups are now listed under
2436 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2437 bothered?
2438
2439 If you want this permanently enabled, you should add that minor mode to
2440 the hook for the group mode:
2441
2442 @lisp
2443 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2444 @end lisp
2445
2446 @menu 
2447 * Topic Variables::    How to customize the topics the Lisp Way.
2448 * Topic Commands::     Interactive E-Z commands.
2449 * Topic Sorting::      Sorting each topic individually.
2450 * Topic Topology::     A map of the world.
2451 * Topic Parameters::   Parameters that apply to all groups in a topic.
2452 @end menu
2453
2454
2455 @node Topic Variables
2456 @subsection Topic Variables
2457 @cindex topic variables
2458
2459 Now, if you select a topic, if will fold/unfold that topic, which is
2460 really neat, I think.
2461
2462 @vindex gnus-topic-line-format
2463 The topic lines themselves are created according to the
2464 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2465 Legal elements are:
2466
2467 @table @samp
2468 @item i
2469 Indentation.
2470 @item n
2471 Topic name.
2472 @item v
2473 Visibility.
2474 @item l
2475 Level.
2476 @item g
2477 Number of groups in the topic.
2478 @item a
2479 Number of unread articles in the topic.
2480 @item A 
2481 Number of unread articles in the topic and all its subtopics. 
2482 @end table
2483
2484 @vindex gnus-topic-indent-level
2485 Each sub-topic (and the groups in the sub-topics) will be indented with
2486 @code{gnus-topic-indent-level} times the topic level number of spaces.
2487 The default is 2.
2488
2489 @vindex gnus-topic-mode-hook
2490 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2491
2492 @vindex gnus-topic-display-empty-topics
2493 The @code{gnus-topic-display-empty-topics} says whether to display even
2494 topics that have no unread articles in them.  The default is @code{t}.
2495
2496
2497 @node Topic Commands
2498 @subsection Topic Commands
2499 @cindex topic commands
2500
2501 When the topic minor mode is turned on, a new @kbd{T} submap will be
2502 available.  In addition, a few of the standard keys change their
2503 definitions slightly.
2504
2505 @table @kbd
2506
2507 @item T n
2508 @kindex T n (Topic)
2509 @findex gnus-topic-create-topic
2510 Prompt for a new topic name and create it 
2511 (@code{gnus-topic-create-topic}). 
2512
2513 @item T m
2514 @kindex T m (Topic)
2515 @findex gnus-topic-move-group
2516 Move the current group to some other topic
2517 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2518 convention (@pxref{Process/Prefix}).
2519
2520 @item T c
2521 @kindex T c (Topic)
2522 @findex gnus-topic-copy-group
2523 Copy the current group to some other topic
2524 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2525 convention (@pxref{Process/Prefix}).
2526
2527 @item T D
2528 @kindex T D (Topic)
2529 @findex gnus-topic-remove-group
2530 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2531 This command uses the process/prefix convention
2532 (@pxref{Process/Prefix}).
2533
2534 @item T M
2535 @kindex T M (Topic)
2536 @findex gnus-topic-move-matching
2537 Move all groups that match some regular expression to a topic
2538 (@code{gnus-topic-move-matching}). 
2539
2540 @item T C
2541 @kindex T C (Topic)
2542 @findex gnus-topic-copy-matching
2543 Copy all groups that match some regular expression to a topic
2544 (@code{gnus-topic-copy-matching}). 
2545
2546 @item T #
2547 @kindex T # (Topic)
2548 @findex gnus-topic-mark-topic
2549 Mark all groups in the current topic with the process mark
2550 (@code{gnus-topic-mark-topic}). 
2551
2552 @item T M-#
2553 @kindex T M-# (Topic)
2554 @findex gnus-topic-unmark-topic
2555 Remove the process mark from all groups in the current topic
2556 (@code{gnus-topic-unmark-topic}). 
2557
2558 @item RET
2559 @kindex RET (Topic)
2560 @findex gnus-topic-select-group
2561 @itemx SPACE
2562 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2563 When you perform this command on a group, you'll enter the group, as
2564 usual.  When done on a topic line, the topic will be folded (if it was
2565 visible) or unfolded (if it was folded already).  So it's basically a
2566 toggling command on topics.  In addition, if you give a numerical
2567 prefix, group on that level (and lower) will be displayed.
2568
2569 @item T TAB
2570 @kindex T TAB (Topic)
2571 @findex gnus-topic-indent
2572 ``Indent'' the current topic so that it becomes a sub-topic of the
2573 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2574 ``un-indent'' the topic instead.
2575
2576 @item C-k
2577 @kindex C-k (Topic)
2578 @findex gnus-topic-kill-group
2579 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2580 topic will be removed along with the topic.
2581
2582 @item C-y
2583 @kindex C-y (Topic)
2584 @findex gnus-topic-yank-group
2585 Yank the previously killed group or topic
2586 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2587 before all groups. 
2588
2589 @item T r
2590 @kindex T r (Topic)
2591 @findex gnus-topic-rename
2592 Rename a topic (@code{gnus-topic-rename}). 
2593
2594 @item T DEL
2595 @kindex T DEL (Topic)
2596 @findex gnus-topic-delete
2597 Delete an empty topic (@code{gnus-topic-delete}). 
2598
2599 @item A T
2600 @kindex A T (Topic)
2601 @findex gnus-topic-list-active
2602 List all groups that Gnus knows about in a topics-ified way
2603 (@code{gnus-topic-list-active}).
2604
2605 @item G p
2606 @kindex G p (Topic)
2607 @findex gnus-topic-edit-parameters
2608 @cindex group parameters
2609 @cindex topic parameters
2610 @cindex parameters
2611 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2612 @xref{Topic Parameters}.
2613
2614 @end table
2615
2616
2617 @node Topic Sorting
2618 @subsection Topic Sorting
2619 @cindex topic sorting
2620
2621 You can sort the groups in each topic individually with the following
2622 commands: 
2623
2624
2625 @table @kbd
2626 @item T S a
2627 @kindex T S a (Topic)
2628 @findex gnus-topic-sort-groups-by-alphabet
2629 Sort the current topic alphabetically by group name
2630 (@code{gnus-topic-sort-groups-by-alphabet}). 
2631
2632 @item T S u
2633 @kindex T S u (Topic)
2634 @findex gnus-topic-sort-groups-by-unread
2635 Sort the current topic by the number of unread articles
2636 (@code{gnus-topic-sort-groups-by-unread}).
2637
2638 @item T S l
2639 @kindex T S l (Topic)
2640 @findex gnus-topic-sort-groups-by-level
2641 Sort the current topic by group level
2642 (@code{gnus-topic-sort-groups-by-level}). 
2643
2644 @item T S v
2645 @kindex T S v (Topic)
2646 @findex gnus-topic-sort-groups-by-score
2647 Sort the current topic by group score
2648 (@code{gnus-topic-sort-groups-by-score}). 
2649
2650 @item T S r
2651 @kindex T S r (Topic)
2652 @findex gnus-topic-sort-groups-by-rank
2653 Sort the current topic by group rank
2654 (@code{gnus-topic-sort-groups-by-rank}). 
2655
2656 @item T S m
2657 @kindex T S m (Topic)
2658 @findex gnus-topic-sort-groups-by-method
2659 Sort the current topic alphabetically by backend name
2660 (@code{gnus-topic-sort-groups-by-method}). 
2661
2662 @end table
2663
2664 @xref{Sorting Groups} for more information about group sorting. 
2665
2666
2667 @node Topic Topology
2668 @subsection Topic Topology
2669 @cindex topic topology
2670 @cindex topology
2671
2672 So, let's have a look at an example group buffer:
2673
2674 @example
2675 Gnus
2676   Emacs -- I wuw it!
2677      3: comp.emacs
2678      2: alt.religion.emacs
2679     Naughty Emacs
2680      452: alt.sex.emacs
2681        0: comp.talk.emacs.recovery
2682   Misc
2683      8: comp.binaries.fractals
2684     13: comp.sources.unix
2685 @end example
2686
2687 So, here we have one top-level topic (@samp{Gnus}), two topics under
2688 that, and one sub-topic under one of the sub-topics.  (There is always
2689 just one (1) top-level topic).  This topology can be expressed as
2690 follows:
2691
2692 @lisp
2693 (("Gnus" visible)
2694  (("Emacs -- I wuw it!" visible) 
2695   (("Naughty Emacs" visible)))
2696  (("Misc" visible)))
2697 @end lisp
2698
2699 @vindex gnus-topic-topology
2700 This is in fact how the variable @code{gnus-topic-topology} would look
2701 for the display above.  That variable is saved in the @file{.newsrc.eld}
2702 file, and shouldn't be messed with manually---unless you really want
2703 to.  Since this variable is read from the @file{.newsrc.eld} file,
2704 setting it in any other startup files will have no effect.  
2705
2706 This topology shows what topics are sub-topics of what topics (right),
2707 and which topics are visible.  Two settings are currently
2708 allowed---@code{visible} and @code{invisible}.
2709
2710
2711 @node Topic Parameters
2712 @subsection Topic Parameters
2713 @cindex topic parameters
2714
2715 All groups in a topic will inherit group parameters from the parent (and
2716 ancestor) topic parameters.  All legal group parameters are legal topic
2717 parameters (@pxref{Group Parameters}).  
2718
2719 Group parameters (of course) override topic parameters, and topic
2720 parameters in sub-topics override topic parameters in super-topics.  You
2721 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2722 verb, although you may feel free to disagree with me here.)
2723
2724 @example
2725 Gnus
2726   Emacs
2727      3: comp.emacs
2728      2: alt.religion.emacs
2729    452: alt.sex.emacs
2730     Relief
2731      452: alt.sex.emacs
2732        0: comp.talk.emacs.recovery
2733   Misc
2734      8: comp.binaries.fractals
2735     13: comp.sources.unix
2736    452: alt.sex.emacs
2737 @end example
2738
2739 The @samp{Emacs} topic has the topic parameter @code{(score-file
2740 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2741 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2742 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2743 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2744 . "religion.SCORE")}.
2745
2746 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2747 will get the @file{relief.SCORE} home score file.  If you enter the same
2748 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2749 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2750 get the @file{religion.SCORE} home score file.
2751
2752 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2753 there are some problems, especially with the @code{total-expiry}
2754 parameter.  Say you have a mail group in two topics; one with
2755 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2756 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2757 of these topics you mean to expire articles from, so anything may
2758 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2759 happens.  You just have to be careful if you do stuff like that.
2760
2761
2762 @node Misc Group Stuff
2763 @section Misc Group Stuff
2764
2765 @menu
2766 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2767 * Group Information::     Information and help on groups and Gnus.
2768 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2769 * File Commands::         Reading and writing the Gnus files.
2770 @end menu
2771
2772 @table @kbd
2773
2774 @item ^
2775 @kindex ^ (Group)
2776 @findex gnus-group-enter-server-mode
2777 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2778 @xref{The Server Buffer}.
2779
2780 @item a
2781 @kindex a (Group)
2782 @findex gnus-group-post-news
2783 Post an article to a group (@code{gnus-group-post-news}).  The current
2784 group name will be used as the default.
2785
2786 @item m
2787 @kindex m (Group)
2788 @findex gnus-group-mail
2789 Mail a message somewhere (@code{gnus-group-mail}).
2790
2791 @end table
2792
2793 Variables for the group buffer:
2794
2795 @table @code
2796
2797 @item gnus-group-mode-hook
2798 @vindex gnus-group-mode-hook
2799 @code{gnus-group-mode-hook} is called after the group buffer has been
2800 created. 
2801
2802 @item gnus-group-prepare-hook
2803 @vindex gnus-group-prepare-hook
2804 @code{gnus-group-prepare-hook} is called after the group buffer is
2805 generated.  It may be used to modify the buffer in some strange,
2806 unnatural way.
2807
2808 @item gnus-permanently-visible-groups
2809 @vindex gnus-permanently-visible-groups
2810 Groups matching this regexp will always be listed in the group buffer,
2811 whether they are empty or not.
2812
2813 @end table
2814
2815
2816 @node Scanning New Messages
2817 @subsection Scanning New Messages
2818 @cindex new messages
2819 @cindex scanning new news
2820
2821 @table @kbd
2822
2823 @item g
2824 @kindex g (Group)
2825 @findex gnus-group-get-new-news
2826 Check the server(s) for new articles.  If the numerical prefix is used,
2827 this command will check only groups of level @var{arg} and lower
2828 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2829 command will force a total rereading of the active file(s) from the
2830 backend(s).
2831
2832 @item M-g
2833 @kindex M-g (Group)
2834 @findex gnus-group-get-new-news-this-group
2835 @vindex gnus-goto-next-group-when-activating
2836 Check whether new articles have arrived in the current group
2837 (@code{gnus-group-get-new-news-this-group}).
2838 @code{gnus-goto-next-group-when-activating} says whether this command is
2839 to move point to the next group or not.  It is @code{t} by default.
2840
2841 @findex gnus-activate-all-groups
2842 @cindex activating groups
2843 @item C-c M-g
2844 @kindex C-c M-g (Group)
2845 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2846
2847 @item R
2848 @kindex R (Group)
2849 @cindex restarting
2850 @findex gnus-group-restart
2851 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2852 file(s), closes the connection to all servers, clears up all run-time
2853 Gnus variables, and then starts Gnus all over again.
2854
2855 @end table
2856
2857 @vindex gnus-get-new-news-hook
2858 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2859
2860 @vindex gnus-after-getting-new-news-hook
2861 @code{gnus-after-getting-new-news-hook} is run after checking for new
2862 news.
2863
2864
2865 @node Group Information
2866 @subsection Group Information
2867 @cindex group information
2868 @cindex information on groups
2869
2870 @table @kbd
2871
2872
2873 @item H f
2874 @kindex H f (Group)
2875 @findex gnus-group-fetch-faq
2876 @vindex gnus-group-faq-directory
2877 @cindex FAQ
2878 @cindex ange-ftp
2879 Try to fetch the FAQ for the current group
2880 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2881 @code{gnus-group-faq-directory}, which is usually a directory on a
2882 remote machine.  This variable can also be a list of directories.  In
2883 that case, giving a prefix to this command will allow you to choose
2884 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2885 for fetching the file.
2886
2887 If fetching from the first site is unsuccessful, Gnus will attempt to go
2888 through @code{gnus-group-faq-directory} and try to open them one by one.
2889
2890 @item H d
2891 @itemx C-c C-d
2892 @kindex H d (Group)
2893 @kindex C-c C-d (Group)
2894 @cindex describing groups
2895 @cindex group description
2896 @findex gnus-group-describe-group
2897 Describe the current group (@code{gnus-group-describe-group}).  If given
2898 a prefix, force Gnus to re-read the description from the server.
2899
2900 @item M-d
2901 @kindex M-d (Group)
2902 @findex gnus-group-describe-all-groups
2903 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2904 prefix, force Gnus to re-read the description file from the server.
2905
2906 @item V
2907 @kindex V (Group)
2908 @cindex version
2909 @findex gnus-version
2910 Display current Gnus version numbers (@code{gnus-version}).
2911
2912 @item ?
2913 @kindex ? (Group)
2914 @findex gnus-group-describe-briefly
2915 Give a very short help message (@code{gnus-group-describe-briefly}).
2916
2917 @item C-c C-i
2918 @kindex C-c C-i (Group)
2919 @cindex info
2920 @cindex manual
2921 @findex gnus-info-find-node
2922 Go to the Gnus info node (@code{gnus-info-find-node}).
2923 @end table
2924
2925
2926 @node Group Timestamp
2927 @subsection Group Timestamp
2928 @cindex timestamps
2929 @cindex group timestamps
2930
2931 It can be convenient to let Gnus keep track of when you last read a
2932 group.  To set the ball rolling, you should add
2933 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2934
2935 @lisp
2936 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2937 @end lisp
2938
2939 After doing this, each time you enter a group, it'll be recorded.
2940
2941 This information can be displayed in various ways---the easiest is to
2942 use the @samp{%d} spec in the group line format:
2943
2944 @lisp
2945 (setq gnus-group-line-format 
2946       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2947 @end lisp
2948
2949 This will result in lines looking like:
2950
2951 @example
2952 *        0: mail.ding                                19961002T012943
2953          0: custom                                   19961002T012713
2954 @end example
2955
2956 As you can see, the date is displayed in compact ISO 8601 format.  This
2957 may be a bit too much, so to just display the date, you could say
2958 something like:
2959
2960 @lisp
2961 (setq gnus-group-line-format 
2962       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2963 @end lisp
2964
2965
2966 @node File Commands
2967 @subsection File Commands
2968 @cindex file commands
2969
2970 @table @kbd
2971
2972 @item r
2973 @kindex r (Group)
2974 @findex gnus-group-read-init-file
2975 @vindex gnus-init-file
2976 @cindex reading init file
2977 Re-read the init file (@code{gnus-init-file}, which defaults to
2978 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2979
2980 @item s
2981 @kindex s (Group)
2982 @findex gnus-group-save-newsrc
2983 @cindex saving .newsrc
2984 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2985 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
2986 file(s) whether Gnus thinks it is necessary or not.
2987
2988 @c @item Z
2989 @c @kindex Z (Group)
2990 @c @findex gnus-group-clear-dribble
2991 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2992
2993 @end table
2994
2995
2996 @node The Summary Buffer
2997 @chapter The Summary Buffer
2998 @cindex summary buffer
2999
3000 A line for each article is displayed in the summary buffer.  You can
3001 move around, read articles, post articles and reply to articles.
3002
3003 The most common way to a summary buffer is to select a group from the
3004 group buffer (@pxref{Selecting a Group}).  
3005
3006 You can have as many summary buffers open as you wish.
3007
3008 @menu
3009 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3010 * Summary Maneuvering::         Moving around the summary buffer.
3011 * Choosing Articles::           Reading articles.
3012 * Paging the Article::          Scrolling the current article.
3013 * Reply Followup and Post::     Posting articles.
3014 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3015 * Marking Articles::            Marking articles as read, expirable, etc.
3016 * Limiting::                    You can limit the summary buffer.
3017 * Threading::                   How threads are made.
3018 * Sorting::                     How articles and threads are sorted.
3019 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3020 * Article Caching::             You may store articles in a cache.
3021 * Persistent Articles::         Making articles expiry-resistant.
3022 * Article Backlog::             Having already read articles hang around.
3023 * Saving Articles::             Ways of customizing article saving.
3024 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3025 * Article Treatment::           The article buffer can be mangled at will.
3026 * Article Commands::            Doing various things with the article buffer.
3027 * Summary Sorting::             Sorting the summary buffer in various ways.
3028 * Finding the Parent::          No child support? Get the parent.
3029 * Alternative Approaches::      Reading using non-default summaries.
3030 * Tree Display::                A more visual display of threads.
3031 * Mail Group Commands::         Some commands can only be used in mail groups.
3032 * Various Summary Stuff::       What didn't fit anywhere else.
3033 * Exiting the Summary Buffer::  Returning to the Group buffer.
3034 * Crosspost Handling::          How crossposted articles are dealt with.
3035 * Duplicate Suppression::       An alternative when crosspost handling fails.
3036 @end menu
3037
3038
3039 @node Summary Buffer Format
3040 @section Summary Buffer Format
3041 @cindex summary buffer format
3042
3043 @menu
3044 * Summary Buffer Lines::     You can specify how summary lines should look.
3045 * Summary Buffer Mode Line:: You can say how the mode line should look.
3046 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3047 @end menu
3048
3049 @findex mail-extract-address-components
3050 @findex gnus-extract-address-components
3051 @vindex gnus-extract-address-components
3052 Gnus will use the value of the @code{gnus-extract-address-components}
3053 variable as a function for getting the name and address parts of a
3054 @code{From} header.  Two pre-defined function exist:
3055 @code{gnus-extract-address-components}, which is the default, quite
3056 fast, and too simplistic solution; and
3057 @code{mail-extract-address-components}, which works very nicely, but is
3058 slower.  The default function will return the wrong answer in 5% of the
3059 cases.  If this is unacceptable to you, use the other function instead.
3060
3061 @vindex gnus-summary-same-subject
3062 @code{gnus-summary-same-subject} is a string indicating that the current
3063 article has the same subject as the previous.  This string will be used
3064 with those specs that require it.  The default is @samp{}.
3065
3066
3067 @node Summary Buffer Lines
3068 @subsection Summary Buffer Lines
3069
3070 @vindex gnus-summary-line-format
3071 You can change the format of the lines in the summary buffer by changing
3072 the @code{gnus-summary-line-format} variable.  It works along the same
3073 lines a a normal @code{format} string, with some extensions
3074 (@pxref{Formatting Variables}).
3075
3076 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3077
3078 The following format specification characters are understood:
3079
3080 @table @samp
3081 @item N 
3082 Article number.
3083 @item S
3084 Subject string.
3085 @item s
3086 Subject if the article is the root or the previous article had a
3087 different subject, @code{gnus-summary-same-subject} otherwise.
3088 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3089 @item F
3090 Full @code{From} header.
3091 @item n
3092 The name (from the @code{From} header).
3093 @item a
3094 The name (from the @code{From} header).  This differs from the @code{n}
3095 spec in that it uses the function designated by the
3096 @code{gnus-extract-address-components} variable, which is slower, but
3097 may be more thorough.
3098 @item A
3099 The address (from the @code{From} header).  This works the same way as
3100 the @code{a} spec.
3101 @item L
3102 Number of lines in the article.
3103 @item c
3104 Number of characters in the article.
3105 @item I
3106 Indentation based on thread level (@pxref{Customizing Threading}).
3107 @item T
3108 Nothing if the article is a root and lots of spaces if it isn't (it
3109 pushes everything after it off the screen).
3110 @item [
3111 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3112 for adopted articles (@pxref{Customizing Threading}).
3113 @item ]
3114 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3115 for adopted articles.
3116 @item >
3117 One space for each thread level.
3118 @item <
3119 Twenty minus thread level spaces.
3120 @item U
3121 Unread.
3122 @item R
3123 Replied.
3124 @item i
3125 Score as a number.
3126 @item z
3127 @vindex gnus-summary-zcore-fuzz
3128 Zcore, @samp{+} if above the default level and @samp{-} if below the
3129 default level.  If the difference between
3130 @code{gnus-summary-default-level} and the score is less than
3131 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3132 @item V
3133 Total thread score.
3134 @item x
3135 @code{Xref}.
3136 @item D
3137 @code{Date}.
3138 @item d
3139 The @code{Date} in @code{DD-MMM} format.
3140 @item o
3141 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3142 @item M
3143 @code{Message-ID}.
3144 @item r
3145 @code{References}.
3146 @item t
3147 Number of articles in the current sub-thread.  Using this spec will slow
3148 down summary buffer generation somewhat.
3149 @item e
3150 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3151 article has any children.
3152 @item P
3153 The line number.
3154 @item u
3155 User defined specifier.  The next character in the format string should
3156 be a letter.  @sc{gnus} will call the function
3157 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3158 following @samp{%u}.  The function will be passed the current header as
3159 argument.  The function should return a string, which will be inserted
3160 into the summary just like information from any other summary specifier.
3161 @end table
3162
3163 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3164 have to be handled with care.  For reasons of efficiency, Gnus will
3165 compute what column these characters will end up in, and ``hard-code''
3166 that.  This means that it is illegal to have these specs after a
3167 variable-length spec.  Well, you might not be arrested, but your summary
3168 buffer will look strange, which is bad enough.
3169
3170 The smart choice is to have these specs as far to the left as possible.
3171 (Isn't that the case with everything, though?  But I digress.)
3172
3173 This restriction may disappear in later versions of Gnus.
3174
3175
3176 @node Summary Buffer Mode Line
3177 @subsection Summary Buffer Mode Line
3178
3179 @vindex gnus-summary-mode-line-format
3180 You can also change the format of the summary mode bar.  Set
3181 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3182 is @samp{Gnus: %%b [%A] %Z}.  
3183
3184 Here are the elements you can play with:
3185
3186 @table @samp
3187 @item G
3188 Group name.
3189 @item p
3190 Unprefixed group name.
3191 @item A
3192 Current article number.
3193 @item V
3194 Gnus version.
3195 @item U
3196 Number of unread articles in this group.
3197 @item e
3198 Number of unselected articles in this group.
3199 @item Z
3200 A string with the number of unread and unselected articles represented
3201 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3202 articles, and just as @samp{<%U more>} if there are just unread articles
3203 and no unselected ones.
3204 @item g
3205 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3206 shortened to @samp{r.a.anime}. 
3207 @item S
3208 Subject of the current article.
3209 @item u
3210 User-defined spec.
3211 @item s
3212 Name of the current score file.
3213 @item d
3214 Number of dormant articles.
3215 @item t
3216 Number of ticked articles.
3217 @item r
3218 Number of articles that have been marked as read in this session. 
3219 @item E
3220 Number of articles expunged by the score files.
3221 @end table
3222
3223
3224 @node Summary Highlighting
3225 @subsection Summary Highlighting
3226
3227 @table @code
3228
3229 @item gnus-visual-mark-article-hook
3230 @vindex gnus-visual-mark-article-hook
3231 This hook is run after selecting an article.  It is meant to be used for
3232 highlighting the article in some way.  It is not run if
3233 @code{gnus-visual} is @code{nil}.
3234
3235 @item gnus-summary-update-hook
3236 @vindex gnus-summary-update-hook
3237 This hook is called when a summary line is changed.  It is not run if
3238 @code{gnus-visual} is @code{nil}.
3239
3240 @item gnus-summary-selected-face
3241 @vindex gnus-summary-selected-face
3242 This is the face (or @dfn{font} as some people call it) that is used to
3243 highlight the current article in the summary buffer.
3244
3245 @item gnus-summary-highlight
3246 @vindex gnus-summary-highlight
3247 Summary lines are highlighted according to this variable, which is a
3248 list where the elements are on the format @var{(FORM . FACE)}.  If you
3249 would, for instance, like ticked articles to be italic and high-scored
3250 articles to be bold, you could set this variable to something like
3251 @lisp
3252 (((eq mark gnus-ticked-mark) . italic)
3253  ((> score default) . bold))
3254 @end lisp
3255 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3256 @var{FACE} will be applied to the line.
3257 @end table
3258
3259
3260 @node Summary Maneuvering
3261 @section Summary Maneuvering
3262 @cindex summary movement
3263
3264 All the straight movement commands understand the numeric prefix and
3265 behave pretty much as you'd expect. 
3266
3267 None of these commands select articles.
3268
3269 @table @kbd
3270 @item G M-n
3271 @itemx M-n
3272 @kindex M-n (Summary)
3273 @kindex G M-n (Summary)
3274 @findex gnus-summary-next-unread-subject
3275 Go to the next summary line of an unread article
3276 (@code{gnus-summary-next-unread-subject}). 
3277
3278 @item G M-p
3279 @itemx M-p
3280 @kindex M-p (Summary)
3281 @kindex G M-p (Summary)
3282 @findex gnus-summary-prev-unread-subject
3283 Go to the previous summary line of an unread article
3284 (@code{gnus-summary-prev-unread-subject}). 
3285
3286 @item G j
3287 @itemx j
3288 @kindex j (Summary)
3289 @kindex G j (Summary)
3290 @findex gnus-summary-goto-article
3291 Ask for an article number and then go to that article
3292 (@code{gnus-summary-goto-article}). 
3293
3294 @item G g
3295 @kindex G g (Summary)
3296 @findex gnus-summary-goto-subject
3297 Ask for an article number and then go the summary line of that article
3298 without displaying the article (@code{gnus-summary-goto-subject}).
3299 @end table
3300
3301 If Gnus asks you to press a key to confirm going to the next group, you
3302 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3303 buffer, searching for the next group to read without actually returning
3304 to the group buffer.
3305
3306 Variables related to summary movement:
3307
3308 @table @code
3309
3310 @vindex gnus-auto-select-next
3311 @item gnus-auto-select-next
3312 If you issue one of the movement commands (like @kbd{n}) and there are
3313 no more unread articles after the current one, Gnus will offer to go to
3314 the next group.  If this variable is @code{t} and the next group is
3315 empty, Gnus will exit summary mode and return to the group buffer.  If
3316 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3317 next group, no matter whether it has any unread articles or not.  As a
3318 special case, if this variable is @code{quietly}, Gnus will select the
3319 next group without asking for confirmation.  If this variable is
3320 @code{almost-quietly}, the same will happen only if you are located on
3321 the last article in the group.  Finally, if this variable is
3322 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3323 without confirmation.  Also @pxref{Group Levels}.
3324
3325 @item gnus-auto-select-same
3326 @vindex gnus-auto-select-same
3327 If non-@code{nil}, all the movement commands will try to go to the next
3328 article with the same subject as the current.  (@dfn{Same} here might
3329 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3330 for details (@pxref{Customizing Threading}).)  This variable is not
3331 particularly useful if you use a threaded display.
3332
3333 @item gnus-summary-check-current
3334 @vindex gnus-summary-check-current
3335 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3336 to the next (or previous) article if the current article is unread.
3337 Instead, they will choose the current article.
3338
3339 @item gnus-auto-center-summary
3340 @vindex gnus-auto-center-summary
3341 If non-@code{nil}, Gnus will keep the point in the summary buffer
3342 centered at all times.  This makes things quite tidy, but if you have a
3343 slow network connection, or simply do not like this un-Emacsism, you can
3344 set this variable to @code{nil} to get the normal Emacs scrolling
3345 action.  This will also inhibit horizontal re-centering of the summary
3346 buffer, which might make it more inconvenient to read extremely long
3347 threads.
3348
3349 @end table
3350
3351
3352 @node Choosing Articles
3353 @section Choosing Articles
3354 @cindex selecting articles
3355
3356 @menu
3357 * Choosing Commands::        Commands for choosing articles.
3358 * Choosing Variables::       Variables that influence these commands.
3359 @end menu
3360
3361
3362 @node Choosing Commands
3363 @subsection Choosing Commands
3364
3365 None of the following movement commands understand the numeric prefix,
3366 and they all select and display an article.
3367
3368 @table @kbd
3369 @item SPACE
3370 @kindex SPACE (Summary)
3371 @findex gnus-summary-next-page
3372 Select the current article, or, if that one's read already, the next
3373 unread article (@code{gnus-summary-next-page}).
3374
3375 @item G n
3376 @itemx n
3377 @kindex n (Summary)
3378 @kindex G n (Summary)
3379 @findex gnus-summary-next-unread-article
3380 Go to next unread article (@code{gnus-summary-next-unread-article}).
3381
3382 @item G p
3383 @itemx p
3384 @kindex p (Summary)
3385 @findex gnus-summary-prev-unread-article
3386 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3387
3388 @item G N
3389 @itemx N
3390 @kindex N (Summary)
3391 @kindex G N (Summary)
3392 @findex gnus-summary-next-article
3393 Go to the next article (@code{gnus-summary-next-article}).
3394
3395 @item G P
3396 @itemx P
3397 @kindex P (Summary)
3398 @kindex G P (Summary)
3399 @findex gnus-summary-prev-article
3400 Go to the previous article (@code{gnus-summary-prev-article}).
3401
3402 @item G C-n
3403 @kindex G C-n (Summary)
3404 @findex gnus-summary-next-same-subject
3405 Go to the next article with the same subject
3406 (@code{gnus-summary-next-same-subject}). 
3407
3408 @item G C-p
3409 @kindex G C-p (Summary)
3410 @findex gnus-summary-prev-same-subject
3411 Go to the previous article with the same subject
3412 (@code{gnus-summary-prev-same-subject}). 
3413
3414 @item G f
3415 @itemx .
3416 @kindex G f  (Summary)
3417 @kindex .  (Summary)
3418 @findex gnus-summary-first-unread-article
3419 Go to the first unread article
3420 (@code{gnus-summary-first-unread-article}).
3421
3422 @item G b
3423 @itemx ,
3424 @kindex G b (Summary)
3425 @kindex , (Summary)
3426 @findex gnus-summary-best-unread-article
3427 Go to the article with the highest score
3428 (@code{gnus-summary-best-unread-article}). 
3429
3430 @item G l
3431 @itemx l
3432 @kindex l (Summary)
3433 @kindex G l (Summary)
3434 @findex gnus-summary-goto-last-article
3435 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3436
3437 @item G p
3438 @kindex G p (Summary)
3439 @findex gnus-summary-pop-article
3440 Pop an article off the summary history and go to this article
3441 (@code{gnus-summary-pop-article}).  This command differs from the
3442 command above in that you can pop as many previous articles off the
3443 history as you like.
3444 @end table
3445
3446
3447 @node Choosing Variables
3448 @subsection Choosing Variables
3449
3450 Some variables that are relevant for moving and selecting articles:
3451
3452 @table @code
3453 @item gnus-auto-extend-newsgroup
3454 @vindex gnus-auto-extend-newsgroup
3455 All the movement commands will try to go to the previous (or next)
3456 article, even if that article isn't displayed in the Summary buffer if
3457 this variable is non-@code{nil}.  Gnus will then fetch the article from
3458 the server and display it in the article buffer.
3459
3460 @item gnus-select-article-hook
3461 @vindex gnus-select-article-hook
3462 This hook is called whenever an article is selected.  By default it
3463 exposes any threads hidden under the selected article.
3464
3465 @item gnus-mark-article-hook
3466 @vindex gnus-mark-article-hook
3467 @findex gnus-summary-mark-unread-as-read
3468 @findex gnus-summary-mark-read-and-unread-as-read
3469 @findex gnus-unread-mark
3470 This hook is called whenever an article is selected.  It is intended to
3471 be used for marking articles as read.  The default value is
3472 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3473 mark of almost any article you read to @code{gnus-unread-mark}.  The
3474 only articles not affected by this function are ticked, dormant, and
3475 expirable articles.  If you'd instead like to just have unread articles
3476 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3477 instead.  It will leave marks like @code{gnus-low-score-mark},
3478 @code{gnus-del-mark} (and so on) alone.
3479
3480 @end table
3481
3482
3483 @node Paging the Article
3484 @section Scrolling the Article
3485 @cindex article scrolling
3486
3487 @table @kbd
3488
3489 @item SPACE
3490 @kindex SPACE (Summary)
3491 @findex gnus-summary-next-page
3492 Pressing @kbd{SPACE} will scroll the current article forward one page,
3493 or, if you have come to the end of the current article, will choose the
3494 next article (@code{gnus-summary-next-page}).
3495
3496 @item DEL
3497 @kindex DEL (Summary)
3498 @findex gnus-summary-prev-page
3499 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3500
3501 @item RET
3502 @kindex RET (Summary)
3503 @findex gnus-summary-scroll-up
3504 Scroll the current article one line forward
3505 (@code{gnus-summary-scroll-up}).
3506
3507 @item A g
3508 @itemx g
3509 @kindex A g (Summary)
3510 @kindex g (Summary)
3511 @findex gnus-summary-show-article
3512 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3513 given a prefix, fetch the current article, but don't run any of the
3514 article treatment functions.  This will give you a ``raw'' article, just
3515 the way it came from the server.
3516
3517 @item A <
3518 @itemx <
3519 @kindex < (Summary)
3520 @kindex A < (Summary)
3521 @findex gnus-summary-beginning-of-article
3522 Scroll to the beginning of the article
3523 (@code{gnus-summary-beginning-of-article}).
3524
3525 @item A >
3526 @itemx >
3527 @kindex > (Summary)
3528 @kindex A > (Summary)
3529 @findex gnus-summary-end-of-article
3530 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3531
3532 @item A s 
3533 @itemx s
3534 @kindex A s (Summary)
3535 @kindex s (Summary)
3536 @findex gnus-summary-isearch-article
3537 Perform an isearch in the article buffer
3538 (@code{gnus-summary-isearch-article}). 
3539
3540 @end table
3541
3542
3543 @node Reply Followup and Post
3544 @section Reply, Followup and Post
3545
3546 @menu
3547 * Summary Mail Commands::            Sending mail.
3548 * Summary Post Commands::            Sending news.
3549 @end menu
3550
3551
3552 @node Summary Mail Commands
3553 @subsection Summary Mail Commands
3554 @cindex mail
3555 @cindex composing mail
3556
3557 Commands for composing a mail message:
3558
3559 @table @kbd
3560
3561 @item S r
3562 @itemx r
3563 @kindex S r (Summary)
3564 @kindex r (Summary)
3565 @findex gnus-summary-reply
3566 Mail a reply to the author of the current article
3567 (@code{gnus-summary-reply}). 
3568
3569 @item S R
3570 @itemx R
3571 @kindex R (Summary)
3572 @kindex S R (Summary)
3573 @findex gnus-summary-reply-with-original
3574 Mail a reply to the author of the current article and include the
3575 original message (@code{gnus-summary-reply-with-original}).  This
3576 command uses the process/prefix convention.
3577
3578 @item S w
3579 @kindex S w (Summary)
3580 @findex gnus-summary-wide-reply
3581 Mail a wide reply to the author of the current article
3582 (@code{gnus-summary-wide-reply}). 
3583
3584 @item S W
3585 @kindex S W (Summary)
3586 @findex gnus-summary-wide-reply-with-original
3587 Mail a wide reply to the current article and include the original
3588 message (@code{gnus-summary-reply-with-original}).  This command uses
3589 the process/prefix convention.
3590
3591 @item S o m
3592 @kindex S o m (Summary)
3593 @findex gnus-summary-mail-forward
3594 Forward the current article to some other person
3595 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3596 headers of the forwarded article.
3597
3598 @item S m
3599 @itemx m
3600 @kindex m (Summary)
3601 @kindex S m (Summary)
3602 @findex gnus-summary-mail-other-window
3603 Send a mail to some other person
3604 (@code{gnus-summary-mail-other-window}).
3605
3606 @item S D b
3607 @kindex S D b (Summary)
3608 @findex gnus-summary-resend-bounced-mail
3609 @cindex bouncing mail
3610 If you have sent a mail, but the mail was bounced back to you for some
3611 reason (wrong address, transient failure), you can use this command to
3612 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3613 will be popped into a mail buffer where you can edit the headers before
3614 sending the mail off again.  If you give a prefix to this command, and
3615 the bounced mail is a reply to some other mail, Gnus will try to fetch
3616 that mail and display it for easy perusal of its headers.  This might
3617 very well fail, though.
3618
3619 @item S D r
3620 @kindex S D r (Summary)
3621 @findex gnus-summary-resend-message
3622 Not to be confused with the previous command,
3623 @code{gnus-summary-resend-message} will prompt you for an address to
3624 send the current message off to, and then send it to that place.  The
3625 headers of the message won't be altered---but lots of headers that say
3626 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3627 means that you actually send a mail to someone that has a @code{To}
3628 header that (probably) points to yourself.  This will confuse people.
3629 So, natcherly you'll only do that if you're really eVIl.  
3630
3631 This command is mainly used if you have several accounts and want to
3632 ship a mail to a different account of yours.  (If you're both
3633 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3634 to the @code{root} account, you may want to resend it to
3635 @code{postmaster}.  Ordnung muß sein!
3636
3637 This command understands the process/prefix convention
3638 (@pxref{Process/Prefix}). 
3639
3640 @item S O m
3641 @kindex S O m (Summary)
3642 @findex gnus-uu-digest-mail-forward
3643 Digest the current series and forward the result using mail
3644 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3645 process/prefix convention (@pxref{Process/Prefix}). 
3646
3647 @item S M-c
3648 @kindex S M-c (Summary)
3649 @findex gnus-summary-mail-crosspost-complaint
3650 @cindex crossposting
3651 @cindex excessive crossposting
3652 Send a complaint about excessive crossposting to the author of the
3653 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3654
3655 @findex gnus-crosspost-complaint
3656 This command is provided as a way to fight back agains the current
3657 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3658 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3659 command understands the process/prefix convention
3660 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3661
3662 @end table
3663
3664
3665 @node Summary Post Commands
3666 @subsection Summary Post Commands
3667 @cindex post
3668 @cindex composing news
3669
3670 Commands for posting a news article:
3671
3672 @table @kbd
3673 @item S p
3674 @itemx a
3675 @kindex a (Summary)
3676 @kindex S p (Summary)
3677 @findex gnus-summary-post-news
3678 Post an article to the current group
3679 (@code{gnus-summary-post-news}).
3680
3681 @item S f
3682 @itemx f
3683 @kindex f (Summary)
3684 @kindex S f (Summary)
3685 @findex gnus-summary-followup
3686 Post a followup to the current article (@code{gnus-summary-followup}).
3687
3688 @item S F
3689 @itemx F
3690 @kindex S F (Summary)
3691 @kindex F (Summary)
3692 @findex gnus-summary-followup-with-original
3693 Post a followup to the current article and include the original message
3694 (@code{gnus-summary-followup-with-original}).   This command uses the
3695 process/prefix convention.
3696
3697 @item S n
3698 @kindex S n (Summary)
3699 @findex gnus-summary-followup-to-mail
3700 Post a followup to the current article via news, even if you got the
3701 message through mail (@code{gnus-summary-followup-to-mail}).
3702
3703 @item S n
3704 @kindex S n (Summary)
3705 @findex gnus-summary-followup-to-mail
3706 Post a followup to the current article via news, even if you got the
3707 message through mail and include the original message
3708 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3709 the process/prefix convention.
3710
3711 @item S o p
3712 @kindex S o p (Summary)
3713 @findex gnus-summary-post-forward
3714 Forward the current article to a newsgroup
3715 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3716 headers of the forwarded article.
3717
3718 @item S O p
3719 @kindex S O p (Summary)
3720 @findex gnus-uu-digest-post-forward
3721 Digest the current series and forward the result to a newsgroup
3722 (@code{gnus-uu-digest-mail-forward}).  
3723
3724 @item S u
3725 @kindex S u (Summary)
3726 @findex gnus-uu-post-news
3727 Uuencode a file, split it into parts, and post it as a series
3728 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3729 @end table
3730
3731
3732 @node Canceling and Superseding
3733 @section Canceling Articles
3734 @cindex canceling articles
3735 @cindex superseding articles
3736
3737 Have you ever written something, and then decided that you really,
3738 really, really wish you hadn't posted that?
3739
3740 Well, you can't cancel mail, but you can cancel posts.
3741
3742 @findex gnus-summary-cancel-article
3743 @kindex C (Summary)
3744 Find the article you wish to cancel (you can only cancel your own
3745 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3746 c} (@code{gnus-summary-cancel-article}).  Your article will be
3747 canceled---machines all over the world will be deleting your article. 
3748
3749 Be aware, however, that not all sites honor cancels, so your article may
3750 live on here and there, while most sites will delete the article in
3751 question.
3752
3753 If you discover that you have made some mistakes and want to do some
3754 corrections, you can post a @dfn{superseding} article that will replace
3755 your original article.
3756
3757 @findex gnus-summary-supersede-article
3758 @kindex S (Summary)
3759 Go to the original article and press @kbd{S s}
3760 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3761 where you can edit the article all you want before sending it off the
3762 usual way.
3763
3764 The same goes for superseding as for canceling, only more so: Some
3765 sites do not honor superseding.  On those sites, it will appear that you
3766 have posted almost the same article twice.
3767
3768 If you have just posted the article, and change your mind right away,
3769 there is a trick you can use to cancel/supersede the article without
3770 waiting for the article to appear on your site first.  You simply return
3771 to the post buffer (which is called @code{*sent ...*}).  There you will
3772 find the article you just posted, with all the headers intact.  Change
3773 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3774 header by substituting one of those words for the word
3775 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3776 you would do normally.  The previous article will be
3777 canceled/superseded.
3778
3779 Just remember, kids: There is no 'c' in 'supersede'.
3780
3781
3782 @node Marking Articles
3783 @section Marking Articles
3784 @cindex article marking
3785 @cindex article ticking
3786 @cindex marks
3787
3788 There are several marks you can set on an article. 
3789
3790 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3791 neologism ohoy!) of the article.  Alphabetic marks generally mean
3792 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3793
3794 In addition, you also have marks that do not affect readedness.
3795
3796 @menu
3797 * Unread Articles::      Marks for unread articles.
3798 * Read Articles::        Marks for read articles.
3799 * Other Marks::          Marks that do not affect readedness.
3800 @end menu
3801
3802 @ifinfo
3803 There's a plethora of commands for manipulating these marks:
3804 @end ifinfo
3805
3806 @menu
3807 * Setting Marks::           How to set and remove marks.
3808 * Setting Process Marks::   How to mark articles for later processing.
3809 @end menu
3810
3811
3812 @node Unread Articles
3813 @subsection Unread Articles
3814
3815 The following marks mark articles as (kinda) unread, in one form or
3816 other.
3817
3818 @table @samp
3819 @item !
3820 @vindex gnus-ticked-mark
3821 Marked as ticked (@code{gnus-ticked-mark}).
3822
3823 @dfn{Ticked articles} are articles that will remain visible always.  If
3824 you see an article that you find interesting, or you want to put off
3825 reading it, or replying to it, until sometime later, you'd typically
3826 tick it.  However, articles can be expired, so if you want to keep an
3827 article forever, you'll have to make it persistent (@pxref{Persistent
3828 Articles}).  
3829
3830 @item ?
3831 @vindex gnus-dormant-mark
3832 Marked as dormant (@code{gnus-dormant-mark}).  
3833
3834 @dfn{Dormant articles} will only appear in the summary buffer if there
3835 are followups to it.
3836
3837 @item SPACE
3838 @vindex gnus-unread-mark
3839 Markes as unread (@code{gnus-unread-mark}).
3840
3841 @dfn{Unread articles} are articles that haven't been read at all yet.
3842 @end table
3843
3844
3845 @node Read Articles
3846 @subsection Read Articles
3847 @cindex expirable mark
3848
3849 All the following marks mark articles as read.
3850
3851 @table @samp
3852
3853 @item r
3854 @vindex gnus-del-mark
3855 These are articles that the user has marked as read with the @kbd{d}
3856 command manually, more or less (@code{gnus-del-mark}).
3857
3858 @item R
3859 @vindex gnus-read-mark
3860 Articles that have actually been read (@code{gnus-read-mark}).
3861
3862 @item O
3863 @vindex gnus-ancient-mark
3864 Articles that were marked as read in previous sessions and are now
3865 @dfn{old} (@code{gnus-ancient-mark}).
3866
3867 @item K
3868 @vindex gnus-killed-mark
3869 Marked as killed (@code{gnus-killed-mark}).
3870
3871 @item X
3872 @vindex gnus-kill-file-mark
3873 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3874
3875 @item Y
3876 @vindex gnus-low-score-mark
3877 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3878
3879 @item C
3880 @vindex gnus-catchup-mark
3881 Marked as read by a catchup (@code{gnus-catchup-mark}).
3882
3883 @item G
3884 @vindex gnus-canceled-mark
3885 Canceled article (@code{gnus-canceled-mark})
3886
3887 @item F
3888 @vindex gnus-souped-mark
3889 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
3890
3891 @item Q
3892 @vindex gnus-sparse-mark
3893 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
3894 Threading}.
3895
3896 @item M
3897 @vindex gnus-duplicate-mark
3898 Article marked as read by duplicate suppression
3899 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
3900
3901 @end table
3902
3903 All these marks just mean that the article is marked as read, really.
3904 They are interpreted differently when doing adaptive scoring, though.
3905
3906 One more special mark, though:
3907
3908 @table @samp
3909 @item E
3910 @vindex gnus-expirable-mark
3911 Marked as expirable (@code{gnus-expirable-mark}).
3912
3913 Marking articles as @dfn{expirable} (or have them marked as such
3914 automatically) doesn't make much sense in normal groups---a user doesn't
3915 control the expiring of news articles, but in mail groups, for instance,
3916 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3917 any time.
3918 @end table
3919
3920
3921 @node Other Marks
3922 @subsection Other Marks
3923 @cindex process mark
3924 @cindex bookmarks
3925
3926 There are some marks that have nothing to do with whether the article is
3927 read or not.
3928
3929 @itemize @bullet
3930
3931 @item 
3932 You can set a bookmark in the current article.  Say you are reading a
3933 long thesis on cats' urinary tracts, and have to go home for dinner
3934 before you've finished reading the thesis.  You can then set a bookmark
3935 in the article, and Gnus will jump to this bookmark the next time it
3936 encounters the article.  @xref{Setting Marks}
3937
3938 @item
3939 @vindex gnus-replied-mark
3940 All articles that you have replied to or made a followup to (i.e., have
3941 answered) will be marked with an @samp{A} in the second column
3942 (@code{gnus-replied-mark}).
3943
3944 @item 
3945 @vindex gnus-cached-mark
3946 Articles that are stored in the article cache will be marked with an
3947 @samp{*} in the second column (@code{gnus-cached-mark}).
3948
3949 @item 
3950 @vindex gnus-saved-mark
3951 Articles that are ``saved'' (in some manner or other; not necessarily
3952 religiously) are marked with an @samp{S} in the second column
3953 (@code{gnus-saved-mark}.
3954
3955 @item 
3956 @vindex gnus-not-empty-thread-mark
3957 @vindex gnus-empty-thread-mark
3958 It the @samp{%e} spec is used, the presence of threads or not will be
3959 marked with @code{gnus-not-empty-thread-mark} and
3960 @code{gnus-empty-thread-mark} in the third column, respectively.
3961
3962 @item 
3963 @vindex gnus-process-mark
3964 Finally we have the @dfn{process mark} (@code{gnus-process-mark}.  A
3965 variety of commands react to the presence of the process mark.  For
3966 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3967 all articles that have been marked with the process mark.  Articles
3968 marked with the process mark have a @samp{#} in the second column.
3969
3970 @end itemize
3971
3972 You might have noticed that most of these ``non-readedness'' marks
3973 appear in the second column by default.  So if you have a cached, saved,
3974 replied article that you have process-marked, what will that look like?
3975
3976 Nothing much.  The precedence rules go as follows: process -> cache ->
3977 replied -> saved.  So if the article is in the cache and is replied,
3978 you'll only see the cache mark and not the replied mark.
3979
3980
3981 @node Setting Marks
3982 @subsection Setting Marks
3983 @cindex setting marks
3984
3985 All the marking commands understand the numeric prefix.
3986
3987 @table @kbd
3988 @item M t
3989 @itemx !
3990 @kindex ! (Summary)
3991 @kindex M t (Summary)
3992 @findex gnus-summary-tick-article-forward
3993 Tick the current article (@code{gnus-summary-tick-article-forward}).
3994
3995 @item M ?
3996 @itemx ?
3997 @kindex ? (Summary)
3998 @kindex M ? (Summary)
3999 @findex gnus-summary-mark-as-dormant
4000 Mark the current article as dormant
4001 (@code{gnus-summary-mark-as-dormant}).
4002
4003 @item M d
4004 @itemx d
4005 @kindex M d (Summary)
4006 @kindex d (Summary)
4007 @findex gnus-summary-mark-as-read-forward
4008 Mark the current article as read
4009 (@code{gnus-summary-mark-as-read-forward}).
4010
4011 @item D
4012 @kindex D (Summary)
4013 @findex gnus-summary-mark-as-read-backward
4014 Mark the current article as read and move point to the previous line
4015 (@code{gnus-summary-mark-as-read-backward}).
4016
4017 @item M k
4018 @itemx k
4019 @kindex k (Summary)
4020 @kindex M k (Summary)
4021 @findex gnus-summary-kill-same-subject-and-select
4022 Mark all articles that have the same subject as the current one as read,
4023 and then select the next unread article
4024 (@code{gnus-summary-kill-same-subject-and-select}).
4025
4026 @item M K
4027 @itemx C-k
4028 @kindex M K (Summary)
4029 @kindex C-k (Summary)
4030 @findex gnus-summary-kill-same-subject
4031 Mark all articles that have the same subject as the current one as read
4032 (@code{gnus-summary-kill-same-subject}).  
4033
4034 @item M C
4035 @kindex M C (Summary)
4036 @findex gnus-summary-catchup
4037 Mark all unread articles as read (@code{gnus-summary-catchup}).
4038
4039 @item M C-c
4040 @kindex M C-c (Summary)
4041 @findex gnus-summary-catchup-all
4042 Mark all articles in the group as read---even the ticked and dormant
4043 articles (@code{gnus-summary-catchup-all}).
4044
4045 @item M H
4046 @kindex M H (Summary)
4047 @findex gnus-summary-catchup-to-here
4048 Catchup the current group to point
4049 (@code{gnus-summary-catchup-to-here}). 
4050
4051 @item C-w
4052 @kindex C-w (Summary)
4053 @findex gnus-summary-mark-region-as-read
4054 Mark all articles between point and mark as read
4055 (@code{gnus-summary-mark-region-as-read}). 
4056
4057 @item M V k
4058 @kindex M V k (Summary)
4059 @findex gnus-summary-kill-below
4060 Kill all articles with scores below the default score (or below the
4061 numeric prefix) (@code{gnus-summary-kill-below}).
4062
4063 @item M c
4064 @itemx M-u
4065 @kindex M c (Summary)
4066 @kindex M-u (Summary)
4067 @findex gnus-summary-clear-mark-forward
4068 Clear all readedness-marks from the current article
4069 (@code{gnus-summary-clear-mark-forward}).
4070
4071 @item M e
4072 @itemx E
4073 @kindex M e (Summary)
4074 @kindex E (Summary)
4075 @findex gnus-summary-mark-as-expirable
4076 Mark the current article as expirable
4077 (@code{gnus-summary-mark-as-expirable}).
4078
4079 @item M b
4080 @kindex M b (Summary)
4081 @findex gnus-summary-set-bookmark
4082 Set a bookmark in the current article
4083 (@code{gnus-summary-set-bookmark}).
4084
4085 @item M B
4086 @kindex M B (Summary)
4087 @findex gnus-summary-remove-bookmark
4088 Remove the bookmark from the current article
4089 (@code{gnus-summary-remove-bookmark}).
4090
4091 @item M V c
4092 @kindex M V c (Summary)
4093 @findex gnus-summary-clear-above
4094 Clear all marks from articles with scores over the default score (or
4095 over the numeric prefix) (@code{gnus-summary-clear-above}).
4096
4097 @item M V u
4098 @kindex M V u (Summary)
4099 @findex gnus-summary-tick-above
4100 Tick all articles with scores over the default score (or over the
4101 numeric prefix) (@code{gnus-summary-tick-above}).
4102
4103 @item M V m
4104 @kindex M V m (Summary)
4105 @findex gnus-summary-mark-above
4106 Prompt for a mark, and mark all articles with scores over the default
4107 score (or over the numeric prefix) with this mark
4108 (@code{gnus-summary-clear-above}).
4109 @end table
4110
4111 @vindex gnus-summary-goto-unread
4112 The @code{gnus-summary-goto-unread} variable controls what action should
4113 be taken after setting a mark.  If non-@code{nil}, point will move to
4114 the next/previous unread article.  If @code{nil}, point will just move
4115 one line up or down.  As a special case, if this variable is
4116 @code{never}, all the marking commands as well as other commands (like
4117 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4118 The default is @code{t}.
4119
4120
4121 @node Setting Process Marks
4122 @subsection Setting Process Marks
4123 @cindex setting process marks
4124
4125 @table @kbd
4126
4127 @item M P p
4128 @itemx #
4129 @kindex # (Summary)
4130 @kindex M P p (Summary)
4131 @findex gnus-summary-mark-as-processable
4132 Mark the current article with the process mark
4133 (@code{gnus-summary-mark-as-processable}). 
4134 @findex gnus-summary-unmark-as-processable
4135
4136 @item M P u 
4137 @itemx M-#
4138 @kindex M P u (Summary)
4139 @kindex M-# (Summary)
4140 Remove the process mark, if any, from the current article
4141 (@code{gnus-summary-unmark-as-processable}).
4142
4143 @item M P U
4144 @kindex M P U (Summary)
4145 @findex gnus-summary-unmark-all-processable
4146 Remove the process mark from all articles
4147 (@code{gnus-summary-unmark-all-processable}). 
4148
4149 @item M P i
4150 @kindex M P i (Summary)
4151 @findex gnus-uu-invert-processable
4152 Invert the list of process marked articles
4153 (@code{gnus-uu-invert-processable}). 
4154
4155 @item M P R
4156 @kindex M P R (Summary)
4157 @findex gnus-uu-mark-by-regexp
4158 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4159
4160 @item M P r
4161 @kindex M P r (Summary)
4162 @findex gnus-uu-mark-region
4163 Mark articles in region (@code{gnus-uu-mark-region}).
4164
4165 @item M P t
4166 @kindex M P t (Summary)
4167 @findex gnus-uu-mark-thread
4168 Mark all articles in the current (sub)thread
4169 (@code{gnus-uu-mark-thread}).
4170
4171 @item M P T
4172 @kindex M P T (Summary)
4173 @findex gnus-uu-unmark-thread
4174 Unmark all articles in the current (sub)thread
4175 (@code{gnus-uu-unmark-thread}).
4176
4177 @item M P v
4178 @kindex M P v (Summary)
4179 @findex gnus-uu-mark-over
4180 Mark all articles that have a score above the prefix argument
4181 (@code{gnus-uu-mark-over}).
4182
4183 @item M P s
4184 @kindex M P s (Summary)
4185 @findex gnus-uu-mark-series
4186 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4187
4188 @item M P S
4189 @kindex M P S (Summary)
4190 @findex gnus-uu-mark-sparse
4191 Mark all series that have already had some articles marked
4192 (@code{gnus-uu-mark-sparse}).
4193
4194 @item M P a
4195 @kindex M P a (Summary)
4196 @findex gnus-uu-mark-all
4197 Mark all articles in series order (@code{gnus-uu-mark-series}).
4198
4199 @item M P b
4200 @kindex M P b (Summary)
4201 @findex gnus-uu-mark-buffer
4202 Mark all articles in the buffer in the order they appear
4203 (@code{gnus-uu-mark-buffer}). 
4204
4205 @item M P k
4206 @kindex M P k (Summary)
4207 @findex gnus-summary-kill-process-mark
4208 Push the current process mark set onto the stack and unmark all articles
4209 (@code{gnus-summary-kill-process-mark}).
4210
4211 @item M P y
4212 @kindex M P y (Summary)
4213 @findex gnus-summary-yank-process-mark
4214 Pop the previous process mark set from the stack and restore it
4215 (@code{gnus-summary-yank-process-mark}).
4216
4217 @item M P w
4218 @kindex M P w (Summary)
4219 @findex gnus-summary-save-process-mark
4220 Push the current process mark set onto the stack
4221 (@code{gnus-summary-save-process-mark}).
4222
4223 @end table
4224
4225
4226 @node Limiting
4227 @section Limiting
4228 @cindex limiting
4229
4230 It can be convenient to limit the summary buffer to just show some
4231 subset of the articles currently in the group.  The effect most limit
4232 commands have is to remove a few (or many) articles from the summary
4233 buffer. 
4234
4235 @table @kbd
4236
4237 @item / /
4238 @itemx / s
4239 @kindex / / (Summary)
4240 @findex gnus-summary-limit-to-subject
4241 Limit the summary buffer to articles that match some subject
4242 (@code{gnus-summary-limit-to-subject}). 
4243
4244 @item / a
4245 @kindex / a (Summary)
4246 @findex gnus-summary-limit-to-author
4247 Limit the summary buffer to articles that match some author
4248 (@code{gnus-summary-limit-to-author}).
4249
4250 @item / u
4251 @itemx x
4252 @kindex / u (Summary)
4253 @kindex x (Summary)
4254 @findex gnus-summary-limit-to-unread
4255 Limit the summary buffer to articles that are not marked as read
4256 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4257 buffer to articles that are strictly unread.  This means that ticked and
4258 dormant articles will also be excluded.
4259
4260 @item / m
4261 @kindex / m (Summary)
4262 @findex gnus-summary-limit-to-marks
4263 Ask for a mark and then limit to all articles that have not been marked
4264 with that mark (@code{gnus-summary-limit-to-marks}).
4265
4266 @item / t
4267 @kindex / t (Summary)
4268 @findex gnus-summary-limit-to-age
4269 Ask for a number and then limit the summary buffer to articles that are
4270 older than (or equal to) that number of days
4271 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4272 articles that are younger than that number of days.
4273
4274 @item / n
4275 @kindex / n (Summary)
4276 @findex gnus-summary-limit-to-articles
4277 Limit the summary buffer to the current article
4278 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4279 convention (@pxref{Process/Prefix}).
4280
4281 @item / w
4282 @kindex / w (Summary)
4283 @findex gnus-summary-pop-limit
4284 Pop the previous limit off the stack and restore it
4285 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4286 the stack.
4287
4288 @item / v
4289 @kindex / v (Summary)
4290 @findex gnus-summary-limit-to-score
4291 Limit the summary buffer to articles that have a score at or above some
4292 score (@code{gnus-summary-limit-to-score}).
4293
4294 @item / E
4295 @itemx M S
4296 @kindex M S (Summary)
4297 @kindex / E (Summary)
4298 @findex gnus-summary-limit-include-expunged
4299 Display all expunged articles
4300 (@code{gnus-summary-limit-include-expunged}). 
4301
4302 @item / D
4303 @kindex / D (Summary)
4304 @findex gnus-summary-limit-include-dormant
4305 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4306
4307 @item / d
4308 @kindex / d (Summary)
4309 @findex gnus-summary-limit-exclude-dormant
4310 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4311
4312 @item / c
4313 @kindex / c (Summary)
4314 @findex gnus-summary-limit-exclude-childless-dormant
4315 Hide all dormant articles that have no children
4316 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4317
4318 @item / C
4319 @kindex / C (Summary)
4320 @findex gnus-summary-limit-mark-excluded-as-read
4321 Mark all excluded unread articles as read
4322 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4323 also mark excluded ticked and dormant articles as read.
4324
4325 @end table
4326
4327
4328 @node Threading
4329 @section Threading
4330 @cindex threading
4331 @cindex article threading
4332
4333 Gnus threads articles by default.  @dfn{To thread} is to put responses
4334 to articles directly after the articles they respond to---in a
4335 hierarchical fashion.
4336
4337 @menu
4338 * Customizing Threading::     Variables you can change to affect the threading.
4339 * Thread Commands::           Thread based commands in the summary buffer.
4340 @end menu
4341
4342
4343 @node Customizing Threading
4344 @subsection Customizing Threading
4345 @cindex customizing threading
4346 @cindex <
4347 @cindex >
4348
4349 @table @code
4350
4351 @item gnus-show-threads
4352 @vindex gnus-show-threads
4353 If this variable is @code{nil}, no threading will be done, and all of
4354 the rest of the variables here will have no effect.  Turning threading
4355 off will speed group selection up a bit, but it is sure to make reading
4356 slower and more awkward.
4357
4358 @item gnus-fetch-old-headers
4359 @vindex gnus-fetch-old-headers
4360 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4361 more old headers---headers to articles that are marked as read.  If you
4362 would like to display as few summary lines as possible, but still
4363 connect as many loose threads as possible, you should set this variable
4364 to @code{some} or a number.  If you set it to a number, no more than
4365 that number of extra old headers will be fetched.  In either case,
4366 fetching old headers only works if the backend you are using carries
4367 overview files---this would normally be @code{nntp}, @code{nnspool} and
4368 @code{nnml}.  Also remember that if the root of the thread has been
4369 expired by the server, there's not much Gnus can do about that.
4370
4371 @item gnus-build-sparse-threads
4372 @vindex gnus-build-sparse-threads
4373 Fetching old headers can be slow.  A low-rent similar effect can be
4374 gotten by setting this variable to @code{some}.  Gnus will then look at
4375 the complete @code{References} headers of all articles and try to string
4376 articles that belong in the same thread together.  This will leave
4377 @dfn{gaps} in the threading display where Gnus guesses that an article
4378 is missing from the thread.  (These gaps appear like normal summary
4379 lines.  If you select a gap, Gnus will try to fetch the article in
4380 question.)  If this variable is @code{t}, Gnus will display all these
4381 ``gaps'' without regard for whether they are useful for completing the
4382 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4383 off sparse leaf nodes that don't lead anywhere.  This variable is
4384 @code{nil} by default.
4385
4386 @item gnus-summary-gather-subject-limit
4387 @vindex gnus-summary-gather-subject-limit
4388 Loose threads are gathered by comparing subjects of articles.  If this
4389 variable is @code{nil}, Gnus requires an exact match between the
4390 subjects of the loose threads before gathering them into one big
4391 super-thread.  This might be too strict a requirement, what with the
4392 presence of stupid newsreaders that chop off long subjects lines.  If
4393 you think so, set this variable to, say, 20 to require that only the
4394 first 20 characters of the subjects have to match.  If you set this
4395 variable to a really low number, you'll find that Gnus will gather
4396 everything in sight into one thread, which isn't very helpful.
4397
4398 @cindex fuzzy article gathering
4399 If you set this variable to the special value @code{fuzzy}, Gnus will
4400 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4401 Matching}). 
4402
4403 @item gnus-simplify-subject-fuzzy-regexp
4404 @vindex gnus-simplify-subject-fuzzy-regexp
4405 This can either be a regular expression or list of regular expressions
4406 that match strings that will be removed from subjects if fuzzy subject
4407 simplification is used.
4408
4409 @item gnus-simplify-ignored-prefixes
4410 @vindex gnus-simplify-ignored-prefixes
4411 If you set @code{gnus-summary-gather-subject-limit} to something as low
4412 as 10, you might consider setting this variable to something sensible:
4413
4414 @c Written by Michael Ernst <mernst@cs.rice.edu>
4415 @lisp
4416 (setq gnus-simplify-ignored-prefixes
4417       (concat 
4418        "\\`\\[?\\("
4419        (mapconcat 
4420         'identity
4421         '("looking"
4422           "wanted" "followup" "summary\\( of\\)?"
4423           "help" "query" "problem" "question" 
4424           "answer" "reference" "announce"
4425           "How can I" "How to" "Comparison of"
4426           ;; ...
4427           )
4428         "\\|")
4429        "\\)\\s *\\("
4430        (mapconcat 'identity
4431                   '("for" "for reference" "with" "about")
4432                   "\\|")
4433        "\\)?\\]?:?[ \t]*"))
4434 @end lisp
4435
4436 All words that match this regexp will be removed before comparing two
4437 subjects. 
4438
4439 @item gnus-summary-gather-exclude-subject
4440 @vindex gnus-summary-gather-exclude-subject
4441 Since loose thread gathering is done on subjects only, that might lead
4442 to many false hits, especially with certain common subjects like
4443 @samp{} and @samp{(none)}.  To make the situation slightly better,
4444 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4445 what subjects should be excluded from the gathering process.  The
4446 default is @samp{^ *$\\|^(none)$}.  
4447
4448 @item gnus-summary-thread-gathering-function
4449 @vindex gnus-summary-thread-gathering-function
4450 Gnus gathers threads by looking at @code{Subject} headers.  This means
4451 that totally unrelated articles may end up in the same ``thread'', which
4452 is confusing.  An alternate approach is to look at all the
4453 @code{Message-ID}s in all the @code{References} headers to find matches.
4454 This will ensure that no gathered threads ever includes unrelated
4455 articles, but it's also means that people who have posted with broken
4456 newsreaders won't be gathered properly.  The choice is yours---plague or
4457 cholera:
4458
4459 @table @code
4460 @item gnus-gather-threads-by-subject
4461 @findex gnus-gather-threads-by-subject
4462 This function is the default gathering function and looks at
4463 @code{Subject}s exclusively.
4464
4465 @item gnus-gather-threads-by-references
4466 @findex gnus-gather-threads-by-references
4467 This function looks at @code{References} headers exclusively.
4468 @end table
4469
4470 If you want to test gathering by @code{References}, you could say
4471 something like:
4472
4473 @lisp
4474 (setq gnus-summary-thread-gathering-function
4475       'gnus-gather-threads-by-references)
4476 @end lisp
4477
4478 @item gnus-summary-make-false-root
4479 @vindex gnus-summary-make-false-root
4480 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4481 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4482 Yup.)  Loose subtrees occur when the real root has expired, or you've
4483 read or killed the root in a previous session.
4484
4485 When there is no real root of a thread, Gnus will have to fudge
4486 something.  This variable says what fudging method Gnus should use.
4487 There are four possible values:
4488
4489 @cindex adopting articles
4490
4491 @table @code
4492
4493 @item adopt
4494 Gnus will make the first of the orphaned articles the parent.  This
4495 parent will adopt all the other articles.  The adopted articles will be
4496 marked as such by pointy brackets (@samp{<>}) instead of the standard
4497 square brackets (@samp{[]}).  This is the default method.
4498
4499 @item dummy
4500 @vindex gnus-summary-dummy-line-format
4501 Gnus will create a dummy summary line that will pretend to be the
4502 parent.  This dummy line does not correspond to any real article, so
4503 selecting it will just select the first real article after the dummy
4504 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4505 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4506 which is the subject of the article.  @xref{Formatting Variables}.
4507
4508 @item empty
4509 Gnus won't actually make any article the parent, but simply leave the
4510 subject field of all orphans except the first empty.  (Actually, it will
4511 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4512 Buffer Format}).)
4513
4514 @item none
4515 Don't make any article parent at all.  Just gather the threads and
4516 display them after one another.
4517
4518 @item nil
4519 Don't gather loose threads.
4520 @end table
4521
4522 @item gnus-thread-hide-subtree
4523 @vindex gnus-thread-hide-subtree
4524 If non-@code{nil}, all threads will be hidden when the summary buffer is
4525 generated.
4526
4527 @item gnus-thread-expunge-below
4528 @vindex gnus-thread-expunge-below
4529 All threads that have a total score (as defined by
4530 @code{gnus-thread-score-function}) less than this number will be
4531 expunged.  This variable is @code{nil} by default, which means that no
4532 threads are expunged.
4533
4534 @item gnus-thread-hide-killed
4535 @vindex gnus-thread-hide-killed
4536 if you kill a thread and this variable is non-@code{nil}, the subtree
4537 will be hidden.
4538
4539 @item gnus-thread-ignore-subject
4540 @vindex gnus-thread-ignore-subject
4541 Sometimes somebody changes the subject in the middle of a thread.  If
4542 this variable is non-@code{nil}, the subject change is ignored.  If it
4543 is @code{nil}, which is the default, a change in the subject will result
4544 in a new thread.
4545
4546 @item gnus-thread-indent-level
4547 @vindex gnus-thread-indent-level
4548 This is a number that says how much each sub-thread should be indented.
4549 The default is 4.
4550
4551 @item gnus-parse-headers-hook
4552 @vindex gnus-parse-headers-hook
4553 Hook run before parsing any headers.  The default value is
4554 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4555 slightly decoded in a hackish way.  This is likely to change in the
4556 future when Gnus becomes @sc{MIME}ified.
4557
4558 @end table
4559
4560
4561 @node Thread Commands
4562 @subsection Thread Commands
4563 @cindex thread commands
4564
4565 @table @kbd
4566
4567 @item T k
4568 @itemx M-C-k
4569 @kindex T k (Summary)
4570 @kindex M-C-k (Summary)
4571 @findex gnus-summary-kill-thread
4572 Mark all articles in the current (sub-)thread as read
4573 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4574 remove all marks instead.  If the prefix argument is negative, tick
4575 articles instead.
4576
4577 @item T l
4578 @itemx M-C-l
4579 @kindex T l (Summary)
4580 @kindex M-C-l (Summary)
4581 @findex gnus-summary-lower-thread
4582 Lower the score of the current (sub-)thread
4583 (@code{gnus-summary-lower-thread}). 
4584
4585 @item T i
4586 @kindex T i (Summary)
4587 @findex gnus-summary-raise-thread
4588 Increase the score of the current (sub-)thread
4589 (@code{gnus-summary-raise-thread}).
4590
4591 @item T #
4592 @kindex T # (Summary)
4593 @findex gnus-uu-mark-thread
4594 Set the process mark on the current (sub-)thread
4595 (@code{gnus-uu-mark-thread}).
4596
4597 @item T M-#
4598 @kindex T M-# (Summary)
4599 @findex gnus-uu-unmark-thread
4600 Remove the process mark from the current (sub-)thread
4601 (@code{gnus-uu-unmark-thread}).
4602
4603 @item T T
4604 @kindex T T (Summary)
4605 @findex gnus-summary-toggle-threads
4606 Toggle threading (@code{gnus-summary-toggle-threads}).
4607
4608 @item T s
4609 @kindex T s (Summary)
4610 @findex gnus-summary-show-thread
4611 Expose the (sub-)thread hidden under the current article, if any
4612 (@code{gnus-summary-show-thread}).
4613
4614 @item T h
4615 @kindex T h (Summary)
4616 @findex gnus-summary-hide-thread
4617 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4618
4619 @item T S
4620 @kindex T S (Summary)
4621 @findex gnus-summary-show-all-threads
4622 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4623
4624 @item T H
4625 @kindex T H (Summary)
4626 @findex gnus-summary-hide-all-threads
4627 Hide all threads (@code{gnus-summary-hide-all-threads}).
4628
4629 @item T t
4630 @kindex T t (Summary)
4631 @findex gnus-summary-rethread-current
4632 Re-thread the thread the current article is part of
4633 (@code{gnus-summary-rethread-current}).  This works even when the
4634 summary buffer is otherwise unthreaded.
4635
4636 @item T ^
4637 @kindex T ^ (Summary)
4638 @findex gnus-summary-reparent-thread
4639 Make the current article the child of the marked (or previous) article
4640 (@code{gnus-summary-reparent-thread}.
4641
4642 @end table
4643
4644 The following commands are thread movement commands.  They all
4645 understand the numeric prefix.
4646
4647 @table @kbd
4648
4649 @item T n
4650 @kindex T n (Summary)
4651 @findex gnus-summary-next-thread
4652 Go to the next thread (@code{gnus-summary-next-thread}).
4653
4654 @item T p
4655 @kindex T p (Summary)
4656 @findex gnus-summary-prev-thread
4657 Go to the previous thread (@code{gnus-summary-prev-thread}).
4658
4659 @item T d
4660 @kindex T d (Summary)
4661 @findex gnus-summary-down-thread
4662 Descend the thread (@code{gnus-summary-down-thread}).
4663
4664 @item T u
4665 @kindex T u (Summary)
4666 @findex gnus-summary-up-thread
4667 Ascend the thread (@code{gnus-summary-up-thread}).
4668
4669 @item T o
4670 @kindex T o (Summary)
4671 @findex gnus-summary-top-thread
4672 Go to the top of the thread (@code{gnus-summary-top-thread}).
4673 @end table
4674
4675 @vindex gnus-thread-operation-ignore-subject 
4676 If you ignore subject while threading, you'll naturally end up with
4677 threads that have several different subjects in them.  If you then issue
4678 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4679 wish to kill the entire thread, but just those parts of the thread that
4680 have the same subject as the current article.  If you like this idea,
4681 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If is
4682 is non-@code{nil} (which it is by default), subjects will be ignored
4683 when doing thread commands.  If this variable is @code{nil}, articles in
4684 the same thread with different subjects will not be included in the
4685 operation in question.  If this variable is @code{fuzzy}, only articles
4686 that have subjects that are fuzzily equal will be included (@pxref{Fuzzy
4687 Matching}).
4688
4689
4690 @node Sorting
4691 @section Sorting
4692
4693 @findex gnus-thread-sort-by-total-score
4694 @findex gnus-thread-sort-by-date
4695 @findex gnus-thread-sort-by-score
4696 @findex gnus-thread-sort-by-subject
4697 @findex gnus-thread-sort-by-author
4698 @findex gnus-thread-sort-by-number
4699 @vindex gnus-thread-sort-functions
4700 If you are using a threaded summary display, you can sort the threads by
4701 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4702 By default, sorting is done on article numbers.  Ready-made sorting
4703 predicate functions include @code{gnus-thread-sort-by-number},
4704 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4705 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4706 @code{gnus-thread-sort-by-total-score}.
4707
4708 Each function takes two threads and return non-@code{nil} if the first
4709 thread should be sorted before the other.  Note that sorting really is
4710 normally done by looking only at the roots of each thread.  If you use
4711 more than one function, the primary sort key should be the last function
4712 in the list.  You should probably always include
4713 @code{gnus-thread-sort-by-number} in the list of sorting
4714 functions---preferably first.  This will ensure that threads that are
4715 equal with respect to the other sort criteria will be displayed in
4716 ascending article order.
4717
4718 If you would like to sort by score, then by subject, and finally by
4719 number, you could do something like:
4720
4721 @lisp
4722 (setq gnus-thread-sort-functions 
4723       '(gnus-thread-sort-by-number
4724         gnus-thread-sort-by-subject
4725         gnus-thread-sort-by-score))
4726 @end lisp
4727
4728 The threads that have highest score will be displayed first in the
4729 summary buffer.  When threads have the same score, they will be sorted
4730 alphabetically.  The threads that have the same score and the same
4731 subject will be sorted by number, which is (normally) the sequence in
4732 which the articles arrived.
4733
4734 If you want to sort by score and then reverse arrival order, you could
4735 say something like:
4736
4737 @lisp
4738 (setq gnus-thread-sort-functions
4739       '((lambda (t1 t2) 
4740           (not (gnus-thread-sort-by-number t1 t2)))
4741         gnus-thread-sort-by-score))
4742 @end lisp
4743
4744 @vindex gnus-thread-score-function
4745 The function in the @code{gnus-thread-score-function} variable (default
4746 @code{+}) is used for calculating the total score of a thread.  Useful
4747 functions might be @code{max}, @code{min}, or squared means, or whatever
4748 tickles your fancy.
4749
4750 @findex gnus-article-sort-functions
4751 @findex gnus-article-sort-by-date
4752 @findex gnus-article-sort-by-score
4753 @findex gnus-article-sort-by-subject
4754 @findex gnus-article-sort-by-author
4755 @findex gnus-article-sort-by-number
4756 If you are using an unthreaded display for some strange reason or other,
4757 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4758 It is very similar to the @code{gnus-thread-sort-functions}, except that
4759 is uses slightly different functions for article comparison.  Available
4760 sorting predicate functions are @code{gnus-article-sort-by-number},
4761 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4762 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4763
4764 If you want to sort an unthreaded summary display by subject, you could
4765 say something like:
4766
4767 @lisp
4768 (setq gnus-article-sort-functions 
4769       '(gnus-article-sort-by-number
4770         gnus-article-sort-by-subject))
4771 @end lisp
4772
4773
4774
4775 @node Asynchronous Fetching
4776 @section Asynchronous Article Fetching
4777 @cindex asynchronous article fetching
4778 @cindex article pre-fetch
4779 @cindex pre-fetch
4780
4781 If you read your news from an @sc{nntp} server that's far away, the
4782 network latencies may make reading articles a chore.  You have to wait
4783 for a while after pressing @kbd{n} to go to the next article before the
4784 article appears.  Why can't Gnus just go ahead and fetch the article
4785 while you are reading the previous one?  Why not, indeed.
4786
4787 First, some caveats.  There are some pitfalls to using asynchronous
4788 article fetching, especially the way Gnus does it.  
4789
4790 Let's say you are reading article 1, which is short, and article 2 is
4791 quite long, and you are not interested in reading that.  Gnus does not
4792 know this, so it goes ahead and fetches article 2.  You decide to read
4793 article 3, but since Gnus is in the process of fetching article 2, the
4794 connection is blocked.
4795
4796 To avoid these situations, Gnus will open two (count 'em two)
4797 connections to the server.  Some people may think this isn't a very nice
4798 thing to do, but I don't see any real alternatives.  Setting up that
4799 extra connection takes some time, so Gnus startup will be slower.
4800
4801 Gnus will fetch more articles than you will read.  This will mean that
4802 the link between your machine and the @sc{nntp} server will become more
4803 loaded than if you didn't use article pre-fetch.  The server itself will
4804 also become more loaded---both with the extra article requests, and the
4805 extra connection.
4806
4807 Ok, so now you know that you shouldn't really use this thing...  unless
4808 you really want to.
4809
4810 @vindex gnus-asynchronous
4811 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4812 happen automatically.
4813
4814 @vindex gnus-use-article-prefetch
4815 You can control how many articles that are to be pre-fetched by setting
4816 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
4817 that when you read an article in the group, the backend will pre-fetch
4818 the next 30 articles.  If this variable is @code{t}, the backend will
4819 pre-fetch all the articles that it can without bound.  If it is
4820 @code{nil}, no pre-fetching will be made.
4821
4822 @vindex gnus-async-prefetch-article-p
4823 @findex gnus-async-read-p
4824 There are probably some articles that you don't want to pre-fetch---read
4825 articles, for instance.  Which articles to pre-fetch is controlled by
4826 the @code{gnus-async-prefetch-article-p} variable.  This function should
4827 return non-@code{nil} when the article in question is to be
4828 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
4829 @code{nil} on read articles.  The function is called with an article
4830 data structure as the only parameter.
4831
4832 If, for instance, you wish to pre-fetch only unread articles that are
4833 shorter than 100 lines, you could say something like:
4834
4835 @lisp
4836 (defun my-async-short-unread-p (data)
4837   "Return non-nil for short, unread articles."
4838   (and (gnus-data-unread-p data)
4839        (< (mail-header-lines (gnus-data-header data))
4840           100)))
4841
4842 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4843 @end lisp
4844
4845 These functions will be called many, many times, so they should
4846 preferrably be short and sweet to avoid slowing down Gnus too much.
4847 It's also probably a good idea to byte-compile things like this.
4848
4849 @vindex gnus-prefetched-article-deletion-strategy
4850 Articles have to be removed from the asynch buffer sooner or later.  The
4851 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4852 articles.  This is a list that may contain the following elements:
4853
4854 @table @code
4855 @item read
4856 Remove articles when they are read.
4857
4858 @item exit
4859 Remove articles when exiting the group.
4860 @end table
4861
4862 The default value is @code{(read exit)}.
4863
4864 @vindex gnus-use-header-prefetch
4865 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4866 from the next group.
4867
4868
4869 @node Article Caching
4870 @section Article Caching
4871 @cindex article caching
4872 @cindex caching
4873
4874 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4875 consider turning article caching on.  Each article will then be stored
4876 locally under your home directory.  As you may surmise, this could
4877 potentially use @emph{huge} amounts of disk space, as well as eat up all
4878 your inodes so fast it will make your head swim.  In vodka.
4879
4880 Used carefully, though, it could be just an easier way to save articles.
4881
4882 @vindex gnus-use-long-file-name
4883 @vindex gnus-cache-directory
4884 @vindex gnus-use-cache
4885 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4886 all articles that are ticked or marked as dormant will then be copied
4887 over to your local cache (@code{gnus-cache-directory}).  Whether this
4888 cache is flat or hierarchal is controlled by the
4889 @code{gnus-use-long-file-name} variable, as usual.
4890
4891 When re-select a ticked or dormant article, it will be fetched from the
4892 cache instead of from the server.  As articles in your cache will never
4893 expire, this might serve as a method of saving articles while still
4894 keeping them where they belong.  Just mark all articles you want to save
4895 as dormant, and don't worry.
4896
4897 When an article is marked as read, is it removed from the cache.
4898
4899 @vindex gnus-cache-remove-articles
4900 @vindex gnus-cache-enter-articles
4901 The entering/removal of articles from the cache is controlled by the
4902 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4903 variables.  Both are lists of symbols.  The first is @code{(ticked
4904 dormant)} by default, meaning that ticked and dormant articles will be
4905 put in the cache.  The latter is @code{(read)} by default, meaning that
4906 articles that are marked as read are removed from the cache.  Possibly
4907 symbols in these two lists are @code{ticked}, @code{dormant},
4908 @code{unread} and @code{read}.
4909
4910 @findex gnus-jog-cache
4911 So where does the massive article-fetching and storing come into the
4912 picture?  The @code{gnus-jog-cache} command will go through all
4913 subscribed newsgroups, request all unread articles, and store them in
4914 the cache.  You should only ever, ever ever ever, use this command if 1)
4915 your connection to the @sc{nntp} server is really, really, really slow
4916 and 2) you have a really, really, really huge disk.  Seriously.
4917
4918 @vindex gnus-uncacheable-groups
4919 It is likely that you do not want caching on some groups.  For instance,
4920 if your @code{nnml} mail is located under your home directory, it makes no
4921 sense to cache it somewhere else under your home directory.  Unless you
4922 feel that it's neat to use twice as much space.  To limit the caching,
4923 you could set the @code{gnus-uncacheable-groups} regexp to
4924 @samp{^nnml}, for instance.  This variable is @code{nil} by
4925 default.
4926
4927 @findex gnus-cache-generate-nov-databases
4928 @findex gnus-cache-generate-active
4929 @vindex gnus-cache-active-file
4930 The cache stores information on what articles it contains in its active
4931 file (@code{gnus-cache-active-file}).  If this file (or any other parts
4932 of the cache) becomes all messed up for some reason or other, Gnus
4933 offers two functions that will try to set things right.  @kbd{M-x
4934 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4935 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4936 file.
4937
4938
4939 @node Persistent Articles
4940 @section Persistent Articles
4941 @cindex persistent articles
4942
4943 Closely related to article caching, we have @dfn{persistent articles}.
4944 In fact, it's just a different way of looking at caching, and much more
4945 useful in my opinion.
4946
4947 Say you're reading a newsgroup, and you happen on to some valuable gem
4948 that you want to keep and treasure forever.  You'd normally just save it
4949 (using one of the many saving commands) in some file.  The problem with
4950 that is that it's just, well, yucky.  Ideally you'd prefer just having
4951 the article remain in the group where you found it forever; untouched by
4952 the expiry going on at the news server.
4953
4954 This is what a @dfn{persistent article} is---an article that just won't
4955 be deleted.  It's implemented using the normal cache functions, but
4956 you use two explicit commands for managing persistent articles:
4957
4958 @table @kbd
4959
4960 @item *
4961 @kindex * (Summary)
4962 @findex gnus-cache-enter-article
4963 Make the current article persistent (@code{gnus-cache-enter-article}). 
4964
4965 @item M-*
4966 @kindex M-* (Summary)
4967 @findex gnus-cache-remove-article
4968 Remove the current article from the persistent articles
4969 (@code{gnus-cache-remove-article}).  This will normally delete the
4970 article. 
4971 @end table
4972
4973 Both these commands understand the process/prefix convention. 
4974
4975 To avoid having all ticked articles (and stuff) entered into the cache,
4976 you should set @code{gnus-use-cache} to @code{passive} if you're just
4977 interested in persistent articles:
4978
4979 @lisp
4980 (setq gnus-use-cache 'passive)
4981 @end lisp
4982
4983
4984 @node Article Backlog
4985 @section Article Backlog
4986 @cindex backlog
4987 @cindex article backlog
4988
4989 If you have a slow connection, but the idea of using caching seems
4990 unappealing to you (and it is, really), you can help the situation some
4991 by switching on the @dfn{backlog}.  This is where Gnus will buffer
4992 already read articles so that it doesn't have to re-fetch articles
4993 you've already read.  This only helps if you are in the habit of
4994 re-selecting articles you've recently read, of course.  If you never do
4995 that, turning the backlog on will slow Gnus down a little bit, and
4996 increase memory usage some.
4997
4998 @vindex gnus-keep-backlog
4999 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5000 at most @var{n} old articles in a buffer for later re-fetching.  If this
5001 variable is non-@code{nil} and is not a number, Gnus will store
5002 @emph{all} read articles, which means that your Emacs will grow without
5003 bound before exploding and taking your machine down with you.  I put
5004 that in there just to keep y'all on your toes.  
5005
5006 This variable is @code{nil} by default.
5007
5008
5009 @node Saving Articles
5010 @section Saving Articles
5011 @cindex saving articles
5012
5013 Gnus can save articles in a number of ways.  Below is the documentation
5014 for saving articles in a fairly straight-forward fashion (i.e., little
5015 processing of the article is done before it is saved).  For a different
5016 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5017 (@pxref{Decoding Articles}).
5018
5019 @vindex gnus-save-all-headers
5020 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5021 unwanted headers before saving the article.
5022
5023 @vindex gnus-saved-headers
5024 If the preceding variable is @code{nil}, all headers that match the
5025 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5026 deleted before saving.
5027
5028 @table @kbd
5029
5030 @item O o
5031 @itemx o
5032 @kindex O o (Summary)
5033 @kindex o (Summary)
5034 @findex gnus-summary-save-article
5035 Save the current article using the default article saver
5036 (@code{gnus-summary-save-article}). 
5037
5038 @item O m
5039 @kindex O m (Summary)
5040 @findex gnus-summary-save-article-mail
5041 Save the current article in mail format
5042 (@code{gnus-summary-save-article-mail}). 
5043
5044 @item O r
5045 @kindex O r (Summary)
5046 @findex gnus-summary-save-article-rmail
5047 Save the current article in rmail format
5048 (@code{gnus-summary-save-article-rmail}). 
5049
5050 @item O f
5051 @kindex O f (Summary)
5052 @findex gnus-summary-save-article-file
5053 Save the current article in plain file format
5054 (@code{gnus-summary-save-article-file}). 
5055
5056 @item O F
5057 @kindex O F (Summary)
5058 @findex gnus-summary-write-article-file
5059 Write the current article in plain file format, overwriting any previous
5060 file contents (@code{gnus-summary-write-article-file}). 
5061
5062 @item O b
5063 @kindex O b (Summary)
5064 @findex gnus-summary-save-article-body-file
5065 Save the current article body in plain file format
5066 (@code{gnus-summary-save-article-body-file}). 
5067
5068 @item O h
5069 @kindex O h (Summary)
5070 @findex gnus-summary-save-article-folder
5071 Save the current article in mh folder format
5072 (@code{gnus-summary-save-article-folder}). 
5073
5074 @item O v
5075 @kindex O v (Summary)
5076 @findex gnus-summary-save-article-vm
5077 Save the current article in a VM folder
5078 (@code{gnus-summary-save-article-vm}).
5079
5080 @item O p
5081 @kindex O p (Summary)
5082 @findex gnus-summary-pipe-output
5083 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5084 the current article to a process (@code{gnus-summary-pipe-output}).
5085 @end table
5086
5087 @vindex gnus-prompt-before-saving
5088 All these commands use the process/prefix convention
5089 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5090 functions, you might get tired of being prompted for files to save each
5091 and every article in.  The prompting action is controlled by
5092 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5093 default, giving you that excessive prompting action you know and
5094 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5095 just once for each series of articles you save.  If you like to really
5096 have Gnus do all your thinking for you, you can even set this variable
5097 to @code{nil}, which means that you will never be prompted for files to
5098 save articles in.  Gnus will simply save all the articles in the default
5099 files. 
5100
5101
5102 @vindex gnus-default-article-saver
5103 You can customize the @code{gnus-default-article-saver} variable to make
5104 Gnus do what you want it to.  You can use any of the four ready-made
5105 functions below, or you can create your own.
5106
5107 @table @code
5108
5109 @item gnus-summary-save-in-rmail
5110 @findex gnus-summary-save-in-rmail
5111 @vindex gnus-rmail-save-name
5112 @findex gnus-plain-save-name
5113 This is the default format, @dfn{babyl}.  Uses the function in the
5114 @code{gnus-rmail-save-name} variable to get a file name to save the
5115 article in.  The default is @code{gnus-plain-save-name}.
5116
5117 @item gnus-summary-save-in-mail
5118 @findex gnus-summary-save-in-mail
5119 @vindex gnus-mail-save-name
5120 Save in a Unix mail (mbox) file.  Uses the function in the
5121 @code{gnus-mail-save-name} variable to get a file name to save the
5122 article in.  The default is @code{gnus-plain-save-name}.
5123
5124 @item gnus-summary-save-in-file
5125 @findex gnus-summary-save-in-file
5126 @vindex gnus-file-save-name
5127 @findex gnus-numeric-save-name
5128 Append the article straight to an ordinary file.  Uses the function in
5129 the @code{gnus-file-save-name} variable to get a file name to save the
5130 article in.  The default is @code{gnus-numeric-save-name}.
5131
5132 @item gnus-summary-save-body-in-file
5133 @findex gnus-summary-save-body-in-file
5134 Append the article body to an ordinary file.  Uses the function in the
5135 @code{gnus-file-save-name} variable to get a file name to save the
5136 article in.  The default is @code{gnus-numeric-save-name}.
5137
5138 @item gnus-summary-save-in-folder
5139 @findex gnus-summary-save-in-folder
5140 @findex gnus-folder-save-name
5141 @findex gnus-Folder-save-name
5142 @vindex gnus-folder-save-name
5143 @cindex rcvstore
5144 @cindex MH folders
5145 Save the article to an MH folder using @code{rcvstore} from the MH
5146 library.  Uses the function in the @code{gnus-folder-save-name} variable
5147 to get a file name to save the article in.  The default is
5148 @code{gnus-folder-save-name}, but you can also use
5149 @code{gnus-Folder-save-name}.  The former creates capitalized names, and
5150 the latter does not.
5151
5152 @item gnus-summary-save-in-vm
5153 @findex gnus-summary-save-in-vm
5154 Save the article in a VM folder.  You have to have the VM mail
5155 reader to use this setting.
5156 @end table
5157
5158 @vindex gnus-article-save-directory
5159 All of these functions, except for the last one, will save the article
5160 in the @code{gnus-article-save-directory}, which is initialized from the
5161 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5162 default. 
5163
5164 As you can see above, the functions use different functions to find a
5165 suitable name of a file to save the article in.  Below is a list of
5166 available functions that generate names:
5167
5168 @table @code
5169
5170 @item gnus-Numeric-save-name
5171 @findex gnus-Numeric-save-name
5172 File names like @file{~/News/Alt.andrea-dworkin/45}.
5173
5174 @item gnus-numeric-save-name
5175 @findex gnus-numeric-save-name
5176 File names like @file{~/News/alt.andrea-dworkin/45}.
5177
5178 @item gnus-Plain-save-name
5179 @findex gnus-Plain-save-name
5180 File names like @file{~/News/Alt.andrea-dworkin}.
5181
5182 @item gnus-plain-save-name
5183 @findex gnus-plain-save-name
5184 File names like @file{~/News/alt.andrea-dworkin}.
5185 @end table
5186
5187 @vindex gnus-split-methods
5188 You can have Gnus suggest where to save articles by plonking a regexp into
5189 the @code{gnus-split-methods} alist.  For instance, if you would like to
5190 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5191 related to VM in @code{vm-stuff}, you could set this variable to something
5192 like:
5193
5194 @lisp
5195 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5196  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5197  (my-choosing-function "../other-dir/my-stuff")
5198  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5199 @end lisp
5200
5201 We see that this is a list where each element is a list that has two
5202 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5203 a string (in which case it is used as a regexp to match on the article
5204 head); it can be a symbol (which will be called as a function with the
5205 group name as a parameter); or it can be a list (which will be
5206 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5207 the @dfn{file} will be used as a default prompt.  In addition, the
5208 result of the operation itself will be used if the function or form
5209 called returns a string or a list of strings.
5210
5211 You basically end up with a list of file names that might be used when
5212 saving the current article.  (All ``matches'' will be used.)  You will
5213 then be prompted for what you really want to use as a name, with file
5214 name completion over the results from applying this variable.
5215
5216 This variable is @code{((gnus-article-archive-name))} by default, which
5217 means that Gnus will look at the articles it saves for an
5218 @code{Archive-name} line and use that as a suggestion for the file
5219 name. 
5220
5221 @vindex gnus-use-long-file-name
5222 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5223 @code{nil}, all the preceding functions will replace all periods
5224 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5225 the functions will generate hierarchies of directories instead of having
5226 all the files in the toplevel directory
5227 (@file{~/News/alt/andrea-dworkin} instead of
5228 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5229 on most systems.  However, for historical reasons, this is @code{nil} on
5230 Xenix and usg-unix-v machines by default.
5231
5232 This function also affects kill and score file names.  If this variable
5233 is a list, and the list contains the element @code{not-score}, long file
5234 names will not be used for score files, if it contains the element
5235 @code{not-save}, long file names will not be used for saving, and if it
5236 contains the element @code{not-kill}, long file names will not be used
5237 for kill files.
5238
5239 If you'd like to save articles in a hierarchy that looks something like
5240 a spool, you could
5241
5242 @lisp
5243 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5244 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5245 @end lisp
5246
5247 Then just save with @kbd{o}.  You'd then read this hierarchy with
5248 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5249 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5250 around to the groups/directories with @code{nneething}.
5251
5252
5253 @node Decoding Articles
5254 @section Decoding Articles
5255 @cindex decoding articles
5256
5257 Sometime users post articles (or series of articles) that have been
5258 encoded in some way or other.  Gnus can decode them for you.
5259
5260 @menu 
5261 * Uuencoded Articles::    Uudecode articles.
5262 * Shared Articles::       Unshar articles.
5263 * PostScript Files::      Split PostScript.
5264 * Decoding Variables::    Variables for a happy decoding.
5265 * Viewing Files::         You want to look at the result of the decoding?
5266 @end menu
5267
5268 All these functions use the process/prefix convention
5269 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5270 the extension that a ``single article'' means ``a single series''.  Gnus
5271 can find out by itself what articles belong to a series, decode all the
5272 articles and unpack/view/save the resulting file(s).
5273
5274 Gnus guesses what articles are in the series according to the following
5275 simplish rule: The subjects must be (nearly) identical, except for the
5276 last two numbers of the line.  (Spaces are largely ignored, however.)
5277
5278 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5279 will find all the articles that match the regexp @samp{^cat.gif
5280 ([0-9]+/[0-9]+).*$}.  
5281
5282 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5283 series}, will not be properly recognized by any of the automatic viewing
5284 commands, and you have to mark the articles manually with @kbd{#}.
5285
5286
5287 @node Uuencoded Articles
5288 @subsection Uuencoded Articles
5289 @cindex uudecode
5290 @cindex uuencoded articles
5291
5292 @table @kbd
5293
5294 @item X u
5295 @kindex X u (Summary)
5296 @findex gnus-uu-decode-uu
5297 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5298
5299 @item X U
5300 @kindex X U (Summary)
5301 @findex gnus-uu-decode-uu-and-save
5302 Uudecodes and saves the current series
5303 (@code{gnus-uu-decode-uu-and-save}).
5304
5305 @item X v u
5306 @kindex X v u (Summary)
5307 @findex gnus-uu-decode-uu-view
5308 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5309
5310 @item X v U
5311 @kindex X v U (Summary)
5312 @findex gnus-uu-decode-uu-and-save-view
5313 Uudecodes, views and saves the current series
5314 (@code{gnus-uu-decode-uu-and-save-view}). 
5315 @end table
5316
5317 Remember that these all react to the presence of articles marked with
5318 the process mark.  If, for instance, you'd like to decode and save an
5319 entire newsgroup, you'd typically do @kbd{M P a}
5320 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5321 (@code{gnus-uu-decode-uu-and-save}).
5322
5323 All this is very much different from how @code{gnus-uu} worked with
5324 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5325 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5326 articles in some way (@pxref{Setting Process Marks}) and then press
5327 @kbd{X u}.
5328
5329 @vindex gnus-uu-notify-files
5330 Note: When trying to decode articles that have names matching
5331 @code{gnus-uu-notify-files}, which is hard-coded to
5332 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5333 automatically post an article on @samp{comp.unix.wizards} saying that
5334 you have just viewed the file in question.  This feature can't be turned
5335 off.
5336
5337
5338 @node Shared Articles
5339 @subsection Shared Articles
5340 @cindex unshar
5341 @cindex shared articles
5342
5343 @table @kbd
5344
5345 @item X s
5346 @kindex X s (Summary)
5347 @findex gnus-uu-decode-unshar
5348 Unshars the current series (@code{gnus-uu-decode-unshar}).
5349
5350 @item X S
5351 @kindex X S (Summary)
5352 @findex gnus-uu-decode-unshar-and-save
5353 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5354
5355 @item X v s
5356 @kindex X v s (Summary)
5357 @findex gnus-uu-decode-unshar-view
5358 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5359
5360 @item X v S
5361 @kindex X v S (Summary)
5362 @findex gnus-uu-decode-unshar-and-save-view
5363 Unshars, views and saves the current series
5364 (@code{gnus-uu-decode-unshar-and-save-view}). 
5365 @end table
5366
5367
5368 @node PostScript Files
5369 @subsection PostScript Files
5370 @cindex PostScript
5371
5372 @table @kbd
5373
5374 @item X p
5375 @kindex X p (Summary)
5376 @findex gnus-uu-decode-postscript
5377 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5378
5379 @item X P
5380 @kindex X P (Summary)
5381 @findex gnus-uu-decode-postscript-and-save
5382 Unpack and save the current PostScript series
5383 (@code{gnus-uu-decode-postscript-and-save}).
5384
5385 @item X v p
5386 @kindex X v p (Summary)
5387 @findex gnus-uu-decode-postscript-view
5388 View the current PostScript series
5389 (@code{gnus-uu-decode-postscript-view}).
5390
5391 @item X v P
5392 @kindex X v P (Summary)
5393 @findex gnus-uu-decode-postscript-and-save-view
5394 View and save the current PostScript series
5395 (@code{gnus-uu-decode-postscript-and-save-view}). 
5396 @end table
5397
5398
5399 @node Decoding Variables
5400 @subsection Decoding Variables
5401
5402 Adjective, not verb.
5403
5404 @menu 
5405 * Rule Variables::          Variables that say how a file is to be viewed.
5406 * Other Decode Variables::  Other decode variables.
5407 * Uuencoding and Posting::  Variables for customizing uuencoding.
5408 @end menu
5409
5410
5411 @node Rule Variables
5412 @subsubsection Rule Variables
5413 @cindex rule variables
5414
5415 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5416 variables are on the form
5417   
5418 @lisp
5419       (list '(regexp1 command2)
5420             '(regexp2 command2)
5421             ...)
5422 @end lisp
5423
5424 @table @code
5425
5426 @item gnus-uu-user-view-rules
5427 @vindex gnus-uu-user-view-rules
5428 @cindex sox
5429 This variable is consulted first when viewing files.  If you wish to use,
5430 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5431 say something like:
5432 @lisp
5433 (setq gnus-uu-user-view-rules
5434       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5435 @end lisp
5436
5437 @item gnus-uu-user-view-rules-end
5438 @vindex gnus-uu-user-view-rules-end
5439 This variable is consulted if Gnus couldn't make any matches from the
5440 user and default view rules.
5441
5442 @item gnus-uu-user-archive-rules
5443 @vindex gnus-uu-user-archive-rules
5444 This variable can be used to say what commands should be used to unpack
5445 archives.
5446 @end table
5447
5448
5449 @node Other Decode Variables
5450 @subsubsection Other Decode Variables
5451
5452 @table @code
5453 @vindex gnus-uu-grabbed-file-functions
5454
5455 @item gnus-uu-grabbed-file-functions
5456 All functions in this list will be called right each file has been
5457 successfully decoded---so that you can move or view files right away,
5458 and don't have to wait for all files to be decoded before you can do
5459 anything.  Ready-made functions you can put in this list are:
5460
5461 @table @code
5462
5463 @item gnus-uu-grab-view
5464 @findex gnus-uu-grab-view
5465 View the file.
5466
5467 @item gnus-uu-grab-move
5468 @findex gnus-uu-grab-move
5469 Move the file (if you're using a saving function.)
5470 @end table
5471
5472 @item gnus-uu-be-dangerous
5473 @vindex gnus-uu-be-dangerous
5474 Specifies what to do if unusual situations arise during decoding.  If
5475 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5476 that didn't work, and overwrite existing files.  Otherwise, ask each
5477 time.
5478
5479 @item gnus-uu-ignore-files-by-name
5480 @vindex gnus-uu-ignore-files-by-name
5481 Files with name matching this regular expression won't be viewed.
5482
5483 @item gnus-uu-ignore-files-by-type
5484 @vindex gnus-uu-ignore-files-by-type
5485 Files with a @sc{mime} type matching this variable won't be viewed.
5486 Note that Gnus tries to guess what type the file is based on the name.
5487 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5488 kludgey.
5489
5490 @item gnus-uu-tmp-dir
5491 @vindex gnus-uu-tmp-dir
5492 Where @code{gnus-uu} does its work.
5493
5494 @item gnus-uu-do-not-unpack-archives
5495 @vindex gnus-uu-do-not-unpack-archives
5496 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5497 looking for files to display.
5498
5499 @item gnus-uu-view-and-save
5500 @vindex gnus-uu-view-and-save
5501 Non-@code{nil} means that the user will always be asked to save a file
5502 after viewing it.
5503
5504 @item gnus-uu-ignore-default-view-rules
5505 @vindex gnus-uu-ignore-default-view-rules
5506 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5507 rules.
5508
5509 @item gnus-uu-ignore-default-archive-rules
5510 @vindex gnus-uu-ignore-default-archive-rules
5511 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5512 unpacking commands.
5513
5514 @item gnus-uu-kill-carriage-return
5515 @vindex gnus-uu-kill-carriage-return
5516 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5517 from articles.
5518
5519 @item gnus-uu-unmark-articles-not-decoded
5520 @vindex gnus-uu-unmark-articles-not-decoded
5521 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5522 unsuccessfully decoded as unread.
5523
5524 @item gnus-uu-correct-stripped-uucode
5525 @vindex gnus-uu-correct-stripped-uucode
5526 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5527 uuencoded files that have had trailing spaces deleted.
5528
5529 @item gnus-uu-view-with-metamail
5530 @vindex gnus-uu-view-with-metamail
5531 @cindex metamail
5532 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5533 commands defined by the rule variables and just fudge a @sc{mime}
5534 content type based on the file name.  The result will be fed to
5535 @code{metamail} for viewing.
5536
5537 @item gnus-uu-save-in-digest
5538 @vindex gnus-uu-save-in-digest
5539 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5540 decoding, will save in digests.  If this variable is @code{nil},
5541 @code{gnus-uu} will just save everything in a file without any
5542 embellishments.  The digesting almost conforms to RFC1153---no easy way
5543 to specify any meaningful volume and issue numbers were found, so I
5544 simply dropped them.
5545
5546 @end table
5547
5548
5549 @node Uuencoding and Posting
5550 @subsubsection Uuencoding and Posting
5551
5552 @table @code
5553
5554 @item gnus-uu-post-include-before-composing
5555 @vindex gnus-uu-post-include-before-composing
5556 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5557 before you compose the article.  If this variable is @code{t}, you can
5558 either include an encoded file with @kbd{C-c C-i} or have one included
5559 for you when you post the article.
5560
5561 @item gnus-uu-post-length
5562 @vindex gnus-uu-post-length
5563 Maximum length of an article.  The encoded file will be split into how
5564 many articles it takes to post the entire file.
5565
5566 @item gnus-uu-post-threaded
5567 @vindex gnus-uu-post-threaded
5568 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5569 thread.  This may not be smart, as no other decoder I have seen are able
5570 to follow threads when collecting uuencoded articles.  (Well, I have
5571 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5572 think that counts...) Default is @code{nil}.
5573
5574 @item gnus-uu-post-separate-description
5575 @vindex gnus-uu-post-separate-description
5576 Non-@code{nil} means that the description will be posted in a separate
5577 article.  The first article will typically be numbered (0/x).  If this
5578 variable is @code{nil}, the description the user enters will be included
5579 at the beginning of the first article, which will be numbered (1/x).
5580 Default is @code{t}.
5581
5582 @end table
5583
5584
5585 @node Viewing Files
5586 @subsection Viewing Files
5587 @cindex viewing files
5588 @cindex pseudo-articles
5589
5590 After decoding, if the file is some sort of archive, Gnus will attempt
5591 to unpack the archive and see if any of the files in the archive can be
5592 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5593 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5594 uncompress and de-tar the main file, and then view the two pictures.
5595 This unpacking process is recursive, so if the archive contains archives
5596 of archives, it'll all be unpacked.
5597
5598 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5599 extracted file into the summary buffer.  If you go to these
5600 ``articles'', you will be prompted for a command to run (usually Gnus
5601 will make a suggestion), and then the command will be run.
5602
5603 @vindex gnus-view-pseudo-asynchronously
5604 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5605 until the viewing is done before proceeding.
5606
5607 @vindex gnus-view-pseudos
5608 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5609 the pseudo-articles into the summary buffer, but view them
5610 immediately.  If this variable is @code{not-confirm}, the user won't even
5611 be asked for a confirmation before viewing is done.
5612
5613 @vindex gnus-view-pseudos-separately 
5614 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5615 pseudo-article will be created for each file to be viewed.  If
5616 @code{nil}, all files that use the same viewing command will be given as
5617 a list of parameters to that command.
5618
5619 @vindex gnus-insert-pseudo-articles
5620 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5621 pseudo-articles when decoding.  It is @code{t} by default.
5622
5623 So; there you are, reading your @emph{pseudo-articles} in your
5624 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5625 Why isn't anything real anymore? How did we get here?
5626
5627
5628 @node Article Treatment
5629 @section Article Treatment
5630
5631 Reading through this huge manual, you may have quite forgotten that the
5632 object of newsreaders are to actually, like, read what people have
5633 written.  Reading articles.  Unfortunately, people are quite bad at
5634 writing, so there are tons of functions and variables to make reading
5635 these articles easier.
5636
5637 @menu
5638 * Article Highlighting::    You want to make the article look like fruit salad.
5639 * Article Fontisizing::     Making emphasized text look niced.
5640 * Article Hiding::          You also want to make certain info go away.
5641 * Article Washing::         Lots of way-neat functions to make life better.
5642 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
5643 * Article Date::            Grumble, UT!
5644 * Article Signature::       What is a signature?
5645 @end menu
5646
5647
5648 @node Article Highlighting
5649 @subsection Article Highlighting
5650 @cindex highlight
5651
5652 Not only do you want your article buffer to look like fruit salad, but
5653 you want it to look like technicolor fruit salad.
5654
5655 @table @kbd
5656
5657 @item W H a
5658 @kindex W H a (Summary)
5659 @findex gnus-article-highlight
5660 Highlight the current article (@code{gnus-article-highlight}).
5661
5662 @item W H h
5663 @kindex W H h (Summary)
5664 @findex gnus-article-highlight-headers
5665 @vindex gnus-header-face-alist
5666 Highlight the headers (@code{gnus-article-highlight-headers}).  The
5667 highlighting will be done according to the @code{gnus-header-face-alist}
5668 variable, which is a list where each element has the form @var{(regexp
5669 name content)}.  @var{regexp} is a regular expression for matching the
5670 header, @var{name} is the face used for highlighting the header name and
5671 @var{content} is the face for highlighting the header value.  The first
5672 match made will be used.  Note that @var{regexp} shouldn't have @samp{^}
5673 prepended---Gnus will add one.
5674
5675 @item W H c
5676 @kindex W H c (Summary)
5677 @findex gnus-article-highlight-citation
5678 Highlight cited text (@code{gnus-article-highlight-citation}). 
5679
5680 Some variables to customize the citation highlights:
5681
5682 @table @code
5683 @vindex gnus-cite-parse-max-size
5684
5685 @item gnus-cite-parse-max-size
5686 If the article size if bigger than this variable (which is 25000 by
5687 default), no citation highlighting will be performed.  
5688
5689 @item gnus-cite-prefix-regexp
5690 @vindex gnus-cite-prefix-regexp
5691 Regexp matching the longest possible citation prefix on a line. 
5692
5693 @item gnus-cite-max-prefix
5694 @vindex gnus-cite-max-prefix
5695 Maximum possible length for a citation prefix (default 20).
5696
5697 @item gnus-cite-face-list
5698 @vindex gnus-cite-face-list
5699 List of faces used for highlighting citations.  When there are citations
5700 from multiple articles in the same message, Gnus will try to give each
5701 citation from each article its own face.  This should make it easier to
5702 see who wrote what.
5703
5704 @item gnus-supercite-regexp
5705 @vindex gnus-supercite-regexp
5706 Regexp matching normal Supercite attribution lines.  
5707
5708 @item gnus-supercite-secondary-regexp
5709 @vindex gnus-supercite-secondary-regexp
5710 Regexp matching mangled Supercite attribution lines.
5711
5712 @item gnus-cite-minimum-match-count
5713 @vindex gnus-cite-minimum-match-count
5714 Minimum number of identical prefixes we have to see before we believe
5715 that it's a citation.
5716
5717 @item gnus-cite-attribution-prefix
5718 @vindex gnus-cite-attribution-prefix
5719 Regexp matching the beginning of an attribution line.
5720
5721 @item gnus-cite-attribution-suffix
5722 @vindex gnus-cite-attribution-suffix
5723 Regexp matching the end of an attribution line.
5724
5725 @item gnus-cite-attribution-face
5726 @vindex gnus-cite-attribution-face
5727 Face used for attribution lines.  It is merged with the face for the
5728 cited text belonging to the attribution.
5729
5730 @end table
5731
5732
5733 @item W H s
5734 @kindex W H s (Summary)
5735 @vindex gnus-signature-separator
5736 @vindex gnus-signature-face
5737 @findex gnus-article-highlight-signature
5738 Highlight the signature (@code{gnus-article-highlight-signature}).
5739 Everything after @code{gnus-signature-separator} (@pxref{Article
5740 Signature}) in an article will be considered a signature and will be
5741 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5742 default.
5743
5744 @end table
5745
5746
5747 @node Article Fontisizing
5748 @subsection Article Fontisizing
5749 @cindex emphasis
5750 @cindex article emphasis
5751
5752 @findex gnus-article-emphasize
5753 @kindex W e (Summary)
5754 People commonly add emphasis to words in news articles by writing things
5755 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
5756 running the article through the @kbd{W e}
5757 (@code{gnus-article-emphasize}) command.
5758
5759 @vindex gnus-article-emphasis
5760 How the emphasis is computed is controlled by the
5761 @code{gnus-article-emphasis} variable.  This is an alist where the first
5762 element is a regular expression to be matched.  The second is a number
5763 that says what regular expression grouping used to find the entire
5764 emphasized word.  The third is a number that says what regexp grouping
5765 should be displayed and highlighted.  (The text between these two
5766 groupings will be hidden.)  The fourth is the face used for
5767 highlighting.
5768
5769 @lisp
5770 (setq gnus-article-emphasis
5771       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5772         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5773 @end lisp
5774
5775 @vindex gnus-emphasis-underline
5776 @vindex gnus-emphasis-bold
5777 @vindex gnus-emphasis-italic
5778 @vindex gnus-emphasis-underline-bold
5779 @vindex gnus-emphasis-underline-italic
5780 @vindex gnus-emphasis-bold-italic
5781 @vindex gnus-emphasis-underline-bold-italic
5782 By default, there are seven rules, and they use the following faces:
5783 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5784 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5785 @code{gnus-emphasis-underline-italic},
5786 @code{gnus-emphasis-undeline-bold}, and
5787 @code{gnus-emphasis-underline-bold-italic}.  
5788
5789 If you want to change these faces, you can either use @kbd{M-x
5790 customize}, or you can use @code{copy-face}.  For instance, if you want
5791 to make @code{gnus-emphasis-italic} use a red face instead, you could
5792 say something like:
5793
5794 @lisp
5795 (copy-face 'red 'gnus-emphasis-italic)
5796 @end lisp
5797
5798
5799 @node Article Hiding
5800 @subsection Article Hiding
5801 @cindex article hiding
5802
5803 Or rather, hiding certain things in each article.  There usually is much
5804 too much cruft in most articles.  
5805
5806 @table @kbd
5807
5808 @item W W a
5809 @kindex W W a (Summary)
5810 @findex gnus-article-hide
5811 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
5812
5813 @item W W h
5814 @kindex W W h (Summary)
5815 @findex gnus-article-hide-headers
5816 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5817 Headers}. 
5818
5819 @item W W b
5820 @kindex W W b (Summary)
5821 @findex gnus-article-hide-boring-headers
5822 Hide headers that aren't particularly interesting
5823 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5824
5825 @item W W s
5826 @kindex W W s (Summary)
5827 @findex gnus-article-hide-signature
5828 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
5829 Signature}. 
5830
5831 @item W W p
5832 @kindex W W p (Summary)
5833 @findex gnus-article-hide-pgp
5834 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). 
5835
5836 @item W W P
5837 @kindex W W P (Summary)
5838 @findex gnus-article-hide-pem
5839 Hide @sc{pem} (privacy enhanced messages) gruft
5840 (@code{gnus-article-hide-pem}).
5841
5842 @item W W c
5843 @kindex W W c (Summary)
5844 @findex gnus-article-hide-citation
5845 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5846 customizing the hiding:
5847
5848 @table @code
5849
5850 @item gnus-cite-hide-percentage
5851 @vindex gnus-cite-hide-percentage
5852 If the cited text is of a bigger percentage than this variable (default
5853 50), hide the cited text.
5854
5855 @item gnus-cite-hide-absolute
5856 @vindex gnus-cite-hide-absolute
5857 The cited text must be have at least this length (default 10) before it
5858 is hidden.
5859
5860 @item gnus-cited-text-button-line-format
5861 @vindex gnus-cited-text-button-line-format
5862 Gnus adds buttons show where the cited text has been hidden, and to
5863 allow toggle hiding the text.  The format of the variable is specified
5864 by this format-like variable (@pxref{Formatting Variables}).  These
5865 specs are legal:
5866
5867 @table @samp
5868 @item b
5869 Start point of the hidden text.
5870 @item e
5871 End point of the hidden text.
5872 @item l
5873 Length of the hidden text.
5874 @end table
5875
5876 @item gnus-cited-lines-visible
5877 @vindex gnus-cited-lines-visible
5878 The number of lines at the beginning of the cited text to leave shown. 
5879
5880 @end table
5881
5882 @item W W C
5883 @kindex W W C (Summary)
5884 @findex gnus-article-hide-citation-in-followups
5885 Hide cited text in articles that aren't roots
5886 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
5887 useful as an interactive command, but might be a handy function to stick
5888 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
5889
5890 @end table
5891
5892 All these ``hiding'' commands are toggles, but if you give a negative
5893 prefix to these commands, they will show what they have previously
5894 hidden.  If you give a positive prefix, they will always hide.
5895
5896 Also @pxref{Article Highlighting} for further variables for
5897 citation customization.
5898
5899
5900 @node Article Washing
5901 @subsection Article Washing
5902 @cindex washing
5903 @cindex article washing
5904
5905 We call this ``article washing'' for a really good reason.  Namely, the
5906 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5907
5908 @dfn{Washing} is defined by us as ``changing something from something to
5909 something else'', but normally results in something looking better.
5910 Cleaner, perhaps.
5911
5912 @table @kbd
5913
5914 @item W l
5915 @kindex W l (Summary)
5916 @findex gnus-summary-stop-page-breaking
5917 Remove page breaks from the current article
5918 (@code{gnus-summary-stop-page-breaking}).
5919
5920 @item W r
5921 @kindex W r (Summary)
5922 @findex gnus-summary-caesar-message
5923 Do a Caesar rotate (rot13) on the article buffer
5924 (@code{gnus-summary-caesar-message}). 
5925
5926 @item W t
5927 @kindex W t (Summary)
5928 @findex gnus-summary-toggle-header
5929 Toggle whether to display all headers in the article buffer
5930 (@code{gnus-summary-toggle-header}). 
5931
5932 @item W v
5933 @kindex W v (Summary)
5934 @findex gnus-summary-verbose-header
5935 Toggle whether to display all headers in the article buffer permanently
5936 (@code{gnus-summary-verbose-header}).
5937
5938 @item W m
5939 @kindex W m (Summary)
5940 @findex gnus-summary-toggle-mime
5941 Toggle whether to run the article through @sc{mime} before displaying
5942 (@code{gnus-summary-toggle-mime}).
5943
5944 @item W o
5945 @kindex W o (Summary)
5946 @findex gnus-article-treat-overstrike
5947 Treat overstrike (@code{gnus-article-treat-overstrike}).
5948
5949 @item W w
5950 @kindex W w (Summary)
5951 @findex gnus-article-fill-cited-article
5952 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
5953 function in @code{gnus-article-display-hook}, it should be run fairly
5954 late and certainly after any highlighting.
5955
5956 You can give the command a numerical prefix to specify the width to use
5957 when filling.
5958
5959 @item W c
5960 @kindex W c (Summary)
5961 @findex gnus-article-remove-cr
5962 Remove CR (@code{gnus-article-remove-cr}).
5963
5964 @item W q
5965 @kindex W q (Summary)
5966 @findex gnus-article-de-quoted-unreadable
5967 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5968
5969 @item W f
5970 @kindex W f (Summary)
5971 @cindex x-face
5972 @findex gnus-article-display-x-face
5973 @findex gnus-article-x-face-command
5974 @vindex gnus-article-x-face-command
5975 @vindex gnus-article-x-face-too-ugly
5976 Look for and display any X-Face headers
5977 (@code{gnus-article-display-x-face}).  The command executed by this
5978 function is given by the @code{gnus-article-x-face-command} variable.
5979 If this variable is a string, this string will be executed in a
5980 sub-shell.  If it is a function, this function will be called with the
5981 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
5982 is a regexp) matches the @code{From} header, the face will not be shown.
5983 The default action under Emacs is to fork off an @code{xv} to view the
5984 face; under XEmacs the default action is to display the face before the
5985 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
5986 support---that will make display somewhat faster.  If there's no native
5987 X-Face support, Gnus will try to convert the @code{X-Face} header using
5988 external programs from the @code{pbmplus} package and friends.)  If you
5989 want to have this function in the display hook, it should probably come
5990 last.
5991
5992 @item W b
5993 @kindex W b (Summary)
5994 @findex gnus-article-add-buttons
5995 Add clickable buttons to the article (@code{gnus-article-add-buttons}). 
5996
5997 @item W B
5998 @kindex W B (Summary)
5999 @findex gnus-article-add-buttons-to-head
6000 Add clickable buttons to the article headers
6001 (@code{gnus-article-add-buttons-to-head}).  
6002
6003 @item W E l
6004 @kindex W E l (Summary)
6005 @findex gnus-article-strip-leading-blank-lines
6006 Remove all blank lines from the beginning of the article
6007 (@code{gnus-article-strip-leading-blank-lines}).
6008
6009 @item W E m
6010 @kindex W E m (Summary)
6011 @findex gnus-article-strip-multiple-blank-lines
6012 Replace all blank lines with empty lines and then all multiple empty
6013 lines with a single empty line.
6014 (@code{gnus-article-strip-multiple-blank-lines}).
6015
6016 @item W E t
6017 @kindex W E t (Summary)
6018 @findex gnus-article-remove-trailing-blank-lines
6019 Remove all blank lines at the end of the article
6020 (@code{gnus-article-remove-trailing-blank-lines}).
6021
6022 @item W E a
6023 @kindex W E a (Summary)
6024 @findex gnus-article-strip-blank-lines
6025 Do all the three commands above
6026 (@code{gnus-article-strip-blank-lines}).
6027
6028 @end table
6029
6030
6031 @node Article Buttons
6032 @subsection Article Buttons
6033 @cindex buttons
6034
6035 People often include references to other stuff in articles, and it would
6036 be nice if Gnus could just fetch whatever it is that people talk about
6037 with the minimum of fuzz.
6038
6039 Gnus adds @dfn{buttons} to certain standard references by default:
6040 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6041 two variables, one that handles article bodies and one that handles
6042 article heads:
6043
6044 @table @code
6045
6046 @item gnus-button-alist
6047 @vindex gnus-button-alist
6048 This is an alist where each entry has this form:
6049
6050 @lisp
6051 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6052 @end lisp
6053
6054 @table @var
6055
6056 @item regexp
6057 All text that match this regular expression will be considered an
6058 external reference.  Here's a typical regexp that match embedded URLs:
6059 @samp{<URL:\\([^\n\r>]*\\)>}. 
6060
6061 @item button-par
6062 Gnus has to know which parts of the match is to be highlighted.  This is
6063 a number that says what sub-expression of the regexp that is to be
6064 highlighted.  If you want it all highlighted, you use 0 here.
6065
6066 @item use-p
6067 This form will be @code{eval}ed, and if the result is non-@code{nil},
6068 this is considered a match.  This is useful if you want extra sifting to
6069 avoid false matches.
6070
6071 @item function
6072 This function will be called when you click on this button.
6073
6074 @item data-par
6075 As with @var{button-par}, this is a sub-expression number, but this one
6076 says which part of the match is to be sent as data to @var{function}. 
6077
6078 @end table
6079
6080 So the full entry for buttonizing URLs is then
6081
6082 @lisp
6083 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6084 @end lisp
6085
6086 @item gnus-header-button-alist
6087 @vindex gnus-header-button-alist
6088 This is just like the other alist, except that it is applied to the
6089 article head only, and that each entry has an additional element that is
6090 used to say what headers to apply the buttonize coding to:
6091
6092 @lisp
6093 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6094 @end lisp
6095
6096 @var{header} is a regular expression.
6097
6098 @item gnus-button-url-regexp
6099 @vindex gnus-button-url-regexp
6100 A regular expression that matches embedded URLs.  It is used in the
6101 default values of the variables above.
6102
6103 @item gnus-article-button-face
6104 @vindex gnus-article-button-face
6105 Face used on buttons.
6106
6107 @item gnus-article-mouse-face
6108 @vindex gnus-article-mouse-face
6109 Face is used when the mouse cursor is over a button.
6110
6111 @end table
6112
6113
6114 @node Article Date
6115 @subsection Article Date
6116
6117 The date is most likely generated in some obscure timezone you've never
6118 heard of, so it's quite nice to be able to find out what the time was
6119 when the article was sent.
6120
6121 @table @kbd
6122
6123 @item W T u
6124 @kindex W T u (Summary)
6125 @findex gnus-article-date-ut
6126 Display the date in UT (aka. GMT, aka ZULU)
6127 (@code{gnus-article-date-ut}). 
6128
6129 @item W T l
6130 @kindex W T l (Summary)
6131 @findex gnus-article-date-local
6132 Display the date in the local timezone (@code{gnus-article-date-local}).
6133
6134 @item W T s
6135 @kindex W T s (Summary)
6136 @vindex gnus-article-time-format
6137 @findex gnus-article-date-user
6138 @findex format-time-string
6139 Display the date using a user-defined format
6140 (@code{gnus-article-date-user}).  The format is specified by the
6141 @code{gnus-article-time-format} variable, and is a string that's passed
6142 to @code{format-time-string}.  See the documentation of that variable
6143 for a list possible format specs.
6144
6145 @item W T e
6146 @kindex W T e (Summary)
6147 @findex gnus-article-date-lapsed
6148 Say how much time has (e)lapsed between the article was posted and now
6149 (@code{gnus-article-date-lapsed}).
6150
6151 @item W T o
6152 @kindex W T o (Summary)
6153 @findex gnus-article-date-original
6154 Display the original date (@code{gnus-article-date-original}).  This can
6155 be useful if you normally use some other conversion function and is
6156 worried that it might be doing something totally wrong.  Say, claiming
6157 that the article was posted in 1854.  Although something like that is
6158 @emph{totally} impossible.  Don't you trust me? *titter*
6159
6160 @end table
6161
6162
6163 @node Article Signature
6164 @subsection Article Signature
6165 @cindex signatures
6166 @cindex article signature
6167
6168 @vindex gnus-signature-separator
6169 Each article is divided into two parts---the head and the body.  The
6170 body can be divided into a signature part and a text part.  The variable
6171 that says what is to be considered a signature is
6172 @code{gnus-signature-separator}.  This is normally the standard
6173 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6174 non-standard signature separators, so this variable can also be a list
6175 of regular expressions to be tested, one by one.  (Searches are done
6176 from the end of the body towards the beginning.)  One likely value is:
6177
6178 @lisp
6179 (setq gnus-signature-separator
6180       '("^-- $"         ; The standard
6181         "^-- *$"        ; A common mangling
6182         "^-------*$"    ; Many people just use a looong 
6183                         ; line of dashes.  Shame!
6184         "^ *--------*$" ; Double-shame!
6185         "^________*$"   ; Underscores are also popular
6186         "^========*$")) ; Pervert!
6187 @end lisp
6188
6189 The more permissive you are, the more likely it is that you'll get false
6190 positives.
6191
6192 @vindex gnus-signature-limit
6193 @code{gnus-signature-limit} provides a limit to what is considered a
6194 signature. 
6195
6196 @enumerate
6197 @item 
6198 If it is an integer, no signature may be longer (in characters) than
6199 that integer.
6200 @item 
6201 If it is a floating point number, no signature may be longer (in lines)
6202 than that number.
6203 @item 
6204 If it is a function, the function will be called without any parameters,
6205 and if it returns @code{nil}, there is no signature in the buffer.
6206 @item
6207 If it is a string, it will be used as a regexp.  If it matches, the text
6208 in question is not a signature.
6209 @end enumerate
6210
6211 This variable can also be a list where the elements may be of the types
6212 listed above.  
6213
6214
6215 @node Article Commands
6216 @section Article Commands
6217
6218 @table @kbd
6219
6220 @item A P
6221 @cindex PostScript
6222 @cindex printing
6223 @kindex A P (Summary)
6224 @vindex gnus-ps-print-hook
6225 @findex gnus-summary-print-article 
6226 Generate and print a PostScript image of the article buffer
6227 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6228 run just before printing the buffer.
6229
6230 @end table
6231
6232
6233 @node Summary Sorting
6234 @section Summary Sorting
6235 @cindex summary sorting
6236
6237 You can have the summary buffer sorted in various ways, even though I
6238 can't really see why you'd want that.
6239
6240 @table @kbd
6241
6242 @item C-c C-s C-n
6243 @kindex C-c C-s C-n (Summary)
6244 @findex gnus-summary-sort-by-number
6245 Sort by article number (@code{gnus-summary-sort-by-number}).
6246
6247 @item C-c C-s C-a
6248 @kindex C-c C-s C-a (Summary)
6249 @findex gnus-summary-sort-by-author
6250 Sort by author (@code{gnus-summary-sort-by-author}).
6251
6252 @item C-c C-s C-s
6253 @kindex C-c C-s C-s (Summary)
6254 @findex gnus-summary-sort-by-subject
6255 Sort by subject (@code{gnus-summary-sort-by-subject}).
6256
6257 @item C-c C-s C-d
6258 @kindex C-c C-s C-d (Summary)
6259 @findex gnus-summary-sort-by-date
6260 Sort by date (@code{gnus-summary-sort-by-date}).
6261
6262 @item C-c C-s C-l
6263 @kindex C-c C-s C-l (Summary)
6264 @findex gnus-summary-sort-by-lines
6265 Sort by lines (@code{gnus-summary-sort-by-lines}).
6266
6267 @item C-c C-s C-i
6268 @kindex C-c C-s C-i (Summary)
6269 @findex gnus-summary-sort-by-score
6270 Sort by score (@code{gnus-summary-sort-by-score}).
6271 @end table
6272
6273 These functions will work both when you use threading and when you don't
6274 use threading.  In the latter case, all summary lines will be sorted,
6275 line by line.  In the former case, sorting will be done on a
6276 root-by-root basis, which might not be what you were looking for.  To
6277 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6278 Commands}).
6279
6280
6281 @node Finding the Parent
6282 @section Finding the Parent
6283 @cindex parent articles
6284 @cindex referring articles
6285
6286 @findex gnus-summary-refer-parent-article
6287 @kindex ^ (Summary)
6288 If you'd like to read the parent of the current article, and it is not
6289 displayed in the summary buffer, you might still be able to.  That is,
6290 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6291 and the @code{References} in the current article are not mangled, you
6292 can just press @kbd{^} or @kbd{A r}
6293 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6294 you'll get the parent.  If the parent is already displayed in the
6295 summary buffer, point will just move to this article.
6296
6297 If given a positive numerical prefix, fetch that many articles back into
6298 the ancestry.  If given a negative numerical prefix, fetch just that
6299 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6300 grandparent and the grandgrandparent of the current article.  If you say
6301 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6302 article. 
6303
6304 @findex gnus-summary-refer-references
6305 @kindex A R (Summary)
6306 You can have Gnus fetch all articles mentioned in the @code{References}
6307 header of the article by pushing @kbd{A R}
6308 (@code{gnus-summary-refer-references}). 
6309
6310 @findex gnus-summary-refer-article
6311 @kindex M-^ (Summary)
6312 @cindex Message-ID
6313 @cindex fetching by Message-ID
6314 You can also ask the @sc{nntp} server for an arbitrary article, no
6315 matter what group it belongs to.  @kbd{M-^}
6316 (@code{gnus-summary-refer-article}) will ask you for a
6317 @code{Message-ID}, which is one of those long, hard-to-read thingies
6318 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6319 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6320
6321 @vindex gnus-refer-article-method
6322 If the group you are reading is located on a backend that does not
6323 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6324 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6325 would, perhaps, be best if the @sc{nntp} server you consult is the same
6326 as the one that keeps the spool you are reading from updated, but that's
6327 not really necessary.
6328
6329 Most of the mail backends support fetching by @code{Message-ID}, but do
6330 not do a particularly excellent job of it.  That is, @code{nnmbox} and
6331 @code{nnbabyl} are able to locate articles from any groups, while
6332 @code{nnml} and @code{nnfolder} are only able to locate articles that
6333 have been posted to the current group.  (Anything else would be too time
6334 consuming.)  @code{nnmh} does not support this at all.
6335
6336
6337 @node Alternative Approaches
6338 @section Alternative Approaches
6339
6340 Different people like to read news using different methods.  This being
6341 Gnus, we offer a small selection of minor modes for the summary buffers.
6342
6343 @menu
6344 * Pick and Read::               First mark articles and then read them.
6345 * Binary Groups::               Auto-decode all articles.
6346 @end menu
6347
6348
6349 @node Pick and Read
6350 @subsection Pick and Read
6351 @cindex pick and read
6352
6353 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
6354 reading interface.  The user first marks the articles she wants to read
6355 from a summary buffer.  Then she starts reading the articles with just
6356 an article buffer displayed.
6357
6358 @findex gnus-pick-mode
6359 @kindex M-x gnus-pick-mode
6360 Gnus provides a summary buffer minor mode that allows
6361 this---@code{gnus-pick-mode}.  This basically means that a few process
6362 mark commands become one-keystroke commands to allow easy marking, and
6363 it makes one additional command for switching to the summary buffer
6364 available. 
6365
6366 Here are the available keystrokes when using pick mode:
6367
6368 @table @kbd
6369 @item .
6370 @kindex . (Pick)
6371 @findex gnus-summary-mark-as-processable
6372 Pick the article on the current line
6373 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6374 go to the article on that line and pick that article.  (The line number
6375 is normally displayed on the beginning of the summary pick lines.)
6376
6377 @item SPACE
6378 @kindex SPACE (Pick)
6379 @findex gnus-pick-next-page
6380 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6381 at the end of the buffer, start reading the picked articles.
6382
6383 @item u
6384 @kindex u (Pick)
6385 @findex gnus-summary-unmark-as-processable
6386 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6387
6388 @item U
6389 @kindex U (Pick)
6390 @findex gnus-summary-unmark-all-processable
6391 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6392
6393 @item t
6394 @kindex t (Pick)
6395 @findex gnus-uu-mark-thread
6396 Pick the thread (@code{gnus-uu-mark-thread}). 
6397
6398 @item T
6399 @kindex T (Pick)
6400 @findex gnus-uu-unmark-thread
6401 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6402
6403 @item r
6404 @kindex r (Pick)
6405 @findex gnus-uu-mark-region
6406 Pick the region (@code{gnus-uu-mark-region}). 
6407
6408 @item R
6409 @kindex R (Pick)
6410 @findex gnus-uu-unmark-region
6411 Unpick the region (@code{gnus-uu-unmark-region}). 
6412
6413 @item e
6414 @kindex e (Pick)
6415 @findex gnus-uu-mark-by-regexp
6416 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6417
6418 @item E
6419 @kindex E (Pick)
6420 @findex gnus-uu-unmark-by-regexp
6421 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6422
6423 @item b
6424 @kindex b (Pick)
6425 @findex gnus-uu-mark-buffer
6426 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6427
6428 @item B
6429 @kindex B (Pick)
6430 @findex gnus-uu-unmark-buffer
6431 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6432
6433 @item RET
6434 @kindex RET (Pick)
6435 @findex gnus-pick-start-reading
6436 @vindex gnus-pick-display-summary
6437 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6438 given a prefix, mark all unpicked articles as read first.  If
6439 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6440 will still be visible when you are reading.
6441
6442 @end table
6443
6444 If this sounds like a good idea to you, you could say:
6445
6446 @lisp
6447 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6448 @end lisp
6449
6450 @vindex gnus-pick-mode-hook
6451 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6452
6453 @vindex gnus-mark-unpicked-articles-as-read
6454 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6455 all unpicked articles as read.  The default is @code{nil}.
6456
6457 @vindex gnus-summary-pick-line-format
6458 The summary line format in pick mode is slightly different than the
6459 standard format.  At the beginning of each line the line number is
6460 displayed.  The pick mode line format is controlled by the
6461 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6462 Variables}).  It accepts the same format specs that
6463 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6464
6465
6466 @node Binary Groups
6467 @subsection Binary Groups
6468 @cindex binary groups
6469
6470 @findex gnus-binary-mode
6471 @kindex M-x gnus-binary-mode
6472 If you spend much time in binary groups, you may grow tired of hitting
6473 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6474 is a minor mode for summary buffers that makes all ordinary Gnus article
6475 selection functions uudecode series of articles and display the result
6476 instead of just displaying the articles the normal way.  
6477
6478 @kindex g (Binary)
6479 @findex gnus-binary-show-article
6480 In fact, the only way to see the actual articles if you have turned this
6481 mode on is the @kbd{g} command (@code{gnus-binary-show-article}). 
6482
6483 @vindex gnus-binary-mode-hook
6484 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6485
6486
6487 @node Tree Display
6488 @section Tree Display
6489 @cindex trees
6490
6491 @vindex gnus-use-trees
6492 If you don't like the normal Gnus summary display, you might try setting
6493 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6494 additional @dfn{tree buffer}.  You can execute all summary mode commands
6495 in the tree buffer.  
6496
6497 There are a few variables to customize the tree display, of course:
6498
6499 @table @code
6500 @item gnus-tree-mode-hook
6501 @vindex gnus-tree-mode-hook
6502 A hook called in all tree mode buffers.
6503
6504 @item gnus-tree-mode-line-format
6505 @vindex gnus-tree-mode-line-format
6506 A format string for the mode bar in the tree mode buffers.  The default
6507 is @samp{Gnus: %%b [%A] %Z}.  For a list of legal specs, @pxref{Summary
6508 Buffer Mode Line}. 
6509
6510 @item gnus-selected-tree-face
6511 @vindex gnus-selected-tree-face
6512 Face used for highlighting the selected article in the tree buffer.  The
6513 default is @code{modeline}.
6514
6515 @item gnus-tree-line-format
6516 @vindex gnus-tree-line-format
6517 A format string for the tree nodes.  The name is a bit of a misnomer,
6518 though---it doesn't define a line, but just the node.  The default value
6519 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6520 the name of the poster.  It is vital that all nodes are of the same
6521 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6522
6523 Legal specs are:
6524
6525 @table @samp
6526 @item n
6527 The name of the poster.
6528 @item f
6529 The @code{From} header.
6530 @item N
6531 The number of the article.
6532 @item [
6533 The opening bracket.
6534 @item ] 
6535 The closing bracket.
6536 @item s
6537 The subject.
6538 @end table
6539
6540 @xref{Formatting Variables}.
6541
6542 Variables related to the display are:
6543
6544 @table @code
6545 @item gnus-tree-brackets
6546 @vindex gnus-tree-brackets
6547 This is used for differentiating between ``real'' articles and
6548 ``sparse'' articles.  The format is @var{((real-open . real-close)
6549 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6550 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6551
6552 @item gnus-tree-parent-child-edges
6553 @vindex gnus-tree-parent-child-edges
6554 This is a list that contains the characters used for connecting parent
6555 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
6556
6557 @end table
6558
6559 @item gnus-tree-minimize-window
6560 @vindex gnus-tree-minimize-window
6561 If this variable is non-@code{nil}, Gnus will try to keep the tree
6562 buffer as small as possible to allow more room for the other Gnus
6563 windows.  If this variable is a number, the tree buffer will never be
6564 higher than that number.  The default is @code{t}.
6565
6566 @item gnus-generate-tree-function
6567 @vindex gnus-generate-tree-function
6568 @findex gnus-generate-horizontal-tree
6569 @findex gnus-generate-vertical-tree
6570 The function that actually generates the thread tree.  Two predefined
6571 functions are available: @code{gnus-generate-horizontal-tree} and
6572 @code{gnus-generate-vertical-tree} (which is the default).
6573
6574 @end table
6575
6576 Here's and example from a horizontal tree buffer:
6577
6578 @example
6579 @{***@}-(***)-[odd]-[Gun]
6580      |      \[Jan]
6581      |      \[odd]-[Eri]
6582      |      \(***)-[Eri]
6583      |            \[odd]-[Paa]
6584      \[Bjo]
6585      \[Gun]
6586      \[Gun]-[Jor]
6587 @end example
6588
6589 Here's the same thread displayed in a vertical tree buffer:
6590
6591 @example
6592 @{***@}
6593   |--------------------------\-----\-----\
6594 (***)                         [Bjo] [Gun] [Gun]
6595   |--\-----\-----\                          |
6596 [odd] [Jan] [odd] (***)                   [Jor]
6597   |           |     |--\
6598 [Gun]       [Eri] [Eri] [odd]
6599                           |
6600                         [Paa]
6601 @end example
6602
6603
6604 @node Mail Group Commands
6605 @section Mail Group Commands
6606 @cindex mail group commands
6607
6608 Some commands only make sense in mail groups.  If these commands are
6609 illegal in the current group, they will raise a hell and let you know.
6610
6611 All these commands (except the expiry and edit commands) use the
6612 process/prefix convention (@pxref{Process/Prefix}).
6613
6614 @table @kbd
6615
6616 @item B e
6617 @kindex B e (Summary)
6618 @findex gnus-summary-expire-articles
6619 Expire all expirable articles in the group
6620 (@code{gnus-summary-expire-articles}).
6621
6622 @item B M-C-e
6623 @kindex B M-C-e (Summary)
6624 @findex gnus-summary-expire-articles-now
6625 Delete all the expirable articles in the group
6626 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
6627 articles that are eligible for expiry in the current group will
6628 disappear forever into that big @file{/dev/null} in the sky.
6629
6630 @item B DEL
6631 @kindex B DEL (Summary)
6632 @findex gnus-summary-delete-article
6633 Delete the mail article.  This is ``delete'' as in ``delete it from your
6634 disk forever and ever, never to return again.'' Use with caution.
6635 (@code{gnus-summary-delete-article}).
6636
6637 @item B m
6638 @kindex B m (Summary)
6639 @cindex move mail
6640 @findex gnus-summary-move-article
6641 Move the article from one mail group to another
6642 (@code{gnus-summary-move-article}). 
6643
6644 @item B c
6645 @kindex B c (Summary)
6646 @cindex copy mail
6647 @findex gnus-summary-copy-article
6648 Copy the article from one group (mail group or not) to a mail group
6649 (@code{gnus-summary-copy-article}).
6650
6651 @item B C
6652 @kindex B C (Summary)
6653 @cindex crosspost mail
6654 @findex gnus-summary-crosspost-article
6655 Crosspost the current article to some other group
6656 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
6657 the article in the other group, and the Xref headers of the article will
6658 be properly updated.
6659
6660 @item B i
6661 @kindex B i (Summary)
6662 @findex gnus-summary-import-article
6663 Import an arbitrary file into the current mail newsgroup
6664 (@code{gnus-summary-import-article}).  You will be prompted for a file
6665 name, a @code{From} header and a @code{Subject} header.
6666
6667 @item B r
6668 @kindex B r (Summary)
6669 @findex gnus-summary-respool-article
6670 Respool the mail article (@code{gnus-summary-move-article}).
6671 @code{gnus-summary-respool-default-method} will be used as the default
6672 select method when respooling.  This variable is @code{nil} by default,
6673 which means that the current group select method will be used instead.
6674
6675 @item B w
6676 @itemx e
6677 @kindex B w (Summary)
6678 @kindex e (Summary)
6679 @findex gnus-summary-edit-article
6680 @kindex C-c C-c (Article)
6681 Edit the current article (@code{gnus-summary-edit-article}).  To finish
6682 editing and make the changes permanent, type @kbd{C-c C-c}
6683 (@kbd{gnus-summary-edit-article-done}).
6684
6685 @item B q
6686 @kindex B q (Summary)
6687 @findex gnus-summary-respool-query
6688 If you want to re-spool an article, you might be curious as to what group
6689 the article will end up in before you do the re-spooling.  This command
6690 will tell you (@code{gnus-summary-respool-query}). 
6691
6692 @item B p
6693 @kindex B p (Summary)
6694 @findex gnus-summary-article-posted-p
6695 Some people have a tendency to send you "courtesy" copies when they
6696 follow up to articles you have posted.  These usually have a
6697 @code{Newsgroups} header in them, but not always.  This command
6698 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6699 article from your news server (or rather, from
6700 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6701 report back whether it found the article or not.  Even if it says that
6702 it didn't find the article, it may have been posted anyway---mail
6703 propagation is much faster than news propagation, and the news copy may
6704 just not have arrived yet.
6705
6706 @end table
6707
6708 @vindex gnus-move-split-methods
6709 @cindex moving articles
6710 If you move (or copy) articles regularly, you might wish to have Gnus
6711 suggest where to put the articles.  @code{gnus-move-split-methods} is a
6712 variable that uses the same syntax as @code{gnus-split-methods}
6713 (@pxref{Saving Articles}).  You may customize that variable to create
6714 suggestions you find reasonable.
6715
6716 @lisp
6717 (setq gnus-move-split-methods
6718       '(("^From:.*Lars Magne" "nnml:junk")
6719         ("^Subject:.*gnus" "nnfolder:important")
6720         (".*" "nnml:misc")))
6721 @end lisp
6722
6723
6724 @node Various Summary Stuff
6725 @section Various Summary Stuff
6726
6727 @menu
6728 * Summary Group Information::         Information oriented commands.
6729 * Searching for Articles::            Multiple article commands.
6730 * Summary Generation Commands::       (Re)generating the summary buffer.
6731 * Really Various Summary Commands::   Those pesky non-conformant commands.
6732 @end menu
6733
6734 @table @code
6735 @vindex gnus-summary-mode-hook
6736 @item gnus-summary-mode-hook
6737 This hook is called when creating a summary mode buffer.
6738
6739 @vindex gnus-summary-generate-hook
6740 @item gnus-summary-generate-hook
6741 This is called as the last thing before doing the threading and the
6742 generation of the summary buffer.  It's quite convenient for customizing
6743 the threading variables based on what data the newsgroup has.  This hook
6744 is called from the summary buffer after most summary buffer variables
6745 has been set.
6746
6747 @vindex gnus-summary-prepare-hook
6748 @item gnus-summary-prepare-hook
6749 Is is called after the summary buffer has been generated.  You might use
6750 it to, for instance, highlight lines or modify the look of the buffer in
6751 some other ungodly manner.  I don't care.
6752
6753 @end table
6754
6755
6756 @node Summary Group Information
6757 @subsection Summary Group Information
6758
6759 @table @kbd
6760
6761 @item H f
6762 @kindex H f (Summary)
6763 @findex gnus-summary-fetch-faq
6764 @vindex gnus-group-faq-directory
6765 Try to fetch the FAQ (list of frequently asked questions) for the
6766 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
6767 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6768 on a remote machine.  This variable can also be a list of directories.
6769 In that case, giving a prefix to this command will allow you to choose
6770 between the various sites.  @code{ange-ftp} probably will be used for
6771 fetching the file.
6772
6773 @item H d
6774 @kindex H d (Summary)
6775 @findex gnus-summary-describe-group
6776 Give a brief description of the current group
6777 (@code{gnus-summary-describe-group}).  If given a prefix, force
6778 rereading the description from the server.
6779
6780 @item H h
6781 @kindex H h (Summary)
6782 @findex gnus-summary-describe-briefly
6783 Give an extremely brief description of the most important summary
6784 keystrokes (@code{gnus-summary-describe-briefly}).
6785
6786 @item H i
6787 @kindex H i (Summary)
6788 @findex gnus-info-find-node
6789 Go to the Gnus info node (@code{gnus-info-find-node}).
6790 @end table
6791
6792
6793 @node Searching for Articles
6794 @subsection Searching for Articles
6795
6796 @table @kbd
6797
6798 @item M-s
6799 @kindex M-s (Summary)
6800 @findex gnus-summary-search-article-forward
6801 Search through all subsequent articles for a regexp
6802 (@code{gnus-summary-search-article-forward}). 
6803
6804 @item M-r
6805 @kindex M-r (Summary)
6806 @findex gnus-summary-search-article-backward
6807 Search through all previous articles for a regexp
6808 (@code{gnus-summary-search-article-backward}). 
6809
6810 @item &
6811 @kindex & (Summary)
6812 @findex gnus-summary-execute-command
6813 This command will prompt you for a header field, a regular expression to
6814 match on this field, and a command to be executed if the match is made
6815 (@code{gnus-summary-execute-command}).
6816
6817 @item M-&
6818 @kindex M-& (Summary)
6819 @findex gnus-summary-universal-argument
6820 Perform any operation on all articles that have been marked with
6821 the process mark (@code{gnus-summary-universal-argument}).
6822 @end table
6823
6824 @node Summary Generation Commands
6825 @subsection Summary Generation Commands
6826
6827 @table @kbd
6828
6829 @item Y g
6830 @kindex Y g (Summary)
6831 @findex gnus-summary-prepare
6832 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6833
6834 @item Y c 
6835 @kindex Y c (Summary)
6836 @findex gnus-summary-insert-cached-articles
6837 Pull all cached articles (for the current group) into the summary buffer
6838 (@code{gnus-summary-insert-cached-articles}).
6839
6840 @end table
6841
6842
6843 @node Really Various Summary Commands
6844 @subsection Really Various Summary Commands
6845
6846 @table @kbd
6847
6848 @item C-d
6849 @kindex C-d (Summary)
6850 @findex gnus-summary-enter-digest-group
6851 If the current article is a collection of other articles (for instance,
6852 a digest), you might use this command to enter a group based on the that
6853 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
6854 guess what article type is currently displayed unless you give a prefix
6855 to this command, which forces a ``digest'' interpretation.  Basically,
6856 whenever you see a message that is a collection of other messages on
6857 some format, you @kbd{C-d} and read these messages in a more convenient
6858 fashion.
6859
6860 @item M-C-d
6861 @kindex M-C-d (Summary)
6862 @findex gnus-summary-read-document
6863 This command is very similar to the one above, but lets you gather
6864 several documents into one biiig group
6865 (@code{gnus-summary-read-document}).  It does this by opening several
6866 @code{nndoc} groups for each document, and then opening an
6867 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
6868 command understands the process/prefix convention
6869 (@pxref{Process/Prefix}). 
6870
6871 @item C-t
6872 @kindex C-t (Summary)
6873 @findex gnus-summary-toggle-truncation
6874 Toggle truncation of summary lines
6875 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
6876 line centering function in the summary buffer, so it's not a good idea
6877 to have truncation switched off while reading articles.
6878
6879 @item =
6880 @kindex = (Summary)
6881 @findex gnus-summary-expand-window
6882 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6883 If given a prefix, force an @code{article} window configuration. 
6884
6885 @end table
6886
6887
6888 @node Exiting the Summary Buffer
6889 @section Exiting the Summary Buffer
6890 @cindex summary exit
6891 @cindex exiting groups
6892
6893 Exiting from the summary buffer will normally update all info on the
6894 group and return you to the group buffer. 
6895
6896 @table @kbd
6897
6898 @item Z Z
6899 @itemx q
6900 @kindex Z Z (Summary)
6901 @kindex q (Summary)
6902 @findex gnus-summary-exit
6903 @vindex gnus-summary-exit-hook
6904 @vindex gnus-summary-prepare-exit-hook
6905 Exit the current group and update all information on the group
6906 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6907 called before doing much of the exiting, and calls
6908 @code{gnus-summary-expire-articles} by default.
6909 @code{gnus-summary-exit-hook} is called after finishing the exiting
6910 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
6911 group mode having no more (unread) groups.
6912
6913 @item Z E
6914 @itemx Q
6915 @kindex Z E (Summary)
6916 @kindex Q (Summary)
6917 @findex gnus-summary-exit-no-update
6918 Exit the current group without updating any information on the group
6919 (@code{gnus-summary-exit-no-update}).
6920
6921 @item Z c
6922 @itemx c
6923 @kindex Z c (Summary)
6924 @kindex c (Summary)
6925 @findex gnus-summary-catchup-and-exit
6926 Mark all unticked articles in the group as read and then exit
6927 (@code{gnus-summary-catchup-and-exit}).
6928
6929 @item Z C
6930 @kindex Z C (Summary)
6931 @findex gnus-summary-catchup-all-and-exit
6932 Mark all articles, even the ticked ones, as read and then exit
6933 (@code{gnus-summary-catchup-all-and-exit}).
6934
6935 @item Z n
6936 @kindex Z n (Summary)
6937 @findex gnus-summary-catchup-and-goto-next-group
6938 Mark all articles as read and go to the next group
6939 (@code{gnus-summary-catchup-and-goto-next-group}). 
6940
6941 @item Z R
6942 @kindex Z R (Summary)
6943 @findex gnus-summary-reselect-current-group
6944 Exit this group, and then enter it again
6945 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
6946 all articles, both read and unread.
6947
6948 @item Z G
6949 @itemx M-g
6950 @kindex Z G (Summary)
6951 @kindex M-g (Summary)
6952 @findex gnus-summary-rescan-group
6953 Exit the group, check for new articles in the group, and select the
6954 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
6955 articles, both read and unread.
6956
6957 @item Z N
6958 @kindex Z N (Summary)
6959 @findex gnus-summary-next-group
6960 Exit the group and go to the next group
6961 (@code{gnus-summary-next-group}). 
6962
6963 @item Z P
6964 @kindex Z P (Summary)
6965 @findex gnus-summary-prev-group
6966 Exit the group and go to the previous group
6967 (@code{gnus-summary-prev-group}). 
6968
6969 @item Z s
6970 @kindex Z s (Summary)
6971 @findex gnus-summary-save-newsrc
6972 Save the current number of read/marked articles in the dribble buffer
6973 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
6974 given a prefix, also save the @file{.newsrc} file(s).  Using this
6975 command will make exit without updating (the @kbd{Q} command) worthless.
6976 @end table
6977
6978 @vindex gnus-exit-group-hook
6979 @code{gnus-exit-group-hook} is called when you exit the current
6980 group.  
6981
6982 @findex gnus-summary-wake-up-the-dead
6983 @findex gnus-dead-summary-mode
6984 @vindex gnus-kill-summary-on-exit
6985 If you're in the habit of exiting groups, and then changing your mind
6986 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
6987 If you do that, Gnus won't kill the summary buffer when you exit it.
6988 (Quelle surprise!)  Instead it will change the name of the buffer to
6989 something like @samp{*Dead Summary ... *} and install a minor mode
6990 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
6991 buffer, you'll find that all keys are mapped to a function called
6992 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
6993 summary buffer will result in a live, normal summary buffer.  
6994
6995 There will never be more than one dead summary buffer at any one time. 
6996
6997 @vindex gnus-use-cross-reference
6998 The data on the current group will be updated (which articles you have
6999 read, which articles you have replied to, etc.) when you exit the
7000 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7001 @code{t} (which is the default), articles that are cross-referenced to
7002 this group and are marked as read, will also be marked as read in the
7003 other subscribed groups they were cross-posted to.  If this variable is
7004 neither @code{nil} nor @code{t}, the article will be marked as read in
7005 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7006
7007
7008 @node Crosspost Handling
7009 @section Crosspost Handling
7010
7011 @cindex velveeta
7012 @cindex spamming
7013 Marking cross-posted articles as read ensures that you'll never have to
7014 read the same article more than once.  Unless, of course, somebody has
7015 posted it to several groups separately.  Posting the same article to
7016 several groups (not cross-posting) is called @dfn{spamming}, and you are
7017 by law required to send nasty-grams to anyone who perpetrates such a
7018 heinous crime.  You may want to try NoCeM handling to filter out spam
7019 (@pxref{NoCeM}). 
7020
7021 Remember: Cross-posting is kinda ok, but posting the same article
7022 separately to several groups is not.  Massive cross-posting (aka.
7023 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7024 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7025 excessive crossposting (@pxref{Summary Mail Commands}).
7026
7027 @cindex cross-posting
7028 @cindex Xref
7029 @cindex @sc{nov}
7030 One thing that may cause Gnus to not do the cross-posting thing
7031 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7032 (which is very nice, because it speeds things up considerably) which
7033 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7034 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7035 even with @sc{xover} by registering the @code{Xref} lines of all
7036 articles you actually read, but if you kill the articles, or just mark
7037 them as read without reading them, Gnus will not get a chance to snoop
7038 the @code{Xref} lines out of these articles, and will be unable to use
7039 the cross reference mechanism.
7040
7041 @cindex LIST overview.fmt
7042 @cindex overview.fmt
7043 To check whether your @sc{nntp} server includes the @code{Xref} header
7044 in its overview files, try @samp{telnet your.nntp.server nntp},
7045 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7046 overview.fmt}.  This may not work, but if it does, and the last line you
7047 get does not read @samp{Xref:full}, then you should shout and whine at
7048 your news admin until she includes the @code{Xref} header in the
7049 overview files.
7050
7051 @vindex gnus-nov-is-evil
7052 If you want Gnus to get the @code{Xref}s right all the time, you have to
7053 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7054 considerably.
7055
7056 C'est la vie.
7057
7058 For an alternative approach, @pxref{Duplicate Suppression}.
7059
7060
7061 @node Duplicate Suppression
7062 @section Duplicate Suppression
7063
7064 By default, Gnus tries to make sure that you don't have to read the same
7065 article more than once by utilizing the crossposting mechanism
7066 (@pxref{Crosspost Handling}).  However, that simple and efficient
7067 approach may not work satisfactorily for some users for various
7068 reasons.  
7069
7070 @enumerate
7071 @item 
7072 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7073 is evil and not very common.
7074
7075 @item 
7076 The @sc{nntp} server may fail to include the @code{Xref} header in the
7077 @file{.overview} data bases.  This is evil and all too common, alas.
7078
7079 @item
7080 You may be reading the same group (or several related groups) from
7081 different @sc{nntp} servers.
7082
7083 @item
7084 You may be getting mail that duplicates articles posted to groups.
7085 @end enumerate
7086
7087 I'm sure there are other situations that @code{Xref} handling fails as
7088 well, but these four are the most common situations.
7089
7090 If, and only if, @code{Xref} handling fails for you, then you may
7091 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7092 will remember the @code{Message-ID}s of all articles you have read or
7093 otherwise marked as read, and then, as if by magic, mark them as read
7094 all subsequent times you see them---in @emph{all} groups.  Using this
7095 mechanism is quite likely to be somewhat inefficient, but not overly
7096 so.  It's certainly preferable to reading the same articles more than
7097 once.
7098
7099 Duplicate suppression is not a very subtle instrument.  It's more like a
7100 sledge hammer than anything else.  It works in a very simple
7101 fashion---if you have marked an article as read, it adds this Message-ID
7102 to a cache.  The next time it sees this Message-ID, it will mark the
7103 article as read the the @samp{M} mark.  It doesn't care what group it
7104 saw the article in.
7105
7106 @table @code
7107 @item gnus-suppress-duplicates
7108 @vindex gnus-suppress-duplicates
7109 If non-@code{nil}, suppress duplicates.
7110
7111 @item gnus-save-duplicate-list
7112 @vindex gnus-save-duplicate-list
7113 If non-@code{nil}, save the list of duplicates to a file.  This will
7114 make startup and shutdown take longer, so the default is @code{nil}.
7115 However, this means that only duplicate articles that is read in a
7116 single Gnus session are suppressed.  
7117
7118 @item gnus-duplicate-list-length
7119 @vindex gnus-duplicate-list-length
7120 This variables says how many @code{Message-ID}s to keep in the duplicate
7121 suppression list.  The default is 10000.  
7122
7123 @item gnus-duplicate-file
7124 @vindex gnus-duplicate-file
7125 The name of the file to store the duplicate suppression list.  The
7126 default is @file{~/News/suppression}.
7127 @end table
7128
7129 If you have a tendency to stop and start Gnus often, setting
7130 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7131 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7132 the other hand, saving the list makes startup and shutdown much slower,
7133 so that means that if you stop and start Gnus often, you should set
7134 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7135 to you to figure out, I think.
7136
7137
7138 @node The Article Buffer
7139 @chapter The Article Buffer
7140 @cindex article buffer
7141
7142 The articles are displayed in the article buffer, of which there is only
7143 one.  All the summary buffers share the same article buffer unless you
7144 tell Gnus otherwise.
7145
7146 @menu
7147 * Hiding Headers::        Deciding what headers should be displayed.
7148 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7149 * Customizing Articles::  Tailoring the look of the articles.
7150 * Article Keymap::        Keystrokes available in the article buffer.
7151 * Misc Article::          Other stuff.
7152 @end menu
7153
7154
7155 @node Hiding Headers
7156 @section Hiding Headers
7157 @cindex hiding headers
7158 @cindex deleting headers
7159
7160 The top section of each article is the @dfn{head}.  (The rest is the
7161 @dfn{body}, but you may have guessed that already.)
7162
7163 @vindex gnus-show-all-headers
7164 There is a lot of useful information in the head: the name of the person
7165 who wrote the article, the date it was written and the subject of the
7166 article.  That's well and nice, but there's also lots of information
7167 most people do not want to see---what systems the article has passed
7168 through before reaching you, the @code{Message-ID}, the
7169 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7170 of some of those lines.  If you want to keep all those lines in the
7171 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7172
7173 Gnus provides you with two variables for sifting headers:
7174
7175 @table @code
7176
7177 @item gnus-visible-headers
7178 @vindex gnus-visible-headers
7179 If this variable is non-@code{nil}, it should be a regular expression
7180 that says what headers you wish to keep in the article buffer.  All
7181 headers that do not match this variable will be hidden.
7182
7183 For instance, if you only want to see the name of the person who wrote
7184 the article and the subject, you'd say:
7185
7186 @lisp
7187 (setq gnus-visible-headers "^From:\\|^Subject:")
7188 @end lisp
7189
7190 This variable can also be a list of regexps to match headers that are to
7191 remain visible.
7192
7193 @item gnus-ignored-headers
7194 @vindex gnus-ignored-headers
7195 This variable is the reverse of @code{gnus-visible-headers}.  If this
7196 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7197 should be a regular expression that matches all lines that you want to
7198 hide.  All lines that do not match this variable will remain visible.
7199
7200 For instance, if you just want to get rid of the @code{References} line
7201 and the @code{Xref} line, you might say:
7202
7203 @lisp
7204 (setq gnus-ignored-headers "^References:\\|^Xref:")
7205 @end lisp
7206
7207 This variable can also be a list of regexps to match headers that are to
7208 be removed.
7209
7210 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7211 variable will have no effect.
7212
7213 @end table
7214
7215 @vindex gnus-sorted-header-list
7216 Gnus can also sort the headers for you.  (It does this by default.)  You
7217 can control the sorting by setting the @code{gnus-sorted-header-list}
7218 variable.  It is a list of regular expressions that says in what order
7219 the headers are to be displayed.
7220
7221 For instance, if you want the name of the author of the article first,
7222 and then the subject, you might say something like:
7223
7224 @lisp
7225 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7226 @end lisp
7227
7228 Any headers that are to remain visible, but are not listed in this
7229 variable, will be displayed in random order after all the headers that
7230 are listed in this variable.
7231
7232 @findex gnus-article-hide-boring-headers
7233 @vindex gnus-article-display-hook
7234 @vindex gnus-boring-article-headers
7235 You can hide further boring headers by entering
7236 @code{gnus-article-hide-boring-headers} into
7237 @code{gnus-article-display-hook}.  What this function does depends on
7238 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7239 list doesn't actually contain header names.  Instead is lists various
7240 @dfn{boring conditions} that Gnus can check and remove from sight.
7241
7242 These conditions are:
7243 @table @code
7244 @item empty
7245 Remove all empty headers.
7246 @item newsgroups
7247 Remove the @code{Newsgroups} header if it only contains the current group
7248 name. 
7249 @item followup-to
7250 Remove the @code{Followup-To} header if it is identical to the
7251 @code{Newsgroups} header.
7252 @item reply-to
7253 Remove the @code{Reply-To} header if it lists the same address as the
7254 @code{From} header.
7255 @item date
7256 Remove the @code{Date} header if the article is less than three days
7257 old. 
7258 @end table
7259
7260 To include the four first elements, you could say something like;
7261
7262 @lisp
7263 (setq gnus-boring-article-headers 
7264       '(empty newsgroups followup-to reply-to))
7265 @end lisp
7266
7267 This is also the default value for this variable.
7268
7269
7270 @node Using MIME
7271 @section Using @sc{mime}
7272 @cindex @sc{mime}
7273
7274 Mime is a standard for waving your hands through the air, aimlessly,
7275 while people stand around yawning.
7276
7277 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7278 while all newsreaders die of fear.
7279
7280 @sc{mime} may specify what character set the article uses, the encoding
7281 of the characters, and it also makes it possible to embed pictures and
7282 other naughty stuff in innocent-looking articles.
7283
7284 @vindex gnus-show-mime
7285 @vindex gnus-show-mime-method
7286 @vindex gnus-strict-mime
7287 @findex metamail-buffer
7288 Gnus handles @sc{mime} by pushing the articles through
7289 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7290 default.  Set @code{gnus-show-mime} to @code{t} if you want to use
7291 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7292 non-@code{nil}, the @sc{mime} method will only be used if there are
7293 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7294 set, then you'll see some unfortunate display glitches in the article
7295 buffer.  These can't be avoided.
7296
7297 It might be best to just use the toggling functions from the summary
7298 buffer to avoid getting nasty surprises. (For instance, you enter the
7299 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7300 decoded the sound file in the article and some horrible sing-a-long song
7301 comes streaming out out your speakers, and you can't find the volume
7302 button, because there isn't one, and people are starting to look at you,
7303 and you try to stop the program, but you can't, and you can't find the
7304 program to control the volume, and everybody else in the room suddenly
7305 decides to look at you disdainfully, and you'll feel rather stupid.)
7306
7307 Any similarity to real events and people is purely coincidental.  Ahem.
7308
7309
7310 @node Customizing Articles
7311 @section Customizing Articles
7312 @cindex article customization
7313
7314 @vindex gnus-article-display-hook
7315 The @code{gnus-article-display-hook} is called after the article has
7316 been inserted into the article buffer.  It is meant to handle all
7317 treatment of the article before it is displayed. 
7318
7319 @findex gnus-article-maybe-highlight
7320 By default this hook just contains @code{gnus-article-hide-headers},
7321 @code{gnus-article-treat-overstrike}, and
7322 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7323 millions, of functions you can put in this hook.  For an overview of
7324 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7325 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7326 Date}.  Note that the order of functions in this hook might affect
7327 things, so you may have to fiddle a bit to get the desired results. 
7328
7329 You can, of course, write your own functions.  The functions are called
7330 from the article buffer, and you can do anything you like, pretty much.
7331 There is no information that you have to keep in the buffer---you can
7332 change everything.  However, you shouldn't delete any headers.  Instead
7333 make them invisible if you want to make them go away.
7334
7335
7336 @node Article Keymap
7337 @section Article Keymap
7338
7339 Most of the keystrokes in the summary buffer can also be used in the
7340 article buffer.  They should behave as if you typed them in the summary
7341 buffer, which means that you don't actually have to have a summary
7342 buffer displayed while reading.  You can do it all from the article
7343 buffer.
7344
7345 A few additional keystrokes are available:
7346
7347 @table @kbd
7348
7349 @item SPACE
7350 @kindex SPACE (Article)
7351 @findex gnus-article-next-page
7352 Scroll forwards one page (@code{gnus-article-next-page}).
7353
7354 @item DEL
7355 @kindex DEL (Article)
7356 @findex gnus-article-prev-page
7357 Scroll backwards one page (@code{gnus-article-prev-page}).
7358
7359 @item C-c ^
7360 @kindex C-c ^ (Article)
7361 @findex gnus-article-refer-article
7362 If point is in the neighborhood of a @code{Message-ID} and you press
7363 @kbd{r}, Gnus will try to get that article from the server
7364 (@code{gnus-article-refer-article}).
7365
7366 @item C-c C-m
7367 @kindex C-c C-m (Article)
7368 @findex gnus-article-mail
7369 Send a reply to the address near point (@code{gnus-article-mail}).  If
7370 given a prefix, include the mail.
7371
7372 @item s
7373 @kindex s (Article)
7374 @findex gnus-article-show-summary
7375 Reconfigure the buffers so that the summary buffer becomes visible
7376 (@code{gnus-article-show-summary}).
7377
7378 @item ?
7379 @kindex ? (Article)
7380 @findex gnus-article-describe-briefly
7381 Give a very brief description of the available keystrokes
7382 (@code{gnus-article-describe-briefly}). 
7383
7384 @item TAB
7385 @kindex TAB (Article)
7386 @findex gnus-article-next-button
7387 Go to the next button, if any (@code{gnus-article-next-button}.  This
7388 only makes sense if you have buttonizing turned on.
7389
7390 @item M-TAB
7391 @kindex M-TAB (Article)
7392 @findex gnus-article-prev-button
7393 Go to the previous button, if any (@code{gnus-article-prev-button}.  
7394
7395 @end table
7396
7397
7398 @node Misc Article
7399 @section Misc Article
7400
7401 @table @code
7402
7403 @item gnus-single-article-buffer
7404 @vindex gnus-single-article-buffer
7405 If non-@code{nil}, use the same article buffer for all the groups.
7406 (This is the default.)  If @code{nil}, each group will have its own
7407 article buffer.
7408
7409 @vindex gnus-article-prepare-hook
7410 @item gnus-article-prepare-hook
7411 This hook is called right after the article has been inserted into the
7412 article buffer.  It is mainly intended for functions that do something
7413 depending on the contents; it should probably not be used for changing
7414 the contents of the article buffer.
7415
7416 @vindex gnus-article-display-hook
7417 @item gnus-article-display-hook
7418 This hook is called as the last thing when displaying an article, and is
7419 intended for modifying the contents of the buffer, doing highlights,
7420 hiding headers, and the like.
7421
7422 @item gnus-article-mode-hook
7423 @vindex gnus-article-mode-hook
7424 Hook called in article mode buffers.
7425
7426 @item gnus-article-mode-syntax-table
7427 @vindex gnus-article-mode-syntax-table
7428 Syntax table used in article buffers.  It is initialized from
7429 @code{text-mode-syntax-table}. 
7430
7431 @vindex gnus-article-mode-line-format
7432 @item gnus-article-mode-line-format
7433 This variable is a format string along the same lines as
7434 @code{gnus-summary-mode-line-format}.  It accepts the same
7435 format specifications as that variable, with one extension:
7436
7437 @table @samp
7438 @item w
7439 The @dfn{wash status} of the article.  This is a short string with one
7440 character for each possible article wash operation that may have been
7441 performed. 
7442 @end table
7443
7444 @vindex gnus-break-pages
7445
7446 @item gnus-break-pages
7447 Controls whether @dfn{page breaking} is to take place.  If this variable
7448 is non-@code{nil}, the articles will be divided into pages whenever a
7449 page delimiter appears in the article.  If this variable is @code{nil},
7450 paging will not be done.
7451
7452 @item gnus-page-delimiter
7453 @vindex gnus-page-delimiter
7454 This is the delimiter mentioned above.  By default, it is @samp{^L}
7455 (form linefeed).
7456 @end table
7457
7458
7459 @node Composing Messages
7460 @chapter Composing Messages
7461 @cindex reply
7462 @cindex followup
7463 @cindex post
7464
7465 @kindex C-c C-c (Post)
7466 All commands for posting and mailing will put you in a message buffer
7467 where you can edit the article all you like, before you send the article
7468 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7469 Manual}.  If you are in a foreign news group, and you wish to post the
7470 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7471 to make Gnus try to post using the foreign server.
7472
7473 @menu 
7474 * Mail::                 Mailing and replying.
7475 * Post::                 Posting and following up.
7476 * Posting Server::       What server should you post via?
7477 * Mail and Post::        Mailing and posting at the same time.
7478 * Archived Messages::    Where Gnus stores the messages you've sent.
7479 @c * Posting Styles::       An easier way to configure some key elements.
7480 @c * Drafts::               Postponing messages and rejected messages.
7481 @c * Rejected Articles::    What happens if the server doesn't like your article?
7482 @end menu
7483
7484 Also see @pxref{Canceling and Superseding} for information on how to
7485 remove articles you shouldn't have posted.
7486
7487
7488 @node Mail
7489 @section Mail
7490
7491 Variables for customizing outgoing mail:
7492
7493 @table @code
7494 @item gnus-uu-digest-headers
7495 @vindex gnus-uu-digest-headers
7496 List of regexps to match headers included in digested messages.  The
7497 headers will be included in the sequence they are matched.
7498
7499 @end table
7500
7501
7502 @node Post
7503 @section Post
7504
7505 Variables for composing news articles:
7506
7507 @table @code
7508 @item gnus-sent-message-ids-file
7509 @vindex gnus-sent-message-ids-file
7510 Gnus will keep a @code{Message-ID} history file of all the mails it has
7511 sent.  If it discovers that it has already sent a mail, it will ask the
7512 user whether to re-send the mail.  (This is primarily useful when
7513 dealing with @sc{soup} packets and the like where one is apt to sent the
7514 same packet multiple times.)  This variable says what the name of this
7515 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
7516 this variable to @code{nil} if you don't want Gnus to keep a history
7517 file.
7518
7519 @item gnus-sent-message-ids-length
7520 @vindex gnus-sent-message-ids-length
7521 This variable says how many @code{Message-ID}s to keep in the history
7522 file.  It is 1000 by default.
7523
7524 @end table
7525
7526
7527 @node Posting Server
7528 @section Posting Server
7529
7530 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7531 (extremely intelligent, of course) article, where does it go?
7532
7533 Thank you for asking.  I hate you.
7534
7535 @vindex gnus-post-method
7536
7537 It can be quite complicated.  Normally, Gnus will use the same native
7538 server.  However.  If your native server doesn't allow posting, just
7539 reading, you probably want to use some other server to post your
7540 (extremely intelligent and fabulously interesting) articles.  You can
7541 then set the @code{gnus-post-method} to some other method:
7542
7543 @lisp
7544 (setq gnus-post-method '(nnspool ""))
7545 @end lisp
7546
7547 Now, if you've done this, and then this server rejects your article, or
7548 this server is down, what do you do then?  To override this variable you
7549 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7550 the ``current'' server for posting.
7551
7552 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7553 Gnus will prompt you for what method to use for posting.  
7554
7555 You can also set @code{gnus-post-method} to a list of select methods.
7556 If that's the case, Gnus will always prompt you for what method to use
7557 for posting. 
7558
7559
7560 @node Mail and Post
7561 @section Mail and Post
7562
7563 Here's a list of variables that are relevant to both mailing and
7564 posting:
7565
7566 @table @code
7567 @item gnus-mailing-list-groups
7568 @findex gnus-mailing-list-groups
7569 @cindex mailing lists
7570
7571 If your news server offers groups that are really mailing lists that are
7572 gatewayed to the @sc{nntp} server, you can read those groups without
7573 problems, but you can't post/followup to them without some difficulty.
7574 One solution is to add a @code{to-address} to the group parameters
7575 (@pxref{Group Parameters}).  An easier thing to do is set the
7576 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7577 really are mailing lists.  Then, at least, followups to the mailing
7578 lists will work most of the time.  Posting to these groups (@kbd{a}) is
7579 still a pain, though.
7580
7581 @end table
7582
7583 You may want to do spell-checking on messages that you send out.  Or, if
7584 you don't want to spell-check by hand, you could add automatic
7585 spell-checking via the @code{ispell} package:
7586
7587 @cindex ispell
7588 @findex ispell-message
7589 @lisp
7590 (add-hook 'message-send-hook 'ispell-message) 
7591 @end lisp
7592
7593
7594 @node Archived Messages
7595 @section Archived Messages
7596 @cindex archived messages
7597 @cindex sent messages
7598
7599 Gnus provides a few different methods for storing the mail and news you
7600 send.  The default method is to use the @dfn{archive virtual server} to
7601 store the messages.  If you want to disable this completely, the
7602 @code{gnus-message-archive-group} variable should be @code{nil}, which
7603 is the default.
7604
7605 @vindex gnus-message-archive-method
7606 @code{gnus-message-archive-method} says what virtual server Gnus is to
7607 use to store sent messages.  The default is:
7608
7609 @lisp
7610 (nnfolder "archive"
7611           (nnfolder-directory "~/Mail/archive/"))
7612 @end lisp
7613
7614 You can, however, use any mail select method (@code{nnml},
7615 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
7616 for doing this sort of thing, though.  If you don't like the default
7617 directory chosen, you could say something like:
7618
7619 @lisp
7620 (setq gnus-message-archive-method
7621       '(nnfolder "archive" 
7622                  (nnfolder-inhibit-expiry t)
7623                  (nnfolder-active-file "~/News/sent-mail/active")
7624                  (nnfolder-directory "~/News/sent-mail/")))
7625 @end lisp
7626
7627 @vindex gnus-message-archive-group
7628 @cindex Gcc
7629 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7630 to one or more group(s) on that server.  Which group to use is
7631 determined by the @code{gnus-message-archive-group} variable.  
7632
7633 This variable can be:
7634
7635 @itemize @bullet
7636 @item a string
7637 Messages will be saved in that group.
7638 @item a list of strings
7639 Messages will be saved in all those groups.
7640 @item an alist of regexps, functions and forms
7641 When a key ``matches'', the result is used.
7642 @item @code{nil}
7643 No message archiving will take place.  This is the default.
7644 @end itemize
7645
7646 Let's illustrate:
7647
7648 Just saving to a single group called @samp{MisK}:
7649 @lisp
7650 (setq gnus-message-archive-group "MisK")
7651 @end lisp
7652
7653 Saving to two groups, @samp{MisK} and @samp{safe}:
7654 @lisp
7655 (setq gnus-message-archive-group '("MisK" "safe"))
7656 @end lisp
7657
7658 Save to different groups based on what group you are in:
7659 @lisp
7660 (setq gnus-message-archive-group 
7661       '(("^alt" "sent-to-alt")
7662         ("mail" "sent-to-mail")
7663         (".*" "sent-to-misc")))
7664 @end lisp
7665
7666 More complex stuff:
7667 @lisp
7668 (setq gnus-message-archive-group 
7669       '((if (message-news-p)
7670             "misc-news" 
7671           "misc-mail")))
7672 @end lisp       
7673
7674 How about storing all news messages in one file, but storing all mail
7675 messages in one file per month:
7676
7677 @lisp
7678 (setq gnus-message-archive-group
7679       '((if (message-news-p)
7680             "misc-news" 
7681           (concat "mail." (format-time-string 
7682                            "%Y-%m" (current-time))))))
7683 @end lisp
7684
7685 Now, when you send a message off, it will be stored in the appropriate
7686 group.  (If you want to disable storing for just one particular message,
7687 you can just remove the @code{Gcc} header that has been inserted.)  The
7688 archive group will appear in the group buffer the next time you start
7689 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
7690 enter it and read the articles in it just like you'd read any other
7691 group.  If the group gets really big and annoying, you can simply rename
7692 if (using @kbd{G r} in the group buffer) to something
7693 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
7694 continue to be stored in the old (now empty) group.
7695
7696 That's the default method of archiving sent messages.  Gnus also a
7697 different way for the people who don't like the default method.  In that
7698 case you should set @code{gnus-message-archive-group} to @code{nil};
7699 this will disable archiving.
7700
7701 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7702 use a different value for @code{gnus-message-archive-group} there.
7703
7704 @table @code
7705 @item gnus-outgoing-message-group 
7706 @vindex gnus-outgoing-message-group 
7707 All outgoing messages will be put in this group.  If you want to store
7708 all your outgoing mail and articles in the group @samp{nnml:archive},
7709 you set this variable to that value.  This variable can also be a list of
7710 group names.
7711
7712 If you want to have greater control over what group to put each
7713 message in, you can set this variable to a function that checks the
7714 current newsgroup name and then returns a suitable group name (or list
7715 of names).
7716
7717 This variable can be used instead of @code{gnus-message-archive-group},
7718 but the latter is the preferred method.
7719 @end table
7720
7721
7722 @c @node Posting Styles
7723 @c @section Posting Styles
7724 @c @cindex posting styles
7725 @c @cindex styles
7726 @c 
7727 @c All them variables, they make my head swim.  
7728 @c 
7729 @c So what if you want a different @code{Organization} and signature based
7730 @c on what groups you post to?  And you post both from your home machine
7731 @c and your work machine, and you want different @code{From} lines, and so
7732 @c on? 
7733 @c 
7734 @c @vindex gnus-posting-styles
7735 @c One way to do stuff like that is to write clever hooks that change the
7736 @c variables you need to have changed.  That's a bit boring, so somebody
7737 @c came up with the bright idea of letting the user specify these things in
7738 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
7739 @c variable: 
7740 @c 
7741 @c @lisp
7742 @c ((".*" 
7743 @c   (signature . "Peace and happiness")
7744 @c   (organization . "What me?"))
7745 @c  ("^comp" 
7746 @c   (signature . "Death to everybody"))
7747 @c  ("comp.emacs.i-love-it" 
7748 @c   (organization . "Emacs is it")))
7749 @c @end lisp
7750 @c 
7751 @c As you might surmise from this example, this alist consists of several
7752 @c @dfn{styles}.  Each style will be applicable if the first element
7753 @c ``matches'', in some form or other.  The entire alist will be iterated
7754 @c over, from the beginning towards the end, and each match will be
7755 @c applied, which means that attributes in later styles that match override
7756 @c the same attributes in earlier matching styles.  So
7757 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7758 @c signature and the @samp{What me?} @code{Organization} header.
7759 @c 
7760 @c The first element in each style is called the @code{match}.  If it's a
7761 @c string, then Gnus will try to regexp match it against the group name.
7762 @c If it's a function symbol, that function will be called with no
7763 @c arguments.  If it's a variable symbol, then the variable will be
7764 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
7765 @c any case, if this returns a non-@code{nil} value, then the style is said
7766 @c to @dfn{match}.
7767 @c 
7768 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
7769 @c attribute consists of a @var{(name . value)} pair.  The attribute name
7770 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
7771 @c attribute name can also be a string.  In that case, this will be used as
7772 @c a header name, and the value will be inserted in the headers of the
7773 @c article.
7774 @c 
7775 @c The attribute value can be a string (used verbatim), a function (the
7776 @c return value will be used), a variable (its value will be used) or a
7777 @c list (it will be @code{eval}ed and the return value will be used).
7778 @c 
7779 @c So here's a new example:
7780 @c 
7781 @c @lisp
7782 @c (setq gnus-posting-styles
7783 @c       '((".*" 
7784 @c           (signature . "~/.signature") 
7785 @c           (from . "user@@foo (user)")
7786 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
7787 @c           (organization . "People's Front Against MWM"))
7788 @c         ("^rec.humor" 
7789 @c           (signature . my-funny-signature-randomizer))
7790 @c         ((equal (system-name) "gnarly")
7791 @c           (signature . my-quote-randomizer))
7792 @c         (posting-from-work-p
7793 @c           (signature . "~/.work-signature")
7794 @c           (from . "user@@bar.foo (user)")
7795 @c           (organization . "Important Work, Inc"))
7796 @c         ("^nn.+:" 
7797 @c           (signature . "~/.mail-signature"))))
7798 @c @end lisp
7799
7800 @c @node Drafts
7801 @c @section Drafts
7802 @c @cindex drafts
7803 @c 
7804 @c If you are writing a message (mail or news) and suddenly remember that
7805 @c you have a steak in the oven (or some pesto in the food processor, you
7806 @c craazy vegetarians), you'll probably wish there was a method to save the
7807 @c message you are writing so that you can continue editing it some other
7808 @c day, and send it when you feel its finished.
7809 @c 
7810 @c Well, don't worry about it.  Whenever you start composing a message of
7811 @c some sort using the Gnus mail and post commands, the buffer you get will
7812 @c automatically associate to an article in a special @dfn{draft} group.
7813 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7814 @c article will be saved there.  (Auto-save files also go to the draft
7815 @c group.) 
7816 @c 
7817 @c @cindex nndraft
7818 @c @vindex gnus-draft-group-directory
7819 @c The draft group is a special group (which is implemented as an
7820 @c @code{nndraft} group, if you absolutely have to know) called
7821 @c @samp{nndraft:drafts}.  The variable @code{gnus-draft-group-directory}
7822 @c controls both the name of the group and the location---the leaf element
7823 @c in the path will be used as the name of the group.  What makes this
7824 @c group special is that you can't tick any articles in it or mark any
7825 @c articles as read---all articles in the group are permanently unread.
7826 @c 
7827 @c If the group doesn't exist, it will be created and you'll be subscribed
7828 @c to it.
7829 @c 
7830 @c @findex gnus-dissociate-buffer-from-draft
7831 @c @kindex C-c M-d (Mail)
7832 @c @kindex C-c M-d (Post)
7833 @c @findex gnus-associate-buffer-with-draft
7834 @c @kindex C-c C-d (Mail)
7835 @c @kindex C-c C-d (Post)
7836 @c If you're writing some super-secret message that you later want to
7837 @c encode with PGP before sending, you may wish to turn the auto-saving
7838 @c (and association with the draft group) off.  You never know who might be
7839 @c interested in reading all your extremely valuable and terribly horrible
7840 @c and interesting secrets.  The @kbd{C-c M-d}
7841 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7842 @c If you change your mind and want to turn the auto-saving back on again,
7843 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7844 @c 
7845 @c @vindex gnus-use-draft
7846 @c To leave association with the draft group off by default, set
7847 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
7848 @c 
7849 @c @findex gnus-summary-send-draft
7850 @c @kindex S D c (Summary)
7851 @c When you want to continue editing the article, you simply enter the
7852 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7853 @c that.  You will be placed in a buffer where you left off.
7854 @c 
7855 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7856 @c Articles}).
7857 @c 
7858 @c @findex gnus-summary-send-all-drafts
7859 @c If you have lots of rejected messages you want to post (or mail) without
7860 @c doing further editing, you can use the @kbd{S D a} command
7861 @c (@code{gnus-summary-send-all-drafts}).  This command understands the
7862 @c process/prefix convention (@pxref{Process/Prefix}).  
7863 @c 
7864 @c 
7865 @c @node Rejected Articles
7866 @c @section Rejected Articles
7867 @c @cindex rejected articles
7868 @c 
7869 @c Sometimes a news server will reject an article.  Perhaps the server
7870 @c doesn't like your face.  Perhaps it just feels miserable.  Perhaps
7871 @c @emph{there be demons}.  Perhaps you have included too much cited text.
7872 @c Perhaps the disk is full.  Perhaps the server is down.
7873 @c 
7874 @c These situations are, of course, totally beyond the control of Gnus.
7875 @c (Gnus, of course, loves the way you look, always feels great, has angels
7876 @c fluttering around inside of it, doesn't care about how much cited text
7877 @c you include, never runs full and never goes down.)  So Gnus saves these
7878 @c articles until some later time when the server feels better.
7879 @c 
7880 @c The rejected articles will automatically be put in a special draft group
7881 @c (@pxref{Drafts}).  When the server comes back up again, you'd then
7882 @c typically enter that group and send all the articles off.
7883 @c 
7884
7885 @node Select Methods
7886 @chapter Select Methods
7887 @cindex foreign groups
7888 @cindex select methods
7889
7890 A @dfn{foreign group} is a group that is not read by the usual (or
7891 default) means.  It could be, for instance, a group from a different
7892 @sc{nntp} server, it could be a virtual group, or it could be your own
7893 personal mail group.
7894
7895 A foreign group (or any group, really) is specified by a @dfn{name} and
7896 a @dfn{select method}.  To take the latter first, a select method is a
7897 list where the first element says what backend to use (e.g. @code{nntp},
7898 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7899 name}.  There may be additional elements in the select method, where the
7900 value may have special meaning for the backend in question.
7901
7902 One could say that a select method defines a @dfn{virtual server}---so
7903 we do just that (@pxref{The Server Buffer}).
7904
7905 The @dfn{name} of the group is the name the backend will recognize the
7906 group as.
7907
7908 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7909 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7910 method @code{(nntp "some.where.edu")}.  Gnus will call this group
7911 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7912 backend just knows this group as @samp{soc.motss}.
7913
7914 The different methods all have their peculiarities, of course.
7915
7916 @menu
7917 * The Server Buffer::     Making and editing virtual servers.
7918 * Getting News::          Reading USENET news with Gnus.
7919 * Getting Mail::          Reading your personal mail with Gnus.
7920 * Other Sources::         Reading directories, files, SOUP packets.
7921 * Combined Groups::       Combining groups into one group.
7922 @end menu
7923
7924
7925 @node The Server Buffer
7926 @section The Server Buffer
7927
7928 Traditionally, a @dfn{server} is a machine or a piece of software that
7929 one connects to, and then requests information from.  Gnus does not
7930 connect directly to any real servers, but does all transactions through
7931 one backend or other.  But that's just putting one layer more between
7932 the actual media and Gnus, so we might just as well say that each
7933 backend represents a virtual server.
7934
7935 For instance, the @code{nntp} backend may be used to connect to several
7936 different actual @sc{nntp} servers, or, perhaps, to many different ports
7937 on the same actual @sc{nntp} server.  You tell Gnus which backend to
7938 use, and what parameters to set by specifying a @dfn{select method}.
7939
7940 These select methods specifications can sometimes become quite
7941 complicated---say, for instance, that you want to read from the
7942 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
7943 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
7944 Anyways, if you had to specify that for each group that used this
7945 server, that would be too much work, so Gnus offers a way of naming
7946 select methods, which is what you do in the server buffer.
7947
7948 To enter the server buffer, user the @kbd{^}
7949 (@code{gnus-group-enter-server-mode}) command in the group buffer.
7950
7951 @menu
7952 * Server Buffer Format::      You can customize the look of this buffer.
7953 * Server Commands::           Commands to manipulate servers.
7954 * Example Methods::           Examples server specifications.
7955 * Creating a Virtual Server:: An example session.
7956 * Server Variables::          Which variables to set.
7957 * Servers and Methods::       You can use server names as select methods.
7958 * Unavailable Servers::       Some servers you try to contact may be down.
7959 @end menu
7960
7961 @vindex gnus-server-mode-hook
7962 @code{gnus-server-mode-hook} is run when creating the server buffer.
7963
7964
7965 @node Server Buffer Format
7966 @subsection Server Buffer Format
7967 @cindex server buffer format
7968
7969 @vindex gnus-server-line-format
7970 You can change the look of the server buffer lines by changing the
7971 @code{gnus-server-line-format} variable.  This is a @code{format}-like
7972 variable, with some simple extensions:
7973
7974 @table @samp
7975
7976 @item h 
7977 How the news is fetched---the backend name.
7978
7979 @item n
7980 The name of this server.
7981
7982 @item w
7983 Where the news is to be fetched from---the address.
7984
7985 @item s
7986 The opened/closed/denied status of the server.
7987 @end table
7988
7989 @vindex gnus-server-mode-line-format
7990 The mode line can also be customized by using the
7991 @code{gnus-server-mode-line-format} variable.  The following specs are
7992 understood: 
7993
7994 @table @samp
7995 @item S
7996 Server name.
7997
7998 @item M
7999 Server method.
8000 @end table
8001
8002 Also @pxref{Formatting Variables}.
8003
8004
8005 @node Server Commands
8006 @subsection Server Commands
8007 @cindex server commands
8008
8009 @table @kbd
8010
8011 @item a
8012 @kindex a (Server)
8013 @findex gnus-server-add-server
8014 Add a new server (@code{gnus-server-add-server}).
8015
8016 @item e
8017 @kindex e (Server)
8018 @findex gnus-server-edit-server
8019 Edit a server (@code{gnus-server-edit-server}).
8020
8021 @item SPACE
8022 @kindex SPACE (Server)
8023 @findex gnus-server-read-server
8024 Browse the current server (@code{gnus-server-read-server}).
8025
8026 @item q
8027 @kindex q (Server)
8028 @findex gnus-server-exit
8029 Return to the group buffer (@code{gnus-server-exit}).
8030
8031 @item k
8032 @kindex k (Server)
8033 @findex gnus-server-kill-server
8034 Kill the current server (@code{gnus-server-kill-server}).
8035
8036 @item y
8037 @kindex y (Server)
8038 @findex gnus-server-yank-server
8039 Yank the previously killed server (@code{gnus-server-yank-server}).
8040
8041 @item c
8042 @kindex c (Server)
8043 @findex gnus-server-copy-server
8044 Copy the current server (@code{gnus-server-copy-server}).
8045
8046 @item l
8047 @kindex l (Server)
8048 @findex gnus-server-list-servers
8049 List all servers (@code{gnus-server-list-servers}).
8050
8051 @item s
8052 @kindex s (Server)
8053 @findex gnus-server-scan-server
8054 Request that the server scan its sources for new articles
8055 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8056 servers. 
8057
8058 @item g
8059 @kindex g (Server)
8060 @findex gnus-server-regenerate-server
8061 Request that the server regenerate all its data structures
8062 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8063 a mail backend that has gotten out of synch.
8064
8065 @end table
8066
8067
8068 @node Example Methods
8069 @subsection Example Methods
8070
8071 Most select methods are pretty simple and self-explanatory: 
8072
8073 @lisp
8074 (nntp "news.funet.fi")
8075 @end lisp
8076
8077 Reading directly from the spool is even simpler:
8078
8079 @lisp
8080 (nnspool "")
8081 @end lisp
8082
8083 As you can see, the first element in a select method is the name of the
8084 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8085 will. 
8086
8087 After these two elements, there may be a arbitrary number of
8088 @var{(variable form)} pairs.
8089
8090 To go back to the first example---imagine that you want to read from
8091 port 15 from that machine.  This is what the select method should
8092 look like then:
8093
8094 @lisp
8095 (nntp "news.funet.fi" (nntp-port-number 15))
8096 @end lisp
8097
8098 You should read the documentation to each backend to find out what
8099 variables are relevant, but here's an @code{nnmh} example. 
8100
8101 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8102 you have two structures that you wish to access: One is your private
8103 mail spool, and the other is a public one.  Here's the possible spec for
8104 you private mail:
8105
8106 @lisp
8107 (nnmh "private" (nnmh-directory "~/private/mail/"))
8108 @end lisp
8109
8110 (This server is then called @samp{private}, but you may have guessed
8111 that.)
8112
8113 Here's the method for a public spool:
8114
8115 @lisp
8116 (nnmh "public" 
8117       (nnmh-directory "/usr/information/spool/") 
8118       (nnmh-get-new-mail nil))
8119 @end lisp
8120
8121 If you are behind a firewall and only have access to the @sc{nntp}
8122 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8123 on the firewall machine and telnet from there to the @sc{nntp} server.
8124 Doing this can be rather fiddly, but your virtual server definition
8125 should probably look something like this:
8126
8127 @lisp
8128 (nntp "firewall"
8129       (nntp-address "the.firewall.machine")
8130       (nntp-open-connection-function nntp-open-rlogin)
8131       (nntp-end-of-line "\n")
8132       (nntp-rlogin-parameters
8133        ("telnet" "the.real.nntp.host" "nntp")))
8134 @end lisp
8135
8136
8137
8138 @node Creating a Virtual Server
8139 @subsection Creating a Virtual Server
8140
8141 If you're saving lots of articles in the cache by using persistent
8142 articles, you may want to create a virtual server to read the cache.
8143
8144 First you need to add a new server.  The @kbd{a} command does that.  It
8145 would probably be best to use @code{nnspool} to read the cache.  You
8146 could also use @code{nnml} or @code{nnmh}, though.
8147
8148 Type @kbd{a nnspool RET cache RET}.
8149
8150 You should now have a brand new @code{nnspool} virtual server called
8151 @samp{cache}.  You now need to edit it to have the right definitions.
8152 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8153 will contain the following:
8154
8155 @lisp
8156 (nnspool "cache")
8157 @end lisp
8158
8159 Change that to:
8160
8161 @lisp
8162 (nnspool "cache"
8163          (nnspool-spool-directory "~/News/cache/")
8164          (nnspool-nov-directory "~/News/cache/")
8165          (nnspool-active-file "~/News/cache/active"))
8166 @end lisp
8167
8168 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8169 @kbd{RET} over this virtual server, you should be entered into a browse
8170 buffer, and you should be able to enter any of the groups displayed.
8171
8172
8173 @node Server Variables
8174 @subsection Server Variables
8175
8176 One sticky point when defining variables (both on backends and in Emacs
8177 in general) is that some variables are typically initialized from other
8178 variables when the definition of the variables is being loaded.  If you
8179 change the "base" variable after the variables have been loaded, you
8180 won't change the "derived" variables.
8181
8182 This typically affects directory and file variables.  For instance,
8183 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8184 directory variables are initialized from that variable, so
8185 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8186 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8187 @code{nnml-directory}---you have to explicitly set all the file
8188 variables to be what you want them to be.  For a complete list of
8189 variables for each backend, see each backend's section later in this
8190 manual, but here's an example @code{nnml} definition:
8191
8192 @lisp
8193 (nnml "public" 
8194       (nnml-directory "~/my-mail/")
8195       (nnml-active-file "~/my-mail/active")
8196       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8197 @end lisp
8198
8199
8200 @node Servers and Methods
8201 @subsection Servers and Methods
8202
8203 Wherever you would normally use a select method
8204 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8205 when browsing a foreign server) you can use a virtual server name
8206 instead.  This could potentially save lots of typing.  And it's nice all
8207 over.
8208
8209
8210 @node Unavailable Servers
8211 @subsection Unavailable Servers
8212
8213 If a server seems to be unreachable, Gnus will mark that server as
8214 @code{denied}.  That means that any subsequent attempt to make contact
8215 with that server will just be ignored.  ``It can't be opened,'' Gnus
8216 will tell you, without making the least effort to see whether that is
8217 actually the case or not.
8218
8219 That might seem quite naughty, but it does make sense most of the time.
8220 Let's say you have 10 groups subscribed to the server
8221 @samp{nepholococcygia.com}.  This server is located somewhere quite far
8222 away from you, the machine is quite, so it takes 1 minute just to find
8223 out that it refuses connection from you today.  If Gnus were to attempt
8224 to do that 10 times, you'd be quite annoyed, so Gnus won't attempt to do
8225 that.  Once it has gotten a single ``connection refused'', it will
8226 regard that server as ``down''.
8227
8228 So, what happens if the machine was only feeling unwell temporarily?
8229 How do you test to see whether the machine has come up again?
8230
8231 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8232 with the following commands:
8233
8234 @table @kbd
8235
8236 @item O
8237 @kindex O (Server)
8238 @findex gnus-server-open-server
8239 Try to establish connection to the server on the current line
8240 (@code{gnus-server-open-server}).
8241
8242 @item C
8243 @kindex C (Server)
8244 @findex gnus-server-close-server
8245 Close the connection (if any) to the server
8246 (@code{gnus-server-close-server}).
8247
8248 @item D
8249 @kindex D (Server)
8250 @findex gnus-server-deny-server
8251 Mark the current server as unreachable
8252 (@code{gnus-server-deny-server}). 
8253
8254 @item M-o
8255 @kindex M-o (Server)
8256 @findex gnus-server-open-all-servers
8257 Open the connections to all servers in the buffer
8258 (@code{gnus-server-open-all-servers}). 
8259
8260 @item M-c
8261 @kindex M-c (Server)
8262 @findex gnus-server-close-all-servers
8263 Close the connections to all servers in the buffer
8264 (@code{gnus-server-close-all-servers}). 
8265
8266 @item R
8267 @kindex R (Server)
8268 @findex gnus-server-remove-denials
8269 Remove all marks to whether Gnus was denied connection from all servers
8270 (@code{gnus-server-remove-denials}). 
8271
8272 @end table
8273
8274
8275 @node Getting News
8276 @section Getting News
8277 @cindex reading news
8278 @cindex news backends
8279
8280 A newsreader is normally used for reading news.  Gnus currently provides
8281 only two methods of getting news---it can read from an @sc{nntp} server,
8282 or it can read from a local spool.
8283
8284 @menu
8285 * NNTP::               Reading news from an @sc{nntp} server.
8286 * News Spool::         Reading news from the local spool.
8287 @end menu
8288
8289
8290 @node NNTP
8291 @subsection @sc{nntp}
8292 @cindex nntp
8293
8294 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8295 You just specify @code{nntp} as method and the address of the @sc{nntp}
8296 server as the, uhm, address.
8297
8298 If the @sc{nntp} server is located at a non-standard port, setting the
8299 third element of the select method to this port number should allow you
8300 to connect to the right port.  You'll have to edit the group info for
8301 that (@pxref{Foreign Groups}).
8302
8303 The name of the foreign group can be the same as a native group.  In
8304 fact, you can subscribe to the same group from as many different servers
8305 you feel like.  There will be no name collisions.
8306
8307 The following variables can be used to create a virtual @code{nntp}
8308 server: 
8309
8310 @table @code
8311
8312 @item nntp-server-opened-hook
8313 @vindex nntp-server-opened-hook
8314 @cindex @sc{mode reader}
8315 @cindex authinfo
8316 @cindex authentification
8317 @cindex nntp authentification
8318 @findex nntp-send-authinfo
8319 @findex nntp-send-mode-reader
8320 @code{nntp-server-opened-hook} is run after a connection has been made.
8321 It can be used to send commands to the @sc{nntp} server after it has
8322 been contacted.  By default is sends the command @code{MODE READER} to
8323 the server with the @code{nntp-send-mode-reader} function. 
8324
8325 @item nntp-authinfo-function 
8326 @vindex nntp-authinfo-function 
8327 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8328 server.  Available functions include:
8329
8330 @table @code
8331 @item nntp-send-authinfo
8332 @findex nntp-send-authinfo
8333 This function will used you current login name as the user name and will
8334 prompt you for the password.  This is the default.
8335
8336 @item nntp-send-nosy-authinfo
8337 @findex nntp-send-nosy-authinfo
8338 This function will prompt you for both user name and password.
8339
8340 @item nntp-send-authinfo-from-file
8341 @findex nntp-send-authinfo-from-file
8342 This function will use your current login name as the user name and will
8343 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8344 @end table
8345
8346 @item nntp-server-action-alist 
8347 @vindex nntp-server-action-alist 
8348 This is an list of regexps to match on server types and actions to be
8349 taken when matches are made.  For instance, if you want Gnus to beep
8350 every time you connect to innd, you could say something like:
8351
8352 @lisp
8353 (setq nntp-server-action-alist
8354       '(("innd" (ding))))
8355 @end lisp
8356
8357 You probably don't want to do that, though.
8358
8359 The default value is
8360
8361 @lisp
8362   '(("nntpd 1\\.5\\.11t" 
8363      (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8364 @end lisp
8365
8366 This ensures that Gnus doesn't send the @code{MODE READER} command to
8367 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8368
8369 @item nntp-maximum-request
8370 @vindex nntp-maximum-request
8371 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8372 will collect headers by sending a series of @code{head} commands.  To
8373 speed things up, the backend sends lots of these commands without
8374 waiting for reply, and then reads all the replies.  This is controlled
8375 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8376 your network is buggy, you should set this to 1.
8377
8378 @item nntp-connection-timeout
8379 @vindex nntp-connection-timeout
8380 If you have lots of foreign @code{nntp} groups that you connect to
8381 regularly, you're sure to have problems with @sc{nntp} servers not
8382 responding properly, or being too loaded to reply within reasonable
8383 time.  This is can lead to awkward problems, which can be helped
8384 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8385 that says how many seconds the @code{nntp} backend should wait for a
8386 connection before giving up.  If it is @code{nil}, which is the default,
8387 no timeouts are done.
8388
8389 @item nntp-command-timeout
8390 @vindex nntp-command-timeout
8391 @cindex PPP connections
8392 @cindex dynamic IP addresses
8393 If you're running Gnus on a machine that has a dynamically assigned
8394 address, Gnus may become confused.  If the address of your machine
8395 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8396 waiting forever for replies from the server.  To help with this
8397 unfortunate problem, you can set this command to a number.  Gnus will
8398 then, if it sits waiting longer than that number of seconds for a reply
8399 from the server, shut down the connection, start a new one, and resend
8400 the command.  This should hopefully be transparent to the user.  A
8401 likely number is 30 seconds. 
8402
8403 @item nntp-retry-on-break
8404 @vindex nntp-retry-on-break
8405 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8406 hangs.  This will have much the same effect as the command timeout
8407 described above.
8408
8409 @item nntp-server-hook
8410 @vindex nntp-server-hook
8411 This hook is run as the last step when connecting to an @sc{nntp}
8412 server.
8413
8414 @findex nntp-open-rlogin
8415 @findex nntp-open-network-stream
8416 @item nntp-open-connection-function
8417 @vindex nntp-open-connection-function
8418 This function is used to connect to the remote system.  Two pre-made
8419 functions are @code{nntp-open-network-stream}, which is the default, and
8420 simply connects to some port or other on the remote system.  The other
8421 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
8422 and then does a telnet to the @sc{nntp} server available there.
8423
8424 @item nntp-rlogin-parameters
8425 @vindex nntp-rlogin-parameters
8426 If you use @code{nntp-open-rlogin} as the
8427 @code{nntp-open-connection-function}, this list will be used as the
8428 parameter list given to @code{rsh}.
8429
8430 @item nntp-end-of-line
8431 @vindex nntp-end-of-line
8432 String to use as end-of-line markers when talking to the @sc{nntp}
8433 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
8434 using @code{rlogin} to talk to the server.
8435
8436 @item nntp-rlogin-user-name
8437 @vindex nntp-rlogin-user-name
8438 User name on the remote system when using the @code{rlogin} connect
8439 function. 
8440
8441 @item nntp-address
8442 @vindex nntp-address
8443 The address of the remote system running the @sc{nntp} server.
8444
8445 @item nntp-port-number
8446 @vindex nntp-port-number
8447 Port number to connect to when using the @code{nntp-open-network-stream}
8448 connect function.
8449
8450 @item nntp-buggy-select
8451 @vindex nntp-buggy-select
8452 Set this to non-@code{nil} if your select routine is buggy.
8453
8454 @item nntp-nov-is-evil 
8455 @vindex nntp-nov-is-evil 
8456 If the @sc{nntp} server does not support @sc{nov}, you could set this
8457 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8458 can be used automatically.
8459
8460 @item nntp-xover-commands
8461 @vindex nntp-xover-commands
8462 @cindex nov
8463 @cindex XOVER
8464 List of strings that are used as commands to fetch @sc{nov} lines from a
8465 server.  The default value of this variable is @code{("XOVER"
8466 "XOVERVIEW")}. 
8467
8468 @item nntp-nov-gap
8469 @vindex nntp-nov-gap
8470 @code{nntp} normally sends just one big request for @sc{nov} lines to
8471 the server.  The server responds with one huge list of lines.  However,
8472 if you have read articles 2-5000 in the group, and only want to read
8473 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8474 lines that you do not want, and will not use.  This variable says how
8475 big a gap between two consecutive articles is allowed to be before the
8476 @code{XOVER} request is split into several request.  Note that if your
8477 network is fast, setting this variable to a really small number means
8478 that fetching will probably be slower.  If this variable is @code{nil},
8479 @code{nntp} will never split requests.
8480
8481 @item nntp-prepare-server-hook
8482 @vindex nntp-prepare-server-hook
8483 A hook run before attempting to connect to an @sc{nntp} server.
8484
8485 @item nntp-warn-about-losing-connection
8486 @vindex nntp-warn-about-losing-connection
8487 If this variable is non-@code{nil}, some noise will be made when a
8488 server closes connection.
8489
8490 @end table
8491
8492
8493 @node News Spool
8494 @subsection News Spool
8495 @cindex nnspool
8496 @cindex news spool
8497
8498 Subscribing to a foreign group from the local spool is extremely easy,
8499 and might be useful, for instance, to speed up reading groups that
8500 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8501 instance. 
8502
8503 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8504 anything else) as the address.
8505
8506 If you have access to a local spool, you should probably use that as the
8507 native select method (@pxref{Finding the News}).  It is normally faster
8508 than using an @code{nntp} select method, but might not be.  It depends.
8509 You just have to try to find out what's best at your site.
8510
8511 @table @code
8512
8513 @item nnspool-inews-program
8514 @vindex nnspool-inews-program
8515 Program used to post an article.
8516
8517 @item nnspool-inews-switches
8518 @vindex nnspool-inews-switches
8519 Parameters given to the inews program when posting an article. 
8520
8521 @item nnspool-spool-directory
8522 @vindex nnspool-spool-directory
8523 Where @code{nnspool} looks for the articles.  This is normally
8524 @file{/usr/spool/news/}.
8525
8526 @item nnspool-nov-directory 
8527 @vindex nnspool-nov-directory 
8528 Where @code{nnspool} will look for @sc{nov} files.  This is normally
8529 @file{/usr/spool/news/over.view/}.
8530
8531 @item nnspool-lib-dir
8532 @vindex nnspool-lib-dir
8533 Where the news lib dir is (@file{/usr/lib/news/} by default).
8534
8535 @item nnspool-active-file
8536 @vindex nnspool-active-file
8537 The path of the active file.
8538
8539 @item nnspool-newsgroups-file
8540 @vindex nnspool-newsgroups-file
8541 The path of the group descriptions file.
8542
8543 @item nnspool-history-file
8544 @vindex nnspool-history-file
8545 The path of the news history file.
8546
8547 @item nnspool-active-times-file
8548 @vindex nnspool-active-times-file
8549 The path of the active date file.
8550
8551 @item nnspool-nov-is-evil
8552 @vindex nnspool-nov-is-evil
8553 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8554 that it finds.
8555
8556 @item nnspool-sift-nov-with-sed
8557 @vindex nnspool-sift-nov-with-sed
8558 @cindex sed
8559 If non-@code{nil}, which is the default, use @code{sed} to get the
8560 relevant portion from the overview file.  If nil, @code{nnspool} will
8561 load the entire file into a buffer and process it there.
8562
8563 @end table
8564
8565
8566 @node Getting Mail
8567 @section Getting Mail
8568 @cindex reading mail
8569 @cindex mail
8570
8571 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8572 course.
8573
8574 @menu
8575 * Getting Started Reading Mail:: A simple cookbook example.
8576 * Splitting Mail::               How to create mail groups.
8577 * Mail Backend Variables::       Variables for customizing mail handling.
8578 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
8579 * Mail and Procmail::            Reading mail groups that procmail create.
8580 * Incorporating Old Mail::       What about the old mail you have?
8581 * Expiring Mail::                Getting rid of unwanted mail.
8582 * Washing Mail::                 Removing gruft from the mail you get.
8583 * Duplicates::                   Dealing with duplicated mail.
8584 * Not Reading Mail::             Using mail backends for reading other files.
8585 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
8586 @end menu
8587
8588
8589 @node Getting Started Reading Mail
8590 @subsection Getting Started Reading Mail
8591
8592 It's quite easy to use Gnus to read your new mail.  You just plonk the
8593 mail backend of your choice into @code{gnus-secondary-select-methods},
8594 and things will happen automatically.
8595
8596 For instance, if you want to use @code{nnml} (which is a one file per
8597 mail backend), you could put the following in your @file{.gnus} file:
8598
8599 @lisp
8600 (setq gnus-secondary-select-methods
8601       '((nnml "private")))
8602 @end lisp
8603
8604 Now, the next time you start Gnus, this backend will be queried for new
8605 articles, and it will move all the messages in your spool file to its
8606 directory, which is @code{~/Mail/} by default.  The new group that will
8607 be created (@samp{mail.misc}) will be subscribed, and you can read it
8608 like any other group.
8609
8610 You will probably want to split the mail into several groups, though:
8611
8612 @lisp
8613 (setq nnmail-split-methods
8614       '(("junk" "^From:.*Lars Ingebrigtsen")
8615        ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8616        ("other" "")))
8617 @end lisp
8618
8619 This will result in three new @code{nnml} mail groups being created:
8620 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
8621 mail that doesn't fit into the first two groups will be placed in the
8622 latter group.
8623
8624 This should be sufficient for reading mail with Gnus.  You might want to
8625 give the other sections in this part of the manual a perusal, though,
8626 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
8627
8628
8629 @node Splitting Mail
8630 @subsection Splitting Mail
8631 @cindex splitting mail
8632 @cindex mail splitting
8633
8634 @vindex nnmail-split-methods
8635 The @code{nnmail-split-methods} variable says how the incoming mail is
8636 to be split into groups.
8637
8638 @lisp
8639 (setq nnmail-split-methods
8640   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8641     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8642     ("mail.other" "")))
8643 @end lisp
8644
8645 This variable is a list of lists, where the first element of each of
8646 these lists is the name of the mail group (they do not have to be called
8647 something beginning with @samp{mail}, by the way), and the second
8648 element is a regular expression used on the header of each mail to
8649 determine if it belongs in this mail group.
8650
8651 If the first element is the special symbol @code{junk}, then messages
8652 that match the regexp will disappear into the aether.  Use with
8653 extreme caution. 
8654
8655 The second element can also be a function.  In that case, it will be
8656 called narrowed to the headers with the first element of the rule as the
8657 argument.  It should return a non-@code{nil} value if it thinks that the
8658 mail belongs in that group.
8659
8660 The last of these groups should always be a general one, and the regular
8661 expression should @emph{always} be @samp{} so that it matches any mails
8662 that haven't been matched by any of the other regexps.  (These rules are
8663 processed from the beginning of the alist toward the end.  The first
8664 rule to make a match will "win", unless you have crossposting enabled.
8665 In that case, all matching rules will "win".)
8666
8667 If you like to tinker with this yourself, you can set this variable to a
8668 function of your choice.  This function will be called without any
8669 arguments in a buffer narrowed to the headers of an incoming mail
8670 message.  The function should return a list of groups names that it
8671 thinks should carry this mail message.
8672
8673 Note that the mail backends are free to maul the poor, innocent
8674 incoming headers all they want to.  They all add @code{Lines} headers;
8675 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8676 @code{From<SPACE>} line to something else.
8677
8678 @vindex nnmail-crosspost
8679 The mail backends all support cross-posting.  If several regexps match,
8680 the mail will be ``cross-posted'' to all those groups.
8681 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
8682 that no articles are crossposted to the general (@samp{}) group.
8683
8684 @vindex nnmail-crosspost-link-function
8685 @cindex crosspost
8686 @cindex links
8687 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8688 the crossposted articles.  However, not all files systems support hard
8689 links.  If that's the case for you, set
8690 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
8691 variable is @code{add-name-to-file} by default.)  
8692
8693 @kindex M-x nnmail-split-history
8694 @kindex nnmail-split-history
8695 If you wish to see where the previous mail split put the messages, you
8696 can use the @kbd{M-x nnmail-split-history} command.
8697
8698 Gnus gives you all the opportunity you could possibly want for shooting
8699 yourself in the foot.  Let's say you create a group that will contain
8700 all the mail you get from your boss.  And then you accidentally
8701 unsubscribe from the group.  Gnus will still put all the mail from your
8702 boss in the unsubscribed group, and so, when your boss mails you ``Have
8703 that report ready by Monday or you're fired!'', you'll never see it and,
8704 come Tuesday, you'll still believe that you're gainfully employed while
8705 you really should be out collecting empty bottles to save up for next
8706 month's rent money.
8707
8708
8709 @node Mail Backend Variables
8710 @subsection Mail Backend Variables
8711
8712 These variables are (for the most part) pertinent to all the various
8713 mail backends.
8714
8715 @table @code
8716 @vindex nnmail-read-incoming-hook
8717 @item nnmail-read-incoming-hook
8718 The mail backends all call this hook after reading new mail.  You can
8719 use this hook to notify any mail watch programs, if you want to.
8720
8721 @vindex nnmail-spool-file
8722 @item nnmail-spool-file
8723 @cindex POP mail
8724 @cindex MAILHOST
8725 @cindex movemail
8726 @vindex nnmail-pop-password
8727 @vindex nnmail-pop-password-required
8728 The backends will look for new mail in this file.  If this variable is
8729 @code{nil}, the mail backends will never attempt to fetch mail by
8730 themselves.  If you are using a POP mail server and your name is
8731 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
8732 your name is not @samp{larsi}, you should probably modify that
8733 slightly, but you may have guessed that already, you smart & handsome
8734 devil!  You can also set this variable to @code{pop}, and Gnus will try
8735 to figure out the POP mail string by itself.  In any case, Gnus will
8736 call @code{movemail} which will contact the POP server named in the
8737 @code{MAILHOST} environment variable.  If the POP server needs a
8738 password, you can either set @code{nnmail-pop-password-required} to
8739 @code{t} and be prompted for the password, or set
8740 @code{nnmail-pop-password} to the password itself.
8741
8742 @code{nnmail-spool-file} can also be a list of mailboxes.
8743
8744 Your Emacs has to have been configured with @samp{--with-pop} before
8745 compilation.  This is the default, but some installations have it
8746 switched off.
8747
8748 When you use a mail backend, Gnus will slurp all your mail from your
8749 inbox and plonk it down in your home directory.  Gnus doesn't move any
8750 mail if you're not using a mail backend---you have to do a lot of magic
8751 invocations first.  At the time when you have finished drawing the
8752 pentagram, lightened the candles, and sacrificed the goat, you really
8753 shouldn't be too surprised when Gnus moves your mail.
8754
8755 @vindex nnmail-use-procmail
8756 @vindex nnmail-procmail-suffix
8757 @item nnmail-use-procmail
8758 If non-@code{nil}, the mail backends will look in
8759 @code{nnmail-procmail-directory} for incoming mail.  All the files in
8760 that directory that have names ending in @code{nnmail-procmail-suffix}
8761 will be considered incoming mailboxes, and will be searched for new
8762 mail.
8763
8764 @vindex nnmail-crash-box
8765 @item nnmail-crash-box
8766 When the mail backends read a spool file, it is first moved to this
8767 file, which is @file{~/.gnus-crash-box} by default.  If this file
8768 already exists, it will always be read (and incorporated) before any
8769 other spool files.
8770
8771 @vindex nnmail-prepare-incoming-hook
8772 @item nnmail-prepare-incoming-hook
8773 This is run in a buffer that holds all the new incoming mail, and can be
8774 used for, well, anything, really.
8775
8776 @vindex nnmail-split-hook
8777 @item nnmail-split-hook
8778 @findex article-decode-rfc1522
8779 @findex RFC1522 decoding
8780 Hook run in the buffer where the mail headers of each message is kept
8781 just before the splitting based on these headers is done.  The hook is
8782 free to modify the buffer contents in any way it sees fit---the buffer
8783 is discarded after the splitting has been done, and no changes performed
8784 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
8785 is one likely function to add to this hook.
8786
8787 @vindex nnmail-pre-get-new-mail-hook
8788 @vindex nnmail-post-get-new-mail-hook
8789 @item nnmail-pre-get-new-mail-hook
8790 @itemx nnmail-post-get-new-mail-hook
8791 These are two useful hooks executed when treating new incoming
8792 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8793 starting to handle the new mail) and
8794 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8795 is done).  Here's and example of using these two hooks to change the
8796 default file modes the new mail files get:
8797
8798 @lisp
8799 (add-hook 'gnus-pre-get-new-mail-hook 
8800           (lambda () (set-default-file-modes 511)))
8801
8802 (add-hook 'gnus-post-get-new-mail-hook 
8803           (lambda () (set-default-file-modes 551)))
8804 @end lisp
8805
8806 @item nnmail-tmp-directory
8807 @vindex nnmail-tmp-directory
8808 This variable says where to move the incoming mail to while processing
8809 it.  This is usually done in the same directory that the mail backend
8810 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8811 it will be used instead.
8812
8813 @item nnmail-movemail-program
8814 @vindex nnmail-movemail-program
8815 This program is executed to move mail from the user's inbox to her home
8816 directory.  The default is @samp{movemail}.
8817
8818 This can also be a function.  In that case, the function will be called
8819 with two parameters -- the name of the inbox, and the file to be moved
8820 to.
8821
8822 @item nnmail-delete-incoming
8823 @vindex nnmail-delete-incoming
8824 @cindex incoming mail files
8825 @cindex deleting incoming files
8826 If non-@code{nil}, the mail backends will delete the temporary incoming
8827 file after splitting mail into the proper groups.  This is @code{t} by
8828 default.
8829
8830 @c This is @code{nil} by
8831 @c default for reasons of security.
8832
8833 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
8834 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8835 lost mail, I think, but that's not the point.  (Except certain versions
8836 of Red Gnus.))  By not deleting the Incoming* files, one can be sure to
8837 not lose mail -- if Gnus totally whacks out, one can always recover what
8838 was lost.
8839
8840 Delete the @file{Incoming*} files at will.
8841
8842 @item nnmail-use-long-file-names
8843 @vindex nnmail-use-long-file-names
8844 If non-@code{nil}, the mail backends will use long file and directory
8845 names.  Groups like @samp{mail.misc} will end up in directories like
8846 @file{mail.misc/}.  If it is @code{nil}, the same group will end up in
8847 @file{mail/misc/}.
8848
8849 @item nnmail-delete-file-function
8850 @vindex nnmail-delete-file-function
8851 @findex delete-file
8852 Function called to delete files.  It is @code{delete-file} by default. 
8853
8854 @end table
8855
8856
8857 @node Fancy Mail Splitting
8858 @subsection Fancy Mail Splitting
8859 @cindex mail splitting
8860 @cindex fancy mail splitting
8861
8862 @vindex nnmail-split-fancy
8863 @findex nnmail-split-fancy
8864 If the rather simple, standard method for specifying how to split mail
8865 doesn't allow you to do what you want, you can set
8866 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
8867 play with the @code{nnmail-split-fancy} variable.
8868
8869 Let's look at an example value of this variable first:
8870
8871 @lisp
8872 ;; Messages from the mailer daemon are not crossposted to any of
8873 ;; the ordinary groups.  Warnings are put in a separate group
8874 ;; from real errors.
8875 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8876                    "mail.misc"))
8877    ;; Non-error messages are crossposted to all relevant
8878    ;; groups, but we don't crosspost between the group for the
8879    ;; (ding) list and the group for other (ding) related mail.
8880    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8881          ("subject" "ding" "ding.misc"))
8882       ;; Other mailing lists...
8883       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8884       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8885       ;; People...
8886       (any "larsi@@ifi\\.uio\\.no" "people.Lars Magne Ingebrigtsen"))
8887    ;; Unmatched mail goes to the catch all group.
8888    "misc.misc")
8889 @end lisp
8890
8891 This variable has the format of a @dfn{split}.  A split is a (possibly)
8892 recursive structure where each split may contain other splits.  Here are
8893 the five possible split syntaxes:
8894
8895 @enumerate
8896
8897 @item 
8898 @samp{group}: If the split is a string, that will be taken as a group name. 
8899
8900 @item
8901 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
8902 element is a string, then that means that if header FIELD (a regexp)
8903 contains VALUE (also a regexp), then store the message as specified by
8904 SPLIT.
8905
8906 @item
8907 @var{(| SPLIT...)}: If the split is a list, and the first element is
8908 @code{|} (vertical bar), then process each SPLIT until one of them
8909 matches.  A SPLIT is said to match if it will cause the mail message to
8910 be stored in one or more groups.
8911
8912 @item
8913 @var{(& SPLIT...)}: If the split is a list, and the first element is
8914 @code{&}, then process all SPLITs in the list.
8915
8916 @item 
8917 @code{junk}: If the split is the symbol @code{junk}, then don't save
8918 this message anywhere.
8919
8920 @item
8921 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
8922 element is @code{:}, then the second element will be called as a
8923 function with @var{args} given as arguments.  The function should return
8924 a SPLIT.
8925
8926 @end enumerate
8927
8928 In these splits, @var{FIELD} must match a complete field name.
8929 @var{VALUE} must match a complete word according to the fundamental mode
8930 syntax table.  You can use @code{.*} in the regexps to match partial
8931 field names or words.  In other words, all @var{VALUE}'s are wrapped in
8932 @samp{\<} and @samp{\>} pairs.
8933
8934 @vindex nnmail-split-abbrev-alist
8935 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
8936 are expanded as specified by the variable
8937 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
8938 the car of the cells contains the key, and the cdr contains a string.
8939
8940 @vindex nnmail-split-fancy-syntax-table
8941 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
8942 when all this splitting is performed.
8943
8944 If you want to have Gnus create groups dynamically based on some
8945 information in the headers, you can say things like:
8946
8947 @example
8948 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
8949 @end example
8950
8951 That is, do @code{replace-match}-like substitions in the group names. 
8952
8953
8954 @node Mail and Procmail
8955 @subsection Mail and Procmail
8956 @cindex procmail
8957
8958 @cindex slocal
8959 @cindex elm
8960 Many people use @code{procmail} (or some other mail filter program or
8961 external delivery agent---@code{slocal}, @code{elm}, etc) to split
8962 incoming mail into groups.  If you do that, you should set
8963 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
8964 backends never ever try to fetch mail by themselves.
8965
8966 This also means that you probably don't want to set
8967 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
8968 side effects.
8969
8970 When a mail backend is queried for what groups it carries, it replies
8971 with the contents of that variable, along with any groups it has figured
8972 out that it carries by other means.  None of the backends (except
8973 @code{nnmh}) actually go out to the disk and check what groups actually
8974 exist.  (It's not trivial to distinguish between what the user thinks is
8975 a basis for a newsgroup and what is just a plain old file or directory.)
8976
8977 This means that you have to tell Gnus (and the backends) what groups
8978 exist by hand.
8979
8980 Let's take the @code{nnmh} backend as an example. 
8981
8982 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
8983 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
8984
8985 Go to the group buffer and type @kbd{G m}.  When prompted, answer
8986 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
8987 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
8988 to include all your mail groups.
8989
8990 That's it.  You are now set to read your mail.  An active file for this
8991 method will be created automatically.
8992
8993 @vindex nnmail-procmail-suffix
8994 @vindex nnmail-procmail-directory
8995 If you use @code{nnfolder} or any other backend that store more than a
8996 single article in each file, you should never have procmail add mails to
8997 the file that Gnus sees.  Instead, procmail should put all incoming mail
8998 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
8999 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9000 name.  The mail backends will read the mail from these files.
9001
9002 @vindex nnmail-resplit-incoming
9003 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9004 put in the @code{mail.misc}, as one would expect.  However, if you want
9005 Gnus to split the mail the normal way, you could set
9006 @code{nnmail-resplit-incoming} to @code{t}.
9007
9008 @vindex nnmail-keep-last-article
9009 If you use @code{procmail} to split things directory into an @code{nnmh}
9010 directory (which you shouldn't do), you should set
9011 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9012 ever expiring the final article (i. e., the article with the highest
9013 article number) in a mail newsgroup.  This is quite, quite important.
9014
9015 Here's an example setup:  The incoming spools are located in
9016 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
9017 spool files have the same names as the equivalent groups).  The
9018 @code{nnfolder} backend is to be used as the mail interface, and the
9019 @code{nnfolder} directory is @file{~/fMail/}.
9020
9021 @lisp
9022 (setq nnfolder-directory "~/fMail/")
9023 (setq nnmail-spool-file 'procmail)
9024 (setq nnmail-procmail-directory "~/incoming/")
9025 (setq gnus-secondary-select-methods '((nnfolder "")))
9026 (setq nnmail-procmail-suffix "")
9027 @end lisp
9028
9029
9030 @node Incorporating Old Mail
9031 @subsection Incorporating Old Mail
9032
9033 Most people have lots of old mail stored in various file formats.  If
9034 you have set up Gnus to read mail using one of the spiffy Gnus mail
9035 backends, you'll probably wish to have that old mail incorporated into
9036 your mail groups.
9037
9038 Doing so can be quite easy.
9039
9040 To take an example: You're reading mail using @code{nnml}
9041 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9042 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9043 file filled with important, but old, mail.  You want to move it into
9044 your @code{nnml} groups.
9045
9046 Here's how:
9047
9048 @enumerate
9049 @item
9050 Go to the group buffer.
9051
9052 @item 
9053 Type `G f' and give the path of the mbox file when prompted to create an
9054 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9055
9056 @item 
9057 Type `SPACE' to enter the newly created group.
9058
9059 @item
9060 Type `M P b' to process-mark all articles in this group (@pxref{Setting
9061 Process Marks}).
9062
9063 @item 
9064 Type `B r' to respool all the process-marked articles, and answer
9065 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9066 @end enumerate
9067
9068 All the mail messages in the mbox file will now also be spread out over
9069 all your @code{nnml} groups.  Try entering them and check whether things
9070 have gone without a glitch.  If things look ok, you may consider
9071 deleting the mbox file, but I wouldn't do that unless I was absolutely
9072 sure that all the mail has ended up where it should be.
9073
9074 Respooling is also a handy thing to do if you're switching from one mail
9075 backend to another.  Just respool all the mail in the old mail groups
9076 using the new mail backend.
9077
9078
9079 @node Expiring Mail
9080 @subsection Expiring Mail
9081 @cindex article expiry
9082
9083 Traditional mail readers have a tendency to remove mail articles when
9084 you mark them as read, in some way.  Gnus takes a fundamentally
9085 different approach to mail reading.
9086
9087 Gnus basically considers mail just to be news that has been received in
9088 a rather peculiar manner.  It does not think that it has the power to
9089 actually change the mail, or delete any mail messages.  If you enter a
9090 mail group, and mark articles as ``read'', or kill them in some other
9091 fashion, the mail articles will still exist on the system.  I repeat:
9092 Gnus will not delete your old, read mail.  Unless you ask it to, of
9093 course.
9094
9095 To make Gnus get rid of your unwanted mail, you have to mark the
9096 articles as @dfn{expirable}.  This does not mean that the articles will
9097 disappear right away, however.  In general, a mail article will be
9098 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9099 more than one week old.  If you do not mark an article as expirable, it
9100 will remain on your system until hell freezes over.  This bears
9101 repeating one more time, with some spurious capitalizations: IF you do
9102 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9103
9104 @vindex gnus-auto-expirable-newsgroups
9105 You do not have to mark articles as expirable by hand.  Groups that
9106 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9107 have all articles that you read marked as expirable automatically.  All
9108 articles that are marked as expirable have an @samp{E} in the first
9109 column in the summary buffer.
9110
9111 Note that making a group auto-expirable don't mean that all read
9112 articles are expired---only the articles that are marked as expirable
9113 will be expired.  Also note the using the @kbd{d} command won't make
9114 groups expirable---only semi-automatic marking of articles as read will
9115 mark the articles as expirable in auto-expirable groups.
9116
9117 Let's say you subscribe to a couple of mailing lists, and you want the
9118 articles you have read to disappear after a while:
9119
9120 @lisp
9121 (setq gnus-auto-expirable-newsgroups 
9122       "mail.nonsense-list\\|mail.nice-list")
9123 @end lisp
9124
9125 Another way to have auto-expiry happen is to have the element
9126 @code{auto-expire} in the group parameters of the group. 
9127
9128 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9129 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9130 doesn't really mix very well.  
9131
9132 @vindex nnmail-expiry-wait
9133 The @code{nnmail-expiry-wait} variable supplies the default time an
9134 expirable article has to live.  The default is seven days.  
9135
9136 Gnus also supplies a function that lets you fine-tune how long articles
9137 are to live, based on what group they are in.  Let's say you want to
9138 have one month expiry period in the @samp{mail.private} group, a one day
9139 expiry period in the @samp{mail.junk} group, and a six day expiry period
9140 everywhere else:
9141
9142 @vindex nnmail-expiry-wait-function
9143 @lisp
9144 (setq nnmail-expiry-wait-function
9145       (lambda (group)
9146        (cond ((string= group "mail.private")
9147                31)
9148              ((string= group "mail.junk")
9149                1)
9150              ((string= group "important")
9151                'never)
9152              (t
9153                6))))
9154 @end lisp
9155
9156 The group names that this function is fed are ``unadorned'' group
9157 names---no @samp{nnml:} prefixes and the like.
9158
9159 The @code{nnmail-expiry-wait} variable and
9160 @code{nnmail-expiry-wait-function} function can be either a number (not
9161 necessarily an integer) or the symbols @code{immediate} or
9162 @code{never}.  
9163
9164 You can also use the @code{expiry-wait} group parameter to selectively
9165 change the expiry period (@pxref{Group Parameters}).
9166
9167 @vindex nnmail-keep-last-article
9168 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9169 expire the final article in a mail newsgroup.  This is to make life
9170 easier for procmail users.
9171
9172 @vindex gnus-total-expirable-newsgroups
9173 By the way, that line up there about Gnus never expiring non-expirable
9174 articles is a lie.  If you put @code{total-expire} in the group
9175 parameters, articles will not be marked as expirable, but all read
9176 articles will be put through the expiry process.  Use with extreme
9177 caution.  Even more dangerous is the
9178 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9179 this regexp will have all read articles put through the expiry process,
9180 which means that @emph{all} old mail articles in the groups in question
9181 will be deleted after a while.  Use with extreme caution, and don't come
9182 crying to me when you discover that the regexp you used matched the
9183 wrong group and all your important mail has disappeared.  Be a
9184 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9185 with!  So there!
9186
9187 Most people make most of their mail groups total-expirable, though. 
9188
9189
9190 @node Washing Mail
9191 @subsection Washing Mail
9192 @cindex mail washing
9193 @cindex list server brain damage
9194 @cindex incoming mail treatment
9195
9196 Mailers and list servers are notorious for doing all sorts of really,
9197 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9198 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9199 end of all lines passing through our server, so let's do that!!!!1!''
9200 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9201 considered to be self-evident were not discussed.  So.  Here we are.
9202
9203 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9204 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9205 be shocked and dismayed by this, but I haven't got the energy.  It is to
9206 laugh.
9207
9208 Gnus provides a plethora of functions for washing articles while
9209 displaying them, but it might be nicer to do the filtering before
9210 storing the mail to disc.  For that purpose, we have three hooks and
9211 various functions that can be put in these hooks.
9212
9213 @table @code
9214 @item nnmail-prepare-incoming-hook
9215 @vindex nnmail-prepare-incoming-hook
9216 This hook is called before doing anything with the mail and is meant for
9217 grand, sweeping gestures.  Functions to be used include:
9218
9219 @table @code
9220 @item nnheader-ms-strip-cr
9221 @findex nnheader-ms-strip-cr
9222 Remove trailing carriage returns from each line.  This is default on
9223 Emacs running on MS machines.
9224
9225 @end table
9226
9227 @item nnmail-prepare-incoming-header-hook
9228 @vindex nnmail-prepare-incoming-header-hook
9229 This hook is called narrowed to each header.  It can be used when
9230 cleaning up the headers.  Functions that can be used include:
9231
9232 @table @code
9233 @item nnmail-remove-leading-whitespace
9234 @findex nnmail-remove-leading-whitespace
9235 Clear leading white space that ``helpful'' listservs have added to the
9236 headers too make them look nice.  Aaah.  
9237
9238 @item nnmail-remove-list-identifiers
9239 @findex nnmail-remove-list-identifiers
9240 Some list servers add an identifier---for example, @samp{(idm)}---to the
9241 beginning of all @code{Subject} headers.  I'm sure that's nice for
9242 people who use stone age mail readers.  This function will remove
9243 strings that match the @code{nnmail-list-identifiers} regexp, which can
9244 also be a list of regexp.
9245
9246 For instance, if you want to remove the @samp{(idm)} and the
9247 @samp{nagnagnag} identifiers:
9248
9249 @lisp
9250 (setq nnmail-list-identifiers
9251       '("(idm)" "nagnagnag"))
9252 @end lisp
9253
9254 @item nnmail-remove-tabs
9255 @findex nnmail-remove-tabs
9256 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9257
9258 @end table
9259
9260 @item nnmail-prepare-incoming-message-hook
9261 @vindex nnmail-prepare-incoming-message-hook
9262 This hook is called narrowed to each message.  Functions to be used
9263 include: 
9264
9265 @table @code
9266 @item article-de-quoted-unreadable
9267 @findex article-de-quoted-unreadable
9268 Decode Quoted Readable encoding.
9269
9270 @end table
9271 @end table
9272
9273
9274 @node Duplicates
9275 @subsection Duplicates
9276
9277 @vindex nnmail-treat-duplicates
9278 @vindex nnmail-message-id-cache-length
9279 @vindex nnmail-message-id-cache-file
9280 @cindex duplicate mails
9281 If you are a member of a couple of mailing list, you will sometime
9282 receive two copies of the same mail.  This can be quite annoying, so
9283 @code{nnmail} checks for and treats any duplicates it might find.  To do
9284 this, it keeps a cache of old @code{Message-ID}s---
9285 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9286 default.  The approximate maximum number of @code{Message-ID}s stored
9287 there is controlled by the @code{nnmail-message-id-cache-length}
9288 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9289 stored.) If all this sounds scary to you, you can set
9290 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9291 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9292 will insert a warning into the head of the mail saying that it thinks
9293 that this is a duplicate of a different message.
9294
9295 This variable can also be a function.  If that's the case, the function
9296 will be called from a buffer narrowed to the message in question with
9297 the @code{Message-ID} as a parameter.  The function must return either
9298 @code{nil}, @code{warn}, or @code{delete}.
9299
9300 You can turn this feature off completely by setting the variable to
9301 @code{nil}.
9302
9303 If you want all the duplicate mails to be put into a special
9304 @dfn{duplicates} group, you could do that using the normal mail split
9305 methods:
9306
9307 @lisp
9308 (setq nnmail-split-fancy
9309       '(| ;; Messages duplicates go to a separate group.
9310           ("gnus-warning" "duplication of message" "duplicate")
9311           ;; Message from daemons, postmaster, and the like to another.
9312           (any mail "mail.misc")
9313           ;; Other rules.
9314           [ ... ] ))
9315 @end lisp
9316
9317 Or something like:
9318 @lisp
9319 (setq nnmail-split-methods 
9320       '(("duplicates" "^Gnus-Warning:")
9321         ;; Other rules.
9322         [...]))
9323 @end lisp
9324
9325 Here's a neat feature: If you know that the recipient reads her mail
9326 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9327 @code{delete}, you can send her as many insults as you like, just by
9328 using a @code{Message-ID} of a mail that you know that she's already
9329 received.  Think of all the fun!  She'll never see any of it!  Whee!
9330
9331
9332 @node Not Reading Mail
9333 @subsection Not Reading Mail
9334
9335 If you start using any of the mail backends, they have the annoying
9336 habit of assuming that you want to read mail with them.  This might not
9337 be unreasonable, but it might not be what you want.
9338
9339 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9340 will ever attempt to read incoming mail, which should help.
9341
9342 @vindex nnbabyl-get-new-mail
9343 @vindex nnmbox-get-new-mail
9344 @vindex nnml-get-new-mail
9345 @vindex nnmh-get-new-mail
9346 @vindex nnfolder-get-new-mail
9347 This might be too much, if, for instance, you are reading mail quite
9348 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9349 file you have stashed away with @code{nnbabyl}.  All backends have
9350 variables called backend-@code{get-new-mail}.  If you want to disable
9351 the @code{nnbabyl} mail reading, you edit the virtual server for the
9352 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9353
9354 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9355 narrowed to the article to be saved before saving it when reading
9356 incoming mail.
9357
9358
9359 @node Choosing a Mail Backend
9360 @subsection Choosing a Mail Backend
9361
9362 Gnus will read the mail spool when you activate a mail group.  The mail
9363 file is first copied to your home directory.  What happens after that
9364 depends on what format you want to store your mail in.
9365
9366 @menu
9367 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
9368 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
9369 * Mail Spool::                  Store your mail in a private spool?
9370 * MH Spool::                    An mhspool-like backend.
9371 * Mail Folders::                Having one file for each group.
9372 @end menu
9373
9374
9375 @node Unix Mail Box
9376 @subsubsection Unix Mail Box
9377 @cindex nnmbox
9378 @cindex unix mail box
9379
9380 @vindex nnmbox-active-file
9381 @vindex nnmbox-mbox-file
9382 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9383 mail.  @code{nnmbox} will add extra headers to each mail article to say
9384 which group it belongs in.
9385
9386 Virtual server settings:
9387
9388 @table @code
9389 @item nnmbox-mbox-file
9390 @vindex nnmbox-mbox-file
9391 The name of the mail box in the user's home directory. 
9392
9393 @item nnmbox-active-file
9394 @vindex nnmbox-active-file
9395 The name of the active file for the mail box.
9396
9397 @item nnmbox-get-new-mail
9398 @vindex nnmbox-get-new-mail
9399 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9400 into groups.
9401 @end table
9402
9403
9404 @node Rmail Babyl
9405 @subsubsection Rmail Babyl
9406 @cindex nnbabyl
9407 @cindex rmail mbox
9408
9409 @vindex nnbabyl-active-file
9410 @vindex nnbabyl-mbox-file
9411 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9412 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9413 article to say which group it belongs in.
9414
9415 Virtual server settings:
9416
9417 @table @code
9418 @item nnbabyl-mbox-file
9419 @vindex nnbabyl-mbox-file
9420 The name of the rmail mbox file.
9421
9422 @item nnbabyl-active-file
9423 @vindex nnbabyl-active-file
9424 The name of the active file for the rmail box.
9425
9426 @item nnbabyl-get-new-mail
9427 @vindex nnbabyl-get-new-mail
9428 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
9429 @end table
9430
9431
9432 @node Mail Spool
9433 @subsubsection Mail Spool
9434 @cindex nnml
9435 @cindex mail @sc{nov} spool
9436
9437 The @dfn{nnml} spool mail format isn't compatible with any other known
9438 format.  It should be used with some caution.
9439
9440 @vindex nnml-directory
9441 If you use this backend, Gnus will split all incoming mail into files;
9442 one file for each mail, and put the articles into the correct
9443 directories under the directory specified by the @code{nnml-directory}
9444 variable.  The default value is @file{~/Mail/}.
9445
9446 You do not have to create any directories beforehand; Gnus will take
9447 care of all that.
9448
9449 If you have a strict limit as to how many files you are allowed to store
9450 in your account, you should not use this backend.  As each mail gets its
9451 own file, you might very well occupy thousands of inodes within a few
9452 weeks.  If this is no problem for you, and it isn't a problem for you
9453 having your friendly systems administrator walking around, madly,
9454 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9455 know that this is probably the fastest format to use.  You do not have
9456 to trudge through a big mbox file just to read your new mail.
9457
9458 @code{nnml} is probably the slowest backend when it comes to article
9459 splitting.  It has to create lots of files, and it also generates
9460 @sc{nov} databases for the incoming mails.  This makes is the fastest
9461 backend when it comes to reading mail.
9462
9463 Virtual server settings:
9464
9465 @table @code
9466 @item nnml-directory
9467 @vindex nnml-directory
9468 All @code{nnml} directories will be placed under this directory. 
9469
9470 @item nnml-active-file
9471 @vindex nnml-active-file
9472 The active file for the @code{nnml} server.
9473
9474 @item nnml-newsgroups-file
9475 @vindex nnml-newsgroups-file
9476 The @code{nnml} group descriptions file.  @xref{Newsgroups File
9477 Format}. 
9478
9479 @item nnml-get-new-mail
9480 @vindex nnml-get-new-mail
9481 If non-@code{nil}, @code{nnml} will read incoming mail.
9482
9483 @item nnml-nov-is-evil
9484 @vindex nnml-nov-is-evil
9485 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
9486
9487 @item nnml-nov-file-name
9488 @vindex nnml-nov-file-name
9489 The name of the @sc{nov} files.  The default is @file{.overview}. 
9490
9491 @item nnml-prepare-save-mail-hook
9492 @vindex nnml-prepare-save-mail-hook
9493 Hook run narrowed to an article before saving.
9494
9495 @end table
9496
9497 @findex nnml-generate-nov-databases
9498 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9499 you can do a complete update by typing @kbd{M-x
9500 nnml-generate-nov-databases}.  This command will trawl through the
9501 entire @code{nnml} hierarchy, looking at each and every article, so it
9502 might take a while to complete.  A better interface to this
9503 functionality can be found in the server buffer (@pxref{Server
9504 Commands}). 
9505
9506
9507 @node MH Spool
9508 @subsubsection MH Spool
9509 @cindex nnmh
9510 @cindex mh-e mail spool
9511
9512 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9513 @sc{nov} databases and it doesn't keep an active file.  This makes
9514 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9515 makes it easier to write procmail scripts for.
9516
9517 Virtual server settings:
9518
9519 @table @code
9520 @item nnmh-directory
9521 @vindex nnmh-directory
9522 All @code{nnmh} directories will be located under this directory.
9523
9524 @item nnmh-get-new-mail
9525 @vindex nnmh-get-new-mail
9526 If non-@code{nil}, @code{nnmh} will read incoming mail.
9527
9528 @item nnmh-be-safe
9529 @vindex nnmh-be-safe
9530 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9531 sure that the articles in the folder are actually what Gnus thinks they
9532 are.  It will check date stamps and stat everything in sight, so
9533 setting this to @code{t} will mean a serious slow-down.  If you never
9534 use anything but Gnus to read the @code{nnmh} articles, you do not have
9535 to set this variable to @code{t}.
9536 @end table
9537
9538
9539 @node Mail Folders
9540 @subsubsection Mail Folders
9541 @cindex nnfolder
9542 @cindex mbox folders
9543 @cindex mail folders
9544
9545 @code{nnfolder} is a backend for storing each mail group in a separate
9546 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
9547 will add extra headers to keep track of article numbers and arrival
9548 dates.
9549
9550 Virtual server settings:
9551
9552 @table @code
9553 @item nnfolder-directory
9554 @vindex nnfolder-directory
9555 All the @code{nnfolder} mail boxes will be stored under this directory. 
9556
9557 @item nnfolder-active-file
9558 @vindex nnfolder-active-file
9559 The name of the active file.
9560
9561 @item nnfolder-newsgroups-file
9562 @vindex nnfolder-newsgroups-file
9563 The name of the group descriptions file.  @xref{Newsgroups File Format}.
9564
9565 @item nnfolder-get-new-mail
9566 @vindex nnfolder-get-new-mail
9567 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9568 @end table
9569
9570 @findex nnfolder-generate-active-file
9571 @kindex M-x nnfolder-generate-active-file
9572 If you have lots of @code{nnfolder}-like files you'd like to read with
9573 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9574 command to make @code{nnfolder} aware of all likely files in
9575 @code{nnfolder-directory}.
9576
9577
9578 @node Other Sources
9579 @section Other Sources
9580
9581 Gnus can do more than just read news or mail.  The methods described
9582 below allow Gnus to view directories and files as if they were
9583 newsgroups.
9584
9585 @menu
9586 * Directory Groups::      You can read a directory as if it was a newsgroup.
9587 * Anything Groups::       Dired?  Who needs dired?
9588 * Document Groups::       Single files can be the basis of a group.
9589 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
9590 * Web Searches::          Creating groups from articles that match a string.
9591 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9592 @end menu
9593
9594
9595 @node Directory Groups
9596 @subsection Directory Groups
9597 @cindex nndir
9598 @cindex directory groups
9599
9600 If you have a directory that has lots of articles in separate files in
9601 it, you might treat it as a newsgroup.  The files have to have numerical
9602 names, of course.
9603
9604 This might be an opportune moment to mention @code{ange-ftp}, that most
9605 wonderful of all wonderful Emacs packages.  When I wrote @code{nndir}, I
9606 didn't think much about it---a backend to read directories.  Big deal.
9607
9608 @code{ange-ftp} changes that picture dramatically.  For instance, if you
9609 enter the @code{ange-ftp} file name
9610 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9611 @code{ange-ftp} will actually allow you to read this directory over at
9612 @samp{sina} as a newsgroup.  Distributed news ahoy!
9613
9614 @code{nndir} will use @sc{nov} files if they are present.
9615
9616 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9617 articles with this method.  You can use @code{nnmh} or @code{nnml} for
9618 whatever you use @code{nndir} for, so you could switch to any of those
9619 methods if you feel the need to have a non-read-only @code{nndir}.
9620
9621
9622 @node Anything Groups
9623 @subsection Anything Groups
9624 @cindex nneething
9625
9626 From the @code{nndir} backend (which reads a single spool-like
9627 directory), it's just a hop and a skip to @code{nneething}, which
9628 pretends that any arbitrary directory is a newsgroup.  Strange, but
9629 true.
9630
9631 When @code{nneething} is presented with a directory, it will scan this
9632 directory and assign article numbers to each file.  When you enter such
9633 a group, @code{nneething} must create ``headers'' that Gnus can use.
9634 After all, Gnus is a newsreader, in case you're
9635 forgetting. @code{nneething} does this in a two-step process.  First, it
9636 snoops each file in question.  If the file looks like an article (i.e.,
9637 the first few lines look like headers), it will use this as the head.
9638 If this is just some arbitrary file without a head (e.g. a C source
9639 file), @code{nneething} will cobble up a header out of thin air.  It
9640 will use file ownership, name and date and do whatever it can with these
9641 elements.
9642
9643 All this should happen automatically for you, and you will be presented
9644 with something that looks very much like a newsgroup.  Totally like a
9645 newsgroup, to be precise.  If you select an article, it will be displayed
9646 in the article buffer, just as usual.
9647
9648 If you select a line that represents a directory, Gnus will pop you into
9649 a new summary buffer for this @code{nneething} group.  And so on.  You can
9650 traverse the entire disk this way, if you feel like, but remember that
9651 Gnus is not dired, really, and does not intend to be, either.
9652
9653 There are two overall modes to this action---ephemeral or solid.  When
9654 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9655 will not store information on what files you have read, and what files
9656 are new, and so on.  If you create a solid @code{nneething} group the
9657 normal way with @kbd{G m}, Gnus will store a mapping table between
9658 article numbers and file names, and you can treat this group like any
9659 other groups.  When you activate a solid @code{nneething} group, you will
9660 be told how many unread articles it contains, etc., etc.
9661
9662 Some variables:
9663
9664 @table @code
9665 @item nneething-map-file-directory
9666 @vindex nneething-map-file-directory
9667 All the mapping files for solid @code{nneething} groups will be stored
9668 in this directory, which defaults to @file{~/.nneething/}.
9669
9670 @item nneething-exclude-files
9671 @vindex nneething-exclude-files
9672 All files that match this regexp will be ignored.  Nice to use to exclude
9673 auto-save files and the like, which is what it does by default.
9674
9675 @item nneething-map-file
9676 @vindex nneething-map-file
9677 Name of the map files.
9678 @end table
9679
9680
9681 @node Document Groups
9682 @subsection Document Groups
9683 @cindex nndoc
9684 @cindex documentation group
9685 @cindex help group
9686
9687 @code{nndoc} is a cute little thing that will let you read a single file
9688 as a newsgroup.  Several files types are supported:
9689
9690 @table @code
9691 @cindex babyl
9692 @cindex rmail mbox
9693
9694 @item babyl
9695 The babyl (rmail) mail box.
9696 @cindex mbox
9697 @cindex Unix mbox
9698
9699 @item mbox
9700 The standard Unix mbox file.
9701
9702 @cindex MMDF mail box
9703 @item mmdf
9704 The MMDF mail box format.
9705
9706 @item news
9707 Several news articles appended into a file.
9708
9709 @item rnews
9710 @cindex rnews batch files
9711 The rnews batch transport format.
9712 @cindex forwarded messages
9713
9714 @item forward
9715 Forwarded articles.
9716
9717 @item mime-digest
9718 @cindex digest
9719 @cindex MIME digest
9720 @cindex 1153 digest
9721 @cindex RFC 1153 digest
9722 @cindex RFC 341 digest
9723 MIME (RFC 1341) digest format.
9724
9725 @item standard-digest
9726 The standard (RFC 1153) digest format.
9727
9728 @item slack-digest
9729 Non-standard digest format---matches most things, but does it badly. 
9730 @end table
9731
9732 You can also use the special ``file type'' @code{guess}, which means
9733 that @code{nndoc} will try to guess what file type it is looking at.
9734 @code{digest} means that @code{nndoc} should guess what digest type the
9735 file is.
9736
9737 @code{nndoc} will not try to change the file or insert any extra headers into
9738 it---it will simply, like, let you use the file as the basis for a
9739 group.  And that's it.
9740
9741 If you have some old archived articles that you want to insert into your
9742 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9743 that.  Say you have an old @file{RMAIL} file with mail that you now want
9744 to split into your new @code{nnml} groups.  You look at that file using
9745 @code{nndoc} (using the @kbd{G f} command in the group buffer
9746 (@pxref{Foreign Groups})), set the process mark on all the articles in
9747 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9748 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
9749 file is now also stored in lots of @code{nnml} directories, and you can
9750 delete that pesky @file{RMAIL} file.  If you have the guts!
9751
9752 Virtual server variables:
9753
9754 @table @code
9755 @item nndoc-article-type
9756 @vindex nndoc-article-type
9757 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9758 @code{mmdf}, @code{forward}, @code{rfc934}, @code{news}, @code{rnews},
9759 @code{mime-digest}, @code{clari-briefs}, or @code{guess}.
9760
9761 @item nndoc-post-type
9762 @vindex nndoc-post-type
9763 This variable says whether Gnus is to consider the group a news group or
9764 a mail group.  There are two legal values:  @code{mail} (the default)
9765 and @code{news}.
9766 @end table
9767
9768 @menu
9769 * Document Server Internals::   How to add your own document types.
9770 @end menu
9771
9772
9773 @node Document Server Internals
9774 @subsubsection Document Server Internals
9775
9776 Adding new document types to be recognized by @code{nndoc} isn't
9777 difficult.  You just have to whip up a definition of what the document
9778 looks like, write a predicate function to recognize that document type,
9779 and then hook into @code{nndoc}.
9780
9781 First, here's an example document type definition:
9782
9783 @example
9784 (mmdf 
9785  (article-begin .  "^\^A\^A\^A\^A\n")
9786  (body-end .  "^\^A\^A\^A\^A\n"))
9787 @end example
9788
9789 The definition is simply a unique @dfn{name} followed by a series of
9790 regexp pseudo-variable settings.  Below are the possible
9791 variables---don't be daunted by the number of variables; most document
9792 types can be defined with very few settings:
9793
9794 @table @code
9795 @item first-article
9796 If present, @code{nndoc} will skip past all text until it finds
9797 something that match this regexp.  All text before this will be
9798 totally ignored. 
9799
9800 @item article-begin
9801 This setting has to be present in all document type definitions.  It
9802 says what the beginning of each article looks like.
9803
9804 @item head-begin-function
9805 If present, this should be a function that moves point to the head of
9806 the article.
9807
9808 @item nndoc-head-begin
9809 If present, this should be a regexp that matches the head of the
9810 article. 
9811
9812 @item nndoc-head-end
9813 This should match the end of the head of the article.  It defaults to
9814 @samp{^$}---the empty line.
9815
9816 @item body-begin-function
9817 If present, this function should move point to the beginning of the body
9818 of the article.
9819
9820 @item body-begin
9821 This should match the beginning of the body of the article.  It defaults
9822 to @samp{^\n}.
9823
9824 @item body-end-function
9825 If present, this function should move point to the end of the body of
9826 the article.
9827
9828 @item body-end
9829 If present, this should match the end of the body of the article.
9830
9831 @item nndoc-file-end
9832 If present, this should match the end of the file.  All text after this
9833 regexp will be totally ignored. 
9834
9835 @end table
9836
9837 So, using these variables @code{nndoc} is able to dissect a document
9838 file into a series of articles, each with a head and a body.  However, a
9839 few more variables are needed since not all document types are all that
9840 news-like---variables needed to transform the head or the body into
9841 something that's palatable for Gnus:
9842
9843 @table @code
9844 @item prepare-body-function
9845 If present, this function will be called when requesting an article.  It
9846 will be called with point at the start of the body, and is useful if the
9847 document has encoded some parts of its contents. 
9848
9849 @item article-transform-function
9850 If present, this function is called when requesting an article.  It's
9851 meant to be used how more wide-ranging transformation of both head and
9852 body of the article.
9853
9854 @item generate-head-function
9855 If present, this function is called to generate a head that Gnus can
9856 understand.  It is called with the article number as a parameter, and is
9857 expected to generate a nice head for the article in question.  It is
9858 called when requesting the headers of all articles.
9859
9860 @end table
9861
9862 Let's look at the most complicated example I can come up with---standard
9863 digests:
9864
9865 @example
9866 (standard-digest
9867  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9868  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9869  (prepare-body-function . nndoc-unquote-dashes)
9870  (body-end-function . nndoc-digest-body-end)
9871  (head-end . "^ ?$")
9872  (body-begin . "^ ?\n")
9873  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
9874  (subtype digest guess))
9875 @end example
9876
9877 We see that all text before a 70-width line of dashes is ignored; all
9878 text after a line that starts with that @samp{^End of} is also ignored;
9879 each article begins with a 30-width line of dashes; the line separating
9880 the head from the body may contain a single space; and that the body is
9881 run through @code{nndoc-unquote-dashes} before being delivered.
9882
9883 To hook your own document definition into @code{nndoc}, use the
9884 @code{nndoc-add-type} function.  It takes two parameters---the first is
9885 the definition itself and the second (optional) parameter says where in
9886 the document type definition alist to put this definition.  The alist is
9887 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
9888 type.  So @code{nndoc-mmdf-type-p} is called to see whether a document
9889 is of @code{mmdf} type, and so on.  These type predicates should return
9890 @code{nil} if the document is not of the correct type; @code{t} if it is
9891 of the correct type; and a number if the document might be of the
9892 correct type.  A high number means high probability; a low number means
9893 low probability with @samp{0} being the lowest legal number.
9894
9895
9896 @node SOUP
9897 @subsection SOUP
9898 @cindex SOUP
9899 @cindex offline
9900
9901 In the PC world people often talk about ``offline'' newsreaders.  These
9902 are thingies that are combined reader/news transport monstrosities.
9903 With built-in modem programs.  Yecchh!
9904
9905 Of course, us Unix Weenie types of human beans use things like
9906 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
9907 transport things like Ghod intended.  And then we just use normal
9908 newsreaders.  
9909
9910 However, it can sometimes be convenient to do something a that's a bit
9911 easier on the brain if you have a very slow modem, and you're not really
9912 that interested in doing things properly.  
9913
9914 A file format called @sc{soup} has been developed for transporting news
9915 and mail from servers to home machines and back again.  It can be a bit
9916 fiddly.
9917
9918 First some terminology:
9919
9920 @table @dfn
9921
9922 @item server
9923 This is the machine that is connected to the outside world and where you
9924 get news and/or mail from.
9925
9926 @item home machine
9927 This is the machine that you want to do the actual reading and responding
9928 on.  It is typically not connected to the rest of the world in any way.
9929
9930 @item packet
9931 Something that contains messages and/or commands.  There are two kinds
9932 of packets:
9933
9934 @table @dfn
9935 @item message packets
9936 These are packets made at the server, and typically contains lots of
9937 messages for you to read.  These are called @file{SoupoutX.tgz} by
9938 default, where @var{X} is a number.
9939
9940 @item response packets
9941 These are packets made at the home machine, and typically contains
9942 replies that you've written.  These are called @file{SoupinX.tgz} by
9943 default, where @var{X} is a number.
9944
9945 @end table
9946
9947 @end table
9948
9949
9950 @enumerate
9951
9952 @item
9953 You log in on the server and create a @sc{soup} packet.  You can either
9954 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
9955 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
9956 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
9957
9958 @item 
9959 You transfer the packet home.  Rail, boat, car or modem will do fine.
9960
9961 @item
9962 You put the packet in your home directory.
9963
9964 @item
9965 You fire up Gnus on your home machine using the @code{nnsoup} backend as
9966 the native or secondary server.
9967
9968 @item
9969 You read articles and mail and answer and followup to the things you
9970 want (@pxref{SOUP Replies}).
9971
9972 @item 
9973 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
9974 packet.
9975
9976 @item 
9977 You transfer this packet to the server.  
9978
9979 @item
9980 You use Gnus to mail this packet out with the @kbd{G s s} command.
9981
9982 @item
9983 You then repeat until you die.
9984
9985 @end enumerate
9986
9987 So you basically have a bipartite system---you use @code{nnsoup} for
9988 reading and Gnus for packing/sending these @sc{soup} packets.
9989
9990 @menu
9991 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
9992 * SOUP Groups::       A backend for reading @sc{soup} packets.
9993 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
9994 @end menu
9995
9996
9997 @node SOUP Commands
9998 @subsubsection SOUP Commands
9999
10000 These are commands for creating and manipulating @sc{soup} packets.
10001
10002 @table @kbd
10003 @item G s b
10004 @kindex G s b (Group)
10005 @findex gnus-group-brew-soup
10006 Pack all unread articles in the current group
10007 (@code{gnus-group-brew-soup}).  This command understands the
10008 process/prefix convention.
10009
10010 @item G s w
10011 @kindex G s w (Group)
10012 @findex gnus-soup-save-areas
10013 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10014
10015 @item G s s
10016 @kindex G s s (Group)
10017 @findex gnus-soup-send-replies
10018 Send all replies from the replies packet
10019 (@code{gnus-soup-send-replies}). 
10020
10021 @item G s p
10022 @kindex G s p (Group)
10023 @findex gnus-soup-pack-packet
10024 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
10025
10026 @item G s r
10027 @kindex G s r (Group)
10028 @findex nnsoup-pack-replies
10029 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
10030
10031 @item O s
10032 @kindex O s (Summary)
10033 @findex gnus-soup-add-article
10034 This summary-mode command adds the current article to a @sc{soup} packet
10035 (@code{gnus-soup-add-article}).  It understands the process/prefix
10036 convention (@pxref{Process/Prefix}). 
10037
10038 @end table
10039
10040
10041 There are a few variables to customize where Gnus will put all these
10042 thingies:  
10043
10044 @table @code
10045
10046 @item gnus-soup-directory
10047 @vindex gnus-soup-directory
10048 Directory where Gnus will save intermediate files while composing
10049 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
10050
10051 @item gnus-soup-replies-directory
10052 @vindex gnus-soup-replies-directory
10053 This is what Gnus will use as a temporary directory while sending our
10054 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10055
10056 @item gnus-soup-prefix-file
10057 @vindex gnus-soup-prefix-file
10058 Name of the file where Gnus stores the last used prefix.  The default is
10059 @samp{gnus-prefix}. 
10060
10061 @item gnus-soup-packer
10062 @vindex gnus-soup-packer
10063 A format string command for packing a @sc{soup} packet.  The default is
10064 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
10065
10066 @item gnus-soup-unpacker
10067 @vindex gnus-soup-unpacker
10068 Format string command for unpacking a @sc{soup} packet.  The default is
10069 @samp{gunzip -c %s | tar xvf -}.
10070
10071 @item gnus-soup-packet-directory
10072 @vindex gnus-soup-packet-directory
10073 Where Gnus will look for reply packets.  The default is @file{~/}. 
10074
10075 @item gnus-soup-packet-regexp
10076 @vindex gnus-soup-packet-regexp
10077 Regular expression matching @sc{soup} reply packets in
10078 @code{gnus-soup-packet-directory}. 
10079
10080 @end table
10081  
10082
10083 @node SOUP Groups
10084 @subsubsection @sc{soup} Groups
10085 @cindex nnsoup
10086
10087 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10088 read incoming packets, unpack them, and put them in a directory where
10089 you can read them at leisure.
10090
10091 These are the variables you can use to customize its behavior:
10092
10093 @table @code
10094
10095 @item nnsoup-tmp-directory
10096 @vindex nnsoup-tmp-directory
10097 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10098 directory.  (@file{/tmp/} by default.)  
10099
10100 @item nnsoup-directory
10101 @vindex nnsoup-directory
10102 @code{nnsoup} then moves each message and index file to this directory.
10103 The default is @file{~/SOUP/}.
10104
10105 @item nnsoup-replies-directory 
10106 @vindex nnsoup-replies-directory 
10107 All replies will stored in this directory before being packed into a
10108 reply packet.  The default is @file{~/SOUP/replies/"}.
10109
10110 @item nnsoup-replies-format-type
10111 @vindex nnsoup-replies-format-type
10112 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10113 (rnews), and I don't think you should touch that variable.  I probably
10114 shouldn't even have documented it.  Drats!  Too late!
10115
10116 @item nnsoup-replies-index-type
10117 @vindex nnsoup-replies-index-type
10118 The index type of the replies packet.  The is @samp{?n}, which means
10119 ``none''.  Don't fiddle with this one either!
10120
10121 @item nnsoup-active-file
10122 @vindex nnsoup-active-file
10123 Where @code{nnsoup} stores lots of information.  This is not an ``active
10124 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10125 this file or mess it up in any way, you're dead.  The default is
10126 @file{~/SOUP/active}.
10127
10128 @item nnsoup-packer
10129 @vindex nnsoup-packer
10130 Format string command for packing a reply @sc{soup} packet.  The default
10131 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
10132
10133 @item nnsoup-unpacker
10134 @vindex nnsoup-unpacker
10135 Format string command for unpacking incoming @sc{soup} packets.  The
10136 default is @samp{gunzip -c %s | tar xvf -}. 
10137
10138 @item nnsoup-packet-directory
10139 @vindex nnsoup-packet-directory
10140 Where @code{nnsoup} will look for incoming packets.  The default is
10141 @file{~/}.  
10142
10143 @item nnsoup-packet-regexp
10144 @vindex nnsoup-packet-regexp
10145 Regular expression matching incoming @sc{soup} packets.  The default is
10146 @samp{Soupout}. 
10147
10148 @end table
10149
10150
10151 @node SOUP Replies
10152 @subsubsection SOUP Replies
10153
10154 Just using @code{nnsoup} won't mean that your postings and mailings end
10155 up in @sc{soup} reply packets automagically.  You have to work a bit
10156 more for that to happen.
10157
10158 @findex nnsoup-set-variables
10159 The @code{nnsoup-set-variables} command will set the appropriate
10160 variables to ensure that all your followups and replies end up in the
10161 @sc{soup} system.
10162
10163 In specific, this is what it does:
10164
10165 @lisp
10166 (setq message-send-news-function 'nnsoup-request-post)
10167 (setq message-send-mail-function 'nnsoup-request-mail)
10168 @end lisp
10169
10170 And that's it, really.  If you only want news to go into the @sc{soup}
10171 system you just use the first line.  If you only want mail to be
10172 @sc{soup}ed you use the second.
10173
10174
10175 @node Web Searches
10176 @subsection Web Searches
10177 @cindex nnweb
10178 @cindex DejaNews
10179 @cindex Alta Vista
10180 @cindex InReference
10181 @cindex Usenet searches
10182 @cindex searching the Usenet
10183
10184 It's, like, too neat to search the Usenet for articles that match a
10185 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10186 those, like, Web browsers, and you, like, have to, rilly, like, look at
10187 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10188 searches without having to use a browser.
10189
10190 The @code{nnweb} backend allows an easy interface to the mighty search
10191 engine.  You create an @code{nnweb} group, enter a search pattern, and
10192 then enter the group and read the articles like you would any normal
10193 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10194 Groups}) will do this in an easy-to-use fashion.
10195
10196 @code{nnweb} groups don't really lend themselves to being solid
10197 groups---they have a very fleeting idea of article numbers.  In fact,
10198 each time you enter an @code{nnweb} group (not even changing the search
10199 pattern), you are likely to get the articles ordered in a different
10200 manner.  Not even using duplicate suppression (@code{Duplicate
10201 Suppression}) will help, since @code{nnweb} doesn't even know the
10202 @code{Message-ID} of the articles before reading them using some search
10203 engines (DejaNews, for instance).  The only possible way to keep track
10204 of which articles you've read is by scoring on the @code{Date}
10205 header---mark all articles that were posted before the last date you
10206 read the group as read.
10207
10208 If the search engine changes its output substantially, @code{nnweb}
10209 won't be able to parse it and will fail.  One could hardly fault the Web
10210 providers if they were to do this---their @emph{raison d'être} is to
10211 make money off of advertisements, not to provide services to the
10212 community.  Since @code{nnweb} washes the ads off all the articles, one
10213 might think that the providers might be somewhat miffed.  We'll see.
10214
10215 You must have the @code{url} and @code{w3} package installed to be able
10216 to use @code{nnweb}.
10217
10218 Virtual server variables:
10219
10220 @table @code
10221 @item nnweb-type
10222 @vindex nnweb-type
10223 What search engine type is being used.  The currently supported types
10224 are @code{dejanews}, @code{altavista} and @code{reference}.
10225
10226 @item nnweb-search
10227 @vindex nnweb-search
10228 The search string to feed to the search engine.
10229
10230 @item nnweb-max-hits
10231 @vindex nnweb-max-hits
10232 Advisory maximum number of hits per search to display.  The default is
10233 100.
10234
10235 @item nnweb-type-definition
10236 @vindex nnweb-type-definition
10237 Type-to-definition alist.  This alist says what @code{nnweb} should do
10238 with the various search engine types.  The following elements must be
10239 present: 
10240
10241 @table @code
10242 @item article
10243 Function to decode the article and provide something that Gnus
10244 understands. 
10245
10246 @item map
10247 Function to create an article number to message header and URL alist. 
10248
10249 @item search
10250 Function to send the search string to the search engine.
10251
10252 @item address
10253 The address the aforementioned function should send the search string
10254 to. 
10255
10256 @item id
10257 Format string URL to fetch an article by @code{Message-ID}.
10258 @end table
10259
10260 @end table
10261
10262
10263
10264 @node Mail-To-News Gateways
10265 @subsection Mail-To-News Gateways
10266 @cindex mail-to-news gateways
10267 @cindex gateways
10268
10269 If your local @code{nntp} server doesn't allow posting, for some reason
10270 or other, you can post using one of the numerous mail-to-news gateways.
10271 The @code{nngateway} backend provides the interface.
10272
10273 Note that you can't read anything from this backend---it can only be
10274 used to post with.
10275
10276 Server variables:
10277
10278 @table @code
10279 @item nngateway-address 
10280 @vindex nngateway-address 
10281 This is the address of the mail-to-news gateway.
10282
10283 @item nngateway-header-transformation
10284 @vindex nngateway-header-transformation
10285 News headers have often have to be transformed in some odd way or other
10286 for the mail-to-news gateway to accept it.  This variable says what 
10287 transformation should be called, and defaults to
10288 @code{nngateway-simple-header-transformation}.  The function is called
10289 narrowed to the headers to be transformed and with one parameter---the
10290 gateway address.
10291
10292 This default function just inserts a new @code{To} header based on the
10293 @code{Newsgroups} header and the gateway address---an article with this
10294 @code{Newsgroups} header:
10295
10296 @example
10297 Newsgroups: alt.religion.emacs
10298 @end example
10299
10300 will get this @code{From} header inserted:
10301
10302 @example
10303 To: alt-religion-emacs@@GATEWAY
10304 @end example
10305
10306 @end table
10307
10308 So, to use this, simply say something like:
10309
10310 @lisp
10311 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10312 @end lisp
10313
10314
10315 @node Combined Groups
10316 @section Combined Groups
10317
10318 Gnus allows combining a mixture of all the other group types into bigger
10319 groups.
10320
10321 @menu
10322 * Virtual Groups::     Combining articles from many groups.
10323 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10324 @end menu
10325
10326
10327 @node Virtual Groups
10328 @subsection Virtual Groups
10329 @cindex nnvirtual
10330 @cindex virtual groups
10331
10332 An @dfn{nnvirtual group} is really nothing more than a collection of
10333 other groups.
10334
10335 For instance, if you are tired of reading many small group, you can
10336 put them all in one big group, and then grow tired of reading one
10337 big, unwieldy group.  The joys of computing!
10338
10339 You specify @code{nnvirtual} as the method.  The address should be a
10340 regexp to match component groups.
10341
10342 All marks in the virtual group will stick to the articles in the
10343 component groups.  So if you tick an article in a virtual group, the
10344 article will also be ticked in the component group from whence it came.
10345 (And vice versa---marks from the component groups will also be shown in
10346 the virtual group.)
10347
10348 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10349 newsgroups into one, big, happy newsgroup:
10350
10351 @lisp
10352 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10353 @end lisp
10354
10355 The component groups can be native or foreign; everything should work
10356 smoothly, but if your computer explodes, it was probably my fault.
10357
10358 Collecting the same group from several servers might actually be a good
10359 idea if users have set the Distribution header to limit distribution.
10360 If you would like to read @samp{soc.motss} both from a server in Japan
10361 and a server in Norway, you could use the following as the group regexp:
10362
10363 @example
10364 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10365 @end example
10366
10367 This should work kinda smoothly---all articles from both groups should
10368 end up in this one, and there should be no duplicates.  Threading (and
10369 the rest) will still work as usual, but there might be problems with the
10370 sequence of articles.  Sorting on date might be an option here
10371 (@pxref{Selecting a Group}.
10372
10373 One limitation, however---all groups that are included in a virtual
10374 group has to be alive (i.e., subscribed or unsubscribed).  Killed or
10375 zombie groups can't be component groups for @code{nnvirtual} groups.
10376
10377 @vindex nnvirtual-always-rescan
10378 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10379 @code{nnvirtual} will always scan groups for unread articles when
10380 entering a virtual group.  If this variable is @code{nil} (which is the
10381 default) and you read articles in a component group after the virtual
10382 group has been activated, the read articles from the component group
10383 will show up when you enter the virtual group.  You'll also see this
10384 effect if you have two virtual groups that contain the same component
10385 group.  If that's the case, you should set this variable to @code{t}.
10386 Or you can just tap @code{M-g} on the virtual group every time before
10387 you enter it---it'll have much the same effect.
10388
10389
10390 @node Kibozed Groups
10391 @subsection Kibozed Groups
10392 @cindex nnkiboze
10393 @cindex kibozing
10394
10395 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10396 the news feed''.  @code{nnkiboze} is a backend that will do this for
10397 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
10398 with useless requests!  Oh happiness!
10399
10400 @kindex G k (Group)
10401 To create a kibozed group, use the @kbd{G k} command in the group
10402 buffer. 
10403
10404 The address field of the @code{nnkiboze} method is, as with
10405 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10406 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
10407 and @code{nnvirtual} ends.
10408
10409 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10410 must have a score file to say what articles that are to be included in
10411 the group (@pxref{Scoring}).
10412
10413 @kindex M-x nnkiboze-generate-groups
10414 @findex nnkiboze-generate-groups
10415 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10416 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
10417 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
10418 all the articles in all the components groups and run them through the
10419 scoring process to determine if there are any articles in the groups
10420 that are to be part of the @code{nnkiboze} groups.
10421
10422 Please limit the number of component groups by using restrictive
10423 regexps.  Otherwise your sysadmin may become annoyed with you, and the
10424 @sc{nntp} site may throw you off and never let you back in again.
10425 Stranger things have happened.
10426
10427 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10428 and they can be foreign.  No restrictions.
10429
10430 @vindex nnkiboze-directory
10431 The generation of an @code{nnkiboze} group means writing two files in
10432 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
10433 contains the @sc{nov} header lines for all the articles in the group,
10434 and the other is an additional @file{.newsrc} file to store information
10435 on what groups that have been searched through to find component
10436 articles.
10437
10438 Articles that are marked as read in the @code{nnkiboze} group will have their
10439 @sc{nov} lines removed from the @sc{nov} file.
10440
10441
10442 @node Scoring
10443 @chapter Scoring
10444 @cindex scoring
10445
10446 Other people use @dfn{kill files}, but we here at Gnus Towers like
10447 scoring better than killing, so we'd rather switch than fight.  They do
10448 something completely different as well, so sit up straight and pay
10449 attention!
10450
10451 @vindex gnus-summary-mark-below
10452 All articles have a default score (@code{gnus-summary-default-score}),
10453 which is 0 by default.  This score may be raised or lowered either
10454 interactively or by score files.  Articles that have a score lower than
10455 @code{gnus-summary-mark-below} are marked as read.
10456
10457 Gnus will read any @dfn{score files} that apply to the current group
10458 before generating the summary buffer.
10459
10460 There are several commands in the summary buffer that insert score
10461 entries based on the current article.  You can, for instance, ask Gnus to
10462 lower or increase the score of all articles with a certain subject.
10463
10464 There are two sorts of scoring entries: Permanent and temporary.
10465 Temporary score entries are self-expiring entries.  Any entries that are
10466 temporary and have not been used for, say, a week, will be removed
10467 silently to help keep the sizes of the score files down.
10468
10469 @menu 
10470 * Summary Score Commands::   Adding score entries for the current group.
10471 * Group Score Commands::     General score commands.
10472 * Score Variables::          Customize your scoring.  (My, what terminology).
10473 * Score File Format::        What a score file may contain.
10474 * Score File Editing::       You can edit score files by hand as well.
10475 * Adaptive Scoring::         Big Sister Gnus knows what you read.
10476 * Home Score File::          How to say where new score entries are to go.
10477 * Followups To Yourself::    Having Gnus notice when people answer you.
10478 * Scoring Tips::             How to score effectively.
10479 * Reverse Scoring::          That problem child of old is not problem.
10480 * Global Score Files::       Earth-spanning, ear-splitting score files.
10481 * Kill Files::               They are still here, but they can be ignored.
10482 * Converting Kill Files::    Translating kill files to score files.
10483 * GroupLens::                Getting predictions on what you like to read.
10484 * Advanced Scoring::         Using logical expressions to build score rules.
10485 * Score Decays::             It can be useful to let scores wither away.
10486 @end menu
10487
10488
10489 @node Summary Score Commands
10490 @section Summary Score Commands
10491 @cindex score commands
10492
10493 The score commands that alter score entries do not actually modify real
10494 score files.  That would be too inefficient.  Gnus maintains a cache of
10495 previously loaded score files, one of which is considered the
10496 @dfn{current score file alist}.  The score commands simply insert
10497 entries into this list, and upon group exit, this list is saved.
10498
10499 The current score file is by default the group's local score file, even
10500 if no such score file actually exists.  To insert score commands into
10501 some other score file (e.g. @file{all.SCORE}), you must first make this
10502 score file the current one.
10503
10504 General score commands that don't actually change the score file:
10505
10506 @table @kbd
10507
10508 @item V s
10509 @kindex V s (Summary)
10510 @findex gnus-summary-set-score
10511 Set the score of the current article (@code{gnus-summary-set-score}).  
10512
10513 @item V S
10514 @kindex V S (Summary)
10515 @findex gnus-summary-current-score
10516 Display the score of the current article
10517 (@code{gnus-summary-current-score}).   
10518
10519 @item V t
10520 @kindex V t (Summary)
10521 @findex gnus-score-find-trace
10522 Display all score rules that have been used on the current article
10523 (@code{gnus-score-find-trace}).   
10524
10525 @item V R
10526 @kindex V R (Summary)
10527 @findex gnus-summary-rescore
10528 Run the current summary through the scoring process
10529 (@code{gnus-summary-rescore}).  This might be useful if you're playing
10530 around with your score files behind Gnus' back and want to see the
10531 effect you're having.
10532
10533 @item V a
10534 @kindex V a (Summary)
10535 @findex gnus-summary-score-entry
10536 Add a new score entry, and allow specifying all elements 
10537 (@code{gnus-summary-score-entry}).
10538
10539 @item V c
10540 @kindex V c (Summary)
10541 @findex gnus-score-change-score-file
10542 Make a different score file the current
10543 (@code{gnus-score-change-score-file}). 
10544
10545 @item V e
10546 @kindex V e (Summary)
10547 @findex gnus-score-edit-current-scores
10548 Edit the current score file (@code{gnus-score-edit-current-scores}).
10549 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10550 File Editing}).
10551
10552 @item V f
10553 @kindex V f (Summary)
10554 @findex gnus-score-edit-file
10555 Edit a score file and make this score file the current one
10556 (@code{gnus-score-edit-file}).
10557
10558 @item V F
10559 @kindex V F (Summary)
10560 @findex gnus-score-flush-cache
10561 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
10562 after editing score files.
10563
10564 @item V C
10565 @kindex V C (Summary)
10566 @findex gnus-score-customize
10567 Customize a score file in a visually pleasing manner
10568 (@code{gnus-score-customize}). 
10569
10570 @item I C-i
10571 @kindex I C-i (Summary)
10572 @findex gnus-summary-raise-score
10573 Increase the score of the current article
10574 (@code{gnus-summary-raise-score}).
10575
10576 @item L C-l
10577 @kindex L C-l (Summary)
10578 @findex gnus-summary-lower-score
10579 Lower the score of the current article
10580 (@code{gnus-summary-lower-score}). 
10581 @end table
10582
10583 The rest of these commands modify the local score file.
10584
10585 @table @kbd
10586
10587 @item V m
10588 @kindex V m (Summary)
10589 @findex gnus-score-set-mark-below
10590 Prompt for a score, and mark all articles with a score below this as
10591 read (@code{gnus-score-set-mark-below}).
10592
10593 @item V x
10594 @kindex V x (Summary)
10595 @findex gnus-score-set-expunge-below
10596 Prompt for a score, and add a score rule to the current score file to
10597 expunge all articles below this score
10598 (@code{gnus-score-set-expunge-below}).
10599 @end table
10600
10601 The keystrokes for actually making score entries follow a very regular
10602 pattern, so there's no need to list all the commands.  (Hundreds of
10603 them.)  
10604
10605 @enumerate
10606 @item
10607 The first key is either @kbd{I} (upper case i) for increasing the score
10608 or @kbd{L} for lowering the score. 
10609 @item
10610 The second key says what header you want to score on.  The following
10611 keys are available:
10612 @table @kbd
10613
10614 @item a
10615 Score on the author name.
10616
10617 @item s
10618 Score on the subject line.
10619
10620 @item x
10621 Score on the Xref line---i.e., the cross-posting line.
10622
10623 @item t
10624 Score on thread---the References line.
10625
10626 @item d
10627 Score on the date.
10628
10629 @item l
10630 Score on the number of lines.
10631
10632 @item i
10633 Score on the Message-ID.
10634
10635 @item f
10636 Score on followups.
10637
10638 @item b
10639 Score on the body.
10640
10641 @item h
10642 Score on the head.
10643 @end table
10644
10645 @item
10646 The third key is the match type.  Which match types are legal depends on
10647 what headers you are scoring on.
10648
10649 @table @code
10650
10651 @item strings 
10652
10653 @table @kbd
10654
10655 @item e
10656 Exact matching.
10657
10658 @item s
10659 Substring matching.
10660
10661 @item f
10662 Fuzzy matching (@pxref{Fuzzy Matching}).
10663
10664 @item r
10665 Regexp matching
10666 @end table
10667
10668 @item date
10669 @table @kbd
10670
10671 @item b
10672 Before date.
10673
10674 @item a
10675 At date.
10676
10677 @item n
10678 This date.
10679 @end table
10680
10681 @item number
10682 @table @kbd
10683
10684 @item <
10685 Less than number.
10686
10687 @item =
10688 Equal to number.
10689
10690 @item >
10691 Greater than number.
10692 @end table
10693 @end table
10694
10695 @item 
10696 The fourth and final key says whether this is a temporary (i.e., expiring)
10697 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10698 it is to be done immediately, without adding to the score file.
10699 @table @kbd
10700
10701 @item t
10702 Temporary score entry.
10703
10704 @item p
10705 Permanent score entry.
10706
10707 @item i
10708 Immediately scoring.
10709 @end table
10710
10711 @end enumerate
10712
10713 So, let's say you want to increase the score on the current author with
10714 exact matching permanently: @kbd{I a e p}.  If you want to lower the
10715 score based on the subject line, using substring matching, and make a
10716 temporary score entry: @kbd{L s s t}.  Pretty easy.
10717
10718 To make things a bit more complicated, there are shortcuts.  If you use
10719 a capital letter on either the second or third keys, Gnus will use
10720 defaults for the remaining one or two keystrokes.  The defaults are
10721 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
10722 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10723
10724 @vindex gnus-score-mimic-keymap
10725 The @code{gnus-score-mimic-keymap} says whether these commands will
10726 pretend they are keymaps or not.
10727
10728
10729 @node Group Score Commands
10730 @section Group Score Commands
10731 @cindex group score commands
10732
10733 There aren't many of these as yet, I'm afraid.
10734
10735 @table @kbd
10736
10737 @item W f
10738 @kindex W f (Group)
10739 @findex gnus-score-flush-cache
10740 Gnus maintains a cache of score alists to avoid having to reload them
10741 all the time.  This command will flush the cache
10742 (@code{gnus-score-flush-cache}). 
10743
10744 @end table
10745
10746
10747 @node Score Variables
10748 @section Score Variables
10749 @cindex score variables
10750
10751 @table @code
10752
10753 @item gnus-use-scoring
10754 @vindex gnus-use-scoring
10755 If @code{nil}, Gnus will not check for score files, and will not, in
10756 general, do any score-related work.  This is @code{t} by default.
10757
10758 @item gnus-kill-killed
10759 @vindex gnus-kill-killed
10760 If this variable is @code{nil}, Gnus will never apply score files to
10761 articles that have already been through the kill process.  While this
10762 may save you lots of time, it also means that if you apply a kill file
10763 to a group, and then change the kill file and want to run it over you
10764 group again to kill more articles, it won't work.  You have to set this
10765 variable to @code{t} to do that.  (It is @code{t} by default.)
10766
10767 @item gnus-kill-files-directory
10768 @vindex gnus-kill-files-directory
10769 All kill and score files will be stored in this directory, which is
10770 initialized from the @code{SAVEDIR} environment variable by default.
10771 This is @file{~/News/} by default.
10772
10773 @item gnus-score-file-suffix
10774 @vindex gnus-score-file-suffix
10775 Suffix to add to the group name to arrive at the score file name
10776 (@samp{SCORE} by default.)
10777
10778 @item gnus-score-uncacheable-files
10779 @vindex gnus-score-uncacheable-files
10780 @cindex score cache
10781 All score files are normally cached to avoid excessive re-loading of
10782 score files.  However, if this might make you Emacs grow big and
10783 bloated, so this regexp can be used to weed out score files that are
10784 unlikely to be needed again.  It would be a bad idea to deny caching of
10785 @file{all.SCORE}, while it might be a good idea to not cache
10786 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
10787 variable is @samp{ADAPT$} by default, so no adaptive score files will
10788 be cached.
10789
10790 @item gnus-save-score
10791 @vindex gnus-save-score
10792 If you have really complicated score files, and do lots of batch
10793 scoring, then you might set this variable to @code{t}.  This will make
10794 Gnus save the scores into the @file{.newsrc.eld} file.
10795
10796 @item gnus-score-interactive-default-score
10797 @vindex gnus-score-interactive-default-score
10798 Score used by all the interactive raise/lower commands to raise/lower
10799 score with.  Default is 1000, which may seem excessive, but this is to
10800 ensure that the adaptive scoring scheme gets enough room to play with.
10801 We don't want the small changes from the adaptive scoring to overwrite
10802 manually entered data.
10803
10804 @item gnus-summary-default-score
10805 @vindex gnus-summary-default-score
10806 Default score of an article, which is 0 by default.
10807
10808 @item gnus-summary-expunge-below
10809 @vindex gnus-summary-expunge-below
10810 Don't display the summary lines of articles that have scores lower than
10811 this variable.  This is @code{nil} by default, which means that no
10812 articles will be hidden.
10813
10814 @item gnus-score-over-mark
10815 @vindex gnus-score-over-mark
10816 Mark (in the third column) used for articles with a score over the
10817 default.  Default is @samp{+}.
10818
10819 @item gnus-score-below-mark
10820 @vindex gnus-score-below-mark
10821 Mark (in the third column) used for articles with a score below the
10822 default.  Default is @samp{-}.
10823
10824 @item gnus-score-find-score-files-function
10825 @vindex gnus-score-find-score-files-function
10826 Function used to find score files for the current group.  This function
10827 is called with the name of the group as the argument. 
10828
10829 Predefined functions available are:
10830 @table @code
10831
10832 @item gnus-score-find-single
10833 @findex gnus-score-find-single
10834 Only apply the group's own score file.
10835
10836 @item gnus-score-find-bnews
10837 @findex gnus-score-find-bnews
10838 Apply all score files that match, using bnews syntax.  This is the
10839 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
10840 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10841 @file{gnu.all.SCORE} would all apply.  In short, the instances of
10842 @samp{all} in the score file names are translated into @samp{.*}, and
10843 then a regexp match is done.
10844
10845 This means that if you have some score entries that you want to apply to
10846 all groups, then you put those entries in the @file{all.SCORE} file. 
10847
10848 The score files are applied in a semi-random order, although Gnus will
10849 try to apply the more general score files before the more specific score
10850 files.  It does this by looking at the number of elements in the score
10851 file names---discarding the @samp{all} elements.
10852
10853 @item gnus-score-find-hierarchical
10854 @findex gnus-score-find-hierarchical
10855 Apply all score files from all the parent groups.  This means that you
10856 can't have score files like @file{all.SCORE}, but you can have
10857 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10858
10859 @end table
10860 This variable can also be a list of functions.  In that case, all these
10861 functions will be called, and all the returned lists of score files will
10862 be applied.  These functions can also return lists of score alists
10863 directly.  In that case, the functions that return these non-file score
10864 alists should probably be placed before the ``real'' score file
10865 functions, to ensure that the last score file returned is the local
10866 score file.  Phu.
10867
10868 @item gnus-score-expiry-days
10869 @vindex gnus-score-expiry-days
10870 This variable says how many days should pass before an unused score file
10871 entry is expired.  If this variable is @code{nil}, no score file entries
10872 are expired.  It's 7 by default.
10873
10874 @item gnus-update-score-entry-dates
10875 @vindex gnus-update-score-entry-dates
10876 If this variable is non-@code{nil}, matching score entries will have
10877 their dates updated.  (This is how Gnus controls expiry---all
10878 non-matching entries will become too old while matching entries will
10879 stay fresh and young.)  However, if you set this variable to @code{nil},
10880 even matching entries will grow old and will have to face that oh-so
10881 grim reaper.  
10882
10883 @item gnus-score-after-write-file-function
10884 @vindex gnus-score-after-write-file-function
10885 Function called with the name of the score file just written.
10886
10887 @end table
10888
10889
10890 @node Score File Format
10891 @section Score File Format
10892 @cindex score file format
10893
10894 A score file is an @code{emacs-lisp} file that normally contains just a
10895 single form.  Casual users are not expected to edit these files;
10896 everything can be changed from the summary buffer.
10897
10898 Anyway, if you'd like to dig into it yourself, here's an example:
10899
10900 @lisp
10901 (("from"
10902   ("Lars Ingebrigtsen" -10000)
10903   ("Per Abrahamsen")
10904   ("larsi\\|lmi" -50000 nil R))
10905  ("subject"
10906   ("Ding is Badd" nil 728373))
10907  ("xref"
10908   ("alt.politics" -1000 728372 s))
10909  ("lines"
10910   (2 -100 nil <))
10911  (mark 0)
10912  (expunge -1000)
10913  (mark-and-expunge -10)
10914  (read-only nil)
10915  (orphan -10)
10916  (adapt t)
10917  (files "/hom/larsi/News/gnu.SCORE")
10918  (exclude-files "all.SCORE")
10919  (local (gnus-newsgroup-auto-expire t)
10920         (gnus-summary-make-false-root 'empty))
10921  (eval (ding)))
10922 @end lisp
10923
10924 This example demonstrates absolutely everything about a score file. 
10925
10926 Even though this looks much like lisp code, nothing here is actually
10927 @code{eval}ed.  The lisp reader is used to read this form, though, so it
10928 has to be legal syntactically, if not semantically.
10929
10930 Six keys are supported by this alist:
10931
10932 @table @code
10933
10934 @item STRING
10935 If the key is a string, it is the name of the header to perform the
10936 match on.  Scoring can only be performed on these eight headers:
10937 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
10938 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
10939 these headers, there are three strings to tell Gnus to fetch the entire
10940 article and do the match on larger parts of the article: @code{Body}
10941 will perform the match on the body of the article, @code{Head} will
10942 perform the match on the head of the article, and @code{All} will
10943 perform the match on the entire article.  Note that using any of these
10944 last three keys will slow down group entry @emph{considerably}.  The
10945 final ``header'' you can score on is @code{Followup}.  These score
10946 entries will result in new score entries being added for all follow-ups
10947 to articles that matches these score entries.
10948
10949 Following this key is a arbitrary number of score entries, where each
10950 score entry has one to four elements.
10951 @enumerate
10952
10953 @item 
10954 The first element is the @dfn{match element}.  On most headers this will
10955 be a string, but on the Lines and Chars headers, this must be an
10956 integer. 
10957
10958 @item 
10959 If the second element is present, it should be a number---the @dfn{score
10960 element}.  This number should be an integer in the neginf to posinf
10961 interval.  This number is added to the score of the article if the match
10962 is successful.  If this element is not present, the
10963 @code{gnus-score-interactive-default-score} number will be used
10964 instead.  This is 1000 by default.
10965
10966 @item 
10967 If the third element is present, it should be a number---the @dfn{date
10968 element}.  This date says when the last time this score entry matched,
10969 which provides a mechanism for expiring the score entries.  It this
10970 element is not present, the score entry is permanent.  The date is
10971 represented by the number of days since December 31, 1 BCE.
10972
10973 @item 
10974 If the fourth element is present, it should be a symbol---the @dfn{type
10975 element}.  This element specifies what function should be used to see
10976 whether this score entry matches the article.  What match types that can
10977 be used depends on what header you wish to perform the match on.
10978 @table @dfn
10979
10980 @item From, Subject, References, Xref, Message-ID
10981 For most header types, there are the @code{r} and @code{R} (regexp), as
10982 well as @code{s} and @code{S} (substring) types, and @code{e} and
10983 @code{E} (exact match), and @code{w} (word match) types.  If this
10984 element is not present, Gnus will assume that substring matching should
10985 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
10986 that the matches will be done in a case-sensitive manner.  All these
10987 one-letter types are really just abbreviations for the @code{regexp},
10988 @code{string}, @code{exact}, and @code{word} types, which you can use
10989 instead, if you feel like.
10990
10991 @item Lines, Chars
10992 These two headers use different match types: @code{<}, @code{>},
10993 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
10994 careful because some backends (like @code{nndir}) do not generate
10995 @code{Lines} header, so every article ends up being marked as having 0
10996 lines.  This can lead to strange results if you happen to lower score of
10997 the articles with few lines.
10998
10999 @item Date
11000 For the Date header we have three kinda silly match types:
11001 @code{before}, @code{at} and @code{after}.  I can't really imagine this
11002 ever being useful, but, like, it would feel kinda silly not to provide
11003 this function.  Just in case.  You never know.  Better safe than sorry.
11004 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
11005 sex on a first date.  (I have been told that at least one person, and I
11006 quote, ``found this function indispensable'', however.)
11007
11008 @cindex ISO8601
11009 @cindex date
11010 A more useful match type is @code{regexp}.  With it, you can match the
11011 date string using a regular expression.  The date is normalized to
11012 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}.  If you want to
11013 match all articles that have been posted on April 1st in every year, you
11014 could use @samp{....0401.........} as a match string, for instance.
11015 (Note that the date is kept in its original time zone, so this will
11016 match articles that were posted when it was April 1st where the article
11017 was posted from.  Time zones are such wholesome fun for the whole
11018 family, eh?)
11019
11020 @item Head, Body, All
11021 These three match keys use the same match types as the @code{From} (etc)
11022 header uses.
11023
11024 @item Followup
11025 This match key is somewhat special, in that it will match the
11026 @code{From} header, and affect the score of not only the matching
11027 articles, but also all followups to the matching articles.  This allows
11028 you e.g. increase the score of followups to your own articles, or
11029 decrease the score of followups to the articles of some known
11030 trouble-maker.  Uses the same match types as the @code{From} header
11031 uses.
11032
11033 @item Thread
11034 This match key works along the same lines as the @code{Followup} match
11035 key.  If you say that you want to score on a (sub-)thread that is
11036 started by an article with a @code{Message-ID} @var{X}, then you add a
11037 @samp{thread} match.  This will add a new @samp{thread} match for each
11038 article that has @var{X} in its @code{References} header.  (These new
11039 @samp{thread} matches will use the @code{Message-ID}s of these matching
11040 articles.)  This will ensure that you can raise/lower the score of an
11041 entire thread, even though some articles in the thread may not have
11042 complete @code{References} headers.  Note that using this may lead to
11043 undeterministic scores of the articles in the thread.
11044 @end table
11045 @end enumerate
11046
11047 @item mark
11048 The value of this entry should be a number.  Any articles with a score
11049 lower than this number will be marked as read.
11050
11051 @item expunge
11052 The value of this entry should be a number.  Any articles with a score
11053 lower than this number will be removed from the summary buffer.
11054
11055 @item mark-and-expunge
11056 The value of this entry should be a number.  Any articles with a score
11057 lower than this number will be marked as read and removed from the
11058 summary buffer.
11059
11060 @item thread-mark-and-expunge
11061 The value of this entry should be a number.  All articles that belong to
11062 a thread that has a total score below this number will be marked as read
11063 and removed from the summary buffer.  @code{gnus-thread-score-function}
11064 says how to compute the total score for a thread.
11065
11066 @item files
11067 The value of this entry should be any number of file names.  These files
11068 are assumed to be score files as well, and will be loaded the same way
11069 this one was.
11070
11071 @item exclude-files
11072 The clue of this entry should be any number of files.  These files will
11073 not be loaded, even though they would normally be so, for some reason or
11074 other. 
11075
11076 @item eval
11077 The value of this entry will be @code{eval}el.  This element will be
11078 ignored when handling global score files. 
11079
11080 @item read-only
11081 Read-only score files will not be updated or saved.  Global score files
11082 should feature this atom (@pxref{Global Score Files}).
11083
11084 @item orphan
11085 The value of this entry should be a number.  Articles that do not have
11086 parents will get this number added to their scores.  Imagine you follow
11087 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
11088 will only follow a few of the threads, also want to see any new threads.
11089
11090 You can do this with the following two score file entries:
11091
11092 @example
11093         (orphan -500)
11094         (mark-and-expunge -100)
11095 @end example
11096
11097 When you enter the group the first time, you will only see the new
11098 threads.  You then raise the score of the threads that you find
11099 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11100 rest.  Next time you enter the group, you will see new articles in the
11101 interesting threads, plus any new threads.
11102
11103 I.e.---the orphan score atom is for high-volume groups where there
11104 exist a few interesting threads which can't be found automatically by
11105 ordinary scoring rules.
11106
11107 @item adapt
11108 This entry controls the adaptive scoring.  If it is @code{t}, the
11109 default adaptive scoring rules will be used.  If it is @code{ignore}, no
11110 adaptive scoring will be performed on this group.  If it is a list, this
11111 list will be used as the adaptive scoring rules.  If it isn't present,
11112 or is something other than @code{t} or @code{ignore}, the default
11113 adaptive scoring rules will be used.  If you want to use adaptive
11114 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11115 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11116 not want adaptive scoring.  If you only want adaptive scoring in a few
11117 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11118 insert @code{(adapt t)} in the score files of the groups where you want
11119 it. 
11120
11121 @item adapt-file
11122 All adaptive score entries will go to the file named by this entry.  It
11123 will also be applied when entering the group.  This atom might be handy
11124 if you want to adapt on several groups at once, using the same adaptive
11125 file for a number of groups.
11126
11127 @item local
11128 @cindex local variables
11129 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11130 Each @var{var} will be made buffer-local to the current summary buffer,
11131 and set to the value specified.  This is a convenient, if somewhat
11132 strange, way of setting variables in some groups if you don't like hooks
11133 much.
11134 @end table
11135
11136
11137 @node Score File Editing
11138 @section Score File Editing
11139
11140 You normally enter all scoring commands from the summary buffer, but you
11141 might feel the urge to edit them by hand as well, so we've supplied you
11142 with a mode for that.  
11143
11144 It's simply a slightly customized @code{emacs-lisp} mode, with these
11145 additional commands:
11146
11147 @table @kbd
11148
11149 @item C-c C-c
11150 @kindex C-c C-c (Score)
11151 @findex gnus-score-edit-done
11152 Save the changes you have made and return to the summary buffer
11153 (@code{gnus-score-edit-done}). 
11154
11155 @item C-c C-d
11156 @kindex C-c C-d (Score)
11157 @findex gnus-score-edit-insert-date
11158 Insert the current date in numerical format
11159 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
11160 you were wondering.
11161
11162 @item C-c C-p
11163 @kindex C-c C-p (Score)
11164 @findex gnus-score-pretty-print
11165 The adaptive score files are saved in an unformatted fashion.  If you
11166 intend to read one of these files, you want to @dfn{pretty print} it
11167 first.  This command (@code{gnus-score-pretty-print}) does that for
11168 you. 
11169
11170 @end table
11171
11172 Type @kbd{M-x gnus-score-mode} to use this mode.
11173
11174 @vindex gnus-score-mode-hook
11175 @code{gnus-score-menu-hook} is run in score mode buffers.
11176
11177 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11178 e} to begin editing score files.
11179
11180
11181 @node Adaptive Scoring
11182 @section Adaptive Scoring
11183 @cindex adaptive scoring
11184
11185 If all this scoring is getting you down, Gnus has a way of making it all
11186 happen automatically---as if by magic.  Or rather, as if by artificial
11187 stupidity, to be precise.
11188
11189 @vindex gnus-use-adaptive-scoring
11190 When you read an article, or mark an article as read, or kill an
11191 article, you leave marks behind.  On exit from the group, Gnus can sniff
11192 these marks and add score elements depending on what marks it finds.
11193 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11194 @code{t} or @code{(line)}.  If you want score adaptively on separate
11195 words appearing in the subjects, you should set this variable to
11196 @code{(word)}.  If you want to use both adaptive methods, set this
11197 variable to @code{(word line)}.
11198
11199 @vindex gnus-default-adaptive-score-alist
11200 To give you complete control over the scoring process, you can customize
11201 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
11202 might look something like this:
11203
11204 @lisp
11205 (defvar gnus-default-adaptive-score-alist
11206   '((gnus-unread-mark)
11207     (gnus-ticked-mark (from 4))
11208     (gnus-dormant-mark (from 5))
11209     (gnus-del-mark (from -4) (subject -1))
11210     (gnus-read-mark (from 4) (subject 2))
11211     (gnus-expirable-mark (from -1) (subject -1))
11212     (gnus-killed-mark (from -1) (subject -3))
11213     (gnus-kill-file-mark)
11214     (gnus-ancient-mark)
11215     (gnus-low-score-mark)
11216     (gnus-catchup-mark (from -1) (subject -1))))
11217 @end lisp
11218
11219 As you see, each element in this alist has a mark as a key (either a
11220 variable name or a ``real'' mark---a character).  Following this key is
11221 a arbitrary number of header/score pairs.  If there are no header/score
11222 pairs following the key, no adaptive scoring will be done on articles
11223 that have that key as the article mark.  For instance, articles with
11224 @code{gnus-unread-mark} in the example above will not get adaptive score
11225 entries.
11226
11227 Each article can have only one mark, so just a single of these rules
11228 will be applied to each article.
11229
11230 To take @code{gnus-del-mark} as an example---this alist says that all
11231 articles that have that mark (i.e., are marked with @samp{D}) will have a
11232 score entry added to lower based on the @code{From} header by -4, and
11233 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
11234
11235 If you have marked 10 articles with the same subject with
11236 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11237 That means that that subject will get a score of ten times -1, which
11238 should be, unless I'm much mistaken, -10.
11239
11240 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11241 the read articles will be marked with the @samp{E} mark.  This'll
11242 probably make adaptive scoring slightly impossible, so auto-expiring and
11243 adaptive scoring doesn't really mix very well.
11244
11245 The headers you can score on are @code{from}, @code{subject},
11246 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11247 @code{chars} and @code{date}.  In addition, you can score on
11248 @code{followup}, which will create an adaptive score entry that matches
11249 on the @code{References} header using the @code{Message-ID} of the
11250 current article, thereby matching the following thread.  
11251
11252 You can also score on @code{thread}, which will try to score all
11253 articles that appear in a thread.  @code{thread} matches uses a
11254 @code{Message-ID} to match on the @code{References} header of the
11255 article.  If the match is made, the @code{Message-ID} of the article is
11256 added to the @code{thread} rule.  (Think about it.  I'd recommend two
11257 aspirins afterwards.)
11258
11259 If you use this scheme, you should set the score file atom @code{mark}
11260 to something small---like -300, perhaps, to avoid having small random
11261 changes result in articles getting marked as read.
11262
11263 After using adaptive scoring for a week or so, Gnus should start to
11264 become properly trained and enhance the authors you like best, and kill
11265 the authors you like least, without you having to say so explicitly. 
11266
11267 You can control what groups the adaptive scoring is to be performed on
11268 by using the score files (@pxref{Score File Format}).  This will also
11269 let you use different rules in different groups.
11270
11271 @vindex gnus-adaptive-file-suffix
11272 The adaptive score entries will be put into a file where the name is the
11273 group name with @code{gnus-adaptive-file-suffix} appended.  The default
11274 is @samp{ADAPT}.
11275
11276 @vindex gnus-score-exact-adapt-limit
11277 When doing adaptive scoring, substring or fuzzy matching would probably
11278 give you the best results in most cases.  However, if the header one
11279 matches is short, the possibility for false positives is great, so if
11280 the length of the match is less than
11281 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
11282 this variable is @code{nil}, exact matching will always be used to avoid
11283 this problem.
11284
11285 @vindex gnus-default-adaptive-word-score-alist
11286 As mentioned above, you can adapt either on individual words or entire
11287 headers.  If you adapt on words, the
11288 @code{gnus-default-adaptive-word-score-alist} variable says what score
11289 each instance of a word should add given a mark.
11290
11291 @lisp
11292 (setq gnus-default-adaptive-word-score-alist  
11293       `((,gnus-read-mark . 30)
11294         (,gnus-catchup-mark . -10)
11295         (,gnus-killed-mark . -20)
11296         (,gnus-del-mark . -15)))
11297 @end lisp
11298
11299 This is the default value.  If you have adaption on words enabled, every
11300 word that appears in subjects of articles that are marked with
11301 @code{gnus-read-mark} will result in a score rule that increase the
11302 score with 30 points.
11303
11304 @vindex gnus-default-ignored-adaptive-words
11305 @vindex gnus-ignored-adaptive-words
11306 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11307 will be ignored.  If you wish to add more words to be ignored, use the
11308 @code{gnus-ignored-adaptive-words} list instead.
11309
11310 @vindex gnus-adaptive-word-syntax-table
11311 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11312 syntax table in effect.  It is similar to the standard syntax table, but
11313 it considers numbers to be non-word-constituent characters.
11314
11315 After using this scheme for a while, it might be nice to write a
11316 @code{gnus-psychoanalyze-user} command to go through the rules and see
11317 what words you like and what words you don't like.  Or perhaps not.
11318
11319 Note that the adaptive word scoring thing is highly experimental and is
11320 likely to change in the future.  Initial impressions seem to indicate
11321 that it's totally useless as it stands.  Some more work (involving more
11322 rigorous statistical methods) will have to be done to make this useful. 
11323
11324
11325 @node Home Score File
11326 @section Home Score File
11327
11328 The score file where new score file entries will go is called the
11329 @dfn{home score file}.  This is normally (and by default) the score file
11330 for the group itself.  For instance, the home score file for
11331 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11332
11333 However, this may not be what you want.  It is often convenient to share
11334 a common home score file among many groups---all @samp{emacs} groups
11335 could perhaps use the same home score file.
11336
11337 @vindex gnus-home-score-file
11338 The variable that controls this is @code{gnus-home-score-file}.  It can
11339 be:
11340
11341 @enumerate
11342 @item
11343 A string.  Then this file will be used as the home score file for all
11344 groups. 
11345
11346 @item
11347 A function. The result of this function will be used as the home score
11348 file.  The function will be called with the name of the group as the
11349 parameter. 
11350
11351 @item
11352 A list.  The elements in this list can be:
11353
11354 @enumerate
11355 @item 
11356 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
11357 the @var{file-name} will will be used as the home score file.
11358
11359 @item 
11360 A function. If the function returns non-nil, the result will be used as
11361 the home score file.
11362
11363 @item 
11364 A string.  Use the string as the home score file.
11365 @end enumerate
11366
11367 The list will be traversed from the beginning towards the end looking
11368 for matches.
11369
11370 @end enumerate
11371
11372 So, if you want to use just a single score file, you could say:
11373
11374 @lisp
11375 (setq gnus-home-score-file
11376       "my-total-score-file.SCORE")
11377 @end lisp
11378
11379 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11380 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11381
11382 @lisp
11383 (setq gnus-home-score-file
11384       'gnus-hierarchial-home-score-file)
11385 @end lisp
11386
11387 This is a ready-made function provided for your convenience.
11388
11389 If you want to have one score file for the @samp{emacs} groups and
11390 another for the @samp{comp} groups, while letting all other groups use
11391 their own home score files:
11392
11393 @lisp
11394 (setq gnus-home-score-file
11395       ;; All groups that match the regexp "\\.emacs"
11396       '("\\.emacs" "emacs.SCORE")
11397       ;; All the comp groups in one score file
11398        ("^comp" "comp.SCORE"))
11399 @end lisp
11400    
11401 @vindex gnus-home-adapt-file
11402 @code{gnus-home-adapt-file} works exactly the same way as
11403 @code{gnus-home-score-file}, but says what the home adaptive score file
11404 is instead.  All new adaptive file entries will go into the file
11405 specified by this variable, and the same syntax is allowed.
11406
11407 In addition to using @code{gnus-home-score-file} and
11408 @code{gnus-home-adapt-file}, you can also use group parameters
11409 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11410 Parameters}) to achieve much the same.  Group and topic parameters take
11411 precedence over this variable.
11412
11413
11414 @node Followups To Yourself
11415 @section Followups To Yourself
11416
11417 Gnus offers two commands for picking out the @code{Message-ID} header in
11418 the current buffer.  Gnus will then add a score rule that scores using
11419 this @code{Message-ID} on the @code{References} header of other
11420 articles.  This will, in effect, increase the score of all articles that
11421 respond to the article in the current buffer.  Quite useful if you want
11422 to easily note when people answer what you've said.
11423
11424 @table @code
11425
11426 @item gnus-score-followup-article
11427 @findex gnus-score-followup-article
11428 This will add a score to articles that directly follow up your own
11429 article. 
11430
11431 @item gnus-score-followup-thread
11432 @findex gnus-score-followup-thread
11433 This will add a score to all articles that appear in a thread ``below''
11434 your own article.
11435 @end table
11436
11437 @vindex message-sent-hook
11438 These two functions are both primarily meant to be used in hooks like
11439 @code{message-sent-hook}.  
11440
11441 If you look closely at your own @code{Message-ID}, you'll notice that
11442 the first two or three characters are always the same.  Here's two of
11443 mine:  
11444
11445 @example
11446 <x6u3u47icf.fsf@@eyesore.no>
11447 <x6sp9o7ibw.fsf@@eyesore.no>
11448 @end example
11449
11450 So ``my'' ident on this machine is @samp{x6}.  This can be
11451 exploited---the following rule will raise the score on all followups to
11452 myself: 
11453
11454 @lisp
11455 ("references"
11456  ("<x6[0-9a-z]+\\.fsf@@.*eyesore.no>" 1000 nil r))
11457 @end lisp
11458
11459 Whether it's the first two or first three characters that are ``yours''
11460 is system-dependent.
11461
11462
11463 @node Scoring Tips
11464 @section Scoring Tips
11465 @cindex scoring tips
11466
11467 @table @dfn
11468
11469 @item Crossposts
11470 @cindex crossposts
11471 @cindex scoring crossposts
11472 If you want to lower the score of crossposts, the line to match on is
11473 the @code{Xref} header.
11474 @lisp
11475 ("xref" (" talk.politics.misc:" -1000))
11476 @end lisp
11477
11478 @item Multiple crossposts
11479 If you want to lower the score of articles that have been crossposted to
11480 more than, say, 3 groups:
11481 @lisp
11482 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11483 @end lisp
11484
11485 @item Matching on the body
11486 This is generally not a very good idea---it takes a very long time.
11487 Gnus actually has to fetch each individual article from the server.  But
11488 you might want to anyway, I guess.  Even though there are three match
11489 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11490 and stick with it in each score file.  If you use any two, each article
11491 will be fetched @emph{twice}.  If you want to match a bit on the
11492 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11493 the matches.  
11494
11495 @item Marking as read
11496 You will probably want to mark articles that has a score below a certain
11497 number as read.  This is most easily achieved by putting the following
11498 in your @file{all.SCORE} file:
11499 @lisp
11500 ((mark -100))
11501 @end lisp
11502 You may also consider doing something similar with @code{expunge}.  
11503
11504 @item Negated character classes
11505 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11506 That will match newlines, which might lead to, well, The Unknown.  Say
11507 @code{[^abcd\n]*} instead.
11508 @end table
11509
11510
11511 @node Reverse Scoring
11512 @section Reverse Scoring
11513 @cindex reverse scoring
11514
11515 If you want to keep just articles that have @samp{Sex with Emacs} in the
11516 subject header, and expunge all other articles, you could put something
11517 like this in your score file:
11518
11519 @lisp
11520 (("subject"
11521   ("Sex with Emacs" 2))
11522  (mark 1)
11523  (expunge 1))
11524 @end lisp
11525
11526 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11527 rest as read, and expunge them to boot.
11528
11529
11530 @node Global Score Files
11531 @section Global Score Files
11532 @cindex global score files
11533
11534 Sure, other newsreaders have ``global kill files''.  These are usually
11535 nothing more than a single kill file that applies to all groups, stored
11536 in the user's home directory.  Bah!  Puny, weak newsreaders!
11537
11538 What I'm talking about here are Global Score Files.  Score files from
11539 all over the world, from users everywhere, uniting all nations in one
11540 big, happy score file union!  Ange-score!  New and untested!
11541
11542 @vindex gnus-global-score-files
11543 All you have to do to use other people's score files is to set the
11544 @code{gnus-global-score-files} variable.  One entry for each score file,
11545 or each score file directory.  Gnus will decide by itself what score
11546 files are applicable to which group.
11547
11548 Say you want to use the score file
11549 @file{/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE} and
11550 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11551
11552 @lisp
11553 (setq gnus-global-score-files
11554       '("/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
11555         "/ftp@@ftp.some-where:/pub/score/"))
11556 @end lisp
11557
11558 @findex gnus-score-search-global-directories
11559 Simple, eh?  Directory names must end with a @samp{/}.  These
11560 directories are typically scanned only once during each Gnus session.
11561 If you feel the need to manually re-scan the remote directories, you can
11562 use the @code{gnus-score-search-global-directories} command.
11563
11564 Note that, at present, using this option will slow down group entry
11565 somewhat.  (That is---a lot.)
11566
11567 If you want to start maintaining score files for other people to use,
11568 just put your score file up for anonymous ftp and announce it to the
11569 world.  Become a retro-moderator!  Participate in the retro-moderator
11570 wars sure to ensue, where retro-moderators battle it out for the
11571 sympathy of the people, luring them to use their score files on false
11572 premises!  Yay!  The net is saved!
11573
11574 Here are some tips for the would-be retro-moderator, off the top of my
11575 head: 
11576
11577 @itemize @bullet
11578
11579 @item 
11580 Articles that are heavily crossposted are probably junk. 
11581 @item
11582 To lower a single inappropriate article, lower by @code{Message-ID}.
11583 @item
11584 Particularly brilliant authors can be raised on a permanent basis. 
11585 @item
11586 Authors that repeatedly post off-charter for the group can safely be
11587 lowered out of existence.
11588 @item
11589 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11590 articles completely.
11591
11592 @item 
11593 Use expiring score entries to keep the size of the file down.  You
11594 should probably have a long expiry period, though, as some sites keep
11595 old articles for a long time.
11596 @end itemize
11597
11598 ... I wonder whether other newsreaders will support global score files
11599 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
11600 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
11601 holding our breath yet?
11602
11603
11604 @node Kill Files
11605 @section Kill Files
11606 @cindex kill files
11607
11608 Gnus still supports those pesky old kill files.  In fact, the kill file
11609 entries can now be expiring, which is something I wrote before Daniel
11610 Quinlan thought of doing score files, so I've left the code in there.
11611
11612 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11613 than score processing, so it might be a good idea to rewrite your kill
11614 files into score files.
11615
11616 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
11617 forms into this file, which means that you can use kill files as some
11618 sort of primitive hook function to be run on group entry, even though
11619 that isn't a very good idea.
11620
11621 Normal kill files look like this:
11622
11623 @lisp
11624 (gnus-kill "From" "Lars Ingebrigtsen")
11625 (gnus-kill "Subject" "ding")
11626 (gnus-expunge "X")
11627 @end lisp
11628
11629 This will mark every article written by me as read, and remove them from
11630 the summary buffer.  Very useful, you'll agree.
11631
11632 Other programs use a totally different kill file syntax.  If Gnus
11633 encounters what looks like a @code{rn} kill file, it will take a stab at
11634 interpreting it. 
11635
11636 Two summary functions for editing a GNUS kill file:
11637
11638 @table @kbd
11639
11640 @item M-k
11641 @kindex M-k (Summary)
11642 @findex gnus-summary-edit-local-kill
11643 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11644
11645 @item M-K
11646 @kindex M-K (Summary)
11647 @findex gnus-summary-edit-global-kill
11648 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11649 @end table
11650
11651 Two group mode functions for editing the kill files:
11652
11653 @table @kbd
11654
11655 @item M-k
11656 @kindex M-k (Group)
11657 @findex gnus-group-edit-local-kill
11658 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11659
11660 @item M-K
11661 @kindex M-K (Group)
11662 @findex gnus-group-edit-global-kill
11663 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11664 @end table
11665
11666 Kill file variables:
11667
11668 @table @code
11669 @item gnus-kill-file-name
11670 @vindex gnus-kill-file-name
11671 A kill file for the group @samp{soc.motss} is normally called
11672 @file{soc.motss.KILL}.  The suffix appended to the group name to get
11673 this file name is detailed by the @code{gnus-kill-file-name} variable.
11674 The ``global'' kill file (not in the score file sense of ``global'', of
11675 course) is called just @file{KILL}.
11676
11677 @vindex gnus-kill-save-kill-file
11678 @item gnus-kill-save-kill-file
11679 If this variable is non-@code{nil}, Gnus will save the
11680 kill file after processing, which is necessary if you use expiring
11681 kills. 
11682
11683 @item gnus-apply-kill-hook
11684 @vindex gnus-apply-kill-hook
11685 @findex gnus-apply-kill-file-unless-scored
11686 @findex gnus-apply-kill-file
11687 A hook called to apply kill files to a group.  It is
11688 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
11689 kill file if you have a score file for the same group, you can set this
11690 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
11691 kill files to be processed, you should set this variable to @code{nil}.
11692
11693 @item gnus-kill-file-mode-hook
11694 @vindex gnus-kill-file-mode-hook
11695 A hook called in kill-file mode buffers.
11696
11697 @end table
11698
11699
11700 @node Converting Kill Files
11701 @section Converting Kill Files
11702 @cindex kill files
11703 @cindex converting kill files
11704
11705 If you have loads of old kill files, you may want to convert them into
11706 score files.  If they are ``regular'', you can use
11707 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11708 by hand.
11709
11710 The kill to score conversion package isn't included in Gnus by default.
11711 You can fetch it from
11712 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
11713
11714 If your old kill files are very complex---if they contain more
11715 non-@code{gnus-kill} forms than not, you'll have to convert them by
11716 hand.  Or just let them be as they are.  Gnus will still use them as
11717 before. 
11718
11719
11720 @node GroupLens
11721 @section GroupLens
11722 @cindex GroupLens
11723
11724 GroupLens is a collaborative filtering system that helps you work
11725 together with other people to find the quality news articles out of the
11726 huge volume of news articles generated every day.
11727
11728 To accomplish this the GroupLens system combines your opinions about
11729 articles you have already read with the opinions of others who have done
11730 likewise and gives you a personalized prediction for each unread news
11731 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
11732 rate articles, and finds other people that rate articles the same way.
11733 Once it has found for you some people you agree with it tells you, in
11734 the form of a prediction, what they thought of the article.  You can use
11735 this prediction to help you decide whether or not you want to read the
11736 article.
11737
11738 @menu
11739 * Using GroupLens::          How to make Gnus use GroupLens.
11740 * Rating Articles::          Letting GroupLens know how you rate articles.
11741 * Displaying Predictions::   Displaying predictions given by GroupLens.
11742 * GroupLens Variables::      Customizing GroupLens.
11743 @end menu
11744
11745
11746 @node Using GroupLens
11747 @subsection Using GroupLens
11748
11749 To use GroupLens you must register a pseudonym with your local Better
11750 Bit Bureau (BBB).
11751 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11752 better bit in town is at the moment.
11753
11754 Once you have registered you'll need to set a couple of variables.
11755
11756 @table @code
11757
11758 @item gnus-use-grouplens
11759 @vindex gnus-use-grouplens
11760 Setting this variable to a non-@code{nil} value will make Gnus hook into
11761 all the relevant GroupLens functions.
11762
11763 @item grouplens-pseudonym
11764 @vindex grouplens-pseudonym
11765 This variable should be set to the pseudonym you got when registering
11766 with the Better Bit Bureau.
11767
11768 @item grouplens-newsgroups
11769 @vindex grouplens-newsgroups
11770 A list of groups that you want to get GroupLens predictions for. 
11771
11772 @end table
11773
11774 Thats the minimum of what you need to get up and running with GroupLens.
11775 Once you've registered, GroupLens will start giving you scores for
11776 articles based on the average of what other people think.  But, to get
11777 the real benefit of GroupLens you need to start rating articles
11778 yourself.  Then the scores GroupLens gives you will be personalized for
11779 you, based on how the people you usually agree with have already rated.
11780
11781
11782 @node Rating Articles
11783 @subsection Rating Articles
11784
11785 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11786 Where 1 means something like this article is a waste of bandwidth and 5
11787 means that the article was really good.  The basic question to ask
11788 yourself is, "on a scale from 1 to 5 would I like to see more articles
11789 like this one?"
11790
11791 There are four ways to enter a rating for an article in GroupLens.
11792
11793 @table @kbd
11794
11795 @item r
11796 @kindex r (GroupLens)
11797 @findex bbb-summary-rate-article
11798 This function will prompt you for a rating on a scale of one to five.
11799
11800 @item k
11801 @kindex k (GroupLens)
11802 @findex grouplens-score-thread
11803 This function will prompt you for a rating, and rate all the articles in
11804 the thread.  This is really useful for some of those long running giant
11805 threads in rec.humor.
11806
11807 @end table
11808
11809 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11810 the score of the article you're reading.
11811
11812 @table @kbd
11813
11814 @item 1-5 n
11815 @kindex n (GroupLens)
11816 @findex grouplens-next-unread-article
11817 Rate the article and go to the next unread article.
11818
11819 @item 1-5 ,
11820 @kindex , (GroupLens)
11821 @findex grouplens-best-unread-article
11822 Rate the article and go to the next unread article with the highest score.
11823
11824 @end table
11825
11826 If you want to give the current article a score of 4 and then go to the
11827 next article, just type @kbd{4 n}.
11828
11829
11830 @node Displaying Predictions
11831 @subsection Displaying Predictions
11832
11833 GroupLens makes a prediction for you about how much you will like a
11834 news article.  The predictions from GroupLens are on a scale from 1 to
11835 5, where 1 is the worst and 5 is the best.  You can use the predictions
11836 from GroupLens in one of three ways controlled by the variable
11837 @code{gnus-grouplens-override-scoring}.
11838
11839 @vindex gnus-grouplens-override-scoring
11840 There are three ways to display predictions in grouplens.  You may
11841 choose to have the GroupLens scores contribute to, or override the
11842 regular gnus scoring mechanism. override is the default; however, some
11843 people prefer to see the Gnus scores plus the grouplens scores.  To get
11844 the separate scoring behavior you need to set
11845 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
11846 GroupLens predictions combined with the grouplens scores set it to
11847 @code{'override} and to combine the scores set
11848 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
11849 the combine option you will also want to set the values for
11850 @code{grouplens-prediction-offset} and
11851 @code{grouplens-score-scale-factor}.
11852
11853 @vindex grouplens-prediction-display
11854 In either case, GroupLens gives you a few choices for how you would like
11855 to see your predictions displayed.  The display of predictions is
11856 controlled by the @code{grouplens-prediction-display} variable.
11857
11858 The following are legal values for that variable.
11859
11860 @table @code
11861 @item prediction-spot
11862 The higher the prediction, the further to the right an @samp{*} is
11863 displayed. 
11864
11865 @item confidence-interval
11866 A numeric confidence interval.
11867
11868 @item prediction-bar
11869 The higher the prediction, the longer the bar.
11870
11871 @item confidence-bar
11872 Numerical confidence.
11873
11874 @item confidence-spot
11875 The spot gets bigger with more confidence.
11876
11877 @item prediction-num
11878 Plain-old numeric value.
11879
11880 @item confidence-plus-minus
11881 Prediction +/i confidence.
11882
11883 @end table
11884
11885
11886 @node GroupLens Variables
11887 @subsection GroupLens Variables
11888
11889 @table @code
11890
11891 @item gnus-summary-grouplens-line-format
11892 The summary line format used in summary buffers that are GroupLens
11893 enhanced.  It accepts the same specs as the normal summary line format
11894 (@pxref{Summary Buffer Lines}).  The default is
11895 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
11896
11897 @item grouplens-bbb-host
11898 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
11899 default.
11900
11901 @item grouplens-bbb-port
11902 Port of the host running the bbbd server.  The default is 9000.
11903
11904 @item grouplens-score-offset
11905 Offset the prediction by this value.  In other words, subtract the
11906 prediction value by this number to arrive at the effective score.  The
11907 default is 0.
11908
11909 @item grouplens-score-scale-factor 
11910 This variable allows the user to magnify the effect of GroupLens scores.
11911 The scale factor is applied after the offset.  The default is 1.
11912
11913 @end table
11914
11915
11916 @node Advanced Scoring
11917 @section Advanced Scoring
11918
11919 Scoring on Subjects and From headers is nice enough, but what if you're
11920 really interested in what a person has to say only when she's talking
11921 about a particular subject?  Or what about if you really don't want to
11922 read what person A has to say when she's following up to person B, but
11923 want to read what she says when she's following up to person C?
11924
11925 By using advanced scoring rules you may create arbitrarily complex
11926 scoring patterns.
11927
11928 @menu
11929 * Advanced Scoring Syntax::     A definition.
11930 * Advanced Scoring Examples::   What they look like.
11931 * Advanced Scoring Tips::       Getting the most out of it.
11932 @end menu
11933
11934
11935 @node Advanced Scoring Syntax
11936 @subsection Advanced Scoring Syntax
11937
11938 Ordinary scoring rules have a string as the first element in the rule.
11939 Advanced scoring rules have a list as the first element.  The second
11940 element is the score to be applied if the first element evaluated to a
11941 non-@code{nil} value.
11942
11943 These lists may consist of three logical operators, one redirection
11944 operator, and various match operators.
11945
11946 Logical operators:
11947
11948 @table @code
11949 @item &
11950 @itemx and
11951 This logical operator will evaluate each of its arguments until it finds
11952 one that evaluates to @code{false}, and then it'll stop.  If all arguments
11953 evaluate to @code{true} values, then this operator will return
11954 @code{true}. 
11955
11956 @item |
11957 @itemx or
11958 This logical operator will evaluate each of its arguments until it finds
11959 one that evaluates to @code{true}.  If no arguments are @code{true},
11960 then this operator will return @code{false}.
11961
11962 @item !
11963 @itemx not
11964 @itemx Â¬
11965 This logical operator only takes a single argument.  It returns the
11966 inverse of the value of its argument.
11967
11968 @end table
11969
11970 There is an @dfn{indirection operator} that will make its arguments
11971 apply to the ancestors of the current article being scored.  For
11972 instance, @code{1-} will make score rules apply to the parent of the
11973 current article.  @code{2-} will make score fules apply to the
11974 grandparent of the current article.  Alternatively, you can write
11975 @code{^^}, where the number of @code{^}s (carets) say how far back into
11976 the ancestry you want to go.
11977
11978 Finally, we have the match operators.  These are the ones that do the
11979 real work.  Match operators are header name strings followed by a match
11980 and a match type.  A typical match operator looks like @samp{("from"
11981 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
11982 simple scoring, and the match types are also the same.
11983
11984
11985 @node Advanced Scoring Examples
11986 @subsection Advanced Scoring Examples
11987
11988 Let's say you want to increase the score of articles written by Lars
11989 when he's talking about Gnus:
11990
11991 @example
11992 ((& 
11993   ("from" "Lars Ingebrigtsen")
11994   ("subject" "Gnus"))
11995  1000)
11996 @end example
11997
11998 Quite simple, huh?
11999
12000 When he writes long articles, he sometimes has something nice to say: 
12001
12002 @example
12003 ((& 
12004   ("from" "Lars Ingebrigtsen")
12005   (|
12006    ("subject" "Gnus")
12007    ("lines" 100 >)))
12008  1000)
12009 @end example
12010
12011 However, when he responds to things written by Reig Eigil Logge, you
12012 really don't want to read what he's written:
12013
12014 @example
12015 ((&
12016   ("from" "Lars Ingebrigtsen")
12017   (1- ("from" "Reig Eigir Logge")))
12018  -100000)
12019 @end example
12020
12021 Everybody that follows up Redmondo when he writes about disappearing
12022 socks should have their scores raised, but only when they talk about
12023 white socks.  However, when Lars talks about socks, it's usually not
12024 very interesting:
12025
12026 @example
12027 ((&
12028   (1-
12029    (&
12030     ("from" "redmondo@@.*no" r)
12031     ("body" "disappearing.*socks" t)))
12032   (! ("from" "Lars Ingebrigtsen"))
12033   ("body" "white.*socks"))
12034  1000)
12035 @end example
12036
12037 The possibilities are endless.
12038
12039
12040 @node Advanced Scoring Tips
12041 @subsection Advanced Scoring Tips
12042
12043 The @code{&} and @code{|} logical operators do short-circuit logic.
12044 That is, they stop processing their arguments when it's clear what the
12045 result of the operation will be.  For instance, if one of the arguments
12046 of an @code{&} evaluates to @code{false}, there's no point in evaluating
12047 the rest of the arguments.  This means that you should put slow matches
12048 (@samp{body}, @code{header}) last and quick matches (@samp{from},
12049 @samp{subject}) first.
12050
12051 The indirection arguments (@code{1-} and so on) will make their
12052 arguments work on previous generations of the thread.  If you say
12053 something like:
12054
12055 @example
12056 ...
12057 (1-
12058  (1-
12059   ("from" "lars")))
12060 ...
12061 @end example
12062
12063 Then that means "score on the from header of the grandparent of the
12064 current article".  An indirection is quite fast, but it's better to say:
12065
12066 @example
12067 (1-
12068  (& 
12069   ("from" "Lars")
12070   ("subject" "Gnus")))
12071 @end example
12072
12073 than it is to say:
12074
12075 @example
12076 (&
12077  (1- ("from" "Lars"))
12078  (1- ("subject" "Gnus")))
12079 @end example
12080
12081
12082 @node Score Decays
12083 @section Score Decays
12084 @cindex score decays
12085 @cindex decays
12086
12087 You may find that your scores have a tendency to grow without
12088 bounds, especially if you're using adaptive scoring.  If scores get too
12089 big, they lose all meaning---they simply max out and it's difficult to
12090 use them in any sensible way.
12091
12092 @vindex gnus-decay-scores
12093 @findex gnus-decay-score
12094 @vindex gnus-score-decay-function
12095 Gnus provides a mechanism for decaying scores to help with this problem.
12096 When score files are loaded and @code{gnus-decay-scores} is
12097 non-@code{nil}, Gnus will run the score files through the decaying
12098 mechanism thereby lowering the scores of all non-permanent score rules.
12099 The decay itself if performed by the @code{gnus-score-decay-function}
12100 function, which is @code{gnus-decay-score} by default.  Here's the
12101 definition of that function:
12102
12103 @lisp
12104 (defun gnus-decay-score (score)
12105   (floor
12106    (- score
12107       (* (if (< score 0) 1 -1)
12108          (min score
12109               (max gnus-score-decay-constant
12110                    (* (abs score)
12111                       gnus-score-decay-scale)))))))
12112 @end lisp
12113
12114 @vindex gnus-score-decay-scale
12115 @vindex gnus-score-decay-constant
12116 @code{gnus-score-decay-constant} is 3 by default and
12117 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
12118
12119 @enumerate
12120 @item
12121 Scores between -3 and 3 will be set to 0 when this function is called.
12122
12123 @item
12124 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12125
12126 @item
12127 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12128 score.
12129 @end enumerate
12130
12131 If you don't like this decay function, write your own.  It is called
12132 with the score to be decayed as its only parameter, and it should return
12133 the new score, which should be an integer.
12134
12135 Gnus will try to decay scores once a day.  If you haven't run Gnus for
12136 four days, Gnus will decay the scores four times, for instance.
12137
12138
12139 @node Various
12140 @chapter Various
12141
12142 @menu
12143 * Process/Prefix::             A convention used by many treatment commands.
12144 * Interactive::                Making Gnus ask you many questions.
12145 * Formatting Variables::       You can specify what buffers should look like.
12146 * Windows Configuration::      Configuring the Gnus buffer windows.
12147 * Compilation::                How to speed Gnus up.
12148 * Mode Lines::                 Displaying information in the mode lines.
12149 * Highlighting and Menus::     Making buffers look all nice and cozy.
12150 * Buttons::                    Get tendonitis in ten easy steps!
12151 * Daemons::                    Gnus can do things behind your back.
12152 * NoCeM::                      How to avoid spam and other fatty foods.
12153 * Picons::                     How to display pictures of what your reading.
12154 * Undo::                       Some actions can be undone.
12155 * Moderation::                 What to do if you're a moderator.
12156 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
12157 * Fuzzy Matching::             What's the big fuzz?
12158 * Various Various::            Things that are really various.
12159 @end menu
12160
12161
12162 @node Process/Prefix
12163 @section Process/Prefix
12164 @cindex process/prefix convention
12165
12166 Many functions, among them functions for moving, decoding and saving
12167 articles, use what is known as the @dfn{Process/Prefix convention}.
12168
12169 This is a method for figuring out what articles that the user wants the
12170 command to be performed on.
12171
12172 It goes like this:
12173
12174 If the numeric prefix is N, perform the operation on the next N
12175 articles, starting with the current one.  If the numeric prefix is
12176 negative, perform the operation on the previous N articles, starting
12177 with the current one.
12178
12179 @vindex transient-mark-mode
12180 If @code{transient-mark-mode} in non-@code{nil} and the region is
12181 active, all articles in the region will be worked upon.
12182
12183 If there is no numeric prefix, but some articles are marked with the
12184 process mark, perform the operation on the articles that are marked with
12185 the process mark.
12186
12187 If there is neither a numeric prefix nor any articles marked with the
12188 process mark, just perform the operation on the current article.
12189
12190 Quite simple, really, but it needs to be made clear so that surprises
12191 are avoided.
12192
12193 Commands that react to the process mark will push the current list of
12194 process marked articles onto a stack and will then clear all process
12195 marked articles.  You can restore the previous configuration with the
12196 @kbd{M P y} command (@pxref{Setting Process Marks}).
12197
12198 @vindex gnus-summary-goto-unread
12199 One thing that seems to shock & horrify lots of people is that, for
12200 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12201 Since each @kbd{d} (which marks the current article as read) by default
12202 goes to the next unread article after marking, this means that @kbd{3 d}
12203 will mark the next three unread articles as read, no matter what the
12204 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
12205 @code{nil} for a more straightforward action.
12206
12207
12208 @node Interactive
12209 @section Interactive
12210 @cindex interaction
12211
12212 @table @code
12213
12214 @item gnus-novice-user
12215 @vindex gnus-novice-user
12216 If this variable is non-@code{nil}, you are either a newcomer to the
12217 World of Usenet, or you are very cautious, which is a nice thing to be,
12218 really.  You will be given questions of the type ``Are you sure you want
12219 to do this?'' before doing anything dangerous.  This is @code{t} by
12220 default.
12221
12222 @item gnus-expert-user
12223 @vindex gnus-expert-user
12224 If this variable is non-@code{nil}, you will never ever be asked any
12225 questions by Gnus.  It will simply assume you know what you're doing, no
12226 matter how strange.
12227
12228 @item gnus-interactive-catchup
12229 @vindex gnus-interactive-catchup
12230 Require confirmation before catching up a group if non-@code{nil}.  It
12231 is @code{t} by default.
12232
12233 @item gnus-interactive-exit
12234 @vindex gnus-interactive-exit
12235 Require confirmation before exiting Gnus.  This variable is @code{t} by
12236 default. 
12237 @end table
12238
12239
12240 @node Formatting Variables
12241 @section Formatting Variables
12242 @cindex formatting variables
12243
12244 Throughout this manual you've probably noticed lots of variables that
12245 are called things like @code{gnus-group-line-format} and
12246 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
12247 output lines in the various buffers.  There's quite a lot of them.
12248 Fortunately, they all use the same syntax, so there's not that much to
12249 be annoyed by.
12250
12251 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12252 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
12253 lots of percentages everywhere.  
12254
12255 @menu 
12256 * Formatting Basics::     A formatting variable is basically a format string.
12257 * Advanced Formatting::   Modifying output in various ways.
12258 * User-Defined Specs::    Having Gnus call your own functions.
12259 * Formatting Fonts::      Making the formatting look colorful and nice.
12260 @end menu
12261
12262 Currently Gnus uses the following formatting variables:
12263 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12264 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12265 @code{gnus-group-mode-line-format},
12266 @code{gnus-summary-mode-line-format},
12267 @code{gnus-article-mode-line-format},
12268 @code{gnus-server-mode-line-format}, and
12269 @code{gnus-summary-pick-line-format}.
12270
12271 All these format variables can also be arbitrary elisp forms.  In that
12272 case, they will be @code{eval}ed to insert the required lines.
12273
12274 @kindex M-x gnus-update-format
12275 @findex gnus-update-format
12276 Gnus includes a command to help you while creating your own format
12277 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
12278 update the spec in question and pop you to a buffer where you can
12279 examine the resulting lisp code to be run to generate the line.  
12280
12281
12282
12283 @node Formatting Basics
12284 @subsection Formatting Basics
12285
12286 Each @samp{%} element will be replaced by some string or other when the
12287 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
12288 spec, and pad with spaces to get a 5-character field''.
12289
12290 As with normal C and Emacs Lisp formatting strings, the numerical
12291 modifier between the @samp{%} and the formatting type character will
12292 @dfn{pad} the output so that it is always at least that long.
12293 @samp{%5y} will make the field always (at least) five characters wide by
12294 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
12295 the right instead.
12296
12297 You may also wish to limit the length of the field to protect against
12298 particularly wide values.  For that you can say @samp{%4,6y}, which
12299 means that the field will never be more than 6 characters wide and never
12300 less than 4 characters wide.
12301
12302
12303 @node Advanced Formatting
12304 @subsection Advanced Formatting
12305
12306 It is frequently useful to post-process the fields in some way.
12307 Padding, limiting, cutting off parts and suppressing certain values can
12308 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
12309 look like @samp{%~(cut 3)~(ignore "0")y}.
12310
12311 These are the legal modifiers:
12312
12313 @table @code
12314 @item pad
12315 @itemx pad-left
12316 Pad the field to the left with spaces until it reaches the required
12317 length.
12318
12319 @item pad-right
12320 Pad the field to the right with spaces until it reaches the required
12321 length.
12322
12323 @item max
12324 @itemx max-left
12325 Cut off characters from the left until it reaches the specified length.
12326
12327 @item max-right
12328 Cut off characters from the right until it reaches the specified
12329 length. 
12330
12331 @item cut
12332 @itemx cut-left
12333 Cut off the specified number of characters from the left.
12334
12335 @item cut-right
12336 Cut off the specified number of characters from the right.
12337
12338 @item ignore
12339 Return an empty string if the field is equal to the specified value. 
12340
12341 @item form
12342 Use the specified form as the field value when the @samp{@@} spec is
12343 used. 
12344 @end table
12345
12346 Let's take an example.  The @samp{%o} spec in the summary mode lines
12347 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12348 This is quite a mouthful, so we want to shave off the century number and
12349 the time, leaving us with a six-character date.  That would be
12350 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
12351 maxing, and we need the padding to ensure that the date is never less
12352 than 6 characters to make it look nice in columns.)
12353
12354 Ignoring is done first; then cutting; then maxing; and then as the very
12355 last operation, padding.  
12356
12357 If you use lots of these advanced thingies, you'll find that Gnus gets
12358 quite slow.  This can be helped enormously by running @kbd{M-x
12359 gnus-compile} when you are satisfied with the look of your lines.
12360 @xref{Compilation}. 
12361
12362
12363 @node User-Defined Specs
12364 @subsection User-Defined Specs
12365
12366 All the specs allow for inserting user defined specifiers---@samp{u}.
12367 The next character in the format string should be a letter.  Gnus
12368 will call the function @code{gnus-user-format-function-}@samp{X}, where
12369 @samp{X} is the letter following @samp{%u}.  The function will be passed
12370 a single parameter---what the parameter means depends on what buffer
12371 it's being called from.  The function should return a string, which will
12372 be inserted into the buffer just like information from any other
12373 specifier.  This function may also be called with dummy values, so it
12374 should protect against that.
12375
12376 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12377 much the same without defining new functions.  Here's an example:
12378 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
12379 given here will be evaluated to yield the current line number, and then
12380 inserted.
12381
12382
12383 @node Formatting Fonts
12384 @subsection Formatting Fonts
12385
12386 There are specs for highlighting, and these are shared by all the format
12387 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
12388 the special @code{mouse-face} property set, which means that it will be
12389 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12390 over it.
12391
12392 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12393 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12394 default.  If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12395 instead, and so on.  Create as many faces as you wish.  The same goes
12396 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12397 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12398
12399 Here's an alternative recipe for the group buffer:
12400
12401 @lisp
12402 ;; Create three face types.
12403 (setq gnus-face-1 'bold)
12404 (setq gnus-face-3 'italic)
12405
12406 ;; We want the article count to be in 
12407 ;; a bold and green face.  So we create 
12408 ;; a new face called `my-green-bold'.
12409 (copy-face 'bold 'my-green-bold)
12410 ;; Set the color.
12411 (set-face-foreground 'my-green-bold "ForestGreen")
12412 (setq gnus-face-2 'my-green-bold)
12413
12414 ;; Set the new & fancy format.
12415 (setq gnus-group-line-format 
12416       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12417 @end lisp
12418
12419 I'm sure you'll be able to use this scheme to create totally unreadable
12420 and extremely vulgar displays.  Have fun!
12421
12422 Note that the @samp{%(} specs (and friends) do not make any sense on the
12423 mode-line variables.
12424
12425
12426 @node Windows Configuration
12427 @section Windows Configuration
12428 @cindex windows configuration
12429
12430 No, there's nothing here about X, so be quiet.
12431
12432 @vindex gnus-use-full-window
12433 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12434 other windows and occupy the entire Emacs screen by itself.  It is
12435 @code{t} by default.
12436
12437 @vindex gnus-buffer-configuration
12438 @code{gnus-buffer-configuration} describes how much space each Gnus
12439 buffer should be given.  Here's an excerpt of this variable:
12440
12441 @lisp
12442 ((group (vertical 1.0 (group 1.0 point)
12443                       (if gnus-carpal (group-carpal 4))))
12444  (article (vertical 1.0 (summary 0.25 point) 
12445                         (article 1.0))))
12446 @end lisp
12447
12448 This is an alist.  The @dfn{key} is a symbol that names some action or
12449 other.  For instance, when displaying the group buffer, the window
12450 configuration function will use @code{group} as the key.  A full list of
12451 possible names is listed below.
12452
12453 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12454 should occupy.  To take the @code{article} split as an example -
12455
12456 @lisp
12457 (article (vertical 1.0 (summary 0.25 point)
12458                        (article 1.0)))
12459 @end lisp
12460
12461 This @dfn{split} says that the summary buffer should occupy 25% of upper
12462 half of the screen, and that it is placed over the article buffer.  As
12463 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12464 reaching for that calculator there).  However, the special number
12465 @code{1.0} is used to signal that this buffer should soak up all the
12466 rest of the space available after the rest of the buffers have taken
12467 whatever they need.  There should be only one buffer with the @code{1.0}
12468 size spec per split.
12469
12470 Point will be put in the buffer that has the optional third element
12471 @code{point}. 
12472
12473 Here's a more complicated example:
12474
12475 @lisp
12476 (article (vertical 1.0 (group 4)
12477                        (summary 0.25 point)
12478                        (if gnus-carpal (summary-carpal 4))
12479                        (article 1.0)))
12480 @end lisp
12481
12482 If the size spec is an integer instead of a floating point number, 
12483 then that number will be used to say how many lines a buffer should
12484 occupy, not a percentage.
12485
12486 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12487 precise---if the @code{car} of the split is a function or a subr), this
12488 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
12489 be used as a split.  This means that there will be three buffers if
12490 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12491 is non-@code{nil}.
12492
12493 Not complicated enough for you?  Well, try this on for size:
12494
12495 @lisp
12496 (article (horizontal 1.0 
12497              (vertical 0.5
12498                  (group 1.0)
12499                  (gnus-carpal 4))
12500              (vertical 1.0
12501                  (summary 0.25 point)
12502                  (summary-carpal 4)
12503                  (article 1.0))))
12504 @end lisp
12505
12506 Whoops.  Two buffers with the mystery 100% tag.  And what's that
12507 @code{horizontal} thingie?  
12508
12509 If the first element in one of the split is @code{horizontal}, Gnus will
12510 split the window horizontally, giving you two windows side-by-side.
12511 Inside each of these strips you may carry on all you like in the normal
12512 fashion.  The number following @code{horizontal} says what percentage of
12513 the screen is to be given to this strip.
12514
12515 For each split, there @emph{must} be one element that has the 100% tag.
12516 The splitting is never accurate, and this buffer will eat any leftover
12517 lines from the splits.
12518
12519 To be slightly more formal, here's a definition of what a legal split
12520 may look like:
12521
12522 @example
12523 split       = frame | horizontal | vertical | buffer | form
12524 frame       = "(frame " size *split ")"
12525 horizontal  = "(horizontal " size *split ")"
12526 vertical    = "(vertical " size *split ")"
12527 buffer      = "(" buffer-name " " size *[ "point" ] ")"
12528 size        = number | frame-params
12529 buffer-name = group | article | summary ...
12530 @end example
12531
12532 The limitations are that the @code{frame} split can only appear as the
12533 top-level split.  @var{form} should be an Emacs Lisp form that should
12534 return a valid split.  We see that each split is fully recursive, and
12535 may contain any number of @code{vertical} and @code{horizontal} splits. 
12536
12537 @vindex gnus-window-min-width
12538 @vindex gnus-window-min-height
12539 @cindex window height
12540 @cindex window width
12541 Finding the right sizes can be a bit complicated.  No window may be less
12542 than @code{gnus-window-min-height} (default 1) characters high, and all
12543 windows must be at least @code{gnus-window-min-width} (default 1)
12544 characters wide.  Gnus will try to enforce this before applying the
12545 splits.  If you want to use the normal Emacs window width/height limit,
12546 you can just set these two variables to @code{nil}.
12547
12548 If you're not familiar with Emacs terminology, @code{horizontal} and
12549 @code{vertical} splits may work the opposite way of what you'd expect.
12550 Windows inside a @code{horizontal} split are shown side-by-side, and
12551 windows within a @code{vertical} split are shown above each other.
12552
12553 @findex gnus-configure-frame
12554 If you want to experiment with window placement, a good tip is to call
12555 @code{gnus-configure-frame} directly with a split.  This is the function
12556 that does all the real work when splitting buffers.  Below is a pretty
12557 nonsensical configuration with 5 windows; two for the group buffer and
12558 three for the article buffer.  (I said it was nonsensical.)  If you
12559 @code{eval} the statement below, you can get an idea of how that would
12560 look straight away, without going through the normal Gnus channels.
12561 Play with it until you're satisfied, and then use
12562 @code{gnus-add-configuration} to add your new creation to the buffer
12563 configuration list. 
12564
12565 @lisp
12566 (gnus-configure-frame
12567  '(horizontal 1.0
12568     (vertical 10
12569       (group 1.0)
12570       (article 0.3 point))
12571     (vertical 1.0
12572       (article 1.0)
12573       (horizontal 4
12574         (group 1.0)
12575         (article 10)))))
12576 @end lisp
12577
12578 You might want to have several frames as well.  No prob---just use the
12579 @code{frame} split:
12580
12581 @lisp
12582 (gnus-configure-frame
12583  '(frame 1.0
12584          (vertical 1.0
12585                    (summary 0.25 point)
12586                    (article 1.0))
12587          (vertical ((height . 5) (width . 15)
12588                     (user-position . t)
12589                     (left . -1) (top . 1))
12590                    (picon 1.0))))
12591
12592 @end lisp
12593
12594 This split will result in the familiar summary/article window
12595 configuration in the first (or ``main'') frame, while a small additional
12596 frame will be created where picons will be shown.  As you can see,
12597 instead of the normal @code{1.0} top-level spec, each additional split
12598 should have a frame parameter alist as the size spec.
12599 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12600 Reference Manual}.
12601
12602 Here's a list of all possible keys for
12603 @code{gnus-buffer-configuration}:
12604
12605 @code{group}, @code{summary}, @code{article}, @code{server},
12606 @code{browse}, @code{message}, @code{pick}, @code{info},
12607 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12608 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12609 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
12610 @code{bug}, @code{compose-bounce}.
12611
12612 Note that the @code{message} key is used for both
12613 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
12614 it is desirable to distinguish between the two, something like this
12615 might be used:
12616
12617 @lisp
12618 (message (horizontal 1.0
12619                      (vertical 1.0 (message 1.0 point))
12620                      (vertical 0.24
12621                                (if (buffer-live-p gnus-summary-buffer)
12622                                    '(summary 0.5))
12623                                (group 1.0)))))
12624 @end lisp
12625
12626 @findex gnus-add-configuration
12627 Since the @code{gnus-buffer-configuration} variable is so long and
12628 complicated, there's a function you can use to ease changing the config
12629 of a single setting: @code{gnus-add-configuration}.  If, for instance,
12630 you want to change the @code{article} setting, you could say:
12631
12632 @lisp
12633 (gnus-add-configuration
12634  '(article (vertical 1.0
12635                (group 4)
12636                (summary .25 point)
12637                (article 1.0))))
12638 @end lisp
12639
12640 You'd typically stick these @code{gnus-add-configuration} calls in your
12641 @file{.gnus.el} file or in some startup hook---they should be run after
12642 Gnus has been loaded.
12643
12644 @vindex gnus-always-force-window-configuration
12645 If all windows mentioned in the configuration are already visible, Gnus
12646 won't change the window configuration.  If you always want to force the
12647 ``right'' window configuration, you can set
12648 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12649
12650
12651 @node Compilation
12652 @section Compilation
12653 @cindex compilation
12654 @cindex byte-compilation
12655
12656 @findex gnus-compile
12657
12658 Remember all those line format specification variables?
12659 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12660 on.  Now, Gnus will of course heed whatever these variables are, but,
12661 unfortunately, changing them will mean a quite significant slow-down.
12662 (The default values of these variables have byte-compiled functions
12663 associated with them, while the user-generated versions do not, of
12664 course.) 
12665
12666 To help with this, you can run @kbd{M-x gnus-compile} after you've
12667 fiddled around with the variables and feel that you're (kind of)
12668 satisfied.  This will result in the new specs being byte-compiled, and
12669 you'll get top speed again.  Gnus will save these compiled specs in the
12670 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
12671 this function, though---you should compile them yourself by sticking
12672 them into the @code{.gnus.el} file and byte-compiling that file.)
12673
12674
12675 @node Mode Lines
12676 @section Mode Lines
12677 @cindex mode lines
12678
12679 @vindex gnus-updated-mode-lines
12680 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12681 lines updated.  It is a list of symbols.  Supported symbols include
12682 @code{group}, @code{article}, @code{summary}, @code{server},
12683 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
12684 Gnus will keep that mode line updated with information that may be
12685 pertinent.  If this variable is @code{nil}, screen refresh may be
12686 quicker.
12687
12688 @cindex display-time
12689
12690 @vindex gnus-mode-non-string-length
12691 By default, Gnus displays information on the current article in the mode
12692 lines of the summary and article buffers.  The information Gnus wishes
12693 to display (e.g. the subject of the article) is often longer than the
12694 mode lines, and therefore have to be cut off at some point.  The
12695 @code{gnus-mode-non-string-length} variable says how long the other
12696 elements on the line is (i.e., the non-info part).  If you put
12697 additional elements on the mode line (e.g. a clock), you should modify
12698 this variable:
12699
12700 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12701 @lisp
12702 (add-hook 'display-time-hook
12703           (lambda () (setq gnus-mode-non-string-length
12704                            (+ 21
12705                               (if line-number-mode 5 0)
12706                               (if column-number-mode 4 0)
12707                               (length display-time-string)))))
12708 @end lisp
12709
12710 If this variable is @code{nil} (which is the default), the mode line
12711 strings won't be chopped off, and they won't be padded either.
12712 Note that the default is unlikely to be desirable, as even the
12713 percentage complete in the buffer may be crowded off the mode line;
12714 the user should configure this variable appropriately for their
12715 configuration.
12716
12717
12718 @node Highlighting and Menus
12719 @section Highlighting and Menus
12720 @cindex visual
12721 @cindex highlighting
12722 @cindex menus
12723
12724 @vindex gnus-visual
12725 The @code{gnus-visual} variable controls most of the prettifying Gnus
12726 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
12727 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
12728 file.
12729
12730 This variable can be a list of visual properties that are enabled.  The
12731 following elements are legal, and are all included by default:
12732
12733 @table @code
12734 @item group-highlight
12735 Do highlights in the group buffer.
12736 @item summary-highlight
12737 Do highlights in the summary buffer.
12738 @item article-highlight
12739 Do highlights in the article buffer.
12740 @item highlight
12741 Turn on highlighting in all buffers.
12742 @item group-menu
12743 Create menus in the group buffer.
12744 @item summary-menu
12745 Create menus in the summary buffers.
12746 @item article-menu
12747 Create menus in the article buffer.
12748 @item browse-menu
12749 Create menus in the browse buffer.
12750 @item server-menu
12751 Create menus in the server buffer.
12752 @item score-menu
12753 Create menus in the score buffers.
12754 @item menu
12755 Create menus in all buffers.
12756 @end table
12757
12758 So if you only want highlighting in the article buffer and menus in all
12759 buffers, you could say something like:
12760
12761 @lisp
12762 (setq gnus-visual '(article-highlight menu))
12763 @end lisp
12764
12765 If you want only highlighting and no menus whatsoever, you'd say:
12766
12767 @lisp
12768 (setq gnus-visual '(highlight))
12769 @end lisp
12770
12771 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12772 in all Gnus buffers.
12773
12774 Other general variables that influence the look of all buffers include:
12775
12776 @table @code
12777 @item gnus-mouse-face
12778 @vindex gnus-mouse-face
12779 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
12780 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12781
12782 @end table
12783
12784 There are hooks associated with the creation of all the different menus:
12785
12786 @table @code
12787
12788 @item gnus-article-menu-hook
12789 @vindex gnus-article-menu-hook
12790 Hook called after creating the article mode menu.
12791
12792 @item gnus-group-menu-hook
12793 @vindex gnus-group-menu-hook
12794 Hook called after creating the group mode menu.
12795
12796 @item gnus-summary-menu-hook
12797 @vindex gnus-summary-menu-hook
12798 Hook called after creating the summary mode menu.
12799
12800 @item gnus-server-menu-hook
12801 @vindex gnus-server-menu-hook
12802 Hook called after creating the server mode menu.
12803
12804 @item gnus-browse-menu-hook
12805 @vindex gnus-browse-menu-hook
12806 Hook called after creating the browse mode menu.
12807
12808 @item gnus-score-menu-hook
12809 @vindex gnus-score-menu-hook
12810 Hook called after creating the score mode menu.
12811
12812 @end table
12813
12814
12815 @node Buttons
12816 @section Buttons
12817 @cindex buttons
12818 @cindex mouse
12819 @cindex click
12820
12821 Those new-fangled @dfn{mouse} contraptions is very popular with the
12822 young, hep kids who don't want to learn the proper way to do things
12823 these days.  Why, I remember way back in the summer of '89, when I was
12824 using Emacs on a Tops 20 system.  Three hundred users on one single
12825 machine, and every user was running Simula compilers.  Bah!
12826
12827 Right.
12828
12829 @vindex gnus-carpal
12830 Well, you can make Gnus display bufferfuls of buttons you can click to
12831 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
12832 really.  Tell the chiropractor I sent you.
12833
12834
12835 @table @code
12836
12837 @item gnus-carpal-mode-hook
12838 @vindex gnus-carpal-mode-hook
12839 Hook run in all carpal mode buffers.
12840
12841 @item gnus-carpal-button-face
12842 @vindex gnus-carpal-button-face
12843 Face used on buttons.
12844
12845 @item gnus-carpal-header-face
12846 @vindex gnus-carpal-header-face
12847 Face used on carpal buffer headers.
12848
12849 @item gnus-carpal-group-buffer-buttons
12850 @vindex gnus-carpal-group-buffer-buttons
12851 Buttons in the group buffer.
12852
12853 @item gnus-carpal-summary-buffer-buttons
12854 @vindex gnus-carpal-summary-buffer-buttons
12855 Buttons in the summary buffer.
12856
12857 @item gnus-carpal-server-buffer-buttons
12858 @vindex gnus-carpal-server-buffer-buttons
12859 Buttons in the server buffer.
12860
12861 @item gnus-carpal-browse-buffer-buttons
12862 @vindex gnus-carpal-browse-buffer-buttons
12863 Buttons in the browse buffer.
12864 @end table
12865
12866 All the @code{buttons} variables are lists.  The elements in these list
12867 is either a cons cell where the car contains a text to be displayed and
12868 the cdr contains a function symbol, or a simple string.
12869
12870
12871 @node Daemons
12872 @section Daemons
12873 @cindex demons
12874 @cindex daemons
12875
12876 Gnus, being larger than any program ever written (allegedly), does lots
12877 of strange stuff that you may wish to have done while you're not
12878 present.  For instance, you may want it to check for new mail once in a
12879 while.  Or you may want it to close down all connections to all servers
12880 when you leave Emacs idle.  And stuff like that.
12881
12882 Gnus will let you do stuff like that by defining various
12883 @dfn{handlers}.  Each handler consists of three elements:  A
12884 @var{function}, a @var{time}, and an @var{idle} parameter.
12885
12886 Here's an example of a handler that closes connections when Emacs has
12887 been idle for thirty minutes:
12888
12889 @lisp
12890 (gnus-demon-close-connections nil 30)
12891 @end lisp
12892
12893 Here's a handler that scans for PGP headers every hour when Emacs is
12894 idle: 
12895
12896 @lisp
12897 (gnus-demon-scan-pgp 60 t)
12898 @end lisp
12899
12900 This @var{time} parameter and than @var{idle} parameter works together
12901 in a strange, but wonderful fashion.  Basically, if @var{idle} is
12902 @code{nil}, then the function will be called every @var{time} minutes.
12903
12904 If @var{idle} is @code{t}, then the function will be called after
12905 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
12906 the function will never be called.  But once Emacs goes idle, the
12907 function will be called every @var{time} minutes.
12908
12909 If @var{idle} is a number and @var{time} is a number, the function will
12910 be called every @var{time} minutes only when Emacs has been idle for
12911 @var{idle} minutes.
12912
12913 If @var{idle} is a number and @var{time} is @code{nil}, the function
12914 will be called once every time Emacs has been idle for @var{idle}
12915 minutes.  
12916
12917 And if @var{time} is a string, it should look like @samp{07:31}, and
12918 the function will then be called once every day somewhere near that
12919 time.  Modified by the @var{idle} parameter, of course.
12920
12921 @vindex gnus-demon-timestep
12922 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
12923 seconds.  This is 60 by default.  If you change that variable,
12924 all the timings in the handlers will be affected.)
12925
12926 @vindex gnus-use-demon
12927 To set the whole thing in motion, though, you have to set
12928 @code{gnus-use-demon} to @code{t}.
12929
12930 So, if you want to add a handler, you could put something like this in
12931 your @file{.gnus} file:
12932
12933 @findex gnus-demon-add-handler
12934 @lisp
12935 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
12936 @end lisp
12937
12938 @findex gnus-demon-add-nocem
12939 @findex gnus-demon-add-scanmail
12940 @findex gnus-demon-add-rescan
12941 @findex gnus-demon-add-disconnection
12942 Some ready-made functions to do this has been created:
12943 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
12944 @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}.  Just
12945 put those functions in your @file{.gnus} if you want those abilities.
12946
12947 @findex gnus-demon-init
12948 @findex gnus-demon-cancel
12949 @vindex gnus-demon-handlers
12950 If you add handlers to @code{gnus-demon-handlers} directly, you should
12951 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
12952 daemons, you can use the @code{gnus-demon-cancel} function.
12953
12954 Note that adding daemons can be pretty naughty if you overdo it.  Adding
12955 functions that scan all news and mail from all servers every two seconds
12956 is a sure-fire way of getting booted off any respectable system.  So
12957 behave. 
12958
12959
12960 @node NoCeM
12961 @section NoCeM
12962 @cindex nocem
12963 @cindex spam
12964
12965 @dfn{Spamming} is posting the same article lots and lots of times.
12966 Spamming is bad.  Spamming is evil.  
12967
12968 Spamming is usually canceled within a day or so by various anti-spamming
12969 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
12970 NoCeM is pronounced ``no see-'em'', and means what the name
12971 implies---these are messages that make the offending articles, like, go
12972 away.  
12973
12974 What use are these NoCeM messages if the articles are canceled anyway?
12975 Some sites do not honor cancel messages and some sites just honor cancels
12976 from a select few people.  Then you may wish to make use of the NoCeM
12977 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
12978
12979 Gnus can read and parse the messages in this group automatically, and
12980 this will make spam disappear.  
12981
12982 There are some variables to customize, of course:
12983
12984 @table @code
12985 @item gnus-use-nocem
12986 @vindex gnus-use-nocem
12987 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
12988 by default. 
12989
12990 @item gnus-nocem-groups
12991 @vindex gnus-nocem-groups
12992 Gnus will look for NoCeM messages in the groups in this list.  The
12993 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
12994 "alt.nocem.misc" "news.admin.net-abuse.announce")}. 
12995
12996 @item gnus-nocem-issuers
12997 @vindex gnus-nocem-issuers
12998 There are many people issuing NoCeM messages.  This list says what
12999 people you want to listen to.  The default is @code{("Automoose-1"
13000 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
13001 (Richard E. Depew)")}; fine, upstanding citizens all of them.
13002
13003 Known despammers that you can put in this list include:
13004
13005 @table @samp
13006 @item clewis@@ferret.ocunix.on.ca;
13007 @cindex Chris Lewis
13008 Chris Lewis---Major Canadian despammer who has probably canceled more
13009 usenet abuse than anybody else.
13010
13011 @item Automoose-1
13012 @cindex CancelMoose[tm]
13013 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
13014 Norwegian, and was the person(s) who invented NoCeM.  
13015
13016 @item jem@@xpat.com;
13017 @cindex Jem
13018 John Milburn---despammer located in Korea who is getting very busy these
13019 days.
13020
13021 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
13022 Richard E. Depew---lone American despammer.  He mostly cancels binary
13023 postings to non-binary groups and removes spews (regurgitated articles).
13024 @end table
13025
13026 You do not have to heed NoCeM messages from all these people---just the
13027 ones you want to listen to.
13028
13029 @item gnus-nocem-verifyer
13030 @vindex gnus-nocem-verifyer
13031 @findex mc-verify
13032 This should be a function for verifying that the NoCeM issuer is who she
13033 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
13034 function.  If this is too slow and you don't care for verification
13035 (which may be dangerous), you can set this variable to @code{nil}.
13036
13037 @item gnus-nocem-directory
13038 @vindex gnus-nocem-directory
13039 This is where Gnus will store its NoCeM cache files.  The default is
13040 @file{~/News/NoCeM/}. 
13041
13042 @item gnus-nocem-expiry-wait
13043 @vindex gnus-nocem-expiry-wait
13044 The number of days before removing old NoCeM entries from the cache.
13045 The default is 15.  If you make it shorter Gnus will be faster, but you
13046 might then see old spam.
13047
13048 @end table
13049
13050
13051 @node Picons
13052 @section Picons
13053
13054 So...  You want to slow down your news reader even more!  This is a
13055 good way to do so.  Its also a great way to impress people staring
13056 over your shoulder as you read news.
13057
13058 @menu
13059 * Picon Basics::           What are picons and How do I get them.
13060 * Picon Requirements::     Don't go further if you aren't using XEmacs.
13061 * Easy Picons::            Displaying Picons---the easy way.
13062 * Hard Picons::            The way you should do it.  You'll learn something.
13063 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
13064 @end menu
13065
13066
13067 @node Picon Basics
13068 @subsection Picon Basics
13069
13070 What are Picons?  To quote directly from the Picons Web site:
13071
13072 @quotation 
13073 @dfn{Picons} is short for ``personal icons''.  They're small,
13074 constrained images used to represent users and domains on the net,
13075 organized into databases so that the appropriate image for a given
13076 e-mail address can be found.  Besides users and domains, there are picon
13077 databases for Usenet newsgroups and weather forecasts.  The picons are
13078 in either monochrome @code{XBM} format or color @code{XPM} and
13079 @code{GIF} formats.
13080 @end quotation
13081
13082 For instructions on obtaining and installing the picons databases, point
13083 your Web browser at
13084 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13085
13086 @vindex gnus-picons-database
13087 Gnus expects picons to be installed into a location pointed to by
13088 @code{gnus-picons-database}.
13089
13090
13091 @node Picon Requirements
13092 @subsection Picon Requirements
13093
13094 To use have Gnus display Picons for you, you must be running XEmacs
13095 19.13 or greater since all other versions of Emacs aren't yet able to
13096 display images.
13097
13098 Additionally, you must have @code{xpm} support compiled into XEmacs.
13099
13100 @vindex gnus-picons-convert-x-face
13101 If you want to display faces from @code{X-Face} headers, you must have
13102 the @code{netpbm} utilities installed, or munge the
13103 @code{gnus-picons-convert-x-face} variable to use something else.
13104
13105
13106 @node Easy Picons
13107 @subsection Easy Picons
13108
13109 To enable displaying picons, simply put the following line in your
13110 @file{~/.gnus} file and start Gnus.
13111
13112 @lisp
13113 (setq gnus-use-picons t)
13114 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13115 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13116 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13117 @end lisp
13118
13119
13120 @node Hard Picons
13121 @subsection Hard Picons 
13122
13123 Gnus can display picons for you as you enter and leave groups and
13124 articles.  It knows how to interact with three sections of the picons
13125 database.  Namely, it can display the picons newsgroup pictures,
13126 author's face picture(s), and the authors domain.  To enable this
13127 feature, you need to first decide where to display them.
13128
13129 @table @code 
13130
13131 @item gnus-picons-display-where 
13132 @vindex gnus-picons-display-where 
13133 Where the picon images should be displayed.  It is @code{picons} by
13134 default (which by default maps to the buffer @samp{*Picons*}).  Other
13135 valid places could be @code{article}, @code{summary}, or
13136 @samp{*scratch*} for all I care.  Just make sure that you've made the
13137 buffer visible using the standard Gnus window configuration
13138 routines---@pxref{Windows Configuration}.
13139
13140 @end table
13141
13142 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13143 window configuration for you to include the @code{picons} buffer.
13144
13145 Now that you've made that decision, you need to add the following
13146 functions to the appropriate hooks so these pictures will get
13147 displayed at the right time.
13148
13149 @vindex gnus-article-display-hook
13150 @vindex gnus-picons-display-where
13151 @table @code
13152 @item gnus-article-display-picons
13153 @findex gnus-article-display-picons
13154 Looks up and display the picons for the author and the author's domain
13155 in the @code{gnus-picons-display-where} buffer.  Should be added to
13156 the @code{gnus-article-display-hook}.
13157
13158 @item gnus-group-display-picons
13159 @findex gnus-article-display-picons
13160 Displays picons representing the current group.  This function should
13161 be added to the @code{gnus-summary-prepare-hook} or to the
13162 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13163 is set to @code{article}.
13164
13165 @item gnus-picons-article-display-x-face
13166 @findex gnus-article-display-picons
13167 Decodes and displays the X-Face header if present.  This function
13168 should be added to @code{gnus-article-display-hook}.
13169
13170 @end table
13171
13172 Note:  You must append them to the hook, so make sure to specify 't'
13173 to the append flag of @code{add-hook}:
13174
13175 @lisp
13176 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13177 @end lisp
13178
13179
13180 @node Picon Configuration
13181 @subsection Picon Configuration
13182
13183 The following variables offer further control over how things are
13184 done, where things are located, and other useless stuff you really
13185 don't need to worry about.
13186
13187 @table @code
13188 @item gnus-picons-database
13189 @vindex gnus-picons-database
13190 The location of the picons database.  Should point to a directory
13191 containing the @file{news}, @file{domains}, @file{users} (and so on)
13192 subdirectories.  Defaults to @file{/usr/local/faces}.
13193
13194 @item gnus-picons-news-directory
13195 @vindex gnus-picons-news-directory
13196 Sub-directory of the faces database containing the icons for
13197 newsgroups.
13198
13199 @item gnus-picons-user-directories
13200 @vindex gnus-picons-user-directories
13201 List of subdirectories to search in @code{gnus-picons-database} for user
13202 faces.  @code{("local" "users" "usenix" "misc/MISC")} is the default.
13203
13204 @item gnus-picons-domain-directories
13205 @vindex gnus-picons-domain-directories
13206 List of subdirectories to search in @code{gnus-picons-database} for
13207 domain name faces.  Defaults to @code{("domains")}.  Some people may
13208 want to add @samp{unknown} to this list.
13209
13210 @item gnus-picons-convert-x-face
13211 @vindex gnus-picons-convert-x-face
13212 The command to use to convert the @code{X-Face} header to an X bitmap
13213 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
13214 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13215 gnus-picons-x-face-file-name)}
13216
13217 @item gnus-picons-x-face-file-name
13218 @vindex gnus-picons-x-face-file-name
13219 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
13220 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13221
13222 @item gnus-picons-buffer
13223 @vindex gnus-picons-buffer
13224 The name of the buffer that @code{picons} points to.  Defaults to
13225 @samp{*Icon Buffer*}.
13226
13227 @end table
13228
13229
13230 @node Undo
13231 @section Undo
13232 @cindex undo
13233
13234 It is very useful to be able to undo actions one has done.  In normal
13235 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13236 In Gnus buffers, however, it isn't that simple.
13237
13238 The things Gnus displays in its buffer is of no value whatsoever to
13239 Gnus---it's all just data that is designed to look nice to the user.
13240 Killing a group in the group buffer with @kbd{C-k} makes the line
13241 disappear, but that's just a side-effect of the real action---the
13242 removal of the group in question from the internal Gnus structures.
13243 Undoing something like that can't be done by the normal Emacs
13244 @code{undo} function.
13245
13246 Gnus tries to remedy this somewhat by keeping track of what the user
13247 does and coming up with actions that would reverse the actions the user
13248 takes.  When the user then presses the @code{undo} key, Gnus will run
13249 the code to reverse the previous action, or the previous actions.
13250 However, not all actions are easily reversible, so Gnus currently offers
13251 a few key functions to be undoable.  These include killing groups,
13252 yanking groups, and changing the list of read articles of groups.
13253 That's it, really.  More functions may be added in the future, but each
13254 added function means an increase in data to be stored, so Gnus will
13255 never be totally undoable.
13256
13257 @findex gnus-undo-mode
13258 @vindex gnus-use-undo
13259 @findex gnus-undo
13260 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
13261 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13262 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
13263 command, which should feel kinda like the normal Emacs @code{undo}
13264 command. 
13265
13266
13267 @node Moderation
13268 @section Moderation
13269 @cindex moderation
13270
13271 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13272 It is not included in the standard Gnus package.  Write a mail to
13273 @samp{larsi@@ifi.uio.no} and state what group you moderate, and you'll
13274 get a copy.
13275
13276 The moderation package is implemented as a minor mode for summary
13277 buffers.  Put
13278
13279 @lisp
13280 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13281 @end lisp
13282
13283 in your @file{.gnus.el} file.
13284
13285 If you are the moderation of @samp{rec.zoofle}, this is how it's
13286 supposed to work:
13287
13288 @enumerate
13289 @item 
13290 You split your incoming mail by matching on
13291 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13292 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13293
13294 @item
13295 You enter that group once in a while and post articles using the @kbd{e}
13296 (edit-and-post) or @kbd{s} (just send unedited) commands.
13297
13298 @item
13299 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13300 articles that weren't approved by you, you can cancel them with the
13301 @kbd{c} command.
13302 @end enumerate
13303
13304 To use moderation mode in these two groups, say:
13305
13306 @lisp
13307 (setq gnus-moderated-list
13308       "^nnml:rec.zoofle$\\|^rec.zoofle$")
13309 @end lisp
13310
13311
13312 @node XEmacs Enhancements
13313 @section XEmacs Enhancements
13314 @cindex XEmacs
13315
13316 XEmacs is able to display pictures and stuff, so Gnus has taken
13317 advantage of that.  Relevant variables include:
13318
13319 @table @code
13320 @item gnus-xmas-glyph-directory
13321 @vindex gnus-xmas-glyph-directory
13322 This is where Gnus will look for pictures.  Gnus will normally
13323 auto-detect this directory, but you may set it manually if you have an
13324 unusual directory structure.
13325
13326 @item gnus-xmas-logo-color-alist
13327 @vindex gnus-xmas-logo-color-alist
13328 This is an alist where the key is a type symbol and the values are the
13329 foreground and background color of the splash page glyph.
13330
13331 @item gnus-xmas-logo-color-style
13332 @vindex gnus-xmas-logo-color-style
13333 This is the key used to look up the color in the alist described above.
13334 Legal values include @code{flame}, @code{pine}, @code{moss},
13335 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13336 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13337
13338 @item gnus-use-toolbar
13339 @vindex gnus-use-toolbar
13340 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
13341 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13342 @code{right-toolbar}, or @code{left-toolbar}.
13343
13344 @item gnus-group-toolbar
13345 @vindex gnus-group-toolbar
13346 The toolbar in the group buffer.
13347
13348 @item gnus-summary-toolbar
13349 @vindex gnus-summary-toolbar
13350 The toolbar in the summary buffer.
13351
13352 @item gnus-summary-mail-toolbar
13353 @vindex gnus-summary-mail-toolbar
13354 The toolbar in the summary buffer of mail groups.
13355
13356 @item gnus-xmas-modeline-glyph
13357 @vindex gnus-xmas-modeline-glyph
13358 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
13359 default. 
13360
13361 @end table
13362
13363
13364 @node Fuzzy Matching
13365 @section Fuzzy Matching
13366 @cindex fuzzy matching
13367
13368 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
13369 things like scoring, thread gathering and thread comparison.  
13370
13371 As opposed to regular expression matching, fuzzy matching is very fuzzy.
13372 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
13373 means, and the implementation has changed over time.
13374
13375 Basically, it tries to remove all noise from lines before comparing.
13376 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
13377 out of the strings before comparing the results.  This often leads to
13378 adequate results---even when faced with strings generated by text
13379 manglers masquerading as newsreaders.
13380
13381
13382 @node Various Various
13383 @section Various Various
13384 @cindex mode lines
13385 @cindex highlights
13386
13387 @table @code
13388
13389 @item gnus-directory
13390 @vindex gnus-directory
13391 All Gnus directories will be initialized from this variable, which
13392 defaults to the @samp{SAVEDIR} environment variable, or @file{~/News/}
13393 if that variable isn't set.
13394
13395 @item gnus-default-directory
13396 @vindex gnus-default-directory
13397 Not related to the above variable at all---this variable says what the
13398 default directory of all Gnus buffers should be.  If you issue commands
13399 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13400 default directory.  If this variable is @code{nil} (which is the
13401 default), the default directory will be the default directory of the
13402 buffer you were in when you started Gnus.
13403
13404 @item gnus-verbose
13405 @vindex gnus-verbose
13406 This variable is an integer between zero and ten.  The higher the value,
13407 the more messages will be displayed.  If this variable is zero, Gnus
13408 will never flash any messages, if it is seven (which is the default),
13409 most important messages will be shown, and if it is ten, Gnus won't ever
13410 shut up, but will flash so many messages it will make your head swim.
13411
13412 @item gnus-verbose-backends
13413 @vindex gnus-verbose-backends
13414 This variable works the same way as @code{gnus-verbose}, but it applies
13415 to the Gnus backends instead of Gnus proper.
13416
13417 @item nnheader-max-head-length
13418 @vindex nnheader-max-head-length
13419 When the backends read straight heads of articles, they all try to read
13420 as little as possible.  This variable (default 4096) specifies
13421 the absolute max length the backends will try to read before giving up
13422 on finding a separator line between the head and the body.  If this
13423 variable is @code{nil}, there is no upper read bound.  If it is
13424 @code{t}, the backends won't try to read the articles piece by piece,
13425 but read the entire articles.  This makes sense with some versions of
13426 @code{ange-ftp}. 
13427
13428 @item nnheader-head-chop-length
13429 @vindex nnheader-head-chop-length
13430 This variable says how big a piece of each article to read when doing
13431 the operation described above.
13432
13433 @item nnheader-file-name-translation-alist 
13434 @vindex nnheader-file-name-translation-alist 
13435 @cindex file names
13436 @cindex illegal characters in file names
13437 @cindex characters in file names
13438 This is an alist that says how to translate characters in file names.
13439 For instance, if @samp{:} is illegal as a file character in file names
13440 on your system (you OS/2 user you), you could say something like:
13441
13442 @lisp
13443 (setq nnheader-file-name-translation-alist 
13444       '((?: . ?_)))
13445 @end lisp
13446
13447 In fact, this is the default value for this variable on OS/2 and MS
13448 Windows (phooey) systems.
13449
13450 @item gnus-hidden-properties
13451 @vindex gnus-hidden-properties
13452 This is a list of properties to use to hide ``invisible'' text.  It is
13453 @code{(invisible t intangible t)} by default on most systems, which
13454 makes invisible text invisible and intangible.
13455
13456 @item gnus-parse-headers-hook
13457 @vindex gnus-parse-headers-hook
13458 A hook called before parsing headers.  It can be used, for instance, to
13459 gather statistics on the headers fetched, or perhaps you'd like to prune
13460 some headers.  I don't see why you'd want that, though.
13461
13462 @item gnus-shell-command-separator
13463 @vindex gnus-shell-command-separator
13464 String used to separate to shell commands.  The default is @samp{;}. 
13465
13466
13467 @end table
13468
13469
13470 @node The End
13471 @chapter The End
13472
13473 Well, that's the manual---you can get on with your life now.  Keep in
13474 touch.  Say hello to your cats from me.  
13475
13476 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
13477
13478 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13479
13480 @quotation
13481 @strong{Te Deum}
13482
13483 @sp 1
13484 Not because of victories @*
13485 I sing,@*
13486 having none,@*
13487 but for the common sunshine,@*
13488 the breeze,@*
13489 the largess of the spring.
13490
13491 @sp 1
13492 Not for victory@*
13493 but for the day's work done@*
13494 as well as I was able;@*
13495 not for a seat upon the dais@*
13496 but at the common table.@*
13497 @end quotation
13498
13499
13500 @node Appendices
13501 @chapter Appendices
13502
13503 @menu
13504 * History::                        How Gnus got where it is today.
13505 * Terminology::                    We use really difficult, like, words here.
13506 * Customization::                  Tailoring Gnus to your needs.
13507 * Troubleshooting::                What you might try if things do not work.
13508 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
13509 * Emacs for Heathens::             A short introduction to Emacsian terms.
13510 * Frequently Asked Questions::     A question-and-answer session.
13511 @end menu
13512
13513
13514 @node History
13515 @section History
13516
13517 @cindex history
13518 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
13519 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13520
13521 If you want to investigate the person responsible for this outrage, you
13522 can point your (feh!) web browser to
13523 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
13524 distribution point for the new and spiffy versions of Gnus, and is known
13525 as The Site That Destroys Newsrcs And Drives People Mad.
13526
13527 During the first extended alpha period of development, the new Gnus was
13528 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
13529 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13530 (Besides, the ``Gnus'' in this abbreviation should probably be
13531 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13532 appropriate name, don't you think?)
13533
13534 In any case, after spending all that energy on coming up with a new and
13535 spunky name, we decided that the name was @emph{too} spunky, so we
13536 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
13537 ``@sc{gnus}''.  New vs. old.
13538
13539 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13540 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13541 plus 15 Gnus 5.0 releases).
13542
13543 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13544 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13545
13546 On July 28th 1996 work on Red Gnus was begun, and it was released on
13547 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13548
13549 If you happen upon a version of Gnus that has a name that is prefixed --
13550 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13551 don't panic.  Don't let it know that you're frightened.  Back away.
13552 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
13553 out of its reach.  Find a proper released version of Gnus and snuggle up
13554 to that instead.
13555
13556 @menu
13557 * Why?::                What's the point of Gnus?
13558 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
13559 * Conformity::          Gnus tries to conform to all standards.
13560 * Emacsen::             Gnus can be run on a few modern Emacsen.
13561 * Contributors::        Oodles of people.  
13562 * New Features::        Pointers to some of the new stuff in Gnus.
13563 * Newest Features::     Features so new that they haven't been written yet.
13564 @end menu
13565
13566
13567 @node Why?
13568 @subsection Why?
13569
13570 What's the point of Gnus?  
13571
13572 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13573 newsreader, that lets you do anything you can think of.  That was my
13574 original motivation, but while working on Gnus, it has become clear to
13575 me that this generation of newsreaders really belong in the stone age.
13576 Newsreaders haven't developed much since the infancy of the net.  If the
13577 volume continues to rise with the current rate of increase, all current
13578 newsreaders will be pretty much useless.  How do you deal with
13579 newsgroups that have thousands of new articles each day?  How do you
13580 keep track of millions of people who post?
13581
13582 Gnus offers no real solutions to these questions, but I would very much
13583 like to see Gnus being used as a testing ground for new methods of
13584 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
13585 to separate the newsreader from the backends, Gnus now offers a simple
13586 interface for anybody who wants to write new backends for fetching mail
13587 and news from different sources.  I have added hooks for customizations
13588 everywhere I could imagine useful.  By doing so, I'm inviting every one
13589 of you to explore and invent.
13590
13591 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}. 
13592
13593
13594 @node Compatibility
13595 @subsection Compatibility
13596
13597 @cindex compatibility
13598 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
13599 bindings have been kept.  More key bindings have been added, of course,
13600 but only in one or two obscure cases have old bindings been changed.
13601
13602 Our motto is:
13603 @quotation
13604 @cartouche
13605 @center In a cloud bones of steel.
13606 @end cartouche
13607 @end quotation
13608
13609 All commands have kept their names.  Some internal functions have changed
13610 their names.
13611
13612 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13613 Articles}. 
13614
13615 One major compatibility question is the presence of several summary
13616 buffers.  All variables that are relevant while reading a group are
13617 buffer-local to the summary buffer they belong in.  Although many
13618 important variables have their values copied into their global
13619 counterparts whenever a command is executed in the summary buffer, this
13620 change might lead to incorrect values being used unless you are careful.
13621
13622 All code that relies on knowledge of @sc{gnus} internals will probably
13623 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
13624 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
13625 maintains a hash table that points to the entries in this alist (which
13626 speeds up many functions), and changing the alist directly will lead to
13627 peculiar results.
13628
13629 @cindex hilit19
13630 @cindex highlighting
13631 Old hilit19 code does not work at all.  In fact, you should probably
13632 remove all hilit code from all Gnus hooks
13633 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13634 Gnus provides various integrated functions for highlighting.  These are
13635 faster and more accurate.  To make life easier for everybody, Gnus will
13636 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
13637 Away!
13638
13639 Packages like @code{expire-kill} will no longer work.  As a matter of
13640 fact, you should probably remove all old @sc{gnus} packages (and other
13641 code) when you start using Gnus.  More likely than not, Gnus already
13642 does what you have written code to make @sc{gnus} do.  (Snicker.)
13643
13644 Even though old methods of doing things are still supported, only the
13645 new methods are documented in this manual.  If you detect a new method of
13646 doing something while reading this manual, that does not mean you have
13647 to stop doing it the old way.
13648
13649 Gnus understands all @sc{gnus} startup files.
13650
13651 @kindex M-x gnus-bug
13652 @findex gnus-bug
13653 @cindex reporting bugs
13654 @cindex bugs
13655 Overall, a casual user who hasn't written much code that depends on
13656 @sc{gnus} internals should suffer no problems.  If problems occur,
13657 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13658
13659
13660 @node Conformity
13661 @subsection Conformity
13662
13663 No rebels without a clue here, ma'am.  We conform to all standards known
13664 to (wo)man.  Except for those standards and/or conventions we disagree
13665 with, of course.
13666
13667 @table @strong
13668
13669 @item RFC 822
13670 @cindex RFC 822
13671 There are no known breaches of this standard.
13672
13673 @item RFC 1036
13674 @cindex RFC 1036
13675 There are no known breaches of this standard, either.
13676
13677 @item Good Net-Keeping Seal of Approval
13678 @cindex Good Net-Keeping Seal of Approval
13679 Gnus has been through the Seal process and failed.  I think it'll pass
13680 the next inspection.
13681
13682 @item Son-of-RFC 1036
13683 @cindex Son-of-RFC 1036
13684 We do have some breaches to this one.
13685
13686 @table @emph
13687
13688 @item MIME
13689 Gnus does no MIME handling, and this standard-to-be seems to think that
13690 MIME is the bees' knees, so we have major breakage here.
13691
13692 @item X-Newsreader
13693 This is considered to be a ``vanity header'', while I consider it to be
13694 consumer information.  After seeing so many badly formatted articles
13695 coming from @code{tin} and @code{Netscape} I know not to use either of
13696 those for posting articles.  I would not have known that if it wasn't
13697 for the @code{X-Newsreader} header.
13698 @end table
13699
13700 @end table
13701
13702 If you ever notice Gnus acting non-compliantly with regards to the texts
13703 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13704 know.
13705
13706
13707 @node Emacsen
13708 @subsection Emacsen
13709 @cindex Emacsen
13710 @cindex XEmacs
13711 @cindex Mule
13712 @cindex Emacs
13713
13714 Gnus should work on :
13715
13716 @itemize @bullet 
13717
13718 @item
13719 Emacs 19.32 and up.
13720
13721 @item
13722 XEmacs 19.14 and up.
13723
13724 @item 
13725 Mule versions based on Emacs 19.32 and up.
13726
13727 @end itemize
13728
13729 Gnus will absolutely not work on any Emacsen older than that.  Not
13730 reliably, at least. 
13731
13732 There are some vague differences between Gnus on the various
13733 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13734 other than that, things should look pretty much the same under all
13735 Emacsen. 
13736
13737
13738 @node Contributors
13739 @subsection Contributors
13740 @cindex contributors
13741
13742 The new Gnus version couldn't have been done without the help of all the
13743 people on the (ding) mailing list.  Every day for over a year I have
13744 gotten billions of nice bug reports from them, filling me with joy,
13745 every single one of them.  Smooches.  The people on the list have been
13746 tried beyond endurance, what with my ``oh, that's a neat idea <type
13747 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13748 work at all <type type>, yup, I'll ship that one off right away <ship
13749 off> no, wait, that absolutely does not work'' policy for releases.
13750 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
13751 ``worser''? ``much worser''?  ``worsest''?)
13752
13753 I would like to take this opportunity to thank the Academy for...  oops,
13754 wrong show.
13755
13756 @itemize @bullet
13757
13758 @item 
13759 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
13760
13761 @item 
13762 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
13763 well as numerous other things).
13764
13765 @item 
13766 Luis Fernandes---design and graphics.
13767
13768 @item
13769 Erik Naggum---help, ideas, support, code and stuff.
13770
13771 @item 
13772 Wes Hardaker---@file{gnus-picon.el} and the manual section on
13773 @dfn{picons} (@pxref{Picons}).
13774
13775 @item 
13776 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
13777 (@pxref{GroupLens}).
13778
13779 @item 
13780 Sudish Joseph---innumerable bug fixes.
13781
13782 @item 
13783 Ilja Weis---@file{gnus-topic.el}.
13784
13785 @item 
13786 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
13787
13788 @item 
13789 Vladimir Alexiev---the refcard and reference booklets.
13790
13791 @item 
13792 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
13793 distribution by Felix Lee and JWZ.
13794
13795 @item 
13796 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
13797
13798 @item 
13799 Peter Mutsaers---orphan article scoring code.
13800
13801 @item 
13802 Ken Raeburn---POP mail support.
13803
13804 @item 
13805 Hallvard B Furuseth---various bits and pieces, especially dealing with
13806 .newsrc files.
13807
13808 @item 
13809 Brian Edmonds---@file{gnus-bbdb.el}.
13810
13811 @item
13812 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
13813
13814 @item 
13815 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
13816
13817 @item 
13818 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
13819
13820 @item
13821 François Pinard---many, many interesting and thorough bug reports.
13822
13823 @end itemize
13824
13825 The following people have contributed many patches and suggestions: 
13826
13827 Christopher Davis,
13828 Andrew Eskilsson,
13829 Kai Grossjohann,
13830 David KÃ¥gedal,
13831 Richard Pieri,
13832 Fabrice Popineau, 
13833 Daniel Quinlan, 
13834 Jason L. Tibbitts, III,
13835 and
13836 Jack Vinson.
13837
13838 Also thanks to the following for patches and stuff:
13839
13840 Adrian Aichner,
13841 Peter Arius, 
13842 Marc Auslander,
13843 Chris Bone,
13844 Mark Borges,
13845 Lance A. Brown,
13846 Kees de Bruin,
13847 Martin Buchholz,
13848 Kevin Buhr,
13849 Alastair Burt,
13850 Joao Cachopo,
13851 Zlatko Calusic,
13852 Massimo Campostrini,
13853 Michael R. Cook,
13854 Glenn Coombs, 
13855 Frank D. Cringle, 
13856 Geoffrey T. Dairiki,
13857 Andre Deparade,
13858 Ulrik Dickow,
13859 Dave Disser,
13860 Joev Dubach,
13861 Paul Eggert,
13862 Michael Ernst,
13863 Luc Van Eycken,
13864 Sam Falkner,
13865 Paul Franklin, 
13866 David S. Goldberg,
13867 D. Hall, 
13868 Magnus Hammerin,
13869 Raja R. Harinath,
13870 Hisashige Kenji, @c Hisashige
13871 Marc Horowitz,
13872 François Felix Ingrand,
13873 Ishikawa Ichiro, @c Ishikawa
13874 Lee Iverson, 
13875 Rajappa Iyer,
13876 Randell Jesup,
13877 Fred Johansen, 
13878 Greg Klanderman,
13879 Karl Kleinpaste,
13880 Peter Skov Knudsen,
13881 Shuhei Kobayashi, @c Kobayashi
13882 Thor Kristoffersen,
13883 Jens Lautenbacher,
13884 Carsten Leonhardt,
13885 James LewisMoss,
13886 Christian Limpach,
13887 Markus Linnala,
13888 Dave Love,
13889 Tonny Madsen,
13890 Shlomo Mahlab,
13891 Nat Makarevitch,
13892 David Martin,
13893 Timo Metzemakers,
13894 Richard Mlynarik,
13895 Lantz Moore,
13896 Morioka Tomohiko, @c Morioka
13897 Erik Toubro Nielsen,
13898 Hrvoje Niksic,
13899 Andy Norman,
13900 C. R. Oldham,
13901 Alexandre Oliva,
13902 Ken Olstad,
13903 Masaharu Onishi, @c Onishi
13904 Hideki Ono, @c Ono
13905 William Perry,
13906 Stephen Peters,
13907 Ulrich Pfeifer,
13908 John McClary Prevost,
13909 Colin Rafferty,
13910 Bart Robinson,
13911 Jason Rumney,
13912 Loren Schall,
13913 Dan Schmidt,
13914 Ralph Schleicher,
13915 Randal L. Schwartz,
13916 Danny Siu, 
13917 Paul D. Smith,
13918 Jeff Sparkes,
13919 Michael Sperber,
13920 Richard Stallman,
13921 Greg Stark, 
13922 Paul Stodghill,
13923 Kurt Swanson,
13924 Samuel Tardieu, 
13925 Teddy,
13926 Chuck Thompson,
13927 Philippe Troin,
13928 Jan Vroonhof,
13929 Barry A. Warsaw,
13930 Christoph Wedler,
13931 Joe Wells,
13932 and
13933 Katsumi Yamaoka. @c Yamaoka
13934
13935 For a full overview of what each person has done, the ChangeLogs
13936 included in the Gnus alpha distributions should give ample reading
13937 (550kB and counting).
13938
13939 Apologies to everybody that I've forgotten, of which there are many, I'm
13940 sure.  
13941
13942 Gee, that's quite a list of people.  I guess that must mean that there
13943 actually are people who are using Gnus.  Who'd'a thunk it!
13944
13945
13946 @node New Features
13947 @subsection New Features
13948 @cindex new features
13949
13950 @menu
13951 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
13952 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
13953 * Red Gnus::           Third time best---Gnus 5.4/5.5.
13954 @end menu
13955
13956 These lists are, of course, just @emph{short} overviews of the
13957 @emph{most} important new features.  No, really.  There are tons more.
13958 Yes, we have feeping creaturism in full effect.
13959
13960
13961 @node ding Gnus
13962 @subsubsection (ding) Gnus
13963
13964 New features in Gnus 5.0/5.1:
13965
13966 @itemize @bullet
13967
13968 @item
13969 The look of all buffers can be changed by setting format-like variables
13970 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
13971  
13972 @item 
13973 Local spool and several @sc{nntp} servers can be used at once
13974 (@pxref{Select Methods}).  
13975
13976 @item 
13977 You can combine groups into virtual groups (@pxref{Virtual Groups}).
13978
13979 @item 
13980 You can read a number of different mail formats (@pxref{Getting Mail}).
13981 All the mail backends implement a convenient mail expiry scheme
13982 (@pxref{Expiring Mail}). 
13983
13984 @item
13985 Gnus can use various strategies for gathering threads that have lost
13986 their roots (thereby gathering loose sub-threads into one thread) or it
13987 can go back and retrieve enough headers to build a complete thread
13988 (@pxref{Customizing Threading}).
13989
13990 @item 
13991 Killed groups can be displayed in the group buffer, and you can read
13992 them as well (@pxref{Listing Groups}).
13993
13994 @item 
13995 Gnus can do partial group updates---you do not have to retrieve the
13996 entire active file just to check for new articles in a few groups
13997 (@pxref{The Active File}).
13998
13999 @item 
14000 Gnus implements a sliding scale of subscribedness to groups
14001 (@pxref{Group Levels}).
14002
14003 @item 
14004 You can score articles according to any number of criteria
14005 (@pxref{Scoring}).  You can even get Gnus to find out how to score
14006 articles for you (@pxref{Adaptive Scoring}).
14007
14008 @item 
14009 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
14010 manner, so it should be difficult to lose much data on what you have
14011 read if your machine should go down (@pxref{Auto Save}). 
14012
14013 @item 
14014 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
14015 the @file{.emacs} file.
14016
14017 @item 
14018 You can set the process mark on both groups and articles and perform
14019 operations on all the marked items (@pxref{Process/Prefix}).
14020
14021 @item 
14022 You can grep through a subset of groups and create a group from the
14023 results (@pxref{Kibozed Groups}). 
14024
14025 @item 
14026 You can list subsets of groups according to, well, anything
14027 (@pxref{Listing Groups}). 
14028
14029 @item 
14030 You can browse foreign servers and subscribe to groups from those
14031 servers (@pxref{Browse Foreign Server}). 
14032
14033 @item 
14034 Gnus can fetch articles asynchronously on a second connection to the
14035 server (@pxref{Asynchronous Fetching}).
14036
14037 @item 
14038 You can cache articles locally (@pxref{Article Caching}). 
14039
14040 @item 
14041 The uudecode functions have been expanded and generalized
14042 (@pxref{Decoding Articles}). 
14043
14044 @item
14045 You can still post uuencoded articles, which was a little-known feature
14046 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
14047
14048 @item
14049 Fetching parents (and other articles) now actually works without
14050 glitches (@pxref{Finding the Parent}). 
14051
14052 @item
14053 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
14054
14055 @item
14056 Digests (and other files) can be used as the basis for groups
14057 (@pxref{Document Groups}).
14058
14059 @item 
14060 Articles can be highlighted and customized (@pxref{Customizing
14061 Articles}). 
14062
14063 @item 
14064 URLs and other external references can be buttonized (@pxref{Article
14065 Buttons}). 
14066
14067 @item
14068 You can do lots of strange stuff with the Gnus window & frame
14069 configuration (@pxref{Windows Configuration}).
14070
14071 @item
14072 You can click on buttons instead of using the keyboard
14073 (@pxref{Buttons}). 
14074
14075 @end itemize
14076
14077
14078 @node September Gnus
14079 @subsubsection September Gnus
14080
14081 New features in Gnus 5.2/5.3:
14082
14083 @itemize @bullet
14084
14085 @item
14086 A new message composition mode is used.  All old customization variables
14087 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14088 now obsolete.
14089
14090 @item
14091 Gnus is now able to generate @dfn{sparse} threads---threads where
14092 missing articles are represented by empty nodes (@pxref{Customizing
14093 Threading}). 
14094
14095 @lisp
14096 (setq gnus-build-sparse-threads 'some)
14097 @end lisp
14098
14099 @item
14100 Outgoing articles are stored on a special archive server
14101 (@pxref{Archived Messages}). 
14102
14103 @item
14104 Partial thread regeneration now happens when articles are
14105 referred. 
14106
14107 @item
14108 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14109
14110 @item
14111 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
14112
14113 @item
14114 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14115
14116 @lisp
14117 (setq gnus-use-trees t)
14118 @end lisp
14119
14120 @item
14121 An @code{nn}-like pick-and-read minor mode is available for the summary
14122 buffers (@pxref{Pick and Read}).
14123
14124 @lisp
14125 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14126 @end lisp
14127
14128 @item
14129 In binary groups you can use a special binary minor mode (@pxref{Binary
14130 Groups}). 
14131
14132 @item
14133 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14134 Topics}).
14135
14136 @lisp
14137 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14138 @end lisp
14139
14140 @item
14141 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14142
14143 @item
14144 Groups can now have a score, and bubbling based on entry frequency
14145 is possible (@pxref{Group Score}).
14146
14147 @lisp
14148 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14149 @end lisp
14150
14151 @item
14152 Groups can be process-marked, and commands can be performed on
14153 groups of groups (@pxref{Marking Groups}).
14154
14155 @item
14156 Caching is possible in virtual groups.
14157
14158 @item
14159 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14160 news batches, ClariNet briefs collections, and just about everything
14161 else (@pxref{Document Groups}).
14162
14163 @item
14164 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14165 (@pxref{SOUP}).
14166
14167 @item
14168 The Gnus cache is much faster.
14169
14170 @item
14171 Groups can be sorted according to many criteria (@pxref{Sorting
14172 Groups}).
14173
14174 @item
14175 New group parameters have been introduced to set list-address and
14176 expiry times (@pxref{Group Parameters}).
14177
14178 @item
14179 All formatting specs allow specifying faces to be used
14180 (@pxref{Formatting Fonts}).
14181
14182 @item
14183 There are several more commands for setting/removing/acting on process
14184 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14185
14186 @item
14187 The summary buffer can be limited to show parts of the available
14188 articles based on a wide range of criteria.  These commands have been
14189 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14190
14191 @item
14192 Articles can be made persistent with the @kbd{*} command
14193 (@pxref{Persistent Articles}).
14194
14195 @item
14196 All functions for hiding article elements are now toggles.
14197
14198 @item
14199 Article headers can be buttonized (@pxref{Article Washing}).
14200
14201 @lisp
14202 (add-hook 'gnus-article-display-hook 
14203           'gnus-article-add-buttons-to-head)
14204 @end lisp
14205
14206 @item
14207 All mail backends support fetching articles by @code{Message-ID}.
14208
14209 @item
14210 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14211
14212 @item
14213 All summary mode commands are available directly from the article
14214 buffer (@pxref{Article Keymap}). 
14215
14216 @item
14217 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14218 Configuration}).
14219
14220 @item
14221 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14222
14223 @item
14224 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14225
14226 @lisp
14227 (setq gnus-use-nocem t)
14228 @end lisp
14229
14230 @item
14231 Groups can be made permanently visible (@pxref{Listing Groups}).
14232
14233 @lisp
14234 (setq gnus-permanently-visible-groups "^nnml:")
14235 @end lisp
14236
14237 @item
14238 Many new hooks have been introduced to make customizing easier. 
14239
14240 @item
14241 Gnus respects the @code{Mail-Copies-To} header.
14242
14243 @item
14244 Threads can be gathered by looking at the @code{References} header
14245 (@pxref{Customizing Threading}).
14246
14247 @lisp
14248 (setq gnus-summary-thread-gathering-function 
14249       'gnus-gather-threads-by-references)
14250 @end lisp
14251
14252 @item
14253 Read articles can be stored in a special backlog buffer to avoid
14254 refetching (@pxref{Article Backlog}).  
14255
14256 @lisp
14257 (setq gnus-keep-backlog 50)
14258 @end lisp
14259
14260 @item
14261 A clean copy of the current article is always stored in a separate
14262 buffer to allow easier treatment.
14263
14264 @item
14265 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14266
14267 @item
14268 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14269 Articles}). 
14270
14271 @lisp
14272 (setq gnus-prompt-before-saving t)
14273 @end lisp
14274
14275 @item
14276 @code{gnus-uu} can view decoded files asynchronously while fetching
14277 articles (@pxref{Other Decode Variables}). 
14278
14279 @lisp
14280 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14281 @end lisp
14282
14283 @item
14284 Filling in the article buffer now works properly on cited text
14285 (@pxref{Article Washing}).
14286
14287 @item
14288 Hiding cited text adds buttons to toggle hiding, and how much
14289 cited text to hide is now customizable (@pxref{Article Hiding}).
14290
14291 @lisp
14292 (setq gnus-cited-lines-visible 2)
14293 @end lisp
14294
14295 @item
14296 Boring headers can be hidden (@pxref{Article Hiding}).
14297
14298 @lisp
14299 (add-hook 'gnus-article-display-hook 
14300           'gnus-article-hide-boring-headers t)
14301 @end lisp
14302
14303 @item
14304 Default scoring values can now be set from the menu bar.
14305
14306 @item
14307 Further syntax checking of outgoing articles have been added.
14308
14309 @end itemize
14310
14311
14312 @node Red Gnus
14313 @subsubsection Red Gnus
14314
14315 New features in Gnus 5.4/5.5:
14316
14317 @itemize @bullet
14318
14319 @item
14320 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14321
14322 @item
14323 Article prefetching functionality has been moved up into 
14324 Gnus (@pxref{Asynchronous Fetching}).  
14325
14326 @item
14327 Scoring can now be performed with logical operators like @code{and},
14328 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14329 Scoring}).
14330
14331 @item
14332 Article washing status can be displayed in the
14333 article mode line (@pxref{Misc Article}).
14334
14335 @item
14336 @file{gnus.el} has been split into many smaller files.
14337
14338 @item
14339 Suppression of duplicate articles based on Message-ID can be done
14340 (@pxref{Duplicate Suppression}).
14341
14342 @lisp
14343 (setq gnus-suppress-duplicates t)
14344 @end lisp
14345
14346 @item
14347 New variables for specifying what score and adapt files are to be
14348 considered home score and adapt files (@pxref{Home Score File}).
14349
14350 @item
14351 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14352 Server Internals}). 
14353
14354 @item
14355 Groups can inherit group parameters from parent topics (@pxref{Topic
14356 Parameters}).
14357
14358 @item
14359 Article editing has been revamped and is now actually usable.
14360
14361 @item
14362 Signatures can be recognized in more intelligent fashions
14363 (@pxref{Article Signature}).
14364
14365 @item
14366 Summary pick mode has been made to look more @code{nn}-like.  Line
14367 numbers are displayed and the @kbd{.} command can be used to pick
14368 articles (@code{Pick and Read}).
14369
14370 @item
14371 Commands for moving the @file{.newsrc.eld} from one server to
14372 another have been added (@pxref{Changing Servers}).
14373
14374 @item
14375 A way to specify that ``uninteresting'' fields be suppressed when
14376 generating lines in buffers (@pxref{Advanced Formatting}).
14377
14378 @item
14379 Several commands in the group buffer can be undone with @kbd{M-C-_}
14380 (@pxref{Undo}).
14381
14382 @item
14383 Scoring can be done on words using the new score type @code{w}
14384 (@pxref{Score File Format}).
14385
14386 @item
14387 Adaptive scoring can be done on a Subject word-by-word basis
14388 (@pxref{Adaptive Scoring}). 
14389
14390 @lisp
14391 (setq gnus-use-adaptive-scoring '(word))
14392 @end lisp
14393
14394 @item
14395 Scores can be decayed (@pxref{Score Decays}).
14396  
14397 @lisp
14398 (setq gnus-decay-scores t)
14399 @end lisp
14400
14401 @item
14402 Scoring can be performed using a regexp on the Date header.  The Date is
14403 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14404
14405 @item
14406 A new command has been added to remove all data on articles from
14407 the native server (@pxref{Changing Servers}).
14408
14409 @item
14410 A new command for reading collections of documents
14411 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14412 (@pxref{Really Various Summary Commands}). 
14413
14414 @item
14415 Process mark sets can be pushed and popped (@pxref{Setting Process
14416 Marks}).
14417
14418 @item
14419 A new mail-to-news backend makes it possible to post even when the NNTP
14420 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14421
14422 @item
14423 A new backend for reading searches from Web search engines
14424 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14425 (@pxref{Web Searches}).
14426
14427 @item
14428 Groups inside topics can now be sorted using the standard sorting
14429 functions, and each topic can be sorted independently (@pxref{Topic
14430 Sorting}).
14431
14432 @item
14433 Subsets of the groups can be sorted independently (@code{Sorting
14434 Groups}).
14435
14436 @item
14437 Cached articles can be pulled into the groups (@pxref{Summary Generation
14438 Commands}).
14439   
14440 @item
14441 Score files are now applied in a more reliable order (@pxref{Score
14442 Variables}).
14443
14444 @item
14445 Reports on where mail messages end up can be generated (@pxref{Splitting
14446 Mail}).
14447
14448 @item
14449 More hooks and functions have been added to remove junk from incoming
14450 mail before saving the mail (@pxref{Washing Mail}).
14451
14452 @item
14453 Emphasized text can be properly fontisized:
14454
14455 @lisp
14456 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14457 @end lisp
14458  
14459 @end itemize
14460
14461
14462 @node Newest Features
14463 @subsection Newest Features
14464 @cindex todo
14465
14466 Also known as the @dfn{todo list}.  Sure to be implemented before the
14467 next millennium. 
14468
14469 Be afraid.  Be very afraid.
14470
14471 @itemize @bullet
14472 @item
14473 Native @sc{mime} support is something that should be done.  
14474 @item
14475 Really do unbinhexing.
14476 @end itemize
14477
14478 And much, much, much more.  There is more to come than has already been
14479 implemented.  (But that's always true, isn't it?)
14480
14481 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14482 up-to-the-second todo list is located, so if you're really curious, you
14483 could point your Web browser over that-a-way.
14484
14485 @iftex
14486
14487 @node The Manual
14488 @section The Manual
14489 @cindex colophon
14490 @cindex manual
14491
14492 This manual was generated from a TeXinfo file and then run through
14493 either @code{texi2dvi}
14494 @iflatex
14495 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14496 and then run through @code{latex} and @code{dvips} 
14497 @end iflatex
14498 to get what you hold in your hands now.
14499
14500 The following conventions have been used:
14501
14502 @enumerate
14503
14504 @item
14505 This is a @samp{string}
14506
14507 @item
14508 This is a @kbd{keystroke}
14509
14510 @item
14511 This is a @file{file}
14512
14513 @item 
14514 This is a @code{symbol}
14515
14516 @end enumerate
14517
14518 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14519 mean:
14520
14521 @lisp
14522 (setq flargnoze "yes")
14523 @end lisp
14524
14525 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14526
14527 @lisp
14528 (setq flumphel 'yes)
14529 @end lisp
14530
14531 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14532 ever get them confused.
14533
14534 @iflatex
14535 @c @head
14536 Of course, everything in this manual is of vital interest, so you should
14537 read it all.  Several times.  However, if you feel like skimming the
14538 manual, look for that gnu head you should see in the margin over
14539 there---it means that what's being discussed is of more importance than
14540 the rest of the stuff.  (On the other hand, if everything is infinitely
14541 important, how can anything be more important than that?  Just one more
14542 of the mysteries of this world, I guess.)
14543 @end iflatex
14544
14545 @end iftex
14546
14547
14548 @node Terminology
14549 @section Terminology
14550
14551 @cindex terminology
14552 @table @dfn
14553
14554 @item news
14555 @cindex news
14556 This is what you are supposed to use this thing for---reading news.
14557 News is generally fetched from a nearby @sc{nntp} server, and is
14558 generally publicly available to everybody.  If you post news, the entire
14559 world is likely to read just what you have written, and they'll all
14560 snigger mischievously.  Behind your back.
14561
14562 @item mail
14563 @cindex mail
14564 Everything that's delivered to you personally is mail.  Some news/mail
14565 readers (like Gnus) blur the distinction between mail and news, but
14566 there is a difference.  Mail is private.  News is public.  Mailing is
14567 not posting, and replying is not following up.
14568
14569 @item reply
14570 @cindex reply
14571 Send a mail to the person who has written what you are reading.
14572
14573 @item follow up
14574 @cindex follow up
14575 Post an article to the current newsgroup responding to the article you
14576 are reading.
14577
14578 @item backend
14579 @cindex backend
14580 Gnus gets fed articles from a number of backends, both news and mail
14581 backends.  Gnus does not handle the underlying media, so to speak---this
14582 is all done by the backends.
14583
14584 @item native
14585 @cindex native
14586 Gnus will always use one method (and backend) as the @dfn{native}, or
14587 default, way of getting news.
14588
14589 @item foreign
14590 @cindex foreign
14591 You can also have any number of foreign groups active at the same time.
14592 These are groups that use different backends for getting news.
14593
14594 @item secondary
14595 @cindex secondary
14596 Secondary backends are somewhere half-way between being native and being
14597 foreign, but they mostly act like they are native.
14598
14599 @item article
14600 @cindex article
14601 A message that has been posted as news.
14602
14603 @item mail message
14604 @cindex mail message
14605 A message that has been mailed.
14606
14607 @item message 
14608 @cindex message
14609 A mail message or news article
14610
14611 @item head
14612 @cindex head
14613 The top part of a message, where administrative information (etc.) is
14614 put.
14615
14616 @item body
14617 @cindex body
14618 The rest of an article.  Everything that is not in the head is in the
14619 body. 
14620
14621 @item header
14622 @cindex header
14623 A line from the head of an article. 
14624
14625 @item headers
14626 @cindex headers
14627 A collection of such lines, or a collection of heads.  Or even a
14628 collection of @sc{nov} lines.
14629
14630 @item @sc{nov}
14631 @cindex nov
14632 When Gnus enters a group, it asks the backend for the headers of all
14633 unread articles in the group.  Most servers support the News OverView
14634 format, which is more compact and much faster to read and parse than the
14635 normal @sc{head} format.
14636
14637 @item level
14638 @cindex levels
14639 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
14640 that have a lower level are ``more'' subscribed than the groups with a
14641 higher level.  In fact, groups on levels 1-5 are considered
14642 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14643 are @dfn{killed}.  Commands for listing groups and scanning for new
14644 articles will all use the numeric prefix as @dfn{working level}.
14645
14646 @item killed groups
14647 @cindex killed groups
14648 No information on killed groups is stored or updated, which makes killed
14649 groups much easier to handle than subscribed groups.
14650
14651 @item zombie groups
14652 @cindex zombie groups
14653 Just like killed groups, only slightly less dead.
14654
14655 @item active file
14656 @cindex active file
14657 The news server has to keep track of what articles it carries, and what
14658 groups exist.  All this information in stored in the active file, which
14659 is rather large, as you might surmise.
14660
14661 @item bogus groups
14662 @cindex bogus groups
14663 A group that exists in the @file{.newsrc} file, but isn't known to the
14664 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
14665 This means that the group probably doesn't exist (any more).
14666
14667 @item server 
14668 @cindex server
14669 A machine than one can connect to and get news (or mail) from.
14670
14671 @item select method
14672 @cindex select method
14673 A structure that specifies the backend, the server and the virtual
14674 server parameters.
14675
14676 @item virtual server
14677 @cindex virtual server
14678 A named select method.  Since a select methods defines all there is to
14679 know about connecting to a (physical) server, taking the things as a
14680 whole is a virtual server.
14681
14682 @item washing
14683 @cindex washing
14684 Taking a buffer and running it through a filter of some sort.  The
14685 result will (more often than not) be cleaner and more pleasing than the
14686 original. 
14687
14688 @item ephemeral groups
14689 @cindex ephemeral groups
14690 Most groups store data on what articles you have read.  @dfn{Ephemeral}
14691 groups are groups that will have no data stored---when you exit the
14692 group, it'll disappear into the aether.  
14693
14694 @item solid groups
14695 @cindex solid groups
14696 This is the opposite of ephemeral groups.  All groups listed in the
14697 group buffer are solid groups.
14698
14699 @item sparse articles
14700 @cindex sparse articles
14701 These are article placeholders shown in the summary buffer when
14702 @code{gnus-build-sparse-threads} has been switched on.
14703
14704 @end table
14705
14706
14707 @node Customization
14708 @section Customization
14709 @cindex general customization
14710
14711 All variables are properly documented elsewhere in this manual.  This
14712 section is designed to give general pointers on how to customize Gnus
14713 for some quite common situations.
14714
14715 @menu
14716 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14717 * Slow Terminal Connection::  You run a remote Emacs.
14718 * Little Disk Space::         You feel that having large setup files is icky.
14719 * Slow Machine::              You feel like buying a faster machine.
14720 @end menu
14721
14722
14723 @node Slow/Expensive Connection
14724 @subsection Slow/Expensive @sc{nntp} Connection
14725
14726 If you run Emacs on a machine locally, and get your news from a machine
14727 over some very thin strings, you want to cut down on the amount of data
14728 Gnus has to get from the @sc{nntp} server.
14729
14730 @table @code
14731
14732 @item gnus-read-active-file
14733 Set this to @code{nil}, which will inhibit Gnus from requesting the
14734 entire active file from the server.  This file is often v.  large.  You
14735 also have to set @code{gnus-check-new-newsgroups} and
14736 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
14737 doesn't suddenly decide to fetch the active file anyway.
14738
14739 @item gnus-nov-is-evil
14740 This one has to be @code{nil}.  If not, grabbing article headers from
14741 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
14742 support @sc{xover}; Gnus will detect this by itself.
14743 @end table
14744
14745
14746 @node Slow Terminal Connection
14747 @subsection Slow Terminal Connection
14748
14749 Let's say you use your home computer for dialing up the system that
14750 runs Emacs and Gnus.  If your modem is slow, you want to reduce the
14751 amount of data that is sent over the wires as much as possible.
14752
14753 @table @code
14754
14755 @item gnus-auto-center-summary
14756 Set this to @code{nil} to inhibit Gnus from re-centering the summary
14757 buffer all the time.  If it is @code{vertical}, do only vertical
14758 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
14759 horizontal and vertical recentering.
14760
14761 @item gnus-visible-headers
14762 Cut down on the headers that are included in the articles to the
14763 minimum.  You can, in fact, make do without them altogether---most of the
14764 useful data is in the summary buffer, anyway.  Set this variable to
14765 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
14766
14767 @item gnus-article-display-hook
14768 Set this hook to all the available hiding commands:
14769 @lisp
14770 (setq gnus-article-display-hook 
14771       '(gnus-article-hide-headers gnus-article-hide-signature
14772         gnus-article-hide-citation))
14773 @end lisp
14774
14775 @item gnus-use-full-window
14776 By setting this to @code{nil}, you can make all the windows smaller.
14777 While this doesn't really cut down much generally, it means that you
14778 have to see smaller portions of articles before deciding that you didn't
14779 want to read them anyway.
14780
14781 @item gnus-thread-hide-subtree
14782 If this is non-@code{nil}, all threads in the summary buffer will be
14783 hidden initially.
14784
14785 @item gnus-updated-mode-lines
14786 If this is @code{nil}, Gnus will not put information in the buffer mode
14787 lines, which might save some time.
14788 @end table
14789
14790
14791 @node Little Disk Space
14792 @subsection Little Disk Space
14793 @cindex disk space
14794
14795 The startup files can get rather large, so you may want to cut their
14796 sizes a bit if you are running out of space.
14797
14798 @table @code
14799
14800 @item gnus-save-newsrc-file
14801 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
14802 only save @file{.newsrc.eld}.  This means that you will not be able to
14803 use any other newsreaders than Gnus.  This variable is @code{t} by
14804 default. 
14805
14806 @item gnus-save-killed-list
14807 If this is @code{nil}, Gnus will not save the list of dead groups.  You
14808 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
14809 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
14810 variable to @code{nil}.  This variable is @code{t} by default.
14811
14812 @end table
14813
14814
14815 @node Slow Machine
14816 @subsection Slow Machine
14817 @cindex slow machine
14818
14819 If you have a slow machine, or are just really impatient, there are a
14820 few things you can do to make Gnus run faster.
14821
14822 Set@code{gnus-check-new-newsgroups} and
14823 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
14824
14825 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
14826 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
14827 summary buffer faster.
14828
14829 Set @code{gnus-article-display-hook} to @code{nil} to make article
14830 processing a bit faster.
14831
14832
14833 @node Troubleshooting
14834 @section Troubleshooting
14835 @cindex troubleshooting
14836
14837 Gnus works @emph{so} well straight out of the box---I can't imagine any
14838 problems, really.
14839
14840 Ahem.
14841
14842 @enumerate
14843
14844 @item
14845 Make sure your computer is switched on.
14846
14847 @item
14848 Make sure that you really load the current Gnus version.  If you have
14849 been running @sc{gnus}, you need to exit Emacs and start it up again before
14850 Gnus will work.
14851
14852 @item
14853 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
14854 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
14855 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
14856 flee}, you have some old @file{.el} files lying around.  Delete these.
14857
14858 @item
14859 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
14860 how-to. 
14861
14862 @item
14863 @vindex max-lisp-eval-depth
14864 Gnus works on many recursive structures, and in some extreme (and very
14865 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
14866 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
14867 something like that.
14868 @end enumerate
14869
14870 If all else fails, report the problem as a bug.
14871
14872 @cindex bugs
14873 @cindex reporting bugs
14874
14875 @kindex M-x gnus-bug
14876 @findex gnus-bug
14877 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
14878 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
14879 me the backtrace.  I will fix bugs, but I can only fix them if you send
14880 me a precise description as to how to reproduce the bug.
14881
14882 You really can never be too detailed in a bug report.  Always use the
14883 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
14884 a 10Kb mail each time you use it, and even if you have sent me your
14885 environment 500 times before.  I don't care.  I want the full info each
14886 time.  
14887
14888 It is also important to remember that I have no memory whatsoever.  If
14889 you send a bug report, and I send you a reply, and then you send back
14890 just ``No, it's not! Moron!'', I will have no idea what you are
14891 insulting me about.  Always over-explain everything.  It's much easier
14892 for all of us---if I don't have all the information I need, I will just
14893 mail you and ask for more info, and everything takes more time.
14894
14895 If the problem you're seeing is very visual, and you can't quite explain
14896 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
14897 it somewhere it can be reached, and include the URL of the picture in
14898 the bug report.
14899
14900 If you just need help, you are better off asking on
14901 @samp{gnu.emacs.gnus}.  I'm not very helpful.
14902
14903 @cindex gnu.emacs.gnus
14904 @cindex ding mailing list
14905 You can also ask on the ding mailing list---@samp{ding@@ifi.uio.no}.
14906 Write to @samp{ding-request@@ifi.uio.no} to subscribe.
14907
14908
14909 @node A Programmers Guide to Gnus
14910 @section A Programmer@'s Guide to Gnus
14911
14912 It is my hope that other people will figure out smart stuff that Gnus
14913 can do, and that other people will write those smart things as well.  To
14914 facilitate that I thought it would be a good idea to describe the inner
14915 workings of Gnus.  And some of the not-so-inner workings, while I'm at
14916 it.
14917
14918 You can never expect the internals of a program not to change, but I
14919 will be defining (in some details) the interface between Gnus and its
14920 backends (this is written in stone), the format of the score files
14921 (ditto), data structures (some are less likely to change than others)
14922 and general method of operations.
14923
14924 @menu 
14925 * Backend Interface::        How Gnus communicates with the servers.
14926 * Score File Syntax::        A BNF definition of the score file standard.
14927 * Headers::                  How Gnus stores headers internally.
14928 * Ranges::                   A handy format for storing mucho numbers.
14929 * Group Info::               The group info format.
14930 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
14931 * Various File Formats::     Formats of files that Gnus use.
14932 @end menu
14933
14934
14935 @node Backend Interface
14936 @subsection Backend Interface
14937
14938 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
14939 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
14940 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
14941 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
14942 examples of the latter we have @code{nntp-port-number} and
14943 @code{nnmbox-directory}.
14944
14945 When Gnus asks for information from a backend---say @code{nntp}---on
14946 something, it will normally include a virtual server name in the
14947 function parameters.  (If not, the backend should use the ``current''
14948 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
14949 server as its only (optional) parameter.  If this virtual server hasn't
14950 been opened, the function should fail.
14951
14952 Note that a virtual server name has no relation to some physical server
14953 name.  Take this example:
14954
14955 @lisp
14956 (nntp "odd-one" 
14957       (nntp-address "ifi.uio.no") 
14958       (nntp-port-number 4324))
14959 @end lisp
14960
14961 Here the virtual server name is @samp{odd-one} while the name of
14962 the physical server is @samp{ifi.uio.no}. 
14963
14964 The backends should be able to switch between several virtual servers.
14965 The standard backends implement this by keeping an alist of virtual
14966 server environments that it pulls down/pushes up when needed.  
14967
14968 There are two groups of interface functions: @dfn{required functions},
14969 which must be present, and @dfn{optional functions}, which Gnus will
14970 always check whether are present before attempting to call.
14971
14972 All these functions are expected to return data in the buffer
14973 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
14974 unfortunately named, but we'll have to live with it.  When I talk about
14975 @dfn{resulting data}, I always refer to the data in that buffer.  When I
14976 talk about @dfn{return value}, I talk about the function value returned by
14977 the function call.  Functions that fail should return @code{nil} as the
14978 return value.
14979
14980 Some backends could be said to be @dfn{server-forming} backends, and
14981 some might be said to not be.  The latter are backends that generally
14982 only operate on one group at a time, and have no concept of ``server''
14983 -- they have a group, and they deliver info on that group and nothing
14984 more.
14985
14986 In the examples and definitions I will refer to the imaginary backend
14987 @code{nnchoke}. 
14988
14989 @cindex @code{nnchoke}
14990
14991 @menu
14992 * Required Backend Functions::        Functions that must be implemented.
14993 * Optional Backend Functions::        Functions that need not be implemented.
14994 * Error Messaging::                   How to get messages and report errors.
14995 * Writing New Backends::              Extending old backends.
14996 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
14997 * Mail-like Backends::                Some tips on mail backends.
14998 @end menu
14999
15000
15001 @node Required Backend Functions
15002 @subsubsection Required Backend Functions
15003
15004 @table @code
15005
15006 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
15007
15008 @var{articles} is either a range of article numbers or a list of
15009 @code{Message-ID}s.  Current backends do not fully support either---only
15010 sequences (lists) of article numbers, and most backends do not support
15011 retrieval of @code{Message-ID}s.  But they should try for both. 
15012
15013 The result data should either be HEADs or NOV lines, and the result
15014 value should either be @code{headers} or @code{nov} to reflect this.
15015 This might later be expanded to @code{various}, which will be a mixture
15016 of HEADs and NOV lines, but this is currently not supported by Gnus.  
15017
15018 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
15019 headers, in some meaning of the word.  This is generally done by
15020 fetching (at most) @var{fetch-old} extra headers less than the smallest
15021 article number in @code{articles}, and fill in the gaps as well.  The
15022 presence of this parameter can be ignored if the backend finds it
15023 cumbersome to follow the request.  If this is non-@code{nil} and not a
15024 number, do maximum fetches.
15025
15026 Here's an example HEAD:
15027
15028 @example
15029 221 1056 Article retrieved.
15030 Path: ifi.uio.no!sturles
15031 From: sturles@@ifi.uio.no (Sturle Sunde)
15032 Newsgroups: ifi.discussion
15033 Subject: Re: Something very droll
15034 Date: 27 Oct 1994 14:02:57 +0100
15035 Organization: Dept. of Informatics, University of Oslo, Norway
15036 Lines: 26
15037 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
15038 References: <38jdmq$4qu@@visbur.ifi.uio.no>
15039 NNTP-Posting-Host: holmenkollen.ifi.uio.no
15040 .
15041 @end example
15042
15043 So a @code{headers} return value would imply that there's a number of
15044 these in the data buffer.
15045
15046 Here's a BNF definition of such a buffer:
15047
15048 @example
15049 headers        = *head
15050 head           = error / valid-head
15051 error-message  = [ "4" / "5" ] 2number " " <error message> eol
15052 valid-head     = valid-message *header "." eol
15053 valid-message  = "221 " <number> " Article retrieved." eol
15054 header         = <text> eol
15055 @end example
15056
15057 If the return value is @code{nov}, the data buffer should contain
15058 @dfn{network overview database} lines.  These are basically fields
15059 separated by tabs. 
15060
15061 @example
15062 nov-buffer = *nov-line
15063 nov-line   = 8*9 [ field <TAB> ] eol
15064 field      = <text except TAB>
15065 @end example
15066
15067 For a closer explanation what should be in those fields,
15068 @pxref{Headers}. 
15069
15070
15071 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
15072
15073 @var{server} is here the virtual server name.  @var{definitions} is a
15074 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server. 
15075
15076 If the server can't be opened, no error should be signaled.  The backend
15077 may then choose to refuse further attempts at connecting to this
15078 server.  In fact, it should do so. 
15079
15080 If the server is opened already, this function should return a
15081 non-@code{nil} value.  There should be no data returned.
15082
15083
15084 @item (nnchoke-close-server &optional SERVER)
15085
15086 Close connection to @var{server} and free all resources connected
15087 to it.  Return @code{nil} if the server couldn't be closed for some
15088 reason.
15089
15090 There should be no data returned.
15091
15092
15093 @item (nnchoke-request-close)
15094
15095 Close connection to all servers and free all resources that the backend
15096 have reserved.  All buffers that have been created by that backend
15097 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
15098 function is generally only called when Gnus is shutting down.
15099
15100 There should be no data returned. 
15101
15102
15103 @item (nnchoke-server-opened &optional SERVER)
15104
15105 If @var{server} is the current virtual server, and the connection to the
15106 physical server is alive, then this function should return a
15107 non-@code{nil} vlue.  This function should under no circumstances
15108 attempt to reconnect to a server that is has lost connection to.
15109
15110 There should be no data returned.
15111
15112
15113 @item (nnchoke-status-message &optional SERVER)
15114
15115 This function should return the last error message from @var{server}. 
15116
15117 There should be no data returned.
15118
15119
15120 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15121
15122 The result data from this function should be the article specified by
15123 @var{article}.  This might either be a @code{Message-ID} or a number.
15124 It is optional whether to implement retrieval by @code{Message-ID}, but
15125 it would be nice if that were possible.
15126
15127 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15128 in this buffer instead of the normal data buffer.  This is to make it
15129 possible to avoid copying large amounts of data from one buffer to
15130 another, and Gnus mainly request articles to be inserted directly into
15131 its article buffer.
15132
15133 If it is at all possible, this function should return a cons cell where
15134 the car is the group name the article was fetched from, and the cdr is
15135 the article number.  This will enable Gnus to find out what the real
15136 group and article numbers are when fetching articles by
15137 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
15138 on successful article retrievement.
15139
15140
15141 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15142
15143 Get data on @var{group}.  This function also has the side effect of
15144 making @var{group} the current group. 
15145
15146 If @var{FAST}, don't bother to return useful data, just make @var{group}
15147 the current group.
15148
15149 Here's an example of some result data and a definition of the same:
15150
15151 @example
15152 211 56 1000 1059 ifi.discussion
15153 @end example
15154
15155 The first number is the status, which should be 211.  Next is the
15156 total number of articles in the group, the lowest article number, the
15157 highest article number, and finally the group name.  Note that the total
15158 number of articles may be less than one might think while just
15159 considering the highest and lowest article numbers, but some articles
15160 may have been canceled.  Gnus just discards the total-number, so
15161 whether one should take the bother to generate it properly (if that is a
15162 problem) is left as an exercise to the reader.
15163
15164 @example
15165 group-status = [ error / info ] eol
15166 error        = [ "4" / "5" ] 2<number> " " <Error message>
15167 info         = "211 " 3* [ <number> " " ] <string>
15168 @end example
15169
15170
15171 @item (nnchoke-close-group GROUP &optional SERVER)
15172
15173 Close @var{group} and free any resources connected to it.  This will be
15174 a no-op on most backends. 
15175
15176 There should be no data returned.
15177
15178
15179 @item (nnchoke-request-list &optional SERVER)
15180
15181 Return a list of all groups available on @var{server}.  And that means
15182 @emph{all}. 
15183
15184 Here's an example from a server that only carries two groups:
15185
15186 @example
15187 ifi.test 0000002200 0000002000 y
15188 ifi.discussion 3324 3300 n
15189 @end example
15190
15191 On each line we have a group name, then the highest article number in
15192 that group, the lowest article number, and finally a flag.
15193
15194 @example
15195 active-file = *active-line
15196 active-line = name " " <number> " " <number> " " flags eol
15197 name        = <string>
15198 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
15199 @end example
15200
15201 The flag says whether the group is read-only (@samp{n}), is moderated
15202 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15203 (@samp{=other-group} or none of the above (@samp{y}). 
15204
15205
15206 @item (nnchoke-request-post &optional SERVER)
15207
15208 This function should post the current buffer.  It might return whether
15209 the posting was successful or not, but that's not required.  If, for
15210 instance, the posting is done asynchronously, it has generally not been
15211 completed by the time this function concludes.  In that case, this
15212 function should set up some kind of sentinel to beep the user loud and
15213 clear if the posting could not be completed.
15214
15215 There should be no result data from this function. 
15216
15217 @end table
15218
15219
15220 @node Optional Backend Functions
15221 @subsubsection Optional Backend Functions
15222
15223 @table @code
15224
15225 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15226
15227 @var{groups} is a list of groups, and this function should request data
15228 on all those groups.  How it does it is of no concern to Gnus, but it
15229 should attempt to do this in a speedy fashion.
15230
15231 The return value of this function can be either @code{active} or
15232 @code{group}, which says what the format of the result data is.  The
15233 former is in the same format as the data from
15234 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15235 in the same format as @code{nnchoke-request-group} gives.
15236
15237 @example
15238 group-buffer = *active-line / *group-status
15239 @end example
15240
15241
15242 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15243
15244 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15245 alterations.  This comes in handy if the backend really carries all the
15246 information (as is the case with virtual and imap groups).  This
15247 function should destructively alter the info to suit its needs, and
15248 should return the (altered) group info.
15249
15250 There should be no result data from this function.
15251
15252
15253 @item (nnchoke-request-type GROUP &optional ARTICLE)
15254
15255 When the user issues commands for ``sending news'' (@kbd{F} in the
15256 summary buffer, for instance), Gnus has to know whether the article the
15257 user is following up is news or mail.  This function should return
15258 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15259 is mail and @code{unknown} if the type can't be decided.  (The
15260 @var{article} parameter is necessary in @code{nnvirtual} groups which
15261 might very well combine mail groups and news groups.)  Both @var{group}
15262 and @var{article} may be @code{nil}.
15263
15264 There should be no result data from this function.
15265
15266
15267 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15268
15269 If the user tries to set a mark that the backend doesn't like, this
15270 function may change the mark.  Gnus will use whatever this function
15271 returns as the mark for @var{article} instead of the original
15272 @var{mark}.  If the backend doesn't care, it must return the original
15273 @var{mark}, and not @code{nil} or any other type of garbage.  
15274
15275 The only use for this that I can see is what @code{nnvirtual} does with
15276 it---if a component group is auto-expirable, marking an article as read
15277 in the virtual group should result in the article being marked as
15278 expirable. 
15279
15280 There should be no result data from this function.
15281
15282
15283 @item (nnchoke-request-scan &optional GROUP SERVER)
15284
15285 This function may be called at any time (by Gnus or anything else) to
15286 request that the backend check for incoming articles, in one way or
15287 another.  A mail backend will typically read the spool file or query the
15288 POP server when this function is invoked.  The @var{group} doesn't have
15289 to be heeded---if the backend decides that it is too much work just
15290 scanning for a single group, it may do a total scan of all groups.  It
15291 would be nice, however, to keep things local if that's practical.
15292
15293 There should be no result data from this function.
15294
15295
15296 @item (nnchoke-request-group-description GROUP &optional SERVER)
15297
15298 The result data from this function should be a description of
15299 @var{group}. 
15300
15301 @example
15302 description-line = name <TAB> description eol
15303 name             = <string>
15304 description      = <text>
15305 @end example
15306
15307 @item (nnchoke-request-list-newsgroups &optional SERVER)
15308
15309 The result data from this function should be the description of all
15310 groups available on the server.
15311
15312 @example
15313 description-buffer = *description-line
15314 @end example
15315
15316
15317 @item (nnchoke-request-newgroups DATE &optional SERVER)
15318
15319 The result data from this function should be all groups that were
15320 created after @samp{date}, which is in normal human-readable date
15321 format.  The data should be in the active buffer format.
15322
15323
15324 @item (nnchoke-request-create-group GROUP &optional SERVER)
15325
15326 This function should create an empty group with name @var{group}.  
15327
15328 There should be no return data.
15329
15330
15331 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15332
15333 This function should run the expiry process on all articles in the
15334 @var{articles} range (which is currently a simple list of article
15335 numbers.)  It is left up to the backend to decide how old articles
15336 should be before they are removed by this function.  If @var{force} is
15337 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15338 they are. 
15339
15340 This function should return a list of articles that it did not/was not
15341 able to delete.
15342
15343 There should be no result data returned.
15344
15345
15346 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15347 &optional LAST)
15348
15349 This function should move @var{article} (which is a number) from
15350 @var{group} by calling @var{accept-form}.  
15351
15352 This function should ready the article in question for moving by
15353 removing any header lines it has added to the article, and generally
15354 should ``tidy up'' the article.  Then it should @code{eval}
15355 @var{accept-form} in the buffer where the ``tidy'' article is.  This
15356 will do the actual copying.  If this @code{eval} returns a
15357 non-@code{nil} value, the article should be removed.
15358
15359 If @var{last} is @code{nil}, that means that there is a high likelihood
15360 that there will be more requests issued shortly, so that allows some
15361 optimizations. 
15362
15363 The function should return a cons where the car is the group name and
15364 the cdr is the article number that the article was entered as.
15365
15366 There should be no data returned. 
15367
15368
15369 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15370
15371 This function takes the current buffer and inserts it into @var{group}.
15372 If @var{last} in @code{nil}, that means that there will be more calls to
15373 this function in short order.
15374
15375 The function should return a cons where the car is the group name and
15376 the cdr is the article number that the article was entered as.
15377
15378 There should be no data returned.
15379
15380
15381 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15382
15383 This function should remove @var{article} (which is a number) from
15384 @var{group} and insert @var{buffer} there instead.
15385
15386 There should be no data returned.
15387
15388
15389 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15390
15391 This function should delete @var{group}.  If @var{force}, it should
15392 really delete all the articles in the group, and then delete the group
15393 itself.  (If there is such a thing as ``the group itself''.)
15394
15395 There should be no data returned.
15396
15397
15398 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15399
15400 This function should rename @var{group} into @var{new-name}.  All
15401 articles that are in @var{group} should move to @var{new-name}.
15402
15403 There should be no data returned.
15404
15405 @end table
15406
15407
15408 @node Error Messaging
15409 @subsubsection Error Messaging
15410
15411 @findex nnheader-report
15412 @findex nnheader-get-report
15413 The backends should use the function @code{nnheader-report} to report
15414 error conditions---they should not raise errors when they aren't able to
15415 perform a request.  The first argument to this function is the backend
15416 symbol, and the rest are interpreted as arguments to @code{format} if
15417 there are many of them, or just a string if there is one of them.
15418 This function always returns @code{nil}.
15419
15420 @lisp
15421 (nnheader-report 'nnchoke "You did something totally bogus")
15422
15423 (nnheader-report 'nnchoke "Could not request group %s" group)
15424 @end lisp
15425
15426 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15427 @code{nil} back from a server, and this function returns the most
15428 recently reported message for the backend in question.  This function
15429 takes one argument---the server symbol.
15430
15431 Internally, these function access @var{backend}@code{-status-string}, so
15432 the @code{nnchoke} backend will have its error message stored in
15433 @code{nnchoke-status-string}. 
15434
15435
15436 @node Writing New Backends
15437 @subsubsection Writing New Backends
15438
15439 Many backends are quite similar.  @code{nnml} is just like
15440 @code{nnspool}, but it allows you to edit the articles on the server.
15441 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15442 and it doesn't maintain overview databases.  @code{nndir} is just like
15443 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15444 editing articles.
15445
15446 It would make sense if it were possible to ``inherit'' functions from
15447 backends when writing new backends.  And, indeed, you can do that if you
15448 want to.  (You don't have to if you don't want to, of course.)  
15449
15450 All the backends declare their public variables and functions by using a
15451 package called @code{nnoo}.  
15452
15453 To inherit functions from other backends (and allow other backends to
15454 inherit functions from the current backend), you should use the
15455 following macros:
15456 following. 
15457
15458 @table @code
15459
15460 @item nnoo-declare
15461 This macro declares the first parameter to be a child of the subsequent
15462 parameters.  For instance:
15463
15464 @lisp
15465 (nnoo-declare nndir
15466   nnml nnmh)
15467 @end lisp
15468
15469 @code{nndir} has here declared that it intends to inherit functions from
15470 both @code{nnml} and @code{nnmh}.
15471
15472 @item defvoo
15473 This macro is equivalent to @code{defvar}, but registers the variable as
15474 a public server variable.  Most state-oriented variables should be
15475 declared with @code{defvoo} instead of @code{defvar}.  
15476
15477 In addition to the normal @code{defvar} parameters, it takes a list of
15478 variables in the parent backends to map the variable to when executing
15479 a function in those backends.
15480
15481 @lisp
15482 (defvoo nndir-directory nil
15483   "Where nndir will look for groups."
15484   nnml-current-directory nnmh-current-directory)
15485 @end lisp
15486
15487 This means that @code{nnml-current-directory} will be set to
15488 @code{nndir-directory} when an @code{nnml} function is called on behalf
15489 of @code{nndir}.  (The same with @code{nnmh}.)  
15490
15491 @item nnoo-define-basics
15492 This macro defines some common functions that almost all backends should
15493 have.
15494
15495 @example
15496 (nnoo-define-basics nndir)
15497 @end example
15498
15499 @item deffoo
15500 This macro is just like @code{defun} and takes the same parameters.  In
15501 addition to doing the normal @code{defun} things, it registers the
15502 function as being public so that other backends can inherit it.
15503
15504 @item nnoo-map-functions
15505 This macro allows mapping of functions from the current backend to
15506 functions from the parent backends.
15507
15508 @example
15509 (nnoo-map-functions nndir
15510   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15511   (nnmh-request-article 0 nndir-current-group 0 0))
15512 @end example
15513
15514 This means that when @code{nndir-retrieve-headers} is called, the first,
15515 third, and fourth parameters will be passed on to
15516 @code{nnml-retrieve-headers}, while the second parameter is set to the
15517 value of @code{nndir-current-group}.
15518
15519 @item nnoo-import
15520 This macro allows importing functions from backends.  It should be the
15521 last thing in the source file, since it will only define functions that
15522 haven't already been defined.
15523
15524 @example
15525 (nnoo-import nndir
15526   (nnmh
15527    nnmh-request-list
15528    nnmh-request-newgroups)
15529   (nnml))
15530 @end example
15531
15532 This means that calls to @code{nndir-request-list} should just be passed
15533 on to @code{nnmh-request-list}, while all public functions from
15534 @code{nnml} that haven't been defined in @code{nndir} yet should be
15535 defined now.
15536
15537 @end table
15538
15539 Below is a slightly shortened version of the @code{nndir} backend.
15540
15541 @lisp
15542 ;;; nndir.el --- single directory newsgroup access for Gnus
15543 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15544
15545 ;;; Code:
15546
15547 (require 'nnheader)
15548 (require 'nnmh)
15549 (require 'nnml)
15550 (require 'nnoo)
15551 (eval-when-compile (require 'cl))
15552
15553 (nnoo-declare nndir
15554   nnml nnmh)
15555
15556 (defvoo nndir-directory nil
15557   "Where nndir will look for groups."
15558   nnml-current-directory nnmh-current-directory)
15559
15560 (defvoo nndir-nov-is-evil nil
15561   "*Non-nil means that nndir will never retrieve NOV headers."
15562   nnml-nov-is-evil)
15563
15564 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15565 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15566 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15567
15568 (defvoo nndir-status-string "" nil nnmh-status-string)
15569 (defconst nndir-version "nndir 1.0")
15570
15571 ;;; Interface functions.
15572
15573 (nnoo-define-basics nndir)
15574
15575 (deffoo nndir-open-server (server &optional defs)
15576   (setq nndir-directory
15577         (or (cadr (assq 'nndir-directory defs))
15578             server))
15579   (unless (assq 'nndir-directory defs)
15580     (push `(nndir-directory ,server) defs))
15581   (push `(nndir-current-group
15582           ,(file-name-nondirectory (directory-file-name nndir-directory)))
15583         defs)
15584   (push `(nndir-top-directory
15585           ,(file-name-directory (directory-file-name nndir-directory)))
15586         defs)
15587   (nnoo-change-server 'nndir server defs))
15588
15589 (nnoo-map-functions nndir
15590   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15591   (nnmh-request-article 0 nndir-current-group 0 0)
15592   (nnmh-request-group nndir-current-group 0 0)
15593   (nnmh-close-group nndir-current-group 0))
15594
15595 (nnoo-import nndir
15596   (nnmh
15597    nnmh-status-message
15598    nnmh-request-list
15599    nnmh-request-newgroups))
15600
15601 (provide 'nndir)
15602 @end lisp
15603
15604
15605 @node Hooking New Backends Into Gnus
15606 @subsubsection Hooking New Backends Into Gnus
15607
15608 @vindex gnus-valid-select-methods
15609 Having Gnus start using your new backend is rather easy---you just
15610 declare it with the @code{gnus-declare-backend} functions.  This will
15611 enter the backend into the @code{gnus-valid-select-methods} variable.
15612
15613 @code{gnus-declare-backend} takes two parameters---the backend name and
15614 an arbitrary number of @dfn{abilities}.
15615
15616 Here's an example:
15617
15618 @lisp
15619 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15620 @end lisp
15621
15622 The abilities can be:
15623
15624 @table @code
15625 @item mail
15626 This is a mailish backend---followups should (probably) go via mail.
15627 @item post
15628 This is a newsish backend---followups should (probably) go via news. 
15629 @item post-mail
15630 This backend supports both mail and news.
15631 @item none
15632 This is neither a post or mail backend---it's something completely
15633 different. 
15634 @item respool
15635 It supports respooling---or rather, it is able to modify its source
15636 articles and groups.
15637 @item address
15638 The name of the server should be in the virtual server name.  This is
15639 true for almost all backends.
15640 @item prompt-address
15641 The user should be prompted for an address when doing commands like
15642 @kbd{B} in the group buffer.  This is true for backends like
15643 @code{nntp}, but not @code{nnmbox}, for instance. 
15644 @end table
15645
15646
15647 @node Mail-like Backends
15648 @subsubsection Mail-like Backends
15649
15650 One of the things that separate the mail backends from the rest of the
15651 backends is the heavy dependence by the mail backends on common
15652 functions in @file{nnmail.el}.  For instance, here's the definition of
15653 @code{nnml-request-scan}: 
15654
15655 @lisp
15656 (deffoo nnml-request-scan (&optional group server)
15657   (setq nnml-article-file-alist nil)
15658   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
15659 @end lisp
15660
15661 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
15662 and @code{nnmail} takes care of all the moving and splitting of the
15663 mail.  
15664
15665 This function takes four parameters.
15666
15667 @table @var
15668 @item method
15669 This should be a symbol to designate which backend is responsible for
15670 the call.
15671
15672 @item exit-function
15673 This function should be called after the splitting has been performed.
15674
15675 @item temp-directory
15676 Where the temporary files should be stored.
15677
15678 @item group
15679 This optional argument should be a group name if the splitting is to be
15680 performed for one group only.
15681 @end table
15682
15683 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
15684 save each article.  @var{backend}@code{-active-number} will be called to
15685 find the article number assigned to this article.  
15686
15687 The function also uses the following variables:
15688 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
15689 this backend); and @var{backend}@code{-group-alist} and
15690 @var{backend}@code{-active-file} to generate the new active file.
15691 @var{backend}@code{-group-alist} should be a group-active alist, like
15692 this:
15693
15694 @example
15695 (("a-group" (1 . 10))
15696  ("some-group" (34 . 39)))
15697 @end example
15698
15699
15700 @node Score File Syntax
15701 @subsection Score File Syntax
15702
15703 Score files are meant to be easily parsable, but yet extremely
15704 mallable.   It was decided that something that had the same read syntax
15705 as an Emacs Lisp list would fit that spec.
15706
15707 Here's a typical score file:
15708
15709 @lisp
15710 (("summary"
15711   ("win95" -10000 nil s)
15712   ("Gnus"))
15713  ("from"
15714   ("Lars" -1000))
15715  (mark -100))
15716 @end lisp
15717
15718 BNF definition of a score file:
15719
15720 @example
15721 score-file       = "" / "(" *element ")"
15722 element          = rule / atom
15723 rule             = string-rule / number-rule / date-rule
15724 string-rule      = "(" quote string-header quote space *string-match ")"
15725 number-rule      = "(" quote number-header quote space *number-match ")"
15726 date-rule        = "(" quote date-header quote space *date-match ")"
15727 quote            = <ascii 34>
15728 string-header    = "subject" / "from" / "references" / "message-id" / 
15729                    "xref" / "body" / "head" / "all" / "followup"
15730 number-header    = "lines" / "chars"
15731 date-header      = "date"
15732 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
15733                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
15734 score            = "nil" / <integer>
15735 date             = "nil" / <natural number>
15736 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
15737                    "r" / "regex" / "R" / "Regex" /
15738                    "e" / "exact" / "E" / "Exact" /
15739                    "f" / "fuzzy" / "F" / "Fuzzy"
15740 number-match     = "(" <integer> [ "" / [ space score [ "" / 
15741                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
15742 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
15743 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
15744                    space date [ "" / [ space date-match-t ] ] ] ] ")"
15745 date-match-t     = "nil" / "at" / "before" / "after"
15746 atom             = "(" [ required-atom / optional-atom ] ")"
15747 required-atom    = mark / expunge / mark-and-expunge / files /
15748                    exclude-files / read-only / touched
15749 optional-atom    = adapt / local / eval 
15750 mark             = "mark" space nil-or-number
15751 nil-or-number    = "nil" / <integer>
15752 expunge          = "expunge" space nil-or-number
15753 mark-and-expunge = "mark-and-expunge" space nil-or-number
15754 files            = "files" *[ space <string> ]
15755 exclude-files    = "exclude-files" *[ space <string> ]
15756 read-only        = "read-only" [ space "nil" / space "t" ]
15757 adapt            = "adapt" [ space "nil" / space "t" / space adapt-rule ]
15758 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
15759 local            = "local" *[ space "(" <string> space <form> ")" ]
15760 eval             = "eval" space <form>
15761 space            = *[ " " / <TAB> / <NEWLINE> ]
15762 @end example
15763
15764 Any unrecognized elements in a score file should be ignored, but not
15765 discarded.  
15766
15767 As you can see, white space is needed, but the type and amount of white
15768 space is irrelevant.  This means that formatting of the score file is
15769 left up to the programmer---if it's simpler to just spew it all out on
15770 one looong line, then that's ok.
15771
15772 The meaning of the various atoms are explained elsewhere in this
15773 manual. 
15774
15775
15776 @node Headers
15777 @subsection Headers
15778
15779 Gnus uses internally a format for storing article headers that
15780 corresponds to the @sc{nov} format in a mysterious fashion.  One could
15781 almost suspect that the author looked at the @sc{nov} specification and
15782 just shamelessly @emph{stole} the entire thing, and one would be right.
15783
15784 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
15785 RFC1036 to talk about lines in the head of an article (e.g.,
15786 @code{From}).  It is used by many people as a synonym for
15787 ``head''---``the header and the body''.  (That should be avoided, in my
15788 opinion.)  And Gnus uses a format internally that it calls ``header'',
15789 which is what I'm talking about here.  This is a 9-element vector,
15790 basically, with each header (ouch) having one slot.
15791
15792 These slots are, in order: @code{number}, @code{subject}, @code{from},
15793 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
15794 @code{xref}.  There are macros for accessing and setting these
15795 slots---they all have predictable names beginning with
15796 @code{mail-header-} and @code{mail-header-set-}, respectively.
15797
15798 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
15799 be put in there.
15800
15801
15802 @node Ranges
15803 @subsection Ranges
15804
15805 @sc{gnus} introduced a concept that I found so useful that I've started
15806 using it a lot and have elaborated on it greatly. 
15807
15808 The question is simple: If you have a large amount of objects that are
15809 identified by numbers (say, articles, to take a @emph{wild} example)
15810 that you want to qualify as being ``included'', a normal sequence isn't
15811 very useful.  (A 200,000 length sequence is a bit long-winded.)
15812
15813 The solution is as simple as the question: You just collapse the
15814 sequence. 
15815
15816 @example
15817 (1 2 3 4 5 6 10 11 12)
15818 @end example
15819
15820 is transformed into
15821
15822 @example
15823 ((1 . 6) (10 . 12))
15824 @end example
15825
15826 To avoid having those nasty @samp{(13 . 13)} elements to denote a
15827 lonesome object, a @samp{13} is a valid element:
15828
15829 @example
15830 ((1 . 6) 7 (10 . 12))
15831 @end example
15832
15833 This means that comparing two ranges to find out whether they are equal
15834 is slightly tricky:
15835
15836 @example
15837 ((1 . 5) 7 8 (10 . 12))
15838 @end example
15839
15840 and
15841
15842 @example
15843 ((1 . 5) (7 . 8) (10 . 12))
15844 @end example
15845
15846 are equal.  In fact, any non-descending list is a range:
15847
15848 @example
15849 (1 2 3 4 5)
15850 @end example
15851
15852 is a perfectly valid range, although a pretty long-winded one.  This is
15853 also legal:
15854
15855 @example
15856 (1 . 5)
15857 @end example
15858
15859 and is equal to the previous range.
15860
15861 Here's a BNF definition of ranges.  Of course, one must remember the
15862 semantic requirement that the numbers are non-descending.  (Any number
15863 of repetition of the same number is allowed, but apt to disappear in
15864 range handling.)
15865
15866 @example
15867 range           = simple-range / normal-range
15868 simple-range    = "(" number " . " number ")"
15869 normal-range    = "(" start-contents ")"
15870 contents        = "" / simple-range *[ " " contents ] / 
15871                   number *[ " " contents ]
15872 @end example
15873
15874 Gnus currently uses ranges to keep track of read articles and article
15875 marks.  I plan on implementing a number of range operators in C if The
15876 Powers That Be are willing to let me.  (I haven't asked yet, because I
15877 need to do some more thinking on what operators I need to make life
15878 totally range-based without ever having to convert back to normal
15879 sequences.) 
15880
15881
15882 @node Group Info
15883 @subsection Group Info
15884
15885 Gnus stores all permanent info on groups in a @dfn{group info} list.
15886 This list is from three to six elements (or more) long and exhaustively
15887 describes the group.
15888
15889 Here are two example group infos; one is a very simple group while the
15890 second is a more complex one:
15891
15892 @example
15893 ("no.group" 5 (1 . 54324))
15894
15895 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
15896                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
15897                 (nnml "")
15898                 (auto-expire (to-address "ding@@ifi.uio.no")))
15899 @end example
15900
15901 The first element is the @dfn{group name}---as Gnus knows the group,
15902 anyway.  The second element is the @dfn{subscription level}, which
15903 normally is a small integer.  The third element is a list of ranges of
15904 read articles.  The fourth element is a list of lists of article marks
15905 of various kinds.  The fifth element is the select method (or virtual
15906 server, if you like).  The sixth element is a list of @dfn{group
15907 parameters}, which is what this section is about.
15908
15909 Any of the last three elements may be missing if they are not required.
15910 In fact, the vast majority of groups will normally only have the first
15911 three elements, which saves quite a lot of cons cells.
15912
15913 Here's a BNF definition of the group info format:
15914
15915 @example
15916 info          = "(" group space level space read 
15917                 [ "" / [ space marks-list [ "" / [ space method [ "" /
15918                 space parameters ] ] ] ] ] ")" 
15919 group         = quote <string> quote
15920 level         = <integer in the range of 1 to inf>
15921 read          = range
15922 marks-lists   = nil / "(" *marks ")"
15923 marks         = "(" <string> range ")"
15924 method        = "(" <string> *elisp-forms ")"
15925 parameters    = "(" *elisp-forms ")"
15926 @end example
15927
15928 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
15929 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
15930 in pseudo-BNF.
15931
15932
15933 @node Emacs/XEmacs Code
15934 @subsection Emacs/XEmacs Code
15935 @cindex XEmacs
15936 @cindex Emacsen
15937
15938 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
15939 platforms must be the primary one.  I chose Emacs.  Not because I don't
15940 like XEmacs or Mule, but because it comes first alphabetically.
15941
15942 This means that Gnus will byte-compile under Emacs with nary a warning,
15943 while XEmacs will pump out gigabytes of warnings while byte-compiling.
15944 As I use byte-compilation warnings to help me root out trivial errors in
15945 Gnus, that's very useful.  
15946
15947 I've also consistently used Emacs function interfaces, but have used
15948 Gnusey aliases for the functions.  To take an example:  Emacs defines a
15949 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
15950 function.  I then define a function called @code{gnus-run-at-time} that
15951 takes the same parameters as the Emacs @code{run-at-time}.  When running
15952 Gnus under Emacs, the former function is just an alias for the latter.
15953 However, when running under XEmacs, the former is an alias for the
15954 following function:
15955
15956 @lisp
15957 (defun gnus-xmas-run-at-time (time repeat function &rest args)
15958   (start-itimer
15959    "gnus-run-at-time"
15960    `(lambda ()
15961       (,function ,@@args))
15962    time repeat))
15963 @end lisp
15964
15965 This sort of thing has been done for bunches of functions.  Gnus does
15966 not redefine any native Emacs functions while running under XEmacs---it
15967 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
15968 all over.
15969
15970 Of course, I could have chosen XEmacs as my native platform and done
15971 mapping functions the other way around.  But I didn't.  The performance
15972 hit these indirections impose on Gnus under XEmacs should be slight.
15973
15974
15975 @node Various File Formats
15976 @subsection Various File Formats
15977
15978 @menu
15979 * Active File Format::      Information on articles and groups available.
15980 * Newsgroups File Format::  Group descriptions.
15981 @end menu
15982
15983
15984 @node Active File Format
15985 @subsubsection Active File Format
15986
15987 The active file lists all groups that are available on the server in
15988 question.  It also lists the highest and lowest current article numbers
15989 in each group.  
15990
15991 Here's an excerpt from a typical active file:
15992
15993 @example
15994 soc.motss 296030 293865 y
15995 alt.binaries.pictures.fractals 3922 3913 n
15996 comp.sources.unix 1605 1593 m
15997 comp.binaries.ibm.pc 5097 5089 y
15998 no.general 1000 900 y
15999 @end example
16000
16001 Here's a pseudo-BNF definition of this file:
16002
16003 @example
16004 active      = *group-line
16005 group-line  = group space high-number space low-number space flag <NEWLINE>
16006 group       = <non-white-space string>
16007 space       = " "
16008 high-number = <non-negative integer>
16009 low-number  = <positive integer>
16010 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
16011 @end example
16012
16013
16014 @node Newsgroups File Format
16015 @subsubsection Newsgroups File Format
16016
16017 The newsgroups file lists groups along with their descriptions.  Not all
16018 groups on the server have to be listed,  and not all groups in the file
16019 have to exist on the server.  The file is meant purely as information to
16020 the user.
16021
16022 The format is quite simple; a group name, a tab, and the description.
16023 Here's the definition:
16024
16025 @example
16026 newsgroups    = *line
16027 line          = group tab description <NEWLINE>
16028 group         = <non-white-space string>
16029 tab           = <TAB>
16030 description   = <string>
16031 @end example
16032
16033
16034 @node Emacs for Heathens
16035 @section Emacs for Heathens
16036
16037 Believe it or not, but some people who use Gnus haven't really used
16038 Emacs much before they embarked on their journey on the Gnus Love Boat.
16039 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
16040 region'', and ``set @code{gnus-flargblossen} to an alist where the key
16041 is a regexp that is used for matching on the group name'' are magical
16042 phrases with little or no meaning, then this appendix is for you.  If
16043 you are already familiar with Emacs, just ignore this and go fondle your
16044 cat instead.
16045
16046 @menu
16047 * Keystrokes::      Entering text and executing commands.
16048 * Emacs Lisp::      The built-in Emacs programming language.
16049 @end menu
16050
16051
16052 @node Keystrokes
16053 @subsection Keystrokes
16054
16055 @itemize @bullet
16056 @item
16057 Q: What is an experienced Emacs user?
16058
16059 @item 
16060 A: A person who wishes that the terminal had pedals.
16061 @end itemize
16062
16063 Yes, when you use Emacs, you are apt to use the control key, the shift
16064 key and the meta key a lot.  This is very annoying to some people
16065 (notably @code{vi}le users), and the rest of us just love the hell out
16066 of it.  Just give up and submit.  Emacs really does stand for
16067 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
16068 may have heard from other disreputable sources (like the Emacs author).
16069
16070 The shift key is normally located near your pinky fingers, and are
16071 normally used to get capital letters and stuff.  You probably use it all
16072 the time.  The control key is normally marked ``CTRL'' or something like
16073 that.  The meta key is, funnily enough, never marked as such on any
16074 keyboards.  The one I'm currently at has a key that's marked ``Alt'',
16075 which is the meta key on this keyboard.  It's usually located somewhere
16076 to the left hand side of the keyboard, usually on the bottom row.
16077
16078 Now, us Emacs people doesn't say ``press the meta-control-m key'',
16079 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
16080 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
16081 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
16082 down the control key, and hold it down while you press @kbd{k}''.
16083 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16084 the control key and then press @kbd{k}''.  Simple, ay?
16085
16086 This is somewhat complicated by the fact that not all keyboards have a
16087 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
16088 means ``press escape, release escape, press @kbd{k}''.  That's much more
16089 work than if you have a meta key, so if that's the case, I respectfully
16090 suggest you get a real keyboard with a meta key.  You can't live without
16091 it.
16092
16093
16094
16095 @node Emacs Lisp
16096 @subsection Emacs Lisp
16097
16098 Emacs is the King of Editors because it's really a Lisp interpreter.
16099 Each and every key you tap runs some Emacs Lisp code snippet, and since
16100 Emacs Lisp is an interpreted language, that means that you can configure
16101 any key to run any arbitrary code.  You just, like, do it.
16102
16103 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16104 functions.  (These are byte-compiled for speed, but it's still
16105 interpreted.)  If you decide that you don't like the way Gnus does
16106 certain things, it's trivial to have it do something a different way.
16107 (Well, at least if you know how to write Lisp code.)  However, that's
16108 beyond the scope of this manual, so we are simply going to talk about
16109 some common constructs that you normally use in your @file{.emacs} file
16110 to customize Gnus.
16111
16112 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16113 write the following:
16114
16115 @lisp
16116 (setq gnus-florgbnize 4)
16117 @end lisp
16118
16119 This function (really ``special form'') @code{setq} is the one that can
16120 set a variable to some value.  This is really all you need to know.  Now
16121 you can go and fill your @code{.emacs} file with lots of these to change
16122 how Gnus works.
16123
16124 If you have put that thing in your @code{.emacs} file, it will be read
16125 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16126 start Emacs.  If you want to change the variable right away, simply say
16127 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
16128 previous ``form'', which here is a simple @code{setq} statement.
16129
16130 Go ahead---just try it, if you're located at your Emacs.  After you
16131 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16132 is the return value of the form you @code{eval}ed.
16133
16134 Some pitfalls:
16135
16136 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16137 that means:
16138
16139 @lisp
16140 (setq gnus-read-active-file 'some)
16141 @end lisp
16142
16143 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16144 @samp{nntp.ifi.uio.no}'', that means:
16145
16146 @lisp
16147 (setq gnus-nntp-server "nntp.ifi.uio.no")
16148 @end lisp
16149
16150 So be careful not to mix up strings (the latter) with symbols (the
16151 former).  The manual is unambiguous, but it can be confusing.
16152
16153
16154 @include gnus-faq.texi
16155
16156 @node Index
16157 @chapter Index
16158 @printindex cp
16159
16160 @node Key Index
16161 @chapter Key Index
16162 @printindex ky
16163
16164 @summarycontents
16165 @contents
16166 @bye
16167
16168 @iftex
16169 @iflatex
16170 \end{document}
16171 @end iflatex
16172 @end iftex
16173
16174 @c End:
16175