*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Red Gnus 0.71 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 Red Gnus 0.71 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 Red 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 Red Gnus 0.71
327
328 @end ifinfo
329
330 @iftex
331
332 @iflatex
333 \tableofcontents
334 \gnuscleardoublepage
335 @end iflatex
336
337 Gnus is the advanced, self-documenting, customizable, extensible
338 unreal-time newsreader for GNU Emacs.  
339
340 Oops.  That sounds oddly familiar, so let's start over again to avoid
341 being accused of plagiarism:
342
343 Gnus is a message-reading laboratory.  It will let you look at just
344 about anything as if it were a newsgroup.  You can read mail with it,
345 you can browse directories with it, you can @code{ftp} with it---you can
346 even read news with it!
347
348 Gnus tries to empower people who read news the same way Emacs empowers
349 people who edit text.  Gnus sets no limits to what the user should be
350 allowed to do.  Users are encouraged to extend Gnus to make it behave
351 like they want it to behave.  A program should not control people;
352 people should be empowered to do what they want by using (or abusing)
353 the program.
354
355 @end iftex
356
357
358 @menu
359 * Starting Up::           Finding news can be a pain.
360 * The Group Buffer::      Selecting, subscribing and killing groups.
361 * The Summary Buffer::    Reading, saving and posting articles.
362 * The Article Buffer::    Displaying and handling articles.
363 * Composing Messages::    Information on sending mail and news.
364 * Select Methods::        Gnus reads all messages from various select methods.
365 * Scoring::               Assigning values to articles.
366 * Various::               General purpose settings.
367 * The End::               Farewell and goodbye.
368 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
369 * Index::                 Variable, function and concept index.
370 * Key Index::             Key Index.
371 @end menu
372
373 @node Starting Up
374 @chapter Starting Gnus
375 @cindex starting up
376
377 @kindex M-x gnus
378 @findex gnus
379 If your system administrator has set things up properly, starting Gnus
380 and reading news is extremely easy---you just type @kbd{M-x gnus} in
381 your Emacs. 
382
383 @findex gnus-other-frame
384 @kindex M-x gnus-other-frame
385 If you want to start Gnus in a different frame, you can use the command
386 @kbd{M-x gnus-other-frame} instead.
387
388 If things do not go smoothly at startup, you have to twiddle some
389 variables. 
390
391 @menu
392 * Finding the News::    Choosing a method for getting news.
393 * The First Time::      What does Gnus do the first time you start it?
394 * The Server is Down::  How can I read my mail then?
395 * Slave Gnusae::        You can have more than one Gnus active at a time.
396 * Fetching a Group::    Starting Gnus just to read a group.
397 * New Groups::          What is Gnus supposed to do with new groups?
398 * Startup Files::       Those pesky startup files---@file{.newsrc}.
399 * Auto Save::           Recovering from a crash.
400 * The Active File::     Reading the active file over a slow line Takes Time.
401 * Changing Servers::    You may want to move from one server to another.
402 * Startup Variables::   Other variables you might change.
403 @end menu
404
405
406 @node Finding the News
407 @section Finding the News
408 @cindex finding news
409
410 @vindex gnus-select-method
411 @c @head
412 The @code{gnus-select-method} variable says where Gnus should look for
413 news.  This variable should be a list where the first element says
414 @dfn{how} and the second element says @dfn{where}.  This method is your
415 native method.  All groups that are not fetched with this method are
416 foreign groups.
417
418 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
419 you want to get your daily dosage of news from, you'd say:
420
421 @lisp
422 (setq gnus-select-method '(nntp "news.somewhere.edu"))
423 @end lisp
424
425 If you want to read directly from the local spool, say:
426
427 @lisp
428 (setq gnus-select-method '(nnspool ""))
429 @end lisp
430
431 If you can use a local spool, you probably should, as it will almost
432 certainly be much faster.
433
434 @vindex gnus-nntpserver-file
435 @cindex NNTPSERVER
436 @cindex @sc{nntp} server
437 If this variable is not set, Gnus will take a look at the
438 @code{NNTPSERVER} environment variable.  If that variable isn't set,
439 Gnus will see whether @code{gnus-nntpserver-file}
440 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
441 that fails as well, Gnus will will try to use the machine that is
442 running Emacs as an @sc{nntp} server.  That's a long shot, though.
443
444 @vindex gnus-nntp-server
445 If @code{gnus-nntp-server} is set, this variable will override
446 @code{gnus-select-method}.  You should therefore set
447 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
448
449 @vindex gnus-secondary-servers
450 You can also make Gnus prompt you interactively for the name of an
451 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
452 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
453 in the @code{gnus-secondary-servers} list (if any).  You can also just
454 type in the name of any server you feel like visiting.
455
456 @findex gnus-group-browse-foreign-server
457 @kindex B (Group)
458 However, if you use one @sc{nntp} server regularly and are just
459 interested in a couple of groups from a different server, you would be
460 better served by using the @kbd{B} command in the group buffer.  It will
461 let you have a look at what groups are available, and you can subscribe
462 to any of the groups you want to.  This also makes @file{.newsrc}
463 maintenance much tidier.  @xref{Foreign Groups}.
464
465 @vindex gnus-secondary-select-methods
466 @c @head
467 A slightly different approach to foreign groups is to set the
468 @code{gnus-secondary-select-methods} variable.  The select methods
469 listed in this variable are in many ways just as native as the
470 @code{gnus-select-method} server.  They will also be queried for active
471 files during startup (if that's required), and new newsgroups that
472 appear on these servers will be subscribed (or not) just as native
473 groups are.
474
475 For instance, if you use the @code{nnmbox} backend to read your mail, you
476 would typically set this variable to
477
478 @lisp
479 (setq gnus-secondary-select-methods '((nnmbox "")))
480 @end lisp
481
482
483 @node The First Time
484 @section The First Time
485 @cindex first time usage
486
487 If no startup files exist, Gnus will try to determine what groups should
488 be subscribed by default.
489
490 @vindex gnus-default-subscribed-newsgroups
491 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
492 will subscribe you to just those groups in that list, leaving the rest
493 killed.  Your system administrator should have set this variable to
494 something useful.
495
496 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
497 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is here
498 defined as @dfn{whatever Lars thinks you should read}.)
499
500 You'll also be subscribed to the Gnus documentation group, which should
501 help you with most common problems.  
502
503 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
504 use the normal functions for handling new groups, and not do anything
505 special.
506
507
508 @node The Server is Down
509 @section The Server is Down
510 @cindex server errors
511
512 If the default server is down, Gnus will understandably have some
513 problems starting.  However, if you have some mail groups in addition to
514 the news groups, you may want to start Gnus anyway.
515
516 Gnus, being the trusting sort of program, will ask whether to proceed
517 without a native select method if that server can't be contacted.  This
518 will happen whether the server doesn't actually exist (i.e., you have
519 given the wrong address) or the server has just momentarily taken ill
520 for some reason or other.  If you decide to continue and have no foreign
521 groups, you'll find it difficult to actually do anything in the group
522 buffer.  But, hey, that's your problem.  Blllrph!
523
524 @findex gnus-no-server
525 @kindex M-x gnus-no-server
526 @c @head
527 If you know that the server is definitely down, or you just want to read
528 your mail without bothering with the server at all, you can use the
529 @code{gnus-no-server} command to start Gnus.  That might come in handy
530 if you're in a hurry as well.  This command will not attempt to contact
531 your primary server---instead, it will just activate all groups on level
532 1 and 2.  (You should preferably keep no native groups on those two
533 levels.)
534
535
536 @node Slave Gnusae
537 @section Slave Gnusae
538 @cindex slave
539
540 You might want to run more than one Emacs with more than one Gnus at the
541 same time.  If you are using different @file{.newsrc} files (e.g., if you
542 are using the two different Gnusae to read from two different servers),
543 that is no problem whatsoever.  You just do it.
544
545 The problem appears when you want to run two Gnusae that use the same
546 @code{.newsrc} file.
547
548 To work around that problem some, we here at the Think-Tank at the Gnus
549 Towers have come up with a new concept: @dfn{Masters} and
550 @dfn{slaves}.  (We have applied for a patent on this concept, and have
551 taken out a copyright on those words.  If you wish to use those words in
552 conjunction with each other, you have to send $1 per usage instance to
553 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
554 Applications}) will be much more expensive, of course.)
555
556 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
557 however you do it).  Each subsequent slave Gnusae should be started with
558 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
559 files, but instead save @dfn{slave files} that contain information only
560 on what groups have been read in the slave session.  When a master Gnus
561 starts, it will read (and delete) these slave files, incorporating all
562 information from them.  (The slave files will be read in the sequence
563 they were created, so the latest changes will have precedence.)
564
565 Information from the slave files has, of course, precedence over the
566 information in the normal (i.e., master) @code{.newsrc} file.
567
568
569 @node Fetching a Group
570 @section Fetching a Group
571 @cindex fetching a group
572
573 @findex gnus-fetch-group
574 It it sometimes convenient to be able to just say ``I want to read this
575 group and I don't care whether Gnus has been started or not''.  This is
576 perhaps more useful for people who write code than for users, but the
577 command @code{gnus-fetch-group} provides this functionality in any case.
578 It takes the group name as a parameter.
579
580
581 @node New Groups
582 @section New Groups
583 @cindex new groups
584 @cindex subscription
585
586 @vindex gnus-check-new-newsgroups
587 If you are satisfied that you really never want to see any new groups,
588 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
589 also save you some time at startup.  Even if this variable is
590 @code{nil}, you can always subscribe to the new groups just by pressing
591 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
592 is @code{t} by default.  If you set this variable to @code{always}, then
593 Gnus will query the backends for new groups even when you do the @kbd{g}
594 command (@pxref{Scanning New Messages}).
595
596 @menu
597 * Checking New Groups::      Determining what groups are new.
598 * Subscription Methods::     What Gnus should do with new groups.
599 * Filtering New Groups::     Making Gnus ignore certain new groups.
600 @end menu
601
602
603 @node Checking New Groups
604 @subsection Checking New Groups
605
606 Gnus normally determines whether a group is new or not by comparing the
607 list of groups from the active file(s) with the lists of subscribed and
608 dead groups.  This isn't a particularly fast method.  If
609 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
610 server for new groups since the last time.  This is both faster and
611 cheaper.  This also means that you can get rid of the list of killed
612 groups altogether, so you may set @code{gnus-save-killed-list} to
613 @code{nil}, which will save time both at startup, at exit, and all over.
614 Saves disk space, too.  Why isn't this the default, then?
615 Unfortunately, not all servers support this command. 
616
617 I bet I know what you're thinking now: How do I find out whether my
618 server supports @code{ask-server}?  No?  Good, because I don't have a
619 fail-safe answer.  I would suggest just setting this variable to
620 @code{ask-server} and see whether any new groups appear within the next
621 few days.  If any do, then it works.  If none do, then it doesn't
622 work.  I could write a function to make Gnus guess whether the server
623 supports @code{ask-server}, but it would just be a guess.  So I won't.
624 You could @code{telnet} to the server and say @code{HELP} and see
625 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
626 it does, then it might work.  (But there are servers that lists
627 @samp{NEWGROUPS} without supporting the function properly.)
628
629 This variable can also be a list of select methods.  If so, Gnus will
630 issue an @code{ask-server} command to each of the select methods, and
631 subscribe them (or not) using the normal methods.  This might be handy
632 if you are monitoring a few servers for new groups.  A side effect is
633 that startup will take much longer, so you can meditate while waiting.
634 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
635
636
637 @node Subscription Methods
638 @subsection Subscription Methods
639
640 @vindex gnus-subscribe-newsgroup-method
641 What Gnus does when it encounters a new group is determined by the
642 @code{gnus-subscribe-newsgroup-method} variable.
643
644 This variable should contain a function.  Some handy pre-fab values
645 are:
646
647 @table @code
648
649 @item gnus-subscribe-zombies
650 @vindex gnus-subscribe-zombies
651 Make all new groups zombies.  This is the default.  You can browse the
652 zombies later (with @kbd{A z}) and either kill them all off properly
653 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
654
655 @item gnus-subscribe-randomly
656 @vindex gnus-subscribe-randomly
657 Subscribe all new groups randomly.
658
659 @item gnus-subscribe-alphabetically
660 @vindex gnus-subscribe-alphabetically
661 Subscribe all new groups alphabetically.
662
663 @item gnus-subscribe-hierarchically
664 @vindex gnus-subscribe-hierarchically
665 Subscribe all new groups hierarchically.  The difference between this
666 function and @code{gnus-subscribe-alphabetically} is slight.
667 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
668 alphabetical fashion, while this function will enter groups into it's
669 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
670 @samp{comp} hierarchy, this function will not mess that configuration
671 up.  Or something like that.
672
673 @item gnus-subscribe-interactively
674 @vindex gnus-subscribe-interactively
675 Subscribe new groups interactively.  This means that Gnus will ask
676 you about @strong{all} new groups.
677
678 @item gnus-subscribe-killed
679 @vindex gnus-subscribe-killed
680 Kill all new groups.
681
682 @end table
683
684 @vindex gnus-subscribe-hierarchical-interactive
685 A closely related variable is
686 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
687 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
688 hierarchical fashion whether to subscribe to new groups or not.  Gnus
689 will ask you for each sub-hierarchy whether you want to descend the
690 hierarchy or not.  
691
692 One common mistake is to set the variable a few paragraphs above to
693 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
694 will not work.  This is ga-ga.  So don't do it.
695
696
697 @node Filtering New Groups
698 @subsection Filtering New Groups
699
700 A nice and portable way to control which new newsgroups should be
701 subscribed (or ignored) is to put an @dfn{options} line at the start of
702 the @file{.newsrc} file.  Here's an example:
703
704 @example
705 options -n !alt.all !rec.all sci.all
706 @end example
707
708 @vindex gnus-subscribe-options-newsgroup-method
709 This line obviously belongs to a serious-minded intellectual scientific
710 person (or she may just be plain old boring), because it says that all
711 groups that have names beginning with @samp{alt} and @samp{rec} should
712 be ignored, and all groups with names beginning with @samp{sci} should
713 be subscribed.  Gnus will not use the normal subscription method for
714 subscribing these groups.
715 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
716 variable defaults to @code{gnus-subscribe-alphabetically}.
717
718 @vindex gnus-options-not-subscribe
719 @vindex gnus-options-subscribe
720 If you don't want to mess with your @file{.newsrc} file, you can just
721 set the two variables @code{gnus-options-subscribe} and
722 @code{gnus-options-not-subscribe}.  These two variables do exactly the
723 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
724 and if the the new group matches the former, it will be unconditionally
725 subscribed, and if it matches the latter, it will be ignored.
726
727 @vindex gnus-auto-subscribed-groups
728 Yet another variable that meddles here is
729 @code{gnus-auto-subscribed-groups}.  It works exactly like
730 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
731 thought it would be nice to have two of these.  This variable is more
732 meant for setting some ground rules, while the other variable is used
733 more for user fiddling.  By default this variable makes all new groups
734 that come from mail backends (@code{nnml}, @code{nnbabyl},
735 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
736 don't like that, just set this variable to @code{nil}.
737
738 New groups that match this regexp are subscribed using
739 @code{gnus-subscribe-options-newsgroup-method}.
740
741
742 @node Changing Servers
743 @section Changing Servers
744 @cindex changing servers
745
746 Sometimes it is necessary to move from one @sc{nntp} server to another.
747 This happens very rarely, but perhaps you change jobs, or one server is
748 very flaky and you want to use another.  
749
750 Changing the server is pretty easy, right?  You just change
751 @code{gnus-select-method} to point to the new server?  
752
753 @emph{Wrong!}
754
755 Article numbers are not (in any way) kept synchronized between different
756 @sc{nntp} servers, and the only way Gnus keeps track of what articles
757 you have read is by keeping track of article numbers.  So when you
758 change @code{gnus-select-method}, your @file{.newsrc} file becomes
759 worthless.  
760
761 Gnus provides a few functions to attempt to translate a @file{.newsrc}
762 file from one server to another.  They all have one thing in
763 common---they take a looong time to run.  You don't want to use these
764 functions more than absolutely necessary.
765
766 @kindex M-x gnus-change-server
767 @findex gnus-change-server
768 If you have access to both servers, Gnus can request the headers for all
769 the articles you have read and compare @code{Message-ID}s and map the
770 article numbers of the read articles and article marks.  The @kbd{M-x
771 gnus-change-server} command will do this for all your native groups.  It
772 will prompt for the method you want to move to.
773
774 @kindex M-x gnus-group-move-group-to-server
775 @findex gnus-group-move-group-to-server
776 You can also move individual groups with the @kbd{M-x
777 gnus-group-move-group-to-server} command.  This is useful if you want to
778 move a (foreign) group from one server to another.
779
780 @kindex M-x gnus-group-clear-data-on-native-groups
781 @findex gnus-group-clear-data-on-native-groups
782 If you don't have access to both the old and new server, all your marks
783 and read ranges have become worthless.  You can use the @kbd{M-x
784 gnus-group-clear-data-on-native-groups} command to clear out all data
785 that you have on your native groups.  Use with caution.
786
787
788 @node Startup Files
789 @section Startup Files
790 @cindex startup files
791 @cindex .newsrc
792 @cindex .newsrc.el
793 @cindex .newsrc.eld
794
795 Now, you all know about the @file{.newsrc} file.  All subscription
796 information is traditionally stored in this file.
797
798 Things got a bit more complicated with @sc{gnus}.  In addition to
799 keeping the @file{.newsrc} file updated, it also used a file called
800 @file{.newsrc.el} for storing all the information that didn't fit into
801 the @file{.newsrc} file.  (Actually, it also duplicated everything in
802 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
803 files was the most recently saved, which enabled people to swap between
804 @sc{gnus} and other newsreaders.
805
806 That was kinda silly, so Gnus went one better: In addition to the
807 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
808 @file{.newsrc.eld}.  It will read whichever of these files that are most
809 recent, but it will never write a @file{.newsrc.el} file.
810
811 @vindex gnus-save-newsrc-file
812 You can turn off writing the @file{.newsrc} file by setting
813 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
814 the file and save some space, as well as making exit from Gnus faster.
815 However, this will make it impossible to use other newsreaders than
816 Gnus.  But hey, who would want to, right?
817
818 @vindex gnus-save-killed-list
819 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
820 will not save the list of killed groups to the startup file.  This will
821 save both time (when starting and quitting) and space (on disk).  It
822 will also mean that Gnus has no record of what groups are new or old,
823 so the automatic new groups subscription methods become meaningless.
824 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
825 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
826 Groups}).  This variable can also be a regular expression.  If that's
827 the case, remove all groups that do not match this regexp before
828 saving.  This can be useful in certain obscure situations that involve
829 several servers where not all servers support @code{ask-server}.
830
831 @vindex gnus-startup-file
832 The @code{gnus-startup-file} variable says where the startup files are.
833 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
834 file being whatever that one is with a @samp{.eld} appended.
835
836 @vindex gnus-save-newsrc-hook
837 @vindex gnus-save-quick-newsrc-hook
838 @vindex gnus-save-standard-newsrc-hook
839 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
840 files, while @code{gnus-save-quick-newsrc-hook} is called just before
841 saving the @file{.newsrc.eld} file, and
842 @code{gnus-save-standard-newsrc-hook} is called just before saving the
843 @file{.newsrc} file.  The latter two are commonly used to turn version
844 control on or off.  Version control is on by default when saving the
845 startup files.  If you want to turn backup creation off, say something like: 
846
847 @lisp
848 (defun turn-off-backup ()
849   (set (make-local-variable 'backup-inhibited) t))
850
851 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
852 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
853 @end lisp
854
855 @vindex gnus-init-file
856 When Gnus starts, it will read the @code{gnus-site-init-file}
857 (@file{.../site-lisp/gnus.el} by default) and @code{gnus-init-file}
858 (@file{~/.gnus.el} by default) files.  These are normal Emacs Lisp files
859 and can be used to avoid cluttering your @file{.emacs} and
860 @file{site-init} files with Gnus stuff.
861
862
863 @node Auto Save
864 @section Auto Save
865 @cindex dribble file
866 @cindex auto-save
867
868 Whenever you do something that changes the Gnus data (reading articles,
869 catching up, killing/subscribing groups), the change is added to a
870 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
871 Emacs way.  If your Emacs should crash before you have saved the
872 @file{.newsrc} files, all changes you have made can be recovered from
873 this file.
874
875 If Gnus detects this file at startup, it will ask the user whether to
876 read it.  The auto save file is deleted whenever the real startup file is
877 saved.
878
879 @vindex gnus-use-dribble-file
880 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
881 maintain a dribble buffer.  The default is @code{t}.
882
883 @vindex gnus-dribble-directory
884 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
885 this variable is @code{nil}, which it is by default, Gnus will dribble
886 into the directory where the @file{.newsrc} file is located.  (This is
887 normally the user's home directory.)  The dribble file will get the same
888 file permissions as the @code{.newsrc} file.
889
890
891 @node The Active File
892 @section The Active File
893 @cindex active file
894 @cindex ignored groups
895
896 When Gnus starts, or indeed whenever it tries to determine whether new
897 articles have arrived, it reads the active file.  This is a very large
898 file that lists all the active groups and articles on the server.
899
900 @vindex gnus-ignored-newsgroups
901 Before examining the active file, Gnus deletes all lines that match the
902 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
903 any groups with bogus names, but you can use this variable to make Gnus
904 ignore hierarchies you aren't ever interested in.  However, this is not
905 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
906 Groups} for an overview of other variables that can be used instead.
907
908 @c This variable is
909 @c @code{nil} by default, and will slow down active file handling somewhat
910 @c if you set it to anything else.
911
912 @vindex gnus-read-active-file
913 @c @head
914 The active file can be rather Huge, so if you have a slow network, you
915 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
916 reading the active file.  This variable is @code{t} by default.
917
918 Gnus will try to make do by getting information just on the groups that
919 you actually subscribe to.
920
921 Note that if you subscribe to lots and lots of groups, setting this
922 variable to @code{nil} will probably make Gnus slower, not faster.  At
923 present, having this variable @code{nil} will slow Gnus down
924 considerably, unless you read news over a 2400 baud modem.  
925
926 This variable can also have the value @code{some}.  Gnus will then
927 attempt to read active info only on the subscribed groups.  On some
928 servers this is quite fast (on sparkling, brand new INN servers that
929 support the @code{LIST ACTIVE group} command), on others this isn't fast
930 at all.  In any case, @code{some} should be faster than @code{nil}, and
931 is certainly faster than @code{t} over slow lines.
932
933 If this variable is @code{nil}, Gnus will ask for group info in total
934 lock-step, which isn't very fast.  If it is @code{some} and you use an
935 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
936 read all the replies in one swoop.  This will normally result in better
937 performance, but if the server does not support the aforementioned
938 @code{LIST ACTIVE group} command, this isn't very nice to the server.
939
940 In any case, if you use @code{some} or @code{nil}, you should definitely
941 kill all groups that you aren't interested in to speed things up.
942
943
944 @node Startup Variables
945 @section Startup Variables
946
947 @table @code
948
949 @item gnus-load-hook
950 @vindex gnus-load-hook
951 A hook that is run while Gnus is being loaded.  Note that this hook will
952 normally be run just once in each Emacs session, no matter how many
953 times you start Gnus.
954
955 @item gnus-startup-hook
956 @vindex gnus-startup-hook
957 A hook that is run after starting up Gnus successfully.
958
959 @item gnus-check-bogus-newsgroups
960 @vindex gnus-check-bogus-newsgroups
961 If non-@code{nil}, Gnus will check for and delete all bogus groups at
962 startup.  A @dfn{bogus group} is a group that you have in your
963 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
964 bogus groups can take quite a while, so to save time and resources it's
965 best to leave this option off, and do the checking for bogus groups once
966 in a while from the group buffer instead (@pxref{Group Maintenance}).
967
968 @item gnus-inhibit-startup-message
969 @vindex gnus-inhibit-startup-message
970 If non-@code{nil}, the startup message won't be displayed.  That way,
971 your boss might not notice as easily that you are reading news instead
972 of doing your job.  Note that this variable is used before
973 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
974
975 @item gnus-no-groups-message
976 @vindex gnus-no-groups-message
977 Message displayed by Gnus when no groups are available.
978
979 @item gnus-play-startup-jingle
980 @vindex gnus-play-startup-jingle
981 If non-@code{nil}, play the Gnus jingle at startup.
982
983 @item gnus-startup-jingle
984 @vindex gnus-startup-jingle
985 Jingle to be played if the above variable is non-@code{nil}.  The
986 default is @samp{Tuxedomoon.Jingle4.au}.
987
988 @end table
989
990
991 @node The Group Buffer
992 @chapter The Group Buffer
993 @cindex group buffer
994
995 The @dfn{group buffer} lists all (or parts) of the available groups.  It
996 is the first buffer shown when Gnus starts, and will never be killed as
997 long as Gnus is active.
998
999 @menu
1000 * Group Buffer Format::    Information listed and how you can change it.
1001 * Group Maneuvering::      Commands for moving in the group buffer.
1002 * Selecting a Group::      Actually reading news.
1003 * Group Data::             Changing the info for a group.
1004 * Subscription Commands::  Unsubscribing, killing, subscribing.
1005 * Group Levels::           Levels? What are those, then?
1006 * Group Score::            A mechanism for finding out what groups you like.
1007 * Marking Groups::         You can mark groups for later processing.
1008 * Foreign Groups::         Creating and editing groups.
1009 * Group Parameters::       Each group may have different parameters set.
1010 * Listing Groups::         Gnus can list various subsets of the groups.
1011 * Sorting Groups::         Re-arrange the group order.
1012 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1013 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1014 * Exiting Gnus::           Stop reading news and get some work done.
1015 * Group Topics::           A folding group mode divided into topics.
1016 * Misc Group Stuff::       Other stuff that you can to do.
1017 @end menu
1018
1019
1020 @node Group Buffer Format
1021 @section Group Buffer Format
1022
1023 @menu 
1024 * Group Line Specification::       Deciding how the group buffer is to look.
1025 * Group Modeline Specification::   The group buffer modeline.
1026 * Group Highlighting::             Having nice colors in the group buffer.
1027 @end menu
1028
1029
1030 @node Group Line Specification
1031 @subsection Group Line Specification
1032 @cindex group buffer format
1033
1034 The default format of the group buffer is nice and dull, but you can
1035 make it as exciting and ugly as you feel like.
1036
1037 Here's a couple of example group lines:
1038
1039 @example
1040      25: news.announce.newusers
1041  *    0: alt.fan.andrea-dworkin
1042 @end example
1043
1044 Quite simple, huh?
1045
1046 You can see that there are 25 unread articles in
1047 @samp{news.announce.newusers}.  There are no unread articles, but some
1048 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1049 asterisk at the beginning of the line?)
1050
1051 @vindex gnus-group-line-format
1052 You can change that format to whatever you want by fiddling with the
1053 @code{gnus-group-line-format} variable.  This variable works along the
1054 lines of a @code{format} specification, which is pretty much the same as
1055 a @code{printf} specifications, for those of you who use (feh!) C.
1056 @xref{Formatting Variables}. 
1057
1058 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1059
1060 There should always be a colon on the line; the cursor always moves to
1061 the colon after performing an operation.  Nothing else is required---not
1062 even the group name.  All displayed text is just window dressing, and is
1063 never examined by Gnus.  Gnus stores all real information it needs using
1064 text properties.
1065
1066 (Note that if you make a really strange, wonderful, spreadsheet-like
1067 layout, everybody will believe you are hard at work with the accounting
1068 instead of wasting time reading news.)
1069
1070 Here's a list of all available format characters:
1071
1072 @table @samp
1073
1074 @item M    
1075 An asterisk if the group only has marked articles.
1076
1077 @item S
1078 Whether the group is subscribed.
1079
1080 @item L    
1081 Level of subscribedness.
1082
1083 @item N
1084 Number of unread articles.
1085
1086 @item I
1087 Number of dormant articles.
1088
1089 @item T
1090 Number of ticked articles.
1091
1092 @item R
1093 Number of read articles.
1094
1095 @item t
1096 Estimated total number of articles.  (This is really @var{max-number}
1097 minus @var{min-number} plus 1.)
1098
1099 @item y
1100 Number of unread, unticked, non-dormant articles.
1101
1102 @item i
1103 Number of ticked and dormant articles.
1104
1105 @item g
1106 Full group name.
1107
1108 @item G
1109 Group name.
1110
1111 @item D
1112 Newsgroup description.
1113
1114 @item o
1115 @samp{m} if moderated.
1116
1117 @item O
1118 @samp{(m)} if moderated.
1119
1120 @item s
1121 Select method.
1122
1123 @item n
1124 Select from where.
1125
1126 @item z
1127 A string that looks like @samp{<%s:%n>} if a foreign select method is
1128 used.
1129
1130 @item P
1131 Indentation based on the level of the topic (@pxref{Group Topics}). 
1132
1133 @item c
1134 @vindex gnus-group-uncollapsed-levels
1135 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1136 variable says how many levels to leave at the end of the group name.
1137 The default is 1---this will mean that group names like
1138 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1139
1140 @item m
1141 @vindex gnus-new-mail-mark
1142 @cindex %
1143 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1144 the group lately.
1145
1146 @item d
1147 A string that says when you last read the group (@pxref{Group
1148 Timestamp}). 
1149
1150 @item u
1151 User defined specifier.  The next character in the format string should
1152 be a letter.  @sc{gnus} will call the function
1153 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1154 following @samp{%u}.  The function will be passed a single dummy
1155 paratere as argument.  The function should return a string, which will
1156 be inserted into the buffer just like information from any other
1157 specifier.
1158 @end table
1159
1160 @cindex *
1161 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1162 if no info is available---for instance, if it is a non-activated foreign
1163 group, or a bogus native group.
1164
1165
1166 @node Group Modeline Specification
1167 @subsection Group Modeline Specification
1168 @cindex group modeline
1169
1170 @vindex gnus-group-mode-line-format
1171 The mode line can be changed by setting
1172 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}).  It
1173 doesn't understand that many format specifiers:
1174
1175 @table @samp
1176 @item S
1177 The native news server.
1178 @item M
1179 The native select method.
1180 @end table
1181
1182
1183 @node Group Highlighting
1184 @subsection Group Highlighting
1185 @cindex highlighting
1186 @cindex group highlighting
1187
1188 @vindex gnus-group-highlight
1189 Highlighting in the group buffer is controlled by the
1190 @code{gnus-group-highlight} variable.  This is an alist with elements
1191 that look like @var{(form . face)}.  If @var{form} evaluates to
1192 something non-@code{nil}, the @var{face} will be used on the line.
1193
1194 Here's an example value for this variable that might look nice if the
1195 background is dark:
1196
1197 @lisp
1198 (setq gnus-group-highlight
1199       `(((> unread 200) . 
1200          ,(custom-face-lookup "Red" nil nil t nil nil))
1201         ((and (< level 3) (zerop unread)) . 
1202          ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1203         ((< level 3) . 
1204          ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1205         ((zerop unread) . 
1206          ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1207         (t . 
1208          ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1209 @end lisp
1210
1211 Variables that are dynamically bound when the forms are evaluated
1212 include:
1213
1214 @table @code
1215 @item group
1216 The group name.
1217 @item unread
1218 The number of unread articles in the group.
1219 @item method
1220 The select method.
1221 @item mailp
1222 Whether the group is a mail group.
1223 @item level
1224 The level of the group.
1225 @item score
1226 The score of the group.
1227 @item ticked 
1228 The number of ticked articles in the group.
1229 @item total
1230 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1231 MIN-NUMBER.
1232 @item topic
1233 When using the topic minor mode, this variable is bound to the current
1234 topic being inserted.
1235 @end table
1236
1237 When the forms are @code{eval}ed, point is at the beginning of the line
1238 of the group in question, so you can use many of the normal Gnus
1239 functions for snarfing info on the group.
1240
1241 @vindex gnus-group-update-hook
1242 @findex gnus-group-highlight-line
1243 @code{gnus-group-update-hook} is called when a group line is changed.
1244 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1245 calls @code{gnus-group-highlight-line} by default.
1246
1247
1248 @node Group Maneuvering
1249 @section Group Maneuvering
1250 @cindex group movement
1251
1252 All movement commands understand the numeric prefix and will behave as
1253 expected, hopefully. 
1254
1255 @table @kbd
1256
1257 @item n
1258 @kindex n (Group)
1259 @findex gnus-group-next-unread-group
1260 Go to the next group that has unread articles
1261 (@code{gnus-group-next-unread-group}).
1262
1263 @item p
1264 @itemx DEL
1265 @kindex DEL (Group)
1266 @kindex p (Group)
1267 @findex gnus-group-prev-unread-group
1268 Go to the previous group that has unread articles
1269 (@code{gnus-group-prev-unread-group}).
1270
1271 @item N
1272 @kindex N (Group)
1273 @findex gnus-group-next-group
1274 Go to the next group (@code{gnus-group-next-group}).
1275
1276 @item P
1277 @kindex P (Group)
1278 @findex gnus-group-prev-group
1279 Go to the previous group (@code{gnus-group-prev-group}).
1280
1281 @item M-p
1282 @kindex M-p (Group)
1283 @findex gnus-group-next-unread-group-same-level
1284 Go to the next unread group on the same (or lower) level
1285 (@code{gnus-group-next-unread-group-same-level}). 
1286
1287 @item M-n
1288 @kindex M-n (Group)
1289 @findex gnus-group-prev-unread-group-same-level
1290 Go to the previous unread group on the same (or lower) level
1291 (@code{gnus-group-prev-unread-group-same-level}). 
1292 @end table
1293
1294 Three commands for jumping to groups:
1295
1296 @table @kbd
1297
1298 @item j
1299 @kindex j (Group)
1300 @findex gnus-group-jump-to-group
1301 Jump to a group (and make it visible if it isn't already)
1302 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1303 like living groups.
1304
1305 @item ,
1306 @kindex , (Group)
1307 @findex gnus-group-best-unread-group
1308 Jump to the unread group with the lowest level
1309 (@code{gnus-group-best-unread-group}). 
1310
1311 @item .
1312 @kindex . (Group)
1313 @findex gnus-group-first-unread-group
1314 Jump to the first group with unread articles
1315 (@code{gnus-group-first-unread-group}).  
1316 @end table
1317
1318 @vindex gnus-group-goto-unread
1319 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1320 commands will move to the next group, not the next unread group.  Even
1321 the commands that say they move to the next unread group.  The default
1322 is @code{t}.
1323
1324
1325 @node Selecting a Group
1326 @section Selecting a Group
1327 @cindex group selection
1328
1329 @table @kbd
1330
1331 @item SPACE
1332 @kindex SPACE (Group)
1333 @findex gnus-group-read-group
1334 Select the current group, switch to the summary buffer and display the
1335 first unread article (@code{gnus-group-read-group}).  If there are no
1336 unread articles in the group, or if you give a non-numerical prefix to
1337 this command, Gnus will offer to fetch all the old articles in this
1338 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1339 determines the number of articles Gnus will fetch.  If @var{N} is
1340 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1341 negative, Gnus fetches the @var{abs(N)} oldest articles.
1342
1343 @item RET
1344 @kindex RET (Group)
1345 @findex gnus-group-select-group
1346 Select the current group and switch to the summary buffer
1347 (@code{gnus-group-select-group}).  Takes the same arguments as
1348 @code{gnus-group-read-group}---the only difference is that this command
1349 does not display the first unread article automatically upon group
1350 entry. 
1351
1352 @item M-RET
1353 @kindex M-RET (Group)
1354 @findex gnus-group-quick-select-group
1355 This does the same as the command above, but tries to do it with the
1356 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1357 scoring/killing will be performed, there will be no highlights and no
1358 expunging.  This might be useful if you're in a real hurry and have to
1359 enter some humongous group.  If you give a 0 prefix to this command
1360 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer.
1361 This might be useful if you want to toggle threading before entering the
1362 group.
1363
1364 @item M-SPACE
1365 @kindex M-SPACE (Group)
1366 @findex gnus-group-visible-select-group
1367 This is yet one more command that does the same as the @kbd{RET}
1368 command, but this one does it without expunging and hiding dormants
1369 (@code{gnus-group-visible-select-group}).
1370
1371 @end table
1372
1373 @vindex gnus-large-newsgroup
1374 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1375 to be a big group.  This is 200 by default.  If the group has more
1376 (unread and/or ticked) articles than this, Gnus will query the user
1377 before entering the group.  The user can then specify how many articles
1378 should be fetched from the server.  If the user specifies a negative
1379 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1380 is positive, the @code{n} articles that have arrived most recently will
1381 be fetched.
1382
1383 @vindex gnus-select-group-hook
1384 @vindex gnus-auto-select-first
1385 @code{gnus-auto-select-first} control whether any articles are selected
1386 automatically when entering a group with the @kbd{SPACE} command.
1387
1388 @table @code
1389
1390 @item nil
1391 Don't select any articles when entering the group.  Just display the
1392 full summary buffer.
1393
1394 @item t
1395 Select the first unread article when entering the group.  
1396
1397 @item best
1398 Select the most high-scored article in the group when entering the
1399 group. 
1400 @end table
1401         
1402 If you want to prevent automatic selection in some group (say, in a
1403 binary group with Huge articles) you can set this variable to @code{nil}
1404 in @code{gnus-select-group-hook}, which is called when a group is
1405 selected.
1406
1407
1408 @node Subscription Commands
1409 @section Subscription Commands
1410 @cindex subscription
1411
1412 @table @kbd
1413
1414 @item S t
1415 @itemx u
1416 @kindex S t (Group)
1417 @kindex u (Group)
1418 @findex gnus-group-unsubscribe-current-group
1419 Toggle subscription to the current group
1420 (@code{gnus-group-unsubscribe-current-group}).  
1421
1422 @item S s
1423 @itemx U
1424 @kindex S s (Group)
1425 @kindex U (Group)
1426 @findex gnus-group-unsubscribe-group
1427 Prompt for a group to subscribe, and then subscribe it.  If it was
1428 subscribed already, unsubscribe it instead
1429 (@code{gnus-group-unsubscribe-group}).
1430
1431 @item S k
1432 @itemx C-k
1433 @kindex S k (Group)
1434 @kindex C-k (Group)
1435 @findex gnus-group-kill-group
1436 Kill the current group (@code{gnus-group-kill-group}).
1437
1438 @item S y
1439 @itemx C-y
1440 @kindex S y (Group)
1441 @kindex C-y (Group)
1442 @findex gnus-group-yank-group
1443 Yank the last killed group (@code{gnus-group-yank-group}).
1444
1445 @item C-x C-t
1446 @kindex C-x C-t (Group)
1447 @findex gnus-group-transpose-groups
1448 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1449 really a subscription command, but you can use it instead of a
1450 kill-and-yank sequence sometimes.
1451
1452 @item S w
1453 @itemx C-w
1454 @kindex S w (Group)
1455 @kindex C-w (Group)
1456 @findex gnus-group-kill-region
1457 Kill all groups in the region (@code{gnus-group-kill-region}). 
1458
1459 @item S z
1460 @kindex S z (Group)
1461 @findex gnus-group-kill-all-zombies
1462 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1463
1464 @item S C-k
1465 @kindex S C-k (Group)
1466 @findex gnus-group-kill-level
1467 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1468 These groups can't be yanked back after killing, so this command should
1469 be used with some caution.  The only time where this command comes in
1470 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1471 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1472 kill off all unsubscribed groups that do not have message numbers in the
1473 @file{.newsrc} file.  
1474
1475 @end table
1476
1477 Also @pxref{Group Levels}.
1478
1479
1480 @node Group Data
1481 @section Group Data
1482
1483 @table @kbd
1484
1485 @item c
1486 @kindex c (Group)
1487 @findex gnus-group-catchup-current
1488 @vindex gnus-group-catchup-group-hook
1489 Mark all unticked articles in this group as read
1490 (@code{gnus-group-catchup-current}).
1491 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1492 the group buffer.
1493
1494 @item C
1495 @kindex C (Group)
1496 @findex gnus-group-catchup-current-all
1497 Mark all articles in this group, even the ticked ones, as read
1498 (@code{gnus-group-catchup-current-all}).   
1499
1500 @item M-c
1501 @kindex M-c (Group)
1502 @findex gnus-group-clear-data
1503 Clear the data from the current group---nix out marks and the list of
1504 read articles (@code{gnus-group-clear-data}).
1505
1506 @item M-x gnus-group-clear-data-on-native-groups
1507 @kindex M-x gnus-group-clear-data-on-native-groups
1508 @findex gnus-group-clear-data-on-native-groups
1509 If you have switched from one @sc{nntp} server to another, all your marks
1510 and read ranges have become worthless.  You can use this command to
1511 clear out all data that you have on your native groups.  Use with
1512 caution. 
1513
1514 @end table
1515
1516
1517 @node Group Levels
1518 @section Group Levels
1519 @cindex group level
1520 @cindex level
1521
1522 All groups have a level of @dfn{subscribedness}.  For instance, if a
1523 group is on level 2, it is more subscribed than a group on level 5.  You
1524 can ask Gnus to just list groups on a given level or lower
1525 (@pxref{Listing Groups}), or to just check for new articles in groups on
1526 a given level or lower (@pxref{Scanning New Messages}).
1527
1528 Remember:  The higher the level of the group, the less important it is. 
1529
1530 @table @kbd
1531
1532 @item S l
1533 @kindex S l (Group)
1534 @findex gnus-group-set-current-level
1535 Set the level of the current group.  If a numeric prefix is given, the
1536 next @var{n} groups will have their levels set.  The user will be
1537 prompted for a level.
1538 @end table
1539
1540 @vindex gnus-level-killed
1541 @vindex gnus-level-zombie
1542 @vindex gnus-level-unsubscribed
1543 @vindex gnus-level-subscribed
1544 Gnus considers groups on between levels 1 and
1545 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1546 @code{gnus-level-subscribed} (exclusive) and
1547 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1548 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1549 (default 8) and @code{gnus-level-killed} to be killed (default 9),
1550 completely dead.  Gnus treats subscribed and unsubscribed groups exactly
1551 the same, but zombie and killed groups have no information on what
1552 articles you have read, etc, stored.  This distinction between dead and
1553 living groups isn't done because it is nice or clever, it is done purely
1554 for reasons of efficiency.
1555
1556 It is recommended that you keep all your mail groups (if any) on quite
1557 low levels (e.g. 1 or 2).
1558
1559 If you want to play with the level variables, you should show some care.
1560 Set them once, and don't touch them ever again.  Better yet, don't touch
1561 them at all unless you know exactly what you're doing.
1562
1563 @vindex gnus-level-default-unsubscribed
1564 @vindex gnus-level-default-subscribed
1565 Two closely related variables are @code{gnus-level-default-subscribed}
1566 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1567 which are the levels that new groups will be put on if they are
1568 (un)subscribed.  These two variables should, of course, be inside the
1569 relevant legal ranges.
1570
1571 @vindex gnus-keep-same-level
1572 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1573 will only move to groups that are of the same level (or lower).  In
1574 particular, going from the last article in one group to the next group
1575 will go to the next group of the same level (or lower).  This might be
1576 handy if you want to read the most important groups before you read the
1577 rest.
1578
1579 @vindex gnus-group-default-list-level
1580 All groups with a level less than or equal to
1581 @code{gnus-group-default-list-level} will be listed in the group buffer
1582 by default.
1583
1584 @vindex gnus-group-list-inactive-groups
1585 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1586 groups will be listed along with the unread groups.  This variable is
1587 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1588 listed. 
1589
1590 @vindex gnus-group-use-permanent-levels
1591 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1592 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1593 use this level as the ``work'' level.
1594
1595 @vindex gnus-activate-level
1596 Gnus will normally just activate groups that are on level
1597 @code{gnus-activate-level} or less.  If you don't want to activate
1598 unsubscribed groups, for instance, you might set this variable to
1599 5.  The default is 6.
1600
1601
1602 @node Group Score
1603 @section Group Score
1604 @cindex group score
1605
1606 You would normally keep important groups on high levels, but that scheme
1607 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1608 group buffer according to how often you read groups, perhaps?  Within
1609 reason?  
1610
1611 This is what @dfn{group score} is for.  You can assign a score to each
1612 group.  You can then sort the group buffer based on this score.
1613 Alternatively, you can sort on score and then level.  (Taken together,
1614 the level and the score is called the @dfn{rank} of the group.  A group
1615 that is on level 4 and has a score of 1 has a higher rank than a group
1616 on level 5 that has a score of 300.  (The level is the most significant
1617 part and the score is the least significant part.))
1618
1619 @findex gnus-summary-bubble-group
1620 If you want groups you read often to get higher scores than groups you
1621 read seldom you can add the @code{gnus-summary-bubble-group} function to
1622 the @code{gnus-summary-exit-hook} hook.  This will result (after
1623 sorting) in a bubbling sort of action.  If you want to see that in
1624 action after each summary exit, you can add
1625 @code{gnus-group-sort-groups-by-rank} or
1626 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1627 slow things down somewhat.
1628
1629
1630 @node Marking Groups
1631 @section Marking Groups
1632 @cindex marking groups
1633
1634 If you want to perform some command on several groups, and they appear
1635 subsequently in the group buffer, you would normally just give a
1636 numerical prefix to the command.  Most group commands will then do your
1637 bidding on those groups.
1638
1639 However, if the groups are not in sequential order, you can still
1640 perform a command on several groups.  You simply mark the groups first
1641 with the process mark and then execute the command.
1642
1643 @table @kbd
1644
1645 @item #
1646 @kindex # (Group)
1647 @itemx M m
1648 @kindex M m (Group)
1649 @findex gnus-group-mark-group
1650 Set the mark on the current group (@code{gnus-group-mark-group}). 
1651
1652 @item M-#
1653 @kindex M-# (Group)
1654 @itemx M u
1655 @kindex M u (Group)
1656 @findex gnus-group-unmark-group
1657 Remove the mark from the current group
1658 (@code{gnus-group-unmark-group}). 
1659
1660 @item M U
1661 @kindex M U (Group)
1662 @findex gnus-group-unmark-all-groups
1663 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). 
1664
1665 @item M w
1666 @kindex M w (Group)
1667 @findex gnus-group-mark-region
1668 Mark all groups between point and mark (@code{gnus-group-mark-region}). 
1669
1670 @item M b
1671 @kindex M b (Group)
1672 @findex gnus-group-mark-buffer
1673 Mark all groups in the buffer (@code{gnus-group-mark-buffer}). 
1674
1675 @item M r
1676 @kindex M r (Group)
1677 @findex gnus-group-mark-regexp
1678 Mark all groups that match some regular expression
1679 (@code{gnus-group-mark-regexp}).  
1680 @end table
1681
1682 Also @pxref{Process/Prefix}.
1683
1684 @findex gnus-group-universal-argument
1685 If you want to execute some command on all groups that have been marked
1686 with the process mark, you can use the @kbd{M-&}
1687 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1688 the command to be executed.
1689
1690
1691 @node Foreign Groups
1692 @section Foreign Groups
1693 @cindex foreign groups
1694
1695 Below are some group mode commands for making and editing general foreign
1696 groups, as well as commands to ease the creation of a few
1697 special-purpose groups.  All these commands insert the newly created
1698 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1699 consulted.
1700
1701 @table @kbd
1702
1703 @item G m
1704 @kindex G m (Group)
1705 @findex gnus-group-make-group
1706 @cindex making groups
1707 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1708 for a name, a method and possibly an @dfn{address}.  For an easier way
1709 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1710
1711 @item G r
1712 @kindex G r (Group)
1713 @findex gnus-group-rename-group
1714 @cindex renaming groups
1715 Rename the current group to something else
1716 (@code{gnus-group-rename-group}).  This is legal only on some
1717 groups---mail groups mostly.  This command might very well be quite slow
1718 on some backends.
1719
1720 @item G c
1721 @kindex G c (Group)
1722 @cindex customizing
1723 @findex gnus-group-customize
1724 Customize the group parameters (@code{gnus-group-customize}).
1725
1726 @item G e
1727 @kindex G e (Group)
1728 @findex gnus-group-edit-group-method
1729 @cindex renaming groups
1730 Enter a buffer where you can edit the select method of the current
1731 group (@code{gnus-group-edit-group-method}).
1732
1733 @item G p
1734 @kindex G p (Group)
1735 @findex gnus-group-edit-group-parameters
1736 Enter a buffer where you can edit the group parameters
1737 (@code{gnus-group-edit-group-parameters}). 
1738
1739 @item G E
1740 @kindex G E (Group)
1741 @findex gnus-group-edit-group
1742 Enter a buffer where you can edit the group info
1743 (@code{gnus-group-edit-group}).
1744
1745 @item G d
1746 @kindex G d (Group)
1747 @findex gnus-group-make-directory-group
1748 @cindex nndir
1749 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1750 for a directory name (@code{gnus-group-make-directory-group}).
1751
1752 @item G h 
1753 @kindex G h (Group)
1754 @cindex help group
1755 @findex gnus-group-make-help-group
1756 Make the Gnus help group (@code{gnus-group-make-help-group}).
1757
1758 @item G a
1759 @kindex G a (Group)
1760 @cindex (ding) archive
1761 @cindex archive group
1762 @findex gnus-group-make-archive-group
1763 @vindex gnus-group-archive-directory
1764 @vindex gnus-group-recent-archive-directory
1765 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1766 default a group pointing to the most recent articles will be created
1767 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1768 group will be created from @code{gnus-group-archive-directory}.
1769
1770 @item G k
1771 @kindex G k (Group)
1772 @findex gnus-group-make-kiboze-group
1773 @cindex nnkiboze
1774 Make a kiboze group.  You will be prompted for a name, for a regexp to
1775 match groups to be ``included'' in the kiboze group, and a series of
1776 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1777 @xref{Kibozed Groups}.
1778
1779 @item G D
1780 @kindex G D (Group)
1781 @findex gnus-group-enter-directory
1782 @cindex nneething
1783 Read an arbitrary directory as if with were a newsgroup with the
1784 @code{nneething} backend (@code{gnus-group-enter-directory}).
1785 @xref{Anything Groups}. 
1786
1787 @item G f
1788 @kindex G f (Group)
1789 @findex gnus-group-make-doc-group
1790 @cindex ClariNet Briefs
1791 @cindex nndoc
1792 Make a group based on some file or other
1793 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1794 command, you will be prompted for a file name and a file type.
1795 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1796 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs}, and
1797 @code{forward}.  If you run this command without a prefix, Gnus will
1798 guess at the file type.  @xref{Document Groups}.
1799
1800 @item G w
1801 @kindex G w (Group)
1802 @findex gnus-group-make-web-group
1803 @cindex DejaNews
1804 @cindex Alta Vista
1805 @cindex InReference
1806 @cindex nnweb
1807 Make an ephemeral group based on a web search
1808 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1809 command, make a solid group instead.  You will be prompted for the
1810 search engine type and the search string.  Legal search engine types
1811 include @code{dejanews}, @code{altavista} and @code{reference}.
1812 @xref{Web Searches}.
1813
1814 @item G DEL
1815 @kindex G DEL (Group)
1816 @findex gnus-group-delete-group
1817 This function will delete the current group
1818 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1819 actually delete all the articles in the group, and forcibly remove the
1820 group itself from the face of the Earth.  Use a prefix only if you are
1821 absolutely sure of what you are doing.
1822
1823 @item G V
1824 @kindex G V (Group)
1825 @findex gnus-group-make-empty-virtual
1826 Make a new, fresh, empty @code{nnvirtual} group
1827 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1828
1829 @item G v
1830 @kindex G v (Group)
1831 @findex gnus-group-add-to-virtual
1832 Add the current group to an @code{nnvirtual} group
1833 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1834 @end table
1835
1836 @xref{Select Methods} for more information on the various select
1837 methods. 
1838
1839 @vindex gnus-activate-foreign-newsgroups
1840 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1841 Gnus will check all foreign groups with this level or lower at startup.
1842 This might take quite a while, especially if you subscribe to lots of
1843 groups from different @sc{nntp} servers.
1844
1845
1846 @node Group Parameters
1847 @section Group Parameters
1848 @cindex group parameters
1849
1850 The group parameters store information local to a particular group:
1851
1852 @table @code
1853 @item to-address
1854 @cindex to-address
1855 If the group parameter list contains an element that looks like
1856 @code{(to-address .  "some@@where.com")}, that address will be used by
1857 the backend when doing followups and posts.  This is primarily useful in
1858 mail groups that represent closed mailing lists---mailing lists where
1859 it's expected that everybody that writes to the mailing list is
1860 subscribed to it.  Since using this parameter ensures that the mail only
1861 goes to the mailing list itself, it means that members won't receive two
1862 copies of your followups.
1863
1864 Using @code{to-address} will actually work whether the group is foreign
1865 or not.  Let's say there's a group on the server that is called
1866 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1867 the articles from a mail-to-news gateway.  Posting directly to this
1868 group is therefore impossible---you have to send mail to the mailing
1869 list address instead. 
1870
1871 @item to-list
1872 @cindex to-list
1873 If the group parameter list has an element that looks like
1874 @code{(to-list . "some@@where.com")}, that address will be used when
1875 doing a @kbd{a} in any group.  It is totally ignored when doing a
1876 followup---except that if it is present in a news group, you'll get mail
1877 group semantics when doing @kbd{f}.
1878
1879 @item broken-reply-to
1880 @cindex broken-reply-to
1881 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1882 headers in this group are to be ignored.  This can be useful if you're
1883 reading a mailing list group where the listserv has inserted
1884 @code{Reply-To} headers that point back to the listserv itself.  This is
1885 broken behavior.  So there!
1886
1887 @item to-group
1888 @cindex to-group
1889 Elements like @code{(to-group . "some.group.name")} means that all
1890 posts in that group will be sent to @code{some.group.name}.  
1891
1892 @item newsgroup
1893 @cindex newsgroup
1894 If this symbol is present in the group parameter list, Gnus will treat
1895 all responses as if they were responses to news articles.  This can be
1896 useful if you have a mail group that's really a mirror of a news group. 
1897
1898 @item gcc-self
1899 @cindex gcc-self
1900 If this symbol is present in the group parameter list and set to
1901 @code{t}, new composed messages will be @code{Gcc}'d to the current
1902 group. If it is present and set to @code{none}, no @code{Gcc:} header
1903 will be generated, if it is present and a string, this string will be
1904 inserted literally as a @code{gcc} header (this symbol takes precedence over
1905 any default @code{Gcc} rules as described later).
1906
1907 @item auto-expire
1908 @cindex auto-expire
1909 If this symbol is present in the group parameter list, all articles that
1910 are read will be marked as expirable.  For an alternative approach,
1911 @pxref{Expiring Mail}.
1912
1913 @item total-expire
1914 @cindex total-expire
1915 If this symbol is present, all read articles will be put through the
1916 expiry process, even if they are not marked as expirable.  Use with
1917 caution. 
1918
1919 @item expiry-wait
1920 @cindex expiry-wait
1921 @vindex nnmail-expiry-wait-function
1922 If the group parameter has an element that looks like @code{(expiry-wait
1923 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1924 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1925 The value can either be a number of days (not necessarily an integer) or
1926 the symbols @code{never} or @code{immediate}.
1927
1928 @item score-file
1929 @cindex score file group parameter
1930 Elements that look like @code{(score-file . "file")} will make
1931 @file{file} into the current score file for the group in question.  This
1932 means that all score commands you issue will end up in that file. 
1933
1934 @item adapt-file
1935 @cindex adapt file group parameter
1936 Elements that look like @code{(adapt-file . "file")} will make
1937 @file{file} into the current adaptive file for the group in question.
1938 All adaptive score entries will be put into this file.
1939
1940 @item admin-address
1941 When unsubscribing to a mailing list you should never send the
1942 unsubscription notice to the mailing list itself.  Instead, you'd send
1943 messages to the administrative address.  This parameter allows you to
1944 put the admin address somewhere convenient.
1945
1946 @item display
1947 Elements that look like @code{(display . MODE)} says which articles to
1948 display on entering the group.  Legal values are:
1949
1950 @table @code
1951 @item all
1952 Display all articles, both read and unread.
1953
1954 @item default
1955 Display the default visible articles, which normally includes unread and
1956 ticked articles.
1957 @end table
1958
1959 @item comment
1960 Elements that look like @code{(comment . "This is a comment")}
1961 are arbitrary comments on the group.  They are currently ignored by
1962 Gnus, but provide a place for you to store information on particular
1963 groups. 
1964
1965 @item @var{(variable form)}
1966 You can use the group parameters to set variables local to the group you
1967 are entering.  If you want to turn threading off in @samp{news.answers},
1968 you could put @code{(gnus-show-threads nil)} in the group parameters of
1969 that group.  @code{gnus-show-threads} will be made into a local variable
1970 in the summary buffer you enter, and the form @code{nil} will be
1971 @code{eval}ed there.
1972
1973 This can also be used as a group-specific hook function, if you'd like.
1974 If you want to hear a beep when you enter a group, you could put
1975 something like @code{(dummy-variable (ding))} in the parameters of that
1976 group.  @code{dummy-variable} will be set to the result of the
1977 @code{(ding)} form, but who cares?
1978
1979 @end table
1980
1981 Use the @kbd{G p} command to edit group parameters of a group.
1982
1983 Also @pxref{Topic Parameters}.
1984
1985
1986 @node Listing Groups
1987 @section Listing Groups
1988 @cindex group listing
1989
1990 These commands all list various slices of the groups that are available.
1991
1992 @table @kbd
1993
1994 @item l
1995 @itemx A s
1996 @kindex A s (Group)
1997 @kindex l (Group)
1998 @findex gnus-group-list-groups
1999 List all groups that have unread articles
2000 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2001 command will list only groups of level ARG and lower.  By default, it
2002 only lists groups of level five (i. e.,
2003 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2004 groups).
2005
2006 @item L
2007 @itemx A u
2008 @kindex A u (Group)
2009 @kindex L (Group)
2010 @findex gnus-group-list-all-groups
2011 List all groups, whether they have unread articles or not
2012 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2013 this command will list only groups of level ARG and lower.  By default,
2014 it lists groups of level seven or lower (i.e., just subscribed and
2015 unsubscribed groups).
2016
2017 @item A l
2018 @kindex A l (Group)
2019 @findex gnus-group-list-level
2020 List all unread groups on a specific level
2021 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2022 with no unread articles.
2023
2024 @item A k
2025 @kindex A k (Group)
2026 @findex gnus-group-list-killed
2027 List all killed groups (@code{gnus-group-list-killed}).  If given a
2028 prefix argument, really list all groups that are available, but aren't
2029 currently (un)subscribed.  This could entail reading the active file
2030 from the server.
2031
2032 @item A z
2033 @kindex A z (Group)
2034 @findex gnus-group-list-zombies
2035 List all zombie groups (@code{gnus-group-list-zombies}).
2036
2037 @item A m
2038 @kindex A m (Group)
2039 @findex gnus-group-list-matching
2040 List all unread, subscribed groups with names that match a regexp
2041 (@code{gnus-group-list-matching}). 
2042
2043 @item A M
2044 @kindex A M (Group)
2045 @findex gnus-group-list-all-matching
2046 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2047
2048 @item A A
2049 @kindex A A (Group)
2050 @findex gnus-group-list-active
2051 List absolutely all groups that are in the active file(s) of the
2052 server(s) you are connected to (@code{gnus-group-list-active}).  This
2053 might very well take quite a while.  It might actually be a better idea
2054 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2055 thing to match on.  Also note that this command may list group that
2056 don't exist (yet)---these will be listed as if they are killed groups.
2057 Take the output with some grains of salt.
2058
2059 @item A a
2060 @kindex A a (Group)
2061 @findex gnus-group-apropos
2062 List all groups that have names that match a regexp
2063 (@code{gnus-group-apropos}).
2064
2065 @item A d
2066 @kindex A d (Group)
2067 @findex gnus-group-description-apropos
2068 List all groups that have names or descriptions that match a regexp
2069 (@code{gnus-group-description-apropos}).
2070
2071 @end table
2072
2073 @vindex gnus-permanently-visible-groups
2074 @cindex visible group parameter
2075 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2076 always be shown, whether they have unread articles or not.  You can also
2077 add the @code{visible} element to the group parameters in question to
2078 get the same effect.
2079
2080 @vindex gnus-list-groups-with-ticked-articles
2081 Groups that have just ticked articles in it are normally listed in the
2082 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2083 @code{nil}, these groups will be treated just like totally empty
2084 groups.  It is @code{t} by default.
2085
2086
2087 @node Sorting Groups
2088 @section Sorting Groups
2089 @cindex sorting groups
2090
2091 @kindex C-c C-s (Group)
2092 @findex gnus-group-sort-groups
2093 @vindex gnus-group-sort-function
2094 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2095 group buffer according to the function(s) given by the
2096 @code{gnus-group-sort-function} variable.  Available sorting functions
2097 include: 
2098
2099 @table @code
2100
2101 @item gnus-group-sort-by-alphabet
2102 @findex gnus-group-sort-by-alphabet
2103 Sort the group names alphabetically.  This is the default.
2104
2105 @item gnus-group-sort-by-real-name
2106 @findex gnus-group-sort-by-real-name
2107 Sort the group alphabetically on the real (unprefixed) group names.
2108
2109 @item gnus-group-sort-by-level
2110 @findex gnus-group-sort-by-level
2111 Sort by group level.
2112
2113 @item gnus-group-sort-by-score
2114 @findex gnus-group-sort-by-score
2115 Sort by group score.
2116
2117 @item gnus-group-sort-by-rank
2118 @findex gnus-group-sort-by-rank
2119 Sort by group score and then the group level.  The level and the score
2120 are, when taken together, the group's @dfn{rank}. 
2121
2122 @item gnus-group-sort-by-unread
2123 @findex gnus-group-sort-by-unread
2124 Sort by number of unread articles.
2125
2126 @item gnus-group-sort-by-method
2127 @findex gnus-group-sort-by-method
2128 Sort alphabetically on the select method.
2129
2130
2131 @end table
2132
2133 @code{gnus-group-sort-function} can also be a list of sorting
2134 functions.  In that case, the most significant sort key function must be
2135 the last one.
2136
2137
2138 There are also a number of commands for sorting directly according to
2139 some sorting criteria:
2140
2141 @table @kbd
2142 @item G S a
2143 @kindex G S a (Group)
2144 @findex gnus-group-sort-groups-by-alphabet
2145 Sort the group buffer alphabetically by group name
2146 (@code{gnus-group-sort-groups-by-alphabet}). 
2147
2148 @item G S u
2149 @kindex G S u (Group)
2150 @findex gnus-group-sort-groups-by-unread
2151 Sort the group buffer by the number of unread articles
2152 (@code{gnus-group-sort-groups-by-unread}).
2153
2154 @item G S l
2155 @kindex G S l (Group)
2156 @findex gnus-group-sort-groups-by-level
2157 Sort the group buffer by group level
2158 (@code{gnus-group-sort-groups-by-level}). 
2159
2160 @item G S v
2161 @kindex G S v (Group)
2162 @findex gnus-group-sort-groups-by-score
2163 Sort the group buffer by group score
2164 (@code{gnus-group-sort-groups-by-score}). 
2165
2166 @item G S r
2167 @kindex G S r (Group)
2168 @findex gnus-group-sort-groups-by-rank
2169 Sort the group buffer by group rank
2170 (@code{gnus-group-sort-groups-by-rank}). 
2171
2172 @item G S m
2173 @kindex G S m (Group)
2174 @findex gnus-group-sort-groups-by-method
2175 Sort the group buffer alphabetically by backend name
2176 (@code{gnus-group-sort-groups-by-method}). 
2177
2178 @end table
2179
2180 When given a prefix, all these commands will sort in reverse order. 
2181
2182 You can also sort a subset of the groups:
2183
2184 @table @kbd
2185 @item G P a
2186 @kindex G P a (Group)
2187 @findex gnus-group-sort-selected-groups-by-alphabet
2188 Sort the process/prefixed groups in the group buffer alphabetically by
2189 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2190
2191 @item G P u
2192 @kindex G P u (Group)
2193 @findex gnus-group-sort-selected-groups-by-unread
2194 Sort the process/prefixed groups in the group buffer by the number of
2195 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2196
2197 @item G P l
2198 @kindex G P l (Group)
2199 @findex gnus-group-sort-selected-groups-by-level
2200 Sort the process/prefixed groups in the group buffer by group level
2201 (@code{gnus-group-sort-selected-groups-by-level}).
2202
2203 @item G P v
2204 @kindex G P v (Group)
2205 @findex gnus-group-sort-selected-groups-by-score
2206 Sort the process/prefixed groups in the group buffer by group score
2207 (@code{gnus-group-sort-selected-groups-by-score}).
2208
2209 @item G P r
2210 @kindex G P r (Group)
2211 @findex gnus-group-sort-selected-groups-by-rank
2212 Sort the process/prefixed groups in the group buffer by group rank
2213 (@code{gnus-group-sort-selected-groups-by-rank}).
2214
2215 @item G P m
2216 @kindex G P m (Group)
2217 @findex gnus-group-sort-selected-groups-by-method
2218 Sort the process/prefixed groups in the group buffer alphabetically by
2219 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2220
2221 @end table
2222
2223
2224
2225 @node Group Maintenance
2226 @section Group Maintenance
2227 @cindex bogus groups
2228
2229 @table @kbd
2230 @item b
2231 @kindex b (Group)
2232 @findex gnus-group-check-bogus-groups
2233 Find bogus groups and delete them
2234 (@code{gnus-group-check-bogus-groups}).
2235
2236 @item F
2237 @kindex F (Group)
2238 @findex gnus-find-new-newsgroups
2239 Find new groups and process them (@code{gnus-find-new-newsgroups}).  If
2240 given a prefix, use the @code{ask-server} method to query the server for
2241 new groups.
2242
2243 @item C-c C-x
2244 @kindex C-c C-x (Group)
2245 @findex gnus-group-expire-articles
2246 Run all expirable articles in the current group through the expiry
2247 process (if any) (@code{gnus-group-expire-articles}).
2248
2249 @item C-c M-C-x
2250 @kindex C-c M-C-x (Group)
2251 @findex gnus-group-expire-all-groups
2252 Run all articles in all groups through the expiry process
2253 (@code{gnus-group-expire-all-groups}).
2254
2255 @end table
2256
2257
2258 @node Browse Foreign Server
2259 @section Browse Foreign Server
2260 @cindex foreign servers
2261 @cindex browsing servers
2262
2263 @table @kbd
2264 @item B
2265 @kindex B (Group)
2266 @findex gnus-group-browse-foreign-server
2267 You will be queried for a select method and a server name.  Gnus will
2268 then attempt to contact this server and let you browse the groups there
2269 (@code{gnus-group-browse-foreign-server}).
2270 @end table
2271
2272 @findex gnus-browse-mode
2273 A new buffer with a list of available groups will appear.  This buffer
2274 will be use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2275 a lot) like a normal group buffer.
2276
2277 Here's a list of keystrokes available in the browse mode:
2278
2279 @table @kbd
2280 @item n
2281 @kindex n (Browse)
2282 @findex gnus-group-next-group
2283 Go to the next group (@code{gnus-group-next-group}).
2284
2285 @item p
2286 @kindex p (Browse)
2287 @findex gnus-group-prev-group
2288 Go to the previous group (@code{gnus-group-prev-group}).
2289
2290 @item SPACE
2291 @kindex SPACE (Browse)
2292 @findex gnus-browse-read-group
2293 Enter the current group and display the first article
2294 (@code{gnus-browse-read-group}). 
2295
2296 @item RET
2297 @kindex RET (Browse)
2298 @findex gnus-browse-select-group
2299 Enter the current group (@code{gnus-browse-select-group}). 
2300
2301 @item u
2302 @kindex u (Browse)
2303 @findex gnus-browse-unsubscribe-current-group
2304 Unsubscribe to the current group, or, as will be the case here,
2305 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
2306
2307 @item l
2308 @itemx q
2309 @kindex q (Browse)
2310 @kindex l (Browse)
2311 @findex gnus-browse-exit
2312 Exit browse mode (@code{gnus-browse-exit}).
2313
2314 @item ?
2315 @kindex ? (Browse)
2316 @findex gnus-browse-describe-briefly
2317 Describe browse mode briefly (well, there's not much to describe, is
2318 there) (@code{gnus-browse-describe-briefly}).
2319 @end table
2320
2321
2322 @node Exiting Gnus
2323 @section Exiting Gnus
2324 @cindex exiting Gnus
2325
2326 Yes, Gnus is ex(c)iting.
2327
2328 @table @kbd
2329 @item z
2330 @kindex z (Group)
2331 @findex gnus-group-suspend
2332 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2333 but it kills all buffers except the Group buffer.  I'm not sure why this
2334 is a gain, but then who am I to judge?
2335
2336 @item q
2337 @kindex q (Group)
2338 @findex gnus-group-exit
2339 Quit Gnus (@code{gnus-group-exit}).
2340
2341 @item Q
2342 @kindex Q (Group)
2343 @findex gnus-group-quit
2344 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2345 The dribble file will be saved, though (@pxref{Auto Save}).
2346 @end table
2347
2348 @vindex gnus-exit-gnus-hook
2349 @vindex gnus-suspend-gnus-hook
2350 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2351 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2352 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2353 exiting Gnus.
2354
2355 @findex gnus-unload
2356 @cindex unloading
2357 If you wish to completely unload Gnus and all its adherents, you can use
2358 the @code{gnus-unload} command.  This command is also very handy when
2359 trying to customize meta-variables.
2360
2361 Note:
2362
2363 @quotation
2364 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2365 numbly heavy and herself fall into a hazy trance as the boy sitting
2366 behind her drew repeated lines with his pencil across the back of her
2367 plastic chair.
2368 @end quotation
2369
2370
2371 @node Group Topics
2372 @section Group Topics
2373 @cindex topics
2374
2375 If you read lots and lots of groups, it might be convenient to group
2376 them hierarchically according to topics.  You put your Emacs groups over
2377 here, your sex groups over there, and the rest (what, two groups or so?)
2378 you put in some misc section that you never bother with anyway.  You can
2379 even group the Emacs sex groups as a sub-topic to either the Emacs
2380 groups or the sex groups---or both!  Go wild!
2381
2382 Here's an example:
2383
2384 @example
2385 Gnus
2386   Emacs -- I wuw it!
2387      3: comp.emacs
2388      2: alt.religion.emacs
2389     Naughty Emacs
2390      452: alt.sex.emacs
2391        0: comp.talk.emacs.recovery
2392   Misc
2393      8: comp.binaries.fractals
2394     13: comp.sources.unix
2395 @end example
2396
2397 @findex gnus-topic-mode
2398 @kindex t (Group)
2399 To get this @emph{fab} functionality you simply turn on (ooh!) the
2400 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2401 is a toggling command.)
2402
2403 Go ahead, just try it.  I'll still be here when you get back.  La de
2404 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2405 press @kbd{l}.  There.  All your groups are now listed under
2406 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2407 bothered?
2408
2409 If you want this permanently enabled, you should add that minor mode to
2410 the hook for the group mode:
2411
2412 @lisp
2413 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2414 @end lisp
2415
2416 @menu 
2417 * Topic Variables::    How to customize the topics the Lisp Way.
2418 * Topic Commands::     Interactive E-Z commands.
2419 * Topic Sorting::      Sorting each topic individually.
2420 * Topic Topology::     A map of the world.
2421 * Topic Parameters::   Parameters that apply to all groups in a topic.
2422 @end menu
2423
2424
2425 @node Topic Variables
2426 @subsection Topic Variables
2427 @cindex topic variables
2428
2429 Now, if you select a topic, if will fold/unfold that topic, which is
2430 really neat, I think.
2431
2432 @vindex gnus-topic-line-format
2433 The topic lines themselves are created according to the
2434 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2435 Legal elements are:
2436
2437 @table @samp
2438 @item i
2439 Indentation.
2440 @item n
2441 Topic name.
2442 @item v
2443 Visibility.
2444 @item l
2445 Level.
2446 @item g
2447 Number of groups in the topic.
2448 @item a
2449 Number of unread articles in the topic.
2450 @item A 
2451 Number of unread articles in the topic and all its subtopics. 
2452 @end table
2453
2454 @vindex gnus-topic-indent-level
2455 Each sub-topic (and the groups in the sub-topics) will be indented with
2456 @code{gnus-topic-indent-level} times the topic level number of spaces.
2457 The default is 2.
2458
2459 @vindex gnus-topic-mode-hook
2460 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2461
2462 @vindex gnus-topic-display-empty-topics
2463 The @code{gnus-topic-display-empty-topics} says whether to display even
2464 topics that have no unread articles in them.  The default is @code{t}.
2465
2466
2467 @node Topic Commands
2468 @subsection Topic Commands
2469 @cindex topic commands
2470
2471 When the topic minor mode is turned on, a new @kbd{T} submap will be
2472 available.  In addition, a few of the standard keys change their
2473 definitions slightly.
2474
2475 @table @kbd
2476
2477 @item T n
2478 @kindex T n (Topic)
2479 @findex gnus-topic-create-topic
2480 Prompt for a new topic name and create it 
2481 (@code{gnus-topic-create-topic}). 
2482
2483 @item T m
2484 @kindex T m (Topic)
2485 @findex gnus-topic-move-group
2486 Move the current group to some other topic
2487 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2488 convention (@pxref{Process/Prefix}).
2489
2490 @item T c
2491 @kindex T c (Topic)
2492 @findex gnus-topic-copy-group
2493 Copy the current group to some other topic
2494 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2495 convention (@pxref{Process/Prefix}).
2496
2497 @item T D
2498 @kindex T D (Topic)
2499 @findex gnus-topic-remove-group
2500 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2501 This command uses the process/prefix convention
2502 (@pxref{Process/Prefix}).
2503
2504 @item T M
2505 @kindex T M (Topic)
2506 @findex gnus-topic-move-matching
2507 Move all groups that match some regular expression to a topic
2508 (@code{gnus-topic-move-matching}). 
2509
2510 @item T C
2511 @kindex T C (Topic)
2512 @findex gnus-topic-copy-matching
2513 Copy all groups that match some regular expression to a topic
2514 (@code{gnus-topic-copy-matching}). 
2515
2516 @item T #
2517 @kindex T # (Topic)
2518 @findex gnus-topic-mark-topic
2519 Mark all groups in the current topic with the process mark
2520 (@code{gnus-topic-mark-topic}). 
2521
2522 @item T M-#
2523 @kindex T M-# (Topic)
2524 @findex gnus-topic-unmark-topic
2525 Remove the process mark from all groups in the current topic
2526 (@code{gnus-topic-unmark-topic}). 
2527
2528 @item RET
2529 @kindex RET (Topic)
2530 @findex gnus-topic-select-group
2531 @itemx SPACE
2532 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2533 When you perform this command on a group, you'll enter the group, as
2534 usual.  When done on a topic line, the topic will be folded (if it was
2535 visible) or unfolded (if it was folded already).  So it's basically a
2536 toggling command on topics.  In addition, if you give a numerical
2537 prefix, group on that level (and lower) will be displayed.
2538
2539 @item T TAB
2540 @kindex T TAB (Topic)
2541 @findex gnus-topic-indent
2542 ``Indent'' the current topic so that it becomes a sub-topic of the
2543 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2544 ``un-indent'' the topic instead.
2545
2546 @item C-k
2547 @kindex C-k (Topic)
2548 @findex gnus-topic-kill-group
2549 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2550 topic will be removed along with the topic.
2551
2552 @item C-y
2553 @kindex C-y (Topic)
2554 @findex gnus-topic-yank-group
2555 Yank the previously killed group or topic
2556 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2557 before all groups. 
2558
2559 @item T r
2560 @kindex T r (Topic)
2561 @findex gnus-topic-rename
2562 Rename a topic (@code{gnus-topic-rename}). 
2563
2564 @item T DEL
2565 @kindex T DEL (Topic)
2566 @findex gnus-topic-delete
2567 Delete an empty topic (@code{gnus-topic-delete}). 
2568
2569 @item A T
2570 @kindex A T (Topic)
2571 @findex gnus-topic-list-active
2572 List all groups that Gnus knows about in a topics-ified way
2573 (@code{gnus-topic-list-active}).
2574
2575 @item G p
2576 @kindex G p (Topic)
2577 @findex gnus-topic-edit-parameters
2578 @cindex group parameters
2579 @cindex topic parameters
2580 @cindex parameters
2581 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2582 @xref{Topic Parameters}.
2583
2584 @end table
2585
2586
2587 @node Topic Sorting
2588 @subsection Topic Sorting
2589 @cindex topic sorting
2590
2591 You can sort the groups in each topic individually with the following
2592 commands: 
2593
2594
2595 @table @kbd
2596 @item T S a
2597 @kindex T S a (Topic)
2598 @findex gnus-topic-sort-groups-by-alphabet
2599 Sort the current topic alphabetically by group name
2600 (@code{gnus-topic-sort-groups-by-alphabet}). 
2601
2602 @item T S u
2603 @kindex T S u (Topic)
2604 @findex gnus-topic-sort-groups-by-unread
2605 Sort the current topic by the number of unread articles
2606 (@code{gnus-topic-sort-groups-by-unread}).
2607
2608 @item T S l
2609 @kindex T S l (Topic)
2610 @findex gnus-topic-sort-groups-by-level
2611 Sort the current topic by group level
2612 (@code{gnus-topic-sort-groups-by-level}). 
2613
2614 @item T S v
2615 @kindex T S v (Topic)
2616 @findex gnus-topic-sort-groups-by-score
2617 Sort the current topic by group score
2618 (@code{gnus-topic-sort-groups-by-score}). 
2619
2620 @item T S r
2621 @kindex T S r (Topic)
2622 @findex gnus-topic-sort-groups-by-rank
2623 Sort the current topic by group rank
2624 (@code{gnus-topic-sort-groups-by-rank}). 
2625
2626 @item T S m
2627 @kindex T S m (Topic)
2628 @findex gnus-topic-sort-groups-by-method
2629 Sort the current topic alphabetically by backend name
2630 (@code{gnus-topic-sort-groups-by-method}). 
2631
2632 @end table
2633
2634 @xref{Sorting Groups} for more information about group sorting. 
2635
2636
2637 @node Topic Topology
2638 @subsection Topic Topology
2639 @cindex topic topology
2640 @cindex topology
2641
2642 So, let's have a look at an example group buffer:
2643
2644 @example
2645 Gnus
2646   Emacs -- I wuw it!
2647      3: comp.emacs
2648      2: alt.religion.emacs
2649     Naughty Emacs
2650      452: alt.sex.emacs
2651        0: comp.talk.emacs.recovery
2652   Misc
2653      8: comp.binaries.fractals
2654     13: comp.sources.unix
2655 @end example
2656
2657 So, here we have one top-level topic (@samp{Gnus}), two topics under
2658 that, and one sub-topic under one of the sub-topics.  (There is always
2659 just one (1) top-level topic).  This topology can be expressed as
2660 follows:
2661
2662 @lisp
2663 (("Gnus" visible)
2664  (("Emacs -- I wuw it!" visible) 
2665   (("Naughty Emacs" visible)))
2666  (("Misc" visible)))
2667 @end lisp
2668
2669 @vindex gnus-topic-topology
2670 This is in fact how the variable @code{gnus-topic-topology} would look
2671 for the display above.  That variable is saved in the @file{.newsrc.eld}
2672 file, and shouldn't be messed with manually---unless you really want
2673 to.  Since this variable is read from the @file{.newsrc.eld} file,
2674 setting it in any other startup files will have no effect.  
2675
2676 This topology shows what topics are sub-topics of what topics (right),
2677 and which topics are visible.  Two settings are currently
2678 allowed---@code{visible} and @code{invisible}.
2679
2680
2681 @node Topic Parameters
2682 @subsection Topic Parameters
2683 @cindex topic parameters
2684
2685 All groups in a topic will inherit group parameters from the parent (and
2686 ancestor) topic parameters.  All legal group parameters are legal topic
2687 parameters (@pxref{Group Parameters}).  
2688
2689 Group parameters (of course) override topic parameters, and topic
2690 parameters in sub-topics override topic parameters in super-topics.  You
2691 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2692 verb, although you may feel free to disagree with me here.)
2693
2694 @example
2695 Gnus
2696   Emacs
2697      3: comp.emacs
2698      2: alt.religion.emacs
2699    452: alt.sex.emacs
2700     Relief
2701      452: alt.sex.emacs
2702        0: comp.talk.emacs.recovery
2703   Misc
2704      8: comp.binaries.fractals
2705     13: comp.sources.unix
2706    452: alt.sex.emacs
2707 @end example
2708
2709 The @samp{Emacs} topic has the topic parameter @code{(score-file
2710 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2711 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2712 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2713 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2714 . "religion.SCORE")}.
2715
2716 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2717 will get the @file{relief.SCORE} home score file.  If you enter the same
2718 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2719 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2720 get the @file{religion.SCORE} home score file.
2721
2722 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2723 there are some problems, especially with the @code{total-expiry}
2724 parameter.  Say you have a mail group in two topics; one with
2725 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2726 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2727 of these topics you mean to expire articles from, so anything may
2728 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2729 happens.  You just have to be careful if you do stuff like that.
2730
2731
2732 @node Misc Group Stuff
2733 @section Misc Group Stuff
2734
2735 @menu
2736 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2737 * Group Information::     Information and help on groups and Gnus.
2738 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2739 * File Commands::         Reading and writing the Gnus files.
2740 @end menu
2741
2742 @table @kbd
2743
2744 @item ^
2745 @kindex ^ (Group)
2746 @findex gnus-group-enter-server-mode
2747 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2748 @xref{The Server Buffer}.
2749
2750 @item a
2751 @kindex a (Group)
2752 @findex gnus-group-post-news
2753 Post an article to a group (@code{gnus-group-post-news}).  The current
2754 group name will be used as the default.
2755
2756 @item m
2757 @kindex m (Group)
2758 @findex gnus-group-mail
2759 Mail a message somewhere (@code{gnus-group-mail}).
2760
2761 @end table
2762
2763 Variables for the group buffer:
2764
2765 @table @code
2766
2767 @item gnus-group-mode-hook
2768 @vindex gnus-group-mode-hook
2769 @code{gnus-group-mode-hook} is called after the group buffer has been
2770 created. 
2771
2772 @item gnus-group-prepare-hook
2773 @vindex gnus-group-prepare-hook
2774 @code{gnus-group-prepare-hook} is called after the group buffer is
2775 generated.  It may be used to modify the buffer in some strange,
2776 unnatural way.
2777
2778 @item gnus-permanently-visible-groups
2779 @vindex gnus-permanently-visible-groups
2780 Groups matching this regexp will always be listed in the group buffer,
2781 whether they are empty or not.
2782
2783 @end table
2784
2785
2786 @node Scanning New Messages
2787 @subsection Scanning New Messages
2788 @cindex new messages
2789 @cindex scanning new news
2790
2791 @table @kbd
2792
2793 @item g
2794 @kindex g (Group)
2795 @findex gnus-group-get-new-news
2796 Check the server(s) for new articles.  If the numerical prefix is used,
2797 this command will check only groups of level @var{arg} and lower
2798 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2799 command will force a total rereading of the active file(s) from the
2800 backend(s).
2801
2802 @item M-g
2803 @kindex M-g (Group)
2804 @findex gnus-group-get-new-news-this-group
2805 @vindex gnus-goto-next-group-when-activating
2806 Check whether new articles have arrived in the current group
2807 (@code{gnus-group-get-new-news-this-group}).
2808 @code{gnus-goto-next-group-when-activating} says whether this command is
2809 to move point to the next group or not.  It is @code{t} by default.
2810
2811 @findex gnus-activate-all-groups
2812 @cindex activating groups
2813 @item C-c M-g
2814 @kindex C-c M-g (Group)
2815 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2816
2817 @item R
2818 @kindex R (Group)
2819 @cindex restarting
2820 @findex gnus-group-restart
2821 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2822 file(s), closes the connection to all servers, clears up all run-time
2823 Gnus variables, and then starts Gnus all over again.
2824
2825 @end table
2826
2827 @vindex gnus-get-new-news-hook
2828 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2829
2830 @vindex gnus-after-getting-new-news-hook
2831 @code{gnus-after-getting-new-news-hook} is run after checking for new
2832 news.
2833
2834
2835 @node Group Information
2836 @subsection Group Information
2837 @cindex group information
2838 @cindex information on groups
2839
2840 @table @kbd
2841
2842
2843 @item H f
2844 @kindex H f (Group)
2845 @itemx M-f
2846 @findex gnus-group-fetch-faq
2847 @vindex gnus-group-faq-directory
2848 @cindex FAQ
2849 @cindex ange-ftp
2850 Try to fetch the FAQ for the current group
2851 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2852 @code{gnus-group-faq-directory}, which is usually a directory on a
2853 remote machine.  This variable can also be a list of directories.  In
2854 that case, giving a prefix to this command will allow you to choose
2855 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2856 for fetching the file.
2857
2858 If fetching from the first site is unsuccessful, Gnus will attempt to go
2859 through @code{gnus-group-faq-directory} and try to open them one by one.
2860
2861 @item H d
2862 @itemx C-c C-d
2863 @kindex H d (Group)
2864 @kindex C-c C-d (Group)
2865 @cindex describing groups
2866 @cindex group description
2867 @findex gnus-group-describe-group
2868 Describe the current group (@code{gnus-group-describe-group}).  If given
2869 a prefix, force Gnus to re-read the description from the server.
2870
2871 @item M-d
2872 @kindex M-d (Group)
2873 @findex gnus-group-describe-all-groups
2874 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2875 prefix, force Gnus to re-read the description file from the server.
2876
2877 @item V
2878 @kindex V (Group)
2879 @cindex version
2880 @findex gnus-version
2881 Display current Gnus version numbers (@code{gnus-version}).
2882
2883 @item ?
2884 @kindex ? (Group)
2885 @findex gnus-group-describe-briefly
2886 Give a very short help message (@code{gnus-group-describe-briefly}).
2887
2888 @item C-c C-i
2889 @kindex C-c C-i (Group)
2890 @cindex info
2891 @cindex manual
2892 @findex gnus-info-find-node
2893 Go to the Gnus info node (@code{gnus-info-find-node}).
2894 @end table
2895
2896
2897 @node Group Timestamp
2898 @subsection Group Timestamp
2899 @cindex timestamps
2900 @cindex group timestamps
2901
2902 It can be convenient to let Gnus keep track of when you last read a
2903 group.  To set the ball rolling, you should add
2904 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2905
2906 @lisp
2907 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2908 @end lisp
2909
2910 After doing this, each time you enter a group, it'll be recorded.
2911
2912 This information can be displayed in various ways---the easiest is to
2913 use the @samp{%d} spec in the group line format:
2914
2915 @lisp
2916 (setq gnus-group-line-format 
2917       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2918 @end lisp
2919
2920 This will result in lines looking like:
2921
2922 @example
2923 *        0: mail.ding                                19961002T012943
2924          0: custom                                   19961002T012713
2925 @end example
2926
2927 As you can see, the date is displayed in compact ISO 8601 format.  This
2928 may be a bit too much, so to just display the date, you could say
2929 something like:
2930
2931 @lisp
2932 (setq gnus-group-line-format 
2933       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2934 @end lisp
2935
2936
2937 @node File Commands
2938 @subsection File Commands
2939 @cindex file commands
2940
2941 @table @kbd
2942
2943 @item r
2944 @kindex r (Group)
2945 @findex gnus-group-read-init-file
2946 @vindex gnus-init-file
2947 @cindex reading init file
2948 Re-read the init file (@code{gnus-init-file}, which defaults to
2949 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2950
2951 @item s
2952 @kindex s (Group)
2953 @findex gnus-group-save-newsrc
2954 @cindex saving .newsrc
2955 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2956 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
2957 file(s) whether Gnus thinks it is necessary or not.
2958
2959 @c @item Z
2960 @c @kindex Z (Group)
2961 @c @findex gnus-group-clear-dribble
2962 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2963
2964 @end table
2965
2966
2967 @node The Summary Buffer
2968 @chapter The Summary Buffer
2969 @cindex summary buffer
2970
2971 A line for each article is displayed in the summary buffer.  You can
2972 move around, read articles, post articles and reply to articles.
2973
2974 The most common way to a summary buffer is to select a group from the
2975 group buffer (@pxref{Selecting a Group}).  
2976
2977 You can have as many summary buffers open as you wish.
2978
2979 @menu
2980 * Summary Buffer Format::       Deciding how the summary buffer is to look.
2981 * Summary Maneuvering::         Moving around the summary buffer.
2982 * Choosing Articles::           Reading articles.
2983 * Paging the Article::          Scrolling the current article.
2984 * Reply Followup and Post::     Posting articles.
2985 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
2986 * Marking Articles::            Marking articles as read, expirable, etc.
2987 * Limiting::                    You can limit the summary buffer.
2988 * Threading::                   How threads are made.
2989 * Sorting::                     How articles and threads are sorted.
2990 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
2991 * Article Caching::             You may store articles in a cache.
2992 * Persistent Articles::         Making articles expiry-resistant.
2993 * Article Backlog::             Having already read articles hang around.
2994 * Saving Articles::             Ways of customizing article saving.
2995 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
2996 * Article Treatment::           The article buffer can be mangled at will.
2997 * Article Commands::            Doing various things with the article buffer.
2998 * Summary Sorting::             Sorting the summary buffer in various ways.
2999 * Finding the Parent::          No child support? Get the parent.
3000 * Alternative Approaches::      Reading using non-default summaries.
3001 * Tree Display::                A more visual display of threads.
3002 * Mail Group Commands::         Some commands can only be used in mail groups.
3003 * Various Summary Stuff::       What didn't fit anywhere else.
3004 * Exiting the Summary Buffer::  Returning to the Group buffer.
3005 * Crosspost Handling::          How crossposted articles are dealt with.
3006 * Duplicate Suppression::       An alternative when crosspost handling fails.
3007 @end menu
3008
3009
3010 @node Summary Buffer Format
3011 @section Summary Buffer Format
3012 @cindex summary buffer format
3013
3014 @menu
3015 * Summary Buffer Lines::     You can specify how summary lines should look.
3016 * Summary Buffer Mode Line:: You can say how the mode line should look.
3017 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3018 @end menu
3019
3020 @findex mail-extract-address-components
3021 @findex gnus-extract-address-components
3022 @vindex gnus-extract-address-components
3023 Gnus will use the value of the @code{gnus-extract-address-components}
3024 variable as a function for getting the name and address parts of a
3025 @code{From} header.  Two pre-defined function exist:
3026 @code{gnus-extract-address-components}, which is the default, quite
3027 fast, and too simplistic solution; and
3028 @code{mail-extract-address-components}, which works very nicely, but is
3029 slower.  The default function will return the wrong answer in 5% of the
3030 cases.  If this is unacceptable to you, use the other function instead.
3031
3032 @vindex gnus-summary-same-subject
3033 @code{gnus-summary-same-subject} is a string indicating that the current
3034 article has the same subject as the previous.  This string will be used
3035 with those specs that require it.  The default is @samp{}.
3036
3037
3038 @node Summary Buffer Lines
3039 @subsection Summary Buffer Lines
3040
3041 @vindex gnus-summary-line-format
3042 You can change the format of the lines in the summary buffer by changing
3043 the @code{gnus-summary-line-format} variable.  It works along the same
3044 lines a a normal @code{format} string, with some extensions
3045 (@pxref{Formatting Variables}).
3046
3047 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3048
3049 The following format specification characters are understood:
3050
3051 @table @samp
3052 @item N 
3053 Article number.
3054 @item S
3055 Subject string.
3056 @item s
3057 Subject if the article is the root or the previous article had a
3058 different subject, @code{gnus-summary-same-subject} otherwise.
3059 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3060 @item F
3061 Full @code{From} header.
3062 @item n
3063 The name (from the @code{From} header).
3064 @item a
3065 The name (from the @code{From} header).  This differs from the @code{n}
3066 spec in that it uses the function designated by the
3067 @code{gnus-extract-address-components} variable, which is slower, but
3068 may be more thorough.
3069 @item A
3070 The address (from the @code{From} header).  This works the same way as
3071 the @code{a} spec.
3072 @item L
3073 Number of lines in the article.
3074 @item c
3075 Number of characters in the article.
3076 @item I
3077 Indentation based on thread level (@pxref{Customizing Threading}).
3078 @item T
3079 Nothing if the article is a root and lots of spaces if it isn't (it
3080 pushes everything after it off the screen).
3081 @item [
3082 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3083 for adopted articles (@pxref{Customizing Threading}).
3084 @item ]
3085 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3086 for adopted articles.
3087 @item >
3088 One space for each thread level.
3089 @item <
3090 Twenty minus thread level spaces.
3091 @item U
3092 Unread.
3093 @item R
3094 Replied.
3095 @item i
3096 Score as a number.
3097 @item z
3098 @vindex gnus-summary-zcore-fuzz
3099 Zcore, @samp{+} if above the default level and @samp{-} if below the
3100 default level.  If the difference between
3101 @code{gnus-summary-default-level} and the score is less than
3102 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3103 @item V
3104 Total thread score.
3105 @item x
3106 @code{Xref}.
3107 @item D
3108 @code{Date}.
3109 @item d
3110 The @code{Date} in @code{YY-MMM} format.
3111 @item o
3112 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3113 @item M
3114 @code{Message-ID}.
3115 @item r
3116 @code{References}.
3117 @item t
3118 Number of articles in the current sub-thread.  Using this spec will slow
3119 down summary buffer generation somewhat.
3120 @item e
3121 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3122 article has any children.
3123 @item P
3124 The line number.
3125 @item u
3126 User defined specifier.  The next character in the format string should
3127 be a letter.  @sc{gnus} will call the function
3128 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3129 following @samp{%u}.  The function will be passed the current header as
3130 argument.  The function should return a string, which will be inserted
3131 into the summary just like information from any other summary specifier.
3132 @end table
3133
3134 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3135 have to be handled with care.  For reasons of efficiency, Gnus will
3136 compute what column these characters will end up in, and ``hard-code''
3137 that.  This means that it is illegal to have these specs after a
3138 variable-length spec.  Well, you might not be arrested, but your summary
3139 buffer will look strange, which is bad enough.
3140
3141 The smart choice is to have these specs as far to the left as possible.
3142 (Isn't that the case with everything, though?  But I digress.)
3143
3144 This restriction may disappear in later versions of Gnus.
3145
3146
3147 @node Summary Buffer Mode Line
3148 @subsection Summary Buffer Mode Line
3149
3150 @vindex gnus-summary-mode-line-format
3151 You can also change the format of the summary mode bar.  Set
3152 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3153 is @samp{Gnus: %%b [%A] %Z}.  
3154
3155 Here are the elements you can play with:
3156
3157 @table @samp
3158 @item G
3159 Group name.
3160 @item p
3161 Unprefixed group name.
3162 @item A
3163 Current article number.
3164 @item V
3165 Gnus version.
3166 @item U
3167 Number of unread articles in this group.
3168 @item e
3169 Number of unselected articles in this group.
3170 @item Z
3171 A string with the number of unread and unselected articles represented
3172 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3173 articles, and just as @samp{<%U more>} if there are just unread articles
3174 and no unselected ones.
3175 @item g
3176 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3177 shortened to @samp{r.a.anime}. 
3178 @item S
3179 Subject of the current article.
3180 @item u
3181 User-defined spec.
3182 @item s
3183 Name of the current score file.
3184 @item d
3185 Number of dormant articles.
3186 @item t
3187 Number of ticked articles.
3188 @item r
3189 Number of articles that have been marked as read in this session. 
3190 @item E
3191 Number of articles expunged by the score files.
3192 @end table
3193
3194
3195 @node Summary Highlighting
3196 @subsection Summary Highlighting
3197
3198 @table @code
3199
3200 @item gnus-visual-mark-article-hook
3201 @vindex gnus-visual-mark-article-hook
3202 This hook is run after selecting an article.  It is meant to be used for
3203 highlighting the article in some way.  It is not run if
3204 @code{gnus-visual} is @code{nil}.
3205
3206 @item gnus-summary-update-hook
3207 @vindex gnus-summary-update-hook
3208 This hook is called when a summary line is changed.  It is not run if
3209 @code{gnus-visual} is @code{nil}.
3210
3211 @item gnus-summary-selected-face
3212 @vindex gnus-summary-selected-face
3213 This is the face (or @dfn{font} as some people call it) that is used to
3214 highlight the current article in the summary buffer.
3215
3216 @item gnus-summary-highlight
3217 @vindex gnus-summary-highlight
3218 Summary lines are highlighted according to this variable, which is a
3219 list where the elements are on the format @var{(FORM . FACE)}.  If you
3220 would, for instance, like ticked articles to be italic and high-scored
3221 articles to be bold, you could set this variable to something like
3222 @lisp
3223 (((eq mark gnus-ticked-mark) . italic)
3224  ((> score default) . bold))
3225 @end lisp
3226 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3227 @var{FACE} will be applied to the line.
3228 @end table
3229
3230
3231 @node Summary Maneuvering
3232 @section Summary Maneuvering
3233 @cindex summary movement
3234
3235 All the straight movement commands understand the numeric prefix and
3236 behave pretty much as you'd expect. 
3237
3238 None of these commands select articles.
3239
3240 @table @kbd
3241 @item G M-n
3242 @itemx M-n
3243 @kindex M-n (Summary)
3244 @kindex G M-n (Summary)
3245 @findex gnus-summary-next-unread-subject
3246 Go to the next summary line of an unread article
3247 (@code{gnus-summary-next-unread-subject}). 
3248
3249 @item G M-p
3250 @itemx M-p
3251 @kindex M-p (Summary)
3252 @kindex G M-p (Summary)
3253 @findex gnus-summary-prev-unread-subject
3254 Go to the previous summary line of an unread article
3255 (@code{gnus-summary-prev-unread-subject}). 
3256
3257 @item G j
3258 @itemx j
3259 @kindex j (Summary)
3260 @kindex G j (Summary)
3261 @findex gnus-summary-goto-article
3262 Ask for an article number and then go to that article
3263 (@code{gnus-summary-goto-article}). 
3264
3265 @item G g
3266 @kindex G g (Summary)
3267 @findex gnus-summary-goto-subject
3268 Ask for an article number and then go the summary line of that article
3269 without displaying the article (@code{gnus-summary-goto-subject}).
3270 @end table
3271
3272 If Gnus asks you to press a key to confirm going to the next group, you
3273 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3274 buffer, searching for the next group to read without actually returning
3275 to the group buffer.
3276
3277 Variables related to summary movement:
3278
3279 @table @code
3280
3281 @vindex gnus-auto-select-next
3282 @item gnus-auto-select-next
3283 If you issue one of the movement commands (like @kbd{n}) and there are
3284 no more unread articles after the current one, Gnus will offer to go to
3285 the next group.  If this variable is @code{t} and the next group is
3286 empty, Gnus will exit summary mode and return to the group buffer.  If
3287 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3288 next group, no matter whether it has any unread articles or not.  As a
3289 special case, if this variable is @code{quietly}, Gnus will select the
3290 next group without asking for confirmation.  If this variable is
3291 @code{almost-quietly}, the same will happen only if you are located on
3292 the last article in the group.  Finally, if this variable is
3293 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3294 without confirmation.  Also @pxref{Group Levels}.
3295
3296 @item gnus-auto-select-same
3297 @vindex gnus-auto-select-same
3298 If non-@code{nil}, all the movement commands will try to go to the next
3299 article with the same subject as the current.  (@dfn{Same} here might
3300 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3301 for details (@pxref{Customizing Threading}).)  This variable is not
3302 particularly useful if you use a threaded display.
3303
3304 @item gnus-summary-check-current
3305 @vindex gnus-summary-check-current
3306 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3307 to the next (or previous) article if the current article is unread.
3308 Instead, they will choose the current article.
3309
3310 @item gnus-auto-center-summary
3311 @vindex gnus-auto-center-summary
3312 If non-@code{nil}, Gnus will keep the point in the summary buffer
3313 centered at all times.  This makes things quite tidy, but if you have a
3314 slow network connection, or simply do not like this un-Emacsism, you can
3315 set this variable to @code{nil} to get the normal Emacs scrolling
3316 action.  This will also inhibit horizontal re-centering of the summary
3317 buffer, which might make it more inconvenient to read extremely long
3318 threads.
3319
3320 @end table
3321
3322
3323 @node Choosing Articles
3324 @section Choosing Articles
3325 @cindex selecting articles
3326
3327 @menu
3328 * Choosing Commands::        Commands for choosing articles.
3329 * Choosing Variables::       Variables that influence these commands.
3330 @end menu
3331
3332
3333 @node Choosing Commands
3334 @subsection Choosing Commands
3335
3336 None of the following movement commands understand the numeric prefix,
3337 and they all select and display an article.
3338
3339 @table @kbd
3340 @item SPACE
3341 @kindex SPACE (Summary)
3342 @findex gnus-summary-next-page
3343 Select the current article, or, if that one's read already, the next
3344 unread article (@code{gnus-summary-next-page}).
3345
3346 @item G n
3347 @itemx n
3348 @kindex n (Summary)
3349 @kindex G n (Summary)
3350 @findex gnus-summary-next-unread-article
3351 Go to next unread article (@code{gnus-summary-next-unread-article}).
3352
3353 @item G p
3354 @itemx p
3355 @kindex p (Summary)
3356 @findex gnus-summary-prev-unread-article
3357 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3358
3359 @item G N
3360 @itemx N
3361 @kindex N (Summary)
3362 @kindex G N (Summary)
3363 @findex gnus-summary-next-article
3364 Go to the next article (@code{gnus-summary-next-article}).
3365
3366 @item G P
3367 @itemx P
3368 @kindex P (Summary)
3369 @kindex G P (Summary)
3370 @findex gnus-summary-prev-article
3371 Go to the previous article (@code{gnus-summary-prev-article}).
3372
3373 @item G C-n
3374 @kindex G C-n (Summary)
3375 @findex gnus-summary-next-same-subject
3376 Go to the next article with the same subject
3377 (@code{gnus-summary-next-same-subject}). 
3378
3379 @item G C-p
3380 @kindex G C-p (Summary)
3381 @findex gnus-summary-prev-same-subject
3382 Go to the previous article with the same subject
3383 (@code{gnus-summary-prev-same-subject}). 
3384
3385 @item G f
3386 @itemx .
3387 @kindex G f  (Summary)
3388 @kindex .  (Summary)
3389 @findex gnus-summary-first-unread-article
3390 Go to the first unread article
3391 (@code{gnus-summary-first-unread-article}).
3392
3393 @item G b
3394 @itemx ,
3395 @kindex G b (Summary)
3396 @kindex , (Summary)
3397 @findex gnus-summary-best-unread-article
3398 Go to the article with the highest score
3399 (@code{gnus-summary-best-unread-article}). 
3400
3401 @item G l
3402 @itemx l
3403 @kindex l (Summary)
3404 @kindex G l (Summary)
3405 @findex gnus-summary-goto-last-article
3406 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3407
3408 @item G p
3409 @kindex G p (Summary)
3410 @findex gnus-summary-pop-article
3411 Pop an article off the summary history and go to this article
3412 (@code{gnus-summary-pop-article}).  This command differs from the
3413 command above in that you can pop as many previous articles off the
3414 history as you like.
3415 @end table
3416
3417
3418 @node Choosing Variables
3419 @subsection Choosing Variables
3420
3421 Some variables that are relevant for moving and selecting articles:
3422
3423 @table @code
3424 @item gnus-auto-extend-newsgroup
3425 @vindex gnus-auto-extend-newsgroup
3426 All the movement commands will try to go to the previous (or next)
3427 article, even if that article isn't displayed in the Summary buffer if
3428 this variable is non-@code{nil}.  Gnus will then fetch the article from
3429 the server and display it in the article buffer.
3430
3431 @item gnus-select-article-hook
3432 @vindex gnus-select-article-hook
3433 This hook is called whenever an article is selected.  By default it
3434 exposes any threads hidden under the selected article.
3435
3436 @item gnus-mark-article-hook
3437 @vindex gnus-mark-article-hook
3438 @findex gnus-summary-mark-unread-as-read
3439 @findex gnus-summary-mark-read-and-unread-as-read
3440 @findex gnus-unread-mark
3441 This hook is called whenever an article is selected.  It is intended to
3442 be used for marking articles as read.  The default value is
3443 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3444 mark of almost any article you read to @code{gnus-unread-mark}.  The
3445 only articles not affected by this function are ticked, dormant, and
3446 expirable articles.  If you'd instead like to just have unread articles
3447 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3448 instead.  It will leave marks like @code{gnus-low-score-mark},
3449 @code{gnus-del-mark} (and so on) alone.
3450
3451 @end table
3452
3453
3454 @node Paging the Article
3455 @section Scrolling the Article
3456 @cindex article scrolling
3457
3458 @table @kbd
3459
3460 @item SPACE
3461 @kindex SPACE (Summary)
3462 @findex gnus-summary-next-page
3463 Pressing @kbd{SPACE} will scroll the current article forward one page,
3464 or, if you have come to the end of the current article, will choose the
3465 next article (@code{gnus-summary-next-page}).
3466
3467 @item DEL
3468 @kindex DEL (Summary)
3469 @findex gnus-summary-prev-page
3470 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3471
3472 @item RET
3473 @kindex RET (Summary)
3474 @findex gnus-summary-scroll-up
3475 Scroll the current article one line forward
3476 (@code{gnus-summary-scroll-up}).
3477
3478 @item A g
3479 @itemx g
3480 @kindex A g (Summary)
3481 @kindex g (Summary)
3482 @findex gnus-summary-show-article
3483 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3484 given a prefix, fetch the current article, but don't run any of the
3485 article treatment functions.  This will give you a ``raw'' article, just
3486 the way it came from the server.
3487
3488 @item A <
3489 @itemx <
3490 @kindex < (Summary)
3491 @kindex A < (Summary)
3492 @findex gnus-summary-beginning-of-article
3493 Scroll to the beginning of the article
3494 (@code{gnus-summary-beginning-of-article}).
3495
3496 @item A >
3497 @itemx >
3498 @kindex > (Summary)
3499 @kindex A > (Summary)
3500 @findex gnus-summary-end-of-article
3501 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3502
3503 @item A s 
3504 @itemx s
3505 @kindex A s (Summary)
3506 @kindex s (Summary)
3507 @findex gnus-summary-isearch-article
3508 Perform an isearch in the article buffer
3509 (@code{gnus-summary-isearch-article}). 
3510
3511 @end table
3512
3513
3514 @node Reply Followup and Post
3515 @section Reply, Followup and Post
3516
3517 @menu
3518 * Summary Mail Commands::            Sending mail.
3519 * Summary Post Commands::            Sending news.
3520 @end menu
3521
3522
3523 @node Summary Mail Commands
3524 @subsection Summary Mail Commands
3525 @cindex mail
3526 @cindex composing mail
3527
3528 Commands for composing a mail message:
3529
3530 @table @kbd
3531
3532 @item S r
3533 @itemx r
3534 @kindex S r (Summary)
3535 @kindex r (Summary)
3536 @findex gnus-summary-reply
3537 Mail a reply to the author of the current article
3538 (@code{gnus-summary-reply}). 
3539
3540 @item S R
3541 @itemx R
3542 @kindex R (Summary)
3543 @kindex S R (Summary)
3544 @findex gnus-summary-reply-with-original
3545 Mail a reply to the author of the current article and include the
3546 original message (@code{gnus-summary-reply-with-original}).  This
3547 command uses the process/prefix convention.
3548
3549 @item S o m
3550 @kindex S o m (Summary)
3551 @findex gnus-summary-mail-forward
3552 Forward the current article to some other person
3553 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3554 headers of the forwarded article.
3555
3556 @item S m
3557 @itemx m
3558 @kindex m (Summary)
3559 @kindex S m (Summary)
3560 @findex gnus-summary-mail-other-window
3561 Send a mail to some other person
3562 (@code{gnus-summary-mail-other-window}).
3563
3564 @item S D b
3565 @kindex S D b (Summary)
3566 @findex gnus-summary-resend-bounced-mail
3567 @cindex bouncing mail
3568 If you have sent a mail, but the mail was bounced back to you for some
3569 reason (wrong address, transient failure), you can use this command to
3570 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3571 will be popped into a mail buffer where you can edit the headers before
3572 sending the mail off again.  If you give a prefix to this command, and
3573 the bounced mail is a reply to some other mail, Gnus will try to fetch
3574 that mail and display it for easy perusal of its headers.  This might
3575 very well fail, though.
3576
3577 @item S D r
3578 @kindex S D r (Summary)
3579 @findex gnus-summary-resend-message
3580 Not to be confused with the previous command,
3581 @code{gnus-summary-resend-message} will prompt you for an address to
3582 send the current message off to, and then send it to that place.  The
3583 headers of the message won't be altered---but lots of headers that say
3584 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3585 means that you actually send a mail to someone that has a @code{To}
3586 header that (probably) points to yourself.  This will confuse people.
3587 So, natcherly you'll only do that if you're really eVIl.  
3588
3589 This command is mainly used if you have several accounts and want to
3590 ship a mail to a different account of yours.  (If you're both
3591 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3592 to the @code{root} account, you may want to resend it to
3593 @code{postmaster}.  Ordnung muß sein!
3594
3595 @item S O m
3596 @kindex S O m (Summary)
3597 @findex gnus-uu-digest-mail-forward
3598 Digest the current series and forward the result using mail
3599 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3600 process/prefix convention (@pxref{Process/Prefix}). 
3601
3602 @item S M-c
3603 @kindex S M-c (Summary)
3604 @findex gnus-summary-mail-crosspost-complaint
3605 @cindex crossposting
3606 @cindex excessive crossposting
3607 Send a complaint about excessive crossposting to the author of the
3608 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3609
3610 @findex gnus-crosspost-complaint
3611 This command is provided as a way to fight back agains the current
3612 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3613 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3614 command understands the process/prefix convention
3615 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3616
3617 @end table
3618
3619
3620 @node Summary Post Commands
3621 @subsection Summary Post Commands
3622 @cindex post
3623 @cindex composing news
3624
3625 Commands for posting a news article:
3626
3627 @table @kbd
3628 @item S p
3629 @itemx a
3630 @kindex a (Summary)
3631 @kindex S p (Summary)
3632 @findex gnus-summary-post-news
3633 Post an article to the current group
3634 (@code{gnus-summary-post-news}).
3635
3636 @item S f
3637 @itemx f
3638 @kindex f (Summary)
3639 @kindex S f (Summary)
3640 @findex gnus-summary-followup
3641 Post a followup to the current article (@code{gnus-summary-followup}).
3642
3643 @item S F
3644 @itemx F
3645 @kindex S F (Summary)
3646 @kindex F (Summary)
3647 @findex gnus-summary-followup-with-original
3648 Post a followup to the current article and include the original message
3649 (@code{gnus-summary-followup-with-original}).   This command uses the
3650 process/prefix convention.
3651
3652 @item S n
3653 @kindex S n (Summary)
3654 @findex gnus-summary-followup-to-mail
3655 Post a followup to the current article via news, even if you got the
3656 message through mail (@code{gnus-summary-followup-to-mail}).
3657
3658 @item S n
3659 @kindex S n (Summary)
3660 @findex gnus-summary-followup-to-mail
3661 Post a followup to the current article via news, even if you got the
3662 message through mail and include the original message
3663 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3664 the process/prefix convention.
3665
3666 @item S o p
3667 @kindex S o p (Summary)
3668 @findex gnus-summary-post-forward
3669 Forward the current article to a newsgroup
3670 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3671 headers of the forwarded article.
3672
3673 @item S O p
3674 @kindex S O p (Summary)
3675 @findex gnus-uu-digest-post-forward
3676 Digest the current series and forward the result to a newsgroup
3677 (@code{gnus-uu-digest-mail-forward}).  
3678
3679 @item S u
3680 @kindex S u (Summary)
3681 @findex gnus-uu-post-news
3682 Uuencode a file, split it into parts, and post it as a series
3683 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3684 @end table
3685
3686
3687 @node Canceling and Superseding
3688 @section Canceling Articles
3689 @cindex canceling articles
3690 @cindex superseding articles
3691
3692 Have you ever written something, and then decided that you really,
3693 really, really wish you hadn't posted that?
3694
3695 Well, you can't cancel mail, but you can cancel posts.
3696
3697 @findex gnus-summary-cancel-article
3698 @kindex C (Summary)
3699 Find the article you wish to cancel (you can only cancel your own
3700 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3701 c} (@code{gnus-summary-cancel-article}).  Your article will be
3702 canceled---machines all over the world will be deleting your article. 
3703
3704 Be aware, however, that not all sites honor cancels, so your article may
3705 live on here and there, while most sites will delete the article in
3706 question.
3707
3708 If you discover that you have made some mistakes and want to do some
3709 corrections, you can post a @dfn{superseding} article that will replace
3710 your original article.
3711
3712 @findex gnus-summary-supersede-article
3713 @kindex S (Summary)
3714 Go to the original article and press @kbd{S s}
3715 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3716 where you can edit the article all you want before sending it off the
3717 usual way.
3718
3719 The same goes for superseding as for canceling, only more so: Some
3720 sites do not honor superseding.  On those sites, it will appear that you
3721 have posted almost the same article twice.
3722
3723 If you have just posted the article, and change your mind right away,
3724 there is a trick you can use to cancel/supersede the article without
3725 waiting for the article to appear on your site first.  You simply return
3726 to the post buffer (which is called @code{*sent ...*}).  There you will
3727 find the article you just posted, with all the headers intact.  Change
3728 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3729 header by substituting one of those words for the word
3730 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3731 you would do normally.  The previous article will be
3732 canceled/superseded.
3733
3734 Just remember, kids: There is no 'c' in 'supersede'.
3735
3736
3737 @node Marking Articles
3738 @section Marking Articles
3739 @cindex article marking
3740 @cindex article ticking
3741 @cindex marks
3742
3743 There are several marks you can set on an article. 
3744
3745 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3746 neologism ohoy!) of the article.  Alphabetic marks generally mean
3747 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3748
3749 In addition, you also have marks that do not affect readedness.
3750
3751 @menu
3752 * Unread Articles::      Marks for unread articles.
3753 * Read Articles::        Marks for read articles.
3754 * Other Marks::          Marks that do not affect readedness.
3755 @end menu
3756
3757 @ifinfo
3758 There's a plethora of commands for manipulating these marks:
3759 @end ifinfo
3760
3761 @menu
3762 * Setting Marks::           How to set and remove marks.
3763 * Setting Process Marks::   How to mark articles for later processing.
3764 @end menu
3765
3766
3767 @node Unread Articles
3768 @subsection Unread Articles
3769
3770 The following marks mark articles as (kinda) unread, in one form or
3771 other.
3772
3773 @table @samp
3774 @item !
3775 @vindex gnus-ticked-mark
3776 Marked as ticked (@code{gnus-ticked-mark}).
3777
3778 @dfn{Ticked articles} are articles that will remain visible always.  If
3779 you see an article that you find interesting, or you want to put off
3780 reading it, or replying to it, until sometime later, you'd typically
3781 tick it.  However, articles can be expired, so if you want to keep an
3782 article forever, you'll have to make it persistent (@pxref{Persistent
3783 Articles}).  
3784
3785 @item ?
3786 @vindex gnus-dormant-mark
3787 Marked as dormant (@code{gnus-dormant-mark}).  
3788
3789 @dfn{Dormant articles} will only appear in the summary buffer if there
3790 are followups to it.
3791
3792 @item SPACE
3793 @vindex gnus-unread-mark
3794 Markes as unread (@code{gnus-unread-mark}).
3795
3796 @dfn{Unread articles} are articles that haven't been read at all yet.
3797 @end table
3798
3799
3800 @node Read Articles
3801 @subsection Read Articles
3802 @cindex expirable mark
3803
3804 All the following marks mark articles as read.
3805
3806 @table @samp
3807
3808 @item r
3809 @vindex gnus-del-mark
3810 These are articles that the user has marked as read with the @kbd{d}
3811 command manually, more or less (@code{gnus-del-mark}).
3812
3813 @item R
3814 @vindex gnus-read-mark
3815 Articles that have actually been read (@code{gnus-read-mark}).
3816
3817 @item O
3818 @vindex gnus-ancient-mark
3819 Articles that were marked as read in previous sessions and are now
3820 @dfn{old} (@code{gnus-ancient-mark}).
3821
3822 @item K
3823 @vindex gnus-killed-mark
3824 Marked as killed (@code{gnus-killed-mark}).
3825
3826 @item X
3827 @vindex gnus-kill-file-mark
3828 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3829
3830 @item Y
3831 @vindex gnus-low-score-mark
3832 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3833
3834 @item C
3835 @vindex gnus-catchup-mark
3836 Marked as read by a catchup (@code{gnus-catchup-mark}).
3837
3838 @item G
3839 @vindex gnus-canceled-mark
3840 Canceled article (@code{gnus-canceled-mark})
3841
3842 @item F
3843 @vindex gnus-souped-mark
3844 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
3845
3846 @item Q
3847 @vindex gnus-sparse-mark
3848 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
3849 Threading}.
3850
3851 @item M
3852 @vindex gnus-duplicate-mark
3853 Article marked as read by duplicate suppression
3854 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
3855
3856 @end table
3857
3858 All these marks just mean that the article is marked as read, really.
3859 They are interpreted differently when doing adaptive scoring, though.
3860
3861 One more special mark, though:
3862
3863 @table @samp
3864 @item E
3865 @vindex gnus-expirable-mark
3866 Marked as expirable (@code{gnus-expirable-mark}).
3867
3868 Marking articles as @dfn{expirable} (or have them marked as such
3869 automatically) doesn't make much sense in normal groups---a user doesn't
3870 control the expiring of news articles, but in mail groups, for instance,
3871 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3872 any time.
3873 @end table
3874
3875
3876 @node Other Marks
3877 @subsection Other Marks
3878 @cindex process mark
3879 @cindex bookmarks
3880
3881 There are some marks that have nothing to do with whether the article is
3882 read or not.
3883
3884 @itemize @bullet
3885
3886 @item 
3887 You can set a bookmark in the current article.  Say you are reading a
3888 long thesis on cats' urinary tracts, and have to go home for dinner
3889 before you've finished reading the thesis.  You can then set a bookmark
3890 in the article, and Gnus will jump to this bookmark the next time it
3891 encounters the article.  @xref{Setting Marks}
3892
3893 @item
3894 @vindex gnus-replied-mark
3895 All articles that you have replied to or made a followup to (i.e., have
3896 answered) will be marked with an @samp{A} in the second column
3897 (@code{gnus-replied-mark}).
3898
3899 @item 
3900 @vindex gnus-cached-mark
3901 Articles that are stored in the article cache will be marked with an
3902 @samp{*} in the second column (@code{gnus-cached-mark}).
3903
3904 @item 
3905 @vindex gnus-saved-mark
3906 Articles that are ``saved'' (in some manner or other; not necessarily
3907 religiously) are marked with an @samp{S} in the second column
3908 (@code{gnus-saved-mark}.
3909
3910 @item 
3911 @vindex gnus-not-empty-thread-mark
3912 @vindex gnus-empty-thread-mark
3913 It the @samp{%e} spec is used, the presence of threads or not will be
3914 marked with @code{gnus-not-empty-thread-mark} and
3915 @code{gnus-empty-thread-mark} in the third column, respectively.
3916
3917 @item 
3918 @vindex gnus-process-mark
3919 Finally we have the @dfn{process mark} (@code{gnus-process-mark}.  A
3920 variety of commands react to the presence of the process mark.  For
3921 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3922 all articles that have been marked with the process mark.  Articles
3923 marked with the process mark have a @samp{#} in the second column.
3924
3925 @end itemize
3926
3927 You might have noticed that most of these ``non-readedness'' marks
3928 appear in the second column by default.  So if you have a cached, saved,
3929 replied article that you have process-marked, what will that look like?
3930
3931 Nothing much.  The precedence rules go as follows: process -> cache ->
3932 replied -> saved.  So if the article is in the cache and is replied,
3933 you'll only see the cache mark and not the replied mark.
3934
3935
3936 @node Setting Marks
3937 @subsection Setting Marks
3938 @cindex setting marks
3939
3940 All the marking commands understand the numeric prefix.
3941
3942 @table @kbd
3943 @item M t
3944 @itemx !
3945 @kindex ! (Summary)
3946 @kindex M t (Summary)
3947 @findex gnus-summary-tick-article-forward
3948 Tick the current article (@code{gnus-summary-tick-article-forward}).
3949
3950 @item M ?
3951 @itemx ?
3952 @kindex ? (Summary)
3953 @kindex M ? (Summary)
3954 @findex gnus-summary-mark-as-dormant
3955 Mark the current article as dormant
3956 (@code{gnus-summary-mark-as-dormant}).
3957
3958 @item M d
3959 @itemx d
3960 @kindex M d (Summary)
3961 @kindex d (Summary)
3962 @findex gnus-summary-mark-as-read-forward
3963 Mark the current article as read
3964 (@code{gnus-summary-mark-as-read-forward}).
3965
3966 @item D
3967 @kindex D (Summary)
3968 @findex gnus-summary-mark-as-read-backward
3969 Mark the current article as read and move point to the previous line
3970 (@code{gnus-summary-mark-as-read-backward}).
3971
3972 @item M k
3973 @itemx k
3974 @kindex k (Summary)
3975 @kindex M k (Summary)
3976 @findex gnus-summary-kill-same-subject-and-select
3977 Mark all articles that have the same subject as the current one as read,
3978 and then select the next unread article
3979 (@code{gnus-summary-kill-same-subject-and-select}).
3980
3981 @item M K
3982 @itemx C-k
3983 @kindex M K (Summary)
3984 @kindex C-k (Summary)
3985 @findex gnus-summary-kill-same-subject
3986 Mark all articles that have the same subject as the current one as read
3987 (@code{gnus-summary-kill-same-subject}).  
3988
3989 @item M C
3990 @kindex M C (Summary)
3991 @findex gnus-summary-catchup
3992 Mark all unread articles as read (@code{gnus-summary-catchup}).
3993
3994 @item M C-c
3995 @kindex M C-c (Summary)
3996 @findex gnus-summary-catchup-all
3997 Mark all articles in the group as read---even the ticked and dormant
3998 articles (@code{gnus-summary-catchup-all}).
3999
4000 @item M H
4001 @kindex M H (Summary)
4002 @findex gnus-summary-catchup-to-here
4003 Catchup the current group to point
4004 (@code{gnus-summary-catchup-to-here}). 
4005
4006 @item C-w
4007 @kindex C-w (Summary)
4008 @findex gnus-summary-mark-region-as-read
4009 Mark all articles between point and mark as read
4010 (@code{gnus-summary-mark-region-as-read}). 
4011
4012 @item M V k
4013 @kindex M V k (Summary)
4014 @findex gnus-summary-kill-below
4015 Kill all articles with scores below the default score (or below the
4016 numeric prefix) (@code{gnus-summary-kill-below}).
4017
4018 @item M c
4019 @itemx M-u
4020 @kindex M c (Summary)
4021 @kindex M-u (Summary)
4022 @findex gnus-summary-clear-mark-forward
4023 Clear all readedness-marks from the current article
4024 (@code{gnus-summary-clear-mark-forward}).
4025
4026 @item M e
4027 @itemx E
4028 @kindex M e (Summary)
4029 @kindex E (Summary)
4030 @findex gnus-summary-mark-as-expirable
4031 Mark the current article as expirable
4032 (@code{gnus-summary-mark-as-expirable}).
4033
4034 @item M b
4035 @kindex M b (Summary)
4036 @findex gnus-summary-set-bookmark
4037 Set a bookmark in the current article
4038 (@code{gnus-summary-set-bookmark}).
4039
4040 @item M B
4041 @kindex M B (Summary)
4042 @findex gnus-summary-remove-bookmark
4043 Remove the bookmark from the current article
4044 (@code{gnus-summary-remove-bookmark}).
4045
4046 @item M V c
4047 @kindex M V c (Summary)
4048 @findex gnus-summary-clear-above
4049 Clear all marks from articles with scores over the default score (or
4050 over the numeric prefix) (@code{gnus-summary-clear-above}).
4051
4052 @item M V u
4053 @kindex M V u (Summary)
4054 @findex gnus-summary-tick-above
4055 Tick all articles with scores over the default score (or over the
4056 numeric prefix) (@code{gnus-summary-tick-above}).
4057
4058 @item M V m
4059 @kindex M V m (Summary)
4060 @findex gnus-summary-mark-above
4061 Prompt for a mark, and mark all articles with scores over the default
4062 score (or over the numeric prefix) with this mark
4063 (@code{gnus-summary-clear-above}).
4064 @end table
4065
4066 @vindex gnus-summary-goto-unread
4067 The @code{gnus-summary-goto-unread} variable controls what action should
4068 be taken after setting a mark.  If non-@code{nil}, point will move to
4069 the next/previous unread article.  If @code{nil}, point will just move
4070 one line up or down.  As a special case, if this variable is
4071 @code{never}, all the marking commands as well as other commands (like
4072 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4073 The default is @code{t}.
4074
4075
4076 @node Setting Process Marks
4077 @subsection Setting Process Marks
4078 @cindex setting process marks
4079
4080 @table @kbd
4081
4082 @item M P p
4083 @itemx #
4084 @kindex # (Summary)
4085 @kindex M P p (Summary)
4086 @findex gnus-summary-mark-as-processable
4087 Mark the current article with the process mark
4088 (@code{gnus-summary-mark-as-processable}). 
4089 @findex gnus-summary-unmark-as-processable
4090
4091 @item M P u 
4092 @itemx M-#
4093 @kindex M P u (Summary)
4094 @kindex M-# (Summary)
4095 Remove the process mark, if any, from the current article
4096 (@code{gnus-summary-unmark-as-processable}).
4097
4098 @item M P U
4099 @kindex M P U (Summary)
4100 @findex gnus-summary-unmark-all-processable
4101 Remove the process mark from all articles
4102 (@code{gnus-summary-unmark-all-processable}). 
4103
4104 @item M P i
4105 @kindex M P i (Summary)
4106 @findex gnus-uu-invert-processable
4107 Invert the list of process marked articles
4108 (@code{gnus-uu-invert-processable}). 
4109
4110 @item M P R
4111 @kindex M P R (Summary)
4112 @findex gnus-uu-mark-by-regexp
4113 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4114
4115 @item M P r
4116 @kindex M P r (Summary)
4117 @findex gnus-uu-mark-region
4118 Mark articles in region (@code{gnus-uu-mark-region}).
4119
4120 @item M P t
4121 @kindex M P t (Summary)
4122 @findex gnus-uu-mark-thread
4123 Mark all articles in the current (sub)thread
4124 (@code{gnus-uu-mark-thread}).
4125
4126 @item M P T
4127 @kindex M P T (Summary)
4128 @findex gnus-uu-unmark-thread
4129 Unmark all articles in the current (sub)thread
4130 (@code{gnus-uu-unmark-thread}).
4131
4132 @item M P v
4133 @kindex M P v (Summary)
4134 @findex gnus-uu-mark-over
4135 Mark all articles that have a score above the prefix argument
4136 (@code{gnus-uu-mark-over}).
4137
4138 @item M P s
4139 @kindex M P s (Summary)
4140 @findex gnus-uu-mark-series
4141 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4142
4143 @item M P S
4144 @kindex M P S (Summary)
4145 @findex gnus-uu-mark-sparse
4146 Mark all series that have already had some articles marked
4147 (@code{gnus-uu-mark-sparse}).
4148
4149 @item M P a
4150 @kindex M P a (Summary)
4151 @findex gnus-uu-mark-all
4152 Mark all articles in series order (@code{gnus-uu-mark-series}).
4153
4154 @item M P b
4155 @kindex M P b (Summary)
4156 @findex gnus-uu-mark-buffer
4157 Mark all articles in the buffer in the order they appear
4158 (@code{gnus-uu-mark-buffer}). 
4159
4160 @item M P k
4161 @kindex M P k (Summary)
4162 @findex gnus-summary-kill-process-mark
4163 Push the current process mark set onto the stack and unmark all articles
4164 (@code{gnus-summary-kill-process-mark}).
4165
4166 @item M P y
4167 @kindex M P y (Summary)
4168 @findex gnus-summary-yank-process-mark
4169 Pop the previous process mark set from the stack and restore it
4170 (@code{gnus-summary-yank-process-mark}).
4171
4172 @item M P w
4173 @kindex M P w (Summary)
4174 @findex gnus-summary-save-process-mark
4175 Push the current process mark set onto the stack
4176 (@code{gnus-summary-save-process-mark}).
4177
4178 @end table
4179
4180
4181 @node Limiting
4182 @section Limiting
4183 @cindex limiting
4184
4185 It can be convenient to limit the summary buffer to just show some
4186 subset of the articles currently in the group.  The effect most limit
4187 commands have is to remove a few (or many) articles from the summary
4188 buffer. 
4189
4190 @table @kbd
4191
4192 @item / /
4193 @itemx / s
4194 @kindex / / (Summary)
4195 @findex gnus-summary-limit-to-subject
4196 Limit the summary buffer to articles that match some subject
4197 (@code{gnus-summary-limit-to-subject}). 
4198
4199 @item / a
4200 @kindex / a (Summary)
4201 @findex gnus-summary-limit-to-author
4202 Limit the summary buffer to articles that match some author
4203 (@code{gnus-summary-limit-to-author}).
4204
4205 @item / u
4206 @itemx x
4207 @kindex / u (Summary)
4208 @kindex x (Summary)
4209 @findex gnus-summary-limit-to-unread
4210 Limit the summary buffer to articles that are not marked as read
4211 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4212 buffer to articles that are strictly unread.  This means that ticked and
4213 dormant articles will also be excluded.
4214
4215 @item / m
4216 @kindex / m (Summary)
4217 @findex gnus-summary-limit-to-marks
4218 Ask for a mark and then limit to all articles that have not been marked
4219 with that mark (@code{gnus-summary-limit-to-marks}).
4220
4221 @item / n
4222 @kindex / n (Summary)
4223 @findex gnus-summary-limit-to-articles
4224 Limit the summary buffer to the current article
4225 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4226 convention (@pxref{Process/Prefix}).
4227
4228 @item / w
4229 @kindex / w (Summary)
4230 @findex gnus-summary-pop-limit
4231 Pop the previous limit off the stack and restore it
4232 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4233 the stack.
4234
4235 @item / v
4236 @kindex / v (Summary)
4237 @findex gnus-summary-limit-to-score
4238 Limit the summary buffer to articles that have a score at or above some
4239 score (@code{gnus-summary-limit-to-score}).
4240
4241 @item / E
4242 @itemx M S
4243 @kindex M S (Summary)
4244 @kindex / E (Summary)
4245 @findex gnus-summary-limit-include-expunged
4246 Display all expunged articles
4247 (@code{gnus-summary-limit-include-expunged}). 
4248
4249 @item / D
4250 @kindex / D (Summary)
4251 @findex gnus-summary-limit-include-dormant
4252 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4253
4254 @item / d
4255 @kindex / d (Summary)
4256 @findex gnus-summary-limit-exclude-dormant
4257 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4258
4259 @item / c
4260 @kindex / c (Summary)
4261 @findex gnus-summary-limit-exclude-childless-dormant
4262 Hide all dormant articles that have no children
4263 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4264
4265 @item / C
4266 @kindex / C (Summary)
4267 @findex gnus-summary-limit-mark-excluded-as-read
4268 Mark all excluded unread articles as read
4269 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4270 also mark excluded ticked and dormant articles as read.
4271
4272 @end table
4273
4274
4275 @node Threading
4276 @section Threading
4277 @cindex threading
4278 @cindex article threading
4279
4280 Gnus threads articles by default.  @dfn{To thread} is to put replies to
4281 articles directly after the articles they reply to---in a hierarchical
4282 fashion.
4283
4284 @menu
4285 * Customizing Threading::     Variables you can change to affect the threading.
4286 * Thread Commands::           Thread based commands in the summary buffer.
4287 @end menu
4288
4289
4290 @node Customizing Threading
4291 @subsection Customizing Threading
4292 @cindex customizing threading
4293 @cindex <
4294 @cindex >
4295
4296 @table @code
4297
4298 @item gnus-show-threads
4299 @vindex gnus-show-threads
4300 If this variable is @code{nil}, no threading will be done, and all of
4301 the rest of the variables here will have no effect.  Turning threading
4302 off will speed group selection up a bit, but it is sure to make reading
4303 slower and more awkward.
4304
4305 @item gnus-fetch-old-headers
4306 @vindex gnus-fetch-old-headers
4307 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4308 more old headers---headers to articles that are marked as read.  If you
4309 would like to display as few summary lines as possible, but still
4310 connect as many loose threads as possible, you should set this variable
4311 to @code{some} or a number.  If you set it to a number, no more than
4312 that number of extra old headers will be fetched.  In either case,
4313 fetching old headers only works if the backend you are using carries
4314 overview files---this would normally be @code{nntp}, @code{nnspool} and
4315 @code{nnml}.  Also remember that if the root of the thread has been
4316 expired by the server, there's not much Gnus can do about that.
4317
4318 @item gnus-build-sparse-threads
4319 @vindex gnus-build-sparse-threads
4320 Fetching old headers can be slow.  A low-rent similar effect can be
4321 gotten by setting this variable to @code{some}.  Gnus will then look at
4322 the complete @code{References} headers of all articles and try to string
4323 articles that belong in the same thread together.  This will leave
4324 @dfn{gaps} in the threading display where Gnus guesses that an article
4325 is missing from the thread.  (These gaps appear like normal summary
4326 lines.  If you select a gap, Gnus will try to fetch the article in
4327 question.)  If this variable is @code{t}, Gnus will display all these
4328 ``gaps'' without regard for whether they are useful for completing the
4329 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4330 off sparse leaf nodes that don't lead anywhere.  This variable is
4331 @code{nil} by default.
4332
4333 @item gnus-summary-gather-subject-limit
4334 @vindex gnus-summary-gather-subject-limit
4335 Loose threads are gathered by comparing subjects of articles.  If this
4336 variable is @code{nil}, Gnus requires an exact match between the
4337 subjects of the loose threads before gathering them into one big
4338 super-thread.  This might be too strict a requirement, what with the
4339 presence of stupid newsreaders that chop off long subjects lines.  If
4340 you think so, set this variable to, say, 20 to require that only the
4341 first 20 characters of the subjects have to match.  If you set this
4342 variable to a really low number, you'll find that Gnus will gather
4343 everything in sight into one thread, which isn't very helpful.
4344
4345 @cindex fuzzy article gathering
4346 If you set this variable to the special value @code{fuzzy}, Gnus will
4347 use a fuzzy string comparison algorithm on the subjects.
4348
4349 @item gnus-simplify-subject-fuzzy-regexp
4350 @vindex gnus-simplify-subject-fuzzy-regexp
4351 This can either be a regular expression or list of regular expressions
4352 that match strings that will be removed from subjects if fuzzy subject
4353 simplification is used.
4354
4355 @item gnus-simplify-ignored-prefixes
4356 @vindex gnus-simplify-ignored-prefixes
4357 If you set @code{gnus-summary-gather-subject-limit} to something as low
4358 as 10, you might consider setting this variable to something sensible:
4359
4360 @c Written by Michael Ernst <mernst@cs.rice.edu>
4361 @lisp
4362 (setq gnus-simplify-ignored-prefixes
4363       (concat 
4364        "\\`\\[?\\("
4365        (mapconcat 
4366         'identity
4367         '("looking"
4368           "wanted" "followup" "summary\\( of\\)?"
4369           "help" "query" "problem" "question" 
4370           "answer" "reference" "announce"
4371           "How can I" "How to" "Comparison of"
4372           ;; ...
4373           )
4374         "\\|")
4375        "\\)\\s *\\("
4376        (mapconcat 'identity
4377                   '("for" "for reference" "with" "about")
4378                   "\\|")
4379        "\\)?\\]?:?[ \t]*"))
4380 @end lisp
4381
4382 All words that match this regexp will be removed before comparing two
4383 subjects. 
4384
4385 @item gnus-summary-gather-exclude-subject
4386 @vindex gnus-summary-gather-exclude-subject
4387 Since loose thread gathering is done on subjects only, that might lead
4388 to many false hits, especially with certain common subjects like
4389 @samp{} and @samp{(none)}.  To make the situation slightly better,
4390 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4391 what subjects should be excluded from the gathering process.  The
4392 default is @samp{^ *$\\|^(none)$}.  
4393
4394 @item gnus-summary-thread-gathering-function
4395 @vindex gnus-summary-thread-gathering-function
4396 Gnus gathers threads by looking at @code{Subject} headers.  This means
4397 that totally unrelated articles may end up in the same ``thread'', which
4398 is confusing.  An alternate approach is to look at all the
4399 @code{Message-ID}s in all the @code{References} headers to find matches.
4400 This will ensure that no gathered threads ever includes unrelated
4401 articles, but it's also means that people who have posted with broken
4402 newsreaders won't be gathered properly.  The choice is yours---plague or
4403 cholera:
4404
4405 @table @code
4406 @item gnus-gather-threads-by-subject
4407 @findex gnus-gather-threads-by-subject
4408 This function is the default gathering function and looks at
4409 @code{Subject}s exclusively.
4410
4411 @item gnus-gather-threads-by-references
4412 @findex gnus-gather-threads-by-references
4413 This function looks at @code{References} headers exclusively.
4414 @end table
4415
4416 If you want to test gathering by @code{References}, you could say
4417 something like:
4418
4419 @lisp
4420 (setq gnus-summary-thread-gathering-function
4421       'gnus-gather-threads-by-references)
4422 @end lisp
4423
4424 @item gnus-summary-make-false-root
4425 @vindex gnus-summary-make-false-root
4426 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4427 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4428 Yup.)  Loose subtrees occur when the real root has expired, or you've
4429 read or killed the root in a previous session.
4430
4431 When there is no real root of a thread, Gnus will have to fudge
4432 something.  This variable says what fudging method Gnus should use.
4433 There are four possible values:
4434
4435 @cindex adopting articles
4436
4437 @table @code
4438
4439 @item adopt
4440 Gnus will make the first of the orphaned articles the parent.  This
4441 parent will adopt all the other articles.  The adopted articles will be
4442 marked as such by pointy brackets (@samp{<>}) instead of the standard
4443 square brackets (@samp{[]}).  This is the default method.
4444
4445 @item dummy
4446 @vindex gnus-summary-dummy-line-format
4447 Gnus will create a dummy summary line that will pretend to be the
4448 parent.  This dummy line does not correspond to any real article, so
4449 selecting it will just select the first real article after the dummy
4450 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4451 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4452 which is the subject of the article.  @xref{Formatting Variables}.
4453
4454 @item empty
4455 Gnus won't actually make any article the parent, but simply leave the
4456 subject field of all orphans except the first empty.  (Actually, it will
4457 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4458 Buffer Format}).)
4459
4460 @item none
4461 Don't make any article parent at all.  Just gather the threads and
4462 display them after one another.
4463
4464 @item nil
4465 Don't gather loose threads.
4466 @end table
4467
4468 @item gnus-thread-hide-subtree
4469 @vindex gnus-thread-hide-subtree
4470 If non-@code{nil}, all threads will be hidden when the summary buffer is
4471 generated.
4472
4473 @item gnus-thread-hide-killed
4474 @vindex gnus-thread-hide-killed
4475 if you kill a thread and this variable is non-@code{nil}, the subtree
4476 will be hidden.
4477
4478 @item gnus-thread-ignore-subject
4479 @vindex gnus-thread-ignore-subject
4480 Sometimes somebody changes the subject in the middle of a thread.  If
4481 this variable is non-@code{nil}, the subject change is ignored.  If it
4482 is @code{nil}, which is the default, a change in the subject will result
4483 in a new thread.
4484
4485 @item gnus-thread-indent-level
4486 @vindex gnus-thread-indent-level
4487 This is a number that says how much each sub-thread should be indented.
4488 The default is 4.
4489 @end table
4490
4491
4492 @node Thread Commands
4493 @subsection Thread Commands
4494 @cindex thread commands
4495
4496 @table @kbd
4497
4498 @item T k
4499 @itemx M-C-k
4500 @kindex T k (Summary)
4501 @kindex M-C-k (Summary)
4502 @findex gnus-summary-kill-thread
4503 Mark all articles in the current (sub-)thread as read
4504 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4505 remove all marks instead.  If the prefix argument is negative, tick
4506 articles instead.
4507
4508 @item T l
4509 @itemx M-C-l
4510 @kindex T l (Summary)
4511 @kindex M-C-l (Summary)
4512 @findex gnus-summary-lower-thread
4513 Lower the score of the current (sub-)thread
4514 (@code{gnus-summary-lower-thread}). 
4515
4516 @item T i
4517 @kindex T i (Summary)
4518 @findex gnus-summary-raise-thread
4519 Increase the score of the current (sub-)thread
4520 (@code{gnus-summary-raise-thread}).
4521
4522 @item T #
4523 @kindex T # (Summary)
4524 @findex gnus-uu-mark-thread
4525 Set the process mark on the current (sub-)thread
4526 (@code{gnus-uu-mark-thread}).
4527
4528 @item T M-#
4529 @kindex T M-# (Summary)
4530 @findex gnus-uu-unmark-thread
4531 Remove the process mark from the current (sub-)thread
4532 (@code{gnus-uu-unmark-thread}).
4533
4534 @item T T
4535 @kindex T T (Summary)
4536 @findex gnus-summary-toggle-threads
4537 Toggle threading (@code{gnus-summary-toggle-threads}).
4538
4539 @item T s
4540 @kindex T s (Summary)
4541 @findex gnus-summary-show-thread
4542 Expose the (sub-)thread hidden under the current article, if any
4543 (@code{gnus-summary-show-thread}).
4544
4545 @item T h
4546 @kindex T h (Summary)
4547 @findex gnus-summary-hide-thread
4548 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4549
4550 @item T S
4551 @kindex T S (Summary)
4552 @findex gnus-summary-show-all-threads
4553 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4554
4555 @item T H
4556 @kindex T H (Summary)
4557 @findex gnus-summary-hide-all-threads
4558 Hide all threads (@code{gnus-summary-hide-all-threads}).
4559
4560 @item T t
4561 @kindex T t (Summary)
4562 @findex gnus-summary-rethread-current
4563 Re-thread the thread the current article is part of
4564 (@code{gnus-summary-rethread-current}).  This works even when the
4565 summary buffer is otherwise unthreaded.
4566
4567 @item T ^
4568 @kindex T ^ (Summary)
4569 @findex gnus-summary-reparent-thread
4570 Make the current article the child of the marked (or previous) article
4571 (@code{gnus-summary-reparent-thread}.
4572
4573 @end table
4574
4575 The following commands are thread movement commands.  They all
4576 understand the numeric prefix.
4577
4578 @table @kbd
4579
4580 @item T n
4581 @kindex T n (Summary)
4582 @findex gnus-summary-next-thread
4583 Go to the next thread (@code{gnus-summary-next-thread}).
4584
4585 @item T p
4586 @kindex T p (Summary)
4587 @findex gnus-summary-prev-thread
4588 Go to the previous thread (@code{gnus-summary-prev-thread}).
4589
4590 @item T d
4591 @kindex T d (Summary)
4592 @findex gnus-summary-down-thread
4593 Descend the thread (@code{gnus-summary-down-thread}).
4594
4595 @item T u
4596 @kindex T u (Summary)
4597 @findex gnus-summary-up-thread
4598 Ascend the thread (@code{gnus-summary-up-thread}).
4599
4600 @item T o
4601 @kindex T o (Summary)
4602 @findex gnus-summary-top-thread
4603 Go to the top of the thread (@code{gnus-summary-top-thread}).
4604 @end table
4605
4606 @vindex gnus-thread-operation-ignore-subject 
4607 If you ignore subject while threading, you'll naturally end up with
4608 threads that have several different subjects in them.  If you then issue
4609 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4610 wish to kill the entire thread, but just those parts of the thread that
4611 have the same subject as the current article.  If you like this idea,
4612 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If is
4613 is non-@code{nil} (which it is by default), subjects will be ignored
4614 when doing thread commands.  If this variable is @code{nil}, articles in
4615 the same thread with different subjects will not be included in the
4616 operation in question.  If this variable is @code{fuzzy}, only articles
4617 that have subjects that are fuzzily equal will be included.
4618
4619
4620 @node Sorting
4621 @section Sorting
4622
4623 @findex gnus-thread-sort-by-total-score
4624 @findex gnus-thread-sort-by-date
4625 @findex gnus-thread-sort-by-score
4626 @findex gnus-thread-sort-by-subject
4627 @findex gnus-thread-sort-by-author
4628 @findex gnus-thread-sort-by-number
4629 @vindex gnus-thread-sort-functions
4630 If you are using a threaded summary display, you can sort the threads by
4631 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4632 By default, sorting is done on article numbers.  Ready-made sorting
4633 predicate functions include @code{gnus-thread-sort-by-number},
4634 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4635 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4636 @code{gnus-thread-sort-by-total-score}.
4637
4638 Each function takes two threads and return non-@code{nil} if the first
4639 thread should be sorted before the other.  Note that sorting really is
4640 normally done by looking only at the roots of each thread.  If you use
4641 more than one function, the primary sort key should be the last function
4642 in the list.  You should probably always include
4643 @code{gnus-thread-sort-by-number} in the list of sorting
4644 functions---preferably first.  This will ensure that threads that are
4645 equal with respect to the other sort criteria will be displayed in
4646 ascending article order.
4647
4648 If you would like to sort by score, then by subject, and finally by
4649 number, you could do something like:
4650
4651 @lisp
4652 (setq gnus-thread-sort-functions 
4653       '(gnus-thread-sort-by-number
4654         gnus-thread-sort-by-subject
4655         gnus-thread-sort-by-score))
4656 @end lisp
4657
4658 The threads that have highest score will be displayed first in the
4659 summary buffer.  When threads have the same score, they will be sorted
4660 alphabetically.  The threads that have the same score and the same
4661 subject will be sorted by number, which is (normally) the sequence in
4662 which the articles arrived.
4663
4664 If you want to sort by score and then reverse arrival order, you could
4665 say something like:
4666
4667 @lisp
4668 (setq gnus-thread-sort-functions
4669       '((lambda (t1 t2) 
4670           (not (gnus-thread-sort-by-number t1 t2)))
4671         gnus-thread-sort-by-score))
4672 @end lisp
4673
4674 @vindex gnus-thread-score-function
4675 The function in the @code{gnus-thread-score-function} variable (default
4676 @code{+}) is used for calculating the total score of a thread.  Useful
4677 functions might be @code{max}, @code{min}, or squared means, or whatever
4678 tickles your fancy.
4679
4680 @findex gnus-article-sort-functions
4681 @findex gnus-article-sort-by-date
4682 @findex gnus-article-sort-by-score
4683 @findex gnus-article-sort-by-subject
4684 @findex gnus-article-sort-by-author
4685 @findex gnus-article-sort-by-number
4686 If you are using an unthreaded display for some strange reason or other,
4687 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4688 It is very similar to the @code{gnus-thread-sort-functions}, except that
4689 is uses slightly different functions for article comparison.  Available
4690 sorting predicate functions are @code{gnus-article-sort-by-number},
4691 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4692 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4693
4694 If you want to sort an unthreaded summary display by subject, you could
4695 say something like:
4696
4697 @lisp
4698 (setq gnus-article-sort-functions 
4699       '(gnus-article-sort-by-number
4700         gnus-article-sort-by-subject))
4701 @end lisp
4702
4703
4704
4705 @node Asynchronous Fetching
4706 @section Asynchronous Article Fetching
4707 @cindex asynchronous article fetching
4708 @cindex article pre-fetch
4709 @cindex pre-fetch
4710
4711 If you read your news from an @sc{nntp} server that's far away, the
4712 network latencies may make reading articles a chore.  You have to wait
4713 for a while after pressing @kbd{n} to go to the next article before the
4714 article appears.  Why can't Gnus just go ahead and fetch the article
4715 while you are reading the previous one?  Why not, indeed.
4716
4717 First, some caveats.  There are some pitfalls to using asynchronous
4718 article fetching, especially the way Gnus does it.  
4719
4720 Let's say you are reading article 1, which is short, and article 2 is
4721 quite long, and you are not interested in reading that.  Gnus does not
4722 know this, so it goes ahead and fetches article 2.  You decide to read
4723 article 3, but since Gnus is in the process of fetching article 2, the
4724 connection is blocked.
4725
4726 To avoid these situations, Gnus will open two (count 'em two)
4727 connections to the server.  Some people may think this isn't a very nice
4728 thing to do, but I don't see any real alternatives.  Setting up that
4729 extra connection takes some time, so Gnus startup will be slower.
4730
4731 Gnus will fetch more articles than you will read.  This will mean that
4732 the link between your machine and the @sc{nntp} server will become more
4733 loaded than if you didn't use article pre-fetch.  The server itself will
4734 also become more loaded---both with the extra article requests, and the
4735 extra connection.
4736
4737 Ok, so now you know that you shouldn't really use this thing...  unless
4738 you really want to.
4739
4740 @vindex gnus-asynchronous
4741 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4742 happen automatically.
4743
4744 @vindex gnus-use-article-prefetch
4745 You can control how many articles that are to be pre-fetched by setting
4746 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
4747 that when you read an article in the group, the backend will pre-fetch
4748 the next 30 articles.  If this variable is @code{t}, the backend will
4749 pre-fetch all the articles that it can without bound.  If it is
4750 @code{nil}, no pre-fetching will be made.
4751
4752 @vindex gnus-async-prefetch-article-p
4753 @findex gnus-async-read-p
4754 There are probably some articles that you don't want to pre-fetch---read
4755 articles, for instance.  Which articles to pre-fetch is controlled by
4756 the @code{gnus-async-prefetch-article-p} variable.  This function should
4757 return non-@code{nil} when the article in question is to be
4758 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
4759 @code{nil} on read articles.  The function is called with an article
4760 data structure as the only parameter.
4761
4762 If, for instance, you wish to pre-fetch only unread articles that are
4763 shorter than 100 lines, you could say something like:
4764
4765 @lisp
4766 (defun my-async-short-unread-p (data)
4767   "Return non-nil for short, unread articles."
4768   (and (gnus-data-unread-p data)
4769        (< (mail-header-lines (gnus-data-header data))
4770           100)))
4771
4772 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4773 @end lisp
4774
4775 These functions will be called many, many times, so they should
4776 preferrably be short and sweet to avoid slowing down Gnus too much.
4777 It's also probably a good idea to byte-compile things like this.
4778
4779 @vindex gnus-prefetched-article-deletion-strategy
4780 Articles have to be removed from the asynch buffer sooner or later.  The
4781 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4782 articles.  This is a list that may contain the following elements:
4783
4784 @table @code
4785 @item read
4786 Remove articles when they are read.
4787
4788 @item exit
4789 Remove articles when exiting the group.
4790 @end table
4791
4792 The default value is @code{(read exit)}.
4793
4794 @vindex gnus-use-header-prefetch
4795 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4796 from the next group.
4797
4798
4799 @node Article Caching
4800 @section Article Caching
4801 @cindex article caching
4802 @cindex caching
4803
4804 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4805 consider turning article caching on.  Each article will then be stored
4806 locally under your home directory.  As you may surmise, this could
4807 potentially use @emph{huge} amounts of disk space, as well as eat up all
4808 your inodes so fast it will make your head swim.  In vodka.
4809
4810 Used carefully, though, it could be just an easier way to save articles.
4811
4812 @vindex gnus-use-long-file-name
4813 @vindex gnus-cache-directory
4814 @vindex gnus-use-cache
4815 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4816 all articles that are ticked or marked as dormant will then be copied
4817 over to your local cache (@code{gnus-cache-directory}).  Whether this
4818 cache is flat or hierarchal is controlled by the
4819 @code{gnus-use-long-file-name} variable, as usual.
4820
4821 When re-select a ticked or dormant article, it will be fetched from the
4822 cache instead of from the server.  As articles in your cache will never
4823 expire, this might serve as a method of saving articles while still
4824 keeping them where they belong.  Just mark all articles you want to save
4825 as dormant, and don't worry.
4826
4827 When an article is marked as read, is it removed from the cache.
4828
4829 @vindex gnus-cache-remove-articles
4830 @vindex gnus-cache-enter-articles
4831 The entering/removal of articles from the cache is controlled by the
4832 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4833 variables.  Both are lists of symbols.  The first is @code{(ticked
4834 dormant)} by default, meaning that ticked and dormant articles will be
4835 put in the cache.  The latter is @code{(read)} by default, meaning that
4836 articles that are marked as read are removed from the cache.  Possibly
4837 symbols in these two lists are @code{ticked}, @code{dormant},
4838 @code{unread} and @code{read}.
4839
4840 @findex gnus-jog-cache
4841 So where does the massive article-fetching and storing come into the
4842 picture?  The @code{gnus-jog-cache} command will go through all
4843 subscribed newsgroups, request all unread articles, and store them in
4844 the cache.  You should only ever, ever ever ever, use this command if 1)
4845 your connection to the @sc{nntp} server is really, really, really slow
4846 and 2) you have a really, really, really huge disk.  Seriously.
4847
4848 @vindex gnus-uncacheable-groups
4849 It is likely that you do not want caching on some groups.  For instance,
4850 if your @code{nnml} mail is located under your home directory, it makes no
4851 sense to cache it somewhere else under your home directory.  Unless you
4852 feel that it's neat to use twice as much space.  To limit the caching,
4853 you could set the @code{gnus-uncacheable-groups} regexp to
4854 @samp{^nnml}, for instance.  This variable is @code{nil} by
4855 default.
4856
4857 @findex gnus-cache-generate-nov-databases
4858 @findex gnus-cache-generate-active
4859 @vindex gnus-cache-active-file
4860 The cache stores information on what articles it contains in its active
4861 file (@code{gnus-cache-active-file}).  If this file (or any other parts
4862 of the cache) becomes all messed up for some reason or other, Gnus
4863 offers two functions that will try to set things right.  @kbd{M-x
4864 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4865 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4866 file.
4867
4868
4869 @node Persistent Articles
4870 @section Persistent Articles
4871 @cindex persistent articles
4872
4873 Closely related to article caching, we have @dfn{persistent articles}.
4874 In fact, it's just a different way of looking at caching, and much more
4875 useful in my opinion.
4876
4877 Say you're reading a newsgroup, and you happen on to some valuable gem
4878 that you want to keep and treasure forever.  You'd normally just save it
4879 (using one of the many saving commands) in some file.  The problem with
4880 that is that it's just, well, yucky.  Ideally you'd prefer just having
4881 the article remain in the group where you found it forever; untouched by
4882 the expiry going on at the news server.
4883
4884 This is what a @dfn{persistent article} is---an article that just won't
4885 be deleted.  It's implemented using the normal cache functions, but
4886 you use two explicit commands for managing persistent articles:
4887
4888 @table @kbd
4889
4890 @item *
4891 @kindex * (Summary)
4892 @findex gnus-cache-enter-article
4893 Make the current article persistent (@code{gnus-cache-enter-article}). 
4894
4895 @item M-*
4896 @kindex M-* (Summary)
4897 @findex gnus-cache-remove-article
4898 Remove the current article from the persistent articles
4899 (@code{gnus-cache-remove-article}).  This will normally delete the
4900 article. 
4901 @end table
4902
4903 Both these commands understand the process/prefix convention. 
4904
4905 To avoid having all ticked articles (and stuff) entered into the cache,
4906 you should set @code{gnus-use-cache} to @code{passive} if you're just
4907 interested in persistent articles:
4908
4909 @lisp
4910 (setq gnus-use-cache 'passive)
4911 @end lisp
4912
4913
4914 @node Article Backlog
4915 @section Article Backlog
4916 @cindex backlog
4917 @cindex article backlog
4918
4919 If you have a slow connection, but the idea of using caching seems
4920 unappealing to you (and it is, really), you can help the situation some
4921 by switching on the @dfn{backlog}.  This is where Gnus will buffer
4922 already read articles so that it doesn't have to re-fetch articles
4923 you've already read.  This only helps if you are in the habit of
4924 re-selecting articles you've recently read, of course.  If you never do
4925 that, turning the backlog on will slow Gnus down a little bit, and
4926 increase memory usage some.
4927
4928 @vindex gnus-keep-backlog
4929 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
4930 at most @var{n} old articles in a buffer for later re-fetching.  If this
4931 variable is non-@code{nil} and is not a number, Gnus will store
4932 @emph{all} read articles, which means that your Emacs will grow without
4933 bound before exploding and taking your machine down with you.  I put
4934 that in there just to keep y'all on your toes.  
4935
4936 This variable is @code{nil} by default.
4937
4938
4939 @node Saving Articles
4940 @section Saving Articles
4941 @cindex saving articles
4942
4943 Gnus can save articles in a number of ways.  Below is the documentation
4944 for saving articles in a fairly straight-forward fashion (i.e., little
4945 processing of the article is done before it is saved).  For a different
4946 approach (uudecoding, unsharing) you should use @code{gnus-uu}
4947 (@pxref{Decoding Articles}).
4948
4949 @vindex gnus-save-all-headers
4950 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
4951 unwanted headers before saving the article.
4952
4953 @vindex gnus-saved-headers
4954 If the preceding variable is @code{nil}, all headers that match the
4955 @code{gnus-saved-headers} regexp will be kept, while the rest will be
4956 deleted before saving.
4957
4958 @table @kbd
4959
4960 @item O o
4961 @itemx o
4962 @kindex O o (Summary)
4963 @kindex o (Summary)
4964 @findex gnus-summary-save-article
4965 Save the current article using the default article saver
4966 (@code{gnus-summary-save-article}). 
4967
4968 @item O m
4969 @kindex O m (Summary)
4970 @findex gnus-summary-save-article-mail
4971 Save the current article in mail format
4972 (@code{gnus-summary-save-article-mail}). 
4973
4974 @item O r
4975 @kindex O r (Summary)
4976 @findex gnus-summary-save-article-rmail
4977 Save the current article in rmail format
4978 (@code{gnus-summary-save-article-rmail}). 
4979
4980 @item O f
4981 @kindex O f (Summary)
4982 @findex gnus-summary-save-article-file
4983 Save the current article in plain file format
4984 (@code{gnus-summary-save-article-file}). 
4985
4986 @item O F
4987 @kindex O F (Summary)
4988 @findex gnus-summary-write-article-file
4989 Write the current article in plain file format, overwriting any previous
4990 file contents (@code{gnus-summary-write-article-file}). 
4991
4992 @item O b
4993 @kindex O b (Summary)
4994 @findex gnus-summary-save-article-body-file
4995 Save the current article body in plain file format
4996 (@code{gnus-summary-save-article-body-file}). 
4997
4998 @item O h
4999 @kindex O h (Summary)
5000 @findex gnus-summary-save-article-folder
5001 Save the current article in mh folder format
5002 (@code{gnus-summary-save-article-folder}). 
5003
5004 @item O v
5005 @kindex O v (Summary)
5006 @findex gnus-summary-save-article-vm
5007 Save the current article in a VM folder
5008 (@code{gnus-summary-save-article-vm}).
5009
5010 @item O p
5011 @kindex O p (Summary)
5012 @findex gnus-summary-pipe-output
5013 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5014 the current article to a process (@code{gnus-summary-pipe-output}).
5015 @end table
5016
5017 @vindex gnus-prompt-before-saving
5018 All these commands use the process/prefix convention
5019 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5020 functions, you might get tired of being prompted for files to save each
5021 and every article in.  The prompting action is controlled by
5022 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5023 default, giving you that excessive prompting action you know and
5024 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5025 just once for each series of articles you save.  If you like to really
5026 have Gnus do all your thinking for you, you can even set this variable
5027 to @code{nil}, which means that you will never be prompted for files to
5028 save articles in.  Gnus will simply save all the articles in the default
5029 files. 
5030
5031
5032 @vindex gnus-default-article-saver
5033 You can customize the @code{gnus-default-article-saver} variable to make
5034 Gnus do what you want it to.  You can use any of the four ready-made
5035 functions below, or you can create your own.
5036
5037 @table @code
5038
5039 @item gnus-summary-save-in-rmail
5040 @findex gnus-summary-save-in-rmail
5041 @vindex gnus-rmail-save-name
5042 @findex gnus-plain-save-name
5043 This is the default format, @dfn{babyl}.  Uses the function in the
5044 @code{gnus-rmail-save-name} variable to get a file name to save the
5045 article in.  The default is @code{gnus-plain-save-name}.
5046
5047 @item gnus-summary-save-in-mail
5048 @findex gnus-summary-save-in-mail
5049 @vindex gnus-mail-save-name
5050 Save in a Unix mail (mbox) file.  Uses the function in the
5051 @code{gnus-mail-save-name} variable to get a file name to save the
5052 article in.  The default is @code{gnus-plain-save-name}.
5053
5054 @item gnus-summary-save-in-file
5055 @findex gnus-summary-save-in-file
5056 @vindex gnus-file-save-name
5057 @findex gnus-numeric-save-name
5058 Append the article straight to an ordinary file.  Uses the function in
5059 the @code{gnus-file-save-name} variable to get a file name to save the
5060 article in.  The default is @code{gnus-numeric-save-name}.
5061
5062 @item gnus-summary-save-body-in-file
5063 @findex gnus-summary-save-body-in-file
5064 Append the article body to an ordinary file.  Uses the function in the
5065 @code{gnus-file-save-name} variable to get a file name to save the
5066 article in.  The default is @code{gnus-numeric-save-name}.
5067
5068 @item gnus-summary-save-in-folder
5069 @findex gnus-summary-save-in-folder
5070 @findex gnus-folder-save-name
5071 @findex gnus-Folder-save-name
5072 @vindex gnus-folder-save-name
5073 @cindex rcvstore
5074 @cindex MH folders
5075 Save the article to an MH folder using @code{rcvstore} from the MH
5076 library.  Uses the function in the @code{gnus-folder-save-name} variable
5077 to get a file name to save the article in.  The default is
5078 @code{gnus-folder-save-name}, but you can also use
5079 @code{gnus-Folder-save-name}.  The former creates capitalized names, and
5080 the latter does not.
5081
5082 @item gnus-summary-save-in-vm
5083 @findex gnus-summary-save-in-vm
5084 Save the article in a VM folder.  You have to have the VM mail
5085 reader to use this setting.
5086 @end table
5087
5088 @vindex gnus-article-save-directory
5089 All of these functions, except for the last one, will save the article
5090 in the @code{gnus-article-save-directory}, which is initialized from the
5091 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5092 default. 
5093
5094 As you can see above, the functions use different functions to find a
5095 suitable name of a file to save the article in.  Below is a list of
5096 available functions that generate names:
5097
5098 @table @code
5099
5100 @item gnus-Numeric-save-name
5101 @findex gnus-Numeric-save-name
5102 File names like @file{~/News/Alt.andrea-dworkin/45}.
5103
5104 @item gnus-numeric-save-name
5105 @findex gnus-numeric-save-name
5106 File names like @file{~/News/alt.andrea-dworkin/45}.
5107
5108 @item gnus-Plain-save-name
5109 @findex gnus-Plain-save-name
5110 File names like @file{~/News/Alt.andrea-dworkin}.
5111
5112 @item gnus-plain-save-name
5113 @findex gnus-plain-save-name
5114 File names like @file{~/News/alt.andrea-dworkin}.
5115 @end table
5116
5117 @vindex gnus-split-methods
5118 You can have Gnus suggest where to save articles by plonking a regexp into
5119 the @code{gnus-split-methods} alist.  For instance, if you would like to
5120 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5121 related to VM in @code{vm-stuff}, you could set this variable to something
5122 like:
5123
5124 @lisp
5125 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5126  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5127  (my-choosing-function "../other-dir/my-stuff")
5128  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5129 @end lisp
5130
5131 We see that this is a list where each element is a list that has two
5132 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5133 a string (in which case it is used as a regexp to match on the article
5134 head); it can be a symbol (which will be called as a function with the
5135 group name as a parameter); or it can be a list (which will be
5136 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5137 the @dfn{file} will be used as a default prompt.  In addition, the
5138 result of the operation itself will be used if the function or form
5139 called returns a string or a list of strings.
5140
5141 You basically end up with a list of file names that might be used when
5142 saving the current article.  (All ``matches'' will be used.)  You will
5143 then be prompted for what you really want to use as a name, with file
5144 name completion over the results from applying this variable.
5145
5146 This variable is @code{((gnus-article-archive-name))} by default, which
5147 means that Gnus will look at the articles it saves for an
5148 @code{Archive-name} line and use that as a suggestion for the file
5149 name. 
5150
5151 @vindex gnus-use-long-file-name
5152 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5153 @code{nil}, all the preceding functions will replace all periods
5154 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5155 the functions will generate hierarchies of directories instead of having
5156 all the files in the toplevel directory
5157 (@file{~/News/alt/andrea-dworkin} instead of
5158 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5159 on most systems.  However, for historical reasons, this is @code{nil} on
5160 Xenix and usg-unix-v machines by default.
5161
5162 This function also affects kill and score file names.  If this variable
5163 is a list, and the list contains the element @code{not-score}, long file
5164 names will not be used for score files, if it contains the element
5165 @code{not-save}, long file names will not be used for saving, and if it
5166 contains the element @code{not-kill}, long file names will not be used
5167 for kill files.
5168
5169 If you'd like to save articles in a hierarchy that looks something like
5170 a spool, you could
5171
5172 @lisp
5173 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5174 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5175 @end lisp
5176
5177 Then just save with @kbd{o}.  You'd then read this hierarchy with
5178 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5179 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5180 around to the groups/directories with @code{nneething}.
5181
5182
5183 @node Decoding Articles
5184 @section Decoding Articles
5185 @cindex decoding articles
5186
5187 Sometime users post articles (or series of articles) that have been
5188 encoded in some way or other.  Gnus can decode them for you.
5189
5190 @menu 
5191 * Uuencoded Articles::    Uudecode articles.
5192 * Shared Articles::       Unshar articles.
5193 * PostScript Files::      Split PostScript.
5194 * Decoding Variables::    Variables for a happy decoding.
5195 * Viewing Files::         You want to look at the result of the decoding?
5196 @end menu
5197
5198 All these functions use the process/prefix convention
5199 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5200 the extension that a ``single article'' means ``a single series''.  Gnus
5201 can find out by itself what articles belong to a series, decode all the
5202 articles and unpack/view/save the resulting file(s).
5203
5204 Gnus guesses what articles are in the series according to the following
5205 simplish rule: The subjects must be (nearly) identical, except for the
5206 last two numbers of the line.  (Spaces are largely ignored, however.)
5207
5208 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5209 will find all the articles that match the regexp @samp{^cat.gif
5210 ([0-9]+/[0-9]+).*$}.  
5211
5212 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5213 series}, will not be properly recognized by any of the automatic viewing
5214 commands, and you have to mark the articles manually with @kbd{#}.
5215
5216
5217 @node Uuencoded Articles
5218 @subsection Uuencoded Articles
5219 @cindex uudecode
5220 @cindex uuencoded articles
5221
5222 @table @kbd
5223
5224 @item X u
5225 @kindex X u (Summary)
5226 @findex gnus-uu-decode-uu
5227 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5228
5229 @item X U
5230 @kindex X U (Summary)
5231 @findex gnus-uu-decode-uu-and-save
5232 Uudecodes and saves the current series
5233 (@code{gnus-uu-decode-uu-and-save}).
5234
5235 @item X v u
5236 @kindex X v u (Summary)
5237 @findex gnus-uu-decode-uu-view
5238 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5239
5240 @item X v U
5241 @kindex X v U (Summary)
5242 @findex gnus-uu-decode-uu-and-save-view
5243 Uudecodes, views and saves the current series
5244 (@code{gnus-uu-decode-uu-and-save-view}). 
5245 @end table
5246
5247 Remember that these all react to the presence of articles marked with
5248 the process mark.  If, for instance, you'd like to decode and save an
5249 entire newsgroup, you'd typically do @kbd{M P a}
5250 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5251 (@code{gnus-uu-decode-uu-and-save}).
5252
5253 All this is very much different from how @code{gnus-uu} worked with
5254 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5255 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5256 articles in some way (@pxref{Setting Process Marks}) and then press
5257 @kbd{X u}.
5258
5259 @vindex gnus-uu-notify-files
5260 Note: When trying to decode articles that have names matching
5261 @code{gnus-uu-notify-files}, which is hard-coded to
5262 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5263 automatically post an article on @samp{comp.unix.wizards} saying that
5264 you have just viewed the file in question.  This feature can't be turned
5265 off.
5266
5267
5268 @node Shared Articles
5269 @subsection Shared Articles
5270 @cindex unshar
5271 @cindex shared articles
5272
5273 @table @kbd
5274
5275 @item X s
5276 @kindex X s (Summary)
5277 @findex gnus-uu-decode-unshar
5278 Unshars the current series (@code{gnus-uu-decode-unshar}).
5279
5280 @item X S
5281 @kindex X S (Summary)
5282 @findex gnus-uu-decode-unshar-and-save
5283 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5284
5285 @item X v s
5286 @kindex X v s (Summary)
5287 @findex gnus-uu-decode-unshar-view
5288 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5289
5290 @item X v S
5291 @kindex X v S (Summary)
5292 @findex gnus-uu-decode-unshar-and-save-view
5293 Unshars, views and saves the current series
5294 (@code{gnus-uu-decode-unshar-and-save-view}). 
5295 @end table
5296
5297
5298 @node PostScript Files
5299 @subsection PostScript Files
5300 @cindex PostScript
5301
5302 @table @kbd
5303
5304 @item X p
5305 @kindex X p (Summary)
5306 @findex gnus-uu-decode-postscript
5307 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5308
5309 @item X P
5310 @kindex X P (Summary)
5311 @findex gnus-uu-decode-postscript-and-save
5312 Unpack and save the current PostScript series
5313 (@code{gnus-uu-decode-postscript-and-save}).
5314
5315 @item X v p
5316 @kindex X v p (Summary)
5317 @findex gnus-uu-decode-postscript-view
5318 View the current PostScript series
5319 (@code{gnus-uu-decode-postscript-view}).
5320
5321 @item X v P
5322 @kindex X v P (Summary)
5323 @findex gnus-uu-decode-postscript-and-save-view
5324 View and save the current PostScript series
5325 (@code{gnus-uu-decode-postscript-and-save-view}). 
5326 @end table
5327
5328
5329 @node Decoding Variables
5330 @subsection Decoding Variables
5331
5332 Adjective, not verb.
5333
5334 @menu 
5335 * Rule Variables::          Variables that say how a file is to be viewed.
5336 * Other Decode Variables::  Other decode variables.
5337 * Uuencoding and Posting::  Variables for customizing uuencoding.
5338 @end menu
5339
5340
5341 @node Rule Variables
5342 @subsubsection Rule Variables
5343 @cindex rule variables
5344
5345 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5346 variables are on the form
5347   
5348 @lisp
5349       (list '(regexp1 command2)
5350             '(regexp2 command2)
5351             ...)
5352 @end lisp
5353
5354 @table @code
5355
5356 @item gnus-uu-user-view-rules
5357 @vindex gnus-uu-user-view-rules
5358 @cindex sox
5359 This variable is consulted first when viewing files.  If you wish to use,
5360 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5361 say something like:
5362 @lisp
5363 (setq gnus-uu-user-view-rules
5364       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5365 @end lisp
5366
5367 @item gnus-uu-user-view-rules-end
5368 @vindex gnus-uu-user-view-rules-end
5369 This variable is consulted if Gnus couldn't make any matches from the
5370 user and default view rules.
5371
5372 @item gnus-uu-user-archive-rules
5373 @vindex gnus-uu-user-archive-rules
5374 This variable can be used to say what commands should be used to unpack
5375 archives.
5376 @end table
5377
5378
5379 @node Other Decode Variables
5380 @subsubsection Other Decode Variables
5381
5382 @table @code
5383 @vindex gnus-uu-grabbed-file-functions
5384
5385 @item gnus-uu-grabbed-file-functions
5386 All functions in this list will be called right each file has been
5387 successfully decoded---so that you can move or view files right away,
5388 and don't have to wait for all files to be decoded before you can do
5389 anything.  Ready-made functions you can put in this list are:
5390
5391 @table @code
5392
5393 @item gnus-uu-grab-view
5394 @findex gnus-uu-grab-view
5395 View the file.
5396
5397 @item gnus-uu-grab-move
5398 @findex gnus-uu-grab-move
5399 Move the file (if you're using a saving function.)
5400 @end table
5401
5402 @item gnus-uu-be-dangerous
5403 @vindex gnus-uu-be-dangerous
5404 Specifies what to do if unusual situations arise during decoding.  If
5405 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5406 that didn't work, and overwrite existing files.  Otherwise, ask each
5407 time.
5408
5409 @item gnus-uu-ignore-files-by-name
5410 @vindex gnus-uu-ignore-files-by-name
5411 Files with name matching this regular expression won't be viewed.
5412
5413 @item gnus-uu-ignore-files-by-type
5414 @vindex gnus-uu-ignore-files-by-type
5415 Files with a @sc{mime} type matching this variable won't be viewed.
5416 Note that Gnus tries to guess what type the file is based on the name.
5417 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5418 kludgey.
5419
5420 @item gnus-uu-tmp-dir
5421 @vindex gnus-uu-tmp-dir
5422 Where @code{gnus-uu} does its work.
5423
5424 @item gnus-uu-do-not-unpack-archives
5425 @vindex gnus-uu-do-not-unpack-archives
5426 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5427 looking for files to display.
5428
5429 @item gnus-uu-view-and-save
5430 @vindex gnus-uu-view-and-save
5431 Non-@code{nil} means that the user will always be asked to save a file
5432 after viewing it.
5433
5434 @item gnus-uu-ignore-default-view-rules
5435 @vindex gnus-uu-ignore-default-view-rules
5436 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5437 rules.
5438
5439 @item gnus-uu-ignore-default-archive-rules
5440 @vindex gnus-uu-ignore-default-archive-rules
5441 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5442 unpacking commands.
5443
5444 @item gnus-uu-kill-carriage-return
5445 @vindex gnus-uu-kill-carriage-return
5446 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5447 from articles.
5448
5449 @item gnus-uu-unmark-articles-not-decoded
5450 @vindex gnus-uu-unmark-articles-not-decoded
5451 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5452 unsuccessfully decoded as unread.
5453
5454 @item gnus-uu-correct-stripped-uucode
5455 @vindex gnus-uu-correct-stripped-uucode
5456 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5457 uuencoded files that have had trailing spaces deleted.
5458
5459 @item gnus-uu-view-with-metamail
5460 @vindex gnus-uu-view-with-metamail
5461 @cindex metamail
5462 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5463 commands defined by the rule variables and just fudge a @sc{mime}
5464 content type based on the file name.  The result will be fed to
5465 @code{metamail} for viewing.
5466
5467 @item gnus-uu-save-in-digest
5468 @vindex gnus-uu-save-in-digest
5469 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5470 decoding, will save in digests.  If this variable is @code{nil},
5471 @code{gnus-uu} will just save everything in a file without any
5472 embellishments.  The digesting almost conforms to RFC1153---no easy way
5473 to specify any meaningful volume and issue numbers were found, so I
5474 simply dropped them.
5475
5476 @end table
5477
5478
5479 @node Uuencoding and Posting
5480 @subsubsection Uuencoding and Posting
5481
5482 @table @code
5483
5484 @item gnus-uu-post-include-before-composing
5485 @vindex gnus-uu-post-include-before-composing
5486 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5487 before you compose the article.  If this variable is @code{t}, you can
5488 either include an encoded file with @kbd{C-c C-i} or have one included
5489 for you when you post the article.
5490
5491 @item gnus-uu-post-length
5492 @vindex gnus-uu-post-length
5493 Maximum length of an article.  The encoded file will be split into how
5494 many articles it takes to post the entire file.
5495
5496 @item gnus-uu-post-threaded
5497 @vindex gnus-uu-post-threaded
5498 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5499 thread.  This may not be smart, as no other decoder I have seen are able
5500 to follow threads when collecting uuencoded articles.  (Well, I have
5501 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5502 think that counts...) Default is @code{nil}.
5503
5504 @item gnus-uu-post-separate-description
5505 @vindex gnus-uu-post-separate-description
5506 Non-@code{nil} means that the description will be posted in a separate
5507 article.  The first article will typically be numbered (0/x).  If this
5508 variable is @code{nil}, the description the user enters will be included
5509 at the beginning of the first article, which will be numbered (1/x).
5510 Default is @code{t}.
5511
5512 @end table
5513
5514
5515 @node Viewing Files
5516 @subsection Viewing Files
5517 @cindex viewing files
5518 @cindex pseudo-articles
5519
5520 After decoding, if the file is some sort of archive, Gnus will attempt
5521 to unpack the archive and see if any of the files in the archive can be
5522 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5523 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5524 uncompress and de-tar the main file, and then view the two pictures.
5525 This unpacking process is recursive, so if the archive contains archives
5526 of archives, it'll all be unpacked.
5527
5528 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5529 extracted file into the summary buffer.  If you go to these
5530 ``articles'', you will be prompted for a command to run (usually Gnus
5531 will make a suggestion), and then the command will be run.
5532
5533 @vindex gnus-view-pseudo-asynchronously
5534 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5535 until the viewing is done before proceeding.
5536
5537 @vindex gnus-view-pseudos
5538 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5539 the pseudo-articles into the summary buffer, but view them
5540 immediately.  If this variable is @code{not-confirm}, the user won't even
5541 be asked for a confirmation before viewing is done.
5542
5543 @vindex gnus-view-pseudos-separately 
5544 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5545 pseudo-article will be created for each file to be viewed.  If
5546 @code{nil}, all files that use the same viewing command will be given as
5547 a list of parameters to that command.
5548
5549 @vindex gnus-insert-pseudo-articles
5550 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5551 pseudo-articles when decoding.  It is @code{t} by default.
5552
5553 So; there you are, reading your @emph{pseudo-articles} in your
5554 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5555 Why isn't anything real anymore? How did we get here?
5556
5557
5558 @node Article Treatment
5559 @section Article Treatment
5560
5561 Reading through this huge manual, you may have quite forgotten that the
5562 object of newsreaders are to actually, like, read what people have
5563 written.  Reading articles.  Unfortunately, people are quite bad at
5564 writing, so there are tons of functions and variables to make reading
5565 these articles easier.
5566
5567 @menu
5568 * Article Highlighting::    You want to make the article look like fruit salad.
5569 * Article Fontisizing::     Making emphasized text look niced.
5570 * Article Hiding::          You also want to make certain info go away.
5571 * Article Washing::         Lots of way-neat functions to make life better.
5572 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
5573 * Article Date::            Grumble, UT!
5574 * Article Signature::       What is a signature?
5575 @end menu
5576
5577
5578 @node Article Highlighting
5579 @subsection Article Highlighting
5580 @cindex highlight
5581
5582 Not only do you want your article buffer to look like fruit salad, but
5583 you want it to look like technicolor fruit salad.
5584
5585 @table @kbd
5586
5587 @item W H a
5588 @kindex W H a (Summary)
5589 @findex gnus-article-highlight
5590 Highlight the current article (@code{gnus-article-highlight}).
5591
5592 @item W H h
5593 @kindex W H h (Summary)
5594 @findex gnus-article-highlight-headers
5595 @vindex gnus-header-face-alist
5596 Highlight the headers (@code{gnus-article-highlight-headers}).  The
5597 highlighting will be done according to the @code{gnus-header-face-alist}
5598 variable, which is a list where each element has the form @var{(regexp
5599 name content)}.  @var{regexp} is a regular expression for matching the
5600 header, @var{name} is the face used for highlighting the header name and
5601 @var{content} is the face for highlighting the header value.  The first
5602 match made will be used.  Note that @var{regexp} shouldn't have @samp{^}
5603 prepended---Gnus will add one.
5604
5605 @item W H c
5606 @kindex W H c (Summary)
5607 @findex gnus-article-highlight-citation
5608 Highlight cited text (@code{gnus-article-highlight-citation}). 
5609
5610 Some variables to customize the citation highlights:
5611
5612 @table @code
5613 @vindex gnus-cite-parse-max-size
5614
5615 @item gnus-cite-parse-max-size
5616 If the article size if bigger than this variable (which is 25000 by
5617 default), no citation highlighting will be performed.  
5618
5619 @item gnus-cite-prefix-regexp
5620 @vindex gnus-cite-prefix-regexp
5621 Regexp matching the longest possible citation prefix on a line. 
5622
5623 @item gnus-cite-max-prefix
5624 @vindex gnus-cite-max-prefix
5625 Maximum possible length for a citation prefix (default 20).
5626
5627 @item gnus-cite-face-list
5628 @vindex gnus-cite-face-list
5629 List of faces used for highlighting citations.  When there are citations
5630 from multiple articles in the same message, Gnus will try to give each
5631 citation from each article its own face.  This should make it easier to
5632 see who wrote what.
5633
5634 @item gnus-supercite-regexp
5635 @vindex gnus-supercite-regexp
5636 Regexp matching normal Supercite attribution lines.  
5637
5638 @item gnus-supercite-secondary-regexp
5639 @vindex gnus-supercite-secondary-regexp
5640 Regexp matching mangled Supercite attribution lines.
5641
5642 @item gnus-cite-minimum-match-count
5643 @vindex gnus-cite-minimum-match-count
5644 Minimum number of identical prefixes we have to see before we believe
5645 that it's a citation.
5646
5647 @item gnus-cite-attribution-prefix
5648 @vindex gnus-cite-attribution-prefix
5649 Regexp matching the beginning of an attribution line.
5650
5651 @item gnus-cite-attribution-suffix
5652 @vindex gnus-cite-attribution-suffix
5653 Regexp matching the end of an attribution line.
5654
5655 @item gnus-cite-attribution-face
5656 @vindex gnus-cite-attribution-face
5657 Face used for attribution lines.  It is merged with the face for the
5658 cited text belonging to the attribution.
5659
5660 @end table
5661
5662
5663 @item W H s
5664 @kindex W H s (Summary)
5665 @vindex gnus-signature-separator
5666 @vindex gnus-signature-face
5667 @findex gnus-article-highlight-signature
5668 Highlight the signature (@code{gnus-article-highlight-signature}).
5669 Everything after @code{gnus-signature-separator} (@pxref{Article
5670 Signature}) in an article will be considered a signature and will be
5671 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5672 default.
5673
5674 @end table
5675
5676
5677 @node Article Fontisizing
5678 @subsection Article Fontisizing
5679 @cindex emphasis
5680 @cindex article emphasis
5681
5682 @findex gnus-article-emphasize
5683 @kindex W e (Summary)
5684 People commonly add emphasis to words in news articles by writing things
5685 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
5686 running the article through the @kbd{W e}
5687 (@code{gnus-article-emphasize}) command.
5688
5689 @vindex gnus-article-emphasis
5690 How the emphasis is computed is controlled by the
5691 @code{gnus-article-emphasis} variable.  This is an alist where the first
5692 element is a regular expression to be matched.  The second is a number
5693 that says what regular expression grouping used to find the entire
5694 emphasized word.  The third is a number that says what regexp grouping
5695 should be displayed and highlighted.  (The text between these two
5696 groupings will be hidden.)  The fourth is the face used for
5697 highlighting.
5698
5699 @lisp
5700 (setq gnus-article-emphasis
5701       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5702         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5703 @end lisp
5704
5705 @vindex gnus-emphasis-underline
5706 @vindex gnus-emphasis-bold
5707 @vindex gnus-emphasis-italic
5708 @vindex gnus-emphasis-underline-bold
5709 @vindex gnus-emphasis-underline-italic
5710 @vindex gnus-emphasis-bold-italic
5711 @vindex gnus-emphasis-underline-bold-italic
5712 By default, there are seven rules, and they use the following faces:
5713 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5714 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5715 @code{gnus-emphasis-underline-italic},
5716 @code{gnus-emphasis-undeline-bold}, and
5717 @code{gnus-emphasis-underline-bold-italic}.  
5718
5719 If you want to change these faces, you can either use @kbd{M-x
5720 customize}, or you can use @code{copy-face}.  For instance, if you want
5721 to make @code{gnus-emphasis-italic} use a red face instead, you could
5722 say something like:
5723
5724 @lisp
5725 (copy-face 'red 'gnus-emphasis-italic)
5726 @end lisp
5727
5728
5729 @node Article Hiding
5730 @subsection Article Hiding
5731 @cindex article hiding
5732
5733 Or rather, hiding certain things in each article.  There usually is much
5734 too much cruft in most articles.  
5735
5736 @table @kbd
5737
5738 @item W W a
5739 @kindex W W a (Summary)
5740 @findex gnus-article-hide
5741 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
5742
5743 @item W W h
5744 @kindex W W h (Summary)
5745 @findex gnus-article-hide-headers
5746 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5747 Headers}. 
5748
5749 @item W W b
5750 @kindex W W b (Summary)
5751 @findex gnus-article-hide-boring-headers
5752 Hide headers that aren't particularly interesting
5753 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5754
5755 @item W W s
5756 @kindex W W s (Summary)
5757 @findex gnus-article-hide-signature
5758 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
5759 Signature}. 
5760
5761 @item W W p
5762 @kindex W W p (Summary)
5763 @findex gnus-article-hide-pgp
5764 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). 
5765
5766 @item W W P
5767 @kindex W W P (Summary)
5768 @findex gnus-article-hide-pem
5769 Hide @sc{pem} (privacy enhanced messages) gruft
5770 (@code{gnus-article-hide-pem}).
5771
5772 @item W W c
5773 @kindex W W c (Summary)
5774 @findex gnus-article-hide-citation
5775 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5776 customizing the hiding:
5777
5778 @table @code
5779
5780 @item gnus-cite-hide-percentage
5781 @vindex gnus-cite-hide-percentage
5782 If the cited text is of a bigger percentage than this variable (default
5783 50), hide the cited text.
5784
5785 @item gnus-cite-hide-absolute
5786 @vindex gnus-cite-hide-absolute
5787 The cited text must be have at least this length (default 10) before it
5788 is hidden.
5789
5790 @item gnus-cited-text-button-line-format
5791 @vindex gnus-cited-text-button-line-format
5792 Gnus adds buttons show where the cited text has been hidden, and to
5793 allow toggle hiding the text.  The format of the variable is specified
5794 by this format-like variable (@pxref{Formatting Variables}).  These
5795 specs are legal:
5796
5797 @table @samp
5798 @item b
5799 Start point of the hidden text.
5800 @item e
5801 End point of the hidden text.
5802 @item l
5803 Length of the hidden text.
5804 @end table
5805
5806 @item gnus-cited-lines-visible
5807 @vindex gnus-cited-lines-visible
5808 The number of lines at the beginning of the cited text to leave shown. 
5809
5810 @end table
5811
5812 @item W W C
5813 @kindex W W C (Summary)
5814 @findex gnus-article-hide-citation-in-followups
5815 Hide cited text in articles that aren't roots
5816 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
5817 useful as an interactive command, but might be a handy function to stick
5818 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
5819
5820 @end table
5821
5822 All these ``hiding'' commands are toggles, but if you give a negative
5823 prefix to these commands, they will show what they have previously
5824 hidden.  If you give a positive prefix, they will always hide.
5825
5826 Also @pxref{Article Highlighting} for further variables for
5827 citation customization.
5828
5829
5830 @node Article Washing
5831 @subsection Article Washing
5832 @cindex washing
5833 @cindex article washing
5834
5835 We call this ``article washing'' for a really good reason.  Namely, the
5836 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5837
5838 @dfn{Washing} is defined by us as ``changing something from something to
5839 something else'', but normally results in something looking better.
5840 Cleaner, perhaps.
5841
5842 @table @kbd
5843
5844 @item W l
5845 @kindex W l (Summary)
5846 @findex gnus-summary-stop-page-breaking
5847 Remove page breaks from the current article
5848 (@code{gnus-summary-stop-page-breaking}).
5849
5850 @item W r
5851 @kindex W r (Summary)
5852 @findex gnus-summary-caesar-message
5853 Do a Caesar rotate (rot13) on the article buffer
5854 (@code{gnus-summary-caesar-message}). 
5855
5856 @item W t
5857 @kindex W t (Summary)
5858 @findex gnus-summary-toggle-header
5859 Toggle whether to display all headers in the article buffer
5860 (@code{gnus-summary-toggle-header}). 
5861
5862 @item W v
5863 @kindex W v (Summary)
5864 @findex gnus-summary-verbose-header
5865 Toggle whether to display all headers in the article buffer permanently
5866 (@code{gnus-summary-verbose-header}).
5867
5868 @item W m
5869 @kindex W m (Summary)
5870 @findex gnus-summary-toggle-mime
5871 Toggle whether to run the article through @sc{mime} before displaying
5872 (@code{gnus-summary-toggle-mime}).
5873
5874 @item W o
5875 @kindex W o (Summary)
5876 @findex gnus-article-treat-overstrike
5877 Treat overstrike (@code{gnus-article-treat-overstrike}).
5878
5879 @item W w
5880 @kindex W w (Summary)
5881 @findex gnus-article-fill-cited-article
5882 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
5883 function in @code{gnus-article-display-hook}, it should be run fairly
5884 late and certainly after any highlighting.
5885
5886 @item W c
5887 @kindex W c (Summary)
5888 @findex gnus-article-remove-cr
5889 Remove CR (@code{gnus-article-remove-cr}).
5890
5891 @item W q
5892 @kindex W q (Summary)
5893 @findex gnus-article-de-quoted-unreadable
5894 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5895
5896 @item W f
5897 @kindex W f (Summary)
5898 @cindex x-face
5899 @findex gnus-article-display-x-face
5900 @findex gnus-article-x-face-command
5901 @vindex gnus-article-x-face-command
5902 @vindex gnus-article-x-face-too-ugly
5903 Look for and display any X-Face headers
5904 (@code{gnus-article-display-x-face}).  The command executed by this
5905 function is given by the @code{gnus-article-x-face-command} variable.
5906 If this variable is a string, this string will be executed in a
5907 sub-shell.  If it is a function, this function will be called with the
5908 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
5909 is a regexp) matches the @code{From} header, the face will not be shown.
5910 The default action under Emacs is to fork off an @code{xv} to view the
5911 face; under XEmacs the default action is to display the face before the
5912 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
5913 support---that will make display somewhat faster.  If there's no native
5914 X-Face support, Gnus will try to convert the @code{X-Face} header using
5915 external programs from the @code{pbmplus} package and friends.)  If you
5916 want to have this function in the display hook, it should probably come
5917 last.
5918
5919 @item W b
5920 @kindex W b (Summary)
5921 @findex gnus-article-add-buttons
5922 Add clickable buttons to the article (@code{gnus-article-add-buttons}). 
5923
5924 @item W B
5925 @kindex W B (Summary)
5926 @findex gnus-article-add-buttons-to-head
5927 Add clickable buttons to the article headers
5928 (@code{gnus-article-add-buttons-to-head}).  
5929
5930 @item W E l
5931 @kindex W E l (Summary)
5932 @findex gnus-article-strip-leading-blank-lines
5933 Remove all blank lines from the beginning of the article
5934 (@code{gnus-article-strip-leading-blank-lines}).
5935
5936 @item W E m
5937 @kindex W E m (Summary)
5938 @findex gnus-article-strip-multiple-blank-lines
5939 Replace all blank lines with empty lines and then all multiple empty
5940 lines with a single empty line.
5941 (@code{gnus-article-strip-multiple-blank-lines}).
5942
5943 @item W E t
5944 @kindex W E t (Summary)
5945 @findex gnus-article-remove-trailing-blank-lines
5946 Remove all blank lines at the end of the article
5947 (@code{gnus-article-remove-trailing-blank-lines}).
5948
5949 @item W E a
5950 @kindex W E a (Summary)
5951 @findex gnus-article-strip-blank-lines
5952 Do all the three commands above
5953 (@code{gnus-article-strip-blank-lines}).
5954
5955 @end table
5956
5957
5958 @node Article Buttons
5959 @subsection Article Buttons
5960 @cindex buttons
5961
5962 People often include references to other stuff in articles, and it would
5963 be nice if Gnus could just fetch whatever it is that people talk about
5964 with the minimum of fuzz.
5965
5966 Gnus adds @dfn{buttons} to certain standard references by default:
5967 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
5968 two variables, one that handles article bodies and one that handles
5969 article heads:
5970
5971 @table @code
5972
5973 @item gnus-button-alist
5974 @vindex gnus-button-alist
5975 This is an alist where each entry has this form:
5976
5977 @lisp
5978 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
5979 @end lisp
5980
5981 @table @var
5982
5983 @item regexp
5984 All text that match this regular expression will be considered an
5985 external reference.  Here's a typical regexp that match embedded URLs:
5986 @samp{<URL:\\([^\n\r>]*\\)>}. 
5987
5988 @item button-par
5989 Gnus has to know which parts of the match is to be highlighted.  This is
5990 a number that says what sub-expression of the regexp that is to be
5991 highlighted.  If you want it all highlighted, you use 0 here.
5992
5993 @item use-p
5994 This form will be @code{eval}ed, and if the result is non-@code{nil},
5995 this is considered a match.  This is useful if you want extra sifting to
5996 avoid false matches.
5997
5998 @item function
5999 This function will be called when you click on this button.
6000
6001 @item data-par
6002 As with @var{button-par}, this is a sub-expression number, but this one
6003 says which part of the match is to be sent as data to @var{function}. 
6004
6005 @end table
6006
6007 So the full entry for buttonizing URLs is then
6008
6009 @lisp
6010 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6011 @end lisp
6012
6013 @item gnus-header-button-alist
6014 @vindex gnus-header-button-alist
6015 This is just like the other alist, except that it is applied to the
6016 article head only, and that each entry has an additional element that is
6017 used to say what headers to apply the buttonize coding to:
6018
6019 @lisp
6020 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6021 @end lisp
6022
6023 @var{header} is a regular expression.
6024
6025 @item gnus-button-url-regexp
6026 @vindex gnus-button-url-regexp
6027 A regular expression that matches embedded URLs.  It is used in the
6028 default values of the variables above.
6029
6030 @item gnus-article-button-face
6031 @vindex gnus-article-button-face
6032 Face used on buttons.
6033
6034 @item gnus-article-mouse-face
6035 @vindex gnus-article-mouse-face
6036 Face is used when the mouse cursor is over a button.
6037
6038 @end table
6039
6040
6041 @node Article Date
6042 @subsection Article Date
6043
6044 The date is most likely generated in some obscure timezone you've never
6045 heard of, so it's quite nice to be able to find out what the time was
6046 when the article was sent.
6047
6048 @table @kbd
6049
6050 @item W T u
6051 @kindex W T u (Summary)
6052 @findex gnus-article-date-ut
6053 Display the date in UT (aka. GMT, aka ZULU)
6054 (@code{gnus-article-date-ut}). 
6055
6056 @item W T l
6057 @kindex W T l (Summary)
6058 @findex gnus-article-date-local
6059 Display the date in the local timezone (@code{gnus-article-date-local}).
6060
6061 @item W T e
6062 @kindex W T e (Summary)
6063 @findex gnus-article-date-lapsed
6064 Say how much time has (e)lapsed between the article was posted and now
6065 (@code{gnus-article-date-lapsed}).
6066
6067 @item W T o
6068 @kindex W T o (Summary)
6069 @findex gnus-article-date-original
6070 Display the original date (@code{gnus-article-date-original}).  This can
6071 be useful if you normally use some other conversion function and is
6072 worried that it might be doing something totally wrong.  Say, claiming
6073 that the article was posted in 1854.  Although something like that is
6074 @emph{totally} impossible.  Don't you trust me? *titter*
6075
6076 @end table
6077
6078
6079 @node Article Signature
6080 @subsection Article Signature
6081 @cindex signatures
6082 @cindex article signature
6083
6084 @vindex gnus-signature-separator
6085 Each article is divided into two parts---the head and the body.  The
6086 body can be divided into a signature part and a text part.  The variable
6087 that says what is to be considered a signature is
6088 @code{gnus-signature-separator}.  This is normally the standard
6089 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6090 non-standard signature separators, so this variable can also be a list
6091 of regular expressions to be tested, one by one.  (Searches are done
6092 from the end of the body towards the beginning.)  One likely value is:
6093
6094 @lisp
6095 (setq gnus-signature-separator
6096       '("^-- $"         ; The standard
6097         "^-- *$"        ; A common mangling
6098         "^-------*$"    ; Many people just use a looong 
6099                         ; line of dashes.  Shame!
6100         "^ *--------*$" ; Double-shame!
6101         "^________*$"   ; Underscores are also popular
6102         "^========*$")) ; Pervert!
6103 @end lisp
6104
6105 The more permissive you are, the more likely it is that you'll get false
6106 positives.
6107
6108 @vindex gnus-signature-limit
6109 @code{gnus-signature-limit} provides a limit to what is considered a
6110 signature. 
6111
6112 @enumerate
6113 @item 
6114 If it is an integer, no signature may be longer (in characters) than
6115 that integer.
6116 @item 
6117 If it is a floating point number, no signature may be longer (in lines)
6118 than that number.
6119 @item 
6120 If it is a function, the function will be called without any parameters,
6121 and if it returns @code{nil}, there is no signature in the buffer.
6122 @item
6123 If it is a string, it will be used as a regexp.  If it matches, the text
6124 in question is not a signature.
6125 @end enumerate
6126
6127 This variable can also be a list where the elements may be of the types
6128 listed above.  
6129
6130
6131 @node Article Commands
6132 @section Article Commands
6133
6134 @table @kbd
6135
6136 @item A P
6137 @cindex PostScript
6138 @cindex printing
6139 @kindex A P (Summary)
6140 @findex gnus-summary-print-article 
6141 Generate and print a PostScript image of the article buffer
6142 (@code{gnus-summary-print-article}).
6143
6144 @end table
6145
6146
6147 @node Summary Sorting
6148 @section Summary Sorting
6149 @cindex summary sorting
6150
6151 You can have the summary buffer sorted in various ways, even though I
6152 can't really see why you'd want that.
6153
6154 @table @kbd
6155
6156 @item C-c C-s C-n
6157 @kindex C-c C-s C-n (Summary)
6158 @findex gnus-summary-sort-by-number
6159 Sort by article number (@code{gnus-summary-sort-by-number}).
6160
6161 @item C-c C-s C-a
6162 @kindex C-c C-s C-a (Summary)
6163 @findex gnus-summary-sort-by-author
6164 Sort by author (@code{gnus-summary-sort-by-author}).
6165
6166 @item C-c C-s C-s
6167 @kindex C-c C-s C-s (Summary)
6168 @findex gnus-summary-sort-by-subject
6169 Sort by subject (@code{gnus-summary-sort-by-subject}).
6170
6171 @item C-c C-s C-d
6172 @kindex C-c C-s C-d (Summary)
6173 @findex gnus-summary-sort-by-date
6174 Sort by date (@code{gnus-summary-sort-by-date}).
6175
6176 @item C-c C-s C-l
6177 @kindex C-c C-s C-l (Summary)
6178 @findex gnus-summary-sort-by-lines
6179 Sort by lines (@code{gnus-summary-sort-by-lines}).
6180
6181 @item C-c C-s C-i
6182 @kindex C-c C-s C-i (Summary)
6183 @findex gnus-summary-sort-by-score
6184 Sort by score (@code{gnus-summary-sort-by-score}).
6185 @end table
6186
6187 These functions will work both when you use threading and when you don't
6188 use threading.  In the latter case, all summary lines will be sorted,
6189 line by line.  In the former case, sorting will be done on a
6190 root-by-root basis, which might not be what you were looking for.  To
6191 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6192 Commands}).
6193
6194
6195 @node Finding the Parent
6196 @section Finding the Parent
6197 @cindex parent articles
6198 @cindex referring articles
6199
6200 @findex gnus-summary-refer-parent-article
6201 @kindex ^ (Summary)
6202 If you'd like to read the parent of the current article, and it is not
6203 displayed in the summary buffer, you might still be able to.  That is,
6204 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6205 and the @code{References} in the current article are not mangled, you
6206 can just press @kbd{^} or @kbd{A r}
6207 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6208 you'll get the parent.  If the parent is already displayed in the
6209 summary buffer, point will just move to this article.
6210
6211 If given a positive numerical prefix, fetch that many articles back into
6212 the ancestry.  If given a negative numerical prefix, fetch just that
6213 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6214 grandparent and the grandgrandparent of the current article.  If you say
6215 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6216 article. 
6217
6218 @findex gnus-summary-refer-references
6219 @kindex A R (Summary)
6220 You can have Gnus fetch all articles mentioned in the @code{References}
6221 header of the article by pushing @kbd{A R}
6222 (@code{gnus-summary-refer-references}). 
6223
6224 @findex gnus-summary-refer-article
6225 @kindex M-^ (Summary)
6226 @cindex Message-ID
6227 @cindex fetching by Message-ID
6228 You can also ask the @sc{nntp} server for an arbitrary article, no
6229 matter what group it belongs to.  @kbd{M-^}
6230 (@code{gnus-summary-refer-article}) will ask you for a
6231 @code{Message-ID}, which is one of those long, hard-to-read thingies
6232 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6233 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6234
6235 @vindex gnus-refer-article-method
6236 If the group you are reading is located on a backend that does not
6237 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6238 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6239 would, perhaps, be best if the @sc{nntp} server you consult is the same
6240 as the one that keeps the spool you are reading from updated, but that's
6241 not really necessary.
6242
6243 Most of the mail backends support fetching by @code{Message-ID}, but do
6244 not do a particularly excellent job of it.  That is, @code{nnmbox} and
6245 @code{nnbabyl} are able to locate articles from any groups, while
6246 @code{nnml} and @code{nnfolder} are only able to locate articles that
6247 have been posted to the current group.  (Anything else would be too time
6248 consuming.)  @code{nnmh} does not support this at all.
6249
6250
6251 @node Alternative Approaches
6252 @section Alternative Approaches
6253
6254 Different people like to read news using different methods.  This being
6255 Gnus, we offer a small selection of minor modes for the summary buffers.
6256
6257 @menu
6258 * Pick and Read::               First mark articles and then read them.
6259 * Binary Groups::               Auto-decode all articles.
6260 @end menu
6261
6262
6263 @node Pick and Read
6264 @subsection Pick and Read
6265 @cindex pick and read
6266
6267 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
6268 reading interface.  The user first marks the articles she wants to read
6269 from a summary buffer.  Then she starts reading the articles with just
6270 an article buffer displayed.
6271
6272 @findex gnus-pick-mode
6273 @kindex M-x gnus-pick-mode
6274 Gnus provides a summary buffer minor mode that allows
6275 this---@code{gnus-pick-mode}.  This basically means that a few process
6276 mark commands become one-keystroke commands to allow easy marking, and
6277 it makes one additional command for switching to the summary buffer
6278 available. 
6279
6280 Here are the available keystrokes when using pick mode:
6281
6282 @table @kbd
6283 @item .
6284 @kindex . (Pick)
6285 @findex gnus-summary-mark-as-processable
6286 Pick the article on the current line
6287 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6288 go to the article on that line and pick that article.  (The line number
6289 is normally displayed on the beginning of the summary pick lines.)
6290
6291 @item SPACE
6292 @kindex SPACE (Pick)
6293 @findex gnus-pick-next-page
6294 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6295 at the end of the buffer, start reading the picked articles.
6296
6297 @item u
6298 @kindex u (Pick)
6299 @findex gnus-summary-unmark-as-processable
6300 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6301
6302 @item U
6303 @kindex U (Pick)
6304 @findex gnus-summary-unmark-all-processable
6305 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6306
6307 @item t
6308 @kindex t (Pick)
6309 @findex gnus-uu-mark-thread
6310 Pick the thread (@code{gnus-uu-mark-thread}). 
6311
6312 @item T
6313 @kindex T (Pick)
6314 @findex gnus-uu-unmark-thread
6315 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6316
6317 @item r
6318 @kindex r (Pick)
6319 @findex gnus-uu-mark-region
6320 Pick the region (@code{gnus-uu-mark-region}). 
6321
6322 @item R
6323 @kindex R (Pick)
6324 @findex gnus-uu-unmark-region
6325 Unpick the region (@code{gnus-uu-unmark-region}). 
6326
6327 @item e
6328 @kindex e (Pick)
6329 @findex gnus-uu-mark-by-regexp
6330 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6331
6332 @item E
6333 @kindex E (Pick)
6334 @findex gnus-uu-unmark-by-regexp
6335 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6336
6337 @item b
6338 @kindex b (Pick)
6339 @findex gnus-uu-mark-buffer
6340 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6341
6342 @item B
6343 @kindex B (Pick)
6344 @findex gnus-uu-unmark-buffer
6345 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6346
6347 @item RET
6348 @kindex RET (Pick)
6349 @findex gnus-pick-start-reading
6350 @vindex gnus-pick-display-summary
6351 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6352 given a prefix, mark all unpicked articles as read first.  If
6353 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6354 will still be visible when you are reading.
6355
6356 @end table
6357
6358 If this sounds like a good idea to you, you could say:
6359
6360 @lisp
6361 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6362 @end lisp
6363
6364 @vindex gnus-pick-mode-hook
6365 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6366
6367 @vindex gnus-mark-unpicked-articles-as-read
6368 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6369 all unpicked articles as read.  The default is @code{nil}.
6370
6371 @vindex gnus-summary-pick-line-format
6372 The summary line format in pick mode is slightly different than the
6373 standard format.  At the beginning of each line the line number is
6374 displayed.  The pick mode line format is controlled by the
6375 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6376 Variables}).  It accepts the same format specs that
6377 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6378
6379
6380 @node Binary Groups
6381 @subsection Binary Groups
6382 @cindex binary groups
6383
6384 @findex gnus-binary-mode
6385 @kindex M-x gnus-binary-mode
6386 If you spend much time in binary groups, you may grow tired of hitting
6387 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6388 is a minor mode for summary buffers that makes all ordinary Gnus article
6389 selection functions uudecode series of articles and display the result
6390 instead of just displaying the articles the normal way.  
6391
6392 @kindex g (Binary)
6393 @findex gnus-binary-show-article
6394 In fact, the only way to see the actual articles if you have turned this
6395 mode on is the @kbd{g} command (@code{gnus-binary-show-article}). 
6396
6397 @vindex gnus-binary-mode-hook
6398 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6399
6400
6401 @node Tree Display
6402 @section Tree Display
6403 @cindex trees
6404
6405 @vindex gnus-use-trees
6406 If you don't like the normal Gnus summary display, you might try setting
6407 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6408 additional @dfn{tree buffer}.  You can execute all summary mode commands
6409 in the tree buffer.  
6410
6411 There are a few variables to customize the tree display, of course:
6412
6413 @table @code
6414 @item gnus-tree-mode-hook
6415 @vindex gnus-tree-mode-hook
6416 A hook called in all tree mode buffers.
6417
6418 @item gnus-tree-mode-line-format
6419 @vindex gnus-tree-mode-line-format
6420 A format string for the mode bar in the tree mode buffers.  The default
6421 is @samp{Gnus: %%b [%A] %Z}.  For a list of legal specs, @pxref{Summary
6422 Buffer Mode Line}. 
6423
6424 @item gnus-selected-tree-face
6425 @vindex gnus-selected-tree-face
6426 Face used for highlighting the selected article in the tree buffer.  The
6427 default is @code{modeline}.
6428
6429 @item gnus-tree-line-format
6430 @vindex gnus-tree-line-format
6431 A format string for the tree nodes.  The name is a bit of a misnomer,
6432 though---it doesn't define a line, but just the node.  The default value
6433 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6434 the name of the poster.  It is vital that all nodes are of the same
6435 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6436
6437 Legal specs are:
6438
6439 @table @samp
6440 @item n
6441 The name of the poster.
6442 @item f
6443 The @code{From} header.
6444 @item N
6445 The number of the article.
6446 @item [
6447 The opening bracket.
6448 @item ] 
6449 The closing bracket.
6450 @item s
6451 The subject.
6452 @end table
6453
6454 @xref{Formatting Variables}.
6455
6456 Variables related to the display are:
6457
6458 @table @code
6459 @item gnus-tree-brackets
6460 @vindex gnus-tree-brackets
6461 This is used for differentiating between ``real'' articles and
6462 ``sparse'' articles.  The format is @var{((real-open . real-close)
6463 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6464 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6465
6466 @item gnus-tree-parent-child-edges
6467 @vindex gnus-tree-parent-child-edges
6468 This is a list that contains the characters used for connecting parent
6469 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
6470
6471 @end table
6472
6473 @item gnus-tree-minimize-window
6474 @vindex gnus-tree-minimize-window
6475 If this variable is non-@code{nil}, Gnus will try to keep the tree
6476 buffer as small as possible to allow more room for the other Gnus
6477 windows.  If this variable is a number, the tree buffer will never be
6478 higher than that number.  The default is @code{t}.
6479
6480 @item gnus-generate-tree-function
6481 @vindex gnus-generate-tree-function
6482 @findex gnus-generate-horizontal-tree
6483 @findex gnus-generate-vertical-tree
6484 The function that actually generates the thread tree.  Two predefined
6485 functions are available: @code{gnus-generate-horizontal-tree} and
6486 @code{gnus-generate-vertical-tree} (which is the default).
6487
6488 @end table
6489
6490 Here's and example from a horizontal tree buffer:
6491
6492 @example
6493 @{***@}-(***)-[odd]-[Gun]
6494      |      \[Jan]
6495      |      \[odd]-[Eri]
6496      |      \(***)-[Eri]
6497      |            \[odd]-[Paa]
6498      \[Bjo]
6499      \[Gun]
6500      \[Gun]-[Jor]
6501 @end example
6502
6503 Here's the same thread displayed in a vertical tree buffer:
6504
6505 @example
6506 @{***@}
6507   |--------------------------\-----\-----\
6508 (***)                         [Bjo] [Gun] [Gun]
6509   |--\-----\-----\                          |
6510 [odd] [Jan] [odd] (***)                   [Jor]
6511   |           |     |--\
6512 [Gun]       [Eri] [Eri] [odd]
6513                           |
6514                         [Paa]
6515 @end example
6516
6517
6518 @node Mail Group Commands
6519 @section Mail Group Commands
6520 @cindex mail group commands
6521
6522 Some commands only make sense in mail groups.  If these commands are
6523 illegal in the current group, they will raise a hell and let you know.
6524
6525 All these commands (except the expiry and edit commands) use the
6526 process/prefix convention (@pxref{Process/Prefix}).
6527
6528 @table @kbd
6529
6530 @item B e
6531 @kindex B e (Summary)
6532 @findex gnus-summary-expire-articles
6533 Expire all expirable articles in the group
6534 (@code{gnus-summary-expire-articles}).
6535
6536 @item B M-C-e
6537 @kindex B M-C-e (Summary)
6538 @findex gnus-summary-expire-articles-now
6539 Delete all the expirable articles in the group
6540 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
6541 articles that are eligible for expiry in the current group will
6542 disappear forever into that big @file{/dev/null} in the sky.
6543
6544 @item B DEL
6545 @kindex B DEL (Summary)
6546 @findex gnus-summary-delete-article
6547 Delete the mail article.  This is ``delete'' as in ``delete it from your
6548 disk forever and ever, never to return again.'' Use with caution.
6549 (@code{gnus-summary-delete-article}).
6550
6551 @item B m
6552 @kindex B m (Summary)
6553 @cindex move mail
6554 @findex gnus-summary-move-article
6555 Move the article from one mail group to another
6556 (@code{gnus-summary-move-article}). 
6557
6558 @item B c
6559 @kindex B c (Summary)
6560 @cindex copy mail
6561 @findex gnus-summary-copy-article
6562 Copy the article from one group (mail group or not) to a mail group
6563 (@code{gnus-summary-copy-article}).
6564
6565 @item B C
6566 @kindex B C (Summary)
6567 @cindex crosspost mail
6568 @findex gnus-summary-crosspost-article
6569 Crosspost the current article to some other group
6570 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
6571 the article in the other group, and the Xref headers of the article will
6572 be properly updated.
6573
6574 @item B i
6575 @kindex B i (Summary)
6576 @findex gnus-summary-import-article
6577 Import an arbitrary file into the current mail newsgroup
6578 (@code{gnus-summary-import-article}).  You will be prompted for a file
6579 name, a @code{From} header and a @code{Subject} header.
6580
6581 @item B r
6582 @kindex B r (Summary)
6583 @findex gnus-summary-respool-article
6584 Respool the mail article (@code{gnus-summary-move-article}).
6585
6586 @item B w
6587 @itemx e
6588 @kindex B w (Summary)
6589 @kindex e (Summary)
6590 @findex gnus-summary-edit-article
6591 @kindex C-c C-c (Article)
6592 Edit the current article (@code{gnus-summary-edit-article}).  To finish
6593 editing and make the changes permanent, type @kbd{C-c C-c}
6594 (@kbd{gnus-summary-edit-article-done}).
6595
6596 @item B q
6597 @kindex B q (Summary)
6598 @findex gnus-summary-respool-query
6599 If you want to re-spool an article, you might be curious as to what group
6600 the article will end up in before you do the re-spooling.  This command
6601 will tell you (@code{gnus-summary-respool-query}). 
6602
6603 @item B p
6604 @kindex B p (Summary)
6605 @findex gnus-summary-article-posted-p
6606 Some people have a tendency to send you "courtesy" copies when they
6607 follow up to articles you have posted.  These usually have a
6608 @code{Newsgroups} header in them, but not always.  This command
6609 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6610 article from your news server (or rather, from
6611 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6612 report back whether it found the article or not.  Even if it says that
6613 it didn't find the article, it may have been posted anyway---mail
6614 propagation is much faster than news propagation, and the news copy may
6615 just not have arrived yet.
6616
6617 @end table
6618
6619 @vindex gnus-move-split-methods
6620 @cindex moving articles
6621 If you move (or copy) articles regularly, you might wish to have Gnus
6622 suggest where to put the articles.  @code{gnus-move-split-methods} is a
6623 variable that uses the same syntax as @code{gnus-split-methods}
6624 (@pxref{Saving Articles}).  You may customize that variable to create
6625 suggestions you find reasonable.
6626
6627
6628 @node Various Summary Stuff
6629 @section Various Summary Stuff
6630
6631 @menu
6632 * Summary Group Information::         Information oriented commands.
6633 * Searching for Articles::            Multiple article commands.
6634 * Summary Generation Commands::       (Re)generating the summary buffer.
6635 * Really Various Summary Commands::   Those pesky non-conformant commands.
6636 @end menu
6637
6638 @table @code
6639 @vindex gnus-summary-mode-hook
6640 @item gnus-summary-mode-hook
6641 This hook is called when creating a summary mode buffer.
6642
6643 @vindex gnus-summary-generate-hook
6644 @item gnus-summary-generate-hook
6645 This is called as the last thing before doing the threading and the
6646 generation of the summary buffer.  It's quite convenient for customizing
6647 the threading variables based on what data the newsgroup has.  This hook
6648 is called from the summary buffer after most summary buffer variables
6649 has been set.
6650
6651 @vindex gnus-summary-prepare-hook
6652 @item gnus-summary-prepare-hook
6653 Is is called after the summary buffer has been generated.  You might use
6654 it to, for instance, highlight lines or modify the look of the buffer in
6655 some other ungodly manner.  I don't care.
6656
6657 @end table
6658
6659
6660 @node Summary Group Information
6661 @subsection Summary Group Information
6662
6663 @table @kbd
6664
6665 @item H f
6666 @kindex H f (Summary)
6667 @findex gnus-summary-fetch-faq
6668 @vindex gnus-group-faq-directory
6669 Try to fetch the FAQ (list of frequently asked questions) for the
6670 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
6671 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6672 on a remote machine.  This variable can also be a list of directories.
6673 In that case, giving a prefix to this command will allow you to choose
6674 between the various sites.  @code{ange-ftp} probably will be used for
6675 fetching the file.
6676
6677 @item H d
6678 @kindex H d (Summary)
6679 @findex gnus-summary-describe-group
6680 Give a brief description of the current group
6681 (@code{gnus-summary-describe-group}).  If given a prefix, force
6682 rereading the description from the server.
6683
6684 @item H h
6685 @kindex H h (Summary)
6686 @findex gnus-summary-describe-briefly
6687 Give an extremely brief description of the most important summary
6688 keystrokes (@code{gnus-summary-describe-briefly}).
6689
6690 @item H i
6691 @kindex H i (Summary)
6692 @findex gnus-info-find-node
6693 Go to the Gnus info node (@code{gnus-info-find-node}).
6694 @end table
6695
6696
6697 @node Searching for Articles
6698 @subsection Searching for Articles
6699
6700 @table @kbd
6701
6702 @item M-s
6703 @kindex M-s (Summary)
6704 @findex gnus-summary-search-article-forward
6705 Search through all subsequent articles for a regexp
6706 (@code{gnus-summary-search-article-forward}). 
6707
6708 @item M-r
6709 @kindex M-r (Summary)
6710 @findex gnus-summary-search-article-backward
6711 Search through all previous articles for a regexp
6712 (@code{gnus-summary-search-article-backward}). 
6713
6714 @item &
6715 @kindex & (Summary)
6716 @findex gnus-summary-execute-command
6717 This command will prompt you for a header field, a regular expression to
6718 match on this field, and a command to be executed if the match is made
6719 (@code{gnus-summary-execute-command}).
6720
6721 @item M-&
6722 @kindex M-& (Summary)
6723 @findex gnus-summary-universal-argument
6724 Perform any operation on all articles that have been marked with
6725 the process mark (@code{gnus-summary-universal-argument}).
6726 @end table
6727
6728 @node Summary Generation Commands
6729 @subsection Summary Generation Commands
6730
6731 @table @kbd
6732
6733 @item Y g
6734 @kindex Y g (Summary)
6735 @findex gnus-summary-prepare
6736 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6737
6738 @item Y c 
6739 @kindex Y c (Summary)
6740 @findex gnus-summary-insert-cached-articles
6741 Pull all cached articles (for the current group) into the summary buffer
6742 (@code{gnus-summary-insert-cached-articles}).
6743
6744 @end table
6745
6746
6747 @node Really Various Summary Commands
6748 @subsection Really Various Summary Commands
6749
6750 @table @kbd
6751
6752 @item C-d
6753 @kindex C-d (Summary)
6754 @findex gnus-summary-enter-digest-group
6755 If the current article is a collection of other articles (for instance,
6756 a digest), you might use this command to enter a group based on the that
6757 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
6758 guess what article type is currently displayed unless you give a prefix
6759 to this command, which forces a ``digest'' interpretation.  Basically,
6760 whenever you see a message that is a collection of other messages on
6761 some format, you @kbd{C-d} and read these messages in a more convenient
6762 fashion.
6763
6764 @item M-C-d
6765 @kindex M-C-d (Summary)
6766 @findex gnus-summary-read-document
6767 This command is very similar to the one above, but lets you gather
6768 several documents into one biiig group
6769 (@code{gnus-summary-read-document}).  It does this by opening several
6770 @code{nndoc} groups for each document, and then opening an
6771 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
6772 command understands the process/prefix convention
6773 (@pxref{Process/Prefix}). 
6774
6775 @item C-t
6776 @kindex C-t (Summary)
6777 @findex gnus-summary-toggle-truncation
6778 Toggle truncation of summary lines
6779 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
6780 line centering function in the summary buffer, so it's not a good idea
6781 to have truncation switched off while reading articles.
6782
6783 @item =
6784 @kindex = (Summary)
6785 @findex gnus-summary-expand-window
6786 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6787 If given a prefix, force an @code{article} window configuration. 
6788
6789 @end table
6790
6791
6792 @node Exiting the Summary Buffer
6793 @section Exiting the Summary Buffer
6794 @cindex summary exit
6795 @cindex exiting groups
6796
6797 Exiting from the summary buffer will normally update all info on the
6798 group and return you to the group buffer. 
6799
6800 @table @kbd
6801
6802 @item Z Z
6803 @itemx q
6804 @kindex Z Z (Summary)
6805 @kindex q (Summary)
6806 @findex gnus-summary-exit
6807 @vindex gnus-summary-exit-hook
6808 @vindex gnus-summary-prepare-exit-hook
6809 Exit the current group and update all information on the group
6810 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6811 called before doing much of the exiting, and calls
6812 @code{gnus-summary-expire-articles} by default.
6813 @code{gnus-summary-exit-hook} is called after finishing the exiting
6814 process. 
6815
6816 @item Z E
6817 @itemx Q
6818 @kindex Z E (Summary)
6819 @kindex Q (Summary)
6820 @findex gnus-summary-exit-no-update
6821 Exit the current group without updating any information on the group
6822 (@code{gnus-summary-exit-no-update}).
6823
6824 @item Z c
6825 @itemx c
6826 @kindex Z c (Summary)
6827 @kindex c (Summary)
6828 @findex gnus-summary-catchup-and-exit
6829 Mark all unticked articles in the group as read and then exit
6830 (@code{gnus-summary-catchup-and-exit}).
6831
6832 @item Z C
6833 @kindex Z C (Summary)
6834 @findex gnus-summary-catchup-all-and-exit
6835 Mark all articles, even the ticked ones, as read and then exit
6836 (@code{gnus-summary-catchup-all-and-exit}).
6837
6838 @item Z n
6839 @kindex Z n (Summary)
6840 @findex gnus-summary-catchup-and-goto-next-group
6841 Mark all articles as read and go to the next group
6842 (@code{gnus-summary-catchup-and-goto-next-group}). 
6843
6844 @item Z R
6845 @kindex Z R (Summary)
6846 @findex gnus-summary-reselect-current-group
6847 Exit this group, and then enter it again
6848 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
6849 all articles, both read and unread.
6850
6851 @item Z G
6852 @itemx M-g
6853 @kindex Z G (Summary)
6854 @kindex M-g (Summary)
6855 @findex gnus-summary-rescan-group
6856 Exit the group, check for new articles in the group, and select the
6857 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
6858 articles, both read and unread.
6859
6860 @item Z N
6861 @kindex Z N (Summary)
6862 @findex gnus-summary-next-group
6863 Exit the group and go to the next group
6864 (@code{gnus-summary-next-group}). 
6865
6866 @item Z P
6867 @kindex Z P (Summary)
6868 @findex gnus-summary-prev-group
6869 Exit the group and go to the previous group
6870 (@code{gnus-summary-prev-group}). 
6871 @end table
6872
6873 @vindex gnus-exit-group-hook
6874 @code{gnus-exit-group-hook} is called when you exit the current
6875 group.  
6876
6877 @findex gnus-summary-wake-up-the-dead
6878 @findex gnus-dead-summary-mode
6879 @vindex gnus-kill-summary-on-exit
6880 If you're in the habit of exiting groups, and then changing your mind
6881 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
6882 If you do that, Gnus won't kill the summary buffer when you exit it.
6883 (Quelle surprise!)  Instead it will change the name of the buffer to
6884 something like @samp{*Dead Summary ... *} and install a minor mode
6885 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
6886 buffer, you'll find that all keys are mapped to a function called
6887 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
6888 summary buffer will result in a live, normal summary buffer.  
6889
6890 There will never be more than one dead summary buffer at any one time. 
6891
6892 @vindex gnus-use-cross-reference
6893 The data on the current group will be updated (which articles you have
6894 read, which articles you have replied to, etc.) when you exit the
6895 summary buffer.  If the @code{gnus-use-cross-reference} variable is
6896 @code{t} (which is the default), articles that are cross-referenced to
6897 this group and are marked as read, will also be marked as read in the
6898 other subscribed groups they were cross-posted to.  If this variable is
6899 neither @code{nil} nor @code{t}, the article will be marked as read in
6900 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
6901
6902
6903 @node Crosspost Handling
6904 @section Crosspost Handling
6905
6906 @cindex velveeta
6907 @cindex spamming
6908 Marking cross-posted articles as read ensures that you'll never have to
6909 read the same article more than once.  Unless, of course, somebody has
6910 posted it to several groups separately.  Posting the same article to
6911 several groups (not cross-posting) is called @dfn{spamming}, and you are
6912 by law required to send nasty-grams to anyone who perpetrates such a
6913 heinous crime.  You may want to try NoCeM handling to filter out spam
6914 (@pxref{NoCeM}). 
6915
6916 Remember: Cross-posting is kinda ok, but posting the same article
6917 separately to several groups is not.  Massive cross-posting (aka.
6918 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
6919 @code{gnus-summary-mail-crosspost-complaint} command to complain about
6920 excessive crossposting (@pxref{Summary Mail Commands}).
6921
6922 @cindex cross-posting
6923 @cindex Xref
6924 @cindex @sc{nov}
6925 One thing that may cause Gnus to not do the cross-posting thing
6926 correctly is if you use an @sc{nntp} server that supports @sc{xover}
6927 (which is very nice, because it speeds things up considerably) which
6928 does not include the @code{Xref} header in its @sc{nov} lines.  This is
6929 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
6930 even with @sc{xover} by registering the @code{Xref} lines of all
6931 articles you actually read, but if you kill the articles, or just mark
6932 them as read without reading them, Gnus will not get a chance to snoop
6933 the @code{Xref} lines out of these articles, and will be unable to use
6934 the cross reference mechanism.
6935
6936 @cindex LIST overview.fmt
6937 @cindex overview.fmt
6938 To check whether your @sc{nntp} server includes the @code{Xref} header
6939 in its overview files, try @samp{telnet your.nntp.server nntp},
6940 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
6941 overview.fmt}.  This may not work, but if it does, and the last line you
6942 get does not read @samp{Xref:full}, then you should shout and whine at
6943 your news admin until she includes the @code{Xref} header in the
6944 overview files.
6945
6946 @vindex gnus-nov-is-evil
6947 If you want Gnus to get the @code{Xref}s right all the time, you have to
6948 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
6949 considerably.
6950
6951 C'est la vie.
6952
6953 For an alternative approach, @pxref{Duplicate Suppression}.
6954
6955
6956 @node Duplicate Suppression
6957 @section Duplicate Suppression
6958
6959 By default, Gnus tries to make sure that you don't have to read the same
6960 article more than once by utilizing the crossposting mechanism
6961 (@pxref{Crosspost Handling}).  However, that simple and efficient
6962 approach may not work satisfactorily for some users for various
6963 reasons.  
6964
6965 @enumerate
6966 @item 
6967 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
6968 is evil and not very common.
6969
6970 @item 
6971 The @sc{nntp} server may fail to include the @code{Xref} header in the
6972 @file{.overview} data bases.  This is evil and all too common, alas.
6973
6974 @item
6975 You may be reading the same group (or several related groups) from
6976 different @sc{nntp} servers.
6977
6978 @item
6979 You may be getting mail that duplicates articles posted to groups.
6980 @end enumerate
6981
6982 I'm sure there are other situations that @code{Xref} handling fails as
6983 well, but these four are the most common situations.
6984
6985 If, and only if, @code{Xref} handling fails for you, then you may
6986 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
6987 will remember the @code{Message-ID}s of all articles you have read or
6988 otherwise marked as read, and then, as if by magic, mark them as read
6989 all subsequent times you see them---in @emph{all} groups.  Using this
6990 mechanism is quite likely to be somewhat inefficient, but not overly
6991 so.  It's certainly preferable to reading the same articles more than
6992 once.
6993
6994 Duplicate suppression is not a very subtle instrument.  It's more like a
6995 sledge hammer than anything else.  It works in a very simple
6996 fashion---if you have marked an article as read, it adds this Message-ID
6997 to a cache.  The next time it sees this Message-ID, it will mark the
6998 article as read the the @samp{M} mark.  It doesn't care what group it
6999 saw the article in.
7000
7001 @table @code
7002 @item gnus-suppress-duplicates
7003 @vindex gnus-suppress-duplicates
7004 If non-@code{nil}, suppress duplicates.
7005
7006 @item gnus-save-duplicate-list
7007 @vindex gnus-save-duplicate-list
7008 If non-@code{nil}, save the list of duplicates to a file.  This will
7009 make startup and shutdown take longer, so the default is @code{nil}.
7010 However, this means that only duplicate articles that is read in a
7011 single Gnus session are suppressed.  
7012
7013 @item gnus-duplicate-list-length
7014 @vindex gnus-duplicate-list-length
7015 This variables says how many @code{Message-ID}s to keep in the duplicate
7016 suppression list.  The default is 10000.  
7017
7018 @item gnus-duplicate-file
7019 @vindex gnus-duplicate-file
7020 The name of the file to store the duplicate suppression list.  The
7021 default is @file{~/News/suppression}.
7022 @end table
7023
7024 If you have a tendency to stop and start Gnus often, setting
7025 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7026 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7027 the other hand, saving the list makes startup and shutdown much slower,
7028 so that means that if you stop and start Gnus often, you should set
7029 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7030 to you to figure out, I think.
7031
7032
7033 @node The Article Buffer
7034 @chapter The Article Buffer
7035 @cindex article buffer
7036
7037 The articles are displayed in the article buffer, of which there is only
7038 one.  All the summary buffers share the same article buffer unless you
7039 tell Gnus otherwise.
7040
7041 @menu
7042 * Hiding Headers::        Deciding what headers should be displayed.
7043 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7044 * Customizing Articles::  Tailoring the look of the articles.
7045 * Article Keymap::        Keystrokes available in the article buffer.
7046 * Misc Article::          Other stuff.
7047 @end menu
7048
7049
7050 @node Hiding Headers
7051 @section Hiding Headers
7052 @cindex hiding headers
7053 @cindex deleting headers
7054
7055 The top section of each article is the @dfn{head}.  (The rest is the
7056 @dfn{body}, but you may have guessed that already.)
7057
7058 @vindex gnus-show-all-headers
7059 There is a lot of useful information in the head: the name of the person
7060 who wrote the article, the date it was written and the subject of the
7061 article.  That's well and nice, but there's also lots of information
7062 most people do not want to see---what systems the article has passed
7063 through before reaching you, the @code{Message-ID}, the
7064 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7065 of some of those lines.  If you want to keep all those lines in the
7066 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7067
7068 Gnus provides you with two variables for sifting headers:
7069
7070 @table @code
7071
7072 @item gnus-visible-headers
7073 @vindex gnus-visible-headers
7074 If this variable is non-@code{nil}, it should be a regular expression
7075 that says what headers you wish to keep in the article buffer.  All
7076 headers that do not match this variable will be hidden.
7077
7078 For instance, if you only want to see the name of the person who wrote
7079 the article and the subject, you'd say:
7080
7081 @lisp
7082 (setq gnus-visible-headers "^From:\\|^Subject:")
7083 @end lisp
7084
7085 This variable can also be a list of regexps to match headers that are to
7086 remain visible.
7087
7088 @item gnus-ignored-headers
7089 @vindex gnus-ignored-headers
7090 This variable is the reverse of @code{gnus-visible-headers}.  If this
7091 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7092 should be a regular expression that matches all lines that you want to
7093 hide.  All lines that do not match this variable will remain visible.
7094
7095 For instance, if you just want to get rid of the @code{References} line
7096 and the @code{Xref} line, you might say:
7097
7098 @lisp
7099 (setq gnus-ignored-headers "^References:\\|^Xref:")
7100 @end lisp
7101
7102 This variable can also be a list of regexps to match headers that are to
7103 be removed.
7104
7105 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7106 variable will have no effect.
7107
7108 @end table
7109
7110 @vindex gnus-sorted-header-list
7111 Gnus can also sort the headers for you.  (It does this by default.)  You
7112 can control the sorting by setting the @code{gnus-sorted-header-list}
7113 variable.  It is a list of regular expressions that says in what order
7114 the headers are to be displayed.
7115
7116 For instance, if you want the name of the author of the article first,
7117 and then the subject, you might say something like:
7118
7119 @lisp
7120 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7121 @end lisp
7122
7123 Any headers that are to remain visible, but are not listed in this
7124 variable, will be displayed in random order after all the headers that
7125 are listed in this variable.
7126
7127 @findex gnus-article-hide-boring-headers
7128 @vindex gnus-article-display-hook
7129 @vindex gnus-boring-article-headers
7130 You can hide further boring headers by entering
7131 @code{gnus-article-hide-boring-headers} into
7132 @code{gnus-article-display-hook}.  What this function does depends on
7133 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7134 list doesn't actually contain header names.  Instead is lists various
7135 @dfn{boring conditions} that Gnus can check and remove from sight.
7136
7137 These conditions are:
7138 @table @code
7139 @item empty
7140 Remove all empty headers.
7141 @item newsgroups
7142 Remove the @code{Newsgroups} header if it only contains the current group
7143 name. 
7144 @item followup-to
7145 Remove the @code{Followup-To} header if it is identical to the
7146 @code{Newsgroups} header.
7147 @item reply-to
7148 Remove the @code{Reply-To} header if it lists the same address as the
7149 @code{From} header.
7150 @item date
7151 Remove the @code{Date} header if the article is less than three days
7152 old. 
7153 @end table
7154
7155 To include the four first elements, you could say something like;
7156
7157 @lisp
7158 (setq gnus-boring-article-headers 
7159       '(empty newsgroups followup-to reply-to))
7160 @end lisp
7161
7162 This is also the default value for this variable.
7163
7164
7165 @node Using MIME
7166 @section Using @sc{mime}
7167 @cindex @sc{mime}
7168
7169 Mime is a standard for waving your hands through the air, aimlessly,
7170 while people stand around yawning.
7171
7172 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7173 while all newsreaders die of fear.
7174
7175 @sc{mime} may specify what character set the article uses, the encoding
7176 of the characters, and it also makes it possible to embed pictures and
7177 other naughty stuff in innocent-looking articles.
7178
7179 @vindex gnus-show-mime
7180 @vindex gnus-show-mime-method
7181 @vindex gnus-strict-mime
7182 @findex metamail-buffer
7183 Gnus handles @sc{mime} by pushing the articles through
7184 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7185 default.  Set @code{gnus-show-mime} to @code{t} if you want to use
7186 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7187 non-@code{nil}, the @sc{mime} method will only be used if there are
7188 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7189 set, then you'll see some unfortunate display glitches in the article
7190 buffer.  These can't be avoided.
7191
7192 It might be best to just use the toggling functions from the summary
7193 buffer to avoid getting nasty surprises. (For instance, you enter the
7194 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7195 decoded the sound file in the article and some horrible sing-a-long song
7196 comes streaming out out your speakers, and you can't find the volume
7197 button, because there isn't one, and people are starting to look at you,
7198 and you try to stop the program, but you can't, and you can't find the
7199 program to control the volume, and everybody else in the room suddenly
7200 decides to look at you disdainfully, and you'll feel rather stupid.)
7201
7202 Any similarity to real events and people is purely coincidental.  Ahem.
7203
7204
7205 @node Customizing Articles
7206 @section Customizing Articles
7207 @cindex article customization
7208
7209 @vindex gnus-article-display-hook
7210 The @code{gnus-article-display-hook} is called after the article has
7211 been inserted into the article buffer.  It is meant to handle all
7212 treatment of the article before it is displayed. 
7213
7214 @findex gnus-article-maybe-highlight
7215 By default this hook just contains @code{gnus-article-hide-headers},
7216 @code{gnus-article-treat-overstrike}, and
7217 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7218 millions, of functions you can put in this hook.  For an overview of
7219 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7220 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7221 Date}.  Note that the order of functions in this hook might affect
7222 things, so you may have to fiddle a bit to get the desired results. 
7223
7224 You can, of course, write your own functions.  The functions are called
7225 from the article buffer, and you can do anything you like, pretty much.
7226 There is no information that you have to keep in the buffer---you can
7227 change everything.  However, you shouldn't delete any headers.  Instead
7228 make them invisible if you want to make them go away.
7229
7230
7231 @node Article Keymap
7232 @section Article Keymap
7233
7234 Most of the keystrokes in the summary buffer can also be used in the
7235 article buffer.  They should behave as if you typed them in the summary
7236 buffer, which means that you don't actually have to have a summary
7237 buffer displayed while reading.  You can do it all from the article
7238 buffer.
7239
7240 A few additional keystrokes are available:
7241
7242 @table @kbd
7243
7244 @item SPACE
7245 @kindex SPACE (Article)
7246 @findex gnus-article-next-page
7247 Scroll forwards one page (@code{gnus-article-next-page}).
7248
7249 @item DEL
7250 @kindex DEL (Article)
7251 @findex gnus-article-prev-page
7252 Scroll backwards one page (@code{gnus-article-prev-page}).
7253
7254 @item C-c ^
7255 @kindex C-c ^ (Article)
7256 @findex gnus-article-refer-article
7257 If point is in the neighborhood of a @code{Message-ID} and you press
7258 @kbd{r}, Gnus will try to get that article from the server
7259 (@code{gnus-article-refer-article}).
7260
7261 @item C-c C-m
7262 @kindex C-c C-m (Article)
7263 @findex gnus-article-mail
7264 Send a reply to the address near point (@code{gnus-article-mail}).  If
7265 given a prefix, include the mail.
7266
7267 @item s
7268 @kindex s (Article)
7269 @findex gnus-article-show-summary
7270 Reconfigure the buffers so that the summary buffer becomes visible
7271 (@code{gnus-article-show-summary}).
7272
7273 @item ?
7274 @kindex ? (Article)
7275 @findex gnus-article-describe-briefly
7276 Give a very brief description of the available keystrokes
7277 (@code{gnus-article-describe-briefly}). 
7278
7279 @item TAB
7280 @kindex TAB (Article)
7281 @findex gnus-article-next-button
7282 Go to the next button, if any (@code{gnus-article-next-button}.  This
7283 only makes sense if you have buttonizing turned on.
7284
7285 @item M-TAB
7286 @kindex M-TAB (Article)
7287 @findex gnus-article-prev-button
7288 Go to the previous button, if any (@code{gnus-article-prev-button}.  
7289
7290 @end table
7291
7292
7293 @node Misc Article
7294 @section Misc Article
7295
7296 @table @code
7297
7298 @item gnus-single-article-buffer
7299 @vindex gnus-single-article-buffer
7300 If non-@code{nil}, use the same article buffer for all the groups.
7301 (This is the default.)  If @code{nil}, each group will have its own
7302 article buffer.
7303
7304 @vindex gnus-article-prepare-hook
7305 @item gnus-article-prepare-hook
7306 This hook is called right after the article has been inserted into the
7307 article buffer.  It is mainly intended for functions that do something
7308 depending on the contents; it should probably not be used for changing
7309 the contents of the article buffer.
7310
7311 @vindex gnus-article-display-hook
7312 @item gnus-article-display-hook
7313 This hook is called as the last thing when displaying an article, and is
7314 intended for modifying the contents of the buffer, doing highlights,
7315 hiding headers, and the like.
7316
7317 @item gnus-article-mode-hook
7318 @vindex gnus-article-mode-hook
7319 Hook called in article mode buffers.
7320
7321 @item gnus-article-mode-syntax-table
7322 @vindex gnus-article-mode-syntax-table
7323 Syntax table used in article buffers.  It is initialized from
7324 @code{text-mode-syntax-table}. 
7325
7326 @vindex gnus-article-mode-line-format
7327 @item gnus-article-mode-line-format
7328 This variable is a format string along the same lines as
7329 @code{gnus-summary-mode-line-format}.  It accepts the same
7330 format specifications as that variable, with one extension:
7331
7332 @table @samp
7333 @item w
7334 The @dfn{wash status} of the article.  This is a short string with one
7335 character for each possible article wash operation that may have been
7336 performed. 
7337 @end table
7338
7339 @vindex gnus-break-pages
7340
7341 @item gnus-break-pages
7342 Controls whether @dfn{page breaking} is to take place.  If this variable
7343 is non-@code{nil}, the articles will be divided into pages whenever a
7344 page delimiter appears in the article.  If this variable is @code{nil},
7345 paging will not be done.
7346
7347 @item gnus-page-delimiter
7348 @vindex gnus-page-delimiter
7349 This is the delimiter mentioned above.  By default, it is @samp{^L}
7350 (form linefeed).
7351 @end table
7352
7353
7354 @node Composing Messages
7355 @chapter Composing Messages
7356 @cindex reply
7357 @cindex followup
7358 @cindex post
7359
7360 @kindex C-c C-c (Post)
7361 All commands for posting and mailing will put you in a message buffer
7362 where you can edit the article all you like, before you send the article
7363 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7364 Manual}.  If you are in a foreign news group, and you wish to post the
7365 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7366 to make Gnus try to post using the foreign server.
7367
7368 @menu 
7369 * Mail::                 Mailing and replying.
7370 * Post::                 Posting and following up.
7371 * Posting Server::       What server should you post via?
7372 * Mail and Post::        Mailing and posting at the same time.
7373 * Archived Messages::    Where Gnus stores the messages you've sent.
7374 @c * Posting Styles::       An easier way to configure some key elements.
7375 @c * Drafts::               Postponing messages and rejected messages.
7376 @c * Rejected Articles::    What happens if the server doesn't like your article?
7377 @end menu
7378
7379 Also see @pxref{Canceling and Superseding} for information on how to
7380 remove articles you shouldn't have posted.
7381
7382
7383 @node Mail
7384 @section Mail
7385
7386 Variables for customizing outgoing mail:
7387
7388 @table @code
7389 @item gnus-uu-digest-headers
7390 @vindex gnus-uu-digest-headers
7391 List of regexps to match headers included in digested messages.  The
7392 headers will be included in the sequence they are matched.
7393
7394 @end table
7395
7396
7397 @node Post
7398 @section Post
7399
7400 Variables for composing news articles:
7401
7402 @table @code
7403 @item gnus-sent-message-ids-file
7404 @vindex gnus-sent-message-ids-file
7405 Gnus will keep a @code{Message-ID} history file of all the mails it has
7406 sent.  If it discovers that it has already sent a mail, it will ask the
7407 user whether to re-send the mail.  (This is primarily useful when
7408 dealing with @sc{soup} packets and the like where one is apt to sent the
7409 same packet multiple times.)  This variable says what the name of this
7410 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
7411 this variable to @code{nil} if you don't want Gnus to keep a history
7412 file.
7413
7414 @item gnus-sent-message-ids-length
7415 @vindex gnus-sent-message-ids-length
7416 This variable says how many @code{Message-ID}s to keep in the history
7417 file.  It is 1000 by default.
7418
7419 @end table
7420
7421
7422 @node Posting Server
7423 @section Posting Server
7424
7425 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7426 (extremely intelligent, of course) article, where does it go?
7427
7428 Thank you for asking.  I hate you.
7429
7430 @vindex gnus-post-method
7431
7432 It can be quite complicated.  Normally, Gnus will use the same native
7433 server.  However.  If your native server doesn't allow posting, just
7434 reading, you probably want to use some other server to post your
7435 (extremely intelligent and fabulously interesting) articles.  You can
7436 then set the @code{gnus-post-method} to some other method:
7437
7438 @lisp
7439 (setq gnus-post-method '(nnspool ""))
7440 @end lisp
7441
7442 Now, if you've done this, and then this server rejects your article, or
7443 this server is down, what do you do then?  To override this variable you
7444 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7445 the ``current'' server for posting.
7446
7447 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7448 Gnus will prompt you for what method to use for posting.  
7449
7450 You can also set @code{gnus-post-method} to a list of select methods.
7451 If that's the case, Gnus will always prompt you for what method to use
7452 for posting. 
7453
7454
7455 @node Mail and Post
7456 @section Mail and Post
7457
7458 Here's a list of variables that are relevant to both mailing and
7459 posting:
7460
7461 @table @code
7462 @item gnus-mailing-list-groups
7463 @findex gnus-mailing-list-groups
7464 @cindex mailing lists
7465
7466 If your news server offers groups that are really mailing lists that are
7467 gatewayed to the @sc{nntp} server, you can read those groups without
7468 problems, but you can't post/followup to them without some difficulty.
7469 One solution is to add a @code{to-address} to the group parameters
7470 (@pxref{Group Parameters}).  An easier thing to do is set the
7471 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7472 really are mailing lists.  Then, at least, followups to the mailing
7473 lists will work most of the time.  Posting to these groups (@kbd{a}) is
7474 still a pain, though.
7475
7476 @end table
7477
7478 You may want to do spell-checking on messages that you send out.  Or, if
7479 you don't want to spell-check by hand, you could add automatic
7480 spell-checking via the @code{ispell} package:
7481
7482 @cindex ispell
7483 @findex ispell-message
7484 @lisp
7485 (add-hook 'message-send-hook 'ispell-message) 
7486 @end lisp
7487
7488
7489 @node Archived Messages
7490 @section Archived Messages
7491 @cindex archived messages
7492 @cindex sent messages
7493
7494 Gnus provides a few different methods for storing the mail you send.
7495 The default method is to use the @dfn{archive virtual server} to store
7496 the mail.  If you want to disable this completely, you should set
7497 @code{gnus-message-archive-group} to @code{nil}.
7498
7499 @vindex gnus-message-archive-method
7500 @code{gnus-message-archive-method} says what virtual server Gnus is to
7501 use to store sent messages.  The default is:
7502
7503 @lisp
7504 (nnfolder "archive"
7505           (nnfolder-directory "~/Mail/archive/"))
7506 @end lisp
7507
7508 You can, however, use any mail select method (@code{nnml},
7509 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
7510 for doing this sort of thing, though.  If you don't like the default
7511 directory chosen, you could say something like:
7512
7513 @lisp
7514 (setq gnus-message-archive-method
7515       '(nnfolder "archive" 
7516                  (nnfolder-inhibit-expiry t)
7517                  (nnfolder-active-file "~/News/sent-mail/active")
7518                  (nnfolder-directory "~/News/sent-mail/")))
7519 @end lisp
7520
7521 @vindex gnus-message-archive-group
7522 @cindex Gcc
7523 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7524 to one or more group(s) on that server.  Which group to use is
7525 determined by the @code{gnus-message-archive-group} variable.  
7526
7527 This variable can be:
7528
7529 @itemize @bullet
7530 @item a string
7531 Messages will be saved in that group.
7532 @item a list of strings
7533 Messages will be saved in all those groups.
7534 @item an alist of regexps, functions and forms
7535 When a key ``matches'', the result is used.
7536 @item @code{nil}
7537 No message archiving will take place.  This is the default.
7538 @end itemize
7539
7540 Let's illustrate:
7541
7542 Just saving to a single group called @samp{MisK}:
7543 @lisp
7544 (setq gnus-message-archive-group "MisK")
7545 @end lisp
7546
7547 Saving to two groups, @samp{MisK} and @samp{safe}:
7548 @lisp
7549 (setq gnus-message-archive-group '("MisK" "safe"))
7550 @end lisp
7551
7552 Save to different groups based on what group you are in:
7553 @lisp
7554 (setq gnus-message-archive-group 
7555       '(("^alt" "sent-to-alt")
7556         ("mail" "sent-to-mail")
7557         (".*" "sent-to-misc")))
7558 @end lisp
7559
7560 More complex stuff:
7561 @lisp
7562 (setq gnus-message-archive-group 
7563       '((if (message-news-p)
7564             "misc-news" 
7565           "misc-mail")))
7566 @end lisp       
7567
7568 How about storing all news messages in one file, but storing all mail
7569 messages in one file per month:
7570
7571 @lisp
7572 (setq gnus-message-archive-group
7573       '((if (message-news-p)
7574             "misc-news" 
7575           (concat "mail." (format-time-string 
7576                            "%Y-%m" (current-time))))))
7577 @end lisp
7578
7579 Now, when you send a message off, it will be stored in the appropriate
7580 group.  (If you want to disable storing for just one particular message,
7581 you can just remove the @code{Gcc} header that has been inserted.)  The
7582 archive group will appear in the group buffer the next time you start
7583 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
7584 enter it and read the articles in it just like you'd read any other
7585 group.  If the group gets really big and annoying, you can simply rename
7586 if (using @kbd{G r} in the group buffer) to something
7587 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
7588 continue to be stored in the old (now empty) group.
7589
7590 That's the default method of archiving sent mail.  Gnus also a different
7591 way for the people who don't like the default method.  In that case you
7592 should set @code{gnus-message-archive-group} to @code{nil}; this will
7593 disable archiving.
7594
7595 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7596 use a different value for @code{gnus-message-archive-group} there.
7597
7598 @table @code
7599 @item gnus-outgoing-message-group 
7600 @vindex gnus-outgoing-message-group 
7601 All outgoing messages will be put in this group.  If you want to store
7602 all your outgoing mail and articles in the group @samp{nnml:archive},
7603 you set this variable to that value.  This variable can also be a list of
7604 group names.
7605
7606 If you want to have greater control over what group to put each
7607 message in, you can set this variable to a function that checks the
7608 current newsgroup name and then returns a suitable group name (or list
7609 of names).
7610 @end table
7611
7612
7613 @c @node Posting Styles
7614 @c @section Posting Styles
7615 @c @cindex posting styles
7616 @c @cindex styles
7617 @c 
7618 @c All them variables, they make my head swim.  
7619 @c 
7620 @c So what if you want a different @code{Organization} and signature based
7621 @c on what groups you post to?  And you post both from your home machine
7622 @c and your work machine, and you want different @code{From} lines, and so
7623 @c on? 
7624 @c 
7625 @c @vindex gnus-posting-styles
7626 @c One way to do stuff like that is to write clever hooks that change the
7627 @c variables you need to have changed.  That's a bit boring, so somebody
7628 @c came up with the bright idea of letting the user specify these things in
7629 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
7630 @c variable: 
7631 @c 
7632 @c @lisp
7633 @c ((".*" 
7634 @c   (signature . "Peace and happiness")
7635 @c   (organization . "What me?"))
7636 @c  ("^comp" 
7637 @c   (signature . "Death to everybody"))
7638 @c  ("comp.emacs.i-love-it" 
7639 @c   (organization . "Emacs is it")))
7640 @c @end lisp
7641 @c 
7642 @c As you might surmise from this example, this alist consists of several
7643 @c @dfn{styles}.  Each style will be applicable if the first element
7644 @c ``matches'', in some form or other.  The entire alist will be iterated
7645 @c over, from the beginning towards the end, and each match will be
7646 @c applied, which means that attributes in later styles that match override
7647 @c the same attributes in earlier matching styles.  So
7648 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7649 @c signature and the @samp{What me?} @code{Organization} header.
7650 @c 
7651 @c The first element in each style is called the @code{match}.  If it's a
7652 @c string, then Gnus will try to regexp match it against the group name.
7653 @c If it's a function symbol, that function will be called with no
7654 @c arguments.  If it's a variable symbol, then the variable will be
7655 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
7656 @c any case, if this returns a non-@code{nil} value, then the style is said
7657 @c to @dfn{match}.
7658 @c 
7659 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
7660 @c attribute consists of a @var{(name . value)} pair.  The attribute name
7661 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
7662 @c attribute name can also be a string.  In that case, this will be used as
7663 @c a header name, and the value will be inserted in the headers of the
7664 @c article.
7665 @c 
7666 @c The attribute value can be a string (used verbatim), a function (the
7667 @c return value will be used), a variable (its value will be used) or a
7668 @c list (it will be @code{eval}ed and the return value will be used).
7669 @c 
7670 @c So here's a new example:
7671 @c 
7672 @c @lisp
7673 @c (setq gnus-posting-styles
7674 @c       '((".*" 
7675 @c           (signature . "~/.signature") 
7676 @c           (from . "user@@foo (user)")
7677 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
7678 @c           (organization . "People's Front Against MWM"))
7679 @c         ("^rec.humor" 
7680 @c           (signature . my-funny-signature-randomizer))
7681 @c         ((equal (system-name) "gnarly")
7682 @c           (signature . my-quote-randomizer))
7683 @c         (posting-from-work-p
7684 @c           (signature . "~/.work-signature")
7685 @c           (from . "user@@bar.foo (user)")
7686 @c           (organization . "Important Work, Inc"))
7687 @c         ("^nn.+:" 
7688 @c           (signature . "~/.mail-signature"))))
7689 @c @end lisp
7690
7691 @c @node Drafts
7692 @c @section Drafts
7693 @c @cindex drafts
7694 @c 
7695 @c If you are writing a message (mail or news) and suddenly remember that
7696 @c you have a steak in the oven (or some pesto in the food processor, you
7697 @c craazy vegetarians), you'll probably wish there was a method to save the
7698 @c message you are writing so that you can continue editing it some other
7699 @c day, and send it when you feel its finished.
7700 @c 
7701 @c Well, don't worry about it.  Whenever you start composing a message of
7702 @c some sort using the Gnus mail and post commands, the buffer you get will
7703 @c automatically associate to an article in a special @dfn{draft} group.
7704 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7705 @c article will be saved there.  (Auto-save files also go to the draft
7706 @c group.) 
7707 @c 
7708 @c @cindex nndraft
7709 @c @vindex gnus-draft-group-directory
7710 @c The draft group is a special group (which is implemented as an
7711 @c @code{nndraft} group, if you absolutely have to know) called
7712 @c @samp{nndraft:drafts}.  The variable @code{gnus-draft-group-directory}
7713 @c controls both the name of the group and the location---the leaf element
7714 @c in the path will be used as the name of the group.  What makes this
7715 @c group special is that you can't tick any articles in it or mark any
7716 @c articles as read---all articles in the group are permanently unread.
7717 @c 
7718 @c If the group doesn't exist, it will be created and you'll be subscribed
7719 @c to it.
7720 @c 
7721 @c @findex gnus-dissociate-buffer-from-draft
7722 @c @kindex C-c M-d (Mail)
7723 @c @kindex C-c M-d (Post)
7724 @c @findex gnus-associate-buffer-with-draft
7725 @c @kindex C-c C-d (Mail)
7726 @c @kindex C-c C-d (Post)
7727 @c If you're writing some super-secret message that you later want to
7728 @c encode with PGP before sending, you may wish to turn the auto-saving
7729 @c (and association with the draft group) off.  You never know who might be
7730 @c interested in reading all your extremely valuable and terribly horrible
7731 @c and interesting secrets.  The @kbd{C-c M-d}
7732 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7733 @c If you change your mind and want to turn the auto-saving back on again,
7734 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7735 @c 
7736 @c @vindex gnus-use-draft
7737 @c To leave association with the draft group off by default, set
7738 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
7739 @c 
7740 @c @findex gnus-summary-send-draft
7741 @c @kindex S D c (Summary)
7742 @c When you want to continue editing the article, you simply enter the
7743 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7744 @c that.  You will be placed in a buffer where you left off.
7745 @c 
7746 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7747 @c Articles}).
7748 @c 
7749 @c @findex gnus-summary-send-all-drafts
7750 @c If you have lots of rejected messages you want to post (or mail) without
7751 @c doing further editing, you can use the @kbd{S D a} command
7752 @c (@code{gnus-summary-send-all-drafts}).  This command understands the
7753 @c process/prefix convention (@pxref{Process/Prefix}).  
7754 @c 
7755 @c 
7756 @c @node Rejected Articles
7757 @c @section Rejected Articles
7758 @c @cindex rejected articles
7759 @c 
7760 @c Sometimes a news server will reject an article.  Perhaps the server
7761 @c doesn't like your face.  Perhaps it just feels miserable.  Perhaps
7762 @c @emph{there be demons}.  Perhaps you have included too much cited text.
7763 @c Perhaps the disk is full.  Perhaps the server is down.
7764 @c 
7765 @c These situations are, of course, totally beyond the control of Gnus.
7766 @c (Gnus, of course, loves the way you look, always feels great, has angels
7767 @c fluttering around inside of it, doesn't care about how much cited text
7768 @c you include, never runs full and never goes down.)  So Gnus saves these
7769 @c articles until some later time when the server feels better.
7770 @c 
7771 @c The rejected articles will automatically be put in a special draft group
7772 @c (@pxref{Drafts}).  When the server comes back up again, you'd then
7773 @c typically enter that group and send all the articles off.
7774 @c 
7775
7776 @node Select Methods
7777 @chapter Select Methods
7778 @cindex foreign groups
7779 @cindex select methods
7780
7781 A @dfn{foreign group} is a group that is not read by the usual (or
7782 default) means.  It could be, for instance, a group from a different
7783 @sc{nntp} server, it could be a virtual group, or it could be your own
7784 personal mail group.
7785
7786 A foreign group (or any group, really) is specified by a @dfn{name} and
7787 a @dfn{select method}.  To take the latter first, a select method is a
7788 list where the first element says what backend to use (e.g. @code{nntp},
7789 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7790 name}.  There may be additional elements in the select method, where the
7791 value may have special meaning for the backend in question.
7792
7793 One could say that a select method defines a @dfn{virtual server}---so
7794 we do just that (@pxref{The Server Buffer}).
7795
7796 The @dfn{name} of the group is the name the backend will recognize the
7797 group as.
7798
7799 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7800 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7801 method @code{(nntp "some.where.edu")}.  Gnus will call this group
7802 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7803 backend just knows this group as @samp{soc.motss}.
7804
7805 The different methods all have their peculiarities, of course.
7806
7807 @menu
7808 * The Server Buffer::     Making and editing virtual servers.
7809 * Getting News::          Reading USENET news with Gnus.
7810 * Getting Mail::          Reading your personal mail with Gnus.
7811 * Other Sources::         Reading directories, files, SOUP packets.
7812 * Combined Groups::       Combining groups into one group.
7813 @end menu
7814
7815
7816 @node The Server Buffer
7817 @section The Server Buffer
7818
7819 Traditionally, a @dfn{server} is a machine or a piece of software that
7820 one connects to, and then requests information from.  Gnus does not
7821 connect directly to any real servers, but does all transactions through
7822 one backend or other.  But that's just putting one layer more between
7823 the actual media and Gnus, so we might just as well say that each
7824 backend represents a virtual server.
7825
7826 For instance, the @code{nntp} backend may be used to connect to several
7827 different actual @sc{nntp} servers, or, perhaps, to many different ports
7828 on the same actual @sc{nntp} server.  You tell Gnus which backend to
7829 use, and what parameters to set by specifying a @dfn{select method}.
7830
7831 These select methods specifications can sometimes become quite
7832 complicated---say, for instance, that you want to read from the
7833 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
7834 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
7835 Anyways, if you had to specify that for each group that used this
7836 server, that would be too much work, so Gnus offers a way of naming
7837 select methods, which is what you do in the server buffer.
7838
7839 To enter the server buffer, user the @kbd{^}
7840 (@code{gnus-group-enter-server-mode}) command in the group buffer.
7841
7842 @menu
7843 * Server Buffer Format::      You can customize the look of this buffer.
7844 * Server Commands::           Commands to manipulate servers.
7845 * Example Methods::           Examples server specifications.
7846 * Creating a Virtual Server:: An example session.
7847 * Servers and Methods::       You can use server names as select methods.
7848 * Unavailable Servers::       Some servers you try to contact may be down.
7849 @end menu
7850
7851 @vindex gnus-server-mode-hook
7852 @code{gnus-server-mode-hook} is run when creating the server buffer.
7853
7854
7855 @node Server Buffer Format
7856 @subsection Server Buffer Format
7857 @cindex server buffer format
7858
7859 @vindex gnus-server-line-format
7860 You can change the look of the server buffer lines by changing the
7861 @code{gnus-server-line-format} variable.  This is a @code{format}-like
7862 variable, with some simple extensions:
7863
7864 @table @samp
7865
7866 @item h 
7867 How the news is fetched---the backend name.
7868
7869 @item n
7870 The name of this server.
7871
7872 @item w
7873 Where the news is to be fetched from---the address.
7874
7875 @item s
7876 The opened/closed/denied status of the server.
7877 @end table
7878
7879 @vindex gnus-server-mode-line-format
7880 The mode line can also be customized by using the
7881 @code{gnus-server-mode-line-format} variable.  The following specs are
7882 understood: 
7883
7884 @table @samp
7885 @item S
7886 Server name.
7887
7888 @item M
7889 Server method.
7890 @end table
7891
7892 Also @pxref{Formatting Variables}.
7893
7894
7895 @node Server Commands
7896 @subsection Server Commands
7897 @cindex server commands
7898
7899 @table @kbd
7900
7901 @item a
7902 @kindex a (Server)
7903 @findex gnus-server-add-server
7904 Add a new server (@code{gnus-server-add-server}).
7905
7906 @item e
7907 @kindex e (Server)
7908 @findex gnus-server-edit-server
7909 Edit a server (@code{gnus-server-edit-server}).
7910
7911 @item SPACE
7912 @kindex SPACE (Server)
7913 @findex gnus-server-read-server
7914 Browse the current server (@code{gnus-server-read-server}).
7915
7916 @item q
7917 @kindex q (Server)
7918 @findex gnus-server-exit
7919 Return to the group buffer (@code{gnus-server-exit}).
7920
7921 @item k
7922 @kindex k (Server)
7923 @findex gnus-server-kill-server
7924 Kill the current server (@code{gnus-server-kill-server}).
7925
7926 @item y
7927 @kindex y (Server)
7928 @findex gnus-server-yank-server
7929 Yank the previously killed server (@code{gnus-server-yank-server}).
7930
7931 @item c
7932 @kindex c (Server)
7933 @findex gnus-server-copy-server
7934 Copy the current server (@code{gnus-server-copy-server}).
7935
7936 @item l
7937 @kindex l (Server)
7938 @findex gnus-server-list-servers
7939 List all servers (@code{gnus-server-list-servers}).
7940
7941 @item s
7942 @kindex s (Server)
7943 @findex gnus-server-scan-server
7944 Request that the server scan its sources for new articles
7945 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
7946 servers. 
7947
7948 @item g
7949 @kindex g (Server)
7950 @findex gnus-server-regenerate-server
7951 Request that the server regenerate all its data structures
7952 (@code{gnus-server-regenerate-server}).  This can be useful if you have
7953 a mail backend that has gotten out of synch.
7954
7955 @end table
7956
7957
7958 @node Example Methods
7959 @subsection Example Methods
7960
7961 Most select methods are pretty simple and self-explanatory: 
7962
7963 @lisp
7964 (nntp "news.funet.fi")
7965 @end lisp
7966
7967 Reading directly from the spool is even simpler:
7968
7969 @lisp
7970 (nnspool "")
7971 @end lisp
7972
7973 As you can see, the first element in a select method is the name of the
7974 backend, and the second is the @dfn{address}, or @dfn{name}, if you
7975 will. 
7976
7977 After these two elements, there may be a arbitrary number of
7978 @var{(variable form)} pairs.
7979
7980 To go back to the first example---imagine that you want to read from
7981 port 15 from that machine.  This is what the select method should
7982 look like then:
7983
7984 @lisp
7985 (nntp "news.funet.fi" (nntp-port-number 15))
7986 @end lisp
7987
7988 You should read the documentation to each backend to find out what
7989 variables are relevant, but here's an @code{nnmh} example. 
7990
7991 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
7992 you have two structures that you wish to access: One is your private
7993 mail spool, and the other is a public one.  Here's the possible spec for
7994 you private mail:
7995
7996 @lisp
7997 (nnmh "private" (nnmh-directory "~/private/mail/"))
7998 @end lisp
7999
8000 (This server is then called @samp{private}, but you may have guessed
8001 that.)
8002
8003 Here's the method for a public spool:
8004
8005 @lisp
8006 (nnmh "public" 
8007       (nnmh-directory "/usr/information/spool/") 
8008       (nnmh-get-new-mail nil))
8009 @end lisp
8010
8011
8012 @node Creating a Virtual Server
8013 @subsection Creating a Virtual Server
8014
8015 If you're saving lots of articles in the cache by using persistent
8016 articles, you may want to create a virtual server to read the cache.
8017
8018 First you need to add a new server.  The @kbd{a} command does that.  It
8019 would probably be best to use @code{nnspool} to read the cache.  You
8020 could also use @code{nnml} or @code{nnmh}, though.
8021
8022 Type @kbd{a nnspool RET cache RET}.
8023
8024 You should now have a brand new @code{nnspool} virtual server called
8025 @samp{cache}.  You now need to edit it to have the right definitions.
8026 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8027 will contain the following:
8028
8029 @lisp
8030 (nnspool "cache")
8031 @end lisp
8032
8033 Change that to:
8034
8035 @lisp
8036 (nnspool "cache"
8037          (nnspool-spool-directory "~/News/cache/")
8038          (nnspool-nov-directory "~/News/cache/")
8039          (nnspool-active-file "~/News/cache/active"))
8040 @end lisp
8041
8042 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8043 @kbd{RET} over this virtual server, you should be entered into a browse
8044 buffer, and you should be able to enter any of the groups displayed.
8045
8046
8047 @node Servers and Methods
8048 @subsection Servers and Methods
8049
8050 Wherever you would normally use a select method
8051 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8052 when browsing a foreign server) you can use a virtual server name
8053 instead.  This could potentially save lots of typing.  And it's nice all
8054 over.
8055
8056
8057 @node Unavailable Servers
8058 @subsection Unavailable Servers
8059
8060 If a server seems to be unreachable, Gnus will mark that server as
8061 @code{denied}.  That means that any subsequent attempt to make contact
8062 with that server will just be ignored.  ``It can't be opened,'' Gnus
8063 will tell you, without making the least effort to see whether that is
8064 actually the case or not.
8065
8066 That might seem quite naughty, but it does make sense most of the time.
8067 Let's say you have 10 groups subscribed to the server
8068 @samp{nepholococcygia.com}.  This server is located somewhere quite far
8069 away from you, the machine is quite, so it takes 1 minute just to find
8070 out that it refuses connection from you today.  If Gnus were to attempt
8071 to do that 10 times, you'd be quite annoyed, so Gnus won't attempt to do
8072 that.  Once it has gotten a single ``connection refused'', it will
8073 regard that server as ``down''.
8074
8075 So, what happens if the machine was only feeling unwell temporarily?
8076 How do you test to see whether the machine has come up again?
8077
8078 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8079 with the following commands:
8080
8081 @table @kbd
8082
8083 @item O
8084 @kindex O (Server)
8085 @findex gnus-server-open-server
8086 Try to establish connection to the server on the current line
8087 (@code{gnus-server-open-server}).
8088
8089 @item C
8090 @kindex C (Server)
8091 @findex gnus-server-close-server
8092 Close the connection (if any) to the server
8093 (@code{gnus-server-close-server}).
8094
8095 @item D
8096 @kindex D (Server)
8097 @findex gnus-server-deny-server
8098 Mark the current server as unreachable
8099 (@code{gnus-server-deny-server}). 
8100
8101 @item M-o
8102 @kindex M-o (Server)
8103 @findex gnus-server-open-all-servers
8104 Open the connections to all servers in the buffer
8105 (@code{gnus-server-open-all-servers}). 
8106
8107 @item M-c
8108 @kindex M-c (Server)
8109 @findex gnus-server-close-all-servers
8110 Close the connections to all servers in the buffer
8111 (@code{gnus-server-close-all-servers}). 
8112
8113 @item R
8114 @kindex R (Server)
8115 @findex gnus-server-remove-denials
8116 Remove all marks to whether Gnus was denied connection from all servers
8117 (@code{gnus-server-remove-denials}). 
8118
8119 @end table
8120
8121
8122 @node Getting News
8123 @section Getting News
8124 @cindex reading news
8125 @cindex news backends
8126
8127 A newsreader is normally used for reading news.  Gnus currently provides
8128 only two methods of getting news---it can read from an @sc{nntp} server,
8129 or it can read from a local spool.
8130
8131 @menu
8132 * NNTP::               Reading news from an @sc{nntp} server.
8133 * News Spool::         Reading news from the local spool.
8134 @end menu
8135
8136
8137 @node NNTP
8138 @subsection @sc{nntp}
8139 @cindex nntp
8140
8141 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8142 You just specify @code{nntp} as method and the address of the @sc{nntp}
8143 server as the, uhm, address.
8144
8145 If the @sc{nntp} server is located at a non-standard port, setting the
8146 third element of the select method to this port number should allow you
8147 to connect to the right port.  You'll have to edit the group info for
8148 that (@pxref{Foreign Groups}).
8149
8150 The name of the foreign group can be the same as a native group.  In
8151 fact, you can subscribe to the same group from as many different servers
8152 you feel like.  There will be no name collisions.
8153
8154 The following variables can be used to create a virtual @code{nntp}
8155 server: 
8156
8157 @table @code
8158
8159 @item nntp-server-opened-hook
8160 @vindex nntp-server-opened-hook
8161 @cindex @sc{mode reader}
8162 @cindex authinfo
8163 @cindex authentification
8164 @cindex nntp authentification
8165 @findex nntp-send-authinfo
8166 @findex nntp-send-mode-reader
8167 @code{nntp-server-opened-hook} is run after a connection has been made.
8168 It can be used to send commands to the @sc{nntp} server after it has
8169 been contacted.  By default is sends the command @code{MODE READER} to
8170 the server with the @code{nntp-send-mode-reader} function. 
8171
8172 @item nntp-authinfo-function 
8173 @vindex nntp-authinfo-function 
8174 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8175 server.  Available functions include:
8176
8177 @table @code
8178 @item nntp-send-authinfo
8179 @findex nntp-send-authinfo
8180 This function will used you current login name as the user name and will
8181 prompt you for the password.  This is the default.
8182
8183 @item nntp-send-nosy-authinfo
8184 @findex nntp-send-nosy-authinfo
8185 This function will prompt you for both user name and password.
8186
8187 @item nntp-send-authinfo-from-file
8188 @findex nntp-send-authinfo-from-file
8189 This function will use your current login name as the user name and will
8190 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8191 @end table
8192
8193 @item nntp-server-action-alist 
8194 @vindex nntp-server-action-alist 
8195 This is an list of regexps to match on server types and actions to be
8196 taken when matches are made.  For instance, if you want Gnus to beep
8197 every time you connect to innd, you could say something like:
8198
8199 @lisp
8200 (setq nntp-server-action-alist
8201       '(("innd" (ding))))
8202 @end lisp
8203
8204 You probably don't want to do that, though.
8205
8206 The default value is
8207
8208 @lisp
8209   '(("nntpd 1\\.5\\.11t" 
8210      (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8211 @end lisp
8212
8213 This ensures that Gnus doesn't send the @code{MODE READER} command to
8214 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8215
8216 @item nntp-maximum-request
8217 @vindex nntp-maximum-request
8218 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8219 will collect headers by sending a series of @code{head} commands.  To
8220 speed things up, the backend sends lots of these commands without
8221 waiting for reply, and then reads all the replies.  This is controlled
8222 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8223 your network is buggy, you should set this to 1.
8224
8225 @item nntp-connection-timeout
8226 @vindex nntp-connection-timeout
8227 If you have lots of foreign @code{nntp} groups that you connect to
8228 regularly, you're sure to have problems with @sc{nntp} servers not
8229 responding properly, or being too loaded to reply within reasonable
8230 time.  This is can lead to awkward problems, which can be helped
8231 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8232 that says how many seconds the @code{nntp} backend should wait for a
8233 connection before giving up.  If it is @code{nil}, which is the default,
8234 no timeouts are done.
8235
8236 @item nntp-command-timeout
8237 @vindex nntp-command-timeout
8238 @cindex PPP connections
8239 @cindex dynamic IP addresses
8240 If you're running Gnus on a machine that has a dynamically assigned
8241 address, Gnus may become confused.  If the address of your machine
8242 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8243 waiting forever for replies from the server.  To help with this
8244 unfortunate problem, you can set this command to a number.  Gnus will
8245 then, if it sits waiting longer than that number of seconds for a reply
8246 from the server, shut down the connection, start a new one, and resend
8247 the command.  This should hopefully be transparent to the user.  A
8248 likely number is 30 seconds. 
8249
8250 @item nntp-retry-on-break
8251 @vindex nntp-retry-on-break
8252 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8253 hangs.  This will have much the same effect as the command timeout
8254 described above.
8255
8256 @item nntp-server-hook
8257 @vindex nntp-server-hook
8258 This hook is run as the last step when connecting to an @sc{nntp}
8259 server.
8260
8261 @findex nntp-open-rlogin
8262 @findex nntp-open-network-stream
8263 @item nntp-open-server-function
8264 @vindex nntp-open-server-function
8265 This function is used to connect to the remote system.  Two pre-made
8266 functions are @code{nntp-open-network-stream}, which is the default, and
8267 simply connects to some port or other on the remote system.  The other
8268 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
8269 and then does a telnet to the @sc{nntp} server available there.
8270
8271 @item nntp-rlogin-parameters
8272 @vindex nntp-rlogin-parameters
8273 If you use @code{nntp-open-rlogin} as the
8274 @code{nntp-open-server-function}, this list will be used as the
8275 parameter list given to @code{rsh}.
8276
8277 @item nntp-end-of-line
8278 @vindex nntp-end-of-line
8279 String to use as end-of-line markers when talking to the @sc{nntp}
8280 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
8281 using @code{rlogin} to talk to the server.
8282
8283 @item nntp-rlogin-user-name
8284 @vindex nntp-rlogin-user-name
8285 User name on the remote system when using the @code{rlogin} connect
8286 function. 
8287
8288 @item nntp-address
8289 @vindex nntp-address
8290 The address of the remote system running the @sc{nntp} server.
8291
8292 @item nntp-port-number
8293 @vindex nntp-port-number
8294 Port number to connect to when using the @code{nntp-open-network-stream}
8295 connect function.
8296
8297 @item nntp-buggy-select
8298 @vindex nntp-buggy-select
8299 Set this to non-@code{nil} if your select routine is buggy.
8300
8301 @item nntp-nov-is-evil 
8302 @vindex nntp-nov-is-evil 
8303 If the @sc{nntp} server does not support @sc{nov}, you could set this
8304 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8305 can be used automatically.
8306
8307 @item nntp-xover-commands
8308 @vindex nntp-xover-commands
8309 @cindex nov
8310 @cindex XOVER
8311 List of strings that are used as commands to fetch @sc{nov} lines from a
8312 server.  The default value of this variable is @code{("XOVER"
8313 "XOVERVIEW")}. 
8314
8315 @item nntp-nov-gap
8316 @vindex nntp-nov-gap
8317 @code{nntp} normally sends just one big request for @sc{nov} lines to
8318 the server.  The server responds with one huge list of lines.  However,
8319 if you have read articles 2-5000 in the group, and only want to read
8320 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8321 lines that you do not want, and will not use.  This variable says how
8322 big a gap between two consecutive articles is allowed to be before the
8323 @code{XOVER} request is split into several request.  Note that if your
8324 network is fast, setting this variable to a really small number means
8325 that fetching will probably be slower.  If this variable is @code{nil},
8326 @code{nntp} will never split requests.
8327
8328 @item nntp-prepare-server-hook
8329 @vindex nntp-prepare-server-hook
8330 A hook run before attempting to connect to an @sc{nntp} server.
8331
8332 @item nntp-warn-about-losing-connection
8333 @vindex nntp-warn-about-losing-connection
8334 If this variable is non-@code{nil}, some noise will be made when a
8335 server closes connection.
8336
8337 @end table
8338
8339
8340 @node News Spool
8341 @subsection News Spool
8342 @cindex nnspool
8343 @cindex news spool
8344
8345 Subscribing to a foreign group from the local spool is extremely easy,
8346 and might be useful, for instance, to speed up reading groups that
8347 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8348 instance. 
8349
8350 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8351 anything else) as the address.
8352
8353 If you have access to a local spool, you should probably use that as the
8354 native select method (@pxref{Finding the News}).  It is normally faster
8355 than using an @code{nntp} select method, but might not be.  It depends.
8356 You just have to try to find out what's best at your site.
8357
8358 @table @code
8359
8360 @item nnspool-inews-program
8361 @vindex nnspool-inews-program
8362 Program used to post an article.
8363
8364 @item nnspool-inews-switches
8365 @vindex nnspool-inews-switches
8366 Parameters given to the inews program when posting an article. 
8367
8368 @item nnspool-spool-directory
8369 @vindex nnspool-spool-directory
8370 Where @code{nnspool} looks for the articles.  This is normally
8371 @file{/usr/spool/news/}.
8372
8373 @item nnspool-nov-directory 
8374 @vindex nnspool-nov-directory 
8375 Where @code{nnspool} will look for @sc{nov} files.  This is normally
8376 @file{/usr/spool/news/over.view/}.
8377
8378 @item nnspool-lib-dir
8379 @vindex nnspool-lib-dir
8380 Where the news lib dir is (@file{/usr/lib/news/} by default).
8381
8382 @item nnspool-active-file
8383 @vindex nnspool-active-file
8384 The path of the active file.
8385
8386 @item nnspool-newsgroups-file
8387 @vindex nnspool-newsgroups-file
8388 The path of the group descriptions file.
8389
8390 @item nnspool-history-file
8391 @vindex nnspool-history-file
8392 The path of the news history file.
8393
8394 @item nnspool-active-times-file
8395 @vindex nnspool-active-times-file
8396 The path of the active date file.
8397
8398 @item nnspool-nov-is-evil
8399 @vindex nnspool-nov-is-evil
8400 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8401 that it finds.
8402
8403 @item nnspool-sift-nov-with-sed
8404 @vindex nnspool-sift-nov-with-sed
8405 @cindex sed
8406 If non-@code{nil}, which is the default, use @code{sed} to get the
8407 relevant portion from the overview file.  If nil, @code{nnspool} will
8408 load the entire file into a buffer and process it there.
8409
8410 @end table
8411
8412
8413 @node Getting Mail
8414 @section Getting Mail
8415 @cindex reading mail
8416 @cindex mail
8417
8418 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8419 course.
8420
8421 @menu
8422 * Getting Started Reading Mail:: A simple cookbook example.
8423 * Splitting Mail::               How to create mail groups.
8424 * Mail Backend Variables::       Variables for customizing mail handling.
8425 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
8426 * Mail and Procmail::            Reading mail groups that procmail create.
8427 * Incorporating Old Mail::       What about the old mail you have?
8428 * Expiring Mail::                Getting rid of unwanted mail.
8429 * Washing Mail::                 Removing gruft from the mail you get.
8430 * Duplicates::                   Dealing with duplicated mail.
8431 * Not Reading Mail::             Using mail backends for reading other files.
8432 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
8433 @end menu
8434
8435
8436 @node Getting Started Reading Mail
8437 @subsection Getting Started Reading Mail
8438
8439 It's quite easy to use Gnus to read your new mail.  You just plonk the
8440 mail backend of your choice into @code{gnus-secondary-select-methods},
8441 and things will happen automatically.
8442
8443 For instance, if you want to use @code{nnml} (which is a one file per
8444 mail backend), you could put the following in your @file{.gnus} file:
8445
8446 @lisp
8447 (setq gnus-secondary-select-methods
8448       '((nnml "private")))
8449 @end lisp
8450
8451 Now, the next time you start Gnus, this backend will be queried for new
8452 articles, and it will move all the messages in your spool file to its
8453 directory, which is @code{~/Mail/} by default.  The new group that will
8454 be created (@samp{mail.misc}) will be subscribed, and you can read it
8455 like any other group.
8456
8457 You will probably want to split the mail into several groups, though:
8458
8459 @lisp
8460 (setq nnmail-split-methods
8461       '(("junk" "^From:.*Lars Ingebrigtsen")
8462        ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8463        ("other" "")))
8464 @end lisp
8465
8466 This will result in three new @code{nnml} mail groups being created:
8467 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
8468 mail that doesn't fit into the first two groups will be placed in the
8469 latter group.
8470
8471 This should be sufficient for reading mail with Gnus.  You might want to
8472 give the other sections in this part of the manual a perusal, though,
8473 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
8474
8475
8476 @node Splitting Mail
8477 @subsection Splitting Mail
8478 @cindex splitting mail
8479 @cindex mail splitting
8480
8481 @vindex nnmail-split-methods
8482 The @code{nnmail-split-methods} variable says how the incoming mail is
8483 to be split into groups.
8484
8485 @lisp
8486 (setq nnmail-split-methods
8487   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8488     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8489     ("mail.other" "")))
8490 @end lisp
8491
8492 This variable is a list of lists, where the first element of each of
8493 these lists is the name of the mail group (they do not have to be called
8494 something beginning with @samp{mail}, by the way), and the second
8495 element is a regular expression used on the header of each mail to
8496 determine if it belongs in this mail group.
8497
8498 If the first element is the special symbol @code{junk}, then messages
8499 that match the regexp will disappear into the aether.  Use with
8500 extreme caution. 
8501
8502 The second element can also be a function.  In that case, it will be
8503 called narrowed to the headers with the first element of the rule as the
8504 argument.  It should return a non-@code{nil} value if it thinks that the
8505 mail belongs in that group.
8506
8507 The last of these groups should always be a general one, and the regular
8508 expression should @emph{always} be @samp{} so that it matches any
8509 mails that haven't been matched by any of the other regexps.
8510
8511 If you like to tinker with this yourself, you can set this variable to a
8512 function of your choice.  This function will be called without any
8513 arguments in a buffer narrowed to the headers of an incoming mail
8514 message.  The function should return a list of groups names that it
8515 thinks should carry this mail message.
8516
8517 Note that the mail backends are free to maul the poor, innocent
8518 incoming headers all they want to.  They all add @code{Lines} headers;
8519 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8520 @code{From<SPACE>} line to something else.
8521
8522 @vindex nnmail-crosspost
8523 The mail backends all support cross-posting.  If several regexps match,
8524 the mail will be ``cross-posted'' to all those groups.
8525 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
8526 that no articles are crossposted to the general (@samp{}) group.
8527
8528 @vindex nnmail-crosspost-link-function
8529 @cindex crosspost
8530 @cindex links
8531 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8532 the crossposted articles.  However, not all files systems support hard
8533 links.  If that's the case for you, set
8534 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
8535 variable is @code{add-name-to-file} by default.)  
8536
8537 @kindex M-x nnmail-split-history
8538 @kindex nnmail-split-history
8539 If you wish to see where the previous mail split put the messages, you
8540 can use the @kbd{M-x nnmail-split-history} command.
8541
8542 Gnus gives you all the opportunity you could possibly want for shooting
8543 yourself in the foot.  Let's say you create a group that will contain
8544 all the mail you get from your boss.  And then you accidentally
8545 unsubscribe from the group.  Gnus will still put all the mail from your
8546 boss in the unsubscribed group, and so, when your boss mails you ``Have
8547 that report ready by Monday or you're fired!'', you'll never see it and,
8548 come Tuesday, you'll still believe that you're gainfully employed while
8549 you really should be out collecting empty bottles to save up for next
8550 month's rent money.
8551
8552
8553 @node Mail Backend Variables
8554 @subsection Mail Backend Variables
8555
8556 These variables are (for the most part) pertinent to all the various
8557 mail backends.
8558
8559 @table @code
8560 @vindex nnmail-read-incoming-hook
8561 @item nnmail-read-incoming-hook
8562 The mail backends all call this hook after reading new mail.  You can
8563 use this hook to notify any mail watch programs, if you want to.
8564
8565 @vindex nnmail-spool-file
8566 @item nnmail-spool-file
8567 @cindex POP mail
8568 @cindex MAILHOST
8569 @cindex movemail
8570 @vindex nnmail-pop-password
8571 @vindex nnmail-pop-password-required
8572 The backends will look for new mail in this file.  If this variable is
8573 @code{nil}, the mail backends will never attempt to fetch mail by
8574 themselves.  If you are using a POP mail server and your name is
8575 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
8576 your name is not @samp{larsi}, you should probably modify that
8577 slightly, but you may have guessed that already, you smart & handsome
8578 devil!  You can also set this variable to @code{pop}, and Gnus will try
8579 to figure out the POP mail string by itself.  In any case, Gnus will
8580 call @code{movemail} which will contact the POP server named in the
8581 @code{MAILHOST} environment variable.  If the POP server needs a
8582 password, you can either set @code{nnmail-pop-password-required} to
8583 @code{t} and be prompted for the password, or set
8584 @code{nnmail-pop-password} to the password itself.
8585
8586 Your Emacs has to have been configured with @samp{--with-pop} before
8587 compilation.  This is the default, but some installations have it
8588 switched off.
8589
8590 When you use a mail backend, Gnus will slurp all your mail from your
8591 inbox and plonk it down in your home directory.  Gnus doesn't move any
8592 mail if you're not using a mail backend---you have to do a lot of magic
8593 invocations first.  At the time when you have finished drawing the
8594 pentagram, lightened the candles, and sacrificed the goat, you really
8595 shouldn't be too surprised when Gnus moves your mail.
8596
8597 @vindex nnmail-use-procmail
8598 @vindex nnmail-procmail-suffix
8599 @item nnmail-use-procmail
8600 If non-@code{nil}, the mail backends will look in
8601 @code{nnmail-procmail-directory} for incoming mail.  All the files in
8602 that directory that have names ending in @code{nnmail-procmail-suffix}
8603 will be considered incoming mailboxes, and will be searched for new
8604 mail.
8605
8606 @vindex nnmail-crash-box
8607 @item nnmail-crash-box
8608 When the mail backends read a spool file, it is first moved to this
8609 file, which is @file{~/.gnus-crash-box} by default.  If this file
8610 already exists, it will always be read (and incorporated) before any
8611 other spool files.
8612
8613 @vindex nnmail-prepare-incoming-hook
8614 @item nnmail-prepare-incoming-hook
8615 This is run in a buffer that holds all the new incoming mail, and can be
8616 used for, well, anything, really.
8617
8618 @vindex nnmail-split-hook
8619 @item nnmail-split-hook
8620 @findex article-decode-rfc1522
8621 @findex RFC1522 decoding
8622 Hook run in the buffer where the mail headers of each message is kept
8623 just before the splitting based on these headers is done.  The hook is
8624 free to modify the buffer contents in any way it sees fit---the buffer
8625 is discarded after the splitting has been done, and no changes performed
8626 in the buffer will show up in any files.  @code{article-decode-rfc1522}
8627 is one likely function to add to this hook.
8628
8629 @vindex nnmail-pre-get-new-mail-hook
8630 @vindex nnmail-post-get-new-mail-hook
8631 @item nnmail-pre-get-new-mail-hook
8632 @itemx nnmail-post-get-new-mail-hook
8633 These are two useful hooks executed when treating new incoming
8634 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8635 starting to handle the new mail) and
8636 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8637 is done).  Here's and example of using these two hooks to change the
8638 default file modes the new mail files get:
8639
8640 @lisp
8641 (add-hook 'gnus-pre-get-new-mail-hook 
8642           (lambda () (set-default-file-modes 511)))
8643
8644 (add-hook 'gnus-post-get-new-mail-hook 
8645           (lambda () (set-default-file-modes 551)))
8646 @end lisp
8647
8648 @item nnmail-tmp-directory
8649 @vindex nnmail-tmp-directory
8650 This variable says where to move the incoming mail to while processing
8651 it.  This is usually done in the same directory that the mail backend
8652 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8653 it will be used instead.
8654
8655 @item nnmail-movemail-program
8656 @vindex nnmail-movemail-program
8657 This program is executed to move mail from the user's inbox to her home
8658 directory.  The default is @samp{movemail}.
8659
8660 This can also be a function.  In that case, the function will be called
8661 with two parameters -- the name of the inbox, and the file to be moved
8662 to.
8663
8664 @item nnmail-delete-incoming
8665 @vindex nnmail-delete-incoming
8666 @cindex incoming mail files
8667 @cindex deleting incoming files
8668 If non-@code{nil}, the mail backends will delete the temporary incoming
8669 file after splitting mail into the proper groups.  This is @code{nil} by
8670 default for reasons of security.
8671
8672 Since Red Gnus is an alpha release, it is to be expected to lose mail.
8673 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8674 lost mail, I think, but that's not the point.)  By not deleting the
8675 Incoming* files, one can be sure to not lose mail -- if Gnus totally
8676 whacks out, one can always recover what was lost.
8677
8678 Delete the @file{Incoming*} files at will.
8679
8680 @item nnmail-use-long-file-names
8681 @vindex nnmail-use-long-file-names
8682 If non-@code{nil}, the mail backends will use long file and directory
8683 names.  Groups like @samp{mail.misc} will end up in directories like
8684 @file{mail.misc/}.  If it is @code{nil}, the same group will end up in
8685 @file{mail/misc/}.
8686
8687 @item nnmail-delete-file-function
8688 @vindex nnmail-delete-file-function
8689 @findex delete-file
8690 Function called to delete files.  It is @code{delete-file} by default. 
8691
8692 @end table
8693
8694
8695 @node Fancy Mail Splitting
8696 @subsection Fancy Mail Splitting
8697 @cindex mail splitting
8698 @cindex fancy mail splitting
8699
8700 @vindex nnmail-split-fancy
8701 @findex nnmail-split-fancy
8702 If the rather simple, standard method for specifying how to split mail
8703 doesn't allow you to do what you want, you can set
8704 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
8705 play with the @code{nnmail-split-fancy} variable.
8706
8707 Let's look at an example value of this variable first:
8708
8709 @lisp
8710 ;; Messages from the mailer daemon are not crossposted to any of
8711 ;; the ordinary groups.  Warnings are put in a separate group
8712 ;; from real errors.
8713 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8714                    "mail.misc"))
8715    ;; Non-error messages are crossposted to all relevant
8716    ;; groups, but we don't crosspost between the group for the
8717    ;; (ding) list and the group for other (ding) related mail.
8718    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8719          ("subject" "ding" "ding.misc"))
8720       ;; Other mailing lists...
8721       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8722       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8723       ;; People...
8724       (any "larsi@@ifi\\.uio\\.no" "people.Lars Magne Ingebrigtsen"))
8725    ;; Unmatched mail goes to the catch all group.
8726    "misc.misc")
8727 @end lisp
8728
8729 This variable has the format of a @dfn{split}.  A split is a (possibly)
8730 recursive structure where each split may contain other splits.  Here are
8731 the five possible split syntaxes:
8732
8733 @enumerate
8734
8735 @item 
8736 @samp{group}: If the split is a string, that will be taken as a group name. 
8737
8738 @item
8739 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
8740 element is a string, then that means that if header FIELD (a regexp)
8741 contains VALUE (also a regexp), then store the message as specified by
8742 SPLIT.
8743
8744 @item
8745 @var{(| SPLIT...)}: If the split is a list, and the first element is
8746 @code{|} (vertical bar), then process each SPLIT until one of them
8747 matches.  A SPLIT is said to match if it will cause the mail message to
8748 be stored in one or more groups.
8749
8750 @item
8751 @var{(& SPLIT...)}: If the split is a list, and the first element is
8752 @code{&}, then process all SPLITs in the list.
8753
8754 @item 
8755 @code{junk}: If the split is the symbol @code{junk}, then don't save
8756 this message anywhere.
8757
8758 @item
8759 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
8760 element is @code{:}, then the second element will be called as a
8761 function with @var{args} given as arguments.  The function should return
8762 a SPLIT.
8763
8764 @end enumerate
8765
8766 In these splits, @var{FIELD} must match a complete field name.
8767 @var{VALUE} must match a complete word according to the fundamental mode
8768 syntax table.  You can use @code{.*} in the regexps to match partial
8769 field names or words.  In other words, all @var{VALUE}'s are wrapped in
8770 @samp{\<} and @samp{\>} pairs.
8771
8772 @vindex nnmail-split-abbrev-alist
8773 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
8774 are expanded as specified by the variable
8775 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
8776 the car of the cells contains the key, and the cdr contains a string.
8777
8778 @vindex nnmail-split-fancy-syntax-table
8779 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
8780 when all this splitting is performed.
8781
8782 If you want to have Gnus create groups dynamically based on some
8783 information in the headers, you can say things like:
8784
8785 @example
8786 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
8787 @end example
8788
8789 That is, do @code{replace-match}-like substitions in the group names. 
8790
8791
8792 @node Mail and Procmail
8793 @subsection Mail and Procmail
8794 @cindex procmail
8795
8796 @cindex slocal
8797 @cindex elm
8798 Many people use @code{procmail} (or some other mail filter program or
8799 external delivery agent---@code{slocal}, @code{elm}, etc) to split
8800 incoming mail into groups.  If you do that, you should set
8801 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
8802 backends never ever try to fetch mail by themselves.
8803
8804 This also means that you probably don't want to set
8805 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
8806 side effects.
8807
8808 When a mail backend is queried for what groups it carries, it replies
8809 with the contents of that variable, along with any groups it has figured
8810 out that it carries by other means.  None of the backends (except
8811 @code{nnmh}) actually go out to the disk and check what groups actually
8812 exist.  (It's not trivial to distinguish between what the user thinks is
8813 a basis for a newsgroup and what is just a plain old file or directory.)
8814
8815 This means that you have to tell Gnus (and the backends) what groups
8816 exist by hand.
8817
8818 Let's take the @code{nnmh} backend as an example. 
8819
8820 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
8821 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
8822
8823 Go to the group buffer and type @kbd{G m}.  When prompted, answer
8824 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
8825 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
8826 to include all your mail groups.
8827
8828 That's it.  You are now set to read your mail.  An active file for this
8829 method will be created automatically.
8830
8831 @vindex nnmail-procmail-suffix
8832 @vindex nnmail-procmail-directory
8833 If you use @code{nnfolder} or any other backend that store more than a
8834 single article in each file, you should never have procmail add mails to
8835 the file that Gnus sees.  Instead, procmail should put all incoming mail
8836 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
8837 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
8838 name.  The mail backends will read the mail from these files.
8839
8840 @vindex nnmail-resplit-incoming
8841 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
8842 put in the @code{mail.misc}, as one would expect.  However, if you want
8843 Gnus to split the mail the normal way, you could set
8844 @code{nnmail-resplit-incoming} to @code{t}.
8845
8846 @vindex nnmail-keep-last-article
8847 If you use @code{procmail} to split things directory into an @code{nnmh}
8848 directory (which you shouldn't do), you should set
8849 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
8850 ever expiring the final article in a mail newsgroup.  This is quite,
8851 quite important.
8852
8853 Here's an example setup:  The incoming spools are located in
8854 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
8855 spool files have the same names as the equivalent groups).  The
8856 @code{nnfolder} backend is to be used as the mail interface, and the
8857 @code{nnfolder} directory is @file{~/fMail/}.
8858
8859 @lisp
8860 (setq nnfolder-directory "~/fMail/")
8861 (setq nnmail-spool-file 'procmail)
8862 (setq nnmail-procmail-directory "~/incoming/")
8863 (setq gnus-secondary-select-methods '((nnfolder "")))
8864 (setq nnmail-procmail-suffix "")
8865 @end lisp
8866
8867
8868 @node Incorporating Old Mail
8869 @subsection Incorporating Old Mail
8870
8871 Most people have lots of old mail stored in various file formats.  If
8872 you have set up Gnus to read mail using one of the spiffy Gnus mail
8873 backends, you'll probably wish to have that old mail incorporated into
8874 your mail groups.
8875
8876 Doing so can be quite easy.
8877
8878 To take an example: You're reading mail using @code{nnml}
8879 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
8880 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
8881 file filled with important, but old, mail.  You want to move it into
8882 your @code{nnml} groups.
8883
8884 Here's how:
8885
8886 @enumerate
8887 @item
8888 Go to the group buffer.
8889
8890 @item 
8891 Type `G f' and give the path of the mbox file when prompted to create an
8892 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
8893
8894 @item 
8895 Type `SPACE' to enter the newly created group.
8896
8897 @item
8898 Type `M P b' to process-mark all articles in this group (@pxref{Setting
8899 Process Marks}).
8900
8901 @item 
8902 Type `B r' to respool all the process-marked articles, and answer
8903 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
8904 @end enumerate
8905
8906 All the mail messages in the mbox file will now also be spread out over
8907 all your @code{nnml} groups.  Try entering them and check whether things
8908 have gone without a glitch.  If things look ok, you may consider
8909 deleting the mbox file, but I wouldn't do that unless I was absolutely
8910 sure that all the mail has ended up where it should be.
8911
8912 Respooling is also a handy thing to do if you're switching from one mail
8913 backend to another.  Just respool all the mail in the old mail groups
8914 using the new mail backend.
8915
8916
8917 @node Expiring Mail
8918 @subsection Expiring Mail
8919 @cindex article expiry
8920
8921 Traditional mail readers have a tendency to remove mail articles when
8922 you mark them as read, in some way.  Gnus takes a fundamentally
8923 different approach to mail reading.
8924
8925 Gnus basically considers mail just to be news that has been received in
8926 a rather peculiar manner.  It does not think that it has the power to
8927 actually change the mail, or delete any mail messages.  If you enter a
8928 mail group, and mark articles as ``read'', or kill them in some other
8929 fashion, the mail articles will still exist on the system.  I repeat:
8930 Gnus will not delete your old, read mail.  Unless you ask it to, of
8931 course.
8932
8933 To make Gnus get rid of your unwanted mail, you have to mark the
8934 articles as @dfn{expirable}.  This does not mean that the articles will
8935 disappear right away, however.  In general, a mail article will be
8936 deleted from your system if, 1) it is marked as expirable, AND 2) it is
8937 more than one week old.  If you do not mark an article as expirable, it
8938 will remain on your system until hell freezes over.  This bears
8939 repeating one more time, with some spurious capitalizations: IF you do
8940 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
8941
8942 @vindex gnus-auto-expirable-newsgroups
8943 You do not have to mark articles as expirable by hand.  Groups that
8944 match the regular expression @code{gnus-auto-expirable-newsgroups} will
8945 have all articles that you read marked as expirable automatically.  All
8946 articles that are marked as expirable have an @samp{E} in the first
8947 column in the summary buffer.
8948
8949 Note that making a group auto-expirable don't mean that all read
8950 articles are expired---only the articles that are marked as expirable
8951 will be expired.  Also note the using the @kbd{d} command won't make
8952 groups expirable---only semi-automatic marking of articles as read will
8953 mark the articles as expirable in auto-expirable groups.
8954
8955 Let's say you subscribe to a couple of mailing lists, and you want the
8956 articles you have read to disappear after a while:
8957
8958 @lisp
8959 (setq gnus-auto-expirable-newsgroups 
8960       "mail.nonsense-list\\|mail.nice-list")
8961 @end lisp
8962
8963 Another way to have auto-expiry happen is to have the element
8964 @code{auto-expire} in the group parameters of the group. 
8965
8966 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
8967 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
8968 doesn't really mix very well.  
8969
8970 @vindex nnmail-expiry-wait
8971 The @code{nnmail-expiry-wait} variable supplies the default time an
8972 expirable article has to live.  The default is seven days.  
8973
8974 Gnus also supplies a function that lets you fine-tune how long articles
8975 are to live, based on what group they are in.  Let's say you want to
8976 have one month expiry period in the @samp{mail.private} group, a one day
8977 expiry period in the @samp{mail.junk} group, and a six day expiry period
8978 everywhere else:
8979
8980 @vindex nnmail-expiry-wait-function
8981 @lisp
8982 (setq nnmail-expiry-wait-function
8983       (lambda (group)
8984        (cond ((string= group "mail.private")
8985                31)
8986              ((string= group "mail.junk")
8987                1)
8988              ((string= group "important")
8989                'never)
8990              (t
8991                6))))
8992 @end lisp
8993
8994 The group names that this function is fed are ``unadorned'' group
8995 names---no @samp{nnml:} prefixes and the like.
8996
8997 The @code{nnmail-expiry-wait} variable and
8998 @code{nnmail-expiry-wait-function} function can be either a number (not
8999 necessarily an integer) or the symbols @code{immediate} or
9000 @code{never}.  
9001
9002 You can also use the @code{expiry-wait} group parameter to selectively
9003 change the expiry period (@pxref{Group Parameters}).
9004
9005 @vindex nnmail-keep-last-article
9006 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9007 expire the final article in a mail newsgroup.  This is to make life
9008 easier for procmail users.
9009
9010 @vindex gnus-total-expirable-newsgroups
9011 By the way, that line up there about Gnus never expiring non-expirable
9012 articles is a lie.  If you put @code{total-expire} in the group
9013 parameters, articles will not be marked as expirable, but all read
9014 articles will be put through the expiry process.  Use with extreme
9015 caution.  Even more dangerous is the
9016 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9017 this regexp will have all read articles put through the expiry process,
9018 which means that @emph{all} old mail articles in the groups in question
9019 will be deleted after a while.  Use with extreme caution, and don't come
9020 crying to me when you discover that the regexp you used matched the
9021 wrong group and all your important mail has disappeared.  Be a
9022 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9023 with!  So there!
9024
9025 Most people make most of their mail groups total-expirable, though. 
9026
9027
9028 @node Washing Mail
9029 @subsection Washing Mail
9030 @cindex mail washing
9031 @cindex list server brain damage
9032 @cindex incoming mail treatment
9033
9034 Mailers and list servers are notorious for doing all sorts of really,
9035 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9036 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9037 end of all lines passing through our server, so let's do that!!!!1!''
9038 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9039 considered to be self-evident were not discussed.  So.  Here we are.
9040
9041 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9042 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9043 be shocked and dismayed by this, but I haven't got the energy.  It is to
9044 laugh.
9045
9046 Gnus provides a plethora of functions for washing articles while
9047 displaying them, but it might be nicer to do the filtering before
9048 storing the mail to disc.  For that purpose, we have three hooks and
9049 various functions that can be put in these hooks.
9050
9051 @table @code
9052 @item nnmail-prepare-incoming-hook
9053 @vindex nnmail-prepare-incoming-hook
9054 This hook is called before doing anything with the mail and is meant for
9055 grand, sweeping gestures.  Functions to be used include:
9056
9057 @table @code
9058 @item nnheader-ms-strip-cr
9059 @findex nnheader-ms-strip-cr
9060 Remove trailing carriage returns from each line.  This is default on
9061 Emacs running on MS machines.
9062
9063 @end table
9064
9065 @item nnmail-prepare-incoming-header-hook
9066 @vindex nnmail-prepare-incoming-header-hook
9067 This hook is called narrowed to each header.  It can be used when
9068 cleaning up the headers.  Functions that can be used include:
9069
9070 @table @code
9071 @item nnmail-remove-leading-whitespace
9072 @findex nnmail-remove-leading-whitespace
9073 Clear leading white space that ``helpful'' listservs have added to the
9074 headers too make them look nice.  Aaah.  
9075
9076 @item nnmail-remove-list-identifiers
9077 @findex nnmail-remove-list-identifiers
9078 Some list servers add an identifier---for example, @samp{(idm)}---to the
9079 beginning of all @code{Subject} headers.  I'm sure that's nice for
9080 people who use stone age mail readers.  This function will remove
9081 strings that match the @code{nnmail-list-identifiers} regexp, which can
9082 also be a list of regexp.
9083
9084 For instance, if you want to remove the @samp{(idm)} and the
9085 @samp{nagnagnag} identifiers:
9086
9087 @lisp
9088 (setq nnmail-list-identifiers
9089       '("(idm)" "nagnagnag"))
9090 @end lisp
9091
9092 @item nnmail-remove-tabs
9093 @findex nnmail-remove-tabs
9094 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9095
9096 @end table
9097
9098 @item nnmail-prepare-incoming-message-hook
9099 @vindex nnmail-prepare-incoming-message-hook
9100 This hook is called narrowed to each message.  Functions to be used
9101 include: 
9102
9103 @table @code
9104 @item article-de-quoted-unreadable
9105 @findex article-de-quoted-unreadable
9106 Decode Quoted Readable encoding.
9107
9108 @end table
9109 @end table
9110
9111
9112 @node Duplicates
9113 @subsection Duplicates
9114
9115 @vindex nnmail-treat-duplicates
9116 @vindex nnmail-message-id-cache-length
9117 @vindex nnmail-message-id-cache-file
9118 @cindex duplicate mails
9119 If you are a member of a couple of mailing list, you will sometime
9120 receive two copies of the same mail.  This can be quite annoying, so
9121 @code{nnmail} checks for and treats any duplicates it might find.  To do
9122 this, it keeps a cache of old @code{Message-ID}s---
9123 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9124 default.  The approximate maximum number of @code{Message-ID}s stored
9125 there is controlled by the @code{nnmail-message-id-cache-length}
9126 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9127 stored.) If all this sounds scary to you, you can set
9128 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9129 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9130 will generate a brand new @code{Message-ID} for the mail and insert a
9131 warning into the head of the mail saying that it thinks that this is a
9132 duplicate of a different message.  
9133
9134 This variable can also be a function.  If that's the case, the function
9135 will be called from a buffer narrowed to the message in question with
9136 the @code{Message-ID} as a parameter.  The function must return either
9137 @code{nil}, @code{warn}, or @code{delete}.
9138
9139 You can turn this feature off completely by setting the variable to
9140 @code{nil}.
9141
9142 If you want all the duplicate mails to be put into a special
9143 @dfn{duplicates} group, you could do that using the normal mail split
9144 methods:
9145
9146 @lisp
9147 (setq nnmail-split-fancy
9148       '(| ;; Messages duplicates go to a separate group.
9149           ("gnus-warning" "duplication of message" "duplicate")
9150           ;; Message from daemons, postmaster, and the like to another.
9151           (any mail "mail.misc")
9152           ;; Other rules.
9153           [ ... ] ))
9154 @end lisp
9155
9156 Or something like:
9157 @lisp
9158 (setq nnmail-split-methods 
9159       '(("duplicates" "^Gnus-Warning:")
9160         ;; Other rules.
9161         [...]))
9162 @end lisp
9163
9164 Here's a neat feature: If you know that the recipient reads her mail
9165 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9166 @code{delete}, you can send her as many insults as you like, just by
9167 using a @code{Message-ID} of a mail that you know that she's already
9168 received.  Think of all the fun!  She'll never see any of it!  Whee!
9169
9170
9171 @node Not Reading Mail
9172 @subsection Not Reading Mail
9173
9174 If you start using any of the mail backends, they have the annoying
9175 habit of assuming that you want to read mail with them.  This might not
9176 be unreasonable, but it might not be what you want.
9177
9178 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9179 will ever attempt to read incoming mail, which should help.
9180
9181 @vindex nnbabyl-get-new-mail
9182 @vindex nnmbox-get-new-mail
9183 @vindex nnml-get-new-mail
9184 @vindex nnmh-get-new-mail
9185 @vindex nnfolder-get-new-mail
9186 This might be too much, if, for instance, you are reading mail quite
9187 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9188 file you have stashed away with @code{nnbabyl}.  All backends have
9189 variables called backend-@code{get-new-mail}.  If you want to disable
9190 the @code{nnbabyl} mail reading, you edit the virtual server for the
9191 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9192
9193 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9194 narrowed to the article to be saved before saving it when reading
9195 incoming mail.
9196
9197
9198 @node Choosing a Mail Backend
9199 @subsection Choosing a Mail Backend
9200
9201 Gnus will read the mail spool when you activate a mail group.  The mail
9202 file is first copied to your home directory.  What happens after that
9203 depends on what format you want to store your mail in.
9204
9205 @menu
9206 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
9207 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
9208 * Mail Spool::                  Store your mail in a private spool?
9209 * MH Spool::                    An mhspool-like backend.
9210 * Mail Folders::                Having one file for each group.
9211 @end menu
9212
9213
9214 @node Unix Mail Box
9215 @subsubsection Unix Mail Box
9216 @cindex nnmbox
9217 @cindex unix mail box
9218
9219 @vindex nnmbox-active-file
9220 @vindex nnmbox-mbox-file
9221 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9222 mail.  @code{nnmbox} will add extra headers to each mail article to say
9223 which group it belongs in.
9224
9225 Virtual server settings:
9226
9227 @table @code
9228 @item nnmbox-mbox-file
9229 @vindex nnmbox-mbox-file
9230 The name of the mail box in the user's home directory. 
9231
9232 @item nnmbox-active-file
9233 @vindex nnmbox-active-file
9234 The name of the active file for the mail box.
9235
9236 @item nnmbox-get-new-mail
9237 @vindex nnmbox-get-new-mail
9238 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9239 into groups.
9240 @end table
9241
9242
9243 @node Rmail Babyl
9244 @subsubsection Rmail Babyl
9245 @cindex nnbabyl
9246 @cindex rmail mbox
9247
9248 @vindex nnbabyl-active-file
9249 @vindex nnbabyl-mbox-file
9250 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9251 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9252 article to say which group it belongs in.
9253
9254 Virtual server settings:
9255
9256 @table @code
9257 @item nnbabyl-mbox-file
9258 @vindex nnbabyl-mbox-file
9259 The name of the rmail mbox file.
9260
9261 @item nnbabyl-active-file
9262 @vindex nnbabyl-active-file
9263 The name of the active file for the rmail box.
9264
9265 @item nnbabyl-get-new-mail
9266 @vindex nnbabyl-get-new-mail
9267 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
9268 @end table
9269
9270
9271 @node Mail Spool
9272 @subsubsection Mail Spool
9273 @cindex nnml
9274 @cindex mail @sc{nov} spool
9275
9276 The @dfn{nnml} spool mail format isn't compatible with any other known
9277 format.  It should be used with some caution.
9278
9279 @vindex nnml-directory
9280 If you use this backend, Gnus will split all incoming mail into files;
9281 one file for each mail, and put the articles into the correct
9282 directories under the directory specified by the @code{nnml-directory}
9283 variable.  The default value is @file{~/Mail/}.
9284
9285 You do not have to create any directories beforehand; Gnus will take
9286 care of all that.
9287
9288 If you have a strict limit as to how many files you are allowed to store
9289 in your account, you should not use this backend.  As each mail gets its
9290 own file, you might very well occupy thousands of inodes within a few
9291 weeks.  If this is no problem for you, and it isn't a problem for you
9292 having your friendly systems administrator walking around, madly,
9293 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9294 know that this is probably the fastest format to use.  You do not have
9295 to trudge through a big mbox file just to read your new mail.
9296
9297 @code{nnml} is probably the slowest backend when it comes to article
9298 splitting.  It has to create lots of files, and it also generates
9299 @sc{nov} databases for the incoming mails.  This makes is the fastest
9300 backend when it comes to reading mail.
9301
9302 Virtual server settings:
9303
9304 @table @code
9305 @item nnml-directory
9306 @vindex nnml-directory
9307 All @code{nnml} directories will be placed under this directory. 
9308
9309 @item nnml-active-file
9310 @vindex nnml-active-file
9311 The active file for the @code{nnml} server.
9312
9313 @item nnml-newsgroups-file
9314 @vindex nnml-newsgroups-file
9315 The @code{nnml} group descriptions file.  @xref{Newsgroups File
9316 Format}. 
9317
9318 @item nnml-get-new-mail
9319 @vindex nnml-get-new-mail
9320 If non-@code{nil}, @code{nnml} will read incoming mail.
9321
9322 @item nnml-nov-is-evil
9323 @vindex nnml-nov-is-evil
9324 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
9325
9326 @item nnml-nov-file-name
9327 @vindex nnml-nov-file-name
9328 The name of the @sc{nov} files.  The default is @file{.overview}. 
9329
9330 @item nnml-prepare-save-mail-hook
9331 @vindex nnml-prepare-save-mail-hook
9332 Hook run narrowed to an article before saving.
9333
9334 @end table
9335
9336 @findex nnml-generate-nov-databases
9337 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9338 you can do a complete update by typing @kbd{M-x
9339 nnml-generate-nov-databases}.  This command will trawl through the
9340 entire @code{nnml} hierarchy, looking at each and every article, so it
9341 might take a while to complete.  A better interface to this
9342 functionality can be found in the server buffer (@pxref{Server
9343 Commands}). 
9344
9345
9346 @node MH Spool
9347 @subsubsection MH Spool
9348 @cindex nnmh
9349 @cindex mh-e mail spool
9350
9351 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9352 @sc{nov} databases and it doesn't keep an active file.  This makes
9353 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9354 makes it easier to write procmail scripts for.
9355
9356 Virtual server settings:
9357
9358 @table @code
9359 @item nnmh-directory
9360 @vindex nnmh-directory
9361 All @code{nnmh} directories will be located under this directory.
9362
9363 @item nnmh-get-new-mail
9364 @vindex nnmh-get-new-mail
9365 If non-@code{nil}, @code{nnmh} will read incoming mail.
9366
9367 @item nnmh-be-safe
9368 @vindex nnmh-be-safe
9369 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9370 sure that the articles in the folder are actually what Gnus thinks they
9371 are.  It will check date stamps and stat everything in sight, so
9372 setting this to @code{t} will mean a serious slow-down.  If you never
9373 use anything but Gnus to read the @code{nnmh} articles, you do not have
9374 to set this variable to @code{t}.
9375 @end table
9376
9377
9378 @node Mail Folders
9379 @subsubsection Mail Folders
9380 @cindex nnfolder
9381 @cindex mbox folders
9382 @cindex mail folders
9383
9384 @code{nnfolder} is a backend for storing each mail group in a separate
9385 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
9386 will add extra headers to keep track of article numbers and arrival
9387 dates.
9388
9389 Virtual server settings:
9390
9391 @table @code
9392 @item nnfolder-directory
9393 @vindex nnfolder-directory
9394 All the @code{nnfolder} mail boxes will be stored under this directory. 
9395
9396 @item nnfolder-active-file
9397 @vindex nnfolder-active-file
9398 The name of the active file.
9399
9400 @item nnfolder-newsgroups-file
9401 @vindex nnfolder-newsgroups-file
9402 The name of the group descriptions file.  @xref{Newsgroups File Format}.
9403
9404 @item nnfolder-get-new-mail
9405 @vindex nnfolder-get-new-mail
9406 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9407 @end table
9408
9409 @findex nnfolder-generate-active-file
9410 @kindex M-x nnfolder-generate-active-file
9411 If you have lots of @code{nnfolder}-like files you'd like to read with
9412 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9413 command to make @code{nnfolder} aware of all likely files in
9414 @code{nnfolder-directory}.
9415
9416
9417 @node Other Sources
9418 @section Other Sources
9419
9420 Gnus can do more than just read news or mail.  The methods described
9421 below allow Gnus to view directories and files as if they were
9422 newsgroups.
9423
9424 @menu
9425 * Directory Groups::      You can read a directory as if it was a newsgroup.
9426 * Anything Groups::       Dired?  Who needs dired?
9427 * Document Groups::       Single files can be the basis of a group.
9428 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
9429 * Web Searches::          Creating groups from articles that match a string.
9430 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9431 @end menu
9432
9433
9434 @node Directory Groups
9435 @subsection Directory Groups
9436 @cindex nndir
9437 @cindex directory groups
9438
9439 If you have a directory that has lots of articles in separate files in
9440 it, you might treat it as a newsgroup.  The files have to have numerical
9441 names, of course.
9442
9443 This might be an opportune moment to mention @code{ange-ftp}, that most
9444 wonderful of all wonderful Emacs packages.  When I wrote @code{nndir}, I
9445 didn't think much about it---a backend to read directories.  Big deal.
9446
9447 @code{ange-ftp} changes that picture dramatically.  For instance, if you
9448 enter the @code{ange-ftp} file name
9449 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9450 @code{ange-ftp} will actually allow you to read this directory over at
9451 @samp{sina} as a newsgroup.  Distributed news ahoy!
9452
9453 @code{nndir} will use @sc{nov} files if they are present.
9454
9455 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9456 articles with this method.  You can use @code{nnmh} or @code{nnml} for
9457 whatever you use @code{nndir} for, so you could switch to any of those
9458 methods if you feel the need to have a non-read-only @code{nndir}.
9459
9460
9461 @node Anything Groups
9462 @subsection Anything Groups
9463 @cindex nneething
9464
9465 From the @code{nndir} backend (which reads a single spool-like
9466 directory), it's just a hop and a skip to @code{nneething}, which
9467 pretends that any arbitrary directory is a newsgroup.  Strange, but
9468 true.
9469
9470 When @code{nneething} is presented with a directory, it will scan this
9471 directory and assign article numbers to each file.  When you enter such
9472 a group, @code{nneething} must create ``headers'' that Gnus can use.
9473 After all, Gnus is a newsreader, in case you're
9474 forgetting. @code{nneething} does this in a two-step process.  First, it
9475 snoops each file in question.  If the file looks like an article (i.e.,
9476 the first few lines look like headers), it will use this as the head.
9477 If this is just some arbitrary file without a head (e.g. a C source
9478 file), @code{nneething} will cobble up a header out of thin air.  It
9479 will use file ownership, name and date and do whatever it can with these
9480 elements.
9481
9482 All this should happen automatically for you, and you will be presented
9483 with something that looks very much like a newsgroup.  Totally like a
9484 newsgroup, to be precise.  If you select an article, it will be displayed
9485 in the article buffer, just as usual.
9486
9487 If you select a line that represents a directory, Gnus will pop you into
9488 a new summary buffer for this @code{nneething} group.  And so on.  You can
9489 traverse the entire disk this way, if you feel like, but remember that
9490 Gnus is not dired, really, and does not intend to be, either.
9491
9492 There are two overall modes to this action---ephemeral or solid.  When
9493 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9494 will not store information on what files you have read, and what files
9495 are new, and so on.  If you create a solid @code{nneething} group the
9496 normal way with @kbd{G m}, Gnus will store a mapping table between
9497 article numbers and file names, and you can treat this group like any
9498 other groups.  When you activate a solid @code{nneething} group, you will
9499 be told how many unread articles it contains, etc., etc.
9500
9501 Some variables:
9502
9503 @table @code
9504 @item nneething-map-file-directory
9505 @vindex nneething-map-file-directory
9506 All the mapping files for solid @code{nneething} groups will be stored
9507 in this directory, which defaults to @file{~/.nneething/}.
9508
9509 @item nneething-exclude-files
9510 @vindex nneething-exclude-files
9511 All files that match this regexp will be ignored.  Nice to use to exclude
9512 auto-save files and the like, which is what it does by default.
9513
9514 @item nneething-map-file
9515 @vindex nneething-map-file
9516 Name of the map files.
9517 @end table
9518
9519
9520 @node Document Groups
9521 @subsection Document Groups
9522 @cindex nndoc
9523 @cindex documentation group
9524 @cindex help group
9525
9526 @code{nndoc} is a cute little thing that will let you read a single file
9527 as a newsgroup.  Several files types are supported:
9528
9529 @table @code
9530 @cindex babyl
9531 @cindex rmail mbox
9532
9533 @item babyl
9534 The babyl (rmail) mail box.
9535 @cindex mbox
9536 @cindex Unix mbox
9537
9538 @item mbox
9539 The standard Unix mbox file.
9540
9541 @cindex MMDF mail box
9542 @item mmdf
9543 The MMDF mail box format.
9544
9545 @item news
9546 Several news articles appended into a file.
9547
9548 @item rnews
9549 @cindex rnews batch files
9550 The rnews batch transport format.
9551 @cindex forwarded messages
9552
9553 @item forward
9554 Forwarded articles.
9555
9556 @item mime-digest
9557 @cindex digest
9558 @cindex MIME digest
9559 @cindex 1153 digest
9560 @cindex RFC 1153 digest
9561 @cindex RFC 341 digest
9562 MIME (RFC 1341) digest format.
9563
9564 @item standard-digest
9565 The standard (RFC 1153) digest format.
9566
9567 @item slack-digest
9568 Non-standard digest format---matches most things, but does it badly. 
9569 @end table
9570
9571 You can also use the special ``file type'' @code{guess}, which means
9572 that @code{nndoc} will try to guess what file type it is looking at.
9573 @code{digest} means that @code{nndoc} should guess what digest type the
9574 file is.
9575
9576 @code{nndoc} will not try to change the file or insert any extra headers into
9577 it---it will simply, like, let you use the file as the basis for a
9578 group.  And that's it.
9579
9580 If you have some old archived articles that you want to insert into your
9581 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9582 that.  Say you have an old @file{RMAIL} file with mail that you now want
9583 to split into your new @code{nnml} groups.  You look at that file using
9584 @code{nndoc} (using the @kbd{G f} command in the group buffer
9585 (@pxref{Foreign Groups})), set the process mark on all the articles in
9586 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9587 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
9588 file is now also stored in lots of @code{nnml} directories, and you can
9589 delete that pesky @file{RMAIL} file.  If you have the guts!
9590
9591 Virtual server variables:
9592
9593 @table @code
9594 @item nndoc-article-type
9595 @vindex nndoc-article-type
9596 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9597 @code{mmdf}, @code{forward}, @code{news}, @code{rnews},
9598 @code{mime-digest}, @code{clari-briefs}, or @code{guess}.
9599
9600 @item nndoc-post-type
9601 @vindex nndoc-post-type
9602 This variable says whether Gnus is to consider the group a news group or
9603 a mail group.  There are two legal values:  @code{mail} (the default)
9604 and @code{news}.
9605 @end table
9606
9607 @menu
9608 * Document Server Internals::   How to add your own document types.
9609 @end menu
9610
9611
9612 @node Document Server Internals
9613 @subsubsection Document Server Internals
9614
9615 Adding new document types to be recognized by @code{nndoc} isn't
9616 difficult.  You just have to whip up a definition of what the document
9617 looks like, write a predicate function to recognize that document type,
9618 and then hook into @code{nndoc}.
9619
9620 First, here's an example document type definition:
9621
9622 @example
9623 (mmdf 
9624  (article-begin .  "^\^A\^A\^A\^A\n")
9625  (body-end .  "^\^A\^A\^A\^A\n"))
9626 @end example
9627
9628 The definition is simply a unique @dfn{name} followed by a series of
9629 regexp pseudo-variable settings.  Below are the possible
9630 variables---don't be daunted by the number of variables; most document
9631 types can be defined with very few settings:
9632
9633 @table @code
9634 @item first-article
9635 If present, @code{nndoc} will skip past all text until it finds
9636 something that match this regexp.  All text before this will be
9637 totally ignored. 
9638
9639 @item article-begin
9640 This setting has to be present in all document type definitions.  It
9641 says what the beginning of each article looks like.
9642
9643 @item head-begin-function
9644 If present, this should be a function that moves point to the head of
9645 the article.
9646
9647 @item nndoc-head-begin
9648 If present, this should be a regexp that matches the head of the
9649 article. 
9650
9651 @item nndoc-head-end
9652 This should match the end of the head of the article.  It defaults to
9653 @samp{^$}---the empty line.
9654
9655 @item body-begin-function
9656 If present, this function should move point to the beginning of the body
9657 of the article.
9658
9659 @item body-begin
9660 This should match the beginning of the body of the article.  It defaults
9661 to @samp{^\n}.
9662
9663 @item body-end-function
9664 If present, this function should move point to the end of the body of
9665 the article.
9666
9667 @item body-end
9668 If present, this should match the end of the body of the article.
9669
9670 @item nndoc-file-end
9671 If present, this should match the end of the file.  All text after this
9672 regexp will be totally ignored. 
9673
9674 @end table
9675
9676 So, using these variables @code{nndoc} is able to dissect a document
9677 file into a series of articles, each with a head and a body.  However, a
9678 few more variables are needed since not all document types are all that
9679 news-like---variables needed to transform the head or the body into
9680 something that's palatable for Gnus:
9681
9682 @table @code
9683 @item prepare-body-function
9684 If present, this function will be called when requesting an article.  It
9685 will be called with point at the start of the body, and is useful if the
9686 document has encoded some parts of its contents. 
9687
9688 @item article-transform-function
9689 If present, this function is called when requesting an article.  It's
9690 meant to be used how more wide-ranging transformation of both head and
9691 body of the article.
9692
9693 @item generate-head-function
9694 If present, this function is called to generate a head that Gnus can
9695 understand.  It is called with the article number as a parameter, and is
9696 expected to generate a nice head for the article in question.  It is
9697 called when requesting the headers of all articles.
9698
9699 @end table
9700
9701 Let's look at the most complicated example I can come up with---standard
9702 digests:
9703
9704 @example
9705 (standard-digest
9706  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9707  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9708  (prepare-body-function . nndoc-unquote-dashes)
9709  (body-end-function . nndoc-digest-body-end)
9710  (head-end . "^ ?$")
9711  (body-begin . "^ ?\n")
9712  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
9713  (subtype digest guess))
9714 @end example
9715
9716 We see that all text before a 70-width line of dashes is ignored; all
9717 text after a line that starts with that @samp{^End of} is also ignored;
9718 each article begins with a 30-width line of dashes; the line separating
9719 the head from the body may contain a single space; and that the body is
9720 run through @code{nndoc-unquote-dashes} before being delivered.
9721
9722 To hook your own document definition into @code{nndoc}, use the
9723 @code{nndoc-add-type} function.  It takes two parameters---the first is
9724 the definition itself and the second (optional) parameter says where in
9725 the document type definition alist to put this definition.  The alist is
9726 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
9727 type.  So @code{nndoc-mmdf-type-p} is called to see whether a document
9728 is of @code{mmdf} type, and so on.  These type predicates should return
9729 @code{nil} if the document is not of the correct type; @code{t} if it is
9730 of the correct type; and a number if the document might be of the
9731 correct type.  A high number means high probability; a low number means
9732 low probability with @samp{0} being the lowest legal number.
9733
9734
9735 @node SOUP
9736 @subsection SOUP
9737 @cindex SOUP
9738 @cindex offline
9739
9740 In the PC world people often talk about ``offline'' newsreaders.  These
9741 are thingies that are combined reader/news transport monstrosities.
9742 With built-in modem programs.  Yecchh!
9743
9744 Of course, us Unix Weenie types of human beans use things like
9745 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
9746 transport things like Ghod intended.  And then we just use normal
9747 newsreaders.  
9748
9749 However, it can sometimes be convenient to do something a that's a bit
9750 easier on the brain if you have a very slow modem, and you're not really
9751 that interested in doing things properly.  
9752
9753 A file format called @sc{soup} has been developed for transporting news
9754 and mail from servers to home machines and back again.  It can be a bit
9755 fiddly.
9756
9757 First some terminology:
9758
9759 @table @dfn
9760
9761 @item server
9762 This is the machine that is connected to the outside world and where you
9763 get news and/or mail from.
9764
9765 @item home machine
9766 This is the machine that you want to do the actual reading and responding
9767 on.  It is typically not connected to the rest of the world in any way.
9768
9769 @item packet
9770 Something that contains messages and/or commands.  There are two kinds
9771 of packets:
9772
9773 @table @dfn
9774 @item message packets
9775 These are packets made at the server, and typically contains lots of
9776 messages for you to read.  These are called @file{SoupoutX.tgz} by
9777 default, where @var{X} is a number.
9778
9779 @item response packets
9780 These are packets made at the home machine, and typically contains
9781 replies that you've written.  These are called @file{SoupinX.tgz} by
9782 default, where @var{X} is a number.
9783
9784 @end table
9785
9786 @end table
9787
9788
9789 @enumerate
9790
9791 @item
9792 You log in on the server and create a @sc{soup} packet.  You can either
9793 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
9794 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
9795 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
9796
9797 @item 
9798 You transfer the packet home.  Rail, boat, car or modem will do fine.
9799
9800 @item
9801 You put the packet in your home directory.
9802
9803 @item
9804 You fire up Gnus on your home machine using the @code{nnsoup} backend as
9805 the native or secondary server.
9806
9807 @item
9808 You read articles and mail and answer and followup to the things you
9809 want (@pxref{SOUP Replies}).
9810
9811 @item 
9812 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
9813 packet.
9814
9815 @item 
9816 You transfer this packet to the server.  
9817
9818 @item
9819 You use Gnus to mail this packet out with the @kbd{G s s} command.
9820
9821 @item
9822 You then repeat until you die.
9823
9824 @end enumerate
9825
9826 So you basically have a bipartite system---you use @code{nnsoup} for
9827 reading and Gnus for packing/sending these @sc{soup} packets.
9828
9829 @menu
9830 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
9831 * SOUP Groups::       A backend for reading @sc{soup} packets.
9832 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
9833 @end menu
9834
9835
9836 @node SOUP Commands
9837 @subsubsection SOUP Commands
9838
9839 These are commands for creating and manipulating @sc{soup} packets.
9840
9841 @table @kbd
9842 @item G s b
9843 @kindex G s b (Group)
9844 @findex gnus-group-brew-soup
9845 Pack all unread articles in the current group
9846 (@code{gnus-group-brew-soup}).  This command understands the
9847 process/prefix convention.
9848
9849 @item G s w
9850 @kindex G s w (Group)
9851 @findex gnus-soup-save-areas
9852 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
9853
9854 @item G s s
9855 @kindex G s s (Group)
9856 @findex gnus-soup-send-replies
9857 Send all replies from the replies packet
9858 (@code{gnus-soup-send-replies}). 
9859
9860 @item G s p
9861 @kindex G s p (Group)
9862 @findex gnus-soup-pack-packet
9863 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
9864
9865 @item G s r
9866 @kindex G s r (Group)
9867 @findex nnsoup-pack-replies
9868 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
9869
9870 @item O s
9871 @kindex O s (Summary)
9872 @findex gnus-soup-add-article
9873 This summary-mode command adds the current article to a @sc{soup} packet
9874 (@code{gnus-soup-add-article}).  It understands the process/prefix
9875 convention (@pxref{Process/Prefix}). 
9876
9877 @end table
9878
9879
9880 There are a few variables to customize where Gnus will put all these
9881 thingies:  
9882
9883 @table @code
9884
9885 @item gnus-soup-directory
9886 @vindex gnus-soup-directory
9887 Directory where Gnus will save intermediate files while composing
9888 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
9889
9890 @item gnus-soup-replies-directory
9891 @vindex gnus-soup-replies-directory
9892 This is what Gnus will use as a temporary directory while sending our
9893 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
9894
9895 @item gnus-soup-prefix-file
9896 @vindex gnus-soup-prefix-file
9897 Name of the file where Gnus stores the last used prefix.  The default is
9898 @samp{gnus-prefix}. 
9899
9900 @item gnus-soup-packer
9901 @vindex gnus-soup-packer
9902 A format string command for packing a @sc{soup} packet.  The default is
9903 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
9904
9905 @item gnus-soup-unpacker
9906 @vindex gnus-soup-unpacker
9907 Format string command for unpacking a @sc{soup} packet.  The default is
9908 @samp{gunzip -c %s | tar xvf -}.
9909
9910 @item gnus-soup-packet-directory
9911 @vindex gnus-soup-packet-directory
9912 Where Gnus will look for reply packets.  The default is @file{~/}. 
9913
9914 @item gnus-soup-packet-regexp
9915 @vindex gnus-soup-packet-regexp
9916 Regular expression matching @sc{soup} reply packets in
9917 @code{gnus-soup-packet-directory}. 
9918
9919 @end table
9920  
9921
9922 @node SOUP Groups
9923 @subsubsection @sc{soup} Groups
9924 @cindex nnsoup
9925
9926 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
9927 read incoming packets, unpack them, and put them in a directory where
9928 you can read them at leisure.
9929
9930 These are the variables you can use to customize its behavior:
9931
9932 @table @code
9933
9934 @item nnsoup-tmp-directory
9935 @vindex nnsoup-tmp-directory
9936 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
9937 directory.  (@file{/tmp/} by default.)  
9938
9939 @item nnsoup-directory
9940 @vindex nnsoup-directory
9941 @code{nnsoup} then moves each message and index file to this directory.
9942 The default is @file{~/SOUP/}.
9943
9944 @item nnsoup-replies-directory 
9945 @vindex nnsoup-replies-directory 
9946 All replies will stored in this directory before being packed into a
9947 reply packet.  The default is @file{~/SOUP/replies/"}.
9948
9949 @item nnsoup-replies-format-type
9950 @vindex nnsoup-replies-format-type
9951 The @sc{soup} format of the replies packets.  The default is @samp{?n}
9952 (rnews), and I don't think you should touch that variable.  I probably
9953 shouldn't even have documented it.  Drats!  Too late!
9954
9955 @item nnsoup-replies-index-type
9956 @vindex nnsoup-replies-index-type
9957 The index type of the replies packet.  The is @samp{?n}, which means
9958 ``none''.  Don't fiddle with this one either!
9959
9960 @item nnsoup-active-file
9961 @vindex nnsoup-active-file
9962 Where @code{nnsoup} stores lots of information.  This is not an ``active
9963 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
9964 this file or mess it up in any way, you're dead.  The default is
9965 @file{~/SOUP/active}.
9966
9967 @item nnsoup-packer
9968 @vindex nnsoup-packer
9969 Format string command for packing a reply @sc{soup} packet.  The default
9970 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
9971
9972 @item nnsoup-unpacker
9973 @vindex nnsoup-unpacker
9974 Format string command for unpacking incoming @sc{soup} packets.  The
9975 default is @samp{gunzip -c %s | tar xvf -}. 
9976
9977 @item nnsoup-packet-directory
9978 @vindex nnsoup-packet-directory
9979 Where @code{nnsoup} will look for incoming packets.  The default is
9980 @file{~/}.  
9981
9982 @item nnsoup-packet-regexp
9983 @vindex nnsoup-packet-regexp
9984 Regular expression matching incoming @sc{soup} packets.  The default is
9985 @samp{Soupout}. 
9986
9987 @end table
9988
9989
9990 @node SOUP Replies
9991 @subsubsection SOUP Replies
9992
9993 Just using @code{nnsoup} won't mean that your postings and mailings end
9994 up in @sc{soup} reply packets automagically.  You have to work a bit
9995 more for that to happen.
9996
9997 @findex nnsoup-set-variables
9998 The @code{nnsoup-set-variables} command will set the appropriate
9999 variables to ensure that all your followups and replies end up in the
10000 @sc{soup} system.
10001
10002 In specific, this is what it does:
10003
10004 @lisp
10005 (setq message-send-news-function 'nnsoup-request-post)
10006 (setq message-send-mail-function 'nnsoup-request-mail)
10007 @end lisp
10008
10009 And that's it, really.  If you only want news to go into the @sc{soup}
10010 system you just use the first line.  If you only want mail to be
10011 @sc{soup}ed you use the second.
10012
10013
10014 @node Web Searches
10015 @subsection Web Searches
10016 @cindex nnweb
10017 @cindex DejaNews
10018 @cindex Alta Vista
10019 @cindex InReference
10020 @cindex Usenet searches
10021 @cindex searching the Usenet
10022
10023 It's, like, too neat to search the Usenet for articles that match a
10024 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10025 those, like, Web browsers, and you, like, have to, rilly, like, look at
10026 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10027 searches without having to use a browser.
10028
10029 The @code{nnweb} backend allows an easy interface to the mighty search
10030 engine.  You create an @code{nnweb} group, enter a search pattern, and
10031 then enter the group and read the articles like you would any normal
10032 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10033 Groups}) will do this in an easy-to-use fashion.
10034
10035 @code{nnweb} groups don't really lend themselves to being solid
10036 groups---they have a very fleeting idea of article numbers.  In fact,
10037 each time you enter an @code{nnweb} group (not even changing the search
10038 pattern), you are likely to get the articles ordered in a different
10039 manner.  Not even using duplicate suppression (@code{Duplicate
10040 Suppression}) will help, since @code{nnweb} doesn't even know the
10041 @code{Message-ID} of the articles before reading them using some search
10042 engines (DejaNews, for instance).  The only possible way to keep track
10043 of which articles you've read is by scoring on the @code{Date}
10044 header---mark all articles that were posted before the last date you
10045 read the group as read.
10046
10047 If the search engine changes its output substantially, @code{nnweb}
10048 won't be able to parse it and will fail.  One could hardly fault the Web
10049 providers if they were to do this---their @emph{raison d'être} is to
10050 make money off of advertisements, not to provide services to the
10051 community.  Since @code{nnweb} washes the ads off all the articles, one
10052 might think that the providers might be somewhat miffed.  We'll see.
10053
10054 You must have the @code{url} and @code{w3} package installed to be able
10055 to use @code{nnweb}.
10056
10057 Virtual server variables:
10058
10059 @table @code
10060 @item nnweb-type
10061 @vindex nnweb-type
10062 What search engine type is being used.  The currently supported types
10063 are @code{dejanews}, @code{altavista} and @code{reference}.
10064
10065 @item nnweb-search
10066 @vindex nnweb-search
10067 The search string to feed to the search engine.
10068
10069 @item nnweb-max-hits
10070 @vindex nnweb-max-hits
10071 Advisory maximum number of hits per search to display.  The default is
10072 100.
10073
10074 @item nnweb-type-definition
10075 @vindex nnweb-type-definition
10076 Type-to-definition alist.  This alist says what @code{nnweb} should do
10077 with the various search engine types.  The following elements must be
10078 present: 
10079
10080 @table @code
10081 @item article
10082 Function to decode the article and provide something that Gnus
10083 understands. 
10084
10085 @item map
10086 Function to create an article number to message header and URL alist. 
10087
10088 @item search
10089 Function to send the search string to the search engine.
10090
10091 @item address
10092 The address the aforementioned function should send the search string
10093 to. 
10094
10095 @item id
10096 Format string URL to fetch an article by @code{Message-ID}.
10097 @end table
10098
10099 @end table
10100
10101
10102
10103 @node Mail-To-News Gateways
10104 @subsection Mail-To-News Gateways
10105 @cindex mail-to-news gateways
10106 @cindex gateways
10107
10108 If your local @code{nntp} server doesn't allow posting, for some reason
10109 or other, you can post using one of the numerous mail-to-news gateways.
10110 The @code{nngateway} backend provides the interface.
10111
10112 Note that you can't read anything from this backend---it can only be
10113 used to post with.
10114
10115 Server variables:
10116
10117 @table @code
10118 @item nngateway-address 
10119 @vindex nngateway-address 
10120 This is the address of the mail-to-news gateway.
10121
10122 @item nngateway-header-transformation
10123 @vindex nngateway-header-transformation
10124 News headers have often have to be transformed in some odd way or other
10125 for the mail-to-news gateway to accept it.  This variable says what 
10126 transformation should be called, and defaults to
10127 @code{nngateway-simple-header-transformation}.  The function is called
10128 narrowed to the headers to be transformed and with one parameter---the
10129 gateway address.
10130
10131 This default function just inserts a new @code{To} header based on the
10132 @code{Newsgroups} header and the gateway address---an article with this
10133 @code{Newsgroups} header:
10134
10135 @example
10136 Newsgroups: alt.religion.emacs
10137 @end example
10138
10139 will get this @code{From} header inserted:
10140
10141 @example
10142 To: alt-religion-emacs@@GATEWAY
10143 @end example
10144
10145 @end table
10146
10147 So, to use this, simply say something like:
10148
10149 @lisp
10150 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10151 @end lisp
10152
10153
10154 @node Combined Groups
10155 @section Combined Groups
10156
10157 Gnus allows combining a mixture of all the other group types into bigger
10158 groups.
10159
10160 @menu
10161 * Virtual Groups::     Combining articles from many groups.
10162 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10163 @end menu
10164
10165
10166 @node Virtual Groups
10167 @subsection Virtual Groups
10168 @cindex nnvirtual
10169 @cindex virtual groups
10170
10171 An @dfn{nnvirtual group} is really nothing more than a collection of
10172 other groups.
10173
10174 For instance, if you are tired of reading many small group, you can
10175 put them all in one big group, and then grow tired of reading one
10176 big, unwieldy group.  The joys of computing!
10177
10178 You specify @code{nnvirtual} as the method.  The address should be a
10179 regexp to match component groups.
10180
10181 All marks in the virtual group will stick to the articles in the
10182 component groups.  So if you tick an article in a virtual group, the
10183 article will also be ticked in the component group from whence it came.
10184 (And vice versa---marks from the component groups will also be shown in
10185 the virtual group.)
10186
10187 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10188 newsgroups into one, big, happy newsgroup:
10189
10190 @lisp
10191 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10192 @end lisp
10193
10194 The component groups can be native or foreign; everything should work
10195 smoothly, but if your computer explodes, it was probably my fault.
10196
10197 Collecting the same group from several servers might actually be a good
10198 idea if users have set the Distribution header to limit distribution.
10199 If you would like to read @samp{soc.motss} both from a server in Japan
10200 and a server in Norway, you could use the following as the group regexp:
10201
10202 @example
10203 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10204 @end example
10205
10206 This should work kinda smoothly---all articles from both groups should
10207 end up in this one, and there should be no duplicates.  Threading (and
10208 the rest) will still work as usual, but there might be problems with the
10209 sequence of articles.  Sorting on date might be an option here
10210 (@pxref{Selecting a Group}.
10211
10212 One limitation, however---all groups that are included in a virtual
10213 group has to be alive (i.e., subscribed or unsubscribed).  Killed or
10214 zombie groups can't be component groups for @code{nnvirtual} groups.
10215
10216 @vindex nnvirtual-always-rescan
10217 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10218 @code{nnvirtual} will always scan groups for unread articles when
10219 entering a virtual group.  If this variable is @code{nil} (which is the
10220 default) and you read articles in a component group after the virtual
10221 group has been activated, the read articles from the component group
10222 will show up when you enter the virtual group.  You'll also see this
10223 effect if you have two virtual groups that contain the same component
10224 group.  If that's the case, you should set this variable to @code{t}.
10225 Or you can just tap @code{M-g} on the virtual group every time before
10226 you enter it---it'll have much the same effect.
10227
10228
10229 @node Kibozed Groups
10230 @subsection Kibozed Groups
10231 @cindex nnkiboze
10232 @cindex kibozing
10233
10234 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10235 the news feed''.  @code{nnkiboze} is a backend that will do this for
10236 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
10237 with useless requests!  Oh happiness!
10238
10239 @kindex G k (Group)
10240 To create a kibozed group, use the @kbd{G k} command in the group
10241 buffer. 
10242
10243 The address field of the @code{nnkiboze} method is, as with
10244 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10245 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
10246 and @code{nnvirtual} ends.
10247
10248 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10249 must have a score file to say what articles that are to be included in
10250 the group (@pxref{Scoring}).
10251
10252 @kindex M-x nnkiboze-generate-groups
10253 @findex nnkiboze-generate-groups
10254 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10255 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
10256 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
10257 all the articles in all the components groups and run them through the
10258 scoring process to determine if there are any articles in the groups
10259 that are to be part of the @code{nnkiboze} groups.
10260
10261 Please limit the number of component groups by using restrictive
10262 regexps.  Otherwise your sysadmin may become annoyed with you, and the
10263 @sc{nntp} site may throw you off and never let you back in again.
10264 Stranger things have happened.
10265
10266 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10267 and they can be foreign.  No restrictions.
10268
10269 @vindex nnkiboze-directory
10270 The generation of an @code{nnkiboze} group means writing two files in
10271 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
10272 contains the @sc{nov} header lines for all the articles in the group,
10273 and the other is an additional @file{.newsrc} file to store information
10274 on what groups that have been searched through to find component
10275 articles.
10276
10277 Articles that are marked as read in the @code{nnkiboze} group will have their
10278 @sc{nov} lines removed from the @sc{nov} file.
10279
10280
10281 @node Scoring
10282 @chapter Scoring
10283 @cindex scoring
10284
10285 Other people use @dfn{kill files}, but we here at Gnus Towers like
10286 scoring better than killing, so we'd rather switch than fight.  They do
10287 something completely different as well, so sit up straight and pay
10288 attention!
10289
10290 @vindex gnus-summary-mark-below
10291 All articles have a default score (@code{gnus-summary-default-score}),
10292 which is 0 by default.  This score may be raised or lowered either
10293 interactively or by score files.  Articles that have a score lower than
10294 @code{gnus-summary-mark-below} are marked as read.
10295
10296 Gnus will read any @dfn{score files} that apply to the current group
10297 before generating the summary buffer.
10298
10299 There are several commands in the summary buffer that insert score
10300 entries based on the current article.  You can, for instance, ask Gnus to
10301 lower or increase the score of all articles with a certain subject.
10302
10303 There are two sorts of scoring entries: Permanent and temporary.
10304 Temporary score entries are self-expiring entries.  Any entries that are
10305 temporary and have not been used for, say, a week, will be removed
10306 silently to help keep the sizes of the score files down.
10307
10308 @menu 
10309 * Summary Score Commands::   Adding score entries for the current group.
10310 * Group Score Commands::     General score commands.
10311 * Score Variables::          Customize your scoring.  (My, what terminology).
10312 * Score File Format::        What a score file may contain.
10313 * Score File Editing::       You can edit score files by hand as well.
10314 * Adaptive Scoring::         Big Sister Gnus knows what you read.
10315 * Home Score File::          How to say where new score entries are to go.
10316 * Followups To Yourself::    Having Gnus notice when people answer you.
10317 * Scoring Tips::             How to score effectively.
10318 * Reverse Scoring::          That problem child of old is not problem.
10319 * Global Score Files::       Earth-spanning, ear-splitting score files.
10320 * Kill Files::               They are still here, but they can be ignored.
10321 * Converting Kill Files::    Translating kill files to score files.
10322 * GroupLens::                Getting predictions on what you like to read.
10323 * Advanced Scoring::         Using logical expressions to build score rules.
10324 * Score Decays::             It can be useful to let scores wither away.
10325 @end menu
10326
10327
10328 @node Summary Score Commands
10329 @section Summary Score Commands
10330 @cindex score commands
10331
10332 The score commands that alter score entries do not actually modify real
10333 score files.  That would be too inefficient.  Gnus maintains a cache of
10334 previously loaded score files, one of which is considered the
10335 @dfn{current score file alist}.  The score commands simply insert
10336 entries into this list, and upon group exit, this list is saved.
10337
10338 The current score file is by default the group's local score file, even
10339 if no such score file actually exists.  To insert score commands into
10340 some other score file (e.g. @file{all.SCORE}), you must first make this
10341 score file the current one.
10342
10343 General score commands that don't actually change the score file:
10344
10345 @table @kbd
10346
10347 @item V s
10348 @kindex V s (Summary)
10349 @findex gnus-summary-set-score
10350 Set the score of the current article (@code{gnus-summary-set-score}).  
10351
10352 @item V S
10353 @kindex V S (Summary)
10354 @findex gnus-summary-current-score
10355 Display the score of the current article
10356 (@code{gnus-summary-current-score}).   
10357
10358 @item V t
10359 @kindex V t (Summary)
10360 @findex gnus-score-find-trace
10361 Display all score rules that have been used on the current article
10362 (@code{gnus-score-find-trace}).   
10363
10364 @item V R
10365 @kindex V R (Summary)
10366 @findex gnus-summary-rescore
10367 Run the current summary through the scoring process
10368 (@code{gnus-summary-rescore}).  This might be useful if you're playing
10369 around with your score files behind Gnus' back and want to see the
10370 effect you're having.
10371
10372 @item V a
10373 @kindex V a (Summary)
10374 @findex gnus-summary-score-entry
10375 Add a new score entry, and allow specifying all elements 
10376 (@code{gnus-summary-score-entry}).
10377
10378 @item V c
10379 @kindex V c (Summary)
10380 @findex gnus-score-change-score-file
10381 Make a different score file the current
10382 (@code{gnus-score-change-score-file}). 
10383
10384 @item V e
10385 @kindex V e (Summary)
10386 @findex gnus-score-edit-current-scores
10387 Edit the current score file (@code{gnus-score-edit-current-scores}).
10388 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10389 File Editing}).
10390
10391 @item V f
10392 @kindex V f (Summary)
10393 @findex gnus-score-edit-file
10394 Edit a score file and make this score file the current one
10395 (@code{gnus-score-edit-file}).
10396
10397 @item V F
10398 @kindex V F (Summary)
10399 @findex gnus-score-flush-cache
10400 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
10401 after editing score files.
10402
10403 @item V C
10404 @kindex V C (Summary)
10405 @findex gnus-score-customize
10406 Customize a score file in a visually pleasing manner
10407 (@code{gnus-score-customize}). 
10408
10409 @item I C-i
10410 @kindex I C-i (Summary)
10411 @findex gnus-summary-raise-score
10412 Increase the score of the current article
10413 (@code{gnus-summary-raise-score}).
10414
10415 @item L C-l
10416 @kindex L C-l (Summary)
10417 @findex gnus-summary-lower-score
10418 Lower the score of the current article
10419 (@code{gnus-summary-lower-score}). 
10420 @end table
10421
10422 The rest of these commands modify the local score file.
10423
10424 @table @kbd
10425
10426 @item V m
10427 @kindex V m (Summary)
10428 @findex gnus-score-set-mark-below
10429 Prompt for a score, and mark all articles with a score below this as
10430 read (@code{gnus-score-set-mark-below}).
10431
10432 @item V x
10433 @kindex V x (Summary)
10434 @findex gnus-score-set-expunge-below
10435 Prompt for a score, and add a score rule to the current score file to
10436 expunge all articles below this score
10437 (@code{gnus-score-set-expunge-below}).
10438 @end table
10439
10440 The keystrokes for actually making score entries follow a very regular
10441 pattern, so there's no need to list all the commands.  (Hundreds of
10442 them.)  
10443
10444 @enumerate
10445 @item
10446 The first key is either @kbd{I} (upper case i) for increasing the score
10447 or @kbd{L} for lowering the score. 
10448 @item
10449 The second key says what header you want to score on.  The following
10450 keys are available:
10451 @table @kbd
10452
10453 @item a
10454 Score on the author name.
10455
10456 @item s
10457 Score on the subject line.
10458
10459 @item x
10460 Score on the Xref line---i.e., the cross-posting line.
10461
10462 @item t
10463 Score on thread---the References line.
10464
10465 @item d
10466 Score on the date.
10467
10468 @item l
10469 Score on the number of lines.
10470
10471 @item i
10472 Score on the Message-ID.
10473
10474 @item f
10475 Score on followups.
10476
10477 @item b
10478 Score on the body.
10479
10480 @item h
10481 Score on the head.
10482 @end table
10483
10484 @item
10485 The third key is the match type.  Which match types are legal depends on
10486 what headers you are scoring on.
10487
10488 @table @code
10489
10490 @item strings 
10491
10492 @table @kbd
10493
10494 @item e
10495 Exact matching.
10496
10497 @item s
10498 Substring matching.
10499
10500 @item f
10501 Fuzzy matching.
10502
10503 @item r
10504 Regexp matching
10505 @end table
10506
10507 @item date
10508 @table @kbd
10509
10510 @item b
10511 Before date.
10512
10513 @item a
10514 At date.
10515
10516 @item n
10517 This date.
10518 @end table
10519
10520 @item number
10521 @table @kbd
10522
10523 @item <
10524 Less than number.
10525
10526 @item =
10527 Equal to number.
10528
10529 @item >
10530 Greater than number.
10531 @end table
10532 @end table
10533
10534 @item 
10535 The fourth and final key says whether this is a temporary (i.e., expiring)
10536 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10537 it is to be done immediately, without adding to the score file.
10538 @table @kbd
10539
10540 @item t
10541 Temporary score entry.
10542
10543 @item p
10544 Permanent score entry.
10545
10546 @item i
10547 Immediately scoring.
10548 @end table
10549
10550 @end enumerate
10551
10552 So, let's say you want to increase the score on the current author with
10553 exact matching permanently: @kbd{I a e p}.  If you want to lower the
10554 score based on the subject line, using substring matching, and make a
10555 temporary score entry: @kbd{L s s t}.  Pretty easy.
10556
10557 To make things a bit more complicated, there are shortcuts.  If you use
10558 a capital letter on either the second or third keys, Gnus will use
10559 defaults for the remaining one or two keystrokes.  The defaults are
10560 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
10561 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10562
10563 @vindex gnus-score-mimic-keymap
10564 The @code{gnus-score-mimic-keymap} says whether these commands will
10565 pretend they are keymaps or not.
10566
10567
10568 @node Group Score Commands
10569 @section Group Score Commands
10570 @cindex group score commands
10571
10572 There aren't many of these as yet, I'm afraid.
10573
10574 @table @kbd
10575
10576 @item W f
10577 @kindex W f (Group)
10578 @findex gnus-score-flush-cache
10579 Gnus maintains a cache of score alists to avoid having to reload them
10580 all the time.  This command will flush the cache
10581 (@code{gnus-score-flush-cache}). 
10582
10583 @end table
10584
10585
10586 @node Score Variables
10587 @section Score Variables
10588 @cindex score variables
10589
10590 @table @code
10591
10592 @item gnus-use-scoring
10593 @vindex gnus-use-scoring
10594 If @code{nil}, Gnus will not check for score files, and will not, in
10595 general, do any score-related work.  This is @code{t} by default.
10596
10597 @item gnus-kill-killed
10598 @vindex gnus-kill-killed
10599 If this variable is @code{nil}, Gnus will never apply score files to
10600 articles that have already been through the kill process.  While this
10601 may save you lots of time, it also means that if you apply a kill file
10602 to a group, and then change the kill file and want to run it over you
10603 group again to kill more articles, it won't work.  You have to set this
10604 variable to @code{t} to do that.  (It is @code{t} by default.)
10605
10606 @item gnus-kill-files-directory
10607 @vindex gnus-kill-files-directory
10608 All kill and score files will be stored in this directory, which is
10609 initialized from the @code{SAVEDIR} environment variable by default.
10610 This is @file{~/News/} by default.
10611
10612 @item gnus-score-file-suffix
10613 @vindex gnus-score-file-suffix
10614 Suffix to add to the group name to arrive at the score file name
10615 (@samp{SCORE} by default.)
10616
10617 @item gnus-score-uncacheable-files
10618 @vindex gnus-score-uncacheable-files
10619 @cindex score cache
10620 All score files are normally cached to avoid excessive re-loading of
10621 score files.  However, if this might make you Emacs grow big and
10622 bloated, so this regexp can be used to weed out score files that are
10623 unlikely to be needed again.  It would be a bad idea to deny caching of
10624 @file{all.SCORE}, while it might be a good idea to not cache
10625 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
10626 variable is @samp{ADAPT$} by default, so no adaptive score files will
10627 be cached.
10628
10629 @item gnus-save-score
10630 @vindex gnus-save-score
10631 If you have really complicated score files, and do lots of batch
10632 scoring, then you might set this variable to @code{t}.  This will make
10633 Gnus save the scores into the @file{.newsrc.eld} file.
10634
10635 @item gnus-score-interactive-default-score
10636 @vindex gnus-score-interactive-default-score
10637 Score used by all the interactive raise/lower commands to raise/lower
10638 score with.  Default is 1000, which may seem excessive, but this is to
10639 ensure that the adaptive scoring scheme gets enough room to play with.
10640 We don't want the small changes from the adaptive scoring to overwrite
10641 manually entered data.
10642
10643 @item gnus-summary-default-score
10644 @vindex gnus-summary-default-score
10645 Default score of an article, which is 0 by default.
10646
10647 @item gnus-score-over-mark
10648 @vindex gnus-score-over-mark
10649 Mark (in the third column) used for articles with a score over the
10650 default.  Default is @samp{+}.
10651
10652 @item gnus-score-below-mark
10653 @vindex gnus-score-below-mark
10654 Mark (in the third column) used for articles with a score below the
10655 default.  Default is @samp{-}.
10656
10657 @item gnus-score-find-score-files-function
10658 @vindex gnus-score-find-score-files-function
10659 Function used to find score files for the current group.  This function
10660 is called with the name of the group as the argument. 
10661
10662 Predefined functions available are:
10663 @table @code
10664
10665 @item gnus-score-find-single
10666 @findex gnus-score-find-single
10667 Only apply the group's own score file.
10668
10669 @item gnus-score-find-bnews
10670 @findex gnus-score-find-bnews
10671 Apply all score files that match, using bnews syntax.  This is the
10672 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
10673 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10674 @file{gnu.all.SCORE} would all apply.  In short, the instances of
10675 @samp{all} in the score file names are translated into @samp{.*}, and
10676 then a regexp match is done.
10677
10678 This means that if you have some score entries that you want to apply to
10679 all groups, then you put those entries in the @file{all.SCORE} file. 
10680
10681 The score files are applied in a semi-random order, although Gnus will
10682 try to apply the more general score files before the more specific score
10683 files.  It does this by looking at the number of elements in the score
10684 file names---discarding the @samp{all} elements.
10685
10686 @item gnus-score-find-hierarchical
10687 @findex gnus-score-find-hierarchical
10688 Apply all score files from all the parent groups.  This means that you
10689 can't have score files like @file{all.SCORE}, but you can have
10690 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10691
10692 @end table
10693 This variable can also be a list of functions.  In that case, all these
10694 functions will be called, and all the returned lists of score files will
10695 be applied.  These functions can also return lists of score alists
10696 directly.  In that case, the functions that return these non-file score
10697 alists should probably be placed before the ``real'' score file
10698 functions, to ensure that the last score file returned is the local
10699 score file.  Phu.
10700
10701 @item gnus-score-expiry-days
10702 @vindex gnus-score-expiry-days
10703 This variable says how many days should pass before an unused score file
10704 entry is expired.  If this variable is @code{nil}, no score file entries
10705 are expired.  It's 7 by default.
10706
10707 @item gnus-update-score-entry-dates
10708 @vindex gnus-update-score-entry-dates
10709 If this variable is non-@code{nil}, matching score entries will have
10710 their dates updated.  (This is how Gnus controls expiry---all
10711 non-matching entries will become too old while matching entries will
10712 stay fresh and young.)  However, if you set this variable to @code{nil},
10713 even matching entries will grow old and will have to face that oh-so
10714 grim reaper.  
10715
10716 @item gnus-score-after-write-file-function
10717 @vindex gnus-score-after-write-file-function
10718 Function called with the name of the score file just written.
10719
10720 @end table
10721
10722
10723 @node Score File Format
10724 @section Score File Format
10725 @cindex score file format
10726
10727 A score file is an @code{emacs-lisp} file that normally contains just a
10728 single form.  Casual users are not expected to edit these files;
10729 everything can be changed from the summary buffer.
10730
10731 Anyway, if you'd like to dig into it yourself, here's an example:
10732
10733 @lisp
10734 (("from"
10735   ("Lars Ingebrigtsen" -10000)
10736   ("Per Abrahamsen")
10737   ("larsi\\|lmi" -50000 nil R))
10738  ("subject"
10739   ("Ding is Badd" nil 728373))
10740  ("xref"
10741   ("alt.politics" -1000 728372 s))
10742  ("lines"
10743   (2 -100 nil <))
10744  (mark 0)
10745  (expunge -1000)
10746  (mark-and-expunge -10)
10747  (read-only nil)
10748  (orphan -10)
10749  (adapt t)
10750  (files "/hom/larsi/News/gnu.SCORE")
10751  (exclude-files "all.SCORE")
10752  (local (gnus-newsgroup-auto-expire t)
10753         (gnus-summary-make-false-root 'empty))
10754  (eval (ding)))
10755 @end lisp
10756
10757 This example demonstrates absolutely everything about a score file. 
10758
10759 Even though this looks much like lisp code, nothing here is actually
10760 @code{eval}ed.  The lisp reader is used to read this form, though, so it
10761 has to be legal syntactically, if not semantically.
10762
10763 Six keys are supported by this alist:
10764
10765 @table @code
10766
10767 @item STRING
10768 If the key is a string, it is the name of the header to perform the
10769 match on.  Scoring can only be performed on these eight headers:
10770 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
10771 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
10772 these headers, there are three strings to tell Gnus to fetch the entire
10773 article and do the match on larger parts of the article: @code{Body}
10774 will perform the match on the body of the article, @code{Head} will
10775 perform the match on the head of the article, and @code{All} will
10776 perform the match on the entire article.  Note that using any of these
10777 last three keys will slow down group entry @emph{considerably}.  The
10778 final ``header'' you can score on is @code{Followup}.  These score
10779 entries will result in new score entries being added for all follow-ups
10780 to articles that matches these score entries.
10781
10782 Following this key is a arbitrary number of score entries, where each
10783 score entry has one to four elements.
10784 @enumerate
10785
10786 @item 
10787 The first element is the @dfn{match element}.  On most headers this will
10788 be a string, but on the Lines and Chars headers, this must be an
10789 integer. 
10790
10791 @item 
10792 If the second element is present, it should be a number---the @dfn{score
10793 element}.  This number should be an integer in the neginf to posinf
10794 interval.  This number is added to the score of the article if the match
10795 is successful.  If this element is not present, the
10796 @code{gnus-score-interactive-default-score} number will be used
10797 instead.  This is 1000 by default.
10798
10799 @item 
10800 If the third element is present, it should be a number---the @dfn{date
10801 element}.  This date says when the last time this score entry matched,
10802 which provides a mechanism for expiring the score entries.  It this
10803 element is not present, the score entry is permanent.  The date is
10804 represented by the number of days since December 31, 1 ce.
10805
10806 @item 
10807 If the fourth element is present, it should be a symbol---the @dfn{type
10808 element}.  This element specifies what function should be used to see
10809 whether this score entry matches the article.  What match types that can
10810 be used depends on what header you wish to perform the match on.
10811 @table @dfn
10812
10813 @item From, Subject, References, Xref, Message-ID
10814 For most header types, there are the @code{r} and @code{R} (regexp), as
10815 well as @code{s} and @code{S} (substring) types, and @code{e} and
10816 @code{E} (exact match), and @code{w} (word match) types.  If this
10817 element is not present, Gnus will assume that substring matching should
10818 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
10819 that the matches will be done in a case-sensitive manner.  All these
10820 one-letter types are really just abbreviations for the @code{regexp},
10821 @code{string}, @code{exact}, and @code{word} types, which you can use
10822 instead, if you feel like.
10823
10824 @item Lines, Chars
10825 These two headers use different match types: @code{<}, @code{>},
10826 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
10827 careful because some backends (like @code{nndir}) do not generate
10828 @code{Lines} header, so every article ends up being marked as having 0
10829 lines.  This can lead to strange results if you happen to lower score of
10830 the articles with few lines.
10831
10832 @item Date
10833 For the Date header we have three kinda silly match types:
10834 @code{before}, @code{at} and @code{after}.  I can't really imagine this
10835 ever being useful, but, like, it would feel kinda silly not to provide
10836 this function.  Just in case.  You never know.  Better safe than sorry.
10837 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
10838 sex on a first date.  (I have been told that at least one person, and I
10839 quote, ``found this function indispensable'', however.)
10840
10841 @cindex ISO8601
10842 @cindex date
10843 A more useful match type is @code{regexp}.  With it, you can match the
10844 date string using a regular expression.  The date is normalized to
10845 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}.  If you want to
10846 match all articles that have been posted on April 1st in every year, you
10847 could use @samp{....0401.........} as a match string, for instance.
10848 (Note that the date is kept in its original time zone, so this will
10849 match articles that were posted when it was April 1st where the article
10850 was posted from.  Time zones are such wholesome fun for the whole
10851 family, eh?)
10852
10853 @item Head, Body, All
10854 These three match keys use the same match types as the @code{From} (etc)
10855 header uses.
10856
10857 @item Followup
10858 This match key is somewhat special, in that it will match the
10859 @code{From} header, and affect the score of not only the matching
10860 articles, but also all followups to the matching articles.  This allows
10861 you e.g. increase the score of followups to your own articles, or
10862 decrease the score of followups to the articles of some known
10863 trouble-maker.  Uses the same match types as the @code{From} header
10864 uses.
10865
10866 @item Thread
10867 This match key works along the same lines as the @code{Followup} match
10868 key.  If you say that you want to score on a (sub-)thread that is
10869 started by an article with a @code{Message-ID} @var{X}, then you add a
10870 @samp{thread} match.  This will add a new @samp{thread} match for each
10871 article that has @var{X} in its @code{References} header.  (These new
10872 @samp{thread} matches will use the @code{Message-ID}s of these matching
10873 articles.)  This will ensure that you can raise/lower the score of an
10874 entire thread, even though some articles in the thread may not have
10875 complete @code{References} headers.  Note that using this may lead to
10876 undeterministic scores of the articles in the thread.
10877 @end table
10878 @end enumerate
10879
10880 @item mark
10881 The value of this entry should be a number.  Any articles with a score
10882 lower than this number will be marked as read.
10883
10884 @item expunge
10885 The value of this entry should be a number.  Any articles with a score
10886 lower than this number will be removed from the summary buffer.
10887
10888 @item mark-and-expunge
10889 The value of this entry should be a number.  Any articles with a score
10890 lower than this number will be marked as read and removed from the
10891 summary buffer.
10892
10893 @item thread-mark-and-expunge
10894 The value of this entry should be a number.  All articles that belong to
10895 a thread that has a total score below this number will be marked as read
10896 and removed from the summary buffer.  @code{gnus-thread-score-function}
10897 says how to compute the total score for a thread.
10898
10899 @item files
10900 The value of this entry should be any number of file names.  These files
10901 are assumed to be score files as well, and will be loaded the same way
10902 this one was.
10903
10904 @item exclude-files
10905 The clue of this entry should be any number of files.  These files will
10906 not be loaded, even though they would normally be so, for some reason or
10907 other. 
10908
10909 @item eval
10910 The value of this entry will be @code{eval}el.  This element will be
10911 ignored when handling global score files. 
10912
10913 @item read-only
10914 Read-only score files will not be updated or saved.  Global score files
10915 should feature this atom (@pxref{Global Score Files}).
10916
10917 @item orphan
10918 The value of this entry should be a number.  Articles that do not have
10919 parents will get this number added to their scores.  Imagine you follow
10920 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
10921 will only follow a few of the threads, also want to see any new threads.
10922
10923 You can do this with the following two score file entries:
10924
10925 @example
10926         (orphan -500)
10927         (mark-and-expunge -100)
10928 @end example
10929
10930 When you enter the group the first time, you will only see the new
10931 threads.  You then raise the score of the threads that you find
10932 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
10933 rest.  Next time you enter the group, you will see new articles in the
10934 interesting threads, plus any new threads.
10935
10936 I.e.---the orphan score atom is for high-volume groups where there
10937 exist a few interesting threads which can't be found automatically by
10938 ordinary scoring rules.
10939
10940 @item adapt
10941 This entry controls the adaptive scoring.  If it is @code{t}, the
10942 default adaptive scoring rules will be used.  If it is @code{ignore}, no
10943 adaptive scoring will be performed on this group.  If it is a list, this
10944 list will be used as the adaptive scoring rules.  If it isn't present,
10945 or is something other than @code{t} or @code{ignore}, the default
10946 adaptive scoring rules will be used.  If you want to use adaptive
10947 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
10948 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
10949 not want adaptive scoring.  If you only want adaptive scoring in a few
10950 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
10951 insert @code{(adapt t)} in the score files of the groups where you want
10952 it. 
10953
10954 @item adapt-file
10955 All adaptive score entries will go to the file named by this entry.  It
10956 will also be applied when entering the group.  This atom might be handy
10957 if you want to adapt on several groups at once, using the same adaptive
10958 file for a number of groups.
10959
10960 @item local
10961 @cindex local variables
10962 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
10963 Each @var{var} will be made buffer-local to the current summary buffer,
10964 and set to the value specified.  This is a convenient, if somewhat
10965 strange, way of setting variables in some groups if you don't like hooks
10966 much.
10967 @end table
10968
10969
10970 @node Score File Editing
10971 @section Score File Editing
10972
10973 You normally enter all scoring commands from the summary buffer, but you
10974 might feel the urge to edit them by hand as well, so we've supplied you
10975 with a mode for that.  
10976
10977 It's simply a slightly customized @code{emacs-lisp} mode, with these
10978 additional commands:
10979
10980 @table @kbd
10981
10982 @item C-c C-c
10983 @kindex C-c C-c (Score)
10984 @findex gnus-score-edit-done
10985 Save the changes you have made and return to the summary buffer
10986 (@code{gnus-score-edit-done}). 
10987
10988 @item C-c C-d
10989 @kindex C-c C-d (Score)
10990 @findex gnus-score-edit-insert-date
10991 Insert the current date in numerical format
10992 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
10993 you were wondering.
10994
10995 @item C-c C-p
10996 @kindex C-c C-p (Score)
10997 @findex gnus-score-pretty-print
10998 The adaptive score files are saved in an unformatted fashion.  If you
10999 intend to read one of these files, you want to @dfn{pretty print} it
11000 first.  This command (@code{gnus-score-pretty-print}) does that for
11001 you. 
11002
11003 @end table
11004
11005 Type @kbd{M-x gnus-score-mode} to use this mode.
11006
11007 @vindex gnus-score-mode-hook
11008 @code{gnus-score-menu-hook} is run in score mode buffers.
11009
11010 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11011 e} to begin editing score files.
11012
11013
11014 @node Adaptive Scoring
11015 @section Adaptive Scoring
11016 @cindex adaptive scoring
11017
11018 If all this scoring is getting you down, Gnus has a way of making it all
11019 happen automatically---as if by magic.  Or rather, as if by artificial
11020 stupidity, to be precise.
11021
11022 @vindex gnus-use-adaptive-scoring
11023 When you read an article, or mark an article as read, or kill an
11024 article, you leave marks behind.  On exit from the group, Gnus can sniff
11025 these marks and add score elements depending on what marks it finds.
11026 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11027 @code{t} or @code{(line)}.  If you want score adaptively on separate
11028 words appearing in the subjects, you should set this variable to
11029 @code{(word)}.  If you want to use both adaptive methods, set this
11030 variable to @code{(word line)}.
11031
11032 @vindex gnus-default-adaptive-score-alist
11033 To give you complete control over the scoring process, you can customize
11034 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
11035 might look something like this:
11036
11037 @lisp
11038 (defvar gnus-default-adaptive-score-alist
11039   '((gnus-unread-mark)
11040     (gnus-ticked-mark (from 4))
11041     (gnus-dormant-mark (from 5))
11042     (gnus-del-mark (from -4) (subject -1))
11043     (gnus-read-mark (from 4) (subject 2))
11044     (gnus-expirable-mark (from -1) (subject -1))
11045     (gnus-killed-mark (from -1) (subject -3))
11046     (gnus-kill-file-mark)
11047     (gnus-ancient-mark)
11048     (gnus-low-score-mark)
11049     (gnus-catchup-mark (from -1) (subject -1))))
11050 @end lisp
11051
11052 As you see, each element in this alist has a mark as a key (either a
11053 variable name or a ``real'' mark---a character).  Following this key is
11054 a arbitrary number of header/score pairs.  If there are no header/score
11055 pairs following the key, no adaptive scoring will be done on articles
11056 that have that key as the article mark.  For instance, articles with
11057 @code{gnus-unread-mark} in the example above will not get adaptive score
11058 entries.
11059
11060 Each article can have only one mark, so just a single of these rules
11061 will be applied to each article.
11062
11063 To take @code{gnus-del-mark} as an example---this alist says that all
11064 articles that have that mark (i.e., are marked with @samp{D}) will have a
11065 score entry added to lower based on the @code{From} header by -4, and
11066 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
11067
11068 If you have marked 10 articles with the same subject with
11069 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11070 That means that that subject will get a score of ten times -1, which
11071 should be, unless I'm much mistaken, -10.
11072
11073 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11074 the read articles will be marked with the @samp{E} mark.  This'll
11075 probably make adaptive scoring slightly impossible, so auto-expiring and
11076 adaptive scoring doesn't really mix very well.
11077
11078 The headers you can score on are @code{from}, @code{subject},
11079 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11080 @code{chars} and @code{date}.  In addition, you can score on
11081 @code{followup}, which will create an adaptive score entry that matches
11082 on the @code{References} header using the @code{Message-ID} of the
11083 current article, thereby matching the following thread.  
11084
11085 You can also score on @code{thread}, which will try to score all
11086 articles that appear in a thread.  @code{thread} matches uses a
11087 @code{Message-ID} to match on the @code{References} header of the
11088 article.  If the match is made, the @code{Message-ID} of the article is
11089 added to the @code{thread} rule.  (Think about it.  I'd recommend two
11090 aspirins afterwards.)
11091
11092 If you use this scheme, you should set the score file atom @code{mark}
11093 to something small---like -300, perhaps, to avoid having small random
11094 changes result in articles getting marked as read.
11095
11096 After using adaptive scoring for a week or so, Gnus should start to
11097 become properly trained and enhance the authors you like best, and kill
11098 the authors you like least, without you having to say so explicitly. 
11099
11100 You can control what groups the adaptive scoring is to be performed on
11101 by using the score files (@pxref{Score File Format}).  This will also
11102 let you use different rules in different groups.
11103
11104 @vindex gnus-adaptive-file-suffix
11105 The adaptive score entries will be put into a file where the name is the
11106 group name with @code{gnus-adaptive-file-suffix} appended.  The default
11107 is @samp{ADAPT}.
11108
11109 @vindex gnus-score-exact-adapt-limit
11110 When doing adaptive scoring, substring or fuzzy matching would probably
11111 give you the best results in most cases.  However, if the header one
11112 matches is short, the possibility for false positives is great, so if
11113 the length of the match is less than
11114 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
11115 this variable is @code{nil}, exact matching will always be used to avoid
11116 this problem.
11117
11118 @vindex gnus-default-adaptive-word-score-alist
11119 As mentioned above, you can adapt either on individual words or entire
11120 headers.  If you adapt on words, the
11121 @code{gnus-default-adaptive-word-score-alist} variable says what score
11122 each instance of a word should add given a mark.
11123
11124 @lisp
11125 (setq gnus-default-adaptive-word-score-alist  
11126       `((,gnus-read-mark . 30)
11127         (,gnus-catchup-mark . -10)
11128         (,gnus-killed-mark . -20)
11129         (,gnus-del-mark . -15)))
11130 @end lisp
11131
11132 This is the default value.  If you have adaption on words enabled, every
11133 word that appears in subjects of articles that are marked with
11134 @code{gnus-read-mark} will result in a score rule that increase the
11135 score with 30 points.
11136
11137 @vindex gnus-default-ignored-adaptive-words
11138 @vindex gnus-ignored-adaptive-words
11139 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11140 will be ignored.  If you wish to add more words to be ignored, use the
11141 @code{gnus-ignored-adaptive-words} list instead.
11142
11143 @vindex gnus-adaptive-word-syntax-table
11144 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11145 syntax table in effect.  It is similar to the standard syntax table, but
11146 it considers numbers to be non-word-constituent characters.
11147
11148 After using this scheme for a while, it might be nice to write a
11149 @code{gnus-psychoanalyze-user} command to go through the rules and see
11150 what words you like and what words you don't like.  Or perhaps not.
11151
11152
11153 @node Home Score File
11154 @section Home Score File
11155
11156 The score file where new score file entries will go is called the
11157 @dfn{home score file}.  This is normally (and by default) the score file
11158 for the group itself.  For instance, the home score file for
11159 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11160
11161 However, this may not be what you want.  It is often convenient to share
11162 a common home score file among many groups---all @samp{emacs} groups
11163 could perhaps use the same home score file.
11164
11165 @vindex gnus-home-score-file
11166 The variable that controls this is @code{gnus-home-score-file}.  It can
11167 be:
11168
11169 @enumerate
11170 @item
11171 A string.  Then this file will be used as the home score file for all
11172 groups. 
11173
11174 @item
11175 A function. The result of this function will be used as the home score
11176 file.  The function will be called with the name of the group as the
11177 parameter. 
11178
11179 @item
11180 A list.  The elements in this list can be:
11181
11182 @enumerate
11183 @item 
11184 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
11185 the @var{file-name} will will be used as the home score file.
11186
11187 @item 
11188 A function. If the function returns non-nil, the result will be used as
11189 the home score file.
11190
11191 @item 
11192 A string.  Use the string as the home score file.
11193 @end enumerate
11194
11195 The list will be traversed from the beginning towards the end looking
11196 for matches.
11197
11198 @end enumerate
11199
11200 So, if you want to use just a single score file, you could say:
11201
11202 @lisp
11203 (setq gnus-home-score-file
11204       "my-total-score-file.SCORE")
11205 @end lisp
11206
11207 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11208 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11209
11210 @lisp
11211 (setq gnus-home-score-file
11212       'gnus-hierarchial-home-score-file)
11213 @end lisp
11214
11215 This is a ready-made function provided for your convenience.
11216
11217 If you want to have one score file for the @samp{emacs} groups and
11218 another for the @samp{comp} groups, while letting all other groups use
11219 their own home score files:
11220
11221 @lisp
11222 (setq gnus-home-score-file
11223       ;; All groups that match the regexp "\\.emacs"
11224       '("\\.emacs" "emacs.SCORE")
11225       ;; All the comp groups in one score file
11226        ("^comp" "comp.SCORE"))
11227 @end lisp
11228    
11229 @vindex gnus-home-adapt-file
11230 @code{gnus-home-adapt-file} works exactly the same way as
11231 @code{gnus-home-score-file}, but says what the home adaptive score file
11232 is instead.  All new adaptive file entries will go into the file
11233 specified by this variable, and the same syntax is allowed.
11234
11235 In addition to using @code{gnus-home-score-file} and
11236 @code{gnus-home-adapt-file}, you can also use group parameters
11237 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11238 Parameters}) to achieve much the same.  Group and topic parameters take
11239 precedence over this variable.
11240
11241
11242 @node Followups To Yourself
11243 @section Followups To Yourself
11244
11245 Gnus offers two commands for picking out the @code{Message-ID} header in
11246 the current buffer.  Gnus will then add a score rule that scores using
11247 this @code{Message-ID} on the @code{References} header of other
11248 articles.  This will, in effect, increase the score of all articles that
11249 respond to the article in the current buffer.  Quite useful if you want
11250 to easily note when people answer what you've said.
11251
11252 @table @code
11253
11254 @item gnus-score-followup-article
11255 @findex gnus-score-followup-article
11256 This will add a score to articles that directly follow up your own
11257 article. 
11258
11259 @item gnus-score-followup-thread
11260 @findex gnus-score-followup-thread
11261 This will add a score to all articles that appear in a thread ``below''
11262 your own article.
11263 @end table
11264
11265 @vindex message-sent-hook
11266 These two functions are both primarily meant to be used in hooks like
11267 @code{message-sent-hook}.  
11268
11269 If you look closely at your own @code{Message-ID}, you'll notice that
11270 the first two or three characters are always the same.  Here's two of
11271 mine:  
11272
11273 @example
11274 <x6u3u47icf.fsf@@eyesore.no>
11275 <x6sp9o7ibw.fsf@@eyesore.no>
11276 @end example
11277
11278 So ``my'' ident on this machine is @samp{x6}.  This can be
11279 exploited---the following rule will raise the score on all followups to
11280 myself: 
11281
11282 @lisp
11283 ("references" 
11284  "<x6[0-9a-z]+\\.fsf@@.*eyesore.no>" 1000 nil r)
11285 @end lisp
11286
11287 Whether it's the first two or first three characters that are ``yours''
11288 is system-dependent.
11289
11290
11291 @node Scoring Tips
11292 @section Scoring Tips
11293 @cindex scoring tips
11294
11295 @table @dfn
11296
11297 @item Crossposts
11298 @cindex crossposts
11299 @cindex scoring crossposts
11300 If you want to lower the score of crossposts, the line to match on is
11301 the @code{Xref} header.
11302 @lisp
11303 ("xref" (" talk.politics.misc:" -1000))
11304 @end lisp
11305
11306 @item Multiple crossposts
11307 If you want to lower the score of articles that have been crossposted to
11308 more than, say, 3 groups:
11309 @lisp
11310 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11311 @end lisp
11312
11313 @item Matching on the body
11314 This is generally not a very good idea---it takes a very long time.
11315 Gnus actually has to fetch each individual article from the server.  But
11316 you might want to anyway, I guess.  Even though there are three match
11317 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11318 and stick with it in each score file.  If you use any two, each article
11319 will be fetched @emph{twice}.  If you want to match a bit on the
11320 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11321 the matches.  
11322
11323 @item Marking as read
11324 You will probably want to mark articles that has a score below a certain
11325 number as read.  This is most easily achieved by putting the following
11326 in your @file{all.SCORE} file:
11327 @lisp
11328 ((mark -100))
11329 @end lisp
11330 You may also consider doing something similar with @code{expunge}.  
11331
11332 @item Negated character classes
11333 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11334 That will match newlines, which might lead to, well, The Unknown.  Say
11335 @code{[^abcd\n]*} instead.
11336 @end table
11337
11338
11339 @node Reverse Scoring
11340 @section Reverse Scoring
11341 @cindex reverse scoring
11342
11343 If you want to keep just articles that have @samp{Sex with Emacs} in the
11344 subject header, and expunge all other articles, you could put something
11345 like this in your score file:
11346
11347 @lisp
11348 (("subject"
11349   ("Sex with Emacs" 2))
11350  (mark 1)
11351  (expunge 1))
11352 @end lisp
11353
11354 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11355 rest as read, and expunge them to boot.
11356
11357
11358 @node Global Score Files
11359 @section Global Score Files
11360 @cindex global score files
11361
11362 Sure, other newsreaders have ``global kill files''.  These are usually
11363 nothing more than a single kill file that applies to all groups, stored
11364 in the user's home directory.  Bah!  Puny, weak newsreaders!
11365
11366 What I'm talking about here are Global Score Files.  Score files from
11367 all over the world, from users everywhere, uniting all nations in one
11368 big, happy score file union!  Ange-score!  New and untested!
11369
11370 @vindex gnus-global-score-files
11371 All you have to do to use other people's score files is to set the
11372 @code{gnus-global-score-files} variable.  One entry for each score file,
11373 or each score file directory.  Gnus will decide by itself what score
11374 files are applicable to which group.
11375
11376 Say you want to use the score file
11377 @file{/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE} and
11378 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11379
11380 @lisp
11381 (setq gnus-global-score-files
11382       '("/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
11383         "/ftp@@ftp.some-where:/pub/score/"))
11384 @end lisp
11385
11386 @findex gnus-score-search-global-directories
11387 Simple, eh?  Directory names must end with a @samp{/}.  These
11388 directories are typically scanned only once during each Gnus session.
11389 If you feel the need to manually re-scan the remote directories, you can
11390 use the @code{gnus-score-search-global-directories} command.
11391
11392 Note that, at present, using this option will slow down group entry
11393 somewhat.  (That is---a lot.)
11394
11395 If you want to start maintaining score files for other people to use,
11396 just put your score file up for anonymous ftp and announce it to the
11397 world.  Become a retro-moderator!  Participate in the retro-moderator
11398 wars sure to ensue, where retro-moderators battle it out for the
11399 sympathy of the people, luring them to use their score files on false
11400 premises!  Yay!  The net is saved!
11401
11402 Here are some tips for the would-be retro-moderator, off the top of my
11403 head: 
11404
11405 @itemize @bullet
11406
11407 @item 
11408 Articles that are heavily crossposted are probably junk. 
11409 @item
11410 To lower a single inappropriate article, lower by @code{Message-ID}.
11411 @item
11412 Particularly brilliant authors can be raised on a permanent basis. 
11413 @item
11414 Authors that repeatedly post off-charter for the group can safely be
11415 lowered out of existence.
11416 @item
11417 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11418 articles completely.
11419
11420 @item 
11421 Use expiring score entries to keep the size of the file down.  You
11422 should probably have a long expiry period, though, as some sites keep
11423 old articles for a long time.
11424 @end itemize
11425
11426 ... I wonder whether other newsreaders will support global score files
11427 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
11428 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
11429 holding our breath yet?
11430
11431
11432 @node Kill Files
11433 @section Kill Files
11434 @cindex kill files
11435
11436 Gnus still supports those pesky old kill files.  In fact, the kill file
11437 entries can now be expiring, which is something I wrote before Daniel
11438 Quinlan thought of doing score files, so I've left the code in there.
11439
11440 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11441 than score processing, so it might be a good idea to rewrite your kill
11442 files into score files.
11443
11444 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
11445 forms into this file, which means that you can use kill files as some
11446 sort of primitive hook function to be run on group entry, even though
11447 that isn't a very good idea.
11448
11449 Normal kill files look like this:
11450
11451 @lisp
11452 (gnus-kill "From" "Lars Ingebrigtsen")
11453 (gnus-kill "Subject" "ding")
11454 (gnus-expunge "X")
11455 @end lisp
11456
11457 This will mark every article written by me as read, and remove them from
11458 the summary buffer.  Very useful, you'll agree.
11459
11460 Other programs use a totally different kill file syntax.  If Gnus
11461 encounters what looks like a @code{rn} kill file, it will take a stab at
11462 interpreting it. 
11463
11464 Two summary functions for editing a GNUS kill file:
11465
11466 @table @kbd
11467
11468 @item M-k
11469 @kindex M-k (Summary)
11470 @findex gnus-summary-edit-local-kill
11471 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11472
11473 @item M-K
11474 @kindex M-K (Summary)
11475 @findex gnus-summary-edit-global-kill
11476 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11477 @end table
11478
11479 Two group mode functions for editing the kill files:
11480
11481 @table @kbd
11482
11483 @item M-k
11484 @kindex M-k (Group)
11485 @findex gnus-group-edit-local-kill
11486 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11487
11488 @item M-K
11489 @kindex M-K (Group)
11490 @findex gnus-group-edit-global-kill
11491 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11492 @end table
11493
11494 Kill file variables:
11495
11496 @table @code
11497 @item gnus-kill-file-name
11498 @vindex gnus-kill-file-name
11499 A kill file for the group @samp{soc.motss} is normally called
11500 @file{soc.motss.KILL}.  The suffix appended to the group name to get
11501 this file name is detailed by the @code{gnus-kill-file-name} variable.
11502 The ``global'' kill file (not in the score file sense of ``global'', of
11503 course) is called just @file{KILL}.
11504
11505 @vindex gnus-kill-save-kill-file
11506 @item gnus-kill-save-kill-file
11507 If this variable is non-@code{nil}, Gnus will save the
11508 kill file after processing, which is necessary if you use expiring
11509 kills. 
11510
11511 @item gnus-apply-kill-hook
11512 @vindex gnus-apply-kill-hook
11513 @findex gnus-apply-kill-file-unless-scored
11514 @findex gnus-apply-kill-file
11515 A hook called to apply kill files to a group.  It is
11516 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
11517 kill file if you have a score file for the same group, you can set this
11518 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
11519 kill files to be processed, you should set this variable to @code{nil}.
11520
11521 @item gnus-kill-file-mode-hook
11522 @vindex gnus-kill-file-mode-hook
11523 A hook called in kill-file mode buffers.
11524
11525 @end table
11526
11527
11528 @node Converting Kill Files
11529 @section Converting Kill Files
11530 @cindex kill files
11531 @cindex converting kill files
11532
11533 If you have loads of old kill files, you may want to convert them into
11534 score files.  If they are ``regular'', you can use
11535 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11536 by hand.
11537
11538 The kill to score conversion package isn't included in Gnus by default.
11539 You can fetch it from
11540 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
11541
11542 If your old kill files are very complex---if they contain more
11543 non-@code{gnus-kill} forms than not, you'll have to convert them by
11544 hand.  Or just let them be as they are.  Gnus will still use them as
11545 before. 
11546
11547
11548 @node GroupLens
11549 @section GroupLens
11550 @cindex GroupLens
11551
11552 GroupLens is a collaborative filtering system that helps you work
11553 together with other people to find the quality news articles out of the
11554 huge volume of news articles generated every day.
11555
11556 To accomplish this the GroupLens system combines your opinions about
11557 articles you have already read with the opinions of others who have done
11558 likewise and gives you a personalized prediction for each unread news
11559 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
11560 rate articles, and finds other people that rate articles the same way.
11561 Once it has found for you some people you agree with it tells you, in
11562 the form of a prediction, what they thought of the article.  You can use
11563 this prediction to help you decide whether or not you want to read the
11564 article.
11565
11566 @menu
11567 * Using GroupLens::          How to make Gnus use GroupLens.
11568 * Rating Articles::          Letting GroupLens know how you rate articles.
11569 * Displaying Predictions::   Displaying predictions given by GroupLens.
11570 * GroupLens Variables::      Customizing GroupLens.
11571 @end menu
11572
11573
11574 @node Using GroupLens
11575 @subsection Using GroupLens
11576
11577 To use GroupLens you must register a pseudonym with your local Better
11578 Bit Bureau (BBB).
11579 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11580 better bit in town is at the moment.
11581
11582 Once you have registered you'll need to set a couple of variables.
11583
11584 @table @code
11585
11586 @item gnus-use-grouplens
11587 @vindex gnus-use-grouplens
11588 Setting this variable to a non-@code{nil} value will make Gnus hook into
11589 all the relevant GroupLens functions.
11590
11591 @item grouplens-pseudonym
11592 @vindex grouplens-pseudonym
11593 This variable should be set to the pseudonym you got when registering
11594 with the Better Bit Bureau.
11595
11596 @item grouplens-newsgroups
11597 @vindex grouplens-newsgroups
11598 A list of groups that you want to get GroupLens predictions for. 
11599
11600 @end table
11601
11602 Thats the minimum of what you need to get up and running with GroupLens.
11603 Once you've registered, GroupLens will start giving you scores for
11604 articles based on the average of what other people think.  But, to get
11605 the real benefit of GroupLens you need to start rating articles
11606 yourself.  Then the scores GroupLens gives you will be personalized for
11607 you, based on how the people you usually agree with have already rated.
11608
11609
11610 @node Rating Articles
11611 @subsection Rating Articles
11612
11613 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11614 Where 1 means something like this article is a waste of bandwidth and 5
11615 means that the article was really good.  The basic question to ask
11616 yourself is, "on a scale from 1 to 5 would I like to see more articles
11617 like this one?"
11618
11619 There are four ways to enter a rating for an article in GroupLens.
11620
11621 @table @kbd
11622
11623 @item r
11624 @kindex r (GroupLens)
11625 @findex bbb-summary-rate-article
11626 This function will prompt you for a rating on a scale of one to five.
11627
11628 @item k
11629 @kindex k (GroupLens)
11630 @findex grouplens-score-thread
11631 This function will prompt you for a rating, and rate all the articles in
11632 the thread.  This is really useful for some of those long running giant
11633 threads in rec.humor.
11634
11635 @end table
11636
11637 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11638 the score of the article you're reading.
11639
11640 @table @kbd
11641
11642 @item 1-5 n
11643 @kindex n (GroupLens)
11644 @findex grouplens-next-unread-article
11645 Rate the article and go to the next unread article.
11646
11647 @item 1-5 ,
11648 @kindex , (GroupLens)
11649 @findex grouplens-best-unread-article
11650 Rate the article and go to the next unread article with the highest score.
11651
11652 @end table
11653
11654 If you want to give the current article a score of 4 and then go to the
11655 next article, just type @kbd{4 n}.
11656
11657
11658 @node Displaying Predictions
11659 @subsection Displaying Predictions
11660
11661 GroupLens makes a prediction for you about how much you will like a
11662 news article.  The predictions from GroupLens are on a scale from 1 to
11663 5, where 1 is the worst and 5 is the best.  You can use the predictions
11664 from GroupLens in one of three ways controlled by the variable
11665 @code{gnus-grouplens-override-scoring}.
11666
11667 @vindex gnus-grouplens-override-scoring
11668 There are three ways to display predictions in grouplens.  You may
11669 choose to have the GroupLens scores contribute to, or override the
11670 regular gnus scoring mechanism. override is the default; however, some
11671 people prefer to see the Gnus scores plus the grouplens scores.  To get
11672 the separate scoring behavior you need to set
11673 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
11674 GroupLens predictions combined with the grouplens scores set it to
11675 @code{'override} and to combine the scores set
11676 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
11677 the combine option you will also want to set the values for
11678 @code{grouplens-prediction-offset} and
11679 @code{grouplens-score-scale-factor}.
11680
11681 @vindex grouplens-prediction-display
11682 In either case, GroupLens gives you a few choices for how you would like
11683 to see your predictions displayed.  The display of predictions is
11684 controlled by the @code{grouplens-prediction-display} variable.
11685
11686 The following are legal values for that variable.
11687
11688 @table @code
11689 @item prediction-spot
11690 The higher the prediction, the further to the right an @samp{*} is
11691 displayed. 
11692
11693 @item confidence-interval
11694 A numeric confidence interval.
11695
11696 @item prediction-bar
11697 The higher the prediction, the longer the bar.
11698
11699 @item confidence-bar
11700 Numerical confidence.
11701
11702 @item confidence-spot
11703 The spot gets bigger with more confidence.
11704
11705 @item prediction-num
11706 Plain-old numeric value.
11707
11708 @item confidence-plus-minus
11709 Prediction +/i confidence.
11710
11711 @end table
11712
11713
11714 @node GroupLens Variables
11715 @subsection GroupLens Variables
11716
11717 @table @code
11718
11719 @item gnus-summary-grouplens-line-format
11720 The summary line format used in summary buffers that are GroupLens
11721 enhanced.  It accepts the same specs as the normal summary line format
11722 (@pxref{Summary Buffer Lines}).  The default is
11723 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
11724
11725 @item grouplens-bbb-host
11726 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
11727 default.
11728
11729 @item grouplens-bbb-port
11730 Port of the host running the bbbd server.  The default is 9000.
11731
11732 @item grouplens-score-offset
11733 Offset the prediction by this value.  In other words, subtract the
11734 prediction value by this number to arrive at the effective score.  The
11735 default is 0.
11736
11737 @item grouplens-score-scale-factor 
11738 This variable allows the user to magnify the effect of GroupLens scores.
11739 The scale factor is applied after the offset.  The default is 1.
11740
11741 @end table
11742
11743
11744 @node Advanced Scoring
11745 @section Advanced Scoring
11746
11747 Scoring on Subjects and From headers is nice enough, but what if you're
11748 really interested in what a person has to say only when she's talking
11749 about a particular subject?  Or what about if you really don't want to
11750 read what person A has to say when she's following up to person B, but
11751 want to read what she says when she's following up to person C?
11752
11753 By using advanced scoring rules you may create arbitrarily complex
11754 scoring patterns.
11755
11756 @menu
11757 * Advanced Scoring Syntax::     A definition.
11758 * Advanced Scoring Examples::   What they look like.
11759 * Advanced Scoring Tips::       Getting the most out of it.
11760 @end menu
11761
11762
11763 @node Advanced Scoring Syntax
11764 @subsection Advanced Scoring Syntax
11765
11766 Ordinary scoring rules have a string as the first element in the rule.
11767 Advanced scoring rules have a list as the first element.  The second
11768 element is the score to be applied if the first element evaluated to a
11769 non-@code{nil} value.
11770
11771 These lists may consist of three logical operators, one redirection
11772 operator, and various match operators.
11773
11774 Logical operators:
11775
11776 @table @code
11777 @item &
11778 @itemx and
11779 This logical operator will evaluate each of its arguments until it finds
11780 one that evaluates to @code{false}, and then it'll stop.  If all arguments
11781 evaluate to @code{true} values, then this operator will return
11782 @code{true}. 
11783
11784 @item |
11785 @itemx or
11786 This logical operator will evaluate each of its arguments until it finds
11787 one that evaluates to @code{true}.  If no arguments are @code{true},
11788 then this operator will return @code{false}.
11789
11790 @item !
11791 @itemx not
11792 @itemx Â¬
11793 This logical operator only takes a single argument.  It returns the
11794 inverse of the value of its argument.
11795
11796 @end table
11797
11798 There is an @dfn{indirection operator} that will make its arguments
11799 apply to the ancestors of the current article being scored.  For
11800 instance, @code{1-} will make score rules apply to the parent of the
11801 current article.  @code{2-} will make score fules apply to the
11802 grandparent of the current article.  Alternatively, you can write
11803 @code{^^}, where the number of @code{^}s (carets) say how far back into
11804 the ancestry you want to go.
11805
11806 Finally, we have the match operators.  These are the ones that do the
11807 real work.  Match operators are header name strings followed by a match
11808 and a match type.  A typical match operator looks like @samp{("from"
11809 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
11810 simple scoring, and the match types are also the same.
11811
11812
11813 @node Advanced Scoring Examples
11814 @subsection Advanced Scoring Examples
11815
11816 Let's say you want to increase the score of articles written by Lars
11817 when he's talking about Gnus:
11818
11819 @example
11820 ((& 
11821   ("from" "Lars Ingebrigtsen")
11822   ("subject" "Gnus"))
11823  1000)
11824 @end example
11825
11826 Quite simple, huh?
11827
11828 When he writes long articles, he sometimes has something nice to say: 
11829
11830 @example
11831 ((& 
11832   ("from" "Lars Ingebrigtsen")
11833   (|
11834    ("subject" "Gnus")
11835    ("lines" 100 >)))
11836  1000)
11837 @end example
11838
11839 However, when he responds to things written by Reig Eigil Logge, you
11840 really don't want to read what he's written:
11841
11842 @example
11843 ((&
11844   ("from" "Lars Ingebrigtsen")
11845   (1- ("from" "Reig Eigir Logge")))
11846  -100000)
11847 @end example
11848
11849 Everybody that follows up Redmondo when he writes about disappearing
11850 socks should have their scores raised, but only when they talk about
11851 white socks.  However, when Lars talks about socks, it's usually not
11852 very interesting:
11853
11854 @example
11855 ((&
11856   (1-
11857    (&
11858     ("from" "redmondo@@.*no" r)
11859     ("body" "disappearing.*socks" t)))
11860   (! ("from" "Lars Ingebrigtsen"))
11861   ("body" "white.*socks"))
11862  1000)
11863 @end example
11864
11865 The possibilities are endless.
11866
11867
11868 @node Advanced Scoring Tips
11869 @subsection Advanced Scoring Tips
11870
11871 The @code{&} and @code{|} logical operators do short-circuit logic.
11872 That is, they stop processing their arguments when it's clear what the
11873 result of the operation will be.  For instance, if one of the arguments
11874 of an @code{&} evaluates to @code{false}, there's no point in evaluating
11875 the rest of the arguments.  This means that you should put slow matches
11876 (@samp{body}, @code{header}) last and quick matches (@samp{from},
11877 @samp{subject}) first.
11878
11879 The indirection arguments (@code{1-} and so on) will make their
11880 arguments work on previous generations of the thread.  If you say
11881 something like:
11882
11883 @example
11884 ...
11885 (1-
11886  (1-
11887   ("from" "lars")))
11888 ...
11889 @end example
11890
11891 Then that means "score on the from header of the grandparent of the
11892 current article".  An indirection is quite fast, but it's better to say:
11893
11894 @example
11895 (1-
11896  (& 
11897   ("from" "Lars")
11898   ("subject" "Gnus")))
11899 @end example
11900
11901 than it is to say:
11902
11903 @example
11904 (&
11905  (1- ("from" "Lars"))
11906  (1- ("subject" "Gnus")))
11907 @end example
11908
11909
11910 @node Score Decays
11911 @section Score Decays
11912 @cindex score decays
11913 @cindex decays
11914
11915 You may find that your scores have a tendency to grow without
11916 bounds, especially if you're using adaptive scoring.  If scores get too
11917 big, they lose all meaning---they simply max out and it's difficult to
11918 use them in any sensible way.
11919
11920 @vindex gnus-decay-scores
11921 @findex gnus-decay-score
11922 @vindex gnus-score-decay-function
11923 Gnus provides a mechanism for decaying scores to help with this problem.
11924 When score files are loaded and @code{gnus-decay-scores} is
11925 non-@code{nil}, Gnus will run the score files through the decaying
11926 mechanism thereby lowering the scores of all non-permanent score rules.
11927 The decay itself if performed by the @code{gnus-score-decay-function}
11928 function, which is @code{gnus-decay-score} by default.  Here's the
11929 definition of that function:
11930
11931 @lisp
11932 (defun gnus-decay-score (score)
11933   (floor
11934    (- score
11935       (* (if (< score 0) 1 -1)
11936          (min score
11937               (max gnus-score-decay-constant
11938                    (* (abs score)
11939                       gnus-score-decay-scale)))))))
11940 @end lisp
11941
11942 @vindex gnus-score-decay-scale
11943 @vindex gnus-score-decay-constant
11944 @code{gnus-score-decay-constant} is 3 by default and
11945 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
11946
11947 @enumerate
11948 @item
11949 Scores between -3 and 3 will be set to 0 when this function is called.
11950
11951 @item
11952 Scores with magnitudes between 3 and 60 will be shrunk by 3.
11953
11954 @item
11955 Scores with magnitudes greater than 60 will be shrunk by 5% of the
11956 score.
11957 @end enumerate
11958
11959 If you don't like this decay function, write your own.  It is called
11960 with the score to be decayed as its only parameter, and it should return
11961 the new score, which should be an integer.
11962
11963 Gnus will try to decay scores once a day.  If you haven't run Gnus for
11964 four days, Gnus will decay the scores four times, for instance.
11965
11966
11967 @node Various
11968 @chapter Various
11969
11970 @menu
11971 * Process/Prefix::             A convention used by many treatment commands.
11972 * Interactive::                Making Gnus ask you many questions.
11973 * Formatting Variables::       You can specify what buffers should look like.
11974 * Windows Configuration::      Configuring the Gnus buffer windows.
11975 * Compilation::                How to speed Gnus up.
11976 * Mode Lines::                 Displaying information in the mode lines.
11977 * Highlighting and Menus::     Making buffers look all nice and cozy.
11978 * Buttons::                    Get tendonitis in ten easy steps!
11979 * Daemons::                    Gnus can do things behind your back.
11980 * NoCeM::                      How to avoid spam and other fatty foods.
11981 * Picons::                     How to display pictures of what your reading.
11982 * Undo::                       Some actions can be undone.
11983 * Moderation::                 What to do if you're a moderator.
11984 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
11985 * Various Various::            Things that are really various.
11986 @end menu
11987
11988
11989 @node Process/Prefix
11990 @section Process/Prefix
11991 @cindex process/prefix convention
11992
11993 Many functions, among them functions for moving, decoding and saving
11994 articles, use what is known as the @dfn{Process/Prefix convention}.
11995
11996 This is a method for figuring out what articles that the user wants the
11997 command to be performed on.
11998
11999 It goes like this:
12000
12001 If the numeric prefix is N, perform the operation on the next N
12002 articles, starting with the current one.  If the numeric prefix is
12003 negative, perform the operation on the previous N articles, starting
12004 with the current one.
12005
12006 @vindex transient-mark-mode
12007 If @code{transient-mark-mode} in non-@code{nil} and the region is
12008 active, all articles in the region will be worked upon.
12009
12010 If there is no numeric prefix, but some articles are marked with the
12011 process mark, perform the operation on the articles that are marked with
12012 the process mark.
12013
12014 If there is neither a numeric prefix nor any articles marked with the
12015 process mark, just perform the operation on the current article.
12016
12017 Quite simple, really, but it needs to be made clear so that surprises
12018 are avoided.
12019
12020 Commands that react to the process mark will push the current list of
12021 process marked articles onto a stack and will then clear all process
12022 marked articles.  You can restore the previous configuration with the
12023 @kbd{M P y} command (@pxref{Setting Process Marks}).
12024
12025 @vindex gnus-summary-goto-unread
12026 One thing that seems to shock & horrify lots of people is that, for
12027 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12028 Since each @kbd{d} (which marks the current article as read) by default
12029 goes to the next unread article after marking, this means that @kbd{3 d}
12030 will mark the next three unread articles as read, no matter what the
12031 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
12032 @code{nil} for a more straightforward action.
12033
12034
12035 @node Interactive
12036 @section Interactive
12037 @cindex interaction
12038
12039 @table @code
12040
12041 @item gnus-novice-user
12042 @vindex gnus-novice-user
12043 If this variable is non-@code{nil}, you are either a newcomer to the
12044 World of Usenet, or you are very cautious, which is a nice thing to be,
12045 really.  You will be given questions of the type ``Are you sure you want
12046 to do this?'' before doing anything dangerous.  This is @code{t} by
12047 default.
12048
12049 @item gnus-expert-user
12050 @vindex gnus-expert-user
12051 If this variable is non-@code{nil}, you will never ever be asked any
12052 questions by Gnus.  It will simply assume you know what you're doing, no
12053 matter how strange.
12054
12055 @item gnus-interactive-catchup
12056 @vindex gnus-interactive-catchup
12057 Require confirmation before catching up a group if non-@code{nil}.  It
12058 is @code{t} by default.
12059
12060 @item gnus-interactive-exit
12061 @vindex gnus-interactive-exit
12062 Require confirmation before exiting Gnus.  This variable is @code{t} by
12063 default. 
12064 @end table
12065
12066
12067 @node Formatting Variables
12068 @section Formatting Variables
12069 @cindex formatting variables
12070
12071 Throughout this manual you've probably noticed lots of variables that
12072 are called things like @code{gnus-group-line-format} and
12073 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
12074 output lines in the various buffers.  There's quite a lot of them.
12075 Fortunately, they all use the same syntax, so there's not that much to
12076 be annoyed by.
12077
12078 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12079 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
12080 lots of percentages everywhere.  
12081
12082 @menu 
12083 * Formatting Basics::     A formatting variable is basically a format string.
12084 * Advanced Formatting::   Modifying output in various ways.
12085 * User-Defined Specs::    Having Gnus call your own functions.
12086 * Formatting Fonts::      Making the formatting look colorful and nice.
12087 @end menu
12088
12089 Currently Gnus uses the following formatting variables:
12090 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12091 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12092 @code{gnus-group-mode-line-format},
12093 @code{gnus-summary-mode-line-format},
12094 @code{gnus-article-mode-line-format},
12095 @code{gnus-server-mode-line-format}, and
12096 @code{gnus-summary-pick-line-format}.
12097
12098 All these format variables can also be arbitrary elisp forms.  In that
12099 case, they will be @code{eval}ed to insert the required lines.
12100
12101 @kindex M-x gnus-update-format
12102 @findex gnus-update-format
12103 Gnus includes a command to help you while creating your own format
12104 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
12105 update the spec in question and pop you to a buffer where you can
12106 examine the resulting lisp code to be run to generate the line.  
12107
12108
12109
12110 @node Formatting Basics
12111 @subsection Formatting Basics
12112
12113 Each @samp{%} element will be replaced by some string or other when the
12114 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
12115 spec, and pad with spaces to get a 5-character field''.
12116
12117 As with normal C and Emacs Lisp formatting strings, the numerical
12118 modifier between the @samp{%} and the formatting type character will
12119 @dfn{pad} the output so that it is always at least that long.
12120 @samp{%5y} will make the field always (at least) five characters wide by
12121 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
12122 the right instead.
12123
12124 You may also wish to limit the length of the field to protect against
12125 particularly wide values.  For that you can say @samp{%4,6y}, which
12126 means that the field will never be more than 6 characters wide and never
12127 less than 4 characters wide.
12128
12129
12130 @node Advanced Formatting
12131 @subsection Advanced Formatting
12132
12133 It is frequently useful to post-process the fields in some way.
12134 Padding, limiting, cutting off parts and suppressing certain values can
12135 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
12136 look like @samp{%~(cut 3)~(ignore "0")y}.
12137
12138 These are the legal modifiers:
12139
12140 @table @code
12141 @item pad
12142 @itemx pad-left
12143 Pad the field to the left with spaces until it reaches the required
12144 length.
12145
12146 @item pad-right
12147 Pad the field to the right with spaces until it reaches the required
12148 length.
12149
12150 @item max
12151 @itemx max-left
12152 Cut off characters from the left until it reaches the specified length.
12153
12154 @item max-right
12155 Cut off characters from the right until it reaches the specified
12156 length. 
12157
12158 @item cut
12159 @itemx cut-left
12160 Cut off the specified number of characters from the left.
12161
12162 @item cut-right
12163 Cut off the specified number of characters from the right.
12164
12165 @item ignore
12166 Return an empty string if the field is equal to the specified value. 
12167
12168 @item form
12169 Use the specified form as the field value when the @samp{@@} spec is
12170 used. 
12171 @end table
12172
12173 Let's take an example.  The @samp{%o} spec in the summary mode lines
12174 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12175 This is quite a mouthful, so we want to shave off the century number and
12176 the time, leaving us with a six-character date.  That would be
12177 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
12178 maxing, and we need the padding to ensure that the date is never less
12179 than 6 characters to make it look nice in columns.)
12180
12181 Ignoring is done first; then cutting; then maxing; and then as the very
12182 last operation, padding.  
12183
12184 If you use lots of these advanced thingies, you'll find that Gnus gets
12185 quite slow.  This can be helped enormously by running @kbd{M-x
12186 gnus-compile} when you are satisfied with the look of your lines.
12187 @xref{Compilation}. 
12188
12189
12190 @node User-Defined Specs
12191 @subsection User-Defined Specs
12192
12193 All the specs allow for inserting user defined specifiers---@samp{u}.
12194 The next character in the format string should be a letter.  Gnus
12195 will call the function @code{gnus-user-format-function-}@samp{X}, where
12196 @samp{X} is the letter following @samp{%u}.  The function will be passed
12197 a single parameter---what the parameter means depends on what buffer
12198 it's being called from.  The function should return a string, which will
12199 be inserted into the buffer just like information from any other
12200 specifier.  This function may also be called with dummy values, so it
12201 should protect against that.
12202
12203 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12204 much the same without defining new functions.  Here's an example:
12205 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
12206 given here will be evaluated to yield the current line number, and then
12207 inserted.
12208
12209
12210 @node Formatting Fonts
12211 @subsection Formatting Fonts
12212
12213 There are specs for highlighting, and these are shared by all the format
12214 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
12215 the special @code{mouse-face} property set, which means that it will be
12216 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12217 over it.
12218
12219 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12220 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12221 default.  If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12222 instead, and so on.  Create as many faces as you wish.  The same goes
12223 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12224 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12225
12226 Here's an alternative recipe for the group buffer:
12227
12228 @lisp
12229 ;; Create three face types.
12230 (setq gnus-face-1 'bold)
12231 (setq gnus-face-3 'italic)
12232
12233 ;; We want the article count to be in 
12234 ;; a bold and green face.  So we create 
12235 ;; a new face called `my-green-bold'.
12236 (copy-face 'bold 'my-green-bold)
12237 ;; Set the color.
12238 (set-face-foreground 'my-green-bold "ForestGreen")
12239 (setq gnus-face-2 'my-green-bold)
12240
12241 ;; Set the new & fancy format.
12242 (setq gnus-group-line-format 
12243       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12244 @end lisp
12245
12246 I'm sure you'll be able to use this scheme to create totally unreadable
12247 and extremely vulgar displays.  Have fun!
12248
12249 Note that the @samp{%(} specs (and friends) do not make any sense on the
12250 mode-line variables.
12251
12252
12253 @node Windows Configuration
12254 @section Windows Configuration
12255 @cindex windows configuration
12256
12257 No, there's nothing here about X, so be quiet.
12258
12259 @vindex gnus-use-full-window
12260 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12261 other windows and occupy the entire Emacs screen by itself.  It is
12262 @code{t} by default.
12263
12264 @vindex gnus-buffer-configuration
12265 @code{gnus-buffer-configuration} describes how much space each Gnus
12266 buffer should be given.  Here's an excerpt of this variable:
12267
12268 @lisp
12269 ((group (vertical 1.0 (group 1.0 point)
12270                       (if gnus-carpal (group-carpal 4))))
12271  (article (vertical 1.0 (summary 0.25 point) 
12272                         (article 1.0))))
12273 @end lisp
12274
12275 This is an alist.  The @dfn{key} is a symbol that names some action or
12276 other.  For instance, when displaying the group buffer, the window
12277 configuration function will use @code{group} as the key.  A full list of
12278 possible names is listed below.
12279
12280 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12281 should occupy.  To take the @code{article} split as an example -
12282
12283 @lisp
12284 (article (vertical 1.0 (summary 0.25 point)
12285                        (article 1.0)))
12286 @end lisp
12287
12288 This @dfn{split} says that the summary buffer should occupy 25% of upper
12289 half of the screen, and that it is placed over the article buffer.  As
12290 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12291 reaching for that calculator there).  However, the special number
12292 @code{1.0} is used to signal that this buffer should soak up all the
12293 rest of the space available after the rest of the buffers have taken
12294 whatever they need.  There should be only one buffer with the @code{1.0}
12295 size spec per split.
12296
12297 Point will be put in the buffer that has the optional third element
12298 @code{point}. 
12299
12300 Here's a more complicated example:
12301
12302 @lisp
12303 (article (vertical 1.0 (group 4)
12304                        (summary 0.25 point)
12305                        (if gnus-carpal (summary-carpal 4))
12306                        (article 1.0)))
12307 @end lisp
12308
12309 If the size spec is an integer instead of a floating point number, 
12310 then that number will be used to say how many lines a buffer should
12311 occupy, not a percentage.
12312
12313 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12314 precise---if the @code{car} of the split is a function or a subr), this
12315 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
12316 be used as a split.  This means that there will be three buffers if
12317 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12318 is non-@code{nil}.
12319
12320 Not complicated enough for you?  Well, try this on for size:
12321
12322 @lisp
12323 (article (horizontal 1.0 
12324              (vertical 0.5
12325                  (group 1.0)
12326                  (gnus-carpal 4))
12327              (vertical 1.0
12328                  (summary 0.25 point)
12329                  (summary-carpal 4)
12330                  (article 1.0))))
12331 @end lisp
12332
12333 Whoops.  Two buffers with the mystery 100% tag.  And what's that
12334 @code{horizontal} thingie?  
12335
12336 If the first element in one of the split is @code{horizontal}, Gnus will
12337 split the window horizontally, giving you two windows side-by-side.
12338 Inside each of these strips you may carry on all you like in the normal
12339 fashion.  The number following @code{horizontal} says what percentage of
12340 the screen is to be given to this strip.
12341
12342 For each split, there @emph{must} be one element that has the 100% tag.
12343 The splitting is never accurate, and this buffer will eat any leftover
12344 lines from the splits.
12345
12346 To be slightly more formal, here's a definition of what a legal split
12347 may look like:
12348
12349 @example
12350 split       = frame | horizontal | vertical | buffer | form
12351 frame       = "(frame " size *split ")"
12352 horizontal  = "(horizontal " size *split ")"
12353 vertical    = "(vertical " size *split ")"
12354 buffer      = "(" buffer-name " " size *[ "point" ] ")"
12355 size        = number | frame-params
12356 buffer-name = group | article | summary ...
12357 @end example
12358
12359 The limitations are that the @code{frame} split can only appear as the
12360 top-level split.  @var{form} should be an Emacs Lisp form that should
12361 return a valid split.  We see that each split is fully recursive, and
12362 may contain any number of @code{vertical} and @code{horizontal} splits. 
12363
12364 @vindex gnus-window-min-width
12365 @vindex gnus-window-min-height
12366 @cindex window height
12367 @cindex window width
12368 Finding the right sizes can be a bit complicated.  No window may be less
12369 than @code{gnus-window-min-height} (default 1) characters high, and all
12370 windows must be at least @code{gnus-window-min-width} (default 1)
12371 characters wide.  Gnus will try to enforce this before applying the
12372 splits.  If you want to use the normal Emacs window width/height limit,
12373 you can just set these two variables to @code{nil}.
12374
12375 If you're not familiar with Emacs terminology, @code{horizontal} and
12376 @code{vertical} splits may work the opposite way of what you'd expect.
12377 Windows inside a @code{horizontal} split are shown side-by-side, and
12378 windows within a @code{vertical} split are shown above each other.
12379
12380 @findex gnus-configure-frame
12381 If you want to experiment with window placement, a good tip is to call
12382 @code{gnus-configure-frame} directly with a split.  This is the function
12383 that does all the real work when splitting buffers.  Below is a pretty
12384 nonsensical configuration with 5 windows; two for the group buffer and
12385 three for the article buffer.  (I said it was nonsensical.)  If you
12386 @code{eval} the statement below, you can get an idea of how that would
12387 look straight away, without going through the normal Gnus channels.
12388 Play with it until you're satisfied, and then use
12389 @code{gnus-add-configuration} to add your new creation to the buffer
12390 configuration list. 
12391
12392 @lisp
12393 (gnus-configure-frame
12394  '(horizontal 1.0
12395     (vertical 10
12396       (group 1.0)
12397       (article 0.3 point))
12398     (vertical 1.0
12399       (article 1.0)
12400       (horizontal 4
12401         (group 1.0)
12402         (article 10)))))
12403 @end lisp
12404
12405 You might want to have several frames as well.  No prob---just use the
12406 @code{frame} split:
12407
12408 @lisp
12409 (gnus-configure-frame
12410  '(frame 1.0
12411          (vertical 1.0
12412                    (summary 0.25 point)
12413                    (article 1.0))
12414          (vertical ((height . 5) (width . 15)
12415                     (user-position . t)
12416                     (left . -1) (top . 1))
12417                    (picon 1.0))))
12418
12419 @end lisp
12420
12421 This split will result in the familiar summary/article window
12422 configuration in the first (or ``main'') frame, while a small additional
12423 frame will be created where picons will be shown.  As you can see,
12424 instead of the normal @code{1.0} top-level spec, each additional split
12425 should have a frame parameter alist as the size spec.
12426 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12427 Reference Manual}.
12428
12429 Here's a list of all possible keys for
12430 @code{gnus-buffer-configuration}:
12431
12432 @code{group}, @code{summary}, @code{article}, @code{server},
12433 @code{browse}, @code{message}, @code{pick}, @code{info},
12434 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12435 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12436 @code{reply-yank}, @code{mail-bounce}, @code{draft},
12437 @code{pipe}, @code{bug}, @code{compose-bounce}.  
12438
12439 Note that the @code{message} key is used for both
12440 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
12441 it is desirable to distinguish between the two, something like this
12442 might be used:
12443
12444 @lisp
12445 (message (horizontal 1.0
12446                      (vertical 1.0 (message 1.0 point))
12447                      (vertical 0.24
12448                                (if (buffer-live-p gnus-summary-buffer)
12449                                    '(summary 0.5))
12450                                (group 1.0)))))
12451 @end lisp
12452
12453 @findex gnus-add-configuration
12454 Since the @code{gnus-buffer-configuration} variable is so long and
12455 complicated, there's a function you can use to ease changing the config
12456 of a single setting: @code{gnus-add-configuration}.  If, for instance,
12457 you want to change the @code{article} setting, you could say:
12458
12459 @lisp
12460 (gnus-add-configuration
12461  '(article (vertical 1.0
12462                (group 4)
12463                (summary .25 point)
12464                (article 1.0))))
12465 @end lisp
12466
12467 You'd typically stick these @code{gnus-add-configuration} calls in your
12468 @file{.gnus.el} file or in some startup hook---they should be run after
12469 Gnus has been loaded.
12470
12471 @vindex gnus-always-force-window-configuration
12472 If all windows mentioned in the configuration are already visible, Gnus
12473 won't change the window configuration.  If you always want to force the
12474 ``right'' window configuration, you can set
12475 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12476
12477
12478 @node Compilation
12479 @section Compilation
12480 @cindex compilation
12481 @cindex byte-compilation
12482
12483 @findex gnus-compile
12484
12485 Remember all those line format specification variables?
12486 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12487 on.  Now, Gnus will of course heed whatever these variables are, but,
12488 unfortunately, changing them will mean a quite significant slow-down.
12489 (The default values of these variables have byte-compiled functions
12490 associated with them, while the user-generated versions do not, of
12491 course.) 
12492
12493 To help with this, you can run @kbd{M-x gnus-compile} after you've
12494 fiddled around with the variables and feel that you're (kind of)
12495 satisfied.  This will result in the new specs being byte-compiled, and
12496 you'll get top speed again.  Gnus will save these compiled specs in the
12497 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
12498 this function, though---you should compile them yourself by sticking
12499 them into the @code{.gnus.el} file and byte-compiling that file.)
12500
12501
12502 @node Mode Lines
12503 @section Mode Lines
12504 @cindex mode lines
12505
12506 @vindex gnus-updated-mode-lines
12507 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12508 lines updated.  It is a list of symbols.  Supported symbols include
12509 @code{group}, @code{article}, @code{summary}, @code{server},
12510 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
12511 Gnus will keep that mode line updated with information that may be
12512 pertinent.  If this variable is @code{nil}, screen refresh may be
12513 quicker.
12514
12515 @cindex display-time
12516
12517 @vindex gnus-mode-non-string-length
12518 By default, Gnus displays information on the current article in the mode
12519 lines of the summary and article buffers.  The information Gnus wishes
12520 to display (e.g. the subject of the article) is often longer than the
12521 mode lines, and therefore have to be cut off at some point.  The
12522 @code{gnus-mode-non-string-length} variable says how long the other
12523 elements on the line is (i.e., the non-info part).  If you put
12524 additional elements on the mode line (e.g. a clock), you should modify
12525 this variable:
12526
12527 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12528 @lisp
12529 (add-hook 'display-time-hook
12530           (lambda () (setq gnus-mode-non-string-length
12531                            (+ 21
12532                               (if line-number-mode 5 0)
12533                               (if column-number-mode 4 0)
12534                               (length display-time-string)))))
12535 @end lisp
12536
12537 If this variable is @code{nil} (which is the default), the mode line
12538 strings won't be chopped off, and they won't be padded either.
12539
12540
12541 @node Highlighting and Menus
12542 @section Highlighting and Menus
12543 @cindex visual
12544 @cindex highlighting
12545 @cindex menus
12546
12547 @vindex gnus-visual
12548 The @code{gnus-visual} variable controls most of the prettifying Gnus
12549 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
12550 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
12551 file.
12552
12553 This variable can be a list of visual properties that are enabled.  The
12554 following elements are legal, and are all included by default:
12555
12556 @table @code
12557 @item group-highlight
12558 Do highlights in the group buffer.
12559 @item summary-highlight
12560 Do highlights in the summary buffer.
12561 @item article-highlight
12562 Do highlights in the article buffer.
12563 @item highlight
12564 Turn on highlighting in all buffers.
12565 @item group-menu
12566 Create menus in the group buffer.
12567 @item summary-menu
12568 Create menus in the summary buffers.
12569 @item article-menu
12570 Create menus in the article buffer.
12571 @item browse-menu
12572 Create menus in the browse buffer.
12573 @item server-menu
12574 Create menus in the server buffer.
12575 @item score-menu
12576 Create menus in the score buffers.
12577 @item menu
12578 Create menus in all buffers.
12579 @end table
12580
12581 So if you only want highlighting in the article buffer and menus in all
12582 buffers, you could say something like:
12583
12584 @lisp
12585 (setq gnus-visual '(article-highlight menu))
12586 @end lisp
12587
12588 If you want only highlighting and no menus whatsoever, you'd say:
12589
12590 @lisp
12591 (setq gnus-visual '(highlight))
12592 @end lisp
12593
12594 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12595 in all Gnus buffers.
12596
12597 Other general variables that influence the look of all buffers include:
12598
12599 @table @code
12600 @item gnus-mouse-face
12601 @vindex gnus-mouse-face
12602 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
12603 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12604
12605 @item gnus-display-type
12606 @vindex gnus-display-type
12607 This variable is symbol indicating the display type Emacs is running
12608 under.  The symbol should be one of @code{color}, @code{grayscale} or
12609 @code{mono}.  If Gnus guesses this display attribute wrongly, either set
12610 this variable in your @file{~/.emacs} or set the resource
12611 @code{Emacs.displayType} in your @file{~/.Xdefaults}.
12612
12613 @item gnus-background-mode 
12614 @vindex gnus-background-mode 
12615 This is a symbol indicating the Emacs background brightness.  The symbol
12616 should be one of @code{light} or @code{dark}.  If Gnus guesses this
12617 frame attribute wrongly, either set this variable in your @file{~/.emacs} or
12618 set the resource @code{Emacs.backgroundMode} in your @file{~/.Xdefaults}. 
12619 `gnus-display-type'.
12620 @end table
12621
12622 There are hooks associated with the creation of all the different menus:
12623
12624 @table @code
12625
12626 @item gnus-article-menu-hook
12627 @vindex gnus-article-menu-hook
12628 Hook called after creating the article mode menu.
12629
12630 @item gnus-group-menu-hook
12631 @vindex gnus-group-menu-hook
12632 Hook called after creating the group mode menu.
12633
12634 @item gnus-summary-menu-hook
12635 @vindex gnus-summary-menu-hook
12636 Hook called after creating the summary mode menu.
12637
12638 @item gnus-server-menu-hook
12639 @vindex gnus-server-menu-hook
12640 Hook called after creating the server mode menu.
12641
12642 @item gnus-browse-menu-hook
12643 @vindex gnus-browse-menu-hook
12644 Hook called after creating the browse mode menu.
12645
12646 @item gnus-score-menu-hook
12647 @vindex gnus-score-menu-hook
12648 Hook called after creating the score mode menu.
12649
12650 @end table
12651
12652
12653 @node Buttons
12654 @section Buttons
12655 @cindex buttons
12656 @cindex mouse
12657 @cindex click
12658
12659 Those new-fangled @dfn{mouse} contraptions is very popular with the
12660 young, hep kids who don't want to learn the proper way to do things
12661 these days.  Why, I remember way back in the summer of '89, when I was
12662 using Emacs on a Tops 20 system.  Three hundred users on one single
12663 machine, and every user was running Simula compilers.  Bah!
12664
12665 Right.
12666
12667 @vindex gnus-carpal
12668 Well, you can make Gnus display bufferfuls of buttons you can click to
12669 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
12670 really.  Tell the chiropractor I sent you.
12671
12672
12673 @table @code
12674
12675 @item gnus-carpal-mode-hook
12676 @vindex gnus-carpal-mode-hook
12677 Hook run in all carpal mode buffers.
12678
12679 @item gnus-carpal-button-face
12680 @vindex gnus-carpal-button-face
12681 Face used on buttons.
12682
12683 @item gnus-carpal-header-face
12684 @vindex gnus-carpal-header-face
12685 Face used on carpal buffer headers.
12686
12687 @item gnus-carpal-group-buffer-buttons
12688 @vindex gnus-carpal-group-buffer-buttons
12689 Buttons in the group buffer.
12690
12691 @item gnus-carpal-summary-buffer-buttons
12692 @vindex gnus-carpal-summary-buffer-buttons
12693 Buttons in the summary buffer.
12694
12695 @item gnus-carpal-server-buffer-buttons
12696 @vindex gnus-carpal-server-buffer-buttons
12697 Buttons in the server buffer.
12698
12699 @item gnus-carpal-browse-buffer-buttons
12700 @vindex gnus-carpal-browse-buffer-buttons
12701 Buttons in the browse buffer.
12702 @end table
12703
12704 All the @code{buttons} variables are lists.  The elements in these list
12705 is either a cons cell where the car contains a text to be displayed and
12706 the cdr contains a function symbol, or a simple string.
12707
12708
12709 @node Daemons
12710 @section Daemons
12711 @cindex demons
12712 @cindex daemons
12713
12714 Gnus, being larger than any program ever written (allegedly), does lots
12715 of strange stuff that you may wish to have done while you're not
12716 present.  For instance, you may want it to check for new mail once in a
12717 while.  Or you may want it to close down all connections to all servers
12718 when you leave Emacs idle.  And stuff like that.
12719
12720 Gnus will let you do stuff like that by defining various
12721 @dfn{handlers}.  Each handler consists of three elements:  A
12722 @var{function}, a @var{time}, and an @var{idle} parameter.
12723
12724 Here's an example of a handler that closes connections when Emacs has
12725 been idle for thirty minutes:
12726
12727 @lisp
12728 (gnus-demon-close-connections nil 30)
12729 @end lisp
12730
12731 Here's a handler that scans for PGP headers every hour when Emacs is
12732 idle: 
12733
12734 @lisp
12735 (gnus-demon-scan-pgp 60 t)
12736 @end lisp
12737
12738 This @var{time} parameter and than @var{idle} parameter works together
12739 in a strange, but wonderful fashion.  Basically, if @var{idle} is
12740 @code{nil}, then the function will be called every @var{time} minutes.
12741
12742 If @var{idle} is @code{t}, then the function will be called after
12743 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
12744 the function will never be called.  But once Emacs goes idle, the
12745 function will be called every @var{time} minutes.
12746
12747 If @var{idle} is a number and @var{time} is a number, the function will
12748 be called every @var{time} minutes only when Emacs has been idle for
12749 @var{idle} minutes.
12750
12751 If @var{idle} is a number and @var{time} is @code{nil}, the function
12752 will be called once every time Emacs has been idle for @var{idle}
12753 minutes.  
12754
12755 And if @var{time} is a string, it should look like @samp{07:31}, and
12756 the function will then be called once every day somewhere near that
12757 time.  Modified by the @var{idle} parameter, of course.
12758
12759 @vindex gnus-demon-timestep
12760 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
12761 seconds.  This is 60 by default.  If you change that variable,
12762 all the timings in the handlers will be affected.)
12763
12764 @vindex gnus-use-demon
12765 To set the whole thing in motion, though, you have to set
12766 @code{gnus-use-demon} to @code{t}.
12767
12768 So, if you want to add a handler, you could put something like this in
12769 your @file{.gnus} file:
12770
12771 @findex gnus-demon-add-handler
12772 @lisp
12773 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
12774 @end lisp
12775
12776 @findex gnus-demon-add-nocem
12777 @findex gnus-demon-add-scanmail
12778 @findex gnus-demon-add-rescan
12779 @findex gnus-demon-add-disconnection
12780 Some ready-made functions to do this has been created:
12781 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
12782 @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}.  Just
12783 put those functions in your @file{.gnus} if you want those abilities.
12784
12785 @findex gnus-demon-init
12786 @findex gnus-demon-cancel
12787 @vindex gnus-demon-handlers
12788 If you add handlers to @code{gnus-demon-handlers} directly, you should
12789 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
12790 daemons, you can use the @code{gnus-demon-cancel} function.
12791
12792 Note that adding daemons can be pretty naughty if you overdo it.  Adding
12793 functions that scan all news and mail from all servers every two seconds
12794 is a sure-fire way of getting booted off any respectable system.  So
12795 behave. 
12796
12797
12798 @node NoCeM
12799 @section NoCeM
12800 @cindex nocem
12801 @cindex spam
12802
12803 @dfn{Spamming} is posting the same article lots and lots of times.
12804 Spamming is bad.  Spamming is evil.  
12805
12806 Spamming is usually canceled within a day or so by various anti-spamming
12807 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
12808 NoCeM is pronounced ``no see-'em'', and means what the name
12809 implies---these are messages that make the offending articles, like, go
12810 away.  
12811
12812 What use are these NoCeM messages if the articles are canceled anyway?
12813 Some sites do not honor cancel messages and some sites just honor cancels
12814 from a select few people.  Then you may wish to make use of the NoCeM
12815 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
12816
12817 Gnus can read and parse the messages in this group automatically, and
12818 this will make spam disappear.  
12819
12820 There are some variables to customize, of course:
12821
12822 @table @code
12823 @item gnus-use-nocem
12824 @vindex gnus-use-nocem
12825 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
12826 by default. 
12827
12828 @item gnus-nocem-groups
12829 @vindex gnus-nocem-groups
12830 Gnus will look for NoCeM messages in the groups in this list.  The
12831 default is @code{("alt.nocem.misc" "news.admin.net-abuse.announce")}. 
12832
12833 @item gnus-nocem-issuers
12834 @vindex gnus-nocem-issuers
12835 There are many people issuing NoCeM messages.  This list says what
12836 people you want to listen to.  The default is @code{("Automoose-1"
12837 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
12838 (Richard E. Depew)")}; fine, upstanding citizens all of them.
12839
12840 Known despammers that you can put in this list include:
12841
12842 @table @samp
12843 @item clewis@@ferret.ocunix.on.ca;
12844 @cindex Chris Lewis
12845 Chris Lewis---Major Canadian despammer who has probably canceled more
12846 usenet abuse than anybody else.
12847
12848 @item Automoose-1
12849 @cindex CancelMoose[tm]
12850 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
12851 Norwegian, and was the person(s) who invented NoCeM.  
12852
12853 @item jem@@xpat.com;
12854 @cindex Jem
12855 John Milburn---despammer located in Korea who is getting very busy these
12856 days.
12857
12858 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
12859 Richard E. Depew---lone American despammer.  He mostly cancels binary
12860 postings to non-binary groups and removes spews (regurgitated articles).
12861 @end table
12862
12863 You do not have to heed NoCeM messages from all these people---just the
12864 ones you want to listen to.
12865
12866 @item gnus-nocem-directory
12867 @vindex gnus-nocem-directory
12868 This is where Gnus will store its NoCeM cache files.  The default is
12869 @file{~/News/NoCeM/}. 
12870
12871 @item gnus-nocem-expiry-wait
12872 @vindex gnus-nocem-expiry-wait
12873 The number of days before removing old NoCeM entries from the cache.
12874 The default is 15.  If you make it shorter Gnus will be faster, but you
12875 might then see old spam.
12876
12877 @end table
12878
12879
12880 @node Picons
12881 @section Picons
12882
12883 So...  You want to slow down your news reader even more!  This is a
12884 good way to do so.  Its also a great way to impress people staring
12885 over your shoulder as you read news.
12886
12887 @menu
12888 * Picon Basics::           What are picons and How do I get them.
12889 * Picon Requirements::     Don't go further if you aren't using XEmacs.
12890 * Easy Picons::            Displaying Picons---the easy way.
12891 * Hard Picons::            The way you should do it.  You'll learn something.
12892 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
12893 @end menu
12894
12895
12896 @node Picon Basics
12897 @subsection Picon Basics
12898
12899 What are Picons?  To quote directly from the Picons Web site:
12900
12901 @quotation 
12902 @dfn{Picons} is short for ``personal icons''.  They're small,
12903 constrained images used to represent users and domains on the net,
12904 organized into databases so that the appropriate image for a given
12905 e-mail address can be found.  Besides users and domains, there are picon
12906 databases for Usenet newsgroups and weather forecasts.  The picons are
12907 in either monochrome @code{XBM} format or color @code{XPM} and
12908 @code{GIF} formats.
12909 @end quotation
12910
12911 For instructions on obtaining and installing the picons databases, point
12912 your Web browser at
12913 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
12914
12915 @vindex gnus-picons-database
12916 Gnus expects picons to be installed into a location pointed to by
12917 @code{gnus-picons-database}.
12918
12919
12920 @node Picon Requirements
12921 @subsection Picon Requirements
12922
12923 To use have Gnus display Picons for you, you must be running XEmacs
12924 19.13 or greater since all other versions of Emacs aren't yet able to
12925 display images.
12926
12927 Additionally, you must have @code{xpm} support compiled into XEmacs.
12928
12929 @vindex gnus-picons-convert-x-face
12930 If you want to display faces from @code{X-Face} headers, you must have
12931 the @code{netpbm} utilities installed, or munge the
12932 @code{gnus-picons-convert-x-face} variable to use something else.
12933
12934
12935 @node Easy Picons
12936 @subsection Easy Picons
12937
12938 To enable displaying picons, simply put the following line in your
12939 @file{~/.gnus} file and start Gnus.
12940
12941 @lisp
12942 (setq gnus-use-picons t)
12943 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
12944 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
12945 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
12946 @end lisp
12947
12948
12949 @node Hard Picons
12950 @subsection Hard Picons 
12951
12952 Gnus can display picons for you as you enter and leave groups and
12953 articles.  It knows how to interact with three sections of the picons
12954 database.  Namely, it can display the picons newsgroup pictures,
12955 author's face picture(s), and the authors domain.  To enable this
12956 feature, you need to first decide where to display them.
12957
12958 @table @code 
12959
12960 @item gnus-picons-display-where 
12961 @vindex gnus-picons-display-where 
12962 Where the picon images should be displayed.  It is @code{picons} by
12963 default (which by default maps to the buffer @samp{*Picons*}).  Other
12964 valid places could be @code{article}, @code{summary}, or
12965 @samp{*scratch*} for all I care.  Just make sure that you've made the
12966 buffer visible using the standard Gnus window configuration
12967 routines---@pxref{Windows Configuration}.
12968
12969 @end table
12970
12971 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
12972 window configuration for you to include the @code{picons} buffer.
12973
12974 Now that you've made that decision, you need to add the following
12975 functions to the appropriate hooks so these pictures will get
12976 displayed at the right time.
12977
12978 @vindex gnus-article-display-hook
12979 @vindex gnus-picons-display-where
12980 @table @code
12981 @item gnus-article-display-picons
12982 @findex gnus-article-display-picons
12983 Looks up and display the picons for the author and the author's domain
12984 in the @code{gnus-picons-display-where} buffer.  Should be added to
12985 the @code{gnus-article-display-hook}.
12986
12987 @item gnus-group-display-picons
12988 @findex gnus-article-display-picons
12989 Displays picons representing the current group.  This function should
12990 be added to the @code{gnus-summary-prepare-hook} or to the
12991 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
12992 is set to @code{article}.
12993
12994 @item gnus-picons-article-display-x-face
12995 @findex gnus-article-display-picons
12996 Decodes and displays the X-Face header if present.  This function
12997 should be added to @code{gnus-article-display-hook}.
12998
12999 @end table
13000
13001 Note:  You must append them to the hook, so make sure to specify 't'
13002 to the append flag of @code{add-hook}:
13003
13004 @lisp
13005 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13006 @end lisp
13007
13008
13009 @node Picon Configuration
13010 @subsection Picon Configuration
13011
13012 The following variables offer further control over how things are
13013 done, where things are located, and other useless stuff you really
13014 don't need to worry about.
13015
13016 @table @code
13017 @item gnus-picons-database
13018 @vindex gnus-picons-database
13019 The location of the picons database.  Should point to a directory
13020 containing the @file{news}, @file{domains}, @file{users} (and so on)
13021 subdirectories.  Defaults to @file{/usr/local/faces}.
13022
13023 @item gnus-picons-news-directory
13024 @vindex gnus-picons-news-directory
13025 Sub-directory of the faces database containing the icons for
13026 newsgroups.
13027
13028 @item gnus-picons-user-directories
13029 @vindex gnus-picons-user-directories
13030 List of subdirectories to search in @code{gnus-picons-database} for user
13031 faces.  @code{("local" "users" "usenix" "misc/MISC")} is the default.
13032
13033 @item gnus-picons-domain-directories
13034 @vindex gnus-picons-domain-directories
13035 List of subdirectories to search in @code{gnus-picons-database} for
13036 domain name faces.  Defaults to @code{("domains")}.  Some people may
13037 want to add @samp{unknown} to this list.
13038
13039 @item gnus-picons-convert-x-face
13040 @vindex gnus-picons-convert-x-face
13041 The command to use to convert the @code{X-Face} header to an X bitmap
13042 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
13043 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13044 gnus-picons-x-face-file-name)}
13045
13046 @item gnus-picons-x-face-file-name
13047 @vindex gnus-picons-x-face-file-name
13048 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
13049 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13050
13051 @item gnus-picons-buffer
13052 @vindex gnus-picons-buffer
13053 The name of the buffer that @code{picons} points to.  Defaults to
13054 @samp{*Icon Buffer*}.
13055
13056 @end table
13057
13058
13059 @node Undo
13060 @section Undo
13061 @cindex undo
13062
13063 It is very useful to be able to undo actions one has done.  In normal
13064 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13065 In Gnus buffers, however, it isn't that simple.
13066
13067 The things Gnus displays in its buffer is of no value whatsoever to
13068 Gnus---it's all just data that is designed to look nice to the user.
13069 Killing a group in the group buffer with @kbd{C-k} makes the line
13070 disappear, but that's just a side-effect of the real action---the
13071 removal of the group in question from the internal Gnus structures.
13072 Undoing something like that can't be done by the normal Emacs
13073 @code{undo} function.
13074
13075 Gnus tries to remedy this somewhat by keeping track of what the user
13076 does and coming up with actions that would reverse the actions the user
13077 takes.  When the user then presses the @code{undo} key, Gnus will run
13078 the code to reverse the previous action, or the previous actions.
13079 However, not all actions are easily reversible, so Gnus currently offers
13080 a few key functions to be undoable.  These include killing groups,
13081 yanking groups, and changing the list of read articles of groups.
13082 That's it, really.  More functions may be added in the future, but each
13083 added function means an increase in data to be stored, so Gnus will
13084 never be totally undoable.
13085
13086 @findex gnus-undo-mode
13087 @vindex gnus-use-undo
13088 @findex gnus-undo
13089 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
13090 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13091 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
13092 command, which should feel kinda like the normal Emacs @code{undo}
13093 command. 
13094
13095
13096 @node Moderation
13097 @section Moderation
13098 @cindex moderation
13099
13100 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13101 It is not included in the standard Gnus package.  Write a mail to
13102 @samp{larsi@@ifi.uio.no} and state what group you moderate, and you'll
13103 get a copy.
13104
13105 The moderation package is implemented as a minor mode for summary
13106 buffers.  Put
13107
13108 @lisp
13109 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13110 @end lisp
13111
13112 in your @file{.gnus.el} file.
13113
13114 If you are the moderation of @samp{rec.zoofle}, this is how it's
13115 supposed to work:
13116
13117 @enumerate
13118 @item 
13119 You split your incoming mail by matching on
13120 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13121 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13122
13123 @item
13124 You enter that group once in a while and post articles using the @kbd{e}
13125 (edit-and-post) or @kbd{s} (just send unedited) commands.
13126
13127 @item
13128 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13129 articles that weren't approved by you, you can cancel them with the
13130 @kbd{c} command.
13131 @end enumerate
13132
13133 To use moderation mode in these two groups, say:
13134
13135 @lisp
13136 (setq gnus-moderated-list
13137       "^nnml:rec.zoofle$\\|^rec.zoofle$")
13138 @end lisp
13139
13140
13141 @node XEmacs Enhancements
13142 @section XEmacs Enhancements
13143 @cindex XEmacs
13144
13145 XEmacs is able to display pictures and stuff, so Gnus has taken
13146 advantage of that.  Relevant variables include:
13147
13148 @table @code
13149 @item gnus-xmas-glyph-directory
13150 @vindex gnus-xmas-glyph-directory
13151 This is where Gnus will look for pictures.  Gnus will normally
13152 auto-detect this directory, but you may set it manually if you have an
13153 unusual directory structure.
13154
13155 @item gnus-xmas-logo-color-alist
13156 @vindex gnus-xmas-logo-color-alist
13157 This is an alist where the key is a type symbol and the values are the
13158 foreground and background color of the splash page glyph.
13159
13160 @item gnus-xmas-logo-color-style
13161 @vindex gnus-xmas-logo-color-style
13162 This is the key used to look up the color in the alist described above.
13163 Legal values include @code{flame}, @code{pine}, @code{moss},
13164 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13165 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13166
13167 @item gnus-use-toolbar
13168 @vindex gnus-use-toolbar
13169 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
13170 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13171 @code{right-toolbar}, or @code{left-toolbar}.
13172
13173 @item gnus-group-toolbar
13174 @vindex gnus-group-toolbar
13175 The toolbar in the group buffer.
13176
13177 @item gnus-summary-toolbar
13178 @vindex gnus-summary-toolbar
13179 The toolbar in the summary buffer.
13180
13181 @item gnus-summary-mail-toolbar
13182 @vindex gnus-summary-mail-toolbar
13183 The toolbar in the summary buffer of mail groups.
13184
13185 @item gnus-xmas-modeline-glyph
13186 @vindex gnus-xmas-modeline-glyph
13187 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
13188 default. 
13189
13190 @end table
13191
13192
13193 @node Various Various
13194 @section Various Various
13195 @cindex mode lines
13196 @cindex highlights
13197
13198 @table @code
13199
13200 @item gnus-directory
13201 @vindex gnus-directory
13202 All Gnus directories will be initialized from this variable, which
13203 defaults to the @samp{SAVEDIR} environment variable, or @file{~/News/}
13204 if that variable isn't set.
13205
13206 @item gnus-default-directory
13207 @vindex gnus-default-directory
13208 Not related to the above variable at all---this variable says what the
13209 default directory of all Gnus buffers should be.  If you issue commands
13210 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13211 default directory.  If this variable is @code{nil} (which is the
13212 default), the default directory will be the default directory of the
13213 buffer you were in when you started Gnus.
13214
13215 @item gnus-verbose
13216 @vindex gnus-verbose
13217 This variable is an integer between zero and ten.  The higher the value,
13218 the more messages will be displayed.  If this variable is zero, Gnus
13219 will never flash any messages, if it is seven (which is the default),
13220 most important messages will be shown, and if it is ten, Gnus won't ever
13221 shut up, but will flash so many messages it will make your head swim.
13222
13223 @item gnus-verbose-backends
13224 @vindex gnus-verbose-backends
13225 This variable works the same way as @code{gnus-verbose}, but it applies
13226 to the Gnus backends instead of Gnus proper.
13227
13228 @item nnheader-max-head-length
13229 @vindex nnheader-max-head-length
13230 When the backends read straight heads of articles, they all try to read
13231 as little as possible.  This variable (default 4096) specifies
13232 the absolute max length the backends will try to read before giving up
13233 on finding a separator line between the head and the body.  If this
13234 variable is @code{nil}, there is no upper read bound.  If it is
13235 @code{t}, the backends won't try to read the articles piece by piece,
13236 but read the entire articles.  This makes sense with some versions of
13237 @code{ange-ftp}. 
13238
13239 @item nnheader-head-chop-length
13240 @vindex nnheader-head-chop-length
13241 This variable says how big a piece of each article to read when doing
13242 the operation described above.
13243
13244 @item nnheader-file-name-translation-alist 
13245 @vindex nnheader-file-name-translation-alist 
13246 @cindex file names
13247 @cindex illegal characters in file names
13248 @cindex characters in file names
13249 This is an alist that says how to translate characters in file names.
13250 For instance, if @samp{:} is illegal as a file character in file names
13251 on your system (you OS/2 user you), you could say something like:
13252
13253 @lisp
13254 (setq nnheader-file-name-translation-alist 
13255       '((?: . ?_)))
13256 @end lisp
13257
13258 In fact, this is the default value for this variable on OS/2 and MS
13259 Windows (phooey) systems.
13260
13261 @item gnus-hidden-properties
13262 @vindex gnus-hidden-properties
13263 This is a list of properties to use to hide ``invisible'' text.  It is
13264 @code{(invisible t intangible t)} by default on most systems, which
13265 makes invisible text invisible and intangible.
13266
13267 @item gnus-parse-headers-hook
13268 @vindex gnus-parse-headers-hook
13269 A hook called before parsing headers.  It can be used, for instance, to
13270 gather statistics on the headers fetched, or perhaps you'd like to prune
13271 some headers.  I don't see why you'd want that, though.
13272
13273 @item gnus-shell-command-separator
13274 @vindex gnus-shell-command-separator
13275 String used to separate to shell commands.  The default is @samp{;}. 
13276
13277
13278 @end table
13279
13280
13281 @node The End
13282 @chapter The End
13283
13284 Well, that's the manual---you can get on with your life now.  Keep in
13285 touch.  Say hello to your cats from me.  
13286
13287 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
13288
13289 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13290
13291 @quotation
13292 @strong{Te Deum}
13293
13294 @sp 1
13295 Not because of victories @*
13296 I sing,@*
13297 having none,@*
13298 but for the common sunshine,@*
13299 the breeze,@*
13300 the largess of the spring.
13301
13302 @sp 1
13303 Not for victory@*
13304 but for the day's work done@*
13305 as well as I was able;@*
13306 not for a seat upon the dais@*
13307 but at the common table.@*
13308 @end quotation
13309
13310
13311 @node Appendices
13312 @chapter Appendices
13313
13314 @menu
13315 * History::                        How Gnus got where it is today.
13316 * Terminology::                    We use really difficult, like, words here.
13317 * Customization::                  Tailoring Gnus to your needs.
13318 * Troubleshooting::                What you might try if things do not work.
13319 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
13320 * Emacs for Heathens::             A short introduction to Emacsian terms.
13321 * Frequently Asked Questions::     A question-and-answer session.
13322 @end menu
13323
13324
13325 @node History
13326 @section History
13327
13328 @cindex history
13329 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
13330 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13331
13332 If you want to investigate the person responsible for this outrage, you
13333 can point your (feh!) web browser to
13334 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
13335 distribution point for the new and spiffy versions of Gnus, and is known
13336 as The Site That Destroys Newsrcs And Drives People Mad.
13337
13338 During the first extended alpha period of development, the new Gnus was
13339 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
13340 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13341 (Besides, the ``Gnus'' in this abbreviation should probably be
13342 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13343 appropriate name, don't you think?)
13344
13345 In any case, after spending all that energy on coming up with a new and
13346 spunky name, we decided that the name was @emph{too} spunky, so we
13347 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
13348 ``@sc{gnus}''.  New vs. old.
13349
13350 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13351 was included in the Emacs 19.30 distribution.
13352
13353 In May 1996 the next Gnus generation (aka.  ``September Gnus'') was
13354 released under the name ``Gnus 5.2''.  
13355
13356 On July 28th 1996 work on Red Gnus was begun.
13357
13358 If you happen upon a version of Gnus that has a name that is prefixed --
13359 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Mamey Sapote Gnus''
13360 -- don't panic.  Don't let it know that you're frightened.  Back away.
13361 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
13362 out of its reach.  Find a proper released version of Gnus and snuggle up
13363 to that instead.
13364
13365 @menu
13366 * Why?::                What's the point of Gnus?
13367 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
13368 * Conformity::          Gnus tries to conform to all standards.
13369 * Emacsen::             Gnus can be run on a few modern Emacsen.
13370 * Contributors::        Oodles of people.  
13371 * New Features::        Pointers to some of the new stuff in Gnus.
13372 * Newest Features::     Features so new that they haven't been written yet.
13373 @end menu
13374
13375
13376 @node Why?
13377 @subsection Why?
13378
13379 What's the point of Gnus?  
13380
13381 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13382 newsreader, that lets you do anything you can think of.  That was my
13383 original motivation, but while working on Gnus, it has become clear to
13384 me that this generation of newsreaders really belong in the stone age.
13385 Newsreaders haven't developed much since the infancy of the net.  If the
13386 volume continues to rise with the current rate of increase, all current
13387 newsreaders will be pretty much useless.  How do you deal with
13388 newsgroups that have thousands of new articles each day?  How do you
13389 keep track of millions of people who post?
13390
13391 Gnus offers no real solutions to these questions, but I would very much
13392 like to see Gnus being used as a testing ground for new methods of
13393 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
13394 to separate the newsreader from the backends, Gnus now offers a simple
13395 interface for anybody who wants to write new backends for fetching mail
13396 and news from different sources.  I have added hooks for customizations
13397 everywhere I could imagine useful.  By doing so, I'm inviting every one
13398 of you to explore and invent.
13399
13400 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}. 
13401
13402
13403 @node Compatibility
13404 @subsection Compatibility
13405
13406 @cindex compatibility
13407 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
13408 bindings have been kept.  More key bindings have been added, of course,
13409 but only in one or two obscure cases have old bindings been changed.
13410
13411 Our motto is:
13412 @quotation
13413 @cartouche
13414 @center In a cloud bones of steel.
13415 @end cartouche
13416 @end quotation
13417
13418 All commands have kept their names.  Some internal functions have changed
13419 their names.
13420
13421 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13422 Articles}. 
13423
13424 One major compatibility question is the presence of several summary
13425 buffers.  All variables that are relevant while reading a group are
13426 buffer-local to the summary buffer they belong in.  Although many
13427 important variables have their values copied into their global
13428 counterparts whenever a command is executed in the summary buffer, this
13429 change might lead to incorrect values being used unless you are careful.
13430
13431 All code that relies on knowledge of @sc{gnus} internals will probably
13432 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
13433 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
13434 maintains a hash table that points to the entries in this alist (which
13435 speeds up many functions), and changing the alist directly will lead to
13436 peculiar results.
13437
13438 @cindex hilit19
13439 @cindex highlighting
13440 Old hilit19 code does not work at all.  In fact, you should probably
13441 remove all hilit code from all Gnus hooks
13442 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13443 Gnus provides various integrated functions for highlighting.  These are
13444 faster and more accurate.  To make life easier for everybody, Gnus will
13445 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
13446 Away!
13447
13448 Packages like @code{expire-kill} will no longer work.  As a matter of
13449 fact, you should probably remove all old @sc{gnus} packages (and other
13450 code) when you start using Gnus.  More likely than not, Gnus already
13451 does what you have written code to make @sc{gnus} do.  (Snicker.)
13452
13453 Even though old methods of doing things are still supported, only the
13454 new methods are documented in this manual.  If you detect a new method of
13455 doing something while reading this manual, that does not mean you have
13456 to stop doing it the old way.
13457
13458 Gnus understands all @sc{gnus} startup files.
13459
13460 @kindex M-x gnus-bug
13461 @findex gnus-bug
13462 @cindex reporting bugs
13463 @cindex bugs
13464 Overall, a casual user who hasn't written much code that depends on
13465 @sc{gnus} internals should suffer no problems.  If problems occur,
13466 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13467
13468
13469 @node Conformity
13470 @subsection Conformity
13471
13472 No rebels without a clue here, ma'am.  We conform to all standards known
13473 to (wo)man.  Except for those standards and/or conventions we disagree
13474 with, of course.
13475
13476 @table @strong
13477
13478 @item RFC 822
13479 @cindex RFC 822
13480 There are no known breaches of this standard.
13481
13482 @item RFC 1036
13483 @cindex RFC 1036
13484 There are no known breaches of this standard, either.
13485
13486 @item Good Net-Keeping Seal of Approval
13487 @cindex Good Net-Keeping Seal of Approval
13488 Gnus has been through the Seal process and failed.  I think it'll pass
13489 the next inspection.
13490
13491 @item Son-of-RFC 1036
13492 @cindex Son-of-RFC 1036
13493 We do have some breaches to this one.
13494
13495 @table @emph
13496
13497 @item MIME
13498 Gnus does no MIME handling, and this standard-to-be seems to think that
13499 MIME is the bees' knees, so we have major breakage here.
13500
13501 @item X-Newsreader
13502 This is considered to be a ``vanity header'', while I consider it to be
13503 consumer information.  After seeing so many badly formatted articles
13504 coming from @code{tin} and @code{Netscape} I know not to use either of
13505 those for posting articles.  I would not have known that if it wasn't
13506 for the @code{X-Newsreader} header.
13507
13508 @item References
13509 Gnus does line breaking on this header.  I infer from RFC1036 that being
13510 conservative in what you output is not creating 5000-character lines, so
13511 it seems like a good idea to me.  However, this standard-to-be says that
13512 whitespace in the @code{References} header is to be preserved, so...  It
13513 doesn't matter one way or the other to Gnus, so if somebody tells me
13514 what The Way is, I'll change it.  Or not.
13515 @end table
13516
13517 @end table
13518
13519 If you ever notice Gnus acting non-compliantly with regards to the texts
13520 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13521 know.
13522
13523
13524 @node Emacsen
13525 @subsection Emacsen
13526 @cindex Emacsen
13527 @cindex XEmacs
13528 @cindex Mule
13529 @cindex Emacs
13530
13531 Gnus should work on :
13532
13533 @itemize @bullet 
13534
13535 @item
13536 Emacs 19.32 and up.
13537
13538 @item
13539 XEmacs 19.14 and up.
13540
13541 @item 
13542 Mule versions based on Emacs 19.32 and up.
13543
13544 @end itemize
13545
13546 Gnus will absolutely not work on any Emacsen older than that.  Not
13547 reliably, at least. 
13548
13549 There are some vague differences between Gnus on the various
13550 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13551 other than that, things should look pretty much the same under all
13552 Emacsen. 
13553
13554
13555 @node Contributors
13556 @subsection Contributors
13557 @cindex contributors
13558
13559 The new Gnus version couldn't have been done without the help of all the
13560 people on the (ding) mailing list.  Every day for over a year I have
13561 gotten billions of nice bug reports from them, filling me with joy,
13562 every single one of them.  Smooches.  The people on the list have been
13563 tried beyond endurance, what with my ``oh, that's a neat idea <type
13564 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13565 work at all <type type>, yup, I'll ship that one off right away <ship
13566 off> no, wait, that absolutely does not work'' policy for releases.
13567 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
13568 ``worser''? ``much worser''?  ``worsest''?)
13569
13570 I would like to take this opportunity to thank the Academy for...  oops,
13571 wrong show.
13572
13573 @itemize @bullet
13574
13575 @item 
13576 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
13577
13578 @item 
13579 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
13580 well as numerous other things).
13581
13582 @item 
13583 Luis Fernandes---design and graphics.
13584
13585 @item
13586 Erik Naggum---help, ideas, support, code and stuff.
13587
13588 @item 
13589 Wes Hardaker---@file{gnus-picon.el} and the manual section on
13590 @dfn{picons} (@pxref{Picons}).
13591
13592 @item 
13593 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
13594 (@pxref{GroupLens}).
13595
13596 @item 
13597 Sudish Joseph---innumerable bug fixes.
13598
13599 @item 
13600 Ilja Weis---@file{gnus-topic.el}.
13601
13602 @item 
13603 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
13604
13605 @item 
13606 Vladimir Alexiev---the refcard and reference booklets.
13607
13608 @item 
13609 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
13610 distribution by Felix Lee and JWZ.
13611
13612 @item 
13613 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
13614
13615 @item 
13616 Peter Mutsaers---orphan article scoring code.
13617
13618 @item 
13619 Ken Raeburn---POP mail support.
13620
13621 @item 
13622 Hallvard B Furuseth---various bits and pieces, especially dealing with
13623 .newsrc files.
13624
13625 @item 
13626 Brian Edmonds---@file{gnus-bbdb.el}.
13627
13628 @item
13629 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
13630
13631 @item 
13632 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
13633
13634 @item 
13635 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
13636
13637 @item
13638 François Pinard---many, many interesting and thorough bug reports.
13639
13640 @end itemize
13641
13642 The following people have contributed many patches and suggestions: 
13643
13644 Christopher Davis,
13645 Andrew Eskilsson,
13646 Kai Grossjohann,
13647 David KÃ¥gedal,
13648 Richard Pieri,
13649 Fabrice Popineau, 
13650 Daniel Quinlan, 
13651 Jason L. Tibbitts, III,
13652 and
13653 Jack Vinson.
13654
13655 Also thanks to the following for patches and stuff:
13656
13657 Peter Arius, 
13658 Marc Auslander,
13659 Mark Borges,
13660 Lance A. Brown,
13661 Kees de Bruin,
13662 Martin Buchholz,
13663 Kevin Buhr,
13664 Alastair Burt,
13665 Joao Cachopo,
13666 Massimo Campostrini,
13667 Michael R. Cook,
13668 Glenn Coombs, 
13669 Frank D. Cringle, 
13670 Geoffrey T. Dairiki,
13671 Ulrik Dickow,
13672 Dave Disser,
13673 Joev Dubach,
13674 Paul Eggert,
13675 Michael Ernst,
13676 Luc Van Eycken,
13677 Sam Falkner,
13678 Paul Franklin, 
13679 David S. Goldberg,
13680 D. Hall, 
13681 Magnus Hammerin,
13682 Raja R. Harinath,
13683 Marc Horowitz,
13684 Ishikawa Ichiro, @c Ishikawa
13685 Francois Felix Ingrand,
13686 Lee Iverson, 
13687 Randell Jesup,
13688 Fred Johansen, 
13689 Thor Kristoffersen,
13690 Jens Lautenbacher,
13691 Carsten Leonhardt,
13692 Christian Limpach,
13693 Tonny Madsen,
13694 Shlomo Mahlab,
13695 Nat Makarevitch,
13696 Timo Metzemakers,
13697 Richard Mlynarik,
13698 Lantz Moore,
13699 Morioka Tomohiko, @c Morioka
13700 Hrvoje Niksic,
13701 Andy Norman,
13702 C. R. Oldham,
13703 Alexandre Oliva,
13704 Ken Olstad,
13705 Masaharu Onishi, @c Onishi
13706 Hideki Ono, @c Ono
13707 William Perry,
13708 Stephen Peters,
13709 Ulrich Pfeifer,
13710 Colin Rafferty,
13711 Bart Robinson,
13712 Ralph Schleicher,
13713 Randal L. Schwartz,
13714 Danny Siu, 
13715 Paul D. Smith,
13716 Jeff Sparkes,
13717 Michael Sperber,
13718 Richard Stallman,
13719 Greg Stark, 
13720 Kurt Swanson,
13721 Samuel Tardieu, 
13722 Teddy,
13723 Chuck Thompson,
13724 Philippe Troin,
13725 Jan Vroonhof,
13726 Barry A. Warsaw,
13727 Christoph Wedler,
13728 Joe Wells,
13729 and
13730 Katsumi Yamaoka. @c Yamaoka
13731
13732
13733 Apologies to everybody that I've forgotten, of which there are many, I'm
13734 sure.  
13735
13736 Gee, that's quite a list of people.  I guess that must mean that there
13737 actually are people who are using Gnus.  Who'd'a thunk it!
13738
13739
13740 @node New Features
13741 @subsection New Features
13742 @cindex new features
13743
13744 @menu
13745 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
13746 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
13747 * Red Gnus::           The future---Gnus 5.4/5.5.
13748 @end menu
13749
13750 These lists are, of course, just @emph{short} overviews of the
13751 @emph{most} important new features.  No, really.  There are tons more.
13752 Yes, we have feeping creaturism in full effect.
13753
13754
13755 @node ding Gnus
13756 @subsubsection (ding) Gnus
13757
13758 New features in Gnus 5.0/5.1:
13759
13760 @itemize @bullet
13761
13762 @item
13763 The look of all buffers can be changed by setting format-like variables
13764 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
13765  
13766 @item 
13767 Local spool and several @sc{nntp} servers can be used at once
13768 (@pxref{Select Methods}).  
13769
13770 @item 
13771 You can combine groups into virtual groups (@pxref{Virtual Groups}).
13772
13773 @item 
13774 You can read a number of different mail formats (@pxref{Getting Mail}).
13775 All the mail backends implement a convenient mail expiry scheme
13776 (@pxref{Expiring Mail}). 
13777
13778 @item
13779 Gnus can use various strategies for gathering threads that have lost
13780 their roots (thereby gathering loose sub-threads into one thread) or it
13781 can go back and retrieve enough headers to build a complete thread
13782 (@pxref{Customizing Threading}).
13783
13784 @item 
13785 Killed groups can be displayed in the group buffer, and you can read
13786 them as well (@pxref{Listing Groups}).
13787
13788 @item 
13789 Gnus can do partial group updates---you do not have to retrieve the
13790 entire active file just to check for new articles in a few groups
13791 (@pxref{The Active File}).
13792
13793 @item 
13794 Gnus implements a sliding scale of subscribedness to groups
13795 (@pxref{Group Levels}).
13796
13797 @item 
13798 You can score articles according to any number of criteria
13799 (@pxref{Scoring}).  You can even get Gnus to find out how to score
13800 articles for you (@pxref{Adaptive Scoring}).
13801
13802 @item 
13803 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
13804 manner, so it should be difficult to lose much data on what you have
13805 read if your machine should go down (@pxref{Auto Save}). 
13806
13807 @item 
13808 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
13809 the @file{.emacs} file.
13810
13811 @item 
13812 You can set the process mark on both groups and articles and perform
13813 operations on all the marked items (@pxref{Process/Prefix}).
13814
13815 @item 
13816 You can grep through a subset of groups and create a group from the
13817 results (@pxref{Kibozed Groups}). 
13818
13819 @item 
13820 You can list subsets of groups according to, well, anything
13821 (@pxref{Listing Groups}). 
13822
13823 @item 
13824 You can browse foreign servers and subscribe to groups from those
13825 servers (@pxref{Browse Foreign Server}). 
13826
13827 @item 
13828 Gnus can fetch articles asynchronously on a second connection to the
13829 server (@pxref{Asynchronous Fetching}).
13830
13831 @item 
13832 You can cache articles locally (@pxref{Article Caching}). 
13833
13834 @item 
13835 The uudecode functions have been expanded and generalized
13836 (@pxref{Decoding Articles}). 
13837
13838 @item
13839 You can still post uuencoded articles, which was a little-known feature
13840 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
13841
13842 @item
13843 Fetching parents (and other articles) now actually works without
13844 glitches (@pxref{Finding the Parent}). 
13845
13846 @item
13847 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
13848
13849 @item
13850 Digests (and other files) can be used as the basis for groups
13851 (@pxref{Document Groups}).
13852
13853 @item 
13854 Articles can be highlighted and customized (@pxref{Customizing
13855 Articles}). 
13856
13857 @item 
13858 URLs and other external references can be buttonized (@pxref{Article
13859 Buttons}). 
13860
13861 @item
13862 You can do lots of strange stuff with the Gnus window & frame
13863 configuration (@pxref{Windows Configuration}).
13864
13865 @item
13866 You can click on buttons instead of using the keyboard
13867 (@pxref{Buttons}). 
13868
13869 @end itemize
13870
13871
13872 @node September Gnus
13873 @subsubsection September Gnus
13874
13875 New features in Gnus 5.2/5.3:
13876
13877 @itemize @bullet
13878
13879 @item
13880 A new message composition mode is used.  All old customization variables
13881 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
13882 now obsolete.
13883
13884 @item
13885 Gnus is now able to generate @dfn{sparse} threads---threads where
13886 missing articles are represented by empty nodes (@pxref{Customizing
13887 Threading}). 
13888
13889 @lisp
13890 (setq gnus-build-sparse-threads 'some)
13891 @end lisp
13892
13893 @item
13894 Outgoing articles are stored on a special archive server
13895 (@pxref{Archived Messages}). 
13896
13897 @item
13898 Partial thread regeneration now happens when articles are
13899 referred. 
13900
13901 @item
13902 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
13903
13904 @item
13905 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
13906
13907 @item
13908 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
13909
13910 @lisp
13911 (setq gnus-use-trees t)
13912 @end lisp
13913
13914 @item
13915 An @code{nn}-like pick-and-read minor mode is available for the summary
13916 buffers (@pxref{Pick and Read}).
13917
13918 @lisp
13919 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
13920 @end lisp
13921
13922 @item
13923 In binary groups you can use a special binary minor mode (@pxref{Binary
13924 Groups}). 
13925
13926 @item
13927 Groups can be grouped in a folding topic hierarchy (@pxref{Group
13928 Topics}).
13929
13930 @lisp
13931 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
13932 @end lisp
13933
13934 @item
13935 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
13936
13937 @item
13938 Groups can now have a score, and bubbling based on entry frequency
13939 is possible (@pxref{Group Score}).
13940
13941 @lisp
13942 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
13943 @end lisp
13944
13945 @item
13946 Groups can be process-marked, and commands can be performed on
13947 groups of groups (@pxref{Marking Groups}).
13948
13949 @item
13950 Caching is possible in virtual groups.
13951
13952 @item
13953 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
13954 news batches, ClariNet briefs collections, and just about everything
13955 else (@pxref{Document Groups}).
13956
13957 @item
13958 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
13959 (@pxref{SOUP}).
13960
13961 @item
13962 The Gnus cache is much faster.
13963
13964 @item
13965 Groups can be sorted according to many criteria (@pxref{Sorting
13966 Groups}).
13967
13968 @item
13969 New group parameters have been introduced to set list-address and
13970 expiry times (@pxref{Group Parameters}).
13971
13972 @item
13973 All formatting specs allow specifying faces to be used
13974 (@pxref{Formatting Fonts}).
13975
13976 @item
13977 There are several more commands for setting/removing/acting on process
13978 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
13979
13980 @item
13981 The summary buffer can be limited to show parts of the available
13982 articles based on a wide range of criteria.  These commands have been
13983 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
13984
13985 @item
13986 Articles can be made persistent with the @kbd{*} command
13987 (@pxref{Persistent Articles}).
13988
13989 @item
13990 All functions for hiding article elements are now toggles.
13991
13992 @item
13993 Article headers can be buttonized (@pxref{Article Washing}).
13994
13995 @lisp
13996 (add-hook 'gnus-article-display-hook 
13997           'gnus-article-add-buttons-to-head)
13998 @end lisp
13999
14000 @item
14001 All mail backends support fetching articles by @code{Message-ID}.
14002
14003 @item
14004 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14005
14006 @item
14007 All summary mode commands are available directly from the article
14008 buffer (@pxref{Article Keymap}). 
14009
14010 @item
14011 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14012 Configuration}).
14013
14014 @item
14015 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14016
14017 @item
14018 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14019
14020 @lisp
14021 (setq gnus-use-nocem t)
14022 @end lisp
14023
14024 @item
14025 Groups can be made permanently visible (@pxref{Listing Groups}).
14026
14027 @lisp
14028 (setq gnus-permanently-visible-groups "^nnml:")
14029 @end lisp
14030
14031 @item
14032 Many new hooks have been introduced to make customizing easier. 
14033
14034 @item
14035 Gnus respects the @code{Mail-Copies-To} header.
14036
14037 @item
14038 Threads can be gathered by looking at the @code{References} header
14039 (@pxref{Customizing Threading}).
14040
14041 @lisp
14042 (setq gnus-summary-thread-gathering-function 
14043       'gnus-gather-threads-by-references)
14044 @end lisp
14045
14046 @item
14047 Read articles can be stored in a special backlog buffer to avoid
14048 refetching (@pxref{Article Backlog}).  
14049
14050 @lisp
14051 (setq gnus-keep-backlog 50)
14052 @end lisp
14053
14054 @item
14055 A clean copy of the current article is always stored in a separate
14056 buffer to allow easier treatment.
14057
14058 @item
14059 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14060
14061 @item
14062 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14063 Articles}). 
14064
14065 @lisp
14066 (setq gnus-prompt-before-saving t)
14067 @end lisp
14068
14069 @item
14070 @code{gnus-uu} can view decoded files asynchronously while fetching
14071 articles (@pxref{Other Decode Variables}). 
14072
14073 @lisp
14074 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14075 @end lisp
14076
14077 @item
14078 Filling in the article buffer now works properly on cited text
14079 (@pxref{Article Washing}).
14080
14081 @item
14082 Hiding cited text adds buttons to toggle hiding, and how much
14083 cited text to hide is now customizable (@pxref{Article Hiding}).
14084
14085 @lisp
14086 (setq gnus-cited-lines-visible 2)
14087 @end lisp
14088
14089 @item
14090 Boring headers can be hidden (@pxref{Article Hiding}).
14091
14092 @lisp
14093 (add-hook 'gnus-article-display-hook 
14094           'gnus-article-hide-boring-headers t)
14095 @end lisp
14096
14097 @item
14098 Default scoring values can now be set from the menu bar.
14099
14100 @item
14101 Further syntax checking of outgoing articles have been added.
14102
14103 @end itemize
14104
14105
14106 @node Red Gnus
14107 @subsubsection Red Gnus
14108
14109 New features in Gnus 5.4/5.5:
14110
14111 @itemize @bullet
14112
14113 @item
14114 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14115
14116 @item
14117 Article prefetching functionality has been moved up into 
14118 Gnus (@pxref{Asynchronous Fetching}).  
14119
14120 @item
14121 Scoring can now be performed with logical operators like @code{and},
14122 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14123 Scoring}).
14124
14125 @item
14126 Article washing status can be displayed in the
14127 article mode line (@pxref{Misc Article}).
14128
14129 @item
14130 @file{gnus.el} has been split into many smaller files.
14131
14132 @item
14133 Suppression of duplicate articles based on Message-ID can be done
14134 (@pxref{Duplicate Suppression}).
14135
14136 @lisp
14137 (setq gnus-suppress-duplicates t)
14138 @end lisp
14139
14140 @item
14141 New variables for specifying what score and adapt files are to be
14142 considered home score and adapt files (@pxref{Home Score File}).
14143
14144 @item
14145 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14146 Server Internals}). 
14147
14148 @item
14149 Groups can inherit group parameters from parent topics (@pxref{Topic
14150 Parameters}).
14151
14152 @item
14153 Article editing has been revamped and is now actually usable.
14154
14155 @item
14156 Signatures can be recognized in more intelligent fashions
14157 (@pxref{Article Signature}).
14158
14159 @item
14160 Summary pick mode has been made to look more @code{nn}-like.  Line
14161 numbers are displayed and the @kbd{.} command can be used to pick
14162 articles (@code{Pick and Read}).
14163
14164 @item
14165 Commands for moving the @file{.newsrc.eld} from one server to
14166 another have been added (@pxref{Changing Servers}).
14167
14168 @item
14169 A way to specify that ``uninteresting'' fields be suppressed when
14170 generating lines in buffers (@pxref{Advanced Formatting}).
14171
14172 @item
14173 Several commands in the group buffer can be undone with @kbd{M-C-_}
14174 (@pxref{Undo}).
14175
14176 @item
14177 Scoring can be done on words using the new score type @code{w}
14178 (@pxref{Score File Format}).
14179
14180 @item
14181 Adaptive scoring can be done on a Subject word-by-word basis
14182 (@pxref{Adaptive Scoring}). 
14183
14184 @lisp
14185 (setq gnus-use-adaptive-scoring '(word))
14186 @end lisp
14187
14188 @item
14189 Scores can be decayed (@pxref{Score Decays}).
14190  
14191 @lisp
14192 (setq gnus-decay-scores t)
14193 @end lisp
14194
14195 @item
14196 Scoring can be performed using a regexp on the Date header.  The Date is
14197 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14198
14199 @item
14200 A new command has been added to remove all data on articles from
14201 the native server (@pxref{Changing Servers}).
14202
14203 @item
14204 A new command for reading collections of documents
14205 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14206 (@pxref{Really Various Summary Commands}). 
14207
14208 @item
14209 Process mark sets can be pushed and popped (@pxref{Setting Process
14210 Marks}).
14211
14212 @item
14213 A new mail-to-news backend makes it possible to post even when the NNTP
14214 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14215
14216 @item
14217 A new backend for reading searches from Web search engines
14218 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14219 (@pxref{Web Searches}).
14220
14221 @item
14222 Groups inside topics can now be sorted using the standard sorting
14223 functions, and each topic can be sorted independently (@pxref{Topic
14224 Sorting}).
14225
14226 @item
14227 Subsets of the groups can be sorted independently (@code{Sorting
14228 Groups}).
14229
14230 @item
14231 Cached articles can be pulled into the groups (@pxref{Summary Generation
14232 Commands}).
14233   
14234 @item
14235 Score files are now applied in a more reliable order (@pxref{Score
14236 Variables}).
14237
14238 @item
14239 Reports on where mail messages end up can be generated (@pxref{Splitting
14240 Mail}).
14241
14242 @item
14243 More hooks and functions have been added to remove junk from incoming
14244 mail before saving the mail (@pxref{Washing Mail}).
14245
14246 @item
14247 Emphasized text can be properly fontisized:
14248
14249 @lisp
14250 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14251 @end lisp
14252  
14253 @end itemize
14254
14255
14256 @node Newest Features
14257 @subsection Newest Features
14258 @cindex todo
14259
14260 Also known as the @dfn{todo list}.  Sure to be implemented before the
14261 next millennium. 
14262
14263 Be afraid.  Be very afraid.
14264
14265 @itemize @bullet
14266 @item
14267 Native @sc{mime} support is something that should be done.  
14268 @item
14269 Really do unbinhexing.
14270 @end itemize
14271
14272 And much, much, much more.  There is more to come than has already been
14273 implemented.  (But that's always true, isn't it?)
14274
14275 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14276 up-to-the-second todo list is located, so if you're really curious, you
14277 could point your Web browser over that-a-way.
14278
14279 @iftex
14280
14281 @node The Manual
14282 @section The Manual
14283 @cindex colophon
14284 @cindex manual
14285
14286 This manual was generated from a TeXinfo file and then run through
14287 either @code{texi2dvi}
14288 @iflatex
14289 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14290 and then run through @code{latex} and @code{dvips} 
14291 @end iflatex
14292 to get what you hold in your hands now.
14293
14294 The following conventions have been used:
14295
14296 @enumerate
14297
14298 @item
14299 This is a @samp{string}
14300
14301 @item
14302 This is a @kbd{keystroke}
14303
14304 @item
14305 This is a @file{file}
14306
14307 @item 
14308 This is a @code{symbol}
14309
14310 @end enumerate
14311
14312 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14313 mean:
14314
14315 @lisp
14316 (setq flargnoze "yes")
14317 @end lisp
14318
14319 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14320
14321 @lisp
14322 (setq flumphel 'yes)
14323 @end lisp
14324
14325 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14326 ever get them confused.
14327
14328 @iflatex
14329 @c @head
14330 Of course, everything in this manual is of vital interest, so you should
14331 read it all.  Several times.  However, if you feel like skimming the
14332 manual, look for that gnu head you should see in the margin over
14333 there---it means that what's being discussed is of more importance than
14334 the rest of the stuff.  (On the other hand, if everything is infinitely
14335 important, how can anything be more important than that?  Just one more
14336 of the mysteries of this world, I guess.)
14337 @end iflatex
14338
14339 @end iftex
14340
14341
14342 @node Terminology
14343 @section Terminology
14344
14345 @cindex terminology
14346 @table @dfn
14347
14348 @item news
14349 @cindex news
14350 This is what you are supposed to use this thing for---reading news.
14351 News is generally fetched from a nearby @sc{nntp} server, and is
14352 generally publicly available to everybody.  If you post news, the entire
14353 world is likely to read just what you have written, and they'll all
14354 snigger mischievously.  Behind your back.
14355
14356 @item mail
14357 @cindex mail
14358 Everything that's delivered to you personally is mail.  Some news/mail
14359 readers (like Gnus) blur the distinction between mail and news, but
14360 there is a difference.  Mail is private.  News is public.  Mailing is
14361 not posting, and replying is not following up.
14362
14363 @item reply
14364 @cindex reply
14365 Send a mail to the person who has written what you are reading.
14366
14367 @item follow up
14368 @cindex follow up
14369 Post an article to the current newsgroup responding to the article you
14370 are reading.
14371
14372 @item backend
14373 @cindex backend
14374 Gnus gets fed articles from a number of backends, both news and mail
14375 backends.  Gnus does not handle the underlying media, so to speak---this
14376 is all done by the backends.
14377
14378 @item native
14379 @cindex native
14380 Gnus will always use one method (and backend) as the @dfn{native}, or
14381 default, way of getting news.
14382
14383 @item foreign
14384 @cindex foreign
14385 You can also have any number of foreign groups active at the same time.
14386 These are groups that use different backends for getting news.
14387
14388 @item secondary
14389 @cindex secondary
14390 Secondary backends are somewhere half-way between being native and being
14391 foreign, but they mostly act like they are native.
14392
14393 @item article
14394 @cindex article
14395 A message that has been posted as news.
14396
14397 @item mail message
14398 @cindex mail message
14399 A message that has been mailed.
14400
14401 @item message 
14402 @cindex message
14403 A mail message or news article
14404
14405 @item head
14406 @cindex head
14407 The top part of a message, where administrative information (etc.) is
14408 put.
14409
14410 @item body
14411 @cindex body
14412 The rest of an article.  Everything that is not in the head is in the
14413 body. 
14414
14415 @item header
14416 @cindex header
14417 A line from the head of an article. 
14418
14419 @item headers
14420 @cindex headers
14421 A collection of such lines, or a collection of heads.  Or even a
14422 collection of @sc{nov} lines.
14423
14424 @item @sc{nov}
14425 @cindex nov
14426 When Gnus enters a group, it asks the backend for the headers of all
14427 unread articles in the group.  Most servers support the News OverView
14428 format, which is more compact and much faster to read and parse than the
14429 normal @sc{head} format.
14430
14431 @item level
14432 @cindex levels
14433 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
14434 that have a lower level are ``more'' subscribed than the groups with a
14435 higher level.  In fact, groups on levels 1-5 are considered
14436 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14437 are @dfn{killed}.  Commands for listing groups and scanning for new
14438 articles will all use the numeric prefix as @dfn{working level}.
14439
14440 @item killed groups
14441 @cindex killed groups
14442 No information on killed groups is stored or updated, which makes killed
14443 groups much easier to handle than subscribed groups.
14444
14445 @item zombie groups
14446 @cindex zombie groups
14447 Just like killed groups, only slightly less dead.
14448
14449 @item active file
14450 @cindex active file
14451 The news server has to keep track of what articles it carries, and what
14452 groups exist.  All this information in stored in the active file, which
14453 is rather large, as you might surmise.
14454
14455 @item bogus groups
14456 @cindex bogus groups
14457 A group that exists in the @file{.newsrc} file, but isn't known to the
14458 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
14459 This means that the group probably doesn't exist (any more).
14460
14461 @item server 
14462 @cindex server
14463 A machine than one can connect to and get news (or mail) from.
14464
14465 @item select method
14466 @cindex select method
14467 A structure that specifies the backend, the server and the virtual
14468 server parameters.
14469
14470 @item virtual server
14471 @cindex virtual server
14472 A named select method.  Since a select methods defines all there is to
14473 know about connecting to a (physical) server, taking the things as a
14474 whole is a virtual server.
14475
14476 @item washing
14477 @cindex washing
14478 Taking a buffer and running it through a filter of some sort.  The
14479 result will (more often than not) be cleaner and more pleasing than the
14480 original. 
14481
14482 @item ephemeral groups
14483 @cindex ephemeral groups
14484 Most groups store data on what articles you have read.  @dfn{Ephemeral}
14485 groups are groups that will have no data stored---when you exit the
14486 group, it'll disappear into the aether.  
14487
14488 @item solid groups
14489 @cindex solid groups
14490 This is the opposite of ephemeral groups.  All groups listed in the
14491 group buffer are solid groups.
14492
14493 @end table
14494
14495
14496 @node Customization
14497 @section Customization
14498 @cindex general customization
14499
14500 All variables are properly documented elsewhere in this manual.  This
14501 section is designed to give general pointers on how to customize Gnus
14502 for some quite common situations.
14503
14504 @menu
14505 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14506 * Slow Terminal Connection::  You run a remote Emacs.
14507 * Little Disk Space::         You feel that having large setup files is icky.
14508 * Slow Machine::              You feel like buying a faster machine.
14509 @end menu
14510
14511
14512 @node Slow/Expensive Connection
14513 @subsection Slow/Expensive @sc{nntp} Connection
14514
14515 If you run Emacs on a machine locally, and get your news from a machine
14516 over some very thin strings, you want to cut down on the amount of data
14517 Gnus has to get from the @sc{nntp} server.
14518
14519 @table @code
14520
14521 @item gnus-read-active-file
14522 Set this to @code{nil}, which will inhibit Gnus from requesting the
14523 entire active file from the server.  This file is often v.  large.  You
14524 also have to set @code{gnus-check-new-newsgroups} and
14525 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
14526 doesn't suddenly decide to fetch the active file anyway.
14527
14528 @item gnus-nov-is-evil
14529 This one has to be @code{nil}.  If not, grabbing article headers from
14530 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
14531 support @sc{xover}; Gnus will detect this by itself.
14532 @end table
14533
14534
14535 @node Slow Terminal Connection
14536 @subsection Slow Terminal Connection
14537
14538 Let's say you use your home computer for dialing up the system that
14539 runs Emacs and Gnus.  If your modem is slow, you want to reduce the
14540 amount of data that is sent over the wires as much as possible.
14541
14542 @table @code
14543
14544 @item gnus-auto-center-summary
14545 Set this to @code{nil} to inhibit Gnus from re-centering the summary
14546 buffer all the time.  If it is @code{vertical}, do only vertical
14547 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
14548 horizontal and vertical recentering.
14549
14550 @item gnus-visible-headers
14551 Cut down on the headers that are included in the articles to the
14552 minimum.  You can, in fact, make do without them altogether---most of the
14553 useful data is in the summary buffer, anyway.  Set this variable to
14554 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
14555
14556 @item gnus-article-display-hook
14557 Set this hook to all the available hiding commands:
14558 @lisp
14559 (setq gnus-article-display-hook 
14560       '(gnus-article-hide-headers gnus-article-hide-signature
14561         gnus-article-hide-citation))
14562 @end lisp
14563
14564 @item gnus-use-full-window
14565 By setting this to @code{nil}, you can make all the windows smaller.
14566 While this doesn't really cut down much generally, it means that you
14567 have to see smaller portions of articles before deciding that you didn't
14568 want to read them anyway.
14569
14570 @item gnus-thread-hide-subtree
14571 If this is non-@code{nil}, all threads in the summary buffer will be
14572 hidden initially.
14573
14574 @item gnus-updated-mode-lines
14575 If this is @code{nil}, Gnus will not put information in the buffer mode
14576 lines, which might save some time.
14577 @end table
14578
14579
14580 @node Little Disk Space
14581 @subsection Little Disk Space
14582 @cindex disk space
14583
14584 The startup files can get rather large, so you may want to cut their
14585 sizes a bit if you are running out of space.
14586
14587 @table @code
14588
14589 @item gnus-save-newsrc-file
14590 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
14591 only save @file{.newsrc.eld}.  This means that you will not be able to
14592 use any other newsreaders than Gnus.  This variable is @code{t} by
14593 default. 
14594
14595 @item gnus-save-killed-list
14596 If this is @code{nil}, Gnus will not save the list of dead groups.  You
14597 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
14598 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
14599 variable to @code{nil}.  This variable is @code{t} by default.
14600
14601 @end table
14602
14603
14604 @node Slow Machine
14605 @subsection Slow Machine
14606 @cindex slow machine
14607
14608 If you have a slow machine, or are just really impatient, there are a
14609 few things you can do to make Gnus run faster.
14610
14611 Set@code{gnus-check-new-newsgroups} and
14612 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
14613
14614 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
14615 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
14616 summary buffer faster.
14617
14618 Set @code{gnus-article-display-hook} to @code{nil} to make article
14619 processing a bit faster.
14620
14621
14622 @node Troubleshooting
14623 @section Troubleshooting
14624 @cindex troubleshooting
14625
14626 Gnus works @emph{so} well straight out of the box---I can't imagine any
14627 problems, really.
14628
14629 Ahem.
14630
14631 @enumerate
14632
14633 @item
14634 Make sure your computer is switched on.
14635
14636 @item
14637 Make sure that you really load the current Gnus version.  If you have
14638 been running @sc{gnus}, you need to exit Emacs and start it up again before
14639 Gnus will work.
14640
14641 @item
14642 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
14643 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
14644 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
14645 flee}, you have some old @file{.el} files lying around.  Delete these.
14646
14647 @item
14648 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
14649 how-to. 
14650
14651 @item
14652 @vindex max-lisp-eval-depth
14653 Gnus works on many recursive structures, and in some extreme (and very
14654 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
14655 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
14656 something like that.
14657 @end enumerate
14658
14659 If all else fails, report the problem as a bug.
14660
14661 @cindex bugs
14662 @cindex reporting bugs
14663
14664 @kindex M-x gnus-bug
14665 @findex gnus-bug
14666 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
14667 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
14668 me the backtrace.  I will fix bugs, but I can only fix them if you send
14669 me a precise description as to how to reproduce the bug.
14670
14671 You really can never be too detailed in a bug report.  Always use the
14672 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
14673 a 10Kb mail each time you use it, and even if you have sent me your
14674 environment 500 times before.  I don't care.  I want the full info each
14675 time.  
14676
14677 It is also important to remember that I have no memory whatsoever.  If
14678 you send a bug report, and I send you a reply, and then you send back
14679 just ``No, it's not! Moron!'', I will have no idea what you are
14680 insulting me about.  Always over-explain everything.  It's much easier
14681 for all of us---if I don't have all the information I need, I will just
14682 mail you and ask for more info, and everything takes more time.
14683
14684 If the problem you're seeing is very visual, and you can't quite explain
14685 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
14686 it somewhere it can be reached, and include the URL of the picture in
14687 the bug report.
14688
14689 If you just need help, you are better off asking on
14690 @samp{gnu.emacs.gnus}.  I'm not very helpful.
14691
14692 @cindex gnu.emacs.gnus
14693 @cindex ding mailing list
14694 You can also ask on the ding mailing list---@samp{ding@@ifi.uio.no}.
14695 Write to @samp{ding-request@@ifi.uio.no} to subscribe.
14696
14697
14698 @node A Programmers Guide to Gnus
14699 @section A Programmer@'s Guide to Gnus
14700
14701 It is my hope that other people will figure out smart stuff that Gnus
14702 can do, and that other people will write those smart things as well.  To
14703 facilitate that I thought it would be a good idea to describe the inner
14704 workings of Gnus.  And some of the not-so-inner workings, while I'm at
14705 it.
14706
14707 You can never expect the internals of a program not to change, but I
14708 will be defining (in some details) the interface between Gnus and its
14709 backends (this is written in stone), the format of the score files
14710 (ditto), data structures (some are less likely to change than others)
14711 and general method of operations.
14712
14713 @menu 
14714 * Backend Interface::        How Gnus communicates with the servers.
14715 * Score File Syntax::        A BNF definition of the score file standard.
14716 * Headers::                  How Gnus stores headers internally.
14717 * Ranges::                   A handy format for storing mucho numbers.
14718 * Group Info::               The group info format.
14719 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
14720 * Various File Formats::     Formats of files that Gnus use.
14721 @end menu
14722
14723
14724 @node Backend Interface
14725 @subsection Backend Interface
14726
14727 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
14728 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
14729 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
14730 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
14731 examples of the latter we have @code{nntp-port-number} and
14732 @code{nnmbox-directory}.
14733
14734 When Gnus asks for information from a backend---say @code{nntp}---on
14735 something, it will normally include a virtual server name in the
14736 function parameters.  (If not, the backend should use the ``current''
14737 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
14738 server as its only (optional) parameter.  If this virtual server hasn't
14739 been opened, the function should fail.
14740
14741 Note that a virtual server name has no relation to some physical server
14742 name.  Take this example:
14743
14744 @lisp
14745 (nntp "odd-one" 
14746       (nntp-address "ifi.uio.no") 
14747       (nntp-port-number 4324))
14748 @end lisp
14749
14750 Here the virtual server name is @samp{odd-one} while the name of
14751 the physical server is @samp{ifi.uio.no}. 
14752
14753 The backends should be able to switch between several virtual servers.
14754 The standard backends implement this by keeping an alist of virtual
14755 server environments that it pulls down/pushes up when needed.  
14756
14757 There are two groups of interface functions: @dfn{required functions},
14758 which must be present, and @dfn{optional functions}, which Gnus will
14759 always check whether are present before attempting to call.
14760
14761 All these functions are expected to return data in the buffer
14762 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
14763 unfortunately named, but we'll have to live with it.  When I talk about
14764 @dfn{resulting data}, I always refer to the data in that buffer.  When I
14765 talk about @dfn{return value}, I talk about the function value returned by
14766 the function call.  Functions that fail should return @code{nil} as the
14767 return value.
14768
14769 Some backends could be said to be @dfn{server-forming} backends, and
14770 some might be said to not be.  The latter are backends that generally
14771 only operate on one group at a time, and have no concept of ``server''
14772 -- they have a group, and they deliver info on that group and nothing
14773 more.
14774
14775 In the examples and definitions I will refer to the imaginary backend
14776 @code{nnchoke}. 
14777
14778 @cindex @code{nnchoke}
14779
14780 @menu
14781 * Required Backend Functions::        Functions that must be implemented.
14782 * Optional Backend Functions::        Functions that need not be implemented.
14783 * Error Messaging::                   How to get messages and report errors.
14784 * Writing New Backends::              Extending old backends.
14785 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
14786 * Mail-like Backends::                Some tips on mail backends.
14787 @end menu
14788
14789
14790 @node Required Backend Functions
14791 @subsubsection Required Backend Functions
14792
14793 @table @code
14794
14795 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
14796
14797 @var{articles} is either a range of article numbers or a list of
14798 @code{Message-ID}s.  Current backends do not fully support either---only
14799 sequences (lists) of article numbers, and most backends do not support
14800 retrieval of @code{Message-ID}s.  But they should try for both. 
14801
14802 The result data should either be HEADs or NOV lines, and the result
14803 value should either be @code{headers} or @code{nov} to reflect this.
14804 This might later be expanded to @code{various}, which will be a mixture
14805 of HEADs and NOV lines, but this is currently not supported by Gnus.  
14806
14807 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
14808 headers, in some meaning of the word.  This is generally done by
14809 fetching (at most) @var{fetch-old} extra headers less than the smallest
14810 article number in @code{articles}, and fill in the gaps as well.  The
14811 presence of this parameter can be ignored if the backend finds it
14812 cumbersome to follow the request.  If this is non-@code{nil} and not a
14813 number, do maximum fetches.
14814
14815 Here's an example HEAD:
14816
14817 @example
14818 221 1056 Article retrieved.
14819 Path: ifi.uio.no!sturles
14820 From: sturles@@ifi.uio.no (Sturle Sunde)
14821 Newsgroups: ifi.discussion
14822 Subject: Re: Something very droll
14823 Date: 27 Oct 1994 14:02:57 +0100
14824 Organization: Dept. of Informatics, University of Oslo, Norway
14825 Lines: 26
14826 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
14827 References: <38jdmq$4qu@@visbur.ifi.uio.no>
14828 NNTP-Posting-Host: holmenkollen.ifi.uio.no
14829 .
14830 @end example
14831
14832 So a @code{headers} return value would imply that there's a number of
14833 these in the data buffer.
14834
14835 Here's a BNF definition of such a buffer:
14836
14837 @example
14838 headers        = *head
14839 head           = error / valid-head
14840 error-message  = [ "4" / "5" ] 2number " " <error message> eol
14841 valid-head     = valid-message *header "." eol
14842 valid-message  = "221 " <number> " Article retrieved." eol
14843 header         = <text> eol
14844 @end example
14845
14846 If the return value is @code{nov}, the data buffer should contain
14847 @dfn{network overview database} lines.  These are basically fields
14848 separated by tabs. 
14849
14850 @example
14851 nov-buffer = *nov-line
14852 nov-line   = 8*9 [ field <TAB> ] eol
14853 field      = <text except TAB>
14854 @end example
14855
14856 For a closer explanation what should be in those fields,
14857 @pxref{Headers}. 
14858
14859
14860 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
14861
14862 @var{server} is here the virtual server name.  @var{definitions} is a
14863 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server. 
14864
14865 If the server can't be opened, no error should be signaled.  The backend
14866 may then choose to refuse further attempts at connecting to this
14867 server.  In fact, it should do so. 
14868
14869 If the server is opened already, this function should return a
14870 non-@code{nil} value.  There should be no data returned.
14871
14872
14873 @item (nnchoke-close-server &optional SERVER)
14874
14875 Close connection to @var{server} and free all resources connected
14876 to it.  Return @code{nil} if the server couldn't be closed for some
14877 reason.
14878
14879 There should be no data returned.
14880
14881
14882 @item (nnchoke-request-close)
14883
14884 Close connection to all servers and free all resources that the backend
14885 have reserved.  All buffers that have been created by that backend
14886 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
14887 function is generally only called when Gnus is shutting down.
14888
14889 There should be no data returned. 
14890
14891
14892 @item (nnchoke-server-opened &optional SERVER)
14893
14894 If @var{server} is the current virtual server, and the connection to the
14895 physical server is alive, then this function should return a
14896 non-@code{nil} vlue.  This function should under no circumstances
14897 attempt to reconnect to a server that is has lost connection to.
14898
14899 There should be no data returned.
14900
14901
14902 @item (nnchoke-status-message &optional SERVER)
14903
14904 This function should return the last error message from @var{server}. 
14905
14906 There should be no data returned.
14907
14908
14909 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
14910
14911 The result data from this function should be the article specified by
14912 @var{article}.  This might either be a @code{Message-ID} or a number.
14913 It is optional whether to implement retrieval by @code{Message-ID}, but
14914 it would be nice if that were possible.
14915
14916 If @var{to-buffer} is non-@code{nil}, the result data should be returned
14917 in this buffer instead of the normal data buffer.  This is to make it
14918 possible to avoid copying large amounts of data from one buffer to
14919 another, and Gnus mainly request articles to be inserted directly into
14920 its article buffer.
14921
14922 If it is at all possible, this function should return a cons cell where
14923 the car is the group name the article was fetched from, and the cdr is
14924 the article number.  This will enable Gnus to find out what the real
14925 group and article numbers are when fetching articles by
14926 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
14927 on successful article retrievement.
14928
14929
14930 @item (nnchoke-open-group GROUP &optional SERVER)
14931
14932 Make @var{group} the current group.  
14933
14934 There should be no data returned by this function.
14935
14936
14937 @item (nnchoke-request-group GROUP &optional SERVER FAST)
14938
14939 Get data on @var{group}.  This function also has the side effect of
14940 making @var{group} the current group. 
14941
14942 If @var{FAST}, don't bother to return useful data, just make @var{group}
14943 the current group.
14944
14945 Here's an example of some result data and a definition of the same:
14946
14947 @example
14948 211 56 1000 1059 ifi.discussion
14949 @end example
14950
14951 The first number is the status, which should be 211.  Next is the
14952 total number of articles in the group, the lowest article number, the
14953 highest article number, and finally the group name.  Note that the total
14954 number of articles may be less than one might think while just
14955 considering the highest and lowest article numbers, but some articles
14956 may have been canceled.  Gnus just discards the total-number, so
14957 whether one should take the bother to generate it properly (if that is a
14958 problem) is left as an exercise to the reader.
14959
14960 @example
14961 group-status = [ error / info ] eol
14962 error        = [ "4" / "5" ] 2<number> " " <Error message>
14963 info         = "211 " 3* [ <number> " " ] <string>
14964 @end example
14965
14966
14967 @item (nnchoke-close-group GROUP &optional SERVER)
14968
14969 Close @var{group} and free any resources connected to it.  This will be
14970 a no-op on most backends. 
14971
14972 There should be no data returned.
14973
14974
14975 @item (nnchoke-request-list &optional SERVER)
14976
14977 Return a list of all groups available on @var{server}.  And that means
14978 @emph{all}. 
14979
14980 Here's an example from a server that only carries two groups:
14981
14982 @example
14983 ifi.test 0000002200 0000002000 y
14984 ifi.discussion 3324 3300 n
14985 @end example
14986
14987 On each line we have a group name, then the highest article number in
14988 that group, the lowest article number, and finally a flag.
14989
14990 @example
14991 active-file = *active-line
14992 active-line = name " " <number> " " <number> " " flags eol
14993 name        = <string>
14994 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
14995 @end example
14996
14997 The flag says whether the group is read-only (@samp{n}), is moderated
14998 (@samp{m}), is dead (@samp{x}), is aliased to some other group
14999 (@samp{=other-group} or none of the above (@samp{y}). 
15000
15001
15002 @item (nnchoke-request-post &optional SERVER)
15003
15004 This function should post the current buffer.  It might return whether
15005 the posting was successful or not, but that's not required.  If, for
15006 instance, the posting is done asynchronously, it has generally not been
15007 completed by the time this function concludes.  In that case, this
15008 function should set up some kind of sentinel to beep the user loud and
15009 clear if the posting could not be completed.
15010
15011 There should be no result data from this function. 
15012
15013 @end table
15014
15015
15016 @node Optional Backend Functions
15017 @subsubsection Optional Backend Functions
15018
15019 @table @code
15020
15021 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15022
15023 @var{groups} is a list of groups, and this function should request data
15024 on all those groups.  How it does it is of no concern to Gnus, but it
15025 should attempt to do this in a speedy fashion.
15026
15027 The return value of this function can be either @code{active} or
15028 @code{group}, which says what the format of the result data is.  The
15029 former is in the same format as the data from
15030 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15031 in the same format as @code{nnchoke-request-group} gives.
15032
15033 @example
15034 group-buffer = *active-line / *group-status
15035 @end example
15036
15037
15038 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15039
15040 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15041 alterations.  This comes in handy if the backend really carries all the
15042 information (as is the case with virtual an imap groups).  This function
15043 may alter the info in any manner it sees fit, and should return the
15044 (altered) group info.  This function may alter the group info
15045 destructively, so no copying is needed before boogeying. 
15046
15047 There should be no result data from this function.
15048
15049
15050 @item (nnchoke-request-type GROUP &optional ARTICLE)
15051
15052 When the user issues commands for ``sending news'' (@kbd{F} in the
15053 summary buffer, for instance), Gnus has to know whether the article the
15054 user is following up is news or mail.  This function should return
15055 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15056 is mail and @code{unknown} if the type can't be decided.  (The
15057 @var{article} parameter is necessary in @code{nnvirtual} groups which
15058 might very well combine mail groups and news groups.)  Both @var{group}
15059 and @var{article} may be @code{nil}.
15060
15061 There should be no result data from this function.
15062
15063
15064 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15065
15066 If the user tries to set a mark that the backend doesn't like, this
15067 function may change the mark.  Gnus will use whatever this function
15068 returns as the mark for @var{article} instead of the original
15069 @var{mark}.  If the backend doesn't care, it must return the original
15070 @var{mark}, and not @code{nil} or any other type of garbage.  
15071
15072 The only use for this that I can see is what @code{nnvirtual} does with
15073 it---if a component group is auto-expirable, marking an article as read
15074 in the virtual group should result in the article being marked as
15075 expirable. 
15076
15077 There should be no result data from this function.
15078
15079
15080 @item (nnchoke-request-scan &optional GROUP SERVER)
15081
15082 This function may be called at any time (by Gnus or anything else) to
15083 request that the backend check for incoming articles, in one way or
15084 another.  A mail backend will typically read the spool file or query the
15085 POP server when this function is invoked.  The @var{group} doesn't have
15086 to be heeded---if the backend decides that it is too much work just
15087 scanning for a single group, it may do a total scan of all groups.  It
15088 would be nice, however, to keep things local if that's practical.
15089
15090 There should be no result data from this function.
15091
15092
15093 @item (nnchoke-request-group-description GROUP &optional SERVER)
15094
15095 The result data from this function should be a description of
15096 @var{group}. 
15097
15098 @example
15099 description-line = name <TAB> description eol
15100 name             = <string>
15101 description      = <text>
15102 @end example
15103
15104 @item (nnchoke-request-list-newsgroups &optional SERVER)
15105
15106 The result data from this function should be the description of all
15107 groups available on the server.
15108
15109 @example
15110 description-buffer = *description-line
15111 @end example
15112
15113
15114 @item (nnchoke-request-newgroups DATE &optional SERVER)
15115
15116 The result data from this function should be all groups that were
15117 created after @samp{date}, which is in normal human-readable date
15118 format.  The data should be in the active buffer format.
15119
15120
15121 @item (nnchoke-request-create-group GROUP &optional SERVER)
15122
15123 This function should create an empty group with name @var{group}.  
15124
15125 There should be no return data.
15126
15127
15128 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15129
15130 This function should run the expiry process on all articles in the
15131 @var{articles} range (which is currently a simple list of article
15132 numbers.)  It is left up to the backend to decide how old articles
15133 should be before they are removed by this function.  If @var{force} is
15134 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15135 they are. 
15136
15137 This function should return a list of articles that it did not/was not
15138 able to delete.
15139
15140 There should be no result data returned.
15141
15142
15143 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15144 &optional LAST)
15145
15146 This function should move @var{article} (which is a number) from
15147 @var{group} by calling @var{accept-form}.  
15148
15149 This function should ready the article in question for moving by
15150 removing any header lines it has added to the article, and generally
15151 should ``tidy up'' the article.  Then it should @code{eval}
15152 @var{accept-form} in the buffer where the ``tidy'' article is.  This
15153 will do the actual copying.  If this @code{eval} returns a
15154 non-@code{nil} value, the article should be removed.
15155
15156 If @var{last} is @code{nil}, that means that there is a high likelihood
15157 that there will be more requests issued shortly, so that allows some
15158 optimizations. 
15159
15160 The function should return a cons where the car is the group name and
15161 the cdr is the article number that the article was entered as.
15162
15163 There should be no data returned. 
15164
15165
15166 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15167
15168 This function takes the current buffer and inserts it into @var{group}.
15169 If @var{last} in @code{nil}, that means that there will be more calls to
15170 this function in short order.
15171
15172 The function should return a cons where the car is the group name and
15173 the cdr is the article number that the article was entered as.
15174
15175 There should be no data returned.
15176
15177
15178 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15179
15180 This function should remove @var{article} (which is a number) from
15181 @var{group} and insert @var{buffer} there instead.
15182
15183 There should be no data returned.
15184
15185
15186 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15187
15188 This function should delete @var{group}.  If @var{force}, it should
15189 really delete all the articles in the group, and then delete the group
15190 itself.  (If there is such a thing as ``the group itself''.)
15191
15192 There should be no data returned.
15193
15194
15195 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15196
15197 This function should rename @var{group} into @var{new-name}.  All
15198 articles that are in @var{group} should move to @var{new-name}.
15199
15200 There should be no data returned.
15201
15202 @end table
15203
15204
15205 @node Error Messaging
15206 @subsubsection Error Messaging
15207
15208 @findex nnheader-report
15209 @findex nnheader-get-report
15210 The backends should use the function @code{nnheader-report} to report
15211 error conditions---they should not raise errors when they aren't able to
15212 perform a request.  The first argument to this function is the backend
15213 symbol, and the rest are interpreted as arguments to @code{format} if
15214 there are many of them, or just a string if there is one of them.
15215 This function always returns @code{nil}.
15216
15217 @lisp
15218 (nnheader-report 'nnchoke "You did something totally bogus")
15219
15220 (nnheader-report 'nnchoke "Could not request group %s" group)
15221 @end lisp
15222
15223 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15224 @code{nil} back from a server, and this function returns the most
15225 recently reported message for the backend in question.  This function
15226 takes one argument---the server symbol.
15227
15228 Internally, these function access @var{backend}@code{-status-string}, so
15229 the @code{nnchoke} backend will have its error message stored in
15230 @code{nnchoke-status-string}. 
15231
15232
15233 @node Writing New Backends
15234 @subsubsection Writing New Backends
15235
15236 Many backends are quite similar.  @code{nnml} is just like
15237 @code{nnspool}, but it allows you to edit the articles on the server.
15238 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15239 and it doesn't maintain overview databases.  @code{nndir} is just like
15240 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15241 editing articles.
15242
15243 It would make sense if it were possible to ``inherit'' functions from
15244 backends when writing new backends.  And, indeed, you can do that if you
15245 want to.  (You don't have to if you don't want to, of course.)  
15246
15247 All the backends declare their public variables and functions by using a
15248 package called @code{nnoo}.  
15249
15250 To inherit functions from other backends (and allow other backends to
15251 inherit functions from the current backend), you should use the
15252 following macros:
15253 following. 
15254
15255 @table @code
15256
15257 @item nnoo-declare
15258 This macro declares the first parameter to be a child of the subsequent
15259 parameters.  For instance:
15260
15261 @lisp
15262 (nnoo-declare nndir
15263   nnml nnmh)
15264 @end lisp
15265
15266 @code{nndir} has here declared that it intends to inherit functions from
15267 both @code{nnml} and @code{nnmh}.
15268
15269 @item defvoo
15270 This macro is equivalent to @code{defvar}, but registers the variable as
15271 a public server variable.  Most state-oriented variables should be
15272 declared with @code{defvoo} instead of @code{defvar}.  
15273
15274 In addition to the normal @code{defvar} parameters, it takes a list of
15275 variables in the parent backends to map the variable to when executing
15276 a function in those backends.
15277
15278 @lisp
15279 (defvoo nndir-directory nil
15280   "Where nndir will look for groups."
15281   nnml-current-directory nnmh-current-directory)
15282 @end lisp
15283
15284 This means that @code{nnml-current-directory} will be set to
15285 @code{nndir-directory} when an @code{nnml} function is called on behalf
15286 of @code{nndir}.  (The same with @code{nnmh}.)  
15287
15288 @item nnoo-define-basics
15289 This macro defines some common functions that almost all backends should
15290 have.
15291
15292 @example
15293 (nnoo-define-basics nndir)
15294 @end example
15295
15296 @item deffoo
15297 This macro is just like @code{defun} and takes the same parameters.  In
15298 addition to doing the normal @code{defun} things, it registers the
15299 function as being public so that other backends can inherit it.
15300
15301 @item nnoo-map-functions
15302 This macro allows mapping of functions from the current backend to
15303 functions from the parent backends.
15304
15305 @example
15306 (nnoo-map-functions nndir
15307   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15308   (nnmh-request-article 0 nndir-current-group 0 0))
15309 @end example
15310
15311 This means that when @code{nndir-retrieve-headers} is called, the first,
15312 third, and fourth parameters will be passed on to
15313 @code{nnml-retrieve-headers}, while the second parameter is set to the
15314 value of @code{nndir-current-group}.
15315
15316 @item nnoo-import
15317 This macro allows importing functions from backends.  It should be the
15318 last thing in the source file, since it will only define functions that
15319 haven't already been defined.
15320
15321 @example
15322 (nnoo-import nndir
15323   (nnmh
15324    nnmh-request-list
15325    nnmh-request-newgroups)
15326   (nnml))
15327 @end example
15328
15329 This means that calls to @code{nndir-request-list} should just be passed
15330 on to @code{nnmh-request-list}, while all public functions from
15331 @code{nnml} that haven't been defined in @code{nndir} yet should be
15332 defined now.
15333
15334 @end table
15335
15336 Below is a slightly shortened version of the @code{nndir} backend.
15337
15338 @lisp
15339 ;;; nndir.el --- single directory newsgroup access for Gnus
15340 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15341
15342 ;;; Code:
15343
15344 (require 'nnheader)
15345 (require 'nnmh)
15346 (require 'nnml)
15347 (require 'nnoo)
15348 (eval-when-compile (require 'cl))
15349
15350 (nnoo-declare nndir
15351   nnml nnmh)
15352
15353 (defvoo nndir-directory nil
15354   "Where nndir will look for groups."
15355   nnml-current-directory nnmh-current-directory)
15356
15357 (defvoo nndir-nov-is-evil nil
15358   "*Non-nil means that nndir will never retrieve NOV headers."
15359   nnml-nov-is-evil)
15360
15361 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15362 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15363 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15364
15365 (defvoo nndir-status-string "" nil nnmh-status-string)
15366 (defconst nndir-version "nndir 1.0")
15367
15368 ;;; Interface functions.
15369
15370 (nnoo-define-basics nndir)
15371
15372 (deffoo nndir-open-server (server &optional defs)
15373   (setq nndir-directory
15374         (or (cadr (assq 'nndir-directory defs))
15375             server))
15376   (unless (assq 'nndir-directory defs)
15377     (push `(nndir-directory ,server) defs))
15378   (push `(nndir-current-group
15379           ,(file-name-nondirectory (directory-file-name nndir-directory)))
15380         defs)
15381   (push `(nndir-top-directory
15382           ,(file-name-directory (directory-file-name nndir-directory)))
15383         defs)
15384   (nnoo-change-server 'nndir server defs))
15385
15386 (nnoo-map-functions nndir
15387   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15388   (nnmh-request-article 0 nndir-current-group 0 0)
15389   (nnmh-request-group nndir-current-group 0 0)
15390   (nnmh-close-group nndir-current-group 0))
15391
15392 (nnoo-import nndir
15393   (nnmh
15394    nnmh-status-message
15395    nnmh-request-list
15396    nnmh-request-newgroups))
15397
15398 (provide 'nndir)
15399 @end lisp
15400
15401
15402 @node Hooking New Backends Into Gnus
15403 @subsubsection Hooking New Backends Into Gnus
15404
15405 @vindex gnus-valid-select-methods
15406 Having Gnus start using your new backend is rather easy---you just
15407 declare it with the @code{gnus-declare-backend} functions.  This will
15408 enter the backend into the @code{gnus-valid-select-methods} variable.
15409
15410 @code{gnus-declare-backend} takes two parameters---the backend name and
15411 an arbitrary number of @dfn{abilities}.
15412
15413 Here's an example:
15414
15415 @lisp
15416 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15417 @end lisp
15418
15419 The abilities can be:
15420
15421 @table @code
15422 @item mail
15423 This is a mailish backend---followups should (probably) go via mail.
15424 @item post
15425 This is a newsish backend---followups should (probably) go via news. 
15426 @item post-mail
15427 This backend supports both mail and news.
15428 @item none
15429 This is neither a post or mail backend---it's something completely
15430 different. 
15431 @item respool
15432 It supports respooling---or rather, it is able to modify its source
15433 articles and groups.
15434 @item address
15435 The name of the server should be in the virtual server name.  This is
15436 true for almost all backends.
15437 @item prompt-address
15438 The user should be prompted for an address when doing commands like
15439 @kbd{B} in the group buffer.  This is true for backends like
15440 @code{nntp}, but not @code{nnmbox}, for instance. 
15441 @end table
15442
15443
15444 @node Mail-like Backends
15445 @subsubsection Mail-like Backends
15446
15447 One of the things that separate the mail backends from the rest of the
15448 backends is the heavy dependence by the mail backends on common
15449 functions in @file{nnmail.el}.  For instance, here's the definition of
15450 @code{nnml-request-scan}: 
15451
15452 @lisp
15453 (deffoo nnml-request-scan (&optional group server)
15454   (setq nnml-article-file-alist nil)
15455   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
15456 @end lisp
15457
15458 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
15459 and @code{nnmail} takes care of all the moving and splitting of the
15460 mail.  
15461
15462 This function takes four parameters.
15463
15464 @table @var
15465 @item method
15466 This should be a symbol to designate which backend is responsible for
15467 the call.
15468
15469 @item exit-function
15470 This function should be called after the splitting has been performed.
15471
15472 @item temp-directory
15473 Where the temporary files should be stored.
15474
15475 @item group
15476 This optional argument should be a group name if the splitting is to be
15477 performed for one group only.
15478 @end table
15479
15480 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
15481 save each article.  @var{backend}@code{-active-number} will be called to
15482 find the article number assigned to this article.  
15483
15484 The function also uses the following variables:
15485 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
15486 this backend); and @var{backend}@code{-group-alist} and
15487 @var{backend}@code{-active-file} to generate the new active file.
15488 @var{backend}@code{-group-alist} should be a group-active alist, like
15489 this:
15490
15491 @example
15492 (("a-group" (1 . 10))
15493  ("some-group" (34 . 39)))
15494 @end example
15495
15496
15497 @node Score File Syntax
15498 @subsection Score File Syntax
15499
15500 Score files are meant to be easily parsable, but yet extremely
15501 mallable.   It was decided that something that had the same read syntax
15502 as an Emacs Lisp list would fit that spec.
15503
15504 Here's a typical score file:
15505
15506 @lisp
15507 (("summary"
15508   ("win95" -10000 nil s)
15509   ("Gnus"))
15510  ("from"
15511   ("Lars" -1000))
15512  (mark -100))
15513 @end lisp
15514
15515 BNF definition of a score file:
15516
15517 @example
15518 score-file       = "" / "(" *element ")"
15519 element          = rule / atom
15520 rule             = string-rule / number-rule / date-rule
15521 string-rule      = "(" quote string-header quote space *string-match ")"
15522 number-rule      = "(" quote number-header quote space *number-match ")"
15523 date-rule        = "(" quote date-header quote space *date-match ")"
15524 quote            = <ascii 34>
15525 string-header    = "subject" / "from" / "references" / "message-id" / 
15526                    "xref" / "body" / "head" / "all" / "followup"
15527 number-header    = "lines" / "chars"
15528 date-header      = "date"
15529 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
15530                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
15531 score            = "nil" / <integer>
15532 date             = "nil" / <natural number>
15533 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
15534                    "r" / "regex" / "R" / "Regex" /
15535                    "e" / "exact" / "E" / "Exact" /
15536                    "f" / "fuzzy" / "F" / "Fuzzy"
15537 number-match     = "(" <integer> [ "" / [ space score [ "" / 
15538                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
15539 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
15540 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
15541                    space date [ "" / [ space date-match-t ] ] ] ] ")"
15542 date-match-t     = "nil" / "at" / "before" / "after"
15543 atom             = "(" [ required-atom / optional-atom ] ")"
15544 required-atom    = mark / expunge / mark-and-expunge / files /
15545                    exclude-files / read-only / touched
15546 optional-atom    = adapt / local / eval 
15547 mark             = "mark" space nil-or-number
15548 nil-or-number    = "nil" / <integer>
15549 expunge          = "expunge" space nil-or-number
15550 mark-and-expunge = "mark-and-expunge" space nil-or-number
15551 files            = "files" *[ space <string> ]
15552 exclude-files    = "exclude-files" *[ space <string> ]
15553 read-only        = "read-only" [ space "nil" / space "t" ]
15554 adapt            = "adapt" [ space "nil" / space "t" / space adapt-rule ]
15555 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
15556 local            = "local" *[ space "(" <string> space <form> ")" ]
15557 eval             = "eval" space <form>
15558 space            = *[ " " / <TAB> / <NEWLINE> ]
15559 @end example
15560
15561 Any unrecognized elements in a score file should be ignored, but not
15562 discarded.  
15563
15564 As you can see, white space is needed, but the type and amount of white
15565 space is irrelevant.  This means that formatting of the score file is
15566 left up to the programmer---if it's simpler to just spew it all out on
15567 one looong line, then that's ok.
15568
15569 The meaning of the various atoms are explained elsewhere in this
15570 manual. 
15571
15572
15573 @node Headers
15574 @subsection Headers
15575
15576 Gnus uses internally a format for storing article headers that
15577 corresponds to the @sc{nov} format in a mysterious fashion.  One could
15578 almost suspect that the author looked at the @sc{nov} specification and
15579 just shamelessly @emph{stole} the entire thing, and one would be right.
15580
15581 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
15582 RFC1036 to talk about lines in the head of an article (e.g.,
15583 @code{From}).  It is used by many people as a synonym for
15584 ``head''---``the header and the body''.  (That should be avoided, in my
15585 opinion.)  And Gnus uses a format internally that it calls ``header'',
15586 which is what I'm talking about here.  This is a 9-element vector,
15587 basically, with each header (ouch) having one slot.
15588
15589 These slots are, in order: @code{number}, @code{subject}, @code{from},
15590 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
15591 @code{xref}.  There are macros for accessing and setting these
15592 slots---they all have predictable names beginning with
15593 @code{mail-header-} and @code{mail-header-set-}, respectively.
15594
15595 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
15596 be put in there.
15597
15598
15599 @node Ranges
15600 @subsection Ranges
15601
15602 @sc{gnus} introduced a concept that I found so useful that I've started
15603 using it a lot and have elaborated on it greatly. 
15604
15605 The question is simple: If you have a large amount of objects that are
15606 identified by numbers (say, articles, to take a @emph{wild} example)
15607 that you want to qualify as being ``included'', a normal sequence isn't
15608 very useful.  (A 200,000 length sequence is a bit long-winded.)
15609
15610 The solution is as simple as the question: You just collapse the
15611 sequence. 
15612
15613 @example
15614 (1 2 3 4 5 6 10 11 12)
15615 @end example
15616
15617 is transformed into
15618
15619 @example
15620 ((1 . 6) (10 . 12))
15621 @end example
15622
15623 To avoid having those nasty @samp{(13 . 13)} elements to denote a
15624 lonesome object, a @samp{13} is a valid element:
15625
15626 @example
15627 ((1 . 6) 7 (10 . 12))
15628 @end example
15629
15630 This means that comparing two ranges to find out whether they are equal
15631 is slightly tricky:
15632
15633 @example
15634 ((1 . 5) 7 8 (10 . 12))
15635 @end example
15636
15637 and
15638
15639 @example
15640 ((1 . 5) (7 . 8) (10 . 12))
15641 @end example
15642
15643 are equal.  In fact, any non-descending list is a range:
15644
15645 @example
15646 (1 2 3 4 5)
15647 @end example
15648
15649 is a perfectly valid range, although a pretty long-winded one.  This is
15650 also legal:
15651
15652 @example
15653 (1 . 5)
15654 @end example
15655
15656 and is equal to the previous range.
15657
15658 Here's a BNF definition of ranges.  Of course, one must remember the
15659 semantic requirement that the numbers are non-descending.  (Any number
15660 of repetition of the same number is allowed, but apt to disappear in
15661 range handling.)
15662
15663 @example
15664 range           = simple-range / normal-range
15665 simple-range    = "(" number " . " number ")"
15666 normal-range    = "(" start-contents ")"
15667 contents        = "" / simple-range *[ " " contents ] / 
15668                   number *[ " " contents ]
15669 @end example
15670
15671 Gnus currently uses ranges to keep track of read articles and article
15672 marks.  I plan on implementing a number of range operators in C if The
15673 Powers That Be are willing to let me.  (I haven't asked yet, because I
15674 need to do some more thinking on what operators I need to make life
15675 totally range-based without ever having to convert back to normal
15676 sequences.) 
15677
15678
15679 @node Group Info
15680 @subsection Group Info
15681
15682 Gnus stores all permanent info on groups in a @dfn{group info} list.
15683 This list is from three to six elements (or more) long and exhaustively
15684 describes the group.
15685
15686 Here are two example group infos; one is a very simple group while the
15687 second is a more complex one:
15688
15689 @example
15690 ("no.group" 5 (1 . 54324))
15691
15692 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
15693                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
15694                 (nnml "")
15695                 (auto-expire (to-address "ding@@ifi.uio.no")))
15696 @end example
15697
15698 The first element is the @dfn{group name}---as Gnus knows the group,
15699 anyway.  The second element is the @dfn{subscription level}, which
15700 normally is a small integer.  The third element is a list of ranges of
15701 read articles.  The fourth element is a list of lists of article marks
15702 of various kinds.  The fifth element is the select method (or virtual
15703 server, if you like).  The sixth element is a list of @dfn{group
15704 parameters}, which is what this section is about.
15705
15706 Any of the last three elements may be missing if they are not required.
15707 In fact, the vast majority of groups will normally only have the first
15708 three elements, which saves quite a lot of cons cells.
15709
15710 Here's a BNF definition of the group info format:
15711
15712 @example
15713 info          = "(" group space level space read 
15714                 [ "" / [ space marks-list [ "" / [ space method [ "" /
15715                 space parameters ] ] ] ] ] ")" 
15716 group         = quote <string> quote
15717 level         = <integer in the range of 1 to inf>
15718 read          = range
15719 marks-lists   = nil / "(" *marks ")"
15720 marks         = "(" <string> range ")"
15721 method        = "(" <string> *elisp-forms ")"
15722 parameters    = "(" *elisp-forms ")"
15723 @end example
15724
15725 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
15726 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
15727 in pseudo-BNF.
15728
15729
15730 @node Emacs/XEmacs Code
15731 @subsection Emacs/XEmacs Code
15732 @cindex XEmacs
15733 @cindex Emacsen
15734
15735 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
15736 platforms must be the primary one.  I chose Emacs.  Not because I don't
15737 like XEmacs or Mule, but because it comes first alphabetically.
15738
15739 This means that Gnus will byte-compile under Emacs with nary a warning,
15740 while XEmacs will pump out gigabytes of warnings while byte-compiling.
15741 As I use byte-compilation warnings to help me root out trivial errors in
15742 Gnus, that's very useful.  
15743
15744 I've also consistently used Emacs function interfaces, but have used
15745 Gnusey aliases for the functions.  To take an example:  Emacs defines a
15746 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
15747 function.  I then define a function called @code{gnus-run-at-time} that
15748 takes the same parameters as the Emacs @code{run-at-time}.  When running
15749 Gnus under Emacs, the former function is just an alias for the latter.
15750 However, when running under XEmacs, the former is an alias for the
15751 following function:
15752
15753 @lisp
15754 (defun gnus-xmas-run-at-time (time repeat function &rest args)
15755   (start-itimer
15756    "gnus-run-at-time"
15757    `(lambda ()
15758       (,function ,@@args))
15759    time repeat))
15760 @end lisp
15761
15762 This sort of thing has been done for bunches of functions.  Gnus does
15763 not redefine any native Emacs functions while running under XEmacs---it
15764 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
15765 all over.
15766
15767 Of course, I could have chosen XEmacs as my native platform and done
15768 mapping functions the other way around.  But I didn't.  The performance
15769 hit these indirections impose on Gnus under XEmacs should be slight.
15770
15771
15772 @node Various File Formats
15773 @subsection Various File Formats
15774
15775 @menu
15776 * Active File Format::      Information on articles and groups available.
15777 * Newsgroups File Format::  Group descriptions.
15778 @end menu
15779
15780
15781 @node Active File Format
15782 @subsubsection Active File Format
15783
15784 The active file lists all groups that are available on the server in
15785 question.  It also lists the highest and lowest current article numbers
15786 in each group.  
15787
15788 Here's an excerpt from a typical active file:
15789
15790 @example
15791 soc.motss 296030 293865 y
15792 alt.binaries.pictures.fractals 3922 3913 n
15793 comp.sources.unix 1605 1593 m
15794 comp.binaries.ibm.pc 5097 5089 y
15795 no.general 1000 900 y
15796 @end example
15797
15798 Here's a pseudo-BNF definition of this file:
15799
15800 @example
15801 active      = *group-line
15802 group-line  = group space high-number space low-number space flag <NEWLINE>
15803 group       = <non-white-space string>
15804 space       = " "
15805 high-number = <non-negative integer>
15806 low-number  = <positive integer>
15807 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
15808 @end example
15809
15810
15811 @node Newsgroups File Format
15812 @subsubsection Newsgroups File Format
15813
15814 The newsgroups file lists groups along with their descriptions.  Not all
15815 groups on the server have to be listed,  and not all groups in the file
15816 have to exist on the server.  The file is meant purely as information to
15817 the user.
15818
15819 The format is quite simple; a group name, a tab, and the description.
15820 Here's the definition:
15821
15822 @example
15823 newsgroups    = *line
15824 line          = group tab description <NEWLINE>
15825 group         = <non-white-space string>
15826 tab           = <TAB>
15827 description   = <string>
15828 @end example
15829
15830
15831 @node Emacs for Heathens
15832 @section Emacs for Heathens
15833
15834 Believe it or not, but some people who use Gnus haven't really used
15835 Emacs much before they embarked on their journey on the Gnus Love Boat.
15836 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
15837 region'', and ``set @code{gnus-flargblossen} to an alist where the key
15838 is a regexp that is used for matching on the group name'' are magical
15839 phrases with little or no meaning, then this appendix is for you.  If
15840 you are already familiar with Emacs, just ignore this and go fondle your
15841 cat instead.
15842
15843 @menu
15844 * Keystrokes::      Entering text and executing commands.
15845 * Emacs Lisp::      The built-in Emacs programming language.
15846 @end menu
15847
15848
15849 @node Keystrokes
15850 @subsection Keystrokes
15851
15852 @itemize @bullet
15853 @item
15854 Q: What is an experienced Emacs user?
15855
15856 @item 
15857 A: A person who wishes that the terminal had pedals.
15858 @end itemize
15859
15860 Yes, when you use Emacs, you are apt to use the control key, the shift
15861 key and the meta key a lot.  This is very annoying to some people
15862 (notably @code{vi}le users), and the rest of us just love the hell out
15863 of it.  Just give up and submit.  Emacs really does stand for
15864 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
15865 may have heard from other disreputable sources (like the Emacs author).
15866
15867 The shift key is normally located near your pinky fingers, and are
15868 normally used to get capital letters and stuff.  You probably use it all
15869 the time.  The control key is normally marked ``CTRL'' or something like
15870 that.  The meta key is, funnily enough, never marked as such on any
15871 keyboards.  The one I'm currently at has a key that's marked ``Alt'',
15872 which is the meta key on this keyboard.  It's usually located somewhere
15873 to the left hand side of the keyboard, usually on the bottom row.
15874
15875 Now, us Emacs people doesn't say ``press the meta-control-m key'',
15876 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
15877 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
15878 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
15879 down the control key, and hold it down while you press @kbd{k}''.
15880 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
15881 the control key and then press @kbd{k}''.  Simple, ay?
15882
15883 This is somewhat complicated by the fact that not all keyboards have a
15884 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
15885 means ``press escape, release escape, press @kbd{k}''.  That's much more
15886 work than if you have a meta key, so if that's the case, I respectfully
15887 suggest you get a real keyboard with a meta key.  You can't live without
15888 it.
15889
15890
15891
15892 @node Emacs Lisp
15893 @subsection Emacs Lisp
15894
15895 Emacs is the King of Editors because it's really a Lisp interpreter.
15896 Each and every key you tap runs some Emacs Lisp code snippet, and since
15897 Emacs Lisp is an interpreted language, that means that you can configure
15898 any key to run any arbitrary code.  You just, like, do it.
15899
15900 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
15901 functions.  (These are byte-compiled for speed, but it's still
15902 interpreted.)  If you decide that you don't like the way Gnus does
15903 certain things, it's trivial to have it do something a different way.
15904 (Well, at least if you know how to write Lisp code.)  However, that's
15905 beyond the scope of this manual, so we are simply going to talk about
15906 some common constructs that you normally use in your @file{.emacs} file
15907 to customize Gnus.
15908
15909 If you want to set the variable @code{gnus-florgbnize} to four (4), you
15910 write the following:
15911
15912 @lisp
15913 (setq gnus-florgbnize 4)
15914 @end lisp
15915
15916 This function (really ``special form'') @code{setq} is the one that can
15917 set a variable to some value.  This is really all you need to know.  Now
15918 you can go and fill your @code{.emacs} file with lots of these to change
15919 how Gnus works.
15920
15921 If you have put that thing in your @code{.emacs} file, it will be read
15922 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
15923 start Emacs.  If you want to change the variable right away, simply say
15924 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
15925 previous ``form'', which here is a simple @code{setq} statement.
15926
15927 Go ahead---just try it, if you're located at your Emacs.  After you
15928 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
15929 is the return value of the form you @code{eval}ed.
15930
15931 Some pitfalls:
15932
15933 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
15934 that means:
15935
15936 @lisp
15937 (setq gnus-read-active-file 'some)
15938 @end lisp
15939
15940 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
15941 @samp{nntp.ifi.uio.no}'', that means:
15942
15943 @lisp
15944 (setq gnus-nntp-server "nntp.ifi.uio.no")
15945 @end lisp
15946
15947 So be careful not to mix up strings (the latter) with symbols (the
15948 former).  The manual is unambiguous, but it can be confusing.
15949
15950
15951 @include gnus-faq.texi
15952
15953 @node Index
15954 @chapter Index
15955 @printindex cp
15956
15957 @node Key Index
15958 @chapter Key Index
15959 @printindex ky
15960
15961 @summarycontents
15962 @contents
15963 @bye
15964
15965 @iftex
15966 @iflatex
15967 \end{document}
15968 @end iflatex
15969 @end iftex
15970
15971 @c End:
15972