*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Gnus 5.6.25 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @c @direntry
9 @c * Gnus: (gnus).         The news reader Gnus.
10 @c @end direntry
11 @iftex
12 @finalout
13 @end iftex
14 @setchapternewpage odd
15
16 @iftex
17 @iflatex
18 \documentclass[twoside,a4paper,openright,11pt]{book}
19 \usepackage[latin1]{inputenc}
20 \usepackage{pagestyle}
21 \usepackage{epsfig}
22 \usepackage{bembo}
23 \usepackage{pixidx}
24
25 \makeindex
26 \begin{document}
27
28 \newcommand{\gnuschaptername}{}
29 \newcommand{\gnussectionname}{}
30
31 \newcommand{\gnusbackslash}{/}
32
33 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
34 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
35
36 \newcommand{\gnuskindex}[1]{\index{#1}}
37 \newcommand{\gnusindex}[1]{\index{#1}}
38
39 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
40 \newcommand{\gnuscode}[1]{\gnustt{#1}}
41 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
42 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
43 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusdfn}[1]{\textit{#1}}
46 \newcommand{\gnusi}[1]{\textit{#1}}
47 \newcommand{\gnusstrong}[1]{\textbf{#1}}
48 \newcommand{\gnusemph}[1]{\textit{#1}}
49 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
50 \newcommand{\gnussc}[1]{\textsc{#1}}
51 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
52 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
53
54 \newcommand{\gnusbullet}{{${\bullet}$}}
55 \newcommand{\gnusdollar}{\$}
56 \newcommand{\gnusampersand}{\&}
57 \newcommand{\gnuspercent}{\%}
58 \newcommand{\gnushash}{\#}
59 \newcommand{\gnushat}{\symbol{"5E}}
60 \newcommand{\gnusunderline}{\symbol{"5F}}
61 \newcommand{\gnusnot}{$\neg$}
62 \newcommand{\gnustilde}{\symbol{"7E}}
63 \newcommand{\gnusless}{{$<$}}
64 \newcommand{\gnusgreater}{{$>$}}
65
66 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
67 \newcommand{\gnusinteresting}{
68 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
69 }
70
71 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
72
73 \newcommand{\gnuspagechapter}[1]{
74 {\mbox{}}
75 }
76
77 \newdimen{\gnusdimen}
78 \gnusdimen 0pt
79
80 \newcommand{\gnuschapter}[2]{
81 \gnuscleardoublepage
82 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
83 \chapter{#2}
84 \renewcommand{\gnussectionname}{}
85 \renewcommand{\gnuschaptername}{#2}
86 \thispagestyle{empty}
87 \hspace*{-2cm}
88 \begin{picture}(500,500)(0,0)
89 \put(480,350){\makebox(0,0)[tr]{#1}}
90 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
91 \end{picture}
92 \clearpage
93 }
94
95 \newcommand{\gnusfigure}[3]{
96 \begin{figure}
97 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
98 #3
99 \end{picture}
100 \caption{#1}
101 \end{figure}
102 }
103
104 \newcommand{\gnusicon}[1]{
105 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
106 }
107
108 \newcommand{\gnuspicon}[1]{
109 \margindex{\epsfig{figure=#1,width=2cm}}
110 }
111
112 \newcommand{\gnusxface}[2]{
113 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
114 }
115
116 \newcommand{\gnussmiley}[2]{
117 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
118 }
119
120 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
121
122 \newcommand{\gnussection}[1]{
123 \renewcommand{\gnussectionname}{#1}
124 \section{#1}
125 }
126
127 \newenvironment{codelist}%
128 {\begin{list}{}{
129 }
130 }{\end{list}}
131
132 \newenvironment{kbdlist}%
133 {\begin{list}{}{
134 \labelwidth=0cm
135 }
136 }{\end{list}}
137
138 \newenvironment{dfnlist}%
139 {\begin{list}{}{
140 }
141 }{\end{list}}
142
143 \newenvironment{stronglist}%
144 {\begin{list}{}{
145 }
146 }{\end{list}}
147
148 \newenvironment{samplist}%
149 {\begin{list}{}{
150 }
151 }{\end{list}}
152
153 \newenvironment{varlist}%
154 {\begin{list}{}{
155 }
156 }{\end{list}}
157
158 \newenvironment{emphlist}%
159 {\begin{list}{}{
160 }
161 }{\end{list}}
162
163 \newlength\gnusheadtextwidth
164 \setlength{\gnusheadtextwidth}{\headtextwidth}
165 \addtolength{\gnusheadtextwidth}{1cm}
166
167 \newpagestyle{gnuspreamble}%
168 {
169 {
170 \ifodd\count0
171 {
172 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
173 }
174 \else
175 {
176 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
177 }
178 }
179 \fi
180 }
181 }
182 {
183 \ifodd\count0
184 \mbox{} \hfill
185 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
186 \else
187 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
188 \hfill \mbox{}
189 \fi
190 }
191
192 \newpagestyle{gnusindex}%
193 {
194 {
195 \ifodd\count0
196 {
197 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
198 }
199 \else
200 {
201 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
202 }
203 \fi
204 }
205 }
206 {
207 \ifodd\count0
208 \mbox{} \hfill
209 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
210 \else
211 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
212 \hfill \mbox{}
213 \fi
214 }
215
216 \newpagestyle{gnus}%
217 {
218 {
219 \ifodd\count0
220 {
221 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
222 }
223 \else
224 {
225 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
226 }
227 \fi
228 }
229 }
230 {
231 \ifodd\count0
232 \mbox{} \hfill
233 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
234 \else
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
236 \hfill \mbox{}
237 \fi
238 }
239
240 \pagenumbering{roman}
241 \pagestyle{gnuspreamble}
242
243 @end iflatex
244 @end iftex
245
246 @iftex
247 @iflatex
248 \begin{titlepage}
249 {
250
251 %\addtolength{\oddsidemargin}{-5cm}
252 %\addtolength{\evensidemargin}{-5cm}
253 \parindent=0cm
254 \addtolength{\textheight}{2cm}
255
256 \gnustitle{\gnustitlename}\\
257 \rule{15cm}{1mm}\\
258 \vfill
259 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
260 \vfill
261 \rule{15cm}{1mm}\\
262 \gnusauthor{by Lars Magne Ingebrigtsen}
263 \newpage
264 }
265
266 \mbox{}
267 \vfill
268
269 \thispagestyle{empty}
270
271 Copyright \copyright{} 1995,96,97 Free Software Foundation, Inc.
272
273 Permission is granted to make and distribute verbatim copies of
274 this manual provided the copyright notice and this permission notice
275 are preserved on all copies.
276
277 Permission is granted to copy and distribute modified versions of this
278 manual under the conditions for verbatim copying, provided that the
279 entire resulting derived work is distributed under the terms of a
280 permission notice identical to this one.
281
282 Permission is granted to copy and distribute translations of this manual
283 into another language, under the above conditions for modified versions.
284
285 \newpage
286 \end{titlepage}
287 @end iflatex
288 @end iftex
289
290 @ifinfo
291
292 This file documents Gnus, the GNU Emacs newsreader.
293
294 Copyright (C) 1995,96 Free Software Foundation, Inc.
295
296 Permission is granted to make and distribute verbatim copies of
297 this manual provided the copyright notice and this permission notice
298 are preserved on all copies.
299
300 @ignore
301 Permission is granted to process this file through Tex and print the
302 results, provided the printed document carries copying permission
303 notice identical to this one except for the removal of this paragraph
304 (this paragraph not being relevant to the printed manual).
305
306 @end ignore
307 Permission is granted to copy and distribute modified versions of this
308 manual under the conditions for verbatim copying, provided also that the
309 entire resulting derived work is distributed under the terms of a
310 permission notice identical to this one.
311
312 Permission is granted to copy and distribute translations of this manual
313 into another language, under the above conditions for modified versions.
314 @end ifinfo
315
316 @tex
317
318 @titlepage
319 @title Gnus 5.6.25 Manual
320
321 @author by Lars Magne Ingebrigtsen
322 @page
323
324 @vskip 0pt plus 1filll
325 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc.
326
327 Permission is granted to make and distribute verbatim copies of
328 this manual provided the copyright notice and this permission notice
329 are preserved on all copies.
330
331 Permission is granted to copy and distribute modified versions of this
332 manual under the conditions for verbatim copying, provided that the
333 entire resulting derived work is distributed under the terms of a
334 permission notice identical to this one.
335
336 Permission is granted to copy and distribute translations of this manual
337 into another language, under the above conditions for modified versions.
338
339 @end titlepage
340 @page
341
342 @end tex
343
344
345 @node Top
346 @top The Gnus Newsreader
347
348 @ifinfo
349
350 You can read news (and mail) from within Emacs by using Gnus.  The news
351 can be gotten by any nefarious means you can think of---@sc{nntp}, local
352 spool or your mbox file.  All at the same time, if you want to push your
353 luck.
354
355 This manual corresponds to Gnus 5.6.25.
356
357 @end ifinfo
358
359 @iftex
360
361 @iflatex
362 \tableofcontents
363 \gnuscleardoublepage
364 @end iflatex
365
366 Gnus is the advanced, self-documenting, customizable, extensible
367 unreal-time newsreader for GNU Emacs.
368
369 Oops.  That sounds oddly familiar, so let's start over again to avoid
370 being accused of plagiarism:
371
372 Gnus is a message-reading laboratory.  It will let you look at just
373 about anything as if it were a newsgroup.  You can read mail with it,
374 you can browse directories with it, you can @code{ftp} with it---you can
375 even read news with it!
376
377 Gnus tries to empower people who read news the same way Emacs empowers
378 people who edit text.  Gnus sets no limits to what the user should be
379 allowed to do.  Users are encouraged to extend Gnus to make it behave
380 like they want it to behave.  A program should not control people;
381 people should be empowered to do what they want by using (or abusing)
382 the program.
383
384 @end iftex
385
386
387 @menu
388 * Starting Up::           Finding news can be a pain.
389 * The Group Buffer::      Selecting, subscribing and killing groups.
390 * The Summary Buffer::    Reading, saving and posting articles.
391 * The Article Buffer::    Displaying and handling articles.
392 * Composing Messages::    Information on sending mail and news.
393 * Select Methods::        Gnus reads all messages from various select methods.
394 * Scoring::               Assigning values to articles.
395 * Various::               General purpose settings.
396 * The End::               Farewell and goodbye.
397 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
398 * Index::                 Variable, function and concept index.
399 * Key Index::             Key Index.
400 @end menu
401
402 @node Starting Up
403 @chapter Starting Gnus
404 @cindex starting up
405
406 @kindex M-x gnus
407 @findex gnus
408 If your system administrator has set things up properly, starting Gnus
409 and reading news is extremely easy---you just type @kbd{M-x gnus} in
410 your Emacs.
411
412 @findex gnus-other-frame
413 @kindex M-x gnus-other-frame
414 If you want to start Gnus in a different frame, you can use the command
415 @kbd{M-x gnus-other-frame} instead.
416
417 If things do not go smoothly at startup, you have to twiddle some
418 variables in your @file{~/.gnus} file.  This file is similar to
419 @file{~/.emacs}, but is read when gnus starts.
420
421 If you puzzle at any terms used in this manual, please refer to the
422 terminology section (@pxref{Terminology}).
423
424 @menu
425 * Finding the News::    Choosing a method for getting news.
426 * The First Time::      What does Gnus do the first time you start it?
427 * The Server is Down::  How can I read my mail then?
428 * Slave Gnusae::        You can have more than one Gnus active at a time.
429 * Fetching a Group::    Starting Gnus just to read a group.
430 * New Groups::          What is Gnus supposed to do with new groups?
431 * Startup Files::       Those pesky startup files---@file{.newsrc}.
432 * Auto Save::           Recovering from a crash.
433 * The Active File::     Reading the active file over a slow line Takes Time.
434 * Changing Servers::    You may want to move from one server to another.
435 * Startup Variables::   Other variables you might change.
436 @end menu
437
438
439 @node Finding the News
440 @section Finding the News
441 @cindex finding news
442
443 @vindex gnus-select-method
444 @c @head
445 The @code{gnus-select-method} variable says where Gnus should look for
446 news.  This variable should be a list where the first element says
447 @dfn{how} and the second element says @dfn{where}.  This method is your
448 native method.  All groups not fetched with this method are
449 foreign groups.
450
451 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
452 you want to get your daily dosage of news from, you'd say:
453
454 @lisp
455 (setq gnus-select-method '(nntp "news.somewhere.edu"))
456 @end lisp
457
458 If you want to read directly from the local spool, say:
459
460 @lisp
461 (setq gnus-select-method '(nnspool ""))
462 @end lisp
463
464 If you can use a local spool, you probably should, as it will almost
465 certainly be much faster.
466
467 @vindex gnus-nntpserver-file
468 @cindex NNTPSERVER
469 @cindex @sc{nntp} server
470 If this variable is not set, Gnus will take a look at the
471 @code{NNTPSERVER} environment variable.  If that variable isn't set,
472 Gnus will see whether @code{gnus-nntpserver-file}
473 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
474 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
475
476 @vindex gnus-nntp-server
477 If @code{gnus-nntp-server} is set, this variable will override
478 @code{gnus-select-method}.  You should therefore set
479 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
480
481 @vindex gnus-secondary-servers
482 You can also make Gnus prompt you interactively for the name of an
483 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
484 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
485 in the @code{gnus-secondary-servers} list (if any).  You can also just
486 type in the name of any server you feel like visiting.
487
488 @findex gnus-group-browse-foreign-server
489 @kindex B (Group)
490 However, if you use one @sc{nntp} server regularly and are just
491 interested in a couple of groups from a different server, you would be
492 better served by using the @kbd{B} command in the group buffer.  It will
493 let you have a look at what groups are available, and you can subscribe
494 to any of the groups you want to.  This also makes @file{.newsrc}
495 maintenance much tidier.  @xref{Foreign Groups}.
496
497 @vindex gnus-secondary-select-methods
498 @c @head
499 A slightly different approach to foreign groups is to set the
500 @code{gnus-secondary-select-methods} variable.  The select methods
501 listed in this variable are in many ways just as native as the
502 @code{gnus-select-method} server.  They will also be queried for active
503 files during startup (if that's required), and new newsgroups that
504 appear on these servers will be subscribed (or not) just as native
505 groups are.
506
507 For instance, if you use the @code{nnmbox} backend to read your mail, you
508 would typically set this variable to
509
510 @lisp
511 (setq gnus-secondary-select-methods '((nnmbox "")))
512 @end lisp
513
514
515 @node The First Time
516 @section The First Time
517 @cindex first time usage
518
519 If no startup files exist, Gnus will try to determine what groups should
520 be subscribed by default.
521
522 @vindex gnus-default-subscribed-newsgroups
523 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
524 will subscribe you to just those groups in that list, leaving the rest
525 killed.  Your system administrator should have set this variable to
526 something useful.
527
528 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
529 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
530 here as @dfn{whatever Lars thinks you should read}.)
531
532 You'll also be subscribed to the Gnus documentation group, which should
533 help you with most common problems.
534
535 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
536 use the normal functions for handling new groups, and not do anything
537 special.
538
539
540 @node The Server is Down
541 @section The Server is Down
542 @cindex server errors
543
544 If the default server is down, Gnus will understandably have some
545 problems starting.  However, if you have some mail groups in addition to
546 the news groups, you may want to start Gnus anyway.
547
548 Gnus, being the trusting sort of program, will ask whether to proceed
549 without a native select method if that server can't be contacted.  This
550 will happen whether the server doesn't actually exist (i.e., you have
551 given the wrong address) or the server has just momentarily taken ill
552 for some reason or other.  If you decide to continue and have no foreign
553 groups, you'll find it difficult to actually do anything in the group
554 buffer.  But, hey, that's your problem.  Blllrph!
555
556 @findex gnus-no-server
557 @kindex M-x gnus-no-server
558 @c @head
559 If you know that the server is definitely down, or you just want to read
560 your mail without bothering with the server at all, you can use the
561 @code{gnus-no-server} command to start Gnus.  That might come in handy
562 if you're in a hurry as well.  This command will not attempt to contact
563 your primary server---instead, it will just activate all groups on level
564 1 and 2.  (You should preferably keep no native groups on those two
565 levels.)
566
567
568 @node Slave Gnusae
569 @section Slave Gnusae
570 @cindex slave
571
572 You might want to run more than one Emacs with more than one Gnus at the
573 same time.  If you are using different @file{.newsrc} files (e.g., if you
574 are using the two different Gnusae to read from two different servers),
575 that is no problem whatsoever.  You just do it.
576
577 The problem appears when you want to run two Gnusae that use the same
578 @code{.newsrc} file.
579
580 To work around that problem some, we here at the Think-Tank at the Gnus
581 Towers have come up with a new concept: @dfn{Masters} and
582 @dfn{slaves}.  (We have applied for a patent on this concept, and have
583 taken out a copyright on those words.  If you wish to use those words in
584 conjunction with each other, you have to send $1 per usage instance to
585 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
586 Applications}) will be much more expensive, of course.)
587
588 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
589 however you do it).  Each subsequent slave Gnusae should be started with
590 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
591 files, but instead save @dfn{slave files} that contain information only
592 on what groups have been read in the slave session.  When a master Gnus
593 starts, it will read (and delete) these slave files, incorporating all
594 information from them.  (The slave files will be read in the sequence
595 they were created, so the latest changes will have precedence.)
596
597 Information from the slave files has, of course, precedence over the
598 information in the normal (i.e., master) @code{.newsrc} file.
599
600
601 @node Fetching a Group
602 @section Fetching a Group
603 @cindex fetching a group
604
605 @findex gnus-fetch-group
606 It is sometimes convenient to be able to just say ``I want to read this
607 group and I don't care whether Gnus has been started or not''.  This is
608 perhaps more useful for people who write code than for users, but the
609 command @code{gnus-fetch-group} provides this functionality in any case.
610 It takes the group name as a parameter.
611
612
613 @node New Groups
614 @section New Groups
615 @cindex new groups
616 @cindex subscription
617
618 @vindex gnus-check-new-newsgroups
619 If you are satisfied that you really never want to see any new groups,
620 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
621 also save you some time at startup.  Even if this variable is
622 @code{nil}, you can always subscribe to the new groups just by pressing
623 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
624 is @code{ask-server} by default.  If you set this variable to
625 @code{always}, then Gnus will query the backends for new groups even
626 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
627
628 @menu
629 * Checking New Groups::      Determining what groups are new.
630 * Subscription Methods::     What Gnus should do with new groups.
631 * Filtering New Groups::     Making Gnus ignore certain new groups.
632 @end menu
633
634
635 @node Checking New Groups
636 @subsection Checking New Groups
637
638 Gnus normally determines whether a group is new or not by comparing the
639 list of groups from the active file(s) with the lists of subscribed and
640 dead groups.  This isn't a particularly fast method.  If
641 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
642 server for new groups since the last time.  This is both faster and
643 cheaper.  This also means that you can get rid of the list of killed
644 groups altogether, so you may set @code{gnus-save-killed-list} to
645 @code{nil}, which will save time both at startup, at exit, and all over.
646 Saves disk space, too.  Why isn't this the default, then?
647 Unfortunately, not all servers support this command.
648
649 I bet I know what you're thinking now: How do I find out whether my
650 server supports @code{ask-server}?  No?  Good, because I don't have a
651 fail-safe answer.  I would suggest just setting this variable to
652 @code{ask-server} and see whether any new groups appear within the next
653 few days.  If any do, then it works.  If none do, then it doesn't
654 work.  I could write a function to make Gnus guess whether the server
655 supports @code{ask-server}, but it would just be a guess.  So I won't.
656 You could @code{telnet} to the server and say @code{HELP} and see
657 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
658 it does, then it might work.  (But there are servers that lists
659 @samp{NEWGROUPS} without supporting the function properly.)
660
661 This variable can also be a list of select methods.  If so, Gnus will
662 issue an @code{ask-server} command to each of the select methods, and
663 subscribe them (or not) using the normal methods.  This might be handy
664 if you are monitoring a few servers for new groups.  A side effect is
665 that startup will take much longer, so you can meditate while waiting.
666 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
667
668
669 @node Subscription Methods
670 @subsection Subscription Methods
671
672 @vindex gnus-subscribe-newsgroup-method
673 What Gnus does when it encounters a new group is determined by the
674 @code{gnus-subscribe-newsgroup-method} variable.
675
676 This variable should contain a function.  This function will be called
677 with the name of the new group as the only parameter.
678
679 Some handy pre-fab functions are:
680
681 @table @code
682
683 @item gnus-subscribe-zombies
684 @vindex gnus-subscribe-zombies
685 Make all new groups zombies.  This is the default.  You can browse the
686 zombies later (with @kbd{A z}) and either kill them all off properly
687 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
688
689 @item gnus-subscribe-randomly
690 @vindex gnus-subscribe-randomly
691 Subscribe all new groups in arbitrary order.  This really means that all
692 new groups will be added at ``the top'' of the group buffer.
693
694 @item gnus-subscribe-alphabetically
695 @vindex gnus-subscribe-alphabetically
696 Subscribe all new groups in alphabetical order.
697
698 @item gnus-subscribe-hierarchically
699 @vindex gnus-subscribe-hierarchically
700 Subscribe all new groups hierarchically.  The difference between this
701 function and @code{gnus-subscribe-alphabetically} is slight.
702 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
703 alphabetical fashion, while this function will enter groups into it's
704 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
705 @samp{comp} hierarchy, this function will not mess that configuration
706 up.  Or something like that.
707
708 @item gnus-subscribe-interactively
709 @vindex gnus-subscribe-interactively
710 Subscribe new groups interactively.  This means that Gnus will ask
711 you about @strong{all} new groups.  The groups you choose to subscribe
712 to will be subscribed hierarchically.
713
714 @item gnus-subscribe-killed
715 @vindex gnus-subscribe-killed
716 Kill all new groups.
717
718 @end table
719
720 @vindex gnus-subscribe-hierarchical-interactive
721 A closely related variable is
722 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
723 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
724 hierarchical fashion whether to subscribe to new groups or not.  Gnus
725 will ask you for each sub-hierarchy whether you want to descend the
726 hierarchy or not.
727
728 One common mistake is to set the variable a few paragraphs above
729 (@code{gnus-subscribe-newsgroup-method}) to
730 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
731 will not work.  This is ga-ga.  So don't do it.
732
733
734 @node Filtering New Groups
735 @subsection Filtering New Groups
736
737 A nice and portable way to control which new newsgroups should be
738 subscribed (or ignored) is to put an @dfn{options} line at the start of
739 the @file{.newsrc} file.  Here's an example:
740
741 @example
742 options -n !alt.all !rec.all sci.all
743 @end example
744
745 @vindex gnus-subscribe-options-newsgroup-method
746 This line obviously belongs to a serious-minded intellectual scientific
747 person (or she may just be plain old boring), because it says that all
748 groups that have names beginning with @samp{alt} and @samp{rec} should
749 be ignored, and all groups with names beginning with @samp{sci} should
750 be subscribed.  Gnus will not use the normal subscription method for
751 subscribing these groups.
752 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
753 variable defaults to @code{gnus-subscribe-alphabetically}.
754
755 @vindex gnus-options-not-subscribe
756 @vindex gnus-options-subscribe
757 If you don't want to mess with your @file{.newsrc} file, you can just
758 set the two variables @code{gnus-options-subscribe} and
759 @code{gnus-options-not-subscribe}.  These two variables do exactly the
760 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
761 and if the new group matches the former, it will be unconditionally
762 subscribed, and if it matches the latter, it will be ignored.
763
764 @vindex gnus-auto-subscribed-groups
765 Yet another variable that meddles here is
766 @code{gnus-auto-subscribed-groups}.  It works exactly like
767 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
768 thought it would be nice to have two of these.  This variable is more
769 meant for setting some ground rules, while the other variable is used
770 more for user fiddling.  By default this variable makes all new groups
771 that come from mail backends (@code{nnml}, @code{nnbabyl},
772 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
773 don't like that, just set this variable to @code{nil}.
774
775 New groups that match this regexp are subscribed using
776 @code{gnus-subscribe-options-newsgroup-method}.
777
778
779 @node Changing Servers
780 @section Changing Servers
781 @cindex changing servers
782
783 Sometimes it is necessary to move from one @sc{nntp} server to another.
784 This happens very rarely, but perhaps you change jobs, or one server is
785 very flaky and you want to use another.
786
787 Changing the server is pretty easy, right?  You just change
788 @code{gnus-select-method} to point to the new server?
789
790 @emph{Wrong!}
791
792 Article numbers are not (in any way) kept synchronized between different
793 @sc{nntp} servers, and the only way Gnus keeps track of what articles
794 you have read is by keeping track of article numbers.  So when you
795 change @code{gnus-select-method}, your @file{.newsrc} file becomes
796 worthless.
797
798 Gnus provides a few functions to attempt to translate a @file{.newsrc}
799 file from one server to another.  They all have one thing in
800 common---they take a looong time to run.  You don't want to use these
801 functions more than absolutely necessary.
802
803 @kindex M-x gnus-change-server
804 @findex gnus-change-server
805 If you have access to both servers, Gnus can request the headers for all
806 the articles you have read and compare @code{Message-ID}s and map the
807 article numbers of the read articles and article marks.  The @kbd{M-x
808 gnus-change-server} command will do this for all your native groups.  It
809 will prompt for the method you want to move to.
810
811 @kindex M-x gnus-group-move-group-to-server
812 @findex gnus-group-move-group-to-server
813 You can also move individual groups with the @kbd{M-x
814 gnus-group-move-group-to-server} command.  This is useful if you want to
815 move a (foreign) group from one server to another.
816
817 @kindex M-x gnus-group-clear-data-on-native-groups
818 @findex gnus-group-clear-data-on-native-groups
819 If you don't have access to both the old and new server, all your marks
820 and read ranges have become worthless.  You can use the @kbd{M-x
821 gnus-group-clear-data-on-native-groups} command to clear out all data
822 that you have on your native groups.  Use with caution.
823
824
825 @node Startup Files
826 @section Startup Files
827 @cindex startup files
828 @cindex .newsrc
829 @cindex .newsrc.el
830 @cindex .newsrc.eld
831
832 Now, you all know about the @file{.newsrc} file.  All subscription
833 information is traditionally stored in this file.
834
835 Things got a bit more complicated with @sc{gnus}.  In addition to
836 keeping the @file{.newsrc} file updated, it also used a file called
837 @file{.newsrc.el} for storing all the information that didn't fit into
838 the @file{.newsrc} file.  (Actually, it also duplicated everything in
839 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
840 files was the most recently saved, which enabled people to swap between
841 @sc{gnus} and other newsreaders.
842
843 That was kinda silly, so Gnus went one better: In addition to the
844 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
845 @file{.newsrc.eld}.  It will read whichever of these files that are most
846 recent, but it will never write a @file{.newsrc.el} file.  You should
847 never delete the @file{.newsrc.eld} file---it contains much information
848 not stored in the @file{.newsrc} file.
849
850 @vindex gnus-save-newsrc-file
851 You can turn off writing the @file{.newsrc} file by setting
852 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
853 the file and save some space, as well as exiting from Gnus faster.
854 However, this will make it impossible to use other newsreaders than
855 Gnus.  But hey, who would want to, right?
856
857 @vindex gnus-save-killed-list
858 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
859 will not save the list of killed groups to the startup file.  This will
860 save both time (when starting and quitting) and space (on disk).  It
861 will also mean that Gnus has no record of what groups are new or old,
862 so the automatic new groups subscription methods become meaningless.
863 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
864 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
865 Groups}).  This variable can also be a regular expression.  If that's
866 the case, remove all groups that do not match this regexp before
867 saving.  This can be useful in certain obscure situations that involve
868 several servers where not all servers support @code{ask-server}.
869
870 @vindex gnus-startup-file
871 The @code{gnus-startup-file} variable says where the startup files are.
872 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
873 file being whatever that one is, with a @samp{.eld} appended.
874
875 @vindex gnus-save-newsrc-hook
876 @vindex gnus-save-quick-newsrc-hook
877 @vindex gnus-save-standard-newsrc-hook
878 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
879 files, while @code{gnus-save-quick-newsrc-hook} is called just before
880 saving the @file{.newsrc.eld} file, and
881 @code{gnus-save-standard-newsrc-hook} is called just before saving the
882 @file{.newsrc} file.  The latter two are commonly used to turn version
883 control on or off.  Version control is on by default when saving the
884 startup files.  If you want to turn backup creation off, say something like:
885
886 @lisp
887 (defun turn-off-backup ()
888   (set (make-local-variable 'backup-inhibited) t))
889
890 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
891 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
892 @end lisp
893
894 @vindex gnus-init-file
895 When Gnus starts, it will read the @code{gnus-site-init-file}
896 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
897 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
898 and can be used to avoid cluttering your @file{~/.emacs} and
899 @file{site-init} files with Gnus stuff.  Gnus will also check for files
900 with the same names as these, but with @file{.elc} and @file{.el}
901 suffixes.  In other words, if you have set @code{gnus-init-file} to
902 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
903 and finally @file{~/.gnus} (in this order).
904
905
906
907 @node Auto Save
908 @section Auto Save
909 @cindex dribble file
910 @cindex auto-save
911
912 Whenever you do something that changes the Gnus data (reading articles,
913 catching up, killing/subscribing groups), the change is added to a
914 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
915 Emacs way.  If your Emacs should crash before you have saved the
916 @file{.newsrc} files, all changes you have made can be recovered from
917 this file.
918
919 If Gnus detects this file at startup, it will ask the user whether to
920 read it.  The auto save file is deleted whenever the real startup file is
921 saved.
922
923 @vindex gnus-use-dribble-file
924 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
925 maintain a dribble buffer.  The default is @code{t}.
926
927 @vindex gnus-dribble-directory
928 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
929 this variable is @code{nil}, which it is by default, Gnus will dribble
930 into the directory where the @file{.newsrc} file is located.  (This is
931 normally the user's home directory.)  The dribble file will get the same
932 file permissions as the @code{.newsrc} file.
933
934 @vindex gnus-always-read-dribble-file
935 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
936 read the dribble file on startup without querying the user.
937
938
939 @node The Active File
940 @section The Active File
941 @cindex active file
942 @cindex ignored groups
943
944 When Gnus starts, or indeed whenever it tries to determine whether new
945 articles have arrived, it reads the active file.  This is a very large
946 file that lists all the active groups and articles on the server.
947
948 @vindex gnus-ignored-newsgroups
949 Before examining the active file, Gnus deletes all lines that match the
950 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
951 any groups with bogus names, but you can use this variable to make Gnus
952 ignore hierarchies you aren't ever interested in.  However, this is not
953 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
954 Groups} for an overview of other variables that can be used instead.
955
956 @c This variable is
957 @c @code{nil} by default, and will slow down active file handling somewhat
958 @c if you set it to anything else.
959
960 @vindex gnus-read-active-file
961 @c @head
962 The active file can be rather Huge, so if you have a slow network, you
963 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
964 reading the active file.  This variable is @code{some} by default.
965
966 Gnus will try to make do by getting information just on the groups that
967 you actually subscribe to.
968
969 Note that if you subscribe to lots and lots of groups, setting this
970 variable to @code{nil} will probably make Gnus slower, not faster.  At
971 present, having this variable @code{nil} will slow Gnus down
972 considerably, unless you read news over a 2400 baud modem.
973
974 This variable can also have the value @code{some}.  Gnus will then
975 attempt to read active info only on the subscribed groups.  On some
976 servers this is quite fast (on sparkling, brand new INN servers that
977 support the @code{LIST ACTIVE group} command), on others this isn't fast
978 at all.  In any case, @code{some} should be faster than @code{nil}, and
979 is certainly faster than @code{t} over slow lines.
980
981 If this variable is @code{nil}, Gnus will ask for group info in total
982 lock-step, which isn't very fast.  If it is @code{some} and you use an
983 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
984 read all the replies in one swoop.  This will normally result in better
985 performance, but if the server does not support the aforementioned
986 @code{LIST ACTIVE group} command, this isn't very nice to the server.
987
988 In any case, if you use @code{some} or @code{nil}, you should definitely
989 kill all groups that you aren't interested in to speed things up.
990
991 Note that this variable also affects active file retrieval from
992 secondary select methods.
993
994
995 @node Startup Variables
996 @section Startup Variables
997
998 @table @code
999
1000 @item gnus-load-hook
1001 @vindex gnus-load-hook
1002 A hook run while Gnus is being loaded.  Note that this hook will
1003 normally be run just once in each Emacs session, no matter how many
1004 times you start Gnus.
1005
1006 @item gnus-before-startup-hook
1007 @vindex gnus-before-startup-hook
1008 A hook run after starting up Gnus successfully.
1009
1010 @item gnus-startup-hook
1011 @vindex gnus-startup-hook
1012 A hook run as the very last thing after starting up Gnus
1013
1014 @item gnus-started-hook
1015 @vindex gnus-started-hook
1016 A hook that is run as the very last thing after starting up Gnus
1017 successfully.
1018
1019 @item gnus-started-hook
1020 @vindex gnus-started-hook
1021 A hook that is run after reading the @file{.newsrc} file(s), but before
1022 generating the group buffer.
1023
1024 @item gnus-check-bogus-newsgroups
1025 @vindex gnus-check-bogus-newsgroups
1026 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1027 startup.  A @dfn{bogus group} is a group that you have in your
1028 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1029 bogus groups can take quite a while, so to save time and resources it's
1030 best to leave this option off, and do the checking for bogus groups once
1031 in a while from the group buffer instead (@pxref{Group Maintenance}).
1032
1033 @item gnus-inhibit-startup-message
1034 @vindex gnus-inhibit-startup-message
1035 If non-@code{nil}, the startup message won't be displayed.  That way,
1036 your boss might not notice as easily that you are reading news instead
1037 of doing your job.  Note that this variable is used before
1038 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1039
1040 @item gnus-no-groups-message
1041 @vindex gnus-no-groups-message
1042 Message displayed by Gnus when no groups are available.
1043
1044 @item gnus-play-startup-jingle
1045 @vindex gnus-play-startup-jingle
1046 If non-@code{nil}, play the Gnus jingle at startup.
1047
1048 @item gnus-startup-jingle
1049 @vindex gnus-startup-jingle
1050 Jingle to be played if the above variable is non-@code{nil}.  The
1051 default is @samp{Tuxedomoon.Jingle4.au}.
1052
1053 @end table
1054
1055
1056 @node The Group Buffer
1057 @chapter The Group Buffer
1058 @cindex group buffer
1059
1060 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1061 is the first buffer shown when Gnus starts, and will never be killed as
1062 long as Gnus is active.
1063
1064 @iftex
1065 @iflatex
1066 \gnusfigure{The Group Buffer}{320}{
1067 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1068 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1069 \put(120,38){\vector(1,2){10}}
1070 \put(40,60){\makebox(0,0)[r]{Mode line}}
1071 \put(40,58){\vector(1,0){30}}
1072 \put(200,28){\makebox(0,0)[t]{Native select method}}
1073 \put(200,26){\vector(-1,2){15}}
1074 }
1075 @end iflatex
1076 @end iftex
1077
1078 @menu
1079 * Group Buffer Format::    Information listed and how you can change it.
1080 * Group Maneuvering::      Commands for moving in the group buffer.
1081 * Selecting a Group::      Actually reading news.
1082 * Group Data::             Changing the info for a group.
1083 * Subscription Commands::  Unsubscribing, killing, subscribing.
1084 * Group Levels::           Levels? What are those, then?
1085 * Group Score::            A mechanism for finding out what groups you like.
1086 * Marking Groups::         You can mark groups for later processing.
1087 * Foreign Groups::         Creating and editing groups.
1088 * Group Parameters::       Each group may have different parameters set.
1089 * Listing Groups::         Gnus can list various subsets of the groups.
1090 * Sorting Groups::         Re-arrange the group order.
1091 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1092 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1093 * Exiting Gnus::           Stop reading news and get some work done.
1094 * Group Topics::           A folding group mode divided into topics.
1095 * Misc Group Stuff::       Other stuff that you can to do.
1096 @end menu
1097
1098
1099 @node Group Buffer Format
1100 @section Group Buffer Format
1101
1102 @menu
1103 * Group Line Specification::       Deciding how the group buffer is to look.
1104 * Group Modeline Specification::   The group buffer modeline.
1105 * Group Highlighting::             Having nice colors in the group buffer.
1106 @end menu
1107
1108
1109 @node Group Line Specification
1110 @subsection Group Line Specification
1111 @cindex group buffer format
1112
1113 The default format of the group buffer is nice and dull, but you can
1114 make it as exciting and ugly as you feel like.
1115
1116 Here's a couple of example group lines:
1117
1118 @example
1119      25: news.announce.newusers
1120  *    0: alt.fan.andrea-dworkin
1121 @end example
1122
1123 Quite simple, huh?
1124
1125 You can see that there are 25 unread articles in
1126 @samp{news.announce.newusers}.  There are no unread articles, but some
1127 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1128 asterisk at the beginning of the line?).
1129
1130 @vindex gnus-group-line-format
1131 You can change that format to whatever you want by fiddling with the
1132 @code{gnus-group-line-format} variable.  This variable works along the
1133 lines of a @code{format} specification, which is pretty much the same as
1134 a @code{printf} specifications, for those of you who use (feh!) C.
1135 @xref{Formatting Variables}.
1136
1137 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1138
1139 There should always be a colon on the line; the cursor always moves to
1140 the colon after performing an operation.  Nothing else is required---not
1141 even the group name.  All displayed text is just window dressing, and is
1142 never examined by Gnus.  Gnus stores all real information it needs using
1143 text properties.
1144
1145 (Note that if you make a really strange, wonderful, spreadsheet-like
1146 layout, everybody will believe you are hard at work with the accounting
1147 instead of wasting time reading news.)
1148
1149 Here's a list of all available format characters:
1150
1151 @table @samp
1152
1153 @item M
1154 An asterisk if the group only has marked articles.
1155
1156 @item S
1157 Whether the group is subscribed.
1158
1159 @item L
1160 Level of subscribedness.
1161
1162 @item N
1163 Number of unread articles.
1164
1165 @item I
1166 Number of dormant articles.
1167
1168 @item T
1169 Number of ticked articles.
1170
1171 @item R
1172 Number of read articles.
1173
1174 @item t
1175 Estimated total number of articles.  (This is really @var{max-number}
1176 minus @var{min-number} plus 1.)
1177
1178 @item y
1179 Number of unread, unticked, non-dormant articles.
1180
1181 @item i
1182 Number of ticked and dormant articles.
1183
1184 @item g
1185 Full group name.
1186
1187 @item G
1188 Group name.
1189
1190 @item D
1191 Newsgroup description.
1192
1193 @item o
1194 @samp{m} if moderated.
1195
1196 @item O
1197 @samp{(m)} if moderated.
1198
1199 @item s
1200 Select method.
1201
1202 @item n
1203 Select from where.
1204
1205 @item z
1206 A string that looks like @samp{<%s:%n>} if a foreign select method is
1207 used.
1208
1209 @item P
1210 Indentation based on the level of the topic (@pxref{Group Topics}).
1211
1212 @item c
1213 @vindex gnus-group-uncollapsed-levels
1214 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1215 variable says how many levels to leave at the end of the group name.
1216 The default is 1---this will mean that group names like
1217 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1218
1219 @item m
1220 @vindex gnus-new-mail-mark
1221 @cindex %
1222 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1223 the group lately.
1224
1225 @item d
1226 A string that says when you last read the group (@pxref{Group
1227 Timestamp}).
1228
1229 @item u
1230 User defined specifier.  The next character in the format string should
1231 be a letter.  Gnus will call the function
1232 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1233 following @samp{%u}.  The function will be passed a single dummy
1234 parameter as argument.  The function should return a string, which will
1235 be inserted into the buffer just like information from any other
1236 specifier.
1237 @end table
1238
1239 @cindex *
1240 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1241 if no info is available---for instance, if it is a non-activated foreign
1242 group, or a bogus native group.
1243
1244
1245 @node Group Modeline Specification
1246 @subsection Group Modeline Specification
1247 @cindex group modeline
1248
1249 @vindex gnus-group-mode-line-format
1250 The mode line can be changed by setting
1251 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1252 doesn't understand that many format specifiers:
1253
1254 @table @samp
1255 @item S
1256 The native news server.
1257 @item M
1258 The native select method.
1259 @end table
1260
1261
1262 @node Group Highlighting
1263 @subsection Group Highlighting
1264 @cindex highlighting
1265 @cindex group highlighting
1266
1267 @vindex gnus-group-highlight
1268 Highlighting in the group buffer is controlled by the
1269 @code{gnus-group-highlight} variable.  This is an alist with elements
1270 that look like @var{(form . face)}.  If @var{form} evaluates to
1271 something non-@code{nil}, the @var{face} will be used on the line.
1272
1273 Here's an example value for this variable that might look nice if the
1274 background is dark:
1275
1276 @lisp
1277 (face-spec-set 'my-group-face-1 '((t (:foreground "Red" :bold t))))
1278 (face-spec-set 'my-group-face-2 '((t (:foreground "SeaGreen" :bold t))))
1279 (face-spec-set 'my-group-face-3 '((t (:foreground "SpringGreen" :bold t))))
1280 (face-spec-set 'my-group-face-4 '((t (:foreground "SteelBlue" :bold t))))
1281 (face-spec-set 'my-group-face-5 '((t (:foreground "SkyBlue" :bold t))))
1282
1283 (setq gnus-group-highlight
1284       '(((> unread 200) . my-group-face-1)
1285         ((and (< level 3) (zerop unread)) . my-group-face-2)
1286         ((< level 3) . my-group-face-3)
1287         ((zerop unread) . my-group-face-4)
1288         (t . my-group-face-5)))
1289 @end lisp
1290
1291 Also @pxref{Faces and Fonts}.
1292
1293 Variables that are dynamically bound when the forms are evaluated
1294 include:
1295
1296 @table @code
1297 @item group
1298 The group name.
1299 @item unread
1300 The number of unread articles in the group.
1301 @item method
1302 The select method.
1303 @item mailp
1304 Whether the group is a mail group.
1305 @item level
1306 The level of the group.
1307 @item score
1308 The score of the group.
1309 @item ticked
1310 The number of ticked articles in the group.
1311 @item total
1312 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1313 MIN-NUMBER plus one.
1314 @item topic
1315 When using the topic minor mode, this variable is bound to the current
1316 topic being inserted.
1317 @end table
1318
1319 When the forms are @code{eval}ed, point is at the beginning of the line
1320 of the group in question, so you can use many of the normal Gnus
1321 functions for snarfing info on the group.
1322
1323 @vindex gnus-group-update-hook
1324 @findex gnus-group-highlight-line
1325 @code{gnus-group-update-hook} is called when a group line is changed.
1326 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1327 calls @code{gnus-group-highlight-line} by default.
1328
1329
1330 @node Group Maneuvering
1331 @section Group Maneuvering
1332 @cindex group movement
1333
1334 All movement commands understand the numeric prefix and will behave as
1335 expected, hopefully.
1336
1337 @table @kbd
1338
1339 @item n
1340 @kindex n (Group)
1341 @findex gnus-group-next-unread-group
1342 Go to the next group that has unread articles
1343 (@code{gnus-group-next-unread-group}).
1344
1345 @item p
1346 @itemx DEL
1347 @kindex DEL (Group)
1348 @kindex p (Group)
1349 @findex gnus-group-prev-unread-group
1350 Go to the previous group that has unread articles
1351 (@code{gnus-group-prev-unread-group}).
1352
1353 @item N
1354 @kindex N (Group)
1355 @findex gnus-group-next-group
1356 Go to the next group (@code{gnus-group-next-group}).
1357
1358 @item P
1359 @kindex P (Group)
1360 @findex gnus-group-prev-group
1361 Go to the previous group (@code{gnus-group-prev-group}).
1362
1363 @item M-n
1364 @kindex M-n (Group)
1365 @findex gnus-group-next-unread-group-same-level
1366 Go to the next unread group on the same (or lower) level
1367 (@code{gnus-group-next-unread-group-same-level}).
1368
1369 @item M-p
1370 @kindex M-p (Group)
1371 @findex gnus-group-prev-unread-group-same-level
1372 Go to the previous unread group on the same (or lower) level
1373 (@code{gnus-group-prev-unread-group-same-level}).
1374 @end table
1375
1376 Three commands for jumping to groups:
1377
1378 @table @kbd
1379
1380 @item j
1381 @kindex j (Group)
1382 @findex gnus-group-jump-to-group
1383 Jump to a group (and make it visible if it isn't already)
1384 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1385 like living groups.
1386
1387 @item ,
1388 @kindex , (Group)
1389 @findex gnus-group-best-unread-group
1390 Jump to the unread group with the lowest level
1391 (@code{gnus-group-best-unread-group}).
1392
1393 @item .
1394 @kindex . (Group)
1395 @findex gnus-group-first-unread-group
1396 Jump to the first group with unread articles
1397 (@code{gnus-group-first-unread-group}).
1398 @end table
1399
1400 @vindex gnus-group-goto-unread
1401 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1402 commands will move to the next group, not the next unread group.  Even
1403 the commands that say they move to the next unread group.  The default
1404 is @code{t}.
1405
1406
1407 @node Selecting a Group
1408 @section Selecting a Group
1409 @cindex group selection
1410
1411 @table @kbd
1412
1413 @item SPACE
1414 @kindex SPACE (Group)
1415 @findex gnus-group-read-group
1416 Select the current group, switch to the summary buffer and display the
1417 first unread article (@code{gnus-group-read-group}).  If there are no
1418 unread articles in the group, or if you give a non-numerical prefix to
1419 this command, Gnus will offer to fetch all the old articles in this
1420 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1421 determines the number of articles Gnus will fetch.  If @var{N} is
1422 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1423 negative, Gnus fetches the @var{abs(N)} oldest articles.
1424
1425 @item RET
1426 @kindex RET (Group)
1427 @findex gnus-group-select-group
1428 Select the current group and switch to the summary buffer
1429 (@code{gnus-group-select-group}).  Takes the same arguments as
1430 @code{gnus-group-read-group}---the only difference is that this command
1431 does not display the first unread article automatically upon group
1432 entry.
1433
1434 @item M-RET
1435 @kindex M-RET (Group)
1436 @findex gnus-group-quick-select-group
1437 This does the same as the command above, but tries to do it with the
1438 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1439 scoring/killing will be performed, there will be no highlights and no
1440 expunging.  This might be useful if you're in a real hurry and have to
1441 enter some humongous group.  If you give a 0 prefix to this command
1442 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1443 which is useful if you want to toggle threading before generating the
1444 summary buffer (@pxref{Summary Generation Commands}).
1445
1446 @item M-SPACE
1447 @kindex M-SPACE (Group)
1448 @findex gnus-group-visible-select-group
1449 This is yet one more command that does the same as the @kbd{RET}
1450 command, but this one does it without expunging and hiding dormants
1451 (@code{gnus-group-visible-select-group}).
1452
1453 @item M-C-RET
1454 @kindex M-C-RET (Group)
1455 @findex gnus-group-select-group-ephemerally
1456 Finally, this command selects the current group ephemerally without
1457 doing any processing of its contents
1458 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1459 turned off.  Everything you do in the group after selecting it in this
1460 manner will have no permanent effects.
1461
1462 @end table
1463
1464 @vindex gnus-large-newsgroup
1465 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1466 to be a big group.  This is 200 by default.  If the group has more
1467 (unread and/or ticked) articles than this, Gnus will query the user
1468 before entering the group.  The user can then specify how many articles
1469 should be fetched from the server.  If the user specifies a negative
1470 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1471 is positive, the @code{n} articles that have arrived most recently will
1472 be fetched.
1473
1474 @vindex gnus-select-group-hook
1475 @vindex gnus-auto-select-first
1476 @code{gnus-auto-select-first} control whether any articles are selected
1477 automatically when entering a group with the @kbd{SPACE} command.
1478
1479 @table @code
1480
1481 @item nil
1482 Don't select any articles when entering the group.  Just display the
1483 full summary buffer.
1484
1485 @item t
1486 Select the first unread article when entering the group.
1487
1488 @item best
1489 Select the highest scored article in the group when entering the
1490 group.
1491 @end table
1492
1493 If you want to prevent automatic selection in some group (say, in a
1494 binary group with Huge articles) you can set this variable to @code{nil}
1495 in @code{gnus-select-group-hook}, which is called when a group is
1496 selected.
1497
1498
1499 @node Subscription Commands
1500 @section Subscription Commands
1501 @cindex subscription
1502
1503 @table @kbd
1504
1505 @item S t
1506 @itemx u
1507 @kindex S t (Group)
1508 @kindex u (Group)
1509 @findex gnus-group-unsubscribe-current-group
1510 @c @icon{gnus-group-unsubscribe}
1511 Toggle subscription to the current group
1512 (@code{gnus-group-unsubscribe-current-group}).
1513
1514 @item S s
1515 @itemx U
1516 @kindex S s (Group)
1517 @kindex U (Group)
1518 @findex gnus-group-unsubscribe-group
1519 Prompt for a group to subscribe, and then subscribe it.  If it was
1520 subscribed already, unsubscribe it instead
1521 (@code{gnus-group-unsubscribe-group}).
1522
1523 @item S k
1524 @itemx C-k
1525 @kindex S k (Group)
1526 @kindex C-k (Group)
1527 @findex gnus-group-kill-group
1528 @c @icon{gnus-group-kill-group}
1529 Kill the current group (@code{gnus-group-kill-group}).
1530
1531 @item S y
1532 @itemx C-y
1533 @kindex S y (Group)
1534 @kindex C-y (Group)
1535 @findex gnus-group-yank-group
1536 Yank the last killed group (@code{gnus-group-yank-group}).
1537
1538 @item C-x C-t
1539 @kindex C-x C-t (Group)
1540 @findex gnus-group-transpose-groups
1541 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1542 really a subscription command, but you can use it instead of a
1543 kill-and-yank sequence sometimes.
1544
1545 @item S w
1546 @itemx C-w
1547 @kindex S w (Group)
1548 @kindex C-w (Group)
1549 @findex gnus-group-kill-region
1550 Kill all groups in the region (@code{gnus-group-kill-region}).
1551
1552 @item S z
1553 @kindex S z (Group)
1554 @findex gnus-group-kill-all-zombies
1555 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1556
1557 @item S C-k
1558 @kindex S C-k (Group)
1559 @findex gnus-group-kill-level
1560 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1561 These groups can't be yanked back after killing, so this command should
1562 be used with some caution.  The only time where this command comes in
1563 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1564 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1565 kill off all unsubscribed groups that do not have message numbers in the
1566 @file{.newsrc} file.
1567
1568 @end table
1569
1570 Also @pxref{Group Levels}.
1571
1572
1573 @node Group Data
1574 @section Group Data
1575
1576 @table @kbd
1577
1578 @item c
1579 @kindex c (Group)
1580 @findex gnus-group-catchup-current
1581 @vindex gnus-group-catchup-group-hook
1582 @c @icon{gnus-group-catchup-current}
1583 Mark all unticked articles in this group as read
1584 (@code{gnus-group-catchup-current}).
1585 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1586 the group buffer.
1587
1588 @item C
1589 @kindex C (Group)
1590 @findex gnus-group-catchup-current-all
1591 Mark all articles in this group, even the ticked ones, as read
1592 (@code{gnus-group-catchup-current-all}).
1593
1594 @item M-c
1595 @kindex M-c (Group)
1596 @findex gnus-group-clear-data
1597 Clear the data from the current group---nix out marks and the list of
1598 read articles (@code{gnus-group-clear-data}).
1599
1600 @item M-x gnus-group-clear-data-on-native-groups
1601 @kindex M-x gnus-group-clear-data-on-native-groups
1602 @findex gnus-group-clear-data-on-native-groups
1603 If you have switched from one @sc{nntp} server to another, all your marks
1604 and read ranges have become worthless.  You can use this command to
1605 clear out all data that you have on your native groups.  Use with
1606 caution.
1607
1608 @end table
1609
1610
1611 @node Group Levels
1612 @section Group Levels
1613 @cindex group level
1614 @cindex level
1615
1616 All groups have a level of @dfn{subscribedness}.  For instance, if a
1617 group is on level 2, it is more subscribed than a group on level 5.  You
1618 can ask Gnus to just list groups on a given level or lower
1619 (@pxref{Listing Groups}), or to just check for new articles in groups on
1620 a given level or lower (@pxref{Scanning New Messages}).
1621
1622 Remember:  The higher the level of the group, the less important it is.
1623
1624 @table @kbd
1625
1626 @item S l
1627 @kindex S l (Group)
1628 @findex gnus-group-set-current-level
1629 Set the level of the current group.  If a numeric prefix is given, the
1630 next @var{n} groups will have their levels set.  The user will be
1631 prompted for a level.
1632 @end table
1633
1634 @vindex gnus-level-killed
1635 @vindex gnus-level-zombie
1636 @vindex gnus-level-unsubscribed
1637 @vindex gnus-level-subscribed
1638 Gnus considers groups from levels 1 to
1639 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1640 @code{gnus-level-subscribed} (exclusive) and
1641 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1642 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1643 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1644 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1645 same, but zombie and killed groups have no information on what articles
1646 you have read, etc, stored.  This distinction between dead and living
1647 groups isn't done because it is nice or clever, it is done purely for
1648 reasons of efficiency.
1649
1650 It is recommended that you keep all your mail groups (if any) on quite
1651 low levels (e.g. 1 or 2).
1652
1653 If you want to play with the level variables, you should show some care.
1654 Set them once, and don't touch them ever again.  Better yet, don't touch
1655 them at all unless you know exactly what you're doing.
1656
1657 @vindex gnus-level-default-unsubscribed
1658 @vindex gnus-level-default-subscribed
1659 Two closely related variables are @code{gnus-level-default-subscribed}
1660 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1661 which are the levels that new groups will be put on if they are
1662 (un)subscribed.  These two variables should, of course, be inside the
1663 relevant valid ranges.
1664
1665 @vindex gnus-keep-same-level
1666 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1667 will only move to groups of the same level (or lower).  In
1668 particular, going from the last article in one group to the next group
1669 will go to the next group of the same level (or lower).  This might be
1670 handy if you want to read the most important groups before you read the
1671 rest.
1672
1673 @vindex gnus-group-default-list-level
1674 All groups with a level less than or equal to
1675 @code{gnus-group-default-list-level} will be listed in the group buffer
1676 by default.
1677
1678 @vindex gnus-group-list-inactive-groups
1679 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1680 groups will be listed along with the unread groups.  This variable is
1681 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1682 listed.
1683
1684 @vindex gnus-group-use-permanent-levels
1685 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1686 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1687 use this level as the ``work'' level.
1688
1689 @vindex gnus-activate-level
1690 Gnus will normally just activate (i. e., query the server about) groups
1691 on level @code{gnus-activate-level} or less.  If you don't want to
1692 activate unsubscribed groups, for instance, you might set this variable
1693 to 5.  The default is 6.
1694
1695
1696 @node Group Score
1697 @section Group Score
1698 @cindex group score
1699 @cindex group rank
1700 @cindex rank
1701
1702 You would normally keep important groups on high levels, but that scheme
1703 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1704 group buffer according to how often you read groups, perhaps?  Within
1705 reason?
1706
1707 This is what @dfn{group score} is for.  You can assign a score to each
1708 group.  You can then sort the group buffer based on this score.
1709 Alternatively, you can sort on score and then level.  (Taken together,
1710 the level and the score is called the @dfn{rank} of the group.  A group
1711 that is on level 4 and has a score of 1 has a higher rank than a group
1712 on level 5 that has a score of 300.  (The level is the most significant
1713 part and the score is the least significant part.))
1714
1715 @findex gnus-summary-bubble-group
1716 If you want groups you read often to get higher scores than groups you
1717 read seldom you can add the @code{gnus-summary-bubble-group} function to
1718 the @code{gnus-summary-exit-hook} hook.  This will result (after
1719 sorting) in a bubbling sort of action.  If you want to see that in
1720 action after each summary exit, you can add
1721 @code{gnus-group-sort-groups-by-rank} or
1722 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1723 slow things down somewhat.
1724
1725
1726 @node Marking Groups
1727 @section Marking Groups
1728 @cindex marking groups
1729
1730 If you want to perform some command on several groups, and they appear
1731 subsequently in the group buffer, you would normally just give a
1732 numerical prefix to the command.  Most group commands will then do your
1733 bidding on those groups.
1734
1735 However, if the groups are not in sequential order, you can still
1736 perform a command on several groups.  You simply mark the groups first
1737 with the process mark and then execute the command.
1738
1739 @table @kbd
1740
1741 @item #
1742 @kindex # (Group)
1743 @itemx M m
1744 @kindex M m (Group)
1745 @findex gnus-group-mark-group
1746 Set the mark on the current group (@code{gnus-group-mark-group}).
1747
1748 @item M-#
1749 @kindex M-# (Group)
1750 @itemx M u
1751 @kindex M u (Group)
1752 @findex gnus-group-unmark-group
1753 Remove the mark from the current group
1754 (@code{gnus-group-unmark-group}).
1755
1756 @item M U
1757 @kindex M U (Group)
1758 @findex gnus-group-unmark-all-groups
1759 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1760
1761 @item M w
1762 @kindex M w (Group)
1763 @findex gnus-group-mark-region
1764 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1765
1766 @item M b
1767 @kindex M b (Group)
1768 @findex gnus-group-mark-buffer
1769 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1770
1771 @item M r
1772 @kindex M r (Group)
1773 @findex gnus-group-mark-regexp
1774 Mark all groups that match some regular expression
1775 (@code{gnus-group-mark-regexp}).
1776 @end table
1777
1778 Also @pxref{Process/Prefix}.
1779
1780 @findex gnus-group-universal-argument
1781 If you want to execute some command on all groups that have been marked
1782 with the process mark, you can use the @kbd{M-&}
1783 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1784 the command to be executed.
1785
1786
1787 @node Foreign Groups
1788 @section Foreign Groups
1789 @cindex foreign groups
1790
1791 Below are some group mode commands for making and editing general foreign
1792 groups, as well as commands to ease the creation of a few
1793 special-purpose groups.  All these commands insert the newly created
1794 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1795 consulted.
1796
1797 @table @kbd
1798
1799 @item G m
1800 @kindex G m (Group)
1801 @findex gnus-group-make-group
1802 @cindex making groups
1803 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1804 for a name, a method and possibly an @dfn{address}.  For an easier way
1805 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1806
1807 @item G r
1808 @kindex G r (Group)
1809 @findex gnus-group-rename-group
1810 @cindex renaming groups
1811 Rename the current group to something else
1812 (@code{gnus-group-rename-group}).  This is valid only on some
1813 groups---mail groups mostly.  This command might very well be quite slow
1814 on some backends.
1815
1816 @item G c
1817 @kindex G c (Group)
1818 @cindex customizing
1819 @findex gnus-group-customize
1820 Customize the group parameters (@code{gnus-group-customize}).
1821
1822 @item G e
1823 @kindex G e (Group)
1824 @findex gnus-group-edit-group-method
1825 @cindex renaming groups
1826 Enter a buffer where you can edit the select method of the current
1827 group (@code{gnus-group-edit-group-method}).
1828
1829 @item G p
1830 @kindex G p (Group)
1831 @findex gnus-group-edit-group-parameters
1832 Enter a buffer where you can edit the group parameters
1833 (@code{gnus-group-edit-group-parameters}).
1834
1835 @item G E
1836 @kindex G E (Group)
1837 @findex gnus-group-edit-group
1838 Enter a buffer where you can edit the group info
1839 (@code{gnus-group-edit-group}).
1840
1841 @item G d
1842 @kindex G d (Group)
1843 @findex gnus-group-make-directory-group
1844 @cindex nndir
1845 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1846 for a directory name (@code{gnus-group-make-directory-group}).
1847
1848 @item G h
1849 @kindex G h (Group)
1850 @cindex help group
1851 @findex gnus-group-make-help-group
1852 Make the Gnus help group (@code{gnus-group-make-help-group}).
1853
1854 @item G a
1855 @kindex G a (Group)
1856 @cindex (ding) archive
1857 @cindex archive group
1858 @findex gnus-group-make-archive-group
1859 @vindex gnus-group-archive-directory
1860 @vindex gnus-group-recent-archive-directory
1861 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1862 default a group pointing to the most recent articles will be created
1863 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1864 group will be created from @code{gnus-group-archive-directory}.
1865
1866 @item G k
1867 @kindex G k (Group)
1868 @findex gnus-group-make-kiboze-group
1869 @cindex nnkiboze
1870 Make a kiboze group.  You will be prompted for a name, for a regexp to
1871 match groups to be ``included'' in the kiboze group, and a series of
1872 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1873 @xref{Kibozed Groups}.
1874
1875 @item G D
1876 @kindex G D (Group)
1877 @findex gnus-group-enter-directory
1878 @cindex nneething
1879 Read an arbitrary directory as if it were a newsgroup with the
1880 @code{nneething} backend (@code{gnus-group-enter-directory}).
1881 @xref{Anything Groups}.
1882
1883 @item G f
1884 @kindex G f (Group)
1885 @findex gnus-group-make-doc-group
1886 @cindex ClariNet Briefs
1887 @cindex nndoc
1888 Make a group based on some file or other
1889 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1890 command, you will be prompted for a file name and a file type.
1891 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1892 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1893 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1894 this command without a prefix, Gnus will guess at the file type.
1895 @xref{Document Groups}.
1896
1897 @item G w
1898 @kindex G w (Group)
1899 @findex gnus-group-make-web-group
1900 @cindex DejaNews
1901 @cindex Alta Vista
1902 @cindex InReference
1903 @cindex nnweb
1904 Make an ephemeral group based on a web search
1905 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1906 command, make a solid group instead.  You will be prompted for the
1907 search engine type and the search string.  Valid search engine types
1908 include @code{dejanews}, @code{altavista} and @code{reference}.
1909 @xref{Web Searches}.
1910
1911 If you use the @code{dejanews} search engine, you can limit the search
1912 to a particular group by using a match string like
1913 @samp{~g alt.sysadmin.recovery shaving}.
1914
1915 @item G DEL
1916 @kindex G DEL (Group)
1917 @findex gnus-group-delete-group
1918 This function will delete the current group
1919 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1920 actually delete all the articles in the group, and forcibly remove the
1921 group itself from the face of the Earth.  Use a prefix only if you are
1922 absolutely sure of what you are doing.  This command can't be used on
1923 read-only groups (like @code{nntp} group), though.
1924
1925 @item G V
1926 @kindex G V (Group)
1927 @findex gnus-group-make-empty-virtual
1928 Make a new, fresh, empty @code{nnvirtual} group
1929 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1930
1931 @item G v
1932 @kindex G v (Group)
1933 @findex gnus-group-add-to-virtual
1934 Add the current group to an @code{nnvirtual} group
1935 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1936 @end table
1937
1938 @xref{Select Methods} for more information on the various select
1939 methods.
1940
1941 @vindex gnus-activate-foreign-newsgroups
1942 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1943 Gnus will check all foreign groups with this level or lower at startup.
1944 This might take quite a while, especially if you subscribe to lots of
1945 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
1946 @code{gnus-activate-level} also affects activation of foreign
1947 newsgroups. 
1948
1949
1950 @node Group Parameters
1951 @section Group Parameters
1952 @cindex group parameters
1953
1954 The group parameters store information local to a particular group.
1955 Here's an example group parameter list:
1956
1957 @example
1958 ((to-address . "ding@@gnus.org")
1959  (auto-expire . t))
1960 @end example
1961
1962 We see that each element consists of a "dotted pair"---the thing before
1963 the dot is the key, while the thing after the dot is the value.  All the
1964 parameters have this form @emph{except} local variable specs, which are
1965 not dotted pairs, but proper lists.
1966
1967 The following group parameters can be used:
1968
1969 @table @code
1970 @item to-address
1971 @cindex to-address
1972 Address used by when doing followups and new posts.
1973
1974 @example
1975 (to-address .  "some@@where.com")
1976 @end example
1977
1978 This is primarily useful in mail groups that represent closed mailing
1979 lists---mailing lists where it's expected that everybody that writes to
1980 the mailing list is subscribed to it.  Since using this parameter
1981 ensures that the mail only goes to the mailing list itself, it means
1982 that members won't receive two copies of your followups.
1983
1984 Using @code{to-address} will actually work whether the group is foreign
1985 or not.  Let's say there's a group on the server that is called
1986 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1987 the articles from a mail-to-news gateway.  Posting directly to this
1988 group is therefore impossible---you have to send mail to the mailing
1989 list address instead.
1990
1991 @item to-list
1992 @cindex to-list
1993 Address used when doing a @kbd{a} in that group.
1994
1995 @example
1996 (to-list . "some@@where.com")
1997 @end example
1998
1999 It is totally ignored
2000 when doing a followup---except that if it is present in a news group,
2001 you'll get mail group semantics when doing @kbd{f}.
2002
2003 If you do an @kbd{a} command in a mail group and you have neither a
2004 @code{to-list} group parameter nor a @code{to-address} group parameter,
2005 then a @code{to-list} group parameter will be added automatically upon
2006 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2007 @vindex gnus-add-to-list
2008
2009 If you do an @kbd{a} command in a mail group and you don't have a
2010 @code{to-list} group parameter, one will be added automatically upon
2011 sending the message.
2012
2013 @item visible
2014 @cindex visible
2015 If the group parameter list has the element @code{(visible . t)},
2016 that group will always be visible in the Group buffer, regardless
2017 of whether it has any unread articles.
2018
2019 @item broken-reply-to
2020 @cindex broken-reply-to
2021 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2022 headers in this group are to be ignored.  This can be useful if you're
2023 reading a mailing list group where the listserv has inserted
2024 @code{Reply-To} headers that point back to the listserv itself.  This is
2025 broken behavior.  So there!
2026
2027 @item to-group
2028 @cindex to-group
2029 Elements like @code{(to-group . "some.group.name")} means that all
2030 posts in that group will be sent to @code{some.group.name}.
2031
2032 @item newsgroup
2033 @cindex newsgroup
2034 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2035 will treat all responses as if they were responses to news articles.
2036 This can be useful if you have a mail group that's really a mirror of a
2037 news group.
2038
2039 @item gcc-self
2040 @cindex gcc-self
2041 If @code{(gcc-self . t)} is present in the group parameter list, newly
2042 composed messages will be @code{Gcc}'d to the current group. If
2043 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2044 generated, if @code{(gcc-self . "string")} is present, this string will
2045 be inserted literally as a @code{gcc} header.  This parameter takes
2046 precedence over any default @code{Gcc} rules as described later
2047 (@pxref{Archived Messages}).
2048
2049 @item auto-expire
2050 @cindex auto-expire
2051 If the group parameter has an element that looks like @code{(auto-expire
2052 . t)}, all articles read will be marked as expirable.  For an
2053 alternative approach, @pxref{Expiring Mail}.
2054
2055 @item total-expire
2056 @cindex total-expire
2057 If the group parameter has an element that looks like
2058 @code{(total-expire . t)}, all read articles will be put through the
2059 expiry process, even if they are not marked as expirable.  Use with
2060 caution.  Unread, ticked and dormant articles are not eligible for
2061 expiry.
2062
2063 @item expiry-wait
2064 @cindex expiry-wait
2065 @vindex nnmail-expiry-wait-function
2066 If the group parameter has an element that looks like @code{(expiry-wait
2067 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2068 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2069 The value can either be a number of days (not necessarily an integer) or
2070 the symbols @code{never} or @code{immediate}.
2071
2072 @item score-file
2073 @cindex score file group parameter
2074 Elements that look like @code{(score-file . "file")} will make
2075 @file{file} into the current score file for the group in question.  All
2076 interactive score entries will be put into this file.
2077
2078 @item adapt-file
2079 @cindex adapt file group parameter
2080 Elements that look like @code{(adapt-file . "file")} will make
2081 @file{file} into the current adaptive file for the group in question.
2082 All adaptive score entries will be put into this file.
2083
2084 @item admin-address
2085 When unsubscribing from a mailing list you should never send the
2086 unsubscription notice to the mailing list itself.  Instead, you'd send
2087 messages to the administrative address.  This parameter allows you to
2088 put the admin address somewhere convenient.
2089
2090 @item display
2091 Elements that look like @code{(display . MODE)} say which articles to
2092 display on entering the group.  Valid values are:
2093
2094 @table @code
2095 @item all
2096 Display all articles, both read and unread.
2097
2098 @item default
2099 Display the default visible articles, which normally includes unread and
2100 ticked articles.
2101 @end table
2102
2103 @item comment
2104 Elements that look like @code{(comment . "This is a comment")}
2105 are arbitrary comments on the group.  They are currently ignored by
2106 Gnus, but provide a place for you to store information on particular
2107 groups.
2108
2109 @item @var{(variable form)}
2110 You can use the group parameters to set variables local to the group you
2111 are entering.  If you want to turn threading off in @samp{news.answers},
2112 you could put @code{(gnus-show-threads nil)} in the group parameters of
2113 that group.  @code{gnus-show-threads} will be made into a local variable
2114 in the summary buffer you enter, and the form @code{nil} will be
2115 @code{eval}ed there.
2116
2117 This can also be used as a group-specific hook function, if you'd like.
2118 If you want to hear a beep when you enter a group, you could put
2119 something like @code{(dummy-variable (ding))} in the parameters of that
2120 group.  @code{dummy-variable} will be set to the result of the
2121 @code{(ding)} form, but who cares?
2122
2123 @end table
2124
2125 Use the @kbd{G p} command to edit group parameters of a group.  You
2126 might also be interested in reading about topic parameters (@pxref{Topic
2127 Parameters}).
2128
2129
2130 @node Listing Groups
2131 @section Listing Groups
2132 @cindex group listing
2133
2134 These commands all list various slices of the groups available.
2135
2136 @table @kbd
2137
2138 @item l
2139 @itemx A s
2140 @kindex A s (Group)
2141 @kindex l (Group)
2142 @findex gnus-group-list-groups
2143 List all groups that have unread articles
2144 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2145 command will list only groups of level ARG and lower.  By default, it
2146 only lists groups of level five (i. e.,
2147 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2148 groups).
2149
2150 @item L
2151 @itemx A u
2152 @kindex A u (Group)
2153 @kindex L (Group)
2154 @findex gnus-group-list-all-groups
2155 List all groups, whether they have unread articles or not
2156 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2157 this command will list only groups of level ARG and lower.  By default,
2158 it lists groups of level seven or lower (i.e., just subscribed and
2159 unsubscribed groups).
2160
2161 @item A l
2162 @kindex A l (Group)
2163 @findex gnus-group-list-level
2164 List all unread groups on a specific level
2165 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2166 with no unread articles.
2167
2168 @item A k
2169 @kindex A k (Group)
2170 @findex gnus-group-list-killed
2171 List all killed groups (@code{gnus-group-list-killed}).  If given a
2172 prefix argument, really list all groups that are available, but aren't
2173 currently (un)subscribed.  This could entail reading the active file
2174 from the server.
2175
2176 @item A z
2177 @kindex A z (Group)
2178 @findex gnus-group-list-zombies
2179 List all zombie groups (@code{gnus-group-list-zombies}).
2180
2181 @item A m
2182 @kindex A m (Group)
2183 @findex gnus-group-list-matching
2184 List all unread, subscribed groups with names that match a regexp
2185 (@code{gnus-group-list-matching}).
2186
2187 @item A M
2188 @kindex A M (Group)
2189 @findex gnus-group-list-all-matching
2190 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2191
2192 @item A A
2193 @kindex A A (Group)
2194 @findex gnus-group-list-active
2195 List absolutely all groups in the active file(s) of the
2196 server(s) you are connected to (@code{gnus-group-list-active}).  This
2197 might very well take quite a while.  It might actually be a better idea
2198 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2199 thing to match on.  Also note that this command may list groups that
2200 don't exist (yet)---these will be listed as if they were killed groups.
2201 Take the output with some grains of salt.
2202
2203 @item A a
2204 @kindex A a (Group)
2205 @findex gnus-group-apropos
2206 List all groups that have names that match a regexp
2207 (@code{gnus-group-apropos}).
2208
2209 @item A d
2210 @kindex A d (Group)
2211 @findex gnus-group-description-apropos
2212 List all groups that have names or descriptions that match a regexp
2213 (@code{gnus-group-description-apropos}).
2214
2215 @end table
2216
2217 @vindex gnus-permanently-visible-groups
2218 @cindex visible group parameter
2219 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2220 always be shown, whether they have unread articles or not.  You can also
2221 add the @code{visible} element to the group parameters in question to
2222 get the same effect.
2223
2224 @vindex gnus-list-groups-with-ticked-articles
2225 Groups that have just ticked articles in it are normally listed in the
2226 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2227 @code{nil}, these groups will be treated just like totally empty
2228 groups.  It is @code{t} by default.
2229
2230
2231 @node Sorting Groups
2232 @section Sorting Groups
2233 @cindex sorting groups
2234
2235 @kindex C-c C-s (Group)
2236 @findex gnus-group-sort-groups
2237 @vindex gnus-group-sort-function
2238 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2239 group buffer according to the function(s) given by the
2240 @code{gnus-group-sort-function} variable.  Available sorting functions
2241 include:
2242
2243 @table @code
2244
2245 @item gnus-group-sort-by-alphabet
2246 @findex gnus-group-sort-by-alphabet
2247 Sort the group names alphabetically.  This is the default.
2248
2249 @item gnus-group-sort-by-real-name
2250 @findex gnus-group-sort-by-real-name
2251 Sort the group alphabetically on the real (unprefixed) group names.
2252
2253 @item gnus-group-sort-by-level
2254 @findex gnus-group-sort-by-level
2255 Sort by group level.
2256
2257 @item gnus-group-sort-by-score
2258 @findex gnus-group-sort-by-score
2259 Sort by group score.  @xref{Group Score}.
2260
2261 @item gnus-group-sort-by-rank
2262 @findex gnus-group-sort-by-rank
2263 Sort by group score and then the group level.  The level and the score
2264 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2265
2266 @item gnus-group-sort-by-unread
2267 @findex gnus-group-sort-by-unread
2268 Sort by number of unread articles.
2269
2270 @item gnus-group-sort-by-method
2271 @findex gnus-group-sort-by-method
2272 Sort alphabetically on the select method.
2273
2274
2275 @end table
2276
2277 @code{gnus-group-sort-function} can also be a list of sorting
2278 functions.  In that case, the most significant sort key function must be
2279 the last one.
2280
2281
2282 There are also a number of commands for sorting directly according to
2283 some sorting criteria:
2284
2285 @table @kbd
2286 @item G S a
2287 @kindex G S a (Group)
2288 @findex gnus-group-sort-groups-by-alphabet
2289 Sort the group buffer alphabetically by group name
2290 (@code{gnus-group-sort-groups-by-alphabet}).
2291
2292 @item G S u
2293 @kindex G S u (Group)
2294 @findex gnus-group-sort-groups-by-unread
2295 Sort the group buffer by the number of unread articles
2296 (@code{gnus-group-sort-groups-by-unread}).
2297
2298 @item G S l
2299 @kindex G S l (Group)
2300 @findex gnus-group-sort-groups-by-level
2301 Sort the group buffer by group level
2302 (@code{gnus-group-sort-groups-by-level}).
2303
2304 @item G S v
2305 @kindex G S v (Group)
2306 @findex gnus-group-sort-groups-by-score
2307 Sort the group buffer by group score
2308 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2309
2310 @item G S r
2311 @kindex G S r (Group)
2312 @findex gnus-group-sort-groups-by-rank
2313 Sort the group buffer by group rank
2314 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2315
2316 @item G S m
2317 @kindex G S m (Group)
2318 @findex gnus-group-sort-groups-by-method
2319 Sort the group buffer alphabetically by backend name
2320 (@code{gnus-group-sort-groups-by-method}).
2321
2322 @end table
2323
2324 When given a prefix, all these commands will sort in reverse order.
2325
2326 You can also sort a subset of the groups:
2327
2328 @table @kbd
2329 @item G P a
2330 @kindex G P a (Group)
2331 @findex gnus-group-sort-selected-groups-by-alphabet
2332 Sort the process/prefixed groups in the group buffer alphabetically by
2333 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2334
2335 @item G P u
2336 @kindex G P u (Group)
2337 @findex gnus-group-sort-selected-groups-by-unread
2338 Sort the process/prefixed groups in the group buffer by the number of
2339 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2340
2341 @item G P l
2342 @kindex G P l (Group)
2343 @findex gnus-group-sort-selected-groups-by-level
2344 Sort the process/prefixed groups in the group buffer by group level
2345 (@code{gnus-group-sort-selected-groups-by-level}).
2346
2347 @item G P v
2348 @kindex G P v (Group)
2349 @findex gnus-group-sort-selected-groups-by-score
2350 Sort the process/prefixed groups in the group buffer by group score
2351 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2352
2353 @item G P r
2354 @kindex G P r (Group)
2355 @findex gnus-group-sort-selected-groups-by-rank
2356 Sort the process/prefixed groups in the group buffer by group rank
2357 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2358
2359 @item G P m
2360 @kindex G P m (Group)
2361 @findex gnus-group-sort-selected-groups-by-method
2362 Sort the process/prefixed groups in the group buffer alphabetically by
2363 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2364
2365 @end table
2366
2367
2368
2369 @node Group Maintenance
2370 @section Group Maintenance
2371 @cindex bogus groups
2372
2373 @table @kbd
2374 @item b
2375 @kindex b (Group)
2376 @findex gnus-group-check-bogus-groups
2377 Find bogus groups and delete them
2378 (@code{gnus-group-check-bogus-groups}).
2379
2380 @item F
2381 @kindex F (Group)
2382 @findex gnus-group-find-new-groups
2383 Find new groups and process them (@code{gnus-group-find-new-groups}).
2384 If given a prefix, use the @code{ask-server} method to query the server
2385 for new groups.
2386
2387 @item C-c C-x
2388 @kindex C-c C-x (Group)
2389 @findex gnus-group-expire-articles
2390 Run all expirable articles in the current group through the expiry
2391 process (if any) (@code{gnus-group-expire-articles}).
2392
2393 @item C-c M-C-x
2394 @kindex C-c M-C-x (Group)
2395 @findex gnus-group-expire-all-groups
2396 Run all articles in all groups through the expiry process
2397 (@code{gnus-group-expire-all-groups}).
2398
2399 @end table
2400
2401
2402 @node Browse Foreign Server
2403 @section Browse Foreign Server
2404 @cindex foreign servers
2405 @cindex browsing servers
2406
2407 @table @kbd
2408 @item B
2409 @kindex B (Group)
2410 @findex gnus-group-browse-foreign-server
2411 You will be queried for a select method and a server name.  Gnus will
2412 then attempt to contact this server and let you browse the groups there
2413 (@code{gnus-group-browse-foreign-server}).
2414 @end table
2415
2416 @findex gnus-browse-mode
2417 A new buffer with a list of available groups will appear.  This buffer
2418 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2419 a lot) like a normal group buffer.
2420
2421 Here's a list of keystrokes available in the browse mode:
2422
2423 @table @kbd
2424 @item n
2425 @kindex n (Browse)
2426 @findex gnus-group-next-group
2427 Go to the next group (@code{gnus-group-next-group}).
2428
2429 @item p
2430 @kindex p (Browse)
2431 @findex gnus-group-prev-group
2432 Go to the previous group (@code{gnus-group-prev-group}).
2433
2434 @item SPACE
2435 @kindex SPACE (Browse)
2436 @findex gnus-browse-read-group
2437 Enter the current group and display the first article
2438 (@code{gnus-browse-read-group}).
2439
2440 @item RET
2441 @kindex RET (Browse)
2442 @findex gnus-browse-select-group
2443 Enter the current group (@code{gnus-browse-select-group}).
2444
2445 @item u
2446 @kindex u (Browse)
2447 @findex gnus-browse-unsubscribe-current-group
2448 Unsubscribe to the current group, or, as will be the case here,
2449 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2450
2451 @item l
2452 @itemx q
2453 @kindex q (Browse)
2454 @kindex l (Browse)
2455 @findex gnus-browse-exit
2456 Exit browse mode (@code{gnus-browse-exit}).
2457
2458 @item ?
2459 @kindex ? (Browse)
2460 @findex gnus-browse-describe-briefly
2461 Describe browse mode briefly (well, there's not much to describe, is
2462 there) (@code{gnus-browse-describe-briefly}).
2463 @end table
2464
2465
2466 @node Exiting Gnus
2467 @section Exiting Gnus
2468 @cindex exiting Gnus
2469
2470 Yes, Gnus is ex(c)iting.
2471
2472 @table @kbd
2473 @item z
2474 @kindex z (Group)
2475 @findex gnus-group-suspend
2476 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2477 but it kills all buffers except the Group buffer.  I'm not sure why this
2478 is a gain, but then who am I to judge?
2479
2480 @item q
2481 @kindex q (Group)
2482 @findex gnus-group-exit
2483 @c @icon{gnus-group-exit}
2484 Quit Gnus (@code{gnus-group-exit}).
2485
2486 @item Q
2487 @kindex Q (Group)
2488 @findex gnus-group-quit
2489 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2490 The dribble file will be saved, though (@pxref{Auto Save}).
2491 @end table
2492
2493 @vindex gnus-exit-gnus-hook
2494 @vindex gnus-suspend-gnus-hook
2495 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2496 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2497 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2498 exiting Gnus.
2499
2500 @findex gnus-unload
2501 @cindex unloading
2502 If you wish to completely unload Gnus and all its adherents, you can use
2503 the @code{gnus-unload} command.  This command is also very handy when
2504 trying to customize meta-variables.
2505
2506 Note:
2507
2508 @quotation
2509 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2510 numbly heavy and herself fall into a hazy trance as the boy sitting
2511 behind her drew repeated lines with his pencil across the back of her
2512 plastic chair.
2513 @end quotation
2514
2515
2516 @node Group Topics
2517 @section Group Topics
2518 @cindex topics
2519
2520 If you read lots and lots of groups, it might be convenient to group
2521 them hierarchically according to topics.  You put your Emacs groups over
2522 here, your sex groups over there, and the rest (what, two groups or so?)
2523 you put in some misc section that you never bother with anyway.  You can
2524 even group the Emacs sex groups as a sub-topic to either the Emacs
2525 groups or the sex groups---or both!  Go wild!
2526
2527 @iftex
2528 @iflatex
2529 \gnusfigure{Group Topics}{400}{
2530 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2531 }
2532 @end iflatex
2533 @end iftex
2534
2535 Here's an example:
2536
2537 @example
2538 Gnus
2539   Emacs -- I wuw it!
2540      3: comp.emacs
2541      2: alt.religion.emacs
2542     Naughty Emacs
2543      452: alt.sex.emacs
2544        0: comp.talk.emacs.recovery
2545   Misc
2546      8: comp.binaries.fractals
2547     13: comp.sources.unix
2548 @end example
2549
2550 @findex gnus-topic-mode
2551 @kindex t (Group)
2552 To get this @emph{fab} functionality you simply turn on (ooh!) the
2553 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2554 is a toggling command.)
2555
2556 Go ahead, just try it.  I'll still be here when you get back.  La de
2557 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2558 press @kbd{l}.  There.  All your groups are now listed under
2559 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2560 bothered?
2561
2562 If you want this permanently enabled, you should add that minor mode to
2563 the hook for the group mode:
2564
2565 @lisp
2566 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2567 @end lisp
2568
2569 @menu
2570 * Topic Variables::    How to customize the topics the Lisp Way.
2571 * Topic Commands::     Interactive E-Z commands.
2572 * Topic Sorting::      Sorting each topic individually.
2573 * Topic Topology::     A map of the world.
2574 * Topic Parameters::   Parameters that apply to all groups in a topic.
2575 @end menu
2576
2577
2578 @node Topic Variables
2579 @subsection Topic Variables
2580 @cindex topic variables
2581
2582 Now, if you select a topic, it will fold/unfold that topic, which is
2583 really neat, I think.
2584
2585 @vindex gnus-topic-line-format
2586 The topic lines themselves are created according to the
2587 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2588 Valid elements are:
2589
2590 @table @samp
2591 @item i
2592 Indentation.
2593 @item n
2594 Topic name.
2595 @item v
2596 Visibility.
2597 @item l
2598 Level.
2599 @item g
2600 Number of groups in the topic.
2601 @item a
2602 Number of unread articles in the topic.
2603 @item A
2604 Number of unread articles in the topic and all its subtopics.
2605 @end table
2606
2607 @vindex gnus-topic-indent-level
2608 Each sub-topic (and the groups in the sub-topics) will be indented with
2609 @code{gnus-topic-indent-level} times the topic level number of spaces.
2610 The default is 2.
2611
2612 @vindex gnus-topic-mode-hook
2613 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2614
2615 @vindex gnus-topic-display-empty-topics
2616 The @code{gnus-topic-display-empty-topics} says whether to display even
2617 topics that have no unread articles in them.  The default is @code{t}.
2618
2619
2620 @node Topic Commands
2621 @subsection Topic Commands
2622 @cindex topic commands
2623
2624 When the topic minor mode is turned on, a new @kbd{T} submap will be
2625 available.  In addition, a few of the standard keys change their
2626 definitions slightly.
2627
2628 @table @kbd
2629
2630 @item T n
2631 @kindex T n (Topic)
2632 @findex gnus-topic-create-topic
2633 Prompt for a new topic name and create it
2634 (@code{gnus-topic-create-topic}).
2635
2636 @item T m
2637 @kindex T m (Topic)
2638 @findex gnus-topic-move-group
2639 Move the current group to some other topic
2640 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2641 convention (@pxref{Process/Prefix}).
2642
2643 @item T c
2644 @kindex T c (Topic)
2645 @findex gnus-topic-copy-group
2646 Copy the current group to some other topic
2647 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2648 convention (@pxref{Process/Prefix}).
2649
2650 @item T D
2651 @kindex T D (Topic)
2652 @findex gnus-topic-remove-group
2653 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2654 This command is mainly useful if you have the same group in several
2655 topics and wish to remove it from one of the topics.  You may also
2656 remove a group from all topics, but in that case, Gnus will add it to
2657 the root topic the next time you start Gnus.  In fact, all new groups
2658 (which, naturally, don't belong to any topic) will show up in the root
2659 topic. 
2660
2661 This command uses the process/prefix convention
2662 (@pxref{Process/Prefix}).
2663
2664 @item T M
2665 @kindex T M (Topic)
2666 @findex gnus-topic-move-matching
2667 Move all groups that match some regular expression to a topic
2668 (@code{gnus-topic-move-matching}).
2669
2670 @item T C
2671 @kindex T C (Topic)
2672 @findex gnus-topic-copy-matching
2673 Copy all groups that match some regular expression to a topic
2674 (@code{gnus-topic-copy-matching}).
2675
2676 @item T h
2677 @kindex T h (Topic)
2678 @findex gnus-topic-toggle-display-empty-topics
2679 Toggle hiding empty topics
2680 (@code{gnus-topic-toggle-display-empty-topics}).
2681
2682 @item T #
2683 @kindex T # (Topic)
2684 @findex gnus-topic-mark-topic
2685 Mark all groups in the current topic with the process mark
2686 (@code{gnus-topic-mark-topic}).
2687
2688 @item T M-#
2689 @kindex T M-# (Topic)
2690 @findex gnus-topic-unmark-topic
2691 Remove the process mark from all groups in the current topic
2692 (@code{gnus-topic-unmark-topic}).
2693
2694 @item RET
2695 @kindex RET (Topic)
2696 @findex gnus-topic-select-group
2697 @itemx SPACE
2698 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2699 When you perform this command on a group, you'll enter the group, as
2700 usual.  When done on a topic line, the topic will be folded (if it was
2701 visible) or unfolded (if it was folded already).  So it's basically a
2702 toggling command on topics.  In addition, if you give a numerical
2703 prefix, group on that level (and lower) will be displayed.
2704
2705 @item T TAB
2706 @itemx TAB
2707 @kindex T TAB (Topic)
2708 @kindex TAB (Topic)
2709 @findex gnus-topic-indent
2710 ``Indent'' the current topic so that it becomes a sub-topic of the
2711 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2712 ``un-indent'' the topic instead.
2713
2714 @item M-TAB
2715 @kindex M-TAB (Topic)
2716 @findex gnus-topic-unindent
2717 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2718 parent of its current parent (@code{gnus-topic-unindent}).  
2719
2720 @item C-k
2721 @kindex C-k (Topic)
2722 @findex gnus-topic-kill-group
2723 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2724 topic will be removed along with the topic.
2725
2726 @item C-y
2727 @kindex C-y (Topic)
2728 @findex gnus-topic-yank-group
2729 Yank the previously killed group or topic
2730 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2731 before all groups.
2732
2733 @item T r
2734 @kindex T r (Topic)
2735 @findex gnus-topic-rename
2736 Rename a topic (@code{gnus-topic-rename}).
2737
2738 @item T DEL
2739 @kindex T DEL (Topic)
2740 @findex gnus-topic-delete
2741 Delete an empty topic (@code{gnus-topic-delete}).
2742
2743 @item A T
2744 @kindex A T (Topic)
2745 @findex gnus-topic-list-active
2746 List all groups that Gnus knows about in a topics-ified way
2747 (@code{gnus-topic-list-active}).
2748
2749 @item G p
2750 @kindex G p (Topic)
2751 @findex gnus-topic-edit-parameters
2752 @cindex group parameters
2753 @cindex topic parameters
2754 @cindex parameters
2755 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2756 @xref{Topic Parameters}.
2757
2758 @end table
2759
2760
2761 @node Topic Sorting
2762 @subsection Topic Sorting
2763 @cindex topic sorting
2764
2765 You can sort the groups in each topic individually with the following
2766 commands:
2767
2768
2769 @table @kbd
2770 @item T S a
2771 @kindex T S a (Topic)
2772 @findex gnus-topic-sort-groups-by-alphabet
2773 Sort the current topic alphabetically by group name
2774 (@code{gnus-topic-sort-groups-by-alphabet}).
2775
2776 @item T S u
2777 @kindex T S u (Topic)
2778 @findex gnus-topic-sort-groups-by-unread
2779 Sort the current topic by the number of unread articles
2780 (@code{gnus-topic-sort-groups-by-unread}).
2781
2782 @item T S l
2783 @kindex T S l (Topic)
2784 @findex gnus-topic-sort-groups-by-level
2785 Sort the current topic by group level
2786 (@code{gnus-topic-sort-groups-by-level}).
2787
2788 @item T S v
2789 @kindex T S v (Topic)
2790 @findex gnus-topic-sort-groups-by-score
2791 Sort the current topic by group score
2792 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2793
2794 @item T S r
2795 @kindex T S r (Topic)
2796 @findex gnus-topic-sort-groups-by-rank
2797 Sort the current topic by group rank
2798 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2799
2800 @item T S m
2801 @kindex T S m (Topic)
2802 @findex gnus-topic-sort-groups-by-method
2803 Sort the current topic alphabetically by backend name
2804 (@code{gnus-topic-sort-groups-by-method}).
2805
2806 @end table
2807
2808 @xref{Sorting Groups} for more information about group sorting.
2809
2810
2811 @node Topic Topology
2812 @subsection Topic Topology
2813 @cindex topic topology
2814 @cindex topology
2815
2816 So, let's have a look at an example group buffer:
2817
2818 @example
2819 Gnus
2820   Emacs -- I wuw it!
2821      3: comp.emacs
2822      2: alt.religion.emacs
2823     Naughty Emacs
2824      452: alt.sex.emacs
2825        0: comp.talk.emacs.recovery
2826   Misc
2827      8: comp.binaries.fractals
2828     13: comp.sources.unix
2829 @end example
2830
2831 So, here we have one top-level topic (@samp{Gnus}), two topics under
2832 that, and one sub-topic under one of the sub-topics.  (There is always
2833 just one (1) top-level topic).  This topology can be expressed as
2834 follows:
2835
2836 @lisp
2837 (("Gnus" visible)
2838  (("Emacs -- I wuw it!" visible)
2839   (("Naughty Emacs" visible)))
2840  (("Misc" visible)))
2841 @end lisp
2842
2843 @vindex gnus-topic-topology
2844 This is in fact how the variable @code{gnus-topic-topology} would look
2845 for the display above.  That variable is saved in the @file{.newsrc.eld}
2846 file, and shouldn't be messed with manually---unless you really want
2847 to.  Since this variable is read from the @file{.newsrc.eld} file,
2848 setting it in any other startup files will have no effect.
2849
2850 This topology shows what topics are sub-topics of what topics (right),
2851 and which topics are visible.  Two settings are currently
2852 allowed---@code{visible} and @code{invisible}.
2853
2854
2855 @node Topic Parameters
2856 @subsection Topic Parameters
2857 @cindex topic parameters
2858
2859 All groups in a topic will inherit group parameters from the parent (and
2860 ancestor) topic parameters.  All valid group parameters are valid topic
2861 parameters (@pxref{Group Parameters}).
2862
2863 Group parameters (of course) override topic parameters, and topic
2864 parameters in sub-topics override topic parameters in super-topics.  You
2865 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2866 verb, although you may feel free to disagree with me here.)
2867
2868 @example
2869 Gnus
2870   Emacs
2871      3: comp.emacs
2872      2: alt.religion.emacs
2873    452: alt.sex.emacs
2874     Relief
2875      452: alt.sex.emacs
2876        0: comp.talk.emacs.recovery
2877   Misc
2878      8: comp.binaries.fractals
2879     13: comp.sources.unix
2880    452: alt.sex.emacs
2881 @end example
2882
2883 The @samp{Emacs} topic has the topic parameter @code{(score-file
2884 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2885 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2886 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2887 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2888 . "religion.SCORE")}.
2889
2890 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2891 will get the @file{relief.SCORE} home score file.  If you enter the same
2892 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2893 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2894 get the @file{religion.SCORE} home score file.
2895
2896 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2897 there are some problems, especially with the @code{total-expiry}
2898 parameter.  Say you have a mail group in two topics; one with
2899 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2900 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2901 of these topics you mean to expire articles from, so anything may
2902 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2903 happens.  You just have to be careful if you do stuff like that.
2904
2905
2906 @node Misc Group Stuff
2907 @section Misc Group Stuff
2908
2909 @menu
2910 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2911 * Group Information::     Information and help on groups and Gnus.
2912 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2913 * File Commands::         Reading and writing the Gnus files.
2914 @end menu
2915
2916 @table @kbd
2917
2918 @item ^
2919 @kindex ^ (Group)
2920 @findex gnus-group-enter-server-mode
2921 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2922 @xref{The Server Buffer}.
2923
2924 @item a
2925 @kindex a (Group)
2926 @findex gnus-group-post-news
2927 Post an article to a group (@code{gnus-group-post-news}).  If given a
2928 prefix, the current group name will be used as the default.
2929
2930 @item m
2931 @kindex m (Group)
2932 @findex gnus-group-mail
2933 Mail a message somewhere (@code{gnus-group-mail}).
2934
2935 @end table
2936
2937 Variables for the group buffer:
2938
2939 @table @code
2940
2941 @item gnus-group-mode-hook
2942 @vindex gnus-group-mode-hook
2943 is called after the group buffer has been
2944 created.
2945
2946 @item gnus-group-prepare-hook
2947 @vindex gnus-group-prepare-hook
2948 is called after the group buffer is
2949 generated.  It may be used to modify the buffer in some strange,
2950 unnatural way.
2951
2952 @item gnus-group-prepared-hook
2953 @vindex gnus-group-prepare-hook
2954 is called as the very last thing after the group buffer has been
2955 generated.  It may be used to move point around, for instance.
2956
2957 @item gnus-permanently-visible-groups
2958 @vindex gnus-permanently-visible-groups
2959 Groups matching this regexp will always be listed in the group buffer,
2960 whether they are empty or not.
2961
2962 @end table
2963
2964
2965 @node Scanning New Messages
2966 @subsection Scanning New Messages
2967 @cindex new messages
2968 @cindex scanning new news
2969
2970 @table @kbd
2971
2972 @item g
2973 @kindex g (Group)
2974 @findex gnus-group-get-new-news
2975 @c @icon{gnus-group-get-new-news}
2976 Check the server(s) for new articles.  If the numerical prefix is used,
2977 this command will check only groups of level @var{arg} and lower
2978 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2979 command will force a total re-reading of the active file(s) from the
2980 backend(s).
2981
2982 @item M-g
2983 @kindex M-g (Group)
2984 @findex gnus-group-get-new-news-this-group
2985 @vindex gnus-goto-next-group-when-activating
2986 @c @icon{gnus-group-get-new-news-this-group}
2987 Check whether new articles have arrived in the current group
2988 (@code{gnus-group-get-new-news-this-group}).
2989 @code{gnus-goto-next-group-when-activating} says whether this command is
2990 to move point to the next group or not.  It is @code{t} by default.
2991
2992 @findex gnus-activate-all-groups
2993 @cindex activating groups
2994 @item C-c M-g
2995 @kindex C-c M-g (Group)
2996 Activate absolutely all groups (@code{gnus-activate-all-groups}).
2997
2998 @item R
2999 @kindex R (Group)
3000 @cindex restarting
3001 @findex gnus-group-restart
3002 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3003 file(s), closes the connection to all servers, clears up all run-time
3004 Gnus variables, and then starts Gnus all over again.
3005
3006 @end table
3007
3008 @vindex gnus-get-new-news-hook
3009 @code{gnus-get-new-news-hook} is run just before checking for new news.
3010
3011 @vindex gnus-after-getting-new-news-hook
3012 @code{gnus-after-getting-new-news-hook} is run after checking for new
3013 news.
3014
3015
3016 @node Group Information
3017 @subsection Group Information
3018 @cindex group information
3019 @cindex information on groups
3020
3021 @table @kbd
3022
3023
3024 @item H f
3025 @kindex H f (Group)
3026 @findex gnus-group-fetch-faq
3027 @vindex gnus-group-faq-directory
3028 @cindex FAQ
3029 @cindex ange-ftp
3030 Try to fetch the FAQ for the current group
3031 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3032 @code{gnus-group-faq-directory}, which is usually a directory on a
3033 remote machine.  This variable can also be a list of directories.  In
3034 that case, giving a prefix to this command will allow you to choose
3035 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3036 for fetching the file.
3037
3038 If fetching from the first site is unsuccessful, Gnus will attempt to go
3039 through @code{gnus-group-faq-directory} and try to open them one by one.
3040
3041 @item H d
3042 @itemx C-c C-d
3043 @c @icon{gnus-group-describe-group}
3044 @kindex H d (Group)
3045 @kindex C-c C-d (Group)
3046 @cindex describing groups
3047 @cindex group description
3048 @findex gnus-group-describe-group
3049 Describe the current group (@code{gnus-group-describe-group}).  If given
3050 a prefix, force Gnus to re-read the description from the server.
3051
3052 @item M-d
3053 @kindex M-d (Group)
3054 @findex gnus-group-describe-all-groups
3055 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3056 prefix, force Gnus to re-read the description file from the server.
3057
3058 @item H v
3059 @itemx V
3060 @kindex V (Group)
3061 @kindex H v (Group)
3062 @cindex version
3063 @findex gnus-version
3064 Display current Gnus version numbers (@code{gnus-version}).
3065
3066 @item ?
3067 @kindex ? (Group)
3068 @findex gnus-group-describe-briefly
3069 Give a very short help message (@code{gnus-group-describe-briefly}).
3070
3071 @item C-c C-i
3072 @kindex C-c C-i (Group)
3073 @cindex info
3074 @cindex manual
3075 @findex gnus-info-find-node
3076 Go to the Gnus info node (@code{gnus-info-find-node}).
3077 @end table
3078
3079
3080 @node Group Timestamp
3081 @subsection Group Timestamp
3082 @cindex timestamps
3083 @cindex group timestamps
3084
3085 It can be convenient to let Gnus keep track of when you last read a
3086 group.  To set the ball rolling, you should add
3087 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3088
3089 @lisp
3090 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3091 @end lisp
3092
3093 After doing this, each time you enter a group, it'll be recorded.
3094
3095 This information can be displayed in various ways---the easiest is to
3096 use the @samp{%d} spec in the group line format:
3097
3098 @lisp
3099 (setq gnus-group-line-format
3100       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3101 @end lisp
3102
3103 This will result in lines looking like:
3104
3105 @example
3106 *        0: mail.ding                                19961002T012943
3107          0: custom                                   19961002T012713
3108 @end example
3109
3110 As you can see, the date is displayed in compact ISO 8601 format.  This
3111 may be a bit too much, so to just display the date, you could say
3112 something like:
3113
3114 @lisp
3115 (setq gnus-group-line-format
3116       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3117 @end lisp
3118
3119
3120 @node File Commands
3121 @subsection File Commands
3122 @cindex file commands
3123
3124 @table @kbd
3125
3126 @item r
3127 @kindex r (Group)
3128 @findex gnus-group-read-init-file
3129 @vindex gnus-init-file
3130 @cindex reading init file
3131 Re-read the init file (@code{gnus-init-file}, which defaults to
3132 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3133
3134 @item s
3135 @kindex s (Group)
3136 @findex gnus-group-save-newsrc
3137 @cindex saving .newsrc
3138 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3139 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3140 file(s) whether Gnus thinks it is necessary or not.
3141
3142 @c @item Z
3143 @c @kindex Z (Group)
3144 @c @findex gnus-group-clear-dribble
3145 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3146
3147 @end table
3148
3149
3150 @node The Summary Buffer
3151 @chapter The Summary Buffer
3152 @cindex summary buffer
3153
3154 A line for each article is displayed in the summary buffer.  You can
3155 move around, read articles, post articles and reply to articles.
3156
3157 The most common way to a summary buffer is to select a group from the
3158 group buffer (@pxref{Selecting a Group}).
3159
3160 You can have as many summary buffers open as you wish.
3161
3162 @menu
3163 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3164 * Summary Maneuvering::         Moving around the summary buffer.
3165 * Choosing Articles::           Reading articles.
3166 * Paging the Article::          Scrolling the current article.
3167 * Reply Followup and Post::     Posting articles.
3168 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3169 * Marking Articles::            Marking articles as read, expirable, etc.
3170 * Limiting::                    You can limit the summary buffer.
3171 * Threading::                   How threads are made.
3172 * Sorting::                     How articles and threads are sorted.
3173 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3174 * Article Caching::             You may store articles in a cache.
3175 * Persistent Articles::         Making articles expiry-resistant.
3176 * Article Backlog::             Having already read articles hang around.
3177 * Saving Articles::             Ways of customizing article saving.
3178 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3179 * Article Treatment::           The article buffer can be mangled at will.
3180 * Article Commands::            Doing various things with the article buffer.
3181 * Summary Sorting::             Sorting the summary buffer in various ways.
3182 * Finding the Parent::          No child support? Get the parent.
3183 * Alternative Approaches::      Reading using non-default summaries.
3184 * Tree Display::                A more visual display of threads.
3185 * Mail Group Commands::         Some commands can only be used in mail groups.
3186 * Various Summary Stuff::       What didn't fit anywhere else.
3187 * Exiting the Summary Buffer::  Returning to the Group buffer.
3188 * Crosspost Handling::          How crossposted articles are dealt with.
3189 * Duplicate Suppression::       An alternative when crosspost handling fails.
3190 @end menu
3191
3192
3193 @node Summary Buffer Format
3194 @section Summary Buffer Format
3195 @cindex summary buffer format
3196
3197 @iftex
3198 @iflatex
3199 \gnusfigure{The Summary Buffer}{180}{
3200 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3201 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3202 }
3203 @end iflatex
3204 @end iftex
3205
3206 @menu
3207 * Summary Buffer Lines::     You can specify how summary lines should look.
3208 * Summary Buffer Mode Line:: You can say how the mode line should look.
3209 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3210 @end menu
3211
3212 @findex mail-extract-address-components
3213 @findex gnus-extract-address-components
3214 @vindex gnus-extract-address-components
3215 Gnus will use the value of the @code{gnus-extract-address-components}
3216 variable as a function for getting the name and address parts of a
3217 @code{From} header.  Two pre-defined functions exist:
3218 @code{gnus-extract-address-components}, which is the default, quite
3219 fast, and too simplistic solution; and
3220 @code{mail-extract-address-components}, which works very nicely, but is
3221 slower.  The default function will return the wrong answer in 5% of the
3222 cases.  If this is unacceptable to you, use the other function instead.
3223
3224 @vindex gnus-summary-same-subject
3225 @code{gnus-summary-same-subject} is a string indicating that the current
3226 article has the same subject as the previous.  This string will be used
3227 with those specs that require it.  The default is @code{""}.
3228
3229
3230 @node Summary Buffer Lines
3231 @subsection Summary Buffer Lines
3232
3233 @vindex gnus-summary-line-format
3234 You can change the format of the lines in the summary buffer by changing
3235 the @code{gnus-summary-line-format} variable.  It works along the same
3236 lines as a normal @code{format} string, with some extensions
3237 (@pxref{Formatting Variables}).
3238
3239 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3240
3241 The following format specification characters are understood:
3242
3243 @table @samp
3244 @item N
3245 Article number.
3246 @item S
3247 Subject string.
3248 @item s
3249 Subject if the article is the root of the thread or the previous article
3250 had a different subject, @code{gnus-summary-same-subject} otherwise.
3251 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3252 @item F
3253 Full @code{From} header.
3254 @item n
3255 The name (from the @code{From} header).
3256 @item a
3257 The name (from the @code{From} header).  This differs from the @code{n}
3258 spec in that it uses the function designated by the
3259 @code{gnus-extract-address-components} variable, which is slower, but
3260 may be more thorough.
3261 @item A
3262 The address (from the @code{From} header).  This works the same way as
3263 the @code{a} spec.
3264 @item L
3265 Number of lines in the article.
3266 @item c
3267 Number of characters in the article.
3268 @item I
3269 Indentation based on thread level (@pxref{Customizing Threading}).
3270 @item T
3271 Nothing if the article is a root and lots of spaces if it isn't (it
3272 pushes everything after it off the screen).
3273 @item [
3274 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3275 for adopted articles (@pxref{Customizing Threading}).
3276 @item ]
3277 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3278 for adopted articles.
3279 @item >
3280 One space for each thread level.
3281 @item <
3282 Twenty minus thread level spaces.
3283 @item U
3284 Unread.
3285
3286 @item R
3287 This misleadingly named specifier is the @dfn{secondary mark}.  This
3288 mark will say whether the article has been replied to, has been cached,
3289 or has been saved.  
3290
3291 @item i
3292 Score as a number (@pxref{Scoring}).
3293 @item z
3294 @vindex gnus-summary-zcore-fuzz
3295 Zcore, @samp{+} if above the default level and @samp{-} if below the
3296 default level.  If the difference between
3297 @code{gnus-summary-default-score} and the score is less than
3298 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3299 @item V
3300 Total thread score.
3301 @item x
3302 @code{Xref}.
3303 @item D
3304 @code{Date}.
3305 @item d
3306 The @code{Date} in @code{DD-MMM} format.
3307 @item o
3308 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3309 @item M
3310 @code{Message-ID}.
3311 @item r
3312 @code{References}.
3313 @item t
3314 Number of articles in the current sub-thread.  Using this spec will slow
3315 down summary buffer generation somewhat.
3316 @item e
3317 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3318 article has any children.
3319 @item P
3320 The line number.
3321 @item O
3322 Download mark.
3323 @item u
3324 User defined specifier.  The next character in the format string should
3325 be a letter.  Gnus will call the function
3326 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3327 following @samp{%u}.  The function will be passed the current header as
3328 argument.  The function should return a string, which will be inserted
3329 into the summary just like information from any other summary specifier.
3330 @end table
3331
3332 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3333 have to be handled with care.  For reasons of efficiency, Gnus will
3334 compute what column these characters will end up in, and ``hard-code''
3335 that.  This means that it is invalid to have these specs after a
3336 variable-length spec.  Well, you might not be arrested, but your summary
3337 buffer will look strange, which is bad enough.
3338
3339 The smart choice is to have these specs as far to the left as possible.
3340 (Isn't that the case with everything, though?  But I digress.)
3341
3342 This restriction may disappear in later versions of Gnus.
3343
3344
3345 @node Summary Buffer Mode Line
3346 @subsection Summary Buffer Mode Line
3347
3348 @vindex gnus-summary-mode-line-format
3349 You can also change the format of the summary mode bar (@pxref{Mode Line
3350 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
3351 like.  The default is @samp{Gnus: %%b [%A] %Z}.
3352
3353 Here are the elements you can play with:
3354
3355 @table @samp
3356 @item G
3357 Group name.
3358 @item p
3359 Unprefixed group name.
3360 @item A
3361 Current article number.
3362 @item z
3363 Current article score.
3364 @item V
3365 Gnus version.
3366 @item U
3367 Number of unread articles in this group.
3368 @item e
3369 Number of unread articles in this group that aren't displayed in the
3370 summary buffer.
3371 @item Z
3372 A string with the number of unread and unselected articles represented
3373 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3374 articles, and just as @samp{<%U more>} if there are just unread articles
3375 and no unselected ones.
3376 @item g
3377 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3378 shortened to @samp{r.a.anime}.
3379 @item S
3380 Subject of the current article.
3381 @item u
3382 User-defined spec (@pxref{User-Defined Specs}).
3383 @item s
3384 Name of the current score file (@pxref{Scoring}).
3385 @item d
3386 Number of dormant articles (@pxref{Unread Articles}).
3387 @item t
3388 Number of ticked articles (@pxref{Unread Articles}).
3389 @item r
3390 Number of articles that have been marked as read in this session.
3391 @item E
3392 Number of articles expunged by the score files.
3393 @end table
3394
3395
3396 @node Summary Highlighting
3397 @subsection Summary Highlighting
3398
3399 @table @code
3400
3401 @item gnus-visual-mark-article-hook
3402 @vindex gnus-visual-mark-article-hook
3403 This hook is run after selecting an article.  It is meant to be used for
3404 highlighting the article in some way.  It is not run if
3405 @code{gnus-visual} is @code{nil}.
3406
3407 @item gnus-summary-update-hook
3408 @vindex gnus-summary-update-hook
3409 This hook is called when a summary line is changed.  It is not run if
3410 @code{gnus-visual} is @code{nil}.
3411
3412 @item gnus-summary-selected-face
3413 @vindex gnus-summary-selected-face
3414 This is the face (or @dfn{font} as some people call it) used to
3415 highlight the current article in the summary buffer.
3416
3417 @item gnus-summary-highlight
3418 @vindex gnus-summary-highlight
3419 Summary lines are highlighted according to this variable, which is a
3420 list where the elements are of the format @var{(FORM . FACE)}.  If you
3421 would, for instance, like ticked articles to be italic and high-scored
3422 articles to be bold, you could set this variable to something like
3423 @lisp
3424 (((eq mark gnus-ticked-mark) . italic)
3425  ((> score default) . bold))
3426 @end lisp
3427 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3428 @var{FACE} will be applied to the line.
3429 @end table
3430
3431
3432 @node Summary Maneuvering
3433 @section Summary Maneuvering
3434 @cindex summary movement
3435
3436 All the straight movement commands understand the numeric prefix and
3437 behave pretty much as you'd expect.
3438
3439 None of these commands select articles.
3440
3441 @table @kbd
3442 @item G M-n
3443 @itemx M-n
3444 @kindex M-n (Summary)
3445 @kindex G M-n (Summary)
3446 @findex gnus-summary-next-unread-subject
3447 Go to the next summary line of an unread article
3448 (@code{gnus-summary-next-unread-subject}).
3449
3450 @item G M-p
3451 @itemx M-p
3452 @kindex M-p (Summary)
3453 @kindex G M-p (Summary)
3454 @findex gnus-summary-prev-unread-subject
3455 Go to the previous summary line of an unread article
3456 (@code{gnus-summary-prev-unread-subject}).
3457
3458 @item G j
3459 @itemx j
3460 @kindex j (Summary)
3461 @kindex G j (Summary)
3462 @findex gnus-summary-goto-article
3463 Ask for an article number or @code{Message-ID}, and then go to that
3464 article (@code{gnus-summary-goto-article}).
3465
3466 @item G g
3467 @kindex G g (Summary)
3468 @findex gnus-summary-goto-subject
3469 Ask for an article number and then go to the summary line of that article
3470 without displaying the article (@code{gnus-summary-goto-subject}).
3471 @end table
3472
3473 If Gnus asks you to press a key to confirm going to the next group, you
3474 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3475 buffer, searching for the next group to read without actually returning
3476 to the group buffer.
3477
3478 Variables related to summary movement:
3479
3480 @table @code
3481
3482 @vindex gnus-auto-select-next
3483 @item gnus-auto-select-next
3484 If you issue one of the movement commands (like @kbd{n}) and there are
3485 no more unread articles after the current one, Gnus will offer to go to
3486 the next group.  If this variable is @code{t} and the next group is
3487 empty, Gnus will exit summary mode and return to the group buffer.  If
3488 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3489 next group, no matter whether it has any unread articles or not.  As a
3490 special case, if this variable is @code{quietly}, Gnus will select the
3491 next group without asking for confirmation.  If this variable is
3492 @code{almost-quietly}, the same will happen only if you are located on
3493 the last article in the group.  Finally, if this variable is
3494 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3495 without confirmation.  Also @pxref{Group Levels}.
3496
3497 @item gnus-auto-select-same
3498 @vindex gnus-auto-select-same
3499 If non-@code{nil}, all the movement commands will try to go to the next
3500 article with the same subject as the current.  (@dfn{Same} here might
3501 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3502 for details (@pxref{Customizing Threading}).)  This variable is not
3503 particularly useful if you use a threaded display.
3504
3505 @item gnus-summary-check-current
3506 @vindex gnus-summary-check-current
3507 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3508 to the next (or previous) article if the current article is unread.
3509 Instead, they will choose the current article.
3510
3511 @item gnus-auto-center-summary
3512 @vindex gnus-auto-center-summary
3513 If non-@code{nil}, Gnus will keep the point in the summary buffer
3514 centered at all times.  This makes things quite tidy, but if you have a
3515 slow network connection, or simply do not like this un-Emacsism, you can
3516 set this variable to @code{nil} to get the normal Emacs scrolling
3517 action.  This will also inhibit horizontal re-centering of the summary
3518 buffer, which might make it more inconvenient to read extremely long
3519 threads.
3520
3521 @end table
3522
3523
3524 @node Choosing Articles
3525 @section Choosing Articles
3526 @cindex selecting articles
3527
3528 @menu
3529 * Choosing Commands::        Commands for choosing articles.
3530 * Choosing Variables::       Variables that influence these commands.
3531 @end menu
3532
3533
3534 @node Choosing Commands
3535 @subsection Choosing Commands
3536
3537 None of the following movement commands understand the numeric prefix,
3538 and they all select and display an article.
3539
3540 @table @kbd
3541 @item SPACE
3542 @kindex SPACE (Summary)
3543 @findex gnus-summary-next-page
3544 Select the current article, or, if that one's read already, the next
3545 unread article (@code{gnus-summary-next-page}).
3546
3547 @item G n
3548 @itemx n
3549 @kindex n (Summary)
3550 @kindex G n (Summary)
3551 @findex gnus-summary-next-unread-article
3552 @c @icon{gnus-summary-next-unread}
3553 Go to next unread article (@code{gnus-summary-next-unread-article}).
3554
3555 @item G p
3556 @itemx p
3557 @kindex p (Summary)
3558 @findex gnus-summary-prev-unread-article
3559 @c @icon{gnus-summary-prev-unread}
3560 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3561
3562 @item G N
3563 @itemx N
3564 @kindex N (Summary)
3565 @kindex G N (Summary)
3566 @findex gnus-summary-next-article
3567 Go to the next article (@code{gnus-summary-next-article}).
3568
3569 @item G P
3570 @itemx P
3571 @kindex P (Summary)
3572 @kindex G P (Summary)
3573 @findex gnus-summary-prev-article
3574 Go to the previous article (@code{gnus-summary-prev-article}).
3575
3576 @item G C-n
3577 @kindex G C-n (Summary)
3578 @findex gnus-summary-next-same-subject
3579 Go to the next article with the same subject
3580 (@code{gnus-summary-next-same-subject}).
3581
3582 @item G C-p
3583 @kindex G C-p (Summary)
3584 @findex gnus-summary-prev-same-subject
3585 Go to the previous article with the same subject
3586 (@code{gnus-summary-prev-same-subject}).
3587
3588 @item G f
3589 @itemx .
3590 @kindex G f  (Summary)
3591 @kindex .  (Summary)
3592 @findex gnus-summary-first-unread-article
3593 Go to the first unread article
3594 (@code{gnus-summary-first-unread-article}).
3595
3596 @item G b
3597 @itemx ,
3598 @kindex G b (Summary)
3599 @kindex , (Summary)
3600 @findex gnus-summary-best-unread-article
3601 Go to the article with the highest score
3602 (@code{gnus-summary-best-unread-article}).
3603
3604 @item G l
3605 @itemx l
3606 @kindex l (Summary)
3607 @kindex G l (Summary)
3608 @findex gnus-summary-goto-last-article
3609 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3610
3611 @item G o
3612 @kindex G o (Summary)
3613 @findex gnus-summary-pop-article
3614 @cindex history
3615 @cindex article history
3616 Pop an article off the summary history and go to this article
3617 (@code{gnus-summary-pop-article}).  This command differs from the
3618 command above in that you can pop as many previous articles off the
3619 history as you like, while @kbd{l} toggles the two last read articles.
3620 For a somewhat related issue (if you use these commands a lot),
3621 @pxref{Article Backlog}.
3622 @end table
3623
3624
3625 @node Choosing Variables
3626 @subsection Choosing Variables
3627
3628 Some variables relevant for moving and selecting articles:
3629
3630 @table @code
3631 @item gnus-auto-extend-newsgroup
3632 @vindex gnus-auto-extend-newsgroup
3633 All the movement commands will try to go to the previous (or next)
3634 article, even if that article isn't displayed in the Summary buffer if
3635 this variable is non-@code{nil}.  Gnus will then fetch the article from
3636 the server and display it in the article buffer.
3637
3638 @item gnus-select-article-hook
3639 @vindex gnus-select-article-hook
3640 This hook is called whenever an article is selected.  By default it
3641 exposes any threads hidden under the selected article.
3642
3643 @item gnus-mark-article-hook
3644 @vindex gnus-mark-article-hook
3645 @findex gnus-summary-mark-unread-as-read
3646 @findex gnus-summary-mark-read-and-unread-as-read
3647 @findex gnus-unread-mark
3648 This hook is called whenever an article is selected.  It is intended to
3649 be used for marking articles as read.  The default value is
3650 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3651 mark of almost any article you read to @code{gnus-unread-mark}.  The
3652 only articles not affected by this function are ticked, dormant, and
3653 expirable articles.  If you'd instead like to just have unread articles
3654 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3655 instead.  It will leave marks like @code{gnus-low-score-mark},
3656 @code{gnus-del-mark} (and so on) alone.
3657
3658 @end table
3659
3660
3661 @node Paging the Article
3662 @section Scrolling the Article
3663 @cindex article scrolling
3664
3665 @table @kbd
3666
3667 @item SPACE
3668 @kindex SPACE (Summary)
3669 @findex gnus-summary-next-page
3670 Pressing @kbd{SPACE} will scroll the current article forward one page,
3671 or, if you have come to the end of the current article, will choose the
3672 next article (@code{gnus-summary-next-page}).
3673
3674 @item DEL
3675 @kindex DEL (Summary)
3676 @findex gnus-summary-prev-page
3677 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3678
3679 @item RET
3680 @kindex RET (Summary)
3681 @findex gnus-summary-scroll-up
3682 Scroll the current article one line forward
3683 (@code{gnus-summary-scroll-up}).
3684
3685 @item A g
3686 @itemx g
3687 @kindex A g (Summary)
3688 @kindex g (Summary)
3689 @findex gnus-summary-show-article
3690 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3691 given a prefix, fetch the current article, but don't run any of the
3692 article treatment functions.  This will give you a ``raw'' article, just
3693 the way it came from the server.
3694
3695 @item A <
3696 @itemx <
3697 @kindex < (Summary)
3698 @kindex A < (Summary)
3699 @findex gnus-summary-beginning-of-article
3700 Scroll to the beginning of the article
3701 (@code{gnus-summary-beginning-of-article}).
3702
3703 @item A >
3704 @itemx >
3705 @kindex > (Summary)
3706 @kindex A > (Summary)
3707 @findex gnus-summary-end-of-article
3708 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3709
3710 @item A s
3711 @itemx s
3712 @kindex A s (Summary)
3713 @kindex s (Summary)
3714 @findex gnus-summary-isearch-article
3715 Perform an isearch in the article buffer
3716 (@code{gnus-summary-isearch-article}).
3717
3718 @item h
3719 @kindex h (Summary)
3720 @findex gnus-summary-select-article-buffer
3721 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3722
3723 @end table
3724
3725
3726 @node Reply Followup and Post
3727 @section Reply, Followup and Post
3728
3729 @menu
3730 * Summary Mail Commands::            Sending mail.
3731 * Summary Post Commands::            Sending news.
3732 @end menu
3733
3734
3735 @node Summary Mail Commands
3736 @subsection Summary Mail Commands
3737 @cindex mail
3738 @cindex composing mail
3739
3740 Commands for composing a mail message:
3741
3742 @table @kbd
3743
3744 @item S r
3745 @itemx r
3746 @kindex S r (Summary)
3747 @kindex r (Summary)
3748 @findex gnus-summary-reply
3749 @c @icon{gnus-summary-mail-reply}
3750 @c @icon{gnus-summary-reply}
3751 Mail a reply to the author of the current article
3752 (@code{gnus-summary-reply}).
3753
3754 @item S R
3755 @itemx R
3756 @kindex R (Summary)
3757 @kindex S R (Summary)
3758 @findex gnus-summary-reply-with-original
3759 @c @icon{gnus-summary-reply-with-original}
3760 Mail a reply to the author of the current article and include the
3761 original message (@code{gnus-summary-reply-with-original}).  This
3762 command uses the process/prefix convention.
3763
3764 @item S w
3765 @kindex S w (Summary)
3766 @findex gnus-summary-wide-reply
3767 Mail a wide reply to the author of the current article
3768 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3769 goes out to all people listed in the @code{To}, @code{From} (or
3770 @code{Reply-to}) and @code{Cc} headers.
3771
3772 @item S W
3773 @kindex S W (Summary)
3774 @findex gnus-summary-wide-reply-with-original
3775 Mail a wide reply to the current article and include the original
3776 message (@code{gnus-summary-reply-with-original}).  This command uses
3777 the process/prefix convention.
3778
3779 @item S o m
3780 @kindex S o m (Summary)
3781 @findex gnus-summary-mail-forward
3782 @c @icon{gnus-summary-mail-forward}
3783 Forward the current article to some other person
3784 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3785 headers of the forwarded article.
3786
3787 @item S m
3788 @itemx m
3789 @kindex m (Summary)
3790 @kindex S m (Summary)
3791 @findex gnus-summary-mail-other-window
3792 @c @icon{gnus-summary-mail-originate}
3793 Send a mail to some other person
3794 (@code{gnus-summary-mail-other-window}).
3795
3796 @item S D b
3797 @kindex S D b (Summary)
3798 @findex gnus-summary-resend-bounced-mail
3799 @cindex bouncing mail
3800 If you have sent a mail, but the mail was bounced back to you for some
3801 reason (wrong address, transient failure), you can use this command to
3802 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3803 will be popped into a mail buffer where you can edit the headers before
3804 sending the mail off again.  If you give a prefix to this command, and
3805 the bounced mail is a reply to some other mail, Gnus will try to fetch
3806 that mail and display it for easy perusal of its headers.  This might
3807 very well fail, though.
3808
3809 @item S D r
3810 @kindex S D r (Summary)
3811 @findex gnus-summary-resend-message
3812 Not to be confused with the previous command,
3813 @code{gnus-summary-resend-message} will prompt you for an address to
3814 send the current message off to, and then send it to that place.  The
3815 headers of the message won't be altered---but lots of headers that say
3816 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3817 means that you actually send a mail to someone that has a @code{To}
3818 header that (probably) points to yourself.  This will confuse people.
3819 So, natcherly you'll only do that if you're really eVIl.
3820
3821 This command is mainly used if you have several accounts and want to
3822 ship a mail to a different account of yours.  (If you're both
3823 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3824 to the @code{root} account, you may want to resend it to
3825 @code{postmaster}.  Ordnung muß sein!
3826
3827 This command understands the process/prefix convention
3828 (@pxref{Process/Prefix}).
3829
3830 @item S O m
3831 @kindex S O m (Summary)
3832 @findex gnus-uu-digest-mail-forward
3833 Digest the current series (@pxref{Decoding Articles}) and forward the
3834 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
3835 uses the process/prefix convention (@pxref{Process/Prefix}).
3836
3837 @item S M-c
3838 @kindex S M-c (Summary)
3839 @findex gnus-summary-mail-crosspost-complaint
3840 @cindex crossposting
3841 @cindex excessive crossposting
3842 Send a complaint about excessive crossposting to the author of the
3843 current article (@code{gnus-summary-mail-crosspost-complaint}).
3844
3845 @findex gnus-crosspost-complaint
3846 This command is provided as a way to fight back against the current
3847 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3848 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3849 command understands the process/prefix convention
3850 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3851
3852 @end table
3853
3854 Also @pxref{(message)Header Commands} for more information.
3855
3856
3857 @node Summary Post Commands
3858 @subsection Summary Post Commands
3859 @cindex post
3860 @cindex composing news
3861
3862 Commands for posting a news article:
3863
3864 @table @kbd
3865 @item S p
3866 @itemx a
3867 @kindex a (Summary)
3868 @kindex S p (Summary)
3869 @findex gnus-summary-post-news
3870 @c @icon{gnus-summary-post-news}
3871 Post an article to the current group
3872 (@code{gnus-summary-post-news}).
3873
3874 @item S f
3875 @itemx f
3876 @kindex f (Summary)
3877 @kindex S f (Summary)
3878 @findex gnus-summary-followup
3879 @c @icon{gnus-summary-followup}
3880 Post a followup to the current article (@code{gnus-summary-followup}).
3881
3882 @item S F
3883 @itemx F
3884 @kindex S F (Summary)
3885 @kindex F (Summary)
3886 @c @icon{gnus-summary-followup-with-original}
3887 @findex gnus-summary-followup-with-original
3888 Post a followup to the current article and include the original message
3889 (@code{gnus-summary-followup-with-original}).   This command uses the
3890 process/prefix convention.
3891
3892 @item S n
3893 @kindex S n (Summary)
3894 @findex gnus-summary-followup-to-mail
3895 Post a followup to the current article via news, even if you got the
3896 message through mail (@code{gnus-summary-followup-to-mail}).
3897
3898 @item S N
3899 @kindex S N (Summary)
3900 @findex gnus-summary-followup-to-mail-with-original
3901 Post a followup to the current article via news, even if you got the
3902 message through mail and include the original message
3903 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3904 the process/prefix convention.
3905
3906 @item S o p
3907 @kindex S o p (Summary)
3908 @findex gnus-summary-post-forward
3909 Forward the current article to a newsgroup
3910 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3911 headers of the forwarded article.
3912
3913 @item S O p
3914 @kindex S O p (Summary)
3915 @findex gnus-uu-digest-post-forward
3916 @cindex digests
3917 @cindex making digests
3918 Digest the current series and forward the result to a newsgroup
3919 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3920 process/prefix convention.
3921
3922 @item S u
3923 @kindex S u (Summary)
3924 @findex gnus-uu-post-news
3925 @c @icon{gnus-uu-post-news}
3926 Uuencode a file, split it into parts, and post it as a series
3927 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3928 @end table
3929
3930 Also @pxref{(message)Header Commands} for more information.
3931
3932
3933 @node Canceling and Superseding
3934 @section Canceling Articles
3935 @cindex canceling articles
3936 @cindex superseding articles
3937
3938 Have you ever written something, and then decided that you really,
3939 really, really wish you hadn't posted that?
3940
3941 Well, you can't cancel mail, but you can cancel posts.
3942
3943 @findex gnus-summary-cancel-article
3944 @kindex C (Summary)
3945 @c @icon{gnus-summary-cancel-article}
3946 Find the article you wish to cancel (you can only cancel your own
3947 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3948 c} (@code{gnus-summary-cancel-article}).  Your article will be
3949 canceled---machines all over the world will be deleting your article.
3950 This command uses the process/prefix convention (@pxref{Process/Prefix}).
3951
3952 Be aware, however, that not all sites honor cancels, so your article may
3953 live on here and there, while most sites will delete the article in
3954 question.
3955
3956 Gnus will use the ``current'' select method when canceling.  If you
3957 want to use the standard posting method, use the @samp{a} symbolic
3958 prefix (@pxref{Symbolic Prefixes}).
3959
3960 If you discover that you have made some mistakes and want to do some
3961 corrections, you can post a @dfn{superseding} article that will replace
3962 your original article.
3963
3964 @findex gnus-summary-supersede-article
3965 @kindex S (Summary)
3966 Go to the original article and press @kbd{S s}
3967 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3968 where you can edit the article all you want before sending it off the
3969 usual way.
3970
3971 The same goes for superseding as for canceling, only more so: Some
3972 sites do not honor superseding.  On those sites, it will appear that you
3973 have posted almost the same article twice.
3974
3975 If you have just posted the article, and change your mind right away,
3976 there is a trick you can use to cancel/supersede the article without
3977 waiting for the article to appear on your site first.  You simply return
3978 to the post buffer (which is called @code{*sent ...*}).  There you will
3979 find the article you just posted, with all the headers intact.  Change
3980 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3981 header by substituting one of those words for the word
3982 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3983 you would do normally.  The previous article will be
3984 canceled/superseded.
3985
3986 Just remember, kids: There is no 'c' in 'supersede'.
3987
3988
3989 @node Marking Articles
3990 @section Marking Articles
3991 @cindex article marking
3992 @cindex article ticking
3993 @cindex marks
3994
3995 There are several marks you can set on an article.
3996
3997 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3998 neologism ohoy!) of the article.  Alphabetic marks generally mean
3999 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4000
4001 In addition, you also have marks that do not affect readedness.
4002
4003 @menu
4004 * Unread Articles::      Marks for unread articles.
4005 * Read Articles::        Marks for read articles.
4006 * Other Marks::          Marks that do not affect readedness.
4007 @end menu
4008
4009 @ifinfo
4010 There's a plethora of commands for manipulating these marks:
4011 @end ifinfo
4012
4013 @menu
4014 * Setting Marks::           How to set and remove marks.
4015 * Setting Process Marks::   How to mark articles for later processing.
4016 @end menu
4017
4018
4019 @node Unread Articles
4020 @subsection Unread Articles
4021
4022 The following marks mark articles as (kinda) unread, in one form or
4023 other.
4024
4025 @table @samp
4026 @item !
4027 @vindex gnus-ticked-mark
4028 Marked as ticked (@code{gnus-ticked-mark}).
4029
4030 @dfn{Ticked articles} are articles that will remain visible always.  If
4031 you see an article that you find interesting, or you want to put off
4032 reading it, or replying to it, until sometime later, you'd typically
4033 tick it.  However, articles can be expired, so if you want to keep an
4034 article forever, you'll have to make it persistent (@pxref{Persistent
4035 Articles}).
4036
4037 @item ?
4038 @vindex gnus-dormant-mark
4039 Marked as dormant (@code{gnus-dormant-mark}).
4040
4041 @dfn{Dormant articles} will only appear in the summary buffer if there
4042 are followups to it.  If you want to see them even if they don't have
4043 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4044
4045 @item SPACE
4046 @vindex gnus-unread-mark
4047 Marked as unread (@code{gnus-unread-mark}).
4048
4049 @dfn{Unread articles} are articles that haven't been read at all yet.
4050 @end table
4051
4052
4053 @node Read Articles
4054 @subsection Read Articles
4055 @cindex expirable mark
4056
4057 All the following marks mark articles as read.
4058
4059 @table @samp
4060
4061 @item r
4062 @vindex gnus-del-mark
4063 These are articles that the user has marked as read with the @kbd{d}
4064 command manually, more or less (@code{gnus-del-mark}).
4065
4066 @item R
4067 @vindex gnus-read-mark
4068 Articles that have actually been read (@code{gnus-read-mark}).
4069
4070 @item O
4071 @vindex gnus-ancient-mark
4072 Articles that were marked as read in previous sessions and are now
4073 @dfn{old} (@code{gnus-ancient-mark}).
4074
4075 @item K
4076 @vindex gnus-killed-mark
4077 Marked as killed (@code{gnus-killed-mark}).
4078
4079 @item X
4080 @vindex gnus-kill-file-mark
4081 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4082
4083 @item Y
4084 @vindex gnus-low-score-mark
4085 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4086
4087 @item C
4088 @vindex gnus-catchup-mark
4089 Marked as read by a catchup (@code{gnus-catchup-mark}).
4090
4091 @item G
4092 @vindex gnus-canceled-mark
4093 Canceled article (@code{gnus-canceled-mark})
4094
4095 @item F
4096 @vindex gnus-souped-mark
4097 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4098
4099 @item Q
4100 @vindex gnus-sparse-mark
4101 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4102 Threading}.
4103
4104 @item M
4105 @vindex gnus-duplicate-mark
4106 Article marked as read by duplicate suppression
4107 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4108
4109 @end table
4110
4111 All these marks just mean that the article is marked as read, really.
4112 They are interpreted differently when doing adaptive scoring, though.
4113
4114 One more special mark, though:
4115
4116 @table @samp
4117 @item E
4118 @vindex gnus-expirable-mark
4119 Marked as expirable (@code{gnus-expirable-mark}).
4120
4121 Marking articles as @dfn{expirable} (or have them marked as such
4122 automatically) doesn't make much sense in normal groups---a user doesn't
4123 control expiring of news articles, but in mail groups, for instance,
4124 articles marked as @dfn{expirable} can be deleted by Gnus at
4125 any time.
4126 @end table
4127
4128
4129 @node Other Marks
4130 @subsection Other Marks
4131 @cindex process mark
4132 @cindex bookmarks
4133
4134 There are some marks that have nothing to do with whether the article is
4135 read or not.
4136
4137 @itemize @bullet
4138
4139 @item
4140 You can set a bookmark in the current article.  Say you are reading a
4141 long thesis on cats' urinary tracts, and have to go home for dinner
4142 before you've finished reading the thesis.  You can then set a bookmark
4143 in the article, and Gnus will jump to this bookmark the next time it
4144 encounters the article.  @xref{Setting Marks}
4145
4146 @item
4147 @vindex gnus-replied-mark
4148 All articles that you have replied to or made a followup to (i.e., have
4149 answered) will be marked with an @samp{A} in the second column
4150 (@code{gnus-replied-mark}).
4151
4152 @item
4153 @vindex gnus-cached-mark
4154 Articles stored in the article cache will be marked with an @samp{*} in
4155 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}
4156
4157 @item
4158 @vindex gnus-saved-mark
4159 Articles ``saved'' (in some manner or other; not necessarily
4160 religiously) are marked with an @samp{S} in the second column
4161 (@code{gnus-saved-mark}).
4162
4163 @item
4164 @vindex gnus-not-empty-thread-mark
4165 @vindex gnus-empty-thread-mark
4166 If the @samp{%e} spec is used, the presence of threads or not will be
4167 marked with @code{gnus-not-empty-thread-mark} and
4168 @code{gnus-empty-thread-mark} in the third column, respectively.
4169
4170 @item
4171 @vindex gnus-process-mark
4172 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4173 variety of commands react to the presence of the process mark.  For
4174 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4175 all articles that have been marked with the process mark.  Articles
4176 marked with the process mark have a @samp{#} in the second column.
4177
4178 @end itemize
4179
4180 You might have noticed that most of these ``non-readedness'' marks
4181 appear in the second column by default.  So if you have a cached, saved,
4182 replied article that you have process-marked, what will that look like?
4183
4184 Nothing much.  The precedence rules go as follows: process -> cache ->
4185 replied -> saved.  So if the article is in the cache and is replied,
4186 you'll only see the cache mark and not the replied mark.
4187
4188
4189 @node Setting Marks
4190 @subsection Setting Marks
4191 @cindex setting marks
4192
4193 All the marking commands understand the numeric prefix.
4194
4195 @table @kbd
4196 @item M c
4197 @itemx M-u
4198 @kindex M c (Summary)
4199 @kindex M-u (Summary)
4200 @findex gnus-summary-clear-mark-forward
4201 @cindex mark as unread
4202 Clear all readedness-marks from the current article
4203 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4204 article as unread.
4205
4206 @item M t
4207 @itemx !
4208 @kindex ! (Summary)
4209 @kindex M t (Summary)
4210 @findex gnus-summary-tick-article-forward
4211 Tick the current article (@code{gnus-summary-tick-article-forward}).
4212 @xref{Article Caching}
4213
4214 @item M ?
4215 @itemx ?
4216 @kindex ? (Summary)
4217 @kindex M ? (Summary)
4218 @findex gnus-summary-mark-as-dormant
4219 Mark the current article as dormant
4220 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}
4221
4222 @item M d
4223 @itemx d
4224 @kindex M d (Summary)
4225 @kindex d (Summary)
4226 @findex gnus-summary-mark-as-read-forward
4227 Mark the current article as read
4228 (@code{gnus-summary-mark-as-read-forward}).
4229
4230 @item D
4231 @kindex D (Summary)
4232 @findex gnus-summary-mark-as-read-backward
4233 Mark the current article as read and move point to the previous line
4234 (@code{gnus-summary-mark-as-read-backward}).
4235
4236 @item M k
4237 @itemx k
4238 @kindex k (Summary)
4239 @kindex M k (Summary)
4240 @findex gnus-summary-kill-same-subject-and-select
4241 Mark all articles that have the same subject as the current one as read,
4242 and then select the next unread article
4243 (@code{gnus-summary-kill-same-subject-and-select}).
4244
4245 @item M K
4246 @itemx C-k
4247 @kindex M K (Summary)
4248 @kindex C-k (Summary)
4249 @findex gnus-summary-kill-same-subject
4250 Mark all articles that have the same subject as the current one as read
4251 (@code{gnus-summary-kill-same-subject}).
4252
4253 @item M C
4254 @kindex M C (Summary)
4255 @findex gnus-summary-catchup
4256 @c @icon{gnus-summary-catchup}
4257 Mark all unread articles as read (@code{gnus-summary-catchup}).
4258
4259 @item M C-c
4260 @kindex M C-c (Summary)
4261 @findex gnus-summary-catchup-all
4262 Mark all articles in the group as read---even the ticked and dormant
4263 articles (@code{gnus-summary-catchup-all}).
4264
4265 @item M H
4266 @kindex M H (Summary)
4267 @findex gnus-summary-catchup-to-here
4268 Catchup the current group to point
4269 (@code{gnus-summary-catchup-to-here}).
4270
4271 @item C-w
4272 @kindex C-w (Summary)
4273 @findex gnus-summary-mark-region-as-read
4274 Mark all articles between point and mark as read
4275 (@code{gnus-summary-mark-region-as-read}).
4276
4277 @item M V k
4278 @kindex M V k (Summary)
4279 @findex gnus-summary-kill-below
4280 Kill all articles with scores below the default score (or below the
4281 numeric prefix) (@code{gnus-summary-kill-below}).
4282
4283 @item M e
4284 @itemx E
4285 @kindex M e (Summary)
4286 @kindex E (Summary)
4287 @findex gnus-summary-mark-as-expirable
4288 Mark the current article as expirable
4289 (@code{gnus-summary-mark-as-expirable}).
4290
4291 @item M b
4292 @kindex M b (Summary)
4293 @findex gnus-summary-set-bookmark
4294 Set a bookmark in the current article
4295 (@code{gnus-summary-set-bookmark}).
4296
4297 @item M B
4298 @kindex M B (Summary)
4299 @findex gnus-summary-remove-bookmark
4300 Remove the bookmark from the current article
4301 (@code{gnus-summary-remove-bookmark}).
4302
4303 @item M V c
4304 @kindex M V c (Summary)
4305 @findex gnus-summary-clear-above
4306 Clear all marks from articles with scores over the default score (or
4307 over the numeric prefix) (@code{gnus-summary-clear-above}).
4308
4309 @item M V u
4310 @kindex M V u (Summary)
4311 @findex gnus-summary-tick-above
4312 Tick all articles with scores over the default score (or over the
4313 numeric prefix) (@code{gnus-summary-tick-above}).
4314
4315 @item M V m
4316 @kindex M V m (Summary)
4317 @findex gnus-summary-mark-above
4318 Prompt for a mark, and mark all articles with scores over the default
4319 score (or over the numeric prefix) with this mark
4320 (@code{gnus-summary-clear-above}).
4321 @end table
4322
4323 @vindex gnus-summary-goto-unread
4324 The @code{gnus-summary-goto-unread} variable controls what action should
4325 be taken after setting a mark.  If non-@code{nil}, point will move to
4326 the next/previous unread article.  If @code{nil}, point will just move
4327 one line up or down.  As a special case, if this variable is
4328 @code{never}, all the marking commands as well as other commands (like
4329 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4330 The default is @code{t}.
4331
4332
4333 @node Setting Process Marks
4334 @subsection Setting Process Marks
4335 @cindex setting process marks
4336
4337 @table @kbd
4338
4339 @item M P p
4340 @itemx #
4341 @kindex # (Summary)
4342 @kindex M P p (Summary)
4343 @findex gnus-summary-mark-as-processable
4344 Mark the current article with the process mark
4345 (@code{gnus-summary-mark-as-processable}).
4346 @findex gnus-summary-unmark-as-processable
4347
4348 @item M P u
4349 @itemx M-#
4350 @kindex M P u (Summary)
4351 @kindex M-# (Summary)
4352 Remove the process mark, if any, from the current article
4353 (@code{gnus-summary-unmark-as-processable}).
4354
4355 @item M P U
4356 @kindex M P U (Summary)
4357 @findex gnus-summary-unmark-all-processable
4358 Remove the process mark from all articles
4359 (@code{gnus-summary-unmark-all-processable}).
4360
4361 @item M P i
4362 @kindex M P i (Summary)
4363 @findex gnus-uu-invert-processable
4364 Invert the list of process marked articles
4365 (@code{gnus-uu-invert-processable}).
4366
4367 @item M P R
4368 @kindex M P R (Summary)
4369 @findex gnus-uu-mark-by-regexp
4370 Mark articles that have a @code{Subject} header that matches a regular
4371 expression (@code{gnus-uu-mark-by-regexp}).
4372
4373 @item M P r
4374 @kindex M P r (Summary)
4375 @findex gnus-uu-mark-region
4376 Mark articles in region (@code{gnus-uu-mark-region}).
4377
4378 @item M P t
4379 @kindex M P t (Summary)
4380 @findex gnus-uu-mark-thread
4381 Mark all articles in the current (sub)thread
4382 (@code{gnus-uu-mark-thread}).
4383
4384 @item M P T
4385 @kindex M P T (Summary)
4386 @findex gnus-uu-unmark-thread
4387 Unmark all articles in the current (sub)thread
4388 (@code{gnus-uu-unmark-thread}).
4389
4390 @item M P v
4391 @kindex M P v (Summary)
4392 @findex gnus-uu-mark-over
4393 Mark all articles that have a score above the prefix argument
4394 (@code{gnus-uu-mark-over}).
4395
4396 @item M P s
4397 @kindex M P s (Summary)
4398 @findex gnus-uu-mark-series
4399 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4400
4401 @item M P S
4402 @kindex M P S (Summary)
4403 @findex gnus-uu-mark-sparse
4404 Mark all series that have already had some articles marked
4405 (@code{gnus-uu-mark-sparse}).
4406
4407 @item M P a
4408 @kindex M P a (Summary)
4409 @findex gnus-uu-mark-all
4410 Mark all articles in series order (@code{gnus-uu-mark-series}).
4411
4412 @item M P b
4413 @kindex M P b (Summary)
4414 @findex gnus-uu-mark-buffer
4415 Mark all articles in the buffer in the order they appear
4416 (@code{gnus-uu-mark-buffer}).
4417
4418 @item M P k
4419 @kindex M P k (Summary)
4420 @findex gnus-summary-kill-process-mark
4421 Push the current process mark set onto the stack and unmark all articles
4422 (@code{gnus-summary-kill-process-mark}).
4423
4424 @item M P y
4425 @kindex M P y (Summary)
4426 @findex gnus-summary-yank-process-mark
4427 Pop the previous process mark set from the stack and restore it
4428 (@code{gnus-summary-yank-process-mark}).
4429
4430 @item M P w
4431 @kindex M P w (Summary)
4432 @findex gnus-summary-save-process-mark
4433 Push the current process mark set onto the stack
4434 (@code{gnus-summary-save-process-mark}).
4435
4436 @end table
4437
4438
4439 @node Limiting
4440 @section Limiting
4441 @cindex limiting
4442
4443 It can be convenient to limit the summary buffer to just show some
4444 subset of the articles currently in the group.  The effect most limit
4445 commands have is to remove a few (or many) articles from the summary
4446 buffer.
4447
4448 All limiting commands work on subsets of the articles already fetched
4449 from the servers.  None of these commands query the server for
4450 additional articles.
4451
4452 @table @kbd
4453
4454 @item / /
4455 @itemx / s
4456 @kindex / / (Summary)
4457 @findex gnus-summary-limit-to-subject
4458 Limit the summary buffer to articles that match some subject
4459 (@code{gnus-summary-limit-to-subject}).
4460
4461 @item / a
4462 @kindex / a (Summary)
4463 @findex gnus-summary-limit-to-author
4464 Limit the summary buffer to articles that match some author
4465 (@code{gnus-summary-limit-to-author}).
4466
4467 @item / u
4468 @itemx x
4469 @kindex / u (Summary)
4470 @kindex x (Summary)
4471 @findex gnus-summary-limit-to-unread
4472 Limit the summary buffer to articles not marked as read
4473 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4474 buffer to articles strictly unread.  This means that ticked and
4475 dormant articles will also be excluded.
4476
4477 @item / m
4478 @kindex / m (Summary)
4479 @findex gnus-summary-limit-to-marks
4480 Ask for a mark and then limit to all articles that have been marked
4481 with that mark (@code{gnus-summary-limit-to-marks}).
4482
4483 @item / t
4484 @kindex / t (Summary)
4485 @findex gnus-summary-limit-to-age
4486 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4487 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4488 articles younger than that number of days.
4489
4490 @item / n
4491 @kindex / n (Summary)
4492 @findex gnus-summary-limit-to-articles
4493 Limit the summary buffer to the current article
4494 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4495 convention (@pxref{Process/Prefix}).
4496
4497 @item / w
4498 @kindex / w (Summary)
4499 @findex gnus-summary-pop-limit
4500 Pop the previous limit off the stack and restore it
4501 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4502 the stack.
4503
4504 @item / v
4505 @kindex / v (Summary)
4506 @findex gnus-summary-limit-to-score
4507 Limit the summary buffer to articles that have a score at or above some
4508 score (@code{gnus-summary-limit-to-score}).
4509
4510 @item / E
4511 @itemx M S
4512 @kindex M S (Summary)
4513 @kindex / E (Summary)
4514 @findex gnus-summary-limit-include-expunged
4515 Include all expunged articles in the limit
4516 (@code{gnus-summary-limit-include-expunged}).
4517
4518 @item / D
4519 @kindex / D (Summary)
4520 @findex gnus-summary-limit-include-dormant
4521 Include all dormant articles in the limit
4522 (@code{gnus-summary-limit-include-dormant}).
4523
4524 @item / *
4525 @kindex / * (Summary)
4526 @findex gnus-summary-limit-include-cached
4527 Include all cached articles in the limit
4528 (@code{gnus-summary-limit-include-cached}).
4529
4530 @item / d
4531 @kindex / d (Summary)
4532 @findex gnus-summary-limit-exclude-dormant
4533 Exclude all dormant articles from the limit
4534 (@code{gnus-summary-limit-exclude-dormant}).
4535
4536 @item / T
4537 @kindex / T (Summary)
4538 @findex gnus-summary-limit-include-thread
4539 Include all the articles in the current thread in the limit.
4540
4541 @item / c
4542 @kindex / c (Summary)
4543 @findex gnus-summary-limit-exclude-childless-dormant
4544 Exclude all dormant articles that have no children from the limit
4545 (@code{gnus-summary-limit-exclude-childless-dormant}).
4546
4547 @item / C
4548 @kindex / C (Summary)
4549 @findex gnus-summary-limit-mark-excluded-as-read
4550 Mark all excluded unread articles as read
4551 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4552 also mark excluded ticked and dormant articles as read.
4553
4554 @end table
4555
4556
4557 @node Threading
4558 @section Threading
4559 @cindex threading
4560 @cindex article threading
4561
4562 Gnus threads articles by default.  @dfn{To thread} is to put responses
4563 to articles directly after the articles they respond to---in a
4564 hierarchical fashion.
4565
4566 Threading is done by looking at the @code{References} headers of the
4567 articles.  In a perfect world, this would be enough to build pretty
4568 trees, but unfortunately, the @code{References} header is often broken
4569 or simply missing.  Weird news propagation excarcerbates the problem,
4570 so one has to employ other heuristics to get pleasing results.  A
4571 plethora of approaches exists, as detailed in horrible detail in
4572 @pxref{Customizing Threading}.
4573
4574 First, a quick overview of the concepts:
4575
4576 @table @dfn
4577 @item root
4578 The top-most article in a thread; the first article in the thread.
4579
4580 @item thread
4581 A tree-like article structure.
4582
4583 @item sub-thread
4584 A small(er) section of this tree-like structure.
4585
4586 @item loose threads
4587 Threads often lose their roots due to article expiry, or due to the root
4588 already having been read in a previous session, and not displayed in the
4589 summary buffer.  We then typically have many sub-threads that really
4590 belong to one thread, but are without connecting roots.  These are
4591 called loose threads.
4592
4593 @item thread gathering
4594 An attempt to gather loose threads into bigger threads.
4595
4596 @item sparse threads
4597 A thread where the missing articles have been ``guessed'' at, and are
4598 displayed as empty lines in the summary buffer.
4599
4600 @end table
4601
4602
4603 @menu
4604 * Customizing Threading::     Variables you can change to affect the threading.
4605 * Thread Commands::           Thread based commands in the summary buffer.
4606 @end menu
4607
4608
4609 @node Customizing Threading
4610 @subsection Customizing Threading
4611 @cindex customizing threading
4612
4613 @menu
4614 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
4615 * Filling In Threads::   Making the threads displayed look fuller.
4616 * More Threading::       Even more variables for fiddling with threads.
4617 * Low-Level Threading::  You thought it was over... but you were wrong!
4618 @end menu
4619
4620
4621 @node Loose Threads
4622 @subsubsection Loose Threads
4623 @cindex <
4624 @cindex >
4625 @cindex loose threads
4626
4627 @table @code
4628 @item gnus-summary-make-false-root
4629 @vindex gnus-summary-make-false-root
4630 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4631 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4632 Yup.)  Loose subtrees occur when the real root has expired, or you've
4633 read or killed the root in a previous session.
4634
4635 When there is no real root of a thread, Gnus will have to fudge
4636 something.  This variable says what fudging method Gnus should use.
4637 There are four possible values:
4638
4639 @iftex
4640 @iflatex
4641 \gnusfigure{The Summary Buffer}{390}{
4642 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4643 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4644 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4645 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4646 }
4647 @end iflatex
4648 @end iftex
4649
4650 @cindex adopting articles
4651
4652 @table @code
4653
4654 @item adopt
4655 Gnus will make the first of the orphaned articles the parent.  This
4656 parent will adopt all the other articles.  The adopted articles will be
4657 marked as such by pointy brackets (@samp{<>}) instead of the standard
4658 square brackets (@samp{[]}).  This is the default method.
4659
4660 @item dummy
4661 @vindex gnus-summary-dummy-line-format
4662 Gnus will create a dummy summary line that will pretend to be the
4663 parent.  This dummy line does not correspond to any real article, so
4664 selecting it will just select the first real article after the dummy
4665 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4666 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4667 which is the subject of the article.  @xref{Formatting Variables}.
4668
4669 @item empty
4670 Gnus won't actually make any article the parent, but simply leave the
4671 subject field of all orphans except the first empty.  (Actually, it will
4672 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4673 Buffer Format}).)
4674
4675 @item none
4676 Don't make any article parent at all.  Just gather the threads and
4677 display them after one another.
4678
4679 @item nil
4680 Don't gather loose threads.
4681 @end table
4682
4683 @item gnus-summary-gather-subject-limit
4684 @vindex gnus-summary-gather-subject-limit
4685 Loose threads are gathered by comparing subjects of articles.  If this
4686 variable is @code{nil}, Gnus requires an exact match between the
4687 subjects of the loose threads before gathering them into one big
4688 super-thread.  This might be too strict a requirement, what with the
4689 presence of stupid newsreaders that chop off long subject lines.  If
4690 you think so, set this variable to, say, 20 to require that only the
4691 first 20 characters of the subjects have to match.  If you set this
4692 variable to a really low number, you'll find that Gnus will gather
4693 everything in sight into one thread, which isn't very helpful.
4694
4695 @cindex fuzzy article gathering
4696 If you set this variable to the special value @code{fuzzy}, Gnus will
4697 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4698 Matching}).
4699
4700 @item gnus-simplify-subject-fuzzy-regexp
4701 @vindex gnus-simplify-subject-fuzzy-regexp
4702 This can either be a regular expression or list of regular expressions
4703 that match strings that will be removed from subjects if fuzzy subject
4704 simplification is used.
4705
4706 @item gnus-simplify-ignored-prefixes
4707 @vindex gnus-simplify-ignored-prefixes
4708 If you set @code{gnus-summary-gather-subject-limit} to something as low
4709 as 10, you might consider setting this variable to something sensible:
4710
4711 @c Written by Michael Ernst <mernst@cs.rice.edu>
4712 @lisp
4713 (setq gnus-simplify-ignored-prefixes
4714       (concat
4715        "\\`\\[?\\("
4716        (mapconcat
4717         'identity
4718         '("looking"
4719           "wanted" "followup" "summary\\( of\\)?"
4720           "help" "query" "problem" "question"
4721           "answer" "reference" "announce"
4722           "How can I" "How to" "Comparison of"
4723           ;; ...
4724           )
4725         "\\|")
4726        "\\)\\s *\\("
4727        (mapconcat 'identity
4728                   '("for" "for reference" "with" "about")
4729                   "\\|")
4730        "\\)?\\]?:?[ \t]*"))
4731 @end lisp
4732
4733 All words that match this regexp will be removed before comparing two
4734 subjects.
4735
4736 @item gnus-simplify-subject-functions
4737 @vindex gnus-simplify-subject-functions
4738 If non-@code{nil}, this variable overrides
4739 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4740 list of functions to apply to the @code{Subject} string iteratively to
4741 arrive at the simplified version of the string.
4742
4743 Useful functions to put in this list include:
4744
4745 @table @code
4746 @item gnus-simplify-subject-re
4747 @findex gnus-simplify-subject-re
4748 Strip the leading @samp{Re:}.
4749
4750 @item gnus-simplify-subject-fuzzy
4751 @findex gnus-simplify-subject-fuzzy
4752 Simplify fuzzily.
4753
4754 @item gnus-simplify-whitespace
4755 @findex gnus-simplify-whitespace
4756 Remove excessive whitespace.
4757 @end table
4758
4759 You may also write your own functions, of course.
4760
4761
4762 @item gnus-summary-gather-exclude-subject
4763 @vindex gnus-summary-gather-exclude-subject
4764 Since loose thread gathering is done on subjects only, that might lead
4765 to many false hits, especially with certain common subjects like
4766 @samp{} and @samp{(none)}.  To make the situation slightly better,
4767 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4768 what subjects should be excluded from the gathering process.@*
4769 The default is @samp{^ *$\\|^(none)$}.
4770
4771 @item gnus-summary-thread-gathering-function
4772 @vindex gnus-summary-thread-gathering-function
4773 Gnus gathers threads by looking at @code{Subject} headers.  This means
4774 that totally unrelated articles may end up in the same ``thread'', which
4775 is confusing.  An alternate approach is to look at all the
4776 @code{Message-ID}s in all the @code{References} headers to find matches.
4777 This will ensure that no gathered threads ever include unrelated
4778 articles, but it also means that people who have posted with broken
4779 newsreaders won't be gathered properly.  The choice is yours---plague or
4780 cholera:
4781
4782 @table @code
4783 @item gnus-gather-threads-by-subject
4784 @findex gnus-gather-threads-by-subject
4785 This function is the default gathering function and looks at
4786 @code{Subject}s exclusively.
4787
4788 @item gnus-gather-threads-by-references
4789 @findex gnus-gather-threads-by-references
4790 This function looks at @code{References} headers exclusively.
4791 @end table
4792
4793 If you want to test gathering by @code{References}, you could say
4794 something like:
4795
4796 @lisp
4797 (setq gnus-summary-thread-gathering-function
4798       'gnus-gather-threads-by-references)
4799 @end lisp
4800
4801 @end table
4802
4803
4804 @node Filling In Threads
4805 @subsubsection Filling In Threads
4806
4807 @table @code
4808 @item gnus-fetch-old-headers
4809 @vindex gnus-fetch-old-headers
4810 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4811 more old headers---headers to articles marked as read.  If you
4812 would like to display as few summary lines as possible, but still
4813 connect as many loose threads as possible, you should set this variable
4814 to @code{some} or a number.  If you set it to a number, no more than
4815 that number of extra old headers will be fetched.  In either case,
4816 fetching old headers only works if the backend you are using carries
4817 overview files---this would normally be @code{nntp}, @code{nnspool} and
4818 @code{nnml}.  Also remember that if the root of the thread has been
4819 expired by the server, there's not much Gnus can do about that.
4820
4821 This variable can also be set to @code{invisible}.  This won't have any
4822 visible effects, but is useful if you use the @kbd{A T} command a lot
4823 (@pxref{Finding the Parent}).
4824
4825 @item gnus-build-sparse-threads
4826 @vindex gnus-build-sparse-threads
4827 Fetching old headers can be slow.  A low-rent similar effect can be
4828 gotten by setting this variable to @code{some}.  Gnus will then look at
4829 the complete @code{References} headers of all articles and try to string
4830 together articles that belong in the same thread.  This will leave
4831 @dfn{gaps} in the threading display where Gnus guesses that an article
4832 is missing from the thread.  (These gaps appear like normal summary
4833 lines.  If you select a gap, Gnus will try to fetch the article in
4834 question.)  If this variable is @code{t}, Gnus will display all these
4835 ``gaps'' without regard for whether they are useful for completing the
4836 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4837 off sparse leaf nodes that don't lead anywhere.  This variable is
4838 @code{nil} by default.
4839
4840 @end table
4841
4842
4843 @node More Threading
4844 @subsubsection More Threading
4845
4846 @table @code
4847 @item gnus-show-threads
4848 @vindex gnus-show-threads
4849 If this variable is @code{nil}, no threading will be done, and all of
4850 the rest of the variables here will have no effect.  Turning threading
4851 off will speed group selection up a bit, but it is sure to make reading
4852 slower and more awkward.
4853
4854 @item gnus-thread-hide-subtree
4855 @vindex gnus-thread-hide-subtree
4856 If non-@code{nil}, all threads will be hidden when the summary buffer is
4857 generated.
4858
4859 @item gnus-thread-expunge-below
4860 @vindex gnus-thread-expunge-below
4861 All threads that have a total score (as defined by
4862 @code{gnus-thread-score-function}) less than this number will be
4863 expunged.  This variable is @code{nil} by default, which means that no
4864 threads are expunged.
4865
4866 @item gnus-thread-hide-killed
4867 @vindex gnus-thread-hide-killed
4868 if you kill a thread and this variable is non-@code{nil}, the subtree
4869 will be hidden.
4870
4871 @item gnus-thread-ignore-subject
4872 @vindex gnus-thread-ignore-subject
4873 Sometimes somebody changes the subject in the middle of a thread.  If
4874 this variable is non-@code{nil}, the subject change is ignored.  If it
4875 is @code{nil}, which is the default, a change in the subject will result
4876 in a new thread.
4877
4878 @item gnus-thread-indent-level
4879 @vindex gnus-thread-indent-level
4880 This is a number that says how much each sub-thread should be indented.
4881 The default is 4.
4882
4883 @end table
4884
4885
4886 @node Low-Level Threading
4887 @subsubsection Low-Level Threading
4888
4889 @table @code
4890
4891 @item gnus-parse-headers-hook
4892 @vindex gnus-parse-headers-hook
4893 Hook run before parsing any headers.  The default value is
4894 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4895 slightly decoded in a hackish way.  This is likely to change in the
4896 future when Gnus becomes @sc{MIME}ified.
4897
4898 @item gnus-alter-header-function
4899 @vindex gnus-alter-header-function
4900 If non-@code{nil}, this function will be called to allow alteration of
4901 article header structures.  The function is called with one parameter,
4902 the article header vector, which it may alter in any way.  For instance,
4903 if you have a mail-to-news gateway which alters the @code{Message-ID}s
4904 in systematic ways (by adding prefixes and such), you can use this
4905 variable to un-scramble the @code{Message-ID}s so that they are more
4906 meaningful.  Here's one example:
4907
4908 @lisp
4909 (setq gnus-alter-header-function 'my-alter-message-id)
4910
4911 (defun my-alter-message-id (header)
4912   (let ((id (mail-header-id header)))
4913     (when (string-match
4914            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
4915       (mail-header-set-id
4916        (concat (match-string 1 id) "@@" (match-string 2 id))
4917        header))))
4918 @end lisp
4919
4920 @end table
4921
4922
4923 @node Thread Commands
4924 @subsection Thread Commands
4925 @cindex thread commands
4926
4927 @table @kbd
4928
4929 @item T k
4930 @itemx M-C-k
4931 @kindex T k (Summary)
4932 @kindex M-C-k (Summary)
4933 @findex gnus-summary-kill-thread
4934 Mark all articles in the current (sub-)thread as read
4935 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4936 remove all marks instead.  If the prefix argument is negative, tick
4937 articles instead.
4938
4939 @item T l
4940 @itemx M-C-l
4941 @kindex T l (Summary)
4942 @kindex M-C-l (Summary)
4943 @findex gnus-summary-lower-thread
4944 Lower the score of the current (sub-)thread
4945 (@code{gnus-summary-lower-thread}).
4946
4947 @item T i
4948 @kindex T i (Summary)
4949 @findex gnus-summary-raise-thread
4950 Increase the score of the current (sub-)thread
4951 (@code{gnus-summary-raise-thread}).
4952
4953 @item T #
4954 @kindex T # (Summary)
4955 @findex gnus-uu-mark-thread
4956 Set the process mark on the current (sub-)thread
4957 (@code{gnus-uu-mark-thread}).
4958
4959 @item T M-#
4960 @kindex T M-# (Summary)
4961 @findex gnus-uu-unmark-thread
4962 Remove the process mark from the current (sub-)thread
4963 (@code{gnus-uu-unmark-thread}).
4964
4965 @item T T
4966 @kindex T T (Summary)
4967 @findex gnus-summary-toggle-threads
4968 Toggle threading (@code{gnus-summary-toggle-threads}).
4969
4970 @item T s
4971 @kindex T s (Summary)
4972 @findex gnus-summary-show-thread
4973 Expose the (sub-)thread hidden under the current article, if any
4974 (@code{gnus-summary-show-thread}).
4975
4976 @item T h
4977 @kindex T h (Summary)
4978 @findex gnus-summary-hide-thread
4979 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4980
4981 @item T S
4982 @kindex T S (Summary)
4983 @findex gnus-summary-show-all-threads
4984 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4985
4986 @item T H
4987 @kindex T H (Summary)
4988 @findex gnus-summary-hide-all-threads
4989 Hide all threads (@code{gnus-summary-hide-all-threads}).
4990
4991 @item T t
4992 @kindex T t (Summary)
4993 @findex gnus-summary-rethread-current
4994 Re-thread the current article's thread
4995 (@code{gnus-summary-rethread-current}).  This works even when the
4996 summary buffer is otherwise unthreaded.
4997
4998 @item T ^
4999 @kindex T ^ (Summary)
5000 @findex gnus-summary-reparent-thread
5001 Make the current article the child of the marked (or previous) article
5002 (@code{gnus-summary-reparent-thread}).
5003
5004 @end table
5005
5006 The following commands are thread movement commands.  They all
5007 understand the numeric prefix.
5008
5009 @table @kbd
5010
5011 @item T n
5012 @kindex T n (Summary)
5013 @findex gnus-summary-next-thread
5014 Go to the next thread (@code{gnus-summary-next-thread}).
5015
5016 @item T p
5017 @kindex T p (Summary)
5018 @findex gnus-summary-prev-thread
5019 Go to the previous thread (@code{gnus-summary-prev-thread}).
5020
5021 @item T d
5022 @kindex T d (Summary)
5023 @findex gnus-summary-down-thread
5024 Descend the thread (@code{gnus-summary-down-thread}).
5025
5026 @item T u
5027 @kindex T u (Summary)
5028 @findex gnus-summary-up-thread
5029 Ascend the thread (@code{gnus-summary-up-thread}).
5030
5031 @item T o
5032 @kindex T o (Summary)
5033 @findex gnus-summary-top-thread
5034 Go to the top of the thread (@code{gnus-summary-top-thread}).
5035 @end table
5036
5037 @vindex gnus-thread-operation-ignore-subject
5038 If you ignore subject while threading, you'll naturally end up with
5039 threads that have several different subjects in them.  If you then issue
5040 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5041 wish to kill the entire thread, but just those parts of the thread that
5042 have the same subject as the current article.  If you like this idea,
5043 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
5044 is non-@code{nil} (which it is by default), subjects will be ignored
5045 when doing thread commands.  If this variable is @code{nil}, articles in
5046 the same thread with different subjects will not be included in the
5047 operation in question.  If this variable is @code{fuzzy}, only articles
5048 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5049 Matching}).
5050
5051
5052 @node Sorting
5053 @section Sorting
5054
5055 @findex gnus-thread-sort-by-total-score
5056 @findex gnus-thread-sort-by-date
5057 @findex gnus-thread-sort-by-score
5058 @findex gnus-thread-sort-by-subject
5059 @findex gnus-thread-sort-by-author
5060 @findex gnus-thread-sort-by-number
5061 @vindex gnus-thread-sort-functions
5062 If you are using a threaded summary display, you can sort the threads by
5063 setting @code{gnus-thread-sort-functions}, which is a list of functions.
5064 By default, sorting is done on article numbers.  Ready-made sorting
5065 predicate functions include @code{gnus-thread-sort-by-number},
5066 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5067 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5068 @code{gnus-thread-sort-by-total-score}.
5069
5070 Each function takes two threads and returns non-@code{nil} if the first
5071 thread should be sorted before the other.  Note that sorting really is
5072 normally done by looking only at the roots of each thread.  If you use
5073 more than one function, the primary sort key should be the last function
5074 in the list.  You should probably always include
5075 @code{gnus-thread-sort-by-number} in the list of sorting
5076 functions---preferably first.  This will ensure that threads that are
5077 equal with respect to the other sort criteria will be displayed in
5078 ascending article order.
5079
5080 If you would like to sort by score, then by subject, and finally by
5081 number, you could do something like:
5082
5083 @lisp
5084 (setq gnus-thread-sort-functions
5085       '(gnus-thread-sort-by-number
5086         gnus-thread-sort-by-subject
5087         gnus-thread-sort-by-total-score))
5088 @end lisp
5089
5090 The threads that have highest score will be displayed first in the
5091 summary buffer.  When threads have the same score, they will be sorted
5092 alphabetically.  The threads that have the same score and the same
5093 subject will be sorted by number, which is (normally) the sequence in
5094 which the articles arrived.
5095
5096 If you want to sort by score and then reverse arrival order, you could
5097 say something like:
5098
5099 @lisp
5100 (setq gnus-thread-sort-functions
5101       '((lambda (t1 t2)
5102           (not (gnus-thread-sort-by-number t1 t2)))
5103         gnus-thread-sort-by-score))
5104 @end lisp
5105
5106 @vindex gnus-thread-score-function
5107 The function in the @code{gnus-thread-score-function} variable (default
5108 @code{+}) is used for calculating the total score of a thread.  Useful
5109 functions might be @code{max}, @code{min}, or squared means, or whatever
5110 tickles your fancy.
5111
5112 @findex gnus-article-sort-functions
5113 @findex gnus-article-sort-by-date
5114 @findex gnus-article-sort-by-score
5115 @findex gnus-article-sort-by-subject
5116 @findex gnus-article-sort-by-author
5117 @findex gnus-article-sort-by-number
5118 If you are using an unthreaded display for some strange reason or other,
5119 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5120 It is very similar to the @code{gnus-thread-sort-functions}, except that
5121 it uses slightly different functions for article comparison.  Available
5122 sorting predicate functions are @code{gnus-article-sort-by-number},
5123 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5124 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5125
5126 If you want to sort an unthreaded summary display by subject, you could
5127 say something like:
5128
5129 @lisp
5130 (setq gnus-article-sort-functions
5131       '(gnus-article-sort-by-number
5132         gnus-article-sort-by-subject))
5133 @end lisp
5134
5135
5136
5137 @node Asynchronous Fetching
5138 @section Asynchronous Article Fetching
5139 @cindex asynchronous article fetching
5140 @cindex article pre-fetch
5141 @cindex pre-fetch
5142
5143 If you read your news from an @sc{nntp} server that's far away, the
5144 network latencies may make reading articles a chore.  You have to wait
5145 for a while after pressing @kbd{n} to go to the next article before the
5146 article appears.  Why can't Gnus just go ahead and fetch the article
5147 while you are reading the previous one?  Why not, indeed.
5148
5149 First, some caveats.  There are some pitfalls to using asynchronous
5150 article fetching, especially the way Gnus does it.
5151
5152 Let's say you are reading article 1, which is short, and article 2 is
5153 quite long, and you are not interested in reading that.  Gnus does not
5154 know this, so it goes ahead and fetches article 2.  You decide to read
5155 article 3, but since Gnus is in the process of fetching article 2, the
5156 connection is blocked.
5157
5158 To avoid these situations, Gnus will open two (count 'em two)
5159 connections to the server.  Some people may think this isn't a very nice
5160 thing to do, but I don't see any real alternatives.  Setting up that
5161 extra connection takes some time, so Gnus startup will be slower.
5162
5163 Gnus will fetch more articles than you will read.  This will mean that
5164 the link between your machine and the @sc{nntp} server will become more
5165 loaded than if you didn't use article pre-fetch.  The server itself will
5166 also become more loaded---both with the extra article requests, and the
5167 extra connection.
5168
5169 Ok, so now you know that you shouldn't really use this thing...  unless
5170 you really want to.
5171
5172 @vindex gnus-asynchronous
5173 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5174 happen automatically.
5175
5176 @vindex gnus-use-article-prefetch
5177 You can control how many articles are to be pre-fetched by setting
5178 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5179 that when you read an article in the group, the backend will pre-fetch
5180 the next 30 articles.  If this variable is @code{t}, the backend will
5181 pre-fetch all the articles it can without bound.  If it is
5182 @code{nil}, no pre-fetching will be done.
5183
5184 @vindex gnus-async-prefetch-article-p
5185 @findex gnus-async-read-p
5186 There are probably some articles that you don't want to pre-fetch---read
5187 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5188 return non-@code{nil} when the article in question is to be
5189 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5190 @code{nil} on read articles.  The function is called with an article
5191 data structure as the only parameter.
5192
5193 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5194
5195 @lisp
5196 (defun my-async-short-unread-p (data)
5197   "Return non-nil for short, unread articles."
5198   (and (gnus-data-unread-p data)
5199        (< (mail-header-lines (gnus-data-header data))
5200           100)))
5201
5202 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5203 @end lisp
5204
5205 These functions will be called many, many times, so they should
5206 preferably be short and sweet to avoid slowing down Gnus too much.
5207 It's probably a good idea to byte-compile things like this.
5208
5209 @vindex gnus-prefetched-article-deletion-strategy
5210 Articles have to be removed from the asynch buffer sooner or later.  The
5211 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5212 articles.  This is a list that may contain the following elements:
5213
5214 @table @code
5215 @item read
5216 Remove articles when they are read.
5217
5218 @item exit
5219 Remove articles when exiting the group.
5220 @end table
5221
5222 The default value is @code{(read exit)}.
5223
5224 @vindex gnus-use-header-prefetch
5225 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5226 from the next group.
5227
5228
5229 @node Article Caching
5230 @section Article Caching
5231 @cindex article caching
5232 @cindex caching
5233
5234 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5235 consider turning article caching on.  Each article will then be stored
5236 locally under your home directory.  As you may surmise, this could
5237 potentially use @emph{huge} amounts of disk space, as well as eat up all
5238 your inodes so fast it will make your head swim.  In vodka.
5239
5240 Used carefully, though, it could be just an easier way to save articles.
5241
5242 @vindex gnus-use-long-file-name
5243 @vindex gnus-cache-directory
5244 @vindex gnus-use-cache
5245 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5246 all articles ticked or marked as dormant will then be copied
5247 over to your local cache (@code{gnus-cache-directory}).  Whether this
5248 cache is flat or hierarchal is controlled by the
5249 @code{gnus-use-long-file-name} variable, as usual.
5250
5251 When re-selecting a ticked or dormant article, it will be fetched from the
5252 cache instead of from the server.  As articles in your cache will never
5253 expire, this might serve as a method of saving articles while still
5254 keeping them where they belong.  Just mark all articles you want to save
5255 as dormant, and don't worry.
5256
5257 When an article is marked as read, is it removed from the cache.
5258
5259 @vindex gnus-cache-remove-articles
5260 @vindex gnus-cache-enter-articles
5261 The entering/removal of articles from the cache is controlled by the
5262 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5263 variables.  Both are lists of symbols.  The first is @code{(ticked
5264 dormant)} by default, meaning that ticked and dormant articles will be
5265 put in the cache.  The latter is @code{(read)} by default, meaning that
5266 articles marked as read are removed from the cache.  Possibly
5267 symbols in these two lists are @code{ticked}, @code{dormant},
5268 @code{unread} and @code{read}.
5269
5270 @findex gnus-jog-cache
5271 So where does the massive article-fetching and storing come into the
5272 picture?  The @code{gnus-jog-cache} command will go through all
5273 subscribed newsgroups, request all unread articles, score them, and
5274 store them in the cache.  You should only ever, ever ever ever, use this
5275 command if 1) your connection to the @sc{nntp} server is really, really,
5276 really slow and 2) you have a really, really, really huge disk.
5277 Seriously.  One way to cut down on the number of articles downloaded is
5278 to score unwanted articles down and have them marked as read.  They will
5279 not then be downloaded by this command.
5280
5281 @vindex gnus-uncacheable-groups
5282 It is likely that you do not want caching on some groups.  For instance,
5283 if your @code{nnml} mail is located under your home directory, it makes no
5284 sense to cache it somewhere else under your home directory.  Unless you
5285 feel that it's neat to use twice as much space.  To limit the caching,
5286 you could set the @code{gnus-uncacheable-groups} regexp to
5287 @samp{^nnml}, for instance.  This variable is @code{nil} by
5288 default.
5289
5290 @findex gnus-cache-generate-nov-databases
5291 @findex gnus-cache-generate-active
5292 @vindex gnus-cache-active-file
5293 The cache stores information on what articles it contains in its active
5294 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5295 of the cache) becomes all messed up for some reason or other, Gnus
5296 offers two functions that will try to set things right.  @kbd{M-x
5297 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5298 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5299 file.
5300
5301
5302 @node Persistent Articles
5303 @section Persistent Articles
5304 @cindex persistent articles
5305
5306 Closely related to article caching, we have @dfn{persistent articles}.
5307 In fact, it's just a different way of looking at caching, and much more
5308 useful in my opinion.
5309
5310 Say you're reading a newsgroup, and you happen on to some valuable gem
5311 that you want to keep and treasure forever.  You'd normally just save it
5312 (using one of the many saving commands) in some file.  The problem with
5313 that is that it's just, well, yucky.  Ideally you'd prefer just having
5314 the article remain in the group where you found it forever; untouched by
5315 the expiry going on at the news server.
5316
5317 This is what a @dfn{persistent article} is---an article that just won't
5318 be deleted.  It's implemented using the normal cache functions, but
5319 you use two explicit commands for managing persistent articles:
5320
5321 @table @kbd
5322
5323 @item *
5324 @kindex * (Summary)
5325 @findex gnus-cache-enter-article
5326 Make the current article persistent (@code{gnus-cache-enter-article}).
5327
5328 @item M-*
5329 @kindex M-* (Summary)
5330 @findex gnus-cache-remove-article
5331 Remove the current article from the persistent articles
5332 (@code{gnus-cache-remove-article}).  This will normally delete the
5333 article.
5334 @end table
5335
5336 Both these commands understand the process/prefix convention.
5337
5338 To avoid having all ticked articles (and stuff) entered into the cache,
5339 you should set @code{gnus-use-cache} to @code{passive} if you're just
5340 interested in persistent articles:
5341
5342 @lisp
5343 (setq gnus-use-cache 'passive)
5344 @end lisp
5345
5346
5347 @node Article Backlog
5348 @section Article Backlog
5349 @cindex backlog
5350 @cindex article backlog
5351
5352 If you have a slow connection, but the idea of using caching seems
5353 unappealing to you (and it is, really), you can help the situation some
5354 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5355 already read articles so that it doesn't have to re-fetch articles
5356 you've already read.  This only helps if you are in the habit of
5357 re-selecting articles you've recently read, of course.  If you never do
5358 that, turning the backlog on will slow Gnus down a little bit, and
5359 increase memory usage some.
5360
5361 @vindex gnus-keep-backlog
5362 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5363 at most @var{n} old articles in a buffer for later re-fetching.  If this
5364 variable is non-@code{nil} and is not a number, Gnus will store
5365 @emph{all} read articles, which means that your Emacs will grow without
5366 bound before exploding and taking your machine down with you.  I put
5367 that in there just to keep y'all on your toes.
5368
5369 This variable is @code{nil} by default.
5370
5371
5372 @node Saving Articles
5373 @section Saving Articles
5374 @cindex saving articles
5375
5376 Gnus can save articles in a number of ways.  Below is the documentation
5377 for saving articles in a fairly straight-forward fashion (i.e., little
5378 processing of the article is done before it is saved).  For a different
5379 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5380 (@pxref{Decoding Articles}).
5381
5382 @vindex gnus-save-all-headers
5383 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5384 unwanted headers before saving the article.
5385
5386 @vindex gnus-saved-headers
5387 If the preceding variable is @code{nil}, all headers that match the
5388 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5389 deleted before saving.
5390
5391 @table @kbd
5392
5393 @item O o
5394 @itemx o
5395 @kindex O o (Summary)
5396 @kindex o (Summary)
5397 @findex gnus-summary-save-article
5398 @c @icon{gnus-summary-save-article}
5399 Save the current article using the default article saver
5400 (@code{gnus-summary-save-article}).
5401
5402 @item O m
5403 @kindex O m (Summary)
5404 @findex gnus-summary-save-article-mail
5405 Save the current article in mail format
5406 (@code{gnus-summary-save-article-mail}).
5407
5408 @item O r
5409 @kindex O r (Summary)
5410 @findex gnus-summary-save-article-rmail
5411 Save the current article in rmail format
5412 (@code{gnus-summary-save-article-rmail}).
5413
5414 @item O f
5415 @kindex O f (Summary)
5416 @findex gnus-summary-save-article-file
5417 @c @icon{gnus-summary-save-article-file}
5418 Save the current article in plain file format
5419 (@code{gnus-summary-save-article-file}).
5420
5421 @item O F
5422 @kindex O F (Summary)
5423 @findex gnus-summary-write-article-file
5424 Write the current article in plain file format, overwriting any previous
5425 file contents (@code{gnus-summary-write-article-file}).
5426
5427 @item O b
5428 @kindex O b (Summary)
5429 @findex gnus-summary-save-article-body-file
5430 Save the current article body in plain file format
5431 (@code{gnus-summary-save-article-body-file}).
5432
5433 @item O h
5434 @kindex O h (Summary)
5435 @findex gnus-summary-save-article-folder
5436 Save the current article in mh folder format
5437 (@code{gnus-summary-save-article-folder}).
5438
5439 @item O v
5440 @kindex O v (Summary)
5441 @findex gnus-summary-save-article-vm
5442 Save the current article in a VM folder
5443 (@code{gnus-summary-save-article-vm}).
5444
5445 @item O p
5446 @kindex O p (Summary)
5447 @findex gnus-summary-pipe-output
5448 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5449 the current article to a process (@code{gnus-summary-pipe-output}).
5450 @end table
5451
5452 @vindex gnus-prompt-before-saving
5453 All these commands use the process/prefix convention
5454 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5455 functions, you might get tired of being prompted for files to save each
5456 and every article in.  The prompting action is controlled by
5457 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5458 default, giving you that excessive prompting action you know and
5459 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5460 just once for each series of articles you save.  If you like to really
5461 have Gnus do all your thinking for you, you can even set this variable
5462 to @code{nil}, which means that you will never be prompted for files to
5463 save articles in.  Gnus will simply save all the articles in the default
5464 files.
5465
5466
5467 @vindex gnus-default-article-saver
5468 You can customize the @code{gnus-default-article-saver} variable to make
5469 Gnus do what you want it to.  You can use any of the four ready-made
5470 functions below, or you can create your own.
5471
5472 @table @code
5473
5474 @item gnus-summary-save-in-rmail
5475 @findex gnus-summary-save-in-rmail
5476 @vindex gnus-rmail-save-name
5477 @findex gnus-plain-save-name
5478 This is the default format, @dfn{babyl}.  Uses the function in the
5479 @code{gnus-rmail-save-name} variable to get a file name to save the
5480 article in.  The default is @code{gnus-plain-save-name}.
5481
5482 @item gnus-summary-save-in-mail
5483 @findex gnus-summary-save-in-mail
5484 @vindex gnus-mail-save-name
5485 Save in a Unix mail (mbox) file.  Uses the function in the
5486 @code{gnus-mail-save-name} variable to get a file name to save the
5487 article in.  The default is @code{gnus-plain-save-name}.
5488
5489 @item gnus-summary-save-in-file
5490 @findex gnus-summary-save-in-file
5491 @vindex gnus-file-save-name
5492 @findex gnus-numeric-save-name
5493 Append the article straight to an ordinary file.  Uses the function in
5494 the @code{gnus-file-save-name} variable to get a file name to save the
5495 article in.  The default is @code{gnus-numeric-save-name}.
5496
5497 @item gnus-summary-save-body-in-file
5498 @findex gnus-summary-save-body-in-file
5499 Append the article body to an ordinary file.  Uses the function in the
5500 @code{gnus-file-save-name} variable to get a file name to save the
5501 article in.  The default is @code{gnus-numeric-save-name}.
5502
5503 @item gnus-summary-save-in-folder
5504 @findex gnus-summary-save-in-folder
5505 @findex gnus-folder-save-name
5506 @findex gnus-Folder-save-name
5507 @vindex gnus-folder-save-name
5508 @cindex rcvstore
5509 @cindex MH folders
5510 Save the article to an MH folder using @code{rcvstore} from the MH
5511 library.  Uses the function in the @code{gnus-folder-save-name} variable
5512 to get a file name to save the article in.  The default is
5513 @code{gnus-folder-save-name}, but you can also use
5514 @code{gnus-Folder-save-name}, which creates capitalized names.
5515
5516 @item gnus-summary-save-in-vm
5517 @findex gnus-summary-save-in-vm
5518 Save the article in a VM folder.  You have to have the VM mail
5519 reader to use this setting.
5520 @end table
5521
5522 @vindex gnus-article-save-directory
5523 All of these functions, except for the last one, will save the article
5524 in the @code{gnus-article-save-directory}, which is initialized from the
5525 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5526 default.
5527
5528 As you can see above, the functions use different functions to find a
5529 suitable name of a file to save the article in.  Below is a list of
5530 available functions that generate names:
5531
5532 @table @code
5533
5534 @item gnus-Numeric-save-name
5535 @findex gnus-Numeric-save-name
5536 File names like @file{~/News/Alt.andrea-dworkin/45}.
5537
5538 @item gnus-numeric-save-name
5539 @findex gnus-numeric-save-name
5540 File names like @file{~/News/alt.andrea-dworkin/45}.
5541
5542 @item gnus-Plain-save-name
5543 @findex gnus-Plain-save-name
5544 File names like @file{~/News/Alt.andrea-dworkin}.
5545
5546 @item gnus-plain-save-name
5547 @findex gnus-plain-save-name
5548 File names like @file{~/News/alt.andrea-dworkin}.
5549 @end table
5550
5551 @vindex gnus-split-methods
5552 You can have Gnus suggest where to save articles by plonking a regexp into
5553 the @code{gnus-split-methods} alist.  For instance, if you would like to
5554 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5555 related to VM in @code{vm-stuff}, you could set this variable to something
5556 like:
5557
5558 @lisp
5559 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5560  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5561  (my-choosing-function "../other-dir/my-stuff")
5562  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5563 @end lisp
5564
5565 We see that this is a list where each element is a list that has two
5566 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5567 a string (in which case it is used as a regexp to match on the article
5568 head); it can be a symbol (which will be called as a function with the
5569 group name as a parameter); or it can be a list (which will be
5570 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5571 the @dfn{file} will be used as a default prompt.  In addition, the
5572 result of the operation itself will be used if the function or form
5573 called returns a string or a list of strings.
5574
5575 You basically end up with a list of file names that might be used when
5576 saving the current article.  (All ``matches'' will be used.)  You will
5577 then be prompted for what you really want to use as a name, with file
5578 name completion over the results from applying this variable.
5579
5580 This variable is @code{((gnus-article-archive-name))} by default, which
5581 means that Gnus will look at the articles it saves for an
5582 @code{Archive-name} line and use that as a suggestion for the file
5583 name.
5584
5585 Here's an example function to clean up file names somewhat.  If you have
5586 lots of mail groups called things like
5587 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5588 these group names before creating the file name to save to.  The
5589 following will do just that:
5590
5591 @lisp
5592 (defun my-save-name (group)
5593   (when (string-match "^nnml:mail." group)
5594     (substring group (match-end 0))))
5595
5596 (setq gnus-split-methods
5597       '((gnus-article-archive-name)
5598         (my-save-name)))
5599 @end lisp
5600
5601
5602 @vindex gnus-use-long-file-name
5603 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5604 @code{nil}, all the preceding functions will replace all periods
5605 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5606 the functions will generate hierarchies of directories instead of having
5607 all the files in the top level directory
5608 (@file{~/News/alt/andrea-dworkin} instead of
5609 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5610 on most systems.  However, for historical reasons, this is @code{nil} on
5611 Xenix and usg-unix-v machines by default.
5612
5613 This function also affects kill and score file names.  If this variable
5614 is a list, and the list contains the element @code{not-score}, long file
5615 names will not be used for score files, if it contains the element
5616 @code{not-save}, long file names will not be used for saving, and if it
5617 contains the element @code{not-kill}, long file names will not be used
5618 for kill files.
5619
5620 If you'd like to save articles in a hierarchy that looks something like
5621 a spool, you could
5622
5623 @lisp
5624 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5625 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5626 @end lisp
5627
5628 Then just save with @kbd{o}.  You'd then read this hierarchy with
5629 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5630 the top level directory as the argument (@file{~/News/}).  Then just walk
5631 around to the groups/directories with @code{nneething}.
5632
5633
5634 @node Decoding Articles
5635 @section Decoding Articles
5636 @cindex decoding articles
5637
5638 Sometime users post articles (or series of articles) that have been
5639 encoded in some way or other.  Gnus can decode them for you.
5640
5641 @menu
5642 * Uuencoded Articles::    Uudecode articles.
5643 * Shell Archives::        Unshar articles.
5644 * PostScript Files::      Split PostScript.
5645 * Other Files::           Plain save and binhex.
5646 * Decoding Variables::    Variables for a happy decoding.
5647 * Viewing Files::         You want to look at the result of the decoding?
5648 @end menu
5649
5650 @cindex series
5651 @cindex article series
5652 All these functions use the process/prefix convention
5653 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5654 the extension that a ``single article'' means ``a single series''.  Gnus
5655 can find out by itself what articles belong to a series, decode all the
5656 articles and unpack/view/save the resulting file(s).
5657
5658 Gnus guesses what articles are in the series according to the following
5659 simplish rule: The subjects must be (nearly) identical, except for the
5660 last two numbers of the line.  (Spaces are largely ignored, however.)
5661
5662 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5663 will find all the articles that match the regexp @samp{^cat.gif
5664 ([0-9]+/[0-9]+).*$}.
5665
5666 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5667 series}, will not be properly recognized by any of the automatic viewing
5668 commands, and you have to mark the articles manually with @kbd{#}.
5669
5670
5671 @node Uuencoded Articles
5672 @subsection Uuencoded Articles
5673 @cindex uudecode
5674 @cindex uuencoded articles
5675
5676 @table @kbd
5677
5678 @item X u
5679 @kindex X u (Summary)
5680 @findex gnus-uu-decode-uu
5681 @c @icon{gnus-uu-decode-uu}
5682 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5683
5684 @item X U
5685 @kindex X U (Summary)
5686 @findex gnus-uu-decode-uu-and-save
5687 Uudecodes and saves the current series
5688 (@code{gnus-uu-decode-uu-and-save}).
5689
5690 @item X v u
5691 @kindex X v u (Summary)
5692 @findex gnus-uu-decode-uu-view
5693 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5694
5695 @item X v U
5696 @kindex X v U (Summary)
5697 @findex gnus-uu-decode-uu-and-save-view
5698 Uudecodes, views and saves the current series
5699 (@code{gnus-uu-decode-uu-and-save-view}).
5700
5701 @end table
5702
5703 Remember that these all react to the presence of articles marked with
5704 the process mark.  If, for instance, you'd like to decode and save an
5705 entire newsgroup, you'd typically do @kbd{M P a}
5706 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5707 (@code{gnus-uu-decode-uu-and-save}).
5708
5709 All this is very much different from how @code{gnus-uu} worked with
5710 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5711 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5712 articles in some way (@pxref{Setting Process Marks}) and then press
5713 @kbd{X u}.
5714
5715 @vindex gnus-uu-notify-files
5716 Note: When trying to decode articles that have names matching
5717 @code{gnus-uu-notify-files}, which is hard-coded to
5718 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5719 automatically post an article on @samp{comp.unix.wizards} saying that
5720 you have just viewed the file in question.  This feature can't be turned
5721 off.
5722
5723
5724 @node Shell Archives
5725 @subsection Shell Archives
5726 @cindex unshar
5727 @cindex shell archives
5728 @cindex shared articles
5729
5730 Shell archives (``shar files'') used to be a popular way to distribute
5731 sources, but it isn't used all that much today.  In any case, we have
5732 some commands to deal with these:
5733
5734 @table @kbd
5735
5736 @item X s
5737 @kindex X s (Summary)
5738 @findex gnus-uu-decode-unshar
5739 Unshars the current series (@code{gnus-uu-decode-unshar}).
5740
5741 @item X S
5742 @kindex X S (Summary)
5743 @findex gnus-uu-decode-unshar-and-save
5744 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5745
5746 @item X v s
5747 @kindex X v s (Summary)
5748 @findex gnus-uu-decode-unshar-view
5749 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5750
5751 @item X v S
5752 @kindex X v S (Summary)
5753 @findex gnus-uu-decode-unshar-and-save-view
5754 Unshars, views and saves the current series
5755 (@code{gnus-uu-decode-unshar-and-save-view}).
5756 @end table
5757
5758
5759 @node PostScript Files
5760 @subsection PostScript Files
5761 @cindex PostScript
5762
5763 @table @kbd
5764
5765 @item X p
5766 @kindex X p (Summary)
5767 @findex gnus-uu-decode-postscript
5768 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5769
5770 @item X P
5771 @kindex X P (Summary)
5772 @findex gnus-uu-decode-postscript-and-save
5773 Unpack and save the current PostScript series
5774 (@code{gnus-uu-decode-postscript-and-save}).
5775
5776 @item X v p
5777 @kindex X v p (Summary)
5778 @findex gnus-uu-decode-postscript-view
5779 View the current PostScript series
5780 (@code{gnus-uu-decode-postscript-view}).
5781
5782 @item X v P
5783 @kindex X v P (Summary)
5784 @findex gnus-uu-decode-postscript-and-save-view
5785 View and save the current PostScript series
5786 (@code{gnus-uu-decode-postscript-and-save-view}).
5787 @end table
5788
5789
5790 @node Other Files
5791 @subsection Other Files
5792
5793 @table @kbd
5794 @item X o
5795 @kindex X o (Summary)
5796 @findex gnus-uu-decode-save
5797 Save the current series
5798 (@code{gnus-uu-decode-save}).
5799
5800 @item X b
5801 @kindex X b (Summary)
5802 @findex gnus-uu-decode-binhex
5803 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
5804 doesn't really work yet.
5805 @end table
5806
5807
5808 @node Decoding Variables
5809 @subsection Decoding Variables
5810
5811 Adjective, not verb.
5812
5813 @menu
5814 * Rule Variables::          Variables that say how a file is to be viewed.
5815 * Other Decode Variables::  Other decode variables.
5816 * Uuencoding and Posting::  Variables for customizing uuencoding.
5817 @end menu
5818
5819
5820 @node Rule Variables
5821 @subsubsection Rule Variables
5822 @cindex rule variables
5823
5824 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5825 variables are of the form
5826
5827 @lisp
5828       (list '(regexp1 command2)
5829             '(regexp2 command2)
5830             ...)
5831 @end lisp
5832
5833 @table @code
5834
5835 @item gnus-uu-user-view-rules
5836 @vindex gnus-uu-user-view-rules
5837 @cindex sox
5838 This variable is consulted first when viewing files.  If you wish to use,
5839 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5840 say something like:
5841 @lisp
5842 (setq gnus-uu-user-view-rules
5843       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5844 @end lisp
5845
5846 @item gnus-uu-user-view-rules-end
5847 @vindex gnus-uu-user-view-rules-end
5848 This variable is consulted if Gnus couldn't make any matches from the
5849 user and default view rules.
5850
5851 @item gnus-uu-user-archive-rules
5852 @vindex gnus-uu-user-archive-rules
5853 This variable can be used to say what commands should be used to unpack
5854 archives.
5855 @end table
5856
5857
5858 @node Other Decode Variables
5859 @subsubsection Other Decode Variables
5860
5861 @table @code
5862 @vindex gnus-uu-grabbed-file-functions
5863
5864 @item gnus-uu-grabbed-file-functions
5865 All functions in this list will be called right after each file has been
5866 successfully decoded---so that you can move or view files right away,
5867 and don't have to wait for all files to be decoded before you can do
5868 anything.  Ready-made functions you can put in this list are:
5869
5870 @table @code
5871
5872 @item gnus-uu-grab-view
5873 @findex gnus-uu-grab-view
5874 View the file.
5875
5876 @item gnus-uu-grab-move
5877 @findex gnus-uu-grab-move
5878 Move the file (if you're using a saving function.)
5879 @end table
5880
5881 @item gnus-uu-be-dangerous
5882 @vindex gnus-uu-be-dangerous
5883 Specifies what to do if unusual situations arise during decoding.  If
5884 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5885 that didn't work, and overwrite existing files.  Otherwise, ask each
5886 time.
5887
5888 @item gnus-uu-ignore-files-by-name
5889 @vindex gnus-uu-ignore-files-by-name
5890 Files with name matching this regular expression won't be viewed.
5891
5892 @item gnus-uu-ignore-files-by-type
5893 @vindex gnus-uu-ignore-files-by-type
5894 Files with a @sc{mime} type matching this variable won't be viewed.
5895 Note that Gnus tries to guess what type the file is based on the name.
5896 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5897 kludgey.
5898
5899 @item gnus-uu-tmp-dir
5900 @vindex gnus-uu-tmp-dir
5901 Where @code{gnus-uu} does its work.
5902
5903 @item gnus-uu-do-not-unpack-archives
5904 @vindex gnus-uu-do-not-unpack-archives
5905 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5906 looking for files to display.
5907
5908 @item gnus-uu-view-and-save
5909 @vindex gnus-uu-view-and-save
5910 Non-@code{nil} means that the user will always be asked to save a file
5911 after viewing it.
5912
5913 @item gnus-uu-ignore-default-view-rules
5914 @vindex gnus-uu-ignore-default-view-rules
5915 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5916 rules.
5917
5918 @item gnus-uu-ignore-default-archive-rules
5919 @vindex gnus-uu-ignore-default-archive-rules
5920 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5921 unpacking commands.
5922
5923 @item gnus-uu-kill-carriage-return
5924 @vindex gnus-uu-kill-carriage-return
5925 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5926 from articles.
5927
5928 @item gnus-uu-unmark-articles-not-decoded
5929 @vindex gnus-uu-unmark-articles-not-decoded
5930 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5931 decoded articles as unread.
5932
5933 @item gnus-uu-correct-stripped-uucode
5934 @vindex gnus-uu-correct-stripped-uucode
5935 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5936 uuencoded files that have had trailing spaces deleted.
5937
5938 @item gnus-uu-pre-uudecode-hook
5939 @vindex gnus-uu-pre-uudecode-hook
5940 Hook run before sending a message to @code{uudecode}.
5941
5942 @item gnus-uu-view-with-metamail
5943 @vindex gnus-uu-view-with-metamail
5944 @cindex metamail
5945 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5946 commands defined by the rule variables and just fudge a @sc{mime}
5947 content type based on the file name.  The result will be fed to
5948 @code{metamail} for viewing.
5949
5950 @item gnus-uu-save-in-digest
5951 @vindex gnus-uu-save-in-digest
5952 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5953 decoding, will save in digests.  If this variable is @code{nil},
5954 @code{gnus-uu} will just save everything in a file without any
5955 embellishments.  The digesting almost conforms to RFC1153---no easy way
5956 to specify any meaningful volume and issue numbers were found, so I
5957 simply dropped them.
5958
5959 @end table
5960
5961
5962 @node Uuencoding and Posting
5963 @subsubsection Uuencoding and Posting
5964
5965 @table @code
5966
5967 @item gnus-uu-post-include-before-composing
5968 @vindex gnus-uu-post-include-before-composing
5969 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5970 before you compose the article.  If this variable is @code{t}, you can
5971 either include an encoded file with @kbd{C-c C-i} or have one included
5972 for you when you post the article.
5973
5974 @item gnus-uu-post-length
5975 @vindex gnus-uu-post-length
5976 Maximum length of an article.  The encoded file will be split into how
5977 many articles it takes to post the entire file.
5978
5979 @item gnus-uu-post-threaded
5980 @vindex gnus-uu-post-threaded
5981 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5982 thread.  This may not be smart, as no other decoder I have seen is able
5983 to follow threads when collecting uuencoded articles.  (Well, I have
5984 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5985 think that counts...) Default is @code{nil}.
5986
5987 @item gnus-uu-post-separate-description
5988 @vindex gnus-uu-post-separate-description
5989 Non-@code{nil} means that the description will be posted in a separate
5990 article.  The first article will typically be numbered (0/x).  If this
5991 variable is @code{nil}, the description the user enters will be included
5992 at the beginning of the first article, which will be numbered (1/x).
5993 Default is @code{t}.
5994
5995 @end table
5996
5997
5998 @node Viewing Files
5999 @subsection Viewing Files
6000 @cindex viewing files
6001 @cindex pseudo-articles
6002
6003 After decoding, if the file is some sort of archive, Gnus will attempt
6004 to unpack the archive and see if any of the files in the archive can be
6005 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
6006 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6007 uncompress and de-tar the main file, and then view the two pictures.
6008 This unpacking process is recursive, so if the archive contains archives
6009 of archives, it'll all be unpacked.
6010
6011 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6012 extracted file into the summary buffer.  If you go to these
6013 ``articles'', you will be prompted for a command to run (usually Gnus
6014 will make a suggestion), and then the command will be run.
6015
6016 @vindex gnus-view-pseudo-asynchronously
6017 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6018 until the viewing is done before proceeding.
6019
6020 @vindex gnus-view-pseudos
6021 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6022 the pseudo-articles into the summary buffer, but view them
6023 immediately.  If this variable is @code{not-confirm}, the user won't even
6024 be asked for a confirmation before viewing is done.
6025
6026 @vindex gnus-view-pseudos-separately
6027 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6028 pseudo-article will be created for each file to be viewed.  If
6029 @code{nil}, all files that use the same viewing command will be given as
6030 a list of parameters to that command.
6031
6032 @vindex gnus-insert-pseudo-articles
6033 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6034 pseudo-articles when decoding.  It is @code{t} by default.
6035
6036 So; there you are, reading your @emph{pseudo-articles} in your
6037 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6038 Why isn't anything real anymore? How did we get here?
6039
6040
6041 @node Article Treatment
6042 @section Article Treatment
6043
6044 Reading through this huge manual, you may have quite forgotten that the
6045 object of newsreaders is to actually, like, read what people have
6046 written.  Reading articles.  Unfortunately, people are quite bad at
6047 writing, so there are tons of functions and variables to make reading
6048 these articles easier.
6049
6050 @menu
6051 * Article Highlighting::    You want to make the article look like fruit salad.
6052 * Article Fontisizing::     Making emphasized text look nice.
6053 * Article Hiding::          You also want to make certain info go away.
6054 * Article Washing::         Lots of way-neat functions to make life better.
6055 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6056 * Article Date::            Grumble, UT!
6057 * Article Signature::       What is a signature?
6058 @end menu
6059
6060
6061 @node Article Highlighting
6062 @subsection Article Highlighting
6063 @cindex highlight
6064
6065 Not only do you want your article buffer to look like fruit salad, but
6066 you want it to look like technicolor fruit salad.
6067
6068 @table @kbd
6069
6070 @item W H a
6071 @kindex W H a (Summary)
6072 @findex gnus-article-highlight
6073 Highlight the current article (@code{gnus-article-highlight}).
6074
6075 @item W H h
6076 @kindex W H h (Summary)
6077 @findex gnus-article-highlight-headers
6078 @vindex gnus-header-face-alist
6079 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6080 highlighting will be done according to the @code{gnus-header-face-alist}
6081 variable, which is a list where each element has the form @var{(regexp
6082 name content)}.  @var{regexp} is a regular expression for matching the
6083 header, @var{name} is the face used for highlighting the header name
6084 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6085 the header value.  The first match made will be used.  Note that
6086 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6087
6088 @item W H c
6089 @kindex W H c (Summary)
6090 @findex gnus-article-highlight-citation
6091 Highlight cited text (@code{gnus-article-highlight-citation}).
6092
6093 Some variables to customize the citation highlights:
6094
6095 @table @code
6096 @vindex gnus-cite-parse-max-size
6097
6098 @item gnus-cite-parse-max-size
6099 If the article size if bigger than this variable (which is 25000 by
6100 default), no citation highlighting will be performed.
6101
6102 @item gnus-cite-prefix-regexp
6103 @vindex gnus-cite-prefix-regexp
6104 Regexp matching the longest possible citation prefix on a line.
6105
6106 @item gnus-cite-max-prefix
6107 @vindex gnus-cite-max-prefix
6108 Maximum possible length for a citation prefix (default 20).
6109
6110 @item gnus-cite-face-list
6111 @vindex gnus-cite-face-list
6112 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6113 When there are citations from multiple articles in the same message,
6114 Gnus will try to give each citation from each article its own face.
6115 This should make it easier to see who wrote what.
6116
6117 @item gnus-supercite-regexp
6118 @vindex gnus-supercite-regexp
6119 Regexp matching normal Supercite attribution lines.
6120
6121 @item gnus-supercite-secondary-regexp
6122 @vindex gnus-supercite-secondary-regexp
6123 Regexp matching mangled Supercite attribution lines.
6124
6125 @item gnus-cite-minimum-match-count
6126 @vindex gnus-cite-minimum-match-count
6127 Minimum number of identical prefixes we have to see before we believe
6128 that it's a citation.
6129
6130 @item gnus-cite-attribution-prefix
6131 @vindex gnus-cite-attribution-prefix
6132 Regexp matching the beginning of an attribution line.
6133
6134 @item gnus-cite-attribution-suffix
6135 @vindex gnus-cite-attribution-suffix
6136 Regexp matching the end of an attribution line.
6137
6138 @item gnus-cite-attribution-face
6139 @vindex gnus-cite-attribution-face
6140 Face used for attribution lines.  It is merged with the face for the
6141 cited text belonging to the attribution.
6142
6143 @end table
6144
6145
6146 @item W H s
6147 @kindex W H s (Summary)
6148 @vindex gnus-signature-separator
6149 @vindex gnus-signature-face
6150 @findex gnus-article-highlight-signature
6151 Highlight the signature (@code{gnus-article-highlight-signature}).
6152 Everything after @code{gnus-signature-separator} (@pxref{Article
6153 Signature}) in an article will be considered a signature and will be
6154 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6155 default.
6156
6157 @end table
6158
6159
6160 @node Article Fontisizing
6161 @subsection Article Fontisizing
6162 @cindex emphasis
6163 @cindex article emphasis
6164
6165 @findex gnus-article-emphasize
6166 @kindex W e (Summary)
6167 People commonly add emphasis to words in news articles by writing things
6168 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
6169 running the article through the @kbd{W e}
6170 (@code{gnus-article-emphasize}) command.
6171
6172 @vindex gnus-article-emphasis
6173 How the emphasis is computed is controlled by the
6174 @code{gnus-article-emphasis} variable.  This is an alist where the first
6175 element is a regular expression to be matched.  The second is a number
6176 that says what regular expression grouping is used to find the entire
6177 emphasized word.  The third is a number that says what regexp grouping
6178 should be displayed and highlighted.  (The text between these two
6179 groupings will be hidden.)  The fourth is the face used for
6180 highlighting.
6181
6182 @lisp
6183 (setq gnus-article-emphasis
6184       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6185         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6186 @end lisp
6187
6188 @vindex gnus-emphasis-underline
6189 @vindex gnus-emphasis-bold
6190 @vindex gnus-emphasis-italic
6191 @vindex gnus-emphasis-underline-bold
6192 @vindex gnus-emphasis-underline-italic
6193 @vindex gnus-emphasis-bold-italic
6194 @vindex gnus-emphasis-underline-bold-italic
6195 By default, there are seven rules, and they use the following faces:
6196 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6197 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6198 @code{gnus-emphasis-underline-italic},
6199 @code{gnus-emphasis-underline-bold}, and
6200 @code{gnus-emphasis-underline-bold-italic}.
6201
6202 If you want to change these faces, you can either use @kbd{M-x
6203 customize}, or you can use @code{copy-face}.  For instance, if you want
6204 to make @code{gnus-emphasis-italic} use a red face instead, you could
6205 say something like:
6206
6207 @lisp
6208 (copy-face 'red 'gnus-emphasis-italic)
6209 @end lisp
6210
6211
6212 @node Article Hiding
6213 @subsection Article Hiding
6214 @cindex article hiding
6215
6216 Or rather, hiding certain things in each article.  There usually is much
6217 too much cruft in most articles.
6218
6219 @table @kbd
6220
6221 @item W W a
6222 @kindex W W a (Summary)
6223 @findex gnus-article-hide
6224 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}).
6225
6226 @item W W h
6227 @kindex W W h (Summary)
6228 @findex gnus-article-hide-headers
6229 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
6230 Headers}.
6231
6232 @item W W b
6233 @kindex W W b (Summary)
6234 @findex gnus-article-hide-boring-headers
6235 Hide headers that aren't particularly interesting
6236 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6237
6238 @item W W s
6239 @kindex W W s (Summary)
6240 @findex gnus-article-hide-signature
6241 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6242 Signature}.
6243
6244 @item W W p
6245 @kindex W W p (Summary)
6246 @findex gnus-article-hide-pgp
6247 @vindex gnus-article-hide-pgp-hook
6248 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6249 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6250 signature has been hidden.
6251
6252 @item W W P
6253 @kindex W W P (Summary)
6254 @findex gnus-article-hide-pem
6255 Hide @sc{pem} (privacy enhanced messages) cruft
6256 (@code{gnus-article-hide-pem}).
6257
6258 @item W W c
6259 @kindex W W c (Summary)
6260 @findex gnus-article-hide-citation
6261 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6262 customizing the hiding:
6263
6264 @table @code
6265
6266 @item gnus-cite-hide-percentage
6267 @vindex gnus-cite-hide-percentage
6268 If the cited text is of a bigger percentage than this variable (default
6269 50), hide the cited text.
6270
6271 @item gnus-cite-hide-absolute
6272 @vindex gnus-cite-hide-absolute
6273 The cited text must have at least this length (default 10) before it
6274 is hidden.
6275
6276 @item gnus-cited-text-button-line-format
6277 @vindex gnus-cited-text-button-line-format
6278 Gnus adds buttons to show where the cited text has been hidden, and to
6279 allow toggle hiding the text.  The format of the variable is specified
6280 by this format-like variable (@pxref{Formatting Variables}).  These
6281 specs are valid:
6282
6283 @table @samp
6284 @item b
6285 Start point of the hidden text.
6286 @item e
6287 End point of the hidden text.
6288 @item l
6289 Length of the hidden text.
6290 @end table
6291
6292 @item gnus-cited-lines-visible
6293 @vindex gnus-cited-lines-visible
6294 The number of lines at the beginning of the cited text to leave shown.
6295
6296 @end table
6297
6298 @item W W C
6299 @kindex W W C (Summary)
6300 @findex gnus-article-hide-citation-in-followups
6301 Hide cited text in articles that aren't roots
6302 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6303 useful as an interactive command, but might be a handy function to stick
6304 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
6305
6306 @end table
6307
6308 All these ``hiding'' commands are toggles, but if you give a negative
6309 prefix to these commands, they will show what they have previously
6310 hidden.  If you give a positive prefix, they will always hide.
6311
6312 Also @pxref{Article Highlighting} for further variables for
6313 citation customization.
6314
6315
6316 @node Article Washing
6317 @subsection Article Washing
6318 @cindex washing
6319 @cindex article washing
6320
6321 We call this ``article washing'' for a really good reason.  Namely, the
6322 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6323
6324 @dfn{Washing} is defined by us as ``changing something from something to
6325 something else'', but normally results in something looking better.
6326 Cleaner, perhaps.
6327
6328 @table @kbd
6329
6330 @item W l
6331 @kindex W l (Summary)
6332 @findex gnus-summary-stop-page-breaking
6333 Remove page breaks from the current article
6334 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article} for page
6335 delimiters. 
6336
6337 @item W r
6338 @kindex W r (Summary)
6339 @findex gnus-summary-caesar-message
6340 @c @icon{gnus-summary-caesar-message}
6341 Do a Caesar rotate (rot13) on the article buffer
6342 (@code{gnus-summary-caesar-message}).
6343 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6344 (Typically offensive jokes and such.)
6345
6346 It's commonly called ``rot13'' because each letter is rotated 13
6347 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6348 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6349 is rumored to have employed this form of, uh, somewhat weak encryption.
6350
6351 @item W t
6352 @kindex W t (Summary)
6353 @findex gnus-summary-toggle-header
6354 Toggle whether to display all headers in the article buffer
6355 (@code{gnus-summary-toggle-header}).
6356
6357 @item W v
6358 @kindex W v (Summary)
6359 @findex gnus-summary-verbose-header
6360 Toggle whether to display all headers in the article buffer permanently
6361 (@code{gnus-summary-verbose-header}).
6362
6363 @item W m
6364 @kindex W m (Summary)
6365 @findex gnus-summary-toggle-mime
6366 Toggle whether to run the article through @sc{mime} before displaying
6367 (@code{gnus-summary-toggle-mime}).
6368
6369 @item W o
6370 @kindex W o (Summary)
6371 @findex gnus-article-treat-overstrike
6372 Treat overstrike (@code{gnus-article-treat-overstrike}).
6373
6374 @item W d
6375 @kindex W d (Summary)
6376 @findex gnus-article-treat-dumbquotes
6377 Treat M******** sm*rtq**t*s (@code{gnus-article-treat-dumbquotes}).
6378
6379 @item W w
6380 @kindex W w (Summary)
6381 @findex gnus-article-fill-cited-article
6382 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
6383 function in @code{gnus-article-display-hook}, it should be run fairly
6384 late and certainly after any highlighting.
6385
6386 You can give the command a numerical prefix to specify the width to use
6387 when filling.
6388
6389 @item W c
6390 @kindex W c (Summary)
6391 @findex gnus-article-remove-cr
6392 Remove CR (i. e., @samp{^M}s on the end of the lines)
6393 (@code{gnus-article-remove-cr}).
6394
6395 @item W q
6396 @kindex W q (Summary)
6397 @findex gnus-article-de-quoted-unreadable
6398 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6399 Quoted-Printable is one common @sc{mime} encoding employed when sending
6400 non-ASCII (i. e., 8-bit) articles.  It typically makes strings like
6401 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6402 readable to me.
6403
6404 @item W f
6405 @kindex W f (Summary)
6406 @cindex x-face
6407 @findex gnus-article-display-x-face
6408 @findex gnus-article-x-face-command
6409 @vindex gnus-article-x-face-command
6410 @vindex gnus-article-x-face-too-ugly
6411 @iftex
6412 @iflatex
6413 \include{xface}
6414 @end iflatex
6415 @end iftex
6416 Look for and display any X-Face headers
6417 (@code{gnus-article-display-x-face}).  The command executed by this
6418 function is given by the @code{gnus-article-x-face-command} variable.
6419 If this variable is a string, this string will be executed in a
6420 sub-shell.  If it is a function, this function will be called with the
6421 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6422 is a regexp) matches the @code{From} header, the face will not be shown.
6423 The default action under Emacs is to fork off an @code{xv} to view the
6424 face; under XEmacs the default action is to display the face before the
6425 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6426 support---that will make display somewhat faster.  If there's no native
6427 X-Face support, Gnus will try to convert the @code{X-Face} header using
6428 external programs from the @code{pbmplus} package and friends.)  If you
6429 want to have this function in the display hook, it should probably come
6430 last.
6431
6432 @item W b
6433 @kindex W b (Summary)
6434 @findex gnus-article-add-buttons
6435 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6436 @xref{Article Buttons}
6437
6438 @item W B
6439 @kindex W B (Summary)
6440 @findex gnus-article-add-buttons-to-head
6441 Add clickable buttons to the article headers
6442 (@code{gnus-article-add-buttons-to-head}).
6443
6444 @item W E l
6445 @kindex W E l (Summary)
6446 @findex gnus-article-strip-leading-blank-lines
6447 Remove all blank lines from the beginning of the article
6448 (@code{gnus-article-strip-leading-blank-lines}).
6449
6450 @item W E m
6451 @kindex W E m (Summary)
6452 @findex gnus-article-strip-multiple-blank-lines
6453 Replace all blank lines with empty lines and then all multiple empty
6454 lines with a single empty line.
6455 (@code{gnus-article-strip-multiple-blank-lines}).
6456
6457 @item W E t
6458 @kindex W E t (Summary)
6459 @findex gnus-article-remove-trailing-blank-lines
6460 Remove all blank lines at the end of the article
6461 (@code{gnus-article-remove-trailing-blank-lines}).
6462
6463 @item W E a
6464 @kindex W E a (Summary)
6465 @findex gnus-article-strip-blank-lines
6466 Do all the three commands above
6467 (@code{gnus-article-strip-blank-lines}).
6468
6469 @item W E A
6470 @kindex W E A (Summary)
6471 @findex gnus-article-strip-all-blank-lines
6472 Remove all blank lines
6473 (@code{gnus-article-strip-all-blank-lines}).
6474
6475 @item W E s
6476 @kindex W E s (Summary)
6477 @findex gnus-article-strip-leading-space
6478 Remove all white space from the beginning of all lines of the article
6479 body (@code{gnus-article-strip-leading-space}).
6480
6481 @end table
6482
6483
6484 @node Article Buttons
6485 @subsection Article Buttons
6486 @cindex buttons
6487
6488 People often include references to other stuff in articles, and it would
6489 be nice if Gnus could just fetch whatever it is that people talk about
6490 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6491 button on these references.
6492
6493 Gnus adds @dfn{buttons} to certain standard references by default:
6494 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6495 two variables, one that handles article bodies and one that handles
6496 article heads:
6497
6498 @table @code
6499
6500 @item gnus-button-alist
6501 @vindex gnus-button-alist
6502 This is an alist where each entry has this form:
6503
6504 @lisp
6505 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6506 @end lisp
6507
6508 @table @var
6509
6510 @item regexp
6511 All text that match this regular expression will be considered an
6512 external reference.  Here's a typical regexp that matches embedded URLs:
6513 @samp{<URL:\\([^\n\r>]*\\)>}.
6514
6515 @item button-par
6516 Gnus has to know which parts of the matches is to be highlighted.  This
6517 is a number that says what sub-expression of the regexp is to be
6518 highlighted.  If you want it all highlighted, you use 0 here.
6519
6520 @item use-p
6521 This form will be @code{eval}ed, and if the result is non-@code{nil},
6522 this is considered a match.  This is useful if you want extra sifting to
6523 avoid false matches.
6524
6525 @item function
6526 This function will be called when you click on this button.
6527
6528 @item data-par
6529 As with @var{button-par}, this is a sub-expression number, but this one
6530 says which part of the match is to be sent as data to @var{function}.
6531
6532 @end table
6533
6534 So the full entry for buttonizing URLs is then
6535
6536 @lisp
6537 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6538 @end lisp
6539
6540 @item gnus-header-button-alist
6541 @vindex gnus-header-button-alist
6542 This is just like the other alist, except that it is applied to the
6543 article head only, and that each entry has an additional element that is
6544 used to say what headers to apply the buttonize coding to:
6545
6546 @lisp
6547 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6548 @end lisp
6549
6550 @var{HEADER} is a regular expression.
6551
6552 @item gnus-button-url-regexp
6553 @vindex gnus-button-url-regexp
6554 A regular expression that matches embedded URLs.  It is used in the
6555 default values of the variables above.
6556
6557 @item gnus-article-button-face
6558 @vindex gnus-article-button-face
6559 Face used on buttons.
6560
6561 @item gnus-article-mouse-face
6562 @vindex gnus-article-mouse-face
6563 Face used when the mouse cursor is over a button.
6564
6565 @end table
6566
6567
6568 @node Article Date
6569 @subsection Article Date
6570
6571 The date is most likely generated in some obscure timezone you've never
6572 heard of, so it's quite nice to be able to find out what the time was
6573 when the article was sent.
6574
6575 @table @kbd
6576
6577 @item W T u
6578 @kindex W T u (Summary)
6579 @findex gnus-article-date-ut
6580 Display the date in UT (aka. GMT, aka ZULU)
6581 (@code{gnus-article-date-ut}).
6582
6583 @item W T i
6584 @kindex W T i (Summary)
6585 @findex gnus-article-date-iso8601
6586 @cindex ISO 8601
6587 Display the date in international format, aka. ISO 8601
6588 (@code{gnus-article-date-iso8601}).
6589
6590 @item W T l
6591 @kindex W T l (Summary)
6592 @findex gnus-article-date-local
6593 Display the date in the local timezone (@code{gnus-article-date-local}).
6594
6595 @item W T s
6596 @kindex W T s (Summary)
6597 @vindex gnus-article-time-format
6598 @findex gnus-article-date-user
6599 @findex format-time-string
6600 Display the date using a user-defined format
6601 (@code{gnus-article-date-user}).  The format is specified by the
6602 @code{gnus-article-time-format} variable, and is a string that's passed
6603 to @code{format-time-string}.  See the documentation of that variable
6604 for a list of possible format specs.
6605
6606 @item W T e
6607 @kindex W T e (Summary)
6608 @findex gnus-article-date-lapsed
6609 @findex gnus-start-date-timer
6610 @findex gnus-stop-date-timer
6611 Say how much time has elapsed between the article was posted and now
6612 (@code{gnus-article-date-lapsed}).  If you want to have this line
6613 updated continually, you can put
6614
6615 @lisp
6616 (gnus-start-date-timer)
6617 @end lisp
6618
6619 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6620 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6621 command.
6622
6623 @item W T o
6624 @kindex W T o (Summary)
6625 @findex gnus-article-date-original
6626 Display the original date (@code{gnus-article-date-original}).  This can
6627 be useful if you normally use some other conversion function and are
6628 worried that it might be doing something totally wrong.  Say, claiming
6629 that the article was posted in 1854.  Although something like that is
6630 @emph{totally} impossible.  Don't you trust me? *titter*
6631
6632 @end table
6633
6634
6635 @node Article Signature
6636 @subsection Article Signature
6637 @cindex signatures
6638 @cindex article signature
6639
6640 @vindex gnus-signature-separator
6641 Each article is divided into two parts---the head and the body.  The
6642 body can be divided into a signature part and a text part.  The variable
6643 that says what is to be considered a signature is
6644 @code{gnus-signature-separator}.  This is normally the standard
6645 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6646 non-standard signature separators, so this variable can also be a list
6647 of regular expressions to be tested, one by one.  (Searches are done
6648 from the end of the body towards the beginning.)  One likely value is:
6649
6650 @lisp
6651 (setq gnus-signature-separator
6652       '("^-- $"         ; The standard
6653         "^-- *$"        ; A common mangling
6654         "^-------*$"    ; Many people just use a looong
6655                         ; line of dashes.  Shame!
6656         "^ *--------*$" ; Double-shame!
6657         "^________*$"   ; Underscores are also popular
6658         "^========*$")) ; Pervert!
6659 @end lisp
6660
6661 The more permissive you are, the more likely it is that you'll get false
6662 positives.
6663
6664 @vindex gnus-signature-limit
6665 @code{gnus-signature-limit} provides a limit to what is considered a
6666 signature.
6667
6668 @enumerate
6669 @item
6670 If it is an integer, no signature may be longer (in characters) than
6671 that integer.
6672 @item
6673 If it is a floating point number, no signature may be longer (in lines)
6674 than that number.
6675 @item
6676 If it is a function, the function will be called without any parameters,
6677 and if it returns @code{nil}, there is no signature in the buffer.
6678 @item
6679 If it is a string, it will be used as a regexp.  If it matches, the text
6680 in question is not a signature.
6681 @end enumerate
6682
6683 This variable can also be a list where the elements may be of the types
6684 listed above.  Here's an example:
6685
6686 @lisp
6687 (setq gnus-signature-limit
6688       '(200.0 "^---*Forwarded article"))
6689 @end lisp
6690
6691 This means that if there are more than 200 lines after the signature
6692 separator, or the text after the signature separator is matched by
6693 the regular expression @samp{^---*Forwarded article}, then it isn't a
6694 signature after all.
6695
6696
6697 @node Article Commands
6698 @section Article Commands
6699
6700 @table @kbd
6701
6702 @item A P
6703 @cindex PostScript
6704 @cindex printing
6705 @kindex A P (Summary)
6706 @vindex gnus-ps-print-hook
6707 @findex gnus-summary-print-article
6708 Generate and print a PostScript image of the article buffer
6709 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6710 run just before printing the buffer.
6711
6712 @end table
6713
6714
6715 @node Summary Sorting
6716 @section Summary Sorting
6717 @cindex summary sorting
6718
6719 You can have the summary buffer sorted in various ways, even though I
6720 can't really see why you'd want that.
6721
6722 @table @kbd
6723
6724 @item C-c C-s C-n
6725 @kindex C-c C-s C-n (Summary)
6726 @findex gnus-summary-sort-by-number
6727 Sort by article number (@code{gnus-summary-sort-by-number}).
6728
6729 @item C-c C-s C-a
6730 @kindex C-c C-s C-a (Summary)
6731 @findex gnus-summary-sort-by-author
6732 Sort by author (@code{gnus-summary-sort-by-author}).
6733
6734 @item C-c C-s C-s
6735 @kindex C-c C-s C-s (Summary)
6736 @findex gnus-summary-sort-by-subject
6737 Sort by subject (@code{gnus-summary-sort-by-subject}).
6738
6739 @item C-c C-s C-d
6740 @kindex C-c C-s C-d (Summary)
6741 @findex gnus-summary-sort-by-date
6742 Sort by date (@code{gnus-summary-sort-by-date}).
6743
6744 @item C-c C-s C-l
6745 @kindex C-c C-s C-l (Summary)
6746 @findex gnus-summary-sort-by-lines
6747 Sort by lines (@code{gnus-summary-sort-by-lines}).
6748
6749 @item C-c C-s C-i
6750 @kindex C-c C-s C-i (Summary)
6751 @findex gnus-summary-sort-by-score
6752 Sort by score (@code{gnus-summary-sort-by-score}).
6753 @end table
6754
6755 These functions will work both when you use threading and when you don't
6756 use threading.  In the latter case, all summary lines will be sorted,
6757 line by line.  In the former case, sorting will be done on a
6758 root-by-root basis, which might not be what you were looking for.  To
6759 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6760 Commands}).
6761
6762
6763 @node Finding the Parent
6764 @section Finding the Parent
6765 @cindex parent articles
6766 @cindex referring articles
6767
6768 @table @kbd
6769 @item ^
6770 @kindex ^ (Summary)
6771 @findex gnus-summary-refer-parent-article
6772 If you'd like to read the parent of the current article, and it is not
6773 displayed in the summary buffer, you might still be able to.  That is,
6774 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6775 and the @code{References} in the current article are not mangled, you
6776 can just press @kbd{^} or @kbd{A r}
6777 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6778 you'll get the parent.  If the parent is already displayed in the
6779 summary buffer, point will just move to this article.
6780
6781 If given a positive numerical prefix, fetch that many articles back into
6782 the ancestry.  If given a negative numerical prefix, fetch just that
6783 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6784 grandparent and the grandgrandparent of the current article.  If you say
6785 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6786 article.
6787
6788 @item A R (Summary)
6789 @findex gnus-summary-refer-references
6790 @kindex A R (Summary)
6791 Fetch all articles mentioned in the @code{References} header of the
6792 article (@code{gnus-summary-refer-references}).
6793
6794 @item A T (Summary)
6795 @findex gnus-summary-refer-thread
6796 @kindex A T (Summary)
6797 Display the full thread where the current article appears
6798 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
6799 headers in the current group to work, so it usually takes a while.  If
6800 you do it often, you may consider setting @code{gnus-fetch-old-headers}
6801 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
6802 visible effects normally, but it'll make this command work a whole lot
6803 faster.  Of course, it'll make group entry somewhat slow.
6804
6805 @vindex gnus-refer-thread-limit
6806 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
6807 articles before the first displayed in the current group) headers to
6808 fetch when doing this command.  The default is 200.  If @code{t}, all
6809 the available headers will be fetched.  This variable can be overridden
6810 by giving the @kbd{A T} command a numerical prefix.
6811
6812 @item M-^ (Summary)
6813 @findex gnus-summary-refer-article
6814 @kindex M-^ (Summary)
6815 @cindex Message-ID
6816 @cindex fetching by Message-ID
6817 You can also ask the @sc{nntp} server for an arbitrary article, no
6818 matter what group it belongs to.  @kbd{M-^}
6819 (@code{gnus-summary-refer-article}) will ask you for a
6820 @code{Message-ID}, which is one of those long, hard-to-read thingies
6821 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6822 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6823 @end table
6824
6825 The current select method will be used when fetching by
6826 @code{Message-ID} from non-news select method, but you can override this
6827 by giving this command a prefix.
6828
6829 @vindex gnus-refer-article-method
6830 If the group you are reading is located on a backend that does not
6831 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6832 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6833 would, perhaps, be best if the @sc{nntp} server you consult is the one
6834 updating the spool you are reading from, but that's not really
6835 necessary.
6836
6837 Most of the mail backends support fetching by @code{Message-ID}, but do
6838 not do a particularly excellent job at it.  That is, @code{nnmbox} and
6839 @code{nnbabyl} are able to locate articles from any groups, while
6840 @code{nnml} and @code{nnfolder} are only able to locate articles that
6841 have been posted to the current group.  (Anything else would be too time
6842 consuming.)  @code{nnmh} does not support this at all.
6843
6844
6845 @node Alternative Approaches
6846 @section Alternative Approaches
6847
6848 Different people like to read news using different methods.  This being
6849 Gnus, we offer a small selection of minor modes for the summary buffers.
6850
6851 @menu
6852 * Pick and Read::               First mark articles and then read them.
6853 * Binary Groups::               Auto-decode all articles.
6854 @end menu
6855
6856
6857 @node Pick and Read
6858 @subsection Pick and Read
6859 @cindex pick and read
6860
6861 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6862 a two-phased reading interface.  The user first marks in a summary
6863 buffer the articles she wants to read.  Then she starts reading the
6864 articles with just an article buffer displayed.
6865
6866 @findex gnus-pick-mode
6867 @kindex M-x gnus-pick-mode
6868 Gnus provides a summary buffer minor mode that allows
6869 this---@code{gnus-pick-mode}.  This basically means that a few process
6870 mark commands become one-keystroke commands to allow easy marking, and
6871 it provides one additional command for switching to the summary buffer.
6872
6873 Here are the available keystrokes when using pick mode:
6874
6875 @table @kbd
6876 @item .
6877 @kindex . (Pick)
6878 @findex gnus-pick-article-or-thread
6879 Pick the article or thread on the current line
6880 (@code{gnus-pick-article-or-thread}).  If the variable
6881 @code{gnus-thread-hide-subtree} is true, then this key selects the
6882 entire thread when used at the first article of the thread.  Otherwise,
6883 it selects just the article. If given a numerical prefix, go to that
6884 thread or article and pick it.  (The line number is normally displayed
6885 at the beginning of the summary pick lines.)
6886
6887 @item SPACE
6888 @kindex SPACE (Pick)
6889 @findex gnus-pick-next-page
6890 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6891 at the end of the buffer, start reading the picked articles.
6892
6893 @item u
6894 @kindex u (Pick)
6895 @findex gnus-pick-unmark-article-or-thread.
6896 Unpick the thread or article
6897 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
6898 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
6899 thread if used at the first article of the thread.  Otherwise it unpicks 
6900 just the article.  You can give this key a numerical prefix to unpick
6901 the thread or article at that line.
6902
6903 @item RET
6904 @kindex RET (Pick)
6905 @findex gnus-pick-start-reading
6906 @vindex gnus-pick-display-summary
6907 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6908 given a prefix, mark all unpicked articles as read first.  If
6909 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6910 will still be visible when you are reading.
6911
6912 @end table
6913
6914 All the normal summary mode commands are still available in the
6915 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
6916 which is mapped to the same function
6917 @code{gnus-summary-tick-article-forward}.
6918
6919 If this sounds like a good idea to you, you could say:
6920
6921 @lisp
6922 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6923 @end lisp
6924
6925 @vindex gnus-pick-mode-hook
6926 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6927
6928 @vindex gnus-mark-unpicked-articles-as-read
6929 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6930 all unpicked articles as read.  The default is @code{nil}.
6931
6932 @vindex gnus-summary-pick-line-format
6933 The summary line format in pick mode is slightly different from the
6934 standard format.  At the beginning of each line the line number is
6935 displayed.  The pick mode line format is controlled by the
6936 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6937 Variables}).  It accepts the same format specs that
6938 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
6939
6940
6941 @node Binary Groups
6942 @subsection Binary Groups
6943 @cindex binary groups
6944
6945 @findex gnus-binary-mode
6946 @kindex M-x gnus-binary-mode
6947 If you spend much time in binary groups, you may grow tired of hitting
6948 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6949 is a minor mode for summary buffers that makes all ordinary Gnus article
6950 selection functions uudecode series of articles and display the result
6951 instead of just displaying the articles the normal way.
6952
6953 @kindex g (Binary)
6954 @findex gnus-binary-show-article
6955 The only way, in fact, to see the actual articles is the @kbd{g}
6956 command, when you have turned on this mode
6957 (@code{gnus-binary-show-article}).
6958
6959 @vindex gnus-binary-mode-hook
6960 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6961
6962
6963 @node Tree Display
6964 @section Tree Display
6965 @cindex trees
6966
6967 @vindex gnus-use-trees
6968 If you don't like the normal Gnus summary display, you might try setting
6969 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6970 additional @dfn{tree buffer}.  You can execute all summary mode commands
6971 in the tree buffer.
6972
6973 There are a few variables to customize the tree display, of course:
6974
6975 @table @code
6976 @item gnus-tree-mode-hook
6977 @vindex gnus-tree-mode-hook
6978 A hook called in all tree mode buffers.
6979
6980 @item gnus-tree-mode-line-format
6981 @vindex gnus-tree-mode-line-format
6982 A format string for the mode bar in the tree mode buffers (@pxref{Mode
6983 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
6984 of valid specs, @pxref{Summary Buffer Mode Line}.
6985
6986 @item gnus-selected-tree-face
6987 @vindex gnus-selected-tree-face
6988 Face used for highlighting the selected article in the tree buffer.  The
6989 default is @code{modeline}.
6990
6991 @item gnus-tree-line-format
6992 @vindex gnus-tree-line-format
6993 A format string for the tree nodes.  The name is a bit of a misnomer,
6994 though---it doesn't define a line, but just the node.  The default value
6995 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6996 the name of the poster.  It is vital that all nodes are of the same
6997 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6998
6999 Valid specs are:
7000
7001 @table @samp
7002 @item n
7003 The name of the poster.
7004 @item f
7005 The @code{From} header.
7006 @item N
7007 The number of the article.
7008 @item [
7009 The opening bracket.
7010 @item ]
7011 The closing bracket.
7012 @item s
7013 The subject.
7014 @end table
7015
7016 @xref{Formatting Variables}.
7017
7018 Variables related to the display are:
7019
7020 @table @code
7021 @item gnus-tree-brackets
7022 @vindex gnus-tree-brackets
7023 This is used for differentiating between ``real'' articles and
7024 ``sparse'' articles.  The format is @var{((real-open . real-close)
7025 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7026 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7027
7028 @item gnus-tree-parent-child-edges
7029 @vindex gnus-tree-parent-child-edges
7030 This is a list that contains the characters used for connecting parent
7031 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
7032
7033 @end table
7034
7035 @item gnus-tree-minimize-window
7036 @vindex gnus-tree-minimize-window
7037 If this variable is non-@code{nil}, Gnus will try to keep the tree
7038 buffer as small as possible to allow more room for the other Gnus
7039 windows.  If this variable is a number, the tree buffer will never be
7040 higher than that number.  The default is @code{t}.  Note that if you
7041 have several windows displayed side-by-side in a frame and the tree
7042 buffer is one of these, minimizing the tree window will also resize all
7043 other windows displayed next to it.
7044
7045 @item gnus-generate-tree-function
7046 @vindex gnus-generate-tree-function
7047 @findex gnus-generate-horizontal-tree
7048 @findex gnus-generate-vertical-tree
7049 The function that actually generates the thread tree.  Two predefined
7050 functions are available: @code{gnus-generate-horizontal-tree} and
7051 @code{gnus-generate-vertical-tree} (which is the default).
7052
7053 @end table
7054
7055 Here's an example from a horizontal tree buffer:
7056
7057 @example
7058 @{***@}-(***)-[odd]-[Gun]
7059      |      \[Jan]
7060      |      \[odd]-[Eri]
7061      |      \(***)-[Eri]
7062      |            \[odd]-[Paa]
7063      \[Bjo]
7064      \[Gun]
7065      \[Gun]-[Jor]
7066 @end example
7067
7068 Here's the same thread displayed in a vertical tree buffer:
7069
7070 @example
7071 @{***@}
7072   |--------------------------\-----\-----\
7073 (***)                         [Bjo] [Gun] [Gun]
7074   |--\-----\-----\                          |
7075 [odd] [Jan] [odd] (***)                   [Jor]
7076   |           |     |--\
7077 [Gun]       [Eri] [Eri] [odd]
7078                           |
7079                         [Paa]
7080 @end example
7081
7082 If you're using horizontal trees, it might be nice to display the trees
7083 side-by-side with the summary buffer.  You could add something like the
7084 following to your @file{.gnus.el} file:
7085
7086 @lisp
7087 (setq gnus-use-trees t
7088       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7089       gnus-tree-minimize-window nil)
7090 (gnus-add-configuration
7091  '(article
7092    (vertical 1.0
7093              (horizontal 0.25
7094                          (summary 0.75 point)
7095                          (tree 1.0))
7096              (article 1.0))))
7097 @end lisp
7098
7099 @xref{Windows Configuration}.
7100
7101
7102 @node Mail Group Commands
7103 @section Mail Group Commands
7104 @cindex mail group commands
7105
7106 Some commands only make sense in mail groups.  If these commands are
7107 invalid in the current group, they will raise a hell and let you know.
7108
7109 All these commands (except the expiry and edit commands) use the
7110 process/prefix convention (@pxref{Process/Prefix}).
7111
7112 @table @kbd
7113
7114 @item B e
7115 @kindex B e (Summary)
7116 @findex gnus-summary-expire-articles
7117 Expire all expirable articles in the group
7118 (@code{gnus-summary-expire-articles}).
7119
7120 @item B M-C-e
7121 @kindex B M-C-e (Summary)
7122 @findex gnus-summary-expire-articles-now
7123 Delete all the expirable articles in the group
7124 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7125 articles eligible for expiry in the current group will
7126 disappear forever into that big @file{/dev/null} in the sky.
7127
7128 @item B DEL
7129 @kindex B DEL (Summary)
7130 @findex gnus-summary-delete-article
7131 @c @icon{gnus-summary-mail-delete}
7132 Delete the mail article.  This is ``delete'' as in ``delete it from your
7133 disk forever and ever, never to return again.'' Use with caution.
7134 (@code{gnus-summary-delete-article}).
7135
7136 @item B m
7137 @kindex B m (Summary)
7138 @cindex move mail
7139 @findex gnus-summary-move-article
7140 Move the article from one mail group to another
7141 (@code{gnus-summary-move-article}).
7142
7143 @item B c
7144 @kindex B c (Summary)
7145 @cindex copy mail
7146 @findex gnus-summary-copy-article
7147 @c @icon{gnus-summary-mail-copy}
7148 Copy the article from one group (mail group or not) to a mail group
7149 (@code{gnus-summary-copy-article}).
7150
7151 @item B B
7152 @kindex B B (Summary)
7153 @cindex crosspost mail
7154 @findex gnus-summary-crosspost-article
7155 Crosspost the current article to some other group
7156 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7157 the article in the other group, and the Xref headers of the article will
7158 be properly updated.
7159
7160 @item B i
7161 @kindex B i (Summary)
7162 @findex gnus-summary-import-article
7163 Import an arbitrary file into the current mail newsgroup
7164 (@code{gnus-summary-import-article}).  You will be prompted for a file
7165 name, a @code{From} header and a @code{Subject} header.
7166
7167 @item B r
7168 @kindex B r (Summary)
7169 @findex gnus-summary-respool-article
7170 Respool the mail article (@code{gnus-summary-move-article}).
7171 @code{gnus-summary-respool-default-method} will be used as the default
7172 select method when respooling.  This variable is @code{nil} by default,
7173 which means that the current group select method will be used instead.
7174
7175 @item B w
7176 @itemx e
7177 @kindex B w (Summary)
7178 @kindex e (Summary)
7179 @findex gnus-summary-edit-article
7180 @kindex C-c C-c (Article)
7181 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7182 editing and make the changes permanent, type @kbd{C-c C-c}
7183 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7184 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7185
7186 @item B q
7187 @kindex B q (Summary)
7188 @findex gnus-summary-respool-query
7189 If you want to re-spool an article, you might be curious as to what group
7190 the article will end up in before you do the re-spooling.  This command
7191 will tell you (@code{gnus-summary-respool-query}).
7192
7193 @item B t
7194 @kindex B t (Summary)
7195 @findex gnus-summary-respool-trace
7196 Similarly, this command will display all fancy splitting patterns used
7197 when repooling, if any (@code{gnus-summary-respool-trace}).
7198
7199 @item B p
7200 @kindex B p (Summary)
7201 @findex gnus-summary-article-posted-p
7202 Some people have a tendency to send you "courtesy" copies when they
7203 follow up to articles you have posted.  These usually have a
7204 @code{Newsgroups} header in them, but not always.  This command
7205 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7206 article from your news server (or rather, from
7207 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7208 report back whether it found the article or not.  Even if it says that
7209 it didn't find the article, it may have been posted anyway---mail
7210 propagation is much faster than news propagation, and the news copy may
7211 just not have arrived yet.
7212
7213 @end table
7214
7215 @vindex gnus-move-split-methods
7216 @cindex moving articles
7217 If you move (or copy) articles regularly, you might wish to have Gnus
7218 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7219 variable that uses the same syntax as @code{gnus-split-methods}
7220 (@pxref{Saving Articles}).  You may customize that variable to create
7221 suggestions you find reasonable.
7222
7223 @lisp
7224 (setq gnus-move-split-methods
7225       '(("^From:.*Lars Magne" "nnml:junk")
7226         ("^Subject:.*gnus" "nnfolder:important")
7227         (".*" "nnml:misc")))
7228 @end lisp
7229
7230
7231 @node Various Summary Stuff
7232 @section Various Summary Stuff
7233
7234 @menu
7235 * Summary Group Information::         Information oriented commands.
7236 * Searching for Articles::            Multiple article commands.
7237 * Summary Generation Commands::       (Re)generating the summary buffer.
7238 * Really Various Summary Commands::   Those pesky non-conformant commands.
7239 @end menu
7240
7241 @table @code
7242 @vindex gnus-summary-mode-hook
7243 @item gnus-summary-mode-hook
7244 This hook is called when creating a summary mode buffer.
7245
7246 @vindex gnus-summary-generate-hook
7247 @item gnus-summary-generate-hook
7248 This is called as the last thing before doing the threading and the
7249 generation of the summary buffer.  It's quite convenient for customizing
7250 the threading variables based on what data the newsgroup has.  This hook
7251 is called from the summary buffer after most summary buffer variables
7252 have been set.
7253
7254 @vindex gnus-summary-prepare-hook
7255 @item gnus-summary-prepare-hook
7256 It is called after the summary buffer has been generated.  You might use
7257 it to, for instance, highlight lines or modify the look of the buffer in
7258 some other ungodly manner.  I don't care.
7259
7260 @vindex gnus-summary-ignore-duplicates
7261 @item gnus-summary-ignore-duplicates
7262 When Gnus discovers two articles that have the same @code{Message-ID},
7263 it has to do something drastic.  No articles are allowed to have the
7264 same @code{Message-ID}, but this may happen when reading mail from some
7265 sources.  Gnus allows you to customize what happens with this variable.
7266 If it is @code{nil} (which is the default), Gnus will rename the
7267 @code{Message-ID} (for display purposes only) and display the article as
7268 any other article.  If this variable is @code{t}, it won't display the
7269 article---it'll be as if it never existed.
7270
7271 @end table
7272
7273
7274 @node Summary Group Information
7275 @subsection Summary Group Information
7276
7277 @table @kbd
7278
7279 @item H f
7280 @kindex H f (Summary)
7281 @findex gnus-summary-fetch-faq
7282 @vindex gnus-group-faq-directory
7283 Try to fetch the FAQ (list of frequently asked questions) for the
7284 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7285 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7286 on a remote machine.  This variable can also be a list of directories.
7287 In that case, giving a prefix to this command will allow you to choose
7288 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7289 be used for fetching the file.
7290
7291 @item H d
7292 @kindex H d (Summary)
7293 @findex gnus-summary-describe-group
7294 Give a brief description of the current group
7295 (@code{gnus-summary-describe-group}).  If given a prefix, force
7296 rereading the description from the server.
7297
7298 @item H h
7299 @kindex H h (Summary)
7300 @findex gnus-summary-describe-briefly
7301 Give an extremely brief description of the most important summary
7302 keystrokes (@code{gnus-summary-describe-briefly}).
7303
7304 @item H i
7305 @kindex H i (Summary)
7306 @findex gnus-info-find-node
7307 Go to the Gnus info node (@code{gnus-info-find-node}).
7308 @end table
7309
7310
7311 @node Searching for Articles
7312 @subsection Searching for Articles
7313
7314 @table @kbd
7315
7316 @item M-s
7317 @kindex M-s (Summary)
7318 @findex gnus-summary-search-article-forward
7319 Search through all subsequent articles for a regexp
7320 (@code{gnus-summary-search-article-forward}).
7321
7322 @item M-r
7323 @kindex M-r (Summary)
7324 @findex gnus-summary-search-article-backward
7325 Search through all previous articles for a regexp
7326 (@code{gnus-summary-search-article-backward}).
7327
7328 @item &
7329 @kindex & (Summary)
7330 @findex gnus-summary-execute-command
7331 This command will prompt you for a header field, a regular expression to
7332 match on this field, and a command to be executed if the match is made
7333 (@code{gnus-summary-execute-command}).  If given a prefix, search
7334 backward instead.
7335
7336 @item M-&
7337 @kindex M-& (Summary)
7338 @findex gnus-summary-universal-argument
7339 Perform any operation on all articles that have been marked with
7340 the process mark (@code{gnus-summary-universal-argument}).
7341 @end table
7342
7343 @node Summary Generation Commands
7344 @subsection Summary Generation Commands
7345
7346 @table @kbd
7347
7348 @item Y g
7349 @kindex Y g (Summary)
7350 @findex gnus-summary-prepare
7351 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7352
7353 @item Y c
7354 @kindex Y c (Summary)
7355 @findex gnus-summary-insert-cached-articles
7356 Pull all cached articles (for the current group) into the summary buffer
7357 (@code{gnus-summary-insert-cached-articles}).
7358
7359 @end table
7360
7361
7362 @node Really Various Summary Commands
7363 @subsection Really Various Summary Commands
7364
7365 @table @kbd
7366
7367 @item C-d
7368 @kindex C-d (Summary)
7369 @findex gnus-summary-enter-digest-group
7370 If the current article is a collection of other articles (for instance,
7371 a digest), you might use this command to enter a group based on the that
7372 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7373 guess what article type is currently displayed unless you give a prefix
7374 to this command, which forces a ``digest'' interpretation.  Basically,
7375 whenever you see a message that is a collection of other messages of
7376 some format, you @kbd{C-d} and read these messages in a more convenient
7377 fashion.
7378
7379 @item M-C-d
7380 @kindex M-C-d (Summary)
7381 @findex gnus-summary-read-document
7382 This command is very similar to the one above, but lets you gather
7383 several documents into one biiig group
7384 (@code{gnus-summary-read-document}).  It does this by opening several
7385 @code{nndoc} groups for each document, and then opening an
7386 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7387 command understands the process/prefix convention
7388 (@pxref{Process/Prefix}).
7389
7390 @item C-t
7391 @kindex C-t (Summary)
7392 @findex gnus-summary-toggle-truncation
7393 Toggle truncation of summary lines
7394 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7395 line centering function in the summary buffer, so it's not a good idea
7396 to have truncation switched off while reading articles.
7397
7398 @item =
7399 @kindex = (Summary)
7400 @findex gnus-summary-expand-window
7401 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7402 If given a prefix, force an @code{article} window configuration.
7403
7404 @item M-C-e
7405 @kindex M-C-e (Summary)
7406 @findex gnus-summary-edit-parameters
7407 Edit the group parameters (@pxref{Group Parameters}) of the current
7408 group (@code{gnus-summary-edit-parameters}).
7409
7410 @end table
7411
7412
7413 @node Exiting the Summary Buffer
7414 @section Exiting the Summary Buffer
7415 @cindex summary exit
7416 @cindex exiting groups
7417
7418 Exiting from the summary buffer will normally update all info on the
7419 group and return you to the group buffer.
7420
7421 @table @kbd
7422
7423 @item Z Z
7424 @itemx q
7425 @kindex Z Z (Summary)
7426 @kindex q (Summary)
7427 @findex gnus-summary-exit
7428 @vindex gnus-summary-exit-hook
7429 @vindex gnus-summary-prepare-exit-hook
7430 @c @icon{gnus-summary-exit}
7431 Exit the current group and update all information on the group
7432 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7433 called before doing much of the exiting, which calls
7434 @code{gnus-summary-expire-articles} by default.
7435 @code{gnus-summary-exit-hook} is called after finishing the exit
7436 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7437 group mode having no more (unread) groups.
7438
7439 @item Z E
7440 @itemx Q
7441 @kindex Z E (Summary)
7442 @kindex Q (Summary)
7443 @findex gnus-summary-exit-no-update
7444 Exit the current group without updating any information on the group
7445 (@code{gnus-summary-exit-no-update}).
7446
7447 @item Z c
7448 @itemx c
7449 @kindex Z c (Summary)
7450 @kindex c (Summary)
7451 @findex gnus-summary-catchup-and-exit
7452 @c @icon{gnus-summary-catchup-and-exit}
7453 Mark all unticked articles in the group as read and then exit
7454 (@code{gnus-summary-catchup-and-exit}).
7455
7456 @item Z C
7457 @kindex Z C (Summary)
7458 @findex gnus-summary-catchup-all-and-exit
7459 Mark all articles, even the ticked ones, as read and then exit
7460 (@code{gnus-summary-catchup-all-and-exit}).
7461
7462 @item Z n
7463 @kindex Z n (Summary)
7464 @findex gnus-summary-catchup-and-goto-next-group
7465 Mark all articles as read and go to the next group
7466 (@code{gnus-summary-catchup-and-goto-next-group}).
7467
7468 @item Z R
7469 @kindex Z R (Summary)
7470 @findex gnus-summary-reselect-current-group
7471 Exit this group, and then enter it again
7472 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7473 all articles, both read and unread.
7474
7475 @item Z G
7476 @itemx M-g
7477 @kindex Z G (Summary)
7478 @kindex M-g (Summary)
7479 @findex gnus-summary-rescan-group
7480 @c @icon{gnus-summary-mail-get}
7481 Exit the group, check for new articles in the group, and select the
7482 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7483 articles, both read and unread.
7484
7485 @item Z N
7486 @kindex Z N (Summary)
7487 @findex gnus-summary-next-group
7488 Exit the group and go to the next group
7489 (@code{gnus-summary-next-group}).
7490
7491 @item Z P
7492 @kindex Z P (Summary)
7493 @findex gnus-summary-prev-group
7494 Exit the group and go to the previous group
7495 (@code{gnus-summary-prev-group}).
7496
7497 @item Z s
7498 @kindex Z s (Summary)
7499 @findex gnus-summary-save-newsrc
7500 Save the current number of read/marked articles in the dribble buffer
7501 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7502 given a prefix, also save the @file{.newsrc} file(s).  Using this
7503 command will make exit without updating (the @kbd{Q} command) worthless.
7504 @end table
7505
7506 @vindex gnus-exit-group-hook
7507 @code{gnus-exit-group-hook} is called when you exit the current
7508 group.
7509
7510 @findex gnus-summary-wake-up-the-dead
7511 @findex gnus-dead-summary-mode
7512 @vindex gnus-kill-summary-on-exit
7513 If you're in the habit of exiting groups, and then changing your mind
7514 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7515 If you do that, Gnus won't kill the summary buffer when you exit it.
7516 (Quelle surprise!)  Instead it will change the name of the buffer to
7517 something like @samp{*Dead Summary ... *} and install a minor mode
7518 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7519 buffer, you'll find that all keys are mapped to a function called
7520 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7521 summary buffer will result in a live, normal summary buffer.
7522
7523 There will never be more than one dead summary buffer at any one time.
7524
7525 @vindex gnus-use-cross-reference
7526 The data on the current group will be updated (which articles you have
7527 read, which articles you have replied to, etc.) when you exit the
7528 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7529 @code{t} (which is the default), articles that are cross-referenced to
7530 this group and are marked as read, will also be marked as read in the
7531 other subscribed groups they were cross-posted to.  If this variable is
7532 neither @code{nil} nor @code{t}, the article will be marked as read in
7533 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7534
7535
7536 @node Crosspost Handling
7537 @section Crosspost Handling
7538
7539 @cindex velveeta
7540 @cindex spamming
7541 Marking cross-posted articles as read ensures that you'll never have to
7542 read the same article more than once.  Unless, of course, somebody has
7543 posted it to several groups separately.  Posting the same article to
7544 several groups (not cross-posting) is called @dfn{spamming}, and you are
7545 by law required to send nasty-grams to anyone who perpetrates such a
7546 heinous crime.  You may want to try NoCeM handling to filter out spam
7547 (@pxref{NoCeM}).
7548
7549 Remember: Cross-posting is kinda ok, but posting the same article
7550 separately to several groups is not.  Massive cross-posting (aka.
7551 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7552 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7553 excessive crossposting (@pxref{Summary Mail Commands}).
7554
7555 @cindex cross-posting
7556 @cindex Xref
7557 @cindex @sc{nov}
7558 One thing that may cause Gnus to not do the cross-posting thing
7559 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7560 (which is very nice, because it speeds things up considerably) which
7561 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7562 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7563 even with @sc{xover} by registering the @code{Xref} lines of all
7564 articles you actually read, but if you kill the articles, or just mark
7565 them as read without reading them, Gnus will not get a chance to snoop
7566 the @code{Xref} lines out of these articles, and will be unable to use
7567 the cross reference mechanism.
7568
7569 @cindex LIST overview.fmt
7570 @cindex overview.fmt
7571 To check whether your @sc{nntp} server includes the @code{Xref} header
7572 in its overview files, try @samp{telnet your.nntp.server nntp},
7573 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7574 overview.fmt}.  This may not work, but if it does, and the last line you
7575 get does not read @samp{Xref:full}, then you should shout and whine at
7576 your news admin until she includes the @code{Xref} header in the
7577 overview files.
7578
7579 @vindex gnus-nov-is-evil
7580 If you want Gnus to get the @code{Xref}s right all the time, you have to
7581 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7582 considerably.
7583
7584 C'est la vie.
7585
7586 For an alternative approach, @pxref{Duplicate Suppression}.
7587
7588
7589 @node Duplicate Suppression
7590 @section Duplicate Suppression
7591
7592 By default, Gnus tries to make sure that you don't have to read the same
7593 article more than once by utilizing the crossposting mechanism
7594 (@pxref{Crosspost Handling}).  However, that simple and efficient
7595 approach may not work satisfactory for some users for various
7596 reasons.
7597
7598 @enumerate
7599 @item
7600 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7601 is evil and not very common.
7602
7603 @item
7604 The @sc{nntp} server may fail to include the @code{Xref} header in the
7605 @file{.overview} data bases.  This is evil and all too common, alas.
7606
7607 @item
7608 You may be reading the same group (or several related groups) from
7609 different @sc{nntp} servers.
7610
7611 @item
7612 You may be getting mail that duplicates articles posted to groups.
7613 @end enumerate
7614
7615 I'm sure there are other situations where @code{Xref} handling fails as
7616 well, but these four are the most common situations.
7617
7618 If, and only if, @code{Xref} handling fails for you, then you may
7619 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7620 will remember the @code{Message-ID}s of all articles you have read or
7621 otherwise marked as read, and then, as if by magic, mark them as read
7622 all subsequent times you see them---in @emph{all} groups.  Using this
7623 mechanism is quite likely to be somewhat inefficient, but not overly
7624 so.  It's certainly preferable to reading the same articles more than
7625 once.
7626
7627 Duplicate suppression is not a very subtle instrument.  It's more like a
7628 sledge hammer than anything else.  It works in a very simple
7629 fashion---if you have marked an article as read, it adds this Message-ID
7630 to a cache.  The next time it sees this Message-ID, it will mark the
7631 article as read with the @samp{M} mark.  It doesn't care what group it
7632 saw the article in.
7633
7634 @table @code
7635 @item gnus-suppress-duplicates
7636 @vindex gnus-suppress-duplicates
7637 If non-@code{nil}, suppress duplicates.
7638
7639 @item gnus-save-duplicate-list
7640 @vindex gnus-save-duplicate-list
7641 If non-@code{nil}, save the list of duplicates to a file.  This will
7642 make startup and shutdown take longer, so the default is @code{nil}.
7643 However, this means that only duplicate articles read in a single Gnus
7644 session are suppressed.
7645
7646 @item gnus-duplicate-list-length
7647 @vindex gnus-duplicate-list-length
7648 This variable says how many @code{Message-ID}s to keep in the duplicate
7649 suppression list.  The default is 10000.
7650
7651 @item gnus-duplicate-file
7652 @vindex gnus-duplicate-file
7653 The name of the file to store the duplicate suppression list in.  The
7654 default is @file{~/News/suppression}.
7655 @end table
7656
7657 If you have a tendency to stop and start Gnus often, setting
7658 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7659 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7660 the other hand, saving the list makes startup and shutdown much slower,
7661 so that means that if you stop and start Gnus often, you should set
7662 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7663 to you to figure out, I think.
7664
7665
7666 @node The Article Buffer
7667 @chapter The Article Buffer
7668 @cindex article buffer
7669
7670 The articles are displayed in the article buffer, of which there is only
7671 one.  All the summary buffers share the same article buffer unless you
7672 tell Gnus otherwise.
7673
7674 @menu
7675 * Hiding Headers::        Deciding what headers should be displayed.
7676 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7677 * Customizing Articles::  Tailoring the look of the articles.
7678 * Article Keymap::        Keystrokes available in the article buffer.
7679 * Misc Article::          Other stuff.
7680 @end menu
7681
7682
7683 @node Hiding Headers
7684 @section Hiding Headers
7685 @cindex hiding headers
7686 @cindex deleting headers
7687
7688 The top section of each article is the @dfn{head}.  (The rest is the
7689 @dfn{body}, but you may have guessed that already.)
7690
7691 @vindex gnus-show-all-headers
7692 There is a lot of useful information in the head: the name of the person
7693 who wrote the article, the date it was written and the subject of the
7694 article.  That's well and nice, but there's also lots of information
7695 most people do not want to see---what systems the article has passed
7696 through before reaching you, the @code{Message-ID}, the
7697 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7698 of some of those lines.  If you want to keep all those lines in the
7699 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7700
7701 Gnus provides you with two variables for sifting headers:
7702
7703 @table @code
7704
7705 @item gnus-visible-headers
7706 @vindex gnus-visible-headers
7707 If this variable is non-@code{nil}, it should be a regular expression
7708 that says what headers you wish to keep in the article buffer.  All
7709 headers that do not match this variable will be hidden.
7710
7711 For instance, if you only want to see the name of the person who wrote
7712 the article and the subject, you'd say:
7713
7714 @lisp
7715 (setq gnus-visible-headers "^From:\\|^Subject:")
7716 @end lisp
7717
7718 This variable can also be a list of regexps to match headers to
7719 remain visible.
7720
7721 @item gnus-ignored-headers
7722 @vindex gnus-ignored-headers
7723 This variable is the reverse of @code{gnus-visible-headers}.  If this
7724 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7725 should be a regular expression that matches all lines that you want to
7726 hide.  All lines that do not match this variable will remain visible.
7727
7728 For instance, if you just want to get rid of the @code{References} line
7729 and the @code{Xref} line, you might say:
7730
7731 @lisp
7732 (setq gnus-ignored-headers "^References:\\|^Xref:")
7733 @end lisp
7734
7735 This variable can also be a list of regexps to match headers to
7736 be removed.
7737
7738 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7739 variable will have no effect.
7740
7741 @end table
7742
7743 @vindex gnus-sorted-header-list
7744 Gnus can also sort the headers for you.  (It does this by default.)  You
7745 can control the sorting by setting the @code{gnus-sorted-header-list}
7746 variable.  It is a list of regular expressions that says in what order
7747 the headers are to be displayed.
7748
7749 For instance, if you want the name of the author of the article first,
7750 and then the subject, you might say something like:
7751
7752 @lisp
7753 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7754 @end lisp
7755
7756 Any headers that are to remain visible, but are not listed in this
7757 variable, will be displayed in random order after all the headers listed in this variable.
7758
7759 @findex gnus-article-hide-boring-headers
7760 @vindex gnus-article-display-hook
7761 @vindex gnus-boring-article-headers
7762 You can hide further boring headers by entering
7763 @code{gnus-article-hide-boring-headers} into
7764 @code{gnus-article-display-hook}.  What this function does depends on
7765 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7766 list doesn't actually contain header names.  Instead is lists various
7767 @dfn{boring conditions} that Gnus can check and remove from sight.
7768
7769 These conditions are:
7770 @table @code
7771 @item empty
7772 Remove all empty headers.
7773 @item newsgroups
7774 Remove the @code{Newsgroups} header if it only contains the current group
7775 name.
7776 @item followup-to
7777 Remove the @code{Followup-To} header if it is identical to the
7778 @code{Newsgroups} header.
7779 @item reply-to
7780 Remove the @code{Reply-To} header if it lists the same address as the
7781 @code{From} header.
7782 @item date
7783 Remove the @code{Date} header if the article is less than three days
7784 old.
7785 @item long-to
7786 Remove the @code{To} header if it is very long.
7787 @item many-to
7788 Remove all @code{To} headers if there are more than one.
7789 @end table
7790
7791 To include the four first elements, you could say something like;
7792
7793 @lisp
7794 (setq gnus-boring-article-headers
7795       '(empty newsgroups followup-to reply-to))
7796 @end lisp
7797
7798 This is also the default value for this variable.
7799
7800
7801 @node Using MIME
7802 @section Using @sc{mime}
7803 @cindex @sc{mime}
7804
7805 Mime is a standard for waving your hands through the air, aimlessly,
7806 while people stand around yawning.
7807
7808 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7809 while all newsreaders die of fear.
7810
7811 @sc{mime} may specify what character set the article uses, the encoding
7812 of the characters, and it also makes it possible to embed pictures and
7813 other naughty stuff in innocent-looking articles.
7814
7815 @vindex gnus-show-mime
7816 @vindex gnus-show-mime-method
7817 @vindex gnus-strict-mime
7818 @findex metamail-buffer
7819 Gnus handles @sc{mime} by pushing the articles through
7820 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7821 default.  This function calls the external @code{metamail} program to
7822 actually do the work.  One common problem with this program is that is
7823 thinks that it can't display 8-bit things in the Emacs buffer.  To tell
7824 it the truth, put something like the following in your
7825 @file{.bash_profile} file.  (You do use @code{bash}, don't you?)
7826
7827 @example
7828 export MM_CHARSET="iso-8859-1"
7829 @end example
7830
7831 For more information on @code{metamail}, see its manual page.
7832
7833 Set @code{gnus-show-mime} to @code{t} if you want to use
7834 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7835 non-@code{nil}, the @sc{mime} method will only be used if there are
7836 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7837 set, then you'll see some unfortunate display glitches in the article
7838 buffer.  These can't be avoided.
7839
7840 It might be best to just use the toggling functions from the summary
7841 buffer to avoid getting nasty surprises. (For instance, you enter the
7842 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7843 decoded the sound file in the article and some horrible sing-a-long song
7844 comes screaming out your speakers, and you can't find the volume
7845 button, because there isn't one, and people are starting to look at you,
7846 and you try to stop the program, but you can't, and you can't find the
7847 program to control the volume, and everybody else in the room suddenly
7848 decides to look at you disdainfully, and you'll feel rather stupid.)
7849
7850 Any similarity to real events and people is purely coincidental.  Ahem.
7851
7852
7853 @node Customizing Articles
7854 @section Customizing Articles
7855 @cindex article customization
7856
7857 @vindex gnus-article-display-hook
7858 The @code{gnus-article-display-hook} is called after the article has
7859 been inserted into the article buffer.  It is meant to handle all
7860 treatment of the article before it is displayed.
7861
7862 @findex gnus-article-maybe-highlight
7863 By default this hook just contains @code{gnus-article-hide-headers},
7864 @code{gnus-article-treat-overstrike}, and
7865 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7866 millions, of functions you can put in this hook.  For an overview of
7867 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7868 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7869 Date}.  Note that the order of functions in this hook might affect
7870 things, so you may have to fiddle a bit to get the desired results.
7871
7872 You can, of course, write your own functions.  The functions are called
7873 from the article buffer, and you can do anything you like, pretty much.
7874 There is no information that you have to keep in the buffer---you can
7875 change everything.  However, you shouldn't delete any headers.  Instead
7876 make them invisible if you want to make them go away.
7877
7878
7879 @node Article Keymap
7880 @section Article Keymap
7881
7882 Most of the keystrokes in the summary buffer can also be used in the
7883 article buffer.  They should behave as if you typed them in the summary
7884 buffer, which means that you don't actually have to have a summary
7885 buffer displayed while reading.  You can do it all from the article
7886 buffer.
7887
7888 A few additional keystrokes are available:
7889
7890 @table @kbd
7891
7892 @item SPACE
7893 @kindex SPACE (Article)
7894 @findex gnus-article-next-page
7895 Scroll forwards one page (@code{gnus-article-next-page}).
7896
7897 @item DEL
7898 @kindex DEL (Article)
7899 @findex gnus-article-prev-page
7900 Scroll backwards one page (@code{gnus-article-prev-page}).
7901
7902 @item C-c ^
7903 @kindex C-c ^ (Article)
7904 @findex gnus-article-refer-article
7905 If point is in the neighborhood of a @code{Message-ID} and you press
7906 @kbd{C-c ^}, Gnus will try to get that article from the server
7907 (@code{gnus-article-refer-article}).
7908
7909 @item C-c C-m
7910 @kindex C-c C-m (Article)
7911 @findex gnus-article-mail
7912 Send a reply to the address near point (@code{gnus-article-mail}).  If
7913 given a prefix, include the mail.
7914
7915 @item s
7916 @kindex s (Article)
7917 @findex gnus-article-show-summary
7918 Reconfigure the buffers so that the summary buffer becomes visible
7919 (@code{gnus-article-show-summary}).
7920
7921 @item ?
7922 @kindex ? (Article)
7923 @findex gnus-article-describe-briefly
7924 Give a very brief description of the available keystrokes
7925 (@code{gnus-article-describe-briefly}).
7926
7927 @item TAB
7928 @kindex TAB (Article)
7929 @findex gnus-article-next-button
7930 Go to the next button, if any (@code{gnus-article-next-button}).  This
7931 only makes sense if you have buttonizing turned on.
7932
7933 @item M-TAB
7934 @kindex M-TAB (Article)
7935 @findex gnus-article-prev-button
7936 Go to the previous button, if any (@code{gnus-article-prev-button}).
7937
7938 @end table
7939
7940
7941 @node Misc Article
7942 @section Misc Article
7943
7944 @table @code
7945
7946 @item gnus-single-article-buffer
7947 @vindex gnus-single-article-buffer
7948 If non-@code{nil}, use the same article buffer for all the groups.
7949 (This is the default.)  If @code{nil}, each group will have its own
7950 article buffer.
7951
7952 @vindex gnus-article-prepare-hook
7953 @item gnus-article-prepare-hook
7954 This hook is called right after the article has been inserted into the
7955 article buffer.  It is mainly intended for functions that do something
7956 depending on the contents; it should probably not be used for changing
7957 the contents of the article buffer.
7958
7959 @vindex gnus-article-display-hook
7960 @item gnus-article-display-hook
7961 This hook is called as the last thing when displaying an article, and is
7962 intended for modifying the contents of the buffer, doing highlights,
7963 hiding headers, and the like.
7964
7965 @item gnus-article-mode-hook
7966 @vindex gnus-article-mode-hook
7967 Hook called in article mode buffers.
7968
7969 @item gnus-article-mode-syntax-table
7970 @vindex gnus-article-mode-syntax-table
7971 Syntax table used in article buffers.  It is initialized from
7972 @code{text-mode-syntax-table}.
7973
7974 @vindex gnus-article-mode-line-format
7975 @item gnus-article-mode-line-format
7976 This variable is a format string along the same lines as
7977 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
7978 accepts the same format specifications as that variable, with one
7979 extension:
7980
7981 @table @samp
7982 @item w
7983 The @dfn{wash status} of the article.  This is a short string with one
7984 character for each possible article wash operation that may have been
7985 performed.
7986 @end table
7987
7988 @vindex gnus-break-pages
7989
7990 @item gnus-break-pages
7991 Controls whether @dfn{page breaking} is to take place.  If this variable
7992 is non-@code{nil}, the articles will be divided into pages whenever a
7993 page delimiter appears in the article.  If this variable is @code{nil},
7994 paging will not be done.
7995
7996 @item gnus-page-delimiter
7997 @vindex gnus-page-delimiter
7998 This is the delimiter mentioned above.  By default, it is @samp{^L}
7999 (formfeed).
8000 @end table
8001
8002
8003 @node Composing Messages
8004 @chapter Composing Messages
8005 @cindex composing messages
8006 @cindex messages
8007 @cindex mail
8008 @cindex sending mail
8009 @cindex reply
8010 @cindex followup
8011 @cindex post
8012
8013 @kindex C-c C-c (Post)
8014 All commands for posting and mailing will put you in a message buffer
8015 where you can edit the article all you like, before you send the article
8016 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
8017 Manual}.  If you are in a foreign news group, and you wish to post the
8018 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8019 to make Gnus try to post using the foreign server.
8020
8021 @menu
8022 * Mail::                 Mailing and replying.
8023 * Post::                 Posting and following up.
8024 * Posting Server::       What server should you post via?
8025 * Mail and Post::        Mailing and posting at the same time.
8026 * Archived Messages::    Where Gnus stores the messages you've sent.
8027 * Posting Styles::       An easier way to specify who you are.
8028 * Drafts::               Postponing messages and rejected messages.
8029 * Rejected Articles::    What happens if the server doesn't like your article?
8030 @end menu
8031
8032 Also see @pxref{Canceling and Superseding} for information on how to
8033 remove articles you shouldn't have posted.
8034
8035
8036 @node Mail
8037 @section Mail
8038
8039 Variables for customizing outgoing mail:
8040
8041 @table @code
8042 @item gnus-uu-digest-headers
8043 @vindex gnus-uu-digest-headers
8044 List of regexps to match headers included in digested messages.  The
8045 headers will be included in the sequence they are matched.
8046
8047 @item gnus-add-to-list
8048 @vindex gnus-add-to-list
8049 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8050 that have none when you do a @kbd{a}.
8051
8052 @end table
8053
8054
8055 @node Post
8056 @section Post
8057
8058 Variables for composing news articles:
8059
8060 @table @code
8061 @item gnus-sent-message-ids-file
8062 @vindex gnus-sent-message-ids-file
8063 Gnus will keep a @code{Message-ID} history file of all the mails it has
8064 sent.  If it discovers that it has already sent a mail, it will ask the
8065 user whether to re-send the mail.  (This is primarily useful when
8066 dealing with @sc{soup} packets and the like where one is apt to send the
8067 same packet multiple times.)  This variable says what the name of this
8068 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8069 this variable to @code{nil} if you don't want Gnus to keep a history
8070 file.
8071
8072 @item gnus-sent-message-ids-length
8073 @vindex gnus-sent-message-ids-length
8074 This variable says how many @code{Message-ID}s to keep in the history
8075 file.  It is 1000 by default.
8076
8077 @end table
8078
8079
8080 @node Posting Server
8081 @section Posting Server
8082
8083 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8084 (extremely intelligent, of course) article, where does it go?
8085
8086 Thank you for asking.  I hate you.
8087
8088 @vindex gnus-post-method
8089
8090 It can be quite complicated.  Normally, Gnus will use the same native
8091 server.  However.  If your native server doesn't allow posting, just
8092 reading, you probably want to use some other server to post your
8093 (extremely intelligent and fabulously interesting) articles.  You can
8094 then set the @code{gnus-post-method} to some other method:
8095
8096 @lisp
8097 (setq gnus-post-method '(nnspool ""))
8098 @end lisp
8099
8100 Now, if you've done this, and then this server rejects your article, or
8101 this server is down, what do you do then?  To override this variable you
8102 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8103 the ``current'' server for posting.
8104
8105 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8106 Gnus will prompt you for what method to use for posting.
8107
8108 You can also set @code{gnus-post-method} to a list of select methods.
8109 If that's the case, Gnus will always prompt you for what method to use
8110 for posting.
8111
8112 Finally, if you want to always post using the same select method as
8113 you're reading from (which might be convenient if you're reading lots of
8114 groups from different private servers), you can set this variable to
8115 @code{current}. 
8116
8117
8118 @node Mail and Post
8119 @section Mail and Post
8120
8121 Here's a list of variables relevant to both mailing and
8122 posting:
8123
8124 @table @code
8125 @item gnus-mailing-list-groups
8126 @findex gnus-mailing-list-groups
8127 @cindex mailing lists
8128
8129 If your news server offers groups that are really mailing lists
8130 gatewayed to the @sc{nntp} server, you can read those groups without
8131 problems, but you can't post/followup to them without some difficulty.
8132 One solution is to add a @code{to-address} to the group parameters
8133 (@pxref{Group Parameters}).  An easier thing to do is set the
8134 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8135 really are mailing lists.  Then, at least, followups to the mailing
8136 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8137 still a pain, though.
8138
8139 @end table
8140
8141 You may want to do spell-checking on messages that you send out.  Or, if
8142 you don't want to spell-check by hand, you could add automatic
8143 spell-checking via the @code{ispell} package:
8144
8145 @cindex ispell
8146 @findex ispell-message
8147 @lisp
8148 (add-hook 'message-send-hook 'ispell-message)
8149 @end lisp
8150
8151
8152 @node Archived Messages
8153 @section Archived Messages
8154 @cindex archived messages
8155 @cindex sent messages
8156
8157 Gnus provides a few different methods for storing the mail and news you
8158 send.  The default method is to use the @dfn{archive virtual server} to
8159 store the messages.  If you want to disable this completely, the
8160 @code{gnus-message-archive-group} variable should be @code{nil}, which
8161 is the default.
8162
8163 @vindex gnus-message-archive-method
8164 @code{gnus-message-archive-method} says what virtual server Gnus is to
8165 use to store sent messages.  The default is:
8166
8167 @lisp
8168 (nnfolder "archive"
8169           (nnfolder-directory   "~/Mail/archive")
8170           (nnfolder-active-file "~/Mail/archive/active")
8171           (nnfolder-get-new-mail nil)
8172           (nnfolder-inhibit-expiry t))
8173 @end lisp
8174
8175 You can, however, use any mail select method (@code{nnml},
8176 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8177 for doing this sort of thing, though.  If you don't like the default
8178 directory chosen, you could say something like:
8179
8180 @lisp
8181 (setq gnus-message-archive-method
8182       '(nnfolder "archive"
8183                  (nnfolder-inhibit-expiry t)
8184                  (nnfolder-active-file "~/News/sent-mail/active")
8185                  (nnfolder-directory "~/News/sent-mail/")))
8186 @end lisp
8187
8188 @vindex gnus-message-archive-group
8189 @cindex Gcc
8190 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8191 to one or more group(s) on that server.  Which group to use is
8192 determined by the @code{gnus-message-archive-group} variable.
8193
8194 This variable can be used to do the following:
8195
8196 @itemize @bullet
8197 @item a string
8198 Messages will be saved in that group.
8199 @item a list of strings
8200 Messages will be saved in all those groups.
8201 @item an alist of regexps, functions and forms
8202 When a key ``matches'', the result is used.
8203 @item @code{nil}
8204 No message archiving will take place.  This is the default.
8205 @end itemize
8206
8207 Let's illustrate:
8208
8209 Just saving to a single group called @samp{MisK}:
8210 @lisp
8211 (setq gnus-message-archive-group "MisK")
8212 @end lisp
8213
8214 Saving to two groups, @samp{MisK} and @samp{safe}:
8215 @lisp
8216 (setq gnus-message-archive-group '("MisK" "safe"))
8217 @end lisp
8218
8219 Save to different groups based on what group you are in:
8220 @lisp
8221 (setq gnus-message-archive-group
8222       '(("^alt" "sent-to-alt")
8223         ("mail" "sent-to-mail")
8224         (".*" "sent-to-misc")))
8225 @end lisp
8226
8227 More complex stuff:
8228 @lisp
8229 (setq gnus-message-archive-group
8230       '((if (message-news-p)
8231             "misc-news"
8232           "misc-mail")))
8233 @end lisp
8234
8235 How about storing all news messages in one file, but storing all mail
8236 messages in one file per month:
8237
8238 @lisp
8239 (setq gnus-message-archive-group
8240       '((if (message-news-p)
8241             "misc-news"
8242           (concat "mail." (format-time-string
8243                            "%Y-%m" (current-time))))))
8244 @end lisp
8245
8246 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8247 use a different value for @code{gnus-message-archive-group} there.)
8248
8249 Now, when you send a message off, it will be stored in the appropriate
8250 group.  (If you want to disable storing for just one particular message,
8251 you can just remove the @code{Gcc} header that has been inserted.)  The
8252 archive group will appear in the group buffer the next time you start
8253 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
8254 enter it and read the articles in it just like you'd read any other
8255 group.  If the group gets really big and annoying, you can simply rename
8256 if (using @kbd{G r} in the group buffer) to something
8257 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8258 continue to be stored in the old (now empty) group.
8259
8260 That's the default method of archiving sent messages.  Gnus offers a
8261 different way for the people who don't like the default method.  In that
8262 case you should set @code{gnus-message-archive-group} to @code{nil};
8263 this will disable archiving.
8264
8265 @table @code
8266 @item gnus-outgoing-message-group
8267 @vindex gnus-outgoing-message-group
8268 All outgoing messages will be put in this group.  If you want to store
8269 all your outgoing mail and articles in the group @samp{nnml:archive},
8270 you set this variable to that value.  This variable can also be a list of
8271 group names.
8272
8273 If you want to have greater control over what group to put each
8274 message in, you can set this variable to a function that checks the
8275 current newsgroup name and then returns a suitable group name (or list
8276 of names).
8277
8278 This variable can be used instead of @code{gnus-message-archive-group},
8279 but the latter is the preferred method.
8280 @end table
8281
8282
8283 @node Posting Styles
8284 @section Posting Styles
8285 @cindex posting styles
8286 @cindex styles
8287
8288 All them variables, they make my head swim.
8289
8290 So what if you want a different @code{Organization} and signature based
8291 on what groups you post to?  And you post both from your home machine
8292 and your work machine, and you want different @code{From} lines, and so
8293 on?
8294
8295 @vindex gnus-posting-styles
8296 One way to do stuff like that is to write clever hooks that change the
8297 variables you need to have changed.  That's a bit boring, so somebody
8298 came up with the bright idea of letting the user specify these things in
8299 a handy alist.  Here's an example of a @code{gnus-posting-styles}
8300 variable:
8301
8302 @lisp
8303 ((".*"
8304   (signature "Peace and happiness")
8305   (organization "What me?"))
8306  ("^comp"
8307   (signature "Death to everybody"))
8308  ("comp.emacs.i-love-it"
8309   (organization "Emacs is it")))
8310 @end lisp
8311
8312 As you might surmise from this example, this alist consists of several
8313 @dfn{styles}.  Each style will be applicable if the first element
8314 ``matches'', in some form or other.  The entire alist will be iterated
8315 over, from the beginning towards the end, and each match will be
8316 applied, which means that attributes in later styles that match override
8317 the same attributes in earlier matching styles.  So
8318 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8319 signature and the @samp{What me?} @code{Organization} header.
8320
8321 The first element in each style is called the @code{match}.  If it's a
8322 string, then Gnus will try to regexp match it against the group name.
8323 If it's a function symbol, that function will be called with no
8324 arguments.  If it's a variable symbol, then the variable will be
8325 referenced.  If it's a list, then that list will be @code{eval}ed.  In
8326 any case, if this returns a non-@code{nil} value, then the style is said
8327 to @dfn{match}.
8328
8329 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8330 attribute consists of a @var{(name . value)} pair.  The attribute name
8331 can be one of @code{signature}, @code{signature-file},
8332 @code{organization}, @code{address} or @code{name}.  The attribute name
8333 can also be a string.  In that case, this will be used as a header name,
8334 and the value will be inserted in the headers of the article.
8335
8336 The attribute value can be a string (used verbatim), a function (the
8337 return value will be used), a variable (its value will be used) or a
8338 list (it will be @code{eval}ed and the return value will be used).
8339
8340 So here's a new example:
8341
8342 @lisp
8343 (setq gnus-posting-styles
8344       '((".*"
8345          (signature-file "~/.signature")
8346          (name "User Name")
8347          ("X-Home-Page" (getenv "WWW_HOME"))
8348          (organization "People's Front Against MWM"))
8349         ("^rec.humor"
8350          (signature my-funny-signature-randomizer))
8351         ((equal (system-name) "gnarly")
8352          (signature my-quote-randomizer))
8353         (posting-from-work-p
8354          (signature-file "~/.work-signature")
8355          (address "user@@bar.foo")
8356          (organization "Important Work, Inc"))
8357         ("^nn.+:"
8358          (signature-file "~/.mail-signature"))))
8359 @end lisp
8360
8361 @node Drafts
8362 @section Drafts
8363 @cindex drafts
8364
8365 If you are writing a message (mail or news) and suddenly remember that
8366 you have a steak in the oven (or some pesto in the food processor, you
8367 craaazy vegetarians), you'll probably wish there was a method to save
8368 the message you are writing so that you can continue editing it some
8369 other day, and send it when you feel its finished.
8370
8371 Well, don't worry about it.  Whenever you start composing a message of
8372 some sort using the Gnus mail and post commands, the buffer you get will
8373 automatically associate to an article in a special @dfn{draft} group.
8374 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8375 article will be saved there.  (Auto-save files also go to the draft
8376 group.)
8377
8378 @cindex nndraft
8379 @vindex nndraft-directory
8380 The draft group is a special group (which is implemented as an
8381 @code{nndraft} group, if you absolutely have to know) called
8382 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8383 @code{nndraft} is to store its files.  What makes this group special is
8384 that you can't tick any articles in it or mark any articles as
8385 read---all articles in the group are permanently unread.
8386
8387 If the group doesn't exist, it will be created and you'll be subscribed
8388 to it.  The only way to make it disappear from the Group buffer is to
8389 unsubscribe it.
8390
8391 @c @findex gnus-dissociate-buffer-from-draft
8392 @c @kindex C-c M-d (Mail)
8393 @c @kindex C-c M-d (Post)
8394 @c @findex gnus-associate-buffer-with-draft
8395 @c @kindex C-c C-d (Mail)
8396 @c @kindex C-c C-d (Post)
8397 @c If you're writing some super-secret message that you later want to
8398 @c encode with PGP before sending, you may wish to turn the auto-saving
8399 @c (and association with the draft group) off.  You never know who might be
8400 @c interested in reading all your extremely valuable and terribly horrible
8401 @c and interesting secrets.  The @kbd{C-c M-d}
8402 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8403 @c If you change your mind and want to turn the auto-saving back on again,
8404 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8405 @c
8406 @c @vindex gnus-use-draft
8407 @c To leave association with the draft group off by default, set
8408 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
8409
8410 @findex gnus-draft-edit-message
8411 @kindex D e (Draft)
8412 When you want to continue editing the article, you simply enter the
8413 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8414 that.  You will be placed in a buffer where you left off.
8415
8416 Rejected articles will also be put in this draft group (@pxref{Rejected
8417 Articles}).
8418
8419 @findex gnus-draft-send-all-messages
8420 @findex gnus-draft-send-message
8421 If you have lots of rejected messages you want to post (or mail) without
8422 doing further editing, you can use the @kbd{D s} command
8423 (@code{gnus-draft-send-message}).  This command understands the
8424 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
8425 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8426 in the buffer.
8427
8428 If you have some messages that you wish not to send, you can use the
8429 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8430 as unsendable.  This is a toggling command.
8431
8432
8433 @node Rejected Articles
8434 @section Rejected Articles
8435 @cindex rejected articles
8436
8437 Sometimes a news server will reject an article.  Perhaps the server
8438 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
8439 @emph{there be demons}.  Perhaps you have included too much cited text.
8440 Perhaps the disk is full.  Perhaps the server is down.
8441
8442 These situations are, of course, totally beyond the control of Gnus.
8443 (Gnus, of course, loves the way you look, always feels great, has angels
8444 fluttering around inside of it, doesn't care about how much cited text
8445 you include, never runs full and never goes down.)  So Gnus saves these
8446 articles until some later time when the server feels better.
8447
8448 The rejected articles will automatically be put in a special draft group
8449 (@pxref{Drafts}).  When the server comes back up again, you'd then
8450 typically enter that group and send all the articles off.
8451
8452
8453 @node Select Methods
8454 @chapter Select Methods
8455 @cindex foreign groups
8456 @cindex select methods
8457
8458 A @dfn{foreign group} is a group not read by the usual (or
8459 default) means.  It could be, for instance, a group from a different
8460 @sc{nntp} server, it could be a virtual group, or it could be your own
8461 personal mail group.
8462
8463 A foreign group (or any group, really) is specified by a @dfn{name} and
8464 a @dfn{select method}.  To take the latter first, a select method is a
8465 list where the first element says what backend to use (e.g. @code{nntp},
8466 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8467 name}.  There may be additional elements in the select method, where the
8468 value may have special meaning for the backend in question.
8469
8470 One could say that a select method defines a @dfn{virtual server}---so
8471 we do just that (@pxref{The Server Buffer}).
8472
8473 The @dfn{name} of the group is the name the backend will recognize the
8474 group as.
8475
8476 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8477 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8478 method @code{(nntp "some.where.edu")}.  Gnus will call this group
8479 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8480 backend just knows this group as @samp{soc.motss}.
8481
8482 The different methods all have their peculiarities, of course.
8483
8484 @menu
8485 * The Server Buffer::     Making and editing virtual servers.
8486 * Getting News::          Reading USENET news with Gnus.
8487 * Getting Mail::          Reading your personal mail with Gnus.
8488 * Other Sources::         Reading directories, files, SOUP packets.
8489 * Combined Groups::       Combining groups into one group.
8490 * Gnus Unplugged::        Reading news and mail offline.
8491 @end menu
8492
8493
8494 @node The Server Buffer
8495 @section The Server Buffer
8496
8497 Traditionally, a @dfn{server} is a machine or a piece of software that
8498 one connects to, and then requests information from.  Gnus does not
8499 connect directly to any real servers, but does all transactions through
8500 one backend or other.  But that's just putting one layer more between
8501 the actual media and Gnus, so we might just as well say that each
8502 backend represents a virtual server.
8503
8504 For instance, the @code{nntp} backend may be used to connect to several
8505 different actual @sc{nntp} servers, or, perhaps, to many different ports
8506 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8507 use, and what parameters to set by specifying a @dfn{select method}.
8508
8509 These select method specifications can sometimes become quite
8510 complicated---say, for instance, that you want to read from the
8511 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8512 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8513 Anyways, if you had to specify that for each group that used this
8514 server, that would be too much work, so Gnus offers a way of naming
8515 select methods, which is what you do in the server buffer.
8516
8517 To enter the server buffer, use the @kbd{^}
8518 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8519
8520 @menu
8521 * Server Buffer Format::      You can customize the look of this buffer.
8522 * Server Commands::           Commands to manipulate servers.
8523 * Example Methods::           Examples server specifications.
8524 * Creating a Virtual Server:: An example session.
8525 * Server Variables::          Which variables to set.
8526 * Servers and Methods::       You can use server names as select methods.
8527 * Unavailable Servers::       Some servers you try to contact may be down.
8528 @end menu
8529
8530 @vindex gnus-server-mode-hook
8531 @code{gnus-server-mode-hook} is run when creating the server buffer.
8532
8533
8534 @node Server Buffer Format
8535 @subsection Server Buffer Format
8536 @cindex server buffer format
8537
8538 @vindex gnus-server-line-format
8539 You can change the look of the server buffer lines by changing the
8540 @code{gnus-server-line-format} variable.  This is a @code{format}-like
8541 variable, with some simple extensions:
8542
8543 @table @samp
8544
8545 @item h
8546 How the news is fetched---the backend name.
8547
8548 @item n
8549 The name of this server.
8550
8551 @item w
8552 Where the news is to be fetched from---the address.
8553
8554 @item s
8555 The opened/closed/denied status of the server.
8556 @end table
8557
8558 @vindex gnus-server-mode-line-format
8559 The mode line can also be customized by using the
8560 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
8561 Formatting}).  The following specs are understood:
8562
8563 @table @samp
8564 @item S
8565 Server name.
8566
8567 @item M
8568 Server method.
8569 @end table
8570
8571 Also @pxref{Formatting Variables}.
8572
8573
8574 @node Server Commands
8575 @subsection Server Commands
8576 @cindex server commands
8577
8578 @table @kbd
8579
8580 @item a
8581 @kindex a (Server)
8582 @findex gnus-server-add-server
8583 Add a new server (@code{gnus-server-add-server}).
8584
8585 @item e
8586 @kindex e (Server)
8587 @findex gnus-server-edit-server
8588 Edit a server (@code{gnus-server-edit-server}).
8589
8590 @item SPACE
8591 @kindex SPACE (Server)
8592 @findex gnus-server-read-server
8593 Browse the current server (@code{gnus-server-read-server}).
8594
8595 @item q
8596 @kindex q (Server)
8597 @findex gnus-server-exit
8598 Return to the group buffer (@code{gnus-server-exit}).
8599
8600 @item k
8601 @kindex k (Server)
8602 @findex gnus-server-kill-server
8603 Kill the current server (@code{gnus-server-kill-server}).
8604
8605 @item y
8606 @kindex y (Server)
8607 @findex gnus-server-yank-server
8608 Yank the previously killed server (@code{gnus-server-yank-server}).
8609
8610 @item c
8611 @kindex c (Server)
8612 @findex gnus-server-copy-server
8613 Copy the current server (@code{gnus-server-copy-server}).
8614
8615 @item l
8616 @kindex l (Server)
8617 @findex gnus-server-list-servers
8618 List all servers (@code{gnus-server-list-servers}).
8619
8620 @item s
8621 @kindex s (Server)
8622 @findex gnus-server-scan-server
8623 Request that the server scan its sources for new articles
8624 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8625 servers.
8626
8627 @item g
8628 @kindex g (Server)
8629 @findex gnus-server-regenerate-server
8630 Request that the server regenerate all its data structures
8631 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8632 a mail backend that has gotten out of synch.
8633
8634 @end table
8635
8636
8637 @node Example Methods
8638 @subsection Example Methods
8639
8640 Most select methods are pretty simple and self-explanatory:
8641
8642 @lisp
8643 (nntp "news.funet.fi")
8644 @end lisp
8645
8646 Reading directly from the spool is even simpler:
8647
8648 @lisp
8649 (nnspool "")
8650 @end lisp
8651
8652 As you can see, the first element in a select method is the name of the
8653 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8654 will.
8655
8656 After these two elements, there may be an arbitrary number of
8657 @var{(variable form)} pairs.
8658
8659 To go back to the first example---imagine that you want to read from
8660 port 15 on that machine.  This is what the select method should
8661 look like then:
8662
8663 @lisp
8664 (nntp "news.funet.fi" (nntp-port-number 15))
8665 @end lisp
8666
8667 You should read the documentation to each backend to find out what
8668 variables are relevant, but here's an @code{nnmh} example:
8669
8670 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8671 you have two structures that you wish to access: One is your private
8672 mail spool, and the other is a public one.  Here's the possible spec for
8673 your private mail:
8674
8675 @lisp
8676 (nnmh "private" (nnmh-directory "~/private/mail/"))
8677 @end lisp
8678
8679 (This server is then called @samp{private}, but you may have guessed
8680 that.)
8681
8682 Here's the method for a public spool:
8683
8684 @lisp
8685 (nnmh "public"
8686       (nnmh-directory "/usr/information/spool/")
8687       (nnmh-get-new-mail nil))
8688 @end lisp
8689
8690 If you are behind a firewall and only have access to the @sc{nntp}
8691 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8692 on the firewall machine and telnet from there to the @sc{nntp} server.
8693 Doing this can be rather fiddly, but your virtual server definition
8694 should probably look something like this:
8695
8696 @lisp
8697 (nntp "firewall"
8698       (nntp-address "the.firewall.machine")
8699       (nntp-open-connection-function nntp-open-rlogin)
8700       (nntp-end-of-line "\n")
8701       (nntp-rlogin-parameters
8702        ("telnet" "the.real.nntp.host" "nntp")))
8703 @end lisp
8704
8705 If you want to use the wonderful @code{ssh} program to provide a
8706 compressed connection over the modem line, you could create a virtual
8707 server that would look something like this:
8708
8709 @lisp
8710 (nntp "news"
8711        (nntp-address "copper.uio.no")
8712        (nntp-rlogin-program "ssh")
8713        (nntp-open-connection-function nntp-open-rlogin)
8714        (nntp-end-of-line "\n")
8715        (nntp-rlogin-parameters
8716         ("telnet" "news.uio.no" "nntp")))
8717 @end lisp
8718
8719 This means that you have to have set up @code{ssh-agent} correctly to
8720 provide automatic authorization, of course.  And to get a compressed
8721 connection, you have to have the @samp{Compression} option in the
8722 @code{ssh} @file{config} file.
8723
8724
8725 @node Creating a Virtual Server
8726 @subsection Creating a Virtual Server
8727
8728 If you're saving lots of articles in the cache by using persistent
8729 articles, you may want to create a virtual server to read the cache.
8730
8731 First you need to add a new server.  The @kbd{a} command does that.  It
8732 would probably be best to use @code{nnspool} to read the cache.  You
8733 could also use @code{nnml} or @code{nnmh}, though.
8734
8735 Type @kbd{a nnspool RET cache RET}.
8736
8737 You should now have a brand new @code{nnspool} virtual server called
8738 @samp{cache}.  You now need to edit it to have the right definitions.
8739 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8740 will contain the following:
8741
8742 @lisp
8743 (nnspool "cache")
8744 @end lisp
8745
8746 Change that to:
8747
8748 @lisp
8749 (nnspool "cache"
8750          (nnspool-spool-directory "~/News/cache/")
8751          (nnspool-nov-directory "~/News/cache/")
8752          (nnspool-active-file "~/News/cache/active"))
8753 @end lisp
8754
8755 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8756 @kbd{RET} over this virtual server, you should be entered into a browse
8757 buffer, and you should be able to enter any of the groups displayed.
8758
8759
8760 @node Server Variables
8761 @subsection Server Variables
8762
8763 One sticky point when defining variables (both on backends and in Emacs
8764 in general) is that some variables are typically initialized from other
8765 variables when the definition of the variables is being loaded.  If you
8766 change the "base" variable after the variables have been loaded, you
8767 won't change the "derived" variables.
8768
8769 This typically affects directory and file variables.  For instance,
8770 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8771 directory variables are initialized from that variable, so
8772 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8773 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8774 @code{nnml-directory}---you have to explicitly set all the file
8775 variables to be what you want them to be.  For a complete list of
8776 variables for each backend, see each backend's section later in this
8777 manual, but here's an example @code{nnml} definition:
8778
8779 @lisp
8780 (nnml "public"
8781       (nnml-directory "~/my-mail/")
8782       (nnml-active-file "~/my-mail/active")
8783       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8784 @end lisp
8785
8786
8787 @node Servers and Methods
8788 @subsection Servers and Methods
8789
8790 Wherever you would normally use a select method
8791 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8792 when browsing a foreign server) you can use a virtual server name
8793 instead.  This could potentially save lots of typing.  And it's nice all
8794 over.
8795
8796
8797 @node Unavailable Servers
8798 @subsection Unavailable Servers
8799
8800 If a server seems to be unreachable, Gnus will mark that server as
8801 @code{denied}.  That means that any subsequent attempt to make contact
8802 with that server will just be ignored.  ``It can't be opened,'' Gnus
8803 will tell you, without making the least effort to see whether that is
8804 actually the case or not.
8805
8806 That might seem quite naughty, but it does make sense most of the time.
8807 Let's say you have 10 groups subscribed to on server
8808 @samp{nephelococcygia.com}.  This server is located somewhere quite far
8809 away from you and the machine is quite slow, so it takes 1 minute just
8810 to find out that it refuses connection to you today.  If Gnus were to
8811 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8812 attempt to do that.  Once it has gotten a single ``connection refused'',
8813 it will regard that server as ``down''.
8814
8815 So, what happens if the machine was only feeling unwell temporarily?
8816 How do you test to see whether the machine has come up again?
8817
8818 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8819 with the following commands:
8820
8821 @table @kbd
8822
8823 @item O
8824 @kindex O (Server)
8825 @findex gnus-server-open-server
8826 Try to establish connection to the server on the current line
8827 (@code{gnus-server-open-server}).
8828
8829 @item C
8830 @kindex C (Server)
8831 @findex gnus-server-close-server
8832 Close the connection (if any) to the server
8833 (@code{gnus-server-close-server}).
8834
8835 @item D
8836 @kindex D (Server)
8837 @findex gnus-server-deny-server
8838 Mark the current server as unreachable
8839 (@code{gnus-server-deny-server}).
8840
8841 @item M-o
8842 @kindex M-o (Server)
8843 @findex gnus-server-open-all-servers
8844 Open the connections to all servers in the buffer
8845 (@code{gnus-server-open-all-servers}).
8846
8847 @item M-c
8848 @kindex M-c (Server)
8849 @findex gnus-server-close-all-servers
8850 Close the connections to all servers in the buffer
8851 (@code{gnus-server-close-all-servers}).
8852
8853 @item R
8854 @kindex R (Server)
8855 @findex gnus-server-remove-denials
8856 Remove all marks to whether Gnus was denied connection from any servers
8857 (@code{gnus-server-remove-denials}).
8858
8859 @end table
8860
8861
8862 @node Getting News
8863 @section Getting News
8864 @cindex reading news
8865 @cindex news backends
8866
8867 A newsreader is normally used for reading news.  Gnus currently provides
8868 only two methods of getting news---it can read from an @sc{nntp} server,
8869 or it can read from a local spool.
8870
8871 @menu
8872 * NNTP::               Reading news from an @sc{nntp} server.
8873 * News Spool::         Reading news from the local spool.
8874 @end menu
8875
8876
8877 @node NNTP
8878 @subsection @sc{nntp}
8879 @cindex nntp
8880
8881 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8882 You just specify @code{nntp} as method and the address of the @sc{nntp}
8883 server as the, uhm, address.
8884
8885 If the @sc{nntp} server is located at a non-standard port, setting the
8886 third element of the select method to this port number should allow you
8887 to connect to the right port.  You'll have to edit the group info for
8888 that (@pxref{Foreign Groups}).
8889
8890 The name of the foreign group can be the same as a native group.  In
8891 fact, you can subscribe to the same group from as many different servers
8892 you feel like.  There will be no name collisions.
8893
8894 The following variables can be used to create a virtual @code{nntp}
8895 server:
8896
8897 @table @code
8898
8899 @item nntp-server-opened-hook
8900 @vindex nntp-server-opened-hook
8901 @cindex @sc{mode reader}
8902 @cindex authinfo
8903 @cindex authentification
8904 @cindex nntp authentification
8905 @findex nntp-send-authinfo
8906 @findex nntp-send-mode-reader
8907 is run after a connection has been made.  It can be used to send
8908 commands to the @sc{nntp} server after it has been contacted.  By
8909 default it sends the command @code{MODE READER} to the server with the
8910 @code{nntp-send-mode-reader} function.  This function should always be
8911 present in this hook.
8912
8913 @item nntp-authinfo-function
8914 @vindex nntp-authinfo-function
8915 @findex nntp-send-authinfo
8916 @vindex nntp-authinfo-file
8917 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8918 server.  The default function is @code{nntp-send-authinfo}, which looks
8919 through your @file{~/.authinfo} (or whatever you've set the
8920 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
8921 are found, it will prompt you for a login name and a password.  The
8922 format of the @file{~/.authinfo} file is (almost) the same as the
8923 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
8924 manual page, but here are the salient facts:
8925
8926 @enumerate
8927 @item
8928 The file contains one or more line, each of which define one server.
8929
8930 @item
8931 Each line may contain an arbitrary number of token/value pairs.  The
8932 valid tokens include @samp{machine}, @samp{login}, @samp{password},
8933 @samp{default} and @samp{force}.  (The latter is not a valid
8934 @file{.netrc}/@code{ftp} token, which is the only way the
8935 @file{.authinfo} file format deviates from the @file{.netrc} file
8936 format.)
8937
8938 @end enumerate
8939
8940 Here's an example file:
8941
8942 @example
8943 machine news.uio.no login larsi password geheimnis
8944 machine nntp.ifi.uio.no login larsi force yes
8945 @end example
8946
8947 The token/value pairs may appear in any order; @samp{machine} doesn't
8948 have to be first, for instance.
8949
8950 In this example, both login name and password have been supplied for the
8951 former server, while the latter has only the login name listed, and the
8952 user will be prompted for the password.  The latter also has the
8953 @samp{force} tag, which means that the authinfo will be sent to the
8954 @var{nntp} server upon connection; the default (i.e., when there is not
8955 @samp{force} tag) is to not send authinfo to the @var{nntp} server
8956 until the @var{nntp} server asks for it.
8957
8958 You can also add @samp{default} lines that will apply to all servers
8959 that don't have matching @samp{machine} lines.
8960
8961 @example
8962 default force yes
8963 @end example
8964
8965 This will force sending @samp{AUTHINFO} commands to all servers not
8966 previously mentioned.
8967
8968 Remember to not leave the @file{~/.authinfo} file world-readable.
8969
8970 @item nntp-server-action-alist
8971 @vindex nntp-server-action-alist
8972 This is a list of regexps to match on server types and actions to be
8973 taken when matches are made.  For instance, if you want Gnus to beep
8974 every time you connect to innd, you could say something like:
8975
8976 @lisp
8977 (setq nntp-server-action-alist
8978       '(("innd" (ding))))
8979 @end lisp
8980
8981 You probably don't want to do that, though.
8982
8983 The default value is
8984
8985 @lisp
8986 '(("nntpd 1\\.5\\.11t"
8987    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
8988 @end lisp
8989
8990 This ensures that Gnus doesn't send the @code{MODE READER} command to
8991 nntpd 1.5.11t, since that command chokes that server, I've been told.
8992
8993 @item nntp-maximum-request
8994 @vindex nntp-maximum-request
8995 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8996 will collect headers by sending a series of @code{head} commands.  To
8997 speed things up, the backend sends lots of these commands without
8998 waiting for reply, and then reads all the replies.  This is controlled
8999 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
9000 your network is buggy, you should set this to 1.
9001
9002 @c @item nntp-connection-timeout
9003 @c @vindex nntp-connection-timeout
9004 @c If you have lots of foreign @code{nntp} groups that you connect to
9005 @c regularly, you're sure to have problems with @sc{nntp} servers not
9006 @c responding properly, or being too loaded to reply within reasonable
9007 @c time.  This is can lead to awkward problems, which can be helped
9008 @c somewhat by setting @code{nntp-connection-timeout}.  This is an integer
9009 @c that says how many seconds the @code{nntp} backend should wait for a
9010 @c connection before giving up.  If it is @code{nil}, which is the default,
9011 @c no timeouts are done.
9012 @c 
9013 @c @item nntp-command-timeout
9014 @c @vindex nntp-command-timeout
9015 @c @cindex PPP connections
9016 @c @cindex dynamic IP addresses
9017 @c If you're running Gnus on a machine that has a dynamically assigned
9018 @c address, Gnus may become confused.  If the address of your machine
9019 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9020 @c waiting forever for replies from the server.  To help with this
9021 @c unfortunate problem, you can set this command to a number.  Gnus will
9022 @c then, if it sits waiting for a reply from the server longer than that
9023 @c number of seconds, shut down the connection, start a new one, and resend
9024 @c the command.  This should hopefully be transparent to the user.  A
9025 @c likely number is 30 seconds.
9026 @c
9027 @c @item nntp-retry-on-break
9028 @c @vindex nntp-retry-on-break
9029 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9030 @c hangs.  This will have much the same effect as the command timeout
9031 @c described above.
9032
9033 @item nntp-server-hook
9034 @vindex nntp-server-hook
9035 This hook is run as the last step when connecting to an @sc{nntp}
9036 server.
9037
9038 @findex nntp-open-rlogin
9039 @findex nntp-open-telnet
9040 @findex nntp-open-network-stream
9041 @item nntp-open-connection-function
9042 @vindex nntp-open-connection-function
9043 This function is used to connect to the remote system.  Four pre-made
9044 functions are supplied:
9045
9046 @table @code
9047 @item nntp-open-network-stream
9048 This is the default, and simply connects to some port or other on the
9049 remote system.
9050
9051 @item nntp-open-rlogin
9052 Does an @samp{rlogin} on the
9053 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9054 available there.
9055
9056 @code{nntp-open-rlogin}-related variables:
9057
9058 @table @code
9059
9060 @item nntp-rlogin-program
9061 @vindex nntp-rlogin-program
9062 Program used to log in on remote machines.  The default is @samp{rsh},
9063 but @samp{ssh} is a popular alternative.
9064
9065 @item nntp-rlogin-parameters
9066 @vindex nntp-rlogin-parameters
9067 This list will be used as the parameter list given to @code{rsh}.
9068
9069 @item nntp-rlogin-user-name
9070 @vindex nntp-rlogin-user-name
9071 User name on the remote system.
9072
9073 @end table
9074
9075 @item nntp-open-telnet
9076 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9077 to get to the @sc{nntp} server.
9078
9079 @code{nntp-open-telnet}-related variables:
9080
9081 @table @code
9082 @item nntp-telnet-command
9083 @vindex nntp-telnet-command
9084 Command used to start @code{telnet}.
9085
9086 @item nntp-telnet-switches
9087 @vindex nntp-telnet-switches
9088 List of strings to be used as the switches to the @code{telnet} command.
9089
9090 @item nntp-telnet-user-name
9091 @vindex nntp-telnet-user-name
9092 User name for log in on the remote system.
9093
9094 @item nntp-telnet-passwd
9095 @vindex nntp-telnet-passwd
9096 Password to use when logging in.
9097
9098 @item nntp-telnet-parameters
9099 @vindex nntp-telnet-parameters
9100 A list of strings executed as a command after logging in
9101 via @code{telnet}.
9102
9103 @item nntp-telnet-shell-prompt
9104 @vindex nntp-telnet-shell-prompt
9105 Regexp matching the shell prompt on the remote machine.  The default is
9106 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9107
9108 @item nntp-open-telnet-envuser
9109 @vindex nntp-open-telnet-envuser
9110 If non-@code{nil}, the @code{telnet} session (client and server both)
9111 will support the @code{ENVIRON} option and not prompt for login name.
9112 This works for Solaris @code{telnet}, for instance.
9113
9114 @end table
9115
9116 @findex nntp-open-ssl-stream
9117 @item nntp-open-ssl-stream
9118 Opens a connection to a server over a @dfn{secure} channel.  To use this
9119 you must have SSLay installed
9120 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9121 @file{ssl.el} (from the W3 distributeion, for instance).  You then
9122 define a server as follows:
9123
9124 @lisp
9125 ;; Type `C-c C-c' after you've finished editing.
9126 ;;
9127 ;; "snews" is port 563 and is predefined in our /etc/services
9128 ;;
9129 (nntp "snews.bar.com"
9130       (nntp-open-connection-function nntp-open-ssl-stream)
9131       (nntp-port-number "snews")
9132       (nntp-address "snews.bar.com"))
9133 @end lisp
9134
9135 @end table
9136
9137 @item nntp-end-of-line
9138 @vindex nntp-end-of-line
9139 String to use as end-of-line marker when talking to the @sc{nntp}
9140 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9141 using @code{rlogin} to talk to the server.
9142
9143 @item nntp-rlogin-user-name
9144 @vindex nntp-rlogin-user-name
9145 User name on the remote system when using the @code{rlogin} connect
9146 function.
9147
9148 @item nntp-address
9149 @vindex nntp-address
9150 The address of the remote system running the @sc{nntp} server.
9151
9152 @item nntp-port-number
9153 @vindex nntp-port-number
9154 Port number to connect to when using the @code{nntp-open-network-stream}
9155 connect function.
9156
9157 @item nntp-buggy-select
9158 @vindex nntp-buggy-select
9159 Set this to non-@code{nil} if your select routine is buggy.
9160
9161 @item nntp-nov-is-evil
9162 @vindex nntp-nov-is-evil
9163 If the @sc{nntp} server does not support @sc{nov}, you could set this
9164 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9165 can be used.
9166
9167 @item nntp-xover-commands
9168 @vindex nntp-xover-commands
9169 @cindex nov
9170 @cindex XOVER
9171 List of strings used as commands to fetch @sc{nov} lines from a
9172 server.  The default value of this variable is @code{("XOVER"
9173 "XOVERVIEW")}.
9174
9175 @item nntp-nov-gap
9176 @vindex nntp-nov-gap
9177 @code{nntp} normally sends just one big request for @sc{nov} lines to
9178 the server.  The server responds with one huge list of lines.  However,
9179 if you have read articles 2-5000 in the group, and only want to read
9180 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9181 lines that you will not need.  This variable says how
9182 big a gap between two consecutive articles is allowed to be before the
9183 @code{XOVER} request is split into several request.  Note that if your
9184 network is fast, setting this variable to a really small number means
9185 that fetching will probably be slower.  If this variable is @code{nil},
9186 @code{nntp} will never split requests.  The default is 5.
9187
9188 @item nntp-prepare-server-hook
9189 @vindex nntp-prepare-server-hook
9190 A hook run before attempting to connect to an @sc{nntp} server.
9191
9192 @item nntp-warn-about-losing-connection
9193 @vindex nntp-warn-about-losing-connection
9194 If this variable is non-@code{nil}, some noise will be made when a
9195 server closes connection.
9196
9197 @item nntp-record-commands
9198 @vindex nntp-record-commands
9199 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9200 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9201 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
9202 that doesn't seem to work.
9203
9204 @end table
9205
9206
9207 @node News Spool
9208 @subsection News Spool
9209 @cindex nnspool
9210 @cindex news spool
9211
9212 Subscribing to a foreign group from the local spool is extremely easy,
9213 and might be useful, for instance, to speed up reading groups that
9214 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9215 instance.
9216
9217 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9218 anything else) as the address.
9219
9220 If you have access to a local spool, you should probably use that as the
9221 native select method (@pxref{Finding the News}).  It is normally faster
9222 than using an @code{nntp} select method, but might not be.  It depends.
9223 You just have to try to find out what's best at your site.
9224
9225 @table @code
9226
9227 @item nnspool-inews-program
9228 @vindex nnspool-inews-program
9229 Program used to post an article.
9230
9231 @item nnspool-inews-switches
9232 @vindex nnspool-inews-switches
9233 Parameters given to the inews program when posting an article.
9234
9235 @item nnspool-spool-directory
9236 @vindex nnspool-spool-directory
9237 Where @code{nnspool} looks for the articles.  This is normally
9238 @file{/usr/spool/news/}.
9239
9240 @item nnspool-nov-directory
9241 @vindex nnspool-nov-directory
9242 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9243 @file{/usr/spool/news/over.view/}.
9244
9245 @item nnspool-lib-dir
9246 @vindex nnspool-lib-dir
9247 Where the news lib dir is (@file{/usr/lib/news/} by default).
9248
9249 @item nnspool-active-file
9250 @vindex nnspool-active-file
9251 The path to the active file.
9252
9253 @item nnspool-newsgroups-file
9254 @vindex nnspool-newsgroups-file
9255 The path to the group descriptions file.
9256
9257 @item nnspool-history-file
9258 @vindex nnspool-history-file
9259 The path to the news history file.
9260
9261 @item nnspool-active-times-file
9262 @vindex nnspool-active-times-file
9263 The path to the active date file.
9264
9265 @item nnspool-nov-is-evil
9266 @vindex nnspool-nov-is-evil
9267 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9268 that it finds.
9269
9270 @item nnspool-sift-nov-with-sed
9271 @vindex nnspool-sift-nov-with-sed
9272 @cindex sed
9273 If non-@code{nil}, which is the default, use @code{sed} to get the
9274 relevant portion from the overview file.  If nil, @code{nnspool} will
9275 load the entire file into a buffer and process it there.
9276
9277 @end table
9278
9279
9280 @node Getting Mail
9281 @section Getting Mail
9282 @cindex reading mail
9283 @cindex mail
9284
9285 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9286 course.
9287
9288 @menu
9289 * Getting Started Reading Mail:: A simple cookbook example.
9290 * Splitting Mail::               How to create mail groups.
9291 * Mail Backend Variables::       Variables for customizing mail handling.
9292 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9293 * Mail and Procmail::            Reading mail groups that procmail create.
9294 * Incorporating Old Mail::       What about the old mail you have?
9295 * Expiring Mail::                Getting rid of unwanted mail.
9296 * Washing Mail::                 Removing gruft from the mail you get.
9297 * Duplicates::                   Dealing with duplicated mail.
9298 * Not Reading Mail::             Using mail backends for reading other files.
9299 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9300 @end menu
9301
9302
9303 @node Getting Started Reading Mail
9304 @subsection Getting Started Reading Mail
9305
9306 It's quite easy to use Gnus to read your new mail.  You just plonk the
9307 mail backend of your choice into @code{gnus-secondary-select-methods},
9308 and things will happen automatically.
9309
9310 For instance, if you want to use @code{nnml} (which is a "one file per
9311 mail" backend), you could put the following in your @file{.gnus} file:
9312
9313 @lisp
9314 (setq gnus-secondary-select-methods
9315       '((nnml "private")))
9316 @end lisp
9317
9318 Now, the next time you start Gnus, this backend will be queried for new
9319 articles, and it will move all the messages in your spool file to its
9320 directory, which is @code{~/Mail/} by default.  The new group that will
9321 be created (@samp{mail.misc}) will be subscribed, and you can read it
9322 like any other group.
9323
9324 You will probably want to split the mail into several groups, though:
9325
9326 @lisp
9327 (setq nnmail-split-methods
9328       '(("junk" "^From:.*Lars Ingebrigtsen")
9329         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9330         ("other" "")))
9331 @end lisp
9332
9333 This will result in three new @code{nnml} mail groups being created:
9334 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
9335 mail that doesn't fit into the first two groups will be placed in the
9336 last group.
9337
9338 This should be sufficient for reading mail with Gnus.  You might want to
9339 give the other sections in this part of the manual a perusal, though.
9340 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9341
9342
9343 @node Splitting Mail
9344 @subsection Splitting Mail
9345 @cindex splitting mail
9346 @cindex mail splitting
9347
9348 @vindex nnmail-split-methods
9349 The @code{nnmail-split-methods} variable says how the incoming mail is
9350 to be split into groups.
9351
9352 @lisp
9353 (setq nnmail-split-methods
9354   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9355     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9356     ("mail.other" "")))
9357 @end lisp
9358
9359 This variable is a list of lists, where the first element of each of
9360 these lists is the name of the mail group (they do not have to be called
9361 something beginning with @samp{mail}, by the way), and the second
9362 element is a regular expression used on the header of each mail to
9363 determine if it belongs in this mail group.  The first string may
9364 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9365 insert sub-expressions from the matched text.  For instance:
9366
9367 @lisp
9368 ("list.\\1" "From:.*\\(.*\\)-list@@majordomo.com")
9369 @end lisp
9370
9371 If the first element is the special symbol @code{junk}, then messages
9372 that match the regexp will disappear into the aether.  Use with
9373 extreme caution.
9374
9375 The second element can also be a function.  In that case, it will be
9376 called narrowed to the headers with the first element of the rule as the
9377 argument.  It should return a non-@code{nil} value if it thinks that the
9378 mail belongs in that group.
9379
9380 The last of these groups should always be a general one, and the regular
9381 expression should @emph{always} be @samp{} so that it matches any mails
9382 that haven't been matched by any of the other regexps.  (These rules are
9383 processed from the beginning of the alist toward the end.  The first
9384 rule to make a match will "win", unless you have crossposting enabled.
9385 In that case, all matching rules will "win".)
9386
9387 If you like to tinker with this yourself, you can set this variable to a
9388 function of your choice.  This function will be called without any
9389 arguments in a buffer narrowed to the headers of an incoming mail
9390 message.  The function should return a list of group names that it
9391 thinks should carry this mail message.
9392
9393 Note that the mail backends are free to maul the poor, innocent,
9394 incoming headers all they want to.  They all add @code{Lines} headers;
9395 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9396 @code{From<SPACE>} line to something else.
9397
9398 @vindex nnmail-crosspost
9399 The mail backends all support cross-posting.  If several regexps match,
9400 the mail will be ``cross-posted'' to all those groups.
9401 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
9402 that no articles are crossposted to the general (@samp{}) group.
9403
9404 @vindex nnmail-crosspost-link-function
9405 @cindex crosspost
9406 @cindex links
9407 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9408 the crossposted articles.  However, not all file systems support hard
9409 links.  If that's the case for you, set
9410 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
9411 variable is @code{add-name-to-file} by default.)
9412
9413 @kindex M-x nnmail-split-history
9414 @kindex nnmail-split-history
9415 If you wish to see where the previous mail split put the messages, you
9416 can use the @kbd{M-x nnmail-split-history} command.
9417
9418 Gnus gives you all the opportunity you could possibly want for shooting
9419 yourself in the foot.  Let's say you create a group that will contain
9420 all the mail you get from your boss.  And then you accidentally
9421 unsubscribe from the group.  Gnus will still put all the mail from your
9422 boss in the unsubscribed group, and so, when your boss mails you ``Have
9423 that report ready by Monday or you're fired!'', you'll never see it and,
9424 come Tuesday, you'll still believe that you're gainfully employed while
9425 you really should be out collecting empty bottles to save up for next
9426 month's rent money.
9427
9428
9429 @node Mail Backend Variables
9430 @subsection Mail Backend Variables
9431
9432 These variables are (for the most part) pertinent to all the various
9433 mail backends.
9434
9435 @table @code
9436 @vindex nnmail-read-incoming-hook
9437 @item nnmail-read-incoming-hook
9438 The mail backends all call this hook after reading new mail.  You can
9439 use this hook to notify any mail watch programs, if you want to.
9440
9441 @vindex nnmail-spool-file
9442 @item nnmail-spool-file
9443 @cindex POP mail
9444 @cindex MAILHOST
9445 @cindex movemail
9446 @vindex nnmail-pop-password
9447 @vindex nnmail-pop-password-required
9448 The backends will look for new mail in this file.  If this variable is
9449 @code{nil}, the mail backends will never attempt to fetch mail by
9450 themselves.  If you are using a POP mail server and your name is
9451 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
9452 your name is not @samp{larsi}, you should probably modify that
9453 slightly, but you may have guessed that already, you smart & handsome
9454 devil!  You can also set this variable to @code{pop}, and Gnus will try
9455 to figure out the POP mail string by itself.  In any case, Gnus will
9456 call @code{movemail} which will contact the POP server named in the
9457 @code{MAILHOST} environment variable.  If the POP server needs a
9458 password, you can either set @code{nnmail-pop-password-required} to
9459 @code{t} and be prompted for the password, or set
9460 @code{nnmail-pop-password} to the password itself.
9461
9462 @code{nnmail-spool-file} can also be a list of mailboxes.
9463
9464 Your Emacs has to have been configured with @samp{--with-pop} before
9465 compilation.  This is the default, but some installations have it
9466 switched off.
9467
9468 When you use a mail backend, Gnus will slurp all your mail from your
9469 inbox and plonk it down in your home directory.  Gnus doesn't move any
9470 mail if you're not using a mail backend---you have to do a lot of magic
9471 invocations first.  At the time when you have finished drawing the
9472 pentagram, lightened the candles, and sacrificed the goat, you really
9473 shouldn't be too surprised when Gnus moves your mail.
9474
9475 @vindex nnmail-use-procmail
9476 @vindex nnmail-procmail-suffix
9477 @item nnmail-use-procmail
9478 If non-@code{nil}, the mail backends will look in
9479 @code{nnmail-procmail-directory} for incoming mail.  All the files in
9480 that directory that have names ending in @code{nnmail-procmail-suffix}
9481 will be considered incoming mailboxes, and will be searched for new
9482 mail.
9483
9484 @vindex nnmail-crash-box
9485 @item nnmail-crash-box
9486 When a mail backend reads a spool file, mail is first moved to this
9487 file, which is @file{~/.gnus-crash-box} by default.  If this file
9488 already exists, it will always be read (and incorporated) before any
9489 other spool files.
9490
9491 @vindex nnmail-prepare-incoming-hook
9492 @item nnmail-prepare-incoming-hook
9493 This is run in a buffer that holds all the new incoming mail, and can be
9494 used for, well, anything, really.
9495
9496 @vindex nnmail-split-hook
9497 @item nnmail-split-hook
9498 @findex article-decode-rfc1522
9499 @findex RFC1522 decoding
9500 Hook run in the buffer where the mail headers of each message is kept
9501 just before the splitting based on these headers is done.  The hook is
9502 free to modify the buffer contents in any way it sees fit---the buffer
9503 is discarded after the splitting has been done, and no changes performed
9504 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
9505 is one likely function to add to this hook.
9506
9507 @vindex nnmail-pre-get-new-mail-hook
9508 @vindex nnmail-post-get-new-mail-hook
9509 @item nnmail-pre-get-new-mail-hook
9510 @itemx nnmail-post-get-new-mail-hook
9511 These are two useful hooks executed when treating new incoming
9512 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9513 starting to handle the new mail) and
9514 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9515 is done).  Here's and example of using these two hooks to change the
9516 default file modes the new mail files get:
9517
9518 @lisp
9519 (add-hook 'gnus-pre-get-new-mail-hook
9520           (lambda () (set-default-file-modes 511)))
9521
9522 (add-hook 'gnus-post-get-new-mail-hook
9523           (lambda () (set-default-file-modes 551)))
9524 @end lisp
9525
9526 @item nnmail-tmp-directory
9527 @vindex nnmail-tmp-directory
9528 This variable says where to move incoming mail to -- while processing
9529 it.  This is usually done in the same directory that the mail backend
9530 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9531 it will be used instead.
9532
9533 @item nnmail-movemail-program
9534 @vindex nnmail-movemail-program
9535 This program is executed to move mail from the user's inbox to her home
9536 directory.  The default is @samp{movemail}.
9537
9538 This can also be a function.  In that case, the function will be called
9539 with two parameters -- the name of the inbox, and the file to be moved
9540 to.
9541
9542 @item nnmail-delete-incoming
9543 @vindex nnmail-delete-incoming
9544 @cindex incoming mail files
9545 @cindex deleting incoming files
9546 If non-@code{nil}, the mail backends will delete the temporary incoming
9547 file after splitting mail into the proper groups.  This is @code{t} by
9548 default.
9549
9550 @c This is @code{nil} by
9551 @c default for reasons of security.
9552
9553 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9554 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9555 lost mail, I think, but that's not the point.  (Except certain versions
9556 of Red Gnus.))  By not deleting the Incoming* files, one can be sure not
9557 to lose mail -- if Gnus totally whacks out, one can always recover what
9558 was lost.
9559
9560 You may delete the @file{Incoming*} files at will.
9561
9562 @item nnmail-use-long-file-names
9563 @vindex nnmail-use-long-file-names
9564 If non-@code{nil}, the mail backends will use long file and directory
9565 names.  Groups like @samp{mail.misc} will end up in directories
9566 (assuming use of @code{nnml} backend) or files (assuming use of
9567 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
9568 the same group will end up in @file{mail/misc}.
9569
9570 @item nnmail-delete-file-function
9571 @vindex nnmail-delete-file-function
9572 @findex delete-file
9573 Function called to delete files.  It is @code{delete-file} by default.
9574
9575 @item nnmail-cache-accepted-message-ids
9576 @vindex nnmail-cache-accepted-message-ids
9577 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9578 the backend (via @code{Gcc}, for instance) into the mail duplication
9579 discovery cache.  The default is @code{nil}.
9580
9581 @end table
9582
9583
9584 @node Fancy Mail Splitting
9585 @subsection Fancy Mail Splitting
9586 @cindex mail splitting
9587 @cindex fancy mail splitting
9588
9589 @vindex nnmail-split-fancy
9590 @findex nnmail-split-fancy
9591 If the rather simple, standard method for specifying how to split mail
9592 doesn't allow you to do what you want, you can set
9593 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
9594 play with the @code{nnmail-split-fancy} variable.
9595
9596 Let's look at an example value of this variable first:
9597
9598 @lisp
9599 ;; Messages from the mailer daemon are not crossposted to any of
9600 ;; the ordinary groups.  Warnings are put in a separate group
9601 ;; from real errors.
9602 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9603                    "mail.misc"))
9604    ;; Non-error messages are crossposted to all relevant
9605    ;; groups, but we don't crosspost between the group for the
9606    ;; (ding) list and the group for other (ding) related mail.
9607    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9608          ("subject" "ding" "ding.misc"))
9609       ;; Other mailing lists...
9610       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9611       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9612       ;; People...
9613       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9614    ;; Unmatched mail goes to the catch all group.
9615    "misc.misc")
9616 @end lisp
9617
9618 This variable has the format of a @dfn{split}.  A split is a (possibly)
9619 recursive structure where each split may contain other splits.  Here are
9620 the five possible split syntaxes:
9621
9622 @enumerate
9623
9624 @item
9625 @samp{group}: If the split is a string, that will be taken as a group
9626 name.  Normal regexp match expansion will be done.  See below for
9627 examples. 
9628
9629 @item
9630 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
9631 which is a string, then store the message as specified by SPLIT, if
9632 header FIELD (a regexp) contains VALUE (also a regexp).
9633
9634 @item
9635 @var{(| SPLIT...)}: If the split is a list, and the first element is
9636 @code{|} (vertical bar), then process each SPLIT until one of them
9637 matches.  A SPLIT is said to match if it will cause the mail message to
9638 be stored in one or more groups.
9639
9640 @item
9641 @var{(& SPLIT...)}: If the split is a list, and the first element is
9642 @code{&}, then process all SPLITs in the list.
9643
9644 @item
9645 @code{junk}: If the split is the symbol @code{junk}, then don't save
9646 this message.
9647
9648 @item
9649 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
9650 element is @code{:}, then the second element will be called as a
9651 function with @var{args} given as arguments.  The function should return
9652 a SPLIT.
9653
9654 @end enumerate
9655
9656 In these splits, @var{FIELD} must match a complete field name.
9657 @var{VALUE} must match a complete word according to the fundamental mode
9658 syntax table.  You can use @code{.*} in the regexps to match partial
9659 field names or words.  In other words, all @var{VALUE}'s are wrapped in
9660 @samp{\<} and @samp{\>} pairs.
9661
9662 @vindex nnmail-split-abbrev-alist
9663 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9664 are expanded as specified by the variable
9665 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
9666 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
9667 value.
9668
9669 @vindex nnmail-split-fancy-syntax-table
9670 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9671 when all this splitting is performed.
9672
9673 If you want to have Gnus create groups dynamically based on some
9674 information in the headers (i.e., do @code{replace-match}-like
9675 substitutions in the group names), you can say things like:
9676
9677 @example
9678 (any "debian-\\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
9679 @end example
9680
9681 If the string contains the element @samp{\&}, then the previously
9682 matched string will be substituted.  Similarly, the elements @samp{\1}
9683 up to @samp{\9} will be substituted with the text matched by the
9684 groupings 1 through 9.
9685
9686
9687 @node Mail and Procmail
9688 @subsection Mail and Procmail
9689 @cindex procmail
9690
9691 @cindex slocal
9692 @cindex elm
9693 Many people use @code{procmail} (or some other mail filter program or
9694 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9695 incoming mail into groups.  If you do that, you should set
9696 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9697 backends never ever try to fetch mail by themselves.
9698
9699 If you have a combined @code{procmail}/POP/mailbox setup, you can do
9700 something like the following:
9701
9702 @vindex nnmail-use-procmail
9703 @lisp
9704 (setq nnmail-use-procmail t)
9705 (setq nnmail-spool-file
9706       '("/usr/spool/mail/my-name" "po:my-name"))
9707 @end lisp
9708
9709 This also means that you probably don't want to set
9710 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9711 side effects.
9712
9713 When a mail backend is queried for what groups it carries, it replies
9714 with the contents of that variable, along with any groups it has figured
9715 out that it carries by other means.  None of the backends, except
9716 @code{nnmh}, actually go out to the disk and check what groups actually
9717 exist.  (It's not trivial to distinguish between what the user thinks is
9718 a basis for a newsgroup and what is just a plain old file or directory.)
9719
9720 This means that you have to tell Gnus (and the backends) by hand what
9721 groups exist.
9722
9723 Let's take the @code{nnmh} backend as an example:
9724
9725 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9726 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9727
9728 Go to the group buffer and type @kbd{G m}.  When prompted, answer
9729 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
9730 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
9731 to include all your mail groups.
9732
9733 That's it.  You are now set to read your mail.  An active file for this
9734 method will be created automatically.
9735
9736 @vindex nnmail-procmail-suffix
9737 @vindex nnmail-procmail-directory
9738 If you use @code{nnfolder} or any other backend that store more than a
9739 single article in each file, you should never have procmail add mails to
9740 the file that Gnus sees.  Instead, procmail should put all incoming mail
9741 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9742 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9743 name.  The mail backends will read the mail from these files.
9744
9745 @vindex nnmail-resplit-incoming
9746 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9747 put in the @code{mail.misc}, as one would expect.  However, if you want
9748 Gnus to split the mail the normal way, you could set
9749 @code{nnmail-resplit-incoming} to @code{t}.
9750
9751 @vindex nnmail-keep-last-article
9752 If you use @code{procmail} to split things directly into an @code{nnmh}
9753 directory (which you shouldn't do), you should set
9754 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9755 ever expiring the final article (i.e., the article with the highest
9756 article number) in a mail newsgroup.  This is quite, quite important.
9757
9758 Here's an example setup:  The incoming spools are located in
9759 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9760 spool files have the same names as the equivalent groups).  The
9761 @code{nnfolder} backend is to be used as the mail interface, and the
9762 @code{nnfolder} directory is @file{~/fMail/}.
9763
9764 @lisp
9765 (setq nnfolder-directory "~/fMail/")
9766 (setq nnmail-spool-file 'procmail)
9767 (setq nnmail-procmail-directory "~/incoming/")
9768 (setq gnus-secondary-select-methods '((nnfolder "")))
9769 (setq nnmail-procmail-suffix "")
9770 @end lisp
9771
9772
9773 @node Incorporating Old Mail
9774 @subsection Incorporating Old Mail
9775
9776 Most people have lots of old mail stored in various file formats.  If
9777 you have set up Gnus to read mail using one of the spiffy Gnus mail
9778 backends, you'll probably wish to have that old mail incorporated into
9779 your mail groups.
9780
9781 Doing so can be quite easy.
9782
9783 To take an example: You're reading mail using @code{nnml}
9784 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9785 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9786 file filled with important, but old, mail.  You want to move it into
9787 your @code{nnml} groups.
9788
9789 Here's how:
9790
9791 @enumerate
9792 @item
9793 Go to the group buffer.
9794
9795 @item
9796 Type `G f' and give the path to the mbox file when prompted to create an
9797 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9798
9799 @item
9800 Type `SPACE' to enter the newly created group.
9801
9802 @item
9803 Type `M P b' to process-mark all articles in this group's buffer
9804 (@pxref{Setting Process Marks}).
9805
9806 @item
9807 Type `B r' to respool all the process-marked articles, and answer
9808 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9809 @end enumerate
9810
9811 All the mail messages in the mbox file will now also be spread out over
9812 all your @code{nnml} groups.  Try entering them and check whether things
9813 have gone without a glitch.  If things look ok, you may consider
9814 deleting the mbox file, but I wouldn't do that unless I was absolutely
9815 sure that all the mail has ended up where it should be.
9816
9817 Respooling is also a handy thing to do if you're switching from one mail
9818 backend to another.  Just respool all the mail in the old mail groups
9819 using the new mail backend.
9820
9821
9822 @node Expiring Mail
9823 @subsection Expiring Mail
9824 @cindex article expiry
9825
9826 Traditional mail readers have a tendency to remove mail articles when
9827 you mark them as read, in some way.  Gnus takes a fundamentally
9828 different approach to mail reading.
9829
9830 Gnus basically considers mail just to be news that has been received in
9831 a rather peculiar manner.  It does not think that it has the power to
9832 actually change the mail, or delete any mail messages.  If you enter a
9833 mail group, and mark articles as ``read'', or kill them in some other
9834 fashion, the mail articles will still exist on the system.  I repeat:
9835 Gnus will not delete your old, read mail.  Unless you ask it to, of
9836 course.
9837
9838 To make Gnus get rid of your unwanted mail, you have to mark the
9839 articles as @dfn{expirable}.  This does not mean that the articles will
9840 disappear right away, however.  In general, a mail article will be
9841 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9842 more than one week old.  If you do not mark an article as expirable, it
9843 will remain on your system until hell freezes over.  This bears
9844 repeating one more time, with some spurious capitalizations: IF you do
9845 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9846
9847 @vindex gnus-auto-expirable-newsgroups
9848 You do not have to mark articles as expirable by hand.  Groups that
9849 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9850 have all articles that you read marked as expirable automatically.  All
9851 articles marked as expirable have an @samp{E} in the first
9852 column in the summary buffer.
9853
9854 By default, if you have auto expiry switched on, Gnus will mark all the
9855 articles you read as expirable, no matter if they were read or unread
9856 before.  To avoid having articles marked as read marked as expirable
9857 automatically, you can put something like the following in your
9858 @file{.gnus} file:
9859
9860 @vindex gnus-mark-article-hook
9861 @lisp
9862 (remove-hook 'gnus-mark-article-hook
9863              'gnus-summary-mark-read-and-unread-as-read)
9864 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9865 @end lisp
9866
9867 Note that making a group auto-expirable doesn't mean that all read
9868 articles are expired---only the articles marked as expirable
9869 will be expired.  Also note that using the @kbd{d} command won't make
9870 groups expirable---only semi-automatic marking of articles as read will
9871 mark the articles as expirable in auto-expirable groups.
9872
9873 Let's say you subscribe to a couple of mailing lists, and you want the
9874 articles you have read to disappear after a while:
9875
9876 @lisp
9877 (setq gnus-auto-expirable-newsgroups
9878       "mail.nonsense-list\\|mail.nice-list")
9879 @end lisp
9880
9881 Another way to have auto-expiry happen is to have the element
9882 @code{auto-expire} in the group parameters of the group.
9883
9884 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9885 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9886 don't really mix very well.
9887
9888 @vindex nnmail-expiry-wait
9889 The @code{nnmail-expiry-wait} variable supplies the default time an
9890 expirable article has to live.  Gnus starts counting days from when the
9891 message @emph{arrived}, not from when it was sent.  The default is seven
9892 days.
9893
9894 Gnus also supplies a function that lets you fine-tune how long articles
9895 are to live, based on what group they are in.  Let's say you want to
9896 have one month expiry period in the @samp{mail.private} group, a one day
9897 expiry period in the @samp{mail.junk} group, and a six day expiry period
9898 everywhere else:
9899
9900 @vindex nnmail-expiry-wait-function
9901 @lisp
9902 (setq nnmail-expiry-wait-function
9903       (lambda (group)
9904        (cond ((string= group "mail.private")
9905                31)
9906              ((string= group "mail.junk")
9907                1)
9908              ((string= group "important")
9909                'never)
9910              (t
9911                6))))
9912 @end lisp
9913
9914 The group names this function is fed are ``unadorned'' group
9915 names---no @samp{nnml:} prefixes and the like.
9916
9917 The @code{nnmail-expiry-wait} variable and
9918 @code{nnmail-expiry-wait-function} function can either be a number (not
9919 necessarily an integer) or one of the symbols @code{immediate} or
9920 @code{never}.
9921
9922 You can also use the @code{expiry-wait} group parameter to selectively
9923 change the expiry period (@pxref{Group Parameters}).
9924
9925 @vindex nnmail-keep-last-article
9926 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9927 expire the final article in a mail newsgroup.  This is to make life
9928 easier for procmail users.
9929
9930 @vindex gnus-total-expirable-newsgroups
9931 By the way: That line up there, about Gnus never expiring non-expirable
9932 articles, is a lie.  If you put @code{total-expire} in the group
9933 parameters, articles will not be marked as expirable, but all read
9934 articles will be put through the expiry process.  Use with extreme
9935 caution.  Even more dangerous is the
9936 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9937 this regexp will have all read articles put through the expiry process,
9938 which means that @emph{all} old mail articles in the groups in question
9939 will be deleted after a while.  Use with extreme caution, and don't come
9940 crying to me when you discover that the regexp you used matched the
9941 wrong group and all your important mail has disappeared.  Be a
9942 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9943 with!  So there!
9944
9945 Most people make most of their mail groups total-expirable, though.
9946
9947
9948 @node Washing Mail
9949 @subsection Washing Mail
9950 @cindex mail washing
9951 @cindex list server brain damage
9952 @cindex incoming mail treatment
9953
9954 Mailers and list servers are notorious for doing all sorts of really,
9955 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9956 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9957 end of all lines passing through our server, so let's do that!!!!1!''
9958 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9959 considered to be self-evident were not discussed.  So.  Here we are.
9960
9961 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9962 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9963 be shocked and dismayed by this, but I haven't got the energy.  It is to
9964 laugh.
9965
9966 Gnus provides a plethora of functions for washing articles while
9967 displaying them, but it might be nicer to do the filtering before
9968 storing the mail to disc.  For that purpose, we have three hooks and
9969 various functions that can be put in these hooks.
9970
9971 @table @code
9972 @item nnmail-prepare-incoming-hook
9973 @vindex nnmail-prepare-incoming-hook
9974 This hook is called before doing anything with the mail and is meant for
9975 grand, sweeping gestures.  Functions to be used include:
9976
9977 @table @code
9978 @item nnheader-ms-strip-cr
9979 @findex nnheader-ms-strip-cr
9980 Remove trailing carriage returns from each line.  This is default on
9981 Emacs running on MS machines.
9982
9983 @end table
9984
9985 @item nnmail-prepare-incoming-header-hook
9986 @vindex nnmail-prepare-incoming-header-hook
9987 This hook is called narrowed to each header.  It can be used when
9988 cleaning up the headers.  Functions that can be used include:
9989
9990 @table @code
9991 @item nnmail-remove-leading-whitespace
9992 @findex nnmail-remove-leading-whitespace
9993 Clear leading white space that ``helpful'' listservs have added to the
9994 headers to make them look nice.  Aaah.
9995
9996 @item nnmail-remove-list-identifiers
9997 @findex nnmail-remove-list-identifiers
9998 Some list servers add an identifier---for example, @samp{(idm)}---to the
9999 beginning of all @code{Subject} headers.  I'm sure that's nice for
10000 people who use stone age mail readers.  This function will remove
10001 strings that match the @code{nnmail-list-identifiers} regexp, which can
10002 also be a list of regexp.
10003
10004 For instance, if you want to remove the @samp{(idm)} and the
10005 @samp{nagnagnag} identifiers:
10006
10007 @lisp
10008 (setq nnmail-list-identifiers
10009       '("(idm)" "nagnagnag"))
10010 @end lisp
10011
10012 @item nnmail-remove-tabs
10013 @findex nnmail-remove-tabs
10014 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10015
10016 @end table
10017
10018 @item nnmail-prepare-incoming-message-hook
10019 @vindex nnmail-prepare-incoming-message-hook
10020 This hook is called narrowed to each message.  Functions to be used
10021 include:
10022
10023 @table @code
10024 @item article-de-quoted-unreadable
10025 @findex article-de-quoted-unreadable
10026 Decode Quoted Readable encoding.
10027
10028 @end table
10029 @end table
10030
10031
10032 @node Duplicates
10033 @subsection Duplicates
10034
10035 @vindex nnmail-treat-duplicates
10036 @vindex nnmail-message-id-cache-length
10037 @vindex nnmail-message-id-cache-file
10038 @cindex duplicate mails
10039 If you are a member of a couple of mailing lists, you will sometimes
10040 receive two copies of the same mail.  This can be quite annoying, so
10041 @code{nnmail} checks for and treats any duplicates it might find.  To do
10042 this, it keeps a cache of old @code{Message-ID}s---
10043 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10044 default.  The approximate maximum number of @code{Message-ID}s stored
10045 there is controlled by the @code{nnmail-message-id-cache-length}
10046 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10047 stored.) If all this sounds scary to you, you can set
10048 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10049 default), and @code{nnmail} won't delete duplicate mails.  Instead it
10050 will insert a warning into the head of the mail saying that it thinks
10051 that this is a duplicate of a different message.
10052
10053 This variable can also be a function.  If that's the case, the function
10054 will be called from a buffer narrowed to the message in question with
10055 the @code{Message-ID} as a parameter.  The function must return either
10056 @code{nil}, @code{warn}, or @code{delete}.
10057
10058 You can turn this feature off completely by setting the variable to
10059 @code{nil}.
10060
10061 If you want all the duplicate mails to be put into a special
10062 @dfn{duplicates} group, you could do that using the normal mail split
10063 methods:
10064
10065 @lisp
10066 (setq nnmail-split-fancy
10067       '(| ;; Messages duplicates go to a separate group.
10068           ("gnus-warning" "duplication of message" "duplicate")
10069           ;; Message from daemons, postmaster, and the like to another.
10070           (any mail "mail.misc")
10071           ;; Other rules.
10072           [ ... ] ))
10073 @end lisp
10074
10075 Or something like:
10076 @lisp
10077 (setq nnmail-split-methods
10078       '(("duplicates" "^Gnus-Warning:")
10079         ;; Other rules.
10080         [...]))
10081 @end lisp
10082
10083 Here's a neat feature: If you know that the recipient reads her mail
10084 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10085 @code{delete}, you can send her as many insults as you like, just by
10086 using a @code{Message-ID} of a mail that you know that she's already
10087 received.  Think of all the fun!  She'll never see any of it!  Whee!
10088
10089
10090 @node Not Reading Mail
10091 @subsection Not Reading Mail
10092
10093 If you start using any of the mail backends, they have the annoying
10094 habit of assuming that you want to read mail with them.  This might not
10095 be unreasonable, but it might not be what you want.
10096
10097 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
10098 will ever attempt to read incoming mail, which should help.
10099
10100 @vindex nnbabyl-get-new-mail
10101 @vindex nnmbox-get-new-mail
10102 @vindex nnml-get-new-mail
10103 @vindex nnmh-get-new-mail
10104 @vindex nnfolder-get-new-mail
10105 This might be too much, if, for instance, you are reading mail quite
10106 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10107 file you have stashed away with @code{nnbabyl}.  All backends have
10108 variables called backend-@code{get-new-mail}.  If you want to disable
10109 the @code{nnbabyl} mail reading, you edit the virtual server for the
10110 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10111
10112 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10113 narrowed to the article to be saved before saving it when reading
10114 incoming mail.
10115
10116
10117 @node Choosing a Mail Backend
10118 @subsection Choosing a Mail Backend
10119
10120 Gnus will read the mail spool when you activate a mail group.  The mail
10121 file is first copied to your home directory.  What happens after that
10122 depends on what format you want to store your mail in.
10123
10124 @menu
10125 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10126 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10127 * Mail Spool::                  Store your mail in a private spool?
10128 * MH Spool::                    An mhspool-like backend.
10129 * Mail Folders::                Having one file for each group.
10130 @end menu
10131
10132
10133 @node Unix Mail Box
10134 @subsubsection Unix Mail Box
10135 @cindex nnmbox
10136 @cindex unix mail box
10137
10138 @vindex nnmbox-active-file
10139 @vindex nnmbox-mbox-file
10140 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10141 mail.  @code{nnmbox} will add extra headers to each mail article to say
10142 which group it belongs in.
10143
10144 Virtual server settings:
10145
10146 @table @code
10147 @item nnmbox-mbox-file
10148 @vindex nnmbox-mbox-file
10149 The name of the mail box in the user's home directory.
10150
10151 @item nnmbox-active-file
10152 @vindex nnmbox-active-file
10153 The name of the active file for the mail box.
10154
10155 @item nnmbox-get-new-mail
10156 @vindex nnmbox-get-new-mail
10157 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10158 into groups.
10159 @end table
10160
10161
10162 @node Rmail Babyl
10163 @subsubsection Rmail Babyl
10164 @cindex nnbabyl
10165 @cindex rmail mbox
10166
10167 @vindex nnbabyl-active-file
10168 @vindex nnbabyl-mbox-file
10169 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10170 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10171 article to say which group it belongs in.
10172
10173 Virtual server settings:
10174
10175 @table @code
10176 @item nnbabyl-mbox-file
10177 @vindex nnbabyl-mbox-file
10178 The name of the rmail mbox file.
10179
10180 @item nnbabyl-active-file
10181 @vindex nnbabyl-active-file
10182 The name of the active file for the rmail box.
10183
10184 @item nnbabyl-get-new-mail
10185 @vindex nnbabyl-get-new-mail
10186 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
10187 @end table
10188
10189
10190 @node Mail Spool
10191 @subsubsection Mail Spool
10192 @cindex nnml
10193 @cindex mail @sc{nov} spool
10194
10195 The @dfn{nnml} spool mail format isn't compatible with any other known
10196 format.  It should be used with some caution.
10197
10198 @vindex nnml-directory
10199 If you use this backend, Gnus will split all incoming mail into files,
10200 one file for each mail, and put the articles into the corresponding
10201 directories under the directory specified by the @code{nnml-directory}
10202 variable.  The default value is @file{~/Mail/}.
10203
10204 You do not have to create any directories beforehand; Gnus will take
10205 care of all that.
10206
10207 If you have a strict limit as to how many files you are allowed to store
10208 in your account, you should not use this backend.  As each mail gets its
10209 own file, you might very well occupy thousands of inodes within a few
10210 weeks.  If this is no problem for you, and it isn't a problem for you
10211 having your friendly systems administrator walking around, madly,
10212 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10213 know that this is probably the fastest format to use.  You do not have
10214 to trudge through a big mbox file just to read your new mail.
10215
10216 @code{nnml} is probably the slowest backend when it comes to article
10217 splitting.  It has to create lots of files, and it also generates
10218 @sc{nov} databases for the incoming mails.  This makes it the fastest
10219 backend when it comes to reading mail.
10220
10221 Virtual server settings:
10222
10223 @table @code
10224 @item nnml-directory
10225 @vindex nnml-directory
10226 All @code{nnml} directories will be placed under this directory.
10227
10228 @item nnml-active-file
10229 @vindex nnml-active-file
10230 The active file for the @code{nnml} server.
10231
10232 @item nnml-newsgroups-file
10233 @vindex nnml-newsgroups-file
10234 The @code{nnml} group descriptions file.  @xref{Newsgroups File
10235 Format}.
10236
10237 @item nnml-get-new-mail
10238 @vindex nnml-get-new-mail
10239 If non-@code{nil}, @code{nnml} will read incoming mail.
10240
10241 @item nnml-nov-is-evil
10242 @vindex nnml-nov-is-evil
10243 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10244
10245 @item nnml-nov-file-name
10246 @vindex nnml-nov-file-name
10247 The name of the @sc{nov} files.  The default is @file{.overview}.
10248
10249 @item nnml-prepare-save-mail-hook
10250 @vindex nnml-prepare-save-mail-hook
10251 Hook run narrowed to an article before saving.
10252
10253 @end table
10254
10255 @findex nnml-generate-nov-databases
10256 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10257 you can do a complete update by typing @kbd{M-x
10258 nnml-generate-nov-databases}.  This command will trawl through the
10259 entire @code{nnml} hierarchy, looking at each and every article, so it
10260 might take a while to complete.  A better interface to this
10261 functionality can be found in the server buffer (@pxref{Server
10262 Commands}).
10263
10264
10265 @node MH Spool
10266 @subsubsection MH Spool
10267 @cindex nnmh
10268 @cindex mh-e mail spool
10269
10270 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10271 @sc{nov} databases and it doesn't keep an active file.  This makes
10272 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10273 makes it easier to write procmail scripts for.
10274
10275 Virtual server settings:
10276
10277 @table @code
10278 @item nnmh-directory
10279 @vindex nnmh-directory
10280 All @code{nnmh} directories will be located under this directory.
10281
10282 @item nnmh-get-new-mail
10283 @vindex nnmh-get-new-mail
10284 If non-@code{nil}, @code{nnmh} will read incoming mail.
10285
10286 @item nnmh-be-safe
10287 @vindex nnmh-be-safe
10288 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10289 sure that the articles in the folder are actually what Gnus thinks they
10290 are.  It will check date stamps and stat everything in sight, so
10291 setting this to @code{t} will mean a serious slow-down.  If you never
10292 use anything but Gnus to read the @code{nnmh} articles, you do not have
10293 to set this variable to @code{t}.
10294 @end table
10295
10296
10297 @node Mail Folders
10298 @subsubsection Mail Folders
10299 @cindex nnfolder
10300 @cindex mbox folders
10301 @cindex mail folders
10302
10303 @code{nnfolder} is a backend for storing each mail group in a separate
10304 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
10305 will add extra headers to keep track of article numbers and arrival
10306 dates.
10307
10308 Virtual server settings:
10309
10310 @table @code
10311 @item nnfolder-directory
10312 @vindex nnfolder-directory
10313 All the @code{nnfolder} mail boxes will be stored under this directory.
10314
10315 @item nnfolder-active-file
10316 @vindex nnfolder-active-file
10317 The name of the active file.
10318
10319 @item nnfolder-newsgroups-file
10320 @vindex nnfolder-newsgroups-file
10321 The name of the group descriptions file.  @xref{Newsgroups File Format}.
10322
10323 @item nnfolder-get-new-mail
10324 @vindex nnfolder-get-new-mail
10325 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10326 @end table
10327
10328 @findex nnfolder-generate-active-file
10329 @kindex M-x nnfolder-generate-active-file
10330 If you have lots of @code{nnfolder}-like files you'd like to read with
10331 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10332 command to make @code{nnfolder} aware of all likely files in
10333 @code{nnfolder-directory}.
10334
10335
10336 @node Other Sources
10337 @section Other Sources
10338
10339 Gnus can do more than just read news or mail.  The methods described
10340 below allow Gnus to view directories and files as if they were
10341 newsgroups.
10342
10343 @menu
10344 * Directory Groups::      You can read a directory as if it was a newsgroup.
10345 * Anything Groups::       Dired?  Who needs dired?
10346 * Document Groups::       Single files can be the basis of a group.
10347 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
10348 * Web Searches::          Creating groups from articles that match a string.
10349 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10350 @end menu
10351
10352
10353 @node Directory Groups
10354 @subsection Directory Groups
10355 @cindex nndir
10356 @cindex directory groups
10357
10358 If you have a directory that has lots of articles in separate files in
10359 it, you might treat it as a newsgroup.  The files have to have numerical
10360 names, of course.
10361
10362 This might be an opportune moment to mention @code{ange-ftp} (and its
10363 successor @code{efs}), that most wonderful of all wonderful Emacs
10364 packages.  When I wrote @code{nndir}, I didn't think much about it---a
10365 backend to read directories.  Big deal.
10366
10367 @code{ange-ftp} changes that picture dramatically.  For instance, if you
10368 enter the @code{ange-ftp} file name
10369 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10370 @code{ange-ftp} or @code{efs} will actually allow you to read this
10371 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
10372
10373 @code{nndir} will use @sc{nov} files if they are present.
10374
10375 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10376 articles with this method.  You can use @code{nnmh} or @code{nnml} for
10377 whatever you use @code{nndir} for, so you could switch to any of those
10378 methods if you feel the need to have a non-read-only @code{nndir}.
10379
10380
10381 @node Anything Groups
10382 @subsection Anything Groups
10383 @cindex nneething
10384
10385 From the @code{nndir} backend (which reads a single spool-like
10386 directory), it's just a hop and a skip to @code{nneething}, which
10387 pretends that any arbitrary directory is a newsgroup.  Strange, but
10388 true.
10389
10390 When @code{nneething} is presented with a directory, it will scan this
10391 directory and assign article numbers to each file.  When you enter such
10392 a group, @code{nneething} must create ``headers'' that Gnus can use.
10393 After all, Gnus is a newsreader, in case you're
10394 forgetting. @code{nneething} does this in a two-step process.  First, it
10395 snoops each file in question.  If the file looks like an article (i.e.,
10396 the first few lines look like headers), it will use this as the head.
10397 If this is just some arbitrary file without a head (e.g. a C source
10398 file), @code{nneething} will cobble up a header out of thin air.  It
10399 will use file ownership, name and date and do whatever it can with these
10400 elements.
10401
10402 All this should happen automatically for you, and you will be presented
10403 with something that looks very much like a newsgroup.  Totally like a
10404 newsgroup, to be precise.  If you select an article, it will be displayed
10405 in the article buffer, just as usual.
10406
10407 If you select a line that represents a directory, Gnus will pop you into
10408 a new summary buffer for this @code{nneething} group.  And so on.  You can
10409 traverse the entire disk this way, if you feel like, but remember that
10410 Gnus is not dired, really, and does not intend to be, either.
10411
10412 There are two overall modes to this action---ephemeral or solid.  When
10413 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10414 will not store information on what files you have read, and what files
10415 are new, and so on.  If you create a solid @code{nneething} group the
10416 normal way with @kbd{G m}, Gnus will store a mapping table between
10417 article numbers and file names, and you can treat this group like any
10418 other groups.  When you activate a solid @code{nneething} group, you will
10419 be told how many unread articles it contains, etc., etc.
10420
10421 Some variables:
10422
10423 @table @code
10424 @item nneething-map-file-directory
10425 @vindex nneething-map-file-directory
10426 All the mapping files for solid @code{nneething} groups will be stored
10427 in this directory, which defaults to @file{~/.nneething/}.
10428
10429 @item nneething-exclude-files
10430 @vindex nneething-exclude-files
10431 All files that match this regexp will be ignored.  Nice to use to exclude
10432 auto-save files and the like, which is what it does by default.
10433
10434 @item nneething-map-file
10435 @vindex nneething-map-file
10436 Name of the map files.
10437 @end table
10438
10439
10440 @node Document Groups
10441 @subsection Document Groups
10442 @cindex nndoc
10443 @cindex documentation group
10444 @cindex help group
10445
10446 @code{nndoc} is a cute little thing that will let you read a single file
10447 as a newsgroup.  Several files types are supported:
10448
10449 @table @code
10450 @cindex babyl
10451 @cindex rmail mbox
10452
10453 @item babyl
10454 The babyl (rmail) mail box.
10455 @cindex mbox
10456 @cindex Unix mbox
10457
10458 @item mbox
10459 The standard Unix mbox file.
10460
10461 @cindex MMDF mail box
10462 @item mmdf
10463 The MMDF mail box format.
10464
10465 @item news
10466 Several news articles appended into a file.
10467
10468 @item rnews
10469 @cindex rnews batch files
10470 The rnews batch transport format.
10471 @cindex forwarded messages
10472
10473 @item forward
10474 Forwarded articles.
10475
10476 @item mime-digest
10477 @cindex digest
10478 @cindex MIME digest
10479 @cindex 1153 digest
10480 @cindex RFC 1153 digest
10481 @cindex RFC 341 digest
10482 MIME (RFC 1341) digest format.
10483
10484 @item standard-digest
10485 The standard (RFC 1153) digest format.
10486
10487 @item slack-digest
10488 Non-standard digest format---matches most things, but does it badly.
10489 @end table
10490
10491 You can also use the special ``file type'' @code{guess}, which means
10492 that @code{nndoc} will try to guess what file type it is looking at.
10493 @code{digest} means that @code{nndoc} should guess what digest type the
10494 file is.
10495
10496 @code{nndoc} will not try to change the file or insert any extra headers into
10497 it---it will simply, like, let you use the file as the basis for a
10498 group.  And that's it.
10499
10500 If you have some old archived articles that you want to insert into your
10501 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10502 that.  Say you have an old @file{RMAIL} file with mail that you now want
10503 to split into your new @code{nnml} groups.  You look at that file using
10504 @code{nndoc} (using the @kbd{G f} command in the group buffer
10505 (@pxref{Foreign Groups})), set the process mark on all the articles in
10506 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10507 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
10508 file is now also stored in lots of @code{nnml} directories, and you can
10509 delete that pesky @file{RMAIL} file.  If you have the guts!
10510
10511 Virtual server variables:
10512
10513 @table @code
10514 @item nndoc-article-type
10515 @vindex nndoc-article-type
10516 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10517 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10518 @code{rfc822-forward}, @code{mime-digest}, @code{standard-digest},
10519 @code{slack-digest}, @code{clari-briefs} or @code{guess}.
10520
10521 @item nndoc-post-type
10522 @vindex nndoc-post-type
10523 This variable says whether Gnus is to consider the group a news group or
10524 a mail group.  There are two valid values:  @code{mail} (the default)
10525 and @code{news}.
10526 @end table
10527
10528 @menu
10529 * Document Server Internals::   How to add your own document types.
10530 @end menu
10531
10532
10533 @node Document Server Internals
10534 @subsubsection Document Server Internals
10535
10536 Adding new document types to be recognized by @code{nndoc} isn't
10537 difficult.  You just have to whip up a definition of what the document
10538 looks like, write a predicate function to recognize that document type,
10539 and then hook into @code{nndoc}.
10540
10541 First, here's an example document type definition:
10542
10543 @example
10544 (mmdf
10545  (article-begin .  "^\^A\^A\^A\^A\n")
10546  (body-end .  "^\^A\^A\^A\^A\n"))
10547 @end example
10548
10549 The definition is simply a unique @dfn{name} followed by a series of
10550 regexp pseudo-variable settings.  Below are the possible
10551 variables---don't be daunted by the number of variables; most document
10552 types can be defined with very few settings:
10553
10554 @table @code
10555 @item first-article
10556 If present, @code{nndoc} will skip past all text until it finds
10557 something that match this regexp.  All text before this will be
10558 totally ignored.
10559
10560 @item article-begin
10561 This setting has to be present in all document type definitions.  It
10562 says what the beginning of each article looks like.
10563
10564 @item head-begin-function
10565 If present, this should be a function that moves point to the head of
10566 the article.
10567
10568 @item nndoc-head-begin
10569 If present, this should be a regexp that matches the head of the
10570 article.
10571
10572 @item nndoc-head-end
10573 This should match the end of the head of the article.  It defaults to
10574 @samp{^$}---the empty line.
10575
10576 @item body-begin-function
10577 If present, this function should move point to the beginning of the body
10578 of the article.
10579
10580 @item body-begin
10581 This should match the beginning of the body of the article.  It defaults
10582 to @samp{^\n}.
10583
10584 @item body-end-function
10585 If present, this function should move point to the end of the body of
10586 the article.
10587
10588 @item body-end
10589 If present, this should match the end of the body of the article.
10590
10591 @item file-end
10592 If present, this should match the end of the file.  All text after this
10593 regexp will be totally ignored.
10594
10595 @end table
10596
10597 So, using these variables @code{nndoc} is able to dissect a document
10598 file into a series of articles, each with a head and a body.  However, a
10599 few more variables are needed since not all document types are all that
10600 news-like---variables needed to transform the head or the body into
10601 something that's palatable for Gnus:
10602
10603 @table @code
10604 @item prepare-body-function
10605 If present, this function will be called when requesting an article.  It
10606 will be called with point at the start of the body, and is useful if the
10607 document has encoded some parts of its contents.
10608
10609 @item article-transform-function
10610 If present, this function is called when requesting an article.  It's
10611 meant to be used for more wide-ranging transformation of both head and
10612 body of the article.
10613
10614 @item generate-head-function
10615 If present, this function is called to generate a head that Gnus can
10616 understand.  It is called with the article number as a parameter, and is
10617 expected to generate a nice head for the article in question.  It is
10618 called when requesting the headers of all articles.
10619
10620 @end table
10621
10622 Let's look at the most complicated example I can come up with---standard
10623 digests:
10624
10625 @example
10626 (standard-digest
10627  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10628  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10629  (prepare-body-function . nndoc-unquote-dashes)
10630  (body-end-function . nndoc-digest-body-end)
10631  (head-end . "^ ?$")
10632  (body-begin . "^ ?\n")
10633  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10634  (subtype digest guess))
10635 @end example
10636
10637 We see that all text before a 70-width line of dashes is ignored; all
10638 text after a line that starts with that @samp{^End of} is also ignored;
10639 each article begins with a 30-width line of dashes; the line separating
10640 the head from the body may contain a single space; and that the body is
10641 run through @code{nndoc-unquote-dashes} before being delivered.
10642
10643 To hook your own document definition into @code{nndoc}, use the
10644 @code{nndoc-add-type} function.  It takes two parameters---the first is
10645 the definition itself and the second (optional) parameter says where in
10646 the document type definition alist to put this definition.  The alist is
10647 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for a given type @code{TYPE}.  So @code{nndoc-mmdf-type-p} is called to see whether a document
10648 is of @code{mmdf} type, and so on.  These type predicates should return
10649 @code{nil} if the document is not of the correct type; @code{t} if it is
10650 of the correct type; and a number if the document might be of the
10651 correct type.  A high number means high probability; a low number means
10652 low probability with @samp{0} being the lowest valid number.
10653
10654
10655 @node SOUP
10656 @subsection SOUP
10657 @cindex SOUP
10658 @cindex offline
10659
10660 In the PC world people often talk about ``offline'' newsreaders.  These
10661 are thingies that are combined reader/news transport monstrosities.
10662 With built-in modem programs.  Yecchh!
10663
10664 Of course, us Unix Weenie types of human beans use things like
10665 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10666 transport things like Ghod intended.  And then we just use normal
10667 newsreaders.
10668
10669 However, it can sometimes be convenient to do something a that's a bit
10670 easier on the brain if you have a very slow modem, and you're not really
10671 that interested in doing things properly.
10672
10673 A file format called @sc{soup} has been developed for transporting news
10674 and mail from servers to home machines and back again.  It can be a bit
10675 fiddly.
10676
10677 First some terminology:
10678
10679 @table @dfn
10680
10681 @item server
10682 This is the machine that is connected to the outside world and where you
10683 get news and/or mail from.
10684
10685 @item home machine
10686 This is the machine that you want to do the actual reading and responding
10687 on.  It is typically not connected to the rest of the world in any way.
10688
10689 @item packet
10690 Something that contains messages and/or commands.  There are two kinds
10691 of packets:
10692
10693 @table @dfn
10694 @item message packets
10695 These are packets made at the server, and typically contain lots of
10696 messages for you to read.  These are called @file{SoupoutX.tgz} by
10697 default, where @var{X} is a number.
10698
10699 @item response packets
10700 These are packets made at the home machine, and typically contains
10701 replies that you've written.  These are called @file{SoupinX.tgz} by
10702 default, where @var{X} is a number.
10703
10704 @end table
10705
10706 @end table
10707
10708
10709 @enumerate
10710
10711 @item
10712 You log in on the server and create a @sc{soup} packet.  You can either
10713 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10714 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10715 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10716
10717 @item
10718 You transfer the packet home.  Rail, boat, car or modem will do fine.
10719
10720 @item
10721 You put the packet in your home directory.
10722
10723 @item
10724 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10725 the native or secondary server.
10726
10727 @item
10728 You read articles and mail and answer and followup to the things you
10729 want (@pxref{SOUP Replies}).
10730
10731 @item
10732 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10733 packet.
10734
10735 @item
10736 You transfer this packet to the server.
10737
10738 @item
10739 You use Gnus to mail this packet out with the @kbd{G s s} command.
10740
10741 @item
10742 You then repeat until you die.
10743
10744 @end enumerate
10745
10746 So you basically have a bipartite system---you use @code{nnsoup} for
10747 reading and Gnus for packing/sending these @sc{soup} packets.
10748
10749 @menu
10750 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10751 * SOUP Groups::       A backend for reading @sc{soup} packets.
10752 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10753 @end menu
10754
10755
10756 @node SOUP Commands
10757 @subsubsection SOUP Commands
10758
10759 These are commands for creating and manipulating @sc{soup} packets.
10760
10761 @table @kbd
10762 @item G s b
10763 @kindex G s b (Group)
10764 @findex gnus-group-brew-soup
10765 Pack all unread articles in the current group
10766 (@code{gnus-group-brew-soup}).  This command understands the
10767 process/prefix convention.
10768
10769 @item G s w
10770 @kindex G s w (Group)
10771 @findex gnus-soup-save-areas
10772 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10773
10774 @item G s s
10775 @kindex G s s (Group)
10776 @findex gnus-soup-send-replies
10777 Send all replies from the replies packet
10778 (@code{gnus-soup-send-replies}).
10779
10780 @item G s p
10781 @kindex G s p (Group)
10782 @findex gnus-soup-pack-packet
10783 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
10784
10785 @item G s r
10786 @kindex G s r (Group)
10787 @findex nnsoup-pack-replies
10788 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
10789
10790 @item O s
10791 @kindex O s (Summary)
10792 @findex gnus-soup-add-article
10793 This summary-mode command adds the current article to a @sc{soup} packet
10794 (@code{gnus-soup-add-article}).  It understands the process/prefix
10795 convention (@pxref{Process/Prefix}).
10796
10797 @end table
10798
10799
10800 There are a few variables to customize where Gnus will put all these
10801 thingies:
10802
10803 @table @code
10804
10805 @item gnus-soup-directory
10806 @vindex gnus-soup-directory
10807 Directory where Gnus will save intermediate files while composing
10808 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
10809
10810 @item gnus-soup-replies-directory
10811 @vindex gnus-soup-replies-directory
10812 This is what Gnus will use as a temporary directory while sending our
10813 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10814
10815 @item gnus-soup-prefix-file
10816 @vindex gnus-soup-prefix-file
10817 Name of the file where Gnus stores the last used prefix.  The default is
10818 @samp{gnus-prefix}.
10819
10820 @item gnus-soup-packer
10821 @vindex gnus-soup-packer
10822 A format string command for packing a @sc{soup} packet.  The default is
10823 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
10824
10825 @item gnus-soup-unpacker
10826 @vindex gnus-soup-unpacker
10827 Format string command for unpacking a @sc{soup} packet.  The default is
10828 @samp{gunzip -c %s | tar xvf -}.
10829
10830 @item gnus-soup-packet-directory
10831 @vindex gnus-soup-packet-directory
10832 Where Gnus will look for reply packets.  The default is @file{~/}.
10833
10834 @item gnus-soup-packet-regexp
10835 @vindex gnus-soup-packet-regexp
10836 Regular expression matching @sc{soup} reply packets in
10837 @code{gnus-soup-packet-directory}.
10838
10839 @end table
10840
10841
10842 @node SOUP Groups
10843 @subsubsection @sc{soup} Groups
10844 @cindex nnsoup
10845
10846 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10847 read incoming packets, unpack them, and put them in a directory where
10848 you can read them at leisure.
10849
10850 These are the variables you can use to customize its behavior:
10851
10852 @table @code
10853
10854 @item nnsoup-tmp-directory
10855 @vindex nnsoup-tmp-directory
10856 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10857 directory.  (@file{/tmp/} by default.)
10858
10859 @item nnsoup-directory
10860 @vindex nnsoup-directory
10861 @code{nnsoup} then moves each message and index file to this directory.
10862 The default is @file{~/SOUP/}.
10863
10864 @item nnsoup-replies-directory
10865 @vindex nnsoup-replies-directory
10866 All replies will be stored in this directory before being packed into a
10867 reply packet.  The default is @file{~/SOUP/replies/"}.
10868
10869 @item nnsoup-replies-format-type
10870 @vindex nnsoup-replies-format-type
10871 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10872 (rnews), and I don't think you should touch that variable.  I probably
10873 shouldn't even have documented it.  Drats!  Too late!
10874
10875 @item nnsoup-replies-index-type
10876 @vindex nnsoup-replies-index-type
10877 The index type of the replies packet.  The default is @samp{?n}, which
10878 means ``none''.  Don't fiddle with this one either!
10879
10880 @item nnsoup-active-file
10881 @vindex nnsoup-active-file
10882 Where @code{nnsoup} stores lots of information.  This is not an ``active
10883 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10884 this file or mess it up in any way, you're dead.  The default is
10885 @file{~/SOUP/active}.
10886
10887 @item nnsoup-packer
10888 @vindex nnsoup-packer
10889 Format string command for packing a reply @sc{soup} packet.  The default
10890 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
10891
10892 @item nnsoup-unpacker
10893 @vindex nnsoup-unpacker
10894 Format string command for unpacking incoming @sc{soup} packets.  The
10895 default is @samp{gunzip -c %s | tar xvf -}.
10896
10897 @item nnsoup-packet-directory
10898 @vindex nnsoup-packet-directory
10899 Where @code{nnsoup} will look for incoming packets.  The default is
10900 @file{~/}.
10901
10902 @item nnsoup-packet-regexp
10903 @vindex nnsoup-packet-regexp
10904 Regular expression matching incoming @sc{soup} packets.  The default is
10905 @samp{Soupout}.
10906
10907 @item nnsoup-always-save
10908 @vindex nnsoup-always-save
10909 If non-@code{nil}, save the replies buffer after each posted message.
10910
10911 @end table
10912
10913
10914 @node SOUP Replies
10915 @subsubsection SOUP Replies
10916
10917 Just using @code{nnsoup} won't mean that your postings and mailings end
10918 up in @sc{soup} reply packets automagically.  You have to work a bit
10919 more for that to happen.
10920
10921 @findex nnsoup-set-variables
10922 The @code{nnsoup-set-variables} command will set the appropriate
10923 variables to ensure that all your followups and replies end up in the
10924 @sc{soup} system.
10925
10926 In specific, this is what it does:
10927
10928 @lisp
10929 (setq message-send-news-function 'nnsoup-request-post)
10930 (setq message-send-mail-function 'nnsoup-request-mail)
10931 @end lisp
10932
10933 And that's it, really.  If you only want news to go into the @sc{soup}
10934 system you just use the first line.  If you only want mail to be
10935 @sc{soup}ed you use the second.
10936
10937
10938 @node Web Searches
10939 @subsection Web Searches
10940 @cindex nnweb
10941 @cindex DejaNews
10942 @cindex Alta Vista
10943 @cindex InReference
10944 @cindex Usenet searches
10945 @cindex searching the Usenet
10946
10947 It's, like, too neat to search the Usenet for articles that match a
10948 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10949 those, like, Web browsers, and you, like, have to, rilly, like, look at
10950 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10951 searches without having to use a browser.
10952
10953 The @code{nnweb} backend allows an easy interface to the mighty search
10954 engine.  You create an @code{nnweb} group, enter a search pattern, and
10955 then enter the group and read the articles like you would any normal
10956 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10957 Groups}) will do this in an easy-to-use fashion.
10958
10959 @code{nnweb} groups don't really lend themselves to being solid
10960 groups---they have a very fleeting idea of article numbers.  In fact,
10961 each time you enter an @code{nnweb} group (not even changing the search
10962 pattern), you are likely to get the articles ordered in a different
10963 manner.  Not even using duplicate suppression (@pxref{Duplicate
10964 Suppression}) will help, since @code{nnweb} doesn't even know the
10965 @code{Message-ID} of the articles before reading them using some search
10966 engines (DejaNews, for instance).  The only possible way to keep track
10967 of which articles you've read is by scoring on the @code{Date}
10968 header---mark all articles posted before the last date you read the
10969 group as read.
10970
10971 If the search engine changes its output substantially, @code{nnweb}
10972 won't be able to parse it and will fail.  One could hardly fault the Web
10973 providers if they were to do this---their @emph{raison d'être} is to
10974 make money off of advertisements, not to provide services to the
10975 community.  Since @code{nnweb} washes the ads off all the articles, one
10976 might think that the providers might be somewhat miffed.  We'll see.
10977
10978 You must have the @code{url} and @code{w3} package installed to be able
10979 to use @code{nnweb}.
10980
10981 Virtual server variables:
10982
10983 @table @code
10984 @item nnweb-type
10985 @vindex nnweb-type
10986 What search engine type is being used.  The currently supported types
10987 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
10988 @code{reference}.
10989
10990 @item nnweb-search
10991 @vindex nnweb-search
10992 The search string to feed to the search engine.
10993
10994 @item nnweb-max-hits
10995 @vindex nnweb-max-hits
10996 Advisory maximum number of hits per search to display.  The default is
10997 100.
10998
10999 @item nnweb-type-definition
11000 @vindex nnweb-type-definition
11001 Type-to-definition alist.  This alist says what @code{nnweb} should do
11002 with the various search engine types.  The following elements must be
11003 present:
11004
11005 @table @code
11006 @item article
11007 Function to decode the article and provide something that Gnus
11008 understands.
11009
11010 @item map
11011 Function to create an article number to message header and URL alist.
11012
11013 @item search
11014 Function to send the search string to the search engine.
11015
11016 @item address
11017 The address the aforementioned function should send the search string
11018 to.
11019
11020 @item id
11021 Format string URL to fetch an article by @code{Message-ID}.
11022 @end table
11023
11024 @end table
11025
11026
11027
11028 @node Mail-To-News Gateways
11029 @subsection Mail-To-News Gateways
11030 @cindex mail-to-news gateways
11031 @cindex gateways
11032
11033 If your local @code{nntp} server doesn't allow posting, for some reason
11034 or other, you can post using one of the numerous mail-to-news gateways.
11035 The @code{nngateway} backend provides the interface.
11036
11037 Note that you can't read anything from this backend---it can only be
11038 used to post with.
11039
11040 Server variables:
11041
11042 @table @code
11043 @item nngateway-address
11044 @vindex nngateway-address
11045 This is the address of the mail-to-news gateway.
11046
11047 @item nngateway-header-transformation
11048 @vindex nngateway-header-transformation
11049 News headers often have to be transformed in some odd way or other
11050 for the mail-to-news gateway to accept it.  This variable says what
11051 transformation should be called, and defaults to
11052 @code{nngateway-simple-header-transformation}.  The function is called
11053 narrowed to the headers to be transformed and with one parameter---the
11054 gateway address.
11055
11056 This default function just inserts a new @code{To} header based on the
11057 @code{Newsgroups} header and the gateway address.
11058 For instance, an article with this @code{Newsgroups} header:
11059
11060 @example
11061 Newsgroups: alt.religion.emacs
11062 @end example
11063
11064 will get this @code{From} header inserted:
11065
11066 @example
11067 To: alt-religion-emacs@@GATEWAY
11068 @end example
11069
11070 The following pre-defined functions exist:
11071
11072 @findex nngateway-simple-header-transformation
11073 @table @code
11074
11075 @item nngateway-simple-header-transformation
11076 Creates a @code{To} header that looks like
11077 @var{newsgroup}@@@code{nngateway-address}.
11078
11079 @findex nngateway-mail2news-header-transformation
11080
11081 @item nngateway-mail2news-header-transformation
11082 Creates a @code{To} header that looks like
11083 @code{nngateway-address}.
11084
11085 Here's an example:
11086
11087 @lisp
11088 (setq gnus-post-method
11089       '(nngateway "mail2news@@replay.com"
11090                   (nngateway-header-transformation
11091                    nngateway-mail2news-header-transformation)))
11092 @end lisp
11093
11094 @end table
11095
11096
11097 @end table
11098
11099 So, to use this, simply say something like:
11100
11101 @lisp
11102 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
11103 @end lisp
11104
11105
11106 @node Combined Groups
11107 @section Combined Groups
11108
11109 Gnus allows combining a mixture of all the other group types into bigger
11110 groups.
11111
11112 @menu
11113 * Virtual Groups::     Combining articles from many groups.
11114 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
11115 @end menu
11116
11117
11118 @node Virtual Groups
11119 @subsection Virtual Groups
11120 @cindex nnvirtual
11121 @cindex virtual groups
11122 @cindex merging groups
11123
11124 An @dfn{nnvirtual group} is really nothing more than a collection of
11125 other groups.
11126
11127 For instance, if you are tired of reading many small groups, you can
11128 put them all in one big group, and then grow tired of reading one
11129 big, unwieldy group.  The joys of computing!
11130
11131 You specify @code{nnvirtual} as the method.  The address should be a
11132 regexp to match component groups.
11133
11134 All marks in the virtual group will stick to the articles in the
11135 component groups.  So if you tick an article in a virtual group, the
11136 article will also be ticked in the component group from whence it came.
11137 (And vice versa---marks from the component groups will also be shown in
11138 the virtual group.)
11139
11140 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
11141 newsgroups into one, big, happy newsgroup:
11142
11143 @lisp
11144 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11145 @end lisp
11146
11147 The component groups can be native or foreign; everything should work
11148 smoothly, but if your computer explodes, it was probably my fault.
11149
11150 Collecting the same group from several servers might actually be a good
11151 idea if users have set the Distribution header to limit distribution.
11152 If you would like to read @samp{soc.motss} both from a server in Japan
11153 and a server in Norway, you could use the following as the group regexp:
11154
11155 @example
11156 "^nntp\\+some\\.server\\.jp:soc\\.motss$\\|^nntp\\+some\\.server\\.no:soc\\.motss$"
11157 @end example
11158
11159 (Remember, though, that if you're creating the group with @kbd{G m}, you
11160 shouldn't double the backslashes, and you should leave off the quote
11161 characters at the beginning and the end of the string.)
11162
11163 This should work kinda smoothly---all articles from both groups should
11164 end up in this one, and there should be no duplicates.  Threading (and
11165 the rest) will still work as usual, but there might be problems with the
11166 sequence of articles.  Sorting on date might be an option here
11167 (@pxref{Selecting a Group}).
11168
11169 One limitation, however---all groups included in a virtual
11170 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
11171 zombie groups can't be component groups for @code{nnvirtual} groups.
11172
11173 @vindex nnvirtual-always-rescan
11174 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11175 @code{nnvirtual} will always scan groups for unread articles when
11176 entering a virtual group.  If this variable is @code{nil} (which is the
11177 default) and you read articles in a component group after the virtual
11178 group has been activated, the read articles from the component group
11179 will show up when you enter the virtual group.  You'll also see this
11180 effect if you have two virtual groups that have a component group in
11181 common.  If that's the case, you should set this variable to @code{t}.
11182 Or you can just tap @code{M-g} on the virtual group every time before
11183 you enter it---it'll have much the same effect.
11184
11185
11186 @node Kibozed Groups
11187 @subsection Kibozed Groups
11188 @cindex nnkiboze
11189 @cindex kibozing
11190
11191 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11192 the news feed''.  @code{nnkiboze} is a backend that will do this for
11193 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
11194 with useless requests!  Oh happiness!
11195
11196 @kindex G k (Group)
11197 To create a kibozed group, use the @kbd{G k} command in the group
11198 buffer.
11199
11200 The address field of the @code{nnkiboze} method is, as with
11201 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11202 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
11203 and @code{nnvirtual} end.
11204
11205 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11206 must have a score file to say what articles are to be included in
11207 the group (@pxref{Scoring}).
11208
11209 @kindex M-x nnkiboze-generate-groups
11210 @findex nnkiboze-generate-groups
11211 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11212 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
11213 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
11214 all the articles in all the component groups and run them through the
11215 scoring process to determine if there are any articles in the groups
11216 that are to be part of the @code{nnkiboze} groups.
11217
11218 Please limit the number of component groups by using restrictive
11219 regexps.  Otherwise your sysadmin may become annoyed with you, and the
11220 @sc{nntp} site may throw you off and never let you back in again.
11221 Stranger things have happened.
11222
11223 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11224 and they can be foreign.  No restrictions.
11225
11226 @vindex nnkiboze-directory
11227 The generation of an @code{nnkiboze} group means writing two files in
11228 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
11229 contains the @sc{nov} header lines for all the articles in the group,
11230 and the other is an additional @file{.newsrc} file to store information
11231 on what groups have been searched through to find component articles.
11232
11233 Articles marked as read in the @code{nnkiboze} group will have
11234 their @sc{nov} lines removed from the @sc{nov} file.
11235
11236
11237 @node Gnus Unplugged
11238 @section Gnus Unplugged
11239 @cindex offline
11240 @cindex unplugged
11241 @cindex Agent
11242 @cindex Gnus Agent
11243 @cindex Gnus Unplugged
11244
11245 In olden times (ca. February '88), people used to run their newsreaders
11246 on big machines with permanent connections to the net.  News transport
11247 was dealt with by news servers, and all the newsreaders had to do was to
11248 read news.  Believe it or not.
11249
11250 Nowadays most people read news and mail at home, and use some sort of
11251 modem to connect to the net.  To avoid running up huge phone bills, it
11252 would be nice to have a way to slurp down all the news and mail, hang up
11253 the phone, read for several hours, and then upload any responses you
11254 have to make.  And then you repeat the procedure.
11255
11256 Of course, you can use news servers for doing this as well.  I've used
11257 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11258 for some years, but doing that's a bore.  Moving the news server
11259 functionality up to the newsreader makes sense if you're the only person
11260 reading news on a machine.
11261
11262 Using Gnus as an ``offline'' newsreader is quite simple.
11263
11264 @itemize @bullet
11265 @item
11266 First, set up Gnus as you would do if you were running it on a machine
11267 that has full connection to the net.  Go ahead.  I'll still be waiting
11268 here.
11269
11270 @item
11271 Then, put the following magical incantation at the end of your
11272 @file{.gnus.el} file:
11273
11274 @lisp
11275 (gnus-agentize)
11276 @end lisp
11277 @end itemize
11278
11279 That's it.  Gnus is now an ``offline'' newsreader.
11280
11281 Of course, to use it as such, you have to learn a few new commands.
11282
11283 @menu
11284 * Agent Basics::           How it all is supposed to work.
11285 * Agent Categories::       How to tell the Gnus Agent what to download.
11286 * Agent Commands::         New commands for all the buffers.
11287 * Agent Expiry::           How to make old articles go away.
11288 * Outgoing Messages::      What happens when you post/mail something?
11289 * Agent Variables::        Customizing is fun.
11290 * Example Setup::          An example @file{.gnus.el} file for offline people.
11291 * Batching Agents::        How to fetch news from a @code{cron} job.
11292 @end menu
11293
11294
11295 @node Agent Basics
11296 @subsection Agent Basics
11297
11298 First, let's get some terminology out of the way.
11299
11300 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11301 connection to the net (and notified the Agent that this is the case).
11302 When the connection to the net is up again (and Gnus knows this), the
11303 Agent is @dfn{plugged}.
11304
11305 The @dfn{local} machine is the one you're running on, and which isn't
11306 connected to the net continuously.
11307
11308 @dfn{Downloading} means fetching things from the net to your local
11309 machine.  @dfn{Uploading} is doing the opposite.
11310
11311 Let's take a typical Gnus session using the Agent.
11312
11313 @itemize @bullet
11314
11315 @item
11316 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
11317 Agent in a disconnected state.  You can read all the news that you have
11318 already fetched while in this mode.
11319
11320 @item
11321 You then decide to see whether any new news has arrived.  You connect
11322 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11323 to make Gnus become @dfn{plugged}.
11324
11325 @item
11326 You can then read the new news immediately, or you can download the news
11327 onto your local machine.  If you want to do the latter, you press @kbd{J
11328 s} to fetch all the eligible articles in all the groups.  (To let Gnus
11329 know which articles you want to download, @pxref{Agent Categories}.)
11330
11331 @item
11332 After fetching the articles, you press @kbd{J j} to make Gnus become
11333 unplugged again, and you shut down the PPP thing (or whatever).  And
11334 then you read the news offline.
11335
11336 @item
11337 And then you go to step 2.
11338 @end itemize
11339
11340 Here are some things you should do the first time (or so) that you use
11341 the Agent.
11342
11343 @itemize @bullet
11344
11345 @item
11346 Decide which servers should be covered by the Agent.  If you have a mail
11347 backend, it would probably be nonsensical to have it covered by the
11348 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
11349 @kbd{J a} the server (or servers) that you wish to have covered by the
11350 Agent (@pxref{Server Agent Commands}).  This will typically be only the
11351 primary select method, which is listed on the bottom in the buffer.
11352
11353 @item
11354 Decide on download policy.  @xref{Agent Categories}
11355
11356 @item
11357 Uhm... that's it.
11358 @end itemize
11359
11360
11361 @node Agent Categories
11362 @subsection Agent Categories
11363
11364 One of the main reasons to integrate the news transport layer into the
11365 newsreader is to allow greater control over what articles to download.
11366 There's not much point in downloading huge amounts of articles, just to
11367 find out that you're not interested in reading any of them.  It's better
11368 to be somewhat more conservative in choosing what to download, and then
11369 mark the articles for downloading manually if it should turn out that
11370 you're interested in the articles anyway.
11371
11372 The main way to control what is to be downloaded is to create a
11373 @dfn{category} and then assign some (or all) groups to this category.
11374 Gnus has its own buffer for creating and managing categories.
11375
11376 @menu
11377 * Category Syntax::       What a category looks like.
11378 * The Category Buffer::   A buffer for maintaining categories.
11379 * Category Variables::    Customize'r'Us.
11380 @end menu
11381
11382
11383 @node Category Syntax
11384 @subsubsection Category Syntax
11385
11386 A category consists of two things.
11387
11388 @enumerate
11389 @item
11390 A predicate which (generally) gives a rough outline of which articles
11391 are eligible for downloading; and
11392
11393 @item
11394 a score rule which (generally) gives you a finer granularity when
11395 deciding what articles to download.  (Note that this @dfn{download
11396 score} is wholly unrelated to normal scores.)
11397 @end enumerate
11398
11399 A predicate consists of predicates with logical operators sprinkled in
11400 between.
11401
11402 Perhaps some examples are in order.
11403
11404 Here's a simple predicate.  (It's the default predicate, in fact, used
11405 for all groups that don't belong to any other category.)
11406
11407 @lisp
11408 short
11409 @end lisp
11410
11411 Quite simple, eh?  This predicate is true if and only if the article is
11412 short (for some value of ``short'').
11413
11414 Here's a more complex predicate:
11415
11416 @lisp
11417 (or high
11418     (and
11419      (not low)
11420      (not long)))
11421 @end lisp
11422
11423 This means that an article should be downloaded if it has a high score,
11424 or if the score is not low and the article is not long.  You get the
11425 drift.
11426
11427 The available logical operators are @code{or}, @code{and} and
11428 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
11429 @samp{|}, @code{&} and @code{!} instead.)
11430
11431 The following predicates are pre-defined, but if none of these fit what
11432 you want to do, you can write your own.
11433
11434 @table @code
11435 @item short
11436 True iff the article is shorter than @code{gnus-agent-short-article}
11437 lines; default 100.
11438
11439 @item long
11440 True iff the article is longer than @code{gnus-agent-long-article}
11441 lines; default 200.
11442
11443 @item low
11444 True iff the article has a download score less than
11445 @code{gnus-agent-low-score}; default 0.
11446
11447 @item high
11448 True iff the article has a download score greater than
11449 @code{gnus-agent-high-score}; default 0.
11450
11451 @item spam
11452 True iff the Gnus Agent guesses that the article is spam.  The
11453 heuristics may change over time, but at present it just computes a
11454 checksum and sees whether articles match.
11455
11456 @item true
11457 Always true.
11458
11459 @item false
11460 Always false.
11461 @end table
11462
11463 If you want to create your own predicate function, here's what you have
11464 to know:  The functions are called with no parameters, but the
11465 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11466 useful values.
11467
11468 Now, the syntax of the download score is the same as the syntax of
11469 normal score files, except that all elements that require actually
11470 seeing the article itself are verboten.  This means that only the
11471 following headers can be scored on: @code{From}, @code{Subject},
11472 @code{Date}, @code{Xref}, @code{Lines}, @code{Chars}, @code{Message-ID},
11473 and @code{References}.
11474
11475
11476 @node The Category Buffer
11477 @subsubsection The Category Buffer
11478
11479 You'd normally do all category maintenance from the category buffer.
11480 When you enter it for the first time (with the @kbd{J c} command from
11481 the group buffer), you'll only see the @code{default} category.
11482
11483 The following commands are available in this buffer:
11484
11485 @table @kbd
11486 @item q
11487 @kindex q (Category)
11488 @findex gnus-category-exit
11489 Return to the group buffer (@code{gnus-category-exit}).
11490
11491 @item k
11492 @kindex k (Category)
11493 @findex gnus-category-kill
11494 Kill the current category (@code{gnus-category-kill}).
11495
11496 @item c
11497 @kindex c (Category)
11498 @findex gnus-category-copy
11499 Copy the current category (@code{gnus-category-copy}).
11500
11501 @item a
11502 @kindex a (Category)
11503 @findex gnus-category-add
11504 Add a new category (@code{gnus-category-add}).
11505
11506 @item p
11507 @kindex p (Category)
11508 @findex gnus-category-edit-predicate
11509 Edit the predicate of the current category
11510 (@code{gnus-category-edit-predicate}).
11511
11512 @item g
11513 @kindex g (Category)
11514 @findex gnus-category-edit-groups
11515 Edit the list of groups belonging to the current category
11516 (@code{gnus-category-edit-groups}).
11517
11518 @item s
11519 @kindex s (Category)
11520 @findex gnus-category-edit-score
11521 Edit the download score rule of the current category
11522 (@code{gnus-category-edit-score}).
11523
11524 @item l
11525 @kindex l (Category)
11526 @findex gnus-category-list
11527 List all the categories (@code{gnus-category-list}).
11528 @end table
11529
11530
11531 @node Category Variables
11532 @subsubsection Category Variables
11533
11534 @table @code
11535 @item gnus-category-mode-hook
11536 @vindex gnus-category-mode-hook
11537 Hook run in category buffers.
11538
11539 @item gnus-category-line-format
11540 @vindex gnus-category-line-format
11541 Format of the lines in the category buffer (@pxref{Formatting
11542 Variables}).  Legal elements are:
11543
11544 @table @samp
11545 @item c
11546 The name of the category.
11547
11548 @item g
11549 The number of groups in the category.
11550 @end table
11551
11552 @item gnus-category-mode-line-format
11553 @vindex gnus-category-mode-line-format
11554 Format of the category mode line (@pxref{Mode Line Formatting}).
11555
11556 @item gnus-agent-short-article
11557 @vindex gnus-agent-short-article
11558 Articles that have fewer lines than this are short.  Default 100.
11559
11560 @item gnus-agent-long-article
11561 @vindex gnus-agent-long-article
11562 Articles that have more lines than this are long.  Default 200.
11563
11564 @item gnus-agent-low-score
11565 @vindex gnus-agent-low-score
11566 Articles that have a score lower than this have a low score.  Default
11567 0.
11568
11569 @item gnus-agent-high-score
11570 @vindex gnus-agent-high-score
11571 Articles that have a score higher than this have a high score.  Default
11572 0.
11573
11574 @end table
11575
11576
11577 @node Agent Commands
11578 @subsection Agent Commands
11579
11580 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
11581 (@code{gnus-agent-toggle-plugged} command works in all modes, and
11582 toggles the plugged/unplugged state of the Gnus Agent.
11583
11584
11585 @menu
11586 * Group Agent Commands::
11587 * Summary Agent Commands::
11588 * Server Agent Commands::
11589 @end menu
11590
11591 You can run a complete batch fetch from the command line with the
11592 following incantation:
11593
11594 @cindex gnus-agent-batch-fetch
11595 @example
11596 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
11597 @end example
11598
11599
11600
11601 @node Group Agent Commands
11602 @subsubsection Group Agent Commands
11603
11604 @table @kbd
11605 @item J u
11606 @kindex J u (Agent Group)
11607 @findex gnus-agent-fetch-groups
11608 Fetch all eligible articles in the current group
11609 (@code{gnus-agent-fetch-groups}).
11610
11611 @item J c
11612 @kindex J c (Agent Group)
11613 @findex gnus-enter-category-buffer
11614 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
11615
11616 @item J s
11617 @kindex J s (Agent Group)
11618 @findex gnus-agent-fetch-session
11619 Fetch all eligible articles in all groups
11620 (@code{gnus-agent-fetch-session}).
11621
11622 @item J S
11623 @kindex J S (Agent Group)
11624 @findex gnus-group-send-drafts
11625 Send all sendable messages in the draft group
11626 (@code{gnus-agent-fetch-session}).  @xref{Drafts}
11627
11628 @item J a
11629 @kindex J a (Agent Group)
11630 @findex gnus-agent-add-group
11631 Add the current group to an Agent category
11632 (@code{gnus-agent-add-group}).
11633
11634 @end table
11635
11636
11637 @node Summary Agent Commands
11638 @subsubsection Summary Agent Commands
11639
11640 @table @kbd
11641 @item J #
11642 @kindex J # (Agent Summary)
11643 @findex gnus-agent-mark-article
11644 Mark the article for downloading (@code{gnus-agent-mark-article}).
11645
11646 @item J M-#
11647 @kindex J M-# (Agent Summary)
11648 @findex gnus-agent-unmark-article
11649 Remove the downloading mark from the article
11650 (@code{gnus-agent-unmark-article}).
11651
11652 @item @@
11653 @kindex @@ (Agent Summary)
11654 @findex gnus-agent-toggle-mark
11655 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
11656
11657 @item J c
11658 @kindex J c (Agent Summary)
11659 @findex gnus-agent-catchup
11660 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
11661
11662 @end table
11663
11664
11665 @node Server Agent Commands
11666 @subsubsection Server Agent Commands
11667
11668 @table @kbd
11669 @item J a
11670 @kindex J a (Agent Server)
11671 @findex gnus-agent-add-server
11672 Add the current server to the list of servers covered by the Gnus Agent
11673 (@code{gnus-agent-add-server}).
11674
11675 @item J r
11676 @kindex J r (Agent Server)
11677 @findex gnus-agent-remove-server
11678 Remove the current server from the list of servers covered by the Gnus
11679 Agent (@code{gnus-agent-remove-server}).
11680
11681 @end table
11682
11683
11684 @node Agent Expiry
11685 @subsection Agent Expiry
11686
11687 @vindex gnus-agent-expiry-days
11688 @findex gnus-agent-expiry
11689 @kindex M-x gnus-agent-expiry
11690 @cindex Agent expiry
11691 @cindex Gnus Agent expiry
11692 @cindex expiry
11693
11694 @code{nnagent} doesn't handle expiry.  Instead, there's a special
11695 @code{gnus-agent-expiry} command that will expire all read articles that
11696 are older than @code{gnus-agent-expiry-days} days.  It can be run
11697 whenever you feel that you're running out of space.  It's not
11698 particularly fast or efficient, and it's not a particularly good idea to
11699 interrupt it (with @kbd{C-g} or anything else) once you've started it.
11700
11701 @vindex gnus-agent-expire-all
11702 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
11703 expire all articles---unread, read, ticked and dormant.  If @code{nil}
11704 (which is the default), only read articles are eligible for expiry, and
11705 unread, ticked and dormant articles will be kept indefinitely.
11706
11707
11708 @node Outgoing Messages
11709 @subsection Outgoing Messages
11710
11711 When Gnus is unplugged, all outgoing messages (both mail and news) are
11712 stored in the draft groups (@pxref{Drafts}).  You can view them there
11713 after posting, and edit them at will.
11714
11715 When Gnus is plugged again, you can send the messages either from the
11716 draft group with the special commands available there, or you can use
11717 the @kbd{J S} command in the group buffer to send all the sendable
11718 messages in the draft group.
11719
11720
11721
11722 @node Agent Variables
11723 @subsection Agent Variables
11724
11725 @table @code
11726 @item gnus-agent-directory
11727 @vindex gnus-agent-directory
11728 Where the Gnus Agent will store its files.  The default is
11729 @file{~/News/agent/}.
11730
11731 @item gnus-agent-handle-level
11732 @vindex gnus-agent-handle-level
11733 Groups on levels (@pxref{Group Levels}) higher than this variable will
11734 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
11735 which means that only subscribed group will be considered by the Agent
11736 by default.
11737
11738 @item gnus-agent-plugged-hook
11739 @vindex gnus-agent-plugged-hook
11740 Hook run when connecting to the network.
11741
11742 @item gnus-agent-unplugged-hook
11743 @vindex gnus-agent-unplugged-hook
11744 Hook run when disconnecting from the network.
11745
11746 @end table
11747
11748
11749 @node Example Setup
11750 @subsection Example Setup
11751
11752 If you don't want to read this manual, and you have a fairly standard
11753 setup, you may be able to use something like the following as your
11754 @file{.gnus.el} file to get started.
11755
11756 @lisp
11757 ;;; Define how Gnus is to fetch news.  We do this over NNTP
11758 ;;; from your ISP's server.
11759 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
11760
11761 ;;; Define how Gnus is to read your mail.  We read mail from
11762 ;;; your ISP's POP server.
11763 (setenv "MAILHOST" "pop.your-isp.com")
11764 (setq nnmail-spool-file "po:username")
11765
11766 ;;; Say how Gnus is to store the mail.  We use nnml groups.
11767 (setq gnus-secondary-select-methods '((nnml "")))
11768
11769 ;;; Make Gnus into an offline newsreader.
11770 (gnus-agentize)
11771 @end lisp
11772
11773 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
11774 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
11775 gnus}.
11776
11777 If this is the first time you've run Gnus, you will be subscribed
11778 automatically to a few default newsgroups.  You'll probably want to
11779 subscribe to more groups, and to do that, you have to query the
11780 @sc{nntp} server for a complete list of groups with the @kbd{A A}
11781 command.  This usually takes quite a while, but you only have to do it
11782 once.
11783
11784 After reading and parsing a while, you'll be presented with a list of
11785 groups.  Subscribe to the ones you want to read with the @kbd{u}
11786 command.  @kbd{l} to make all the killed groups disappear after you've
11787 subscribe to all the groups you want to read.  (@kbd{A k} will bring
11788 back all the killed groups.)
11789
11790 You can now read the groups at once, or you can download the articles
11791 with the @kbd{J s} command.  And then read the rest of this manual to
11792 find out which of the other gazillion things you want to customize.
11793
11794
11795 @node Batching Agents
11796 @subsection Batching Agents
11797
11798 Having the Gnus Agent fetch articles (and post whatever messages you've
11799 written) is quite easy once you've gotten things set up properly.  The
11800 following shell script will do everything that is necessary:
11801
11802 @example
11803 #!/bin/sh
11804 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
11805 @end example
11806
11807
11808
11809 @node Scoring
11810 @chapter Scoring
11811 @cindex scoring
11812
11813 Other people use @dfn{kill files}, but we here at Gnus Towers like
11814 scoring better than killing, so we'd rather switch than fight.  They do
11815 something completely different as well, so sit up straight and pay
11816 attention!
11817
11818 @vindex gnus-summary-mark-below
11819 All articles have a default score (@code{gnus-summary-default-score}),
11820 which is 0 by default.  This score may be raised or lowered either
11821 interactively or by score files.  Articles that have a score lower than
11822 @code{gnus-summary-mark-below} are marked as read.
11823
11824 Gnus will read any @dfn{score files} that apply to the current group
11825 before generating the summary buffer.
11826
11827 There are several commands in the summary buffer that insert score
11828 entries based on the current article.  You can, for instance, ask Gnus to
11829 lower or increase the score of all articles with a certain subject.
11830
11831 There are two sorts of scoring entries: Permanent and temporary.
11832 Temporary score entries are self-expiring entries.  Any entries that are
11833 temporary and have not been used for, say, a week, will be removed
11834 silently to help keep the sizes of the score files down.
11835
11836 @menu
11837 * Summary Score Commands::   Adding score entries for the current group.
11838 * Group Score Commands::     General score commands.
11839 * Score Variables::          Customize your scoring.  (My, what terminology).
11840 * Score File Format::        What a score file may contain.
11841 * Score File Editing::       You can edit score files by hand as well.
11842 * Adaptive Scoring::         Big Sister Gnus knows what you read.
11843 * Home Score File::          How to say where new score entries are to go.
11844 * Followups To Yourself::    Having Gnus notice when people answer you.
11845 * Scoring Tips::             How to score effectively.
11846 * Reverse Scoring::          That problem child of old is not problem.
11847 * Global Score Files::       Earth-spanning, ear-splitting score files.
11848 * Kill Files::               They are still here, but they can be ignored.
11849 * Converting Kill Files::    Translating kill files to score files.
11850 * GroupLens::                Getting predictions on what you like to read.
11851 * Advanced Scoring::         Using logical expressions to build score rules.
11852 * Score Decays::             It can be useful to let scores wither away.
11853 @end menu
11854
11855
11856 @node Summary Score Commands
11857 @section Summary Score Commands
11858 @cindex score commands
11859
11860 The score commands that alter score entries do not actually modify real
11861 score files.  That would be too inefficient.  Gnus maintains a cache of
11862 previously loaded score files, one of which is considered the
11863 @dfn{current score file alist}.  The score commands simply insert
11864 entries into this list, and upon group exit, this list is saved.
11865
11866 The current score file is by default the group's local score file, even
11867 if no such score file actually exists.  To insert score commands into
11868 some other score file (e.g. @file{all.SCORE}), you must first make this
11869 score file the current one.
11870
11871 General score commands that don't actually change the score file:
11872
11873 @table @kbd
11874
11875 @item V s
11876 @kindex V s (Summary)
11877 @findex gnus-summary-set-score
11878 Set the score of the current article (@code{gnus-summary-set-score}).
11879
11880 @item V S
11881 @kindex V S (Summary)
11882 @findex gnus-summary-current-score
11883 Display the score of the current article
11884 (@code{gnus-summary-current-score}).
11885
11886 @item V t
11887 @kindex V t (Summary)
11888 @findex gnus-score-find-trace
11889 Display all score rules that have been used on the current article
11890 (@code{gnus-score-find-trace}).
11891
11892 @item V R
11893 @kindex V R (Summary)
11894 @findex gnus-summary-rescore
11895 Run the current summary through the scoring process
11896 (@code{gnus-summary-rescore}).  This might be useful if you're playing
11897 around with your score files behind Gnus' back and want to see the
11898 effect you're having.
11899
11900 @item V c
11901 @kindex V c (Summary)
11902 @findex gnus-score-change-score-file
11903 Make a different score file the current
11904 (@code{gnus-score-change-score-file}).
11905
11906 @item V e
11907 @kindex V e (Summary)
11908 @findex gnus-score-edit-current-scores
11909 Edit the current score file (@code{gnus-score-edit-current-scores}).
11910 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
11911 File Editing}).
11912
11913 @item V f
11914 @kindex V f (Summary)
11915 @findex gnus-score-edit-file
11916 Edit a score file and make this score file the current one
11917 (@code{gnus-score-edit-file}).
11918
11919 @item V F
11920 @kindex V F (Summary)
11921 @findex gnus-score-flush-cache
11922 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
11923 after editing score files.
11924
11925 @item V C
11926 @kindex V C (Summary)
11927 @findex gnus-score-customize
11928 Customize a score file in a visually pleasing manner
11929 (@code{gnus-score-customize}).
11930
11931 @end table
11932
11933 The rest of these commands modify the local score file.
11934
11935 @table @kbd
11936
11937 @item V m
11938 @kindex V m (Summary)
11939 @findex gnus-score-set-mark-below
11940 Prompt for a score, and mark all articles with a score below this as
11941 read (@code{gnus-score-set-mark-below}).
11942
11943 @item V x
11944 @kindex V x (Summary)
11945 @findex gnus-score-set-expunge-below
11946 Prompt for a score, and add a score rule to the current score file to
11947 expunge all articles below this score
11948 (@code{gnus-score-set-expunge-below}).
11949 @end table
11950
11951 The keystrokes for actually making score entries follow a very regular
11952 pattern, so there's no need to list all the commands.  (Hundreds of
11953 them.)
11954
11955 @findex gnus-summary-increase-score
11956 @findex gnus-summary-lower-score
11957
11958 @enumerate
11959 @item
11960 The first key is either @kbd{I} (upper case i) for increasing the score
11961 or @kbd{L} for lowering the score.
11962 @item
11963 The second key says what header you want to score on.  The following
11964 keys are available:
11965 @table @kbd
11966
11967 @item a
11968 Score on the author name.
11969
11970 @item s
11971 Score on the subject line.
11972
11973 @item x
11974 Score on the Xref line---i.e., the cross-posting line.
11975
11976 @item t
11977 Score on thread---the References line.
11978
11979 @item d
11980 Score on the date.
11981
11982 @item l
11983 Score on the number of lines.
11984
11985 @item i
11986 Score on the Message-ID.
11987
11988 @item f
11989 Score on followups.
11990
11991 @item b
11992 Score on the body.
11993
11994 @item h
11995 Score on the head.
11996 @end table
11997
11998 @item
11999 The third key is the match type.  Which match types are valid depends on
12000 what headers you are scoring on.
12001
12002 @table @code
12003
12004 @item strings
12005
12006 @table @kbd
12007
12008 @item e
12009 Exact matching.
12010
12011 @item s
12012 Substring matching.
12013
12014 @item f
12015 Fuzzy matching (@pxref{Fuzzy Matching}).
12016
12017 @item r
12018 Regexp matching
12019 @end table
12020
12021 @item date
12022 @table @kbd
12023
12024 @item b
12025 Before date.
12026
12027 @item a
12028 After date.
12029
12030 @item n
12031 This date.
12032 @end table
12033
12034 @item number
12035 @table @kbd
12036
12037 @item <
12038 Less than number.
12039
12040 @item =
12041 Equal to number.
12042
12043 @item >
12044 Greater than number.
12045 @end table
12046 @end table
12047
12048 @item
12049 The fourth and final key says whether this is a temporary (i.e., expiring)
12050 score entry, or a permanent (i.e., non-expiring) score entry, or whether
12051 it is to be done immediately, without adding to the score file.
12052 @table @kbd
12053
12054 @item t
12055 Temporary score entry.
12056
12057 @item p
12058 Permanent score entry.
12059
12060 @item i
12061 Immediately scoring.
12062 @end table
12063
12064 @end enumerate
12065
12066 So, let's say you want to increase the score on the current author with
12067 exact matching permanently: @kbd{I a e p}.  If you want to lower the
12068 score based on the subject line, using substring matching, and make a
12069 temporary score entry: @kbd{L s s t}.  Pretty easy.
12070
12071 To make things a bit more complicated, there are shortcuts.  If you use
12072 a capital letter on either the second or third keys, Gnus will use
12073 defaults for the remaining one or two keystrokes.  The defaults are
12074 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
12075 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
12076
12077 These functions take both the numerical prefix and the symbolic prefix
12078 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
12079 (or increase) the score of the article.  A symbolic prefix of @code{a}
12080 says to use the @file{all.SCORE} file for the command instead of the
12081 current score file.
12082
12083 @vindex gnus-score-mimic-keymap
12084 The @code{gnus-score-mimic-keymap} says whether these commands will
12085 pretend they are keymaps or not.
12086
12087
12088 @node Group Score Commands
12089 @section Group Score Commands
12090 @cindex group score commands
12091
12092 There aren't many of these as yet, I'm afraid.
12093
12094 @table @kbd
12095
12096 @item W f
12097 @kindex W f (Group)
12098 @findex gnus-score-flush-cache
12099 Gnus maintains a cache of score alists to avoid having to reload them
12100 all the time.  This command will flush the cache
12101 (@code{gnus-score-flush-cache}).
12102
12103 @end table
12104
12105 You can do scoring from the command line by saying something like:
12106
12107 @findex gnus-batch-score
12108 @cindex batch scoring
12109 @example
12110 $ emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score
12111 @end example
12112
12113
12114 @node Score Variables
12115 @section Score Variables
12116 @cindex score variables
12117
12118 @table @code
12119
12120 @item gnus-use-scoring
12121 @vindex gnus-use-scoring
12122 If @code{nil}, Gnus will not check for score files, and will not, in
12123 general, do any score-related work.  This is @code{t} by default.
12124
12125 @item gnus-kill-killed
12126 @vindex gnus-kill-killed
12127 If this variable is @code{nil}, Gnus will never apply score files to
12128 articles that have already been through the kill process.  While this
12129 may save you lots of time, it also means that if you apply a kill file
12130 to a group, and then change the kill file and want to run it over you
12131 group again to kill more articles, it won't work.  You have to set this
12132 variable to @code{t} to do that.  (It is @code{t} by default.)
12133
12134 @item gnus-kill-files-directory
12135 @vindex gnus-kill-files-directory
12136 All kill and score files will be stored in this directory, which is
12137 initialized from the @code{SAVEDIR} environment variable by default.
12138 This is @file{~/News/} by default.
12139
12140 @item gnus-score-file-suffix
12141 @vindex gnus-score-file-suffix
12142 Suffix to add to the group name to arrive at the score file name
12143 (@samp{SCORE} by default.)
12144
12145 @item gnus-score-uncacheable-files
12146 @vindex gnus-score-uncacheable-files
12147 @cindex score cache
12148 All score files are normally cached to avoid excessive re-loading of
12149 score files.  However, if this might make you Emacs grow big and
12150 bloated, so this regexp can be used to weed out score files unlikely to be needed again.  It would be a bad idea to deny caching of
12151 @file{all.SCORE}, while it might be a good idea to not cache
12152 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
12153 variable is @samp{ADAPT$} by default, so no adaptive score files will
12154 be cached.
12155
12156 @item gnus-save-score
12157 @vindex gnus-save-score
12158 If you have really complicated score files, and do lots of batch
12159 scoring, then you might set this variable to @code{t}.  This will make
12160 Gnus save the scores into the @file{.newsrc.eld} file.
12161
12162 @item gnus-score-interactive-default-score
12163 @vindex gnus-score-interactive-default-score
12164 Score used by all the interactive raise/lower commands to raise/lower
12165 score with.  Default is 1000, which may seem excessive, but this is to
12166 ensure that the adaptive scoring scheme gets enough room to play with.
12167 We don't want the small changes from the adaptive scoring to overwrite
12168 manually entered data.
12169
12170 @item gnus-summary-default-score
12171 @vindex gnus-summary-default-score
12172 Default score of an article, which is 0 by default.
12173
12174 @item gnus-summary-expunge-below
12175 @vindex gnus-summary-expunge-below
12176 Don't display the summary lines of articles that have scores lower than
12177 this variable.  This is @code{nil} by default, which means that no
12178 articles will be hidden.  This variable is local to the summary buffers,
12179 and has to be set from @code{gnus-summary-mode-hook}.
12180
12181 @item gnus-score-over-mark
12182 @vindex gnus-score-over-mark
12183 Mark (in the third column) used for articles with a score over the
12184 default.  Default is @samp{+}.
12185
12186 @item gnus-score-below-mark
12187 @vindex gnus-score-below-mark
12188 Mark (in the third column) used for articles with a score below the
12189 default.  Default is @samp{-}.
12190
12191 @item gnus-score-find-score-files-function
12192 @vindex gnus-score-find-score-files-function
12193 Function used to find score files for the current group.  This function
12194 is called with the name of the group as the argument.
12195
12196 Predefined functions available are:
12197 @table @code
12198
12199 @item gnus-score-find-single
12200 @findex gnus-score-find-single
12201 Only apply the group's own score file.
12202
12203 @item gnus-score-find-bnews
12204 @findex gnus-score-find-bnews
12205 Apply all score files that match, using bnews syntax.  This is the
12206 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
12207 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12208 @file{gnu.all.SCORE} would all apply.  In short, the instances of
12209 @samp{all} in the score file names are translated into @samp{.*}, and
12210 then a regexp match is done.
12211
12212 This means that if you have some score entries that you want to apply to
12213 all groups, then you put those entries in the @file{all.SCORE} file.
12214
12215 The score files are applied in a semi-random order, although Gnus will
12216 try to apply the more general score files before the more specific score
12217 files.  It does this by looking at the number of elements in the score
12218 file names---discarding the @samp{all} elements.
12219
12220 @item gnus-score-find-hierarchical
12221 @findex gnus-score-find-hierarchical
12222 Apply all score files from all the parent groups.  This means that you
12223 can't have score files like @file{all.SCORE}, but you can have
12224 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12225
12226 @end table
12227 This variable can also be a list of functions.  In that case, all these
12228 functions will be called, and all the returned lists of score files will
12229 be applied.  These functions can also return lists of score alists
12230 directly.  In that case, the functions that return these non-file score
12231 alists should probably be placed before the ``real'' score file
12232 functions, to ensure that the last score file returned is the local
12233 score file.  Phu.
12234
12235 @item gnus-score-expiry-days
12236 @vindex gnus-score-expiry-days
12237 This variable says how many days should pass before an unused score file
12238 entry is expired.  If this variable is @code{nil}, no score file entries
12239 are expired.  It's 7 by default.
12240
12241 @item gnus-update-score-entry-dates
12242 @vindex gnus-update-score-entry-dates
12243 If this variable is non-@code{nil}, matching score entries will have
12244 their dates updated.  (This is how Gnus controls expiry---all
12245 non-matching entries will become too old while matching entries will
12246 stay fresh and young.)  However, if you set this variable to @code{nil},
12247 even matching entries will grow old and will have to face that oh-so
12248 grim reaper.
12249
12250 @item gnus-score-after-write-file-function
12251 @vindex gnus-score-after-write-file-function
12252 Function called with the name of the score file just written.
12253
12254 @item gnus-score-thread-simplify
12255 @vindex gnus-score-thread-simplify
12256 If this variable is non-@code{nil}, article subjects will be simplified
12257 for subject scoring purposes in the same manner as with
12258 threading---according to the current value of
12259 gnus-simplify-subject-functions.  If the scoring entry uses
12260 @code{substring} or @code{exact} matching, the match will also be
12261 simplified in this manner.
12262
12263 @end table
12264
12265
12266 @node Score File Format
12267 @section Score File Format
12268 @cindex score file format
12269
12270 A score file is an @code{emacs-lisp} file that normally contains just a
12271 single form.  Casual users are not expected to edit these files;
12272 everything can be changed from the summary buffer.
12273
12274 Anyway, if you'd like to dig into it yourself, here's an example:
12275
12276 @lisp
12277 (("from"
12278   ("Lars Ingebrigtsen" -10000)
12279   ("Per Abrahamsen")
12280   ("larsi\\|lmi" -50000 nil R))
12281  ("subject"
12282   ("Ding is Badd" nil 728373))
12283  ("xref"
12284   ("alt.politics" -1000 728372 s))
12285  ("lines"
12286   (2 -100 nil <))
12287  (mark 0)
12288  (expunge -1000)
12289  (mark-and-expunge -10)
12290  (read-only nil)
12291  (orphan -10)
12292  (adapt t)
12293  (files "/hom/larsi/News/gnu.SCORE")
12294  (exclude-files "all.SCORE")
12295  (local (gnus-newsgroup-auto-expire t)
12296         (gnus-summary-make-false-root empty))
12297  (eval (ding)))
12298 @end lisp
12299
12300 This example demonstrates most score file elements.  For a different
12301 approach, see @pxref{Advanced Scoring}.
12302
12303 Even though this looks much like lisp code, nothing here is actually
12304 @code{eval}ed.  The lisp reader is used to read this form, though, so it
12305 has to be valid syntactically, if not semantically.
12306
12307 Six keys are supported by this alist:
12308
12309 @table @code
12310
12311 @item STRING
12312 If the key is a string, it is the name of the header to perform the
12313 match on.  Scoring can only be performed on these eight headers:
12314 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
12315 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
12316 these headers, there are three strings to tell Gnus to fetch the entire
12317 article and do the match on larger parts of the article: @code{Body}
12318 will perform the match on the body of the article, @code{Head} will
12319 perform the match on the head of the article, and @code{All} will
12320 perform the match on the entire article.  Note that using any of these
12321 last three keys will slow down group entry @emph{considerably}.  The
12322 final ``header'' you can score on is @code{Followup}.  These score
12323 entries will result in new score entries being added for all follow-ups
12324 to articles that matches these score entries.
12325
12326 Following this key is a arbitrary number of score entries, where each
12327 score entry has one to four elements.
12328 @enumerate
12329
12330 @item
12331 The first element is the @dfn{match element}.  On most headers this will
12332 be a string, but on the Lines and Chars headers, this must be an
12333 integer.
12334
12335 @item
12336 If the second element is present, it should be a number---the @dfn{score
12337 element}.  This number should be an integer in the neginf to posinf
12338 interval.  This number is added to the score of the article if the match
12339 is successful.  If this element is not present, the
12340 @code{gnus-score-interactive-default-score} number will be used
12341 instead.  This is 1000 by default.
12342
12343 @item
12344 If the third element is present, it should be a number---the @dfn{date
12345 element}.  This date says when the last time this score entry matched,
12346 which provides a mechanism for expiring the score entries.  It this
12347 element is not present, the score entry is permanent.  The date is
12348 represented by the number of days since December 31, 1 BCE.
12349
12350 @item
12351 If the fourth element is present, it should be a symbol---the @dfn{type
12352 element}.  This element specifies what function should be used to see
12353 whether this score entry matches the article.  What match types that can
12354 be used depends on what header you wish to perform the match on.
12355 @table @dfn
12356
12357 @item From, Subject, References, Xref, Message-ID
12358 For most header types, there are the @code{r} and @code{R} (regexp), as
12359 well as @code{s} and @code{S} (substring) types, and @code{e} and
12360 @code{E} (exact match), and @code{w} (word match) types.  If this
12361 element is not present, Gnus will assume that substring matching should
12362 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
12363 that the matches will be done in a case-sensitive manner.  All these
12364 one-letter types are really just abbreviations for the @code{regexp},
12365 @code{string}, @code{exact}, and @code{word} types, which you can use
12366 instead, if you feel like.
12367
12368 @item Lines, Chars
12369 These two headers use different match types: @code{<}, @code{>},
12370 @code{=}, @code{>=} and @code{<=}.
12371
12372 These predicates are true if
12373
12374 @example
12375 (PREDICATE HEADER MATCH)
12376 @end example
12377
12378 evaluates to non-@code{nil}.  For instance, the advanced match
12379 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
12380 following form:
12381
12382 @lisp
12383 (< header-value 4)
12384 @end lisp
12385
12386 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
12387 the match, we get the score added if the article has less than 4 lines.
12388 (It's easy to get confused and think it's the other way around.  But
12389 it's not.  I think.)
12390
12391 When matching on @code{Lines}, be careful because some backends (like
12392 @code{nndir}) do not generate @code{Lines} header, so every article ends
12393 up being marked as having 0 lines.  This can lead to strange results if
12394 you happen to lower score of the articles with few lines.
12395
12396 @item Date
12397 For the Date header we have three kinda silly match types:
12398 @code{before}, @code{at} and @code{after}.  I can't really imagine this
12399 ever being useful, but, like, it would feel kinda silly not to provide
12400 this function.  Just in case.  You never know.  Better safe than sorry.
12401 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
12402 sex on a first date.  (I have been told that at least one person, and I
12403 quote, ``found this function indispensable'', however.)
12404
12405 @cindex ISO8601
12406 @cindex date
12407 A more useful match type is @code{regexp}.  With it, you can match the
12408 date string using a regular expression.  The date is normalized to
12409 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
12410 you want to match all articles that have been posted on April 1st in
12411 every year, you could use @samp{....0401.........} as a match string,
12412 for instance.  (Note that the date is kept in its original time zone, so
12413 this will match articles that were posted when it was April 1st where
12414 the article was posted from.  Time zones are such wholesome fun for the
12415 whole family, eh?)
12416
12417 @item Head, Body, All
12418 These three match keys use the same match types as the @code{From} (etc)
12419 header uses.
12420
12421 @item Followup
12422 This match key is somewhat special, in that it will match the
12423 @code{From} header, and affect the score of not only the matching
12424 articles, but also all followups to the matching articles.  This allows
12425 you e.g. increase the score of followups to your own articles, or
12426 decrease the score of followups to the articles of some known
12427 trouble-maker.  Uses the same match types as the @code{From} header
12428 uses.  (Using this match key will lead to creation of @file{ADAPT}
12429 files.)
12430
12431 @item Thread
12432 This match key works along the same lines as the @code{Followup} match
12433 key.  If you say that you want to score on a (sub-)thread started by an article with a @code{Message-ID} @var{X}, then you add a
12434 @samp{thread} match.  This will add a new @samp{thread} match for each
12435 article that has @var{X} in its @code{References} header.  (These new
12436 @samp{thread} matches will use the @code{Message-ID}s of these matching
12437 articles.)  This will ensure that you can raise/lower the score of an
12438 entire thread, even though some articles in the thread may not have
12439 complete @code{References} headers.  Note that using this may lead to
12440 undeterministic scores of the articles in the thread.  (Using this match
12441 key will lead to creation of @file{ADAPT} files.)
12442 @end table
12443 @end enumerate
12444
12445 @cindex Score File Atoms
12446 @item mark
12447 The value of this entry should be a number.  Any articles with a score
12448 lower than this number will be marked as read.
12449
12450 @item expunge
12451 The value of this entry should be a number.  Any articles with a score
12452 lower than this number will be removed from the summary buffer.
12453
12454 @item mark-and-expunge
12455 The value of this entry should be a number.  Any articles with a score
12456 lower than this number will be marked as read and removed from the
12457 summary buffer.
12458
12459 @item thread-mark-and-expunge
12460 The value of this entry should be a number.  All articles that belong to
12461 a thread that has a total score below this number will be marked as read
12462 and removed from the summary buffer.  @code{gnus-thread-score-function}
12463 says how to compute the total score for a thread.
12464
12465 @item files
12466 The value of this entry should be any number of file names.  These files
12467 are assumed to be score files as well, and will be loaded the same way
12468 this one was.
12469
12470 @item exclude-files
12471 The clue of this entry should be any number of files.  These files will
12472 not be loaded, even though they would normally be so, for some reason or
12473 other.
12474
12475 @item eval
12476 The value of this entry will be @code{eval}el.  This element will be
12477 ignored when handling global score files.
12478
12479 @item read-only
12480 Read-only score files will not be updated or saved.  Global score files
12481 should feature this atom (@pxref{Global Score Files}).  (Note:
12482 @dfn{Global} here really means @dfn{global}; not your personal
12483 apply-to-all-groups score files.)
12484
12485 @item orphan
12486 The value of this entry should be a number.  Articles that do not have
12487 parents will get this number added to their scores.  Imagine you follow
12488 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
12489 will only follow a few of the threads, also want to see any new threads.
12490
12491 You can do this with the following two score file entries:
12492
12493 @example
12494         (orphan -500)
12495         (mark-and-expunge -100)
12496 @end example
12497
12498 When you enter the group the first time, you will only see the new
12499 threads.  You then raise the score of the threads that you find
12500 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
12501 rest.  Next time you enter the group, you will see new articles in the
12502 interesting threads, plus any new threads.
12503
12504 I.e.---the orphan score atom is for high-volume groups where there
12505 exist a few interesting threads which can't be found automatically by
12506 ordinary scoring rules.
12507
12508 @item adapt
12509 This entry controls the adaptive scoring.  If it is @code{t}, the
12510 default adaptive scoring rules will be used.  If it is @code{ignore}, no
12511 adaptive scoring will be performed on this group.  If it is a list, this
12512 list will be used as the adaptive scoring rules.  If it isn't present,
12513 or is something other than @code{t} or @code{ignore}, the default
12514 adaptive scoring rules will be used.  If you want to use adaptive
12515 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
12516 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
12517 not want adaptive scoring.  If you only want adaptive scoring in a few
12518 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
12519 insert @code{(adapt t)} in the score files of the groups where you want
12520 it.
12521
12522 @item adapt-file
12523 All adaptive score entries will go to the file named by this entry.  It
12524 will also be applied when entering the group.  This atom might be handy
12525 if you want to adapt on several groups at once, using the same adaptive
12526 file for a number of groups.
12527
12528 @item local
12529 @cindex local variables
12530 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
12531 Each @var{var} will be made buffer-local to the current summary buffer,
12532 and set to the value specified.  This is a convenient, if somewhat
12533 strange, way of setting variables in some groups if you don't like hooks
12534 much.  Note that the @var{value} won't be evaluated.
12535 @end table
12536
12537
12538 @node Score File Editing
12539 @section Score File Editing
12540
12541 You normally enter all scoring commands from the summary buffer, but you
12542 might feel the urge to edit them by hand as well, so we've supplied you
12543 with a mode for that.
12544
12545 It's simply a slightly customized @code{emacs-lisp} mode, with these
12546 additional commands:
12547
12548 @table @kbd
12549
12550 @item C-c C-c
12551 @kindex C-c C-c (Score)
12552 @findex gnus-score-edit-done
12553 Save the changes you have made and return to the summary buffer
12554 (@code{gnus-score-edit-done}).
12555
12556 @item C-c C-d
12557 @kindex C-c C-d (Score)
12558 @findex gnus-score-edit-insert-date
12559 Insert the current date in numerical format
12560 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
12561 you were wondering.
12562
12563 @item C-c C-p
12564 @kindex C-c C-p (Score)
12565 @findex gnus-score-pretty-print
12566 The adaptive score files are saved in an unformatted fashion.  If you
12567 intend to read one of these files, you want to @dfn{pretty print} it
12568 first.  This command (@code{gnus-score-pretty-print}) does that for
12569 you.
12570
12571 @end table
12572
12573 Type @kbd{M-x gnus-score-mode} to use this mode.
12574
12575 @vindex gnus-score-mode-hook
12576 @code{gnus-score-menu-hook} is run in score mode buffers.
12577
12578 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
12579 e} to begin editing score files.
12580
12581
12582 @node Adaptive Scoring
12583 @section Adaptive Scoring
12584 @cindex adaptive scoring
12585
12586 If all this scoring is getting you down, Gnus has a way of making it all
12587 happen automatically---as if by magic.  Or rather, as if by artificial
12588 stupidity, to be precise.
12589
12590 @vindex gnus-use-adaptive-scoring
12591 When you read an article, or mark an article as read, or kill an
12592 article, you leave marks behind.  On exit from the group, Gnus can sniff
12593 these marks and add score elements depending on what marks it finds.
12594 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
12595 @code{t} or @code{(line)}.  If you want score adaptively on separate
12596 words appearing in the subjects, you should set this variable to
12597 @code{(word)}.  If you want to use both adaptive methods, set this
12598 variable to @code{(word line)}.
12599
12600 @vindex gnus-default-adaptive-score-alist
12601 To give you complete control over the scoring process, you can customize
12602 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
12603 might look something like this:
12604
12605 @lisp
12606 (defvar gnus-default-adaptive-score-alist
12607   '((gnus-unread-mark)
12608     (gnus-ticked-mark (from 4))
12609     (gnus-dormant-mark (from 5))
12610     (gnus-del-mark (from -4) (subject -1))
12611     (gnus-read-mark (from 4) (subject 2))
12612     (gnus-expirable-mark (from -1) (subject -1))
12613     (gnus-killed-mark (from -1) (subject -3))
12614     (gnus-kill-file-mark)
12615     (gnus-ancient-mark)
12616     (gnus-low-score-mark)
12617     (gnus-catchup-mark (from -1) (subject -1))))
12618 @end lisp
12619
12620 As you see, each element in this alist has a mark as a key (either a
12621 variable name or a ``real'' mark---a character).  Following this key is
12622 a arbitrary number of header/score pairs.  If there are no header/score
12623 pairs following the key, no adaptive scoring will be done on articles
12624 that have that key as the article mark.  For instance, articles with
12625 @code{gnus-unread-mark} in the example above will not get adaptive score
12626 entries.
12627
12628 Each article can have only one mark, so just a single of these rules
12629 will be applied to each article.
12630
12631 To take @code{gnus-del-mark} as an example---this alist says that all
12632 articles that have that mark (i.e., are marked with @samp{D}) will have a
12633 score entry added to lower based on the @code{From} header by -4, and
12634 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
12635
12636 If you have marked 10 articles with the same subject with
12637 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
12638 That means that that subject will get a score of ten times -1, which
12639 should be, unless I'm much mistaken, -10.
12640
12641 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
12642 the read articles will be marked with the @samp{E} mark.  This'll
12643 probably make adaptive scoring slightly impossible, so auto-expiring and
12644 adaptive scoring doesn't really mix very well.
12645
12646 The headers you can score on are @code{from}, @code{subject},
12647 @code{message-id}, @code{references}, @code{xref}, @code{lines},
12648 @code{chars} and @code{date}.  In addition, you can score on
12649 @code{followup}, which will create an adaptive score entry that matches
12650 on the @code{References} header using the @code{Message-ID} of the
12651 current article, thereby matching the following thread.
12652
12653 You can also score on @code{thread}, which will try to score all
12654 articles that appear in a thread.  @code{thread} matches uses a
12655 @code{Message-ID} to match on the @code{References} header of the
12656 article.  If the match is made, the @code{Message-ID} of the article is
12657 added to the @code{thread} rule.  (Think about it.  I'd recommend two
12658 aspirins afterwards.)
12659
12660 If you use this scheme, you should set the score file atom @code{mark}
12661 to something small---like -300, perhaps, to avoid having small random
12662 changes result in articles getting marked as read.
12663
12664 After using adaptive scoring for a week or so, Gnus should start to
12665 become properly trained and enhance the authors you like best, and kill
12666 the authors you like least, without you having to say so explicitly.
12667
12668 You can control what groups the adaptive scoring is to be performed on
12669 by using the score files (@pxref{Score File Format}).  This will also
12670 let you use different rules in different groups.
12671
12672 @vindex gnus-adaptive-file-suffix
12673 The adaptive score entries will be put into a file where the name is the
12674 group name with @code{gnus-adaptive-file-suffix} appended.  The default
12675 is @samp{ADAPT}.
12676
12677 @vindex gnus-score-exact-adapt-limit
12678 When doing adaptive scoring, substring or fuzzy matching would probably
12679 give you the best results in most cases.  However, if the header one
12680 matches is short, the possibility for false positives is great, so if
12681 the length of the match is less than
12682 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
12683 this variable is @code{nil}, exact matching will always be used to avoid
12684 this problem.
12685
12686 @vindex gnus-default-adaptive-word-score-alist
12687 As mentioned above, you can adapt either on individual words or entire
12688 headers.  If you adapt on words, the
12689 @code{gnus-default-adaptive-word-score-alist} variable says what score
12690 each instance of a word should add given a mark.
12691
12692 @lisp
12693 (setq gnus-default-adaptive-word-score-alist
12694       `((,gnus-read-mark . 30)
12695         (,gnus-catchup-mark . -10)
12696         (,gnus-killed-mark . -20)
12697         (,gnus-del-mark . -15)))
12698 @end lisp
12699
12700 This is the default value.  If you have adaption on words enabled, every
12701 word that appears in subjects of articles marked with
12702 @code{gnus-read-mark} will result in a score rule that increase the
12703 score with 30 points.
12704
12705 @vindex gnus-default-ignored-adaptive-words
12706 @vindex gnus-ignored-adaptive-words
12707 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
12708 will be ignored.  If you wish to add more words to be ignored, use the
12709 @code{gnus-ignored-adaptive-words} list instead.
12710
12711 @vindex gnus-adaptive-word-syntax-table
12712 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
12713 syntax table in effect.  It is similar to the standard syntax table, but
12714 it considers numbers to be non-word-constituent characters.
12715
12716 @vindex gnus-adaptive-word-minimum
12717 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
12718 word scoring process will never bring down the score of an article to
12719 below this number.  The default is @code{nil}.
12720
12721 After using this scheme for a while, it might be nice to write a
12722 @code{gnus-psychoanalyze-user} command to go through the rules and see
12723 what words you like and what words you don't like.  Or perhaps not.
12724
12725 Note that the adaptive word scoring thing is highly experimental and is
12726 likely to change in the future.  Initial impressions seem to indicate
12727 that it's totally useless as it stands.  Some more work (involving more
12728 rigorous statistical methods) will have to be done to make this useful.
12729
12730
12731 @node Home Score File
12732 @section Home Score File
12733
12734 The score file where new score file entries will go is called the
12735 @dfn{home score file}.  This is normally (and by default) the score file
12736 for the group itself.  For instance, the home score file for
12737 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
12738
12739 However, this may not be what you want.  It is often convenient to share
12740 a common home score file among many groups---all @samp{emacs} groups
12741 could perhaps use the same home score file.
12742
12743 @vindex gnus-home-score-file
12744 The variable that controls this is @code{gnus-home-score-file}.  It can
12745 be:
12746
12747 @enumerate
12748 @item
12749 A string.  Then this file will be used as the home score file for all
12750 groups.
12751
12752 @item
12753 A function. The result of this function will be used as the home score
12754 file.  The function will be called with the name of the group as the
12755 parameter.
12756
12757 @item
12758 A list.  The elements in this list can be:
12759
12760 @enumerate
12761 @item
12762 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
12763 the @var{file-name} will will be used as the home score file.
12764
12765 @item
12766 A function. If the function returns non-nil, the result will be used as
12767 the home score file.
12768
12769 @item
12770 A string.  Use the string as the home score file.
12771 @end enumerate
12772
12773 The list will be traversed from the beginning towards the end looking
12774 for matches.
12775
12776 @end enumerate
12777
12778 So, if you want to use just a single score file, you could say:
12779
12780 @lisp
12781 (setq gnus-home-score-file
12782       "my-total-score-file.SCORE")
12783 @end lisp
12784
12785 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
12786 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
12787
12788 @findex gnus-hierarchial-home-score-file
12789 @lisp
12790 (setq gnus-home-score-file
12791       'gnus-hierarchial-home-score-file)
12792 @end lisp
12793
12794 This is a ready-made function provided for your convenience.
12795 Other functions include
12796
12797 @table @code
12798 @item gnus-current-home-score-file
12799 @findex gnus-current-home-score-file
12800 Return the ``current'' regular score file.  This will make scoring
12801 commands add entry to the ``innermost'' matching score file.
12802
12803 @end table
12804
12805 If you want to have one score file for the @samp{emacs} groups and
12806 another for the @samp{comp} groups, while letting all other groups use
12807 their own home score files:
12808
12809 @lisp
12810 (setq gnus-home-score-file
12811       ;; All groups that match the regexp "\\.emacs"
12812       '(("\\.emacs" "emacs.SCORE")
12813         ;; All the comp groups in one score file
12814         ("^comp" "comp.SCORE")))
12815 @end lisp
12816
12817 @vindex gnus-home-adapt-file
12818 @code{gnus-home-adapt-file} works exactly the same way as
12819 @code{gnus-home-score-file}, but says what the home adaptive score file
12820 is instead.  All new adaptive file entries will go into the file
12821 specified by this variable, and the same syntax is allowed.
12822
12823 In addition to using @code{gnus-home-score-file} and
12824 @code{gnus-home-adapt-file}, you can also use group parameters
12825 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
12826 Parameters}) to achieve much the same.  Group and topic parameters take
12827 precedence over this variable.
12828
12829
12830 @node Followups To Yourself
12831 @section Followups To Yourself
12832
12833 Gnus offers two commands for picking out the @code{Message-ID} header in
12834 the current buffer.  Gnus will then add a score rule that scores using
12835 this @code{Message-ID} on the @code{References} header of other
12836 articles.  This will, in effect, increase the score of all articles that
12837 respond to the article in the current buffer.  Quite useful if you want
12838 to easily note when people answer what you've said.
12839
12840 @table @code
12841
12842 @item gnus-score-followup-article
12843 @findex gnus-score-followup-article
12844 This will add a score to articles that directly follow up your own
12845 article.
12846
12847 @item gnus-score-followup-thread
12848 @findex gnus-score-followup-thread
12849 This will add a score to all articles that appear in a thread ``below''
12850 your own article.
12851 @end table
12852
12853 @vindex message-sent-hook
12854 These two functions are both primarily meant to be used in hooks like
12855 @code{message-sent-hook}.
12856
12857 If you look closely at your own @code{Message-ID}, you'll notice that
12858 the first two or three characters are always the same.  Here's two of
12859 mine:
12860
12861 @example
12862 <x6u3u47icf.fsf@@eyesore.no>
12863 <x6sp9o7ibw.fsf@@eyesore.no>
12864 @end example
12865
12866 So ``my'' ident on this machine is @samp{x6}.  This can be
12867 exploited---the following rule will raise the score on all followups to
12868 myself:
12869
12870 @lisp
12871 ("references"
12872  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
12873   1000 nil r))
12874 @end lisp
12875
12876 Whether it's the first two or first three characters that are ``yours''
12877 is system-dependent.
12878
12879
12880 @node Scoring Tips
12881 @section Scoring Tips
12882 @cindex scoring tips
12883
12884 @table @dfn
12885
12886 @item Crossposts
12887 @cindex crossposts
12888 @cindex scoring crossposts
12889 If you want to lower the score of crossposts, the line to match on is
12890 the @code{Xref} header.
12891 @lisp
12892 ("xref" (" talk.politics.misc:" -1000))
12893 @end lisp
12894
12895 @item Multiple crossposts
12896 If you want to lower the score of articles that have been crossposted to
12897 more than, say, 3 groups:
12898 @lisp
12899 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
12900 @end lisp
12901
12902 @item Matching on the body
12903 This is generally not a very good idea---it takes a very long time.
12904 Gnus actually has to fetch each individual article from the server.  But
12905 you might want to anyway, I guess.  Even though there are three match
12906 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
12907 and stick with it in each score file.  If you use any two, each article
12908 will be fetched @emph{twice}.  If you want to match a bit on the
12909 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
12910 the matches.
12911
12912 @item Marking as read
12913 You will probably want to mark articles that has a score below a certain
12914 number as read.  This is most easily achieved by putting the following
12915 in your @file{all.SCORE} file:
12916 @lisp
12917 ((mark -100))
12918 @end lisp
12919 You may also consider doing something similar with @code{expunge}.
12920
12921 @item Negated character classes
12922 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
12923 That will match newlines, which might lead to, well, The Unknown.  Say
12924 @code{[^abcd\n]*} instead.
12925 @end table
12926
12927
12928 @node Reverse Scoring
12929 @section Reverse Scoring
12930 @cindex reverse scoring
12931
12932 If you want to keep just articles that have @samp{Sex with Emacs} in the
12933 subject header, and expunge all other articles, you could put something
12934 like this in your score file:
12935
12936 @lisp
12937 (("subject"
12938   ("Sex with Emacs" 2))
12939  (mark 1)
12940  (expunge 1))
12941 @end lisp
12942
12943 So, you raise all articles that match @samp{Sex with Emacs} and mark the
12944 rest as read, and expunge them to boot.
12945
12946
12947 @node Global Score Files
12948 @section Global Score Files
12949 @cindex global score files
12950
12951 Sure, other newsreaders have ``global kill files''.  These are usually
12952 nothing more than a single kill file that applies to all groups, stored
12953 in the user's home directory.  Bah!  Puny, weak newsreaders!
12954
12955 What I'm talking about here are Global Score Files.  Score files from
12956 all over the world, from users everywhere, uniting all nations in one
12957 big, happy score file union!  Ange-score!  New and untested!
12958
12959 @vindex gnus-global-score-files
12960 All you have to do to use other people's score files is to set the
12961 @code{gnus-global-score-files} variable.  One entry for each score file,
12962 or each score file directory.  Gnus will decide by itself what score
12963 files are applicable to which group.
12964
12965 Say you want to use the score file
12966 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
12967 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
12968
12969 @lisp
12970 (setq gnus-global-score-files
12971       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
12972         "/ftp@@ftp.some-where:/pub/score/"))
12973 @end lisp
12974
12975 @findex gnus-score-search-global-directories
12976 Simple, eh?  Directory names must end with a @samp{/}.  These
12977 directories are typically scanned only once during each Gnus session.
12978 If you feel the need to manually re-scan the remote directories, you can
12979 use the @code{gnus-score-search-global-directories} command.
12980
12981 Note that, at present, using this option will slow down group entry
12982 somewhat.  (That is---a lot.)
12983
12984 If you want to start maintaining score files for other people to use,
12985 just put your score file up for anonymous ftp and announce it to the
12986 world.  Become a retro-moderator!  Participate in the retro-moderator
12987 wars sure to ensue, where retro-moderators battle it out for the
12988 sympathy of the people, luring them to use their score files on false
12989 premises!  Yay!  The net is saved!
12990
12991 Here are some tips for the would-be retro-moderator, off the top of my
12992 head:
12993
12994 @itemize @bullet
12995
12996 @item
12997 Articles heavily crossposted are probably junk.
12998 @item
12999 To lower a single inappropriate article, lower by @code{Message-ID}.
13000 @item
13001 Particularly brilliant authors can be raised on a permanent basis.
13002 @item
13003 Authors that repeatedly post off-charter for the group can safely be
13004 lowered out of existence.
13005 @item
13006 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
13007 articles completely.
13008
13009 @item
13010 Use expiring score entries to keep the size of the file down.  You
13011 should probably have a long expiry period, though, as some sites keep
13012 old articles for a long time.
13013 @end itemize
13014
13015 ... I wonder whether other newsreaders will support global score files
13016 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
13017 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
13018 holding our breath yet?
13019
13020
13021 @node Kill Files
13022 @section Kill Files
13023 @cindex kill files
13024
13025 Gnus still supports those pesky old kill files.  In fact, the kill file
13026 entries can now be expiring, which is something I wrote before Daniel
13027 Quinlan thought of doing score files, so I've left the code in there.
13028
13029 In short, kill processing is a lot slower (and I do mean @emph{a lot})
13030 than score processing, so it might be a good idea to rewrite your kill
13031 files into score files.
13032
13033 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
13034 forms into this file, which means that you can use kill files as some
13035 sort of primitive hook function to be run on group entry, even though
13036 that isn't a very good idea.
13037
13038 Normal kill files look like this:
13039
13040 @lisp
13041 (gnus-kill "From" "Lars Ingebrigtsen")
13042 (gnus-kill "Subject" "ding")
13043 (gnus-expunge "X")
13044 @end lisp
13045
13046 This will mark every article written by me as read, and remove the
13047 marked articles from the summary buffer.  Very useful, you'll agree.
13048
13049 Other programs use a totally different kill file syntax.  If Gnus
13050 encounters what looks like a @code{rn} kill file, it will take a stab at
13051 interpreting it.
13052
13053 Two summary functions for editing a GNUS kill file:
13054
13055 @table @kbd
13056
13057 @item M-k
13058 @kindex M-k (Summary)
13059 @findex gnus-summary-edit-local-kill
13060 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
13061
13062 @item M-K
13063 @kindex M-K (Summary)
13064 @findex gnus-summary-edit-global-kill
13065 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
13066 @end table
13067
13068 Two group mode functions for editing the kill files:
13069
13070 @table @kbd
13071
13072 @item M-k
13073 @kindex M-k (Group)
13074 @findex gnus-group-edit-local-kill
13075 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
13076
13077 @item M-K
13078 @kindex M-K (Group)
13079 @findex gnus-group-edit-global-kill
13080 Edit the general kill file (@code{gnus-group-edit-global-kill}).
13081 @end table
13082
13083 Kill file variables:
13084
13085 @table @code
13086 @item gnus-kill-file-name
13087 @vindex gnus-kill-file-name
13088 A kill file for the group @samp{soc.motss} is normally called
13089 @file{soc.motss.KILL}.  The suffix appended to the group name to get
13090 this file name is detailed by the @code{gnus-kill-file-name} variable.
13091 The ``global'' kill file (not in the score file sense of ``global'', of
13092 course) is just called @file{KILL}.
13093
13094 @vindex gnus-kill-save-kill-file
13095 @item gnus-kill-save-kill-file
13096 If this variable is non-@code{nil}, Gnus will save the
13097 kill file after processing, which is necessary if you use expiring
13098 kills.
13099
13100 @item gnus-apply-kill-hook
13101 @vindex gnus-apply-kill-hook
13102 @findex gnus-apply-kill-file-unless-scored
13103 @findex gnus-apply-kill-file
13104 A hook called to apply kill files to a group.  It is
13105 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
13106 kill file if you have a score file for the same group, you can set this
13107 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
13108 kill files to be processed, you should set this variable to @code{nil}.
13109
13110 @item gnus-kill-file-mode-hook
13111 @vindex gnus-kill-file-mode-hook
13112 A hook called in kill-file mode buffers.
13113
13114 @end table
13115
13116
13117 @node Converting Kill Files
13118 @section Converting Kill Files
13119 @cindex kill files
13120 @cindex converting kill files
13121
13122 If you have loads of old kill files, you may want to convert them into
13123 score files.  If they are ``regular'', you can use
13124 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
13125 by hand.
13126
13127 The kill to score conversion package isn't included in Gnus by default.
13128 You can fetch it from
13129 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
13130
13131 If your old kill files are very complex---if they contain more
13132 non-@code{gnus-kill} forms than not, you'll have to convert them by
13133 hand.  Or just let them be as they are.  Gnus will still use them as
13134 before.
13135
13136
13137 @node GroupLens
13138 @section GroupLens
13139 @cindex GroupLens
13140
13141 GroupLens is a collaborative filtering system that helps you work
13142 together with other people to find the quality news articles out of the
13143 huge volume of news articles generated every day.
13144
13145 To accomplish this the GroupLens system combines your opinions about
13146 articles you have already read with the opinions of others who have done
13147 likewise and gives you a personalized prediction for each unread news
13148 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
13149 rate articles, and finds other people that rate articles the same way.
13150 Once it has found some people you agree with it tells you, in the form
13151 of a prediction, what they thought of the article.  You can use this
13152 prediction to help you decide whether or not you want to read the
13153 article.
13154
13155 @menu
13156 * Using GroupLens::          How to make Gnus use GroupLens.
13157 * Rating Articles::          Letting GroupLens know how you rate articles.
13158 * Displaying Predictions::   Displaying predictions given by GroupLens.
13159 * GroupLens Variables::      Customizing GroupLens.
13160 @end menu
13161
13162
13163 @node Using GroupLens
13164 @subsection Using GroupLens
13165
13166 To use GroupLens you must register a pseudonym with your local Better
13167 Bit Bureau (BBB).
13168 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
13169 better bit in town at the moment.
13170
13171 Once you have registered you'll need to set a couple of variables.
13172
13173 @table @code
13174
13175 @item gnus-use-grouplens
13176 @vindex gnus-use-grouplens
13177 Setting this variable to a non-@code{nil} value will make Gnus hook into
13178 all the relevant GroupLens functions.
13179
13180 @item grouplens-pseudonym
13181 @vindex grouplens-pseudonym
13182 This variable should be set to the pseudonym you got when registering
13183 with the Better Bit Bureau.
13184
13185 @item grouplens-newsgroups
13186 @vindex grouplens-newsgroups
13187 A list of groups that you want to get GroupLens predictions for.
13188
13189 @end table
13190
13191 That's the minimum of what you need to get up and running with GroupLens.
13192 Once you've registered, GroupLens will start giving you scores for
13193 articles based on the average of what other people think.  But, to get
13194 the real benefit of GroupLens you need to start rating articles
13195 yourself.  Then the scores GroupLens gives you will be personalized for
13196 you, based on how the people you usually agree with have already rated.
13197
13198
13199 @node Rating Articles
13200 @subsection Rating Articles
13201
13202 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
13203 Where 1 means something like this article is a waste of bandwidth and 5
13204 means that the article was really good.  The basic question to ask
13205 yourself is, "on a scale from 1 to 5 would I like to see more articles
13206 like this one?"
13207
13208 There are four ways to enter a rating for an article in GroupLens.
13209
13210 @table @kbd
13211
13212 @item r
13213 @kindex r (GroupLens)
13214 @findex bbb-summary-rate-article
13215 This function will prompt you for a rating on a scale of one to five.
13216
13217 @item k
13218 @kindex k (GroupLens)
13219 @findex grouplens-score-thread
13220 This function will prompt you for a rating, and rate all the articles in
13221 the thread.  This is really useful for some of those long running giant
13222 threads in rec.humor.
13223
13224 @end table
13225
13226 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13227 the score of the article you're reading.
13228
13229 @table @kbd
13230
13231 @item 1-5 n
13232 @kindex n (GroupLens)
13233 @findex grouplens-next-unread-article
13234 Rate the article and go to the next unread article.
13235
13236 @item 1-5 ,
13237 @kindex , (GroupLens)
13238 @findex grouplens-best-unread-article
13239 Rate the article and go to the next unread article with the highest score.
13240
13241 @end table
13242
13243 If you want to give the current article a score of 4 and then go to the
13244 next article, just type @kbd{4 n}.
13245
13246
13247 @node Displaying Predictions
13248 @subsection Displaying Predictions
13249
13250 GroupLens makes a prediction for you about how much you will like a
13251 news article.  The predictions from GroupLens are on a scale from 1 to
13252 5, where 1 is the worst and 5 is the best.  You can use the predictions
13253 from GroupLens in one of three ways controlled by the variable
13254 @code{gnus-grouplens-override-scoring}.
13255
13256 @vindex gnus-grouplens-override-scoring
13257 There are three ways to display predictions in grouplens.  You may
13258 choose to have the GroupLens scores contribute to, or override the
13259 regular gnus scoring mechanism. override is the default; however, some
13260 people prefer to see the Gnus scores plus the grouplens scores.  To get
13261 the separate scoring behavior you need to set
13262 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
13263 GroupLens predictions combined with the grouplens scores set it to
13264 @code{'override} and to combine the scores set
13265 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
13266 the combine option you will also want to set the values for
13267 @code{grouplens-prediction-offset} and
13268 @code{grouplens-score-scale-factor}.
13269
13270 @vindex grouplens-prediction-display
13271 In either case, GroupLens gives you a few choices for how you would like
13272 to see your predictions displayed.  The display of predictions is
13273 controlled by the @code{grouplens-prediction-display} variable.
13274
13275 The following are valid values for that variable.
13276
13277 @table @code
13278 @item prediction-spot
13279 The higher the prediction, the further to the right an @samp{*} is
13280 displayed.
13281
13282 @item confidence-interval
13283 A numeric confidence interval.
13284
13285 @item prediction-bar
13286 The higher the prediction, the longer the bar.
13287
13288 @item confidence-bar
13289 Numerical confidence.
13290
13291 @item confidence-spot
13292 The spot gets bigger with more confidence.
13293
13294 @item prediction-num
13295 Plain-old numeric value.
13296
13297 @item confidence-plus-minus
13298 Prediction +/- confidence.
13299
13300 @end table
13301
13302
13303 @node GroupLens Variables
13304 @subsection GroupLens Variables
13305
13306 @table @code
13307
13308 @item gnus-summary-grouplens-line-format
13309 The summary line format used in GroupLens-enhanced summary buffers.  It
13310 accepts the same specs as the normal summary line format (@pxref{Summary
13311 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
13312 %s\n}.
13313
13314 @item grouplens-bbb-host
13315 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
13316 default.
13317
13318 @item grouplens-bbb-port
13319 Port of the host running the bbbd server.  The default is 9000.
13320
13321 @item grouplens-score-offset
13322 Offset the prediction by this value.  In other words, subtract the
13323 prediction value by this number to arrive at the effective score.  The
13324 default is 0.
13325
13326 @item grouplens-score-scale-factor
13327 This variable allows the user to magnify the effect of GroupLens scores.
13328 The scale factor is applied after the offset.  The default is 1.
13329
13330 @end table
13331
13332
13333 @node Advanced Scoring
13334 @section Advanced Scoring
13335
13336 Scoring on Subjects and From headers is nice enough, but what if you're
13337 really interested in what a person has to say only when she's talking
13338 about a particular subject?  Or what if you really don't want to
13339 read what person A has to say when she's following up to person B, but
13340 want to read what she says when she's following up to person C?
13341
13342 By using advanced scoring rules you may create arbitrarily complex
13343 scoring patterns.
13344
13345 @menu
13346 * Advanced Scoring Syntax::     A definition.
13347 * Advanced Scoring Examples::   What they look like.
13348 * Advanced Scoring Tips::       Getting the most out of it.
13349 @end menu
13350
13351
13352 @node Advanced Scoring Syntax
13353 @subsection Advanced Scoring Syntax
13354
13355 Ordinary scoring rules have a string as the first element in the rule.
13356 Advanced scoring rules have a list as the first element.  The second
13357 element is the score to be applied if the first element evaluated to a
13358 non-@code{nil} value.
13359
13360 These lists may consist of three logical operators, one redirection
13361 operator, and various match operators.
13362
13363 Logical operators:
13364
13365 @table @code
13366 @item &
13367 @itemx and
13368 This logical operator will evaluate each of its arguments until it finds
13369 one that evaluates to @code{false}, and then it'll stop.  If all arguments
13370 evaluate to @code{true} values, then this operator will return
13371 @code{true}.
13372
13373 @item |
13374 @itemx or
13375 This logical operator will evaluate each of its arguments until it finds
13376 one that evaluates to @code{true}.  If no arguments are @code{true},
13377 then this operator will return @code{false}.
13378
13379 @item !
13380 @itemx not
13381 @itemx Â¬
13382 This logical operator only takes a single argument.  It returns the
13383 logical negation of the value of its argument.
13384
13385 @end table
13386
13387 There is an @dfn{indirection operator} that will make its arguments
13388 apply to the ancestors of the current article being scored.  For
13389 instance, @code{1-} will make score rules apply to the parent of the
13390 current article.  @code{2-} will make score rules apply to the
13391 grandparent of the current article.  Alternatively, you can write
13392 @code{^^}, where the number of @code{^}s (carets) says how far back into
13393 the ancestry you want to go.
13394
13395 Finally, we have the match operators.  These are the ones that do the
13396 real work.  Match operators are header name strings followed by a match
13397 and a match type.  A typical match operator looks like @samp{("from"
13398 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
13399 simple scoring, and the match types are also the same.
13400
13401
13402 @node Advanced Scoring Examples
13403 @subsection Advanced Scoring Examples
13404
13405 Let's say you want to increase the score of articles written by Lars
13406 when he's talking about Gnus:
13407
13408 @example
13409 ((&
13410   ("from" "Lars Ingebrigtsen")
13411   ("subject" "Gnus"))
13412  1000)
13413 @end example
13414
13415 Quite simple, huh?
13416
13417 When he writes long articles, he sometimes has something nice to say:
13418
13419 @example
13420 ((&
13421   ("from" "Lars Ingebrigtsen")
13422   (|
13423    ("subject" "Gnus")
13424    ("lines" 100 >)))
13425  1000)
13426 @end example
13427
13428 However, when he responds to things written by Reig Eigil Logge, you
13429 really don't want to read what he's written:
13430
13431 @example
13432 ((&
13433   ("from" "Lars Ingebrigtsen")
13434   (1- ("from" "Reig Eigir Logge")))
13435  -100000)
13436 @end example
13437
13438 Everybody that follows up Redmondo when he writes about disappearing
13439 socks should have their scores raised, but only when they talk about
13440 white socks.  However, when Lars talks about socks, it's usually not
13441 very interesting:
13442
13443 @example
13444 ((&
13445   (1-
13446    (&
13447     ("from" "redmondo@@.*no" r)
13448     ("body" "disappearing.*socks" t)))
13449   (! ("from" "Lars Ingebrigtsen"))
13450   ("body" "white.*socks"))
13451  1000)
13452 @end example
13453
13454 The possibilities are endless.
13455
13456
13457 @node Advanced Scoring Tips
13458 @subsection Advanced Scoring Tips
13459
13460 The @code{&} and @code{|} logical operators do short-circuit logic.
13461 That is, they stop processing their arguments when it's clear what the
13462 result of the operation will be.  For instance, if one of the arguments
13463 of an @code{&} evaluates to @code{false}, there's no point in evaluating
13464 the rest of the arguments.  This means that you should put slow matches
13465 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
13466 @samp{subject}) first.
13467
13468 The indirection arguments (@code{1-} and so on) will make their
13469 arguments work on previous generations of the thread.  If you say
13470 something like:
13471
13472 @example
13473 ...
13474 (1-
13475  (1-
13476   ("from" "lars")))
13477 ...
13478 @end example
13479
13480 Then that means "score on the from header of the grandparent of the
13481 current article".  An indirection is quite fast, but it's better to say:
13482
13483 @example
13484 (1-
13485  (&
13486   ("from" "Lars")
13487   ("subject" "Gnus")))
13488 @end example
13489
13490 than it is to say:
13491
13492 @example
13493 (&
13494  (1- ("from" "Lars"))
13495  (1- ("subject" "Gnus")))
13496 @end example
13497
13498
13499 @node Score Decays
13500 @section Score Decays
13501 @cindex score decays
13502 @cindex decays
13503
13504 You may find that your scores have a tendency to grow without
13505 bounds, especially if you're using adaptive scoring.  If scores get too
13506 big, they lose all meaning---they simply max out and it's difficult to
13507 use them in any sensible way.
13508
13509 @vindex gnus-decay-scores
13510 @findex gnus-decay-score
13511 @vindex gnus-score-decay-function
13512 Gnus provides a mechanism for decaying scores to help with this problem.
13513 When score files are loaded and @code{gnus-decay-scores} is
13514 non-@code{nil}, Gnus will run the score files through the decaying
13515 mechanism thereby lowering the scores of all non-permanent score rules.
13516 The decay itself if performed by the @code{gnus-score-decay-function}
13517 function, which is @code{gnus-decay-score} by default.  Here's the
13518 definition of that function:
13519
13520 @lisp
13521 (defun gnus-decay-score (score)
13522   "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'."
13523   (floor
13524    (- score
13525       (* (if (< score 0) 1 -1)
13526          (min (abs score)
13527               (max gnus-score-decay-constant
13528                    (* (abs score)
13529                       gnus-score-decay-scale)))))))
13530 @end lisp
13531
13532 @vindex gnus-score-decay-scale
13533 @vindex gnus-score-decay-constant
13534 @code{gnus-score-decay-constant} is 3 by default and
13535 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
13536
13537 @enumerate
13538 @item
13539 Scores between -3 and 3 will be set to 0 when this function is called.
13540
13541 @item
13542 Scores with magnitudes between 3 and 60 will be shrunk by 3.
13543
13544 @item
13545 Scores with magnitudes greater than 60 will be shrunk by 5% of the
13546 score.
13547 @end enumerate
13548
13549 If you don't like this decay function, write your own.  It is called
13550 with the score to be decayed as its only parameter, and it should return
13551 the new score, which should be an integer.
13552
13553 Gnus will try to decay scores once a day.  If you haven't run Gnus for
13554 four days, Gnus will decay the scores four times, for instance.
13555
13556
13557 @node Various
13558 @chapter Various
13559
13560 @menu
13561 * Process/Prefix::             A convention used by many treatment commands.
13562 * Interactive::                Making Gnus ask you many questions.
13563 * Symbolic Prefixes::          How to supply some Gnus functions with options.
13564 * Formatting Variables::       You can specify what buffers should look like.
13565 * Windows Configuration::      Configuring the Gnus buffer windows.
13566 * Faces and Fonts::            How to change how faces look.
13567 * Compilation::                How to speed Gnus up.
13568 * Mode Lines::                 Displaying information in the mode lines.
13569 * Highlighting and Menus::     Making buffers look all nice and cozy.
13570 * Buttons::                    Get tendonitis in ten easy steps!
13571 * Daemons::                    Gnus can do things behind your back.
13572 * NoCeM::                      How to avoid spam and other fatty foods.
13573 * Undo::                       Some actions can be undone.
13574 * Moderation::                 What to do if you're a moderator.
13575 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
13576 * Fuzzy Matching::             What's the big fuzz?
13577 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
13578 * Various Various::            Things that are really various.
13579 @end menu
13580
13581
13582 @node Process/Prefix
13583 @section Process/Prefix
13584 @cindex process/prefix convention
13585
13586 Many functions, among them functions for moving, decoding and saving
13587 articles, use what is known as the @dfn{Process/Prefix convention}.
13588
13589 This is a method for figuring out what articles the user wants the
13590 command to be performed on.
13591
13592 It goes like this:
13593
13594 If the numeric prefix is N, perform the operation on the next N
13595 articles, starting with the current one.  If the numeric prefix is
13596 negative, perform the operation on the previous N articles, starting
13597 with the current one.
13598
13599 @vindex transient-mark-mode
13600 If @code{transient-mark-mode} in non-@code{nil} and the region is
13601 active, all articles in the region will be worked upon.
13602
13603 If there is no numeric prefix, but some articles are marked with the
13604 process mark, perform the operation on the articles marked with
13605 the process mark.
13606
13607 If there is neither a numeric prefix nor any articles marked with the
13608 process mark, just perform the operation on the current article.
13609
13610 Quite simple, really, but it needs to be made clear so that surprises
13611 are avoided.
13612
13613 Commands that react to the process mark will push the current list of
13614 process marked articles onto a stack and will then clear all process
13615 marked articles.  You can restore the previous configuration with the
13616 @kbd{M P y} command (@pxref{Setting Process Marks}).
13617
13618 @vindex gnus-summary-goto-unread
13619 One thing that seems to shock & horrify lots of people is that, for
13620 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
13621 Since each @kbd{d} (which marks the current article as read) by default
13622 goes to the next unread article after marking, this means that @kbd{3 d}
13623 will mark the next three unread articles as read, no matter what the
13624 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
13625 @code{nil} for a more straightforward action.
13626
13627
13628 @node Interactive
13629 @section Interactive
13630 @cindex interaction
13631
13632 @table @code
13633
13634 @item gnus-novice-user
13635 @vindex gnus-novice-user
13636 If this variable is non-@code{nil}, you are either a newcomer to the
13637 World of Usenet, or you are very cautious, which is a nice thing to be,
13638 really.  You will be given questions of the type ``Are you sure you want
13639 to do this?'' before doing anything dangerous.  This is @code{t} by
13640 default.
13641
13642 @item gnus-expert-user
13643 @vindex gnus-expert-user
13644 If this variable is non-@code{nil}, you will seldom be asked any
13645 questions by Gnus.  It will simply assume you know what you're doing, no
13646 matter how strange.
13647
13648 @item gnus-interactive-catchup
13649 @vindex gnus-interactive-catchup
13650 Require confirmation before catching up a group if non-@code{nil}.  It
13651 is @code{t} by default.
13652
13653 @item gnus-interactive-exit
13654 @vindex gnus-interactive-exit
13655 Require confirmation before exiting Gnus.  This variable is @code{t} by
13656 default.
13657 @end table
13658
13659
13660 @node Symbolic Prefixes
13661 @section Symbolic Prefixes
13662 @cindex symbolic prefixes
13663
13664 Quite a lot of Emacs commands react to the (numeric) prefix.  For
13665 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
13666 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
13667 rule of 900 to the current article.
13668
13669 This is all nice and well, but what if you want to give a command some
13670 additional information?  Well, what most commands do is interpret the
13671 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
13672 doesn't want a backup file to be created when saving the current buffer,
13673 for instance.  But what if you want to save without making a backup
13674 file, and you want Emacs to flash lights and play a nice tune at the
13675 same time?  You can't, and you're probably perfectly happy that way.
13676
13677 @kindex M-i (Summary)
13678 @findex gnus-symbolic-argument
13679 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
13680 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
13681 character typed in is the value.  You can stack as many @kbd{M-i}
13682 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
13683 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
13684 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
13685 @code{b}''.  You get the drift.
13686
13687 Typing in symbolic prefixes to commands that don't accept them doesn't
13688 hurt, but it doesn't do any good either.  Currently not many Gnus
13689 functions make use of the symbolic prefix.
13690
13691 If you're interested in how Gnus implements this, @pxref{Extended
13692 Interactive}.
13693
13694
13695 @node Formatting Variables
13696 @section Formatting Variables
13697 @cindex formatting variables
13698
13699 Throughout this manual you've probably noticed lots of variables called
13700 things like @code{gnus-group-line-format} and
13701 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
13702 output lines in the various buffers.  There's quite a lot of them.
13703 Fortunately, they all use the same syntax, so there's not that much to
13704 be annoyed by.
13705
13706 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
13707 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
13708 lots of percentages everywhere.
13709
13710 @menu
13711 * Formatting Basics::     A formatting variable is basically a format string.
13712 * Mode Line Formatting::  Some rules about mode line formatting variables.
13713 * Advanced Formatting::   Modifying output in various ways.
13714 * User-Defined Specs::    Having Gnus call your own functions.
13715 * Formatting Fonts::      Making the formatting look colorful and nice.
13716 @end menu
13717
13718 Currently Gnus uses the following formatting variables:
13719 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
13720 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
13721 @code{gnus-group-mode-line-format},
13722 @code{gnus-summary-mode-line-format},
13723 @code{gnus-article-mode-line-format},
13724 @code{gnus-server-mode-line-format}, and
13725 @code{gnus-summary-pick-line-format}.
13726
13727 All these format variables can also be arbitrary elisp forms.  In that
13728 case, they will be @code{eval}ed to insert the required lines.
13729
13730 @kindex M-x gnus-update-format
13731 @findex gnus-update-format
13732 Gnus includes a command to help you while creating your own format
13733 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
13734 update the spec in question and pop you to a buffer where you can
13735 examine the resulting lisp code to be run to generate the line.
13736
13737
13738
13739 @node Formatting Basics
13740 @subsection Formatting Basics
13741
13742 Each @samp{%} element will be replaced by some string or other when the
13743 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
13744 spec, and pad with spaces to get a 5-character field''.
13745
13746 As with normal C and Emacs Lisp formatting strings, the numerical
13747 modifier between the @samp{%} and the formatting type character will
13748 @dfn{pad} the output so that it is always at least that long.
13749 @samp{%5y} will make the field always (at least) five characters wide by
13750 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
13751 the right instead.
13752
13753 You may also wish to limit the length of the field to protect against
13754 particularly wide values.  For that you can say @samp{%4,6y}, which
13755 means that the field will never be more than 6 characters wide and never
13756 less than 4 characters wide.
13757
13758
13759 @node Mode Line Formatting
13760 @subsection Mode Line Formatting
13761
13762 Mode line formatting variables (e.g.,
13763 @code{gnus-summary-mode-line-format}) follow the same rules as other,
13764 buffer line oriented formatting variables (@pxref{Formatting Basics})
13765 with the following two differences:
13766
13767 @enumerate
13768
13769 @item
13770 There must be no newline (@samp{\n}) at the end.
13771
13772 @item
13773 The special @samp{%%b} spec can be used to display the buffer name.
13774 Well, it's no spec at all, really---@samp{%%} is just a way to quote
13775 @samp{%} to allow it to pass through the formatting machinery unmangled,
13776 so that Emacs receives @samp{%b}, which is something the Emacs mode line
13777 display interprets to mean ``show the buffer name''.  For a full list of
13778 mode line specs Emacs understands, see the documentation of the
13779 @code{mode-line-format} variable.
13780
13781 @end enumerate
13782
13783
13784 @node Advanced Formatting
13785 @subsection Advanced Formatting
13786
13787 It is frequently useful to post-process the fields in some way.
13788 Padding, limiting, cutting off parts and suppressing certain values can
13789 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
13790 look like @samp{%~(cut 3)~(ignore "0")y}.
13791
13792 These are the valid modifiers:
13793
13794 @table @code
13795 @item pad
13796 @itemx pad-left
13797 Pad the field to the left with spaces until it reaches the required
13798 length.
13799
13800 @item pad-right
13801 Pad the field to the right with spaces until it reaches the required
13802 length.
13803
13804 @item max
13805 @itemx max-left
13806 Cut off characters from the left until it reaches the specified length.
13807
13808 @item max-right
13809 Cut off characters from the right until it reaches the specified
13810 length.
13811
13812 @item cut
13813 @itemx cut-left
13814 Cut off the specified number of characters from the left.
13815
13816 @item cut-right
13817 Cut off the specified number of characters from the right.
13818
13819 @item ignore
13820 Return an empty string if the field is equal to the specified value.
13821
13822 @item form
13823 Use the specified form as the field value when the @samp{@@} spec is
13824 used.
13825 @end table
13826
13827 Let's take an example.  The @samp{%o} spec in the summary mode lines
13828 will return a date in compact ISO8601 format---@samp{19960809T230410}.
13829 This is quite a mouthful, so we want to shave off the century number and
13830 the time, leaving us with a six-character date.  That would be
13831 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
13832 maxing, and we need the padding to ensure that the date is never less
13833 than 6 characters to make it look nice in columns.)
13834
13835 Ignoring is done first; then cutting; then maxing; and then as the very
13836 last operation, padding.
13837
13838 If you use lots of these advanced thingies, you'll find that Gnus gets
13839 quite slow.  This can be helped enormously by running @kbd{M-x
13840 gnus-compile} when you are satisfied with the look of your lines.
13841 @xref{Compilation}.
13842
13843
13844 @node User-Defined Specs
13845 @subsection User-Defined Specs
13846
13847 All the specs allow for inserting user defined specifiers---@samp{u}.
13848 The next character in the format string should be a letter.  Gnus
13849 will call the function @code{gnus-user-format-function-}@samp{X}, where
13850 @samp{X} is the letter following @samp{%u}.  The function will be passed
13851 a single parameter---what the parameter means depends on what buffer
13852 it's being called from.  The function should return a string, which will
13853 be inserted into the buffer just like information from any other
13854 specifier.  This function may also be called with dummy values, so it
13855 should protect against that.
13856
13857 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
13858 much the same without defining new functions.  Here's an example:
13859 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
13860 given here will be evaluated to yield the current line number, and then
13861 inserted.
13862
13863
13864 @node Formatting Fonts
13865 @subsection Formatting Fonts
13866
13867 There are specs for highlighting, and these are shared by all the format
13868 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
13869 the special @code{mouse-face} property set, which means that it will be
13870 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
13871 over it.
13872
13873 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
13874 normal faces set using @code{gnus-face-0}, which is @code{bold} by
13875 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
13876 and so on.  Create as many faces as you wish.  The same goes for the
13877 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
13878 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
13879
13880 Here's an alternative recipe for the group buffer:
13881
13882 @lisp
13883 ;; Create three face types.
13884 (setq gnus-face-1 'bold)
13885 (setq gnus-face-3 'italic)
13886
13887 ;; We want the article count to be in
13888 ;; a bold and green face.  So we create
13889 ;; a new face called `my-green-bold'.
13890 (copy-face 'bold 'my-green-bold)
13891 ;; Set the color.
13892 (set-face-foreground 'my-green-bold "ForestGreen")
13893 (setq gnus-face-2 'my-green-bold)
13894
13895 ;; Set the new & fancy format.
13896 (setq gnus-group-line-format
13897       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
13898 @end lisp
13899
13900 I'm sure you'll be able to use this scheme to create totally unreadable
13901 and extremely vulgar displays.  Have fun!
13902
13903 Note that the @samp{%(} specs (and friends) do not make any sense on the
13904 mode-line variables.
13905
13906
13907 @node Windows Configuration
13908 @section Windows Configuration
13909 @cindex windows configuration
13910
13911 No, there's nothing here about X, so be quiet.
13912
13913 @vindex gnus-use-full-window
13914 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
13915 other windows and occupy the entire Emacs screen by itself.  It is
13916 @code{t} by default.
13917
13918 @vindex gnus-buffer-configuration
13919 @code{gnus-buffer-configuration} describes how much space each Gnus
13920 buffer should be given.  Here's an excerpt of this variable:
13921
13922 @lisp
13923 ((group (vertical 1.0 (group 1.0 point)
13924                       (if gnus-carpal (group-carpal 4))))
13925  (article (vertical 1.0 (summary 0.25 point)
13926                         (article 1.0))))
13927 @end lisp
13928
13929 This is an alist.  The @dfn{key} is a symbol that names some action or
13930 other.  For instance, when displaying the group buffer, the window
13931 configuration function will use @code{group} as the key.  A full list of
13932 possible names is listed below.
13933
13934 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
13935 should occupy.  To take the @code{article} split as an example -
13936
13937 @lisp
13938 (article (vertical 1.0 (summary 0.25 point)
13939                        (article 1.0)))
13940 @end lisp
13941
13942 This @dfn{split} says that the summary buffer should occupy 25% of upper
13943 half of the screen, and that it is placed over the article buffer.  As
13944 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
13945 reaching for that calculator there).  However, the special number
13946 @code{1.0} is used to signal that this buffer should soak up all the
13947 rest of the space available after the rest of the buffers have taken
13948 whatever they need.  There should be only one buffer with the @code{1.0}
13949 size spec per split.
13950
13951 Point will be put in the buffer that has the optional third element
13952 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
13953 split where the tag @code{frame-focus} is a member (i.e. is the third or
13954 fourth element in the list, depending on whether the @code{point} tag is
13955 present) gets focus.
13956
13957 Here's a more complicated example:
13958
13959 @lisp
13960 (article (vertical 1.0 (group 4)
13961                        (summary 0.25 point)
13962                        (if gnus-carpal (summary-carpal 4))
13963                        (article 1.0)))
13964 @end lisp
13965
13966 If the size spec is an integer instead of a floating point number,
13967 then that number will be used to say how many lines a buffer should
13968 occupy, not a percentage.
13969
13970 If the @dfn{split} looks like something that can be @code{eval}ed (to be
13971 precise---if the @code{car} of the split is a function or a subr), this
13972 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
13973 be used as a split.  This means that there will be three buffers if
13974 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
13975 is non-@code{nil}.
13976
13977 Not complicated enough for you?  Well, try this on for size:
13978
13979 @lisp
13980 (article (horizontal 1.0
13981              (vertical 0.5
13982                  (group 1.0)
13983                  (gnus-carpal 4))
13984              (vertical 1.0
13985                  (summary 0.25 point)
13986                  (summary-carpal 4)
13987                  (article 1.0))))
13988 @end lisp
13989
13990 Whoops.  Two buffers with the mystery 100% tag.  And what's that
13991 @code{horizontal} thingie?
13992
13993 If the first element in one of the split is @code{horizontal}, Gnus will
13994 split the window horizontally, giving you two windows side-by-side.
13995 Inside each of these strips you may carry on all you like in the normal
13996 fashion.  The number following @code{horizontal} says what percentage of
13997 the screen is to be given to this strip.
13998
13999 For each split, there @emph{must} be one element that has the 100% tag.
14000 The splitting is never accurate, and this buffer will eat any leftover
14001 lines from the splits.
14002
14003 To be slightly more formal, here's a definition of what a valid split
14004 may look like:
14005
14006 @example
14007 split       = frame | horizontal | vertical | buffer | form
14008 frame       = "(frame " size *split ")"
14009 horizontal  = "(horizontal " size *split ")"
14010 vertical    = "(vertical " size *split ")"
14011 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
14012 size        = number | frame-params
14013 buffer-name = group | article | summary ...
14014 @end example
14015
14016 The limitations are that the @code{frame} split can only appear as the
14017 top-level split.  @var{form} should be an Emacs Lisp form that should
14018 return a valid split.  We see that each split is fully recursive, and
14019 may contain any number of @code{vertical} and @code{horizontal} splits.
14020
14021 @vindex gnus-window-min-width
14022 @vindex gnus-window-min-height
14023 @cindex window height
14024 @cindex window width
14025 Finding the right sizes can be a bit complicated.  No window may be less
14026 than @code{gnus-window-min-height} (default 1) characters high, and all
14027 windows must be at least @code{gnus-window-min-width} (default 1)
14028 characters wide.  Gnus will try to enforce this before applying the
14029 splits.  If you want to use the normal Emacs window width/height limit,
14030 you can just set these two variables to @code{nil}.
14031
14032 If you're not familiar with Emacs terminology, @code{horizontal} and
14033 @code{vertical} splits may work the opposite way of what you'd expect.
14034 Windows inside a @code{horizontal} split are shown side-by-side, and
14035 windows within a @code{vertical} split are shown above each other.
14036
14037 @findex gnus-configure-frame
14038 If you want to experiment with window placement, a good tip is to call
14039 @code{gnus-configure-frame} directly with a split.  This is the function
14040 that does all the real work when splitting buffers.  Below is a pretty
14041 nonsensical configuration with 5 windows; two for the group buffer and
14042 three for the article buffer.  (I said it was nonsensical.)  If you
14043 @code{eval} the statement below, you can get an idea of how that would
14044 look straight away, without going through the normal Gnus channels.
14045 Play with it until you're satisfied, and then use
14046 @code{gnus-add-configuration} to add your new creation to the buffer
14047 configuration list.
14048
14049 @lisp
14050 (gnus-configure-frame
14051  '(horizontal 1.0
14052     (vertical 10
14053       (group 1.0)
14054       (article 0.3 point))
14055     (vertical 1.0
14056       (article 1.0)
14057       (horizontal 4
14058         (group 1.0)
14059         (article 10)))))
14060 @end lisp
14061
14062 You might want to have several frames as well.  No prob---just use the
14063 @code{frame} split:
14064
14065 @lisp
14066 (gnus-configure-frame
14067  '(frame 1.0
14068          (vertical 1.0
14069                    (summary 0.25 point frame-focus)
14070                    (article 1.0))
14071          (vertical ((height . 5) (width . 15)
14072                     (user-position . t)
14073                     (left . -1) (top . 1))
14074                    (picon 1.0))))
14075
14076 @end lisp
14077
14078 This split will result in the familiar summary/article window
14079 configuration in the first (or ``main'') frame, while a small additional
14080 frame will be created where picons will be shown.  As you can see,
14081 instead of the normal @code{1.0} top-level spec, each additional split
14082 should have a frame parameter alist as the size spec.
14083 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
14084 Reference Manual}.  Under XEmacs, a frame property list will be
14085 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
14086 is such a plist.
14087
14088 Here's a list of all possible keys for
14089 @code{gnus-buffer-configuration}:
14090
14091 @code{group}, @code{summary}, @code{article}, @code{server},
14092 @code{browse}, @code{message}, @code{pick}, @code{info},
14093 @code{summary-faq}, @code{edit-group}, @code{edit-server},
14094 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
14095 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
14096 @code{bug}, @code{compose-bounce}, and @code{score-trace}.
14097
14098 Note that the @code{message} key is used for both
14099 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
14100 it is desirable to distinguish between the two, something like this
14101 might be used:
14102
14103 @lisp
14104 (message (horizontal 1.0
14105                      (vertical 1.0 (message 1.0 point))
14106                      (vertical 0.24
14107                                (if (buffer-live-p gnus-summary-buffer)
14108                                    '(summary 0.5))
14109                                (group 1.0)))))
14110 @end lisp
14111
14112 @findex gnus-add-configuration
14113 Since the @code{gnus-buffer-configuration} variable is so long and
14114 complicated, there's a function you can use to ease changing the config
14115 of a single setting: @code{gnus-add-configuration}.  If, for instance,
14116 you want to change the @code{article} setting, you could say:
14117
14118 @lisp
14119 (gnus-add-configuration
14120  '(article (vertical 1.0
14121                (group 4)
14122                (summary .25 point)
14123                (article 1.0))))
14124 @end lisp
14125
14126 You'd typically stick these @code{gnus-add-configuration} calls in your
14127 @file{.gnus.el} file or in some startup hook---they should be run after
14128 Gnus has been loaded.
14129
14130 @vindex gnus-always-force-window-configuration
14131 If all windows mentioned in the configuration are already visible, Gnus
14132 won't change the window configuration.  If you always want to force the
14133 ``right'' window configuration, you can set
14134 @code{gnus-always-force-window-configuration} to non-@code{nil}.
14135
14136
14137 @node Faces and Fonts
14138 @section Faces and Fonts
14139 @cindex faces
14140 @cindex fonts
14141 @cindex colors
14142
14143 Fiddling with fonts and faces used to be very difficult, but these days
14144 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
14145 the face you want to alter, and alter it via the standard Customize
14146 interface.
14147
14148
14149 @node Compilation
14150 @section Compilation
14151 @cindex compilation
14152 @cindex byte-compilation
14153
14154 @findex gnus-compile
14155
14156 Remember all those line format specification variables?
14157 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
14158 on.  Now, Gnus will of course heed whatever these variables are, but,
14159 unfortunately, changing them will mean a quite significant slow-down.
14160 (The default values of these variables have byte-compiled functions
14161 associated with them, while the user-generated versions do not, of
14162 course.)
14163
14164 To help with this, you can run @kbd{M-x gnus-compile} after you've
14165 fiddled around with the variables and feel that you're (kind of)
14166 satisfied.  This will result in the new specs being byte-compiled, and
14167 you'll get top speed again.  Gnus will save these compiled specs in the
14168 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
14169 this function, though---you should compile them yourself by sticking
14170 them into the @code{.gnus.el} file and byte-compiling that file.)
14171
14172
14173 @node Mode Lines
14174 @section Mode Lines
14175 @cindex mode lines
14176
14177 @vindex gnus-updated-mode-lines
14178 @code{gnus-updated-mode-lines} says what buffers should keep their mode
14179 lines updated.  It is a list of symbols.  Supported symbols include
14180 @code{group}, @code{article}, @code{summary}, @code{server},
14181 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
14182 Gnus will keep that mode line updated with information that may be
14183 pertinent.  If this variable is @code{nil}, screen refresh may be
14184 quicker.
14185
14186 @cindex display-time
14187
14188 @vindex gnus-mode-non-string-length
14189 By default, Gnus displays information on the current article in the mode
14190 lines of the summary and article buffers.  The information Gnus wishes
14191 to display (e.g. the subject of the article) is often longer than the
14192 mode lines, and therefore have to be cut off at some point.  The
14193 @code{gnus-mode-non-string-length} variable says how long the other
14194 elements on the line is (i.e., the non-info part).  If you put
14195 additional elements on the mode line (e.g. a clock), you should modify
14196 this variable:
14197
14198 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
14199 @lisp
14200 (add-hook 'display-time-hook
14201           (lambda () (setq gnus-mode-non-string-length
14202                            (+ 21
14203                               (if line-number-mode 5 0)
14204                               (if column-number-mode 4 0)
14205                               (length display-time-string)))))
14206 @end lisp
14207
14208 If this variable is @code{nil} (which is the default), the mode line
14209 strings won't be chopped off, and they won't be padded either.  Note
14210 that the default is unlikely to be desirable, as even the percentage
14211 complete in the buffer may be crowded off the mode line; the user should
14212 configure this variable appropriately for her configuration.
14213
14214
14215 @node Highlighting and Menus
14216 @section Highlighting and Menus
14217 @cindex visual
14218 @cindex highlighting
14219 @cindex menus
14220
14221 @vindex gnus-visual
14222 The @code{gnus-visual} variable controls most of the Gnus-prettifying
14223 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
14224 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
14225 file.
14226
14227 This variable can be a list of visual properties that are enabled.  The
14228 following elements are valid, and are all included by default:
14229
14230 @table @code
14231 @item group-highlight
14232 Do highlights in the group buffer.
14233 @item summary-highlight
14234 Do highlights in the summary buffer.
14235 @item article-highlight
14236 Do highlights in the article buffer.
14237 @item highlight
14238 Turn on highlighting in all buffers.
14239 @item group-menu
14240 Create menus in the group buffer.
14241 @item summary-menu
14242 Create menus in the summary buffers.
14243 @item article-menu
14244 Create menus in the article buffer.
14245 @item browse-menu
14246 Create menus in the browse buffer.
14247 @item server-menu
14248 Create menus in the server buffer.
14249 @item score-menu
14250 Create menus in the score buffers.
14251 @item menu
14252 Create menus in all buffers.
14253 @end table
14254
14255 So if you only want highlighting in the article buffer and menus in all
14256 buffers, you could say something like:
14257
14258 @lisp
14259 (setq gnus-visual '(article-highlight menu))
14260 @end lisp
14261
14262 If you want highlighting only and no menus whatsoever, you'd say:
14263
14264 @lisp
14265 (setq gnus-visual '(highlight))
14266 @end lisp
14267
14268 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14269 in all Gnus buffers.
14270
14271 Other general variables that influence the look of all buffers include:
14272
14273 @table @code
14274 @item gnus-mouse-face
14275 @vindex gnus-mouse-face
14276 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
14277 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
14278
14279 @end table
14280
14281 There are hooks associated with the creation of all the different menus:
14282
14283 @table @code
14284
14285 @item gnus-article-menu-hook
14286 @vindex gnus-article-menu-hook
14287 Hook called after creating the article mode menu.
14288
14289 @item gnus-group-menu-hook
14290 @vindex gnus-group-menu-hook
14291 Hook called after creating the group mode menu.
14292
14293 @item gnus-summary-menu-hook
14294 @vindex gnus-summary-menu-hook
14295 Hook called after creating the summary mode menu.
14296
14297 @item gnus-server-menu-hook
14298 @vindex gnus-server-menu-hook
14299 Hook called after creating the server mode menu.
14300
14301 @item gnus-browse-menu-hook
14302 @vindex gnus-browse-menu-hook
14303 Hook called after creating the browse mode menu.
14304
14305 @item gnus-score-menu-hook
14306 @vindex gnus-score-menu-hook
14307 Hook called after creating the score mode menu.
14308
14309 @end table
14310
14311
14312 @node Buttons
14313 @section Buttons
14314 @cindex buttons
14315 @cindex mouse
14316 @cindex click
14317
14318 Those new-fangled @dfn{mouse} contraptions is very popular with the
14319 young, hep kids who don't want to learn the proper way to do things
14320 these days.  Why, I remember way back in the summer of '89, when I was
14321 using Emacs on a Tops 20 system.  Three hundred users on one single
14322 machine, and every user was running Simula compilers.  Bah!
14323
14324 Right.
14325
14326 @vindex gnus-carpal
14327 Well, you can make Gnus display bufferfuls of buttons you can click to
14328 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
14329 really.  Tell the chiropractor I sent you.
14330
14331
14332 @table @code
14333
14334 @item gnus-carpal-mode-hook
14335 @vindex gnus-carpal-mode-hook
14336 Hook run in all carpal mode buffers.
14337
14338 @item gnus-carpal-button-face
14339 @vindex gnus-carpal-button-face
14340 Face used on buttons.
14341
14342 @item gnus-carpal-header-face
14343 @vindex gnus-carpal-header-face
14344 Face used on carpal buffer headers.
14345
14346 @item gnus-carpal-group-buffer-buttons
14347 @vindex gnus-carpal-group-buffer-buttons
14348 Buttons in the group buffer.
14349
14350 @item gnus-carpal-summary-buffer-buttons
14351 @vindex gnus-carpal-summary-buffer-buttons
14352 Buttons in the summary buffer.
14353
14354 @item gnus-carpal-server-buffer-buttons
14355 @vindex gnus-carpal-server-buffer-buttons
14356 Buttons in the server buffer.
14357
14358 @item gnus-carpal-browse-buffer-buttons
14359 @vindex gnus-carpal-browse-buffer-buttons
14360 Buttons in the browse buffer.
14361 @end table
14362
14363 All the @code{buttons} variables are lists.  The elements in these list
14364 are either cons cells where the @code{car} contains a text to be displayed and
14365 the @code{cdr} contains a function symbol, or a simple string.
14366
14367
14368 @node Daemons
14369 @section Daemons
14370 @cindex demons
14371 @cindex daemons
14372
14373 Gnus, being larger than any program ever written (allegedly), does lots
14374 of strange stuff that you may wish to have done while you're not
14375 present.  For instance, you may want it to check for new mail once in a
14376 while.  Or you may want it to close down all connections to all servers
14377 when you leave Emacs idle.  And stuff like that.
14378
14379 Gnus will let you do stuff like that by defining various
14380 @dfn{handlers}.  Each handler consists of three elements:  A
14381 @var{function}, a @var{time}, and an @var{idle} parameter.
14382
14383 Here's an example of a handler that closes connections when Emacs has
14384 been idle for thirty minutes:
14385
14386 @lisp
14387 (gnus-demon-close-connections nil 30)
14388 @end lisp
14389
14390 Here's a handler that scans for PGP headers every hour when Emacs is
14391 idle:
14392
14393 @lisp
14394 (gnus-demon-scan-pgp 60 t)
14395 @end lisp
14396
14397 This @var{time} parameter and than @var{idle} parameter work together
14398 in a strange, but wonderful fashion.  Basically, if @var{idle} is
14399 @code{nil}, then the function will be called every @var{time} minutes.
14400
14401 If @var{idle} is @code{t}, then the function will be called after
14402 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
14403 the function will never be called.  But once Emacs goes idle, the
14404 function will be called every @var{time} minutes.
14405
14406 If @var{idle} is a number and @var{time} is a number, the function will
14407 be called every @var{time} minutes only when Emacs has been idle for
14408 @var{idle} minutes.
14409
14410 If @var{idle} is a number and @var{time} is @code{nil}, the function
14411 will be called once every time Emacs has been idle for @var{idle}
14412 minutes.
14413
14414 And if @var{time} is a string, it should look like @samp{07:31}, and
14415 the function will then be called once every day somewhere near that
14416 time.  Modified by the @var{idle} parameter, of course.
14417
14418 @vindex gnus-demon-timestep
14419 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
14420 seconds.  This is 60 by default.  If you change that variable,
14421 all the timings in the handlers will be affected.)
14422
14423 @vindex gnus-use-demon
14424 To set the whole thing in motion, though, you have to set
14425 @code{gnus-use-demon} to @code{t}.
14426
14427 So, if you want to add a handler, you could put something like this in
14428 your @file{.gnus} file:
14429
14430 @findex gnus-demon-add-handler
14431 @lisp
14432 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
14433 @end lisp
14434
14435 @findex gnus-demon-add-nocem
14436 @findex gnus-demon-add-scanmail
14437 @findex gnus-demon-add-rescan
14438 @findex gnus-demon-add-scan-timestamps
14439 @findex gnus-demon-add-disconnection
14440 Some ready-made functions to do this have been created:
14441 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
14442 @code{gnus-demon-add-nntp-close-connection},
14443 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
14444 @code{gnus-demon-add-scanmail}.  Just put those functions in your
14445 @file{.gnus} if you want those abilities.
14446
14447 @findex gnus-demon-init
14448 @findex gnus-demon-cancel
14449 @vindex gnus-demon-handlers
14450 If you add handlers to @code{gnus-demon-handlers} directly, you should
14451 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
14452 daemons, you can use the @code{gnus-demon-cancel} function.
14453
14454 Note that adding daemons can be pretty naughty if you over do it.  Adding
14455 functions that scan all news and mail from all servers every two seconds
14456 is a sure-fire way of getting booted off any respectable system.  So
14457 behave.
14458
14459
14460 @node NoCeM
14461 @section NoCeM
14462 @cindex nocem
14463 @cindex spam
14464
14465 @dfn{Spamming} is posting the same article lots and lots of times.
14466 Spamming is bad.  Spamming is evil.
14467
14468 Spamming is usually canceled within a day or so by various anti-spamming
14469 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
14470 NoCeM is pronounced ``no see-'em'', and means what the name
14471 implies---these are messages that make the offending articles, like, go
14472 away.
14473
14474 What use are these NoCeM messages if the articles are canceled anyway?
14475 Some sites do not honor cancel messages and some sites just honor cancels
14476 from a select few people.  Then you may wish to make use of the NoCeM
14477 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
14478
14479 Gnus can read and parse the messages in this group automatically, and
14480 this will make spam disappear.
14481
14482 There are some variables to customize, of course:
14483
14484 @table @code
14485 @item gnus-use-nocem
14486 @vindex gnus-use-nocem
14487 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
14488 by default.
14489
14490 @item gnus-nocem-groups
14491 @vindex gnus-nocem-groups
14492 Gnus will look for NoCeM messages in the groups in this list.  The
14493 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
14494 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
14495
14496 @item gnus-nocem-issuers
14497 @vindex gnus-nocem-issuers
14498 There are many people issuing NoCeM messages.  This list says what
14499 people you want to listen to.  The default is @code{("Automoose-1"
14500 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
14501 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
14502 (Richard E. Depew)")}; fine, upstanding citizens all of them.
14503
14504 Known despammers that you can put in this list include:
14505
14506 @table @samp
14507 @item clewis@@ferret.ocunix.on.ca;
14508 @cindex Chris Lewis
14509 Chris Lewis---Major Canadian despammer who has probably canceled more
14510 usenet abuse than anybody else.
14511
14512 @item Automoose-1
14513 @cindex CancelMoose[tm]
14514 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
14515 Norwegian, and was the person(s) who invented NoCeM.
14516
14517 @item jem@@xpat.com;
14518 @cindex Jem
14519 John Milburn---despammer located in Korea who is getting very busy these
14520 days.
14521
14522 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
14523 Richard E. Depew---lone American despammer.  He mostly cancels binary
14524 postings to non-binary groups and removes spews (regurgitated articles).
14525 @end table
14526
14527 You do not have to heed NoCeM messages from all these people---just the
14528 ones you want to listen to.  You also don't have to accept all NoCeM
14529 messages from the people you like.  Each NoCeM message has a @dfn{type}
14530 header that gives the message a (more or less, usually less) rigorous
14531 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
14532 @samp{binary}, and @samp{troll}.  To specify this, you have to use
14533 @var{(issuer conditions ...)} elements in the list.  Each condition is
14534 either a string (which is a regexp that matches types you want to use)
14535 or a list on the form @code{(not STRING)}, where @var{string} is a
14536 regexp that matches types you don't want to use.
14537
14538 For instance, if you want all NoCeM messages from Chris Lewis except his
14539 @samp{troll} messages, you'd say:
14540
14541 @lisp
14542 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
14543 @end lisp
14544
14545 On the other hand, if you just want nothing but his @samp{spam} and
14546 @samp{spew} messages, you'd say:
14547
14548 @lisp
14549 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
14550 @end lisp
14551
14552 The specs are applied left-to-right.
14553
14554
14555 @item gnus-nocem-verifyer
14556 @vindex gnus-nocem-verifyer
14557 @findex mc-verify
14558 This should be a function for verifying that the NoCeM issuer is who she
14559 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
14560 function.  If this is too slow and you don't care for verification
14561 (which may be dangerous), you can set this variable to @code{nil}.
14562
14563 If you want signed NoCeM messages to be verified and unsigned messages
14564 not to be verified (but used anyway), you could do something like:
14565
14566 @lisp
14567 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
14568
14569 (defun my-gnus-mc-verify ()
14570   (not (eq 'forged
14571            (ignore-errors
14572              (if (mc-verify)
14573                  t
14574                'forged)))))
14575 @end lisp
14576
14577 This might be dangerous, though.
14578
14579 @item gnus-nocem-directory
14580 @vindex gnus-nocem-directory
14581 This is where Gnus will store its NoCeM cache files.  The default is
14582 @file{~/News/NoCeM/}.
14583
14584 @item gnus-nocem-expiry-wait
14585 @vindex gnus-nocem-expiry-wait
14586 The number of days before removing old NoCeM entries from the cache.
14587 The default is 15.  If you make it shorter Gnus will be faster, but you
14588 might then see old spam.
14589
14590 @end table
14591
14592 Using NoCeM could potentially be a memory hog.  If you have many living
14593 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
14594 big.  If this is a problem, you should kill off all (or most) of your
14595 unsubscribed groups (@pxref{Subscription Commands}).
14596
14597
14598 @node Undo
14599 @section Undo
14600 @cindex undo
14601
14602 It is very useful to be able to undo actions one has done.  In normal
14603 Emacs buffers, it's easy enough---you just push the @code{undo} button.
14604 In Gnus buffers, however, it isn't that simple.
14605
14606 The things Gnus displays in its buffer is of no value whatsoever to
14607 Gnus---it's all just data designed to look nice to the user.
14608 Killing a group in the group buffer with @kbd{C-k} makes the line
14609 disappear, but that's just a side-effect of the real action---the
14610 removal of the group in question from the internal Gnus structures.
14611 Undoing something like that can't be done by the normal Emacs
14612 @code{undo} function.
14613
14614 Gnus tries to remedy this somewhat by keeping track of what the user
14615 does and coming up with actions that would reverse the actions the user
14616 takes.  When the user then presses the @code{undo} key, Gnus will run
14617 the code to reverse the previous action, or the previous actions.
14618 However, not all actions are easily reversible, so Gnus currently offers
14619 a few key functions to be undoable.  These include killing groups,
14620 yanking groups, and changing the list of read articles of groups.
14621 That's it, really.  More functions may be added in the future, but each
14622 added function means an increase in data to be stored, so Gnus will
14623 never be totally undoable.
14624
14625 @findex gnus-undo-mode
14626 @vindex gnus-use-undo
14627 @findex gnus-undo
14628 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
14629 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
14630 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
14631 command, which should feel kinda like the normal Emacs @code{undo}
14632 command.
14633
14634
14635 @node Moderation
14636 @section Moderation
14637 @cindex moderation
14638
14639 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
14640 It is not included in the standard Gnus package.  Write a mail to
14641 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
14642 get a copy.
14643
14644 The moderation package is implemented as a minor mode for summary
14645 buffers.  Put
14646
14647 @lisp
14648 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
14649 @end lisp
14650
14651 in your @file{.gnus.el} file.
14652
14653 If you are the moderator of @samp{rec.zoofle}, this is how it's
14654 supposed to work:
14655
14656 @enumerate
14657 @item
14658 You split your incoming mail by matching on
14659 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
14660 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
14661
14662 @item
14663 You enter that group once in a while and post articles using the @kbd{e}
14664 (edit-and-post) or @kbd{s} (just send unedited) commands.
14665
14666 @item
14667 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
14668 articles that weren't approved by you, you can cancel them with the
14669 @kbd{c} command.
14670 @end enumerate
14671
14672 To use moderation mode in these two groups, say:
14673
14674 @lisp
14675 (setq gnus-moderated-list
14676       "^nnml:rec.zoofle$\\|^rec.zoofle$")
14677 @end lisp
14678
14679
14680 @node XEmacs Enhancements
14681 @section XEmacs Enhancements
14682 @cindex XEmacs
14683
14684 XEmacs is able to display pictures and stuff, so Gnus has taken
14685 advantage of that.
14686
14687 @menu
14688 * Picons::    How to display pictures of what your reading.
14689 * Smileys::   Show all those happy faces the way they were meant to be shown.
14690 * Toolbar::   Click'n'drool.
14691 * XVarious::  Other XEmacsy Gnusey variables.
14692 @end menu
14693
14694
14695 @node Picons
14696 @subsection Picons
14697
14698 @iftex
14699 @iflatex
14700 \include{picons}
14701 @end iflatex
14702 @end iftex
14703
14704 So...  You want to slow down your news reader even more!  This is a
14705 good way to do so.  Its also a great way to impress people staring
14706 over your shoulder as you read news.
14707
14708 @menu
14709 * Picon Basics::           What are picons and How do I get them.
14710 * Picon Requirements::     Don't go further if you aren't using XEmacs.
14711 * Easy Picons::            Displaying Picons---the easy way.
14712 * Hard Picons::            The way you should do it.  You'll learn something.
14713 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
14714 @end menu
14715
14716
14717 @node Picon Basics
14718 @subsubsection Picon Basics
14719
14720 What are Picons?  To quote directly from the Picons Web site:
14721
14722 @iftex
14723 @iflatex
14724 \margindex{}
14725 @end iflatex
14726 @end iftex
14727
14728 @quotation
14729 @dfn{Picons} is short for ``personal icons''.  They're small,
14730 constrained images used to represent users and domains on the net,
14731 organized into databases so that the appropriate image for a given
14732 e-mail address can be found.  Besides users and domains, there are picon
14733 databases for Usenet newsgroups and weather forecasts.  The picons are
14734 in either monochrome @code{XBM} format or color @code{XPM} and
14735 @code{GIF} formats.
14736 @end quotation
14737
14738 @vindex gnus-picons-piconsearch-url
14739 If you have a permanent connection to the Internet you can use Steve
14740 Kinzler's Picons Search engine by setting
14741 @code{gnus-picons-piconsearch-url} to the string
14742 @file{http://www.cs.indiana.edu/picons/search.html}.
14743
14744 @vindex gnus-picons-database
14745 Otherwise you need a local copy of his database.  For instructions on
14746 obtaining and installing the picons databases, point your Web browser at
14747 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
14748 picons to be installed into a location pointed to by
14749 @code{gnus-picons-database}.
14750
14751
14752 @node Picon Requirements
14753 @subsubsection Picon Requirements
14754
14755 To have Gnus display Picons for you, you must be running XEmacs
14756 19.13 or greater since all other versions of Emacs aren't yet able to
14757 display images.
14758
14759 Additionally, you must have @code{x} support compiled into XEmacs.  To
14760 display color picons which are much nicer than the black & white one,
14761 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
14762
14763 @vindex gnus-picons-convert-x-face
14764 If you want to display faces from @code{X-Face} headers, you should have
14765 the @code{xface} support compiled into XEmacs.  Otherwise you must have
14766 the @code{netpbm} utilities installed, or munge the
14767 @code{gnus-picons-convert-x-face} variable to use something else.
14768
14769
14770 @node Easy Picons
14771 @subsubsection Easy Picons
14772
14773 To enable displaying picons, simply put the following line in your
14774 @file{~/.gnus} file and start Gnus.
14775
14776 @lisp
14777 (setq gnus-use-picons t)
14778 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14779 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
14780 @end lisp
14781
14782 and make sure @code{gnus-picons-database} points to the directory
14783 containing the Picons databases.
14784
14785 Alternatively if you want to use the web piconsearch engine add this:
14786
14787 @lisp
14788 (setq gnus-picons-piconsearch-url "http://www.cs.indiana.edu:800/piconsearch")
14789 @end lisp
14790
14791
14792 @node Hard Picons
14793 @subsubsection Hard Picons
14794
14795 @iftex
14796 @iflatex
14797 \margindex{}
14798 @end iflatex
14799 @end iftex
14800
14801 Gnus can display picons for you as you enter and leave groups and
14802 articles.  It knows how to interact with three sections of the picons
14803 database.  Namely, it can display the picons newsgroup pictures,
14804 author's face picture(s), and the authors domain.  To enable this
14805 feature, you need to select where to get the picons from, and where to
14806 display them.
14807
14808 @table @code
14809
14810 @item gnus-picons-database
14811 @vindex gnus-picons-database
14812 The location of the picons database.  Should point to a directory
14813 containing the @file{news}, @file{domains}, @file{users} (and so on)
14814 subdirectories.  This is only useful if
14815 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
14816 @file{/usr/local/faces/}.
14817
14818 @item gnus-picons-piconsearch-url
14819 @vindex gnus-picons-piconsearch-url
14820 The URL for the web picons search engine.  The only currently known
14821 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
14822 workaround network delays, icons will be fetched in the background.  If
14823 this is @code{nil} 'the default), then picons are fetched from local
14824 database indicated by @code{gnus-picons-database}.
14825
14826 @item gnus-picons-display-where
14827 @vindex gnus-picons-display-where
14828 Where the picon images should be displayed.  It is @code{picons} by
14829 default (which by default maps to the buffer @samp{*Picons*}).  Other
14830 valid places could be @code{article}, @code{summary}, or
14831 @samp{*scratch*} for all I care.  Just make sure that you've made the
14832 buffer visible using the standard Gnus window configuration
14833 routines---@pxref{Windows Configuration}.
14834
14835 @item gnus-picons-group-excluded-groups
14836 @vindex gnus-picons-group-excluded-groups
14837 Groups that are matched by this regexp won't have their group icons
14838 displayed.
14839
14840 @end table
14841
14842 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
14843 window configuration for you to include the @code{picons} buffer.
14844
14845 Now that you've made those decision, you need to add the following
14846 functions to the appropriate hooks so these pictures will get displayed
14847 at the right time.
14848
14849 @vindex gnus-article-display-hook
14850 @vindex gnus-picons-display-where
14851 @table @code
14852 @item gnus-article-display-picons
14853 @findex gnus-article-display-picons
14854 Looks up and displays the picons for the author and the author's domain
14855 in the @code{gnus-picons-display-where} buffer.  Should be added to the
14856 @code{gnus-article-display-hook}.
14857
14858 @item gnus-picons-article-display-x-face
14859 @findex gnus-article-display-picons
14860 Decodes and displays the X-Face header if present.  This function
14861 should be added to @code{gnus-article-display-hook}.
14862
14863 @end table
14864
14865 Note:  You must append them to the hook, so make sure to specify 't'
14866 for the append flag of @code{add-hook}:
14867
14868 @lisp
14869 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14870 @end lisp
14871
14872
14873 @node Picon Useless Configuration
14874 @subsubsection Picon Useless Configuration
14875
14876 @iftex
14877 @iflatex
14878 \margindex{}
14879 @end iflatex
14880 @end iftex
14881
14882 The following variables offer further control over how things are
14883 done, where things are located, and other useless stuff you really
14884 don't need to worry about.
14885
14886 @table @code
14887
14888 @item gnus-picons-news-directories
14889 @vindex gnus-picons-news-directories
14890 List of subdirectories to search in @code{gnus-picons-database} for
14891 newsgroups faces.  @code{("news")} is the default.
14892
14893 @item gnus-picons-user-directories
14894 @vindex gnus-picons-user-directories
14895 List of subdirectories to search in @code{gnus-picons-database} for user
14896 faces.  @code{("local" "users" "usenix" "misc")} is the default.
14897
14898 @item gnus-picons-domain-directories
14899 @vindex gnus-picons-domain-directories
14900 List of subdirectories to search in @code{gnus-picons-database} for
14901 domain name faces.  Defaults to @code{("domains")}.  Some people may
14902 want to add @samp{"unknown"} to this list.
14903
14904 @item gnus-picons-convert-x-face
14905 @vindex gnus-picons-convert-x-face
14906 If you don't have @code{xface} support builtin XEmacs, this is the
14907 command to use to convert the @code{X-Face} header to an X bitmap
14908 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
14909 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
14910 gnus-picons-x-face-file-name)}
14911
14912 @item gnus-picons-x-face-file-name
14913 @vindex gnus-picons-x-face-file-name
14914 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
14915 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
14916
14917 @item gnus-picons-has-modeline-p
14918 @vindex gnus-picons-has-modeline-p
14919 If you have set @code{gnus-picons-display-where} to @code{picons}, your
14920 XEmacs frame will become really cluttered.  To alleviate this a bit you
14921 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
14922 remove the mode line from the Picons buffer.  This is only useful if
14923 @code{gnus-picons-display-where} is @code{picons}.
14924
14925 @item gnus-picons-refresh-before-display
14926 @vindex gnus-picons-refresh-before-display
14927 If non-nil, display the article buffer before computing the picons.
14928 Defaults to @code{nil}.
14929
14930 @item gnus-picons-display-as-address
14931 @vindex gnus-picons-display-as-address
14932 If @code{t} display textual email addresses along with pictures.
14933 Defaults to @code{t}.
14934
14935 @item gnus-picons-file-suffixes
14936 @vindex gnus-picons-file-suffixes
14937 Ordered list of suffixes on picon file names to try.  Defaults to
14938 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
14939
14940 @item gnus-picons-display-article-move-p
14941 @vindex gnus-picons-display-article-move-p
14942 Whether to move point to first empty line when displaying picons.  This
14943 has only an effect if `gnus-picons-display-where' has value `article'.
14944
14945 @item gnus-picons-clear-cache-on-shutdown
14946 @vindex gnus-picons-clear-cache-on-shutdown
14947 Whether to clear the picons cache when exiting gnus.  Gnus caches every
14948 picons it finds while it is running.  This saves some time in the search
14949 process but eats some memory.  If this variable is set to @code{nil},
14950 Gnus will never clear the cache itself; you will have to manually call
14951 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
14952 cleared every time you exit Gnus.  Defaults to @code{t}.
14953
14954 @iftex
14955 @iflatex
14956 \margindex{}
14957 @end iflatex
14958 @end iftex
14959
14960 @end table
14961
14962 @node Smileys
14963 @subsection Smileys
14964 @cindex smileys
14965
14966 @iftex
14967 @iflatex
14968 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
14969 \input{smiley}
14970 @end iflatex
14971 @end iftex
14972
14973 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
14974 currently the only package that uses Smiley, it is documented here.
14975
14976 In short---to use Smiley in Gnus, put the following in your
14977 @file{.gnus.el} file:
14978
14979 @lisp
14980 (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
14981 @end lisp
14982
14983 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
14984 the like---to pictures and displays those instead of the text smiley
14985 faces.  The conversion is controlled by a list of regexps that matches
14986 text and maps that to file names.
14987
14988 @vindex smiley-nosey-regexp-alist
14989 @vindex smiley-deformed-regexp-alist
14990 Smiley supplies two example conversion alists by default:
14991 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
14992 and so on), and @code{smiley-nosey-regexp-alist} (which matches
14993 @samp{:-)}, @samp{:-(} and so on).
14994
14995 The alist used is specified by the @code{smiley-regexp-alist} variable,
14996 which defaults to the value of @code{smiley-deformed-regexp-alist}.
14997
14998 The first item in each element is the regexp to be matched; the second
14999 element is the regexp match group that is to be replaced by the picture;
15000 and the third element is the name of the file to be displayed.
15001
15002 The following variables customize where Smiley will look for these
15003 files, as well as the color to be used and stuff:
15004
15005 @table @code
15006
15007 @item smiley-data-directory
15008 @vindex smiley-data-directory
15009 Where Smiley will look for smiley faces files.
15010
15011 @item smiley-flesh-color
15012 @vindex smiley-flesh-color
15013 Skin color.  The default is @samp{yellow}, which is really racist.
15014
15015 @item smiley-features-color
15016 @vindex smiley-features-color
15017 Color of the features of the face.  The default is @samp{black}.
15018
15019 @item smiley-tongue-color
15020 @vindex smiley-tongue-color
15021 Color of the tongue.  The default is @samp{red}.
15022
15023 @item smiley-circle-color
15024 @vindex smiley-circle-color
15025 Color of the circle around the face.  The default is @samp{black}.
15026
15027 @item smiley-mouse-face
15028 @vindex smiley-mouse-face
15029 Face used for mouse highlighting over the smiley face.
15030
15031 @end table
15032
15033
15034 @node Toolbar
15035 @subsection Toolbar
15036
15037 @table @code
15038
15039 @iftex
15040 @iflatex
15041 \margindex{}
15042 @end iflatex
15043 @end iftex
15044
15045 @item gnus-use-toolbar
15046 @vindex gnus-use-toolbar
15047 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
15048 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
15049 @code{right-toolbar}, or @code{left-toolbar}.
15050
15051 @item gnus-group-toolbar
15052 @vindex gnus-group-toolbar
15053 The toolbar in the group buffer.
15054
15055 @item gnus-summary-toolbar
15056 @vindex gnus-summary-toolbar
15057 The toolbar in the summary buffer.
15058
15059 @item gnus-summary-mail-toolbar
15060 @vindex gnus-summary-mail-toolbar
15061 The toolbar in the summary buffer of mail groups.
15062
15063 @end table
15064
15065
15066 @node XVarious
15067 @subsection Various XEmacs Variables
15068
15069 @table @code
15070 @item gnus-xmas-glyph-directory
15071 @vindex gnus-xmas-glyph-directory
15072 This is where Gnus will look for pictures.  Gnus will normally
15073 auto-detect this directory, but you may set it manually if you have an
15074 unusual directory structure.
15075
15076 @item gnus-xmas-logo-color-alist
15077 @vindex gnus-xmas-logo-color-alist
15078 This is an alist where the key is a type symbol and the values are the
15079 foreground and background color of the splash page glyph.
15080
15081 @item gnus-xmas-logo-color-style
15082 @vindex gnus-xmas-logo-color-style
15083 This is the key used to look up the color in the alist described above.
15084 Legal values include @code{flame}, @code{pine}, @code{moss},
15085 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
15086 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
15087
15088 @item gnus-xmas-modeline-glyph
15089 @vindex gnus-xmas-modeline-glyph
15090 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
15091 default.
15092
15093 @iftex
15094 @iflatex
15095 \margindex{}
15096 @end iflatex
15097 @end iftex
15098
15099 @end table
15100
15101
15102
15103
15104 @node Fuzzy Matching
15105 @section Fuzzy Matching
15106 @cindex fuzzy matching
15107
15108 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
15109 things like scoring, thread gathering and thread comparison.
15110
15111 As opposed to regular expression matching, fuzzy matching is very fuzzy.
15112 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
15113 means, and the implementation has changed over time.
15114
15115 Basically, it tries to remove all noise from lines before comparing.
15116 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
15117 out of the strings before comparing the results.  This often leads to
15118 adequate results---even when faced with strings generated by text
15119 manglers masquerading as newsreaders.
15120
15121
15122 @node Thwarting Email Spam
15123 @section Thwarting Email Spam
15124 @cindex email spam
15125 @cindex spam
15126 @cindex UCE
15127 @cindex unsolicited commercial email
15128
15129 In these last days of the Usenet, commercial vultures are hanging about
15130 and grepping through news like crazy to find email addresses they can
15131 foist off their scams and products to.  As a reaction to this, many
15132 people have started putting nonsense addresses into their @code{From}
15133 lines.  I think this is counterproductive---it makes it difficult for
15134 people to send you legitimate mail in response to things you write, as
15135 well as making it difficult to see who wrote what.  This rewriting may
15136 perhaps be a bigger menace than the unsolicited commercial email itself
15137 in the end.
15138
15139 The biggest problem I have with email spam is that it comes in under
15140 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
15141 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
15142 mail group, only to find two pyramid schemes, seven advertisements
15143 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
15144 and one mail asking me to repent and find some god.
15145
15146 This is annoying.
15147
15148 The way to deal with this is having Gnus split out all spam into a
15149 @samp{spam} mail group (@pxref{Splitting Mail}).
15150
15151 First, pick one (1) valid mail address that you can be reached at, and
15152 put it in your @code{From} header of all your news articles.  (I've
15153 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
15154 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
15155 sysadm whether your sendmail installation accepts keywords in the local
15156 part of the mail address.)
15157
15158 @lisp
15159 (setq message-default-news-headers
15160       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
15161 @end lisp
15162
15163 Then put the following split rule in @code{nnmail-split-fancy}
15164 (@pxref{Fancy Mail Splitting}):
15165
15166 @lisp
15167 (
15168  ...
15169  (to "larsi@@trym.ifi.uio.no"
15170       (| ("subject" "re:.*" "misc")
15171          ("references" ".*@@.*" "misc")
15172          "spam"))
15173  ...
15174 )
15175 @end lisp
15176
15177 This says that all mail to this address is suspect, but if it has a
15178 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
15179 header, it's probably ok.  All the rest goes to the @samp{spam} group.
15180 (This idea probably comes from Tim Pierce.)
15181
15182 In addition, many mail spammers talk directly to your @code{smtp} server
15183 and do not include your email address explicitly in the @code{To}
15184 header.  Why they do this is unknown---perhaps it's to thwart this
15185 thwarting scheme?  In any case, this is trivial to deal with---you just
15186 put anything not addressed to you in the @samp{spam} group by ending
15187 your fancy split rule in this way:
15188
15189 @lisp
15190 (
15191  ...
15192  (to "larsi" "misc")
15193  "spam")
15194 @end lisp
15195
15196 In my experience, this will sort virtually everything into the right
15197 group.  You still have to check the @samp{spam} group from time to time to
15198 check for legitimate mail, though.  If you feel like being a good net
15199 citizen, you can even send off complaints to the proper authorities on
15200 each unsolicited commercial email---at your leisure.
15201
15202 If you are also a lazy net citizen, you will probably prefer complaining
15203 automatically with the @file{gnus-junk.el} package, available FOR FREE
15204 at @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
15205 Since most e-mail spam is sent automatically, this may reconcile the
15206 cosmic balance somewhat.
15207
15208 This works for me.  It allows people an easy way to contact me (they can
15209 just press @kbd{r} in the usual way), and I'm not bothered at all with
15210 spam.  It's a win-win situation.  Forging @code{From} headers to point
15211 to non-existent domains is yucky, in my opinion.
15212
15213
15214 @node Various Various
15215 @section Various Various
15216 @cindex mode lines
15217 @cindex highlights
15218
15219 @table @code
15220
15221 @item gnus-home-directory
15222 All Gnus path variables will be initialized from this variable, which
15223 defaults to @file{~/}.
15224
15225 @item gnus-directory
15226 @vindex gnus-directory
15227 Most Gnus storage path variables will be initialized from this variable,
15228 which defaults to the @samp{SAVEDIR} environment variable, or
15229 @file{~/News/} if that variable isn't set.
15230
15231 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
15232 This means that other directory variables that are initialized from this
15233 variable won't be set properly if you set this variable in
15234 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
15235
15236 @item gnus-default-directory
15237 @vindex gnus-default-directory
15238 Not related to the above variable at all---this variable says what the
15239 default directory of all Gnus buffers should be.  If you issue commands
15240 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
15241 default directory.  If this variable is @code{nil} (which is the
15242 default), the default directory will be the default directory of the
15243 buffer you were in when you started Gnus.
15244
15245 @item gnus-verbose
15246 @vindex gnus-verbose
15247 This variable is an integer between zero and ten.  The higher the value,
15248 the more messages will be displayed.  If this variable is zero, Gnus
15249 will never flash any messages, if it is seven (which is the default),
15250 most important messages will be shown, and if it is ten, Gnus won't ever
15251 shut up, but will flash so many messages it will make your head swim.
15252
15253 @item gnus-verbose-backends
15254 @vindex gnus-verbose-backends
15255 This variable works the same way as @code{gnus-verbose}, but it applies
15256 to the Gnus backends instead of Gnus proper.
15257
15258 @item nnheader-max-head-length
15259 @vindex nnheader-max-head-length
15260 When the backends read straight heads of articles, they all try to read
15261 as little as possible.  This variable (default 4096) specifies
15262 the absolute max length the backends will try to read before giving up
15263 on finding a separator line between the head and the body.  If this
15264 variable is @code{nil}, there is no upper read bound.  If it is
15265 @code{t}, the backends won't try to read the articles piece by piece,
15266 but read the entire articles.  This makes sense with some versions of
15267 @code{ange-ftp} or @code{efs}.
15268
15269 @item nnheader-head-chop-length
15270 @vindex nnheader-head-chop-length
15271 This variable (default 2048) says how big a piece of each article to
15272 read when doing the operation described above.
15273
15274 @item nnheader-file-name-translation-alist
15275 @vindex nnheader-file-name-translation-alist
15276 @cindex file names
15277 @cindex invalid characters in file names
15278 @cindex characters in file names
15279 This is an alist that says how to translate characters in file names.
15280 For instance, if @samp{:} is invalid as a file character in file names
15281 on your system (you OS/2 user you), you could say something like:
15282
15283 @lisp
15284 (setq nnheader-file-name-translation-alist
15285       '((?: . ?_)))
15286 @end lisp
15287
15288 In fact, this is the default value for this variable on OS/2 and MS
15289 Windows (phooey) systems.
15290
15291 @item gnus-hidden-properties
15292 @vindex gnus-hidden-properties
15293 This is a list of properties to use to hide ``invisible'' text.  It is
15294 @code{(invisible t intangible t)} by default on most systems, which
15295 makes invisible text invisible and intangible.
15296
15297 @item gnus-parse-headers-hook
15298 @vindex gnus-parse-headers-hook
15299 A hook called before parsing headers.  It can be used, for instance, to
15300 gather statistics on the headers fetched, or perhaps you'd like to prune
15301 some headers.  I don't see why you'd want that, though.
15302
15303 @item gnus-shell-command-separator
15304 @vindex gnus-shell-command-separator
15305 String used to separate two shell commands.  The default is @samp{;}.
15306
15307
15308 @end table
15309
15310
15311 @node The End
15312 @chapter The End
15313
15314 Well, that's the manual---you can get on with your life now.  Keep in
15315 touch.  Say hello to your cats from me.
15316
15317 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
15318
15319 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
15320
15321 @quotation
15322 @strong{Te Deum}
15323
15324 @sp 1
15325 Not because of victories @*
15326 I sing,@*
15327 having none,@*
15328 but for the common sunshine,@*
15329 the breeze,@*
15330 the largess of the spring.
15331
15332 @sp 1
15333 Not for victory@*
15334 but for the day's work done@*
15335 as well as I was able;@*
15336 not for a seat upon the dais@*
15337 but at the common table.@*
15338 @end quotation
15339
15340
15341 @node Appendices
15342 @chapter Appendices
15343
15344 @menu
15345 * History::                        How Gnus got where it is today.
15346 * Terminology::                    We use really difficult, like, words here.
15347 * Customization::                  Tailoring Gnus to your needs.
15348 * Troubleshooting::                What you might try if things do not work.
15349 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
15350 * Emacs for Heathens::             A short introduction to Emacsian terms.
15351 * Frequently Asked Questions::     A question-and-answer session.
15352 @end menu
15353
15354
15355 @node History
15356 @section History
15357
15358 @cindex history
15359 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
15360 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
15361
15362 If you want to investigate the person responsible for this outrage, you
15363 can point your (feh!) web browser to
15364 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
15365 distribution point for the new and spiffy versions of Gnus, and is known
15366 as The Site That Destroys Newsrcs And Drives People Mad.
15367
15368 During the first extended alpha period of development, the new Gnus was
15369 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
15370 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
15371 (Besides, the ``Gnus'' in this abbreviation should probably be
15372 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
15373 appropriate name, don't you think?)
15374
15375 In any case, after spending all that energy on coming up with a new and
15376 spunky name, we decided that the name was @emph{too} spunky, so we
15377 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
15378 ``@sc{gnus}''.  New vs. old.
15379
15380 The first ``proper'' release of Gnus 5 was done in November 1995 when it
15381 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
15382 plus 15 Gnus 5.0 releases).
15383
15384 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
15385 releases)) was released under the name ``Gnus 5.2'' (40 releases).
15386
15387 On July 28th 1996 work on Red Gnus was begun, and it was released on
15388 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
15389
15390 On September 13th 1997, Quassia Gnus was started and lasted 37
15391 releases.  If was released as ``Gnus 5.6.25' on March 8th 1998.
15392
15393 If you happen upon a version of Gnus that has a prefixed name --
15394 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
15395 don't panic.  Don't let it know that you're frightened.  Back away.
15396 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
15397 out of its reach.  Find a proper released version of Gnus and snuggle up
15398 to that instead.
15399
15400 @menu
15401 * Why?::                What's the point of Gnus?
15402 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
15403 * Conformity::          Gnus tries to conform to all standards.
15404 * Emacsen::             Gnus can be run on a few modern Emacsen.
15405 * Contributors::        Oodles of people.
15406 * New Features::        Pointers to some of the new stuff in Gnus.
15407 * Newest Features::     Features so new that they haven't been written yet.
15408 @end menu
15409
15410
15411 @node Why?
15412 @subsection Why?
15413
15414 What's the point of Gnus?
15415
15416 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
15417 newsreader, that lets you do anything you can think of.  That was my
15418 original motivation, but while working on Gnus, it has become clear to
15419 me that this generation of newsreaders really belong in the stone age.
15420 Newsreaders haven't developed much since the infancy of the net.  If the
15421 volume continues to rise with the current rate of increase, all current
15422 newsreaders will be pretty much useless.  How do you deal with
15423 newsgroups that have thousands of new articles each day?  How do you
15424 keep track of millions of people who post?
15425
15426 Gnus offers no real solutions to these questions, but I would very much
15427 like to see Gnus being used as a testing ground for new methods of
15428 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
15429 to separate the newsreader from the backends, Gnus now offers a simple
15430 interface for anybody who wants to write new backends for fetching mail
15431 and news from different sources.  I have added hooks for customizations
15432 everywhere I could imagine it being useful.  By doing so, I'm inviting
15433 every one of you to explore and invent.
15434
15435 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
15436 @kbd{C-u 100 M-x all-hail-xemacs}.
15437
15438
15439 @node Compatibility
15440 @subsection Compatibility
15441
15442 @cindex compatibility
15443 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
15444 bindings have been kept.  More key bindings have been added, of course,
15445 but only in one or two obscure cases have old bindings been changed.
15446
15447 Our motto is:
15448 @quotation
15449 @cartouche
15450 @center In a cloud bones of steel.
15451 @end cartouche
15452 @end quotation
15453
15454 All commands have kept their names.  Some internal functions have changed
15455 their names.
15456
15457 The @code{gnus-uu} package has changed drastically. @xref{Decoding
15458 Articles}.
15459
15460 One major compatibility question is the presence of several summary
15461 buffers.  All variables relevant while reading a group are
15462 buffer-local to the summary buffer they belong in.  Although many
15463 important variables have their values copied into their global
15464 counterparts whenever a command is executed in the summary buffer, this
15465 change might lead to incorrect values being used unless you are careful.
15466
15467 All code that relies on knowledge of @sc{gnus} internals will probably
15468 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
15469 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
15470 maintains a hash table that points to the entries in this alist (which
15471 speeds up many functions), and changing the alist directly will lead to
15472 peculiar results.
15473
15474 @cindex hilit19
15475 @cindex highlighting
15476 Old hilit19 code does not work at all.  In fact, you should probably
15477 remove all hilit code from all Gnus hooks
15478 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
15479 Gnus provides various integrated functions for highlighting.  These are
15480 faster and more accurate.  To make life easier for everybody, Gnus will
15481 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
15482 Away!
15483
15484 Packages like @code{expire-kill} will no longer work.  As a matter of
15485 fact, you should probably remove all old @sc{gnus} packages (and other
15486 code) when you start using Gnus.  More likely than not, Gnus already
15487 does what you have written code to make @sc{gnus} do.  (Snicker.)
15488
15489 Even though old methods of doing things are still supported, only the
15490 new methods are documented in this manual.  If you detect a new method of
15491 doing something while reading this manual, that does not mean you have
15492 to stop doing it the old way.
15493
15494 Gnus understands all @sc{gnus} startup files.
15495
15496 @kindex M-x gnus-bug
15497 @findex gnus-bug
15498 @cindex reporting bugs
15499 @cindex bugs
15500 Overall, a casual user who hasn't written much code that depends on
15501 @sc{gnus} internals should suffer no problems.  If problems occur,
15502 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
15503
15504 @vindex gnus-bug-create-help-buffer
15505 If you are in the habit of sending bug reports @emph{very} often, you
15506 may find the helpful help buffer annoying after a while.  If so, set
15507 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
15508 up at you.
15509
15510
15511 @node Conformity
15512 @subsection Conformity
15513
15514 No rebels without a clue here, ma'am.  We conform to all standards known
15515 to (wo)man.  Except for those standards and/or conventions we disagree
15516 with, of course.
15517
15518 @table @strong
15519
15520 @item RFC 822
15521 @cindex RFC 822
15522 There are no known breaches of this standard.
15523
15524 @item RFC 1036
15525 @cindex RFC 1036
15526 There are no known breaches of this standard, either.
15527
15528 @item Son-of-RFC 1036
15529 @cindex Son-of-RFC 1036
15530 We do have some breaches to this one.
15531
15532 @table @emph
15533
15534 @item MIME
15535 Gnus does no MIME handling, and this standard-to-be seems to think that
15536 MIME is the bees' knees, so we have major breakage here.
15537
15538 @item X-Newsreader
15539 This is considered to be a ``vanity header'', while I consider it to be
15540 consumer information.  After seeing so many badly formatted articles
15541 coming from @code{tin} and @code{Netscape} I know not to use either of
15542 those for posting articles.  I would not have known that if it wasn't
15543 for the @code{X-Newsreader} header.
15544 @end table
15545
15546 @end table
15547
15548 If you ever notice Gnus acting non-compliant with regards to the texts
15549 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
15550 know.
15551
15552
15553 @node Emacsen
15554 @subsection Emacsen
15555 @cindex Emacsen
15556 @cindex XEmacs
15557 @cindex Mule
15558 @cindex Emacs
15559
15560 Gnus should work on :
15561
15562 @itemize @bullet
15563
15564 @item
15565 Emacs 19.32 and up.
15566
15567 @item
15568 XEmacs 19.14 and up.
15569
15570 @item
15571 Mule versions based on Emacs 19.32 and up.
15572
15573 @end itemize
15574
15575 Gnus will absolutely not work on any Emacsen older than that.  Not
15576 reliably, at least.
15577
15578 There are some vague differences between Gnus on the various
15579 platforms---XEmacs features more graphics (a logo and a toolbar)---but
15580 other than that, things should look pretty much the same under all
15581 Emacsen.
15582
15583
15584 @node Contributors
15585 @subsection Contributors
15586 @cindex contributors
15587
15588 The new Gnus version couldn't have been done without the help of all the
15589 people on the (ding) mailing list.  Every day for over a year I have
15590 gotten billions of nice bug reports from them, filling me with joy,
15591 every single one of them.  Smooches.  The people on the list have been
15592 tried beyond endurance, what with my ``oh, that's a neat idea <type
15593 type>, yup, I'll release it right away <ship off> no wait, that doesn't
15594 work at all <type type>, yup, I'll ship that one off right away <ship
15595 off> no, wait, that absolutely does not work'' policy for releases.
15596 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
15597 ``worser''? ``much worser''?  ``worsest''?)
15598
15599 I would like to take this opportunity to thank the Academy for...  oops,
15600 wrong show.
15601
15602 @itemize @bullet
15603
15604 @item
15605 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
15606
15607 @item
15608 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
15609 well as numerous other things).
15610
15611 @item
15612 Luis Fernandes---design and graphics.
15613
15614 @item
15615 Erik Naggum---help, ideas, support, code and stuff.
15616
15617 @item
15618 Wes Hardaker---@file{gnus-picon.el} and the manual section on
15619 @dfn{picons} (@pxref{Picons}).
15620
15621 @item
15622 Kim-Minh Kaplan---further work on the picon code.
15623
15624 @item
15625 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
15626 (@pxref{GroupLens}).
15627
15628 @item
15629 Sudish Joseph---innumerable bug fixes.
15630
15631 @item
15632 Ilja Weis---@file{gnus-topic.el}.
15633
15634 @item
15635 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
15636
15637 @item
15638 Vladimir Alexiev---the refcard and reference booklets.
15639
15640 @item
15641 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
15642 distribution by Felix Lee and JWZ.
15643
15644 @item
15645 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
15646
15647 @item
15648 Peter Mutsaers---orphan article scoring code.
15649
15650 @item
15651 Ken Raeburn---POP mail support.
15652
15653 @item
15654 Hallvard B Furuseth---various bits and pieces, especially dealing with
15655 .newsrc files.
15656
15657 @item
15658 Brian Edmonds---@file{gnus-bbdb.el}.
15659
15660 @item
15661 David Moore---rewrite of @file{nnvirtual.el} and many other things.
15662
15663 @item
15664 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
15665
15666 @item
15667 François Pinard---many, many interesting and thorough bug reports, as
15668 well as autoconf support.
15669
15670 @end itemize
15671
15672 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
15673 Borges, and Jost Krieger proof-reading parts of the manual.
15674
15675 The following people have contributed many patches and suggestions:
15676
15677 Christopher Davis,
15678 Andrew Eskilsson,
15679 Kai Grossjohann,
15680 David KÃ¥gedal,
15681 Richard Pieri,
15682 Fabrice Popineau,
15683 Daniel Quinlan,
15684 Jason L. Tibbitts, III,
15685 and
15686 Jack Vinson.
15687
15688 Also thanks to the following for patches and stuff:
15689
15690 Jari Aalto,
15691 Adrian Aichner,
15692 Vladimir Alexiev,
15693 Russ Allbery,
15694 Peter Arius,
15695 Matt Armstrong,
15696 Marc Auslander,
15697 Frank Bennett,
15698 Robert Bihlmeyer,
15699 Chris Bone,
15700 Mark Borges,
15701 Mark Boyns,
15702 Lance A. Brown,
15703 Kees de Bruin,
15704 Martin Buchholz,
15705 Joe Buehler,
15706 Kevin Buhr,
15707 Alastair Burt,
15708 Joao Cachopo,
15709 Zlatko Calusic,
15710 Massimo Campostrini,
15711 Castor,
15712 David Charlap,
15713 Dan Christensen,
15714 Kevin Christian,
15715 Michael R. Cook,
15716 Glenn Coombs,
15717 Frank D. Cringle,
15718 Geoffrey T. Dairiki,
15719 Andre Deparade,
15720 Ulrik Dickow,
15721 Dave Disser,
15722 Rui-Tao Dong, @c ?
15723 Joev Dubach,
15724 Michael Welsh Duggan,
15725 Dave Edmondson,
15726 Paul Eggert,
15727 Enami Tsugutomo, @c Enami
15728 Michael Ernst,
15729 Luc Van Eycken,
15730 Sam Falkner,
15731 Nelson Jose dos Santos Ferreira,
15732 Sigbjorn Finne,
15733 Decklin Foster,
15734 Gary D. Foster,
15735 Paul Franklin,
15736 Guy Geens,
15737 Arne Georg Gleditsch,
15738 David S. Goldberg,
15739 Michelangelo Grigni,
15740 D. Hall,
15741 Magnus Hammerin,
15742 Kenichi Handa, @c Handa
15743 Raja R. Harinath,
15744 Yoshiki Hayashi, @c ?
15745 P. E. Jareth Hein,
15746 Hisashige Kenji, @c Hisashige
15747 Marc Horowitz,
15748 Gunnar Horrigmo,
15749 Richard Hoskins,
15750 Brad Howes,
15751 François Felix Ingrand,
15752 Ishikawa Ichiro, @c Ishikawa
15753 Lee Iverson,
15754 Iwamuro Motonori, @c Iwamuro
15755 Rajappa Iyer,
15756 Andreas Jaeger,
15757 Randell Jesup,
15758 Fred Johansen,
15759 Simon Josefsson,
15760 Greg Klanderman,
15761 Karl Kleinpaste,
15762 Peter Skov Knudsen,
15763 Shuhei Kobayashi, @c Kobayashi
15764 Thor Kristoffersen,
15765 Jens Lautenbacher,
15766 Seokchan Lee, @c Lee
15767 Carsten Leonhardt,
15768 James LewisMoss,
15769 Christian Limpach,
15770 Markus Linnala,
15771 Dave Love,
15772 Mike McEwan,
15773 Tonny Madsen,
15774 Shlomo Mahlab,
15775 Nat Makarevitch,
15776 Istvan Marko,
15777 David Martin,
15778 Jason R. Mastaler,
15779 Gordon Matzigkeit,
15780 Timo Metzemakers,
15781 Richard Mlynarik,
15782 Lantz Moore,
15783 Morioka Tomohiko, @c Morioka
15784 Erik Toubro Nielsen,
15785 Hrvoje Niksic,
15786 Andy Norman,
15787 Fred Oberhauser,
15788 C. R. Oldham,
15789 Alexandre Oliva,
15790 Ken Olstad,
15791 Masaharu Onishi, @c Onishi
15792 Hideki Ono, @c Ono
15793 William Perry,
15794 Stephen Peters,
15795 Jens-Ulrik Holger Petersen,
15796 Ulrich Pfeifer,
15797 John McClary Prevost,
15798 Mike Pullen,
15799 Jim Radford,
15800 Colin Rafferty,
15801 Lasse Rasinen,
15802 Lars Balker Rasmussen,
15803 Joe Reiss,
15804 Renaud Rioboo,
15805 Roland B. Roberts,
15806 Bart Robinson,
15807 Christian von Roques,
15808 Jason Rumney,
15809 Wolfgang Rupprecht,
15810 Jay Sachs,
15811 Dewey M. Sasser,
15812 Loren Schall,
15813 Dan Schmidt,
15814 Ralph Schleicher,
15815 Philippe Schnoebelen,
15816 Andreas Schwab,
15817 Randal L. Schwartz,
15818 Justin Sheehy,
15819 Danny Siu,
15820 Matt Simmons,
15821 Paul D. Smith,
15822 Jeff Sparkes,
15823 Toby Speight,
15824 Michael Sperber,
15825 Darren Stalder,
15826 Richard Stallman,
15827 Greg Stark,
15828 Sam Steingold,
15829 Paul Stodghill,
15830 Kurt Swanson,
15831 Samuel Tardieu,
15832 Teddy,
15833 Chuck Thompson,
15834 Philippe Troin,
15835 James Troup,
15836 Aaron M. Ucko,
15837 Aki Vehtari,
15838 Didier Verna,
15839 Jan Vroonhof,
15840 Stefan Waldherr,
15841 Pete Ware,
15842 Barry A. Warsaw,
15843 Christoph Wedler,
15844 Joe Wells,
15845 Katsumi Yamaoka, @c Yamaoka
15846 and
15847 Shenghuo Zhu. @c Zhu
15848
15849 For a full overview of what each person has done, the ChangeLogs
15850 included in the Gnus alpha distributions should give ample reading
15851 (550kB and counting).
15852
15853 Apologies to everybody that I've forgotten, of which there are many, I'm
15854 sure.
15855
15856 Gee, that's quite a list of people.  I guess that must mean that there
15857 actually are people who are using Gnus.  Who'd'a thunk it!
15858
15859
15860 @node New Features
15861 @subsection New Features
15862 @cindex new features
15863
15864 @menu
15865 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
15866 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
15867 * Red Gnus::           Third time best---Gnus 5.4/5.5.
15868 * Quassia Gnus::       Two times two is four, or Gnus 5.6.25.
15869 @end menu
15870
15871 These lists are, of course, just @emph{short} overviews of the
15872 @emph{most} important new features.  No, really.  There are tons more.
15873 Yes, we have feeping creaturism in full effect.
15874
15875
15876 @node ding Gnus
15877 @subsubsection (ding) Gnus
15878
15879 New features in Gnus 5.0/5.1:
15880
15881 @itemize @bullet
15882
15883 @item
15884 The look of all buffers can be changed by setting format-like variables
15885 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
15886
15887 @item
15888 Local spool and several @sc{nntp} servers can be used at once
15889 (@pxref{Select Methods}).
15890
15891 @item
15892 You can combine groups into virtual groups (@pxref{Virtual Groups}).
15893
15894 @item
15895 You can read a number of different mail formats (@pxref{Getting Mail}).
15896 All the mail backends implement a convenient mail expiry scheme
15897 (@pxref{Expiring Mail}).
15898
15899 @item
15900 Gnus can use various strategies for gathering threads that have lost
15901 their roots (thereby gathering loose sub-threads into one thread) or it
15902 can go back and retrieve enough headers to build a complete thread
15903 (@pxref{Customizing Threading}).
15904
15905 @item
15906 Killed groups can be displayed in the group buffer, and you can read
15907 them as well (@pxref{Listing Groups}).
15908
15909 @item
15910 Gnus can do partial group updates---you do not have to retrieve the
15911 entire active file just to check for new articles in a few groups
15912 (@pxref{The Active File}).
15913
15914 @item
15915 Gnus implements a sliding scale of subscribedness to groups
15916 (@pxref{Group Levels}).
15917
15918 @item
15919 You can score articles according to any number of criteria
15920 (@pxref{Scoring}).  You can even get Gnus to find out how to score
15921 articles for you (@pxref{Adaptive Scoring}).
15922
15923 @item
15924 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
15925 manner, so it should be difficult to lose much data on what you have
15926 read if your machine should go down (@pxref{Auto Save}).
15927
15928 @item
15929 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
15930 the @file{.emacs} file.
15931
15932 @item
15933 You can set the process mark on both groups and articles and perform
15934 operations on all the marked items (@pxref{Process/Prefix}).
15935
15936 @item
15937 You can grep through a subset of groups and create a group from the
15938 results (@pxref{Kibozed Groups}).
15939
15940 @item
15941 You can list subsets of groups according to, well, anything
15942 (@pxref{Listing Groups}).
15943
15944 @item
15945 You can browse foreign servers and subscribe to groups from those
15946 servers (@pxref{Browse Foreign Server}).
15947
15948 @item
15949 Gnus can fetch articles, asynchronously, on a second connection to the
15950 server (@pxref{Asynchronous Fetching}).
15951
15952 @item
15953 You can cache articles locally (@pxref{Article Caching}).
15954
15955 @item
15956 The uudecode functions have been expanded and generalized
15957 (@pxref{Decoding Articles}).
15958
15959 @item
15960 You can still post uuencoded articles, which was a little-known feature
15961 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
15962
15963 @item
15964 Fetching parents (and other articles) now actually works without
15965 glitches (@pxref{Finding the Parent}).
15966
15967 @item
15968 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
15969
15970 @item
15971 Digests (and other files) can be used as the basis for groups
15972 (@pxref{Document Groups}).
15973
15974 @item
15975 Articles can be highlighted and customized (@pxref{Customizing
15976 Articles}).
15977
15978 @item
15979 URLs and other external references can be buttonized (@pxref{Article
15980 Buttons}).
15981
15982 @item
15983 You can do lots of strange stuff with the Gnus window & frame
15984 configuration (@pxref{Windows Configuration}).
15985
15986 @item
15987 You can click on buttons instead of using the keyboard
15988 (@pxref{Buttons}).
15989
15990 @end itemize
15991
15992
15993 @node September Gnus
15994 @subsubsection September Gnus
15995
15996 @iftex
15997 @iflatex
15998 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
15999 @end iflatex
16000 @end iftex
16001
16002 New features in Gnus 5.2/5.3:
16003
16004 @itemize @bullet
16005
16006 @item
16007 A new message composition mode is used.  All old customization variables
16008 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
16009 now obsolete.
16010
16011 @item
16012 Gnus is now able to generate @dfn{sparse} threads---threads where
16013 missing articles are represented by empty nodes (@pxref{Customizing
16014 Threading}).
16015
16016 @lisp
16017 (setq gnus-build-sparse-threads 'some)
16018 @end lisp
16019
16020 @item
16021 Outgoing articles are stored on a special archive server
16022 (@pxref{Archived Messages}).
16023
16024 @item
16025 Partial thread regeneration now happens when articles are
16026 referred.
16027
16028 @item
16029 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
16030
16031 @item
16032 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
16033
16034 @item
16035 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
16036
16037 @lisp
16038 (setq gnus-use-trees t)
16039 @end lisp
16040
16041 @item
16042 An @code{nn}-like pick-and-read minor mode is available for the summary
16043 buffers (@pxref{Pick and Read}).
16044
16045 @lisp
16046 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
16047 @end lisp
16048
16049 @item
16050 In binary groups you can use a special binary minor mode (@pxref{Binary
16051 Groups}).
16052
16053 @item
16054 Groups can be grouped in a folding topic hierarchy (@pxref{Group
16055 Topics}).
16056
16057 @lisp
16058 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
16059 @end lisp
16060
16061 @item
16062 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
16063
16064 @item
16065 Groups can now have a score, and bubbling based on entry frequency
16066 is possible (@pxref{Group Score}).
16067
16068 @lisp
16069 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
16070 @end lisp
16071
16072 @item
16073 Groups can be process-marked, and commands can be performed on
16074 groups of groups (@pxref{Marking Groups}).
16075
16076 @item
16077 Caching is possible in virtual groups.
16078
16079 @item
16080 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
16081 news batches, ClariNet briefs collections, and just about everything
16082 else (@pxref{Document Groups}).
16083
16084 @item
16085 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
16086 (@pxref{SOUP}).
16087
16088 @item
16089 The Gnus cache is much faster.
16090
16091 @item
16092 Groups can be sorted according to many criteria (@pxref{Sorting
16093 Groups}).
16094
16095 @item
16096 New group parameters have been introduced to set list-addresses and
16097 expiry times (@pxref{Group Parameters}).
16098
16099 @item
16100 All formatting specs allow specifying faces to be used
16101 (@pxref{Formatting Fonts}).
16102
16103 @item
16104 There are several more commands for setting/removing/acting on process
16105 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
16106
16107 @item
16108 The summary buffer can be limited to show parts of the available
16109 articles based on a wide range of criteria.  These commands have been
16110 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
16111
16112 @item
16113 Articles can be made persistent with the @kbd{*} command
16114 (@pxref{Persistent Articles}).
16115
16116 @item
16117 All functions for hiding article elements are now toggles.
16118
16119 @item
16120 Article headers can be buttonized (@pxref{Article Washing}).
16121
16122 @lisp
16123 (add-hook 'gnus-article-display-hook
16124           'gnus-article-add-buttons-to-head)
16125 @end lisp
16126
16127 @item
16128 All mail backends support fetching articles by @code{Message-ID}.
16129
16130 @item
16131 Duplicate mail can now be treated properly (@pxref{Duplicates}).
16132
16133 @item
16134 All summary mode commands are available directly from the article
16135 buffer (@pxref{Article Keymap}).
16136
16137 @item
16138 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
16139 Configuration}).
16140
16141 @item
16142 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
16143 @iftex
16144 @iflatex
16145 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
16146 @end iflatex
16147 @end iftex
16148
16149 @item
16150 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
16151
16152 @lisp
16153 (setq gnus-use-nocem t)
16154 @end lisp
16155
16156 @item
16157 Groups can be made permanently visible (@pxref{Listing Groups}).
16158
16159 @lisp
16160 (setq gnus-permanently-visible-groups "^nnml:")
16161 @end lisp
16162
16163 @item
16164 Many new hooks have been introduced to make customizing easier.
16165
16166 @item
16167 Gnus respects the @code{Mail-Copies-To} header.
16168
16169 @item
16170 Threads can be gathered by looking at the @code{References} header
16171 (@pxref{Customizing Threading}).
16172
16173 @lisp
16174 (setq gnus-summary-thread-gathering-function
16175       'gnus-gather-threads-by-references)
16176 @end lisp
16177
16178 @item
16179 Read articles can be stored in a special backlog buffer to avoid
16180 refetching (@pxref{Article Backlog}).
16181
16182 @lisp
16183 (setq gnus-keep-backlog 50)
16184 @end lisp
16185
16186 @item
16187 A clean copy of the current article is always stored in a separate
16188 buffer to allow easier treatment.
16189
16190 @item
16191 Gnus can suggest where to save articles (@pxref{Saving Articles}).
16192
16193 @item
16194 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
16195 Articles}).
16196
16197 @lisp
16198 (setq gnus-prompt-before-saving t)
16199 @end lisp
16200
16201 @item
16202 @code{gnus-uu} can view decoded files asynchronously while fetching
16203 articles (@pxref{Other Decode Variables}).
16204
16205 @lisp
16206 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
16207 @end lisp
16208
16209 @item
16210 Filling in the article buffer now works properly on cited text
16211 (@pxref{Article Washing}).
16212
16213 @item
16214 Hiding cited text adds buttons to toggle hiding, and how much
16215 cited text to hide is now customizable (@pxref{Article Hiding}).
16216
16217 @lisp
16218 (setq gnus-cited-lines-visible 2)
16219 @end lisp
16220
16221 @item
16222 Boring headers can be hidden (@pxref{Article Hiding}).
16223
16224 @lisp
16225 (add-hook 'gnus-article-display-hook
16226           'gnus-article-hide-boring-headers t)
16227 @end lisp
16228
16229 @item
16230 Default scoring values can now be set from the menu bar.
16231
16232 @item
16233 Further syntax checking of outgoing articles have been added.
16234
16235 @end itemize
16236
16237
16238 @node Red Gnus
16239 @subsubsection Red Gnus
16240
16241 New features in Gnus 5.4/5.5:
16242
16243 @iftex
16244 @iflatex
16245 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
16246 @end iflatex
16247 @end iftex
16248
16249 @itemize @bullet
16250
16251 @item
16252 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
16253
16254 @item
16255 Article prefetching functionality has been moved up into
16256 Gnus (@pxref{Asynchronous Fetching}).
16257
16258 @item
16259 Scoring can now be performed with logical operators like @code{and},
16260 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16261 Scoring}).
16262
16263 @item
16264 Article washing status can be displayed in the
16265 article mode line (@pxref{Misc Article}).
16266
16267 @item
16268 @file{gnus.el} has been split into many smaller files.
16269
16270 @item
16271 Suppression of duplicate articles based on Message-ID can be done
16272 (@pxref{Duplicate Suppression}).
16273
16274 @lisp
16275 (setq gnus-suppress-duplicates t)
16276 @end lisp
16277
16278 @item
16279 New variables for specifying what score and adapt files are to be
16280 considered home score and adapt files (@pxref{Home Score File}) have
16281 been added.
16282
16283 @item
16284 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
16285 Server Internals}).
16286
16287 @item
16288 Groups can inherit group parameters from parent topics (@pxref{Topic
16289 Parameters}).
16290
16291 @item
16292 Article editing has been revamped and is now actually usable.
16293
16294 @item
16295 Signatures can be recognized in more intelligent fashions
16296 (@pxref{Article Signature}).
16297
16298 @item
16299 Summary pick mode has been made to look more @code{nn}-like.  Line
16300 numbers are displayed and the @kbd{.} command can be used to pick
16301 articles (@code{Pick and Read}).
16302
16303 @item
16304 Commands for moving the @file{.newsrc.eld} from one server to
16305 another have been added (@pxref{Changing Servers}).
16306
16307 @item
16308 There's a way now to specify that ``uninteresting'' fields be suppressed
16309 when generating lines in buffers (@pxref{Advanced Formatting}).
16310
16311 @item
16312 Several commands in the group buffer can be undone with @kbd{M-C-_}
16313 (@pxref{Undo}).
16314
16315 @item
16316 Scoring can be done on words using the new score type @code{w}
16317 (@pxref{Score File Format}).
16318
16319 @item
16320 Adaptive scoring can be done on a Subject word-by-word basis
16321 (@pxref{Adaptive Scoring}).
16322
16323 @lisp
16324 (setq gnus-use-adaptive-scoring '(word))
16325 @end lisp
16326
16327 @item
16328 Scores can be decayed (@pxref{Score Decays}).
16329
16330 @lisp
16331 (setq gnus-decay-scores t)
16332 @end lisp
16333
16334 @item
16335 Scoring can be performed using a regexp on the Date header.  The Date is
16336 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
16337
16338 @item
16339 A new command has been added to remove all data on articles from
16340 the native server (@pxref{Changing Servers}).
16341
16342 @item
16343 A new command for reading collections of documents
16344 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
16345 (@pxref{Really Various Summary Commands}).
16346
16347 @item
16348 Process mark sets can be pushed and popped (@pxref{Setting Process
16349 Marks}).
16350
16351 @item
16352 A new mail-to-news backend makes it possible to post even when the NNTP
16353 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
16354
16355 @item
16356 A new backend for reading searches from Web search engines
16357 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
16358 (@pxref{Web Searches}).
16359
16360 @item
16361 Groups inside topics can now be sorted using the standard sorting
16362 functions, and each topic can be sorted independently (@pxref{Topic
16363 Sorting}).
16364
16365 @item
16366 Subsets of the groups can be sorted independently (@code{Sorting
16367 Groups}).
16368
16369 @item
16370 Cached articles can be pulled into the groups (@pxref{Summary Generation
16371 Commands}).
16372 @iftex
16373 @iflatex
16374 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
16375 @end iflatex
16376 @end iftex
16377
16378 @item
16379 Score files are now applied in a more reliable order (@pxref{Score
16380 Variables}).
16381
16382 @item
16383 Reports on where mail messages end up can be generated (@pxref{Splitting
16384 Mail}).
16385
16386 @item
16387 More hooks and functions have been added to remove junk from incoming
16388 mail before saving the mail (@pxref{Washing Mail}).
16389
16390 @item
16391 Emphasized text can be properly fontisized:
16392
16393 @lisp
16394 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
16395 @end lisp
16396
16397 @end itemize
16398
16399
16400 @node Quassia Gnus
16401 @subsubsection Quassia Gnus
16402
16403 New features in Gnus 5.6.25:
16404
16405 @itemize @bullet
16406
16407 @item
16408 New functionality for using Gnus as an offline newsreader has been
16409 added.  A plethora of new commands and modes have been added.  See
16410 @pxref{Gnus Unplugged} for the full story.
16411
16412 @item
16413  The @code{nndraft} backend has returned, but works differently than
16414 before.  All Message buffers are now also articles in the @code{nndraft}
16415 group, which is created automatically.
16416
16417 @item
16418 @code{gnus-alter-header-function} can now be used to alter header
16419 values.
16420
16421 @item
16422  @code{gnus-summary-goto-article} now accept Message-ID's.
16423
16424 @item
16425  A new Message command for deleting text in the body of a message
16426 outside the region: @kbd{C-c C-v}.
16427
16428 @item
16429  You can now post to component group in @code{nnvirtual} groups with
16430 @kbd{C-u C-c C-c}.
16431
16432 @item
16433  @code{nntp-rlogin-program}---new variable to ease customization.
16434
16435 @item
16436  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
16437 re-highlighting of the article buffer.
16438
16439 @item
16440  New element in @code{gnus-boring-article-headers}---@code{long-to}.
16441
16442 @item
16443  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
16444 Prefixes" in the Gnus manual for details.
16445
16446 @item
16447  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
16448 @kbd{a} to add the score rule to the "all.SCORE" file.
16449
16450 @item
16451  @code{gnus-simplify-subject-functions} variable to allow greater
16452 control over simplification.
16453
16454 @item
16455  @kbd{A T}---new command for fetching the current thread.
16456
16457 @item
16458  @kbd{/ T}---new command for including the current thread in the
16459 limit.
16460
16461 @item
16462  @kbd{M-RET} is a new Message command for breaking cited text.
16463
16464 @item
16465  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
16466
16467 @item
16468  The @code{custom-face-lookup} function has been removed.
16469 If you used this function in your initialization files, you must
16470 rewrite them to use @code{face-spec-set} instead.
16471
16472 @item
16473  Canceling now uses the current select method.  Symbolic prefix
16474 @kbd{a} forces normal posting method.
16475
16476 @item
16477  New command to translate M******** sm*rtq**t*s into proper
16478 text---@kbd{W d}.
16479
16480 @item
16481  For easier debugging of @code{nntp}, you can set
16482 @code{nntp-record-commands} to a non-@code{nil} value.
16483
16484 @item
16485  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
16486 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
16487
16488 @item
16489  A command for editing group parameters from the summary buffer
16490 has been added.
16491
16492 @item
16493  A history of where mails have been split is available.
16494
16495 @item
16496  A new article date command has been added---@code{article-date-iso8601}.
16497
16498 @item
16499  Subjects can be simplified when threading by setting
16500 @code{gnus-score-thread-simplify}.
16501
16502 @item
16503  A new function for citing in Message has been
16504 added---@code{message-cite-original-without-signature}.
16505
16506 @item
16507  @code{article-strip-all-blank-lines}---new article command.
16508
16509 @item
16510  A new Message command to kill to the end of the article has
16511 been added.
16512
16513 @item
16514  A minimum adaptive score can be specified by using the
16515 @code{gnus-adaptive-word-minimum} variable.
16516
16517 @item
16518  The "lapsed date" article header can be kept continually
16519 updated by the @code{gnus-start-date-timer} command.
16520
16521 @item
16522  Web listserv archives can be read with the @code{nnlistserv} backend.
16523
16524 @item
16525  Old dejanews archives can now be read by @code{nnweb}.
16526
16527 @end itemize
16528
16529
16530 @node Newest Features
16531 @subsection Newest Features
16532 @cindex todo
16533
16534 Also known as the @dfn{todo list}.  Sure to be implemented before the
16535 next millennium.
16536
16537 Be afraid.  Be very afraid.
16538
16539 (That a feature appears in this list doesn't necessarily mean that I've
16540 decided to actually implement it.  It just means that I think it sounds
16541 interesting.)
16542
16543 (Yes, this is the actual, up-to-the-second todo list.)
16544
16545 @itemize @bullet
16546
16547 @item
16548 Native @sc{mime} support is something that should be done.
16549
16550 @item
16551 Really do unbinhexing.
16552
16553 @item
16554  I would like the zombie-page to contain an URL to the source of the
16555 latest version of gnus or some explanation on where to find it.
16556
16557 @item
16558  A way to continue editing the latest Message composition.
16559
16560 @item
16561  http://www.sonicnet.com/feature/ari3/
16562
16563 @item
16564  facep is not declared.
16565
16566 @item
16567  Include a section in the manual on why the number of articles
16568 isn't the same in the group buffer and on the SPC prompt.
16569
16570 @item
16571  Interacting with rmail fcc isn't easy.
16572
16573 @item
16574 @example
16575  Hypermail:
16576 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
16577 <URL:http://www.eit.com/software/hypermail/hypermail.html>
16578 <URL:http://homer.ncm.com/>
16579 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
16580 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
16581 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
16582 http://www.miranova.com/gnus-list/
16583
16584 @end example
16585
16586 @item
16587 @samp{^-- } is made into - in LaTeX.
16588
16589 @item
16590  gnus-kill is much slower than it was in GNUS 4.1.3.
16591
16592 @item
16593  when expunging articles on low score, the sparse nodes keep hanging on?
16594 @item
16595  starting the first time seems to hang Gnus on some systems.  Does
16596 NEWGROUPS answer too fast?
16597 @item
16598  nndir doesn't read gzipped files.
16599 @item
16600  FAQ doesn't have an up node?
16601 @item
16602  when moving mail from a procmail spool to the crash-box,
16603 the crash-box is only appropriate to one specific group.
16604 @item
16605  `t' `t' makes X-Faces disappear.
16606 @item
16607  nnmh-be-safe means that crossposted articles will
16608 be marked as unread.
16609 @item
16610  Orphan score entries don't show on "V t" score trace
16611 @item
16612  when clearing out data, the cache data should also be reset.
16613 @item
16614  rewrite gnus-summary-limit-children to be non-recursive
16615 to avoid exceeding lisp nesting on huge groups.
16616 @item
16617  expunged articles are counted when computing scores.
16618 @item
16619  implement gnus-batch-brew-soup
16620 @item
16621  ticked articles aren't easy to read in pick mode -- `n' and
16622 stuff just skips past them.  Read articles are the same.
16623 @item
16624  topics that contain just groups with ticked
16625 articles aren't displayed.
16626 @item
16627  nndoc should always allocate unique Message-IDs.
16628 @item
16629  implement gnus-score-thread
16630 @item
16631  If there are mail groups the first time you use Gnus, Gnus'll
16632 make the mail groups killed.
16633 @item
16634  no "no news is good news" when using topics.
16635 @item
16636  when doing crosspost marking, the cache has to be consulted
16637 and articles have to be removed.
16638 @item
16639  nnweb should fetch complete articles when they are split into several
16640 parts.
16641 @item
16642  scoring on head immediate doesn't work.
16643 @item
16644  finding short score file names takes forever.
16645 @item
16646  canceling articles in foreign groups.
16647 @item
16648  nntp-open-rlogin no longer works.
16649 @item
16650  C-u C-x C-s (Summary) switches to the group buffer.
16651 @item
16652  move nnmail-split-history out to the backends.
16653 @item
16654  nnweb doesn't work properly.
16655 @item
16656  using a virtual server name as `gnus-select-method' doesn't work?
16657 @item
16658  when killing/yanking a group from one topic to another in a slave, the
16659 master will yank it first to one topic and then add it to another.
16660 Perhaps.
16661
16662 @item
16663  warn user about `=' redirection of a group in the active file?
16664 @item
16665  really unbinhex binhex files.
16666 @item
16667  take over the XEmacs menubar and offer a toggle between the XEmacs
16668 bar and the Gnus bar.
16669 @item
16670 @example
16671  push active file and NOV file parsing down into C code.
16672 `(canonize-message-id id)'
16673 `(mail-parent-message-id references n)'
16674 `(parse-news-nov-line &optional dependency-hashtb)'
16675 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
16676 `(parse-news-active-region beg end hashtb)'
16677
16678 @end example
16679
16680 @item
16681  nnml .overview directory with splits.
16682 @item
16683  asynchronous cache
16684 @item
16685  postponed commands.
16686 @item
16687  the selected article show have its Subject displayed in its summary line.
16688 @item
16689  when entering groups, get the real number of unread articles from
16690 the server?
16691 @item
16692  sort after gathering threads -- make false roots have the
16693 headers of the oldest orphan with a 0 article number?
16694 @item
16695  nndoc groups should inherit the score files of their parents?  Also
16696 inherit copy prompts and save files.
16697 @item
16698  command to start up Gnus (if not running) and enter a mail mode buffer.
16699 @item
16700  allow editing the group description from the group buffer
16701 for backends that support that.
16702 @item
16703 gnus-hide,show-all-topics
16704 @item
16705  groups and sub-topics should be allowed to mingle inside each topic,
16706 and not just list all subtopics at the end.
16707 @item
16708  a command to remove all read articles that are not needed to connect
16709 threads -- `gnus-summary-limit-to-sparse-unread'?
16710 @item
16711  a variable to turn off limiting/cutting of threads in the tree buffer.
16712 @item
16713  a variable to limit how many files are uudecoded.
16714 @item
16715  add zombie groups to a special "New Groups" topic.
16716 @item
16717  server mode command: close/open all connections
16718 @item
16719  put a file date in gnus-score-alist and check whether the file
16720 has been changed before using it.
16721 @item
16722  on exit from a digest group, go to the next article in the parent group.
16723 @item
16724  hide (sub)threads with low score.
16725 @item
16726  when expiring, remove all marks from expired articles.
16727 @item
16728  gnus-summary-limit-to-body
16729 @item
16730  a regexp alist that says what level groups are to be subscribed
16731 on.  Eg. -- `(("nnml:" . 1))'.
16732 @item
16733  easier interface to nnkiboze to create ephemeral groups that
16734 contain groups that match a regexp.
16735 @item
16736  allow newlines in <URL:> urls, but remove them before using
16737 the URL.
16738 @item
16739  If there is no From line, the mail backends should fudge one from the
16740 "From " line.
16741 @item
16742  fuzzy simplifying should strip all non-alpha-numerical info
16743 from subject lines.
16744 @item
16745  gnus-soup-brew-soup-with-high-scores.
16746 @item
16747  nntp-ping-before-connect
16748 @item
16749  command to check whether NOV is evil.  "list overview.fmt".
16750 @item
16751  when entering a group, Gnus should look through the score
16752 files very early for `local' atoms and set those local variables.
16753 @item
16754  message annotations.
16755 @item
16756  topics are always yanked before groups, and that's not good.
16757 @item
16758  (set-extent-property extent 'help-echo "String to display in minibuf")
16759 to display help in the minibuffer on buttons under XEmacs.
16760 @item
16761  allow group line format spec to say how many articles there
16762 are in the cache.
16763 @item
16764  AUTHINFO GENERIC
16765 @item
16766  support qmail maildir spools
16767 @item
16768  `run-with-idle-timer' in gnus-demon.
16769 @item
16770  stop using invisible text properties and start using overlays instead
16771 @item
16772  C-c C-f C-e to add an Expires header.
16773 @item
16774  go from one group to the next; everything is expunged; go to the
16775 next group instead of going to the group buffer.
16776 @item
16777  gnus-renumber-cache -- to renumber the cache using "low" numbers.
16778 @item
16779  record topic changes in the dribble buffer.
16780 @item
16781  `nnfolder-generate-active-file' should look at the folders it
16782 finds and generate proper active ranges.
16783 @item
16784  nneething-look-in-files-for-article-heads variable to control
16785 whether nneething should sniff all files in the directories.
16786 @item
16787  gnus-fetch-article -- start Gnus, enter group, display article
16788 @item
16789  gnus-dont-move-articles-to-same-group variable when respooling.
16790 @item
16791  when messages are crossposted between several auto-expirable groups,
16792 articles aren't properly marked as expirable.
16793 @item
16794  nneething should allow deletion/moving.
16795 @item
16796  TAB on the last button should go to the first button.
16797 @item
16798  if the car of an element in `mail-split-methods' is a function,
16799 and the function returns non-nil, use that as the name of the group(s) to
16800 save mail in.
16801 @item
16802  command for listing all score files that have been applied.
16803 @item
16804  a command in the article buffer to return to `summary' config.
16805 @item
16806  `gnus-always-post-using-current-server' -- variable to override
16807 `C-c C-c' when posting.
16808 @item
16809  nnmail-group-spool-alist -- says where each group should use
16810 as a spool file.
16811 @item
16812  when an article is crossposted to an auto-expirable group, the article
16813 should be marker as expirable.
16814 @item
16815  article mode command/menu for "send region as URL to browser".
16816 @item
16817  on errors, jump to info nodes that explain the error.  For instance,
16818 on invalid From headers, or on error messages from the nntp server.
16819 @item
16820  when gathering threads, make the article that has no "Re: " the parent.
16821 Also consult Date headers.
16822 @item
16823  a token in splits to call shrink-window-if-larger-than-buffer
16824 @item
16825  `1 0 A M' to do matches on the active hashtb.
16826 @item
16827  duplicates -- command to remove Gnus-Warning header, use the read
16828 Message-ID, delete the "original".
16829 @item
16830  when replying to several messages at once, put the "other" message-ids
16831 into a See-Also header.
16832 @item
16833  support setext: URL:http://www.bsdi.com/setext/
16834 @item
16835  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
16836 @item
16837  when browsing a foreign server, the groups that are already subscribed
16838 should be listed as such and not as "K".
16839 @item
16840  generate font names dynamically.
16841 @item
16842  score file mode auto-alist.
16843 @item
16844  allow nndoc to change/add/delete things from documents.  Implement
16845 methods for each format for adding an article to the document.
16846 @item
16847  `gnus-fetch-old-headers' `all' value to incorporate
16848 absolutely all headers there is.
16849 @item
16850  function like `|', but concatenate all marked articles
16851 and pipe them to the process.
16852 @item
16853  cache the list of killed (or active) groups in a separate file.  Update
16854 the file whenever we read the active file or the list
16855 of killed groups in the .eld file reaches a certain length.
16856 @item
16857  function for starting to edit a file to put into
16858 the current mail group.
16859 @item
16860  score-find-trace should display the total score of the article.
16861 @item
16862  "ghettozie" -- score on Xref header and nix it out after using it
16863 to avoid marking as read in other groups it has been crossposted to.
16864 @item
16865  look at procmail splitting.  The backends should create
16866 the groups automatically if a spool file exists for that group.
16867 @item
16868  function for backends to register themselves with Gnus.
16869 @item
16870  when replying to several process-marked articles,
16871 have all the From end up in Cc headers?  Variable to toggle.
16872 @item
16873  command to delete a crossposted mail article from all
16874 groups it has been mailed to.
16875 @item
16876  `B c' and `B m' should be crosspost aware.
16877 @item
16878  hide-pgp should also hide PGP public key blocks.
16879 @item
16880  Command in the group buffer to respool process-marked groups.
16881 @item
16882  `gnus-summary-find-matching' should accept
16883 pseudo-"headers" like "body", "head" and "all"
16884 @item
16885  When buttifying <URL: > things, all white space (including
16886 newlines) should be ignored.
16887 @item
16888  Process-marking all groups in a topic should process-mark
16889 groups in subtopics as well.
16890 @item
16891  Add non-native groups to the list of killed groups when killing them.
16892 @item
16893  nntp-suggest-kewl-config to probe the nntp server and suggest
16894 variable settings.
16895 @item
16896  add edit and forward secondary marks.
16897 @item
16898  nnml shouldn't visit its .overview files.
16899 @item
16900  allow customizing sorting within gathered threads.
16901 @item
16902  `B q' shouldn't select the current article.
16903 @item
16904  nnmbox should support a newsgroups file for descriptions.
16905 @item
16906  allow fetching mail from several pop servers.
16907 @item
16908  Be able to specify whether the saving commands save the original
16909 or the formatted article.
16910 @item
16911  a command to reparent with the child process-marked (cf. `T ^'.).
16912 @item
16913  I think the possibility to send a password with nntp-open-rlogin
16914 should be a feature in Red Gnus.
16915 @item
16916  The `Z n' command should be possible to execute from a mouse click.
16917 @item
16918  more limiting functions -- date, etc.
16919 @item
16920  be able to limit on a random header; on body; using reverse matches.
16921 @item
16922  a group parameter (`absofucking-total-expiry') that will make Gnus expire
16923 even unread articles.
16924 @item
16925  a command to print the article buffer as postscript.
16926 @item
16927  variable to disable password fetching when opening by nntp-open-telnet.
16928 @item
16929  manual: more example servers -- nntp with rlogin, telnet
16930 @item
16931  checking for bogus groups should clean topic alists as well.
16932 @item
16933  canceling articles in foreign groups.
16934 @item
16935  article number in folded topics isn't properly updated by
16936 Xref handling.
16937 @item
16938  Movement in the group buffer to the next unread group should go to the
16939 next closed topic with unread messages if no group can be found.
16940 @item
16941  Extensive info pages generated on the fly with help everywhere --
16942 in the "*Gnus edit*" buffers, for instance.
16943 @item
16944  Topic movement commands -- like thread movement.  Up, down, forward, next.
16945 @item
16946  a way to tick/mark as read Gcc'd articles.
16947 @item
16948  a way to say that all groups within a specific topic comes
16949 from a particular server?  Hm.
16950 @item
16951  `gnus-article-fill-if-long-lines' -- a function to fill
16952 the article buffer if there are any looong lines there.
16953 @item
16954  `T h' should jump to the parent topic and fold it.
16955 @item
16956  a command to create an ephemeral nndoc group out of a file,
16957 and then splitting it/moving it to some other group/backend.
16958 @item
16959  a group parameter for nnkiboze groups that says that
16960 all kibozed articles should be entered into the cache.
16961 @item
16962  It should also probably be possible to delimit what
16963 `gnus-jog-cache' does -- for instance, work on just some groups, or on
16964 some levels, and entering just articles that have a score higher than
16965 a certain number.
16966 @item
16967  nnfolder should append to the folder instead of re-writing
16968 the entire folder to disk when accepting new messages.
16969 @item
16970  allow all backends to do the proper thing with .gz files.
16971 @item
16972  a backend for reading collections of babyl files nnbabylfolder?
16973 @item
16974  a command for making the native groups into foreign groups.
16975 @item
16976  server mode command for clearing read marks from all groups
16977 from a server.
16978 @item
16979  when following up multiple articles, include all To, Cc, etc headers
16980 from all articles.
16981 @item
16982  a command for deciding what the total score of the current
16983 thread is.  Also a way to highlight based on this.
16984 @item
16985  command to show and edit group scores
16986 @item
16987  a gnus-tree-minimize-horizontal to minimize tree buffers
16988 horizontally.
16989 @item
16990  command to generate nnml overview file for one group.
16991 @item
16992  `C-u C-u a' -- prompt for many crossposted groups.
16993 @item
16994  keep track of which mail groups have received new articles (in this session).
16995 Be able to generate a report and perhaps do some marking in the group
16996 buffer.
16997 @item
16998  gnus-build-sparse-threads to a number -- build only sparse threads
16999 that are of that length.
17000 @item
17001  have nnmh respect mh's unseen sequence in .mh_profile.
17002 @item
17003  cache the newsgroups descriptions locally.
17004 @item
17005  asynchronous posting under nntp.
17006 @item
17007  be able to control word adaptive scoring from the score files.
17008 @item
17009  a variable to make `C-c C-c' post using the "current" select method.
17010 @item
17011  `limit-exclude-low-scored-articles'.
17012 @item
17013  if `gnus-summary-show-thread' is a number, hide threads that have
17014 a score lower than this number.
17015 @item
17016  split newsgroup subscription variable up into "order" and "method".
17017 @item
17018  buttonize ange-ftp file names.
17019 @item
17020  a command to make a duplicate copy of the current article
17021 so that each copy can be edited separately.
17022 @item
17023  nnweb should allow fetching from the local nntp server.
17024 @item
17025  record the sorting done in the summary buffer so that
17026 it can be repeated when limiting/regenerating the buffer.
17027 @item
17028  nnml-generate-nov-databses should generate for
17029 all nnml servers.
17030 @item
17031  when the user does commands in the group buffer, check
17032 the modification time of the .newsrc.eld file and use
17033 ask-user-about-supersession-threat.  Also warn when trying
17034 to save .newsrc.eld and it has changed.
17035 @item
17036  M-g on a topic will display all groups with 0 articles in
17037 the topic.
17038 @item
17039  command to remove all topic stuff.
17040 @item
17041  allow exploding incoming digests when reading incoming mail
17042 and splitting the resulting digests.
17043 @item
17044  nnsoup shouldn't set the `message-' variables.
17045 @item
17046  command to nix out all nnoo state information.
17047 @item
17048  nnmail-process-alist that calls functions if group names
17049 matches an alist -- before saving.
17050 @item
17051  use buffer-invisibility-spec everywhere for hiding text.
17052 @item
17053  variable to activate each group before entering them
17054 to get the (new) number of articles.  `gnus-activate-before-entering'.
17055 @item
17056  command to fetch a Message-ID from any buffer, even
17057 starting Gnus first if necessary.
17058 @item
17059  when posting and checking whether a group exists or not, just
17060 ask the nntp server instead of relying on the active hashtb.
17061 @item
17062  buttonize the output of `C-c C-a' in an apropos-like way.
17063 @item
17064  `G p' should understand process/prefix, and allow editing
17065 of several groups at once.
17066 @item
17067  command to create an ephemeral nnvirtual group that
17068 matches some regexp(s).
17069 @item
17070  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
17071 @item
17072  it should be possible to score "thread" on the From header.
17073 @item
17074  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
17075 @item
17076  `B i' should display the article at once in the summary buffer.
17077 @item
17078  remove the "*" mark at once when unticking an article.
17079 @item
17080  `M-s' should highlight the matching text.
17081 @item
17082  when checking for duplicated mails, use Resent-Message-ID if present.
17083 @item
17084  killing and yanking groups in topics should be better.  If killing one copy
17085 of a group that exists in multiple topics, only that copy should
17086 be removed.  Yanking should insert the copy, and yanking topics
17087 should be possible to be interspersed with the other yankings.
17088 @item
17089  command for enter a group just to read the cached articles.  A way to say
17090 "ignore the nntp connection; just read from the cache."
17091 @item
17092  `X u' should decode base64 articles.
17093 @item
17094  a way to hide all "inner" cited text, leaving just the most
17095 recently cited text.
17096 @item
17097  nnvirtual should be asynchronous.
17098 @item
17099  after editing an article, gnus-original-article-buffer should
17100 be invalidated.
17101 @item
17102  there should probably be a way to make Gnus not connect to the
17103 server and just read the articles in the server
17104 @item
17105  allow a `set-default' (or something) to change the default
17106 value of nnoo variables.
17107 @item
17108  a command to import group infos from a .newsrc.eld file.
17109 @item
17110  groups from secondary servers have the entire select method
17111 listed in each group info.
17112 @item
17113  a command for just switching from the summary buffer to the group
17114 buffer.
17115 @item
17116  a way to specify that some incoming mail washing functions
17117 should only be applied to some groups.
17118 @item
17119  Message `C-f C-t' should ask the user whether to heed
17120 mail-copies-to: never.
17121 @item
17122  new group parameter -- `post-to-server' that says to post
17123 using the current server.  Also a variable to do the same.
17124 @item
17125  the slave dribble files should autosave to the slave file names.
17126 @item
17127  a group parameter that says what articles to display on group entry, based
17128 on article marks.
17129 @item
17130  a way to visually distinguish slave Gnusae from masters.  (Whip instead
17131 of normal logo?)
17132 @item
17133  Use DJ Bernstein "From " quoting/dequoting, where applicable.
17134 @item
17135  Why is hide-citation-maybe and hide-citation different?  Also
17136 clear up info.
17137 @item
17138  group user-defined meta-parameters.
17139
17140
17141
17142 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
17143 @item
17144  I like the option for trying to retrieve the FAQ for a group and I was
17145 thinking it would be great if for those newsgroups that had archives
17146 you could also try to read the archive for that group.  Part of the
17147 problem is that archives are spread all over the net, unlike FAQs.
17148 What would be best I suppose is to find the one closest to your site.
17149
17150 In any case, there is a list of general news group archives at
17151 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
17152
17153
17154
17155
17156 @item
17157 @example
17158 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
17159 (add-hook 'gnus-select-group-hook
17160   (lambda ()
17161     (gnus-group-add-parameter group
17162        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
17163
17164 (defun gnus-user-format-function-d (headers)
17165   "Return the date the group was last read."
17166   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
17167       (t "")))
17168 @end example
17169
17170 @item
17171  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
17172 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
17173 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
17174 hatt forskjellige serveres startup-filer forskjellige steder.
17175
17176
17177 @item
17178 LMI> Well, nnbabyl could alter the group info to heed labels like
17179 LMI> answered and read, I guess.
17180
17181 It could also keep them updated (the same for the Status: header of
17182 unix mbox files).
17183
17184 They could be used like this:
17185
17186
17187 @example
17188 `M l <name> RET' add label <name> to current message.
17189 `M u <name> RET' remove label <name> from current message.
17190 `/ l <expr> RET' limit summary buffer according to <expr>.
17191
17192 <expr> would be a boolean expression on the labels, e.g.
17193
17194 `/ l bug & !fixed RET'
17195 @end example
17196
17197 would show all the messages which are labeled `bug' but not labeled
17198 `fixed'.
17199
17200 One could also imagine the labels being used for highlighting, or
17201 affect the summary line format.
17202
17203
17204 @item
17205 Sender: abraham@@dina.kvl.dk
17206
17207 I'd like a gnus-find-file which work like find file, except that it
17208 would recognize things that looks like messages or folders:
17209
17210 - If it is a directory containing numbered files, create an nndir
17211 summary buffer.
17212
17213 - For other directories, create a nneething summary buffer.
17214
17215 - For files matching "\\`From ", create a nndoc/mbox summary.
17216
17217 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
17218
17219 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
17220
17221 - For other files, just find them normally.
17222
17223 I'd like `nneething' to use this function, so it would work on a
17224 directory potentially containing mboxes or babyl files.
17225
17226 @item
17227 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
17228 tell him what you are doing.
17229
17230 @item
17231 Currently, I get prompted:
17232
17233 decend into sci?
17234 - type y
17235 decend into sci.something ?
17236 - type n
17237 decend into ucd?
17238
17239 The problem above is that since there is really only one subsection of
17240 science, shouldn't it prompt you for only descending sci.something?  If
17241 there was a sci.somethingelse group or section, then it should prompt
17242 for sci? first the sci.something? then sci.somethingelse?...
17243
17244 @item
17245 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
17246 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
17247 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
17248 "no.all.SCORE", osv.
17249
17250 @item
17251 What i want is for Gnus to treat any sequence or combination of the following
17252 as a single spoiler warning and hide it all, replacing it with a "Next Page"
17253 button:
17254
17255
17256 ^L's
17257
17258 more than n blank lines
17259
17260 more than m identical lines
17261 (which should be replaced with button to show them)
17262
17263 any whitespace surrounding any of the above
17264
17265
17266 @item
17267 Well, we could allow a new value to `gnus-thread-ignore-subject' --
17268 `spaces', or something.  (We could even default to that.)  And then
17269 subjects that differ in white space only could be considered the
17270 "same" subject for threading purposes.
17271
17272 @item
17273 Modes to preprocess the contents (e.g. jka-compr) use the second form
17274 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
17275 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
17276 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
17277
17278 @item
17279  Under XEmacs -- do funny article marks:
17280 tick - thumb tack
17281 killed - skull
17282 soup - bowl of soup
17283 score below - dim light bulb
17284 score over - bright light bulb
17285
17286 @item
17287 Yes. I think the algorithm is as follows:
17288
17289 @example
17290 Group-mode
17291
17292    show-list-of-articles-in-group
17293         if (key-pressed == SPACE)
17294                 if (no-more-articles-in-group-to-select)
17295                         if (articles-selected)
17296                                 start-reading-selected-articles;
17297                         junk-unread-articles;
17298                         next-group;
17299                  else
17300                         show-next-page;
17301
17302          else if (key-pressed = '.')
17303                 if (consolidated-menus)         # same as hide-thread in Gnus
17304                         select-thread-under-cursor;
17305                 else
17306                         select-article-under-cursor;
17307
17308
17309 Article-mode
17310         if (key-pressed == SPACE)
17311                 if (more-pages-in-article)
17312                         next-page;
17313                 else if (more-selected-articles-to-read)
17314                         next-article;
17315                 else
17316                         next-group;
17317 @end example
17318
17319 @item
17320 My precise need here would have been to limit files to Incoming*.
17321 One could think of some `nneething-only-files' variable, but I guess
17322 it would have been unacceptable if one was using many unrelated such
17323 nneething groups.
17324
17325 A more useful approach would be to, in response to the `G D' prompt, be
17326 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
17327 the top-level directory only (in case directories would be matched by
17328 the wildcard expression).
17329
17330 @item
17331 It would be nice if it also handled
17332
17333         <URL:news://sunsite.auc.dk/>
17334
17335 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
17336
17337
17338 @item
17339
17340   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
17341 really well.  Each menu is 'named' by a symbol that would be on a
17342 gnus-*-menus (where * would be whatever, but at least group, summary, and
17343 article versions) variable.
17344
17345   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
17346
17347   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
17348 the main menubar.  This approach works really well for Emacs-W3 and VM.
17349
17350
17351 @item
17352  nndoc should take care to create unique Message-IDs for all its
17353 articles.
17354 @item
17355  gnus-score-followup-article only works when you have a summary buffer
17356 active.  Make it work when posting from the group buffer as well.
17357 (message-sent-hook).
17358 @item
17359  rewrite gnus-demon to use run-with-idle-timers.
17360
17361 @item
17362  * Enhancements to Gnus:
17363
17364   Add two commands:
17365
17366   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
17367     straight to the server buffer, without opening any connections to
17368     servers first.
17369
17370   * gnus-server-read-server-newsrc--produces a buffer very similar to
17371     the group buffer, but with only groups from that server listed;
17372     quitting this buffer returns to the server buffer.
17373
17374 @item
17375  add a command to check the integrity of an nnfolder folder --
17376 go through the article numbers and see that there are no duplicates,
17377 and stuff.
17378
17379 @item
17380  `unsmileyfy-buffer' to undo smileification.
17381
17382 @item
17383  a command to give all relevant info on an article, including all
17384 secondary marks.
17385
17386 @item
17387  when doing `-request-accept-article', the backends should do
17388 the nnmail duplicate checking.
17389
17390 @item
17391  allow `message-signature-file' to be a function to return the
17392 value of the signature file.
17393
17394 @item
17395  In addition, I would love it if I could configure message-tab so that it
17396 could call `bbdb-complete-name' in other headers.  So, some sort of
17397 interface like
17398
17399 (setq message-tab-alist
17400       '((message-header-regexp message-expand-group)
17401         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
17402
17403 then you could run the relevant function to complete the information in
17404 the header
17405
17406 @item
17407  cache the newsgroups file locally to avoid reloading it all the time.
17408
17409 @item
17410  a command to import a buffer into a group.
17411
17412 @item
17413  nnweb should allow fetching by Message-ID from servers.
17414
17415 @item
17416  point in the article buffer doesn't always go to the
17417 beginning of the buffer when selecting new articles.
17418
17419 @item
17420  a command to process mark all unread articles.
17421
17422 @item
17423  `gnus-gather-threads-by-references-and-subject' -- first
17424 do gathering by references, and then go through the dummy roots and
17425 do more gathering by subject.
17426
17427 @item
17428  gnus-uu-mark-in-numerical-order -- process mark articles in
17429 article numerical order.
17430
17431 @item
17432  (gnus-thread-total-score
17433  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
17434 bind to a key.
17435
17436 @item
17437  sorting by score is wrong when using sparse threads.
17438
17439 @item
17440  a command to fetch an arbitrary article -- without having to be
17441 in the summary buffer.
17442
17443 @item
17444  a new nncvs backend.  Each group would show an article, using
17445 version branches as threading, checkin date as the date, etc.
17446
17447 @item
17448  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
17449 This filter allows one to construct advance queries on the Dejanews
17450 database such as specifying start and end dates, subject, author,
17451 and/or newsgroup name.
17452
17453 @item
17454  new Date header scoring type -- older, newer
17455
17456 @item
17457  use the summary toolbar in the article buffer.
17458
17459 @item
17460  a command to fetch all articles that are less than X days old.
17461
17462 @item
17463  in pick mode, `q' should save the list of selected articles in the
17464 group info.  The next time the group is selected, these articles
17465 will automatically get the process mark.
17466
17467 @item
17468  Isn't it possible to (also?) allow M-^ to automatically try the
17469 default server if it fails on the current server?  (controlled by a
17470 user variable, (nil, t, 'ask)).
17471
17472 @item
17473  make it possible to cancel articles using the select method for the
17474 current group.
17475
17476 @item
17477  `gnus-summary-select-article-on-entry' or something.  It'll default
17478 to t and will select whatever article decided by `gnus-auto-select-first'.
17479
17480 @item
17481  a new variable to control which selection commands should be unselecting.
17482 `first', `best', `next', `prev', `next-unread', `prev-unread' are
17483 candidates.
17484
17485 @item
17486  be able to select groups that have no articles in them
17487 to be able to post in them (using the current select method).
17488
17489 @item
17490  be able to post via DejaNews.
17491
17492 @item
17493  `x' should retain any sortings that have been performed.
17494
17495 @item
17496  allow the user to specify the precedence of the secondary marks.  Also
17497 allow them to be displayed separately.
17498
17499 @item
17500  gnus-summary-save-in-pipe should concatenate the results from
17501 the processes when doing a process marked pipe.
17502
17503 @item
17504  a new match type, like Followup, but which adds Thread matches on all
17505 articles that match a certain From header.
17506
17507 @item
17508  a function that can be read from kill-emacs-query-functions to offer
17509 saving living summary buffers.
17510
17511 @item
17512  a function for selecting a particular group which will contain
17513 the articles listed in a list of article numbers/id's.
17514
17515 @item
17516  a battery of character translation functions to translate common
17517 Mac, MS (etc) characters into ISO 8859-1.
17518
17519 @example
17520 (defun article-fix-m$word ()
17521   "Fix M$Word smartquotes in an article."
17522   (interactive)
17523   (save-excursion
17524     (let ((buffer-read-only nil))
17525       (goto-char (point-min))
17526       (while (search-forward "\221" nil t)
17527         (replace-match "`" t t))
17528       (goto-char (point-min))
17529       (while (search-forward "\222" nil t)
17530         (replace-match "'" t t))
17531       (goto-char (point-min))
17532       (while (search-forward "\223" nil t)
17533         (replace-match "\"" t t))
17534       (goto-char (point-min))
17535       (while (search-forward "\224" nil t)
17536         (replace-match "\"" t t)))))
17537 @end example
17538
17539 @item
17540 @example
17541  (add-hook 'gnus-exit-query-functions
17542 '(lambda ()
17543    (if (and (file-exists-p nnmail-spool-file)
17544             (> (nnheader-file-size nnmail-spool-file) 0))
17545        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
17546        (y-or-n-p "Are you sure you want to quit Gnus? "))))
17547 @end example
17548
17549 @item
17550  allow message-default-headers to be a function.
17551
17552 @item
17553  new Date score match types -- < > = (etc) that take floating point
17554 numbers and match on the age of the article.
17555
17556 @item
17557  gnus-cacheable-groups
17558
17559 @item
17560 @example
17561 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
17562 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
17563 >  > > buffer in the frame that it was called from =:-O
17564 >
17565 >  > Hm.  How do you start up Gnus?  From the toolbar or with
17566 >  > `M-x gnus-other-frame'?
17567 >
17568 >    I normally start it up from the toolbar; at
17569 > least that's the way I've caught it doing the
17570 > deed before.
17571 @end example
17572
17573 @item
17574  all commands that react to the process mark should push
17575 the current process mark set onto the stack.
17576
17577 @item
17578  gnus-article-hide-pgp
17579 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
17580 @example
17581 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
17582 @end example
17583 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
17584 er min type heuristikk og langt fra alles.
17585
17586 @item
17587  `gnus-subscribe-sorted' -- insert new groups where they would have been
17588 sorted to if `gnus-group-sort-function' were run.
17589
17590 @item
17591  gnus-(group,summary)-highlight should respect any `face' text props set
17592 on the lines.
17593
17594 @item
17595  use run-with-idle-timer for gnus-demon instead of the
17596 home-brewed stuff for better reliability.
17597
17598 @item
17599  add a way to select which NoCeM type to apply -- spam, troll, etc.
17600
17601 @item
17602  nndraft-request-group should tally autosave files.
17603
17604 @item
17605  implement nntp-retry-on-break and nntp-command-timeout.
17606
17607 @item
17608  gnus-article-highlight-limit that says when not to highlight (long)
17609 articles.
17610
17611 @item
17612  (nnoo-set SERVER VARIABLE VALUE)
17613
17614 @item
17615  nn*-spool-methods
17616
17617 @item
17618  interrupitng agent fetching of articles should save articles.
17619
17620 @item
17621  command to open a digest group, and copy all the articles there to the
17622 current group.
17623
17624 @item
17625  a variable to disable article body highlights if there's more than
17626 X characters in the body.
17627
17628 @item
17629  handle 480/381 authinfo requests separately.
17630
17631 @item
17632  include the texi/dir file in the distribution.
17633
17634 @item
17635  format spec to "tab" to a position.
17636
17637 @item
17638  Move all prompting to the new `M-n' default style.
17639
17640 @item
17641  command to display all dormant articles.
17642
17643 @item
17644  gnus-auto-select-next makeover -- list of things it should do.
17645
17646 @item
17647  a score match type that adds scores matching on From if From has replied
17648 to something someone else has said.
17649
17650 @item
17651  Read Netscape discussion groups:
17652 snews://secnews.netscape.com/netscape.communicator.unix
17653
17654 @item
17655 One command to edit the original version if an article, and one to edit
17656 the displayed version.
17657
17658 @item
17659 @kbd{T v} -- make all process-marked articles the children of the
17660 current article.
17661
17662 @item
17663 Switch from initial text to the new default text mechanism.
17664
17665 @item
17666 How about making it possible to expire local articles?  Will it be
17667 possible to make various constraints on when an article can be
17668 expired, e.g. (read), (age > 14 days), or the more interesting (read
17669 & age > 14 days)?
17670
17671 @item
17672 New limit command---limit to articles that have a certain string
17673 in the head or body.
17674
17675 @item
17676 Allow breaking lengthy NNTP commands.
17677
17678 @item
17679 gnus-article-highlight-limit, to disable highlighting in big articles.
17680
17681 @item
17682 Editing an article should put the article to be edited
17683 in a special, unique buffer.
17684
17685 @item
17686 A command to send a mail to the admin-address group param.
17687
17688 @item
17689 A Date scoring type that will match if the article
17690 is less than a certain number of days old.
17691
17692 @item
17693 New spec: %~(tab 56) to put point on column 56
17694
17695 @item
17696 Allow Gnus Agent scoring to use normal score files.
17697
17698 @item
17699 Rething the Agent active file thing.  `M-g' doesn't update the active
17700 file, for instance.
17701
17702 @item
17703 With dummy roots, `^' and then selecing the first article
17704 in any other dummy thread will make Gnus highlight the
17705 dummy root instead of the first article.
17706
17707 @item
17708 Propagate all group properties (marks, article numbers, etc) up to the
17709 topics for displaying.
17710
17711 @item
17712 `n' in the group buffer with topics should go to the next group
17713 with unread articles, even if that group is hidden in a topic.
17714
17715 @item
17716 gnus-posting-styles doesn't work in drafts.
17717
17718 @item
17719 gnus-summary-limit-include-cached is slow when there are
17720 many articles in the cache, since it regenerates big parts of the
17721 summary buffer for each article.
17722
17723 @item
17724 Solve the halting problem.
17725
17726 @c TODO
17727 @end itemize
17728
17729 @iftex
17730
17731 @page
17732 @node The Manual
17733 @section The Manual
17734 @cindex colophon
17735 @cindex manual
17736
17737 This manual was generated from a TeXinfo file and then run through
17738 either @code{texi2dvi}
17739 @iflatex
17740 or my own home-brewed TeXinfo to \LaTeX\ transformer,
17741 and then run through @code{latex} and @code{dvips}
17742 @end iflatex
17743 to get what you hold in your hands now.
17744
17745 The following conventions have been used:
17746
17747 @enumerate
17748
17749 @item
17750 This is a @samp{string}
17751
17752 @item
17753 This is a @kbd{keystroke}
17754
17755 @item
17756 This is a @file{file}
17757
17758 @item
17759 This is a @code{symbol}
17760
17761 @end enumerate
17762
17763 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
17764 mean:
17765
17766 @lisp
17767 (setq flargnoze "yes")
17768 @end lisp
17769
17770 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
17771
17772 @lisp
17773 (setq flumphel 'yes)
17774 @end lisp
17775
17776 @samp{yes} and @code{yes} are two @emph{very} different things---don't
17777 ever get them confused.
17778
17779 @iflatex
17780 @c @head
17781 Of course, everything in this manual is of vital interest, so you should
17782 read it all.  Several times.  However, if you feel like skimming the
17783 manual, look for that gnu head you should see in the margin over
17784 there---it means that what's being discussed is of more importance than
17785 the rest of the stuff.  (On the other hand, if everything is infinitely
17786 important, how can anything be more important than that?  Just one more
17787 of the mysteries of this world, I guess.)
17788 @end iflatex
17789
17790 @end iftex
17791
17792
17793 @page
17794 @node Terminology
17795 @section Terminology
17796
17797 @cindex terminology
17798 @table @dfn
17799
17800 @item news
17801 @cindex news
17802 This is what you are supposed to use this thing for---reading news.
17803 News is generally fetched from a nearby @sc{nntp} server, and is
17804 generally publicly available to everybody.  If you post news, the entire
17805 world is likely to read just what you have written, and they'll all
17806 snigger mischievously.  Behind your back.
17807
17808 @item mail
17809 @cindex mail
17810 Everything that's delivered to you personally is mail.  Some news/mail
17811 readers (like Gnus) blur the distinction between mail and news, but
17812 there is a difference.  Mail is private.  News is public.  Mailing is
17813 not posting, and replying is not following up.
17814
17815 @item reply
17816 @cindex reply
17817 Send a mail to the person who has written what you are reading.
17818
17819 @item follow up
17820 @cindex follow up
17821 Post an article to the current newsgroup responding to the article you
17822 are reading.
17823
17824 @item backend
17825 @cindex backend
17826 Gnus gets fed articles from a number of backends, both news and mail
17827 backends.  Gnus does not handle the underlying media, so to speak---this
17828 is all done by the backends.
17829
17830 @item native
17831 @cindex native
17832 Gnus will always use one method (and backend) as the @dfn{native}, or
17833 default, way of getting news.
17834
17835 @item foreign
17836 @cindex foreign
17837 You can also have any number of foreign groups active at the same time.
17838 These are groups that use non-native non-secondary backends for getting
17839 news.
17840
17841 @item secondary
17842 @cindex secondary
17843 Secondary backends are somewhere half-way between being native and being
17844 foreign, but they mostly act like they are native.
17845
17846 @item article
17847 @cindex article
17848 A message that has been posted as news.
17849
17850 @item mail message
17851 @cindex mail message
17852 A message that has been mailed.
17853
17854 @item message
17855 @cindex message
17856 A mail message or news article
17857
17858 @item head
17859 @cindex head
17860 The top part of a message, where administrative information (etc.) is
17861 put.
17862
17863 @item body
17864 @cindex body
17865 The rest of an article.  Everything not in the head is in the
17866 body.
17867
17868 @item header
17869 @cindex header
17870 A line from the head of an article.
17871
17872 @item headers
17873 @cindex headers
17874 A collection of such lines, or a collection of heads.  Or even a
17875 collection of @sc{nov} lines.
17876
17877 @item @sc{nov}
17878 @cindex nov
17879 When Gnus enters a group, it asks the backend for the headers of all
17880 unread articles in the group.  Most servers support the News OverView
17881 format, which is more compact and much faster to read and parse than the
17882 normal @sc{head} format.
17883
17884 @item level
17885 @cindex levels
17886 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
17887 that have a lower level are ``more'' subscribed than the groups with a
17888 higher level.  In fact, groups on levels 1-5 are considered
17889 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
17890 are @dfn{killed}.  Commands for listing groups and scanning for new
17891 articles will all use the numeric prefix as @dfn{working level}.
17892
17893 @item killed groups
17894 @cindex killed groups
17895 No information on killed groups is stored or updated, which makes killed
17896 groups much easier to handle than subscribed groups.
17897
17898 @item zombie groups
17899 @cindex zombie groups
17900 Just like killed groups, only slightly less dead.
17901
17902 @item active file
17903 @cindex active file
17904 The news server has to keep track of what articles it carries, and what
17905 groups exist.  All this information in stored in the active file, which
17906 is rather large, as you might surmise.
17907
17908 @item bogus groups
17909 @cindex bogus groups
17910 A group that exists in the @file{.newsrc} file, but isn't known to the
17911 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
17912 This means that the group probably doesn't exist (any more).
17913
17914 @item activating
17915 @cindex activating groups
17916 The act of asking the server for info on a group and computing the
17917 number of unread articles is called @dfn{activating the group}.
17918 Un-activated groups are listed with @samp{*} in the group buffer.
17919
17920 @item server
17921 @cindex server
17922 A machine one can connect to and get news (or mail) from.
17923
17924 @item select method
17925 @cindex select method
17926 A structure that specifies the backend, the server and the virtual
17927 server settings.
17928
17929 @item virtual server
17930 @cindex virtual server
17931 A named select method.  Since a select method defines all there is to
17932 know about connecting to a (physical) server, taking the thing as a
17933 whole is a virtual server.
17934
17935 @item washing
17936 @cindex washing
17937 Taking a buffer and running it through a filter of some sort.  The
17938 result will (more often than not) be cleaner and more pleasing than the
17939 original.
17940
17941 @item ephemeral groups
17942 @cindex ephemeral groups
17943 Most groups store data on what articles you have read.  @dfn{Ephemeral}
17944 groups are groups that will have no data stored---when you exit the
17945 group, it'll disappear into the aether.
17946
17947 @item solid groups
17948 @cindex solid groups
17949 This is the opposite of ephemeral groups.  All groups listed in the
17950 group buffer are solid groups.
17951
17952 @item sparse articles
17953 @cindex sparse articles
17954 These are article placeholders shown in the summary buffer when
17955 @code{gnus-build-sparse-threads} has been switched on.
17956
17957 @item threading
17958 @cindex threading
17959 To put responses to articles directly after the articles they respond
17960 to---in a hierarchical fashion.
17961
17962 @item root
17963 @cindex root
17964 @cindex thread root
17965 The first article in a thread is the root.  It is the ancestor of all
17966 articles in the thread.
17967
17968 @item parent
17969 @cindex parent
17970 An article that has responses.
17971
17972 @item child
17973 @cindex child
17974 An article that responds to a different article---its parent.
17975
17976 @item digest
17977 @cindex digest
17978 A collection of messages in one file.  The most common digest format is
17979 specified by RFC1153.
17980
17981 @end table
17982
17983
17984 @page
17985 @node Customization
17986 @section Customization
17987 @cindex general customization
17988
17989 All variables are properly documented elsewhere in this manual.  This
17990 section is designed to give general pointers on how to customize Gnus
17991 for some quite common situations.
17992
17993 @menu
17994 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
17995 * Slow Terminal Connection::  You run a remote Emacs.
17996 * Little Disk Space::         You feel that having large setup files is icky.
17997 * Slow Machine::              You feel like buying a faster machine.
17998 @end menu
17999
18000
18001 @node Slow/Expensive Connection
18002 @subsection Slow/Expensive @sc{nntp} Connection
18003
18004 If you run Emacs on a machine locally, and get your news from a machine
18005 over some very thin strings, you want to cut down on the amount of data
18006 Gnus has to get from the @sc{nntp} server.
18007
18008 @table @code
18009
18010 @item gnus-read-active-file
18011 Set this to @code{nil}, which will inhibit Gnus from requesting the
18012 entire active file from the server.  This file is often v.  large.  You
18013 also have to set @code{gnus-check-new-newsgroups} and
18014 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
18015 doesn't suddenly decide to fetch the active file anyway.
18016
18017 @item gnus-nov-is-evil
18018 This one has to be @code{nil}.  If not, grabbing article headers from
18019 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
18020 support @sc{xover}; Gnus will detect this by itself.
18021 @end table
18022
18023
18024 @node Slow Terminal Connection
18025 @subsection Slow Terminal Connection
18026
18027 Let's say you use your home computer for dialing up the system that runs
18028 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
18029 possible) the amount of data sent over the wires.
18030
18031 @table @code
18032
18033 @item gnus-auto-center-summary
18034 Set this to @code{nil} to inhibit Gnus from re-centering the summary
18035 buffer all the time.  If it is @code{vertical}, do only vertical
18036 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
18037 horizontal and vertical recentering.
18038
18039 @item gnus-visible-headers
18040 Cut down on the headers included in the articles to the
18041 minimum.  You can, in fact, make do without them altogether---most of the
18042 useful data is in the summary buffer, anyway.  Set this variable to
18043 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
18044
18045 @item gnus-article-display-hook
18046 Set this hook to all the available hiding commands:
18047 @lisp
18048 (setq gnus-article-display-hook
18049       '(gnus-article-hide-headers gnus-article-hide-signature
18050         gnus-article-hide-citation))
18051 @end lisp
18052
18053 @item gnus-use-full-window
18054 By setting this to @code{nil}, you can make all the windows smaller.
18055 While this doesn't really cut down much generally, it means that you
18056 have to see smaller portions of articles before deciding that you didn't
18057 want to read them anyway.
18058
18059 @item gnus-thread-hide-subtree
18060 If this is non-@code{nil}, all threads in the summary buffer will be
18061 hidden initially.
18062
18063 @item gnus-updated-mode-lines
18064 If this is @code{nil}, Gnus will not put information in the buffer mode
18065 lines, which might save some time.
18066 @end table
18067
18068
18069 @node Little Disk Space
18070 @subsection Little Disk Space
18071 @cindex disk space
18072
18073 The startup files can get rather large, so you may want to cut their
18074 sizes a bit if you are running out of space.
18075
18076 @table @code
18077
18078 @item gnus-save-newsrc-file
18079 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
18080 only save @file{.newsrc.eld}.  This means that you will not be able to
18081 use any other newsreaders than Gnus.  This variable is @code{t} by
18082 default.
18083
18084 @item gnus-save-killed-list
18085 If this is @code{nil}, Gnus will not save the list of dead groups.  You
18086 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
18087 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
18088 variable to @code{nil}.  This variable is @code{t} by default.
18089
18090 @end table
18091
18092
18093 @node Slow Machine
18094 @subsection Slow Machine
18095 @cindex slow machine
18096
18097 If you have a slow machine, or are just really impatient, there are a
18098 few things you can do to make Gnus run faster.
18099
18100 Set @code{gnus-check-new-newsgroups} and
18101 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
18102
18103 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
18104 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
18105 summary buffer faster.
18106
18107 Set @code{gnus-article-display-hook} to @code{nil} to make article
18108 processing a bit faster.
18109
18110
18111 @page
18112 @node Troubleshooting
18113 @section Troubleshooting
18114 @cindex troubleshooting
18115
18116 Gnus works @emph{so} well straight out of the box---I can't imagine any
18117 problems, really.
18118
18119 Ahem.
18120
18121 @enumerate
18122
18123 @item
18124 Make sure your computer is switched on.
18125
18126 @item
18127 Make sure that you really load the current Gnus version.  If you have
18128 been running @sc{gnus}, you need to exit Emacs and start it up again before
18129 Gnus will work.
18130
18131 @item
18132 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
18133 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
18134 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
18135 flee}, you have some old @file{.el} files lying around.  Delete these.
18136
18137 @item
18138 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
18139 how-to.
18140
18141 @item
18142 @vindex max-lisp-eval-depth
18143 Gnus works on many recursive structures, and in some extreme (and very
18144 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
18145 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
18146 something like that.
18147 @end enumerate
18148
18149 If all else fails, report the problem as a bug.
18150
18151 @cindex bugs
18152 @cindex reporting bugs
18153
18154 @kindex M-x gnus-bug
18155 @findex gnus-bug
18156 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
18157 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
18158 me the backtrace.  I will fix bugs, but I can only fix them if you send
18159 me a precise description as to how to reproduce the bug.
18160
18161 You really can never be too detailed in a bug report.  Always use the
18162 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
18163 a 10Kb mail each time you use it, and even if you have sent me your
18164 environment 500 times before.  I don't care.  I want the full info each
18165 time.
18166
18167 It is also important to remember that I have no memory whatsoever.  If
18168 you send a bug report, and I send you a reply, and then you just send
18169 back ``No, it's not! Moron!'', I will have no idea what you are
18170 insulting me about.  Always over-explain everything.  It's much easier
18171 for all of us---if I don't have all the information I need, I will just
18172 mail you and ask for more info, and everything takes more time.
18173
18174 If the problem you're seeing is very visual, and you can't quite explain
18175 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
18176 it somewhere it can be reached, and include the URL of the picture in
18177 the bug report.
18178
18179 If you just need help, you are better off asking on
18180 @samp{gnu.emacs.gnus}.  I'm not very helpful.
18181
18182 @cindex gnu.emacs.gnus
18183 @cindex ding mailing list
18184 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
18185 Write to @samp{ding-request@@gnus.org} to subscribe.
18186
18187
18188 @page
18189 @node A Programmers Guide to Gnus
18190 @section A Programmer@'s Guide to Gnus
18191
18192 It is my hope that other people will figure out smart stuff that Gnus
18193 can do, and that other people will write those smart things as well.  To
18194 facilitate that I thought it would be a good idea to describe the inner
18195 workings of Gnus.  And some of the not-so-inner workings, while I'm at
18196 it.
18197
18198 You can never expect the internals of a program not to change, but I
18199 will be defining (in some details) the interface between Gnus and its
18200 backends (this is written in stone), the format of the score files
18201 (ditto), data structures (some are less likely to change than others)
18202 and general methods of operation.
18203
18204 @menu
18205 * Gnus Utility Functions::   Common functions and variable to use.
18206 * Backend Interface::        How Gnus communicates with the servers.
18207 * Score File Syntax::        A BNF definition of the score file standard.
18208 * Headers::                  How Gnus stores headers internally.
18209 * Ranges::                   A handy format for storing mucho numbers.
18210 * Group Info::               The group info format.
18211 * Extended Interactive::     Symbolic prefixes and stuff.
18212 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
18213 * Various File Formats::     Formats of files that Gnus use.
18214 @end menu
18215
18216
18217 @node Gnus Utility Functions
18218 @subsection Gnus Utility Functions
18219 @cindex Gnus utility functions
18220 @cindex utility functions
18221 @cindex functions
18222 @cindex internal variables
18223
18224 When writing small functions to be run from hooks (and stuff), it's
18225 vital to have access to the Gnus internal functions and variables.
18226 Below is a list of the most common ones.
18227
18228 @table @code
18229
18230 @item gnus-newsgroup-name
18231 @vindex gnus-newsgroup-name
18232 This variable holds the name of the current newsgroup.
18233
18234 @item gnus-find-method-for-group
18235 @findex gnus-find-method-for-group
18236 A function that returns the select method for @var{group}.
18237
18238 @item gnus-group-real-name
18239 @findex gnus-group-real-name
18240 Takes a full (prefixed) Gnus group name, and returns the unprefixed
18241 name.
18242
18243 @item gnus-group-prefixed-name
18244 @findex gnus-group-prefixed-name
18245 Takes an unprefixed group name and a select method, and returns the full
18246 (prefixed) Gnus group name.
18247
18248 @item gnus-get-info
18249 @findex gnus-get-info
18250 Returns the group info list for @var{group}.
18251
18252 @item gnus-group-unread
18253 @findex gnus-group-unread
18254 The number of unread articles in @var{group}, or @code{t} if that is
18255 unknown.
18256
18257 @item gnus-active
18258 @findex gnus-active
18259 The active entry for @var{group}.
18260
18261 @item gnus-set-active
18262 @findex gnus-set-active
18263 Set the active entry for @var{group}.
18264
18265 @item gnus-add-current-to-buffer-list
18266 @findex gnus-add-current-to-buffer-list
18267 Adds the current buffer to the list of buffers to be killed on Gnus
18268 exit.
18269
18270 @item gnus-continuum-version
18271 @findex gnus-continuum-version
18272 Takes a Gnus version string as a parameter and returns a floating point
18273 number.  Earlier versions will always get a lower number than later
18274 versions.
18275
18276 @item gnus-group-read-only-p
18277 @findex gnus-group-read-only-p
18278 Says whether @var{group} is read-only or not.
18279
18280 @item gnus-news-group-p
18281 @findex gnus-news-group-p
18282 Says whether @var{group} came from a news backend.
18283
18284 @item gnus-ephemeral-group-p
18285 @findex gnus-ephemeral-group-p
18286 Says whether @var{group} is ephemeral or not.
18287
18288 @item gnus-server-to-method
18289 @findex gnus-server-to-method
18290 Returns the select method corresponding to @var{server}.
18291
18292 @item gnus-server-equal
18293 @findex gnus-server-equal
18294 Says whether two virtual servers are equal.
18295
18296 @item gnus-group-native-p
18297 @findex gnus-group-native-p
18298 Says whether @var{group} is native or not.
18299
18300 @item gnus-group-secondary-p
18301 @findex gnus-group-secondary-p
18302 Says whether @var{group} is secondary or not.
18303
18304 @item gnus-group-foreign-p
18305 @findex gnus-group-foreign-p
18306 Says whether @var{group} is foreign or not.
18307
18308 @item group-group-find-parameter
18309 @findex group-group-find-parameter
18310 Returns the parameter list of @var{group}.  If given a second parameter,
18311 returns the value of that parameter for @var{group}.
18312
18313 @item gnus-group-set-parameter
18314 @findex gnus-group-set-parameter
18315 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
18316
18317 @item gnus-narrow-to-body
18318 @findex gnus-narrow-to-body
18319 Narrows the current buffer to the body of the article.
18320
18321 @item gnus-check-backend-function
18322 @findex gnus-check-backend-function
18323 Takes two parameters, @var{function} and @var{group}.  If the backend
18324 @var{group} comes from supports @var{function}, return non-@code{nil}.
18325
18326 @lisp
18327 (gnus-check-backend-function "request-scan" "nnml:misc")
18328 => t
18329 @end lisp
18330
18331 @item gnus-read-method
18332 @findex gnus-read-method
18333 Prompts the user for a select method.
18334
18335 @end table
18336
18337
18338 @node Backend Interface
18339 @subsection Backend Interface
18340
18341 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
18342 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
18343 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
18344 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
18345 examples of the latter we have @code{nntp-port-number} and
18346 @code{nnmbox-directory}.
18347
18348 When Gnus asks for information from a backend---say @code{nntp}---on
18349 something, it will normally include a virtual server name in the
18350 function parameters.  (If not, the backend should use the ``current''
18351 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
18352 server as its only (optional) parameter.  If this virtual server hasn't
18353 been opened, the function should fail.
18354
18355 Note that a virtual server name has no relation to some physical server
18356 name.  Take this example:
18357
18358 @lisp
18359 (nntp "odd-one"
18360       (nntp-address "ifi.uio.no")
18361       (nntp-port-number 4324))
18362 @end lisp
18363
18364 Here the virtual server name is @samp{odd-one} while the name of
18365 the physical server is @samp{ifi.uio.no}.
18366
18367 The backends should be able to switch between several virtual servers.
18368 The standard backends implement this by keeping an alist of virtual
18369 server environments that they pull down/push up when needed.
18370
18371 There are two groups of interface functions: @dfn{required functions},
18372 which must be present, and @dfn{optional functions}, which Gnus will
18373 always check for presence before attempting to call 'em.
18374
18375 All these functions are expected to return data in the buffer
18376 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
18377 unfortunately named, but we'll have to live with it.  When I talk about
18378 @dfn{resulting data}, I always refer to the data in that buffer.  When I
18379 talk about @dfn{return value}, I talk about the function value returned by
18380 the function call.  Functions that fail should return @code{nil} as the
18381 return value.
18382
18383 Some backends could be said to be @dfn{server-forming} backends, and
18384 some might be said not to be.  The latter are backends that generally
18385 only operate on one group at a time, and have no concept of ``server''
18386 -- they have a group, and they deliver info on that group and nothing
18387 more.
18388
18389 In the examples and definitions I will refer to the imaginary backend
18390 @code{nnchoke}.
18391
18392 @cindex @code{nnchoke}
18393
18394 @menu
18395 * Required Backend Functions::        Functions that must be implemented.
18396 * Optional Backend Functions::        Functions that need not be implemented.
18397 * Error Messaging::                   How to get messages and report errors.
18398 * Writing New Backends::              Extending old backends.
18399 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
18400 * Mail-like Backends::                Some tips on mail backends.
18401 @end menu
18402
18403
18404 @node Required Backend Functions
18405 @subsubsection Required Backend Functions
18406
18407 @table @code
18408
18409 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
18410
18411 @var{articles} is either a range of article numbers or a list of
18412 @code{Message-ID}s.  Current backends do not fully support either---only
18413 sequences (lists) of article numbers, and most backends do not support
18414 retrieval of @code{Message-ID}s.  But they should try for both.
18415
18416 The result data should either be HEADs or NOV lines, and the result
18417 value should either be @code{headers} or @code{nov} to reflect this.
18418 This might later be expanded to @code{various}, which will be a mixture
18419 of HEADs and NOV lines, but this is currently not supported by Gnus.
18420
18421 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
18422 headers", in some meaning of the word.  This is generally done by
18423 fetching (at most) @var{fetch-old} extra headers less than the smallest
18424 article number in @code{articles}, and filling the gaps as well.  The
18425 presence of this parameter can be ignored if the backend finds it
18426 cumbersome to follow the request.  If this is non-@code{nil} and not a
18427 number, do maximum fetches.
18428
18429 Here's an example HEAD:
18430
18431 @example
18432 221 1056 Article retrieved.
18433 Path: ifi.uio.no!sturles
18434 From: sturles@@ifi.uio.no (Sturle Sunde)
18435 Newsgroups: ifi.discussion
18436 Subject: Re: Something very droll
18437 Date: 27 Oct 1994 14:02:57 +0100
18438 Organization: Dept. of Informatics, University of Oslo, Norway
18439 Lines: 26
18440 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
18441 References: <38jdmq$4qu@@visbur.ifi.uio.no>
18442 NNTP-Posting-Host: holmenkollen.ifi.uio.no
18443 .
18444 @end example
18445
18446 So a @code{headers} return value would imply that there's a number of
18447 these in the data buffer.
18448
18449 Here's a BNF definition of such a buffer:
18450
18451 @example
18452 headers        = *head
18453 head           = error / valid-head
18454 error-message  = [ "4" / "5" ] 2number " " <error message> eol
18455 valid-head     = valid-message *header "." eol
18456 valid-message  = "221 " <number> " Article retrieved." eol
18457 header         = <text> eol
18458 @end example
18459
18460 If the return value is @code{nov}, the data buffer should contain
18461 @dfn{network overview database} lines.  These are basically fields
18462 separated by tabs.
18463
18464 @example
18465 nov-buffer = *nov-line
18466 nov-line   = 8*9 [ field <TAB> ] eol
18467 field      = <text except TAB>
18468 @end example
18469
18470 For a closer look at what should be in those fields,
18471 @pxref{Headers}.
18472
18473
18474 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
18475
18476 @var{server} is here the virtual server name.  @var{definitions} is a
18477 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
18478
18479 If the server can't be opened, no error should be signaled.  The backend
18480 may then choose to refuse further attempts at connecting to this
18481 server.  In fact, it should do so.
18482
18483 If the server is opened already, this function should return a
18484 non-@code{nil} value.  There should be no data returned.
18485
18486
18487 @item (nnchoke-close-server &optional SERVER)
18488
18489 Close connection to @var{server} and free all resources connected
18490 to it.  Return @code{nil} if the server couldn't be closed for some
18491 reason.
18492
18493 There should be no data returned.
18494
18495
18496 @item (nnchoke-request-close)
18497
18498 Close connection to all servers and free all resources that the backend
18499 have reserved.  All buffers that have been created by that backend
18500 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
18501 function is generally only called when Gnus is shutting down.
18502
18503 There should be no data returned.
18504
18505
18506 @item (nnchoke-server-opened &optional SERVER)
18507
18508 If @var{server} is the current virtual server, and the connection to the
18509 physical server is alive, then this function should return a
18510 non-@code{nil} vlue.  This function should under no circumstances
18511 attempt to reconnect to a server we have lost connection to.
18512
18513 There should be no data returned.
18514
18515
18516 @item (nnchoke-status-message &optional SERVER)
18517
18518 This function should return the last error message from @var{server}.
18519
18520 There should be no data returned.
18521
18522
18523 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
18524
18525 The result data from this function should be the article specified by
18526 @var{article}.  This might either be a @code{Message-ID} or a number.
18527 It is optional whether to implement retrieval by @code{Message-ID}, but
18528 it would be nice if that were possible.
18529
18530 If @var{to-buffer} is non-@code{nil}, the result data should be returned
18531 in this buffer instead of the normal data buffer.  This is to make it
18532 possible to avoid copying large amounts of data from one buffer to
18533 another, while Gnus mainly requests articles to be inserted directly
18534 into its article buffer.
18535
18536 If it is at all possible, this function should return a cons cell where
18537 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
18538 the article number.  This will enable Gnus to find out what the real
18539 group and article numbers are when fetching articles by
18540 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
18541 on successful article retrieval.
18542
18543
18544 @item (nnchoke-request-group GROUP &optional SERVER FAST)
18545
18546 Get data on @var{group}.  This function also has the side effect of
18547 making @var{group} the current group.
18548
18549 If @var{FAST}, don't bother to return useful data, just make @var{group}
18550 the current group.
18551
18552 Here's an example of some result data and a definition of the same:
18553
18554 @example
18555 211 56 1000 1059 ifi.discussion
18556 @end example
18557
18558 The first number is the status, which should be 211.  Next is the
18559 total number of articles in the group, the lowest article number, the
18560 highest article number, and finally the group name.  Note that the total
18561 number of articles may be less than one might think while just
18562 considering the highest and lowest article numbers, but some articles
18563 may have been canceled.  Gnus just discards the total-number, so
18564 whether one should take the bother to generate it properly (if that is a
18565 problem) is left as an exercise to the reader.
18566
18567 @example
18568 group-status = [ error / info ] eol
18569 error        = [ "4" / "5" ] 2<number> " " <Error message>
18570 info         = "211 " 3* [ <number> " " ] <string>
18571 @end example
18572
18573
18574 @item (nnchoke-close-group GROUP &optional SERVER)
18575
18576 Close @var{group} and free any resources connected to it.  This will be
18577 a no-op on most backends.
18578
18579 There should be no data returned.
18580
18581
18582 @item (nnchoke-request-list &optional SERVER)
18583
18584 Return a list of all groups available on @var{server}.  And that means
18585 @emph{all}.
18586
18587 Here's an example from a server that only carries two groups:
18588
18589 @example
18590 ifi.test 0000002200 0000002000 y
18591 ifi.discussion 3324 3300 n
18592 @end example
18593
18594 On each line we have a group name, then the highest article number in
18595 that group, the lowest article number, and finally a flag.
18596
18597 @example
18598 active-file = *active-line
18599 active-line = name " " <number> " " <number> " " flags eol
18600 name        = <string>
18601 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
18602 @end example
18603
18604 The flag says whether the group is read-only (@samp{n}), is moderated
18605 (@samp{m}), is dead (@samp{x}), is aliased to some other group
18606 (@samp{=other-group}) or none of the above (@samp{y}).
18607
18608
18609 @item (nnchoke-request-post &optional SERVER)
18610
18611 This function should post the current buffer.  It might return whether
18612 the posting was successful or not, but that's not required.  If, for
18613 instance, the posting is done asynchronously, it has generally not been
18614 completed by the time this function concludes.  In that case, this
18615 function should set up some kind of sentinel to beep the user loud and
18616 clear if the posting could not be completed.
18617
18618 There should be no result data from this function.
18619
18620 @end table
18621
18622
18623 @node Optional Backend Functions
18624 @subsubsection Optional Backend Functions
18625
18626 @table @code
18627
18628 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
18629
18630 @var{groups} is a list of groups, and this function should request data
18631 on all those groups.  How it does it is of no concern to Gnus, but it
18632 should attempt to do this in a speedy fashion.
18633
18634 The return value of this function can be either @code{active} or
18635 @code{group}, which says what the format of the result data is.  The
18636 former is in the same format as the data from
18637 @code{nnchoke-request-list}, while the latter is a buffer full of lines
18638 in the same format as @code{nnchoke-request-group} gives.
18639
18640 @example
18641 group-buffer = *active-line / *group-status
18642 @end example
18643
18644
18645 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
18646
18647 A Gnus group info (@pxref{Group Info}) is handed to the backend for
18648 alterations.  This comes in handy if the backend really carries all the
18649 information (as is the case with virtual and imap groups).  This
18650 function should destructively alter the info to suit its needs, and
18651 should return the (altered) group info.
18652
18653 There should be no result data from this function.
18654
18655
18656 @item (nnchoke-request-type GROUP &optional ARTICLE)
18657
18658 When the user issues commands for ``sending news'' (@kbd{F} in the
18659 summary buffer, for instance), Gnus has to know whether the article the
18660 user is following up on is news or mail.  This function should return
18661 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
18662 is mail and @code{unknown} if the type can't be decided.  (The
18663 @var{article} parameter is necessary in @code{nnvirtual} groups which
18664 might very well combine mail groups and news groups.)  Both @var{group}
18665 and @var{article} may be @code{nil}.
18666
18667 There should be no result data from this function.
18668
18669
18670 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
18671
18672 If the user tries to set a mark that the backend doesn't like, this
18673 function may change the mark.  Gnus will use whatever this function
18674 returns as the mark for @var{article} instead of the original
18675 @var{mark}.  If the backend doesn't care, it must return the original
18676 @var{mark}, and not @code{nil} or any other type of garbage.
18677
18678 The only use for this I can see is what @code{nnvirtual} does with
18679 it---if a component group is auto-expirable, marking an article as read
18680 in the virtual group should result in the article being marked as
18681 expirable.
18682
18683 There should be no result data from this function.
18684
18685
18686 @item (nnchoke-request-scan &optional GROUP SERVER)
18687
18688 This function may be called at any time (by Gnus or anything else) to
18689 request that the backend check for incoming articles, in one way or
18690 another.  A mail backend will typically read the spool file or query the
18691 POP server when this function is invoked.  The @var{group} doesn't have
18692 to be heeded---if the backend decides that it is too much work just
18693 scanning for a single group, it may do a total scan of all groups.  It
18694 would be nice, however, to keep things local if that's practical.
18695
18696 There should be no result data from this function.
18697
18698
18699 @item (nnchoke-request-group-description GROUP &optional SERVER)
18700
18701 The result data from this function should be a description of
18702 @var{group}.
18703
18704 @example
18705 description-line = name <TAB> description eol
18706 name             = <string>
18707 description      = <text>
18708 @end example
18709
18710 @item (nnchoke-request-list-newsgroups &optional SERVER)
18711
18712 The result data from this function should be the description of all
18713 groups available on the server.
18714
18715 @example
18716 description-buffer = *description-line
18717 @end example
18718
18719
18720 @item (nnchoke-request-newgroups DATE &optional SERVER)
18721
18722 The result data from this function should be all groups that were
18723 created after @samp{date}, which is in normal human-readable date
18724 format.  The data should be in the active buffer format.
18725
18726
18727 @item (nnchoke-request-create-group GROUP &optional SERVER)
18728
18729 This function should create an empty group with name @var{group}.
18730
18731 There should be no return data.
18732
18733
18734 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
18735
18736 This function should run the expiry process on all articles in the
18737 @var{articles} range (which is currently a simple list of article
18738 numbers.)  It is left up to the backend to decide how old articles
18739 should be before they are removed by this function.  If @var{force} is
18740 non-@code{nil}, all @var{articles} should be deleted, no matter how new
18741 they are.
18742
18743 This function should return a list of articles that it did not/was not
18744 able to delete.
18745
18746 There should be no result data returned.
18747
18748
18749 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
18750 &optional LAST)
18751
18752 This function should move @var{article} (which is a number) from
18753 @var{group} by calling @var{accept-form}.
18754
18755 This function should ready the article in question for moving by
18756 removing any header lines it has added to the article, and generally
18757 should ``tidy up'' the article.  Then it should @code{eval}
18758 @var{accept-form} in the buffer where the ``tidy'' article is.  This
18759 will do the actual copying.  If this @code{eval} returns a
18760 non-@code{nil} value, the article should be removed.
18761
18762 If @var{last} is @code{nil}, that means that there is a high likelihood
18763 that there will be more requests issued shortly, so that allows some
18764 optimizations.
18765
18766 The function should return a cons where the @code{car} is the group name and
18767 the @code{cdr} is the article number that the article was entered as.
18768
18769 There should be no data returned.
18770
18771
18772 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
18773
18774 This function takes the current buffer and inserts it into @var{group}.
18775 If @var{last} in @code{nil}, that means that there will be more calls to
18776 this function in short order.
18777
18778 The function should return a cons where the @code{car} is the group name and
18779 the @code{cdr} is the article number that the article was entered as.
18780
18781 There should be no data returned.
18782
18783
18784 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
18785
18786 This function should remove @var{article} (which is a number) from
18787 @var{group} and insert @var{buffer} there instead.
18788
18789 There should be no data returned.
18790
18791
18792 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
18793
18794 This function should delete @var{group}.  If @var{force}, it should
18795 really delete all the articles in the group, and then delete the group
18796 itself.  (If there is such a thing as ``the group itself''.)
18797
18798 There should be no data returned.
18799
18800
18801 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
18802
18803 This function should rename @var{group} into @var{new-name}.  All
18804 articles in @var{group} should move to @var{new-name}.
18805
18806 There should be no data returned.
18807
18808 @end table
18809
18810
18811 @node Error Messaging
18812 @subsubsection Error Messaging
18813
18814 @findex nnheader-report
18815 @findex nnheader-get-report
18816 The backends should use the function @code{nnheader-report} to report
18817 error conditions---they should not raise errors when they aren't able to
18818 perform a request.  The first argument to this function is the backend
18819 symbol, and the rest are interpreted as arguments to @code{format} if
18820 there are multiple of them, or just a string if there is one of them.
18821 This function must always returns @code{nil}.
18822
18823 @lisp
18824 (nnheader-report 'nnchoke "You did something totally bogus")
18825
18826 (nnheader-report 'nnchoke "Could not request group %s" group)
18827 @end lisp
18828
18829 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
18830 @code{nil} back from a server, and this function returns the most
18831 recently reported message for the backend in question.  This function
18832 takes one argument---the server symbol.
18833
18834 Internally, these functions access @var{backend}@code{-status-string},
18835 so the @code{nnchoke} backend will have its error message stored in
18836 @code{nnchoke-status-string}.
18837
18838
18839 @node Writing New Backends
18840 @subsubsection Writing New Backends
18841
18842 Many backends are quite similar.  @code{nnml} is just like
18843 @code{nnspool}, but it allows you to edit the articles on the server.
18844 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
18845 and it doesn't maintain overview databases.  @code{nndir} is just like
18846 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
18847 editing articles.
18848
18849 It would make sense if it were possible to ``inherit'' functions from
18850 backends when writing new backends.  And, indeed, you can do that if you
18851 want to.  (You don't have to if you don't want to, of course.)
18852
18853 All the backends declare their public variables and functions by using a
18854 package called @code{nnoo}.
18855
18856 To inherit functions from other backends (and allow other backends to
18857 inherit functions from the current backend), you should use the
18858 following macros:
18859
18860 @table @code
18861
18862 @item nnoo-declare
18863 This macro declares the first parameter to be a child of the subsequent
18864 parameters.  For instance:
18865
18866 @lisp
18867 (nnoo-declare nndir
18868   nnml nnmh)
18869 @end lisp
18870
18871 @code{nndir} has declared here that it intends to inherit functions from
18872 both @code{nnml} and @code{nnmh}.
18873
18874 @item defvoo
18875 This macro is equivalent to @code{defvar}, but registers the variable as
18876 a public server variable.  Most state-oriented variables should be
18877 declared with @code{defvoo} instead of @code{defvar}.
18878
18879 In addition to the normal @code{defvar} parameters, it takes a list of
18880 variables in the parent backends to map the variable to when executing
18881 a function in those backends.
18882
18883 @lisp
18884 (defvoo nndir-directory nil
18885   "Where nndir will look for groups."
18886   nnml-current-directory nnmh-current-directory)
18887 @end lisp
18888
18889 This means that @code{nnml-current-directory} will be set to
18890 @code{nndir-directory} when an @code{nnml} function is called on behalf
18891 of @code{nndir}.  (The same with @code{nnmh}.)
18892
18893 @item nnoo-define-basics
18894 This macro defines some common functions that almost all backends should
18895 have.
18896
18897 @example
18898 (nnoo-define-basics nndir)
18899 @end example
18900
18901 @item deffoo
18902 This macro is just like @code{defun} and takes the same parameters.  In
18903 addition to doing the normal @code{defun} things, it registers the
18904 function as being public so that other backends can inherit it.
18905
18906 @item nnoo-map-functions
18907 This macro allows mapping of functions from the current backend to
18908 functions from the parent backends.
18909
18910 @example
18911 (nnoo-map-functions nndir
18912   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18913   (nnmh-request-article 0 nndir-current-group 0 0))
18914 @end example
18915
18916 This means that when @code{nndir-retrieve-headers} is called, the first,
18917 third, and fourth parameters will be passed on to
18918 @code{nnml-retrieve-headers}, while the second parameter is set to the
18919 value of @code{nndir-current-group}.
18920
18921 @item nnoo-import
18922 This macro allows importing functions from backends.  It should be the
18923 last thing in the source file, since it will only define functions that
18924 haven't already been defined.
18925
18926 @example
18927 (nnoo-import nndir
18928   (nnmh
18929    nnmh-request-list
18930    nnmh-request-newgroups)
18931   (nnml))
18932 @end example
18933
18934 This means that calls to @code{nndir-request-list} should just be passed
18935 on to @code{nnmh-request-list}, while all public functions from
18936 @code{nnml} that haven't been defined in @code{nndir} yet should be
18937 defined now.
18938
18939 @end table
18940
18941 Below is a slightly shortened version of the @code{nndir} backend.
18942
18943 @lisp
18944 ;;; nndir.el --- single directory newsgroup access for Gnus
18945 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
18946
18947 ;;; Code:
18948
18949 (require 'nnheader)
18950 (require 'nnmh)
18951 (require 'nnml)
18952 (require 'nnoo)
18953 (eval-when-compile (require 'cl))
18954
18955 (nnoo-declare nndir
18956   nnml nnmh)
18957
18958 (defvoo nndir-directory nil
18959   "Where nndir will look for groups."
18960   nnml-current-directory nnmh-current-directory)
18961
18962 (defvoo nndir-nov-is-evil nil
18963   "*Non-nil means that nndir will never retrieve NOV headers."
18964   nnml-nov-is-evil)
18965
18966 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
18967 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
18968 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
18969
18970 (defvoo nndir-status-string "" nil nnmh-status-string)
18971 (defconst nndir-version "nndir 1.0")
18972
18973 ;;; Interface functions.
18974
18975 (nnoo-define-basics nndir)
18976
18977 (deffoo nndir-open-server (server &optional defs)
18978   (setq nndir-directory
18979         (or (cadr (assq 'nndir-directory defs))
18980             server))
18981   (unless (assq 'nndir-directory defs)
18982     (push `(nndir-directory ,server) defs))
18983   (push `(nndir-current-group
18984           ,(file-name-nondirectory (directory-file-name nndir-directory)))
18985         defs)
18986   (push `(nndir-top-directory
18987           ,(file-name-directory (directory-file-name nndir-directory)))
18988         defs)
18989   (nnoo-change-server 'nndir server defs))
18990
18991 (nnoo-map-functions nndir
18992   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18993   (nnmh-request-article 0 nndir-current-group 0 0)
18994   (nnmh-request-group nndir-current-group 0 0)
18995   (nnmh-close-group nndir-current-group 0))
18996
18997 (nnoo-import nndir
18998   (nnmh
18999    nnmh-status-message
19000    nnmh-request-list
19001    nnmh-request-newgroups))
19002
19003 (provide 'nndir)
19004 @end lisp
19005
19006
19007 @node Hooking New Backends Into Gnus
19008 @subsubsection Hooking New Backends Into Gnus
19009
19010 @vindex gnus-valid-select-methods
19011 Having Gnus start using your new backend is rather easy---you just
19012 declare it with the @code{gnus-declare-backend} functions.  This will
19013 enter the backend into the @code{gnus-valid-select-methods} variable.
19014
19015 @code{gnus-declare-backend} takes two parameters---the backend name and
19016 an arbitrary number of @dfn{abilities}.
19017
19018 Here's an example:
19019
19020 @lisp
19021 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
19022 @end lisp
19023
19024 The abilities can be:
19025
19026 @table @code
19027 @item mail
19028 This is a mailish backend---followups should (probably) go via mail.
19029 @item post
19030 This is a newsish backend---followups should (probably) go via news.
19031 @item post-mail
19032 This backend supports both mail and news.
19033 @item none
19034 This is neither a post nor mail backend---it's something completely
19035 different.
19036 @item respool
19037 It supports respooling---or rather, it is able to modify its source
19038 articles and groups.
19039 @item address
19040 The name of the server should be in the virtual server name.  This is
19041 true for almost all backends.
19042 @item prompt-address
19043 The user should be prompted for an address when doing commands like
19044 @kbd{B} in the group buffer.  This is true for backends like
19045 @code{nntp}, but not @code{nnmbox}, for instance.
19046 @end table
19047
19048
19049 @node Mail-like Backends
19050 @subsubsection Mail-like Backends
19051
19052 One of the things that separate the mail backends from the rest of the
19053 backends is the heavy dependence by the mail backends on common
19054 functions in @file{nnmail.el}.  For instance, here's the definition of
19055 @code{nnml-request-scan}:
19056
19057 @lisp
19058 (deffoo nnml-request-scan (&optional group server)
19059   (setq nnml-article-file-alist nil)
19060   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
19061 @end lisp
19062
19063 It simply calls @code{nnmail-get-new-mail} with a few parameters,
19064 and @code{nnmail} takes care of all the moving and splitting of the
19065 mail.
19066
19067 This function takes four parameters.
19068
19069 @table @var
19070 @item method
19071 This should be a symbol to designate which backend is responsible for
19072 the call.
19073
19074 @item exit-function
19075 This function should be called after the splitting has been performed.
19076
19077 @item temp-directory
19078 Where the temporary files should be stored.
19079
19080 @item group
19081 This optional argument should be a group name if the splitting is to be
19082 performed for one group only.
19083 @end table
19084
19085 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
19086 save each article.  @var{backend}@code{-active-number} will be called to
19087 find the article number assigned to this article.
19088
19089 The function also uses the following variables:
19090 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
19091 this backend); and @var{backend}@code{-group-alist} and
19092 @var{backend}@code{-active-file} to generate the new active file.
19093 @var{backend}@code{-group-alist} should be a group-active alist, like
19094 this:
19095
19096 @example
19097 (("a-group" (1 . 10))
19098  ("some-group" (34 . 39)))
19099 @end example
19100
19101
19102 @node Score File Syntax
19103 @subsection Score File Syntax
19104
19105 Score files are meant to be easily parseable, but yet extremely
19106 mallable.   It was decided that something that had the same read syntax
19107 as an Emacs Lisp list would fit that spec.
19108
19109 Here's a typical score file:
19110
19111 @lisp
19112 (("summary"
19113   ("win95" -10000 nil s)
19114   ("Gnus"))
19115  ("from"
19116   ("Lars" -1000))
19117  (mark -100))
19118 @end lisp
19119
19120 BNF definition of a score file:
19121
19122 @example
19123 score-file       = "" / "(" *element ")"
19124 element          = rule / atom
19125 rule             = string-rule / number-rule / date-rule
19126 string-rule      = "(" quote string-header quote space *string-match ")"
19127 number-rule      = "(" quote number-header quote space *number-match ")"
19128 date-rule        = "(" quote date-header quote space *date-match ")"
19129 quote            = <ascii 34>
19130 string-header    = "subject" / "from" / "references" / "message-id" /
19131                    "xref" / "body" / "head" / "all" / "followup"
19132 number-header    = "lines" / "chars"
19133 date-header      = "date"
19134 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
19135                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
19136 score            = "nil" / <integer>
19137 date             = "nil" / <natural number>
19138 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
19139                    "r" / "regex" / "R" / "Regex" /
19140                    "e" / "exact" / "E" / "Exact" /
19141                    "f" / "fuzzy" / "F" / "Fuzzy"
19142 number-match     = "(" <integer> [ "" / [ space score [ "" /
19143                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
19144 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
19145 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
19146                    space date [ "" / [ space date-match-t ] ] ] ] ")"
19147 date-match-t     = "nil" / "at" / "before" / "after"
19148 atom             = "(" [ required-atom / optional-atom ] ")"
19149 required-atom    = mark / expunge / mark-and-expunge / files /
19150                    exclude-files / read-only / touched
19151 optional-atom    = adapt / local / eval
19152 mark             = "mark" space nil-or-number
19153 nil-or-number    = "nil" / <integer>
19154 expunge          = "expunge" space nil-or-number
19155 mark-and-expunge = "mark-and-expunge" space nil-or-number
19156 files            = "files" *[ space <string> ]
19157 exclude-files    = "exclude-files" *[ space <string> ]
19158 read-only        = "read-only" [ space "nil" / space "t" ]
19159 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
19160 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
19161 local            = "local" *[ space "(" <string> space <form> ")" ]
19162 eval             = "eval" space <form>
19163 space            = *[ " " / <TAB> / <NEWLINE> ]
19164 @end example
19165
19166 Any unrecognized elements in a score file should be ignored, but not
19167 discarded.
19168
19169 As you can see, white space is needed, but the type and amount of white
19170 space is irrelevant.  This means that formatting of the score file is
19171 left up to the programmer---if it's simpler to just spew it all out on
19172 one looong line, then that's ok.
19173
19174 The meaning of the various atoms are explained elsewhere in this
19175 manual (@pxref{Score File Format}).
19176
19177
19178 @node Headers
19179 @subsection Headers
19180
19181 Internally Gnus uses a format for storing article headers that
19182 corresponds to the @sc{nov} format in a mysterious fashion.  One could
19183 almost suspect that the author looked at the @sc{nov} specification and
19184 just shamelessly @emph{stole} the entire thing, and one would be right.
19185
19186 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
19187 RFC1036 to talk about lines in the head of an article (e.g.,
19188 @code{From}).  It is used by many people as a synonym for
19189 ``head''---``the header and the body''.  (That should be avoided, in my
19190 opinion.)  And Gnus uses a format internally that it calls ``header'',
19191 which is what I'm talking about here.  This is a 9-element vector,
19192 basically, with each header (ouch) having one slot.
19193
19194 These slots are, in order: @code{number}, @code{subject}, @code{from},
19195 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
19196 @code{xref}.  There are macros for accessing and setting these
19197 slots---they all have predictable names beginning with
19198 @code{mail-header-} and @code{mail-header-set-}, respectively.
19199
19200 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
19201 be put in there.
19202
19203
19204 @node Ranges
19205 @subsection Ranges
19206
19207 @sc{gnus} introduced a concept that I found so useful that I've started
19208 using it a lot and have elaborated on it greatly.
19209
19210 The question is simple: If you have a large amount of objects that are
19211 identified by numbers (say, articles, to take a @emph{wild} example)
19212 that you want to qualify as being ``included'', a normal sequence isn't
19213 very useful.  (A 200,000 length sequence is a bit long-winded.)
19214
19215 The solution is as simple as the question: You just collapse the
19216 sequence.
19217
19218 @example
19219 (1 2 3 4 5 6 10 11 12)
19220 @end example
19221
19222 is transformed into
19223
19224 @example
19225 ((1 . 6) (10 . 12))
19226 @end example
19227
19228 To avoid having those nasty @samp{(13 . 13)} elements to denote a
19229 lonesome object, a @samp{13} is a valid element:
19230
19231 @example
19232 ((1 . 6) 7 (10 . 12))
19233 @end example
19234
19235 This means that comparing two ranges to find out whether they are equal
19236 is slightly tricky:
19237
19238 @example
19239 ((1 . 5) 7 8 (10 . 12))
19240 @end example
19241
19242 and
19243
19244 @example
19245 ((1 . 5) (7 . 8) (10 . 12))
19246 @end example
19247
19248 are equal.  In fact, any non-descending list is a range:
19249
19250 @example
19251 (1 2 3 4 5)
19252 @end example
19253
19254 is a perfectly valid range, although a pretty long-winded one.  This is
19255 also valid:
19256
19257 @example
19258 (1 . 5)
19259 @end example
19260
19261 and is equal to the previous range.
19262
19263 Here's a BNF definition of ranges.  Of course, one must remember the
19264 semantic requirement that the numbers are non-descending.  (Any number
19265 of repetition of the same number is allowed, but apt to disappear in
19266 range handling.)
19267
19268 @example
19269 range           = simple-range / normal-range
19270 simple-range    = "(" number " . " number ")"
19271 normal-range    = "(" start-contents ")"
19272 contents        = "" / simple-range *[ " " contents ] /
19273                   number *[ " " contents ]
19274 @end example
19275
19276 Gnus currently uses ranges to keep track of read articles and article
19277 marks.  I plan on implementing a number of range operators in C if The
19278 Powers That Be are willing to let me.  (I haven't asked yet, because I
19279 need to do some more thinking on what operators I need to make life
19280 totally range-based without ever having to convert back to normal
19281 sequences.)
19282
19283
19284 @node Group Info
19285 @subsection Group Info
19286
19287 Gnus stores all permanent info on groups in a @dfn{group info} list.
19288 This list is from three to six elements (or more) long and exhaustively
19289 describes the group.
19290
19291 Here are two example group infos; one is a very simple group while the
19292 second is a more complex one:
19293
19294 @example
19295 ("no.group" 5 (1 . 54324))
19296
19297 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
19298                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
19299                 (nnml "")
19300                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
19301 @end example
19302
19303 The first element is the @dfn{group name}---as Gnus knows the group,
19304 anyway.  The second element is the @dfn{subscription level}, which
19305 normally is a small integer.  (It can also be the @dfn{rank}, which is a
19306 cons cell where the @code{car} is the level and the @code{cdr} is the
19307 score.)  The third element is a list of ranges of read articles.  The
19308 fourth element is a list of lists of article marks of various kinds.
19309 The fifth element is the select method (or virtual server, if you like).
19310 The sixth element is a list of @dfn{group parameters}, which is what
19311 this section is about.
19312
19313 Any of the last three elements may be missing if they are not required.
19314 In fact, the vast majority of groups will normally only have the first
19315 three elements, which saves quite a lot of cons cells.
19316
19317 Here's a BNF definition of the group info format:
19318
19319 @example
19320 info          = "(" group space ralevel space read
19321                 [ "" / [ space marks-list [ "" / [ space method [ "" /
19322                 space parameters ] ] ] ] ] ")"
19323 group         = quote <string> quote
19324 ralevel       = rank / level
19325 level         = <integer in the range of 1 to inf>
19326 rank          = "(" level "." score ")"
19327 score         = <integer in the range of 1 to inf>
19328 read          = range
19329 marks-lists   = nil / "(" *marks ")"
19330 marks         = "(" <string> range ")"
19331 method        = "(" <string> *elisp-forms ")"
19332 parameters    = "(" *elisp-forms ")"
19333 @end example
19334
19335 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
19336 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
19337 in pseudo-BNF.
19338
19339 If you have a Gnus info and want to access the elements, Gnus offers a
19340 series of macros for getting/setting these elements.
19341
19342 @table @code
19343 @item gnus-info-group
19344 @itemx gnus-info-set-group
19345 @findex gnus-info-group
19346 @findex gnus-info-set-group
19347 Get/set the group name.
19348
19349 @item gnus-info-rank
19350 @itemx gnus-info-set-rank
19351 @findex gnus-info-rank
19352 @findex gnus-info-set-rank
19353 Get/set the group rank (@pxref{Group Score}).
19354
19355 @item gnus-info-level
19356 @itemx gnus-info-set-level
19357 @findex gnus-info-level
19358 @findex gnus-info-set-level
19359 Get/set the group level.
19360
19361 @item gnus-info-score
19362 @itemx gnus-info-set-score
19363 @findex gnus-info-score
19364 @findex gnus-info-set-score
19365 Get/set the group score (@pxref{Group Score}).
19366
19367 @item gnus-info-read
19368 @itemx gnus-info-set-read
19369 @findex gnus-info-read
19370 @findex gnus-info-set-read
19371 Get/set the ranges of read articles.
19372
19373 @item gnus-info-marks
19374 @itemx gnus-info-set-marks
19375 @findex gnus-info-marks
19376 @findex gnus-info-set-marks
19377 Get/set the lists of ranges of marked articles.
19378
19379 @item gnus-info-method
19380 @itemx gnus-info-set-method
19381 @findex gnus-info-method
19382 @findex gnus-info-set-method
19383 Get/set the group select method.
19384
19385 @item gnus-info-params
19386 @itemx gnus-info-set-params
19387 @findex gnus-info-params
19388 @findex gnus-info-set-params
19389 Get/set the group parameters.
19390 @end table
19391
19392 All the getter functions take one parameter---the info list.  The setter
19393 functions take two parameters---the info list and the new value.
19394
19395 The last three elements in the group info aren't mandatory, so it may be
19396 necessary to extend the group info before setting the element.  If this
19397 is necessary, you can just pass on a non-@code{nil} third parameter to
19398 the three final setter functions to have this happen automatically.
19399
19400
19401 @node Extended Interactive
19402 @subsection Extended Interactive
19403 @cindex interactive
19404 @findex gnus-interactive
19405
19406 Gnus extends the standard Emacs @code{interactive} specification
19407 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
19408 Prefixes}).  Here's an example of how this is used:
19409
19410 @lisp
19411 (defun gnus-summary-increase-score (&optional score symp)
19412   (interactive (gnus-interactive "P\ny"))
19413   ...
19414   )
19415 @end lisp
19416
19417 The best thing to do would have been to implement
19418 @code{gnus-interactive} as a macro which would have returned an
19419 @code{interactive} form, but this isn't possible since Emacs checks
19420 whether a function is interactive or not by simply doing an @code{assq}
19421 on the lambda form.  So, instead we have @code{gnus-interactive}
19422 function that takes a string and returns values that are usable to
19423 @code{interactive}.
19424
19425 This function accepts (almost) all normal @code{interactive} specs, but
19426 adds a few more.
19427
19428 @table @samp
19429 @item y
19430 @vindex gnus-current-prefix-symbol
19431 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
19432 variable.
19433
19434 @item Y
19435 @vindex gnus-current-prefix-symbols
19436 A list of the current symbolic prefixes---the
19437 @code{gnus-current-prefix-symbol} variable.
19438
19439 @item A
19440 The current article number---the @code{gnus-summary-article-number}
19441 function.
19442
19443 @item H
19444 The current article header---the @code{gnus-summary-article-header}
19445 function.
19446
19447 @item g
19448 The current group name---the @code{gnus-group-group-name}
19449 function.
19450
19451 @end table
19452
19453
19454 @node Emacs/XEmacs Code
19455 @subsection Emacs/XEmacs Code
19456 @cindex XEmacs
19457 @cindex Emacsen
19458
19459 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
19460 platforms must be the primary one.  I chose Emacs.  Not because I don't
19461 like XEmacs or Mule, but because it comes first alphabetically.
19462
19463 This means that Gnus will byte-compile under Emacs with nary a warning,
19464 while XEmacs will pump out gigabytes of warnings while byte-compiling.
19465 As I use byte-compilation warnings to help me root out trivial errors in
19466 Gnus, that's very useful.
19467
19468 I've also consistently used Emacs function interfaces, but have used
19469 Gnusey aliases for the functions.  To take an example:  Emacs defines a
19470 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
19471 function.  I then define a function called @code{gnus-run-at-time} that
19472 takes the same parameters as the Emacs @code{run-at-time}.  When running
19473 Gnus under Emacs, the former function is just an alias for the latter.
19474 However, when running under XEmacs, the former is an alias for the
19475 following function:
19476
19477 @lisp
19478 (defun gnus-xmas-run-at-time (time repeat function &rest args)
19479   (start-itimer
19480    "gnus-run-at-time"
19481    `(lambda ()
19482       (,function ,@@args))
19483    time repeat))
19484 @end lisp
19485
19486 This sort of thing has been done for bunches of functions.  Gnus does
19487 not redefine any native Emacs functions while running under XEmacs---it
19488 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
19489 all over.
19490
19491 In the cases where the XEmacs function interface was obviously cleaner,
19492 I used it instead.  For example @code{gnus-region-active-p} is an alias
19493 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
19494
19495 Of course, I could have chosen XEmacs as my native platform and done
19496 mapping functions the other way around.  But I didn't.  The performance
19497 hit these indirections impose on Gnus under XEmacs should be slight.
19498
19499
19500 @node Various File Formats
19501 @subsection Various File Formats
19502
19503 @menu
19504 * Active File Format::      Information on articles and groups available.
19505 * Newsgroups File Format::  Group descriptions.
19506 @end menu
19507
19508
19509 @node Active File Format
19510 @subsubsection Active File Format
19511
19512 The active file lists all groups available on the server in
19513 question.  It also lists the highest and lowest current article numbers
19514 in each group.
19515
19516 Here's an excerpt from a typical active file:
19517
19518 @example
19519 soc.motss 296030 293865 y
19520 alt.binaries.pictures.fractals 3922 3913 n
19521 comp.sources.unix 1605 1593 m
19522 comp.binaries.ibm.pc 5097 5089 y
19523 no.general 1000 900 y
19524 @end example
19525
19526 Here's a pseudo-BNF definition of this file:
19527
19528 @example
19529 active      = *group-line
19530 group-line  = group space high-number space low-number space flag <NEWLINE>
19531 group       = <non-white-space string>
19532 space       = " "
19533 high-number = <non-negative integer>
19534 low-number  = <positive integer>
19535 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
19536 @end example
19537
19538 For a full description of this file, see the manual pages for
19539 @samp{innd}, in particular @samp{active(5)}.
19540
19541
19542 @node Newsgroups File Format
19543 @subsubsection Newsgroups File Format
19544
19545 The newsgroups file lists groups along with their descriptions.  Not all
19546 groups on the server have to be listed,  and not all groups in the file
19547 have to exist on the server.  The file is meant purely as information to
19548 the user.
19549
19550 The format is quite simple; a group name, a tab, and the description.
19551 Here's the definition:
19552
19553 @example
19554 newsgroups    = *line
19555 line          = group tab description <NEWLINE>
19556 group         = <non-white-space string>
19557 tab           = <TAB>
19558 description   = <string>
19559 @end example
19560
19561
19562 @page
19563 @node Emacs for Heathens
19564 @section Emacs for Heathens
19565
19566 Believe it or not, but some people who use Gnus haven't really used
19567 Emacs much before they embarked on their journey on the Gnus Love Boat.
19568 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
19569 region'', and ``set @code{gnus-flargblossen} to an alist where the key
19570 is a regexp that is used for matching on the group name'' are magical
19571 phrases with little or no meaning, then this appendix is for you.  If
19572 you are already familiar with Emacs, just ignore this and go fondle your
19573 cat instead.
19574
19575 @menu
19576 * Keystrokes::      Entering text and executing commands.
19577 * Emacs Lisp::      The built-in Emacs programming language.
19578 @end menu
19579
19580
19581 @node Keystrokes
19582 @subsection Keystrokes
19583
19584 @itemize @bullet
19585 @item
19586 Q: What is an experienced Emacs user?
19587
19588 @item
19589 A: A person who wishes that the terminal had pedals.
19590 @end itemize
19591
19592 Yes, when you use Emacs, you are apt to use the control key, the shift
19593 key and the meta key a lot.  This is very annoying to some people
19594 (notably @code{vi}le users), and the rest of us just love the hell out
19595 of it.  Just give up and submit.  Emacs really does stand for
19596 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
19597 may have heard from other disreputable sources (like the Emacs author).
19598
19599 The shift keys are normally located near your pinky fingers, and are
19600 normally used to get capital letters and stuff.  You probably use it all
19601 the time.  The control key is normally marked ``CTRL'' or something like
19602 that.  The meta key is, funnily enough, never marked as such on any
19603 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
19604 which is the meta key on this keyboard.  It's usually located somewhere
19605 to the left hand side of the keyboard, usually on the bottom row.
19606
19607 Now, us Emacs people don't say ``press the meta-control-m key'',
19608 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
19609 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
19610 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
19611 down the control key, and hold it down while you press @kbd{k}''.
19612 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
19613 the control key and then press @kbd{k}''.  Simple, ay?
19614
19615 This is somewhat complicated by the fact that not all keyboards have a
19616 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
19617 means ``press escape, release escape, press @kbd{k}''.  That's much more
19618 work than if you have a meta key, so if that's the case, I respectfully
19619 suggest you get a real keyboard with a meta key.  You can't live without
19620 it.
19621
19622
19623
19624 @node Emacs Lisp
19625 @subsection Emacs Lisp
19626
19627 Emacs is the King of Editors because it's really a Lisp interpreter.
19628 Each and every key you tap runs some Emacs Lisp code snippet, and since
19629 Emacs Lisp is an interpreted language, that means that you can configure
19630 any key to run any arbitrary code.  You just, like, do it.
19631
19632 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
19633 functions.  (These are byte-compiled for speed, but it's still
19634 interpreted.)  If you decide that you don't like the way Gnus does
19635 certain things, it's trivial to have it do something a different way.
19636 (Well, at least if you know how to write Lisp code.)  However, that's
19637 beyond the scope of this manual, so we are simply going to talk about
19638 some common constructs that you normally use in your @file{.emacs} file
19639 to customize Gnus.
19640
19641 If you want to set the variable @code{gnus-florgbnize} to four (4), you
19642 write the following:
19643
19644 @lisp
19645 (setq gnus-florgbnize 4)
19646 @end lisp
19647
19648 This function (really ``special form'') @code{setq} is the one that can
19649 set a variable to some value.  This is really all you need to know.  Now
19650 you can go and fill your @code{.emacs} file with lots of these to change
19651 how Gnus works.
19652
19653 If you have put that thing in your @code{.emacs} file, it will be read
19654 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
19655 start Emacs.  If you want to change the variable right away, simply say
19656 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
19657 previous ``form'', which is a simple @code{setq} statement here.
19658
19659 Go ahead---just try it, if you're located at your Emacs.  After you
19660 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
19661 is the return value of the form you @code{eval}ed.
19662
19663 Some pitfalls:
19664
19665 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
19666 that means:
19667
19668 @lisp
19669 (setq gnus-read-active-file 'some)
19670 @end lisp
19671
19672 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
19673 @samp{nntp.ifi.uio.no}'', that means:
19674
19675 @lisp
19676 (setq gnus-nntp-server "nntp.ifi.uio.no")
19677 @end lisp
19678
19679 So be careful not to mix up strings (the latter) with symbols (the
19680 former).  The manual is unambiguous, but it can be confusing.
19681
19682 @page
19683 @include gnus-faq.texi
19684
19685 @node Index
19686 @chapter Index
19687 @printindex cp
19688
19689 @node Key Index
19690 @chapter Key Index
19691 @printindex ky
19692
19693 @summarycontents
19694 @contents
19695 @bye
19696
19697 @iftex
19698 @iflatex
19699 \end{document}
19700 @end iflatex
19701 @end iftex
19702
19703 @c End:
19704