Add www.netaddress.com for webmail.
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-  -*- coding: iso-latin-1 -*-
2
3 @setfilename gnus
4 @settitle Pterodactyl Gnus  Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @c @direntry
9 @c * Gnus: (gnus).         The newsreader 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 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
54
55 \newcommand{\gnusbullet}{{${\bullet}$}}
56 \newcommand{\gnusdollar}{\$}
57 \newcommand{\gnusampersand}{\&}
58 \newcommand{\gnuspercent}{\%}
59 \newcommand{\gnushash}{\#}
60 \newcommand{\gnushat}{\symbol{"5E}}
61 \newcommand{\gnusunderline}{\symbol{"5F}}
62 \newcommand{\gnusnot}{$\neg$}
63 \newcommand{\gnustilde}{\symbol{"7E}}
64 \newcommand{\gnusless}{{$<$}}
65 \newcommand{\gnusgreater}{{$>$}}
66 \newcommand{\gnusbraceleft}{{$>$}}
67 \newcommand{\gnusbraceright}{{$>$}}
68
69 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
70 \newcommand{\gnusinteresting}{
71 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
72 }
73
74 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
75
76 \newcommand{\gnuspagechapter}[1]{
77 {\mbox{}}
78 }
79
80 \newdimen{\gnusdimen}
81 \gnusdimen 0pt
82
83 \newcommand{\gnuschapter}[2]{
84 \gnuscleardoublepage
85 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
86 \chapter{#2}
87 \renewcommand{\gnussectionname}{}
88 \renewcommand{\gnuschaptername}{#2}
89 \thispagestyle{empty}
90 \hspace*{-2cm}
91 \begin{picture}(500,500)(0,0)
92 \put(480,350){\makebox(0,0)[tr]{#1}}
93 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
94 \end{picture}
95 \clearpage
96 }
97
98 \newcommand{\gnusfigure}[3]{
99 \begin{figure}
100 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
101 #3
102 \end{picture}
103 \caption{#1}
104 \end{figure}
105 }
106
107 \newcommand{\gnusicon}[1]{
108 \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}}}
109 }
110
111 \newcommand{\gnuspicon}[1]{
112 \margindex{\epsfig{figure=#1,width=2cm}}
113 }
114
115 \newcommand{\gnusxface}[2]{
116 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
117 }
118
119 \newcommand{\gnussmiley}[2]{
120 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
121 }
122
123 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
124
125 \newcommand{\gnussection}[1]{
126 \renewcommand{\gnussectionname}{#1}
127 \section{#1}
128 }
129
130 \newenvironment{codelist}%
131 {\begin{list}{}{
132 }
133 }{\end{list}}
134
135 \newenvironment{kbdlist}%
136 {\begin{list}{}{
137 \labelwidth=0cm
138 }
139 }{\end{list}}
140
141 \newenvironment{dfnlist}%
142 {\begin{list}{}{
143 }
144 }{\end{list}}
145
146 \newenvironment{stronglist}%
147 {\begin{list}{}{
148 }
149 }{\end{list}}
150
151 \newenvironment{samplist}%
152 {\begin{list}{}{
153 }
154 }{\end{list}}
155
156 \newenvironment{varlist}%
157 {\begin{list}{}{
158 }
159 }{\end{list}}
160
161 \newenvironment{emphlist}%
162 {\begin{list}{}{
163 }
164 }{\end{list}}
165
166 \newlength\gnusheadtextwidth
167 \setlength{\gnusheadtextwidth}{\headtextwidth}
168 \addtolength{\gnusheadtextwidth}{1cm}
169
170 \newpagestyle{gnuspreamble}%
171 {
172 {
173 \ifodd\count0
174 {
175 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
176 }
177 \else
178 {
179 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
180 }
181 }
182 \fi
183 }
184 }
185 {
186 \ifodd\count0
187 \mbox{} \hfill
188 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
189 \else
190 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
191 \hfill \mbox{}
192 \fi
193 }
194
195 \newpagestyle{gnusindex}%
196 {
197 {
198 \ifodd\count0
199 {
200 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
201 }
202 \else
203 {
204 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
205 }
206 \fi
207 }
208 }
209 {
210 \ifodd\count0
211 \mbox{} \hfill
212 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
213 \else
214 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
215 \hfill \mbox{}
216 \fi
217 }
218
219 \newpagestyle{gnus}%
220 {
221 {
222 \ifodd\count0
223 {
224 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
225 }
226 \else
227 {
228 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
229 }
230 \fi
231 }
232 }
233 {
234 \ifodd\count0
235 \mbox{} \hfill
236 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
237 \else
238 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
239 \hfill \mbox{}
240 \fi
241 }
242
243 \pagenumbering{roman}
244 \pagestyle{gnuspreamble}
245
246 @end iflatex
247 @end iftex
248
249 @iftex
250 @iflatex
251 \begin{titlepage}
252 {
253
254 %\addtolength{\oddsidemargin}{-5cm}
255 %\addtolength{\evensidemargin}{-5cm}
256 \parindent=0cm
257 \addtolength{\textheight}{2cm}
258
259 \gnustitle{\gnustitlename}\\
260 \rule{15cm}{1mm}\\
261 \vfill
262 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
263 \vfill
264 \rule{15cm}{1mm}\\
265 \gnusauthor{by Lars Magne Ingebrigtsen}
266 \newpage
267 }
268
269 \mbox{}
270 \vfill
271
272 \thispagestyle{empty}
273
274 Copyright \copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
275
276 Permission is granted to make and distribute verbatim copies of
277 this manual provided the copyright notice and this permission notice
278 are preserved on all copies.
279
280 Permission is granted to copy and distribute modified versions of this
281 manual under the conditions for verbatim copying, provided that the
282 entire resulting derived work is distributed under the terms of a
283 permission notice identical to this one.
284
285 Permission is granted to copy and distribute translations of this manual
286 into another language, under the above conditions for modified versions.
287
288 \newpage
289 \end{titlepage}
290 @end iflatex
291 @end iftex
292
293 @ifinfo
294
295 This file documents Gnus, the GNU Emacs newsreader.
296
297 Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
298
299 Permission is granted to make and distribute verbatim copies of
300 this manual provided the copyright notice and this permission notice
301 are preserved on all copies.
302
303 @ignore
304 Permission is granted to process this file through Tex and print the
305 results, provided the printed document carries copying permission
306 notice identical to this one except for the removal of this paragraph
307 (this paragraph not being relevant to the printed manual).
308
309 @end ignore
310 Permission is granted to copy and distribute modified versions of this
311 manual under the conditions for verbatim copying, provided also that the
312 entire resulting derived work is distributed under the terms of a
313 permission notice identical to this one.
314
315 Permission is granted to copy and distribute translations of this manual
316 into another language, under the above conditions for modified versions.
317 @end ifinfo
318
319 @tex
320
321 @titlepage
322 @title Pterodactyl Gnus  Manual
323
324 @author by Lars Magne Ingebrigtsen
325 @page
326
327 @vskip 0pt plus 1filll
328 Copyright @copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
329
330 Permission is granted to make and distribute verbatim copies of
331 this manual provided the copyright notice and this permission notice
332 are preserved on all copies.
333
334 Permission is granted to copy and distribute modified versions of this
335 manual under the conditions for verbatim copying, provided that the
336 entire resulting derived work is distributed under the terms of a
337 permission notice identical to this one.
338
339 Permission is granted to copy and distribute translations of this manual
340 into another language, under the above conditions for modified versions.
341
342 @end titlepage
343 @page
344
345 @end tex
346
347
348 @node Top
349 @top The Gnus Newsreader
350
351 @ifinfo
352
353 You can read news (and mail) from within Emacs by using Gnus.  The news
354 can be gotten by any nefarious means you can think of---@sc{nntp}, local
355 spool or your mbox file.  All at the same time, if you want to push your
356 luck.
357
358 This manual corresponds to Pterodactyl Gnus .
359
360 @end ifinfo
361
362 @iftex
363
364 @iflatex
365 \tableofcontents
366 \gnuscleardoublepage
367 @end iflatex
368
369 Gnus is the advanced, self-documenting, customizable, extensible
370 unreal-time newsreader for GNU Emacs.
371
372 Oops.  That sounds oddly familiar, so let's start over again to avoid
373 being accused of plagiarism:
374
375 Gnus is a message-reading laboratory.  It will let you look at just
376 about anything as if it were a newsgroup.  You can read mail with it,
377 you can browse directories with it, you can @code{ftp} with it---you can
378 even read news with it!
379
380 Gnus tries to empower people who read news the same way Emacs empowers
381 people who edit text.  Gnus sets no limits to what the user should be
382 allowed to do.  Users are encouraged to extend Gnus to make it behave
383 like they want it to behave.  A program should not control people;
384 people should be empowered to do what they want by using (or abusing)
385 the program.
386
387 @end iftex
388
389
390 @menu
391 * Starting Up::           Finding news can be a pain.
392 * The Group Buffer::      Selecting, subscribing and killing groups.
393 * The Summary Buffer::    Reading, saving and posting articles.
394 * The Article Buffer::    Displaying and handling articles.
395 * Composing Messages::    Information on sending mail and news.
396 * Select Methods::        Gnus reads all messages from various select methods.
397 * Scoring::               Assigning values to articles.
398 * Various::               General purpose settings.
399 * The End::               Farewell and goodbye.
400 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
401 * Index::                 Variable, function and concept index.
402 * Key Index::             Key Index.
403 @end menu
404
405 @node Starting Up
406 @chapter Starting Gnus
407 @cindex starting up
408
409 @kindex M-x gnus
410 @findex gnus
411 If your system administrator has set things up properly, starting Gnus
412 and reading news is extremely easy---you just type @kbd{M-x gnus} in
413 your Emacs.
414
415 @findex gnus-other-frame
416 @kindex M-x gnus-other-frame
417 If you want to start Gnus in a different frame, you can use the command
418 @kbd{M-x gnus-other-frame} instead.
419
420 If things do not go smoothly at startup, you have to twiddle some
421 variables in your @file{~/.gnus} file.  This file is similar to
422 @file{~/.emacs}, but is read when gnus starts.
423
424 If you puzzle at any terms used in this manual, please refer to the
425 terminology section (@pxref{Terminology}).
426
427 @menu
428 * Finding the News::    Choosing a method for getting news.
429 * The First Time::      What does Gnus do the first time you start it?
430 * The Server is Down::  How can I read my mail then?
431 * Slave Gnusae::        You can have more than one Gnus active at a time.
432 * Fetching a Group::    Starting Gnus just to read a group.
433 * New Groups::          What is Gnus supposed to do with new groups?
434 * Startup Files::       Those pesky startup files---@file{.newsrc}.
435 * Auto Save::           Recovering from a crash.
436 * The Active File::     Reading the active file over a slow line Takes Time.
437 * Changing Servers::    You may want to move from one server to another.
438 * Startup Variables::   Other variables you might change.
439 @end menu
440
441
442 @node Finding the News
443 @section Finding the News
444 @cindex finding news
445
446 @vindex gnus-select-method
447 @c @head
448 The @code{gnus-select-method} variable says where Gnus should look for
449 news.  This variable should be a list where the first element says
450 @dfn{how} and the second element says @dfn{where}.  This method is your
451 native method.  All groups not fetched with this method are
452 foreign groups.
453
454 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
455 you want to get your daily dosage of news from, you'd say:
456
457 @lisp
458 (setq gnus-select-method '(nntp "news.somewhere.edu"))
459 @end lisp
460
461 If you want to read directly from the local spool, say:
462
463 @lisp
464 (setq gnus-select-method '(nnspool ""))
465 @end lisp
466
467 If you can use a local spool, you probably should, as it will almost
468 certainly be much faster.
469
470 @vindex gnus-nntpserver-file
471 @cindex NNTPSERVER
472 @cindex @sc{nntp} server
473 If this variable is not set, Gnus will take a look at the
474 @code{NNTPSERVER} environment variable.  If that variable isn't set,
475 Gnus will see whether @code{gnus-nntpserver-file}
476 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
477 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
478
479 @vindex gnus-nntp-server
480 If @code{gnus-nntp-server} is set, this variable will override
481 @code{gnus-select-method}.  You should therefore set
482 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
483
484 @vindex gnus-secondary-servers
485 @vindex gnus-nntp-server
486 You can also make Gnus prompt you interactively for the name of an
487 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
488 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
489 in the @code{gnus-secondary-servers} list (if any).  You can also just
490 type in the name of any server you feel like visiting.  (Note that this
491 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
492 gnus} later in the same Emacs session, Gnus will contact the same
493 server.)
494
495 @findex gnus-group-browse-foreign-server
496 @kindex B (Group)
497 However, if you use one @sc{nntp} server regularly and are just
498 interested in a couple of groups from a different server, you would be
499 better served by using the @kbd{B} command in the group buffer.  It will
500 let you have a look at what groups are available, and you can subscribe
501 to any of the groups you want to.  This also makes @file{.newsrc}
502 maintenance much tidier.  @xref{Foreign Groups}.
503
504 @vindex gnus-secondary-select-methods
505 @c @head
506 A slightly different approach to foreign groups is to set the
507 @code{gnus-secondary-select-methods} variable.  The select methods
508 listed in this variable are in many ways just as native as the
509 @code{gnus-select-method} server.  They will also be queried for active
510 files during startup (if that's required), and new newsgroups that
511 appear on these servers will be subscribed (or not) just as native
512 groups are.
513
514 For instance, if you use the @code{nnmbox} backend to read your mail, you
515 would typically set this variable to
516
517 @lisp
518 (setq gnus-secondary-select-methods '((nnmbox "")))
519 @end lisp
520
521
522 @node The First Time
523 @section The First Time
524 @cindex first time usage
525
526 If no startup files exist, Gnus will try to determine what groups should
527 be subscribed by default.
528
529 @vindex gnus-default-subscribed-newsgroups
530 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
531 will subscribe you to just those groups in that list, leaving the rest
532 killed.  Your system administrator should have set this variable to
533 something useful.
534
535 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
536 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
537 here as @dfn{whatever Lars thinks you should read}.)
538
539 You'll also be subscribed to the Gnus documentation group, which should
540 help you with most common problems.
541
542 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
543 use the normal functions for handling new groups, and not do anything
544 special.
545
546
547 @node The Server is Down
548 @section The Server is Down
549 @cindex server errors
550
551 If the default server is down, Gnus will understandably have some
552 problems starting.  However, if you have some mail groups in addition to
553 the news groups, you may want to start Gnus anyway.
554
555 Gnus, being the trusting sort of program, will ask whether to proceed
556 without a native select method if that server can't be contacted.  This
557 will happen whether the server doesn't actually exist (i.e., you have
558 given the wrong address) or the server has just momentarily taken ill
559 for some reason or other.  If you decide to continue and have no foreign
560 groups, you'll find it difficult to actually do anything in the group
561 buffer.  But, hey, that's your problem.  Blllrph!
562
563 @findex gnus-no-server
564 @kindex M-x gnus-no-server
565 @c @head
566 If you know that the server is definitely down, or you just want to read
567 your mail without bothering with the server at all, you can use the
568 @code{gnus-no-server} command to start Gnus.  That might come in handy
569 if you're in a hurry as well.  This command will not attempt to contact
570 your primary server---instead, it will just activate all groups on level
571 1 and 2.  (You should preferably keep no native groups on those two
572 levels.)
573
574
575 @node Slave Gnusae
576 @section Slave Gnusae
577 @cindex slave
578
579 You might want to run more than one Emacs with more than one Gnus at the
580 same time.  If you are using different @file{.newsrc} files (e.g., if you
581 are using the two different Gnusae to read from two different servers),
582 that is no problem whatsoever.  You just do it.
583
584 The problem appears when you want to run two Gnusae that use the same
585 @code{.newsrc} file.
586
587 To work around that problem some, we here at the Think-Tank at the Gnus
588 Towers have come up with a new concept: @dfn{Masters} and
589 @dfn{slaves}.  (We have applied for a patent on this concept, and have
590 taken out a copyright on those words.  If you wish to use those words in
591 conjunction with each other, you have to send $1 per usage instance to
592 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
593 Applications}) will be much more expensive, of course.)
594
595 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
596 however you do it).  Each subsequent slave Gnusae should be started with
597 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
598 files, but instead save @dfn{slave files} that contain information only
599 on what groups have been read in the slave session.  When a master Gnus
600 starts, it will read (and delete) these slave files, incorporating all
601 information from them.  (The slave files will be read in the sequence
602 they were created, so the latest changes will have precedence.)
603
604 Information from the slave files has, of course, precedence over the
605 information in the normal (i.e., master) @code{.newsrc} file.
606
607
608 @node Fetching a Group
609 @section Fetching a Group
610 @cindex fetching a group
611
612 @findex gnus-fetch-group
613 It is sometimes convenient to be able to just say ``I want to read this
614 group and I don't care whether Gnus has been started or not''.  This is
615 perhaps more useful for people who write code than for users, but the
616 command @code{gnus-fetch-group} provides this functionality in any case.
617 It takes the group name as a parameter.
618
619
620 @node New Groups
621 @section New Groups
622 @cindex new groups
623 @cindex subscription
624
625 @vindex gnus-check-new-newsgroups
626 If you are satisfied that you really never want to see any new groups,
627 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
628 also save you some time at startup.  Even if this variable is
629 @code{nil}, you can always subscribe to the new groups just by pressing
630 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
631 is @code{ask-server} by default.  If you set this variable to
632 @code{always}, then Gnus will query the backends for new groups even
633 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
634
635 @menu
636 * Checking New Groups::      Determining what groups are new.
637 * Subscription Methods::     What Gnus should do with new groups.
638 * Filtering New Groups::     Making Gnus ignore certain new groups.
639 @end menu
640
641
642 @node Checking New Groups
643 @subsection Checking New Groups
644
645 Gnus normally determines whether a group is new or not by comparing the
646 list of groups from the active file(s) with the lists of subscribed and
647 dead groups.  This isn't a particularly fast method.  If
648 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
649 server for new groups since the last time.  This is both faster and
650 cheaper.  This also means that you can get rid of the list of killed
651 groups altogether, so you may set @code{gnus-save-killed-list} to
652 @code{nil}, which will save time both at startup, at exit, and all over.
653 Saves disk space, too.  Why isn't this the default, then?
654 Unfortunately, not all servers support this command.
655
656 I bet I know what you're thinking now: How do I find out whether my
657 server supports @code{ask-server}?  No?  Good, because I don't have a
658 fail-safe answer.  I would suggest just setting this variable to
659 @code{ask-server} and see whether any new groups appear within the next
660 few days.  If any do, then it works.  If none do, then it doesn't
661 work.  I could write a function to make Gnus guess whether the server
662 supports @code{ask-server}, but it would just be a guess.  So I won't.
663 You could @code{telnet} to the server and say @code{HELP} and see
664 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
665 it does, then it might work.  (But there are servers that lists
666 @samp{NEWGROUPS} without supporting the function properly.)
667
668 This variable can also be a list of select methods.  If so, Gnus will
669 issue an @code{ask-server} command to each of the select methods, and
670 subscribe them (or not) using the normal methods.  This might be handy
671 if you are monitoring a few servers for new groups.  A side effect is
672 that startup will take much longer, so you can meditate while waiting.
673 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
674
675
676 @node Subscription Methods
677 @subsection Subscription Methods
678
679 @vindex gnus-subscribe-newsgroup-method
680 What Gnus does when it encounters a new group is determined by the
681 @code{gnus-subscribe-newsgroup-method} variable.
682
683 This variable should contain a function.  This function will be called
684 with the name of the new group as the only parameter.
685
686 Some handy pre-fab functions are:
687
688 @table @code
689
690 @item gnus-subscribe-zombies
691 @vindex gnus-subscribe-zombies
692 Make all new groups zombies.  This is the default.  You can browse the
693 zombies later (with @kbd{A z}) and either kill them all off properly
694 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
695
696 @item gnus-subscribe-randomly
697 @vindex gnus-subscribe-randomly
698 Subscribe all new groups in arbitrary order.  This really means that all
699 new groups will be added at ``the top'' of the group buffer.
700
701 @item gnus-subscribe-alphabetically
702 @vindex gnus-subscribe-alphabetically
703 Subscribe all new groups in alphabetical order.
704
705 @item gnus-subscribe-hierarchically
706 @vindex gnus-subscribe-hierarchically
707 Subscribe all new groups hierarchically.  The difference between this
708 function and @code{gnus-subscribe-alphabetically} is slight.
709 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
710 alphabetical fashion, while this function will enter groups into its
711 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
712 @samp{comp} hierarchy, this function will not mess that configuration
713 up.  Or something like that.
714
715 @item gnus-subscribe-interactively
716 @vindex gnus-subscribe-interactively
717 Subscribe new groups interactively.  This means that Gnus will ask
718 you about @strong{all} new groups.  The groups you choose to subscribe
719 to will be subscribed hierarchically.
720
721 @item gnus-subscribe-killed
722 @vindex gnus-subscribe-killed
723 Kill all new groups.
724
725 @item gnus-subscribe-topics
726 @vindex gnus-subscribe-topics
727 Put the groups into the topic that has a matching @code{subscribe} topic 
728 parameter (@pxref{Topic Parameters}).  For instance, a @code{subscribe}
729 topic parameter that looks like
730
731 @example
732 "nnslashdot"
733 @end example
734
735 will mean that all groups that match that regex will be subscribed under 
736 that topic.
737
738 @end table
739
740 @vindex gnus-subscribe-hierarchical-interactive
741 A closely related variable is
742 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
743 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
744 hierarchical fashion whether to subscribe to new groups or not.  Gnus
745 will ask you for each sub-hierarchy whether you want to descend the
746 hierarchy or not.
747
748 One common mistake is to set the variable a few paragraphs above
749 (@code{gnus-subscribe-newsgroup-method}) to
750 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
751 will not work.  This is ga-ga.  So don't do it.
752
753
754 @node Filtering New Groups
755 @subsection Filtering New Groups
756
757 A nice and portable way to control which new newsgroups should be
758 subscribed (or ignored) is to put an @dfn{options} line at the start of
759 the @file{.newsrc} file.  Here's an example:
760
761 @example
762 options -n !alt.all !rec.all sci.all
763 @end example
764
765 @vindex gnus-subscribe-options-newsgroup-method
766 This line obviously belongs to a serious-minded intellectual scientific
767 person (or she may just be plain old boring), because it says that all
768 groups that have names beginning with @samp{alt} and @samp{rec} should
769 be ignored, and all groups with names beginning with @samp{sci} should
770 be subscribed.  Gnus will not use the normal subscription method for
771 subscribing these groups.
772 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
773 variable defaults to @code{gnus-subscribe-alphabetically}.
774
775 @vindex gnus-options-not-subscribe
776 @vindex gnus-options-subscribe
777 If you don't want to mess with your @file{.newsrc} file, you can just
778 set the two variables @code{gnus-options-subscribe} and
779 @code{gnus-options-not-subscribe}.  These two variables do exactly the
780 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
781 and if the new group matches the former, it will be unconditionally
782 subscribed, and if it matches the latter, it will be ignored.
783
784 @vindex gnus-auto-subscribed-groups
785 Yet another variable that meddles here is
786 @code{gnus-auto-subscribed-groups}.  It works exactly like
787 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
788 thought it would be nice to have two of these.  This variable is more
789 meant for setting some ground rules, while the other variable is used
790 more for user fiddling.  By default this variable makes all new groups
791 that come from mail backends (@code{nnml}, @code{nnbabyl},
792 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
793 don't like that, just set this variable to @code{nil}.
794
795 New groups that match this regexp are subscribed using
796 @code{gnus-subscribe-options-newsgroup-method}.
797
798
799 @node Changing Servers
800 @section Changing Servers
801 @cindex changing servers
802
803 Sometimes it is necessary to move from one @sc{nntp} server to another.
804 This happens very rarely, but perhaps you change jobs, or one server is
805 very flaky and you want to use another.
806
807 Changing the server is pretty easy, right?  You just change
808 @code{gnus-select-method} to point to the new server?
809
810 @emph{Wrong!}
811
812 Article numbers are not (in any way) kept synchronized between different
813 @sc{nntp} servers, and the only way Gnus keeps track of what articles
814 you have read is by keeping track of article numbers.  So when you
815 change @code{gnus-select-method}, your @file{.newsrc} file becomes
816 worthless.
817
818 Gnus provides a few functions to attempt to translate a @file{.newsrc}
819 file from one server to another.  They all have one thing in
820 common---they take a looong time to run.  You don't want to use these
821 functions more than absolutely necessary.
822
823 @kindex M-x gnus-change-server
824 @findex gnus-change-server
825 If you have access to both servers, Gnus can request the headers for all
826 the articles you have read and compare @code{Message-ID}s and map the
827 article numbers of the read articles and article marks.  The @kbd{M-x
828 gnus-change-server} command will do this for all your native groups.  It
829 will prompt for the method you want to move to.
830
831 @kindex M-x gnus-group-move-group-to-server
832 @findex gnus-group-move-group-to-server
833 You can also move individual groups with the @kbd{M-x
834 gnus-group-move-group-to-server} command.  This is useful if you want to
835 move a (foreign) group from one server to another.
836
837 @kindex M-x gnus-group-clear-data-on-native-groups
838 @findex gnus-group-clear-data-on-native-groups
839 If you don't have access to both the old and new server, all your marks
840 and read ranges have become worthless.  You can use the @kbd{M-x
841 gnus-group-clear-data-on-native-groups} command to clear out all data
842 that you have on your native groups.  Use with caution.
843
844 After changing servers, you @strong{must} move the cache hierarchy away,
845 since the cached articles will have wrong article numbers, which will
846 affect which articles Gnus thinks are read.
847
848
849 @node Startup Files
850 @section Startup Files
851 @cindex startup files
852 @cindex .newsrc
853 @cindex .newsrc.el
854 @cindex .newsrc.eld
855
856 Now, you all know about the @file{.newsrc} file.  All subscription
857 information is traditionally stored in this file.
858
859 Things got a bit more complicated with @sc{gnus}.  In addition to
860 keeping the @file{.newsrc} file updated, it also used a file called
861 @file{.newsrc.el} for storing all the information that didn't fit into
862 the @file{.newsrc} file.  (Actually, it also duplicated everything in
863 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
864 files was the most recently saved, which enabled people to swap between
865 @sc{gnus} and other newsreaders.
866
867 That was kinda silly, so Gnus went one better: In addition to the
868 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
869 @file{.newsrc.eld}.  It will read whichever of these files that are most
870 recent, but it will never write a @file{.newsrc.el} file.  You should
871 never delete the @file{.newsrc.eld} file---it contains much information
872 not stored in the @file{.newsrc} file.
873
874 @vindex gnus-save-newsrc-file
875 @vindex gnus-read-newsrc-file
876 You can turn off writing the @file{.newsrc} file by setting
877 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
878 the file and save some space, as well as exiting from Gnus faster.
879 However, this will make it impossible to use other newsreaders than
880 Gnus.  But hey, who would want to, right?  Similarly, setting
881 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
882 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
883 convenient if you have a tendency to use Netscape once in a while.
884
885 @vindex gnus-save-killed-list
886 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
887 will not save the list of killed groups to the startup file.  This will
888 save both time (when starting and quitting) and space (on disk).  It
889 will also mean that Gnus has no record of what groups are new or old,
890 so the automatic new groups subscription methods become meaningless.
891 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
892 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
893 Groups}).  This variable can also be a regular expression.  If that's
894 the case, remove all groups that do not match this regexp before
895 saving.  This can be useful in certain obscure situations that involve
896 several servers where not all servers support @code{ask-server}.
897
898 @vindex gnus-startup-file
899 The @code{gnus-startup-file} variable says where the startup files are.
900 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
901 file being whatever that one is, with a @samp{.eld} appended.
902
903 @vindex gnus-save-newsrc-hook
904 @vindex gnus-save-quick-newsrc-hook
905 @vindex gnus-save-standard-newsrc-hook
906 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
907 files, while @code{gnus-save-quick-newsrc-hook} is called just before
908 saving the @file{.newsrc.eld} file, and
909 @code{gnus-save-standard-newsrc-hook} is called just before saving the
910 @file{.newsrc} file.  The latter two are commonly used to turn version
911 control on or off.  Version control is on by default when saving the
912 startup files.  If you want to turn backup creation off, say something like:
913
914 @lisp
915 (defun turn-off-backup ()
916   (set (make-local-variable 'backup-inhibited) t))
917
918 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
919 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
920 @end lisp
921
922 @vindex gnus-init-file
923 When Gnus starts, it will read the @code{gnus-site-init-file}
924 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
925 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
926 and can be used to avoid cluttering your @file{~/.emacs} and
927 @file{site-init} files with Gnus stuff.  Gnus will also check for files
928 with the same names as these, but with @file{.elc} and @file{.el}
929 suffixes.  In other words, if you have set @code{gnus-init-file} to
930 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
931 and finally @file{~/.gnus} (in this order).
932
933
934
935 @node Auto Save
936 @section Auto Save
937 @cindex dribble file
938 @cindex auto-save
939
940 Whenever you do something that changes the Gnus data (reading articles,
941 catching up, killing/subscribing groups), the change is added to a
942 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
943 Emacs way.  If your Emacs should crash before you have saved the
944 @file{.newsrc} files, all changes you have made can be recovered from
945 this file.
946
947 If Gnus detects this file at startup, it will ask the user whether to
948 read it.  The auto save file is deleted whenever the real startup file is
949 saved.
950
951 @vindex gnus-use-dribble-file
952 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
953 maintain a dribble buffer.  The default is @code{t}.
954
955 @vindex gnus-dribble-directory
956 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
957 this variable is @code{nil}, which it is by default, Gnus will dribble
958 into the directory where the @file{.newsrc} file is located.  (This is
959 normally the user's home directory.)  The dribble file will get the same
960 file permissions as the @code{.newsrc} file.
961
962 @vindex gnus-always-read-dribble-file
963 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
964 read the dribble file on startup without querying the user.
965
966
967 @node The Active File
968 @section The Active File
969 @cindex active file
970 @cindex ignored groups
971
972 When Gnus starts, or indeed whenever it tries to determine whether new
973 articles have arrived, it reads the active file.  This is a very large
974 file that lists all the active groups and articles on the server.
975
976 @vindex gnus-ignored-newsgroups
977 Before examining the active file, Gnus deletes all lines that match the
978 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
979 any groups with bogus names, but you can use this variable to make Gnus
980 ignore hierarchies you aren't ever interested in.  However, this is not
981 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
982 Groups} for an overview of other variables that can be used instead.
983
984 @c This variable is
985 @c @code{nil} by default, and will slow down active file handling somewhat
986 @c if you set it to anything else.
987
988 @vindex gnus-read-active-file
989 @c @head
990 The active file can be rather Huge, so if you have a slow network, you
991 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
992 reading the active file.  This variable is @code{some} by default.
993
994 Gnus will try to make do by getting information just on the groups that
995 you actually subscribe to.
996
997 Note that if you subscribe to lots and lots of groups, setting this
998 variable to @code{nil} will probably make Gnus slower, not faster.  At
999 present, having this variable @code{nil} will slow Gnus down
1000 considerably, unless you read news over a 2400 baud modem.
1001
1002 This variable can also have the value @code{some}.  Gnus will then
1003 attempt to read active info only on the subscribed groups.  On some
1004 servers this is quite fast (on sparkling, brand new INN servers that
1005 support the @code{LIST ACTIVE group} command), on others this isn't fast
1006 at all.  In any case, @code{some} should be faster than @code{nil}, and
1007 is certainly faster than @code{t} over slow lines.
1008
1009 Some news servers (Leafnode and old versions of INN, for instance) do
1010 not support the @code{LIST ACTIVE group}.  For these servers, @code{nil}
1011 is probably the most efficient value for this variable.
1012
1013 If this variable is @code{nil}, Gnus will ask for group info in total
1014 lock-step, which isn't very fast.  If it is @code{some} and you use an
1015 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1016 read all the replies in one swoop.  This will normally result in better
1017 performance, but if the server does not support the aforementioned
1018 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1019
1020 If you think that starting up Gnus takes too long, try all the three
1021 different values for this variable and see what works best for you. 
1022
1023 In any case, if you use @code{some} or @code{nil}, you should definitely
1024 kill all groups that you aren't interested in to speed things up.
1025
1026 Note that this variable also affects active file retrieval from
1027 secondary select methods.
1028
1029
1030 @node Startup Variables
1031 @section Startup Variables
1032
1033 @table @code
1034
1035 @item gnus-load-hook
1036 @vindex gnus-load-hook
1037 A hook run while Gnus is being loaded.  Note that this hook will
1038 normally be run just once in each Emacs session, no matter how many
1039 times you start Gnus.
1040
1041 @item gnus-before-startup-hook
1042 @vindex gnus-before-startup-hook
1043 A hook run after starting up Gnus successfully.
1044
1045 @item gnus-startup-hook
1046 @vindex gnus-startup-hook
1047 A hook run as the very last thing after starting up Gnus
1048
1049 @item gnus-started-hook
1050 @vindex gnus-started-hook
1051 A hook that is run as the very last thing after starting up Gnus
1052 successfully.
1053
1054 @item gnus-setup-news-hook
1055 @vindex gnus-setup-news-hook
1056 A hook that is run after reading the @file{.newsrc} file(s), but before
1057 generating the group buffer.
1058
1059 @item gnus-check-bogus-newsgroups
1060 @vindex gnus-check-bogus-newsgroups
1061 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1062 startup.  A @dfn{bogus group} is a group that you have in your
1063 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1064 bogus groups can take quite a while, so to save time and resources it's
1065 best to leave this option off, and do the checking for bogus groups once
1066 in a while from the group buffer instead (@pxref{Group Maintenance}).
1067
1068 @item gnus-inhibit-startup-message
1069 @vindex gnus-inhibit-startup-message
1070 If non-@code{nil}, the startup message won't be displayed.  That way,
1071 your boss might not notice as easily that you are reading news instead
1072 of doing your job.  Note that this variable is used before
1073 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1074
1075 @item gnus-no-groups-message
1076 @vindex gnus-no-groups-message
1077 Message displayed by Gnus when no groups are available.
1078
1079 @item gnus-play-startup-jingle
1080 @vindex gnus-play-startup-jingle
1081 If non-@code{nil}, play the Gnus jingle at startup.
1082
1083 @item gnus-startup-jingle
1084 @vindex gnus-startup-jingle
1085 Jingle to be played if the above variable is non-@code{nil}.  The
1086 default is @samp{Tuxedomoon.Jingle4.au}.
1087
1088 @end table
1089
1090
1091 @node The Group Buffer
1092 @chapter The Group Buffer
1093 @cindex group buffer
1094
1095 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1096 is the first buffer shown when Gnus starts, and will never be killed as
1097 long as Gnus is active.
1098
1099 @iftex
1100 @iflatex
1101 \gnusfigure{The Group Buffer}{320}{
1102 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1103 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1104 \put(120,38){\vector(1,2){10}}
1105 \put(40,60){\makebox(0,0)[r]{Mode line}}
1106 \put(40,58){\vector(1,0){30}}
1107 \put(200,28){\makebox(0,0)[t]{Native select method}}
1108 \put(200,26){\vector(-1,2){15}}
1109 }
1110 @end iflatex
1111 @end iftex
1112
1113 @menu
1114 * Group Buffer Format::    Information listed and how you can change it.
1115 * Group Maneuvering::      Commands for moving in the group buffer.
1116 * Selecting a Group::      Actually reading news.
1117 * Group Data::             Changing the info for a group.
1118 * Subscription Commands::  Unsubscribing, killing, subscribing.
1119 * Group Levels::           Levels? What are those, then?
1120 * Group Score::            A mechanism for finding out what groups you like.
1121 * Marking Groups::         You can mark groups for later processing.
1122 * Foreign Groups::         Creating and editing groups.
1123 * Group Parameters::       Each group may have different parameters set.
1124 * Listing Groups::         Gnus can list various subsets of the groups.
1125 * Sorting Groups::         Re-arrange the group order.
1126 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1127 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1128 * Exiting Gnus::           Stop reading news and get some work done.
1129 * Group Topics::           A folding group mode divided into topics.
1130 * Misc Group Stuff::       Other stuff that you can to do.
1131 @end menu
1132
1133
1134 @node Group Buffer Format
1135 @section Group Buffer Format
1136
1137 @menu
1138 * Group Line Specification::       Deciding how the group buffer is to look.
1139 * Group Modeline Specification::   The group buffer modeline.
1140 * Group Highlighting::             Having nice colors in the group buffer.
1141 @end menu
1142
1143
1144 @node Group Line Specification
1145 @subsection Group Line Specification
1146 @cindex group buffer format
1147
1148 The default format of the group buffer is nice and dull, but you can
1149 make it as exciting and ugly as you feel like.
1150
1151 Here's a couple of example group lines:
1152
1153 @example
1154      25: news.announce.newusers
1155  *    0: alt.fan.andrea-dworkin
1156 @end example
1157
1158 Quite simple, huh?
1159
1160 You can see that there are 25 unread articles in
1161 @samp{news.announce.newusers}.  There are no unread articles, but some
1162 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1163 asterisk at the beginning of the line?).
1164
1165 @vindex gnus-group-line-format
1166 You can change that format to whatever you want by fiddling with the
1167 @code{gnus-group-line-format} variable.  This variable works along the
1168 lines of a @code{format} specification, which is pretty much the same as
1169 a @code{printf} specifications, for those of you who use (feh!) C.
1170 @xref{Formatting Variables}.
1171
1172 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1173
1174 There should always be a colon on the line; the cursor always moves to
1175 the colon after performing an operation.  Nothing else is required---not
1176 even the group name.  All displayed text is just window dressing, and is
1177 never examined by Gnus.  Gnus stores all real information it needs using
1178 text properties.
1179
1180 (Note that if you make a really strange, wonderful, spreadsheet-like
1181 layout, everybody will believe you are hard at work with the accounting
1182 instead of wasting time reading news.)
1183
1184 Here's a list of all available format characters:
1185
1186 @table @samp
1187
1188 @item M
1189 An asterisk if the group only has marked articles.
1190
1191 @item S
1192 Whether the group is subscribed.
1193
1194 @item L
1195 Level of subscribedness.
1196
1197 @item N
1198 Number of unread articles.
1199
1200 @item I
1201 Number of dormant articles.
1202
1203 @item T
1204 Number of ticked articles.
1205
1206 @item R
1207 Number of read articles.
1208
1209 @item t
1210 Estimated total number of articles.  (This is really @var{max-number}
1211 minus @var{min-number} plus 1.)
1212
1213 @item y
1214 Number of unread, unticked, non-dormant articles.
1215
1216 @item i
1217 Number of ticked and dormant articles.
1218
1219 @item g
1220 Full group name.
1221
1222 @item G
1223 Group name.
1224
1225 @item D
1226 Newsgroup description.
1227
1228 @item o
1229 @samp{m} if moderated.
1230
1231 @item O
1232 @samp{(m)} if moderated.
1233
1234 @item s
1235 Select method.
1236
1237 @item n
1238 Select from where.
1239
1240 @item z
1241 A string that looks like @samp{<%s:%n>} if a foreign select method is
1242 used.
1243
1244 @item P
1245 Indentation based on the level of the topic (@pxref{Group Topics}).
1246
1247 @item c
1248 @vindex gnus-group-uncollapsed-levels
1249 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1250 variable says how many levels to leave at the end of the group name.
1251 The default is 1---this will mean that group names like
1252 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1253
1254 @item m
1255 @vindex gnus-new-mail-mark
1256 @cindex %
1257 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1258 the group lately.
1259
1260 @item d
1261 A string that says when you last read the group (@pxref{Group
1262 Timestamp}).
1263
1264 @item u
1265 User defined specifier.  The next character in the format string should
1266 be a letter.  Gnus will call the function
1267 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1268 following @samp{%u}.  The function will be passed a single dummy
1269 parameter as argument.  The function should return a string, which will
1270 be inserted into the buffer just like information from any other
1271 specifier.
1272 @end table
1273
1274 @cindex *
1275 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1276 if no info is available---for instance, if it is a non-activated foreign
1277 group, or a bogus native group.
1278
1279
1280 @node Group Modeline Specification
1281 @subsection Group Modeline Specification
1282 @cindex group modeline
1283
1284 @vindex gnus-group-mode-line-format
1285 The mode line can be changed by setting
1286 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1287 doesn't understand that many format specifiers:
1288
1289 @table @samp
1290 @item S
1291 The native news server.
1292 @item M
1293 The native select method.
1294 @end table
1295
1296
1297 @node Group Highlighting
1298 @subsection Group Highlighting
1299 @cindex highlighting
1300 @cindex group highlighting
1301
1302 @vindex gnus-group-highlight
1303 Highlighting in the group buffer is controlled by the
1304 @code{gnus-group-highlight} variable.  This is an alist with elements
1305 that look like @code{(@var{form} . @var{face})}.  If @var{form} evaluates to
1306 something non-@code{nil}, the @var{face} will be used on the line.
1307
1308 Here's an example value for this variable that might look nice if the
1309 background is dark:
1310
1311 @lisp
1312 (face-spec-set 'my-group-face-1
1313                '((t (:foreground "Red" :bold t))))
1314 (face-spec-set 'my-group-face-2
1315                '((t (:foreground "SeaGreen" :bold t))))
1316 (face-spec-set 'my-group-face-3
1317                '((t (:foreground "SpringGreen" :bold t))))
1318 (face-spec-set 'my-group-face-4
1319                '((t (:foreground "SteelBlue" :bold t))))
1320 (face-spec-set 'my-group-face-5
1321                '((t (:foreground "SkyBlue" :bold t))))
1322
1323 (setq gnus-group-highlight
1324       '(((> unread 200) . my-group-face-1)
1325         ((and (< level 3) (zerop unread)) . my-group-face-2)
1326         ((< level 3) . my-group-face-3)
1327         ((zerop unread) . my-group-face-4)
1328         (t . my-group-face-5)))
1329 @end lisp
1330
1331 Also @pxref{Faces and Fonts}.
1332
1333 Variables that are dynamically bound when the forms are evaluated
1334 include:
1335
1336 @table @code
1337 @item group
1338 The group name.
1339 @item unread
1340 The number of unread articles in the group.
1341 @item method
1342 The select method.
1343 @item mailp
1344 Whether the group is a mail group.
1345 @item level
1346 The level of the group.
1347 @item score
1348 The score of the group.
1349 @item ticked
1350 The number of ticked articles in the group.
1351 @item total
1352 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1353 MIN-NUMBER plus one.
1354 @item topic
1355 When using the topic minor mode, this variable is bound to the current
1356 topic being inserted.
1357 @end table
1358
1359 When the forms are @code{eval}ed, point is at the beginning of the line
1360 of the group in question, so you can use many of the normal Gnus
1361 functions for snarfing info on the group.
1362
1363 @vindex gnus-group-update-hook
1364 @findex gnus-group-highlight-line
1365 @code{gnus-group-update-hook} is called when a group line is changed.
1366 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1367 calls @code{gnus-group-highlight-line} by default.
1368
1369
1370 @node Group Maneuvering
1371 @section Group Maneuvering
1372 @cindex group movement
1373
1374 All movement commands understand the numeric prefix and will behave as
1375 expected, hopefully.
1376
1377 @table @kbd
1378
1379 @item n
1380 @kindex n (Group)
1381 @findex gnus-group-next-unread-group
1382 Go to the next group that has unread articles
1383 (@code{gnus-group-next-unread-group}).
1384
1385 @item p
1386 @itemx DEL
1387 @kindex DEL (Group)
1388 @kindex p (Group)
1389 @findex gnus-group-prev-unread-group
1390 Go to the previous group that has unread articles
1391 (@code{gnus-group-prev-unread-group}).
1392
1393 @item N
1394 @kindex N (Group)
1395 @findex gnus-group-next-group
1396 Go to the next group (@code{gnus-group-next-group}).
1397
1398 @item P
1399 @kindex P (Group)
1400 @findex gnus-group-prev-group
1401 Go to the previous group (@code{gnus-group-prev-group}).
1402
1403 @item M-n
1404 @kindex M-n (Group)
1405 @findex gnus-group-next-unread-group-same-level
1406 Go to the next unread group on the same (or lower) level
1407 (@code{gnus-group-next-unread-group-same-level}).
1408
1409 @item M-p
1410 @kindex M-p (Group)
1411 @findex gnus-group-prev-unread-group-same-level
1412 Go to the previous unread group on the same (or lower) level
1413 (@code{gnus-group-prev-unread-group-same-level}).
1414 @end table
1415
1416 Three commands for jumping to groups:
1417
1418 @table @kbd
1419
1420 @item j
1421 @kindex j (Group)
1422 @findex gnus-group-jump-to-group
1423 Jump to a group (and make it visible if it isn't already)
1424 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1425 like living groups.
1426
1427 @item ,
1428 @kindex , (Group)
1429 @findex gnus-group-best-unread-group
1430 Jump to the unread group with the lowest level
1431 (@code{gnus-group-best-unread-group}).
1432
1433 @item .
1434 @kindex . (Group)
1435 @findex gnus-group-first-unread-group
1436 Jump to the first group with unread articles
1437 (@code{gnus-group-first-unread-group}).
1438 @end table
1439
1440 @vindex gnus-group-goto-unread
1441 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1442 commands will move to the next group, not the next unread group.  Even
1443 the commands that say they move to the next unread group.  The default
1444 is @code{t}.
1445
1446
1447 @node Selecting a Group
1448 @section Selecting a Group
1449 @cindex group selection
1450
1451 @table @kbd
1452
1453 @item SPACE
1454 @kindex SPACE (Group)
1455 @findex gnus-group-read-group
1456 Select the current group, switch to the summary buffer and display the
1457 first unread article (@code{gnus-group-read-group}).  If there are no
1458 unread articles in the group, or if you give a non-numerical prefix to
1459 this command, Gnus will offer to fetch all the old articles in this
1460 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1461 determines the number of articles Gnus will fetch.  If @var{N} is
1462 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1463 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
1464
1465 @item RET
1466 @kindex RET (Group)
1467 @findex gnus-group-select-group
1468 Select the current group and switch to the summary buffer
1469 (@code{gnus-group-select-group}).  Takes the same arguments as
1470 @code{gnus-group-read-group}---the only difference is that this command
1471 does not display the first unread article automatically upon group
1472 entry.
1473
1474 @item M-RET
1475 @kindex M-RET (Group)
1476 @findex gnus-group-quick-select-group
1477 This does the same as the command above, but tries to do it with the
1478 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1479 scoring/killing will be performed, there will be no highlights and no
1480 expunging.  This might be useful if you're in a real hurry and have to
1481 enter some humongous group.  If you give a 0 prefix to this command
1482 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1483 which is useful if you want to toggle threading before generating the
1484 summary buffer (@pxref{Summary Generation Commands}).
1485
1486 @item M-SPACE
1487 @kindex M-SPACE (Group)
1488 @findex gnus-group-visible-select-group
1489 This is yet one more command that does the same as the @kbd{RET}
1490 command, but this one does it without expunging and hiding dormants
1491 (@code{gnus-group-visible-select-group}).
1492
1493 @item M-C-RET
1494 @kindex M-C-RET (Group)
1495 @findex gnus-group-select-group-ephemerally
1496 Finally, this command selects the current group ephemerally without
1497 doing any processing of its contents
1498 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1499 turned off.  Everything you do in the group after selecting it in this
1500 manner will have no permanent effects.
1501
1502 @end table
1503
1504 @vindex gnus-large-newsgroup
1505 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1506 to be a big group.  This is 200 by default.  If the group has more
1507 (unread and/or ticked) articles than this, Gnus will query the user
1508 before entering the group.  The user can then specify how many articles
1509 should be fetched from the server.  If the user specifies a negative
1510 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1511 is positive, the @code{n} articles that have arrived most recently will
1512 be fetched.
1513
1514 @vindex gnus-select-group-hook
1515 @vindex gnus-auto-select-first
1516 @code{gnus-auto-select-first} control whether any articles are selected
1517 automatically when entering a group with the @kbd{SPACE} command.
1518
1519 @table @code
1520
1521 @item nil
1522 Don't select any articles when entering the group.  Just display the
1523 full summary buffer.
1524
1525 @item t
1526 Select the first unread article when entering the group.
1527
1528 @item best
1529 Select the highest scored article in the group when entering the
1530 group.
1531
1532 @end table
1533
1534 This variable can also be a function.  In that case, that function will
1535 be called to place point on a subject line, and/or select some article.
1536 Useful functions include:
1537
1538 @table @code
1539 @item gnus-summary-first-unread-subject
1540 Place point on the subject line of the first unread article, but
1541 don't select the article.
1542
1543 @item gnus-summary-first-unread-article
1544 Select the first unread article.
1545
1546 @item gnus-summary-best-unread-article
1547 Select the highest-scored unread article.
1548 @end table
1549
1550
1551 If you want to prevent automatic selection in some group (say, in a
1552 binary group with Huge articles) you can set this variable to @code{nil}
1553 in @code{gnus-select-group-hook}, which is called when a group is
1554 selected.
1555
1556
1557 @node Subscription Commands
1558 @section Subscription Commands
1559 @cindex subscription
1560
1561 @table @kbd
1562
1563 @item S t
1564 @itemx u
1565 @kindex S t (Group)
1566 @kindex u (Group)
1567 @findex gnus-group-unsubscribe-current-group
1568 @c @icon{gnus-group-unsubscribe}
1569 Toggle subscription to the current group
1570 (@code{gnus-group-unsubscribe-current-group}).
1571
1572 @item S s
1573 @itemx U
1574 @kindex S s (Group)
1575 @kindex U (Group)
1576 @findex gnus-group-unsubscribe-group
1577 Prompt for a group to subscribe, and then subscribe it.  If it was
1578 subscribed already, unsubscribe it instead
1579 (@code{gnus-group-unsubscribe-group}).
1580
1581 @item S k
1582 @itemx C-k
1583 @kindex S k (Group)
1584 @kindex C-k (Group)
1585 @findex gnus-group-kill-group
1586 @c @icon{gnus-group-kill-group}
1587 Kill the current group (@code{gnus-group-kill-group}).
1588
1589 @item S y
1590 @itemx C-y
1591 @kindex S y (Group)
1592 @kindex C-y (Group)
1593 @findex gnus-group-yank-group
1594 Yank the last killed group (@code{gnus-group-yank-group}).
1595
1596 @item C-x C-t
1597 @kindex C-x C-t (Group)
1598 @findex gnus-group-transpose-groups
1599 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1600 really a subscription command, but you can use it instead of a
1601 kill-and-yank sequence sometimes.
1602
1603 @item S w
1604 @itemx C-w
1605 @kindex S w (Group)
1606 @kindex C-w (Group)
1607 @findex gnus-group-kill-region
1608 Kill all groups in the region (@code{gnus-group-kill-region}).
1609
1610 @item S z
1611 @kindex S z (Group)
1612 @findex gnus-group-kill-all-zombies
1613 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1614
1615 @item S C-k
1616 @kindex S C-k (Group)
1617 @findex gnus-group-kill-level
1618 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1619 These groups can't be yanked back after killing, so this command should
1620 be used with some caution.  The only time where this command comes in
1621 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1622 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1623 kill off all unsubscribed groups that do not have message numbers in the
1624 @file{.newsrc} file.
1625
1626 @end table
1627
1628 Also @pxref{Group Levels}.
1629
1630
1631 @node Group Data
1632 @section Group Data
1633
1634 @table @kbd
1635
1636 @item c
1637 @kindex c (Group)
1638 @findex gnus-group-catchup-current
1639 @vindex gnus-group-catchup-group-hook
1640 @c @icon{gnus-group-catchup-current}
1641 Mark all unticked articles in this group as read
1642 (@code{gnus-group-catchup-current}).
1643 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1644 the group buffer.
1645
1646 @item C
1647 @kindex C (Group)
1648 @findex gnus-group-catchup-current-all
1649 Mark all articles in this group, even the ticked ones, as read
1650 (@code{gnus-group-catchup-current-all}).
1651
1652 @item M-c
1653 @kindex M-c (Group)
1654 @findex gnus-group-clear-data
1655 Clear the data from the current group---nix out marks and the list of
1656 read articles (@code{gnus-group-clear-data}).
1657
1658 @item M-x gnus-group-clear-data-on-native-groups
1659 @kindex M-x gnus-group-clear-data-on-native-groups
1660 @findex gnus-group-clear-data-on-native-groups
1661 If you have switched from one @sc{nntp} server to another, all your marks
1662 and read ranges have become worthless.  You can use this command to
1663 clear out all data that you have on your native groups.  Use with
1664 caution.
1665
1666 @end table
1667
1668
1669 @node Group Levels
1670 @section Group Levels
1671 @cindex group level
1672 @cindex level
1673
1674 All groups have a level of @dfn{subscribedness}.  For instance, if a
1675 group is on level 2, it is more subscribed than a group on level 5.  You
1676 can ask Gnus to just list groups on a given level or lower
1677 (@pxref{Listing Groups}), or to just check for new articles in groups on
1678 a given level or lower (@pxref{Scanning New Messages}).
1679
1680 Remember:  The higher the level of the group, the less important it is.
1681
1682 @table @kbd
1683
1684 @item S l
1685 @kindex S l (Group)
1686 @findex gnus-group-set-current-level
1687 Set the level of the current group.  If a numeric prefix is given, the
1688 next @var{n} groups will have their levels set.  The user will be
1689 prompted for a level.
1690 @end table
1691
1692 @vindex gnus-level-killed
1693 @vindex gnus-level-zombie
1694 @vindex gnus-level-unsubscribed
1695 @vindex gnus-level-subscribed
1696 Gnus considers groups from levels 1 to
1697 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1698 @code{gnus-level-subscribed} (exclusive) and
1699 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1700 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1701 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1702 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1703 same, but zombie and killed groups have no information on what articles
1704 you have read, etc, stored.  This distinction between dead and living
1705 groups isn't done because it is nice or clever, it is done purely for
1706 reasons of efficiency.
1707
1708 It is recommended that you keep all your mail groups (if any) on quite
1709 low levels (e.g. 1 or 2).
1710
1711 If you want to play with the level variables, you should show some care.
1712 Set them once, and don't touch them ever again.  Better yet, don't touch
1713 them at all unless you know exactly what you're doing.
1714
1715 @vindex gnus-level-default-unsubscribed
1716 @vindex gnus-level-default-subscribed
1717 Two closely related variables are @code{gnus-level-default-subscribed}
1718 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1719 which are the levels that new groups will be put on if they are
1720 (un)subscribed.  These two variables should, of course, be inside the
1721 relevant valid ranges.
1722
1723 @vindex gnus-keep-same-level
1724 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1725 will only move to groups of the same level (or lower).  In
1726 particular, going from the last article in one group to the next group
1727 will go to the next group of the same level (or lower).  This might be
1728 handy if you want to read the most important groups before you read the
1729 rest.
1730
1731 @vindex gnus-group-default-list-level
1732 All groups with a level less than or equal to
1733 @code{gnus-group-default-list-level} will be listed in the group buffer
1734 by default.
1735
1736 @vindex gnus-group-list-inactive-groups
1737 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1738 groups will be listed along with the unread groups.  This variable is
1739 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1740 listed.
1741
1742 @vindex gnus-group-use-permanent-levels
1743 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1744 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1745 use this level as the ``work'' level.
1746
1747 @vindex gnus-activate-level
1748 Gnus will normally just activate (i. e., query the server about) groups
1749 on level @code{gnus-activate-level} or less.  If you don't want to
1750 activate unsubscribed groups, for instance, you might set this variable
1751 to 5.  The default is 6.
1752
1753
1754 @node Group Score
1755 @section Group Score
1756 @cindex group score
1757 @cindex group rank
1758 @cindex rank
1759
1760 You would normally keep important groups on high levels, but that scheme
1761 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1762 group buffer according to how often you read groups, perhaps?  Within
1763 reason?
1764
1765 This is what @dfn{group score} is for.  You can have Gnus assign a score
1766 to each group through the mechanism described below.  You can then sort
1767 the group buffer based on this score.  Alternatively, you can sort on
1768 score and then level.  (Taken together, the level and the score is
1769 called the @dfn{rank} of the group.  A group that is on level 4 and has
1770 a score of 1 has a higher rank than a group on level 5 that has a score
1771 of 300.  (The level is the most significant part and the score is the
1772 least significant part.))
1773
1774 @findex gnus-summary-bubble-group
1775 If you want groups you read often to get higher scores than groups you
1776 read seldom you can add the @code{gnus-summary-bubble-group} function to
1777 the @code{gnus-summary-exit-hook} hook.  This will result (after
1778 sorting) in a bubbling sort of action.  If you want to see that in
1779 action after each summary exit, you can add
1780 @code{gnus-group-sort-groups-by-rank} or
1781 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1782 slow things down somewhat.
1783
1784
1785 @node Marking Groups
1786 @section Marking Groups
1787 @cindex marking groups
1788
1789 If you want to perform some command on several groups, and they appear
1790 subsequently in the group buffer, you would normally just give a
1791 numerical prefix to the command.  Most group commands will then do your
1792 bidding on those groups.
1793
1794 However, if the groups are not in sequential order, you can still
1795 perform a command on several groups.  You simply mark the groups first
1796 with the process mark and then execute the command.
1797
1798 @table @kbd
1799
1800 @item #
1801 @kindex # (Group)
1802 @itemx M m
1803 @kindex M m (Group)
1804 @findex gnus-group-mark-group
1805 Set the mark on the current group (@code{gnus-group-mark-group}).
1806
1807 @item M-#
1808 @kindex M-# (Group)
1809 @itemx M u
1810 @kindex M u (Group)
1811 @findex gnus-group-unmark-group
1812 Remove the mark from the current group
1813 (@code{gnus-group-unmark-group}).
1814
1815 @item M U
1816 @kindex M U (Group)
1817 @findex gnus-group-unmark-all-groups
1818 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1819
1820 @item M w
1821 @kindex M w (Group)
1822 @findex gnus-group-mark-region
1823 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1824
1825 @item M b
1826 @kindex M b (Group)
1827 @findex gnus-group-mark-buffer
1828 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1829
1830 @item M r
1831 @kindex M r (Group)
1832 @findex gnus-group-mark-regexp
1833 Mark all groups that match some regular expression
1834 (@code{gnus-group-mark-regexp}).
1835 @end table
1836
1837 Also @pxref{Process/Prefix}.
1838
1839 @findex gnus-group-universal-argument
1840 If you want to execute some command on all groups that have been marked
1841 with the process mark, you can use the @kbd{M-&}
1842 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1843 the command to be executed.
1844
1845
1846 @node Foreign Groups
1847 @section Foreign Groups
1848 @cindex foreign groups
1849
1850 Below are some group mode commands for making and editing general foreign
1851 groups, as well as commands to ease the creation of a few
1852 special-purpose groups.  All these commands insert the newly created
1853 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1854 consulted.
1855
1856 @table @kbd
1857
1858 @item G m
1859 @kindex G m (Group)
1860 @findex gnus-group-make-group
1861 @cindex making groups
1862 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1863 for a name, a method and possibly an @dfn{address}.  For an easier way
1864 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1865
1866 @item G r
1867 @kindex G r (Group)
1868 @findex gnus-group-rename-group
1869 @cindex renaming groups
1870 Rename the current group to something else
1871 (@code{gnus-group-rename-group}).  This is valid only on some
1872 groups---mail groups mostly.  This command might very well be quite slow
1873 on some backends.
1874
1875 @item G c
1876 @kindex G c (Group)
1877 @cindex customizing
1878 @findex gnus-group-customize
1879 Customize the group parameters (@code{gnus-group-customize}).
1880
1881 @item G e
1882 @kindex G e (Group)
1883 @findex gnus-group-edit-group-method
1884 @cindex renaming groups
1885 Enter a buffer where you can edit the select method of the current
1886 group (@code{gnus-group-edit-group-method}).
1887
1888 @item G p
1889 @kindex G p (Group)
1890 @findex gnus-group-edit-group-parameters
1891 Enter a buffer where you can edit the group parameters
1892 (@code{gnus-group-edit-group-parameters}).
1893
1894 @item G E
1895 @kindex G E (Group)
1896 @findex gnus-group-edit-group
1897 Enter a buffer where you can edit the group info
1898 (@code{gnus-group-edit-group}).
1899
1900 @item G d
1901 @kindex G d (Group)
1902 @findex gnus-group-make-directory-group
1903 @cindex nndir
1904 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1905 for a directory name (@code{gnus-group-make-directory-group}).
1906
1907 @item G h
1908 @kindex G h (Group)
1909 @cindex help group
1910 @findex gnus-group-make-help-group
1911 Make the Gnus help group (@code{gnus-group-make-help-group}).
1912
1913 @item G a
1914 @kindex G a (Group)
1915 @cindex (ding) archive
1916 @cindex archive group
1917 @findex gnus-group-make-archive-group
1918 @vindex gnus-group-archive-directory
1919 @vindex gnus-group-recent-archive-directory
1920 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1921 default a group pointing to the most recent articles will be created
1922 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1923 group will be created from @code{gnus-group-archive-directory}.
1924
1925 @item G k
1926 @kindex G k (Group)
1927 @findex gnus-group-make-kiboze-group
1928 @cindex nnkiboze
1929 Make a kiboze group.  You will be prompted for a name, for a regexp to
1930 match groups to be ``included'' in the kiboze group, and a series of
1931 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1932 @xref{Kibozed Groups}.
1933
1934 @item G D
1935 @kindex G D (Group)
1936 @findex gnus-group-enter-directory
1937 @cindex nneething
1938 Read an arbitrary directory as if it were a newsgroup with the
1939 @code{nneething} backend (@code{gnus-group-enter-directory}).
1940 @xref{Anything Groups}.
1941
1942 @item G f
1943 @kindex G f (Group)
1944 @findex gnus-group-make-doc-group
1945 @cindex ClariNet Briefs
1946 @cindex nndoc
1947 Make a group based on some file or other
1948 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1949 command, you will be prompted for a file name and a file type.
1950 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1951 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1952 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
1953 If you run this command without a prefix, Gnus will guess at the file
1954 type.  @xref{Document Groups}.
1955
1956 @item G u
1957 @kindex G u (Group)
1958 @vindex gnus-useful-groups
1959 @findex gnus-group-make-useful-group
1960 Create one of the groups mentioned in @code{gnus-useful-groups}
1961 (@code{gnus-group-make-useful-group}).
1962
1963 @item G w
1964 @kindex G w (Group)
1965 @findex gnus-group-make-web-group
1966 @cindex DejaNews
1967 @cindex Alta Vista
1968 @cindex InReference
1969 @cindex nnweb
1970 Make an ephemeral group based on a web search
1971 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1972 command, make a solid group instead.  You will be prompted for the
1973 search engine type and the search string.  Valid search engine types
1974 include @code{dejanews}, @code{altavista} and @code{reference}.
1975 @xref{Web Searches}.
1976
1977 If you use the @code{dejanews} search engine, you can limit the search
1978 to a particular group by using a match string like
1979 @samp{~g alt.sysadmin.recovery shaving}.
1980
1981 @item G DEL
1982 @kindex G DEL (Group)
1983 @findex gnus-group-delete-group
1984 This function will delete the current group
1985 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1986 actually delete all the articles in the group, and forcibly remove the
1987 group itself from the face of the Earth.  Use a prefix only if you are
1988 absolutely sure of what you are doing.  This command can't be used on
1989 read-only groups (like @code{nntp} group), though.
1990
1991 @item G V
1992 @kindex G V (Group)
1993 @findex gnus-group-make-empty-virtual
1994 Make a new, fresh, empty @code{nnvirtual} group
1995 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1996
1997 @item G v
1998 @kindex G v (Group)
1999 @findex gnus-group-add-to-virtual
2000 Add the current group to an @code{nnvirtual} group
2001 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
2002 @end table
2003
2004 @xref{Select Methods}, for more information on the various select
2005 methods.
2006
2007 @vindex gnus-activate-foreign-newsgroups
2008 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2009 Gnus will check all foreign groups with this level or lower at startup.
2010 This might take quite a while, especially if you subscribe to lots of
2011 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
2012 @code{gnus-activate-level} also affects activation of foreign
2013 newsgroups.
2014
2015
2016 @node Group Parameters
2017 @section Group Parameters
2018 @cindex group parameters
2019
2020 The group parameters store information local to a particular group.
2021 Here's an example group parameter list:
2022
2023 @example
2024 ((to-address . "ding@@gnus.org")
2025  (auto-expire . t))
2026 @end example
2027
2028 We see that each element consists of a "dotted pair"---the thing before
2029 the dot is the key, while the thing after the dot is the value.  All the
2030 parameters have this form @emph{except} local variable specs, which are
2031 not dotted pairs, but proper lists.
2032
2033 The following group parameters can be used:
2034
2035 @table @code
2036 @item to-address
2037 @cindex to-address
2038 Address used by when doing followups and new posts.
2039
2040 @example
2041 (to-address .  "some@@where.com")
2042 @end example
2043
2044 This is primarily useful in mail groups that represent closed mailing
2045 lists---mailing lists where it's expected that everybody that writes to
2046 the mailing list is subscribed to it.  Since using this parameter
2047 ensures that the mail only goes to the mailing list itself, it means
2048 that members won't receive two copies of your followups.
2049
2050 Using @code{to-address} will actually work whether the group is foreign
2051 or not.  Let's say there's a group on the server that is called
2052 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2053 the articles from a mail-to-news gateway.  Posting directly to this
2054 group is therefore impossible---you have to send mail to the mailing
2055 list address instead.
2056
2057 @item to-list
2058 @cindex to-list
2059 Address used when doing a @kbd{a} in that group.
2060
2061 @example
2062 (to-list . "some@@where.com")
2063 @end example
2064
2065 It is totally ignored
2066 when doing a followup---except that if it is present in a news group,
2067 you'll get mail group semantics when doing @kbd{f}.
2068
2069 If you do an @kbd{a} command in a mail group and you have neither a
2070 @code{to-list} group parameter nor a @code{to-address} group parameter,
2071 then a @code{to-list} group parameter will be added automatically upon
2072 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2073 @vindex gnus-add-to-list
2074
2075 If you do an @kbd{a} command in a mail group and you don't have a
2076 @code{to-list} group parameter, one will be added automatically upon
2077 sending the message.
2078
2079 @item visible
2080 @cindex visible
2081 If the group parameter list has the element @code{(visible . t)},
2082 that group will always be visible in the Group buffer, regardless
2083 of whether it has any unread articles.
2084
2085 @item broken-reply-to
2086 @cindex broken-reply-to
2087 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2088 headers in this group are to be ignored.  This can be useful if you're
2089 reading a mailing list group where the listserv has inserted
2090 @code{Reply-To} headers that point back to the listserv itself.  This is
2091 broken behavior.  So there!
2092
2093 @item to-group
2094 @cindex to-group
2095 Elements like @code{(to-group . "some.group.name")} means that all
2096 posts in that group will be sent to @code{some.group.name}.
2097
2098 @item newsgroup
2099 @cindex newsgroup
2100 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2101 will treat all responses as if they were responses to news articles.
2102 This can be useful if you have a mail group that's really a mirror of a
2103 news group.
2104
2105 @item gcc-self
2106 @cindex gcc-self
2107 If @code{(gcc-self . t)} is present in the group parameter list, newly
2108 composed messages will be @code{Gcc}'d to the current group. If
2109 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2110 generated, if @code{(gcc-self . "string")} is present, this string will
2111 be inserted literally as a @code{gcc} header.  This parameter takes
2112 precedence over any default @code{Gcc} rules as described later
2113 (@pxref{Archived Messages}).
2114
2115 @item auto-expire
2116 @cindex auto-expire
2117 If the group parameter has an element that looks like @code{(auto-expire
2118 . t)}, all articles read will be marked as expirable.  For an
2119 alternative approach, @pxref{Expiring Mail}.
2120
2121 @item total-expire
2122 @cindex total-expire
2123 If the group parameter has an element that looks like
2124 @code{(total-expire . t)}, all read articles will be put through the
2125 expiry process, even if they are not marked as expirable.  Use with
2126 caution.  Unread, ticked and dormant articles are not eligible for
2127 expiry.
2128
2129 @item expiry-wait
2130 @cindex expiry-wait
2131 @vindex nnmail-expiry-wait-function
2132 If the group parameter has an element that looks like @code{(expiry-wait
2133 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2134 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2135 The value can either be a number of days (not necessarily an integer) or
2136 the symbols @code{never} or @code{immediate}.
2137
2138 @item score-file
2139 @cindex score file group parameter
2140 Elements that look like @code{(score-file . "file")} will make
2141 @file{file} into the current score file for the group in question.  All
2142 interactive score entries will be put into this file.
2143
2144 @item adapt-file
2145 @cindex adapt file group parameter
2146 Elements that look like @code{(adapt-file . "file")} will make
2147 @file{file} into the current adaptive file for the group in question.
2148 All adaptive score entries will be put into this file.
2149
2150 @item admin-address
2151 When unsubscribing from a mailing list you should never send the
2152 unsubscription notice to the mailing list itself.  Instead, you'd send
2153 messages to the administrative address.  This parameter allows you to
2154 put the admin address somewhere convenient.
2155
2156 @item display
2157 Elements that look like @code{(display . MODE)} say which articles to
2158 display on entering the group.  Valid values are:
2159
2160 @table @code
2161 @item all
2162 Display all articles, both read and unread.
2163
2164 @item default
2165 Display the default visible articles, which normally includes unread and
2166 ticked articles.
2167 @end table
2168
2169 @item comment
2170 Elements that look like @code{(comment . "This is a comment")}
2171 are arbitrary comments on the group.  They are currently ignored by
2172 Gnus, but provide a place for you to store information on particular
2173 groups.
2174
2175 @item charset
2176 Elements that look like @code{(charset . iso-8859-1)} will make
2177 @code{iso-8859-1} the default charset; that is, the charset that will be
2178 used for all articles that do not specify a charset.
2179
2180 @item (@var{variable} @var{form})
2181 You can use the group parameters to set variables local to the group you
2182 are entering.  If you want to turn threading off in @samp{news.answers},
2183 you could put @code{(gnus-show-threads nil)} in the group parameters of
2184 that group.  @code{gnus-show-threads} will be made into a local variable
2185 in the summary buffer you enter, and the form @code{nil} will be
2186 @code{eval}ed there.
2187
2188 This can also be used as a group-specific hook function, if you'd like.
2189 If you want to hear a beep when you enter a group, you could put
2190 something like @code{(dummy-variable (ding))} in the parameters of that
2191 group.  @code{dummy-variable} will be set to the result of the
2192 @code{(ding)} form, but who cares?
2193
2194 @item posting-style
2195 You can store additional posting style information for this group only
2196 here (@pxref{Posting Styles}). The format is that of an entry in the
2197 @code{gnus-posting-styles} alist, except that there's no regexp matching
2198 the group name (of course). Style elements in this group parameter will
2199 take precedence over the ones found in @code{gnus-posting-styles}.
2200
2201 For instance, if you want a funky name and signature in this group only,
2202 instead of hacking @code{gnus-posting-styles}, you could put something
2203 like this in the group parameters:
2204
2205 @example
2206 (posting-style
2207   (name "Funky Name")
2208   (signature "Funky Signature"))
2209 @end example
2210
2211 @end table
2212
2213 Use the @kbd{G p} command to edit group parameters of a group.  You
2214 might also be interested in reading about topic parameters (@pxref{Topic
2215 Parameters}).
2216
2217
2218 @node Listing Groups
2219 @section Listing Groups
2220 @cindex group listing
2221
2222 These commands all list various slices of the groups available.
2223
2224 @table @kbd
2225
2226 @item l
2227 @itemx A s
2228 @kindex A s (Group)
2229 @kindex l (Group)
2230 @findex gnus-group-list-groups
2231 List all groups that have unread articles
2232 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2233 command will list only groups of level ARG and lower.  By default, it
2234 only lists groups of level five (i. e.,
2235 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2236 groups).
2237
2238 @item L
2239 @itemx A u
2240 @kindex A u (Group)
2241 @kindex L (Group)
2242 @findex gnus-group-list-all-groups
2243 List all groups, whether they have unread articles or not
2244 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2245 this command will list only groups of level ARG and lower.  By default,
2246 it lists groups of level seven or lower (i.e., just subscribed and
2247 unsubscribed groups).
2248
2249 @item A l
2250 @kindex A l (Group)
2251 @findex gnus-group-list-level
2252 List all unread groups on a specific level
2253 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2254 with no unread articles.
2255
2256 @item A k
2257 @kindex A k (Group)
2258 @findex gnus-group-list-killed
2259 List all killed groups (@code{gnus-group-list-killed}).  If given a
2260 prefix argument, really list all groups that are available, but aren't
2261 currently (un)subscribed.  This could entail reading the active file
2262 from the server.
2263
2264 @item A z
2265 @kindex A z (Group)
2266 @findex gnus-group-list-zombies
2267 List all zombie groups (@code{gnus-group-list-zombies}).
2268
2269 @item A m
2270 @kindex A m (Group)
2271 @findex gnus-group-list-matching
2272 List all unread, subscribed groups with names that match a regexp
2273 (@code{gnus-group-list-matching}).
2274
2275 @item A M
2276 @kindex A M (Group)
2277 @findex gnus-group-list-all-matching
2278 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2279
2280 @item A A
2281 @kindex A A (Group)
2282 @findex gnus-group-list-active
2283 List absolutely all groups in the active file(s) of the
2284 server(s) you are connected to (@code{gnus-group-list-active}).  This
2285 might very well take quite a while.  It might actually be a better idea
2286 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2287 thing to match on.  Also note that this command may list groups that
2288 don't exist (yet)---these will be listed as if they were killed groups.
2289 Take the output with some grains of salt.
2290
2291 @item A a
2292 @kindex A a (Group)
2293 @findex gnus-group-apropos
2294 List all groups that have names that match a regexp
2295 (@code{gnus-group-apropos}).
2296
2297 @item A d
2298 @kindex A d (Group)
2299 @findex gnus-group-description-apropos
2300 List all groups that have names or descriptions that match a regexp
2301 (@code{gnus-group-description-apropos}).
2302
2303 @end table
2304
2305 @vindex gnus-permanently-visible-groups
2306 @cindex visible group parameter
2307 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2308 always be shown, whether they have unread articles or not.  You can also
2309 add the @code{visible} element to the group parameters in question to
2310 get the same effect.
2311
2312 @vindex gnus-list-groups-with-ticked-articles
2313 Groups that have just ticked articles in it are normally listed in the
2314 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2315 @code{nil}, these groups will be treated just like totally empty
2316 groups.  It is @code{t} by default.
2317
2318
2319 @node Sorting Groups
2320 @section Sorting Groups
2321 @cindex sorting groups
2322
2323 @kindex C-c C-s (Group)
2324 @findex gnus-group-sort-groups
2325 @vindex gnus-group-sort-function
2326 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2327 group buffer according to the function(s) given by the
2328 @code{gnus-group-sort-function} variable.  Available sorting functions
2329 include:
2330
2331 @table @code
2332
2333 @item gnus-group-sort-by-alphabet
2334 @findex gnus-group-sort-by-alphabet
2335 Sort the group names alphabetically.  This is the default.
2336
2337 @item gnus-group-sort-by-real-name
2338 @findex gnus-group-sort-by-real-name
2339 Sort the group alphabetically on the real (unprefixed) group names.
2340
2341 @item gnus-group-sort-by-level
2342 @findex gnus-group-sort-by-level
2343 Sort by group level.
2344
2345 @item gnus-group-sort-by-score
2346 @findex gnus-group-sort-by-score
2347 Sort by group score.  @xref{Group Score}.
2348
2349 @item gnus-group-sort-by-rank
2350 @findex gnus-group-sort-by-rank
2351 Sort by group score and then the group level.  The level and the score
2352 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2353
2354 @item gnus-group-sort-by-unread
2355 @findex gnus-group-sort-by-unread
2356 Sort by number of unread articles.
2357
2358 @item gnus-group-sort-by-method
2359 @findex gnus-group-sort-by-method
2360 Sort alphabetically on the select method.
2361
2362
2363 @end table
2364
2365 @code{gnus-group-sort-function} can also be a list of sorting
2366 functions.  In that case, the most significant sort key function must be
2367 the last one.
2368
2369
2370 There are also a number of commands for sorting directly according to
2371 some sorting criteria:
2372
2373 @table @kbd
2374 @item G S a
2375 @kindex G S a (Group)
2376 @findex gnus-group-sort-groups-by-alphabet
2377 Sort the group buffer alphabetically by group name
2378 (@code{gnus-group-sort-groups-by-alphabet}).
2379
2380 @item G S u
2381 @kindex G S u (Group)
2382 @findex gnus-group-sort-groups-by-unread
2383 Sort the group buffer by the number of unread articles
2384 (@code{gnus-group-sort-groups-by-unread}).
2385
2386 @item G S l
2387 @kindex G S l (Group)
2388 @findex gnus-group-sort-groups-by-level
2389 Sort the group buffer by group level
2390 (@code{gnus-group-sort-groups-by-level}).
2391
2392 @item G S v
2393 @kindex G S v (Group)
2394 @findex gnus-group-sort-groups-by-score
2395 Sort the group buffer by group score
2396 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2397
2398 @item G S r
2399 @kindex G S r (Group)
2400 @findex gnus-group-sort-groups-by-rank
2401 Sort the group buffer by group rank
2402 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2403
2404 @item G S m
2405 @kindex G S m (Group)
2406 @findex gnus-group-sort-groups-by-method
2407 Sort the group buffer alphabetically by backend name
2408 (@code{gnus-group-sort-groups-by-method}).
2409
2410 @end table
2411
2412 All the commands below obey the process/prefix convention
2413 (@pxref{Process/Prefix}).
2414
2415 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2416 commands will sort in reverse order.
2417
2418 You can also sort a subset of the groups:
2419
2420 @table @kbd
2421 @item G P a
2422 @kindex G P a (Group)
2423 @findex gnus-group-sort-selected-groups-by-alphabet
2424 Sort the groups alphabetically by group name
2425 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2426
2427 @item G P u
2428 @kindex G P u (Group)
2429 @findex gnus-group-sort-selected-groups-by-unread
2430 Sort the groups by the number of unread articles
2431 (@code{gnus-group-sort-selected-groups-by-unread}).
2432
2433 @item G P l
2434 @kindex G P l (Group)
2435 @findex gnus-group-sort-selected-groups-by-level
2436 Sort the groups by group level
2437 (@code{gnus-group-sort-selected-groups-by-level}).
2438
2439 @item G P v
2440 @kindex G P v (Group)
2441 @findex gnus-group-sort-selected-groups-by-score
2442 Sort the groups by group score
2443 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2444
2445 @item G P r
2446 @kindex G P r (Group)
2447 @findex gnus-group-sort-selected-groups-by-rank
2448 Sort the groups by group rank
2449 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2450
2451 @item G P m
2452 @kindex G P m (Group)
2453 @findex gnus-group-sort-selected-groups-by-method
2454 Sort the groups alphabetically by backend name
2455 (@code{gnus-group-sort-selected-groups-by-method}).
2456
2457 @end table
2458
2459
2460
2461 @node Group Maintenance
2462 @section Group Maintenance
2463 @cindex bogus groups
2464
2465 @table @kbd
2466 @item b
2467 @kindex b (Group)
2468 @findex gnus-group-check-bogus-groups
2469 Find bogus groups and delete them
2470 (@code{gnus-group-check-bogus-groups}).
2471
2472 @item F
2473 @kindex F (Group)
2474 @findex gnus-group-find-new-groups
2475 Find new groups and process them (@code{gnus-group-find-new-groups}).
2476 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2477 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
2478 to query the server for new groups, and subscribe the new groups as
2479 zombies.
2480
2481 @item C-c C-x
2482 @kindex C-c C-x (Group)
2483 @findex gnus-group-expire-articles
2484 Run all expirable articles in the current group through the expiry
2485 process (if any) (@code{gnus-group-expire-articles}).
2486
2487 @item C-c M-C-x
2488 @kindex C-c M-C-x (Group)
2489 @findex gnus-group-expire-all-groups
2490 Run all articles in all groups through the expiry process
2491 (@code{gnus-group-expire-all-groups}).
2492
2493 @end table
2494
2495
2496 @node Browse Foreign Server
2497 @section Browse Foreign Server
2498 @cindex foreign servers
2499 @cindex browsing servers
2500
2501 @table @kbd
2502 @item B
2503 @kindex B (Group)
2504 @findex gnus-group-browse-foreign-server
2505 You will be queried for a select method and a server name.  Gnus will
2506 then attempt to contact this server and let you browse the groups there
2507 (@code{gnus-group-browse-foreign-server}).
2508 @end table
2509
2510 @findex gnus-browse-mode
2511 A new buffer with a list of available groups will appear.  This buffer
2512 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2513 a lot) like a normal group buffer.
2514
2515 Here's a list of keystrokes available in the browse mode:
2516
2517 @table @kbd
2518 @item n
2519 @kindex n (Browse)
2520 @findex gnus-group-next-group
2521 Go to the next group (@code{gnus-group-next-group}).
2522
2523 @item p
2524 @kindex p (Browse)
2525 @findex gnus-group-prev-group
2526 Go to the previous group (@code{gnus-group-prev-group}).
2527
2528 @item SPACE
2529 @kindex SPACE (Browse)
2530 @findex gnus-browse-read-group
2531 Enter the current group and display the first article
2532 (@code{gnus-browse-read-group}).
2533
2534 @item RET
2535 @kindex RET (Browse)
2536 @findex gnus-browse-select-group
2537 Enter the current group (@code{gnus-browse-select-group}).
2538
2539 @item u
2540 @kindex u (Browse)
2541 @findex gnus-browse-unsubscribe-current-group
2542 Unsubscribe to the current group, or, as will be the case here,
2543 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2544
2545 @item l
2546 @itemx q
2547 @kindex q (Browse)
2548 @kindex l (Browse)
2549 @findex gnus-browse-exit
2550 Exit browse mode (@code{gnus-browse-exit}).
2551
2552 @item ?
2553 @kindex ? (Browse)
2554 @findex gnus-browse-describe-briefly
2555 Describe browse mode briefly (well, there's not much to describe, is
2556 there) (@code{gnus-browse-describe-briefly}).
2557 @end table
2558
2559
2560 @node Exiting Gnus
2561 @section Exiting Gnus
2562 @cindex exiting Gnus
2563
2564 Yes, Gnus is ex(c)iting.
2565
2566 @table @kbd
2567 @item z
2568 @kindex z (Group)
2569 @findex gnus-group-suspend
2570 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2571 but it kills all buffers except the Group buffer.  I'm not sure why this
2572 is a gain, but then who am I to judge?
2573
2574 @item q
2575 @kindex q (Group)
2576 @findex gnus-group-exit
2577 @c @icon{gnus-group-exit}
2578 Quit Gnus (@code{gnus-group-exit}).
2579
2580 @item Q
2581 @kindex Q (Group)
2582 @findex gnus-group-quit
2583 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2584 The dribble file will be saved, though (@pxref{Auto Save}).
2585 @end table
2586
2587 @vindex gnus-exit-gnus-hook
2588 @vindex gnus-suspend-gnus-hook
2589 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2590 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2591 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2592 exiting Gnus.
2593
2594 @findex gnus-unload
2595 @cindex unloading
2596 If you wish to completely unload Gnus and all its adherents, you can use
2597 the @code{gnus-unload} command.  This command is also very handy when
2598 trying to customize meta-variables.
2599
2600 Note:
2601
2602 @quotation
2603 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2604 numbly heavy and herself fall into a hazy trance as the boy sitting
2605 behind her drew repeated lines with his pencil across the back of her
2606 plastic chair.
2607 @end quotation
2608
2609
2610 @node Group Topics
2611 @section Group Topics
2612 @cindex topics
2613
2614 If you read lots and lots of groups, it might be convenient to group
2615 them hierarchically according to topics.  You put your Emacs groups over
2616 here, your sex groups over there, and the rest (what, two groups or so?)
2617 you put in some misc section that you never bother with anyway.  You can
2618 even group the Emacs sex groups as a sub-topic to either the Emacs
2619 groups or the sex groups---or both!  Go wild!
2620
2621 @iftex
2622 @iflatex
2623 \gnusfigure{Group Topics}{400}{
2624 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2625 }
2626 @end iflatex
2627 @end iftex
2628
2629 Here's an example:
2630
2631 @example
2632 Gnus
2633   Emacs -- I wuw it!
2634      3: comp.emacs
2635      2: alt.religion.emacs
2636     Naughty Emacs
2637      452: alt.sex.emacs
2638        0: comp.talk.emacs.recovery
2639   Misc
2640      8: comp.binaries.fractals
2641     13: comp.sources.unix
2642 @end example
2643
2644 @findex gnus-topic-mode
2645 @kindex t (Group)
2646 To get this @emph{fab} functionality you simply turn on (ooh!) the
2647 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2648 is a toggling command.)
2649
2650 Go ahead, just try it.  I'll still be here when you get back.  La de
2651 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2652 press @kbd{l}.  There.  All your groups are now listed under
2653 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2654 bothered?
2655
2656 If you want this permanently enabled, you should add that minor mode to
2657 the hook for the group mode:
2658
2659 @lisp
2660 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2661 @end lisp
2662
2663 @menu
2664 * Topic Variables::    How to customize the topics the Lisp Way.
2665 * Topic Commands::     Interactive E-Z commands.
2666 * Topic Sorting::      Sorting each topic individually.
2667 * Topic Topology::     A map of the world.
2668 * Topic Parameters::   Parameters that apply to all groups in a topic.
2669 @end menu
2670
2671
2672 @node Topic Variables
2673 @subsection Topic Variables
2674 @cindex topic variables
2675
2676 Now, if you select a topic, it will fold/unfold that topic, which is
2677 really neat, I think.
2678
2679 @vindex gnus-topic-line-format
2680 The topic lines themselves are created according to the
2681 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2682 Valid elements are:
2683
2684 @table @samp
2685 @item i
2686 Indentation.
2687 @item n
2688 Topic name.
2689 @item v
2690 Visibility.
2691 @item l
2692 Level.
2693 @item g
2694 Number of groups in the topic.
2695 @item a
2696 Number of unread articles in the topic.
2697 @item A
2698 Number of unread articles in the topic and all its subtopics.
2699 @end table
2700
2701 @vindex gnus-topic-indent-level
2702 Each sub-topic (and the groups in the sub-topics) will be indented with
2703 @code{gnus-topic-indent-level} times the topic level number of spaces.
2704 The default is 2.
2705
2706 @vindex gnus-topic-mode-hook
2707 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2708
2709 @vindex gnus-topic-display-empty-topics
2710 The @code{gnus-topic-display-empty-topics} says whether to display even
2711 topics that have no unread articles in them.  The default is @code{t}.
2712
2713
2714 @node Topic Commands
2715 @subsection Topic Commands
2716 @cindex topic commands
2717
2718 When the topic minor mode is turned on, a new @kbd{T} submap will be
2719 available.  In addition, a few of the standard keys change their
2720 definitions slightly.
2721
2722 @table @kbd
2723
2724 @item T n
2725 @kindex T n (Topic)
2726 @findex gnus-topic-create-topic
2727 Prompt for a new topic name and create it
2728 (@code{gnus-topic-create-topic}).
2729
2730 @item T m
2731 @kindex T m (Topic)
2732 @findex gnus-topic-move-group
2733 Move the current group to some other topic
2734 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2735 convention (@pxref{Process/Prefix}).
2736
2737 @item T j
2738 @kindex T j (Topic)
2739 @findex gnus-topic-jump-to-topic
2740 Go to a topic (@code{gnus-topic-jump-to-topic}).  
2741
2742 @item T c
2743 @kindex T c (Topic)
2744 @findex gnus-topic-copy-group
2745 Copy the current group to some other topic
2746 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2747 convention (@pxref{Process/Prefix}).
2748
2749 @item T D
2750 @kindex T D (Topic)
2751 @findex gnus-topic-remove-group
2752 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2753 This command is mainly useful if you have the same group in several
2754 topics and wish to remove it from one of the topics.  You may also
2755 remove a group from all topics, but in that case, Gnus will add it to
2756 the root topic the next time you start Gnus.  In fact, all new groups
2757 (which, naturally, don't belong to any topic) will show up in the root
2758 topic.
2759
2760 This command uses the process/prefix convention
2761 (@pxref{Process/Prefix}).
2762
2763 @item T M
2764 @kindex T M (Topic)
2765 @findex gnus-topic-move-matching
2766 Move all groups that match some regular expression to a topic
2767 (@code{gnus-topic-move-matching}).
2768
2769 @item T C
2770 @kindex T C (Topic)
2771 @findex gnus-topic-copy-matching
2772 Copy all groups that match some regular expression to a topic
2773 (@code{gnus-topic-copy-matching}).
2774
2775 @item T H
2776 @kindex T H (Topic)
2777 @findex gnus-topic-toggle-display-empty-topics
2778 Toggle hiding empty topics
2779 (@code{gnus-topic-toggle-display-empty-topics}).
2780
2781 @item T #
2782 @kindex T # (Topic)
2783 @findex gnus-topic-mark-topic
2784 Mark all groups in the current topic with the process mark
2785 (@code{gnus-topic-mark-topic}).
2786
2787 @item T M-#
2788 @kindex T M-# (Topic)
2789 @findex gnus-topic-unmark-topic
2790 Remove the process mark from all groups in the current topic
2791 (@code{gnus-topic-unmark-topic}).
2792
2793 @item T TAB
2794 @itemx TAB
2795 @kindex T TAB (Topic)
2796 @kindex TAB (Topic)
2797 @findex gnus-topic-indent
2798 ``Indent'' the current topic so that it becomes a sub-topic of the
2799 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2800 ``un-indent'' the topic instead.
2801
2802 @item M-TAB
2803 @kindex M-TAB (Topic)
2804 @findex gnus-topic-unindent
2805 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2806 parent of its current parent (@code{gnus-topic-unindent}).
2807
2808 @item RET
2809 @kindex RET (Topic)
2810 @findex gnus-topic-select-group
2811 @itemx SPACE
2812 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2813 When you perform this command on a group, you'll enter the group, as
2814 usual.  When done on a topic line, the topic will be folded (if it was
2815 visible) or unfolded (if it was folded already).  So it's basically a
2816 toggling command on topics.  In addition, if you give a numerical
2817 prefix, group on that level (and lower) will be displayed.
2818
2819 @item C-c C-x
2820 @kindex C-c C-x (Topic)
2821 @findex gnus-topic-expire-articles
2822 Run all expirable articles in the current group or topic through the expiry
2823 process (if any) (@code{gnus-topic-expire-articles}).
2824
2825 @item C-k
2826 @kindex C-k (Topic)
2827 @findex gnus-topic-kill-group
2828 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2829 topic will be removed along with the topic.
2830
2831 @item C-y
2832 @kindex C-y (Topic)
2833 @findex gnus-topic-yank-group
2834 Yank the previously killed group or topic
2835 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2836 before all groups.
2837
2838 @item T r
2839 @kindex T r (Topic)
2840 @findex gnus-topic-rename
2841 Rename a topic (@code{gnus-topic-rename}).
2842
2843 @item T DEL
2844 @kindex T DEL (Topic)
2845 @findex gnus-topic-delete
2846 Delete an empty topic (@code{gnus-topic-delete}).
2847
2848 @item A T
2849 @kindex A T (Topic)
2850 @findex gnus-topic-list-active
2851 List all groups that Gnus knows about in a topics-ified way
2852 (@code{gnus-topic-list-active}).
2853
2854 @item G p
2855 @kindex G p (Topic)
2856 @findex gnus-topic-edit-parameters
2857 @cindex group parameters
2858 @cindex topic parameters
2859 @cindex parameters
2860 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2861 @xref{Topic Parameters}.
2862
2863 @end table
2864
2865
2866 @node Topic Sorting
2867 @subsection Topic Sorting
2868 @cindex topic sorting
2869
2870 You can sort the groups in each topic individually with the following
2871 commands:
2872
2873
2874 @table @kbd
2875 @item T S a
2876 @kindex T S a (Topic)
2877 @findex gnus-topic-sort-groups-by-alphabet
2878 Sort the current topic alphabetically by group name
2879 (@code{gnus-topic-sort-groups-by-alphabet}).
2880
2881 @item T S u
2882 @kindex T S u (Topic)
2883 @findex gnus-topic-sort-groups-by-unread
2884 Sort the current topic by the number of unread articles
2885 (@code{gnus-topic-sort-groups-by-unread}).
2886
2887 @item T S l
2888 @kindex T S l (Topic)
2889 @findex gnus-topic-sort-groups-by-level
2890 Sort the current topic by group level
2891 (@code{gnus-topic-sort-groups-by-level}).
2892
2893 @item T S v
2894 @kindex T S v (Topic)
2895 @findex gnus-topic-sort-groups-by-score
2896 Sort the current topic by group score
2897 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2898
2899 @item T S r
2900 @kindex T S r (Topic)
2901 @findex gnus-topic-sort-groups-by-rank
2902 Sort the current topic by group rank
2903 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2904
2905 @item T S m
2906 @kindex T S m (Topic)
2907 @findex gnus-topic-sort-groups-by-method
2908 Sort the current topic alphabetically by backend name
2909 (@code{gnus-topic-sort-groups-by-method}).
2910
2911 @end table
2912
2913 @xref{Sorting Groups}, for more information about group sorting.
2914
2915
2916 @node Topic Topology
2917 @subsection Topic Topology
2918 @cindex topic topology
2919 @cindex topology
2920
2921 So, let's have a look at an example group buffer:
2922
2923 @example
2924 Gnus
2925   Emacs -- I wuw it!
2926      3: comp.emacs
2927      2: alt.religion.emacs
2928     Naughty Emacs
2929      452: alt.sex.emacs
2930        0: comp.talk.emacs.recovery
2931   Misc
2932      8: comp.binaries.fractals
2933     13: comp.sources.unix
2934 @end example
2935
2936 So, here we have one top-level topic (@samp{Gnus}), two topics under
2937 that, and one sub-topic under one of the sub-topics.  (There is always
2938 just one (1) top-level topic).  This topology can be expressed as
2939 follows:
2940
2941 @lisp
2942 (("Gnus" visible)
2943  (("Emacs -- I wuw it!" visible)
2944   (("Naughty Emacs" visible)))
2945  (("Misc" visible)))
2946 @end lisp
2947
2948 @vindex gnus-topic-topology
2949 This is in fact how the variable @code{gnus-topic-topology} would look
2950 for the display above.  That variable is saved in the @file{.newsrc.eld}
2951 file, and shouldn't be messed with manually---unless you really want
2952 to.  Since this variable is read from the @file{.newsrc.eld} file,
2953 setting it in any other startup files will have no effect.
2954
2955 This topology shows what topics are sub-topics of what topics (right),
2956 and which topics are visible.  Two settings are currently
2957 allowed---@code{visible} and @code{invisible}.
2958
2959
2960 @node Topic Parameters
2961 @subsection Topic Parameters
2962 @cindex topic parameters
2963
2964 All groups in a topic will inherit group parameters from the parent (and
2965 ancestor) topic parameters.  All valid group parameters are valid topic
2966 parameters (@pxref{Group Parameters}).
2967
2968 Group parameters (of course) override topic parameters, and topic
2969 parameters in sub-topics override topic parameters in super-topics.  You
2970 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2971 verb, although you may feel free to disagree with me here.)
2972
2973 @example
2974 Gnus
2975   Emacs
2976      3: comp.emacs
2977      2: alt.religion.emacs
2978    452: alt.sex.emacs
2979     Relief
2980      452: alt.sex.emacs
2981        0: comp.talk.emacs.recovery
2982   Misc
2983      8: comp.binaries.fractals
2984     13: comp.sources.unix
2985    452: alt.sex.emacs
2986 @end example
2987
2988 The @samp{Emacs} topic has the topic parameter @code{(score-file
2989 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2990 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2991 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2992 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2993 . "religion.SCORE")}.
2994
2995 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2996 will get the @file{relief.SCORE} home score file.  If you enter the same
2997 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2998 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2999 get the @file{religion.SCORE} home score file.
3000
3001 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
3002 there are some problems, especially with the @code{total-expiry}
3003 parameter.  Say you have a mail group in two topics; one with
3004 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
3005 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
3006 of these topics you mean to expire articles from, so anything may
3007 happen.  In fact, I hereby declare that it is @dfn{undefined} what
3008 happens.  You just have to be careful if you do stuff like that.
3009
3010
3011 @node Misc Group Stuff
3012 @section Misc Group Stuff
3013
3014 @menu
3015 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
3016 * Group Information::     Information and help on groups and Gnus.
3017 * Group Timestamp::       Making Gnus keep track of when you last read a group.
3018 * File Commands::         Reading and writing the Gnus files.
3019 @end menu
3020
3021 @table @kbd
3022
3023 @item ^
3024 @kindex ^ (Group)
3025 @findex gnus-group-enter-server-mode
3026 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3027 @xref{The Server Buffer}.
3028
3029 @item a
3030 @kindex a (Group)
3031 @findex gnus-group-post-news
3032 Post an article to a group (@code{gnus-group-post-news}).  If given a
3033 prefix, the current group name will be used as the default.
3034
3035 @item m
3036 @kindex m (Group)
3037 @findex gnus-group-mail
3038 Mail a message somewhere (@code{gnus-group-mail}).
3039
3040 @end table
3041
3042 Variables for the group buffer:
3043
3044 @table @code
3045
3046 @item gnus-group-mode-hook
3047 @vindex gnus-group-mode-hook
3048 is called after the group buffer has been
3049 created.
3050
3051 @item gnus-group-prepare-hook
3052 @vindex gnus-group-prepare-hook
3053 is called after the group buffer is
3054 generated.  It may be used to modify the buffer in some strange,
3055 unnatural way.
3056
3057 @item gnus-group-prepared-hook
3058 @vindex gnus-group-prepare-hook
3059 is called as the very last thing after the group buffer has been
3060 generated.  It may be used to move point around, for instance.
3061
3062 @item gnus-permanently-visible-groups
3063 @vindex gnus-permanently-visible-groups
3064 Groups matching this regexp will always be listed in the group buffer,
3065 whether they are empty or not.
3066
3067 @end table
3068
3069
3070 @node Scanning New Messages
3071 @subsection Scanning New Messages
3072 @cindex new messages
3073 @cindex scanning new news
3074
3075 @table @kbd
3076
3077 @item g
3078 @kindex g (Group)
3079 @findex gnus-group-get-new-news
3080 @c @icon{gnus-group-get-new-news}
3081 Check the server(s) for new articles.  If the numerical prefix is used,
3082 this command will check only groups of level @var{arg} and lower
3083 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
3084 command will force a total re-reading of the active file(s) from the
3085 backend(s).
3086
3087 @item M-g
3088 @kindex M-g (Group)
3089 @findex gnus-group-get-new-news-this-group
3090 @vindex gnus-goto-next-group-when-activating
3091 @c @icon{gnus-group-get-new-news-this-group}
3092 Check whether new articles have arrived in the current group
3093 (@code{gnus-group-get-new-news-this-group}).
3094 @code{gnus-goto-next-group-when-activating} says whether this command is
3095 to move point to the next group or not.  It is @code{t} by default.
3096
3097 @findex gnus-activate-all-groups
3098 @cindex activating groups
3099 @item C-c M-g
3100 @kindex C-c M-g (Group)
3101 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3102
3103 @item R
3104 @kindex R (Group)
3105 @cindex restarting
3106 @findex gnus-group-restart
3107 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3108 file(s), closes the connection to all servers, clears up all run-time
3109 Gnus variables, and then starts Gnus all over again.
3110
3111 @end table
3112
3113 @vindex gnus-get-new-news-hook
3114 @code{gnus-get-new-news-hook} is run just before checking for new news.
3115
3116 @vindex gnus-after-getting-new-news-hook
3117 @code{gnus-after-getting-new-news-hook} is run after checking for new
3118 news.
3119
3120
3121 @node Group Information
3122 @subsection Group Information
3123 @cindex group information
3124 @cindex information on groups
3125
3126 @table @kbd
3127
3128
3129 @item H f
3130 @kindex H f (Group)
3131 @findex gnus-group-fetch-faq
3132 @vindex gnus-group-faq-directory
3133 @cindex FAQ
3134 @cindex ange-ftp
3135 Try to fetch the FAQ for the current group
3136 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3137 @code{gnus-group-faq-directory}, which is usually a directory on a
3138 remote machine.  This variable can also be a list of directories.  In
3139 that case, giving a prefix to this command will allow you to choose
3140 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3141 for fetching the file.
3142
3143 If fetching from the first site is unsuccessful, Gnus will attempt to go
3144 through @code{gnus-group-faq-directory} and try to open them one by one.
3145
3146 @item H d
3147 @itemx C-c C-d
3148 @c @icon{gnus-group-describe-group}
3149 @kindex H d (Group)
3150 @kindex C-c C-d (Group)
3151 @cindex describing groups
3152 @cindex group description
3153 @findex gnus-group-describe-group
3154 Describe the current group (@code{gnus-group-describe-group}).  If given
3155 a prefix, force Gnus to re-read the description from the server.
3156
3157 @item M-d
3158 @kindex M-d (Group)
3159 @findex gnus-group-describe-all-groups
3160 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3161 prefix, force Gnus to re-read the description file from the server.
3162
3163 @item H v
3164 @itemx V
3165 @kindex V (Group)
3166 @kindex H v (Group)
3167 @cindex version
3168 @findex gnus-version
3169 Display current Gnus version numbers (@code{gnus-version}).
3170
3171 @item ?
3172 @kindex ? (Group)
3173 @findex gnus-group-describe-briefly
3174 Give a very short help message (@code{gnus-group-describe-briefly}).
3175
3176 @item C-c C-i
3177 @kindex C-c C-i (Group)
3178 @cindex info
3179 @cindex manual
3180 @findex gnus-info-find-node
3181 Go to the Gnus info node (@code{gnus-info-find-node}).
3182 @end table
3183
3184
3185 @node Group Timestamp
3186 @subsection Group Timestamp
3187 @cindex timestamps
3188 @cindex group timestamps
3189
3190 It can be convenient to let Gnus keep track of when you last read a
3191 group.  To set the ball rolling, you should add
3192 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3193
3194 @lisp
3195 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3196 @end lisp
3197
3198 After doing this, each time you enter a group, it'll be recorded.
3199
3200 This information can be displayed in various ways---the easiest is to
3201 use the @samp{%d} spec in the group line format:
3202
3203 @lisp
3204 (setq gnus-group-line-format
3205       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3206 @end lisp
3207
3208 This will result in lines looking like:
3209
3210 @example
3211 *        0: mail.ding                                19961002T012943
3212          0: custom                                   19961002T012713
3213 @end example
3214
3215 As you can see, the date is displayed in compact ISO 8601 format.  This
3216 may be a bit too much, so to just display the date, you could say
3217 something like:
3218
3219 @lisp
3220 (setq gnus-group-line-format
3221       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3222 @end lisp
3223
3224
3225 @node File Commands
3226 @subsection File Commands
3227 @cindex file commands
3228
3229 @table @kbd
3230
3231 @item r
3232 @kindex r (Group)
3233 @findex gnus-group-read-init-file
3234 @vindex gnus-init-file
3235 @cindex reading init file
3236 Re-read the init file (@code{gnus-init-file}, which defaults to
3237 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3238
3239 @item s
3240 @kindex s (Group)
3241 @findex gnus-group-save-newsrc
3242 @cindex saving .newsrc
3243 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3244 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3245 file(s) whether Gnus thinks it is necessary or not.
3246
3247 @c @item Z
3248 @c @kindex Z (Group)
3249 @c @findex gnus-group-clear-dribble
3250 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3251
3252 @end table
3253
3254
3255 @node The Summary Buffer
3256 @chapter The Summary Buffer
3257 @cindex summary buffer
3258
3259 A line for each article is displayed in the summary buffer.  You can
3260 move around, read articles, post articles and reply to articles.
3261
3262 The most common way to a summary buffer is to select a group from the
3263 group buffer (@pxref{Selecting a Group}).
3264
3265 You can have as many summary buffers open as you wish.
3266
3267 @menu
3268 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3269 * Summary Maneuvering::         Moving around the summary buffer.
3270 * Choosing Articles::           Reading articles.
3271 * Paging the Article::          Scrolling the current article.
3272 * Reply Followup and Post::     Posting articles.
3273 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3274 * Marking Articles::            Marking articles as read, expirable, etc.
3275 * Limiting::                    You can limit the summary buffer.
3276 * Threading::                   How threads are made.
3277 * Sorting::                     How articles and threads are sorted.
3278 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3279 * Article Caching::             You may store articles in a cache.
3280 * Persistent Articles::         Making articles expiry-resistant.
3281 * Article Backlog::             Having already read articles hang around.
3282 * Saving Articles::             Ways of customizing article saving.
3283 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3284 * Article Treatment::           The article buffer can be mangled at will.
3285 * MIME Commands::               Doing MIMEy things with the articles.
3286 * Charsets::                    Character set issues.
3287 * Article Commands::            Doing various things with the article buffer.
3288 * Summary Sorting::             Sorting the summary buffer in various ways.
3289 * Finding the Parent::          No child support? Get the parent.
3290 * Alternative Approaches::      Reading using non-default summaries.
3291 * Tree Display::                A more visual display of threads.
3292 * Mail Group Commands::         Some commands can only be used in mail groups.
3293 * Various Summary Stuff::       What didn't fit anywhere else.
3294 * Exiting the Summary Buffer::  Returning to the Group buffer.
3295 * Crosspost Handling::          How crossposted articles are dealt with.
3296 * Duplicate Suppression::       An alternative when crosspost handling fails.
3297 @end menu
3298
3299
3300 @node Summary Buffer Format
3301 @section Summary Buffer Format
3302 @cindex summary buffer format
3303
3304 @iftex
3305 @iflatex
3306 \gnusfigure{The Summary Buffer}{180}{
3307 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3308 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3309 }
3310 @end iflatex
3311 @end iftex
3312
3313 @menu
3314 * Summary Buffer Lines::     You can specify how summary lines should look.
3315 * To From Newsgroups::       How to not display your own name.
3316 * Summary Buffer Mode Line:: You can say how the mode line should look.
3317 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3318 @end menu
3319
3320 @findex mail-extract-address-components
3321 @findex gnus-extract-address-components
3322 @vindex gnus-extract-address-components
3323 Gnus will use the value of the @code{gnus-extract-address-components}
3324 variable as a function for getting the name and address parts of a
3325 @code{From} header.  Two pre-defined functions exist:
3326 @code{gnus-extract-address-components}, which is the default, quite
3327 fast, and too simplistic solution; and
3328 @code{mail-extract-address-components}, which works very nicely, but is
3329 slower.  The default function will return the wrong answer in 5% of the
3330 cases.  If this is unacceptable to you, use the other function instead:
3331
3332 @lisp
3333 (setq gnus-extract-address-components
3334       'mail-extract-address-components)
3335 @end lisp
3336
3337 @vindex gnus-summary-same-subject
3338 @code{gnus-summary-same-subject} is a string indicating that the current
3339 article has the same subject as the previous.  This string will be used
3340 with those specs that require it.  The default is @code{""}.
3341
3342
3343 @node Summary Buffer Lines
3344 @subsection Summary Buffer Lines
3345
3346 @vindex gnus-summary-line-format
3347 You can change the format of the lines in the summary buffer by changing
3348 the @code{gnus-summary-line-format} variable.  It works along the same
3349 lines as a normal @code{format} string, with some extensions
3350 (@pxref{Formatting Variables}).
3351
3352 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3353
3354 The following format specification characters are understood:
3355
3356 @table @samp
3357 @item N
3358 Article number.
3359 @item S
3360 Subject string. List identifiers stripped, @code{gnus-list-identifies}. @xref{Article Hiding}.
3361 @item s
3362 Subject if the article is the root of the thread or the previous article
3363 had a different subject, @code{gnus-summary-same-subject} otherwise.
3364 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3365 @item F
3366 Full @code{From} header.
3367 @item n
3368 The name (from the @code{From} header).
3369 @item f
3370 The name, code @code{To} header or the @code{Newsgroups} header
3371 (@pxref{To From Newsgroups}).
3372 @item a
3373 The name (from the @code{From} header).  This differs from the @code{n}
3374 spec in that it uses the function designated by the
3375 @code{gnus-extract-address-components} variable, which is slower, but
3376 may be more thorough.
3377 @item A
3378 The address (from the @code{From} header).  This works the same way as
3379 the @code{a} spec.
3380 @item L
3381 Number of lines in the article.
3382 @item c
3383 Number of characters in the article.
3384 @item I
3385 Indentation based on thread level (@pxref{Customizing Threading}).
3386 @item T
3387 Nothing if the article is a root and lots of spaces if it isn't (it
3388 pushes everything after it off the screen).
3389 @item [
3390 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3391 for adopted articles (@pxref{Customizing Threading}).
3392 @item ]
3393 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3394 for adopted articles.
3395 @item >
3396 One space for each thread level.
3397 @item <
3398 Twenty minus thread level spaces.
3399 @item U
3400 Unread.
3401
3402 @item R
3403 This misleadingly named specifier is the @dfn{secondary mark}.  This
3404 mark will say whether the article has been replied to, has been cached,
3405 or has been saved.
3406
3407 @item i
3408 Score as a number (@pxref{Scoring}).
3409 @item z
3410 @vindex gnus-summary-zcore-fuzz
3411 Zcore, @samp{+} if above the default level and @samp{-} if below the
3412 default level.  If the difference between
3413 @code{gnus-summary-default-score} and the score is less than
3414 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3415 @item V
3416 Total thread score.
3417 @item x
3418 @code{Xref}.
3419 @item D
3420 @code{Date}.
3421 @item d
3422 The @code{Date} in @code{DD-MMM} format.
3423 @item o
3424 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3425 @item M
3426 @code{Message-ID}.
3427 @item r
3428 @code{References}.
3429 @item t
3430 Number of articles in the current sub-thread.  Using this spec will slow
3431 down summary buffer generation somewhat.
3432 @item e
3433 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3434 article has any children.
3435 @item P
3436 The line number.
3437 @item O
3438 Download mark.
3439 @item u
3440 User defined specifier.  The next character in the format string should
3441 be a letter.  Gnus will call the function
3442 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3443 following @samp{%u}.  The function will be passed the current header as
3444 argument.  The function should return a string, which will be inserted
3445 into the summary just like information from any other summary specifier.
3446 @end table
3447
3448 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3449 have to be handled with care.  For reasons of efficiency, Gnus will
3450 compute what column these characters will end up in, and ``hard-code''
3451 that.  This means that it is invalid to have these specs after a
3452 variable-length spec.  Well, you might not be arrested, but your summary
3453 buffer will look strange, which is bad enough.
3454
3455 The smart choice is to have these specs as far to the left as possible.
3456 (Isn't that the case with everything, though?  But I digress.)
3457
3458 This restriction may disappear in later versions of Gnus.
3459
3460
3461 @node To From Newsgroups
3462 @subsection To From Newsgroups
3463 @cindex To
3464 @cindex Newsgroups
3465
3466 In some groups (particularly in archive groups), the @code{From} header
3467 isn't very interesting, since all the articles there are written by
3468 you.  To display the information in the @code{To} or @code{Newsgroups}
3469 headers instead, you need to decide three things: What information to
3470 gather; where to display it; and when to display it.
3471
3472 @enumerate
3473 @item
3474 @vindex gnus-extra-headers
3475 The reading of extra header information is controlled by the
3476 @code{gnus-extra-headers}.  This is a list of header symbols.  For
3477 instance:
3478
3479 @lisp
3480 (setq gnus-extra-headers
3481       '(To Newsgroups X-Newsreader))
3482 @end lisp
3483
3484 This will result in Gnus trying to obtain these three headers, and
3485 storing it in header structures for later easy retrieval.
3486
3487 @item
3488 @findex gnus-extra-header
3489 The value of these extra headers can be accessed via the
3490 @code{gnus-extra-header} function.  Here's a format line spec that will
3491 access the @code{X-Newsreader} header:
3492
3493 @example
3494 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3495 @end example
3496
3497 @item
3498 @vindex gnus-ignored-from-addresses
3499 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3500 summary line spec returns the @code{To}, @code{Newsreader} or
3501 @code{From} header.  If this regexp matches the contents of the
3502 @code{From} header, the value of the @code{To} or @code{Newsreader}
3503 headers are used instead.
3504
3505 @end enumerate
3506
3507 @vindex nnmail-extra-headers
3508 A related variable is @code{nnmail-extra-headers}, which controls when
3509 to include extra headers when generating overview (@sc{nov}) files.  If
3510 you have old overview files, you should regenerate them after changing
3511 this variable.
3512
3513 @vindex gnus-summary-line-format
3514 You also have to instruct Gnus to display the data by changing the
3515 @code{%n} spec to the @code{%f} spec in the
3516 @code{gnus-summary-line-format} variable.
3517
3518 In summary, you'd typically do something like the following:
3519
3520 @lisp
3521 (setq gnus-extra-headers
3522       '(To Newsgroups))
3523 (setq nnmail-extra-headers gnus-extra-headers)
3524 (setq gnus-summary-line-format
3525       "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3526 (setq gnus-ignored-from-addresses
3527       "Your Name Here")
3528 @end lisp
3529
3530 Now, this is mostly useful for mail groups, where you have control over
3531 the @sc{nov} files that are created.  However, if you can persuade your
3532 nntp admin to add:
3533
3534 @example
3535 Newsgroups:full
3536 @end example
3537
3538 to the end of her @file{overview.fmt} file, then you can use that just
3539 as you would the extra headers from the mail groups.
3540
3541
3542 @node Summary Buffer Mode Line
3543 @subsection Summary Buffer Mode Line
3544
3545 @vindex gnus-summary-mode-line-format
3546 You can also change the format of the summary mode bar (@pxref{Mode Line
3547 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
3548 like.  The default is @samp{Gnus: %%b [%A] %Z}.
3549
3550 Here are the elements you can play with:
3551
3552 @table @samp
3553 @item G
3554 Group name.
3555 @item p
3556 Unprefixed group name.
3557 @item A
3558 Current article number.
3559 @item z
3560 Current article score.
3561 @item V
3562 Gnus version.
3563 @item U
3564 Number of unread articles in this group.
3565 @item e
3566 Number of unread articles in this group that aren't displayed in the
3567 summary buffer.
3568 @item Z
3569 A string with the number of unread and unselected articles represented
3570 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3571 articles, and just as @samp{<%U more>} if there are just unread articles
3572 and no unselected ones.
3573 @item g
3574 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3575 shortened to @samp{r.a.anime}.
3576 @item S
3577 Subject of the current article.
3578 @item u
3579 User-defined spec (@pxref{User-Defined Specs}).
3580 @item s
3581 Name of the current score file (@pxref{Scoring}).
3582 @item d
3583 Number of dormant articles (@pxref{Unread Articles}).
3584 @item t
3585 Number of ticked articles (@pxref{Unread Articles}).
3586 @item r
3587 Number of articles that have been marked as read in this session.
3588 @item E
3589 Number of articles expunged by the score files.
3590 @end table
3591
3592
3593 @node Summary Highlighting
3594 @subsection Summary Highlighting
3595
3596 @table @code
3597
3598 @item gnus-visual-mark-article-hook
3599 @vindex gnus-visual-mark-article-hook
3600 This hook is run after selecting an article.  It is meant to be used for
3601 highlighting the article in some way.  It is not run if
3602 @code{gnus-visual} is @code{nil}.
3603
3604 @item gnus-summary-update-hook
3605 @vindex gnus-summary-update-hook
3606 This hook is called when a summary line is changed.  It is not run if
3607 @code{gnus-visual} is @code{nil}.
3608
3609 @item gnus-summary-selected-face
3610 @vindex gnus-summary-selected-face
3611 This is the face (or @dfn{font} as some people call it) used to
3612 highlight the current article in the summary buffer.
3613
3614 @item gnus-summary-highlight
3615 @vindex gnus-summary-highlight
3616 Summary lines are highlighted according to this variable, which is a
3617 list where the elements are of the format @code{(@var{form}
3618 . @var{face})}.  If you would, for instance, like ticked articles to be
3619 italic and high-scored articles to be bold, you could set this variable
3620 to something like
3621 @lisp
3622 (((eq mark gnus-ticked-mark) . italic)
3623  ((> score default) . bold))
3624 @end lisp
3625 As you may have guessed, if @var{form} returns a non-@code{nil} value,
3626 @var{face} will be applied to the line.
3627 @end table
3628
3629
3630 @node Summary Maneuvering
3631 @section Summary Maneuvering
3632 @cindex summary movement
3633
3634 All the straight movement commands understand the numeric prefix and
3635 behave pretty much as you'd expect.
3636
3637 None of these commands select articles.
3638
3639 @table @kbd
3640 @item G M-n
3641 @itemx M-n
3642 @kindex M-n (Summary)
3643 @kindex G M-n (Summary)
3644 @findex gnus-summary-next-unread-subject
3645 Go to the next summary line of an unread article
3646 (@code{gnus-summary-next-unread-subject}).
3647
3648 @item G M-p
3649 @itemx M-p
3650 @kindex M-p (Summary)
3651 @kindex G M-p (Summary)
3652 @findex gnus-summary-prev-unread-subject
3653 Go to the previous summary line of an unread article
3654 (@code{gnus-summary-prev-unread-subject}).
3655
3656 @item G j
3657 @itemx j
3658 @kindex j (Summary)
3659 @kindex G j (Summary)
3660 @findex gnus-summary-goto-article
3661 Ask for an article number or @code{Message-ID}, and then go to that
3662 article (@code{gnus-summary-goto-article}).
3663
3664 @item G g
3665 @kindex G g (Summary)
3666 @findex gnus-summary-goto-subject
3667 Ask for an article number and then go to the summary line of that article
3668 without displaying the article (@code{gnus-summary-goto-subject}).
3669 @end table
3670
3671 If Gnus asks you to press a key to confirm going to the next group, you
3672 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3673 buffer, searching for the next group to read without actually returning
3674 to the group buffer.
3675
3676 Variables related to summary movement:
3677
3678 @table @code
3679
3680 @vindex gnus-auto-select-next
3681 @item gnus-auto-select-next
3682 If you issue one of the movement commands (like @kbd{n}) and there are
3683 no more unread articles after the current one, Gnus will offer to go to
3684 the next group.  If this variable is @code{t} and the next group is
3685 empty, Gnus will exit summary mode and return to the group buffer.  If
3686 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3687 next group, no matter whether it has any unread articles or not.  As a
3688 special case, if this variable is @code{quietly}, Gnus will select the
3689 next group without asking for confirmation.  If this variable is
3690 @code{almost-quietly}, the same will happen only if you are located on
3691 the last article in the group.  Finally, if this variable is
3692 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3693 without confirmation.  Also @pxref{Group Levels}.
3694
3695 @item gnus-auto-select-same
3696 @vindex gnus-auto-select-same
3697 If non-@code{nil}, all the movement commands will try to go to the next
3698 article with the same subject as the current.  (@dfn{Same} here might
3699 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3700 for details (@pxref{Customizing Threading}).)  If there are no more
3701 articles with the same subject, go to the first unread article.
3702
3703 This variable is not particularly useful if you use a threaded display.
3704
3705 @item gnus-summary-check-current
3706 @vindex gnus-summary-check-current
3707 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3708 to the next (or previous) article if the current article is unread.
3709 Instead, they will choose the current article.
3710
3711 @item gnus-auto-center-summary
3712 @vindex gnus-auto-center-summary
3713 If non-@code{nil}, Gnus will keep the point in the summary buffer
3714 centered at all times.  This makes things quite tidy, but if you have a
3715 slow network connection, or simply do not like this un-Emacsism, you can
3716 set this variable to @code{nil} to get the normal Emacs scrolling
3717 action.  This will also inhibit horizontal re-centering of the summary
3718 buffer, which might make it more inconvenient to read extremely long
3719 threads.
3720
3721 This variable can also be a number.  In that case, center the window at
3722 the given number of lines from the top.
3723
3724 @end table
3725
3726
3727 @node Choosing Articles
3728 @section Choosing Articles
3729 @cindex selecting articles
3730
3731 @menu
3732 * Choosing Commands::        Commands for choosing articles.
3733 * Choosing Variables::       Variables that influence these commands.
3734 @end menu
3735
3736
3737 @node Choosing Commands
3738 @subsection Choosing Commands
3739
3740 None of the following movement commands understand the numeric prefix,
3741 and they all select and display an article.
3742
3743 @table @kbd
3744 @item SPACE
3745 @kindex SPACE (Summary)
3746 @findex gnus-summary-next-page
3747 Select the current article, or, if that one's read already, the next
3748 unread article (@code{gnus-summary-next-page}).
3749
3750 @item G n
3751 @itemx n
3752 @kindex n (Summary)
3753 @kindex G n (Summary)
3754 @findex gnus-summary-next-unread-article
3755 @c @icon{gnus-summary-next-unread}
3756 Go to next unread article (@code{gnus-summary-next-unread-article}).
3757
3758 @item G p
3759 @itemx p
3760 @kindex p (Summary)
3761 @findex gnus-summary-prev-unread-article
3762 @c @icon{gnus-summary-prev-unread}
3763 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3764
3765 @item G N
3766 @itemx N
3767 @kindex N (Summary)
3768 @kindex G N (Summary)
3769 @findex gnus-summary-next-article
3770 Go to the next article (@code{gnus-summary-next-article}).
3771
3772 @item G P
3773 @itemx P
3774 @kindex P (Summary)
3775 @kindex G P (Summary)
3776 @findex gnus-summary-prev-article
3777 Go to the previous article (@code{gnus-summary-prev-article}).
3778
3779 @item G C-n
3780 @kindex G C-n (Summary)
3781 @findex gnus-summary-next-same-subject
3782 Go to the next article with the same subject
3783 (@code{gnus-summary-next-same-subject}).
3784
3785 @item G C-p
3786 @kindex G C-p (Summary)
3787 @findex gnus-summary-prev-same-subject
3788 Go to the previous article with the same subject
3789 (@code{gnus-summary-prev-same-subject}).
3790
3791 @item G f
3792 @itemx .
3793 @kindex G f  (Summary)
3794 @kindex .  (Summary)
3795 @findex gnus-summary-first-unread-article
3796 Go to the first unread article
3797 (@code{gnus-summary-first-unread-article}).
3798
3799 @item G b
3800 @itemx ,
3801 @kindex G b (Summary)
3802 @kindex , (Summary)
3803 @findex gnus-summary-best-unread-article
3804 Go to the article with the highest score
3805 (@code{gnus-summary-best-unread-article}).
3806
3807 @item G l
3808 @itemx l
3809 @kindex l (Summary)
3810 @kindex G l (Summary)
3811 @findex gnus-summary-goto-last-article
3812 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3813
3814 @item G o
3815 @kindex G o (Summary)
3816 @findex gnus-summary-pop-article
3817 @cindex history
3818 @cindex article history
3819 Pop an article off the summary history and go to this article
3820 (@code{gnus-summary-pop-article}).  This command differs from the
3821 command above in that you can pop as many previous articles off the
3822 history as you like, while @kbd{l} toggles the two last read articles.
3823 For a somewhat related issue (if you use these commands a lot),
3824 @pxref{Article Backlog}.
3825 @end table
3826
3827
3828 @node Choosing Variables
3829 @subsection Choosing Variables
3830
3831 Some variables relevant for moving and selecting articles:
3832
3833 @table @code
3834 @item gnus-auto-extend-newsgroup
3835 @vindex gnus-auto-extend-newsgroup
3836 All the movement commands will try to go to the previous (or next)
3837 article, even if that article isn't displayed in the Summary buffer if
3838 this variable is non-@code{nil}.  Gnus will then fetch the article from
3839 the server and display it in the article buffer.
3840
3841 @item gnus-select-article-hook
3842 @vindex gnus-select-article-hook
3843 This hook is called whenever an article is selected.  By default it
3844 exposes any threads hidden under the selected article.
3845
3846 @item gnus-mark-article-hook
3847 @vindex gnus-mark-article-hook
3848 @findex gnus-summary-mark-unread-as-read
3849 @findex gnus-summary-mark-read-and-unread-as-read
3850 @findex gnus-unread-mark
3851 This hook is called whenever an article is selected.  It is intended to
3852 be used for marking articles as read.  The default value is
3853 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3854 mark of almost any article you read to @code{gnus-unread-mark}.  The
3855 only articles not affected by this function are ticked, dormant, and
3856 expirable articles.  If you'd instead like to just have unread articles
3857 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3858 instead.  It will leave marks like @code{gnus-low-score-mark},
3859 @code{gnus-del-mark} (and so on) alone.
3860
3861 @end table
3862
3863
3864 @node Paging the Article
3865 @section Scrolling the Article
3866 @cindex article scrolling
3867
3868 @table @kbd
3869
3870 @item SPACE
3871 @kindex SPACE (Summary)
3872 @findex gnus-summary-next-page
3873 Pressing @kbd{SPACE} will scroll the current article forward one page,
3874 or, if you have come to the end of the current article, will choose the
3875 next article (@code{gnus-summary-next-page}).
3876
3877 @item DEL
3878 @kindex DEL (Summary)
3879 @findex gnus-summary-prev-page
3880 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3881
3882 @item RET
3883 @kindex RET (Summary)
3884 @findex gnus-summary-scroll-up
3885 Scroll the current article one line forward
3886 (@code{gnus-summary-scroll-up}).
3887
3888 @item M-RET
3889 @kindex M-RET (Summary)
3890 @findex gnus-summary-scroll-down
3891 Scroll the current article one line backward
3892 (@code{gnus-summary-scroll-down}).
3893
3894 @item A g
3895 @itemx g
3896 @kindex A g (Summary)
3897 @kindex g (Summary)
3898 @findex gnus-summary-show-article
3899 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3900 given a prefix, fetch the current article, but don't run any of the
3901 article treatment functions.  This will give you a ``raw'' article, just
3902 the way it came from the server.
3903
3904 @item A <
3905 @itemx <
3906 @kindex < (Summary)
3907 @kindex A < (Summary)
3908 @findex gnus-summary-beginning-of-article
3909 Scroll to the beginning of the article
3910 (@code{gnus-summary-beginning-of-article}).
3911
3912 @item A >
3913 @itemx >
3914 @kindex > (Summary)
3915 @kindex A > (Summary)
3916 @findex gnus-summary-end-of-article
3917 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3918
3919 @item A s
3920 @itemx s
3921 @kindex A s (Summary)
3922 @kindex s (Summary)
3923 @findex gnus-summary-isearch-article
3924 Perform an isearch in the article buffer
3925 (@code{gnus-summary-isearch-article}).
3926
3927 @item h
3928 @kindex h (Summary)
3929 @findex gnus-summary-select-article-buffer
3930 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3931
3932 @end table
3933
3934
3935 @node Reply Followup and Post
3936 @section Reply, Followup and Post
3937
3938 @menu
3939 * Summary Mail Commands::            Sending mail.
3940 * Summary Post Commands::            Sending news.
3941 @end menu
3942
3943
3944 @node Summary Mail Commands
3945 @subsection Summary Mail Commands
3946 @cindex mail
3947 @cindex composing mail
3948
3949 Commands for composing a mail message:
3950
3951 @table @kbd
3952
3953 @item S r
3954 @itemx r
3955 @kindex S r (Summary)
3956 @kindex r (Summary)
3957 @findex gnus-summary-reply
3958 @c @icon{gnus-summary-mail-reply}
3959 @c @icon{gnus-summary-reply}
3960 Mail a reply to the author of the current article
3961 (@code{gnus-summary-reply}).
3962
3963 @item S R
3964 @itemx R
3965 @kindex R (Summary)
3966 @kindex S R (Summary)
3967 @findex gnus-summary-reply-with-original
3968 @c @icon{gnus-summary-reply-with-original}
3969 Mail a reply to the author of the current article and include the
3970 original message (@code{gnus-summary-reply-with-original}).  This
3971 command uses the process/prefix convention.
3972
3973 @item S w
3974 @kindex S w (Summary)
3975 @findex gnus-summary-wide-reply
3976 Mail a wide reply to the author of the current article
3977 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3978 goes out to all people listed in the @code{To}, @code{From} (or
3979 @code{Reply-to}) and @code{Cc} headers.
3980
3981 @item S W
3982 @kindex S W (Summary)
3983 @findex gnus-summary-wide-reply-with-original
3984 Mail a wide reply to the current article and include the original
3985 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
3986 the process/prefix convention.
3987
3988 @item S o m
3989 @kindex S o m (Summary)
3990 @findex gnus-summary-mail-forward
3991 @c @icon{gnus-summary-mail-forward}
3992 Forward the current article to some other person
3993 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3994 headers of the forwarded article.
3995
3996 @item S m
3997 @itemx m
3998 @kindex m (Summary)
3999 @kindex S m (Summary)
4000 @findex gnus-summary-mail-other-window
4001 @c @icon{gnus-summary-mail-originate}
4002 Send a mail to some other person
4003 (@code{gnus-summary-mail-other-window}).
4004
4005 @item S D b
4006 @kindex S D b (Summary)
4007 @findex gnus-summary-resend-bounced-mail
4008 @cindex bouncing mail
4009 If you have sent a mail, but the mail was bounced back to you for some
4010 reason (wrong address, transient failure), you can use this command to
4011 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
4012 will be popped into a mail buffer where you can edit the headers before
4013 sending the mail off again.  If you give a prefix to this command, and
4014 the bounced mail is a reply to some other mail, Gnus will try to fetch
4015 that mail and display it for easy perusal of its headers.  This might
4016 very well fail, though.
4017
4018 @item S D r
4019 @kindex S D r (Summary)
4020 @findex gnus-summary-resend-message
4021 Not to be confused with the previous command,
4022 @code{gnus-summary-resend-message} will prompt you for an address to
4023 send the current message off to, and then send it to that place.  The
4024 headers of the message won't be altered---but lots of headers that say
4025 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
4026 means that you actually send a mail to someone that has a @code{To}
4027 header that (probably) points to yourself.  This will confuse people.
4028 So, natcherly you'll only do that if you're really eVIl.
4029
4030 This command is mainly used if you have several accounts and want to
4031 ship a mail to a different account of yours.  (If you're both
4032 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4033 to the @code{root} account, you may want to resend it to
4034 @code{postmaster}.  Ordnung mu\e-Aß sein!\e$)A
4035
4036 This command understands the process/prefix convention
4037 (@pxref{Process/Prefix}).
4038
4039 @item S O m
4040 @kindex S O m (Summary)
4041 @findex gnus-uu-digest-mail-forward
4042 Digest the current series (@pxref{Decoding Articles}) and forward the
4043 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
4044 uses the process/prefix convention (@pxref{Process/Prefix}).
4045
4046 @item S M-c
4047 @kindex S M-c (Summary)
4048 @findex gnus-summary-mail-crosspost-complaint
4049 @cindex crossposting
4050 @cindex excessive crossposting
4051 Send a complaint about excessive crossposting to the author of the
4052 current article (@code{gnus-summary-mail-crosspost-complaint}).
4053
4054 @findex gnus-crosspost-complaint
4055 This command is provided as a way to fight back against the current
4056 crossposting pandemic that's sweeping Usenet.  It will compose a reply
4057 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
4058 command understands the process/prefix convention
4059 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4060
4061 @end table
4062
4063 Also @pxref{(message)Header Commands} for more information.
4064
4065
4066 @node Summary Post Commands
4067 @subsection Summary Post Commands
4068 @cindex post
4069 @cindex composing news
4070
4071 Commands for posting a news article:
4072
4073 @table @kbd
4074 @item S p
4075 @itemx a
4076 @kindex a (Summary)
4077 @kindex S p (Summary)
4078 @findex gnus-summary-post-news
4079 @c @icon{gnus-summary-post-news}
4080 Post an article to the current group
4081 (@code{gnus-summary-post-news}).
4082
4083 @item S f
4084 @itemx f
4085 @kindex f (Summary)
4086 @kindex S f (Summary)
4087 @findex gnus-summary-followup
4088 @c @icon{gnus-summary-followup}
4089 Post a followup to the current article (@code{gnus-summary-followup}).
4090
4091 @item S F
4092 @itemx F
4093 @kindex S F (Summary)
4094 @kindex F (Summary)
4095 @c @icon{gnus-summary-followup-with-original}
4096 @findex gnus-summary-followup-with-original
4097 Post a followup to the current article and include the original message
4098 (@code{gnus-summary-followup-with-original}).   This command uses the
4099 process/prefix convention.
4100
4101 @item S n
4102 @kindex S n (Summary)
4103 @findex gnus-summary-followup-to-mail
4104 Post a followup to the current article via news, even if you got the
4105 message through mail (@code{gnus-summary-followup-to-mail}).
4106
4107 @item S N
4108 @kindex S N (Summary)
4109 @findex gnus-summary-followup-to-mail-with-original
4110 Post a followup to the current article via news, even if you got the
4111 message through mail and include the original message
4112 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
4113 the process/prefix convention.
4114
4115 @item S o p
4116 @kindex S o p (Summary)
4117 @findex gnus-summary-post-forward
4118 Forward the current article to a newsgroup
4119 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
4120 headers of the forwarded article.
4121
4122 @item S O p
4123 @kindex S O p (Summary)
4124 @findex gnus-uu-digest-post-forward
4125 @cindex digests
4126 @cindex making digests
4127 Digest the current series and forward the result to a newsgroup
4128 (@code{gnus-uu-digest-mail-forward}).  This command uses the
4129 process/prefix convention.
4130
4131 @item S u
4132 @kindex S u (Summary)
4133 @findex gnus-uu-post-news
4134 @c @icon{gnus-uu-post-news}
4135 Uuencode a file, split it into parts, and post it as a series
4136 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4137 @end table
4138
4139 Also @pxref{(message)Header Commands} for more information.
4140
4141
4142 @node Canceling and Superseding
4143 @section Canceling Articles
4144 @cindex canceling articles
4145 @cindex superseding articles
4146
4147 Have you ever written something, and then decided that you really,
4148 really, really wish you hadn't posted that?
4149
4150 Well, you can't cancel mail, but you can cancel posts.
4151
4152 @findex gnus-summary-cancel-article
4153 @kindex C (Summary)
4154 @c @icon{gnus-summary-cancel-article}
4155 Find the article you wish to cancel (you can only cancel your own
4156 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
4157 c} (@code{gnus-summary-cancel-article}).  Your article will be
4158 canceled---machines all over the world will be deleting your article.
4159 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4160
4161 Be aware, however, that not all sites honor cancels, so your article may
4162 live on here and there, while most sites will delete the article in
4163 question.
4164
4165 Gnus will use the ``current'' select method when canceling.  If you
4166 want to use the standard posting method, use the @samp{a} symbolic
4167 prefix (@pxref{Symbolic Prefixes}).
4168
4169 If you discover that you have made some mistakes and want to do some
4170 corrections, you can post a @dfn{superseding} article that will replace
4171 your original article.
4172
4173 @findex gnus-summary-supersede-article
4174 @kindex S (Summary)
4175 Go to the original article and press @kbd{S s}
4176 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
4177 where you can edit the article all you want before sending it off the
4178 usual way.
4179
4180 The same goes for superseding as for canceling, only more so: Some
4181 sites do not honor superseding.  On those sites, it will appear that you
4182 have posted almost the same article twice.
4183
4184 If you have just posted the article, and change your mind right away,
4185 there is a trick you can use to cancel/supersede the article without
4186 waiting for the article to appear on your site first.  You simply return
4187 to the post buffer (which is called @code{*sent ...*}).  There you will
4188 find the article you just posted, with all the headers intact.  Change
4189 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4190 header by substituting one of those words for the word
4191 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
4192 you would do normally.  The previous article will be
4193 canceled/superseded.
4194
4195 Just remember, kids: There is no 'c' in 'supersede'.
4196
4197
4198 @node Marking Articles
4199 @section Marking Articles
4200 @cindex article marking
4201 @cindex article ticking
4202 @cindex marks
4203
4204 There are several marks you can set on an article.
4205
4206 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4207 neologism ohoy!) of the article.  Alphabetic marks generally mean
4208 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4209
4210 In addition, you also have marks that do not affect readedness.
4211
4212 @menu
4213 * Unread Articles::      Marks for unread articles.
4214 * Read Articles::        Marks for read articles.
4215 * Other Marks::          Marks that do not affect readedness.
4216 @end menu
4217
4218 @ifinfo
4219 There's a plethora of commands for manipulating these marks:
4220 @end ifinfo
4221
4222 @menu
4223 * Setting Marks::             How to set and remove marks.
4224 * Generic Marking Commands::  How to customize the marking.
4225 * Setting Process Marks::     How to mark articles for later processing.
4226 @end menu
4227
4228
4229 @node Unread Articles
4230 @subsection Unread Articles
4231
4232 The following marks mark articles as (kinda) unread, in one form or
4233 other.
4234
4235 @table @samp
4236 @item !
4237 @vindex gnus-ticked-mark
4238 Marked as ticked (@code{gnus-ticked-mark}).
4239
4240 @dfn{Ticked articles} are articles that will remain visible always.  If
4241 you see an article that you find interesting, or you want to put off
4242 reading it, or replying to it, until sometime later, you'd typically
4243 tick it.  However, articles can be expired, so if you want to keep an
4244 article forever, you'll have to make it persistent (@pxref{Persistent
4245 Articles}).
4246
4247 @item ?
4248 @vindex gnus-dormant-mark
4249 Marked as dormant (@code{gnus-dormant-mark}).
4250
4251 @dfn{Dormant articles} will only appear in the summary buffer if there
4252 are followups to it.  If you want to see them even if they don't have
4253 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4254
4255 @item SPACE
4256 @vindex gnus-unread-mark
4257 Marked as unread (@code{gnus-unread-mark}).
4258
4259 @dfn{Unread articles} are articles that haven't been read at all yet.
4260 @end table
4261
4262
4263 @node Read Articles
4264 @subsection Read Articles
4265 @cindex expirable mark
4266
4267 All the following marks mark articles as read.
4268
4269 @table @samp
4270
4271 @item r
4272 @vindex gnus-del-mark
4273 These are articles that the user has marked as read with the @kbd{d}
4274 command manually, more or less (@code{gnus-del-mark}).
4275
4276 @item R
4277 @vindex gnus-read-mark
4278 Articles that have actually been read (@code{gnus-read-mark}).
4279
4280 @item O
4281 @vindex gnus-ancient-mark
4282 Articles that were marked as read in previous sessions and are now
4283 @dfn{old} (@code{gnus-ancient-mark}).
4284
4285 @item K
4286 @vindex gnus-killed-mark
4287 Marked as killed (@code{gnus-killed-mark}).
4288
4289 @item X
4290 @vindex gnus-kill-file-mark
4291 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4292
4293 @item Y
4294 @vindex gnus-low-score-mark
4295 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4296
4297 @item C
4298 @vindex gnus-catchup-mark
4299 Marked as read by a catchup (@code{gnus-catchup-mark}).
4300
4301 @item G
4302 @vindex gnus-canceled-mark
4303 Canceled article (@code{gnus-canceled-mark})
4304
4305 @item F
4306 @vindex gnus-souped-mark
4307 @sc{soup}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4308
4309 @item Q
4310 @vindex gnus-sparse-mark
4311 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4312 Threading}.
4313
4314 @item M
4315 @vindex gnus-duplicate-mark
4316 Article marked as read by duplicate suppression
4317 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4318
4319 @end table
4320
4321 All these marks just mean that the article is marked as read, really.
4322 They are interpreted differently when doing adaptive scoring, though.
4323
4324 One more special mark, though:
4325
4326 @table @samp
4327 @item E
4328 @vindex gnus-expirable-mark
4329 Marked as expirable (@code{gnus-expirable-mark}).
4330
4331 Marking articles as @dfn{expirable} (or have them marked as such
4332 automatically) doesn't make much sense in normal groups---a user doesn't
4333 control expiring of news articles, but in mail groups, for instance,
4334 articles marked as @dfn{expirable} can be deleted by Gnus at
4335 any time.
4336 @end table
4337
4338
4339 @node Other Marks
4340 @subsection Other Marks
4341 @cindex process mark
4342 @cindex bookmarks
4343
4344 There are some marks that have nothing to do with whether the article is
4345 read or not.
4346
4347 @itemize @bullet
4348
4349 @item
4350 You can set a bookmark in the current article.  Say you are reading a
4351 long thesis on cats' urinary tracts, and have to go home for dinner
4352 before you've finished reading the thesis.  You can then set a bookmark
4353 in the article, and Gnus will jump to this bookmark the next time it
4354 encounters the article.  @xref{Setting Marks}.
4355
4356 @item
4357 @vindex gnus-replied-mark
4358 All articles that you have replied to or made a followup to (i.e., have
4359 answered) will be marked with an @samp{A} in the second column
4360 (@code{gnus-replied-mark}).
4361
4362 @item
4363 @vindex gnus-cached-mark
4364 Articles stored in the article cache will be marked with an @samp{*} in
4365 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
4366
4367 @item
4368 @vindex gnus-saved-mark
4369 Articles ``saved'' (in some manner or other; not necessarily
4370 religiously) are marked with an @samp{S} in the second column
4371 (@code{gnus-saved-mark}).
4372
4373 @item
4374 @vindex gnus-not-empty-thread-mark
4375 @vindex gnus-empty-thread-mark
4376 If the @samp{%e} spec is used, the presence of threads or not will be
4377 marked with @code{gnus-not-empty-thread-mark} and
4378 @code{gnus-empty-thread-mark} in the third column, respectively.
4379
4380 @item
4381 @vindex gnus-process-mark
4382 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4383 variety of commands react to the presence of the process mark.  For
4384 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4385 all articles that have been marked with the process mark.  Articles
4386 marked with the process mark have a @samp{#} in the second column.
4387
4388 @end itemize
4389
4390 You might have noticed that most of these ``non-readedness'' marks
4391 appear in the second column by default.  So if you have a cached, saved,
4392 replied article that you have process-marked, what will that look like?
4393
4394 Nothing much.  The precedence rules go as follows: process -> cache ->
4395 replied -> saved.  So if the article is in the cache and is replied,
4396 you'll only see the cache mark and not the replied mark.
4397
4398
4399 @node Setting Marks
4400 @subsection Setting Marks
4401 @cindex setting marks
4402
4403 All the marking commands understand the numeric prefix.
4404
4405 @table @kbd
4406 @item M c
4407 @itemx M-u
4408 @kindex M c (Summary)
4409 @kindex M-u (Summary)
4410 @findex gnus-summary-clear-mark-forward
4411 @cindex mark as unread
4412 Clear all readedness-marks from the current article
4413 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4414 article as unread.
4415
4416 @item M t
4417 @itemx !
4418 @kindex ! (Summary)
4419 @kindex M t (Summary)
4420 @findex gnus-summary-tick-article-forward
4421 Tick the current article (@code{gnus-summary-tick-article-forward}).
4422 @xref{Article Caching}.
4423
4424 @item M ?
4425 @itemx ?
4426 @kindex ? (Summary)
4427 @kindex M ? (Summary)
4428 @findex gnus-summary-mark-as-dormant
4429 Mark the current article as dormant
4430 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
4431
4432 @item M d
4433 @itemx d
4434 @kindex M d (Summary)
4435 @kindex d (Summary)
4436 @findex gnus-summary-mark-as-read-forward
4437 Mark the current article as read
4438 (@code{gnus-summary-mark-as-read-forward}).
4439
4440 @item D
4441 @kindex D (Summary)
4442 @findex gnus-summary-mark-as-read-backward
4443 Mark the current article as read and move point to the previous line
4444 (@code{gnus-summary-mark-as-read-backward}).
4445
4446 @item M k
4447 @itemx k
4448 @kindex k (Summary)
4449 @kindex M k (Summary)
4450 @findex gnus-summary-kill-same-subject-and-select
4451 Mark all articles that have the same subject as the current one as read,
4452 and then select the next unread article
4453 (@code{gnus-summary-kill-same-subject-and-select}).
4454
4455 @item M K
4456 @itemx C-k
4457 @kindex M K (Summary)
4458 @kindex C-k (Summary)
4459 @findex gnus-summary-kill-same-subject
4460 Mark all articles that have the same subject as the current one as read
4461 (@code{gnus-summary-kill-same-subject}).
4462
4463 @item M C
4464 @kindex M C (Summary)
4465 @findex gnus-summary-catchup
4466 @c @icon{gnus-summary-catchup}
4467 Mark all unread articles as read (@code{gnus-summary-catchup}).
4468
4469 @item M C-c
4470 @kindex M C-c (Summary)
4471 @findex gnus-summary-catchup-all
4472 Mark all articles in the group as read---even the ticked and dormant
4473 articles (@code{gnus-summary-catchup-all}).
4474
4475 @item M H
4476 @kindex M H (Summary)
4477 @findex gnus-summary-catchup-to-here
4478 Catchup the current group to point
4479 (@code{gnus-summary-catchup-to-here}).
4480
4481 @item C-w
4482 @kindex C-w (Summary)
4483 @findex gnus-summary-mark-region-as-read
4484 Mark all articles between point and mark as read
4485 (@code{gnus-summary-mark-region-as-read}).
4486
4487 @item M V k
4488 @kindex M V k (Summary)
4489 @findex gnus-summary-kill-below
4490 Kill all articles with scores below the default score (or below the
4491 numeric prefix) (@code{gnus-summary-kill-below}).
4492
4493 @item M e
4494 @itemx E
4495 @kindex M e (Summary)
4496 @kindex E (Summary)
4497 @findex gnus-summary-mark-as-expirable
4498 Mark the current article as expirable
4499 (@code{gnus-summary-mark-as-expirable}).
4500
4501 @item M b
4502 @kindex M b (Summary)
4503 @findex gnus-summary-set-bookmark
4504 Set a bookmark in the current article
4505 (@code{gnus-summary-set-bookmark}).
4506
4507 @item M B
4508 @kindex M B (Summary)
4509 @findex gnus-summary-remove-bookmark
4510 Remove the bookmark from the current article
4511 (@code{gnus-summary-remove-bookmark}).
4512
4513 @item M V c
4514 @kindex M V c (Summary)
4515 @findex gnus-summary-clear-above
4516 Clear all marks from articles with scores over the default score (or
4517 over the numeric prefix) (@code{gnus-summary-clear-above}).
4518
4519 @item M V u
4520 @kindex M V u (Summary)
4521 @findex gnus-summary-tick-above
4522 Tick all articles with scores over the default score (or over the
4523 numeric prefix) (@code{gnus-summary-tick-above}).
4524
4525 @item M V m
4526 @kindex M V m (Summary)
4527 @findex gnus-summary-mark-above
4528 Prompt for a mark, and mark all articles with scores over the default
4529 score (or over the numeric prefix) with this mark
4530 (@code{gnus-summary-clear-above}).
4531 @end table
4532
4533 @vindex gnus-summary-goto-unread
4534 The @code{gnus-summary-goto-unread} variable controls what action should
4535 be taken after setting a mark.  If non-@code{nil}, point will move to
4536 the next/previous unread article.  If @code{nil}, point will just move
4537 one line up or down.  As a special case, if this variable is
4538 @code{never}, all the marking commands as well as other commands (like
4539 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4540 The default is @code{t}.
4541
4542
4543 @node Generic Marking Commands
4544 @subsection Generic Marking Commands
4545
4546 Some people would like the command that ticks an article (@kbd{!}) go to
4547 the next article.  Others would like it to go to the next unread
4548 article.  Yet others would like it to stay on the current article.  And
4549 even though I haven't heard of anybody wanting it to go to the
4550 previous (unread) article, I'm sure there are people that want that as
4551 well.
4552
4553 Multiply these five behaviours with five different marking commands, and
4554 you get a potentially complex set of variable to control what each
4555 command should do.
4556
4557 To sidestep that mess, Gnus provides commands that do all these
4558 different things.  They can be found on the @kbd{M M} map in the summary
4559 buffer.  Type @kbd{M M C-h} to see them all---there are too many of them
4560 to list in this manual.
4561
4562 While you can use these commands directly, most users would prefer
4563 altering the summary mode keymap.  For instance, if you would like the
4564 @kbd{!} command to go to the next article instead of the next unread
4565 article, you could say something like:
4566
4567 @lisp
4568 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
4569 (defun my-alter-summary-map ()
4570   (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
4571 @end lisp
4572
4573 or
4574
4575 @lisp
4576 (defun my-alter-summary-map ()
4577   (local-set-key "!" "MM!n"))
4578 @end lisp
4579
4580
4581 @node Setting Process Marks
4582 @subsection Setting Process Marks
4583 @cindex setting process marks
4584
4585 @table @kbd
4586
4587 @item M P p
4588 @itemx #
4589 @kindex # (Summary)
4590 @kindex M P p (Summary)
4591 @findex gnus-summary-mark-as-processable
4592 Mark the current article with the process mark
4593 (@code{gnus-summary-mark-as-processable}).
4594 @findex gnus-summary-unmark-as-processable
4595
4596 @item M P u
4597 @itemx M-#
4598 @kindex M P u (Summary)
4599 @kindex M-# (Summary)
4600 Remove the process mark, if any, from the current article
4601 (@code{gnus-summary-unmark-as-processable}).
4602
4603 @item M P U
4604 @kindex M P U (Summary)
4605 @findex gnus-summary-unmark-all-processable
4606 Remove the process mark from all articles
4607 (@code{gnus-summary-unmark-all-processable}).
4608
4609 @item M P i
4610 @kindex M P i (Summary)
4611 @findex gnus-uu-invert-processable
4612 Invert the list of process marked articles
4613 (@code{gnus-uu-invert-processable}).
4614
4615 @item M P R
4616 @kindex M P R (Summary)
4617 @findex gnus-uu-mark-by-regexp
4618 Mark articles that have a @code{Subject} header that matches a regular
4619 expression (@code{gnus-uu-mark-by-regexp}).
4620
4621 @item M P r
4622 @kindex M P r (Summary)
4623 @findex gnus-uu-mark-region
4624 Mark articles in region (@code{gnus-uu-mark-region}).
4625
4626 @item M P t
4627 @kindex M P t (Summary)
4628 @findex gnus-uu-mark-thread
4629 Mark all articles in the current (sub)thread
4630 (@code{gnus-uu-mark-thread}).
4631
4632 @item M P T
4633 @kindex M P T (Summary)
4634 @findex gnus-uu-unmark-thread
4635 Unmark all articles in the current (sub)thread
4636 (@code{gnus-uu-unmark-thread}).
4637
4638 @item M P v
4639 @kindex M P v (Summary)
4640 @findex gnus-uu-mark-over
4641 Mark all articles that have a score above the prefix argument
4642 (@code{gnus-uu-mark-over}).
4643
4644 @item M P s
4645 @kindex M P s (Summary)
4646 @findex gnus-uu-mark-series
4647 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4648
4649 @item M P S
4650 @kindex M P S (Summary)
4651 @findex gnus-uu-mark-sparse
4652 Mark all series that have already had some articles marked
4653 (@code{gnus-uu-mark-sparse}).
4654
4655 @item M P a
4656 @kindex M P a (Summary)
4657 @findex gnus-uu-mark-all
4658 Mark all articles in series order (@code{gnus-uu-mark-series}).
4659
4660 @item M P b
4661 @kindex M P b (Summary)
4662 @findex gnus-uu-mark-buffer
4663 Mark all articles in the buffer in the order they appear
4664 (@code{gnus-uu-mark-buffer}).
4665
4666 @item M P k
4667 @kindex M P k (Summary)
4668 @findex gnus-summary-kill-process-mark
4669 Push the current process mark set onto the stack and unmark all articles
4670 (@code{gnus-summary-kill-process-mark}).
4671
4672 @item M P y
4673 @kindex M P y (Summary)
4674 @findex gnus-summary-yank-process-mark
4675 Pop the previous process mark set from the stack and restore it
4676 (@code{gnus-summary-yank-process-mark}).
4677
4678 @item M P w
4679 @kindex M P w (Summary)
4680 @findex gnus-summary-save-process-mark
4681 Push the current process mark set onto the stack
4682 (@code{gnus-summary-save-process-mark}).
4683
4684 @end table
4685
4686
4687 @node Limiting
4688 @section Limiting
4689 @cindex limiting
4690
4691 It can be convenient to limit the summary buffer to just show some
4692 subset of the articles currently in the group.  The effect most limit
4693 commands have is to remove a few (or many) articles from the summary
4694 buffer.
4695
4696 All limiting commands work on subsets of the articles already fetched
4697 from the servers.  None of these commands query the server for
4698 additional articles.
4699
4700 @table @kbd
4701
4702 @item / /
4703 @itemx / s
4704 @kindex / / (Summary)
4705 @findex gnus-summary-limit-to-subject
4706 Limit the summary buffer to articles that match some subject
4707 (@code{gnus-summary-limit-to-subject}).
4708
4709 @item / a
4710 @kindex / a (Summary)
4711 @findex gnus-summary-limit-to-author
4712 Limit the summary buffer to articles that match some author
4713 (@code{gnus-summary-limit-to-author}).
4714
4715 @item / x
4716 @kindex / x (Summary)
4717 @findex gnus-summary-limit-to-extra
4718 Limit the summary buffer to articles that match one of the ``extra''
4719 headers (@pxref{To From Newsgroups})
4720 (@code{gnus-summary-limit-to-author}).
4721
4722 @item / u
4723 @itemx x
4724 @kindex / u (Summary)
4725 @kindex x (Summary)
4726 @findex gnus-summary-limit-to-unread
4727 Limit the summary buffer to articles not marked as read
4728 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4729 buffer to articles strictly unread.  This means that ticked and
4730 dormant articles will also be excluded.
4731
4732 @item / m
4733 @kindex / m (Summary)
4734 @findex gnus-summary-limit-to-marks
4735 Ask for a mark and then limit to all articles that have been marked
4736 with that mark (@code{gnus-summary-limit-to-marks}).
4737
4738 @item / t
4739 @kindex / t (Summary)
4740 @findex gnus-summary-limit-to-age
4741 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4742 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4743 articles younger than that number of days.
4744
4745 @item / n
4746 @kindex / n (Summary)
4747 @findex gnus-summary-limit-to-articles
4748 Limit the summary buffer to the current article
4749 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4750 convention (@pxref{Process/Prefix}).
4751
4752 @item / w
4753 @kindex / w (Summary)
4754 @findex gnus-summary-pop-limit
4755 Pop the previous limit off the stack and restore it
4756 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4757 the stack.
4758
4759 @item / v
4760 @kindex / v (Summary)
4761 @findex gnus-summary-limit-to-score
4762 Limit the summary buffer to articles that have a score at or above some
4763 score (@code{gnus-summary-limit-to-score}).
4764
4765 @item / E
4766 @itemx M S
4767 @kindex M S (Summary)
4768 @kindex / E (Summary)
4769 @findex gnus-summary-limit-include-expunged
4770 Include all expunged articles in the limit
4771 (@code{gnus-summary-limit-include-expunged}).
4772
4773 @item / D
4774 @kindex / D (Summary)
4775 @findex gnus-summary-limit-include-dormant
4776 Include all dormant articles in the limit
4777 (@code{gnus-summary-limit-include-dormant}).
4778
4779 @item / *
4780 @kindex / * (Summary)
4781 @findex gnus-summary-limit-include-cached
4782 Include all cached articles in the limit
4783 (@code{gnus-summary-limit-include-cached}).
4784
4785 @item / d
4786 @kindex / d (Summary)
4787 @findex gnus-summary-limit-exclude-dormant
4788 Exclude all dormant articles from the limit
4789 (@code{gnus-summary-limit-exclude-dormant}).
4790
4791 @item / M
4792 @kindex / M (Summary)
4793 @findex gnus-summary-limit-exclude-marks
4794 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
4795
4796 @item / T
4797 @kindex / T (Summary)
4798 @findex gnus-summary-limit-include-thread
4799 Include all the articles in the current thread in the limit.
4800
4801 @item / c
4802 @kindex / c (Summary)
4803 @findex gnus-summary-limit-exclude-childless-dormant
4804 Exclude all dormant articles that have no children from the limit
4805 (@code{gnus-summary-limit-exclude-childless-dormant}).
4806
4807 @item / C
4808 @kindex / C (Summary)
4809 @findex gnus-summary-limit-mark-excluded-as-read
4810 Mark all excluded unread articles as read
4811 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4812 also mark excluded ticked and dormant articles as read.
4813
4814 @end table
4815
4816
4817 @node Threading
4818 @section Threading
4819 @cindex threading
4820 @cindex article threading
4821
4822 Gnus threads articles by default.  @dfn{To thread} is to put responses
4823 to articles directly after the articles they respond to---in a
4824 hierarchical fashion.
4825
4826 Threading is done by looking at the @code{References} headers of the
4827 articles.  In a perfect world, this would be enough to build pretty
4828 trees, but unfortunately, the @code{References} header is often broken
4829 or simply missing.  Weird news propagation excarcerbates the problem,
4830 so one has to employ other heuristics to get pleasing results.  A
4831 plethora of approaches exists, as detailed in horrible detail in
4832 @pxref{Customizing Threading}.
4833
4834 First, a quick overview of the concepts:
4835
4836 @table @dfn
4837 @item root
4838 The top-most article in a thread; the first article in the thread.
4839
4840 @item thread
4841 A tree-like article structure.
4842
4843 @item sub-thread
4844 A small(er) section of this tree-like structure.
4845
4846 @item loose threads
4847 Threads often lose their roots due to article expiry, or due to the root
4848 already having been read in a previous session, and not displayed in the
4849 summary buffer.  We then typically have many sub-threads that really
4850 belong to one thread, but are without connecting roots.  These are
4851 called loose threads.
4852
4853 @item thread gathering
4854 An attempt to gather loose threads into bigger threads.
4855
4856 @item sparse threads
4857 A thread where the missing articles have been ``guessed'' at, and are
4858 displayed as empty lines in the summary buffer.
4859
4860 @end table
4861
4862
4863 @menu
4864 * Customizing Threading::     Variables you can change to affect the threading.
4865 * Thread Commands::           Thread based commands in the summary buffer.
4866 @end menu
4867
4868
4869 @node Customizing Threading
4870 @subsection Customizing Threading
4871 @cindex customizing threading
4872
4873 @menu
4874 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
4875 * Filling In Threads::   Making the threads displayed look fuller.
4876 * More Threading::       Even more variables for fiddling with threads.
4877 * Low-Level Threading::  You thought it was over... but you were wrong!
4878 @end menu
4879
4880
4881 @node Loose Threads
4882 @subsubsection Loose Threads
4883 @cindex <
4884 @cindex >
4885 @cindex loose threads
4886
4887 @table @code
4888 @item gnus-summary-make-false-root
4889 @vindex gnus-summary-make-false-root
4890 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4891 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4892 Yup.)  Loose subtrees occur when the real root has expired, or you've
4893 read or killed the root in a previous session.
4894
4895 When there is no real root of a thread, Gnus will have to fudge
4896 something.  This variable says what fudging method Gnus should use.
4897 There are four possible values:
4898
4899 @iftex
4900 @iflatex
4901 \gnusfigure{The Summary Buffer}{390}{
4902 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4903 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4904 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4905 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4906 }
4907 @end iflatex
4908 @end iftex
4909
4910 @cindex adopting articles
4911
4912 @table @code
4913
4914 @item adopt
4915 Gnus will make the first of the orphaned articles the parent.  This
4916 parent will adopt all the other articles.  The adopted articles will be
4917 marked as such by pointy brackets (@samp{<>}) instead of the standard
4918 square brackets (@samp{[]}).  This is the default method.
4919
4920 @item dummy
4921 @vindex gnus-summary-dummy-line-format
4922 Gnus will create a dummy summary line that will pretend to be the
4923 parent.  This dummy line does not correspond to any real article, so
4924 selecting it will just select the first real article after the dummy
4925 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4926 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4927 which is the subject of the article.  @xref{Formatting Variables}.
4928
4929 @item empty
4930 Gnus won't actually make any article the parent, but simply leave the
4931 subject field of all orphans except the first empty.  (Actually, it will
4932 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4933 Buffer Format}).)
4934
4935 @item none
4936 Don't make any article parent at all.  Just gather the threads and
4937 display them after one another.
4938
4939 @item nil
4940 Don't gather loose threads.
4941 @end table
4942
4943 @item gnus-summary-gather-subject-limit
4944 @vindex gnus-summary-gather-subject-limit
4945 Loose threads are gathered by comparing subjects of articles.  If this
4946 variable is @code{nil}, Gnus requires an exact match between the
4947 subjects of the loose threads before gathering them into one big
4948 super-thread.  This might be too strict a requirement, what with the
4949 presence of stupid newsreaders that chop off long subject lines.  If
4950 you think so, set this variable to, say, 20 to require that only the
4951 first 20 characters of the subjects have to match.  If you set this
4952 variable to a really low number, you'll find that Gnus will gather
4953 everything in sight into one thread, which isn't very helpful.
4954
4955 @cindex fuzzy article gathering
4956 If you set this variable to the special value @code{fuzzy}, Gnus will
4957 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4958 Matching}).
4959
4960 @item gnus-simplify-subject-fuzzy-regexp
4961 @vindex gnus-simplify-subject-fuzzy-regexp
4962 This can either be a regular expression or list of regular expressions
4963 that match strings that will be removed from subjects if fuzzy subject
4964 simplification is used.
4965
4966 @item gnus-simplify-ignored-prefixes
4967 @vindex gnus-simplify-ignored-prefixes
4968 If you set @code{gnus-summary-gather-subject-limit} to something as low
4969 as 10, you might consider setting this variable to something sensible:
4970
4971 @c Written by Michael Ernst <mernst@cs.rice.edu>
4972 @lisp
4973 (setq gnus-simplify-ignored-prefixes
4974       (concat
4975        "\\`\\[?\\("
4976        (mapconcat
4977         'identity
4978         '("looking"
4979           "wanted" "followup" "summary\\( of\\)?"
4980           "help" "query" "problem" "question"
4981           "answer" "reference" "announce"
4982           "How can I" "How to" "Comparison of"
4983           ;; ...
4984           )
4985         "\\|")
4986        "\\)\\s *\\("
4987        (mapconcat 'identity
4988                   '("for" "for reference" "with" "about")
4989                   "\\|")
4990        "\\)?\\]?:?[ \t]*"))
4991 @end lisp
4992
4993 All words that match this regexp will be removed before comparing two
4994 subjects.
4995
4996 @item gnus-simplify-subject-functions
4997 @vindex gnus-simplify-subject-functions
4998 If non-@code{nil}, this variable overrides
4999 @code{gnus-summary-gather-subject-limit}.  This variable should be a
5000 list of functions to apply to the @code{Subject} string iteratively to
5001 arrive at the simplified version of the string.
5002
5003 Useful functions to put in this list include:
5004
5005 @table @code
5006 @item gnus-simplify-subject-re
5007 @findex gnus-simplify-subject-re
5008 Strip the leading @samp{Re:}.
5009
5010 @item gnus-simplify-subject-fuzzy
5011 @findex gnus-simplify-subject-fuzzy
5012 Simplify fuzzily.
5013
5014 @item gnus-simplify-whitespace
5015 @findex gnus-simplify-whitespace
5016 Remove excessive whitespace.
5017 @end table
5018
5019 You may also write your own functions, of course.
5020
5021
5022 @item gnus-summary-gather-exclude-subject
5023 @vindex gnus-summary-gather-exclude-subject
5024 Since loose thread gathering is done on subjects only, that might lead
5025 to many false hits, especially with certain common subjects like
5026 @samp{} and @samp{(none)}.  To make the situation slightly better,
5027 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5028 what subjects should be excluded from the gathering process.@*
5029 The default is @samp{^ *$\\|^(none)$}.
5030
5031 @item gnus-summary-thread-gathering-function
5032 @vindex gnus-summary-thread-gathering-function
5033 Gnus gathers threads by looking at @code{Subject} headers.  This means
5034 that totally unrelated articles may end up in the same ``thread'', which
5035 is confusing.  An alternate approach is to look at all the
5036 @code{Message-ID}s in all the @code{References} headers to find matches.
5037 This will ensure that no gathered threads ever include unrelated
5038 articles, but it also means that people who have posted with broken
5039 newsreaders won't be gathered properly.  The choice is yours---plague or
5040 cholera:
5041
5042 @table @code
5043 @item gnus-gather-threads-by-subject
5044 @findex gnus-gather-threads-by-subject
5045 This function is the default gathering function and looks at
5046 @code{Subject}s exclusively.
5047
5048 @item gnus-gather-threads-by-references
5049 @findex gnus-gather-threads-by-references
5050 This function looks at @code{References} headers exclusively.
5051 @end table
5052
5053 If you want to test gathering by @code{References}, you could say
5054 something like:
5055
5056 @lisp
5057 (setq gnus-summary-thread-gathering-function
5058       'gnus-gather-threads-by-references)
5059 @end lisp
5060
5061 @end table
5062
5063
5064 @node Filling In Threads
5065 @subsubsection Filling In Threads
5066
5067 @table @code
5068 @item gnus-fetch-old-headers
5069 @vindex gnus-fetch-old-headers
5070 If non-@code{nil}, Gnus will attempt to build old threads by fetching
5071 more old headers---headers to articles marked as read.  If you
5072 would like to display as few summary lines as possible, but still
5073 connect as many loose threads as possible, you should set this variable
5074 to @code{some} or a number.  If you set it to a number, no more than
5075 that number of extra old headers will be fetched.  In either case,
5076 fetching old headers only works if the backend you are using carries
5077 overview files---this would normally be @code{nntp}, @code{nnspool} and
5078 @code{nnml}.  Also remember that if the root of the thread has been
5079 expired by the server, there's not much Gnus can do about that.
5080
5081 This variable can also be set to @code{invisible}.  This won't have any
5082 visible effects, but is useful if you use the @kbd{A T} command a lot
5083 (@pxref{Finding the Parent}).
5084
5085 @item gnus-build-sparse-threads
5086 @vindex gnus-build-sparse-threads
5087 Fetching old headers can be slow.  A low-rent similar effect can be
5088 gotten by setting this variable to @code{some}.  Gnus will then look at
5089 the complete @code{References} headers of all articles and try to string
5090 together articles that belong in the same thread.  This will leave
5091 @dfn{gaps} in the threading display where Gnus guesses that an article
5092 is missing from the thread.  (These gaps appear like normal summary
5093 lines.  If you select a gap, Gnus will try to fetch the article in
5094 question.)  If this variable is @code{t}, Gnus will display all these
5095 ``gaps'' without regard for whether they are useful for completing the
5096 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
5097 off sparse leaf nodes that don't lead anywhere.  This variable is
5098 @code{nil} by default.
5099
5100 @end table
5101
5102
5103 @node More Threading
5104 @subsubsection More Threading
5105
5106 @table @code
5107 @item gnus-show-threads
5108 @vindex gnus-show-threads
5109 If this variable is @code{nil}, no threading will be done, and all of
5110 the rest of the variables here will have no effect.  Turning threading
5111 off will speed group selection up a bit, but it is sure to make reading
5112 slower and more awkward.
5113
5114 @item gnus-thread-hide-subtree
5115 @vindex gnus-thread-hide-subtree
5116 If non-@code{nil}, all threads will be hidden when the summary buffer is
5117 generated.
5118
5119 @item gnus-thread-expunge-below
5120 @vindex gnus-thread-expunge-below
5121 All threads that have a total score (as defined by
5122 @code{gnus-thread-score-function}) less than this number will be
5123 expunged.  This variable is @code{nil} by default, which means that no
5124 threads are expunged.
5125
5126 @item gnus-thread-hide-killed
5127 @vindex gnus-thread-hide-killed
5128 if you kill a thread and this variable is non-@code{nil}, the subtree
5129 will be hidden.
5130
5131 @item gnus-thread-ignore-subject
5132 @vindex gnus-thread-ignore-subject
5133 Sometimes somebody changes the subject in the middle of a thread.  If
5134 this variable is non-@code{nil}, the subject change is ignored.  If it
5135 is @code{nil}, which is the default, a change in the subject will result
5136 in a new thread.
5137
5138 @item gnus-thread-indent-level
5139 @vindex gnus-thread-indent-level
5140 This is a number that says how much each sub-thread should be indented.
5141 The default is 4.
5142
5143 @item gnus-sort-gathered-threads-function
5144 @vindex gnus-sort-gathered-threads-function
5145 Sometimes, particularly with mailing lists, the order in which mails
5146 arrive locally is not necessarily the same as the order in which they
5147 arrived on the mailing list. Consequently, when sorting sub-threads
5148 using the default @code{gnus-thread-sort-by-number}, responses can end
5149 up appearing before the article to which they are responding to. Setting
5150 this variable to an alternate value
5151 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
5152 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
5153 more logical sub-thread ordering in such instances.
5154
5155 @end table
5156
5157
5158 @node Low-Level Threading
5159 @subsubsection Low-Level Threading
5160
5161 @table @code
5162
5163 @item gnus-parse-headers-hook
5164 @vindex gnus-parse-headers-hook
5165 Hook run before parsing any headers.
5166
5167 @item gnus-alter-header-function
5168 @vindex gnus-alter-header-function
5169 If non-@code{nil}, this function will be called to allow alteration of
5170 article header structures.  The function is called with one parameter,
5171 the article header vector, which it may alter in any way.  For instance,
5172 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5173 in systematic ways (by adding prefixes and such), you can use this
5174 variable to un-scramble the @code{Message-ID}s so that they are more
5175 meaningful.  Here's one example:
5176
5177 @lisp
5178 (setq gnus-alter-header-function 'my-alter-message-id)
5179
5180 (defun my-alter-message-id (header)
5181   (let ((id (mail-header-id header)))
5182     (when (string-match
5183            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5184       (mail-header-set-id
5185        (concat (match-string 1 id) "@@" (match-string 2 id))
5186        header))))
5187 @end lisp
5188
5189 @end table
5190
5191
5192 @node Thread Commands
5193 @subsection Thread Commands
5194 @cindex thread commands
5195
5196 @table @kbd
5197
5198 @item T k
5199 @itemx M-C-k
5200 @kindex T k (Summary)
5201 @kindex M-C-k (Summary)
5202 @findex gnus-summary-kill-thread
5203 Mark all articles in the current (sub-)thread as read
5204 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
5205 remove all marks instead.  If the prefix argument is negative, tick
5206 articles instead.
5207
5208 @item T l
5209 @itemx M-C-l
5210 @kindex T l (Summary)
5211 @kindex M-C-l (Summary)
5212 @findex gnus-summary-lower-thread
5213 Lower the score of the current (sub-)thread
5214 (@code{gnus-summary-lower-thread}).
5215
5216 @item T i
5217 @kindex T i (Summary)
5218 @findex gnus-summary-raise-thread
5219 Increase the score of the current (sub-)thread
5220 (@code{gnus-summary-raise-thread}).
5221
5222 @item T #
5223 @kindex T # (Summary)
5224 @findex gnus-uu-mark-thread
5225 Set the process mark on the current (sub-)thread
5226 (@code{gnus-uu-mark-thread}).
5227
5228 @item T M-#
5229 @kindex T M-# (Summary)
5230 @findex gnus-uu-unmark-thread
5231 Remove the process mark from the current (sub-)thread
5232 (@code{gnus-uu-unmark-thread}).
5233
5234 @item T T
5235 @kindex T T (Summary)
5236 @findex gnus-summary-toggle-threads
5237 Toggle threading (@code{gnus-summary-toggle-threads}).
5238
5239 @item T s
5240 @kindex T s (Summary)
5241 @findex gnus-summary-show-thread
5242 Expose the (sub-)thread hidden under the current article, if any
5243 (@code{gnus-summary-show-thread}).
5244
5245 @item T h
5246 @kindex T h (Summary)
5247 @findex gnus-summary-hide-thread
5248 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5249
5250 @item T S
5251 @kindex T S (Summary)
5252 @findex gnus-summary-show-all-threads
5253 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5254
5255 @item T H
5256 @kindex T H (Summary)
5257 @findex gnus-summary-hide-all-threads
5258 Hide all threads (@code{gnus-summary-hide-all-threads}).
5259
5260 @item T t
5261 @kindex T t (Summary)
5262 @findex gnus-summary-rethread-current
5263 Re-thread the current article's thread
5264 (@code{gnus-summary-rethread-current}).  This works even when the
5265 summary buffer is otherwise unthreaded.
5266
5267 @item T ^
5268 @kindex T ^ (Summary)
5269 @findex gnus-summary-reparent-thread
5270 Make the current article the child of the marked (or previous) article
5271 (@code{gnus-summary-reparent-thread}).
5272
5273 @end table
5274
5275 The following commands are thread movement commands.  They all
5276 understand the numeric prefix.
5277
5278 @table @kbd
5279
5280 @item T n
5281 @kindex T n (Summary)
5282 @findex gnus-summary-next-thread
5283 Go to the next thread (@code{gnus-summary-next-thread}).
5284
5285 @item T p
5286 @kindex T p (Summary)
5287 @findex gnus-summary-prev-thread
5288 Go to the previous thread (@code{gnus-summary-prev-thread}).
5289
5290 @item T d
5291 @kindex T d (Summary)
5292 @findex gnus-summary-down-thread
5293 Descend the thread (@code{gnus-summary-down-thread}).
5294
5295 @item T u
5296 @kindex T u (Summary)
5297 @findex gnus-summary-up-thread
5298 Ascend the thread (@code{gnus-summary-up-thread}).
5299
5300 @item T o
5301 @kindex T o (Summary)
5302 @findex gnus-summary-top-thread
5303 Go to the top of the thread (@code{gnus-summary-top-thread}).
5304 @end table
5305
5306 @vindex gnus-thread-operation-ignore-subject
5307 If you ignore subject while threading, you'll naturally end up with
5308 threads that have several different subjects in them.  If you then issue
5309 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5310 wish to kill the entire thread, but just those parts of the thread that
5311 have the same subject as the current article.  If you like this idea,
5312 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
5313 is non-@code{nil} (which it is by default), subjects will be ignored
5314 when doing thread commands.  If this variable is @code{nil}, articles in
5315 the same thread with different subjects will not be included in the
5316 operation in question.  If this variable is @code{fuzzy}, only articles
5317 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5318 Matching}).
5319
5320
5321 @node Sorting
5322 @section Sorting
5323
5324 @findex gnus-thread-sort-by-total-score
5325 @findex gnus-thread-sort-by-date
5326 @findex gnus-thread-sort-by-score
5327 @findex gnus-thread-sort-by-subject
5328 @findex gnus-thread-sort-by-author
5329 @findex gnus-thread-sort-by-number
5330 @vindex gnus-thread-sort-functions
5331 If you are using a threaded summary display, you can sort the threads by
5332 setting @code{gnus-thread-sort-functions}, which can be either a single
5333 function, a list of functions, or a list containing functions and
5334 @code{(not some-function)} elements.
5335
5336 By default, sorting is done on article numbers.  Ready-made sorting
5337 predicate functions include @code{gnus-thread-sort-by-number},
5338 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5339 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5340 @code{gnus-thread-sort-by-total-score}.
5341
5342 Each function takes two threads and returns non-@code{nil} if the first
5343 thread should be sorted before the other.  Note that sorting really is
5344 normally done by looking only at the roots of each thread.
5345
5346 If you use more than one function, the primary sort key should be the
5347 last function in the list.  You should probably always include
5348 @code{gnus-thread-sort-by-number} in the list of sorting
5349 functions---preferably first.  This will ensure that threads that are
5350 equal with respect to the other sort criteria will be displayed in
5351 ascending article order.
5352
5353 If you would like to sort by reverse score, then by subject, and finally
5354 by number, you could do something like:
5355
5356 @lisp
5357 (setq gnus-thread-sort-functions
5358       '(gnus-thread-sort-by-number
5359         gnus-thread-sort-by-subject
5360         (not gnus-thread-sort-by-total-score)))
5361 @end lisp
5362
5363 The threads that have highest score will be displayed first in the
5364 summary buffer.  When threads have the same score, they will be sorted
5365 alphabetically.  The threads that have the same score and the same
5366 subject will be sorted by number, which is (normally) the sequence in
5367 which the articles arrived.
5368
5369 If you want to sort by score and then reverse arrival order, you could
5370 say something like:
5371
5372 @lisp
5373 (setq gnus-thread-sort-functions
5374       '((lambda (t1 t2)
5375           (not (gnus-thread-sort-by-number t1 t2)))
5376         gnus-thread-sort-by-score))
5377 @end lisp
5378
5379 @vindex gnus-thread-score-function
5380 The function in the @code{gnus-thread-score-function} variable (default
5381 @code{+}) is used for calculating the total score of a thread.  Useful
5382 functions might be @code{max}, @code{min}, or squared means, or whatever
5383 tickles your fancy.
5384
5385 @findex gnus-article-sort-functions
5386 @findex gnus-article-sort-by-date
5387 @findex gnus-article-sort-by-score
5388 @findex gnus-article-sort-by-subject
5389 @findex gnus-article-sort-by-author
5390 @findex gnus-article-sort-by-number
5391 If you are using an unthreaded display for some strange reason or other,
5392 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5393 It is very similar to the @code{gnus-thread-sort-functions}, except that
5394 it uses slightly different functions for article comparison.  Available
5395 sorting predicate functions are @code{gnus-article-sort-by-number},
5396 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5397 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5398
5399 If you want to sort an unthreaded summary display by subject, you could
5400 say something like:
5401
5402 @lisp
5403 (setq gnus-article-sort-functions
5404       '(gnus-article-sort-by-number
5405         gnus-article-sort-by-subject))
5406 @end lisp
5407
5408
5409
5410 @node Asynchronous Fetching
5411 @section Asynchronous Article Fetching
5412 @cindex asynchronous article fetching
5413 @cindex article pre-fetch
5414 @cindex pre-fetch
5415
5416 If you read your news from an @sc{nntp} server that's far away, the
5417 network latencies may make reading articles a chore.  You have to wait
5418 for a while after pressing @kbd{n} to go to the next article before the
5419 article appears.  Why can't Gnus just go ahead and fetch the article
5420 while you are reading the previous one?  Why not, indeed.
5421
5422 First, some caveats.  There are some pitfalls to using asynchronous
5423 article fetching, especially the way Gnus does it.
5424
5425 Let's say you are reading article 1, which is short, and article 2 is
5426 quite long, and you are not interested in reading that.  Gnus does not
5427 know this, so it goes ahead and fetches article 2.  You decide to read
5428 article 3, but since Gnus is in the process of fetching article 2, the
5429 connection is blocked.
5430
5431 To avoid these situations, Gnus will open two (count 'em two)
5432 connections to the server.  Some people may think this isn't a very nice
5433 thing to do, but I don't see any real alternatives.  Setting up that
5434 extra connection takes some time, so Gnus startup will be slower.
5435
5436 Gnus will fetch more articles than you will read.  This will mean that
5437 the link between your machine and the @sc{nntp} server will become more
5438 loaded than if you didn't use article pre-fetch.  The server itself will
5439 also become more loaded---both with the extra article requests, and the
5440 extra connection.
5441
5442 Ok, so now you know that you shouldn't really use this thing...  unless
5443 you really want to.
5444
5445 @vindex gnus-asynchronous
5446 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5447 happen automatically.
5448
5449 @vindex gnus-use-article-prefetch
5450 You can control how many articles are to be pre-fetched by setting
5451 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5452 that when you read an article in the group, the backend will pre-fetch
5453 the next 30 articles.  If this variable is @code{t}, the backend will
5454 pre-fetch all the articles it can without bound.  If it is
5455 @code{nil}, no pre-fetching will be done.
5456
5457 @vindex gnus-async-prefetch-article-p
5458 @findex gnus-async-read-p
5459 There are probably some articles that you don't want to pre-fetch---read
5460 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5461 return non-@code{nil} when the article in question is to be
5462 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5463 @code{nil} on read articles.  The function is called with an article
5464 data structure as the only parameter.
5465
5466 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5467
5468 @lisp
5469 (defun my-async-short-unread-p (data)
5470   "Return non-nil for short, unread articles."
5471   (and (gnus-data-unread-p data)
5472        (< (mail-header-lines (gnus-data-header data))
5473           100)))
5474
5475 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5476 @end lisp
5477
5478 These functions will be called many, many times, so they should
5479 preferably be short and sweet to avoid slowing down Gnus too much.
5480 It's probably a good idea to byte-compile things like this.
5481
5482 @vindex gnus-prefetched-article-deletion-strategy
5483 Articles have to be removed from the asynch buffer sooner or later.  The
5484 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5485 articles.  This is a list that may contain the following elements:
5486
5487 @table @code
5488 @item read
5489 Remove articles when they are read.
5490
5491 @item exit
5492 Remove articles when exiting the group.
5493 @end table
5494
5495 The default value is @code{(read exit)}.
5496
5497 @c @vindex gnus-use-header-prefetch
5498 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5499 @c from the next group.
5500
5501
5502 @node Article Caching
5503 @section Article Caching
5504 @cindex article caching
5505 @cindex caching
5506
5507 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5508 consider turning article caching on.  Each article will then be stored
5509 locally under your home directory.  As you may surmise, this could
5510 potentially use @emph{huge} amounts of disk space, as well as eat up all
5511 your inodes so fast it will make your head swim.  In vodka.
5512
5513 Used carefully, though, it could be just an easier way to save articles.
5514
5515 @vindex gnus-use-long-file-name
5516 @vindex gnus-cache-directory
5517 @vindex gnus-use-cache
5518 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5519 all articles ticked or marked as dormant will then be copied
5520 over to your local cache (@code{gnus-cache-directory}).  Whether this
5521 cache is flat or hierarchal is controlled by the
5522 @code{gnus-use-long-file-name} variable, as usual.
5523
5524 When re-selecting a ticked or dormant article, it will be fetched from the
5525 cache instead of from the server.  As articles in your cache will never
5526 expire, this might serve as a method of saving articles while still
5527 keeping them where they belong.  Just mark all articles you want to save
5528 as dormant, and don't worry.
5529
5530 When an article is marked as read, is it removed from the cache.
5531
5532 @vindex gnus-cache-remove-articles
5533 @vindex gnus-cache-enter-articles
5534 The entering/removal of articles from the cache is controlled by the
5535 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5536 variables.  Both are lists of symbols.  The first is @code{(ticked
5537 dormant)} by default, meaning that ticked and dormant articles will be
5538 put in the cache.  The latter is @code{(read)} by default, meaning that
5539 articles marked as read are removed from the cache.  Possibly
5540 symbols in these two lists are @code{ticked}, @code{dormant},
5541 @code{unread} and @code{read}.
5542
5543 @findex gnus-jog-cache
5544 So where does the massive article-fetching and storing come into the
5545 picture?  The @code{gnus-jog-cache} command will go through all
5546 subscribed newsgroups, request all unread articles, score them, and
5547 store them in the cache.  You should only ever, ever ever ever, use this
5548 command if 1) your connection to the @sc{nntp} server is really, really,
5549 really slow and 2) you have a really, really, really huge disk.
5550 Seriously.  One way to cut down on the number of articles downloaded is
5551 to score unwanted articles down and have them marked as read.  They will
5552 not then be downloaded by this command.
5553
5554 @vindex gnus-uncacheable-groups
5555 @vindex gnus-cacheable-groups
5556 It is likely that you do not want caching on all groups.  For instance,
5557 if your @code{nnml} mail is located under your home directory, it makes no
5558 sense to cache it somewhere else under your home directory.  Unless you
5559 feel that it's neat to use twice as much space.
5560
5561 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5562 regexp of groups to cache, @samp{^nntp} for instance, or set the
5563 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5564 Both variables are @code{nil} by default. If a group matches both
5565 variables, the group is not cached.
5566
5567 @findex gnus-cache-generate-nov-databases
5568 @findex gnus-cache-generate-active
5569 @vindex gnus-cache-active-file
5570 The cache stores information on what articles it contains in its active
5571 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5572 of the cache) becomes all messed up for some reason or other, Gnus
5573 offers two functions that will try to set things right.  @kbd{M-x
5574 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5575 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5576 file.
5577
5578
5579 @node Persistent Articles
5580 @section Persistent Articles
5581 @cindex persistent articles
5582
5583 Closely related to article caching, we have @dfn{persistent articles}.
5584 In fact, it's just a different way of looking at caching, and much more
5585 useful in my opinion.
5586
5587 Say you're reading a newsgroup, and you happen on to some valuable gem
5588 that you want to keep and treasure forever.  You'd normally just save it
5589 (using one of the many saving commands) in some file.  The problem with
5590 that is that it's just, well, yucky.  Ideally you'd prefer just having
5591 the article remain in the group where you found it forever; untouched by
5592 the expiry going on at the news server.
5593
5594 This is what a @dfn{persistent article} is---an article that just won't
5595 be deleted.  It's implemented using the normal cache functions, but
5596 you use two explicit commands for managing persistent articles:
5597
5598 @table @kbd
5599
5600 @item *
5601 @kindex * (Summary)
5602 @findex gnus-cache-enter-article
5603 Make the current article persistent (@code{gnus-cache-enter-article}).
5604
5605 @item M-*
5606 @kindex M-* (Summary)
5607 @findex gnus-cache-remove-article
5608 Remove the current article from the persistent articles
5609 (@code{gnus-cache-remove-article}).  This will normally delete the
5610 article.
5611 @end table
5612
5613 Both these commands understand the process/prefix convention.
5614
5615 To avoid having all ticked articles (and stuff) entered into the cache,
5616 you should set @code{gnus-use-cache} to @code{passive} if you're just
5617 interested in persistent articles:
5618
5619 @lisp
5620 (setq gnus-use-cache 'passive)
5621 @end lisp
5622
5623
5624 @node Article Backlog
5625 @section Article Backlog
5626 @cindex backlog
5627 @cindex article backlog
5628
5629 If you have a slow connection, but the idea of using caching seems
5630 unappealing to you (and it is, really), you can help the situation some
5631 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5632 already read articles so that it doesn't have to re-fetch articles
5633 you've already read.  This only helps if you are in the habit of
5634 re-selecting articles you've recently read, of course.  If you never do
5635 that, turning the backlog on will slow Gnus down a little bit, and
5636 increase memory usage some.
5637
5638 @vindex gnus-keep-backlog
5639 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5640 at most @var{n} old articles in a buffer for later re-fetching.  If this
5641 variable is non-@code{nil} and is not a number, Gnus will store
5642 @emph{all} read articles, which means that your Emacs will grow without
5643 bound before exploding and taking your machine down with you.  I put
5644 that in there just to keep y'all on your toes.
5645
5646 This variable is @code{nil} by default.
5647
5648
5649 @node Saving Articles
5650 @section Saving Articles
5651 @cindex saving articles
5652
5653 Gnus can save articles in a number of ways.  Below is the documentation
5654 for saving articles in a fairly straight-forward fashion (i.e., little
5655 processing of the article is done before it is saved).  For a different
5656 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5657 (@pxref{Decoding Articles}).
5658
5659 @vindex gnus-save-all-headers
5660 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5661 unwanted headers before saving the article.
5662
5663 @vindex gnus-saved-headers
5664 If the preceding variable is @code{nil}, all headers that match the
5665 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5666 deleted before saving.
5667
5668 @table @kbd
5669
5670 @item O o
5671 @itemx o
5672 @kindex O o (Summary)
5673 @kindex o (Summary)
5674 @findex gnus-summary-save-article
5675 @c @icon{gnus-summary-save-article}
5676 Save the current article using the default article saver
5677 (@code{gnus-summary-save-article}).
5678
5679 @item O m
5680 @kindex O m (Summary)
5681 @findex gnus-summary-save-article-mail
5682 Save the current article in mail format
5683 (@code{gnus-summary-save-article-mail}).
5684
5685 @item O r
5686 @kindex O r (Summary)
5687 @findex gnus-summary-save-article-rmail
5688 Save the current article in rmail format
5689 (@code{gnus-summary-save-article-rmail}).
5690
5691 @item O f
5692 @kindex O f (Summary)
5693 @findex gnus-summary-save-article-file
5694 @c @icon{gnus-summary-save-article-file}
5695 Save the current article in plain file format
5696 (@code{gnus-summary-save-article-file}).
5697
5698 @item O F
5699 @kindex O F (Summary)
5700 @findex gnus-summary-write-article-file
5701 Write the current article in plain file format, overwriting any previous
5702 file contents (@code{gnus-summary-write-article-file}).
5703
5704 @item O b
5705 @kindex O b (Summary)
5706 @findex gnus-summary-save-article-body-file
5707 Save the current article body in plain file format
5708 (@code{gnus-summary-save-article-body-file}).
5709
5710 @item O h
5711 @kindex O h (Summary)
5712 @findex gnus-summary-save-article-folder
5713 Save the current article in mh folder format
5714 (@code{gnus-summary-save-article-folder}).
5715
5716 @item O v
5717 @kindex O v (Summary)
5718 @findex gnus-summary-save-article-vm
5719 Save the current article in a VM folder
5720 (@code{gnus-summary-save-article-vm}).
5721
5722 @item O p
5723 @kindex O p (Summary)
5724 @findex gnus-summary-pipe-output
5725 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5726 the current article to a process (@code{gnus-summary-pipe-output}).
5727 @end table
5728
5729 @vindex gnus-prompt-before-saving
5730 All these commands use the process/prefix convention
5731 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5732 functions, you might get tired of being prompted for files to save each
5733 and every article in.  The prompting action is controlled by
5734 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5735 default, giving you that excessive prompting action you know and
5736 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5737 just once for each series of articles you save.  If you like to really
5738 have Gnus do all your thinking for you, you can even set this variable
5739 to @code{nil}, which means that you will never be prompted for files to
5740 save articles in.  Gnus will simply save all the articles in the default
5741 files.
5742
5743
5744 @vindex gnus-default-article-saver
5745 You can customize the @code{gnus-default-article-saver} variable to make
5746 Gnus do what you want it to.  You can use any of the six ready-made
5747 functions below, or you can create your own.
5748
5749 @table @code
5750
5751 @item gnus-summary-save-in-rmail
5752 @findex gnus-summary-save-in-rmail
5753 @vindex gnus-rmail-save-name
5754 @findex gnus-plain-save-name
5755 This is the default format, @dfn{babyl}.  Uses the function in the
5756 @code{gnus-rmail-save-name} variable to get a file name to save the
5757 article in.  The default is @code{gnus-plain-save-name}.
5758
5759 @item gnus-summary-save-in-mail
5760 @findex gnus-summary-save-in-mail
5761 @vindex gnus-mail-save-name
5762 Save in a Unix mail (mbox) file.  Uses the function in the
5763 @code{gnus-mail-save-name} variable to get a file name to save the
5764 article in.  The default is @code{gnus-plain-save-name}.
5765
5766 @item gnus-summary-save-in-file
5767 @findex gnus-summary-save-in-file
5768 @vindex gnus-file-save-name
5769 @findex gnus-numeric-save-name
5770 Append the article straight to an ordinary file.  Uses the function in
5771 the @code{gnus-file-save-name} variable to get a file name to save the
5772 article in.  The default is @code{gnus-numeric-save-name}.
5773
5774 @item gnus-summary-save-body-in-file
5775 @findex gnus-summary-save-body-in-file
5776 Append the article body to an ordinary file.  Uses the function in the
5777 @code{gnus-file-save-name} variable to get a file name to save the
5778 article in.  The default is @code{gnus-numeric-save-name}.
5779
5780 @item gnus-summary-save-in-folder
5781 @findex gnus-summary-save-in-folder
5782 @findex gnus-folder-save-name
5783 @findex gnus-Folder-save-name
5784 @vindex gnus-folder-save-name
5785 @cindex rcvstore
5786 @cindex MH folders
5787 Save the article to an MH folder using @code{rcvstore} from the MH
5788 library.  Uses the function in the @code{gnus-folder-save-name} variable
5789 to get a file name to save the article in.  The default is
5790 @code{gnus-folder-save-name}, but you can also use
5791 @code{gnus-Folder-save-name}, which creates capitalized names.
5792
5793 @item gnus-summary-save-in-vm
5794 @findex gnus-summary-save-in-vm
5795 Save the article in a VM folder.  You have to have the VM mail
5796 reader to use this setting.
5797 @end table
5798
5799 @vindex gnus-article-save-directory
5800 All of these functions, except for the last one, will save the article
5801 in the @code{gnus-article-save-directory}, which is initialized from the
5802 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5803 default.
5804
5805 As you can see above, the functions use different functions to find a
5806 suitable name of a file to save the article in.  Below is a list of
5807 available functions that generate names:
5808
5809 @table @code
5810
5811 @item gnus-Numeric-save-name
5812 @findex gnus-Numeric-save-name
5813 File names like @file{~/News/Alt.andrea-dworkin/45}.
5814
5815 @item gnus-numeric-save-name
5816 @findex gnus-numeric-save-name
5817 File names like @file{~/News/alt.andrea-dworkin/45}.
5818
5819 @item gnus-Plain-save-name
5820 @findex gnus-Plain-save-name
5821 File names like @file{~/News/Alt.andrea-dworkin}.
5822
5823 @item gnus-plain-save-name
5824 @findex gnus-plain-save-name
5825 File names like @file{~/News/alt.andrea-dworkin}.
5826 @end table
5827
5828 @vindex gnus-split-methods
5829 You can have Gnus suggest where to save articles by plonking a regexp into
5830 the @code{gnus-split-methods} alist.  For instance, if you would like to
5831 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5832 related to VM in @code{vm-stuff}, you could set this variable to something
5833 like:
5834
5835 @lisp
5836 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5837  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5838  (my-choosing-function "../other-dir/my-stuff")
5839  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5840 @end lisp
5841
5842 We see that this is a list where each element is a list that has two
5843 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5844 a string (in which case it is used as a regexp to match on the article
5845 head); it can be a symbol (which will be called as a function with the
5846 group name as a parameter); or it can be a list (which will be
5847 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5848 the @dfn{file} will be used as a default prompt.  In addition, the
5849 result of the operation itself will be used if the function or form
5850 called returns a string or a list of strings.
5851
5852 You basically end up with a list of file names that might be used when
5853 saving the current article.  (All ``matches'' will be used.)  You will
5854 then be prompted for what you really want to use as a name, with file
5855 name completion over the results from applying this variable.
5856
5857 This variable is @code{((gnus-article-archive-name))} by default, which
5858 means that Gnus will look at the articles it saves for an
5859 @code{Archive-name} line and use that as a suggestion for the file
5860 name.
5861
5862 Here's an example function to clean up file names somewhat.  If you have
5863 lots of mail groups called things like
5864 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5865 these group names before creating the file name to save to.  The
5866 following will do just that:
5867
5868 @lisp
5869 (defun my-save-name (group)
5870   (when (string-match "^nnml:mail." group)
5871     (substring group (match-end 0))))
5872
5873 (setq gnus-split-methods
5874       '((gnus-article-archive-name)
5875         (my-save-name)))
5876 @end lisp
5877
5878
5879 @vindex gnus-use-long-file-name
5880 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5881 @code{nil}, all the preceding functions will replace all periods
5882 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5883 the functions will generate hierarchies of directories instead of having
5884 all the files in the top level directory
5885 (@file{~/News/alt/andrea-dworkin} instead of
5886 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5887 on most systems.  However, for historical reasons, this is @code{nil} on
5888 Xenix and usg-unix-v machines by default.
5889
5890 This function also affects kill and score file names.  If this variable
5891 is a list, and the list contains the element @code{not-score}, long file
5892 names will not be used for score files, if it contains the element
5893 @code{not-save}, long file names will not be used for saving, and if it
5894 contains the element @code{not-kill}, long file names will not be used
5895 for kill files.
5896
5897 If you'd like to save articles in a hierarchy that looks something like
5898 a spool, you could
5899
5900 @lisp
5901 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5902 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5903 @end lisp
5904
5905 Then just save with @kbd{o}.  You'd then read this hierarchy with
5906 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5907 the top level directory as the argument (@file{~/News/}).  Then just walk
5908 around to the groups/directories with @code{nneething}.
5909
5910
5911 @node Decoding Articles
5912 @section Decoding Articles
5913 @cindex decoding articles
5914
5915 Sometime users post articles (or series of articles) that have been
5916 encoded in some way or other.  Gnus can decode them for you.
5917
5918 @menu
5919 * Uuencoded Articles::    Uudecode articles.
5920 * Shell Archives::        Unshar articles.
5921 * PostScript Files::      Split PostScript.
5922 * Other Files::           Plain save and binhex.
5923 * Decoding Variables::    Variables for a happy decoding.
5924 * Viewing Files::         You want to look at the result of the decoding?
5925 @end menu
5926
5927 @cindex series
5928 @cindex article series
5929 All these functions use the process/prefix convention
5930 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5931 the extension that a ``single article'' means ``a single series''.  Gnus
5932 can find out by itself what articles belong to a series, decode all the
5933 articles and unpack/view/save the resulting file(s).
5934
5935 Gnus guesses what articles are in the series according to the following
5936 simplish rule: The subjects must be (nearly) identical, except for the
5937 last two numbers of the line.  (Spaces are largely ignored, however.)
5938
5939 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5940 will find all the articles that match the regexp @samp{^cat.gif
5941 ([0-9]+/[0-9]+).*$}.
5942
5943 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5944 series}, will not be properly recognized by any of the automatic viewing
5945 commands, and you have to mark the articles manually with @kbd{#}.
5946
5947
5948 @node Uuencoded Articles
5949 @subsection Uuencoded Articles
5950 @cindex uudecode
5951 @cindex uuencoded articles
5952
5953 @table @kbd
5954
5955 @item X u
5956 @kindex X u (Summary)
5957 @findex gnus-uu-decode-uu
5958 @c @icon{gnus-uu-decode-uu}
5959 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5960
5961 @item X U
5962 @kindex X U (Summary)
5963 @findex gnus-uu-decode-uu-and-save
5964 Uudecodes and saves the current series
5965 (@code{gnus-uu-decode-uu-and-save}).
5966
5967 @item X v u
5968 @kindex X v u (Summary)
5969 @findex gnus-uu-decode-uu-view
5970 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5971
5972 @item X v U
5973 @kindex X v U (Summary)
5974 @findex gnus-uu-decode-uu-and-save-view
5975 Uudecodes, views and saves the current series
5976 (@code{gnus-uu-decode-uu-and-save-view}).
5977
5978 @end table
5979
5980 Remember that these all react to the presence of articles marked with
5981 the process mark.  If, for instance, you'd like to decode and save an
5982 entire newsgroup, you'd typically do @kbd{M P a}
5983 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5984 (@code{gnus-uu-decode-uu-and-save}).
5985
5986 All this is very much different from how @code{gnus-uu} worked with
5987 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5988 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5989 articles in some way (@pxref{Setting Process Marks}) and then press
5990 @kbd{X u}.
5991
5992 @vindex gnus-uu-notify-files
5993 Note: When trying to decode articles that have names matching
5994 @code{gnus-uu-notify-files}, which is hard-coded to
5995 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5996 automatically post an article on @samp{comp.unix.wizards} saying that
5997 you have just viewed the file in question.  This feature can't be turned
5998 off.
5999
6000
6001 @node Shell Archives
6002 @subsection Shell Archives
6003 @cindex unshar
6004 @cindex shell archives
6005 @cindex shared articles
6006
6007 Shell archives (``shar files'') used to be a popular way to distribute
6008 sources, but it isn't used all that much today.  In any case, we have
6009 some commands to deal with these:
6010
6011 @table @kbd
6012
6013 @item X s
6014 @kindex X s (Summary)
6015 @findex gnus-uu-decode-unshar
6016 Unshars the current series (@code{gnus-uu-decode-unshar}).
6017
6018 @item X S
6019 @kindex X S (Summary)
6020 @findex gnus-uu-decode-unshar-and-save
6021 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6022
6023 @item X v s
6024 @kindex X v s (Summary)
6025 @findex gnus-uu-decode-unshar-view
6026 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6027
6028 @item X v S
6029 @kindex X v S (Summary)
6030 @findex gnus-uu-decode-unshar-and-save-view
6031 Unshars, views and saves the current series
6032 (@code{gnus-uu-decode-unshar-and-save-view}).
6033 @end table
6034
6035
6036 @node PostScript Files
6037 @subsection PostScript Files
6038 @cindex PostScript
6039
6040 @table @kbd
6041
6042 @item X p
6043 @kindex X p (Summary)
6044 @findex gnus-uu-decode-postscript
6045 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6046
6047 @item X P
6048 @kindex X P (Summary)
6049 @findex gnus-uu-decode-postscript-and-save
6050 Unpack and save the current PostScript series
6051 (@code{gnus-uu-decode-postscript-and-save}).
6052
6053 @item X v p
6054 @kindex X v p (Summary)
6055 @findex gnus-uu-decode-postscript-view
6056 View the current PostScript series
6057 (@code{gnus-uu-decode-postscript-view}).
6058
6059 @item X v P
6060 @kindex X v P (Summary)
6061 @findex gnus-uu-decode-postscript-and-save-view
6062 View and save the current PostScript series
6063 (@code{gnus-uu-decode-postscript-and-save-view}).
6064 @end table
6065
6066
6067 @node Other Files
6068 @subsection Other Files
6069
6070 @table @kbd
6071 @item X o
6072 @kindex X o (Summary)
6073 @findex gnus-uu-decode-save
6074 Save the current series
6075 (@code{gnus-uu-decode-save}).
6076
6077 @item X b
6078 @kindex X b (Summary)
6079 @findex gnus-uu-decode-binhex
6080 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
6081 doesn't really work yet.
6082 @end table
6083
6084
6085 @node Decoding Variables
6086 @subsection Decoding Variables
6087
6088 Adjective, not verb.
6089
6090 @menu
6091 * Rule Variables::          Variables that say how a file is to be viewed.
6092 * Other Decode Variables::  Other decode variables.
6093 * Uuencoding and Posting::  Variables for customizing uuencoding.
6094 @end menu
6095
6096
6097 @node Rule Variables
6098 @subsubsection Rule Variables
6099 @cindex rule variables
6100
6101 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
6102 variables are of the form
6103
6104 @lisp
6105       (list '(regexp1 command2)
6106             '(regexp2 command2)
6107             ...)
6108 @end lisp
6109
6110 @table @code
6111
6112 @item gnus-uu-user-view-rules
6113 @vindex gnus-uu-user-view-rules
6114 @cindex sox
6115 This variable is consulted first when viewing files.  If you wish to use,
6116 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6117 say something like:
6118 @lisp
6119 (setq gnus-uu-user-view-rules
6120       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6121 @end lisp
6122
6123 @item gnus-uu-user-view-rules-end
6124 @vindex gnus-uu-user-view-rules-end
6125 This variable is consulted if Gnus couldn't make any matches from the
6126 user and default view rules.
6127
6128 @item gnus-uu-user-archive-rules
6129 @vindex gnus-uu-user-archive-rules
6130 This variable can be used to say what commands should be used to unpack
6131 archives.
6132 @end table
6133
6134
6135 @node Other Decode Variables
6136 @subsubsection Other Decode Variables
6137
6138 @table @code
6139 @vindex gnus-uu-grabbed-file-functions
6140
6141 @item gnus-uu-grabbed-file-functions
6142 All functions in this list will be called right after each file has been
6143 successfully decoded---so that you can move or view files right away,
6144 and don't have to wait for all files to be decoded before you can do
6145 anything.  Ready-made functions you can put in this list are:
6146
6147 @table @code
6148
6149 @item gnus-uu-grab-view
6150 @findex gnus-uu-grab-view
6151 View the file.
6152
6153 @item gnus-uu-grab-move
6154 @findex gnus-uu-grab-move
6155 Move the file (if you're using a saving function.)
6156 @end table
6157
6158 @item gnus-uu-be-dangerous
6159 @vindex gnus-uu-be-dangerous
6160 Specifies what to do if unusual situations arise during decoding.  If
6161 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
6162 that didn't work, and overwrite existing files.  Otherwise, ask each
6163 time.
6164
6165 @item gnus-uu-ignore-files-by-name
6166 @vindex gnus-uu-ignore-files-by-name
6167 Files with name matching this regular expression won't be viewed.
6168
6169 @item gnus-uu-ignore-files-by-type
6170 @vindex gnus-uu-ignore-files-by-type
6171 Files with a @sc{mime} type matching this variable won't be viewed.
6172 Note that Gnus tries to guess what type the file is based on the name.
6173 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6174 kludgey.
6175
6176 @item gnus-uu-tmp-dir
6177 @vindex gnus-uu-tmp-dir
6178 Where @code{gnus-uu} does its work.
6179
6180 @item gnus-uu-do-not-unpack-archives
6181 @vindex gnus-uu-do-not-unpack-archives
6182 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6183 looking for files to display.
6184
6185 @item gnus-uu-view-and-save
6186 @vindex gnus-uu-view-and-save
6187 Non-@code{nil} means that the user will always be asked to save a file
6188 after viewing it.
6189
6190 @item gnus-uu-ignore-default-view-rules
6191 @vindex gnus-uu-ignore-default-view-rules
6192 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6193 rules.
6194
6195 @item gnus-uu-ignore-default-archive-rules
6196 @vindex gnus-uu-ignore-default-archive-rules
6197 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6198 unpacking commands.
6199
6200 @item gnus-uu-kill-carriage-return
6201 @vindex gnus-uu-kill-carriage-return
6202 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6203 from articles.
6204
6205 @item gnus-uu-unmark-articles-not-decoded
6206 @vindex gnus-uu-unmark-articles-not-decoded
6207 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6208 decoded articles as unread.
6209
6210 @item gnus-uu-correct-stripped-uucode
6211 @vindex gnus-uu-correct-stripped-uucode
6212 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6213 uuencoded files that have had trailing spaces deleted.
6214
6215 @item gnus-uu-pre-uudecode-hook
6216 @vindex gnus-uu-pre-uudecode-hook
6217 Hook run before sending a message to @code{uudecode}.
6218
6219 @item gnus-uu-view-with-metamail
6220 @vindex gnus-uu-view-with-metamail
6221 @cindex metamail
6222 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6223 commands defined by the rule variables and just fudge a @sc{mime}
6224 content type based on the file name.  The result will be fed to
6225 @code{metamail} for viewing.
6226
6227 @item gnus-uu-save-in-digest
6228 @vindex gnus-uu-save-in-digest
6229 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6230 decoding, will save in digests.  If this variable is @code{nil},
6231 @code{gnus-uu} will just save everything in a file without any
6232 embellishments.  The digesting almost conforms to RFC1153---no easy way
6233 to specify any meaningful volume and issue numbers were found, so I
6234 simply dropped them.
6235
6236 @end table
6237
6238
6239 @node Uuencoding and Posting
6240 @subsubsection Uuencoding and Posting
6241
6242 @table @code
6243
6244 @item gnus-uu-post-include-before-composing
6245 @vindex gnus-uu-post-include-before-composing
6246 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6247 before you compose the article.  If this variable is @code{t}, you can
6248 either include an encoded file with @kbd{C-c C-i} or have one included
6249 for you when you post the article.
6250
6251 @item gnus-uu-post-length
6252 @vindex gnus-uu-post-length
6253 Maximum length of an article.  The encoded file will be split into how
6254 many articles it takes to post the entire file.
6255
6256 @item gnus-uu-post-threaded
6257 @vindex gnus-uu-post-threaded
6258 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6259 thread.  This may not be smart, as no other decoder I have seen is able
6260 to follow threads when collecting uuencoded articles.  (Well, I have
6261 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6262 think that counts...) Default is @code{nil}.
6263
6264 @item gnus-uu-post-separate-description
6265 @vindex gnus-uu-post-separate-description
6266 Non-@code{nil} means that the description will be posted in a separate
6267 article.  The first article will typically be numbered (0/x).  If this
6268 variable is @code{nil}, the description the user enters will be included
6269 at the beginning of the first article, which will be numbered (1/x).
6270 Default is @code{t}.
6271
6272 @end table
6273
6274
6275 @node Viewing Files
6276 @subsection Viewing Files
6277 @cindex viewing files
6278 @cindex pseudo-articles
6279
6280 After decoding, if the file is some sort of archive, Gnus will attempt
6281 to unpack the archive and see if any of the files in the archive can be
6282 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
6283 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6284 uncompress and de-tar the main file, and then view the two pictures.
6285 This unpacking process is recursive, so if the archive contains archives
6286 of archives, it'll all be unpacked.
6287
6288 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6289 extracted file into the summary buffer.  If you go to these
6290 ``articles'', you will be prompted for a command to run (usually Gnus
6291 will make a suggestion), and then the command will be run.
6292
6293 @vindex gnus-view-pseudo-asynchronously
6294 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6295 until the viewing is done before proceeding.
6296
6297 @vindex gnus-view-pseudos
6298 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6299 the pseudo-articles into the summary buffer, but view them
6300 immediately.  If this variable is @code{not-confirm}, the user won't even
6301 be asked for a confirmation before viewing is done.
6302
6303 @vindex gnus-view-pseudos-separately
6304 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6305 pseudo-article will be created for each file to be viewed.  If
6306 @code{nil}, all files that use the same viewing command will be given as
6307 a list of parameters to that command.
6308
6309 @vindex gnus-insert-pseudo-articles
6310 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6311 pseudo-articles when decoding.  It is @code{t} by default.
6312
6313 So; there you are, reading your @emph{pseudo-articles} in your
6314 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6315 Why isn't anything real anymore? How did we get here?
6316
6317
6318 @node Article Treatment
6319 @section Article Treatment
6320
6321 Reading through this huge manual, you may have quite forgotten that the
6322 object of newsreaders is to actually, like, read what people have
6323 written.  Reading articles.  Unfortunately, people are quite bad at
6324 writing, so there are tons of functions and variables to make reading
6325 these articles easier.
6326
6327 @menu
6328 * Article Highlighting::    You want to make the article look like fruit salad.
6329 * Article Fontisizing::     Making emphasized text look nice.
6330 * Article Hiding::          You also want to make certain info go away.
6331 * Article Washing::         Lots of way-neat functions to make life better.
6332 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6333 * Article Date::            Grumble, UT!
6334 * Article Signature::       What is a signature?
6335 * Article Miscellania::     Various other stuff.
6336 @end menu
6337
6338
6339 @node Article Highlighting
6340 @subsection Article Highlighting
6341 @cindex highlighting
6342
6343 Not only do you want your article buffer to look like fruit salad, but
6344 you want it to look like technicolor fruit salad.
6345
6346 @table @kbd
6347
6348 @item W H a
6349 @kindex W H a (Summary)
6350 @findex gnus-article-highlight
6351 @findex gnus-article-maybe-highlight
6352 Do much highlighting of the current article
6353 (@code{gnus-article-highlight}).  This function highlights header, cited
6354 text, the signature, and adds buttons to the body and the head.
6355
6356 @item W H h
6357 @kindex W H h (Summary)
6358 @findex gnus-article-highlight-headers
6359 @vindex gnus-header-face-alist
6360 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6361 highlighting will be done according to the @code{gnus-header-face-alist}
6362 variable, which is a list where each element has the form
6363 @code{(@var{regexp} @var{name} @var{content})}.
6364 @var{regexp} is a regular expression for matching the
6365 header, @var{name} is the face used for highlighting the header name
6366 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6367 the header value.  The first match made will be used.  Note that
6368 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6369
6370 @item W H c
6371 @kindex W H c (Summary)
6372 @findex gnus-article-highlight-citation
6373 Highlight cited text (@code{gnus-article-highlight-citation}).
6374
6375 Some variables to customize the citation highlights:
6376
6377 @table @code
6378 @vindex gnus-cite-parse-max-size
6379
6380 @item gnus-cite-parse-max-size
6381 If the article size if bigger than this variable (which is 25000 by
6382 default), no citation highlighting will be performed.
6383
6384 @item gnus-cite-prefix-regexp
6385 @vindex gnus-cite-prefix-regexp
6386 Regexp matching the longest possible citation prefix on a line.
6387
6388 @item gnus-cite-max-prefix
6389 @vindex gnus-cite-max-prefix
6390 Maximum possible length for a citation prefix (default 20).
6391
6392 @item gnus-cite-face-list
6393 @vindex gnus-cite-face-list
6394 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6395 When there are citations from multiple articles in the same message,
6396 Gnus will try to give each citation from each article its own face.
6397 This should make it easier to see who wrote what.
6398
6399 @item gnus-supercite-regexp
6400 @vindex gnus-supercite-regexp
6401 Regexp matching normal Supercite attribution lines.
6402
6403 @item gnus-supercite-secondary-regexp
6404 @vindex gnus-supercite-secondary-regexp
6405 Regexp matching mangled Supercite attribution lines.
6406
6407 @item gnus-cite-minimum-match-count
6408 @vindex gnus-cite-minimum-match-count
6409 Minimum number of identical prefixes we have to see before we believe
6410 that it's a citation.
6411
6412 @item gnus-cite-attribution-prefix
6413 @vindex gnus-cite-attribution-prefix
6414 Regexp matching the beginning of an attribution line.
6415
6416 @item gnus-cite-attribution-suffix
6417 @vindex gnus-cite-attribution-suffix
6418 Regexp matching the end of an attribution line.
6419
6420 @item gnus-cite-attribution-face
6421 @vindex gnus-cite-attribution-face
6422 Face used for attribution lines.  It is merged with the face for the
6423 cited text belonging to the attribution.
6424
6425 @end table
6426
6427
6428 @item W H s
6429 @kindex W H s (Summary)
6430 @vindex gnus-signature-separator
6431 @vindex gnus-signature-face
6432 @findex gnus-article-highlight-signature
6433 Highlight the signature (@code{gnus-article-highlight-signature}).
6434 Everything after @code{gnus-signature-separator} (@pxref{Article
6435 Signature}) in an article will be considered a signature and will be
6436 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6437 default.
6438
6439 @end table
6440
6441 @xref{Customizing Articles}, for how to highlight articles automatically.
6442
6443
6444 @node Article Fontisizing
6445 @subsection Article Fontisizing
6446 @cindex emphasis
6447 @cindex article emphasis
6448
6449 @findex gnus-article-emphasize
6450 @kindex W e (Summary)
6451 People commonly add emphasis to words in news articles by writing things
6452 like @samp{_this_} or @samp{*this*} or @samp{/this/}.  Gnus can make
6453 this look nicer by running the article through the @kbd{W e}
6454 (@code{gnus-article-emphasize}) command.
6455
6456 @vindex gnus-emphasis-alist
6457 How the emphasis is computed is controlled by the
6458 @code{gnus-emphasis-alist} variable.  This is an alist where the first
6459 element is a regular expression to be matched.  The second is a number
6460 that says what regular expression grouping is used to find the entire
6461 emphasized word.  The third is a number that says what regexp grouping
6462 should be displayed and highlighted.  (The text between these two
6463 groupings will be hidden.)  The fourth is the face used for
6464 highlighting.
6465
6466 @lisp
6467 (setq gnus-article-emphasis
6468       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6469         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6470 @end lisp
6471
6472 @cindex slash
6473 @cindex asterisk
6474 @cindex underline
6475 @cindex /
6476 @cindex *
6477
6478 @vindex gnus-emphasis-underline
6479 @vindex gnus-emphasis-bold
6480 @vindex gnus-emphasis-italic
6481 @vindex gnus-emphasis-underline-bold
6482 @vindex gnus-emphasis-underline-italic
6483 @vindex gnus-emphasis-bold-italic
6484 @vindex gnus-emphasis-underline-bold-italic
6485 By default, there are seven rules, and they use the following faces:
6486 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6487 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6488 @code{gnus-emphasis-underline-italic},
6489 @code{gnus-emphasis-underline-bold}, and
6490 @code{gnus-emphasis-underline-bold-italic}.
6491
6492 If you want to change these faces, you can either use @kbd{M-x
6493 customize}, or you can use @code{copy-face}.  For instance, if you want
6494 to make @code{gnus-emphasis-italic} use a red face instead, you could
6495 say something like:
6496
6497 @lisp
6498 (copy-face 'red 'gnus-emphasis-italic)
6499 @end lisp
6500
6501 @vindex gnus-group-highlight-words-alist
6502
6503 If you want to highlight arbitrary words, you can use the
6504 @code{gnus-group-highlight-words-alist} variable, which uses the same
6505 syntax as @code{gnus-emphasis-alist}.  The @code{highlight-words} group
6506 parameter (@pxref{Group Parameters}) can also be used.
6507
6508 @xref{Customizing Articles}, for how to fontize articles automatically.
6509
6510
6511 @node Article Hiding
6512 @subsection Article Hiding
6513 @cindex article hiding
6514
6515 Or rather, hiding certain things in each article.  There usually is much
6516 too much cruft in most articles.
6517
6518 @table @kbd
6519
6520 @item W W a
6521 @kindex W W a (Summary)
6522 @findex gnus-article-hide
6523 Do quite a lot of hiding on the article buffer
6524 (@kbd{gnus-article-hide}).  In particular, this function will hide
6525 headers, PGP, cited text and the signature.
6526
6527 @item W W h
6528 @kindex W W h (Summary)
6529 @findex gnus-article-hide-headers
6530 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
6531 Headers}.
6532
6533 @item W W b
6534 @kindex W W b (Summary)
6535 @findex gnus-article-hide-boring-headers
6536 Hide headers that aren't particularly interesting
6537 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6538
6539 @item W W s
6540 @kindex W W s (Summary)
6541 @findex gnus-article-hide-signature
6542 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6543 Signature}.
6544
6545 @item W W l
6546 @kindex W W l (Summary)
6547 @findex gnus-article-hide-list-identifiers
6548 @vindex gnus-list-identifiers
6549 Hide list identifiers specified in @code{gnus-list-identifiers}. Theese
6550 are strings some list servers add to the beginning of all @code{Subject}
6551 headers---for example, @samp{[zebra 4711]}.
6552
6553 @table @code
6554
6555 @item gnus-list-identifiers
6556 @vindex gnus-list-identifiers
6557 A regular expression that matches list identifiers to be removed from
6558 subject. This can also be a list of regular expressions.
6559
6560 @end table
6561
6562 @item W W p
6563 @kindex W W p (Summary)
6564 @findex gnus-article-hide-pgp
6565 @vindex gnus-article-hide-pgp-hook
6566 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6567 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6568 signature has been hidden.  For example, to automatically verify
6569 articles that have signatures in them do:
6570 @lisp
6571 ;;; Hide pgp cruft if any.
6572
6573 (setq gnus-treat-strip-pgp t)
6574
6575 ;;; After hiding pgp, verify the message;
6576 ;;; only happens if pgp signature is found.
6577
6578 (add-hook 'gnus-article-hide-pgp-hook
6579           (lambda ()
6580             (save-excursion
6581               (set-buffer gnus-original-article-buffer)
6582               (mc-verify))))
6583 @end lisp
6584
6585 @item W W P
6586 @kindex W W P (Summary)
6587 @findex gnus-article-hide-pem
6588 Hide @sc{pem} (privacy enhanced messages) cruft
6589 (@code{gnus-article-hide-pem}).
6590
6591 @item W W B
6592 @kindex W W B (Summary)
6593 @findex gnus-article-strip-banner
6594 @cindex banner
6595 @cindex OneList
6596 @cindex stripping advertisments
6597 @cindex advertisments
6598 Strip the banner specified by the @code{banner} group parameter
6599 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
6600 annoying banners and/or signatures that some mailing lists and moderated
6601 groups adds to all the messages.  The way to use this function is to add
6602 the @code{banner} group parameter (@pxref{Group Parameters}) to the
6603 group you want banners stripped from.  The parameter either be a string,
6604 which will be interpreted as a regular expression matching text to be
6605 removed, or the symbol @code{signature}, meaning that the (last)
6606 signature should be removed.
6607
6608 @item W W c
6609 @kindex W W c (Summary)
6610 @findex gnus-article-hide-citation
6611 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6612 customizing the hiding:
6613
6614 @table @code
6615
6616 @item gnus-cited-opened-text-button-line-format
6617 @itemx gnus-cited-closed-text-button-line-format
6618 @vindex gnus-cited-closed-text-button-line-format
6619 @vindex gnus-cited-opened-text-button-line-format
6620 Gnus adds buttons to show where the cited text has been hidden, and to
6621 allow toggle hiding the text.  The format of the variable is specified
6622 by these format-like variable (@pxref{Formatting Variables}).  These
6623 specs are valid:
6624
6625 @table @samp
6626 @item b
6627 Starting point of the hidden text.
6628 @item e
6629 Ending point of the hidden text.
6630 @item l
6631 Number of characters in the hidden region.
6632 @item n
6633 Number of lines of hidden text.
6634 @end table
6635
6636 @item gnus-cited-lines-visible
6637 @vindex gnus-cited-lines-visible
6638 The number of lines at the beginning of the cited text to leave shown.
6639
6640 @end table
6641
6642 @item W W C-c
6643 @kindex W W C-c (Summary)
6644 @findex gnus-article-hide-citation-maybe
6645
6646 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6647 following two variables:
6648
6649 @table @code
6650 @item gnus-cite-hide-percentage
6651 @vindex gnus-cite-hide-percentage
6652 If the cited text is of a bigger percentage than this variable (default
6653 50), hide the cited text.
6654
6655 @item gnus-cite-hide-absolute
6656 @vindex gnus-cite-hide-absolute
6657 The cited text must have at least this length (default 10) before it
6658 is hidden.
6659 @end table
6660
6661 @item W W C
6662 @kindex W W C (Summary)
6663 @findex gnus-article-hide-citation-in-followups
6664 Hide cited text in articles that aren't roots
6665 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6666 useful as an interactive command, but might be a handy function to stick
6667 have happen automatically (@pxref{Customizing Articles}).
6668
6669 @end table
6670
6671 All these ``hiding'' commands are toggles, but if you give a negative
6672 prefix to these commands, they will show what they have previously
6673 hidden.  If you give a positive prefix, they will always hide.
6674
6675 Also @pxref{Article Highlighting} for further variables for
6676 citation customization.
6677
6678 @xref{Customizing Articles}, for how to hide article elements
6679 automatically.
6680
6681
6682 @node Article Washing
6683 @subsection Article Washing
6684 @cindex washing
6685 @cindex article washing
6686
6687 We call this ``article washing'' for a really good reason.  Namely, the
6688 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6689
6690 @dfn{Washing} is defined by us as ``changing something from something to
6691 something else'', but normally results in something looking better.
6692 Cleaner, perhaps.
6693
6694 @table @kbd
6695
6696 @item W l
6697 @kindex W l (Summary)
6698 @findex gnus-summary-stop-page-breaking
6699 Remove page breaks from the current article
6700 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
6701 delimiters.
6702
6703 @item W r
6704 @kindex W r (Summary)
6705 @findex gnus-summary-caesar-message
6706 @c @icon{gnus-summary-caesar-message}
6707 Do a Caesar rotate (rot13) on the article buffer
6708 (@code{gnus-summary-caesar-message}).
6709 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6710 (Typically offensive jokes and such.)
6711
6712 It's commonly called ``rot13'' because each letter is rotated 13
6713 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6714 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6715 is rumored to have employed this form of, uh, somewhat weak encryption.
6716
6717 @item W t
6718 @kindex W t (Summary)
6719 @findex gnus-summary-toggle-header
6720 Toggle whether to display all headers in the article buffer
6721 (@code{gnus-summary-toggle-header}).
6722
6723 @item W v
6724 @kindex W v (Summary)
6725 @findex gnus-summary-verbose-header
6726 Toggle whether to display all headers in the article buffer permanently
6727 (@code{gnus-summary-verbose-header}).
6728
6729 @item W o
6730 @kindex W o (Summary)
6731 @findex gnus-article-treat-overstrike
6732 Treat overstrike (@code{gnus-article-treat-overstrike}).
6733
6734 @item W d
6735 @kindex W d (Summary)
6736 @findex gnus-article-treat-dumbquotes
6737 @vindex gnus-article-dumbquotes-map
6738 @cindex Smartquotes
6739 @cindex M******** sm*rtq**t*s
6740 @cindex Latin 1
6741 Treat M******** sm*rtq**t*s according to
6742 @code{gnus-article-dumbquotes-map}
6743 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
6744 whether a character is a sm*rtq**t* or not, so it should only be used
6745 interactively.
6746
6747 @item W w
6748 @kindex W w (Summary)
6749 @findex gnus-article-fill-cited-article
6750 Do word wrap (@code{gnus-article-fill-cited-article}).
6751
6752 You can give the command a numerical prefix to specify the width to use
6753 when filling.
6754
6755 @item W Q
6756 @kindex W Q (Summary)
6757 @findex gnus-article-fill-long-lines 
6758 Fill long lines (@code{gnus-article-fill-long-lines}).
6759
6760 @item W C
6761 @kindex W C (Summary)
6762 @findex gnus-article-capitalize-sentences
6763 Capitalize the first word in each sentence
6764 (@code{gnus-article-capitalize-sentences}).
6765
6766 @item W c
6767 @kindex W c (Summary)
6768 @findex gnus-article-remove-cr
6769 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6770 (this takes care of DOS line endings), and then translate any remaining
6771 CRs into LF (this takes care of Mac line endings)
6772 (@code{gnus-article-remove-cr}).
6773
6774 @item W q
6775 @kindex W q (Summary)
6776 @findex gnus-article-de-quoted-unreadable
6777 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6778 Quoted-Printable is one common @sc{mime} encoding employed when sending
6779 non-ASCII (i. e., 8-bit) articles.  It typically makes strings like
6780 @samp{d\e-Aéjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very\e$)A
6781 readable to me.  Note that the this is usually done automatically by
6782 Gnus if the message in question has a @code{Content-Transfer-Encoding}
6783 header that says that this encoding has been done.
6784
6785 @item W f
6786 @kindex W f (Summary)
6787 @cindex x-face
6788 @findex gnus-article-display-x-face
6789 @findex gnus-article-x-face-command
6790 @vindex gnus-article-x-face-command
6791 @vindex gnus-article-x-face-too-ugly
6792 @iftex
6793 @iflatex
6794 \include{xface}
6795 @end iflatex
6796 @end iftex
6797 Look for and display any X-Face headers
6798 (@code{gnus-article-display-x-face}).  The command executed by this
6799 function is given by the @code{gnus-article-x-face-command} variable.
6800 If this variable is a string, this string will be executed in a
6801 sub-shell.  If it is a function, this function will be called with the
6802 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6803 is a regexp) matches the @code{From} header, the face will not be shown.
6804 The default action under Emacs is to fork off an @code{xv} to view the
6805 face; under XEmacs the default action is to display the face before the
6806 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6807 support---that will make display somewhat faster.  If there's no native
6808 X-Face support, Gnus will try to convert the @code{X-Face} header using
6809 external programs from the @code{pbmplus} package and friends.)  If you
6810 want to have this function in the display hook, it should probably come
6811 last.
6812
6813 @item W b
6814 @kindex W b (Summary)
6815 @findex gnus-article-add-buttons
6816 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6817 @xref{Article Buttons}.
6818
6819 @item W B
6820 @kindex W B (Summary)
6821 @findex gnus-article-add-buttons-to-head
6822 Add clickable buttons to the article headers
6823 (@code{gnus-article-add-buttons-to-head}).
6824
6825 @item W W H
6826 @kindex W W H (Summary)
6827 @findex gnus-article-strip-headers-from-body
6828 Strip headers like the @code{X-No-Archive} header from the beginning of
6829 article bodies (@code{gnus-article-strip-headers-from-body}).
6830
6831 @item W E l
6832 @kindex W E l (Summary)
6833 @findex gnus-article-strip-leading-blank-lines
6834 Remove all blank lines from the beginning of the article
6835 (@code{gnus-article-strip-leading-blank-lines}).
6836
6837 @item W E m
6838 @kindex W E m (Summary)
6839 @findex gnus-article-strip-multiple-blank-lines
6840 Replace all blank lines with empty lines and then all multiple empty
6841 lines with a single empty line.
6842 (@code{gnus-article-strip-multiple-blank-lines}).
6843
6844 @item W E t
6845 @kindex W E t (Summary)
6846 @findex gnus-article-remove-trailing-blank-lines
6847 Remove all blank lines at the end of the article
6848 (@code{gnus-article-remove-trailing-blank-lines}).
6849
6850 @item W E a
6851 @kindex W E a (Summary)
6852 @findex gnus-article-strip-blank-lines
6853 Do all the three commands above
6854 (@code{gnus-article-strip-blank-lines}).
6855
6856 @item W E A
6857 @kindex W E A (Summary)
6858 @findex gnus-article-strip-all-blank-lines
6859 Remove all blank lines
6860 (@code{gnus-article-strip-all-blank-lines}).
6861
6862 @item W E s
6863 @kindex W E s (Summary)
6864 @findex gnus-article-strip-leading-space
6865 Remove all white space from the beginning of all lines of the article
6866 body (@code{gnus-article-strip-leading-space}).
6867
6868 @item W E e
6869 @kindex W E e (Summary)
6870 @findex gnus-article-strip-trailing-space
6871 Remove all white space from the end of all lines of the article
6872 body (@code{gnus-article-strip-trailing-space}).
6873
6874 @end table
6875
6876 @xref{Customizing Articles}, for how to wash articles automatically.
6877
6878
6879 @node Article Buttons
6880 @subsection Article Buttons
6881 @cindex buttons
6882
6883 People often include references to other stuff in articles, and it would
6884 be nice if Gnus could just fetch whatever it is that people talk about
6885 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6886 button on these references.
6887
6888 Gnus adds @dfn{buttons} to certain standard references by default:
6889 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6890 two variables, one that handles article bodies and one that handles
6891 article heads:
6892
6893 @table @code
6894
6895 @item gnus-button-alist
6896 @vindex gnus-button-alist
6897 This is an alist where each entry has this form:
6898
6899 @lisp
6900 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6901 @end lisp
6902
6903 @table @var
6904
6905 @item regexp
6906 All text that match this regular expression will be considered an
6907 external reference.  Here's a typical regexp that matches embedded URLs:
6908 @samp{<URL:\\([^\n\r>]*\\)>}.
6909
6910 @item button-par
6911 Gnus has to know which parts of the matches is to be highlighted.  This
6912 is a number that says what sub-expression of the regexp is to be
6913 highlighted.  If you want it all highlighted, you use 0 here.
6914
6915 @item use-p
6916 This form will be @code{eval}ed, and if the result is non-@code{nil},
6917 this is considered a match.  This is useful if you want extra sifting to
6918 avoid false matches.
6919
6920 @item function
6921 This function will be called when you click on this button.
6922
6923 @item data-par
6924 As with @var{button-par}, this is a sub-expression number, but this one
6925 says which part of the match is to be sent as data to @var{function}.
6926
6927 @end table
6928
6929 So the full entry for buttonizing URLs is then
6930
6931 @lisp
6932 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6933 @end lisp
6934
6935 @item gnus-header-button-alist
6936 @vindex gnus-header-button-alist
6937 This is just like the other alist, except that it is applied to the
6938 article head only, and that each entry has an additional element that is
6939 used to say what headers to apply the buttonize coding to:
6940
6941 @lisp
6942 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6943 @end lisp
6944
6945 @var{header} is a regular expression.
6946
6947 @item gnus-button-url-regexp
6948 @vindex gnus-button-url-regexp
6949 A regular expression that matches embedded URLs.  It is used in the
6950 default values of the variables above.
6951
6952 @item gnus-article-button-face
6953 @vindex gnus-article-button-face
6954 Face used on buttons.
6955
6956 @item gnus-article-mouse-face
6957 @vindex gnus-article-mouse-face
6958 Face used when the mouse cursor is over a button.
6959
6960 @end table
6961
6962 @xref{Customizing Articles}, for how to buttonize articles automatically.
6963
6964
6965 @node Article Date
6966 @subsection Article Date
6967
6968 The date is most likely generated in some obscure timezone you've never
6969 heard of, so it's quite nice to be able to find out what the time was
6970 when the article was sent.
6971
6972 @table @kbd
6973
6974 @item W T u
6975 @kindex W T u (Summary)
6976 @findex gnus-article-date-ut
6977 Display the date in UT (aka. GMT, aka ZULU)
6978 (@code{gnus-article-date-ut}).
6979
6980 @item W T i
6981 @kindex W T i (Summary)
6982 @findex gnus-article-date-iso8601
6983 @cindex ISO 8601
6984 Display the date in international format, aka. ISO 8601
6985 (@code{gnus-article-date-iso8601}).
6986
6987 @item W T l
6988 @kindex W T l (Summary)
6989 @findex gnus-article-date-local
6990 Display the date in the local timezone (@code{gnus-article-date-local}).
6991
6992 @item W T s
6993 @kindex W T s (Summary)
6994 @vindex gnus-article-time-format
6995 @findex gnus-article-date-user
6996 @findex format-time-string
6997 Display the date using a user-defined format
6998 (@code{gnus-article-date-user}).  The format is specified by the
6999 @code{gnus-article-time-format} variable, and is a string that's passed
7000 to @code{format-time-string}.  See the documentation of that variable
7001 for a list of possible format specs.
7002
7003 @item W T e
7004 @kindex W T e (Summary)
7005 @findex gnus-article-date-lapsed
7006 @findex gnus-start-date-timer
7007 @findex gnus-stop-date-timer
7008 Say how much time has elapsed between the article was posted and now
7009 (@code{gnus-article-date-lapsed}).  It looks something like:
7010
7011 @example
7012 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
7013 @end example
7014
7015 The value of @code{gnus-article-date-lapsed-new-header} determines
7016 whether this header will just be added below the old Date one, or will
7017 replace it.
7018
7019 An advantage of using Gnus to read mail is that it converts simple bugs
7020 into wonderful absurdities.
7021
7022 If you want to have this line updated continually, you can put
7023
7024 @lisp
7025 (gnus-start-date-timer)
7026 @end lisp
7027
7028 in your @file{.gnus.el} file, or you can run it off of some hook.  If
7029 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
7030 command.
7031
7032 @item W T o
7033 @kindex W T o (Summary)
7034 @findex gnus-article-date-original
7035 Display the original date (@code{gnus-article-date-original}).  This can
7036 be useful if you normally use some other conversion function and are
7037 worried that it might be doing something totally wrong.  Say, claiming
7038 that the article was posted in 1854.  Although something like that is
7039 @emph{totally} impossible.  Don't you trust me? *titter*
7040
7041 @end table
7042
7043 @xref{Customizing Articles}, for how to display the date in your
7044 preferred format automatically.
7045
7046
7047 @node Article Signature
7048 @subsection Article Signature
7049 @cindex signatures
7050 @cindex article signature
7051
7052 @vindex gnus-signature-separator
7053 Each article is divided into two parts---the head and the body.  The
7054 body can be divided into a signature part and a text part.  The variable
7055 that says what is to be considered a signature is
7056 @code{gnus-signature-separator}.  This is normally the standard
7057 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
7058 non-standard signature separators, so this variable can also be a list
7059 of regular expressions to be tested, one by one.  (Searches are done
7060 from the end of the body towards the beginning.)  One likely value is:
7061
7062 @lisp
7063 (setq gnus-signature-separator
7064       '("^-- $"         ; The standard
7065         "^-- *$"        ; A common mangling
7066         "^-------*$"    ; Many people just use a looong
7067                         ; line of dashes.  Shame!
7068         "^ *--------*$" ; Double-shame!
7069         "^________*$"   ; Underscores are also popular
7070         "^========*$")) ; Pervert!
7071 @end lisp
7072
7073 The more permissive you are, the more likely it is that you'll get false
7074 positives.
7075
7076 @vindex gnus-signature-limit
7077 @code{gnus-signature-limit} provides a limit to what is considered a
7078 signature when displaying articles.
7079
7080 @enumerate
7081 @item
7082 If it is an integer, no signature may be longer (in characters) than
7083 that integer.
7084 @item
7085 If it is a floating point number, no signature may be longer (in lines)
7086 than that number.
7087 @item
7088 If it is a function, the function will be called without any parameters,
7089 and if it returns @code{nil}, there is no signature in the buffer.
7090 @item
7091 If it is a string, it will be used as a regexp.  If it matches, the text
7092 in question is not a signature.
7093 @end enumerate
7094
7095 This variable can also be a list where the elements may be of the types
7096 listed above.  Here's an example:
7097
7098 @lisp
7099 (setq gnus-signature-limit
7100       '(200.0 "^---*Forwarded article"))
7101 @end lisp
7102
7103 This means that if there are more than 200 lines after the signature
7104 separator, or the text after the signature separator is matched by
7105 the regular expression @samp{^---*Forwarded article}, then it isn't a
7106 signature after all.
7107
7108
7109 @node Article Miscellania
7110 @subsection Article Miscellania
7111
7112 @table @kbd
7113 @item A t
7114 @kindex A t (Summary)
7115 @findex gnus-article-babel
7116 Translate the article from one language to another
7117 (@code{gnus-article-babel}). 
7118
7119 @end table
7120
7121
7122 @node MIME Commands
7123 @section @sc{mime} Commands
7124 @cindex MIME decoding
7125
7126 The following commands all understand the numerical prefix.  For
7127 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
7128
7129 @table @kbd
7130 @item b
7131 @itemx K b
7132 @kindex b (Summary)
7133 @kindex K b (Summary)
7134 View the @sc{mime} part.
7135
7136 @item K o
7137 @kindex K o (Summary)
7138 Save the @sc{mime} part.
7139
7140 @item K c
7141 @kindex K c (Summary)
7142 Copy the @sc{mime} part.
7143
7144 @item K e
7145 @kindex K e (Summary)
7146 View the @sc{mime} part externally.
7147
7148 @item K i
7149 @kindex K i (Summary)
7150 View the @sc{mime} part internally.
7151
7152 @item K |
7153 @kindex K | (Summary)
7154 Pipe the @sc{mime} part to an external command.
7155 @end table
7156
7157 The rest of these @sc{mime} commands do not use the numerical prefix in
7158 the same manner:
7159
7160 @table @kbd
7161 @item K b
7162 @kindex K b (Summary)
7163 Make all the @sc{mime} parts have buttons in from of them.
7164
7165 @item K m
7166 @kindex K m (Summary)
7167 Some multipart messages are transmitted with missing or faulty headers.
7168 This command will attempt to ``repair'' these messages so that they can
7169 be viewed in a more pleasant manner.
7170
7171 @item X m
7172 @kindex X m (Summary)
7173 @findex gnus-summary-save-parts
7174 Save all parts matching a @sc{mime} type to a directory
7175 (@code{gnus-summary-save-parts}).  Understands the process/prefix
7176 convention (@pxref{Process/Prefix}).
7177
7178 @item M-t
7179 @kindex M-t (Summary)
7180 @findex gnus-summary-display-buttonized
7181 Toggle the buttonized display of the article buffer
7182 (@code{gnus-summary-toggle-display-buttonized}).
7183
7184 @item W M w
7185 @kindex W M w (Summary)
7186 Decode RFC2047-encoded words in the article headers
7187 (@code{gnus-article-decode-mime-words}).
7188
7189 @item W M c
7190 @kindex W M c (Summary)
7191 Decode encoded article bodies as well as charsets
7192 (@code{gnus-article-decode-charset}).
7193
7194 This command looks in the @code{Content-Type} header to determine the
7195 charset.  If there is no such header in the article, you can give it a
7196 prefix, which will prompt for the charset to decode as.  In regional
7197 groups where people post using some common encoding (but do not include
7198 MIME headers), you can set the @code{charset} group/topic parameter to
7199 the required charset (@pxref{Group Parameters}).
7200
7201 @item W M v
7202 @kindex W M v (Summary)
7203 View all the @sc{mime} parts in the current article
7204 (@code{gnus-mime-view-all-parts}).
7205
7206 @end table
7207
7208 Relevant variables:
7209
7210 @table @code
7211 @item gnus-ignored-mime-types
7212 @vindex gnus-ignored-mime-types
7213 This is a list of regexps.  @sc{mime} types that match a regexp from
7214 this list will be completely ignored by Gnus.  The default value is
7215 @code{nil}.
7216
7217 To have all Vcards be ignored, you'd say something like this:
7218
7219 @lisp
7220 (setq gnus-ignored-mime-types
7221       '("text/x-vcard"))
7222 @end lisp
7223
7224 @item gnus-unbuttonized-mime-types
7225 @vindex gnus-unbuttonized-mime-types
7226 This is a list of regexps.  @sc{mime} types that match a regexp from
7227 this list won't have @sc{mime} buttons inserted unless they aren't
7228 displayed.  The default value is @code{(".*/.*")}.
7229
7230 @item gnus-article-mime-part-function
7231 @vindex gnus-article-mime-part-function
7232 For each @sc{mime} part, this function will be called with the @sc{mime}
7233 handle as the parameter.  The function is meant to be used to allow
7234 users to gather information from the article (e. g., add Vcard info to
7235 the bbdb database) or to do actions based on parts (e. g., automatically
7236 save all jpegs into some directory).
7237
7238 Here's an example function the does the latter:
7239
7240 @lisp
7241 (defun my-save-all-jpeg-parts (handle)
7242   (when (equal (car (mm-handle-type handle)) "image/jpeg")
7243     (with-temp-buffer
7244       (insert (mm-get-part handle))
7245       (write-region (point-min) (point-max)
7246                     (read-file-name "Save jpeg to: ")))))
7247 (setq gnus-article-mime-part-function
7248       'my-save-all-jpeg-parts)
7249 @end lisp
7250
7251 @vindex gnus-mime-multipart-functions
7252 @item gnus-mime-multipart-functions
7253 Alist of @sc{mime} multipart types and functions to handle them.
7254
7255 @end table
7256
7257
7258 @node Charsets
7259 @section Charsets
7260 @cindex charsets
7261
7262 People use different charsets, and we have @sc{mime} to let us know what
7263 charsets they use.  Or rather, we wish we had.  Many people use
7264 newsreaders and mailers that do not understand or use @sc{mime}, and
7265 just send out messages without saying what character sets they use.  To
7266 help a bit with this, some local news hierarchies have policies that say
7267 what character set is the default.  For instance, the @samp{fj}
7268 hierarchy uses @code{iso-2022-jp-2}.
7269
7270 @vindex gnus-group-charset-alist
7271 This knowledge is encoded in the @code{gnus-group-charset-alist}
7272 variable, which is an alist of regexps (to match group names) and
7273 default charsets to be used when reading these groups.
7274
7275 In addition, some people do use soi-disant @sc{mime}-aware agents that
7276 aren't.  These blitely mark messages as being in @code{iso-8859-1} even
7277 if they really are in @code{koi-8}.  To help here, the
7278 @code{gnus-newsgroup-ignored-charsets} variable can be used.  The
7279 charsets that are listed here will be ignored.  The variable can be set
7280 on a group-by-group basis using the group parameters (@pxref{Group
7281 Parameters}).  The default value is @code{(unknown-8bit)}, which is
7282 something some agents insist on having in there.
7283
7284
7285 @node Article Commands
7286 @section Article Commands
7287
7288 @table @kbd
7289
7290 @item A P
7291 @cindex PostScript
7292 @cindex printing
7293 @kindex A P (Summary)
7294 @vindex gnus-ps-print-hook
7295 @findex gnus-summary-print-article
7296 Generate and print a PostScript image of the article buffer
7297 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
7298 run just before printing the buffer.
7299
7300 @end table
7301
7302
7303 @node Summary Sorting
7304 @section Summary Sorting
7305 @cindex summary sorting
7306
7307 You can have the summary buffer sorted in various ways, even though I
7308 can't really see why you'd want that.
7309
7310 @table @kbd
7311
7312 @item C-c C-s C-n
7313 @kindex C-c C-s C-n (Summary)
7314 @findex gnus-summary-sort-by-number
7315 Sort by article number (@code{gnus-summary-sort-by-number}).
7316
7317 @item C-c C-s C-a
7318 @kindex C-c C-s C-a (Summary)
7319 @findex gnus-summary-sort-by-author
7320 Sort by author (@code{gnus-summary-sort-by-author}).
7321
7322 @item C-c C-s C-s
7323 @kindex C-c C-s C-s (Summary)
7324 @findex gnus-summary-sort-by-subject
7325 Sort by subject (@code{gnus-summary-sort-by-subject}).
7326
7327 @item C-c C-s C-d
7328 @kindex C-c C-s C-d (Summary)
7329 @findex gnus-summary-sort-by-date
7330 Sort by date (@code{gnus-summary-sort-by-date}).
7331
7332 @item C-c C-s C-l
7333 @kindex C-c C-s C-l (Summary)
7334 @findex gnus-summary-sort-by-lines
7335 Sort by lines (@code{gnus-summary-sort-by-lines}).
7336
7337 @item C-c C-s C-c
7338 @kindex C-c C-s C-c (Summary)
7339 @findex gnus-summary-sort-by-chars
7340 Sort by article length (@code{gnus-summary-sort-by-chars}).
7341
7342 @item C-c C-s C-i
7343 @kindex C-c C-s C-i (Summary)
7344 @findex gnus-summary-sort-by-score
7345 Sort by score (@code{gnus-summary-sort-by-score}).
7346 @end table
7347
7348 These functions will work both when you use threading and when you don't
7349 use threading.  In the latter case, all summary lines will be sorted,
7350 line by line.  In the former case, sorting will be done on a
7351 root-by-root basis, which might not be what you were looking for.  To
7352 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7353 Commands}).
7354
7355
7356 @node Finding the Parent
7357 @section Finding the Parent
7358 @cindex parent articles
7359 @cindex referring articles
7360
7361 @table @kbd
7362 @item ^
7363 @kindex ^ (Summary)
7364 @findex gnus-summary-refer-parent-article
7365 If you'd like to read the parent of the current article, and it is not
7366 displayed in the summary buffer, you might still be able to.  That is,
7367 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7368 and the @code{References} in the current article are not mangled, you
7369 can just press @kbd{^} or @kbd{A r}
7370 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
7371 you'll get the parent.  If the parent is already displayed in the
7372 summary buffer, point will just move to this article.
7373
7374 If given a positive numerical prefix, fetch that many articles back into
7375 the ancestry.  If given a negative numerical prefix, fetch just that
7376 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
7377 grandparent and the grandgrandparent of the current article.  If you say
7378 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
7379 article.
7380
7381 @item A R (Summary)
7382 @findex gnus-summary-refer-references
7383 @kindex A R (Summary)
7384 Fetch all articles mentioned in the @code{References} header of the
7385 article (@code{gnus-summary-refer-references}).
7386
7387 @item A T (Summary)
7388 @findex gnus-summary-refer-thread
7389 @kindex A T (Summary)
7390 Display the full thread where the current article appears
7391 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
7392 headers in the current group to work, so it usually takes a while.  If
7393 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7394 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
7395 visible effects normally, but it'll make this command work a whole lot
7396 faster.  Of course, it'll make group entry somewhat slow.
7397
7398 @vindex gnus-refer-thread-limit
7399 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7400 articles before the first displayed in the current group) headers to
7401 fetch when doing this command.  The default is 200.  If @code{t}, all
7402 the available headers will be fetched.  This variable can be overridden
7403 by giving the @kbd{A T} command a numerical prefix.
7404
7405 @item M-^ (Summary)
7406 @findex gnus-summary-refer-article
7407 @kindex M-^ (Summary)
7408 @cindex Message-ID
7409 @cindex fetching by Message-ID
7410 You can also ask the @sc{nntp} server for an arbitrary article, no
7411 matter what group it belongs to.  @kbd{M-^}
7412 (@code{gnus-summary-refer-article}) will ask you for a
7413 @code{Message-ID}, which is one of those long, hard-to-read thingies
7414 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
7415 have to get it all exactly right.  No fuzzy searches, I'm afraid.
7416 @end table
7417
7418 The current select method will be used when fetching by
7419 @code{Message-ID} from non-news select method, but you can override this
7420 by giving this command a prefix.
7421
7422 @vindex gnus-refer-article-method
7423 If the group you are reading is located on a backend that does not
7424 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7425 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
7426 would, perhaps, be best if the @sc{nntp} server you consult is the one
7427 updating the spool you are reading from, but that's not really
7428 necessary.
7429
7430 It can also be a list of select methods, as well as the special symbol
7431 @code{current}, which means to use the current select method.  If it
7432 is a list, Gnus will try all the methods in the list until it finds a
7433 match.
7434
7435 Here's an example setting that will first try the current method, and
7436 then ask Deja if that fails:
7437
7438 @lisp
7439 (setq gnus-refer-article-method
7440       '(current
7441         (nnweb "refer" (nnweb-type dejanews))))
7442 @end lisp
7443
7444 Most of the mail backends support fetching by @code{Message-ID}, but do
7445 not do a particularly excellent job at it.  That is, @code{nnmbox} and
7446 @code{nnbabyl} are able to locate articles from any groups, while
7447 @code{nnml} and @code{nnfolder} are only able to locate articles that
7448 have been posted to the current group.  (Anything else would be too time
7449 consuming.)  @code{nnmh} does not support this at all.
7450
7451
7452 @node Alternative Approaches
7453 @section Alternative Approaches
7454
7455 Different people like to read news using different methods.  This being
7456 Gnus, we offer a small selection of minor modes for the summary buffers.
7457
7458 @menu
7459 * Pick and Read::               First mark articles and then read them.
7460 * Binary Groups::               Auto-decode all articles.
7461 @end menu
7462
7463
7464 @node Pick and Read
7465 @subsection Pick and Read
7466 @cindex pick and read
7467
7468 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7469 a two-phased reading interface.  The user first marks in a summary
7470 buffer the articles she wants to read.  Then she starts reading the
7471 articles with just an article buffer displayed.
7472
7473 @findex gnus-pick-mode
7474 @kindex M-x gnus-pick-mode
7475 Gnus provides a summary buffer minor mode that allows
7476 this---@code{gnus-pick-mode}.  This basically means that a few process
7477 mark commands become one-keystroke commands to allow easy marking, and
7478 it provides one additional command for switching to the summary buffer.
7479
7480 Here are the available keystrokes when using pick mode:
7481
7482 @table @kbd
7483 @item .
7484 @kindex . (Pick)
7485 @findex gnus-pick-article-or-thread
7486 Pick the article or thread on the current line
7487 (@code{gnus-pick-article-or-thread}).  If the variable
7488 @code{gnus-thread-hide-subtree} is true, then this key selects the
7489 entire thread when used at the first article of the thread.  Otherwise,
7490 it selects just the article. If given a numerical prefix, go to that
7491 thread or article and pick it.  (The line number is normally displayed
7492 at the beginning of the summary pick lines.)
7493
7494 @item SPACE
7495 @kindex SPACE (Pick)
7496 @findex gnus-pick-next-page
7497 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
7498 at the end of the buffer, start reading the picked articles.
7499
7500 @item u
7501 @kindex u (Pick)
7502 @findex gnus-pick-unmark-article-or-thread.
7503 Unpick the thread or article
7504 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
7505 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7506 thread if used at the first article of the thread.  Otherwise it unpicks
7507 just the article.  You can give this key a numerical prefix to unpick
7508 the thread or article at that line.
7509
7510 @item RET
7511 @kindex RET (Pick)
7512 @findex gnus-pick-start-reading
7513 @vindex gnus-pick-display-summary
7514 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
7515 given a prefix, mark all unpicked articles as read first.  If
7516 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7517 will still be visible when you are reading.
7518
7519 @end table
7520
7521 All the normal summary mode commands are still available in the
7522 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
7523 which is mapped to the same function
7524 @code{gnus-summary-tick-article-forward}.
7525
7526 If this sounds like a good idea to you, you could say:
7527
7528 @lisp
7529 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7530 @end lisp
7531
7532 @vindex gnus-pick-mode-hook
7533 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7534
7535 @vindex gnus-mark-unpicked-articles-as-read
7536 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7537 all unpicked articles as read.  The default is @code{nil}.
7538
7539 @vindex gnus-summary-pick-line-format
7540 The summary line format in pick mode is slightly different from the
7541 standard format.  At the beginning of each line the line number is
7542 displayed.  The pick mode line format is controlled by the
7543 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7544 Variables}).  It accepts the same format specs that
7545 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7546
7547
7548 @node Binary Groups
7549 @subsection Binary Groups
7550 @cindex binary groups
7551
7552 @findex gnus-binary-mode
7553 @kindex M-x gnus-binary-mode
7554 If you spend much time in binary groups, you may grow tired of hitting
7555 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
7556 is a minor mode for summary buffers that makes all ordinary Gnus article
7557 selection functions uudecode series of articles and display the result
7558 instead of just displaying the articles the normal way.
7559
7560 @kindex g (Binary)
7561 @findex gnus-binary-show-article
7562 The only way, in fact, to see the actual articles is the @kbd{g}
7563 command, when you have turned on this mode
7564 (@code{gnus-binary-show-article}).
7565
7566 @vindex gnus-binary-mode-hook
7567 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7568
7569
7570 @node Tree Display
7571 @section Tree Display
7572 @cindex trees
7573
7574 @vindex gnus-use-trees
7575 If you don't like the normal Gnus summary display, you might try setting
7576 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
7577 additional @dfn{tree buffer}.  You can execute all summary mode commands
7578 in the tree buffer.
7579
7580 There are a few variables to customize the tree display, of course:
7581
7582 @table @code
7583 @item gnus-tree-mode-hook
7584 @vindex gnus-tree-mode-hook
7585 A hook called in all tree mode buffers.
7586
7587 @item gnus-tree-mode-line-format
7588 @vindex gnus-tree-mode-line-format
7589 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7590 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
7591 of valid specs, @pxref{Summary Buffer Mode Line}.
7592
7593 @item gnus-selected-tree-face
7594 @vindex gnus-selected-tree-face
7595 Face used for highlighting the selected article in the tree buffer.  The
7596 default is @code{modeline}.
7597
7598 @item gnus-tree-line-format
7599 @vindex gnus-tree-line-format
7600 A format string for the tree nodes.  The name is a bit of a misnomer,
7601 though---it doesn't define a line, but just the node.  The default value
7602 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7603 the name of the poster.  It is vital that all nodes are of the same
7604 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7605
7606 Valid specs are:
7607
7608 @table @samp
7609 @item n
7610 The name of the poster.
7611 @item f
7612 The @code{From} header.
7613 @item N
7614 The number of the article.
7615 @item [
7616 The opening bracket.
7617 @item ]
7618 The closing bracket.
7619 @item s
7620 The subject.
7621 @end table
7622
7623 @xref{Formatting Variables}.
7624
7625 Variables related to the display are:
7626
7627 @table @code
7628 @item gnus-tree-brackets
7629 @vindex gnus-tree-brackets
7630 This is used for differentiating between ``real'' articles and
7631 ``sparse'' articles.  The format is @code{((@var{real-open} . @var{real-close})
7632 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
7633 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7634
7635 @item gnus-tree-parent-child-edges
7636 @vindex gnus-tree-parent-child-edges
7637 This is a list that contains the characters used for connecting parent
7638 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
7639
7640 @end table
7641
7642 @item gnus-tree-minimize-window
7643 @vindex gnus-tree-minimize-window
7644 If this variable is non-@code{nil}, Gnus will try to keep the tree
7645 buffer as small as possible to allow more room for the other Gnus
7646 windows.  If this variable is a number, the tree buffer will never be
7647 higher than that number.  The default is @code{t}.  Note that if you
7648 have several windows displayed side-by-side in a frame and the tree
7649 buffer is one of these, minimizing the tree window will also resize all
7650 other windows displayed next to it.
7651
7652 @item gnus-generate-tree-function
7653 @vindex gnus-generate-tree-function
7654 @findex gnus-generate-horizontal-tree
7655 @findex gnus-generate-vertical-tree
7656 The function that actually generates the thread tree.  Two predefined
7657 functions are available: @code{gnus-generate-horizontal-tree} and
7658 @code{gnus-generate-vertical-tree} (which is the default).
7659
7660 @end table
7661
7662 Here's an example from a horizontal tree buffer:
7663
7664 @example
7665 @{***@}-(***)-[odd]-[Gun]
7666      |      \[Jan]
7667      |      \[odd]-[Eri]
7668      |      \(***)-[Eri]
7669      |            \[odd]-[Paa]
7670      \[Bjo]
7671      \[Gun]
7672      \[Gun]-[Jor]
7673 @end example
7674
7675 Here's the same thread displayed in a vertical tree buffer:
7676
7677 @example
7678 @{***@}
7679   |--------------------------\-----\-----\
7680 (***)                         [Bjo] [Gun] [Gun]
7681   |--\-----\-----\                          |
7682 [odd] [Jan] [odd] (***)                   [Jor]
7683   |           |     |--\
7684 [Gun]       [Eri] [Eri] [odd]
7685                           |
7686                         [Paa]
7687 @end example
7688
7689 If you're using horizontal trees, it might be nice to display the trees
7690 side-by-side with the summary buffer.  You could add something like the
7691 following to your @file{.gnus.el} file:
7692
7693 @lisp
7694 (setq gnus-use-trees t
7695       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7696       gnus-tree-minimize-window nil)
7697 (gnus-add-configuration
7698  '(article
7699    (vertical 1.0
7700              (horizontal 0.25
7701                          (summary 0.75 point)
7702                          (tree 1.0))
7703              (article 1.0))))
7704 @end lisp
7705
7706 @xref{Windows Configuration}.
7707
7708
7709 @node Mail Group Commands
7710 @section Mail Group Commands
7711 @cindex mail group commands
7712
7713 Some commands only make sense in mail groups.  If these commands are
7714 invalid in the current group, they will raise a hell and let you know.
7715
7716 All these commands (except the expiry and edit commands) use the
7717 process/prefix convention (@pxref{Process/Prefix}).
7718
7719 @table @kbd
7720
7721 @item B e
7722 @kindex B e (Summary)
7723 @findex gnus-summary-expire-articles
7724 Expire all expirable articles in the group
7725 (@code{gnus-summary-expire-articles}).
7726
7727 @item B M-C-e
7728 @kindex B M-C-e (Summary)
7729 @findex gnus-summary-expire-articles-now
7730 Delete all the expirable articles in the group
7731 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7732 articles eligible for expiry in the current group will
7733 disappear forever into that big @file{/dev/null} in the sky.
7734
7735 @item B DEL
7736 @kindex B DEL (Summary)
7737 @findex gnus-summary-delete-article
7738 @c @icon{gnus-summary-mail-delete}
7739 Delete the mail article.  This is ``delete'' as in ``delete it from your
7740 disk forever and ever, never to return again.'' Use with caution.
7741 (@code{gnus-summary-delete-article}).
7742
7743 @item B m
7744 @kindex B m (Summary)
7745 @cindex move mail
7746 @findex gnus-summary-move-article
7747 Move the article from one mail group to another
7748 (@code{gnus-summary-move-article}).
7749
7750 @item B c
7751 @kindex B c (Summary)
7752 @cindex copy mail
7753 @findex gnus-summary-copy-article
7754 @c @icon{gnus-summary-mail-copy}
7755 Copy the article from one group (mail group or not) to a mail group
7756 (@code{gnus-summary-copy-article}).
7757
7758 @item B B
7759 @kindex B B (Summary)
7760 @cindex crosspost mail
7761 @findex gnus-summary-crosspost-article
7762 Crosspost the current article to some other group
7763 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7764 the article in the other group, and the Xref headers of the article will
7765 be properly updated.
7766
7767 @item B i
7768 @kindex B i (Summary)
7769 @findex gnus-summary-import-article
7770 Import an arbitrary file into the current mail newsgroup
7771 (@code{gnus-summary-import-article}).  You will be prompted for a file
7772 name, a @code{From} header and a @code{Subject} header.
7773
7774 @item B r
7775 @kindex B r (Summary)
7776 @findex gnus-summary-respool-article
7777 Respool the mail article (@code{gnus-summary-respool-article}).
7778 @code{gnus-summary-respool-default-method} will be used as the default
7779 select method when respooling.  This variable is @code{nil} by default,
7780 which means that the current group select method will be used instead.
7781
7782 @item B w
7783 @itemx e
7784 @kindex B w (Summary)
7785 @kindex e (Summary)
7786 @findex gnus-summary-edit-article
7787 @kindex C-c C-c (Article)
7788 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7789 editing and make the changes permanent, type @kbd{C-c C-c}
7790 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7791 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7792
7793 @item B q
7794 @kindex B q (Summary)
7795 @findex gnus-summary-respool-query
7796 If you want to re-spool an article, you might be curious as to what group
7797 the article will end up in before you do the re-spooling.  This command
7798 will tell you (@code{gnus-summary-respool-query}).
7799
7800 @item B t
7801 @kindex B t (Summary)
7802 @findex gnus-summary-respool-trace
7803 Similarly, this command will display all fancy splitting patterns used
7804 when repooling, if any (@code{gnus-summary-respool-trace}).
7805
7806 @item B p
7807 @kindex B p (Summary)
7808 @findex gnus-summary-article-posted-p
7809 Some people have a tendency to send you "courtesy" copies when they
7810 follow up to articles you have posted.  These usually have a
7811 @code{Newsgroups} header in them, but not always.  This command
7812 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7813 article from your news server (or rather, from
7814 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7815 report back whether it found the article or not.  Even if it says that
7816 it didn't find the article, it may have been posted anyway---mail
7817 propagation is much faster than news propagation, and the news copy may
7818 just not have arrived yet.
7819
7820 @end table
7821
7822 @vindex gnus-move-split-methods
7823 @cindex moving articles
7824 If you move (or copy) articles regularly, you might wish to have Gnus
7825 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7826 variable that uses the same syntax as @code{gnus-split-methods}
7827 (@pxref{Saving Articles}).  You may customize that variable to create
7828 suggestions you find reasonable.
7829
7830 @lisp
7831 (setq gnus-move-split-methods
7832       '(("^From:.*Lars Magne" "nnml:junk")
7833         ("^Subject:.*gnus" "nnfolder:important")
7834         (".*" "nnml:misc")))
7835 @end lisp
7836
7837
7838 @node Various Summary Stuff
7839 @section Various Summary Stuff
7840
7841 @menu
7842 * Summary Group Information::         Information oriented commands.
7843 * Searching for Articles::            Multiple article commands.
7844 * Summary Generation Commands::       (Re)generating the summary buffer.
7845 * Really Various Summary Commands::   Those pesky non-conformant commands.
7846 @end menu
7847
7848 @table @code
7849 @vindex gnus-summary-mode-hook
7850 @item gnus-summary-mode-hook
7851 This hook is called when creating a summary mode buffer.
7852
7853 @vindex gnus-summary-generate-hook
7854 @item gnus-summary-generate-hook
7855 This is called as the last thing before doing the threading and the
7856 generation of the summary buffer.  It's quite convenient for customizing
7857 the threading variables based on what data the newsgroup has.  This hook
7858 is called from the summary buffer after most summary buffer variables
7859 have been set.
7860
7861 @vindex gnus-summary-prepare-hook
7862 @item gnus-summary-prepare-hook
7863 It is called after the summary buffer has been generated.  You might use
7864 it to, for instance, highlight lines or modify the look of the buffer in
7865 some other ungodly manner.  I don't care.
7866
7867 @vindex gnus-summary-prepared-hook
7868 @item gnus-summary-prepared-hook
7869 A hook called as the very last thing after the summary buffer has been
7870 generated.
7871
7872 @vindex gnus-summary-ignore-duplicates
7873 @item gnus-summary-ignore-duplicates
7874 When Gnus discovers two articles that have the same @code{Message-ID},
7875 it has to do something drastic.  No articles are allowed to have the
7876 same @code{Message-ID}, but this may happen when reading mail from some
7877 sources.  Gnus allows you to customize what happens with this variable.
7878 If it is @code{nil} (which is the default), Gnus will rename the
7879 @code{Message-ID} (for display purposes only) and display the article as
7880 any other article.  If this variable is @code{t}, it won't display the
7881 article---it'll be as if it never existed.
7882
7883 @end table
7884
7885
7886 @node Summary Group Information
7887 @subsection Summary Group Information
7888
7889 @table @kbd
7890
7891 @item H f
7892 @kindex H f (Summary)
7893 @findex gnus-summary-fetch-faq
7894 @vindex gnus-group-faq-directory
7895 Try to fetch the FAQ (list of frequently asked questions) for the
7896 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7897 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7898 on a remote machine.  This variable can also be a list of directories.
7899 In that case, giving a prefix to this command will allow you to choose
7900 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7901 be used for fetching the file.
7902
7903 @item H d
7904 @kindex H d (Summary)
7905 @findex gnus-summary-describe-group
7906 Give a brief description of the current group
7907 (@code{gnus-summary-describe-group}).  If given a prefix, force
7908 rereading the description from the server.
7909
7910 @item H h
7911 @kindex H h (Summary)
7912 @findex gnus-summary-describe-briefly
7913 Give an extremely brief description of the most important summary
7914 keystrokes (@code{gnus-summary-describe-briefly}).
7915
7916 @item H i
7917 @kindex H i (Summary)
7918 @findex gnus-info-find-node
7919 Go to the Gnus info node (@code{gnus-info-find-node}).
7920 @end table
7921
7922
7923 @node Searching for Articles
7924 @subsection Searching for Articles
7925
7926 @table @kbd
7927
7928 @item M-s
7929 @kindex M-s (Summary)
7930 @findex gnus-summary-search-article-forward
7931 Search through all subsequent articles for a regexp
7932 (@code{gnus-summary-search-article-forward}).
7933
7934 @item M-r
7935 @kindex M-r (Summary)
7936 @findex gnus-summary-search-article-backward
7937 Search through all previous articles for a regexp
7938 (@code{gnus-summary-search-article-backward}).
7939
7940 @item &
7941 @kindex & (Summary)
7942 @findex gnus-summary-execute-command
7943 This command will prompt you for a header field, a regular expression to
7944 match on this field, and a command to be executed if the match is made
7945 (@code{gnus-summary-execute-command}).  If given a prefix, search
7946 backward instead.
7947
7948 @item M-&
7949 @kindex M-& (Summary)
7950 @findex gnus-summary-universal-argument
7951 Perform any operation on all articles that have been marked with
7952 the process mark (@code{gnus-summary-universal-argument}).
7953 @end table
7954
7955 @node Summary Generation Commands
7956 @subsection Summary Generation Commands
7957
7958 @table @kbd
7959
7960 @item Y g
7961 @kindex Y g (Summary)
7962 @findex gnus-summary-prepare
7963 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7964
7965 @item Y c
7966 @kindex Y c (Summary)
7967 @findex gnus-summary-insert-cached-articles
7968 Pull all cached articles (for the current group) into the summary buffer
7969 (@code{gnus-summary-insert-cached-articles}).
7970
7971 @end table
7972
7973
7974 @node Really Various Summary Commands
7975 @subsection Really Various Summary Commands
7976
7977 @table @kbd
7978
7979 @item A D
7980 @itemx C-d
7981 @kindex C-d (Summary)
7982 @kindex A D (Summary)
7983 @findex gnus-summary-enter-digest-group
7984 If the current article is a collection of other articles (for instance,
7985 a digest), you might use this command to enter a group based on the that
7986 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7987 guess what article type is currently displayed unless you give a prefix
7988 to this command, which forces a ``digest'' interpretation.  Basically,
7989 whenever you see a message that is a collection of other messages of
7990 some format, you @kbd{C-d} and read these messages in a more convenient
7991 fashion.
7992
7993 @item M-C-d
7994 @kindex M-C-d (Summary)
7995 @findex gnus-summary-read-document
7996 This command is very similar to the one above, but lets you gather
7997 several documents into one biiig group
7998 (@code{gnus-summary-read-document}).  It does this by opening several
7999 @code{nndoc} groups for each document, and then opening an
8000 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
8001 command understands the process/prefix convention
8002 (@pxref{Process/Prefix}).
8003
8004 @item C-t
8005 @kindex C-t (Summary)
8006 @findex gnus-summary-toggle-truncation
8007 Toggle truncation of summary lines
8008 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
8009 line centering function in the summary buffer, so it's not a good idea
8010 to have truncation switched off while reading articles.
8011
8012 @item =
8013 @kindex = (Summary)
8014 @findex gnus-summary-expand-window
8015 Expand the summary buffer window (@code{gnus-summary-expand-window}).
8016 If given a prefix, force an @code{article} window configuration.
8017
8018 @item M-C-e
8019 @kindex M-C-e (Summary)
8020 @findex gnus-summary-edit-parameters
8021 Edit the group parameters (@pxref{Group Parameters}) of the current
8022 group (@code{gnus-summary-edit-parameters}).
8023
8024 @item M-C-g
8025 @kindex M-C-g (Summary)
8026 @findex gnus-summary-customize-parameters
8027 Customize the group parameters (@pxref{Group Parameters}) of the current
8028 group (@code{gnus-summary-customize-parameters}).
8029
8030 @end table
8031
8032
8033 @node Exiting the Summary Buffer
8034 @section Exiting the Summary Buffer
8035 @cindex summary exit
8036 @cindex exiting groups
8037
8038 Exiting from the summary buffer will normally update all info on the
8039 group and return you to the group buffer.
8040
8041 @table @kbd
8042
8043 @item Z Z
8044 @itemx q
8045 @kindex Z Z (Summary)
8046 @kindex q (Summary)
8047 @findex gnus-summary-exit
8048 @vindex gnus-summary-exit-hook
8049 @vindex gnus-summary-prepare-exit-hook
8050 @c @icon{gnus-summary-exit}
8051 Exit the current group and update all information on the group
8052 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
8053 called before doing much of the exiting, which calls
8054 @code{gnus-summary-expire-articles} by default.
8055 @code{gnus-summary-exit-hook} is called after finishing the exit
8056 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
8057 group mode having no more (unread) groups.
8058
8059 @item Z E
8060 @itemx Q
8061 @kindex Z E (Summary)
8062 @kindex Q (Summary)
8063 @findex gnus-summary-exit-no-update
8064 Exit the current group without updating any information on the group
8065 (@code{gnus-summary-exit-no-update}).
8066
8067 @item Z c
8068 @itemx c
8069 @kindex Z c (Summary)
8070 @kindex c (Summary)
8071 @findex gnus-summary-catchup-and-exit
8072 @c @icon{gnus-summary-catchup-and-exit}
8073 Mark all unticked articles in the group as read and then exit
8074 (@code{gnus-summary-catchup-and-exit}).
8075
8076 @item Z C
8077 @kindex Z C (Summary)
8078 @findex gnus-summary-catchup-all-and-exit
8079 Mark all articles, even the ticked ones, as read and then exit
8080 (@code{gnus-summary-catchup-all-and-exit}).
8081
8082 @item Z n
8083 @kindex Z n (Summary)
8084 @findex gnus-summary-catchup-and-goto-next-group
8085 Mark all articles as read and go to the next group
8086 (@code{gnus-summary-catchup-and-goto-next-group}).
8087
8088 @item Z R
8089 @kindex Z R (Summary)
8090 @findex gnus-summary-reselect-current-group
8091 Exit this group, and then enter it again
8092 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
8093 all articles, both read and unread.
8094
8095 @item Z G
8096 @itemx M-g
8097 @kindex Z G (Summary)
8098 @kindex M-g (Summary)
8099 @findex gnus-summary-rescan-group
8100 @c @icon{gnus-summary-mail-get}
8101 Exit the group, check for new articles in the group, and select the
8102 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
8103 articles, both read and unread.
8104
8105 @item Z N
8106 @kindex Z N (Summary)
8107 @findex gnus-summary-next-group
8108 Exit the group and go to the next group
8109 (@code{gnus-summary-next-group}).
8110
8111 @item Z P
8112 @kindex Z P (Summary)
8113 @findex gnus-summary-prev-group
8114 Exit the group and go to the previous group
8115 (@code{gnus-summary-prev-group}).
8116
8117 @item Z s
8118 @kindex Z s (Summary)
8119 @findex gnus-summary-save-newsrc
8120 Save the current number of read/marked articles in the dribble buffer
8121 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
8122 given a prefix, also save the @file{.newsrc} file(s).  Using this
8123 command will make exit without updating (the @kbd{Q} command) worthless.
8124 @end table
8125
8126 @vindex gnus-exit-group-hook
8127 @code{gnus-exit-group-hook} is called when you exit the current
8128 group.
8129
8130 @findex gnus-summary-wake-up-the-dead
8131 @findex gnus-dead-summary-mode
8132 @vindex gnus-kill-summary-on-exit
8133 If you're in the habit of exiting groups, and then changing your mind
8134 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8135 If you do that, Gnus won't kill the summary buffer when you exit it.
8136 (Quelle surprise!)  Instead it will change the name of the buffer to
8137 something like @samp{*Dead Summary ... *} and install a minor mode
8138 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
8139 buffer, you'll find that all keys are mapped to a function called
8140 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
8141 summary buffer will result in a live, normal summary buffer.
8142
8143 There will never be more than one dead summary buffer at any one time.
8144
8145 @vindex gnus-use-cross-reference
8146 The data on the current group will be updated (which articles you have
8147 read, which articles you have replied to, etc.) when you exit the
8148 summary buffer.  If the @code{gnus-use-cross-reference} variable is
8149 @code{t} (which is the default), articles that are cross-referenced to
8150 this group and are marked as read, will also be marked as read in the
8151 other subscribed groups they were cross-posted to.  If this variable is
8152 neither @code{nil} nor @code{t}, the article will be marked as read in
8153 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8154
8155
8156 @node Crosspost Handling
8157 @section Crosspost Handling
8158
8159 @cindex velveeta
8160 @cindex spamming
8161 Marking cross-posted articles as read ensures that you'll never have to
8162 read the same article more than once.  Unless, of course, somebody has
8163 posted it to several groups separately.  Posting the same article to
8164 several groups (not cross-posting) is called @dfn{spamming}, and you are
8165 by law required to send nasty-grams to anyone who perpetrates such a
8166 heinous crime.  You may want to try NoCeM handling to filter out spam
8167 (@pxref{NoCeM}).
8168
8169 Remember: Cross-posting is kinda ok, but posting the same article
8170 separately to several groups is not.  Massive cross-posting (aka.
8171 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8172 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8173 excessive crossposting (@pxref{Summary Mail Commands}).
8174
8175 @cindex cross-posting
8176 @cindex Xref
8177 @cindex @sc{nov}
8178 One thing that may cause Gnus to not do the cross-posting thing
8179 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8180 (which is very nice, because it speeds things up considerably) which
8181 does not include the @code{Xref} header in its @sc{nov} lines.  This is
8182 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
8183 even with @sc{xover} by registering the @code{Xref} lines of all
8184 articles you actually read, but if you kill the articles, or just mark
8185 them as read without reading them, Gnus will not get a chance to snoop
8186 the @code{Xref} lines out of these articles, and will be unable to use
8187 the cross reference mechanism.
8188
8189 @cindex LIST overview.fmt
8190 @cindex overview.fmt
8191 To check whether your @sc{nntp} server includes the @code{Xref} header
8192 in its overview files, try @samp{telnet your.nntp.server nntp},
8193 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8194 overview.fmt}.  This may not work, but if it does, and the last line you
8195 get does not read @samp{Xref:full}, then you should shout and whine at
8196 your news admin until she includes the @code{Xref} header in the
8197 overview files.
8198
8199 @vindex gnus-nov-is-evil
8200 If you want Gnus to get the @code{Xref}s right all the time, you have to
8201 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8202 considerably.
8203
8204 C'est la vie.
8205
8206 For an alternative approach, @pxref{Duplicate Suppression}.
8207
8208
8209 @node Duplicate Suppression
8210 @section Duplicate Suppression
8211
8212 By default, Gnus tries to make sure that you don't have to read the same
8213 article more than once by utilizing the crossposting mechanism
8214 (@pxref{Crosspost Handling}).  However, that simple and efficient
8215 approach may not work satisfactory for some users for various
8216 reasons.
8217
8218 @enumerate
8219 @item
8220 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
8221 is evil and not very common.
8222
8223 @item
8224 The @sc{nntp} server may fail to include the @code{Xref} header in the
8225 @file{.overview} data bases.  This is evil and all too common, alas.
8226
8227 @item
8228 You may be reading the same group (or several related groups) from
8229 different @sc{nntp} servers.
8230
8231 @item
8232 You may be getting mail that duplicates articles posted to groups.
8233 @end enumerate
8234
8235 I'm sure there are other situations where @code{Xref} handling fails as
8236 well, but these four are the most common situations.
8237
8238 If, and only if, @code{Xref} handling fails for you, then you may
8239 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
8240 will remember the @code{Message-ID}s of all articles you have read or
8241 otherwise marked as read, and then, as if by magic, mark them as read
8242 all subsequent times you see them---in @emph{all} groups.  Using this
8243 mechanism is quite likely to be somewhat inefficient, but not overly
8244 so.  It's certainly preferable to reading the same articles more than
8245 once.
8246
8247 Duplicate suppression is not a very subtle instrument.  It's more like a
8248 sledge hammer than anything else.  It works in a very simple
8249 fashion---if you have marked an article as read, it adds this Message-ID
8250 to a cache.  The next time it sees this Message-ID, it will mark the
8251 article as read with the @samp{M} mark.  It doesn't care what group it
8252 saw the article in.
8253
8254 @table @code
8255 @item gnus-suppress-duplicates
8256 @vindex gnus-suppress-duplicates
8257 If non-@code{nil}, suppress duplicates.
8258
8259 @item gnus-save-duplicate-list
8260 @vindex gnus-save-duplicate-list
8261 If non-@code{nil}, save the list of duplicates to a file.  This will
8262 make startup and shutdown take longer, so the default is @code{nil}.
8263 However, this means that only duplicate articles read in a single Gnus
8264 session are suppressed.
8265
8266 @item gnus-duplicate-list-length
8267 @vindex gnus-duplicate-list-length
8268 This variable says how many @code{Message-ID}s to keep in the duplicate
8269 suppression list.  The default is 10000.
8270
8271 @item gnus-duplicate-file
8272 @vindex gnus-duplicate-file
8273 The name of the file to store the duplicate suppression list in.  The
8274 default is @file{~/News/suppression}.
8275 @end table
8276
8277 If you have a tendency to stop and start Gnus often, setting
8278 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
8279 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
8280 the other hand, saving the list makes startup and shutdown much slower,
8281 so that means that if you stop and start Gnus often, you should set
8282 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
8283 to you to figure out, I think.
8284
8285
8286 @node The Article Buffer
8287 @chapter The Article Buffer
8288 @cindex article buffer
8289
8290 The articles are displayed in the article buffer, of which there is only
8291 one.  All the summary buffers share the same article buffer unless you
8292 tell Gnus otherwise.
8293
8294 @menu
8295 * Hiding Headers::        Deciding what headers should be displayed.
8296 * Using MIME::            Pushing articles through @sc{mime} before reading them.
8297 * Customizing Articles::  Tailoring the look of the articles.
8298 * Article Keymap::        Keystrokes available in the article buffer.
8299 * Misc Article::          Other stuff.
8300 @end menu
8301
8302
8303 @node Hiding Headers
8304 @section Hiding Headers
8305 @cindex hiding headers
8306 @cindex deleting headers
8307
8308 The top section of each article is the @dfn{head}.  (The rest is the
8309 @dfn{body}, but you may have guessed that already.)
8310
8311 @vindex gnus-show-all-headers
8312 There is a lot of useful information in the head: the name of the person
8313 who wrote the article, the date it was written and the subject of the
8314 article.  That's well and nice, but there's also lots of information
8315 most people do not want to see---what systems the article has passed
8316 through before reaching you, the @code{Message-ID}, the
8317 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8318 of some of those lines.  If you want to keep all those lines in the
8319 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8320
8321 Gnus provides you with two variables for sifting headers:
8322
8323 @table @code
8324
8325 @item gnus-visible-headers
8326 @vindex gnus-visible-headers
8327 If this variable is non-@code{nil}, it should be a regular expression
8328 that says what headers you wish to keep in the article buffer.  All
8329 headers that do not match this variable will be hidden.
8330
8331 For instance, if you only want to see the name of the person who wrote
8332 the article and the subject, you'd say:
8333
8334 @lisp
8335 (setq gnus-visible-headers "^From:\\|^Subject:")
8336 @end lisp
8337
8338 This variable can also be a list of regexps to match headers to
8339 remain visible.
8340
8341 @item gnus-ignored-headers
8342 @vindex gnus-ignored-headers
8343 This variable is the reverse of @code{gnus-visible-headers}.  If this
8344 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8345 should be a regular expression that matches all lines that you want to
8346 hide.  All lines that do not match this variable will remain visible.
8347
8348 For instance, if you just want to get rid of the @code{References} line
8349 and the @code{Xref} line, you might say:
8350
8351 @lisp
8352 (setq gnus-ignored-headers "^References:\\|^Xref:")
8353 @end lisp
8354
8355 This variable can also be a list of regexps to match headers to
8356 be removed.
8357
8358 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8359 variable will have no effect.
8360
8361 @end table
8362
8363 @vindex gnus-sorted-header-list
8364 Gnus can also sort the headers for you.  (It does this by default.)  You
8365 can control the sorting by setting the @code{gnus-sorted-header-list}
8366 variable.  It is a list of regular expressions that says in what order
8367 the headers are to be displayed.
8368
8369 For instance, if you want the name of the author of the article first,
8370 and then the subject, you might say something like:
8371
8372 @lisp
8373 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8374 @end lisp
8375
8376 Any headers that are to remain visible, but are not listed in this
8377 variable, will be displayed in random order after all the headers listed in this variable.
8378
8379 @findex gnus-article-hide-boring-headers
8380 @vindex gnus-boring-article-headers
8381 You can hide further boring headers by setting
8382 @code{gnus-treat-hide-boring-header} to @code{head}.  What this function
8383 does depends on the @code{gnus-boring-article-headers} variable.  It's a
8384 list, but this list doesn't actually contain header names.  Instead is
8385 lists various @dfn{boring conditions} that Gnus can check and remove
8386 from sight.
8387
8388 These conditions are:
8389 @table @code
8390 @item empty
8391 Remove all empty headers.
8392 @item followup-to
8393 Remove the @code{Followup-To} header if it is identical to the
8394 @code{Newsgroups} header.
8395 @item reply-to
8396 Remove the @code{Reply-To} header if it lists the same address as the
8397 @code{From} header.
8398 @item newsgroups
8399 Remove the @code{Newsgroups} header if it only contains the current group
8400 name.
8401 @item date
8402 Remove the @code{Date} header if the article is less than three days
8403 old.
8404 @item long-to
8405 Remove the @code{To} header if it is very long.
8406 @item many-to
8407 Remove all @code{To} headers if there are more than one.
8408 @end table
8409
8410 To include the four three elements, you could say something like;
8411
8412 @lisp
8413 (setq gnus-boring-article-headers
8414       '(empty followup-to reply-to))
8415 @end lisp
8416
8417 This is also the default value for this variable.
8418
8419
8420 @node Using MIME
8421 @section Using @sc{mime}
8422 @cindex @sc{mime}
8423
8424 Mime is a standard for waving your hands through the air, aimlessly,
8425 while people stand around yawning.
8426
8427 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8428 while all newsreaders die of fear.
8429
8430 @sc{mime} may specify what character set the article uses, the encoding
8431 of the characters, and it also makes it possible to embed pictures and
8432 other naughty stuff in innocent-looking articles.
8433
8434 @vindex gnus-display-mime-function
8435 @findex gnus-display-mime
8436 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
8437 to display the @sc{mime} parts.  This is @code{gnus-display-mime} by
8438 default, which creates a bundle of clickable buttons that can be used to
8439 display, save and manipulate the @sc{mime} objects.
8440
8441 The following commands are available when you have placed point over a
8442 @sc{mime} button:
8443
8444 @table @kbd
8445 @findex gnus-article-press-button
8446 @item RET (Article)
8447 @itemx BUTTON-2 (Article)
8448 Toggle displaying of the @sc{mime} object
8449 (@code{gnus-article-press-button}).
8450
8451 @findex gnus-mime-view-part
8452 @item M-RET (Article)
8453 @itemx v (Article)
8454 Prompt for a method, and then view the @sc{mime} object using this
8455 method (@code{gnus-mime-view-part}).
8456
8457 @findex gnus-mime-save-part
8458 @item o (Article)
8459 Prompt for a file name, and then save the @sc{mime} object
8460 (@code{gnus-mime-save-part}).
8461
8462 @findex gnus-mime-copy-part
8463 @item c (Article)
8464 Copy the @sc{mime} object to a fresh buffer and display this buffer
8465 (@code{gnus-mime-copy-part}).
8466
8467 @findex gnus-mime-view-part-as-type
8468 @item t (Article)
8469 View the @sc{mime} object as if it were a different @sc{mime} media type
8470 (@code{gnus-mime-view-part-as-type}. 
8471
8472 @findex gnus-mime-pipe-part
8473 @item | (Article)
8474 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
8475 @end table
8476
8477 Gnus will display some @sc{mime} objects automatically.  The way Gnus
8478 determines which parts to do this with is described in the Emacs MIME
8479 manual.
8480
8481 It might be best to just use the toggling functions from the article
8482 buffer to avoid getting nasty surprises.  (For instance, you enter the
8483 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
8484 decoded the sound file in the article and some horrible sing-a-long song
8485 comes screaming out your speakers, and you can't find the volume button,
8486 because there isn't one, and people are starting to look at you, and you
8487 try to stop the program, but you can't, and you can't find the program
8488 to control the volume, and everybody else in the room suddenly decides
8489 to look at you disdainfully, and you'll feel rather stupid.)
8490
8491 Any similarity to real events and people is purely coincidental.  Ahem.
8492
8493 Also see @pxref{MIME Commands}.
8494
8495
8496 @node Customizing Articles
8497 @section Customizing Articles
8498 @cindex article customization
8499
8500 A slew of functions for customizing how the articles are to look like
8501 exist.  You can call these functions interactively, or you can have them
8502 called automatically when you select the articles.
8503
8504 To have them called automatically, you should set the corresponding
8505 ``treatment'' variable.  For instance, to have headers hidden, you'd set
8506 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
8507 be set, but first we discuss the values these variables can have.
8508
8509 Note: Some values, while valid, make little sense.  Check the list below
8510 for sensible values.
8511
8512 @enumerate
8513 @item
8514 @code{nil}: Don't do this treatment.
8515
8516 @item
8517 @code{t}: Do this treatment on all body parts.
8518
8519 @item
8520 @code{head}: Do the treatment on the headers.
8521
8522 @item
8523 @code{last}: Do this treatment on the last part.
8524
8525 @item
8526 An integer: Do this treatment on all body parts that have a length less
8527 than this number.
8528
8529 @item
8530 A list of strings: Do this treatment on all body parts that are in
8531 articles that are read in groups that have names that match one of the
8532 regexps in the list.
8533
8534 @item
8535 A list where the first element is not a string:
8536
8537 The list is evaluated recursively.  The first element of the list is a
8538 predicate.  The following predicates are recognized: @code{or},
8539 @code{and}, @code{not} and @code{typep}.  Here's an example:
8540
8541 @lisp
8542 (or last
8543     (typep "text/x-vcard"))
8544 @end lisp
8545
8546 @end enumerate
8547
8548 You may have noticed that the word @dfn{part} is used here.  This refers
8549 to the fact that some messages are @sc{mime} multipart articles that may
8550 be divided into several parts.  Articles that are not multiparts are
8551 considered to contain just a single part.
8552
8553 @vindex gnus-article-treat-types
8554 Are the treatments applied to all sorts of multipart parts?  Yes, if you
8555 want to, but by default, only @samp{text/plain} parts are given the
8556 treatment.  This is controlled by the @code{gnus-article-treat-types}
8557 variable, which is a list of regular expressions that are matched to the
8558 type of the part.  This variable is ignored if the value of the
8559 controlling variable is a predicate list, as described above.
8560
8561 The following treatment options are available.  The easiest way to
8562 customize this is to examine the @code{gnus-article-treat} customization
8563 group. Values in brackets are suggested sensible values. Others are possible
8564 but those listed are probably sufficient for most people.
8565
8566 @table @code
8567 @item gnus-treat-highlight-signature (t, last)
8568 @item gnus-treat-buttonize (t, integer)
8569 @item gnus-treat-buttonize-head (head)
8570 @item gnus-treat-emphasize (t, head, integer)
8571 @item gnus-treat-fill-article (t, integer)
8572 @item gnus-treat-strip-cr (t, integer)
8573 @item gnus-treat-hide-headers (head)
8574 @item gnus-treat-hide-boring-headers (head)
8575 @item gnus-treat-hide-signature (t, last)
8576 @item gnus-treat-hide-citation (t, integer)
8577 @item gnus-treat-strip-pgp (t, last, integer)
8578 @item gnus-treat-strip-pem (t, last, integer)
8579 @item gnus-treat-highlight-headers (head)
8580 @item gnus-treat-highlight-citation (t, integer)
8581 @item gnus-treat-highlight-signature (t, last, integer)
8582 @item gnus-treat-date-ut (head)
8583 @item gnus-treat-date-local (head)
8584 @item gnus-treat-date-lapsed (head)
8585 @item gnus-treat-date-original (head)
8586 @item gnus-treat-strip-headers-in-body (t, integer)
8587 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
8588 @item gnus-treat-strip-leading-blank-lines (t, integer)
8589 @item gnus-treat-strip-multiple-blank-lines (t, integer)
8590 @item gnus-treat-overstrike (t, integer)
8591 @item gnus-treat-display-xface (head)
8592 @item gnus-treat-display-smileys (t, integer)
8593 @item gnus-treat-display-picons (head)
8594 @item gnus-treat-capitalize-sentences (t, integer)
8595 @item gnus-treat-fill-long-lines (t, integer)
8596 @item gnus-treat-play-sounds
8597 @item gnus-treat-translate
8598 @end table
8599
8600 @vindex gnus-part-display-hook
8601 You can, of course, write your own functions to be called from
8602 @code{gnus-part-display-hook}.  The functions are called narrowed to the
8603 part, and you can do anything you like, pretty much.  There is no
8604 information that you have to keep in the buffer---you can change
8605 everything.  
8606
8607
8608 @node Article Keymap
8609 @section Article Keymap
8610
8611 Most of the keystrokes in the summary buffer can also be used in the
8612 article buffer.  They should behave as if you typed them in the summary
8613 buffer, which means that you don't actually have to have a summary
8614 buffer displayed while reading.  You can do it all from the article
8615 buffer.
8616
8617 A few additional keystrokes are available:
8618
8619 @table @kbd
8620
8621 @item SPACE
8622 @kindex SPACE (Article)
8623 @findex gnus-article-next-page
8624 Scroll forwards one page (@code{gnus-article-next-page}).
8625
8626 @item DEL
8627 @kindex DEL (Article)
8628 @findex gnus-article-prev-page
8629 Scroll backwards one page (@code{gnus-article-prev-page}).
8630
8631 @item C-c ^
8632 @kindex C-c ^ (Article)
8633 @findex gnus-article-refer-article
8634 If point is in the neighborhood of a @code{Message-ID} and you press
8635 @kbd{C-c ^}, Gnus will try to get that article from the server
8636 (@code{gnus-article-refer-article}).
8637
8638 @item C-c C-m
8639 @kindex C-c C-m (Article)
8640 @findex gnus-article-mail
8641 Send a reply to the address near point (@code{gnus-article-mail}).  If
8642 given a prefix, include the mail.
8643
8644 @item s
8645 @kindex s (Article)
8646 @findex gnus-article-show-summary
8647 Reconfigure the buffers so that the summary buffer becomes visible
8648 (@code{gnus-article-show-summary}).
8649
8650 @item ?
8651 @kindex ? (Article)
8652 @findex gnus-article-describe-briefly
8653 Give a very brief description of the available keystrokes
8654 (@code{gnus-article-describe-briefly}).
8655
8656 @item TAB
8657 @kindex TAB (Article)
8658 @findex gnus-article-next-button
8659 Go to the next button, if any (@code{gnus-article-next-button}).  This
8660 only makes sense if you have buttonizing turned on.
8661
8662 @item M-TAB
8663 @kindex M-TAB (Article)
8664 @findex gnus-article-prev-button
8665 Go to the previous button, if any (@code{gnus-article-prev-button}).
8666
8667 @end table
8668
8669
8670 @node Misc Article
8671 @section Misc Article
8672
8673 @table @code
8674
8675 @item gnus-single-article-buffer
8676 @vindex gnus-single-article-buffer
8677 If non-@code{nil}, use the same article buffer for all the groups.
8678 (This is the default.)  If @code{nil}, each group will have its own
8679 article buffer.
8680
8681 @vindex gnus-article-decode-hook
8682 @item gnus-article-decode-hook
8683 @cindex MIME
8684 Hook used to decode @sc{mime} articles.  The default value is
8685 @code{(article-decode-charset article-decode-encoded-words)}
8686
8687 @vindex gnus-article-prepare-hook
8688 @item gnus-article-prepare-hook
8689 This hook is called right after the article has been inserted into the
8690 article buffer.  It is mainly intended for functions that do something
8691 depending on the contents; it should probably not be used for changing
8692 the contents of the article buffer.
8693
8694 @item gnus-article-mode-hook
8695 @vindex gnus-article-mode-hook
8696 Hook called in article mode buffers.
8697
8698 @item gnus-article-mode-syntax-table
8699 @vindex gnus-article-mode-syntax-table
8700 Syntax table used in article buffers.  It is initialized from
8701 @code{text-mode-syntax-table}.
8702
8703 @vindex gnus-article-mode-line-format
8704 @item gnus-article-mode-line-format
8705 This variable is a format string along the same lines as
8706 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
8707 accepts the same format specifications as that variable, with one
8708 extension:
8709
8710 @table @samp
8711 @item w
8712 The @dfn{wash status} of the article.  This is a short string with one
8713 character for each possible article wash operation that may have been
8714 performed.
8715 @item m
8716 The number of @sc{mime} parts in the article.
8717 @end table
8718
8719 @vindex gnus-break-pages
8720
8721 @item gnus-break-pages
8722 Controls whether @dfn{page breaking} is to take place.  If this variable
8723 is non-@code{nil}, the articles will be divided into pages whenever a
8724 page delimiter appears in the article.  If this variable is @code{nil},
8725 paging will not be done.
8726
8727 @item gnus-page-delimiter
8728 @vindex gnus-page-delimiter
8729 This is the delimiter mentioned above.  By default, it is @samp{^L}
8730 (formfeed).
8731 @end table
8732
8733
8734 @node Composing Messages
8735 @chapter Composing Messages
8736 @cindex composing messages
8737 @cindex messages
8738 @cindex mail
8739 @cindex sending mail
8740 @cindex reply
8741 @cindex followup
8742 @cindex post
8743
8744 @kindex C-c C-c (Post)
8745 All commands for posting and mailing will put you in a message buffer
8746 where you can edit the article all you like, before you send the article
8747 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
8748 Manual}.  If you are in a foreign news group, and you wish to post the
8749 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8750 to make Gnus try to post using the foreign server.
8751
8752 @menu
8753 * Mail::                 Mailing and replying.
8754 * Post::                 Posting and following up.
8755 * Posting Server::       What server should you post via?
8756 * Mail and Post::        Mailing and posting at the same time.
8757 * Archived Messages::    Where Gnus stores the messages you've sent.
8758 * Posting Styles::       An easier way to specify who you are.
8759 * Drafts::               Postponing messages and rejected messages.
8760 * Rejected Articles::    What happens if the server doesn't like your article?
8761 @end menu
8762
8763 Also see @pxref{Canceling and Superseding} for information on how to
8764 remove articles you shouldn't have posted.
8765
8766
8767 @node Mail
8768 @section Mail
8769
8770 Variables for customizing outgoing mail:
8771
8772 @table @code
8773 @item gnus-uu-digest-headers
8774 @vindex gnus-uu-digest-headers
8775 List of regexps to match headers included in digested messages.  The
8776 headers will be included in the sequence they are matched.
8777
8778 @item gnus-add-to-list
8779 @vindex gnus-add-to-list
8780 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8781 that have none when you do a @kbd{a}.
8782
8783 @end table
8784
8785
8786 @node Post
8787 @section Post
8788
8789 Variables for composing news articles:
8790
8791 @table @code
8792 @item gnus-sent-message-ids-file
8793 @vindex gnus-sent-message-ids-file
8794 Gnus will keep a @code{Message-ID} history file of all the mails it has
8795 sent.  If it discovers that it has already sent a mail, it will ask the
8796 user whether to re-send the mail.  (This is primarily useful when
8797 dealing with @sc{soup} packets and the like where one is apt to send the
8798 same packet multiple times.)  This variable says what the name of this
8799 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8800 this variable to @code{nil} if you don't want Gnus to keep a history
8801 file.
8802
8803 @item gnus-sent-message-ids-length
8804 @vindex gnus-sent-message-ids-length
8805 This variable says how many @code{Message-ID}s to keep in the history
8806 file.  It is 1000 by default.
8807
8808 @end table
8809
8810
8811 @node Posting Server
8812 @section Posting Server
8813
8814 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8815 (extremely intelligent, of course) article, where does it go?
8816
8817 Thank you for asking.  I hate you.
8818
8819 @vindex gnus-post-method
8820
8821 It can be quite complicated.  Normally, Gnus will use the same native
8822 server.  However.  If your native server doesn't allow posting, just
8823 reading, you probably want to use some other server to post your
8824 (extremely intelligent and fabulously interesting) articles.  You can
8825 then set the @code{gnus-post-method} to some other method:
8826
8827 @lisp
8828 (setq gnus-post-method '(nnspool ""))
8829 @end lisp
8830
8831 Now, if you've done this, and then this server rejects your article, or
8832 this server is down, what do you do then?  To override this variable you
8833 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8834 the ``current'' server for posting.
8835
8836 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8837 Gnus will prompt you for what method to use for posting.
8838
8839 You can also set @code{gnus-post-method} to a list of select methods.
8840 If that's the case, Gnus will always prompt you for what method to use
8841 for posting.
8842
8843 Finally, if you want to always post using the same select method as
8844 you're reading from (which might be convenient if you're reading lots of
8845 groups from different private servers), you can set this variable to
8846 @code{current}.
8847
8848
8849 @node Mail and Post
8850 @section Mail and Post
8851
8852 Here's a list of variables relevant to both mailing and
8853 posting:
8854
8855 @table @code
8856 @item gnus-mailing-list-groups
8857 @findex gnus-mailing-list-groups
8858 @cindex mailing lists
8859
8860 If your news server offers groups that are really mailing lists
8861 gatewayed to the @sc{nntp} server, you can read those groups without
8862 problems, but you can't post/followup to them without some difficulty.
8863 One solution is to add a @code{to-address} to the group parameters
8864 (@pxref{Group Parameters}).  An easier thing to do is set the
8865 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8866 really are mailing lists.  Then, at least, followups to the mailing
8867 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8868 still a pain, though.
8869
8870 @end table
8871
8872 You may want to do spell-checking on messages that you send out.  Or, if
8873 you don't want to spell-check by hand, you could add automatic
8874 spell-checking via the @code{ispell} package:
8875
8876 @cindex ispell
8877 @findex ispell-message
8878 @lisp
8879 (add-hook 'message-send-hook 'ispell-message)
8880 @end lisp
8881
8882
8883 @node Archived Messages
8884 @section Archived Messages
8885 @cindex archived messages
8886 @cindex sent messages
8887
8888 Gnus provides a few different methods for storing the mail and news you
8889 send.  The default method is to use the @dfn{archive virtual server} to
8890 store the messages.  If you want to disable this completely, the
8891 @code{gnus-message-archive-group} variable should be @code{nil}, which
8892 is the default.
8893
8894 @vindex gnus-message-archive-method
8895 @code{gnus-message-archive-method} says what virtual server Gnus is to
8896 use to store sent messages.  The default is:
8897
8898 @lisp
8899 (nnfolder "archive"
8900           (nnfolder-directory   "~/Mail/archive")
8901           (nnfolder-active-file "~/Mail/archive/active")
8902           (nnfolder-get-new-mail nil)
8903           (nnfolder-inhibit-expiry t))
8904 @end lisp
8905
8906 You can, however, use any mail select method (@code{nnml},
8907 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8908 for doing this sort of thing, though.  If you don't like the default
8909 directory chosen, you could say something like:
8910
8911 @lisp
8912 (setq gnus-message-archive-method
8913       '(nnfolder "archive"
8914                  (nnfolder-inhibit-expiry t)
8915                  (nnfolder-active-file "~/News/sent-mail/active")
8916                  (nnfolder-directory "~/News/sent-mail/")))
8917 @end lisp
8918
8919 @vindex gnus-message-archive-group
8920 @cindex Gcc
8921 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8922 to one or more group(s) on that server.  Which group to use is
8923 determined by the @code{gnus-message-archive-group} variable.
8924
8925 This variable can be used to do the following:
8926
8927 @itemize @bullet
8928 @item a string
8929 Messages will be saved in that group.
8930 @item a list of strings
8931 Messages will be saved in all those groups.
8932 @item an alist of regexps, functions and forms
8933 When a key ``matches'', the result is used.
8934 @item @code{nil}
8935 No message archiving will take place.  This is the default.
8936 @end itemize
8937
8938 Let's illustrate:
8939
8940 Just saving to a single group called @samp{MisK}:
8941 @lisp
8942 (setq gnus-message-archive-group "MisK")
8943 @end lisp
8944
8945 Saving to two groups, @samp{MisK} and @samp{safe}:
8946 @lisp
8947 (setq gnus-message-archive-group '("MisK" "safe"))
8948 @end lisp
8949
8950 Save to different groups based on what group you are in:
8951 @lisp
8952 (setq gnus-message-archive-group
8953       '(("^alt" "sent-to-alt")
8954         ("mail" "sent-to-mail")
8955         (".*" "sent-to-misc")))
8956 @end lisp
8957
8958 More complex stuff:
8959 @lisp
8960 (setq gnus-message-archive-group
8961       '((if (message-news-p)
8962             "misc-news"
8963           "misc-mail")))
8964 @end lisp
8965
8966 How about storing all news messages in one file, but storing all mail
8967 messages in one file per month:
8968
8969 @lisp
8970 (setq gnus-message-archive-group
8971       '((if (message-news-p)
8972             "misc-news"
8973           (concat "mail." (format-time-string "%Y-%m")))))
8974 @end lisp
8975
8976 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8977 use a different value for @code{gnus-message-archive-group} there.)
8978
8979 Now, when you send a message off, it will be stored in the appropriate
8980 group.  (If you want to disable storing for just one particular message,
8981 you can just remove the @code{Gcc} header that has been inserted.)  The
8982 archive group will appear in the group buffer the next time you start
8983 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
8984 enter it and read the articles in it just like you'd read any other
8985 group.  If the group gets really big and annoying, you can simply rename
8986 if (using @kbd{G r} in the group buffer) to something
8987 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8988 continue to be stored in the old (now empty) group.
8989
8990 That's the default method of archiving sent messages.  Gnus offers a
8991 different way for the people who don't like the default method.  In that
8992 case you should set @code{gnus-message-archive-group} to @code{nil};
8993 this will disable archiving.
8994
8995 @table @code
8996 @item gnus-outgoing-message-group
8997 @vindex gnus-outgoing-message-group
8998 All outgoing messages will be put in this group.  If you want to store
8999 all your outgoing mail and articles in the group @samp{nnml:archive},
9000 you set this variable to that value.  This variable can also be a list of
9001 group names.
9002
9003 If you want to have greater control over what group to put each
9004 message in, you can set this variable to a function that checks the
9005 current newsgroup name and then returns a suitable group name (or list
9006 of names).
9007
9008 This variable can be used instead of @code{gnus-message-archive-group},
9009 but the latter is the preferred method.
9010 @end table
9011
9012
9013 @node Posting Styles
9014 @section Posting Styles
9015 @cindex posting styles
9016 @cindex styles
9017
9018 All them variables, they make my head swim.
9019
9020 So what if you want a different @code{Organization} and signature based
9021 on what groups you post to?  And you post both from your home machine
9022 and your work machine, and you want different @code{From} lines, and so
9023 on?
9024
9025 @vindex gnus-posting-styles
9026 One way to do stuff like that is to write clever hooks that change the
9027 variables you need to have changed.  That's a bit boring, so somebody
9028 came up with the bright idea of letting the user specify these things in
9029 a handy alist.  Here's an example of a @code{gnus-posting-styles}
9030 variable:
9031
9032 @lisp
9033 ((".*"
9034   (signature "Peace and happiness")
9035   (organization "What me?"))
9036  ("^comp"
9037   (signature "Death to everybody"))
9038  ("comp.emacs.i-love-it"
9039   (organization "Emacs is it")))
9040 @end lisp
9041
9042 As you might surmise from this example, this alist consists of several
9043 @dfn{styles}.  Each style will be applicable if the first element
9044 ``matches'', in some form or other.  The entire alist will be iterated
9045 over, from the beginning towards the end, and each match will be
9046 applied, which means that attributes in later styles that match override
9047 the same attributes in earlier matching styles.  So
9048 @samp{comp.programming.literate} will have the @samp{Death to everybody}
9049 signature and the @samp{What me?} @code{Organization} header.
9050
9051 The first element in each style is called the @code{match}.  If it's a
9052 string, then Gnus will try to regexp match it against the group name.
9053 If it is the symbol @code{header}, then Gnus will look for header that
9054 match the next element in the match, and compare that to the last header
9055 in the match.  If it's a function symbol, that function will be called
9056 with no arguments.  If it's a variable symbol, then the variable will be
9057 referenced.  If it's a list, then that list will be @code{eval}ed.  In
9058 any case, if this returns a non-@code{nil} value, then the style is said
9059 to @dfn{match}.
9060
9061 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
9062 attribute consists of a @code{(@var{name} . @var{value})} pair.  The
9063 attribute name can be one of @code{signature}, @code{signature-file},
9064 @code{organization}, @code{address}, @code{name} or @code{body}.  The
9065 attribute name can also be a string.  In that case, this will be used as
9066 a header name, and the value will be inserted in the headers of the
9067 article.  If the attribute name is @code{eval}, the form is evaluated,
9068 and the result is thrown away.
9069
9070 The attribute value can be a string (used verbatim), a function with
9071 zero arguments (the return value will be used), a variable (its value
9072 will be used) or a list (it will be @code{eval}ed and the return value
9073 will be used).  The functions and sexps are called/@code{eval}ed in the
9074 message buffer that is being set up.  The headers of the current article
9075 are available through the @code{message-reply-headers} variable.
9076
9077 If you wish to check whether the message you are about to compose is
9078 meant to be a news article or a mail message, you can check the values
9079 of the @code{message-news-p} and @code{message-mail-p} functions.
9080
9081 @findex message-mail-p
9082 @findex message-news-p
9083
9084 So here's a new example:
9085
9086 @lisp
9087 (setq gnus-posting-styles
9088       '((".*"
9089          (signature-file "~/.signature")
9090          (name "User Name")
9091          ("X-Home-Page" (getenv "WWW_HOME"))
9092          (organization "People's Front Against MWM"))
9093         ("^rec.humor"
9094          (signature my-funny-signature-randomizer))
9095         ((equal (system-name) "gnarly")
9096          (signature my-quote-randomizer))
9097         ((message-news-p)
9098          (signature my-news-signature))
9099         ((header "From.*To" "larsi.*org")
9100          (Organization "Somewhere, Inc."))
9101         ((posting-from-work-p)
9102          (signature-file "~/.work-signature")
9103          (address "user@@bar.foo")
9104          (body "You are fired.\n\nSincerely, your boss.")
9105          (organization "Important Work, Inc"))
9106         ("^nn.+:"
9107          (signature-file "~/.mail-signature"))))
9108 @end lisp
9109
9110
9111 @node Drafts
9112 @section Drafts
9113 @cindex drafts
9114
9115 If you are writing a message (mail or news) and suddenly remember that
9116 you have a steak in the oven (or some pesto in the food processor, you
9117 craaazy vegetarians), you'll probably wish there was a method to save
9118 the message you are writing so that you can continue editing it some
9119 other day, and send it when you feel its finished.
9120
9121 Well, don't worry about it.  Whenever you start composing a message of
9122 some sort using the Gnus mail and post commands, the buffer you get will
9123 automatically associate to an article in a special @dfn{draft} group.
9124 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
9125 article will be saved there.  (Auto-save files also go to the draft
9126 group.)
9127
9128 @cindex nndraft
9129 @vindex nndraft-directory
9130 The draft group is a special group (which is implemented as an
9131 @code{nndraft} group, if you absolutely have to know) called
9132 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
9133 @code{nndraft} is to store its files.  What makes this group special is
9134 that you can't tick any articles in it or mark any articles as
9135 read---all articles in the group are permanently unread.
9136
9137 If the group doesn't exist, it will be created and you'll be subscribed
9138 to it.  The only way to make it disappear from the Group buffer is to
9139 unsubscribe it.
9140
9141 @c @findex gnus-dissociate-buffer-from-draft
9142 @c @kindex C-c M-d (Mail)
9143 @c @kindex C-c M-d (Post)
9144 @c @findex gnus-associate-buffer-with-draft
9145 @c @kindex C-c C-d (Mail)
9146 @c @kindex C-c C-d (Post)
9147 @c If you're writing some super-secret message that you later want to
9148 @c encode with PGP before sending, you may wish to turn the auto-saving
9149 @c (and association with the draft group) off.  You never know who might be
9150 @c interested in reading all your extremely valuable and terribly horrible
9151 @c and interesting secrets.  The @kbd{C-c M-d}
9152 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9153 @c If you change your mind and want to turn the auto-saving back on again,
9154 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9155 @c
9156 @c @vindex gnus-use-draft
9157 @c To leave association with the draft group off by default, set
9158 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
9159
9160 @findex gnus-draft-edit-message
9161 @kindex D e (Draft)
9162 When you want to continue editing the article, you simply enter the
9163 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9164 that.  You will be placed in a buffer where you left off.
9165
9166 Rejected articles will also be put in this draft group (@pxref{Rejected
9167 Articles}).
9168
9169 @findex gnus-draft-send-all-messages
9170 @findex gnus-draft-send-message
9171 If you have lots of rejected messages you want to post (or mail) without
9172 doing further editing, you can use the @kbd{D s} command
9173 (@code{gnus-draft-send-message}).  This command understands the
9174 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
9175 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9176 in the buffer.
9177
9178 If you have some messages that you wish not to send, you can use the
9179 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9180 as unsendable.  This is a toggling command.
9181
9182
9183 @node Rejected Articles
9184 @section Rejected Articles
9185 @cindex rejected articles
9186
9187 Sometimes a news server will reject an article.  Perhaps the server
9188 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
9189 @emph{there be demons}.  Perhaps you have included too much cited text.
9190 Perhaps the disk is full.  Perhaps the server is down.
9191
9192 These situations are, of course, totally beyond the control of Gnus.
9193 (Gnus, of course, loves the way you look, always feels great, has angels
9194 fluttering around inside of it, doesn't care about how much cited text
9195 you include, never runs full and never goes down.)  So Gnus saves these
9196 articles until some later time when the server feels better.
9197
9198 The rejected articles will automatically be put in a special draft group
9199 (@pxref{Drafts}).  When the server comes back up again, you'd then
9200 typically enter that group and send all the articles off.
9201
9202
9203 @node Select Methods
9204 @chapter Select Methods
9205 @cindex foreign groups
9206 @cindex select methods
9207
9208 A @dfn{foreign group} is a group not read by the usual (or
9209 default) means.  It could be, for instance, a group from a different
9210 @sc{nntp} server, it could be a virtual group, or it could be your own
9211 personal mail group.
9212
9213 A foreign group (or any group, really) is specified by a @dfn{name} and
9214 a @dfn{select method}.  To take the latter first, a select method is a
9215 list where the first element says what backend to use (e.g. @code{nntp},
9216 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
9217 name}.  There may be additional elements in the select method, where the
9218 value may have special meaning for the backend in question.
9219
9220 One could say that a select method defines a @dfn{virtual server}---so
9221 we do just that (@pxref{The Server Buffer}).
9222
9223 The @dfn{name} of the group is the name the backend will recognize the
9224 group as.
9225
9226 For instance, the group @samp{soc.motss} on the @sc{nntp} server
9227 @samp{some.where.edu} will have the name @samp{soc.motss} and select
9228 method @code{(nntp "some.where.edu")}.  Gnus will call this group
9229 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
9230 backend just knows this group as @samp{soc.motss}.
9231
9232 The different methods all have their peculiarities, of course.
9233
9234 @menu
9235 * The Server Buffer::     Making and editing virtual servers.
9236 * Getting News::          Reading USENET news with Gnus.
9237 * Getting Mail::          Reading your personal mail with Gnus.
9238 * Browsing the Web::      Getting messages from a plethora of Web sources.
9239 * Other Sources::         Reading directories, files, SOUP packets.
9240 * Combined Groups::       Combining groups into one group.
9241 * Gnus Unplugged::        Reading news and mail offline.
9242 @end menu
9243
9244
9245 @node The Server Buffer
9246 @section The Server Buffer
9247
9248 Traditionally, a @dfn{server} is a machine or a piece of software that
9249 one connects to, and then requests information from.  Gnus does not
9250 connect directly to any real servers, but does all transactions through
9251 one backend or other.  But that's just putting one layer more between
9252 the actual media and Gnus, so we might just as well say that each
9253 backend represents a virtual server.
9254
9255 For instance, the @code{nntp} backend may be used to connect to several
9256 different actual @sc{nntp} servers, or, perhaps, to many different ports
9257 on the same actual @sc{nntp} server.  You tell Gnus which backend to
9258 use, and what parameters to set by specifying a @dfn{select method}.
9259
9260 These select method specifications can sometimes become quite
9261 complicated---say, for instance, that you want to read from the
9262 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9263 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
9264 Anyways, if you had to specify that for each group that used this
9265 server, that would be too much work, so Gnus offers a way of naming
9266 select methods, which is what you do in the server buffer.
9267
9268 To enter the server buffer, use the @kbd{^}
9269 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9270
9271 @menu
9272 * Server Buffer Format::      You can customize the look of this buffer.
9273 * Server Commands::           Commands to manipulate servers.
9274 * Example Methods::           Examples server specifications.
9275 * Creating a Virtual Server:: An example session.
9276 * Server Variables::          Which variables to set.
9277 * Servers and Methods::       You can use server names as select methods.
9278 * Unavailable Servers::       Some servers you try to contact may be down.
9279 @end menu
9280
9281 @vindex gnus-server-mode-hook
9282 @code{gnus-server-mode-hook} is run when creating the server buffer.
9283
9284
9285 @node Server Buffer Format
9286 @subsection Server Buffer Format
9287 @cindex server buffer format
9288
9289 @vindex gnus-server-line-format
9290 You can change the look of the server buffer lines by changing the
9291 @code{gnus-server-line-format} variable.  This is a @code{format}-like
9292 variable, with some simple extensions:
9293
9294 @table @samp
9295
9296 @item h
9297 How the news is fetched---the backend name.
9298
9299 @item n
9300 The name of this server.
9301
9302 @item w
9303 Where the news is to be fetched from---the address.
9304
9305 @item s
9306 The opened/closed/denied status of the server.
9307 @end table
9308
9309 @vindex gnus-server-mode-line-format
9310 The mode line can also be customized by using the
9311 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9312 Formatting}).  The following specs are understood:
9313
9314 @table @samp
9315 @item S
9316 Server name.
9317
9318 @item M
9319 Server method.
9320 @end table
9321
9322 Also @pxref{Formatting Variables}.
9323
9324
9325 @node Server Commands
9326 @subsection Server Commands
9327 @cindex server commands
9328
9329 @table @kbd
9330
9331 @item a
9332 @kindex a (Server)
9333 @findex gnus-server-add-server
9334 Add a new server (@code{gnus-server-add-server}).
9335
9336 @item e
9337 @kindex e (Server)
9338 @findex gnus-server-edit-server
9339 Edit a server (@code{gnus-server-edit-server}).
9340
9341 @item SPACE
9342 @kindex SPACE (Server)
9343 @findex gnus-server-read-server
9344 Browse the current server (@code{gnus-server-read-server}).
9345
9346 @item q
9347 @kindex q (Server)
9348 @findex gnus-server-exit
9349 Return to the group buffer (@code{gnus-server-exit}).
9350
9351 @item k
9352 @kindex k (Server)
9353 @findex gnus-server-kill-server
9354 Kill the current server (@code{gnus-server-kill-server}).
9355
9356 @item y
9357 @kindex y (Server)
9358 @findex gnus-server-yank-server
9359 Yank the previously killed server (@code{gnus-server-yank-server}).
9360
9361 @item c
9362 @kindex c (Server)
9363 @findex gnus-server-copy-server
9364 Copy the current server (@code{gnus-server-copy-server}).
9365
9366 @item l
9367 @kindex l (Server)
9368 @findex gnus-server-list-servers
9369 List all servers (@code{gnus-server-list-servers}).
9370
9371 @item s
9372 @kindex s (Server)
9373 @findex gnus-server-scan-server
9374 Request that the server scan its sources for new articles
9375 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
9376 servers.
9377
9378 @item g
9379 @kindex g (Server)
9380 @findex gnus-server-regenerate-server
9381 Request that the server regenerate all its data structures
9382 (@code{gnus-server-regenerate-server}).  This can be useful if you have
9383 a mail backend that has gotten out of synch.
9384
9385 @end table
9386
9387
9388 @node Example Methods
9389 @subsection Example Methods
9390
9391 Most select methods are pretty simple and self-explanatory:
9392
9393 @lisp
9394 (nntp "news.funet.fi")
9395 @end lisp
9396
9397 Reading directly from the spool is even simpler:
9398
9399 @lisp
9400 (nnspool "")
9401 @end lisp
9402
9403 As you can see, the first element in a select method is the name of the
9404 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9405 will.
9406
9407 After these two elements, there may be an arbitrary number of
9408 @code{(@var{variable} @var{form})} pairs.
9409
9410 To go back to the first example---imagine that you want to read from
9411 port 15 on that machine.  This is what the select method should
9412 look like then:
9413
9414 @lisp
9415 (nntp "news.funet.fi" (nntp-port-number 15))
9416 @end lisp
9417
9418 You should read the documentation to each backend to find out what
9419 variables are relevant, but here's an @code{nnmh} example:
9420
9421 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
9422 you have two structures that you wish to access: One is your private
9423 mail spool, and the other is a public one.  Here's the possible spec for
9424 your private mail:
9425
9426 @lisp
9427 (nnmh "private" (nnmh-directory "~/private/mail/"))
9428 @end lisp
9429
9430 (This server is then called @samp{private}, but you may have guessed
9431 that.)
9432
9433 Here's the method for a public spool:
9434
9435 @lisp
9436 (nnmh "public"
9437       (nnmh-directory "/usr/information/spool/")
9438       (nnmh-get-new-mail nil))
9439 @end lisp
9440
9441 If you are behind a firewall and only have access to the @sc{nntp}
9442 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9443 on the firewall machine and telnet from there to the @sc{nntp} server.
9444 Doing this can be rather fiddly, but your virtual server definition
9445 should probably look something like this:
9446
9447 @lisp
9448 (nntp "firewall"
9449       (nntp-address "the.firewall.machine")
9450       (nntp-open-connection-function nntp-open-rlogin)
9451       (nntp-end-of-line "\n")
9452       (nntp-rlogin-parameters
9453        ("telnet" "the.real.nntp.host" "nntp")))
9454 @end lisp
9455
9456 If you want to use the wonderful @code{ssh} program to provide a
9457 compressed connection over the modem line, you could create a virtual
9458 server that would look something like this:
9459
9460 @lisp
9461 (nntp "news"
9462        (nntp-address "copper.uio.no")
9463        (nntp-rlogin-program "ssh")
9464        (nntp-open-connection-function nntp-open-rlogin)
9465        (nntp-end-of-line "\n")
9466        (nntp-rlogin-parameters
9467         ("telnet" "news.uio.no" "nntp")))
9468 @end lisp
9469
9470 This means that you have to have set up @code{ssh-agent} correctly to
9471 provide automatic authorization, of course.  And to get a compressed
9472 connection, you have to have the @samp{Compression} option in the
9473 @code{ssh} @file{config} file.
9474
9475
9476 @node Creating a Virtual Server
9477 @subsection Creating a Virtual Server
9478
9479 If you're saving lots of articles in the cache by using persistent
9480 articles, you may want to create a virtual server to read the cache.
9481
9482 First you need to add a new server.  The @kbd{a} command does that.  It
9483 would probably be best to use @code{nnspool} to read the cache.  You
9484 could also use @code{nnml} or @code{nnmh}, though.
9485
9486 Type @kbd{a nnspool RET cache RET}.
9487
9488 You should now have a brand new @code{nnspool} virtual server called
9489 @samp{cache}.  You now need to edit it to have the right definitions.
9490 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
9491 will contain the following:
9492
9493 @lisp
9494 (nnspool "cache")
9495 @end lisp
9496
9497 Change that to:
9498
9499 @lisp
9500 (nnspool "cache"
9501          (nnspool-spool-directory "~/News/cache/")
9502          (nnspool-nov-directory "~/News/cache/")
9503          (nnspool-active-file "~/News/cache/active"))
9504 @end lisp
9505
9506 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
9507 @kbd{RET} over this virtual server, you should be entered into a browse
9508 buffer, and you should be able to enter any of the groups displayed.
9509
9510
9511 @node Server Variables
9512 @subsection Server Variables
9513
9514 One sticky point when defining variables (both on backends and in Emacs
9515 in general) is that some variables are typically initialized from other
9516 variables when the definition of the variables is being loaded.  If you
9517 change the "base" variable after the variables have been loaded, you
9518 won't change the "derived" variables.
9519
9520 This typically affects directory and file variables.  For instance,
9521 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9522 directory variables are initialized from that variable, so
9523 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
9524 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9525 @code{nnml-directory}---you have to explicitly set all the file
9526 variables to be what you want them to be.  For a complete list of
9527 variables for each backend, see each backend's section later in this
9528 manual, but here's an example @code{nnml} definition:
9529
9530 @lisp
9531 (nnml "public"
9532       (nnml-directory "~/my-mail/")
9533       (nnml-active-file "~/my-mail/active")
9534       (nnml-newsgroups-file "~/my-mail/newsgroups"))
9535 @end lisp
9536
9537
9538 @node Servers and Methods
9539 @subsection Servers and Methods
9540
9541 Wherever you would normally use a select method
9542 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9543 when browsing a foreign server) you can use a virtual server name
9544 instead.  This could potentially save lots of typing.  And it's nice all
9545 over.
9546
9547
9548 @node Unavailable Servers
9549 @subsection Unavailable Servers
9550
9551 If a server seems to be unreachable, Gnus will mark that server as
9552 @code{denied}.  That means that any subsequent attempt to make contact
9553 with that server will just be ignored.  ``It can't be opened,'' Gnus
9554 will tell you, without making the least effort to see whether that is
9555 actually the case or not.
9556
9557 That might seem quite naughty, but it does make sense most of the time.
9558 Let's say you have 10 groups subscribed to on server
9559 @samp{nephelococcygia.com}.  This server is located somewhere quite far
9560 away from you and the machine is quite slow, so it takes 1 minute just
9561 to find out that it refuses connection to you today.  If Gnus were to
9562 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9563 attempt to do that.  Once it has gotten a single ``connection refused'',
9564 it will regard that server as ``down''.
9565
9566 So, what happens if the machine was only feeling unwell temporarily?
9567 How do you test to see whether the machine has come up again?
9568
9569 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9570 with the following commands:
9571
9572 @table @kbd
9573
9574 @item O
9575 @kindex O (Server)
9576 @findex gnus-server-open-server
9577 Try to establish connection to the server on the current line
9578 (@code{gnus-server-open-server}).
9579
9580 @item C
9581 @kindex C (Server)
9582 @findex gnus-server-close-server
9583 Close the connection (if any) to the server
9584 (@code{gnus-server-close-server}).
9585
9586 @item D
9587 @kindex D (Server)
9588 @findex gnus-server-deny-server
9589 Mark the current server as unreachable
9590 (@code{gnus-server-deny-server}).
9591
9592 @item M-o
9593 @kindex M-o (Server)
9594 @findex gnus-server-open-all-servers
9595 Open the connections to all servers in the buffer
9596 (@code{gnus-server-open-all-servers}).
9597
9598 @item M-c
9599 @kindex M-c (Server)
9600 @findex gnus-server-close-all-servers
9601 Close the connections to all servers in the buffer
9602 (@code{gnus-server-close-all-servers}).
9603
9604 @item R
9605 @kindex R (Server)
9606 @findex gnus-server-remove-denials
9607 Remove all marks to whether Gnus was denied connection from any servers
9608 (@code{gnus-server-remove-denials}).
9609
9610 @end table
9611
9612
9613 @node Getting News
9614 @section Getting News
9615 @cindex reading news
9616 @cindex news backends
9617
9618 A newsreader is normally used for reading news.  Gnus currently provides
9619 only two methods of getting news---it can read from an @sc{nntp} server,
9620 or it can read from a local spool.
9621
9622 @menu
9623 * NNTP::               Reading news from an @sc{nntp} server.
9624 * News Spool::         Reading news from the local spool.
9625 @end menu
9626
9627
9628 @node NNTP
9629 @subsection @sc{nntp}
9630 @cindex nntp
9631
9632 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9633 You just specify @code{nntp} as method and the address of the @sc{nntp}
9634 server as the, uhm, address.
9635
9636 If the @sc{nntp} server is located at a non-standard port, setting the
9637 third element of the select method to this port number should allow you
9638 to connect to the right port.  You'll have to edit the group info for
9639 that (@pxref{Foreign Groups}).
9640
9641 The name of the foreign group can be the same as a native group.  In
9642 fact, you can subscribe to the same group from as many different servers
9643 you feel like.  There will be no name collisions.
9644
9645 The following variables can be used to create a virtual @code{nntp}
9646 server:
9647
9648 @table @code
9649
9650 @item nntp-server-opened-hook
9651 @vindex nntp-server-opened-hook
9652 @cindex @sc{mode reader}
9653 @cindex authinfo
9654 @cindex authentification
9655 @cindex nntp authentification
9656 @findex nntp-send-authinfo
9657 @findex nntp-send-mode-reader
9658 is run after a connection has been made.  It can be used to send
9659 commands to the @sc{nntp} server after it has been contacted.  By
9660 default it sends the command @code{MODE READER} to the server with the
9661 @code{nntp-send-mode-reader} function.  This function should always be
9662 present in this hook.
9663
9664 @item nntp-authinfo-function
9665 @vindex nntp-authinfo-function
9666 @findex nntp-send-authinfo
9667 @vindex nntp-authinfo-file
9668 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9669 server.  The default function is @code{nntp-send-authinfo}, which looks
9670 through your @file{~/.authinfo} (or whatever you've set the
9671 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
9672 are found, it will prompt you for a login name and a password.  The
9673 format of the @file{~/.authinfo} file is (almost) the same as the
9674 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9675 manual page, but here are the salient facts:
9676
9677 @enumerate
9678 @item
9679 The file contains one or more line, each of which define one server.
9680
9681 @item
9682 Each line may contain an arbitrary number of token/value pairs.  The
9683 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9684 @samp{default} and @samp{force}.  (The latter is not a valid
9685 @file{.netrc}/@code{ftp} token, which is the only way the
9686 @file{.authinfo} file format deviates from the @file{.netrc} file
9687 format.)
9688
9689 @end enumerate
9690
9691 Here's an example file:
9692
9693 @example
9694 machine news.uio.no login larsi password geheimnis
9695 machine nntp.ifi.uio.no login larsi force yes
9696 @end example
9697
9698 The token/value pairs may appear in any order; @samp{machine} doesn't
9699 have to be first, for instance.
9700
9701 In this example, both login name and password have been supplied for the
9702 former server, while the latter has only the login name listed, and the
9703 user will be prompted for the password.  The latter also has the
9704 @samp{force} tag, which means that the authinfo will be sent to the
9705 @var{nntp} server upon connection; the default (i.e., when there is not
9706 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9707 until the @var{nntp} server asks for it.
9708
9709 You can also add @samp{default} lines that will apply to all servers
9710 that don't have matching @samp{machine} lines.
9711
9712 @example
9713 default force yes
9714 @end example
9715
9716 This will force sending @samp{AUTHINFO} commands to all servers not
9717 previously mentioned.
9718
9719 Remember to not leave the @file{~/.authinfo} file world-readable.
9720
9721 @item nntp-server-action-alist
9722 @vindex nntp-server-action-alist
9723 This is a list of regexps to match on server types and actions to be
9724 taken when matches are made.  For instance, if you want Gnus to beep
9725 every time you connect to innd, you could say something like:
9726
9727 @lisp
9728 (setq nntp-server-action-alist
9729       '(("innd" (ding))))
9730 @end lisp
9731
9732 You probably don't want to do that, though.
9733
9734 The default value is
9735
9736 @lisp
9737 '(("nntpd 1\\.5\\.11t"
9738    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9739 @end lisp
9740
9741 This ensures that Gnus doesn't send the @code{MODE READER} command to
9742 nntpd 1.5.11t, since that command chokes that server, I've been told.
9743
9744 @item nntp-maximum-request
9745 @vindex nntp-maximum-request
9746 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9747 will collect headers by sending a series of @code{head} commands.  To
9748 speed things up, the backend sends lots of these commands without
9749 waiting for reply, and then reads all the replies.  This is controlled
9750 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
9751 your network is buggy, you should set this to 1.
9752
9753 @item nntp-connection-timeout
9754 @vindex nntp-connection-timeout
9755 If you have lots of foreign @code{nntp} groups that you connect to
9756 regularly, you're sure to have problems with @sc{nntp} servers not
9757 responding properly, or being too loaded to reply within reasonable
9758 time.  This is can lead to awkward problems, which can be helped
9759 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
9760 that says how many seconds the @code{nntp} backend should wait for a
9761 connection before giving up.  If it is @code{nil}, which is the default,
9762 no timeouts are done.
9763
9764 @c @item nntp-command-timeout
9765 @c @vindex nntp-command-timeout
9766 @c @cindex PPP connections
9767 @c @cindex dynamic IP addresses
9768 @c If you're running Gnus on a machine that has a dynamically assigned
9769 @c address, Gnus may become confused.  If the address of your machine
9770 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9771 @c waiting forever for replies from the server.  To help with this
9772 @c unfortunate problem, you can set this command to a number.  Gnus will
9773 @c then, if it sits waiting for a reply from the server longer than that
9774 @c number of seconds, shut down the connection, start a new one, and resend
9775 @c the command.  This should hopefully be transparent to the user.  A
9776 @c likely number is 30 seconds.
9777 @c
9778 @c @item nntp-retry-on-break
9779 @c @vindex nntp-retry-on-break
9780 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9781 @c hangs.  This will have much the same effect as the command timeout
9782 @c described above.
9783
9784 @item nntp-server-hook
9785 @vindex nntp-server-hook
9786 This hook is run as the last step when connecting to an @sc{nntp}
9787 server.
9788
9789 @findex nntp-open-rlogin
9790 @findex nntp-open-telnet
9791 @findex nntp-open-network-stream
9792 @item nntp-open-connection-function
9793 @vindex nntp-open-connection-function
9794 This function is used to connect to the remote system.  Four pre-made
9795 functions are supplied:
9796
9797 @table @code
9798 @item nntp-open-network-stream
9799 This is the default, and simply connects to some port or other on the
9800 remote system.
9801
9802 @item nntp-open-rlogin
9803 Does an @samp{rlogin} on the
9804 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9805 available there.
9806
9807 @code{nntp-open-rlogin}-related variables:
9808
9809 @table @code
9810
9811 @item nntp-rlogin-program
9812 @vindex nntp-rlogin-program
9813 Program used to log in on remote machines.  The default is @samp{rsh},
9814 but @samp{ssh} is a popular alternative.
9815
9816 @item nntp-rlogin-parameters
9817 @vindex nntp-rlogin-parameters
9818 This list will be used as the parameter list given to @code{rsh}.
9819
9820 @item nntp-rlogin-user-name
9821 @vindex nntp-rlogin-user-name
9822 User name on the remote system.
9823
9824 @end table
9825
9826 @item nntp-open-telnet
9827 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9828 to get to the @sc{nntp} server.
9829
9830 @code{nntp-open-telnet}-related variables:
9831
9832 @table @code
9833 @item nntp-telnet-command
9834 @vindex nntp-telnet-command
9835 Command used to start @code{telnet}.
9836
9837 @item nntp-telnet-switches
9838 @vindex nntp-telnet-switches
9839 List of strings to be used as the switches to the @code{telnet} command.
9840
9841 @item nntp-telnet-user-name
9842 @vindex nntp-telnet-user-name
9843 User name for log in on the remote system.
9844
9845 @item nntp-telnet-passwd
9846 @vindex nntp-telnet-passwd
9847 Password to use when logging in.
9848
9849 @item nntp-telnet-parameters
9850 @vindex nntp-telnet-parameters
9851 A list of strings executed as a command after logging in
9852 via @code{telnet}.
9853
9854 @item nntp-telnet-shell-prompt
9855 @vindex nntp-telnet-shell-prompt
9856 Regexp matching the shell prompt on the remote machine.  The default is
9857 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9858
9859 @item nntp-open-telnet-envuser
9860 @vindex nntp-open-telnet-envuser
9861 If non-@code{nil}, the @code{telnet} session (client and server both)
9862 will support the @code{ENVIRON} option and not prompt for login name.
9863 This works for Solaris @code{telnet}, for instance.
9864
9865 @end table
9866
9867 @findex nntp-open-ssl-stream
9868 @item nntp-open-ssl-stream
9869 Opens a connection to a server over a @dfn{secure} channel.  To use this
9870 you must have SSLay installed
9871 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9872 @file{ssl.el} (from the W3 distributeion, for instance).  You then
9873 define a server as follows:
9874
9875 @lisp
9876 ;; Type `C-c C-c' after you've finished editing.
9877 ;;
9878 ;; "snews" is port 563 and is predefined in our /etc/services
9879 ;;
9880 (nntp "snews.bar.com"
9881       (nntp-open-connection-function nntp-open-ssl-stream)
9882       (nntp-port-number "snews")
9883       (nntp-address "snews.bar.com"))
9884 @end lisp
9885
9886 @end table
9887
9888 @item nntp-end-of-line
9889 @vindex nntp-end-of-line
9890 String to use as end-of-line marker when talking to the @sc{nntp}
9891 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9892 using @code{rlogin} to talk to the server.
9893
9894 @item nntp-rlogin-user-name
9895 @vindex nntp-rlogin-user-name
9896 User name on the remote system when using the @code{rlogin} connect
9897 function.
9898
9899 @item nntp-address
9900 @vindex nntp-address
9901 The address of the remote system running the @sc{nntp} server.
9902
9903 @item nntp-port-number
9904 @vindex nntp-port-number
9905 Port number to connect to when using the @code{nntp-open-network-stream}
9906 connect function.
9907
9908 @item nntp-buggy-select
9909 @vindex nntp-buggy-select
9910 Set this to non-@code{nil} if your select routine is buggy.
9911
9912 @item nntp-nov-is-evil
9913 @vindex nntp-nov-is-evil
9914 If the @sc{nntp} server does not support @sc{nov}, you could set this
9915 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9916 can be used.
9917
9918 @item nntp-xover-commands
9919 @vindex nntp-xover-commands
9920 @cindex nov
9921 @cindex XOVER
9922 List of strings used as commands to fetch @sc{nov} lines from a
9923 server.  The default value of this variable is @code{("XOVER"
9924 "XOVERVIEW")}.
9925
9926 @item nntp-nov-gap
9927 @vindex nntp-nov-gap
9928 @code{nntp} normally sends just one big request for @sc{nov} lines to
9929 the server.  The server responds with one huge list of lines.  However,
9930 if you have read articles 2-5000 in the group, and only want to read
9931 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9932 lines that you will not need.  This variable says how
9933 big a gap between two consecutive articles is allowed to be before the
9934 @code{XOVER} request is split into several request.  Note that if your
9935 network is fast, setting this variable to a really small number means
9936 that fetching will probably be slower.  If this variable is @code{nil},
9937 @code{nntp} will never split requests.  The default is 5.
9938
9939 @item nntp-prepare-server-hook
9940 @vindex nntp-prepare-server-hook
9941 A hook run before attempting to connect to an @sc{nntp} server.
9942
9943 @item nntp-warn-about-losing-connection
9944 @vindex nntp-warn-about-losing-connection
9945 If this variable is non-@code{nil}, some noise will be made when a
9946 server closes connection.
9947
9948 @item nntp-record-commands
9949 @vindex nntp-record-commands
9950 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9951 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9952 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
9953 that doesn't seem to work.
9954
9955 @end table
9956
9957
9958 @node News Spool
9959 @subsection News Spool
9960 @cindex nnspool
9961 @cindex news spool
9962
9963 Subscribing to a foreign group from the local spool is extremely easy,
9964 and might be useful, for instance, to speed up reading groups that
9965 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9966 instance.
9967
9968 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9969 anything else) as the address.
9970
9971 If you have access to a local spool, you should probably use that as the
9972 native select method (@pxref{Finding the News}).  It is normally faster
9973 than using an @code{nntp} select method, but might not be.  It depends.
9974 You just have to try to find out what's best at your site.
9975
9976 @table @code
9977
9978 @item nnspool-inews-program
9979 @vindex nnspool-inews-program
9980 Program used to post an article.
9981
9982 @item nnspool-inews-switches
9983 @vindex nnspool-inews-switches
9984 Parameters given to the inews program when posting an article.
9985
9986 @item nnspool-spool-directory
9987 @vindex nnspool-spool-directory
9988 Where @code{nnspool} looks for the articles.  This is normally
9989 @file{/usr/spool/news/}.
9990
9991 @item nnspool-nov-directory
9992 @vindex nnspool-nov-directory
9993 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9994 @file{/usr/spool/news/over.view/}.
9995
9996 @item nnspool-lib-dir
9997 @vindex nnspool-lib-dir
9998 Where the news lib dir is (@file{/usr/lib/news/} by default).
9999
10000 @item nnspool-active-file
10001 @vindex nnspool-active-file
10002 The path to the active file.
10003
10004 @item nnspool-newsgroups-file
10005 @vindex nnspool-newsgroups-file
10006 The path to the group descriptions file.
10007
10008 @item nnspool-history-file
10009 @vindex nnspool-history-file
10010 The path to the news history file.
10011
10012 @item nnspool-active-times-file
10013 @vindex nnspool-active-times-file
10014 The path to the active date file.
10015
10016 @item nnspool-nov-is-evil
10017 @vindex nnspool-nov-is-evil
10018 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
10019 that it finds.
10020
10021 @item nnspool-sift-nov-with-sed
10022 @vindex nnspool-sift-nov-with-sed
10023 @cindex sed
10024 If non-@code{nil}, which is the default, use @code{sed} to get the
10025 relevant portion from the overview file.  If nil, @code{nnspool} will
10026 load the entire file into a buffer and process it there.
10027
10028 @end table
10029
10030
10031 @node Getting Mail
10032 @section Getting Mail
10033 @cindex reading mail
10034 @cindex mail
10035
10036 Reading mail with a newsreader---isn't that just plain WeIrD? But of
10037 course.
10038
10039 @menu
10040 * Mail in a Newsreader::         Important introductory notes.  
10041 * Getting Started Reading Mail:: A simple cookbook example.
10042 * Splitting Mail::               How to create mail groups.
10043 * Mail Sources::                 How to tell Gnus where to get mail from.
10044 * Mail Backend Variables::       Variables for customizing mail handling.
10045 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
10046 * Group Mail Splitting::         Use group customize to drive mail splitting.
10047 * Incorporating Old Mail::       What about the old mail you have?
10048 * Expiring Mail::                Getting rid of unwanted mail.
10049 * Washing Mail::                 Removing gruft from the mail you get.
10050 * Duplicates::                   Dealing with duplicated mail.
10051 * Not Reading Mail::             Using mail backends for reading other files.
10052 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
10053 @end menu
10054
10055
10056 @node Mail in a Newsreader
10057 @subsection Mail in a Newsreader
10058
10059 If you are used to traditional mail readers, but have decided to switch 
10060 to reading mail with Gnus, you may find yourself experiencing something
10061 of a culture shock.
10062
10063 Gnus does not behave like traditional mail readers.  If you want to make 
10064 it behave that way, you can, but it's an uphill battle.
10065
10066 Gnus, by default, handles all its groups using the same approach.  This
10067 approach is very newsreaderly---you enter a group, see the new/unread
10068 messages, and when you read the messages, they get marked as read, and
10069 you don't see them any more.  (Unless you explicitly ask for them.)
10070
10071 In particular, you do not do anything explicitly to delete messages.
10072
10073 Does this mean that all the messages that have been marked as read are
10074 deleted?  How awful!
10075
10076 But, no, it means that old messages are @dfn{expired} according to some
10077 scheme or other.  For news messages, the expire process is controlled by 
10078 the news administrator; for mail, the expire process is controlled by
10079 you.  The expire process for mail is covered in depth in @pxref{Expiring
10080 Mail}.
10081
10082 What many Gnus users find, after using it a while for both news and
10083 mail, is that the transport mechanism has very little to do with how
10084 they want to treat a message.
10085
10086 Many people subscribe to several mailing lists.  These are transported
10087 via SMTP, and are therefore mail.  But we might go for weeks without
10088 answering, or even reading these messages very carefully. We may not
10089 need to save them because if we should need to read one again, they are
10090 archived somewhere else.
10091
10092 Some people have local news groups which have only a handful of readers.
10093 These are transported via NNTP, and are therefore news.  But we may need
10094 to read and answer a large fraction of the messages very carefully in
10095 order to do our work.  And there may not be an archive, so we may need
10096 to save the interesting messages the same way we would personal mail.
10097
10098 The important distinction turns out to be not the transport mechanism,
10099 but other factors such as how interested we are in the subject matter,
10100 or how easy it is to retrieve the message if we need to read it again.
10101
10102 Gnus provides many options for sorting mail into ``groups'' which behave
10103 like newsgroups, and for treating each group (whether mail or news)
10104 differently.
10105
10106 Some users never get comfortable using the Gnus (ahem) paradigm and wish
10107 that Gnus should grow up and be a male, er, mail reader.  It is possible
10108 to whip Gnus into a more mailreaderly being, but, as said before, it's
10109 not easy.  People who prefer proper mail readers should try @sc{vm}
10110 instead, which is an excellent, and proper, mail reader.
10111
10112 I don't mean to scare anybody off, but I want to make it clear that you
10113 may be required to learn a new way of thinking about messages.  After
10114 you've been subjected to The Gnus Way, you will come to love it.  I can
10115 guarantee it.  (At least the guy who sold me the Emacs Subliminal
10116 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
10117 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
10118 You Do.)
10119
10120
10121 @node Getting Started Reading Mail
10122 @subsection Getting Started Reading Mail
10123
10124 It's quite easy to use Gnus to read your new mail.  You just plonk the
10125 mail backend of your choice into @code{gnus-secondary-select-methods},
10126 and things will happen automatically.
10127
10128 For instance, if you want to use @code{nnml} (which is a "one file per
10129 mail" backend), you could put the following in your @file{.gnus} file:
10130
10131 @lisp
10132 (setq gnus-secondary-select-methods
10133       '((nnml "private")))
10134 @end lisp
10135
10136 Now, the next time you start Gnus, this backend will be queried for new
10137 articles, and it will move all the messages in your spool file to its
10138 directory, which is @code{~/Mail/} by default.  The new group that will
10139 be created (@samp{mail.misc}) will be subscribed, and you can read it
10140 like any other group.
10141
10142 You will probably want to split the mail into several groups, though:
10143
10144 @lisp
10145 (setq nnmail-split-methods
10146       '(("junk" "^From:.*Lars Ingebrigtsen")
10147         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
10148         ("other" "")))
10149 @end lisp
10150
10151 This will result in three new @code{nnml} mail groups being created:
10152 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
10153 mail that doesn't fit into the first two groups will be placed in the
10154 last group.
10155
10156 This should be sufficient for reading mail with Gnus.  You might want to
10157 give the other sections in this part of the manual a perusal, though.
10158 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10159
10160
10161 @node Splitting Mail
10162 @subsection Splitting Mail
10163 @cindex splitting mail
10164 @cindex mail splitting
10165
10166 @vindex nnmail-split-methods
10167 The @code{nnmail-split-methods} variable says how the incoming mail is
10168 to be split into groups.
10169
10170 @lisp
10171 (setq nnmail-split-methods
10172   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10173     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10174     ("mail.other" "")))
10175 @end lisp
10176
10177 This variable is a list of lists, where the first element of each of
10178 these lists is the name of the mail group (they do not have to be called
10179 something beginning with @samp{mail}, by the way), and the second
10180 element is a regular expression used on the header of each mail to
10181 determine if it belongs in this mail group.  The first string may
10182 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10183 insert sub-expressions from the matched text.  For instance:
10184
10185 @lisp
10186 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10187 @end lisp
10188
10189 The second element can also be a function.  In that case, it will be
10190 called narrowed to the headers with the first element of the rule as the
10191 argument.  It should return a non-@code{nil} value if it thinks that the
10192 mail belongs in that group.
10193
10194 The last of these groups should always be a general one, and the regular
10195 expression should @emph{always} be @samp{} so that it matches any mails
10196 that haven't been matched by any of the other regexps.  (These rules are
10197 processed from the beginning of the alist toward the end.  The first
10198 rule to make a match will "win", unless you have crossposting enabled.
10199 In that case, all matching rules will "win".)
10200
10201 If you like to tinker with this yourself, you can set this variable to a
10202 function of your choice.  This function will be called without any
10203 arguments in a buffer narrowed to the headers of an incoming mail
10204 message.  The function should return a list of group names that it
10205 thinks should carry this mail message.
10206
10207 Note that the mail backends are free to maul the poor, innocent,
10208 incoming headers all they want to.  They all add @code{Lines} headers;
10209 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10210 @code{From<SPACE>} line to something else.
10211
10212 @vindex nnmail-crosspost
10213 The mail backends all support cross-posting.  If several regexps match,
10214 the mail will be ``cross-posted'' to all those groups.
10215 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
10216 that no articles are crossposted to the general (@samp{}) group.
10217
10218 @vindex nnmail-crosspost-link-function
10219 @cindex crosspost
10220 @cindex links
10221 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10222 the crossposted articles.  However, not all file systems support hard
10223 links.  If that's the case for you, set
10224 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
10225 variable is @code{add-name-to-file} by default.)
10226
10227 @kindex M-x nnmail-split-history
10228 @kindex nnmail-split-history
10229 If you wish to see where the previous mail split put the messages, you
10230 can use the @kbd{M-x nnmail-split-history} command.
10231
10232 Gnus gives you all the opportunity you could possibly want for shooting
10233 yourself in the foot.  Let's say you create a group that will contain
10234 all the mail you get from your boss.  And then you accidentally
10235 unsubscribe from the group.  Gnus will still put all the mail from your
10236 boss in the unsubscribed group, and so, when your boss mails you ``Have
10237 that report ready by Monday or you're fired!'', you'll never see it and,
10238 come Tuesday, you'll still believe that you're gainfully employed while
10239 you really should be out collecting empty bottles to save up for next
10240 month's rent money.
10241
10242
10243 @node Mail Sources
10244 @subsection Mail Sources
10245
10246 Mail can be gotten from many different sources---the mail spool, from a
10247 POP mail server, or from a procmail directory, for instance.
10248
10249 @menu
10250 * Mail Source Specifiers::       How to specify what a mail source is.
10251 * Mail Source Customization::    Some variables that influence things.
10252 * Fetching Mail::                Using the mail source specifiers.
10253 @end menu
10254
10255
10256 @node Mail Source Specifiers
10257 @subsubsection Mail Source Specifiers
10258 @cindex POP
10259 @cindex mail server
10260 @cindex procmail
10261 @cindex mail spool
10262 @cindex mail source
10263
10264 You tell Gnus how to fetch mail by setting @code{mail-sources}
10265 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
10266
10267 Here's an example:
10268
10269 @lisp
10270 (pop :server "pop3.mailserver.com" :user "myname")
10271 @end lisp
10272
10273 As can be observed, a mail source specifier is a list where the first
10274 element is a @dfn{mail source type}, followed by an arbitrary number of
10275 @dfn{keywords}.  Keywords that are not explicitly specified are given
10276 default values.
10277
10278 The following mail source types are available:
10279
10280 @table @code
10281 @item file
10282 Get mail from a single file; typically from the mail spool.
10283
10284 Keywords:
10285
10286 @table @code
10287 @item :path
10288 The path of the file.  Defaults to the value of the @code{MAIL}
10289 environment variable or @file{/usr/mail/spool/user-name}.
10290 @end table
10291
10292 An example file mail source:
10293
10294 @lisp
10295 (file :path "/usr/spool/mail/user-name")
10296 @end lisp
10297
10298 Or using the default path:
10299
10300 @lisp
10301 (file)
10302 @end lisp
10303
10304 If the mail spool file is not located on the local machine, it's best to 
10305 use POP or IMAP or the like to fetch the mail.  You can not you ange-ftp 
10306 file names here---it has no way to lock the mail spool while moving the
10307 mail.
10308
10309 If it's impossible to set up a proper server, you can use ssh instead.
10310
10311 @lisp
10312 (setq mail-sources
10313       '((file :prescript "ssh host bin/getmail >%t")))
10314 @end lisp
10315
10316 The @samp{getmail} script would look something like the following:
10317
10318 @example
10319 #!/bin/sh
10320 #  getmail - move mail from spool to stdout
10321 #  flu@@iki.fi
10322
10323 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
10324 TMP=~/Mail/tmp
10325 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
10326 @end example
10327
10328 Alter this script to fit find the @samp{movemail} you want to use.
10329
10330
10331 @item directory
10332 Get mail from several files in a directory.  This is typically used when
10333 you have procmail split the incoming mail into several files.
10334
10335 Keywords:
10336
10337 @table @code
10338 @item :path
10339 The path of the directory where the files are.  There is no default
10340 value.
10341
10342 @item :suffix
10343 Only files ending with this suffix are used.  The default is
10344 @samp{.spool}.
10345
10346 @item :predicate
10347 Only files that have this predicate return non-@code{nil} are returned.
10348 The default is @code{identity}.  This is used as an additional
10349 filter---only files that have the right suffix @emph{and} satisfy this
10350 predicate are considered.
10351
10352 @item :prescript
10353 @itemx :postscript
10354 Script run before/after fetching mail.
10355
10356 @end table
10357
10358 An example directory mail source:
10359
10360 @lisp
10361 (directory :path "/home/user-name/procmail-dir/"
10362            :suffix ".prcml")
10363 @end lisp
10364
10365 @item pop
10366 Get mail from a POP server.
10367
10368 Keywords:
10369
10370 @table @code
10371 @item :server
10372 The name of the POP server.  The default is taken from the
10373 @code{MAILHOST} environment variable.
10374
10375 @item :port
10376 The port number of the POP server.  The default is @samp{pop3}.
10377
10378 @item :user
10379 The user name to give to the POP server.  The default is the login
10380 name.
10381
10382 @item :password
10383 The password to give to the POP server.  If not specified, the user is
10384 prompted.
10385
10386 @item :program
10387 The program to use to fetch mail from the POP server.  This is should be
10388 a @code{format}-like string.  Here's an example:
10389
10390 @example
10391 fetchmail %u@@%s -P %p %t
10392 @end example
10393
10394 The valid format specifier characters are:
10395
10396 @table @samp
10397 @item t
10398 The name of the file the mail is to be moved to.  This must always be
10399 included in this string.
10400
10401 @item s
10402 The name of the server.
10403
10404 @item P
10405 The port number of the server.
10406
10407 @item u
10408 The user name to use.
10409
10410 @item p
10411 The password to use.
10412 @end table
10413
10414 The values used for these specs are taken from the values you give the
10415 corresponding keywords.
10416
10417 @item :prescript
10418 A script to be run before fetching the mail.  The syntax is the same as
10419 the @code{:program} keyword.  This can also be a function to be run.
10420
10421 @item :postscript
10422 A script to be run after fetching the mail.  The syntax is the same as
10423 the @code{:program} keyword.  This can also be a function to be run.
10424
10425 @item :function
10426 The function to use to fetch mail from the POP server.  The function is
10427 called with one parameter---the name of the file where the mail should
10428 be moved to.
10429
10430 @item :authentication
10431 This can be either the symbol @code{password} or the symbol @code{apop}
10432 and says what authentication scheme to use.  The default is
10433 @code{password}.
10434
10435 @end table
10436
10437 If the @code{:program} and @code{:function} keywords aren't specified,
10438 @code{pop3-movemail} will be used.
10439
10440 Here are some examples.  Fetch from the default POP server, using the
10441 default user name, and default fetcher:
10442
10443 @lisp
10444 (pop)
10445 @end lisp
10446
10447 Fetch from a named server with a named user and password:
10448
10449 @lisp
10450 (pop :server "my.pop.server"
10451      :user "user-name" :password "secret")
10452 @end lisp
10453
10454 Use @samp{movemail} to move the mail:
10455
10456 @lisp
10457 (pop :program "movemail po:%u %t %p")
10458 @end lisp
10459
10460 @item maildir
10461 Get mail from a maildir. This is a type of mailbox currently only
10462 supported by qmail, where each file in a special directory contains
10463 exactly one mail.
10464
10465 Keywords:
10466
10467 @table @code
10468 @item :path
10469 The path of the directory where the mails are stored.  The default is
10470 @samp{~/Maildir/new}.
10471
10472 If you sometimes look at your mail through a pop3 daemon before fetching
10473 them with Gnus, you may also have to fetch your mails from the
10474 @code{cur} directory inside the maildir, like in the following example.
10475
10476 @end table
10477
10478 An example maildir mail source:
10479
10480 @lisp
10481 (maildir :path "/home/user-name/Maildir/cur")
10482 @end lisp
10483
10484 @item imap
10485 Get mail from a IMAP server. If you don't want to use IMAP as intended,
10486 as a network mail reading protocol (ie with nnimap), for some reason or
10487 other, Gnus let you treat it similar to a POP server and fetches
10488 articles from a given IMAP mailbox.
10489
10490 Keywords:
10491
10492 @table @code
10493 @item :server
10494 The name of the IMAP server.  The default is taken from the
10495 @code{MAILHOST} environment variable.
10496
10497 @item :port
10498 The port number of the IMAP server.  The default is @samp{143}, or
10499 @samp{993} for SSL connections.
10500
10501 @item :user
10502 The user name to give to the IMAP server.  The default is the login
10503 name.
10504
10505 @item :password
10506 The password to give to the IMAP server.  If not specified, the user is
10507 prompted.
10508
10509 @item :stream
10510 What stream to use for connecting to the server, this is one of the
10511 symbols in @code{imap-stream-alist}. Right now, this means
10512 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
10513
10514 @item :authenticator
10515 Which authenticator to use for authenticating to the server, this is one
10516 of the symbols in @code{imap-authenticator-alist}. Right now, this means
10517 @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
10518 @samp{login}.
10519
10520 @item :mailbox
10521 The name of the mailbox to get mail from. The default is @samp{INBOX}
10522 which normally is the mailbox which receive incoming mail.
10523
10524 @item :predicate
10525 The predicate used to find articles to fetch. The default, 
10526 @samp{UNSEEN UNDELETED}, is probably the best choice for most people,
10527 but if you sometimes peek in your mailbox with a IMAP client and mark
10528 some articles as read (or; SEEN) you might want to set this to
10529 @samp{nil}. Then all articles in the mailbox is fetched, no matter
10530 what. For a complete list of predicates, see RFC2060 \e-A§6.4.4.\e$)A
10531
10532 @item :fetchflag
10533 How to flag fetched articles on the server, the default @samp{\Deleted}
10534 will mark them as deleted, an alternative would be @samp{\Seen} which
10535 would simply mark them as read. Theese are the two most likely choices,
10536 but more flags are defined in RFC2060 \e-A§2.3.2.\e$)A
10537
10538 @item :dontexpunge
10539 If non-nil, don't remove all articles marked as deleted in the mailbox
10540 after finishing the fetch.
10541
10542 @end table
10543
10544 An example IMAP mail source:
10545
10546 @lisp
10547 (imap :server "mail.mycorp.com" :stream kerberos4)
10548 @end lisp
10549
10550 @item webmail
10551 Get mail from a webmail server, such as www.hotmail.com, 
10552 mail.yahoo.com, and www.netaddress.com. 
10553
10554 WARNING: Mails may lost. NO WARRANTY.
10555
10556 Keywords:
10557
10558 @table @code
10559 @item :subtype
10560 The type of the webmail server.  The default is @code{hotmail}. The
10561 alternatives are @code{yahoo}, @code{netaddress}.
10562
10563 @item :user
10564 The user name to give to the webmail server.  The default is the login
10565 name.
10566
10567 @item :password
10568 The password to give to the webmail server.  If not specified, the user is
10569 prompted.
10570
10571 @end table
10572
10573 An example webmail source:
10574
10575 @lisp
10576 (webmail :subtype 'yahoo :user "user-name" :password "secret")
10577 @end lisp
10578 @end table
10579
10580
10581 @node Mail Source Customization
10582 @subsubsection Mail Source Customization
10583
10584 The following is a list of variables that influence how the mail is
10585 fetched.  You would normally not need to set or change any of these
10586 variables.
10587
10588 @table @code
10589 @item mail-source-crash-box
10590 @vindex mail-source-crash-box
10591 File where mail will be stored while processing it.  The default is
10592 @file{~/.emacs-mail-crash-box}.
10593
10594 @item mail-source-delete-incoming
10595 @vindex mail-source-delete-incoming
10596 If non-@code{nil}, delete incoming files after handling them.
10597
10598 @item mail-source-directory
10599 @vindex mail-source-directory
10600 Directory where files (if any) will be stored.  The default is
10601 @file{~/Mail/}.  At present, the only thing this is used for is to say
10602 where the incoming files will be stored if the previous variable is
10603 @code{nil}.
10604
10605 @item mail-source-default-file-modes
10606 @vindex mail-source-default-file-modes
10607 All new mail files will get this file mode.  The default is 384.
10608
10609 @end table
10610
10611
10612 @node Fetching Mail
10613 @subsubsection Fetching Mail
10614
10615 @vindex mail-sources
10616 @vindex nnmail-spool-file
10617 The way to actually tell Gnus where to get new mail from is to set
10618 @code{mail-sources} to a list of mail source specifiers
10619 (@pxref{Mail Source Specifiers}).
10620
10621 If this variable (and the obsolescent @code{nnmail-spool-file}) is
10622 @code{nil}, the mail backends will never attempt to fetch mail by
10623 themselves.
10624
10625 If you want to fetch mail both from your local spool as well as a POP
10626 mail server, you'd say something like:
10627
10628 @lisp
10629 (setq mail-sources
10630       '((file)
10631         (pop :server "pop3.mail.server"
10632              :password "secret")))
10633 @end lisp
10634
10635 Or, if you don't want to use any of the keyword defaults:
10636
10637 @lisp
10638 (setq mail-sources
10639       '((file :path "/var/spool/mail/user-name")
10640         (pop :server "pop3.mail.server"
10641              :user "user-name"
10642              :port "pop3"
10643              :password "secret")))
10644 @end lisp
10645
10646
10647 When you use a mail backend, Gnus will slurp all your mail from your
10648 inbox and plonk it down in your home directory.  Gnus doesn't move any
10649 mail if you're not using a mail backend---you have to do a lot of magic
10650 invocations first.  At the time when you have finished drawing the
10651 pentagram, lightened the candles, and sacrificed the goat, you really
10652 shouldn't be too surprised when Gnus moves your mail.
10653
10654
10655
10656 @node Mail Backend Variables
10657 @subsection Mail Backend Variables
10658
10659 These variables are (for the most part) pertinent to all the various
10660 mail backends.
10661
10662 @table @code
10663 @vindex nnmail-read-incoming-hook
10664 @item nnmail-read-incoming-hook
10665 The mail backends all call this hook after reading new mail.  You can
10666 use this hook to notify any mail watch programs, if you want to.
10667
10668 @vindex nnmail-split-hook
10669 @item nnmail-split-hook
10670 @findex article-decode-encoded-words
10671 @findex RFC1522 decoding
10672 @findex RFC2047 decoding
10673 Hook run in the buffer where the mail headers of each message is kept
10674 just before the splitting based on these headers is done.  The hook is
10675 free to modify the buffer contents in any way it sees fit---the buffer
10676 is discarded after the splitting has been done, and no changes performed
10677 in the buffer will show up in any files.
10678 @code{gnus-article-decode-encoded-words} is one likely function to add
10679 to this hook.
10680
10681 @vindex nnmail-pre-get-new-mail-hook
10682 @vindex nnmail-post-get-new-mail-hook
10683 @item nnmail-pre-get-new-mail-hook
10684 @itemx nnmail-post-get-new-mail-hook
10685 These are two useful hooks executed when treating new incoming
10686 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10687 starting to handle the new mail) and
10688 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10689 is done).  Here's and example of using these two hooks to change the
10690 default file modes the new mail files get:
10691
10692 @lisp
10693 (add-hook 'gnus-pre-get-new-mail-hook
10694           (lambda () (set-default-file-modes 511)))
10695
10696 (add-hook 'gnus-post-get-new-mail-hook
10697           (lambda () (set-default-file-modes 551)))
10698 @end lisp
10699
10700 @item nnmail-use-long-file-names
10701 @vindex nnmail-use-long-file-names
10702 If non-@code{nil}, the mail backends will use long file and directory
10703 names.  Groups like @samp{mail.misc} will end up in directories
10704 (assuming use of @code{nnml} backend) or files (assuming use of
10705 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
10706 the same group will end up in @file{mail/misc}.
10707
10708 @item nnmail-delete-file-function
10709 @vindex nnmail-delete-file-function
10710 @findex delete-file
10711 Function called to delete files.  It is @code{delete-file} by default.
10712
10713 @item nnmail-cache-accepted-message-ids
10714 @vindex nnmail-cache-accepted-message-ids
10715 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10716 the backend (via @code{Gcc}, for instance) into the mail duplication
10717 discovery cache.  The default is @code{nil}.
10718
10719 @end table
10720
10721
10722 @node Fancy Mail Splitting
10723 @subsection Fancy Mail Splitting
10724 @cindex mail splitting
10725 @cindex fancy mail splitting
10726
10727 @vindex nnmail-split-fancy
10728 @findex nnmail-split-fancy
10729 If the rather simple, standard method for specifying how to split mail
10730 doesn't allow you to do what you want, you can set
10731 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
10732 play with the @code{nnmail-split-fancy} variable.
10733
10734 Let's look at an example value of this variable first:
10735
10736 @lisp
10737 ;; Messages from the mailer daemon are not crossposted to any of
10738 ;; the ordinary groups.  Warnings are put in a separate group
10739 ;; from real errors.
10740 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10741                    "mail.misc"))
10742    ;; Non-error messages are crossposted to all relevant
10743    ;; groups, but we don't crosspost between the group for the
10744    ;; (ding) list and the group for other (ding) related mail.
10745    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10746          ("subject" "ding" "ding.misc"))
10747       ;; Other mailing lists...
10748       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10749       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10750       ;; Both lists below have the same suffix, so prevent
10751       ;; cross-posting to mkpkg.list of messages posted only to 
10752       ;; the bugs- list, but allow cross-posting when the
10753       ;; message was really cross-posted.
10754       (any "bugs-mypackage@@somewhere" "mypkg.bugs")
10755       (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
10756       ;; People...
10757       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10758    ;; Unmatched mail goes to the catch all group.
10759    "misc.misc")
10760 @end lisp
10761
10762 This variable has the format of a @dfn{split}.  A split is a (possibly)
10763 recursive structure where each split may contain other splits.  Here are
10764 the five possible split syntaxes:
10765
10766 @enumerate
10767
10768 @item
10769 @samp{group}: If the split is a string, that will be taken as a group
10770 name.  Normal regexp match expansion will be done.  See below for
10771 examples.
10772
10773 @item
10774 @code{(@var{field} @var{value} @var{[- restrict [- restrict [@dots{}]]]} 
10775 @var{split})}: If the split is a list, the first element of which is a
10776 string, then store the message as specified by @var{split}, if header
10777 @var{field} (a regexp) contains @var{value} (also a regexp).  If
10778 @var{restrict} (yet another regexp) matches some string after
10779 @var{field} and before the end of the matched @var{value}, the
10780 @var{split} is ignored.  If none of the @var{restrict} clauses match,
10781 @var{split} is processed.
10782
10783 @item
10784 @code{(| @var{split}@dots{})}: If the split is a list, and the first
10785 element is @code{|} (vertical bar), then process each @var{split} until
10786 one of them matches.  A @var{split} is said to match if it will cause
10787 the mail message to be stored in one or more groups.
10788
10789 @item
10790 @code{(& @var{split}@dots{})}: If the split is a list, and the first
10791 element is @code{&}, then process all @var{split}s in the list.
10792
10793 @item
10794 @code{junk}: If the split is the symbol @code{junk}, then don't save
10795 this message. Use with extreme caution.
10796
10797 @item
10798 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}:  If the split is
10799 a list, and the first element is @code{:}, then the second element will
10800 be called as a function with @var{args} given as arguments.  The
10801 function should return a @var{split}.
10802
10803 @item
10804 @code{(! @var{func} @var{split})}: If the split is a list, and the first
10805 element is @code{!}, then SPLIT will be processed, and FUNC will be
10806 called as a function with the result of SPLIT as argument. FUNC should
10807 return a split.
10808
10809 @item
10810 @code{nil}: If the split is @code{nil}, it is ignored.
10811
10812 @end enumerate
10813
10814 In these splits, @var{field} must match a complete field name.
10815 @var{value} must match a complete word according to the fundamental mode
10816 syntax table.  You can use @code{.*} in the regexps to match partial
10817 field names or words.  In other words, all @var{value}'s are wrapped in
10818 @samp{\<} and @samp{\>} pairs.
10819
10820 @vindex nnmail-split-abbrev-alist
10821 @var{field} and @var{value} can also be lisp symbols, in that case they
10822 are expanded as specified by the variable
10823 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
10824 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10825 value.
10826
10827 @vindex nnmail-split-fancy-syntax-table
10828 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10829 when all this splitting is performed.
10830
10831 If you want to have Gnus create groups dynamically based on some
10832 information in the headers (i.e., do @code{replace-match}-like
10833 substitutions in the group names), you can say things like:
10834
10835 @example
10836 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10837 @end example
10838
10839 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
10840 will be filed in @samp{mail.debian.foo}.
10841
10842 If the string contains the element @samp{\&}, then the previously
10843 matched string will be substituted.  Similarly, the elements @samp{\\1}
10844 up to @samp{\\9} will be substituted with the text matched by the
10845 groupings 1 through 9.
10846
10847
10848 @node Group Mail Splitting
10849 @subsection Group Mail Splitting
10850 @cindex mail splitting
10851 @cindex group mail splitting
10852
10853 @findex gnus-group-split
10854 If you subscribe to dozens of mailing lists but you don't want to
10855 maintain mail splitting rules manually, group mail splitting is for you.
10856 You just have to set @var{to-list} and/or @var{to-address} in group
10857 parameters or group customization and set @code{nnmail-split-methods} to
10858 @code{gnus-group-split}.  This splitting function will scan all groups
10859 for those parameters and split mail accordingly, i.e., messages posted
10860 from or to the addresses specified in the parameters @var{to-list} or
10861 @var{to-address} of a mail group will be stored in that group.
10862
10863 Sometimes, mailing lists have multiple addresses, and you may want mail
10864 splitting to recognize them all: just set the @var{extra-aliases} group
10865 parameter to the list of additional addresses and it's done.  If you'd
10866 rather use a regular expression, set @var{split-regexp}.
10867
10868 All these parameters in a group will be used to create an
10869 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
10870 the @var{value} is a single regular expression that matches
10871 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
10872 matches of @var{split-regexp}, and the @var{split} is the name of the
10873 group.  @var{restrict}s are also supported: just set the
10874 @var{split-exclude} parameter to a list of regular expressions.
10875
10876 If you can't get the right split to be generated using all these
10877 parameters, or you just need something fancier, you can set the
10878 parameter @var{split-spec} to an @code{nnmail-split-fancy} split.  In
10879 this case, all other aforementioned parameters will be ignored by
10880 @code{gnus-group-split}.  In particular, @var{split-spec} may be set to
10881 @code{nil}, in which case the group will be ignored by
10882 @code{gnus-group-split}.
10883
10884 @vindex gnus-group-split-default-catch-all-group
10885 @code{gnus-group-split} will do cross-posting on all groups that match,
10886 by defining a single @code{&} fancy split containing one split for each
10887 group.  If a message doesn't match any split, it will be stored in the
10888 group named in @code{gnus-group-split-default-catch-all-group}, unless
10889 some group has @var{split-spec} set to @code{catch-all}, in which case
10890 that group is used as the catch-all group.  Note that, in this case,
10891 there's no cross-posting, as a @code{|} fancy split encloses the
10892 @code{&} split and the catch-all group.
10893
10894 It's time for an example.  Assume the following group parameters have
10895 been defined:
10896
10897 @example
10898 nnml:mail.bar:
10899 ((to-address . "bar@@femail.com")
10900  (split-regexp . ".*@@femail\\.com"))
10901 nnml:mail.foo:
10902 ((to-list . "foo@@nowhere.gov")
10903  (extra-aliases "foo@@localhost" "foo-redist@@home")
10904  (split-exclude "bugs-foo" "rambling-foo")
10905  (admin-address . "foo-request@@nowhere.gov"))
10906 nnml:mail.others:
10907 ((split-spec . catch-all))
10908 @end example
10909
10910 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
10911 behave as if @code{nnmail-split-fancy} had been selected and variable
10912 @code{nnmail-split-fancy} had been set as follows:
10913
10914 @lisp
10915 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
10916       (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
10917            - "bugs-foo" - "rambling-foo" "mail.foo"))
10918    "mail.others")
10919 @end lisp
10920
10921 @findex gnus-group-split-fancy
10922 If you'd rather not use group splitting for all your mail groups, you
10923 may use it for only some of them, by using @code{nnmail-split-fancy}
10924 splits like this:
10925
10926 @lisp
10927 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
10928 @end lisp
10929
10930 @var{groups} may be a regular expression or a list of group names whose
10931 parameters will be scanned to generate the output split.
10932 @var{no-crosspost} can be used to disable cross-posting; in this case, a
10933 single @code{|} split will be output.  @var{catch-all} may be the name
10934 of a group to be used as the default catch-all group.  If
10935 @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
10936 empty string in any selected group, no catch-all split will be issued.
10937 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
10938 this group will override the value of the @var{catch-all} argument.
10939
10940 @findex gnus-group-split-setup
10941 Unfortunately, scanning all groups and their parameters can be quite
10942 slow, especially considering that it has to be done for every message.
10943 But don't despair!  The function @code{gnus-group-split-setup} can be
10944 used to select @code{gnus-group-split} in a much more efficient way.  It
10945 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
10946 @code{nnmail-split-fancy} to the split produced by
10947 @code{gnus-group-split-fancy}.  Thus, the group parameters are only
10948 scanned once, no matter how many messages are split.
10949
10950 @findex gnus-group-split-update
10951 However, if you change group parameters, you have to update
10952 @code{nnmail-split-fancy} manually.  You can do it by running
10953 @code{gnus-group-split-update}.  If you'd rather have it updated
10954 automatically, just tell @code{gnus-group-split-setup} to do it for
10955 you.  For example, add to your @file{.gnus}:
10956
10957 @lisp
10958 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
10959 @end lisp
10960
10961 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
10962 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
10963 have to worry about updating @code{nnmail-split-fancy} again.  If you
10964 don't omit @var{catch-all} (it's optional),
10965 @code{gnus-group-split-default-catch-all-group} will be set to its
10966 value.
10967
10968 @vindex gnus-group-split-updated-hook
10969 Because you may want to change @code{nnmail-split-fancy} after it is set
10970 by @code{gnus-group-split-update}, this function will run
10971 @code{gnus-group-split-updated-hook} just before finishing.
10972
10973 @node Incorporating Old Mail
10974 @subsection Incorporating Old Mail
10975
10976 Most people have lots of old mail stored in various file formats.  If
10977 you have set up Gnus to read mail using one of the spiffy Gnus mail
10978 backends, you'll probably wish to have that old mail incorporated into
10979 your mail groups.
10980
10981 Doing so can be quite easy.
10982
10983 To take an example: You're reading mail using @code{nnml}
10984 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10985 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
10986 file filled with important, but old, mail.  You want to move it into
10987 your @code{nnml} groups.
10988
10989 Here's how:
10990
10991 @enumerate
10992 @item
10993 Go to the group buffer.
10994
10995 @item
10996 Type `G f' and give the path to the mbox file when prompted to create an
10997 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10998
10999 @item
11000 Type `SPACE' to enter the newly created group.
11001
11002 @item
11003 Type `M P b' to process-mark all articles in this group's buffer
11004 (@pxref{Setting Process Marks}).
11005
11006 @item
11007 Type `B r' to respool all the process-marked articles, and answer
11008 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
11009 @end enumerate
11010
11011 All the mail messages in the mbox file will now also be spread out over
11012 all your @code{nnml} groups.  Try entering them and check whether things
11013 have gone without a glitch.  If things look ok, you may consider
11014 deleting the mbox file, but I wouldn't do that unless I was absolutely
11015 sure that all the mail has ended up where it should be.
11016
11017 Respooling is also a handy thing to do if you're switching from one mail
11018 backend to another.  Just respool all the mail in the old mail groups
11019 using the new mail backend.
11020
11021
11022 @node Expiring Mail
11023 @subsection Expiring Mail
11024 @cindex article expiry
11025
11026 Traditional mail readers have a tendency to remove mail articles when
11027 you mark them as read, in some way.  Gnus takes a fundamentally
11028 different approach to mail reading.
11029
11030 Gnus basically considers mail just to be news that has been received in
11031 a rather peculiar manner.  It does not think that it has the power to
11032 actually change the mail, or delete any mail messages.  If you enter a
11033 mail group, and mark articles as ``read'', or kill them in some other
11034 fashion, the mail articles will still exist on the system.  I repeat:
11035 Gnus will not delete your old, read mail.  Unless you ask it to, of
11036 course.
11037
11038 To make Gnus get rid of your unwanted mail, you have to mark the
11039 articles as @dfn{expirable}.  This does not mean that the articles will
11040 disappear right away, however.  In general, a mail article will be
11041 deleted from your system if, 1) it is marked as expirable, AND 2) it is
11042 more than one week old.  If you do not mark an article as expirable, it
11043 will remain on your system until hell freezes over.  This bears
11044 repeating one more time, with some spurious capitalizations: IF you do
11045 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
11046
11047 @vindex gnus-auto-expirable-newsgroups
11048 You do not have to mark articles as expirable by hand.  Groups that
11049 match the regular expression @code{gnus-auto-expirable-newsgroups} will
11050 have all articles that you read marked as expirable automatically.  All
11051 articles marked as expirable have an @samp{E} in the first
11052 column in the summary buffer.
11053
11054 By default, if you have auto expiry switched on, Gnus will mark all the
11055 articles you read as expirable, no matter if they were read or unread
11056 before.  To avoid having articles marked as read marked as expirable
11057 automatically, you can put something like the following in your
11058 @file{.gnus} file:
11059
11060 @vindex gnus-mark-article-hook
11061 @lisp
11062 (remove-hook 'gnus-mark-article-hook
11063              'gnus-summary-mark-read-and-unread-as-read)
11064 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
11065 @end lisp
11066
11067 Note that making a group auto-expirable doesn't mean that all read
11068 articles are expired---only the articles marked as expirable
11069 will be expired.  Also note that using the @kbd{d} command won't make
11070 groups expirable---only semi-automatic marking of articles as read will
11071 mark the articles as expirable in auto-expirable groups.
11072
11073 Let's say you subscribe to a couple of mailing lists, and you want the
11074 articles you have read to disappear after a while:
11075
11076 @lisp
11077 (setq gnus-auto-expirable-newsgroups
11078       "mail.nonsense-list\\|mail.nice-list")
11079 @end lisp
11080
11081 Another way to have auto-expiry happen is to have the element
11082 @code{auto-expire} in the group parameters of the group.
11083
11084 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
11085 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
11086 don't really mix very well.
11087
11088 @vindex nnmail-expiry-wait
11089 The @code{nnmail-expiry-wait} variable supplies the default time an
11090 expirable article has to live.  Gnus starts counting days from when the
11091 message @emph{arrived}, not from when it was sent.  The default is seven
11092 days.
11093
11094 Gnus also supplies a function that lets you fine-tune how long articles
11095 are to live, based on what group they are in.  Let's say you want to
11096 have one month expiry period in the @samp{mail.private} group, a one day
11097 expiry period in the @samp{mail.junk} group, and a six day expiry period
11098 everywhere else:
11099
11100 @vindex nnmail-expiry-wait-function
11101 @lisp
11102 (setq nnmail-expiry-wait-function
11103       (lambda (group)
11104        (cond ((string= group "mail.private")
11105                31)
11106              ((string= group "mail.junk")
11107                1)
11108              ((string= group "important")
11109                'never)
11110              (t
11111                6))))
11112 @end lisp
11113
11114 The group names this function is fed are ``unadorned'' group
11115 names---no @samp{nnml:} prefixes and the like.
11116
11117 The @code{nnmail-expiry-wait} variable and
11118 @code{nnmail-expiry-wait-function} function can either be a number (not
11119 necessarily an integer) or one of the symbols @code{immediate} or
11120 @code{never}.
11121
11122 You can also use the @code{expiry-wait} group parameter to selectively
11123 change the expiry period (@pxref{Group Parameters}).
11124
11125 @vindex nnmail-keep-last-article
11126 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
11127 expire the final article in a mail newsgroup.  This is to make life
11128 easier for procmail users.
11129
11130 @vindex gnus-total-expirable-newsgroups
11131 By the way: That line up there, about Gnus never expiring non-expirable
11132 articles, is a lie.  If you put @code{total-expire} in the group
11133 parameters, articles will not be marked as expirable, but all read
11134 articles will be put through the expiry process.  Use with extreme
11135 caution.  Even more dangerous is the
11136 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
11137 this regexp will have all read articles put through the expiry process,
11138 which means that @emph{all} old mail articles in the groups in question
11139 will be deleted after a while.  Use with extreme caution, and don't come
11140 crying to me when you discover that the regexp you used matched the
11141 wrong group and all your important mail has disappeared.  Be a
11142 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
11143 with!  So there!
11144
11145 Most people make most of their mail groups total-expirable, though.
11146
11147 @vindex gnus-inhibit-user-auto-expire
11148 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
11149 commands will not mark an article as expirable, even if the group has
11150 auto-expire turned on.
11151
11152
11153 @node Washing Mail
11154 @subsection Washing Mail
11155 @cindex mail washing
11156 @cindex list server brain damage
11157 @cindex incoming mail treatment
11158
11159 Mailers and list servers are notorious for doing all sorts of really,
11160 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
11161 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
11162 end of all lines passing through our server, so let's do that!!!!1!''
11163 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
11164 considered to be self-evident were not discussed.  So.  Here we are.
11165
11166 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
11167 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
11168 be shocked and dismayed by this, but I haven't got the energy.  It is to
11169 laugh.
11170
11171 Gnus provides a plethora of functions for washing articles while
11172 displaying them, but it might be nicer to do the filtering before
11173 storing the mail to disc.  For that purpose, we have three hooks and
11174 various functions that can be put in these hooks.
11175
11176 @table @code
11177 @item nnmail-prepare-incoming-hook
11178 @vindex nnmail-prepare-incoming-hook
11179 This hook is called before doing anything with the mail and is meant for
11180 grand, sweeping gestures.  It is called in a buffer that contains all
11181 the new, incoming mail.  Functions to be used include:
11182
11183 @table @code
11184 @item nnheader-ms-strip-cr
11185 @findex nnheader-ms-strip-cr
11186 Remove trailing carriage returns from each line.  This is default on
11187 Emacs running on MS machines.
11188
11189 @end table
11190
11191 @item nnmail-prepare-incoming-header-hook
11192 @vindex nnmail-prepare-incoming-header-hook
11193 This hook is called narrowed to each header.  It can be used when
11194 cleaning up the headers.  Functions that can be used include:
11195
11196 @table @code
11197 @item nnmail-remove-leading-whitespace
11198 @findex nnmail-remove-leading-whitespace
11199 Clear leading white space that ``helpful'' listservs have added to the
11200 headers to make them look nice.  Aaah.
11201
11202 @item nnmail-remove-list-identifiers
11203 @findex nnmail-remove-list-identifiers
11204 Some list servers add an identifier---for example, @samp{(idm)}---to the
11205 beginning of all @code{Subject} headers.  I'm sure that's nice for
11206 people who use stone age mail readers.  This function will remove
11207 strings that match the @code{nnmail-list-identifiers} regexp, which can
11208 also be a list of regexp.
11209
11210 For instance, if you want to remove the @samp{(idm)} and the
11211 @samp{nagnagnag} identifiers:
11212
11213 @lisp
11214 (setq nnmail-list-identifiers
11215       '("(idm)" "nagnagnag"))
11216 @end lisp
11217
11218 This can also be done non-destructively with
11219 @code{gnus-list-identifiers}, @xref{Article Hiding}.
11220
11221 @item nnmail-remove-tabs
11222 @findex nnmail-remove-tabs
11223 Translate all @samp{TAB} characters into @samp{SPACE} characters.
11224
11225 @item nnmail-fix-eudora-headers
11226 @findex nnmail-fix-eudora-headers
11227 @cindex Eudora
11228 Eudora produces broken @code{References} headers, but OK
11229 @code{In-Reply-To} headers.  This function will get rid of the
11230 @code{References} headers.
11231
11232 @end table
11233
11234 @item nnmail-prepare-incoming-message-hook
11235 @vindex nnmail-prepare-incoming-message-hook
11236 This hook is called narrowed to each message.  Functions to be used
11237 include:
11238
11239 @table @code
11240 @item article-de-quoted-unreadable
11241 @findex article-de-quoted-unreadable
11242 Decode Quoted Readable encoding.
11243
11244 @end table
11245 @end table
11246
11247
11248 @node Duplicates
11249 @subsection Duplicates
11250
11251 @vindex nnmail-treat-duplicates
11252 @vindex nnmail-message-id-cache-length
11253 @vindex nnmail-message-id-cache-file
11254 @cindex duplicate mails
11255 If you are a member of a couple of mailing lists, you will sometimes
11256 receive two copies of the same mail.  This can be quite annoying, so
11257 @code{nnmail} checks for and treats any duplicates it might find.  To do
11258 this, it keeps a cache of old @code{Message-ID}s---
11259 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
11260 default.  The approximate maximum number of @code{Message-ID}s stored
11261 there is controlled by the @code{nnmail-message-id-cache-length}
11262 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
11263 stored.) If all this sounds scary to you, you can set
11264 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
11265 default), and @code{nnmail} won't delete duplicate mails.  Instead it
11266 will insert a warning into the head of the mail saying that it thinks
11267 that this is a duplicate of a different message.
11268
11269 This variable can also be a function.  If that's the case, the function
11270 will be called from a buffer narrowed to the message in question with
11271 the @code{Message-ID} as a parameter.  The function must return either
11272 @code{nil}, @code{warn}, or @code{delete}.
11273
11274 You can turn this feature off completely by setting the variable to
11275 @code{nil}.
11276
11277 If you want all the duplicate mails to be put into a special
11278 @dfn{duplicates} group, you could do that using the normal mail split
11279 methods:
11280
11281 @lisp
11282 (setq nnmail-split-fancy
11283       '(| ;; Messages duplicates go to a separate group.
11284           ("gnus-warning" "duplication of message" "duplicate")
11285           ;; Message from daemons, postmaster, and the like to another.
11286           (any mail "mail.misc")
11287           ;; Other rules.
11288           [ ... ] ))
11289 @end lisp
11290
11291 Or something like:
11292 @lisp
11293 (setq nnmail-split-methods
11294       '(("duplicates" "^Gnus-Warning:")
11295         ;; Other rules.
11296         [...]))
11297 @end lisp
11298
11299 Here's a neat feature: If you know that the recipient reads her mail
11300 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
11301 @code{delete}, you can send her as many insults as you like, just by
11302 using a @code{Message-ID} of a mail that you know that she's already
11303 received.  Think of all the fun!  She'll never see any of it!  Whee!
11304
11305
11306 @node Not Reading Mail
11307 @subsection Not Reading Mail
11308
11309 If you start using any of the mail backends, they have the annoying
11310 habit of assuming that you want to read mail with them.  This might not
11311 be unreasonable, but it might not be what you want.
11312
11313 If you set @code{mail-sources} and @code{nnmail-spool-file} to
11314 @code{nil}, none of the backends will ever attempt to read incoming
11315 mail, which should help.
11316
11317 @vindex nnbabyl-get-new-mail
11318 @vindex nnmbox-get-new-mail
11319 @vindex nnml-get-new-mail
11320 @vindex nnmh-get-new-mail
11321 @vindex nnfolder-get-new-mail
11322 This might be too much, if, for instance, you are reading mail quite
11323 happily with @code{nnml} and just want to peek at some old @sc{rmail}
11324 file you have stashed away with @code{nnbabyl}.  All backends have
11325 variables called backend-@code{get-new-mail}.  If you want to disable
11326 the @code{nnbabyl} mail reading, you edit the virtual server for the
11327 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
11328
11329 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
11330 narrowed to the article to be saved before saving it when reading
11331 incoming mail.
11332
11333
11334 @node Choosing a Mail Backend
11335 @subsection Choosing a Mail Backend
11336
11337 Gnus will read the mail spool when you activate a mail group.  The mail
11338 file is first copied to your home directory.  What happens after that
11339 depends on what format you want to store your mail in.
11340
11341 There are five different mail backends in the standard Gnus, and more
11342 backends are available separately.  The mail backend most people use
11343 (because it is the fastest and most flexible) is @code{nnml}
11344 (@pxref{Mail Spool}).
11345
11346 @menu
11347 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
11348 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
11349 * Mail Spool::                  Store your mail in a private spool?
11350 * MH Spool::                    An mhspool-like backend.
11351 * Mail Folders::                Having one file for each group.
11352 * Comparing Mail Backends::     An in-depth looks at pros and cons.
11353 @end menu
11354
11355
11356 @node Unix Mail Box
11357 @subsubsection Unix Mail Box
11358 @cindex nnmbox
11359 @cindex unix mail box
11360
11361 @vindex nnmbox-active-file
11362 @vindex nnmbox-mbox-file
11363 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
11364 mail.  @code{nnmbox} will add extra headers to each mail article to say
11365 which group it belongs in.
11366
11367 Virtual server settings:
11368
11369 @table @code
11370 @item nnmbox-mbox-file
11371 @vindex nnmbox-mbox-file
11372 The name of the mail box in the user's home directory.
11373
11374 @item nnmbox-active-file
11375 @vindex nnmbox-active-file
11376 The name of the active file for the mail box.
11377
11378 @item nnmbox-get-new-mail
11379 @vindex nnmbox-get-new-mail
11380 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
11381 into groups.
11382 @end table
11383
11384
11385 @node Rmail Babyl
11386 @subsubsection Rmail Babyl
11387 @cindex nnbabyl
11388 @cindex rmail mbox
11389
11390 @vindex nnbabyl-active-file
11391 @vindex nnbabyl-mbox-file
11392 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
11393 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
11394 article to say which group it belongs in.
11395
11396 Virtual server settings:
11397
11398 @table @code
11399 @item nnbabyl-mbox-file
11400 @vindex nnbabyl-mbox-file
11401 The name of the rmail mbox file.
11402
11403 @item nnbabyl-active-file
11404 @vindex nnbabyl-active-file
11405 The name of the active file for the rmail box.
11406
11407 @item nnbabyl-get-new-mail
11408 @vindex nnbabyl-get-new-mail
11409 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
11410 @end table
11411
11412
11413 @node Mail Spool
11414 @subsubsection Mail Spool
11415 @cindex nnml
11416 @cindex mail @sc{nov} spool
11417
11418 The @dfn{nnml} spool mail format isn't compatible with any other known
11419 format.  It should be used with some caution.
11420
11421 @vindex nnml-directory
11422 If you use this backend, Gnus will split all incoming mail into files,
11423 one file for each mail, and put the articles into the corresponding
11424 directories under the directory specified by the @code{nnml-directory}
11425 variable.  The default value is @file{~/Mail/}.
11426
11427 You do not have to create any directories beforehand; Gnus will take
11428 care of all that.
11429
11430 If you have a strict limit as to how many files you are allowed to store
11431 in your account, you should not use this backend.  As each mail gets its
11432 own file, you might very well occupy thousands of inodes within a few
11433 weeks.  If this is no problem for you, and it isn't a problem for you
11434 having your friendly systems administrator walking around, madly,
11435 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
11436 know that this is probably the fastest format to use.  You do not have
11437 to trudge through a big mbox file just to read your new mail.
11438
11439 @code{nnml} is probably the slowest backend when it comes to article
11440 splitting.  It has to create lots of files, and it also generates
11441 @sc{nov} databases for the incoming mails.  This makes it the fastest
11442 backend when it comes to reading mail.
11443
11444 Virtual server settings:
11445
11446 @table @code
11447 @item nnml-directory
11448 @vindex nnml-directory
11449 All @code{nnml} directories will be placed under this directory.
11450
11451 @item nnml-active-file
11452 @vindex nnml-active-file
11453 The active file for the @code{nnml} server.
11454
11455 @item nnml-newsgroups-file
11456 @vindex nnml-newsgroups-file
11457 The @code{nnml} group descriptions file.  @xref{Newsgroups File
11458 Format}.
11459
11460 @item nnml-get-new-mail
11461 @vindex nnml-get-new-mail
11462 If non-@code{nil}, @code{nnml} will read incoming mail.
11463
11464 @item nnml-nov-is-evil
11465 @vindex nnml-nov-is-evil
11466 If non-@code{nil}, this backend will ignore any @sc{nov} files.
11467
11468 @item nnml-nov-file-name
11469 @vindex nnml-nov-file-name
11470 The name of the @sc{nov} files.  The default is @file{.overview}.
11471
11472 @item nnml-prepare-save-mail-hook
11473 @vindex nnml-prepare-save-mail-hook
11474 Hook run narrowed to an article before saving.
11475
11476 @end table
11477
11478 @findex nnml-generate-nov-databases
11479 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
11480 you can do a complete update by typing @kbd{M-x
11481 nnml-generate-nov-databases}.  This command will trawl through the
11482 entire @code{nnml} hierarchy, looking at each and every article, so it
11483 might take a while to complete.  A better interface to this
11484 functionality can be found in the server buffer (@pxref{Server
11485 Commands}).
11486
11487
11488 @node MH Spool
11489 @subsubsection MH Spool
11490 @cindex nnmh
11491 @cindex mh-e mail spool
11492
11493 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
11494 @sc{nov} databases and it doesn't keep an active file.  This makes
11495 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
11496 makes it easier to write procmail scripts for.
11497
11498 Virtual server settings:
11499
11500 @table @code
11501 @item nnmh-directory
11502 @vindex nnmh-directory
11503 All @code{nnmh} directories will be located under this directory.
11504
11505 @item nnmh-get-new-mail
11506 @vindex nnmh-get-new-mail
11507 If non-@code{nil}, @code{nnmh} will read incoming mail.
11508
11509 @item nnmh-be-safe
11510 @vindex nnmh-be-safe
11511 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
11512 sure that the articles in the folder are actually what Gnus thinks they
11513 are.  It will check date stamps and stat everything in sight, so
11514 setting this to @code{t} will mean a serious slow-down.  If you never
11515 use anything but Gnus to read the @code{nnmh} articles, you do not have
11516 to set this variable to @code{t}.
11517 @end table
11518
11519
11520 @node Mail Folders
11521 @subsubsection Mail Folders
11522 @cindex nnfolder
11523 @cindex mbox folders
11524 @cindex mail folders
11525
11526 @code{nnfolder} is a backend for storing each mail group in a separate
11527 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
11528 will add extra headers to keep track of article numbers and arrival
11529 dates.
11530
11531 Virtual server settings:
11532
11533 @table @code
11534 @item nnfolder-directory
11535 @vindex nnfolder-directory
11536 All the @code{nnfolder} mail boxes will be stored under this directory.
11537
11538 @item nnfolder-active-file
11539 @vindex nnfolder-active-file
11540 The name of the active file.
11541
11542 @item nnfolder-newsgroups-file
11543 @vindex nnfolder-newsgroups-file
11544 The name of the group descriptions file.  @xref{Newsgroups File Format}.
11545
11546 @item nnfolder-get-new-mail
11547 @vindex nnfolder-get-new-mail
11548 If non-@code{nil}, @code{nnfolder} will read incoming mail.
11549
11550 @item nnfolder-save-buffer-hook
11551 @vindex nnfolder-save-buffer-hook
11552 @cindex backup files
11553 Hook run before saving the folders.  Note that Emacs does the normal
11554 backup renaming of files even with the @code{nnfolder} buffers.  If you
11555 wish to switch this off, you could say something like the following in
11556 your @file{.emacs} file:
11557
11558 @lisp
11559 (defun turn-off-backup ()
11560   (set (make-local-variable 'backup-inhibited) t))
11561
11562 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
11563 @end lisp
11564
11565 @item nnfolder-delete-mail-hook
11566 @vindex nnfolder-delete-mail-hook
11567 Hook run in a buffer narrowed to the message that is to be deleted.
11568 This function can be used to copy the message to somewhere else, or to
11569 extract some information from it before removing it.
11570
11571 @end table
11572
11573
11574 @findex nnfolder-generate-active-file
11575 @kindex M-x nnfolder-generate-active-file
11576 If you have lots of @code{nnfolder}-like files you'd like to read with
11577 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11578 command to make @code{nnfolder} aware of all likely files in
11579 @code{nnfolder-directory}.  This only works if you use long file names,
11580 though.
11581
11582 @node Comparing Mail Backends
11583 @subsubsection Comparing Mail Backends
11584
11585 First, just for terminology, the @dfn{backend} is the common word for a
11586 low-level access method---a transport, if you will, by which something
11587 is acquired.  The sense is that one's mail has to come from somewhere,
11588 and so selection of a suitable backend is required in order to get that
11589 mail within spitting distance of Gnus.
11590
11591 The same concept exists for Usenet itself: Though access to articles is
11592 typically done by NNTP these days, once upon a midnight dreary, everyone
11593 in the world got at Usenet by running a reader on the machine where the
11594 articles lay (the machine which today we call an NNTP server), and
11595 access was by the reader stepping into the articles' directory spool
11596 area directly.  One can still select between either the @code{nntp} or
11597 @code{nnspool} backends, to select between these methods, if one happens
11598 actually to live on the server (or can see its spool directly, anyway,
11599 via NFS).
11600
11601 The goal in selecting a mail backend is to pick one which
11602 simultaneously represents a suitable way of dealing with the original
11603 format plus leaving mail in a form that is convenient to use in the
11604 future.  Here are some high and low points on each:
11605
11606 @table @code
11607 @item nnmbox
11608
11609 UNIX systems have historically had a single, very common, and well-
11610 defined format.  All messages arrive in a single @dfn{spool file}, and
11611 they are delineated by a line whose regular expression matches
11612 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
11613 to make it clear in this instance that this is not the RFC-specified
11614 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
11615 historically from the Unix environment, it is simplest if one does not
11616 mess a great deal with the original mailbox format, so if one chooses
11617 this backend, Gnus' primary activity in getting mail from the real spool
11618 area to Gnus' preferred directory is simply to copy it, with no
11619 (appreciable) format change in the process.  It is the ``dumbest'' way
11620 to move mail into availability in the Gnus environment.  This makes it
11621 fast to move into place, but slow to parse, when Gnus has to look at
11622 what's where.
11623
11624 @item nnbabyl
11625
11626 Once upon a time, there was the DEC-10 and DEC-20, running operating
11627 systems called TOPS and related things, and the usual (only?) mail
11628 reading environment was a thing called Babyl.  I don't know what format
11629 was used for mail landing on the system, but Babyl had its own internal
11630 format to which mail was converted, primarily involving creating a
11631 spool-file-like entity with a scheme for inserting Babyl-specific
11632 headers and status bits above the top of each message in the file.
11633 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
11634 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
11635 to understand the mail files folks already had in existence.  Gnus (and
11636 VM, for that matter) continue to support this format because it's
11637 perceived as having some good qualities in those mailer-specific
11638 headers/status bits stuff.  RMAIL itself still exists as well, of
11639 course, and is still maintained by Stallman.
11640
11641 Both of the above forms leave your mail in a single file on your
11642 filesystem, and they must parse that entire file each time you take a
11643 look at your mail.
11644
11645 @item nnml
11646
11647 @code{nnml} is the backend which smells the most as though you were
11648 actually operating with an @code{nnspool}-accessed Usenet system.  (In
11649 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
11650 lo these years ago.)  One's mail is taken from the original spool file,
11651 and is then cut up into individual message files, 1:1.  It maintains a
11652 Usenet-style active file (analogous to what one finds in an INN- or
11653 CNews-based news system in (for instance) @file{/var/lib/news/active},
11654 or what is returned via the @samp{NNTP LIST} verb) and also creates
11655 @dfn{overview} files for efficient group entry, as has been defined for
11656 @sc{nntp} servers for some years now.  It is slower in mail-splitting,
11657 due to the creation of lots of files, updates to the @code{nnml} active
11658 file, and additions to overview files on a per-message basis, but it is
11659 extremely fast on access because of what amounts to the indexing support
11660 provided by the active file and overviews.
11661
11662 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
11663 resource which defines available places in the filesystem to put new
11664 files.  Sysadmins take a dim view of heavy inode occupation within
11665 tight, shared filesystems.  But if you live on a personal machine where
11666 the filesystem is your own and space is not at a premium, @code{nnml}
11667 wins big.
11668
11669 It is also problematic using this backend if you are living in a
11670 FAT16-based Windows world, since much space will be wasted on all these
11671 tiny files.
11672
11673 @item nnmh
11674
11675 The Rand MH mail-reading system has been around UNIX systems for a very
11676 long time; it operates by splitting one's spool file of messages into
11677 individual files, but with little or no indexing support -- @code{nnmh}
11678 is considered to be semantically equivalent to ``@code{nnml} without
11679 active file or overviews''.  This is arguably the worst choice, because
11680 one gets the slowness of individual file creation married to the
11681 slowness of access parsing when learning what's new in one's groups.
11682
11683 @item nnfolder
11684
11685 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
11686 method described above) on a per-group basis.  That is, @code{nnmbox}
11687 itself puts *all* one's mail in one file; @code{nnfolder} provides a
11688 little bit of optimization to this so that each of one's mail groups has
11689 a Unix mail box file.  It's faster than @code{nnmbox} because each group
11690 can be parsed separately, and still provides the simple Unix mail box
11691 format requiring minimal effort in moving the mail around.  In addition, 
11692 it maintains an ``active'' file making it much faster for Gnus to figure 
11693 out how many messages there are in each separate group.
11694
11695 If you have groups that are expected to have a massive amount of
11696 messages, @code{nnfolder} is not the best choice, but if you receive
11697 only a moderate amount of mail, @code{nnfolder} is probably the most
11698 friendly mail backend all over.
11699
11700 @end table
11701
11702
11703 @node Browsing the Web
11704 @section Browsing the Web
11705 @cindex web
11706 @cindex browsing the web
11707 @cindex www
11708 @cindex http
11709
11710 Web-based discussion forums are getting more and more popular.  On many
11711 subjects, the web-based forums have become the most important forums,
11712 eclipsing the importance of mailing lists and news groups.  The reason
11713 is easy to understand---they are friendly to new users; you just point
11714 and click, and there's the discussion.  With mailing lists, you have to
11715 go through a cumbersome subscription procedure, and most people don't
11716 even know what a news group is.
11717
11718 The problem with this scenario is that web browsers are not very good at 
11719 being newsreaders.  They do not keep track of what articles you've read; 
11720 they do not allow you to score on subjects you're interested in; they do 
11721 not allow off-line browsing; they require you to click around and drive
11722 you mad in the end.
11723
11724 So---if web browsers suck at reading discussion forums, why not use Gnus 
11725 to do it instead?
11726
11727 Gnus has been getting quite a collection of backends for providing
11728 interfaces to these sources.
11729
11730 @menu
11731 * Web Searches::          Creating groups from articles that match a string.
11732 * Slashdot::              Reading the Slashdot comments.
11733 * Ultimate::              The Ultimate Bulletin Board systems.
11734 * Web Archive::           Reading mailing list archived on web.
11735 @end menu
11736
11737 The main caveat with all these web sources is that they probably won't
11738 work for a very long time.  Gleaning information from the @sc{html} data 
11739 is guesswork at best, and when the layout is altered, the Gnus backend
11740 will fail.  If you have reasonably new versions of these backends,
11741 though, you should be ok.
11742
11743 One thing all these Web methods have in common is that the Web sources
11744 are often down, unavailable or just plain too slow to be fun.  In those
11745 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
11746 Unplugged}) handle downloading articles, and then you can read them at
11747 leisure from your local disk.  No more World Wide Wait for you.
11748
11749
11750 @node Web Searches
11751 @subsection Web Searches
11752 @cindex nnweb
11753 @cindex DejaNews
11754 @cindex Alta Vista
11755 @cindex InReference
11756 @cindex Usenet searches
11757 @cindex searching the Usenet
11758
11759 It's, like, too neat to search the Usenet for articles that match a
11760 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11761 those, like, Web browsers, and you, like, have to, rilly, like, look at
11762 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11763 searches without having to use a browser.
11764
11765 The @code{nnweb} backend allows an easy interface to the mighty search
11766 engine.  You create an @code{nnweb} group, enter a search pattern, and
11767 then enter the group and read the articles like you would any normal
11768 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
11769 Groups}) will do this in an easy-to-use fashion.
11770
11771 @code{nnweb} groups don't really lend themselves to being solid
11772 groups---they have a very fleeting idea of article numbers.  In fact,
11773 each time you enter an @code{nnweb} group (not even changing the search
11774 pattern), you are likely to get the articles ordered in a different
11775 manner.  Not even using duplicate suppression (@pxref{Duplicate
11776 Suppression}) will help, since @code{nnweb} doesn't even know the
11777 @code{Message-ID} of the articles before reading them using some search
11778 engines (DejaNews, for instance).  The only possible way to keep track
11779 of which articles you've read is by scoring on the @code{Date}
11780 header---mark all articles posted before the last date you read the
11781 group as read.
11782
11783 If the search engine changes its output substantially, @code{nnweb}
11784 won't be able to parse it and will fail.  One could hardly fault the Web
11785 providers if they were to do this---their @emph{raison d'\e-Aêtre} is to\e$)A
11786 make money off of advertisements, not to provide services to the
11787 community.  Since @code{nnweb} washes the ads off all the articles, one
11788 might think that the providers might be somewhat miffed.  We'll see.
11789
11790 You must have the @code{url} and @code{w3} package installed to be able
11791 to use @code{nnweb}.
11792
11793 Virtual server variables:
11794
11795 @table @code
11796 @item nnweb-type
11797 @vindex nnweb-type
11798 What search engine type is being used.  The currently supported types
11799 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11800 @code{reference}.
11801
11802 @item nnweb-search
11803 @vindex nnweb-search
11804 The search string to feed to the search engine.
11805
11806 @item nnweb-max-hits
11807 @vindex nnweb-max-hits
11808 Advisory maximum number of hits per search to display.  The default is
11809 100.
11810
11811 @item nnweb-type-definition
11812 @vindex nnweb-type-definition
11813 Type-to-definition alist.  This alist says what @code{nnweb} should do
11814 with the various search engine types.  The following elements must be
11815 present:
11816
11817 @table @code
11818 @item article
11819 Function to decode the article and provide something that Gnus
11820 understands.
11821
11822 @item map
11823 Function to create an article number to message header and URL alist.
11824
11825 @item search
11826 Function to send the search string to the search engine.
11827
11828 @item address
11829 The address the aforementioned function should send the search string
11830 to.
11831
11832 @item id
11833 Format string URL to fetch an article by @code{Message-ID}.
11834 @end table
11835
11836 @end table
11837
11838
11839 @node Slashdot
11840 @subsection Slashdot
11841 @cindex Slashdot
11842 @cindex nnslashdot
11843
11844 Slashdot (@file{http://slashdot.org/}) is a popular news site, with
11845 lively discussion following the news articles.  @code{nnslashdot} will
11846 let you read this forum in a convenient manner.
11847
11848 The easiest way to read this source is to put something like the
11849 following in your @file{.gnus.el} file:
11850
11851 @lisp
11852 (setq gnus-secondary-select-methods
11853       '((nnslashdot "")))
11854 @end lisp
11855
11856 This will make Gnus query the @code{nnslashdot} backend for new comments
11857 and groups.  The @kbd{F} command will subscribe each new news article as
11858 a new Gnus group, and you can read the comments by entering these
11859 groups.  (Note that the default subscription method is to subscribe new
11860 groups as zombies.  Other methods are available (@pxref{Subscription
11861 Methods}).
11862
11863 When following up to @code{nnslashdot} comments (or posting new
11864 comments), some light @sc{html}izations will be performed.  In
11865 particular, text quoted with @samp{> } will be quoted with
11866 @code{blockquote} instead, and signatures will have @code{br} added to
11867 the end of each line.  Other than that, you can just write @sc{html}
11868 directly into the message buffer.  Note that Slashdot filters out some
11869 @sc{html} forms.
11870
11871 The following variables can be altered to change its behavior:
11872
11873 @table @code
11874 @item nnslashdot-threaded
11875 Whether @code{nnslashdot} should display threaded groups or not.  The
11876 default is @code{t}.  To be able to display threads, @code{nnslashdot}
11877 has to retrieve absolutely all comments in a group upon entry.  If a
11878 threaded display is not required, @code{nnslashdot} will only retrieve
11879 the comments that are actually wanted by the user.  Threading is nicer,
11880 but much, much slower than untreaded.
11881
11882 @item nnslashdot-login-name
11883 @vindex nnslashdot-login-name
11884 The login name to use when posting.
11885
11886 @item nnslashdot-password
11887 @vindex nnslashdot-password
11888 The password to use when posting.
11889
11890 @item nnslashdot-directory
11891 @vindex nnslashdot-directory
11892 Where @code{nnslashdot} will store its files.  The default value is
11893 @samp{~/News/slashdot/}.
11894
11895 @item nnslashdot-active-url
11896 @vindex nnslashdot-active-url
11897 The @sc{url} format string that will be used to fetch the information on 
11898 news articles and comments.  The default is
11899 @samp{http://slashdot.org/search.pl?section=&min=%d}.
11900
11901 @item nnslashdot-comments-url
11902 @vindex nnslashdot-comments-url
11903 The @sc{url} format string that will be used to fetch comments.  The
11904 default is
11905 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
11906
11907 @item nnslashdot-article-url
11908 @vindex nnslashdot-article-url
11909 The @sc{url} format string that will be used to fetch the news article.  The
11910 default is
11911 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
11912
11913 @item nnslashdot-threshold
11914 @vindex nnslashdot-threshold
11915 The score threshold.  The default is -1.
11916
11917 @item nnslashdot-group-number
11918 @vindex nnslashdot-group-number
11919 The number of old groups, in addition to the ten latest, to keep
11920 updated.  The default is 0.
11921
11922 @end table
11923
11924
11925
11926 @node Ultimate
11927 @subsection Ultimate
11928 @cindex nnultimate
11929 @cindex Ultimate Bulletin Board
11930
11931 The Ultimate Bulletin Board (@file{http://www.ultimatebb.com/}) is
11932 probably the most popular Web bulletin board system used.  It has a
11933 quite regular and nice interface, and it's possible to get the
11934 information Gnus needs to keep groups updated.
11935
11936 The easiest way to get started with @code{nnultimate} is to say
11937 something like the following in the group buffer:  @kbd{B nnultimate RET 
11938 http://www.tcj.com/messboard/ubbcgi/ RET}.  (Substitute the @sc{url}
11939 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
11940 you're interested in; there's quite a list of them on the Ultimate web
11941 site.)  Then subscribe to the groups you're interested in from the
11942 server buffer, and read them from the group buffer.
11943
11944 The following @code{nnultimate} variables can be altered:
11945
11946 @table @code
11947 @item nnultimate-directory
11948 @vindex nnultimate-directory
11949 The directory where @code{nnultimate} stores its files.  The default is
11950 @samp{~/News/ultimate/}.
11951 @end table
11952
11953 @node Web Archive
11954 @subsection Web Archive
11955 @cindex nnwarchive
11956 @cindex Web Archive
11957
11958 Some mailing lists only have archives on Web servers, such as
11959 (@file{http://www.egroups.com/}). It has a quite regular and nice
11960 interface, and it's possible to get the information Gnus needs to keep
11961 groups updated.
11962
11963 The easiest way to get started with @code{nnwarchive} is to say
11964 something like the following in the group buffer: @kbd{M-x
11965 gnus-group-make-nnwarchive-group RET an_egroup RET egroups RET
11966 www.egroups.com RET your@@email.address RET}.  (Substitute the
11967 @sc{an_egroup} with the mailing list you subscribed, the
11968 @sc{your@@email.address} with your email address.)
11969
11970 The following @code{nnwarchive} variables can be altered:
11971
11972 @table @code
11973 @item nnwarchive-directory
11974 @vindex nnwarchive-directory
11975 The directory where @code{nnwarchive} stores its files.  The default is
11976 @samp{~/News/warchive/}.
11977
11978 @item nnwarchive-login
11979 @vindex nnwarchive-login
11980 The account name on the web server.
11981
11982 @item nnwarchive-passwd
11983 @vindex nnwarchive-passwd
11984 The password for your account on the web server.
11985 @end table
11986
11987 @node Other Sources
11988 @section Other Sources
11989
11990 Gnus can do more than just read news or mail.  The methods described
11991 below allow Gnus to view directories and files as if they were
11992 newsgroups.
11993
11994 @menu
11995 * Directory Groups::      You can read a directory as if it was a newsgroup.
11996 * Anything Groups::       Dired?  Who needs dired?
11997 * Document Groups::       Single files can be the basis of a group.
11998 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
11999 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
12000 * IMAP::                  Using Gnus as a IMAP client.
12001 @end menu
12002
12003
12004 @node Directory Groups
12005 @subsection Directory Groups
12006 @cindex nndir
12007 @cindex directory groups
12008
12009 If you have a directory that has lots of articles in separate files in
12010 it, you might treat it as a newsgroup.  The files have to have numerical
12011 names, of course.
12012
12013 This might be an opportune moment to mention @code{ange-ftp} (and its
12014 successor @code{efs}), that most wonderful of all wonderful Emacs
12015 packages.  When I wrote @code{nndir}, I didn't think much about it---a
12016 backend to read directories.  Big deal.
12017
12018 @code{ange-ftp} changes that picture dramatically.  For instance, if you
12019 enter the @code{ange-ftp} file name
12020 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
12021 @code{ange-ftp} or @code{efs} will actually allow you to read this
12022 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
12023
12024 @code{nndir} will use @sc{nov} files if they are present.
12025
12026 @code{nndir} is a ``read-only'' backend---you can't delete or expire
12027 articles with this method.  You can use @code{nnmh} or @code{nnml} for
12028 whatever you use @code{nndir} for, so you could switch to any of those
12029 methods if you feel the need to have a non-read-only @code{nndir}.
12030
12031
12032 @node Anything Groups
12033 @subsection Anything Groups
12034 @cindex nneething
12035
12036 From the @code{nndir} backend (which reads a single spool-like
12037 directory), it's just a hop and a skip to @code{nneething}, which
12038 pretends that any arbitrary directory is a newsgroup.  Strange, but
12039 true.
12040
12041 When @code{nneething} is presented with a directory, it will scan this
12042 directory and assign article numbers to each file.  When you enter such
12043 a group, @code{nneething} must create ``headers'' that Gnus can use.
12044 After all, Gnus is a newsreader, in case you're
12045 forgetting. @code{nneething} does this in a two-step process.  First, it
12046 snoops each file in question.  If the file looks like an article (i.e.,
12047 the first few lines look like headers), it will use this as the head.
12048 If this is just some arbitrary file without a head (e.g. a C source
12049 file), @code{nneething} will cobble up a header out of thin air.  It
12050 will use file ownership, name and date and do whatever it can with these
12051 elements.
12052
12053 All this should happen automatically for you, and you will be presented
12054 with something that looks very much like a newsgroup.  Totally like a
12055 newsgroup, to be precise.  If you select an article, it will be displayed
12056 in the article buffer, just as usual.
12057
12058 If you select a line that represents a directory, Gnus will pop you into
12059 a new summary buffer for this @code{nneething} group.  And so on.  You can
12060 traverse the entire disk this way, if you feel like, but remember that
12061 Gnus is not dired, really, and does not intend to be, either.
12062
12063 There are two overall modes to this action---ephemeral or solid.  When
12064 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
12065 will not store information on what files you have read, and what files
12066 are new, and so on.  If you create a solid @code{nneething} group the
12067 normal way with @kbd{G m}, Gnus will store a mapping table between
12068 article numbers and file names, and you can treat this group like any
12069 other groups.  When you activate a solid @code{nneething} group, you will
12070 be told how many unread articles it contains, etc., etc.
12071
12072 Some variables:
12073
12074 @table @code
12075 @item nneething-map-file-directory
12076 @vindex nneething-map-file-directory
12077 All the mapping files for solid @code{nneething} groups will be stored
12078 in this directory, which defaults to @file{~/.nneething/}.
12079
12080 @item nneething-exclude-files
12081 @vindex nneething-exclude-files
12082 All files that match this regexp will be ignored.  Nice to use to exclude
12083 auto-save files and the like, which is what it does by default.
12084
12085 @item nneething-include-files
12086 @vindex nneething-include-files
12087 Regexp saying what files to include in the group.  If this variable is
12088 non-@code{nil}, only files matching this regexp will be included.
12089
12090 @item nneething-map-file
12091 @vindex nneething-map-file
12092 Name of the map files.
12093 @end table
12094
12095
12096 @node Document Groups
12097 @subsection Document Groups
12098 @cindex nndoc
12099 @cindex documentation group
12100 @cindex help group
12101
12102 @code{nndoc} is a cute little thing that will let you read a single file
12103 as a newsgroup.  Several files types are supported:
12104
12105 @table @code
12106 @cindex babyl
12107 @cindex rmail mbox
12108
12109 @item babyl
12110 The babyl (rmail) mail box.
12111 @cindex mbox
12112 @cindex Unix mbox
12113
12114 @item mbox
12115 The standard Unix mbox file.
12116
12117 @cindex MMDF mail box
12118 @item mmdf
12119 The MMDF mail box format.
12120
12121 @item news
12122 Several news articles appended into a file.
12123
12124 @item rnews
12125 @cindex rnews batch files
12126 The rnews batch transport format.
12127 @cindex forwarded messages
12128
12129 @item forward
12130 Forwarded articles.
12131
12132 @item nsmail
12133 Netscape mail boxes.
12134
12135 @item mime-parts
12136 MIME multipart messages.
12137
12138 @item standard-digest
12139 The standard (RFC 1153) digest format.
12140
12141 @item slack-digest
12142 Non-standard digest format---matches most things, but does it badly.
12143 @end table
12144
12145 You can also use the special ``file type'' @code{guess}, which means
12146 that @code{nndoc} will try to guess what file type it is looking at.
12147 @code{digest} means that @code{nndoc} should guess what digest type the
12148 file is.
12149
12150 @code{nndoc} will not try to change the file or insert any extra headers into
12151 it---it will simply, like, let you use the file as the basis for a
12152 group.  And that's it.
12153
12154 If you have some old archived articles that you want to insert into your
12155 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
12156 that.  Say you have an old @file{RMAIL} file with mail that you now want
12157 to split into your new @code{nnml} groups.  You look at that file using
12158 @code{nndoc} (using the @kbd{G f} command in the group buffer
12159 (@pxref{Foreign Groups})), set the process mark on all the articles in
12160 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
12161 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
12162 file is now also stored in lots of @code{nnml} directories, and you can
12163 delete that pesky @file{RMAIL} file.  If you have the guts!
12164
12165 Virtual server variables:
12166
12167 @table @code
12168 @item nndoc-article-type
12169 @vindex nndoc-article-type
12170 This should be one of @code{mbox}, @code{babyl}, @code{digest},
12171 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
12172 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
12173 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
12174
12175 @item nndoc-post-type
12176 @vindex nndoc-post-type
12177 This variable says whether Gnus is to consider the group a news group or
12178 a mail group.  There are two valid values:  @code{mail} (the default)
12179 and @code{news}.
12180 @end table
12181
12182 @menu
12183 * Document Server Internals::   How to add your own document types.
12184 @end menu
12185
12186
12187 @node Document Server Internals
12188 @subsubsection Document Server Internals
12189
12190 Adding new document types to be recognized by @code{nndoc} isn't
12191 difficult.  You just have to whip up a definition of what the document
12192 looks like, write a predicate function to recognize that document type,
12193 and then hook into @code{nndoc}.
12194
12195 First, here's an example document type definition:
12196
12197 @example
12198 (mmdf
12199  (article-begin .  "^\^A\^A\^A\^A\n")
12200  (body-end .  "^\^A\^A\^A\^A\n"))
12201 @end example
12202
12203 The definition is simply a unique @dfn{name} followed by a series of
12204 regexp pseudo-variable settings.  Below are the possible
12205 variables---don't be daunted by the number of variables; most document
12206 types can be defined with very few settings:
12207
12208 @table @code
12209 @item first-article
12210 If present, @code{nndoc} will skip past all text until it finds
12211 something that match this regexp.  All text before this will be
12212 totally ignored.
12213
12214 @item article-begin
12215 This setting has to be present in all document type definitions.  It
12216 says what the beginning of each article looks like.
12217
12218 @item head-begin-function
12219 If present, this should be a function that moves point to the head of
12220 the article.
12221
12222 @item nndoc-head-begin
12223 If present, this should be a regexp that matches the head of the
12224 article.
12225
12226 @item nndoc-head-end
12227 This should match the end of the head of the article.  It defaults to
12228 @samp{^$}---the empty line.
12229
12230 @item body-begin-function
12231 If present, this function should move point to the beginning of the body
12232 of the article.
12233
12234 @item body-begin
12235 This should match the beginning of the body of the article.  It defaults
12236 to @samp{^\n}.
12237
12238 @item body-end-function
12239 If present, this function should move point to the end of the body of
12240 the article.
12241
12242 @item body-end
12243 If present, this should match the end of the body of the article.
12244
12245 @item file-end
12246 If present, this should match the end of the file.  All text after this
12247 regexp will be totally ignored.
12248
12249 @end table
12250
12251 So, using these variables @code{nndoc} is able to dissect a document
12252 file into a series of articles, each with a head and a body.  However, a
12253 few more variables are needed since not all document types are all that
12254 news-like---variables needed to transform the head or the body into
12255 something that's palatable for Gnus:
12256
12257 @table @code
12258 @item prepare-body-function
12259 If present, this function will be called when requesting an article.  It
12260 will be called with point at the start of the body, and is useful if the
12261 document has encoded some parts of its contents.
12262
12263 @item article-transform-function
12264 If present, this function is called when requesting an article.  It's
12265 meant to be used for more wide-ranging transformation of both head and
12266 body of the article.
12267
12268 @item generate-head-function
12269 If present, this function is called to generate a head that Gnus can
12270 understand.  It is called with the article number as a parameter, and is
12271 expected to generate a nice head for the article in question.  It is
12272 called when requesting the headers of all articles.
12273
12274 @end table
12275
12276 Let's look at the most complicated example I can come up with---standard
12277 digests:
12278
12279 @example
12280 (standard-digest
12281  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
12282  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
12283  (prepare-body-function . nndoc-unquote-dashes)
12284  (body-end-function . nndoc-digest-body-end)
12285  (head-end . "^ ?$")
12286  (body-begin . "^ ?\n")
12287  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
12288  (subtype digest guess))
12289 @end example
12290
12291 We see that all text before a 70-width line of dashes is ignored; all
12292 text after a line that starts with that @samp{^End of} is also ignored;
12293 each article begins with a 30-width line of dashes; the line separating
12294 the head from the body may contain a single space; and that the body is
12295 run through @code{nndoc-unquote-dashes} before being delivered.
12296
12297 To hook your own document definition into @code{nndoc}, use the
12298 @code{nndoc-add-type} function.  It takes two parameters---the first is
12299 the definition itself and the second (optional) parameter says where in
12300 the document type definition alist to put this definition.  The alist is
12301 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
12302 is of @code{mmdf} type, and so on.  These type predicates should return
12303 @code{nil} if the document is not of the correct type; @code{t} if it is
12304 of the correct type; and a number if the document might be of the
12305 correct type.  A high number means high probability; a low number means
12306 low probability with @samp{0} being the lowest valid number.
12307
12308
12309 @node SOUP
12310 @subsection SOUP
12311 @cindex SOUP
12312 @cindex offline
12313
12314 In the PC world people often talk about ``offline'' newsreaders.  These
12315 are thingies that are combined reader/news transport monstrosities.
12316 With built-in modem programs.  Yecchh!
12317
12318 Of course, us Unix Weenie types of human beans use things like
12319 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
12320 transport things like Ghod intended.  And then we just use normal
12321 newsreaders.
12322
12323 However, it can sometimes be convenient to do something that's a bit
12324 easier on the brain if you have a very slow modem, and you're not really
12325 that interested in doing things properly.
12326
12327 A file format called @sc{soup} has been developed for transporting news
12328 and mail from servers to home machines and back again.  It can be a bit
12329 fiddly.
12330
12331 First some terminology:
12332
12333 @table @dfn
12334
12335 @item server
12336 This is the machine that is connected to the outside world and where you
12337 get news and/or mail from.
12338
12339 @item home machine
12340 This is the machine that you want to do the actual reading and responding
12341 on.  It is typically not connected to the rest of the world in any way.
12342
12343 @item packet
12344 Something that contains messages and/or commands.  There are two kinds
12345 of packets:
12346
12347 @table @dfn
12348 @item message packets
12349 These are packets made at the server, and typically contain lots of
12350 messages for you to read.  These are called @file{SoupoutX.tgz} by
12351 default, where @var{x} is a number.
12352
12353 @item response packets
12354 These are packets made at the home machine, and typically contains
12355 replies that you've written.  These are called @file{SoupinX.tgz} by
12356 default, where @var{x} is a number.
12357
12358 @end table
12359
12360 @end table
12361
12362
12363 @enumerate
12364
12365 @item
12366 You log in on the server and create a @sc{soup} packet.  You can either
12367 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
12368 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
12369 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
12370
12371 @item
12372 You transfer the packet home.  Rail, boat, car or modem will do fine.
12373
12374 @item
12375 You put the packet in your home directory.
12376
12377 @item
12378 You fire up Gnus on your home machine using the @code{nnsoup} backend as
12379 the native or secondary server.
12380
12381 @item
12382 You read articles and mail and answer and followup to the things you
12383 want (@pxref{SOUP Replies}).
12384
12385 @item
12386 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
12387 packet.
12388
12389 @item
12390 You transfer this packet to the server.
12391
12392 @item
12393 You use Gnus to mail this packet out with the @kbd{G s s} command.
12394
12395 @item
12396 You then repeat until you die.
12397
12398 @end enumerate
12399
12400 So you basically have a bipartite system---you use @code{nnsoup} for
12401 reading and Gnus for packing/sending these @sc{soup} packets.
12402
12403 @menu
12404 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
12405 * SOUP Groups::       A backend for reading @sc{soup} packets.
12406 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
12407 @end menu
12408
12409
12410 @node SOUP Commands
12411 @subsubsection SOUP Commands
12412
12413 These are commands for creating and manipulating @sc{soup} packets.
12414
12415 @table @kbd
12416 @item G s b
12417 @kindex G s b (Group)
12418 @findex gnus-group-brew-soup
12419 Pack all unread articles in the current group
12420 (@code{gnus-group-brew-soup}).  This command understands the
12421 process/prefix convention.
12422
12423 @item G s w
12424 @kindex G s w (Group)
12425 @findex gnus-soup-save-areas
12426 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
12427
12428 @item G s s
12429 @kindex G s s (Group)
12430 @findex gnus-soup-send-replies
12431 Send all replies from the replies packet
12432 (@code{gnus-soup-send-replies}).
12433
12434 @item G s p
12435 @kindex G s p (Group)
12436 @findex gnus-soup-pack-packet
12437 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
12438
12439 @item G s r
12440 @kindex G s r (Group)
12441 @findex nnsoup-pack-replies
12442 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
12443
12444 @item O s
12445 @kindex O s (Summary)
12446 @findex gnus-soup-add-article
12447 This summary-mode command adds the current article to a @sc{soup} packet
12448 (@code{gnus-soup-add-article}).  It understands the process/prefix
12449 convention (@pxref{Process/Prefix}).
12450
12451 @end table
12452
12453
12454 There are a few variables to customize where Gnus will put all these
12455 thingies:
12456
12457 @table @code
12458
12459 @item gnus-soup-directory
12460 @vindex gnus-soup-directory
12461 Directory where Gnus will save intermediate files while composing
12462 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
12463
12464 @item gnus-soup-replies-directory
12465 @vindex gnus-soup-replies-directory
12466 This is what Gnus will use as a temporary directory while sending our
12467 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
12468
12469 @item gnus-soup-prefix-file
12470 @vindex gnus-soup-prefix-file
12471 Name of the file where Gnus stores the last used prefix.  The default is
12472 @samp{gnus-prefix}.
12473
12474 @item gnus-soup-packer
12475 @vindex gnus-soup-packer
12476 A format string command for packing a @sc{soup} packet.  The default is
12477 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
12478
12479 @item gnus-soup-unpacker
12480 @vindex gnus-soup-unpacker
12481 Format string command for unpacking a @sc{soup} packet.  The default is
12482 @samp{gunzip -c %s | tar xvf -}.
12483
12484 @item gnus-soup-packet-directory
12485 @vindex gnus-soup-packet-directory
12486 Where Gnus will look for reply packets.  The default is @file{~/}.
12487
12488 @item gnus-soup-packet-regexp
12489 @vindex gnus-soup-packet-regexp
12490 Regular expression matching @sc{soup} reply packets in
12491 @code{gnus-soup-packet-directory}.
12492
12493 @end table
12494
12495
12496 @node SOUP Groups
12497 @subsubsection @sc{soup} Groups
12498 @cindex nnsoup
12499
12500 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
12501 read incoming packets, unpack them, and put them in a directory where
12502 you can read them at leisure.
12503
12504 These are the variables you can use to customize its behavior:
12505
12506 @table @code
12507
12508 @item nnsoup-tmp-directory
12509 @vindex nnsoup-tmp-directory
12510 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
12511 directory.  (@file{/tmp/} by default.)
12512
12513 @item nnsoup-directory
12514 @vindex nnsoup-directory
12515 @code{nnsoup} then moves each message and index file to this directory.
12516 The default is @file{~/SOUP/}.
12517
12518 @item nnsoup-replies-directory
12519 @vindex nnsoup-replies-directory
12520 All replies will be stored in this directory before being packed into a
12521 reply packet.  The default is @file{~/SOUP/replies/"}.
12522
12523 @item nnsoup-replies-format-type
12524 @vindex nnsoup-replies-format-type
12525 The @sc{soup} format of the replies packets.  The default is @samp{?n}
12526 (rnews), and I don't think you should touch that variable.  I probably
12527 shouldn't even have documented it.  Drats!  Too late!
12528
12529 @item nnsoup-replies-index-type
12530 @vindex nnsoup-replies-index-type
12531 The index type of the replies packet.  The default is @samp{?n}, which
12532 means ``none''.  Don't fiddle with this one either!
12533
12534 @item nnsoup-active-file
12535 @vindex nnsoup-active-file
12536 Where @code{nnsoup} stores lots of information.  This is not an ``active
12537 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
12538 this file or mess it up in any way, you're dead.  The default is
12539 @file{~/SOUP/active}.
12540
12541 @item nnsoup-packer
12542 @vindex nnsoup-packer
12543 Format string command for packing a reply @sc{soup} packet.  The default
12544 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
12545
12546 @item nnsoup-unpacker
12547 @vindex nnsoup-unpacker
12548 Format string command for unpacking incoming @sc{soup} packets.  The
12549 default is @samp{gunzip -c %s | tar xvf -}.
12550
12551 @item nnsoup-packet-directory
12552 @vindex nnsoup-packet-directory
12553 Where @code{nnsoup} will look for incoming packets.  The default is
12554 @file{~/}.
12555
12556 @item nnsoup-packet-regexp
12557 @vindex nnsoup-packet-regexp
12558 Regular expression matching incoming @sc{soup} packets.  The default is
12559 @samp{Soupout}.
12560
12561 @item nnsoup-always-save
12562 @vindex nnsoup-always-save
12563 If non-@code{nil}, save the replies buffer after each posted message.
12564
12565 @end table
12566
12567
12568 @node SOUP Replies
12569 @subsubsection SOUP Replies
12570
12571 Just using @code{nnsoup} won't mean that your postings and mailings end
12572 up in @sc{soup} reply packets automagically.  You have to work a bit
12573 more for that to happen.
12574
12575 @findex nnsoup-set-variables
12576 The @code{nnsoup-set-variables} command will set the appropriate
12577 variables to ensure that all your followups and replies end up in the
12578 @sc{soup} system.
12579
12580 In specific, this is what it does:
12581
12582 @lisp
12583 (setq message-send-news-function 'nnsoup-request-post)
12584 (setq message-send-mail-function 'nnsoup-request-mail)
12585 @end lisp
12586
12587 And that's it, really.  If you only want news to go into the @sc{soup}
12588 system you just use the first line.  If you only want mail to be
12589 @sc{soup}ed you use the second.
12590
12591
12592 @node Mail-To-News Gateways
12593 @subsection Mail-To-News Gateways
12594 @cindex mail-to-news gateways
12595 @cindex gateways
12596
12597 If your local @code{nntp} server doesn't allow posting, for some reason
12598 or other, you can post using one of the numerous mail-to-news gateways.
12599 The @code{nngateway} backend provides the interface.
12600
12601 Note that you can't read anything from this backend---it can only be
12602 used to post with.
12603
12604 Server variables:
12605
12606 @table @code
12607 @item nngateway-address
12608 @vindex nngateway-address
12609 This is the address of the mail-to-news gateway.
12610
12611 @item nngateway-header-transformation
12612 @vindex nngateway-header-transformation
12613 News headers often have to be transformed in some odd way or other
12614 for the mail-to-news gateway to accept it.  This variable says what
12615 transformation should be called, and defaults to
12616 @code{nngateway-simple-header-transformation}.  The function is called
12617 narrowed to the headers to be transformed and with one parameter---the
12618 gateway address.
12619
12620 This default function just inserts a new @code{To} header based on the
12621 @code{Newsgroups} header and the gateway address.
12622 For instance, an article with this @code{Newsgroups} header:
12623
12624 @example
12625 Newsgroups: alt.religion.emacs
12626 @end example
12627
12628 will get this @code{From} header inserted:
12629
12630 @example
12631 To: alt-religion-emacs@@GATEWAY
12632 @end example
12633
12634 The following pre-defined functions exist:
12635
12636 @findex nngateway-simple-header-transformation
12637 @table @code
12638
12639 @item nngateway-simple-header-transformation
12640 Creates a @code{To} header that looks like
12641 @var{newsgroup}@@@code{nngateway-address}.
12642
12643 @findex nngateway-mail2news-header-transformation
12644
12645 @item nngateway-mail2news-header-transformation
12646 Creates a @code{To} header that looks like
12647 @code{nngateway-address}.
12648
12649 Here's an example:
12650
12651 @lisp
12652 (setq gnus-post-method
12653       '(nngateway "mail2news@@replay.com"
12654                   (nngateway-header-transformation
12655                    nngateway-mail2news-header-transformation)))
12656 @end lisp
12657
12658 @end table
12659
12660
12661 @end table
12662
12663 So, to use this, simply say something like:
12664
12665 @lisp
12666 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
12667 @end lisp
12668
12669
12670
12671 @node IMAP
12672 @subsection IMAP
12673 @cindex nnimap
12674 @cindex IMAP
12675
12676 IMAP is a network protocol for reading mail (or news, or ...), think of
12677 it as a modernized NNTP. Connecting to a IMAP server is much similar to
12678 connecting to a news server, you just specify the network address of the
12679 server.
12680
12681 The following variables can be used to create a virtual @code{nnimap}
12682 server:
12683
12684 @table @code
12685
12686 @item nnimap-address
12687 @vindex nnimap-address
12688
12689 The address of the remote IMAP server. Defaults to the virtual server
12690 name if not specified.
12691
12692 @item nnimap-server-port
12693 @vindex nnimap-server-port
12694 Port on server to contact. Defaults to port 143, or 993 for SSL.
12695
12696 @item nnimap-list-pattern
12697 @vindex nnimap-list-pattern
12698 String or list of strings of mailboxes to limit available groups
12699 to. This is used when the server has very many mailboxes and you're only
12700 interested in a few -- some servers export your home directory via IMAP,
12701 you'll probably want to limit the mailboxes to those in @file{~/Mail/*}
12702 then.
12703
12704 The string can also be a cons of REFERENCE and the string as above, what
12705 REFERENCE is used for is server specific, but on the University of
12706 Washington server it's a directory that will be concatenated with the
12707 mailbox.
12708
12709 Example:
12710
12711 @lisp
12712 ("INBOX" "Mail/*" "alt.sex.*" ("~friend/Mail/" . "list/*"))
12713 @end lisp
12714
12715 @item nnimap-stream
12716 @vindex nnimap-stream
12717 The type of stream used to connect to your server. By default, nnimap
12718 will use the most secure stream your server is capable of.
12719
12720 @itemize @bullet
12721 @item
12722 @dfn{kerberos4:} Uses the `imtest' program.
12723 @item
12724 @dfn{ssl:} Uses OpenSSL or SSLeay.
12725 @item
12726 @dfn{network:} Plain, TCP/IP network connection.
12727 @end itemize
12728
12729 @item nnimap-authenticator
12730 @vindex nnimap-authenticator
12731
12732 The authenticator used to connect to the server. By default, nnimap will
12733 use the most secure authenticator your server is capable of.
12734
12735 @itemize @bullet
12736 @item
12737 @dfn{kerberos4:} Kerberos authentication.
12738 @item
12739 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
12740 @item
12741 @dfn{login:} Plain-text username/password via LOGIN.
12742 @item
12743 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
12744 @end itemize
12745
12746 @item nnimap-expunge-on-close
12747 @cindex Expunging
12748 @vindex nnimap-expunge-on-close
12749 Unlike Parmenides the IMAP designers has decided that things that
12750 doesn't exist actually does exist. More specifically, IMAP has this
12751 concept of marking articles @code{Deleted} which doesn't actually delete
12752 them, and this (marking them @code{Deleted}, that is) is what nnimap
12753 does when you delete a article in Gnus (with @kbd{G DEL} or similair).
12754
12755 Since the articles aren't really removed when we mark them with the
12756 @code{Deleted} flag we'll need a way to actually delete them. Feel like
12757 running in circles yet?
12758
12759 Traditionally, nnimap has removed all articles marked as @code{Deleted}
12760 when closing a mailbox but this is now configurable by this server
12761 variable.
12762
12763 The possible options are:
12764
12765 @table @code
12766
12767 @item always
12768 The default behaviour, delete all articles marked as "Deleted" when
12769 closing a mailbox.
12770 @item never
12771 Never actually delete articles. Currently there is no way of showing the
12772 articles marked for deletion in nnimap, but other IMAP clients may allow
12773 you to do this. If you ever want to run the EXPUNGE command manually,
12774 @xref{Expunging mailboxes}.
12775 @item ask
12776 When closing mailboxes, nnimap will ask if you wish to expunge deleted
12777 articles or not.
12778 @end table
12779
12780 @end table
12781
12782 @menu
12783 * Splitting in IMAP::     Splitting mail with nnimap.
12784 * Editing IMAP ACLs::     Limiting/enabling other users access to a mailbox.
12785 * Expunging mailboxes::   Equivalent of a "compress mailbox" button.
12786 @end menu
12787
12788
12789
12790 @node Splitting in IMAP
12791 @subsubsection Splitting in IMAP
12792 @cindex splitting imap mail
12793
12794 Splitting is something Gnus users has loved and used for years, and now
12795 the rest of the world is catching up. Yeah, dream on, not many IMAP
12796 server has server side splitting and those that have splitting seem to
12797 use some non-standard protocol. This means that IMAP support for Gnus
12798 has to do it's own splitting.
12799
12800 And it does.
12801
12802 There are three variables of interest:
12803
12804 @table @code
12805
12806 @item nnimap-split-crosspost
12807 @cindex splitting, crosspost
12808 @cindex crosspost
12809 @vindex nnimap-split-crosspost
12810
12811 If non-nil, do crossposting if several split methods match the mail. If
12812 nil, the first match in @code{nnimap-split-rule} found will be used.
12813
12814 Nnmail equivalent: @code{nnmail-crosspost}.
12815
12816 @item nnimap-split-inbox
12817 @cindex splitting, inbox
12818 @cindex inbox
12819 @vindex nnimap-split-inbox
12820
12821 A string or a list of strings that gives the name(s) of IMAP mailboxes
12822 to split from. Defaults to nil, which means that splitting is disabled!
12823
12824 @lisp
12825 (setq nnimap-split-inbox '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
12826 @end lisp
12827
12828 No nnmail equivalent.
12829
12830 @item nnimap-split-rule
12831 @cindex Splitting, rules
12832 @vindex nnimap-split-rule
12833
12834 New mail found in @code{nnimap-split-inbox} will be split according to
12835 this variable.
12836
12837 This variable contains a list of lists, where the first element in the
12838 sublist gives the name of the IMAP mailbox to move articles matching the
12839 regexp in the second element in the sublist. Got that? Neither did I, we
12840 need examples.
12841
12842 @lisp
12843 (setq nnimap-split-rule
12844         '(("INBOX.nnimap"        "^Sender: owner-nnimap@@vic20.globalcom.se")
12845           ("INBOX.junk"          "^Subject:.*MAKE MONEY")
12846           ("INBOX.private"       "")))
12847 @end lisp
12848
12849 This will put all articles from the nnimap mailing list into mailbox
12850 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
12851 into INBOX.spam and everything else in INBOX.private.
12852
12853 The first string may contain `\\1' forms, like the ones used by
12854 replace-match to insert sub-expressions from the matched text. For
12855 instance:
12856
12857 @lisp
12858 ("INBOX.lists.\\1"     "^Sender: owner-\\([a-z-]+\\)@@")
12859 @end lisp
12860
12861 The second element can also be a function. In that case, it will be
12862 called with the first element of the rule as the argument, in a buffer
12863 containing the headers of the article. It should return a non-nil value
12864 if it thinks that the mail belongs in that group.
12865
12866 Nnmail users might recollect that the last regexp had to be empty to
12867 match all articles (like in the example above). This is not required in
12868 nnimap. Articles not matching any of the regexps will not be moved out
12869 of your inbox. (This might might affect performance if you keep lots of
12870 unread articles in your inbox, since the splitting code would go over
12871 them every time you fetch new mail.)
12872
12873 These rules are processed from the beginning of the alist toward the
12874 end. The first rule to make a match will "win", unless you have
12875 crossposting enabled. In that case, all matching rules will "win".
12876
12877 The splitting code tries to create mailboxes if it need too.
12878
12879 Nnmail equivalent: @code{nnmail-split-methods}.
12880
12881 @end table
12882
12883 @node Editing IMAP ACLs
12884 @subsubsection Editing IMAP ACLs
12885 @cindex editing imap acls
12886 @cindex Access Control Lists
12887 @cindex Editing IMAP ACLs
12888 @kindex G l
12889 @findex gnus-group-nnimap-edit-acl
12890
12891 ACL stands for Access Control List.  ACLs are used in IMAP for limiting
12892 (or enabling) other users access to your mail boxes. Not all IMAP
12893 servers support this, this function will give an error if it doesn't.
12894
12895 To edit a ACL for a mailbox, type @kbd{G l}
12896 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
12897 editing window with detailed instructions.
12898
12899 Some possible uses:
12900
12901 @itemize @bullet
12902 @item
12903 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
12904 on your mailing list mailboxes enables other users on the same server to
12905 follow the list without subscribing to it.
12906 @item
12907 At least with the Cyrus server, you are required to give the user
12908 "anyone" posting ("p") capabilities to have "plussing" work (that is,
12909 mail sent to user+mailbox@@domain ending up in the IMAP mailbox
12910 INBOX.mailbox).
12911 @end itemize
12912
12913 @node Expunging mailboxes
12914 @subsubsection Expunging mailboxes
12915 @cindex expunging
12916
12917 @cindex Expunge
12918 @cindex Manual expunging
12919 @kindex G x
12920 @findex gnus-group-nnimap-expunge
12921
12922 If you're using the @code{never} setting of @code{nnimap-expunge-close},
12923 you may want the option of expunging all deleted articles in a mailbox
12924 manually. This is exactly what @kbd{G x} does.
12925
12926 Currently there is no way of showing deleted articles, you can just
12927 delete them.
12928
12929
12930
12931 @node Combined Groups
12932 @section Combined Groups
12933
12934 Gnus allows combining a mixture of all the other group types into bigger
12935 groups.
12936
12937 @menu
12938 * Virtual Groups::     Combining articles from many groups.
12939 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
12940 @end menu
12941
12942
12943 @node Virtual Groups
12944 @subsection Virtual Groups
12945 @cindex nnvirtual
12946 @cindex virtual groups
12947 @cindex merging groups
12948
12949 An @dfn{nnvirtual group} is really nothing more than a collection of
12950 other groups.
12951
12952 For instance, if you are tired of reading many small groups, you can
12953 put them all in one big group, and then grow tired of reading one
12954 big, unwieldy group.  The joys of computing!
12955
12956 You specify @code{nnvirtual} as the method.  The address should be a
12957 regexp to match component groups.
12958
12959 All marks in the virtual group will stick to the articles in the
12960 component groups.  So if you tick an article in a virtual group, the
12961 article will also be ticked in the component group from whence it came.
12962 (And vice versa---marks from the component groups will also be shown in
12963 the virtual group.)
12964
12965 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
12966 newsgroups into one, big, happy newsgroup:
12967
12968 @lisp
12969 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
12970 @end lisp
12971
12972 The component groups can be native or foreign; everything should work
12973 smoothly, but if your computer explodes, it was probably my fault.
12974
12975 Collecting the same group from several servers might actually be a good
12976 idea if users have set the Distribution header to limit distribution.
12977 If you would like to read @samp{soc.motss} both from a server in Japan
12978 and a server in Norway, you could use the following as the group regexp:
12979
12980 @example
12981 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
12982 @end example
12983
12984 (Remember, though, that if you're creating the group with @kbd{G m}, you
12985 shouldn't double the backslashes, and you should leave off the quote
12986 characters at the beginning and the end of the string.)
12987
12988 This should work kinda smoothly---all articles from both groups should
12989 end up in this one, and there should be no duplicates.  Threading (and
12990 the rest) will still work as usual, but there might be problems with the
12991 sequence of articles.  Sorting on date might be an option here
12992 (@pxref{Selecting a Group}).
12993
12994 One limitation, however---all groups included in a virtual
12995 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
12996 zombie groups can't be component groups for @code{nnvirtual} groups.
12997
12998 @vindex nnvirtual-always-rescan
12999 If the @code{nnvirtual-always-rescan} is non-@code{nil},
13000 @code{nnvirtual} will always scan groups for unread articles when
13001 entering a virtual group.  If this variable is @code{nil} (which is the
13002 default) and you read articles in a component group after the virtual
13003 group has been activated, the read articles from the component group
13004 will show up when you enter the virtual group.  You'll also see this
13005 effect if you have two virtual groups that have a component group in
13006 common.  If that's the case, you should set this variable to @code{t}.
13007 Or you can just tap @code{M-g} on the virtual group every time before
13008 you enter it---it'll have much the same effect.
13009
13010 @code{nnvirtual} can have both mail and news groups as component groups.
13011 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
13012 has to ask the backend of the component group the article comes from
13013 whether it is a news or mail backend.  However, when you do a @kbd{^},
13014 there is typically no sure way for the component backend to know this,
13015 and in that case @code{nnvirtual} tells Gnus that the article came from a
13016 not-news backend.  (Just to be on the safe side.)
13017
13018 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
13019 line from the article you respond to in these cases.
13020
13021
13022
13023 @node Kibozed Groups
13024 @subsection Kibozed Groups
13025 @cindex nnkiboze
13026 @cindex kibozing
13027
13028 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
13029 the news feed''.  @code{nnkiboze} is a backend that will do this for
13030 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
13031 with useless requests!  Oh happiness!
13032
13033 @kindex G k (Group)
13034 To create a kibozed group, use the @kbd{G k} command in the group
13035 buffer.
13036
13037 The address field of the @code{nnkiboze} method is, as with
13038 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
13039 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
13040 and @code{nnvirtual} end.
13041
13042 In addition to this regexp detailing component groups, an @code{nnkiboze} group
13043 must have a score file to say what articles are to be included in
13044 the group (@pxref{Scoring}).
13045
13046 @kindex M-x nnkiboze-generate-groups
13047 @findex nnkiboze-generate-groups
13048 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
13049 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
13050 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
13051 all the articles in all the component groups and run them through the
13052 scoring process to determine if there are any articles in the groups
13053 that are to be part of the @code{nnkiboze} groups.
13054
13055 Please limit the number of component groups by using restrictive
13056 regexps.  Otherwise your sysadmin may become annoyed with you, and the
13057 @sc{nntp} site may throw you off and never let you back in again.
13058 Stranger things have happened.
13059
13060 @code{nnkiboze} component groups do not have to be alive---they can be dead,
13061 and they can be foreign.  No restrictions.
13062
13063 @vindex nnkiboze-directory
13064 The generation of an @code{nnkiboze} group means writing two files in
13065 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
13066 contains the @sc{nov} header lines for all the articles in the group,
13067 and the other is an additional @file{.newsrc} file to store information
13068 on what groups have been searched through to find component articles.
13069
13070 Articles marked as read in the @code{nnkiboze} group will have
13071 their @sc{nov} lines removed from the @sc{nov} file.
13072
13073
13074 @node Gnus Unplugged
13075 @section Gnus Unplugged
13076 @cindex offline
13077 @cindex unplugged
13078 @cindex Agent
13079 @cindex Gnus Agent
13080 @cindex Gnus Unplugged
13081
13082 In olden times (ca. February '88), people used to run their newsreaders
13083 on big machines with permanent connections to the net.  News transport
13084 was dealt with by news servers, and all the newsreaders had to do was to
13085 read news.  Believe it or not.
13086
13087 Nowadays most people read news and mail at home, and use some sort of
13088 modem to connect to the net.  To avoid running up huge phone bills, it
13089 would be nice to have a way to slurp down all the news and mail, hang up
13090 the phone, read for several hours, and then upload any responses you
13091 have to make.  And then you repeat the procedure.
13092
13093 Of course, you can use news servers for doing this as well.  I've used
13094 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
13095 for some years, but doing that's a bore.  Moving the news server
13096 functionality up to the newsreader makes sense if you're the only person
13097 reading news on a machine.
13098
13099 Using Gnus as an ``offline'' newsreader is quite simple.
13100
13101 @itemize @bullet
13102 @item
13103 First, set up Gnus as you would do if you were running it on a machine
13104 that has full connection to the net.  Go ahead.  I'll still be waiting
13105 here.
13106
13107 @item
13108 Then, put the following magical incantation at the end of your
13109 @file{.gnus.el} file:
13110
13111 @lisp
13112 (gnus-agentize)
13113 @end lisp
13114 @end itemize
13115
13116 That's it.  Gnus is now an ``offline'' newsreader.
13117
13118 Of course, to use it as such, you have to learn a few new commands.
13119
13120 @menu
13121 * Agent Basics::           How it all is supposed to work.
13122 * Agent Categories::       How to tell the Gnus Agent what to download.
13123 * Agent Commands::         New commands for all the buffers.
13124 * Agent Expiry::           How to make old articles go away.
13125 * Outgoing Messages::      What happens when you post/mail something?
13126 * Agent Variables::        Customizing is fun.
13127 * Example Setup::          An example @file{.gnus.el} file for offline people.
13128 * Batching Agents::        How to fetch news from a @code{cron} job.
13129 * Agent Caveats::          What you think it'll do and what it does.
13130 @end menu
13131
13132
13133 @node Agent Basics
13134 @subsection Agent Basics
13135
13136 First, let's get some terminology out of the way.
13137
13138 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
13139 connection to the net (and notified the Agent that this is the case).
13140 When the connection to the net is up again (and Gnus knows this), the
13141 Agent is @dfn{plugged}.
13142
13143 The @dfn{local} machine is the one you're running on, and which isn't
13144 connected to the net continuously.
13145
13146 @dfn{Downloading} means fetching things from the net to your local
13147 machine.  @dfn{Uploading} is doing the opposite.
13148
13149 Let's take a typical Gnus session using the Agent.
13150
13151 @itemize @bullet
13152
13153 @item
13154 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
13155 Agent in a disconnected state.  You can read all the news that you have
13156 already fetched while in this mode.
13157
13158 @item
13159 You then decide to see whether any new news has arrived.  You connect
13160 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
13161 to make Gnus become @dfn{plugged}.
13162
13163 @item
13164 You can then read the new news immediately, or you can download the news
13165 onto your local machine.  If you want to do the latter, you press @kbd{J
13166 s} to fetch all the eligible articles in all the groups.  (To let Gnus
13167 know which articles you want to download, @pxref{Agent Categories}.)
13168
13169 @item
13170 After fetching the articles, you press @kbd{J j} to make Gnus become
13171 unplugged again, and you shut down the PPP thing (or whatever).  And
13172 then you read the news offline.
13173
13174 @item
13175 And then you go to step 2.
13176 @end itemize
13177
13178 Here are some things you should do the first time (or so) that you use
13179 the Agent.
13180
13181 @itemize @bullet
13182
13183 @item
13184 Decide which servers should be covered by the Agent.  If you have a mail
13185 backend, it would probably be nonsensical to have it covered by the
13186 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
13187 @kbd{J a} the server (or servers) that you wish to have covered by the
13188 Agent (@pxref{Server Agent Commands}).  This will typically be only the
13189 primary select method, which is listed on the bottom in the buffer.
13190
13191 @item
13192 Decide on download policy.  @xref{Agent Categories}.
13193
13194 @item
13195 Uhm... that's it.
13196 @end itemize
13197
13198
13199 @node Agent Categories
13200 @subsection Agent Categories
13201
13202 One of the main reasons to integrate the news transport layer into the
13203 newsreader is to allow greater control over what articles to download.
13204 There's not much point in downloading huge amounts of articles, just to
13205 find out that you're not interested in reading any of them.  It's better
13206 to be somewhat more conservative in choosing what to download, and then
13207 mark the articles for downloading manually if it should turn out that
13208 you're interested in the articles anyway.
13209
13210 The main way to control what is to be downloaded is to create a
13211 @dfn{category} and then assign some (or all) groups to this category.
13212 Groups that do not belong in any other category belong to the
13213 @code{default} category. Gnus has its own buffer for creating and
13214 managing categories.
13215
13216 @menu
13217 * Category Syntax::       What a category looks like.
13218 * The Category Buffer::   A buffer for maintaining categories.
13219 * Category Variables::    Customize'r'Us.
13220 @end menu
13221
13222
13223 @node Category Syntax
13224 @subsubsection Category Syntax
13225
13226 A category consists of two things.
13227
13228 @enumerate
13229 @item
13230 A predicate which (generally) gives a rough outline of which articles
13231 are eligible for downloading; and
13232
13233 @item
13234 a score rule which (generally) gives you a finer granularity when
13235 deciding what articles to download.  (Note that this @dfn{download
13236 score} is not necessarily related to normal scores.)
13237 @end enumerate
13238
13239 A predicate in its simplest form can be a single predicate such as
13240 @code{true} or @code{false}. These two will download every available
13241 article or nothing respectively. In the case of these two special
13242 predicates an additional score rule is superfluous.
13243
13244 Predicates of @code{high} or @code{low} download articles in respect of
13245 their scores in relationship to @code{gnus-agent-high-score} and
13246 @code{gnus-agent-low-score} as descibed below.
13247
13248 To gain even finer control of what is to be regarded eligible for
13249 download a predicate can consist of a number of predicates with logical
13250 operators sprinkled in between.
13251
13252 Perhaps some examples are in order.
13253
13254 Here's a simple predicate.  (It's the default predicate, in fact, used
13255 for all groups that don't belong to any other category.)
13256
13257 @lisp
13258 short
13259 @end lisp
13260
13261 Quite simple, eh?  This predicate is true if and only if the article is
13262 short (for some value of ``short'').
13263
13264 Here's a more complex predicate:
13265
13266 @lisp
13267 (or high
13268     (and
13269      (not low)
13270      (not long)))
13271 @end lisp
13272
13273 This means that an article should be downloaded if it has a high score,
13274 or if the score is not low and the article is not long.  You get the
13275 drift.
13276
13277 The available logical operators are @code{or}, @code{and} and
13278 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
13279 @samp{|}, @code{&} and @code{!} instead.)
13280
13281 The following predicates are pre-defined, but if none of these fit what
13282 you want to do, you can write your own.
13283
13284 @table @code
13285 @item short
13286 True iff the article is shorter than @code{gnus-agent-short-article}
13287 lines; default 100.
13288
13289 @item long
13290 True iff the article is longer than @code{gnus-agent-long-article}
13291 lines; default 200.
13292
13293 @item low
13294 True iff the article has a download score less than
13295 @code{gnus-agent-low-score}; default 0.
13296
13297 @item high
13298 True iff the article has a download score greater than
13299 @code{gnus-agent-high-score}; default 0.
13300
13301 @item spam
13302 True iff the Gnus Agent guesses that the article is spam.  The
13303 heuristics may change over time, but at present it just computes a
13304 checksum and sees whether articles match.
13305
13306 @item true
13307 Always true.
13308
13309 @item false
13310 Always false.
13311 @end table
13312
13313 If you want to create your own predicate function, here's what you have
13314 to know:  The functions are called with no parameters, but the
13315 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
13316 useful values.
13317
13318 For example, you could decide that you don't want to download articles
13319 that were posted more than a certain number of days ago (e.g. posted
13320 more than @code{gnus-agent-expire-days} ago) you might write a function
13321 something along the lines of the following:
13322
13323 @lisp
13324 (defun my-article-old-p ()
13325   "Say whether an article is old."
13326   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
13327      (- (time-to-days (current-time)) gnus-agent-expire-days)))
13328 @end lisp
13329
13330 with the predicate then defined as:
13331
13332 @lisp
13333 (not my-article-old-p)
13334 @end lisp
13335
13336 or you could append your predicate to the predefined
13337 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
13338 wherever.  (Note: this would have to be at a point *after*
13339 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
13340
13341 @lisp
13342 (defvar  gnus-category-predicate-alist
13343   (append gnus-category-predicate-alist
13344          '((old . my-article-old-p))))
13345 @end lisp
13346
13347 and simply specify your predicate as:
13348
13349 @lisp
13350 (not old)
13351 @end lisp
13352
13353 If/when using something like the above, be aware that there are many
13354 misconfigured systems/mailers out there and so an article's date is not
13355 always a reliable indication of when it was posted. Hell, some people
13356 just don't give a damm.
13357
13358
13359 The above predicates apply to *all* the groups which belong to the
13360 category. However, if you wish to have a specific predicate for an
13361 individual group within a category, or you're just too lazy to set up a
13362 new category, you can enter a group's individual predicate in it's group
13363 parameters like so:
13364
13365 @lisp
13366 (agent-predicate . short)
13367 @end lisp
13368
13369 This is the group parameter equivalent of the agent category
13370 default. Note that when specifying a single word predicate like this,
13371 the @code{agent-predicate} specification must be in dotted pair
13372 notation.
13373
13374 The equivalent of the longer example from above would be:
13375
13376 @lisp
13377 (agent-predicate or high (and (not low) (not long)))
13378 @end lisp
13379
13380 The outer parenthesis required in the category specification are not
13381 entered here as, not being in dotted pair notation, the value of the
13382 predicate is assumed to be a list.
13383
13384
13385 Now, the syntax of the download score is the same as the syntax of
13386 normal score files, except that all elements that require actually
13387 seeing the article itself are verboten.  This means that only the
13388 following headers can be scored on: @code{Subject}, @code{From},
13389 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
13390 @code{Lines}, and @code{Xref}.
13391
13392 As with predicates, the specification of the @code{download score rule}
13393 to use in respect of a group can be in either the category definition if
13394 it's to be applicable to all groups in therein, or a group's parameters
13395 if it's to be specific to that group.
13396
13397 In both of these places the @code{download score rule} can take one of
13398 three forms:
13399
13400 @enumerate
13401 @item
13402 Score rule
13403
13404 This has the same syntax as a normal gnus score file except only a
13405 subset of scoring keywords are available as mentioned above.
13406
13407 example:
13408
13409 @itemize @bullet
13410 @item
13411 Category specification
13412
13413 @lisp
13414 (("from"
13415        ("Lars Ingebrigtsen" 1000000 nil s))
13416 ("lines"
13417        (500 -100 nil <)))
13418 @end lisp
13419
13420 @item
13421 Group Parameter specification
13422
13423 @lisp
13424 (agent-score ("from"
13425                    ("Lars Ingebrigtsen" 1000000 nil s))
13426              ("lines"
13427                    (500 -100 nil <)))
13428 @end lisp
13429
13430 Again, note the omission of the outermost parenthesis here.
13431 @end itemize
13432
13433 @item
13434 Agent score file
13435
13436 These score files must *only* contain the permitted scoring keywords
13437 stated above.
13438
13439 example:
13440
13441 @itemize @bullet
13442 @item
13443 Category specification
13444
13445 @lisp
13446 ("~/News/agent.SCORE")
13447 @end lisp
13448
13449 or perhaps
13450
13451 @lisp
13452 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
13453 @end lisp
13454
13455 @item
13456 Group Parameter specification
13457
13458 @lisp
13459 (agent-score "~/News/agent.SCORE")
13460 @end lisp
13461
13462 Additional score files can be specified as above. Need I say anything
13463 about parenthesis.
13464 @end itemize
13465
13466 @item
13467 Use @code{normal} score files
13468
13469 If you dont want to maintain two sets of scoring rules for a group, and
13470 your desired @code{downloading} criteria for a group are the same as your
13471 @code{reading} criteria then you can tell the agent to refer to your
13472 @code{normal} score files when deciding what to download.
13473
13474 These directives in either the category definition or a group's
13475 parameters will cause the agent to read in all the applicable score
13476 files for a group, *filtering out* those those sections that do not
13477 relate to one of the permitted subset of scoring keywords.
13478
13479 @itemize @bullet
13480 @item
13481 Category Specification
13482
13483 @lisp
13484 file
13485 @end lisp
13486
13487 @item
13488 Group Parameter specification
13489
13490 @lisp
13491 (agent-score . file)
13492 @end lisp
13493 @end itemize
13494 @end enumerate
13495
13496 @node The Category Buffer
13497 @subsubsection The Category Buffer
13498
13499 You'd normally do all category maintenance from the category buffer.
13500 When you enter it for the first time (with the @kbd{J c} command from
13501 the group buffer), you'll only see the @code{default} category.
13502
13503 The following commands are available in this buffer:
13504
13505 @table @kbd
13506 @item q
13507 @kindex q (Category)
13508 @findex gnus-category-exit
13509 Return to the group buffer (@code{gnus-category-exit}).
13510
13511 @item k
13512 @kindex k (Category)
13513 @findex gnus-category-kill
13514 Kill the current category (@code{gnus-category-kill}).
13515
13516 @item c
13517 @kindex c (Category)
13518 @findex gnus-category-copy
13519 Copy the current category (@code{gnus-category-copy}).
13520
13521 @item a
13522 @kindex a (Category)
13523 @findex gnus-category-add
13524 Add a new category (@code{gnus-category-add}).
13525
13526 @item p
13527 @kindex p (Category)
13528 @findex gnus-category-edit-predicate
13529 Edit the predicate of the current category
13530 (@code{gnus-category-edit-predicate}).
13531
13532 @item g
13533 @kindex g (Category)
13534 @findex gnus-category-edit-groups
13535 Edit the list of groups belonging to the current category
13536 (@code{gnus-category-edit-groups}).
13537
13538 @item s
13539 @kindex s (Category)
13540 @findex gnus-category-edit-score
13541 Edit the download score rule of the current category
13542 (@code{gnus-category-edit-score}).
13543
13544 @item l
13545 @kindex l (Category)
13546 @findex gnus-category-list
13547 List all the categories (@code{gnus-category-list}).
13548 @end table
13549
13550
13551 @node Category Variables
13552 @subsubsection Category Variables
13553
13554 @table @code
13555 @item gnus-category-mode-hook
13556 @vindex gnus-category-mode-hook
13557 Hook run in category buffers.
13558
13559 @item gnus-category-line-format
13560 @vindex gnus-category-line-format
13561 Format of the lines in the category buffer (@pxref{Formatting
13562 Variables}).  Valid elements are:
13563
13564 @table @samp
13565 @item c
13566 The name of the category.
13567
13568 @item g
13569 The number of groups in the category.
13570 @end table
13571
13572 @item gnus-category-mode-line-format
13573 @vindex gnus-category-mode-line-format
13574 Format of the category mode line (@pxref{Mode Line Formatting}).
13575
13576 @item gnus-agent-short-article
13577 @vindex gnus-agent-short-article
13578 Articles that have fewer lines than this are short.  Default 100.
13579
13580 @item gnus-agent-long-article
13581 @vindex gnus-agent-long-article
13582 Articles that have more lines than this are long.  Default 200.
13583
13584 @item gnus-agent-low-score
13585 @vindex gnus-agent-low-score
13586 Articles that have a score lower than this have a low score.  Default
13587 0.
13588
13589 @item gnus-agent-high-score
13590 @vindex gnus-agent-high-score
13591 Articles that have a score higher than this have a high score.  Default
13592 0.
13593
13594 @end table
13595
13596
13597 @node Agent Commands
13598 @subsection Agent Commands
13599
13600 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
13601 (@code{gnus-agent-toggle-plugged} command works in all modes, and
13602 toggles the plugged/unplugged state of the Gnus Agent.
13603
13604
13605 @menu
13606 * Group Agent Commands::
13607 * Summary Agent Commands::
13608 * Server Agent Commands::
13609 @end menu
13610
13611 You can run a complete batch fetch from the command line with the
13612 following incantation:
13613
13614 @cindex gnus-agent-batch-fetch
13615 @example
13616 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
13617 @end example
13618
13619
13620
13621 @node Group Agent Commands
13622 @subsubsection Group Agent Commands
13623
13624 @table @kbd
13625 @item J u
13626 @kindex J u (Agent Group)
13627 @findex gnus-agent-fetch-groups
13628 Fetch all eligible articles in the current group
13629 (@code{gnus-agent-fetch-groups}).
13630
13631 @item J c
13632 @kindex J c (Agent Group)
13633 @findex gnus-enter-category-buffer
13634 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
13635
13636 @item J s
13637 @kindex J s (Agent Group)
13638 @findex gnus-agent-fetch-session
13639 Fetch all eligible articles in all groups
13640 (@code{gnus-agent-fetch-session}).
13641
13642 @item J S
13643 @kindex J S (Agent Group)
13644 @findex gnus-group-send-drafts
13645 Send all sendable messages in the draft group
13646 (@code{gnus-group-send-drafts}).  @xref{Drafts}.
13647
13648 @item J a
13649 @kindex J a (Agent Group)
13650 @findex gnus-agent-add-group
13651 Add the current group to an Agent category
13652 (@code{gnus-agent-add-group}).  This command understands the
13653 process/prefix convention (@pxref{Process/Prefix}).
13654
13655 @item J r
13656 @kindex J r (Agent Group)
13657 @findex gnus-agent-remove-group
13658 Remove the current group from its category, if any
13659 (@code{gnus-agent-remove-group}).  This command understands the
13660 process/prefix convention (@pxref{Process/Prefix}).
13661
13662 @end table
13663
13664
13665 @node Summary Agent Commands
13666 @subsubsection Summary Agent Commands
13667
13668 @table @kbd
13669 @item J #
13670 @kindex J # (Agent Summary)
13671 @findex gnus-agent-mark-article
13672 Mark the article for downloading (@code{gnus-agent-mark-article}).
13673
13674 @item J M-#
13675 @kindex J M-# (Agent Summary)
13676 @findex gnus-agent-unmark-article
13677 Remove the downloading mark from the article
13678 (@code{gnus-agent-unmark-article}).
13679
13680 @item @@
13681 @kindex @@ (Agent Summary)
13682 @findex gnus-agent-toggle-mark
13683 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
13684
13685 @item J c
13686 @kindex J c (Agent Summary)
13687 @findex gnus-agent-catchup
13688 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
13689
13690 @end table
13691
13692
13693 @node Server Agent Commands
13694 @subsubsection Server Agent Commands
13695
13696 @table @kbd
13697 @item J a
13698 @kindex J a (Agent Server)
13699 @findex gnus-agent-add-server
13700 Add the current server to the list of servers covered by the Gnus Agent
13701 (@code{gnus-agent-add-server}).
13702
13703 @item J r
13704 @kindex J r (Agent Server)
13705 @findex gnus-agent-remove-server
13706 Remove the current server from the list of servers covered by the Gnus
13707 Agent (@code{gnus-agent-remove-server}).
13708
13709 @end table
13710
13711
13712 @node Agent Expiry
13713 @subsection Agent Expiry
13714
13715 @vindex gnus-agent-expire-days
13716 @findex gnus-agent-expire
13717 @kindex M-x gnus-agent-expire
13718 @cindex Agent expiry
13719 @cindex Gnus Agent expiry
13720 @cindex expiry
13721
13722 @code{nnagent} doesn't handle expiry.  Instead, there's a special
13723 @code{gnus-agent-expire} command that will expire all read articles that
13724 are older than @code{gnus-agent-expire-days} days.  It can be run
13725 whenever you feel that you're running out of space.  It's not
13726 particularly fast or efficient, and it's not a particularly good idea to
13727 interrupt it (with @kbd{C-g} or anything else) once you've started it.
13728
13729 @vindex gnus-agent-expire-all
13730 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
13731 expire all articles---unread, read, ticked and dormant.  If @code{nil}
13732 (which is the default), only read articles are eligible for expiry, and
13733 unread, ticked and dormant articles will be kept indefinitely.
13734
13735
13736 @node Outgoing Messages
13737 @subsection Outgoing Messages
13738
13739 When Gnus is unplugged, all outgoing messages (both mail and news) are
13740 stored in the draft groups (@pxref{Drafts}).  You can view them there
13741 after posting, and edit them at will.
13742
13743 When Gnus is plugged again, you can send the messages either from the
13744 draft group with the special commands available there, or you can use
13745 the @kbd{J S} command in the group buffer to send all the sendable
13746 messages in the draft group.
13747
13748
13749
13750 @node Agent Variables
13751 @subsection Agent Variables
13752
13753 @table @code
13754 @item gnus-agent-directory
13755 @vindex gnus-agent-directory
13756 Where the Gnus Agent will store its files.  The default is
13757 @file{~/News/agent/}.
13758
13759 @item gnus-agent-handle-level
13760 @vindex gnus-agent-handle-level
13761 Groups on levels (@pxref{Group Levels}) higher than this variable will
13762 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
13763 which means that only subscribed group will be considered by the Agent
13764 by default.
13765
13766 @item gnus-agent-plugged-hook
13767 @vindex gnus-agent-plugged-hook
13768 Hook run when connecting to the network.
13769
13770 @item gnus-agent-unplugged-hook
13771 @vindex gnus-agent-unplugged-hook
13772 Hook run when disconnecting from the network.
13773
13774 @end table
13775
13776
13777 @node Example Setup
13778 @subsection Example Setup
13779
13780 If you don't want to read this manual, and you have a fairly standard
13781 setup, you may be able to use something like the following as your
13782 @file{.gnus.el} file to get started.
13783
13784 @lisp
13785 ;;; Define how Gnus is to fetch news.  We do this over NNTP
13786 ;;; from your ISP's server.
13787 (setq gnus-select-method '(nntp "news.your-isp.com"))
13788
13789 ;;; Define how Gnus is to read your mail.  We read mail from
13790 ;;; your ISP's POP server.
13791 (setq mail-sources '((pop :server "pop.your-isp.com")))
13792
13793 ;;; Say how Gnus is to store the mail.  We use nnml groups.
13794 (setq gnus-secondary-select-methods '((nnml "")))
13795
13796 ;;; Make Gnus into an offline newsreader.
13797 (gnus-agentize)
13798 @end lisp
13799
13800 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
13801 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
13802 gnus}.
13803
13804 If this is the first time you've run Gnus, you will be subscribed
13805 automatically to a few default newsgroups.  You'll probably want to
13806 subscribe to more groups, and to do that, you have to query the
13807 @sc{nntp} server for a complete list of groups with the @kbd{A A}
13808 command.  This usually takes quite a while, but you only have to do it
13809 once.
13810
13811 After reading and parsing a while, you'll be presented with a list of
13812 groups.  Subscribe to the ones you want to read with the @kbd{u}
13813 command.  @kbd{l} to make all the killed groups disappear after you've
13814 subscribe to all the groups you want to read.  (@kbd{A k} will bring
13815 back all the killed groups.)
13816
13817 You can now read the groups at once, or you can download the articles
13818 with the @kbd{J s} command.  And then read the rest of this manual to
13819 find out which of the other gazillion things you want to customize.
13820
13821
13822 @node Batching Agents
13823 @subsection Batching Agents
13824
13825 Having the Gnus Agent fetch articles (and post whatever messages you've
13826 written) is quite easy once you've gotten things set up properly.  The
13827 following shell script will do everything that is necessary:
13828
13829 @example
13830 #!/bin/sh
13831 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
13832 @end example
13833
13834
13835 @node Agent Caveats
13836 @subsection Agent Caveats
13837
13838 The Gnus Agent doesn't seem to work like most other offline
13839 newsreaders.  Here are some common questions that some imaginary people
13840 may ask:
13841
13842 @table @dfn
13843 @item If I read an article while plugged, do they get entered into the
13844 Agent?
13845
13846 @strong{No.}
13847
13848 @item If I read an article while plugged, and the article already exists
13849 in the Agent, will it get downloaded once more?
13850
13851 @strong{Yes.}
13852
13853 @end table
13854
13855 In short, when Gnus is unplugged, it only looks into the locally stored
13856 articles; when it's plugged, it only talks to your ISP.
13857
13858
13859 @node Scoring
13860 @chapter Scoring
13861 @cindex scoring
13862
13863 Other people use @dfn{kill files}, but we here at Gnus Towers like
13864 scoring better than killing, so we'd rather switch than fight.  They do
13865 something completely different as well, so sit up straight and pay
13866 attention!
13867
13868 @vindex gnus-summary-mark-below
13869 All articles have a default score (@code{gnus-summary-default-score}),
13870 which is 0 by default.  This score may be raised or lowered either
13871 interactively or by score files.  Articles that have a score lower than
13872 @code{gnus-summary-mark-below} are marked as read.
13873
13874 Gnus will read any @dfn{score files} that apply to the current group
13875 before generating the summary buffer.
13876
13877 There are several commands in the summary buffer that insert score
13878 entries based on the current article.  You can, for instance, ask Gnus to
13879 lower or increase the score of all articles with a certain subject.
13880
13881 There are two sorts of scoring entries: Permanent and temporary.
13882 Temporary score entries are self-expiring entries.  Any entries that are
13883 temporary and have not been used for, say, a week, will be removed
13884 silently to help keep the sizes of the score files down.
13885
13886 @menu
13887 * Summary Score Commands::   Adding score entries for the current group.
13888 * Group Score Commands::     General score commands.
13889 * Score Variables::          Customize your scoring.  (My, what terminology).
13890 * Score File Format::        What a score file may contain.
13891 * Score File Editing::       You can edit score files by hand as well.
13892 * Adaptive Scoring::         Big Sister Gnus knows what you read.
13893 * Home Score File::          How to say where new score entries are to go.
13894 * Followups To Yourself::    Having Gnus notice when people answer you.
13895 * Scoring Tips::             How to score effectively.
13896 * Reverse Scoring::          That problem child of old is not problem.
13897 * Global Score Files::       Earth-spanning, ear-splitting score files.
13898 * Kill Files::               They are still here, but they can be ignored.
13899 * Converting Kill Files::    Translating kill files to score files.
13900 * GroupLens::                Getting predictions on what you like to read.
13901 * Advanced Scoring::         Using logical expressions to build score rules.
13902 * Score Decays::             It can be useful to let scores wither away.
13903 @end menu
13904
13905
13906 @node Summary Score Commands
13907 @section Summary Score Commands
13908 @cindex score commands
13909
13910 The score commands that alter score entries do not actually modify real
13911 score files.  That would be too inefficient.  Gnus maintains a cache of
13912 previously loaded score files, one of which is considered the
13913 @dfn{current score file alist}.  The score commands simply insert
13914 entries into this list, and upon group exit, this list is saved.
13915
13916 The current score file is by default the group's local score file, even
13917 if no such score file actually exists.  To insert score commands into
13918 some other score file (e.g. @file{all.SCORE}), you must first make this
13919 score file the current one.
13920
13921 General score commands that don't actually change the score file:
13922
13923 @table @kbd
13924
13925 @item V s
13926 @kindex V s (Summary)
13927 @findex gnus-summary-set-score
13928 Set the score of the current article (@code{gnus-summary-set-score}).
13929
13930 @item V S
13931 @kindex V S (Summary)
13932 @findex gnus-summary-current-score
13933 Display the score of the current article
13934 (@code{gnus-summary-current-score}).
13935
13936 @item V t
13937 @kindex V t (Summary)
13938 @findex gnus-score-find-trace
13939 Display all score rules that have been used on the current article
13940 (@code{gnus-score-find-trace}).
13941
13942 @item V R
13943 @kindex V R (Summary)
13944 @findex gnus-summary-rescore
13945 Run the current summary through the scoring process
13946 (@code{gnus-summary-rescore}).  This might be useful if you're playing
13947 around with your score files behind Gnus' back and want to see the
13948 effect you're having.
13949
13950 @item V c
13951 @kindex V c (Summary)
13952 @findex gnus-score-change-score-file
13953 Make a different score file the current
13954 (@code{gnus-score-change-score-file}).
13955
13956 @item V e
13957 @kindex V e (Summary)
13958 @findex gnus-score-edit-current-scores
13959 Edit the current score file (@code{gnus-score-edit-current-scores}).
13960 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
13961 File Editing}).
13962
13963 @item V f
13964 @kindex V f (Summary)
13965 @findex gnus-score-edit-file
13966 Edit a score file and make this score file the current one
13967 (@code{gnus-score-edit-file}).
13968
13969 @item V F
13970 @kindex V F (Summary)
13971 @findex gnus-score-flush-cache
13972 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
13973 after editing score files.
13974
13975 @item V C
13976 @kindex V C (Summary)
13977 @findex gnus-score-customize
13978 Customize a score file in a visually pleasing manner
13979 (@code{gnus-score-customize}).
13980
13981 @end table
13982
13983 The rest of these commands modify the local score file.
13984
13985 @table @kbd
13986
13987 @item V m
13988 @kindex V m (Summary)
13989 @findex gnus-score-set-mark-below
13990 Prompt for a score, and mark all articles with a score below this as
13991 read (@code{gnus-score-set-mark-below}).
13992
13993 @item V x
13994 @kindex V x (Summary)
13995 @findex gnus-score-set-expunge-below
13996 Prompt for a score, and add a score rule to the current score file to
13997 expunge all articles below this score
13998 (@code{gnus-score-set-expunge-below}).
13999 @end table
14000
14001 The keystrokes for actually making score entries follow a very regular
14002 pattern, so there's no need to list all the commands.  (Hundreds of
14003 them.)
14004
14005 @findex gnus-summary-increase-score
14006 @findex gnus-summary-lower-score
14007
14008 @enumerate
14009 @item
14010 The first key is either @kbd{I} (upper case i) for increasing the score
14011 or @kbd{L} for lowering the score.
14012 @item
14013 The second key says what header you want to score on.  The following
14014 keys are available:
14015 @table @kbd
14016
14017 @item a
14018 Score on the author name.
14019
14020 @item s
14021 Score on the subject line.
14022
14023 @item x
14024 Score on the @code{Xref} line---i.e., the cross-posting line.
14025
14026 @item r
14027 Score on the @code{References} line.
14028
14029 @item d
14030 Score on the date.
14031
14032 @item l
14033 Score on the number of lines.
14034
14035 @item i
14036 Score on the @code{Message-ID} header.
14037
14038 @item f
14039 Score on followups---this matches the author name, and adds scores to
14040 the followups to this author.
14041
14042 @item b
14043 Score on the body.
14044
14045 @item h
14046 Score on the head.
14047
14048 @item t
14049 Score on thread.
14050
14051 @end table
14052
14053 @item
14054 The third key is the match type.  Which match types are valid depends on
14055 what headers you are scoring on.
14056
14057 @table @code
14058
14059 @item strings
14060
14061 @table @kbd
14062
14063 @item e
14064 Exact matching.
14065
14066 @item s
14067 Substring matching.
14068
14069 @item f
14070 Fuzzy matching (@pxref{Fuzzy Matching}).
14071
14072 @item r
14073 Regexp matching
14074 @end table
14075
14076 @item date
14077 @table @kbd
14078
14079 @item b
14080 Before date.
14081
14082 @item a
14083 After date.
14084
14085 @item n
14086 This date.
14087 @end table
14088
14089 @item number
14090 @table @kbd
14091
14092 @item <
14093 Less than number.
14094
14095 @item =
14096 Equal to number.
14097
14098 @item >
14099 Greater than number.
14100 @end table
14101 @end table
14102
14103 @item
14104 The fourth and final key says whether this is a temporary (i.e., expiring)
14105 score entry, or a permanent (i.e., non-expiring) score entry, or whether
14106 it is to be done immediately, without adding to the score file.
14107 @table @kbd
14108
14109 @item t
14110 Temporary score entry.
14111
14112 @item p
14113 Permanent score entry.
14114
14115 @item i
14116 Immediately scoring.
14117 @end table
14118
14119 @end enumerate
14120
14121 So, let's say you want to increase the score on the current author with
14122 exact matching permanently: @kbd{I a e p}.  If you want to lower the
14123 score based on the subject line, using substring matching, and make a
14124 temporary score entry: @kbd{L s s t}.  Pretty easy.
14125
14126 To make things a bit more complicated, there are shortcuts.  If you use
14127 a capital letter on either the second or third keys, Gnus will use
14128 defaults for the remaining one or two keystrokes.  The defaults are
14129 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
14130 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
14131
14132 These functions take both the numerical prefix and the symbolic prefix
14133 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
14134 (or increase) the score of the article.  A symbolic prefix of @code{a}
14135 says to use the @file{all.SCORE} file for the command instead of the
14136 current score file.
14137
14138 @vindex gnus-score-mimic-keymap
14139 The @code{gnus-score-mimic-keymap} says whether these commands will
14140 pretend they are keymaps or not.
14141
14142
14143 @node Group Score Commands
14144 @section Group Score Commands
14145 @cindex group score commands
14146
14147 There aren't many of these as yet, I'm afraid.
14148
14149 @table @kbd
14150
14151 @item W f
14152 @kindex W f (Group)
14153 @findex gnus-score-flush-cache
14154 Gnus maintains a cache of score alists to avoid having to reload them
14155 all the time.  This command will flush the cache
14156 (@code{gnus-score-flush-cache}).
14157
14158 @end table
14159
14160 You can do scoring from the command line by saying something like:
14161
14162 @findex gnus-batch-score
14163 @cindex batch scoring
14164 @example
14165 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
14166 @end example
14167
14168
14169 @node Score Variables
14170 @section Score Variables
14171 @cindex score variables
14172
14173 @table @code
14174
14175 @item gnus-use-scoring
14176 @vindex gnus-use-scoring
14177 If @code{nil}, Gnus will not check for score files, and will not, in
14178 general, do any score-related work.  This is @code{t} by default.
14179
14180 @item gnus-kill-killed
14181 @vindex gnus-kill-killed
14182 If this variable is @code{nil}, Gnus will never apply score files to
14183 articles that have already been through the kill process.  While this
14184 may save you lots of time, it also means that if you apply a kill file
14185 to a group, and then change the kill file and want to run it over you
14186 group again to kill more articles, it won't work.  You have to set this
14187 variable to @code{t} to do that.  (It is @code{t} by default.)
14188
14189 @item gnus-kill-files-directory
14190 @vindex gnus-kill-files-directory
14191 All kill and score files will be stored in this directory, which is
14192 initialized from the @code{SAVEDIR} environment variable by default.
14193 This is @file{~/News/} by default.
14194
14195 @item gnus-score-file-suffix
14196 @vindex gnus-score-file-suffix
14197 Suffix to add to the group name to arrive at the score file name
14198 (@samp{SCORE} by default.)
14199
14200 @item gnus-score-uncacheable-files
14201 @vindex gnus-score-uncacheable-files
14202 @cindex score cache
14203 All score files are normally cached to avoid excessive re-loading of
14204 score files.  However, if this might make your Emacs grow big and
14205 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
14206 @file{all.SCORE}, while it might be a good idea to not cache
14207 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
14208 variable is @samp{ADAPT$} by default, so no adaptive score files will
14209 be cached.
14210
14211 @item gnus-save-score
14212 @vindex gnus-save-score
14213 If you have really complicated score files, and do lots of batch
14214 scoring, then you might set this variable to @code{t}.  This will make
14215 Gnus save the scores into the @file{.newsrc.eld} file.
14216
14217 If you do not set this to @code{t}, then manual scores (like those set
14218 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
14219 across group visits.
14220
14221 @item gnus-score-interactive-default-score
14222 @vindex gnus-score-interactive-default-score
14223 Score used by all the interactive raise/lower commands to raise/lower
14224 score with.  Default is 1000, which may seem excessive, but this is to
14225 ensure that the adaptive scoring scheme gets enough room to play with.
14226 We don't want the small changes from the adaptive scoring to overwrite
14227 manually entered data.
14228
14229 @item gnus-summary-default-score
14230 @vindex gnus-summary-default-score
14231 Default score of an article, which is 0 by default.
14232
14233 @item gnus-summary-expunge-below
14234 @vindex gnus-summary-expunge-below
14235 Don't display the summary lines of articles that have scores lower than
14236 this variable.  This is @code{nil} by default, which means that no
14237 articles will be hidden.  This variable is local to the summary buffers,
14238 and has to be set from @code{gnus-summary-mode-hook}.
14239
14240 @item gnus-score-over-mark
14241 @vindex gnus-score-over-mark
14242 Mark (in the third column) used for articles with a score over the
14243 default.  Default is @samp{+}.
14244
14245 @item gnus-score-below-mark
14246 @vindex gnus-score-below-mark
14247 Mark (in the third column) used for articles with a score below the
14248 default.  Default is @samp{-}.
14249
14250 @item gnus-score-find-score-files-function
14251 @vindex gnus-score-find-score-files-function
14252 Function used to find score files for the current group.  This function
14253 is called with the name of the group as the argument.
14254
14255 Predefined functions available are:
14256 @table @code
14257
14258 @item gnus-score-find-single
14259 @findex gnus-score-find-single
14260 Only apply the group's own score file.
14261
14262 @item gnus-score-find-bnews
14263 @findex gnus-score-find-bnews
14264 Apply all score files that match, using bnews syntax.  This is the
14265 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
14266 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
14267 @file{gnu.all.SCORE} would all apply.  In short, the instances of
14268 @samp{all} in the score file names are translated into @samp{.*}, and
14269 then a regexp match is done.
14270
14271 This means that if you have some score entries that you want to apply to
14272 all groups, then you put those entries in the @file{all.SCORE} file.
14273
14274 The score files are applied in a semi-random order, although Gnus will
14275 try to apply the more general score files before the more specific score
14276 files.  It does this by looking at the number of elements in the score
14277 file names---discarding the @samp{all} elements.
14278
14279 @item gnus-score-find-hierarchical
14280 @findex gnus-score-find-hierarchical
14281 Apply all score files from all the parent groups.  This means that you
14282 can't have score files like @file{all.SCORE}, but you can have
14283 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
14284
14285 @end table
14286 This variable can also be a list of functions.  In that case, all these
14287 functions will be called, and all the returned lists of score files will
14288 be applied.  These functions can also return lists of score alists
14289 directly.  In that case, the functions that return these non-file score
14290 alists should probably be placed before the ``real'' score file
14291 functions, to ensure that the last score file returned is the local
14292 score file.  Phu.
14293
14294 @item gnus-score-expiry-days
14295 @vindex gnus-score-expiry-days
14296 This variable says how many days should pass before an unused score file
14297 entry is expired.  If this variable is @code{nil}, no score file entries
14298 are expired.  It's 7 by default.
14299
14300 @item gnus-update-score-entry-dates
14301 @vindex gnus-update-score-entry-dates
14302 If this variable is non-@code{nil}, matching score entries will have
14303 their dates updated.  (This is how Gnus controls expiry---all
14304 non-matching entries will become too old while matching entries will
14305 stay fresh and young.)  However, if you set this variable to @code{nil},
14306 even matching entries will grow old and will have to face that oh-so
14307 grim reaper.
14308
14309 @item gnus-score-after-write-file-function
14310 @vindex gnus-score-after-write-file-function
14311 Function called with the name of the score file just written.
14312
14313 @item gnus-score-thread-simplify
14314 @vindex gnus-score-thread-simplify
14315 If this variable is non-@code{nil}, article subjects will be simplified
14316 for subject scoring purposes in the same manner as with
14317 threading---according to the current value of
14318 gnus-simplify-subject-functions.  If the scoring entry uses
14319 @code{substring} or @code{exact} matching, the match will also be
14320 simplified in this manner.
14321
14322 @end table
14323
14324
14325 @node Score File Format
14326 @section Score File Format
14327 @cindex score file format
14328
14329 A score file is an @code{emacs-lisp} file that normally contains just a
14330 single form.  Casual users are not expected to edit these files;
14331 everything can be changed from the summary buffer.
14332
14333 Anyway, if you'd like to dig into it yourself, here's an example:
14334
14335 @lisp
14336 (("from"
14337   ("Lars Ingebrigtsen" -10000)
14338   ("Per Abrahamsen")
14339   ("larsi\\|lmi" -50000 nil R))
14340  ("subject"
14341   ("Ding is Badd" nil 728373))
14342  ("xref"
14343   ("alt.politics" -1000 728372 s))
14344  ("lines"
14345   (2 -100 nil <))
14346  (mark 0)
14347  (expunge -1000)
14348  (mark-and-expunge -10)
14349  (read-only nil)
14350  (orphan -10)
14351  (adapt t)
14352  (files "/hom/larsi/News/gnu.SCORE")
14353  (exclude-files "all.SCORE")
14354  (local (gnus-newsgroup-auto-expire t)
14355         (gnus-summary-make-false-root empty))
14356  (eval (ding)))
14357 @end lisp
14358
14359 This example demonstrates most score file elements.  For a different
14360 approach, see @pxref{Advanced Scoring}.
14361
14362 Even though this looks much like lisp code, nothing here is actually
14363 @code{eval}ed.  The lisp reader is used to read this form, though, so it
14364 has to be valid syntactically, if not semantically.
14365
14366 Six keys are supported by this alist:
14367
14368 @table @code
14369
14370 @item STRING
14371 If the key is a string, it is the name of the header to perform the
14372 match on.  Scoring can only be performed on these eight headers:
14373 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
14374 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
14375 these headers, there are three strings to tell Gnus to fetch the entire
14376 article and do the match on larger parts of the article: @code{Body}
14377 will perform the match on the body of the article, @code{Head} will
14378 perform the match on the head of the article, and @code{All} will
14379 perform the match on the entire article.  Note that using any of these
14380 last three keys will slow down group entry @emph{considerably}.  The
14381 final ``header'' you can score on is @code{Followup}.  These score
14382 entries will result in new score entries being added for all follow-ups
14383 to articles that matches these score entries.
14384
14385 Following this key is a arbitrary number of score entries, where each
14386 score entry has one to four elements.
14387 @enumerate
14388
14389 @item
14390 The first element is the @dfn{match element}.  On most headers this will
14391 be a string, but on the Lines and Chars headers, this must be an
14392 integer.
14393
14394 @item
14395 If the second element is present, it should be a number---the @dfn{score
14396 element}.  This number should be an integer in the neginf to posinf
14397 interval.  This number is added to the score of the article if the match
14398 is successful.  If this element is not present, the
14399 @code{gnus-score-interactive-default-score} number will be used
14400 instead.  This is 1000 by default.
14401
14402 @item
14403 If the third element is present, it should be a number---the @dfn{date
14404 element}.  This date says when the last time this score entry matched,
14405 which provides a mechanism for expiring the score entries.  It this
14406 element is not present, the score entry is permanent.  The date is
14407 represented by the number of days since December 31, 1 BCE.
14408
14409 @item
14410 If the fourth element is present, it should be a symbol---the @dfn{type
14411 element}.  This element specifies what function should be used to see
14412 whether this score entry matches the article.  What match types that can
14413 be used depends on what header you wish to perform the match on.
14414 @table @dfn
14415
14416 @item From, Subject, References, Xref, Message-ID
14417 For most header types, there are the @code{r} and @code{R} (regexp), as
14418 well as @code{s} and @code{S} (substring) types, and @code{e} and
14419 @code{E} (exact match), and @code{w} (word match) types.  If this
14420 element is not present, Gnus will assume that substring matching should
14421 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
14422 that the matches will be done in a case-sensitive manner.  All these
14423 one-letter types are really just abbreviations for the @code{regexp},
14424 @code{string}, @code{exact}, and @code{word} types, which you can use
14425 instead, if you feel like.
14426
14427 @item Lines, Chars
14428 These two headers use different match types: @code{<}, @code{>},
14429 @code{=}, @code{>=} and @code{<=}.
14430
14431 These predicates are true if
14432
14433 @example
14434 (PREDICATE HEADER MATCH)
14435 @end example
14436
14437 evaluates to non-@code{nil}.  For instance, the advanced match
14438 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
14439 following form:
14440
14441 @lisp
14442 (< header-value 4)
14443 @end lisp
14444
14445 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
14446 the match, we get the score added if the article has less than 4 lines.
14447 (It's easy to get confused and think it's the other way around.  But
14448 it's not.  I think.)
14449
14450 When matching on @code{Lines}, be careful because some backends (like
14451 @code{nndir}) do not generate @code{Lines} header, so every article ends
14452 up being marked as having 0 lines.  This can lead to strange results if
14453 you happen to lower score of the articles with few lines.
14454
14455 @item Date
14456 For the Date header we have three kinda silly match types:
14457 @code{before}, @code{at} and @code{after}.  I can't really imagine this
14458 ever being useful, but, like, it would feel kinda silly not to provide
14459 this function.  Just in case.  You never know.  Better safe than sorry.
14460 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
14461 sex on a first date.  (I have been told that at least one person, and I
14462 quote, ``found this function indispensable'', however.)
14463
14464 @cindex ISO8601
14465 @cindex date
14466 A more useful match type is @code{regexp}.  With it, you can match the
14467 date string using a regular expression.  The date is normalized to
14468 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
14469 you want to match all articles that have been posted on April 1st in
14470 every year, you could use @samp{....0401.........} as a match string,
14471 for instance.  (Note that the date is kept in its original time zone, so
14472 this will match articles that were posted when it was April 1st where
14473 the article was posted from.  Time zones are such wholesome fun for the
14474 whole family, eh?)
14475
14476 @item Head, Body, All
14477 These three match keys use the same match types as the @code{From} (etc)
14478 header uses.
14479
14480 @item Followup
14481 This match key is somewhat special, in that it will match the
14482 @code{From} header, and affect the score of not only the matching
14483 articles, but also all followups to the matching articles.  This allows
14484 you e.g. increase the score of followups to your own articles, or
14485 decrease the score of followups to the articles of some known
14486 trouble-maker.  Uses the same match types as the @code{From} header
14487 uses.  (Using this match key will lead to creation of @file{ADAPT}
14488 files.)
14489
14490 @item Thread
14491 This match key works along the same lines as the @code{Followup} match
14492 key.  If you say that you want to score on a (sub-)thread started by an
14493 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
14494 match.  This will add a new @samp{thread} match for each article that
14495 has @var{x} in its @code{References} header.  (These new @samp{thread}
14496 matches will use the @code{Message-ID}s of these matching articles.)
14497 This will ensure that you can raise/lower the score of an entire thread,
14498 even though some articles in the thread may not have complete
14499 @code{References} headers.  Note that using this may lead to
14500 undeterministic scores of the articles in the thread.  (Using this match
14501 key will lead to creation of @file{ADAPT} files.)
14502 @end table
14503 @end enumerate
14504
14505 @cindex Score File Atoms
14506 @item mark
14507 The value of this entry should be a number.  Any articles with a score
14508 lower than this number will be marked as read.
14509
14510 @item expunge
14511 The value of this entry should be a number.  Any articles with a score
14512 lower than this number will be removed from the summary buffer.
14513
14514 @item mark-and-expunge
14515 The value of this entry should be a number.  Any articles with a score
14516 lower than this number will be marked as read and removed from the
14517 summary buffer.
14518
14519 @item thread-mark-and-expunge
14520 The value of this entry should be a number.  All articles that belong to
14521 a thread that has a total score below this number will be marked as read
14522 and removed from the summary buffer.  @code{gnus-thread-score-function}
14523 says how to compute the total score for a thread.
14524
14525 @item files
14526 The value of this entry should be any number of file names.  These files
14527 are assumed to be score files as well, and will be loaded the same way
14528 this one was.
14529
14530 @item exclude-files
14531 The clue of this entry should be any number of files.  These files will
14532 not be loaded, even though they would normally be so, for some reason or
14533 other.
14534
14535 @item eval
14536 The value of this entry will be @code{eval}el.  This element will be
14537 ignored when handling global score files.
14538
14539 @item read-only
14540 Read-only score files will not be updated or saved.  Global score files
14541 should feature this atom (@pxref{Global Score Files}).  (Note:
14542 @dfn{Global} here really means @dfn{global}; not your personal
14543 apply-to-all-groups score files.)
14544
14545 @item orphan
14546 The value of this entry should be a number.  Articles that do not have
14547 parents will get this number added to their scores.  Imagine you follow
14548 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
14549 will only follow a few of the threads, also want to see any new threads.
14550
14551 You can do this with the following two score file entries:
14552
14553 @example
14554         (orphan -500)
14555         (mark-and-expunge -100)
14556 @end example
14557
14558 When you enter the group the first time, you will only see the new
14559 threads.  You then raise the score of the threads that you find
14560 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
14561 rest.  Next time you enter the group, you will see new articles in the
14562 interesting threads, plus any new threads.
14563
14564 I.e.---the orphan score atom is for high-volume groups where there
14565 exist a few interesting threads which can't be found automatically by
14566 ordinary scoring rules.
14567
14568 @item adapt
14569 This entry controls the adaptive scoring.  If it is @code{t}, the
14570 default adaptive scoring rules will be used.  If it is @code{ignore}, no
14571 adaptive scoring will be performed on this group.  If it is a list, this
14572 list will be used as the adaptive scoring rules.  If it isn't present,
14573 or is something other than @code{t} or @code{ignore}, the default
14574 adaptive scoring rules will be used.  If you want to use adaptive
14575 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
14576 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
14577 not want adaptive scoring.  If you only want adaptive scoring in a few
14578 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
14579 insert @code{(adapt t)} in the score files of the groups where you want
14580 it.
14581
14582 @item adapt-file
14583 All adaptive score entries will go to the file named by this entry.  It
14584 will also be applied when entering the group.  This atom might be handy
14585 if you want to adapt on several groups at once, using the same adaptive
14586 file for a number of groups.
14587
14588 @item local
14589 @cindex local variables
14590 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
14591 Each @var{var} will be made buffer-local to the current summary buffer,
14592 and set to the value specified.  This is a convenient, if somewhat
14593 strange, way of setting variables in some groups if you don't like hooks
14594 much.  Note that the @var{value} won't be evaluated.
14595 @end table
14596
14597
14598 @node Score File Editing
14599 @section Score File Editing
14600
14601 You normally enter all scoring commands from the summary buffer, but you
14602 might feel the urge to edit them by hand as well, so we've supplied you
14603 with a mode for that.
14604
14605 It's simply a slightly customized @code{emacs-lisp} mode, with these
14606 additional commands:
14607
14608 @table @kbd
14609
14610 @item C-c C-c
14611 @kindex C-c C-c (Score)
14612 @findex gnus-score-edit-done
14613 Save the changes you have made and return to the summary buffer
14614 (@code{gnus-score-edit-done}).
14615
14616 @item C-c C-d
14617 @kindex C-c C-d (Score)
14618 @findex gnus-score-edit-insert-date
14619 Insert the current date in numerical format
14620 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
14621 you were wondering.
14622
14623 @item C-c C-p
14624 @kindex C-c C-p (Score)
14625 @findex gnus-score-pretty-print
14626 The adaptive score files are saved in an unformatted fashion.  If you
14627 intend to read one of these files, you want to @dfn{pretty print} it
14628 first.  This command (@code{gnus-score-pretty-print}) does that for
14629 you.
14630
14631 @end table
14632
14633 Type @kbd{M-x gnus-score-mode} to use this mode.
14634
14635 @vindex gnus-score-mode-hook
14636 @code{gnus-score-menu-hook} is run in score mode buffers.
14637
14638 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
14639 e} to begin editing score files.
14640
14641
14642 @node Adaptive Scoring
14643 @section Adaptive Scoring
14644 @cindex adaptive scoring
14645
14646 If all this scoring is getting you down, Gnus has a way of making it all
14647 happen automatically---as if by magic.  Or rather, as if by artificial
14648 stupidity, to be precise.
14649
14650 @vindex gnus-use-adaptive-scoring
14651 When you read an article, or mark an article as read, or kill an
14652 article, you leave marks behind.  On exit from the group, Gnus can sniff
14653 these marks and add score elements depending on what marks it finds.
14654 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
14655 @code{t} or @code{(line)}.  If you want score adaptively on separate
14656 words appearing in the subjects, you should set this variable to
14657 @code{(word)}.  If you want to use both adaptive methods, set this
14658 variable to @code{(word line)}.
14659
14660 @vindex gnus-default-adaptive-score-alist
14661 To give you complete control over the scoring process, you can customize
14662 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
14663 might look something like this:
14664
14665 @lisp
14666 (defvar gnus-default-adaptive-score-alist
14667   '((gnus-unread-mark)
14668     (gnus-ticked-mark (from 4))
14669     (gnus-dormant-mark (from 5))
14670     (gnus-del-mark (from -4) (subject -1))
14671     (gnus-read-mark (from 4) (subject 2))
14672     (gnus-expirable-mark (from -1) (subject -1))
14673     (gnus-killed-mark (from -1) (subject -3))
14674     (gnus-kill-file-mark)
14675     (gnus-ancient-mark)
14676     (gnus-low-score-mark)
14677     (gnus-catchup-mark (from -1) (subject -1))))
14678 @end lisp
14679
14680 As you see, each element in this alist has a mark as a key (either a
14681 variable name or a ``real'' mark---a character).  Following this key is
14682 a arbitrary number of header/score pairs.  If there are no header/score
14683 pairs following the key, no adaptive scoring will be done on articles
14684 that have that key as the article mark.  For instance, articles with
14685 @code{gnus-unread-mark} in the example above will not get adaptive score
14686 entries.
14687
14688 Each article can have only one mark, so just a single of these rules
14689 will be applied to each article.
14690
14691 To take @code{gnus-del-mark} as an example---this alist says that all
14692 articles that have that mark (i.e., are marked with @samp{D}) will have a
14693 score entry added to lower based on the @code{From} header by -4, and
14694 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
14695
14696 If you have marked 10 articles with the same subject with
14697 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
14698 That means that that subject will get a score of ten times -1, which
14699 should be, unless I'm much mistaken, -10.
14700
14701 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
14702 the read articles will be marked with the @samp{E} mark.  This'll
14703 probably make adaptive scoring slightly impossible, so auto-expiring and
14704 adaptive scoring doesn't really mix very well.
14705
14706 The headers you can score on are @code{from}, @code{subject},
14707 @code{message-id}, @code{references}, @code{xref}, @code{lines},
14708 @code{chars} and @code{date}.  In addition, you can score on
14709 @code{followup}, which will create an adaptive score entry that matches
14710 on the @code{References} header using the @code{Message-ID} of the
14711 current article, thereby matching the following thread.
14712
14713 You can also score on @code{thread}, which will try to score all
14714 articles that appear in a thread.  @code{thread} matches uses a
14715 @code{Message-ID} to match on the @code{References} header of the
14716 article.  If the match is made, the @code{Message-ID} of the article is
14717 added to the @code{thread} rule.  (Think about it.  I'd recommend two
14718 aspirins afterwards.)
14719
14720 If you use this scheme, you should set the score file atom @code{mark}
14721 to something small---like -300, perhaps, to avoid having small random
14722 changes result in articles getting marked as read.
14723
14724 After using adaptive scoring for a week or so, Gnus should start to
14725 become properly trained and enhance the authors you like best, and kill
14726 the authors you like least, without you having to say so explicitly.
14727
14728 You can control what groups the adaptive scoring is to be performed on
14729 by using the score files (@pxref{Score File Format}).  This will also
14730 let you use different rules in different groups.
14731
14732 @vindex gnus-adaptive-file-suffix
14733 The adaptive score entries will be put into a file where the name is the
14734 group name with @code{gnus-adaptive-file-suffix} appended.  The default
14735 is @samp{ADAPT}.
14736
14737 @vindex gnus-score-exact-adapt-limit
14738 When doing adaptive scoring, substring or fuzzy matching would probably
14739 give you the best results in most cases.  However, if the header one
14740 matches is short, the possibility for false positives is great, so if
14741 the length of the match is less than
14742 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
14743 this variable is @code{nil}, exact matching will always be used to avoid
14744 this problem.
14745
14746 @vindex gnus-default-adaptive-word-score-alist
14747 As mentioned above, you can adapt either on individual words or entire
14748 headers.  If you adapt on words, the
14749 @code{gnus-default-adaptive-word-score-alist} variable says what score
14750 each instance of a word should add given a mark.
14751
14752 @lisp
14753 (setq gnus-default-adaptive-word-score-alist
14754       `((,gnus-read-mark . 30)
14755         (,gnus-catchup-mark . -10)
14756         (,gnus-killed-mark . -20)
14757         (,gnus-del-mark . -15)))
14758 @end lisp
14759
14760 This is the default value.  If you have adaption on words enabled, every
14761 word that appears in subjects of articles marked with
14762 @code{gnus-read-mark} will result in a score rule that increase the
14763 score with 30 points.
14764
14765 @vindex gnus-default-ignored-adaptive-words
14766 @vindex gnus-ignored-adaptive-words
14767 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
14768 will be ignored.  If you wish to add more words to be ignored, use the
14769 @code{gnus-ignored-adaptive-words} list instead.
14770
14771 @vindex gnus-adaptive-word-syntax-table
14772 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
14773 syntax table in effect.  It is similar to the standard syntax table, but
14774 it considers numbers to be non-word-constituent characters.
14775
14776 @vindex gnus-adaptive-word-minimum
14777 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
14778 word scoring process will never bring down the score of an article to
14779 below this number.  The default is @code{nil}.
14780
14781 @vindex gnus-adaptive-word-no-group-words
14782 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
14783 won't adaptively word score any of the words in the group name.  Useful
14784 for groups like @samp{comp.editors.emacs}, where most of the subject
14785 lines contain the word @samp{emacs}.
14786
14787 After using this scheme for a while, it might be nice to write a
14788 @code{gnus-psychoanalyze-user} command to go through the rules and see
14789 what words you like and what words you don't like.  Or perhaps not.
14790
14791 Note that the adaptive word scoring thing is highly experimental and is
14792 likely to change in the future.  Initial impressions seem to indicate
14793 that it's totally useless as it stands.  Some more work (involving more
14794 rigorous statistical methods) will have to be done to make this useful.
14795
14796
14797 @node Home Score File
14798 @section Home Score File
14799
14800 The score file where new score file entries will go is called the
14801 @dfn{home score file}.  This is normally (and by default) the score file
14802 for the group itself.  For instance, the home score file for
14803 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
14804
14805 However, this may not be what you want.  It is often convenient to share
14806 a common home score file among many groups---all @samp{emacs} groups
14807 could perhaps use the same home score file.
14808
14809 @vindex gnus-home-score-file
14810 The variable that controls this is @code{gnus-home-score-file}.  It can
14811 be:
14812
14813 @enumerate
14814 @item
14815 A string.  Then this file will be used as the home score file for all
14816 groups.
14817
14818 @item
14819 A function. The result of this function will be used as the home score
14820 file.  The function will be called with the name of the group as the
14821 parameter.
14822
14823 @item
14824 A list.  The elements in this list can be:
14825
14826 @enumerate
14827 @item
14828 @code{(@var{regexp} @var{file-name})}.  If the @var{regexp} matches the
14829 group name, the @var{file-name} will will be used as the home score file.
14830
14831 @item
14832 A function. If the function returns non-nil, the result will be used as
14833 the home score file.
14834
14835 @item
14836 A string.  Use the string as the home score file.
14837 @end enumerate
14838
14839 The list will be traversed from the beginning towards the end looking
14840 for matches.
14841
14842 @end enumerate
14843
14844 So, if you want to use just a single score file, you could say:
14845
14846 @lisp
14847 (setq gnus-home-score-file
14848       "my-total-score-file.SCORE")
14849 @end lisp
14850
14851 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
14852 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
14853
14854 @findex gnus-hierarchial-home-score-file
14855 @lisp
14856 (setq gnus-home-score-file
14857       'gnus-hierarchial-home-score-file)
14858 @end lisp
14859
14860 This is a ready-made function provided for your convenience.
14861 Other functions include
14862
14863 @table @code
14864 @item gnus-current-home-score-file
14865 @findex gnus-current-home-score-file
14866 Return the ``current'' regular score file.  This will make scoring
14867 commands add entry to the ``innermost'' matching score file.
14868
14869 @end table
14870
14871 If you want to have one score file for the @samp{emacs} groups and
14872 another for the @samp{comp} groups, while letting all other groups use
14873 their own home score files:
14874
14875 @lisp
14876 (setq gnus-home-score-file
14877       ;; All groups that match the regexp "\\.emacs"
14878       '(("\\.emacs" "emacs.SCORE")
14879         ;; All the comp groups in one score file
14880         ("^comp" "comp.SCORE")))
14881 @end lisp
14882
14883 @vindex gnus-home-adapt-file
14884 @code{gnus-home-adapt-file} works exactly the same way as
14885 @code{gnus-home-score-file}, but says what the home adaptive score file
14886 is instead.  All new adaptive file entries will go into the file
14887 specified by this variable, and the same syntax is allowed.
14888
14889 In addition to using @code{gnus-home-score-file} and
14890 @code{gnus-home-adapt-file}, you can also use group parameters
14891 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
14892 Parameters}) to achieve much the same.  Group and topic parameters take
14893 precedence over this variable.
14894
14895
14896 @node Followups To Yourself
14897 @section Followups To Yourself
14898
14899 Gnus offers two commands for picking out the @code{Message-ID} header in
14900 the current buffer.  Gnus will then add a score rule that scores using
14901 this @code{Message-ID} on the @code{References} header of other
14902 articles.  This will, in effect, increase the score of all articles that
14903 respond to the article in the current buffer.  Quite useful if you want
14904 to easily note when people answer what you've said.
14905
14906 @table @code
14907
14908 @item gnus-score-followup-article
14909 @findex gnus-score-followup-article
14910 This will add a score to articles that directly follow up your own
14911 article.
14912
14913 @item gnus-score-followup-thread
14914 @findex gnus-score-followup-thread
14915 This will add a score to all articles that appear in a thread ``below''
14916 your own article.
14917 @end table
14918
14919 @vindex message-sent-hook
14920 These two functions are both primarily meant to be used in hooks like
14921 @code{message-sent-hook}.
14922
14923 If you look closely at your own @code{Message-ID}, you'll notice that
14924 the first two or three characters are always the same.  Here's two of
14925 mine:
14926
14927 @example
14928 <x6u3u47icf.fsf@@eyesore.no>
14929 <x6sp9o7ibw.fsf@@eyesore.no>
14930 @end example
14931
14932 So ``my'' ident on this machine is @samp{x6}.  This can be
14933 exploited---the following rule will raise the score on all followups to
14934 myself:
14935
14936 @lisp
14937 ("references"
14938  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
14939   1000 nil r))
14940 @end lisp
14941
14942 Whether it's the first two or first three characters that are ``yours''
14943 is system-dependent.
14944
14945
14946 @node Scoring Tips
14947 @section Scoring Tips
14948 @cindex scoring tips
14949
14950 @table @dfn
14951
14952 @item Crossposts
14953 @cindex crossposts
14954 @cindex scoring crossposts
14955 If you want to lower the score of crossposts, the line to match on is
14956 the @code{Xref} header.
14957 @lisp
14958 ("xref" (" talk.politics.misc:" -1000))
14959 @end lisp
14960
14961 @item Multiple crossposts
14962 If you want to lower the score of articles that have been crossposted to
14963 more than, say, 3 groups:
14964 @lisp
14965 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
14966 @end lisp
14967
14968 @item Matching on the body
14969 This is generally not a very good idea---it takes a very long time.
14970 Gnus actually has to fetch each individual article from the server.  But
14971 you might want to anyway, I guess.  Even though there are three match
14972 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
14973 and stick with it in each score file.  If you use any two, each article
14974 will be fetched @emph{twice}.  If you want to match a bit on the
14975 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
14976 the matches.
14977
14978 @item Marking as read
14979 You will probably want to mark articles that have scores below a certain
14980 number as read.  This is most easily achieved by putting the following
14981 in your @file{all.SCORE} file:
14982 @lisp
14983 ((mark -100))
14984 @end lisp
14985 You may also consider doing something similar with @code{expunge}.
14986
14987 @item Negated character classes
14988 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
14989 That will match newlines, which might lead to, well, The Unknown.  Say
14990 @code{[^abcd\n]*} instead.
14991 @end table
14992
14993
14994 @node Reverse Scoring
14995 @section Reverse Scoring
14996 @cindex reverse scoring
14997
14998 If you want to keep just articles that have @samp{Sex with Emacs} in the
14999 subject header, and expunge all other articles, you could put something
15000 like this in your score file:
15001
15002 @lisp
15003 (("subject"
15004   ("Sex with Emacs" 2))
15005  (mark 1)
15006  (expunge 1))
15007 @end lisp
15008
15009 So, you raise all articles that match @samp{Sex with Emacs} and mark the
15010 rest as read, and expunge them to boot.
15011
15012
15013 @node Global Score Files
15014 @section Global Score Files
15015 @cindex global score files
15016
15017 Sure, other newsreaders have ``global kill files''.  These are usually
15018 nothing more than a single kill file that applies to all groups, stored
15019 in the user's home directory.  Bah!  Puny, weak newsreaders!
15020
15021 What I'm talking about here are Global Score Files.  Score files from
15022 all over the world, from users everywhere, uniting all nations in one
15023 big, happy score file union!  Ange-score!  New and untested!
15024
15025 @vindex gnus-global-score-files
15026 All you have to do to use other people's score files is to set the
15027 @code{gnus-global-score-files} variable.  One entry for each score file,
15028 or each score file directory.  Gnus will decide by itself what score
15029 files are applicable to which group.
15030
15031 Say you want to use the score file
15032 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
15033 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
15034
15035 @lisp
15036 (setq gnus-global-score-files
15037       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
15038         "/ftp@@ftp.some-where:/pub/score/"))
15039 @end lisp
15040
15041 @findex gnus-score-search-global-directories
15042 Simple, eh?  Directory names must end with a @samp{/}.  These
15043 directories are typically scanned only once during each Gnus session.
15044 If you feel the need to manually re-scan the remote directories, you can
15045 use the @code{gnus-score-search-global-directories} command.
15046
15047 Note that, at present, using this option will slow down group entry
15048 somewhat.  (That is---a lot.)
15049
15050 If you want to start maintaining score files for other people to use,
15051 just put your score file up for anonymous ftp and announce it to the
15052 world.  Become a retro-moderator!  Participate in the retro-moderator
15053 wars sure to ensue, where retro-moderators battle it out for the
15054 sympathy of the people, luring them to use their score files on false
15055 premises!  Yay!  The net is saved!
15056
15057 Here are some tips for the would-be retro-moderator, off the top of my
15058 head:
15059
15060 @itemize @bullet
15061
15062 @item
15063 Articles heavily crossposted are probably junk.
15064 @item
15065 To lower a single inappropriate article, lower by @code{Message-ID}.
15066 @item
15067 Particularly brilliant authors can be raised on a permanent basis.
15068 @item
15069 Authors that repeatedly post off-charter for the group can safely be
15070 lowered out of existence.
15071 @item
15072 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
15073 articles completely.
15074
15075 @item
15076 Use expiring score entries to keep the size of the file down.  You
15077 should probably have a long expiry period, though, as some sites keep
15078 old articles for a long time.
15079 @end itemize
15080
15081 ... I wonder whether other newsreaders will support global score files
15082 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
15083 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
15084 holding our breath yet?
15085
15086
15087 @node Kill Files
15088 @section Kill Files
15089 @cindex kill files
15090
15091 Gnus still supports those pesky old kill files.  In fact, the kill file
15092 entries can now be expiring, which is something I wrote before Daniel
15093 Quinlan thought of doing score files, so I've left the code in there.
15094
15095 In short, kill processing is a lot slower (and I do mean @emph{a lot})
15096 than score processing, so it might be a good idea to rewrite your kill
15097 files into score files.
15098
15099 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
15100 forms into this file, which means that you can use kill files as some
15101 sort of primitive hook function to be run on group entry, even though
15102 that isn't a very good idea.
15103
15104 Normal kill files look like this:
15105
15106 @lisp
15107 (gnus-kill "From" "Lars Ingebrigtsen")
15108 (gnus-kill "Subject" "ding")
15109 (gnus-expunge "X")
15110 @end lisp
15111
15112 This will mark every article written by me as read, and remove the
15113 marked articles from the summary buffer.  Very useful, you'll agree.
15114
15115 Other programs use a totally different kill file syntax.  If Gnus
15116 encounters what looks like a @code{rn} kill file, it will take a stab at
15117 interpreting it.
15118
15119 Two summary functions for editing a GNUS kill file:
15120
15121 @table @kbd
15122
15123 @item M-k
15124 @kindex M-k (Summary)
15125 @findex gnus-summary-edit-local-kill
15126 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
15127
15128 @item M-K
15129 @kindex M-K (Summary)
15130 @findex gnus-summary-edit-global-kill
15131 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
15132 @end table
15133
15134 Two group mode functions for editing the kill files:
15135
15136 @table @kbd
15137
15138 @item M-k
15139 @kindex M-k (Group)
15140 @findex gnus-group-edit-local-kill
15141 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
15142
15143 @item M-K
15144 @kindex M-K (Group)
15145 @findex gnus-group-edit-global-kill
15146 Edit the general kill file (@code{gnus-group-edit-global-kill}).
15147 @end table
15148
15149 Kill file variables:
15150
15151 @table @code
15152 @item gnus-kill-file-name
15153 @vindex gnus-kill-file-name
15154 A kill file for the group @samp{soc.motss} is normally called
15155 @file{soc.motss.KILL}.  The suffix appended to the group name to get
15156 this file name is detailed by the @code{gnus-kill-file-name} variable.
15157 The ``global'' kill file (not in the score file sense of ``global'', of
15158 course) is just called @file{KILL}.
15159
15160 @vindex gnus-kill-save-kill-file
15161 @item gnus-kill-save-kill-file
15162 If this variable is non-@code{nil}, Gnus will save the
15163 kill file after processing, which is necessary if you use expiring
15164 kills.
15165
15166 @item gnus-apply-kill-hook
15167 @vindex gnus-apply-kill-hook
15168 @findex gnus-apply-kill-file-unless-scored
15169 @findex gnus-apply-kill-file
15170 A hook called to apply kill files to a group.  It is
15171 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
15172 kill file if you have a score file for the same group, you can set this
15173 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
15174 kill files to be processed, you should set this variable to @code{nil}.
15175
15176 @item gnus-kill-file-mode-hook
15177 @vindex gnus-kill-file-mode-hook
15178 A hook called in kill-file mode buffers.
15179
15180 @end table
15181
15182
15183 @node Converting Kill Files
15184 @section Converting Kill Files
15185 @cindex kill files
15186 @cindex converting kill files
15187
15188 If you have loads of old kill files, you may want to convert them into
15189 score files.  If they are ``regular'', you can use
15190 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
15191 by hand.
15192
15193 The kill to score conversion package isn't included in Gnus by default.
15194 You can fetch it from
15195 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
15196
15197 If your old kill files are very complex---if they contain more
15198 non-@code{gnus-kill} forms than not, you'll have to convert them by
15199 hand.  Or just let them be as they are.  Gnus will still use them as
15200 before.
15201
15202
15203 @node GroupLens
15204 @section GroupLens
15205 @cindex GroupLens
15206
15207 GroupLens is a collaborative filtering system that helps you work
15208 together with other people to find the quality news articles out of the
15209 huge volume of news articles generated every day.
15210
15211 To accomplish this the GroupLens system combines your opinions about
15212 articles you have already read with the opinions of others who have done
15213 likewise and gives you a personalized prediction for each unread news
15214 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
15215 rate articles, and finds other people that rate articles the same way.
15216 Once it has found some people you agree with it tells you, in the form
15217 of a prediction, what they thought of the article.  You can use this
15218 prediction to help you decide whether or not you want to read the
15219 article.
15220
15221 @menu
15222 * Using GroupLens::          How to make Gnus use GroupLens.
15223 * Rating Articles::          Letting GroupLens know how you rate articles.
15224 * Displaying Predictions::   Displaying predictions given by GroupLens.
15225 * GroupLens Variables::      Customizing GroupLens.
15226 @end menu
15227
15228
15229 @node Using GroupLens
15230 @subsection Using GroupLens
15231
15232 To use GroupLens you must register a pseudonym with your local Better
15233 Bit Bureau (BBB).
15234 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
15235 better bit in town at the moment.
15236
15237 Once you have registered you'll need to set a couple of variables.
15238
15239 @table @code
15240
15241 @item gnus-use-grouplens
15242 @vindex gnus-use-grouplens
15243 Setting this variable to a non-@code{nil} value will make Gnus hook into
15244 all the relevant GroupLens functions.
15245
15246 @item grouplens-pseudonym
15247 @vindex grouplens-pseudonym
15248 This variable should be set to the pseudonym you got when registering
15249 with the Better Bit Bureau.
15250
15251 @item grouplens-newsgroups
15252 @vindex grouplens-newsgroups
15253 A list of groups that you want to get GroupLens predictions for.
15254
15255 @end table
15256
15257 That's the minimum of what you need to get up and running with GroupLens.
15258 Once you've registered, GroupLens will start giving you scores for
15259 articles based on the average of what other people think.  But, to get
15260 the real benefit of GroupLens you need to start rating articles
15261 yourself.  Then the scores GroupLens gives you will be personalized for
15262 you, based on how the people you usually agree with have already rated.
15263
15264
15265 @node Rating Articles
15266 @subsection Rating Articles
15267
15268 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
15269 Where 1 means something like this article is a waste of bandwidth and 5
15270 means that the article was really good.  The basic question to ask
15271 yourself is, "on a scale from 1 to 5 would I like to see more articles
15272 like this one?"
15273
15274 There are four ways to enter a rating for an article in GroupLens.
15275
15276 @table @kbd
15277
15278 @item r
15279 @kindex r (GroupLens)
15280 @findex bbb-summary-rate-article
15281 This function will prompt you for a rating on a scale of one to five.
15282
15283 @item k
15284 @kindex k (GroupLens)
15285 @findex grouplens-score-thread
15286 This function will prompt you for a rating, and rate all the articles in
15287 the thread.  This is really useful for some of those long running giant
15288 threads in rec.humor.
15289
15290 @end table
15291
15292 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
15293 the score of the article you're reading.
15294
15295 @table @kbd
15296
15297 @item 1-5 n
15298 @kindex n (GroupLens)
15299 @findex grouplens-next-unread-article
15300 Rate the article and go to the next unread article.
15301
15302 @item 1-5 ,
15303 @kindex , (GroupLens)
15304 @findex grouplens-best-unread-article
15305 Rate the article and go to the next unread article with the highest score.
15306
15307 @end table
15308
15309 If you want to give the current article a score of 4 and then go to the
15310 next article, just type @kbd{4 n}.
15311
15312
15313 @node Displaying Predictions
15314 @subsection Displaying Predictions
15315
15316 GroupLens makes a prediction for you about how much you will like a
15317 news article.  The predictions from GroupLens are on a scale from 1 to
15318 5, where 1 is the worst and 5 is the best.  You can use the predictions
15319 from GroupLens in one of three ways controlled by the variable
15320 @code{gnus-grouplens-override-scoring}.
15321
15322 @vindex gnus-grouplens-override-scoring
15323 There are three ways to display predictions in grouplens.  You may
15324 choose to have the GroupLens scores contribute to, or override the
15325 regular gnus scoring mechanism. override is the default; however, some
15326 people prefer to see the Gnus scores plus the grouplens scores.  To get
15327 the separate scoring behavior you need to set
15328 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
15329 GroupLens predictions combined with the grouplens scores set it to
15330 @code{'override} and to combine the scores set
15331 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
15332 the combine option you will also want to set the values for
15333 @code{grouplens-prediction-offset} and
15334 @code{grouplens-score-scale-factor}.
15335
15336 @vindex grouplens-prediction-display
15337 In either case, GroupLens gives you a few choices for how you would like
15338 to see your predictions displayed.  The display of predictions is
15339 controlled by the @code{grouplens-prediction-display} variable.
15340
15341 The following are valid values for that variable.
15342
15343 @table @code
15344 @item prediction-spot
15345 The higher the prediction, the further to the right an @samp{*} is
15346 displayed.
15347
15348 @item confidence-interval
15349 A numeric confidence interval.
15350
15351 @item prediction-bar
15352 The higher the prediction, the longer the bar.
15353
15354 @item confidence-bar
15355 Numerical confidence.
15356
15357 @item confidence-spot
15358 The spot gets bigger with more confidence.
15359
15360 @item prediction-num
15361 Plain-old numeric value.
15362
15363 @item confidence-plus-minus
15364 Prediction +/- confidence.
15365
15366 @end table
15367
15368
15369 @node GroupLens Variables
15370 @subsection GroupLens Variables
15371
15372 @table @code
15373
15374 @item gnus-summary-grouplens-line-format
15375 The summary line format used in GroupLens-enhanced summary buffers.  It
15376 accepts the same specs as the normal summary line format (@pxref{Summary
15377 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
15378 %s\n}.
15379
15380 @item grouplens-bbb-host
15381 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
15382 default.
15383
15384 @item grouplens-bbb-port
15385 Port of the host running the bbbd server.  The default is 9000.
15386
15387 @item grouplens-score-offset
15388 Offset the prediction by this value.  In other words, subtract the
15389 prediction value by this number to arrive at the effective score.  The
15390 default is 0.
15391
15392 @item grouplens-score-scale-factor
15393 This variable allows the user to magnify the effect of GroupLens scores.
15394 The scale factor is applied after the offset.  The default is 1.
15395
15396 @end table
15397
15398
15399 @node Advanced Scoring
15400 @section Advanced Scoring
15401
15402 Scoring on Subjects and From headers is nice enough, but what if you're
15403 really interested in what a person has to say only when she's talking
15404 about a particular subject?  Or what if you really don't want to
15405 read what person A has to say when she's following up to person B, but
15406 want to read what she says when she's following up to person C?
15407
15408 By using advanced scoring rules you may create arbitrarily complex
15409 scoring patterns.
15410
15411 @menu
15412 * Advanced Scoring Syntax::     A definition.
15413 * Advanced Scoring Examples::   What they look like.
15414 * Advanced Scoring Tips::       Getting the most out of it.
15415 @end menu
15416
15417
15418 @node Advanced Scoring Syntax
15419 @subsection Advanced Scoring Syntax
15420
15421 Ordinary scoring rules have a string as the first element in the rule.
15422 Advanced scoring rules have a list as the first element.  The second
15423 element is the score to be applied if the first element evaluated to a
15424 non-@code{nil} value.
15425
15426 These lists may consist of three logical operators, one redirection
15427 operator, and various match operators.
15428
15429 Logical operators:
15430
15431 @table @code
15432 @item &
15433 @itemx and
15434 This logical operator will evaluate each of its arguments until it finds
15435 one that evaluates to @code{false}, and then it'll stop.  If all arguments
15436 evaluate to @code{true} values, then this operator will return
15437 @code{true}.
15438
15439 @item |
15440 @itemx or
15441 This logical operator will evaluate each of its arguments until it finds
15442 one that evaluates to @code{true}.  If no arguments are @code{true},
15443 then this operator will return @code{false}.
15444
15445 @item !
15446 @itemx not
15447 @itemx \e-A¬\e$)A
15448 This logical operator only takes a single argument.  It returns the
15449 logical negation of the value of its argument.
15450
15451 @end table
15452
15453 There is an @dfn{indirection operator} that will make its arguments
15454 apply to the ancestors of the current article being scored.  For
15455 instance, @code{1-} will make score rules apply to the parent of the
15456 current article.  @code{2-} will make score rules apply to the
15457 grandparent of the current article.  Alternatively, you can write
15458 @code{^^}, where the number of @code{^}s (carets) says how far back into
15459 the ancestry you want to go.
15460
15461 Finally, we have the match operators.  These are the ones that do the
15462 real work.  Match operators are header name strings followed by a match
15463 and a match type.  A typical match operator looks like @samp{("from"
15464 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
15465 simple scoring, and the match types are also the same.
15466
15467
15468 @node Advanced Scoring Examples
15469 @subsection Advanced Scoring Examples
15470
15471 Let's say you want to increase the score of articles written by Lars
15472 when he's talking about Gnus:
15473
15474 @example
15475 ((&
15476   ("from" "Lars Ingebrigtsen")
15477   ("subject" "Gnus"))
15478  1000)
15479 @end example
15480
15481 Quite simple, huh?
15482
15483 When he writes long articles, he sometimes has something nice to say:
15484
15485 @example
15486 ((&
15487   ("from" "Lars Ingebrigtsen")
15488   (|
15489    ("subject" "Gnus")
15490    ("lines" 100 >)))
15491  1000)
15492 @end example
15493
15494 However, when he responds to things written by Reig Eigil Logge, you
15495 really don't want to read what he's written:
15496
15497 @example
15498 ((&
15499   ("from" "Lars Ingebrigtsen")
15500   (1- ("from" "Reig Eigir Logge")))
15501  -100000)
15502 @end example
15503
15504 Everybody that follows up Redmondo when he writes about disappearing
15505 socks should have their scores raised, but only when they talk about
15506 white socks.  However, when Lars talks about socks, it's usually not
15507 very interesting:
15508
15509 @example
15510 ((&
15511   (1-
15512    (&
15513     ("from" "redmondo@@.*no" r)
15514     ("body" "disappearing.*socks" t)))
15515   (! ("from" "Lars Ingebrigtsen"))
15516   ("body" "white.*socks"))
15517  1000)
15518 @end example
15519
15520 The possibilities are endless.
15521
15522
15523 @node Advanced Scoring Tips
15524 @subsection Advanced Scoring Tips
15525
15526 The @code{&} and @code{|} logical operators do short-circuit logic.
15527 That is, they stop processing their arguments when it's clear what the
15528 result of the operation will be.  For instance, if one of the arguments
15529 of an @code{&} evaluates to @code{false}, there's no point in evaluating
15530 the rest of the arguments.  This means that you should put slow matches
15531 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
15532 @samp{subject}) first.
15533
15534 The indirection arguments (@code{1-} and so on) will make their
15535 arguments work on previous generations of the thread.  If you say
15536 something like:
15537
15538 @example
15539 ...
15540 (1-
15541  (1-
15542   ("from" "lars")))
15543 ...
15544 @end example
15545
15546 Then that means "score on the from header of the grandparent of the
15547 current article".  An indirection is quite fast, but it's better to say:
15548
15549 @example
15550 (1-
15551  (&
15552   ("from" "Lars")
15553   ("subject" "Gnus")))
15554 @end example
15555
15556 than it is to say:
15557
15558 @example
15559 (&
15560  (1- ("from" "Lars"))
15561  (1- ("subject" "Gnus")))
15562 @end example
15563
15564
15565 @node Score Decays
15566 @section Score Decays
15567 @cindex score decays
15568 @cindex decays
15569
15570 You may find that your scores have a tendency to grow without
15571 bounds, especially if you're using adaptive scoring.  If scores get too
15572 big, they lose all meaning---they simply max out and it's difficult to
15573 use them in any sensible way.
15574
15575 @vindex gnus-decay-scores
15576 @findex gnus-decay-score
15577 @vindex gnus-decay-score-function
15578 Gnus provides a mechanism for decaying scores to help with this problem.
15579 When score files are loaded and @code{gnus-decay-scores} is
15580 non-@code{nil}, Gnus will run the score files through the decaying
15581 mechanism thereby lowering the scores of all non-permanent score rules.
15582 The decay itself if performed by the @code{gnus-decay-score-function}
15583 function, which is @code{gnus-decay-score} by default.  Here's the
15584 definition of that function:
15585
15586 @lisp
15587 (defun gnus-decay-score (score)
15588   "Decay SCORE.
15589 This is done according to `gnus-score-decay-constant'
15590 and `gnus-score-decay-scale'."
15591   (floor
15592    (- score
15593       (* (if (< score 0) 1 -1)
15594          (min (abs score)
15595               (max gnus-score-decay-constant
15596                    (* (abs score)
15597                       gnus-score-decay-scale)))))))
15598 @end lisp
15599
15600 @vindex gnus-score-decay-scale
15601 @vindex gnus-score-decay-constant
15602 @code{gnus-score-decay-constant} is 3 by default and
15603 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
15604
15605 @enumerate
15606 @item
15607 Scores between -3 and 3 will be set to 0 when this function is called.
15608
15609 @item
15610 Scores with magnitudes between 3 and 60 will be shrunk by 3.
15611
15612 @item
15613 Scores with magnitudes greater than 60 will be shrunk by 5% of the
15614 score.
15615 @end enumerate
15616
15617 If you don't like this decay function, write your own.  It is called
15618 with the score to be decayed as its only parameter, and it should return
15619 the new score, which should be an integer.
15620
15621 Gnus will try to decay scores once a day.  If you haven't run Gnus for
15622 four days, Gnus will decay the scores four times, for instance.
15623
15624
15625 @node Various
15626 @chapter Various
15627
15628 @menu
15629 * Process/Prefix::             A convention used by many treatment commands.
15630 * Interactive::                Making Gnus ask you many questions.
15631 * Symbolic Prefixes::          How to supply some Gnus functions with options.
15632 * Formatting Variables::       You can specify what buffers should look like.
15633 * Windows Configuration::      Configuring the Gnus buffer windows.
15634 * Faces and Fonts::            How to change how faces look.
15635 * Compilation::                How to speed Gnus up.
15636 * Mode Lines::                 Displaying information in the mode lines.
15637 * Highlighting and Menus::     Making buffers look all nice and cozy.
15638 * Buttons::                    Get tendonitis in ten easy steps!
15639 * Daemons::                    Gnus can do things behind your back.
15640 * NoCeM::                      How to avoid spam and other fatty foods.
15641 * Undo::                       Some actions can be undone.
15642 * Moderation::                 What to do if you're a moderator.
15643 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
15644 * Fuzzy Matching::             What's the big fuzz?
15645 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
15646 * Various Various::            Things that are really various.
15647 @end menu
15648
15649
15650 @node Process/Prefix
15651 @section Process/Prefix
15652 @cindex process/prefix convention
15653
15654 Many functions, among them functions for moving, decoding and saving
15655 articles, use what is known as the @dfn{Process/Prefix convention}.
15656
15657 This is a method for figuring out what articles the user wants the
15658 command to be performed on.
15659
15660 It goes like this:
15661
15662 If the numeric prefix is N, perform the operation on the next N
15663 articles, starting with the current one.  If the numeric prefix is
15664 negative, perform the operation on the previous N articles, starting
15665 with the current one.
15666
15667 @vindex transient-mark-mode
15668 If @code{transient-mark-mode} in non-@code{nil} and the region is
15669 active, all articles in the region will be worked upon.
15670
15671 If there is no numeric prefix, but some articles are marked with the
15672 process mark, perform the operation on the articles marked with
15673 the process mark.
15674
15675 If there is neither a numeric prefix nor any articles marked with the
15676 process mark, just perform the operation on the current article.
15677
15678 Quite simple, really, but it needs to be made clear so that surprises
15679 are avoided.
15680
15681 Commands that react to the process mark will push the current list of
15682 process marked articles onto a stack and will then clear all process
15683 marked articles.  You can restore the previous configuration with the
15684 @kbd{M P y} command (@pxref{Setting Process Marks}).
15685
15686 @vindex gnus-summary-goto-unread
15687 One thing that seems to shock & horrify lots of people is that, for
15688 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
15689 Since each @kbd{d} (which marks the current article as read) by default
15690 goes to the next unread article after marking, this means that @kbd{3 d}
15691 will mark the next three unread articles as read, no matter what the
15692 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
15693 @code{nil} for a more straightforward action.
15694
15695
15696 @node Interactive
15697 @section Interactive
15698 @cindex interaction
15699
15700 @table @code
15701
15702 @item gnus-novice-user
15703 @vindex gnus-novice-user
15704 If this variable is non-@code{nil}, you are either a newcomer to the
15705 World of Usenet, or you are very cautious, which is a nice thing to be,
15706 really.  You will be given questions of the type ``Are you sure you want
15707 to do this?'' before doing anything dangerous.  This is @code{t} by
15708 default.
15709
15710 @item gnus-expert-user
15711 @vindex gnus-expert-user
15712 If this variable is non-@code{nil}, you will seldom be asked any
15713 questions by Gnus.  It will simply assume you know what you're doing, no
15714 matter how strange.
15715
15716 @item gnus-interactive-catchup
15717 @vindex gnus-interactive-catchup
15718 Require confirmation before catching up a group if non-@code{nil}.  It
15719 is @code{t} by default.
15720
15721 @item gnus-interactive-exit
15722 @vindex gnus-interactive-exit
15723 Require confirmation before exiting Gnus.  This variable is @code{t} by
15724 default.
15725 @end table
15726
15727
15728 @node Symbolic Prefixes
15729 @section Symbolic Prefixes
15730 @cindex symbolic prefixes
15731
15732 Quite a lot of Emacs commands react to the (numeric) prefix.  For
15733 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
15734 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
15735 rule of 900 to the current article.
15736
15737 This is all nice and well, but what if you want to give a command some
15738 additional information?  Well, what most commands do is interpret the
15739 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
15740 doesn't want a backup file to be created when saving the current buffer,
15741 for instance.  But what if you want to save without making a backup
15742 file, and you want Emacs to flash lights and play a nice tune at the
15743 same time?  You can't, and you're probably perfectly happy that way.
15744
15745 @kindex M-i (Summary)
15746 @findex gnus-symbolic-argument
15747 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
15748 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
15749 character typed in is the value.  You can stack as many @kbd{M-i}
15750 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
15751 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
15752 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
15753 @code{b}''.  You get the drift.
15754
15755 Typing in symbolic prefixes to commands that don't accept them doesn't
15756 hurt, but it doesn't do any good either.  Currently not many Gnus
15757 functions make use of the symbolic prefix.
15758
15759 If you're interested in how Gnus implements this, @pxref{Extended
15760 Interactive}.
15761
15762
15763 @node Formatting Variables
15764 @section Formatting Variables
15765 @cindex formatting variables
15766
15767 Throughout this manual you've probably noticed lots of variables called
15768 things like @code{gnus-group-line-format} and
15769 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
15770 output lines in the various buffers.  There's quite a lot of them.
15771 Fortunately, they all use the same syntax, so there's not that much to
15772 be annoyed by.
15773
15774 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
15775 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
15776 lots of percentages everywhere.
15777
15778 @menu
15779 * Formatting Basics::     A formatting variable is basically a format string.
15780 * Mode Line Formatting::  Some rules about mode line formatting variables.
15781 * Advanced Formatting::   Modifying output in various ways.
15782 * User-Defined Specs::    Having Gnus call your own functions.
15783 * Formatting Fonts::      Making the formatting look colorful and nice.
15784 @end menu
15785
15786 Currently Gnus uses the following formatting variables:
15787 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
15788 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
15789 @code{gnus-group-mode-line-format},
15790 @code{gnus-summary-mode-line-format},
15791 @code{gnus-article-mode-line-format},
15792 @code{gnus-server-mode-line-format}, and
15793 @code{gnus-summary-pick-line-format}.
15794
15795 All these format variables can also be arbitrary elisp forms.  In that
15796 case, they will be @code{eval}ed to insert the required lines.
15797
15798 @kindex M-x gnus-update-format
15799 @findex gnus-update-format
15800 Gnus includes a command to help you while creating your own format
15801 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
15802 update the spec in question and pop you to a buffer where you can
15803 examine the resulting lisp code to be run to generate the line.
15804
15805
15806
15807 @node Formatting Basics
15808 @subsection Formatting Basics
15809
15810 Each @samp{%} element will be replaced by some string or other when the
15811 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
15812 spec, and pad with spaces to get a 5-character field''.
15813
15814 As with normal C and Emacs Lisp formatting strings, the numerical
15815 modifier between the @samp{%} and the formatting type character will
15816 @dfn{pad} the output so that it is always at least that long.
15817 @samp{%5y} will make the field always (at least) five characters wide by
15818 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
15819 the right instead.
15820
15821 You may also wish to limit the length of the field to protect against
15822 particularly wide values.  For that you can say @samp{%4,6y}, which
15823 means that the field will never be more than 6 characters wide and never
15824 less than 4 characters wide.
15825
15826
15827 @node Mode Line Formatting
15828 @subsection Mode Line Formatting
15829
15830 Mode line formatting variables (e.g.,
15831 @code{gnus-summary-mode-line-format}) follow the same rules as other,
15832 buffer line oriented formatting variables (@pxref{Formatting Basics})
15833 with the following two differences:
15834
15835 @enumerate
15836
15837 @item
15838 There must be no newline (@samp{\n}) at the end.
15839
15840 @item
15841 The special @samp{%%b} spec can be used to display the buffer name.
15842 Well, it's no spec at all, really---@samp{%%} is just a way to quote
15843 @samp{%} to allow it to pass through the formatting machinery unmangled,
15844 so that Emacs receives @samp{%b}, which is something the Emacs mode line
15845 display interprets to mean ``show the buffer name''.  For a full list of
15846 mode line specs Emacs understands, see the documentation of the
15847 @code{mode-line-format} variable.
15848
15849 @end enumerate
15850
15851
15852 @node Advanced Formatting
15853 @subsection Advanced Formatting
15854
15855 It is frequently useful to post-process the fields in some way.
15856 Padding, limiting, cutting off parts and suppressing certain values can
15857 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
15858 look like @samp{%~(cut 3)~(ignore "0")y}.
15859
15860 These are the valid modifiers:
15861
15862 @table @code
15863 @item pad
15864 @itemx pad-left
15865 Pad the field to the left with spaces until it reaches the required
15866 length.
15867
15868 @item pad-right
15869 Pad the field to the right with spaces until it reaches the required
15870 length.
15871
15872 @item max
15873 @itemx max-left
15874 Cut off characters from the left until it reaches the specified length.
15875
15876 @item max-right
15877 Cut off characters from the right until it reaches the specified
15878 length.
15879
15880 @item cut
15881 @itemx cut-left
15882 Cut off the specified number of characters from the left.
15883
15884 @item cut-right
15885 Cut off the specified number of characters from the right.
15886
15887 @item ignore
15888 Return an empty string if the field is equal to the specified value.
15889
15890 @item form
15891 Use the specified form as the field value when the @samp{@@} spec is
15892 used.
15893 @end table
15894
15895 Let's take an example.  The @samp{%o} spec in the summary mode lines
15896 will return a date in compact ISO8601 format---@samp{19960809T230410}.
15897 This is quite a mouthful, so we want to shave off the century number and
15898 the time, leaving us with a six-character date.  That would be
15899 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
15900 maxing, and we need the padding to ensure that the date is never less
15901 than 6 characters to make it look nice in columns.)
15902
15903 Ignoring is done first; then cutting; then maxing; and then as the very
15904 last operation, padding.
15905
15906 If you use lots of these advanced thingies, you'll find that Gnus gets
15907 quite slow.  This can be helped enormously by running @kbd{M-x
15908 gnus-compile} when you are satisfied with the look of your lines.
15909 @xref{Compilation}.
15910
15911
15912 @node User-Defined Specs
15913 @subsection User-Defined Specs
15914
15915 All the specs allow for inserting user defined specifiers---@samp{u}.
15916 The next character in the format string should be a letter.  Gnus
15917 will call the function @code{gnus-user-format-function-}@samp{X}, where
15918 @samp{X} is the letter following @samp{%u}.  The function will be passed
15919 a single parameter---what the parameter means depends on what buffer
15920 it's being called from.  The function should return a string, which will
15921 be inserted into the buffer just like information from any other
15922 specifier.  This function may also be called with dummy values, so it
15923 should protect against that.
15924
15925 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
15926 much the same without defining new functions.  Here's an example:
15927 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
15928 given here will be evaluated to yield the current line number, and then
15929 inserted.
15930
15931
15932 @node Formatting Fonts
15933 @subsection Formatting Fonts
15934
15935 There are specs for highlighting, and these are shared by all the format
15936 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
15937 the special @code{mouse-face} property set, which means that it will be
15938 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
15939 over it.
15940
15941 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
15942 normal faces set using @code{gnus-face-0}, which is @code{bold} by
15943 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
15944 and so on.  Create as many faces as you wish.  The same goes for the
15945 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
15946 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
15947
15948 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
15949 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
15950 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
15951 @code{gnus-balloon-face-*} variables should be either strings or
15952 symbols naming functions that return a string. Under @code{balloon-help-mode},
15953 when the mouse passes over text with this property set, a balloon window
15954 will appear and display the string. Please refer to the doc string of
15955 @code{balloon-help-mode} for more information on this.
15956
15957 Here's an alternative recipe for the group buffer:
15958
15959 @lisp
15960 ;; Create three face types.
15961 (setq gnus-face-1 'bold)
15962 (setq gnus-face-3 'italic)
15963
15964 ;; We want the article count to be in
15965 ;; a bold and green face.  So we create
15966 ;; a new face called `my-green-bold'.
15967 (copy-face 'bold 'my-green-bold)
15968 ;; Set the color.
15969 (set-face-foreground 'my-green-bold "ForestGreen")
15970 (setq gnus-face-2 'my-green-bold)
15971
15972 ;; Set the new & fancy format.
15973 (setq gnus-group-line-format
15974       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
15975 @end lisp
15976
15977 I'm sure you'll be able to use this scheme to create totally unreadable
15978 and extremely vulgar displays.  Have fun!
15979
15980 Note that the @samp{%(} specs (and friends) do not make any sense on the
15981 mode-line variables.
15982
15983
15984 @node Windows Configuration
15985 @section Windows Configuration
15986 @cindex windows configuration
15987
15988 No, there's nothing here about X, so be quiet.
15989
15990 @vindex gnus-use-full-window
15991 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
15992 other windows and occupy the entire Emacs screen by itself.  It is
15993 @code{t} by default.
15994
15995 Setting this variable to @code{nil} kinda works, but there are
15996 glitches.  Use at your own peril.
15997
15998 @vindex gnus-buffer-configuration
15999 @code{gnus-buffer-configuration} describes how much space each Gnus
16000 buffer should be given.  Here's an excerpt of this variable:
16001
16002 @lisp
16003 ((group (vertical 1.0 (group 1.0 point)
16004                       (if gnus-carpal (group-carpal 4))))
16005  (article (vertical 1.0 (summary 0.25 point)
16006                         (article 1.0))))
16007 @end lisp
16008
16009 This is an alist.  The @dfn{key} is a symbol that names some action or
16010 other.  For instance, when displaying the group buffer, the window
16011 configuration function will use @code{group} as the key.  A full list of
16012 possible names is listed below.
16013
16014 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
16015 should occupy.  To take the @code{article} split as an example -
16016
16017 @lisp
16018 (article (vertical 1.0 (summary 0.25 point)
16019                        (article 1.0)))
16020 @end lisp
16021
16022 This @dfn{split} says that the summary buffer should occupy 25% of upper
16023 half of the screen, and that it is placed over the article buffer.  As
16024 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
16025 reaching for that calculator there).  However, the special number
16026 @code{1.0} is used to signal that this buffer should soak up all the
16027 rest of the space available after the rest of the buffers have taken
16028 whatever they need.  There should be only one buffer with the @code{1.0}
16029 size spec per split.
16030
16031 Point will be put in the buffer that has the optional third element
16032 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
16033 split where the tag @code{frame-focus} is a member (i.e. is the third or
16034 fourth element in the list, depending on whether the @code{point} tag is
16035 present) gets focus.
16036
16037 Here's a more complicated example:
16038
16039 @lisp
16040 (article (vertical 1.0 (group 4)
16041                        (summary 0.25 point)
16042                        (if gnus-carpal (summary-carpal 4))
16043                        (article 1.0)))
16044 @end lisp
16045
16046 If the size spec is an integer instead of a floating point number,
16047 then that number will be used to say how many lines a buffer should
16048 occupy, not a percentage.
16049
16050 If the @dfn{split} looks like something that can be @code{eval}ed (to be
16051 precise---if the @code{car} of the split is a function or a subr), this
16052 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
16053 be used as a split.  This means that there will be three buffers if
16054 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
16055 is non-@code{nil}.
16056
16057 Not complicated enough for you?  Well, try this on for size:
16058
16059 @lisp
16060 (article (horizontal 1.0
16061              (vertical 0.5
16062                  (group 1.0)
16063                  (gnus-carpal 4))
16064              (vertical 1.0
16065                  (summary 0.25 point)
16066                  (summary-carpal 4)
16067                  (article 1.0))))
16068 @end lisp
16069
16070 Whoops.  Two buffers with the mystery 100% tag.  And what's that
16071 @code{horizontal} thingie?
16072
16073 If the first element in one of the split is @code{horizontal}, Gnus will
16074 split the window horizontally, giving you two windows side-by-side.
16075 Inside each of these strips you may carry on all you like in the normal
16076 fashion.  The number following @code{horizontal} says what percentage of
16077 the screen is to be given to this strip.
16078
16079 For each split, there @emph{must} be one element that has the 100% tag.
16080 The splitting is never accurate, and this buffer will eat any leftover
16081 lines from the splits.
16082
16083 To be slightly more formal, here's a definition of what a valid split
16084 may look like:
16085
16086 @example
16087 split       = frame | horizontal | vertical | buffer | form
16088 frame       = "(frame " size *split ")"
16089 horizontal  = "(horizontal " size *split ")"
16090 vertical    = "(vertical " size *split ")"
16091 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
16092 size        = number | frame-params
16093 buffer-name = group | article | summary ...
16094 @end example
16095
16096 The limitations are that the @code{frame} split can only appear as the
16097 top-level split.  @var{form} should be an Emacs Lisp form that should
16098 return a valid split.  We see that each split is fully recursive, and
16099 may contain any number of @code{vertical} and @code{horizontal} splits.
16100
16101 @vindex gnus-window-min-width
16102 @vindex gnus-window-min-height
16103 @cindex window height
16104 @cindex window width
16105 Finding the right sizes can be a bit complicated.  No window may be less
16106 than @code{gnus-window-min-height} (default 1) characters high, and all
16107 windows must be at least @code{gnus-window-min-width} (default 1)
16108 characters wide.  Gnus will try to enforce this before applying the
16109 splits.  If you want to use the normal Emacs window width/height limit,
16110 you can just set these two variables to @code{nil}.
16111
16112 If you're not familiar with Emacs terminology, @code{horizontal} and
16113 @code{vertical} splits may work the opposite way of what you'd expect.
16114 Windows inside a @code{horizontal} split are shown side-by-side, and
16115 windows within a @code{vertical} split are shown above each other.
16116
16117 @findex gnus-configure-frame
16118 If you want to experiment with window placement, a good tip is to call
16119 @code{gnus-configure-frame} directly with a split.  This is the function
16120 that does all the real work when splitting buffers.  Below is a pretty
16121 nonsensical configuration with 5 windows; two for the group buffer and
16122 three for the article buffer.  (I said it was nonsensical.)  If you
16123 @code{eval} the statement below, you can get an idea of how that would
16124 look straight away, without going through the normal Gnus channels.
16125 Play with it until you're satisfied, and then use
16126 @code{gnus-add-configuration} to add your new creation to the buffer
16127 configuration list.
16128
16129 @lisp
16130 (gnus-configure-frame
16131  '(horizontal 1.0
16132     (vertical 10
16133       (group 1.0)
16134       (article 0.3 point))
16135     (vertical 1.0
16136       (article 1.0)
16137       (horizontal 4
16138         (group 1.0)
16139         (article 10)))))
16140 @end lisp
16141
16142 You might want to have several frames as well.  No prob---just use the
16143 @code{frame} split:
16144
16145 @lisp
16146 (gnus-configure-frame
16147  '(frame 1.0
16148          (vertical 1.0
16149                    (summary 0.25 point frame-focus)
16150                    (article 1.0))
16151          (vertical ((height . 5) (width . 15)
16152                     (user-position . t)
16153                     (left . -1) (top . 1))
16154                    (picon 1.0))))
16155
16156 @end lisp
16157
16158 This split will result in the familiar summary/article window
16159 configuration in the first (or ``main'') frame, while a small additional
16160 frame will be created where picons will be shown.  As you can see,
16161 instead of the normal @code{1.0} top-level spec, each additional split
16162 should have a frame parameter alist as the size spec.
16163 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
16164 Reference Manual}.  Under XEmacs, a frame property list will be
16165 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
16166 is such a plist.
16167 The list of all possible keys for @code{gnus-buffer-configuration} can
16168 be found in its default value.
16169
16170 Note that the @code{message} key is used for both
16171 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
16172 it is desirable to distinguish between the two, something like this
16173 might be used:
16174
16175 @lisp
16176 (message (horizontal 1.0
16177                      (vertical 1.0 (message 1.0 point))
16178                      (vertical 0.24
16179                                (if (buffer-live-p gnus-summary-buffer)
16180                                    '(summary 0.5))
16181                                (group 1.0)))))
16182 @end lisp
16183
16184 One common desire for a multiple frame split is to have a separate frame
16185 for composing mail and news while leaving the original frame intact.  To
16186 accomplish that, something like the following can be done:
16187
16188 @lisp
16189 (message (frame 1.0
16190                 (if (not (buffer-live-p gnus-summary-buffer))
16191                     (car (cdr (assoc 'group gnus-buffer-configuration)))
16192                   (car (cdr (assoc 'summary gnus-buffer-configuration))))
16193                 (vertical ((user-position . t) (top . 1) (left . 1)
16194                            (name . "Message"))
16195                           (message 1.0 point))))
16196 @end lisp
16197
16198 @findex gnus-add-configuration
16199 Since the @code{gnus-buffer-configuration} variable is so long and
16200 complicated, there's a function you can use to ease changing the config
16201 of a single setting: @code{gnus-add-configuration}.  If, for instance,
16202 you want to change the @code{article} setting, you could say:
16203
16204 @lisp
16205 (gnus-add-configuration
16206  '(article (vertical 1.0
16207                (group 4)
16208                (summary .25 point)
16209                (article 1.0))))
16210 @end lisp
16211
16212 You'd typically stick these @code{gnus-add-configuration} calls in your
16213 @file{.gnus.el} file or in some startup hook---they should be run after
16214 Gnus has been loaded.
16215
16216 @vindex gnus-always-force-window-configuration
16217 If all windows mentioned in the configuration are already visible, Gnus
16218 won't change the window configuration.  If you always want to force the
16219 ``right'' window configuration, you can set
16220 @code{gnus-always-force-window-configuration} to non-@code{nil}.
16221
16222 If you're using tree displays (@pxref{Tree Display}), and the tree
16223 window is displayed vertically next to another window, you may also want
16224 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
16225 windows resized.
16226
16227
16228 @node Faces and Fonts
16229 @section Faces and Fonts
16230 @cindex faces
16231 @cindex fonts
16232 @cindex colors
16233
16234 Fiddling with fonts and faces used to be very difficult, but these days
16235 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
16236 the face you want to alter, and alter it via the standard Customize
16237 interface.
16238
16239
16240 @node Compilation
16241 @section Compilation
16242 @cindex compilation
16243 @cindex byte-compilation
16244
16245 @findex gnus-compile
16246
16247 Remember all those line format specification variables?
16248 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
16249 on.  Now, Gnus will of course heed whatever these variables are, but,
16250 unfortunately, changing them will mean a quite significant slow-down.
16251 (The default values of these variables have byte-compiled functions
16252 associated with them, while the user-generated versions do not, of
16253 course.)
16254
16255 To help with this, you can run @kbd{M-x gnus-compile} after you've
16256 fiddled around with the variables and feel that you're (kind of)
16257 satisfied.  This will result in the new specs being byte-compiled, and
16258 you'll get top speed again.  Gnus will save these compiled specs in the
16259 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
16260 this function, though---you should compile them yourself by sticking
16261 them into the @code{.gnus.el} file and byte-compiling that file.)
16262
16263
16264 @node Mode Lines
16265 @section Mode Lines
16266 @cindex mode lines
16267
16268 @vindex gnus-updated-mode-lines
16269 @code{gnus-updated-mode-lines} says what buffers should keep their mode
16270 lines updated.  It is a list of symbols.  Supported symbols include
16271 @code{group}, @code{article}, @code{summary}, @code{server},
16272 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
16273 Gnus will keep that mode line updated with information that may be
16274 pertinent.  If this variable is @code{nil}, screen refresh may be
16275 quicker.
16276
16277 @cindex display-time
16278
16279 @vindex gnus-mode-non-string-length
16280 By default, Gnus displays information on the current article in the mode
16281 lines of the summary and article buffers.  The information Gnus wishes
16282 to display (e.g. the subject of the article) is often longer than the
16283 mode lines, and therefore have to be cut off at some point.  The
16284 @code{gnus-mode-non-string-length} variable says how long the other
16285 elements on the line is (i.e., the non-info part).  If you put
16286 additional elements on the mode line (e.g. a clock), you should modify
16287 this variable:
16288
16289 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
16290 @lisp
16291 (add-hook 'display-time-hook
16292           (lambda () (setq gnus-mode-non-string-length
16293                            (+ 21
16294                               (if line-number-mode 5 0)
16295                               (if column-number-mode 4 0)
16296                               (length display-time-string)))))
16297 @end lisp
16298
16299 If this variable is @code{nil} (which is the default), the mode line
16300 strings won't be chopped off, and they won't be padded either.  Note
16301 that the default is unlikely to be desirable, as even the percentage
16302 complete in the buffer may be crowded off the mode line; the user should
16303 configure this variable appropriately for her configuration.
16304
16305
16306 @node Highlighting and Menus
16307 @section Highlighting and Menus
16308 @cindex visual
16309 @cindex highlighting
16310 @cindex menus
16311
16312 @vindex gnus-visual
16313 The @code{gnus-visual} variable controls most of the Gnus-prettifying
16314 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
16315 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
16316 file.
16317
16318 This variable can be a list of visual properties that are enabled.  The
16319 following elements are valid, and are all included by default:
16320
16321 @table @code
16322 @item group-highlight
16323 Do highlights in the group buffer.
16324 @item summary-highlight
16325 Do highlights in the summary buffer.
16326 @item article-highlight
16327 Do highlights in the article buffer.
16328 @item highlight
16329 Turn on highlighting in all buffers.
16330 @item group-menu
16331 Create menus in the group buffer.
16332 @item summary-menu
16333 Create menus in the summary buffers.
16334 @item article-menu
16335 Create menus in the article buffer.
16336 @item browse-menu
16337 Create menus in the browse buffer.
16338 @item server-menu
16339 Create menus in the server buffer.
16340 @item score-menu
16341 Create menus in the score buffers.
16342 @item menu
16343 Create menus in all buffers.
16344 @end table
16345
16346 So if you only want highlighting in the article buffer and menus in all
16347 buffers, you could say something like:
16348
16349 @lisp
16350 (setq gnus-visual '(article-highlight menu))
16351 @end lisp
16352
16353 If you want highlighting only and no menus whatsoever, you'd say:
16354
16355 @lisp
16356 (setq gnus-visual '(highlight))
16357 @end lisp
16358
16359 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
16360 in all Gnus buffers.
16361
16362 Other general variables that influence the look of all buffers include:
16363
16364 @table @code
16365 @item gnus-mouse-face
16366 @vindex gnus-mouse-face
16367 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
16368 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
16369
16370 @end table
16371
16372 There are hooks associated with the creation of all the different menus:
16373
16374 @table @code
16375
16376 @item gnus-article-menu-hook
16377 @vindex gnus-article-menu-hook
16378 Hook called after creating the article mode menu.
16379
16380 @item gnus-group-menu-hook
16381 @vindex gnus-group-menu-hook
16382 Hook called after creating the group mode menu.
16383
16384 @item gnus-summary-menu-hook
16385 @vindex gnus-summary-menu-hook
16386 Hook called after creating the summary mode menu.
16387
16388 @item gnus-server-menu-hook
16389 @vindex gnus-server-menu-hook
16390 Hook called after creating the server mode menu.
16391
16392 @item gnus-browse-menu-hook
16393 @vindex gnus-browse-menu-hook
16394 Hook called after creating the browse mode menu.
16395
16396 @item gnus-score-menu-hook
16397 @vindex gnus-score-menu-hook
16398 Hook called after creating the score mode menu.
16399
16400 @end table
16401
16402
16403 @node Buttons
16404 @section Buttons
16405 @cindex buttons
16406 @cindex mouse
16407 @cindex click
16408
16409 Those new-fangled @dfn{mouse} contraptions is very popular with the
16410 young, hep kids who don't want to learn the proper way to do things
16411 these days.  Why, I remember way back in the summer of '89, when I was
16412 using Emacs on a Tops 20 system.  Three hundred users on one single
16413 machine, and every user was running Simula compilers.  Bah!
16414
16415 Right.
16416
16417 @vindex gnus-carpal
16418 Well, you can make Gnus display bufferfuls of buttons you can click to
16419 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
16420 really.  Tell the chiropractor I sent you.
16421
16422
16423 @table @code
16424
16425 @item gnus-carpal-mode-hook
16426 @vindex gnus-carpal-mode-hook
16427 Hook run in all carpal mode buffers.
16428
16429 @item gnus-carpal-button-face
16430 @vindex gnus-carpal-button-face
16431 Face used on buttons.
16432
16433 @item gnus-carpal-header-face
16434 @vindex gnus-carpal-header-face
16435 Face used on carpal buffer headers.
16436
16437 @item gnus-carpal-group-buffer-buttons
16438 @vindex gnus-carpal-group-buffer-buttons
16439 Buttons in the group buffer.
16440
16441 @item gnus-carpal-summary-buffer-buttons
16442 @vindex gnus-carpal-summary-buffer-buttons
16443 Buttons in the summary buffer.
16444
16445 @item gnus-carpal-server-buffer-buttons
16446 @vindex gnus-carpal-server-buffer-buttons
16447 Buttons in the server buffer.
16448
16449 @item gnus-carpal-browse-buffer-buttons
16450 @vindex gnus-carpal-browse-buffer-buttons
16451 Buttons in the browse buffer.
16452 @end table
16453
16454 All the @code{buttons} variables are lists.  The elements in these list
16455 are either cons cells where the @code{car} contains a text to be displayed and
16456 the @code{cdr} contains a function symbol, or a simple string.
16457
16458
16459 @node Daemons
16460 @section Daemons
16461 @cindex demons
16462 @cindex daemons
16463
16464 Gnus, being larger than any program ever written (allegedly), does lots
16465 of strange stuff that you may wish to have done while you're not
16466 present.  For instance, you may want it to check for new mail once in a
16467 while.  Or you may want it to close down all connections to all servers
16468 when you leave Emacs idle.  And stuff like that.
16469
16470 Gnus will let you do stuff like that by defining various
16471 @dfn{handlers}.  Each handler consists of three elements:  A
16472 @var{function}, a @var{time}, and an @var{idle} parameter.
16473
16474 Here's an example of a handler that closes connections when Emacs has
16475 been idle for thirty minutes:
16476
16477 @lisp
16478 (gnus-demon-close-connections nil 30)
16479 @end lisp
16480
16481 Here's a handler that scans for PGP headers every hour when Emacs is
16482 idle:
16483
16484 @lisp
16485 (gnus-demon-scan-pgp 60 t)
16486 @end lisp
16487
16488 This @var{time} parameter and than @var{idle} parameter work together
16489 in a strange, but wonderful fashion.  Basically, if @var{idle} is
16490 @code{nil}, then the function will be called every @var{time} minutes.
16491
16492 If @var{idle} is @code{t}, then the function will be called after
16493 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
16494 the function will never be called.  But once Emacs goes idle, the
16495 function will be called every @var{time} minutes.
16496
16497 If @var{idle} is a number and @var{time} is a number, the function will
16498 be called every @var{time} minutes only when Emacs has been idle for
16499 @var{idle} minutes.
16500
16501 If @var{idle} is a number and @var{time} is @code{nil}, the function
16502 will be called once every time Emacs has been idle for @var{idle}
16503 minutes.
16504
16505 And if @var{time} is a string, it should look like @samp{07:31}, and
16506 the function will then be called once every day somewhere near that
16507 time.  Modified by the @var{idle} parameter, of course.
16508
16509 @vindex gnus-demon-timestep
16510 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
16511 seconds.  This is 60 by default.  If you change that variable,
16512 all the timings in the handlers will be affected.)
16513
16514 So, if you want to add a handler, you could put something like this in
16515 your @file{.gnus} file:
16516
16517 @findex gnus-demon-add-handler
16518 @lisp
16519 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
16520 @end lisp
16521
16522 @findex gnus-demon-add-nocem
16523 @findex gnus-demon-add-scanmail
16524 @findex gnus-demon-add-rescan
16525 @findex gnus-demon-add-scan-timestamps
16526 @findex gnus-demon-add-disconnection
16527 Some ready-made functions to do this have been created:
16528 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
16529 @code{gnus-demon-add-nntp-close-connection},
16530 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
16531 @code{gnus-demon-add-scanmail}.  Just put those functions in your
16532 @file{.gnus} if you want those abilities.
16533
16534 @findex gnus-demon-init
16535 @findex gnus-demon-cancel
16536 @vindex gnus-demon-handlers
16537 If you add handlers to @code{gnus-demon-handlers} directly, you should
16538 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
16539 daemons, you can use the @code{gnus-demon-cancel} function.
16540
16541 Note that adding daemons can be pretty naughty if you over do it.  Adding
16542 functions that scan all news and mail from all servers every two seconds
16543 is a sure-fire way of getting booted off any respectable system.  So
16544 behave.
16545
16546
16547 @node NoCeM
16548 @section NoCeM
16549 @cindex nocem
16550 @cindex spam
16551
16552 @dfn{Spamming} is posting the same article lots and lots of times.
16553 Spamming is bad.  Spamming is evil.
16554
16555 Spamming is usually canceled within a day or so by various anti-spamming
16556 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
16557 NoCeM is pronounced ``no see-'em'', and means what the name
16558 implies---these are messages that make the offending articles, like, go
16559 away.
16560
16561 What use are these NoCeM messages if the articles are canceled anyway?
16562 Some sites do not honor cancel messages and some sites just honor cancels
16563 from a select few people.  Then you may wish to make use of the NoCeM
16564 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
16565
16566 Gnus can read and parse the messages in this group automatically, and
16567 this will make spam disappear.
16568
16569 There are some variables to customize, of course:
16570
16571 @table @code
16572 @item gnus-use-nocem
16573 @vindex gnus-use-nocem
16574 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
16575 by default.
16576
16577 @item gnus-nocem-groups
16578 @vindex gnus-nocem-groups
16579 Gnus will look for NoCeM messages in the groups in this list.  The
16580 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
16581 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
16582
16583 @item gnus-nocem-issuers
16584 @vindex gnus-nocem-issuers
16585 There are many people issuing NoCeM messages.  This list says what
16586 people you want to listen to.  The default is @code{("Automoose-1"
16587 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
16588 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
16589 (Richard E. Depew)")}; fine, upstanding citizens all of them.
16590
16591 Known despammers that you can put in this list include:
16592
16593 @table @samp
16594 @item clewis@@ferret.ocunix.on.ca;
16595 @cindex Chris Lewis
16596 Chris Lewis---Major Canadian despammer who has probably canceled more
16597 usenet abuse than anybody else.
16598
16599 @item Automoose-1
16600 @cindex CancelMoose[tm]
16601 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
16602 Norwegian, and was the person(s) who invented NoCeM.
16603
16604 @item jem@@xpat.com;
16605 @cindex Jem
16606 John Milburn---despammer located in Korea who is getting very busy these
16607 days.
16608
16609 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
16610 Richard E. Depew---lone American despammer.  He mostly cancels binary
16611 postings to non-binary groups and removes spews (regurgitated articles).
16612 @end table
16613
16614 You do not have to heed NoCeM messages from all these people---just the
16615 ones you want to listen to.  You also don't have to accept all NoCeM
16616 messages from the people you like.  Each NoCeM message has a @dfn{type}
16617 header that gives the message a (more or less, usually less) rigorous
16618 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
16619 @samp{binary}, and @samp{troll}.  To specify this, you have to use
16620 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
16621 Each condition is either a string (which is a regexp that matches types
16622 you want to use) or a list on the form @code{(not @var{string})}, where
16623 @var{string} is a regexp that matches types you don't want to use.
16624
16625 For instance, if you want all NoCeM messages from Chris Lewis except his
16626 @samp{troll} messages, you'd say:
16627
16628 @lisp
16629 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
16630 @end lisp
16631
16632 On the other hand, if you just want nothing but his @samp{spam} and
16633 @samp{spew} messages, you'd say:
16634
16635 @lisp
16636 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
16637 @end lisp
16638
16639 The specs are applied left-to-right.
16640
16641
16642 @item gnus-nocem-verifyer
16643 @vindex gnus-nocem-verifyer
16644 @findex mc-verify
16645 This should be a function for verifying that the NoCeM issuer is who she
16646 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
16647 function.  If this is too slow and you don't care for verification
16648 (which may be dangerous), you can set this variable to @code{nil}.
16649
16650 If you want signed NoCeM messages to be verified and unsigned messages
16651 not to be verified (but used anyway), you could do something like:
16652
16653 @lisp
16654 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
16655
16656 (defun my-gnus-mc-verify ()
16657   (not (eq 'forged
16658            (ignore-errors
16659              (if (mc-verify)
16660                  t
16661                'forged)))))
16662 @end lisp
16663
16664 This might be dangerous, though.
16665
16666 @item gnus-nocem-directory
16667 @vindex gnus-nocem-directory
16668 This is where Gnus will store its NoCeM cache files.  The default is
16669 @file{~/News/NoCeM/}.
16670
16671 @item gnus-nocem-expiry-wait
16672 @vindex gnus-nocem-expiry-wait
16673 The number of days before removing old NoCeM entries from the cache.
16674 The default is 15.  If you make it shorter Gnus will be faster, but you
16675 might then see old spam.
16676
16677 @end table
16678
16679 Using NoCeM could potentially be a memory hog.  If you have many living
16680 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
16681 big.  If this is a problem, you should kill off all (or most) of your
16682 unsubscribed groups (@pxref{Subscription Commands}).
16683
16684
16685 @node Undo
16686 @section Undo
16687 @cindex undo
16688
16689 It is very useful to be able to undo actions one has done.  In normal
16690 Emacs buffers, it's easy enough---you just push the @code{undo} button.
16691 In Gnus buffers, however, it isn't that simple.
16692
16693 The things Gnus displays in its buffer is of no value whatsoever to
16694 Gnus---it's all just data designed to look nice to the user.
16695 Killing a group in the group buffer with @kbd{C-k} makes the line
16696 disappear, but that's just a side-effect of the real action---the
16697 removal of the group in question from the internal Gnus structures.
16698 Undoing something like that can't be done by the normal Emacs
16699 @code{undo} function.
16700
16701 Gnus tries to remedy this somewhat by keeping track of what the user
16702 does and coming up with actions that would reverse the actions the user
16703 takes.  When the user then presses the @code{undo} key, Gnus will run
16704 the code to reverse the previous action, or the previous actions.
16705 However, not all actions are easily reversible, so Gnus currently offers
16706 a few key functions to be undoable.  These include killing groups,
16707 yanking groups, and changing the list of read articles of groups.
16708 That's it, really.  More functions may be added in the future, but each
16709 added function means an increase in data to be stored, so Gnus will
16710 never be totally undoable.
16711
16712 @findex gnus-undo-mode
16713 @vindex gnus-use-undo
16714 @findex gnus-undo
16715 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
16716 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
16717 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
16718 command, which should feel kinda like the normal Emacs @code{undo}
16719 command.
16720
16721
16722 @node Moderation
16723 @section Moderation
16724 @cindex moderation
16725
16726 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
16727 It is not included in the standard Gnus package.  Write a mail to
16728 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
16729 get a copy.
16730
16731 The moderation package is implemented as a minor mode for summary
16732 buffers.  Put
16733
16734 @lisp
16735 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
16736 @end lisp
16737
16738 in your @file{.gnus.el} file.
16739
16740 If you are the moderator of @samp{rec.zoofle}, this is how it's
16741 supposed to work:
16742
16743 @enumerate
16744 @item
16745 You split your incoming mail by matching on
16746 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
16747 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
16748
16749 @item
16750 You enter that group once in a while and post articles using the @kbd{e}
16751 (edit-and-post) or @kbd{s} (just send unedited) commands.
16752
16753 @item
16754 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
16755 articles that weren't approved by you, you can cancel them with the
16756 @kbd{c} command.
16757 @end enumerate
16758
16759 To use moderation mode in these two groups, say:
16760
16761 @lisp
16762 (setq gnus-moderated-list
16763       "^nnml:rec.zoofle$\\|^rec.zoofle$")
16764 @end lisp
16765
16766
16767 @node XEmacs Enhancements
16768 @section XEmacs Enhancements
16769 @cindex XEmacs
16770
16771 XEmacs is able to display pictures and stuff, so Gnus has taken
16772 advantage of that.
16773
16774 @menu
16775 * Picons::    How to display pictures of what your reading.
16776 * Smileys::   Show all those happy faces the way they were meant to be shown.
16777 * Toolbar::   Click'n'drool.
16778 * XVarious::  Other XEmacsy Gnusey variables.
16779 @end menu
16780
16781
16782 @node Picons
16783 @subsection Picons
16784
16785 @iftex
16786 @iflatex
16787 \include{picons}
16788 @end iflatex
16789 @end iftex
16790
16791 So...  You want to slow down your news reader even more!  This is a
16792 good way to do so.  Its also a great way to impress people staring
16793 over your shoulder as you read news.
16794
16795 @menu
16796 * Picon Basics::           What are picons and How do I get them.
16797 * Picon Requirements::     Don't go further if you aren't using XEmacs.
16798 * Easy Picons::            Displaying Picons---the easy way.
16799 * Hard Picons::            The way you should do it.  You'll learn something.
16800 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
16801 @end menu
16802
16803
16804 @node Picon Basics
16805 @subsubsection Picon Basics
16806
16807 What are Picons?  To quote directly from the Picons Web site:
16808
16809 @iftex
16810 @iflatex
16811 \margindex{}
16812 @end iflatex
16813 @end iftex
16814
16815 @quotation
16816 @dfn{Picons} is short for ``personal icons''.  They're small,
16817 constrained images used to represent users and domains on the net,
16818 organized into databases so that the appropriate image for a given
16819 e-mail address can be found.  Besides users and domains, there are picon
16820 databases for Usenet newsgroups and weather forecasts.  The picons are
16821 in either monochrome @code{XBM} format or color @code{XPM} and
16822 @code{GIF} formats.
16823 @end quotation
16824
16825 @vindex gnus-picons-piconsearch-url
16826 If you have a permanent connection to the Internet you can use Steve
16827 Kinzler's Picons Search engine by setting
16828 @code{gnus-picons-piconsearch-url} to the string @*
16829 @file{http://www.cs.indiana.edu/picons/search.html}.
16830
16831 @vindex gnus-picons-database
16832 Otherwise you need a local copy of his database.  For instructions on
16833 obtaining and installing the picons databases, point your Web browser at @*
16834 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
16835 picons to be installed into a location pointed to by
16836 @code{gnus-picons-database}.
16837
16838
16839 @node Picon Requirements
16840 @subsubsection Picon Requirements
16841
16842 To have Gnus display Picons for you, you must be running XEmacs
16843 19.13 or greater since all other versions of Emacs aren't yet able to
16844 display images.
16845
16846 Additionally, you must have @code{x} support compiled into XEmacs.  To
16847 display color picons which are much nicer than the black & white one,
16848 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
16849
16850 @vindex gnus-picons-convert-x-face
16851 If you want to display faces from @code{X-Face} headers, you should have
16852 the @code{xface} support compiled into XEmacs.  Otherwise you must have
16853 the @code{netpbm} utilities installed, or munge the
16854 @code{gnus-picons-convert-x-face} variable to use something else.
16855
16856
16857 @node Easy Picons
16858 @subsubsection Easy Picons
16859
16860 To enable displaying picons, simply put the following line in your
16861 @file{~/.gnus} file and start Gnus.
16862
16863 @lisp
16864 (setq gnus-use-picons t)
16865 (setq gnus-treat-display-picons t)
16866 @end lisp
16867
16868 and make sure @code{gnus-picons-database} points to the directory
16869 containing the Picons databases.
16870
16871 Alternatively if you want to use the web piconsearch engine add this:
16872
16873 @lisp
16874 (setq gnus-picons-piconsearch-url
16875       "http://www.cs.indiana.edu:800/piconsearch")
16876 @end lisp
16877
16878
16879 @node Hard Picons
16880 @subsubsection Hard Picons
16881
16882 @iftex
16883 @iflatex
16884 \margindex{}
16885 @end iflatex
16886 @end iftex
16887
16888 Gnus can display picons for you as you enter and leave groups and
16889 articles.  It knows how to interact with three sections of the picons
16890 database.  Namely, it can display the picons newsgroup pictures,
16891 author's face picture(s), and the authors domain.  To enable this
16892 feature, you need to select where to get the picons from, and where to
16893 display them.
16894
16895 @table @code
16896
16897 @item gnus-picons-database
16898 @vindex gnus-picons-database
16899 The location of the picons database.  Should point to a directory
16900 containing the @file{news}, @file{domains}, @file{users} (and so on)
16901 subdirectories.  This is only useful if
16902 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
16903 @file{/usr/local/faces/}.
16904
16905 @item gnus-picons-piconsearch-url
16906 @vindex gnus-picons-piconsearch-url
16907 The URL for the web picons search engine.  The only currently known
16908 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
16909 workaround network delays, icons will be fetched in the background.  If
16910 this is @code{nil} 'the default), then picons are fetched from local
16911 database indicated by @code{gnus-picons-database}.
16912
16913 @item gnus-picons-display-where
16914 @vindex gnus-picons-display-where
16915 Where the picon images should be displayed.  It is @code{picons} by
16916 default (which by default maps to the buffer @samp{*Picons*}).  Other
16917 valid places could be @code{article}, @code{summary}, or
16918 @samp{*scratch*} for all I care.  Just make sure that you've made the
16919 buffer visible using the standard Gnus window configuration
16920 routines---@pxref{Windows Configuration}.
16921
16922 @item gnus-picons-group-excluded-groups
16923 @vindex gnus-picons-group-excluded-groups
16924 Groups that are matched by this regexp won't have their group icons
16925 displayed.
16926
16927 @end table
16928
16929 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
16930 window configuration for you to include the @code{picons} buffer.
16931
16932 Now that you've made those decision, you need to add the following
16933 functions to the appropriate hooks so these pictures will get displayed
16934 at the right time.
16935
16936 @vindex gnus-picons-display-where
16937 @table @code
16938 @item gnus-article-display-picons
16939 @findex gnus-article-display-picons
16940 Looks up and displays the picons for the author and the author's domain
16941 in the @code{gnus-picons-display-where} buffer.
16942
16943 @item gnus-picons-article-display-x-face
16944 @findex gnus-article-display-picons
16945 Decodes and displays the X-Face header if present.
16946
16947 @end table
16948
16949
16950
16951 @node Picon Useless Configuration
16952 @subsubsection Picon Useless Configuration
16953
16954 @iftex
16955 @iflatex
16956 \margindex{}
16957 @end iflatex
16958 @end iftex
16959
16960 The following variables offer further control over how things are
16961 done, where things are located, and other useless stuff you really
16962 don't need to worry about.
16963
16964 @table @code
16965
16966 @item gnus-picons-news-directories
16967 @vindex gnus-picons-news-directories
16968 List of subdirectories to search in @code{gnus-picons-database} for
16969 newsgroups faces.  @code{("news")} is the default.
16970
16971 @item gnus-picons-user-directories
16972 @vindex gnus-picons-user-directories
16973 List of subdirectories to search in @code{gnus-picons-database} for user
16974 faces.  @code{("local" "users" "usenix" "misc")} is the default.
16975
16976 @item gnus-picons-domain-directories
16977 @vindex gnus-picons-domain-directories
16978 List of subdirectories to search in @code{gnus-picons-database} for
16979 domain name faces.  Defaults to @code{("domains")}.  Some people may
16980 want to add @samp{"unknown"} to this list.
16981
16982 @item gnus-picons-convert-x-face
16983 @vindex gnus-picons-convert-x-face
16984 If you don't have @code{xface} support builtin XEmacs, this is the
16985 command to use to convert the @code{X-Face} header to an X bitmap
16986 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
16987 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
16988 gnus-picons-x-face-file-name)}
16989
16990 @item gnus-picons-x-face-file-name
16991 @vindex gnus-picons-x-face-file-name
16992 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
16993 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
16994
16995 @item gnus-picons-has-modeline-p
16996 @vindex gnus-picons-has-modeline-p
16997 If you have set @code{gnus-picons-display-where} to @code{picons}, your
16998 XEmacs frame will become really cluttered.  To alleviate this a bit you
16999 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
17000 remove the mode line from the Picons buffer.  This is only useful if
17001 @code{gnus-picons-display-where} is @code{picons}.
17002
17003 @item gnus-picons-refresh-before-display
17004 @vindex gnus-picons-refresh-before-display
17005 If non-nil, display the article buffer before computing the picons.
17006 Defaults to @code{nil}.
17007
17008 @item gnus-picons-display-as-address
17009 @vindex gnus-picons-display-as-address
17010 If @code{t} display textual email addresses along with pictures.
17011 Defaults to @code{t}.
17012
17013 @item gnus-picons-file-suffixes
17014 @vindex gnus-picons-file-suffixes
17015 Ordered list of suffixes on picon file names to try.  Defaults to
17016 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
17017
17018 @item gnus-picons-setup-hook
17019 @vindex gnus-picons-setup-hook
17020 Hook run in the picon buffer, if that is displayed.
17021
17022 @item gnus-picons-display-article-move-p
17023 @vindex gnus-picons-display-article-move-p
17024 Whether to move point to first empty line when displaying picons.  This
17025 has only an effect if `gnus-picons-display-where' has value `article'.
17026
17027 If @code{nil}, display the picons in the @code{From} and
17028 @code{Newsgroups} lines.  This is the defailt.
17029
17030 @item gnus-picons-clear-cache-on-shutdown
17031 @vindex gnus-picons-clear-cache-on-shutdown
17032 Whether to clear the picons cache when exiting gnus.  Gnus caches every
17033 picons it finds while it is running.  This saves some time in the search
17034 process but eats some memory.  If this variable is set to @code{nil},
17035 Gnus will never clear the cache itself; you will have to manually call
17036 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
17037 cleared every time you exit Gnus.  Defaults to @code{t}.
17038
17039 @iftex
17040 @iflatex
17041 \margindex{}
17042 @end iflatex
17043 @end iftex
17044
17045 @end table
17046
17047 @node Smileys
17048 @subsection Smileys
17049 @cindex smileys
17050
17051 @iftex
17052 @iflatex
17053 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
17054 \input{smiley}
17055 @end iflatex
17056 @end iftex
17057
17058 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
17059 currently the only package that uses Smiley, it is documented here.
17060
17061 In short---to use Smiley in Gnus, put the following in your
17062 @file{.gnus.el} file:
17063
17064 @lisp
17065 (setq gnus-treat-display-smiley t)
17066 @end lisp
17067
17068 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
17069 the like---to pictures and displays those instead of the text smiley
17070 faces.  The conversion is controlled by a list of regexps that matches
17071 text and maps that to file names.
17072
17073 @vindex smiley-nosey-regexp-alist
17074 @vindex smiley-deformed-regexp-alist
17075 Smiley supplies two example conversion alists by default:
17076 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
17077 and so on), and @code{smiley-nosey-regexp-alist} (which matches
17078 @samp{:-)}, @samp{:-(} and so on).
17079
17080 The alist used is specified by the @code{smiley-regexp-alist} variable,
17081 which defaults to the value of @code{smiley-deformed-regexp-alist}.
17082
17083 The first item in each element is the regexp to be matched; the second
17084 element is the regexp match group that is to be replaced by the picture;
17085 and the third element is the name of the file to be displayed.
17086
17087 The following variables customize where Smiley will look for these
17088 files, as well as the color to be used and stuff:
17089
17090 @table @code
17091
17092 @item smiley-data-directory
17093 @vindex smiley-data-directory
17094 Where Smiley will look for smiley faces files.
17095
17096 @item smiley-flesh-color
17097 @vindex smiley-flesh-color
17098 Skin color.  The default is @samp{yellow}, which is really racist.
17099
17100 @item smiley-features-color
17101 @vindex smiley-features-color
17102 Color of the features of the face.  The default is @samp{black}.
17103
17104 @item smiley-tongue-color
17105 @vindex smiley-tongue-color
17106 Color of the tongue.  The default is @samp{red}.
17107
17108 @item smiley-circle-color
17109 @vindex smiley-circle-color
17110 Color of the circle around the face.  The default is @samp{black}.
17111
17112 @item smiley-mouse-face
17113 @vindex smiley-mouse-face
17114 Face used for mouse highlighting over the smiley face.
17115
17116 @end table
17117
17118
17119 @node Toolbar
17120 @subsection Toolbar
17121
17122 @table @code
17123
17124 @iftex
17125 @iflatex
17126 \margindex{}
17127 @end iflatex
17128 @end iftex
17129
17130 @item gnus-use-toolbar
17131 @vindex gnus-use-toolbar
17132 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
17133 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
17134 @code{right-toolbar}, or @code{left-toolbar}.
17135
17136 @item gnus-group-toolbar
17137 @vindex gnus-group-toolbar
17138 The toolbar in the group buffer.
17139
17140 @item gnus-summary-toolbar
17141 @vindex gnus-summary-toolbar
17142 The toolbar in the summary buffer.
17143
17144 @item gnus-summary-mail-toolbar
17145 @vindex gnus-summary-mail-toolbar
17146 The toolbar in the summary buffer of mail groups.
17147
17148 @end table
17149
17150
17151 @node XVarious
17152 @subsection Various XEmacs Variables
17153
17154 @table @code
17155 @item gnus-xmas-glyph-directory
17156 @vindex gnus-xmas-glyph-directory
17157 This is where Gnus will look for pictures.  Gnus will normally
17158 auto-detect this directory, but you may set it manually if you have an
17159 unusual directory structure.
17160
17161 @item gnus-xmas-logo-color-alist
17162 @vindex gnus-xmas-logo-color-alist
17163 This is an alist where the key is a type symbol and the values are the
17164 foreground and background color of the splash page glyph.
17165
17166 @item gnus-xmas-logo-color-style
17167 @vindex gnus-xmas-logo-color-style
17168 This is the key used to look up the color in the alist described above.
17169 Valid values include @code{flame}, @code{pine}, @code{moss},
17170 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
17171 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
17172
17173 @item gnus-xmas-modeline-glyph
17174 @vindex gnus-xmas-modeline-glyph
17175 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
17176 default.
17177
17178 @iftex
17179 @iflatex
17180 \margindex{}
17181 @end iflatex
17182 @end iftex
17183
17184 @end table
17185
17186
17187
17188
17189 @node Fuzzy Matching
17190 @section Fuzzy Matching
17191 @cindex fuzzy matching
17192
17193 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
17194 things like scoring, thread gathering and thread comparison.
17195
17196 As opposed to regular expression matching, fuzzy matching is very fuzzy.
17197 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
17198 means, and the implementation has changed over time.
17199
17200 Basically, it tries to remove all noise from lines before comparing.
17201 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
17202 out of the strings before comparing the results.  This often leads to
17203 adequate results---even when faced with strings generated by text
17204 manglers masquerading as newsreaders.
17205
17206
17207 @node Thwarting Email Spam
17208 @section Thwarting Email Spam
17209 @cindex email spam
17210 @cindex spam
17211 @cindex UCE
17212 @cindex unsolicited commercial email
17213
17214 In these last days of the Usenet, commercial vultures are hanging about
17215 and grepping through news like crazy to find email addresses they can
17216 foist off their scams and products to.  As a reaction to this, many
17217 people have started putting nonsense addresses into their @code{From}
17218 lines.  I think this is counterproductive---it makes it difficult for
17219 people to send you legitimate mail in response to things you write, as
17220 well as making it difficult to see who wrote what.  This rewriting may
17221 perhaps be a bigger menace than the unsolicited commercial email itself
17222 in the end.
17223
17224 The biggest problem I have with email spam is that it comes in under
17225 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
17226 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
17227 mail group, only to find two pyramid schemes, seven advertisements
17228 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
17229 and one mail asking me to repent and find some god.
17230
17231 This is annoying.
17232
17233 The way to deal with this is having Gnus split out all spam into a
17234 @samp{spam} mail group (@pxref{Splitting Mail}).
17235
17236 First, pick one (1) valid mail address that you can be reached at, and
17237 put it in your @code{From} header of all your news articles.  (I've
17238 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
17239 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
17240 sysadm whether your sendmail installation accepts keywords in the local
17241 part of the mail address.)
17242
17243 @lisp
17244 (setq message-default-news-headers
17245       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
17246 @end lisp
17247
17248 Then put the following split rule in @code{nnmail-split-fancy}
17249 (@pxref{Fancy Mail Splitting}):
17250
17251 @lisp
17252 (
17253  ...
17254  (to "larsi@@trym.ifi.uio.no"
17255       (| ("subject" "re:.*" "misc")
17256          ("references" ".*@@.*" "misc")
17257          "spam"))
17258  ...
17259 )
17260 @end lisp
17261
17262 This says that all mail to this address is suspect, but if it has a
17263 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
17264 header, it's probably ok.  All the rest goes to the @samp{spam} group.
17265 (This idea probably comes from Tim Pierce.)
17266
17267 In addition, many mail spammers talk directly to your @code{smtp} server
17268 and do not include your email address explicitly in the @code{To}
17269 header.  Why they do this is unknown---perhaps it's to thwart this
17270 thwarting scheme?  In any case, this is trivial to deal with---you just
17271 put anything not addressed to you in the @samp{spam} group by ending
17272 your fancy split rule in this way:
17273
17274 @lisp
17275 (
17276  ...
17277  (to "larsi" "misc")
17278  "spam")
17279 @end lisp
17280
17281 In my experience, this will sort virtually everything into the right
17282 group.  You still have to check the @samp{spam} group from time to time to
17283 check for legitimate mail, though.  If you feel like being a good net
17284 citizen, you can even send off complaints to the proper authorities on
17285 each unsolicited commercial email---at your leisure.
17286
17287 If you are also a lazy net citizen, you will probably prefer complaining
17288 automatically with the @file{gnus-junk.el} package, available FOR FREE
17289 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
17290 Since most e-mail spam is sent automatically, this may reconcile the
17291 cosmic balance somewhat.
17292
17293 This works for me.  It allows people an easy way to contact me (they can
17294 just press @kbd{r} in the usual way), and I'm not bothered at all with
17295 spam.  It's a win-win situation.  Forging @code{From} headers to point
17296 to non-existent domains is yucky, in my opinion.
17297
17298
17299 @node Various Various
17300 @section Various Various
17301 @cindex mode lines
17302 @cindex highlights
17303
17304 @table @code
17305
17306 @item gnus-home-directory
17307 All Gnus path variables will be initialized from this variable, which
17308 defaults to @file{~/}.
17309
17310 @item gnus-directory
17311 @vindex gnus-directory
17312 Most Gnus storage path variables will be initialized from this variable,
17313 which defaults to the @samp{SAVEDIR} environment variable, or
17314 @file{~/News/} if that variable isn't set.
17315
17316 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
17317 This means that other directory variables that are initialized from this
17318 variable won't be set properly if you set this variable in
17319 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
17320
17321 @item gnus-default-directory
17322 @vindex gnus-default-directory
17323 Not related to the above variable at all---this variable says what the
17324 default directory of all Gnus buffers should be.  If you issue commands
17325 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
17326 default directory.  If this variable is @code{nil} (which is the
17327 default), the default directory will be the default directory of the
17328 buffer you were in when you started Gnus.
17329
17330 @item gnus-verbose
17331 @vindex gnus-verbose
17332 This variable is an integer between zero and ten.  The higher the value,
17333 the more messages will be displayed.  If this variable is zero, Gnus
17334 will never flash any messages, if it is seven (which is the default),
17335 most important messages will be shown, and if it is ten, Gnus won't ever
17336 shut up, but will flash so many messages it will make your head swim.
17337
17338 @item gnus-verbose-backends
17339 @vindex gnus-verbose-backends
17340 This variable works the same way as @code{gnus-verbose}, but it applies
17341 to the Gnus backends instead of Gnus proper.
17342
17343 @item nnheader-max-head-length
17344 @vindex nnheader-max-head-length
17345 When the backends read straight heads of articles, they all try to read
17346 as little as possible.  This variable (default 4096) specifies
17347 the absolute max length the backends will try to read before giving up
17348 on finding a separator line between the head and the body.  If this
17349 variable is @code{nil}, there is no upper read bound.  If it is
17350 @code{t}, the backends won't try to read the articles piece by piece,
17351 but read the entire articles.  This makes sense with some versions of
17352 @code{ange-ftp} or @code{efs}.
17353
17354 @item nnheader-head-chop-length
17355 @vindex nnheader-head-chop-length
17356 This variable (default 2048) says how big a piece of each article to
17357 read when doing the operation described above.
17358
17359 @item nnheader-file-name-translation-alist
17360 @vindex nnheader-file-name-translation-alist
17361 @cindex file names
17362 @cindex invalid characters in file names
17363 @cindex characters in file names
17364 This is an alist that says how to translate characters in file names.
17365 For instance, if @samp{:} is invalid as a file character in file names
17366 on your system (you OS/2 user you), you could say something like:
17367
17368 @lisp
17369 (setq nnheader-file-name-translation-alist
17370       '((?: . ?_)))
17371 @end lisp
17372
17373 In fact, this is the default value for this variable on OS/2 and MS
17374 Windows (phooey) systems.
17375
17376 @item gnus-hidden-properties
17377 @vindex gnus-hidden-properties
17378 This is a list of properties to use to hide ``invisible'' text.  It is
17379 @code{(invisible t intangible t)} by default on most systems, which
17380 makes invisible text invisible and intangible.
17381
17382 @item gnus-parse-headers-hook
17383 @vindex gnus-parse-headers-hook
17384 A hook called before parsing headers.  It can be used, for instance, to
17385 gather statistics on the headers fetched, or perhaps you'd like to prune
17386 some headers.  I don't see why you'd want that, though.
17387
17388 @item gnus-shell-command-separator
17389 @vindex gnus-shell-command-separator
17390 String used to separate two shell commands.  The default is @samp{;}.
17391
17392
17393 @end table
17394
17395
17396 @node The End
17397 @chapter The End
17398
17399 Well, that's the manual---you can get on with your life now.  Keep in
17400 touch.  Say hello to your cats from me.
17401
17402 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
17403
17404 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
17405
17406 @quotation
17407 @strong{Te Deum}
17408
17409 @sp 1
17410 Not because of victories @*
17411 I sing,@*
17412 having none,@*
17413 but for the common sunshine,@*
17414 the breeze,@*
17415 the largess of the spring.
17416
17417 @sp 1
17418 Not for victory@*
17419 but for the day's work done@*
17420 as well as I was able;@*
17421 not for a seat upon the dais@*
17422 but at the common table.@*
17423 @end quotation
17424
17425
17426 @node Appendices
17427 @chapter Appendices
17428
17429 @menu
17430 * History::                        How Gnus got where it is today.
17431 * Terminology::                    We use really difficult, like, words here.
17432 * Customization::                  Tailoring Gnus to your needs.
17433 * Troubleshooting::                What you might try if things do not work.
17434 * Gnus Reference Guide::           Rilly, rilly technical stuff.
17435 * Emacs for Heathens::             A short introduction to Emacsian terms.
17436 * Frequently Asked Questions::     A question-and-answer session.
17437 @end menu
17438
17439
17440 @node History
17441 @section History
17442
17443 @cindex history
17444 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
17445 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
17446
17447 If you want to investigate the person responsible for this outrage, you
17448 can point your (feh!) web browser to
17449 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
17450 distribution point for the new and spiffy versions of Gnus, and is known
17451 as The Site That Destroys Newsrcs And Drives People Mad.
17452
17453 During the first extended alpha period of development, the new Gnus was
17454 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
17455 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
17456 (Besides, the ``Gnus'' in this abbreviation should probably be
17457 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
17458 appropriate name, don't you think?)
17459
17460 In any case, after spending all that energy on coming up with a new and
17461 spunky name, we decided that the name was @emph{too} spunky, so we
17462 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
17463 ``@sc{gnus}''.  New vs. old.
17464
17465 The first ``proper'' release of Gnus 5 was done in November 1995 when it
17466 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
17467 plus 15 Gnus 5.0 releases).
17468
17469 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
17470 releases)) was released under the name ``Gnus 5.2'' (40 releases).
17471
17472 On July 28th 1996 work on Red Gnus was begun, and it was released on
17473 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
17474
17475 On September 13th 1997, Quassia Gnus was started and lasted 37
17476 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
17477
17478 If you happen upon a version of Gnus that has a prefixed name --
17479 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
17480 don't panic.  Don't let it know that you're frightened.  Back away.
17481 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
17482 out of its reach.  Find a proper released version of Gnus and snuggle up
17483 to that instead.
17484
17485 @menu
17486 * Why?::                What's the point of Gnus?
17487 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
17488 * Conformity::          Gnus tries to conform to all standards.
17489 * Emacsen::             Gnus can be run on a few modern Emacsen.
17490 * Gnus Development::    How Gnus is developed.
17491 * Contributors::        Oodles of people.
17492 * New Features::        Pointers to some of the new stuff in Gnus.
17493 * Newest Features::     Features so new that they haven't been written yet.
17494 @end menu
17495
17496
17497 @node Why?
17498 @subsection Why?
17499
17500 What's the point of Gnus?
17501
17502 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
17503 newsreader, that lets you do anything you can think of.  That was my
17504 original motivation, but while working on Gnus, it has become clear to
17505 me that this generation of newsreaders really belong in the stone age.
17506 Newsreaders haven't developed much since the infancy of the net.  If the
17507 volume continues to rise with the current rate of increase, all current
17508 newsreaders will be pretty much useless.  How do you deal with
17509 newsgroups that have thousands of new articles each day?  How do you
17510 keep track of millions of people who post?
17511
17512 Gnus offers no real solutions to these questions, but I would very much
17513 like to see Gnus being used as a testing ground for new methods of
17514 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
17515 to separate the newsreader from the backends, Gnus now offers a simple
17516 interface for anybody who wants to write new backends for fetching mail
17517 and news from different sources.  I have added hooks for customizations
17518 everywhere I could imagine it being useful.  By doing so, I'm inviting
17519 every one of you to explore and invent.
17520
17521 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
17522 @kbd{C-u 100 M-x all-hail-xemacs}.
17523
17524
17525 @node Compatibility
17526 @subsection Compatibility
17527
17528 @cindex compatibility
17529 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
17530 bindings have been kept.  More key bindings have been added, of course,
17531 but only in one or two obscure cases have old bindings been changed.
17532
17533 Our motto is:
17534 @quotation
17535 @cartouche
17536 @center In a cloud bones of steel.
17537 @end cartouche
17538 @end quotation
17539
17540 All commands have kept their names.  Some internal functions have changed
17541 their names.
17542
17543 The @code{gnus-uu} package has changed drastically. @xref{Decoding
17544 Articles}.
17545
17546 One major compatibility question is the presence of several summary
17547 buffers.  All variables relevant while reading a group are
17548 buffer-local to the summary buffer they belong in.  Although many
17549 important variables have their values copied into their global
17550 counterparts whenever a command is executed in the summary buffer, this
17551 change might lead to incorrect values being used unless you are careful.
17552
17553 All code that relies on knowledge of @sc{gnus} internals will probably
17554 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
17555 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
17556 maintains a hash table that points to the entries in this alist (which
17557 speeds up many functions), and changing the alist directly will lead to
17558 peculiar results.
17559
17560 @cindex hilit19
17561 @cindex highlighting
17562 Old hilit19 code does not work at all.  In fact, you should probably
17563 remove all hilit code from all Gnus hooks
17564 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
17565 Gnus provides various integrated functions for highlighting.  These are
17566 faster and more accurate.  To make life easier for everybody, Gnus will
17567 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
17568 Away!
17569
17570 Packages like @code{expire-kill} will no longer work.  As a matter of
17571 fact, you should probably remove all old @sc{gnus} packages (and other
17572 code) when you start using Gnus.  More likely than not, Gnus already
17573 does what you have written code to make @sc{gnus} do.  (Snicker.)
17574
17575 Even though old methods of doing things are still supported, only the
17576 new methods are documented in this manual.  If you detect a new method of
17577 doing something while reading this manual, that does not mean you have
17578 to stop doing it the old way.
17579
17580 Gnus understands all @sc{gnus} startup files.
17581
17582 @kindex M-x gnus-bug
17583 @findex gnus-bug
17584 @cindex reporting bugs
17585 @cindex bugs
17586 Overall, a casual user who hasn't written much code that depends on
17587 @sc{gnus} internals should suffer no problems.  If problems occur,
17588 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
17589
17590 @vindex gnus-bug-create-help-buffer
17591 If you are in the habit of sending bug reports @emph{very} often, you
17592 may find the helpful help buffer annoying after a while.  If so, set
17593 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
17594 up at you.
17595
17596
17597 @node Conformity
17598 @subsection Conformity
17599
17600 No rebels without a clue here, ma'am.  We conform to all standards known
17601 to (wo)man.  Except for those standards and/or conventions we disagree
17602 with, of course.
17603
17604 @table @strong
17605
17606 @item RFC 822
17607 @cindex RFC 822
17608 There are no known breaches of this standard.
17609
17610 @item RFC 1036
17611 @cindex RFC 1036
17612 There are no known breaches of this standard, either.
17613
17614 @item Son-of-RFC 1036
17615 @cindex Son-of-RFC 1036
17616 We do have some breaches to this one.
17617
17618 @table @emph
17619
17620 @item X-Newsreader
17621 @itemx User-Agent
17622 These are considered to be ``vanity headers'', while I consider them
17623 to be consumer information.  After seeing so many badly formatted
17624 articles coming from @code{tin} and @code{Netscape} I know not to use
17625 either of those for posting articles.  I would not have known that if
17626 it wasn't for the @code{X-Newsreader} header.
17627 @end table
17628
17629 @item USEFOR
17630 @cindex USEFOR
17631 USEFOR is an IETF working group writing a successor to RFC 1036, based
17632 on Son-of-RFC 1036.  They have produced a number of drafts proposing
17633 various changes to the format of news articles.  The Gnus towers will
17634 look into implementing the changes when the draft is accepted as an RFC.
17635
17636 @end table
17637
17638 If you ever notice Gnus acting non-compliant with regards to the texts
17639 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
17640 know.
17641
17642
17643 @node Emacsen
17644 @subsection Emacsen
17645 @cindex Emacsen
17646 @cindex XEmacs
17647 @cindex Mule
17648 @cindex Emacs
17649
17650 Gnus should work on :
17651
17652 @itemize @bullet
17653
17654 @item
17655 Emacs 20.3 and up.
17656
17657 @item
17658 XEmacs 20.4 and up.
17659
17660 @end itemize
17661
17662 This Gnus version will absolutely not work on any Emacsen older than
17663 that.  Not reliably, at least.  Older versions of Gnus may work on older
17664 Emacs versions.
17665
17666 There are some vague differences between Gnus on the various
17667 platforms---XEmacs features more graphics (a logo and a toolbar)---but
17668 other than that, things should look pretty much the same under all
17669 Emacsen.
17670
17671
17672 @node Gnus Development
17673 @subsection Gnus Development
17674
17675 Gnus is developed in a two-phased cycle.  The first phase involves much
17676 discussion on the @samp{ding@@gnus.org} mailing list, where people
17677 propose changes and new features, post patches and new backends.  This
17678 phase is called the @dfn{alpha} phase, since the Gnusae released in this
17679 phase are @dfn{alpha releases}, or (perhaps more commonly in other
17680 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
17681 unstable and should not be used by casual users.  Gnus alpha releases
17682 have names like ``Red Gnus'' and ``Quassia Gnus''.
17683
17684 After futzing around for 50-100 alpha releases, Gnus is declared
17685 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
17686 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
17687 supposed to be able to use these, and these are mostly discussed on the
17688 @samp{gnu.emacs.gnus} newsgroup.
17689
17690 @cindex Incoming*
17691 @vindex nnmail-delete-incoming
17692 Some variable defaults differ between alpha Gnusae and released Gnusae.
17693 In particular, @code{nnmail-delete-incoming} defaults to @code{nil} in
17694 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
17695 lossage of mail if an alpha release hiccups while handling the mail.
17696
17697 The division of discussion between the ding mailing list and the Gnus
17698 newsgroup is not purely based on publicity concerns.  It's true that
17699 having people write about the horrible things that an alpha Gnus release
17700 can do (sometimes) in a public forum may scare people off, but more
17701 importantly, talking about new experimental features that have been
17702 introduced may confuse casual users.  New features are frequently
17703 introduced, fiddled with, and judged to be found wanting, and then
17704 either discarded or totally rewritten.  People reading the mailing list
17705 usually keep up with these rapid changes, whille people on the newsgroup
17706 can't be assumed to do so.
17707
17708
17709
17710 @node Contributors
17711 @subsection Contributors
17712 @cindex contributors
17713
17714 The new Gnus version couldn't have been done without the help of all the
17715 people on the (ding) mailing list.  Every day for over a year I have
17716 gotten billions of nice bug reports from them, filling me with joy,
17717 every single one of them.  Smooches.  The people on the list have been
17718 tried beyond endurance, what with my ``oh, that's a neat idea <type
17719 type>, yup, I'll release it right away <ship off> no wait, that doesn't
17720 work at all <type type>, yup, I'll ship that one off right away <ship
17721 off> no, wait, that absolutely does not work'' policy for releases.
17722 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
17723 ``worser''? ``much worser''?  ``worsest''?)
17724
17725 I would like to take this opportunity to thank the Academy for...  oops,
17726 wrong show.
17727
17728 @itemize @bullet
17729
17730 @item
17731 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
17732
17733 @item
17734 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
17735 well as numerous other things).
17736
17737 @item
17738 Luis Fernandes---design and graphics.
17739
17740 @item
17741 Erik Naggum---help, ideas, support, code and stuff.
17742
17743 @item
17744 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
17745 connected with @sc{mime} and other types of en/decoding.
17746
17747 @item
17748 Wes Hardaker---@file{gnus-picon.el} and the manual section on
17749 @dfn{picons} (@pxref{Picons}).
17750
17751 @item
17752 Kim-Minh Kaplan---further work on the picon code.
17753
17754 @item
17755 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
17756 (@pxref{GroupLens}).
17757
17758 @item
17759 Sudish Joseph---innumerable bug fixes.
17760
17761 @item
17762 Ilja Weis---@file{gnus-topic.el}.
17763
17764 @item
17765 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
17766
17767 @item
17768 Vladimir Alexiev---the refcard and reference booklets.
17769
17770 @item
17771 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
17772 distribution by Felix Lee and JWZ.
17773
17774 @item
17775 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
17776
17777 @item
17778 Peter Mutsaers---orphan article scoring code.
17779
17780 @item
17781 Ken Raeburn---POP mail support.
17782
17783 @item
17784 Hallvard B Furuseth---various bits and pieces, especially dealing with
17785 .newsrc files.
17786
17787 @item
17788 Brian Edmonds---@file{gnus-bbdb.el}.
17789
17790 @item
17791 David Moore---rewrite of @file{nnvirtual.el} and many other things.
17792
17793 @item
17794 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
17795
17796 @item
17797 Fran\e-Açois Pinard---many, many interesting and thorough bug reports, as\e$)A
17798 well as autoconf support.
17799
17800 @end itemize
17801
17802 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
17803 Borges, and Jost Krieger proof-reading parts of the manual.
17804
17805 The following people have contributed many patches and suggestions:
17806
17807 Christopher Davis,
17808 Andrew Eskilsson,
17809 Kai Grossjohann,
17810 David K\e-AÃ¥gedal,\e$)A
17811 Richard Pieri,
17812 Fabrice Popineau,
17813 Daniel Quinlan,
17814 Jason L. Tibbitts, III,
17815 and
17816 Jack Vinson.
17817
17818 Also thanks to the following for patches and stuff:
17819
17820 Jari Aalto,
17821 Adrian Aichner,
17822 Vladimir Alexiev,
17823 Russ Allbery,
17824 Peter Arius,
17825 Matt Armstrong,
17826 Marc Auslander,
17827 Miles Bader,
17828 Alexei V. Barantsev,
17829 Frank Bennett,
17830 Robert Bihlmeyer,
17831 Chris Bone,
17832 Mark Borges,
17833 Mark Boyns,
17834 Lance A. Brown,
17835 Rob Browning,
17836 Kees de Bruin,
17837 Martin Buchholz,
17838 Joe Buehler,
17839 Kevin Buhr,
17840 Alastair Burt,
17841 Joao Cachopo,
17842 Zlatko Calusic,
17843 Massimo Campostrini,
17844 Castor,
17845 David Charlap,
17846 Dan Christensen,
17847 Kevin Christian,
17848 Jae-you Chung, @c ?
17849 James H. Cloos, Jr.,
17850 Laura Conrad,
17851 Michael R. Cook,
17852 Glenn Coombs,
17853 Andrew J. Cosgriff,
17854 Neil Crellin,
17855 Frank D. Cringle,
17856 Geoffrey T. Dairiki,
17857 Andre Deparade,
17858 Ulrik Dickow,
17859 Dave Disser,
17860 Rui-Tao Dong, @c ?
17861 Joev Dubach,
17862 Michael Welsh Duggan,
17863 Dave Edmondson,
17864 Paul Eggert,
17865 Mark W. Eichin,
17866 Karl Eichwalder,
17867 Enami Tsugutomo, @c Enami
17868 Michael Ernst,
17869 Luc Van Eycken,
17870 Sam Falkner,
17871 Nelson Jose dos Santos Ferreira,
17872 Sigbjorn Finne,
17873 Sven Fischer,
17874 Paul Fisher,
17875 Decklin Foster,
17876 Gary D. Foster,
17877 Paul Franklin,
17878 Guy Geens,
17879 Arne Georg Gleditsch,
17880 David S. Goldberg,
17881 Michelangelo Grigni,
17882 Dale Hagglund,
17883 D. Hall,
17884 Magnus Hammerin,
17885 Kenichi Handa, @c Handa
17886 Raja R. Harinath,
17887 Yoshiki Hayashi, @c ?
17888 P. E. Jareth Hein,
17889 Hisashige Kenji, @c Hisashige
17890 Scott Hofmann,
17891 Marc Horowitz,
17892 Gunnar Horrigmo,
17893 Richard Hoskins,
17894 Brad Howes,
17895 Miguel de Icaza,
17896 Fran\e-Açois Felix Ingrand,\e$)A
17897 Tatsuya Ichikawa, @c ?
17898 Ishikawa Ichiro, @c Ishikawa
17899 Lee Iverson,
17900 Iwamuro Motonori, @c Iwamuro
17901 Rajappa Iyer,
17902 Andreas Jaeger,
17903 Adam P. Jenkins,
17904 Randell Jesup,
17905 Fred Johansen,
17906 Gareth Jones,
17907 Simon Josefsson,
17908 Greg Klanderman,
17909 Karl Kleinpaste,
17910 Michael Klingbeil,
17911 Peter Skov Knudsen,
17912 Shuhei Kobayashi, @c Kobayashi
17913 Petr Konecny,
17914 Koseki Yoshinori, @c Koseki
17915 Thor Kristoffersen,
17916 Jens Lautenbacher,
17917 Martin Larose,
17918 Seokchan Lee, @c Lee
17919 Joerg Lenneis,
17920 Carsten Leonhardt,
17921 James LewisMoss,
17922 Christian Limpach,
17923 Markus Linnala,
17924 Dave Love,
17925 Mike McEwan,
17926 Tonny Madsen,
17927 Shlomo Mahlab,
17928 Nat Makarevitch,
17929 Istvan Marko,
17930 David Martin,
17931 Jason R. Mastaler,
17932 Gordon Matzigkeit,
17933 Timo Metzemakers,
17934 Richard Mlynarik,
17935 Lantz Moore,
17936 Morioka Tomohiko, @c Morioka
17937 Erik Toubro Nielsen,
17938 Hrvoje Niksic,
17939 Andy Norman,
17940 Fred Oberhauser,
17941 C. R. Oldham,
17942 Alexandre Oliva,
17943 Ken Olstad,
17944 Masaharu Onishi, @c Onishi
17945 Hideki Ono, @c Ono
17946 Ettore Perazzoli,
17947 William Perry,
17948 Stephen Peters,
17949 Jens-Ulrik Holger Petersen,
17950 Ulrich Pfeifer,
17951 Matt Pharr,
17952 Andy Piper,
17953 John McClary Prevost,
17954 Bill Pringlemeir,
17955 Mike Pullen,
17956 Jim Radford,
17957 Colin Rafferty,
17958 Lasse Rasinen,
17959 Lars Balker Rasmussen,
17960 Joe Reiss,
17961 Renaud Rioboo,
17962 Roland B. Roberts,
17963 Bart Robinson,
17964 Christian von Roques,
17965 Markus Rost,
17966 Jason Rumney,
17967 Wolfgang Rupprecht,
17968 Jay Sachs,
17969 Dewey M. Sasser,
17970 Conrad Sauerwald,
17971 Loren Schall,
17972 Dan Schmidt,
17973 Ralph Schleicher,
17974 Philippe Schnoebelen,
17975 Andreas Schwab,
17976 Randal L. Schwartz,
17977 Justin Sheehy,
17978 Danny Siu,
17979 Matt Simmons,
17980 Paul D. Smith,
17981 Jeff Sparkes,
17982 Toby Speight,
17983 Michael Sperber,
17984 Darren Stalder,
17985 Richard Stallman,
17986 Greg Stark,
17987 Sam Steingold,
17988 Paul Stevenson,
17989 Jonas Steverud,
17990 Paul Stodghill,
17991 Kiyokazu Suto, @c Suto
17992 Kurt Swanson,
17993 Samuel Tardieu,
17994 Teddy,
17995 Chuck Thompson,
17996 Tozawa Akihiko, @c Tozawa
17997 Philippe Troin,
17998 James Troup,
17999 Trung Tran-Duc,
18000 Jack Twilley,
18001 Aaron M. Ucko,
18002 Aki Vehtari,
18003 Didier Verna,
18004 Vladimir Volovich,
18005 Jan Vroonhof,
18006 Stefan Waldherr,
18007 Pete Ware,
18008 Barry A. Warsaw,
18009 Christoph Wedler,
18010 Joe Wells,
18011 Lee Willis,
18012 Katsumi Yamaoka @c Yamaoka
18013 and
18014 Lloyd Zusman.
18015
18016
18017 For a full overview of what each person has done, the ChangeLogs
18018 included in the Gnus alpha distributions should give ample reading
18019 (550kB and counting).
18020
18021 Apologies to everybody that I've forgotten, of which there are many, I'm
18022 sure.
18023
18024 Gee, that's quite a list of people.  I guess that must mean that there
18025 actually are people who are using Gnus.  Who'd'a thunk it!
18026
18027
18028 @node New Features
18029 @subsection New Features
18030 @cindex new features
18031
18032 @menu
18033 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
18034 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
18035 * Red Gnus::           Third time best---Gnus 5.4/5.5.
18036 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
18037 @end menu
18038
18039 These lists are, of course, just @emph{short} overviews of the
18040 @emph{most} important new features.  No, really.  There are tons more.
18041 Yes, we have feeping creaturism in full effect.
18042
18043
18044 @node ding Gnus
18045 @subsubsection (ding) Gnus
18046
18047 New features in Gnus 5.0/5.1:
18048
18049 @itemize @bullet
18050
18051 @item
18052 The look of all buffers can be changed by setting format-like variables
18053 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
18054
18055 @item
18056 Local spool and several @sc{nntp} servers can be used at once
18057 (@pxref{Select Methods}).
18058
18059 @item
18060 You can combine groups into virtual groups (@pxref{Virtual Groups}).
18061
18062 @item
18063 You can read a number of different mail formats (@pxref{Getting Mail}).
18064 All the mail backends implement a convenient mail expiry scheme
18065 (@pxref{Expiring Mail}).
18066
18067 @item
18068 Gnus can use various strategies for gathering threads that have lost
18069 their roots (thereby gathering loose sub-threads into one thread) or it
18070 can go back and retrieve enough headers to build a complete thread
18071 (@pxref{Customizing Threading}).
18072
18073 @item
18074 Killed groups can be displayed in the group buffer, and you can read
18075 them as well (@pxref{Listing Groups}).
18076
18077 @item
18078 Gnus can do partial group updates---you do not have to retrieve the
18079 entire active file just to check for new articles in a few groups
18080 (@pxref{The Active File}).
18081
18082 @item
18083 Gnus implements a sliding scale of subscribedness to groups
18084 (@pxref{Group Levels}).
18085
18086 @item
18087 You can score articles according to any number of criteria
18088 (@pxref{Scoring}).  You can even get Gnus to find out how to score
18089 articles for you (@pxref{Adaptive Scoring}).
18090
18091 @item
18092 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
18093 manner, so it should be difficult to lose much data on what you have
18094 read if your machine should go down (@pxref{Auto Save}).
18095
18096 @item
18097 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
18098 the @file{.emacs} file.
18099
18100 @item
18101 You can set the process mark on both groups and articles and perform
18102 operations on all the marked items (@pxref{Process/Prefix}).
18103
18104 @item
18105 You can grep through a subset of groups and create a group from the
18106 results (@pxref{Kibozed Groups}).
18107
18108 @item
18109 You can list subsets of groups according to, well, anything
18110 (@pxref{Listing Groups}).
18111
18112 @item
18113 You can browse foreign servers and subscribe to groups from those
18114 servers (@pxref{Browse Foreign Server}).
18115
18116 @item
18117 Gnus can fetch articles, asynchronously, on a second connection to the
18118 server (@pxref{Asynchronous Fetching}).
18119
18120 @item
18121 You can cache articles locally (@pxref{Article Caching}).
18122
18123 @item
18124 The uudecode functions have been expanded and generalized
18125 (@pxref{Decoding Articles}).
18126
18127 @item
18128 You can still post uuencoded articles, which was a little-known feature
18129 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
18130
18131 @item
18132 Fetching parents (and other articles) now actually works without
18133 glitches (@pxref{Finding the Parent}).
18134
18135 @item
18136 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
18137
18138 @item
18139 Digests (and other files) can be used as the basis for groups
18140 (@pxref{Document Groups}).
18141
18142 @item
18143 Articles can be highlighted and customized (@pxref{Customizing
18144 Articles}).
18145
18146 @item
18147 URLs and other external references can be buttonized (@pxref{Article
18148 Buttons}).
18149
18150 @item
18151 You can do lots of strange stuff with the Gnus window & frame
18152 configuration (@pxref{Windows Configuration}).
18153
18154 @item
18155 You can click on buttons instead of using the keyboard
18156 (@pxref{Buttons}).
18157
18158 @end itemize
18159
18160
18161 @node September Gnus
18162 @subsubsection September Gnus
18163
18164 @iftex
18165 @iflatex
18166 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
18167 @end iflatex
18168 @end iftex
18169
18170 New features in Gnus 5.2/5.3:
18171
18172 @itemize @bullet
18173
18174 @item
18175 A new message composition mode is used.  All old customization variables
18176 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
18177 now obsolete.
18178
18179 @item
18180 Gnus is now able to generate @dfn{sparse} threads---threads where
18181 missing articles are represented by empty nodes (@pxref{Customizing
18182 Threading}).
18183
18184 @lisp
18185 (setq gnus-build-sparse-threads 'some)
18186 @end lisp
18187
18188 @item
18189 Outgoing articles are stored on a special archive server
18190 (@pxref{Archived Messages}).
18191
18192 @item
18193 Partial thread regeneration now happens when articles are
18194 referred.
18195
18196 @item
18197 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
18198
18199 @item
18200 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
18201
18202 @item
18203 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
18204
18205 @lisp
18206 (setq gnus-use-trees t)
18207 @end lisp
18208
18209 @item
18210 An @code{nn}-like pick-and-read minor mode is available for the summary
18211 buffers (@pxref{Pick and Read}).
18212
18213 @lisp
18214 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
18215 @end lisp
18216
18217 @item
18218 In binary groups you can use a special binary minor mode (@pxref{Binary
18219 Groups}).
18220
18221 @item
18222 Groups can be grouped in a folding topic hierarchy (@pxref{Group
18223 Topics}).
18224
18225 @lisp
18226 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
18227 @end lisp
18228
18229 @item
18230 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
18231
18232 @item
18233 Groups can now have a score, and bubbling based on entry frequency
18234 is possible (@pxref{Group Score}).
18235
18236 @lisp
18237 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
18238 @end lisp
18239
18240 @item
18241 Groups can be process-marked, and commands can be performed on
18242 groups of groups (@pxref{Marking Groups}).
18243
18244 @item
18245 Caching is possible in virtual groups.
18246
18247 @item
18248 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
18249 news batches, ClariNet briefs collections, and just about everything
18250 else (@pxref{Document Groups}).
18251
18252 @item
18253 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
18254 (@pxref{SOUP}).
18255
18256 @item
18257 The Gnus cache is much faster.
18258
18259 @item
18260 Groups can be sorted according to many criteria (@pxref{Sorting
18261 Groups}).
18262
18263 @item
18264 New group parameters have been introduced to set list-addresses and
18265 expiry times (@pxref{Group Parameters}).
18266
18267 @item
18268 All formatting specs allow specifying faces to be used
18269 (@pxref{Formatting Fonts}).
18270
18271 @item
18272 There are several more commands for setting/removing/acting on process
18273 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
18274
18275 @item
18276 The summary buffer can be limited to show parts of the available
18277 articles based on a wide range of criteria.  These commands have been
18278 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
18279
18280 @item
18281 Articles can be made persistent with the @kbd{*} command
18282 (@pxref{Persistent Articles}).
18283
18284 @item
18285 All functions for hiding article elements are now toggles.
18286
18287 @item
18288 Article headers can be buttonized (@pxref{Article Washing}).
18289
18290 @item
18291 All mail backends support fetching articles by @code{Message-ID}.
18292
18293 @item
18294 Duplicate mail can now be treated properly (@pxref{Duplicates}).
18295
18296 @item
18297 All summary mode commands are available directly from the article
18298 buffer (@pxref{Article Keymap}).
18299
18300 @item
18301 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
18302 Configuration}).
18303
18304 @item
18305 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
18306 @iftex
18307 @iflatex
18308 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
18309 @end iflatex
18310 @end iftex
18311
18312 @item
18313 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
18314
18315 @lisp
18316 (setq gnus-use-nocem t)
18317 @end lisp
18318
18319 @item
18320 Groups can be made permanently visible (@pxref{Listing Groups}).
18321
18322 @lisp
18323 (setq gnus-permanently-visible-groups "^nnml:")
18324 @end lisp
18325
18326 @item
18327 Many new hooks have been introduced to make customizing easier.
18328
18329 @item
18330 Gnus respects the @code{Mail-Copies-To} header.
18331
18332 @item
18333 Threads can be gathered by looking at the @code{References} header
18334 (@pxref{Customizing Threading}).
18335
18336 @lisp
18337 (setq gnus-summary-thread-gathering-function
18338       'gnus-gather-threads-by-references)
18339 @end lisp
18340
18341 @item
18342 Read articles can be stored in a special backlog buffer to avoid
18343 refetching (@pxref{Article Backlog}).
18344
18345 @lisp
18346 (setq gnus-keep-backlog 50)
18347 @end lisp
18348
18349 @item
18350 A clean copy of the current article is always stored in a separate
18351 buffer to allow easier treatment.
18352
18353 @item
18354 Gnus can suggest where to save articles (@pxref{Saving Articles}).
18355
18356 @item
18357 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
18358 Articles}).
18359
18360 @lisp
18361 (setq gnus-prompt-before-saving t)
18362 @end lisp
18363
18364 @item
18365 @code{gnus-uu} can view decoded files asynchronously while fetching
18366 articles (@pxref{Other Decode Variables}).
18367
18368 @lisp
18369 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
18370 @end lisp
18371
18372 @item
18373 Filling in the article buffer now works properly on cited text
18374 (@pxref{Article Washing}).
18375
18376 @item
18377 Hiding cited text adds buttons to toggle hiding, and how much
18378 cited text to hide is now customizable (@pxref{Article Hiding}).
18379
18380 @lisp
18381 (setq gnus-cited-lines-visible 2)
18382 @end lisp
18383
18384 @item
18385 Boring headers can be hidden (@pxref{Article Hiding}).
18386
18387 @item
18388 Default scoring values can now be set from the menu bar.
18389
18390 @item
18391 Further syntax checking of outgoing articles have been added.
18392
18393 @end itemize
18394
18395
18396 @node Red Gnus
18397 @subsubsection Red Gnus
18398
18399 New features in Gnus 5.4/5.5:
18400
18401 @iftex
18402 @iflatex
18403 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
18404 @end iflatex
18405 @end iftex
18406
18407 @itemize @bullet
18408
18409 @item
18410 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
18411
18412 @item
18413 Article prefetching functionality has been moved up into
18414 Gnus (@pxref{Asynchronous Fetching}).
18415
18416 @item
18417 Scoring can now be performed with logical operators like @code{and},
18418 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
18419 Scoring}).
18420
18421 @item
18422 Article washing status can be displayed in the
18423 article mode line (@pxref{Misc Article}).
18424
18425 @item
18426 @file{gnus.el} has been split into many smaller files.
18427
18428 @item
18429 Suppression of duplicate articles based on Message-ID can be done
18430 (@pxref{Duplicate Suppression}).
18431
18432 @lisp
18433 (setq gnus-suppress-duplicates t)
18434 @end lisp
18435
18436 @item
18437 New variables for specifying what score and adapt files are to be
18438 considered home score and adapt files (@pxref{Home Score File}) have
18439 been added.
18440
18441 @item
18442 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
18443 Server Internals}).
18444
18445 @item
18446 Groups can inherit group parameters from parent topics (@pxref{Topic
18447 Parameters}).
18448
18449 @item
18450 Article editing has been revamped and is now actually usable.
18451
18452 @item
18453 Signatures can be recognized in more intelligent fashions
18454 (@pxref{Article Signature}).
18455
18456 @item
18457 Summary pick mode has been made to look more @code{nn}-like.  Line
18458 numbers are displayed and the @kbd{.} command can be used to pick
18459 articles (@code{Pick and Read}).
18460
18461 @item
18462 Commands for moving the @file{.newsrc.eld} from one server to
18463 another have been added (@pxref{Changing Servers}).
18464
18465 @item
18466 There's a way now to specify that ``uninteresting'' fields be suppressed
18467 when generating lines in buffers (@pxref{Advanced Formatting}).
18468
18469 @item
18470 Several commands in the group buffer can be undone with @kbd{M-C-_}
18471 (@pxref{Undo}).
18472
18473 @item
18474 Scoring can be done on words using the new score type @code{w}
18475 (@pxref{Score File Format}).
18476
18477 @item
18478 Adaptive scoring can be done on a Subject word-by-word basis
18479 (@pxref{Adaptive Scoring}).
18480
18481 @lisp
18482 (setq gnus-use-adaptive-scoring '(word))
18483 @end lisp
18484
18485 @item
18486 Scores can be decayed (@pxref{Score Decays}).
18487
18488 @lisp
18489 (setq gnus-decay-scores t)
18490 @end lisp
18491
18492 @item
18493 Scoring can be performed using a regexp on the Date header.  The Date is
18494 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
18495
18496 @item
18497 A new command has been added to remove all data on articles from
18498 the native server (@pxref{Changing Servers}).
18499
18500 @item
18501 A new command for reading collections of documents
18502 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
18503 (@pxref{Really Various Summary Commands}).
18504
18505 @item
18506 Process mark sets can be pushed and popped (@pxref{Setting Process
18507 Marks}).
18508
18509 @item
18510 A new mail-to-news backend makes it possible to post even when the NNTP
18511 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
18512
18513 @item
18514 A new backend for reading searches from Web search engines
18515 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
18516 (@pxref{Web Searches}).
18517
18518 @item
18519 Groups inside topics can now be sorted using the standard sorting
18520 functions, and each topic can be sorted independently (@pxref{Topic
18521 Sorting}).
18522
18523 @item
18524 Subsets of the groups can be sorted independently (@code{Sorting
18525 Groups}).
18526
18527 @item
18528 Cached articles can be pulled into the groups (@pxref{Summary Generation
18529 Commands}).
18530 @iftex
18531 @iflatex
18532 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
18533 @end iflatex
18534 @end iftex
18535
18536 @item
18537 Score files are now applied in a more reliable order (@pxref{Score
18538 Variables}).
18539
18540 @item
18541 Reports on where mail messages end up can be generated (@pxref{Splitting
18542 Mail}).
18543
18544 @item
18545 More hooks and functions have been added to remove junk from incoming
18546 mail before saving the mail (@pxref{Washing Mail}).
18547
18548 @item
18549 Emphasized text can be properly fontisized:
18550
18551 @end itemize
18552
18553
18554 @node Quassia Gnus
18555 @subsubsection Quassia Gnus
18556
18557 New features in Gnus 5.6:
18558
18559 @itemize @bullet
18560
18561 @item
18562 New functionality for using Gnus as an offline newsreader has been
18563 added.  A plethora of new commands and modes have been added.  See
18564 @pxref{Gnus Unplugged} for the full story.
18565
18566 @item
18567  The @code{nndraft} backend has returned, but works differently than
18568 before.  All Message buffers are now also articles in the @code{nndraft}
18569 group, which is created automatically.
18570
18571 @item
18572 @code{gnus-alter-header-function} can now be used to alter header
18573 values.
18574
18575 @item
18576  @code{gnus-summary-goto-article} now accept Message-ID's.
18577
18578 @item
18579  A new Message command for deleting text in the body of a message
18580 outside the region: @kbd{C-c C-v}.
18581
18582 @item
18583  You can now post to component group in @code{nnvirtual} groups with
18584 @kbd{C-u C-c C-c}.
18585
18586 @item
18587  @code{nntp-rlogin-program}---new variable to ease customization.
18588
18589 @item
18590  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
18591 re-highlighting of the article buffer.
18592
18593 @item
18594  New element in @code{gnus-boring-article-headers}---@code{long-to}.
18595
18596 @item
18597  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
18598 Prefixes" in the Gnus manual for details.
18599
18600 @item
18601  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
18602 @kbd{a} to add the score rule to the "all.SCORE" file.
18603
18604 @item
18605  @code{gnus-simplify-subject-functions} variable to allow greater
18606 control over simplification.
18607
18608 @item
18609  @kbd{A T}---new command for fetching the current thread.
18610
18611 @item
18612  @kbd{/ T}---new command for including the current thread in the
18613 limit.
18614
18615 @item
18616  @kbd{M-RET} is a new Message command for breaking cited text.
18617
18618 @item
18619  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
18620
18621 @item
18622  The @code{custom-face-lookup} function has been removed.
18623 If you used this function in your initialization files, you must
18624 rewrite them to use @code{face-spec-set} instead.
18625
18626 @item
18627  Canceling now uses the current select method.  Symbolic prefix
18628 @kbd{a} forces normal posting method.
18629
18630 @item
18631  New command to translate M******** sm*rtq**t*s into proper
18632 text---@kbd{W d}.
18633
18634 @item
18635  For easier debugging of @code{nntp}, you can set
18636 @code{nntp-record-commands} to a non-@code{nil} value.
18637
18638 @item
18639  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
18640 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
18641
18642 @item
18643  A command for editing group parameters from the summary buffer
18644 has been added.
18645
18646 @item
18647  A history of where mails have been split is available.
18648
18649 @item
18650  A new article date command has been added---@code{article-date-iso8601}.
18651
18652 @item
18653  Subjects can be simplified when threading by setting
18654 @code{gnus-score-thread-simplify}.
18655
18656 @item
18657  A new function for citing in Message has been
18658 added---@code{message-cite-original-without-signature}.
18659
18660 @item
18661  @code{article-strip-all-blank-lines}---new article command.
18662
18663 @item
18664  A new Message command to kill to the end of the article has
18665 been added.
18666
18667 @item
18668  A minimum adaptive score can be specified by using the
18669 @code{gnus-adaptive-word-minimum} variable.
18670
18671 @item
18672  The "lapsed date" article header can be kept continually
18673 updated by the @code{gnus-start-date-timer} command.
18674
18675 @item
18676  Web listserv archives can be read with the @code{nnlistserv} backend.
18677
18678 @item
18679  Old dejanews archives can now be read by @code{nnweb}.
18680
18681 @end itemize
18682
18683
18684 @node Newest Features
18685 @subsection Newest Features
18686 @cindex todo
18687
18688 Also known as the @dfn{todo list}.  Sure to be implemented before the
18689 next millennium.
18690
18691 Be afraid.  Be very afraid.
18692
18693 (That a feature appears in this list doesn't necessarily mean that I've
18694 decided to actually implement it.  It just means that I think it sounds
18695 interesting.)
18696
18697 (Yes, this is the actual, up-to-the-second todo list.)
18698
18699 @itemize @bullet
18700
18701 @item
18702  I would like the zombie-page to contain an URL to the source of the
18703 latest version of gnus or some explanation on where to find it.
18704
18705 @item
18706  A way to continue editing the latest Message composition.
18707
18708 @item
18709  http://www.sonicnet.com/feature/ari3/
18710
18711 @item
18712  facep is not declared.
18713
18714 @item
18715  Include a section in the manual on why the number of articles
18716 isn't the same in the group buffer and on the SPC prompt.
18717
18718 @item
18719  Interacting with rmail fcc isn't easy.
18720
18721 @item
18722 @example
18723  Hypermail:
18724 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
18725 <URL:http://www.eit.com/software/hypermail/hypermail.html>
18726 <URL:http://homer.ncm.com/>
18727 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
18728 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
18729 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
18730 http://www.miranova.com/gnus-list/
18731
18732 @end example
18733
18734 @item
18735 @samp{^-- } is made into - in LaTeX.
18736
18737 @item
18738  gnus-kill is much slower than it was in GNUS 4.1.3.
18739
18740 @item
18741  when expunging articles on low score, the sparse nodes keep hanging on?
18742 @item
18743  starting the first time seems to hang Gnus on some systems.  Does
18744 NEWGROUPS answer too fast?
18745 @item
18746  nndir doesn't read gzipped files.
18747 @item
18748  FAQ doesn't have an up node?
18749 @item
18750  when moving mail from a procmail spool to the crash-box,
18751 the crash-box is only appropriate to one specific group.
18752 @item
18753  `t' `t' makes X-Faces disappear.
18754 @item
18755  nnmh-be-safe means that crossposted articles will
18756 be marked as unread.
18757 @item
18758  Orphan score entries don't show on "V t" score trace
18759 @item
18760  when clearing out data, the cache data should also be reset.
18761 @item
18762  rewrite gnus-summary-limit-children to be non-recursive
18763 to avoid exceeding lisp nesting on huge groups.
18764 @item
18765  expunged articles are counted when computing scores.
18766 @item
18767  implement gnus-batch-brew-soup
18768 @item
18769  ticked articles aren't easy to read in pick mode -- `n' and
18770 stuff just skips past them.  Read articles are the same.
18771 @item
18772  topics that contain just groups with ticked
18773 articles aren't displayed.
18774 @item
18775  nndoc should always allocate unique Message-IDs.
18776 @item
18777  If there are mail groups the first time you use Gnus, Gnus'll
18778 make the mail groups killed.
18779 @item
18780  no "no news is good news" when using topics.
18781 @item
18782  when doing crosspost marking, the cache has to be consulted
18783 and articles have to be removed.
18784 @item
18785  nnweb should fetch complete articles when they are split into several
18786 parts.
18787 @item
18788  scoring on head immediate doesn't work.
18789 @item
18790  finding short score file names takes forever.
18791 @item
18792  canceling articles in foreign groups.
18793 @item
18794  nntp-open-rlogin no longer works.
18795 @item
18796  C-u C-x C-s (Summary) switches to the group buffer.
18797 @item
18798  move nnmail-split-history out to the backends.
18799 @item
18800  nnweb doesn't work properly.
18801 @item
18802  using a virtual server name as `gnus-select-method' doesn't work?
18803 @item
18804  when killing/yanking a group from one topic to another in a slave, the
18805 master will yank it first to one topic and then add it to another.
18806 Perhaps.
18807
18808 @item
18809  warn user about `=' redirection of a group in the active file?
18810 @item
18811  take over the XEmacs menubar and offer a toggle between the XEmacs
18812 bar and the Gnus bar.
18813 @item
18814 @example
18815  push active file and NOV file parsing down into C code.
18816 `(canonize-message-id id)'
18817 `(mail-parent-message-id references n)'
18818 `(parse-news-nov-line &optional dependency-hashtb)'
18819 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
18820 `(parse-news-active-region beg end hashtb)'
18821
18822 @end example
18823
18824 @item
18825  nnml .overview directory with splits.
18826 @item
18827  asynchronous cache
18828 @item
18829  postponed commands.
18830 @item
18831  the selected article show have its Subject displayed in its summary line.
18832 @item
18833  when entering groups, get the real number of unread articles from
18834 the server?
18835 @item
18836  sort after gathering threads -- make false roots have the
18837 headers of the oldest orphan with a 0 article number?
18838 @item
18839  nndoc groups should inherit the score files of their parents?  Also
18840 inherit copy prompts and save files.
18841 @item
18842  command to start up Gnus (if not running) and enter a mail mode buffer.
18843 @item
18844  allow editing the group description from the group buffer
18845 for backends that support that.
18846 @item
18847 gnus-hide,show-all-topics
18848 @item
18849  groups and sub-topics should be allowed to mingle inside each topic,
18850 and not just list all subtopics at the end.
18851 @item
18852  a command to remove all read articles that are not needed to connect
18853 threads -- `gnus-summary-limit-to-sparse-unread'?
18854 @item
18855  a variable to turn off limiting/cutting of threads in the tree buffer.
18856 @item
18857  a variable to limit how many files are uudecoded.
18858 @item
18859  add zombie groups to a special "New Groups" topic.
18860 @item
18861  server mode command: close/open all connections
18862 @item
18863  put a file date in gnus-score-alist and check whether the file
18864 has been changed before using it.
18865 @item
18866  on exit from a digest group, go to the next article in the parent group.
18867 @item
18868  hide (sub)threads with low score.
18869 @item
18870  when expiring, remove all marks from expired articles.
18871 @item
18872  gnus-summary-limit-to-body
18873 @item
18874  a regexp alist that says what level groups are to be subscribed
18875 on.  Eg. -- `(("nnml:" . 1))'.
18876 @item
18877  easier interface to nnkiboze to create ephemeral groups that
18878 contain groups that match a regexp.
18879 @item
18880  allow newlines in <URL:> urls, but remove them before using
18881 the URL.
18882 @item
18883  If there is no From line, the mail backends should fudge one from the
18884 "From " line.
18885 @item
18886  fuzzy simplifying should strip all non-alpha-numerical info
18887 from subject lines.
18888 @item
18889  gnus-soup-brew-soup-with-high-scores.
18890 @item
18891  nntp-ping-before-connect
18892 @item
18893  command to check whether NOV is evil.  "list overview.fmt".
18894 @item
18895  when entering a group, Gnus should look through the score
18896 files very early for `local' atoms and set those local variables.
18897 @item
18898  message annotations.
18899 @item
18900  topics are always yanked before groups, and that's not good.
18901 @item
18902  (set-extent-property extent 'help-echo "String to display in minibuf")
18903 to display help in the minibuffer on buttons under XEmacs.
18904 @item
18905  allow group line format spec to say how many articles there
18906 are in the cache.
18907 @item
18908  AUTHINFO GENERIC
18909 @item
18910  `run-with-idle-timer' in gnus-demon.
18911 @item
18912  stop using invisible text properties and start using overlays instead
18913 @item
18914  C-c C-f C-e to add an Expires header.
18915 @item
18916  go from one group to the next; everything is expunged; go to the
18917 next group instead of going to the group buffer.
18918 @item
18919  gnus-renumber-cache -- to renumber the cache using "low" numbers.
18920 @item
18921  record topic changes in the dribble buffer.
18922 @item
18923  `nnfolder-generate-active-file' should look at the folders it
18924 finds and generate proper active ranges.
18925 @item
18926  nneething-look-in-files-for-article-heads variable to control
18927 whether nneething should sniff all files in the directories.
18928 @item
18929  gnus-fetch-article -- start Gnus, enter group, display article
18930 @item
18931  gnus-dont-move-articles-to-same-group variable when respooling.
18932 @item
18933  when messages are crossposted between several auto-expirable groups,
18934 articles aren't properly marked as expirable.
18935 @item
18936  nneething should allow deletion/moving.
18937 @item
18938  TAB on the last button should go to the first button.
18939 @item
18940  if the car of an element in `mail-split-methods' is a function,
18941 and the function returns non-nil, use that as the name of the group(s) to
18942 save mail in.
18943 @item
18944  command for listing all score files that have been applied.
18945 @item
18946  a command in the article buffer to return to `summary' config.
18947 @item
18948  `gnus-always-post-using-current-server' -- variable to override
18949 `C-c C-c' when posting.
18950 @item
18951  nnmail-group-spool-alist -- says where each group should use
18952 as a spool file.
18953 @item
18954  when an article is crossposted to an auto-expirable group, the article
18955 should be marker as expirable.
18956 @item
18957  article mode command/menu for "send region as URL to browser".
18958 @item
18959  on errors, jump to info nodes that explain the error.  For instance,
18960 on invalid From headers, or on error messages from the nntp server.
18961 @item
18962  when gathering threads, make the article that has no "Re: " the parent.
18963 Also consult Date headers.
18964 @item
18965  a token in splits to call shrink-window-if-larger-than-buffer
18966 @item
18967  `1 0 A M' to do matches on the active hashtb.
18968 @item
18969  duplicates -- command to remove Gnus-Warning header, use the read
18970 Message-ID, delete the "original".
18971 @item
18972  when replying to several messages at once, put the "other" message-ids
18973 into a See-Also header.
18974 @item
18975  support setext: URL:http://www.bsdi.com/setext/
18976 @item
18977  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
18978 @item
18979  when browsing a foreign server, the groups that are already subscribed
18980 should be listed as such and not as "K".
18981 @item
18982  generate font names dynamically.
18983 @item
18984  score file mode auto-alist.
18985 @item
18986  allow nndoc to change/add/delete things from documents.  Implement
18987 methods for each format for adding an article to the document.
18988 @item
18989  `gnus-fetch-old-headers' `all' value to incorporate
18990 absolutely all headers there is.
18991 @item
18992  function like `|', but concatenate all marked articles
18993 and pipe them to the process.
18994 @item
18995  cache the list of killed (or active) groups in a separate file.  Update
18996 the file whenever we read the active file or the list
18997 of killed groups in the .eld file reaches a certain length.
18998 @item
18999  function for starting to edit a file to put into
19000 the current mail group.
19001 @item
19002  score-find-trace should display the total score of the article.
19003 @item
19004  "ghettozie" -- score on Xref header and nix it out after using it
19005 to avoid marking as read in other groups it has been crossposted to.
19006 @item
19007  look at procmail splitting.  The backends should create
19008 the groups automatically if a spool file exists for that group.
19009 @item
19010  function for backends to register themselves with Gnus.
19011 @item
19012  when replying to several process-marked articles,
19013 have all the From end up in Cc headers?  Variable to toggle.
19014 @item
19015  command to delete a crossposted mail article from all
19016 groups it has been mailed to.
19017 @item
19018  `B c' and `B m' should be crosspost aware.
19019 @item
19020  hide-pgp should also hide PGP public key blocks.
19021 @item
19022  Command in the group buffer to respool process-marked groups.
19023 @item
19024  `gnus-summary-find-matching' should accept
19025 pseudo-"headers" like "body", "head" and "all"
19026 @item
19027  When buttifying <URL: > things, all white space (including
19028 newlines) should be ignored.
19029 @item
19030  Process-marking all groups in a topic should process-mark
19031 groups in subtopics as well.
19032 @item
19033  Add non-native groups to the list of killed groups when killing them.
19034 @item
19035  nntp-suggest-kewl-config to probe the nntp server and suggest
19036 variable settings.
19037 @item
19038  add edit and forward secondary marks.
19039 @item
19040  nnml shouldn't visit its .overview files.
19041 @item
19042  allow customizing sorting within gathered threads.
19043 @item
19044  `B q' shouldn't select the current article.
19045 @item
19046  nnmbox should support a newsgroups file for descriptions.
19047 @item
19048  allow fetching mail from several pop servers.
19049 @item
19050  Be able to specify whether the saving commands save the original
19051 or the formatted article.
19052 @item
19053  a command to reparent with the child process-marked (cf. `T ^'.).
19054 @item
19055  I think the possibility to send a password with nntp-open-rlogin
19056 should be a feature in Red Gnus.
19057 @item
19058  The `Z n' command should be possible to execute from a mouse click.
19059 @item
19060  more limiting functions -- date, etc.
19061 @item
19062  be able to limit on a random header; on body; using reverse matches.
19063 @item
19064  a group parameter (`absofucking-total-expiry') that will make Gnus expire
19065 even unread articles.
19066 @item
19067  a command to print the article buffer as postscript.
19068 @item
19069  variable to disable password fetching when opening by nntp-open-telnet.
19070 @item
19071  manual: more example servers -- nntp with rlogin, telnet
19072 @item
19073  checking for bogus groups should clean topic alists as well.
19074 @item
19075  canceling articles in foreign groups.
19076 @item
19077  article number in folded topics isn't properly updated by
19078 Xref handling.
19079 @item
19080  Movement in the group buffer to the next unread group should go to the
19081 next closed topic with unread messages if no group can be found.
19082 @item
19083  Extensive info pages generated on the fly with help everywhere --
19084 in the "*Gnus edit*" buffers, for instance.
19085 @item
19086  Topic movement commands -- like thread movement.  Up, down, forward, next.
19087 @item
19088  a way to tick/mark as read Gcc'd articles.
19089 @item
19090  a way to say that all groups within a specific topic comes
19091 from a particular server?  Hm.
19092 @item
19093  `gnus-article-fill-if-long-lines' -- a function to fill
19094 the article buffer if there are any looong lines there.
19095 @item
19096  `T h' should jump to the parent topic and fold it.
19097 @item
19098  a command to create an ephemeral nndoc group out of a file,
19099 and then splitting it/moving it to some other group/backend.
19100 @item
19101  a group parameter for nnkiboze groups that says that
19102 all kibozed articles should be entered into the cache.
19103 @item
19104  It should also probably be possible to delimit what
19105 `gnus-jog-cache' does -- for instance, work on just some groups, or on
19106 some levels, and entering just articles that have a score higher than
19107 a certain number.
19108 @item
19109  nnfolder should append to the folder instead of re-writing
19110 the entire folder to disk when accepting new messages.
19111 @item
19112  allow all backends to do the proper thing with .gz files.
19113 @item
19114  a backend for reading collections of babyl files nnbabylfolder?
19115 @item
19116  a command for making the native groups into foreign groups.
19117 @item
19118  server mode command for clearing read marks from all groups
19119 from a server.
19120 @item
19121  when following up multiple articles, include all To, Cc, etc headers
19122 from all articles.
19123 @item
19124  a command for deciding what the total score of the current
19125 thread is.  Also a way to highlight based on this.
19126 @item
19127  command to show and edit group scores
19128 @item
19129  a gnus-tree-minimize-horizontal to minimize tree buffers
19130 horizontally.
19131 @item
19132  command to generate nnml overview file for one group.
19133 @item
19134  `C-u C-u a' -- prompt for many crossposted groups.
19135 @item
19136  keep track of which mail groups have received new articles (in this session).
19137 Be able to generate a report and perhaps do some marking in the group
19138 buffer.
19139 @item
19140  gnus-build-sparse-threads to a number -- build only sparse threads
19141 that are of that length.
19142 @item
19143  have nnmh respect mh's unseen sequence in .mh_profile.
19144 @item
19145  cache the newsgroups descriptions locally.
19146 @item
19147  asynchronous posting under nntp.
19148 @item
19149  be able to control word adaptive scoring from the score files.
19150 @item
19151  a variable to make `C-c C-c' post using the "current" select method.
19152 @item
19153  `limit-exclude-low-scored-articles'.
19154 @item
19155  if `gnus-summary-show-thread' is a number, hide threads that have
19156 a score lower than this number.
19157 @item
19158  split newsgroup subscription variable up into "order" and "method".
19159 @item
19160  buttonize ange-ftp file names.
19161 @item
19162  a command to make a duplicate copy of the current article
19163 so that each copy can be edited separately.
19164 @item
19165  nnweb should allow fetching from the local nntp server.
19166 @item
19167  record the sorting done in the summary buffer so that
19168 it can be repeated when limiting/regenerating the buffer.
19169 @item
19170  nnml-generate-nov-databses should generate for
19171 all nnml servers.
19172 @item
19173  when the user does commands in the group buffer, check
19174 the modification time of the .newsrc.eld file and use
19175 ask-user-about-supersession-threat.  Also warn when trying
19176 to save .newsrc.eld and it has changed.
19177 @item
19178  M-g on a topic will display all groups with 0 articles in
19179 the topic.
19180 @item
19181  command to remove all topic stuff.
19182 @item
19183  allow exploding incoming digests when reading incoming mail
19184 and splitting the resulting digests.
19185 @item
19186  nnsoup shouldn't set the `message-' variables.
19187 @item
19188  command to nix out all nnoo state information.
19189 @item
19190  nnmail-process-alist that calls functions if group names
19191 matches an alist -- before saving.
19192 @item
19193  use buffer-invisibility-spec everywhere for hiding text.
19194 @item
19195  variable to activate each group before entering them
19196 to get the (new) number of articles.  `gnus-activate-before-entering'.
19197 @item
19198  command to fetch a Message-ID from any buffer, even
19199 starting Gnus first if necessary.
19200 @item
19201  when posting and checking whether a group exists or not, just
19202 ask the nntp server instead of relying on the active hashtb.
19203 @item
19204  buttonize the output of `C-c C-a' in an apropos-like way.
19205 @item
19206  `G p' should understand process/prefix, and allow editing
19207 of several groups at once.
19208 @item
19209  command to create an ephemeral nnvirtual group that
19210 matches some regexp(s).
19211 @item
19212  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
19213 @item
19214  it should be possible to score "thread" on the From header.
19215 @item
19216  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
19217 @item
19218  `B i' should display the article at once in the summary buffer.
19219 @item
19220  remove the "*" mark at once when unticking an article.
19221 @item
19222  `M-s' should highlight the matching text.
19223 @item
19224  when checking for duplicated mails, use Resent-Message-ID if present.
19225 @item
19226  killing and yanking groups in topics should be better.  If killing one copy
19227 of a group that exists in multiple topics, only that copy should
19228 be removed.  Yanking should insert the copy, and yanking topics
19229 should be possible to be interspersed with the other yankings.
19230 @item
19231  command for enter a group just to read the cached articles.  A way to say
19232 "ignore the nntp connection; just read from the cache."
19233 @item
19234  `X u' should decode base64 articles.
19235 @item
19236  a way to hide all "inner" cited text, leaving just the most
19237 recently cited text.
19238 @item
19239  nnvirtual should be asynchronous.
19240 @item
19241  after editing an article, gnus-original-article-buffer should
19242 be invalidated.
19243 @item
19244  there should probably be a way to make Gnus not connect to the
19245 server and just read the articles in the server
19246 @item
19247  allow a `set-default' (or something) to change the default
19248 value of nnoo variables.
19249 @item
19250  a command to import group infos from a .newsrc.eld file.
19251 @item
19252  groups from secondary servers have the entire select method
19253 listed in each group info.
19254 @item
19255  a command for just switching from the summary buffer to the group
19256 buffer.
19257 @item
19258  a way to specify that some incoming mail washing functions
19259 should only be applied to some groups.
19260 @item
19261  Message `C-f C-t' should ask the user whether to heed
19262 mail-copies-to: never.
19263 @item
19264  new group parameter -- `post-to-server' that says to post
19265 using the current server.  Also a variable to do the same.
19266 @item
19267  the slave dribble files should auto-save to the slave file names.
19268 @item
19269  a group parameter that says what articles to display on group entry, based
19270 on article marks.
19271 @item
19272  a way to visually distinguish slave Gnusae from masters.  (Whip instead
19273 of normal logo?)
19274 @item
19275  Use DJ Bernstein "From " quoting/dequoting, where applicable.
19276 @item
19277  Why is hide-citation-maybe and hide-citation different?  Also
19278 clear up info.
19279 @item
19280  group user-defined meta-parameters.
19281
19282
19283
19284 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
19285 @item
19286  I like the option for trying to retrieve the FAQ for a group and I was
19287 thinking it would be great if for those newsgroups that had archives
19288 you could also try to read the archive for that group.  Part of the
19289 problem is that archives are spread all over the net, unlike FAQs.
19290 What would be best I suppose is to find the one closest to your site.
19291
19292 In any case, there is a list of general news group archives at @*
19293 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
19294
19295
19296
19297
19298 @item
19299 @example
19300 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
19301 (add-hook 'gnus-select-group-hook
19302   (lambda ()
19303     (gnus-group-add-parameter group
19304        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
19305
19306 (defun gnus-user-format-function-d (headers)
19307   "Return the date the group was last read."
19308   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
19309       (t "")))
19310 @end example
19311
19312 @item
19313  tanken var at n\e-AÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete\e$)A
19314 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den v\e-Aære en\e$)A
19315 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
19316 hatt forskjellige serveres startup-filer forskjellige steder.
19317
19318
19319 @item
19320 LMI> Well, nnbabyl could alter the group info to heed labels like
19321 LMI> answered and read, I guess.
19322
19323 It could also keep them updated (the same for the Status: header of
19324 unix mbox files).
19325
19326 They could be used like this:
19327
19328
19329 @example
19330 `M l <name> RET' add label <name> to current message.
19331 `M u <name> RET' remove label <name> from current message.
19332 `/ l <expr> RET' limit summary buffer according to <expr>.
19333
19334 <expr> would be a boolean expression on the labels, e.g.
19335
19336 `/ l bug & !fixed RET'
19337 @end example
19338
19339 would show all the messages which are labeled `bug' but not labeled
19340 `fixed'.
19341
19342 One could also imagine the labels being used for highlighting, or
19343 affect the summary line format.
19344
19345
19346 @item
19347 Sender: abraham@@dina.kvl.dk
19348
19349 I'd like a gnus-find-file which work like find file, except that it
19350 would recognize things that looks like messages or folders:
19351
19352 - If it is a directory containing numbered files, create an nndir
19353 summary buffer.
19354
19355 - For other directories, create a nneething summary buffer.
19356
19357 - For files matching "\\`From ", create a nndoc/mbox summary.
19358
19359 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
19360
19361 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
19362
19363 - For other files, just find them normally.
19364
19365 I'd like `nneething' to use this function, so it would work on a
19366 directory potentially containing mboxes or babyl files.
19367
19368 @item
19369 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
19370 tell him what you are doing.
19371
19372 @item
19373 Currently, I get prompted:
19374
19375 decend into sci?
19376 - type y
19377 decend into sci.something ?
19378 - type n
19379 decend into ucd?
19380
19381 The problem above is that since there is really only one subsection of
19382 science, shouldn't it prompt you for only descending sci.something?  If
19383 there was a sci.somethingelse group or section, then it should prompt
19384 for sci? first the sci.something? then sci.somethingelse?...
19385
19386 @item
19387 Ja, det burde v\e-Aære en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?\e$)A
19388 `gnus-use-few-score-files'?  S\e-AÃ¥ kunne score-regler legges til den\e$)A
19389 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
19390 "no.all.SCORE", osv.
19391
19392 @item
19393 What i want is for Gnus to treat any sequence or combination of the following
19394 as a single spoiler warning and hide it all, replacing it with a "Next Page"
19395 button:
19396
19397
19398 ^L's
19399
19400 more than n blank lines
19401
19402 more than m identical lines
19403 (which should be replaced with button to show them)
19404
19405 any whitespace surrounding any of the above
19406
19407
19408 @item
19409 Well, we could allow a new value to `gnus-thread-ignore-subject' --
19410 `spaces', or something.  (We could even default to that.)  And then
19411 subjects that differ in white space only could be considered the
19412 "same" subject for threading purposes.
19413
19414 @item
19415 Modes to preprocess the contents (e.g. jka-compr) use the second form
19416 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
19417 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
19418 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
19419
19420 @item
19421  Under XEmacs -- do funny article marks:
19422 tick - thumb tack
19423 killed - skull
19424 soup - bowl of soup
19425 score below - dim light bulb
19426 score over - bright light bulb
19427
19428 @item
19429 Yes. I think the algorithm is as follows:
19430
19431 @example
19432 Group-mode
19433
19434    show-list-of-articles-in-group
19435         if (key-pressed == SPACE)
19436                 if (no-more-articles-in-group-to-select)
19437                         if (articles-selected)
19438                                 start-reading-selected-articles;
19439                         junk-unread-articles;
19440                         next-group;
19441                  else
19442                         show-next-page;
19443
19444          else if (key-pressed = '.')
19445                 if (consolidated-menus)         # same as hide-thread in Gnus
19446                         select-thread-under-cursor;
19447                 else
19448                         select-article-under-cursor;
19449
19450
19451 Article-mode
19452         if (key-pressed == SPACE)
19453                 if (more-pages-in-article)
19454                         next-page;
19455                 else if (more-selected-articles-to-read)
19456                         next-article;
19457                 else
19458                         next-group;
19459 @end example
19460
19461 @item
19462 My precise need here would have been to limit files to Incoming*.
19463 One could think of some `nneething-only-files' variable, but I guess
19464 it would have been unacceptable if one was using many unrelated such
19465 nneething groups.
19466
19467 A more useful approach would be to, in response to the `G D' prompt, be
19468 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
19469 the top-level directory only (in case directories would be matched by
19470 the wildcard expression).
19471
19472 @item
19473 It would be nice if it also handled
19474
19475         <URL:news://sunsite.auc.dk/>
19476
19477 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
19478
19479
19480 @item
19481
19482   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
19483 really well.  Each menu is 'named' by a symbol that would be on a
19484 gnus-*-menus (where * would be whatever, but at least group, summary, and
19485 article versions) variable.
19486
19487   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
19488
19489   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
19490 the main menubar.  This approach works really well for Emacs-W3 and VM.
19491
19492
19493 @item
19494  nndoc should take care to create unique Message-IDs for all its
19495 articles.
19496 @item
19497  gnus-score-followup-article only works when you have a summary buffer
19498 active.  Make it work when posting from the group buffer as well.
19499 (message-sent-hook).
19500 @item
19501  rewrite gnus-demon to use run-with-idle-timers.
19502
19503 @item
19504  * Enhancements to Gnus:
19505
19506   Add two commands:
19507
19508   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
19509     straight to the server buffer, without opening any connections to
19510     servers first.
19511
19512   * gnus-server-read-server-newsrc--produces a buffer very similar to
19513     the group buffer, but with only groups from that server listed;
19514     quitting this buffer returns to the server buffer.
19515
19516 @item
19517  add a command to check the integrity of an nnfolder folder --
19518 go through the article numbers and see that there are no duplicates,
19519 and stuff.
19520
19521 @item
19522  `unsmileyfy-buffer' to undo smileification.
19523
19524 @item
19525  a command to give all relevant info on an article, including all
19526 secondary marks.
19527
19528 @item
19529  when doing `-request-accept-article', the backends should do
19530 the nnmail duplicate checking.
19531
19532 @item
19533  allow `message-signature-file' to be a function to return the
19534 value of the signature file.
19535
19536 @item
19537  In addition, I would love it if I could configure message-tab so that it
19538 could call `bbdb-complete-name' in other headers.  So, some sort of
19539 interface like
19540
19541 (setq message-tab-alist
19542       '((message-header-regexp message-expand-group)
19543         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
19544
19545 then you could run the relevant function to complete the information in
19546 the header
19547
19548 @item
19549  cache the newsgroups file locally to avoid reloading it all the time.
19550
19551 @item
19552  a command to import a buffer into a group.
19553
19554 @item
19555  nnweb should allow fetching by Message-ID from servers.
19556
19557 @item
19558  point in the article buffer doesn't always go to the
19559 beginning of the buffer when selecting new articles.
19560
19561 @item
19562  a command to process mark all unread articles.
19563
19564 @item
19565  `gnus-gather-threads-by-references-and-subject' -- first
19566 do gathering by references, and then go through the dummy roots and
19567 do more gathering by subject.
19568
19569 @item
19570  gnus-uu-mark-in-numerical-order -- process mark articles in
19571 article numerical order.
19572
19573 @item
19574  (gnus-thread-total-score
19575  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
19576 bind to a key.
19577
19578 @item
19579  sorting by score is wrong when using sparse threads.
19580
19581 @item
19582  a command to fetch an arbitrary article -- without having to be
19583 in the summary buffer.
19584
19585 @item
19586  a new nncvs backend.  Each group would show an article, using
19587 version branches as threading, checkin date as the date, etc.
19588
19589 @item
19590  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
19591 This filter allows one to construct advance queries on the Dejanews
19592 database such as specifying start and end dates, subject, author,
19593 and/or newsgroup name.
19594
19595 @item
19596  new Date header scoring type -- older, newer
19597
19598 @item
19599  use the summary toolbar in the article buffer.
19600
19601 @item
19602  a command to fetch all articles that are less than X days old.
19603
19604 @item
19605  in pick mode, `q' should save the list of selected articles in the
19606 group info.  The next time the group is selected, these articles
19607 will automatically get the process mark.
19608
19609 @item
19610  Isn't it possible to (also?) allow M-^ to automatically try the
19611 default server if it fails on the current server?  (controlled by a
19612 user variable, (nil, t, 'ask)).
19613
19614 @item
19615  make it possible to cancel articles using the select method for the
19616 current group.
19617
19618 @item
19619  `gnus-summary-select-article-on-entry' or something.  It'll default
19620 to t and will select whatever article decided by `gnus-auto-select-first'.
19621
19622 @item
19623  a new variable to control which selection commands should be unselecting.
19624 `first', `best', `next', `prev', `next-unread', `prev-unread' are
19625 candidates.
19626
19627 @item
19628  be able to select groups that have no articles in them
19629 to be able to post in them (using the current select method).
19630
19631 @item
19632  be able to post via DejaNews.
19633
19634 @item
19635  `x' should retain any sortings that have been performed.
19636
19637 @item
19638  allow the user to specify the precedence of the secondary marks.  Also
19639 allow them to be displayed separately.
19640
19641 @item
19642  gnus-summary-save-in-pipe should concatenate the results from
19643 the processes when doing a process marked pipe.
19644
19645 @item
19646  a new match type, like Followup, but which adds Thread matches on all
19647 articles that match a certain From header.
19648
19649 @item
19650  a function that can be read from kill-emacs-query-functions to offer
19651 saving living summary buffers.
19652
19653 @item
19654  a function for selecting a particular group which will contain
19655 the articles listed in a list of article numbers/id's.
19656
19657 @item
19658  a battery of character translation functions to translate common
19659 Mac, MS (etc) characters into ISO 8859-1.
19660
19661 @example
19662 (defun article-fix-m$word ()
19663   "Fix M$Word smartquotes in an article."
19664   (interactive)
19665   (save-excursion
19666     (let ((buffer-read-only nil))
19667       (goto-char (point-min))
19668       (while (search-forward "\221" nil t)
19669         (replace-match "`" t t))
19670       (goto-char (point-min))
19671       (while (search-forward "\222" nil t)
19672         (replace-match "'" t t))
19673       (goto-char (point-min))
19674       (while (search-forward "\223" nil t)
19675         (replace-match "\"" t t))
19676       (goto-char (point-min))
19677       (while (search-forward "\224" nil t)
19678         (replace-match "\"" t t)))))
19679 @end example
19680
19681 @item
19682 @example
19683  (add-hook 'gnus-exit-query-functions
19684 '(lambda ()
19685    (if (and (file-exists-p nnmail-spool-file)
19686             (> (nnheader-file-size nnmail-spool-file) 0))
19687        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
19688        (y-or-n-p "Are you sure you want to quit Gnus? "))))
19689 @end example
19690
19691 @item
19692  allow message-default-headers to be a function.
19693
19694 @item
19695  new Date score match types -- < > = (etc) that take floating point
19696 numbers and match on the age of the article.
19697
19698 @item
19699 @example
19700 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
19701 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
19702 >  > > buffer in the frame that it was called from =:-O
19703 >
19704 >  > Hm.  How do you start up Gnus?  From the toolbar or with
19705 >  > `M-x gnus-other-frame'?
19706 >
19707 >    I normally start it up from the toolbar; at
19708 > least that's the way I've caught it doing the
19709 > deed before.
19710 @end example
19711
19712 @item
19713  all commands that react to the process mark should push
19714 the current process mark set onto the stack.
19715
19716 @item
19717  gnus-article-hide-pgp
19718 Selv ville jeg nok ha valgt \e-AÃ¥ slette den dersom teksten matcher\e$)A
19719 @example
19720 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
19721 @end example
19722 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
19723 er min type heuristikk og langt fra alles.
19724
19725 @item
19726  `gnus-subscribe-sorted' -- insert new groups where they would have been
19727 sorted to if `gnus-group-sort-function' were run.
19728
19729 @item
19730  gnus-(group,summary)-highlight should respect any `face' text props set
19731 on the lines.
19732
19733 @item
19734  use run-with-idle-timer for gnus-demon instead of the
19735 home-brewed stuff for better reliability.
19736
19737 @item
19738  add a way to select which NoCeM type to apply -- spam, troll, etc.
19739
19740 @item
19741  nndraft-request-group should tally auto-save files.
19742
19743 @item
19744  implement nntp-retry-on-break and nntp-command-timeout.
19745
19746 @item
19747  gnus-article-highlight-limit that says when not to highlight (long)
19748 articles.
19749
19750 @item
19751  (nnoo-set SERVER VARIABLE VALUE)
19752
19753 @item
19754  nn*-spool-methods
19755
19756 @item
19757  interrupitng agent fetching of articles should save articles.
19758
19759 @item
19760  command to open a digest group, and copy all the articles there to the
19761 current group.
19762
19763 @item
19764  a variable to disable article body highlights if there's more than
19765 X characters in the body.
19766
19767 @item
19768  handle 480/381 authinfo requests separately.
19769
19770 @item
19771  include the texi/dir file in the distribution.
19772
19773 @item
19774  format spec to "tab" to a position.
19775
19776 @item
19777  Move all prompting to the new `M-n' default style.
19778
19779 @item
19780  command to display all dormant articles.
19781
19782 @item
19783  gnus-auto-select-next makeover -- list of things it should do.
19784
19785 @item
19786  a score match type that adds scores matching on From if From has replied
19787 to something someone else has said.
19788
19789 @item
19790  Read Netscape discussion groups:
19791 snews://secnews.netscape.com/netscape.communicator.unix
19792
19793 @item
19794 One command to edit the original version if an article, and one to edit
19795 the displayed version.
19796
19797 @item
19798 @kbd{T v} -- make all process-marked articles the children of the
19799 current article.
19800
19801 @item
19802 Switch from initial text to the new default text mechanism.
19803
19804 @item
19805 How about making it possible to expire local articles?  Will it be
19806 possible to make various constraints on when an article can be
19807 expired, e.g. (read), (age > 14 days), or the more interesting (read
19808 & age > 14 days)?
19809
19810 @item
19811 New limit command---limit to articles that have a certain string
19812 in the head or body.
19813
19814 @item
19815 Allow breaking lengthy NNTP commands.
19816
19817 @item
19818 gnus-article-highlight-limit, to disable highlighting in big articles.
19819
19820 @item
19821 Editing an article should put the article to be edited
19822 in a special, unique buffer.
19823
19824 @item
19825 A command to send a mail to the admin-address group param.
19826
19827 @item
19828 A Date scoring type that will match if the article
19829 is less than a certain number of days old.
19830
19831 @item
19832 New spec: %~(tab 56) to put point on column 56
19833
19834 @item
19835 Allow Gnus Agent scoring to use normal score files.
19836
19837 @item
19838 Rething the Agent active file thing.  `M-g' doesn't update the active
19839 file, for instance.
19840
19841 @item
19842 With dummy roots, `^' and then selecing the first article
19843 in any other dummy thread will make Gnus highlight the
19844 dummy root instead of the first article.
19845
19846 @item
19847 Propagate all group properties (marks, article numbers, etc) up to the
19848 topics for displaying.
19849
19850 @item
19851 `n' in the group buffer with topics should go to the next group
19852 with unread articles, even if that group is hidden in a topic.
19853
19854 @item
19855 gnus-posting-styles doesn't work in drafts.
19856
19857 @item
19858 gnus-summary-limit-include-cached is slow when there are
19859 many articles in the cache, since it regenerates big parts of the
19860 summary buffer for each article.
19861
19862 @item
19863 Implement gnus-batch-brew-soup.
19864
19865 @item
19866 Group parameters and summary commands for un/subscribing to mailing
19867 lists.
19868
19869 @item
19870 Introduce nnmail-home-directory.
19871
19872 @item
19873 gnus-fetch-group and friends should exit Gnus when the user
19874 exits the group.
19875
19876 @item
19877 The jingle is only played on the second invocation of Gnus.
19878
19879 @item
19880 Bouncing articles should do MIME.
19881
19882 @item
19883 Crossposted articles should "inherit" the % or @ mark from the other
19884 groups it has been crossposted to, or something.  (Agent.)
19885
19886 @item
19887 If point is on a group that appears multiple times in topics, and
19888 you press `l', point will move to the first instance of the group.
19889
19890 @item
19891 A spec for the group line format to display the number of
19892 agent-downloaded articles in the group.
19893
19894 @item
19895 Some nntp servers never respond when posting, so there should be a
19896 timeout for all commands.
19897
19898 @item
19899 When stading on a topic line and `t'-ing, point goes to the last line.
19900 It should go somewhere else.
19901
19902 @item
19903 I'm having trouble accessing a newsgroup with a "+" in its name with
19904 Gnus.  There is a new newsgroup on msnews.microsoft.com named
19905 "microsoft.public.multimedia.directx.html+time" that I'm trying to
19906 access as
19907 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
19908 but it gives an error that it cant access the group.
19909
19910 Is the "+" character illegal in newsgroup names?  Is there any way in
19911 Gnus to work around this?  (gnus 5.6.45 - XEmacs 20.4)
19912
19913 @item
19914
19915 When `#F', do:
19916
19917 @example
19918 Subject: Answer to your mails 01.01.1999-01.05.1999
19919  --text follows this line--
19920 Sorry I killfiled you...
19921
19922 Under the subject "foo", you wrote on 01.01.1999:
19923 > bar
19924 Under the subject "foo1", you wrote on 01.01.1999:
19925 > bar 1
19926 @end example
19927
19928 @item
19929 Allow "orphan" scores in the Agent scoring.
19930
19931 @item
19932 @example
19933     - Edit article's summary line. 
19934     - End edit
19935     - Sort lines in buffer by subject
19936
19937     --> the old subject line appears in Summary buffer, not the one that was
19938     just changed to.
19939 @end example
19940
19941
19942 @item
19943 Remove list identifiers from the subject in the summary when doing `^'
19944 and the like.
19945
19946 @item
19947 Have the Agent write out articles, one by one, as it retrieves them,
19948 to avoid having to re-fetch them all if Emacs should crash while
19949 fetching. 
19950
19951 @item
19952 Be able to forward groups of messages as MIME digests.
19953
19954 @item
19955 Solve the halting problem.
19956
19957 @c TODO
19958 @end itemize
19959
19960 @iftex
19961
19962 @page
19963 @node The Manual
19964 @section The Manual
19965 @cindex colophon
19966 @cindex manual
19967
19968 This manual was generated from a TeXinfo file and then run through
19969 either @code{texi2dvi}
19970 @iflatex
19971 or my own home-brewed TeXinfo to \LaTeX\ transformer,
19972 and then run through @code{latex} and @code{dvips}
19973 @end iflatex
19974 to get what you hold in your hands now.
19975
19976 The following conventions have been used:
19977
19978 @enumerate
19979
19980 @item
19981 This is a @samp{string}
19982
19983 @item
19984 This is a @kbd{keystroke}
19985
19986 @item
19987 This is a @file{file}
19988
19989 @item
19990 This is a @code{symbol}
19991
19992 @end enumerate
19993
19994 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
19995 mean:
19996
19997 @lisp
19998 (setq flargnoze "yes")
19999 @end lisp
20000
20001 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
20002
20003 @lisp
20004 (setq flumphel 'yes)
20005 @end lisp
20006
20007 @samp{yes} and @code{yes} are two @emph{very} different things---don't
20008 ever get them confused.
20009
20010 @iflatex
20011 @c @head
20012 Of course, everything in this manual is of vital interest, so you should
20013 read it all.  Several times.  However, if you feel like skimming the
20014 manual, look for that gnu head you should see in the margin over
20015 there---it means that what's being discussed is of more importance than
20016 the rest of the stuff.  (On the other hand, if everything is infinitely
20017 important, how can anything be more important than that?  Just one more
20018 of the mysteries of this world, I guess.)
20019 @end iflatex
20020
20021 @end iftex
20022
20023
20024 @page
20025 @node Terminology
20026 @section Terminology
20027
20028 @cindex terminology
20029 @table @dfn
20030
20031 @item news
20032 @cindex news
20033 This is what you are supposed to use this thing for---reading news.
20034 News is generally fetched from a nearby @sc{nntp} server, and is
20035 generally publicly available to everybody.  If you post news, the entire
20036 world is likely to read just what you have written, and they'll all
20037 snigger mischievously.  Behind your back.
20038
20039 @item mail
20040 @cindex mail
20041 Everything that's delivered to you personally is mail.  Some news/mail
20042 readers (like Gnus) blur the distinction between mail and news, but
20043 there is a difference.  Mail is private.  News is public.  Mailing is
20044 not posting, and replying is not following up.
20045
20046 @item reply
20047 @cindex reply
20048 Send a mail to the person who has written what you are reading.
20049
20050 @item follow up
20051 @cindex follow up
20052 Post an article to the current newsgroup responding to the article you
20053 are reading.
20054
20055 @item backend
20056 @cindex backend
20057 Gnus gets fed articles from a number of backends, both news and mail
20058 backends.  Gnus does not handle the underlying media, so to speak---this
20059 is all done by the backends.
20060
20061 @item native
20062 @cindex native
20063 Gnus will always use one method (and backend) as the @dfn{native}, or
20064 default, way of getting news.
20065
20066 @item foreign
20067 @cindex foreign
20068 You can also have any number of foreign groups active at the same time.
20069 These are groups that use non-native non-secondary backends for getting
20070 news.
20071
20072 @item secondary
20073 @cindex secondary
20074 Secondary backends are somewhere half-way between being native and being
20075 foreign, but they mostly act like they are native.
20076
20077 @item article
20078 @cindex article
20079 A message that has been posted as news.
20080
20081 @item mail message
20082 @cindex mail message
20083 A message that has been mailed.
20084
20085 @item message
20086 @cindex message
20087 A mail message or news article
20088
20089 @item head
20090 @cindex head
20091 The top part of a message, where administrative information (etc.) is
20092 put.
20093
20094 @item body
20095 @cindex body
20096 The rest of an article.  Everything not in the head is in the
20097 body.
20098
20099 @item header
20100 @cindex header
20101 A line from the head of an article.
20102
20103 @item headers
20104 @cindex headers
20105 A collection of such lines, or a collection of heads.  Or even a
20106 collection of @sc{nov} lines.
20107
20108 @item @sc{nov}
20109 @cindex nov
20110 When Gnus enters a group, it asks the backend for the headers of all
20111 unread articles in the group.  Most servers support the News OverView
20112 format, which is more compact and much faster to read and parse than the
20113 normal @sc{head} format.
20114
20115 @item level
20116 @cindex levels
20117 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
20118 that have a lower level are ``more'' subscribed than the groups with a
20119 higher level.  In fact, groups on levels 1-5 are considered
20120 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
20121 are @dfn{killed}.  Commands for listing groups and scanning for new
20122 articles will all use the numeric prefix as @dfn{working level}.
20123
20124 @item killed groups
20125 @cindex killed groups
20126 No information on killed groups is stored or updated, which makes killed
20127 groups much easier to handle than subscribed groups.
20128
20129 @item zombie groups
20130 @cindex zombie groups
20131 Just like killed groups, only slightly less dead.
20132
20133 @item active file
20134 @cindex active file
20135 The news server has to keep track of what articles it carries, and what
20136 groups exist.  All this information in stored in the active file, which
20137 is rather large, as you might surmise.
20138
20139 @item bogus groups
20140 @cindex bogus groups
20141 A group that exists in the @file{.newsrc} file, but isn't known to the
20142 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
20143 This means that the group probably doesn't exist (any more).
20144
20145 @item activating
20146 @cindex activating groups
20147 The act of asking the server for info on a group and computing the
20148 number of unread articles is called @dfn{activating the group}.
20149 Un-activated groups are listed with @samp{*} in the group buffer.
20150
20151 @item server
20152 @cindex server
20153 A machine one can connect to and get news (or mail) from.
20154
20155 @item select method
20156 @cindex select method
20157 A structure that specifies the backend, the server and the virtual
20158 server settings.
20159
20160 @item virtual server
20161 @cindex virtual server
20162 A named select method.  Since a select method defines all there is to
20163 know about connecting to a (physical) server, taking the thing as a
20164 whole is a virtual server.
20165
20166 @item washing
20167 @cindex washing
20168 Taking a buffer and running it through a filter of some sort.  The
20169 result will (more often than not) be cleaner and more pleasing than the
20170 original.
20171
20172 @item ephemeral groups
20173 @cindex ephemeral groups
20174 Most groups store data on what articles you have read.  @dfn{Ephemeral}
20175 groups are groups that will have no data stored---when you exit the
20176 group, it'll disappear into the aether.
20177
20178 @item solid groups
20179 @cindex solid groups
20180 This is the opposite of ephemeral groups.  All groups listed in the
20181 group buffer are solid groups.
20182
20183 @item sparse articles
20184 @cindex sparse articles
20185 These are article placeholders shown in the summary buffer when
20186 @code{gnus-build-sparse-threads} has been switched on.
20187
20188 @item threading
20189 @cindex threading
20190 To put responses to articles directly after the articles they respond
20191 to---in a hierarchical fashion.
20192
20193 @item root
20194 @cindex root
20195 @cindex thread root
20196 The first article in a thread is the root.  It is the ancestor of all
20197 articles in the thread.
20198
20199 @item parent
20200 @cindex parent
20201 An article that has responses.
20202
20203 @item child
20204 @cindex child
20205 An article that responds to a different article---its parent.
20206
20207 @item digest
20208 @cindex digest
20209 A collection of messages in one file.  The most common digest format is
20210 specified by RFC1153.
20211
20212 @end table
20213
20214
20215 @page
20216 @node Customization
20217 @section Customization
20218 @cindex general customization
20219
20220 All variables are properly documented elsewhere in this manual.  This
20221 section is designed to give general pointers on how to customize Gnus
20222 for some quite common situations.
20223
20224 @menu
20225 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
20226 * Slow Terminal Connection::  You run a remote Emacs.
20227 * Little Disk Space::         You feel that having large setup files is icky.
20228 * Slow Machine::              You feel like buying a faster machine.
20229 @end menu
20230
20231
20232 @node Slow/Expensive Connection
20233 @subsection Slow/Expensive @sc{nntp} Connection
20234
20235 If you run Emacs on a machine locally, and get your news from a machine
20236 over some very thin strings, you want to cut down on the amount of data
20237 Gnus has to get from the @sc{nntp} server.
20238
20239 @table @code
20240
20241 @item gnus-read-active-file
20242 Set this to @code{nil}, which will inhibit Gnus from requesting the
20243 entire active file from the server.  This file is often v.  large.  You
20244 also have to set @code{gnus-check-new-newsgroups} and
20245 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
20246 doesn't suddenly decide to fetch the active file anyway.
20247
20248 @item gnus-nov-is-evil
20249 This one has to be @code{nil}.  If not, grabbing article headers from
20250 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
20251 support @sc{xover}; Gnus will detect this by itself.
20252 @end table
20253
20254
20255 @node Slow Terminal Connection
20256 @subsection Slow Terminal Connection
20257
20258 Let's say you use your home computer for dialing up the system that runs
20259 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
20260 possible) the amount of data sent over the wires.
20261
20262 @table @code
20263
20264 @item gnus-auto-center-summary
20265 Set this to @code{nil} to inhibit Gnus from re-centering the summary
20266 buffer all the time.  If it is @code{vertical}, do only vertical
20267 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
20268 horizontal and vertical recentering.
20269
20270 @item gnus-visible-headers
20271 Cut down on the headers included in the articles to the
20272 minimum.  You can, in fact, make do without them altogether---most of the
20273 useful data is in the summary buffer, anyway.  Set this variable to
20274 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
20275
20276 Set this hook to all the available hiding commands:
20277 @lisp
20278 (setq gnus-treat-hide-headers 'head
20279       gnus-treat-hide-signature t
20280       gnus-treat-hide-citation t)
20281 @end lisp
20282
20283 @item gnus-use-full-window
20284 By setting this to @code{nil}, you can make all the windows smaller.
20285 While this doesn't really cut down much generally, it means that you
20286 have to see smaller portions of articles before deciding that you didn't
20287 want to read them anyway.
20288
20289 @item gnus-thread-hide-subtree
20290 If this is non-@code{nil}, all threads in the summary buffer will be
20291 hidden initially.
20292
20293 @item gnus-updated-mode-lines
20294 If this is @code{nil}, Gnus will not put information in the buffer mode
20295 lines, which might save some time.
20296 @end table
20297
20298
20299 @node Little Disk Space
20300 @subsection Little Disk Space
20301 @cindex disk space
20302
20303 The startup files can get rather large, so you may want to cut their
20304 sizes a bit if you are running out of space.
20305
20306 @table @code
20307
20308 @item gnus-save-newsrc-file
20309 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
20310 only save @file{.newsrc.eld}.  This means that you will not be able to
20311 use any other newsreaders than Gnus.  This variable is @code{t} by
20312 default.
20313
20314 @item gnus-read-newsrc-file
20315 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
20316 only read @file{.newsrc.eld}.  This means that you will not be able to
20317 use any other newsreaders than Gnus.  This variable is @code{t} by
20318 default.
20319
20320 @item gnus-save-killed-list
20321 If this is @code{nil}, Gnus will not save the list of dead groups.  You
20322 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
20323 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
20324 variable to @code{nil}.  This variable is @code{t} by default.
20325
20326 @end table
20327
20328
20329 @node Slow Machine
20330 @subsection Slow Machine
20331 @cindex slow machine
20332
20333 If you have a slow machine, or are just really impatient, there are a
20334 few things you can do to make Gnus run faster.
20335
20336 Set @code{gnus-check-new-newsgroups} and
20337 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
20338
20339 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
20340 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
20341 summary buffer faster.
20342
20343
20344 @page
20345 @node Troubleshooting
20346 @section Troubleshooting
20347 @cindex troubleshooting
20348
20349 Gnus works @emph{so} well straight out of the box---I can't imagine any
20350 problems, really.
20351
20352 Ahem.
20353
20354 @enumerate
20355
20356 @item
20357 Make sure your computer is switched on.
20358
20359 @item
20360 Make sure that you really load the current Gnus version.  If you have
20361 been running @sc{gnus}, you need to exit Emacs and start it up again before
20362 Gnus will work.
20363
20364 @item
20365 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
20366 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
20367 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
20368 flee}, you have some old @file{.el} files lying around.  Delete these.
20369
20370 @item
20371 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
20372 how-to.
20373
20374 @item
20375 @vindex max-lisp-eval-depth
20376 Gnus works on many recursive structures, and in some extreme (and very
20377 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
20378 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
20379 something like that.
20380 @end enumerate
20381
20382 If all else fails, report the problem as a bug.
20383
20384 @cindex bugs
20385 @cindex reporting bugs
20386
20387 @kindex M-x gnus-bug
20388 @findex gnus-bug
20389 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
20390 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
20391 me the backtrace.  I will fix bugs, but I can only fix them if you send
20392 me a precise description as to how to reproduce the bug.
20393
20394 You really can never be too detailed in a bug report.  Always use the
20395 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
20396 a 10Kb mail each time you use it, and even if you have sent me your
20397 environment 500 times before.  I don't care.  I want the full info each
20398 time.
20399
20400 It is also important to remember that I have no memory whatsoever.  If
20401 you send a bug report, and I send you a reply, and then you just send
20402 back ``No, it's not! Moron!'', I will have no idea what you are
20403 insulting me about.  Always over-explain everything.  It's much easier
20404 for all of us---if I don't have all the information I need, I will just
20405 mail you and ask for more info, and everything takes more time.
20406
20407 If the problem you're seeing is very visual, and you can't quite explain
20408 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
20409 it somewhere it can be reached, and include the URL of the picture in
20410 the bug report.
20411
20412 If you just need help, you are better off asking on
20413 @samp{gnu.emacs.gnus}.  I'm not very helpful.
20414
20415 @cindex gnu.emacs.gnus
20416 @cindex ding mailing list
20417 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
20418 Write to @samp{ding-request@@gnus.org} to subscribe.
20419
20420
20421 @page
20422 @node Gnus Reference Guide
20423 @section Gnus Reference Guide
20424
20425 It is my hope that other people will figure out smart stuff that Gnus
20426 can do, and that other people will write those smart things as well.  To
20427 facilitate that I thought it would be a good idea to describe the inner
20428 workings of Gnus.  And some of the not-so-inner workings, while I'm at
20429 it.
20430
20431 You can never expect the internals of a program not to change, but I
20432 will be defining (in some details) the interface between Gnus and its
20433 backends (this is written in stone), the format of the score files
20434 (ditto), data structures (some are less likely to change than others)
20435 and general methods of operation.
20436
20437 @menu
20438 * Gnus Utility Functions::   Common functions and variable to use.
20439 * Backend Interface::        How Gnus communicates with the servers.
20440 * Score File Syntax::        A BNF definition of the score file standard.
20441 * Headers::                  How Gnus stores headers internally.
20442 * Ranges::                   A handy format for storing mucho numbers.
20443 * Group Info::               The group info format.
20444 * Extended Interactive::     Symbolic prefixes and stuff.
20445 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
20446 * Various File Formats::     Formats of files that Gnus use.
20447 @end menu
20448
20449
20450 @node Gnus Utility Functions
20451 @subsection Gnus Utility Functions
20452 @cindex Gnus utility functions
20453 @cindex utility functions
20454 @cindex functions
20455 @cindex internal variables
20456
20457 When writing small functions to be run from hooks (and stuff), it's
20458 vital to have access to the Gnus internal functions and variables.
20459 Below is a list of the most common ones.
20460
20461 @table @code
20462
20463 @item gnus-newsgroup-name
20464 @vindex gnus-newsgroup-name
20465 This variable holds the name of the current newsgroup.
20466
20467 @item gnus-find-method-for-group
20468 @findex gnus-find-method-for-group
20469 A function that returns the select method for @var{group}.
20470
20471 @item gnus-group-real-name
20472 @findex gnus-group-real-name
20473 Takes a full (prefixed) Gnus group name, and returns the unprefixed
20474 name.
20475
20476 @item gnus-group-prefixed-name
20477 @findex gnus-group-prefixed-name
20478 Takes an unprefixed group name and a select method, and returns the full
20479 (prefixed) Gnus group name.
20480
20481 @item gnus-get-info
20482 @findex gnus-get-info
20483 Returns the group info list for @var{group}.
20484
20485 @item gnus-group-unread
20486 @findex gnus-group-unread
20487 The number of unread articles in @var{group}, or @code{t} if that is
20488 unknown.
20489
20490 @item gnus-active
20491 @findex gnus-active
20492 The active entry for @var{group}.
20493
20494 @item gnus-set-active
20495 @findex gnus-set-active
20496 Set the active entry for @var{group}.
20497
20498 @item gnus-add-current-to-buffer-list
20499 @findex gnus-add-current-to-buffer-list
20500 Adds the current buffer to the list of buffers to be killed on Gnus
20501 exit.
20502
20503 @item gnus-continuum-version
20504 @findex gnus-continuum-version
20505 Takes a Gnus version string as a parameter and returns a floating point
20506 number.  Earlier versions will always get a lower number than later
20507 versions.
20508
20509 @item gnus-group-read-only-p
20510 @findex gnus-group-read-only-p
20511 Says whether @var{group} is read-only or not.
20512
20513 @item gnus-news-group-p
20514 @findex gnus-news-group-p
20515 Says whether @var{group} came from a news backend.
20516
20517 @item gnus-ephemeral-group-p
20518 @findex gnus-ephemeral-group-p
20519 Says whether @var{group} is ephemeral or not.
20520
20521 @item gnus-server-to-method
20522 @findex gnus-server-to-method
20523 Returns the select method corresponding to @var{server}.
20524
20525 @item gnus-server-equal
20526 @findex gnus-server-equal
20527 Says whether two virtual servers are equal.
20528
20529 @item gnus-group-native-p
20530 @findex gnus-group-native-p
20531 Says whether @var{group} is native or not.
20532
20533 @item gnus-group-secondary-p
20534 @findex gnus-group-secondary-p
20535 Says whether @var{group} is secondary or not.
20536
20537 @item gnus-group-foreign-p
20538 @findex gnus-group-foreign-p
20539 Says whether @var{group} is foreign or not.
20540
20541 @item group-group-find-parameter
20542 @findex group-group-find-parameter
20543 Returns the parameter list of @var{group}.  If given a second parameter,
20544 returns the value of that parameter for @var{group}.
20545
20546 @item gnus-group-set-parameter
20547 @findex gnus-group-set-parameter
20548 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
20549
20550 @item gnus-narrow-to-body
20551 @findex gnus-narrow-to-body
20552 Narrows the current buffer to the body of the article.
20553
20554 @item gnus-check-backend-function
20555 @findex gnus-check-backend-function
20556 Takes two parameters, @var{function} and @var{group}.  If the backend
20557 @var{group} comes from supports @var{function}, return non-@code{nil}.
20558
20559 @lisp
20560 (gnus-check-backend-function "request-scan" "nnml:misc")
20561 @result{} t
20562 @end lisp
20563
20564 @item gnus-read-method
20565 @findex gnus-read-method
20566 Prompts the user for a select method.
20567
20568 @end table
20569
20570
20571 @node Backend Interface
20572 @subsection Backend Interface
20573
20574 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
20575 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
20576 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
20577 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
20578 examples of the latter we have @code{nntp-port-number} and
20579 @code{nnmbox-directory}.
20580
20581 When Gnus asks for information from a backend---say @code{nntp}---on
20582 something, it will normally include a virtual server name in the
20583 function parameters.  (If not, the backend should use the ``current''
20584 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
20585 server as its only (optional) parameter.  If this virtual server hasn't
20586 been opened, the function should fail.
20587
20588 Note that a virtual server name has no relation to some physical server
20589 name.  Take this example:
20590
20591 @lisp
20592 (nntp "odd-one"
20593       (nntp-address "ifi.uio.no")
20594       (nntp-port-number 4324))
20595 @end lisp
20596
20597 Here the virtual server name is @samp{odd-one} while the name of
20598 the physical server is @samp{ifi.uio.no}.
20599
20600 The backends should be able to switch between several virtual servers.
20601 The standard backends implement this by keeping an alist of virtual
20602 server environments that they pull down/push up when needed.
20603
20604 There are two groups of interface functions: @dfn{required functions},
20605 which must be present, and @dfn{optional functions}, which Gnus will
20606 always check for presence before attempting to call 'em.
20607
20608 All these functions are expected to return data in the buffer
20609 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
20610 unfortunately named, but we'll have to live with it.  When I talk about
20611 @dfn{resulting data}, I always refer to the data in that buffer.  When I
20612 talk about @dfn{return value}, I talk about the function value returned by
20613 the function call.  Functions that fail should return @code{nil} as the
20614 return value.
20615
20616 Some backends could be said to be @dfn{server-forming} backends, and
20617 some might be said not to be.  The latter are backends that generally
20618 only operate on one group at a time, and have no concept of ``server''
20619 -- they have a group, and they deliver info on that group and nothing
20620 more.
20621
20622 In the examples and definitions I will refer to the imaginary backend
20623 @code{nnchoke}.
20624
20625 @cindex @code{nnchoke}
20626
20627 @menu
20628 * Required Backend Functions::        Functions that must be implemented.
20629 * Optional Backend Functions::        Functions that need not be implemented.
20630 * Error Messaging::                   How to get messages and report errors.
20631 * Writing New Backends::              Extending old backends.
20632 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
20633 * Mail-like Backends::                Some tips on mail backends.
20634 @end menu
20635
20636
20637 @node Required Backend Functions
20638 @subsubsection Required Backend Functions
20639
20640 @table @code
20641
20642 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
20643
20644 @var{articles} is either a range of article numbers or a list of
20645 @code{Message-ID}s.  Current backends do not fully support either---only
20646 sequences (lists) of article numbers, and most backends do not support
20647 retrieval of @code{Message-ID}s.  But they should try for both.
20648
20649 The result data should either be HEADs or NOV lines, and the result
20650 value should either be @code{headers} or @code{nov} to reflect this.
20651 This might later be expanded to @code{various}, which will be a mixture
20652 of HEADs and NOV lines, but this is currently not supported by Gnus.
20653
20654 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
20655 headers", in some meaning of the word.  This is generally done by
20656 fetching (at most) @var{fetch-old} extra headers less than the smallest
20657 article number in @code{articles}, and filling the gaps as well.  The
20658 presence of this parameter can be ignored if the backend finds it
20659 cumbersome to follow the request.  If this is non-@code{nil} and not a
20660 number, do maximum fetches.
20661
20662 Here's an example HEAD:
20663
20664 @example
20665 221 1056 Article retrieved.
20666 Path: ifi.uio.no!sturles
20667 From: sturles@@ifi.uio.no (Sturle Sunde)
20668 Newsgroups: ifi.discussion
20669 Subject: Re: Something very droll
20670 Date: 27 Oct 1994 14:02:57 +0100
20671 Organization: Dept. of Informatics, University of Oslo, Norway
20672 Lines: 26
20673 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
20674 References: <38jdmq$4qu@@visbur.ifi.uio.no>
20675 NNTP-Posting-Host: holmenkollen.ifi.uio.no
20676 .
20677 @end example
20678
20679 So a @code{headers} return value would imply that there's a number of
20680 these in the data buffer.
20681
20682 Here's a BNF definition of such a buffer:
20683
20684 @example
20685 headers        = *head
20686 head           = error / valid-head
20687 error-message  = [ "4" / "5" ] 2number " " <error message> eol
20688 valid-head     = valid-message *header "." eol
20689 valid-message  = "221 " <number> " Article retrieved." eol
20690 header         = <text> eol
20691 @end example
20692
20693 If the return value is @code{nov}, the data buffer should contain
20694 @dfn{network overview database} lines.  These are basically fields
20695 separated by tabs.
20696
20697 @example
20698 nov-buffer = *nov-line
20699 nov-line   = 8*9 [ field <TAB> ] eol
20700 field      = <text except TAB>
20701 @end example
20702
20703 For a closer look at what should be in those fields,
20704 @pxref{Headers}.
20705
20706
20707 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
20708
20709 @var{server} is here the virtual server name.  @var{definitions} is a
20710 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
20711
20712 If the server can't be opened, no error should be signaled.  The backend
20713 may then choose to refuse further attempts at connecting to this
20714 server.  In fact, it should do so.
20715
20716 If the server is opened already, this function should return a
20717 non-@code{nil} value.  There should be no data returned.
20718
20719
20720 @item (nnchoke-close-server &optional SERVER)
20721
20722 Close connection to @var{server} and free all resources connected
20723 to it.  Return @code{nil} if the server couldn't be closed for some
20724 reason.
20725
20726 There should be no data returned.
20727
20728
20729 @item (nnchoke-request-close)
20730
20731 Close connection to all servers and free all resources that the backend
20732 have reserved.  All buffers that have been created by that backend
20733 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
20734 function is generally only called when Gnus is shutting down.
20735
20736 There should be no data returned.
20737
20738
20739 @item (nnchoke-server-opened &optional SERVER)
20740
20741 If @var{server} is the current virtual server, and the connection to the
20742 physical server is alive, then this function should return a
20743 non-@code{nil} vlue.  This function should under no circumstances
20744 attempt to reconnect to a server we have lost connection to.
20745
20746 There should be no data returned.
20747
20748
20749 @item (nnchoke-status-message &optional SERVER)
20750
20751 This function should return the last error message from @var{server}.
20752
20753 There should be no data returned.
20754
20755
20756 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
20757
20758 The result data from this function should be the article specified by
20759 @var{article}.  This might either be a @code{Message-ID} or a number.
20760 It is optional whether to implement retrieval by @code{Message-ID}, but
20761 it would be nice if that were possible.
20762
20763 If @var{to-buffer} is non-@code{nil}, the result data should be returned
20764 in this buffer instead of the normal data buffer.  This is to make it
20765 possible to avoid copying large amounts of data from one buffer to
20766 another, while Gnus mainly requests articles to be inserted directly
20767 into its article buffer.
20768
20769 If it is at all possible, this function should return a cons cell where
20770 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
20771 the article number.  This will enable Gnus to find out what the real
20772 group and article numbers are when fetching articles by
20773 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
20774 on successful article retrieval.
20775
20776
20777 @item (nnchoke-request-group GROUP &optional SERVER FAST)
20778
20779 Get data on @var{group}.  This function also has the side effect of
20780 making @var{group} the current group.
20781
20782 If @var{fast}, don't bother to return useful data, just make @var{group}
20783 the current group.
20784
20785 Here's an example of some result data and a definition of the same:
20786
20787 @example
20788 211 56 1000 1059 ifi.discussion
20789 @end example
20790
20791 The first number is the status, which should be 211.  Next is the
20792 total number of articles in the group, the lowest article number, the
20793 highest article number, and finally the group name.  Note that the total
20794 number of articles may be less than one might think while just
20795 considering the highest and lowest article numbers, but some articles
20796 may have been canceled.  Gnus just discards the total-number, so
20797 whether one should take the bother to generate it properly (if that is a
20798 problem) is left as an exercise to the reader.
20799
20800 @example
20801 group-status = [ error / info ] eol
20802 error        = [ "4" / "5" ] 2<number> " " <Error message>
20803 info         = "211 " 3* [ <number> " " ] <string>
20804 @end example
20805
20806
20807 @item (nnchoke-close-group GROUP &optional SERVER)
20808
20809 Close @var{group} and free any resources connected to it.  This will be
20810 a no-op on most backends.
20811
20812 There should be no data returned.
20813
20814
20815 @item (nnchoke-request-list &optional SERVER)
20816
20817 Return a list of all groups available on @var{server}.  And that means
20818 @emph{all}.
20819
20820 Here's an example from a server that only carries two groups:
20821
20822 @example
20823 ifi.test 0000002200 0000002000 y
20824 ifi.discussion 3324 3300 n
20825 @end example
20826
20827 On each line we have a group name, then the highest article number in
20828 that group, the lowest article number, and finally a flag.
20829
20830 @example
20831 active-file = *active-line
20832 active-line = name " " <number> " " <number> " " flags eol
20833 name        = <string>
20834 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
20835 @end example
20836
20837 The flag says whether the group is read-only (@samp{n}), is moderated
20838 (@samp{m}), is dead (@samp{x}), is aliased to some other group
20839 (@samp{=other-group}) or none of the above (@samp{y}).
20840
20841
20842 @item (nnchoke-request-post &optional SERVER)
20843
20844 This function should post the current buffer.  It might return whether
20845 the posting was successful or not, but that's not required.  If, for
20846 instance, the posting is done asynchronously, it has generally not been
20847 completed by the time this function concludes.  In that case, this
20848 function should set up some kind of sentinel to beep the user loud and
20849 clear if the posting could not be completed.
20850
20851 There should be no result data from this function.
20852
20853 @end table
20854
20855
20856 @node Optional Backend Functions
20857 @subsubsection Optional Backend Functions
20858
20859 @table @code
20860
20861 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
20862
20863 @var{groups} is a list of groups, and this function should request data
20864 on all those groups.  How it does it is of no concern to Gnus, but it
20865 should attempt to do this in a speedy fashion.
20866
20867 The return value of this function can be either @code{active} or
20868 @code{group}, which says what the format of the result data is.  The
20869 former is in the same format as the data from
20870 @code{nnchoke-request-list}, while the latter is a buffer full of lines
20871 in the same format as @code{nnchoke-request-group} gives.
20872
20873 @example
20874 group-buffer = *active-line / *group-status
20875 @end example
20876
20877
20878 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
20879
20880 A Gnus group info (@pxref{Group Info}) is handed to the backend for
20881 alterations.  This comes in handy if the backend really carries all the
20882 information (as is the case with virtual and imap groups).  This
20883 function should destructively alter the info to suit its needs, and
20884 should return the (altered) group info.
20885
20886 There should be no result data from this function.
20887
20888
20889 @item (nnchoke-request-type GROUP &optional ARTICLE)
20890
20891 When the user issues commands for ``sending news'' (@kbd{F} in the
20892 summary buffer, for instance), Gnus has to know whether the article the
20893 user is following up on is news or mail.  This function should return
20894 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
20895 is mail and @code{unknown} if the type can't be decided.  (The
20896 @var{article} parameter is necessary in @code{nnvirtual} groups which
20897 might very well combine mail groups and news groups.)  Both @var{group}
20898 and @var{article} may be @code{nil}.
20899
20900 There should be no result data from this function.
20901
20902
20903 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
20904
20905 Set/remove/add marks on articles. Normally Gnus handles the article
20906 marks (such as read, ticked, expired etc) internally, and store them in
20907 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
20908 information about the articles on the server, so Gnus need to propagate
20909 the mark information to the server.
20910
20911 ACTION is a list of mark setting requests, having this format:
20912
20913 @example
20914 (RANGE ACTION MARK)
20915 @end example
20916
20917 Range is a range of articles you wish to update marks on. Action is
20918 @code{set}, @code{add} or @code{del}, respectively used for removing all
20919 existing marks and setting them as specified, adding (preserving the
20920 marks not mentioned) mark and removing (preserving the marks not
20921 mentioned) marks. Mark is a list of marks; where each mark is a
20922 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
20923 @code{expire}, @code{killed}, @code{dormant}, @code{save},
20924 @code{download} and @code{unsend}, but your backend should, if possible,
20925 not limit itself to theese.
20926
20927 Given contradictory actions, the last action in the list should be the
20928 effective one. That is, if your action contains a request to add the
20929 @code{tick} mark on article 1 and, later in the list, a request to
20930 remove the mark on the same article, the mark should in fact be removed.
20931
20932 An example action list:
20933
20934 @example
20935 (((5 12 30) 'del '(tick))
20936  ((10 . 90) 'add '(read expire))
20937  ((92 94) 'del '(read)))
20938 @end example
20939
20940 The function should return a range of articles it wasn't able to set the
20941 mark on (currently not used for anything).
20942
20943 There should be no result data from this function.
20944
20945 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
20946
20947 If the user tries to set a mark that the backend doesn't like, this
20948 function may change the mark.  Gnus will use whatever this function
20949 returns as the mark for @var{article} instead of the original
20950 @var{mark}.  If the backend doesn't care, it must return the original
20951 @var{mark}, and not @code{nil} or any other type of garbage.
20952
20953 The only use for this I can see is what @code{nnvirtual} does with
20954 it---if a component group is auto-expirable, marking an article as read
20955 in the virtual group should result in the article being marked as
20956 expirable.
20957
20958 There should be no result data from this function.
20959
20960
20961 @item (nnchoke-request-scan &optional GROUP SERVER)
20962
20963 This function may be called at any time (by Gnus or anything else) to
20964 request that the backend check for incoming articles, in one way or
20965 another.  A mail backend will typically read the spool file or query the
20966 POP server when this function is invoked.  The @var{group} doesn't have
20967 to be heeded---if the backend decides that it is too much work just
20968 scanning for a single group, it may do a total scan of all groups.  It
20969 would be nice, however, to keep things local if that's practical.
20970
20971 There should be no result data from this function.
20972
20973
20974 @item (nnchoke-request-group-description GROUP &optional SERVER)
20975
20976 The result data from this function should be a description of
20977 @var{group}.
20978
20979 @example
20980 description-line = name <TAB> description eol
20981 name             = <string>
20982 description      = <text>
20983 @end example
20984
20985 @item (nnchoke-request-list-newsgroups &optional SERVER)
20986
20987 The result data from this function should be the description of all
20988 groups available on the server.
20989
20990 @example
20991 description-buffer = *description-line
20992 @end example
20993
20994
20995 @item (nnchoke-request-newgroups DATE &optional SERVER)
20996
20997 The result data from this function should be all groups that were
20998 created after @samp{date}, which is in normal human-readable date
20999 format.  The data should be in the active buffer format.
21000
21001
21002 @item (nnchoke-request-create-group GROUP &optional SERVER)
21003
21004 This function should create an empty group with name @var{group}.
21005
21006 There should be no return data.
21007
21008
21009 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
21010
21011 This function should run the expiry process on all articles in the
21012 @var{articles} range (which is currently a simple list of article
21013 numbers.)  It is left up to the backend to decide how old articles
21014 should be before they are removed by this function.  If @var{force} is
21015 non-@code{nil}, all @var{articles} should be deleted, no matter how new
21016 they are.
21017
21018 This function should return a list of articles that it did not/was not
21019 able to delete.
21020
21021 There should be no result data returned.
21022
21023
21024 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
21025 &optional LAST)
21026
21027 This function should move @var{article} (which is a number) from
21028 @var{group} by calling @var{accept-form}.
21029
21030 This function should ready the article in question for moving by
21031 removing any header lines it has added to the article, and generally
21032 should ``tidy up'' the article.  Then it should @code{eval}
21033 @var{accept-form} in the buffer where the ``tidy'' article is.  This
21034 will do the actual copying.  If this @code{eval} returns a
21035 non-@code{nil} value, the article should be removed.
21036
21037 If @var{last} is @code{nil}, that means that there is a high likelihood
21038 that there will be more requests issued shortly, so that allows some
21039 optimizations.
21040
21041 The function should return a cons where the @code{car} is the group name and
21042 the @code{cdr} is the article number that the article was entered as.
21043
21044 There should be no data returned.
21045
21046
21047 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
21048
21049 This function takes the current buffer and inserts it into @var{group}.
21050 If @var{last} in @code{nil}, that means that there will be more calls to
21051 this function in short order.
21052
21053 The function should return a cons where the @code{car} is the group name and
21054 the @code{cdr} is the article number that the article was entered as.
21055
21056 There should be no data returned.
21057
21058
21059 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
21060
21061 This function should remove @var{article} (which is a number) from
21062 @var{group} and insert @var{buffer} there instead.
21063
21064 There should be no data returned.
21065
21066
21067 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
21068
21069 This function should delete @var{group}.  If @var{force}, it should
21070 really delete all the articles in the group, and then delete the group
21071 itself.  (If there is such a thing as ``the group itself''.)
21072
21073 There should be no data returned.
21074
21075
21076 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
21077
21078 This function should rename @var{group} into @var{new-name}.  All
21079 articles in @var{group} should move to @var{new-name}.
21080
21081 There should be no data returned.
21082
21083 @end table
21084
21085
21086 @node Error Messaging
21087 @subsubsection Error Messaging
21088
21089 @findex nnheader-report
21090 @findex nnheader-get-report
21091 The backends should use the function @code{nnheader-report} to report
21092 error conditions---they should not raise errors when they aren't able to
21093 perform a request.  The first argument to this function is the backend
21094 symbol, and the rest are interpreted as arguments to @code{format} if
21095 there are multiple of them, or just a string if there is one of them.
21096 This function must always returns @code{nil}.
21097
21098 @lisp
21099 (nnheader-report 'nnchoke "You did something totally bogus")
21100
21101 (nnheader-report 'nnchoke "Could not request group %s" group)
21102 @end lisp
21103
21104 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
21105 @code{nil} back from a server, and this function returns the most
21106 recently reported message for the backend in question.  This function
21107 takes one argument---the server symbol.
21108
21109 Internally, these functions access @var{backend}@code{-status-string},
21110 so the @code{nnchoke} backend will have its error message stored in
21111 @code{nnchoke-status-string}.
21112
21113
21114 @node Writing New Backends
21115 @subsubsection Writing New Backends
21116
21117 Many backends are quite similar.  @code{nnml} is just like
21118 @code{nnspool}, but it allows you to edit the articles on the server.
21119 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
21120 and it doesn't maintain overview databases.  @code{nndir} is just like
21121 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
21122 editing articles.
21123
21124 It would make sense if it were possible to ``inherit'' functions from
21125 backends when writing new backends.  And, indeed, you can do that if you
21126 want to.  (You don't have to if you don't want to, of course.)
21127
21128 All the backends declare their public variables and functions by using a
21129 package called @code{nnoo}.
21130
21131 To inherit functions from other backends (and allow other backends to
21132 inherit functions from the current backend), you should use the
21133 following macros:
21134
21135 @table @code
21136
21137 @item nnoo-declare
21138 This macro declares the first parameter to be a child of the subsequent
21139 parameters.  For instance:
21140
21141 @lisp
21142 (nnoo-declare nndir
21143   nnml nnmh)
21144 @end lisp
21145
21146 @code{nndir} has declared here that it intends to inherit functions from
21147 both @code{nnml} and @code{nnmh}.
21148
21149 @item defvoo
21150 This macro is equivalent to @code{defvar}, but registers the variable as
21151 a public server variable.  Most state-oriented variables should be
21152 declared with @code{defvoo} instead of @code{defvar}.
21153
21154 In addition to the normal @code{defvar} parameters, it takes a list of
21155 variables in the parent backends to map the variable to when executing
21156 a function in those backends.
21157
21158 @lisp
21159 (defvoo nndir-directory nil
21160   "Where nndir will look for groups."
21161   nnml-current-directory nnmh-current-directory)
21162 @end lisp
21163
21164 This means that @code{nnml-current-directory} will be set to
21165 @code{nndir-directory} when an @code{nnml} function is called on behalf
21166 of @code{nndir}.  (The same with @code{nnmh}.)
21167
21168 @item nnoo-define-basics
21169 This macro defines some common functions that almost all backends should
21170 have.
21171
21172 @example
21173 (nnoo-define-basics nndir)
21174 @end example
21175
21176 @item deffoo
21177 This macro is just like @code{defun} and takes the same parameters.  In
21178 addition to doing the normal @code{defun} things, it registers the
21179 function as being public so that other backends can inherit it.
21180
21181 @item nnoo-map-functions
21182 This macro allows mapping of functions from the current backend to
21183 functions from the parent backends.
21184
21185 @example
21186 (nnoo-map-functions nndir
21187   (nnml-retrieve-headers 0 nndir-current-group 0 0)
21188   (nnmh-request-article 0 nndir-current-group 0 0))
21189 @end example
21190
21191 This means that when @code{nndir-retrieve-headers} is called, the first,
21192 third, and fourth parameters will be passed on to
21193 @code{nnml-retrieve-headers}, while the second parameter is set to the
21194 value of @code{nndir-current-group}.
21195
21196 @item nnoo-import
21197 This macro allows importing functions from backends.  It should be the
21198 last thing in the source file, since it will only define functions that
21199 haven't already been defined.
21200
21201 @example
21202 (nnoo-import nndir
21203   (nnmh
21204    nnmh-request-list
21205    nnmh-request-newgroups)
21206   (nnml))
21207 @end example
21208
21209 This means that calls to @code{nndir-request-list} should just be passed
21210 on to @code{nnmh-request-list}, while all public functions from
21211 @code{nnml} that haven't been defined in @code{nndir} yet should be
21212 defined now.
21213
21214 @end table
21215
21216 Below is a slightly shortened version of the @code{nndir} backend.
21217
21218 @lisp
21219 ;;; nndir.el --- single directory newsgroup access for Gnus
21220 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
21221
21222 ;;; Code:
21223
21224 (require 'nnheader)
21225 (require 'nnmh)
21226 (require 'nnml)
21227 (require 'nnoo)
21228 (eval-when-compile (require 'cl))
21229
21230 (nnoo-declare nndir
21231   nnml nnmh)
21232
21233 (defvoo nndir-directory nil
21234   "Where nndir will look for groups."
21235   nnml-current-directory nnmh-current-directory)
21236
21237 (defvoo nndir-nov-is-evil nil
21238   "*Non-nil means that nndir will never retrieve NOV headers."
21239   nnml-nov-is-evil)
21240
21241 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
21242 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
21243 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
21244
21245 (defvoo nndir-status-string "" nil nnmh-status-string)
21246 (defconst nndir-version "nndir 1.0")
21247
21248 ;;; Interface functions.
21249
21250 (nnoo-define-basics nndir)
21251
21252 (deffoo nndir-open-server (server &optional defs)
21253   (setq nndir-directory
21254         (or (cadr (assq 'nndir-directory defs))
21255             server))
21256   (unless (assq 'nndir-directory defs)
21257     (push `(nndir-directory ,server) defs))
21258   (push `(nndir-current-group
21259           ,(file-name-nondirectory (directory-file-name nndir-directory)))
21260         defs)
21261   (push `(nndir-top-directory
21262           ,(file-name-directory (directory-file-name nndir-directory)))
21263         defs)
21264   (nnoo-change-server 'nndir server defs))
21265
21266 (nnoo-map-functions nndir
21267   (nnml-retrieve-headers 0 nndir-current-group 0 0)
21268   (nnmh-request-article 0 nndir-current-group 0 0)
21269   (nnmh-request-group nndir-current-group 0 0)
21270   (nnmh-close-group nndir-current-group 0))
21271
21272 (nnoo-import nndir
21273   (nnmh
21274    nnmh-status-message
21275    nnmh-request-list
21276    nnmh-request-newgroups))
21277
21278 (provide 'nndir)
21279 @end lisp
21280
21281
21282 @node Hooking New Backends Into Gnus
21283 @subsubsection Hooking New Backends Into Gnus
21284
21285 @vindex gnus-valid-select-methods
21286 Having Gnus start using your new backend is rather easy---you just
21287 declare it with the @code{gnus-declare-backend} functions.  This will
21288 enter the backend into the @code{gnus-valid-select-methods} variable.
21289
21290 @code{gnus-declare-backend} takes two parameters---the backend name and
21291 an arbitrary number of @dfn{abilities}.
21292
21293 Here's an example:
21294
21295 @lisp
21296 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
21297 @end lisp
21298
21299 The abilities can be:
21300
21301 @table @code
21302 @item mail
21303 This is a mailish backend---followups should (probably) go via mail.
21304 @item post
21305 This is a newsish backend---followups should (probably) go via news.
21306 @item post-mail
21307 This backend supports both mail and news.
21308 @item none
21309 This is neither a post nor mail backend---it's something completely
21310 different.
21311 @item respool
21312 It supports respooling---or rather, it is able to modify its source
21313 articles and groups.
21314 @item address
21315 The name of the server should be in the virtual server name.  This is
21316 true for almost all backends.
21317 @item prompt-address
21318 The user should be prompted for an address when doing commands like
21319 @kbd{B} in the group buffer.  This is true for backends like
21320 @code{nntp}, but not @code{nnmbox}, for instance.
21321 @end table
21322
21323
21324 @node Mail-like Backends
21325 @subsubsection Mail-like Backends
21326
21327 One of the things that separate the mail backends from the rest of the
21328 backends is the heavy dependence by the mail backends on common
21329 functions in @file{nnmail.el}.  For instance, here's the definition of
21330 @code{nnml-request-scan}:
21331
21332 @lisp
21333 (deffoo nnml-request-scan (&optional group server)
21334   (setq nnml-article-file-alist nil)
21335   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
21336 @end lisp
21337
21338 It simply calls @code{nnmail-get-new-mail} with a few parameters,
21339 and @code{nnmail} takes care of all the moving and splitting of the
21340 mail.
21341
21342 This function takes four parameters.
21343
21344 @table @var
21345 @item method
21346 This should be a symbol to designate which backend is responsible for
21347 the call.
21348
21349 @item exit-function
21350 This function should be called after the splitting has been performed.
21351
21352 @item temp-directory
21353 Where the temporary files should be stored.
21354
21355 @item group
21356 This optional argument should be a group name if the splitting is to be
21357 performed for one group only.
21358 @end table
21359
21360 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
21361 save each article.  @var{backend}@code{-active-number} will be called to
21362 find the article number assigned to this article.
21363
21364 The function also uses the following variables:
21365 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
21366 this backend); and @var{backend}@code{-group-alist} and
21367 @var{backend}@code{-active-file} to generate the new active file.
21368 @var{backend}@code{-group-alist} should be a group-active alist, like
21369 this:
21370
21371 @example
21372 (("a-group" (1 . 10))
21373  ("some-group" (34 . 39)))
21374 @end example
21375
21376
21377 @node Score File Syntax
21378 @subsection Score File Syntax
21379
21380 Score files are meant to be easily parseable, but yet extremely
21381 mallable.   It was decided that something that had the same read syntax
21382 as an Emacs Lisp list would fit that spec.
21383
21384 Here's a typical score file:
21385
21386 @lisp
21387 (("summary"
21388   ("win95" -10000 nil s)
21389   ("Gnus"))
21390  ("from"
21391   ("Lars" -1000))
21392  (mark -100))
21393 @end lisp
21394
21395 BNF definition of a score file:
21396
21397 @example
21398 score-file       = "" / "(" *element ")"
21399 element          = rule / atom
21400 rule             = string-rule / number-rule / date-rule
21401 string-rule      = "(" quote string-header quote space *string-match ")"
21402 number-rule      = "(" quote number-header quote space *number-match ")"
21403 date-rule        = "(" quote date-header quote space *date-match ")"
21404 quote            = <ascii 34>
21405 string-header    = "subject" / "from" / "references" / "message-id" /
21406                    "xref" / "body" / "head" / "all" / "followup"
21407 number-header    = "lines" / "chars"
21408 date-header      = "date"
21409 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
21410                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
21411 score            = "nil" / <integer>
21412 date             = "nil" / <natural number>
21413 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
21414                    "r" / "regex" / "R" / "Regex" /
21415                    "e" / "exact" / "E" / "Exact" /
21416                    "f" / "fuzzy" / "F" / "Fuzzy"
21417 number-match     = "(" <integer> [ "" / [ space score [ "" /
21418                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
21419 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
21420 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
21421                    space date [ "" / [ space date-match-t ] ] ] ] ")"
21422 date-match-t     = "nil" / "at" / "before" / "after"
21423 atom             = "(" [ required-atom / optional-atom ] ")"
21424 required-atom    = mark / expunge / mark-and-expunge / files /
21425                    exclude-files / read-only / touched
21426 optional-atom    = adapt / local / eval
21427 mark             = "mark" space nil-or-number
21428 nil-or-number    = "nil" / <integer>
21429 expunge          = "expunge" space nil-or-number
21430 mark-and-expunge = "mark-and-expunge" space nil-or-number
21431 files            = "files" *[ space <string> ]
21432 exclude-files    = "exclude-files" *[ space <string> ]
21433 read-only        = "read-only" [ space "nil" / space "t" ]
21434 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
21435 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
21436 local            = "local" *[ space "(" <string> space <form> ")" ]
21437 eval             = "eval" space <form>
21438 space            = *[ " " / <TAB> / <NEWLINE> ]
21439 @end example
21440
21441 Any unrecognized elements in a score file should be ignored, but not
21442 discarded.
21443
21444 As you can see, white space is needed, but the type and amount of white
21445 space is irrelevant.  This means that formatting of the score file is
21446 left up to the programmer---if it's simpler to just spew it all out on
21447 one looong line, then that's ok.
21448
21449 The meaning of the various atoms are explained elsewhere in this
21450 manual (@pxref{Score File Format}).
21451
21452
21453 @node Headers
21454 @subsection Headers
21455
21456 Internally Gnus uses a format for storing article headers that
21457 corresponds to the @sc{nov} format in a mysterious fashion.  One could
21458 almost suspect that the author looked at the @sc{nov} specification and
21459 just shamelessly @emph{stole} the entire thing, and one would be right.
21460
21461 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
21462 RFC1036 to talk about lines in the head of an article (e.g.,
21463 @code{From}).  It is used by many people as a synonym for
21464 ``head''---``the header and the body''.  (That should be avoided, in my
21465 opinion.)  And Gnus uses a format internally that it calls ``header'',
21466 which is what I'm talking about here.  This is a 9-element vector,
21467 basically, with each header (ouch) having one slot.
21468
21469 These slots are, in order: @code{number}, @code{subject}, @code{from},
21470 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
21471 @code{xref}, and @code{extra}.  There are macros for accessing and
21472 setting these slots---they all have predictable names beginning with
21473 @code{mail-header-} and @code{mail-header-set-}, respectively.
21474
21475 All these slots contain strings, except the @code{extra} slot, which
21476 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
21477
21478
21479 @node Ranges
21480 @subsection Ranges
21481
21482 @sc{gnus} introduced a concept that I found so useful that I've started
21483 using it a lot and have elaborated on it greatly.
21484
21485 The question is simple: If you have a large amount of objects that are
21486 identified by numbers (say, articles, to take a @emph{wild} example)
21487 that you want to qualify as being ``included'', a normal sequence isn't
21488 very useful.  (A 200,000 length sequence is a bit long-winded.)
21489
21490 The solution is as simple as the question: You just collapse the
21491 sequence.
21492
21493 @example
21494 (1 2 3 4 5 6 10 11 12)
21495 @end example
21496
21497 is transformed into
21498
21499 @example
21500 ((1 . 6) (10 . 12))
21501 @end example
21502
21503 To avoid having those nasty @samp{(13 . 13)} elements to denote a
21504 lonesome object, a @samp{13} is a valid element:
21505
21506 @example
21507 ((1 . 6) 7 (10 . 12))
21508 @end example
21509
21510 This means that comparing two ranges to find out whether they are equal
21511 is slightly tricky:
21512
21513 @example
21514 ((1 . 5) 7 8 (10 . 12))
21515 @end example
21516
21517 and
21518
21519 @example
21520 ((1 . 5) (7 . 8) (10 . 12))
21521 @end example
21522
21523 are equal.  In fact, any non-descending list is a range:
21524
21525 @example
21526 (1 2 3 4 5)
21527 @end example
21528
21529 is a perfectly valid range, although a pretty long-winded one.  This is
21530 also valid:
21531
21532 @example
21533 (1 . 5)
21534 @end example
21535
21536 and is equal to the previous range.
21537
21538 Here's a BNF definition of ranges.  Of course, one must remember the
21539 semantic requirement that the numbers are non-descending.  (Any number
21540 of repetition of the same number is allowed, but apt to disappear in
21541 range handling.)
21542
21543 @example
21544 range           = simple-range / normal-range
21545 simple-range    = "(" number " . " number ")"
21546 normal-range    = "(" start-contents ")"
21547 contents        = "" / simple-range *[ " " contents ] /
21548                   number *[ " " contents ]
21549 @end example
21550
21551 Gnus currently uses ranges to keep track of read articles and article
21552 marks.  I plan on implementing a number of range operators in C if The
21553 Powers That Be are willing to let me.  (I haven't asked yet, because I
21554 need to do some more thinking on what operators I need to make life
21555 totally range-based without ever having to convert back to normal
21556 sequences.)
21557
21558
21559 @node Group Info
21560 @subsection Group Info
21561
21562 Gnus stores all permanent info on groups in a @dfn{group info} list.
21563 This list is from three to six elements (or more) long and exhaustively
21564 describes the group.
21565
21566 Here are two example group infos; one is a very simple group while the
21567 second is a more complex one:
21568
21569 @example
21570 ("no.group" 5 ((1 . 54324)))
21571
21572 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
21573                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
21574                 (nnml "")
21575                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
21576 @end example
21577
21578 The first element is the @dfn{group name}---as Gnus knows the group,
21579 anyway.  The second element is the @dfn{subscription level}, which
21580 normally is a small integer.  (It can also be the @dfn{rank}, which is a
21581 cons cell where the @code{car} is the level and the @code{cdr} is the
21582 score.)  The third element is a list of ranges of read articles.  The
21583 fourth element is a list of lists of article marks of various kinds.
21584 The fifth element is the select method (or virtual server, if you like).
21585 The sixth element is a list of @dfn{group parameters}, which is what
21586 this section is about.
21587
21588 Any of the last three elements may be missing if they are not required.
21589 In fact, the vast majority of groups will normally only have the first
21590 three elements, which saves quite a lot of cons cells.
21591
21592 Here's a BNF definition of the group info format:
21593
21594 @example
21595 info          = "(" group space ralevel space read
21596                 [ "" / [ space marks-list [ "" / [ space method [ "" /
21597                 space parameters ] ] ] ] ] ")"
21598 group         = quote <string> quote
21599 ralevel       = rank / level
21600 level         = <integer in the range of 1 to inf>
21601 rank          = "(" level "." score ")"
21602 score         = <integer in the range of 1 to inf>
21603 read          = range
21604 marks-lists   = nil / "(" *marks ")"
21605 marks         = "(" <string> range ")"
21606 method        = "(" <string> *elisp-forms ")"
21607 parameters    = "(" *elisp-forms ")"
21608 @end example
21609
21610 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
21611 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
21612 in pseudo-BNF.
21613
21614 If you have a Gnus info and want to access the elements, Gnus offers a
21615 series of macros for getting/setting these elements.
21616
21617 @table @code
21618 @item gnus-info-group
21619 @itemx gnus-info-set-group
21620 @findex gnus-info-group
21621 @findex gnus-info-set-group
21622 Get/set the group name.
21623
21624 @item gnus-info-rank
21625 @itemx gnus-info-set-rank
21626 @findex gnus-info-rank
21627 @findex gnus-info-set-rank
21628 Get/set the group rank (@pxref{Group Score}).
21629
21630 @item gnus-info-level
21631 @itemx gnus-info-set-level
21632 @findex gnus-info-level
21633 @findex gnus-info-set-level
21634 Get/set the group level.
21635
21636 @item gnus-info-score
21637 @itemx gnus-info-set-score
21638 @findex gnus-info-score
21639 @findex gnus-info-set-score
21640 Get/set the group score (@pxref{Group Score}).
21641
21642 @item gnus-info-read
21643 @itemx gnus-info-set-read
21644 @findex gnus-info-read
21645 @findex gnus-info-set-read
21646 Get/set the ranges of read articles.
21647
21648 @item gnus-info-marks
21649 @itemx gnus-info-set-marks
21650 @findex gnus-info-marks
21651 @findex gnus-info-set-marks
21652 Get/set the lists of ranges of marked articles.
21653
21654 @item gnus-info-method
21655 @itemx gnus-info-set-method
21656 @findex gnus-info-method
21657 @findex gnus-info-set-method
21658 Get/set the group select method.
21659
21660 @item gnus-info-params
21661 @itemx gnus-info-set-params
21662 @findex gnus-info-params
21663 @findex gnus-info-set-params
21664 Get/set the group parameters.
21665 @end table
21666
21667 All the getter functions take one parameter---the info list.  The setter
21668 functions take two parameters---the info list and the new value.
21669
21670 The last three elements in the group info aren't mandatory, so it may be
21671 necessary to extend the group info before setting the element.  If this
21672 is necessary, you can just pass on a non-@code{nil} third parameter to
21673 the three final setter functions to have this happen automatically.
21674
21675
21676 @node Extended Interactive
21677 @subsection Extended Interactive
21678 @cindex interactive
21679 @findex gnus-interactive
21680
21681 Gnus extends the standard Emacs @code{interactive} specification
21682 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
21683 Prefixes}).  Here's an example of how this is used:
21684
21685 @lisp
21686 (defun gnus-summary-increase-score (&optional score symp)
21687   (interactive (gnus-interactive "P\ny"))
21688   ...
21689   )
21690 @end lisp
21691
21692 The best thing to do would have been to implement
21693 @code{gnus-interactive} as a macro which would have returned an
21694 @code{interactive} form, but this isn't possible since Emacs checks
21695 whether a function is interactive or not by simply doing an @code{assq}
21696 on the lambda form.  So, instead we have @code{gnus-interactive}
21697 function that takes a string and returns values that are usable to
21698 @code{interactive}.
21699
21700 This function accepts (almost) all normal @code{interactive} specs, but
21701 adds a few more.
21702
21703 @table @samp
21704 @item y
21705 @vindex gnus-current-prefix-symbol
21706 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
21707 variable.
21708
21709 @item Y
21710 @vindex gnus-current-prefix-symbols
21711 A list of the current symbolic prefixes---the
21712 @code{gnus-current-prefix-symbol} variable.
21713
21714 @item A
21715 The current article number---the @code{gnus-summary-article-number}
21716 function.
21717
21718 @item H
21719 The current article header---the @code{gnus-summary-article-header}
21720 function.
21721
21722 @item g
21723 The current group name---the @code{gnus-group-group-name}
21724 function.
21725
21726 @end table
21727
21728
21729 @node Emacs/XEmacs Code
21730 @subsection Emacs/XEmacs Code
21731 @cindex XEmacs
21732 @cindex Emacsen
21733
21734 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
21735 platforms must be the primary one.  I chose Emacs.  Not because I don't
21736 like XEmacs or Mule, but because it comes first alphabetically.
21737
21738 This means that Gnus will byte-compile under Emacs with nary a warning,
21739 while XEmacs will pump out gigabytes of warnings while byte-compiling.
21740 As I use byte-compilation warnings to help me root out trivial errors in
21741 Gnus, that's very useful.
21742
21743 I've also consistently used Emacs function interfaces, but have used
21744 Gnusey aliases for the functions.  To take an example:  Emacs defines a
21745 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
21746 function.  I then define a function called @code{gnus-run-at-time} that
21747 takes the same parameters as the Emacs @code{run-at-time}.  When running
21748 Gnus under Emacs, the former function is just an alias for the latter.
21749 However, when running under XEmacs, the former is an alias for the
21750 following function:
21751
21752 @lisp
21753 (defun gnus-xmas-run-at-time (time repeat function &rest args)
21754   (start-itimer
21755    "gnus-run-at-time"
21756    `(lambda ()
21757       (,function ,@@args))
21758    time repeat))
21759 @end lisp
21760
21761 This sort of thing has been done for bunches of functions.  Gnus does
21762 not redefine any native Emacs functions while running under XEmacs---it
21763 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
21764 all over.
21765
21766 In the cases where the XEmacs function interface was obviously cleaner,
21767 I used it instead.  For example @code{gnus-region-active-p} is an alias
21768 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
21769
21770 Of course, I could have chosen XEmacs as my native platform and done
21771 mapping functions the other way around.  But I didn't.  The performance
21772 hit these indirections impose on Gnus under XEmacs should be slight.
21773
21774
21775 @node Various File Formats
21776 @subsection Various File Formats
21777
21778 @menu
21779 * Active File Format::      Information on articles and groups available.
21780 * Newsgroups File Format::  Group descriptions.
21781 @end menu
21782
21783
21784 @node Active File Format
21785 @subsubsection Active File Format
21786
21787 The active file lists all groups available on the server in
21788 question.  It also lists the highest and lowest current article numbers
21789 in each group.
21790
21791 Here's an excerpt from a typical active file:
21792
21793 @example
21794 soc.motss 296030 293865 y
21795 alt.binaries.pictures.fractals 3922 3913 n
21796 comp.sources.unix 1605 1593 m
21797 comp.binaries.ibm.pc 5097 5089 y
21798 no.general 1000 900 y
21799 @end example
21800
21801 Here's a pseudo-BNF definition of this file:
21802
21803 @example
21804 active      = *group-line
21805 group-line  = group space high-number space low-number space flag <NEWLINE>
21806 group       = <non-white-space string>
21807 space       = " "
21808 high-number = <non-negative integer>
21809 low-number  = <positive integer>
21810 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
21811 @end example
21812
21813 For a full description of this file, see the manual pages for
21814 @samp{innd}, in particular @samp{active(5)}.
21815
21816
21817 @node Newsgroups File Format
21818 @subsubsection Newsgroups File Format
21819
21820 The newsgroups file lists groups along with their descriptions.  Not all
21821 groups on the server have to be listed,  and not all groups in the file
21822 have to exist on the server.  The file is meant purely as information to
21823 the user.
21824
21825 The format is quite simple; a group name, a tab, and the description.
21826 Here's the definition:
21827
21828 @example
21829 newsgroups    = *line
21830 line          = group tab description <NEWLINE>
21831 group         = <non-white-space string>
21832 tab           = <TAB>
21833 description   = <string>
21834 @end example
21835
21836
21837 @page
21838 @node Emacs for Heathens
21839 @section Emacs for Heathens
21840
21841 Believe it or not, but some people who use Gnus haven't really used
21842 Emacs much before they embarked on their journey on the Gnus Love Boat.
21843 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
21844 region'', and ``set @code{gnus-flargblossen} to an alist where the key
21845 is a regexp that is used for matching on the group name'' are magical
21846 phrases with little or no meaning, then this appendix is for you.  If
21847 you are already familiar with Emacs, just ignore this and go fondle your
21848 cat instead.
21849
21850 @menu
21851 * Keystrokes::      Entering text and executing commands.
21852 * Emacs Lisp::      The built-in Emacs programming language.
21853 @end menu
21854
21855
21856 @node Keystrokes
21857 @subsection Keystrokes
21858
21859 @itemize @bullet
21860 @item
21861 Q: What is an experienced Emacs user?
21862
21863 @item
21864 A: A person who wishes that the terminal had pedals.
21865 @end itemize
21866
21867 Yes, when you use Emacs, you are apt to use the control key, the shift
21868 key and the meta key a lot.  This is very annoying to some people
21869 (notably @code{vi}le users), and the rest of us just love the hell out
21870 of it.  Just give up and submit.  Emacs really does stand for
21871 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
21872 may have heard from other disreputable sources (like the Emacs author).
21873
21874 The shift keys are normally located near your pinky fingers, and are
21875 normally used to get capital letters and stuff.  You probably use it all
21876 the time.  The control key is normally marked ``CTRL'' or something like
21877 that.  The meta key is, funnily enough, never marked as such on any
21878 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
21879 which is the meta key on this keyboard.  It's usually located somewhere
21880 to the left hand side of the keyboard, usually on the bottom row.
21881
21882 Now, us Emacs people don't say ``press the meta-control-m key'',
21883 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
21884 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
21885 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
21886 down the control key, and hold it down while you press @kbd{k}''.
21887 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
21888 the control key and then press @kbd{k}''.  Simple, ay?
21889
21890 This is somewhat complicated by the fact that not all keyboards have a
21891 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
21892 means ``press escape, release escape, press @kbd{k}''.  That's much more
21893 work than if you have a meta key, so if that's the case, I respectfully
21894 suggest you get a real keyboard with a meta key.  You can't live without
21895 it.
21896
21897
21898
21899 @node Emacs Lisp
21900 @subsection Emacs Lisp
21901
21902 Emacs is the King of Editors because it's really a Lisp interpreter.
21903 Each and every key you tap runs some Emacs Lisp code snippet, and since
21904 Emacs Lisp is an interpreted language, that means that you can configure
21905 any key to run any arbitrary code.  You just, like, do it.
21906
21907 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
21908 functions.  (These are byte-compiled for speed, but it's still
21909 interpreted.)  If you decide that you don't like the way Gnus does
21910 certain things, it's trivial to have it do something a different way.
21911 (Well, at least if you know how to write Lisp code.)  However, that's
21912 beyond the scope of this manual, so we are simply going to talk about
21913 some common constructs that you normally use in your @file{.emacs} file
21914 to customize Gnus.
21915
21916 If you want to set the variable @code{gnus-florgbnize} to four (4), you
21917 write the following:
21918
21919 @lisp
21920 (setq gnus-florgbnize 4)
21921 @end lisp
21922
21923 This function (really ``special form'') @code{setq} is the one that can
21924 set a variable to some value.  This is really all you need to know.  Now
21925 you can go and fill your @code{.emacs} file with lots of these to change
21926 how Gnus works.
21927
21928 If you have put that thing in your @code{.emacs} file, it will be read
21929 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
21930 start Emacs.  If you want to change the variable right away, simply say
21931 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
21932 previous ``form'', which is a simple @code{setq} statement here.
21933
21934 Go ahead---just try it, if you're located at your Emacs.  After you
21935 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
21936 is the return value of the form you @code{eval}ed.
21937
21938 Some pitfalls:
21939
21940 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
21941 that means:
21942
21943 @lisp
21944 (setq gnus-read-active-file 'some)
21945 @end lisp
21946
21947 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
21948 @samp{nntp.ifi.uio.no}'', that means:
21949
21950 @lisp
21951 (setq gnus-nntp-server "nntp.ifi.uio.no")
21952 @end lisp
21953
21954 So be careful not to mix up strings (the latter) with symbols (the
21955 former).  The manual is unambiguous, but it can be confusing.
21956
21957 @page
21958 @include gnus-faq.texi
21959
21960 @node Index
21961 @chapter Index
21962 @printindex cp
21963
21964 @node Key Index
21965 @chapter Key Index
21966 @printindex ky
21967
21968 @summarycontents
21969 @contents
21970 @bye
21971
21972 @iftex
21973 @iflatex
21974 \end{document}
21975 @end iflatex
21976 @end iftex
21977
21978 @c End: