Various customization improvements.
[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ß sein!
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éjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
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 Most of the mail backends support fetching by @code{Message-ID}, but do
7431 not do a particularly excellent job at it.  That is, @code{nnmbox} and
7432 @code{nnbabyl} are able to locate articles from any groups, while
7433 @code{nnml} and @code{nnfolder} are only able to locate articles that
7434 have been posted to the current group.  (Anything else would be too time
7435 consuming.)  @code{nnmh} does not support this at all.
7436
7437
7438 @node Alternative Approaches
7439 @section Alternative Approaches
7440
7441 Different people like to read news using different methods.  This being
7442 Gnus, we offer a small selection of minor modes for the summary buffers.
7443
7444 @menu
7445 * Pick and Read::               First mark articles and then read them.
7446 * Binary Groups::               Auto-decode all articles.
7447 @end menu
7448
7449
7450 @node Pick and Read
7451 @subsection Pick and Read
7452 @cindex pick and read
7453
7454 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7455 a two-phased reading interface.  The user first marks in a summary
7456 buffer the articles she wants to read.  Then she starts reading the
7457 articles with just an article buffer displayed.
7458
7459 @findex gnus-pick-mode
7460 @kindex M-x gnus-pick-mode
7461 Gnus provides a summary buffer minor mode that allows
7462 this---@code{gnus-pick-mode}.  This basically means that a few process
7463 mark commands become one-keystroke commands to allow easy marking, and
7464 it provides one additional command for switching to the summary buffer.
7465
7466 Here are the available keystrokes when using pick mode:
7467
7468 @table @kbd
7469 @item .
7470 @kindex . (Pick)
7471 @findex gnus-pick-article-or-thread
7472 Pick the article or thread on the current line
7473 (@code{gnus-pick-article-or-thread}).  If the variable
7474 @code{gnus-thread-hide-subtree} is true, then this key selects the
7475 entire thread when used at the first article of the thread.  Otherwise,
7476 it selects just the article. If given a numerical prefix, go to that
7477 thread or article and pick it.  (The line number is normally displayed
7478 at the beginning of the summary pick lines.)
7479
7480 @item SPACE
7481 @kindex SPACE (Pick)
7482 @findex gnus-pick-next-page
7483 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
7484 at the end of the buffer, start reading the picked articles.
7485
7486 @item u
7487 @kindex u (Pick)
7488 @findex gnus-pick-unmark-article-or-thread.
7489 Unpick the thread or article
7490 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
7491 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7492 thread if used at the first article of the thread.  Otherwise it unpicks
7493 just the article.  You can give this key a numerical prefix to unpick
7494 the thread or article at that line.
7495
7496 @item RET
7497 @kindex RET (Pick)
7498 @findex gnus-pick-start-reading
7499 @vindex gnus-pick-display-summary
7500 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
7501 given a prefix, mark all unpicked articles as read first.  If
7502 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7503 will still be visible when you are reading.
7504
7505 @end table
7506
7507 All the normal summary mode commands are still available in the
7508 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
7509 which is mapped to the same function
7510 @code{gnus-summary-tick-article-forward}.
7511
7512 If this sounds like a good idea to you, you could say:
7513
7514 @lisp
7515 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7516 @end lisp
7517
7518 @vindex gnus-pick-mode-hook
7519 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7520
7521 @vindex gnus-mark-unpicked-articles-as-read
7522 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7523 all unpicked articles as read.  The default is @code{nil}.
7524
7525 @vindex gnus-summary-pick-line-format
7526 The summary line format in pick mode is slightly different from the
7527 standard format.  At the beginning of each line the line number is
7528 displayed.  The pick mode line format is controlled by the
7529 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7530 Variables}).  It accepts the same format specs that
7531 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7532
7533
7534 @node Binary Groups
7535 @subsection Binary Groups
7536 @cindex binary groups
7537
7538 @findex gnus-binary-mode
7539 @kindex M-x gnus-binary-mode
7540 If you spend much time in binary groups, you may grow tired of hitting
7541 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
7542 is a minor mode for summary buffers that makes all ordinary Gnus article
7543 selection functions uudecode series of articles and display the result
7544 instead of just displaying the articles the normal way.
7545
7546 @kindex g (Binary)
7547 @findex gnus-binary-show-article
7548 The only way, in fact, to see the actual articles is the @kbd{g}
7549 command, when you have turned on this mode
7550 (@code{gnus-binary-show-article}).
7551
7552 @vindex gnus-binary-mode-hook
7553 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7554
7555
7556 @node Tree Display
7557 @section Tree Display
7558 @cindex trees
7559
7560 @vindex gnus-use-trees
7561 If you don't like the normal Gnus summary display, you might try setting
7562 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
7563 additional @dfn{tree buffer}.  You can execute all summary mode commands
7564 in the tree buffer.
7565
7566 There are a few variables to customize the tree display, of course:
7567
7568 @table @code
7569 @item gnus-tree-mode-hook
7570 @vindex gnus-tree-mode-hook
7571 A hook called in all tree mode buffers.
7572
7573 @item gnus-tree-mode-line-format
7574 @vindex gnus-tree-mode-line-format
7575 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7576 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
7577 of valid specs, @pxref{Summary Buffer Mode Line}.
7578
7579 @item gnus-selected-tree-face
7580 @vindex gnus-selected-tree-face
7581 Face used for highlighting the selected article in the tree buffer.  The
7582 default is @code{modeline}.
7583
7584 @item gnus-tree-line-format
7585 @vindex gnus-tree-line-format
7586 A format string for the tree nodes.  The name is a bit of a misnomer,
7587 though---it doesn't define a line, but just the node.  The default value
7588 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7589 the name of the poster.  It is vital that all nodes are of the same
7590 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7591
7592 Valid specs are:
7593
7594 @table @samp
7595 @item n
7596 The name of the poster.
7597 @item f
7598 The @code{From} header.
7599 @item N
7600 The number of the article.
7601 @item [
7602 The opening bracket.
7603 @item ]
7604 The closing bracket.
7605 @item s
7606 The subject.
7607 @end table
7608
7609 @xref{Formatting Variables}.
7610
7611 Variables related to the display are:
7612
7613 @table @code
7614 @item gnus-tree-brackets
7615 @vindex gnus-tree-brackets
7616 This is used for differentiating between ``real'' articles and
7617 ``sparse'' articles.  The format is @code{((@var{real-open} . @var{real-close})
7618 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
7619 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7620
7621 @item gnus-tree-parent-child-edges
7622 @vindex gnus-tree-parent-child-edges
7623 This is a list that contains the characters used for connecting parent
7624 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
7625
7626 @end table
7627
7628 @item gnus-tree-minimize-window
7629 @vindex gnus-tree-minimize-window
7630 If this variable is non-@code{nil}, Gnus will try to keep the tree
7631 buffer as small as possible to allow more room for the other Gnus
7632 windows.  If this variable is a number, the tree buffer will never be
7633 higher than that number.  The default is @code{t}.  Note that if you
7634 have several windows displayed side-by-side in a frame and the tree
7635 buffer is one of these, minimizing the tree window will also resize all
7636 other windows displayed next to it.
7637
7638 @item gnus-generate-tree-function
7639 @vindex gnus-generate-tree-function
7640 @findex gnus-generate-horizontal-tree
7641 @findex gnus-generate-vertical-tree
7642 The function that actually generates the thread tree.  Two predefined
7643 functions are available: @code{gnus-generate-horizontal-tree} and
7644 @code{gnus-generate-vertical-tree} (which is the default).
7645
7646 @end table
7647
7648 Here's an example from a horizontal tree buffer:
7649
7650 @example
7651 @{***@}-(***)-[odd]-[Gun]
7652      |      \[Jan]
7653      |      \[odd]-[Eri]
7654      |      \(***)-[Eri]
7655      |            \[odd]-[Paa]
7656      \[Bjo]
7657      \[Gun]
7658      \[Gun]-[Jor]
7659 @end example
7660
7661 Here's the same thread displayed in a vertical tree buffer:
7662
7663 @example
7664 @{***@}
7665   |--------------------------\-----\-----\
7666 (***)                         [Bjo] [Gun] [Gun]
7667   |--\-----\-----\                          |
7668 [odd] [Jan] [odd] (***)                   [Jor]
7669   |           |     |--\
7670 [Gun]       [Eri] [Eri] [odd]
7671                           |
7672                         [Paa]
7673 @end example
7674
7675 If you're using horizontal trees, it might be nice to display the trees
7676 side-by-side with the summary buffer.  You could add something like the
7677 following to your @file{.gnus.el} file:
7678
7679 @lisp
7680 (setq gnus-use-trees t
7681       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7682       gnus-tree-minimize-window nil)
7683 (gnus-add-configuration
7684  '(article
7685    (vertical 1.0
7686              (horizontal 0.25
7687                          (summary 0.75 point)
7688                          (tree 1.0))
7689              (article 1.0))))
7690 @end lisp
7691
7692 @xref{Windows Configuration}.
7693
7694
7695 @node Mail Group Commands
7696 @section Mail Group Commands
7697 @cindex mail group commands
7698
7699 Some commands only make sense in mail groups.  If these commands are
7700 invalid in the current group, they will raise a hell and let you know.
7701
7702 All these commands (except the expiry and edit commands) use the
7703 process/prefix convention (@pxref{Process/Prefix}).
7704
7705 @table @kbd
7706
7707 @item B e
7708 @kindex B e (Summary)
7709 @findex gnus-summary-expire-articles
7710 Expire all expirable articles in the group
7711 (@code{gnus-summary-expire-articles}).
7712
7713 @item B M-C-e
7714 @kindex B M-C-e (Summary)
7715 @findex gnus-summary-expire-articles-now
7716 Delete all the expirable articles in the group
7717 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7718 articles eligible for expiry in the current group will
7719 disappear forever into that big @file{/dev/null} in the sky.
7720
7721 @item B DEL
7722 @kindex B DEL (Summary)
7723 @findex gnus-summary-delete-article
7724 @c @icon{gnus-summary-mail-delete}
7725 Delete the mail article.  This is ``delete'' as in ``delete it from your
7726 disk forever and ever, never to return again.'' Use with caution.
7727 (@code{gnus-summary-delete-article}).
7728
7729 @item B m
7730 @kindex B m (Summary)
7731 @cindex move mail
7732 @findex gnus-summary-move-article
7733 Move the article from one mail group to another
7734 (@code{gnus-summary-move-article}).
7735
7736 @item B c
7737 @kindex B c (Summary)
7738 @cindex copy mail
7739 @findex gnus-summary-copy-article
7740 @c @icon{gnus-summary-mail-copy}
7741 Copy the article from one group (mail group or not) to a mail group
7742 (@code{gnus-summary-copy-article}).
7743
7744 @item B B
7745 @kindex B B (Summary)
7746 @cindex crosspost mail
7747 @findex gnus-summary-crosspost-article
7748 Crosspost the current article to some other group
7749 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7750 the article in the other group, and the Xref headers of the article will
7751 be properly updated.
7752
7753 @item B i
7754 @kindex B i (Summary)
7755 @findex gnus-summary-import-article
7756 Import an arbitrary file into the current mail newsgroup
7757 (@code{gnus-summary-import-article}).  You will be prompted for a file
7758 name, a @code{From} header and a @code{Subject} header.
7759
7760 @item B r
7761 @kindex B r (Summary)
7762 @findex gnus-summary-respool-article
7763 Respool the mail article (@code{gnus-summary-respool-article}).
7764 @code{gnus-summary-respool-default-method} will be used as the default
7765 select method when respooling.  This variable is @code{nil} by default,
7766 which means that the current group select method will be used instead.
7767
7768 @item B w
7769 @itemx e
7770 @kindex B w (Summary)
7771 @kindex e (Summary)
7772 @findex gnus-summary-edit-article
7773 @kindex C-c C-c (Article)
7774 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7775 editing and make the changes permanent, type @kbd{C-c C-c}
7776 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7777 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7778
7779 @item B q
7780 @kindex B q (Summary)
7781 @findex gnus-summary-respool-query
7782 If you want to re-spool an article, you might be curious as to what group
7783 the article will end up in before you do the re-spooling.  This command
7784 will tell you (@code{gnus-summary-respool-query}).
7785
7786 @item B t
7787 @kindex B t (Summary)
7788 @findex gnus-summary-respool-trace
7789 Similarly, this command will display all fancy splitting patterns used
7790 when repooling, if any (@code{gnus-summary-respool-trace}).
7791
7792 @item B p
7793 @kindex B p (Summary)
7794 @findex gnus-summary-article-posted-p
7795 Some people have a tendency to send you "courtesy" copies when they
7796 follow up to articles you have posted.  These usually have a
7797 @code{Newsgroups} header in them, but not always.  This command
7798 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7799 article from your news server (or rather, from
7800 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7801 report back whether it found the article or not.  Even if it says that
7802 it didn't find the article, it may have been posted anyway---mail
7803 propagation is much faster than news propagation, and the news copy may
7804 just not have arrived yet.
7805
7806 @end table
7807
7808 @vindex gnus-move-split-methods
7809 @cindex moving articles
7810 If you move (or copy) articles regularly, you might wish to have Gnus
7811 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7812 variable that uses the same syntax as @code{gnus-split-methods}
7813 (@pxref{Saving Articles}).  You may customize that variable to create
7814 suggestions you find reasonable.
7815
7816 @lisp
7817 (setq gnus-move-split-methods
7818       '(("^From:.*Lars Magne" "nnml:junk")
7819         ("^Subject:.*gnus" "nnfolder:important")
7820         (".*" "nnml:misc")))
7821 @end lisp
7822
7823
7824 @node Various Summary Stuff
7825 @section Various Summary Stuff
7826
7827 @menu
7828 * Summary Group Information::         Information oriented commands.
7829 * Searching for Articles::            Multiple article commands.
7830 * Summary Generation Commands::       (Re)generating the summary buffer.
7831 * Really Various Summary Commands::   Those pesky non-conformant commands.
7832 @end menu
7833
7834 @table @code
7835 @vindex gnus-summary-mode-hook
7836 @item gnus-summary-mode-hook
7837 This hook is called when creating a summary mode buffer.
7838
7839 @vindex gnus-summary-generate-hook
7840 @item gnus-summary-generate-hook
7841 This is called as the last thing before doing the threading and the
7842 generation of the summary buffer.  It's quite convenient for customizing
7843 the threading variables based on what data the newsgroup has.  This hook
7844 is called from the summary buffer after most summary buffer variables
7845 have been set.
7846
7847 @vindex gnus-summary-prepare-hook
7848 @item gnus-summary-prepare-hook
7849 It is called after the summary buffer has been generated.  You might use
7850 it to, for instance, highlight lines or modify the look of the buffer in
7851 some other ungodly manner.  I don't care.
7852
7853 @vindex gnus-summary-prepared-hook
7854 @item gnus-summary-prepared-hook
7855 A hook called as the very last thing after the summary buffer has been
7856 generated.
7857
7858 @vindex gnus-summary-ignore-duplicates
7859 @item gnus-summary-ignore-duplicates
7860 When Gnus discovers two articles that have the same @code{Message-ID},
7861 it has to do something drastic.  No articles are allowed to have the
7862 same @code{Message-ID}, but this may happen when reading mail from some
7863 sources.  Gnus allows you to customize what happens with this variable.
7864 If it is @code{nil} (which is the default), Gnus will rename the
7865 @code{Message-ID} (for display purposes only) and display the article as
7866 any other article.  If this variable is @code{t}, it won't display the
7867 article---it'll be as if it never existed.
7868
7869 @end table
7870
7871
7872 @node Summary Group Information
7873 @subsection Summary Group Information
7874
7875 @table @kbd
7876
7877 @item H f
7878 @kindex H f (Summary)
7879 @findex gnus-summary-fetch-faq
7880 @vindex gnus-group-faq-directory
7881 Try to fetch the FAQ (list of frequently asked questions) for the
7882 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7883 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7884 on a remote machine.  This variable can also be a list of directories.
7885 In that case, giving a prefix to this command will allow you to choose
7886 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7887 be used for fetching the file.
7888
7889 @item H d
7890 @kindex H d (Summary)
7891 @findex gnus-summary-describe-group
7892 Give a brief description of the current group
7893 (@code{gnus-summary-describe-group}).  If given a prefix, force
7894 rereading the description from the server.
7895
7896 @item H h
7897 @kindex H h (Summary)
7898 @findex gnus-summary-describe-briefly
7899 Give an extremely brief description of the most important summary
7900 keystrokes (@code{gnus-summary-describe-briefly}).
7901
7902 @item H i
7903 @kindex H i (Summary)
7904 @findex gnus-info-find-node
7905 Go to the Gnus info node (@code{gnus-info-find-node}).
7906 @end table
7907
7908
7909 @node Searching for Articles
7910 @subsection Searching for Articles
7911
7912 @table @kbd
7913
7914 @item M-s
7915 @kindex M-s (Summary)
7916 @findex gnus-summary-search-article-forward
7917 Search through all subsequent articles for a regexp
7918 (@code{gnus-summary-search-article-forward}).
7919
7920 @item M-r
7921 @kindex M-r (Summary)
7922 @findex gnus-summary-search-article-backward
7923 Search through all previous articles for a regexp
7924 (@code{gnus-summary-search-article-backward}).
7925
7926 @item &
7927 @kindex & (Summary)
7928 @findex gnus-summary-execute-command
7929 This command will prompt you for a header field, a regular expression to
7930 match on this field, and a command to be executed if the match is made
7931 (@code{gnus-summary-execute-command}).  If given a prefix, search
7932 backward instead.
7933
7934 @item M-&
7935 @kindex M-& (Summary)
7936 @findex gnus-summary-universal-argument
7937 Perform any operation on all articles that have been marked with
7938 the process mark (@code{gnus-summary-universal-argument}).
7939 @end table
7940
7941 @node Summary Generation Commands
7942 @subsection Summary Generation Commands
7943
7944 @table @kbd
7945
7946 @item Y g
7947 @kindex Y g (Summary)
7948 @findex gnus-summary-prepare
7949 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7950
7951 @item Y c
7952 @kindex Y c (Summary)
7953 @findex gnus-summary-insert-cached-articles
7954 Pull all cached articles (for the current group) into the summary buffer
7955 (@code{gnus-summary-insert-cached-articles}).
7956
7957 @end table
7958
7959
7960 @node Really Various Summary Commands
7961 @subsection Really Various Summary Commands
7962
7963 @table @kbd
7964
7965 @item A D
7966 @itemx C-d
7967 @kindex C-d (Summary)
7968 @kindex A D (Summary)
7969 @findex gnus-summary-enter-digest-group
7970 If the current article is a collection of other articles (for instance,
7971 a digest), you might use this command to enter a group based on the that
7972 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7973 guess what article type is currently displayed unless you give a prefix
7974 to this command, which forces a ``digest'' interpretation.  Basically,
7975 whenever you see a message that is a collection of other messages of
7976 some format, you @kbd{C-d} and read these messages in a more convenient
7977 fashion.
7978
7979 @item M-C-d
7980 @kindex M-C-d (Summary)
7981 @findex gnus-summary-read-document
7982 This command is very similar to the one above, but lets you gather
7983 several documents into one biiig group
7984 (@code{gnus-summary-read-document}).  It does this by opening several
7985 @code{nndoc} groups for each document, and then opening an
7986 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7987 command understands the process/prefix convention
7988 (@pxref{Process/Prefix}).
7989
7990 @item C-t
7991 @kindex C-t (Summary)
7992 @findex gnus-summary-toggle-truncation
7993 Toggle truncation of summary lines
7994 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7995 line centering function in the summary buffer, so it's not a good idea
7996 to have truncation switched off while reading articles.
7997
7998 @item =
7999 @kindex = (Summary)
8000 @findex gnus-summary-expand-window
8001 Expand the summary buffer window (@code{gnus-summary-expand-window}).
8002 If given a prefix, force an @code{article} window configuration.
8003
8004 @item M-C-e
8005 @kindex M-C-e (Summary)
8006 @findex gnus-summary-edit-parameters
8007 Edit the group parameters (@pxref{Group Parameters}) of the current
8008 group (@code{gnus-summary-edit-parameters}).
8009
8010 @item M-C-g
8011 @kindex M-C-g (Summary)
8012 @findex gnus-summary-customize-parameters
8013 Customize the group parameters (@pxref{Group Parameters}) of the current
8014 group (@code{gnus-summary-customize-parameters}).
8015
8016 @end table
8017
8018
8019 @node Exiting the Summary Buffer
8020 @section Exiting the Summary Buffer
8021 @cindex summary exit
8022 @cindex exiting groups
8023
8024 Exiting from the summary buffer will normally update all info on the
8025 group and return you to the group buffer.
8026
8027 @table @kbd
8028
8029 @item Z Z
8030 @itemx q
8031 @kindex Z Z (Summary)
8032 @kindex q (Summary)
8033 @findex gnus-summary-exit
8034 @vindex gnus-summary-exit-hook
8035 @vindex gnus-summary-prepare-exit-hook
8036 @c @icon{gnus-summary-exit}
8037 Exit the current group and update all information on the group
8038 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
8039 called before doing much of the exiting, which calls
8040 @code{gnus-summary-expire-articles} by default.
8041 @code{gnus-summary-exit-hook} is called after finishing the exit
8042 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
8043 group mode having no more (unread) groups.
8044
8045 @item Z E
8046 @itemx Q
8047 @kindex Z E (Summary)
8048 @kindex Q (Summary)
8049 @findex gnus-summary-exit-no-update
8050 Exit the current group without updating any information on the group
8051 (@code{gnus-summary-exit-no-update}).
8052
8053 @item Z c
8054 @itemx c
8055 @kindex Z c (Summary)
8056 @kindex c (Summary)
8057 @findex gnus-summary-catchup-and-exit
8058 @c @icon{gnus-summary-catchup-and-exit}
8059 Mark all unticked articles in the group as read and then exit
8060 (@code{gnus-summary-catchup-and-exit}).
8061
8062 @item Z C
8063 @kindex Z C (Summary)
8064 @findex gnus-summary-catchup-all-and-exit
8065 Mark all articles, even the ticked ones, as read and then exit
8066 (@code{gnus-summary-catchup-all-and-exit}).
8067
8068 @item Z n
8069 @kindex Z n (Summary)
8070 @findex gnus-summary-catchup-and-goto-next-group
8071 Mark all articles as read and go to the next group
8072 (@code{gnus-summary-catchup-and-goto-next-group}).
8073
8074 @item Z R
8075 @kindex Z R (Summary)
8076 @findex gnus-summary-reselect-current-group
8077 Exit this group, and then enter it again
8078 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
8079 all articles, both read and unread.
8080
8081 @item Z G
8082 @itemx M-g
8083 @kindex Z G (Summary)
8084 @kindex M-g (Summary)
8085 @findex gnus-summary-rescan-group
8086 @c @icon{gnus-summary-mail-get}
8087 Exit the group, check for new articles in the group, and select the
8088 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
8089 articles, both read and unread.
8090
8091 @item Z N
8092 @kindex Z N (Summary)
8093 @findex gnus-summary-next-group
8094 Exit the group and go to the next group
8095 (@code{gnus-summary-next-group}).
8096
8097 @item Z P
8098 @kindex Z P (Summary)
8099 @findex gnus-summary-prev-group
8100 Exit the group and go to the previous group
8101 (@code{gnus-summary-prev-group}).
8102
8103 @item Z s
8104 @kindex Z s (Summary)
8105 @findex gnus-summary-save-newsrc
8106 Save the current number of read/marked articles in the dribble buffer
8107 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
8108 given a prefix, also save the @file{.newsrc} file(s).  Using this
8109 command will make exit without updating (the @kbd{Q} command) worthless.
8110 @end table
8111
8112 @vindex gnus-exit-group-hook
8113 @code{gnus-exit-group-hook} is called when you exit the current
8114 group.
8115
8116 @findex gnus-summary-wake-up-the-dead
8117 @findex gnus-dead-summary-mode
8118 @vindex gnus-kill-summary-on-exit
8119 If you're in the habit of exiting groups, and then changing your mind
8120 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8121 If you do that, Gnus won't kill the summary buffer when you exit it.
8122 (Quelle surprise!)  Instead it will change the name of the buffer to
8123 something like @samp{*Dead Summary ... *} and install a minor mode
8124 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
8125 buffer, you'll find that all keys are mapped to a function called
8126 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
8127 summary buffer will result in a live, normal summary buffer.
8128
8129 There will never be more than one dead summary buffer at any one time.
8130
8131 @vindex gnus-use-cross-reference
8132 The data on the current group will be updated (which articles you have
8133 read, which articles you have replied to, etc.) when you exit the
8134 summary buffer.  If the @code{gnus-use-cross-reference} variable is
8135 @code{t} (which is the default), articles that are cross-referenced to
8136 this group and are marked as read, will also be marked as read in the
8137 other subscribed groups they were cross-posted to.  If this variable is
8138 neither @code{nil} nor @code{t}, the article will be marked as read in
8139 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8140
8141
8142 @node Crosspost Handling
8143 @section Crosspost Handling
8144
8145 @cindex velveeta
8146 @cindex spamming
8147 Marking cross-posted articles as read ensures that you'll never have to
8148 read the same article more than once.  Unless, of course, somebody has
8149 posted it to several groups separately.  Posting the same article to
8150 several groups (not cross-posting) is called @dfn{spamming}, and you are
8151 by law required to send nasty-grams to anyone who perpetrates such a
8152 heinous crime.  You may want to try NoCeM handling to filter out spam
8153 (@pxref{NoCeM}).
8154
8155 Remember: Cross-posting is kinda ok, but posting the same article
8156 separately to several groups is not.  Massive cross-posting (aka.
8157 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8158 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8159 excessive crossposting (@pxref{Summary Mail Commands}).
8160
8161 @cindex cross-posting
8162 @cindex Xref
8163 @cindex @sc{nov}
8164 One thing that may cause Gnus to not do the cross-posting thing
8165 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8166 (which is very nice, because it speeds things up considerably) which
8167 does not include the @code{Xref} header in its @sc{nov} lines.  This is
8168 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
8169 even with @sc{xover} by registering the @code{Xref} lines of all
8170 articles you actually read, but if you kill the articles, or just mark
8171 them as read without reading them, Gnus will not get a chance to snoop
8172 the @code{Xref} lines out of these articles, and will be unable to use
8173 the cross reference mechanism.
8174
8175 @cindex LIST overview.fmt
8176 @cindex overview.fmt
8177 To check whether your @sc{nntp} server includes the @code{Xref} header
8178 in its overview files, try @samp{telnet your.nntp.server nntp},
8179 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8180 overview.fmt}.  This may not work, but if it does, and the last line you
8181 get does not read @samp{Xref:full}, then you should shout and whine at
8182 your news admin until she includes the @code{Xref} header in the
8183 overview files.
8184
8185 @vindex gnus-nov-is-evil
8186 If you want Gnus to get the @code{Xref}s right all the time, you have to
8187 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8188 considerably.
8189
8190 C'est la vie.
8191
8192 For an alternative approach, @pxref{Duplicate Suppression}.
8193
8194
8195 @node Duplicate Suppression
8196 @section Duplicate Suppression
8197
8198 By default, Gnus tries to make sure that you don't have to read the same
8199 article more than once by utilizing the crossposting mechanism
8200 (@pxref{Crosspost Handling}).  However, that simple and efficient
8201 approach may not work satisfactory for some users for various
8202 reasons.
8203
8204 @enumerate
8205 @item
8206 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
8207 is evil and not very common.
8208
8209 @item
8210 The @sc{nntp} server may fail to include the @code{Xref} header in the
8211 @file{.overview} data bases.  This is evil and all too common, alas.
8212
8213 @item
8214 You may be reading the same group (or several related groups) from
8215 different @sc{nntp} servers.
8216
8217 @item
8218 You may be getting mail that duplicates articles posted to groups.
8219 @end enumerate
8220
8221 I'm sure there are other situations where @code{Xref} handling fails as
8222 well, but these four are the most common situations.
8223
8224 If, and only if, @code{Xref} handling fails for you, then you may
8225 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
8226 will remember the @code{Message-ID}s of all articles you have read or
8227 otherwise marked as read, and then, as if by magic, mark them as read
8228 all subsequent times you see them---in @emph{all} groups.  Using this
8229 mechanism is quite likely to be somewhat inefficient, but not overly
8230 so.  It's certainly preferable to reading the same articles more than
8231 once.
8232
8233 Duplicate suppression is not a very subtle instrument.  It's more like a
8234 sledge hammer than anything else.  It works in a very simple
8235 fashion---if you have marked an article as read, it adds this Message-ID
8236 to a cache.  The next time it sees this Message-ID, it will mark the
8237 article as read with the @samp{M} mark.  It doesn't care what group it
8238 saw the article in.
8239
8240 @table @code
8241 @item gnus-suppress-duplicates
8242 @vindex gnus-suppress-duplicates
8243 If non-@code{nil}, suppress duplicates.
8244
8245 @item gnus-save-duplicate-list
8246 @vindex gnus-save-duplicate-list
8247 If non-@code{nil}, save the list of duplicates to a file.  This will
8248 make startup and shutdown take longer, so the default is @code{nil}.
8249 However, this means that only duplicate articles read in a single Gnus
8250 session are suppressed.
8251
8252 @item gnus-duplicate-list-length
8253 @vindex gnus-duplicate-list-length
8254 This variable says how many @code{Message-ID}s to keep in the duplicate
8255 suppression list.  The default is 10000.
8256
8257 @item gnus-duplicate-file
8258 @vindex gnus-duplicate-file
8259 The name of the file to store the duplicate suppression list in.  The
8260 default is @file{~/News/suppression}.
8261 @end table
8262
8263 If you have a tendency to stop and start Gnus often, setting
8264 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
8265 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
8266 the other hand, saving the list makes startup and shutdown much slower,
8267 so that means that if you stop and start Gnus often, you should set
8268 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
8269 to you to figure out, I think.
8270
8271
8272 @node The Article Buffer
8273 @chapter The Article Buffer
8274 @cindex article buffer
8275
8276 The articles are displayed in the article buffer, of which there is only
8277 one.  All the summary buffers share the same article buffer unless you
8278 tell Gnus otherwise.
8279
8280 @menu
8281 * Hiding Headers::        Deciding what headers should be displayed.
8282 * Using MIME::            Pushing articles through @sc{mime} before reading them.
8283 * Customizing Articles::  Tailoring the look of the articles.
8284 * Article Keymap::        Keystrokes available in the article buffer.
8285 * Misc Article::          Other stuff.
8286 @end menu
8287
8288
8289 @node Hiding Headers
8290 @section Hiding Headers
8291 @cindex hiding headers
8292 @cindex deleting headers
8293
8294 The top section of each article is the @dfn{head}.  (The rest is the
8295 @dfn{body}, but you may have guessed that already.)
8296
8297 @vindex gnus-show-all-headers
8298 There is a lot of useful information in the head: the name of the person
8299 who wrote the article, the date it was written and the subject of the
8300 article.  That's well and nice, but there's also lots of information
8301 most people do not want to see---what systems the article has passed
8302 through before reaching you, the @code{Message-ID}, the
8303 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8304 of some of those lines.  If you want to keep all those lines in the
8305 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8306
8307 Gnus provides you with two variables for sifting headers:
8308
8309 @table @code
8310
8311 @item gnus-visible-headers
8312 @vindex gnus-visible-headers
8313 If this variable is non-@code{nil}, it should be a regular expression
8314 that says what headers you wish to keep in the article buffer.  All
8315 headers that do not match this variable will be hidden.
8316
8317 For instance, if you only want to see the name of the person who wrote
8318 the article and the subject, you'd say:
8319
8320 @lisp
8321 (setq gnus-visible-headers "^From:\\|^Subject:")
8322 @end lisp
8323
8324 This variable can also be a list of regexps to match headers to
8325 remain visible.
8326
8327 @item gnus-ignored-headers
8328 @vindex gnus-ignored-headers
8329 This variable is the reverse of @code{gnus-visible-headers}.  If this
8330 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8331 should be a regular expression that matches all lines that you want to
8332 hide.  All lines that do not match this variable will remain visible.
8333
8334 For instance, if you just want to get rid of the @code{References} line
8335 and the @code{Xref} line, you might say:
8336
8337 @lisp
8338 (setq gnus-ignored-headers "^References:\\|^Xref:")
8339 @end lisp
8340
8341 This variable can also be a list of regexps to match headers to
8342 be removed.
8343
8344 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8345 variable will have no effect.
8346
8347 @end table
8348
8349 @vindex gnus-sorted-header-list
8350 Gnus can also sort the headers for you.  (It does this by default.)  You
8351 can control the sorting by setting the @code{gnus-sorted-header-list}
8352 variable.  It is a list of regular expressions that says in what order
8353 the headers are to be displayed.
8354
8355 For instance, if you want the name of the author of the article first,
8356 and then the subject, you might say something like:
8357
8358 @lisp
8359 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8360 @end lisp
8361
8362 Any headers that are to remain visible, but are not listed in this
8363 variable, will be displayed in random order after all the headers listed in this variable.
8364
8365 @findex gnus-article-hide-boring-headers
8366 @vindex gnus-boring-article-headers
8367 You can hide further boring headers by setting
8368 @code{gnus-treat-hide-boring-header} to @code{head}.  What this function
8369 does depends on the @code{gnus-boring-article-headers} variable.  It's a
8370 list, but this list doesn't actually contain header names.  Instead is
8371 lists various @dfn{boring conditions} that Gnus can check and remove
8372 from sight.
8373
8374 These conditions are:
8375 @table @code
8376 @item empty
8377 Remove all empty headers.
8378 @item followup-to
8379 Remove the @code{Followup-To} header if it is identical to the
8380 @code{Newsgroups} header.
8381 @item reply-to
8382 Remove the @code{Reply-To} header if it lists the same address as the
8383 @code{From} header.
8384 @item newsgroups
8385 Remove the @code{Newsgroups} header if it only contains the current group
8386 name.
8387 @item date
8388 Remove the @code{Date} header if the article is less than three days
8389 old.
8390 @item long-to
8391 Remove the @code{To} header if it is very long.
8392 @item many-to
8393 Remove all @code{To} headers if there are more than one.
8394 @end table
8395
8396 To include the four three elements, you could say something like;
8397
8398 @lisp
8399 (setq gnus-boring-article-headers
8400       '(empty followup-to reply-to))
8401 @end lisp
8402
8403 This is also the default value for this variable.
8404
8405
8406 @node Using MIME
8407 @section Using @sc{mime}
8408 @cindex @sc{mime}
8409
8410 Mime is a standard for waving your hands through the air, aimlessly,
8411 while people stand around yawning.
8412
8413 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8414 while all newsreaders die of fear.
8415
8416 @sc{mime} may specify what character set the article uses, the encoding
8417 of the characters, and it also makes it possible to embed pictures and
8418 other naughty stuff in innocent-looking articles.
8419
8420 @vindex gnus-display-mime-function
8421 @findex gnus-display-mime
8422 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
8423 to display the @sc{mime} parts.  This is @code{gnus-display-mime} by
8424 default, which creates a bundle of clickable buttons that can be used to
8425 display, save and manipulate the @sc{mime} objects.
8426
8427 The following commands are available when you have placed point over a
8428 @sc{mime} button:
8429
8430 @table @kbd
8431 @findex gnus-article-press-button
8432 @item RET (Article)
8433 @itemx BUTTON-2 (Article)
8434 Toggle displaying of the @sc{mime} object
8435 (@code{gnus-article-press-button}).
8436
8437 @findex gnus-mime-view-part
8438 @item M-RET (Article)
8439 @itemx v (Article)
8440 Prompt for a method, and then view the @sc{mime} object using this
8441 method (@code{gnus-mime-view-part}).
8442
8443 @findex gnus-mime-save-part
8444 @item o (Article)
8445 Prompt for a file name, and then save the @sc{mime} object
8446 (@code{gnus-mime-save-part}).
8447
8448 @findex gnus-mime-copy-part
8449 @item c (Article)
8450 Copy the @sc{mime} object to a fresh buffer and display this buffer
8451 (@code{gnus-mime-copy-part}).
8452
8453 @findex gnus-mime-view-part-as-type
8454 @item t (Article)
8455 View the @sc{mime} object as if it were a different @sc{mime} media type
8456 (@code{gnus-mime-view-part-as-type}. 
8457
8458 @findex gnus-mime-pipe-part
8459 @item | (Article)
8460 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
8461 @end table
8462
8463 Gnus will display some @sc{mime} objects automatically.  The way Gnus
8464 determines which parts to do this with is described in the Emacs MIME
8465 manual.
8466
8467 It might be best to just use the toggling functions from the article
8468 buffer to avoid getting nasty surprises.  (For instance, you enter the
8469 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
8470 decoded the sound file in the article and some horrible sing-a-long song
8471 comes screaming out your speakers, and you can't find the volume button,
8472 because there isn't one, and people are starting to look at you, and you
8473 try to stop the program, but you can't, and you can't find the program
8474 to control the volume, and everybody else in the room suddenly decides
8475 to look at you disdainfully, and you'll feel rather stupid.)
8476
8477 Any similarity to real events and people is purely coincidental.  Ahem.
8478
8479 Also see @pxref{MIME Commands}.
8480
8481
8482 @node Customizing Articles
8483 @section Customizing Articles
8484 @cindex article customization
8485
8486 A slew of functions for customizing how the articles are to look like
8487 exist.  You can call these functions interactively, or you can have them
8488 called automatically when you select the articles.
8489
8490 To have them called automatically, you should set the corresponding
8491 ``treatment'' variable.  For instance, to have headers hidden, you'd set
8492 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
8493 be set, but first we discuss the values these variables can have.
8494
8495 Note: Some values, while valid, make little sense.  Check the list below
8496 for sensible values.
8497
8498 @enumerate
8499 @item
8500 @code{nil}: Don't do this treatment.
8501
8502 @item
8503 @code{t}: Do this treatment on all body parts.
8504
8505 @item
8506 @code{head}: Do the treatment on the headers.
8507
8508 @item
8509 @code{last}: Do this treatment on the last part.
8510
8511 @item
8512 An integer: Do this treatment on all body parts that have a length less
8513 than this number.
8514
8515 @item
8516 A list of strings: Do this treatment on all body parts that are in
8517 articles that are read in groups that have names that match one of the
8518 regexps in the list.
8519
8520 @item
8521 A list where the first element is not a string:
8522
8523 The list is evaluated recursively.  The first element of the list is a
8524 predicate.  The following predicates are recognized: @code{or},
8525 @code{and}, @code{not} and @code{typep}.  Here's an example:
8526
8527 @lisp
8528 (or last
8529     (typep "text/x-vcard"))
8530 @end lisp
8531
8532 @end enumerate
8533
8534 You may have noticed that the word @dfn{part} is used here.  This refers
8535 to the fact that some messages are @sc{mime} multipart articles that may
8536 be divided into several parts.  Articles that are not multiparts are
8537 considered to contain just a single part.
8538
8539 @vindex gnus-article-treat-types
8540 Are the treatments applied to all sorts of multipart parts?  Yes, if you
8541 want to, but by default, only @samp{text/plain} parts are given the
8542 treatment.  This is controlled by the @code{gnus-article-treat-types}
8543 variable, which is a list of regular expressions that are matched to the
8544 type of the part.  This variable is ignored if the value of the
8545 controlling variable is a predicate list, as described above.
8546
8547 The following treatment options are available.  The easiest way to
8548 customize this is to examine the @code{gnus-article-treat} customization
8549 group. Values in brackets are suggested sensible values. Others are possible
8550 but those listed are probably sufficient for most people.
8551
8552 @table @code
8553 @item gnus-treat-highlight-signature (t, last)
8554 @item gnus-treat-buttonize (t, integer)
8555 @item gnus-treat-buttonize-head (head)
8556 @item gnus-treat-emphasize (t, head, integer)
8557 @item gnus-treat-fill-article (t, integer)
8558 @item gnus-treat-strip-cr (t, integer)
8559 @item gnus-treat-hide-headers (head)
8560 @item gnus-treat-hide-boring-headers (head)
8561 @item gnus-treat-hide-signature (t, last)
8562 @item gnus-treat-hide-citation (t, integer)
8563 @item gnus-treat-strip-pgp (t, last, integer)
8564 @item gnus-treat-strip-pem (t, last, integer)
8565 @item gnus-treat-highlight-headers (head)
8566 @item gnus-treat-highlight-citation (t, integer)
8567 @item gnus-treat-highlight-signature (t, last, integer)
8568 @item gnus-treat-date-ut (head)
8569 @item gnus-treat-date-local (head)
8570 @item gnus-treat-date-lapsed (head)
8571 @item gnus-treat-date-original (head)
8572 @item gnus-treat-strip-headers-in-body (t, integer)
8573 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
8574 @item gnus-treat-strip-leading-blank-lines (t, integer)
8575 @item gnus-treat-strip-multiple-blank-lines (t, integer)
8576 @item gnus-treat-overstrike (t, integer)
8577 @item gnus-treat-display-xface (head)
8578 @item gnus-treat-display-smileys (t, integer)
8579 @item gnus-treat-display-picons (head)
8580 @item gnus-treat-capitalize-sentences (t, integer)
8581 @item gnus-treat-fill-long-lines (t, integer)
8582 @item gnus-treat-play-sounds
8583 @item gnus-treat-translate
8584 @end table
8585
8586 @vindex gnus-part-display-hook
8587 You can, of course, write your own functions to be called from
8588 @code{gnus-part-display-hook}.  The functions are called narrowed to the
8589 part, and you can do anything you like, pretty much.  There is no
8590 information that you have to keep in the buffer---you can change
8591 everything.  
8592
8593
8594 @node Article Keymap
8595 @section Article Keymap
8596
8597 Most of the keystrokes in the summary buffer can also be used in the
8598 article buffer.  They should behave as if you typed them in the summary
8599 buffer, which means that you don't actually have to have a summary
8600 buffer displayed while reading.  You can do it all from the article
8601 buffer.
8602
8603 A few additional keystrokes are available:
8604
8605 @table @kbd
8606
8607 @item SPACE
8608 @kindex SPACE (Article)
8609 @findex gnus-article-next-page
8610 Scroll forwards one page (@code{gnus-article-next-page}).
8611
8612 @item DEL
8613 @kindex DEL (Article)
8614 @findex gnus-article-prev-page
8615 Scroll backwards one page (@code{gnus-article-prev-page}).
8616
8617 @item C-c ^
8618 @kindex C-c ^ (Article)
8619 @findex gnus-article-refer-article
8620 If point is in the neighborhood of a @code{Message-ID} and you press
8621 @kbd{C-c ^}, Gnus will try to get that article from the server
8622 (@code{gnus-article-refer-article}).
8623
8624 @item C-c C-m
8625 @kindex C-c C-m (Article)
8626 @findex gnus-article-mail
8627 Send a reply to the address near point (@code{gnus-article-mail}).  If
8628 given a prefix, include the mail.
8629
8630 @item s
8631 @kindex s (Article)
8632 @findex gnus-article-show-summary
8633 Reconfigure the buffers so that the summary buffer becomes visible
8634 (@code{gnus-article-show-summary}).
8635
8636 @item ?
8637 @kindex ? (Article)
8638 @findex gnus-article-describe-briefly
8639 Give a very brief description of the available keystrokes
8640 (@code{gnus-article-describe-briefly}).
8641
8642 @item TAB
8643 @kindex TAB (Article)
8644 @findex gnus-article-next-button
8645 Go to the next button, if any (@code{gnus-article-next-button}).  This
8646 only makes sense if you have buttonizing turned on.
8647
8648 @item M-TAB
8649 @kindex M-TAB (Article)
8650 @findex gnus-article-prev-button
8651 Go to the previous button, if any (@code{gnus-article-prev-button}).
8652
8653 @end table
8654
8655
8656 @node Misc Article
8657 @section Misc Article
8658
8659 @table @code
8660
8661 @item gnus-single-article-buffer
8662 @vindex gnus-single-article-buffer
8663 If non-@code{nil}, use the same article buffer for all the groups.
8664 (This is the default.)  If @code{nil}, each group will have its own
8665 article buffer.
8666
8667 @vindex gnus-article-decode-hook
8668 @item gnus-article-decode-hook
8669 @cindex MIME
8670 Hook used to decode @sc{mime} articles.  The default value is
8671 @code{(article-decode-charset article-decode-encoded-words)}
8672
8673 @vindex gnus-article-prepare-hook
8674 @item gnus-article-prepare-hook
8675 This hook is called right after the article has been inserted into the
8676 article buffer.  It is mainly intended for functions that do something
8677 depending on the contents; it should probably not be used for changing
8678 the contents of the article buffer.
8679
8680 @item gnus-article-mode-hook
8681 @vindex gnus-article-mode-hook
8682 Hook called in article mode buffers.
8683
8684 @item gnus-article-mode-syntax-table
8685 @vindex gnus-article-mode-syntax-table
8686 Syntax table used in article buffers.  It is initialized from
8687 @code{text-mode-syntax-table}.
8688
8689 @vindex gnus-article-mode-line-format
8690 @item gnus-article-mode-line-format
8691 This variable is a format string along the same lines as
8692 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
8693 accepts the same format specifications as that variable, with one
8694 extension:
8695
8696 @table @samp
8697 @item w
8698 The @dfn{wash status} of the article.  This is a short string with one
8699 character for each possible article wash operation that may have been
8700 performed.
8701 @item m
8702 The number of @sc{mime} parts in the article.
8703 @end table
8704
8705 @vindex gnus-break-pages
8706
8707 @item gnus-break-pages
8708 Controls whether @dfn{page breaking} is to take place.  If this variable
8709 is non-@code{nil}, the articles will be divided into pages whenever a
8710 page delimiter appears in the article.  If this variable is @code{nil},
8711 paging will not be done.
8712
8713 @item gnus-page-delimiter
8714 @vindex gnus-page-delimiter
8715 This is the delimiter mentioned above.  By default, it is @samp{^L}
8716 (formfeed).
8717 @end table
8718
8719
8720 @node Composing Messages
8721 @chapter Composing Messages
8722 @cindex composing messages
8723 @cindex messages
8724 @cindex mail
8725 @cindex sending mail
8726 @cindex reply
8727 @cindex followup
8728 @cindex post
8729
8730 @kindex C-c C-c (Post)
8731 All commands for posting and mailing will put you in a message buffer
8732 where you can edit the article all you like, before you send the article
8733 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
8734 Manual}.  If you are in a foreign news group, and you wish to post the
8735 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8736 to make Gnus try to post using the foreign server.
8737
8738 @menu
8739 * Mail::                 Mailing and replying.
8740 * Post::                 Posting and following up.
8741 * Posting Server::       What server should you post via?
8742 * Mail and Post::        Mailing and posting at the same time.
8743 * Archived Messages::    Where Gnus stores the messages you've sent.
8744 * Posting Styles::       An easier way to specify who you are.
8745 * Drafts::               Postponing messages and rejected messages.
8746 * Rejected Articles::    What happens if the server doesn't like your article?
8747 @end menu
8748
8749 Also see @pxref{Canceling and Superseding} for information on how to
8750 remove articles you shouldn't have posted.
8751
8752
8753 @node Mail
8754 @section Mail
8755
8756 Variables for customizing outgoing mail:
8757
8758 @table @code
8759 @item gnus-uu-digest-headers
8760 @vindex gnus-uu-digest-headers
8761 List of regexps to match headers included in digested messages.  The
8762 headers will be included in the sequence they are matched.
8763
8764 @item gnus-add-to-list
8765 @vindex gnus-add-to-list
8766 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8767 that have none when you do a @kbd{a}.
8768
8769 @end table
8770
8771
8772 @node Post
8773 @section Post
8774
8775 Variables for composing news articles:
8776
8777 @table @code
8778 @item gnus-sent-message-ids-file
8779 @vindex gnus-sent-message-ids-file
8780 Gnus will keep a @code{Message-ID} history file of all the mails it has
8781 sent.  If it discovers that it has already sent a mail, it will ask the
8782 user whether to re-send the mail.  (This is primarily useful when
8783 dealing with @sc{soup} packets and the like where one is apt to send the
8784 same packet multiple times.)  This variable says what the name of this
8785 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8786 this variable to @code{nil} if you don't want Gnus to keep a history
8787 file.
8788
8789 @item gnus-sent-message-ids-length
8790 @vindex gnus-sent-message-ids-length
8791 This variable says how many @code{Message-ID}s to keep in the history
8792 file.  It is 1000 by default.
8793
8794 @end table
8795
8796
8797 @node Posting Server
8798 @section Posting Server
8799
8800 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8801 (extremely intelligent, of course) article, where does it go?
8802
8803 Thank you for asking.  I hate you.
8804
8805 @vindex gnus-post-method
8806
8807 It can be quite complicated.  Normally, Gnus will use the same native
8808 server.  However.  If your native server doesn't allow posting, just
8809 reading, you probably want to use some other server to post your
8810 (extremely intelligent and fabulously interesting) articles.  You can
8811 then set the @code{gnus-post-method} to some other method:
8812
8813 @lisp
8814 (setq gnus-post-method '(nnspool ""))
8815 @end lisp
8816
8817 Now, if you've done this, and then this server rejects your article, or
8818 this server is down, what do you do then?  To override this variable you
8819 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8820 the ``current'' server for posting.
8821
8822 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8823 Gnus will prompt you for what method to use for posting.
8824
8825 You can also set @code{gnus-post-method} to a list of select methods.
8826 If that's the case, Gnus will always prompt you for what method to use
8827 for posting.
8828
8829 Finally, if you want to always post using the same select method as
8830 you're reading from (which might be convenient if you're reading lots of
8831 groups from different private servers), you can set this variable to
8832 @code{current}.
8833
8834
8835 @node Mail and Post
8836 @section Mail and Post
8837
8838 Here's a list of variables relevant to both mailing and
8839 posting:
8840
8841 @table @code
8842 @item gnus-mailing-list-groups
8843 @findex gnus-mailing-list-groups
8844 @cindex mailing lists
8845
8846 If your news server offers groups that are really mailing lists
8847 gatewayed to the @sc{nntp} server, you can read those groups without
8848 problems, but you can't post/followup to them without some difficulty.
8849 One solution is to add a @code{to-address} to the group parameters
8850 (@pxref{Group Parameters}).  An easier thing to do is set the
8851 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8852 really are mailing lists.  Then, at least, followups to the mailing
8853 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8854 still a pain, though.
8855
8856 @end table
8857
8858 You may want to do spell-checking on messages that you send out.  Or, if
8859 you don't want to spell-check by hand, you could add automatic
8860 spell-checking via the @code{ispell} package:
8861
8862 @cindex ispell
8863 @findex ispell-message
8864 @lisp
8865 (add-hook 'message-send-hook 'ispell-message)
8866 @end lisp
8867
8868
8869 @node Archived Messages
8870 @section Archived Messages
8871 @cindex archived messages
8872 @cindex sent messages
8873
8874 Gnus provides a few different methods for storing the mail and news you
8875 send.  The default method is to use the @dfn{archive virtual server} to
8876 store the messages.  If you want to disable this completely, the
8877 @code{gnus-message-archive-group} variable should be @code{nil}, which
8878 is the default.
8879
8880 @vindex gnus-message-archive-method
8881 @code{gnus-message-archive-method} says what virtual server Gnus is to
8882 use to store sent messages.  The default is:
8883
8884 @lisp
8885 (nnfolder "archive"
8886           (nnfolder-directory   "~/Mail/archive")
8887           (nnfolder-active-file "~/Mail/archive/active")
8888           (nnfolder-get-new-mail nil)
8889           (nnfolder-inhibit-expiry t))
8890 @end lisp
8891
8892 You can, however, use any mail select method (@code{nnml},
8893 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8894 for doing this sort of thing, though.  If you don't like the default
8895 directory chosen, you could say something like:
8896
8897 @lisp
8898 (setq gnus-message-archive-method
8899       '(nnfolder "archive"
8900                  (nnfolder-inhibit-expiry t)
8901                  (nnfolder-active-file "~/News/sent-mail/active")
8902                  (nnfolder-directory "~/News/sent-mail/")))
8903 @end lisp
8904
8905 @vindex gnus-message-archive-group
8906 @cindex Gcc
8907 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8908 to one or more group(s) on that server.  Which group to use is
8909 determined by the @code{gnus-message-archive-group} variable.
8910
8911 This variable can be used to do the following:
8912
8913 @itemize @bullet
8914 @item a string
8915 Messages will be saved in that group.
8916 @item a list of strings
8917 Messages will be saved in all those groups.
8918 @item an alist of regexps, functions and forms
8919 When a key ``matches'', the result is used.
8920 @item @code{nil}
8921 No message archiving will take place.  This is the default.
8922 @end itemize
8923
8924 Let's illustrate:
8925
8926 Just saving to a single group called @samp{MisK}:
8927 @lisp
8928 (setq gnus-message-archive-group "MisK")
8929 @end lisp
8930
8931 Saving to two groups, @samp{MisK} and @samp{safe}:
8932 @lisp
8933 (setq gnus-message-archive-group '("MisK" "safe"))
8934 @end lisp
8935
8936 Save to different groups based on what group you are in:
8937 @lisp
8938 (setq gnus-message-archive-group
8939       '(("^alt" "sent-to-alt")
8940         ("mail" "sent-to-mail")
8941         (".*" "sent-to-misc")))
8942 @end lisp
8943
8944 More complex stuff:
8945 @lisp
8946 (setq gnus-message-archive-group
8947       '((if (message-news-p)
8948             "misc-news"
8949           "misc-mail")))
8950 @end lisp
8951
8952 How about storing all news messages in one file, but storing all mail
8953 messages in one file per month:
8954
8955 @lisp
8956 (setq gnus-message-archive-group
8957       '((if (message-news-p)
8958             "misc-news"
8959           (concat "mail." (format-time-string "%Y-%m")))))
8960 @end lisp
8961
8962 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8963 use a different value for @code{gnus-message-archive-group} there.)
8964
8965 Now, when you send a message off, it will be stored in the appropriate
8966 group.  (If you want to disable storing for just one particular message,
8967 you can just remove the @code{Gcc} header that has been inserted.)  The
8968 archive group will appear in the group buffer the next time you start
8969 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
8970 enter it and read the articles in it just like you'd read any other
8971 group.  If the group gets really big and annoying, you can simply rename
8972 if (using @kbd{G r} in the group buffer) to something
8973 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8974 continue to be stored in the old (now empty) group.
8975
8976 That's the default method of archiving sent messages.  Gnus offers a
8977 different way for the people who don't like the default method.  In that
8978 case you should set @code{gnus-message-archive-group} to @code{nil};
8979 this will disable archiving.
8980
8981 @table @code
8982 @item gnus-outgoing-message-group
8983 @vindex gnus-outgoing-message-group
8984 All outgoing messages will be put in this group.  If you want to store
8985 all your outgoing mail and articles in the group @samp{nnml:archive},
8986 you set this variable to that value.  This variable can also be a list of
8987 group names.
8988
8989 If you want to have greater control over what group to put each
8990 message in, you can set this variable to a function that checks the
8991 current newsgroup name and then returns a suitable group name (or list
8992 of names).
8993
8994 This variable can be used instead of @code{gnus-message-archive-group},
8995 but the latter is the preferred method.
8996 @end table
8997
8998
8999 @node Posting Styles
9000 @section Posting Styles
9001 @cindex posting styles
9002 @cindex styles
9003
9004 All them variables, they make my head swim.
9005
9006 So what if you want a different @code{Organization} and signature based
9007 on what groups you post to?  And you post both from your home machine
9008 and your work machine, and you want different @code{From} lines, and so
9009 on?
9010
9011 @vindex gnus-posting-styles
9012 One way to do stuff like that is to write clever hooks that change the
9013 variables you need to have changed.  That's a bit boring, so somebody
9014 came up with the bright idea of letting the user specify these things in
9015 a handy alist.  Here's an example of a @code{gnus-posting-styles}
9016 variable:
9017
9018 @lisp
9019 ((".*"
9020   (signature "Peace and happiness")
9021   (organization "What me?"))
9022  ("^comp"
9023   (signature "Death to everybody"))
9024  ("comp.emacs.i-love-it"
9025   (organization "Emacs is it")))
9026 @end lisp
9027
9028 As you might surmise from this example, this alist consists of several
9029 @dfn{styles}.  Each style will be applicable if the first element
9030 ``matches'', in some form or other.  The entire alist will be iterated
9031 over, from the beginning towards the end, and each match will be
9032 applied, which means that attributes in later styles that match override
9033 the same attributes in earlier matching styles.  So
9034 @samp{comp.programming.literate} will have the @samp{Death to everybody}
9035 signature and the @samp{What me?} @code{Organization} header.
9036
9037 The first element in each style is called the @code{match}.  If it's a
9038 string, then Gnus will try to regexp match it against the group name.
9039 If it is the symbol @code{header}, then Gnus will look for header that
9040 match the next element in the match, and compare that to the last header
9041 in the match.  If it's a function symbol, that function will be called
9042 with no arguments.  If it's a variable symbol, then the variable will be
9043 referenced.  If it's a list, then that list will be @code{eval}ed.  In
9044 any case, if this returns a non-@code{nil} value, then the style is said
9045 to @dfn{match}.
9046
9047 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
9048 attribute consists of a @code{(@var{name} . @var{value})} pair.  The
9049 attribute name can be one of @code{signature}, @code{signature-file},
9050 @code{organization}, @code{address}, @code{name} or @code{body}.  The
9051 attribute name can also be a string.  In that case, this will be used as
9052 a header name, and the value will be inserted in the headers of the
9053 article.  If the attribute name is @code{eval}, the form is evaluated,
9054 and the result is thrown away.
9055
9056 The attribute value can be a string (used verbatim), a function with
9057 zero arguments (the return value will be used), a variable (its value
9058 will be used) or a list (it will be @code{eval}ed and the return value
9059 will be used).  The functions and sexps are called/@code{eval}ed in the
9060 message buffer that is being set up.  The headers of the current article
9061 are available through the @code{message-reply-headers} variable.
9062
9063 If you wish to check whether the message you are about to compose is
9064 meant to be a news article or a mail message, you can check the values
9065 of the @code{message-news-p} and @code{message-mail-p} functions.
9066
9067 @findex message-mail-p
9068 @findex message-news-p
9069
9070 So here's a new example:
9071
9072 @lisp
9073 (setq gnus-posting-styles
9074       '((".*"
9075          (signature-file "~/.signature")
9076          (name "User Name")
9077          ("X-Home-Page" (getenv "WWW_HOME"))
9078          (organization "People's Front Against MWM"))
9079         ("^rec.humor"
9080          (signature my-funny-signature-randomizer))
9081         ((equal (system-name) "gnarly")
9082          (signature my-quote-randomizer))
9083         ((message-news-p)
9084          (signature my-news-signature))
9085         ((header "From.*To" "larsi.*org")
9086          (Organization "Somewhere, Inc."))
9087         ((posting-from-work-p)
9088          (signature-file "~/.work-signature")
9089          (address "user@@bar.foo")
9090          (body "You are fired.\n\nSincerely, your boss.")
9091          (organization "Important Work, Inc"))
9092         ("^nn.+:"
9093          (signature-file "~/.mail-signature"))))
9094 @end lisp
9095
9096
9097 @node Drafts
9098 @section Drafts
9099 @cindex drafts
9100
9101 If you are writing a message (mail or news) and suddenly remember that
9102 you have a steak in the oven (or some pesto in the food processor, you
9103 craaazy vegetarians), you'll probably wish there was a method to save
9104 the message you are writing so that you can continue editing it some
9105 other day, and send it when you feel its finished.
9106
9107 Well, don't worry about it.  Whenever you start composing a message of
9108 some sort using the Gnus mail and post commands, the buffer you get will
9109 automatically associate to an article in a special @dfn{draft} group.
9110 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
9111 article will be saved there.  (Auto-save files also go to the draft
9112 group.)
9113
9114 @cindex nndraft
9115 @vindex nndraft-directory
9116 The draft group is a special group (which is implemented as an
9117 @code{nndraft} group, if you absolutely have to know) called
9118 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
9119 @code{nndraft} is to store its files.  What makes this group special is
9120 that you can't tick any articles in it or mark any articles as
9121 read---all articles in the group are permanently unread.
9122
9123 If the group doesn't exist, it will be created and you'll be subscribed
9124 to it.  The only way to make it disappear from the Group buffer is to
9125 unsubscribe it.
9126
9127 @c @findex gnus-dissociate-buffer-from-draft
9128 @c @kindex C-c M-d (Mail)
9129 @c @kindex C-c M-d (Post)
9130 @c @findex gnus-associate-buffer-with-draft
9131 @c @kindex C-c C-d (Mail)
9132 @c @kindex C-c C-d (Post)
9133 @c If you're writing some super-secret message that you later want to
9134 @c encode with PGP before sending, you may wish to turn the auto-saving
9135 @c (and association with the draft group) off.  You never know who might be
9136 @c interested in reading all your extremely valuable and terribly horrible
9137 @c and interesting secrets.  The @kbd{C-c M-d}
9138 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9139 @c If you change your mind and want to turn the auto-saving back on again,
9140 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9141 @c
9142 @c @vindex gnus-use-draft
9143 @c To leave association with the draft group off by default, set
9144 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
9145
9146 @findex gnus-draft-edit-message
9147 @kindex D e (Draft)
9148 When you want to continue editing the article, you simply enter the
9149 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9150 that.  You will be placed in a buffer where you left off.
9151
9152 Rejected articles will also be put in this draft group (@pxref{Rejected
9153 Articles}).
9154
9155 @findex gnus-draft-send-all-messages
9156 @findex gnus-draft-send-message
9157 If you have lots of rejected messages you want to post (or mail) without
9158 doing further editing, you can use the @kbd{D s} command
9159 (@code{gnus-draft-send-message}).  This command understands the
9160 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
9161 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9162 in the buffer.
9163
9164 If you have some messages that you wish not to send, you can use the
9165 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9166 as unsendable.  This is a toggling command.
9167
9168
9169 @node Rejected Articles
9170 @section Rejected Articles
9171 @cindex rejected articles
9172
9173 Sometimes a news server will reject an article.  Perhaps the server
9174 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
9175 @emph{there be demons}.  Perhaps you have included too much cited text.
9176 Perhaps the disk is full.  Perhaps the server is down.
9177
9178 These situations are, of course, totally beyond the control of Gnus.
9179 (Gnus, of course, loves the way you look, always feels great, has angels
9180 fluttering around inside of it, doesn't care about how much cited text
9181 you include, never runs full and never goes down.)  So Gnus saves these
9182 articles until some later time when the server feels better.
9183
9184 The rejected articles will automatically be put in a special draft group
9185 (@pxref{Drafts}).  When the server comes back up again, you'd then
9186 typically enter that group and send all the articles off.
9187
9188
9189 @node Select Methods
9190 @chapter Select Methods
9191 @cindex foreign groups
9192 @cindex select methods
9193
9194 A @dfn{foreign group} is a group not read by the usual (or
9195 default) means.  It could be, for instance, a group from a different
9196 @sc{nntp} server, it could be a virtual group, or it could be your own
9197 personal mail group.
9198
9199 A foreign group (or any group, really) is specified by a @dfn{name} and
9200 a @dfn{select method}.  To take the latter first, a select method is a
9201 list where the first element says what backend to use (e.g. @code{nntp},
9202 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
9203 name}.  There may be additional elements in the select method, where the
9204 value may have special meaning for the backend in question.
9205
9206 One could say that a select method defines a @dfn{virtual server}---so
9207 we do just that (@pxref{The Server Buffer}).
9208
9209 The @dfn{name} of the group is the name the backend will recognize the
9210 group as.
9211
9212 For instance, the group @samp{soc.motss} on the @sc{nntp} server
9213 @samp{some.where.edu} will have the name @samp{soc.motss} and select
9214 method @code{(nntp "some.where.edu")}.  Gnus will call this group
9215 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
9216 backend just knows this group as @samp{soc.motss}.
9217
9218 The different methods all have their peculiarities, of course.
9219
9220 @menu
9221 * The Server Buffer::     Making and editing virtual servers.
9222 * Getting News::          Reading USENET news with Gnus.
9223 * Getting Mail::          Reading your personal mail with Gnus.
9224 * Browsing the Web::      Getting messages from a plethora of Web sources.
9225 * Other Sources::         Reading directories, files, SOUP packets.
9226 * Combined Groups::       Combining groups into one group.
9227 * Gnus Unplugged::        Reading news and mail offline.
9228 @end menu
9229
9230
9231 @node The Server Buffer
9232 @section The Server Buffer
9233
9234 Traditionally, a @dfn{server} is a machine or a piece of software that
9235 one connects to, and then requests information from.  Gnus does not
9236 connect directly to any real servers, but does all transactions through
9237 one backend or other.  But that's just putting one layer more between
9238 the actual media and Gnus, so we might just as well say that each
9239 backend represents a virtual server.
9240
9241 For instance, the @code{nntp} backend may be used to connect to several
9242 different actual @sc{nntp} servers, or, perhaps, to many different ports
9243 on the same actual @sc{nntp} server.  You tell Gnus which backend to
9244 use, and what parameters to set by specifying a @dfn{select method}.
9245
9246 These select method specifications can sometimes become quite
9247 complicated---say, for instance, that you want to read from the
9248 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9249 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
9250 Anyways, if you had to specify that for each group that used this
9251 server, that would be too much work, so Gnus offers a way of naming
9252 select methods, which is what you do in the server buffer.
9253
9254 To enter the server buffer, use the @kbd{^}
9255 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9256
9257 @menu
9258 * Server Buffer Format::      You can customize the look of this buffer.
9259 * Server Commands::           Commands to manipulate servers.
9260 * Example Methods::           Examples server specifications.
9261 * Creating a Virtual Server:: An example session.
9262 * Server Variables::          Which variables to set.
9263 * Servers and Methods::       You can use server names as select methods.
9264 * Unavailable Servers::       Some servers you try to contact may be down.
9265 @end menu
9266
9267 @vindex gnus-server-mode-hook
9268 @code{gnus-server-mode-hook} is run when creating the server buffer.
9269
9270
9271 @node Server Buffer Format
9272 @subsection Server Buffer Format
9273 @cindex server buffer format
9274
9275 @vindex gnus-server-line-format
9276 You can change the look of the server buffer lines by changing the
9277 @code{gnus-server-line-format} variable.  This is a @code{format}-like
9278 variable, with some simple extensions:
9279
9280 @table @samp
9281
9282 @item h
9283 How the news is fetched---the backend name.
9284
9285 @item n
9286 The name of this server.
9287
9288 @item w
9289 Where the news is to be fetched from---the address.
9290
9291 @item s
9292 The opened/closed/denied status of the server.
9293 @end table
9294
9295 @vindex gnus-server-mode-line-format
9296 The mode line can also be customized by using the
9297 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9298 Formatting}).  The following specs are understood:
9299
9300 @table @samp
9301 @item S
9302 Server name.
9303
9304 @item M
9305 Server method.
9306 @end table
9307
9308 Also @pxref{Formatting Variables}.
9309
9310
9311 @node Server Commands
9312 @subsection Server Commands
9313 @cindex server commands
9314
9315 @table @kbd
9316
9317 @item a
9318 @kindex a (Server)
9319 @findex gnus-server-add-server
9320 Add a new server (@code{gnus-server-add-server}).
9321
9322 @item e
9323 @kindex e (Server)
9324 @findex gnus-server-edit-server
9325 Edit a server (@code{gnus-server-edit-server}).
9326
9327 @item SPACE
9328 @kindex SPACE (Server)
9329 @findex gnus-server-read-server
9330 Browse the current server (@code{gnus-server-read-server}).
9331
9332 @item q
9333 @kindex q (Server)
9334 @findex gnus-server-exit
9335 Return to the group buffer (@code{gnus-server-exit}).
9336
9337 @item k
9338 @kindex k (Server)
9339 @findex gnus-server-kill-server
9340 Kill the current server (@code{gnus-server-kill-server}).
9341
9342 @item y
9343 @kindex y (Server)
9344 @findex gnus-server-yank-server
9345 Yank the previously killed server (@code{gnus-server-yank-server}).
9346
9347 @item c
9348 @kindex c (Server)
9349 @findex gnus-server-copy-server
9350 Copy the current server (@code{gnus-server-copy-server}).
9351
9352 @item l
9353 @kindex l (Server)
9354 @findex gnus-server-list-servers
9355 List all servers (@code{gnus-server-list-servers}).
9356
9357 @item s
9358 @kindex s (Server)
9359 @findex gnus-server-scan-server
9360 Request that the server scan its sources for new articles
9361 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
9362 servers.
9363
9364 @item g
9365 @kindex g (Server)
9366 @findex gnus-server-regenerate-server
9367 Request that the server regenerate all its data structures
9368 (@code{gnus-server-regenerate-server}).  This can be useful if you have
9369 a mail backend that has gotten out of synch.
9370
9371 @end table
9372
9373
9374 @node Example Methods
9375 @subsection Example Methods
9376
9377 Most select methods are pretty simple and self-explanatory:
9378
9379 @lisp
9380 (nntp "news.funet.fi")
9381 @end lisp
9382
9383 Reading directly from the spool is even simpler:
9384
9385 @lisp
9386 (nnspool "")
9387 @end lisp
9388
9389 As you can see, the first element in a select method is the name of the
9390 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9391 will.
9392
9393 After these two elements, there may be an arbitrary number of
9394 @code{(@var{variable} @var{form})} pairs.
9395
9396 To go back to the first example---imagine that you want to read from
9397 port 15 on that machine.  This is what the select method should
9398 look like then:
9399
9400 @lisp
9401 (nntp "news.funet.fi" (nntp-port-number 15))
9402 @end lisp
9403
9404 You should read the documentation to each backend to find out what
9405 variables are relevant, but here's an @code{nnmh} example:
9406
9407 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
9408 you have two structures that you wish to access: One is your private
9409 mail spool, and the other is a public one.  Here's the possible spec for
9410 your private mail:
9411
9412 @lisp
9413 (nnmh "private" (nnmh-directory "~/private/mail/"))
9414 @end lisp
9415
9416 (This server is then called @samp{private}, but you may have guessed
9417 that.)
9418
9419 Here's the method for a public spool:
9420
9421 @lisp
9422 (nnmh "public"
9423       (nnmh-directory "/usr/information/spool/")
9424       (nnmh-get-new-mail nil))
9425 @end lisp
9426
9427 If you are behind a firewall and only have access to the @sc{nntp}
9428 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9429 on the firewall machine and telnet from there to the @sc{nntp} server.
9430 Doing this can be rather fiddly, but your virtual server definition
9431 should probably look something like this:
9432
9433 @lisp
9434 (nntp "firewall"
9435       (nntp-address "the.firewall.machine")
9436       (nntp-open-connection-function nntp-open-rlogin)
9437       (nntp-end-of-line "\n")
9438       (nntp-rlogin-parameters
9439        ("telnet" "the.real.nntp.host" "nntp")))
9440 @end lisp
9441
9442 If you want to use the wonderful @code{ssh} program to provide a
9443 compressed connection over the modem line, you could create a virtual
9444 server that would look something like this:
9445
9446 @lisp
9447 (nntp "news"
9448        (nntp-address "copper.uio.no")
9449        (nntp-rlogin-program "ssh")
9450        (nntp-open-connection-function nntp-open-rlogin)
9451        (nntp-end-of-line "\n")
9452        (nntp-rlogin-parameters
9453         ("telnet" "news.uio.no" "nntp")))
9454 @end lisp
9455
9456 This means that you have to have set up @code{ssh-agent} correctly to
9457 provide automatic authorization, of course.  And to get a compressed
9458 connection, you have to have the @samp{Compression} option in the
9459 @code{ssh} @file{config} file.
9460
9461
9462 @node Creating a Virtual Server
9463 @subsection Creating a Virtual Server
9464
9465 If you're saving lots of articles in the cache by using persistent
9466 articles, you may want to create a virtual server to read the cache.
9467
9468 First you need to add a new server.  The @kbd{a} command does that.  It
9469 would probably be best to use @code{nnspool} to read the cache.  You
9470 could also use @code{nnml} or @code{nnmh}, though.
9471
9472 Type @kbd{a nnspool RET cache RET}.
9473
9474 You should now have a brand new @code{nnspool} virtual server called
9475 @samp{cache}.  You now need to edit it to have the right definitions.
9476 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
9477 will contain the following:
9478
9479 @lisp
9480 (nnspool "cache")
9481 @end lisp
9482
9483 Change that to:
9484
9485 @lisp
9486 (nnspool "cache"
9487          (nnspool-spool-directory "~/News/cache/")
9488          (nnspool-nov-directory "~/News/cache/")
9489          (nnspool-active-file "~/News/cache/active"))
9490 @end lisp
9491
9492 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
9493 @kbd{RET} over this virtual server, you should be entered into a browse
9494 buffer, and you should be able to enter any of the groups displayed.
9495
9496
9497 @node Server Variables
9498 @subsection Server Variables
9499
9500 One sticky point when defining variables (both on backends and in Emacs
9501 in general) is that some variables are typically initialized from other
9502 variables when the definition of the variables is being loaded.  If you
9503 change the "base" variable after the variables have been loaded, you
9504 won't change the "derived" variables.
9505
9506 This typically affects directory and file variables.  For instance,
9507 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9508 directory variables are initialized from that variable, so
9509 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
9510 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9511 @code{nnml-directory}---you have to explicitly set all the file
9512 variables to be what you want them to be.  For a complete list of
9513 variables for each backend, see each backend's section later in this
9514 manual, but here's an example @code{nnml} definition:
9515
9516 @lisp
9517 (nnml "public"
9518       (nnml-directory "~/my-mail/")
9519       (nnml-active-file "~/my-mail/active")
9520       (nnml-newsgroups-file "~/my-mail/newsgroups"))
9521 @end lisp
9522
9523
9524 @node Servers and Methods
9525 @subsection Servers and Methods
9526
9527 Wherever you would normally use a select method
9528 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9529 when browsing a foreign server) you can use a virtual server name
9530 instead.  This could potentially save lots of typing.  And it's nice all
9531 over.
9532
9533
9534 @node Unavailable Servers
9535 @subsection Unavailable Servers
9536
9537 If a server seems to be unreachable, Gnus will mark that server as
9538 @code{denied}.  That means that any subsequent attempt to make contact
9539 with that server will just be ignored.  ``It can't be opened,'' Gnus
9540 will tell you, without making the least effort to see whether that is
9541 actually the case or not.
9542
9543 That might seem quite naughty, but it does make sense most of the time.
9544 Let's say you have 10 groups subscribed to on server
9545 @samp{nephelococcygia.com}.  This server is located somewhere quite far
9546 away from you and the machine is quite slow, so it takes 1 minute just
9547 to find out that it refuses connection to you today.  If Gnus were to
9548 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9549 attempt to do that.  Once it has gotten a single ``connection refused'',
9550 it will regard that server as ``down''.
9551
9552 So, what happens if the machine was only feeling unwell temporarily?
9553 How do you test to see whether the machine has come up again?
9554
9555 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9556 with the following commands:
9557
9558 @table @kbd
9559
9560 @item O
9561 @kindex O (Server)
9562 @findex gnus-server-open-server
9563 Try to establish connection to the server on the current line
9564 (@code{gnus-server-open-server}).
9565
9566 @item C
9567 @kindex C (Server)
9568 @findex gnus-server-close-server
9569 Close the connection (if any) to the server
9570 (@code{gnus-server-close-server}).
9571
9572 @item D
9573 @kindex D (Server)
9574 @findex gnus-server-deny-server
9575 Mark the current server as unreachable
9576 (@code{gnus-server-deny-server}).
9577
9578 @item M-o
9579 @kindex M-o (Server)
9580 @findex gnus-server-open-all-servers
9581 Open the connections to all servers in the buffer
9582 (@code{gnus-server-open-all-servers}).
9583
9584 @item M-c
9585 @kindex M-c (Server)
9586 @findex gnus-server-close-all-servers
9587 Close the connections to all servers in the buffer
9588 (@code{gnus-server-close-all-servers}).
9589
9590 @item R
9591 @kindex R (Server)
9592 @findex gnus-server-remove-denials
9593 Remove all marks to whether Gnus was denied connection from any servers
9594 (@code{gnus-server-remove-denials}).
9595
9596 @end table
9597
9598
9599 @node Getting News
9600 @section Getting News
9601 @cindex reading news
9602 @cindex news backends
9603
9604 A newsreader is normally used for reading news.  Gnus currently provides
9605 only two methods of getting news---it can read from an @sc{nntp} server,
9606 or it can read from a local spool.
9607
9608 @menu
9609 * NNTP::               Reading news from an @sc{nntp} server.
9610 * News Spool::         Reading news from the local spool.
9611 @end menu
9612
9613
9614 @node NNTP
9615 @subsection @sc{nntp}
9616 @cindex nntp
9617
9618 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9619 You just specify @code{nntp} as method and the address of the @sc{nntp}
9620 server as the, uhm, address.
9621
9622 If the @sc{nntp} server is located at a non-standard port, setting the
9623 third element of the select method to this port number should allow you
9624 to connect to the right port.  You'll have to edit the group info for
9625 that (@pxref{Foreign Groups}).
9626
9627 The name of the foreign group can be the same as a native group.  In
9628 fact, you can subscribe to the same group from as many different servers
9629 you feel like.  There will be no name collisions.
9630
9631 The following variables can be used to create a virtual @code{nntp}
9632 server:
9633
9634 @table @code
9635
9636 @item nntp-server-opened-hook
9637 @vindex nntp-server-opened-hook
9638 @cindex @sc{mode reader}
9639 @cindex authinfo
9640 @cindex authentification
9641 @cindex nntp authentification
9642 @findex nntp-send-authinfo
9643 @findex nntp-send-mode-reader
9644 is run after a connection has been made.  It can be used to send
9645 commands to the @sc{nntp} server after it has been contacted.  By
9646 default it sends the command @code{MODE READER} to the server with the
9647 @code{nntp-send-mode-reader} function.  This function should always be
9648 present in this hook.
9649
9650 @item nntp-authinfo-function
9651 @vindex nntp-authinfo-function
9652 @findex nntp-send-authinfo
9653 @vindex nntp-authinfo-file
9654 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9655 server.  The default function is @code{nntp-send-authinfo}, which looks
9656 through your @file{~/.authinfo} (or whatever you've set the
9657 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
9658 are found, it will prompt you for a login name and a password.  The
9659 format of the @file{~/.authinfo} file is (almost) the same as the
9660 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9661 manual page, but here are the salient facts:
9662
9663 @enumerate
9664 @item
9665 The file contains one or more line, each of which define one server.
9666
9667 @item
9668 Each line may contain an arbitrary number of token/value pairs.  The
9669 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9670 @samp{default} and @samp{force}.  (The latter is not a valid
9671 @file{.netrc}/@code{ftp} token, which is the only way the
9672 @file{.authinfo} file format deviates from the @file{.netrc} file
9673 format.)
9674
9675 @end enumerate
9676
9677 Here's an example file:
9678
9679 @example
9680 machine news.uio.no login larsi password geheimnis
9681 machine nntp.ifi.uio.no login larsi force yes
9682 @end example
9683
9684 The token/value pairs may appear in any order; @samp{machine} doesn't
9685 have to be first, for instance.
9686
9687 In this example, both login name and password have been supplied for the
9688 former server, while the latter has only the login name listed, and the
9689 user will be prompted for the password.  The latter also has the
9690 @samp{force} tag, which means that the authinfo will be sent to the
9691 @var{nntp} server upon connection; the default (i.e., when there is not
9692 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9693 until the @var{nntp} server asks for it.
9694
9695 You can also add @samp{default} lines that will apply to all servers
9696 that don't have matching @samp{machine} lines.
9697
9698 @example
9699 default force yes
9700 @end example
9701
9702 This will force sending @samp{AUTHINFO} commands to all servers not
9703 previously mentioned.
9704
9705 Remember to not leave the @file{~/.authinfo} file world-readable.
9706
9707 @item nntp-server-action-alist
9708 @vindex nntp-server-action-alist
9709 This is a list of regexps to match on server types and actions to be
9710 taken when matches are made.  For instance, if you want Gnus to beep
9711 every time you connect to innd, you could say something like:
9712
9713 @lisp
9714 (setq nntp-server-action-alist
9715       '(("innd" (ding))))
9716 @end lisp
9717
9718 You probably don't want to do that, though.
9719
9720 The default value is
9721
9722 @lisp
9723 '(("nntpd 1\\.5\\.11t"
9724    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9725 @end lisp
9726
9727 This ensures that Gnus doesn't send the @code{MODE READER} command to
9728 nntpd 1.5.11t, since that command chokes that server, I've been told.
9729
9730 @item nntp-maximum-request
9731 @vindex nntp-maximum-request
9732 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9733 will collect headers by sending a series of @code{head} commands.  To
9734 speed things up, the backend sends lots of these commands without
9735 waiting for reply, and then reads all the replies.  This is controlled
9736 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
9737 your network is buggy, you should set this to 1.
9738
9739 @item nntp-connection-timeout
9740 @vindex nntp-connection-timeout
9741 If you have lots of foreign @code{nntp} groups that you connect to
9742 regularly, you're sure to have problems with @sc{nntp} servers not
9743 responding properly, or being too loaded to reply within reasonable
9744 time.  This is can lead to awkward problems, which can be helped
9745 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
9746 that says how many seconds the @code{nntp} backend should wait for a
9747 connection before giving up.  If it is @code{nil}, which is the default,
9748 no timeouts are done.
9749
9750 @c @item nntp-command-timeout
9751 @c @vindex nntp-command-timeout
9752 @c @cindex PPP connections
9753 @c @cindex dynamic IP addresses
9754 @c If you're running Gnus on a machine that has a dynamically assigned
9755 @c address, Gnus may become confused.  If the address of your machine
9756 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9757 @c waiting forever for replies from the server.  To help with this
9758 @c unfortunate problem, you can set this command to a number.  Gnus will
9759 @c then, if it sits waiting for a reply from the server longer than that
9760 @c number of seconds, shut down the connection, start a new one, and resend
9761 @c the command.  This should hopefully be transparent to the user.  A
9762 @c likely number is 30 seconds.
9763 @c
9764 @c @item nntp-retry-on-break
9765 @c @vindex nntp-retry-on-break
9766 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9767 @c hangs.  This will have much the same effect as the command timeout
9768 @c described above.
9769
9770 @item nntp-server-hook
9771 @vindex nntp-server-hook
9772 This hook is run as the last step when connecting to an @sc{nntp}
9773 server.
9774
9775 @findex nntp-open-rlogin
9776 @findex nntp-open-telnet
9777 @findex nntp-open-network-stream
9778 @item nntp-open-connection-function
9779 @vindex nntp-open-connection-function
9780 This function is used to connect to the remote system.  Four pre-made
9781 functions are supplied:
9782
9783 @table @code
9784 @item nntp-open-network-stream
9785 This is the default, and simply connects to some port or other on the
9786 remote system.
9787
9788 @item nntp-open-rlogin
9789 Does an @samp{rlogin} on the
9790 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9791 available there.
9792
9793 @code{nntp-open-rlogin}-related variables:
9794
9795 @table @code
9796
9797 @item nntp-rlogin-program
9798 @vindex nntp-rlogin-program
9799 Program used to log in on remote machines.  The default is @samp{rsh},
9800 but @samp{ssh} is a popular alternative.
9801
9802 @item nntp-rlogin-parameters
9803 @vindex nntp-rlogin-parameters
9804 This list will be used as the parameter list given to @code{rsh}.
9805
9806 @item nntp-rlogin-user-name
9807 @vindex nntp-rlogin-user-name
9808 User name on the remote system.
9809
9810 @end table
9811
9812 @item nntp-open-telnet
9813 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9814 to get to the @sc{nntp} server.
9815
9816 @code{nntp-open-telnet}-related variables:
9817
9818 @table @code
9819 @item nntp-telnet-command
9820 @vindex nntp-telnet-command
9821 Command used to start @code{telnet}.
9822
9823 @item nntp-telnet-switches
9824 @vindex nntp-telnet-switches
9825 List of strings to be used as the switches to the @code{telnet} command.
9826
9827 @item nntp-telnet-user-name
9828 @vindex nntp-telnet-user-name
9829 User name for log in on the remote system.
9830
9831 @item nntp-telnet-passwd
9832 @vindex nntp-telnet-passwd
9833 Password to use when logging in.
9834
9835 @item nntp-telnet-parameters
9836 @vindex nntp-telnet-parameters
9837 A list of strings executed as a command after logging in
9838 via @code{telnet}.
9839
9840 @item nntp-telnet-shell-prompt
9841 @vindex nntp-telnet-shell-prompt
9842 Regexp matching the shell prompt on the remote machine.  The default is
9843 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9844
9845 @item nntp-open-telnet-envuser
9846 @vindex nntp-open-telnet-envuser
9847 If non-@code{nil}, the @code{telnet} session (client and server both)
9848 will support the @code{ENVIRON} option and not prompt for login name.
9849 This works for Solaris @code{telnet}, for instance.
9850
9851 @end table
9852
9853 @findex nntp-open-ssl-stream
9854 @item nntp-open-ssl-stream
9855 Opens a connection to a server over a @dfn{secure} channel.  To use this
9856 you must have SSLay installed
9857 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9858 @file{ssl.el} (from the W3 distributeion, for instance).  You then
9859 define a server as follows:
9860
9861 @lisp
9862 ;; Type `C-c C-c' after you've finished editing.
9863 ;;
9864 ;; "snews" is port 563 and is predefined in our /etc/services
9865 ;;
9866 (nntp "snews.bar.com"
9867       (nntp-open-connection-function nntp-open-ssl-stream)
9868       (nntp-port-number "snews")
9869       (nntp-address "snews.bar.com"))
9870 @end lisp
9871
9872 @end table
9873
9874 @item nntp-end-of-line
9875 @vindex nntp-end-of-line
9876 String to use as end-of-line marker when talking to the @sc{nntp}
9877 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9878 using @code{rlogin} to talk to the server.
9879
9880 @item nntp-rlogin-user-name
9881 @vindex nntp-rlogin-user-name
9882 User name on the remote system when using the @code{rlogin} connect
9883 function.
9884
9885 @item nntp-address
9886 @vindex nntp-address
9887 The address of the remote system running the @sc{nntp} server.
9888
9889 @item nntp-port-number
9890 @vindex nntp-port-number
9891 Port number to connect to when using the @code{nntp-open-network-stream}
9892 connect function.
9893
9894 @item nntp-buggy-select
9895 @vindex nntp-buggy-select
9896 Set this to non-@code{nil} if your select routine is buggy.
9897
9898 @item nntp-nov-is-evil
9899 @vindex nntp-nov-is-evil
9900 If the @sc{nntp} server does not support @sc{nov}, you could set this
9901 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9902 can be used.
9903
9904 @item nntp-xover-commands
9905 @vindex nntp-xover-commands
9906 @cindex nov
9907 @cindex XOVER
9908 List of strings used as commands to fetch @sc{nov} lines from a
9909 server.  The default value of this variable is @code{("XOVER"
9910 "XOVERVIEW")}.
9911
9912 @item nntp-nov-gap
9913 @vindex nntp-nov-gap
9914 @code{nntp} normally sends just one big request for @sc{nov} lines to
9915 the server.  The server responds with one huge list of lines.  However,
9916 if you have read articles 2-5000 in the group, and only want to read
9917 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9918 lines that you will not need.  This variable says how
9919 big a gap between two consecutive articles is allowed to be before the
9920 @code{XOVER} request is split into several request.  Note that if your
9921 network is fast, setting this variable to a really small number means
9922 that fetching will probably be slower.  If this variable is @code{nil},
9923 @code{nntp} will never split requests.  The default is 5.
9924
9925 @item nntp-prepare-server-hook
9926 @vindex nntp-prepare-server-hook
9927 A hook run before attempting to connect to an @sc{nntp} server.
9928
9929 @item nntp-warn-about-losing-connection
9930 @vindex nntp-warn-about-losing-connection
9931 If this variable is non-@code{nil}, some noise will be made when a
9932 server closes connection.
9933
9934 @item nntp-record-commands
9935 @vindex nntp-record-commands
9936 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9937 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9938 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
9939 that doesn't seem to work.
9940
9941 @end table
9942
9943
9944 @node News Spool
9945 @subsection News Spool
9946 @cindex nnspool
9947 @cindex news spool
9948
9949 Subscribing to a foreign group from the local spool is extremely easy,
9950 and might be useful, for instance, to speed up reading groups that
9951 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9952 instance.
9953
9954 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9955 anything else) as the address.
9956
9957 If you have access to a local spool, you should probably use that as the
9958 native select method (@pxref{Finding the News}).  It is normally faster
9959 than using an @code{nntp} select method, but might not be.  It depends.
9960 You just have to try to find out what's best at your site.
9961
9962 @table @code
9963
9964 @item nnspool-inews-program
9965 @vindex nnspool-inews-program
9966 Program used to post an article.
9967
9968 @item nnspool-inews-switches
9969 @vindex nnspool-inews-switches
9970 Parameters given to the inews program when posting an article.
9971
9972 @item nnspool-spool-directory
9973 @vindex nnspool-spool-directory
9974 Where @code{nnspool} looks for the articles.  This is normally
9975 @file{/usr/spool/news/}.
9976
9977 @item nnspool-nov-directory
9978 @vindex nnspool-nov-directory
9979 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9980 @file{/usr/spool/news/over.view/}.
9981
9982 @item nnspool-lib-dir
9983 @vindex nnspool-lib-dir
9984 Where the news lib dir is (@file{/usr/lib/news/} by default).
9985
9986 @item nnspool-active-file
9987 @vindex nnspool-active-file
9988 The path to the active file.
9989
9990 @item nnspool-newsgroups-file
9991 @vindex nnspool-newsgroups-file
9992 The path to the group descriptions file.
9993
9994 @item nnspool-history-file
9995 @vindex nnspool-history-file
9996 The path to the news history file.
9997
9998 @item nnspool-active-times-file
9999 @vindex nnspool-active-times-file
10000 The path to the active date file.
10001
10002 @item nnspool-nov-is-evil
10003 @vindex nnspool-nov-is-evil
10004 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
10005 that it finds.
10006
10007 @item nnspool-sift-nov-with-sed
10008 @vindex nnspool-sift-nov-with-sed
10009 @cindex sed
10010 If non-@code{nil}, which is the default, use @code{sed} to get the
10011 relevant portion from the overview file.  If nil, @code{nnspool} will
10012 load the entire file into a buffer and process it there.
10013
10014 @end table
10015
10016
10017 @node Getting Mail
10018 @section Getting Mail
10019 @cindex reading mail
10020 @cindex mail
10021
10022 Reading mail with a newsreader---isn't that just plain WeIrD? But of
10023 course.
10024
10025 @menu
10026 * Mail in a Newsreader::         Important introductory notes.  
10027 * Getting Started Reading Mail:: A simple cookbook example.
10028 * Splitting Mail::               How to create mail groups.
10029 * Mail Sources::                 How to tell Gnus where to get mail from.
10030 * Mail Backend Variables::       Variables for customizing mail handling.
10031 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
10032 * Group Mail Splitting::         Use group customize to drive mail splitting.
10033 * Incorporating Old Mail::       What about the old mail you have?
10034 * Expiring Mail::                Getting rid of unwanted mail.
10035 * Washing Mail::                 Removing gruft from the mail you get.
10036 * Duplicates::                   Dealing with duplicated mail.
10037 * Not Reading Mail::             Using mail backends for reading other files.
10038 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
10039 @end menu
10040
10041
10042 @node Mail in a Newsreader
10043 @subsection Mail in a Newsreader
10044
10045 If you are used to traditional mail readers, but have decided to switch 
10046 to reading mail with Gnus, you may find yourself experiencing something
10047 of a culture shock.
10048
10049 Gnus does not behave like traditional mail readers.  If you want to make 
10050 it behave that way, you can, but it's an uphill battle.
10051
10052 Gnus, by default, handles all its groups using the same approach.  This
10053 approach is very newsreaderly---you enter a group, see the new/unread
10054 messages, and when you read the messages, they get marked as read, and
10055 you don't see them any more.  (Unless you explicitly ask for them.)
10056
10057 In particular, you do not do anything explicitly to delete messages.
10058
10059 Does this mean that all the messages that have been marked as read are
10060 deleted?  How awful!
10061
10062 But, no, it means that old messages are @dfn{expired} according to some
10063 scheme or other.  For news messages, the expire process is controlled by 
10064 the news administrator; for mail, the expire process is controlled by
10065 you.  The expire process for mail is covered in depth in @pxref{Expiring
10066 Mail}.
10067
10068 What many Gnus users find, after using it a while for both news and
10069 mail, is that the transport mechanism has very little to do with how
10070 they want to treat a message.
10071
10072 Many people subscribe to several mailing lists.  These are transported
10073 via SMTP, and are therefore mail.  But we might go for weeks without
10074 answering, or even reading these messages very carefully. We may not
10075 need to save them because if we should need to read one again, they are
10076 archived somewhere else.
10077
10078 Some people have local news groups which have only a handful of readers.
10079 These are transported via NNTP, and are therefore news.  But we may need
10080 to read and answer a large fraction of the messages very carefully in
10081 order to do our work.  And there may not be an archive, so we may need
10082 to save the interesting messages the same way we would personal mail.
10083
10084 The important distinction turns out to be not the transport mechanism,
10085 but other factors such as how interested we are in the subject matter,
10086 or how easy it is to retrieve the message if we need to read it again.
10087
10088 Gnus provides many options for sorting mail into ``groups'' which behave
10089 like newsgroups, and for treating each group (whether mail or news)
10090 differently.
10091
10092 Some users never get comfortable using the Gnus (ahem) paradigm and wish
10093 that Gnus should grow up and be a male, er, mail reader.  It is possible
10094 to whip Gnus into a more mailreaderly being, but, as said before, it's
10095 not easy.  People who prefer proper mail readers should try @sc{vm}
10096 instead, which is an excellent, and proper, mail reader.
10097
10098 I don't mean to scare anybody off, but I want to make it clear that you
10099 may be required to learn a new way of thinking about messages.  After
10100 you've been subjected to The Gnus Way, you will come to love it.  I can
10101 guarantee it.  (At least the guy who sold me the Emacs Subliminal
10102 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
10103 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
10104 You Do.)
10105
10106
10107 @node Getting Started Reading Mail
10108 @subsection Getting Started Reading Mail
10109
10110 It's quite easy to use Gnus to read your new mail.  You just plonk the
10111 mail backend of your choice into @code{gnus-secondary-select-methods},
10112 and things will happen automatically.
10113
10114 For instance, if you want to use @code{nnml} (which is a "one file per
10115 mail" backend), you could put the following in your @file{.gnus} file:
10116
10117 @lisp
10118 (setq gnus-secondary-select-methods
10119       '((nnml "private")))
10120 @end lisp
10121
10122 Now, the next time you start Gnus, this backend will be queried for new
10123 articles, and it will move all the messages in your spool file to its
10124 directory, which is @code{~/Mail/} by default.  The new group that will
10125 be created (@samp{mail.misc}) will be subscribed, and you can read it
10126 like any other group.
10127
10128 You will probably want to split the mail into several groups, though:
10129
10130 @lisp
10131 (setq nnmail-split-methods
10132       '(("junk" "^From:.*Lars Ingebrigtsen")
10133         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
10134         ("other" "")))
10135 @end lisp
10136
10137 This will result in three new @code{nnml} mail groups being created:
10138 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
10139 mail that doesn't fit into the first two groups will be placed in the
10140 last group.
10141
10142 This should be sufficient for reading mail with Gnus.  You might want to
10143 give the other sections in this part of the manual a perusal, though.
10144 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10145
10146
10147 @node Splitting Mail
10148 @subsection Splitting Mail
10149 @cindex splitting mail
10150 @cindex mail splitting
10151
10152 @vindex nnmail-split-methods
10153 The @code{nnmail-split-methods} variable says how the incoming mail is
10154 to be split into groups.
10155
10156 @lisp
10157 (setq nnmail-split-methods
10158   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10159     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10160     ("mail.other" "")))
10161 @end lisp
10162
10163 This variable is a list of lists, where the first element of each of
10164 these lists is the name of the mail group (they do not have to be called
10165 something beginning with @samp{mail}, by the way), and the second
10166 element is a regular expression used on the header of each mail to
10167 determine if it belongs in this mail group.  The first string may
10168 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10169 insert sub-expressions from the matched text.  For instance:
10170
10171 @lisp
10172 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10173 @end lisp
10174
10175 The second element can also be a function.  In that case, it will be
10176 called narrowed to the headers with the first element of the rule as the
10177 argument.  It should return a non-@code{nil} value if it thinks that the
10178 mail belongs in that group.
10179
10180 The last of these groups should always be a general one, and the regular
10181 expression should @emph{always} be @samp{} so that it matches any mails
10182 that haven't been matched by any of the other regexps.  (These rules are
10183 processed from the beginning of the alist toward the end.  The first
10184 rule to make a match will "win", unless you have crossposting enabled.
10185 In that case, all matching rules will "win".)
10186
10187 If you like to tinker with this yourself, you can set this variable to a
10188 function of your choice.  This function will be called without any
10189 arguments in a buffer narrowed to the headers of an incoming mail
10190 message.  The function should return a list of group names that it
10191 thinks should carry this mail message.
10192
10193 Note that the mail backends are free to maul the poor, innocent,
10194 incoming headers all they want to.  They all add @code{Lines} headers;
10195 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10196 @code{From<SPACE>} line to something else.
10197
10198 @vindex nnmail-crosspost
10199 The mail backends all support cross-posting.  If several regexps match,
10200 the mail will be ``cross-posted'' to all those groups.
10201 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
10202 that no articles are crossposted to the general (@samp{}) group.
10203
10204 @vindex nnmail-crosspost-link-function
10205 @cindex crosspost
10206 @cindex links
10207 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10208 the crossposted articles.  However, not all file systems support hard
10209 links.  If that's the case for you, set
10210 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
10211 variable is @code{add-name-to-file} by default.)
10212
10213 @kindex M-x nnmail-split-history
10214 @kindex nnmail-split-history
10215 If you wish to see where the previous mail split put the messages, you
10216 can use the @kbd{M-x nnmail-split-history} command.
10217
10218 Gnus gives you all the opportunity you could possibly want for shooting
10219 yourself in the foot.  Let's say you create a group that will contain
10220 all the mail you get from your boss.  And then you accidentally
10221 unsubscribe from the group.  Gnus will still put all the mail from your
10222 boss in the unsubscribed group, and so, when your boss mails you ``Have
10223 that report ready by Monday or you're fired!'', you'll never see it and,
10224 come Tuesday, you'll still believe that you're gainfully employed while
10225 you really should be out collecting empty bottles to save up for next
10226 month's rent money.
10227
10228
10229 @node Mail Sources
10230 @subsection Mail Sources
10231
10232 Mail can be gotten from many different sources---the mail spool, from a
10233 POP mail server, or from a procmail directory, for instance.
10234
10235 @menu
10236 * Mail Source Specifiers::       How to specify what a mail source is.
10237 * Mail Source Customization::    Some variables that influence things.
10238 * Fetching Mail::                Using the mail source specifiers.
10239 @end menu
10240
10241
10242 @node Mail Source Specifiers
10243 @subsubsection Mail Source Specifiers
10244 @cindex POP
10245 @cindex mail server
10246 @cindex procmail
10247 @cindex mail spool
10248 @cindex mail source
10249
10250 You tell Gnus how to fetch mail by setting @code{mail-sources}
10251 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
10252
10253 Here's an example:
10254
10255 @lisp
10256 (pop :server "pop3.mailserver.com" :user "myname")
10257 @end lisp
10258
10259 As can be observed, a mail source specifier is a list where the first
10260 element is a @dfn{mail source type}, followed by an arbitrary number of
10261 @dfn{keywords}.  Keywords that are not explicitly specified are given
10262 default values.
10263
10264 The following mail source types are available:
10265
10266 @table @code
10267 @item file
10268 Get mail from a single file; typically from the mail spool.
10269
10270 Keywords:
10271
10272 @table @code
10273 @item :path
10274 The path of the file.  Defaults to the value of the @code{MAIL}
10275 environment variable or @file{/usr/mail/spool/user-name}.
10276 @end table
10277
10278 An example file mail source:
10279
10280 @lisp
10281 (file :path "/usr/spool/mail/user-name")
10282 @end lisp
10283
10284 Or using the default path:
10285
10286 @lisp
10287 (file)
10288 @end lisp
10289
10290 If the mail spool file is not located on the local machine, it's best to 
10291 use POP or IMAP or the like to fetch the mail.  You can not you ange-ftp 
10292 file names here---it has no way to lock the mail spool while moving the
10293 mail.
10294
10295 If it's impossible to set up a proper server, you can use ssh instead.
10296
10297 @lisp
10298 (setq mail-sources
10299       '((file :prescript "ssh host bin/getmail >%t")))
10300 @end lisp
10301
10302 The @samp{getmail} script would look something like the following:
10303
10304 @example
10305 #!/bin/sh
10306 #  getmail - move mail from spool to stdout
10307 #  flu@@iki.fi
10308
10309 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
10310 TMP=~/Mail/tmp
10311 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
10312 @end example
10313
10314 Alter this script to fit find the @samp{movemail} you want to use.
10315
10316
10317 @item directory
10318 Get mail from several files in a directory.  This is typically used when
10319 you have procmail split the incoming mail into several files.
10320
10321 Keywords:
10322
10323 @table @code
10324 @item :path
10325 The path of the directory where the files are.  There is no default
10326 value.
10327
10328 @item :suffix
10329 Only files ending with this suffix are used.  The default is
10330 @samp{.spool}.
10331
10332 @item :predicate
10333 Only files that have this predicate return non-@code{nil} are returned.
10334 The default is @code{identity}.  This is used as an additional
10335 filter---only files that have the right suffix @emph{and} satisfy this
10336 predicate are considered.
10337
10338 @item :prescript
10339 @itemx :postscript
10340 Script run before/after fetching mail.
10341
10342 @end table
10343
10344 An example directory mail source:
10345
10346 @lisp
10347 (directory :path "/home/user-name/procmail-dir/"
10348            :suffix ".prcml")
10349 @end lisp
10350
10351 @item pop
10352 Get mail from a POP server.
10353
10354 Keywords:
10355
10356 @table @code
10357 @item :server
10358 The name of the POP server.  The default is taken from the
10359 @code{MAILHOST} environment variable.
10360
10361 @item :port
10362 The port number of the POP server.  The default is @samp{pop3}.
10363
10364 @item :user
10365 The user name to give to the POP server.  The default is the login
10366 name.
10367
10368 @item :password
10369 The password to give to the POP server.  If not specified, the user is
10370 prompted.
10371
10372 @item :program
10373 The program to use to fetch mail from the POP server.  This is should be
10374 a @code{format}-like string.  Here's an example:
10375
10376 @example
10377 fetchmail %u@@%s -P %p %t
10378 @end example
10379
10380 The valid format specifier characters are:
10381
10382 @table @samp
10383 @item t
10384 The name of the file the mail is to be moved to.  This must always be
10385 included in this string.
10386
10387 @item s
10388 The name of the server.
10389
10390 @item P
10391 The port number of the server.
10392
10393 @item u
10394 The user name to use.
10395
10396 @item p
10397 The password to use.
10398 @end table
10399
10400 The values used for these specs are taken from the values you give the
10401 corresponding keywords.
10402
10403 @item :prescript
10404 A script to be run before fetching the mail.  The syntax is the same as
10405 the @code{:program} keyword.  This can also be a function to be run.
10406
10407 @item :postscript
10408 A script to be run after fetching the mail.  The syntax is the same as
10409 the @code{:program} keyword.  This can also be a function to be run.
10410
10411 @item :function
10412 The function to use to fetch mail from the POP server.  The function is
10413 called with one parameter---the name of the file where the mail should
10414 be moved to.
10415
10416 @item :authentication
10417 This can be either the symbol @code{password} or the symbol @code{apop}
10418 and says what authentication scheme to use.  The default is
10419 @code{password}.
10420
10421 @end table
10422
10423 If the @code{:program} and @code{:function} keywords aren't specified,
10424 @code{pop3-movemail} will be used.
10425
10426 Here are some examples.  Fetch from the default POP server, using the
10427 default user name, and default fetcher:
10428
10429 @lisp
10430 (pop)
10431 @end lisp
10432
10433 Fetch from a named server with a named user and password:
10434
10435 @lisp
10436 (pop :server "my.pop.server"
10437      :user "user-name" :password "secret")
10438 @end lisp
10439
10440 Use @samp{movemail} to move the mail:
10441
10442 @lisp
10443 (pop :program "movemail po:%u %t %p")
10444 @end lisp
10445
10446 @item maildir
10447 Get mail from a maildir. This is a type of mailbox currently only
10448 supported by qmail, where each file in a special directory contains
10449 exactly one mail.
10450
10451 Keywords:
10452
10453 @table @code
10454 @item :path
10455 The path of the directory where the mails are stored.  The default is
10456 @samp{~/Maildir/new}.
10457
10458 If you sometimes look at your mail through a pop3 daemon before fetching
10459 them with Gnus, you may also have to fetch your mails from the
10460 @code{cur} directory inside the maildir, like in the following example.
10461
10462 @end table
10463
10464 An example maildir mail source:
10465
10466 @lisp
10467 (maildir :path "/home/user-name/Maildir/cur")
10468 @end lisp
10469
10470 @item imap
10471 Get mail from a IMAP server. If you don't want to use IMAP as intended,
10472 as a network mail reading protocol, for some reason or other Gnus let
10473 you treat it similar to a POP server and fetches articles from a given
10474 IMAP mailbox.
10475
10476 Keywords:
10477
10478 @table @code
10479 @item :server
10480 The name of the IMAP server.  The default is taken from the
10481 @code{MAILHOST} environment variable.
10482
10483 @item :port
10484 The port number of the IMAP server.  The default is @samp{143}, or
10485 @samp{993} for SSL connections.
10486
10487 @item :user
10488 The user name to give to the IMAP server.  The default is the login
10489 name.
10490
10491 @item :password
10492 The password to give to the IMAP server.  If not specified, the user is
10493 prompted.
10494
10495 @item :stream
10496 What stream to use for connecting to the server, this is one of the
10497 symbols in @code{imap-stream-alist}. Right now, this means
10498 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
10499
10500 @item :authenticator
10501 Which authenticator to use for authenticating to the server, this is one
10502 of the symbols in @code{imap-authenticator-alist}. Right now, this means
10503 @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
10504 @samp{login}.
10505
10506 @item :mailbox
10507 The name of the mailbox to get mail from. The default is @samp{INBOX}
10508 which normally is the mailbox which receive incoming mail.
10509
10510 @item :predicate
10511 The predicate used to find articles to fetch. The default, 
10512 @samp{UNSEEN UNDELETED}, is probably the best choice for most people,
10513 but if you sometimes peek in your mailbox with a IMAP client and mark
10514 some articles as read (or; SEEN) you might want to set this to
10515 @samp{nil}. Then all articles in the mailbox is fetched, no matter
10516 what. For a complete list of predicates, see RFC2060 Â§6.4.4.
10517
10518 @end table
10519
10520 An example IMAP mail source:
10521
10522 @lisp
10523 (imap :server "mail.mycorp.com" :stream kerberos4)
10524 @end lisp
10525
10526 @end table
10527
10528
10529 @node Mail Source Customization
10530 @subsubsection Mail Source Customization
10531
10532 The following is a list of variables that influence how the mail is
10533 fetched.  You would normally not need to set or change any of these
10534 variables.
10535
10536 @table @code
10537 @item mail-source-crash-box
10538 @vindex mail-source-crash-box
10539 File where mail will be stored while processing it.  The default is
10540 @file{~/.emacs-mail-crash-box}.
10541
10542 @item mail-source-delete-incoming
10543 @vindex mail-source-delete-incoming
10544 If non-@code{nil}, delete incoming files after handling them.
10545
10546 @item mail-source-directory
10547 @vindex mail-source-directory
10548 Directory where files (if any) will be stored.  The default is
10549 @file{~/Mail/}.  At present, the only thing this is used for is to say
10550 where the incoming files will be stored if the previous variable is
10551 @code{nil}.
10552
10553 @item mail-source-default-file-modes
10554 @vindex mail-source-default-file-modes
10555 All new mail files will get this file mode.  The default is 384.
10556
10557 @end table
10558
10559
10560 @node Fetching Mail
10561 @subsubsection Fetching Mail
10562
10563 @vindex mail-sources
10564 @vindex nnmail-spool-file
10565 The way to actually tell Gnus where to get new mail from is to set
10566 @code{mail-sources} to a list of mail source specifiers
10567 (@pxref{Mail Source Specifiers}).
10568
10569 If this variable (and the obsolescent @code{nnmail-spool-file}) is
10570 @code{nil}, the mail backends will never attempt to fetch mail by
10571 themselves.
10572
10573 If you want to fetch mail both from your local spool as well as a POP
10574 mail server, you'd say something like:
10575
10576 @lisp
10577 (setq mail-sources
10578       '((file)
10579         (pop :server "pop3.mail.server"
10580              :password "secret")))
10581 @end lisp
10582
10583 Or, if you don't want to use any of the keyword defaults:
10584
10585 @lisp
10586 (setq mail-sources
10587       '((file :path "/var/spool/mail/user-name")
10588         (pop :server "pop3.mail.server"
10589              :user "user-name"
10590              :port "pop3"
10591              :password "secret")))
10592 @end lisp
10593
10594
10595 When you use a mail backend, Gnus will slurp all your mail from your
10596 inbox and plonk it down in your home directory.  Gnus doesn't move any
10597 mail if you're not using a mail backend---you have to do a lot of magic
10598 invocations first.  At the time when you have finished drawing the
10599 pentagram, lightened the candles, and sacrificed the goat, you really
10600 shouldn't be too surprised when Gnus moves your mail.
10601
10602
10603
10604 @node Mail Backend Variables
10605 @subsection Mail Backend Variables
10606
10607 These variables are (for the most part) pertinent to all the various
10608 mail backends.
10609
10610 @table @code
10611 @vindex nnmail-read-incoming-hook
10612 @item nnmail-read-incoming-hook
10613 The mail backends all call this hook after reading new mail.  You can
10614 use this hook to notify any mail watch programs, if you want to.
10615
10616 @vindex nnmail-split-hook
10617 @item nnmail-split-hook
10618 @findex article-decode-encoded-words
10619 @findex RFC1522 decoding
10620 @findex RFC2047 decoding
10621 Hook run in the buffer where the mail headers of each message is kept
10622 just before the splitting based on these headers is done.  The hook is
10623 free to modify the buffer contents in any way it sees fit---the buffer
10624 is discarded after the splitting has been done, and no changes performed
10625 in the buffer will show up in any files.
10626 @code{gnus-article-decode-encoded-words} is one likely function to add
10627 to this hook.
10628
10629 @vindex nnmail-pre-get-new-mail-hook
10630 @vindex nnmail-post-get-new-mail-hook
10631 @item nnmail-pre-get-new-mail-hook
10632 @itemx nnmail-post-get-new-mail-hook
10633 These are two useful hooks executed when treating new incoming
10634 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10635 starting to handle the new mail) and
10636 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10637 is done).  Here's and example of using these two hooks to change the
10638 default file modes the new mail files get:
10639
10640 @lisp
10641 (add-hook 'gnus-pre-get-new-mail-hook
10642           (lambda () (set-default-file-modes 511)))
10643
10644 (add-hook 'gnus-post-get-new-mail-hook
10645           (lambda () (set-default-file-modes 551)))
10646 @end lisp
10647
10648 @item nnmail-use-long-file-names
10649 @vindex nnmail-use-long-file-names
10650 If non-@code{nil}, the mail backends will use long file and directory
10651 names.  Groups like @samp{mail.misc} will end up in directories
10652 (assuming use of @code{nnml} backend) or files (assuming use of
10653 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
10654 the same group will end up in @file{mail/misc}.
10655
10656 @item nnmail-delete-file-function
10657 @vindex nnmail-delete-file-function
10658 @findex delete-file
10659 Function called to delete files.  It is @code{delete-file} by default.
10660
10661 @item nnmail-cache-accepted-message-ids
10662 @vindex nnmail-cache-accepted-message-ids
10663 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10664 the backend (via @code{Gcc}, for instance) into the mail duplication
10665 discovery cache.  The default is @code{nil}.
10666
10667 @end table
10668
10669
10670 @node Fancy Mail Splitting
10671 @subsection Fancy Mail Splitting
10672 @cindex mail splitting
10673 @cindex fancy mail splitting
10674
10675 @vindex nnmail-split-fancy
10676 @findex nnmail-split-fancy
10677 If the rather simple, standard method for specifying how to split mail
10678 doesn't allow you to do what you want, you can set
10679 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
10680 play with the @code{nnmail-split-fancy} variable.
10681
10682 Let's look at an example value of this variable first:
10683
10684 @lisp
10685 ;; Messages from the mailer daemon are not crossposted to any of
10686 ;; the ordinary groups.  Warnings are put in a separate group
10687 ;; from real errors.
10688 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10689                    "mail.misc"))
10690    ;; Non-error messages are crossposted to all relevant
10691    ;; groups, but we don't crosspost between the group for the
10692    ;; (ding) list and the group for other (ding) related mail.
10693    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10694          ("subject" "ding" "ding.misc"))
10695       ;; Other mailing lists...
10696       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10697       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10698       ;; Both lists below have the same suffix, so prevent
10699       ;; cross-posting to mkpkg.list of messages posted only to 
10700       ;; the bugs- list, but allow cross-posting when the
10701       ;; message was really cross-posted.
10702       (any "bugs-mypackage@@somewhere" "mypkg.bugs")
10703       (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
10704       ;; People...
10705       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10706    ;; Unmatched mail goes to the catch all group.
10707    "misc.misc")
10708 @end lisp
10709
10710 This variable has the format of a @dfn{split}.  A split is a (possibly)
10711 recursive structure where each split may contain other splits.  Here are
10712 the five possible split syntaxes:
10713
10714 @enumerate
10715
10716 @item
10717 @samp{group}: If the split is a string, that will be taken as a group
10718 name.  Normal regexp match expansion will be done.  See below for
10719 examples.
10720
10721 @item
10722 @code{(@var{field} @var{value} @var{[- restrict [- restrict [@dots{}]]]} 
10723 @var{split})}: If the split is a list, the first element of which is a
10724 string, then store the message as specified by @var{split}, if header
10725 @var{field} (a regexp) contains @var{value} (also a regexp).  If
10726 @var{restrict} (yet another regexp) matches some string after
10727 @var{field} and before the end of the matched @var{value}, the
10728 @var{split} is ignored.  If none of the @var{restrict} clauses match,
10729 @var{split} is processed.
10730
10731 @item
10732 @code{(| @var{split}@dots{})}: If the split is a list, and the first
10733 element is @code{|} (vertical bar), then process each @var{split} until
10734 one of them matches.  A @var{split} is said to match if it will cause
10735 the mail message to be stored in one or more groups.
10736
10737 @item
10738 @code{(& @var{split}@dots{})}: If the split is a list, and the first
10739 element is @code{&}, then process all @var{split}s in the list.
10740
10741 @item
10742 @code{junk}: If the split is the symbol @code{junk}, then don't save
10743 this message. Use with extreme caution.
10744
10745 @item
10746 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}:  If the split is
10747 a list, and the first element is @code{:}, then the second element will
10748 be called as a function with @var{args} given as arguments.  The
10749 function should return a @var{split}.
10750
10751 @item
10752 @code{(! @var{func} @var{split})}: If the split is a list, and the first
10753 element is @code{!}, then SPLIT will be processed, and FUNC will be
10754 called as a function with the result of SPLIT as argument. FUNC should
10755 return a split.
10756
10757 @item
10758 @code{nil}: If the split is @code{nil}, it is ignored.
10759
10760 @end enumerate
10761
10762 In these splits, @var{field} must match a complete field name.
10763 @var{value} must match a complete word according to the fundamental mode
10764 syntax table.  You can use @code{.*} in the regexps to match partial
10765 field names or words.  In other words, all @var{value}'s are wrapped in
10766 @samp{\<} and @samp{\>} pairs.
10767
10768 @vindex nnmail-split-abbrev-alist
10769 @var{field} and @var{value} can also be lisp symbols, in that case they
10770 are expanded as specified by the variable
10771 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
10772 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10773 value.
10774
10775 @vindex nnmail-split-fancy-syntax-table
10776 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10777 when all this splitting is performed.
10778
10779 If you want to have Gnus create groups dynamically based on some
10780 information in the headers (i.e., do @code{replace-match}-like
10781 substitutions in the group names), you can say things like:
10782
10783 @example
10784 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10785 @end example
10786
10787 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
10788 will be filed in @samp{mail.debian.foo}.
10789
10790 If the string contains the element @samp{\&}, then the previously
10791 matched string will be substituted.  Similarly, the elements @samp{\\1}
10792 up to @samp{\\9} will be substituted with the text matched by the
10793 groupings 1 through 9.
10794
10795
10796 @node Group Mail Splitting
10797 @subsection Group Mail Splitting
10798 @cindex mail splitting
10799 @cindex group mail splitting
10800
10801 @findex gnus-group-split
10802 If you subscribe to dozens of mailing lists but you don't want to
10803 maintain mail splitting rules manually, group mail splitting is for you.
10804 You just have to set @var{to-list} and/or @var{to-address} in group
10805 parameters or group customization and set @code{nnmail-split-methods} to
10806 @code{gnus-group-split}.  This splitting function will scan all groups
10807 for those parameters and split mail accordingly, i.e., messages posted
10808 from or to the addresses specified in the parameters @var{to-list} or
10809 @var{to-address} of a mail group will be stored in that group.
10810
10811 Sometimes, mailing lists have multiple addresses, and you may want mail
10812 splitting to recognize them all: just set the @var{extra-aliases} group
10813 parameter to the list of additional addresses and it's done.  If you'd
10814 rather use a regular expression, set @var{split-regexp}.
10815
10816 All these parameters in a group will be used to create an
10817 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
10818 the @var{value} is a single regular expression that matches
10819 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
10820 matches of @var{split-regexp}, and the @var{split} is the name of the
10821 group.  @var{restrict}s are also supported: just set the
10822 @var{split-exclude} parameter to a list of regular expressions.
10823
10824 If you can't get the right split to be generated using all these
10825 parameters, or you just need something fancier, you can set the
10826 parameter @var{split-spec} to an @code{nnmail-split-fancy} split.  In
10827 this case, all other aforementioned parameters will be ignored by
10828 @code{gnus-group-split}.  In particular, @var{split-spec} may be set to
10829 @code{nil}, in which case the group will be ignored by
10830 @code{gnus-group-split}.
10831
10832 @vindex gnus-group-split-default-catch-all-group
10833 @code{gnus-group-split} will do cross-posting on all groups that match,
10834 by defining a single @code{&} fancy split containing one split for each
10835 group.  If a message doesn't match any split, it will be stored in the
10836 group named in @code{gnus-group-split-default-catch-all-group}, unless
10837 some group has @var{split-spec} set to @code{catch-all}, in which case
10838 that group is used as the catch-all group.  Note that, in this case,
10839 there's no cross-posting, as a @code{|} fancy split encloses the
10840 @code{&} split and the catch-all group.
10841
10842 It's time for an example.  Assume the following group parameters have
10843 been defined:
10844
10845 @example
10846 nnml:mail.bar:
10847 ((to-address . "bar@@femail.com")
10848  (split-regexp . ".*@@femail\\.com"))
10849 nnml:mail.foo:
10850 ((to-list . "foo@@nowhere.gov")
10851  (extra-aliases "foo@@localhost" "foo-redist@@home")
10852  (split-exclude "bugs-foo" "rambling-foo")
10853  (admin-address . "foo-request@@nowhere.gov"))
10854 nnml:mail.others:
10855 ((split-spec . catch-all))
10856 @end example
10857
10858 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
10859 behave as if @code{nnmail-split-fancy} had been selected and variable
10860 @code{nnmail-split-fancy} had been set as follows:
10861
10862 @lisp
10863 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
10864       (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
10865            - "bugs-foo" - "rambling-foo" "mail.foo"))
10866    "mail.others")
10867 @end lisp
10868
10869 @findex gnus-group-split-fancy
10870 If you'd rather not use group splitting for all your mail groups, you
10871 may use it for only some of them, by using @code{nnmail-split-fancy}
10872 splits like this:
10873
10874 @lisp
10875 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
10876 @end lisp
10877
10878 @var{groups} may be a regular expression or a list of group names whose
10879 parameters will be scanned to generate the output split.
10880 @var{no-crosspost} can be used to disable cross-posting; in this case, a
10881 single @code{|} split will be output.  @var{catch-all} may be the name
10882 of a group to be used as the default catch-all group.  If
10883 @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
10884 empty string in any selected group, no catch-all split will be issued.
10885 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
10886 this group will override the value of the @var{catch-all} argument.
10887
10888 @findex gnus-group-split-setup
10889 Unfortunately, scanning all groups and their parameters can be quite
10890 slow, especially considering that it has to be done for every message.
10891 But don't despair!  The function @code{gnus-group-split-setup} can be
10892 used to select @code{gnus-group-split} in a much more efficient way.  It
10893 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
10894 @code{nnmail-split-fancy} to the split produced by
10895 @code{gnus-group-split-fancy}.  Thus, the group parameters are only
10896 scanned once, no matter how many messages are split.
10897
10898 @findex gnus-group-split-update
10899 However, if you change group parameters, you have to update
10900 @code{nnmail-split-fancy} manually.  You can do it by running
10901 @code{gnus-group-split-update}.  If you'd rather have it updated
10902 automatically, just tell @code{gnus-group-split-setup} to do it for
10903 you.  For example, add to your @file{.gnus}:
10904
10905 @lisp
10906 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
10907 @end lisp
10908
10909 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
10910 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
10911 have to worry about updating @code{nnmail-split-fancy} again.  If you
10912 don't omit @var{catch-all} (it's optional),
10913 @code{gnus-group-split-default-catch-all-group} will be set to its
10914 value.
10915
10916 @vindex gnus-group-split-updated-hook
10917 Because you may want to change @code{nnmail-split-fancy} after it is set
10918 by @code{gnus-group-split-update}, this function will run
10919 @code{gnus-group-split-updated-hook} just before finishing.
10920
10921 @node Incorporating Old Mail
10922 @subsection Incorporating Old Mail
10923
10924 Most people have lots of old mail stored in various file formats.  If
10925 you have set up Gnus to read mail using one of the spiffy Gnus mail
10926 backends, you'll probably wish to have that old mail incorporated into
10927 your mail groups.
10928
10929 Doing so can be quite easy.
10930
10931 To take an example: You're reading mail using @code{nnml}
10932 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10933 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
10934 file filled with important, but old, mail.  You want to move it into
10935 your @code{nnml} groups.
10936
10937 Here's how:
10938
10939 @enumerate
10940 @item
10941 Go to the group buffer.
10942
10943 @item
10944 Type `G f' and give the path to the mbox file when prompted to create an
10945 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10946
10947 @item
10948 Type `SPACE' to enter the newly created group.
10949
10950 @item
10951 Type `M P b' to process-mark all articles in this group's buffer
10952 (@pxref{Setting Process Marks}).
10953
10954 @item
10955 Type `B r' to respool all the process-marked articles, and answer
10956 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10957 @end enumerate
10958
10959 All the mail messages in the mbox file will now also be spread out over
10960 all your @code{nnml} groups.  Try entering them and check whether things
10961 have gone without a glitch.  If things look ok, you may consider
10962 deleting the mbox file, but I wouldn't do that unless I was absolutely
10963 sure that all the mail has ended up where it should be.
10964
10965 Respooling is also a handy thing to do if you're switching from one mail
10966 backend to another.  Just respool all the mail in the old mail groups
10967 using the new mail backend.
10968
10969
10970 @node Expiring Mail
10971 @subsection Expiring Mail
10972 @cindex article expiry
10973
10974 Traditional mail readers have a tendency to remove mail articles when
10975 you mark them as read, in some way.  Gnus takes a fundamentally
10976 different approach to mail reading.
10977
10978 Gnus basically considers mail just to be news that has been received in
10979 a rather peculiar manner.  It does not think that it has the power to
10980 actually change the mail, or delete any mail messages.  If you enter a
10981 mail group, and mark articles as ``read'', or kill them in some other
10982 fashion, the mail articles will still exist on the system.  I repeat:
10983 Gnus will not delete your old, read mail.  Unless you ask it to, of
10984 course.
10985
10986 To make Gnus get rid of your unwanted mail, you have to mark the
10987 articles as @dfn{expirable}.  This does not mean that the articles will
10988 disappear right away, however.  In general, a mail article will be
10989 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10990 more than one week old.  If you do not mark an article as expirable, it
10991 will remain on your system until hell freezes over.  This bears
10992 repeating one more time, with some spurious capitalizations: IF you do
10993 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10994
10995 @vindex gnus-auto-expirable-newsgroups
10996 You do not have to mark articles as expirable by hand.  Groups that
10997 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10998 have all articles that you read marked as expirable automatically.  All
10999 articles marked as expirable have an @samp{E} in the first
11000 column in the summary buffer.
11001
11002 By default, if you have auto expiry switched on, Gnus will mark all the
11003 articles you read as expirable, no matter if they were read or unread
11004 before.  To avoid having articles marked as read marked as expirable
11005 automatically, you can put something like the following in your
11006 @file{.gnus} file:
11007
11008 @vindex gnus-mark-article-hook
11009 @lisp
11010 (remove-hook 'gnus-mark-article-hook
11011              'gnus-summary-mark-read-and-unread-as-read)
11012 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
11013 @end lisp
11014
11015 Note that making a group auto-expirable doesn't mean that all read
11016 articles are expired---only the articles marked as expirable
11017 will be expired.  Also note that using the @kbd{d} command won't make
11018 groups expirable---only semi-automatic marking of articles as read will
11019 mark the articles as expirable in auto-expirable groups.
11020
11021 Let's say you subscribe to a couple of mailing lists, and you want the
11022 articles you have read to disappear after a while:
11023
11024 @lisp
11025 (setq gnus-auto-expirable-newsgroups
11026       "mail.nonsense-list\\|mail.nice-list")
11027 @end lisp
11028
11029 Another way to have auto-expiry happen is to have the element
11030 @code{auto-expire} in the group parameters of the group.
11031
11032 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
11033 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
11034 don't really mix very well.
11035
11036 @vindex nnmail-expiry-wait
11037 The @code{nnmail-expiry-wait} variable supplies the default time an
11038 expirable article has to live.  Gnus starts counting days from when the
11039 message @emph{arrived}, not from when it was sent.  The default is seven
11040 days.
11041
11042 Gnus also supplies a function that lets you fine-tune how long articles
11043 are to live, based on what group they are in.  Let's say you want to
11044 have one month expiry period in the @samp{mail.private} group, a one day
11045 expiry period in the @samp{mail.junk} group, and a six day expiry period
11046 everywhere else:
11047
11048 @vindex nnmail-expiry-wait-function
11049 @lisp
11050 (setq nnmail-expiry-wait-function
11051       (lambda (group)
11052        (cond ((string= group "mail.private")
11053                31)
11054              ((string= group "mail.junk")
11055                1)
11056              ((string= group "important")
11057                'never)
11058              (t
11059                6))))
11060 @end lisp
11061
11062 The group names this function is fed are ``unadorned'' group
11063 names---no @samp{nnml:} prefixes and the like.
11064
11065 The @code{nnmail-expiry-wait} variable and
11066 @code{nnmail-expiry-wait-function} function can either be a number (not
11067 necessarily an integer) or one of the symbols @code{immediate} or
11068 @code{never}.
11069
11070 You can also use the @code{expiry-wait} group parameter to selectively
11071 change the expiry period (@pxref{Group Parameters}).
11072
11073 @vindex nnmail-keep-last-article
11074 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
11075 expire the final article in a mail newsgroup.  This is to make life
11076 easier for procmail users.
11077
11078 @vindex gnus-total-expirable-newsgroups
11079 By the way: That line up there, about Gnus never expiring non-expirable
11080 articles, is a lie.  If you put @code{total-expire} in the group
11081 parameters, articles will not be marked as expirable, but all read
11082 articles will be put through the expiry process.  Use with extreme
11083 caution.  Even more dangerous is the
11084 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
11085 this regexp will have all read articles put through the expiry process,
11086 which means that @emph{all} old mail articles in the groups in question
11087 will be deleted after a while.  Use with extreme caution, and don't come
11088 crying to me when you discover that the regexp you used matched the
11089 wrong group and all your important mail has disappeared.  Be a
11090 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
11091 with!  So there!
11092
11093 Most people make most of their mail groups total-expirable, though.
11094
11095 @vindex gnus-inhibit-user-auto-expire
11096 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
11097 commands will not mark an article as expirable, even if the group has
11098 auto-expire turned on.
11099
11100
11101 @node Washing Mail
11102 @subsection Washing Mail
11103 @cindex mail washing
11104 @cindex list server brain damage
11105 @cindex incoming mail treatment
11106
11107 Mailers and list servers are notorious for doing all sorts of really,
11108 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
11109 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
11110 end of all lines passing through our server, so let's do that!!!!1!''
11111 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
11112 considered to be self-evident were not discussed.  So.  Here we are.
11113
11114 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
11115 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
11116 be shocked and dismayed by this, but I haven't got the energy.  It is to
11117 laugh.
11118
11119 Gnus provides a plethora of functions for washing articles while
11120 displaying them, but it might be nicer to do the filtering before
11121 storing the mail to disc.  For that purpose, we have three hooks and
11122 various functions that can be put in these hooks.
11123
11124 @table @code
11125 @item nnmail-prepare-incoming-hook
11126 @vindex nnmail-prepare-incoming-hook
11127 This hook is called before doing anything with the mail and is meant for
11128 grand, sweeping gestures.  It is called in a buffer that contains all
11129 the new, incoming mail.  Functions to be used include:
11130
11131 @table @code
11132 @item nnheader-ms-strip-cr
11133 @findex nnheader-ms-strip-cr
11134 Remove trailing carriage returns from each line.  This is default on
11135 Emacs running on MS machines.
11136
11137 @end table
11138
11139 @item nnmail-prepare-incoming-header-hook
11140 @vindex nnmail-prepare-incoming-header-hook
11141 This hook is called narrowed to each header.  It can be used when
11142 cleaning up the headers.  Functions that can be used include:
11143
11144 @table @code
11145 @item nnmail-remove-leading-whitespace
11146 @findex nnmail-remove-leading-whitespace
11147 Clear leading white space that ``helpful'' listservs have added to the
11148 headers to make them look nice.  Aaah.
11149
11150 @item nnmail-remove-list-identifiers
11151 @findex nnmail-remove-list-identifiers
11152 Some list servers add an identifier---for example, @samp{(idm)}---to the
11153 beginning of all @code{Subject} headers.  I'm sure that's nice for
11154 people who use stone age mail readers.  This function will remove
11155 strings that match the @code{nnmail-list-identifiers} regexp, which can
11156 also be a list of regexp.
11157
11158 For instance, if you want to remove the @samp{(idm)} and the
11159 @samp{nagnagnag} identifiers:
11160
11161 @lisp
11162 (setq nnmail-list-identifiers
11163       '("(idm)" "nagnagnag"))
11164 @end lisp
11165
11166 This can also be done non-destructively with
11167 @code{gnus-list-identifiers}, @xref{Article Hiding}.
11168
11169 @item nnmail-remove-tabs
11170 @findex nnmail-remove-tabs
11171 Translate all @samp{TAB} characters into @samp{SPACE} characters.
11172
11173 @item nnmail-fix-eudora-headers
11174 @findex nnmail-fix-eudora-headers
11175 @cindex Eudora
11176 Eudora produces broken @code{References} headers, but OK
11177 @code{In-Reply-To} headers.  This function will get rid of the
11178 @code{References} headers.
11179
11180 @end table
11181
11182 @item nnmail-prepare-incoming-message-hook
11183 @vindex nnmail-prepare-incoming-message-hook
11184 This hook is called narrowed to each message.  Functions to be used
11185 include:
11186
11187 @table @code
11188 @item article-de-quoted-unreadable
11189 @findex article-de-quoted-unreadable
11190 Decode Quoted Readable encoding.
11191
11192 @end table
11193 @end table
11194
11195
11196 @node Duplicates
11197 @subsection Duplicates
11198
11199 @vindex nnmail-treat-duplicates
11200 @vindex nnmail-message-id-cache-length
11201 @vindex nnmail-message-id-cache-file
11202 @cindex duplicate mails
11203 If you are a member of a couple of mailing lists, you will sometimes
11204 receive two copies of the same mail.  This can be quite annoying, so
11205 @code{nnmail} checks for and treats any duplicates it might find.  To do
11206 this, it keeps a cache of old @code{Message-ID}s---
11207 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
11208 default.  The approximate maximum number of @code{Message-ID}s stored
11209 there is controlled by the @code{nnmail-message-id-cache-length}
11210 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
11211 stored.) If all this sounds scary to you, you can set
11212 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
11213 default), and @code{nnmail} won't delete duplicate mails.  Instead it
11214 will insert a warning into the head of the mail saying that it thinks
11215 that this is a duplicate of a different message.
11216
11217 This variable can also be a function.  If that's the case, the function
11218 will be called from a buffer narrowed to the message in question with
11219 the @code{Message-ID} as a parameter.  The function must return either
11220 @code{nil}, @code{warn}, or @code{delete}.
11221
11222 You can turn this feature off completely by setting the variable to
11223 @code{nil}.
11224
11225 If you want all the duplicate mails to be put into a special
11226 @dfn{duplicates} group, you could do that using the normal mail split
11227 methods:
11228
11229 @lisp
11230 (setq nnmail-split-fancy
11231       '(| ;; Messages duplicates go to a separate group.
11232           ("gnus-warning" "duplication of message" "duplicate")
11233           ;; Message from daemons, postmaster, and the like to another.
11234           (any mail "mail.misc")
11235           ;; Other rules.
11236           [ ... ] ))
11237 @end lisp
11238
11239 Or something like:
11240 @lisp
11241 (setq nnmail-split-methods
11242       '(("duplicates" "^Gnus-Warning:")
11243         ;; Other rules.
11244         [...]))
11245 @end lisp
11246
11247 Here's a neat feature: If you know that the recipient reads her mail
11248 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
11249 @code{delete}, you can send her as many insults as you like, just by
11250 using a @code{Message-ID} of a mail that you know that she's already
11251 received.  Think of all the fun!  She'll never see any of it!  Whee!
11252
11253
11254 @node Not Reading Mail
11255 @subsection Not Reading Mail
11256
11257 If you start using any of the mail backends, they have the annoying
11258 habit of assuming that you want to read mail with them.  This might not
11259 be unreasonable, but it might not be what you want.
11260
11261 If you set @code{mail-sources} and @code{nnmail-spool-file} to
11262 @code{nil}, none of the backends will ever attempt to read incoming
11263 mail, which should help.
11264
11265 @vindex nnbabyl-get-new-mail
11266 @vindex nnmbox-get-new-mail
11267 @vindex nnml-get-new-mail
11268 @vindex nnmh-get-new-mail
11269 @vindex nnfolder-get-new-mail
11270 This might be too much, if, for instance, you are reading mail quite
11271 happily with @code{nnml} and just want to peek at some old @sc{rmail}
11272 file you have stashed away with @code{nnbabyl}.  All backends have
11273 variables called backend-@code{get-new-mail}.  If you want to disable
11274 the @code{nnbabyl} mail reading, you edit the virtual server for the
11275 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
11276
11277 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
11278 narrowed to the article to be saved before saving it when reading
11279 incoming mail.
11280
11281
11282 @node Choosing a Mail Backend
11283 @subsection Choosing a Mail Backend
11284
11285 Gnus will read the mail spool when you activate a mail group.  The mail
11286 file is first copied to your home directory.  What happens after that
11287 depends on what format you want to store your mail in.
11288
11289 There are five different mail backends in the standard Gnus, and more
11290 backends are available separately.  The mail backend most people use
11291 (because it is the fastest and most flexible) is @code{nnml}
11292 (@pxref{Mail Spool}).
11293
11294 @menu
11295 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
11296 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
11297 * Mail Spool::                  Store your mail in a private spool?
11298 * MH Spool::                    An mhspool-like backend.
11299 * Mail Folders::                Having one file for each group.
11300 * Comparing Mail Backends::     An in-depth looks at pros and cons.
11301 @end menu
11302
11303
11304 @node Unix Mail Box
11305 @subsubsection Unix Mail Box
11306 @cindex nnmbox
11307 @cindex unix mail box
11308
11309 @vindex nnmbox-active-file
11310 @vindex nnmbox-mbox-file
11311 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
11312 mail.  @code{nnmbox} will add extra headers to each mail article to say
11313 which group it belongs in.
11314
11315 Virtual server settings:
11316
11317 @table @code
11318 @item nnmbox-mbox-file
11319 @vindex nnmbox-mbox-file
11320 The name of the mail box in the user's home directory.
11321
11322 @item nnmbox-active-file
11323 @vindex nnmbox-active-file
11324 The name of the active file for the mail box.
11325
11326 @item nnmbox-get-new-mail
11327 @vindex nnmbox-get-new-mail
11328 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
11329 into groups.
11330 @end table
11331
11332
11333 @node Rmail Babyl
11334 @subsubsection Rmail Babyl
11335 @cindex nnbabyl
11336 @cindex rmail mbox
11337
11338 @vindex nnbabyl-active-file
11339 @vindex nnbabyl-mbox-file
11340 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
11341 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
11342 article to say which group it belongs in.
11343
11344 Virtual server settings:
11345
11346 @table @code
11347 @item nnbabyl-mbox-file
11348 @vindex nnbabyl-mbox-file
11349 The name of the rmail mbox file.
11350
11351 @item nnbabyl-active-file
11352 @vindex nnbabyl-active-file
11353 The name of the active file for the rmail box.
11354
11355 @item nnbabyl-get-new-mail
11356 @vindex nnbabyl-get-new-mail
11357 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
11358 @end table
11359
11360
11361 @node Mail Spool
11362 @subsubsection Mail Spool
11363 @cindex nnml
11364 @cindex mail @sc{nov} spool
11365
11366 The @dfn{nnml} spool mail format isn't compatible with any other known
11367 format.  It should be used with some caution.
11368
11369 @vindex nnml-directory
11370 If you use this backend, Gnus will split all incoming mail into files,
11371 one file for each mail, and put the articles into the corresponding
11372 directories under the directory specified by the @code{nnml-directory}
11373 variable.  The default value is @file{~/Mail/}.
11374
11375 You do not have to create any directories beforehand; Gnus will take
11376 care of all that.
11377
11378 If you have a strict limit as to how many files you are allowed to store
11379 in your account, you should not use this backend.  As each mail gets its
11380 own file, you might very well occupy thousands of inodes within a few
11381 weeks.  If this is no problem for you, and it isn't a problem for you
11382 having your friendly systems administrator walking around, madly,
11383 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
11384 know that this is probably the fastest format to use.  You do not have
11385 to trudge through a big mbox file just to read your new mail.
11386
11387 @code{nnml} is probably the slowest backend when it comes to article
11388 splitting.  It has to create lots of files, and it also generates
11389 @sc{nov} databases for the incoming mails.  This makes it the fastest
11390 backend when it comes to reading mail.
11391
11392 Virtual server settings:
11393
11394 @table @code
11395 @item nnml-directory
11396 @vindex nnml-directory
11397 All @code{nnml} directories will be placed under this directory.
11398
11399 @item nnml-active-file
11400 @vindex nnml-active-file
11401 The active file for the @code{nnml} server.
11402
11403 @item nnml-newsgroups-file
11404 @vindex nnml-newsgroups-file
11405 The @code{nnml} group descriptions file.  @xref{Newsgroups File
11406 Format}.
11407
11408 @item nnml-get-new-mail
11409 @vindex nnml-get-new-mail
11410 If non-@code{nil}, @code{nnml} will read incoming mail.
11411
11412 @item nnml-nov-is-evil
11413 @vindex nnml-nov-is-evil
11414 If non-@code{nil}, this backend will ignore any @sc{nov} files.
11415
11416 @item nnml-nov-file-name
11417 @vindex nnml-nov-file-name
11418 The name of the @sc{nov} files.  The default is @file{.overview}.
11419
11420 @item nnml-prepare-save-mail-hook
11421 @vindex nnml-prepare-save-mail-hook
11422 Hook run narrowed to an article before saving.
11423
11424 @end table
11425
11426 @findex nnml-generate-nov-databases
11427 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
11428 you can do a complete update by typing @kbd{M-x
11429 nnml-generate-nov-databases}.  This command will trawl through the
11430 entire @code{nnml} hierarchy, looking at each and every article, so it
11431 might take a while to complete.  A better interface to this
11432 functionality can be found in the server buffer (@pxref{Server
11433 Commands}).
11434
11435
11436 @node MH Spool
11437 @subsubsection MH Spool
11438 @cindex nnmh
11439 @cindex mh-e mail spool
11440
11441 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
11442 @sc{nov} databases and it doesn't keep an active file.  This makes
11443 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
11444 makes it easier to write procmail scripts for.
11445
11446 Virtual server settings:
11447
11448 @table @code
11449 @item nnmh-directory
11450 @vindex nnmh-directory
11451 All @code{nnmh} directories will be located under this directory.
11452
11453 @item nnmh-get-new-mail
11454 @vindex nnmh-get-new-mail
11455 If non-@code{nil}, @code{nnmh} will read incoming mail.
11456
11457 @item nnmh-be-safe
11458 @vindex nnmh-be-safe
11459 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
11460 sure that the articles in the folder are actually what Gnus thinks they
11461 are.  It will check date stamps and stat everything in sight, so
11462 setting this to @code{t} will mean a serious slow-down.  If you never
11463 use anything but Gnus to read the @code{nnmh} articles, you do not have
11464 to set this variable to @code{t}.
11465 @end table
11466
11467
11468 @node Mail Folders
11469 @subsubsection Mail Folders
11470 @cindex nnfolder
11471 @cindex mbox folders
11472 @cindex mail folders
11473
11474 @code{nnfolder} is a backend for storing each mail group in a separate
11475 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
11476 will add extra headers to keep track of article numbers and arrival
11477 dates.
11478
11479 Virtual server settings:
11480
11481 @table @code
11482 @item nnfolder-directory
11483 @vindex nnfolder-directory
11484 All the @code{nnfolder} mail boxes will be stored under this directory.
11485
11486 @item nnfolder-active-file
11487 @vindex nnfolder-active-file
11488 The name of the active file.
11489
11490 @item nnfolder-newsgroups-file
11491 @vindex nnfolder-newsgroups-file
11492 The name of the group descriptions file.  @xref{Newsgroups File Format}.
11493
11494 @item nnfolder-get-new-mail
11495 @vindex nnfolder-get-new-mail
11496 If non-@code{nil}, @code{nnfolder} will read incoming mail.
11497
11498 @item nnfolder-save-buffer-hook
11499 @vindex nnfolder-save-buffer-hook
11500 @cindex backup files
11501 Hook run before saving the folders.  Note that Emacs does the normal
11502 backup renaming of files even with the @code{nnfolder} buffers.  If you
11503 wish to switch this off, you could say something like the following in
11504 your @file{.emacs} file:
11505
11506 @lisp
11507 (defun turn-off-backup ()
11508   (set (make-local-variable 'backup-inhibited) t))
11509
11510 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
11511 @end lisp
11512
11513 @item nnfolder-delete-mail-hook
11514 @vindex nnfolder-delete-mail-hook
11515 Hook run in a buffer narrowed to the message that is to be deleted.
11516 This function can be used to copy the message to somewhere else, or to
11517 extract some information from it before removing it.
11518
11519 @end table
11520
11521
11522 @findex nnfolder-generate-active-file
11523 @kindex M-x nnfolder-generate-active-file
11524 If you have lots of @code{nnfolder}-like files you'd like to read with
11525 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11526 command to make @code{nnfolder} aware of all likely files in
11527 @code{nnfolder-directory}.  This only works if you use long file names,
11528 though.
11529
11530 @node Comparing Mail Backends
11531 @subsubsection Comparing Mail Backends
11532
11533 First, just for terminology, the @dfn{backend} is the common word for a
11534 low-level access method---a transport, if you will, by which something
11535 is acquired.  The sense is that one's mail has to come from somewhere,
11536 and so selection of a suitable backend is required in order to get that
11537 mail within spitting distance of Gnus.
11538
11539 The same concept exists for Usenet itself: Though access to articles is
11540 typically done by NNTP these days, once upon a midnight dreary, everyone
11541 in the world got at Usenet by running a reader on the machine where the
11542 articles lay (the machine which today we call an NNTP server), and
11543 access was by the reader stepping into the articles' directory spool
11544 area directly.  One can still select between either the @code{nntp} or
11545 @code{nnspool} backends, to select between these methods, if one happens
11546 actually to live on the server (or can see its spool directly, anyway,
11547 via NFS).
11548
11549 The goal in selecting a mail backend is to pick one which
11550 simultaneously represents a suitable way of dealing with the original
11551 format plus leaving mail in a form that is convenient to use in the
11552 future.  Here are some high and low points on each:
11553
11554 @table @code
11555 @item nnmbox
11556
11557 UNIX systems have historically had a single, very common, and well-
11558 defined format.  All messages arrive in a single @dfn{spool file}, and
11559 they are delineated by a line whose regular expression matches
11560 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
11561 to make it clear in this instance that this is not the RFC-specified
11562 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
11563 historically from the Unix environment, it is simplest if one does not
11564 mess a great deal with the original mailbox format, so if one chooses
11565 this backend, Gnus' primary activity in getting mail from the real spool
11566 area to Gnus' preferred directory is simply to copy it, with no
11567 (appreciable) format change in the process.  It is the ``dumbest'' way
11568 to move mail into availability in the Gnus environment.  This makes it
11569 fast to move into place, but slow to parse, when Gnus has to look at
11570 what's where.
11571
11572 @item nnbabyl
11573
11574 Once upon a time, there was the DEC-10 and DEC-20, running operating
11575 systems called TOPS and related things, and the usual (only?) mail
11576 reading environment was a thing called Babyl.  I don't know what format
11577 was used for mail landing on the system, but Babyl had its own internal
11578 format to which mail was converted, primarily involving creating a
11579 spool-file-like entity with a scheme for inserting Babyl-specific
11580 headers and status bits above the top of each message in the file.
11581 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
11582 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
11583 to understand the mail files folks already had in existence.  Gnus (and
11584 VM, for that matter) continue to support this format because it's
11585 perceived as having some good qualities in those mailer-specific
11586 headers/status bits stuff.  RMAIL itself still exists as well, of
11587 course, and is still maintained by Stallman.
11588
11589 Both of the above forms leave your mail in a single file on your
11590 filesystem, and they must parse that entire file each time you take a
11591 look at your mail.
11592
11593 @item nnml
11594
11595 @code{nnml} is the backend which smells the most as though you were
11596 actually operating with an @code{nnspool}-accessed Usenet system.  (In
11597 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
11598 lo these years ago.)  One's mail is taken from the original spool file,
11599 and is then cut up into individual message files, 1:1.  It maintains a
11600 Usenet-style active file (analogous to what one finds in an INN- or
11601 CNews-based news system in (for instance) @file{/var/lib/news/active},
11602 or what is returned via the @samp{NNTP LIST} verb) and also creates
11603 @dfn{overview} files for efficient group entry, as has been defined for
11604 @sc{nntp} servers for some years now.  It is slower in mail-splitting,
11605 due to the creation of lots of files, updates to the @code{nnml} active
11606 file, and additions to overview files on a per-message basis, but it is
11607 extremely fast on access because of what amounts to the indexing support
11608 provided by the active file and overviews.
11609
11610 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
11611 resource which defines available places in the filesystem to put new
11612 files.  Sysadmins take a dim view of heavy inode occupation within
11613 tight, shared filesystems.  But if you live on a personal machine where
11614 the filesystem is your own and space is not at a premium, @code{nnml}
11615 wins big.
11616
11617 It is also problematic using this backend if you are living in a
11618 FAT16-based Windows world, since much space will be wasted on all these
11619 tiny files.
11620
11621 @item nnmh
11622
11623 The Rand MH mail-reading system has been around UNIX systems for a very
11624 long time; it operates by splitting one's spool file of messages into
11625 individual files, but with little or no indexing support -- @code{nnmh}
11626 is considered to be semantically equivalent to ``@code{nnml} without
11627 active file or overviews''.  This is arguably the worst choice, because
11628 one gets the slowness of individual file creation married to the
11629 slowness of access parsing when learning what's new in one's groups.
11630
11631 @item nnfolder
11632
11633 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
11634 method described above) on a per-group basis.  That is, @code{nnmbox}
11635 itself puts *all* one's mail in one file; @code{nnfolder} provides a
11636 little bit of optimization to this so that each of one's mail groups has
11637 a Unix mail box file.  It's faster than @code{nnmbox} because each group
11638 can be parsed separately, and still provides the simple Unix mail box
11639 format requiring minimal effort in moving the mail around.  In addition, 
11640 it maintains an ``active'' file making it much faster for Gnus to figure 
11641 out how many messages there are in each separate group.
11642
11643 If you have groups that are expected to have a massive amount of
11644 messages, @code{nnfolder} is not the best choice, but if you receive
11645 only a moderate amount of mail, @code{nnfolder} is probably the most
11646 friendly mail backend all over.
11647
11648 @end table
11649
11650
11651 @node Browsing the Web
11652 @section Browsing the Web
11653 @cindex web
11654 @cindex browsing the web
11655 @cindex www
11656 @cindex http
11657
11658 Web-based discussion forums are getting more and more popular.  On many
11659 subjects, the web-based forums have become the most important forums,
11660 eclipsing the importance of mailing lists and news groups.  The reason
11661 is easy to understand---they are friendly to new users; you just point
11662 and click, and there's the discussion.  With mailing lists, you have to
11663 go through a cumbersome subscription procedure, and most people don't
11664 even know what a news group is.
11665
11666 The problem with this scenario is that web browsers are not very good at 
11667 being newsreaders.  They do not keep track of what articles you've read; 
11668 they do not allow you to score on subjects you're interested in; they do 
11669 not allow off-line browsing; they require you to click around and drive
11670 you mad in the end.
11671
11672 So---if web browsers suck at reading discussion forums, why not use Gnus 
11673 to do it instead?
11674
11675 Gnus has been getting quite a collection of backends for providing
11676 interfaces to these sources.
11677
11678 @menu
11679 * Web Searches::          Creating groups from articles that match a string.
11680 * Slashdot::              Reading the Slashdot comments.
11681 * Ultimate::              The Ultimate Bulletin Board systems.
11682 @end menu
11683
11684 The main caveat with all these web sources is that they probably won't
11685 work for a very long time.  Gleaning information from the @sc{html} data 
11686 is guesswork at best, and when the layout is altered, the Gnus backend
11687 will fail.  If you have reasonably new versions of these backends,
11688 though, you should be ok.
11689
11690 One thing all these Web methods have in common is that the Web sources
11691 are often down, unavailable or just plain too slow to be fun.  In those
11692 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
11693 Unplugged}) handle downloading articles, and then you can read them at
11694 leisure from your local disk.  No more World Wide Wait for you.
11695
11696
11697 @node Web Searches
11698 @subsection Web Searches
11699 @cindex nnweb
11700 @cindex DejaNews
11701 @cindex Alta Vista
11702 @cindex InReference
11703 @cindex Usenet searches
11704 @cindex searching the Usenet
11705
11706 It's, like, too neat to search the Usenet for articles that match a
11707 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11708 those, like, Web browsers, and you, like, have to, rilly, like, look at
11709 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11710 searches without having to use a browser.
11711
11712 The @code{nnweb} backend allows an easy interface to the mighty search
11713 engine.  You create an @code{nnweb} group, enter a search pattern, and
11714 then enter the group and read the articles like you would any normal
11715 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
11716 Groups}) will do this in an easy-to-use fashion.
11717
11718 @code{nnweb} groups don't really lend themselves to being solid
11719 groups---they have a very fleeting idea of article numbers.  In fact,
11720 each time you enter an @code{nnweb} group (not even changing the search
11721 pattern), you are likely to get the articles ordered in a different
11722 manner.  Not even using duplicate suppression (@pxref{Duplicate
11723 Suppression}) will help, since @code{nnweb} doesn't even know the
11724 @code{Message-ID} of the articles before reading them using some search
11725 engines (DejaNews, for instance).  The only possible way to keep track
11726 of which articles you've read is by scoring on the @code{Date}
11727 header---mark all articles posted before the last date you read the
11728 group as read.
11729
11730 If the search engine changes its output substantially, @code{nnweb}
11731 won't be able to parse it and will fail.  One could hardly fault the Web
11732 providers if they were to do this---their @emph{raison d'être} is to
11733 make money off of advertisements, not to provide services to the
11734 community.  Since @code{nnweb} washes the ads off all the articles, one
11735 might think that the providers might be somewhat miffed.  We'll see.
11736
11737 You must have the @code{url} and @code{w3} package installed to be able
11738 to use @code{nnweb}.
11739
11740 Virtual server variables:
11741
11742 @table @code
11743 @item nnweb-type
11744 @vindex nnweb-type
11745 What search engine type is being used.  The currently supported types
11746 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11747 @code{reference}.
11748
11749 @item nnweb-search
11750 @vindex nnweb-search
11751 The search string to feed to the search engine.
11752
11753 @item nnweb-max-hits
11754 @vindex nnweb-max-hits
11755 Advisory maximum number of hits per search to display.  The default is
11756 100.
11757
11758 @item nnweb-type-definition
11759 @vindex nnweb-type-definition
11760 Type-to-definition alist.  This alist says what @code{nnweb} should do
11761 with the various search engine types.  The following elements must be
11762 present:
11763
11764 @table @code
11765 @item article
11766 Function to decode the article and provide something that Gnus
11767 understands.
11768
11769 @item map
11770 Function to create an article number to message header and URL alist.
11771
11772 @item search
11773 Function to send the search string to the search engine.
11774
11775 @item address
11776 The address the aforementioned function should send the search string
11777 to.
11778
11779 @item id
11780 Format string URL to fetch an article by @code{Message-ID}.
11781 @end table
11782
11783 @end table
11784
11785
11786 @node Slashdot
11787 @subsection Slashdot
11788 @cindex Slashdot
11789 @cindex nnslashdot
11790
11791 Slashdot (@file{http://slashdot.org/}) is a popular news site, with
11792 lively discussion following the news articles.  @code{nnslashdot} will
11793 let you read this forum in a convenient manner.
11794
11795 The easiest way to read this source is to put something like the
11796 following in your @file{.gnus.el} file:
11797
11798 @lisp
11799 (setq gnus-secondary-select-methods
11800       '((nnslashdot "")))
11801 @end lisp
11802
11803 This will make Gnus query the @code{nnslashdot} backend for new comments
11804 and groups.  The @kbd{F} command will subscribe each new news article as
11805 a new Gnus group, and you can read the comments by entering these
11806 groups.  (Note that the default subscription method is to subscribe new
11807 groups as zombies.  Other methods are available (@pxref{Subscription
11808 Methods}).
11809
11810 The following variables can be altered to change its behavior:
11811
11812 @table @code
11813 @item nnslashdot-threaded
11814 Whether @code{nnslashdot} should display threaded groups or not.  The
11815 default is @code{t}.  To be able to display threads, @code{nnslashdot}
11816 has to retrieve absolutely all comments in a group upon entry.  If a
11817 threaded display is not required, @code{nnslashdot} will only retrieve
11818 the comments that are actually wanted by the user.  Threading is nicer,
11819 but much, much slower than untreaded.
11820
11821 @item nnslashdot-directory
11822 @vindex nnslashdot-directory
11823 Where @code{nnslashdot} will store its files.  The default value is
11824 @samp{~/News/slashdot/}.
11825
11826 @item nnslashdot-active-url
11827 @vindex nnslashdot-active-url
11828 The @sc{url} format string that will be used to fetch the information on 
11829 news articles and comments.  The default is
11830 @samp{http://slashdot.org/search.pl?section=&min=%d}.
11831
11832 @item nnslashdot-comments-url
11833 @vindex nnslashdot-comments-url
11834 The @sc{url} format string that will be used to fetch comments.  The
11835 default is
11836 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
11837
11838 @item nnslashdot-article-url
11839 @vindex nnslashdot-article-url
11840 The @sc{url} format string that will be used to fetch the news article.  The
11841 default is
11842 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
11843
11844 @item nnslashdot-threshold
11845 @vindex nnslashdot-threshold
11846 The score threshold.  The default is -1.
11847
11848 @item nnslashdot-group-number
11849 @vindex nnslashdot-group-number
11850 The number of old groups, in addition to the ten latest, to keep
11851 updated.  The default is 0.
11852
11853 @end table
11854
11855
11856
11857 @node Ultimate
11858 @subsection Ultimate
11859 @cindex nnultimate
11860 @cindex Ultimate Bulletin Board
11861
11862 The Ultimate Bulletin Board (@file{http://www.ultimatebb.com/}) is
11863 probably the most popular Web bulletin board system used.  It has a
11864 quite regular and nice interface, and it's possible to get the
11865 information Gnus needs to keep groups updated.
11866
11867 The easiest way to get started with @code{nnultimate} is to say
11868 something like the following in the group buffer:  @kbd{B nnultimate RET 
11869 http://www.tcj.com/messboard/ubbcgi/ RET}.  (Substitute the @sc{url}
11870 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
11871 you're interested in; there's quite a list of them on the Ultimate web
11872 site.)  Then subscribe to the groups you're interested in from the
11873 server buffer, and read them from the group buffer.
11874
11875 The following @code{nnultimate} variables can be altered:
11876
11877 @table @code
11878 @item nnultimate-directory
11879 @vindex nnultimate-directory
11880 The directory where @code{nnultimate} stores its files.  The default is
11881 @samp{~/News/ultimate/}.
11882 @end table
11883
11884
11885 @node Other Sources
11886 @section Other Sources
11887
11888 Gnus can do more than just read news or mail.  The methods described
11889 below allow Gnus to view directories and files as if they were
11890 newsgroups.
11891
11892 @menu
11893 * Directory Groups::      You can read a directory as if it was a newsgroup.
11894 * Anything Groups::       Dired?  Who needs dired?
11895 * Document Groups::       Single files can be the basis of a group.
11896 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
11897 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
11898 * IMAP::                  Using Gnus as a IMAP client.
11899 @end menu
11900
11901
11902 @node Directory Groups
11903 @subsection Directory Groups
11904 @cindex nndir
11905 @cindex directory groups
11906
11907 If you have a directory that has lots of articles in separate files in
11908 it, you might treat it as a newsgroup.  The files have to have numerical
11909 names, of course.
11910
11911 This might be an opportune moment to mention @code{ange-ftp} (and its
11912 successor @code{efs}), that most wonderful of all wonderful Emacs
11913 packages.  When I wrote @code{nndir}, I didn't think much about it---a
11914 backend to read directories.  Big deal.
11915
11916 @code{ange-ftp} changes that picture dramatically.  For instance, if you
11917 enter the @code{ange-ftp} file name
11918 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11919 @code{ange-ftp} or @code{efs} will actually allow you to read this
11920 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
11921
11922 @code{nndir} will use @sc{nov} files if they are present.
11923
11924 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11925 articles with this method.  You can use @code{nnmh} or @code{nnml} for
11926 whatever you use @code{nndir} for, so you could switch to any of those
11927 methods if you feel the need to have a non-read-only @code{nndir}.
11928
11929
11930 @node Anything Groups
11931 @subsection Anything Groups
11932 @cindex nneething
11933
11934 From the @code{nndir} backend (which reads a single spool-like
11935 directory), it's just a hop and a skip to @code{nneething}, which
11936 pretends that any arbitrary directory is a newsgroup.  Strange, but
11937 true.
11938
11939 When @code{nneething} is presented with a directory, it will scan this
11940 directory and assign article numbers to each file.  When you enter such
11941 a group, @code{nneething} must create ``headers'' that Gnus can use.
11942 After all, Gnus is a newsreader, in case you're
11943 forgetting. @code{nneething} does this in a two-step process.  First, it
11944 snoops each file in question.  If the file looks like an article (i.e.,
11945 the first few lines look like headers), it will use this as the head.
11946 If this is just some arbitrary file without a head (e.g. a C source
11947 file), @code{nneething} will cobble up a header out of thin air.  It
11948 will use file ownership, name and date and do whatever it can with these
11949 elements.
11950
11951 All this should happen automatically for you, and you will be presented
11952 with something that looks very much like a newsgroup.  Totally like a
11953 newsgroup, to be precise.  If you select an article, it will be displayed
11954 in the article buffer, just as usual.
11955
11956 If you select a line that represents a directory, Gnus will pop you into
11957 a new summary buffer for this @code{nneething} group.  And so on.  You can
11958 traverse the entire disk this way, if you feel like, but remember that
11959 Gnus is not dired, really, and does not intend to be, either.
11960
11961 There are two overall modes to this action---ephemeral or solid.  When
11962 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11963 will not store information on what files you have read, and what files
11964 are new, and so on.  If you create a solid @code{nneething} group the
11965 normal way with @kbd{G m}, Gnus will store a mapping table between
11966 article numbers and file names, and you can treat this group like any
11967 other groups.  When you activate a solid @code{nneething} group, you will
11968 be told how many unread articles it contains, etc., etc.
11969
11970 Some variables:
11971
11972 @table @code
11973 @item nneething-map-file-directory
11974 @vindex nneething-map-file-directory
11975 All the mapping files for solid @code{nneething} groups will be stored
11976 in this directory, which defaults to @file{~/.nneething/}.
11977
11978 @item nneething-exclude-files
11979 @vindex nneething-exclude-files
11980 All files that match this regexp will be ignored.  Nice to use to exclude
11981 auto-save files and the like, which is what it does by default.
11982
11983 @item nneething-include-files
11984 @vindex nneething-include-files
11985 Regexp saying what files to include in the group.  If this variable is
11986 non-@code{nil}, only files matching this regexp will be included.
11987
11988 @item nneething-map-file
11989 @vindex nneething-map-file
11990 Name of the map files.
11991 @end table
11992
11993
11994 @node Document Groups
11995 @subsection Document Groups
11996 @cindex nndoc
11997 @cindex documentation group
11998 @cindex help group
11999
12000 @code{nndoc} is a cute little thing that will let you read a single file
12001 as a newsgroup.  Several files types are supported:
12002
12003 @table @code
12004 @cindex babyl
12005 @cindex rmail mbox
12006
12007 @item babyl
12008 The babyl (rmail) mail box.
12009 @cindex mbox
12010 @cindex Unix mbox
12011
12012 @item mbox
12013 The standard Unix mbox file.
12014
12015 @cindex MMDF mail box
12016 @item mmdf
12017 The MMDF mail box format.
12018
12019 @item news
12020 Several news articles appended into a file.
12021
12022 @item rnews
12023 @cindex rnews batch files
12024 The rnews batch transport format.
12025 @cindex forwarded messages
12026
12027 @item forward
12028 Forwarded articles.
12029
12030 @item nsmail
12031 Netscape mail boxes.
12032
12033 @item mime-parts
12034 MIME multipart messages.
12035
12036 @item standard-digest
12037 The standard (RFC 1153) digest format.
12038
12039 @item slack-digest
12040 Non-standard digest format---matches most things, but does it badly.
12041 @end table
12042
12043 You can also use the special ``file type'' @code{guess}, which means
12044 that @code{nndoc} will try to guess what file type it is looking at.
12045 @code{digest} means that @code{nndoc} should guess what digest type the
12046 file is.
12047
12048 @code{nndoc} will not try to change the file or insert any extra headers into
12049 it---it will simply, like, let you use the file as the basis for a
12050 group.  And that's it.
12051
12052 If you have some old archived articles that you want to insert into your
12053 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
12054 that.  Say you have an old @file{RMAIL} file with mail that you now want
12055 to split into your new @code{nnml} groups.  You look at that file using
12056 @code{nndoc} (using the @kbd{G f} command in the group buffer
12057 (@pxref{Foreign Groups})), set the process mark on all the articles in
12058 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
12059 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
12060 file is now also stored in lots of @code{nnml} directories, and you can
12061 delete that pesky @file{RMAIL} file.  If you have the guts!
12062
12063 Virtual server variables:
12064
12065 @table @code
12066 @item nndoc-article-type
12067 @vindex nndoc-article-type
12068 This should be one of @code{mbox}, @code{babyl}, @code{digest},
12069 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
12070 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
12071 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
12072
12073 @item nndoc-post-type
12074 @vindex nndoc-post-type
12075 This variable says whether Gnus is to consider the group a news group or
12076 a mail group.  There are two valid values:  @code{mail} (the default)
12077 and @code{news}.
12078 @end table
12079
12080 @menu
12081 * Document Server Internals::   How to add your own document types.
12082 @end menu
12083
12084
12085 @node Document Server Internals
12086 @subsubsection Document Server Internals
12087
12088 Adding new document types to be recognized by @code{nndoc} isn't
12089 difficult.  You just have to whip up a definition of what the document
12090 looks like, write a predicate function to recognize that document type,
12091 and then hook into @code{nndoc}.
12092
12093 First, here's an example document type definition:
12094
12095 @example
12096 (mmdf
12097  (article-begin .  "^\^A\^A\^A\^A\n")
12098  (body-end .  "^\^A\^A\^A\^A\n"))
12099 @end example
12100
12101 The definition is simply a unique @dfn{name} followed by a series of
12102 regexp pseudo-variable settings.  Below are the possible
12103 variables---don't be daunted by the number of variables; most document
12104 types can be defined with very few settings:
12105
12106 @table @code
12107 @item first-article
12108 If present, @code{nndoc} will skip past all text until it finds
12109 something that match this regexp.  All text before this will be
12110 totally ignored.
12111
12112 @item article-begin
12113 This setting has to be present in all document type definitions.  It
12114 says what the beginning of each article looks like.
12115
12116 @item head-begin-function
12117 If present, this should be a function that moves point to the head of
12118 the article.
12119
12120 @item nndoc-head-begin
12121 If present, this should be a regexp that matches the head of the
12122 article.
12123
12124 @item nndoc-head-end
12125 This should match the end of the head of the article.  It defaults to
12126 @samp{^$}---the empty line.
12127
12128 @item body-begin-function
12129 If present, this function should move point to the beginning of the body
12130 of the article.
12131
12132 @item body-begin
12133 This should match the beginning of the body of the article.  It defaults
12134 to @samp{^\n}.
12135
12136 @item body-end-function
12137 If present, this function should move point to the end of the body of
12138 the article.
12139
12140 @item body-end
12141 If present, this should match the end of the body of the article.
12142
12143 @item file-end
12144 If present, this should match the end of the file.  All text after this
12145 regexp will be totally ignored.
12146
12147 @end table
12148
12149 So, using these variables @code{nndoc} is able to dissect a document
12150 file into a series of articles, each with a head and a body.  However, a
12151 few more variables are needed since not all document types are all that
12152 news-like---variables needed to transform the head or the body into
12153 something that's palatable for Gnus:
12154
12155 @table @code
12156 @item prepare-body-function
12157 If present, this function will be called when requesting an article.  It
12158 will be called with point at the start of the body, and is useful if the
12159 document has encoded some parts of its contents.
12160
12161 @item article-transform-function
12162 If present, this function is called when requesting an article.  It's
12163 meant to be used for more wide-ranging transformation of both head and
12164 body of the article.
12165
12166 @item generate-head-function
12167 If present, this function is called to generate a head that Gnus can
12168 understand.  It is called with the article number as a parameter, and is
12169 expected to generate a nice head for the article in question.  It is
12170 called when requesting the headers of all articles.
12171
12172 @end table
12173
12174 Let's look at the most complicated example I can come up with---standard
12175 digests:
12176
12177 @example
12178 (standard-digest
12179  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
12180  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
12181  (prepare-body-function . nndoc-unquote-dashes)
12182  (body-end-function . nndoc-digest-body-end)
12183  (head-end . "^ ?$")
12184  (body-begin . "^ ?\n")
12185  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
12186  (subtype digest guess))
12187 @end example
12188
12189 We see that all text before a 70-width line of dashes is ignored; all
12190 text after a line that starts with that @samp{^End of} is also ignored;
12191 each article begins with a 30-width line of dashes; the line separating
12192 the head from the body may contain a single space; and that the body is
12193 run through @code{nndoc-unquote-dashes} before being delivered.
12194
12195 To hook your own document definition into @code{nndoc}, use the
12196 @code{nndoc-add-type} function.  It takes two parameters---the first is
12197 the definition itself and the second (optional) parameter says where in
12198 the document type definition alist to put this definition.  The alist is
12199 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
12200 is of @code{mmdf} type, and so on.  These type predicates should return
12201 @code{nil} if the document is not of the correct type; @code{t} if it is
12202 of the correct type; and a number if the document might be of the
12203 correct type.  A high number means high probability; a low number means
12204 low probability with @samp{0} being the lowest valid number.
12205
12206
12207 @node SOUP
12208 @subsection SOUP
12209 @cindex SOUP
12210 @cindex offline
12211
12212 In the PC world people often talk about ``offline'' newsreaders.  These
12213 are thingies that are combined reader/news transport monstrosities.
12214 With built-in modem programs.  Yecchh!
12215
12216 Of course, us Unix Weenie types of human beans use things like
12217 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
12218 transport things like Ghod intended.  And then we just use normal
12219 newsreaders.
12220
12221 However, it can sometimes be convenient to do something that's a bit
12222 easier on the brain if you have a very slow modem, and you're not really
12223 that interested in doing things properly.
12224
12225 A file format called @sc{soup} has been developed for transporting news
12226 and mail from servers to home machines and back again.  It can be a bit
12227 fiddly.
12228
12229 First some terminology:
12230
12231 @table @dfn
12232
12233 @item server
12234 This is the machine that is connected to the outside world and where you
12235 get news and/or mail from.
12236
12237 @item home machine
12238 This is the machine that you want to do the actual reading and responding
12239 on.  It is typically not connected to the rest of the world in any way.
12240
12241 @item packet
12242 Something that contains messages and/or commands.  There are two kinds
12243 of packets:
12244
12245 @table @dfn
12246 @item message packets
12247 These are packets made at the server, and typically contain lots of
12248 messages for you to read.  These are called @file{SoupoutX.tgz} by
12249 default, where @var{x} is a number.
12250
12251 @item response packets
12252 These are packets made at the home machine, and typically contains
12253 replies that you've written.  These are called @file{SoupinX.tgz} by
12254 default, where @var{x} is a number.
12255
12256 @end table
12257
12258 @end table
12259
12260
12261 @enumerate
12262
12263 @item
12264 You log in on the server and create a @sc{soup} packet.  You can either
12265 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
12266 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
12267 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
12268
12269 @item
12270 You transfer the packet home.  Rail, boat, car or modem will do fine.
12271
12272 @item
12273 You put the packet in your home directory.
12274
12275 @item
12276 You fire up Gnus on your home machine using the @code{nnsoup} backend as
12277 the native or secondary server.
12278
12279 @item
12280 You read articles and mail and answer and followup to the things you
12281 want (@pxref{SOUP Replies}).
12282
12283 @item
12284 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
12285 packet.
12286
12287 @item
12288 You transfer this packet to the server.
12289
12290 @item
12291 You use Gnus to mail this packet out with the @kbd{G s s} command.
12292
12293 @item
12294 You then repeat until you die.
12295
12296 @end enumerate
12297
12298 So you basically have a bipartite system---you use @code{nnsoup} for
12299 reading and Gnus for packing/sending these @sc{soup} packets.
12300
12301 @menu
12302 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
12303 * SOUP Groups::       A backend for reading @sc{soup} packets.
12304 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
12305 @end menu
12306
12307
12308 @node SOUP Commands
12309 @subsubsection SOUP Commands
12310
12311 These are commands for creating and manipulating @sc{soup} packets.
12312
12313 @table @kbd
12314 @item G s b
12315 @kindex G s b (Group)
12316 @findex gnus-group-brew-soup
12317 Pack all unread articles in the current group
12318 (@code{gnus-group-brew-soup}).  This command understands the
12319 process/prefix convention.
12320
12321 @item G s w
12322 @kindex G s w (Group)
12323 @findex gnus-soup-save-areas
12324 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
12325
12326 @item G s s
12327 @kindex G s s (Group)
12328 @findex gnus-soup-send-replies
12329 Send all replies from the replies packet
12330 (@code{gnus-soup-send-replies}).
12331
12332 @item G s p
12333 @kindex G s p (Group)
12334 @findex gnus-soup-pack-packet
12335 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
12336
12337 @item G s r
12338 @kindex G s r (Group)
12339 @findex nnsoup-pack-replies
12340 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
12341
12342 @item O s
12343 @kindex O s (Summary)
12344 @findex gnus-soup-add-article
12345 This summary-mode command adds the current article to a @sc{soup} packet
12346 (@code{gnus-soup-add-article}).  It understands the process/prefix
12347 convention (@pxref{Process/Prefix}).
12348
12349 @end table
12350
12351
12352 There are a few variables to customize where Gnus will put all these
12353 thingies:
12354
12355 @table @code
12356
12357 @item gnus-soup-directory
12358 @vindex gnus-soup-directory
12359 Directory where Gnus will save intermediate files while composing
12360 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
12361
12362 @item gnus-soup-replies-directory
12363 @vindex gnus-soup-replies-directory
12364 This is what Gnus will use as a temporary directory while sending our
12365 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
12366
12367 @item gnus-soup-prefix-file
12368 @vindex gnus-soup-prefix-file
12369 Name of the file where Gnus stores the last used prefix.  The default is
12370 @samp{gnus-prefix}.
12371
12372 @item gnus-soup-packer
12373 @vindex gnus-soup-packer
12374 A format string command for packing a @sc{soup} packet.  The default is
12375 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
12376
12377 @item gnus-soup-unpacker
12378 @vindex gnus-soup-unpacker
12379 Format string command for unpacking a @sc{soup} packet.  The default is
12380 @samp{gunzip -c %s | tar xvf -}.
12381
12382 @item gnus-soup-packet-directory
12383 @vindex gnus-soup-packet-directory
12384 Where Gnus will look for reply packets.  The default is @file{~/}.
12385
12386 @item gnus-soup-packet-regexp
12387 @vindex gnus-soup-packet-regexp
12388 Regular expression matching @sc{soup} reply packets in
12389 @code{gnus-soup-packet-directory}.
12390
12391 @end table
12392
12393
12394 @node SOUP Groups
12395 @subsubsection @sc{soup} Groups
12396 @cindex nnsoup
12397
12398 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
12399 read incoming packets, unpack them, and put them in a directory where
12400 you can read them at leisure.
12401
12402 These are the variables you can use to customize its behavior:
12403
12404 @table @code
12405
12406 @item nnsoup-tmp-directory
12407 @vindex nnsoup-tmp-directory
12408 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
12409 directory.  (@file{/tmp/} by default.)
12410
12411 @item nnsoup-directory
12412 @vindex nnsoup-directory
12413 @code{nnsoup} then moves each message and index file to this directory.
12414 The default is @file{~/SOUP/}.
12415
12416 @item nnsoup-replies-directory
12417 @vindex nnsoup-replies-directory
12418 All replies will be stored in this directory before being packed into a
12419 reply packet.  The default is @file{~/SOUP/replies/"}.
12420
12421 @item nnsoup-replies-format-type
12422 @vindex nnsoup-replies-format-type
12423 The @sc{soup} format of the replies packets.  The default is @samp{?n}
12424 (rnews), and I don't think you should touch that variable.  I probably
12425 shouldn't even have documented it.  Drats!  Too late!
12426
12427 @item nnsoup-replies-index-type
12428 @vindex nnsoup-replies-index-type
12429 The index type of the replies packet.  The default is @samp{?n}, which
12430 means ``none''.  Don't fiddle with this one either!
12431
12432 @item nnsoup-active-file
12433 @vindex nnsoup-active-file
12434 Where @code{nnsoup} stores lots of information.  This is not an ``active
12435 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
12436 this file or mess it up in any way, you're dead.  The default is
12437 @file{~/SOUP/active}.
12438
12439 @item nnsoup-packer
12440 @vindex nnsoup-packer
12441 Format string command for packing a reply @sc{soup} packet.  The default
12442 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
12443
12444 @item nnsoup-unpacker
12445 @vindex nnsoup-unpacker
12446 Format string command for unpacking incoming @sc{soup} packets.  The
12447 default is @samp{gunzip -c %s | tar xvf -}.
12448
12449 @item nnsoup-packet-directory
12450 @vindex nnsoup-packet-directory
12451 Where @code{nnsoup} will look for incoming packets.  The default is
12452 @file{~/}.
12453
12454 @item nnsoup-packet-regexp
12455 @vindex nnsoup-packet-regexp
12456 Regular expression matching incoming @sc{soup} packets.  The default is
12457 @samp{Soupout}.
12458
12459 @item nnsoup-always-save
12460 @vindex nnsoup-always-save
12461 If non-@code{nil}, save the replies buffer after each posted message.
12462
12463 @end table
12464
12465
12466 @node SOUP Replies
12467 @subsubsection SOUP Replies
12468
12469 Just using @code{nnsoup} won't mean that your postings and mailings end
12470 up in @sc{soup} reply packets automagically.  You have to work a bit
12471 more for that to happen.
12472
12473 @findex nnsoup-set-variables
12474 The @code{nnsoup-set-variables} command will set the appropriate
12475 variables to ensure that all your followups and replies end up in the
12476 @sc{soup} system.
12477
12478 In specific, this is what it does:
12479
12480 @lisp
12481 (setq message-send-news-function 'nnsoup-request-post)
12482 (setq message-send-mail-function 'nnsoup-request-mail)
12483 @end lisp
12484
12485 And that's it, really.  If you only want news to go into the @sc{soup}
12486 system you just use the first line.  If you only want mail to be
12487 @sc{soup}ed you use the second.
12488
12489
12490 @node Mail-To-News Gateways
12491 @subsection Mail-To-News Gateways
12492 @cindex mail-to-news gateways
12493 @cindex gateways
12494
12495 If your local @code{nntp} server doesn't allow posting, for some reason
12496 or other, you can post using one of the numerous mail-to-news gateways.
12497 The @code{nngateway} backend provides the interface.
12498
12499 Note that you can't read anything from this backend---it can only be
12500 used to post with.
12501
12502 Server variables:
12503
12504 @table @code
12505 @item nngateway-address
12506 @vindex nngateway-address
12507 This is the address of the mail-to-news gateway.
12508
12509 @item nngateway-header-transformation
12510 @vindex nngateway-header-transformation
12511 News headers often have to be transformed in some odd way or other
12512 for the mail-to-news gateway to accept it.  This variable says what
12513 transformation should be called, and defaults to
12514 @code{nngateway-simple-header-transformation}.  The function is called
12515 narrowed to the headers to be transformed and with one parameter---the
12516 gateway address.
12517
12518 This default function just inserts a new @code{To} header based on the
12519 @code{Newsgroups} header and the gateway address.
12520 For instance, an article with this @code{Newsgroups} header:
12521
12522 @example
12523 Newsgroups: alt.religion.emacs
12524 @end example
12525
12526 will get this @code{From} header inserted:
12527
12528 @example
12529 To: alt-religion-emacs@@GATEWAY
12530 @end example
12531
12532 The following pre-defined functions exist:
12533
12534 @findex nngateway-simple-header-transformation
12535 @table @code
12536
12537 @item nngateway-simple-header-transformation
12538 Creates a @code{To} header that looks like
12539 @var{newsgroup}@@@code{nngateway-address}.
12540
12541 @findex nngateway-mail2news-header-transformation
12542
12543 @item nngateway-mail2news-header-transformation
12544 Creates a @code{To} header that looks like
12545 @code{nngateway-address}.
12546
12547 Here's an example:
12548
12549 @lisp
12550 (setq gnus-post-method
12551       '(nngateway "mail2news@@replay.com"
12552                   (nngateway-header-transformation
12553                    nngateway-mail2news-header-transformation)))
12554 @end lisp
12555
12556 @end table
12557
12558
12559 @end table
12560
12561 So, to use this, simply say something like:
12562
12563 @lisp
12564 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
12565 @end lisp
12566
12567
12568
12569 @node IMAP
12570 @subsection IMAP
12571 @cindex nnimap
12572 @cindex IMAP
12573
12574 IMAP is a network protocol for reading mail (or news, or ...), think of
12575 it as a modernized NNTP. Connecting to a IMAP server is much similar to
12576 connecting to a news server, you just specify the network address of the
12577 server.
12578
12579 The following variables can be used to create a virtual @code{nnimap}
12580 server:
12581
12582 @table @code
12583
12584 @item nnimap-address
12585 @vindex nnimap-address
12586
12587 The address of the remote IMAP server. Defaults to the virtual server
12588 name if not specified.
12589
12590 @item nnimap-server-port
12591 @vindex nnimap-server-port
12592 Port on server to contact. Defaults to port 143, or 993 for SSL.
12593
12594 @item nnimap-list-pattern
12595 @vindex nnimap-list-pattern
12596 String or list of strings of mailboxes to limit available groups
12597 to. This is used when the server has very many mailboxes and you're only
12598 interested in a few -- some servers export your home directory via IMAP,
12599 you'll probably want to limit the mailboxes to those in @file{~/Mail/*}
12600 then.
12601
12602 The string can also be a cons of REFERENCE and the string as above, what
12603 REFERENCE is used for is server specific, but on the University of
12604 Washington server it's a directory that will be concatenated with the
12605 mailbox.
12606
12607 Example:
12608
12609 @lisp
12610 ("INBOX" "Mail/*" "alt.sex.*" ("~friend/Mail/" . "list/*"))
12611 @end lisp
12612
12613 @item nnimap-stream
12614 @vindex nnimap-stream
12615 The type of stream used to connect to your server. By default, nnimap
12616 will use the most secure stream your server is capable of.
12617
12618 @itemize @bullet
12619 @item
12620 @dfn{kerberos4:} Uses the `imtest' program.
12621 @item
12622 @dfn{ssl:} Uses OpenSSL or SSLeay.
12623 @item
12624 @dfn{network:} Plain, TCP/IP network connection.
12625 @end itemize
12626
12627 @item nnimap-authenticator
12628 @vindex nnimap-authenticator
12629
12630 The authenticator used to connect to the server. By default, nnimap will
12631 use the most secure authenticator your server is capable of.
12632
12633 @itemize @bullet
12634 @item
12635 @dfn{kerberos4:} Kerberos authentication.
12636 @item
12637 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
12638 @item
12639 @dfn{login:} Plain-text username/password via LOGIN.
12640 @item
12641 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
12642 @end itemize
12643
12644 @item nnimap-expunge-on-close
12645 @cindex Expunging
12646 @vindex nnimap-expunge-on-close
12647 Unlike Parmenides the IMAP designers has decided that things that
12648 doesn't exist actually does exist. More specifically, IMAP has this
12649 concept of marking articles @code{Deleted} which doesn't actually delete
12650 them, and this (marking them @code{Deleted}, that is) is what nnimap
12651 does when you delete a article in Gnus (with @kbd{G DEL} or similair).
12652
12653 Since the articles aren't really removed when we mark them with the
12654 @code{Deleted} flag we'll need a way to actually delete them. Feel like
12655 running in circles yet?
12656
12657 Traditionally, nnimap has removed all articles marked as @code{Deleted}
12658 when closing a mailbox but this is now configurable by this server
12659 variable.
12660
12661 The possible options are:
12662
12663 @table @code
12664
12665 @item always
12666 The default behaviour, delete all articles marked as "Deleted" when
12667 closing a mailbox.
12668 @item never
12669 Never actually delete articles. Currently there is no way of showing the
12670 articles marked for deletion in nnimap, but other IMAP clients may allow
12671 you to do this. If you ever want to run the EXPUNGE command manually,
12672 @xref{Expunging mailboxes}.
12673 @item ask
12674 When closing mailboxes, nnimap will ask if you wish to expunge deleted
12675 articles or not.
12676 @end table
12677
12678 @end table
12679
12680 @menu
12681 * Splitting in IMAP::     Splitting mail with nnimap.
12682 * Editing IMAP ACLs::     Limiting/enabling other users access to a mailbox.
12683 * Expunging mailboxes::   Equivalent of a "compress mailbox" button.
12684 @end menu
12685
12686
12687
12688 @node Splitting in IMAP
12689 @subsubsection Splitting in IMAP
12690 @cindex splitting imap mail
12691
12692 Splitting is something Gnus users has loved and used for years, and now
12693 the rest of the world is catching up. Yeah, dream on, not many IMAP
12694 server has server side splitting and those that have splitting seem to
12695 use some non-standard protocol. This means that IMAP support for Gnus
12696 has to do it's own splitting.
12697
12698 And it does.
12699
12700 There are three variables of interest:
12701
12702 @table @code
12703
12704 @item nnimap-split-crosspost
12705 @cindex splitting, crosspost
12706 @cindex crosspost
12707 @vindex nnimap-split-crosspost
12708
12709 If non-nil, do crossposting if several split methods match the mail. If
12710 nil, the first match in @code{nnimap-split-rule} found will be used.
12711
12712 Nnmail equivalent: @code{nnmail-crosspost}.
12713
12714 @item nnimap-split-inbox
12715 @cindex splitting, inbox
12716 @cindex inbox
12717 @vindex nnimap-split-inbox
12718
12719 A string or a list of strings that gives the name(s) of IMAP mailboxes
12720 to split from. Defaults to nil, which means that splitting is disabled!
12721
12722 @lisp
12723 (setq nnimap-split-inbox '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
12724 @end lisp
12725
12726 No nnmail equivalent.
12727
12728 @item nnimap-split-rule
12729 @cindex Splitting, rules
12730 @vindex nnimap-split-rule
12731
12732 New mail found in @code{nnimap-split-inbox} will be split according to
12733 this variable.
12734
12735 This variable contains a list of lists, where the first element in the
12736 sublist gives the name of the IMAP mailbox to move articles matching the
12737 regexp in the second element in the sublist. Got that? Neither did I, we
12738 need examples.
12739
12740 @lisp
12741 (setq nnimap-split-rule
12742         '(("INBOX.nnimap"        "^Sender: owner-nnimap@@vic20.globalcom.se")
12743           ("INBOX.junk"          "^Subject:.*MAKE MONEY")
12744           ("INBOX.private"       "")))
12745 @end lisp
12746
12747 This will put all articles from the nnimap mailing list into mailbox
12748 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
12749 into INBOX.spam and everything else in INBOX.private.
12750
12751 The first string may contain `\\1' forms, like the ones used by
12752 replace-match to insert sub-expressions from the matched text. For
12753 instance:
12754
12755 @lisp
12756 ("INBOX.lists.\\1"     "^Sender: owner-\\([a-z-]+\\)@@")
12757 @end lisp
12758
12759 The second element can also be a function. In that case, it will be
12760 called with the first element of the rule as the argument, in a buffer
12761 containing the headers of the article. It should return a non-nil value
12762 if it thinks that the mail belongs in that group.
12763
12764 Nnmail users might recollect that the last regexp had to be empty to
12765 match all articles (like in the example above). This is not required in
12766 nnimap. Articles not matching any of the regexps will not be moved out
12767 of your inbox. (This might might affect performance if you keep lots of
12768 unread articles in your inbox, since the splitting code would go over
12769 them every time you fetch new mail.)
12770
12771 These rules are processed from the beginning of the alist toward the
12772 end. The first rule to make a match will "win", unless you have
12773 crossposting enabled. In that case, all matching rules will "win".
12774
12775 The splitting code tries to create mailboxes if it need too.
12776
12777 Nnmail equivalent: @code{nnmail-split-methods}.
12778
12779 @end table
12780
12781 @node Editing IMAP ACLs
12782 @subsubsection Editing IMAP ACLs
12783 @cindex editing imap acls
12784 @cindex Access Control Lists
12785 @cindex Editing IMAP ACLs
12786 @kindex G l
12787 @findex gnus-group-nnimap-edit-acl
12788
12789 ACL stands for Access Control List.  ACLs are used in IMAP for limiting
12790 (or enabling) other users access to your mail boxes. Not all IMAP
12791 servers support this, this function will give an error if it doesn't.
12792
12793 To edit a ACL for a mailbox, type @kbd{G l}
12794 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
12795 editing window with detailed instructions.
12796
12797 Some possible uses:
12798
12799 @itemize @bullet
12800 @item
12801 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
12802 on your mailing list mailboxes enables other users on the same server to
12803 follow the list without subscribing to it.
12804 @item
12805 At least with the Cyrus server, you are required to give the user
12806 "anyone" posting ("p") capabilities to have "plussing" work (that is,
12807 mail sent to user+mailbox@@domain ending up in the IMAP mailbox
12808 INBOX.mailbox).
12809 @end itemize
12810
12811 @node Expunging mailboxes
12812 @subsubsection Expunging mailboxes
12813 @cindex expunging
12814
12815 @cindex Expunge
12816 @cindex Manual expunging
12817 @kindex G x
12818 @findex gnus-group-nnimap-expunge
12819
12820 If you're using the @code{never} setting of @code{nnimap-expunge-close},
12821 you may want the option of expunging all deleted articles in a mailbox
12822 manually. This is exactly what @kbd{G x} does.
12823
12824 Currently there is no way of showing deleted articles, you can just
12825 delete them.
12826
12827
12828
12829 @node Combined Groups
12830 @section Combined Groups
12831
12832 Gnus allows combining a mixture of all the other group types into bigger
12833 groups.
12834
12835 @menu
12836 * Virtual Groups::     Combining articles from many groups.
12837 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
12838 @end menu
12839
12840
12841 @node Virtual Groups
12842 @subsection Virtual Groups
12843 @cindex nnvirtual
12844 @cindex virtual groups
12845 @cindex merging groups
12846
12847 An @dfn{nnvirtual group} is really nothing more than a collection of
12848 other groups.
12849
12850 For instance, if you are tired of reading many small groups, you can
12851 put them all in one big group, and then grow tired of reading one
12852 big, unwieldy group.  The joys of computing!
12853
12854 You specify @code{nnvirtual} as the method.  The address should be a
12855 regexp to match component groups.
12856
12857 All marks in the virtual group will stick to the articles in the
12858 component groups.  So if you tick an article in a virtual group, the
12859 article will also be ticked in the component group from whence it came.
12860 (And vice versa---marks from the component groups will also be shown in
12861 the virtual group.)
12862
12863 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
12864 newsgroups into one, big, happy newsgroup:
12865
12866 @lisp
12867 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
12868 @end lisp
12869
12870 The component groups can be native or foreign; everything should work
12871 smoothly, but if your computer explodes, it was probably my fault.
12872
12873 Collecting the same group from several servers might actually be a good
12874 idea if users have set the Distribution header to limit distribution.
12875 If you would like to read @samp{soc.motss} both from a server in Japan
12876 and a server in Norway, you could use the following as the group regexp:
12877
12878 @example
12879 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
12880 @end example
12881
12882 (Remember, though, that if you're creating the group with @kbd{G m}, you
12883 shouldn't double the backslashes, and you should leave off the quote
12884 characters at the beginning and the end of the string.)
12885
12886 This should work kinda smoothly---all articles from both groups should
12887 end up in this one, and there should be no duplicates.  Threading (and
12888 the rest) will still work as usual, but there might be problems with the
12889 sequence of articles.  Sorting on date might be an option here
12890 (@pxref{Selecting a Group}).
12891
12892 One limitation, however---all groups included in a virtual
12893 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
12894 zombie groups can't be component groups for @code{nnvirtual} groups.
12895
12896 @vindex nnvirtual-always-rescan
12897 If the @code{nnvirtual-always-rescan} is non-@code{nil},
12898 @code{nnvirtual} will always scan groups for unread articles when
12899 entering a virtual group.  If this variable is @code{nil} (which is the
12900 default) and you read articles in a component group after the virtual
12901 group has been activated, the read articles from the component group
12902 will show up when you enter the virtual group.  You'll also see this
12903 effect if you have two virtual groups that have a component group in
12904 common.  If that's the case, you should set this variable to @code{t}.
12905 Or you can just tap @code{M-g} on the virtual group every time before
12906 you enter it---it'll have much the same effect.
12907
12908 @code{nnvirtual} can have both mail and news groups as component groups.
12909 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
12910 has to ask the backend of the component group the article comes from
12911 whether it is a news or mail backend.  However, when you do a @kbd{^},
12912 there is typically no sure way for the component backend to know this,
12913 and in that case @code{nnvirtual} tells Gnus that the article came from a
12914 not-news backend.  (Just to be on the safe side.)
12915
12916 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
12917 line from the article you respond to in these cases.
12918
12919
12920
12921 @node Kibozed Groups
12922 @subsection Kibozed Groups
12923 @cindex nnkiboze
12924 @cindex kibozing
12925
12926 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
12927 the news feed''.  @code{nnkiboze} is a backend that will do this for
12928 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
12929 with useless requests!  Oh happiness!
12930
12931 @kindex G k (Group)
12932 To create a kibozed group, use the @kbd{G k} command in the group
12933 buffer.
12934
12935 The address field of the @code{nnkiboze} method is, as with
12936 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
12937 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
12938 and @code{nnvirtual} end.
12939
12940 In addition to this regexp detailing component groups, an @code{nnkiboze} group
12941 must have a score file to say what articles are to be included in
12942 the group (@pxref{Scoring}).
12943
12944 @kindex M-x nnkiboze-generate-groups
12945 @findex nnkiboze-generate-groups
12946 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
12947 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
12948 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
12949 all the articles in all the component groups and run them through the
12950 scoring process to determine if there are any articles in the groups
12951 that are to be part of the @code{nnkiboze} groups.
12952
12953 Please limit the number of component groups by using restrictive
12954 regexps.  Otherwise your sysadmin may become annoyed with you, and the
12955 @sc{nntp} site may throw you off and never let you back in again.
12956 Stranger things have happened.
12957
12958 @code{nnkiboze} component groups do not have to be alive---they can be dead,
12959 and they can be foreign.  No restrictions.
12960
12961 @vindex nnkiboze-directory
12962 The generation of an @code{nnkiboze} group means writing two files in
12963 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
12964 contains the @sc{nov} header lines for all the articles in the group,
12965 and the other is an additional @file{.newsrc} file to store information
12966 on what groups have been searched through to find component articles.
12967
12968 Articles marked as read in the @code{nnkiboze} group will have
12969 their @sc{nov} lines removed from the @sc{nov} file.
12970
12971
12972 @node Gnus Unplugged
12973 @section Gnus Unplugged
12974 @cindex offline
12975 @cindex unplugged
12976 @cindex Agent
12977 @cindex Gnus Agent
12978 @cindex Gnus Unplugged
12979
12980 In olden times (ca. February '88), people used to run their newsreaders
12981 on big machines with permanent connections to the net.  News transport
12982 was dealt with by news servers, and all the newsreaders had to do was to
12983 read news.  Believe it or not.
12984
12985 Nowadays most people read news and mail at home, and use some sort of
12986 modem to connect to the net.  To avoid running up huge phone bills, it
12987 would be nice to have a way to slurp down all the news and mail, hang up
12988 the phone, read for several hours, and then upload any responses you
12989 have to make.  And then you repeat the procedure.
12990
12991 Of course, you can use news servers for doing this as well.  I've used
12992 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
12993 for some years, but doing that's a bore.  Moving the news server
12994 functionality up to the newsreader makes sense if you're the only person
12995 reading news on a machine.
12996
12997 Using Gnus as an ``offline'' newsreader is quite simple.
12998
12999 @itemize @bullet
13000 @item
13001 First, set up Gnus as you would do if you were running it on a machine
13002 that has full connection to the net.  Go ahead.  I'll still be waiting
13003 here.
13004
13005 @item
13006 Then, put the following magical incantation at the end of your
13007 @file{.gnus.el} file:
13008
13009 @lisp
13010 (gnus-agentize)
13011 @end lisp
13012 @end itemize
13013
13014 That's it.  Gnus is now an ``offline'' newsreader.
13015
13016 Of course, to use it as such, you have to learn a few new commands.
13017
13018 @menu
13019 * Agent Basics::           How it all is supposed to work.
13020 * Agent Categories::       How to tell the Gnus Agent what to download.
13021 * Agent Commands::         New commands for all the buffers.
13022 * Agent Expiry::           How to make old articles go away.
13023 * Outgoing Messages::      What happens when you post/mail something?
13024 * Agent Variables::        Customizing is fun.
13025 * Example Setup::          An example @file{.gnus.el} file for offline people.
13026 * Batching Agents::        How to fetch news from a @code{cron} job.
13027 * Agent Caveats::          What you think it'll do and what it does.
13028 @end menu
13029
13030
13031 @node Agent Basics
13032 @subsection Agent Basics
13033
13034 First, let's get some terminology out of the way.
13035
13036 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
13037 connection to the net (and notified the Agent that this is the case).
13038 When the connection to the net is up again (and Gnus knows this), the
13039 Agent is @dfn{plugged}.
13040
13041 The @dfn{local} machine is the one you're running on, and which isn't
13042 connected to the net continuously.
13043
13044 @dfn{Downloading} means fetching things from the net to your local
13045 machine.  @dfn{Uploading} is doing the opposite.
13046
13047 Let's take a typical Gnus session using the Agent.
13048
13049 @itemize @bullet
13050
13051 @item
13052 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
13053 Agent in a disconnected state.  You can read all the news that you have
13054 already fetched while in this mode.
13055
13056 @item
13057 You then decide to see whether any new news has arrived.  You connect
13058 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
13059 to make Gnus become @dfn{plugged}.
13060
13061 @item
13062 You can then read the new news immediately, or you can download the news
13063 onto your local machine.  If you want to do the latter, you press @kbd{J
13064 s} to fetch all the eligible articles in all the groups.  (To let Gnus
13065 know which articles you want to download, @pxref{Agent Categories}.)
13066
13067 @item
13068 After fetching the articles, you press @kbd{J j} to make Gnus become
13069 unplugged again, and you shut down the PPP thing (or whatever).  And
13070 then you read the news offline.
13071
13072 @item
13073 And then you go to step 2.
13074 @end itemize
13075
13076 Here are some things you should do the first time (or so) that you use
13077 the Agent.
13078
13079 @itemize @bullet
13080
13081 @item
13082 Decide which servers should be covered by the Agent.  If you have a mail
13083 backend, it would probably be nonsensical to have it covered by the
13084 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
13085 @kbd{J a} the server (or servers) that you wish to have covered by the
13086 Agent (@pxref{Server Agent Commands}).  This will typically be only the
13087 primary select method, which is listed on the bottom in the buffer.
13088
13089 @item
13090 Decide on download policy.  @xref{Agent Categories}.
13091
13092 @item
13093 Uhm... that's it.
13094 @end itemize
13095
13096
13097 @node Agent Categories
13098 @subsection Agent Categories
13099
13100 One of the main reasons to integrate the news transport layer into the
13101 newsreader is to allow greater control over what articles to download.
13102 There's not much point in downloading huge amounts of articles, just to
13103 find out that you're not interested in reading any of them.  It's better
13104 to be somewhat more conservative in choosing what to download, and then
13105 mark the articles for downloading manually if it should turn out that
13106 you're interested in the articles anyway.
13107
13108 The main way to control what is to be downloaded is to create a
13109 @dfn{category} and then assign some (or all) groups to this category.
13110 Groups that do not belong in any other category belong to the
13111 @code{default} category. Gnus has its own buffer for creating and
13112 managing categories.
13113
13114 @menu
13115 * Category Syntax::       What a category looks like.
13116 * The Category Buffer::   A buffer for maintaining categories.
13117 * Category Variables::    Customize'r'Us.
13118 @end menu
13119
13120
13121 @node Category Syntax
13122 @subsubsection Category Syntax
13123
13124 A category consists of two things.
13125
13126 @enumerate
13127 @item
13128 A predicate which (generally) gives a rough outline of which articles
13129 are eligible for downloading; and
13130
13131 @item
13132 a score rule which (generally) gives you a finer granularity when
13133 deciding what articles to download.  (Note that this @dfn{download
13134 score} is not necessarily related to normal scores.)
13135 @end enumerate
13136
13137 A predicate in its simplest form can be a single predicate such as
13138 @code{true} or @code{false}. These two will download every available
13139 article or nothing respectively. In the case of these two special
13140 predicates an additional score rule is superfluous.
13141
13142 Predicates of @code{high} or @code{low} download articles in respect of
13143 their scores in relationship to @code{gnus-agent-high-score} and
13144 @code{gnus-agent-low-score} as descibed below.
13145
13146 To gain even finer control of what is to be regarded eligible for
13147 download a predicate can consist of a number of predicates with logical
13148 operators sprinkled in between.
13149
13150 Perhaps some examples are in order.
13151
13152 Here's a simple predicate.  (It's the default predicate, in fact, used
13153 for all groups that don't belong to any other category.)
13154
13155 @lisp
13156 short
13157 @end lisp
13158
13159 Quite simple, eh?  This predicate is true if and only if the article is
13160 short (for some value of ``short'').
13161
13162 Here's a more complex predicate:
13163
13164 @lisp
13165 (or high
13166     (and
13167      (not low)
13168      (not long)))
13169 @end lisp
13170
13171 This means that an article should be downloaded if it has a high score,
13172 or if the score is not low and the article is not long.  You get the
13173 drift.
13174
13175 The available logical operators are @code{or}, @code{and} and
13176 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
13177 @samp{|}, @code{&} and @code{!} instead.)
13178
13179 The following predicates are pre-defined, but if none of these fit what
13180 you want to do, you can write your own.
13181
13182 @table @code
13183 @item short
13184 True iff the article is shorter than @code{gnus-agent-short-article}
13185 lines; default 100.
13186
13187 @item long
13188 True iff the article is longer than @code{gnus-agent-long-article}
13189 lines; default 200.
13190
13191 @item low
13192 True iff the article has a download score less than
13193 @code{gnus-agent-low-score}; default 0.
13194
13195 @item high
13196 True iff the article has a download score greater than
13197 @code{gnus-agent-high-score}; default 0.
13198
13199 @item spam
13200 True iff the Gnus Agent guesses that the article is spam.  The
13201 heuristics may change over time, but at present it just computes a
13202 checksum and sees whether articles match.
13203
13204 @item true
13205 Always true.
13206
13207 @item false
13208 Always false.
13209 @end table
13210
13211 If you want to create your own predicate function, here's what you have
13212 to know:  The functions are called with no parameters, but the
13213 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
13214 useful values.
13215
13216 For example, you could decide that you don't want to download articles
13217 that were posted more than a certain number of days ago (e.g. posted
13218 more than @code{gnus-agent-expire-days} ago) you might write a function
13219 something along the lines of the following:
13220
13221 @lisp
13222 (defun my-article-old-p ()
13223   "Say whether an article is old."
13224   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
13225      (- (time-to-days (current-time)) gnus-agent-expire-days)))
13226 @end lisp
13227
13228 with the predicate then defined as:
13229
13230 @lisp
13231 (not my-article-old-p)
13232 @end lisp
13233
13234 or you could append your predicate to the predefined
13235 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
13236 wherever.  (Note: this would have to be at a point *after*
13237 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
13238
13239 @lisp
13240 (defvar  gnus-category-predicate-alist
13241   (append gnus-category-predicate-alist
13242          '((old . my-article-old-p))))
13243 @end lisp
13244
13245 and simply specify your predicate as:
13246
13247 @lisp
13248 (not old)
13249 @end lisp
13250
13251 If/when using something like the above, be aware that there are many
13252 misconfigured systems/mailers out there and so an article's date is not
13253 always a reliable indication of when it was posted. Hell, some people
13254 just don't give a damm.
13255
13256
13257 The above predicates apply to *all* the groups which belong to the
13258 category. However, if you wish to have a specific predicate for an
13259 individual group within a category, or you're just too lazy to set up a
13260 new category, you can enter a group's individual predicate in it's group
13261 parameters like so:
13262
13263 @lisp
13264 (agent-predicate . short)
13265 @end lisp
13266
13267 This is the group parameter equivalent of the agent category
13268 default. Note that when specifying a single word predicate like this,
13269 the @code{agent-predicate} specification must be in dotted pair
13270 notation.
13271
13272 The equivalent of the longer example from above would be:
13273
13274 @lisp
13275 (agent-predicate or high (and (not low) (not long)))
13276 @end lisp
13277
13278 The outer parenthesis required in the category specification are not
13279 entered here as, not being in dotted pair notation, the value of the
13280 predicate is assumed to be a list.
13281
13282
13283 Now, the syntax of the download score is the same as the syntax of
13284 normal score files, except that all elements that require actually
13285 seeing the article itself are verboten.  This means that only the
13286 following headers can be scored on: @code{Subject}, @code{From},
13287 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
13288 @code{Lines}, and @code{Xref}.
13289
13290 As with predicates, the specification of the @code{download score rule}
13291 to use in respect of a group can be in either the category definition if
13292 it's to be applicable to all groups in therein, or a group's parameters
13293 if it's to be specific to that group.
13294
13295 In both of these places the @code{download score rule} can take one of
13296 three forms:
13297
13298 @enumerate
13299 @item
13300 Score rule
13301
13302 This has the same syntax as a normal gnus score file except only a
13303 subset of scoring keywords are available as mentioned above.
13304
13305 example:
13306
13307 @itemize @bullet
13308 @item
13309 Category specification
13310
13311 @lisp
13312 (("from"
13313        ("Lars Ingebrigtsen" 1000000 nil s))
13314 ("lines"
13315        (500 -100 nil <)))
13316 @end lisp
13317
13318 @item
13319 Group Parameter specification
13320
13321 @lisp
13322 (agent-score ("from"
13323                    ("Lars Ingebrigtsen" 1000000 nil s))
13324              ("lines"
13325                    (500 -100 nil <)))
13326 @end lisp
13327
13328 Again, note the omission of the outermost parenthesis here.
13329 @end itemize
13330
13331 @item
13332 Agent score file
13333
13334 These score files must *only* contain the permitted scoring keywords
13335 stated above.
13336
13337 example:
13338
13339 @itemize @bullet
13340 @item
13341 Category specification
13342
13343 @lisp
13344 ("~/News/agent.SCORE")
13345 @end lisp
13346
13347 or perhaps
13348
13349 @lisp
13350 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
13351 @end lisp
13352
13353 @item
13354 Group Parameter specification
13355
13356 @lisp
13357 (agent-score "~/News/agent.SCORE")
13358 @end lisp
13359
13360 Additional score files can be specified as above. Need I say anything
13361 about parenthesis.
13362 @end itemize
13363
13364 @item
13365 Use @code{normal} score files
13366
13367 If you dont want to maintain two sets of scoring rules for a group, and
13368 your desired @code{downloading} criteria for a group are the same as your
13369 @code{reading} criteria then you can tell the agent to refer to your
13370 @code{normal} score files when deciding what to download.
13371
13372 These directives in either the category definition or a group's
13373 parameters will cause the agent to read in all the applicable score
13374 files for a group, *filtering out* those those sections that do not
13375 relate to one of the permitted subset of scoring keywords.
13376
13377 @itemize @bullet
13378 @item
13379 Category Specification
13380
13381 @lisp
13382 file
13383 @end lisp
13384
13385 @item
13386 Group Parameter specification
13387
13388 @lisp
13389 (agent-score . file)
13390 @end lisp
13391 @end itemize
13392 @end enumerate
13393
13394 @node The Category Buffer
13395 @subsubsection The Category Buffer
13396
13397 You'd normally do all category maintenance from the category buffer.
13398 When you enter it for the first time (with the @kbd{J c} command from
13399 the group buffer), you'll only see the @code{default} category.
13400
13401 The following commands are available in this buffer:
13402
13403 @table @kbd
13404 @item q
13405 @kindex q (Category)
13406 @findex gnus-category-exit
13407 Return to the group buffer (@code{gnus-category-exit}).
13408
13409 @item k
13410 @kindex k (Category)
13411 @findex gnus-category-kill
13412 Kill the current category (@code{gnus-category-kill}).
13413
13414 @item c
13415 @kindex c (Category)
13416 @findex gnus-category-copy
13417 Copy the current category (@code{gnus-category-copy}).
13418
13419 @item a
13420 @kindex a (Category)
13421 @findex gnus-category-add
13422 Add a new category (@code{gnus-category-add}).
13423
13424 @item p
13425 @kindex p (Category)
13426 @findex gnus-category-edit-predicate
13427 Edit the predicate of the current category
13428 (@code{gnus-category-edit-predicate}).
13429
13430 @item g
13431 @kindex g (Category)
13432 @findex gnus-category-edit-groups
13433 Edit the list of groups belonging to the current category
13434 (@code{gnus-category-edit-groups}).
13435
13436 @item s
13437 @kindex s (Category)
13438 @findex gnus-category-edit-score
13439 Edit the download score rule of the current category
13440 (@code{gnus-category-edit-score}).
13441
13442 @item l
13443 @kindex l (Category)
13444 @findex gnus-category-list
13445 List all the categories (@code{gnus-category-list}).
13446 @end table
13447
13448
13449 @node Category Variables
13450 @subsubsection Category Variables
13451
13452 @table @code
13453 @item gnus-category-mode-hook
13454 @vindex gnus-category-mode-hook
13455 Hook run in category buffers.
13456
13457 @item gnus-category-line-format
13458 @vindex gnus-category-line-format
13459 Format of the lines in the category buffer (@pxref{Formatting
13460 Variables}).  Valid elements are:
13461
13462 @table @samp
13463 @item c
13464 The name of the category.
13465
13466 @item g
13467 The number of groups in the category.
13468 @end table
13469
13470 @item gnus-category-mode-line-format
13471 @vindex gnus-category-mode-line-format
13472 Format of the category mode line (@pxref{Mode Line Formatting}).
13473
13474 @item gnus-agent-short-article
13475 @vindex gnus-agent-short-article
13476 Articles that have fewer lines than this are short.  Default 100.
13477
13478 @item gnus-agent-long-article
13479 @vindex gnus-agent-long-article
13480 Articles that have more lines than this are long.  Default 200.
13481
13482 @item gnus-agent-low-score
13483 @vindex gnus-agent-low-score
13484 Articles that have a score lower than this have a low score.  Default
13485 0.
13486
13487 @item gnus-agent-high-score
13488 @vindex gnus-agent-high-score
13489 Articles that have a score higher than this have a high score.  Default
13490 0.
13491
13492 @end table
13493
13494
13495 @node Agent Commands
13496 @subsection Agent Commands
13497
13498 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
13499 (@code{gnus-agent-toggle-plugged} command works in all modes, and
13500 toggles the plugged/unplugged state of the Gnus Agent.
13501
13502
13503 @menu
13504 * Group Agent Commands::
13505 * Summary Agent Commands::
13506 * Server Agent Commands::
13507 @end menu
13508
13509 You can run a complete batch fetch from the command line with the
13510 following incantation:
13511
13512 @cindex gnus-agent-batch-fetch
13513 @example
13514 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
13515 @end example
13516
13517
13518
13519 @node Group Agent Commands
13520 @subsubsection Group Agent Commands
13521
13522 @table @kbd
13523 @item J u
13524 @kindex J u (Agent Group)
13525 @findex gnus-agent-fetch-groups
13526 Fetch all eligible articles in the current group
13527 (@code{gnus-agent-fetch-groups}).
13528
13529 @item J c
13530 @kindex J c (Agent Group)
13531 @findex gnus-enter-category-buffer
13532 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
13533
13534 @item J s
13535 @kindex J s (Agent Group)
13536 @findex gnus-agent-fetch-session
13537 Fetch all eligible articles in all groups
13538 (@code{gnus-agent-fetch-session}).
13539
13540 @item J S
13541 @kindex J S (Agent Group)
13542 @findex gnus-group-send-drafts
13543 Send all sendable messages in the draft group
13544 (@code{gnus-group-send-drafts}).  @xref{Drafts}.
13545
13546 @item J a
13547 @kindex J a (Agent Group)
13548 @findex gnus-agent-add-group
13549 Add the current group to an Agent category
13550 (@code{gnus-agent-add-group}).  This command understands the
13551 process/prefix convention (@pxref{Process/Prefix}).
13552
13553 @item J r
13554 @kindex J r (Agent Group)
13555 @findex gnus-agent-remove-group
13556 Remove the current group from its category, if any
13557 (@code{gnus-agent-remove-group}).  This command understands the
13558 process/prefix convention (@pxref{Process/Prefix}).
13559
13560 @end table
13561
13562
13563 @node Summary Agent Commands
13564 @subsubsection Summary Agent Commands
13565
13566 @table @kbd
13567 @item J #
13568 @kindex J # (Agent Summary)
13569 @findex gnus-agent-mark-article
13570 Mark the article for downloading (@code{gnus-agent-mark-article}).
13571
13572 @item J M-#
13573 @kindex J M-# (Agent Summary)
13574 @findex gnus-agent-unmark-article
13575 Remove the downloading mark from the article
13576 (@code{gnus-agent-unmark-article}).
13577
13578 @item @@
13579 @kindex @@ (Agent Summary)
13580 @findex gnus-agent-toggle-mark
13581 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
13582
13583 @item J c
13584 @kindex J c (Agent Summary)
13585 @findex gnus-agent-catchup
13586 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
13587
13588 @end table
13589
13590
13591 @node Server Agent Commands
13592 @subsubsection Server Agent Commands
13593
13594 @table @kbd
13595 @item J a
13596 @kindex J a (Agent Server)
13597 @findex gnus-agent-add-server
13598 Add the current server to the list of servers covered by the Gnus Agent
13599 (@code{gnus-agent-add-server}).
13600
13601 @item J r
13602 @kindex J r (Agent Server)
13603 @findex gnus-agent-remove-server
13604 Remove the current server from the list of servers covered by the Gnus
13605 Agent (@code{gnus-agent-remove-server}).
13606
13607 @end table
13608
13609
13610 @node Agent Expiry
13611 @subsection Agent Expiry
13612
13613 @vindex gnus-agent-expire-days
13614 @findex gnus-agent-expire
13615 @kindex M-x gnus-agent-expire
13616 @cindex Agent expiry
13617 @cindex Gnus Agent expiry
13618 @cindex expiry
13619
13620 @code{nnagent} doesn't handle expiry.  Instead, there's a special
13621 @code{gnus-agent-expire} command that will expire all read articles that
13622 are older than @code{gnus-agent-expire-days} days.  It can be run
13623 whenever you feel that you're running out of space.  It's not
13624 particularly fast or efficient, and it's not a particularly good idea to
13625 interrupt it (with @kbd{C-g} or anything else) once you've started it.
13626
13627 @vindex gnus-agent-expire-all
13628 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
13629 expire all articles---unread, read, ticked and dormant.  If @code{nil}
13630 (which is the default), only read articles are eligible for expiry, and
13631 unread, ticked and dormant articles will be kept indefinitely.
13632
13633
13634 @node Outgoing Messages
13635 @subsection Outgoing Messages
13636
13637 When Gnus is unplugged, all outgoing messages (both mail and news) are
13638 stored in the draft groups (@pxref{Drafts}).  You can view them there
13639 after posting, and edit them at will.
13640
13641 When Gnus is plugged again, you can send the messages either from the
13642 draft group with the special commands available there, or you can use
13643 the @kbd{J S} command in the group buffer to send all the sendable
13644 messages in the draft group.
13645
13646
13647
13648 @node Agent Variables
13649 @subsection Agent Variables
13650
13651 @table @code
13652 @item gnus-agent-directory
13653 @vindex gnus-agent-directory
13654 Where the Gnus Agent will store its files.  The default is
13655 @file{~/News/agent/}.
13656
13657 @item gnus-agent-handle-level
13658 @vindex gnus-agent-handle-level
13659 Groups on levels (@pxref{Group Levels}) higher than this variable will
13660 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
13661 which means that only subscribed group will be considered by the Agent
13662 by default.
13663
13664 @item gnus-agent-plugged-hook
13665 @vindex gnus-agent-plugged-hook
13666 Hook run when connecting to the network.
13667
13668 @item gnus-agent-unplugged-hook
13669 @vindex gnus-agent-unplugged-hook
13670 Hook run when disconnecting from the network.
13671
13672 @end table
13673
13674
13675 @node Example Setup
13676 @subsection Example Setup
13677
13678 If you don't want to read this manual, and you have a fairly standard
13679 setup, you may be able to use something like the following as your
13680 @file{.gnus.el} file to get started.
13681
13682 @lisp
13683 ;;; Define how Gnus is to fetch news.  We do this over NNTP
13684 ;;; from your ISP's server.
13685 (setq gnus-select-method '(nntp "news.your-isp.com"))
13686
13687 ;;; Define how Gnus is to read your mail.  We read mail from
13688 ;;; your ISP's POP server.
13689 (setq mail-sources '((pop :server "pop.your-isp.com")))
13690
13691 ;;; Say how Gnus is to store the mail.  We use nnml groups.
13692 (setq gnus-secondary-select-methods '((nnml "")))
13693
13694 ;;; Make Gnus into an offline newsreader.
13695 (gnus-agentize)
13696 @end lisp
13697
13698 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
13699 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
13700 gnus}.
13701
13702 If this is the first time you've run Gnus, you will be subscribed
13703 automatically to a few default newsgroups.  You'll probably want to
13704 subscribe to more groups, and to do that, you have to query the
13705 @sc{nntp} server for a complete list of groups with the @kbd{A A}
13706 command.  This usually takes quite a while, but you only have to do it
13707 once.
13708
13709 After reading and parsing a while, you'll be presented with a list of
13710 groups.  Subscribe to the ones you want to read with the @kbd{u}
13711 command.  @kbd{l} to make all the killed groups disappear after you've
13712 subscribe to all the groups you want to read.  (@kbd{A k} will bring
13713 back all the killed groups.)
13714
13715 You can now read the groups at once, or you can download the articles
13716 with the @kbd{J s} command.  And then read the rest of this manual to
13717 find out which of the other gazillion things you want to customize.
13718
13719
13720 @node Batching Agents
13721 @subsection Batching Agents
13722
13723 Having the Gnus Agent fetch articles (and post whatever messages you've
13724 written) is quite easy once you've gotten things set up properly.  The
13725 following shell script will do everything that is necessary:
13726
13727 @example
13728 #!/bin/sh
13729 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
13730 @end example
13731
13732
13733 @node Agent Caveats
13734 @subsection Agent Caveats
13735
13736 The Gnus Agent doesn't seem to work like most other offline
13737 newsreaders.  Here are some common questions that some imaginary people
13738 may ask:
13739
13740 @table @dfn
13741 @item If I read an article while plugged, do they get entered into the
13742 Agent?
13743
13744 @strong{No.}
13745
13746 @item If I read an article while plugged, and the article already exists
13747 in the Agent, will it get downloaded once more?
13748
13749 @strong{Yes.}
13750
13751 @end table
13752
13753 In short, when Gnus is unplugged, it only looks into the locally stored
13754 articles; when it's plugged, it only talks to your ISP.
13755
13756
13757 @node Scoring
13758 @chapter Scoring
13759 @cindex scoring
13760
13761 Other people use @dfn{kill files}, but we here at Gnus Towers like
13762 scoring better than killing, so we'd rather switch than fight.  They do
13763 something completely different as well, so sit up straight and pay
13764 attention!
13765
13766 @vindex gnus-summary-mark-below
13767 All articles have a default score (@code{gnus-summary-default-score}),
13768 which is 0 by default.  This score may be raised or lowered either
13769 interactively or by score files.  Articles that have a score lower than
13770 @code{gnus-summary-mark-below} are marked as read.
13771
13772 Gnus will read any @dfn{score files} that apply to the current group
13773 before generating the summary buffer.
13774
13775 There are several commands in the summary buffer that insert score
13776 entries based on the current article.  You can, for instance, ask Gnus to
13777 lower or increase the score of all articles with a certain subject.
13778
13779 There are two sorts of scoring entries: Permanent and temporary.
13780 Temporary score entries are self-expiring entries.  Any entries that are
13781 temporary and have not been used for, say, a week, will be removed
13782 silently to help keep the sizes of the score files down.
13783
13784 @menu
13785 * Summary Score Commands::   Adding score entries for the current group.
13786 * Group Score Commands::     General score commands.
13787 * Score Variables::          Customize your scoring.  (My, what terminology).
13788 * Score File Format::        What a score file may contain.
13789 * Score File Editing::       You can edit score files by hand as well.
13790 * Adaptive Scoring::         Big Sister Gnus knows what you read.
13791 * Home Score File::          How to say where new score entries are to go.
13792 * Followups To Yourself::    Having Gnus notice when people answer you.
13793 * Scoring Tips::             How to score effectively.
13794 * Reverse Scoring::          That problem child of old is not problem.
13795 * Global Score Files::       Earth-spanning, ear-splitting score files.
13796 * Kill Files::               They are still here, but they can be ignored.
13797 * Converting Kill Files::    Translating kill files to score files.
13798 * GroupLens::                Getting predictions on what you like to read.
13799 * Advanced Scoring::         Using logical expressions to build score rules.
13800 * Score Decays::             It can be useful to let scores wither away.
13801 @end menu
13802
13803
13804 @node Summary Score Commands
13805 @section Summary Score Commands
13806 @cindex score commands
13807
13808 The score commands that alter score entries do not actually modify real
13809 score files.  That would be too inefficient.  Gnus maintains a cache of
13810 previously loaded score files, one of which is considered the
13811 @dfn{current score file alist}.  The score commands simply insert
13812 entries into this list, and upon group exit, this list is saved.
13813
13814 The current score file is by default the group's local score file, even
13815 if no such score file actually exists.  To insert score commands into
13816 some other score file (e.g. @file{all.SCORE}), you must first make this
13817 score file the current one.
13818
13819 General score commands that don't actually change the score file:
13820
13821 @table @kbd
13822
13823 @item V s
13824 @kindex V s (Summary)
13825 @findex gnus-summary-set-score
13826 Set the score of the current article (@code{gnus-summary-set-score}).
13827
13828 @item V S
13829 @kindex V S (Summary)
13830 @findex gnus-summary-current-score
13831 Display the score of the current article
13832 (@code{gnus-summary-current-score}).
13833
13834 @item V t
13835 @kindex V t (Summary)
13836 @findex gnus-score-find-trace
13837 Display all score rules that have been used on the current article
13838 (@code{gnus-score-find-trace}).
13839
13840 @item V R
13841 @kindex V R (Summary)
13842 @findex gnus-summary-rescore
13843 Run the current summary through the scoring process
13844 (@code{gnus-summary-rescore}).  This might be useful if you're playing
13845 around with your score files behind Gnus' back and want to see the
13846 effect you're having.
13847
13848 @item V c
13849 @kindex V c (Summary)
13850 @findex gnus-score-change-score-file
13851 Make a different score file the current
13852 (@code{gnus-score-change-score-file}).
13853
13854 @item V e
13855 @kindex V e (Summary)
13856 @findex gnus-score-edit-current-scores
13857 Edit the current score file (@code{gnus-score-edit-current-scores}).
13858 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
13859 File Editing}).
13860
13861 @item V f
13862 @kindex V f (Summary)
13863 @findex gnus-score-edit-file
13864 Edit a score file and make this score file the current one
13865 (@code{gnus-score-edit-file}).
13866
13867 @item V F
13868 @kindex V F (Summary)
13869 @findex gnus-score-flush-cache
13870 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
13871 after editing score files.
13872
13873 @item V C
13874 @kindex V C (Summary)
13875 @findex gnus-score-customize
13876 Customize a score file in a visually pleasing manner
13877 (@code{gnus-score-customize}).
13878
13879 @end table
13880
13881 The rest of these commands modify the local score file.
13882
13883 @table @kbd
13884
13885 @item V m
13886 @kindex V m (Summary)
13887 @findex gnus-score-set-mark-below
13888 Prompt for a score, and mark all articles with a score below this as
13889 read (@code{gnus-score-set-mark-below}).
13890
13891 @item V x
13892 @kindex V x (Summary)
13893 @findex gnus-score-set-expunge-below
13894 Prompt for a score, and add a score rule to the current score file to
13895 expunge all articles below this score
13896 (@code{gnus-score-set-expunge-below}).
13897 @end table
13898
13899 The keystrokes for actually making score entries follow a very regular
13900 pattern, so there's no need to list all the commands.  (Hundreds of
13901 them.)
13902
13903 @findex gnus-summary-increase-score
13904 @findex gnus-summary-lower-score
13905
13906 @enumerate
13907 @item
13908 The first key is either @kbd{I} (upper case i) for increasing the score
13909 or @kbd{L} for lowering the score.
13910 @item
13911 The second key says what header you want to score on.  The following
13912 keys are available:
13913 @table @kbd
13914
13915 @item a
13916 Score on the author name.
13917
13918 @item s
13919 Score on the subject line.
13920
13921 @item x
13922 Score on the @code{Xref} line---i.e., the cross-posting line.
13923
13924 @item r
13925 Score on the @code{References} line.
13926
13927 @item d
13928 Score on the date.
13929
13930 @item l
13931 Score on the number of lines.
13932
13933 @item i
13934 Score on the @code{Message-ID} header.
13935
13936 @item f
13937 Score on followups---this matches the author name, and adds scores to
13938 the followups to this author.
13939
13940 @item b
13941 Score on the body.
13942
13943 @item h
13944 Score on the head.
13945
13946 @item t
13947 Score on thread.
13948
13949 @end table
13950
13951 @item
13952 The third key is the match type.  Which match types are valid depends on
13953 what headers you are scoring on.
13954
13955 @table @code
13956
13957 @item strings
13958
13959 @table @kbd
13960
13961 @item e
13962 Exact matching.
13963
13964 @item s
13965 Substring matching.
13966
13967 @item f
13968 Fuzzy matching (@pxref{Fuzzy Matching}).
13969
13970 @item r
13971 Regexp matching
13972 @end table
13973
13974 @item date
13975 @table @kbd
13976
13977 @item b
13978 Before date.
13979
13980 @item a
13981 After date.
13982
13983 @item n
13984 This date.
13985 @end table
13986
13987 @item number
13988 @table @kbd
13989
13990 @item <
13991 Less than number.
13992
13993 @item =
13994 Equal to number.
13995
13996 @item >
13997 Greater than number.
13998 @end table
13999 @end table
14000
14001 @item
14002 The fourth and final key says whether this is a temporary (i.e., expiring)
14003 score entry, or a permanent (i.e., non-expiring) score entry, or whether
14004 it is to be done immediately, without adding to the score file.
14005 @table @kbd
14006
14007 @item t
14008 Temporary score entry.
14009
14010 @item p
14011 Permanent score entry.
14012
14013 @item i
14014 Immediately scoring.
14015 @end table
14016
14017 @end enumerate
14018
14019 So, let's say you want to increase the score on the current author with
14020 exact matching permanently: @kbd{I a e p}.  If you want to lower the
14021 score based on the subject line, using substring matching, and make a
14022 temporary score entry: @kbd{L s s t}.  Pretty easy.
14023
14024 To make things a bit more complicated, there are shortcuts.  If you use
14025 a capital letter on either the second or third keys, Gnus will use
14026 defaults for the remaining one or two keystrokes.  The defaults are
14027 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
14028 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
14029
14030 These functions take both the numerical prefix and the symbolic prefix
14031 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
14032 (or increase) the score of the article.  A symbolic prefix of @code{a}
14033 says to use the @file{all.SCORE} file for the command instead of the
14034 current score file.
14035
14036 @vindex gnus-score-mimic-keymap
14037 The @code{gnus-score-mimic-keymap} says whether these commands will
14038 pretend they are keymaps or not.
14039
14040
14041 @node Group Score Commands
14042 @section Group Score Commands
14043 @cindex group score commands
14044
14045 There aren't many of these as yet, I'm afraid.
14046
14047 @table @kbd
14048
14049 @item W f
14050 @kindex W f (Group)
14051 @findex gnus-score-flush-cache
14052 Gnus maintains a cache of score alists to avoid having to reload them
14053 all the time.  This command will flush the cache
14054 (@code{gnus-score-flush-cache}).
14055
14056 @end table
14057
14058 You can do scoring from the command line by saying something like:
14059
14060 @findex gnus-batch-score
14061 @cindex batch scoring
14062 @example
14063 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
14064 @end example
14065
14066
14067 @node Score Variables
14068 @section Score Variables
14069 @cindex score variables
14070
14071 @table @code
14072
14073 @item gnus-use-scoring
14074 @vindex gnus-use-scoring
14075 If @code{nil}, Gnus will not check for score files, and will not, in
14076 general, do any score-related work.  This is @code{t} by default.
14077
14078 @item gnus-kill-killed
14079 @vindex gnus-kill-killed
14080 If this variable is @code{nil}, Gnus will never apply score files to
14081 articles that have already been through the kill process.  While this
14082 may save you lots of time, it also means that if you apply a kill file
14083 to a group, and then change the kill file and want to run it over you
14084 group again to kill more articles, it won't work.  You have to set this
14085 variable to @code{t} to do that.  (It is @code{t} by default.)
14086
14087 @item gnus-kill-files-directory
14088 @vindex gnus-kill-files-directory
14089 All kill and score files will be stored in this directory, which is
14090 initialized from the @code{SAVEDIR} environment variable by default.
14091 This is @file{~/News/} by default.
14092
14093 @item gnus-score-file-suffix
14094 @vindex gnus-score-file-suffix
14095 Suffix to add to the group name to arrive at the score file name
14096 (@samp{SCORE} by default.)
14097
14098 @item gnus-score-uncacheable-files
14099 @vindex gnus-score-uncacheable-files
14100 @cindex score cache
14101 All score files are normally cached to avoid excessive re-loading of
14102 score files.  However, if this might make your Emacs grow big and
14103 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
14104 @file{all.SCORE}, while it might be a good idea to not cache
14105 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
14106 variable is @samp{ADAPT$} by default, so no adaptive score files will
14107 be cached.
14108
14109 @item gnus-save-score
14110 @vindex gnus-save-score
14111 If you have really complicated score files, and do lots of batch
14112 scoring, then you might set this variable to @code{t}.  This will make
14113 Gnus save the scores into the @file{.newsrc.eld} file.
14114
14115 If you do not set this to @code{t}, then manual scores (like those set
14116 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
14117 across group visits.
14118
14119 @item gnus-score-interactive-default-score
14120 @vindex gnus-score-interactive-default-score
14121 Score used by all the interactive raise/lower commands to raise/lower
14122 score with.  Default is 1000, which may seem excessive, but this is to
14123 ensure that the adaptive scoring scheme gets enough room to play with.
14124 We don't want the small changes from the adaptive scoring to overwrite
14125 manually entered data.
14126
14127 @item gnus-summary-default-score
14128 @vindex gnus-summary-default-score
14129 Default score of an article, which is 0 by default.
14130
14131 @item gnus-summary-expunge-below
14132 @vindex gnus-summary-expunge-below
14133 Don't display the summary lines of articles that have scores lower than
14134 this variable.  This is @code{nil} by default, which means that no
14135 articles will be hidden.  This variable is local to the summary buffers,
14136 and has to be set from @code{gnus-summary-mode-hook}.
14137
14138 @item gnus-score-over-mark
14139 @vindex gnus-score-over-mark
14140 Mark (in the third column) used for articles with a score over the
14141 default.  Default is @samp{+}.
14142
14143 @item gnus-score-below-mark
14144 @vindex gnus-score-below-mark
14145 Mark (in the third column) used for articles with a score below the
14146 default.  Default is @samp{-}.
14147
14148 @item gnus-score-find-score-files-function
14149 @vindex gnus-score-find-score-files-function
14150 Function used to find score files for the current group.  This function
14151 is called with the name of the group as the argument.
14152
14153 Predefined functions available are:
14154 @table @code
14155
14156 @item gnus-score-find-single
14157 @findex gnus-score-find-single
14158 Only apply the group's own score file.
14159
14160 @item gnus-score-find-bnews
14161 @findex gnus-score-find-bnews
14162 Apply all score files that match, using bnews syntax.  This is the
14163 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
14164 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
14165 @file{gnu.all.SCORE} would all apply.  In short, the instances of
14166 @samp{all} in the score file names are translated into @samp{.*}, and
14167 then a regexp match is done.
14168
14169 This means that if you have some score entries that you want to apply to
14170 all groups, then you put those entries in the @file{all.SCORE} file.
14171
14172 The score files are applied in a semi-random order, although Gnus will
14173 try to apply the more general score files before the more specific score
14174 files.  It does this by looking at the number of elements in the score
14175 file names---discarding the @samp{all} elements.
14176
14177 @item gnus-score-find-hierarchical
14178 @findex gnus-score-find-hierarchical
14179 Apply all score files from all the parent groups.  This means that you
14180 can't have score files like @file{all.SCORE}, but you can have
14181 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
14182
14183 @end table
14184 This variable can also be a list of functions.  In that case, all these
14185 functions will be called, and all the returned lists of score files will
14186 be applied.  These functions can also return lists of score alists
14187 directly.  In that case, the functions that return these non-file score
14188 alists should probably be placed before the ``real'' score file
14189 functions, to ensure that the last score file returned is the local
14190 score file.  Phu.
14191
14192 @item gnus-score-expiry-days
14193 @vindex gnus-score-expiry-days
14194 This variable says how many days should pass before an unused score file
14195 entry is expired.  If this variable is @code{nil}, no score file entries
14196 are expired.  It's 7 by default.
14197
14198 @item gnus-update-score-entry-dates
14199 @vindex gnus-update-score-entry-dates
14200 If this variable is non-@code{nil}, matching score entries will have
14201 their dates updated.  (This is how Gnus controls expiry---all
14202 non-matching entries will become too old while matching entries will
14203 stay fresh and young.)  However, if you set this variable to @code{nil},
14204 even matching entries will grow old and will have to face that oh-so
14205 grim reaper.
14206
14207 @item gnus-score-after-write-file-function
14208 @vindex gnus-score-after-write-file-function
14209 Function called with the name of the score file just written.
14210
14211 @item gnus-score-thread-simplify
14212 @vindex gnus-score-thread-simplify
14213 If this variable is non-@code{nil}, article subjects will be simplified
14214 for subject scoring purposes in the same manner as with
14215 threading---according to the current value of
14216 gnus-simplify-subject-functions.  If the scoring entry uses
14217 @code{substring} or @code{exact} matching, the match will also be
14218 simplified in this manner.
14219
14220 @end table
14221
14222
14223 @node Score File Format
14224 @section Score File Format
14225 @cindex score file format
14226
14227 A score file is an @code{emacs-lisp} file that normally contains just a
14228 single form.  Casual users are not expected to edit these files;
14229 everything can be changed from the summary buffer.
14230
14231 Anyway, if you'd like to dig into it yourself, here's an example:
14232
14233 @lisp
14234 (("from"
14235   ("Lars Ingebrigtsen" -10000)
14236   ("Per Abrahamsen")
14237   ("larsi\\|lmi" -50000 nil R))
14238  ("subject"
14239   ("Ding is Badd" nil 728373))
14240  ("xref"
14241   ("alt.politics" -1000 728372 s))
14242  ("lines"
14243   (2 -100 nil <))
14244  (mark 0)
14245  (expunge -1000)
14246  (mark-and-expunge -10)
14247  (read-only nil)
14248  (orphan -10)
14249  (adapt t)
14250  (files "/hom/larsi/News/gnu.SCORE")
14251  (exclude-files "all.SCORE")
14252  (local (gnus-newsgroup-auto-expire t)
14253         (gnus-summary-make-false-root empty))
14254  (eval (ding)))
14255 @end lisp
14256
14257 This example demonstrates most score file elements.  For a different
14258 approach, see @pxref{Advanced Scoring}.
14259
14260 Even though this looks much like lisp code, nothing here is actually
14261 @code{eval}ed.  The lisp reader is used to read this form, though, so it
14262 has to be valid syntactically, if not semantically.
14263
14264 Six keys are supported by this alist:
14265
14266 @table @code
14267
14268 @item STRING
14269 If the key is a string, it is the name of the header to perform the
14270 match on.  Scoring can only be performed on these eight headers:
14271 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
14272 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
14273 these headers, there are three strings to tell Gnus to fetch the entire
14274 article and do the match on larger parts of the article: @code{Body}
14275 will perform the match on the body of the article, @code{Head} will
14276 perform the match on the head of the article, and @code{All} will
14277 perform the match on the entire article.  Note that using any of these
14278 last three keys will slow down group entry @emph{considerably}.  The
14279 final ``header'' you can score on is @code{Followup}.  These score
14280 entries will result in new score entries being added for all follow-ups
14281 to articles that matches these score entries.
14282
14283 Following this key is a arbitrary number of score entries, where each
14284 score entry has one to four elements.
14285 @enumerate
14286
14287 @item
14288 The first element is the @dfn{match element}.  On most headers this will
14289 be a string, but on the Lines and Chars headers, this must be an
14290 integer.
14291
14292 @item
14293 If the second element is present, it should be a number---the @dfn{score
14294 element}.  This number should be an integer in the neginf to posinf
14295 interval.  This number is added to the score of the article if the match
14296 is successful.  If this element is not present, the
14297 @code{gnus-score-interactive-default-score} number will be used
14298 instead.  This is 1000 by default.
14299
14300 @item
14301 If the third element is present, it should be a number---the @dfn{date
14302 element}.  This date says when the last time this score entry matched,
14303 which provides a mechanism for expiring the score entries.  It this
14304 element is not present, the score entry is permanent.  The date is
14305 represented by the number of days since December 31, 1 BCE.
14306
14307 @item
14308 If the fourth element is present, it should be a symbol---the @dfn{type
14309 element}.  This element specifies what function should be used to see
14310 whether this score entry matches the article.  What match types that can
14311 be used depends on what header you wish to perform the match on.
14312 @table @dfn
14313
14314 @item From, Subject, References, Xref, Message-ID
14315 For most header types, there are the @code{r} and @code{R} (regexp), as
14316 well as @code{s} and @code{S} (substring) types, and @code{e} and
14317 @code{E} (exact match), and @code{w} (word match) types.  If this
14318 element is not present, Gnus will assume that substring matching should
14319 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
14320 that the matches will be done in a case-sensitive manner.  All these
14321 one-letter types are really just abbreviations for the @code{regexp},
14322 @code{string}, @code{exact}, and @code{word} types, which you can use
14323 instead, if you feel like.
14324
14325 @item Lines, Chars
14326 These two headers use different match types: @code{<}, @code{>},
14327 @code{=}, @code{>=} and @code{<=}.
14328
14329 These predicates are true if
14330
14331 @example
14332 (PREDICATE HEADER MATCH)
14333 @end example
14334
14335 evaluates to non-@code{nil}.  For instance, the advanced match
14336 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
14337 following form:
14338
14339 @lisp
14340 (< header-value 4)
14341 @end lisp
14342
14343 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
14344 the match, we get the score added if the article has less than 4 lines.
14345 (It's easy to get confused and think it's the other way around.  But
14346 it's not.  I think.)
14347
14348 When matching on @code{Lines}, be careful because some backends (like
14349 @code{nndir}) do not generate @code{Lines} header, so every article ends
14350 up being marked as having 0 lines.  This can lead to strange results if
14351 you happen to lower score of the articles with few lines.
14352
14353 @item Date
14354 For the Date header we have three kinda silly match types:
14355 @code{before}, @code{at} and @code{after}.  I can't really imagine this
14356 ever being useful, but, like, it would feel kinda silly not to provide
14357 this function.  Just in case.  You never know.  Better safe than sorry.
14358 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
14359 sex on a first date.  (I have been told that at least one person, and I
14360 quote, ``found this function indispensable'', however.)
14361
14362 @cindex ISO8601
14363 @cindex date
14364 A more useful match type is @code{regexp}.  With it, you can match the
14365 date string using a regular expression.  The date is normalized to
14366 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
14367 you want to match all articles that have been posted on April 1st in
14368 every year, you could use @samp{....0401.........} as a match string,
14369 for instance.  (Note that the date is kept in its original time zone, so
14370 this will match articles that were posted when it was April 1st where
14371 the article was posted from.  Time zones are such wholesome fun for the
14372 whole family, eh?)
14373
14374 @item Head, Body, All
14375 These three match keys use the same match types as the @code{From} (etc)
14376 header uses.
14377
14378 @item Followup
14379 This match key is somewhat special, in that it will match the
14380 @code{From} header, and affect the score of not only the matching
14381 articles, but also all followups to the matching articles.  This allows
14382 you e.g. increase the score of followups to your own articles, or
14383 decrease the score of followups to the articles of some known
14384 trouble-maker.  Uses the same match types as the @code{From} header
14385 uses.  (Using this match key will lead to creation of @file{ADAPT}
14386 files.)
14387
14388 @item Thread
14389 This match key works along the same lines as the @code{Followup} match
14390 key.  If you say that you want to score on a (sub-)thread started by an
14391 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
14392 match.  This will add a new @samp{thread} match for each article that
14393 has @var{x} in its @code{References} header.  (These new @samp{thread}
14394 matches will use the @code{Message-ID}s of these matching articles.)
14395 This will ensure that you can raise/lower the score of an entire thread,
14396 even though some articles in the thread may not have complete
14397 @code{References} headers.  Note that using this may lead to
14398 undeterministic scores of the articles in the thread.  (Using this match
14399 key will lead to creation of @file{ADAPT} files.)
14400 @end table
14401 @end enumerate
14402
14403 @cindex Score File Atoms
14404 @item mark
14405 The value of this entry should be a number.  Any articles with a score
14406 lower than this number will be marked as read.
14407
14408 @item expunge
14409 The value of this entry should be a number.  Any articles with a score
14410 lower than this number will be removed from the summary buffer.
14411
14412 @item mark-and-expunge
14413 The value of this entry should be a number.  Any articles with a score
14414 lower than this number will be marked as read and removed from the
14415 summary buffer.
14416
14417 @item thread-mark-and-expunge
14418 The value of this entry should be a number.  All articles that belong to
14419 a thread that has a total score below this number will be marked as read
14420 and removed from the summary buffer.  @code{gnus-thread-score-function}
14421 says how to compute the total score for a thread.
14422
14423 @item files
14424 The value of this entry should be any number of file names.  These files
14425 are assumed to be score files as well, and will be loaded the same way
14426 this one was.
14427
14428 @item exclude-files
14429 The clue of this entry should be any number of files.  These files will
14430 not be loaded, even though they would normally be so, for some reason or
14431 other.
14432
14433 @item eval
14434 The value of this entry will be @code{eval}el.  This element will be
14435 ignored when handling global score files.
14436
14437 @item read-only
14438 Read-only score files will not be updated or saved.  Global score files
14439 should feature this atom (@pxref{Global Score Files}).  (Note:
14440 @dfn{Global} here really means @dfn{global}; not your personal
14441 apply-to-all-groups score files.)
14442
14443 @item orphan
14444 The value of this entry should be a number.  Articles that do not have
14445 parents will get this number added to their scores.  Imagine you follow
14446 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
14447 will only follow a few of the threads, also want to see any new threads.
14448
14449 You can do this with the following two score file entries:
14450
14451 @example
14452         (orphan -500)
14453         (mark-and-expunge -100)
14454 @end example
14455
14456 When you enter the group the first time, you will only see the new
14457 threads.  You then raise the score of the threads that you find
14458 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
14459 rest.  Next time you enter the group, you will see new articles in the
14460 interesting threads, plus any new threads.
14461
14462 I.e.---the orphan score atom is for high-volume groups where there
14463 exist a few interesting threads which can't be found automatically by
14464 ordinary scoring rules.
14465
14466 @item adapt
14467 This entry controls the adaptive scoring.  If it is @code{t}, the
14468 default adaptive scoring rules will be used.  If it is @code{ignore}, no
14469 adaptive scoring will be performed on this group.  If it is a list, this
14470 list will be used as the adaptive scoring rules.  If it isn't present,
14471 or is something other than @code{t} or @code{ignore}, the default
14472 adaptive scoring rules will be used.  If you want to use adaptive
14473 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
14474 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
14475 not want adaptive scoring.  If you only want adaptive scoring in a few
14476 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
14477 insert @code{(adapt t)} in the score files of the groups where you want
14478 it.
14479
14480 @item adapt-file
14481 All adaptive score entries will go to the file named by this entry.  It
14482 will also be applied when entering the group.  This atom might be handy
14483 if you want to adapt on several groups at once, using the same adaptive
14484 file for a number of groups.
14485
14486 @item local
14487 @cindex local variables
14488 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
14489 Each @var{var} will be made buffer-local to the current summary buffer,
14490 and set to the value specified.  This is a convenient, if somewhat
14491 strange, way of setting variables in some groups if you don't like hooks
14492 much.  Note that the @var{value} won't be evaluated.
14493 @end table
14494
14495
14496 @node Score File Editing
14497 @section Score File Editing
14498
14499 You normally enter all scoring commands from the summary buffer, but you
14500 might feel the urge to edit them by hand as well, so we've supplied you
14501 with a mode for that.
14502
14503 It's simply a slightly customized @code{emacs-lisp} mode, with these
14504 additional commands:
14505
14506 @table @kbd
14507
14508 @item C-c C-c
14509 @kindex C-c C-c (Score)
14510 @findex gnus-score-edit-done
14511 Save the changes you have made and return to the summary buffer
14512 (@code{gnus-score-edit-done}).
14513
14514 @item C-c C-d
14515 @kindex C-c C-d (Score)
14516 @findex gnus-score-edit-insert-date
14517 Insert the current date in numerical format
14518 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
14519 you were wondering.
14520
14521 @item C-c C-p
14522 @kindex C-c C-p (Score)
14523 @findex gnus-score-pretty-print
14524 The adaptive score files are saved in an unformatted fashion.  If you
14525 intend to read one of these files, you want to @dfn{pretty print} it
14526 first.  This command (@code{gnus-score-pretty-print}) does that for
14527 you.
14528
14529 @end table
14530
14531 Type @kbd{M-x gnus-score-mode} to use this mode.
14532
14533 @vindex gnus-score-mode-hook
14534 @code{gnus-score-menu-hook} is run in score mode buffers.
14535
14536 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
14537 e} to begin editing score files.
14538
14539
14540 @node Adaptive Scoring
14541 @section Adaptive Scoring
14542 @cindex adaptive scoring
14543
14544 If all this scoring is getting you down, Gnus has a way of making it all
14545 happen automatically---as if by magic.  Or rather, as if by artificial
14546 stupidity, to be precise.
14547
14548 @vindex gnus-use-adaptive-scoring
14549 When you read an article, or mark an article as read, or kill an
14550 article, you leave marks behind.  On exit from the group, Gnus can sniff
14551 these marks and add score elements depending on what marks it finds.
14552 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
14553 @code{t} or @code{(line)}.  If you want score adaptively on separate
14554 words appearing in the subjects, you should set this variable to
14555 @code{(word)}.  If you want to use both adaptive methods, set this
14556 variable to @code{(word line)}.
14557
14558 @vindex gnus-default-adaptive-score-alist
14559 To give you complete control over the scoring process, you can customize
14560 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
14561 might look something like this:
14562
14563 @lisp
14564 (defvar gnus-default-adaptive-score-alist
14565   '((gnus-unread-mark)
14566     (gnus-ticked-mark (from 4))
14567     (gnus-dormant-mark (from 5))
14568     (gnus-del-mark (from -4) (subject -1))
14569     (gnus-read-mark (from 4) (subject 2))
14570     (gnus-expirable-mark (from -1) (subject -1))
14571     (gnus-killed-mark (from -1) (subject -3))
14572     (gnus-kill-file-mark)
14573     (gnus-ancient-mark)
14574     (gnus-low-score-mark)
14575     (gnus-catchup-mark (from -1) (subject -1))))
14576 @end lisp
14577
14578 As you see, each element in this alist has a mark as a key (either a
14579 variable name or a ``real'' mark---a character).  Following this key is
14580 a arbitrary number of header/score pairs.  If there are no header/score
14581 pairs following the key, no adaptive scoring will be done on articles
14582 that have that key as the article mark.  For instance, articles with
14583 @code{gnus-unread-mark} in the example above will not get adaptive score
14584 entries.
14585
14586 Each article can have only one mark, so just a single of these rules
14587 will be applied to each article.
14588
14589 To take @code{gnus-del-mark} as an example---this alist says that all
14590 articles that have that mark (i.e., are marked with @samp{D}) will have a
14591 score entry added to lower based on the @code{From} header by -4, and
14592 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
14593
14594 If you have marked 10 articles with the same subject with
14595 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
14596 That means that that subject will get a score of ten times -1, which
14597 should be, unless I'm much mistaken, -10.
14598
14599 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
14600 the read articles will be marked with the @samp{E} mark.  This'll
14601 probably make adaptive scoring slightly impossible, so auto-expiring and
14602 adaptive scoring doesn't really mix very well.
14603
14604 The headers you can score on are @code{from}, @code{subject},
14605 @code{message-id}, @code{references}, @code{xref}, @code{lines},
14606 @code{chars} and @code{date}.  In addition, you can score on
14607 @code{followup}, which will create an adaptive score entry that matches
14608 on the @code{References} header using the @code{Message-ID} of the
14609 current article, thereby matching the following thread.
14610
14611 You can also score on @code{thread}, which will try to score all
14612 articles that appear in a thread.  @code{thread} matches uses a
14613 @code{Message-ID} to match on the @code{References} header of the
14614 article.  If the match is made, the @code{Message-ID} of the article is
14615 added to the @code{thread} rule.  (Think about it.  I'd recommend two
14616 aspirins afterwards.)
14617
14618 If you use this scheme, you should set the score file atom @code{mark}
14619 to something small---like -300, perhaps, to avoid having small random
14620 changes result in articles getting marked as read.
14621
14622 After using adaptive scoring for a week or so, Gnus should start to
14623 become properly trained and enhance the authors you like best, and kill
14624 the authors you like least, without you having to say so explicitly.
14625
14626 You can control what groups the adaptive scoring is to be performed on
14627 by using the score files (@pxref{Score File Format}).  This will also
14628 let you use different rules in different groups.
14629
14630 @vindex gnus-adaptive-file-suffix
14631 The adaptive score entries will be put into a file where the name is the
14632 group name with @code{gnus-adaptive-file-suffix} appended.  The default
14633 is @samp{ADAPT}.
14634
14635 @vindex gnus-score-exact-adapt-limit
14636 When doing adaptive scoring, substring or fuzzy matching would probably
14637 give you the best results in most cases.  However, if the header one
14638 matches is short, the possibility for false positives is great, so if
14639 the length of the match is less than
14640 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
14641 this variable is @code{nil}, exact matching will always be used to avoid
14642 this problem.
14643
14644 @vindex gnus-default-adaptive-word-score-alist
14645 As mentioned above, you can adapt either on individual words or entire
14646 headers.  If you adapt on words, the
14647 @code{gnus-default-adaptive-word-score-alist} variable says what score
14648 each instance of a word should add given a mark.
14649
14650 @lisp
14651 (setq gnus-default-adaptive-word-score-alist
14652       `((,gnus-read-mark . 30)
14653         (,gnus-catchup-mark . -10)
14654         (,gnus-killed-mark . -20)
14655         (,gnus-del-mark . -15)))
14656 @end lisp
14657
14658 This is the default value.  If you have adaption on words enabled, every
14659 word that appears in subjects of articles marked with
14660 @code{gnus-read-mark} will result in a score rule that increase the
14661 score with 30 points.
14662
14663 @vindex gnus-default-ignored-adaptive-words
14664 @vindex gnus-ignored-adaptive-words
14665 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
14666 will be ignored.  If you wish to add more words to be ignored, use the
14667 @code{gnus-ignored-adaptive-words} list instead.
14668
14669 @vindex gnus-adaptive-word-syntax-table
14670 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
14671 syntax table in effect.  It is similar to the standard syntax table, but
14672 it considers numbers to be non-word-constituent characters.
14673
14674 @vindex gnus-adaptive-word-minimum
14675 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
14676 word scoring process will never bring down the score of an article to
14677 below this number.  The default is @code{nil}.
14678
14679 @vindex gnus-adaptive-word-no-group-words
14680 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
14681 won't adaptively word score any of the words in the group name.  Useful
14682 for groups like @samp{comp.editors.emacs}, where most of the subject
14683 lines contain the word @samp{emacs}.
14684
14685 After using this scheme for a while, it might be nice to write a
14686 @code{gnus-psychoanalyze-user} command to go through the rules and see
14687 what words you like and what words you don't like.  Or perhaps not.
14688
14689 Note that the adaptive word scoring thing is highly experimental and is
14690 likely to change in the future.  Initial impressions seem to indicate
14691 that it's totally useless as it stands.  Some more work (involving more
14692 rigorous statistical methods) will have to be done to make this useful.
14693
14694
14695 @node Home Score File
14696 @section Home Score File
14697
14698 The score file where new score file entries will go is called the
14699 @dfn{home score file}.  This is normally (and by default) the score file
14700 for the group itself.  For instance, the home score file for
14701 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
14702
14703 However, this may not be what you want.  It is often convenient to share
14704 a common home score file among many groups---all @samp{emacs} groups
14705 could perhaps use the same home score file.
14706
14707 @vindex gnus-home-score-file
14708 The variable that controls this is @code{gnus-home-score-file}.  It can
14709 be:
14710
14711 @enumerate
14712 @item
14713 A string.  Then this file will be used as the home score file for all
14714 groups.
14715
14716 @item
14717 A function. The result of this function will be used as the home score
14718 file.  The function will be called with the name of the group as the
14719 parameter.
14720
14721 @item
14722 A list.  The elements in this list can be:
14723
14724 @enumerate
14725 @item
14726 @code{(@var{regexp} @var{file-name})}.  If the @var{regexp} matches the
14727 group name, the @var{file-name} will will be used as the home score file.
14728
14729 @item
14730 A function. If the function returns non-nil, the result will be used as
14731 the home score file.
14732
14733 @item
14734 A string.  Use the string as the home score file.
14735 @end enumerate
14736
14737 The list will be traversed from the beginning towards the end looking
14738 for matches.
14739
14740 @end enumerate
14741
14742 So, if you want to use just a single score file, you could say:
14743
14744 @lisp
14745 (setq gnus-home-score-file
14746       "my-total-score-file.SCORE")
14747 @end lisp
14748
14749 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
14750 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
14751
14752 @findex gnus-hierarchial-home-score-file
14753 @lisp
14754 (setq gnus-home-score-file
14755       'gnus-hierarchial-home-score-file)
14756 @end lisp
14757
14758 This is a ready-made function provided for your convenience.
14759 Other functions include
14760
14761 @table @code
14762 @item gnus-current-home-score-file
14763 @findex gnus-current-home-score-file
14764 Return the ``current'' regular score file.  This will make scoring
14765 commands add entry to the ``innermost'' matching score file.
14766
14767 @end table
14768
14769 If you want to have one score file for the @samp{emacs} groups and
14770 another for the @samp{comp} groups, while letting all other groups use
14771 their own home score files:
14772
14773 @lisp
14774 (setq gnus-home-score-file
14775       ;; All groups that match the regexp "\\.emacs"
14776       '(("\\.emacs" "emacs.SCORE")
14777         ;; All the comp groups in one score file
14778         ("^comp" "comp.SCORE")))
14779 @end lisp
14780
14781 @vindex gnus-home-adapt-file
14782 @code{gnus-home-adapt-file} works exactly the same way as
14783 @code{gnus-home-score-file}, but says what the home adaptive score file
14784 is instead.  All new adaptive file entries will go into the file
14785 specified by this variable, and the same syntax is allowed.
14786
14787 In addition to using @code{gnus-home-score-file} and
14788 @code{gnus-home-adapt-file}, you can also use group parameters
14789 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
14790 Parameters}) to achieve much the same.  Group and topic parameters take
14791 precedence over this variable.
14792
14793
14794 @node Followups To Yourself
14795 @section Followups To Yourself
14796
14797 Gnus offers two commands for picking out the @code{Message-ID} header in
14798 the current buffer.  Gnus will then add a score rule that scores using
14799 this @code{Message-ID} on the @code{References} header of other
14800 articles.  This will, in effect, increase the score of all articles that
14801 respond to the article in the current buffer.  Quite useful if you want
14802 to easily note when people answer what you've said.
14803
14804 @table @code
14805
14806 @item gnus-score-followup-article
14807 @findex gnus-score-followup-article
14808 This will add a score to articles that directly follow up your own
14809 article.
14810
14811 @item gnus-score-followup-thread
14812 @findex gnus-score-followup-thread
14813 This will add a score to all articles that appear in a thread ``below''
14814 your own article.
14815 @end table
14816
14817 @vindex message-sent-hook
14818 These two functions are both primarily meant to be used in hooks like
14819 @code{message-sent-hook}.
14820
14821 If you look closely at your own @code{Message-ID}, you'll notice that
14822 the first two or three characters are always the same.  Here's two of
14823 mine:
14824
14825 @example
14826 <x6u3u47icf.fsf@@eyesore.no>
14827 <x6sp9o7ibw.fsf@@eyesore.no>
14828 @end example
14829
14830 So ``my'' ident on this machine is @samp{x6}.  This can be
14831 exploited---the following rule will raise the score on all followups to
14832 myself:
14833
14834 @lisp
14835 ("references"
14836  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
14837   1000 nil r))
14838 @end lisp
14839
14840 Whether it's the first two or first three characters that are ``yours''
14841 is system-dependent.
14842
14843
14844 @node Scoring Tips
14845 @section Scoring Tips
14846 @cindex scoring tips
14847
14848 @table @dfn
14849
14850 @item Crossposts
14851 @cindex crossposts
14852 @cindex scoring crossposts
14853 If you want to lower the score of crossposts, the line to match on is
14854 the @code{Xref} header.
14855 @lisp
14856 ("xref" (" talk.politics.misc:" -1000))
14857 @end lisp
14858
14859 @item Multiple crossposts
14860 If you want to lower the score of articles that have been crossposted to
14861 more than, say, 3 groups:
14862 @lisp
14863 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
14864 @end lisp
14865
14866 @item Matching on the body
14867 This is generally not a very good idea---it takes a very long time.
14868 Gnus actually has to fetch each individual article from the server.  But
14869 you might want to anyway, I guess.  Even though there are three match
14870 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
14871 and stick with it in each score file.  If you use any two, each article
14872 will be fetched @emph{twice}.  If you want to match a bit on the
14873 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
14874 the matches.
14875
14876 @item Marking as read
14877 You will probably want to mark articles that have scores below a certain
14878 number as read.  This is most easily achieved by putting the following
14879 in your @file{all.SCORE} file:
14880 @lisp
14881 ((mark -100))
14882 @end lisp
14883 You may also consider doing something similar with @code{expunge}.
14884
14885 @item Negated character classes
14886 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
14887 That will match newlines, which might lead to, well, The Unknown.  Say
14888 @code{[^abcd\n]*} instead.
14889 @end table
14890
14891
14892 @node Reverse Scoring
14893 @section Reverse Scoring
14894 @cindex reverse scoring
14895
14896 If you want to keep just articles that have @samp{Sex with Emacs} in the
14897 subject header, and expunge all other articles, you could put something
14898 like this in your score file:
14899
14900 @lisp
14901 (("subject"
14902   ("Sex with Emacs" 2))
14903  (mark 1)
14904  (expunge 1))
14905 @end lisp
14906
14907 So, you raise all articles that match @samp{Sex with Emacs} and mark the
14908 rest as read, and expunge them to boot.
14909
14910
14911 @node Global Score Files
14912 @section Global Score Files
14913 @cindex global score files
14914
14915 Sure, other newsreaders have ``global kill files''.  These are usually
14916 nothing more than a single kill file that applies to all groups, stored
14917 in the user's home directory.  Bah!  Puny, weak newsreaders!
14918
14919 What I'm talking about here are Global Score Files.  Score files from
14920 all over the world, from users everywhere, uniting all nations in one
14921 big, happy score file union!  Ange-score!  New and untested!
14922
14923 @vindex gnus-global-score-files
14924 All you have to do to use other people's score files is to set the
14925 @code{gnus-global-score-files} variable.  One entry for each score file,
14926 or each score file directory.  Gnus will decide by itself what score
14927 files are applicable to which group.
14928
14929 Say you want to use the score file
14930 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
14931 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
14932
14933 @lisp
14934 (setq gnus-global-score-files
14935       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
14936         "/ftp@@ftp.some-where:/pub/score/"))
14937 @end lisp
14938
14939 @findex gnus-score-search-global-directories
14940 Simple, eh?  Directory names must end with a @samp{/}.  These
14941 directories are typically scanned only once during each Gnus session.
14942 If you feel the need to manually re-scan the remote directories, you can
14943 use the @code{gnus-score-search-global-directories} command.
14944
14945 Note that, at present, using this option will slow down group entry
14946 somewhat.  (That is---a lot.)
14947
14948 If you want to start maintaining score files for other people to use,
14949 just put your score file up for anonymous ftp and announce it to the
14950 world.  Become a retro-moderator!  Participate in the retro-moderator
14951 wars sure to ensue, where retro-moderators battle it out for the
14952 sympathy of the people, luring them to use their score files on false
14953 premises!  Yay!  The net is saved!
14954
14955 Here are some tips for the would-be retro-moderator, off the top of my
14956 head:
14957
14958 @itemize @bullet
14959
14960 @item
14961 Articles heavily crossposted are probably junk.
14962 @item
14963 To lower a single inappropriate article, lower by @code{Message-ID}.
14964 @item
14965 Particularly brilliant authors can be raised on a permanent basis.
14966 @item
14967 Authors that repeatedly post off-charter for the group can safely be
14968 lowered out of existence.
14969 @item
14970 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
14971 articles completely.
14972
14973 @item
14974 Use expiring score entries to keep the size of the file down.  You
14975 should probably have a long expiry period, though, as some sites keep
14976 old articles for a long time.
14977 @end itemize
14978
14979 ... I wonder whether other newsreaders will support global score files
14980 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
14981 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
14982 holding our breath yet?
14983
14984
14985 @node Kill Files
14986 @section Kill Files
14987 @cindex kill files
14988
14989 Gnus still supports those pesky old kill files.  In fact, the kill file
14990 entries can now be expiring, which is something I wrote before Daniel
14991 Quinlan thought of doing score files, so I've left the code in there.
14992
14993 In short, kill processing is a lot slower (and I do mean @emph{a lot})
14994 than score processing, so it might be a good idea to rewrite your kill
14995 files into score files.
14996
14997 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
14998 forms into this file, which means that you can use kill files as some
14999 sort of primitive hook function to be run on group entry, even though
15000 that isn't a very good idea.
15001
15002 Normal kill files look like this:
15003
15004 @lisp
15005 (gnus-kill "From" "Lars Ingebrigtsen")
15006 (gnus-kill "Subject" "ding")
15007 (gnus-expunge "X")
15008 @end lisp
15009
15010 This will mark every article written by me as read, and remove the
15011 marked articles from the summary buffer.  Very useful, you'll agree.
15012
15013 Other programs use a totally different kill file syntax.  If Gnus
15014 encounters what looks like a @code{rn} kill file, it will take a stab at
15015 interpreting it.
15016
15017 Two summary functions for editing a GNUS kill file:
15018
15019 @table @kbd
15020
15021 @item M-k
15022 @kindex M-k (Summary)
15023 @findex gnus-summary-edit-local-kill
15024 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
15025
15026 @item M-K
15027 @kindex M-K (Summary)
15028 @findex gnus-summary-edit-global-kill
15029 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
15030 @end table
15031
15032 Two group mode functions for editing the kill files:
15033
15034 @table @kbd
15035
15036 @item M-k
15037 @kindex M-k (Group)
15038 @findex gnus-group-edit-local-kill
15039 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
15040
15041 @item M-K
15042 @kindex M-K (Group)
15043 @findex gnus-group-edit-global-kill
15044 Edit the general kill file (@code{gnus-group-edit-global-kill}).
15045 @end table
15046
15047 Kill file variables:
15048
15049 @table @code
15050 @item gnus-kill-file-name
15051 @vindex gnus-kill-file-name
15052 A kill file for the group @samp{soc.motss} is normally called
15053 @file{soc.motss.KILL}.  The suffix appended to the group name to get
15054 this file name is detailed by the @code{gnus-kill-file-name} variable.
15055 The ``global'' kill file (not in the score file sense of ``global'', of
15056 course) is just called @file{KILL}.
15057
15058 @vindex gnus-kill-save-kill-file
15059 @item gnus-kill-save-kill-file
15060 If this variable is non-@code{nil}, Gnus will save the
15061 kill file after processing, which is necessary if you use expiring
15062 kills.
15063
15064 @item gnus-apply-kill-hook
15065 @vindex gnus-apply-kill-hook
15066 @findex gnus-apply-kill-file-unless-scored
15067 @findex gnus-apply-kill-file
15068 A hook called to apply kill files to a group.  It is
15069 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
15070 kill file if you have a score file for the same group, you can set this
15071 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
15072 kill files to be processed, you should set this variable to @code{nil}.
15073
15074 @item gnus-kill-file-mode-hook
15075 @vindex gnus-kill-file-mode-hook
15076 A hook called in kill-file mode buffers.
15077
15078 @end table
15079
15080
15081 @node Converting Kill Files
15082 @section Converting Kill Files
15083 @cindex kill files
15084 @cindex converting kill files
15085
15086 If you have loads of old kill files, you may want to convert them into
15087 score files.  If they are ``regular'', you can use
15088 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
15089 by hand.
15090
15091 The kill to score conversion package isn't included in Gnus by default.
15092 You can fetch it from
15093 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
15094
15095 If your old kill files are very complex---if they contain more
15096 non-@code{gnus-kill} forms than not, you'll have to convert them by
15097 hand.  Or just let them be as they are.  Gnus will still use them as
15098 before.
15099
15100
15101 @node GroupLens
15102 @section GroupLens
15103 @cindex GroupLens
15104
15105 GroupLens is a collaborative filtering system that helps you work
15106 together with other people to find the quality news articles out of the
15107 huge volume of news articles generated every day.
15108
15109 To accomplish this the GroupLens system combines your opinions about
15110 articles you have already read with the opinions of others who have done
15111 likewise and gives you a personalized prediction for each unread news
15112 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
15113 rate articles, and finds other people that rate articles the same way.
15114 Once it has found some people you agree with it tells you, in the form
15115 of a prediction, what they thought of the article.  You can use this
15116 prediction to help you decide whether or not you want to read the
15117 article.
15118
15119 @menu
15120 * Using GroupLens::          How to make Gnus use GroupLens.
15121 * Rating Articles::          Letting GroupLens know how you rate articles.
15122 * Displaying Predictions::   Displaying predictions given by GroupLens.
15123 * GroupLens Variables::      Customizing GroupLens.
15124 @end menu
15125
15126
15127 @node Using GroupLens
15128 @subsection Using GroupLens
15129
15130 To use GroupLens you must register a pseudonym with your local Better
15131 Bit Bureau (BBB).
15132 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
15133 better bit in town at the moment.
15134
15135 Once you have registered you'll need to set a couple of variables.
15136
15137 @table @code
15138
15139 @item gnus-use-grouplens
15140 @vindex gnus-use-grouplens
15141 Setting this variable to a non-@code{nil} value will make Gnus hook into
15142 all the relevant GroupLens functions.
15143
15144 @item grouplens-pseudonym
15145 @vindex grouplens-pseudonym
15146 This variable should be set to the pseudonym you got when registering
15147 with the Better Bit Bureau.
15148
15149 @item grouplens-newsgroups
15150 @vindex grouplens-newsgroups
15151 A list of groups that you want to get GroupLens predictions for.
15152
15153 @end table
15154
15155 That's the minimum of what you need to get up and running with GroupLens.
15156 Once you've registered, GroupLens will start giving you scores for
15157 articles based on the average of what other people think.  But, to get
15158 the real benefit of GroupLens you need to start rating articles
15159 yourself.  Then the scores GroupLens gives you will be personalized for
15160 you, based on how the people you usually agree with have already rated.
15161
15162
15163 @node Rating Articles
15164 @subsection Rating Articles
15165
15166 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
15167 Where 1 means something like this article is a waste of bandwidth and 5
15168 means that the article was really good.  The basic question to ask
15169 yourself is, "on a scale from 1 to 5 would I like to see more articles
15170 like this one?"
15171
15172 There are four ways to enter a rating for an article in GroupLens.
15173
15174 @table @kbd
15175
15176 @item r
15177 @kindex r (GroupLens)
15178 @findex bbb-summary-rate-article
15179 This function will prompt you for a rating on a scale of one to five.
15180
15181 @item k
15182 @kindex k (GroupLens)
15183 @findex grouplens-score-thread
15184 This function will prompt you for a rating, and rate all the articles in
15185 the thread.  This is really useful for some of those long running giant
15186 threads in rec.humor.
15187
15188 @end table
15189
15190 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
15191 the score of the article you're reading.
15192
15193 @table @kbd
15194
15195 @item 1-5 n
15196 @kindex n (GroupLens)
15197 @findex grouplens-next-unread-article
15198 Rate the article and go to the next unread article.
15199
15200 @item 1-5 ,
15201 @kindex , (GroupLens)
15202 @findex grouplens-best-unread-article
15203 Rate the article and go to the next unread article with the highest score.
15204
15205 @end table
15206
15207 If you want to give the current article a score of 4 and then go to the
15208 next article, just type @kbd{4 n}.
15209
15210
15211 @node Displaying Predictions
15212 @subsection Displaying Predictions
15213
15214 GroupLens makes a prediction for you about how much you will like a
15215 news article.  The predictions from GroupLens are on a scale from 1 to
15216 5, where 1 is the worst and 5 is the best.  You can use the predictions
15217 from GroupLens in one of three ways controlled by the variable
15218 @code{gnus-grouplens-override-scoring}.
15219
15220 @vindex gnus-grouplens-override-scoring
15221 There are three ways to display predictions in grouplens.  You may
15222 choose to have the GroupLens scores contribute to, or override the
15223 regular gnus scoring mechanism. override is the default; however, some
15224 people prefer to see the Gnus scores plus the grouplens scores.  To get
15225 the separate scoring behavior you need to set
15226 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
15227 GroupLens predictions combined with the grouplens scores set it to
15228 @code{'override} and to combine the scores set
15229 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
15230 the combine option you will also want to set the values for
15231 @code{grouplens-prediction-offset} and
15232 @code{grouplens-score-scale-factor}.
15233
15234 @vindex grouplens-prediction-display
15235 In either case, GroupLens gives you a few choices for how you would like
15236 to see your predictions displayed.  The display of predictions is
15237 controlled by the @code{grouplens-prediction-display} variable.
15238
15239 The following are valid values for that variable.
15240
15241 @table @code
15242 @item prediction-spot
15243 The higher the prediction, the further to the right an @samp{*} is
15244 displayed.
15245
15246 @item confidence-interval
15247 A numeric confidence interval.
15248
15249 @item prediction-bar
15250 The higher the prediction, the longer the bar.
15251
15252 @item confidence-bar
15253 Numerical confidence.
15254
15255 @item confidence-spot
15256 The spot gets bigger with more confidence.
15257
15258 @item prediction-num
15259 Plain-old numeric value.
15260
15261 @item confidence-plus-minus
15262 Prediction +/- confidence.
15263
15264 @end table
15265
15266
15267 @node GroupLens Variables
15268 @subsection GroupLens Variables
15269
15270 @table @code
15271
15272 @item gnus-summary-grouplens-line-format
15273 The summary line format used in GroupLens-enhanced summary buffers.  It
15274 accepts the same specs as the normal summary line format (@pxref{Summary
15275 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
15276 %s\n}.
15277
15278 @item grouplens-bbb-host
15279 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
15280 default.
15281
15282 @item grouplens-bbb-port
15283 Port of the host running the bbbd server.  The default is 9000.
15284
15285 @item grouplens-score-offset
15286 Offset the prediction by this value.  In other words, subtract the
15287 prediction value by this number to arrive at the effective score.  The
15288 default is 0.
15289
15290 @item grouplens-score-scale-factor
15291 This variable allows the user to magnify the effect of GroupLens scores.
15292 The scale factor is applied after the offset.  The default is 1.
15293
15294 @end table
15295
15296
15297 @node Advanced Scoring
15298 @section Advanced Scoring
15299
15300 Scoring on Subjects and From headers is nice enough, but what if you're
15301 really interested in what a person has to say only when she's talking
15302 about a particular subject?  Or what if you really don't want to
15303 read what person A has to say when she's following up to person B, but
15304 want to read what she says when she's following up to person C?
15305
15306 By using advanced scoring rules you may create arbitrarily complex
15307 scoring patterns.
15308
15309 @menu
15310 * Advanced Scoring Syntax::     A definition.
15311 * Advanced Scoring Examples::   What they look like.
15312 * Advanced Scoring Tips::       Getting the most out of it.
15313 @end menu
15314
15315
15316 @node Advanced Scoring Syntax
15317 @subsection Advanced Scoring Syntax
15318
15319 Ordinary scoring rules have a string as the first element in the rule.
15320 Advanced scoring rules have a list as the first element.  The second
15321 element is the score to be applied if the first element evaluated to a
15322 non-@code{nil} value.
15323
15324 These lists may consist of three logical operators, one redirection
15325 operator, and various match operators.
15326
15327 Logical operators:
15328
15329 @table @code
15330 @item &
15331 @itemx and
15332 This logical operator will evaluate each of its arguments until it finds
15333 one that evaluates to @code{false}, and then it'll stop.  If all arguments
15334 evaluate to @code{true} values, then this operator will return
15335 @code{true}.
15336
15337 @item |
15338 @itemx or
15339 This logical operator will evaluate each of its arguments until it finds
15340 one that evaluates to @code{true}.  If no arguments are @code{true},
15341 then this operator will return @code{false}.
15342
15343 @item !
15344 @itemx not
15345 @itemx Â¬
15346 This logical operator only takes a single argument.  It returns the
15347 logical negation of the value of its argument.
15348
15349 @end table
15350
15351 There is an @dfn{indirection operator} that will make its arguments
15352 apply to the ancestors of the current article being scored.  For
15353 instance, @code{1-} will make score rules apply to the parent of the
15354 current article.  @code{2-} will make score rules apply to the
15355 grandparent of the current article.  Alternatively, you can write
15356 @code{^^}, where the number of @code{^}s (carets) says how far back into
15357 the ancestry you want to go.
15358
15359 Finally, we have the match operators.  These are the ones that do the
15360 real work.  Match operators are header name strings followed by a match
15361 and a match type.  A typical match operator looks like @samp{("from"
15362 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
15363 simple scoring, and the match types are also the same.
15364
15365
15366 @node Advanced Scoring Examples
15367 @subsection Advanced Scoring Examples
15368
15369 Let's say you want to increase the score of articles written by Lars
15370 when he's talking about Gnus:
15371
15372 @example
15373 ((&
15374   ("from" "Lars Ingebrigtsen")
15375   ("subject" "Gnus"))
15376  1000)
15377 @end example
15378
15379 Quite simple, huh?
15380
15381 When he writes long articles, he sometimes has something nice to say:
15382
15383 @example
15384 ((&
15385   ("from" "Lars Ingebrigtsen")
15386   (|
15387    ("subject" "Gnus")
15388    ("lines" 100 >)))
15389  1000)
15390 @end example
15391
15392 However, when he responds to things written by Reig Eigil Logge, you
15393 really don't want to read what he's written:
15394
15395 @example
15396 ((&
15397   ("from" "Lars Ingebrigtsen")
15398   (1- ("from" "Reig Eigir Logge")))
15399  -100000)
15400 @end example
15401
15402 Everybody that follows up Redmondo when he writes about disappearing
15403 socks should have their scores raised, but only when they talk about
15404 white socks.  However, when Lars talks about socks, it's usually not
15405 very interesting:
15406
15407 @example
15408 ((&
15409   (1-
15410    (&
15411     ("from" "redmondo@@.*no" r)
15412     ("body" "disappearing.*socks" t)))
15413   (! ("from" "Lars Ingebrigtsen"))
15414   ("body" "white.*socks"))
15415  1000)
15416 @end example
15417
15418 The possibilities are endless.
15419
15420
15421 @node Advanced Scoring Tips
15422 @subsection Advanced Scoring Tips
15423
15424 The @code{&} and @code{|} logical operators do short-circuit logic.
15425 That is, they stop processing their arguments when it's clear what the
15426 result of the operation will be.  For instance, if one of the arguments
15427 of an @code{&} evaluates to @code{false}, there's no point in evaluating
15428 the rest of the arguments.  This means that you should put slow matches
15429 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
15430 @samp{subject}) first.
15431
15432 The indirection arguments (@code{1-} and so on) will make their
15433 arguments work on previous generations of the thread.  If you say
15434 something like:
15435
15436 @example
15437 ...
15438 (1-
15439  (1-
15440   ("from" "lars")))
15441 ...
15442 @end example
15443
15444 Then that means "score on the from header of the grandparent of the
15445 current article".  An indirection is quite fast, but it's better to say:
15446
15447 @example
15448 (1-
15449  (&
15450   ("from" "Lars")
15451   ("subject" "Gnus")))
15452 @end example
15453
15454 than it is to say:
15455
15456 @example
15457 (&
15458  (1- ("from" "Lars"))
15459  (1- ("subject" "Gnus")))
15460 @end example
15461
15462
15463 @node Score Decays
15464 @section Score Decays
15465 @cindex score decays
15466 @cindex decays
15467
15468 You may find that your scores have a tendency to grow without
15469 bounds, especially if you're using adaptive scoring.  If scores get too
15470 big, they lose all meaning---they simply max out and it's difficult to
15471 use them in any sensible way.
15472
15473 @vindex gnus-decay-scores
15474 @findex gnus-decay-score
15475 @vindex gnus-decay-score-function
15476 Gnus provides a mechanism for decaying scores to help with this problem.
15477 When score files are loaded and @code{gnus-decay-scores} is
15478 non-@code{nil}, Gnus will run the score files through the decaying
15479 mechanism thereby lowering the scores of all non-permanent score rules.
15480 The decay itself if performed by the @code{gnus-decay-score-function}
15481 function, which is @code{gnus-decay-score} by default.  Here's the
15482 definition of that function:
15483
15484 @lisp
15485 (defun gnus-decay-score (score)
15486   "Decay SCORE.
15487 This is done according to `gnus-score-decay-constant'
15488 and `gnus-score-decay-scale'."
15489   (floor
15490    (- score
15491       (* (if (< score 0) 1 -1)
15492          (min (abs score)
15493               (max gnus-score-decay-constant
15494                    (* (abs score)
15495                       gnus-score-decay-scale)))))))
15496 @end lisp
15497
15498 @vindex gnus-score-decay-scale
15499 @vindex gnus-score-decay-constant
15500 @code{gnus-score-decay-constant} is 3 by default and
15501 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
15502
15503 @enumerate
15504 @item
15505 Scores between -3 and 3 will be set to 0 when this function is called.
15506
15507 @item
15508 Scores with magnitudes between 3 and 60 will be shrunk by 3.
15509
15510 @item
15511 Scores with magnitudes greater than 60 will be shrunk by 5% of the
15512 score.
15513 @end enumerate
15514
15515 If you don't like this decay function, write your own.  It is called
15516 with the score to be decayed as its only parameter, and it should return
15517 the new score, which should be an integer.
15518
15519 Gnus will try to decay scores once a day.  If you haven't run Gnus for
15520 four days, Gnus will decay the scores four times, for instance.
15521
15522
15523 @node Various
15524 @chapter Various
15525
15526 @menu
15527 * Process/Prefix::             A convention used by many treatment commands.
15528 * Interactive::                Making Gnus ask you many questions.
15529 * Symbolic Prefixes::          How to supply some Gnus functions with options.
15530 * Formatting Variables::       You can specify what buffers should look like.
15531 * Windows Configuration::      Configuring the Gnus buffer windows.
15532 * Faces and Fonts::            How to change how faces look.
15533 * Compilation::                How to speed Gnus up.
15534 * Mode Lines::                 Displaying information in the mode lines.
15535 * Highlighting and Menus::     Making buffers look all nice and cozy.
15536 * Buttons::                    Get tendonitis in ten easy steps!
15537 * Daemons::                    Gnus can do things behind your back.
15538 * NoCeM::                      How to avoid spam and other fatty foods.
15539 * Undo::                       Some actions can be undone.
15540 * Moderation::                 What to do if you're a moderator.
15541 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
15542 * Fuzzy Matching::             What's the big fuzz?
15543 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
15544 * Various Various::            Things that are really various.
15545 @end menu
15546
15547
15548 @node Process/Prefix
15549 @section Process/Prefix
15550 @cindex process/prefix convention
15551
15552 Many functions, among them functions for moving, decoding and saving
15553 articles, use what is known as the @dfn{Process/Prefix convention}.
15554
15555 This is a method for figuring out what articles the user wants the
15556 command to be performed on.
15557
15558 It goes like this:
15559
15560 If the numeric prefix is N, perform the operation on the next N
15561 articles, starting with the current one.  If the numeric prefix is
15562 negative, perform the operation on the previous N articles, starting
15563 with the current one.
15564
15565 @vindex transient-mark-mode
15566 If @code{transient-mark-mode} in non-@code{nil} and the region is
15567 active, all articles in the region will be worked upon.
15568
15569 If there is no numeric prefix, but some articles are marked with the
15570 process mark, perform the operation on the articles marked with
15571 the process mark.
15572
15573 If there is neither a numeric prefix nor any articles marked with the
15574 process mark, just perform the operation on the current article.
15575
15576 Quite simple, really, but it needs to be made clear so that surprises
15577 are avoided.
15578
15579 Commands that react to the process mark will push the current list of
15580 process marked articles onto a stack and will then clear all process
15581 marked articles.  You can restore the previous configuration with the
15582 @kbd{M P y} command (@pxref{Setting Process Marks}).
15583
15584 @vindex gnus-summary-goto-unread
15585 One thing that seems to shock & horrify lots of people is that, for
15586 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
15587 Since each @kbd{d} (which marks the current article as read) by default
15588 goes to the next unread article after marking, this means that @kbd{3 d}
15589 will mark the next three unread articles as read, no matter what the
15590 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
15591 @code{nil} for a more straightforward action.
15592
15593
15594 @node Interactive
15595 @section Interactive
15596 @cindex interaction
15597
15598 @table @code
15599
15600 @item gnus-novice-user
15601 @vindex gnus-novice-user
15602 If this variable is non-@code{nil}, you are either a newcomer to the
15603 World of Usenet, or you are very cautious, which is a nice thing to be,
15604 really.  You will be given questions of the type ``Are you sure you want
15605 to do this?'' before doing anything dangerous.  This is @code{t} by
15606 default.
15607
15608 @item gnus-expert-user
15609 @vindex gnus-expert-user
15610 If this variable is non-@code{nil}, you will seldom be asked any
15611 questions by Gnus.  It will simply assume you know what you're doing, no
15612 matter how strange.
15613
15614 @item gnus-interactive-catchup
15615 @vindex gnus-interactive-catchup
15616 Require confirmation before catching up a group if non-@code{nil}.  It
15617 is @code{t} by default.
15618
15619 @item gnus-interactive-exit
15620 @vindex gnus-interactive-exit
15621 Require confirmation before exiting Gnus.  This variable is @code{t} by
15622 default.
15623 @end table
15624
15625
15626 @node Symbolic Prefixes
15627 @section Symbolic Prefixes
15628 @cindex symbolic prefixes
15629
15630 Quite a lot of Emacs commands react to the (numeric) prefix.  For
15631 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
15632 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
15633 rule of 900 to the current article.
15634
15635 This is all nice and well, but what if you want to give a command some
15636 additional information?  Well, what most commands do is interpret the
15637 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
15638 doesn't want a backup file to be created when saving the current buffer,
15639 for instance.  But what if you want to save without making a backup
15640 file, and you want Emacs to flash lights and play a nice tune at the
15641 same time?  You can't, and you're probably perfectly happy that way.
15642
15643 @kindex M-i (Summary)
15644 @findex gnus-symbolic-argument
15645 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
15646 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
15647 character typed in is the value.  You can stack as many @kbd{M-i}
15648 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
15649 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
15650 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
15651 @code{b}''.  You get the drift.
15652
15653 Typing in symbolic prefixes to commands that don't accept them doesn't
15654 hurt, but it doesn't do any good either.  Currently not many Gnus
15655 functions make use of the symbolic prefix.
15656
15657 If you're interested in how Gnus implements this, @pxref{Extended
15658 Interactive}.
15659
15660
15661 @node Formatting Variables
15662 @section Formatting Variables
15663 @cindex formatting variables
15664
15665 Throughout this manual you've probably noticed lots of variables called
15666 things like @code{gnus-group-line-format} and
15667 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
15668 output lines in the various buffers.  There's quite a lot of them.
15669 Fortunately, they all use the same syntax, so there's not that much to
15670 be annoyed by.
15671
15672 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
15673 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
15674 lots of percentages everywhere.
15675
15676 @menu
15677 * Formatting Basics::     A formatting variable is basically a format string.
15678 * Mode Line Formatting::  Some rules about mode line formatting variables.
15679 * Advanced Formatting::   Modifying output in various ways.
15680 * User-Defined Specs::    Having Gnus call your own functions.
15681 * Formatting Fonts::      Making the formatting look colorful and nice.
15682 @end menu
15683
15684 Currently Gnus uses the following formatting variables:
15685 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
15686 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
15687 @code{gnus-group-mode-line-format},
15688 @code{gnus-summary-mode-line-format},
15689 @code{gnus-article-mode-line-format},
15690 @code{gnus-server-mode-line-format}, and
15691 @code{gnus-summary-pick-line-format}.
15692
15693 All these format variables can also be arbitrary elisp forms.  In that
15694 case, they will be @code{eval}ed to insert the required lines.
15695
15696 @kindex M-x gnus-update-format
15697 @findex gnus-update-format
15698 Gnus includes a command to help you while creating your own format
15699 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
15700 update the spec in question and pop you to a buffer where you can
15701 examine the resulting lisp code to be run to generate the line.
15702
15703
15704
15705 @node Formatting Basics
15706 @subsection Formatting Basics
15707
15708 Each @samp{%} element will be replaced by some string or other when the
15709 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
15710 spec, and pad with spaces to get a 5-character field''.
15711
15712 As with normal C and Emacs Lisp formatting strings, the numerical
15713 modifier between the @samp{%} and the formatting type character will
15714 @dfn{pad} the output so that it is always at least that long.
15715 @samp{%5y} will make the field always (at least) five characters wide by
15716 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
15717 the right instead.
15718
15719 You may also wish to limit the length of the field to protect against
15720 particularly wide values.  For that you can say @samp{%4,6y}, which
15721 means that the field will never be more than 6 characters wide and never
15722 less than 4 characters wide.
15723
15724
15725 @node Mode Line Formatting
15726 @subsection Mode Line Formatting
15727
15728 Mode line formatting variables (e.g.,
15729 @code{gnus-summary-mode-line-format}) follow the same rules as other,
15730 buffer line oriented formatting variables (@pxref{Formatting Basics})
15731 with the following two differences:
15732
15733 @enumerate
15734
15735 @item
15736 There must be no newline (@samp{\n}) at the end.
15737
15738 @item
15739 The special @samp{%%b} spec can be used to display the buffer name.
15740 Well, it's no spec at all, really---@samp{%%} is just a way to quote
15741 @samp{%} to allow it to pass through the formatting machinery unmangled,
15742 so that Emacs receives @samp{%b}, which is something the Emacs mode line
15743 display interprets to mean ``show the buffer name''.  For a full list of
15744 mode line specs Emacs understands, see the documentation of the
15745 @code{mode-line-format} variable.
15746
15747 @end enumerate
15748
15749
15750 @node Advanced Formatting
15751 @subsection Advanced Formatting
15752
15753 It is frequently useful to post-process the fields in some way.
15754 Padding, limiting, cutting off parts and suppressing certain values can
15755 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
15756 look like @samp{%~(cut 3)~(ignore "0")y}.
15757
15758 These are the valid modifiers:
15759
15760 @table @code
15761 @item pad
15762 @itemx pad-left
15763 Pad the field to the left with spaces until it reaches the required
15764 length.
15765
15766 @item pad-right
15767 Pad the field to the right with spaces until it reaches the required
15768 length.
15769
15770 @item max
15771 @itemx max-left
15772 Cut off characters from the left until it reaches the specified length.
15773
15774 @item max-right
15775 Cut off characters from the right until it reaches the specified
15776 length.
15777
15778 @item cut
15779 @itemx cut-left
15780 Cut off the specified number of characters from the left.
15781
15782 @item cut-right
15783 Cut off the specified number of characters from the right.
15784
15785 @item ignore
15786 Return an empty string if the field is equal to the specified value.
15787
15788 @item form
15789 Use the specified form as the field value when the @samp{@@} spec is
15790 used.
15791 @end table
15792
15793 Let's take an example.  The @samp{%o} spec in the summary mode lines
15794 will return a date in compact ISO8601 format---@samp{19960809T230410}.
15795 This is quite a mouthful, so we want to shave off the century number and
15796 the time, leaving us with a six-character date.  That would be
15797 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
15798 maxing, and we need the padding to ensure that the date is never less
15799 than 6 characters to make it look nice in columns.)
15800
15801 Ignoring is done first; then cutting; then maxing; and then as the very
15802 last operation, padding.
15803
15804 If you use lots of these advanced thingies, you'll find that Gnus gets
15805 quite slow.  This can be helped enormously by running @kbd{M-x
15806 gnus-compile} when you are satisfied with the look of your lines.
15807 @xref{Compilation}.
15808
15809
15810 @node User-Defined Specs
15811 @subsection User-Defined Specs
15812
15813 All the specs allow for inserting user defined specifiers---@samp{u}.
15814 The next character in the format string should be a letter.  Gnus
15815 will call the function @code{gnus-user-format-function-}@samp{X}, where
15816 @samp{X} is the letter following @samp{%u}.  The function will be passed
15817 a single parameter---what the parameter means depends on what buffer
15818 it's being called from.  The function should return a string, which will
15819 be inserted into the buffer just like information from any other
15820 specifier.  This function may also be called with dummy values, so it
15821 should protect against that.
15822
15823 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
15824 much the same without defining new functions.  Here's an example:
15825 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
15826 given here will be evaluated to yield the current line number, and then
15827 inserted.
15828
15829
15830 @node Formatting Fonts
15831 @subsection Formatting Fonts
15832
15833 There are specs for highlighting, and these are shared by all the format
15834 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
15835 the special @code{mouse-face} property set, which means that it will be
15836 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
15837 over it.
15838
15839 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
15840 normal faces set using @code{gnus-face-0}, which is @code{bold} by
15841 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
15842 and so on.  Create as many faces as you wish.  The same goes for the
15843 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
15844 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
15845
15846 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
15847 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
15848 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
15849 @code{gnus-balloon-face-*} variables should be either strings or
15850 symbols naming functions that return a string. Under @code{balloon-help-mode},
15851 when the mouse passes over text with this property set, a balloon window
15852 will appear and display the string. Please refer to the doc string of
15853 @code{balloon-help-mode} for more information on this.
15854
15855 Here's an alternative recipe for the group buffer:
15856
15857 @lisp
15858 ;; Create three face types.
15859 (setq gnus-face-1 'bold)
15860 (setq gnus-face-3 'italic)
15861
15862 ;; We want the article count to be in
15863 ;; a bold and green face.  So we create
15864 ;; a new face called `my-green-bold'.
15865 (copy-face 'bold 'my-green-bold)
15866 ;; Set the color.
15867 (set-face-foreground 'my-green-bold "ForestGreen")
15868 (setq gnus-face-2 'my-green-bold)
15869
15870 ;; Set the new & fancy format.
15871 (setq gnus-group-line-format
15872       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
15873 @end lisp
15874
15875 I'm sure you'll be able to use this scheme to create totally unreadable
15876 and extremely vulgar displays.  Have fun!
15877
15878 Note that the @samp{%(} specs (and friends) do not make any sense on the
15879 mode-line variables.
15880
15881
15882 @node Windows Configuration
15883 @section Windows Configuration
15884 @cindex windows configuration
15885
15886 No, there's nothing here about X, so be quiet.
15887
15888 @vindex gnus-use-full-window
15889 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
15890 other windows and occupy the entire Emacs screen by itself.  It is
15891 @code{t} by default.
15892
15893 Setting this variable to @code{nil} kinda works, but there are
15894 glitches.  Use at your own peril.
15895
15896 @vindex gnus-buffer-configuration
15897 @code{gnus-buffer-configuration} describes how much space each Gnus
15898 buffer should be given.  Here's an excerpt of this variable:
15899
15900 @lisp
15901 ((group (vertical 1.0 (group 1.0 point)
15902                       (if gnus-carpal (group-carpal 4))))
15903  (article (vertical 1.0 (summary 0.25 point)
15904                         (article 1.0))))
15905 @end lisp
15906
15907 This is an alist.  The @dfn{key} is a symbol that names some action or
15908 other.  For instance, when displaying the group buffer, the window
15909 configuration function will use @code{group} as the key.  A full list of
15910 possible names is listed below.
15911
15912 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
15913 should occupy.  To take the @code{article} split as an example -
15914
15915 @lisp
15916 (article (vertical 1.0 (summary 0.25 point)
15917                        (article 1.0)))
15918 @end lisp
15919
15920 This @dfn{split} says that the summary buffer should occupy 25% of upper
15921 half of the screen, and that it is placed over the article buffer.  As
15922 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
15923 reaching for that calculator there).  However, the special number
15924 @code{1.0} is used to signal that this buffer should soak up all the
15925 rest of the space available after the rest of the buffers have taken
15926 whatever they need.  There should be only one buffer with the @code{1.0}
15927 size spec per split.
15928
15929 Point will be put in the buffer that has the optional third element
15930 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
15931 split where the tag @code{frame-focus} is a member (i.e. is the third or
15932 fourth element in the list, depending on whether the @code{point} tag is
15933 present) gets focus.
15934
15935 Here's a more complicated example:
15936
15937 @lisp
15938 (article (vertical 1.0 (group 4)
15939                        (summary 0.25 point)
15940                        (if gnus-carpal (summary-carpal 4))
15941                        (article 1.0)))
15942 @end lisp
15943
15944 If the size spec is an integer instead of a floating point number,
15945 then that number will be used to say how many lines a buffer should
15946 occupy, not a percentage.
15947
15948 If the @dfn{split} looks like something that can be @code{eval}ed (to be
15949 precise---if the @code{car} of the split is a function or a subr), this
15950 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
15951 be used as a split.  This means that there will be three buffers if
15952 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
15953 is non-@code{nil}.
15954
15955 Not complicated enough for you?  Well, try this on for size:
15956
15957 @lisp
15958 (article (horizontal 1.0
15959              (vertical 0.5
15960                  (group 1.0)
15961                  (gnus-carpal 4))
15962              (vertical 1.0
15963                  (summary 0.25 point)
15964                  (summary-carpal 4)
15965                  (article 1.0))))
15966 @end lisp
15967
15968 Whoops.  Two buffers with the mystery 100% tag.  And what's that
15969 @code{horizontal} thingie?
15970
15971 If the first element in one of the split is @code{horizontal}, Gnus will
15972 split the window horizontally, giving you two windows side-by-side.
15973 Inside each of these strips you may carry on all you like in the normal
15974 fashion.  The number following @code{horizontal} says what percentage of
15975 the screen is to be given to this strip.
15976
15977 For each split, there @emph{must} be one element that has the 100% tag.
15978 The splitting is never accurate, and this buffer will eat any leftover
15979 lines from the splits.
15980
15981 To be slightly more formal, here's a definition of what a valid split
15982 may look like:
15983
15984 @example
15985 split       = frame | horizontal | vertical | buffer | form
15986 frame       = "(frame " size *split ")"
15987 horizontal  = "(horizontal " size *split ")"
15988 vertical    = "(vertical " size *split ")"
15989 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
15990 size        = number | frame-params
15991 buffer-name = group | article | summary ...
15992 @end example
15993
15994 The limitations are that the @code{frame} split can only appear as the
15995 top-level split.  @var{form} should be an Emacs Lisp form that should
15996 return a valid split.  We see that each split is fully recursive, and
15997 may contain any number of @code{vertical} and @code{horizontal} splits.
15998
15999 @vindex gnus-window-min-width
16000 @vindex gnus-window-min-height
16001 @cindex window height
16002 @cindex window width
16003 Finding the right sizes can be a bit complicated.  No window may be less
16004 than @code{gnus-window-min-height} (default 1) characters high, and all
16005 windows must be at least @code{gnus-window-min-width} (default 1)
16006 characters wide.  Gnus will try to enforce this before applying the
16007 splits.  If you want to use the normal Emacs window width/height limit,
16008 you can just set these two variables to @code{nil}.
16009
16010 If you're not familiar with Emacs terminology, @code{horizontal} and
16011 @code{vertical} splits may work the opposite way of what you'd expect.
16012 Windows inside a @code{horizontal} split are shown side-by-side, and
16013 windows within a @code{vertical} split are shown above each other.
16014
16015 @findex gnus-configure-frame
16016 If you want to experiment with window placement, a good tip is to call
16017 @code{gnus-configure-frame} directly with a split.  This is the function
16018 that does all the real work when splitting buffers.  Below is a pretty
16019 nonsensical configuration with 5 windows; two for the group buffer and
16020 three for the article buffer.  (I said it was nonsensical.)  If you
16021 @code{eval} the statement below, you can get an idea of how that would
16022 look straight away, without going through the normal Gnus channels.
16023 Play with it until you're satisfied, and then use
16024 @code{gnus-add-configuration} to add your new creation to the buffer
16025 configuration list.
16026
16027 @lisp
16028 (gnus-configure-frame
16029  '(horizontal 1.0
16030     (vertical 10
16031       (group 1.0)
16032       (article 0.3 point))
16033     (vertical 1.0
16034       (article 1.0)
16035       (horizontal 4
16036         (group 1.0)
16037         (article 10)))))
16038 @end lisp
16039
16040 You might want to have several frames as well.  No prob---just use the
16041 @code{frame} split:
16042
16043 @lisp
16044 (gnus-configure-frame
16045  '(frame 1.0
16046          (vertical 1.0
16047                    (summary 0.25 point frame-focus)
16048                    (article 1.0))
16049          (vertical ((height . 5) (width . 15)
16050                     (user-position . t)
16051                     (left . -1) (top . 1))
16052                    (picon 1.0))))
16053
16054 @end lisp
16055
16056 This split will result in the familiar summary/article window
16057 configuration in the first (or ``main'') frame, while a small additional
16058 frame will be created where picons will be shown.  As you can see,
16059 instead of the normal @code{1.0} top-level spec, each additional split
16060 should have a frame parameter alist as the size spec.
16061 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
16062 Reference Manual}.  Under XEmacs, a frame property list will be
16063 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
16064 is such a plist.
16065 The list of all possible keys for @code{gnus-buffer-configuration} can
16066 be found in its default value.
16067
16068 Note that the @code{message} key is used for both
16069 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
16070 it is desirable to distinguish between the two, something like this
16071 might be used:
16072
16073 @lisp
16074 (message (horizontal 1.0
16075                      (vertical 1.0 (message 1.0 point))
16076                      (vertical 0.24
16077                                (if (buffer-live-p gnus-summary-buffer)
16078                                    '(summary 0.5))
16079                                (group 1.0)))))
16080 @end lisp
16081
16082 One common desire for a multiple frame split is to have a separate frame
16083 for composing mail and news while leaving the original frame intact.  To
16084 accomplish that, something like the following can be done:
16085
16086 @lisp
16087 (message (frame 1.0
16088                 (if (not (buffer-live-p gnus-summary-buffer))
16089                     (car (cdr (assoc 'group gnus-buffer-configuration)))
16090                   (car (cdr (assoc 'summary gnus-buffer-configuration))))
16091                 (vertical ((user-position . t) (top . 1) (left . 1)
16092                            (name . "Message"))
16093                           (message 1.0 point))))
16094 @end lisp
16095
16096 @findex gnus-add-configuration
16097 Since the @code{gnus-buffer-configuration} variable is so long and
16098 complicated, there's a function you can use to ease changing the config
16099 of a single setting: @code{gnus-add-configuration}.  If, for instance,
16100 you want to change the @code{article} setting, you could say:
16101
16102 @lisp
16103 (gnus-add-configuration
16104  '(article (vertical 1.0
16105                (group 4)
16106                (summary .25 point)
16107                (article 1.0))))
16108 @end lisp
16109
16110 You'd typically stick these @code{gnus-add-configuration} calls in your
16111 @file{.gnus.el} file or in some startup hook---they should be run after
16112 Gnus has been loaded.
16113
16114 @vindex gnus-always-force-window-configuration
16115 If all windows mentioned in the configuration are already visible, Gnus
16116 won't change the window configuration.  If you always want to force the
16117 ``right'' window configuration, you can set
16118 @code{gnus-always-force-window-configuration} to non-@code{nil}.
16119
16120 If you're using tree displays (@pxref{Tree Display}), and the tree
16121 window is displayed vertically next to another window, you may also want
16122 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
16123 windows resized.
16124
16125
16126 @node Faces and Fonts
16127 @section Faces and Fonts
16128 @cindex faces
16129 @cindex fonts
16130 @cindex colors
16131
16132 Fiddling with fonts and faces used to be very difficult, but these days
16133 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
16134 the face you want to alter, and alter it via the standard Customize
16135 interface.
16136
16137
16138 @node Compilation
16139 @section Compilation
16140 @cindex compilation
16141 @cindex byte-compilation
16142
16143 @findex gnus-compile
16144
16145 Remember all those line format specification variables?
16146 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
16147 on.  Now, Gnus will of course heed whatever these variables are, but,
16148 unfortunately, changing them will mean a quite significant slow-down.
16149 (The default values of these variables have byte-compiled functions
16150 associated with them, while the user-generated versions do not, of
16151 course.)
16152
16153 To help with this, you can run @kbd{M-x gnus-compile} after you've
16154 fiddled around with the variables and feel that you're (kind of)
16155 satisfied.  This will result in the new specs being byte-compiled, and
16156 you'll get top speed again.  Gnus will save these compiled specs in the
16157 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
16158 this function, though---you should compile them yourself by sticking
16159 them into the @code{.gnus.el} file and byte-compiling that file.)
16160
16161
16162 @node Mode Lines
16163 @section Mode Lines
16164 @cindex mode lines
16165
16166 @vindex gnus-updated-mode-lines
16167 @code{gnus-updated-mode-lines} says what buffers should keep their mode
16168 lines updated.  It is a list of symbols.  Supported symbols include
16169 @code{group}, @code{article}, @code{summary}, @code{server},
16170 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
16171 Gnus will keep that mode line updated with information that may be
16172 pertinent.  If this variable is @code{nil}, screen refresh may be
16173 quicker.
16174
16175 @cindex display-time
16176
16177 @vindex gnus-mode-non-string-length
16178 By default, Gnus displays information on the current article in the mode
16179 lines of the summary and article buffers.  The information Gnus wishes
16180 to display (e.g. the subject of the article) is often longer than the
16181 mode lines, and therefore have to be cut off at some point.  The
16182 @code{gnus-mode-non-string-length} variable says how long the other
16183 elements on the line is (i.e., the non-info part).  If you put
16184 additional elements on the mode line (e.g. a clock), you should modify
16185 this variable:
16186
16187 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
16188 @lisp
16189 (add-hook 'display-time-hook
16190           (lambda () (setq gnus-mode-non-string-length
16191                            (+ 21
16192                               (if line-number-mode 5 0)
16193                               (if column-number-mode 4 0)
16194                               (length display-time-string)))))
16195 @end lisp
16196
16197 If this variable is @code{nil} (which is the default), the mode line
16198 strings won't be chopped off, and they won't be padded either.  Note
16199 that the default is unlikely to be desirable, as even the percentage
16200 complete in the buffer may be crowded off the mode line; the user should
16201 configure this variable appropriately for her configuration.
16202
16203
16204 @node Highlighting and Menus
16205 @section Highlighting and Menus
16206 @cindex visual
16207 @cindex highlighting
16208 @cindex menus
16209
16210 @vindex gnus-visual
16211 The @code{gnus-visual} variable controls most of the Gnus-prettifying
16212 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
16213 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
16214 file.
16215
16216 This variable can be a list of visual properties that are enabled.  The
16217 following elements are valid, and are all included by default:
16218
16219 @table @code
16220 @item group-highlight
16221 Do highlights in the group buffer.
16222 @item summary-highlight
16223 Do highlights in the summary buffer.
16224 @item article-highlight
16225 Do highlights in the article buffer.
16226 @item highlight
16227 Turn on highlighting in all buffers.
16228 @item group-menu
16229 Create menus in the group buffer.
16230 @item summary-menu
16231 Create menus in the summary buffers.
16232 @item article-menu
16233 Create menus in the article buffer.
16234 @item browse-menu
16235 Create menus in the browse buffer.
16236 @item server-menu
16237 Create menus in the server buffer.
16238 @item score-menu
16239 Create menus in the score buffers.
16240 @item menu
16241 Create menus in all buffers.
16242 @end table
16243
16244 So if you only want highlighting in the article buffer and menus in all
16245 buffers, you could say something like:
16246
16247 @lisp
16248 (setq gnus-visual '(article-highlight menu))
16249 @end lisp
16250
16251 If you want highlighting only and no menus whatsoever, you'd say:
16252
16253 @lisp
16254 (setq gnus-visual '(highlight))
16255 @end lisp
16256
16257 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
16258 in all Gnus buffers.
16259
16260 Other general variables that influence the look of all buffers include:
16261
16262 @table @code
16263 @item gnus-mouse-face
16264 @vindex gnus-mouse-face
16265 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
16266 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
16267
16268 @end table
16269
16270 There are hooks associated with the creation of all the different menus:
16271
16272 @table @code
16273
16274 @item gnus-article-menu-hook
16275 @vindex gnus-article-menu-hook
16276 Hook called after creating the article mode menu.
16277
16278 @item gnus-group-menu-hook
16279 @vindex gnus-group-menu-hook
16280 Hook called after creating the group mode menu.
16281
16282 @item gnus-summary-menu-hook
16283 @vindex gnus-summary-menu-hook
16284 Hook called after creating the summary mode menu.
16285
16286 @item gnus-server-menu-hook
16287 @vindex gnus-server-menu-hook
16288 Hook called after creating the server mode menu.
16289
16290 @item gnus-browse-menu-hook
16291 @vindex gnus-browse-menu-hook
16292 Hook called after creating the browse mode menu.
16293
16294 @item gnus-score-menu-hook
16295 @vindex gnus-score-menu-hook
16296 Hook called after creating the score mode menu.
16297
16298 @end table
16299
16300
16301 @node Buttons
16302 @section Buttons
16303 @cindex buttons
16304 @cindex mouse
16305 @cindex click
16306
16307 Those new-fangled @dfn{mouse} contraptions is very popular with the
16308 young, hep kids who don't want to learn the proper way to do things
16309 these days.  Why, I remember way back in the summer of '89, when I was
16310 using Emacs on a Tops 20 system.  Three hundred users on one single
16311 machine, and every user was running Simula compilers.  Bah!
16312
16313 Right.
16314
16315 @vindex gnus-carpal
16316 Well, you can make Gnus display bufferfuls of buttons you can click to
16317 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
16318 really.  Tell the chiropractor I sent you.
16319
16320
16321 @table @code
16322
16323 @item gnus-carpal-mode-hook
16324 @vindex gnus-carpal-mode-hook
16325 Hook run in all carpal mode buffers.
16326
16327 @item gnus-carpal-button-face
16328 @vindex gnus-carpal-button-face
16329 Face used on buttons.
16330
16331 @item gnus-carpal-header-face
16332 @vindex gnus-carpal-header-face
16333 Face used on carpal buffer headers.
16334
16335 @item gnus-carpal-group-buffer-buttons
16336 @vindex gnus-carpal-group-buffer-buttons
16337 Buttons in the group buffer.
16338
16339 @item gnus-carpal-summary-buffer-buttons
16340 @vindex gnus-carpal-summary-buffer-buttons
16341 Buttons in the summary buffer.
16342
16343 @item gnus-carpal-server-buffer-buttons
16344 @vindex gnus-carpal-server-buffer-buttons
16345 Buttons in the server buffer.
16346
16347 @item gnus-carpal-browse-buffer-buttons
16348 @vindex gnus-carpal-browse-buffer-buttons
16349 Buttons in the browse buffer.
16350 @end table
16351
16352 All the @code{buttons} variables are lists.  The elements in these list
16353 are either cons cells where the @code{car} contains a text to be displayed and
16354 the @code{cdr} contains a function symbol, or a simple string.
16355
16356
16357 @node Daemons
16358 @section Daemons
16359 @cindex demons
16360 @cindex daemons
16361
16362 Gnus, being larger than any program ever written (allegedly), does lots
16363 of strange stuff that you may wish to have done while you're not
16364 present.  For instance, you may want it to check for new mail once in a
16365 while.  Or you may want it to close down all connections to all servers
16366 when you leave Emacs idle.  And stuff like that.
16367
16368 Gnus will let you do stuff like that by defining various
16369 @dfn{handlers}.  Each handler consists of three elements:  A
16370 @var{function}, a @var{time}, and an @var{idle} parameter.
16371
16372 Here's an example of a handler that closes connections when Emacs has
16373 been idle for thirty minutes:
16374
16375 @lisp
16376 (gnus-demon-close-connections nil 30)
16377 @end lisp
16378
16379 Here's a handler that scans for PGP headers every hour when Emacs is
16380 idle:
16381
16382 @lisp
16383 (gnus-demon-scan-pgp 60 t)
16384 @end lisp
16385
16386 This @var{time} parameter and than @var{idle} parameter work together
16387 in a strange, but wonderful fashion.  Basically, if @var{idle} is
16388 @code{nil}, then the function will be called every @var{time} minutes.
16389
16390 If @var{idle} is @code{t}, then the function will be called after
16391 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
16392 the function will never be called.  But once Emacs goes idle, the
16393 function will be called every @var{time} minutes.
16394
16395 If @var{idle} is a number and @var{time} is a number, the function will
16396 be called every @var{time} minutes only when Emacs has been idle for
16397 @var{idle} minutes.
16398
16399 If @var{idle} is a number and @var{time} is @code{nil}, the function
16400 will be called once every time Emacs has been idle for @var{idle}
16401 minutes.
16402
16403 And if @var{time} is a string, it should look like @samp{07:31}, and
16404 the function will then be called once every day somewhere near that
16405 time.  Modified by the @var{idle} parameter, of course.
16406
16407 @vindex gnus-demon-timestep
16408 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
16409 seconds.  This is 60 by default.  If you change that variable,
16410 all the timings in the handlers will be affected.)
16411
16412 So, if you want to add a handler, you could put something like this in
16413 your @file{.gnus} file:
16414
16415 @findex gnus-demon-add-handler
16416 @lisp
16417 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
16418 @end lisp
16419
16420 @findex gnus-demon-add-nocem
16421 @findex gnus-demon-add-scanmail
16422 @findex gnus-demon-add-rescan
16423 @findex gnus-demon-add-scan-timestamps
16424 @findex gnus-demon-add-disconnection
16425 Some ready-made functions to do this have been created:
16426 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
16427 @code{gnus-demon-add-nntp-close-connection},
16428 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
16429 @code{gnus-demon-add-scanmail}.  Just put those functions in your
16430 @file{.gnus} if you want those abilities.
16431
16432 @findex gnus-demon-init
16433 @findex gnus-demon-cancel
16434 @vindex gnus-demon-handlers
16435 If you add handlers to @code{gnus-demon-handlers} directly, you should
16436 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
16437 daemons, you can use the @code{gnus-demon-cancel} function.
16438
16439 Note that adding daemons can be pretty naughty if you over do it.  Adding
16440 functions that scan all news and mail from all servers every two seconds
16441 is a sure-fire way of getting booted off any respectable system.  So
16442 behave.
16443
16444
16445 @node NoCeM
16446 @section NoCeM
16447 @cindex nocem
16448 @cindex spam
16449
16450 @dfn{Spamming} is posting the same article lots and lots of times.
16451 Spamming is bad.  Spamming is evil.
16452
16453 Spamming is usually canceled within a day or so by various anti-spamming
16454 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
16455 NoCeM is pronounced ``no see-'em'', and means what the name
16456 implies---these are messages that make the offending articles, like, go
16457 away.
16458
16459 What use are these NoCeM messages if the articles are canceled anyway?
16460 Some sites do not honor cancel messages and some sites just honor cancels
16461 from a select few people.  Then you may wish to make use of the NoCeM
16462 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
16463
16464 Gnus can read and parse the messages in this group automatically, and
16465 this will make spam disappear.
16466
16467 There are some variables to customize, of course:
16468
16469 @table @code
16470 @item gnus-use-nocem
16471 @vindex gnus-use-nocem
16472 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
16473 by default.
16474
16475 @item gnus-nocem-groups
16476 @vindex gnus-nocem-groups
16477 Gnus will look for NoCeM messages in the groups in this list.  The
16478 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
16479 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
16480
16481 @item gnus-nocem-issuers
16482 @vindex gnus-nocem-issuers
16483 There are many people issuing NoCeM messages.  This list says what
16484 people you want to listen to.  The default is @code{("Automoose-1"
16485 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
16486 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
16487 (Richard E. Depew)")}; fine, upstanding citizens all of them.
16488
16489 Known despammers that you can put in this list include:
16490
16491 @table @samp
16492 @item clewis@@ferret.ocunix.on.ca;
16493 @cindex Chris Lewis
16494 Chris Lewis---Major Canadian despammer who has probably canceled more
16495 usenet abuse than anybody else.
16496
16497 @item Automoose-1
16498 @cindex CancelMoose[tm]
16499 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
16500 Norwegian, and was the person(s) who invented NoCeM.
16501
16502 @item jem@@xpat.com;
16503 @cindex Jem
16504 John Milburn---despammer located in Korea who is getting very busy these
16505 days.
16506
16507 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
16508 Richard E. Depew---lone American despammer.  He mostly cancels binary
16509 postings to non-binary groups and removes spews (regurgitated articles).
16510 @end table
16511
16512 You do not have to heed NoCeM messages from all these people---just the
16513 ones you want to listen to.  You also don't have to accept all NoCeM
16514 messages from the people you like.  Each NoCeM message has a @dfn{type}
16515 header that gives the message a (more or less, usually less) rigorous
16516 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
16517 @samp{binary}, and @samp{troll}.  To specify this, you have to use
16518 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
16519 Each condition is either a string (which is a regexp that matches types
16520 you want to use) or a list on the form @code{(not @var{string})}, where
16521 @var{string} is a regexp that matches types you don't want to use.
16522
16523 For instance, if you want all NoCeM messages from Chris Lewis except his
16524 @samp{troll} messages, you'd say:
16525
16526 @lisp
16527 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
16528 @end lisp
16529
16530 On the other hand, if you just want nothing but his @samp{spam} and
16531 @samp{spew} messages, you'd say:
16532
16533 @lisp
16534 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
16535 @end lisp
16536
16537 The specs are applied left-to-right.
16538
16539
16540 @item gnus-nocem-verifyer
16541 @vindex gnus-nocem-verifyer
16542 @findex mc-verify
16543 This should be a function for verifying that the NoCeM issuer is who she
16544 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
16545 function.  If this is too slow and you don't care for verification
16546 (which may be dangerous), you can set this variable to @code{nil}.
16547
16548 If you want signed NoCeM messages to be verified and unsigned messages
16549 not to be verified (but used anyway), you could do something like:
16550
16551 @lisp
16552 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
16553
16554 (defun my-gnus-mc-verify ()
16555   (not (eq 'forged
16556            (ignore-errors
16557              (if (mc-verify)
16558                  t
16559                'forged)))))
16560 @end lisp
16561
16562 This might be dangerous, though.
16563
16564 @item gnus-nocem-directory
16565 @vindex gnus-nocem-directory
16566 This is where Gnus will store its NoCeM cache files.  The default is
16567 @file{~/News/NoCeM/}.
16568
16569 @item gnus-nocem-expiry-wait
16570 @vindex gnus-nocem-expiry-wait
16571 The number of days before removing old NoCeM entries from the cache.
16572 The default is 15.  If you make it shorter Gnus will be faster, but you
16573 might then see old spam.
16574
16575 @end table
16576
16577 Using NoCeM could potentially be a memory hog.  If you have many living
16578 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
16579 big.  If this is a problem, you should kill off all (or most) of your
16580 unsubscribed groups (@pxref{Subscription Commands}).
16581
16582
16583 @node Undo
16584 @section Undo
16585 @cindex undo
16586
16587 It is very useful to be able to undo actions one has done.  In normal
16588 Emacs buffers, it's easy enough---you just push the @code{undo} button.
16589 In Gnus buffers, however, it isn't that simple.
16590
16591 The things Gnus displays in its buffer is of no value whatsoever to
16592 Gnus---it's all just data designed to look nice to the user.
16593 Killing a group in the group buffer with @kbd{C-k} makes the line
16594 disappear, but that's just a side-effect of the real action---the
16595 removal of the group in question from the internal Gnus structures.
16596 Undoing something like that can't be done by the normal Emacs
16597 @code{undo} function.
16598
16599 Gnus tries to remedy this somewhat by keeping track of what the user
16600 does and coming up with actions that would reverse the actions the user
16601 takes.  When the user then presses the @code{undo} key, Gnus will run
16602 the code to reverse the previous action, or the previous actions.
16603 However, not all actions are easily reversible, so Gnus currently offers
16604 a few key functions to be undoable.  These include killing groups,
16605 yanking groups, and changing the list of read articles of groups.
16606 That's it, really.  More functions may be added in the future, but each
16607 added function means an increase in data to be stored, so Gnus will
16608 never be totally undoable.
16609
16610 @findex gnus-undo-mode
16611 @vindex gnus-use-undo
16612 @findex gnus-undo
16613 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
16614 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
16615 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
16616 command, which should feel kinda like the normal Emacs @code{undo}
16617 command.
16618
16619
16620 @node Moderation
16621 @section Moderation
16622 @cindex moderation
16623
16624 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
16625 It is not included in the standard Gnus package.  Write a mail to
16626 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
16627 get a copy.
16628
16629 The moderation package is implemented as a minor mode for summary
16630 buffers.  Put
16631
16632 @lisp
16633 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
16634 @end lisp
16635
16636 in your @file{.gnus.el} file.
16637
16638 If you are the moderator of @samp{rec.zoofle}, this is how it's
16639 supposed to work:
16640
16641 @enumerate
16642 @item
16643 You split your incoming mail by matching on
16644 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
16645 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
16646
16647 @item
16648 You enter that group once in a while and post articles using the @kbd{e}
16649 (edit-and-post) or @kbd{s} (just send unedited) commands.
16650
16651 @item
16652 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
16653 articles that weren't approved by you, you can cancel them with the
16654 @kbd{c} command.
16655 @end enumerate
16656
16657 To use moderation mode in these two groups, say:
16658
16659 @lisp
16660 (setq gnus-moderated-list
16661       "^nnml:rec.zoofle$\\|^rec.zoofle$")
16662 @end lisp
16663
16664
16665 @node XEmacs Enhancements
16666 @section XEmacs Enhancements
16667 @cindex XEmacs
16668
16669 XEmacs is able to display pictures and stuff, so Gnus has taken
16670 advantage of that.
16671
16672 @menu
16673 * Picons::    How to display pictures of what your reading.
16674 * Smileys::   Show all those happy faces the way they were meant to be shown.
16675 * Toolbar::   Click'n'drool.
16676 * XVarious::  Other XEmacsy Gnusey variables.
16677 @end menu
16678
16679
16680 @node Picons
16681 @subsection Picons
16682
16683 @iftex
16684 @iflatex
16685 \include{picons}
16686 @end iflatex
16687 @end iftex
16688
16689 So...  You want to slow down your news reader even more!  This is a
16690 good way to do so.  Its also a great way to impress people staring
16691 over your shoulder as you read news.
16692
16693 @menu
16694 * Picon Basics::           What are picons and How do I get them.
16695 * Picon Requirements::     Don't go further if you aren't using XEmacs.
16696 * Easy Picons::            Displaying Picons---the easy way.
16697 * Hard Picons::            The way you should do it.  You'll learn something.
16698 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
16699 @end menu
16700
16701
16702 @node Picon Basics
16703 @subsubsection Picon Basics
16704
16705 What are Picons?  To quote directly from the Picons Web site:
16706
16707 @iftex
16708 @iflatex
16709 \margindex{}
16710 @end iflatex
16711 @end iftex
16712
16713 @quotation
16714 @dfn{Picons} is short for ``personal icons''.  They're small,
16715 constrained images used to represent users and domains on the net,
16716 organized into databases so that the appropriate image for a given
16717 e-mail address can be found.  Besides users and domains, there are picon
16718 databases for Usenet newsgroups and weather forecasts.  The picons are
16719 in either monochrome @code{XBM} format or color @code{XPM} and
16720 @code{GIF} formats.
16721 @end quotation
16722
16723 @vindex gnus-picons-piconsearch-url
16724 If you have a permanent connection to the Internet you can use Steve
16725 Kinzler's Picons Search engine by setting
16726 @code{gnus-picons-piconsearch-url} to the string @*
16727 @file{http://www.cs.indiana.edu/picons/search.html}.
16728
16729 @vindex gnus-picons-database
16730 Otherwise you need a local copy of his database.  For instructions on
16731 obtaining and installing the picons databases, point your Web browser at @*
16732 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
16733 picons to be installed into a location pointed to by
16734 @code{gnus-picons-database}.
16735
16736
16737 @node Picon Requirements
16738 @subsubsection Picon Requirements
16739
16740 To have Gnus display Picons for you, you must be running XEmacs
16741 19.13 or greater since all other versions of Emacs aren't yet able to
16742 display images.
16743
16744 Additionally, you must have @code{x} support compiled into XEmacs.  To
16745 display color picons which are much nicer than the black & white one,
16746 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
16747
16748 @vindex gnus-picons-convert-x-face
16749 If you want to display faces from @code{X-Face} headers, you should have
16750 the @code{xface} support compiled into XEmacs.  Otherwise you must have
16751 the @code{netpbm} utilities installed, or munge the
16752 @code{gnus-picons-convert-x-face} variable to use something else.
16753
16754
16755 @node Easy Picons
16756 @subsubsection Easy Picons
16757
16758 To enable displaying picons, simply put the following line in your
16759 @file{~/.gnus} file and start Gnus.
16760
16761 @lisp
16762 (setq gnus-use-picons t)
16763 (setq gnus-treat-display-picons t)
16764 @end lisp
16765
16766 and make sure @code{gnus-picons-database} points to the directory
16767 containing the Picons databases.
16768
16769 Alternatively if you want to use the web piconsearch engine add this:
16770
16771 @lisp
16772 (setq gnus-picons-piconsearch-url
16773       "http://www.cs.indiana.edu:800/piconsearch")
16774 @end lisp
16775
16776
16777 @node Hard Picons
16778 @subsubsection Hard Picons
16779
16780 @iftex
16781 @iflatex
16782 \margindex{}
16783 @end iflatex
16784 @end iftex
16785
16786 Gnus can display picons for you as you enter and leave groups and
16787 articles.  It knows how to interact with three sections of the picons
16788 database.  Namely, it can display the picons newsgroup pictures,
16789 author's face picture(s), and the authors domain.  To enable this
16790 feature, you need to select where to get the picons from, and where to
16791 display them.
16792
16793 @table @code
16794
16795 @item gnus-picons-database
16796 @vindex gnus-picons-database
16797 The location of the picons database.  Should point to a directory
16798 containing the @file{news}, @file{domains}, @file{users} (and so on)
16799 subdirectories.  This is only useful if
16800 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
16801 @file{/usr/local/faces/}.
16802
16803 @item gnus-picons-piconsearch-url
16804 @vindex gnus-picons-piconsearch-url
16805 The URL for the web picons search engine.  The only currently known
16806 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
16807 workaround network delays, icons will be fetched in the background.  If
16808 this is @code{nil} 'the default), then picons are fetched from local
16809 database indicated by @code{gnus-picons-database}.
16810
16811 @item gnus-picons-display-where
16812 @vindex gnus-picons-display-where
16813 Where the picon images should be displayed.  It is @code{picons} by
16814 default (which by default maps to the buffer @samp{*Picons*}).  Other
16815 valid places could be @code{article}, @code{summary}, or
16816 @samp{*scratch*} for all I care.  Just make sure that you've made the
16817 buffer visible using the standard Gnus window configuration
16818 routines---@pxref{Windows Configuration}.
16819
16820 @item gnus-picons-group-excluded-groups
16821 @vindex gnus-picons-group-excluded-groups
16822 Groups that are matched by this regexp won't have their group icons
16823 displayed.
16824
16825 @end table
16826
16827 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
16828 window configuration for you to include the @code{picons} buffer.
16829
16830 Now that you've made those decision, you need to add the following
16831 functions to the appropriate hooks so these pictures will get displayed
16832 at the right time.
16833
16834 @vindex gnus-picons-display-where
16835 @table @code
16836 @item gnus-article-display-picons
16837 @findex gnus-article-display-picons
16838 Looks up and displays the picons for the author and the author's domain
16839 in the @code{gnus-picons-display-where} buffer.
16840
16841 @item gnus-picons-article-display-x-face
16842 @findex gnus-article-display-picons
16843 Decodes and displays the X-Face header if present.
16844
16845 @end table
16846
16847
16848
16849 @node Picon Useless Configuration
16850 @subsubsection Picon Useless Configuration
16851
16852 @iftex
16853 @iflatex
16854 \margindex{}
16855 @end iflatex
16856 @end iftex
16857
16858 The following variables offer further control over how things are
16859 done, where things are located, and other useless stuff you really
16860 don't need to worry about.
16861
16862 @table @code
16863
16864 @item gnus-picons-news-directories
16865 @vindex gnus-picons-news-directories
16866 List of subdirectories to search in @code{gnus-picons-database} for
16867 newsgroups faces.  @code{("news")} is the default.
16868
16869 @item gnus-picons-user-directories
16870 @vindex gnus-picons-user-directories
16871 List of subdirectories to search in @code{gnus-picons-database} for user
16872 faces.  @code{("local" "users" "usenix" "misc")} is the default.
16873
16874 @item gnus-picons-domain-directories
16875 @vindex gnus-picons-domain-directories
16876 List of subdirectories to search in @code{gnus-picons-database} for
16877 domain name faces.  Defaults to @code{("domains")}.  Some people may
16878 want to add @samp{"unknown"} to this list.
16879
16880 @item gnus-picons-convert-x-face
16881 @vindex gnus-picons-convert-x-face
16882 If you don't have @code{xface} support builtin XEmacs, this is the
16883 command to use to convert the @code{X-Face} header to an X bitmap
16884 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
16885 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
16886 gnus-picons-x-face-file-name)}
16887
16888 @item gnus-picons-x-face-file-name
16889 @vindex gnus-picons-x-face-file-name
16890 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
16891 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
16892
16893 @item gnus-picons-has-modeline-p
16894 @vindex gnus-picons-has-modeline-p
16895 If you have set @code{gnus-picons-display-where} to @code{picons}, your
16896 XEmacs frame will become really cluttered.  To alleviate this a bit you
16897 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
16898 remove the mode line from the Picons buffer.  This is only useful if
16899 @code{gnus-picons-display-where} is @code{picons}.
16900
16901 @item gnus-picons-refresh-before-display
16902 @vindex gnus-picons-refresh-before-display
16903 If non-nil, display the article buffer before computing the picons.
16904 Defaults to @code{nil}.
16905
16906 @item gnus-picons-display-as-address
16907 @vindex gnus-picons-display-as-address
16908 If @code{t} display textual email addresses along with pictures.
16909 Defaults to @code{t}.
16910
16911 @item gnus-picons-file-suffixes
16912 @vindex gnus-picons-file-suffixes
16913 Ordered list of suffixes on picon file names to try.  Defaults to
16914 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
16915
16916 @item gnus-picons-setup-hook
16917 @vindex gnus-picons-setup-hook
16918 Hook run in the picon buffer, if that is displayed.
16919
16920 @item gnus-picons-display-article-move-p
16921 @vindex gnus-picons-display-article-move-p
16922 Whether to move point to first empty line when displaying picons.  This
16923 has only an effect if `gnus-picons-display-where' has value `article'.
16924
16925 If @code{nil}, display the picons in the @code{From} and
16926 @code{Newsgroups} lines.  This is the defailt.
16927
16928 @item gnus-picons-clear-cache-on-shutdown
16929 @vindex gnus-picons-clear-cache-on-shutdown
16930 Whether to clear the picons cache when exiting gnus.  Gnus caches every
16931 picons it finds while it is running.  This saves some time in the search
16932 process but eats some memory.  If this variable is set to @code{nil},
16933 Gnus will never clear the cache itself; you will have to manually call
16934 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
16935 cleared every time you exit Gnus.  Defaults to @code{t}.
16936
16937 @iftex
16938 @iflatex
16939 \margindex{}
16940 @end iflatex
16941 @end iftex
16942
16943 @end table
16944
16945 @node Smileys
16946 @subsection Smileys
16947 @cindex smileys
16948
16949 @iftex
16950 @iflatex
16951 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
16952 \input{smiley}
16953 @end iflatex
16954 @end iftex
16955
16956 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
16957 currently the only package that uses Smiley, it is documented here.
16958
16959 In short---to use Smiley in Gnus, put the following in your
16960 @file{.gnus.el} file:
16961
16962 @lisp
16963 (setq gnus-treat-display-smiley t)
16964 @end lisp
16965
16966 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
16967 the like---to pictures and displays those instead of the text smiley
16968 faces.  The conversion is controlled by a list of regexps that matches
16969 text and maps that to file names.
16970
16971 @vindex smiley-nosey-regexp-alist
16972 @vindex smiley-deformed-regexp-alist
16973 Smiley supplies two example conversion alists by default:
16974 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
16975 and so on), and @code{smiley-nosey-regexp-alist} (which matches
16976 @samp{:-)}, @samp{:-(} and so on).
16977
16978 The alist used is specified by the @code{smiley-regexp-alist} variable,
16979 which defaults to the value of @code{smiley-deformed-regexp-alist}.
16980
16981 The first item in each element is the regexp to be matched; the second
16982 element is the regexp match group that is to be replaced by the picture;
16983 and the third element is the name of the file to be displayed.
16984
16985 The following variables customize where Smiley will look for these
16986 files, as well as the color to be used and stuff:
16987
16988 @table @code
16989
16990 @item smiley-data-directory
16991 @vindex smiley-data-directory
16992 Where Smiley will look for smiley faces files.
16993
16994 @item smiley-flesh-color
16995 @vindex smiley-flesh-color
16996 Skin color.  The default is @samp{yellow}, which is really racist.
16997
16998 @item smiley-features-color
16999 @vindex smiley-features-color
17000 Color of the features of the face.  The default is @samp{black}.
17001
17002 @item smiley-tongue-color
17003 @vindex smiley-tongue-color
17004 Color of the tongue.  The default is @samp{red}.
17005
17006 @item smiley-circle-color
17007 @vindex smiley-circle-color
17008 Color of the circle around the face.  The default is @samp{black}.
17009
17010 @item smiley-mouse-face
17011 @vindex smiley-mouse-face
17012 Face used for mouse highlighting over the smiley face.
17013
17014 @end table
17015
17016
17017 @node Toolbar
17018 @subsection Toolbar
17019
17020 @table @code
17021
17022 @iftex
17023 @iflatex
17024 \margindex{}
17025 @end iflatex
17026 @end iftex
17027
17028 @item gnus-use-toolbar
17029 @vindex gnus-use-toolbar
17030 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
17031 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
17032 @code{right-toolbar}, or @code{left-toolbar}.
17033
17034 @item gnus-group-toolbar
17035 @vindex gnus-group-toolbar
17036 The toolbar in the group buffer.
17037
17038 @item gnus-summary-toolbar
17039 @vindex gnus-summary-toolbar
17040 The toolbar in the summary buffer.
17041
17042 @item gnus-summary-mail-toolbar
17043 @vindex gnus-summary-mail-toolbar
17044 The toolbar in the summary buffer of mail groups.
17045
17046 @end table
17047
17048
17049 @node XVarious
17050 @subsection Various XEmacs Variables
17051
17052 @table @code
17053 @item gnus-xmas-glyph-directory
17054 @vindex gnus-xmas-glyph-directory
17055 This is where Gnus will look for pictures.  Gnus will normally
17056 auto-detect this directory, but you may set it manually if you have an
17057 unusual directory structure.
17058
17059 @item gnus-xmas-logo-color-alist
17060 @vindex gnus-xmas-logo-color-alist
17061 This is an alist where the key is a type symbol and the values are the
17062 foreground and background color of the splash page glyph.
17063
17064 @item gnus-xmas-logo-color-style
17065 @vindex gnus-xmas-logo-color-style
17066 This is the key used to look up the color in the alist described above.
17067 Valid values include @code{flame}, @code{pine}, @code{moss},
17068 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
17069 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
17070
17071 @item gnus-xmas-modeline-glyph
17072 @vindex gnus-xmas-modeline-glyph
17073 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
17074 default.
17075
17076 @iftex
17077 @iflatex
17078 \margindex{}
17079 @end iflatex
17080 @end iftex
17081
17082 @end table
17083
17084
17085
17086
17087 @node Fuzzy Matching
17088 @section Fuzzy Matching
17089 @cindex fuzzy matching
17090
17091 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
17092 things like scoring, thread gathering and thread comparison.
17093
17094 As opposed to regular expression matching, fuzzy matching is very fuzzy.
17095 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
17096 means, and the implementation has changed over time.
17097
17098 Basically, it tries to remove all noise from lines before comparing.
17099 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
17100 out of the strings before comparing the results.  This often leads to
17101 adequate results---even when faced with strings generated by text
17102 manglers masquerading as newsreaders.
17103
17104
17105 @node Thwarting Email Spam
17106 @section Thwarting Email Spam
17107 @cindex email spam
17108 @cindex spam
17109 @cindex UCE
17110 @cindex unsolicited commercial email
17111
17112 In these last days of the Usenet, commercial vultures are hanging about
17113 and grepping through news like crazy to find email addresses they can
17114 foist off their scams and products to.  As a reaction to this, many
17115 people have started putting nonsense addresses into their @code{From}
17116 lines.  I think this is counterproductive---it makes it difficult for
17117 people to send you legitimate mail in response to things you write, as
17118 well as making it difficult to see who wrote what.  This rewriting may
17119 perhaps be a bigger menace than the unsolicited commercial email itself
17120 in the end.
17121
17122 The biggest problem I have with email spam is that it comes in under
17123 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
17124 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
17125 mail group, only to find two pyramid schemes, seven advertisements
17126 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
17127 and one mail asking me to repent and find some god.
17128
17129 This is annoying.
17130
17131 The way to deal with this is having Gnus split out all spam into a
17132 @samp{spam} mail group (@pxref{Splitting Mail}).
17133
17134 First, pick one (1) valid mail address that you can be reached at, and
17135 put it in your @code{From} header of all your news articles.  (I've
17136 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
17137 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
17138 sysadm whether your sendmail installation accepts keywords in the local
17139 part of the mail address.)
17140
17141 @lisp
17142 (setq message-default-news-headers
17143       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
17144 @end lisp
17145
17146 Then put the following split rule in @code{nnmail-split-fancy}
17147 (@pxref{Fancy Mail Splitting}):
17148
17149 @lisp
17150 (
17151  ...
17152  (to "larsi@@trym.ifi.uio.no"
17153       (| ("subject" "re:.*" "misc")
17154          ("references" ".*@@.*" "misc")
17155          "spam"))
17156  ...
17157 )
17158 @end lisp
17159
17160 This says that all mail to this address is suspect, but if it has a
17161 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
17162 header, it's probably ok.  All the rest goes to the @samp{spam} group.
17163 (This idea probably comes from Tim Pierce.)
17164
17165 In addition, many mail spammers talk directly to your @code{smtp} server
17166 and do not include your email address explicitly in the @code{To}
17167 header.  Why they do this is unknown---perhaps it's to thwart this
17168 thwarting scheme?  In any case, this is trivial to deal with---you just
17169 put anything not addressed to you in the @samp{spam} group by ending
17170 your fancy split rule in this way:
17171
17172 @lisp
17173 (
17174  ...
17175  (to "larsi" "misc")
17176  "spam")
17177 @end lisp
17178
17179 In my experience, this will sort virtually everything into the right
17180 group.  You still have to check the @samp{spam} group from time to time to
17181 check for legitimate mail, though.  If you feel like being a good net
17182 citizen, you can even send off complaints to the proper authorities on
17183 each unsolicited commercial email---at your leisure.
17184
17185 If you are also a lazy net citizen, you will probably prefer complaining
17186 automatically with the @file{gnus-junk.el} package, available FOR FREE
17187 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
17188 Since most e-mail spam is sent automatically, this may reconcile the
17189 cosmic balance somewhat.
17190
17191 This works for me.  It allows people an easy way to contact me (they can
17192 just press @kbd{r} in the usual way), and I'm not bothered at all with
17193 spam.  It's a win-win situation.  Forging @code{From} headers to point
17194 to non-existent domains is yucky, in my opinion.
17195
17196
17197 @node Various Various
17198 @section Various Various
17199 @cindex mode lines
17200 @cindex highlights
17201
17202 @table @code
17203
17204 @item gnus-home-directory
17205 All Gnus path variables will be initialized from this variable, which
17206 defaults to @file{~/}.
17207
17208 @item gnus-directory
17209 @vindex gnus-directory
17210 Most Gnus storage path variables will be initialized from this variable,
17211 which defaults to the @samp{SAVEDIR} environment variable, or
17212 @file{~/News/} if that variable isn't set.
17213
17214 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
17215 This means that other directory variables that are initialized from this
17216 variable won't be set properly if you set this variable in
17217 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
17218
17219 @item gnus-default-directory
17220 @vindex gnus-default-directory
17221 Not related to the above variable at all---this variable says what the
17222 default directory of all Gnus buffers should be.  If you issue commands
17223 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
17224 default directory.  If this variable is @code{nil} (which is the
17225 default), the default directory will be the default directory of the
17226 buffer you were in when you started Gnus.
17227
17228 @item gnus-verbose
17229 @vindex gnus-verbose
17230 This variable is an integer between zero and ten.  The higher the value,
17231 the more messages will be displayed.  If this variable is zero, Gnus
17232 will never flash any messages, if it is seven (which is the default),
17233 most important messages will be shown, and if it is ten, Gnus won't ever
17234 shut up, but will flash so many messages it will make your head swim.
17235
17236 @item gnus-verbose-backends
17237 @vindex gnus-verbose-backends
17238 This variable works the same way as @code{gnus-verbose}, but it applies
17239 to the Gnus backends instead of Gnus proper.
17240
17241 @item nnheader-max-head-length
17242 @vindex nnheader-max-head-length
17243 When the backends read straight heads of articles, they all try to read
17244 as little as possible.  This variable (default 4096) specifies
17245 the absolute max length the backends will try to read before giving up
17246 on finding a separator line between the head and the body.  If this
17247 variable is @code{nil}, there is no upper read bound.  If it is
17248 @code{t}, the backends won't try to read the articles piece by piece,
17249 but read the entire articles.  This makes sense with some versions of
17250 @code{ange-ftp} or @code{efs}.
17251
17252 @item nnheader-head-chop-length
17253 @vindex nnheader-head-chop-length
17254 This variable (default 2048) says how big a piece of each article to
17255 read when doing the operation described above.
17256
17257 @item nnheader-file-name-translation-alist
17258 @vindex nnheader-file-name-translation-alist
17259 @cindex file names
17260 @cindex invalid characters in file names
17261 @cindex characters in file names
17262 This is an alist that says how to translate characters in file names.
17263 For instance, if @samp{:} is invalid as a file character in file names
17264 on your system (you OS/2 user you), you could say something like:
17265
17266 @lisp
17267 (setq nnheader-file-name-translation-alist
17268       '((?: . ?_)))
17269 @end lisp
17270
17271 In fact, this is the default value for this variable on OS/2 and MS
17272 Windows (phooey) systems.
17273
17274 @item gnus-hidden-properties
17275 @vindex gnus-hidden-properties
17276 This is a list of properties to use to hide ``invisible'' text.  It is
17277 @code{(invisible t intangible t)} by default on most systems, which
17278 makes invisible text invisible and intangible.
17279
17280 @item gnus-parse-headers-hook
17281 @vindex gnus-parse-headers-hook
17282 A hook called before parsing headers.  It can be used, for instance, to
17283 gather statistics on the headers fetched, or perhaps you'd like to prune
17284 some headers.  I don't see why you'd want that, though.
17285
17286 @item gnus-shell-command-separator
17287 @vindex gnus-shell-command-separator
17288 String used to separate two shell commands.  The default is @samp{;}.
17289
17290
17291 @end table
17292
17293
17294 @node The End
17295 @chapter The End
17296
17297 Well, that's the manual---you can get on with your life now.  Keep in
17298 touch.  Say hello to your cats from me.
17299
17300 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
17301
17302 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
17303
17304 @quotation
17305 @strong{Te Deum}
17306
17307 @sp 1
17308 Not because of victories @*
17309 I sing,@*
17310 having none,@*
17311 but for the common sunshine,@*
17312 the breeze,@*
17313 the largess of the spring.
17314
17315 @sp 1
17316 Not for victory@*
17317 but for the day's work done@*
17318 as well as I was able;@*
17319 not for a seat upon the dais@*
17320 but at the common table.@*
17321 @end quotation
17322
17323
17324 @node Appendices
17325 @chapter Appendices
17326
17327 @menu
17328 * History::                        How Gnus got where it is today.
17329 * Terminology::                    We use really difficult, like, words here.
17330 * Customization::                  Tailoring Gnus to your needs.
17331 * Troubleshooting::                What you might try if things do not work.
17332 * Gnus Reference Guide::           Rilly, rilly technical stuff.
17333 * Emacs for Heathens::             A short introduction to Emacsian terms.
17334 * Frequently Asked Questions::     A question-and-answer session.
17335 @end menu
17336
17337
17338 @node History
17339 @section History
17340
17341 @cindex history
17342 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
17343 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
17344
17345 If you want to investigate the person responsible for this outrage, you
17346 can point your (feh!) web browser to
17347 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
17348 distribution point for the new and spiffy versions of Gnus, and is known
17349 as The Site That Destroys Newsrcs And Drives People Mad.
17350
17351 During the first extended alpha period of development, the new Gnus was
17352 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
17353 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
17354 (Besides, the ``Gnus'' in this abbreviation should probably be
17355 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
17356 appropriate name, don't you think?)
17357
17358 In any case, after spending all that energy on coming up with a new and
17359 spunky name, we decided that the name was @emph{too} spunky, so we
17360 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
17361 ``@sc{gnus}''.  New vs. old.
17362
17363 The first ``proper'' release of Gnus 5 was done in November 1995 when it
17364 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
17365 plus 15 Gnus 5.0 releases).
17366
17367 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
17368 releases)) was released under the name ``Gnus 5.2'' (40 releases).
17369
17370 On July 28th 1996 work on Red Gnus was begun, and it was released on
17371 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
17372
17373 On September 13th 1997, Quassia Gnus was started and lasted 37
17374 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
17375
17376 If you happen upon a version of Gnus that has a prefixed name --
17377 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
17378 don't panic.  Don't let it know that you're frightened.  Back away.
17379 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
17380 out of its reach.  Find a proper released version of Gnus and snuggle up
17381 to that instead.
17382
17383 @menu
17384 * Why?::                What's the point of Gnus?
17385 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
17386 * Conformity::          Gnus tries to conform to all standards.
17387 * Emacsen::             Gnus can be run on a few modern Emacsen.
17388 * Gnus Development::    How Gnus is developed.
17389 * Contributors::        Oodles of people.
17390 * New Features::        Pointers to some of the new stuff in Gnus.
17391 * Newest Features::     Features so new that they haven't been written yet.
17392 @end menu
17393
17394
17395 @node Why?
17396 @subsection Why?
17397
17398 What's the point of Gnus?
17399
17400 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
17401 newsreader, that lets you do anything you can think of.  That was my
17402 original motivation, but while working on Gnus, it has become clear to
17403 me that this generation of newsreaders really belong in the stone age.
17404 Newsreaders haven't developed much since the infancy of the net.  If the
17405 volume continues to rise with the current rate of increase, all current
17406 newsreaders will be pretty much useless.  How do you deal with
17407 newsgroups that have thousands of new articles each day?  How do you
17408 keep track of millions of people who post?
17409
17410 Gnus offers no real solutions to these questions, but I would very much
17411 like to see Gnus being used as a testing ground for new methods of
17412 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
17413 to separate the newsreader from the backends, Gnus now offers a simple
17414 interface for anybody who wants to write new backends for fetching mail
17415 and news from different sources.  I have added hooks for customizations
17416 everywhere I could imagine it being useful.  By doing so, I'm inviting
17417 every one of you to explore and invent.
17418
17419 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
17420 @kbd{C-u 100 M-x all-hail-xemacs}.
17421
17422
17423 @node Compatibility
17424 @subsection Compatibility
17425
17426 @cindex compatibility
17427 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
17428 bindings have been kept.  More key bindings have been added, of course,
17429 but only in one or two obscure cases have old bindings been changed.
17430
17431 Our motto is:
17432 @quotation
17433 @cartouche
17434 @center In a cloud bones of steel.
17435 @end cartouche
17436 @end quotation
17437
17438 All commands have kept their names.  Some internal functions have changed
17439 their names.
17440
17441 The @code{gnus-uu} package has changed drastically. @xref{Decoding
17442 Articles}.
17443
17444 One major compatibility question is the presence of several summary
17445 buffers.  All variables relevant while reading a group are
17446 buffer-local to the summary buffer they belong in.  Although many
17447 important variables have their values copied into their global
17448 counterparts whenever a command is executed in the summary buffer, this
17449 change might lead to incorrect values being used unless you are careful.
17450
17451 All code that relies on knowledge of @sc{gnus} internals will probably
17452 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
17453 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
17454 maintains a hash table that points to the entries in this alist (which
17455 speeds up many functions), and changing the alist directly will lead to
17456 peculiar results.
17457
17458 @cindex hilit19
17459 @cindex highlighting
17460 Old hilit19 code does not work at all.  In fact, you should probably
17461 remove all hilit code from all Gnus hooks
17462 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
17463 Gnus provides various integrated functions for highlighting.  These are
17464 faster and more accurate.  To make life easier for everybody, Gnus will
17465 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
17466 Away!
17467
17468 Packages like @code{expire-kill} will no longer work.  As a matter of
17469 fact, you should probably remove all old @sc{gnus} packages (and other
17470 code) when you start using Gnus.  More likely than not, Gnus already
17471 does what you have written code to make @sc{gnus} do.  (Snicker.)
17472
17473 Even though old methods of doing things are still supported, only the
17474 new methods are documented in this manual.  If you detect a new method of
17475 doing something while reading this manual, that does not mean you have
17476 to stop doing it the old way.
17477
17478 Gnus understands all @sc{gnus} startup files.
17479
17480 @kindex M-x gnus-bug
17481 @findex gnus-bug
17482 @cindex reporting bugs
17483 @cindex bugs
17484 Overall, a casual user who hasn't written much code that depends on
17485 @sc{gnus} internals should suffer no problems.  If problems occur,
17486 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
17487
17488 @vindex gnus-bug-create-help-buffer
17489 If you are in the habit of sending bug reports @emph{very} often, you
17490 may find the helpful help buffer annoying after a while.  If so, set
17491 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
17492 up at you.
17493
17494
17495 @node Conformity
17496 @subsection Conformity
17497
17498 No rebels without a clue here, ma'am.  We conform to all standards known
17499 to (wo)man.  Except for those standards and/or conventions we disagree
17500 with, of course.
17501
17502 @table @strong
17503
17504 @item RFC 822
17505 @cindex RFC 822
17506 There are no known breaches of this standard.
17507
17508 @item RFC 1036
17509 @cindex RFC 1036
17510 There are no known breaches of this standard, either.
17511
17512 @item Son-of-RFC 1036
17513 @cindex Son-of-RFC 1036
17514 We do have some breaches to this one.
17515
17516 @table @emph
17517
17518 @item X-Newsreader
17519 @itemx User-Agent
17520 These are considered to be ``vanity headers'', while I consider them
17521 to be consumer information.  After seeing so many badly formatted
17522 articles coming from @code{tin} and @code{Netscape} I know not to use
17523 either of those for posting articles.  I would not have known that if
17524 it wasn't for the @code{X-Newsreader} header.
17525 @end table
17526
17527 @item USEFOR
17528 @cindex USEFOR
17529 USEFOR is an IETF working group writing a successor to RFC 1036, based
17530 on Son-of-RFC 1036.  They have produced a number of drafts proposing
17531 various changes to the format of news articles.  The Gnus towers will
17532 look into implementing the changes when the draft is accepted as an RFC.
17533
17534 @end table
17535
17536 If you ever notice Gnus acting non-compliant with regards to the texts
17537 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
17538 know.
17539
17540
17541 @node Emacsen
17542 @subsection Emacsen
17543 @cindex Emacsen
17544 @cindex XEmacs
17545 @cindex Mule
17546 @cindex Emacs
17547
17548 Gnus should work on :
17549
17550 @itemize @bullet
17551
17552 @item
17553 Emacs 20.3 and up.
17554
17555 @item
17556 XEmacs 20.4 and up.
17557
17558 @end itemize
17559
17560 This Gnus version will absolutely not work on any Emacsen older than
17561 that.  Not reliably, at least.  Older versions of Gnus may work on older
17562 Emacs versions.
17563
17564 There are some vague differences between Gnus on the various
17565 platforms---XEmacs features more graphics (a logo and a toolbar)---but
17566 other than that, things should look pretty much the same under all
17567 Emacsen.
17568
17569
17570 @node Gnus Development
17571 @subsection Gnus Development
17572
17573 Gnus is developed in a two-phased cycle.  The first phase involves much
17574 discussion on the @samp{ding@@gnus.org} mailing list, where people
17575 propose changes and new features, post patches and new backends.  This
17576 phase is called the @dfn{alpha} phase, since the Gnusae released in this
17577 phase are @dfn{alpha releases}, or (perhaps more commonly in other
17578 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
17579 unstable and should not be used by casual users.  Gnus alpha releases
17580 have names like ``Red Gnus'' and ``Quassia Gnus''.
17581
17582 After futzing around for 50-100 alpha releases, Gnus is declared
17583 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
17584 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
17585 supposed to be able to use these, and these are mostly discussed on the
17586 @samp{gnu.emacs.gnus} newsgroup.
17587
17588 @cindex Incoming*
17589 @vindex nnmail-delete-incoming
17590 Some variable defaults differ between alpha Gnusae and released Gnusae.
17591 In particular, @code{nnmail-delete-incoming} defaults to @code{nil} in
17592 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
17593 lossage of mail if an alpha release hiccups while handling the mail.
17594
17595 The division of discussion between the ding mailing list and the Gnus
17596 newsgroup is not purely based on publicity concerns.  It's true that
17597 having people write about the horrible things that an alpha Gnus release
17598 can do (sometimes) in a public forum may scare people off, but more
17599 importantly, talking about new experimental features that have been
17600 introduced may confuse casual users.  New features are frequently
17601 introduced, fiddled with, and judged to be found wanting, and then
17602 either discarded or totally rewritten.  People reading the mailing list
17603 usually keep up with these rapid changes, whille people on the newsgroup
17604 can't be assumed to do so.
17605
17606
17607
17608 @node Contributors
17609 @subsection Contributors
17610 @cindex contributors
17611
17612 The new Gnus version couldn't have been done without the help of all the
17613 people on the (ding) mailing list.  Every day for over a year I have
17614 gotten billions of nice bug reports from them, filling me with joy,
17615 every single one of them.  Smooches.  The people on the list have been
17616 tried beyond endurance, what with my ``oh, that's a neat idea <type
17617 type>, yup, I'll release it right away <ship off> no wait, that doesn't
17618 work at all <type type>, yup, I'll ship that one off right away <ship
17619 off> no, wait, that absolutely does not work'' policy for releases.
17620 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
17621 ``worser''? ``much worser''?  ``worsest''?)
17622
17623 I would like to take this opportunity to thank the Academy for...  oops,
17624 wrong show.
17625
17626 @itemize @bullet
17627
17628 @item
17629 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
17630
17631 @item
17632 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
17633 well as numerous other things).
17634
17635 @item
17636 Luis Fernandes---design and graphics.
17637
17638 @item
17639 Erik Naggum---help, ideas, support, code and stuff.
17640
17641 @item
17642 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
17643 connected with @sc{mime} and other types of en/decoding.
17644
17645 @item
17646 Wes Hardaker---@file{gnus-picon.el} and the manual section on
17647 @dfn{picons} (@pxref{Picons}).
17648
17649 @item
17650 Kim-Minh Kaplan---further work on the picon code.
17651
17652 @item
17653 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
17654 (@pxref{GroupLens}).
17655
17656 @item
17657 Sudish Joseph---innumerable bug fixes.
17658
17659 @item
17660 Ilja Weis---@file{gnus-topic.el}.
17661
17662 @item
17663 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
17664
17665 @item
17666 Vladimir Alexiev---the refcard and reference booklets.
17667
17668 @item
17669 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
17670 distribution by Felix Lee and JWZ.
17671
17672 @item
17673 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
17674
17675 @item
17676 Peter Mutsaers---orphan article scoring code.
17677
17678 @item
17679 Ken Raeburn---POP mail support.
17680
17681 @item
17682 Hallvard B Furuseth---various bits and pieces, especially dealing with
17683 .newsrc files.
17684
17685 @item
17686 Brian Edmonds---@file{gnus-bbdb.el}.
17687
17688 @item
17689 David Moore---rewrite of @file{nnvirtual.el} and many other things.
17690
17691 @item
17692 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
17693
17694 @item
17695 François Pinard---many, many interesting and thorough bug reports, as
17696 well as autoconf support.
17697
17698 @end itemize
17699
17700 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
17701 Borges, and Jost Krieger proof-reading parts of the manual.
17702
17703 The following people have contributed many patches and suggestions:
17704
17705 Christopher Davis,
17706 Andrew Eskilsson,
17707 Kai Grossjohann,
17708 David KÃ¥gedal,
17709 Richard Pieri,
17710 Fabrice Popineau,
17711 Daniel Quinlan,
17712 Jason L. Tibbitts, III,
17713 and
17714 Jack Vinson.
17715
17716 Also thanks to the following for patches and stuff:
17717
17718 Jari Aalto,
17719 Adrian Aichner,
17720 Vladimir Alexiev,
17721 Russ Allbery,
17722 Peter Arius,
17723 Matt Armstrong,
17724 Marc Auslander,
17725 Miles Bader,
17726 Alexei V. Barantsev,
17727 Frank Bennett,
17728 Robert Bihlmeyer,
17729 Chris Bone,
17730 Mark Borges,
17731 Mark Boyns,
17732 Lance A. Brown,
17733 Rob Browning,
17734 Kees de Bruin,
17735 Martin Buchholz,
17736 Joe Buehler,
17737 Kevin Buhr,
17738 Alastair Burt,
17739 Joao Cachopo,
17740 Zlatko Calusic,
17741 Massimo Campostrini,
17742 Castor,
17743 David Charlap,
17744 Dan Christensen,
17745 Kevin Christian,
17746 Jae-you Chung, @c ?
17747 James H. Cloos, Jr.,
17748 Laura Conrad,
17749 Michael R. Cook,
17750 Glenn Coombs,
17751 Andrew J. Cosgriff,
17752 Neil Crellin,
17753 Frank D. Cringle,
17754 Geoffrey T. Dairiki,
17755 Andre Deparade,
17756 Ulrik Dickow,
17757 Dave Disser,
17758 Rui-Tao Dong, @c ?
17759 Joev Dubach,
17760 Michael Welsh Duggan,
17761 Dave Edmondson,
17762 Paul Eggert,
17763 Mark W. Eichin,
17764 Karl Eichwalder,
17765 Enami Tsugutomo, @c Enami
17766 Michael Ernst,
17767 Luc Van Eycken,
17768 Sam Falkner,
17769 Nelson Jose dos Santos Ferreira,
17770 Sigbjorn Finne,
17771 Sven Fischer,
17772 Paul Fisher,
17773 Decklin Foster,
17774 Gary D. Foster,
17775 Paul Franklin,
17776 Guy Geens,
17777 Arne Georg Gleditsch,
17778 David S. Goldberg,
17779 Michelangelo Grigni,
17780 Dale Hagglund,
17781 D. Hall,
17782 Magnus Hammerin,
17783 Kenichi Handa, @c Handa
17784 Raja R. Harinath,
17785 Yoshiki Hayashi, @c ?
17786 P. E. Jareth Hein,
17787 Hisashige Kenji, @c Hisashige
17788 Scott Hofmann,
17789 Marc Horowitz,
17790 Gunnar Horrigmo,
17791 Richard Hoskins,
17792 Brad Howes,
17793 Miguel de Icaza,
17794 François Felix Ingrand,
17795 Tatsuya Ichikawa, @c ?
17796 Ishikawa Ichiro, @c Ishikawa
17797 Lee Iverson,
17798 Iwamuro Motonori, @c Iwamuro
17799 Rajappa Iyer,
17800 Andreas Jaeger,
17801 Adam P. Jenkins,
17802 Randell Jesup,
17803 Fred Johansen,
17804 Gareth Jones,
17805 Simon Josefsson,
17806 Greg Klanderman,
17807 Karl Kleinpaste,
17808 Michael Klingbeil,
17809 Peter Skov Knudsen,
17810 Shuhei Kobayashi, @c Kobayashi
17811 Petr Konecny,
17812 Koseki Yoshinori, @c Koseki
17813 Thor Kristoffersen,
17814 Jens Lautenbacher,
17815 Martin Larose,
17816 Seokchan Lee, @c Lee
17817 Joerg Lenneis,
17818 Carsten Leonhardt,
17819 James LewisMoss,
17820 Christian Limpach,
17821 Markus Linnala,
17822 Dave Love,
17823 Mike McEwan,
17824 Tonny Madsen,
17825 Shlomo Mahlab,
17826 Nat Makarevitch,
17827 Istvan Marko,
17828 David Martin,
17829 Jason R. Mastaler,
17830 Gordon Matzigkeit,
17831 Timo Metzemakers,
17832 Richard Mlynarik,
17833 Lantz Moore,
17834 Morioka Tomohiko, @c Morioka
17835 Erik Toubro Nielsen,
17836 Hrvoje Niksic,
17837 Andy Norman,
17838 Fred Oberhauser,
17839 C. R. Oldham,
17840 Alexandre Oliva,
17841 Ken Olstad,
17842 Masaharu Onishi, @c Onishi
17843 Hideki Ono, @c Ono
17844 Ettore Perazzoli,
17845 William Perry,
17846 Stephen Peters,
17847 Jens-Ulrik Holger Petersen,
17848 Ulrich Pfeifer,
17849 Matt Pharr,
17850 Andy Piper,
17851 John McClary Prevost,
17852 Bill Pringlemeir,
17853 Mike Pullen,
17854 Jim Radford,
17855 Colin Rafferty,
17856 Lasse Rasinen,
17857 Lars Balker Rasmussen,
17858 Joe Reiss,
17859 Renaud Rioboo,
17860 Roland B. Roberts,
17861 Bart Robinson,
17862 Christian von Roques,
17863 Markus Rost,
17864 Jason Rumney,
17865 Wolfgang Rupprecht,
17866 Jay Sachs,
17867 Dewey M. Sasser,
17868 Conrad Sauerwald,
17869 Loren Schall,
17870 Dan Schmidt,
17871 Ralph Schleicher,
17872 Philippe Schnoebelen,
17873 Andreas Schwab,
17874 Randal L. Schwartz,
17875 Justin Sheehy,
17876 Danny Siu,
17877 Matt Simmons,
17878 Paul D. Smith,
17879 Jeff Sparkes,
17880 Toby Speight,
17881 Michael Sperber,
17882 Darren Stalder,
17883 Richard Stallman,
17884 Greg Stark,
17885 Sam Steingold,
17886 Paul Stevenson,
17887 Jonas Steverud,
17888 Paul Stodghill,
17889 Kiyokazu Suto, @c Suto
17890 Kurt Swanson,
17891 Samuel Tardieu,
17892 Teddy,
17893 Chuck Thompson,
17894 Tozawa Akihiko, @c Tozawa
17895 Philippe Troin,
17896 James Troup,
17897 Trung Tran-Duc,
17898 Jack Twilley,
17899 Aaron M. Ucko,
17900 Aki Vehtari,
17901 Didier Verna,
17902 Vladimir Volovich,
17903 Jan Vroonhof,
17904 Stefan Waldherr,
17905 Pete Ware,
17906 Barry A. Warsaw,
17907 Christoph Wedler,
17908 Joe Wells,
17909 Lee Willis,
17910 Katsumi Yamaoka @c Yamaoka
17911 and
17912 Lloyd Zusman.
17913
17914
17915 For a full overview of what each person has done, the ChangeLogs
17916 included in the Gnus alpha distributions should give ample reading
17917 (550kB and counting).
17918
17919 Apologies to everybody that I've forgotten, of which there are many, I'm
17920 sure.
17921
17922 Gee, that's quite a list of people.  I guess that must mean that there
17923 actually are people who are using Gnus.  Who'd'a thunk it!
17924
17925
17926 @node New Features
17927 @subsection New Features
17928 @cindex new features
17929
17930 @menu
17931 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
17932 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
17933 * Red Gnus::           Third time best---Gnus 5.4/5.5.
17934 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
17935 @end menu
17936
17937 These lists are, of course, just @emph{short} overviews of the
17938 @emph{most} important new features.  No, really.  There are tons more.
17939 Yes, we have feeping creaturism in full effect.
17940
17941
17942 @node ding Gnus
17943 @subsubsection (ding) Gnus
17944
17945 New features in Gnus 5.0/5.1:
17946
17947 @itemize @bullet
17948
17949 @item
17950 The look of all buffers can be changed by setting format-like variables
17951 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
17952
17953 @item
17954 Local spool and several @sc{nntp} servers can be used at once
17955 (@pxref{Select Methods}).
17956
17957 @item
17958 You can combine groups into virtual groups (@pxref{Virtual Groups}).
17959
17960 @item
17961 You can read a number of different mail formats (@pxref{Getting Mail}).
17962 All the mail backends implement a convenient mail expiry scheme
17963 (@pxref{Expiring Mail}).
17964
17965 @item
17966 Gnus can use various strategies for gathering threads that have lost
17967 their roots (thereby gathering loose sub-threads into one thread) or it
17968 can go back and retrieve enough headers to build a complete thread
17969 (@pxref{Customizing Threading}).
17970
17971 @item
17972 Killed groups can be displayed in the group buffer, and you can read
17973 them as well (@pxref{Listing Groups}).
17974
17975 @item
17976 Gnus can do partial group updates---you do not have to retrieve the
17977 entire active file just to check for new articles in a few groups
17978 (@pxref{The Active File}).
17979
17980 @item
17981 Gnus implements a sliding scale of subscribedness to groups
17982 (@pxref{Group Levels}).
17983
17984 @item
17985 You can score articles according to any number of criteria
17986 (@pxref{Scoring}).  You can even get Gnus to find out how to score
17987 articles for you (@pxref{Adaptive Scoring}).
17988
17989 @item
17990 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
17991 manner, so it should be difficult to lose much data on what you have
17992 read if your machine should go down (@pxref{Auto Save}).
17993
17994 @item
17995 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
17996 the @file{.emacs} file.
17997
17998 @item
17999 You can set the process mark on both groups and articles and perform
18000 operations on all the marked items (@pxref{Process/Prefix}).
18001
18002 @item
18003 You can grep through a subset of groups and create a group from the
18004 results (@pxref{Kibozed Groups}).
18005
18006 @item
18007 You can list subsets of groups according to, well, anything
18008 (@pxref{Listing Groups}).
18009
18010 @item
18011 You can browse foreign servers and subscribe to groups from those
18012 servers (@pxref{Browse Foreign Server}).
18013
18014 @item
18015 Gnus can fetch articles, asynchronously, on a second connection to the
18016 server (@pxref{Asynchronous Fetching}).
18017
18018 @item
18019 You can cache articles locally (@pxref{Article Caching}).
18020
18021 @item
18022 The uudecode functions have been expanded and generalized
18023 (@pxref{Decoding Articles}).
18024
18025 @item
18026 You can still post uuencoded articles, which was a little-known feature
18027 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
18028
18029 @item
18030 Fetching parents (and other articles) now actually works without
18031 glitches (@pxref{Finding the Parent}).
18032
18033 @item
18034 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
18035
18036 @item
18037 Digests (and other files) can be used as the basis for groups
18038 (@pxref{Document Groups}).
18039
18040 @item
18041 Articles can be highlighted and customized (@pxref{Customizing
18042 Articles}).
18043
18044 @item
18045 URLs and other external references can be buttonized (@pxref{Article
18046 Buttons}).
18047
18048 @item
18049 You can do lots of strange stuff with the Gnus window & frame
18050 configuration (@pxref{Windows Configuration}).
18051
18052 @item
18053 You can click on buttons instead of using the keyboard
18054 (@pxref{Buttons}).
18055
18056 @end itemize
18057
18058
18059 @node September Gnus
18060 @subsubsection September Gnus
18061
18062 @iftex
18063 @iflatex
18064 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
18065 @end iflatex
18066 @end iftex
18067
18068 New features in Gnus 5.2/5.3:
18069
18070 @itemize @bullet
18071
18072 @item
18073 A new message composition mode is used.  All old customization variables
18074 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
18075 now obsolete.
18076
18077 @item
18078 Gnus is now able to generate @dfn{sparse} threads---threads where
18079 missing articles are represented by empty nodes (@pxref{Customizing
18080 Threading}).
18081
18082 @lisp
18083 (setq gnus-build-sparse-threads 'some)
18084 @end lisp
18085
18086 @item
18087 Outgoing articles are stored on a special archive server
18088 (@pxref{Archived Messages}).
18089
18090 @item
18091 Partial thread regeneration now happens when articles are
18092 referred.
18093
18094 @item
18095 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
18096
18097 @item
18098 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
18099
18100 @item
18101 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
18102
18103 @lisp
18104 (setq gnus-use-trees t)
18105 @end lisp
18106
18107 @item
18108 An @code{nn}-like pick-and-read minor mode is available for the summary
18109 buffers (@pxref{Pick and Read}).
18110
18111 @lisp
18112 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
18113 @end lisp
18114
18115 @item
18116 In binary groups you can use a special binary minor mode (@pxref{Binary
18117 Groups}).
18118
18119 @item
18120 Groups can be grouped in a folding topic hierarchy (@pxref{Group
18121 Topics}).
18122
18123 @lisp
18124 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
18125 @end lisp
18126
18127 @item
18128 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
18129
18130 @item
18131 Groups can now have a score, and bubbling based on entry frequency
18132 is possible (@pxref{Group Score}).
18133
18134 @lisp
18135 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
18136 @end lisp
18137
18138 @item
18139 Groups can be process-marked, and commands can be performed on
18140 groups of groups (@pxref{Marking Groups}).
18141
18142 @item
18143 Caching is possible in virtual groups.
18144
18145 @item
18146 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
18147 news batches, ClariNet briefs collections, and just about everything
18148 else (@pxref{Document Groups}).
18149
18150 @item
18151 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
18152 (@pxref{SOUP}).
18153
18154 @item
18155 The Gnus cache is much faster.
18156
18157 @item
18158 Groups can be sorted according to many criteria (@pxref{Sorting
18159 Groups}).
18160
18161 @item
18162 New group parameters have been introduced to set list-addresses and
18163 expiry times (@pxref{Group Parameters}).
18164
18165 @item
18166 All formatting specs allow specifying faces to be used
18167 (@pxref{Formatting Fonts}).
18168
18169 @item
18170 There are several more commands for setting/removing/acting on process
18171 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
18172
18173 @item
18174 The summary buffer can be limited to show parts of the available
18175 articles based on a wide range of criteria.  These commands have been
18176 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
18177
18178 @item
18179 Articles can be made persistent with the @kbd{*} command
18180 (@pxref{Persistent Articles}).
18181
18182 @item
18183 All functions for hiding article elements are now toggles.
18184
18185 @item
18186 Article headers can be buttonized (@pxref{Article Washing}).
18187
18188 @item
18189 All mail backends support fetching articles by @code{Message-ID}.
18190
18191 @item
18192 Duplicate mail can now be treated properly (@pxref{Duplicates}).
18193
18194 @item
18195 All summary mode commands are available directly from the article
18196 buffer (@pxref{Article Keymap}).
18197
18198 @item
18199 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
18200 Configuration}).
18201
18202 @item
18203 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
18204 @iftex
18205 @iflatex
18206 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
18207 @end iflatex
18208 @end iftex
18209
18210 @item
18211 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
18212
18213 @lisp
18214 (setq gnus-use-nocem t)
18215 @end lisp
18216
18217 @item
18218 Groups can be made permanently visible (@pxref{Listing Groups}).
18219
18220 @lisp
18221 (setq gnus-permanently-visible-groups "^nnml:")
18222 @end lisp
18223
18224 @item
18225 Many new hooks have been introduced to make customizing easier.
18226
18227 @item
18228 Gnus respects the @code{Mail-Copies-To} header.
18229
18230 @item
18231 Threads can be gathered by looking at the @code{References} header
18232 (@pxref{Customizing Threading}).
18233
18234 @lisp
18235 (setq gnus-summary-thread-gathering-function
18236       'gnus-gather-threads-by-references)
18237 @end lisp
18238
18239 @item
18240 Read articles can be stored in a special backlog buffer to avoid
18241 refetching (@pxref{Article Backlog}).
18242
18243 @lisp
18244 (setq gnus-keep-backlog 50)
18245 @end lisp
18246
18247 @item
18248 A clean copy of the current article is always stored in a separate
18249 buffer to allow easier treatment.
18250
18251 @item
18252 Gnus can suggest where to save articles (@pxref{Saving Articles}).
18253
18254 @item
18255 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
18256 Articles}).
18257
18258 @lisp
18259 (setq gnus-prompt-before-saving t)
18260 @end lisp
18261
18262 @item
18263 @code{gnus-uu} can view decoded files asynchronously while fetching
18264 articles (@pxref{Other Decode Variables}).
18265
18266 @lisp
18267 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
18268 @end lisp
18269
18270 @item
18271 Filling in the article buffer now works properly on cited text
18272 (@pxref{Article Washing}).
18273
18274 @item
18275 Hiding cited text adds buttons to toggle hiding, and how much
18276 cited text to hide is now customizable (@pxref{Article Hiding}).
18277
18278 @lisp
18279 (setq gnus-cited-lines-visible 2)
18280 @end lisp
18281
18282 @item
18283 Boring headers can be hidden (@pxref{Article Hiding}).
18284
18285 @item
18286 Default scoring values can now be set from the menu bar.
18287
18288 @item
18289 Further syntax checking of outgoing articles have been added.
18290
18291 @end itemize
18292
18293
18294 @node Red Gnus
18295 @subsubsection Red Gnus
18296
18297 New features in Gnus 5.4/5.5:
18298
18299 @iftex
18300 @iflatex
18301 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
18302 @end iflatex
18303 @end iftex
18304
18305 @itemize @bullet
18306
18307 @item
18308 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
18309
18310 @item
18311 Article prefetching functionality has been moved up into
18312 Gnus (@pxref{Asynchronous Fetching}).
18313
18314 @item
18315 Scoring can now be performed with logical operators like @code{and},
18316 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
18317 Scoring}).
18318
18319 @item
18320 Article washing status can be displayed in the
18321 article mode line (@pxref{Misc Article}).
18322
18323 @item
18324 @file{gnus.el} has been split into many smaller files.
18325
18326 @item
18327 Suppression of duplicate articles based on Message-ID can be done
18328 (@pxref{Duplicate Suppression}).
18329
18330 @lisp
18331 (setq gnus-suppress-duplicates t)
18332 @end lisp
18333
18334 @item
18335 New variables for specifying what score and adapt files are to be
18336 considered home score and adapt files (@pxref{Home Score File}) have
18337 been added.
18338
18339 @item
18340 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
18341 Server Internals}).
18342
18343 @item
18344 Groups can inherit group parameters from parent topics (@pxref{Topic
18345 Parameters}).
18346
18347 @item
18348 Article editing has been revamped and is now actually usable.
18349
18350 @item
18351 Signatures can be recognized in more intelligent fashions
18352 (@pxref{Article Signature}).
18353
18354 @item
18355 Summary pick mode has been made to look more @code{nn}-like.  Line
18356 numbers are displayed and the @kbd{.} command can be used to pick
18357 articles (@code{Pick and Read}).
18358
18359 @item
18360 Commands for moving the @file{.newsrc.eld} from one server to
18361 another have been added (@pxref{Changing Servers}).
18362
18363 @item
18364 There's a way now to specify that ``uninteresting'' fields be suppressed
18365 when generating lines in buffers (@pxref{Advanced Formatting}).
18366
18367 @item
18368 Several commands in the group buffer can be undone with @kbd{M-C-_}
18369 (@pxref{Undo}).
18370
18371 @item
18372 Scoring can be done on words using the new score type @code{w}
18373 (@pxref{Score File Format}).
18374
18375 @item
18376 Adaptive scoring can be done on a Subject word-by-word basis
18377 (@pxref{Adaptive Scoring}).
18378
18379 @lisp
18380 (setq gnus-use-adaptive-scoring '(word))
18381 @end lisp
18382
18383 @item
18384 Scores can be decayed (@pxref{Score Decays}).
18385
18386 @lisp
18387 (setq gnus-decay-scores t)
18388 @end lisp
18389
18390 @item
18391 Scoring can be performed using a regexp on the Date header.  The Date is
18392 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
18393
18394 @item
18395 A new command has been added to remove all data on articles from
18396 the native server (@pxref{Changing Servers}).
18397
18398 @item
18399 A new command for reading collections of documents
18400 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
18401 (@pxref{Really Various Summary Commands}).
18402
18403 @item
18404 Process mark sets can be pushed and popped (@pxref{Setting Process
18405 Marks}).
18406
18407 @item
18408 A new mail-to-news backend makes it possible to post even when the NNTP
18409 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
18410
18411 @item
18412 A new backend for reading searches from Web search engines
18413 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
18414 (@pxref{Web Searches}).
18415
18416 @item
18417 Groups inside topics can now be sorted using the standard sorting
18418 functions, and each topic can be sorted independently (@pxref{Topic
18419 Sorting}).
18420
18421 @item
18422 Subsets of the groups can be sorted independently (@code{Sorting
18423 Groups}).
18424
18425 @item
18426 Cached articles can be pulled into the groups (@pxref{Summary Generation
18427 Commands}).
18428 @iftex
18429 @iflatex
18430 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
18431 @end iflatex
18432 @end iftex
18433
18434 @item
18435 Score files are now applied in a more reliable order (@pxref{Score
18436 Variables}).
18437
18438 @item
18439 Reports on where mail messages end up can be generated (@pxref{Splitting
18440 Mail}).
18441
18442 @item
18443 More hooks and functions have been added to remove junk from incoming
18444 mail before saving the mail (@pxref{Washing Mail}).
18445
18446 @item
18447 Emphasized text can be properly fontisized:
18448
18449 @end itemize
18450
18451
18452 @node Quassia Gnus
18453 @subsubsection Quassia Gnus
18454
18455 New features in Gnus 5.6:
18456
18457 @itemize @bullet
18458
18459 @item
18460 New functionality for using Gnus as an offline newsreader has been
18461 added.  A plethora of new commands and modes have been added.  See
18462 @pxref{Gnus Unplugged} for the full story.
18463
18464 @item
18465  The @code{nndraft} backend has returned, but works differently than
18466 before.  All Message buffers are now also articles in the @code{nndraft}
18467 group, which is created automatically.
18468
18469 @item
18470 @code{gnus-alter-header-function} can now be used to alter header
18471 values.
18472
18473 @item
18474  @code{gnus-summary-goto-article} now accept Message-ID's.
18475
18476 @item
18477  A new Message command for deleting text in the body of a message
18478 outside the region: @kbd{C-c C-v}.
18479
18480 @item
18481  You can now post to component group in @code{nnvirtual} groups with
18482 @kbd{C-u C-c C-c}.
18483
18484 @item
18485  @code{nntp-rlogin-program}---new variable to ease customization.
18486
18487 @item
18488  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
18489 re-highlighting of the article buffer.
18490
18491 @item
18492  New element in @code{gnus-boring-article-headers}---@code{long-to}.
18493
18494 @item
18495  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
18496 Prefixes" in the Gnus manual for details.
18497
18498 @item
18499  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
18500 @kbd{a} to add the score rule to the "all.SCORE" file.
18501
18502 @item
18503  @code{gnus-simplify-subject-functions} variable to allow greater
18504 control over simplification.
18505
18506 @item
18507  @kbd{A T}---new command for fetching the current thread.
18508
18509 @item
18510  @kbd{/ T}---new command for including the current thread in the
18511 limit.
18512
18513 @item
18514  @kbd{M-RET} is a new Message command for breaking cited text.
18515
18516 @item
18517  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
18518
18519 @item
18520  The @code{custom-face-lookup} function has been removed.
18521 If you used this function in your initialization files, you must
18522 rewrite them to use @code{face-spec-set} instead.
18523
18524 @item
18525  Canceling now uses the current select method.  Symbolic prefix
18526 @kbd{a} forces normal posting method.
18527
18528 @item
18529  New command to translate M******** sm*rtq**t*s into proper
18530 text---@kbd{W d}.
18531
18532 @item
18533  For easier debugging of @code{nntp}, you can set
18534 @code{nntp-record-commands} to a non-@code{nil} value.
18535
18536 @item
18537  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
18538 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
18539
18540 @item
18541  A command for editing group parameters from the summary buffer
18542 has been added.
18543
18544 @item
18545  A history of where mails have been split is available.
18546
18547 @item
18548  A new article date command has been added---@code{article-date-iso8601}.
18549
18550 @item
18551  Subjects can be simplified when threading by setting
18552 @code{gnus-score-thread-simplify}.
18553
18554 @item
18555  A new function for citing in Message has been
18556 added---@code{message-cite-original-without-signature}.
18557
18558 @item
18559  @code{article-strip-all-blank-lines}---new article command.
18560
18561 @item
18562  A new Message command to kill to the end of the article has
18563 been added.
18564
18565 @item
18566  A minimum adaptive score can be specified by using the
18567 @code{gnus-adaptive-word-minimum} variable.
18568
18569 @item
18570  The "lapsed date" article header can be kept continually
18571 updated by the @code{gnus-start-date-timer} command.
18572
18573 @item
18574  Web listserv archives can be read with the @code{nnlistserv} backend.
18575
18576 @item
18577  Old dejanews archives can now be read by @code{nnweb}.
18578
18579 @end itemize
18580
18581
18582 @node Newest Features
18583 @subsection Newest Features
18584 @cindex todo
18585
18586 Also known as the @dfn{todo list}.  Sure to be implemented before the
18587 next millennium.
18588
18589 Be afraid.  Be very afraid.
18590
18591 (That a feature appears in this list doesn't necessarily mean that I've
18592 decided to actually implement it.  It just means that I think it sounds
18593 interesting.)
18594
18595 (Yes, this is the actual, up-to-the-second todo list.)
18596
18597 @itemize @bullet
18598
18599 @item
18600  I would like the zombie-page to contain an URL to the source of the
18601 latest version of gnus or some explanation on where to find it.
18602
18603 @item
18604  A way to continue editing the latest Message composition.
18605
18606 @item
18607  http://www.sonicnet.com/feature/ari3/
18608
18609 @item
18610  facep is not declared.
18611
18612 @item
18613  Include a section in the manual on why the number of articles
18614 isn't the same in the group buffer and on the SPC prompt.
18615
18616 @item
18617  Interacting with rmail fcc isn't easy.
18618
18619 @item
18620 @example
18621  Hypermail:
18622 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
18623 <URL:http://www.eit.com/software/hypermail/hypermail.html>
18624 <URL:http://homer.ncm.com/>
18625 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
18626 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
18627 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
18628 http://www.miranova.com/gnus-list/
18629
18630 @end example
18631
18632 @item
18633 @samp{^-- } is made into - in LaTeX.
18634
18635 @item
18636  gnus-kill is much slower than it was in GNUS 4.1.3.
18637
18638 @item
18639  when expunging articles on low score, the sparse nodes keep hanging on?
18640 @item
18641  starting the first time seems to hang Gnus on some systems.  Does
18642 NEWGROUPS answer too fast?
18643 @item
18644  nndir doesn't read gzipped files.
18645 @item
18646  FAQ doesn't have an up node?
18647 @item
18648  when moving mail from a procmail spool to the crash-box,
18649 the crash-box is only appropriate to one specific group.
18650 @item
18651  `t' `t' makes X-Faces disappear.
18652 @item
18653  nnmh-be-safe means that crossposted articles will
18654 be marked as unread.
18655 @item
18656  Orphan score entries don't show on "V t" score trace
18657 @item
18658  when clearing out data, the cache data should also be reset.
18659 @item
18660  rewrite gnus-summary-limit-children to be non-recursive
18661 to avoid exceeding lisp nesting on huge groups.
18662 @item
18663  expunged articles are counted when computing scores.
18664 @item
18665  implement gnus-batch-brew-soup
18666 @item
18667  ticked articles aren't easy to read in pick mode -- `n' and
18668 stuff just skips past them.  Read articles are the same.
18669 @item
18670  topics that contain just groups with ticked
18671 articles aren't displayed.
18672 @item
18673  nndoc should always allocate unique Message-IDs.
18674 @item
18675  If there are mail groups the first time you use Gnus, Gnus'll
18676 make the mail groups killed.
18677 @item
18678  no "no news is good news" when using topics.
18679 @item
18680  when doing crosspost marking, the cache has to be consulted
18681 and articles have to be removed.
18682 @item
18683  nnweb should fetch complete articles when they are split into several
18684 parts.
18685 @item
18686  scoring on head immediate doesn't work.
18687 @item
18688  finding short score file names takes forever.
18689 @item
18690  canceling articles in foreign groups.
18691 @item
18692  nntp-open-rlogin no longer works.
18693 @item
18694  C-u C-x C-s (Summary) switches to the group buffer.
18695 @item
18696  move nnmail-split-history out to the backends.
18697 @item
18698  nnweb doesn't work properly.
18699 @item
18700  using a virtual server name as `gnus-select-method' doesn't work?
18701 @item
18702  when killing/yanking a group from one topic to another in a slave, the
18703 master will yank it first to one topic and then add it to another.
18704 Perhaps.
18705
18706 @item
18707  warn user about `=' redirection of a group in the active file?
18708 @item
18709  take over the XEmacs menubar and offer a toggle between the XEmacs
18710 bar and the Gnus bar.
18711 @item
18712 @example
18713  push active file and NOV file parsing down into C code.
18714 `(canonize-message-id id)'
18715 `(mail-parent-message-id references n)'
18716 `(parse-news-nov-line &optional dependency-hashtb)'
18717 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
18718 `(parse-news-active-region beg end hashtb)'
18719
18720 @end example
18721
18722 @item
18723  nnml .overview directory with splits.
18724 @item
18725  asynchronous cache
18726 @item
18727  postponed commands.
18728 @item
18729  the selected article show have its Subject displayed in its summary line.
18730 @item
18731  when entering groups, get the real number of unread articles from
18732 the server?
18733 @item
18734  sort after gathering threads -- make false roots have the
18735 headers of the oldest orphan with a 0 article number?
18736 @item
18737  nndoc groups should inherit the score files of their parents?  Also
18738 inherit copy prompts and save files.
18739 @item
18740  command to start up Gnus (if not running) and enter a mail mode buffer.
18741 @item
18742  allow editing the group description from the group buffer
18743 for backends that support that.
18744 @item
18745 gnus-hide,show-all-topics
18746 @item
18747  groups and sub-topics should be allowed to mingle inside each topic,
18748 and not just list all subtopics at the end.
18749 @item
18750  a command to remove all read articles that are not needed to connect
18751 threads -- `gnus-summary-limit-to-sparse-unread'?
18752 @item
18753  a variable to turn off limiting/cutting of threads in the tree buffer.
18754 @item
18755  a variable to limit how many files are uudecoded.
18756 @item
18757  add zombie groups to a special "New Groups" topic.
18758 @item
18759  server mode command: close/open all connections
18760 @item
18761  put a file date in gnus-score-alist and check whether the file
18762 has been changed before using it.
18763 @item
18764  on exit from a digest group, go to the next article in the parent group.
18765 @item
18766  hide (sub)threads with low score.
18767 @item
18768  when expiring, remove all marks from expired articles.
18769 @item
18770  gnus-summary-limit-to-body
18771 @item
18772  a regexp alist that says what level groups are to be subscribed
18773 on.  Eg. -- `(("nnml:" . 1))'.
18774 @item
18775  easier interface to nnkiboze to create ephemeral groups that
18776 contain groups that match a regexp.
18777 @item
18778  allow newlines in <URL:> urls, but remove them before using
18779 the URL.
18780 @item
18781  If there is no From line, the mail backends should fudge one from the
18782 "From " line.
18783 @item
18784  fuzzy simplifying should strip all non-alpha-numerical info
18785 from subject lines.
18786 @item
18787  gnus-soup-brew-soup-with-high-scores.
18788 @item
18789  nntp-ping-before-connect
18790 @item
18791  command to check whether NOV is evil.  "list overview.fmt".
18792 @item
18793  when entering a group, Gnus should look through the score
18794 files very early for `local' atoms and set those local variables.
18795 @item
18796  message annotations.
18797 @item
18798  topics are always yanked before groups, and that's not good.
18799 @item
18800  (set-extent-property extent 'help-echo "String to display in minibuf")
18801 to display help in the minibuffer on buttons under XEmacs.
18802 @item
18803  allow group line format spec to say how many articles there
18804 are in the cache.
18805 @item
18806  AUTHINFO GENERIC
18807 @item
18808  `run-with-idle-timer' in gnus-demon.
18809 @item
18810  stop using invisible text properties and start using overlays instead
18811 @item
18812  C-c C-f C-e to add an Expires header.
18813 @item
18814  go from one group to the next; everything is expunged; go to the
18815 next group instead of going to the group buffer.
18816 @item
18817  gnus-renumber-cache -- to renumber the cache using "low" numbers.
18818 @item
18819  record topic changes in the dribble buffer.
18820 @item
18821  `nnfolder-generate-active-file' should look at the folders it
18822 finds and generate proper active ranges.
18823 @item
18824  nneething-look-in-files-for-article-heads variable to control
18825 whether nneething should sniff all files in the directories.
18826 @item
18827  gnus-fetch-article -- start Gnus, enter group, display article
18828 @item
18829  gnus-dont-move-articles-to-same-group variable when respooling.
18830 @item
18831  when messages are crossposted between several auto-expirable groups,
18832 articles aren't properly marked as expirable.
18833 @item
18834  nneething should allow deletion/moving.
18835 @item
18836  TAB on the last button should go to the first button.
18837 @item
18838  if the car of an element in `mail-split-methods' is a function,
18839 and the function returns non-nil, use that as the name of the group(s) to
18840 save mail in.
18841 @item
18842  command for listing all score files that have been applied.
18843 @item
18844  a command in the article buffer to return to `summary' config.
18845 @item
18846  `gnus-always-post-using-current-server' -- variable to override
18847 `C-c C-c' when posting.
18848 @item
18849  nnmail-group-spool-alist -- says where each group should use
18850 as a spool file.
18851 @item
18852  when an article is crossposted to an auto-expirable group, the article
18853 should be marker as expirable.
18854 @item
18855  article mode command/menu for "send region as URL to browser".
18856 @item
18857  on errors, jump to info nodes that explain the error.  For instance,
18858 on invalid From headers, or on error messages from the nntp server.
18859 @item
18860  when gathering threads, make the article that has no "Re: " the parent.
18861 Also consult Date headers.
18862 @item
18863  a token in splits to call shrink-window-if-larger-than-buffer
18864 @item
18865  `1 0 A M' to do matches on the active hashtb.
18866 @item
18867  duplicates -- command to remove Gnus-Warning header, use the read
18868 Message-ID, delete the "original".
18869 @item
18870  when replying to several messages at once, put the "other" message-ids
18871 into a See-Also header.
18872 @item
18873  support setext: URL:http://www.bsdi.com/setext/
18874 @item
18875  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
18876 @item
18877  when browsing a foreign server, the groups that are already subscribed
18878 should be listed as such and not as "K".
18879 @item
18880  generate font names dynamically.
18881 @item
18882  score file mode auto-alist.
18883 @item
18884  allow nndoc to change/add/delete things from documents.  Implement
18885 methods for each format for adding an article to the document.
18886 @item
18887  `gnus-fetch-old-headers' `all' value to incorporate
18888 absolutely all headers there is.
18889 @item
18890  function like `|', but concatenate all marked articles
18891 and pipe them to the process.
18892 @item
18893  cache the list of killed (or active) groups in a separate file.  Update
18894 the file whenever we read the active file or the list
18895 of killed groups in the .eld file reaches a certain length.
18896 @item
18897  function for starting to edit a file to put into
18898 the current mail group.
18899 @item
18900  score-find-trace should display the total score of the article.
18901 @item
18902  "ghettozie" -- score on Xref header and nix it out after using it
18903 to avoid marking as read in other groups it has been crossposted to.
18904 @item
18905  look at procmail splitting.  The backends should create
18906 the groups automatically if a spool file exists for that group.
18907 @item
18908  function for backends to register themselves with Gnus.
18909 @item
18910  when replying to several process-marked articles,
18911 have all the From end up in Cc headers?  Variable to toggle.
18912 @item
18913  command to delete a crossposted mail article from all
18914 groups it has been mailed to.
18915 @item
18916  `B c' and `B m' should be crosspost aware.
18917 @item
18918  hide-pgp should also hide PGP public key blocks.
18919 @item
18920  Command in the group buffer to respool process-marked groups.
18921 @item
18922  `gnus-summary-find-matching' should accept
18923 pseudo-"headers" like "body", "head" and "all"
18924 @item
18925  When buttifying <URL: > things, all white space (including
18926 newlines) should be ignored.
18927 @item
18928  Process-marking all groups in a topic should process-mark
18929 groups in subtopics as well.
18930 @item
18931  Add non-native groups to the list of killed groups when killing them.
18932 @item
18933  nntp-suggest-kewl-config to probe the nntp server and suggest
18934 variable settings.
18935 @item
18936  add edit and forward secondary marks.
18937 @item
18938  nnml shouldn't visit its .overview files.
18939 @item
18940  allow customizing sorting within gathered threads.
18941 @item
18942  `B q' shouldn't select the current article.
18943 @item
18944  nnmbox should support a newsgroups file for descriptions.
18945 @item
18946  allow fetching mail from several pop servers.
18947 @item
18948  Be able to specify whether the saving commands save the original
18949 or the formatted article.
18950 @item
18951  a command to reparent with the child process-marked (cf. `T ^'.).
18952 @item
18953  I think the possibility to send a password with nntp-open-rlogin
18954 should be a feature in Red Gnus.
18955 @item
18956  The `Z n' command should be possible to execute from a mouse click.
18957 @item
18958  more limiting functions -- date, etc.
18959 @item
18960  be able to limit on a random header; on body; using reverse matches.
18961 @item
18962  a group parameter (`absofucking-total-expiry') that will make Gnus expire
18963 even unread articles.
18964 @item
18965  a command to print the article buffer as postscript.
18966 @item
18967  variable to disable password fetching when opening by nntp-open-telnet.
18968 @item
18969  manual: more example servers -- nntp with rlogin, telnet
18970 @item
18971  checking for bogus groups should clean topic alists as well.
18972 @item
18973  canceling articles in foreign groups.
18974 @item
18975  article number in folded topics isn't properly updated by
18976 Xref handling.
18977 @item
18978  Movement in the group buffer to the next unread group should go to the
18979 next closed topic with unread messages if no group can be found.
18980 @item
18981  Extensive info pages generated on the fly with help everywhere --
18982 in the "*Gnus edit*" buffers, for instance.
18983 @item
18984  Topic movement commands -- like thread movement.  Up, down, forward, next.
18985 @item
18986  a way to tick/mark as read Gcc'd articles.
18987 @item
18988  a way to say that all groups within a specific topic comes
18989 from a particular server?  Hm.
18990 @item
18991  `gnus-article-fill-if-long-lines' -- a function to fill
18992 the article buffer if there are any looong lines there.
18993 @item
18994  `T h' should jump to the parent topic and fold it.
18995 @item
18996  a command to create an ephemeral nndoc group out of a file,
18997 and then splitting it/moving it to some other group/backend.
18998 @item
18999  a group parameter for nnkiboze groups that says that
19000 all kibozed articles should be entered into the cache.
19001 @item
19002  It should also probably be possible to delimit what
19003 `gnus-jog-cache' does -- for instance, work on just some groups, or on
19004 some levels, and entering just articles that have a score higher than
19005 a certain number.
19006 @item
19007  nnfolder should append to the folder instead of re-writing
19008 the entire folder to disk when accepting new messages.
19009 @item
19010  allow all backends to do the proper thing with .gz files.
19011 @item
19012  a backend for reading collections of babyl files nnbabylfolder?
19013 @item
19014  a command for making the native groups into foreign groups.
19015 @item
19016  server mode command for clearing read marks from all groups
19017 from a server.
19018 @item
19019  when following up multiple articles, include all To, Cc, etc headers
19020 from all articles.
19021 @item
19022  a command for deciding what the total score of the current
19023 thread is.  Also a way to highlight based on this.
19024 @item
19025  command to show and edit group scores
19026 @item
19027  a gnus-tree-minimize-horizontal to minimize tree buffers
19028 horizontally.
19029 @item
19030  command to generate nnml overview file for one group.
19031 @item
19032  `C-u C-u a' -- prompt for many crossposted groups.
19033 @item
19034  keep track of which mail groups have received new articles (in this session).
19035 Be able to generate a report and perhaps do some marking in the group
19036 buffer.
19037 @item
19038  gnus-build-sparse-threads to a number -- build only sparse threads
19039 that are of that length.
19040 @item
19041  have nnmh respect mh's unseen sequence in .mh_profile.
19042 @item
19043  cache the newsgroups descriptions locally.
19044 @item
19045  asynchronous posting under nntp.
19046 @item
19047  be able to control word adaptive scoring from the score files.
19048 @item
19049  a variable to make `C-c C-c' post using the "current" select method.
19050 @item
19051  `limit-exclude-low-scored-articles'.
19052 @item
19053  if `gnus-summary-show-thread' is a number, hide threads that have
19054 a score lower than this number.
19055 @item
19056  split newsgroup subscription variable up into "order" and "method".
19057 @item
19058  buttonize ange-ftp file names.
19059 @item
19060  a command to make a duplicate copy of the current article
19061 so that each copy can be edited separately.
19062 @item
19063  nnweb should allow fetching from the local nntp server.
19064 @item
19065  record the sorting done in the summary buffer so that
19066 it can be repeated when limiting/regenerating the buffer.
19067 @item
19068  nnml-generate-nov-databses should generate for
19069 all nnml servers.
19070 @item
19071  when the user does commands in the group buffer, check
19072 the modification time of the .newsrc.eld file and use
19073 ask-user-about-supersession-threat.  Also warn when trying
19074 to save .newsrc.eld and it has changed.
19075 @item
19076  M-g on a topic will display all groups with 0 articles in
19077 the topic.
19078 @item
19079  command to remove all topic stuff.
19080 @item
19081  allow exploding incoming digests when reading incoming mail
19082 and splitting the resulting digests.
19083 @item
19084  nnsoup shouldn't set the `message-' variables.
19085 @item
19086  command to nix out all nnoo state information.
19087 @item
19088  nnmail-process-alist that calls functions if group names
19089 matches an alist -- before saving.
19090 @item
19091  use buffer-invisibility-spec everywhere for hiding text.
19092 @item
19093  variable to activate each group before entering them
19094 to get the (new) number of articles.  `gnus-activate-before-entering'.
19095 @item
19096  command to fetch a Message-ID from any buffer, even
19097 starting Gnus first if necessary.
19098 @item
19099  when posting and checking whether a group exists or not, just
19100 ask the nntp server instead of relying on the active hashtb.
19101 @item
19102  buttonize the output of `C-c C-a' in an apropos-like way.
19103 @item
19104  `G p' should understand process/prefix, and allow editing
19105 of several groups at once.
19106 @item
19107  command to create an ephemeral nnvirtual group that
19108 matches some regexp(s).
19109 @item
19110  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
19111 @item
19112  it should be possible to score "thread" on the From header.
19113 @item
19114  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
19115 @item
19116  `B i' should display the article at once in the summary buffer.
19117 @item
19118  remove the "*" mark at once when unticking an article.
19119 @item
19120  `M-s' should highlight the matching text.
19121 @item
19122  when checking for duplicated mails, use Resent-Message-ID if present.
19123 @item
19124  killing and yanking groups in topics should be better.  If killing one copy
19125 of a group that exists in multiple topics, only that copy should
19126 be removed.  Yanking should insert the copy, and yanking topics
19127 should be possible to be interspersed with the other yankings.
19128 @item
19129  command for enter a group just to read the cached articles.  A way to say
19130 "ignore the nntp connection; just read from the cache."
19131 @item
19132  `X u' should decode base64 articles.
19133 @item
19134  a way to hide all "inner" cited text, leaving just the most
19135 recently cited text.
19136 @item
19137  nnvirtual should be asynchronous.
19138 @item
19139  after editing an article, gnus-original-article-buffer should
19140 be invalidated.
19141 @item
19142  there should probably be a way to make Gnus not connect to the
19143 server and just read the articles in the server
19144 @item
19145  allow a `set-default' (or something) to change the default
19146 value of nnoo variables.
19147 @item
19148  a command to import group infos from a .newsrc.eld file.
19149 @item
19150  groups from secondary servers have the entire select method
19151 listed in each group info.
19152 @item
19153  a command for just switching from the summary buffer to the group
19154 buffer.
19155 @item
19156  a way to specify that some incoming mail washing functions
19157 should only be applied to some groups.
19158 @item
19159  Message `C-f C-t' should ask the user whether to heed
19160 mail-copies-to: never.
19161 @item
19162  new group parameter -- `post-to-server' that says to post
19163 using the current server.  Also a variable to do the same.
19164 @item
19165  the slave dribble files should auto-save to the slave file names.
19166 @item
19167  a group parameter that says what articles to display on group entry, based
19168 on article marks.
19169 @item
19170  a way to visually distinguish slave Gnusae from masters.  (Whip instead
19171 of normal logo?)
19172 @item
19173  Use DJ Bernstein "From " quoting/dequoting, where applicable.
19174 @item
19175  Why is hide-citation-maybe and hide-citation different?  Also
19176 clear up info.
19177 @item
19178  group user-defined meta-parameters.
19179
19180
19181
19182 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
19183 @item
19184  I like the option for trying to retrieve the FAQ for a group and I was
19185 thinking it would be great if for those newsgroups that had archives
19186 you could also try to read the archive for that group.  Part of the
19187 problem is that archives are spread all over the net, unlike FAQs.
19188 What would be best I suppose is to find the one closest to your site.
19189
19190 In any case, there is a list of general news group archives at @*
19191 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
19192
19193
19194
19195
19196 @item
19197 @example
19198 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
19199 (add-hook 'gnus-select-group-hook
19200   (lambda ()
19201     (gnus-group-add-parameter group
19202        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
19203
19204 (defun gnus-user-format-function-d (headers)
19205   "Return the date the group was last read."
19206   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
19207       (t "")))
19208 @end example
19209
19210 @item
19211  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
19212 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
19213 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
19214 hatt forskjellige serveres startup-filer forskjellige steder.
19215
19216
19217 @item
19218 LMI> Well, nnbabyl could alter the group info to heed labels like
19219 LMI> answered and read, I guess.
19220
19221 It could also keep them updated (the same for the Status: header of
19222 unix mbox files).
19223
19224 They could be used like this:
19225
19226
19227 @example
19228 `M l <name> RET' add label <name> to current message.
19229 `M u <name> RET' remove label <name> from current message.
19230 `/ l <expr> RET' limit summary buffer according to <expr>.
19231
19232 <expr> would be a boolean expression on the labels, e.g.
19233
19234 `/ l bug & !fixed RET'
19235 @end example
19236
19237 would show all the messages which are labeled `bug' but not labeled
19238 `fixed'.
19239
19240 One could also imagine the labels being used for highlighting, or
19241 affect the summary line format.
19242
19243
19244 @item
19245 Sender: abraham@@dina.kvl.dk
19246
19247 I'd like a gnus-find-file which work like find file, except that it
19248 would recognize things that looks like messages or folders:
19249
19250 - If it is a directory containing numbered files, create an nndir
19251 summary buffer.
19252
19253 - For other directories, create a nneething summary buffer.
19254
19255 - For files matching "\\`From ", create a nndoc/mbox summary.
19256
19257 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
19258
19259 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
19260
19261 - For other files, just find them normally.
19262
19263 I'd like `nneething' to use this function, so it would work on a
19264 directory potentially containing mboxes or babyl files.
19265
19266 @item
19267 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
19268 tell him what you are doing.
19269
19270 @item
19271 Currently, I get prompted:
19272
19273 decend into sci?
19274 - type y
19275 decend into sci.something ?
19276 - type n
19277 decend into ucd?
19278
19279 The problem above is that since there is really only one subsection of
19280 science, shouldn't it prompt you for only descending sci.something?  If
19281 there was a sci.somethingelse group or section, then it should prompt
19282 for sci? first the sci.something? then sci.somethingelse?...
19283
19284 @item
19285 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
19286 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
19287 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
19288 "no.all.SCORE", osv.
19289
19290 @item
19291 What i want is for Gnus to treat any sequence or combination of the following
19292 as a single spoiler warning and hide it all, replacing it with a "Next Page"
19293 button:
19294
19295
19296 ^L's
19297
19298 more than n blank lines
19299
19300 more than m identical lines
19301 (which should be replaced with button to show them)
19302
19303 any whitespace surrounding any of the above
19304
19305
19306 @item
19307 Well, we could allow a new value to `gnus-thread-ignore-subject' --
19308 `spaces', or something.  (We could even default to that.)  And then
19309 subjects that differ in white space only could be considered the
19310 "same" subject for threading purposes.
19311
19312 @item
19313 Modes to preprocess the contents (e.g. jka-compr) use the second form
19314 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
19315 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
19316 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
19317
19318 @item
19319  Under XEmacs -- do funny article marks:
19320 tick - thumb tack
19321 killed - skull
19322 soup - bowl of soup
19323 score below - dim light bulb
19324 score over - bright light bulb
19325
19326 @item
19327 Yes. I think the algorithm is as follows:
19328
19329 @example
19330 Group-mode
19331
19332    show-list-of-articles-in-group
19333         if (key-pressed == SPACE)
19334                 if (no-more-articles-in-group-to-select)
19335                         if (articles-selected)
19336                                 start-reading-selected-articles;
19337                         junk-unread-articles;
19338                         next-group;
19339                  else
19340                         show-next-page;
19341
19342          else if (key-pressed = '.')
19343                 if (consolidated-menus)         # same as hide-thread in Gnus
19344                         select-thread-under-cursor;
19345                 else
19346                         select-article-under-cursor;
19347
19348
19349 Article-mode
19350         if (key-pressed == SPACE)
19351                 if (more-pages-in-article)
19352                         next-page;
19353                 else if (more-selected-articles-to-read)
19354                         next-article;
19355                 else
19356                         next-group;
19357 @end example
19358
19359 @item
19360 My precise need here would have been to limit files to Incoming*.
19361 One could think of some `nneething-only-files' variable, but I guess
19362 it would have been unacceptable if one was using many unrelated such
19363 nneething groups.
19364
19365 A more useful approach would be to, in response to the `G D' prompt, be
19366 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
19367 the top-level directory only (in case directories would be matched by
19368 the wildcard expression).
19369
19370 @item
19371 It would be nice if it also handled
19372
19373         <URL:news://sunsite.auc.dk/>
19374
19375 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
19376
19377
19378 @item
19379
19380   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
19381 really well.  Each menu is 'named' by a symbol that would be on a
19382 gnus-*-menus (where * would be whatever, but at least group, summary, and
19383 article versions) variable.
19384
19385   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
19386
19387   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
19388 the main menubar.  This approach works really well for Emacs-W3 and VM.
19389
19390
19391 @item
19392  nndoc should take care to create unique Message-IDs for all its
19393 articles.
19394 @item
19395  gnus-score-followup-article only works when you have a summary buffer
19396 active.  Make it work when posting from the group buffer as well.
19397 (message-sent-hook).
19398 @item
19399  rewrite gnus-demon to use run-with-idle-timers.
19400
19401 @item
19402  * Enhancements to Gnus:
19403
19404   Add two commands:
19405
19406   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
19407     straight to the server buffer, without opening any connections to
19408     servers first.
19409
19410   * gnus-server-read-server-newsrc--produces a buffer very similar to
19411     the group buffer, but with only groups from that server listed;
19412     quitting this buffer returns to the server buffer.
19413
19414 @item
19415  add a command to check the integrity of an nnfolder folder --
19416 go through the article numbers and see that there are no duplicates,
19417 and stuff.
19418
19419 @item
19420  `unsmileyfy-buffer' to undo smileification.
19421
19422 @item
19423  a command to give all relevant info on an article, including all
19424 secondary marks.
19425
19426 @item
19427  when doing `-request-accept-article', the backends should do
19428 the nnmail duplicate checking.
19429
19430 @item
19431  allow `message-signature-file' to be a function to return the
19432 value of the signature file.
19433
19434 @item
19435  In addition, I would love it if I could configure message-tab so that it
19436 could call `bbdb-complete-name' in other headers.  So, some sort of
19437 interface like
19438
19439 (setq message-tab-alist
19440       '((message-header-regexp message-expand-group)
19441         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
19442
19443 then you could run the relevant function to complete the information in
19444 the header
19445
19446 @item
19447  cache the newsgroups file locally to avoid reloading it all the time.
19448
19449 @item
19450  a command to import a buffer into a group.
19451
19452 @item
19453  nnweb should allow fetching by Message-ID from servers.
19454
19455 @item
19456  point in the article buffer doesn't always go to the
19457 beginning of the buffer when selecting new articles.
19458
19459 @item
19460  a command to process mark all unread articles.
19461
19462 @item
19463  `gnus-gather-threads-by-references-and-subject' -- first
19464 do gathering by references, and then go through the dummy roots and
19465 do more gathering by subject.
19466
19467 @item
19468  gnus-uu-mark-in-numerical-order -- process mark articles in
19469 article numerical order.
19470
19471 @item
19472  (gnus-thread-total-score
19473  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
19474 bind to a key.
19475
19476 @item
19477  sorting by score is wrong when using sparse threads.
19478
19479 @item
19480  a command to fetch an arbitrary article -- without having to be
19481 in the summary buffer.
19482
19483 @item
19484  a new nncvs backend.  Each group would show an article, using
19485 version branches as threading, checkin date as the date, etc.
19486
19487 @item
19488  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
19489 This filter allows one to construct advance queries on the Dejanews
19490 database such as specifying start and end dates, subject, author,
19491 and/or newsgroup name.
19492
19493 @item
19494  new Date header scoring type -- older, newer
19495
19496 @item
19497  use the summary toolbar in the article buffer.
19498
19499 @item
19500  a command to fetch all articles that are less than X days old.
19501
19502 @item
19503  in pick mode, `q' should save the list of selected articles in the
19504 group info.  The next time the group is selected, these articles
19505 will automatically get the process mark.
19506
19507 @item
19508  Isn't it possible to (also?) allow M-^ to automatically try the
19509 default server if it fails on the current server?  (controlled by a
19510 user variable, (nil, t, 'ask)).
19511
19512 @item
19513  make it possible to cancel articles using the select method for the
19514 current group.
19515
19516 @item
19517  `gnus-summary-select-article-on-entry' or something.  It'll default
19518 to t and will select whatever article decided by `gnus-auto-select-first'.
19519
19520 @item
19521  a new variable to control which selection commands should be unselecting.
19522 `first', `best', `next', `prev', `next-unread', `prev-unread' are
19523 candidates.
19524
19525 @item
19526  be able to select groups that have no articles in them
19527 to be able to post in them (using the current select method).
19528
19529 @item
19530  be able to post via DejaNews.
19531
19532 @item
19533  `x' should retain any sortings that have been performed.
19534
19535 @item
19536  allow the user to specify the precedence of the secondary marks.  Also
19537 allow them to be displayed separately.
19538
19539 @item
19540  gnus-summary-save-in-pipe should concatenate the results from
19541 the processes when doing a process marked pipe.
19542
19543 @item
19544  a new match type, like Followup, but which adds Thread matches on all
19545 articles that match a certain From header.
19546
19547 @item
19548  a function that can be read from kill-emacs-query-functions to offer
19549 saving living summary buffers.
19550
19551 @item
19552  a function for selecting a particular group which will contain
19553 the articles listed in a list of article numbers/id's.
19554
19555 @item
19556  a battery of character translation functions to translate common
19557 Mac, MS (etc) characters into ISO 8859-1.
19558
19559 @example
19560 (defun article-fix-m$word ()
19561   "Fix M$Word smartquotes in an article."
19562   (interactive)
19563   (save-excursion
19564     (let ((buffer-read-only nil))
19565       (goto-char (point-min))
19566       (while (search-forward "\221" nil t)
19567         (replace-match "`" t t))
19568       (goto-char (point-min))
19569       (while (search-forward "\222" nil t)
19570         (replace-match "'" t t))
19571       (goto-char (point-min))
19572       (while (search-forward "\223" nil t)
19573         (replace-match "\"" t t))
19574       (goto-char (point-min))
19575       (while (search-forward "\224" nil t)
19576         (replace-match "\"" t t)))))
19577 @end example
19578
19579 @item
19580 @example
19581  (add-hook 'gnus-exit-query-functions
19582 '(lambda ()
19583    (if (and (file-exists-p nnmail-spool-file)
19584             (> (nnheader-file-size nnmail-spool-file) 0))
19585        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
19586        (y-or-n-p "Are you sure you want to quit Gnus? "))))
19587 @end example
19588
19589 @item
19590  allow message-default-headers to be a function.
19591
19592 @item
19593  new Date score match types -- < > = (etc) that take floating point
19594 numbers and match on the age of the article.
19595
19596 @item
19597 @example
19598 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
19599 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
19600 >  > > buffer in the frame that it was called from =:-O
19601 >
19602 >  > Hm.  How do you start up Gnus?  From the toolbar or with
19603 >  > `M-x gnus-other-frame'?
19604 >
19605 >    I normally start it up from the toolbar; at
19606 > least that's the way I've caught it doing the
19607 > deed before.
19608 @end example
19609
19610 @item
19611  all commands that react to the process mark should push
19612 the current process mark set onto the stack.
19613
19614 @item
19615  gnus-article-hide-pgp
19616 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
19617 @example
19618 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
19619 @end example
19620 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
19621 er min type heuristikk og langt fra alles.
19622
19623 @item
19624  `gnus-subscribe-sorted' -- insert new groups where they would have been
19625 sorted to if `gnus-group-sort-function' were run.
19626
19627 @item
19628  gnus-(group,summary)-highlight should respect any `face' text props set
19629 on the lines.
19630
19631 @item
19632  use run-with-idle-timer for gnus-demon instead of the
19633 home-brewed stuff for better reliability.
19634
19635 @item
19636  add a way to select which NoCeM type to apply -- spam, troll, etc.
19637
19638 @item
19639  nndraft-request-group should tally auto-save files.
19640
19641 @item
19642  implement nntp-retry-on-break and nntp-command-timeout.
19643
19644 @item
19645  gnus-article-highlight-limit that says when not to highlight (long)
19646 articles.
19647
19648 @item
19649  (nnoo-set SERVER VARIABLE VALUE)
19650
19651 @item
19652  nn*-spool-methods
19653
19654 @item
19655  interrupitng agent fetching of articles should save articles.
19656
19657 @item
19658  command to open a digest group, and copy all the articles there to the
19659 current group.
19660
19661 @item
19662  a variable to disable article body highlights if there's more than
19663 X characters in the body.
19664
19665 @item
19666  handle 480/381 authinfo requests separately.
19667
19668 @item
19669  include the texi/dir file in the distribution.
19670
19671 @item
19672  format spec to "tab" to a position.
19673
19674 @item
19675  Move all prompting to the new `M-n' default style.
19676
19677 @item
19678  command to display all dormant articles.
19679
19680 @item
19681  gnus-auto-select-next makeover -- list of things it should do.
19682
19683 @item
19684  a score match type that adds scores matching on From if From has replied
19685 to something someone else has said.
19686
19687 @item
19688  Read Netscape discussion groups:
19689 snews://secnews.netscape.com/netscape.communicator.unix
19690
19691 @item
19692 One command to edit the original version if an article, and one to edit
19693 the displayed version.
19694
19695 @item
19696 @kbd{T v} -- make all process-marked articles the children of the
19697 current article.
19698
19699 @item
19700 Switch from initial text to the new default text mechanism.
19701
19702 @item
19703 How about making it possible to expire local articles?  Will it be
19704 possible to make various constraints on when an article can be
19705 expired, e.g. (read), (age > 14 days), or the more interesting (read
19706 & age > 14 days)?
19707
19708 @item
19709 New limit command---limit to articles that have a certain string
19710 in the head or body.
19711
19712 @item
19713 Allow breaking lengthy NNTP commands.
19714
19715 @item
19716 gnus-article-highlight-limit, to disable highlighting in big articles.
19717
19718 @item
19719 Editing an article should put the article to be edited
19720 in a special, unique buffer.
19721
19722 @item
19723 A command to send a mail to the admin-address group param.
19724
19725 @item
19726 A Date scoring type that will match if the article
19727 is less than a certain number of days old.
19728
19729 @item
19730 New spec: %~(tab 56) to put point on column 56
19731
19732 @item
19733 Allow Gnus Agent scoring to use normal score files.
19734
19735 @item
19736 Rething the Agent active file thing.  `M-g' doesn't update the active
19737 file, for instance.
19738
19739 @item
19740 With dummy roots, `^' and then selecing the first article
19741 in any other dummy thread will make Gnus highlight the
19742 dummy root instead of the first article.
19743
19744 @item
19745 Propagate all group properties (marks, article numbers, etc) up to the
19746 topics for displaying.
19747
19748 @item
19749 `n' in the group buffer with topics should go to the next group
19750 with unread articles, even if that group is hidden in a topic.
19751
19752 @item
19753 gnus-posting-styles doesn't work in drafts.
19754
19755 @item
19756 gnus-summary-limit-include-cached is slow when there are
19757 many articles in the cache, since it regenerates big parts of the
19758 summary buffer for each article.
19759
19760 @item
19761 Implement gnus-batch-brew-soup.
19762
19763 @item
19764 Group parameters and summary commands for un/subscribing to mailing
19765 lists.
19766
19767 @item
19768 Introduce nnmail-home-directory.
19769
19770 @item
19771 gnus-fetch-group and friends should exit Gnus when the user
19772 exits the group.
19773
19774 @item
19775 The jingle is only played on the second invocation of Gnus.
19776
19777 @item
19778 Bouncing articles should do MIME.
19779
19780 @item
19781 Crossposted articles should "inherit" the % or @ mark from the other
19782 groups it has been crossposted to, or something.  (Agent.)
19783
19784 @item
19785 If point is on a group that appears multiple times in topics, and
19786 you press `l', point will move to the first instance of the group.
19787
19788 @item
19789 A spec for the group line format to display the number of
19790 agent-downloaded articles in the group.
19791
19792 @item
19793 Some nntp servers never respond when posting, so there should be a
19794 timeout for all commands.
19795
19796 @item
19797 When stading on a topic line and `t'-ing, point goes to the last line.
19798 It should go somewhere else.
19799
19800 @item
19801 I'm having trouble accessing a newsgroup with a "+" in its name with
19802 Gnus.  There is a new newsgroup on msnews.microsoft.com named
19803 "microsoft.public.multimedia.directx.html+time" that I'm trying to
19804 access as
19805 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
19806 but it gives an error that it cant access the group.
19807
19808 Is the "+" character illegal in newsgroup names?  Is there any way in
19809 Gnus to work around this?  (gnus 5.6.45 - XEmacs 20.4)
19810
19811 @item
19812
19813 When `#F', do:
19814
19815 @example
19816 Subject: Answer to your mails 01.01.1999-01.05.1999
19817  --text follows this line--
19818 Sorry I killfiled you...
19819
19820 Under the subject "foo", you wrote on 01.01.1999:
19821 > bar
19822 Under the subject "foo1", you wrote on 01.01.1999:
19823 > bar 1
19824 @end example
19825
19826 @item
19827 Allow "orphan" scores in the Agent scoring.
19828
19829 @item
19830 @example
19831     - Edit article's summary line. 
19832     - End edit
19833     - Sort lines in buffer by subject
19834
19835     --> the old subject line appears in Summary buffer, not the one that was
19836     just changed to.
19837 @end example
19838
19839
19840 @item
19841 Remove list identifiers from the subject in the summary when doing `^'
19842 and the like.
19843
19844 @item
19845 Have the Agent write out articles, one by one, as it retrieves them,
19846 to avoid having to re-fetch them all if Emacs should crash while
19847 fetching. 
19848
19849 @item
19850 Solve the halting problem.
19851
19852 @c TODO
19853 @end itemize
19854
19855 @iftex
19856
19857 @page
19858 @node The Manual
19859 @section The Manual
19860 @cindex colophon
19861 @cindex manual
19862
19863 This manual was generated from a TeXinfo file and then run through
19864 either @code{texi2dvi}
19865 @iflatex
19866 or my own home-brewed TeXinfo to \LaTeX\ transformer,
19867 and then run through @code{latex} and @code{dvips}
19868 @end iflatex
19869 to get what you hold in your hands now.
19870
19871 The following conventions have been used:
19872
19873 @enumerate
19874
19875 @item
19876 This is a @samp{string}
19877
19878 @item
19879 This is a @kbd{keystroke}
19880
19881 @item
19882 This is a @file{file}
19883
19884 @item
19885 This is a @code{symbol}
19886
19887 @end enumerate
19888
19889 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
19890 mean:
19891
19892 @lisp
19893 (setq flargnoze "yes")
19894 @end lisp
19895
19896 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
19897
19898 @lisp
19899 (setq flumphel 'yes)
19900 @end lisp
19901
19902 @samp{yes} and @code{yes} are two @emph{very} different things---don't
19903 ever get them confused.
19904
19905 @iflatex
19906 @c @head
19907 Of course, everything in this manual is of vital interest, so you should
19908 read it all.  Several times.  However, if you feel like skimming the
19909 manual, look for that gnu head you should see in the margin over
19910 there---it means that what's being discussed is of more importance than
19911 the rest of the stuff.  (On the other hand, if everything is infinitely
19912 important, how can anything be more important than that?  Just one more
19913 of the mysteries of this world, I guess.)
19914 @end iflatex
19915
19916 @end iftex
19917
19918
19919 @page
19920 @node Terminology
19921 @section Terminology
19922
19923 @cindex terminology
19924 @table @dfn
19925
19926 @item news
19927 @cindex news
19928 This is what you are supposed to use this thing for---reading news.
19929 News is generally fetched from a nearby @sc{nntp} server, and is
19930 generally publicly available to everybody.  If you post news, the entire
19931 world is likely to read just what you have written, and they'll all
19932 snigger mischievously.  Behind your back.
19933
19934 @item mail
19935 @cindex mail
19936 Everything that's delivered to you personally is mail.  Some news/mail
19937 readers (like Gnus) blur the distinction between mail and news, but
19938 there is a difference.  Mail is private.  News is public.  Mailing is
19939 not posting, and replying is not following up.
19940
19941 @item reply
19942 @cindex reply
19943 Send a mail to the person who has written what you are reading.
19944
19945 @item follow up
19946 @cindex follow up
19947 Post an article to the current newsgroup responding to the article you
19948 are reading.
19949
19950 @item backend
19951 @cindex backend
19952 Gnus gets fed articles from a number of backends, both news and mail
19953 backends.  Gnus does not handle the underlying media, so to speak---this
19954 is all done by the backends.
19955
19956 @item native
19957 @cindex native
19958 Gnus will always use one method (and backend) as the @dfn{native}, or
19959 default, way of getting news.
19960
19961 @item foreign
19962 @cindex foreign
19963 You can also have any number of foreign groups active at the same time.
19964 These are groups that use non-native non-secondary backends for getting
19965 news.
19966
19967 @item secondary
19968 @cindex secondary
19969 Secondary backends are somewhere half-way between being native and being
19970 foreign, but they mostly act like they are native.
19971
19972 @item article
19973 @cindex article
19974 A message that has been posted as news.
19975
19976 @item mail message
19977 @cindex mail message
19978 A message that has been mailed.
19979
19980 @item message
19981 @cindex message
19982 A mail message or news article
19983
19984 @item head
19985 @cindex head
19986 The top part of a message, where administrative information (etc.) is
19987 put.
19988
19989 @item body
19990 @cindex body
19991 The rest of an article.  Everything not in the head is in the
19992 body.
19993
19994 @item header
19995 @cindex header
19996 A line from the head of an article.
19997
19998 @item headers
19999 @cindex headers
20000 A collection of such lines, or a collection of heads.  Or even a
20001 collection of @sc{nov} lines.
20002
20003 @item @sc{nov}
20004 @cindex nov
20005 When Gnus enters a group, it asks the backend for the headers of all
20006 unread articles in the group.  Most servers support the News OverView
20007 format, which is more compact and much faster to read and parse than the
20008 normal @sc{head} format.
20009
20010 @item level
20011 @cindex levels
20012 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
20013 that have a lower level are ``more'' subscribed than the groups with a
20014 higher level.  In fact, groups on levels 1-5 are considered
20015 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
20016 are @dfn{killed}.  Commands for listing groups and scanning for new
20017 articles will all use the numeric prefix as @dfn{working level}.
20018
20019 @item killed groups
20020 @cindex killed groups
20021 No information on killed groups is stored or updated, which makes killed
20022 groups much easier to handle than subscribed groups.
20023
20024 @item zombie groups
20025 @cindex zombie groups
20026 Just like killed groups, only slightly less dead.
20027
20028 @item active file
20029 @cindex active file
20030 The news server has to keep track of what articles it carries, and what
20031 groups exist.  All this information in stored in the active file, which
20032 is rather large, as you might surmise.
20033
20034 @item bogus groups
20035 @cindex bogus groups
20036 A group that exists in the @file{.newsrc} file, but isn't known to the
20037 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
20038 This means that the group probably doesn't exist (any more).
20039
20040 @item activating
20041 @cindex activating groups
20042 The act of asking the server for info on a group and computing the
20043 number of unread articles is called @dfn{activating the group}.
20044 Un-activated groups are listed with @samp{*} in the group buffer.
20045
20046 @item server
20047 @cindex server
20048 A machine one can connect to and get news (or mail) from.
20049
20050 @item select method
20051 @cindex select method
20052 A structure that specifies the backend, the server and the virtual
20053 server settings.
20054
20055 @item virtual server
20056 @cindex virtual server
20057 A named select method.  Since a select method defines all there is to
20058 know about connecting to a (physical) server, taking the thing as a
20059 whole is a virtual server.
20060
20061 @item washing
20062 @cindex washing
20063 Taking a buffer and running it through a filter of some sort.  The
20064 result will (more often than not) be cleaner and more pleasing than the
20065 original.
20066
20067 @item ephemeral groups
20068 @cindex ephemeral groups
20069 Most groups store data on what articles you have read.  @dfn{Ephemeral}
20070 groups are groups that will have no data stored---when you exit the
20071 group, it'll disappear into the aether.
20072
20073 @item solid groups
20074 @cindex solid groups
20075 This is the opposite of ephemeral groups.  All groups listed in the
20076 group buffer are solid groups.
20077
20078 @item sparse articles
20079 @cindex sparse articles
20080 These are article placeholders shown in the summary buffer when
20081 @code{gnus-build-sparse-threads} has been switched on.
20082
20083 @item threading
20084 @cindex threading
20085 To put responses to articles directly after the articles they respond
20086 to---in a hierarchical fashion.
20087
20088 @item root
20089 @cindex root
20090 @cindex thread root
20091 The first article in a thread is the root.  It is the ancestor of all
20092 articles in the thread.
20093
20094 @item parent
20095 @cindex parent
20096 An article that has responses.
20097
20098 @item child
20099 @cindex child
20100 An article that responds to a different article---its parent.
20101
20102 @item digest
20103 @cindex digest
20104 A collection of messages in one file.  The most common digest format is
20105 specified by RFC1153.
20106
20107 @end table
20108
20109
20110 @page
20111 @node Customization
20112 @section Customization
20113 @cindex general customization
20114
20115 All variables are properly documented elsewhere in this manual.  This
20116 section is designed to give general pointers on how to customize Gnus
20117 for some quite common situations.
20118
20119 @menu
20120 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
20121 * Slow Terminal Connection::  You run a remote Emacs.
20122 * Little Disk Space::         You feel that having large setup files is icky.
20123 * Slow Machine::              You feel like buying a faster machine.
20124 @end menu
20125
20126
20127 @node Slow/Expensive Connection
20128 @subsection Slow/Expensive @sc{nntp} Connection
20129
20130 If you run Emacs on a machine locally, and get your news from a machine
20131 over some very thin strings, you want to cut down on the amount of data
20132 Gnus has to get from the @sc{nntp} server.
20133
20134 @table @code
20135
20136 @item gnus-read-active-file
20137 Set this to @code{nil}, which will inhibit Gnus from requesting the
20138 entire active file from the server.  This file is often v.  large.  You
20139 also have to set @code{gnus-check-new-newsgroups} and
20140 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
20141 doesn't suddenly decide to fetch the active file anyway.
20142
20143 @item gnus-nov-is-evil
20144 This one has to be @code{nil}.  If not, grabbing article headers from
20145 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
20146 support @sc{xover}; Gnus will detect this by itself.
20147 @end table
20148
20149
20150 @node Slow Terminal Connection
20151 @subsection Slow Terminal Connection
20152
20153 Let's say you use your home computer for dialing up the system that runs
20154 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
20155 possible) the amount of data sent over the wires.
20156
20157 @table @code
20158
20159 @item gnus-auto-center-summary
20160 Set this to @code{nil} to inhibit Gnus from re-centering the summary
20161 buffer all the time.  If it is @code{vertical}, do only vertical
20162 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
20163 horizontal and vertical recentering.
20164
20165 @item gnus-visible-headers
20166 Cut down on the headers included in the articles to the
20167 minimum.  You can, in fact, make do without them altogether---most of the
20168 useful data is in the summary buffer, anyway.  Set this variable to
20169 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
20170
20171 Set this hook to all the available hiding commands:
20172 @lisp
20173 (setq gnus-treat-hide-headers 'head
20174       gnus-treat-hide-signature t
20175       gnus-treat-hide-citation t)
20176 @end lisp
20177
20178 @item gnus-use-full-window
20179 By setting this to @code{nil}, you can make all the windows smaller.
20180 While this doesn't really cut down much generally, it means that you
20181 have to see smaller portions of articles before deciding that you didn't
20182 want to read them anyway.
20183
20184 @item gnus-thread-hide-subtree
20185 If this is non-@code{nil}, all threads in the summary buffer will be
20186 hidden initially.
20187
20188 @item gnus-updated-mode-lines
20189 If this is @code{nil}, Gnus will not put information in the buffer mode
20190 lines, which might save some time.
20191 @end table
20192
20193
20194 @node Little Disk Space
20195 @subsection Little Disk Space
20196 @cindex disk space
20197
20198 The startup files can get rather large, so you may want to cut their
20199 sizes a bit if you are running out of space.
20200
20201 @table @code
20202
20203 @item gnus-save-newsrc-file
20204 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
20205 only save @file{.newsrc.eld}.  This means that you will not be able to
20206 use any other newsreaders than Gnus.  This variable is @code{t} by
20207 default.
20208
20209 @item gnus-read-newsrc-file
20210 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
20211 only read @file{.newsrc.eld}.  This means that you will not be able to
20212 use any other newsreaders than Gnus.  This variable is @code{t} by
20213 default.
20214
20215 @item gnus-save-killed-list
20216 If this is @code{nil}, Gnus will not save the list of dead groups.  You
20217 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
20218 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
20219 variable to @code{nil}.  This variable is @code{t} by default.
20220
20221 @end table
20222
20223
20224 @node Slow Machine
20225 @subsection Slow Machine
20226 @cindex slow machine
20227
20228 If you have a slow machine, or are just really impatient, there are a
20229 few things you can do to make Gnus run faster.
20230
20231 Set @code{gnus-check-new-newsgroups} and
20232 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
20233
20234 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
20235 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
20236 summary buffer faster.
20237
20238
20239 @page
20240 @node Troubleshooting
20241 @section Troubleshooting
20242 @cindex troubleshooting
20243
20244 Gnus works @emph{so} well straight out of the box---I can't imagine any
20245 problems, really.
20246
20247 Ahem.
20248
20249 @enumerate
20250
20251 @item
20252 Make sure your computer is switched on.
20253
20254 @item
20255 Make sure that you really load the current Gnus version.  If you have
20256 been running @sc{gnus}, you need to exit Emacs and start it up again before
20257 Gnus will work.
20258
20259 @item
20260 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
20261 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
20262 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
20263 flee}, you have some old @file{.el} files lying around.  Delete these.
20264
20265 @item
20266 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
20267 how-to.
20268
20269 @item
20270 @vindex max-lisp-eval-depth
20271 Gnus works on many recursive structures, and in some extreme (and very
20272 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
20273 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
20274 something like that.
20275 @end enumerate
20276
20277 If all else fails, report the problem as a bug.
20278
20279 @cindex bugs
20280 @cindex reporting bugs
20281
20282 @kindex M-x gnus-bug
20283 @findex gnus-bug
20284 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
20285 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
20286 me the backtrace.  I will fix bugs, but I can only fix them if you send
20287 me a precise description as to how to reproduce the bug.
20288
20289 You really can never be too detailed in a bug report.  Always use the
20290 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
20291 a 10Kb mail each time you use it, and even if you have sent me your
20292 environment 500 times before.  I don't care.  I want the full info each
20293 time.
20294
20295 It is also important to remember that I have no memory whatsoever.  If
20296 you send a bug report, and I send you a reply, and then you just send
20297 back ``No, it's not! Moron!'', I will have no idea what you are
20298 insulting me about.  Always over-explain everything.  It's much easier
20299 for all of us---if I don't have all the information I need, I will just
20300 mail you and ask for more info, and everything takes more time.
20301
20302 If the problem you're seeing is very visual, and you can't quite explain
20303 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
20304 it somewhere it can be reached, and include the URL of the picture in
20305 the bug report.
20306
20307 If you just need help, you are better off asking on
20308 @samp{gnu.emacs.gnus}.  I'm not very helpful.
20309
20310 @cindex gnu.emacs.gnus
20311 @cindex ding mailing list
20312 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
20313 Write to @samp{ding-request@@gnus.org} to subscribe.
20314
20315
20316 @page
20317 @node Gnus Reference Guide
20318 @section Gnus Reference Guide
20319
20320 It is my hope that other people will figure out smart stuff that Gnus
20321 can do, and that other people will write those smart things as well.  To
20322 facilitate that I thought it would be a good idea to describe the inner
20323 workings of Gnus.  And some of the not-so-inner workings, while I'm at
20324 it.
20325
20326 You can never expect the internals of a program not to change, but I
20327 will be defining (in some details) the interface between Gnus and its
20328 backends (this is written in stone), the format of the score files
20329 (ditto), data structures (some are less likely to change than others)
20330 and general methods of operation.
20331
20332 @menu
20333 * Gnus Utility Functions::   Common functions and variable to use.
20334 * Backend Interface::        How Gnus communicates with the servers.
20335 * Score File Syntax::        A BNF definition of the score file standard.
20336 * Headers::                  How Gnus stores headers internally.
20337 * Ranges::                   A handy format for storing mucho numbers.
20338 * Group Info::               The group info format.
20339 * Extended Interactive::     Symbolic prefixes and stuff.
20340 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
20341 * Various File Formats::     Formats of files that Gnus use.
20342 @end menu
20343
20344
20345 @node Gnus Utility Functions
20346 @subsection Gnus Utility Functions
20347 @cindex Gnus utility functions
20348 @cindex utility functions
20349 @cindex functions
20350 @cindex internal variables
20351
20352 When writing small functions to be run from hooks (and stuff), it's
20353 vital to have access to the Gnus internal functions and variables.
20354 Below is a list of the most common ones.
20355
20356 @table @code
20357
20358 @item gnus-newsgroup-name
20359 @vindex gnus-newsgroup-name
20360 This variable holds the name of the current newsgroup.
20361
20362 @item gnus-find-method-for-group
20363 @findex gnus-find-method-for-group
20364 A function that returns the select method for @var{group}.
20365
20366 @item gnus-group-real-name
20367 @findex gnus-group-real-name
20368 Takes a full (prefixed) Gnus group name, and returns the unprefixed
20369 name.
20370
20371 @item gnus-group-prefixed-name
20372 @findex gnus-group-prefixed-name
20373 Takes an unprefixed group name and a select method, and returns the full
20374 (prefixed) Gnus group name.
20375
20376 @item gnus-get-info
20377 @findex gnus-get-info
20378 Returns the group info list for @var{group}.
20379
20380 @item gnus-group-unread
20381 @findex gnus-group-unread
20382 The number of unread articles in @var{group}, or @code{t} if that is
20383 unknown.
20384
20385 @item gnus-active
20386 @findex gnus-active
20387 The active entry for @var{group}.
20388
20389 @item gnus-set-active
20390 @findex gnus-set-active
20391 Set the active entry for @var{group}.
20392
20393 @item gnus-add-current-to-buffer-list
20394 @findex gnus-add-current-to-buffer-list
20395 Adds the current buffer to the list of buffers to be killed on Gnus
20396 exit.
20397
20398 @item gnus-continuum-version
20399 @findex gnus-continuum-version
20400 Takes a Gnus version string as a parameter and returns a floating point
20401 number.  Earlier versions will always get a lower number than later
20402 versions.
20403
20404 @item gnus-group-read-only-p
20405 @findex gnus-group-read-only-p
20406 Says whether @var{group} is read-only or not.
20407
20408 @item gnus-news-group-p
20409 @findex gnus-news-group-p
20410 Says whether @var{group} came from a news backend.
20411
20412 @item gnus-ephemeral-group-p
20413 @findex gnus-ephemeral-group-p
20414 Says whether @var{group} is ephemeral or not.
20415
20416 @item gnus-server-to-method
20417 @findex gnus-server-to-method
20418 Returns the select method corresponding to @var{server}.
20419
20420 @item gnus-server-equal
20421 @findex gnus-server-equal
20422 Says whether two virtual servers are equal.
20423
20424 @item gnus-group-native-p
20425 @findex gnus-group-native-p
20426 Says whether @var{group} is native or not.
20427
20428 @item gnus-group-secondary-p
20429 @findex gnus-group-secondary-p
20430 Says whether @var{group} is secondary or not.
20431
20432 @item gnus-group-foreign-p
20433 @findex gnus-group-foreign-p
20434 Says whether @var{group} is foreign or not.
20435
20436 @item group-group-find-parameter
20437 @findex group-group-find-parameter
20438 Returns the parameter list of @var{group}.  If given a second parameter,
20439 returns the value of that parameter for @var{group}.
20440
20441 @item gnus-group-set-parameter
20442 @findex gnus-group-set-parameter
20443 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
20444
20445 @item gnus-narrow-to-body
20446 @findex gnus-narrow-to-body
20447 Narrows the current buffer to the body of the article.
20448
20449 @item gnus-check-backend-function
20450 @findex gnus-check-backend-function
20451 Takes two parameters, @var{function} and @var{group}.  If the backend
20452 @var{group} comes from supports @var{function}, return non-@code{nil}.
20453
20454 @lisp
20455 (gnus-check-backend-function "request-scan" "nnml:misc")
20456 @result{} t
20457 @end lisp
20458
20459 @item gnus-read-method
20460 @findex gnus-read-method
20461 Prompts the user for a select method.
20462
20463 @end table
20464
20465
20466 @node Backend Interface
20467 @subsection Backend Interface
20468
20469 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
20470 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
20471 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
20472 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
20473 examples of the latter we have @code{nntp-port-number} and
20474 @code{nnmbox-directory}.
20475
20476 When Gnus asks for information from a backend---say @code{nntp}---on
20477 something, it will normally include a virtual server name in the
20478 function parameters.  (If not, the backend should use the ``current''
20479 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
20480 server as its only (optional) parameter.  If this virtual server hasn't
20481 been opened, the function should fail.
20482
20483 Note that a virtual server name has no relation to some physical server
20484 name.  Take this example:
20485
20486 @lisp
20487 (nntp "odd-one"
20488       (nntp-address "ifi.uio.no")
20489       (nntp-port-number 4324))
20490 @end lisp
20491
20492 Here the virtual server name is @samp{odd-one} while the name of
20493 the physical server is @samp{ifi.uio.no}.
20494
20495 The backends should be able to switch between several virtual servers.
20496 The standard backends implement this by keeping an alist of virtual
20497 server environments that they pull down/push up when needed.
20498
20499 There are two groups of interface functions: @dfn{required functions},
20500 which must be present, and @dfn{optional functions}, which Gnus will
20501 always check for presence before attempting to call 'em.
20502
20503 All these functions are expected to return data in the buffer
20504 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
20505 unfortunately named, but we'll have to live with it.  When I talk about
20506 @dfn{resulting data}, I always refer to the data in that buffer.  When I
20507 talk about @dfn{return value}, I talk about the function value returned by
20508 the function call.  Functions that fail should return @code{nil} as the
20509 return value.
20510
20511 Some backends could be said to be @dfn{server-forming} backends, and
20512 some might be said not to be.  The latter are backends that generally
20513 only operate on one group at a time, and have no concept of ``server''
20514 -- they have a group, and they deliver info on that group and nothing
20515 more.
20516
20517 In the examples and definitions I will refer to the imaginary backend
20518 @code{nnchoke}.
20519
20520 @cindex @code{nnchoke}
20521
20522 @menu
20523 * Required Backend Functions::        Functions that must be implemented.
20524 * Optional Backend Functions::        Functions that need not be implemented.
20525 * Error Messaging::                   How to get messages and report errors.
20526 * Writing New Backends::              Extending old backends.
20527 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
20528 * Mail-like Backends::                Some tips on mail backends.
20529 @end menu
20530
20531
20532 @node Required Backend Functions
20533 @subsubsection Required Backend Functions
20534
20535 @table @code
20536
20537 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
20538
20539 @var{articles} is either a range of article numbers or a list of
20540 @code{Message-ID}s.  Current backends do not fully support either---only
20541 sequences (lists) of article numbers, and most backends do not support
20542 retrieval of @code{Message-ID}s.  But they should try for both.
20543
20544 The result data should either be HEADs or NOV lines, and the result
20545 value should either be @code{headers} or @code{nov} to reflect this.
20546 This might later be expanded to @code{various}, which will be a mixture
20547 of HEADs and NOV lines, but this is currently not supported by Gnus.
20548
20549 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
20550 headers", in some meaning of the word.  This is generally done by
20551 fetching (at most) @var{fetch-old} extra headers less than the smallest
20552 article number in @code{articles}, and filling the gaps as well.  The
20553 presence of this parameter can be ignored if the backend finds it
20554 cumbersome to follow the request.  If this is non-@code{nil} and not a
20555 number, do maximum fetches.
20556
20557 Here's an example HEAD:
20558
20559 @example
20560 221 1056 Article retrieved.
20561 Path: ifi.uio.no!sturles
20562 From: sturles@@ifi.uio.no (Sturle Sunde)
20563 Newsgroups: ifi.discussion
20564 Subject: Re: Something very droll
20565 Date: 27 Oct 1994 14:02:57 +0100
20566 Organization: Dept. of Informatics, University of Oslo, Norway
20567 Lines: 26
20568 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
20569 References: <38jdmq$4qu@@visbur.ifi.uio.no>
20570 NNTP-Posting-Host: holmenkollen.ifi.uio.no
20571 .
20572 @end example
20573
20574 So a @code{headers} return value would imply that there's a number of
20575 these in the data buffer.
20576
20577 Here's a BNF definition of such a buffer:
20578
20579 @example
20580 headers        = *head
20581 head           = error / valid-head
20582 error-message  = [ "4" / "5" ] 2number " " <error message> eol
20583 valid-head     = valid-message *header "." eol
20584 valid-message  = "221 " <number> " Article retrieved." eol
20585 header         = <text> eol
20586 @end example
20587
20588 If the return value is @code{nov}, the data buffer should contain
20589 @dfn{network overview database} lines.  These are basically fields
20590 separated by tabs.
20591
20592 @example
20593 nov-buffer = *nov-line
20594 nov-line   = 8*9 [ field <TAB> ] eol
20595 field      = <text except TAB>
20596 @end example
20597
20598 For a closer look at what should be in those fields,
20599 @pxref{Headers}.
20600
20601
20602 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
20603
20604 @var{server} is here the virtual server name.  @var{definitions} is a
20605 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
20606
20607 If the server can't be opened, no error should be signaled.  The backend
20608 may then choose to refuse further attempts at connecting to this
20609 server.  In fact, it should do so.
20610
20611 If the server is opened already, this function should return a
20612 non-@code{nil} value.  There should be no data returned.
20613
20614
20615 @item (nnchoke-close-server &optional SERVER)
20616
20617 Close connection to @var{server} and free all resources connected
20618 to it.  Return @code{nil} if the server couldn't be closed for some
20619 reason.
20620
20621 There should be no data returned.
20622
20623
20624 @item (nnchoke-request-close)
20625
20626 Close connection to all servers and free all resources that the backend
20627 have reserved.  All buffers that have been created by that backend
20628 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
20629 function is generally only called when Gnus is shutting down.
20630
20631 There should be no data returned.
20632
20633
20634 @item (nnchoke-server-opened &optional SERVER)
20635
20636 If @var{server} is the current virtual server, and the connection to the
20637 physical server is alive, then this function should return a
20638 non-@code{nil} vlue.  This function should under no circumstances
20639 attempt to reconnect to a server we have lost connection to.
20640
20641 There should be no data returned.
20642
20643
20644 @item (nnchoke-status-message &optional SERVER)
20645
20646 This function should return the last error message from @var{server}.
20647
20648 There should be no data returned.
20649
20650
20651 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
20652
20653 The result data from this function should be the article specified by
20654 @var{article}.  This might either be a @code{Message-ID} or a number.
20655 It is optional whether to implement retrieval by @code{Message-ID}, but
20656 it would be nice if that were possible.
20657
20658 If @var{to-buffer} is non-@code{nil}, the result data should be returned
20659 in this buffer instead of the normal data buffer.  This is to make it
20660 possible to avoid copying large amounts of data from one buffer to
20661 another, while Gnus mainly requests articles to be inserted directly
20662 into its article buffer.
20663
20664 If it is at all possible, this function should return a cons cell where
20665 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
20666 the article number.  This will enable Gnus to find out what the real
20667 group and article numbers are when fetching articles by
20668 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
20669 on successful article retrieval.
20670
20671
20672 @item (nnchoke-request-group GROUP &optional SERVER FAST)
20673
20674 Get data on @var{group}.  This function also has the side effect of
20675 making @var{group} the current group.
20676
20677 If @var{fast}, don't bother to return useful data, just make @var{group}
20678 the current group.
20679
20680 Here's an example of some result data and a definition of the same:
20681
20682 @example
20683 211 56 1000 1059 ifi.discussion
20684 @end example
20685
20686 The first number is the status, which should be 211.  Next is the
20687 total number of articles in the group, the lowest article number, the
20688 highest article number, and finally the group name.  Note that the total
20689 number of articles may be less than one might think while just
20690 considering the highest and lowest article numbers, but some articles
20691 may have been canceled.  Gnus just discards the total-number, so
20692 whether one should take the bother to generate it properly (if that is a
20693 problem) is left as an exercise to the reader.
20694
20695 @example
20696 group-status = [ error / info ] eol
20697 error        = [ "4" / "5" ] 2<number> " " <Error message>
20698 info         = "211 " 3* [ <number> " " ] <string>
20699 @end example
20700
20701
20702 @item (nnchoke-close-group GROUP &optional SERVER)
20703
20704 Close @var{group} and free any resources connected to it.  This will be
20705 a no-op on most backends.
20706
20707 There should be no data returned.
20708
20709
20710 @item (nnchoke-request-list &optional SERVER)
20711
20712 Return a list of all groups available on @var{server}.  And that means
20713 @emph{all}.
20714
20715 Here's an example from a server that only carries two groups:
20716
20717 @example
20718 ifi.test 0000002200 0000002000 y
20719 ifi.discussion 3324 3300 n
20720 @end example
20721
20722 On each line we have a group name, then the highest article number in
20723 that group, the lowest article number, and finally a flag.
20724
20725 @example
20726 active-file = *active-line
20727 active-line = name " " <number> " " <number> " " flags eol
20728 name        = <string>
20729 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
20730 @end example
20731
20732 The flag says whether the group is read-only (@samp{n}), is moderated
20733 (@samp{m}), is dead (@samp{x}), is aliased to some other group
20734 (@samp{=other-group}) or none of the above (@samp{y}).
20735
20736
20737 @item (nnchoke-request-post &optional SERVER)
20738
20739 This function should post the current buffer.  It might return whether
20740 the posting was successful or not, but that's not required.  If, for
20741 instance, the posting is done asynchronously, it has generally not been
20742 completed by the time this function concludes.  In that case, this
20743 function should set up some kind of sentinel to beep the user loud and
20744 clear if the posting could not be completed.
20745
20746 There should be no result data from this function.
20747
20748 @end table
20749
20750
20751 @node Optional Backend Functions
20752 @subsubsection Optional Backend Functions
20753
20754 @table @code
20755
20756 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
20757
20758 @var{groups} is a list of groups, and this function should request data
20759 on all those groups.  How it does it is of no concern to Gnus, but it
20760 should attempt to do this in a speedy fashion.
20761
20762 The return value of this function can be either @code{active} or
20763 @code{group}, which says what the format of the result data is.  The
20764 former is in the same format as the data from
20765 @code{nnchoke-request-list}, while the latter is a buffer full of lines
20766 in the same format as @code{nnchoke-request-group} gives.
20767
20768 @example
20769 group-buffer = *active-line / *group-status
20770 @end example
20771
20772
20773 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
20774
20775 A Gnus group info (@pxref{Group Info}) is handed to the backend for
20776 alterations.  This comes in handy if the backend really carries all the
20777 information (as is the case with virtual and imap groups).  This
20778 function should destructively alter the info to suit its needs, and
20779 should return the (altered) group info.
20780
20781 There should be no result data from this function.
20782
20783
20784 @item (nnchoke-request-type GROUP &optional ARTICLE)
20785
20786 When the user issues commands for ``sending news'' (@kbd{F} in the
20787 summary buffer, for instance), Gnus has to know whether the article the
20788 user is following up on is news or mail.  This function should return
20789 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
20790 is mail and @code{unknown} if the type can't be decided.  (The
20791 @var{article} parameter is necessary in @code{nnvirtual} groups which
20792 might very well combine mail groups and news groups.)  Both @var{group}
20793 and @var{article} may be @code{nil}.
20794
20795 There should be no result data from this function.
20796
20797
20798 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
20799
20800 Set/remove/add marks on articles. Normally Gnus handles the article
20801 marks (such as read, ticked, expired etc) internally, and store them in
20802 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
20803 information about the articles on the server, so Gnus need to propagate
20804 the mark information to the server.
20805
20806 ACTION is a list of mark setting requests, having this format:
20807
20808 @example
20809 (RANGE ACTION MARK)
20810 @end example
20811
20812 Range is a range of articles you wish to update marks on. Action is
20813 @code{set}, @code{add} or @code{del}, respectively used for removing all
20814 existing marks and setting them as specified, adding (preserving the
20815 marks not mentioned) mark and removing (preserving the marks not
20816 mentioned) marks. Mark is a list of marks; where each mark is a
20817 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
20818 @code{expire}, @code{killed}, @code{dormant}, @code{save},
20819 @code{download} and @code{unsend}, but your backend should, if possible,
20820 not limit itself to theese.
20821
20822 Given contradictory actions, the last action in the list should be the
20823 effective one. That is, if your action contains a request to add the
20824 @code{tick} mark on article 1 and, later in the list, a request to
20825 remove the mark on the same article, the mark should in fact be removed.
20826
20827 An example action list:
20828
20829 @example
20830 (((5 12 30) 'del '(tick))
20831  ((10 . 90) 'add '(read expire))
20832  ((92 94) 'del '(read)))
20833 @end example
20834
20835 The function should return a range of articles it wasn't able to set the
20836 mark on (currently not used for anything).
20837
20838 There should be no result data from this function.
20839
20840 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
20841
20842 If the user tries to set a mark that the backend doesn't like, this
20843 function may change the mark.  Gnus will use whatever this function
20844 returns as the mark for @var{article} instead of the original
20845 @var{mark}.  If the backend doesn't care, it must return the original
20846 @var{mark}, and not @code{nil} or any other type of garbage.
20847
20848 The only use for this I can see is what @code{nnvirtual} does with
20849 it---if a component group is auto-expirable, marking an article as read
20850 in the virtual group should result in the article being marked as
20851 expirable.
20852
20853 There should be no result data from this function.
20854
20855
20856 @item (nnchoke-request-scan &optional GROUP SERVER)
20857
20858 This function may be called at any time (by Gnus or anything else) to
20859 request that the backend check for incoming articles, in one way or
20860 another.  A mail backend will typically read the spool file or query the
20861 POP server when this function is invoked.  The @var{group} doesn't have
20862 to be heeded---if the backend decides that it is too much work just
20863 scanning for a single group, it may do a total scan of all groups.  It
20864 would be nice, however, to keep things local if that's practical.
20865
20866 There should be no result data from this function.
20867
20868
20869 @item (nnchoke-request-group-description GROUP &optional SERVER)
20870
20871 The result data from this function should be a description of
20872 @var{group}.
20873
20874 @example
20875 description-line = name <TAB> description eol
20876 name             = <string>
20877 description      = <text>
20878 @end example
20879
20880 @item (nnchoke-request-list-newsgroups &optional SERVER)
20881
20882 The result data from this function should be the description of all
20883 groups available on the server.
20884
20885 @example
20886 description-buffer = *description-line
20887 @end example
20888
20889
20890 @item (nnchoke-request-newgroups DATE &optional SERVER)
20891
20892 The result data from this function should be all groups that were
20893 created after @samp{date}, which is in normal human-readable date
20894 format.  The data should be in the active buffer format.
20895
20896
20897 @item (nnchoke-request-create-group GROUP &optional SERVER)
20898
20899 This function should create an empty group with name @var{group}.
20900
20901 There should be no return data.
20902
20903
20904 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
20905
20906 This function should run the expiry process on all articles in the
20907 @var{articles} range (which is currently a simple list of article
20908 numbers.)  It is left up to the backend to decide how old articles
20909 should be before they are removed by this function.  If @var{force} is
20910 non-@code{nil}, all @var{articles} should be deleted, no matter how new
20911 they are.
20912
20913 This function should return a list of articles that it did not/was not
20914 able to delete.
20915
20916 There should be no result data returned.
20917
20918
20919 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
20920 &optional LAST)
20921
20922 This function should move @var{article} (which is a number) from
20923 @var{group} by calling @var{accept-form}.
20924
20925 This function should ready the article in question for moving by
20926 removing any header lines it has added to the article, and generally
20927 should ``tidy up'' the article.  Then it should @code{eval}
20928 @var{accept-form} in the buffer where the ``tidy'' article is.  This
20929 will do the actual copying.  If this @code{eval} returns a
20930 non-@code{nil} value, the article should be removed.
20931
20932 If @var{last} is @code{nil}, that means that there is a high likelihood
20933 that there will be more requests issued shortly, so that allows some
20934 optimizations.
20935
20936 The function should return a cons where the @code{car} is the group name and
20937 the @code{cdr} is the article number that the article was entered as.
20938
20939 There should be no data returned.
20940
20941
20942 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
20943
20944 This function takes the current buffer and inserts it into @var{group}.
20945 If @var{last} in @code{nil}, that means that there will be more calls to
20946 this function in short order.
20947
20948 The function should return a cons where the @code{car} is the group name and
20949 the @code{cdr} is the article number that the article was entered as.
20950
20951 There should be no data returned.
20952
20953
20954 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
20955
20956 This function should remove @var{article} (which is a number) from
20957 @var{group} and insert @var{buffer} there instead.
20958
20959 There should be no data returned.
20960
20961
20962 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
20963
20964 This function should delete @var{group}.  If @var{force}, it should
20965 really delete all the articles in the group, and then delete the group
20966 itself.  (If there is such a thing as ``the group itself''.)
20967
20968 There should be no data returned.
20969
20970
20971 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
20972
20973 This function should rename @var{group} into @var{new-name}.  All
20974 articles in @var{group} should move to @var{new-name}.
20975
20976 There should be no data returned.
20977
20978 @end table
20979
20980
20981 @node Error Messaging
20982 @subsubsection Error Messaging
20983
20984 @findex nnheader-report
20985 @findex nnheader-get-report
20986 The backends should use the function @code{nnheader-report} to report
20987 error conditions---they should not raise errors when they aren't able to
20988 perform a request.  The first argument to this function is the backend
20989 symbol, and the rest are interpreted as arguments to @code{format} if
20990 there are multiple of them, or just a string if there is one of them.
20991 This function must always returns @code{nil}.
20992
20993 @lisp
20994 (nnheader-report 'nnchoke "You did something totally bogus")
20995
20996 (nnheader-report 'nnchoke "Could not request group %s" group)
20997 @end lisp
20998
20999 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
21000 @code{nil} back from a server, and this function returns the most
21001 recently reported message for the backend in question.  This function
21002 takes one argument---the server symbol.
21003
21004 Internally, these functions access @var{backend}@code{-status-string},
21005 so the @code{nnchoke} backend will have its error message stored in
21006 @code{nnchoke-status-string}.
21007
21008
21009 @node Writing New Backends
21010 @subsubsection Writing New Backends
21011
21012 Many backends are quite similar.  @code{nnml} is just like
21013 @code{nnspool}, but it allows you to edit the articles on the server.
21014 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
21015 and it doesn't maintain overview databases.  @code{nndir} is just like
21016 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
21017 editing articles.
21018
21019 It would make sense if it were possible to ``inherit'' functions from
21020 backends when writing new backends.  And, indeed, you can do that if you
21021 want to.  (You don't have to if you don't want to, of course.)
21022
21023 All the backends declare their public variables and functions by using a
21024 package called @code{nnoo}.
21025
21026 To inherit functions from other backends (and allow other backends to
21027 inherit functions from the current backend), you should use the
21028 following macros:
21029
21030 @table @code
21031
21032 @item nnoo-declare
21033 This macro declares the first parameter to be a child of the subsequent
21034 parameters.  For instance:
21035
21036 @lisp
21037 (nnoo-declare nndir
21038   nnml nnmh)
21039 @end lisp
21040
21041 @code{nndir} has declared here that it intends to inherit functions from
21042 both @code{nnml} and @code{nnmh}.
21043
21044 @item defvoo
21045 This macro is equivalent to @code{defvar}, but registers the variable as
21046 a public server variable.  Most state-oriented variables should be
21047 declared with @code{defvoo} instead of @code{defvar}.
21048
21049 In addition to the normal @code{defvar} parameters, it takes a list of
21050 variables in the parent backends to map the variable to when executing
21051 a function in those backends.
21052
21053 @lisp
21054 (defvoo nndir-directory nil
21055   "Where nndir will look for groups."
21056   nnml-current-directory nnmh-current-directory)
21057 @end lisp
21058
21059 This means that @code{nnml-current-directory} will be set to
21060 @code{nndir-directory} when an @code{nnml} function is called on behalf
21061 of @code{nndir}.  (The same with @code{nnmh}.)
21062
21063 @item nnoo-define-basics
21064 This macro defines some common functions that almost all backends should
21065 have.
21066
21067 @example
21068 (nnoo-define-basics nndir)
21069 @end example
21070
21071 @item deffoo
21072 This macro is just like @code{defun} and takes the same parameters.  In
21073 addition to doing the normal @code{defun} things, it registers the
21074 function as being public so that other backends can inherit it.
21075
21076 @item nnoo-map-functions
21077 This macro allows mapping of functions from the current backend to
21078 functions from the parent backends.
21079
21080 @example
21081 (nnoo-map-functions nndir
21082   (nnml-retrieve-headers 0 nndir-current-group 0 0)
21083   (nnmh-request-article 0 nndir-current-group 0 0))
21084 @end example
21085
21086 This means that when @code{nndir-retrieve-headers} is called, the first,
21087 third, and fourth parameters will be passed on to
21088 @code{nnml-retrieve-headers}, while the second parameter is set to the
21089 value of @code{nndir-current-group}.
21090
21091 @item nnoo-import
21092 This macro allows importing functions from backends.  It should be the
21093 last thing in the source file, since it will only define functions that
21094 haven't already been defined.
21095
21096 @example
21097 (nnoo-import nndir
21098   (nnmh
21099    nnmh-request-list
21100    nnmh-request-newgroups)
21101   (nnml))
21102 @end example
21103
21104 This means that calls to @code{nndir-request-list} should just be passed
21105 on to @code{nnmh-request-list}, while all public functions from
21106 @code{nnml} that haven't been defined in @code{nndir} yet should be
21107 defined now.
21108
21109 @end table
21110
21111 Below is a slightly shortened version of the @code{nndir} backend.
21112
21113 @lisp
21114 ;;; nndir.el --- single directory newsgroup access for Gnus
21115 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
21116
21117 ;;; Code:
21118
21119 (require 'nnheader)
21120 (require 'nnmh)
21121 (require 'nnml)
21122 (require 'nnoo)
21123 (eval-when-compile (require 'cl))
21124
21125 (nnoo-declare nndir
21126   nnml nnmh)
21127
21128 (defvoo nndir-directory nil
21129   "Where nndir will look for groups."
21130   nnml-current-directory nnmh-current-directory)
21131
21132 (defvoo nndir-nov-is-evil nil
21133   "*Non-nil means that nndir will never retrieve NOV headers."
21134   nnml-nov-is-evil)
21135
21136 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
21137 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
21138 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
21139
21140 (defvoo nndir-status-string "" nil nnmh-status-string)
21141 (defconst nndir-version "nndir 1.0")
21142
21143 ;;; Interface functions.
21144
21145 (nnoo-define-basics nndir)
21146
21147 (deffoo nndir-open-server (server &optional defs)
21148   (setq nndir-directory
21149         (or (cadr (assq 'nndir-directory defs))
21150             server))
21151   (unless (assq 'nndir-directory defs)
21152     (push `(nndir-directory ,server) defs))
21153   (push `(nndir-current-group
21154           ,(file-name-nondirectory (directory-file-name nndir-directory)))
21155         defs)
21156   (push `(nndir-top-directory
21157           ,(file-name-directory (directory-file-name nndir-directory)))
21158         defs)
21159   (nnoo-change-server 'nndir server defs))
21160
21161 (nnoo-map-functions nndir
21162   (nnml-retrieve-headers 0 nndir-current-group 0 0)
21163   (nnmh-request-article 0 nndir-current-group 0 0)
21164   (nnmh-request-group nndir-current-group 0 0)
21165   (nnmh-close-group nndir-current-group 0))
21166
21167 (nnoo-import nndir
21168   (nnmh
21169    nnmh-status-message
21170    nnmh-request-list
21171    nnmh-request-newgroups))
21172
21173 (provide 'nndir)
21174 @end lisp
21175
21176
21177 @node Hooking New Backends Into Gnus
21178 @subsubsection Hooking New Backends Into Gnus
21179
21180 @vindex gnus-valid-select-methods
21181 Having Gnus start using your new backend is rather easy---you just
21182 declare it with the @code{gnus-declare-backend} functions.  This will
21183 enter the backend into the @code{gnus-valid-select-methods} variable.
21184
21185 @code{gnus-declare-backend} takes two parameters---the backend name and
21186 an arbitrary number of @dfn{abilities}.
21187
21188 Here's an example:
21189
21190 @lisp
21191 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
21192 @end lisp
21193
21194 The abilities can be:
21195
21196 @table @code
21197 @item mail
21198 This is a mailish backend---followups should (probably) go via mail.
21199 @item post
21200 This is a newsish backend---followups should (probably) go via news.
21201 @item post-mail
21202 This backend supports both mail and news.
21203 @item none
21204 This is neither a post nor mail backend---it's something completely
21205 different.
21206 @item respool
21207 It supports respooling---or rather, it is able to modify its source
21208 articles and groups.
21209 @item address
21210 The name of the server should be in the virtual server name.  This is
21211 true for almost all backends.
21212 @item prompt-address
21213 The user should be prompted for an address when doing commands like
21214 @kbd{B} in the group buffer.  This is true for backends like
21215 @code{nntp}, but not @code{nnmbox}, for instance.
21216 @end table
21217
21218
21219 @node Mail-like Backends
21220 @subsubsection Mail-like Backends
21221
21222 One of the things that separate the mail backends from the rest of the
21223 backends is the heavy dependence by the mail backends on common
21224 functions in @file{nnmail.el}.  For instance, here's the definition of
21225 @code{nnml-request-scan}:
21226
21227 @lisp
21228 (deffoo nnml-request-scan (&optional group server)
21229   (setq nnml-article-file-alist nil)
21230   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
21231 @end lisp
21232
21233 It simply calls @code{nnmail-get-new-mail} with a few parameters,
21234 and @code{nnmail} takes care of all the moving and splitting of the
21235 mail.
21236
21237 This function takes four parameters.
21238
21239 @table @var
21240 @item method
21241 This should be a symbol to designate which backend is responsible for
21242 the call.
21243
21244 @item exit-function
21245 This function should be called after the splitting has been performed.
21246
21247 @item temp-directory
21248 Where the temporary files should be stored.
21249
21250 @item group
21251 This optional argument should be a group name if the splitting is to be
21252 performed for one group only.
21253 @end table
21254
21255 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
21256 save each article.  @var{backend}@code{-active-number} will be called to
21257 find the article number assigned to this article.
21258
21259 The function also uses the following variables:
21260 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
21261 this backend); and @var{backend}@code{-group-alist} and
21262 @var{backend}@code{-active-file} to generate the new active file.
21263 @var{backend}@code{-group-alist} should be a group-active alist, like
21264 this:
21265
21266 @example
21267 (("a-group" (1 . 10))
21268  ("some-group" (34 . 39)))
21269 @end example
21270
21271
21272 @node Score File Syntax
21273 @subsection Score File Syntax
21274
21275 Score files are meant to be easily parseable, but yet extremely
21276 mallable.   It was decided that something that had the same read syntax
21277 as an Emacs Lisp list would fit that spec.
21278
21279 Here's a typical score file:
21280
21281 @lisp
21282 (("summary"
21283   ("win95" -10000 nil s)
21284   ("Gnus"))
21285  ("from"
21286   ("Lars" -1000))
21287  (mark -100))
21288 @end lisp
21289
21290 BNF definition of a score file:
21291
21292 @example
21293 score-file       = "" / "(" *element ")"
21294 element          = rule / atom
21295 rule             = string-rule / number-rule / date-rule
21296 string-rule      = "(" quote string-header quote space *string-match ")"
21297 number-rule      = "(" quote number-header quote space *number-match ")"
21298 date-rule        = "(" quote date-header quote space *date-match ")"
21299 quote            = <ascii 34>
21300 string-header    = "subject" / "from" / "references" / "message-id" /
21301                    "xref" / "body" / "head" / "all" / "followup"
21302 number-header    = "lines" / "chars"
21303 date-header      = "date"
21304 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
21305                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
21306 score            = "nil" / <integer>
21307 date             = "nil" / <natural number>
21308 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
21309                    "r" / "regex" / "R" / "Regex" /
21310                    "e" / "exact" / "E" / "Exact" /
21311                    "f" / "fuzzy" / "F" / "Fuzzy"
21312 number-match     = "(" <integer> [ "" / [ space score [ "" /
21313                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
21314 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
21315 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
21316                    space date [ "" / [ space date-match-t ] ] ] ] ")"
21317 date-match-t     = "nil" / "at" / "before" / "after"
21318 atom             = "(" [ required-atom / optional-atom ] ")"
21319 required-atom    = mark / expunge / mark-and-expunge / files /
21320                    exclude-files / read-only / touched
21321 optional-atom    = adapt / local / eval
21322 mark             = "mark" space nil-or-number
21323 nil-or-number    = "nil" / <integer>
21324 expunge          = "expunge" space nil-or-number
21325 mark-and-expunge = "mark-and-expunge" space nil-or-number
21326 files            = "files" *[ space <string> ]
21327 exclude-files    = "exclude-files" *[ space <string> ]
21328 read-only        = "read-only" [ space "nil" / space "t" ]
21329 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
21330 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
21331 local            = "local" *[ space "(" <string> space <form> ")" ]
21332 eval             = "eval" space <form>
21333 space            = *[ " " / <TAB> / <NEWLINE> ]
21334 @end example
21335
21336 Any unrecognized elements in a score file should be ignored, but not
21337 discarded.
21338
21339 As you can see, white space is needed, but the type and amount of white
21340 space is irrelevant.  This means that formatting of the score file is
21341 left up to the programmer---if it's simpler to just spew it all out on
21342 one looong line, then that's ok.
21343
21344 The meaning of the various atoms are explained elsewhere in this
21345 manual (@pxref{Score File Format}).
21346
21347
21348 @node Headers
21349 @subsection Headers
21350
21351 Internally Gnus uses a format for storing article headers that
21352 corresponds to the @sc{nov} format in a mysterious fashion.  One could
21353 almost suspect that the author looked at the @sc{nov} specification and
21354 just shamelessly @emph{stole} the entire thing, and one would be right.
21355
21356 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
21357 RFC1036 to talk about lines in the head of an article (e.g.,
21358 @code{From}).  It is used by many people as a synonym for
21359 ``head''---``the header and the body''.  (That should be avoided, in my
21360 opinion.)  And Gnus uses a format internally that it calls ``header'',
21361 which is what I'm talking about here.  This is a 9-element vector,
21362 basically, with each header (ouch) having one slot.
21363
21364 These slots are, in order: @code{number}, @code{subject}, @code{from},
21365 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
21366 @code{xref}, and @code{extra}.  There are macros for accessing and
21367 setting these slots---they all have predictable names beginning with
21368 @code{mail-header-} and @code{mail-header-set-}, respectively.
21369
21370 All these slots contain strings, except the @code{extra} slot, which
21371 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
21372
21373
21374 @node Ranges
21375 @subsection Ranges
21376
21377 @sc{gnus} introduced a concept that I found so useful that I've started
21378 using it a lot and have elaborated on it greatly.
21379
21380 The question is simple: If you have a large amount of objects that are
21381 identified by numbers (say, articles, to take a @emph{wild} example)
21382 that you want to qualify as being ``included'', a normal sequence isn't
21383 very useful.  (A 200,000 length sequence is a bit long-winded.)
21384
21385 The solution is as simple as the question: You just collapse the
21386 sequence.
21387
21388 @example
21389 (1 2 3 4 5 6 10 11 12)
21390 @end example
21391
21392 is transformed into
21393
21394 @example
21395 ((1 . 6) (10 . 12))
21396 @end example
21397
21398 To avoid having those nasty @samp{(13 . 13)} elements to denote a
21399 lonesome object, a @samp{13} is a valid element:
21400
21401 @example
21402 ((1 . 6) 7 (10 . 12))
21403 @end example
21404
21405 This means that comparing two ranges to find out whether they are equal
21406 is slightly tricky:
21407
21408 @example
21409 ((1 . 5) 7 8 (10 . 12))
21410 @end example
21411
21412 and
21413
21414 @example
21415 ((1 . 5) (7 . 8) (10 . 12))
21416 @end example
21417
21418 are equal.  In fact, any non-descending list is a range:
21419
21420 @example
21421 (1 2 3 4 5)
21422 @end example
21423
21424 is a perfectly valid range, although a pretty long-winded one.  This is
21425 also valid:
21426
21427 @example
21428 (1 . 5)
21429 @end example
21430
21431 and is equal to the previous range.
21432
21433 Here's a BNF definition of ranges.  Of course, one must remember the
21434 semantic requirement that the numbers are non-descending.  (Any number
21435 of repetition of the same number is allowed, but apt to disappear in
21436 range handling.)
21437
21438 @example
21439 range           = simple-range / normal-range
21440 simple-range    = "(" number " . " number ")"
21441 normal-range    = "(" start-contents ")"
21442 contents        = "" / simple-range *[ " " contents ] /
21443                   number *[ " " contents ]
21444 @end example
21445
21446 Gnus currently uses ranges to keep track of read articles and article
21447 marks.  I plan on implementing a number of range operators in C if The
21448 Powers That Be are willing to let me.  (I haven't asked yet, because I
21449 need to do some more thinking on what operators I need to make life
21450 totally range-based without ever having to convert back to normal
21451 sequences.)
21452
21453
21454 @node Group Info
21455 @subsection Group Info
21456
21457 Gnus stores all permanent info on groups in a @dfn{group info} list.
21458 This list is from three to six elements (or more) long and exhaustively
21459 describes the group.
21460
21461 Here are two example group infos; one is a very simple group while the
21462 second is a more complex one:
21463
21464 @example
21465 ("no.group" 5 ((1 . 54324)))
21466
21467 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
21468                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
21469                 (nnml "")
21470                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
21471 @end example
21472
21473 The first element is the @dfn{group name}---as Gnus knows the group,
21474 anyway.  The second element is the @dfn{subscription level}, which
21475 normally is a small integer.  (It can also be the @dfn{rank}, which is a
21476 cons cell where the @code{car} is the level and the @code{cdr} is the
21477 score.)  The third element is a list of ranges of read articles.  The
21478 fourth element is a list of lists of article marks of various kinds.
21479 The fifth element is the select method (or virtual server, if you like).
21480 The sixth element is a list of @dfn{group parameters}, which is what
21481 this section is about.
21482
21483 Any of the last three elements may be missing if they are not required.
21484 In fact, the vast majority of groups will normally only have the first
21485 three elements, which saves quite a lot of cons cells.
21486
21487 Here's a BNF definition of the group info format:
21488
21489 @example
21490 info          = "(" group space ralevel space read
21491                 [ "" / [ space marks-list [ "" / [ space method [ "" /
21492                 space parameters ] ] ] ] ] ")"
21493 group         = quote <string> quote
21494 ralevel       = rank / level
21495 level         = <integer in the range of 1 to inf>
21496 rank          = "(" level "." score ")"
21497 score         = <integer in the range of 1 to inf>
21498 read          = range
21499 marks-lists   = nil / "(" *marks ")"
21500 marks         = "(" <string> range ")"
21501 method        = "(" <string> *elisp-forms ")"
21502 parameters    = "(" *elisp-forms ")"
21503 @end example
21504
21505 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
21506 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
21507 in pseudo-BNF.
21508
21509 If you have a Gnus info and want to access the elements, Gnus offers a
21510 series of macros for getting/setting these elements.
21511
21512 @table @code
21513 @item gnus-info-group
21514 @itemx gnus-info-set-group
21515 @findex gnus-info-group
21516 @findex gnus-info-set-group
21517 Get/set the group name.
21518
21519 @item gnus-info-rank
21520 @itemx gnus-info-set-rank
21521 @findex gnus-info-rank
21522 @findex gnus-info-set-rank
21523 Get/set the group rank (@pxref{Group Score}).
21524
21525 @item gnus-info-level
21526 @itemx gnus-info-set-level
21527 @findex gnus-info-level
21528 @findex gnus-info-set-level
21529 Get/set the group level.
21530
21531 @item gnus-info-score
21532 @itemx gnus-info-set-score
21533 @findex gnus-info-score
21534 @findex gnus-info-set-score
21535 Get/set the group score (@pxref{Group Score}).
21536
21537 @item gnus-info-read
21538 @itemx gnus-info-set-read
21539 @findex gnus-info-read
21540 @findex gnus-info-set-read
21541 Get/set the ranges of read articles.
21542
21543 @item gnus-info-marks
21544 @itemx gnus-info-set-marks
21545 @findex gnus-info-marks
21546 @findex gnus-info-set-marks
21547 Get/set the lists of ranges of marked articles.
21548
21549 @item gnus-info-method
21550 @itemx gnus-info-set-method
21551 @findex gnus-info-method
21552 @findex gnus-info-set-method
21553 Get/set the group select method.
21554
21555 @item gnus-info-params
21556 @itemx gnus-info-set-params
21557 @findex gnus-info-params
21558 @findex gnus-info-set-params
21559 Get/set the group parameters.
21560 @end table
21561
21562 All the getter functions take one parameter---the info list.  The setter
21563 functions take two parameters---the info list and the new value.
21564
21565 The last three elements in the group info aren't mandatory, so it may be
21566 necessary to extend the group info before setting the element.  If this
21567 is necessary, you can just pass on a non-@code{nil} third parameter to
21568 the three final setter functions to have this happen automatically.
21569
21570
21571 @node Extended Interactive
21572 @subsection Extended Interactive
21573 @cindex interactive
21574 @findex gnus-interactive
21575
21576 Gnus extends the standard Emacs @code{interactive} specification
21577 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
21578 Prefixes}).  Here's an example of how this is used:
21579
21580 @lisp
21581 (defun gnus-summary-increase-score (&optional score symp)
21582   (interactive (gnus-interactive "P\ny"))
21583   ...
21584   )
21585 @end lisp
21586
21587 The best thing to do would have been to implement
21588 @code{gnus-interactive} as a macro which would have returned an
21589 @code{interactive} form, but this isn't possible since Emacs checks
21590 whether a function is interactive or not by simply doing an @code{assq}
21591 on the lambda form.  So, instead we have @code{gnus-interactive}
21592 function that takes a string and returns values that are usable to
21593 @code{interactive}.
21594
21595 This function accepts (almost) all normal @code{interactive} specs, but
21596 adds a few more.
21597
21598 @table @samp
21599 @item y
21600 @vindex gnus-current-prefix-symbol
21601 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
21602 variable.
21603
21604 @item Y
21605 @vindex gnus-current-prefix-symbols
21606 A list of the current symbolic prefixes---the
21607 @code{gnus-current-prefix-symbol} variable.
21608
21609 @item A
21610 The current article number---the @code{gnus-summary-article-number}
21611 function.
21612
21613 @item H
21614 The current article header---the @code{gnus-summary-article-header}
21615 function.
21616
21617 @item g
21618 The current group name---the @code{gnus-group-group-name}
21619 function.
21620
21621 @end table
21622
21623
21624 @node Emacs/XEmacs Code
21625 @subsection Emacs/XEmacs Code
21626 @cindex XEmacs
21627 @cindex Emacsen
21628
21629 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
21630 platforms must be the primary one.  I chose Emacs.  Not because I don't
21631 like XEmacs or Mule, but because it comes first alphabetically.
21632
21633 This means that Gnus will byte-compile under Emacs with nary a warning,
21634 while XEmacs will pump out gigabytes of warnings while byte-compiling.
21635 As I use byte-compilation warnings to help me root out trivial errors in
21636 Gnus, that's very useful.
21637
21638 I've also consistently used Emacs function interfaces, but have used
21639 Gnusey aliases for the functions.  To take an example:  Emacs defines a
21640 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
21641 function.  I then define a function called @code{gnus-run-at-time} that
21642 takes the same parameters as the Emacs @code{run-at-time}.  When running
21643 Gnus under Emacs, the former function is just an alias for the latter.
21644 However, when running under XEmacs, the former is an alias for the
21645 following function:
21646
21647 @lisp
21648 (defun gnus-xmas-run-at-time (time repeat function &rest args)
21649   (start-itimer
21650    "gnus-run-at-time"
21651    `(lambda ()
21652       (,function ,@@args))
21653    time repeat))
21654 @end lisp
21655
21656 This sort of thing has been done for bunches of functions.  Gnus does
21657 not redefine any native Emacs functions while running under XEmacs---it
21658 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
21659 all over.
21660
21661 In the cases where the XEmacs function interface was obviously cleaner,
21662 I used it instead.  For example @code{gnus-region-active-p} is an alias
21663 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
21664
21665 Of course, I could have chosen XEmacs as my native platform and done
21666 mapping functions the other way around.  But I didn't.  The performance
21667 hit these indirections impose on Gnus under XEmacs should be slight.
21668
21669
21670 @node Various File Formats
21671 @subsection Various File Formats
21672
21673 @menu
21674 * Active File Format::      Information on articles and groups available.
21675 * Newsgroups File Format::  Group descriptions.
21676 @end menu
21677
21678
21679 @node Active File Format
21680 @subsubsection Active File Format
21681
21682 The active file lists all groups available on the server in
21683 question.  It also lists the highest and lowest current article numbers
21684 in each group.
21685
21686 Here's an excerpt from a typical active file:
21687
21688 @example
21689 soc.motss 296030 293865 y
21690 alt.binaries.pictures.fractals 3922 3913 n
21691 comp.sources.unix 1605 1593 m
21692 comp.binaries.ibm.pc 5097 5089 y
21693 no.general 1000 900 y
21694 @end example
21695
21696 Here's a pseudo-BNF definition of this file:
21697
21698 @example
21699 active      = *group-line
21700 group-line  = group space high-number space low-number space flag <NEWLINE>
21701 group       = <non-white-space string>
21702 space       = " "
21703 high-number = <non-negative integer>
21704 low-number  = <positive integer>
21705 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
21706 @end example
21707
21708 For a full description of this file, see the manual pages for
21709 @samp{innd}, in particular @samp{active(5)}.
21710
21711
21712 @node Newsgroups File Format
21713 @subsubsection Newsgroups File Format
21714
21715 The newsgroups file lists groups along with their descriptions.  Not all
21716 groups on the server have to be listed,  and not all groups in the file
21717 have to exist on the server.  The file is meant purely as information to
21718 the user.
21719
21720 The format is quite simple; a group name, a tab, and the description.
21721 Here's the definition:
21722
21723 @example
21724 newsgroups    = *line
21725 line          = group tab description <NEWLINE>
21726 group         = <non-white-space string>
21727 tab           = <TAB>
21728 description   = <string>
21729 @end example
21730
21731
21732 @page
21733 @node Emacs for Heathens
21734 @section Emacs for Heathens
21735
21736 Believe it or not, but some people who use Gnus haven't really used
21737 Emacs much before they embarked on their journey on the Gnus Love Boat.
21738 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
21739 region'', and ``set @code{gnus-flargblossen} to an alist where the key
21740 is a regexp that is used for matching on the group name'' are magical
21741 phrases with little or no meaning, then this appendix is for you.  If
21742 you are already familiar with Emacs, just ignore this and go fondle your
21743 cat instead.
21744
21745 @menu
21746 * Keystrokes::      Entering text and executing commands.
21747 * Emacs Lisp::      The built-in Emacs programming language.
21748 @end menu
21749
21750
21751 @node Keystrokes
21752 @subsection Keystrokes
21753
21754 @itemize @bullet
21755 @item
21756 Q: What is an experienced Emacs user?
21757
21758 @item
21759 A: A person who wishes that the terminal had pedals.
21760 @end itemize
21761
21762 Yes, when you use Emacs, you are apt to use the control key, the shift
21763 key and the meta key a lot.  This is very annoying to some people
21764 (notably @code{vi}le users), and the rest of us just love the hell out
21765 of it.  Just give up and submit.  Emacs really does stand for
21766 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
21767 may have heard from other disreputable sources (like the Emacs author).
21768
21769 The shift keys are normally located near your pinky fingers, and are
21770 normally used to get capital letters and stuff.  You probably use it all
21771 the time.  The control key is normally marked ``CTRL'' or something like
21772 that.  The meta key is, funnily enough, never marked as such on any
21773 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
21774 which is the meta key on this keyboard.  It's usually located somewhere
21775 to the left hand side of the keyboard, usually on the bottom row.
21776
21777 Now, us Emacs people don't say ``press the meta-control-m key'',
21778 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
21779 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
21780 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
21781 down the control key, and hold it down while you press @kbd{k}''.
21782 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
21783 the control key and then press @kbd{k}''.  Simple, ay?
21784
21785 This is somewhat complicated by the fact that not all keyboards have a
21786 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
21787 means ``press escape, release escape, press @kbd{k}''.  That's much more
21788 work than if you have a meta key, so if that's the case, I respectfully
21789 suggest you get a real keyboard with a meta key.  You can't live without
21790 it.
21791
21792
21793
21794 @node Emacs Lisp
21795 @subsection Emacs Lisp
21796
21797 Emacs is the King of Editors because it's really a Lisp interpreter.
21798 Each and every key you tap runs some Emacs Lisp code snippet, and since
21799 Emacs Lisp is an interpreted language, that means that you can configure
21800 any key to run any arbitrary code.  You just, like, do it.
21801
21802 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
21803 functions.  (These are byte-compiled for speed, but it's still
21804 interpreted.)  If you decide that you don't like the way Gnus does
21805 certain things, it's trivial to have it do something a different way.
21806 (Well, at least if you know how to write Lisp code.)  However, that's
21807 beyond the scope of this manual, so we are simply going to talk about
21808 some common constructs that you normally use in your @file{.emacs} file
21809 to customize Gnus.
21810
21811 If you want to set the variable @code{gnus-florgbnize} to four (4), you
21812 write the following:
21813
21814 @lisp
21815 (setq gnus-florgbnize 4)
21816 @end lisp
21817
21818 This function (really ``special form'') @code{setq} is the one that can
21819 set a variable to some value.  This is really all you need to know.  Now
21820 you can go and fill your @code{.emacs} file with lots of these to change
21821 how Gnus works.
21822
21823 If you have put that thing in your @code{.emacs} file, it will be read
21824 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
21825 start Emacs.  If you want to change the variable right away, simply say
21826 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
21827 previous ``form'', which is a simple @code{setq} statement here.
21828
21829 Go ahead---just try it, if you're located at your Emacs.  After you
21830 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
21831 is the return value of the form you @code{eval}ed.
21832
21833 Some pitfalls:
21834
21835 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
21836 that means:
21837
21838 @lisp
21839 (setq gnus-read-active-file 'some)
21840 @end lisp
21841
21842 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
21843 @samp{nntp.ifi.uio.no}'', that means:
21844
21845 @lisp
21846 (setq gnus-nntp-server "nntp.ifi.uio.no")
21847 @end lisp
21848
21849 So be careful not to mix up strings (the latter) with symbols (the
21850 former).  The manual is unambiguous, but it can be confusing.
21851
21852 @page
21853 @include gnus-faq.texi
21854
21855 @node Index
21856 @chapter Index
21857 @printindex cp
21858
21859 @node Key Index
21860 @chapter Key Index
21861 @printindex ky
21862
21863 @summarycontents
21864 @contents
21865 @bye
21866
21867 @iftex
21868 @iflatex
21869 \end{document}
21870 @end iflatex
21871 @end iftex
21872
21873 @c End: