*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Gnus 5.2 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{fontenc}
18 % \usepackage{babel}
19 \usepackage{pagestyle}
20 \usepackage{epsfig}
21 % \usepackage{ifitricks}
22 \fontfamily{bembo}\selectfont
23
24 \makeindex
25 \begin{document}
26
27 \newcommand{\gnuschaptername}{}
28 \newcommand{\gnussectionname}{}
29
30 \newcommand{\gnusbackslash}{/}
31
32 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
33 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
34
35 \newcommand{\gnuskindex}[1]{\index{#1}}
36 \newcommand{\gnusindex}[1]{\index{#1}}
37
38 \newcommand{\gnustt}[1]{{\textbf{\textsf{#1}}}}
39 \newcommand{\gnuscode}[1]{\gnustt{#1}}
40 \newcommand{\gnussamp}[1]{``\gnustt{#1}''}
41 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
42 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
43 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusdfn}[1]{\textit{#1}}
45 \newcommand{\gnusi}[1]{\textit{#1}}
46 \newcommand{\gnusstrong}[1]{\textbf{#1}}
47 \newcommand{\gnusemph}[1]{\textit{#1}}
48 \newcommand{\gnusvar}[1]{\textsl{\textsf{#1}}}
49 \newcommand{\gnussc}[1]{\textsc{#1}}
50 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
51 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
52
53 \newcommand{\gnusbullet}{{${\bullet}$}}
54 \newcommand{\gnusdollar}{\$}
55 \newcommand{\gnusampersand}{\&}
56 \newcommand{\gnuspercent}{\%}
57 \newcommand{\gnushash}{\#}
58 \newcommand{\gnushat}{\symbol{"5E}}
59 \newcommand{\gnusunderline}{\symbol{"5F}}
60 \newcommand{\gnustilde}{\symbol{"7E}}
61 \newcommand{\gnusless}{{$<$}}
62 \newcommand{\gnusgreater}{{$>$}}
63
64 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=gnus-head.eps,height=1cm}}}
65 \newcommand{\gnusinteresting}{
66 \marginpar[\hspace{2.5cm}\gnushead]{\gnushead}
67 }
68
69 \newcommand{\gnuschapter}[1]{
70 \renewcommand{\gnussectionname}{}
71 \chapter{#1}
72 \renewcommand{\gnuschaptername}{#1}
73 \thispagestyle{empty}
74 % \epsfig{figure=gnus-herd-\arabic{chapter}.eps,height=15cm}
75 \clearpage
76 }
77
78 \newcommand{\gnusitemx}[1]{\vspace{-\itemsep}\item#1}
79
80 \newcommand{\gnussection}[1]{
81 \renewcommand{\gnussectionname}{#1}
82 \section{#1}
83 }
84
85 \newenvironment{codelist}%
86 {\begin{list}{}{
87 }
88 }{\end{list}}
89
90 \newenvironment{kbdlist}%
91 {\begin{list}{}{
92 \labelwidth=0cm
93 }
94 }{\end{list}}
95
96 \newenvironment{dfnlist}%
97 {\begin{list}{}{
98 }
99 }{\end{list}}
100
101 \newenvironment{stronglist}%
102 {\begin{list}{}{
103 }
104 }{\end{list}}
105
106 \newenvironment{samplist}%
107 {\begin{list}{}{
108 }
109 }{\end{list}}
110
111 \newenvironment{varlist}%
112 {\begin{list}{}{
113 }
114 }{\end{list}}
115
116 \newenvironment{emphlist}%
117 {\begin{list}{}{
118 }
119 }{\end{list}}
120
121 \newpagestyle{gnus}%
122 {
123 {
124 \ifodd\count0
125 {
126 \hspace*{-2ex}
127 \underline{
128 \makebox[\headtextwidth]{
129 \hspace*{-2.3ex}
130 \textbf{\arabic{chapter}.\arabic{section}}
131 \textbf{\gnussectionname\hfill\arabic{page}}
132 }}
133 }
134 \else
135 {
136 \hspace*{-2.25cm}
137 \underline{
138 \hspace*{-2.3ex}
139 \makebox[\headtextwidth]{
140 \textbf{\arabic{page}\hfill\gnuschaptername}
141 }}
142 }
143 \fi
144 }
145 }
146 {
147 \ifodd\count0
148 \mbox{} \hfill 
149 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
150 \else
151 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
152 \hfill \mbox{}
153 \fi
154 }
155 \pagestyle{gnus}
156
157 @end iflatex
158 @end iftex
159
160 @iftex
161 @iflatex
162 \begin{titlepage}
163 {
164
165 %\addtolength{\oddsidemargin}{-5cm}
166 %\addtolength{\evensidemargin}{-5cm}
167 \parindent=0cm
168 \addtolength{\textheight}{2cm}
169
170 \gnustitle{\gnustitlename}\\
171 \rule{15cm}{1mm}\\
172 \vfill
173 \hspace*{-1cm}\epsfig{figure=gnus-big-logo.eps,height=15cm}
174 \vfill
175 \rule{15cm}{1mm}\\
176 \gnusauthor{by Lars Magne Ingebrigtsen}
177 \newpage
178 }
179
180 \mbox{}
181 \vfill
182
183 \thispagestyle{empty}
184
185 Copyright \copyright{} 1995,96 Free Software Foundation, Inc. 
186
187 Permission is granted to make and distribute verbatim copies of
188 this manual provided the copyright notice and this permission notice
189 are preserved on all copies.
190
191 Permission is granted to copy and distribute modified versions of this
192 manual under the conditions for verbatim copying, provided that the
193 entire resulting derived work is distributed under the terms of a
194 permission notice identical to this one.
195
196 Permission is granted to copy and distribute translations of this manual
197 into another language, under the above conditions for modified versions.
198
199 \newpage
200 \end{titlepage}
201 @end iflatex
202 @end iftex
203
204 @ifinfo
205
206 This file documents Gnus, the GNU Emacs newsreader.
207
208 Copyright (C) 1995,96 Free Software Foundation, Inc.
209
210 Permission is granted to make and distribute verbatim copies of
211 this manual provided the copyright notice and this permission notice
212 are preserved on all copies.
213
214 @ignore
215 Permission is granted to process this file through Tex and print the
216 results, provided the printed document carries copying permission
217 notice identical to this one except for the removal of this paragraph
218 (this paragraph not being relevant to the printed manual).
219
220 @end ignore
221 Permission is granted to copy and distribute modified versions of this
222 manual under the conditions for verbatim copying, provided also that the
223 entire resulting derived work is distributed under the terms of a
224 permission notice identical to this one.
225
226 Permission is granted to copy and distribute translations of this manual
227 into another language, under the above conditions for modified versions.
228 @end ifinfo
229
230 @tex
231
232 @titlepage
233 @title Gnus Manual
234
235 @author by Lars Magne Ingebrigtsen
236 @page
237
238 @vskip 0pt plus 1filll
239 Copyright @copyright{} 1995,96 Free Software Foundation, Inc. 
240
241 Permission is granted to make and distribute verbatim copies of
242 this manual provided the copyright notice and this permission notice
243 are preserved on all copies.
244
245 Permission is granted to copy and distribute modified versions of this
246 manual under the conditions for verbatim copying, provided that the
247 entire resulting derived work is distributed under the terms of a
248 permission notice identical to this one.
249
250 Permission is granted to copy and distribute translations of this manual
251 into another language, under the above conditions for modified versions.
252
253 @end titlepage
254 @page
255
256 @end tex
257
258
259 @node Top
260 @top The Gnus Newsreader
261
262 @ifinfo
263
264 You can read news (and mail) from within Emacs by using Gnus.  The news
265 can be gotten by any nefarious means you can think of---@sc{nntp}, local
266 spool or your mbox file.  All at the same time, if you want to push your
267 luck.
268
269 @end ifinfo
270
271 @iftex
272
273 @iflatex
274 \thispagestyle{empty}
275 @end iflatex
276
277 Gnus is the advanced, self-documenting, customizable, extensible
278 unreal-time newsreader for GNU Emacs.  
279
280 Oops.  That sounds oddly familiar, so let's start over again to avoid
281 being accused of plagiarism:
282
283 Gnus is a message-reading laboratory.  It will let you look at just
284 about anything as if it were a newsgroup.  You can read mail with it,
285 you can browse directories with it, you can @code{ftp} with it---you can
286 even read news with it!
287
288 Gnus tries to empower people who read news the same way Emacs empowers
289 people who edit text.  Gnus sets no limits to what the user should be
290 allowed to do.  Users are encouraged to extend Gnus to make it behave
291 like they want it to behave.  A program should not control people;
292 people should be empowered to do what they want by using (or abusing)
293 the program.
294
295 @end iftex
296
297
298 @menu
299 * Starting Up::           Finding news can be a pain.
300 * The Group Buffer::      Selecting, subscribing and killing groups.
301 * The Summary Buffer::    Reading, saving and posting articles.
302 * The Article Buffer::    Displaying and handling articles.
303 * Composing Messages::    Information on sending mail and news.
304 * Select Methods::        Gnus reads all messages from various select methods.
305 * Scoring::               Assigning values to articles.
306 * Various::               General purpose settings.
307 * The End::               Farewell and goodbye.
308 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
309 * Index::                 Variable, function and concept index.
310 * Key Index::             Key Index.
311 @end menu
312
313
314 @node Starting Up
315 @chapter Starting Gnus
316 @cindex starting up
317
318 @kindex M-x gnus
319 @findex gnus
320 If your system administrator has set things up properly, starting Gnus
321 and reading news is extremely easy---you just type @kbd{M-x gnus} in
322 your Emacs. 
323
324 @findex gnus-other-frame
325 @kindex M-x gnus-other-frame
326 If you want to start Gnus in a different frame, you can use the command
327 @kbd{M-x gnus-other-frame} instead.
328
329 If things do not go smoothly at startup, you have to twiddle some
330 variables. 
331
332 @menu
333 * Finding the News::    Choosing a method for getting news.
334 * The First Time::      What does Gnus do the first time you start it?
335 * The Server is Down::  How can I read my mail then?
336 * Slave Gnusii::        You can have more than one Gnus active at a time.
337 * Fetching a Group::    Starting Gnus just to read a group.
338 * New Groups::          What is Gnus supposed to do with new groups?
339 * Startup Files::       Those pesky startup files---@file{.newsrc}.
340 * Auto Save::           Recovering from a crash.
341 * The Active File::     Reading the active file over a slow line Takes Time.
342 * Startup Variables::   Other variables you might change.
343 @end menu
344
345
346 @node Finding the News
347 @section Finding the News
348
349 @vindex gnus-select-method
350 @c @head
351 The @code{gnus-select-method} variable says where Gnus should look for
352 news.  This variable should be a list where the first element says
353 @dfn{how} and the second element says @dfn{where}.  This method is your
354 native method.  All groups that are not fetched with this method are
355 foreign groups.
356
357 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
358 you want to get your daily dosage of news from, you'd say:
359
360 @lisp
361 (setq gnus-select-method '(nntp "news.somewhere.edu"))
362 @end lisp
363
364 If you want to read directly from the local spool, say:
365
366 @lisp
367 (setq gnus-select-method '(nnspool ""))
368 @end lisp
369
370 If you can use a local spool, you probably should, as it will almost
371 certainly be much faster.
372
373 @vindex gnus-nntpserver-file
374 @cindex NNTPSERVER
375 @cindex @sc{nntp} server
376 If this variable is not set, Gnus will take a look at the
377 @code{NNTPSERVER} environment variable.  If that variable isn't set,
378 Gnus will see whether @code{gnus-nntpserver-file}
379 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
380 that fails as well, Gnus will will try to use the machine that is
381 running Emacs as an @sc{nntp} server.  That's a long-shot, though.
382
383 @vindex gnus-nntp-server
384 If @code{gnus-nntp-server} is set, this variable will override
385 @code{gnus-select-method}.  You should therefore set
386 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
387
388 @vindex gnus-secondary-servers
389 You can also make Gnus prompt you interactively for the name of an
390 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
391 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
392 in the @code{gnus-secondary-servers} list (if any).  You can also just
393 type in the name of any server you feel like visiting.
394
395 @findex gnus-group-browse-foreign-server
396 @kindex B (Group)
397 However, if you use one @sc{nntp} server regularly and are just
398 interested in a couple of groups from a different server, you would be
399 better served by using the @kbd{B} command in the group buffer.  It will
400 let you have a look at what groups are available, and you can subscribe
401 to any of the groups you want to.  This also makes @file{.newsrc}
402 maintenance much tidier.  @xref{Foreign Groups}.
403
404 @vindex gnus-secondary-select-methods
405 @c @head
406 A slightly different approach to foreign groups is to set the
407 @code{gnus-secondary-select-methods} variable.  The select methods
408 listed in this variable are in many ways just as native as the
409 @code{gnus-select-method} server.  They will also be queried for active
410 files during startup (if that's required), and new newsgroups that
411 appear on these servers will be subscribed (or not) just as native
412 groups are.
413
414 For instance, if you use the @code{nnmbox} backend to read your mail, you
415 would typically set this variable to
416
417 @lisp
418 (setq gnus-secondary-select-methods '((nnmbox "")))
419 @end lisp
420
421
422 @node The First Time
423 @section The First Time
424 @cindex first time usage
425
426 If no startup files exist, Gnus will try to determine what groups should
427 be subscribed by default.
428
429 @vindex gnus-default-subscribed-newsgroups
430 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
431 will subscribe you to just those groups in that list, leaving the rest
432 killed.  Your system administrator should have set this variable to
433 something useful.
434
435 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
436 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is here
437 defined as @dfn{whatever Lars thinks you should read}.)
438
439 You'll also be subscribed to the Gnus documentation group, which should
440 help you with most common problems.  
441
442 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
443 use the normal functions for handling new groups, and not do anything
444 special.
445
446
447 @node The Server is Down
448 @section The Server is Down
449 @cindex server errors
450
451 If the default server is down, Gnus will understandably have some
452 problems starting.  However, if you have some mail groups in addition to
453 the news groups, you may want to start Gnus anyway.
454
455 Gnus, being the trusting sort of program, will ask whether to proceed
456 without a native select method if that server can't be contacted.  This
457 will happen whether the server doesn't actually exist (i.e., you have
458 given the wrong address) or the server has just momentarily taken ill
459 for some reason or other.  If you decide to continue and have no foreign
460 groups, you'll find it difficult to actually do anything in the group
461 buffer.  But, hey, that's your problem.  Blllrph!
462
463 @findex gnus-no-server
464 @c @head
465 If you know that the server is definitely down, or you just want to read
466 your mail without bothering with the server at all, you can use the
467 @code{gnus-no-server} command to start Gnus.  That might come in handy
468 if you're in a hurry as well.
469
470
471 @node Slave Gnusii
472 @section Slave Gnusiï
473 @cindex slave
474
475 You might want to run more than one Emacs with more than one Gnus at the
476 same time.  If you are using different @file{.newsrc} files (eg., if you
477 are using the two different Gnusiï to read from two different servers),
478 that is no problem whatsoever.  You just do it.
479
480 The problem appears when you want to run two Gnusiï that use the same
481 @code{.newsrc} file.
482
483 To work around that problem some, we here at the Think-Tank at the Gnus
484 Towers have come up with a new concept: @dfn{Masters} and
485 @dfn{servants}.  (We have applied for a patent on this concept, and have
486 taken out a copyright on those words.  If you wish to use those words in
487 conjunction with each other, you have to send $1 per usage instance to
488 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
489 Applications}) will be much more expensive, of course.)
490
491 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
492 however you do it).  Each subsequent slave Gnusiï should be started with
493 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
494 files, but instead save @dfn{slave files} that contains information only
495 on what groups have been read in the slave session.  When a master Gnus
496 starts, it will read (and delete) these slave files, incorporating all
497 information from them.  (The slave files will be read in the sequence
498 they were created, so the latest changes will have precedence.)
499
500 Information from the slave files has, of course, precedence over the
501 information in the normal (i. e., master) @code{.newsrc} file.
502
503
504 @node Fetching a Group
505 @section Fetching a Group
506
507 @findex gnus-fetch-group
508 It it sometime convenient to be able to just say ``I want to read this
509 group and I don't care whether Gnus has been started or not''.  This is
510 perhaps more useful for people who write code than for users, but the
511 command @code{gnus-fetch-group} provides this functionality in any case.
512 It takes the group name as a parameter.
513
514
515 @node New Groups
516 @section New Groups
517 @cindex new groups
518
519 @vindex gnus-subscribe-newsgroup-method
520 What Gnus does when it encounters a new group is determined by the
521 @code{gnus-subscribe-newsgroup-method} variable.
522
523 This variable should contain a function.  Some handy pre-fab values
524 are:
525
526 @table @code
527
528 @item gnus-subscribe-zombies
529 @vindex gnus-subscribe-zombies
530 Make all new groups zombies.  You can browse the zombies later (with
531 @kbd{A z}) and either kill them all off properly, or subscribe to them.
532 This is the default.
533
534 @item gnus-subscribe-randomly
535 @vindex gnus-subscribe-randomly
536 Subscribe all new groups randomly.
537
538 @item gnus-subscribe-alphabetically
539 @vindex gnus-subscribe-alphabetically
540 Subscribe all new groups alphabetically.
541
542 @item gnus-subscribe-hierarchically
543 @vindex gnus-subscribe-hierarchically
544 Subscribe all new groups hierarchically.
545
546 @item gnus-subscribe-interactively
547 @vindex gnus-subscribe-interactively
548 Subscribe new groups interactively.  This means that Gnus will ask
549 you about @strong{all} new groups.
550
551 @item gnus-subscribe-killed
552 @vindex gnus-subscribe-killed
553 Kill all new groups.
554
555 @end table
556
557 @vindex gnus-subscribe-hierarchical-interactive
558 A closely related variable is
559 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
560 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
561 hierarchical fashion whether to subscribe to new groups or not.  Gnus
562 will ask you for each sub-hierarchy whether you want to descend the
563 hierarchy or not.  
564
565 One common mistake is to set the variable a few paragraphs above to
566 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
567 will not work.  This is ga-ga.  So don't do it.
568
569 A nice and portable way to control which new newsgroups should be
570 subscribed (or ignored) is to put an @dfn{options} line at the start of
571 the @file{.newsrc} file.  Here's an example:
572
573 @example
574 options -n !alt.all !rec.all sci.all
575 @end example
576
577 @vindex gnus-subscribe-options-newsgroup-method
578 This line obviously belongs to a serious-minded intellectual scientific
579 person (or she may just be plain old boring), because it says that all
580 groups that have names beginning with @samp{alt} and @samp{rec} should
581 be ignored, and all groups with names beginning with @samp{sci} should
582 be subscribed.  Gnus will not use the normal subscription method for
583 subscribing these groups.
584 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
585 variable defaults to @code{gnus-subscribe-alphabetically}.
586
587 @vindex gnus-options-not-subscribe
588 @vindex gnus-options-subscribe
589 If you don't want to mess with your @file{.newsrc} file, you can just
590 set the two variables @code{gnus-options-subscribe} and
591 @code{gnus-options-not-subscribe}.  These two variables do exactly the
592 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
593 and if the the new group matches the former, it will be unconditionally
594 subscribed, and if it matches the latter, it will be ignored.
595
596 @vindex gnus-auto-subscribed-groups
597 Yet another variable that meddles here is
598 @code{gnus-auto-subscribed-groups}.  It works exactly like
599 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
600 thought it would be nice to have two of these.  This variable is more
601 meant for setting some ground rules, while the other variable is used
602 more for user fiddling.  By default this variable makes all new groups
603 that come from mail backends (@code{nnml}, @code{nnbabyl},
604 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
605 don't like that, just set this variable to @code{nil}.
606
607 @vindex gnus-check-new-newsgroups
608 If you are satisfied that you really never want to see any new groups,
609 you could set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
610 also save you some time at startup.  Even if this variable is
611 @code{nil}, you can always subscribe to the new groups just by pressing
612 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
613 is @code{t} by default.
614
615 Gnus normally determines whether a group is new or not by comparing the
616 list of groups from the active file(s) with the lists of subscribed and
617 dead groups.  This isn't a particularly fast method.  If
618 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
619 server for new groups since the last time.  This is both faster &
620 cheaper.  This also means that you can get rid of the list of killed
621 groups altogether, so you may set @code{gnus-save-killed-list} to
622 @code{nil}, which will save time both at startup, at exit, and all over.
623 Saves disk space, too.  Why isn't this the default, then?
624 Unfortunately, not all servers support this command. 
625
626 I bet I know what you're thinking now: How do I find out whether my
627 server supports @code{ask-server}?  No?  Good, because I don't have a
628 fail-safe answer.  I would suggest just setting this variable to
629 @code{ask-server} and see whether any new groups appear within the next
630 few days.  If any do, then it works.  If any don't, then it doesn't
631 work.  I could write a function to make Gnus guess whether the server
632 supports @code{ask-server}, but it would just be a guess.  So I won't.
633 You could @code{telnet} to the server and say @code{HELP} and see
634 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
635 it does, then it might work.  (But there are servers that lists
636 @samp{NEWGROUPS} without supporting the function properly.)
637
638 This variable can also be a list of select methods.  If so, Gnus will
639 issue an @code{ask-server} command to each of the select methods, and
640 subscribe them (or not) using the normal methods.  This might be handy
641 if you are monitoring a few servers for new groups.  A side effect is
642 that startup will take much longer, so you can meditate while waiting.
643 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
644
645
646 @node Startup Files
647 @section Startup Files
648 @cindex startup files
649 @cindex .newsrc
650
651 Now, you all know about the @file{.newsrc} file.  All subscription
652 information is traditionally stored in this file.
653
654 Things got a bit more complicated with @sc{gnus}.  In addition to
655 keeping the @file{.newsrc} file updated, it also used a file called
656 @file{.newsrc.el} for storing all the information that didn't fit into
657 the @file{.newsrc} file.  (Actually, it also duplicated everything in
658 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
659 files was the most recently saved, which enabled people to swap between
660 @sc{gnus} and other newsreaders.
661
662 That was kinda silly, so Gnus went one better: In addition to the
663 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
664 @file{.newsrc.eld}.  It will read whichever of these files that are most
665 recent, but it will never write a @file{.newsrc.el} file.
666
667 @vindex gnus-save-newsrc-file
668 You can turn off writing the @file{.newsrc} file by setting
669 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
670 the file and save some space, as well as making exit from Gnus faster.
671 However, this will make it impossible to use other newsreaders than
672 Gnus.  But hey, who would want to, right?
673
674 @vindex gnus-save-killed-list
675 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
676 will not save the list of killed groups to the startup file.  This will
677 save both time (when starting and quitting) and space (on disk).  It
678 will also means that Gnus has no record of what groups are new or old,
679 so the automatic new groups subscription methods become meaningless.
680 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
681 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
682 Groups}).
683
684 @vindex gnus-startup-file
685 The @code{gnus-startup-file} variable says where the startup files are.
686 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
687 file being whatever that one is with a @samp{.eld} appended.
688
689 @vindex gnus-save-newsrc-hook
690 @vindex gnus-save-quick-newsrc-hook
691 @vindex gnus-save-standard-newsrc-hook
692 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
693 files, while @code{gnus-save-quick-newsrc-hook} is called just before
694 saving the @file{.newsrc.eld} file, and
695 @code{gnus-save-standard-newsrc-hook} is called just before saving the
696 @file{.newsrc} file.  The latter two are commonly used to turn version
697 control on or off.  Version control is off by default when saving the
698 startup files.
699
700
701 @node Auto Save
702 @section Auto Save
703 @cindex dribble file
704 @cindex auto-save
705
706 Whenever you do something that changes the Gnus data (reading articles,
707 catching up, killing/subscribing groups), the change is added to a
708 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
709 Emacs way.  If your Emacs should crash before you have saved the
710 @file{.newsrc} files, all changes you have made can be recovered from
711 this file.
712
713 If Gnus detects this file at startup, it will ask the user whether to
714 read it.  The auto save file is deleted whenever the real startup file is
715 saved.
716
717 @vindex gnus-use-dribble-file
718 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
719 maintain a dribble buffer.  The default is @code{t}.
720
721 @vindex gnus-dribble-directory
722 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
723 this variable is @code{nil}, which it is by default, Gnus will dribble
724 into the directory where the @file{.newsrc} file is located.  (This is
725 normally the user's home directory.)  The dribble file will get the same
726 file permissions as the @code{.newsrc} file.
727
728
729 @node The Active File
730 @section The Active File
731 @cindex active file
732 @cindex ignored groups
733
734 When Gnus starts, or indeed whenever it tries to determine whether new
735 articles have arrived, it reads the active file.  This is a very large
736 file that lists all the active groups and articles on the server.
737
738 @vindex gnus-ignored-newsgroups
739 Before examining the active file, Gnus deletes all lines that match the
740 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
741 any groups with bogus names, but you can use this variable to make Gnus
742 ignore hierarchies you aren't ever interested in.  However, this is not
743 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
744 Groups} for an overview of other variables that can be used instead.
745
746 @c This variable is
747 @c @code{nil} by default, and will slow down active file handling somewhat
748 @c if you set it to anything else.
749
750 @vindex gnus-read-active-file
751 @c @head
752 The active file can be rather Huge, so if you have a slow network, you
753 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
754 reading the active file.  This variable is @code{t} by default.
755
756 Gnus will try to make do by getting information just on the groups that
757 you actually subscribe to.
758
759 Note that if you subscribe to lots and lots of groups, setting this
760 variable to @code{nil} will probably make Gnus slower, not faster.  At
761 present, having this variable @code{nil} will slow Gnus down
762 considerably, unless you read news over a 2400 baud modem.  
763
764 This variable can also have the value @code{some}.  Gnus will then
765 attempt to read active info only on the subscribed groups.  On some
766 servers this is quite fast (on sparkling, brand new INN servers that
767 support the @code{LIST ACTIVE group} command), on others this isn't fast
768 at all.  In any case, @code{some} should be faster than @code{nil}, and
769 is certainly faster than @code{t} over slow lines.
770
771 If this variable is @code{nil}, Gnus will ask for group info in total
772 lock-step, which isn't very fast.  If it is @code{some} and you use an
773 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
774 read all the replies in one swoop.  This will normally result in better
775 performance, but if the server does not support the aforementioned
776 @code{LIST ACTIVE group} command, this isn't very nice to the server.
777
778 In any case, if you use @code{some} or @code{nil}, you should definitely
779 kill all groups that you aren't interested in to speed things up.
780
781
782 @node Startup Variables
783 @section Startup Variables
784
785 @table @code
786
787 @item gnus-load-hook
788 @vindex gnus-load-hook
789 A hook that is run while Gnus is being loaded.  Note that this hook will
790 normally be run just once in each Emacs session, no matter how many
791 times you start Gnus.
792
793 @item gnus-startup-hook
794 @vindex gnus-startup-hook
795 A hook that is run after starting up Gnus successfully.
796
797 @item gnus-check-bogus-newsgroups
798 @vindex gnus-check-bogus-newsgroups
799 If non-@code{nil}, Gnus will check for and delete all bogus groups at
800 startup.  A @dfn{bogus group} is a group that you have in your
801 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
802 bogus groups can take quite a while, so to save time and resources it's
803 best to leave this option off, and do the checking for bogus groups once
804 in a while from the group buffer instead (@pxref{Group Maintenance}).
805
806 @item gnus-inhibit-startup-message
807 @vindex gnus-inhibit-startup-message
808 If non-@code{nil}, the startup message won't be displayed.  That way,
809 your boss might not notice that you are reading news instead of doing
810 your job as easily.
811
812 @item gnus-no-groups-message
813 @vindex gnus-no-groups-message
814 Message displayed by Gnus when no groups are available.
815 @end table
816
817
818 @node The Group Buffer
819 @chapter The Group Buffer
820 @cindex group buffer
821
822 The @dfn{group buffer} lists all (or parts) of the available groups.  It
823 is the first buffer shown when Gnus starts, and will never be killed as
824 long as Gnus is active.
825
826 @menu
827 * Group Buffer Format::    Information listed and how you can change it.
828 * Group Maneuvering::      Commands for moving in the group buffer.
829 * Selecting a Group::      Actually reading news.
830 * Subscription Commands::  Unsubscribing, killing, subscribing.
831 * Group Levels::           Levels? What are those, then?
832 * Group Score::            A mechanism for finding out what groups you like.
833 * Marking Groups::         You can mark groups for later processing.
834 * Foreign Groups::         Creating and editing groups.
835 * Group Parameters::       Each group may have different parameters set.
836 * Listing Groups::         Gnus can list various subsets of the groups.
837 * Sorting Groups::         Re-arrange the group order.
838 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
839 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
840 * Exiting Gnus::           Stop reading news and get some work done.
841 * Group Topics::           A folding group mode divided into topics.
842 * Misc Group Stuff::       Other stuff that you can to do.
843 @end menu
844
845
846 @node Group Buffer Format
847 @section Group Buffer Format
848 @cindex group buffer format
849
850 @menu 
851 * Group Line Specification::       Deciding how the group buffer is to look.
852 * Group Modeline Specification::   The group buffer modeline.
853 * Group Highlighting::             Having nice colors in the group buffer.
854 @end menu
855
856
857 @node Group Line Specification
858 @subsection Group Line Specification
859
860 The default format of the group buffer is nice and dull, but you can
861 make it as exciting and ugly as you feel like.
862
863 Here's a couple of example group lines:
864
865 @example
866      25: news.announce.newusers
867  *    0: alt.fan.andrea-dworkin
868 @end example
869
870 Quite simple, huh?
871
872 You can see that there are 25 unread articles in
873 @samp{news.announce.newusers}.  There are no unread articles, but some
874 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
875 asterisk at the beginning of the line?)
876
877 @vindex gnus-group-line-format
878 You can change that format to whatever you want by fiddling with the
879 @code{gnus-group-line-format} variable.  This variable works along the
880 lines of a @code{format} specification, which is pretty much the same as
881 a @code{printf} specifications, for those of you who use (feh!) C.
882 @xref{Formatting Variables}. 
883
884 The default value that produced those lines above is 
885 @samp{%M%S%5y: %(%g%)\n}.
886
887 There should always be a colon on the line; the cursor always moves to
888 the colon after performing an operation.  Nothing else is required---not
889 even the group name.  All displayed text is just window dressing, and is
890 never examined by Gnus.  Gnus stores all real information it needs using
891 text properties.
892
893 (Note that if you make a really strange, wonderful, spreadsheet-like
894 layout, everybody will believe you are hard at work with the accounting
895 instead of wasting time reading news.)
896
897 Here's a list of all available format characters:
898
899 @table @samp
900
901 @item M    
902 Only marked articles.
903
904 @item S
905 Whether the group is subscribed.
906
907 @item L    
908 Level of subscribedness.
909
910 @item N
911 Number of unread articles.
912
913 @item I
914 Number of dormant articles.
915
916 @item T
917 Number of ticked articles.
918
919 @item R
920 Number of read articles.
921
922 @item t
923 Total number of articles.
924
925 @item y
926 Number of unread, unticked, non-dormant articles.
927
928 @item i
929 Number of ticked and dormant articles.
930
931 @item g
932 Full group name.
933
934 @item G
935 Group name.
936
937 @item D
938 Newsgroup description.
939
940 @item o
941 @samp{m} if moderated.
942
943 @item O
944 @samp{(m)} if moderated.
945
946 @item s
947 Select method.
948
949 @item n
950 Select from where.
951
952 @item z
953 A string that looks like @samp{<%s:%n>} if a foreign select method is
954 used.
955
956 @item P
957 Indentation based on the level of the topic (@pxref{Group Topics}). 
958
959 @item c
960 @vindex gnus-group-uncollapsed-levels
961 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
962 variable says how many levels to leave at the end of the group name.
963 The default is @code{1}.
964
965 @item u
966 User defined specifier.  The next character in the format string should
967 be a letter.  @sc{gnus} will call the function
968 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
969 following @samp{%u}.  The function will be passed the current headers as
970 argument.  The function should return a string, which will be inserted
971 into the buffer just like information from any other specifier.
972 @end table
973
974 @cindex *
975 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
976 if no info is available---for instance, if it is a non-activated foreign
977 group, or a bogus (or semi-bogus) native group.
978
979
980 @node Group Modeline Specification
981 @subsection Group Modeline Specification
982
983 @vindex gnus-group-mode-line-format
984 The mode line can be changed by setting
985 (@code{gnus-group-mode-line-format}).  It doesn't understand that many
986 format specifiers:
987
988 @table @samp
989 @item S
990 The native news server.
991 @item M
992 The native select method.
993 @end table
994
995
996 @node Group Highlighting
997 @subsection Group Highlighting
998
999 @vindex gnus-group-highlight
1000 Highlighting in the group buffer is controlled by the
1001 @code{gnus-group-highlight} variable.  This is an alist with elements
1002 that look like @var{(form . face)}.  If @var{form} evaluates to
1003 something non-@code{nil}, the @var{face} will be used on the line.
1004
1005 Here's an example value for this variable that might look nice if the
1006 background is dark:
1007
1008 @lisp
1009 (setq gnus-group-highlight
1010     `(((> unread 200) . 
1011        ,(custom-face-lookup "Red" nil nil t nil nil))
1012       ((and (< level 3) (zerop unread)) . 
1013        ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1014       ((< level 3) . 
1015        ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1016       ((zerop unread) . 
1017        ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1018       (t . 
1019        ,(custom-face-lookup "SkyBlue" nil nil t nil nil))
1020       ))
1021 @end lisp
1022
1023 Variables that are dynamically bound when the forms are evaluated
1024 include:
1025
1026 @table @code
1027 @item group
1028 The group name.
1029 @item unread
1030 The number of unread articles in the group.
1031 @item method
1032 The select method.
1033 @item mailp
1034 Whether the group is a mail group.
1035 @item level
1036 The level of the group.
1037 @item score
1038 The score of the group.
1039 @item ticked 
1040 The number of ticked articles in the group.
1041 @item topic
1042 When using the topic minor mode, this variable is bound to the current
1043 topic being inserted.
1044 @end table
1045
1046 When the forms are @code{eval}ed, point is at the beginning of the line
1047 of the group in question, so you can use many of the normal Gnus
1048 functions for snarfing info on the group.
1049
1050 @vindex gnus-group-update-hook
1051 @findex gnus-group-highlight-line
1052 @code{gnus-group-update-hook} is called when a group line is changed.
1053 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1054 calls @code{gnus-group-highlight-line} by default.
1055
1056
1057 @node Group Maneuvering
1058 @section Group Maneuvering
1059 @cindex group movement
1060
1061 All movement commands understand the numeric prefix and will behave as
1062 expected, hopefully. 
1063
1064 @table @kbd
1065
1066 @item n
1067 @kindex n (Group)
1068 @findex gnus-group-next-unread-group
1069 Go to the next group that has unread articles
1070 (@code{gnus-group-next-unread-group}).
1071
1072 @item p
1073
1074 @itemx DEL
1075 @kindex DEL (Group)
1076 @kindex p (Group)
1077 @findex gnus-group-prev-unread-group
1078 Go to the previous group group that has unread articles
1079 (@code{gnus-group-prev-unread-group}).
1080
1081 @item N
1082 @kindex N (Group)
1083 @findex gnus-group-next-group
1084 Go to the next group (@code{gnus-group-next-group}).
1085
1086 @item P
1087 @kindex P (Group)
1088 @findex gnus-group-prev-group
1089 Go to the previous group (@code{gnus-group-prev-group}).
1090
1091 @item M-p
1092 @kindex M-p (Group)
1093 @findex gnus-group-next-unread-group-same-level
1094 Go to the next unread group on the same level (or lower)
1095 (@code{gnus-group-next-unread-group-same-level}). 
1096
1097 @item M-n
1098 @kindex M-n (Group)
1099 @findex gnus-group-prev-unread-group-same-level
1100 Go to the previous unread group on the same level (or lower)
1101 (@code{gnus-group-prev-unread-group-same-level}). 
1102 @end table
1103
1104 Three commands for jumping to groups:
1105
1106 @table @kbd
1107
1108 @item j
1109 @kindex j (Group)
1110 @findex gnus-group-jump-to-group
1111 Jump to a group (and make it visible if it isn't already)
1112 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1113 like living groups.
1114
1115 @item ,
1116 @kindex , (Group)
1117 @findex gnus-group-best-unread-group
1118 Jump to the unread group with the lowest level
1119 (@code{gnus-group-best-unread-group}). 
1120
1121 @item .
1122 @kindex . (Group)
1123 @findex gnus-group-first-unread-group
1124 Jump to the first group with unread articles
1125 (@code{gnus-group-first-unread-group}).  
1126 @end table
1127
1128 @vindex gnus-group-goto-unread
1129 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1130 commands will move to the next group, not the next unread group.  Even
1131 the commands that say they move to the next unread group.  The default
1132 is @code{t}.
1133
1134
1135 @node Selecting a Group
1136 @section Selecting a Group
1137 @cindex group selection
1138
1139 @table @kbd
1140
1141 @item SPACE
1142 @kindex SPACE (Group)
1143 @findex gnus-group-read-group
1144 Select the current group, switch to the summary buffer and display the
1145 first unread article (@code{gnus-group-read-group}).  If there are no
1146 unread articles in the group, or if you give a non-numerical prefix to
1147 this command, Gnus will offer to fetch all the old articles in this
1148 group from the server.  If you give a numerical prefix @var{N}, Gnus
1149 will fetch @var{N} number of articles.  If @var{N} is positive, fetch
1150 the @var{N} newest articles, if @var{N} is negative, fetch the
1151 @var{abs(N)} oldest articles.
1152
1153 @item RET
1154 @kindex RET (Group)
1155 @findex gnus-group-select-group
1156 Select the current group and switch to the summary buffer
1157 (@code{gnus-group-select-group}).  Takes the same arguments as
1158 @code{gnus-group-read-group}---the only difference is that this command
1159 does not display the first unread article automatically upon group
1160 entry. 
1161
1162 @item M-RET
1163 @kindex M-RET (Group)
1164 @findex gnus-group-quick-select-group
1165 This does the same as the command above, but tries to do it with the
1166 minimum amount off fuzz (@code{gnus-group-quick-select-group}).  No
1167 scoring/killing will be performed, there will be no highlights and no
1168 expunging.  This might be useful if you're in a real hurry and have to
1169 enter some humongous group.
1170
1171 @item M-SPACE
1172 @kindex M-RET (Group)
1173 @findex gnus-group-visible-select-group
1174 This is yet one more command that does the same as the one above, but
1175 this one does it without expunging and hiding dormants
1176 (@code{gnus-group-visible-select-group}).  
1177
1178 @item c
1179 @kindex c (Group)
1180 @findex gnus-group-catchup-current
1181 @vindex gnus-group-catchup-group-hook
1182 Mark all unticked articles in this group as read
1183 (@code{gnus-group-catchup-current}).
1184 @code{gnus-group-catchup-group-hook} is when catching up a group from
1185 the group buffer.
1186
1187 @item C
1188 @kindex C (Group)
1189 @findex gnus-group-catchup-current-all
1190 Mark all articles in this group, even the ticked ones, as read
1191 (@code{gnus-group-catchup-current-all}).   
1192 @end table
1193
1194 @vindex gnus-large-newsgroup
1195 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1196 to be a big group.  This is 200 by default.  If the group has more
1197 unread articles than this, Gnus will query the user before entering the
1198 group.  The user can then specify how many articles should be fetched
1199 from the server.  If the user specifies a negative number (@code{-n}),
1200 the @code{n} oldest articles will be fetched.  If it is positive, the
1201 @code{n} articles that have arrived most recently will be fetched.
1202
1203 @vindex gnus-select-group-hook
1204 @vindex gnus-auto-select-first
1205 @code{gnus-auto-select-first} control whether any articles are selected
1206 automatically when entering a group.  
1207
1208 @table @code
1209
1210 @item nil
1211 Don't select any articles when entering the group.  Just display the
1212 full summary buffer.
1213
1214 @item t
1215 Select the first unread article when entering the group.  
1216
1217 @item best
1218 Select the most high-scored article in the group when entering the
1219 group. 
1220 @end table
1221         
1222 If you want to prevent automatic selection in some group (say, in a
1223 binary group with Huge articles) you can set this variable to @code{nil}
1224 in @code{gnus-select-group-hook}, which is called when a group is
1225 selected.
1226
1227
1228 @node Subscription Commands
1229 @section Subscription Commands
1230 @cindex subscribing
1231
1232 @table @kbd
1233
1234 @item S t
1235 @itemx u
1236 @kindex S t (Group)
1237 @kindex u (Group)
1238 @findex gnus-group-unsubscribe-current-group
1239 Toggle subscription to the current group
1240 (@code{gnus-group-unsubscribe-current-group}).  
1241
1242 @item S s
1243 @itemx U
1244 @kindex S s (Group)
1245 @kindex U (Group)
1246 @findex gnus-group-unsubscribe-group
1247 Prompt for a group to subscribe, and then subscribe it.  If it was
1248 subscribed already, unsubscribe it instead
1249 (@code{gnus-group-unsubscribe-group}).
1250
1251 @item S k
1252 @itemx C-k
1253 @kindex S k (Group)
1254 @kindex C-k (Group)
1255 @findex gnus-group-kill-group
1256 Kill the current group (@code{gnus-group-kill-group}).
1257
1258 @item S y
1259 @itemx C-y
1260 @kindex S y (Group)
1261 @kindex C-y (Group)
1262 @findex gnus-group-yank-group
1263 Yank the last killed group (@code{gnus-group-yank-group}).
1264
1265 @item C-x C-t
1266 @kindex C-x C-t (Group)
1267 @findex gnus-group-transpose-groups
1268 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1269 really a subscription command, but you can use it instead of a
1270 kill-and-yank sequence sometimes.
1271
1272 @item S w
1273 @itemx C-w
1274 @kindex S w (Group)
1275 @kindex C-w (Group)
1276 @findex gnus-group-kill-region
1277 Kill all groups in the region (@code{gnus-group-kill-region}). 
1278
1279 @item S z
1280 @kindex S z (Group)
1281 @findex gnus-group-kill-all-zombies
1282 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1283
1284 @item S C-k
1285 @kindex S C-k (Group)
1286 @findex gnus-group-kill-level
1287 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1288 These groups can't be yanked back after killing, so this command should
1289 be used with some caution.  The only thing where this command comes in
1290 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1291 groups that you want to get rid off.  @kbd{S C-k} on level @code{7} will
1292 kill off all unsubscribed groups that do not have message numbers in the
1293 @file{.newsrc} file.  
1294
1295 @end table
1296
1297 Also @pxref{Group Levels}.
1298
1299
1300 @node Group Levels
1301 @section Group Levels
1302 @cindex group level
1303
1304 All groups have a level of @dfn{subscribedness}.  For instance, if a
1305 group is on level 2, it is more subscribed than a group on level 5.  You
1306 can ask Gnus to just list groups on a given level or lower
1307 (@pxref{Listing Groups}), or to just check for new articles in groups on
1308 a given level or lower (@pxref{Scanning New Messages}).
1309
1310 @table @kbd
1311
1312 @item S l
1313 @kindex S l (Group)
1314 @findex gnus-group-set-current-level
1315 Set the level of the current group.  If a numeric prefix is given, the
1316 next @var{n} groups will have their levels set.  The user will be
1317 prompted for a level.
1318 @end table
1319
1320 @vindex gnus-level-killed
1321 @vindex gnus-level-zombie
1322 @vindex gnus-level-unsubscribed
1323 @vindex gnus-level-subscribed
1324 Gnus considers groups on between levels 1 and
1325 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1326 @code{gnus-level-subscribed} (exclusive) and
1327 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1328 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1329 (default 8) and @code{gnus-level-killed} to be killed (default 9),
1330 completely dead.  Gnus treats subscribed and unsubscribed groups exactly
1331 the same, but zombie and killed groups have no information on what
1332 articles you have read, etc, stored.  This distinction between dead and
1333 living groups isn't done because it is nice or clever, it is done purely
1334 for reasons of efficiency.
1335
1336 It is recommended that you keep all your mail groups (if any) on quite
1337 low levels (eg. 1 or 2).
1338
1339 If you want to play with the level variables, you should show some care.
1340 Set them once, and don't touch them ever again.  Better yet, don't touch
1341 them at all unless you know exactly what you're doing.
1342
1343 @vindex gnus-level-default-unsubscribed
1344 @vindex gnus-level-default-subscribed
1345 Two closely related variables are @code{gnus-level-default-subscribed}
1346 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1347 which are the levels that new groups will be put on if they are
1348 (un)subscribed.  These two variables should, of course, be inside the
1349 relevant legal ranges.
1350
1351 @vindex gnus-keep-same-level
1352 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1353 will only move to groups that are of the same level (or lower).  In
1354 particular, going from the last article in one group to the next group
1355 will go to the next group of the same level (or lower).  This might be
1356 handy if you want to read the most important groups before you read the
1357 rest.
1358
1359 @vindex gnus-group-default-list-level
1360 All groups with a level less than or equal to
1361 @code{gnus-group-default-list-level} will be listed in the group buffer
1362 by default.
1363
1364 @vindex gnus-group-list-inactive-groups
1365 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1366 groups will be listed along with the unread groups.  This variable is
1367 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1368 listed. 
1369
1370 @vindex gnus-group-use-permanent-levels
1371 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1372 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1373 use this level as the ``work'' level.
1374
1375 @vindex gnus-activate-level
1376 Gnus will normally just activate groups that are on level
1377 @code{gnus-activate-level} or less.  If you don't want to activate
1378 unsubscribed groups, for instance, you might set this variable to
1379 @code{5}. 
1380
1381
1382 @node Group Score
1383 @section Group Score
1384 @cindex group score
1385
1386 You would normally keep important groups on high levels, but that scheme
1387 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1388 group buffer according to how often you read groups, perhaps?  Within
1389 reason?  
1390
1391 This is what @dfn{group score} is for.  You can assign a score to each
1392 group.  You can then sort the group buffer based on this score.
1393 Alternatively, you can sort on score and then level.  (Taken together,
1394 the level and the score is called the @dfn{rank} of the group.  A group
1395 that is on level 4 and has a score of 1 has a higher rank than a group
1396 on level 5 that has a score of 300.  (The level is the most significant
1397 part and the score is the least significant part.)
1398
1399 @findex gnus-summary-bubble-group
1400 If you want groups you read often to get higher scores than groups you
1401 read seldom you can add the @code{gnus-summary-bubble-group} function to
1402 the @code{gnus-summary-exit-hook} hook.  This will result (after
1403 sorting) in a bubbling sort of action.  If you want to see that in
1404 action after each summary exit, you can add
1405 @code{gnus-group-sort-groups-by-rank} or
1406 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1407 slow things down somewhat.
1408
1409
1410 @node Marking Groups
1411 @section Marking Groups
1412 @cindex marking groups
1413
1414 If you want to perform some command on several groups, and they appear
1415 subsequently in the group buffer, you would normally just give a
1416 numerical prefix to the command.  Most group commands will then do your
1417 bidding on those groups.
1418
1419 However, if the groups are not in sequential order, you can still
1420 perform a command on several groups.  You simply mark the groups first
1421 with the process mark and then execute the command.
1422
1423 @table @kbd
1424
1425 @item #
1426 @kindex # (Group)
1427 @itemx M m
1428 @kindex M m (Group)
1429 @findex gnus-group-mark-group
1430 Set the mark on the current group (@code{gnus-group-mark-group}). 
1431
1432 @item M-#
1433 @kindex M-# (Group)
1434 @itemx M u
1435 @kindex M u (Group)
1436 @findex gnus-group-unmark-group
1437 Remove the mark from the current group
1438 (@code{gnus-group-unmark-group}). 
1439
1440 @item M U
1441 @kindex M U (Group)
1442 @findex gnus-group-unmark-all-groups
1443 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). 
1444
1445 @item M w
1446 @kindex M w (Group)
1447 @findex gnus-group-mark-region
1448 Mark all groups between point and mark (@code{gnus-group-mark-region}). 
1449
1450 @item M b
1451 @kindex M b (Group)
1452 @findex gnus-group-mark-buffer
1453 Mark all groups in the buffer (@code{gnus-group-mark-buffer}). 
1454
1455 @item M r
1456 @kindex M r (Group)
1457 @findex gnus-group-mark-regexp
1458 Mark all groups that match some regular expression
1459 (@code{gnus-group-mark-regexp}).  
1460 @end table
1461
1462 Also @pxref{Process/Prefix}.
1463
1464 @findex gnus-group-universal-argument
1465 If you want to execute some command on all groups that have been marked
1466 with the process mark, you can use the @kbd{M-&}
1467 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1468 the command to be executed.
1469
1470
1471 @node Foreign Groups
1472 @section Foreign Groups
1473
1474 Here are some group mode commands for making and editing general foreign
1475 groups, as well as commands to ease the creation of a few
1476 special-purpose groups:
1477
1478 @table @kbd
1479
1480 @item G m
1481 @kindex G m (Group)
1482 @findex gnus-group-make-group
1483 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1484 for a name, a method and possibly an @dfn{address}.  For an easier way
1485 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1486
1487 @item G r
1488 @kindex G r (Group)
1489 @findex gnus-group-rename-group
1490 Rename the current group to something else
1491 (@code{gnus-group-rename-group}).  This is legal only on some groups --
1492 mail groups mostly.  This command might very well be quite slow on some
1493 backends. 
1494
1495 @item G e
1496 @kindex G e (Group)
1497 @findex gnus-group-edit-group-method
1498 Enter a buffer where you can edit the select method of the current
1499 group (@code{gnus-group-edit-group-method}).
1500
1501 @item G p
1502 @kindex G p (Group)
1503 @findex gnus-group-edit-group-parameters
1504 Enter a buffer where you can edit the group parameters
1505 (@code{gnus-group-edit-group-parameters}). 
1506
1507 @item G E
1508 @kindex G E (Group)
1509 @findex gnus-group-edit-group
1510 Enter a buffer where you can edit the group info
1511 (@code{gnus-group-edit-group}).
1512
1513 @item G d
1514 @kindex G d (Group)
1515 @findex gnus-group-make-directory-group
1516 Make a directory group.  You will be prompted for a directory name
1517 (@code{gnus-group-make-directory-group}).  
1518
1519 @item G h 
1520 @kindex G h (Group)
1521 @findex gnus-group-make-help-group
1522 Make the Gnus help group (@code{gnus-group-make-help-group}).
1523
1524 @item G a
1525 @kindex G a (Group)
1526 @findex gnus-group-make-archive-group
1527 @vindex gnus-group-archive-directory
1528 @vindex gnus-group-recent-archive-directory
1529 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1530 default a group pointing to the most recent articles will be created
1531 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1532 group will be created from from @code{gnus-group-archive-directory}.
1533
1534 @item G k
1535 @kindex G k (Group)
1536 @findex gnus-group-make-kiboze-group
1537 Make a kiboze group.  You will be prompted for a name, for a regexp to
1538 match groups to be ``included'' in the kiboze group, and a series of
1539 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1540
1541 @item G D
1542 @kindex G D (Group)
1543 @findex gnus-group-enter-directory
1544 Read an arbitrary directory as if with were a newsgroup with the
1545 @code{nneething} backend (@code{gnus-group-enter-directory}).
1546
1547 @item G f
1548 @kindex G f (Group)
1549 @findex gnus-group-make-doc-group
1550 @cindex ClariNet Briefs
1551 Make a group based on some file or other
1552 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1553 command, you will be prompted for a file name and a file type.
1554 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1555 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs}, and
1556 @code{forward}.  If you run this command without a prefix, Gnus will
1557 guess at the file type.
1558
1559 @item G DEL
1560 @kindex G DEL (Group)
1561 @findex gnus-group-delete-group
1562 This function will delete the current group
1563 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1564 actually delete all the articles in the group, and forcibly remove the
1565 group itself from the face of the Earth.  Use a prefix only if you are
1566 absolutely sure of what you are doing.
1567
1568 @item G V
1569 @kindex G V (Group)
1570 @findex gnus-group-make-empty-virtual
1571 Make a new, fresh, empty @code{nnvirtual} group
1572 (@code{gnus-group-make-empty-virtual}).
1573
1574 @item G v
1575 @kindex G v (Group)
1576 @findex gnus-group-add-to-virtual
1577 Add the current group to an @code{nnvirtual} group
1578 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1579 @end table
1580
1581 @xref{Select Methods} for more information on the various select
1582 methods. 
1583
1584 @vindex gnus-activate-foreign-newsgroups
1585 If the @code{gnus-activate-foreign-newsgroups} is a positive number,
1586 Gnus will check all foreign groups with this level or lower at startup.
1587 This might take quite a while, especially if you subscribe to lots of
1588 groups from different @sc{nntp} servers.
1589
1590
1591 @node Group Parameters
1592 @section Group Parameters
1593 @cindex group parameters
1594
1595 Gnus stores all information on a group in a list that is usually known
1596 as the @dfn{group info}.  This list has from three to six elements.
1597 Here's an example info.
1598
1599 @lisp
1600 ("nnml:mail.ding" 3 ((1 . 232) 244 (256 . 270)) ((tick 246 249))
1601                   (nnml "private") ((to-address . "ding@@ifi.uio.no")))
1602 @end lisp
1603
1604 The first element is the @dfn{group name}, as Gnus knows the group,
1605 anyway.  The second element is the @dfn{subscription level}, which
1606 normally is a small integer.  The third element is a list of ranges of
1607 read articles.  The fourth element is a list of lists of article marks
1608 of various kinds.  The fifth element is the select method (or virtual
1609 server, if you like).  The sixth element is a list of @dfn{group
1610 parameters}, which is what this section is about.
1611
1612 Any of the last three elements may be missing if they are not required.
1613 In fact, the vast majority of groups will normally only have the first
1614 three elements, which saves quite a lot of cons cells.
1615
1616 The group parameters store information local to a particular group:
1617
1618 @table @code
1619 @item to-address
1620 @cindex to-address
1621 If the group parameter list contains an element that looks like
1622 @code{(to-address .  "some@@where.com")}, that address will be used by
1623 the backend when doing followups and posts.  This is primarily useful in
1624 mail groups that represent closed mailing lists---mailing lists where
1625 it's expected that everybody that writes to the mailing list is
1626 subscribed to it.  Since using this parameter ensures that the mail only
1627 goes to the mailing list itself, it means that members won't receive two
1628 copies of your followups.
1629
1630 Using @code{to-address} will actually work whether the group is foreign
1631 or not.  Let's say there's a group on the server that is called
1632 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1633 the articles from a mail-to-news gateway.  Posting directly to this
1634 group is therefore impossible---you have to send mail to the mailing
1635 list address instead. 
1636
1637 @item to-list
1638 @cindex to-list
1639 If the group parameter list has an element that looks like
1640 @code{(to-list . "some@@where.com")}, that address will be used when
1641 doing a @kbd{a} in any group.  It is totally ignored when doing a
1642 followup---except that if it is present in a news group, you'll get mail
1643 group semantics when doing @kbd{f}.
1644
1645 @item broken-reply-to
1646 @cindex broken-reply-to
1647 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1648 headers in this group are to be ignored.  This can be useful if you're
1649 reading a mailing list group where the listserv has inserted
1650 @code{Reply-To} headers that point back to the listserv itself.  This is
1651 broken behavior.  So there!
1652
1653 @item to-group
1654 @cindex to-group
1655 If the group parameter list contains an element like @code{(to-group
1656 . "some.group.name")}, all posts will be sent to that group.
1657
1658 @item auto-expire
1659 @cindex auto-expire
1660 If this symbol is present in the group parameter list, all articles that
1661 are read will be marked as expirable.  For an alternative approach,
1662 @pxref{Expiring Mail}.
1663
1664 @item total-expire
1665 @cindex total-expire
1666 If this symbol is present, all read articles will be put through the
1667 expiry process, even if they are not marked as expirable.  Use with
1668 caution. 
1669
1670 @item expiry-wait
1671 @cindex expiry-wait
1672 @vindex nnmail-expiry-wait-function
1673 If the group parameter has an element that looks like @code{(expiry-wait
1674 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1675 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1676 The value can either be a number of days (not necessarily an integer) or
1677 the symbols @code{never} or @code{immediate}.
1678
1679 @item score-file
1680 Elements that look like @code{(score-file . "file")} will make
1681 @samp{file} into the current score file for the group in question.  This
1682 means that all score commands you issue will end up in that file. 
1683
1684 @item admin-address
1685 When unsubscribing to a mailing list you should never send the
1686 unsubscription notice to the mailing list itself.  Instead, you'd send
1687 messages to the administrative address.  This parameter allows you to
1688 put the admin address somewhere convenient.
1689
1690 @item comment
1691 This parameter allows you to enter a arbitrary comment on the group.
1692
1693 @item @var{(variable form)}
1694 You can use the group parameters to set variables local to the group you
1695 are entering.  Say you want to turn threading off in
1696 @samp{news.answers}.  You'd then put @code{(gnus-show-threads nil)} in
1697 the group parameters of that group.  @code{gnus-show-threads} will be
1698 made into a local variable in the summary buffer you enter, and the form
1699 @code{nil} will be @code{eval}ed there.  
1700
1701 This can also be used as a group-specific hook function, if you'd like.
1702 If you want to hear a beep when you enter the group
1703 @samp{alt.binaries.pictures.furniture}, you could put something like
1704 @code{(dummy-variable (ding))} in the parameters of that group.
1705 @code{dummy-variable} will be set to the result of the @code{(ding)}
1706 form, but who cares?
1707
1708 @end table
1709
1710 If you want to change the group info you can use the @kbd{G E} command
1711 to enter a buffer where you can edit it.
1712
1713 You usually don't want to edit the entire group info, so you'd be better
1714 off using the @kbd{G p} command to just edit the group parameters.
1715
1716
1717 @node Listing Groups
1718 @section Listing Groups
1719 @cindex group listing
1720
1721 These commands all list various slices of the groups that are available.
1722
1723 @table @kbd
1724
1725 @item l
1726 @itemx A s
1727 @kindex A s (Group)
1728 @kindex l (Group)
1729 @findex gnus-group-list-groups
1730 List all groups that have unread articles
1731 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
1732 command will list only groups of level ARG and lower.  By default, it
1733 only lists groups of level five or lower (i.e., just subscribed groups).
1734
1735 @item L
1736 @itemx A u
1737 @kindex A u (Group)
1738 @kindex L (Group)
1739 @findex gnus-group-list-all-groups
1740 List all groups, whether they have unread articles or not
1741 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
1742 this command will list only groups of level ARG and lower.  By default,
1743 it lists groups of level seven or lower (i.e., just subscribed and
1744 unsubscribed groups).
1745
1746 @item A l
1747 @kindex A l (Group)
1748 @findex gnus-group-list-level
1749 List all unread groups on a specific level
1750 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
1751 with no unread articles.
1752
1753 @item A k
1754 @kindex A k (Group)
1755 @findex gnus-group-list-killed
1756 List all killed groups (@code{gnus-group-list-killed}).  If given a
1757 prefix argument, really list all groups that are available, but aren't
1758 currently (un)subscribed.  This could entail reading the active file
1759 from the server.
1760
1761 @item A z
1762 @kindex A z (Group)
1763 @findex gnus-group-list-zombies
1764 List all zombie groups (@code{gnus-group-list-zombies}).
1765
1766 @item A m
1767 @kindex A m (Group)
1768 @findex gnus-group-list-matching
1769 List all subscribed groups with unread articles that match a regexp
1770 (@code{gnus-group-list-matching}). 
1771
1772 @item A M
1773 @kindex A M (Group)
1774 @findex gnus-group-list-all-matching
1775 List groups that match a regexp (@code{gnus-group-list-all-matching}).
1776
1777 @item A A
1778 @kindex A A (Group)
1779 @findex gnus-group-list-active
1780 List absolutely all groups that are in the active file(s) of the
1781 server(s) you are connected to (@code{gnus-group-list-active}).  This
1782 might very well take quite a while.  It might actually be a better idea
1783 to do a @kbd{A m} to list all matching, and just give @samp{.} as the
1784 thing to match on.
1785
1786 @item A a
1787 @kindex A a (Group)
1788 @findex gnus-group-apropos
1789 List all groups that have names that match a regexp
1790 (@code{gnus-group-apropos}).
1791
1792 @item A d
1793 @kindex A d (Group)
1794 @findex gnus-group-description-apropos
1795 List all groups that have names or descriptions that match a regexp
1796 (@code{gnus-group-description-apropos}).
1797
1798 @end table
1799
1800 @vindex gnus-permanently-visible-groups
1801 @cindex visible group parameter
1802 Groups that match the @code{gnus-permanently-visible-groups} regexp will
1803 always be shown, whether they have unread articles or not.  You can also
1804 add the @code{visible} element to the group parameters in question to
1805 get the same effect.
1806
1807 @vindex gnus-list-groups-with-ticked-articles
1808 Groups that have just ticked articles in it are normally listed in the
1809 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
1810 @code{nil}, these groups will be treated just like totally empty
1811 groups.  It is @code{t} by default.
1812
1813
1814 @node Sorting Groups
1815 @section Sorting Groups
1816 @cindex sorting groups
1817
1818 @kindex C-c C-s (Group)
1819 @findex gnus-group-sort-groups
1820 @vindex gnus-group-sort-function
1821 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
1822 group buffer according to the function(s) given by the
1823 @code{gnus-group-sort-function} variable.  Available sorting functions
1824 include: 
1825
1826 @table @code
1827
1828 @item gnus-group-sort-by-alphabet
1829 @findex gnus-group-sort-by-alphabet
1830 Sort the group names alphabetically.  This is the default.
1831
1832 @item gnus-group-sort-by-level
1833 @findex gnus-group-sort-by-level
1834 Sort by group level.
1835
1836 @item gnus-group-sort-by-score
1837 @findex gnus-group-sort-by-score
1838 Sort by group score.
1839
1840 @item gnus-group-sort-by-rank
1841 @findex gnus-group-sort-by-rank
1842 Sort by group score and then the group level.  The level and the score
1843 are, when taken together, the group's @dfn{rank}. 
1844
1845 @item gnus-group-sort-by-unread
1846 @findex gnus-group-sort-by-unread
1847 Sort by number of unread articles.
1848
1849 @item gnus-group-sort-by-method
1850 @findex gnus-group-sort-by-method
1851 Sort by alphabetically on the select method.
1852
1853
1854 @end table
1855
1856 @code{gnus-group-sort-function} can also be a list of sorting
1857 functions.  In that case, the most significant sort key function must be
1858 the last one.
1859
1860
1861 There are also a number of commands for sorting directly according to
1862 some sorting criteria:
1863
1864 @table @kbd
1865 @item G S a
1866 @kindex G S a (Group)
1867 @findex gnus-group-sort-groups-by-alphabet
1868 Sort the group buffer alphabetically by group name
1869 (@code{gnus-group-sort-groups-by-alphabet}). 
1870
1871 @item G S u
1872 @kindex G S u (Group)
1873 @findex gnus-group-sort-groups-by-unread
1874 Sort the group buffer by the number of unread articles
1875 (@code{gnus-group-sort-groups-by-unread}).
1876
1877 @item G S l
1878 @kindex G S l (Group)
1879 @findex gnus-group-sort-groups-by-level
1880 Sort the group buffer by group level
1881 (@code{gnus-group-sort-groups-by-level}). 
1882
1883 @item G S v
1884 @kindex G S v (Group)
1885 @findex gnus-group-sort-groups-by-score
1886 Sort the group buffer by group score
1887 (@code{gnus-group-sort-groups-by-score}). 
1888
1889 @item G S r
1890 @kindex G S r (Group)
1891 @findex gnus-group-sort-groups-by-rank
1892 Sort the group buffer by group level
1893 (@code{gnus-group-sort-groups-by-rank}). 
1894
1895 @item G S m
1896 @kindex G S m (Group)
1897 @findex gnus-group-sort-groups-by-method
1898 Sort the group buffer alphabetically by backend name
1899 (@code{gnus-group-sort-groups-by-method}). 
1900
1901 @end table
1902
1903 When given a prefix, all these commands will sort in reverse order. 
1904
1905
1906 @node Group Maintenance
1907 @section Group Maintenance
1908 @cindex bogus groups
1909
1910 @table @kbd
1911 @item b
1912 @kindex b (Group)
1913 @findex gnus-group-check-bogus-groups
1914 Find bogus groups and delete them
1915 (@code{gnus-group-check-bogus-groups}).
1916
1917 @item F
1918 @kindex F (Group)
1919 @findex gnus-find-new-newsgroups
1920 Find new groups and process them (@code{gnus-find-new-newsgroups}).  If
1921 given a prefix, use the @code{ask-server} method to query the server for
1922 new groups.
1923
1924 @item C-c C-x
1925 @kindex C-c C-x (Group)
1926 @findex gnus-group-expire-articles
1927 Run all expirable articles in the current group through the expiry
1928 process (if any) (@code{gnus-group-expire-articles}).
1929
1930 @item C-c M-C-x
1931 @kindex C-c M-C-x (Group)
1932 @findex gnus-group-expire-all-groups
1933 Run all articles in all groups through the expiry process
1934 (@code{gnus-group-expire-all-groups}).
1935
1936 @end table
1937
1938
1939 @node Browse Foreign Server
1940 @section Browse Foreign Server
1941 @cindex foreign servers
1942 @cindex browsing servers
1943
1944 @table @kbd
1945 @item B
1946 @kindex B (Group)
1947 @findex gnus-group-browse-foreign-server
1948 You will be queried for a select method and a server name.  Gnus will
1949 then attempt to contact this server and let you browse the groups there
1950 (@code{gnus-group-browse-foreign-server}).
1951 @end table
1952
1953 @findex gnus-browse-mode
1954 A new buffer with a list of available groups will appear.  This buffer
1955 will be use the @code{gnus-browse-mode}.  This buffer looks a bit
1956 (well, a lot) like a normal group buffer, but with one major difference
1957 - you can't enter any of the groups.  If you want to read any of the
1958 news available on that server, you have to subscribe to the groups you
1959 think may be interesting, and then you have to exit this buffer.  The
1960 new groups will be added to the group buffer, and then you can read them
1961 as you would any other group.
1962
1963 Future versions of Gnus may possibly permit reading groups straight from
1964 the browse buffer.
1965
1966 Here's a list of keystrokes available in the browse mode:
1967
1968 @table @kbd
1969 @item n
1970 @kindex n (Browse)
1971 @findex gnus-group-next-group
1972 Go to the next group (@code{gnus-group-next-group}).
1973
1974 @item p
1975 @kindex p (Browse)
1976 @findex gnus-group-prev-group
1977 Go to the previous group (@code{gnus-group-prev-group}).
1978
1979 @item SPACE
1980 @kindex SPACE (Browse)
1981 @findex gnus-browse-read-group
1982 Enter the current group and display the first article
1983 (@code{gnus-browse-read-group}). 
1984
1985 @item RET
1986 @kindex RET (Browse)
1987 @findex gnus-browse-select-group
1988 Enter the current group (@code{gnus-browse-select-group}). 
1989
1990 @item u
1991 @kindex u (Browse)
1992 @findex gnus-browse-unsubscribe-current-group
1993 Unsubscribe to the current group, or, as will be the case here,
1994 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
1995
1996 @item l
1997 @itemx q
1998 @kindex q (Browse)
1999 @kindex l (Browse)
2000 @findex gnus-browse-exit
2001 Exit browse mode (@code{gnus-browse-exit}).
2002
2003 @item ?
2004 @kindex ? (Browse)
2005 @findex gnus-browse-describe-briefly
2006 Describe browse mode briefly (well, there's not much to describe, is
2007 there) (@code{gnus-browse-describe-briefly}).
2008 @end table
2009
2010
2011 @node Exiting Gnus
2012 @section Exiting Gnus
2013 @cindex exiting Gnus
2014
2015 Yes, Gnus is ex(c)iting.
2016
2017 @table @kbd
2018 @item z
2019 @kindex z (Group)
2020 @findex gnus-group-suspend
2021 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2022 but it kills all buffers except the Group buffer.  I'm not sure why this
2023 is a gain, but then who am I to judge?
2024
2025 @item q
2026 @kindex q (Group)
2027 @findex gnus-group-exit
2028 Quit Gnus (@code{gnus-group-exit}).
2029
2030 @item Q
2031 @kindex Q (Group)
2032 @findex gnus-group-quit
2033 Quit Gnus without saving any startup files (@code{gnus-group-quit}).
2034 @end table
2035
2036 @vindex gnus-exit-gnus-hook
2037 @vindex gnus-suspend-gnus-hook
2038 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2039 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2040 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2041 exiting Gnus.
2042
2043 @findex gnus-unload
2044 @cindex unloading
2045 If you wish to completely unload Gnus and all its adherents, you can use
2046 the @code{gnus-unload} command.  This command is also very handy when
2047 trying to customize meta-variables.
2048
2049 Note:
2050
2051 @quotation
2052 Miss Lisa Cannifax, while sitting in English class, feels her feet go
2053 numbly heavy and herself fall into a hazy trance as the boy sitting
2054 behind her drew repeated lines with his pencil across the back of her
2055 plastic chair.
2056 @end quotation
2057
2058
2059 @node Group Topics
2060 @section Group Topics
2061 @cindex topics
2062
2063 If you read lots and lots of groups, it might be convenient to group
2064 them hierarchically according to topics.  You put your Emacs groups over
2065 here, your sex groups over there, and the rest (what, two groups or so?)
2066 you put in some misc section that you never bother with anyway.  You can
2067 even group the Emacs sex groups as a sub-topic to either the Emacs
2068 groups or the sex groups---or both!  Go wild!
2069
2070 @findex gnus-topic-mode
2071 @kindex t (Group)
2072 To get this @emph{fab} functionality you simply turn on (ooh!) the
2073 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2074 is a toggling command.)
2075
2076 Go ahead, just try it.  I'll still be here when you get back.  La de
2077 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2078 press @kbd{l}.  There.  All your groups are now listed under
2079 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2080 bothered?
2081
2082 If you want this permanently enabled, you should add that minor mode to
2083 the hook for the group mode:
2084
2085 @lisp
2086 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2087 @end lisp
2088
2089 @menu 
2090 * Topic Variables::    How to customize the topics the Lisp Way.
2091 * Topic Commands::     Interactive E-Z commands.
2092 * Topic Topology::     A map of the world.
2093 @end menu
2094
2095
2096 @node Topic Variables
2097 @subsection Topic Variables
2098 @cindex topic variables
2099
2100 Now, if you select a topic, if will fold/unfold that topic, which is
2101 really neat, I think.
2102
2103 @vindex gnus-topic-line-format
2104 The topic lines themselves are created according to the
2105 @code{gnus-topic-line-format} variable.  @xref{Formatting Variables}.
2106 Elements allowed are:
2107
2108 @table @samp
2109 @item i
2110 Indentation.
2111 @item n
2112 Topic name.
2113 @item v
2114 Visibility.
2115 @item l
2116 Level.
2117 @item g
2118 Number of groups in the topic.
2119 @item a
2120 Number of unread articles in the topic.
2121 @item A 
2122 Number of unread articles in the topic and all its subtopics. 
2123 @end table
2124
2125 @vindex gnus-topic-indent-level
2126 Each sub-topic (and the groups in the sub-topics) will be indented with
2127 @code{gnus-topic-indent-level} times the topic level number of spaces.
2128 The default is @code{2}.
2129
2130 @vindex gnus-topic-mode-hook
2131 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2132
2133
2134 @node Topic Commands
2135 @subsection Topic Commands
2136 @cindex topic commands
2137
2138 When the topic minor mode is turned on, a new @kbd{T} submap will be
2139 available.  In addition, a few of the standard keys change their
2140 definitions slightly.
2141
2142 @table @kbd
2143
2144 @item T n
2145 @kindex T n (Group)
2146 @findex gnus-topic-create-topic
2147 Prompt for a new topic name and create it 
2148 (@code{gnus-topic-create-topic}). 
2149
2150 @item T m
2151 @kindex T m (Group)
2152 @findex gnus-topic-move-group
2153 Move the current group to some other topic
2154 (@code{gnus-topic-move-group}).  This command understands the
2155 process/prefix convention (@pxref{Process/Prefix}).
2156
2157 @item T c
2158 @kindex T c (Group)
2159 @findex gnus-topic-copy-group
2160 Copy the current group to some other topic
2161 (@code{gnus-topic-copy-group}).  This command understands the
2162 process/prefix convention (@pxref{Process/Prefix}).
2163
2164 @item T D
2165 @kindex T D (Group)
2166 @findex gnus-topic-remove-group
2167 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2168 This command understands the process/prefix convention
2169 (@pxref{Process/Prefix}).
2170
2171 @item T M
2172 @kindex T M (Group)
2173 @findex gnus-topic-move-matching
2174 Move all groups that match some regular expression to a topic
2175 (@code{gnus-topic-move-matching}). 
2176
2177 @item T C
2178 @kindex T C (Group)
2179 @findex gnus-topic-copy-matching
2180 Copy all groups that match some regular expression to a topic
2181 (@code{gnus-topic-copy-matching}). 
2182
2183 @item T #
2184 @kindex T # (Group)
2185 @findex gnus-topic-mark-topic
2186 Mark all groups in the current topic with the process mark
2187 (@code{gnus-topic-mark-topic}). 
2188
2189 @item T M-#
2190 @kindex T M-# (Group)
2191 @findex gnus-topic-unmark-topic
2192 Remove the process mark from all groups in the current topic
2193 (@code{gnus-topic-unmark-topic}). 
2194
2195 @item RET
2196 @kindex RET (Group)
2197 @findex gnus-topic-select-group
2198 @itemx SPACE
2199 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2200 When you perform this command on a group, you'll enter the group, as
2201 usual.  When done on a topic line, the topic will be folded (if it was
2202 visible) or unfolded (if it was folded already).  So it's basically a
2203 toggling command on topics.  In addition, if you give a numerical
2204 prefix, group on that level (and lower) will be displayed.
2205
2206 @item T TAB
2207 @kindex T TAB (Group)
2208 @findex gnus-topic-indent
2209 ``Indent'' the current topic so that it becomes a sub-topic of the
2210 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2211 ``un-indent'' the topic instead.
2212
2213 @item C-k
2214 @kindex C-k (Group)
2215 @findex gnus-topic-kill-group
2216 Kill a group or topic (@code{gnus-topic-kill-group}).  
2217
2218 @item C-y
2219 @kindex C-y (Group)
2220 @findex gnus-topic-yank-group
2221 Yank the previously killed group or topic (@code{gnus-topic-yank-group}).
2222 Note that all topics will be yanked before all groups.
2223
2224 @item T r
2225 @kindex T r (Group)
2226 @findex gnus-topic-rename
2227 Rename a topic (@code{gnus-topic-rename}). 
2228
2229 @item T DEL
2230 @kindex T DEL (Group)
2231 @findex gnus-topic-delete
2232 Delete an empty topic (@code{gnus-topic-delete}). 
2233
2234 @item A T
2235 @kindex A T (Group)
2236 @findex gnus-topic-list-active
2237 List all groups that Gnus knows about in a topics-ified way
2238 (@code{gnus-topic-list-active}).
2239
2240 @end table
2241
2242
2243 @node Topic Topology
2244 @subsection Topic Topology
2245 @cindex topic topology
2246 @cindex topology
2247
2248 So, let's have a look at an example group buffer:
2249
2250 @example
2251 Gnus
2252   Emacs -- I wuw it!
2253        3: comp.emacs
2254        2: alt.religion.emacs
2255     Naughty Emacs
2256      452: alt.sex.emacs
2257        0: comp.talk.emacs.recovery
2258   Misc
2259        8: comp.binaries.fractals
2260       13: comp.sources.unix
2261 @end example
2262
2263 So, here we have one top-level topic, two topics under that, and one
2264 sub-topic under one of the sub-topics.  (There is always just one (1)
2265 top-level topic).  This topology can be expressed as follows:
2266
2267 @lisp
2268 (("Gnus" visible)
2269  (("Emacs -- I wuw it!" visible) 
2270   (("Naughty Emacs" visible)))
2271  (("Misc" visible)))
2272 @end lisp
2273
2274 @vindex gnus-topic-topology
2275 This is in fact how the variable @code{gnus-topic-topology} would look
2276 for the display above.  That variable is saved in the @file{.newsrc.eld}
2277 file, and shouldn't be messed with manually---unless you really want
2278 to.  Since this variable is read from the @file{.newsrc.eld} file,
2279 setting it in any other startup files will have no effect.  
2280
2281 This topology shows what topics are sub-topics of what topics (right),
2282 and which topics are visible.  Two settings are currently
2283 allowed---@code{visible} and @code{invisible}.
2284
2285
2286 @node Misc Group Stuff
2287 @section Misc Group Stuff
2288
2289 @menu
2290 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2291 * Group Information::     Information and help on groups and Gnus.
2292 * File Commands::         Reading and writing the Gnus files.
2293 @end menu
2294
2295 @table @kbd
2296
2297 @item ^
2298 @kindex ^ (Group)
2299 @findex gnus-group-enter-server-mode
2300 Enter the server buffer (@code{gnus-group-enter-server-mode}). @xref{The
2301 Server Buffer}.
2302
2303 @item a
2304 @kindex a (Group)
2305 @findex gnus-group-post-news
2306 Post an article to a group (@code{gnus-group-post-news}).  The current
2307 group name will be used as the default.
2308
2309 @item m
2310 @kindex m (Group)
2311 @findex gnus-group-mail
2312 Mail a message somewhere (@code{gnus-group-mail}).
2313
2314 @end table
2315
2316 Variables for the group buffer:
2317
2318 @table @code
2319
2320 @item gnus-group-mode-hook
2321 @vindex gnus-group-mode-hook
2322 @code{gnus-group-mode-hook} is called after the group buffer has been
2323 created. 
2324
2325 @item gnus-group-prepare-hook
2326 @vindex gnus-group-prepare-hook
2327 @code{gnus-group-prepare-hook} is called after the group buffer is
2328 generated.  It may be used to modify the buffer in some strange,
2329 unnatural way.
2330
2331 @item gnus-permanently-visible-groups
2332 @vindex gnus-permanently-visible-groups
2333 Groups matching this regexp will always be listed in the group buffer,
2334 whether they are empty or not.
2335
2336 @end table
2337
2338
2339 @node Scanning New Messages
2340 @subsection Scanning New Messages
2341 @cindex new messages
2342 @cindex scanning new news
2343
2344 @table @kbd
2345
2346 @item g
2347 @kindex g (Group)
2348 @findex gnus-group-get-new-news
2349 Check the server(s) for new articles.  If the numerical prefix is used,
2350 this command will check only groups of level @var{arg} and lower
2351 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2352 command will force a total rereading of the active file(s) from the
2353 backend(s).
2354
2355 @item M-g
2356 @kindex M-g (Group)
2357 @findex gnus-group-get-new-news-this-group
2358 @vindex gnus-goto-next-group-when-activating
2359 Check whether new articles have arrived in the current group
2360 (@code{gnus-group-get-new-news-this-group}).  The
2361 @code{gnus-goto-next-group-when-activating} variable controls whether
2362 this command is to move point to the next group or not.  It is @code{t}
2363 by default.
2364
2365 @findex gnus-activate-all-groups
2366 @cindex activating groups
2367 @item C-c M-g
2368 @kindex C-c M-g (Group)
2369 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2370
2371 @item R
2372 @kindex R (Group)
2373 @cindex restarting
2374 @findex gnus-group-restart
2375 Restart Gnus (@code{gnus-group-restart}).
2376
2377 @end table
2378
2379 @vindex gnus-get-new-news-hook
2380 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2381
2382 @vindex gnus-after-getting-new-news-hook
2383 @code{gnus-after-getting-new-news-hook} is run after checking for new
2384 news.
2385
2386
2387 @node Group Information
2388 @subsection Group Information
2389 @cindex group information
2390 @cindex information on groups
2391
2392 @table @kbd
2393
2394 @item M-f
2395 @kindex M-f (Group)
2396 @findex gnus-group-fetch-faq
2397 @cindex FAQ
2398 @cindex ange-ftp
2399 Try to fetch the FAQ for the current group
2400 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2401 @code{gnus-group-faq-directory}, which is usually a directory on a
2402 remote machine.  @code{ange-ftp} will be used for fetching the file.
2403
2404 @item D
2405 @kindex D (Group)
2406 @cindex describing groups
2407 @cindex group description
2408 @findex gnus-group-describe-group
2409 Describe the current group (@code{gnus-group-describe-group}).  If given
2410 a prefix, force Gnus to re-read the description from the server.
2411
2412 @item M-d
2413 @kindex M-d (Group)
2414 @findex gnus-group-describe-all-groups
2415 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2416 prefix, force Gnus to re-read the description file from the server.
2417
2418 @item V
2419 @kindex V (Group)
2420 @cindex version
2421 @findex gnus-version
2422 Display current Gnus version numbers (@code{gnus-version}).
2423
2424 @item ?
2425 @kindex ? (Group)
2426 @findex gnus-group-describe-briefly
2427 Give a very short help message (@code{gnus-group-describe-briefly}).
2428
2429 @item C-c C-i
2430 @kindex C-c C-i (Group)
2431 @cindex info
2432 @cindex manual
2433 @findex gnus-info-find-node
2434 Go to the Gnus info node (@code{gnus-info-find-node}).
2435 @end table
2436
2437
2438 @node File Commands
2439 @subsection File Commands
2440 @cindex file commands
2441
2442 @table @kbd
2443
2444 @item r
2445 @kindex r (Group)
2446 @findex gnus-group-read-init-file
2447 @vindex gnus-init-file
2448 @cindex reading init file
2449 Read the init file (@code{gnus-init-file}, which defaults to
2450 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2451
2452 @item s
2453 @kindex s (Group)
2454 @findex gnus-group-save-newsrc
2455 @cindex saving .newsrc
2456 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2457 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
2458 file(s) whether Gnus thinks it is necessary or not.
2459
2460 @item Z
2461 @kindex Z (Group)
2462 @findex gnus-group-clear-dribble
2463 Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2464
2465 @end table
2466
2467
2468 @node The Summary Buffer
2469 @chapter The Summary Buffer
2470 @cindex summary buffer
2471
2472 A line for each article is displayed in the summary buffer.  You can
2473 move around, read articles, post articles and reply to articles.
2474
2475 @menu
2476 * Summary Buffer Format::       Deciding how the summary buffer is to look.
2477 * Summary Maneuvering::         Moving around the summary buffer.
2478 * Choosing Articles::           Reading articles.
2479 * Paging the Article::          Scrolling the current article.
2480 * Reply Followup and Post::     Posting articles.
2481 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
2482 * Marking Articles::            Marking articles as read, expirable, etc.
2483 * Limiting::                    You can limit the summary buffer.
2484 * Threading::                   How threads are made.
2485 * Sorting::                     How articles and threads are sorted.
2486 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
2487 * Article Caching::             You may store articles in a cache.
2488 * Persistent Articles::         Making articles expiry-resistant.
2489 * Article Backlog::             Having already read articles hang around.
2490 * Saving Articles::             Ways of customizing article saving.
2491 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
2492 * Article Treatment::           The article buffer can be mangled at will.
2493 * Summary Sorting::             Sorting the summary buffer in various ways.
2494 * Finding the Parent::          No child support? Get the parent.
2495 * Alternative Approaches::      Reading using non-default summaries.
2496 * Tree Display::                A more visual display of threads.
2497 * Mail Group Commands::         Some commands can only be used in mail groups.
2498 * Various Summary Stuff::       What didn't fit anywhere else.
2499 * Exiting the Summary Buffer::  Returning to the Group buffer.
2500 @end menu
2501
2502
2503 @node Summary Buffer Format
2504 @section Summary Buffer Format
2505 @cindex summary buffer format
2506
2507 @menu
2508 * Summary Buffer Lines::     You can specify how summary lines should look.
2509 * Summary Buffer Mode Line:: You can say how the mode line should look.
2510 * Summary Highlighting::     Making the summary buffer all pretty and nice.
2511 @end menu
2512
2513 @findex mail-extract-address-components
2514 @findex gnus-extract-address-components
2515 @vindex gnus-extract-address-components
2516 Gnus will use the value of the @code{gnus-extract-address-components}
2517 variable as a function for getting the name and address parts of a
2518 @code{From} header.  Two pre-defined function exist:
2519 @code{gnus-extract-address-components}, which is the default, quite
2520 fast, and too simplistic solution; and
2521 @code{mail-extract-address-components}, which works very nicely, but is
2522 slower.  The default function will return the wrong answer in 5% of the
2523 cases.  If this is unacceptable to you, use the other function instead.
2524
2525 @vindex gnus-summary-same-subject
2526 @code{gnus-summary-same-subject} is a string indicating that the current
2527 article has the same subject as the previous.  This string will be used
2528 with those specs that require it.  The default is @samp{}.
2529
2530
2531 @node Summary Buffer Lines
2532 @subsection Summary Buffer Lines
2533
2534 @vindex gnus-summary-line-format
2535 You can change the format of the lines in the summary buffer by changing
2536 the @code{gnus-summary-line-format} variable.  It works along the same
2537 lines a a normal @code{format} string, with some extensions.
2538
2539 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
2540
2541 The following format specification characters are understood:
2542
2543 @table @samp
2544 @item N 
2545 Article number.
2546 @item S
2547 Subject string.
2548 @item s
2549 Subject if the article is the root, @code{gnus-summary-same-subject}
2550 otherwise. 
2551 @item F
2552 Full @code{From} line.
2553 @item n
2554 The name (from the @code{From} header).
2555 @item a
2556 The name (from the @code{From} header).  This differs from the @code{n}
2557 spec in that it uses @code{gnus-extract-address-components}, which is
2558 slower, but may be more thorough.
2559 @item A
2560 The address (from the @code{From} header).  This works the same way as
2561 the @code{a} spec.
2562 @item L
2563 Number of lines in the article.
2564 @item c
2565 Number of characters in the article.
2566 @item I
2567 Indentation based on thread level (@pxref{Customizing Threading}).
2568 @item T
2569 Nothing if the article is a root and lots of spaces if it isn't (it
2570 pushes everything after it off the screen).
2571 @item \[
2572 Opening bracket, which is normally @samp{\[}, but can also be @samp{<}
2573 for adopted articles.
2574 @item \]
2575 Closing bracket, which is normally @samp{\]}, but can also be @samp{>}
2576 for adopted articles.
2577 @item >
2578 One space for each thread level.
2579 @item <
2580 Twenty minus thread level spaces.
2581 @item U
2582 Unread.
2583 @item R
2584 Replied.
2585 @item i
2586 Score as a number.
2587 @item z
2588 @vindex gnus-summary-zcore-fuzz
2589 Zcore, @samp{+} if above the default level and @samp{-} if below the
2590 default level.  If the difference between
2591 @code{gnus-summary-default-level} and the score is less than
2592 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
2593 @item V
2594 Total thread score.
2595 @item x
2596 @code{Xref}.
2597 @item D
2598 @code{Date}.
2599 @item M
2600 @code{Message-ID}.
2601 @item r
2602 @code{References}.
2603 @item t
2604 Number of articles in the current sub-thread.  Using this spec will slow
2605 down summary buffer generation somewhat.
2606 @item e
2607 A single character will be displayed if the article has any children. 
2608 @item u
2609 User defined specifier.  The next character in the format string should
2610 be a letter.  @sc{gnus} will call the function
2611 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
2612 following @samp{%u}.  The function will be passed the current header as
2613 argument.  The function should return a string, which will be inserted
2614 into the summary just like information from any other summary specifier.
2615 @end table
2616
2617 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
2618 have to be handled with care.  For reasons of efficiency, Gnus will
2619 compute what column these characters will end up in, and ``hard-code''
2620 that.  This means that it is illegal to have these specs after a
2621 variable-length spec.  Well, you might not be arrested, but your summary
2622 buffer will look strange, which is bad enough.
2623
2624 The smart choice is to have these specs as far to the left as possible.
2625 (Isn't that the case with everything, though?  But I digress.)
2626
2627 This restriction may disappear in later versions of Gnus.
2628
2629
2630 @node Summary Buffer Mode Line
2631 @subsection Summary Buffer Mode Line
2632
2633 @vindex gnus-summary-mode-line-format
2634 You can also change the format of the summary mode bar.  Set
2635 @code{gnus-summary-mode-line-format} to whatever you like.  Here are the
2636 elements you can play with:
2637
2638 @table @samp
2639 @item G
2640 Group name.
2641 @item p
2642 Unprefixed group name.
2643 @item A
2644 Current article number.
2645 @item V
2646 Gnus version.
2647 @item U
2648 Number of unread articles in this group.
2649 @item e
2650 Number of unselected articles in this group.
2651 @item Z
2652 A string with the number of unread and unselected articles represented
2653 either as @samp{<%U(+%u) more>} if there are both unread and unselected
2654 articles, and just as @samp{<%U more>} if there are just unread articles
2655 and no unselected ones.
2656 @item g
2657 Shortish group name.  For instance, @samp{rec.arts.anime} will be
2658 shortened to @samp{r.a.anime}. 
2659 @item S
2660 Subject of the current article.
2661 @item u
2662 Used-defined spec.
2663 @item s
2664 Name of the current score file.
2665 @item d
2666 Number of dormant articles.
2667 @item t
2668 Number of ticked articles.
2669 @item r
2670 Number of articles that have been marked as read in this session. 
2671 @item E
2672 Number of articles expunged by the score files.
2673 @end table
2674
2675
2676 @node Summary Highlighting
2677 @subsection Summary Highlighting
2678
2679 @table @code
2680
2681 @item gnus-visual-mark-article-hook
2682 @vindex gnus-visual-mark-article-hook
2683 This hook is run after selecting an article.  It is meant to be used for
2684 highlighting the article in some way.  It is not run if
2685 @code{gnus-visual} is @code{nil}.
2686
2687 @item gnus-summary-update-hook
2688 @vindex gnus-summary-update-hook
2689 This hook is called when a summary line is changed.  It is not run if
2690 @code{gnus-visual} is @code{nil}.
2691
2692 @item gnus-summary-selected-face
2693 @vindex gnus-summary-selected-face
2694 This is the face (or @dfn{font} as some people call it) that is used to
2695 highlight the current article in the summary buffer.
2696
2697 @item gnus-summary-highlight
2698 @vindex gnus-summary-highlight
2699 Summary lines are highlighted according to this variable, which is a
2700 list where the elements are on the format @code{(FORM . FACE)}.  If you
2701 would, for instance, like ticked articles to be italic and high-scored
2702 articles to be bold, you could set this variable to something like
2703 @lisp
2704 (((eq mark gnus-ticked-mark) . italic)
2705  ((> score default) . bold))
2706 @end lisp
2707 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
2708 @var{FACE} will be applied to the line.
2709 @end table
2710
2711
2712 @node Summary Maneuvering
2713 @section Summary Maneuvering
2714 @cindex summary movement
2715
2716 All the straight movement commands understand the numeric prefix and
2717 behave pretty much as you'd expect. 
2718
2719 None of these commands select articles.
2720
2721 @table @kbd
2722 @item G M-n
2723 @itemx M-n
2724 @kindex M-n (Summary)
2725 @kindex G M-n (Summary)
2726 @findex gnus-summary-next-unread-subject
2727 Go to the next summary line of an unread article
2728 (@code{gnus-summary-next-unread-subject}). 
2729
2730 @item G M-p
2731 @itemx M-p
2732 @kindex M-p (Summary)
2733 @kindex G M-p (Summary)
2734 @findex gnus-summary-prev-unread-subject
2735 Go to the previous summary line of an unread article
2736 (@code{gnus-summary-prev-unread-subject}). 
2737
2738 @item G j
2739 @itemx j
2740 @kindex j (Summary)
2741 @kindex G j (Summary)
2742 @findex gnus-summary-goto-article
2743 Ask for an article number and then go that article
2744 (@code{gnus-summary-goto-article}). 
2745
2746 @item G g
2747 @kindex G g (Summary)
2748 @findex gnus-summary-goto-subject
2749 Ask for an article number and then go the summary line of that article
2750 (@code{gnus-summary-goto-subject}).
2751 @end table
2752
2753 If Gnus asks you to press a key to confirm going to the next group, you
2754 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
2755 buffer, searching for the next group to read without actually returning
2756 to the group buffer.
2757
2758 Variables related to summary movement:
2759
2760 @table @code
2761
2762 @vindex gnus-auto-select-next
2763 @item gnus-auto-select-next
2764 If you are at the end of the group and issue one of the movement
2765 commands, Gnus will offer to go to the next group.  If this variable is
2766 @code{t} and the next group is empty, Gnus will exit summary mode and
2767 return to the group buffer.  If this variable is neither @code{t} nor
2768 @code{nil}, Gnus will select the next group, no matter whether it has
2769 any unread articles or not.  As a special case, if this variable is
2770 @code{quietly}, Gnus will select the next group without asking for
2771 confirmation.  If this variable is @code{almost-quietly}, the same will
2772 happen only if you are located on the last article in the group.
2773 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
2774 command will go to the next group without confirmation.  Also
2775 @pxref{Group Levels}.
2776
2777 @item gnus-auto-select-same
2778 @vindex gnus-auto-select-same
2779 If non-@code{nil}, all the movement commands will try to go to the next
2780 article with the same subject as the current.  This variable is not
2781 particularly useful if you use a threaded display.
2782
2783 @item gnus-summary-check-current
2784 @vindex gnus-summary-check-current
2785 If non-@code{nil}, all the ``unread'' movement commands will not proceed
2786 to the next (or previous) article if the current article is unread.
2787 Instead, they will choose the current article.
2788
2789 @item gnus-auto-center-summary
2790 @vindex gnus-auto-center-summary
2791 If non-@code{nil}, Gnus will keep the point in the summary buffer
2792 centered at all times.  This makes things quite tidy, but if you have a
2793 slow network connection, or simply do not like this un-Emacsism, you can
2794 set this variable to @code{nil} to get the normal Emacs scrolling
2795 action.  This will also inhibit horizontal re-centering of the summary
2796 buffer, which might make it more inconvenient to read extremely long
2797 threads.
2798
2799 @end table
2800
2801
2802 @node Choosing Articles
2803 @section Choosing Articles
2804 @cindex selecting articles
2805
2806 None of the following movement commands understand the numeric prefix,
2807 and they all select and display an article.
2808
2809 @table @kbd
2810 @item SPACE
2811 @kindex SPACE (Summary)
2812 @findex gnus-summary-next-page
2813 Select the current article, or, if that one's read already, the next
2814 unread article (@code{gnus-summary-next-page}).
2815
2816 @item G n
2817 @itemx n
2818 @kindex n (Summary)
2819 @kindex G n (Summary)
2820 @findex gnus-summary-next-unread-article
2821 Go to next unread article (@code{gnus-summary-next-unread-article}).
2822
2823 @item G p
2824 @itemx p
2825 @kindex p (Summary)
2826 @findex gnus-summary-prev-unread-article
2827 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
2828
2829 @item G N
2830 @itemx N
2831 @kindex N (Summary)
2832 @kindex G N (Summary)
2833 @findex gnus-summary-next-article
2834 Go to the next article (@code{gnus-summary-next-article}).
2835
2836 @item G P
2837 @itemx P
2838 @kindex P (Summary)
2839 @kindex G P (Summary)
2840 @findex gnus-summary-prev-article
2841 Go to the previous article (@code{gnus-summary-prev-article}).
2842
2843 @item G C-n
2844 @kindex G C-n (Summary)
2845 @findex gnus-summary-next-same-subject
2846 Go to the next article with the same subject
2847 (@code{gnus-summary-next-same-subject}). 
2848
2849 @item G C-p
2850 @kindex G C-p (Summary)
2851 @findex gnus-summary-prev-same-subject
2852 Go to the previous article with the same subject
2853 (@code{gnus-summary-prev-same-subject}). 
2854
2855 @item G f
2856 @itemx .
2857 @kindex G f  (Summary)
2858 @kindex .  (Summary)
2859 @findex gnus-summary-first-unread-article
2860 Go to the first unread article
2861 (@code{gnus-summary-first-unread-article}).
2862
2863 @item G b
2864 @itemx ,
2865 @kindex G b (Summary)
2866 @kindex , (Summary)
2867 @findex gnus-summary-best-unread-article
2868 Go to the article with the highest score
2869 (@code{gnus-summary-best-unread-article}). 
2870
2871 @item G l
2872 @itemx l
2873 @kindex l (Summary)
2874 @kindex G l (Summary)
2875 @findex gnus-summary-goto-last-article
2876 Go to the previous article read (@code{gnus-summary-goto-last-article}).
2877
2878 @item G p
2879 @kindex G p (Summary)
2880 @findex gnus-summary-pop-article
2881 Pop an article off the summary history and go to this article
2882 (@code{gnus-summary-pop-article}).  This command differs from the
2883 command above in that you can pop as many previous articles off the
2884 history as you like.
2885 @end table
2886
2887 Some variables that are relevant for moving and selecting articles:
2888
2889 @table @code
2890 @item gnus-auto-extend-newsgroup
2891 @vindex gnus-auto-extend-newsgroup
2892 All the movement commands will try to go to the previous (or next)
2893 article, even if that article isn't displayed in the Summary buffer if
2894 this variable is non-@code{nil}.  Gnus will then fetch the article from
2895 the server and display it in the article buffer.
2896
2897 @item gnus-select-article-hook
2898 @vindex gnus-select-article-hook
2899 This hook is called whenever an article is selected.  By default it
2900 exposes any threads hidden under the selected article.
2901
2902 @item gnus-mark-article-hook
2903 @vindex gnus-mark-article-hook
2904 @findex gnus-summary-mark-unread-as-read
2905 @findex gnus-summary-mark-read-and-unread-as-read
2906 @findex gnus-unread-mark
2907 This hook is called whenever an article is selected.  It is intended to
2908 be used for marking articles as read.  The default value is
2909 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
2910 mark of almost any article you read to @code{gnus-unread-mark}.  The
2911 only articles not affected by this function are ticked, dormant, and
2912 expirable articles.  If you'd instead like to just have unread articles
2913 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
2914 instead.  It will leave marks like @code{gnus-low-score-mark},
2915 @code{gnus-del-mark} (and so on) alone.
2916
2917 @end table
2918
2919
2920 @node Paging the Article
2921 @section Scrolling the Article
2922 @cindex article scrolling
2923
2924 @table @kbd
2925
2926 @item SPACE
2927 @kindex SPACE (Summary)
2928 @findex gnus-summary-next-page
2929 Pressing @kbd{SPACE} will scroll the current article forward one page,
2930 or, if you have come to the end of the current article, will choose the
2931 next article (@code{gnus-summary-next-page}).
2932
2933 @item DEL
2934 @kindex DEL (Summary)
2935 @findex gnus-summary-prev-page
2936 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
2937
2938 @item RET
2939 @kindex RET (Summary)
2940 @findex gnus-summary-scroll-up
2941 Scroll the current article one line forward
2942 (@code{gnus-summary-scroll-up}).
2943
2944 @item A g
2945 @itemx g
2946 @kindex A g (Summary)
2947 @kindex g (Summary)
2948 @findex gnus-summary-show-article
2949 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
2950 given a prefix, fetch the current article, but don't run any of the
2951 article treatment functions.  This will give you a ``raw'' article, just
2952 the way it came from the server.
2953
2954 @item A <
2955 @itemx <
2956 @kindex < (Summary)
2957 @kindex A < (Summary)
2958 @findex gnus-summary-beginning-of-article
2959 Scroll to the beginning of the article
2960 (@code{gnus-summary-beginning-of-article}).
2961
2962 @item A >
2963 @itemx >
2964 @kindex > (Summary)
2965 @kindex A > (Summary)
2966 @findex gnus-summary-end-of-article
2967 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
2968
2969 @item A s 
2970 @kindex A s (Summary)
2971 @findex gnus-summary-isearch-article
2972 Perform an isearch in the article buffer
2973 (@code{gnus-summary-isearch-article}). 
2974
2975 @end table
2976
2977
2978 @node Reply Followup and Post
2979 @section Reply, Followup and Post
2980
2981 @menu
2982 * Summary Mail Commands::            Sending mail.
2983 * Summary Post Commands::            Sending news.
2984 @end menu
2985
2986
2987 @node Summary Mail Commands
2988 @subsection Summary Mail Commands
2989 @cindex mail
2990 @cindex composing mail
2991
2992 Commands for composing a mail message:
2993
2994 @table @kbd
2995
2996 @item S r
2997 @itemx r
2998 @kindex S r (Summary)
2999 @kindex r (Summary)
3000 @findex gnus-summary-reply
3001 Mail a reply to the author of the current article
3002 (@code{gnus-summary-reply}). 
3003
3004 @item S R
3005 @itemx R
3006 @kindex R (Summary)
3007 @kindex S R (Summary)
3008 @findex gnus-summary-reply-with-original
3009 Mail a reply to the author of the current article and include the
3010 original message (@code{gnus-summary-reply-with-original}).  This
3011 command uses the process/prefix convention.
3012
3013 @item S o m
3014 @kindex S o m (Summary)
3015 @findex gnus-summary-mail-forward
3016 Forward the current article to some other person
3017 (@code{gnus-summary-mail-forward}). 
3018
3019 @item S o p
3020 @kindex S o p (Summary)
3021 @findex gnus-summary-post-forward
3022 Forward the current article to a newsgroup
3023 (@code{gnus-summary-post-forward}).
3024
3025 @item S m
3026 @itemx m
3027 @kindex m (Summary)
3028 @kindex S m (Summary)
3029 @findex gnus-summary-mail-other-window
3030 Send a mail to some other person
3031 (@code{gnus-summary-mail-other-window}).
3032
3033 @item S D b
3034 @kindex S D b (Summary)
3035 @findex gnus-summary-resend-bounced-mail
3036 @cindex bouncing mail
3037 If you have sent a mail, but the mail was bounced back to you for some
3038 reason (wrong address, transient failure), you can use this command to
3039 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3040 will be popped into a mail buffer where you can edit the headers before
3041 sending the mail off again.  If you give a prefix to this command, and
3042 the bounced mail is a reply to some other mail, Gnus will try to fetch
3043 that mail and display it for easy perusal of its headers.  This might
3044 very well fail, though.
3045
3046 @item S D r
3047 @kindex S D r (Summary)
3048 @findex gnus-summary-resend-message
3049 Not to be confused with the previous command,
3050 @code{gnus-summary-resend-message} will prompt you for an address to
3051 send the current message off to, and then send it to that place.  The
3052 headers of the message won't be altered---but lots of headers that say
3053 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3054 means that you actually send a mail to someone that has a @code{To}
3055 header that (probably) points to yourself.  This will confuse people.
3056 So, natcherly you'll only do that if you're really eVIl.  
3057
3058 This command is mainly used if you have several accounts and want to
3059 ship a mail to a different account of yours.  (If you're both
3060 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3061 to the @code{root} account, you may want to resend it to
3062 @code{postmaster}.  Ordnung muss sein!
3063
3064 @item S O m
3065 @kindex S O m (Summary)
3066 @findex gnus-uu-digest-mail-forward
3067 Digest the current series and forward the result using mail
3068 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3069 process/prefix convention (@pxref{Process/Prefix}). 
3070
3071 @item S O p
3072 @kindex S O p (Summary)
3073 @findex gnus-uu-digest-post-forward
3074 Digest the current series and forward the result to a newsgroup
3075 (@code{gnus-uu-digest-mail-forward}).  
3076 @end table
3077
3078
3079 @node Summary Post Commands
3080 @subsection Summary Post Commands
3081 @cindex post
3082 @cindex composing news
3083
3084 Commands for posting an article:
3085
3086 @table @kbd
3087 @item S p
3088 @itemx a
3089 @kindex a (Summary)
3090 @kindex S p (Summary)
3091 @findex gnus-summary-post-news
3092 Post an article to the current group
3093 (@code{gnus-summary-post-news}).
3094
3095 @item S f
3096 @itemx f
3097 @kindex f (Summary)
3098 @kindex S f (Summary)
3099 @findex gnus-summary-followup
3100 Post a followup to the current article (@code{gnus-summary-followup}).
3101
3102 @item S F
3103 @itemx F
3104 @kindex S F (Summary)
3105 @kindex F (Summary)
3106 @findex gnus-summary-followup-with-original
3107 Post a followup to the current article and include the original message
3108 (@code{gnus-summary-followup-with-original}).   This command uses the
3109 process/prefix convention.
3110
3111 @item S u
3112 @kindex S u (Summary)
3113 @findex gnus-uu-post-news
3114 Uuencode a file, split it into parts, and post it as a series
3115 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3116 @end table
3117
3118
3119 @node Canceling and Superseding
3120 @section Canceling Articles
3121 @cindex canceling articles
3122 @cindex superseding articles
3123
3124 Have you ever written something, and then decided that you really,
3125 really, really wish you hadn't posted that?
3126
3127 Well, you can't cancel mail, but you can cancel posts.
3128
3129 @findex gnus-summary-cancel-article
3130 @kindex C (Summary)
3131 Find the article you wish to cancel (you can only cancel your own
3132 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3133 c} (@code{gnus-summary-cancel-article}).  Your article will be
3134 canceled---machines all over the world will be deleting your article. 
3135
3136 Be aware, however, that not all sites honor cancels, so your article may
3137 live on here and there, while most sites will delete the article in
3138 question.
3139
3140 If you discover that you have made some mistakes and want to do some
3141 corrections, you can post a @dfn{superseding} article that will replace
3142 your original article.
3143
3144 @findex gnus-summary-supersede-article
3145 @kindex S (Summary)
3146 Go to the original article and press @kbd{S s}
3147 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3148 where you can edit the article all you want before sending it off the
3149 usual way.
3150
3151 The same goes for superseding as for canceling, only more so: Some
3152 sites do not honor superseding.  On those sites, it will appear that you
3153 have posted almost the same article twice.
3154
3155 If you have just posted the article, and change your mind right away,
3156 there is a trick you can use to cancel/supersede the article without
3157 waiting for the article to appear on your site first.  You simply return
3158 to the post buffer (which is called @code{*post-buf*}).  There you will
3159 find the article you just posted, with all the headers intact.  Change
3160 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3161 header by substituting one of those words for @code{Message-ID}.  Then
3162 just press @kbd{C-c C-c} to send the article as you would do normally.
3163 The previous article will be canceled/superseded.
3164
3165 Just remember, kids: There is no 'c' in 'supersede'.
3166
3167
3168 @node Marking Articles
3169 @section Marking Articles
3170 @cindex article marking
3171 @cindex article ticking
3172 @cindex marks
3173
3174 There are several marks you can set on an article. 
3175
3176 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3177 neologism ohoy!) of the article.  Alphabetic marks generally mean
3178 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3179
3180 In addition, you also have marks that do not affect readedness.
3181
3182 @menu
3183 * Unread Articles::      Marks for unread articles.
3184 * Read Articles::        Marks for read articles.
3185 * Other Marks::          Marks that do not affect readedness.
3186 @end menu
3187
3188 @ifinfo
3189 There's a plethora of commands for manipulating these marks:
3190 @end ifinfo
3191
3192 @menu
3193 * Setting Marks::           How to set and remove marks.
3194 * Setting Process Marks::   How to mark articles for later processing.
3195 @end menu
3196
3197
3198 @node Unread Articles
3199 @subsection Unread Articles
3200
3201 The following marks mark articles as unread, in one form or other.
3202
3203 @vindex gnus-dormant-mark
3204 @vindex gnus-ticked-mark
3205 @table @samp
3206 @item !
3207 @dfn{Ticked articles} are articles that will remain visible always.  If
3208 you see an article that you find interesting, or you want to put off
3209 reading it, or replying to it, until sometime later, you'd typically
3210 tick it.  However, articles can be expired, so if you want to keep an
3211 article forever, you'll have to save it.  Ticked articles have a
3212 @samp{!} (@code{gnus-ticked-mark}) in the first column.
3213
3214 @item ?
3215 @vindex gnus-dormant-mark
3216 A @dfn{dormant} article is marked with a @samp{?}
3217 (@code{gnus-dormant-mark}), and will only appear in the summary buffer
3218 if there are followups to it.
3219
3220 @item SPACE
3221 @vindex gnus-unread-mark
3222 An @dfn{unread} article is marked with a @samp{SPACE}
3223 (@code{gnus-unread-mark}).  These are articles that haven't been read at
3224 all yet.
3225 @end table
3226
3227
3228 @node Read Articles
3229 @subsection Read Articles
3230 @cindex expirable mark
3231
3232 All the following marks mark articles as read.
3233
3234 @table @samp
3235
3236 @item r
3237 @vindex gnus-del-mark
3238 Articles that are marked as read.  They have a @samp{r}
3239 (@code{gnus-del-mark}) in the first column.  These are articles that the
3240 user has marked as read more or less manually.
3241
3242 @item R
3243 @vindex gnus-read-mark
3244 Articles that are actually read are marked with @samp{R}
3245 (@code{gnus-read-mark}). 
3246
3247 @item O
3248 @vindex gnus-ancient-mark
3249 Articles that were marked as read in previous sessions are now
3250 @dfn{old} and marked with @samp{O} (@code{gnus-ancient-mark}). 
3251
3252 @item K
3253 @vindex gnus-killed-mark
3254 Marked as killed (@code{gnus-killed-mark}).
3255
3256 @item X
3257 @vindex gnus-kill-file-mark
3258 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3259
3260 @item Y
3261 @vindex gnus-low-score-mark
3262 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3263
3264 @item C
3265 @vindex gnus-catchup-mark
3266 Marked as read by a catchup (@code{gnus-catchup-mark}).
3267
3268 @item G
3269 @vindex gnus-canceled-mark
3270 Canceled article (@code{gnus-canceled-mark})
3271
3272 @item F
3273 @vindex gnus-souped-mark
3274 @sc{SOUP}ed article (@code{gnus-souped-mark}).
3275
3276 @item Q
3277 @vindex gnus-sparse-mark
3278 Sparsely reffed article (@code{gnus-sparse-mark}).
3279 @end table
3280
3281 All these marks just mean that the article is marked as read, really.
3282 They are interpreted differently by the adaptive scoring scheme,
3283 however.
3284
3285 One more special mark, though:
3286
3287 @table @samp
3288 @item E
3289 @vindex gnus-expirable-mark
3290 You can also mark articles as @dfn{expirable} (or have them marked as
3291 such automatically).  That doesn't make much sense in normal groups,
3292 because a user does not control the expiring of news articles, but in
3293 mail groups, for instance, articles that are marked as @dfn{expirable}
3294 can be deleted by Gnus at any time.  Expirable articles are marked with
3295 @samp{E} (@code{gnus-expirable-mark}).
3296 @end table
3297
3298
3299 @node Other Marks
3300 @subsection Other Marks
3301 @cindex process mark
3302 @cindex bookmarks
3303
3304 There are some marks that have nothing to do with whether the article is
3305 read or not.
3306
3307 @itemize @bullet
3308
3309 @item 
3310 You can set a bookmark in the current article.  Say you are reading a
3311 long thesis on cats' urinary tracts, and have to go home for dinner
3312 before you've finished reading the thesis.  You can then set a bookmark
3313 in the article, and Gnus will jump to this bookmark the next time it
3314 encounters the article.
3315
3316 @item
3317 @vindex gnus-replied-mark
3318 All articles that you have replied to or made a followup to (i.e., have
3319 answered) will be marked with an @samp{A} in the second column
3320 (@code{gnus-replied-mark}).
3321
3322 @item 
3323 @vindex gnus-cached-mark
3324 Articles that are stored in the article cache will be marked with an
3325 @samp{*} in the second column (@code{gnus-cached-mark}).
3326
3327 @item 
3328 @vindex gnus-saved-mark
3329 Articles that are ``saved'' (in some manner or other; not necessarily
3330 religiously) are marked with an @samp{S} in the second column
3331 (@code{gnus-saved-mark}.
3332
3333 @item 
3334 @vindex gnus-not-empty-thread-mark
3335 @vindex gnus-empty-thread-mark
3336 It the @samp{%e} spec is used, the presence of threads or not will be
3337 marked with @code{gnus-not-empty-thread-mark} and
3338 @code{gnus-empty-thread-mark} in the third column, respectively.
3339
3340 @item 
3341 @vindex gnus-process-mark
3342 Finally we have the @dfn{process mark} (@code{gnus-process-mark}.  A
3343 variety of commands react to the presence of the process mark.  For
3344 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3345 all articles that have been marked with the process mark.  Articles
3346 marked with the process mark have a @samp{#} in the second column.
3347
3348 @end itemize
3349
3350 You might have noticed that most of these ``non-readedness'' marks
3351 appear in the second column by default.  So if you have a cached, saved,
3352 replied article that you have process-marked, what will that look like?
3353
3354 Nothing much.  The precedence rules go as follows: process -> cache ->
3355 replied -> saved.  So if the article is in the cache and is replied,
3356 you'll only see the cache mark and not the replied mark.
3357
3358
3359 @node Setting Marks
3360 @subsection Setting Marks
3361 @cindex setting marks
3362
3363 All the marking commands understand the numeric prefix.
3364
3365 @table @kbd
3366 @item M t
3367 @itemx !
3368 @kindex ! (Summary)
3369 @kindex M t (Summary)
3370 @findex gnus-summary-tick-article-forward
3371 Tick the current article (@code{gnus-summary-tick-article-forward}).
3372
3373 @item M ?
3374 @itemx ?
3375 @kindex ? (Summary)
3376 @kindex M ? (Summary)
3377 @findex gnus-summary-mark-as-dormant
3378 Mark the current article as dormant
3379 (@code{gnus-summary-mark-as-dormant}).
3380
3381 @item M d
3382 @itemx d
3383 @kindex M d (Summary)
3384 @kindex d (Summary)
3385 @findex gnus-summary-mark-as-read-forward
3386 Mark the current article as read
3387 (@code{gnus-summary-mark-as-read-forward}).
3388
3389 @item M k
3390 @itemx k
3391 @kindex k (Summary)
3392 @kindex M k (Summary)
3393 @findex gnus-summary-kill-same-subject-and-select
3394 Mark all articles that have the same subject as the current one as read,
3395 and then select the next unread article
3396 (@code{gnus-summary-kill-same-subject-and-select}).
3397
3398 @item M K
3399 @itemx C-k
3400 @kindex M K (Summary)
3401 @kindex C-k (Summary)
3402 @findex gnus-summary-kill-same-subject
3403 Mark all articles that have the same subject as the current one as read
3404 (@code{gnus-summary-kill-same-subject}).  
3405
3406 @item M C
3407 @kindex M C (Summary)
3408 @findex gnus-summary-catchup
3409 Mark all unread articles in the group as read
3410 (@code{gnus-summary-catchup}).
3411
3412 @item M C-c
3413 @kindex M C-c (Summary)
3414 @findex gnus-summary-catchup-all
3415 Mark all articles in the group as read---even the ticked and dormant
3416 articles (@code{gnus-summary-catchup-all}).
3417
3418 @item M H
3419 @kindex M H (Summary)
3420 @findex gnus-summary-catchup-to-here
3421 Catchup the current group to point
3422 (@code{gnus-summary-catchup-to-here}). 
3423
3424 @item C-w
3425 @kindex C-w (Summary)
3426 @findex gnus-summary-mark-region-as-read
3427 Mark all articles between point and mark as read
3428 (@code{gnus-summary-mark-region-as-read}). 
3429
3430 @item M V k
3431 @kindex M V k (Summary)
3432 @findex gnus-summary-kill-below
3433 Kill all articles with scores below the default score (or below the
3434 numeric prefix) (@code{gnus-summary-kill-below}).
3435
3436 @item M c
3437 @itemx M-u
3438 @kindex M c (Summary)
3439 @kindex M-u (Summary)
3440 @findex gnus-summary-clear-mark-forward
3441 Clear all readedness-marks from the current article
3442 (@code{gnus-summary-clear-mark-forward}).
3443
3444 @item M e
3445 @itemx E
3446 @kindex M e (Summary)
3447 @kindex E (Summary)
3448 @findex gnus-summary-mark-as-expirable
3449 Mark the current article as expirable
3450 (@code{gnus-summary-mark-as-expirable}).
3451
3452 @item M b
3453 @kindex M b (Summary)
3454 @findex gnus-summary-set-bookmark
3455 Set a bookmark in the current article
3456 (@code{gnus-summary-set-bookmark}).
3457
3458 @item M B
3459 @kindex M B (Summary)
3460 @findex gnus-summary-remove-bookmark
3461 Remove the bookmark from the current article
3462 (@code{gnus-summary-remove-bookmark}).
3463
3464 @item M V c
3465 @kindex M V c (Summary)
3466 @findex gnus-summary-clear-above
3467 Clear all marks from articles with scores over the default score (or
3468 over the numeric prefix) (@code{gnus-summary-clear-above}).
3469
3470 @item M V u
3471 @kindex M V u (Summary)
3472 @findex gnus-summary-tick-above
3473 Tick all articles with scores over the default score (or over the
3474 numeric prefix) (@code{gnus-summary-tick-above}).
3475
3476 @item M V m
3477 @kindex M V m (Summary)
3478 @findex gnus-summary-mark-above
3479 Prompt for a mark, and mark all articles with scores over the default
3480 score (or over the numeric prefix) with this mark
3481 (@code{gnus-summary-clear-above}).
3482 @end table
3483
3484 @vindex gnus-summary-goto-unread
3485 The @code{gnus-summary-goto-unread} variable controls what action should
3486 be taken after setting a mark.  If non-@code{nil}, point will move to
3487 the next/previous unread article.  If @code{nil}, point will just move
3488 one line up or down.  As a special case, if this variable is
3489 @code{never}, all the marking commands as well as other commands (like
3490 @kbd{SPACE}) will move to the next article, whether it is unread or not.
3491 The default is @code{t}.
3492
3493
3494 @node Setting Process Marks
3495 @subsection Setting Process Marks
3496 @cindex setting process marks
3497
3498 @table @kbd
3499
3500 @item M P p
3501 @itemx #
3502 @kindex # (Summary)
3503 @kindex M P p (Summary)
3504 @findex gnus-summary-mark-as-processable
3505 Mark the current article with the process mark
3506 (@code{gnus-summary-mark-as-processable}). 
3507 @findex gnus-summary-unmark-as-processable
3508
3509 @item M P u 
3510 @itemx M-#
3511 @kindex M P u (Summary)
3512 @kindex M-# (Summary)
3513 Remove the process mark, if any, from the current article
3514 (@code{gnus-summary-unmark-as-processable}).
3515
3516 @item M P U
3517 @kindex M P U (Summary)
3518 @findex gnus-summary-unmark-all-processable
3519 Remove the process mark from all articles
3520 (@code{gnus-summary-unmark-all-processable}). 
3521
3522 @item M P R
3523 @kindex M P R (Summary)
3524 @findex gnus-uu-mark-by-regexp
3525 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
3526
3527 @item M P r
3528 @kindex M P r (Summary)
3529 @findex gnus-uu-mark-region
3530 Mark articles in region (@code{gnus-uu-mark-region}).
3531
3532 @item M P t
3533 @kindex M P t (Summary)
3534 @findex gnus-uu-mark-thread
3535 Mark all articles in the current (sub)thread
3536 (@code{gnus-uu-mark-thread}).
3537
3538 @item M P T
3539 @kindex M P T (Summary)
3540 @findex gnus-uu-unmark-thread
3541 Unmark all articles in the current (sub)thread
3542 (@code{gnus-uu-unmark-thread}).
3543
3544 @item M P v
3545 @kindex M P v (Summary)
3546 @findex gnus-uu-mark-over
3547 Mark all articles that have a score above the prefix argument
3548 (@code{gnus-uu-mark-over}).
3549
3550 @item M P s
3551 @kindex M P s (Summary)
3552 @findex gnus-uu-mark-series
3553 Mark all articles in the current series (@code{gnus-uu-mark-series}).
3554
3555 @item M P S
3556 @kindex M P S (Summary)
3557 @findex gnus-uu-mark-sparse
3558 Mark all series that have already had some articles marked
3559 (@code{gnus-uu-mark-sparse}).
3560
3561 @item M P a
3562 @kindex M P a (Summary)
3563 @findex gnus-uu-mark-all
3564 Mark all articles in series order (@code{gnus-uu-mark-series}).
3565
3566 @item M P b
3567 @kindex M P b (Summary)
3568 @findex gnus-uu-mark-buffer
3569 Mark all articles in the buffer in the order they appear
3570 (@code{gnus-uu-mark-buffer}). 
3571 @end table
3572
3573
3574 @node Limiting
3575 @section Limiting
3576 @cindex limiting
3577
3578 It can be convenient to limit the summary buffer to just show some
3579 subset of the articles currently in the group.  The effect most limit
3580 commands have is to remove a few (or many) articles from the summary
3581 buffer. 
3582
3583 @table @kbd
3584
3585 @item / /
3586 @itemx / s
3587 @kindex / / (Summary)
3588 @findex gnus-summary-limit-to-subject
3589 Limit the summary buffer to articles that match some subject
3590 (@code{gnus-summary-limit-to-subject}). 
3591
3592 @item / a
3593 @kindex / a (Summary)
3594 @findex gnus-summary-limit-to-author
3595 Limit the summary buffer to articles that match some author
3596 (@code{gnus-summary-limit-to-author}).
3597
3598 @item / u
3599 @itemx x
3600 @kindex / u (Summary)
3601 @kindex x (Summary)
3602 @findex gnus-summary-limit-to-unread
3603 Limit the summary buffer to articles that are not marked as read
3604 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
3605 buffer to articles that are strictly unread.  This means that ticked and
3606 dormant articles will also be excluded.
3607
3608 @item / m
3609 @kindex / m (Summary)
3610 @findex gnus-summary-limit-to-marks
3611 Ask for a mark and then limit to all articles that have not been marked
3612 with that mark (@code{gnus-summary-limit-to-marks}).
3613
3614 @item / n
3615 @kindex / n (Summary)
3616 @findex gnus-summary-limit-to-articles
3617 Limit the summary buffer to the current article
3618 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
3619 convention (@pxref{Process/Prefix}).
3620
3621 @item / w
3622 @kindex / w (Summary)
3623 @findex gnus-summary-pop-limit
3624 Pop the previous limit off the stack and restore it
3625 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
3626 the stack.
3627
3628 @item / v
3629 @kindex / v (Summary)
3630 @findex gnus-summary-limit-to-score
3631 Limit the summary buffer to articles that have a score at or above some
3632 score (@code{gnus-summary-limit-to-score}).
3633
3634 @item / E
3635 @itemx M S
3636 @kindex M S (Summary)
3637 @kindex / E (Summary)
3638 @findex gnus-summary-limit-include-expunged
3639 Display all expunged articles
3640 (@code{gnus-summary-limit-include-expunged}). 
3641
3642 @item / D
3643 @kindex / D (Summary)
3644 @findex gnus-summary-limit-include-dormant
3645 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
3646
3647 @item / d
3648 @kindex / d (Summary)
3649 @findex gnus-summary-limit-exclude-dormant
3650 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
3651
3652 @item / c
3653 @kindex / c (Summary)
3654 @findex gnus-summary-limit-exclude-childless-dormant
3655 Hide all dormant articles that have no children
3656 (@code{gnus-summary-limit-exclude-childless-dormant}). 
3657
3658 @item / C
3659 @kindex / C (Summary)
3660 @findex gnus-summary-limit-mark-excluded-as-read
3661 Mark all excluded unread articles as read
3662 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
3663 also mark excluded ticked and dormant articles as read.
3664
3665 @end table
3666
3667
3668 @node Threading
3669 @section Threading
3670 @cindex threading
3671 @cindex article threading
3672
3673 Gnus threads articles by default.  @dfn{To thread} is to put replies to
3674 articles directly after the articles they reply to---in a hierarchical
3675 fashion.
3676
3677 @menu
3678 * Customizing Threading::     Variables you can change to affect the threading.
3679 * Thread Commands::           Thread based commands in the summary buffer.
3680 @end menu
3681
3682
3683 @node Customizing Threading
3684 @subsection Customizing Threading
3685 @cindex customizing threading
3686 @cindex <
3687 @cindex >
3688
3689 @table @code
3690
3691 @item gnus-show-threads
3692 @vindex gnus-show-threads
3693 If this variable is @code{nil}, no threading will be done, and all of
3694 the rest of the variables here will have no effect.  Turning threading
3695 off will speed group selection up a bit, but it is sure to make reading
3696 slower and more awkward.
3697
3698 @item gnus-fetch-old-headers
3699 @vindex gnus-fetch-old-headers
3700 If non-@code{nil}, Gnus will attempt to build old threads by fetching
3701 more old headers---headers to articles that are marked as read.  If you
3702 would like to display as few summary lines as possible, but still
3703 connect as many loose threads as possible, you should set this variable
3704 to @code{some} or a number.  If you set it to a number, no more than
3705 that number of extra old headers will be fetched.  In either case,
3706 fetching old headers only works if the backend you are using carries
3707 overview files---this would normally be @code{nntp}, @code{nnspool} and
3708 @code{nnml}.  Also remember that if the root of the thread has been
3709 expired by the server, there's not much Gnus can do about that.
3710
3711 @item gnus-build-sparse-threads
3712 @vindex gnus-build-sparse-threads
3713 Fetching old headers can be slow.  A low-rent similar effect can be
3714 gotten by setting this variable to @code{some}.  Gnus will then look at
3715 the complete @code{References} headers of all articles and try to string
3716 articles that belong in the same thread together.  This will leave
3717 @dfn{gaps} in the threading display where Gnus guesses that an article
3718 is missing from the thread.  (These gaps appear like normal summary
3719 lines.  If you select a gap, Gnus will try to fetch the article in
3720 question.)  If this variable is @code{t}, Gnus will display all these
3721 ``gaps'' without regard for whether they are useful for completing the
3722 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
3723 off sparse leaf nodes that don't lead anywhere.  This variable is
3724 @code{nil} by default.
3725
3726 @item gnus-summary-gather-subject-limit
3727 @vindex gnus-summary-gather-subject-limit
3728 Loose threads are gathered by comparing subjects of articles.  If this
3729 variable is @code{nil}, Gnus requires an exact match between the
3730 subjects of the loose threads before gathering them into one big
3731 super-thread.  This might be too strict a requirement, what with the
3732 presence of stupid newsreaders that chop off long subjects lines.  If
3733 you think so, set this variable to, say, 20 to require that only the
3734 first 20 characters of the subjects have to match.  If you set this
3735 variable to a really low number, you'll find that Gnus will gather
3736 everything in sight into one thread, which isn't very helpful.
3737
3738 @cindex fuzzy article gathering
3739 If you set this variable to the special value @code{fuzzy}, Gnus will
3740 use a fuzzy string comparison algorithm on the subjects.
3741
3742 @item gnus-simplify-subject-fuzzy-regexp
3743 @vindex gnus-simplify-subject-fuzzy-regexp
3744 This can either be a regular expression or list of regular expressions
3745 that match strings that will be removed from subjects if fuzzy subject
3746 simplification is used.
3747
3748 @item gnus-simplify-ignored-prefixes
3749 @vindex gnus-simplify-ignored-prefixes
3750 If you set @code{gnus-summary-gather-subject-limit} to something as low
3751 as 10, you might consider setting this variable to something sensible:
3752
3753 @c Written by Michael Ernst <mernst@cs.rice.edu>
3754 @lisp
3755 (setq gnus-simplify-ignored-prefixes
3756       (concat 
3757        "\\`\\[?\\("
3758        (mapconcat 'identity
3759                   '("looking"
3760                      "wanted" "followup" "summary\\( of\\)?"
3761                      "help" "query" "problem" "question" 
3762                      "answer" "reference" "announce"
3763                      "How can I" "How to" "Comparison of"
3764                      ;; ...
3765                      )
3766                   "\\|")
3767                   "\\)\\s *\\("
3768                   (mapconcat 'identity
3769                              '("for" "for reference" "with" "about")
3770                              "\\|")
3771                   "\\)?\\]?:?[ \t]*"))
3772 @end lisp
3773
3774 All words that match this regexp will be removed before comparing two
3775 subjects. 
3776
3777 @item gnus-summary-gather-exclude-subject
3778 @vindex gnus-summary-gather-exclude-subject
3779 Since loose thread gathering is done on subjects only, that might lead
3780 to many false hits, especially with certain common subjects like
3781 @samp{} and @samp{(none)}.  To make the situation slightly better,
3782 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
3783 what subjects should be excluded from the gathering process.  The
3784 default is @samp{^ *$\\|^(none)$}.  
3785
3786 @item gnus-summary-thread-gathering-function
3787 @vindex gnus-summary-thread-gathering-function
3788 Gnus gathers threads by looking at @code{Subject} headers.  This means
3789 that totally unrelated articles may end up in the same ``thread'', which
3790 is confusing.  An alternate approach is to look at all the
3791 @code{Message-ID}s in all the @code{References} headers to find matches.
3792 This will ensure that no gathered threads ever includes unrelated
3793 articles, but it's also means that people who have posted with broken
3794 newsreaders won't be gathered properly.  The choice is yours---plague or
3795 cholera:
3796
3797 @table @code
3798 @item gnus-gather-threads-by-subject
3799 @findex gnus-gather-threads-by-subject
3800 This function is the default gathering function and looks at
3801 @code{Subject}s exclusively.
3802
3803 @item gnus-gather-threads-by-references
3804 @findex gnus-gather-threads-by-references
3805 This function looks at @code{References} headers exclusively.
3806 @end table
3807
3808 If you want to test gathering by @code{References}, you could say
3809 something like:
3810
3811 @lisp
3812 (setq gnus-summary-thread-gathering-function
3813       'gnus-gather-threads-by-references)
3814 @end lisp
3815
3816 @item gnus-summary-make-false-root
3817 @vindex gnus-summary-make-false-root
3818 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
3819 and create a dummy root at the top.  (Wait a minute.  Root at the top?
3820 Yup.)  Loose subtrees occur when the real root has expired, or you've
3821 read or killed the root in a previous session.
3822
3823 When there is no real root of a thread, Gnus will have to fudge
3824 something.  This variable says what fudging method Gnus should use.
3825 There are four possible values:
3826
3827 @cindex adopting articles
3828
3829 @table @code
3830
3831 @item adopt
3832 Gnus will make the first of the orphaned articles the parent.  This
3833 parent will adopt all the other articles.  The adopted articles will be
3834 marked as such by pointy brackets (@samp{<>}) instead of the standard
3835 square brackets (@samp{[]}).  This is the default method.
3836
3837 @item dummy
3838 @vindex gnus-summary-dummy-line-format
3839 Gnus will create a dummy summary line that will pretend to be the
3840 parent.  This dummy line does not correspond to any real article, so
3841 selecting it will just select the first real article after the dummy
3842 article.  @code{gnus-summary-dummy-line-format} is used to specify the
3843 format of the dummy roots.  It accepts only one format spec:  @samp{S},
3844 which is the subject of the article.  @xref{Formatting Variables}.
3845
3846 @item empty
3847 Gnus won't actually make any article the parent, but simply leave the
3848 subject field of all orphans except the first empty.  (Actually, it will
3849 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
3850 Buffer Format}).)
3851
3852 @item none
3853 Don't make any article parent at all.  Just gather the threads and
3854 display them after one another.
3855
3856 @item nil
3857 Don't gather loose threads.
3858 @end table
3859
3860 @item gnus-thread-hide-subtree
3861 @vindex gnus-thread-hide-subtree
3862 If non-@code{nil}, all threads will be hidden when the summary buffer is
3863 generated.
3864
3865 @item gnus-thread-hide-killed
3866 @vindex gnus-thread-hide-killed
3867 if you kill a thread and this variable is non-@code{nil}, the subtree
3868 will be hidden.
3869
3870 @item gnus-thread-ignore-subject
3871 @vindex gnus-thread-ignore-subject
3872 Sometimes somebody changes the subject in the middle of a thread.  If
3873 this variable is non-@code{nil}, the subject change is ignored.  If it
3874 is @code{nil}, which is the default, a change in the subject will result
3875 in a new thread.
3876
3877 @item gnus-thread-indent-level
3878 @vindex gnus-thread-indent-level
3879 This is a number that says how much each sub-thread should be indented.
3880 The default is @code{4}.
3881 @end table
3882
3883
3884 @node Thread Commands
3885 @subsection Thread Commands
3886 @cindex thread commands
3887
3888 @table @kbd
3889
3890 @item T k
3891 @itemx M-C-k
3892 @kindex T k (Summary)
3893 @kindex M-C-k (Summary)
3894 @findex gnus-summary-kill-thread
3895 Mark all articles in the current sub-thread as read
3896 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
3897 remove all marks instead.  If the prefix argument is negative, tick
3898 articles instead.
3899
3900 @item T l
3901 @itemx M-C-l
3902 @kindex T l (Summary)
3903 @kindex M-C-l (Summary)
3904 @findex gnus-summary-lower-thread
3905 Lower the score of the current thread
3906 (@code{gnus-summary-lower-thread}). 
3907
3908 @item T i
3909 @kindex T i (Summary)
3910 @findex gnus-summary-raise-thread
3911 Increase the score of the current thread
3912 (@code{gnus-summary-raise-thread}).
3913
3914 @item T #
3915 @kindex T # (Summary)
3916 @findex gnus-uu-mark-thread
3917 Set the process mark on the current thread
3918 (@code{gnus-uu-mark-thread}).
3919
3920 @item T M-#
3921 @kindex T M-# (Summary)
3922 @findex gnus-uu-unmark-thread
3923 Remove the process mark from the current thread
3924 (@code{gnus-uu-unmark-thread}).
3925
3926 @item T T
3927 @kindex T T (Summary)
3928 @findex gnus-summary-toggle-threads
3929 Toggle threading (@code{gnus-summary-toggle-threads}).
3930
3931 @item T s
3932 @kindex T s (Summary)
3933 @findex gnus-summary-show-thread
3934 Expose the thread hidden under the current article, if any
3935 (@code{gnus-summary-show-thread}).
3936
3937 @item T h
3938 @kindex T h (Summary)
3939 @findex gnus-summary-hide-thread
3940 Hide the current (sub)thread (@code{gnus-summary-hide-thread}).
3941
3942 @item T S
3943 @kindex T S (Summary)
3944 @findex gnus-summary-show-all-threads
3945 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
3946
3947 @item T H
3948 @kindex T H (Summary)
3949 @findex gnus-summary-hide-all-threads
3950 Hide all threads (@code{gnus-summary-hide-all-threads}).
3951
3952 @item T t
3953 @kindex T t (Summary)
3954 @findex gnus-summary-rethread-current
3955 Re-thread the thread the current article is part of
3956 (@code{gnus-summary-rethread-current}).  This works even when the
3957 summary buffer is otherwise unthreaded.
3958
3959 @item T ^
3960 @kindex T ^ (Summary)
3961 @findex gnus-summary-reparent-thread
3962 Make the current article the child of the marked (or previous) article
3963 (@code{gnus-summary-reparent-thread}.
3964
3965 @end table
3966
3967 The following commands are thread movement commands.  They all
3968 understand the numeric prefix.
3969
3970 @table @kbd
3971
3972 @item T n
3973 @kindex T n (Summary)
3974 @findex gnus-summary-next-thread
3975 Go to the next thread (@code{gnus-summary-next-thread}).
3976
3977 @item T p
3978 @kindex T p (Summary)
3979 @findex gnus-summary-prev-thread
3980 Go to the previous thread (@code{gnus-summary-prev-thread}).
3981
3982 @item T d
3983 @kindex T d (Summary)
3984 @findex gnus-summary-down-thread
3985 Descend the thread (@code{gnus-summary-down-thread}).
3986
3987 @item T u
3988 @kindex T u (Summary)
3989 @findex gnus-summary-up-thread
3990 Ascend the thread (@code{gnus-summary-up-thread}).
3991
3992 @item T o
3993 @kindex T o (Summary)
3994 @findex gnus-summary-top-thread
3995 Go to the top of the thread (@code{gnus-summary-top-thread}).
3996 @end table
3997
3998 @vindex gnus-thread-operation-ignore-subject 
3999 If you ignore subject while threading, you'll naturally end up with
4000 threads that have several different subjects in them.  If you then issue
4001 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4002 wish to kill the entire thread, but just those parts of the thread that
4003 have the same subject as the current article.  If you like this idea,
4004 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If is
4005 is non-@code{nil} (which it is by default), subjects will be ignored
4006 when doing thread commands.  If this variable is @code{nil}, articles in
4007 the same thread with different subjects will not be included in the
4008 operation in question.  If this variable is @code{fuzzy}, only articles
4009 that have subjects that are fuzzily equal will be included.
4010
4011
4012 @node Sorting
4013 @section Sorting
4014
4015 @findex gnus-thread-sort-by-total-score
4016 @findex gnus-thread-sort-by-date
4017 @findex gnus-thread-sort-by-score
4018 @findex gnus-thread-sort-by-subject
4019 @findex gnus-thread-sort-by-author
4020 @findex gnus-thread-sort-by-number
4021 @vindex gnus-thread-sort-functions
4022 If you are using a threaded summary display, you can sort the threads by
4023 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4024 By default, sorting is done on article numbers.  Ready-made sorting
4025 predicate functions include @code{gnus-thread-sort-by-number},
4026 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4027 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4028 @code{gnus-thread-sort-by-total-score}.
4029
4030 Each function takes two threads and return non-@code{nil} if the first
4031 thread should be sorted before the other.  Note that sorting really is
4032 normally done by looking only at the roots of each thread.  If you use
4033 more than one function, the primary sort key should be the last function
4034 in the list.  You should probably always include
4035 @code{gnus-thread-sort-by-number} in the list of sorting
4036 functions---preferably first.  This will ensure that threads that are
4037 equal with respect to the other sort criteria will be displayed in
4038 ascending article order.
4039
4040 If you would like to sort by score, then by subject, and finally by
4041 number, you could do something like:
4042
4043 @lisp
4044 (setq gnus-thread-sort-functions 
4045       '(gnus-thread-sort-by-number
4046         gnus-thread-sort-by-subject
4047         gnus-thread-sort-by-score))
4048 @end lisp
4049
4050 The threads that have highest score will be displayed first in the
4051 summary buffer.  When threads have the same score, they will be sorted
4052 alphabetically.  The threads that have the same score and the same
4053 subject will be sorted by number, which is (normally) the sequence in
4054 which the articles arrived.
4055
4056 If you want to sort by score and then reverse arrival order, you could
4057 say something like:
4058
4059 @lisp
4060 (setq gnus-thread-sort-functions
4061       '((lambda (t1 t2) 
4062           (not (gnus-thread-sort-by-number t1 t2)))
4063         gnus-thread-sort-by-score))
4064 @end lisp
4065
4066 @vindex gnus-thread-score-function
4067 The function in the @code{gnus-thread-score-function} variable (default
4068 @code{+}) is used for calculating the total score of a thread.  Useful
4069 functions might be @code{max}, @code{min}, or squared means, or whatever
4070 tickles your fancy.
4071
4072 @findex gnus-article-sort-functions
4073 @findex gnus-article-sort-by-date
4074 @findex gnus-article-sort-by-score
4075 @findex gnus-article-sort-by-subject
4076 @findex gnus-article-sort-by-author
4077 @findex gnus-article-sort-by-number
4078 If you are using an unthreaded display for some strange reason or other,
4079 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4080 It is very similar to the @code{gnus-thread-sort-functions}, except that
4081 is uses slightly different functions for article comparison.  Available
4082 sorting predicate functions are @code{gnus-article-sort-by-number},
4083 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4084 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4085
4086 If you want to sort an unthreaded summary display by subject, you could
4087 say something like:
4088
4089 @lisp
4090 (setq gnus-article-sort-functions 
4091       '(gnus-article-sort-by-number
4092         gnus-article-sort-by-subject))
4093 @end lisp
4094
4095
4096
4097 @node Asynchronous Fetching
4098 @section Asynchronous Article Fetching
4099 @cindex asynchronous article fetching
4100
4101 If you read your news from an @sc{nntp} server that's far away, the
4102 network latencies may make reading articles a chore.  You have to wait
4103 for a while after pressing @kbd{n} to go to the next article before the
4104 article appears.  Why can't Gnus just go ahead and fetch the article
4105 while you are reading the previous one? Why not, indeed.
4106
4107 First, some caveats.  There are some pitfalls to using asynchronous
4108 article fetching, especially the way Gnus does it.  
4109
4110 Let's say you are reading article 1, which is short, and article 2 is
4111 quite long, and you are not interested in reading that.  Gnus does not
4112 know this, so it goes ahead and fetches article 2.  You decide to read
4113 article 3, but since Gnus is in the process of fetching article 2, the
4114 connection is blocked.
4115
4116 To avoid these situations, Gnus will open two (count 'em two)
4117 connections to the server.  Some people may think this isn't a very nice
4118 thing to do, but I don't see any real alternatives.  Setting up that
4119 extra connection takes some time, so Gnus startup will be slower.
4120
4121 Gnus will fetch more articles than you will read.  This will mean that
4122 the link between your machine and the @sc{nntp} server will become more
4123 loaded than if you didn't use article pre-fetch.  The server itself will
4124 also become more loaded---both with the extra article requests, and the
4125 extra connection.
4126
4127 Ok, so now you know that you shouldn't really use this thing...  unless
4128 you really want to.
4129
4130 @vindex gnus-asynchronous
4131 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4132 happen automatically.
4133
4134 @vindex nntp-async-number
4135 You can control how many articles that are to be pre-fetched by setting
4136 @code{nntp-async-number}.  This is five by default, which means that when
4137 you read an article in the group, @code{nntp} will pre-fetch the next
4138 five articles.  If this variable is @code{t}, @code{nntp} will pre-fetch
4139 all the articles that it can without bound.  If it is @code{nil}, no
4140 pre-fetching will be made.
4141
4142 @vindex gnus-asynchronous-article-function
4143 You may wish to create some sort of scheme for choosing which articles
4144 that @code{nntp} should consider as candidates for pre-fetching.  For
4145 instance, you may wish to pre-fetch all articles with high scores, and
4146 not pre-fetch low-scored articles.  You can do that by setting the
4147 @code{gnus-asynchronous-article-function}, which will be called with an
4148 alist where the keys are the article numbers.  Your function should
4149 return an alist where the articles you are not interested in have been
4150 removed.  You could also do sorting on article score and the like. 
4151
4152
4153 @node Article Caching
4154 @section Article Caching
4155 @cindex article caching
4156 @cindex caching
4157
4158 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4159 consider turning article caching on.  Each article will then be stored
4160 locally under your home directory.  As you may surmise, this could
4161 potentially use @emph{huge} amounts of disk space, as well as eat up all
4162 your inodes so fast it will make your head swim.  In vodka.
4163
4164 Used carefully, though, it could be just an easier way to save articles.
4165
4166 @vindex gnus-use-long-file-name
4167 @vindex gnus-cache-directory
4168 @vindex gnus-use-cache
4169 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4170 all articles that are ticked or marked as dormant will then be copied
4171 over to your local cache (@code{gnus-cache-directory}).  Whether this
4172 cache is flat or hierarchal is controlled by the
4173 @code{gnus-use-long-file-name} variable, as usual.
4174
4175 When re-select a ticked or dormant article, it will be fetched from the
4176 cache instead of from the server.  As articles in your cache will never
4177 expire, this might serve as a method of saving articles while still
4178 keeping them where they belong.  Just mark all articles you want to save
4179 as dormant, and don't worry.
4180
4181 When an article is marked as read, is it removed from the cache.
4182
4183 @vindex gnus-cache-remove-articles
4184 @vindex gnus-cache-enter-articles
4185 The entering/removal of articles from the cache is controlled by the
4186 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4187 variables.  Both are lists of symbols.  The first is @code{(ticked
4188 dormant)} by default, meaning that ticked and dormant articles will be
4189 put in the cache.  The latter is @code{(read)} by default, meaning that
4190 articles that are marked as read are removed from the cache.  Possibly
4191 symbols in these two lists are @code{ticked}, @code{dormant},
4192 @code{unread} and @code{read}.
4193
4194 @findex gnus-jog-cache
4195 So where does the massive article-fetching and storing come into the
4196 picture?  The @code{gnus-jog-cache} command will go through all
4197 subscribed newsgroups, request all unread articles, and store them in
4198 the cache.  You should only ever, ever ever ever, use this command if 1)
4199 your connection to the @sc{nntp} server is really, really, really slow
4200 and 2) you have a really, really, really huge disk.  Seriously.
4201
4202 @vindex gnus-uncacheable-groups
4203 It is likely that you do not want caching on some groups.  For instance,
4204 if your @code{nnml} mail is located under your home directory, it makes no
4205 sense to cache it somewhere else under your home directory.  Unless you
4206 feel that it's neat to use twice as much space.  To limit the caching,
4207 you could set the @code{gnus-uncacheable-groups} regexp to
4208 @samp{^nnml}, for instance.  This variable is @code{nil} by
4209 default.
4210
4211 @findex gnus-cache-generate-nov-databases
4212 @findex gnus-cache-generate-active
4213 @vindex gnus-cache-active-file
4214 The cache stores information on what articles it contains in its active
4215 file (@code{gnus-cache-active-file}).  If this file (or any other parts
4216 of the cache) becomes all messed up for some reason or other, Gnus
4217 offers two functions that will try to set things right.  @kbd{M-x
4218 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4219 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4220 file.
4221
4222
4223 @node Persistent Articles
4224 @section Persistent Articles
4225 @cindex persistent articles
4226
4227 Closely related to article caching, we have @dfn{persistent articles}.
4228 In fact, it's just a different way of looking at caching, and much more
4229 useful in my opinion.
4230
4231 Say you're reading a newsgroup, and you happen on to some valuable gem
4232 that you want to keep and treasure forever.  You'd normally just save it
4233 (using one of the many saving commands) in some file.  The problem with
4234 that is that it's just, well, yucky.  Ideally you'd prefer just having
4235 the article remain in the group where you found it forever; untouched by
4236 the expiry going on at the news server.
4237
4238 This is what a @dfn{persistent article} is---an article that just won't
4239 be deleted.  It's implemented using the normal cache functions, but
4240 you use two explicit commands for managing persistent articles:
4241
4242 @table @kbd
4243
4244 @item *
4245 @kindex * (Summary)
4246 @findex gnus-cache-enter-article
4247 Make the current article persistent (@code{gnus-cache-enter-article}). 
4248
4249 @item M-*
4250 @kindex M-* (Summary)
4251 @findex gnus-cache-remove-article
4252 Remove the current article from the persistent articles
4253 (@code{gnus-cache-remove-article}).  This will normally delete the
4254 article. 
4255 @end table
4256
4257 Both these commands understand the process/prefix convention. 
4258
4259 To avoid having all ticked articles (and stuff) entered into the cache,
4260 you should set @code{gnus-use-cache} to @code{passive} if you're just
4261 interested in persistent articles:
4262
4263 @lisp
4264 (setq gnus-use-cache 'passive)
4265 @end lisp
4266
4267
4268 @node Article Backlog
4269 @section Article Backlog
4270 @cindex backlog
4271 @cindex article backlog
4272
4273 If you have a slow connection, but the idea of using caching seems
4274 unappealing to you (and it is, really), you can help the situation some
4275 by switching on the @dfn{backlog}.  This is where Gnus will buffer
4276 already read articles so that it doesn't have to re-fetch articles
4277 you've already read.  This only helps if you are in the habit of
4278 re-selecting articles you've recently read, of course.  If you never do
4279 that, turning the backlog on will slow Gnus down a little bit, and
4280 increase memory usage some.
4281
4282 @vindex gnus-keep-backlog
4283 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
4284 at most @var{n} old articles in a buffer for later re-fetching.  If this
4285 variable is non-@code{nil} and is not a number, Gnus will store
4286 @emph{all} read articles, which means that your Emacs will grow without
4287 bound before exploding and taking your machine down with you.  I put
4288 that in there just to keep y'all on your toes.  
4289
4290 This variable is @code{nil} by default.
4291
4292
4293 @node Saving Articles
4294 @section Saving Articles
4295 @cindex saving articles
4296
4297 Gnus can save articles in a number of ways.  Below is the documentation
4298 for saving articles in a fairly straight-forward fashion (i.e., little
4299 processing of the article is done before it is saved).  For a different
4300 approach (uudecoding, unsharing) you should use @code{gnus-uu}
4301 (@pxref{Decoding Articles}).
4302
4303 @vindex gnus-save-all-headers
4304 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
4305 unwanted headers before saving the article.
4306
4307 @vindex gnus-saved-headers
4308 If the preceding variable is @code{nil}, all headers that match the
4309 @code{gnus-saved-headers} regexp will be kept, while the rest will be
4310 deleted before saving.
4311
4312 @table @kbd
4313
4314 @item O o
4315 @itemx o
4316 @kindex O o (Summary)
4317 @kindex o (Summary)
4318 @findex gnus-summary-save-article
4319 Save the current article using the default article saver
4320 (@code{gnus-summary-save-article}). 
4321
4322 @item O m
4323 @kindex O m (Summary)
4324 @findex gnus-summary-save-article-mail
4325 Save the current article in mail format
4326 (@code{gnus-summary-save-article-mail}). 
4327
4328 @item O r
4329 @kindex O r (Summary)
4330 @findex gnus-summary-save-article-rmail
4331 Save the current article in rmail format
4332 (@code{gnus-summary-save-article-rmail}). 
4333
4334 @item O f
4335 @kindex O f (Summary)
4336 @findex gnus-summary-save-article-file
4337 Save the current article in plain file format
4338 (@code{gnus-summary-save-article-file}). 
4339
4340 @item O b
4341 @kindex O b (Summary)
4342 @findex gnus-summary-save-article-body-file
4343 Save the current article body in plain file format
4344 (@code{gnus-summary-save-article-body-file}). 
4345
4346 @item O h
4347 @kindex O h (Summary)
4348 @findex gnus-summary-save-article-folder
4349 Save the current article in mh folder format
4350 (@code{gnus-summary-save-article-folder}). 
4351
4352 @item O v
4353 @kindex O v (Summary)
4354 @findex gnus-summary-save-article-vm
4355 Save the current article in a VM folder
4356 (@code{gnus-summary-save-article-vm}).
4357
4358 @item O p
4359 @kindex O p (Summary)
4360 @findex gnus-summary-pipe-output
4361 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
4362 the current article to a process (@code{gnus-summary-pipe-output}).
4363 @end table
4364
4365 @vindex gnus-prompt-before-saving
4366 All these commands use the process/prefix convention
4367 (@pxref{Process/Prefix}).  If you save bunches of articles using these
4368 functions, you might get tired of being prompted for files to save each
4369 and every article in.  The prompting action is controlled by
4370 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
4371 default, giving you that excessive prompting action you know and
4372 loathe.  If you set this variable to @code{t} instead, you'll be prompted
4373 just once for each series of articles you save.  If you like to really
4374 have Gnus do all your thinking for you, you can even set this variable
4375 to @code{nil}, which means that you will never be prompted for files to
4376 save articles in.  Gnus will simply save all the articles in the default
4377 files. 
4378
4379
4380 @vindex gnus-default-article-saver
4381 You can customize the @code{gnus-default-article-saver} variable to make
4382 Gnus do what you want it to.  You can use any of the four ready-made
4383 functions below, or you can create your own.
4384
4385 @table @code
4386
4387 @item gnus-summary-save-in-rmail
4388 @findex gnus-summary-save-in-rmail
4389 @vindex gnus-rmail-save-name
4390 @findex gnus-plain-save-name
4391 This is the default format, @dfn{babyl}.  Uses the function in the
4392 @code{gnus-rmail-save-name} variable to get a file name to save the
4393 article in.  The default is @code{gnus-plain-save-name}.
4394
4395 @item gnus-summary-save-in-mail
4396 @findex gnus-summary-save-in-mail
4397 @vindex gnus-mail-save-name
4398 Save in a Unix mail (mbox) file.  Uses the function in the
4399 @code{gnus-mail-save-name} variable to get a file name to save the
4400 article in.  The default is @code{gnus-plain-save-name}.
4401
4402 @item gnus-summary-save-in-file
4403 @findex gnus-summary-save-in-file
4404 @vindex gnus-file-save-name
4405 @findex gnus-numeric-save-name
4406 Append the article straight to an ordinary file.  Uses the function in
4407 the @code{gnus-file-save-name} variable to get a file name to save the
4408 article in.  The default is @code{gnus-numeric-save-name}.
4409
4410 @item gnus-summary-save-body-in-file
4411 @findex gnus-summary-save-body-in-file
4412 Append the article body to an ordinary file.  Uses the function in the
4413 @code{gnus-file-save-name} variable to get a file name to save the
4414 article in.  The default is @code{gnus-numeric-save-name}.
4415
4416 @item gnus-summary-save-in-folder
4417 @findex gnus-summary-save-in-folder
4418 @findex gnus-folder-save-name
4419 @findex gnus-Folder-save-name
4420 @vindex gnus-folder-save-name
4421 @cindex rcvstore
4422 @cindex MH folders
4423 Save the article to an MH folder using @code{rcvstore} from the MH
4424 library.  Uses the function in the @code{gnus-folder-save-name} variable
4425 to get a file name to save the article in.  The default is
4426 @code{gnus-folder-save-name}, but you can also use
4427 @code{gnus-Folder-save-name}.  The former creates capitalized names, and
4428 the latter does not.
4429
4430 @item gnus-summary-save-in-vm
4431 @findex gnus-summary-save-in-vm
4432 Save the article in a VM folder.  You have to have the VM mail
4433 reader to use this setting.
4434 @end table
4435
4436 @vindex gnus-article-save-directory
4437 All of these functions, except for the last one, will save the article
4438 in the @code{gnus-article-save-directory}, which is initialized from the
4439 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
4440 default. 
4441
4442 As you can see above, the functions use different functions to find a
4443 suitable name of a file to save the article in.  Below is a list of
4444 available functions that generate names:
4445
4446 @table @code
4447
4448 @item gnus-Numeric-save-name
4449 @findex gnus-Numeric-save-name
4450 Generates file names that look like @file{~/News/Alt.andrea-dworkin/45}.
4451
4452 @item gnus-numeric-save-name
4453 @findex gnus-numeric-save-name
4454 Generates file names that look like @file{~/News/alt.andrea-dworkin/45}.
4455
4456 @item gnus-Plain-save-name
4457 @findex gnus-Plain-save-name
4458 Generates file names that look like @file{~/News/Alt.andrea-dworkin}.
4459
4460 @item gnus-plain-save-name
4461 @findex gnus-plain-save-name
4462 Generates file names that look like @file{~/News/alt.andrea-dworkin}.
4463 @end table
4464
4465 @vindex gnus-split-methods
4466 You can have Gnus suggest where to save articles by plonking a regexp into
4467 the @code{gnus-split-methods} alist.  For instance, if you would like to
4468 save articles related to Gnus in the file @file{gnus-stuff}, and articles
4469 related to VM in @code{vm-stuff}, you could set this variable to something
4470 like:
4471
4472 @lisp
4473 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
4474  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
4475  (my-choosing-function "../other-dir/my-stuff")
4476  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
4477 @end lisp
4478
4479 We see that this is a list where each element is a list that has two
4480 elements---the @dfn{match} and the @dfn{file}.  The match can either be
4481 a string (in which case it is used as a regexp to match on the article
4482 head); it can be a symbol (which will be called as a function); or it
4483 can be a list (which will be @code{eval}ed).  If any of these actions
4484 have a non-@code{nil} result, the @dfn{file} will be used as a default
4485 prompt.  In addition, the result of the operation itself will be used if
4486 the function or form called returns a string or a list of strings. 
4487
4488 You basically end up with a list of file names that might be used when
4489 saving the current article.  (All ``matches'' will be used.)  You will
4490 then be prompted for what you really want to use as a name, with file
4491 name completion over the results from applying this variable.
4492
4493 This variable is @code{((gnus-article-archive-name))} by default, which
4494 means that Gnus will look at the articles it saves for an
4495 @code{Archive-name} line and use that as a suggestion for the file
4496 name. 
4497
4498 @vindex gnus-use-long-file-name
4499 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
4500 @code{nil}, all the preceding functions will replace all periods
4501 (@samp{.}) in the group names with slashes (@samp{/})---which means that
4502 the functions will generate hierarchies of directories instead of having
4503 all the files in the toplevel directory
4504 (@file{~/News/alt/andrea-dworkin} instead of
4505 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
4506 on most systems.  However, for historical reasons, this is @code{nil} on
4507 Xenix and usg-unix-v machines by default.
4508
4509 This function also affects kill and score file names.  If this variable
4510 is a list, and the list contains the element @code{not-score}, long file
4511 names will not be used for score files, if it contains the element
4512 @code{not-save}, long file names will not be used for saving, and if it
4513 contains the element @code{not-kill}, long file names will not be used
4514 for kill files.
4515
4516 If you'd like to save articles in a hierarchy that looks something like
4517 a spool, you could
4518
4519 @lisp
4520 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
4521 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
4522 @end lisp
4523
4524 Then just save with @kbd{o}.  You'd then read this hierarchy with
4525 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
4526 the toplevel directory as the argument (@file{~/News/}).  Then just walk
4527 around to the groups/directories with @code{nneething}.
4528
4529
4530 @node Decoding Articles
4531 @section Decoding Articles
4532 @cindex decoding articles
4533
4534 Sometime users post articles (or series of articles) that have been
4535 encoded in some way or other.  Gnus can decode them for you.
4536
4537 @menu 
4538 * Uuencoded Articles::    Uudecode articles.
4539 * Shared Articles::       Unshar articles.
4540 * PostScript Files::      Split PostScript.
4541 * Decoding Variables::    Variables for a happy decoding.
4542 * Viewing Files::         You want to look at the result of the decoding?
4543 @end menu
4544
4545 All these functions use the process/prefix convention
4546 (@pxref{Process/Prefix}) for finding out what articles to work on, with
4547 the extension that a ``single article'' means ``a single series''.  Gnus
4548 can find out by itself what articles belong to a series, decode all the
4549 articles and unpack/view/save the resulting file(s).
4550
4551 Gnus guesses what articles are in the series according to the following
4552 simplish rule: The subjects must be (nearly) identical, except for the
4553 last two numbers of the line.  (Spaces are largely ignored, however.)
4554
4555 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
4556 will find all the articles that match the regexp @samp{^cat.gif
4557 ([0-9]+/[0-9]+).*$}.  
4558
4559 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
4560 series}, will not be properly recognized by any of the automatic viewing
4561 commands, and you have to mark the articles manually with @kbd{#}.
4562
4563
4564 @node Uuencoded Articles
4565 @subsection Uuencoded Articles
4566 @cindex uudecode
4567 @cindex uuencoded articles
4568
4569 @table @kbd
4570
4571 @item X u
4572 @kindex X u (Summary)
4573 @findex gnus-uu-decode-uu
4574 Uudecodes the current series (@code{gnus-uu-decode-uu}).
4575
4576 @item X U
4577 @kindex X U (Summary)
4578 @findex gnus-uu-decode-uu-and-save
4579 Uudecodes and saves the current series
4580 (@code{gnus-uu-decode-uu-and-save}).
4581
4582 @item X v u
4583 @kindex X v u (Summary)
4584 @findex gnus-uu-decode-uu-view
4585 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
4586
4587 @item X v U
4588 @kindex X v U (Summary)
4589 @findex gnus-uu-decode-uu-and-save-view
4590 Uudecodes, views and saves the current series
4591 (@code{gnus-uu-decode-uu-and-save-view}). 
4592 @end table
4593
4594 Remember that these all react to the presence of articles marked with
4595 the process mark.  If, for instance, you'd like to decode and save an
4596 entire newsgroup, you'd typically do @kbd{M P a}
4597 (@code{gnus-uu-mark-all}) and then @kbd{X U}
4598 (@code{gnus-uu-decode-uu-and-save}).
4599
4600 All this is very much different from how @code{gnus-uu} worked with
4601 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
4602 the sun.  This version of @code{gnus-uu} generally assumes that you mark
4603 articles in some way (@pxref{Setting Process Marks}) and then press
4604 @kbd{X u}.
4605
4606 @vindex gnus-uu-notify-files
4607 Note: When trying to decode articles that have names matching
4608 @code{gnus-uu-notify-files}, which is hard-coded to
4609 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
4610 automatically post an article on @samp{comp.unix.wizards} saying that
4611 you have just viewed the file in question.  This feature can't be turned
4612 off.
4613
4614
4615 @node Shared Articles
4616 @subsection Shared Articles
4617 @cindex unshar
4618 @cindex shared articles
4619
4620 @table @kbd
4621
4622 @item X s
4623 @kindex X s (Summary)
4624 @findex gnus-uu-decode-unshar
4625 Unshars the current series (@code{gnus-uu-decode-unshar}).
4626
4627 @item X S
4628 @kindex X S (Summary)
4629 @findex gnus-uu-decode-unshar-and-save
4630 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
4631
4632 @item X v s
4633 @kindex X v s (Summary)
4634 @findex gnus-uu-decode-unshar-view
4635 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
4636
4637 @item X v S
4638 @kindex X v S (Summary)
4639 @findex gnus-uu-decode-unshar-and-save-view
4640 Unshars, views and saves the current series
4641 (@code{gnus-uu-decode-unshar-and-save-view}). 
4642 @end table
4643
4644
4645 @node PostScript Files
4646 @subsection PostScript Files
4647 @cindex PostScript
4648
4649 @table @kbd
4650
4651 @item X p
4652 @kindex X p (Summary)
4653 @findex gnus-uu-decode-postscript
4654 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
4655
4656 @item X P
4657 @kindex X P (Summary)
4658 @findex gnus-uu-decode-postscript-and-save
4659 Unpack and save the current PostScript series
4660 (@code{gnus-uu-decode-postscript-and-save}).
4661
4662 @item X v p
4663 @kindex X v p (Summary)
4664 @findex gnus-uu-decode-postscript-view
4665 View the current PostScript series
4666 (@code{gnus-uu-decode-postscript-view}).
4667
4668 @item X v P
4669 @kindex X v P (Summary)
4670 @findex gnus-uu-decode-postscript-and-save-view
4671 View and save the current PostScript series
4672 (@code{gnus-uu-decode-postscript-and-save-view}). 
4673 @end table
4674
4675
4676 @node Decoding Variables
4677 @subsection Decoding Variables
4678
4679 Adjective, not verb.
4680
4681 @menu 
4682 * Rule Variables::          Variables that say how a file is to be viewed.
4683 * Other Decode Variables::  Other decode variables.
4684 * Uuencoding and Posting::  Variables for customizing uuencoding.
4685 @end menu
4686
4687
4688 @node Rule Variables
4689 @subsubsection Rule Variables
4690 @cindex rule variables
4691
4692 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
4693 variables are on the form
4694   
4695 @lisp
4696       (list '(regexp1 command2)
4697             '(regexp2 command2)
4698             ...)
4699 @end lisp
4700
4701 @table @code
4702
4703 @item gnus-uu-user-view-rules
4704 @vindex gnus-uu-user-view-rules
4705 @cindex sox
4706 This variable is consulted first when viewing files.  If you wish to use,
4707 for instance, @code{sox} to convert an @samp{.au} sound file, you could
4708 say something like:
4709 @lisp
4710        (setq gnus-uu-user-view-rules
4711          (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
4712 @end lisp
4713
4714 @item gnus-uu-user-view-rules-end
4715 @vindex gnus-uu-user-view-rules-end
4716 This variable is consulted if Gnus couldn't make any matches from the
4717 user and default view rules.
4718
4719 @item gnus-uu-user-archive-rules
4720 @vindex gnus-uu-user-archive-rules
4721 This variable can be used to say what commands should be used to unpack
4722 archives.
4723 @end table
4724
4725
4726 @node Other Decode Variables
4727 @subsubsection Other Decode Variables
4728
4729 @table @code
4730 @vindex gnus-uu-grabbed-file-functions
4731
4732 @item gnus-uu-grabbed-file-functions
4733 All functions in this list will be called right each file has been
4734 successfully decoded---so that you can move or view files right away,
4735 and don't have to wait for all files to be decoded before you can do
4736 anything.  Ready-made functions you can put in this list are:
4737
4738 @table @code
4739
4740 @item gnus-uu-grab-view
4741 @findex gnus-uu-grab-view
4742 View the file.
4743
4744 @item gnus-uu-grab-move
4745 @findex gnus-uu-grab-move
4746 Move the file (if you're using a saving function.)
4747 @end table
4748
4749 @item gnus-uu-ignore-files-by-name
4750 @vindex gnus-uu-ignore-files-by-name
4751 Files with name matching this regular expression won't be viewed.
4752
4753 @item gnus-uu-ignore-files-by-type
4754 @vindex gnus-uu-ignore-files-by-type
4755 Files with a @sc{mime} type matching this variable won't be viewed.
4756 Note that Gnus tries to guess what type the file is based on the name.
4757 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
4758 kludgey.
4759
4760 @item gnus-uu-tmp-dir
4761 @vindex gnus-uu-tmp-dir
4762 Where @code{gnus-uu} does its work.
4763
4764 @item gnus-uu-do-not-unpack-archives
4765 @vindex gnus-uu-do-not-unpack-archives
4766 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
4767 looking for files to display.
4768
4769 @item gnus-uu-view-and-save
4770 @vindex gnus-uu-view-and-save
4771 Non-@code{nil} means that the user will always be asked to save a file
4772 after viewing it.
4773
4774 @item gnus-uu-ignore-default-view-rules
4775 @vindex gnus-uu-ignore-default-view-rules
4776 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
4777 rules.
4778
4779 @item gnus-uu-ignore-default-archive-rules
4780 @vindex gnus-uu-ignore-default-archive-rules
4781 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
4782 unpacking commands.
4783
4784 @item gnus-uu-kill-carriage-return
4785 @vindex gnus-uu-kill-carriage-return
4786 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
4787 from articles.
4788
4789 @item gnus-uu-unmark-articles-not-decoded
4790 @vindex gnus-uu-unmark-articles-not-decoded
4791 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
4792 unsuccessfully decoded as unread.
4793
4794 @item gnus-uu-correct-stripped-uucode
4795 @vindex gnus-uu-correct-stripped-uucode
4796 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
4797 uuencoded files that have had trailing spaces deleted.
4798
4799 @item gnus-uu-view-with-metamail
4800 @vindex gnus-uu-view-with-metamail
4801 @cindex metamail
4802 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
4803 commands defined by the rule variables and just fudge a @sc{mime}
4804 content type based on the file name.  The result will be fed to
4805 @code{metamail} for viewing.
4806
4807 @item gnus-uu-save-in-digest
4808 @vindex gnus-uu-save-in-digest
4809 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
4810 decoding, will save in digests.  If this variable is @code{nil},
4811 @code{gnus-uu} will just save everything in a file without any
4812 embellishments.  The digesting almost conforms to RFC1153---no easy way
4813 to specify any meaningful volume and issue numbers were found, so I
4814 simply dropped them.
4815
4816 @end table
4817
4818
4819 @node Uuencoding and Posting
4820 @subsubsection Uuencoding and Posting
4821
4822 @table @code
4823
4824 @item gnus-uu-post-include-before-composing
4825 @vindex gnus-uu-post-include-before-composing
4826 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
4827 before you compose the article.  If this variable is @code{t}, you can
4828 either include an encoded file with @kbd{C-c C-i} or have one included
4829 for you when you post the article.
4830
4831 @item gnus-uu-post-length
4832 @vindex gnus-uu-post-length
4833 Maximum length of an article.  The encoded file will be split into how
4834 many articles it takes to post the entire file.
4835
4836 @item gnus-uu-post-threaded
4837 @vindex gnus-uu-post-threaded
4838 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
4839 thread.  This may not be smart, as no other decoder I have seen are able
4840 to follow threads when collecting uuencoded articles.  (Well, I have
4841 seen one package that does that---@code{gnus-uu}, but somehow, I don't
4842 think that counts...) Default is @code{nil}.
4843
4844 @item gnus-uu-post-separate-description
4845 @vindex gnus-uu-post-separate-description
4846 Non-@code{nil} means that the description will be posted in a separate
4847 article.  The first article will typically be numbered (0/x).  If this
4848 variable is @code{nil}, the description the user enters will be included
4849 at the beginning of the first article, which will be numbered (1/x).
4850 Default is @code{t}.
4851
4852 @end table
4853
4854
4855 @node Viewing Files
4856 @subsection Viewing Files
4857 @cindex viewing files
4858 @cindex pseudo-articles
4859
4860 After decoding, if the file is some sort of archive, Gnus will attempt
4861 to unpack the archive and see if any of the files in the archive can be
4862 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
4863 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
4864 uncompress and de-tar the main file, and then view the two pictures.
4865 This unpacking process is recursive, so if the archive contains archives
4866 of archives, it'll all be unpacked.
4867
4868 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
4869 extracted file into the summary buffer.  If you go to these
4870 ``articles'', you will be prompted for a command to run (usually Gnus
4871 will make a suggestion), and then the command will be run.
4872
4873 @vindex gnus-view-pseudo-asynchronously
4874 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
4875 until the viewing is done before proceeding.
4876
4877 @vindex gnus-view-pseudos
4878 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
4879 the pseudo-articles into the summary buffer, but view them
4880 immediately.  If this variable is @code{not-confirm}, the user won't even
4881 be asked for a confirmation before viewing is done.
4882
4883 @vindex gnus-view-pseudos-separately 
4884 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
4885 pseudo-article will be created for each file to be viewed.  If
4886 @code{nil}, all files that use the same viewing command will be given as
4887 a list of parameters to that command.
4888
4889 @vindex gnus-insert-pseudo-articles
4890 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
4891 pseudo-articles when decoding.  It is @code{t} by default.
4892
4893 So; there you are, reading your @emph{pseudo-articles} in your
4894 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
4895 Why isn't anything real anymore? How did we get here?
4896
4897
4898 @node Article Treatment
4899 @section Article Treatment
4900
4901 Reading through this huge manual, you may have quite forgotten that the
4902 object of newsreaders are to actually, like, read what people have
4903 written.  Reading articles.  Unfortunately, people are quite bad at
4904 writing, so there are tons of functions and variables to make reading
4905 these articles easier.
4906
4907 @menu
4908 * Article Highlighting::    You want to make the article look like fruit salad.
4909 * Article Hiding::          You also want to make certain info go away.
4910 * Article Washing::         Lots of way-neat functions to make life better.
4911 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
4912 * Article Date::            Grumble, UT!
4913 @end menu
4914
4915
4916 @node Article Highlighting
4917 @subsection Article Highlighting
4918 @cindex highlight
4919
4920 Not only do you want your article buffer to look like fruit salad, but
4921 you want it to look like technicolor fruit salad.
4922
4923 @table @kbd
4924
4925 @item W H a
4926 @kindex W H a (Summary)
4927 @findex gnus-article-highlight
4928 Highlight the current article (@code{gnus-article-highlight}).
4929
4930 @item W H h
4931 @kindex W H h (Summary)
4932 @findex gnus-article-highlight-headers
4933 @vindex gnus-header-face-alist
4934 Highlight the headers (@code{gnus-article-highlight-headers}).  The
4935 highlighting will be done according to the @code{gnus-header-face-alist}
4936 variable, which is a list where each element has the form @var{(regexp
4937 name content)}.  @var{regexp} is a regular expression for matching the
4938 header, @var{name} is the face used for highlighting the header name and
4939 @var{content} is the face for highlighting the header value.  The first
4940 match made will be used.  Note that @var{regexp} shouldn't have @samp{^}
4941 prepended---Gnus will add one.
4942
4943 @item W H c
4944 @kindex W H c (Summary)
4945 @findex gnus-article-highlight-citation
4946 Highlight cited text (@code{gnus-article-highlight-citation}). 
4947
4948 Some variables to customize the citation highlights:
4949
4950 @table @code
4951 @vindex gnus-cite-parse-max-size
4952
4953 @item gnus-cite-parse-max-size
4954 If the article size if bigger than this variable (which is 25000 by
4955 default), no citation highlighting will be performed.  
4956
4957 @item gnus-cite-prefix-regexp
4958 @vindex gnus-cite-prefix-regexp
4959 Regexp matching the longest possible citation prefix on a line. 
4960
4961 @item gnus-cite-max-prefix
4962 @vindex gnus-cite-max-prefix
4963 Maximum possible length for a citation prefix (default 20).
4964
4965 @item gnus-cite-face-list
4966 @vindex gnus-cite-face-list
4967 List of faces used for highlighting citations.  When there are citations
4968 from multiple articles in the same message, Gnus will try to give each
4969 citation from each article its own face.  This should make it easier to
4970 see who wrote what.
4971
4972 @item gnus-supercite-regexp
4973 @vindex gnus-supercite-regexp
4974 Regexp matching normal SuperCite attribution lines.  
4975
4976 @item gnus-supercite-secondary-regexp
4977 @vindex gnus-supercite-secondary-regexp
4978 Regexp matching mangled SuperCite attribution lines.
4979
4980 @item gnus-cite-minimum-match-count
4981 @vindex gnus-cite-minimum-match-count
4982 Minimum number of identical prefixes we have to see before we believe
4983 that it's a citation.
4984
4985 @item gnus-cite-attribution-prefix
4986 @vindex gnus-cite-attribution-prefix
4987 Regexp matching the beginning of an attribution line.
4988
4989 @item gnus-cite-attribution-suffix
4990 @vindex gnus-cite-attribution-suffix
4991 Regexp matching the end of an attribution line.
4992
4993 @item gnus-cite-attribution-face
4994 @vindex gnus-cite-attribution-face
4995 Face used for attribution lines.  It is merged with the face for the
4996 cited text belonging to the attribution.
4997
4998 @end table
4999
5000
5001 @item W H s
5002 @kindex W H s (Summary)
5003 @vindex gnus-signature-separator
5004 @vindex gnus-signature-face
5005 @findex gnus-article-highlight-signature
5006 Highlight the signature (@code{gnus-article-highlight-signature}).
5007 Everything after @code{gnus-signature-separator} in an article will be
5008 considered a signature and will be highlighted with
5009 @code{gnus-signature-face}, which is @code{italic} by default. 
5010
5011 @end table
5012
5013
5014 @node Article Hiding
5015 @subsection Article Hiding
5016 @cindex article hiding
5017
5018 Or rather, hiding certain things in each article.  There usually is much
5019 too much cruft in most articles.  
5020
5021 @table @kbd
5022
5023 @item W W a
5024 @kindex W W a (Summary)
5025 @findex gnus-article-hide
5026 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
5027
5028 @item W W h
5029 @kindex W W h (Summary)
5030 @findex gnus-article-hide-headers
5031 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5032 Headers}. 
5033
5034 @item W W b
5035 @kindex W W b (Summary)
5036 @findex gnus-article-hide-boring-headers
5037 Hide headers that aren't particularly interesting
5038 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5039
5040 @item W W s
5041 @kindex W W s (Summary)
5042 @findex gnus-article-hide-signature
5043 Hide signature (@code{gnus-article-hide-signature}).
5044
5045 @item W W p
5046 @kindex W W p (Summary)
5047 @findex gnus-article-hide-pgp
5048 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). 
5049
5050 @item W W c
5051 @kindex W W c (Summary)
5052 @findex gnus-article-hide-citation
5053 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5054 customizing the hiding:
5055
5056 @table @code
5057
5058 @item gnus-cite-hide-percentage
5059 @vindex gnus-cite-hide-percentage
5060 If the cited text is of a bigger percentage than this variable (default
5061 50), hide the cited text.
5062
5063 @item gnus-cite-hide-absolute
5064 @vindex gnus-cite-hide-absolute
5065 The cited text must be have at least this length (default 10) before it
5066 is hidden.
5067
5068 @item gnus-cited-text-button-line-format
5069 @vindex gnus-cited-text-button-line-format
5070 Gnus adds buttons show where the cited text has been hidden, and to
5071 allow toggle hiding the text.  The format of the variable is specified
5072 by this format-like variable.  These specs are legal:
5073
5074 @table @samp
5075 @item b
5076 Start point of the hidden text.
5077 @item e
5078 End point of the hidden text.
5079 @item l
5080 Length of the hidden text.
5081 @end table
5082
5083 @item gnus-cited-lines-visible
5084 @vindex gnus-cited-lines-visible
5085 The number of lines at the beginning of the cited text to leave shown. 
5086
5087 @end table
5088
5089 @item W W C
5090 @kindex W W C (Summary)
5091 @findex gnus-article-hide-citation-in-followups
5092 Hide cited text in articles that aren't roots
5093 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
5094 useful as an interactive command, but might be a handy function to stick
5095 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
5096
5097 @end table
5098
5099 All these ``hiding'' commands are toggles, but if you give a negative
5100 prefix to these commands, they will show what they have previously
5101 hidden.  If you give a positive prefix, they will always hide.
5102
5103 Also @pxref{Article Highlighting} for further variables for
5104 citation customization.
5105
5106 @vindex gnus-signature-limit
5107 @code{gnus-signature-limit} provides a limit to what is considered a
5108 signature.  If it is a number, no signature may not be longer (in
5109 characters) than that number.  If it is a function, the function will be
5110 called without any parameters, and if it returns @code{nil}, there is no
5111 signature in the buffer.  If it is a string, it will be used as a
5112 regexp.  If it matches, the text in question is not a signature.
5113
5114
5115 @node Article Washing
5116 @subsection Article Washing
5117 @cindex washing
5118 @cindex article washing
5119
5120 We call this ``article washing'' for a really good reason.  Namely, the
5121 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5122
5123 @dfn{Washing} is defined by us as ``changing something from something to
5124 something else'', but normally results in something looking better.
5125 Cleaner, perhaps.
5126
5127 @table @kbd
5128
5129 @item W l
5130 @kindex W l (Summary)
5131 @findex gnus-summary-stop-page-breaking
5132 Remove page breaks from the current article
5133 (@code{gnus-summary-stop-page-breaking}).
5134
5135 @item W r
5136 @kindex W r (Summary)
5137 @findex gnus-summary-caesar-message
5138 Do a Caesar rotate (rot13) on the article buffer
5139 (@code{gnus-summary-caesar-message}). 
5140
5141 @item W t
5142 @kindex W t (Summary)
5143 @findex gnus-summary-toggle-header
5144 Toggle whether to display all headers in the article buffer
5145 (@code{gnus-summary-toggle-header}). 
5146
5147 @item W v
5148 @kindex W v (Summary)
5149 @findex gnus-summary-verbose-header
5150 Toggle whether to display all headers in the article buffer permanently
5151 (@code{gnus-summary-verbose-header}).
5152
5153 @item W m
5154 @kindex W m (Summary)
5155 @findex gnus-summary-toggle-mime
5156 Toggle whether to run the article through @sc{mime} before displaying
5157 (@code{gnus-summary-toggle-mime}).
5158
5159 @item W o
5160 @kindex W o (Summary)
5161 @findex gnus-article-treat-overstrike
5162 Treat overstrike (@code{gnus-article-treat-overstrike}).
5163
5164 @item W w
5165 @kindex W w (Summary)
5166 @findex gnus-article-fill-cited-article
5167 Do word wrap (@code{gnus-article-fill-cited-article}).
5168
5169 @item W c
5170 @kindex W c (Summary)
5171 @findex gnus-article-remove-cr
5172 Remove CR (@code{gnus-article-remove-cr}).
5173
5174 @item W L
5175 @kindex W L (Summary)
5176 @findex gnus-article-remove-trailing-blank-lines
5177 Remove all blank lines at the end of the article
5178 (@code{gnus-article-remove-trailing-blank-lines}).
5179
5180 @item W q
5181 @kindex W q (Summary)
5182 @findex gnus-article-de-quoted-unreadable
5183 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5184
5185 @item W f
5186 @kindex W f (Summary)
5187 @cindex x-face
5188 @findex gnus-article-display-x-face
5189 @findex gnus-article-x-face-command
5190 @vindex gnus-article-x-face-command
5191 @vindex gnus-article-x-face-too-ugly
5192 Look for and display any X-Face headers
5193 (@code{gnus-article-display-x-face}).  The command executed by this
5194 function is given by the @code{gnus-article-x-face-command} variable.  If
5195 this variable is a string, this string will be executed in a sub-shell.
5196 If it is a function, this function will be called with the face as the
5197 argument.  If the @code{gnus-article-x-face-too-ugly} (which is a regexp)
5198 matches the @code{From} header, the face will not be shown.  The default
5199 action under Emacs is to fork off an @code{xv} to view the face; under
5200 XEmacs the default action is to display the face after the @code{From}
5201 header. 
5202
5203 @item W b
5204 @kindex W b (Summary)
5205 @findex gnus-article-add-buttons
5206 Add clickable buttons to the article (@code{gnus-article-add-buttons}). 
5207
5208 @item W B
5209 @kindex W B (Summary)
5210 @findex gnus-article-add-buttons-to-head
5211 Add clickable buttons to the article headers
5212 (@code{gnus-article-add-buttons-to-head}).  
5213
5214 @end table
5215
5216
5217 @node Article Buttons
5218 @subsection Article Buttons
5219 @cindex buttons
5220
5221 People often include references to other stuff in articles, and it would
5222 be nice if Gnus could just fetch whatever it is that people talk about
5223 with the minimum of fuzz.
5224
5225 Gnus adds @dfn{buttons} to certain standard references by default:
5226 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
5227 two variables, one that handles article bodies and one that handles
5228 article heads:
5229
5230 @table @code
5231
5232 @item gnus-button-alist
5233 @vindex gnus-button-alist
5234 This is an alist where each entry has this form:
5235
5236 @lisp
5237 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
5238 @end lisp
5239
5240 @table @var
5241
5242 @item regexp
5243 All text that match this regular expression will be considered an
5244 external reference.  Here's a typical regexp that match embedded URLs:
5245 @samp{<URL:\\([^\n\r>]*\\)>}. 
5246
5247 @item button-par
5248 Gnus has to know which parts of the match is to be highlighted.  This is
5249 a number that says what sub-expression of the regexp that is to be
5250 highlighted.  If you want it all highlighted, you use @code{0} here.
5251
5252 @item use-p
5253 This form will be @code{eval}ed, and if the result is non-@code{nil},
5254 this is considered a match.  This is useful if you want extra sifting to
5255 avoid false matches.
5256
5257 @item function
5258 This function will be called when you click on this button.
5259
5260 @item data-par
5261 As with @var{button-par}, this is a sub-expression number, but this one
5262 says which part of the match is to be sent as data to @var{function}. 
5263
5264 @end table
5265
5266 So the full entry for buttonizing URLs is then
5267
5268 @lisp
5269 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
5270 @end lisp
5271
5272 @item gnus-header-button-alist
5273 @vindex gnus-header-button-alist
5274 This is just like the other alist, except that it is applied to the
5275 article head only, and that each entry has an additional element that is
5276 used to say what headers to apply the buttonize coding to:
5277
5278 @lisp
5279 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
5280 @end lisp
5281
5282 @var{header} is a regular expression.
5283
5284 @item gnus-button-url-regexp
5285 @vindex gnus-button-url-regexp
5286 A regular expression that matches embedded URLs.  It is used in the
5287 default values of the variables above.
5288
5289 @item gnus-article-button-face
5290 @vindex gnus-article-button-face
5291 Face used on bottons.
5292
5293 @item gnus-article-mouse-face
5294 @vindex gnus-article-mouse-face
5295 Face is used when the mouse cursor is over a button.
5296
5297 @end table
5298
5299
5300 @node Article Date
5301 @subsection Article Date
5302
5303 The date is most likely generated in some obscure timezone you've never
5304 heard of, so it's quite nice to be able to find out what the time was
5305 when the article was sent.
5306
5307 @table @kbd
5308
5309 @item W T u
5310 @kindex W T u (Summary)
5311 @findex gnus-article-date-ut
5312 Display the date in UT (aka. GMT, aka ZULU)
5313 (@code{gnus-article-date-ut}). 
5314
5315 @item W T l
5316 @kindex W T l (Summary)
5317 @findex gnus-article-date-local
5318 Display the date in the local timezone (@code{gnus-article-date-local}).
5319
5320 @item W T e
5321 @kindex W T e (Summary)
5322 @findex gnus-article-date-lapsed
5323 Say how much time has (e)lapsed between the article was posted and now
5324 (@code{gnus-article-date-lapsed}).
5325
5326 @item W T o
5327 @kindex W T o (Summary)
5328 @findex gnus-article-date-original
5329 Display the original date (@code{gnus-article-date-original}).  This can
5330 be useful if you normally use some other conversion function and is
5331 worried that it might be doing something totally wrong.  Say, claiming
5332 that the article was posted in 1854.  Although something like that is
5333 @emph{totally} impossible.  Don't you trust me? *titter*
5334
5335 @end table
5336
5337
5338 @node Summary Sorting
5339 @section Summary Sorting
5340 @cindex summary sorting
5341
5342 You can have the summary buffer sorted in various ways, even though I
5343 can't really see why you'd want that.
5344
5345 @table @kbd
5346
5347 @item C-c C-s C-n
5348 @kindex C-c C-s C-n (Summary)
5349 @findex gnus-summary-sort-by-number
5350 Sort by article number (@code{gnus-summary-sort-by-number}).
5351
5352 @item C-c C-s C-a
5353 @kindex C-c C-s C-a (Summary)
5354 @findex gnus-summary-sort-by-author
5355 Sort by author (@code{gnus-summary-sort-by-author}).
5356
5357 @item C-c C-s C-s
5358 @kindex C-c C-s C-s (Summary)
5359 @findex gnus-summary-sort-by-subject
5360 Sort by subject (@code{gnus-summary-sort-by-subject}).
5361
5362 @item C-c C-s C-d
5363 @kindex C-c C-s C-d (Summary)
5364 @findex gnus-summary-sort-by-date
5365 Sort by date (@code{gnus-summary-sort-by-date}).
5366
5367 @item C-c C-s C-i
5368 @kindex C-c C-s C-i (Summary)
5369 @findex gnus-summary-sort-by-score
5370 Sort by score (@code{gnus-summary-sort-by-score}).
5371 @end table
5372
5373 These functions will work both when you use threading and when you don't
5374 use threading.  In the latter case, all summary lines will be sorted,
5375 line by line.  In the former case, sorting will be done on a
5376 root-by-root basis, which might not be what you were looking for.  To
5377 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
5378 Commands}).
5379
5380
5381 @node Finding the Parent
5382 @section Finding the Parent
5383 @cindex parent articles
5384 @cindex referring articles
5385
5386 @findex gnus-summary-refer-parent-article
5387 @kindex ^ (Summary)
5388 If you'd like to read the parent of the current article, and it is not
5389 displayed in the summary buffer, you might still be able to.  That is,
5390 if the current group is fetched by @sc{nntp}, the parent hasn't expired
5391 and the @code{References} in the current article are not mangled, you
5392 can just press @kbd{^} or @kbd{A r}
5393 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
5394 you'll get the parent.  If the parent is already displayed in the
5395 summary buffer, point will just move to this article.
5396
5397 @findex gnus-summary-refer-references
5398 @kindex A R (Summary)
5399 You can have Gnus fetch all articles mentioned in the @code{References}
5400 header of the article by pushing @kbd{A R}
5401 (@code{gnus-summary-refer-references}). 
5402
5403 @findex gnus-summary-refer-article
5404 @kindex M-^ (Summary)
5405 You can also ask the @sc{nntp} server for an arbitrary article, no
5406 matter what group it belongs to.  @kbd{M-^}
5407 (@code{gnus-summary-refer-article}) will ask you for a
5408 @code{Message-ID}, which is one of those long thingies that look
5409 something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You have to get
5410 it all exactly right.  No fuzzy searches, I'm afraid.
5411
5412 @vindex gnus-refer-article-method
5413 If the group you are reading is located on a backend that does not
5414 support fetching by @code{Message-ID} very well (like @code{nnspool}),
5415 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
5416 would, perhaps, be best if the @sc{nntp} server you consult is the same
5417 as the one that keeps the spool you are reading from updated, but that's
5418 not really necessary.
5419
5420 Most of the mail backends support fetching by @code{Message-ID}, but do
5421 not do a particularly excellent job of it.  That is, @code{nnmbox} and
5422 @code{nnbabyl} are able to locate articles from any groups, while
5423 @code{nnml} and @code{nnfolder} are only able to locate articles that
5424 have been posted to the current group.  (Anything else would be too time
5425 consuming.)  @code{nnmh} does not support this at all.
5426
5427
5428 @node Alternative Approaches
5429 @section Alternative Approaches
5430
5431 Different people like to read news using different methods.  This being
5432 Gnus, we offer a small selection of minor modes for the summary buffers.
5433
5434 @menu
5435 * Pick and Read::               First mark articles and then read them.
5436 * Binary Groups::               Auto-decode all articles.
5437 @end menu
5438
5439
5440 @node Pick and Read
5441 @subsection Pick and Read
5442 @cindex pick and read
5443
5444 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
5445 reading interface.  The user first marks the articles she wants to read
5446 from a summary buffer.  Then she starts reading the articles with just
5447 an article buffer displayed.
5448
5449 @findex gnus-pick-mode
5450 @kindex M-x gnus-pick-mode
5451 Gnus provides a summary buffer minor mode that allows
5452 this---@code{gnus-pick-mode}.  This basically means that a few process
5453 mark commands become one-keystroke commands to allow easy marking, and
5454 it makes one additional command for switching to the summary buffer
5455 available. 
5456
5457 Here are the available keystrokes when using pick mode:
5458
5459 @table @kbd
5460 @item SPACE
5461 @kindex SPACE (Pick)
5462 @findex gnus-summary-mark-as-processable
5463 Pick the article (@code{gnus-summary-mark-as-processable}). 
5464
5465 @item u
5466 @kindex u (Pick)
5467 @findex gnus-summary-unmark-as-processable
5468 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
5469
5470 @item U
5471 @kindex U (Pick)
5472 @findex gnus-summary-unmark-all-processable
5473 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
5474
5475 @item t
5476 @kindex t (Pick)
5477 @findex gnus-uu-mark-thread
5478 Pick the thread (@code{gnus-uu-mark-thread}). 
5479
5480 @item T
5481 @kindex T (Pick)
5482 @findex gnus-uu-unmark-thread
5483 Unpick the thread (@code{gnus-uu-unmark-thread}). 
5484
5485 @item r
5486 @kindex r (Pick)
5487 @findex gnus-uu-mark-region
5488 Pick the region (@code{gnus-uu-mark-region}). 
5489
5490 @item R
5491 @kindex R (Pick)
5492 @findex gnus-uu-unmark-region
5493 Unpick the region (@code{gnus-uu-unmark-region}). 
5494
5495 @item e
5496 @kindex e (Pick)
5497 @findex gnus-uu-mark-by-regexp
5498 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
5499
5500 @item E
5501 @kindex E (Pick)
5502 @findex gnus-uu-unmark-by-regexp
5503 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
5504
5505 @item b
5506 @kindex b (Pick)
5507 @findex gnus-uu-mark-buffer
5508 Pick the buffer (@code{gnus-uu-mark-buffer}). 
5509
5510 @item B
5511 @kindex B (Pick)
5512 @findex gnus-uu-unmark-buffer
5513 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
5514
5515 @item RET
5516 @kindex RET (Pick)
5517 @findex gnus-pick-start-reading
5518 @vindex gnus-pick-display-summary
5519 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
5520 given a prefix, mark all unpicked articles as read first.  If
5521 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
5522 will still be visible when you are reading.
5523
5524 @end table
5525
5526 If this sounds like a good idea to you, you could say:
5527
5528 @lisp
5529 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
5530 @end lisp
5531
5532 @vindex gnus-pick-mode-hook
5533 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
5534
5535
5536 @node Binary Groups
5537 @subsection Binary Groups
5538 @cindex binary groups
5539
5540 @findex gnus-binary-mode
5541 @kindex M-x gnus-binary-mode
5542 If you spend much time in binary groups, you may grow tired of hitting
5543 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
5544 is a minor mode for summary buffers that makes all ordinary Gnus article
5545 selection functions uudecode series of articles and display the result
5546 instead of just displaying the articles the normal way.  
5547
5548 @kindex g (Binary)
5549 @findex gnus-binary-show-article
5550 In fact, the only way to see the actual articles if you have turned this
5551 mode on is the @kbd{g} command (@code{gnus-binary-show-article}). 
5552
5553 @vindex gnus-binary-mode-hook
5554 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
5555
5556
5557 @node Tree Display
5558 @section Tree Display
5559 @cindex trees
5560
5561 @vindex gnus-use-trees
5562 If you don't like the normal Gnus summary display, you might try setting
5563 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
5564 additional @dfn{tree buffer}.  You can execute all summary mode commands
5565 in the tree buffer.  
5566
5567 There are a few variables to customize the tree display, of course:
5568
5569 @table @code
5570 @item gnus-tree-mode-hook
5571 @vindex gnus-tree-mode-hook
5572 A hook called in all tree mode buffers.
5573
5574 @item gnus-tree-mode-line-format
5575 @vindex gnus-tree-mode-line-format
5576 A format string for the mode bar in the tree mode buffers.  The default
5577 is @samp{Gnus: %%b [%A] %Z}.  For a list of legal specs, @pxref{Summary
5578 Buffer Mode Line}. 
5579
5580 @item gnus-selected-tree-face
5581 @vindex gnus-selected-tree-face
5582 Face used for highlighting the selected article in the tree buffer.  The
5583 default is @code{modeline}.
5584
5585 @item gnus-tree-line-format
5586 @vindex gnus-tree-line-format
5587 A format string for the tree nodes.  The name is a bit of a misnomer,
5588 though---it doesn't define a line, but just the node.  The default value
5589 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
5590 the name of the poster.  It is vital that all nodes are of the same
5591 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
5592
5593 Legal specs are:
5594
5595 @table @samp
5596 @item n
5597 The name of the poster.
5598 @item f
5599 The @code{From} header.
5600 @item N
5601 The number of the article.
5602 @item [
5603 The opening bracket.
5604 @item ] 
5605 The closing bracket.
5606 @item s
5607 The subject.
5608 @end table
5609
5610 @xref{Formatting Variables}.
5611
5612 Variables related to the display are:
5613
5614 @table @code
5615 @item gnus-tree-brackets
5616 @vindex gnus-tree-brackets
5617 This is used for differentiating between ``real'' articles and
5618 ``sparse'' articles.  The format is @var{((real-open . real-close)
5619 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
5620 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
5621
5622 @item gnus-tree-parent-child-edges
5623 @vindex gnus-tree-parent-child-edges
5624 This is a list that contains the characters used for connecting parent
5625 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
5626
5627 @end table
5628
5629 @item gnus-tree-minimize-window
5630 @vindex gnus-tree-minimize-window
5631 If this variable is non-@code{nil}, Gnus will try to keep the tree
5632 buffer as small as possible to allow more room for the other Gnus
5633 windows.  If this variable is a number, the tree buffer will never be
5634 higher than that number.  The default is @code{t}.
5635
5636 @item gnus-generate-tree-function
5637 @vindex gnus-generate-tree-function
5638 @findex gnus-generate-horizontal-tree
5639 @findex gnus-generate-vertical-tree
5640 The function that actually generates the thread tree.  Two predefined
5641 functions are available: @code{gnus-generate-horizontal-tree} and
5642 @code{gnus-generate-vertical-tree} (which is the default).
5643
5644 @end table
5645
5646 Here's and example from a horizontal tree buffer:
5647
5648 @example
5649 @{***@}-(***)-[odd]-[Gun]
5650      |     \[Jan]
5651      |     \[odd]-[Eri]
5652      |     \(***)-[Eri]
5653      |           \[odd]-[Paa]
5654      \[Bjo]
5655      \[Gun]
5656      \[Gun]-[Jor]
5657 @end example
5658
5659 Here's the same thread displayed in a vertical tree buffer:
5660
5661 @example
5662 @{***@}
5663   |--------------------------\-----\-----\
5664 (***)                         [Bjo] [Gun] [Gun]
5665   |--\-----\-----\                          |
5666 [odd] [Jan] [odd] (***)                   [Jor]
5667   |           |     |--\
5668 [Gun]       [Eri] [Eri] [odd]
5669                           |
5670                         [Paa]
5671 @end example
5672
5673
5674 @node Mail Group Commands
5675 @section Mail Group Commands
5676 @cindex mail group commands
5677
5678 Some commands only make sense in mail groups.  If these commands are
5679 illegal in the current group, they will raise a hell and let you know.
5680
5681 All these commands (except the expiry and edit commands) use the
5682 process/prefix convention (@pxref{Process/Prefix}).
5683
5684 @table @kbd
5685
5686 @item B e
5687 @kindex B e (Summary)
5688 @findex gnus-summary-expire-articles
5689 Expire all expirable articles in the group
5690 (@code{gnus-summary-expire-articles}).
5691
5692 @item B M-C-e
5693 @kindex B M-C-e (Summary)
5694 @findex gnus-summary-expire-articles-now
5695 Expunge all the expirable articles in the group
5696 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
5697 articles that are eligible for expiry in the current group will
5698 disappear forever into that big @file{/dev/null} in the sky.
5699
5700 @item B DEL
5701 @kindex B DEL (Summary)
5702 @findex gnus-summary-delete-article
5703 Delete the mail article.  This is ``delete'' as in ``delete it from your
5704 disk forever and ever, never to return again.'' Use with caution.
5705 (@code{gnus-summary-delete-article}).
5706
5707 @item B m
5708 @kindex B m (Summary)
5709 @cindex move mail
5710 @findex gnus-summary-move-article
5711 Move the article from one mail group to another
5712 (@code{gnus-summary-move-article}). 
5713
5714 @item B c
5715 @kindex B c (Summary)
5716 @cindex copy mail
5717 @findex gnus-summary-copy-article
5718 Copy the article from one group (mail group or not) to a mail group
5719 (@code{gnus-summary-copy-article}).
5720
5721 @item B C
5722 @kindex B C (Summary)
5723 @cindex crosspost mail
5724 @findex gnus-summary-crosspost-article
5725 Crosspost the current article to some other group
5726 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
5727 the article in the other group, and the Xref headers of the article will
5728 be properly updated.
5729
5730 @item B i
5731 @kindex B i (Summary)
5732 @findex gnus-summary-import-article
5733 Import an arbitrary file into the current mail newsgroup
5734 (@code{gnus-summary-import-article}).  You will be prompted for a file
5735 name, a @code{From} header and a @code{Subject} header.
5736
5737 @item B r
5738 @kindex B r (Summary)
5739 @findex gnus-summary-respool-article
5740 Respool the mail article (@code{gnus-summary-move-article}).
5741
5742 @item B w
5743 @itemx e
5744 @kindex B w (Summary)
5745 @kindex e (Summary)
5746 @findex gnus-summary-edit-article
5747 @kindex C-c C-c (Article)
5748 Edit the current article (@code{gnus-summary-edit-article}).  To finish
5749 editing and make the changes permanent, type @kbd{C-c C-c}
5750 (@kbd{gnus-summary-edit-article-done}).
5751
5752 @item B q
5753 @kindex B q (Summary)
5754 @findex gnus-summary-respool-query
5755 If you want to re-spool an article, you might be curious as to what group
5756 the article will end up in before you do the re-spooling.  This command
5757 will tell you (@code{gnus-summary-respool-query}). 
5758 @end table
5759
5760 @vindex gnus-move-split-methods
5761 @cindex moving articles
5762 If you move (or copy) articles regularly, you might wish to have Gnus
5763 suggest where to put the articles.  @code{gnus-move-split-methods} is a
5764 variable that uses the same syntax as @code{gnus-split-methods}
5765 (@pxref{Saving Articles}).  You may customize that variable to create
5766 suggestions you find reasonable.
5767
5768
5769 @node Various Summary Stuff
5770 @section Various Summary Stuff
5771
5772 @menu
5773 * Summary Group Information::         Information oriented commands.
5774 * Searching for Articles::            Multiple article commands.
5775 * Really Various Summary Commands::   Those pesky non-conformant commands.
5776 @end menu
5777
5778 @table @code
5779 @vindex gnus-summary-mode-hook
5780 @item gnus-summary-mode-hook
5781 This hook is called when creating a summary mode buffer.
5782
5783 @vindex gnus-summary-generate-hook
5784 @item gnus-summary-generate-hook
5785 This is called as the last thing before doing the threading and the
5786 generation of the summary buffer.  It's quite convenient for customizing
5787 the threading variables based on what data the newsgroup has.  This hook
5788 is called from the summary buffer after most summary buffer variables
5789 has been set.
5790
5791 @vindex gnus-summary-prepare-hook
5792 @item gnus-summary-prepare-hook
5793 Is is called after the summary buffer has been generated.  You might use
5794 it to, for instance, highlight lines or modify the look of the buffer in
5795 some other ungodly manner.  I don't care.
5796
5797 @end table
5798
5799
5800 @node Summary Group Information
5801 @subsection Summary Group Information
5802
5803 @table @kbd
5804
5805 @item H f
5806 @kindex H f (Summary)
5807 @findex gnus-summary-fetch-faq
5808 @vindex gnus-group-faq-directory
5809 Try to fetch the FAQ (list of frequently asked questions) for the
5810 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
5811 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
5812 on a remote machine.  This variable can also be a list of directories.
5813 In that case, giving a prefix to this command will allow you to choose
5814 between the various sites.  @code{ange-ftp} probably will be used for
5815 fetching the file.
5816
5817 @item H d
5818 @kindex H d (Summary)
5819 @findex gnus-summary-describe-group
5820 Give a brief description of the current group
5821 (@code{gnus-summary-describe-group}).  If given a prefix, force
5822 rereading the description from the server.
5823
5824 @item H h
5825 @kindex H h (Summary)
5826 @findex gnus-summary-describe-briefly
5827 Give a very brief description of the most important summary keystrokes
5828 (@code{gnus-summary-describe-briefly}). 
5829
5830 @item H i
5831 @kindex H i (Summary)
5832 @findex gnus-info-find-node
5833 Go to the Gnus info node (@code{gnus-info-find-node}).
5834 @end table
5835
5836
5837 @node Searching for Articles
5838 @subsection Searching for Articles
5839
5840 @table @kbd
5841
5842 @item M-s
5843 @kindex M-s (Summary)
5844 @findex gnus-summary-search-article-forward
5845 Search through all subsequent articles for a regexp
5846 (@code{gnus-summary-search-article-forward}). 
5847
5848 @item M-r
5849 @kindex M-r (Summary)
5850 @findex gnus-summary-search-article-backward
5851 Search through all previous articles for a regexp
5852 (@code{gnus-summary-search-article-backward}). 
5853
5854 @item &
5855 @kindex & (Summary)
5856 @findex gnus-summary-execute-command
5857 This command will prompt you for a header field, a regular expression to
5858 match on this field, and a command to be executed if the match is made
5859 (@code{gnus-summary-execute-command}).
5860
5861 @item M-&
5862 @kindex M-& (Summary)
5863 @findex gnus-summary-universal-argument
5864 Perform any operation on all articles that have been marked with
5865 the process mark (@code{gnus-summary-universal-argument}).
5866 @end table
5867
5868
5869 @node Really Various Summary Commands
5870 @subsection Really Various Summary Commands
5871
5872 @table @kbd
5873
5874 @item A D
5875 @kindex A D (Summary)
5876 @findex gnus-summary-enter-digest-group
5877 If the current article is a collection of other articles (for instance,
5878 a digest), you might use this command to enter a group based on the that
5879 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
5880 guess what article type is currently displayed unless you give a prefix
5881 to this command, which forces a ``digest'' interpretation.  Basically,
5882 whenever you see a message that is a collection of other messages on
5883 some format, you @kbd{A D} and read these messages in a more convenient
5884 fashion.
5885
5886 @item C-t
5887 @kindex C-t (Summary)
5888 @findex gnus-summary-toggle-truncation
5889 Toggle truncation of summary lines (@code{gnus-summary-toggle-truncation}).
5890
5891 @item =
5892 @kindex = (Summary)
5893 @findex gnus-summary-expand-window
5894 Expand the summary buffer window (@code{gnus-summary-expand-window}).
5895 If given a prefix, force an @code{article} window configuration. 
5896 @end table
5897
5898
5899 @node Exiting the Summary Buffer
5900 @section Exiting the Summary Buffer
5901 @cindex summary exit
5902 @cindex exiting groups
5903
5904 Exiting from the summary buffer will normally update all info on the
5905 group and return you to the group buffer. 
5906
5907 @table @kbd
5908
5909 @item Z Z
5910 @itemx q
5911 @kindex Z Z (Summary)
5912 @kindex q (Summary)
5913 @findex gnus-summary-exit
5914 @vindex gnus-summary-exit-hook
5915 @vindex gnus-summary-prepare-exit-hook
5916 Exit the current group and update all information on the group
5917 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
5918 called before doing much of the exiting, and calls
5919 @code{gnus-summary-expire-articles} by default.
5920 @code{gnus-summary-exit-hook} is called after finishing the exiting
5921 process. 
5922
5923 @item Z E
5924 @itemx Q
5925 @kindex Z E (Summary)
5926 @kindex Q (Summary)
5927 @findex gnus-summary-exit-no-update
5928 Exit the current group without updating any information on the group
5929 (@code{gnus-summary-exit-no-update}).
5930
5931 @item Z c
5932 @itemx c
5933 @kindex Z c (Summary)
5934 @kindex c (Summary)
5935 @findex gnus-summary-catchup-and-exit
5936 Mark all unticked articles in the group as read and then exit
5937 (@code{gnus-summary-catchup-and-exit}).
5938
5939 @item Z C
5940 @kindex Z C (Summary)
5941 @findex gnus-summary-catchup-all-and-exit
5942 Mark all articles, even the ticked ones, as read and then exit
5943 (@code{gnus-summary-catchup-all-and-exit}).
5944
5945 @item Z n
5946 @kindex Z n (Summary)
5947 @findex gnus-summary-catchup-and-goto-next-group
5948 Mark all articles as read and go to the next group
5949 (@code{gnus-summary-catchup-and-goto-next-group}). 
5950
5951 @item Z R
5952 @kindex Z R (Summary)
5953 @findex gnus-summary-reselect-current-group
5954 Exit this group, and then enter it again
5955 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
5956 all articles, both read and unread.
5957
5958 @item Z G
5959 @itemx M-g
5960 @kindex Z G (Summary)
5961 @kindex M-g (Summary)
5962 @findex gnus-summary-rescan-group
5963 Exit the group, check for new articles in the group, and select the
5964 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
5965 articles, both read and unread.
5966
5967 @item Z N
5968 @kindex Z N (Summary)
5969 @findex gnus-summary-next-group
5970 Exit the group and go to the next group
5971 (@code{gnus-summary-next-group}). 
5972
5973 @item Z P
5974 @kindex Z P (Summary)
5975 @findex gnus-summary-prev-group
5976 Exit the group and go to the previous group
5977 (@code{gnus-summary-prev-group}). 
5978 @end table
5979
5980 @vindex gnus-exit-group-hook
5981 @code{gnus-exit-group-hook} is called when you exit the current
5982 group.  
5983
5984 @findex gnus-summary-wake-up-the-dead
5985 @findex gnus-dead-summary-mode
5986 @vindex gnus-kill-summary-on-exit
5987 If you're in the habit of exiting groups, and then changing your mind
5988 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
5989 If you do that, Gnus won't kill the summary buffer when you exit it.
5990 (Quelle surprise!)  Instead it will change the name of the buffer to
5991 something like @samp{*Dead Summary ... *} and install a minor mode
5992 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
5993 buffer, you'll find that all keys are mapped to a function called
5994 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
5995 summary buffer will result in a live, normal summary buffer.  
5996
5997 There will never be more than one dead summary buffer at any one time. 
5998
5999 @vindex gnus-use-cross-reference
6000 The data on the current group will be updated (which articles you have
6001 read, which articles you have replied to, etc.) when you exit the
6002 summary buffer.  If the @code{gnus-use-cross-reference} variable is
6003 @code{t} (which is the default), articles that are cross-referenced to
6004 this group and are marked as read, will also be marked as read in the
6005 other subscribed groups they were cross-posted to.  If this variable is
6006 neither @code{nil} nor @code{t}, the article will be marked as read in
6007 both subscribed and unsubscribed groups.
6008
6009 @cindex velveeta
6010 @cindex spamming
6011 Marking cross-posted articles as read ensures that you'll never have to
6012 read the same article more than once.  Unless, of course, somebody has
6013 posted it to several groups separately.  Posting the same article to
6014 several groups (not cross-posting) is called @dfn{spamming}, and you are
6015 by law required to send nasty-grams to anyone who perpetrates such a
6016 heinous crime.
6017
6018 Remember: Cross-posting is kinda ok, but posting the same article
6019 separately to several groups is not.  Massive cross-posting (aka.
6020 @dfn{velveeta}) is to be avoided.  
6021
6022 @cindex cross-posting
6023 @cindex Xref
6024 @cindex @sc{nov}
6025 One thing that may cause Gnus to not do the cross-posting thing
6026 correctly is if you use an @sc{nntp} server that supports @sc{xover}
6027 (which is very nice, because it speeds things up considerably) which
6028 does not include the @code{Xref} header in its @sc{nov} lines.  This is
6029 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
6030 even with @sc{xover} by registering the @code{Xref} lines of all
6031 articles you actually read, but if you kill the articles, or just mark
6032 them as read without reading them, Gnus will not get a chance to snoop
6033 the @code{Xref} lines out of these articles, and will be unable to use
6034 the cross reference mechanism.
6035
6036 @cindex LIST overview.fmt
6037 @cindex overview.fmt
6038 To check whether your @sc{nntp} server includes the @code{Xref} header
6039 in its overview files, try @samp{telnet your.nntp.server nntp},
6040 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
6041 overview.fmt}.  This may not work, but if it does, and the last line you
6042 get does not read @samp{Xref:full}, then you should shout and whine at
6043 your news admin until she includes the @code{Xref} header in the
6044 overview files.
6045
6046 @vindex gnus-nov-is-evil
6047 If you want Gnus to get the @code{Xref}s right all the time, you have to
6048 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
6049 considerably.
6050
6051 C'est la vie.
6052
6053
6054 @node The Article Buffer
6055 @chapter The Article Buffer
6056 @cindex article buffer
6057
6058 The articles are displayed in the article buffer, of which there is only
6059 one.  All the summary buffers share the same article buffer unless you
6060 tell Gnus otherwise.
6061
6062 @menu
6063 * Hiding Headers::        Deciding what headers should be displayed.
6064 * Using MIME::            Pushing articles through @sc{mime} before reading them.
6065 * Customizing Articles::  Tailoring the look of the articles.
6066 * Article Keymap::        Keystrokes available in the article buffer
6067 * Misc Article::          Other stuff.
6068 @end menu
6069
6070
6071 @node Hiding Headers
6072 @section Hiding Headers
6073 @cindex hiding headers
6074 @cindex deleting headers
6075
6076 The top section of each article is the @dfn{head}.  (The rest is the
6077 @dfn{body}, but you may have guessed that already.)
6078
6079 @vindex gnus-show-all-headers
6080 There is a lot of useful information in the head: the name of the person
6081 who wrote the article, the date it was written and the subject of the
6082 article.  That's well and nice, but there's also lots of information
6083 most people do not want to see---what systems the article has passed
6084 through before reaching you, the @code{Message-ID}, the
6085 @code{References}, etc. ad nauseum---and you'll probably want to get rid
6086 of some of those lines.  If you want to keep all those lines in the
6087 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
6088
6089 Gnus provides you with two variables for sifting headers:
6090
6091 @table @code
6092
6093 @item gnus-visible-headers
6094 @vindex gnus-visible-headers
6095 If this variable is non-@code{nil}, it should be a regular expression
6096 that says what headers you wish to keep in the article buffer.  All
6097 headers that do not match this variable will be hidden.
6098
6099 For instance, if you only want to see the name of the person who wrote
6100 the article and the subject, you'd say:
6101
6102 @lisp
6103 (setq gnus-visible-headers "^From:\\|^Subject:")
6104 @end lisp
6105
6106 This variable can also be a list of regexps to match headers that are to
6107 remain visible.
6108
6109 @item gnus-ignored-headers
6110 @vindex gnus-ignored-headers
6111 This variable is the reverse of @code{gnus-visible-headers}.  If this
6112 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
6113 should be a regular expression that matches all lines that you want to
6114 hide.  All lines that do not match this variable will remain visible.
6115
6116 For instance, if you just want to get rid of the @code{References} line
6117 and the @code{Xref} line, you might say:
6118
6119 @lisp
6120 (setq gnus-ignored-headers "^References:\\|^Xref:")
6121 @end lisp
6122
6123 This variable can also be a list of regexps to match headers that are to
6124 be removed.
6125
6126 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
6127 variable will have no effect.
6128
6129 @end table
6130
6131 @vindex gnus-sorted-header-list
6132 Gnus can also sort the headers for you.  (It does this by default.)  You
6133 can control the sorting by setting the @code{gnus-sorted-header-list}
6134 variable.  It is a list of regular expressions that says in what order
6135 the headers are to be displayed.
6136
6137 For instance, if you want the name of the author of the article first,
6138 and then the subject, you might say something like:
6139
6140 @lisp
6141 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
6142 @end lisp
6143
6144 Any headers that are to remain visible, but are not listed in this
6145 variable, will be displayed in random order after all the headers that
6146 are listed in this variable.
6147
6148 @findex gnus-article-hide-boring-headers
6149 @vindex gnus-article-display-hook
6150 @vindex gnus-boring-article-headers
6151 You can hide further boring headers by entering
6152 @code{gnus-article-hide-boring-headers} into
6153 @code{gnus-article-display-hook}.  What this function does depends on
6154 the @code{gnus-boring-article-headers} variable.  It's a list, but this
6155 list doesn't actually contain header names.  Instead is lists various
6156 @dfn{boring conditions} that Gnus can check and remove from sight.
6157
6158 These conditions are:
6159 @table @code
6160 @item empty
6161 Remove all empty headers.
6162 @item newsgroups
6163 Remove the @code{Newsgroups} header if it only contains the current group
6164 name. 
6165 @item followup-to
6166 Remove the @code{Followup-To} header if it is identical to the
6167 @code{Newsgroups} header.
6168 @item reply-to
6169 Remove the @code{Reply-To} header if it lists the same address as the
6170 @code{From} header.
6171 @item date
6172 Remove the @code{Date} header if the article is less than three days
6173 old. 
6174 @end table
6175
6176 To include the four first elements, you could say something like;
6177
6178 @lisp
6179 (setq gnus-boring-article-headers 
6180       '(empty newsgroups followup-to reply-to))
6181 @end lisp
6182
6183 This is also the default value for this variable.
6184
6185
6186 @node Using MIME
6187 @section Using @sc{mime}
6188 @cindex @sc{mime}
6189
6190 Mime is a standard for waving your hands through the air, aimlessly,
6191 while people stand around yawning.
6192
6193 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
6194 while all newsreaders die of fear.
6195
6196 @sc{mime} may specify what character set the article uses, the encoding
6197 of the characters, and it also makes it possible to embed pictures and
6198 other naughty stuff in innocent-looking articles.
6199
6200 @vindex gnus-show-mime
6201 @vindex gnus-show-mime-method
6202 @vindex gnus-strict-mime
6203 @findex metamail-buffer
6204 Gnus handles @sc{mime} by shoving the articles through
6205 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
6206 default.  Set @code{gnus-show-mime} to @code{t} if you want to use
6207 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
6208 non-@code{nil}, the @sc{mime} method will only be used if there are
6209 @sc{mime} headers in the article.
6210
6211 It might be best to just use the toggling functions from the summary
6212 buffer to avoid getting nasty surprises. (For instance, you enter the
6213 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
6214 decoded the sound file in the article and some horrible sing-a-long song
6215 comes streaming out out your speakers, and you can't find the volume
6216 button, because there isn't one, and people are starting to look at you,
6217 and you try to stop the program, but you can't, and you can't find the
6218 program to control the volume, and everybody else in the room suddenly
6219 decides to look at you disdainfully, and you'll feel rather stupid.)
6220
6221 Any similarity to real events and people is purely coincidental.  Ahem.
6222
6223
6224 @node Customizing Articles
6225 @section Customizing Articles
6226 @cindex article customization
6227
6228 @vindex gnus-article-display-hook
6229 The @code{gnus-article-display-hook} is called after the article has
6230 been inserted into the article buffer.  It is meant to handle all
6231 treatment of the article before it is displayed. 
6232
6233 @findex gnus-article-maybe-highlight
6234 By default it contains @code{gnus-article-hide-headers},
6235 @code{gnus-article-treat-overstrike}, and
6236 @code{gnus-article-maybe-highlight}, but there are thousands, nay
6237 millions, of functions you can put in this hook.  For an overview of
6238 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
6239 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
6240 Date}.
6241
6242 You can, of course, write your own functions.  The functions are called
6243 from the article buffer, and you can do anything you like, pretty much.
6244 There is no information that you have to keep in the buffer---you can
6245 change everything.  However, you shouldn't delete any headers.  Instead
6246 make them invisible if you want to make them go away.
6247
6248
6249 @node Article Keymap
6250 @section Article Keymap
6251
6252 Most of the keystrokes in the summary buffer can also be used in the
6253 article buffer.  They should behave as if you typed them in the summary
6254 buffer, which means that you don't actually have to have a summary
6255 buffer displayed while reading.  You can do it all from the article
6256 buffer.
6257
6258 A few additional keystrokes are available:
6259
6260 @table @kbd
6261
6262 @item SPACE
6263 @kindex SPACE (Article)
6264 @findex gnus-article-next-page
6265 Scroll forwards one page (@code{gnus-article-next-page}).
6266
6267 @item DEL
6268 @kindex DEL (Article)
6269 @findex gnus-article-prev-page
6270 Scroll backwards one page (@code{gnus-article-prev-page}).
6271
6272 @item C-c ^
6273 @kindex C-c ^ (Article)
6274 @findex gnus-article-refer-article
6275 If point is in the neighborhood of a @code{Message-ID} and you press
6276 @kbd{r}, Gnus will try to get that article from the server
6277 (@code{gnus-article-refer-article}).
6278
6279 @item C-c C-m
6280 @kindex C-c C-m (Article)
6281 @findex gnus-article-mail
6282 Send a reply to the address near point (@code{gnus-article-mail}).  If
6283 given a prefix, include the mail.
6284
6285 @item s
6286 @kindex s (Article)
6287 @findex gnus-article-show-summary
6288 Reconfigure the buffers so that the summary buffer becomes visible
6289 (@code{gnus-article-show-summary}).
6290
6291 @item ?
6292 @kindex ? (Article)
6293 @findex gnus-article-describe-briefly
6294 Give a very brief description of the available keystrokes
6295 (@code{gnus-article-describe-briefly}). 
6296
6297 @item TAB
6298 @kindex TAB (Article)
6299 @findex gnus-article-next-button
6300 Go to the next button, if any (@code{gnus-article-next-button}.  This
6301 only makes sense if you have buttonizing turned on.
6302
6303 @item M-TAB
6304 @kindex M-TAB (Article)
6305 @findex gnus-article-prev-button
6306 Go to the previous button, if any (@code{gnus-article-prev-button}.  
6307
6308 @end table
6309
6310
6311 @node Misc Article
6312 @section Misc Article
6313
6314 @table @code
6315
6316 @item gnus-single-article-buffer
6317 @vindex gnus-single-article-buffer
6318 If non-@code{nil}, use the same article buffer for all the groups.
6319 (This is the default.)  If @code{nil}, each group will have its own
6320 article buffer.
6321
6322 @vindex gnus-article-prepare-hook
6323 @item gnus-article-prepare-hook
6324 This hook is called right after the article has been inserted into the
6325 article buffer.  It is mainly intended for functions that do something
6326 depending on the contents; it should probably not be used for changing
6327 the contents of the article buffer.
6328
6329 @vindex gnus-article-display-hook
6330 @item gnus-article-display-hook
6331 This hook is called as the last thing when displaying an article, and is
6332 intended for modifying the contents of the buffer, doing highlights,
6333 hiding headers, and the like.
6334
6335 @item gnus-article-mode-hook
6336 @vindex gnus-article-mode-hook
6337 Hook called in article mode buffers.
6338
6339 @vindex gnus-article-mode-line-format
6340 @item gnus-article-mode-line-format
6341 This variable is a format string along the same lines as
6342 @code{gnus-summary-mode-line-format}.  It accepts exactly the same
6343 format specifications as that variable.
6344 @vindex gnus-break-pages
6345
6346 @item gnus-break-pages
6347 Controls whether @dfn{page breaking} is to take place.  If this variable
6348 is non-@code{nil}, the articles will be divided into pages whenever a
6349 page delimiter appears in the article.  If this variable is @code{nil},
6350 paging will not be done.
6351
6352 @item gnus-page-delimiter
6353 @vindex gnus-page-delimiter
6354 This is the delimiter mentioned above.  By default, it is @samp{^L}
6355 (form linefeed).
6356 @end table
6357
6358
6359 @node Composing Messages
6360 @chapter Composing Messages
6361 @cindex reply
6362 @cindex followup
6363 @cindex post
6364
6365 @kindex C-c C-c (Post)
6366 All commands for posting and mailing will put you in a message buffer
6367 where you can edit the article all you like, before you send the article
6368 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
6369 Manual}.  If you are in a foreign news group, and you wish to post the
6370 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
6371 to make Gnus try to post using the foreign server.
6372
6373 @menu 
6374 * Mail::                 Mailing and replying.
6375 * Post::                 Posting and following up.
6376 * Posting Server::       What server should you post via?
6377 * Mail and Post::        Mailing and posting at the same time.
6378 * Archived Messages::    Where Gnus stores the messages you've sent.
6379 @c * Posting Styles::       An easier way to configure some key elements.
6380 @c * Drafts::               Postponing messages and rejected messages.
6381 @c * Rejected Articles::    What happens if the server doesn't like your article?
6382 @end menu
6383
6384 Also see @pxref{Canceling and Superseding} for information on how to
6385 remove articles you shouldn't have posted.
6386
6387
6388 @node Mail
6389 @section Mail
6390
6391 Variables for customizing outgoing mail:
6392
6393 @table @code
6394 @item gnus-uu-digest-headers
6395 @vindex gnus-uu-digest-headers
6396 List of regexps to match headers included in digested messages.  The
6397 headers will be included in the sequence they are matched.
6398
6399 @end table
6400
6401
6402 @node Post
6403 @section Post
6404
6405 Variables for composing news articles:
6406
6407 @table @code
6408 @item gnus-sent-message-ids-file
6409 @vindex gnus-sent-message-ids-file
6410 Gnus will keep a @code{Message-ID} history file of all the mails it has
6411 sent.  If it discovers that it has already sent a mail, it will ask the
6412 user whether to re-send the mail.  (This is primarily useful when
6413 dealing with @sc{soup} packets and the like where one is apt to sent the
6414 same packet multiple times.)  This variable says what the name of this
6415 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
6416 this variable to @code{nil} if you don't want Gnus to keep a history
6417 file.
6418
6419 @item gnus-sent-message-ids-length
6420 @vindex gnus-sent-message-ids-length
6421 This variable says how many @code{Message-ID}s to keep in the history
6422 file.  It is 1000 by default.
6423
6424 @end table
6425
6426
6427 @node Posting Server
6428 @section Posting Server
6429
6430 When you press those magical @kbd{C-c C-c} keys to ship off your latest
6431 (extremely intelligent, of course) article, where does it go?
6432
6433 Thank you for asking.  I hate you.
6434
6435 @vindex gnus-post-method
6436
6437 It can be quite complicated.  Normally, Gnus will use the same native
6438 server.  However.  If your native server doesn't allow posting, just
6439 reading, you probably want to use some other server to post your
6440 (extremely intelligent and fabulously interesting) articles.  You can
6441 then set the @code{gnus-post-method} to some other method:
6442
6443 @lisp
6444 (setq gnus-post-method '(nnspool ""))
6445 @end lisp
6446
6447 Now, if you've done this, and then this server rejects your article, or
6448 this server is down, what do you do then?  To override this variable you
6449 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
6450 the ``current'' server for posting.
6451
6452 If you give a zero prefix (i. e., @kbd{C-u 0 C-c C-c}) to that command,
6453 Gnus will prompt you for what method to use for posting.  
6454
6455 You can also set @code{gnus-post-method} to a list of select methods.
6456 If that's the case, Gnus will always prompt you for what method to use
6457 for posting. 
6458
6459
6460 @node Mail and Post
6461 @section Mail and Post
6462
6463 Here's a list of variables that are relevant to both mailing and
6464 posting:
6465
6466 @table @code
6467 @item gnus-mailing-list-groups
6468 @findex gnus-mailing-list-groups
6469 @cindex mailing lists
6470
6471 If your news server offers groups that are really mailing lists that are
6472 gatewayed to the @sc{nntp} server, you can read those groups without
6473 problems, but you can't post/followup to them without some difficulty.
6474 One solution is to add a @code{to-address} to the group parameters
6475 (@pxref{Group Parameters}).  An easier thing to do is set the
6476 @code{gnus-mailing-list-groups} to a regexp that match the groups that
6477 really are mailing lists.  Then, at least, followups to the mailing
6478 lists will work most of the time.  Posting to these groups (@kbd{a}) is
6479 still a pain, though.
6480
6481 @end table
6482
6483 You may want to do spell-checking on messages that you send out.  Or, if
6484 you don't want to spell-check by hand, you could add automatic
6485 spell-checking via the @code{ispell} package:
6486
6487 @cindex ispell
6488 @findex ispell-message
6489 @lisp
6490 (add-hook 'message-send-hook 'ispell-message) 
6491 @end lisp
6492
6493
6494 @node Archived Messages
6495 @section Archived Messages
6496 @cindex archived messages
6497 @cindex sent messages
6498
6499 Gnus provides a few different methods for storing the mail you send.
6500 The default method is to use the @dfn{archive virtual server} to store
6501 the mail.  If you want to disable this completely, you should set
6502 @code{gnus-message-archive-group} to @code{nil}.
6503
6504 @vindex gnus-message-archive-method
6505 @code{gnus-message-archive-method} says what virtual server Gnus is to
6506 use to store sent messages.  It is @code{(nnfolder "archive"
6507 (nnfolder-directory "~/Mail/archive/"))} by default, but you can use any
6508 mail select method (@code{nnml}, @code{nnmbox}, etc.).  However,
6509 @code{nnfolder} is a quite likeable select method for doing this sort of
6510 thing.  If you don't like the default directory chosen, you could say
6511 something like:
6512
6513 @lisp
6514 (setq gnus-message-archive-method
6515       '(nnfolder "archive" 
6516                  (nnfolder-inhibit-expiry t)
6517                  (nnfolder-active-file "~/News/sent-mail/active")
6518                  (nnfolder-directory "~/News/sent-mail/")))
6519 @end lisp
6520
6521 @vindex gnus-message-archive-group
6522 @cindex Gcc
6523 Gnus will insert @code{Gcc} headers in all outgoing messages that point
6524 to one or more group(s) on that server.  Which group to use is
6525 determined by the @code{gnus-message-archive-group} variable.  
6526
6527 This variable can be:
6528
6529 @itemize @bullet
6530 @item a string
6531 Messages will be saved in that group.
6532 @item a list of strings
6533 Messages will be saved in all those groups.
6534 @item an alist of regexps, functions and forms
6535 When a key ``matches'', the result is used.
6536 @end itemize
6537
6538 Let's illustrate:
6539
6540 Just saving to a single group called @samp{MisK}:
6541 @lisp
6542 (setq gnus-message-archive-group "MisK")
6543 @end lisp
6544
6545 Saving to two groups, @samp{MisK} and @samp{safe}:
6546 @lisp
6547 (setq gnus-message-archive-group '("MisK" "safe"))
6548 @end lisp
6549
6550 Save to different groups based on what group you are in:
6551 @lisp
6552 (setq gnus-message-archive-group 
6553       '(("^alt" "sent-to-alt")
6554         ("mail" "sent-to-mail")
6555         (".*" "sent-to-misc")))
6556 @end lisp
6557
6558 More complex stuff:
6559 @lisp
6560 (setq gnus-message-archive-group 
6561       '((if (message-news-p)
6562             "misc-news" 
6563           "misc-mail")))
6564 @end lisp       
6565
6566 This is the default.
6567
6568 How about storing all news messages in one file, but storing all mail
6569 messages in one file per month:
6570
6571 @lisp
6572 (setq gnus-message-archive-group
6573       '((if (message-news-p)
6574             "misc-news" 
6575           (concat "mail." (format-time-string 
6576                            "%Y-%m" (current-time))))))
6577 @end lisp
6578
6579 Now, when you send a message off, it will be stored in the appropriate
6580 group.  (If you want to disable storing for just one particular message,
6581 you can just remove the @code{Gcc} header that has been inserted.)  The
6582 archive group will appear in the group buffer the next time you start
6583 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
6584 enter it and read the articles in it just like you'd read any other
6585 group.  If the group gets really big and annoying, you can simply rename
6586 if (using @kbd{G r} in the group buffer) to something nice --
6587 @samp{misc-mail-september-1995}, or whatever.  New messages will
6588 continue to be stored in the old (now empty) group.
6589
6590 That's the default method of archiving sent mail.  Gnus also offers two
6591 other variables for the people who don't like the default method.  In
6592 that case you should set @code{gnus-message-archive-group} to
6593 @code{nil}; this will disable archiving.
6594
6595 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
6596 use a different value for @code{gnus-message-archive-group} there.
6597
6598
6599 @table @code
6600 @item gnus-outgoing-message-group 
6601 @vindex gnus-outgoing-message-group 
6602 All outgoing messages will be put in this group.  If you want to store
6603 all your outgoing mail and articles in the group @samp{nnml:archive},
6604 you set this variable to that value.  This variable can also be a list of
6605 group names.
6606
6607 If you want to have greater control over what group to put each
6608 message in, you can set this variable to a function that checks the
6609 current newsgroup name and then returns a suitable group name (or list
6610 of names).
6611 @end table
6612
6613
6614 @c @node Posting Styles
6615 @c @section Posting Styles
6616 @c @cindex posting styles
6617 @c @cindex styles
6618 @c 
6619 @c All them variables, they make my head swim.  
6620 @c 
6621 @c So what if you want a different @code{Organization} and signature based
6622 @c on what groups you post to?  And you post both from your home machine
6623 @c and your work machine, and you want different @code{From} lines, and so
6624 @c on? 
6625 @c 
6626 @c @vindex gnus-posting-styles
6627 @c One way to do stuff like that is to write clever hooks that change the
6628 @c variables you need to have changed.  That's a bit boring, so somebody
6629 @c came up with the bright idea of letting the user specify these things in
6630 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
6631 @c variable: 
6632 @c 
6633 @c @lisp
6634 @c ((".*" 
6635 @c   (signature . "Peace and happiness")
6636 @c   (organization . "What me?"))
6637 @c  ("^comp" 
6638 @c   (signature . "Death to everybody"))
6639 @c  ("comp.emacs.i-love-it" 
6640 @c   (organization . "Emacs is it")))
6641 @c @end lisp
6642 @c 
6643 @c As you might surmise from this example, this alist consists of several
6644 @c @dfn{styles}.  Each style will be applicable if the first element
6645 @c ``matches'', in some form or other.  The entire alist will be iterated
6646 @c over, from the beginning towards the end, and each match will be
6647 @c applied, which means that attributes in later styles that match override
6648 @c the same attributes in earlier matching styles.  So
6649 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
6650 @c signature and the @samp{What me?} @code{Organization} header.
6651 @c 
6652 @c The first element in each style is called the @code{match}.  If it's a
6653 @c string, then Gnus will try to regexp match it against the group name.
6654 @c If it's a function symbol, that function will be called with no
6655 @c arguments.  If it's a variable symbol, then the variable will be
6656 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
6657 @c any case, if this returns a non-@code{nil} value, then the style is said
6658 @c to @dfn{match}.
6659 @c 
6660 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
6661 @c attribute consists of a @var{(name . value)} pair.  The attribute name
6662 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
6663 @c attribute name can also be a string.  In that case, this will be used as
6664 @c a header name, and the value will be inserted in the headers of the
6665 @c article.
6666 @c 
6667 @c The attribute value can be a string (used verbatim), a function (the
6668 @c return value will be used), a variable (its value will be used) or a
6669 @c list (it will be @code{eval}ed and the return value will be used).
6670 @c 
6671 @c So here's a new example:
6672 @c 
6673 @c @lisp
6674 @c (setq gnus-posting-styles
6675 @c       '((".*" 
6676 @c           (signature . "~/.signature") 
6677 @c           (from . "user@@foo (user)")
6678 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
6679 @c           (organization . "People's Front Against MWM"))
6680 @c         ("^rec.humor" 
6681 @c           (signature . my-funny-signature-randomizer))
6682 @c         ((equal (system-name) "gnarly")
6683 @c           (signature . my-quote-randomizer))
6684 @c         (posting-from-work-p
6685 @c           (signature . "~/.work-signature")
6686 @c           (from . "user@@bar.foo (user)")
6687 @c           (organization . "Important Work, Inc"))
6688 @c         ("^nn.+:" 
6689 @c           (signature . "~/.mail-signature"))))
6690 @c @end lisp
6691
6692 @c @node Drafts
6693 @c @section Drafts
6694 @c @cindex drafts
6695 @c 
6696 @c If you are writing a message (mail or news) and suddenly remember that
6697 @c you have a steak in the oven (or some pesto in the food processor, you
6698 @c craazy vegetarians), you'll probably wish there was a method to save the
6699 @c message you are writing so that you can continue editing it some other
6700 @c day, and send it when you feel its finished.
6701 @c 
6702 @c Well, don't worry about it.  Whenever you start composing a message of
6703 @c some sort using the Gnus mail and post commands, the buffer you get will
6704 @c automatically associate to an article in a special @dfn{draft} group.
6705 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
6706 @c article will be saved there.  (Auto-save files also go to the draft
6707 @c group.) 
6708 @c 
6709 @c @cindex nndraft
6710 @c @vindex gnus-draft-group-directory
6711 @c The draft group is a special group (which is implemented as an
6712 @c @code{nndraft} group, if you absolutely have to know) called
6713 @c @samp{nndraft:drafts}.  The variable @code{gnus-draft-group-directory}
6714 @c controls both the name of the group and the location---the leaf element
6715 @c in the path will be used as the name of the group.  What makes this
6716 @c group special is that you can't tick any articles in it or mark any
6717 @c articles as read---all articles in the group are permanently unread.
6718 @c 
6719 @c If the group doesn't exist, it will be created and you'll be subscribed
6720 @c to it.
6721 @c 
6722 @c @findex gnus-dissociate-buffer-from-draft
6723 @c @kindex C-c M-d (Mail)
6724 @c @kindex C-c M-d (Post)
6725 @c @findex gnus-associate-buffer-with-draft
6726 @c @kindex C-c C-d (Mail)
6727 @c @kindex C-c C-d (Post)
6728 @c If you're writing some super-secret message that you later want to
6729 @c encode with PGP before sending, you may wish to turn the auto-saving
6730 @c (and association with the draft group) off.  You never know who might be
6731 @c interested in reading all your extremely valuable and terribly horrible
6732 @c and interesting secrets.  The @kbd{C-c M-d}
6733 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
6734 @c If you change your mind and want to turn the auto-saving back on again,
6735 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
6736 @c 
6737 @c @vindex gnus-use-draft
6738 @c To leave association with the draft group off by default, set
6739 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
6740 @c 
6741 @c @findex gnus-summary-send-draft
6742 @c @kindex S D c (Summary)
6743 @c When you want to continue editing the article, you simply enter the
6744 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
6745 @c that.  You will be placed in a buffer where you left off.
6746 @c 
6747 @c Rejected articles will also be put in this draft group (@pxref{Rejected
6748 @c Articles}).
6749 @c 
6750 @c @findex gnus-summary-send-all-drafts
6751 @c If you have lots of rejected messages you want to post (or mail) without
6752 @c doing further editing, you can use the @kbd{S D a} command
6753 @c (@code{gnus-summary-send-all-drafts}).  This command understands the
6754 @c process/prefix convention (@pxref{Process/Prefix}).  
6755 @c 
6756 @c 
6757 @c @node Rejected Articles
6758 @c @section Rejected Articles
6759 @c @cindex rejected articles
6760 @c 
6761 @c Sometimes a news server will reject an article.  Perhaps the server
6762 @c doesn't like your face.  Perhaps it just feels miserable.  Perhaps
6763 @c @emph{there be demons}.  Perhaps you have included too much cited text.
6764 @c Perhaps the disk is full.  Perhaps the server is down.
6765 @c 
6766 @c These situations are, of course, totally beyond the control of Gnus.
6767 @c (Gnus, of course, loves the way you look, always feels great, has angels
6768 @c fluttering around inside of it, doesn't care about how much cited text
6769 @c you include, never runs full and never goes down.)  So Gnus saves these
6770 @c articles until some later time when the server feels better.
6771 @c 
6772 @c The rejected articles will automatically be put in a special draft group
6773 @c (@pxref{Drafts}).  When the server comes back up again, you'd then
6774 @c typically enter that group and send all the articles off.
6775 @c 
6776
6777 @node Select Methods
6778 @chapter Select Methods
6779 @cindex foreign groups
6780 @cindex select methods
6781
6782 A @dfn{foreign group} is a group that is not read by the usual (or
6783 default) means.  It could be, for instance, a group from a different
6784 @sc{nntp} server, it could be a virtual group, or it could be your own
6785 personal mail group.
6786
6787 A foreign group (or any group, really) is specified by a @dfn{name} and
6788 a @dfn{select method}.  To take the latter first, a select method is a
6789 list where the first element says what backend to use (eg. @code{nntp},
6790 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
6791 name}.  There may be additional elements in the select method, where the
6792 value may have special meaning for the backend in question.
6793
6794 One could say that a select method defines a @dfn{virtual server}---so
6795 we do just that (@pxref{The Server Buffer}).
6796
6797 The @dfn{name} of the group is the name the backend will recognize the
6798 group as.
6799
6800 For instance, the group @samp{soc.motss} on the @sc{nntp} server
6801 @samp{some.where.edu} will have the name @samp{soc.motss} and select
6802 method @code{(nntp "some.where.edu")}.  Gnus will call this group, in
6803 all circumstances, @samp{nntp+some.where.edu:soc.motss}, even though the
6804 @code{nntp} backend just knows this group as @samp{soc.motss}.
6805
6806 The different methods all have their peculiarities, of course.
6807
6808 @menu
6809 * The Server Buffer::     Making and editing virtual servers.
6810 * Getting News::          Reading USENET news with Gnus.
6811 * Getting Mail::          Reading your personal mail with Gnus.
6812 * Other Sources::         Reading directories, files, SOUP packets.
6813 * Combined Groups::       Combining groups into one group.
6814 @end menu
6815
6816
6817 @node The Server Buffer
6818 @section The Server Buffer
6819
6820 Traditionally, a @dfn{server} is a machine or a piece of software that
6821 one connects to, and then requests information from.  Gnus does not
6822 connect directly to any real servers, but does all transactions through
6823 one backend or other.  But that's just putting one layer more between
6824 the actual media and Gnus, so we might just as well say that each
6825 backend represents a virtual server.
6826
6827 For instance, the @code{nntp} backend may be used to connect to several
6828 different actual @sc{nntp} servers, or, perhaps, to many different ports
6829 on the same actual @sc{nntp} server.  You tell Gnus which backend to
6830 use, and what parameters to set by specifying a @dfn{select method}.
6831
6832 These select methods specifications can sometimes become quite
6833 complicated---say, for instance, that you want to read from the
6834 @sc{nntp} server @samp{news.funet.fi} on port number @code{13}, which
6835 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
6836 Anyways, if you had to specify that for each group that used this
6837 server, that would be too much work, so Gnus offers a way of naming
6838 select methods, which is what you do in the server buffer.
6839
6840 To enter the server buffer, user the @kbd{^}
6841 (@code{gnus-group-enter-server-mode}) command in the group buffer.
6842
6843 @menu
6844 * Server Buffer Format::      You can customize the look of this buffer.
6845 * Server Commands::           Commands to manipulate servers.
6846 * Example Methods::           Examples server specifications.
6847 * Creating a Virtual Server:: An example session.
6848 * Servers and Methods::       You can use server names as select methods.
6849 * Unavailable Servers::       Some servers you try to contact may be down.
6850 @end menu
6851
6852 @vindex gnus-server-mode-hook
6853 @code{gnus-server-mode-hook} is run when creating the server buffer.
6854
6855
6856 @node Server Buffer Format
6857 @subsection Server Buffer Format
6858 @cindex server buffer format
6859
6860 @vindex gnus-server-line-format
6861 You can change the look of the server buffer lines by changing the
6862 @code{gnus-server-line-format} variable.  This is a @code{format}-like
6863 variable, with some simple extensions:
6864
6865 @table @samp
6866
6867 @item h 
6868 How the news is fetched---the backend name.
6869
6870 @item n
6871 The name of this server.
6872
6873 @item w
6874 Where the news is to be fetched from---the address.
6875
6876 @item s
6877 The opened/closed/denied status of the server.
6878 @end table
6879
6880 @vindex gnus-server-mode-line-format
6881 The mode line can also be customized by using the
6882 @code{gnus-server-mode-line-format} variable.  The following specs are
6883 understood: 
6884
6885 @table @samp
6886 @item S
6887 Server name.
6888
6889 @item M
6890 Server method.
6891 @end table
6892
6893 Also @pxref{Formatting Variables}.
6894
6895
6896 @node Server Commands
6897 @subsection Server Commands
6898 @cindex server commands
6899
6900 @table @kbd
6901
6902 @item a
6903 @kindex a (Server)
6904 @findex gnus-server-add-server
6905 Add a new server (@code{gnus-server-add-server}).
6906
6907 @item e
6908 @kindex e (Server)
6909 @findex gnus-server-edit-server
6910 Edit a server (@code{gnus-server-edit-server}).
6911
6912 @item SPACE
6913 @kindex SPACE (Server)
6914 @findex gnus-server-read-server
6915 Browse the current server (@code{gnus-server-read-server}).
6916
6917 @item q
6918 @kindex q (Server)
6919 @findex gnus-server-exit
6920 Return to the group buffer (@code{gnus-server-exit}).
6921
6922 @item k
6923 @kindex k (Server)
6924 @findex gnus-server-kill-server
6925 Kill the current server (@code{gnus-server-kill-server}).
6926
6927 @item y
6928 @kindex y (Server)
6929 @findex gnus-server-yank-server
6930 Yank the previously killed server (@code{gnus-server-yank-server}).
6931
6932 @item c
6933 @kindex c (Server)
6934 @findex gnus-server-copy-server
6935 Copy the current server (@code{gnus-server-copy-server}).
6936
6937 @item l
6938 @kindex l (Server)
6939 @findex gnus-server-list-servers
6940 List all servers (@code{gnus-server-list-servers}).
6941
6942 @end table
6943
6944
6945 @node Example Methods
6946 @subsection Example Methods
6947
6948 Most select methods are pretty simple and self-explanatory: 
6949
6950 @lisp
6951 (nntp "news.funet.fi")
6952 @end lisp
6953
6954 Reading directly from the spool is even simpler:
6955
6956 @lisp
6957 (nnspool "")
6958 @end lisp
6959
6960 As you can see, the first element in a select method is the name of the
6961 backend, and the second is the @dfn{address}, or @dfn{name}, if you
6962 will. 
6963
6964 After these two elements, there may be a arbitrary number of
6965 @var{(variable form)} pairs.
6966
6967 To go back to the first example---imagine that you want to read from
6968 port @code{15} from that machine.  This is what the select method should
6969 look like then:
6970
6971 @lisp
6972 (nntp "news.funet.fi" (nntp-port-number 15))
6973 @end lisp
6974
6975 You should read the documentation to each backend to find out what
6976 variables are relevant, but here's an @code{nnmh} example. 
6977
6978 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
6979 you have two structures that you wish to access: One is your private
6980 mail spool, and the other is a public one.  Here's the possible spec for
6981 you private mail:
6982
6983 @lisp
6984 (nnmh "private" (nnmh-directory "~/private/mail/"))
6985 @end lisp
6986
6987 (This server is then called @samp{private}, but you may have guessed
6988 that.)
6989
6990 Here's the method for a public spool:
6991
6992 @lisp
6993 (nnmh "public" 
6994       (nnmh-directory "/usr/information/spool/") 
6995       (nnmh-get-new-mail nil))
6996 @end lisp
6997
6998
6999 @node Creating a Virtual Server
7000 @subsection Creating a Virtual Server
7001
7002 If you're saving lots of articles in the cache by using persistent
7003 articles, you may want to create a virtual server to read the cache.
7004
7005 First you need to add a new server.  The @kbd{a} command does that.  It
7006 would probably be best to use @code{nnspool} to read the cache.  You
7007 could also use @code{nnml} or @code{nnmh}, though.
7008
7009 Type @kbd{a nnspool RET cache RET}.
7010
7011 You should now have a brand new @code{nnspool} virtual server called
7012 @samp{cache}.  You now need to edit it to have the right definitions.
7013 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
7014 will contain the following:
7015
7016 @lisp
7017 (nnspool "cache")
7018 @end lisp
7019
7020 Change that to:
7021
7022 @lisp
7023 (nnspool "cache"
7024          (nnspool-spool-directory "~/News/cache/")
7025          (nnspool-nov-directory "~/News/cache/")
7026          (nnspool-active-file "~/News/cache/active"))
7027 @end lisp
7028
7029 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
7030 @kbd{RET} over this virtual server, you should be entered into a browse
7031 buffer, and you should be able to enter any of the groups displayed.
7032
7033
7034 @node Servers and Methods
7035 @subsection Servers and Methods
7036
7037 Wherever you would normally use a select method
7038 (eg. @code{gnus-secondary-select-method}, in the group select method,
7039 when browsing a foreign server) you can use a virtual server name
7040 instead.  This could potentially save lots of typing.  And it's nice all
7041 over.
7042
7043
7044 @node Unavailable Servers
7045 @subsection Unavailable Servers
7046
7047 If a server seems to be unreachable, Gnus will mark that server as
7048 @code{denied}.  That means that any subsequent attempt to make contact
7049 with that server will just be ignored.  ``It can't be opened,'' Gnus
7050 will tell you, without making the least effort to see whether that is
7051 actually the case or not.
7052
7053 That might seem quite naughty, but it does make sense most of the time.
7054 Let's say you have 10 groups subscribed to the server
7055 @samp{nepholococcygia.com}.  This server is located somewhere quite far
7056 away from you, the machine is quite, so it takes 1 minute just to find
7057 out that it refuses connection from you today.  If Gnus were to attempt
7058 to do that 10 times, you'd be quite annoyed, so Gnus won't attempt to do
7059 that.  Once it has gotten a single ``connection refused'', it will
7060 regard that server as ``down''.
7061
7062 So, what happens if the machine was only feeling unwell temporarily?
7063 How do you test to see whether the machine has come up again?
7064
7065 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
7066 with the following commands:
7067
7068 @table @kbd
7069
7070 @item O
7071 @kindex O (Server)
7072 @findex gnus-server-open-server
7073 Try to establish connection to the server on the current line
7074 (@code{gnus-server-open-server}).
7075
7076 @item C
7077 @kindex C (Server)
7078 @findex gnus-server-close-server
7079 Close the connection (if any) to the server
7080 (@code{gnus-server-close-server}).
7081
7082 @item D
7083 @kindex D (Server)
7084 @findex gnus-server-deny-server
7085 Mark the current server as unreachable
7086 (@code{gnus-server-deny-server}). 
7087
7088 @item R
7089 @kindex R (Server)
7090 @findex gnus-server-remove-denials
7091 Remove all marks to whether Gnus was denied connection from all servers
7092 (@code{gnus-server-remove-denials}). 
7093
7094 @end table
7095
7096
7097 @node Getting News
7098 @section Getting News
7099 @cindex reading news
7100 @cindex news backends
7101
7102 A newsreader is normally used for reading news.  Gnus currently provides
7103 only two methods of getting news -- it can read from an @sc{nntp}
7104 server, or it can read from a local spool.
7105
7106 @menu
7107 * NNTP::               Reading news from an @sc{nntp} server.
7108 * News Spool::         Reading news from the local spool.
7109 @end menu
7110
7111
7112 @node NNTP
7113 @subsection @sc{nntp}
7114 @cindex nntp
7115
7116 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
7117 You just specify @code{nntp} as method and the address of the @sc{nntp}
7118 server as the, uhm, address.
7119
7120 If the @sc{nntp} server is located at a non-standard port, setting the
7121 third element of the select method to this port number should allow you
7122 to connect to the right port.  You'll have to edit the group info for
7123 that (@pxref{Foreign Groups}).
7124
7125 The name of the foreign group can be the same as a native group.  In
7126 fact, you can subscribe to the same group from as many different servers
7127 you feel like.  There will be no name collisions.
7128
7129 The following variables can be used to create a virtual @code{nntp}
7130 server: 
7131
7132 @table @code
7133
7134 @item nntp-server-opened-hook
7135 @vindex nntp-server-opened-hook
7136 @cindex @sc{mode reader}
7137 @cindex authinfo
7138 @cindex authentification
7139 @cindex nntp authentification
7140 @findex nntp-send-authinfo
7141 @findex nntp-send-mode-reader
7142 @code{nntp-server-opened-hook} is run after a connection has been made.
7143 It can be used to send commands to the @sc{nntp} server after it has
7144 been contacted.  By default is sends the command @code{MODE READER} to
7145 the server with the @code{nntp-send-mode-reader} function.  Another
7146 popular function is @code{nntp-send-authinfo}, which will prompt you for
7147 an @sc{nntp} password and stuff.
7148
7149 @item nntp-server-action-alist 
7150 @vindex nntp-server-action-alist 
7151 This is an list of regexps to match on server types and actions to be
7152 taken when matches are made.  For instance, if you want Gnus to beep
7153 every time you connect to innd, you could say something like:
7154
7155 @lisp
7156 (setq nntp-server-action-alist
7157       '(("innd" (ding))))
7158 @end lisp
7159
7160 You probably don't want to do that, though.
7161
7162 The default value is
7163
7164 @lisp
7165   '(("nntpd 1\\.5\\.11t" 
7166      (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
7167 @end lisp
7168
7169 This ensures that Gnus doesn't send the @code{MODE READER} command to
7170 nntpd 1.5.11t, since that command chokes that server, I've been told. 
7171
7172 @item nntp-maximum-request
7173 @vindex nntp-maximum-request
7174 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
7175 will collect headers by sending a series of @code{head} commands.  To
7176 speed things up, the backend sends lots of these commands without
7177 waiting for reply, and then reads all the replies.  This is controlled
7178 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
7179 your network is buggy, you should set this to 1.
7180
7181 @item nntp-connection-timeout
7182 @vindex nntp-connection-timeout
7183 If you have lots of foreign @code{nntp} groups that you connect to
7184 regularly, you're sure to have problems with @sc{nntp} servers not
7185 responding properly, or being too loaded to reply within reasonable
7186 time.  This is can lead to awkward problems, which can be helped
7187 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
7188 that says how many seconds the @code{nntp} backend should wait for a
7189 connection before giving up.  If it is @code{nil}, which is the default,
7190 no timeouts are done.
7191
7192 @item nntp-command-timeout
7193 @vindex nntp-command-timeout
7194 @cindex PPP connections
7195 @cindex dynamic IP addresses
7196 If you're running Gnus on a machine that has a dynamically assigned
7197 address, Gnus may become confused.  If the address of your machine
7198 changes after connecting to the @sc{nntp} server, Gnus will simply sit
7199 waiting forever for replies from the server.  To help with this
7200 unfortunate problem, you can set this command to a number.  Gnus will
7201 then, if it sits waiting longer than that number of seconds for a reply
7202 from the server, shut down the connection, start a new one, and resend
7203 the command.  This should hopefully be transparent to the user.  A
7204 likely number is 30 seconds. 
7205
7206 @item nntp-retry-on-break
7207 @vindex nntp-retry-on-break
7208 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
7209 hangs.  This will have much the same effect as the command timeout
7210 described above.
7211
7212 @item nntp-server-hook
7213 @vindex nntp-server-hook
7214 This hook is run as the last step when connecting to an @sc{nntp}
7215 server.
7216
7217 @findex nntp-open-rlogin
7218 @findex nntp-open-network-stream
7219 @item nntp-open-server-function
7220 @vindex nntp-open-server-function
7221 This function is used to connect to the remote system.  Two pre-made
7222 functions are @code{nntp-open-network-stream}, which is the default, and
7223 simply connects to some port or other on the remote system.  The other
7224 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
7225 and then does a telnet to the @sc{nntp} server available there.
7226
7227 @item nntp-rlogin-parameters
7228 @vindex nntp-rlogin-parameters
7229 If you use @code{nntp-open-rlogin} as the
7230 @code{nntp-open-server-function}, this list will be used as the
7231 parameter list given to @code{rsh}.
7232
7233 @item nntp-end-of-line
7234 @vindex nntp-end-of-line
7235 String to use as end-of-line markers when talking to the @sc{nntp}
7236 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
7237 using @code{rlogin} to talk to the server.
7238
7239 @item nntp-rlogin-user-name
7240 @vindex nntp-rlogin-user-name
7241 User name on the remote system when using the @code{rlogin} connect
7242 function. 
7243
7244 @item nntp-address
7245 @vindex nntp-address
7246 The address of the remote system running the @sc{nntp} server.
7247
7248 @item nntp-port-number
7249 @vindex nntp-port-number
7250 Port number to connect to when using the @code{nntp-open-network-stream}
7251 connect function.
7252
7253 @item nntp-buggy-select
7254 @vindex nntp-buggy-select
7255 Set this to non-@code{nil} if your select routine is buggy.
7256
7257 @item nntp-nov-is-evil 
7258 @vindex nntp-nov-is-evil 
7259 If the @sc{nntp} server does not support @sc{nov}, you could set this
7260 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
7261 can be used automatically.
7262
7263 @item nntp-xover-commands
7264 @vindex nntp-xover-commands
7265 @cindex nov
7266 @cindex XOVER
7267 List of strings that are used as commands to fetch @sc{nov} lines from a
7268 server.  The default value of this variable is @code{("XOVER"
7269 "XOVERVIEW")}. 
7270
7271 @item nntp-nov-gap
7272 @vindex nntp-nov-gap
7273 @code{nntp} normally sends just one big request for @sc{nov} lines to
7274 the server.  The server responds with one huge list of lines.  However,
7275 if you have read articles 2-5000 in the group, and only want to read
7276 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
7277 lines that you do not want, and will not use.  This variable says how
7278 big a gap between two consecutive articles is allowed to be before the
7279 @code{XOVER} request is split into several request.  Note that if your
7280 network is fast, setting this variable to a really small number means
7281 that fetching will probably be slower.  If this variable is @code{nil},
7282 @code{nntp} will never split requests.
7283
7284 @item nntp-prepare-server-hook
7285 @vindex nntp-prepare-server-hook
7286 A hook run before attempting to connect to an @sc{nntp} server.
7287
7288 @item nntp-async-number
7289 @vindex nntp-async-number
7290 How many articles should be pre-fetched when in asynchronous mode.  If
7291 this variable is @code{t}, @code{nntp} will pre-fetch all the articles
7292 that it can without bound.  If it is @code{nil}, no pre-fetching will be
7293 made.
7294
7295 @item nntp-warn-about-losing-connection
7296 @vindex nntp-warn-about-losing-connection
7297 If this variable is non-@code{nil}, some noise will be made when a
7298 server closes connection.
7299
7300 @end table
7301
7302
7303 @node News Spool
7304 @subsection News Spool
7305 @cindex nnspool
7306 @cindex news spool
7307
7308 Subscribing to a foreign group from the local spool is extremely easy,
7309 and might be useful, for instance, to speed up reading groups like
7310 @samp{alt.binaries.pictures.furniture}.
7311
7312 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
7313 anything else) as the address.
7314
7315 If you have access to a local spool, you should probably use that as the
7316 native select method (@pxref{Finding the News}).  It is normally faster
7317 than using an @code{nntp} select method, but might not be.  It depends.
7318 You just have to try to find out what's best at your site.
7319
7320 @table @code
7321
7322 @item nnspool-inews-program
7323 @vindex nnspool-inews-program
7324 Program used to post an article.
7325
7326 @item nnspool-inews-switches
7327 @vindex nnspool-inews-switches
7328 Parameters given to the inews program when posting an article. 
7329
7330 @item nnspool-spool-directory
7331 @vindex nnspool-spool-directory
7332 Where @code{nnspool} looks for the articles.  This is normally
7333 @file{/usr/spool/news/}.
7334
7335 @item nnspool-nov-directory 
7336 @vindex nnspool-nov-directory 
7337 Where @code{nnspool} will look for @sc{nov} files.  This is normally
7338 @file{/usr/spool/news/over.view/}.
7339
7340 @item nnspool-lib-dir
7341 @vindex nnspool-lib-dir
7342 Where the news lib dir is (@file{/usr/lib/news/} by default).
7343
7344 @item nnspool-active-file
7345 @vindex nnspool-active-file
7346 The path of the active file.
7347
7348 @item nnspool-newsgroups-file
7349 @vindex nnspool-newsgroups-file
7350 The path of the group descriptions file.
7351
7352 @item nnspool-history-file
7353 @vindex nnspool-history-file
7354 The path of the news history file.
7355
7356 @item nnspool-active-times-file
7357 @vindex nnspool-active-times-file
7358 The path of the active date file.
7359
7360 @item nnspool-nov-is-evil
7361 @vindex nnspool-nov-is-evil
7362 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
7363 that it finds.
7364
7365 @item nnspool-sift-nov-with-sed
7366 @vindex nnspool-sift-nov-with-sed
7367 @cindex sed
7368 If non-@code{nil}, which is the default, use @code{sed} to get the
7369 relevant portion from the overview file.  If nil, @code{nnspool} will
7370 load the entire file into a buffer and process it there.
7371
7372 @end table
7373
7374
7375 @node Getting Mail
7376 @section Getting Mail
7377 @cindex reading mail
7378 @cindex mail
7379
7380 Reading mail with a newsreader---isn't that just plain WeIrD? But of
7381 course.
7382
7383 @menu
7384 * Getting Started Reading Mail:: A simple cookbook example.
7385 * Splitting Mail::               How to create mail groups.
7386 * Mail Backend Variables::       Variables for customizing mail handling.
7387 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
7388 * Mail and Procmail::            Reading mail groups that procmail create.
7389 * Incorporating Old Mail::       What about the old mail you have?
7390 * Expiring Mail::                Getting rid of unwanted mail.
7391 * Duplicates::                   Dealing with duplicated mail.
7392 * Not Reading Mail::             Using mail backends for reading other files.
7393 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
7394 @end menu
7395
7396
7397 @node Getting Started Reading Mail
7398 @subsection Getting Started Reading Mail
7399
7400 It's quite easy to use Gnus to read your new mail.  You just plonk the
7401 mail backend of your choice into @code{gnus-secondary-select-methods},
7402 and things will happen automatically.
7403
7404 For instance, if you want to use @code{nnml} (which is a one file per
7405 mail backend), you could put the following in your @file{.gnus} file:
7406
7407 @lisp
7408 (setq gnus-secondary-select-methods
7409       '((nnml "private")))
7410 @end lisp
7411
7412 Now, the next time you start Gnus, this backend will be queried for new
7413 articles, and it will move all the messages in your spool file to its
7414 directory, which is @code{~/Mail/} by default.  The new group that will
7415 be created (@samp{mail.misc}) will be subscribed, and you can read it
7416 like any other group.
7417
7418 You will probably want to split the mail into several groups, though:
7419
7420 @lisp
7421 (setq nnmail-split-methods
7422   '(("junk" "^From:.*Lars Ingebrigtsen")
7423     ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
7424     ("other" "")))
7425 @end lisp
7426
7427 This will result in three new mail groups being created:
7428 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
7429 mail that doesn't fit into the first two groups will be placed in the
7430 latter group.
7431
7432 This should be sufficient for reading mail with Gnus.  You might want to
7433 give the other sections in this part of the manual a perusal, though,
7434 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
7435
7436
7437 @node Splitting Mail
7438 @subsection Splitting Mail
7439 @cindex splitting mail
7440 @cindex mail splitting
7441
7442 @vindex nnmail-split-methods
7443 The @code{nnmail-split-methods} variable says how the incoming mail is
7444 to be split into groups.
7445
7446 @lisp
7447 (setq nnmail-split-methods
7448   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
7449     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
7450     ("mail.other" "")))
7451 @end lisp
7452
7453 This variable is a list of lists, where the first element of each of
7454 these lists is the name of the mail group (they do not have to be called
7455 something beginning with @samp{mail}, by the way), and the second
7456 element is a regular expression used on the header of each mail to
7457 determine if it belongs in this mail group.
7458
7459 The second element can also be a function.  In that case, it will be
7460 called narrowed to the headers with the first element of the rule as the
7461 argument.  It should return a non-@code{nil} value if it thinks that the
7462 mail belongs in that group.
7463
7464 The last of these groups should always be a general one, and the regular
7465 expression should @emph{always} be @samp{} so that it matches any
7466 mails that haven't been matched by any of the other regexps.
7467
7468 If you like to tinker with this yourself, you can set this variable to a
7469 function of your choice.  This function will be called without any
7470 arguments in a buffer narrowed to the headers of an incoming mail
7471 message.  The function should return a list of groups names that it
7472 thinks should carry this mail message.
7473
7474 Note that the mail backends are free to maul the poor, innocent
7475 incoming headers all they want to.  They all add @code{Lines} headers;
7476 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
7477 @code{From<SPACE>} line to something else.
7478
7479 @vindex nnmail-crosspost
7480 The mail backends all support cross-posting.  If several regexps match,
7481 the mail will be ``cross-posted'' to all those groups.
7482 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
7483 that no articles are crossposted to the general (@samp{}) group.
7484
7485 @vindex nnmail-crosspost-link-function
7486 @cindex crosspost
7487 @cindex links
7488 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
7489 the crossposted articles.  However, not all files systems support hard
7490 links.  If that's the case for you, set
7491 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
7492 variable is @code{add-name-to-file} by default.)  
7493
7494 Gnus gives you all the opportunity you could possibly want for shooting
7495 yourself in the foot.  Let's say you create a group that will contain
7496 all the mail you get from your boss.  And then you accidentally
7497 unsubscribe from the group.  Gnus will still put all the mail from your
7498 boss in the unsubscribed group, and so, when your boss mails you ``Have
7499 that report ready by Monday or you're fired!'', you'll never see it and,
7500 come Tuesday, you'll still believe that you're gainfully employed while
7501 you really should be out collecting empty bottles to save up for next
7502 month's rent money.
7503
7504
7505 @node Mail Backend Variables
7506 @subsection Mail Backend Variables
7507
7508 These variables are (for the most part) pertinent to all the various
7509 mail backends.
7510
7511 @table @code
7512 @vindex nnmail-read-incoming-hook
7513 @item nnmail-read-incoming-hook
7514 The mail backends all call this hook after reading new mail.  You can
7515 use this hook to notify any mail watch programs, if you want to.
7516
7517 @vindex nnmail-spool-file
7518 @item nnmail-spool-file
7519 @cindex POP mail
7520 @cindex MAILHOST
7521 @cindex movemail
7522 @vindex nnmail-pop-password
7523 @vindex nnmail-pop-password-required
7524 The backends will look for new mail in this file.  If this variable is
7525 @code{nil}, the mail backends will never attempt to fetch mail by
7526 themselves.  If you are using a POP mail server and your name is
7527 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
7528 your name is not @samp{larsi}, you should probably modify that
7529 slightly, but you may have guessed that already, you smart & handsome
7530 devil!  You can also set this variable to @code{pop}, and Gnus will try
7531 to figure out the POP mail string by itself.  In any case, Gnus will
7532 call @code{movemail} which will contact the POP server named in the
7533 @code{MAILHOST} environment variable.  If the POP server needs a
7534 password, you can either set @code{nnmail-pop-password-required} to
7535 @code{t} and be prompted for the password, or set
7536 @code{nnmail-pop-password} to the password itself.
7537
7538 When you use a mail backend, Gnus will slurp all your mail from your
7539 inbox and plonk it down in your home directory.  Gnus doesn't move any
7540 mail if you're not using a mail backend---you have to do a lot of magic
7541 invocations first.  At the time when you have finished drawing the
7542 pentagram, lightened the candles, and sacrificed the goat, you really
7543 shouldn't be too surprised when Gnus moves your mail.
7544
7545 @vindex nnmail-use-procmail
7546 @vindex nnmail-procmail-suffix
7547 @item nnmail-use-procmail
7548 If non-@code{nil}, the mail backends will look in
7549 @code{nnmail-procmail-directory} for incoming mail.  All the files in
7550 that directory that have names ending in @code{nnmail-procmail-suffix}
7551 will be considered incoming mailboxes, and will be searched for new
7552 mail.
7553
7554 @vindex nnmail-crash-box
7555 @item nnmail-crash-box
7556 When the mail backends read a spool file, it is first moved to this
7557 file, which is @file{~/.gnus-crash-box} by default.  If this file
7558 already exists, it will always be read (and incorporated) before any
7559 other spool files.
7560
7561 @vindex nnmail-prepare-incoming-hook
7562 @item nnmail-prepare-incoming-hook
7563 This is run in a buffer that holds all the new incoming mail, and can be
7564 used for, well, anything, really.
7565
7566 @vindex nnmail-pre-get-new-mail-hook
7567 @vindex nnmail-post-get-new-mail-hook
7568 @item nnmail-pre-get-new-mail-hook
7569 @itemx nnmail-post-get-new-mail-hook
7570 These are two useful hooks executed when treating new incoming
7571 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
7572 starting to handle the new mail) and
7573 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
7574 is done).  Here's and example of using these two hooks to change the
7575 default file modes the new mail files get:
7576
7577 @lisp
7578 (add-hook 'gnus-pre-get-new-mail-hook 
7579           (lambda () (set-default-file-modes 511)))
7580
7581 (add-hook 'gnus-post-get-new-mail-hook 
7582           (lambda () (set-default-file-modes 551)))
7583 @end lisp
7584
7585 @item nnmail-tmp-directory
7586 @vindex nnmail-tmp-directory
7587 This variable says where to move the incoming mail to while processing
7588 it.  This is usually done in the same directory that the mail backend
7589 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
7590 it will be used instead.
7591
7592 @item nnmail-movemail-program
7593 @vindex nnmail-movemail-program
7594 This program is executed to move mail from the user's inbox to her home
7595 directory.  The default is @samp{movemail}.
7596
7597 @item nnmail-delete-incoming
7598 @vindex nnmail-delete-incoming
7599 @cindex incoming mail files
7600 @cindex deleting incoming files
7601 If non-@code{nil}, the mail backends will delete the temporary incoming
7602 file after splitting mail into the proper groups.  This is @code{nil} by
7603 default for reasons of security.
7604
7605 @item nnmail-use-long-file-names
7606 @vindex nnmail-use-long-file-names
7607 If non-@code{nil}, the mail backends will use long file and directory
7608 names.  Groups like @samp{mail.misc} will end up in directories like
7609 @file{mail.misc/}.  If it is @code{nil}, the same group will end up in
7610 @file{mail/misc/}.
7611
7612 @item nnmail-delete-file-function
7613 @vindex nnmail-delete-file-function
7614 @findex delete-file
7615 Function called to delete files.  It is @code{delete-file} by default. 
7616
7617 @end table
7618
7619
7620 @node Fancy Mail Splitting
7621 @subsection Fancy Mail Splitting
7622 @cindex mail splitting
7623 @cindex fancy mail splitting
7624
7625 @vindex nnmail-split-fancy
7626 @findex nnmail-split-fancy
7627 If the rather simple, standard method for specifying how to split mail
7628 doesn't allow you to do what you want, you can set
7629 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
7630 play with the @code{nnmail-split-fancy} variable. 
7631
7632 Let's look at an example value of this variable first:
7633
7634 @lisp
7635 ;; Messages from the mailer daemon are not crossposted to any of
7636 ;; the ordinary groups.  Warnings are put in a separate group
7637 ;; from real errors.
7638 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
7639                    "mail.misc"))
7640    ;; Non-error messages are crossposted to all relevant
7641    ;; groups, but we don't crosspost between the group for the
7642    ;; (ding) list and the group for other (ding) related mail.
7643    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
7644          ("subject" "ding" "ding.misc"))
7645       ;; Other mailing lists...
7646       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
7647       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
7648       ;; People...
7649       (any "larsi@@ifi\\.uio\\.no" "people.Lars Magne Ingebrigtsen"))
7650    ;; Unmatched mail goes to the catch all group.
7651    "misc.misc"))")
7652 @end lisp
7653
7654 This variable has the format of a @dfn{split}.  A split is a (possibly)
7655 recursive structure where each split may contain other splits.  Here are
7656 the four possible split syntaxes:
7657
7658 @table @dfn
7659
7660 @item GROUP 
7661 If the split is a string, that will be taken as a group name. 
7662
7663 @item (FIELD VALUE SPLIT)
7664 If the split is a list, and the first element is a string, then that
7665 means that if header FIELD (a regexp) contains VALUE (also a regexp),
7666 then store the message as specified by SPLIT.
7667
7668 @item (| SPLIT...)
7669 If the split is a list, and the first element is @code{|} (vertical
7670 bar), then process each SPLIT until one of them matches.  A SPLIT is
7671 said to match if it will cause the mail message to be stored in one or
7672 more groups.
7673
7674 @item (& SPLIT...)
7675 If the split is a list, and the first element is @code{&}, then process
7676 all SPLITs in the list.
7677 @end table
7678
7679 In these splits, FIELD must match a complete field name.  VALUE must
7680 match a complete word according to the fundamental mode syntax table.
7681 You can use @code{.*} in the regexps to match partial field names or
7682 words.
7683
7684 @vindex nnmail-split-abbrev-alist
7685 FIELD and VALUE can also be lisp symbols, in that case they are expanded
7686 as specified by the variable @code{nnmail-split-abbrev-alist}.  This is
7687 an alist of cons cells, where the car of the cells contains the key, and
7688 the cdr contains a string.
7689
7690 @vindex nnmail-split-fancy-syntax-table
7691 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
7692 when all this splitting is performed.
7693
7694
7695 @node Mail and Procmail
7696 @subsection Mail and Procmail
7697 @cindex procmail
7698
7699 @cindex slocal
7700 @cindex elm
7701 Many people use @code{procmail} (or some other mail filter program or
7702 external delivery agent---@code{slocal}, @code{elm}, etc) to split
7703 incoming mail into groups.  If you do that, you should set
7704 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
7705 backends never ever try to fetch mail by themselves.
7706
7707 This also means that you probably don't want to set
7708 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
7709 side effects.
7710
7711 When a mail backend is queried for what groups it carries, it replies
7712 with the contents of that variable, along with any groups it has figured
7713 out that it carries by other means.  None of the backends (except
7714 @code{nnmh}) actually go out to the disk and check what groups actually
7715 exist.  (It's not trivial to distinguish between what the user thinks is
7716 a basis for a newsgroup and what is just a plain old file or directory.)
7717
7718 This means that you have to tell Gnus (and the backends) what groups
7719 exist by hand.
7720
7721 Let's take the @code{nnmh} backend as an example. 
7722
7723 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
7724 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
7725
7726 Go to the group buffer and type @kbd{G m}.  When prompted, answer
7727 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
7728 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
7729 to include all your mail groups.
7730
7731 That's it.  You are now set to read your mail.  An active file for this
7732 method will be created automatically.
7733
7734 @vindex nnmail-procmail-suffix
7735 @vindex nnmail-procmail-directory
7736 If you use @code{nnfolder} or any other backend that store more than a
7737 single article in each file, you should never have procmail add mails to
7738 the file that Gnus sees.  Instead, procmail should put all incoming mail
7739 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
7740 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
7741 name.  The mail backends will read the mail from these files.
7742
7743 @vindex nnmail-resplit-incoming
7744 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
7745 put in the @code{mail.misc}, as one would expect.  However, if you want
7746 Gnus to split the mail the normal way, you could set
7747 @code{nnmail-resplit-incoming} to @code{t}.
7748
7749 @vindex nnmail-keep-last-article
7750 If you use @code{procmail} to split things directory into an @code{nnmh}
7751 directory (which you shouldn't do), you should set
7752 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
7753 ever expiring the final article in a mail newsgroup.  This is quite,
7754 quite important.
7755
7756
7757 @node Incorporating Old Mail
7758 @subsection Incorporating Old Mail
7759
7760 Most people have lots of old mail stored in various file formats.  If
7761 you have set up Gnus to read mail using one of the spiffy Gnus mail
7762 backends, you'll probably wish to have that old mail incorporated into
7763 your mail groups.
7764
7765 Doing so can be quite easy.
7766
7767 To take an example: You're reading mail using @code{nnml}
7768 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
7769 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
7770 file filled with important, but old, mail.  You want to move it into
7771 your @code{nnml} groups.
7772
7773 Here's how:
7774
7775 @enumerate
7776 @item
7777 Go to the group buffer.
7778
7779 @item 
7780 Type `G f' and give the path of the mbox file when prompted to create an
7781 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
7782
7783 @item 
7784 Type `SPACE' to enter the newly created group.
7785
7786 @item
7787 Type `M P b' to process-mark all articles in this group (@pxref{Setting
7788 Process Marks}).
7789
7790 @item 
7791 Type `B r' to respool all the process-marked articles, and answer
7792 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
7793 @end enumerate
7794
7795 All the mail messages in the mbox file will now also be spread out over
7796 all your @code{nnml} groups.  Try entering them and check whether things
7797 have gone without a glitch.  If things look ok, you may consider
7798 deleting the mbox file, but I wouldn't do that unless I was absolutely
7799 sure that all the mail has ended up where it should be.
7800
7801 Respooling is also a handy thing to do if you're switching from one mail
7802 backend to another.  Just respool all the mail in the old mail groups
7803 using the new mail backend.
7804
7805
7806 @node Expiring Mail
7807 @subsection Expiring Mail
7808 @cindex article expiry
7809
7810 Traditional mail readers have a tendency to remove mail articles when
7811 you mark them as read, in some way.  Gnus takes a fundamentally
7812 different approach to mail reading.
7813
7814 Gnus basically considers mail just to be news that has been received in
7815 a rather peculiar manner.  It does not think that it has the power to
7816 actually change the mail, or delete any mail messages.  If you enter a
7817 mail group, and mark articles as ``read'', or kill them in some other
7818 fashion, the mail articles will still exist on the system.  I repeat:
7819 Gnus will not delete your old, read mail.  Unless you ask it to, of
7820 course.
7821
7822 To make Gnus get rid of your unwanted mail, you have to mark the
7823 articles as @dfn{expirable}.  This does not mean that the articles will
7824 disappear right away, however.  In general, a mail article will be
7825 deleted from your system if, 1) it is marked as expirable, AND 2) it is
7826 more than one week old.  If you do not mark an article as expirable, it
7827 will remain on your system until hell freezes over.  This bears
7828 repeating one more time, with some spurious capitalizations: IF you do
7829 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
7830
7831 @vindex gnus-auto-expirable-newsgroups
7832 You do not have to mark articles as expirable by hand.  Groups that
7833 match the regular expression @code{gnus-auto-expirable-newsgroups} will
7834 have all articles that you read marked as expirable automatically.  All
7835 articles that are marked as expirable have an @samp{E} in the first
7836 column in the summary buffer.
7837
7838 Let's say you subscribe to a couple of mailing lists, and you want the
7839 articles you have read to disappear after a while:
7840
7841 @lisp
7842 (setq gnus-auto-expirable-newsgroups 
7843       "mail.nonsense-list\\|mail.nice-list")
7844 @end lisp
7845
7846 Another way to have auto-expiry happen is to have the element
7847 @code{auto-expire} in the group parameters of the group. 
7848
7849 @vindex nnmail-expiry-wait
7850 The @code{nnmail-expiry-wait} variable supplies the default time an
7851 expirable article has to live.  The default is seven days.  
7852
7853 Gnus also supplies a function that lets you fine-tune how long articles
7854 are to live, based on what group they are in.  Let's say you want to
7855 have one month expiry period in the @samp{mail.private} group, a one day
7856 expiry period in the @samp{mail.junk} group, and a six day expiry period
7857 everywhere else:
7858
7859 @vindex nnmail-expiry-wait-function
7860 @lisp
7861 (setq nnmail-expiry-wait-function
7862       (lambda (group)
7863        (cond ((string= group "mail.private")
7864                31)
7865              ((string= group "mail.junk")
7866                1)
7867              ((string= group "important")
7868                'never)
7869              (t
7870                6))))
7871 @end lisp
7872
7873 The group names that this function is fed are ``unadorned'' group
7874 names---no @samp{nnml:} prefixes and the like.
7875
7876 The @code{nnmail-expiry-wait} variable and
7877 @code{nnmail-expiry-wait-function} function can be either a number (not
7878 necessarily an integer) or the symbols @code{immediate} or
7879 @code{never}.  
7880
7881 You can also use the @code{expiry-wait} group parameter to selectively
7882 change the expiry period (@pxref{Group Parameters}).
7883
7884 @vindex nnmail-keep-last-article
7885 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
7886 expire the final article in a mail newsgroup.  This is to make life
7887 easier for procmail users.
7888
7889 @vindex gnus-total-expirable-newsgroups
7890 By the way, that line up there about Gnus never expiring non-expirable
7891 articles is a lie.  If you put @code{total-expire} in the group
7892 parameters, articles will not be marked as expirable, but all read
7893 articles will be put through the expiry process.  Use with extreme
7894 caution.  Even more dangerous is the
7895 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
7896 this regexp will have all read articles put through the expiry process,
7897 which means that @emph{all} old mail articles in the groups in question
7898 will be deleted after a while.  Use with extreme caution, and don't come
7899 crying to me when you discover that the regexp you used matched the
7900 wrong group and all your important mail has disappeared.  Be a
7901 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
7902 with!  So there!
7903
7904
7905 @node Duplicates
7906 @subsection Duplicates
7907
7908 @vindex nnmail-treat-duplicates
7909 @vindex nnmail-message-id-cache-length
7910 @vindex nnmail-message-id-cache-file
7911 @cindex duplicate mails
7912 If you are a member of a couple of mailing list, you will sometime
7913 receive two copies of the same mail.  This can be quite annoying, so
7914 @code{nnmail} checks for and treats any duplicates it might find.  To do
7915 this, it keeps a cache of old @code{Message-ID}s -
7916 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
7917 default.  The approximate maximum number of @code{Message-ID}s stored
7918 there is controlled by the @code{nnmail-message-id-cache-length}
7919 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
7920 stored.) If all this sounds scary to you, you can set
7921 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
7922 default), and @code{nnmail} won't delete duplicate mails.  Instead it
7923 will generate a brand new @code{Message-ID} for the mail and insert a
7924 warning into the head of the mail saying that it thinks that this is a
7925 duplicate of a different message.  
7926
7927 This variable can also be a function.  If that's the case, the function
7928 will be called from a buffer narrowed to the message in question with
7929 the @code{Message-ID} as a parameter.  The function must return either
7930 @code{nil}, @code{warn}, or @code{delete}.
7931
7932 You can turn this feature off completely by setting the variable to
7933 @code{nil}.
7934
7935 If you want all the duplicate mails to be put into a special
7936 @dfn{duplicates} group, you could do that using the normal mail split
7937 methods:
7938
7939 @lisp
7940 (setq nnmail-split-fancy
7941       '(| ;; Messages duplicates go to a separate group.
7942           ("gnus-warning" "duplication of message" "duplicate")
7943           ;; Message from daemons, postmaster, and the like to another.
7944           (any mail "mail.misc")
7945           ;; Other rules.
7946           [ ... ] ))
7947 @end lisp
7948
7949 Or something like:
7950 @lisp
7951 (setq nnmail-split-methods 
7952       '(("duplicates" "^Gnus-Warning:")
7953         ;; Other rules.
7954         [...]))
7955 @end lisp
7956
7957 Here's a neat feature: If you know that the recipient reads her mail
7958 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
7959 @code{delete}, you can send her as many insults as you like, just by
7960 using a @code{Message-ID} of a mail that you know that she's already
7961 received.  Think of all the fun!  She'll never see any of it!  Whee!
7962
7963
7964 @node Not Reading Mail
7965 @subsection Not Reading Mail
7966
7967 If you start using any of the mail backends, they have the annoying
7968 habit of assuming that you want to read mail with them.  This might not
7969 be unreasonable, but it might not be what you want.
7970
7971 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
7972 will ever attempt to read incoming mail, which should help.
7973
7974 @vindex nnbabyl-get-new-mail
7975 @vindex nnmbox-get-new-mail
7976 @vindex nnml-get-new-mail
7977 @vindex nnmh-get-new-mail
7978 @vindex nnfolder-get-new-mail
7979 This might be too much, if, for instance, you are reading mail quite
7980 happily with @code{nnml} and just want to peek at some old @sc{rmail}
7981 file you have stashed away with @code{nnbabyl}.  All backends have
7982 variables called backend-@code{get-new-mail}.  If you want to disable
7983 the @code{nnbabyl} mail reading, you edit the virtual server for the
7984 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
7985
7986 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
7987 narrowed to the article to be saved before saving it when reading
7988 incoming mail.
7989
7990
7991 @node Choosing a Mail Backend
7992 @subsection Choosing a Mail Backend
7993
7994 Gnus will read the mail spool when you activate a mail group.  The mail
7995 file is first copied to your home directory.  What happens after that
7996 depends on what format you want to store your mail in.
7997
7998 @menu
7999 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
8000 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
8001 * Mail Spool::                  Store your mail in a private spool?
8002 * MH Spool::                    An mhspool-like backend.
8003 * Mail Folders::                Having one file for each group.
8004 @end menu
8005
8006
8007 @node Unix Mail Box
8008 @subsubsection Unix Mail Box
8009 @cindex nnmbox
8010 @cindex unix mail box
8011
8012 @vindex nnmbox-active-file
8013 @vindex nnmbox-mbox-file
8014 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
8015 mail.  @code{nnmbox} will add extra headers to each mail article to say
8016 which group it belongs in.
8017
8018 Virtual server settings:
8019
8020 @table @code
8021 @item nnmbox-mbox-file
8022 @vindex nnmbox-mbox-file
8023 The name of the mail box in the user's home directory. 
8024
8025 @item nnmbox-active-file
8026 @vindex nnmbox-active-file
8027 The name of the active file for the mail box.
8028
8029 @item nnmbox-get-new-mail
8030 @vindex nnmbox-get-new-mail
8031 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
8032 into groups.
8033 @end table
8034
8035
8036 @node Rmail Babyl
8037 @subsubsection Rmail Babyl
8038 @cindex nnbabyl
8039 @cindex rmail mbox
8040
8041 @vindex nnbabyl-active-file
8042 @vindex nnbabyl-mbox-file
8043 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
8044 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
8045 article to say which group it belongs in.
8046
8047 Virtual server settings:
8048
8049 @table @code
8050 @item nnbabyl-mbox-file
8051 @vindex nnbabyl-mbox-file
8052 The name of the rmail mbox file.
8053
8054 @item nnbabyl-active-file
8055 @vindex nnbabyl-active-file
8056 The name of the active file for the rmail box.
8057
8058 @item nnbabyl-get-new-mail
8059 @vindex nnbabyl-get-new-mail
8060 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
8061 @end table
8062
8063
8064 @node Mail Spool
8065 @subsubsection Mail Spool
8066 @cindex nnml
8067 @cindex mail @sc{nov} spool
8068
8069 The @dfn{nnml} spool mail format isn't compatible with any other known
8070 format.  It should be used with some caution.
8071
8072 @vindex nnml-directory
8073 If you use this backend, Gnus will split all incoming mail into files;
8074 one file for each mail, and put the articles into the correct
8075 directories under the directory specified by the @code{nnml-directory}
8076 variable.  The default value is @file{~/Mail/}.
8077
8078 You do not have to create any directories beforehand; Gnus will take
8079 care of all that.
8080
8081 If you have a strict limit as to how many files you are allowed to store
8082 in your account, you should not use this backend.  As each mail gets its
8083 own file, you might very well occupy thousands of inodes within a few
8084 weeks.  If this is no problem for you, and it isn't a problem for you
8085 having your friendly systems administrator walking around, madly,
8086 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
8087 know that this is probably the fastest format to use.  You do not have
8088 to trudge through a big mbox file just to read your new mail.
8089
8090 @code{nnml} is probably the slowest backend when it comes to article
8091 splitting.  It has to create lots of files, and it also generates
8092 @sc{nov} databases for the incoming mails.  This makes is the fastest
8093 backend when it comes to reading mail.
8094
8095 Virtual server settings:
8096
8097 @table @code
8098 @item nnml-directory
8099 @vindex nnml-directory
8100 All @code{nnml} directories will be placed under this directory. 
8101
8102 @item nnml-active-file
8103 @vindex nnml-active-file
8104 The active file for the @code{nnml} server.
8105
8106 @item nnml-newsgroups-file
8107 @vindex nnml-newsgroups-file
8108 The @code{nnml} group descriptions file.  @xref{Newsgroups File
8109 Format}. 
8110
8111 @item nnml-get-new-mail
8112 @vindex nnml-get-new-mail
8113 If non-@code{nil}, @code{nnml} will read incoming mail.
8114
8115 @item nnml-nov-is-evil
8116 @vindex nnml-nov-is-evil
8117 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
8118
8119 @item nnml-nov-file-name
8120 @vindex nnml-nov-file-name
8121 The name of the @sc{nov} files.  The default is @file{.overview}. 
8122
8123 @item nnml-prepare-save-mail-hook
8124 @vindex nnml-prepare-save-mail-hook
8125 Hook run narrowed to an article before saving.
8126
8127 @end table
8128
8129 @findex nnml-generate-nov-databases
8130 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
8131 you can do a complete update by typing @kbd{M-x
8132 nnml-generate-nov-databases}.  This command will trawl through the
8133 entire @code{nnml} hierarchy, looking at each and every article, so it
8134 might take a while to complete.
8135
8136
8137 @node MH Spool
8138 @subsubsection MH Spool
8139 @cindex nnmh
8140 @cindex mh-e mail spool
8141
8142 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
8143 @sc{nov} databases and it doesn't keep an active file.  This makes
8144 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
8145 makes it easier to write procmail scripts for.
8146
8147 Virtual server settings:
8148
8149 @table @code
8150 @item nnmh-directory
8151 @vindex nnmh-directory
8152 All @code{nnmh} directories will be located under this directory.
8153
8154 @item nnmh-get-new-mail
8155 @vindex nnmh-get-new-mail
8156 If non-@code{nil}, @code{nnmh} will read incoming mail.
8157
8158 @item nnmh-be-safe
8159 @vindex nnmh-be-safe
8160 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
8161 sure that the articles in the folder are actually what Gnus thinks they
8162 are.  It will check date stamps and stat everything in sight, so
8163 setting this to @code{t} will mean a serious slow-down.  If you never
8164 use anything but Gnus to read the @code{nnmh} articles, you do not have
8165 to set this variable to @code{t}.
8166 @end table
8167
8168
8169 @node Mail Folders
8170 @subsubsection Mail Folders
8171 @cindex nnfolder
8172 @cindex mbox folders
8173 @cindex mail folders
8174
8175 @code{nnfolder} is a backend for storing each mail group in a separate
8176 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
8177 will add extra headers to keep track of article numbers and arrival
8178 dates.
8179
8180 Virtual server settings:
8181
8182 @table @code
8183 @item nnfolder-directory
8184 @vindex nnfolder-directory
8185 All the @code{nnfolder} mail boxes will be stored under this directory. 
8186
8187 @item nnfolder-active-file
8188 @vindex nnfolder-active-file
8189 The name of the active file.
8190
8191 @item nnfolder-newsgroups-file
8192 @vindex nnfolder-newsgroups-file
8193 The name of the group descriptions file.  @xref{Newsgroups File Format}.
8194
8195 @item nnfolder-get-new-mail
8196 @vindex nnfolder-get-new-mail
8197 If non-@code{nil}, @code{nnfolder} will read incoming mail.
8198 @end table
8199
8200 @findex nnfolder-generate-active-file
8201 @kindex M-x nnfolder-generate-active-file
8202 If you have lots of @code{nnfolder}-like files you'd like to read with
8203 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
8204 command to make @code{nnfolder} aware of all likely files in
8205 @code{nnfolder-directory}.
8206
8207
8208 @node Other Sources
8209 @section Other Sources
8210
8211 Gnus can do more than just read news or mail.  The methods described
8212 below allow Gnus to view directories and files as if they were
8213 newsgroups.
8214
8215 @menu
8216 * Directory Groups::   You can read a directory as if it was a newsgroup.
8217 * Anything Groups::    Dired?  Who needs dired?
8218 * Document Groups::    Single files can be the basis of a group.
8219 * SOUP::               Reading @sc{SOUP} packets ``offline''.
8220 @end menu
8221
8222
8223 @node Directory Groups
8224 @subsection Directory Groups
8225 @cindex nndir
8226 @cindex directory groups
8227
8228 If you have a directory that has lots of articles in separate files in
8229 it, you might treat it as a newsgroup.  The files have to have numerical
8230 names, of course.
8231
8232 This might be an opportune moment to mention @code{ange-ftp}, that most
8233 wonderful of all wonderful Emacs packages.  When I wrote @code{nndir}, I
8234 didn't think much about it---a backend to read directories.  Big deal.
8235
8236 @code{ange-ftp} changes that picture dramatically.  For instance, if you
8237 enter @file{"/ftp.hpc.uh.edu:/pub/emacs/ding-list/"} as the the
8238 directory name, ange-ftp will actually allow you to read this directory
8239 over at @samp{sina} as a newsgroup.  Distributed news ahoy!
8240
8241 @code{nndir} will use @sc{nov} files if they are present.
8242
8243 @code{nndir} is a ``read-only'' backend---you can't delete or expire
8244 articles with this method.  You can use @code{nnmh} or @code{nnml} for
8245 whatever you use @code{nndir} for, so you could switch to any of those
8246 methods if you feel the need to have a non-read-only @code{nndir}.
8247
8248
8249 @node Anything Groups
8250 @subsection Anything Groups
8251 @cindex nneething
8252
8253 From the @code{nndir} backend (which reads a single spool-like
8254 directory), it's just a hop and a skip to @code{nneething}, which
8255 pretends that any arbitrary directory is a newsgroup.  Strange, but
8256 true.
8257
8258 When @code{nneething} is presented with a directory, it will scan this
8259 directory and assign article numbers to each file.  When you enter such
8260 a group, @code{nneething} must create ``headers'' that Gnus can use.
8261 After all, Gnus is a newsreader, in case you're
8262 forgetting. @code{nneething} does this in a two-step process.  First, it
8263 snoops each file in question.  If the file looks like an article (i.e.,
8264 the first few lines look like headers), it will use this as the head.
8265 If this is just some arbitrary file without a head (eg. a C source
8266 file), @code{nneething} will cobble up a header out of thin air.  It
8267 will use file ownership, name and date and do whatever it can with these
8268 elements.
8269
8270 All this should happen automatically for you, and you will be presented
8271 with something that looks very much like a newsgroup.  Totally like a
8272 newsgroup, to be precise.  If you select an article, it will be displayed
8273 in the article buffer, just as usual.
8274
8275 If you select a line that represents a directory, Gnus will pop you into
8276 a new summary buffer for this @code{nneething} group.  And so on.  You can
8277 traverse the entire disk this way, if you feel like, but remember that
8278 Gnus is not dired, really, and does not intend to be, either.
8279
8280 There are two overall modes to this action---ephemeral or solid.  When
8281 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
8282 will not store information on what files you have read, and what files
8283 are new, and so on.  If you create a solid @code{nneething} group the
8284 normal way with @kbd{G m}, Gnus will store a mapping table between
8285 article numbers and file names, and you can treat this group like any
8286 other groups.  When you activate a solid @code{nneething} group, you will
8287 be told how many unread articles it contains, etc., etc.
8288
8289 Some variables:
8290
8291 @table @code
8292 @item nneething-map-file-directory
8293 @vindex nneething-map-file-directory
8294 All the mapping files for solid @code{nneething} groups will be stored
8295 in this directory, which defaults to @file{~/.nneething/}.
8296
8297 @item nneething-exclude-files
8298 @vindex nneething-exclude-files
8299 All files that match this regexp will be ignored.  Nice to use to exclude
8300 auto-save files and the like, which is what it does by default.
8301
8302 @item nneething-map-file
8303 @vindex nneething-map-file
8304 Name of the map files.
8305 @end table
8306
8307
8308 @node Document Groups
8309 @subsection Document Groups
8310 @cindex nndoc
8311 @cindex documentation group
8312 @cindex help group
8313
8314 @code{nndoc} is a cute little thing that will let you read a single file
8315 as a newsgroup.  Several files types are supported:
8316
8317 @table @code
8318 @cindex babyl
8319 @cindex rmail mbox
8320
8321 @item babyl
8322 The babyl (rmail) mail box.
8323 @cindex mbox
8324 @cindex Unix mbox
8325
8326 @item mbox
8327 The standard Unix mbox file.
8328
8329 @cindex MMDF mail box
8330 @item mmdf
8331 The MMDF mail box format.
8332
8333 @item news
8334 Several news articles appended into a file.
8335
8336 @item rnews
8337 @cindex rnews batch files
8338 The rnews batch transport format.
8339 @cindex forwarded messages
8340
8341 @item forward
8342 Forwarded articles.
8343
8344 @item mime-digest
8345 @cindex digest
8346 @cindex MIME digest
8347 @cindex 1153 digest
8348 @cindex RFC 1153 digest
8349 @cindex RFC 341 digest
8350 MIME (RFC 1341) digest format.
8351
8352 @item standard-digest
8353 The standard (RFC 1153) digest format.
8354
8355 @item slack-digest
8356 Non-standard digest format---matches most things, but does it badly. 
8357 @end table
8358
8359 You can also use the special ``file type'' @code{guess}, which means
8360 that @code{nndoc} will try to guess what file type it is looking at.
8361 @code{digest} means that @code{nndoc} should guess what digest type the
8362 file is.
8363
8364 @code{nndoc} will not try to change the file or insert any extra headers into
8365 it---it will simply, like, let you use the file as the basis for a
8366 group.  And that's it.
8367
8368 If you have some old archived articles that you want to insert into your
8369 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
8370 that.  Say you have an old @file{RMAIL} file with mail that you now want
8371 to split into your new @code{nnml} groups.  You look at that file using
8372 @code{nndoc}, set the process mark on all the articles in the buffer
8373 (@kbd{M P b}, for instance), and then re-spool (@kbd{B r}) using
8374 @code{nnml}.  If all goes well, all the mail in the @file{RMAIL} file is
8375 now also stored in lots of @code{nnml} directories, and you can delete
8376 that pesky @file{RMAIL} file.  If you have the guts!  
8377
8378 Virtual server variables:
8379
8380 @table @code
8381 @item nndoc-article-type
8382 @vindex nndoc-article-type
8383 This should be one of @code{mbox}, @code{babyl}, @code{digest},
8384 @code{mmdf}, @code{forward}, @code{news}, @code{rnews},
8385 @code{mime-digest}, @code{clari-briefs}, or @code{guess}.
8386
8387 @item nndoc-post-type
8388 @vindex nndoc-post-type
8389 This variable says whether Gnus is to consider the group a news group or
8390 a mail group.  There are two legal values:  @code{mail} (the default)
8391 and @code{news}.
8392 @end table
8393
8394
8395 @node SOUP
8396 @subsection SOUP
8397 @cindex SOUP
8398 @cindex offline
8399
8400 In the PC world people often talk about ``offline'' newsreaders.  These
8401 are thingies that are combined reader/news transport monstrosities.
8402 With built-in modem programs.  Yecchh!
8403
8404 Of course, us Unix Weenie types of human beans use things like
8405 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
8406 transport things like Ghod intended.  And then we just use normal
8407 newsreaders.  
8408
8409 However, it can sometimes be convenient to do something a that's a bit
8410 easier on the brain if you have a very slow modem, and you're not really
8411 that interested in doing things properly.  
8412
8413 A file format called @sc{soup} has been developed for transporting news
8414 and mail from servers to home machines and back again.  It can be a bit
8415 fiddly.
8416
8417 @enumerate
8418
8419 @item
8420 You log in on the server and create a @sc{soup} packet.  You can either
8421 use a dedicated @sc{soup} thingie, or you can use Gnus to create the
8422 packet with the @kbd{O s} command.
8423
8424 @item 
8425 You transfer the packet home.  Rail, boat, car or modem will do fine.
8426
8427 @item
8428 You put the packet in your home directory.
8429
8430 @item
8431 You fire up Gnus using the @code{nnsoup} backend as the native server.
8432
8433 @item
8434 You read articles and mail and answer and followup to the things you
8435 want.
8436
8437 @item 
8438 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
8439 packet.
8440
8441 @item 
8442 You transfer this packet to the server.  
8443
8444 @item
8445 You use Gnus to mail this packet out with the @kbd{G s s} command.
8446
8447 @item
8448 You then repeat until you die.
8449
8450 @end enumerate
8451
8452 So you basically have a bipartite system---you use @code{nnsoup} for
8453 reading and Gnus for packing/sending these @sc{soup} packets.
8454
8455 @menu
8456 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
8457 * SOUP Groups::       A backend for reading @sc{soup} packets.
8458 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
8459 @end menu
8460
8461
8462 @node SOUP Commands
8463 @subsubsection SOUP Commands
8464
8465 @table @kbd
8466 @item G s b
8467 @kindex G s b (Group)
8468 @findex gnus-group-brew-soup
8469 Pack all unread articles in the current group
8470 (@code{gnus-group-brew-soup}).  This command understands the
8471 process/prefix convention.
8472
8473 @item G s w
8474 @kindex G s w (Group)
8475 @findex gnus-soup-save-areas
8476 Save all data files (@code{gnus-soup-save-areas}).
8477
8478 @item G s s
8479 @kindex G s s (Group)
8480 @findex gnus-soup-send-replies
8481 Send all replies from the replies packet
8482 (@code{gnus-soup-send-replies}). 
8483
8484 @item G s p
8485 @kindex G s p (Group)
8486 @findex gnus-soup-pack-packet
8487 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
8488
8489 @item G s r
8490 @kindex G s r (Group)
8491 @findex nnsoup-pack-replies
8492 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
8493
8494 @item O s
8495 @kindex O s (Summary)
8496 @findex gnus-soup-add-article
8497 This summary-mode command adds the current article to a @sc{soup} packet
8498 (@code{gnus-soup-add-article}).  It understands the process/prefix
8499 convention. 
8500
8501 @end table
8502
8503
8504 There are a few variables to customize where Gnus will put all these
8505 thingies:  
8506
8507 @table @code
8508
8509 @item gnus-soup-directory
8510 @vindex gnus-soup-directory
8511 Directory where Gnus will save intermediate files while composing
8512 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
8513
8514 @item gnus-soup-replies-directory
8515 @vindex gnus-soup-replies-directory
8516 This is what Gnus will use as a temporary directory while sending our
8517 reply packets.  The default is @file{~/SoupBrew/SoupReplies/}. 
8518
8519 @item gnus-soup-prefix-file
8520 @vindex gnus-soup-prefix-file
8521 Name of the file where Gnus stores the last used prefix.  The default is
8522 @samp{gnus-prefix}. 
8523
8524 @item gnus-soup-packer
8525 @vindex gnus-soup-packer
8526 A format string command for packing a @sc{soup} packet.  The default is
8527 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
8528
8529 @item gnus-soup-unpacker
8530 @vindex gnus-soup-unpacker
8531 Format string command for unpacking a @sc{soup} packet.  The default is
8532 @samp{gunzip -c %s | tar xvf -}.
8533
8534 @item gnus-soup-packet-directory
8535 @vindex gnus-soup-packet-directory
8536 Where Gnus will look for reply packets.  The default is @file{~/}. 
8537
8538 @item gnus-soup-packet-regexp
8539 @vindex gnus-soup-packet-regexp
8540 Regular expression matching @sc{soup} reply packets in
8541 @code{gnus-soup-packet-directory}. 
8542
8543 @end table
8544  
8545
8546 @node SOUP Groups
8547 @subsubsection @sc{soup} Groups
8548 @cindex nnsoup
8549
8550 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
8551 read incoming packets, unpack them, and put them in a directory where
8552 you can read them at leisure.
8553
8554 These are the variables you can use to customize its behavior:
8555
8556 @table @code
8557
8558 @item nnsoup-tmp-directory
8559 @vindex nnsoup-tmp-directory
8560 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
8561 directory.  (@file{/tmp/} by default.)  
8562
8563 @item nnsoup-directory
8564 @vindex nnsoup-directory
8565 @code{nnsoup} then moves each message and index file to this directory.
8566 The default is @file{~/SOUP/}.
8567
8568 @item nnsoup-replies-directory 
8569 @vindex nnsoup-replies-directory 
8570 All replies will stored in this directory before being packed into a
8571 reply packet.  The default is @file{~/SOUP/replies/"}.
8572
8573 @item nnsoup-replies-format-type
8574 @vindex nnsoup-replies-format-type
8575 The @sc{soup} format of the replies packets.  The default is @samp{?n}
8576 (rnews), and I don't think you should touch that variable.  I probably
8577 shouldn't even have documented it.  Drats!  Too late!
8578
8579 @item nnsoup-replies-index-type
8580 @vindex nnsoup-replies-index-type
8581 The index type of the replies packet.  The is @samp{?n}, which means
8582 ``none''.  Don't fiddle with this one either!
8583
8584 @item nnsoup-active-file
8585 @vindex nnsoup-active-file
8586 Where @code{nnsoup} stores lots of information.  This is not an ``active
8587 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
8588 this file or mess it up in any way, you're dead.  The default is
8589 @file{~/SOUP/active}.
8590
8591 @item nnsoup-packer
8592 @vindex nnsoup-packer
8593 Format string command for packing a reply @sc{soup} packet.  The default
8594 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
8595
8596 @item nnsoup-unpacker
8597 @vindex nnsoup-unpacker
8598 Format string command for unpacking incoming @sc{soup} packets.  The
8599 default is @samp{gunzip -c %s | tar xvf -}. 
8600
8601 @item nnsoup-packet-directory
8602 @vindex nnsoup-packet-directory
8603 Where @code{nnsoup} will look for incoming packets.  The default is
8604 @file{~/}.  
8605
8606 @item nnsoup-packet-regexp
8607 @vindex nnsoup-packet-regexp
8608 Regular expression matching incoming @sc{soup} packets.  The default is
8609 @samp{Soupout}. 
8610
8611 @end table
8612
8613
8614 @node SOUP Replies
8615 @subsubsection SOUP Replies
8616
8617 Just using @code{nnsoup} won't mean that your postings and mailings end
8618 up in @sc{soup} reply packets automagically.  You have to work a bit
8619 more for that to happen.
8620
8621 @findex nnsoup-set-variables
8622 The @code{nnsoup-set-variables} command will set the appropriate
8623 variables to ensure that all your followups and replies end up in the
8624 @sc{soup} system.
8625
8626 In specific, this is what it does:
8627
8628 @lisp
8629 (setq gnus-inews-article-function 'nnsoup-request-post)
8630 (setq send-mail-function 'nnsoup-request-mail)
8631 @end lisp
8632
8633 And that's it, really.  If you only want news to go into the @sc{soup}
8634 system you just use the first line.  If you only want mail to be
8635 @sc{soup}ed you use the second.
8636
8637
8638 @node Combined Groups
8639 @section Combined Groups
8640
8641 Gnus allows combining a mixture of all the other group types into bigger
8642 groups.
8643
8644 @menu
8645 * Virtual Groups::     Combining articles from many groups.
8646 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
8647 @end menu
8648
8649
8650 @node Virtual Groups
8651 @subsection Virtual Groups
8652 @cindex nnvirtual
8653 @cindex virtual groups
8654
8655 An @dfn{nnvirtual group} is really nothing more than a collection of
8656 other groups.
8657
8658 For instance, if you are tired of reading many small group, you can
8659 put them all in one big group, and then grow tired of reading one
8660 big, unwieldy group.  The joys of computing!
8661
8662 You specify @code{nnvirtual} as the method.  The address should be a
8663 regexp to match component groups.
8664
8665 All marks in the virtual group will stick to the articles in the
8666 component groups.  So if you tick an article in a virtual group, the
8667 article will also be ticked in the component group from whence it came.
8668 (And vice versa---marks from the component groups will also be shown in
8669 the virtual group.)
8670
8671 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
8672 newsgroups into one, big, happy newsgroup:
8673
8674 @lisp
8675 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
8676 @end lisp
8677
8678 The component groups can be native or foreign; everything should work
8679 smoothly, but if your computer explodes, it was probably my fault.
8680
8681 Collecting the same group from several servers might actually be a good
8682 idea if users have set the Distribution header to limit distribution.
8683 If you would like to read @samp{soc.motss} both from a server in Japan
8684 and a server in Norway, you could use the following as the group regexp:
8685
8686 @example
8687 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
8688 @end example
8689
8690 This should work kinda smoothly---all articles from both groups should
8691 end up in this one, and there should be no duplicates.  Threading (and
8692 the rest) will still work as usual, but there might be problems with the
8693 sequence of articles.  Sorting on date might be an option here
8694 (@pxref{Selecting a Group}.
8695
8696 One limitation, however---all groups that are included in a virtual
8697 group has to be alive (i.e., subscribed or unsubscribed).  Killed or
8698 zombie groups can't be component groups for @code{nnvirtual} groups.
8699
8700 @vindex nnvirtual-always-rescan
8701 If the @code{nnvirtual-always-rescan} is non-@code{nil},
8702 @code{nnvirtual} will always scan groups for unread articles when
8703 entering a virtual group.  If this variable is @code{nil} (which is the
8704 default) and you read articles in a component group after the virtual
8705 group has been activated, the read articles from the component group
8706 will show up when you enter the virtual group.  You'll also see this
8707 effect if you have two virtual groups that contain the same component
8708 group.  If that's the case, you should set this variable to @code{t}.
8709 Or you can just tap @code{M-g} on the virtual group every time before
8710 you enter it---it'll have much the same effect.
8711
8712
8713 @node Kibozed Groups
8714 @subsection Kibozed Groups
8715 @cindex nnkiboze
8716 @cindex kibozing
8717
8718 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
8719 the news feed''.  @code{nnkiboze} is a backend that will do this for
8720 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
8721 with useless requests!  Oh happiness!
8722
8723 The address field of the @code{nnkiboze} method is, as with
8724 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
8725 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
8726 and @code{nnvirtual} ends.
8727
8728 In addition to this regexp detailing component groups, an @code{nnkiboze} group
8729 must have a score file to say what articles that are to be included in
8730 the group (@pxref{Scoring}).
8731
8732 @kindex M-x nnkiboze-generate-groups
8733 @findex nnkiboze-generate-groups
8734 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
8735 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
8736 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
8737 all the articles in all the components groups and run them through the
8738 scoring process to determine if there are any articles in the groups
8739 that are to be part of the @code{nnkiboze} groups.
8740
8741 Please limit the number of component groups by using restrictive
8742 regexps.  Otherwise your sysadmin may become annoyed with you, and the
8743 @sc{nntp} site may throw you off and never let you back in again.
8744 Stranger things have happened.
8745
8746 @code{nnkiboze} component groups do not have to be alive---they can be dead,
8747 and they can be foreign.  No restrictions.
8748
8749 @vindex nnkiboze-directory
8750 The generation of an @code{nnkiboze} group means writing two files in
8751 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
8752 contains the @sc{nov} header lines for all the articles in the group,
8753 and the other is an additional @file{.newsrc} file to store information
8754 on what groups that have been searched through to find component
8755 articles.
8756
8757 Articles that are marked as read in the @code{nnkiboze} group will have their
8758 @sc{nov} lines removed from the @sc{nov} file.
8759
8760
8761 @node Scoring
8762 @chapter Scoring
8763 @cindex scoring
8764
8765 Other people use @dfn{kill files}, but we here at Gnus Towers like
8766 scoring better than killing, so we'd rather switch than fight.  They do
8767 something completely different as well, so sit up straight and pay
8768 attention!
8769
8770 @vindex gnus-summary-mark-below
8771 All articles have a default score (@code{gnus-summary-default-score}),
8772 which is 0 by default.  This score may be raised or lowered either
8773 interactively or by score files.  Articles that have a score lower than
8774 @code{gnus-summary-mark-below} are marked as read.
8775
8776 Gnus will read any @dfn{score files} that apply to the current group
8777 before generating the summary buffer.
8778
8779 There are several commands in the summary buffer that insert score
8780 entries based on the current article.  You can, for instance, ask Gnus to
8781 lower or increase the score of all articles with a certain subject.
8782
8783 There are two sorts of scoring entries: Permanent and temporary.
8784 Temporary score entries are self-expiring entries.  Any entries that are
8785 temporary and have not been used for, say, a week, will be removed
8786 silently to help keep the sizes of the score files down.
8787
8788 @menu 
8789 * Summary Score Commands::   Adding score entries for the current group.
8790 * Group Score Commands::     General score commands.
8791 * Score Variables::          Customize your scoring.  (My, what terminology).
8792 * Score File Format::        What a score file may contain.
8793 * Score File Editing::       You can edit score files by hand as well.
8794 * Adaptive Scoring::         Big Sister Gnus *knows* what you read.
8795 * Followups To Yourself::    Having Gnus notice when people answer you.
8796 * Scoring Tips::             How to score effectively.
8797 * Reverse Scoring::          That problem child of old is not problem.
8798 * Global Score Files::       Earth-spanning, ear-splitting score files.
8799 * Kill Files::               They are still here, but they can be ignored.
8800 * GroupLens::                Getting predictions on what you like to read.
8801 @end menu
8802
8803
8804 @node Summary Score Commands
8805 @section Summary Score Commands
8806 @cindex score commands
8807
8808 The score commands that alter score entries do not actually modify real
8809 score files.  That would be too inefficient.  Gnus maintains a cache of
8810 previously loaded score files, one of which is considered the
8811 @dfn{current score file alist}.  The score commands simply insert
8812 entries into this list, and upon group exit, this list is saved.
8813
8814 The current score file is by default the group's local score file, even
8815 if no such score file actually exists.  To insert score commands into
8816 some other score file (eg. @file{all.SCORE}), you must first make this
8817 score file the current one.
8818
8819 General score commands that don't actually change the score file:
8820
8821 @table @kbd
8822
8823 @item V s
8824 @kindex V s (Summary)
8825 @findex gnus-summary-set-score
8826 Set the score of the current article (@code{gnus-summary-set-score}).  
8827
8828 @item V S
8829 @kindex V S (Summary)
8830 @findex gnus-summary-current-score
8831 Display the score of the current article
8832 (@code{gnus-summary-current-score}).   
8833
8834 @item V t
8835 @kindex V t (Summary)
8836 @findex gnus-score-find-trace
8837 Display all score rules that have been used on the current article
8838 (@code{gnus-score-find-trace}).   
8839
8840 @item V R
8841 @cindex V R (Summary)
8842 @findex gnus-summary-rescore
8843 Run the current summary through the scoring process
8844 (@code{gnus-summary-rescore}).  This might be useful if you're playing
8845 around with your score files behind Gnus' back and want to see the
8846 effect you're having.
8847
8848 @item V a
8849 @kindex V a (Summary)
8850 @findex gnus-summary-score-entry
8851 Add a new score entry, and allow specifying all elements 
8852 (@code{gnus-summary-score-entry}).
8853
8854 @item V c
8855 @kindex V c (Summary)
8856 @findex gnus-score-change-score-file
8857 Make a different score file the current
8858 (@code{gnus-score-change-score-file}). 
8859
8860 @item V e
8861 @kindex V e (Summary)
8862 @findex gnus-score-edit-current-scores
8863 Edit the current score file (@code{gnus-score-edit-current-scores}).
8864 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
8865 File Editing}).
8866
8867 @item V f
8868 @kindex V f (Summary)
8869 @findex gnus-score-edit-file
8870 Edit a score file and make this score file the current one
8871 (@code{gnus-score-edit-file}).
8872
8873 @item V F
8874 @kindex V F (Summary)
8875 @findex gnus-score-flush-cache
8876 Flush the score cahe (@code{gnus-score-flush-cache}).  This is useful
8877 after editing score files.
8878
8879 @item V C
8880 @kindex V C (Summary)
8881 @findex gnus-score-customize
8882 Customize a score file in a visually pleasing manner
8883 (@code{gnus-score-customize}). 
8884
8885 @item I C-i
8886 @kindex I C-i (Summary)
8887 @findex gnus-summary-raise-score
8888 Increase the score of the current article
8889 (@code{gnus-summary-raise-score}).
8890
8891 @item L C-l
8892 @kindex L C-l (Summary)
8893 @findex gnus-summary-lower-score
8894 Lower the score of the current article
8895 (@code{gnus-summary-lower-score}). 
8896 @end table
8897
8898 The rest of these commands modify the local score file.
8899
8900 @table @kbd
8901
8902 @item V m
8903 @kindex V m (Summary)
8904 @findex gnus-score-set-mark-below
8905 Prompt for a score, and mark all articles with a score below this as
8906 read (@code{gnus-score-set-mark-below}).
8907
8908 @item V E
8909 @kindex V E (Summary)
8910 @findex gnus-score-set-expunge-below
8911 Expunge all articles with a score below the default score (or the
8912 numeric prefix) (@code{gnus-score-set-expunge-below}).
8913 @end table
8914
8915 The keystrokes for actually making score entries follow a very regular
8916 pattern, so there's no need to list all the commands.  (Hundreds of
8917 them.)  
8918
8919 @enumerate
8920 @item
8921 The first key is either @kbd{I} (upper case i) for increasing the score
8922 or @kbd{L} for lowering the score. 
8923 @item
8924 The second key says what header you want to score on.  The following
8925 keys are available:
8926 @table @kbd
8927
8928 @item a
8929 Score on the author name.
8930
8931 @item s
8932 Score on the subject line.
8933
8934 @item x
8935 Score on the Xref line---i.e., the cross-posting line.
8936
8937 @item t
8938 Score on thread---the References line.
8939
8940 @item d
8941 Score on the date.
8942
8943 @item l
8944 Score on the number of lines.
8945
8946 @item i
8947 Score on the Message-ID.
8948
8949 @item f
8950 Score on followups.
8951
8952 @item b
8953 Score on the body.
8954
8955 @item h
8956 Score on the head.
8957 @end table
8958
8959 @item
8960 The third key is the match type.  Which match types are legal depends on
8961 what headers you are scoring on.
8962
8963 @table @code
8964
8965 @item strings 
8966
8967 @table @kbd
8968
8969 @item e
8970 Exact matching.
8971
8972 @item s
8973 Substring matching.
8974
8975 @item f
8976 Fuzzy matching.
8977
8978 @item r
8979 Regexp matching
8980 @end table
8981
8982 @item date
8983 @table @kbd
8984
8985 @item b
8986 Before date.
8987
8988 @item a
8989 At date.
8990
8991 @item n
8992 This date.
8993 @end table
8994
8995 @item number
8996 @table @kbd
8997
8998 @item <
8999 Less than number.
9000
9001 @item =
9002 Equal to number.
9003
9004 @item >
9005 Greater than number.
9006 @end table
9007 @end table
9008
9009 @item 
9010 The fourth and final key says whether this is a temporary (i.e., expiring)
9011 score entry, or a permanent (i.e., non-expiring) score entry, or whether
9012 it is to be done immediately, without adding to the score file.
9013 @table @kbd
9014
9015 @item t
9016 Temporary score entry.
9017
9018 @item p
9019 Permanent score entry.
9020
9021 @item i
9022 Immediately scoring.
9023 @end table
9024
9025 @end enumerate
9026
9027 So, let's say you want to increase the score on the current author with
9028 exact matching permanently: @kbd{I a e p}.  If you want to lower the
9029 score based on the subject line, using substring matching, and make a
9030 temporary score entry: @kbd{L s s t}.  Pretty easy.
9031
9032 To make things a bit more complicated, there are shortcuts.  If you use
9033 a capital letter on either the second or third keys, Gnus will use
9034 defaults for the remaining one or two keystrokes.  The defaults are
9035 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
9036 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
9037
9038 @vindex gnus-score-mimic-keymap
9039 The @code{gnus-score-mimic-keymap} says whether these commands will
9040 pretend they are keymaps or not.
9041
9042
9043 @node Group Score Commands
9044 @section Group Score Commands
9045 @cindex group score commands
9046
9047 There aren't many of these as yet, I'm afraid.
9048
9049 @table @kbd
9050
9051 @item W f
9052 @kindex W f (Group)
9053 @findex gnus-score-flush-cache
9054 Gnus maintains a cache of score alists to avoid having to reload them
9055 all the time.  This command will flush the cache
9056 (@code{gnus-score-flush-cache}). 
9057
9058 @end table
9059
9060
9061 @node Score Variables
9062 @section Score Variables
9063 @cindex score variables
9064
9065 @table @code
9066
9067 @item gnus-use-scoring
9068 @vindex gnus-use-scoring
9069 If @code{nil}, Gnus will not check for score files, and will not, in
9070 general, do any score-related work.  This is @code{t} by default.
9071
9072 @item gnus-kill-killed
9073 @vindex gnus-kill-killed
9074 If this variable is @code{nil}, Gnus will never apply score files to
9075 articles that have already been through the kill process.  While this
9076 may save you lots of time, it also means that if you apply a kill file
9077 to a group, and then change the kill file and want to run it over you
9078 group again to kill more articles, it won't work.  You have to set this
9079 variable to @code{t} to do that.  (It is @code{t} by default.)
9080
9081 @item gnus-kill-files-directory
9082 @vindex gnus-kill-files-directory
9083 All kill and score files will be stored in this directory, which is
9084 initialized from the @code{SAVEDIR} environment variable by default.
9085 This is @file{~/News/} by default.
9086
9087 @item gnus-score-file-suffix
9088 @vindex gnus-score-file-suffix
9089 Suffix to add to the group name to arrive at the score file name
9090 (@samp{SCORE} by default.)
9091
9092 @item gnus-score-uncacheable-files
9093 @vindex gnus-score-uncacheable-files
9094 @cindex score cache
9095 All score files are normally cached to avoid excessive re-loading of
9096 score files.  However, if this might make you Emacs grow big and
9097 bloated, so this regexp can be used to weed out score files that are
9098 unlikely to be needed again.  It would be a bad idea to deny caching of
9099 @file{all.SCORE}, while it might be a good idea to not cache
9100 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
9101 variable is @samp{ADAPT$} by default, so no adaptive score files will
9102 be cached.
9103
9104 @item gnus-save-score
9105 @vindex gnus-save-score
9106 If you have really complicated score files, and do lots of batch
9107 scoring, then you might set this variable to @code{t}.  This will make
9108 Gnus save the scores into the @file{.newsrc.eld} file.
9109
9110 @item gnus-score-interactive-default-score
9111 @vindex gnus-score-interactive-default-score
9112 Score used by all the interactive raise/lower commands to raise/lower
9113 score with.  Default is 1000, which may seem excessive, but this is to
9114 ensure that the adaptive scoring scheme gets enough room to play with.
9115 We don't want the small changes from the adaptive scoring to overwrite
9116 manually entered data.
9117
9118 @item gnus-summary-default-score
9119 @vindex gnus-summary-default-score
9120 Default score of an article, which is 0 by default.
9121
9122 @item gnus-score-over-mark
9123 @vindex gnus-score-over-mark
9124 Mark (in the third column) used for articles with a score over the
9125 default.  Default is @samp{+}.
9126
9127 @item gnus-score-below-mark
9128 @vindex gnus-score-below-mark
9129 Mark (in the third column) used for articles with a score below the
9130 default.  Default is @samp{-}.
9131
9132 @item gnus-score-find-score-files-function
9133 @vindex gnus-score-find-score-files-function
9134 Function used to find score files for the current group.  This function
9135 is called with the name of the group as the argument. 
9136
9137 Predefined functions available are:
9138 @table @code
9139
9140 @item gnus-score-find-single
9141 @findex gnus-score-find-single
9142 Only apply the group's own score file.
9143
9144 @item gnus-score-find-bnews
9145 @findex gnus-score-find-bnews
9146 Apply all score files that match, using bnews syntax.  This is the
9147 default.  For instance, if the current group is @samp{gnu.emacs.gnus},
9148 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
9149 @file{gnu.all.SCORE} would all apply.  In short, the instances of
9150 @samp{all} in the score file names are translated into @samp{.*}, and
9151 then a regexp match is done.
9152
9153 This means that if you have some score entries that you want to apply to
9154 all groups, then you put those entries in the @file{all.SCORE} file. 
9155
9156 @item gnus-score-find-hierarchical
9157 @findex gnus-score-find-hierarchical
9158 Apply all score files from all the parent groups.  This means that you
9159 can't have score files like @file{all.SCORE} or @file{all.emacs.SCORE},
9160 but you can have @file{SCORE},  @file{comp.SCORE} and
9161 @file{comp.emacs.SCORE}. 
9162
9163 @end table
9164 This variable can also be a list of functions.  In that case, all these
9165 functions will be called, and all the returned lists of score files will
9166 be applied.  These functions can also return lists of score alists
9167 directly.  In that case, the functions that return these non-file score
9168 alists should probably be placed before the ``real'' score file
9169 functions, to ensure that the last score file returned is the local
9170 score file.  Phu.
9171
9172 @item gnus-score-expiry-days
9173 @vindex gnus-score-expiry-days
9174 This variable says how many days should pass before an unused score file
9175 entry is expired.  If this variable is @code{nil}, no score file entries
9176 are expired.  It's 7 by default.
9177
9178 @item gnus-update-score-entry-dates
9179 @vindex gnus-update-score-entry-dates
9180 If this variable is non-@code{nil}, matching score entries will have
9181 their dates updated.  (This is how Gnus controls expiry---all
9182 non-matching entries will become too old while matching entries will
9183 stay fresh and young.)  However, if you set this variable to @code{nil},
9184 even matching entries will grow old and will have to face that oh-so
9185 grim reaper.  
9186
9187 @item gnus-score-after-write-file-function
9188 @vindex gnus-score-after-write-file-function
9189 Function called with the name of the score file just written.
9190
9191 @end table
9192
9193
9194 @node Score File Format
9195 @section Score File Format
9196 @cindex score file format
9197
9198 A score file is an @code{emacs-lisp} file that normally contains just a
9199 single form.  Casual users are not expected to edit these files;
9200 everything can be changed from the summary buffer.
9201
9202 Anyway, if you'd like to dig into it yourself, here's an example:
9203
9204 @lisp
9205 (("from"
9206   ("Lars Ingebrigtsen" -10000)
9207   ("Per Abrahamsen")
9208   ("larsi\\|lmi" -50000 nil R))
9209  ("subject"
9210   ("Ding is Badd" nil 728373))
9211  ("xref"
9212   ("alt.politics" -1000 728372 s))
9213  ("lines"
9214   (2 -100 nil <))
9215  (mark 0)
9216  (expunge -1000)
9217  (mark-and-expunge -10)
9218  (read-only nil)
9219  (orphan -10)
9220  (adapt t)
9221  (files "/hom/larsi/News/gnu.SCORE")
9222  (exclude-files "all.SCORE")
9223  (local (gnus-newsgroup-auto-expire t)
9224         (gnus-summary-make-false-root 'empty))
9225  (eval (ding)))
9226 @end lisp
9227
9228 This example demonstrates absolutely everything about a score file. 
9229
9230 Even though this looks much like lisp code, nothing here is actually
9231 @code{eval}ed.  The lisp reader is used to read this form, though, so it
9232 has to be legal syntactically, if not semantically.
9233
9234 Six keys are supported by this alist:
9235
9236 @table @code
9237
9238 @item STRING
9239 If the key is a string, it is the name of the header to perform the
9240 match on.  Scoring can only be performed on these eight headers:
9241 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
9242 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
9243 these headers, there are three strings to tell Gnus to fetch the entire
9244 article and do the match on larger parts of the article: @code{Body}
9245 will perform the match on the body of the article, @code{Head} will
9246 perform the match on the head of the article, and @code{All} will
9247 perform the match on the entire article.  Note that using any of these
9248 last three keys will slow down group entry @emph{considerably}.  The
9249 final ``header'' you can score on is @code{Followup}.  These score
9250 entries will result in new score entries being added for all follow-ups
9251 to articles that matches these score entries.
9252
9253 Following this key is a arbitrary number of score entries, where each
9254 score entry has one to four elements.
9255 @enumerate
9256
9257 @item 
9258 The first element is the @dfn{match element}.  On most headers this will
9259 be a string, but on the Lines and Chars headers, this must be an
9260 integer. 
9261
9262 @item 
9263 If the second element is present, it should be a number---the @dfn{score
9264 element}.  This number should be an integer in the neginf to posinf
9265 interval.  This number is added to the score of the article if the match
9266 is successful.  If this element is not present, the
9267 @code{gnus-score-interactive-default-score} number will be used
9268 instead.  This is 1000 by default.
9269
9270 @item 
9271 If the third element is present, it should be a number---the @dfn{date
9272 element}.  This date says when the last time this score entry matched,
9273 which provides a mechanism for expiring the score entries.  It this
9274 element is not present, the score entry is permanent.  The date is
9275 represented by the number of days since December 31, 1 ce.
9276
9277 @item 
9278 If the fourth element is present, it should be a symbol---the @dfn{type
9279 element}.  This element specifies what function should be used to see
9280 whether this score entry matches the article.  What match types that can
9281 be used depends on what header you wish to perform the match on.
9282 @table @dfn
9283
9284 @item From, Subject, References, Xref, Message-ID
9285 For most header types, there are the @code{r} and @code{R} (regexp) as
9286 well as @code{s} and @code{S} (substring) types and @code{e} and
9287 @code{E} (exact match) types.  If this element is not present, Gnus will
9288 assume that substring matching should be used.  @code{R} and @code{S}
9289 differ from the other two in that the matches will be done in a
9290 case-sensitive manner.  All these one-letter types are really just
9291 abbreviations for the @code{regexp}, @code{string} and @code{exact}
9292 types, which you can use instead, if you feel like.
9293
9294 @item Lines, Chars
9295 These two headers use different match types: @code{<}, @code{>},
9296 @code{=}, @code{>=} and @code{<=}.
9297
9298 @item Date
9299 For the Date header we have three match types: @code{before}, @code{at}
9300 and @code{after}.  I can't really imagine this ever being useful, but,
9301 like, it would feel kinda silly not to provide this function.  Just in
9302 case.  You never know.  Better safe than sorry.  Once burnt, twice shy.
9303 Don't judge a book by its cover.  Never not have sex on a first date.
9304
9305 @item Head, Body, All
9306 These three match keys use the same match types as the @code{From} (etc)
9307 header uses.
9308
9309 @item Followup
9310 This match key will add a score entry on all articles that followup to
9311 some author.  Uses the same match types as the @code{From} header uses.
9312
9313 @item Thread
9314 This match key will add a score entry on all articles that are part of
9315 a thread.  Uses the same match types as the @code{References} header
9316 uses.
9317 @end table
9318 @end enumerate
9319
9320 @item mark
9321 The value of this entry should be a number.  Any articles with a score
9322 lower than this number will be marked as read.
9323
9324 @item expunge
9325 The value of this entry should be a number.  Any articles with a score
9326 lower than this number will be removed from the summary buffer.
9327
9328 @item mark-and-expunge
9329 The value of this entry should be a number.  Any articles with a score
9330 lower than this number will be marked as read and removed from the
9331 summary buffer.
9332
9333 @item thread-mark-and-expunge
9334 The value of this entry should be a number.  All articles that belong to
9335 a thread that has a total score below this number will be marked as read
9336 and removed from the summary buffer.  @code{gnus-thread-score-function}
9337 says how to compute the total score for a thread.
9338
9339 @item files
9340 The value of this entry should be any number of file names.  These files
9341 are assumed to be score files as well, and will be loaded the same way
9342 this one was.
9343
9344 @item exclude-files
9345 The clue of this entry should be any number of files.  This files will
9346 not be loaded, even though they would normally be so, for some reason or
9347 other. 
9348
9349 @item eval
9350 The value of this entry will be @code{eval}el.  This element will be
9351 ignored when handling global score files. 
9352
9353 @item read-only
9354 Read-only score files will not be updated or saved.  Global score files
9355 should feature this atom (@pxref{Global Score Files}).
9356
9357 @item orphan
9358 The value of this entry should be a number.  Articles that do not have
9359 parents will get this number added to their scores.  Imagine you follow
9360 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
9361 will only follow a few of the threads, also want to see any new threads.
9362
9363 You can do this with the following two score file entries:
9364
9365 @example
9366         (orphan -500)
9367         (mark-and-expunge -100)
9368 @end example
9369
9370 When you enter the group the first time, you will only see the new
9371 threads.  You then raise the score of the threads that you find
9372 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
9373 rest.  Next time you enter the group, you will see new articles in the
9374 interesting threads, plus any new threads.
9375
9376 I.e. -- the orphan score atom is for high-volume groups where there
9377 exist a few interesting threads which can't be found automatically by
9378 ordinary scoring rules.
9379
9380 @item adapt
9381 This entry controls the adaptive scoring.  If it is @code{t}, the
9382 default adaptive scoring rules will be used.  If it is @code{ignore}, no
9383 adaptive scoring will be performed on this group.  If it is a list, this
9384 list will be used as the adaptive scoring rules.  If it isn't present,
9385 or is something other than @code{t} or @code{ignore}, the default
9386 adaptive scoring rules will be used.  If you want to use adaptive
9387 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
9388 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
9389 not want adaptive scoring.  If you only want adaptive scoring in a few
9390 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
9391 insert @code{(adapt t)} in the score files of the groups where you want
9392 it. 
9393
9394 @item adapt-file
9395 All adaptive score entries will go to the file named by this entry.  It
9396 will also be applied when entering the group.  This atom might be handy
9397 if you want to adapt on several groups at once, using the same adaptive
9398 file for a number of groups.
9399
9400 @item local
9401 @cindex local variables
9402 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
9403 Each @var{var} will be made buffer-local to the current summary buffer,
9404 and set to the value specified.  This is a convenient, if somewhat
9405 strange, way of setting variables in some groups if you don't like hooks
9406 much.
9407 @end table
9408
9409
9410 @node Score File Editing
9411 @section Score File Editing
9412
9413 You normally enter all scoring commands from the summary buffer, but you
9414 might feel the urge to edit them by hand as well, so we've supplied you
9415 with a mode for that.  
9416
9417 It's simply a slightly customized @code{emacs-lisp} mode, with these
9418 additional commands:
9419
9420 @table @kbd
9421
9422 @item C-c C-c
9423 @kindex C-c C-c (Score)
9424 @findex gnus-score-edit-done
9425 Save the changes you have made and return to the summary buffer
9426 (@code{gnus-score-edit-done}). 
9427
9428 @item C-c C-d
9429 @kindex C-c C-d (Score)
9430 @findex gnus-score-edit-insert-date
9431 Insert the current date in numerical format
9432 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
9433 you were wondering.
9434
9435 @item C-c C-p
9436 @kindex C-c C-p (Score)
9437 @findex gnus-score-pretty-print
9438 The adaptive score files are saved in an unformatted fashion.  If you
9439 intend to read one of these files, you want to @dfn{pretty print} it
9440 first.  This command (@code{gnus-score-pretty-print}) does that for
9441 you. 
9442
9443 @end table
9444
9445 Type @kbd{M-x gnus-score-mode} to use this mode.
9446
9447 @vindex gnus-score-mode-hook
9448 @code{gnus-score-menu-hook} is run in score mode buffers.
9449
9450 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
9451 e} to begin editing score files.
9452
9453
9454 @node Adaptive Scoring
9455 @section Adaptive Scoring
9456 @cindex adaptive scoring
9457
9458 If all this scoring is getting you down, Gnus has a way of making it all
9459 happen automatically---as if by magic.  Or rather, as if by artificial
9460 stupidity, to be precise.
9461
9462 @vindex gnus-use-adaptive-scoring
9463 When you read an article, or mark an article as read, or kill an
9464 article, you leave marks behind.  On exit from the group, Gnus can sniff
9465 these marks and add score elements depending on what marks it finds.
9466 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
9467 @code{t}. 
9468
9469 @vindex gnus-default-adaptive-score-alist
9470 To give you complete control over the scoring process, you can customize
9471 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
9472 might look something like this:
9473
9474 @lisp
9475 (defvar gnus-default-adaptive-score-alist
9476   '((gnus-unread-mark)
9477     (gnus-ticked-mark (from 4))
9478     (gnus-dormant-mark (from 5))
9479     (gnus-del-mark (from -4) (subject -1))
9480     (gnus-read-mark (from 4) (subject 2))
9481     (gnus-expirable-mark (from -1) (subject -1))
9482     (gnus-killed-mark (from -1) (subject -3))
9483     (gnus-kill-file-mark)
9484     (gnus-ancient-mark)
9485     (gnus-low-score-mark)
9486     (gnus-catchup-mark (from -1) (subject -1))))
9487 @end lisp
9488
9489 As you see, each element in this alist has a mark as a key (either a
9490 variable name or a ``real'' mark---a character).  Following this key is
9491 a arbitrary number of header/score pairs.  If there are no header/score
9492 pairs following the key, no adaptive scoring will be done on articles
9493 that have that key as the article mark.  For instance, articles with
9494 @code{gnus-unread-mark} in the example above will not get adaptive score
9495 entries.
9496
9497 Each article can have only one mark, so just a single of these rules
9498 will be applied to each article.
9499
9500 To take @code{gnus-del-mark} as an example---this alist says that all
9501 articles that have that mark (i.e., are marked with @samp{D}) will have a
9502 score entry added to lower based on the @code{From} header by -4, and
9503 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
9504
9505 If you have marked 10 articles with the same subject with
9506 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
9507 That means that that subject will get a score of ten times -1, which
9508 should be, unless I'm much mistaken, -10.
9509
9510 The headers you can score on are @code{from}, @code{subject},
9511 @code{message-id}, @code{references}, @code{xref}, @code{lines},
9512 @code{chars} and @code{date}.  In addition, you can score on
9513 @code{followup}, which will create an adaptive score entry that matches
9514 on the @code{References} header using the @code{Message-ID} of the
9515 current article, thereby matching the following thread.  
9516
9517 You can also score on @code{thread}, which will try to score all
9518 articles that appear in a thread.  @code{thread} matches uses a
9519 @code{Message-ID} to match on the @code{References} header of the
9520 article.  If the match is made, the @code{Message-ID} of the article is
9521 added to the @code{thread} rule.  (Think about it.  I'd recommend two
9522 aspirins afterwards.)
9523
9524 If you use this scheme, you should set the score file atom @code{mark}
9525 to something small---like -300, perhaps, to avoid having small random
9526 changes result in articles getting marked as read.
9527
9528 After using adaptive scoring for a week or so, Gnus should start to
9529 become properly trained and enhance the authors you like best, and kill
9530 the authors you like least, without you having to say so explicitly. 
9531
9532 You can control what groups the adaptive scoring is to be performed on
9533 by using the score files (@pxref{Score File Format}).  This will also
9534 let you use different rules in different groups.
9535
9536 @vindex gnus-adaptive-file-suffix
9537 The adaptive score entries will be put into a file where the name is the
9538 group name with @code{gnus-adaptive-file-suffix} appended.  The default
9539 is @samp{ADAPT}.
9540
9541 @vindex gnus-score-exact-adapt-limit
9542 When doing adaptive scoring, substring or fuzzy matching would probably
9543 give you the best results in most cases.  However, if the header one
9544 matches is short, the possibility for false positives is great, so if
9545 the length of the match is less than
9546 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
9547 this variable is @code{nil}, exact matching will always be used to avoid
9548 this problem.
9549
9550
9551 @node Followups To Yourself
9552 @section Followups To Yourself
9553
9554 Gnus offers two commands for picking out the @code{Message-ID} header in
9555 the current buffer.  Gnus will then add a score rule that scores using
9556 this @code{Message-ID} on the @code{References} header of other
9557 articles.  This will, in effect, increase the score of all articles that
9558 respond to the article in the current buffer.  Quite useful if you want
9559 to easily note when people answer what you've said.
9560
9561 @table @code
9562
9563 @item gnus-score-followup-article
9564 @findex gnus-score-followup-article
9565 This will add a score to articles that directly follow up your own
9566 article. 
9567
9568 @item gnus-score-followup-thread
9569 @findex gnus-score-followup-thread
9570 This will add a score to all articles that appear in a thread ``below''
9571 your own article.
9572 @end table
9573
9574 @vindex gnus-inews-article-hook
9575 These two functions are both primarily meant to be used in hooks like
9576 @code{gnus-inews-article-hook}.  
9577
9578
9579 @node Scoring Tips
9580 @section Scoring Tips
9581 @cindex scoring tips
9582
9583 @table @dfn
9584
9585 @item Crossposts
9586 @cindex crossposts
9587 @cindex scoring crossposts
9588 If you want to lower the score of crossposts, the line to match on is
9589 the @code{Xref} header.
9590 @lisp
9591 ("xref" (" talk.politics.misc:" -1000))
9592 @end lisp
9593
9594 @item Multiple crossposts
9595 If you want to lower the score of articles that have been crossposted to
9596 more than, say, 3 groups:
9597 @lisp
9598 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
9599 @end lisp
9600
9601 @item Matching on the body
9602 This is generally not a very good idea---it takes a very long time.
9603 Gnus actually has to fetch each individual article from the server.  But
9604 you might want to anyway, I guess.  Even though there are three match
9605 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
9606 and stick with it in each score file.  If you use any two, each article
9607 will be fetched @emph{twice}.  If you want to match a bit on the
9608 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
9609 the matches.  
9610
9611 @item Marking as read
9612 You will probably want to mark articles that has a score below a certain
9613 number as read.  This is most easily achieved by putting the following
9614 in your @file{all.SCORE} file:
9615 @lisp
9616 ((mark -100))
9617 @end lisp
9618 You may also consider doing something similar with @code{expunge}.  
9619
9620 @item Negated character classes
9621 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
9622 That will match newlines, which might lead to, well, The Unknown.  Say
9623 @code{[^abcd\n]*} instead.
9624 @end table
9625
9626
9627 @node Reverse Scoring
9628 @section Reverse Scoring
9629 @cindex reverse scoring
9630
9631 If you want to keep just articles that have @samp{Sex with Emacs} in the
9632 subject header, and expunge all other articles, you could put something
9633 like this in your score file:
9634
9635 @lisp
9636 (("subject"
9637   ("Sex with Emacs" 2))
9638  (mark 1)
9639  (expunge 1))
9640 @end lisp
9641
9642 So, you raise all articles that match @samp{Sex with Emacs} and mark the
9643 rest as read, and expunge them to boot.
9644
9645
9646 @node Global Score Files
9647 @section Global Score Files
9648 @cindex global score files
9649
9650 Sure, other newsreaders have ``global kill files''.  These are usually
9651 nothing more than a single kill file that applies to all groups, stored
9652 in the user's home directory.  Bah!  Puny, weak newsreaders!
9653
9654 What I'm talking about here are Global Score Files.  Score files from
9655 all over the world, from users everywhere, uniting all nations in one
9656 big, happy score file union!  Ange-score!  New and untested!
9657
9658 @vindex gnus-global-score-files
9659 All you have to do to use other people's score files is to set the
9660 @code{gnus-global-score-files} variable.  One entry for each score file,
9661 or each score file directory.  Gnus will decide by itself what score
9662 files are applicable to which group.
9663
9664 Say you want to use all score files in the
9665 @file{/ftp@@ftp.some-where:/pub/score} directory and the single score
9666 file @file{/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE}:
9667
9668 @lisp
9669 (setq gnus-global-score-files
9670       '("/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
9671         "/ftp@@ftp.some-where:/pub/score/"))
9672 @end lisp
9673
9674 @findex gnus-score-search-global-directories
9675 Simple, eh?  Directory names must end with a @samp{/}.  These
9676 directories are typically scanned only once during each Gnus session.
9677 If you feel the need to manually re-scan the remote directories, you can
9678 use the @code{gnus-score-search-global-directories} command.
9679
9680 Note that, at present, using this option will slow down group entry
9681 somewhat.  (That is---a lot.)
9682
9683 If you want to start maintaining score files for other people to use,
9684 just put your score file up for anonymous ftp and announce it to the
9685 world.  Become a retro-moderator!  Participate in the retro-moderator
9686 wars sure to ensue, where retro-moderators battle it out for the
9687 sympathy of the people, luring them to use their score files on false
9688 premises!  Yay!  The net is saved!
9689
9690 Here are some tips for the would-be retro-moderator, off the top of my
9691 head: 
9692
9693 @itemize @bullet
9694
9695 @item 
9696 Articles that are heavily crossposted are probably junk. 
9697 @item
9698 To lower a single inappropriate article, lower by @code{Message-ID}.
9699 @item
9700 Particularly brilliant authors can be raised on a permanent basis. 
9701 @item
9702 Authors that repeatedly post off-charter for the group can safely be
9703 lowered out of existence.
9704 @item
9705 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
9706 articles completely.
9707
9708 @item 
9709 Use expiring score entries to keep the size of the file down.  You
9710 should probably have a long expiry period, though, as some sites keep
9711 old articles for a long time.
9712 @end itemize
9713
9714 ... I wonder whether other newsreaders will support global score files
9715 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
9716 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
9717 holding our breath yet?
9718
9719
9720 @node Kill Files
9721 @section Kill Files
9722 @cindex kill files
9723
9724 Gnus still supports those pesky old kill files.  In fact, the kill file
9725 entries can now be expiring, which is something I wrote before Daniel
9726 Quinlan thought of doing score files, so I've left the code in there.
9727
9728 In short, kill processing is a lot slower (and I do mean @emph{a lot})
9729 than score processing, so it might be a good idea to rewrite your kill
9730 files into score files.
9731
9732 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
9733 forms into this file, which means that you can use kill files as some
9734 sort of primitive hook function to be run on group entry, even though
9735 that isn't a very good idea.
9736
9737 XCNormal kill files look like this:
9738
9739 @lisp
9740 (gnus-kill "From" "Lars Ingebrigtsen")
9741 (gnus-kill "Subject" "ding")
9742 (gnus-expunge "X")
9743 @end lisp
9744
9745 This will mark every article written by me as read, and remove them from
9746 the summary buffer.  Very useful, you'll agree.
9747
9748 Other programs use a totally different kill file syntax.  If Gnus
9749 encounters what looks like a @code{rn} kill file, it will take a stab at
9750 interpreting it. 
9751
9752 Two summary functions for editing a GNUS kill file:
9753
9754 @table @kbd
9755
9756 @item M-k
9757 @kindex M-k (Summary)
9758 @findex gnus-summary-edit-local-kill
9759 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
9760
9761 @item M-K
9762 @kindex M-K (Summary)
9763 @findex gnus-summary-edit-global-kill
9764 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
9765 @end table
9766
9767 Two group mode functions for editing the kill files:
9768
9769 @table @kbd
9770
9771 @item M-k
9772 @kindex M-k (Group)
9773 @findex gnus-group-edit-local-kill
9774 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
9775
9776 @item M-K
9777 @kindex M-K (Group)
9778 @findex gnus-group-edit-global-kill
9779 Edit the general kill file (@code{gnus-group-edit-global-kill}).
9780 @end table
9781
9782 Kill file variables:
9783
9784 @table @code
9785 @item gnus-kill-file-name
9786 @vindex gnus-kill-file-name
9787 A kill file for the group @samp{soc.motss} is normally called
9788 @file{soc.motss.KILL}.  The suffix appended to the group name to get
9789 this file name is detailed by the @code{gnus-kill-file-name} variable.
9790 The ``global'' kill file (not in the score file sense of ``global'', of
9791 course) is called just @file{KILL}.
9792
9793 @vindex gnus-kill-save-kill-file
9794 @item gnus-kill-save-kill-file
9795 If this variable is non-@code{nil}, Gnus will save the
9796 kill file after processing, which is necessary if you use expiring
9797 kills. 
9798
9799 @item gnus-apply-kill-hook
9800 @vindex gnus-apply-kill-hook
9801 @findex gnus-apply-kill-file-unless-scored
9802 @findex gnus-apply-kill-file
9803 A hook called to apply kill files to a group.  It is
9804 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
9805 kill file if you have a score file for the same group, you can set this
9806 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
9807 kill files to be processed, you should set this variable to @code{nil}.
9808
9809 @item gnus-kill-file-mode-hook
9810 @vindex gnus-kill-file-mode-hook
9811 A hook called in kill-file mode buffers.
9812
9813 @end table
9814
9815
9816 @node GroupLens
9817 @section GroupLens
9818 @cindex GroupLens
9819
9820 GroupLens is a collaborative filtering system that helps you work
9821 together with other people to find the quality news articles out of the
9822 huge volume of news articles generated every day.
9823
9824 To accomplish this the GroupLens system combines your opinions about
9825 articles you have already read with the opinions of others who have done
9826 likewise and gives you a personalized prediction for each unread news
9827 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
9828 rate articles, and finds other people that rate articles the same way.
9829 Once it has found for you some people you agree with it tells you, in
9830 the form of a prediction, what they thought of the article.  You can use
9831 this prediction to help you decide whether or not you want to read the
9832 article.
9833
9834 @menu
9835 * Using GroupLens::          How to make Gnus use GroupLens.
9836 * Rating Articles::          Letting GroupLens know how you rate articles.
9837 * Displaying Predictions::   Displaying predictions given by GroupLens.
9838 * GroupLens Variables::      Customizing GroupLens.
9839 @end menu
9840
9841
9842 @node Using GroupLens
9843 @subsection Using GroupLens
9844
9845 To use GroupLens you must register a pseudonym with your local Better
9846 Bit Bureau (BBB).  At the moment the only better bit in town is at
9847 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html}.
9848
9849 Once you have registered you'll need to set a couple of variables.
9850
9851 @table @code
9852
9853 @item gnus-use-grouplens
9854 @vindex gnus-use-grouplens
9855 Setting this variable to a non-@code{nil} value will make Gnus hook into
9856 all the relevant GroupLens functions.
9857
9858 @item grouplens-pseudonym
9859 @vindex grouplens-pseudonym
9860 This variable should be set to the pseudonum you got when registering
9861 with the Better Bit Bureau.
9862
9863 @item grouplens-newsgroups
9864 @vindex grouplens-newsgroups
9865 A list of groups that you want to get GroupLens predictions for. 
9866
9867 @end table
9868
9869 Thats the minimum of what you need to get up and running with GroupLens.
9870 Once you've registered, GroupLens will start giving you scores for
9871 articles based on the average of what other people think.  But, to get
9872 the real benefit of GroupLens you need to start rating articles
9873 yourself.  Then the scores GroupLens gives you will be personalized for
9874 you, based on how the people you usually agree with have already rated.
9875
9876
9877 @node Rating Articles
9878 @subsection Rating Articles
9879
9880 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
9881 Where 1 means something like this article is a waste of bandwidth and 5
9882 means that the article was really good.  The basic question to ask
9883 yourself is, "on a scale from 1 to 5 would I like to see more articles
9884 like this one?"
9885
9886 There are four ways to enter a rating for an article in GroupLens.
9887
9888 @table @kbd
9889
9890 @item r
9891 @kindex r (GroupLens)
9892 @findex bbb-summary-rate-article
9893 This function will prompt you for a rating on a scale of one to five.
9894
9895 @item k
9896 @kindex k (GroupLens)
9897 @findex grouplens-score-thread
9898 This function will prompt you for a rating, and rate all the articles in
9899 the thread.  This is really useful for some of those long running giant
9900 threads in rec.humor.
9901
9902 @end table
9903
9904 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
9905 the score of the article you're reading.
9906
9907 @table @kbd
9908
9909 @item 1-5 n
9910 @kindex n (GroupLens)
9911 @findex grouplens-next-unread-article
9912 Rate the article and go to the next unread article.
9913
9914 @item 1-5 ,
9915 @kindex , (GroupLens)
9916 @findex grouplens-best-unread-article
9917 Rate the article and go to the next unread article with the highest score.
9918
9919 @end table
9920
9921 If you want to give the current article a score of 4 and then go to the
9922 next article, just type @kbd{4 n}.
9923
9924
9925 @node Displaying Predictions
9926 @subsection Displaying Predictions
9927
9928 GroupLens makes a prediction for you about how much you will like a
9929 news article.  The predictions from GroupLens are on a scale from 1 to
9930 5, where 1 is the worst and 5 is the best.  You can use the predictions
9931 from GroupLens in one of three ways controlled by the variable
9932 @code{gnus-grouplens-override-scoring}.
9933
9934 @vindex gnus-grouplens-override-scoring
9935 There are three ways to display predictions in grouplens.  You may
9936 choose to have the GroupLens scores contribute to, or override the
9937 regular gnus scoring mechanism. override is the default; however, some
9938 people prefer to see the Gnus scores plus the grouplens scores.  To get
9939 the separate scoring behavior you need to set
9940 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
9941 GroupLens predictions combined with the grouplens scores set it to
9942 @code{'override} and to combine the scores set
9943 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
9944 the combine option you will also want to set the values for
9945 @code{grouplens-prediction-offset} and
9946 @code{grouplens-score-scale-factor}.
9947
9948 @vindex grouplens-prediction-display
9949 In either case, GroupLens gives you a few choices for how you would like
9950 to see your predictions displayed.  The display of predictions is
9951 controlled by the @code{grouplens-prediction-display} variable.
9952
9953 The following are legal values for that variable.
9954
9955 @table @code
9956 @item prediction-spot
9957 The higher the prediction, the further to the right an @samp{*} is
9958 displayed. 
9959
9960 @item confidence-interval
9961 A numeric confidence interval.
9962
9963 @item prediction-bar
9964 The higher the prediction, the longer the bar.
9965
9966 @item confidence-bar
9967 Numerical confidence.
9968
9969 @item confidence-spot
9970 The spot gets bigger with more confidence.
9971
9972 @item prediction-num
9973 Plain-old numeric value.
9974
9975 @item confidence-plus-minus
9976 Prediction +/i confidence.
9977
9978 @end table
9979
9980
9981 @node GroupLens Variables
9982 @subsection GroupLens Variables
9983
9984 @table @code
9985
9986 @item gnus-summary-grouplens-line-format
9987 The summary line format used in summary buffers that are GroupLens
9988 enhanced.  It accepts the same specs as the normal summary line format
9989 (@pxref{Summary Buffer Lines}).  The default is
9990 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
9991
9992 @item grouplens-bbb-host
9993 Host running the bbbd server.  The default is
9994 @samp{grouplens.cs.umn.edu}. 
9995
9996 @item grouplens-bbb-port
9997 Port of the host running the bbbd server.  The default is 9000.
9998
9999 @item grouplens-score-offset
10000 Offset the prediction by this value.  In other words, subtract the
10001 prediction value by this number to arrive at the effective score.  The
10002 default is 0.
10003
10004 @item grouplens-score-scale-factor 
10005 This variable allows the user to magnify the effect of GroupLens scores.
10006 The scale factor is applied after the offset.  The default is 1.
10007
10008 @end table
10009
10010
10011
10012 @node Various
10013 @chapter Various
10014
10015 @menu
10016 * Process/Prefix::             A convention used by many treatment commands.
10017 * Interactive::                Making Gnus ask you many questions.
10018 * Formatting Variables::       You can specify what buffers should look like.
10019 * Windows Configuration::      Configuring the Gnus buffer windows.
10020 * Compilation::                How to speed Gnus up.
10021 * Mode Lines::                 Displaying information in the mode lines.
10022 * Highlighting and Menus::     Making buffers look all nice and cozy.
10023 * Buttons::                    Get tendonitis in ten easy steps!
10024 * Daemons::                    Gnus can do things behind your back.
10025 * NoCeM::                      How to avoid spam and other fatty foods.
10026 * Picons::                     How to display pictures of what your reading.
10027 * Various Various::            Things that are really various.
10028 @end menu
10029
10030
10031 @node Process/Prefix
10032 @section Process/Prefix
10033 @cindex process/prefix convention
10034
10035 Many functions, among them functions for moving, decoding and saving
10036 articles, use what is known as the @dfn{Process/Prefix convention}.
10037
10038 This is a method for figuring out what articles that the user wants the
10039 command to be performed on.
10040
10041 It goes like this:
10042
10043 If the numeric prefix is N, perform the operation on the next N
10044 articles, starting with the current one.  If the numeric prefix is
10045 negative, perform the operation on the previous N articles, starting
10046 with the current one.
10047
10048 @vindex transient-mark-mode
10049 If @code{transient-mark-mode} in non-@code{nil} and the region is
10050 active, all articles in the region will be worked upon.
10051
10052 If there is no numeric prefix, but some articles are marked with the
10053 process mark, perform the operation on the articles that are marked with
10054 the process mark.
10055
10056 If there is neither a numeric prefix nor any articles marked with the
10057 process mark, just perform the operation on the current article.
10058
10059 Quite simple, really, but it needs to be made clear so that surprises
10060 are avoided.
10061
10062 @vindex gnus-summary-goto-unread
10063 One thing that seems to shock & horrify lots of people is that, for
10064 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
10065 Since each @kbd{d} (which marks the current article as read) by default
10066 goes to the next unread article after marking, this means that @kbd{3 d}
10067 will mark the next three unread articles as read, no matter what the
10068 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
10069 @code{nil} for a more straightforward action.
10070
10071
10072 @node Interactive
10073 @section Interactive
10074 @cindex interaction
10075
10076 @table @code
10077
10078 @item gnus-novice-user
10079 @vindex gnus-novice-user
10080 If this variable is non-@code{nil}, you are either a newcomer to the
10081 World of Usenet, or you are very cautious, which is a nice thing to be,
10082 really.  You will be given questions of the type ``Are you sure you want
10083 to do this?'' before doing anything dangerous.  This is @code{t} by
10084 default.
10085
10086 @item gnus-expert-user
10087 @vindex gnus-expert-user
10088 If this variable is non-@code{nil}, you will never ever be asked any
10089 questions by Gnus.  It will simply assume you know what you're doing, no
10090 matter how strange.
10091
10092 @item gnus-interactive-catchup
10093 @vindex gnus-interactive-catchup
10094 Require confirmation before catching up a group if non-@code{nil}.  It
10095 is @code{t} by default.
10096
10097 @item gnus-interactive-exit
10098 @vindex gnus-interactive-exit
10099 Require confirmation before exiting Gnus.  This variable is @code{t} by
10100 default. 
10101 @end table
10102
10103
10104 @node Formatting Variables
10105 @section Formatting Variables
10106 @cindex formatting variables
10107
10108 Throughout this manual you've probably noticed lots of variables that
10109 are called things like @code{gnus-group-line-format} and
10110 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
10111 output lines in the various buffers.  There's quite a lot of them.
10112 Fortunately, they all use the same syntax, so there's not that much to
10113 be annoyed by.
10114
10115 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
10116 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
10117 lots of percentages everywhere.  
10118
10119 Each @samp{%} element will be replaced by some string or other when the
10120 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
10121 spec, and pad with spaces to get a 5-character field''.  Just like a
10122 normal format spec, almost.
10123
10124 You can also say @samp{%6,4y}, which means that the field will never be
10125 more than 6 characters wide and never less than 4 characters wide.
10126
10127 There are also specs for highlighting, and these are shared by all the
10128 format variables.  Text inside the @samp{%(} and @samp{%)} specifiers
10129 will get the special @code{mouse-face} property set, which means that it
10130 will be highlighted (with @code{gnus-mouse-face}) when you put the mouse
10131 pointer over it.
10132
10133 Text inside the @samp{%[} and @samp{%]} specifiers will have their
10134 normal faces set using @code{gnus-face-0}, which is @code{bold} by
10135 default.  If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
10136 instead, and so on.  Create as many faces as you wish.  The same goes
10137 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
10138 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
10139
10140 Here's an alternative recipe for the group buffer:
10141
10142 @lisp
10143 ;; Create three face types.
10144 (setq gnus-face-1 'bold)
10145 (setq gnus-face-3 'italic)
10146
10147 ;; We want the article count to be in 
10148 ;; a bold and green face.  So we create 
10149 ;; a new face called `my-green-bold'.
10150 (copy-face 'bold 'my-green-bold)
10151 ;; Set the color.
10152 (set-face-foreground 'my-green-bold "ForestGreen")
10153 (setq gnus-face-2 'my-green-bold)
10154
10155 ;; Set the new & fancy format.
10156 (setq gnus-group-line-format 
10157       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
10158 @end lisp
10159
10160 I'm sure you'll be able to use this scheme to create totally unreadable
10161 and extremely vulgar displays.  Have fun!
10162
10163 Currently Gnus uses the following formatting variables:
10164 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
10165 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
10166 @code{gnus-group-mode-line-format},
10167 @code{gnus-summary-mode-line-format},
10168 @code{gnus-article-mode-line-format},
10169 @code{gnus-server-mode-line-format}. 
10170
10171 Note that the @samp{%(} specs (and friends) do not make any sense on the
10172 mode-line variables.
10173
10174 All these format variables can also be arbitrary elisp forms.  In that
10175 case, they will be @code{eval}ed to insert the required lines.
10176
10177 @kindex M-x gnus-update-format
10178 @findex gnus-update-format
10179 Gnus includes a command to help you while creating your own format
10180 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
10181 update the spec in question and pop you to a buffer where you can
10182 examine the resulting lisp code to be run to generate the line.  
10183
10184
10185 @node Windows Configuration
10186 @section Windows Configuration
10187 @cindex windows configuration
10188
10189 No, there's nothing here about X, so be quiet.
10190
10191 @vindex gnus-use-full-window
10192 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
10193 other windows and occupy the entire Emacs screen by itself.  It is
10194 @code{t} by default.
10195
10196 @vindex gnus-buffer-configuration
10197 @code{gnus-buffer-configuration} describes how much space each Gnus
10198 buffer should be given.  Here's an excerpt of this variable:
10199
10200 @lisp
10201 ((group (vertical 1.0 (group 1.0 point)
10202                       (if gnus-carpal (group-carpal 4))))
10203  (article (vertical 1.0 (summary 0.25 point) 
10204                         (article 1.0))))
10205 @end lisp
10206
10207 This is an alist.  The @dfn{key} is a symbol that names some action or
10208 other.  For instance, when displaying the group buffer, the window
10209 configuration function will use @code{group} as the key.  A full list of
10210 possible names is listed below.
10211
10212 The @dfn{value} (i. e., the @dfn{split}) says how much space each buffer
10213 should occupy.  To take the @code{article} split as an example -
10214
10215 @lisp
10216 (article (vertical 1.0 (summary 0.25 point)
10217                        (article 1.0)))
10218 @end lisp
10219
10220 This @dfn{split} says that the summary buffer should occupy 25% of upper
10221 half of the screen, and that it is placed over the article buffer.  As
10222 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
10223 reaching for that calculator there).  However, the special number
10224 @code{1.0} is used to signal that this buffer should soak up all the
10225 rest of the space available after the rest of the buffers have taken
10226 whatever they need.  There should be only one buffer with the @code{1.0}
10227 size spec per split.
10228
10229 Point will be put in the buffer that has the optional third element
10230 @code{point}. 
10231
10232 Here's a more complicated example:
10233
10234 @lisp
10235 (article (vertical 1.0 (group 4)
10236                        (summary 0.25 point)
10237                        (if gnus-carpal (summary-carpal 4))
10238                        (article 1.0)))
10239 @end lisp
10240
10241 If the size spec is an integer instead of a floating point number, 
10242 then that number will be used to say how many lines a buffer should
10243 occupy, not a percentage.
10244
10245 If the @dfn{split} looks like something that can be @code{eval}ed (to be
10246 precise---if the @code{car} of the split is a function or a subr), this
10247 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
10248 be used as a split.  This means that there will be three buffers if
10249 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
10250 is non-@code{nil}.
10251
10252 Not complicated enough for you?  Well, try this on for size:
10253
10254 @lisp
10255 (article (horizontal 1.0 
10256              (vertical 0.5
10257                  (group 1.0)
10258                  (gnus-carpal 4))
10259              (vertical 1.0
10260                  (summary 0.25 point)
10261                  (summary-carpal 4)
10262                  (article 1.0))))
10263 @end lisp
10264
10265 Whoops.  Two buffers with the mystery 100% tag.  And what's that
10266 @code{horizontal} thingie?  
10267
10268 If the first element in one of the split is @code{horizontal}, Gnus will
10269 split the window horizontally, giving you two windows side-by-side.
10270 Inside each of these strips you may carry on all you like in the normal
10271 fashion.  The number following @code{horizontal} says what percentage of
10272 the screen is to be given to this strip.
10273
10274 For each split, there @emph{must} be one element that has the 100% tag.
10275 The splitting is never accurate, and this buffer will eat any leftover
10276 lines from the splits.
10277
10278 To be slightly more formal, here's a definition of what a legal split
10279 may look like:
10280
10281 @example
10282 split       = frame | horizontal | vertical | buffer | form
10283 frame       = "(frame " size *split ")"
10284 horizontal  = "(horizontal " size *split ")"
10285 vertical    = "(vertical " size *split ")"
10286 buffer      = "(" buffer-name " " size *[ "point" ] ")"
10287 size        = number | frame-params
10288 buffer-name = group | article | summary ...
10289 @end example
10290
10291 The limitations are that the @code{frame} split can only appear as the
10292 top-level split.  @var{form} should be an Emacs Lisp form that should
10293 return a valid split.  We see that each split is fully recursive, and
10294 may contain any number of @code{vertical} and @code{horizontal} splits. 
10295
10296 @vindex gnus-window-min-width
10297 @vindex gnus-window-min-height
10298 @cindex window height
10299 @cindex window width
10300 Finding the right sizes can be a bit complicated.  No window may be less
10301 than @code{gnus-window-min-height} (default 2) characters high, and all
10302 windows must be at least @code{gnus-window-min-width} (default 1)
10303 characters wide.  Gnus will try to enforce this before applying the
10304 splits.  If you want to use the normal Emacs window width/height limit,
10305 you can just set these two variables to @code{nil}.
10306
10307 If you're not familiar with Emacs terminology, @code{horizontal} and
10308 @code{vertical} splits may work the opposite way of what you'd expect.
10309 Windows inside a @code{horizontal} split are shown side-by-side, and
10310 windows within a @code{vertical} split are shown above each other.
10311
10312 @findex gnus-configure-frame
10313 If you want to experiment with window placement, a good tip is to call
10314 @code{gnus-configure-frame} directly with a split.  This is the function
10315 that does all the real work when splitting buffers.  Below is a pretty
10316 nonsensical configuration with 5 windows; two for the group buffer and
10317 three for the article buffer.  (I said it was nonsensical.)  If you
10318 @code{eval} the statement below, you can get an idea of how that would
10319 look straight away, without going through the normal Gnus channels.
10320 Play with it until you're satisfied, and then use
10321 @code{gnus-add-configuration} to add your new creation to the buffer
10322 configuration list. 
10323
10324 @lisp
10325 (gnus-configure-frame
10326  '(horizontal 1.0
10327     (vertical 10
10328       (group 1.0)
10329       (article 0.3 point))
10330     (vertical 1.0
10331       (article 1.0)
10332       (horizontal 4
10333         (group 1.0)
10334         (article 10)))))
10335 @end lisp
10336
10337 You might want to have several frames as well.  No prob---just use the
10338 @code{frame} split:
10339
10340 @lisp
10341 (gnus-configure-frame
10342  '(frame 1.0
10343          (vertical 1.0
10344                    (summary 0.25 point)
10345                    (article 1.0))
10346          (vertical ((height . 5) (width . 15)
10347                     (user-position . t)
10348                     (left . -1) (top . 1))
10349                    (picon 1.0))))
10350
10351 @end lisp
10352
10353 This split will result in the familiar summary/article window
10354 configuration in the first (or ``main'') frame, while a small additional
10355 frame will be created where picons will be shown.  As you can see,
10356 instead of the normal @code{1.0} top-level spec, each additional split
10357 should have a frame parameter alist as the size spec.
10358 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
10359 Reference Manual}.
10360
10361 Here's a list of all possible keys for
10362 @code{gnus-buffer-configuration}:
10363
10364 @code{group}, @code{summary}, @code{article}, @code{server},
10365 @code{browse}, @code{group-mail}, @code{summary-mail},
10366 @code{summary-reply}, @code{info}, @code{summary-faq},
10367 @code{edit-group}, @code{edit-server}, @code{reply}, @code{reply-yank},
10368 @code{followup}, @code{followup-yank}, @code{edit-score}.  
10369
10370 @findex gnus-add-configuration
10371 Since the @code{gnus-buffer-configuration} variable is so long and
10372 complicated, there's a function you can use to ease changing the config
10373 of a single setting: @code{gnus-add-configuration}.  If, for instance,
10374 you want to change the @code{article} setting, you could say:
10375
10376 @lisp
10377 (gnus-add-configuration
10378  '(article (vertical 1.0
10379                (group 4)
10380                (summary .25 point)
10381                (article 1.0))))
10382 @end lisp
10383
10384 You'd typically stick these @code{gnus-add-configuration} calls in your
10385 @file{.gnus} file or in some startup hook -- they should be run after
10386 Gnus has been loaded.
10387
10388
10389 @node Compilation 
10390 @section Compilation 
10391 @cindex compilation
10392 @cindex byte-compilation
10393
10394 @findex gnus-compile
10395
10396 Remember all those line format specification variables?
10397 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
10398 on.  Now, Gnus will of course heed whatever these variables are, but,
10399 unfortunately, changing them will mean a quite significant slow-down.
10400 (The default values of these variables have byte-compiled functions
10401 associated with them, while the user-generated versions do not, of
10402 course.) 
10403
10404 To help with this, you can run @kbd{M-x gnus-compile} after you've
10405 fiddled around with the variables and feel that you're (kind of)
10406 satisfied.  This will result in the new specs being byte-compiled, and
10407 you'll get top speed again.
10408
10409
10410 @node Mode Lines
10411 @section Mode Lines
10412 @cindex mode lines
10413
10414 @vindex gnus-updated-mode-lines
10415 @code{gnus-updated-mode-lines} says what buffers should keep their mode
10416 lines updated.  It is a list of symbols.  Supported symbols include
10417 @code{group}, @code{article}, @code{summary}, @code{server},
10418 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
10419 Gnus will keep that mode line updated with information that may be
10420 pertinent.  If this variable is @code{nil}, screen refresh may be
10421 quicker.
10422
10423 @cindex display-time
10424
10425 @vindex gnus-mode-non-string-length
10426 By default, Gnus displays information on the current article in the mode
10427 lines of the summary and article buffers.  The information Gnus wishes
10428 to display (eg. the subject of the article) is often longer than the
10429 mode lines, and therefore have to be cut off at some point.  The
10430 @code{gnus-mode-non-string-length} variable says how long the other
10431 elements on the line is (i.e., the non-info part).  If you put
10432 additional elements on the mode line (eg. a clock), you should modify
10433 this variable:
10434
10435 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
10436 @lisp
10437 (add-hook 'display-time-hook
10438           (lambda () (setq gnus-mode-non-string-length
10439                            (+ 21
10440                               (if line-number-mode 5 0)
10441                               (if column-number-mode 4 0)
10442                               (length display-time-string)))))
10443 @end lisp
10444
10445 If this variable is @code{nil} (which is the default), the mode line
10446 strings won't be chopped off, and they won't be padded either.
10447
10448
10449 @node Highlighting and Menus
10450 @section Highlighting and Menus
10451 @cindex visual
10452 @cindex highlighting
10453 @cindex menus
10454
10455 @vindex gnus-visual
10456 The @code{gnus-visual} variable controls most of the prettifying Gnus
10457 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
10458 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
10459 file.
10460
10461 This variable can be a list of visual properties that are enabled.  The
10462 following elements are legal, and are all included by default:
10463
10464 @table @code
10465 @item group-highlight
10466 Do highlights in the group buffer.
10467 @item summary-highlight
10468 Do highlights in the summary buffer.
10469 @item article-highlight
10470 Do highlights in the article buffer.
10471 @item highlight
10472 Turn on highlighting in all buffers.
10473 @item group-menu
10474 Create menus in the group buffer.
10475 @item summary-menu
10476 Create menus in the summary buffers.
10477 @item article-menu
10478 Create menus in the article buffer.
10479 @item browse-menu
10480 Create menus in the browse buffer.
10481 @item server-menu
10482 Create menus in the server buffer.
10483 @item score-menu
10484 Create menus in the score buffers.
10485 @item menu
10486 Create menus in all buffers.
10487 @end table
10488
10489 So if you only want highlighting in the article buffer and menus in all
10490 buffers, you could say something like:
10491
10492 @lisp
10493 (setq gnus-visual '(article-highlight menu))
10494 @end lisp
10495
10496 If you want only highlighting and no menus whatsoever, you'd say:
10497
10498 @lisp
10499 (setq gnus-visual '(highlight))
10500 @end lisp
10501
10502 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
10503 in all Gnus buffers.
10504
10505 Other general variables that influence the look of all buffers include:
10506
10507 @table @code
10508 @item gnus-mouse-face
10509 @vindex gnus-mouse-face
10510 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
10511 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
10512
10513 @item gnus-display-type
10514 @vindex gnus-display-type
10515 This variable is symbol indicating the display type Emacs is running
10516 under.  The symbol should be one of @code{color}, @code{grayscale} or
10517 @code{mono}.  If Gnus guesses this display attribute wrongly, either set
10518 this variable in your @file{~/.emacs} or set the resource
10519 @code{Emacs.displayType} in your @file{~/.Xdefaults}.
10520
10521 @item gnus-background-mode 
10522 @vindex gnus-background-mode 
10523 This is a symbol indicating the Emacs background brightness.  The symbol
10524 should be one of @code{light} or @code{dark}.  If Gnus guesses this
10525 frame attribute wrongly, either set this variable in your @file{~/.emacs} or
10526 set the resource @code{Emacs.backgroundMode} in your @file{~/.Xdefaults}. 
10527 `gnus-display-type'.
10528 @end table
10529
10530 There are hooks associated with the creation of all the different menus:
10531
10532 @table @code
10533
10534 @item gnus-article-menu-hook
10535 @vindex gnus-article-menu-hook
10536 Hook called after creating the article mode menu.
10537
10538 @item gnus-group-menu-hook
10539 @vindex gnus-group-menu-hook
10540 Hook called after creating the group mode menu.
10541
10542 @item gnus-summary-menu-hook
10543 @vindex gnus-summary-menu-hook
10544 Hook called after creating the summary mode menu.
10545
10546 @item gnus-server-menu-hook
10547 @vindex gnus-server-menu-hook
10548 Hook called after creating the server mode menu.
10549
10550 @item gnus-browse-menu-hook
10551 @vindex gnus-browse-menu-hook
10552 Hook called after creating the browse mode menu.
10553
10554 @item gnus-score-menu-hook
10555 @vindex gnus-score-menu-hook
10556 Hook called after creating the score mode menu.
10557
10558 @end table
10559
10560
10561 @node Buttons
10562 @section Buttons
10563 @cindex buttons
10564 @cindex mouse
10565 @cindex click
10566
10567 Those new-fangled @dfn{mouse} contraptions is very popular with the
10568 young, hep kids who don't want to learn the proper way to do things
10569 these days.  Why, I remember way back in the summer of '89, when I was
10570 using Emacs on a Tops 20 system.  Three hundred users on one single
10571 machine, and every user was running Simula compilers.  Bah!
10572
10573 Right.
10574
10575 @vindex gnus-carpal
10576 Well, you can make Gnus display bufferfuls of buttons you can click to
10577 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
10578 really.  Tell the chiropractor I sent you.
10579
10580
10581 @table @code
10582
10583 @item gnus-carpal-mode-hook
10584 @vindex gnus-carpal-mode-hook
10585 Hook run in all carpal mode buffers.
10586
10587 @item gnus-carpal-button-face
10588 @vindex gnus-carpal-button-face
10589 Face used on buttons.
10590
10591 @item gnus-carpal-header-face
10592 @vindex gnus-carpal-header-face
10593 Face used on carpal buffer headers.
10594
10595 @item gnus-carpal-group-buffer-buttons
10596 @vindex gnus-carpal-group-buffer-buttons
10597 Buttons in the group buffer.
10598
10599 @item gnus-carpal-summary-buffer-buttons
10600 @vindex gnus-carpal-summary-buffer-buttons
10601 Buttons in the summary buffer.
10602
10603 @item gnus-carpal-server-buffer-buttons
10604 @vindex gnus-carpal-server-buffer-buttons
10605 Buttons in the server buffer.
10606
10607 @item gnus-carpal-browse-buffer-buttons
10608 @vindex gnus-carpal-browse-buffer-buttons
10609 Buttons in the browse buffer.
10610 @end table
10611
10612 All the @code{buttons} variables are lists.  The elements in these list
10613 is either a cons cell where the car contains a text to be displayed and
10614 the cdr contains a function symbol, or a simple string.
10615
10616
10617 @node Daemons
10618 @section Daemons
10619 @cindex demons
10620 @cindex daemons
10621
10622 Gnus, being larger than any program ever written (allegedly), does lots
10623 of strange stuff that you may wish to have done while you're not
10624 present.  For instance, you may want it to check for new mail once in a
10625 while.  Or you may want it to close down all connections to all servers
10626 when you leave Emacs idle.  And stuff like that.
10627
10628 Gnus will let you do stuff like that by defining various
10629 @dfn{handlers}.  Each handler consists of three elements:  A
10630 @var{function}, a @var{time}, and an @var{idle} parameter.
10631
10632 Here's an example of a handler that closes connections when Emacs has
10633 been idle for thirty minutes:
10634
10635 @lisp
10636 (gnus-demon-close-connections nil 30)
10637 @end lisp
10638
10639 Here's a handler that scans for PGP headers every hour when Emacs is
10640 idle: 
10641
10642 @lisp
10643 (gnus-demon-scan-pgp 60 t)
10644 @end lisp
10645
10646 This @var{time} parameter and than @var{idle} parameter works together
10647 in a strange, but wonderful fashion.  Basically, if @var{idle} is
10648 @code{nil}, then the function will be called every @var{time} minutes.
10649
10650 If @var{idle} is @code{t}, then the function will be called after
10651 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
10652 the function will never be called.  But once Emacs goes idle, the
10653 function will be called every @var{time} minutes.
10654
10655 If @var{idle} is a number and @var{time} is a number, the function will
10656 be called every @var{time} minutes only when Emacs has been idle for
10657 @var{idle} minutes.
10658
10659 If @var{idle} is a number and @var{time} is @code{nil}, the function
10660 will be called once every time Emacs has been idle for @var{idle}
10661 minutes.  
10662
10663 And if @var{time} is a string, it should look like @samp{07:31}, and
10664 the function will then be called once every day somewhere near that
10665 time.  Modified by the @var{idle} parameter, of course.
10666
10667 @vindex gnus-demon-timestep
10668 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
10669 seconds.  This is @code{60} by default.  If you change that variable,
10670 all the timings in the handlers will be affected.)
10671
10672 @vindex gnus-use-demon
10673 To set the whole thing in motion, though, you have to set
10674 @code{gnus-use-demon} to @code{t}.
10675
10676 So, if you want to add a handler, you could put something like this in
10677 your @file{.gnus} file:
10678
10679 @findex gnus-demon-add-handler
10680 @lisp
10681 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
10682 @end lisp
10683
10684 @findex gnus-demon-add-nocem
10685 @findex gnus-demon-add-scanmail
10686 @findex gnus-demon-add-disconnection
10687 Some ready-made functions to do this has been created:
10688 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection}, and
10689 @code{gnus-demon-add-scanmail}.  Just put those functions in your
10690 @file{.gnus} if you want those abilities.
10691
10692 @findex gnus-demon-init
10693 @findex gnus-demon-cancel
10694 @vindex gnus-demon-handlers
10695 If you add handlers to @code{gnus-demon-handlers} directly, you should
10696 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
10697 daemons, you can use the @code{gnus-demon-cancel} function.
10698
10699 Note that adding daemons can be pretty naughty if you overdo it.  Adding
10700 functions that scan all news and mail from all servers every two seconds
10701 is a sure-fire way of getting booted off any respectable system.  So
10702 behave. 
10703
10704
10705 @node NoCeM
10706 @section NoCeM
10707 @cindex nocem
10708 @cindex spam
10709
10710 @dfn{Spamming} is posting the same article lots and lots of times.
10711 Spamming is bad.  Spamming is evil.  
10712
10713 Spamming is usually canceled within a day or so by various anti-spamming
10714 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
10715 NoCeM is pronounced ``no see-'em'', and means what the name
10716 implies---these are messages that make the offending articles, like, go
10717 away.  
10718
10719 What use are these NoCeM messages if the articles are canceled anyway?
10720 Some sites do not honor cancel messages and some sites just honor cancels
10721 from a select few people.  Then you may wish to make use of the NoCeM
10722 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
10723
10724 Gnus can read and parse the messages in this group automatically, and
10725 this will make spam disappear.  
10726
10727 There are some variables to customize, of course:
10728
10729 @table @code
10730 @item gnus-use-nocem
10731 @vindex gnus-use-nocem
10732 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
10733 by default. 
10734
10735 @item gnus-nocem-groups
10736 @vindex gnus-nocem-groups
10737 Gnus will look for NoCeM messages in the groups in this list.  The
10738 default is @code{("alt.nocem.misc" "news.admin.net-abuse.announce")}. 
10739
10740 @item gnus-nocem-issuers
10741 @vindex gnus-nocem-issuers
10742 There are many people issuing NoCeM messages.  This list says what
10743 people you want to listen to.  The default is @code{("Automoose-1"
10744 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
10745 (Richard E. Depew)")}; fine, upstanding citizens all of them.
10746
10747 Known despammers that you can put in this list include:
10748
10749 @table @samp
10750 @item clewis@@ferret.ocunix.on.ca;
10751 @cindex Chris Lewis
10752 Chris Lewis---Major Canadian despammer who has probably canceled more
10753 usenet abuse than anybody else.
10754
10755 @item Automoose-1
10756 @cindex CancelMoose[tm]
10757 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
10758 Norwegian, and was the person(s) who invented NoCeM.  
10759
10760 @item jem@@xpat.com;
10761 @cindex Jem
10762 Jem---Korean despammer who is getting very busy these days.
10763
10764 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
10765 Richard E. Depew---lone American despammer.  He mostly cancels binary
10766 postings to non-binary groups and removes spews (regurgitated articles).
10767 @end table
10768
10769 You do not have to heed NoCeM messages from all these people---just the
10770 ones you want to listen to.
10771
10772 @item gnus-nocem-directory
10773 @vindex gnus-nocem-directory
10774 This is where Gnus will store its NoCeM cache files.  The default is
10775 @file{~/News/NoCeM/}. 
10776
10777 @item gnus-nocem-expiry-wait
10778 @vindex gnus-nocem-expiry-wait
10779 The number of days before removing old NoCeM entries from the cache.
10780 The default is 15.  If you make it shorter Gnus will be faster, but you
10781 might then see old spam.
10782
10783 @end table
10784
10785
10786 @node Picons
10787 @section Picons
10788
10789 So...  You want to slow down your news reader even more!  This is a
10790 good way to do so.  Its also a great way to impress people staring
10791 over your shoulder as you read news.
10792
10793 @menu
10794 * Picon Basics::           What are picons and How do I get them.
10795 * Picon Requirements::     Don't go further if you aren't using XEmacs.
10796 * Easy Picons::            Displaying Picons -- the easy way.
10797 * Hard Picons::            The way you should do it.  You'll learn something.
10798 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
10799 @end menu
10800
10801
10802 @node Picon Basics
10803 @subsection Picon Basics
10804
10805 What are Picons?  To quote directly from the Picons Web site
10806 (@samp{http://www.cs.indiana.edu/picons/ftp/index.html}):
10807
10808 @quotation 
10809 @dfn{Picons} is short for ``personal icons''.  They're small,
10810 constrained images used to represent users and domains on the net,
10811 organized into databases so that the appropriate image for a given
10812 e-mail address can be found.  Besides users and domains, there are picon
10813 databases for Usenet newsgroups and weather forecasts.  The picons are
10814 in either monochrome @code{XBM} format or color @code{XPM} and
10815 @code{GIF} formats.
10816 @end quotation
10817
10818 Please see the above mentioned web site for instructions on obtaining
10819 and installing the picons databases, or the following ftp site:
10820 @samp{http://www.cs.indiana.edu/picons/ftp/index.html}.
10821
10822 @vindex gnus-picons-database
10823 Gnus expects picons to be installed into a location pointed to by
10824 @code{gnus-picons-database}.
10825
10826
10827 @node Picon Requirements
10828 @subsection Picon Requirements
10829
10830 To use have Gnus display Picons for you, you must be running XEmacs
10831 19.13 or greater since all other versions of Emacs aren't yet able to
10832 display images.
10833
10834 Additionally, you must have @code{xpm} support compiled into XEmacs.
10835
10836 @vindex gnus-picons-convert-x-face
10837 If you want to display faces from @code{X-Face} headers, you must have
10838 the @code{netpbm} utilities installed, or munge the
10839 @code{gnus-picons-convert-x-face} variable to use something else.
10840
10841
10842 @node Easy Picons
10843 @subsection Easy Picons
10844
10845 To enable displaying picons, simply put the following line in your
10846 @file{~/.gnus} file and start Gnus.
10847
10848 @lisp
10849 (setq gnus-use-picons t)
10850 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
10851 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
10852 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
10853 @end lisp
10854
10855
10856 @node Hard Picons
10857 @subsection Hard Picons 
10858
10859 Gnus can display picons for you as you enter and leave groups and
10860 articles.  It knows how to interact with three sections of the picons
10861 database.  Namely, it can display the picons newsgroup pictures,
10862 author's face picture(s), and the authors domain.  To enable this
10863 feature, you need to first decide where to display them.
10864
10865 @table @code 
10866
10867 @item gnus-picons-display-where 
10868 @vindex gnus-picons-display-where 
10869 Where the picon images should be displayed.  It is @code{picons} by
10870 default (which by default maps to the buffer @samp{*Picons*}).  Other
10871 valid places could be @code{article}, @code{summary}, or
10872 @samp{"*scratch*"} for all I care.  Just make sure that you've made the
10873 buffer visible using the standard Gnus window configuration routines --
10874 @xref{Windows Configuration}.
10875
10876 @end table
10877
10878 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
10879 window configuration for you to include the @code{picons} buffer.
10880
10881 Now that you've made that decision, you need to add the following
10882 functions to the appropriate hooks so these pictures will get
10883 displayed at the right time.
10884
10885 @vindex gnus-article-display-hook
10886 @vindex gnus-picons-display-where
10887 @table @code
10888 @item gnus-article-display-picons
10889 @findex gnus-article-display-picons
10890 Looks up and display the picons for the author and the author's domain
10891 in the @code{gnus-picons-display-where} buffer.  Should be added to
10892 the @code{gnus-article-display-hook}.
10893
10894 @item gnus-group-display-picons
10895 @findex gnus-article-display-picons
10896 Displays picons representing the current group.  This function should
10897 be added to the @code{gnus-summary-prepare-hook} or to the
10898 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
10899 is set to @code{article}.
10900
10901 @item gnus-picons-article-display-x-face
10902 @findex gnus-article-display-picons
10903 Decodes and displays the X-Face header if present.  This function
10904 should be added to @code{gnus-article-display-hook}.
10905
10906 @end table
10907
10908 Note:  You must append them to the hook, so make sure to specify 't'
10909 to the append flag of @code{add-hook}:
10910
10911 @lisp
10912 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
10913 @end lisp
10914
10915
10916 @node Picon Configuration
10917 @subsection Picon Configuration
10918
10919 The following variables offer further control over how things are
10920 done, where things are located, and other useless stuff you really
10921 don't need to worry about.
10922
10923 @table @code
10924 @item gnus-picons-database
10925 @vindex gnus-picons-database
10926 The location of the picons database.  Should point to a directory
10927 containing the @file{news}, @file{domains}, @file{users} (and so on)
10928 subdirectories.  Defaults to @file{/usr/local/faces}.
10929
10930 @item gnus-picons-news-directory
10931 @vindex gnus-picons-news-directory
10932 Sub-directory of the faces database containing the icons for
10933 newsgroups.
10934
10935 @item gnus-picons-user-directories
10936 @vindex gnus-picons-user-directories
10937 List of subdirectories to search in @code{gnus-picons-database} for user
10938 faces.  Defaults to @code{("local" "users" "usenix" "misc/MISC")}.
10939
10940 @item gnus-picons-domain-directories
10941 @vindex gnus-picons-domain-directories
10942 List of subdirectories to search in @code{gnus-picons-database} for
10943 domain name faces.  Defaults to @code{("domains")}.  Some people may
10944 want to add @samp{unknown} to this list.
10945
10946 @item gnus-picons-convert-x-face
10947 @vindex gnus-picons-convert-x-face
10948 The command to use to convert the @code{X-Face} header to an X bitmap
10949 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
10950 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
10951 gnus-picons-x-face-file-name)}
10952
10953 @item gnus-picons-x-face-file-name
10954 @vindex gnus-picons-x-face-file-name
10955 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
10956 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
10957
10958 @item gnus-picons-buffer
10959 @vindex gnus-picons-buffer
10960 The name of the buffer that @code{picons} points to.  Defaults to
10961 @samp{*Icon Buffer*}.
10962
10963 @end table
10964
10965
10966 @node Various Various
10967 @section Various Various
10968 @cindex mode lines
10969 @cindex highlights
10970
10971 @table @code
10972
10973 @item gnus-verbose
10974 @vindex gnus-verbose
10975 This variable is an integer between zero and ten.  The higher the value,
10976 the more messages will be displayed.  If this variable is zero, Gnus
10977 will never flash any messages, if it is seven (which is the default),
10978 most important messages will be shown, and if it is ten, Gnus won't ever
10979 shut up, but will flash so many messages it will make your head swim.
10980
10981 @item gnus-verbose-backends
10982 @vindex gnus-verbose-backends
10983 This variable works the same way as @code{gnus-verbose}, but it applies
10984 to the Gnus backends instead of Gnus proper.
10985
10986 @item nnheader-max-head-length
10987 @vindex nnheader-max-head-length
10988 When the backends read straight heads of articles, they all try to read
10989 as little as possible.  This variable (default @code{4096}) specifies
10990 the absolute max length the backends will try to read before giving up
10991 on finding a separator line between the head and the body.  If this
10992 variable is @code{nil}, there is no upper read bound.  If it is
10993 @code{t}, the backends won't try to read the articles piece by piece,
10994 but read the entire articles.  This makes sense with some versions of
10995 @code{ange-ftp}. 
10996
10997 @item nnheader-file-name-translation-alist 
10998 @vindex nnheader-file-name-translation-alist 
10999 @cindex file names
11000 @cindex illegal characters in file names
11001 @cindex characters in file names
11002 This is an alist that says how to translate characters in file names.
11003 For instance, if @samp{:} is illegal as a file character in file names
11004 on your system (you OS/2 user you), you could say something like:
11005
11006 @lisp
11007 (setq nnheader-file-name-translation-alist 
11008       '((?: . ?_)))
11009 @end lisp
11010
11011 In fact, this is the default value for this variable on OS/2 and MS
11012 Windows (phooey) systems.
11013
11014 @item gnus-hidden-properties
11015 @vindex gnus-hidden-properties
11016 This is a list of properties to use to hide ``invisible'' text.  It is
11017 @code{(invisible t intangible t)} by default on most systems, which
11018 makes invisible text invisible and intangible.
11019
11020 @item gnus-parse-headers-hook
11021 @vindex gnus-parse-headers-hook
11022 A hook called before parsing headers.  It can be used, for instance, to
11023 gather statistics on the headers fetched, or perhaps you'd like to prune
11024 some headers.  I don't see why you'd want that, though.
11025
11026 @end table
11027
11028
11029 @node The End
11030 @chapter The End
11031
11032 Well, that's the manual---you can get on with your life now.  Keep in
11033 touch.  Say hello to your cats from me.  
11034
11035 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
11036
11037 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
11038
11039 @quotation
11040 @strong{Te Deum}
11041 @sp 1
11042 Not because of victories @*
11043 I sing,@*
11044 having none,@*
11045 but for the common sunshine,@*
11046 the breeze,@*
11047 the largess of the spring.
11048 @sp 1
11049 Not for victory@*
11050 but for the day's work done@*
11051 as well as I was able;@*
11052 not for a seat upon the dais@*
11053 but at the common table.@*
11054 @end quotation
11055
11056
11057 @node Appendices
11058 @chapter Appendices
11059
11060 @menu
11061 * History::                        How Gnus got where it is today.
11062 * Terminology::                    We use really difficult, like, words here.
11063 * Customization::                  Tailoring Gnus to your needs.
11064 * Troubleshooting::                What you might try if things do not work.
11065 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
11066 * Emacs for Heathens::             A short introduction to Emacsian terms.
11067 * Frequently Asked Questions::     A question-and-answer session.
11068 @end menu
11069
11070
11071 @node History
11072 @section History
11073
11074 @cindex history
11075 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
11076 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
11077
11078 If you want to investigate the person responsible for this outrage, you
11079 can point your (feh!) web browser to
11080 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
11081 distribution point for the new and spiffy versions of Gnus, and is known
11082 as The Site That Destroys Newsrcs And Drives People Mad.
11083
11084 During the first extended alpha period of development, the new Gnus was
11085 called ``(ding) Gnus''.  @dfn{(ding)}, is, of course, short for
11086 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
11087 (Besides, the ``Gnus'' in this abbreviation should probably be
11088 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
11089 appropriate name, don't you think?)
11090
11091 In any case, after spending all that energy on coming up with a new and
11092 spunky name, we decided that the name was @emph{too} spunky, so we
11093 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
11094 ``@sc{gnus}''.  New vs. old.
11095
11096 The first ``proper'' release of Gnus 5 was done in November 1995 when it
11097 was included in the Emacs 19.30 distribution.
11098
11099 In May 1996 the next Gnus generation (aka.  ``September Gnus'') was
11100 released under the name ``Gnus 5.2''.  
11101
11102 @menu
11103 * Why?::                What's the point of Gnus?
11104 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
11105 * Conformity::          Gnus tries to conform to all standards.
11106 * Emacsen::             Gnus can be run on a few modern Emacsen.
11107 * Contributors::        Oodles of people.  
11108 * New Features::        Pointers to some of the new stuff in Gnus.
11109 * Newest Features::     Features so new that they haven't been written yet.
11110 * Censorship::          This manual has been censored.
11111 @end menu
11112
11113
11114 @node Why?
11115 @subsection Why?
11116
11117 What's the point of Gnus?  
11118
11119 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
11120 newsreader, that lets you do anything you can think of.  That was my
11121 original motivation, but while working on Gnus, it has become clear to
11122 me that this generation of newsreaders really belong in the stone age.
11123 Newsreaders haven't developed much since the infancy of the net.  If the
11124 volume continues to rise with the current rate of increase, all current
11125 newsreaders will be pretty much useless.  How do you deal with
11126 newsgroups that have thousands of new articles each day?  How do you
11127 keep track of millions of people who post?
11128
11129 Gnus offers no real solutions to these questions, but I would very much
11130 like to see Gnus being used as a testing ground for new methods of
11131 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
11132 to separate the newsreader from the backends, Gnus now offers a simple
11133 interface for anybody who wants to write new backends for fetching mail
11134 and news from different sources.  I have added hooks for customizations
11135 everywhere I could imagine useful.  By doing so, I'm inviting every one
11136 of you to explore and invent.
11137
11138 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}. 
11139
11140
11141 @node Compatibility
11142 @subsection Compatibility
11143
11144 @cindex compatibility
11145 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
11146 bindings have been kept.  More key bindings have been added, of course,
11147 but only in one or two obscure cases have old bindings been changed.
11148
11149 Our motto is:
11150 @quotation
11151 @cartouche
11152 @center In a cloud bones of steel.
11153 @end cartouche
11154 @end quotation
11155
11156 All commands have kept their names.  Some internal functions have changed
11157 their names.
11158
11159 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
11160 Articles}. 
11161
11162 One major compatibility question is the presence of several summary
11163 buffers.  All variables that are relevant while reading a group are
11164 buffer-local to the summary buffer they belong in.  Although many
11165 important variables have their values copied into their global
11166 counterparts whenever a command is executed in the summary buffer, this
11167 change might lead to incorrect values being used unless you are careful.
11168
11169 All code that relies on knowledge of @sc{gnus} internals will probably
11170 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
11171 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
11172 maintains a hash table that points to the entries in this alist (which
11173 speeds up many functions), and changing the alist directly will lead to
11174 peculiar results.
11175
11176 @cindex hilit19
11177 @cindex highlighting
11178 Old hilit19 code does not work at all.  In fact, you should probably
11179 remove all hilit code from all Gnus hooks
11180 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
11181 Gnus provides various integrated functions for highlighting.  These are
11182 faster and more accurate.  To make life easier for everybody, Gnus will
11183 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
11184 Away!
11185
11186 Packages like @code{expire-kill} will no longer work.  As a matter of
11187 fact, you should probably remove all old @sc{gnus} packages (and other
11188 code) when you start using Gnus.  More likely than not, Gnus already
11189 does what you have written code to make @sc{gnus} do.  (Snicker.)
11190
11191 Even though old methods of doing things are still supported, only the
11192 new methods are documented in this manual.  If you detect a new method of
11193 doing something while reading this manual, that does not mean you have
11194 to stop doing it the old way.
11195
11196 Gnus understands all @sc{gnus} startup files.
11197
11198 @kindex M-x gnus-bug
11199 @findex gnus-bug
11200 @cindex reporting bugs
11201 @cindex bugs
11202 Overall, a casual user who hasn't written much code that depends on
11203 @sc{gnus} internals should suffer no problems.  If problems occur,
11204 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
11205
11206
11207 @node Conformity
11208 @subsection Conformity
11209
11210 No rebels without a clue here, ma'am.  We conform to all standards known
11211 to (wo)man.  Except for those standards and/or conventions we disagree
11212 with, of course.
11213
11214 @table @strong
11215
11216 @item RFC 822
11217 @cindex RFC 822
11218 There are no known breaches of this standard.
11219
11220 @item RFC 1036
11221 @cindex RFC 1036
11222 There are no known breaches of this standard, either.
11223
11224 @item Usenet Seal of Approval
11225 @cindex Usenet Seal of Approval
11226 Gnus hasn't been formally through the Seal process, but I have read
11227 through the Seal text and I think Gnus would pass.
11228
11229 @item Son-of-RFC 1036
11230 @cindex Son-of-RFC 1036
11231 We do have some breaches to this one.
11232
11233 @table @emph
11234
11235 @item MIME
11236 Gnus does no MIME handling, and this standard-to-be seems to think that
11237 MIME is the bees' knees, so we have major breakage here.
11238
11239 @item X-Newsreader
11240 This is considered to be a ``vanity header'', while I consider it to be
11241 consumer information.  After seeing so many badly formatted articles
11242 coming from @code{tin} and @code{Netscape} I know not to use either of
11243 those for posting articles.  I would not have known that if it wasn't
11244 for the @code{X-Newsreader} header.
11245
11246 @item References
11247 Gnus does line breaking on this header.  I infer from RFC1036 that being
11248 conservative in what you output is not creating 5000-character lines, so
11249 it seems like a good idea to me.  However, this standard-to-be says that
11250 whitespace in the @code{References} header is to be preserved, so...  It
11251 doesn't matter one way or the other to Gnus, so if somebody tells me
11252 what The Way is, I'll change it.  Or not.
11253 @end table
11254
11255 @end table
11256
11257 If you ever notice Gnus acting non-compliantly with regards to the texts
11258 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
11259 know.
11260
11261
11262 @node Emacsen
11263 @subsection Emacsen
11264 @cindex Emacsen
11265 @cindex XEmacs
11266 @cindex Mule
11267 @cindex Emacs
11268
11269 Gnus should work on :
11270
11271 @itemize @bullet 
11272
11273 @item
11274 Emacs 19.30 and up.
11275
11276 @item
11277 XEmacs 19.13 and up.
11278
11279 @item 
11280 Mule versions based on Emacs 19.30 and up.
11281
11282 @end itemize
11283
11284 Gnus will absolutely not work on any Emacsen older than that.  Not
11285 reliably, at least. 
11286
11287 There are some vague differences between Gnus on the various platforms: 
11288
11289 @itemize @bullet
11290
11291 @item
11292 The mouse-face on Gnus lines under Emacs and Mule is delimited to
11293 certain parts of the lines while they cover the entire line under
11294 XEmacs. 
11295
11296 @item 
11297 The same with current-article marking---XEmacs puts an underline under
11298 the entire summary line while Emacs and Mule are nicer and kinder.
11299
11300 @item
11301 XEmacs features more graphics---a logo and a toolbar.
11302
11303 @item
11304 Citation highlighting us better under Emacs and Mule than under XEmacs.
11305
11306 @item
11307 Emacs 19.26-19.28 have tangible hidden headers, which can be a bit
11308 confusing. 
11309
11310 @end itemize
11311
11312
11313 @node Contributors
11314 @subsection Contributors
11315 @cindex contributors
11316
11317 The new Gnus version couldn't have been done without the help of all the
11318 people on the (ding) mailing list.  Every day for over a year I have
11319 gotten billions of nice bug reports from them, filling me with joy,
11320 every single one of them.  Smooches.  The people on the list have been
11321 tried beyond endurance, what with my ``oh, that's a neat idea <type
11322 type>, yup, I'll release it right away <ship off> no wait, that doesn't
11323 work at all <type type>, yup, I'll ship that one off right away <ship
11324 off> no, wait, that absolutely does not work'' policy for releases.
11325 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
11326 ``worser''? ``much worser''?  ``worsest''?)
11327
11328 I would like to take this opportunity to thank the Academy for...  oops,
11329 wrong show.
11330
11331 @itemize @bullet
11332
11333 @item Masanobu @sc{Umeda}
11334 The writer of the original @sc{gnus}.
11335
11336 @item Per Abrahamsen
11337 Custom, scoring, highlighting and @sc{soup} code (as well as numerous
11338 other things).
11339
11340 @item Luis Fernandes
11341 Design and graphics.
11342
11343 @item Wes Hardaker
11344 @file{gnus-picon.el} and the manual section on @dfn{picons}
11345 (@pxref{Picons}). 
11346
11347 @item Brad Miller
11348 @file{gnus-gl.el} and the GroupLens manual section (@pxref{GroupLens}). 
11349
11350 @item Sudish Joseph
11351 Innumerable bug fixes.
11352
11353 @item Ilja Weis
11354 @file{gnus-topic.el}.
11355
11356 @item Steven L. Baur
11357 Lots and lots of bugs detections and fixes.
11358
11359 @item Vladimir Alexiev
11360 The refcard and reference booklets.
11361
11362 @item Felix Lee & JWZ
11363 I stole some pieces from the XGnus distribution by Felix Lee and JWZ.
11364
11365 @item Scott Byer
11366 @file{nnfolder.el} enhancements & rewrite.
11367
11368 @item Peter Mutsaers
11369 Orphan article scoring code.
11370
11371 @item Ken Raeburn
11372 POP mail support.
11373
11374 @item Hallvard B Furuseth
11375 Various bits and pieces, especially dealing with .newsrc files.
11376
11377 @item Brian Edmonds
11378 @file{gnus-bbdb.el}.
11379
11380 @item Ricardo Nassif and Mark Borges
11381 Proof-reading.
11382
11383 @item Kevin Davidson
11384 Came up with the name @dfn{ding}, so blame him.
11385
11386 @end itemize
11387
11388 Peter Arius, Stainless Steel Rat, Ulrik Dickow, Jack Vinson, Daniel
11389 Quinlan, Frank D. Cringle, Geoffrey T. Dairiki, Fabrice Popineau and
11390 Andrew Eskilsson have all contributed code and suggestions.
11391
11392
11393 @node New Features
11394 @subsection New Features
11395 @cindex new features
11396
11397 @itemize @bullet
11398
11399 @item
11400 The look of all buffers can be changed by setting format-like variables
11401 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
11402  
11403 @item 
11404 Local spool and several @sc{nntp} servers can be used at once
11405 (@pxref{Select Methods}).  
11406
11407 @item 
11408 You can combine groups into virtual groups (@pxref{Virtual Groups}).
11409
11410 @item 
11411 You can read a number of different mail formats (@pxref{Getting Mail}).
11412 All the mail backends implement a convenient mail expiry scheme
11413 (@pxref{Expiring Mail}). 
11414
11415 @item
11416 Gnus can use various strategies for gathering threads that have lost
11417 their roots (thereby gathering loose sub-threads into one thread) or it
11418 can go back and retrieve enough headers to build a complete thread
11419 (@pxref{Customizing Threading}).
11420
11421 @item 
11422 Killed groups can be displayed in the group buffer, and you can read
11423 them as well (@pxref{Listing Groups}).
11424
11425 @item 
11426 Gnus can do partial group updates---you do not have to retrieve the
11427 entire active file just to check for new articles in a few groups
11428 (@pxref{The Active File}).
11429
11430 @item 
11431 Gnus implements a sliding scale of subscribedness to groups
11432 (@pxref{Group Levels}).
11433
11434 @item 
11435 You can score articles according to any number of criteria
11436 (@pxref{Scoring}).  You can even get Gnus to find out how to score
11437 articles for you (@pxref{Adaptive Scoring}).
11438
11439 @item 
11440 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
11441 manner, so it should be difficult to lose much data on what you have
11442 read if your machine should go down (@pxref{Auto Save}). 
11443
11444 @item 
11445 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
11446 the @file{.emacs} file.
11447
11448 @item 
11449 You can set the process mark on both groups and articles and perform
11450 operations on all the marked items (@pxref{Process/Prefix}).
11451
11452 @item 
11453 You can grep through a subset of groups and create a group from the
11454 results (@pxref{Kibozed Groups}). 
11455
11456 @item 
11457 You can list subsets of groups according to, well, anything
11458 (@pxref{Listing Groups}). 
11459
11460 @item 
11461 You can browse foreign servers and subscribe to groups from those
11462 servers (@pxref{Browse Foreign Server}). 
11463
11464 @item 
11465 Gnus can fetch articles asynchronously on a second connection to the
11466 server (@pxref{Asynchronous Fetching}).
11467
11468 @item 
11469 You can cache articles locally (@pxref{Article Caching}). 
11470
11471 @item 
11472 The uudecode functions have been expanded and generalized
11473 (@pxref{Decoding Articles}). 
11474
11475 @item
11476 You can still post uuencoded articles, which was a little-known feature
11477 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
11478
11479 @item
11480 Fetching parents (and other articles) now actually works without
11481 glitches (@pxref{Finding the Parent}). 
11482
11483 @item
11484 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
11485
11486 @item
11487 Digests (and other files) can be used as the basis for groups
11488 (@pxref{Document Groups}).
11489
11490 @item 
11491 Articles can be highlighted and customized (@pxref{Customizing
11492 Articles}). 
11493
11494 @item 
11495 URLs and other external references can be buttonized (@pxref{Article
11496 Buttons}). 
11497
11498 @item
11499 You can do lots of strange stuff with the Gnus window & frame
11500 configuration (@pxref{Windows Configuration}).
11501
11502 @item
11503 You can click on buttons instead of using the keyboard
11504 (@pxref{Buttons}). 
11505
11506 @item 
11507 Gnus can use NoCeM files to weed out spam (@pxref{NoCeM}). 
11508
11509 @end itemize
11510
11511 This is, of course, just a @emph{short} overview of the @emph{most}
11512 important new features.  No, really.  There are tons more.  Yes, we have
11513 feeping creaturism in full effect, but nothing too gratuitous, I would
11514 hope. 
11515
11516
11517 @node Newest Features
11518 @subsection Newest Features
11519 @cindex todo
11520
11521 Also known as the @dfn{todo list}.  Sure to be implemented before the
11522 next millennium. 
11523
11524 Be afraid.  Be very afraid.
11525
11526 @itemize @bullet
11527 @item
11528 Native @sc{mime} support is something that should be done.  
11529 @item
11530 A better and simpler method for specifying mail composing methods. 
11531 @item
11532 Allow posting through mail-to-news gateways.
11533 @item
11534 Really do unbinhexing.
11535 @end itemize
11536
11537 And much, much, much more.  There is more to come than has already been
11538 implemented.  (But that's always true, isn't it?)
11539
11540 @code{<URL:http://www.ifi.uio.no/~larsi/sgnus/todo>} is where the actual
11541 up-to-the-second todo list is located, so if you're really curious, you
11542 could point your Web browser over that-a-way.
11543
11544
11545 @node Censorship
11546 @subsection Censorship
11547 @cindex censorship
11548
11549 This version of the Gnus manual (as well as Gnus itself) has been
11550 censored in accord with the Communications Decency Act.  This law was
11551 described by its proponents as a ban on pornography---which was a
11552 deception, since it prohibits far more than that.  This manual did not
11553 contain pornography, but part of it was prohibited nonetheless.
11554
11555 For information on US government censorship of the Internet, and
11556 what you can do to bring back freedom of the press, see the web
11557 site @samp{http://www.vtw.org/}.
11558
11559
11560 @node Terminology
11561 @section Terminology
11562
11563 @cindex terminology
11564 @table @dfn
11565
11566 @item news
11567 @cindex news
11568 This is what you are supposed to use this thing for---reading news.
11569 News is generally fetched from a nearby @sc{nntp} server, and is
11570 generally publicly available to everybody.  If you post news, the entire
11571 world is likely to read just what you have written, and they'll all
11572 snigger mischievously.  Behind your back.
11573
11574 @item mail
11575 @cindex mail
11576 Everything that's delivered to you personally is mail.  Some news/mail
11577 readers (like Gnus) blur the distinction between mail and news, but
11578 there is a difference.  Mail is private.  News is public.  Mailing is
11579 not posting, and replying is not following up.
11580
11581 @item reply
11582 @cindex reply
11583 Send a mail to the person who has written what you are reading.
11584
11585 @item follow up
11586 @cindex follow up
11587 Post an article to the current newsgroup responding to the article you
11588 are reading.
11589
11590 @item backend
11591 @cindex backend
11592 Gnus gets fed articles from a number of backends, both news and mail
11593 backends.  Gnus does not handle the underlying media, so to speak---this
11594 is all done by the backends.
11595
11596 @item native
11597 @cindex native
11598 Gnus will always use one method (and backend) as the @dfn{native}, or
11599 default, way of getting news.
11600
11601 @item foreign
11602 @cindex foreign
11603 You can also have any number of foreign groups active at the same time.
11604 These are groups that use different backends for getting news.
11605
11606 @item secondary
11607 @cindex secondary
11608 Secondary backends are somewhere half-way between being native and being
11609 foreign, but they mostly act like they are native.
11610
11611 @item article
11612 @cindex article
11613 A nessage that has been posted as news.
11614
11615 @item mail message
11616 @cindex mail message
11617 A message that has been mailed.
11618
11619 @item message 
11620 @cindex message
11621 A mail message or news article
11622
11623 @item head
11624 @cindex head
11625 The top part of a message, where administrative information (etc.) is
11626 put.
11627
11628 @item body
11629 @cindex body
11630 The rest of an article.  Everything that is not in the head is in the
11631 body. 
11632
11633 @item header
11634 @cindex header
11635 A line from the head of an article. 
11636
11637 @item headers
11638 @cindex headers
11639 A collection of such lines, or a collection of heads.  Or even a
11640 collection of @sc{nov} lines.
11641
11642 @item @sc{nov}
11643 @cindex nov
11644 When Gnus enters a group, it asks the backend for the headers of all
11645 unread articles in the group.  Most servers support the News OverView
11646 format, which is more compact and much faster to read and parse than the
11647 normal @sc{head} format.
11648
11649 @item level
11650 @cindex levels
11651 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
11652 that have a lower level are ``more'' subscribed than the groups with a
11653 higher level.  In fact, groups on levels 1-5 are considered
11654 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
11655 are @dfn{killed}.  Commands for listing groups and scanning for new
11656 articles will all use the numeric prefix as @dfn{working level}.
11657
11658 @item killed groups
11659 @cindex killed groups
11660 No information on killed groups is stored or updated, which makes killed
11661 groups much easier to handle than subscribed groups.
11662
11663 @item zombie groups
11664 @cindex zombie groups
11665 Just like killed groups, only slightly less dead.
11666
11667 @item active file
11668 @cindex active file
11669 The news server has to keep track of what articles it carries, and what
11670 groups exist.  All this information in stored in the active file, which
11671 is rather large, as you might surmise.
11672
11673 @item bogus groups
11674 @cindex bogus groups
11675 A group that exists in the @file{.newsrc} file, but isn't known to the
11676 server (i. e.,  it isn't in the active file), is a @emph{bogus group}.
11677 This means that the group probably doesn't exist (any more).
11678
11679 @item server 
11680 @cindex server
11681 A machine than one can connect to and get news (or mail) from.
11682
11683 @item select method
11684 @cindex select method
11685 A structure that specifies the backend, the server and the virtual
11686 server parameters.
11687
11688 @item virtual server
11689 @cindex virtual server
11690 A named select method.  Since a select methods defines all there is to
11691 know about connecting to a (physical) server, taking the who things as a
11692 whole is a virtual server.
11693
11694 @end table
11695
11696
11697 @node Customization
11698 @section Customization
11699 @cindex general customization
11700
11701 All variables are properly documented elsewhere in this manual.  This
11702 section is designed to give general pointers on how to customize Gnus
11703 for some quite common situations.
11704
11705 @menu
11706 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
11707 * Slow Terminal Connection::  You run a remote Emacs.
11708 * Little Disk Space::         You feel that having large setup files is icky.
11709 * Slow Machine::              You feel like buying a faster machine.
11710 @end menu
11711
11712
11713 @node Slow/Expensive Connection
11714 @subsection Slow/Expensive @sc{nntp} Connection
11715
11716 If you run Emacs on a machine locally, and get your news from a machine
11717 over some very thin strings, you want to cut down on the amount of data
11718 Gnus has to get from the @sc{nntp} server.
11719
11720 @table @code
11721
11722 @item gnus-read-active-file
11723 Set this to @code{nil}, which will inhibit Gnus from requesting the
11724 entire active file from the server.  This file is often v.  large.  You
11725 also have to set @code{gnus-check-new-news} and
11726 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
11727 doesn't suddenly decide to fetch the active file anyway.
11728
11729 @item gnus-nov-is-evil
11730 This one has to be @code{nil}.  If not, grabbing article headers from
11731 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
11732 support @sc{xover}; Gnus will detect this by itself.
11733 @end table
11734
11735
11736 @node Slow Terminal Connection
11737 @subsection Slow Terminal Connection
11738
11739 Let's say you use your home computer for dialing up the system that
11740 runs Emacs and Gnus.  If your modem is slow, you want to reduce the
11741 amount of data that is sent over the wires as much as possible.
11742
11743 @table @code
11744
11745 @item gnus-auto-center-summary
11746 Set this to @code{nil} to inhibit Gnus from re-centering the summary
11747 buffer all the time.  If it is @code{vertical}, do only vertical
11748 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
11749 horizontal and vertical recentering.
11750
11751 @item gnus-visible-headers
11752 Cut down on the headers that are included in the articles to the
11753 minimum.  You can, in fact, make do without them altogether---most of the
11754 useful data is in the summary buffer, anyway.  Set this variable to
11755 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
11756
11757 @item gnus-article-display-hook
11758 Set this hook to all the available hiding commands:
11759 @lisp
11760 (setq gnus-article-display-hook 
11761       '(gnus-article-hide-headers gnus-article-hide-signature
11762         gnus-article-hide-citation))
11763 @end lisp
11764
11765 @item gnus-use-full-window
11766 By setting this to @code{nil}, you can make all the windows smaller.
11767 While this doesn't really cut down much generally, it means that you
11768 have to see smaller portions of articles before deciding that you didn't
11769 want to read them anyway.
11770
11771 @item gnus-thread-hide-subtree
11772 If this is non-@code{nil}, all threads in the summary buffer will be
11773 hidden initially.
11774
11775 @item gnus-updated-mode-lines
11776 If this is @code{nil}, Gnus will not put information in the buffer mode
11777 lines, which might save some time.
11778 @end table
11779
11780
11781 @node Little Disk Space
11782 @subsection Little Disk Space
11783 @cindex disk space
11784
11785 The startup files can get rather large, so you may want to cut their
11786 sizes a bit if you are running out of space.
11787
11788 @table @code
11789
11790 @item gnus-save-newsrc-file
11791 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
11792 only save @file{.newsrc.eld}.  This means that you will not be able to
11793 use any other newsreaders than Gnus.  This variable is @code{t} by
11794 default. 
11795
11796 @item gnus-save-killed-list
11797 If this is @code{nil}, Gnus will not save the list of dead groups.  You
11798 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
11799 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
11800 variable to @code{nil}.  This variable is @code{t} by default.
11801
11802 @end table
11803
11804
11805 @node Slow Machine
11806 @subsection Slow Machine
11807 @cindex slow machine
11808
11809 If you have a slow machine, or are just really impatient, there are a
11810 few things you can do to make Gnus run faster.
11811
11812 Set@code{gnus-check-new-newsgroups} and
11813 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
11814
11815 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
11816 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
11817 summary buffer faster.
11818
11819 Set @code{gnus-article-display-hook} to @code{nil} to make article
11820 processing a bit faster.
11821
11822
11823 @node Troubleshooting
11824 @section Troubleshooting
11825 @cindex troubleshooting
11826
11827 Gnus works @emph{so} well straight out of the box---I can't imagine any
11828 problems, really.
11829
11830 Ahem.
11831
11832 @enumerate
11833
11834 @item
11835 Make sure your computer is switched on.
11836
11837 @item
11838 Make sure that you really load the current Gnus version.  If you have
11839 been running @sc{gnus}, you need to exit Emacs and start it up again before
11840 Gnus will work.
11841
11842 @item
11843 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
11844 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
11845 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
11846 flee}, you have some old @file{.el} files lying around.  Delete these.
11847
11848 @item
11849 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
11850 how-to. 
11851 @end enumerate
11852
11853 If all else fails, report the problem as a bug.
11854
11855 @cindex bugs
11856 @cindex reporting bugs
11857
11858 @kindex M-x gnus-bug
11859 @findex gnus-bug
11860 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
11861 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
11862 me the backtrace.  I will fix bugs, but I can only fix them if you send
11863 me a precise description as to how to reproduce the bug.
11864
11865 You really can never be too detailed in a bug report.  Always use the
11866 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
11867 a 10Kb mail each time you use it, and even if you have sent me your
11868 environment 500 times before.  I don't care.  I want the full info each
11869 time.  
11870
11871 It is also important to remember that I have no memory whatsoever.  If
11872 you send a bug report, and I send you a reply, and then you send back
11873 just ``No, it's not! Moron!'', I will have no idea what you are
11874 insulting me about.  Always over-explain everything.  It's much easier
11875 for all of us---if I don't have all the information I need, I will just
11876 mail you and ask for more info, and everything takes more time.
11877
11878 If the problem you're seeing is very visual, and you can't quite explain
11879 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
11880 it somewhere it can be reached, and include the URL of the picture in
11881 the bug report.a
11882
11883 If you just need help, you are better off asking on
11884 @samp{gnu.emacs.gnus}.  I'm not very helpful.
11885
11886 @cindex gnu.emacs.gnus
11887 @cindex ding mailing list
11888 You can also ask on the ding mailing list---@samp{ding@@ifi.uio.no}.
11889 Write to @samp{ding-request@@ifi.uio.no} to subscribe.
11890
11891
11892 @node A Programmers Guide to Gnus
11893 @section A Programmer's Guide to Gnus
11894
11895 It is my hope that other people will figure out smart stuff that Gnus
11896 can do, and that other people will write those smart things as well.  To
11897 facilitate that I thought it would be a good idea to describe the inner
11898 workings of Gnus.  And some of the not-so-inner workings, while I'm at
11899 it.
11900
11901 You can never expect the internals of a program not to change, but I
11902 will be defining (in some details) the interface between Gnus and its
11903 backends (this is written in stone), the format of the score files
11904 (ditto), data structures (some are less likely to change than others)
11905 and general method of operations.
11906
11907 @menu 
11908 * Backend Interface::        How Gnus communicates with the servers.
11909 * Score File Syntax::        A BNF definition of the score file standard.
11910 * Headers::                  How Gnus stores headers internally.
11911 * Ranges::                   A handy format for storing mucho numbers.
11912 * Group Info::               The group info format.
11913 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
11914 * Various File Formats::     Formats of files that Gnus use.
11915 @end menu
11916
11917
11918 @node Backend Interface
11919 @subsection Backend Interface
11920
11921 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
11922 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
11923 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
11924 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
11925 examples of the latter we have @code{nntp-port-number} and
11926 @code{nnmbox-directory}.
11927
11928 When Gnus asks for information from a backend---say @code{nntp}---on
11929 something, it will normally include a virtual server name in the
11930 function parameters.  (If not, the backend should use the ``current''
11931 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
11932 server as its only (optional) parameter.  If this virtual server hasn't
11933 been opened, the function should fail.
11934
11935 Note that a virtual server name has no relation to some physical server
11936 name.  Take this example:
11937
11938 @lisp
11939 (nntp "odd-one" 
11940       (nntp-address "ifi.uio.no") 
11941       (nntp-port-number 4324))
11942 @end lisp
11943
11944 Here the virtual server name is @samp{odd-one} while the name of
11945 the physical server is @samp{ifi.uio.no}. 
11946
11947 The backends should be able to switch between several virtual servers.
11948 The standard backends implement this by keeping an alist of virtual
11949 server environments that it pulls down/pushes up when needed.  
11950
11951 There are two groups of interface functions: @dfn{required functions},
11952 which must be present, and @dfn{optional functions}, which Gnus will
11953 always check whether are present before attempting to call.
11954
11955 All these functions are expected to return data in the buffer
11956 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
11957 unfortunately named, but we'll have to live with it.  When I talk about
11958 ``resulting data'', I always refer to the data in that buffer.  When I
11959 talk about ``return value'', I talk about the function value returned by
11960 the function call.
11961
11962 Some backends could be said to be @dfn{server-forming} backends, and
11963 some might be said to not be.  The latter are backends that generally
11964 only operate on one group at a time, and have no concept of ``server''
11965 -- they have a group, and they deliver info on that group and nothing
11966 more.
11967
11968 In the examples and definitions I will refer to the imaginary backend
11969 @code{nnchoke}. 
11970
11971 @cindex @code{nnchoke}
11972
11973 @menu
11974 * Required Backend Functions::        Functions that must be implemented.
11975 * Optional Backend Functions::        Functions that need not be implemented.
11976 * Writing New Backends::              Extending old backends.
11977 @end menu
11978
11979
11980 @node Required Backend Functions
11981 @subsubsection Required Backend Functions
11982
11983 @table @code
11984
11985 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
11986
11987 @var{articles} is either a range of article numbers or a list of
11988 @code{Message-ID}s.  Current backends do not fully support either---only
11989 sequences (lists) of article numbers, and most backends do not support
11990 retrieval of @code{Message-ID}s.  But they should try for both. 
11991
11992 The result data should either be HEADs or NOV lines, and the result
11993 value should either be @code{headers} or @code{nov} to reflect this.
11994 This might later be expanded to @code{various}, which will be a mixture
11995 of HEADs and NOV lines, but this is currently not supported by Gnus.  
11996
11997 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
11998 headers, in some meaning of the word.  This is generally done by
11999 fetching (at most) @var{fetch-old} extra headers less than the smallest
12000 article number in @code{articles}, and fill in the gaps as well.  The
12001 presence of this parameter can be ignored if the backend finds it
12002 cumbersome to follow the request.  If this is non-@code{nil} and not a
12003 number, do maximum fetches.
12004
12005 Here's an example HEAD:
12006
12007 @example
12008 221 1056 Article retrieved.
12009 Path: ifi.uio.no!sturles
12010 From: sturles@@ifi.uio.no (Sturle Sunde)
12011 Newsgroups: ifi.discussion
12012 Subject: Re: Something very droll
12013 Date: 27 Oct 1994 14:02:57 +0100
12014 Organization: Dept. of Informatics, University of Oslo, Norway
12015 Lines: 26
12016 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
12017 References: <38jdmq$4qu@@visbur.ifi.uio.no>
12018 NNTP-Posting-Host: holmenkollen.ifi.uio.no
12019 .
12020 @end example
12021
12022 So a @code{headers} return value would imply that there's a number of
12023 these in the data buffer.
12024
12025 Here's a BNF definition of such a buffer:
12026
12027 @example
12028 headers        = *head
12029 head           = error / valid-head
12030 error-message  = [ "4" / "5" ] 2number " " <error message> eol
12031 valid-head     = valid-message *header "." eol
12032 valid-message  = "221 " <number> " Article retrieved." eol
12033 header         = <text> eol
12034 @end example
12035
12036 If the return value is @code{nov}, the data buffer should contain
12037 @dfn{network overview database} lines.  These are basically fields
12038 separated by tabs. 
12039
12040 @example
12041 nov-buffer = *nov-line
12042 nov-line   = 8*9 [ field <TAB> ] eol
12043 field      = <text except TAB>
12044 @end example
12045
12046 For a closer explanation what should be in those fields,
12047 @pxref{Headers}. 
12048
12049
12050 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
12051
12052 @var{server} is here the virtual server name.  @var{definitions} is a
12053 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server. 
12054
12055 If the server can't be opened, no error should be signaled.  The backend
12056 may then choose to refuse further attempts at connecting to this
12057 server.  In fact, it should do so. 
12058
12059 If the server is opened already, this function should return a
12060 non-@code{nil} value.  There should be no data returned.
12061
12062
12063 @item (nnchoke-close-server &optional SERVER)
12064
12065 Close connection to @var{server} and free all resources connected
12066 to it.  Return @code{nil} if the server couldn't be closed for some
12067 reason.
12068
12069 There should be no data returned.
12070
12071
12072 @item (nnchoke-request-close)
12073
12074 Close connection to all servers and free all resources that the backend
12075 have reserved.  All buffers that have been created by that backend
12076 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
12077 function is generally only called when Gnus is shutting down.
12078
12079 There should be no data returned. 
12080
12081
12082 @item (nnchoke-server-opened &optional SERVER)
12083
12084 If @var{server} is the current virtual server, and the connection to the
12085 physical server is alive, then this function should return a
12086 non-@code{nil} vlue.  This function should under no circumstances
12087 attempt to reconnect to a server that is has lost connection to.
12088
12089 There should be no data returned.
12090
12091
12092 @item (nnchoke-status-message &optional SERVER)
12093
12094 This function should return the last error message from @var{server}. 
12095
12096 There should be no data returned.
12097
12098
12099 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
12100
12101 The result data from this function should be the article specified by
12102 @var{article}.  This might either be a @code{Message-ID} or a number.
12103 It is optional whether to implement retrieval by @code{Message-ID}, but
12104 it would be nice if that were possible.
12105
12106 If @var{to-buffer} is non-@code{nil}, the result data should be returned
12107 in this buffer instead of the normal data buffer.  This is to make it
12108 possible to avoid copying large amounts of data from one buffer to
12109 another, and Gnus mainly request articles to be inserted directly into
12110 its article buffer.
12111
12112 If it is at all possible, this function should return a cons cell where
12113 the car is the group name the article was fetched from, and the cdr is
12114 the article number.  This will enable Gnus to find out what the real
12115 group and article numbers are when fetching articles by
12116 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
12117 on successful article retrievement.
12118
12119
12120 @item (nnchoke-open-group GROUP &optional SERVER)
12121
12122 Make @var{group} the current group.  
12123
12124 There should be no data returned by this function.
12125
12126
12127 @item (nnchoke-request-group GROUP &optional SERVER)
12128
12129 Get data on @var{group}.  This function also has the side effect of
12130 making @var{group} the current group. 
12131
12132 Here's an example of some result data and a definition of the same:
12133
12134 @example
12135 211 56 1000 1059 ifi.discussion
12136 @end example
12137
12138 The first number is the status, which should be @code{211}.  Next is the
12139 total number of articles in the group, the lowest article number, the
12140 highest article number, and finally the group name.  Note that the total
12141 number of articles may be less than one might think while just
12142 considering the highest and lowest article numbers, but some articles
12143 may have been canceled.  Gnus just discards the total-number, so
12144 whether one should take the bother to generate it properly (if that is a
12145 problem) is left as an exercise to the reader.
12146
12147 @example
12148 group-status = [ error / info ] eol
12149 error        = [ "4" / "5" ] 2<number> " " <Error message>
12150 info         = "211 " 3* [ <number> " " ] <string>
12151 @end example
12152
12153
12154 @item (nnchoke-close-group GROUP &optional SERVER)
12155
12156 Close @var{group} and free any resources connected to it.  This will be
12157 a no-op on most backends. 
12158
12159 There should be no data returned.
12160
12161
12162 @item (nnchoke-request-list &optional SERVER)
12163
12164 Return a list of all groups available on @var{server}.  And that means
12165 @emph{all}. 
12166
12167 Here's an example from a server that only carries two groups:
12168
12169 @example
12170 ifi.test 0000002200 0000002000 y
12171 ifi.discussion 3324 3300 n
12172 @end example
12173
12174 On each line we have a group name, then the highest article number in
12175 that group, the lowest article number, and finally a flag.
12176
12177 @example
12178 active-file = *active-line
12179 active-line = name " " <number> " " <number> " " flags eol
12180 name        = <string>
12181 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
12182 @end example
12183
12184 The flag says whether the group is read-only (@samp{n}), is moderated
12185 (@samp{m}), is dead (@samp{x}), is aliased to some other group
12186 (@samp{=other-group} or none of the above (@samp{y}). 
12187
12188
12189 @item (nnchoke-request-post &optional SERVER)
12190
12191 This function should post the current buffer.  It might return whether
12192 the posting was successful or not, but that's not required.  If, for
12193 instance, the posting is done asynchronously, it has generally not been
12194 completed by the time this function concludes.  In that case, this
12195 function should set up some kind of sentinel to beep the user loud and
12196 clear if the posting could not be completed.
12197
12198 There should be no result data from this function. 
12199
12200 @end table
12201
12202
12203 @node Optional Backend Functions
12204 @subsubsection Optional Backend Functions
12205
12206 @table @code
12207
12208 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
12209
12210 @var{groups} is a list of groups, and this function should request data
12211 on all those groups.  How it does it is of no concern to Gnus, but it
12212 should attempt to do this in a speedy fashion.
12213
12214 The return value of this function can be either @code{active} or
12215 @code{group}, which says what the format of the result data is.  The
12216 former is in the same format as the data from
12217 @code{nnchoke-request-list}, while the latter is a buffer full of lines
12218 in the same format as @code{nnchoke-request-group} gives.
12219
12220 @example
12221 group-buffer = *active-line / *group-status
12222 @end example
12223
12224
12225 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
12226
12227 A Gnus group info (@pxref{Group Info}) is handed to the backend for
12228 alterations.  This comes in handy if the backend really carries all the
12229 information (as is the case with virtual an imap groups).  This function
12230 may alter the info in any manner it sees fit, and should return the
12231 (altered) group info.  This function may alter the group info
12232 destructively, so no copying is needed before boogeying. 
12233
12234 There should be no result data from this function.
12235
12236
12237 @item (nnchoke-request-type GROUP &optional ARTICLE)
12238
12239 When the user issues commands for ``sending news'' (@kbd{F} in the
12240 summary buffer, for instance), Gnus has to know whether the article the
12241 user is following up is news or mail.  This function should return
12242 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
12243 is mail and @code{unknown} if the type can't be decided.  (The
12244 @var{article} parameter is necessary in @code{nnvirtual} groups which
12245 might very well combine mail groups and news groups.)
12246
12247 There should be no result data from this function.
12248
12249
12250 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
12251
12252 If the user tries to set a mark that the backend doesn't like, this
12253 function may change the mark.  Gnus will use whatever this function
12254 returns as the mark for @var{article} instead of the original
12255 @var{mark}.  If the backend doesn't care, it must return the original
12256 @var{mark}, and not @code{nil} or any other type of garbage.  
12257
12258 The only use for this that I can see is what @code{nnvirtual} does with
12259 it---if a component group is auto-expirable, marking an article as read
12260 in the virtual group should result in the article being marked as
12261 expirable. 
12262
12263 There should be no result data from this function.
12264
12265
12266 @item (nnchoke-request-scan &optional GROUP SERVER)
12267
12268 This function may be called at any time (by Gnus or anything else) to
12269 request that the backend check for incoming articles, in one way or
12270 another.  A mail backend will typically read the spool file or query the
12271 POP server when this function is invoked.  The @var{group} doesn't have
12272 to be heeded---if the backend decides that it is too much work just
12273 scanning for a single group, it may do a total scan of all groups.  It
12274 would be nice, however, to keep things local if that's practical.
12275
12276 There should be no result data from this function.
12277
12278
12279 @item (nnchoke-request-asynchronous GROUP &optional SERVER ARTICLES)
12280
12281 This is a request to fetch articles asynchronously later.
12282 @var{articles} is an alist of @var{(article-number line-number)}.  One
12283 would generally expect that if one later fetches article number 4, for
12284 instance, some sort of asynchronous fetching of the articles after 4
12285 (which might be 5, 6, 7 or 11, 3, 909 depending on the order in that
12286 alist) would be fetched asynchronously, but that is left up to the
12287 backend.  Gnus doesn't care.
12288
12289 There should be no result data from this function.
12290  
12291
12292 @item (nnchoke-request-group-description GROUP &optional SERVER)
12293
12294 The result data from this function should be a description of
12295 @var{group}. 
12296
12297 @example
12298 description-line = name <TAB> description eol
12299 name             = <string>
12300 description      = <text>
12301 @end example
12302
12303 @item (nnchoke-request-list-newsgroups &optional SERVER)
12304
12305 The result data from this function should be the description of all
12306 groups available on the server.
12307
12308 @example
12309 description-buffer = *description-line
12310 @end example
12311
12312
12313 @item (nnchoke-request-newgroups DATE &optional SERVER)
12314
12315 The result data from this function should be all groups that were
12316 created after @samp{date}, which is in normal human-readable date
12317 format.  The data should be in the active buffer format.
12318
12319
12320 @item (nnchoke-request-create-group GROUP &optional SERVER)
12321
12322 This function should create an empty group with name @var{group}.  
12323
12324 There should be no return data.
12325
12326
12327 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
12328
12329 This function should run the expiry process on all articles in the
12330 @var{articles} range (which is currently a simple list of article
12331 numbers.)  It is left up to the backend to decide how old articles
12332 should be before they are removed by this function.  If @var{force} is
12333 non-@code{nil}, all @var{articles} should be deleted, no matter how new
12334 they are. 
12335
12336 This function should return a list of articles that it did not/was not
12337 able to delete.
12338
12339 There should be no result data returned.
12340
12341
12342 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
12343 &optional LAST)
12344
12345 This function should move @var{article} (which is a number) from
12346 @var{group} by calling @var{accept-form}.  
12347
12348 This function should ready the article in question for moving by
12349 removing any header lines it has added to the article, and generally
12350 should ``tidy up'' the article.  Then it should @code{eval}
12351 @var{accept-form} in the buffer where the ``tidy'' article is.  This
12352 will do the actual copying.  If this @code{eval} returns a
12353 non-@code{nil} value, the article should be removed.
12354
12355 If @var{last} is @code{nil}, that means that there is a high likelihood
12356 that there will be more requests issued shortly, so that allows some
12357 optimizations. 
12358
12359 The function should return a cons where the car is the group name and
12360 the cdr is the article number that the article was entered as.
12361
12362 There should be no data returned. 
12363
12364
12365 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
12366
12367 This function takes the current buffer and inserts it into @var{group}.
12368 If @var{last} in @code{nil}, that means that there will be more calls to
12369 this function in short order.
12370
12371 The function should return a cons where the car is the group name and
12372 the cdr is the article number that the article was entered as.
12373
12374 There should be no data returned.
12375
12376
12377 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
12378
12379 This function should remove @var{article} (which is a number) from
12380 @var{group} and insert @var{buffer} there instead.
12381
12382 There should be no data returned.
12383
12384
12385 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
12386
12387 This function should delete @var{group}.  If @var{force}, it should
12388 really delete all the articles in the group, and then delete the group
12389 itself.  (If there is such a thing as ``the group itself''.)
12390
12391 There should be no data returned.
12392
12393
12394 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
12395
12396 This function should rename @var{group} into @var{new-name}.  All
12397 articles that are in @var{group} should move to @var{new-name}.
12398
12399 There should be no data returned.
12400
12401 @end table
12402
12403
12404 @node Writing New Backends
12405 @subsubsection Writing New Backends
12406
12407 The various backends share many similarities.  @code{nnml} is just like
12408 @code{nnspool}, but it allows you to edit the articles on the server.
12409 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
12410 and it doesn't maintain overview databases.  @code{nndir} is just like
12411 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
12412 editing articles.
12413
12414 It would make sense if it were possible to ``inherit'' functions from
12415 backends when writing new backends.  And, indeed, you can do that if you
12416 want to.  (You don't have to if you don't want to, of course.)  
12417
12418 All the backends declare their public variables and functions by using a
12419 package called @code{nnoo}.  
12420
12421 To inherit functions from other backends (and allow other backends to
12422 inherit functions from the current backend), you should use the
12423 following macros:
12424 following. 
12425
12426 @table @code
12427
12428 @item nnoo-declare
12429 This macro declares the first parameter to be a child of the subsequent
12430 parameters.  For instance:
12431
12432 @lisp
12433 (nnoo-declare nndir
12434   nnml nnmh)
12435 @end lisp
12436
12437 @code{nndir} has here declared that it intends to inherit functions from
12438 both @code{nnml} and @code{nnmh}.
12439
12440 @item defvoo
12441 This macro is equivalent to @code{defvar}, but registers the variable as
12442 a public server variable.  Most state-oriented variables should be
12443 declared with @code{defvoo} instead of @code{defvar}.  
12444
12445 In addition to the normal @code{defvar} parameters, it takes a list of
12446 variables in the parent backends to map the variable to when executing
12447 a function in those backends.
12448
12449 @lisp
12450 (defvoo nndir-directory nil
12451   "Where nndir will look for groups."
12452   nnml-current-directory nnmh-current-directory)
12453 @end lisp
12454
12455 This means that @code{nnml-current-directory} will be set to
12456 @code{nndir-directory} when an @code{nnml} function is called on behalf
12457 of @code{nndir}.  (The same with @code{nnmh}.)  
12458
12459 @item nnoo-define-basics
12460 This macro defines some common functions that almost all backends should
12461 have.
12462
12463 @example
12464 (nnoo-define-basics nndir)
12465 @end example
12466
12467 @item deffoo
12468 This macro is just like @code{defun} and takes the same parameters.  In
12469 addition to doing the normal @code{defun} things, it registers the
12470 function as being public so that other backends can inherit it.
12471
12472 @item nnoo-map-functions
12473 This macro allows mapping of functions from the current backend to
12474 functions from the parent backends.
12475
12476 @example
12477 (nnoo-map-functions nndir
12478   (nnml-retrieve-headers 0 nndir-current-group 0 0)
12479   (nnmh-request-article 0 nndir-current-group 0 0))
12480 @end example
12481
12482 This means that when @code{nndir-retrieve-headers} is called, the first,
12483 third, and fourth parameters will be passed on to
12484 @code{nnml-retrieve-headers}, while the second parameter is set to the
12485 value of @code{nndir-current-group}.
12486
12487 @item nnoo-import
12488 This macro allows importing functions from backends.  It should be the
12489 last thing in the source file, since it will only define functions that
12490 haven't already been defined.
12491
12492 @example
12493 (nnoo-import nndir
12494   (nnmh
12495    nnmh-request-list
12496    nnmh-request-newgroups)
12497   (nnml))
12498 @end example
12499
12500 This means that calls to @code{nndir-request-list} should just be passed
12501 on to @code{nnmh-request-list}, while all public functions from
12502 @code{nnml} that haven't been defined in @code{nndir} yet should be
12503 defined now.
12504
12505 @end table
12506
12507 Below is a slightly shortened version of the @code{nndir} backend.
12508
12509 @lisp
12510 ;;; nndir.el --- single directory newsgroup access for Gnus
12511 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
12512
12513 ;;; Code:
12514
12515 (require 'nnheader)
12516 (require 'nnmh)
12517 (require 'nnml)
12518 (require 'nnoo)
12519 (eval-when-compile (require 'cl))
12520
12521 (nnoo-declare nndir
12522   nnml nnmh)
12523
12524 (defvoo nndir-directory nil
12525   "Where nndir will look for groups."
12526   nnml-current-directory nnmh-current-directory)
12527
12528 (defvoo nndir-nov-is-evil nil
12529   "*Non-nil means that nndir will never retrieve NOV headers."
12530   nnml-nov-is-evil)
12531
12532 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
12533 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
12534 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
12535
12536 (defvoo nndir-status-string "" nil nnmh-status-string)
12537 (defconst nndir-version "nndir 1.0")
12538
12539 ;;; Interface functions.
12540
12541 (nnoo-define-basics nndir)
12542
12543 (deffoo nndir-open-server (server &optional defs)
12544   (setq nndir-directory
12545         (or (cadr (assq 'nndir-directory defs))
12546             server))
12547   (unless (assq 'nndir-directory defs)
12548     (push `(nndir-directory ,server) defs))
12549   (push `(nndir-current-group
12550           ,(file-name-nondirectory (directory-file-name nndir-directory)))
12551         defs)
12552   (push `(nndir-top-directory
12553           ,(file-name-directory (directory-file-name nndir-directory)))
12554         defs)
12555   (nnoo-change-server 'nndir server defs))
12556
12557 (nnoo-map-functions nndir
12558   (nnml-retrieve-headers 0 nndir-current-group 0 0)
12559   (nnmh-request-article 0 nndir-current-group 0 0)
12560   (nnmh-request-group nndir-current-group 0 0)
12561   (nnmh-close-group nndir-current-group 0))
12562
12563 (nnoo-import nndir
12564   (nnmh
12565    nnmh-status-message
12566    nnmh-request-list
12567    nnmh-request-newgroups))
12568
12569 (provide 'nndir)
12570 @end lisp
12571
12572
12573
12574 @node Score File Syntax
12575 @subsection Score File Syntax
12576
12577 Score files are meant to be easily parsable, but yet extremely
12578 mallable.   It was decided that something that had the same read syntax
12579 as an Emacs Lisp list would fit that spec.
12580
12581 Here's a typical score file:
12582
12583 @lisp
12584 (("summary"
12585   ("win95" -10000 nil s)
12586   ("Gnus"))
12587  ("from"
12588   ("Lars" -1000))
12589  (mark -100))
12590 @end lisp
12591
12592 BNF definition of a score file:
12593
12594 @example
12595 score-file       = "" / "(" *element ")"
12596 element          = rule / atom
12597 rule             = string-rule / number-rule / date-rule
12598 string-rule      = "(" quote string-header quote space *string-match ")"
12599 number-rule      = "(" quote number-header quote space *number-match ")"
12600 date-rule        = "(" quote date-header quote space *date-match ")"
12601 quote            = <ascii 34>
12602 string-header    = "subject" / "from" / "references" / "message-id" / 
12603                    "xref" / "body" / "head" / "all" / "followup"
12604 number-header    = "lines" / "chars"
12605 date-header      = "date"
12606 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
12607                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
12608 score            = "nil" / <integer>
12609 date             = "nil" / <natural number>
12610 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
12611                    "r" / "regex" / "R" / "Regex" /
12612                    "e" / "exact" / "E" / "Exact" /
12613                    "f" / "fuzzy" / "F" / "Fuzzy"
12614 number-match     = "(" <integer> [ "" / [ space score [ "" / 
12615                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
12616 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
12617 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
12618                    space date [ "" / [ space date-match-t ] ] ] ] ")"
12619 date-match-t     = "nil" / "at" / "before" / "after"
12620 atom             = "(" [ required-atom / optional-atom ] ")"
12621 required-atom    = mark / expunge / mark-and-expunge / files /
12622                    exclude-files / read-only / touched
12623 optional-atom    = adapt / local / eval 
12624 mark             = "mark" space nil-or-number
12625 nil-or-number    = "nil" / <integer>
12626 expunge          = "expunge" space nil-or-number
12627 mark-and-expunge = "mark-and-expunge" space nil-or-number
12628 files            = "files" *[ space <string> ]
12629 exclude-files    = "exclude-files" *[ space <string> ]
12630 read-only        = "read-only" [ space "nil" / space "t" ]
12631 adapt            = "adapt" [ space "nil" / space "t" / space adapt-rule ]
12632 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
12633 local            = "local" *[ space "(" <string> space <form> ")" ]
12634 eval             = "eval" space <form>
12635 space            = *[ " " / <TAB> / <NEWLINE> ]
12636 @end example
12637
12638 Any unrecognized elements in a score file should be ignored, but not
12639 discarded.  
12640
12641 As you can see, white space is needed, but the type and amount of white
12642 space is irrelevant.  This means that formatting of the score file is
12643 left up to the programmer---if it's simpler to just spew it all out on
12644 one looong line, then that's ok.
12645
12646 The meaning of the various atoms are explained elsewhere in this
12647 manual. 
12648
12649
12650 @node Headers
12651 @subsection Headers
12652
12653 Gnus uses internally a format for storing article headers that
12654 corresponds to the @sc{nov} format in a mysterious fashion.  One could
12655 almost suspect that the author looked at the @sc{nov} specification and
12656 just shamelessly @emph{stole} the entire thing, and one would be right.
12657
12658 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
12659 RFC1036 to talk about lines in the head of an article (eg.,
12660 @code{From}).  It is used by many people as a synonym for
12661 ``head''---``the header and the body''.  (That should be avoided, in my
12662 opinion.)  And Gnus uses a format internally that it calls ``header'',
12663 which is what I'm talking about here.  This is a 9-element vector,
12664 basically, with each header (ouch) having one slot.
12665
12666 These slots are, in order: @code{number}, @code{subject}, @code{from},
12667 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
12668 @code{xref}.  There are macros for accessing and setting these slots --
12669 they all have predictable names beginning with @code{mail-header-} and
12670 @code{mail-header-set-}, respectively.  
12671
12672 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
12673 be put in there.
12674
12675
12676 @node Ranges
12677 @subsection Ranges
12678
12679 @sc{gnus} introduced a concept that I found so useful that I've started
12680 using it a lot and have elaborated on it greatly. 
12681
12682 The question is simple: If you have a large amount of objects that are
12683 identified by numbers (say, articles, to take a @emph{wild} example)
12684 that you want to callify as being ``included'', a normal sequence isn't
12685 very useful.  (A 200,000 length sequence is a bit long-winded.)
12686
12687 The solution is as simple as the question: You just collapse the
12688 sequence. 
12689
12690 @example
12691 (1 2 3 4 5 6 10 11 12)
12692 @end example
12693
12694 is transformed into
12695
12696 @example
12697 ((1 . 6) (10 . 12))
12698 @end example
12699
12700 To avoid having those nasty @samp{(13 . 13)} elements to denote a
12701 lonesome object, a @samp{13} is a valid element:
12702
12703 @example
12704 ((1 . 6) 7 (10 . 12))
12705 @end example
12706
12707 This means that comparing two ranges to find out whether they are equal
12708 is slightly tricky:
12709
12710 @example
12711 ((1 . 5) 7 8 (10 . 12))
12712 @end example
12713
12714 and
12715
12716 @example
12717 ((1 . 5) (7 . 8) (10 . 12))
12718 @end example
12719
12720 are equal.  In fact, any non-descending list is a range:
12721
12722 @example
12723 (1 2 3 4 5)
12724 @end example
12725
12726 is a perfectly valid range, although a pretty long-winded one.  This is
12727 also legal:
12728
12729 @example
12730 (1 . 5)
12731 @end example
12732
12733 and is equal to the previous range.
12734
12735 Here's a BNF definition of ranges.  Of course, one must remember the
12736 semantic requirement that the numbers are non-descending.  (Any number
12737 of repetition of the same number is allowed, but apt to disappear in
12738 range handling.)
12739
12740 @example
12741 range           = simple-range / normal-range
12742 simple-range    = "(" number " . " number ")"
12743 normal-range    = "(" start-contents ")"
12744 contents        = "" / simple-range *[ " " contents ] / 
12745                   number *[ " " contents ]
12746 @end example
12747
12748 Gnus currently uses ranges to keep track of read articles and article
12749 marks.  I plan on implementing a number of range operators in C if The
12750 Powers That Be are willing to let me.  (I haven't asked yet, because I
12751 need to do some more thinking on what operators I need to make life
12752 totally range-based without ever having to convert back to normal
12753 sequences.) 
12754
12755
12756 @node Group Info
12757 @subsection Group Info
12758
12759 Gnus stores all permanent info on groups in a @dfn{group info} list.
12760 This list is from three to six elements (or more) long and exhaustively
12761 describes the group.
12762
12763 Here are two example group infos; one is a very simple group while the
12764 second is a more complex one:
12765
12766 @example
12767 ("no.group" 5 (1 . 54324))
12768
12769 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
12770                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
12771                 (nnml "")
12772                 (auto-expire (to-address "ding@@ifi.uio.no")))
12773 @end example
12774
12775 The first element is the group name as Gnus knows the group; the second
12776 is the group level; the third is the read articles in range format; the
12777 fourth is a list of article marks lists; the fifth is the select method;
12778 and the sixth contains the group parameters.
12779
12780 Here's a BNF definition of the group info format:
12781
12782 @example
12783 info          = "(" group space level space read 
12784                 [ "" / [ space marks-list [ "" / [ space method [ "" /
12785                 space parameters ] ] ] ] ] ")" 
12786 group         = quote <string> quote
12787 level         = <integer in the range of 1 to inf>
12788 read          = range
12789 marks-lists   = nil / "(" *marks ")"
12790 marks         = "(" <string> range ")"
12791 method        = "(" <string> *elisp-forms ")"
12792 parameters    = "(" *elisp-forms ")"
12793 @end example
12794
12795 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
12796 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
12797 in pseudo-BNF.
12798
12799
12800 @node Emacs/XEmacs Code
12801 @subsection Emacs/XEmacs Code
12802 @cindex XEmacs
12803 @cindex Emacsen
12804
12805 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
12806 platforms must be the primary one.  I chose Emacs.  Not because I don't
12807 like XEmacs or Mule, but because it comes first alphabetically.
12808
12809 This means that Gnus will byte-compile under Emacs with nary a warning,
12810 while XEmacs will pump out gigabytes of warnings while byte-compiling.
12811 As I use byte-compilation warnings to help me root out trivial errors in
12812 Gnus, that's very useful.  
12813
12814 I've also consistently used Emacs function interfaces, but have used
12815 Gnusey aliases for the functions.  To take an example:  Emacs defines a
12816 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
12817 function.  I then define a function called @code{gnus-run-at-time} that
12818 takes the same parameters as the Emacs @code{run-at-time}.  When running
12819 Gnus under Emacs, the former function is just an alias for the latter.
12820 However, when running under XEmacs, the former is an alias for the
12821 following function:
12822
12823 @lisp
12824 (defun gnus-xmas-run-at-time (time repeat function &rest args)
12825   (start-itimer
12826    "gnus-run-at-time"
12827    `(lambda ()
12828       (,function ,@@args))
12829    time repeat))
12830 @end lisp
12831
12832 This sort of thing has been done for bunches of functions.  Gnus does
12833 not redefine any native Emacs functions while running under XEmacs -- it
12834 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
12835 all over.
12836
12837 Of course, I could have chosen XEmacs as my native platform and done
12838 mapping functions the other way around.  But I didn't.  The performance
12839 hit these indirections impose on Gnus under XEmacs should be slight.
12840
12841
12842 @node Various File Formats
12843 @subsection Various File Formats
12844
12845 @menu
12846 * Active File Format::      Information on articles and groups available.
12847 * Newsgroups File Format::  Group descriptions.
12848 @end menu
12849
12850
12851 @node Active File Format
12852 @subsubsection Active File Format
12853
12854 The active file lists all groups that are available on the server in
12855 question.  It also lists the highest and lowest current article numbers
12856 in each group.  
12857
12858 Here's an excerpt from a typical active file:
12859
12860 @example
12861 soc.motss 296030 293865 y
12862 alt.binaries.pictures.fractals 3922 3913 n
12863 comp.sources.unix 1605 1593 m
12864 comp.binaries.ibm.pc 5097 5089 y
12865 no.general 1000 900 y
12866 @end example
12867
12868 Here's a pseudo-BNF definition of this file:
12869
12870 @example
12871 active      = *group-line
12872 group-line  = group space high-number space low-number space flag <NEWLINE>
12873 group       = <non-white-space string>
12874 space       = " "
12875 high-number = <non-negative integer>
12876 low-number  = <positive integer>
12877 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
12878 @end example
12879
12880
12881 @node Newsgroups File Format
12882 @subsubsection Newsgroups File Format
12883
12884 The newsgroups file lists groups along with their descriptions.  Not all
12885 groups on the server have to be listed,  and not all groups in the file
12886 have to exist on the server.  The file is meant purely as information to
12887 the user.
12888
12889 The format is quite simple; a group name, a tab, and the description.
12890 Here's the definition:
12891
12892 @example
12893 newsgroups    = *line
12894 line          = group tab description <NEWLINE>
12895 group         = <non-white-space string>
12896 tab           = <TAB>
12897 description   = <string>
12898 @end example
12899
12900
12901 @node Emacs for Heathens
12902 @section Emacs for Heathens
12903
12904 Believe it or not, but some people who use Gnus haven't really used
12905 Emacs much before they embarked on their journey on the Gnus Love Boat.
12906 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
12907 region'', and ``set @code{gnus-flargblossen} to an alist where the key
12908 is a regexp that is used for matching on the group name'' are magical
12909 phrases with little or no meaning, then this appendix is for you.  If
12910 you are already familiar with Emacs, just ignore this and go fondle your
12911 cat instead.
12912
12913 @menu
12914 * Keystrokes::      Entering text and executing commands.
12915 * Emacs Lisp::      The built-in Emacs programming language.
12916 @end menu
12917
12918
12919 @node Keystrokes
12920 @subsection Keystrokes
12921
12922 @itemize @bullet
12923 @item
12924 Q: What is an experienced Emacs user?
12925
12926 @item 
12927 A: A person who wishes that the terminal had pedals.
12928 @end itemize
12929
12930 Yes, when you use Emacs, you are apt to use the control key, the shift
12931 key and the meta key a lot.  This is very annoying to some people
12932 (notably @code{vi}le users), and the rest of us just love the hell out
12933 of it.  Just give up and submit.  Emacs really does stand for
12934 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
12935 may have heard from other disreputable sources (like the Emacs author).
12936
12937 The shift key is normally located near your pinky fingers, and are
12938 normally used to get capital letters and stuff.  You probably use it all
12939 the time.  The control key is normally marked ``CTRL'' or something like
12940 that.  The meta key is, funnily enough, never marked as such on any
12941 keyboards.  The one I'm currently at has a key that's marked ``Alt'',
12942 which is the meta key on this keyboard.  It's usually located somewhere
12943 to the left hand side of the keyboard, usually on the bottom row.
12944
12945 Now, us Emacs people doesn't say ``press the meta-control-m key'',
12946 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
12947 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
12948 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
12949 down the control key, and hold it down while you press @kbd{k}''.
12950 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
12951 the control key and then press @kbd{k}''.  Simple, ay?
12952
12953 This is somewhat complicated by the fact that not all keyboards have a
12954 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
12955 means ``press escape, release escape, press @kbd{k}''.  That's much more
12956 work than if you have a meta key, so if that's the case, I respectfully
12957 suggest you get a real keyboard with a meta key.  You can't live without
12958 it.
12959
12960
12961
12962 @node Emacs Lisp
12963 @subsection Emacs Lisp
12964
12965 Emacs is the King of Editors because it's really a Lisp interpreter.
12966 Each and every key you tap runs some Emacs Lisp code snippet, and since
12967 Emacs Lisp is an interpreted language, that means that you can configure
12968 any key to run any arbitrary code.  You just, like, do it.
12969
12970 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
12971 functions.  (These are byte-compiled for speed, but it's still
12972 interpreted.)  If you decide that you don't like the way Gnus does
12973 certain things, it's trivial to have it do something a different way.
12974 (Well, at least if you know how to write Lisp code.)  However, that's
12975 beyond the scope of this manual, so we are simply going to talk about
12976 some common constructs that you normally use in your @file{.emacs} file
12977 to customize Gnus.
12978
12979 If you want to set the variable @code{gnus-florgbnize} to four (4), you
12980 write the following:
12981
12982 @lisp
12983 (setq gnus-florgbnize 4)
12984 @end lisp
12985
12986 This function (really ``special form'') @code{setq} is the one that can
12987 set a variable to some value.  This is really all you need to know.  Now
12988 you can go and fill your @code{.emacs} file with lots of these to change
12989 how Gnus works.
12990
12991 If you have put that thing in your @code{.emacs} file, it will be read
12992 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
12993 start Emacs.  If you want to change the variable right away, simply say
12994 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
12995 previous ``form'', which here is a simple @code{setq} statement.
12996
12997 Go ahead---just try it, if you're located at your Emacs.  After you
12998 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
12999 is the return value of the form you @code{eval}ed.
13000
13001 Some pitfalls:
13002
13003 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
13004 that means:
13005
13006 @lisp
13007 (setq gnus-read-active-file 'some)
13008 @end lisp
13009
13010 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
13011 @samp{nntp.ifi.uio.no}'', that means:
13012
13013 @lisp
13014 (setq gnus-nntp-server "nntp.ifi.uio.no")
13015 @end lisp
13016
13017 So be careful not to mix up strings (the latter) with symbols (the
13018 former).  The manual is unambiguous, but it can be confusing.
13019
13020
13021 @include gnus-faq.texi
13022
13023 @node Index
13024 @chapter Index
13025 @printindex cp
13026
13027 @node Key Index
13028 @chapter Key Index
13029 @printindex ky
13030
13031 @summarycontents
13032 @contents
13033 @bye
13034
13035 @iftex
13036 @iflatex
13037 \end{document}
13038 @end iflatex
13039 @end iftex
13040
13041 @c End:
13042