Importing pgnus-0.34
[elisp/gnus.git-] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Pterodactyl Gnus 0.34 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
54 \newcommand{\gnusbullet}{{${\bullet}$}}
55 \newcommand{\gnusdollar}{\$}
56 \newcommand{\gnusampersand}{\&}
57 \newcommand{\gnuspercent}{\%}
58 \newcommand{\gnushash}{\#}
59 \newcommand{\gnushat}{\symbol{"5E}}
60 \newcommand{\gnusunderline}{\symbol{"5F}}
61 \newcommand{\gnusnot}{$\neg$}
62 \newcommand{\gnustilde}{\symbol{"7E}}
63 \newcommand{\gnusless}{{$<$}}
64 \newcommand{\gnusgreater}{{$>$}}
65 \newcommand{\gnusbraceleft}{{$>$}}
66 \newcommand{\gnusbraceright}{{$>$}}
67
68 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
69 \newcommand{\gnusinteresting}{
70 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
71 }
72
73 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
74
75 \newcommand{\gnuspagechapter}[1]{
76 {\mbox{}}
77 }
78
79 \newdimen{\gnusdimen}
80 \gnusdimen 0pt
81
82 \newcommand{\gnuschapter}[2]{
83 \gnuscleardoublepage
84 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
85 \chapter{#2}
86 \renewcommand{\gnussectionname}{}
87 \renewcommand{\gnuschaptername}{#2}
88 \thispagestyle{empty}
89 \hspace*{-2cm}
90 \begin{picture}(500,500)(0,0)
91 \put(480,350){\makebox(0,0)[tr]{#1}}
92 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
93 \end{picture}
94 \clearpage
95 }
96
97 \newcommand{\gnusfigure}[3]{
98 \begin{figure}
99 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
100 #3
101 \end{picture}
102 \caption{#1}
103 \end{figure}
104 }
105
106 \newcommand{\gnusicon}[1]{
107 \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}}}
108 }
109
110 \newcommand{\gnuspicon}[1]{
111 \margindex{\epsfig{figure=#1,width=2cm}}
112 }
113
114 \newcommand{\gnusxface}[2]{
115 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
116 }
117
118 \newcommand{\gnussmiley}[2]{
119 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
120 }
121
122 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
123
124 \newcommand{\gnussection}[1]{
125 \renewcommand{\gnussectionname}{#1}
126 \section{#1}
127 }
128
129 \newenvironment{codelist}%
130 {\begin{list}{}{
131 }
132 }{\end{list}}
133
134 \newenvironment{kbdlist}%
135 {\begin{list}{}{
136 \labelwidth=0cm
137 }
138 }{\end{list}}
139
140 \newenvironment{dfnlist}%
141 {\begin{list}{}{
142 }
143 }{\end{list}}
144
145 \newenvironment{stronglist}%
146 {\begin{list}{}{
147 }
148 }{\end{list}}
149
150 \newenvironment{samplist}%
151 {\begin{list}{}{
152 }
153 }{\end{list}}
154
155 \newenvironment{varlist}%
156 {\begin{list}{}{
157 }
158 }{\end{list}}
159
160 \newenvironment{emphlist}%
161 {\begin{list}{}{
162 }
163 }{\end{list}}
164
165 \newlength\gnusheadtextwidth
166 \setlength{\gnusheadtextwidth}{\headtextwidth}
167 \addtolength{\gnusheadtextwidth}{1cm}
168
169 \newpagestyle{gnuspreamble}%
170 {
171 {
172 \ifodd\count0
173 {
174 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
175 }
176 \else
177 {
178 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
179 }
180 }
181 \fi
182 }
183 }
184 {
185 \ifodd\count0
186 \mbox{} \hfill
187 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
188 \else
189 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
190 \hfill \mbox{}
191 \fi
192 }
193
194 \newpagestyle{gnusindex}%
195 {
196 {
197 \ifodd\count0
198 {
199 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
200 }
201 \else
202 {
203 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
204 }
205 \fi
206 }
207 }
208 {
209 \ifodd\count0
210 \mbox{} \hfill
211 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
212 \else
213 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
214 \hfill \mbox{}
215 \fi
216 }
217
218 \newpagestyle{gnus}%
219 {
220 {
221 \ifodd\count0
222 {
223 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
224 }
225 \else
226 {
227 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
228 }
229 \fi
230 }
231 }
232 {
233 \ifodd\count0
234 \mbox{} \hfill
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
236 \else
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
238 \hfill \mbox{}
239 \fi
240 }
241
242 \pagenumbering{roman}
243 \pagestyle{gnuspreamble}
244
245 @end iflatex
246 @end iftex
247
248 @iftex
249 @iflatex
250 \begin{titlepage}
251 {
252
253 %\addtolength{\oddsidemargin}{-5cm}
254 %\addtolength{\evensidemargin}{-5cm}
255 \parindent=0cm
256 \addtolength{\textheight}{2cm}
257
258 \gnustitle{\gnustitlename}\\
259 \rule{15cm}{1mm}\\
260 \vfill
261 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
262 \vfill
263 \rule{15cm}{1mm}\\
264 \gnusauthor{by Lars Magne Ingebrigtsen}
265 \newpage
266 }
267
268 \mbox{}
269 \vfill
270
271 \thispagestyle{empty}
272
273 Copyright \copyright{} 1995,96,97,98 Free Software Foundation, Inc.
274
275 Permission is granted to make and distribute verbatim copies of
276 this manual provided the copyright notice and this permission notice
277 are preserved on all copies.
278
279 Permission is granted to copy and distribute modified versions of this
280 manual under the conditions for verbatim copying, provided that the
281 entire resulting derived work is distributed under the terms of a
282 permission notice identical to this one.
283
284 Permission is granted to copy and distribute translations of this manual
285 into another language, under the above conditions for modified versions.
286
287 \newpage
288 \end{titlepage}
289 @end iflatex
290 @end iftex
291
292 @ifinfo
293
294 This file documents Gnus, the GNU Emacs newsreader.
295
296 Copyright (C) 1995,96 Free Software Foundation, Inc.
297
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
301
302 @ignore
303 Permission is granted to process this file through Tex and print the
304 results, provided the printed document carries copying permission
305 notice identical to this one except for the removal of this paragraph
306 (this paragraph not being relevant to the printed manual).
307
308 @end ignore
309 Permission is granted to copy and distribute modified versions of this
310 manual under the conditions for verbatim copying, provided also that the
311 entire resulting derived work is distributed under the terms of a
312 permission notice identical to this one.
313
314 Permission is granted to copy and distribute translations of this manual
315 into another language, under the above conditions for modified versions.
316 @end ifinfo
317
318 @tex
319
320 @titlepage
321 @title Pterodactyl Gnus 0.34 Manual
322
323 @author by Lars Magne Ingebrigtsen
324 @page
325
326 @vskip 0pt plus 1filll
327 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc.
328
329 Permission is granted to make and distribute verbatim copies of
330 this manual provided the copyright notice and this permission notice
331 are preserved on all copies.
332
333 Permission is granted to copy and distribute modified versions of this
334 manual under the conditions for verbatim copying, provided that the
335 entire resulting derived work is distributed under the terms of a
336 permission notice identical to this one.
337
338 Permission is granted to copy and distribute translations of this manual
339 into another language, under the above conditions for modified versions.
340
341 @end titlepage
342 @page
343
344 @end tex
345
346
347 @node Top
348 @top The Gnus Newsreader
349
350 @ifinfo
351
352 You can read news (and mail) from within Emacs by using Gnus.  The news
353 can be gotten by any nefarious means you can think of---@sc{nntp}, local
354 spool or your mbox file.  All at the same time, if you want to push your
355 luck.
356
357 This manual corresponds to Pterodactyl Gnus 0.34.
358
359 @end ifinfo
360
361 @iftex
362
363 @iflatex
364 \tableofcontents
365 \gnuscleardoublepage
366 @end iflatex
367
368 Gnus is the advanced, self-documenting, customizable, extensible
369 unreal-time newsreader for GNU Emacs.
370
371 Oops.  That sounds oddly familiar, so let's start over again to avoid
372 being accused of plagiarism:
373
374 Gnus is a message-reading laboratory.  It will let you look at just
375 about anything as if it were a newsgroup.  You can read mail with it,
376 you can browse directories with it, you can @code{ftp} with it---you can
377 even read news with it!
378
379 Gnus tries to empower people who read news the same way Emacs empowers
380 people who edit text.  Gnus sets no limits to what the user should be
381 allowed to do.  Users are encouraged to extend Gnus to make it behave
382 like they want it to behave.  A program should not control people;
383 people should be empowered to do what they want by using (or abusing)
384 the program.
385
386 @end iftex
387
388
389 @menu
390 * Starting Up::           Finding news can be a pain.
391 * The Group Buffer::      Selecting, subscribing and killing groups.
392 * The Summary Buffer::    Reading, saving and posting articles.
393 * The Article Buffer::    Displaying and handling articles.
394 * Composing Messages::    Information on sending mail and news.
395 * Select Methods::        Gnus reads all messages from various select methods.
396 * Scoring::               Assigning values to articles.
397 * Various::               General purpose settings.
398 * The End::               Farewell and goodbye.
399 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
400 * Index::                 Variable, function and concept index.
401 * Key Index::             Key Index.
402 @end menu
403
404 @node Starting Up
405 @chapter Starting Gnus
406 @cindex starting up
407
408 @kindex M-x gnus
409 @findex gnus
410 If your system administrator has set things up properly, starting Gnus
411 and reading news is extremely easy---you just type @kbd{M-x gnus} in
412 your Emacs.
413
414 @findex gnus-other-frame
415 @kindex M-x gnus-other-frame
416 If you want to start Gnus in a different frame, you can use the command
417 @kbd{M-x gnus-other-frame} instead.
418
419 If things do not go smoothly at startup, you have to twiddle some
420 variables in your @file{~/.gnus} file.  This file is similar to
421 @file{~/.emacs}, but is read when gnus starts.
422
423 If you puzzle at any terms used in this manual, please refer to the
424 terminology section (@pxref{Terminology}).
425
426 @menu
427 * Finding the News::    Choosing a method for getting news.
428 * The First Time::      What does Gnus do the first time you start it?
429 * The Server is Down::  How can I read my mail then?
430 * Slave Gnusae::        You can have more than one Gnus active at a time.
431 * Fetching a Group::    Starting Gnus just to read a group.
432 * New Groups::          What is Gnus supposed to do with new groups?
433 * Startup Files::       Those pesky startup files---@file{.newsrc}.
434 * Auto Save::           Recovering from a crash.
435 * The Active File::     Reading the active file over a slow line Takes Time.
436 * Changing Servers::    You may want to move from one server to another.
437 * Startup Variables::   Other variables you might change.
438 @end menu
439
440
441 @node Finding the News
442 @section Finding the News
443 @cindex finding news
444
445 @vindex gnus-select-method
446 @c @head
447 The @code{gnus-select-method} variable says where Gnus should look for
448 news.  This variable should be a list where the first element says
449 @dfn{how} and the second element says @dfn{where}.  This method is your
450 native method.  All groups not fetched with this method are
451 foreign groups.
452
453 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
454 you want to get your daily dosage of news from, you'd say:
455
456 @lisp
457 (setq gnus-select-method '(nntp "news.somewhere.edu"))
458 @end lisp
459
460 If you want to read directly from the local spool, say:
461
462 @lisp
463 (setq gnus-select-method '(nnspool ""))
464 @end lisp
465
466 If you can use a local spool, you probably should, as it will almost
467 certainly be much faster.
468
469 @vindex gnus-nntpserver-file
470 @cindex NNTPSERVER
471 @cindex @sc{nntp} server
472 If this variable is not set, Gnus will take a look at the
473 @code{NNTPSERVER} environment variable.  If that variable isn't set,
474 Gnus will see whether @code{gnus-nntpserver-file}
475 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
476 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
477
478 @vindex gnus-nntp-server
479 If @code{gnus-nntp-server} is set, this variable will override
480 @code{gnus-select-method}.  You should therefore set
481 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
482
483 @vindex gnus-secondary-servers
484 You can also make Gnus prompt you interactively for the name of an
485 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
486 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
487 in the @code{gnus-secondary-servers} list (if any).  You can also just
488 type in the name of any server you feel like visiting.
489
490 @findex gnus-group-browse-foreign-server
491 @kindex B (Group)
492 However, if you use one @sc{nntp} server regularly and are just
493 interested in a couple of groups from a different server, you would be
494 better served by using the @kbd{B} command in the group buffer.  It will
495 let you have a look at what groups are available, and you can subscribe
496 to any of the groups you want to.  This also makes @file{.newsrc}
497 maintenance much tidier.  @xref{Foreign Groups}.
498
499 @vindex gnus-secondary-select-methods
500 @c @head
501 A slightly different approach to foreign groups is to set the
502 @code{gnus-secondary-select-methods} variable.  The select methods
503 listed in this variable are in many ways just as native as the
504 @code{gnus-select-method} server.  They will also be queried for active
505 files during startup (if that's required), and new newsgroups that
506 appear on these servers will be subscribed (or not) just as native
507 groups are.
508
509 For instance, if you use the @code{nnmbox} backend to read your mail, you
510 would typically set this variable to
511
512 @lisp
513 (setq gnus-secondary-select-methods '((nnmbox "")))
514 @end lisp
515
516
517 @node The First Time
518 @section The First Time
519 @cindex first time usage
520
521 If no startup files exist, Gnus will try to determine what groups should
522 be subscribed by default.
523
524 @vindex gnus-default-subscribed-newsgroups
525 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
526 will subscribe you to just those groups in that list, leaving the rest
527 killed.  Your system administrator should have set this variable to
528 something useful.
529
530 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
531 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
532 here as @dfn{whatever Lars thinks you should read}.)
533
534 You'll also be subscribed to the Gnus documentation group, which should
535 help you with most common problems.
536
537 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
538 use the normal functions for handling new groups, and not do anything
539 special.
540
541
542 @node The Server is Down
543 @section The Server is Down
544 @cindex server errors
545
546 If the default server is down, Gnus will understandably have some
547 problems starting.  However, if you have some mail groups in addition to
548 the news groups, you may want to start Gnus anyway.
549
550 Gnus, being the trusting sort of program, will ask whether to proceed
551 without a native select method if that server can't be contacted.  This
552 will happen whether the server doesn't actually exist (i.e., you have
553 given the wrong address) or the server has just momentarily taken ill
554 for some reason or other.  If you decide to continue and have no foreign
555 groups, you'll find it difficult to actually do anything in the group
556 buffer.  But, hey, that's your problem.  Blllrph!
557
558 @findex gnus-no-server
559 @kindex M-x gnus-no-server
560 @c @head
561 If you know that the server is definitely down, or you just want to read
562 your mail without bothering with the server at all, you can use the
563 @code{gnus-no-server} command to start Gnus.  That might come in handy
564 if you're in a hurry as well.  This command will not attempt to contact
565 your primary server---instead, it will just activate all groups on level
566 1 and 2.  (You should preferably keep no native groups on those two
567 levels.)
568
569
570 @node Slave Gnusae
571 @section Slave Gnusae
572 @cindex slave
573
574 You might want to run more than one Emacs with more than one Gnus at the
575 same time.  If you are using different @file{.newsrc} files (e.g., if you
576 are using the two different Gnusae to read from two different servers),
577 that is no problem whatsoever.  You just do it.
578
579 The problem appears when you want to run two Gnusae that use the same
580 @code{.newsrc} file.
581
582 To work around that problem some, we here at the Think-Tank at the Gnus
583 Towers have come up with a new concept: @dfn{Masters} and
584 @dfn{slaves}.  (We have applied for a patent on this concept, and have
585 taken out a copyright on those words.  If you wish to use those words in
586 conjunction with each other, you have to send $1 per usage instance to
587 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
588 Applications}) will be much more expensive, of course.)
589
590 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
591 however you do it).  Each subsequent slave Gnusae should be started with
592 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
593 files, but instead save @dfn{slave files} that contain information only
594 on what groups have been read in the slave session.  When a master Gnus
595 starts, it will read (and delete) these slave files, incorporating all
596 information from them.  (The slave files will be read in the sequence
597 they were created, so the latest changes will have precedence.)
598
599 Information from the slave files has, of course, precedence over the
600 information in the normal (i.e., master) @code{.newsrc} file.
601
602
603 @node Fetching a Group
604 @section Fetching a Group
605 @cindex fetching a group
606
607 @findex gnus-fetch-group
608 It is sometimes convenient to be able to just say ``I want to read this
609 group and I don't care whether Gnus has been started or not''.  This is
610 perhaps more useful for people who write code than for users, but the
611 command @code{gnus-fetch-group} provides this functionality in any case.
612 It takes the group name as a parameter.
613
614
615 @node New Groups
616 @section New Groups
617 @cindex new groups
618 @cindex subscription
619
620 @vindex gnus-check-new-newsgroups
621 If you are satisfied that you really never want to see any new groups,
622 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
623 also save you some time at startup.  Even if this variable is
624 @code{nil}, you can always subscribe to the new groups just by pressing
625 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
626 is @code{ask-server} by default.  If you set this variable to
627 @code{always}, then Gnus will query the backends for new groups even
628 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
629
630 @menu
631 * Checking New Groups::      Determining what groups are new.
632 * Subscription Methods::     What Gnus should do with new groups.
633 * Filtering New Groups::     Making Gnus ignore certain new groups.
634 @end menu
635
636
637 @node Checking New Groups
638 @subsection Checking New Groups
639
640 Gnus normally determines whether a group is new or not by comparing the
641 list of groups from the active file(s) with the lists of subscribed and
642 dead groups.  This isn't a particularly fast method.  If
643 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
644 server for new groups since the last time.  This is both faster and
645 cheaper.  This also means that you can get rid of the list of killed
646 groups altogether, so you may set @code{gnus-save-killed-list} to
647 @code{nil}, which will save time both at startup, at exit, and all over.
648 Saves disk space, too.  Why isn't this the default, then?
649 Unfortunately, not all servers support this command.
650
651 I bet I know what you're thinking now: How do I find out whether my
652 server supports @code{ask-server}?  No?  Good, because I don't have a
653 fail-safe answer.  I would suggest just setting this variable to
654 @code{ask-server} and see whether any new groups appear within the next
655 few days.  If any do, then it works.  If none do, then it doesn't
656 work.  I could write a function to make Gnus guess whether the server
657 supports @code{ask-server}, but it would just be a guess.  So I won't.
658 You could @code{telnet} to the server and say @code{HELP} and see
659 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
660 it does, then it might work.  (But there are servers that lists
661 @samp{NEWGROUPS} without supporting the function properly.)
662
663 This variable can also be a list of select methods.  If so, Gnus will
664 issue an @code{ask-server} command to each of the select methods, and
665 subscribe them (or not) using the normal methods.  This might be handy
666 if you are monitoring a few servers for new groups.  A side effect is
667 that startup will take much longer, so you can meditate while waiting.
668 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
669
670
671 @node Subscription Methods
672 @subsection Subscription Methods
673
674 @vindex gnus-subscribe-newsgroup-method
675 What Gnus does when it encounters a new group is determined by the
676 @code{gnus-subscribe-newsgroup-method} variable.
677
678 This variable should contain a function.  This function will be called
679 with the name of the new group as the only parameter.
680
681 Some handy pre-fab functions are:
682
683 @table @code
684
685 @item gnus-subscribe-zombies
686 @vindex gnus-subscribe-zombies
687 Make all new groups zombies.  This is the default.  You can browse the
688 zombies later (with @kbd{A z}) and either kill them all off properly
689 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
690
691 @item gnus-subscribe-randomly
692 @vindex gnus-subscribe-randomly
693 Subscribe all new groups in arbitrary order.  This really means that all
694 new groups will be added at ``the top'' of the group buffer.
695
696 @item gnus-subscribe-alphabetically
697 @vindex gnus-subscribe-alphabetically
698 Subscribe all new groups in alphabetical order.
699
700 @item gnus-subscribe-hierarchically
701 @vindex gnus-subscribe-hierarchically
702 Subscribe all new groups hierarchically.  The difference between this
703 function and @code{gnus-subscribe-alphabetically} is slight.
704 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
705 alphabetical fashion, while this function will enter groups into it's
706 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
707 @samp{comp} hierarchy, this function will not mess that configuration
708 up.  Or something like that.
709
710 @item gnus-subscribe-interactively
711 @vindex gnus-subscribe-interactively
712 Subscribe new groups interactively.  This means that Gnus will ask
713 you about @strong{all} new groups.  The groups you choose to subscribe
714 to will be subscribed hierarchically.
715
716 @item gnus-subscribe-killed
717 @vindex gnus-subscribe-killed
718 Kill all new groups.
719
720 @end table
721
722 @vindex gnus-subscribe-hierarchical-interactive
723 A closely related variable is
724 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
725 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
726 hierarchical fashion whether to subscribe to new groups or not.  Gnus
727 will ask you for each sub-hierarchy whether you want to descend the
728 hierarchy or not.
729
730 One common mistake is to set the variable a few paragraphs above
731 (@code{gnus-subscribe-newsgroup-method}) to
732 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
733 will not work.  This is ga-ga.  So don't do it.
734
735
736 @node Filtering New Groups
737 @subsection Filtering New Groups
738
739 A nice and portable way to control which new newsgroups should be
740 subscribed (or ignored) is to put an @dfn{options} line at the start of
741 the @file{.newsrc} file.  Here's an example:
742
743 @example
744 options -n !alt.all !rec.all sci.all
745 @end example
746
747 @vindex gnus-subscribe-options-newsgroup-method
748 This line obviously belongs to a serious-minded intellectual scientific
749 person (or she may just be plain old boring), because it says that all
750 groups that have names beginning with @samp{alt} and @samp{rec} should
751 be ignored, and all groups with names beginning with @samp{sci} should
752 be subscribed.  Gnus will not use the normal subscription method for
753 subscribing these groups.
754 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
755 variable defaults to @code{gnus-subscribe-alphabetically}.
756
757 @vindex gnus-options-not-subscribe
758 @vindex gnus-options-subscribe
759 If you don't want to mess with your @file{.newsrc} file, you can just
760 set the two variables @code{gnus-options-subscribe} and
761 @code{gnus-options-not-subscribe}.  These two variables do exactly the
762 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
763 and if the new group matches the former, it will be unconditionally
764 subscribed, and if it matches the latter, it will be ignored.
765
766 @vindex gnus-auto-subscribed-groups
767 Yet another variable that meddles here is
768 @code{gnus-auto-subscribed-groups}.  It works exactly like
769 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
770 thought it would be nice to have two of these.  This variable is more
771 meant for setting some ground rules, while the other variable is used
772 more for user fiddling.  By default this variable makes all new groups
773 that come from mail backends (@code{nnml}, @code{nnbabyl},
774 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
775 don't like that, just set this variable to @code{nil}.
776
777 New groups that match this regexp are subscribed using
778 @code{gnus-subscribe-options-newsgroup-method}.
779
780
781 @node Changing Servers
782 @section Changing Servers
783 @cindex changing servers
784
785 Sometimes it is necessary to move from one @sc{nntp} server to another.
786 This happens very rarely, but perhaps you change jobs, or one server is
787 very flaky and you want to use another.
788
789 Changing the server is pretty easy, right?  You just change
790 @code{gnus-select-method} to point to the new server?
791
792 @emph{Wrong!}
793
794 Article numbers are not (in any way) kept synchronized between different
795 @sc{nntp} servers, and the only way Gnus keeps track of what articles
796 you have read is by keeping track of article numbers.  So when you
797 change @code{gnus-select-method}, your @file{.newsrc} file becomes
798 worthless.
799
800 Gnus provides a few functions to attempt to translate a @file{.newsrc}
801 file from one server to another.  They all have one thing in
802 common---they take a looong time to run.  You don't want to use these
803 functions more than absolutely necessary.
804
805 @kindex M-x gnus-change-server
806 @findex gnus-change-server
807 If you have access to both servers, Gnus can request the headers for all
808 the articles you have read and compare @code{Message-ID}s and map the
809 article numbers of the read articles and article marks.  The @kbd{M-x
810 gnus-change-server} command will do this for all your native groups.  It
811 will prompt for the method you want to move to.
812
813 @kindex M-x gnus-group-move-group-to-server
814 @findex gnus-group-move-group-to-server
815 You can also move individual groups with the @kbd{M-x
816 gnus-group-move-group-to-server} command.  This is useful if you want to
817 move a (foreign) group from one server to another.
818
819 @kindex M-x gnus-group-clear-data-on-native-groups
820 @findex gnus-group-clear-data-on-native-groups
821 If you don't have access to both the old and new server, all your marks
822 and read ranges have become worthless.  You can use the @kbd{M-x
823 gnus-group-clear-data-on-native-groups} command to clear out all data
824 that you have on your native groups.  Use with caution.
825
826
827 @node Startup Files
828 @section Startup Files
829 @cindex startup files
830 @cindex .newsrc
831 @cindex .newsrc.el
832 @cindex .newsrc.eld
833
834 Now, you all know about the @file{.newsrc} file.  All subscription
835 information is traditionally stored in this file.
836
837 Things got a bit more complicated with @sc{gnus}.  In addition to
838 keeping the @file{.newsrc} file updated, it also used a file called
839 @file{.newsrc.el} for storing all the information that didn't fit into
840 the @file{.newsrc} file.  (Actually, it also duplicated everything in
841 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
842 files was the most recently saved, which enabled people to swap between
843 @sc{gnus} and other newsreaders.
844
845 That was kinda silly, so Gnus went one better: In addition to the
846 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
847 @file{.newsrc.eld}.  It will read whichever of these files that are most
848 recent, but it will never write a @file{.newsrc.el} file.  You should
849 never delete the @file{.newsrc.eld} file---it contains much information
850 not stored in the @file{.newsrc} file.
851
852 @vindex gnus-save-newsrc-file
853 You can turn off writing the @file{.newsrc} file by setting
854 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
855 the file and save some space, as well as exiting from Gnus faster.
856 However, this will make it impossible to use other newsreaders than
857 Gnus.  But hey, who would want to, right?
858
859 @vindex gnus-save-killed-list
860 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
861 will not save the list of killed groups to the startup file.  This will
862 save both time (when starting and quitting) and space (on disk).  It
863 will also mean that Gnus has no record of what groups are new or old,
864 so the automatic new groups subscription methods become meaningless.
865 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
866 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
867 Groups}).  This variable can also be a regular expression.  If that's
868 the case, remove all groups that do not match this regexp before
869 saving.  This can be useful in certain obscure situations that involve
870 several servers where not all servers support @code{ask-server}.
871
872 @vindex gnus-startup-file
873 The @code{gnus-startup-file} variable says where the startup files are.
874 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
875 file being whatever that one is, with a @samp{.eld} appended.
876
877 @vindex gnus-save-newsrc-hook
878 @vindex gnus-save-quick-newsrc-hook
879 @vindex gnus-save-standard-newsrc-hook
880 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
881 files, while @code{gnus-save-quick-newsrc-hook} is called just before
882 saving the @file{.newsrc.eld} file, and
883 @code{gnus-save-standard-newsrc-hook} is called just before saving the
884 @file{.newsrc} file.  The latter two are commonly used to turn version
885 control on or off.  Version control is on by default when saving the
886 startup files.  If you want to turn backup creation off, say something like:
887
888 @lisp
889 (defun turn-off-backup ()
890   (set (make-local-variable 'backup-inhibited) t))
891
892 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
893 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
894 @end lisp
895
896 @vindex gnus-init-file
897 When Gnus starts, it will read the @code{gnus-site-init-file}
898 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
899 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
900 and can be used to avoid cluttering your @file{~/.emacs} and
901 @file{site-init} files with Gnus stuff.  Gnus will also check for files
902 with the same names as these, but with @file{.elc} and @file{.el}
903 suffixes.  In other words, if you have set @code{gnus-init-file} to
904 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
905 and finally @file{~/.gnus} (in this order).
906
907
908
909 @node Auto Save
910 @section Auto Save
911 @cindex dribble file
912 @cindex auto-save
913
914 Whenever you do something that changes the Gnus data (reading articles,
915 catching up, killing/subscribing groups), the change is added to a
916 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
917 Emacs way.  If your Emacs should crash before you have saved the
918 @file{.newsrc} files, all changes you have made can be recovered from
919 this file.
920
921 If Gnus detects this file at startup, it will ask the user whether to
922 read it.  The auto save file is deleted whenever the real startup file is
923 saved.
924
925 @vindex gnus-use-dribble-file
926 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
927 maintain a dribble buffer.  The default is @code{t}.
928
929 @vindex gnus-dribble-directory
930 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
931 this variable is @code{nil}, which it is by default, Gnus will dribble
932 into the directory where the @file{.newsrc} file is located.  (This is
933 normally the user's home directory.)  The dribble file will get the same
934 file permissions as the @code{.newsrc} file.
935
936 @vindex gnus-always-read-dribble-file
937 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
938 read the dribble file on startup without querying the user.
939
940
941 @node The Active File
942 @section The Active File
943 @cindex active file
944 @cindex ignored groups
945
946 When Gnus starts, or indeed whenever it tries to determine whether new
947 articles have arrived, it reads the active file.  This is a very large
948 file that lists all the active groups and articles on the server.
949
950 @vindex gnus-ignored-newsgroups
951 Before examining the active file, Gnus deletes all lines that match the
952 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
953 any groups with bogus names, but you can use this variable to make Gnus
954 ignore hierarchies you aren't ever interested in.  However, this is not
955 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
956 Groups} for an overview of other variables that can be used instead.
957
958 @c This variable is
959 @c @code{nil} by default, and will slow down active file handling somewhat
960 @c if you set it to anything else.
961
962 @vindex gnus-read-active-file
963 @c @head
964 The active file can be rather Huge, so if you have a slow network, you
965 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
966 reading the active file.  This variable is @code{some} by default.
967
968 Gnus will try to make do by getting information just on the groups that
969 you actually subscribe to.
970
971 Note that if you subscribe to lots and lots of groups, setting this
972 variable to @code{nil} will probably make Gnus slower, not faster.  At
973 present, having this variable @code{nil} will slow Gnus down
974 considerably, unless you read news over a 2400 baud modem.
975
976 This variable can also have the value @code{some}.  Gnus will then
977 attempt to read active info only on the subscribed groups.  On some
978 servers this is quite fast (on sparkling, brand new INN servers that
979 support the @code{LIST ACTIVE group} command), on others this isn't fast
980 at all.  In any case, @code{some} should be faster than @code{nil}, and
981 is certainly faster than @code{t} over slow lines.
982
983 If this variable is @code{nil}, Gnus will ask for group info in total
984 lock-step, which isn't very fast.  If it is @code{some} and you use an
985 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
986 read all the replies in one swoop.  This will normally result in better
987 performance, but if the server does not support the aforementioned
988 @code{LIST ACTIVE group} command, this isn't very nice to the server.
989
990 In any case, if you use @code{some} or @code{nil}, you should definitely
991 kill all groups that you aren't interested in to speed things up.
992
993 Note that this variable also affects active file retrieval from
994 secondary select methods.
995
996
997 @node Startup Variables
998 @section Startup Variables
999
1000 @table @code
1001
1002 @item gnus-load-hook
1003 @vindex gnus-load-hook
1004 A hook run while Gnus is being loaded.  Note that this hook will
1005 normally be run just once in each Emacs session, no matter how many
1006 times you start Gnus.
1007
1008 @item gnus-before-startup-hook
1009 @vindex gnus-before-startup-hook
1010 A hook run after starting up Gnus successfully.
1011
1012 @item gnus-startup-hook
1013 @vindex gnus-startup-hook
1014 A hook run as the very last thing after starting up Gnus
1015
1016 @item gnus-started-hook
1017 @vindex gnus-started-hook
1018 A hook that is run as the very last thing after starting up Gnus
1019 successfully.
1020
1021 @item gnus-started-hook
1022 @vindex gnus-started-hook
1023 A hook that is run after reading the @file{.newsrc} file(s), but before
1024 generating the group buffer.
1025
1026 @item gnus-check-bogus-newsgroups
1027 @vindex gnus-check-bogus-newsgroups
1028 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1029 startup.  A @dfn{bogus group} is a group that you have in your
1030 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1031 bogus groups can take quite a while, so to save time and resources it's
1032 best to leave this option off, and do the checking for bogus groups once
1033 in a while from the group buffer instead (@pxref{Group Maintenance}).
1034
1035 @item gnus-inhibit-startup-message
1036 @vindex gnus-inhibit-startup-message
1037 If non-@code{nil}, the startup message won't be displayed.  That way,
1038 your boss might not notice as easily that you are reading news instead
1039 of doing your job.  Note that this variable is used before
1040 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1041
1042 @item gnus-no-groups-message
1043 @vindex gnus-no-groups-message
1044 Message displayed by Gnus when no groups are available.
1045
1046 @item gnus-play-startup-jingle
1047 @vindex gnus-play-startup-jingle
1048 If non-@code{nil}, play the Gnus jingle at startup.
1049
1050 @item gnus-startup-jingle
1051 @vindex gnus-startup-jingle
1052 Jingle to be played if the above variable is non-@code{nil}.  The
1053 default is @samp{Tuxedomoon.Jingle4.au}.
1054
1055 @end table
1056
1057
1058 @node The Group Buffer
1059 @chapter The Group Buffer
1060 @cindex group buffer
1061
1062 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1063 is the first buffer shown when Gnus starts, and will never be killed as
1064 long as Gnus is active.
1065
1066 @iftex
1067 @iflatex
1068 \gnusfigure{The Group Buffer}{320}{
1069 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1070 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1071 \put(120,38){\vector(1,2){10}}
1072 \put(40,60){\makebox(0,0)[r]{Mode line}}
1073 \put(40,58){\vector(1,0){30}}
1074 \put(200,28){\makebox(0,0)[t]{Native select method}}
1075 \put(200,26){\vector(-1,2){15}}
1076 }
1077 @end iflatex
1078 @end iftex
1079
1080 @menu
1081 * Group Buffer Format::    Information listed and how you can change it.
1082 * Group Maneuvering::      Commands for moving in the group buffer.
1083 * Selecting a Group::      Actually reading news.
1084 * Group Data::             Changing the info for a group.
1085 * Subscription Commands::  Unsubscribing, killing, subscribing.
1086 * Group Levels::           Levels? What are those, then?
1087 * Group Score::            A mechanism for finding out what groups you like.
1088 * Marking Groups::         You can mark groups for later processing.
1089 * Foreign Groups::         Creating and editing groups.
1090 * Group Parameters::       Each group may have different parameters set.
1091 * Listing Groups::         Gnus can list various subsets of the groups.
1092 * Sorting Groups::         Re-arrange the group order.
1093 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1094 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1095 * Exiting Gnus::           Stop reading news and get some work done.
1096 * Group Topics::           A folding group mode divided into topics.
1097 * Misc Group Stuff::       Other stuff that you can to do.
1098 @end menu
1099
1100
1101 @node Group Buffer Format
1102 @section Group Buffer Format
1103
1104 @menu
1105 * Group Line Specification::       Deciding how the group buffer is to look.
1106 * Group Modeline Specification::   The group buffer modeline.
1107 * Group Highlighting::             Having nice colors in the group buffer.
1108 @end menu
1109
1110
1111 @node Group Line Specification
1112 @subsection Group Line Specification
1113 @cindex group buffer format
1114
1115 The default format of the group buffer is nice and dull, but you can
1116 make it as exciting and ugly as you feel like.
1117
1118 Here's a couple of example group lines:
1119
1120 @example
1121      25: news.announce.newusers
1122  *    0: alt.fan.andrea-dworkin
1123 @end example
1124
1125 Quite simple, huh?
1126
1127 You can see that there are 25 unread articles in
1128 @samp{news.announce.newusers}.  There are no unread articles, but some
1129 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1130 asterisk at the beginning of the line?).
1131
1132 @vindex gnus-group-line-format
1133 You can change that format to whatever you want by fiddling with the
1134 @code{gnus-group-line-format} variable.  This variable works along the
1135 lines of a @code{format} specification, which is pretty much the same as
1136 a @code{printf} specifications, for those of you who use (feh!) C.
1137 @xref{Formatting Variables}.
1138
1139 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1140
1141 There should always be a colon on the line; the cursor always moves to
1142 the colon after performing an operation.  Nothing else is required---not
1143 even the group name.  All displayed text is just window dressing, and is
1144 never examined by Gnus.  Gnus stores all real information it needs using
1145 text properties.
1146
1147 (Note that if you make a really strange, wonderful, spreadsheet-like
1148 layout, everybody will believe you are hard at work with the accounting
1149 instead of wasting time reading news.)
1150
1151 Here's a list of all available format characters:
1152
1153 @table @samp
1154
1155 @item M
1156 An asterisk if the group only has marked articles.
1157
1158 @item S
1159 Whether the group is subscribed.
1160
1161 @item L
1162 Level of subscribedness.
1163
1164 @item N
1165 Number of unread articles.
1166
1167 @item I
1168 Number of dormant articles.
1169
1170 @item T
1171 Number of ticked articles.
1172
1173 @item R
1174 Number of read articles.
1175
1176 @item t
1177 Estimated total number of articles.  (This is really @var{max-number}
1178 minus @var{min-number} plus 1.)
1179
1180 @item y
1181 Number of unread, unticked, non-dormant articles.
1182
1183 @item i
1184 Number of ticked and dormant articles.
1185
1186 @item g
1187 Full group name.
1188
1189 @item G
1190 Group name.
1191
1192 @item D
1193 Newsgroup description.
1194
1195 @item o
1196 @samp{m} if moderated.
1197
1198 @item O
1199 @samp{(m)} if moderated.
1200
1201 @item s
1202 Select method.
1203
1204 @item n
1205 Select from where.
1206
1207 @item z
1208 A string that looks like @samp{<%s:%n>} if a foreign select method is
1209 used.
1210
1211 @item P
1212 Indentation based on the level of the topic (@pxref{Group Topics}).
1213
1214 @item c
1215 @vindex gnus-group-uncollapsed-levels
1216 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1217 variable says how many levels to leave at the end of the group name.
1218 The default is 1---this will mean that group names like
1219 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1220
1221 @item m
1222 @vindex gnus-new-mail-mark
1223 @cindex %
1224 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1225 the group lately.
1226
1227 @item d
1228 A string that says when you last read the group (@pxref{Group
1229 Timestamp}).
1230
1231 @item u
1232 User defined specifier.  The next character in the format string should
1233 be a letter.  Gnus will call the function
1234 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1235 following @samp{%u}.  The function will be passed a single dummy
1236 parameter as argument.  The function should return a string, which will
1237 be inserted into the buffer just like information from any other
1238 specifier.
1239 @end table
1240
1241 @cindex *
1242 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1243 if no info is available---for instance, if it is a non-activated foreign
1244 group, or a bogus native group.
1245
1246
1247 @node Group Modeline Specification
1248 @subsection Group Modeline Specification
1249 @cindex group modeline
1250
1251 @vindex gnus-group-mode-line-format
1252 The mode line can be changed by setting
1253 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1254 doesn't understand that many format specifiers:
1255
1256 @table @samp
1257 @item S
1258 The native news server.
1259 @item M
1260 The native select method.
1261 @end table
1262
1263
1264 @node Group Highlighting
1265 @subsection Group Highlighting
1266 @cindex highlighting
1267 @cindex group highlighting
1268
1269 @vindex gnus-group-highlight
1270 Highlighting in the group buffer is controlled by the
1271 @code{gnus-group-highlight} variable.  This is an alist with elements
1272 that look like @var{(form . face)}.  If @var{form} evaluates to
1273 something non-@code{nil}, the @var{face} will be used on the line.
1274
1275 Here's an example value for this variable that might look nice if the
1276 background is dark:
1277
1278 @lisp
1279 (face-spec-set 'my-group-face-1
1280                '((t (:foreground "Red" :bold t))))
1281 (face-spec-set 'my-group-face-2
1282                '((t (:foreground "SeaGreen" :bold t))))
1283 (face-spec-set 'my-group-face-3
1284                '((t (:foreground "SpringGreen" :bold t))))
1285 (face-spec-set 'my-group-face-4
1286                '((t (:foreground "SteelBlue" :bold t))))
1287 (face-spec-set 'my-group-face-5
1288                '((t (:foreground "SkyBlue" :bold t))))
1289
1290 (setq gnus-group-highlight
1291       '(((> unread 200) . my-group-face-1)
1292         ((and (< level 3) (zerop unread)) . my-group-face-2)
1293         ((< level 3) . my-group-face-3)
1294         ((zerop unread) . my-group-face-4)
1295         (t . my-group-face-5)))
1296 @end lisp
1297
1298 Also @pxref{Faces and Fonts}.
1299
1300 Variables that are dynamically bound when the forms are evaluated
1301 include:
1302
1303 @table @code
1304 @item group
1305 The group name.
1306 @item unread
1307 The number of unread articles in the group.
1308 @item method
1309 The select method.
1310 @item mailp
1311 Whether the group is a mail group.
1312 @item level
1313 The level of the group.
1314 @item score
1315 The score of the group.
1316 @item ticked
1317 The number of ticked articles in the group.
1318 @item total
1319 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1320 MIN-NUMBER plus one.
1321 @item topic
1322 When using the topic minor mode, this variable is bound to the current
1323 topic being inserted.
1324 @end table
1325
1326 When the forms are @code{eval}ed, point is at the beginning of the line
1327 of the group in question, so you can use many of the normal Gnus
1328 functions for snarfing info on the group.
1329
1330 @vindex gnus-group-update-hook
1331 @findex gnus-group-highlight-line
1332 @code{gnus-group-update-hook} is called when a group line is changed.
1333 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1334 calls @code{gnus-group-highlight-line} by default.
1335
1336
1337 @node Group Maneuvering
1338 @section Group Maneuvering
1339 @cindex group movement
1340
1341 All movement commands understand the numeric prefix and will behave as
1342 expected, hopefully.
1343
1344 @table @kbd
1345
1346 @item n
1347 @kindex n (Group)
1348 @findex gnus-group-next-unread-group
1349 Go to the next group that has unread articles
1350 (@code{gnus-group-next-unread-group}).
1351
1352 @item p
1353 @itemx DEL
1354 @kindex DEL (Group)
1355 @kindex p (Group)
1356 @findex gnus-group-prev-unread-group
1357 Go to the previous group that has unread articles
1358 (@code{gnus-group-prev-unread-group}).
1359
1360 @item N
1361 @kindex N (Group)
1362 @findex gnus-group-next-group
1363 Go to the next group (@code{gnus-group-next-group}).
1364
1365 @item P
1366 @kindex P (Group)
1367 @findex gnus-group-prev-group
1368 Go to the previous group (@code{gnus-group-prev-group}).
1369
1370 @item M-n
1371 @kindex M-n (Group)
1372 @findex gnus-group-next-unread-group-same-level
1373 Go to the next unread group on the same (or lower) level
1374 (@code{gnus-group-next-unread-group-same-level}).
1375
1376 @item M-p
1377 @kindex M-p (Group)
1378 @findex gnus-group-prev-unread-group-same-level
1379 Go to the previous unread group on the same (or lower) level
1380 (@code{gnus-group-prev-unread-group-same-level}).
1381 @end table
1382
1383 Three commands for jumping to groups:
1384
1385 @table @kbd
1386
1387 @item j
1388 @kindex j (Group)
1389 @findex gnus-group-jump-to-group
1390 Jump to a group (and make it visible if it isn't already)
1391 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1392 like living groups.
1393
1394 @item ,
1395 @kindex , (Group)
1396 @findex gnus-group-best-unread-group
1397 Jump to the unread group with the lowest level
1398 (@code{gnus-group-best-unread-group}).
1399
1400 @item .
1401 @kindex . (Group)
1402 @findex gnus-group-first-unread-group
1403 Jump to the first group with unread articles
1404 (@code{gnus-group-first-unread-group}).
1405 @end table
1406
1407 @vindex gnus-group-goto-unread
1408 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1409 commands will move to the next group, not the next unread group.  Even
1410 the commands that say they move to the next unread group.  The default
1411 is @code{t}.
1412
1413
1414 @node Selecting a Group
1415 @section Selecting a Group
1416 @cindex group selection
1417
1418 @table @kbd
1419
1420 @item SPACE
1421 @kindex SPACE (Group)
1422 @findex gnus-group-read-group
1423 Select the current group, switch to the summary buffer and display the
1424 first unread article (@code{gnus-group-read-group}).  If there are no
1425 unread articles in the group, or if you give a non-numerical prefix to
1426 this command, Gnus will offer to fetch all the old articles in this
1427 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1428 determines the number of articles Gnus will fetch.  If @var{N} is
1429 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1430 negative, Gnus fetches the @var{abs(N)} oldest articles.
1431
1432 @item RET
1433 @kindex RET (Group)
1434 @findex gnus-group-select-group
1435 Select the current group and switch to the summary buffer
1436 (@code{gnus-group-select-group}).  Takes the same arguments as
1437 @code{gnus-group-read-group}---the only difference is that this command
1438 does not display the first unread article automatically upon group
1439 entry.
1440
1441 @item M-RET
1442 @kindex M-RET (Group)
1443 @findex gnus-group-quick-select-group
1444 This does the same as the command above, but tries to do it with the
1445 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1446 scoring/killing will be performed, there will be no highlights and no
1447 expunging.  This might be useful if you're in a real hurry and have to
1448 enter some humongous group.  If you give a 0 prefix to this command
1449 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1450 which is useful if you want to toggle threading before generating the
1451 summary buffer (@pxref{Summary Generation Commands}).
1452
1453 @item M-SPACE
1454 @kindex M-SPACE (Group)
1455 @findex gnus-group-visible-select-group
1456 This is yet one more command that does the same as the @kbd{RET}
1457 command, but this one does it without expunging and hiding dormants
1458 (@code{gnus-group-visible-select-group}).
1459
1460 @item M-C-RET
1461 @kindex M-C-RET (Group)
1462 @findex gnus-group-select-group-ephemerally
1463 Finally, this command selects the current group ephemerally without
1464 doing any processing of its contents
1465 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1466 turned off.  Everything you do in the group after selecting it in this
1467 manner will have no permanent effects.
1468
1469 @end table
1470
1471 @vindex gnus-large-newsgroup
1472 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1473 to be a big group.  This is 200 by default.  If the group has more
1474 (unread and/or ticked) articles than this, Gnus will query the user
1475 before entering the group.  The user can then specify how many articles
1476 should be fetched from the server.  If the user specifies a negative
1477 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1478 is positive, the @code{n} articles that have arrived most recently will
1479 be fetched.
1480
1481 @vindex gnus-select-group-hook
1482 @vindex gnus-auto-select-first
1483 @code{gnus-auto-select-first} control whether any articles are selected
1484 automatically when entering a group with the @kbd{SPACE} command.
1485
1486 @table @code
1487
1488 @item nil
1489 Don't select any articles when entering the group.  Just display the
1490 full summary buffer.
1491
1492 @item t
1493 Select the first unread article when entering the group.
1494
1495 @item best
1496 Select the highest scored article in the group when entering the
1497 group.
1498
1499 @end table
1500
1501 This variable can also be a function.  In that case, that function will
1502 be called to place point on a subject line, and/or select some article.
1503 Useful functions include:
1504
1505 @table @code
1506 @item gnus-summary-first-unread-subject
1507 Place point on the subject line of the first unread article, but
1508 don't select the article.
1509
1510 @item gnus-summary-first-unread-article
1511 Select the first unread article.
1512
1513 @item gnus-summary-best-unread-article
1514 Select the highest-scored unread article.
1515 @end table
1516
1517
1518 If you want to prevent automatic selection in some group (say, in a
1519 binary group with Huge articles) you can set this variable to @code{nil}
1520 in @code{gnus-select-group-hook}, which is called when a group is
1521 selected.
1522
1523
1524 @node Subscription Commands
1525 @section Subscription Commands
1526 @cindex subscription
1527
1528 @table @kbd
1529
1530 @item S t
1531 @itemx u
1532 @kindex S t (Group)
1533 @kindex u (Group)
1534 @findex gnus-group-unsubscribe-current-group
1535 @c @icon{gnus-group-unsubscribe}
1536 Toggle subscription to the current group
1537 (@code{gnus-group-unsubscribe-current-group}).
1538
1539 @item S s
1540 @itemx U
1541 @kindex S s (Group)
1542 @kindex U (Group)
1543 @findex gnus-group-unsubscribe-group
1544 Prompt for a group to subscribe, and then subscribe it.  If it was
1545 subscribed already, unsubscribe it instead
1546 (@code{gnus-group-unsubscribe-group}).
1547
1548 @item S k
1549 @itemx C-k
1550 @kindex S k (Group)
1551 @kindex C-k (Group)
1552 @findex gnus-group-kill-group
1553 @c @icon{gnus-group-kill-group}
1554 Kill the current group (@code{gnus-group-kill-group}).
1555
1556 @item S y
1557 @itemx C-y
1558 @kindex S y (Group)
1559 @kindex C-y (Group)
1560 @findex gnus-group-yank-group
1561 Yank the last killed group (@code{gnus-group-yank-group}).
1562
1563 @item C-x C-t
1564 @kindex C-x C-t (Group)
1565 @findex gnus-group-transpose-groups
1566 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1567 really a subscription command, but you can use it instead of a
1568 kill-and-yank sequence sometimes.
1569
1570 @item S w
1571 @itemx C-w
1572 @kindex S w (Group)
1573 @kindex C-w (Group)
1574 @findex gnus-group-kill-region
1575 Kill all groups in the region (@code{gnus-group-kill-region}).
1576
1577 @item S z
1578 @kindex S z (Group)
1579 @findex gnus-group-kill-all-zombies
1580 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1581
1582 @item S C-k
1583 @kindex S C-k (Group)
1584 @findex gnus-group-kill-level
1585 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1586 These groups can't be yanked back after killing, so this command should
1587 be used with some caution.  The only time where this command comes in
1588 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1589 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1590 kill off all unsubscribed groups that do not have message numbers in the
1591 @file{.newsrc} file.
1592
1593 @end table
1594
1595 Also @pxref{Group Levels}.
1596
1597
1598 @node Group Data
1599 @section Group Data
1600
1601 @table @kbd
1602
1603 @item c
1604 @kindex c (Group)
1605 @findex gnus-group-catchup-current
1606 @vindex gnus-group-catchup-group-hook
1607 @c @icon{gnus-group-catchup-current}
1608 Mark all unticked articles in this group as read
1609 (@code{gnus-group-catchup-current}).
1610 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1611 the group buffer.
1612
1613 @item C
1614 @kindex C (Group)
1615 @findex gnus-group-catchup-current-all
1616 Mark all articles in this group, even the ticked ones, as read
1617 (@code{gnus-group-catchup-current-all}).
1618
1619 @item M-c
1620 @kindex M-c (Group)
1621 @findex gnus-group-clear-data
1622 Clear the data from the current group---nix out marks and the list of
1623 read articles (@code{gnus-group-clear-data}).
1624
1625 @item M-x gnus-group-clear-data-on-native-groups
1626 @kindex M-x gnus-group-clear-data-on-native-groups
1627 @findex gnus-group-clear-data-on-native-groups
1628 If you have switched from one @sc{nntp} server to another, all your marks
1629 and read ranges have become worthless.  You can use this command to
1630 clear out all data that you have on your native groups.  Use with
1631 caution.
1632
1633 @end table
1634
1635
1636 @node Group Levels
1637 @section Group Levels
1638 @cindex group level
1639 @cindex level
1640
1641 All groups have a level of @dfn{subscribedness}.  For instance, if a
1642 group is on level 2, it is more subscribed than a group on level 5.  You
1643 can ask Gnus to just list groups on a given level or lower
1644 (@pxref{Listing Groups}), or to just check for new articles in groups on
1645 a given level or lower (@pxref{Scanning New Messages}).
1646
1647 Remember:  The higher the level of the group, the less important it is.
1648
1649 @table @kbd
1650
1651 @item S l
1652 @kindex S l (Group)
1653 @findex gnus-group-set-current-level
1654 Set the level of the current group.  If a numeric prefix is given, the
1655 next @var{n} groups will have their levels set.  The user will be
1656 prompted for a level.
1657 @end table
1658
1659 @vindex gnus-level-killed
1660 @vindex gnus-level-zombie
1661 @vindex gnus-level-unsubscribed
1662 @vindex gnus-level-subscribed
1663 Gnus considers groups from levels 1 to
1664 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1665 @code{gnus-level-subscribed} (exclusive) and
1666 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1667 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1668 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1669 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1670 same, but zombie and killed groups have no information on what articles
1671 you have read, etc, stored.  This distinction between dead and living
1672 groups isn't done because it is nice or clever, it is done purely for
1673 reasons of efficiency.
1674
1675 It is recommended that you keep all your mail groups (if any) on quite
1676 low levels (e.g. 1 or 2).
1677
1678 If you want to play with the level variables, you should show some care.
1679 Set them once, and don't touch them ever again.  Better yet, don't touch
1680 them at all unless you know exactly what you're doing.
1681
1682 @vindex gnus-level-default-unsubscribed
1683 @vindex gnus-level-default-subscribed
1684 Two closely related variables are @code{gnus-level-default-subscribed}
1685 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1686 which are the levels that new groups will be put on if they are
1687 (un)subscribed.  These two variables should, of course, be inside the
1688 relevant valid ranges.
1689
1690 @vindex gnus-keep-same-level
1691 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1692 will only move to groups of the same level (or lower).  In
1693 particular, going from the last article in one group to the next group
1694 will go to the next group of the same level (or lower).  This might be
1695 handy if you want to read the most important groups before you read the
1696 rest.
1697
1698 @vindex gnus-group-default-list-level
1699 All groups with a level less than or equal to
1700 @code{gnus-group-default-list-level} will be listed in the group buffer
1701 by default.
1702
1703 @vindex gnus-group-list-inactive-groups
1704 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1705 groups will be listed along with the unread groups.  This variable is
1706 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1707 listed.
1708
1709 @vindex gnus-group-use-permanent-levels
1710 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1711 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1712 use this level as the ``work'' level.
1713
1714 @vindex gnus-activate-level
1715 Gnus will normally just activate (i. e., query the server about) groups
1716 on level @code{gnus-activate-level} or less.  If you don't want to
1717 activate unsubscribed groups, for instance, you might set this variable
1718 to 5.  The default is 6.
1719
1720
1721 @node Group Score
1722 @section Group Score
1723 @cindex group score
1724 @cindex group rank
1725 @cindex rank
1726
1727 You would normally keep important groups on high levels, but that scheme
1728 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1729 group buffer according to how often you read groups, perhaps?  Within
1730 reason?
1731
1732 This is what @dfn{group score} is for.  You can assign a score to each
1733 group.  You can then sort the group buffer based on this score.
1734 Alternatively, you can sort on score and then level.  (Taken together,
1735 the level and the score is called the @dfn{rank} of the group.  A group
1736 that is on level 4 and has a score of 1 has a higher rank than a group
1737 on level 5 that has a score of 300.  (The level is the most significant
1738 part and the score is the least significant part.))
1739
1740 @findex gnus-summary-bubble-group
1741 If you want groups you read often to get higher scores than groups you
1742 read seldom you can add the @code{gnus-summary-bubble-group} function to
1743 the @code{gnus-summary-exit-hook} hook.  This will result (after
1744 sorting) in a bubbling sort of action.  If you want to see that in
1745 action after each summary exit, you can add
1746 @code{gnus-group-sort-groups-by-rank} or
1747 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1748 slow things down somewhat.
1749
1750
1751 @node Marking Groups
1752 @section Marking Groups
1753 @cindex marking groups
1754
1755 If you want to perform some command on several groups, and they appear
1756 subsequently in the group buffer, you would normally just give a
1757 numerical prefix to the command.  Most group commands will then do your
1758 bidding on those groups.
1759
1760 However, if the groups are not in sequential order, you can still
1761 perform a command on several groups.  You simply mark the groups first
1762 with the process mark and then execute the command.
1763
1764 @table @kbd
1765
1766 @item #
1767 @kindex # (Group)
1768 @itemx M m
1769 @kindex M m (Group)
1770 @findex gnus-group-mark-group
1771 Set the mark on the current group (@code{gnus-group-mark-group}).
1772
1773 @item M-#
1774 @kindex M-# (Group)
1775 @itemx M u
1776 @kindex M u (Group)
1777 @findex gnus-group-unmark-group
1778 Remove the mark from the current group
1779 (@code{gnus-group-unmark-group}).
1780
1781 @item M U
1782 @kindex M U (Group)
1783 @findex gnus-group-unmark-all-groups
1784 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1785
1786 @item M w
1787 @kindex M w (Group)
1788 @findex gnus-group-mark-region
1789 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1790
1791 @item M b
1792 @kindex M b (Group)
1793 @findex gnus-group-mark-buffer
1794 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1795
1796 @item M r
1797 @kindex M r (Group)
1798 @findex gnus-group-mark-regexp
1799 Mark all groups that match some regular expression
1800 (@code{gnus-group-mark-regexp}).
1801 @end table
1802
1803 Also @pxref{Process/Prefix}.
1804
1805 @findex gnus-group-universal-argument
1806 If you want to execute some command on all groups that have been marked
1807 with the process mark, you can use the @kbd{M-&}
1808 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1809 the command to be executed.
1810
1811
1812 @node Foreign Groups
1813 @section Foreign Groups
1814 @cindex foreign groups
1815
1816 Below are some group mode commands for making and editing general foreign
1817 groups, as well as commands to ease the creation of a few
1818 special-purpose groups.  All these commands insert the newly created
1819 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1820 consulted.
1821
1822 @table @kbd
1823
1824 @item G m
1825 @kindex G m (Group)
1826 @findex gnus-group-make-group
1827 @cindex making groups
1828 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1829 for a name, a method and possibly an @dfn{address}.  For an easier way
1830 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1831
1832 @item G r
1833 @kindex G r (Group)
1834 @findex gnus-group-rename-group
1835 @cindex renaming groups
1836 Rename the current group to something else
1837 (@code{gnus-group-rename-group}).  This is valid only on some
1838 groups---mail groups mostly.  This command might very well be quite slow
1839 on some backends.
1840
1841 @item G c
1842 @kindex G c (Group)
1843 @cindex customizing
1844 @findex gnus-group-customize
1845 Customize the group parameters (@code{gnus-group-customize}).
1846
1847 @item G e
1848 @kindex G e (Group)
1849 @findex gnus-group-edit-group-method
1850 @cindex renaming groups
1851 Enter a buffer where you can edit the select method of the current
1852 group (@code{gnus-group-edit-group-method}).
1853
1854 @item G p
1855 @kindex G p (Group)
1856 @findex gnus-group-edit-group-parameters
1857 Enter a buffer where you can edit the group parameters
1858 (@code{gnus-group-edit-group-parameters}).
1859
1860 @item G E
1861 @kindex G E (Group)
1862 @findex gnus-group-edit-group
1863 Enter a buffer where you can edit the group info
1864 (@code{gnus-group-edit-group}).
1865
1866 @item G d
1867 @kindex G d (Group)
1868 @findex gnus-group-make-directory-group
1869 @cindex nndir
1870 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1871 for a directory name (@code{gnus-group-make-directory-group}).
1872
1873 @item G h
1874 @kindex G h (Group)
1875 @cindex help group
1876 @findex gnus-group-make-help-group
1877 Make the Gnus help group (@code{gnus-group-make-help-group}).
1878
1879 @item G a
1880 @kindex G a (Group)
1881 @cindex (ding) archive
1882 @cindex archive group
1883 @findex gnus-group-make-archive-group
1884 @vindex gnus-group-archive-directory
1885 @vindex gnus-group-recent-archive-directory
1886 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1887 default a group pointing to the most recent articles will be created
1888 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1889 group will be created from @code{gnus-group-archive-directory}.
1890
1891 @item G k
1892 @kindex G k (Group)
1893 @findex gnus-group-make-kiboze-group
1894 @cindex nnkiboze
1895 Make a kiboze group.  You will be prompted for a name, for a regexp to
1896 match groups to be ``included'' in the kiboze group, and a series of
1897 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1898 @xref{Kibozed Groups}.
1899
1900 @item G D
1901 @kindex G D (Group)
1902 @findex gnus-group-enter-directory
1903 @cindex nneething
1904 Read an arbitrary directory as if it were a newsgroup with the
1905 @code{nneething} backend (@code{gnus-group-enter-directory}).
1906 @xref{Anything Groups}.
1907
1908 @item G f
1909 @kindex G f (Group)
1910 @findex gnus-group-make-doc-group
1911 @cindex ClariNet Briefs
1912 @cindex nndoc
1913 Make a group based on some file or other
1914 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1915 command, you will be prompted for a file name and a file type.
1916 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1917 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1918 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1919 this command without a prefix, Gnus will guess at the file type.
1920 @xref{Document Groups}.
1921
1922 @item G u
1923 @kindex G u (Group)
1924 @vindex gnus-useful-groups
1925 @findex gnus-group-make-useful-group
1926 Create one of the groups mentioned in @code{gnus-useful-groups}
1927 (@code{gnus-group-make-useful-group}).
1928
1929 @item G w
1930 @kindex G w (Group)
1931 @findex gnus-group-make-web-group
1932 @cindex DejaNews
1933 @cindex Alta Vista
1934 @cindex InReference
1935 @cindex nnweb
1936 Make an ephemeral group based on a web search
1937 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1938 command, make a solid group instead.  You will be prompted for the
1939 search engine type and the search string.  Valid search engine types
1940 include @code{dejanews}, @code{altavista} and @code{reference}.
1941 @xref{Web Searches}.
1942
1943 If you use the @code{dejanews} search engine, you can limit the search
1944 to a particular group by using a match string like
1945 @samp{~g alt.sysadmin.recovery shaving}.
1946
1947 @item G DEL
1948 @kindex G DEL (Group)
1949 @findex gnus-group-delete-group
1950 This function will delete the current group
1951 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1952 actually delete all the articles in the group, and forcibly remove the
1953 group itself from the face of the Earth.  Use a prefix only if you are
1954 absolutely sure of what you are doing.  This command can't be used on
1955 read-only groups (like @code{nntp} group), though.
1956
1957 @item G V
1958 @kindex G V (Group)
1959 @findex gnus-group-make-empty-virtual
1960 Make a new, fresh, empty @code{nnvirtual} group
1961 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1962
1963 @item G v
1964 @kindex G v (Group)
1965 @findex gnus-group-add-to-virtual
1966 Add the current group to an @code{nnvirtual} group
1967 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1968 @end table
1969
1970 @xref{Select Methods} for more information on the various select
1971 methods.
1972
1973 @vindex gnus-activate-foreign-newsgroups
1974 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1975 Gnus will check all foreign groups with this level or lower at startup.
1976 This might take quite a while, especially if you subscribe to lots of
1977 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
1978 @code{gnus-activate-level} also affects activation of foreign
1979 newsgroups. 
1980
1981
1982 @node Group Parameters
1983 @section Group Parameters
1984 @cindex group parameters
1985
1986 The group parameters store information local to a particular group.
1987 Here's an example group parameter list:
1988
1989 @example
1990 ((to-address . "ding@@gnus.org")
1991  (auto-expire . t))
1992 @end example
1993
1994 We see that each element consists of a "dotted pair"---the thing before
1995 the dot is the key, while the thing after the dot is the value.  All the
1996 parameters have this form @emph{except} local variable specs, which are
1997 not dotted pairs, but proper lists.
1998
1999 The following group parameters can be used:
2000
2001 @table @code
2002 @item to-address
2003 @cindex to-address
2004 Address used by when doing followups and new posts.
2005
2006 @example
2007 (to-address .  "some@@where.com")
2008 @end example
2009
2010 This is primarily useful in mail groups that represent closed mailing
2011 lists---mailing lists where it's expected that everybody that writes to
2012 the mailing list is subscribed to it.  Since using this parameter
2013 ensures that the mail only goes to the mailing list itself, it means
2014 that members won't receive two copies of your followups.
2015
2016 Using @code{to-address} will actually work whether the group is foreign
2017 or not.  Let's say there's a group on the server that is called
2018 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2019 the articles from a mail-to-news gateway.  Posting directly to this
2020 group is therefore impossible---you have to send mail to the mailing
2021 list address instead.
2022
2023 @item to-list
2024 @cindex to-list
2025 Address used when doing a @kbd{a} in that group.
2026
2027 @example
2028 (to-list . "some@@where.com")
2029 @end example
2030
2031 It is totally ignored
2032 when doing a followup---except that if it is present in a news group,
2033 you'll get mail group semantics when doing @kbd{f}.
2034
2035 If you do an @kbd{a} command in a mail group and you have neither a
2036 @code{to-list} group parameter nor a @code{to-address} group parameter,
2037 then a @code{to-list} group parameter will be added automatically upon
2038 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2039 @vindex gnus-add-to-list
2040
2041 If you do an @kbd{a} command in a mail group and you don't have a
2042 @code{to-list} group parameter, one will be added automatically upon
2043 sending the message.
2044
2045 @item visible
2046 @cindex visible
2047 If the group parameter list has the element @code{(visible . t)},
2048 that group will always be visible in the Group buffer, regardless
2049 of whether it has any unread articles.
2050
2051 @item broken-reply-to
2052 @cindex broken-reply-to
2053 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2054 headers in this group are to be ignored.  This can be useful if you're
2055 reading a mailing list group where the listserv has inserted
2056 @code{Reply-To} headers that point back to the listserv itself.  This is
2057 broken behavior.  So there!
2058
2059 @item to-group
2060 @cindex to-group
2061 Elements like @code{(to-group . "some.group.name")} means that all
2062 posts in that group will be sent to @code{some.group.name}.
2063
2064 @item newsgroup
2065 @cindex newsgroup
2066 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2067 will treat all responses as if they were responses to news articles.
2068 This can be useful if you have a mail group that's really a mirror of a
2069 news group.
2070
2071 @item gcc-self
2072 @cindex gcc-self
2073 If @code{(gcc-self . t)} is present in the group parameter list, newly
2074 composed messages will be @code{Gcc}'d to the current group. If
2075 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2076 generated, if @code{(gcc-self . "string")} is present, this string will
2077 be inserted literally as a @code{gcc} header.  This parameter takes
2078 precedence over any default @code{Gcc} rules as described later
2079 (@pxref{Archived Messages}).
2080
2081 @item auto-expire
2082 @cindex auto-expire
2083 If the group parameter has an element that looks like @code{(auto-expire
2084 . t)}, all articles read will be marked as expirable.  For an
2085 alternative approach, @pxref{Expiring Mail}.
2086
2087 @item total-expire
2088 @cindex total-expire
2089 If the group parameter has an element that looks like
2090 @code{(total-expire . t)}, all read articles will be put through the
2091 expiry process, even if they are not marked as expirable.  Use with
2092 caution.  Unread, ticked and dormant articles are not eligible for
2093 expiry.
2094
2095 @item expiry-wait
2096 @cindex expiry-wait
2097 @vindex nnmail-expiry-wait-function
2098 If the group parameter has an element that looks like @code{(expiry-wait
2099 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2100 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2101 The value can either be a number of days (not necessarily an integer) or
2102 the symbols @code{never} or @code{immediate}.
2103
2104 @item score-file
2105 @cindex score file group parameter
2106 Elements that look like @code{(score-file . "file")} will make
2107 @file{file} into the current score file for the group in question.  All
2108 interactive score entries will be put into this file.
2109
2110 @item adapt-file
2111 @cindex adapt file group parameter
2112 Elements that look like @code{(adapt-file . "file")} will make
2113 @file{file} into the current adaptive file for the group in question.
2114 All adaptive score entries will be put into this file.
2115
2116 @item admin-address
2117 When unsubscribing from a mailing list you should never send the
2118 unsubscription notice to the mailing list itself.  Instead, you'd send
2119 messages to the administrative address.  This parameter allows you to
2120 put the admin address somewhere convenient.
2121
2122 @item display
2123 Elements that look like @code{(display . MODE)} say which articles to
2124 display on entering the group.  Valid values are:
2125
2126 @table @code
2127 @item all
2128 Display all articles, both read and unread.
2129
2130 @item default
2131 Display the default visible articles, which normally includes unread and
2132 ticked articles.
2133 @end table
2134
2135 @item comment
2136 Elements that look like @code{(comment . "This is a comment")}
2137 are arbitrary comments on the group.  They are currently ignored by
2138 Gnus, but provide a place for you to store information on particular
2139 groups.
2140
2141 @item charset
2142 Elements that look like @code{(charset . iso-8859-1)} will make
2143 @code{iso-8859-1} the default charset; that is, the charset that will be 
2144 used for all articles that do not specify a charset.
2145
2146 @item @var{(variable form)}
2147 You can use the group parameters to set variables local to the group you
2148 are entering.  If you want to turn threading off in @samp{news.answers},
2149 you could put @code{(gnus-show-threads nil)} in the group parameters of
2150 that group.  @code{gnus-show-threads} will be made into a local variable
2151 in the summary buffer you enter, and the form @code{nil} will be
2152 @code{eval}ed there.
2153
2154 This can also be used as a group-specific hook function, if you'd like.
2155 If you want to hear a beep when you enter a group, you could put
2156 something like @code{(dummy-variable (ding))} in the parameters of that
2157 group.  @code{dummy-variable} will be set to the result of the
2158 @code{(ding)} form, but who cares?
2159
2160 @end table
2161
2162 Use the @kbd{G p} command to edit group parameters of a group.  You
2163 might also be interested in reading about topic parameters (@pxref{Topic
2164 Parameters}).
2165
2166
2167 @node Listing Groups
2168 @section Listing Groups
2169 @cindex group listing
2170
2171 These commands all list various slices of the groups available.
2172
2173 @table @kbd
2174
2175 @item l
2176 @itemx A s
2177 @kindex A s (Group)
2178 @kindex l (Group)
2179 @findex gnus-group-list-groups
2180 List all groups that have unread articles
2181 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2182 command will list only groups of level ARG and lower.  By default, it
2183 only lists groups of level five (i. e.,
2184 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2185 groups).
2186
2187 @item L
2188 @itemx A u
2189 @kindex A u (Group)
2190 @kindex L (Group)
2191 @findex gnus-group-list-all-groups
2192 List all groups, whether they have unread articles or not
2193 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2194 this command will list only groups of level ARG and lower.  By default,
2195 it lists groups of level seven or lower (i.e., just subscribed and
2196 unsubscribed groups).
2197
2198 @item A l
2199 @kindex A l (Group)
2200 @findex gnus-group-list-level
2201 List all unread groups on a specific level
2202 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2203 with no unread articles.
2204
2205 @item A k
2206 @kindex A k (Group)
2207 @findex gnus-group-list-killed
2208 List all killed groups (@code{gnus-group-list-killed}).  If given a
2209 prefix argument, really list all groups that are available, but aren't
2210 currently (un)subscribed.  This could entail reading the active file
2211 from the server.
2212
2213 @item A z
2214 @kindex A z (Group)
2215 @findex gnus-group-list-zombies
2216 List all zombie groups (@code{gnus-group-list-zombies}).
2217
2218 @item A m
2219 @kindex A m (Group)
2220 @findex gnus-group-list-matching
2221 List all unread, subscribed groups with names that match a regexp
2222 (@code{gnus-group-list-matching}).
2223
2224 @item A M
2225 @kindex A M (Group)
2226 @findex gnus-group-list-all-matching
2227 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2228
2229 @item A A
2230 @kindex A A (Group)
2231 @findex gnus-group-list-active
2232 List absolutely all groups in the active file(s) of the
2233 server(s) you are connected to (@code{gnus-group-list-active}).  This
2234 might very well take quite a while.  It might actually be a better idea
2235 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2236 thing to match on.  Also note that this command may list groups that
2237 don't exist (yet)---these will be listed as if they were killed groups.
2238 Take the output with some grains of salt.
2239
2240 @item A a
2241 @kindex A a (Group)
2242 @findex gnus-group-apropos
2243 List all groups that have names that match a regexp
2244 (@code{gnus-group-apropos}).
2245
2246 @item A d
2247 @kindex A d (Group)
2248 @findex gnus-group-description-apropos
2249 List all groups that have names or descriptions that match a regexp
2250 (@code{gnus-group-description-apropos}).
2251
2252 @end table
2253
2254 @vindex gnus-permanently-visible-groups
2255 @cindex visible group parameter
2256 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2257 always be shown, whether they have unread articles or not.  You can also
2258 add the @code{visible} element to the group parameters in question to
2259 get the same effect.
2260
2261 @vindex gnus-list-groups-with-ticked-articles
2262 Groups that have just ticked articles in it are normally listed in the
2263 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2264 @code{nil}, these groups will be treated just like totally empty
2265 groups.  It is @code{t} by default.
2266
2267
2268 @node Sorting Groups
2269 @section Sorting Groups
2270 @cindex sorting groups
2271
2272 @kindex C-c C-s (Group)
2273 @findex gnus-group-sort-groups
2274 @vindex gnus-group-sort-function
2275 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2276 group buffer according to the function(s) given by the
2277 @code{gnus-group-sort-function} variable.  Available sorting functions
2278 include:
2279
2280 @table @code
2281
2282 @item gnus-group-sort-by-alphabet
2283 @findex gnus-group-sort-by-alphabet
2284 Sort the group names alphabetically.  This is the default.
2285
2286 @item gnus-group-sort-by-real-name
2287 @findex gnus-group-sort-by-real-name
2288 Sort the group alphabetically on the real (unprefixed) group names.
2289
2290 @item gnus-group-sort-by-level
2291 @findex gnus-group-sort-by-level
2292 Sort by group level.
2293
2294 @item gnus-group-sort-by-score
2295 @findex gnus-group-sort-by-score
2296 Sort by group score.  @xref{Group Score}.
2297
2298 @item gnus-group-sort-by-rank
2299 @findex gnus-group-sort-by-rank
2300 Sort by group score and then the group level.  The level and the score
2301 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2302
2303 @item gnus-group-sort-by-unread
2304 @findex gnus-group-sort-by-unread
2305 Sort by number of unread articles.
2306
2307 @item gnus-group-sort-by-method
2308 @findex gnus-group-sort-by-method
2309 Sort alphabetically on the select method.
2310
2311
2312 @end table
2313
2314 @code{gnus-group-sort-function} can also be a list of sorting
2315 functions.  In that case, the most significant sort key function must be
2316 the last one.
2317
2318
2319 There are also a number of commands for sorting directly according to
2320 some sorting criteria:
2321
2322 @table @kbd
2323 @item G S a
2324 @kindex G S a (Group)
2325 @findex gnus-group-sort-groups-by-alphabet
2326 Sort the group buffer alphabetically by group name
2327 (@code{gnus-group-sort-groups-by-alphabet}).
2328
2329 @item G S u
2330 @kindex G S u (Group)
2331 @findex gnus-group-sort-groups-by-unread
2332 Sort the group buffer by the number of unread articles
2333 (@code{gnus-group-sort-groups-by-unread}).
2334
2335 @item G S l
2336 @kindex G S l (Group)
2337 @findex gnus-group-sort-groups-by-level
2338 Sort the group buffer by group level
2339 (@code{gnus-group-sort-groups-by-level}).
2340
2341 @item G S v
2342 @kindex G S v (Group)
2343 @findex gnus-group-sort-groups-by-score
2344 Sort the group buffer by group score
2345 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2346
2347 @item G S r
2348 @kindex G S r (Group)
2349 @findex gnus-group-sort-groups-by-rank
2350 Sort the group buffer by group rank
2351 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2352
2353 @item G S m
2354 @kindex G S m (Group)
2355 @findex gnus-group-sort-groups-by-method
2356 Sort the group buffer alphabetically by backend name
2357 (@code{gnus-group-sort-groups-by-method}).
2358
2359 @end table
2360
2361 All the commands below obeys the process/prefix convention
2362 (@pxref{Process/Prefix}).
2363
2364 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2365 commands will sort in reverse order.  
2366
2367 You can also sort a subset of the groups:
2368
2369 @table @kbd
2370 @item G P a
2371 @kindex G P a (Group)
2372 @findex gnus-group-sort-selected-groups-by-alphabet
2373 Sort the groups alphabetically by group name
2374 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2375
2376 @item G P u
2377 @kindex G P u (Group)
2378 @findex gnus-group-sort-selected-groups-by-unread
2379 Sort the groups by the number of unread articles
2380 (@code{gnus-group-sort-selected-groups-by-unread}).
2381
2382 @item G P l
2383 @kindex G P l (Group)
2384 @findex gnus-group-sort-selected-groups-by-level
2385 Sort the groups by group level
2386 (@code{gnus-group-sort-selected-groups-by-level}).
2387
2388 @item G P v
2389 @kindex G P v (Group)
2390 @findex gnus-group-sort-selected-groups-by-score
2391 Sort the groups by group score
2392 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2393
2394 @item G P r
2395 @kindex G P r (Group)
2396 @findex gnus-group-sort-selected-groups-by-rank
2397 Sort the groups by group rank
2398 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2399
2400 @item G P m
2401 @kindex G P m (Group)
2402 @findex gnus-group-sort-selected-groups-by-method
2403 Sort the groups alphabetically by backend name
2404 (@code{gnus-group-sort-selected-groups-by-method}).
2405
2406 @end table
2407
2408
2409
2410 @node Group Maintenance
2411 @section Group Maintenance
2412 @cindex bogus groups
2413
2414 @table @kbd
2415 @item b
2416 @kindex b (Group)
2417 @findex gnus-group-check-bogus-groups
2418 Find bogus groups and delete them
2419 (@code{gnus-group-check-bogus-groups}).
2420
2421 @item F
2422 @kindex F (Group)
2423 @findex gnus-group-find-new-groups
2424 Find new groups and process them (@code{gnus-group-find-new-groups}).
2425 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2426 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
2427 to query the server for new groups, and subscribe the new groups as
2428 zombies.
2429
2430 @item C-c C-x
2431 @kindex C-c C-x (Group)
2432 @findex gnus-group-expire-articles
2433 Run all expirable articles in the current group through the expiry
2434 process (if any) (@code{gnus-group-expire-articles}).
2435
2436 @item C-c M-C-x
2437 @kindex C-c M-C-x (Group)
2438 @findex gnus-group-expire-all-groups
2439 Run all articles in all groups through the expiry process
2440 (@code{gnus-group-expire-all-groups}).
2441
2442 @end table
2443
2444
2445 @node Browse Foreign Server
2446 @section Browse Foreign Server
2447 @cindex foreign servers
2448 @cindex browsing servers
2449
2450 @table @kbd
2451 @item B
2452 @kindex B (Group)
2453 @findex gnus-group-browse-foreign-server
2454 You will be queried for a select method and a server name.  Gnus will
2455 then attempt to contact this server and let you browse the groups there
2456 (@code{gnus-group-browse-foreign-server}).
2457 @end table
2458
2459 @findex gnus-browse-mode
2460 A new buffer with a list of available groups will appear.  This buffer
2461 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2462 a lot) like a normal group buffer.
2463
2464 Here's a list of keystrokes available in the browse mode:
2465
2466 @table @kbd
2467 @item n
2468 @kindex n (Browse)
2469 @findex gnus-group-next-group
2470 Go to the next group (@code{gnus-group-next-group}).
2471
2472 @item p
2473 @kindex p (Browse)
2474 @findex gnus-group-prev-group
2475 Go to the previous group (@code{gnus-group-prev-group}).
2476
2477 @item SPACE
2478 @kindex SPACE (Browse)
2479 @findex gnus-browse-read-group
2480 Enter the current group and display the first article
2481 (@code{gnus-browse-read-group}).
2482
2483 @item RET
2484 @kindex RET (Browse)
2485 @findex gnus-browse-select-group
2486 Enter the current group (@code{gnus-browse-select-group}).
2487
2488 @item u
2489 @kindex u (Browse)
2490 @findex gnus-browse-unsubscribe-current-group
2491 Unsubscribe to the current group, or, as will be the case here,
2492 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2493
2494 @item l
2495 @itemx q
2496 @kindex q (Browse)
2497 @kindex l (Browse)
2498 @findex gnus-browse-exit
2499 Exit browse mode (@code{gnus-browse-exit}).
2500
2501 @item ?
2502 @kindex ? (Browse)
2503 @findex gnus-browse-describe-briefly
2504 Describe browse mode briefly (well, there's not much to describe, is
2505 there) (@code{gnus-browse-describe-briefly}).
2506 @end table
2507
2508
2509 @node Exiting Gnus
2510 @section Exiting Gnus
2511 @cindex exiting Gnus
2512
2513 Yes, Gnus is ex(c)iting.
2514
2515 @table @kbd
2516 @item z
2517 @kindex z (Group)
2518 @findex gnus-group-suspend
2519 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2520 but it kills all buffers except the Group buffer.  I'm not sure why this
2521 is a gain, but then who am I to judge?
2522
2523 @item q
2524 @kindex q (Group)
2525 @findex gnus-group-exit
2526 @c @icon{gnus-group-exit}
2527 Quit Gnus (@code{gnus-group-exit}).
2528
2529 @item Q
2530 @kindex Q (Group)
2531 @findex gnus-group-quit
2532 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2533 The dribble file will be saved, though (@pxref{Auto Save}).
2534 @end table
2535
2536 @vindex gnus-exit-gnus-hook
2537 @vindex gnus-suspend-gnus-hook
2538 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2539 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2540 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2541 exiting Gnus.
2542
2543 @findex gnus-unload
2544 @cindex unloading
2545 If you wish to completely unload Gnus and all its adherents, you can use
2546 the @code{gnus-unload} command.  This command is also very handy when
2547 trying to customize meta-variables.
2548
2549 Note:
2550
2551 @quotation
2552 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2553 numbly heavy and herself fall into a hazy trance as the boy sitting
2554 behind her drew repeated lines with his pencil across the back of her
2555 plastic chair.
2556 @end quotation
2557
2558
2559 @node Group Topics
2560 @section Group Topics
2561 @cindex topics
2562
2563 If you read lots and lots of groups, it might be convenient to group
2564 them hierarchically according to topics.  You put your Emacs groups over
2565 here, your sex groups over there, and the rest (what, two groups or so?)
2566 you put in some misc section that you never bother with anyway.  You can
2567 even group the Emacs sex groups as a sub-topic to either the Emacs
2568 groups or the sex groups---or both!  Go wild!
2569
2570 @iftex
2571 @iflatex
2572 \gnusfigure{Group Topics}{400}{
2573 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2574 }
2575 @end iflatex
2576 @end iftex
2577
2578 Here's an example:
2579
2580 @example
2581 Gnus
2582   Emacs -- I wuw it!
2583      3: comp.emacs
2584      2: alt.religion.emacs
2585     Naughty Emacs
2586      452: alt.sex.emacs
2587        0: comp.talk.emacs.recovery
2588   Misc
2589      8: comp.binaries.fractals
2590     13: comp.sources.unix
2591 @end example
2592
2593 @findex gnus-topic-mode
2594 @kindex t (Group)
2595 To get this @emph{fab} functionality you simply turn on (ooh!) the
2596 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2597 is a toggling command.)
2598
2599 Go ahead, just try it.  I'll still be here when you get back.  La de
2600 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2601 press @kbd{l}.  There.  All your groups are now listed under
2602 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2603 bothered?
2604
2605 If you want this permanently enabled, you should add that minor mode to
2606 the hook for the group mode:
2607
2608 @lisp
2609 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2610 @end lisp
2611
2612 @menu
2613 * Topic Variables::    How to customize the topics the Lisp Way.
2614 * Topic Commands::     Interactive E-Z commands.
2615 * Topic Sorting::      Sorting each topic individually.
2616 * Topic Topology::     A map of the world.
2617 * Topic Parameters::   Parameters that apply to all groups in a topic.
2618 @end menu
2619
2620
2621 @node Topic Variables
2622 @subsection Topic Variables
2623 @cindex topic variables
2624
2625 Now, if you select a topic, it will fold/unfold that topic, which is
2626 really neat, I think.
2627
2628 @vindex gnus-topic-line-format
2629 The topic lines themselves are created according to the
2630 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2631 Valid elements are:
2632
2633 @table @samp
2634 @item i
2635 Indentation.
2636 @item n
2637 Topic name.
2638 @item v
2639 Visibility.
2640 @item l
2641 Level.
2642 @item g
2643 Number of groups in the topic.
2644 @item a
2645 Number of unread articles in the topic.
2646 @item A
2647 Number of unread articles in the topic and all its subtopics.
2648 @end table
2649
2650 @vindex gnus-topic-indent-level
2651 Each sub-topic (and the groups in the sub-topics) will be indented with
2652 @code{gnus-topic-indent-level} times the topic level number of spaces.
2653 The default is 2.
2654
2655 @vindex gnus-topic-mode-hook
2656 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2657
2658 @vindex gnus-topic-display-empty-topics
2659 The @code{gnus-topic-display-empty-topics} says whether to display even
2660 topics that have no unread articles in them.  The default is @code{t}.
2661
2662
2663 @node Topic Commands
2664 @subsection Topic Commands
2665 @cindex topic commands
2666
2667 When the topic minor mode is turned on, a new @kbd{T} submap will be
2668 available.  In addition, a few of the standard keys change their
2669 definitions slightly.
2670
2671 @table @kbd
2672
2673 @item T n
2674 @kindex T n (Topic)
2675 @findex gnus-topic-create-topic
2676 Prompt for a new topic name and create it
2677 (@code{gnus-topic-create-topic}).
2678
2679 @item T m
2680 @kindex T m (Topic)
2681 @findex gnus-topic-move-group
2682 Move the current group to some other topic
2683 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2684 convention (@pxref{Process/Prefix}).
2685
2686 @item T c
2687 @kindex T c (Topic)
2688 @findex gnus-topic-copy-group
2689 Copy the current group to some other topic
2690 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2691 convention (@pxref{Process/Prefix}).
2692
2693 @item T D
2694 @kindex T D (Topic)
2695 @findex gnus-topic-remove-group
2696 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2697 This command is mainly useful if you have the same group in several
2698 topics and wish to remove it from one of the topics.  You may also
2699 remove a group from all topics, but in that case, Gnus will add it to
2700 the root topic the next time you start Gnus.  In fact, all new groups
2701 (which, naturally, don't belong to any topic) will show up in the root
2702 topic. 
2703
2704 This command uses the process/prefix convention
2705 (@pxref{Process/Prefix}).
2706
2707 @item T M
2708 @kindex T M (Topic)
2709 @findex gnus-topic-move-matching
2710 Move all groups that match some regular expression to a topic
2711 (@code{gnus-topic-move-matching}).
2712
2713 @item T C
2714 @kindex T C (Topic)
2715 @findex gnus-topic-copy-matching
2716 Copy all groups that match some regular expression to a topic
2717 (@code{gnus-topic-copy-matching}).
2718
2719 @item T H
2720 @kindex T H (Topic)
2721 @findex gnus-topic-toggle-display-empty-topics
2722 Toggle hiding empty topics
2723 (@code{gnus-topic-toggle-display-empty-topics}).
2724
2725 @item T #
2726 @kindex T # (Topic)
2727 @findex gnus-topic-mark-topic
2728 Mark all groups in the current topic with the process mark
2729 (@code{gnus-topic-mark-topic}).
2730
2731 @item T M-#
2732 @kindex T M-# (Topic)
2733 @findex gnus-topic-unmark-topic
2734 Remove the process mark from all groups in the current topic
2735 (@code{gnus-topic-unmark-topic}).
2736
2737 @item RET
2738 @kindex RET (Topic)
2739 @findex gnus-topic-select-group
2740 @itemx SPACE
2741 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2742 When you perform this command on a group, you'll enter the group, as
2743 usual.  When done on a topic line, the topic will be folded (if it was
2744 visible) or unfolded (if it was folded already).  So it's basically a
2745 toggling command on topics.  In addition, if you give a numerical
2746 prefix, group on that level (and lower) will be displayed.
2747
2748 @item T TAB
2749 @itemx TAB
2750 @kindex T TAB (Topic)
2751 @kindex TAB (Topic)
2752 @findex gnus-topic-indent
2753 ``Indent'' the current topic so that it becomes a sub-topic of the
2754 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2755 ``un-indent'' the topic instead.
2756
2757 @item M-TAB
2758 @kindex M-TAB (Topic)
2759 @findex gnus-topic-unindent
2760 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2761 parent of its current parent (@code{gnus-topic-unindent}).  
2762
2763 @item C-k
2764 @kindex C-k (Topic)
2765 @findex gnus-topic-kill-group
2766 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2767 topic will be removed along with the topic.
2768
2769 @item C-y
2770 @kindex C-y (Topic)
2771 @findex gnus-topic-yank-group
2772 Yank the previously killed group or topic
2773 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2774 before all groups.
2775
2776 @item T r
2777 @kindex T r (Topic)
2778 @findex gnus-topic-rename
2779 Rename a topic (@code{gnus-topic-rename}).
2780
2781 @item T DEL
2782 @kindex T DEL (Topic)
2783 @findex gnus-topic-delete
2784 Delete an empty topic (@code{gnus-topic-delete}).
2785
2786 @item A T
2787 @kindex A T (Topic)
2788 @findex gnus-topic-list-active
2789 List all groups that Gnus knows about in a topics-ified way
2790 (@code{gnus-topic-list-active}).
2791
2792 @item G p
2793 @kindex G p (Topic)
2794 @findex gnus-topic-edit-parameters
2795 @cindex group parameters
2796 @cindex topic parameters
2797 @cindex parameters
2798 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2799 @xref{Topic Parameters}.
2800
2801 @end table
2802
2803
2804 @node Topic Sorting
2805 @subsection Topic Sorting
2806 @cindex topic sorting
2807
2808 You can sort the groups in each topic individually with the following
2809 commands:
2810
2811
2812 @table @kbd
2813 @item T S a
2814 @kindex T S a (Topic)
2815 @findex gnus-topic-sort-groups-by-alphabet
2816 Sort the current topic alphabetically by group name
2817 (@code{gnus-topic-sort-groups-by-alphabet}).
2818
2819 @item T S u
2820 @kindex T S u (Topic)
2821 @findex gnus-topic-sort-groups-by-unread
2822 Sort the current topic by the number of unread articles
2823 (@code{gnus-topic-sort-groups-by-unread}).
2824
2825 @item T S l
2826 @kindex T S l (Topic)
2827 @findex gnus-topic-sort-groups-by-level
2828 Sort the current topic by group level
2829 (@code{gnus-topic-sort-groups-by-level}).
2830
2831 @item T S v
2832 @kindex T S v (Topic)
2833 @findex gnus-topic-sort-groups-by-score
2834 Sort the current topic by group score
2835 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2836
2837 @item T S r
2838 @kindex T S r (Topic)
2839 @findex gnus-topic-sort-groups-by-rank
2840 Sort the current topic by group rank
2841 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2842
2843 @item T S m
2844 @kindex T S m (Topic)
2845 @findex gnus-topic-sort-groups-by-method
2846 Sort the current topic alphabetically by backend name
2847 (@code{gnus-topic-sort-groups-by-method}).
2848
2849 @end table
2850
2851 @xref{Sorting Groups} for more information about group sorting.
2852
2853
2854 @node Topic Topology
2855 @subsection Topic Topology
2856 @cindex topic topology
2857 @cindex topology
2858
2859 So, let's have a look at an example group buffer:
2860
2861 @example
2862 Gnus
2863   Emacs -- I wuw it!
2864      3: comp.emacs
2865      2: alt.religion.emacs
2866     Naughty Emacs
2867      452: alt.sex.emacs
2868        0: comp.talk.emacs.recovery
2869   Misc
2870      8: comp.binaries.fractals
2871     13: comp.sources.unix
2872 @end example
2873
2874 So, here we have one top-level topic (@samp{Gnus}), two topics under
2875 that, and one sub-topic under one of the sub-topics.  (There is always
2876 just one (1) top-level topic).  This topology can be expressed as
2877 follows:
2878
2879 @lisp
2880 (("Gnus" visible)
2881  (("Emacs -- I wuw it!" visible)
2882   (("Naughty Emacs" visible)))
2883  (("Misc" visible)))
2884 @end lisp
2885
2886 @vindex gnus-topic-topology
2887 This is in fact how the variable @code{gnus-topic-topology} would look
2888 for the display above.  That variable is saved in the @file{.newsrc.eld}
2889 file, and shouldn't be messed with manually---unless you really want
2890 to.  Since this variable is read from the @file{.newsrc.eld} file,
2891 setting it in any other startup files will have no effect.
2892
2893 This topology shows what topics are sub-topics of what topics (right),
2894 and which topics are visible.  Two settings are currently
2895 allowed---@code{visible} and @code{invisible}.
2896
2897
2898 @node Topic Parameters
2899 @subsection Topic Parameters
2900 @cindex topic parameters
2901
2902 All groups in a topic will inherit group parameters from the parent (and
2903 ancestor) topic parameters.  All valid group parameters are valid topic
2904 parameters (@pxref{Group Parameters}).
2905
2906 Group parameters (of course) override topic parameters, and topic
2907 parameters in sub-topics override topic parameters in super-topics.  You
2908 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2909 verb, although you may feel free to disagree with me here.)
2910
2911 @example
2912 Gnus
2913   Emacs
2914      3: comp.emacs
2915      2: alt.religion.emacs
2916    452: alt.sex.emacs
2917     Relief
2918      452: alt.sex.emacs
2919        0: comp.talk.emacs.recovery
2920   Misc
2921      8: comp.binaries.fractals
2922     13: comp.sources.unix
2923    452: alt.sex.emacs
2924 @end example
2925
2926 The @samp{Emacs} topic has the topic parameter @code{(score-file
2927 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2928 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2929 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2930 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2931 . "religion.SCORE")}.
2932
2933 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2934 will get the @file{relief.SCORE} home score file.  If you enter the same
2935 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2936 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2937 get the @file{religion.SCORE} home score file.
2938
2939 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2940 there are some problems, especially with the @code{total-expiry}
2941 parameter.  Say you have a mail group in two topics; one with
2942 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2943 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2944 of these topics you mean to expire articles from, so anything may
2945 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2946 happens.  You just have to be careful if you do stuff like that.
2947
2948
2949 @node Misc Group Stuff
2950 @section Misc Group Stuff
2951
2952 @menu
2953 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2954 * Group Information::     Information and help on groups and Gnus.
2955 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2956 * File Commands::         Reading and writing the Gnus files.
2957 @end menu
2958
2959 @table @kbd
2960
2961 @item ^
2962 @kindex ^ (Group)
2963 @findex gnus-group-enter-server-mode
2964 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2965 @xref{The Server Buffer}.
2966
2967 @item a
2968 @kindex a (Group)
2969 @findex gnus-group-post-news
2970 Post an article to a group (@code{gnus-group-post-news}).  If given a
2971 prefix, the current group name will be used as the default.
2972
2973 @item m
2974 @kindex m (Group)
2975 @findex gnus-group-mail
2976 Mail a message somewhere (@code{gnus-group-mail}).
2977
2978 @end table
2979
2980 Variables for the group buffer:
2981
2982 @table @code
2983
2984 @item gnus-group-mode-hook
2985 @vindex gnus-group-mode-hook
2986 is called after the group buffer has been
2987 created.
2988
2989 @item gnus-group-prepare-hook
2990 @vindex gnus-group-prepare-hook
2991 is called after the group buffer is
2992 generated.  It may be used to modify the buffer in some strange,
2993 unnatural way.
2994
2995 @item gnus-group-prepared-hook
2996 @vindex gnus-group-prepare-hook
2997 is called as the very last thing after the group buffer has been
2998 generated.  It may be used to move point around, for instance.
2999
3000 @item gnus-permanently-visible-groups
3001 @vindex gnus-permanently-visible-groups
3002 Groups matching this regexp will always be listed in the group buffer,
3003 whether they are empty or not.
3004
3005 @end table
3006
3007
3008 @node Scanning New Messages
3009 @subsection Scanning New Messages
3010 @cindex new messages
3011 @cindex scanning new news
3012
3013 @table @kbd
3014
3015 @item g
3016 @kindex g (Group)
3017 @findex gnus-group-get-new-news
3018 @c @icon{gnus-group-get-new-news}
3019 Check the server(s) for new articles.  If the numerical prefix is used,
3020 this command will check only groups of level @var{arg} and lower
3021 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
3022 command will force a total re-reading of the active file(s) from the
3023 backend(s).
3024
3025 @item M-g
3026 @kindex M-g (Group)
3027 @findex gnus-group-get-new-news-this-group
3028 @vindex gnus-goto-next-group-when-activating
3029 @c @icon{gnus-group-get-new-news-this-group}
3030 Check whether new articles have arrived in the current group
3031 (@code{gnus-group-get-new-news-this-group}).
3032 @code{gnus-goto-next-group-when-activating} says whether this command is
3033 to move point to the next group or not.  It is @code{t} by default.
3034
3035 @findex gnus-activate-all-groups
3036 @cindex activating groups
3037 @item C-c M-g
3038 @kindex C-c M-g (Group)
3039 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3040
3041 @item R
3042 @kindex R (Group)
3043 @cindex restarting
3044 @findex gnus-group-restart
3045 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3046 file(s), closes the connection to all servers, clears up all run-time
3047 Gnus variables, and then starts Gnus all over again.
3048
3049 @end table
3050
3051 @vindex gnus-get-new-news-hook
3052 @code{gnus-get-new-news-hook} is run just before checking for new news.
3053
3054 @vindex gnus-after-getting-new-news-hook
3055 @code{gnus-after-getting-new-news-hook} is run after checking for new
3056 news.
3057
3058
3059 @node Group Information
3060 @subsection Group Information
3061 @cindex group information
3062 @cindex information on groups
3063
3064 @table @kbd
3065
3066
3067 @item H f
3068 @kindex H f (Group)
3069 @findex gnus-group-fetch-faq
3070 @vindex gnus-group-faq-directory
3071 @cindex FAQ
3072 @cindex ange-ftp
3073 Try to fetch the FAQ for the current group
3074 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3075 @code{gnus-group-faq-directory}, which is usually a directory on a
3076 remote machine.  This variable can also be a list of directories.  In
3077 that case, giving a prefix to this command will allow you to choose
3078 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3079 for fetching the file.
3080
3081 If fetching from the first site is unsuccessful, Gnus will attempt to go
3082 through @code{gnus-group-faq-directory} and try to open them one by one.
3083
3084 @item H d
3085 @itemx C-c C-d
3086 @c @icon{gnus-group-describe-group}
3087 @kindex H d (Group)
3088 @kindex C-c C-d (Group)
3089 @cindex describing groups
3090 @cindex group description
3091 @findex gnus-group-describe-group
3092 Describe the current group (@code{gnus-group-describe-group}).  If given
3093 a prefix, force Gnus to re-read the description from the server.
3094
3095 @item M-d
3096 @kindex M-d (Group)
3097 @findex gnus-group-describe-all-groups
3098 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3099 prefix, force Gnus to re-read the description file from the server.
3100
3101 @item H v
3102 @itemx V
3103 @kindex V (Group)
3104 @kindex H v (Group)
3105 @cindex version
3106 @findex gnus-version
3107 Display current Gnus version numbers (@code{gnus-version}).
3108
3109 @item ?
3110 @kindex ? (Group)
3111 @findex gnus-group-describe-briefly
3112 Give a very short help message (@code{gnus-group-describe-briefly}).
3113
3114 @item C-c C-i
3115 @kindex C-c C-i (Group)
3116 @cindex info
3117 @cindex manual
3118 @findex gnus-info-find-node
3119 Go to the Gnus info node (@code{gnus-info-find-node}).
3120 @end table
3121
3122
3123 @node Group Timestamp
3124 @subsection Group Timestamp
3125 @cindex timestamps
3126 @cindex group timestamps
3127
3128 It can be convenient to let Gnus keep track of when you last read a
3129 group.  To set the ball rolling, you should add
3130 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3131
3132 @lisp
3133 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3134 @end lisp
3135
3136 After doing this, each time you enter a group, it'll be recorded.
3137
3138 This information can be displayed in various ways---the easiest is to
3139 use the @samp{%d} spec in the group line format:
3140
3141 @lisp
3142 (setq gnus-group-line-format
3143       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3144 @end lisp
3145
3146 This will result in lines looking like:
3147
3148 @example
3149 *        0: mail.ding                                19961002T012943
3150          0: custom                                   19961002T012713
3151 @end example
3152
3153 As you can see, the date is displayed in compact ISO 8601 format.  This
3154 may be a bit too much, so to just display the date, you could say
3155 something like:
3156
3157 @lisp
3158 (setq gnus-group-line-format
3159       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3160 @end lisp
3161
3162
3163 @node File Commands
3164 @subsection File Commands
3165 @cindex file commands
3166
3167 @table @kbd
3168
3169 @item r
3170 @kindex r (Group)
3171 @findex gnus-group-read-init-file
3172 @vindex gnus-init-file
3173 @cindex reading init file
3174 Re-read the init file (@code{gnus-init-file}, which defaults to
3175 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3176
3177 @item s
3178 @kindex s (Group)
3179 @findex gnus-group-save-newsrc
3180 @cindex saving .newsrc
3181 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3182 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3183 file(s) whether Gnus thinks it is necessary or not.
3184
3185 @c @item Z
3186 @c @kindex Z (Group)
3187 @c @findex gnus-group-clear-dribble
3188 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3189
3190 @end table
3191
3192
3193 @node The Summary Buffer
3194 @chapter The Summary Buffer
3195 @cindex summary buffer
3196
3197 A line for each article is displayed in the summary buffer.  You can
3198 move around, read articles, post articles and reply to articles.
3199
3200 The most common way to a summary buffer is to select a group from the
3201 group buffer (@pxref{Selecting a Group}).
3202
3203 You can have as many summary buffers open as you wish.
3204
3205 @menu
3206 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3207 * Summary Maneuvering::         Moving around the summary buffer.
3208 * Choosing Articles::           Reading articles.
3209 * Paging the Article::          Scrolling the current article.
3210 * Reply Followup and Post::     Posting articles.
3211 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3212 * Marking Articles::            Marking articles as read, expirable, etc.
3213 * Limiting::                    You can limit the summary buffer.
3214 * Threading::                   How threads are made.
3215 * Sorting::                     How articles and threads are sorted.
3216 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3217 * Article Caching::             You may store articles in a cache.
3218 * Persistent Articles::         Making articles expiry-resistant.
3219 * Article Backlog::             Having already read articles hang around.
3220 * Saving Articles::             Ways of customizing article saving.
3221 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3222 * Article Treatment::           The article buffer can be mangled at will.
3223 * MIME Commands::               Doing MIMEy things with the articles.
3224 * Article Commands::            Doing various things with the article buffer.
3225 * Summary Sorting::             Sorting the summary buffer in various ways.
3226 * Finding the Parent::          No child support? Get the parent.
3227 * Alternative Approaches::      Reading using non-default summaries.
3228 * Tree Display::                A more visual display of threads.
3229 * Mail Group Commands::         Some commands can only be used in mail groups.
3230 * Various Summary Stuff::       What didn't fit anywhere else.
3231 * Exiting the Summary Buffer::  Returning to the Group buffer.
3232 * Crosspost Handling::          How crossposted articles are dealt with.
3233 * Duplicate Suppression::       An alternative when crosspost handling fails.
3234 @end menu
3235
3236
3237 @node Summary Buffer Format
3238 @section Summary Buffer Format
3239 @cindex summary buffer format
3240
3241 @iftex
3242 @iflatex
3243 \gnusfigure{The Summary Buffer}{180}{
3244 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3245 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3246 }
3247 @end iflatex
3248 @end iftex
3249
3250 @menu
3251 * Summary Buffer Lines::     You can specify how summary lines should look.
3252 * Summary Buffer Mode Line:: You can say how the mode line should look.
3253 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3254 @end menu
3255
3256 @findex mail-extract-address-components
3257 @findex gnus-extract-address-components
3258 @vindex gnus-extract-address-components
3259 Gnus will use the value of the @code{gnus-extract-address-components}
3260 variable as a function for getting the name and address parts of a
3261 @code{From} header.  Two pre-defined functions exist:
3262 @code{gnus-extract-address-components}, which is the default, quite
3263 fast, and too simplistic solution; and
3264 @code{mail-extract-address-components}, which works very nicely, but is
3265 slower.  The default function will return the wrong answer in 5% of the
3266 cases.  If this is unacceptable to you, use the other function instead:
3267
3268 @lisp
3269 (setq gnus-extract-address-components
3270       'mail-extract-address-components)
3271 @end lisp
3272
3273 @vindex gnus-summary-same-subject
3274 @code{gnus-summary-same-subject} is a string indicating that the current
3275 article has the same subject as the previous.  This string will be used
3276 with those specs that require it.  The default is @code{""}.
3277
3278
3279 @node Summary Buffer Lines
3280 @subsection Summary Buffer Lines
3281
3282 @vindex gnus-summary-line-format
3283 You can change the format of the lines in the summary buffer by changing
3284 the @code{gnus-summary-line-format} variable.  It works along the same
3285 lines as a normal @code{format} string, with some extensions
3286 (@pxref{Formatting Variables}).
3287
3288 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3289
3290 The following format specification characters are understood:
3291
3292 @table @samp
3293 @item N
3294 Article number.
3295 @item S
3296 Subject string.
3297 @item s
3298 Subject if the article is the root of the thread or the previous article
3299 had a different subject, @code{gnus-summary-same-subject} otherwise.
3300 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3301 @item F
3302 Full @code{From} header.
3303 @item n
3304 The name (from the @code{From} header).
3305 @item a
3306 The name (from the @code{From} header).  This differs from the @code{n}
3307 spec in that it uses the function designated by the
3308 @code{gnus-extract-address-components} variable, which is slower, but
3309 may be more thorough.
3310 @item A
3311 The address (from the @code{From} header).  This works the same way as
3312 the @code{a} spec.
3313 @item L
3314 Number of lines in the article.
3315 @item c
3316 Number of characters in the article.
3317 @item I
3318 Indentation based on thread level (@pxref{Customizing Threading}).
3319 @item T
3320 Nothing if the article is a root and lots of spaces if it isn't (it
3321 pushes everything after it off the screen).
3322 @item [
3323 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3324 for adopted articles (@pxref{Customizing Threading}).
3325 @item ]
3326 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3327 for adopted articles.
3328 @item >
3329 One space for each thread level.
3330 @item <
3331 Twenty minus thread level spaces.
3332 @item U
3333 Unread.
3334
3335 @item R
3336 This misleadingly named specifier is the @dfn{secondary mark}.  This
3337 mark will say whether the article has been replied to, has been cached,
3338 or has been saved.  
3339
3340 @item i
3341 Score as a number (@pxref{Scoring}).
3342 @item z
3343 @vindex gnus-summary-zcore-fuzz
3344 Zcore, @samp{+} if above the default level and @samp{-} if below the
3345 default level.  If the difference between
3346 @code{gnus-summary-default-score} and the score is less than
3347 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3348 @item V
3349 Total thread score.
3350 @item x
3351 @code{Xref}.
3352 @item D
3353 @code{Date}.
3354 @item d
3355 The @code{Date} in @code{DD-MMM} format.
3356 @item o
3357 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3358 @item M
3359 @code{Message-ID}.
3360 @item r
3361 @code{References}.
3362 @item t
3363 Number of articles in the current sub-thread.  Using this spec will slow
3364 down summary buffer generation somewhat.
3365 @item e
3366 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3367 article has any children.
3368 @item P
3369 The line number.
3370 @item O
3371 Download mark.
3372 @item u
3373 User defined specifier.  The next character in the format string should
3374 be a letter.  Gnus will call the function
3375 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3376 following @samp{%u}.  The function will be passed the current header as
3377 argument.  The function should return a string, which will be inserted
3378 into the summary just like information from any other summary specifier.
3379 @end table
3380
3381 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3382 have to be handled with care.  For reasons of efficiency, Gnus will
3383 compute what column these characters will end up in, and ``hard-code''
3384 that.  This means that it is invalid to have these specs after a
3385 variable-length spec.  Well, you might not be arrested, but your summary
3386 buffer will look strange, which is bad enough.
3387
3388 The smart choice is to have these specs as far to the left as possible.
3389 (Isn't that the case with everything, though?  But I digress.)
3390
3391 This restriction may disappear in later versions of Gnus.
3392
3393
3394 @node Summary Buffer Mode Line
3395 @subsection Summary Buffer Mode Line
3396
3397 @vindex gnus-summary-mode-line-format
3398 You can also change the format of the summary mode bar (@pxref{Mode Line
3399 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
3400 like.  The default is @samp{Gnus: %%b [%A] %Z}.
3401
3402 Here are the elements you can play with:
3403
3404 @table @samp
3405 @item G
3406 Group name.
3407 @item p
3408 Unprefixed group name.
3409 @item A
3410 Current article number.
3411 @item z
3412 Current article score.
3413 @item V
3414 Gnus version.
3415 @item U
3416 Number of unread articles in this group.
3417 @item e
3418 Number of unread articles in this group that aren't displayed in the
3419 summary buffer.
3420 @item Z
3421 A string with the number of unread and unselected articles represented
3422 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3423 articles, and just as @samp{<%U more>} if there are just unread articles
3424 and no unselected ones.
3425 @item g
3426 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3427 shortened to @samp{r.a.anime}.
3428 @item S
3429 Subject of the current article.
3430 @item u
3431 User-defined spec (@pxref{User-Defined Specs}).
3432 @item s
3433 Name of the current score file (@pxref{Scoring}).
3434 @item d
3435 Number of dormant articles (@pxref{Unread Articles}).
3436 @item t
3437 Number of ticked articles (@pxref{Unread Articles}).
3438 @item r
3439 Number of articles that have been marked as read in this session.
3440 @item E
3441 Number of articles expunged by the score files.
3442 @end table
3443
3444
3445 @node Summary Highlighting
3446 @subsection Summary Highlighting
3447
3448 @table @code
3449
3450 @item gnus-visual-mark-article-hook
3451 @vindex gnus-visual-mark-article-hook
3452 This hook is run after selecting an article.  It is meant to be used for
3453 highlighting the article in some way.  It is not run if
3454 @code{gnus-visual} is @code{nil}.
3455
3456 @item gnus-summary-update-hook
3457 @vindex gnus-summary-update-hook
3458 This hook is called when a summary line is changed.  It is not run if
3459 @code{gnus-visual} is @code{nil}.
3460
3461 @item gnus-summary-selected-face
3462 @vindex gnus-summary-selected-face
3463 This is the face (or @dfn{font} as some people call it) used to
3464 highlight the current article in the summary buffer.
3465
3466 @item gnus-summary-highlight
3467 @vindex gnus-summary-highlight
3468 Summary lines are highlighted according to this variable, which is a
3469 list where the elements are of the format @var{(FORM . FACE)}.  If you
3470 would, for instance, like ticked articles to be italic and high-scored
3471 articles to be bold, you could set this variable to something like
3472 @lisp
3473 (((eq mark gnus-ticked-mark) . italic)
3474  ((> score default) . bold))
3475 @end lisp
3476 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3477 @var{FACE} will be applied to the line.
3478 @end table
3479
3480
3481 @node Summary Maneuvering
3482 @section Summary Maneuvering
3483 @cindex summary movement
3484
3485 All the straight movement commands understand the numeric prefix and
3486 behave pretty much as you'd expect.
3487
3488 None of these commands select articles.
3489
3490 @table @kbd
3491 @item G M-n
3492 @itemx M-n
3493 @kindex M-n (Summary)
3494 @kindex G M-n (Summary)
3495 @findex gnus-summary-next-unread-subject
3496 Go to the next summary line of an unread article
3497 (@code{gnus-summary-next-unread-subject}).
3498
3499 @item G M-p
3500 @itemx M-p
3501 @kindex M-p (Summary)
3502 @kindex G M-p (Summary)
3503 @findex gnus-summary-prev-unread-subject
3504 Go to the previous summary line of an unread article
3505 (@code{gnus-summary-prev-unread-subject}).
3506
3507 @item G j
3508 @itemx j
3509 @kindex j (Summary)
3510 @kindex G j (Summary)
3511 @findex gnus-summary-goto-article
3512 Ask for an article number or @code{Message-ID}, and then go to that
3513 article (@code{gnus-summary-goto-article}).
3514
3515 @item G g
3516 @kindex G g (Summary)
3517 @findex gnus-summary-goto-subject
3518 Ask for an article number and then go to the summary line of that article
3519 without displaying the article (@code{gnus-summary-goto-subject}).
3520 @end table
3521
3522 If Gnus asks you to press a key to confirm going to the next group, you
3523 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3524 buffer, searching for the next group to read without actually returning
3525 to the group buffer.
3526
3527 Variables related to summary movement:
3528
3529 @table @code
3530
3531 @vindex gnus-auto-select-next
3532 @item gnus-auto-select-next
3533 If you issue one of the movement commands (like @kbd{n}) and there are
3534 no more unread articles after the current one, Gnus will offer to go to
3535 the next group.  If this variable is @code{t} and the next group is
3536 empty, Gnus will exit summary mode and return to the group buffer.  If
3537 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3538 next group, no matter whether it has any unread articles or not.  As a
3539 special case, if this variable is @code{quietly}, Gnus will select the
3540 next group without asking for confirmation.  If this variable is
3541 @code{almost-quietly}, the same will happen only if you are located on
3542 the last article in the group.  Finally, if this variable is
3543 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3544 without confirmation.  Also @pxref{Group Levels}.
3545
3546 @item gnus-auto-select-same
3547 @vindex gnus-auto-select-same
3548 If non-@code{nil}, all the movement commands will try to go to the next
3549 article with the same subject as the current.  (@dfn{Same} here might
3550 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3551 for details (@pxref{Customizing Threading}).)  If there are no more
3552 articles with the same subject, go to the first unread article.
3553
3554 This variable is not particularly useful if you use a threaded display.
3555
3556 @item gnus-summary-check-current
3557 @vindex gnus-summary-check-current
3558 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3559 to the next (or previous) article if the current article is unread.
3560 Instead, they will choose the current article.
3561
3562 @item gnus-auto-center-summary
3563 @vindex gnus-auto-center-summary
3564 If non-@code{nil}, Gnus will keep the point in the summary buffer
3565 centered at all times.  This makes things quite tidy, but if you have a
3566 slow network connection, or simply do not like this un-Emacsism, you can
3567 set this variable to @code{nil} to get the normal Emacs scrolling
3568 action.  This will also inhibit horizontal re-centering of the summary
3569 buffer, which might make it more inconvenient to read extremely long
3570 threads.
3571
3572 @end table
3573
3574
3575 @node Choosing Articles
3576 @section Choosing Articles
3577 @cindex selecting articles
3578
3579 @menu
3580 * Choosing Commands::        Commands for choosing articles.
3581 * Choosing Variables::       Variables that influence these commands.
3582 @end menu
3583
3584
3585 @node Choosing Commands
3586 @subsection Choosing Commands
3587
3588 None of the following movement commands understand the numeric prefix,
3589 and they all select and display an article.
3590
3591 @table @kbd
3592 @item SPACE
3593 @kindex SPACE (Summary)
3594 @findex gnus-summary-next-page
3595 Select the current article, or, if that one's read already, the next
3596 unread article (@code{gnus-summary-next-page}).
3597
3598 @item G n
3599 @itemx n
3600 @kindex n (Summary)
3601 @kindex G n (Summary)
3602 @findex gnus-summary-next-unread-article
3603 @c @icon{gnus-summary-next-unread}
3604 Go to next unread article (@code{gnus-summary-next-unread-article}).
3605
3606 @item G p
3607 @itemx p
3608 @kindex p (Summary)
3609 @findex gnus-summary-prev-unread-article
3610 @c @icon{gnus-summary-prev-unread}
3611 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3612
3613 @item G N
3614 @itemx N
3615 @kindex N (Summary)
3616 @kindex G N (Summary)
3617 @findex gnus-summary-next-article
3618 Go to the next article (@code{gnus-summary-next-article}).
3619
3620 @item G P
3621 @itemx P
3622 @kindex P (Summary)
3623 @kindex G P (Summary)
3624 @findex gnus-summary-prev-article
3625 Go to the previous article (@code{gnus-summary-prev-article}).
3626
3627 @item G C-n
3628 @kindex G C-n (Summary)
3629 @findex gnus-summary-next-same-subject
3630 Go to the next article with the same subject
3631 (@code{gnus-summary-next-same-subject}).
3632
3633 @item G C-p
3634 @kindex G C-p (Summary)
3635 @findex gnus-summary-prev-same-subject
3636 Go to the previous article with the same subject
3637 (@code{gnus-summary-prev-same-subject}).
3638
3639 @item G f
3640 @itemx .
3641 @kindex G f  (Summary)
3642 @kindex .  (Summary)
3643 @findex gnus-summary-first-unread-article
3644 Go to the first unread article
3645 (@code{gnus-summary-first-unread-article}).
3646
3647 @item G b
3648 @itemx ,
3649 @kindex G b (Summary)
3650 @kindex , (Summary)
3651 @findex gnus-summary-best-unread-article
3652 Go to the article with the highest score
3653 (@code{gnus-summary-best-unread-article}).
3654
3655 @item G l
3656 @itemx l
3657 @kindex l (Summary)
3658 @kindex G l (Summary)
3659 @findex gnus-summary-goto-last-article
3660 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3661
3662 @item G o
3663 @kindex G o (Summary)
3664 @findex gnus-summary-pop-article
3665 @cindex history
3666 @cindex article history
3667 Pop an article off the summary history and go to this article
3668 (@code{gnus-summary-pop-article}).  This command differs from the
3669 command above in that you can pop as many previous articles off the
3670 history as you like, while @kbd{l} toggles the two last read articles.
3671 For a somewhat related issue (if you use these commands a lot),
3672 @pxref{Article Backlog}.
3673 @end table
3674
3675
3676 @node Choosing Variables
3677 @subsection Choosing Variables
3678
3679 Some variables relevant for moving and selecting articles:
3680
3681 @table @code
3682 @item gnus-auto-extend-newsgroup
3683 @vindex gnus-auto-extend-newsgroup
3684 All the movement commands will try to go to the previous (or next)
3685 article, even if that article isn't displayed in the Summary buffer if
3686 this variable is non-@code{nil}.  Gnus will then fetch the article from
3687 the server and display it in the article buffer.
3688
3689 @item gnus-select-article-hook
3690 @vindex gnus-select-article-hook
3691 This hook is called whenever an article is selected.  By default it
3692 exposes any threads hidden under the selected article.
3693
3694 @item gnus-mark-article-hook
3695 @vindex gnus-mark-article-hook
3696 @findex gnus-summary-mark-unread-as-read
3697 @findex gnus-summary-mark-read-and-unread-as-read
3698 @findex gnus-unread-mark
3699 This hook is called whenever an article is selected.  It is intended to
3700 be used for marking articles as read.  The default value is
3701 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3702 mark of almost any article you read to @code{gnus-unread-mark}.  The
3703 only articles not affected by this function are ticked, dormant, and
3704 expirable articles.  If you'd instead like to just have unread articles
3705 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3706 instead.  It will leave marks like @code{gnus-low-score-mark},
3707 @code{gnus-del-mark} (and so on) alone.
3708
3709 @end table
3710
3711
3712 @node Paging the Article
3713 @section Scrolling the Article
3714 @cindex article scrolling
3715
3716 @table @kbd
3717
3718 @item SPACE
3719 @kindex SPACE (Summary)
3720 @findex gnus-summary-next-page
3721 Pressing @kbd{SPACE} will scroll the current article forward one page,
3722 or, if you have come to the end of the current article, will choose the
3723 next article (@code{gnus-summary-next-page}).
3724
3725 @item DEL
3726 @kindex DEL (Summary)
3727 @findex gnus-summary-prev-page
3728 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3729
3730 @item RET
3731 @kindex RET (Summary)
3732 @findex gnus-summary-scroll-up
3733 Scroll the current article one line forward
3734 (@code{gnus-summary-scroll-up}).
3735
3736 @item M-RET
3737 @kindex M-RET (Summary)
3738 @findex gnus-summary-scroll-down
3739 Scroll the current article one line backward
3740 (@code{gnus-summary-scroll-down}).
3741
3742 @item A g
3743 @itemx g
3744 @kindex A g (Summary)
3745 @kindex g (Summary)
3746 @findex gnus-summary-show-article
3747 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3748 given a prefix, fetch the current article, but don't run any of the
3749 article treatment functions.  This will give you a ``raw'' article, just
3750 the way it came from the server.
3751
3752 @item A <
3753 @itemx <
3754 @kindex < (Summary)
3755 @kindex A < (Summary)
3756 @findex gnus-summary-beginning-of-article
3757 Scroll to the beginning of the article
3758 (@code{gnus-summary-beginning-of-article}).
3759
3760 @item A >
3761 @itemx >
3762 @kindex > (Summary)
3763 @kindex A > (Summary)
3764 @findex gnus-summary-end-of-article
3765 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3766
3767 @item A s
3768 @itemx s
3769 @kindex A s (Summary)
3770 @kindex s (Summary)
3771 @findex gnus-summary-isearch-article
3772 Perform an isearch in the article buffer
3773 (@code{gnus-summary-isearch-article}).
3774
3775 @item h
3776 @kindex h (Summary)
3777 @findex gnus-summary-select-article-buffer
3778 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3779
3780 @end table
3781
3782
3783 @node Reply Followup and Post
3784 @section Reply, Followup and Post
3785
3786 @menu
3787 * Summary Mail Commands::            Sending mail.
3788 * Summary Post Commands::            Sending news.
3789 @end menu
3790
3791
3792 @node Summary Mail Commands
3793 @subsection Summary Mail Commands
3794 @cindex mail
3795 @cindex composing mail
3796
3797 Commands for composing a mail message:
3798
3799 @table @kbd
3800
3801 @item S r
3802 @itemx r
3803 @kindex S r (Summary)
3804 @kindex r (Summary)
3805 @findex gnus-summary-reply
3806 @c @icon{gnus-summary-mail-reply}
3807 @c @icon{gnus-summary-reply}
3808 Mail a reply to the author of the current article
3809 (@code{gnus-summary-reply}).
3810
3811 @item S R
3812 @itemx R
3813 @kindex R (Summary)
3814 @kindex S R (Summary)
3815 @findex gnus-summary-reply-with-original
3816 @c @icon{gnus-summary-reply-with-original}
3817 Mail a reply to the author of the current article and include the
3818 original message (@code{gnus-summary-reply-with-original}).  This
3819 command uses the process/prefix convention.
3820
3821 @item S w
3822 @kindex S w (Summary)
3823 @findex gnus-summary-wide-reply
3824 Mail a wide reply to the author of the current article
3825 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3826 goes out to all people listed in the @code{To}, @code{From} (or
3827 @code{Reply-to}) and @code{Cc} headers.
3828
3829 @item S W
3830 @kindex S W (Summary)
3831 @findex gnus-summary-wide-reply-with-original
3832 Mail a wide reply to the current article and include the original
3833 message (@code{gnus-summary-reply-with-original}).  This command uses
3834 the process/prefix convention.
3835
3836 @item S o m
3837 @kindex S o m (Summary)
3838 @findex gnus-summary-mail-forward
3839 @c @icon{gnus-summary-mail-forward}
3840 Forward the current article to some other person
3841 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3842 headers of the forwarded article.
3843
3844 @item S m
3845 @itemx m
3846 @kindex m (Summary)
3847 @kindex S m (Summary)
3848 @findex gnus-summary-mail-other-window
3849 @c @icon{gnus-summary-mail-originate}
3850 Send a mail to some other person
3851 (@code{gnus-summary-mail-other-window}).
3852
3853 @item S D b
3854 @kindex S D b (Summary)
3855 @findex gnus-summary-resend-bounced-mail
3856 @cindex bouncing mail
3857 If you have sent a mail, but the mail was bounced back to you for some
3858 reason (wrong address, transient failure), you can use this command to
3859 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3860 will be popped into a mail buffer where you can edit the headers before
3861 sending the mail off again.  If you give a prefix to this command, and
3862 the bounced mail is a reply to some other mail, Gnus will try to fetch
3863 that mail and display it for easy perusal of its headers.  This might
3864 very well fail, though.
3865
3866 @item S D r
3867 @kindex S D r (Summary)
3868 @findex gnus-summary-resend-message
3869 Not to be confused with the previous command,
3870 @code{gnus-summary-resend-message} will prompt you for an address to
3871 send the current message off to, and then send it to that place.  The
3872 headers of the message won't be altered---but lots of headers that say
3873 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3874 means that you actually send a mail to someone that has a @code{To}
3875 header that (probably) points to yourself.  This will confuse people.
3876 So, natcherly you'll only do that if you're really eVIl.
3877
3878 This command is mainly used if you have several accounts and want to
3879 ship a mail to a different account of yours.  (If you're both
3880 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3881 to the @code{root} account, you may want to resend it to
3882 @code{postmaster}.  Ordnung muß sein!
3883
3884 This command understands the process/prefix convention
3885 (@pxref{Process/Prefix}).
3886
3887 @item S O m
3888 @kindex S O m (Summary)
3889 @findex gnus-uu-digest-mail-forward
3890 Digest the current series (@pxref{Decoding Articles}) and forward the
3891 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
3892 uses the process/prefix convention (@pxref{Process/Prefix}).
3893
3894 @item S M-c
3895 @kindex S M-c (Summary)
3896 @findex gnus-summary-mail-crosspost-complaint
3897 @cindex crossposting
3898 @cindex excessive crossposting
3899 Send a complaint about excessive crossposting to the author of the
3900 current article (@code{gnus-summary-mail-crosspost-complaint}).
3901
3902 @findex gnus-crosspost-complaint
3903 This command is provided as a way to fight back against the current
3904 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3905 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3906 command understands the process/prefix convention
3907 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3908
3909 @end table
3910
3911 Also @pxref{(message)Header Commands} for more information.
3912
3913
3914 @node Summary Post Commands
3915 @subsection Summary Post Commands
3916 @cindex post
3917 @cindex composing news
3918
3919 Commands for posting a news article:
3920
3921 @table @kbd
3922 @item S p
3923 @itemx a
3924 @kindex a (Summary)
3925 @kindex S p (Summary)
3926 @findex gnus-summary-post-news
3927 @c @icon{gnus-summary-post-news}
3928 Post an article to the current group
3929 (@code{gnus-summary-post-news}).
3930
3931 @item S f
3932 @itemx f
3933 @kindex f (Summary)
3934 @kindex S f (Summary)
3935 @findex gnus-summary-followup
3936 @c @icon{gnus-summary-followup}
3937 Post a followup to the current article (@code{gnus-summary-followup}).
3938
3939 @item S F
3940 @itemx F
3941 @kindex S F (Summary)
3942 @kindex F (Summary)
3943 @c @icon{gnus-summary-followup-with-original}
3944 @findex gnus-summary-followup-with-original
3945 Post a followup to the current article and include the original message
3946 (@code{gnus-summary-followup-with-original}).   This command uses the
3947 process/prefix convention.
3948
3949 @item S n
3950 @kindex S n (Summary)
3951 @findex gnus-summary-followup-to-mail
3952 Post a followup to the current article via news, even if you got the
3953 message through mail (@code{gnus-summary-followup-to-mail}).
3954
3955 @item S N
3956 @kindex S N (Summary)
3957 @findex gnus-summary-followup-to-mail-with-original
3958 Post a followup to the current article via news, even if you got the
3959 message through mail and include the original message
3960 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3961 the process/prefix convention.
3962
3963 @item S o p
3964 @kindex S o p (Summary)
3965 @findex gnus-summary-post-forward
3966 Forward the current article to a newsgroup
3967 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3968 headers of the forwarded article.
3969
3970 @item S O p
3971 @kindex S O p (Summary)
3972 @findex gnus-uu-digest-post-forward
3973 @cindex digests
3974 @cindex making digests
3975 Digest the current series and forward the result to a newsgroup
3976 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3977 process/prefix convention.
3978
3979 @item S u
3980 @kindex S u (Summary)
3981 @findex gnus-uu-post-news
3982 @c @icon{gnus-uu-post-news}
3983 Uuencode a file, split it into parts, and post it as a series
3984 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3985 @end table
3986
3987 Also @pxref{(message)Header Commands} for more information.
3988
3989
3990 @node Canceling and Superseding
3991 @section Canceling Articles
3992 @cindex canceling articles
3993 @cindex superseding articles
3994
3995 Have you ever written something, and then decided that you really,
3996 really, really wish you hadn't posted that?
3997
3998 Well, you can't cancel mail, but you can cancel posts.
3999
4000 @findex gnus-summary-cancel-article
4001 @kindex C (Summary)
4002 @c @icon{gnus-summary-cancel-article}
4003 Find the article you wish to cancel (you can only cancel your own
4004 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
4005 c} (@code{gnus-summary-cancel-article}).  Your article will be
4006 canceled---machines all over the world will be deleting your article.
4007 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4008
4009 Be aware, however, that not all sites honor cancels, so your article may
4010 live on here and there, while most sites will delete the article in
4011 question.
4012
4013 Gnus will use the ``current'' select method when canceling.  If you
4014 want to use the standard posting method, use the @samp{a} symbolic
4015 prefix (@pxref{Symbolic Prefixes}).
4016
4017 If you discover that you have made some mistakes and want to do some
4018 corrections, you can post a @dfn{superseding} article that will replace
4019 your original article.
4020
4021 @findex gnus-summary-supersede-article
4022 @kindex S (Summary)
4023 Go to the original article and press @kbd{S s}
4024 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
4025 where you can edit the article all you want before sending it off the
4026 usual way.
4027
4028 The same goes for superseding as for canceling, only more so: Some
4029 sites do not honor superseding.  On those sites, it will appear that you
4030 have posted almost the same article twice.
4031
4032 If you have just posted the article, and change your mind right away,
4033 there is a trick you can use to cancel/supersede the article without
4034 waiting for the article to appear on your site first.  You simply return
4035 to the post buffer (which is called @code{*sent ...*}).  There you will
4036 find the article you just posted, with all the headers intact.  Change
4037 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4038 header by substituting one of those words for the word
4039 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
4040 you would do normally.  The previous article will be
4041 canceled/superseded.
4042
4043 Just remember, kids: There is no 'c' in 'supersede'.
4044
4045
4046 @node Marking Articles
4047 @section Marking Articles
4048 @cindex article marking
4049 @cindex article ticking
4050 @cindex marks
4051
4052 There are several marks you can set on an article.
4053
4054 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4055 neologism ohoy!) of the article.  Alphabetic marks generally mean
4056 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4057
4058 In addition, you also have marks that do not affect readedness.
4059
4060 @menu
4061 * Unread Articles::      Marks for unread articles.
4062 * Read Articles::        Marks for read articles.
4063 * Other Marks::          Marks that do not affect readedness.
4064 @end menu
4065
4066 @ifinfo
4067 There's a plethora of commands for manipulating these marks:
4068 @end ifinfo
4069
4070 @menu
4071 * Setting Marks::           How to set and remove marks.
4072 * Setting Process Marks::   How to mark articles for later processing.
4073 @end menu
4074
4075
4076 @node Unread Articles
4077 @subsection Unread Articles
4078
4079 The following marks mark articles as (kinda) unread, in one form or
4080 other.
4081
4082 @table @samp
4083 @item !
4084 @vindex gnus-ticked-mark
4085 Marked as ticked (@code{gnus-ticked-mark}).
4086
4087 @dfn{Ticked articles} are articles that will remain visible always.  If
4088 you see an article that you find interesting, or you want to put off
4089 reading it, or replying to it, until sometime later, you'd typically
4090 tick it.  However, articles can be expired, so if you want to keep an
4091 article forever, you'll have to make it persistent (@pxref{Persistent
4092 Articles}).
4093
4094 @item ?
4095 @vindex gnus-dormant-mark
4096 Marked as dormant (@code{gnus-dormant-mark}).
4097
4098 @dfn{Dormant articles} will only appear in the summary buffer if there
4099 are followups to it.  If you want to see them even if they don't have
4100 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4101
4102 @item SPACE
4103 @vindex gnus-unread-mark
4104 Marked as unread (@code{gnus-unread-mark}).
4105
4106 @dfn{Unread articles} are articles that haven't been read at all yet.
4107 @end table
4108
4109
4110 @node Read Articles
4111 @subsection Read Articles
4112 @cindex expirable mark
4113
4114 All the following marks mark articles as read.
4115
4116 @table @samp
4117
4118 @item r
4119 @vindex gnus-del-mark
4120 These are articles that the user has marked as read with the @kbd{d}
4121 command manually, more or less (@code{gnus-del-mark}).
4122
4123 @item R
4124 @vindex gnus-read-mark
4125 Articles that have actually been read (@code{gnus-read-mark}).
4126
4127 @item O
4128 @vindex gnus-ancient-mark
4129 Articles that were marked as read in previous sessions and are now
4130 @dfn{old} (@code{gnus-ancient-mark}).
4131
4132 @item K
4133 @vindex gnus-killed-mark
4134 Marked as killed (@code{gnus-killed-mark}).
4135
4136 @item X
4137 @vindex gnus-kill-file-mark
4138 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4139
4140 @item Y
4141 @vindex gnus-low-score-mark
4142 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4143
4144 @item C
4145 @vindex gnus-catchup-mark
4146 Marked as read by a catchup (@code{gnus-catchup-mark}).
4147
4148 @item G
4149 @vindex gnus-canceled-mark
4150 Canceled article (@code{gnus-canceled-mark})
4151
4152 @item F
4153 @vindex gnus-souped-mark
4154 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4155
4156 @item Q
4157 @vindex gnus-sparse-mark
4158 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4159 Threading}.
4160
4161 @item M
4162 @vindex gnus-duplicate-mark
4163 Article marked as read by duplicate suppression
4164 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4165
4166 @end table
4167
4168 All these marks just mean that the article is marked as read, really.
4169 They are interpreted differently when doing adaptive scoring, though.
4170
4171 One more special mark, though:
4172
4173 @table @samp
4174 @item E
4175 @vindex gnus-expirable-mark
4176 Marked as expirable (@code{gnus-expirable-mark}).
4177
4178 Marking articles as @dfn{expirable} (or have them marked as such
4179 automatically) doesn't make much sense in normal groups---a user doesn't
4180 control expiring of news articles, but in mail groups, for instance,
4181 articles marked as @dfn{expirable} can be deleted by Gnus at
4182 any time.
4183 @end table
4184
4185
4186 @node Other Marks
4187 @subsection Other Marks
4188 @cindex process mark
4189 @cindex bookmarks
4190
4191 There are some marks that have nothing to do with whether the article is
4192 read or not.
4193
4194 @itemize @bullet
4195
4196 @item
4197 You can set a bookmark in the current article.  Say you are reading a
4198 long thesis on cats' urinary tracts, and have to go home for dinner
4199 before you've finished reading the thesis.  You can then set a bookmark
4200 in the article, and Gnus will jump to this bookmark the next time it
4201 encounters the article.  @xref{Setting Marks}.
4202
4203 @item
4204 @vindex gnus-replied-mark
4205 All articles that you have replied to or made a followup to (i.e., have
4206 answered) will be marked with an @samp{A} in the second column
4207 (@code{gnus-replied-mark}).
4208
4209 @item
4210 @vindex gnus-cached-mark
4211 Articles stored in the article cache will be marked with an @samp{*} in
4212 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
4213
4214 @item
4215 @vindex gnus-saved-mark
4216 Articles ``saved'' (in some manner or other; not necessarily
4217 religiously) are marked with an @samp{S} in the second column
4218 (@code{gnus-saved-mark}).
4219
4220 @item
4221 @vindex gnus-not-empty-thread-mark
4222 @vindex gnus-empty-thread-mark
4223 If the @samp{%e} spec is used, the presence of threads or not will be
4224 marked with @code{gnus-not-empty-thread-mark} and
4225 @code{gnus-empty-thread-mark} in the third column, respectively.
4226
4227 @item
4228 @vindex gnus-process-mark
4229 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4230 variety of commands react to the presence of the process mark.  For
4231 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4232 all articles that have been marked with the process mark.  Articles
4233 marked with the process mark have a @samp{#} in the second column.
4234
4235 @end itemize
4236
4237 You might have noticed that most of these ``non-readedness'' marks
4238 appear in the second column by default.  So if you have a cached, saved,
4239 replied article that you have process-marked, what will that look like?
4240
4241 Nothing much.  The precedence rules go as follows: process -> cache ->
4242 replied -> saved.  So if the article is in the cache and is replied,
4243 you'll only see the cache mark and not the replied mark.
4244
4245
4246 @node Setting Marks
4247 @subsection Setting Marks
4248 @cindex setting marks
4249
4250 All the marking commands understand the numeric prefix.
4251
4252 @table @kbd
4253 @item M c
4254 @itemx M-u
4255 @kindex M c (Summary)
4256 @kindex M-u (Summary)
4257 @findex gnus-summary-clear-mark-forward
4258 @cindex mark as unread
4259 Clear all readedness-marks from the current article
4260 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4261 article as unread.
4262
4263 @item M t
4264 @itemx !
4265 @kindex ! (Summary)
4266 @kindex M t (Summary)
4267 @findex gnus-summary-tick-article-forward
4268 Tick the current article (@code{gnus-summary-tick-article-forward}).
4269 @xref{Article Caching}.
4270
4271 @item M ?
4272 @itemx ?
4273 @kindex ? (Summary)
4274 @kindex M ? (Summary)
4275 @findex gnus-summary-mark-as-dormant
4276 Mark the current article as dormant
4277 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
4278
4279 @item M d
4280 @itemx d
4281 @kindex M d (Summary)
4282 @kindex d (Summary)
4283 @findex gnus-summary-mark-as-read-forward
4284 Mark the current article as read
4285 (@code{gnus-summary-mark-as-read-forward}).
4286
4287 @item D
4288 @kindex D (Summary)
4289 @findex gnus-summary-mark-as-read-backward
4290 Mark the current article as read and move point to the previous line
4291 (@code{gnus-summary-mark-as-read-backward}).
4292
4293 @item M k
4294 @itemx k
4295 @kindex k (Summary)
4296 @kindex M k (Summary)
4297 @findex gnus-summary-kill-same-subject-and-select
4298 Mark all articles that have the same subject as the current one as read,
4299 and then select the next unread article
4300 (@code{gnus-summary-kill-same-subject-and-select}).
4301
4302 @item M K
4303 @itemx C-k
4304 @kindex M K (Summary)
4305 @kindex C-k (Summary)
4306 @findex gnus-summary-kill-same-subject
4307 Mark all articles that have the same subject as the current one as read
4308 (@code{gnus-summary-kill-same-subject}).
4309
4310 @item M C
4311 @kindex M C (Summary)
4312 @findex gnus-summary-catchup
4313 @c @icon{gnus-summary-catchup}
4314 Mark all unread articles as read (@code{gnus-summary-catchup}).
4315
4316 @item M C-c
4317 @kindex M C-c (Summary)
4318 @findex gnus-summary-catchup-all
4319 Mark all articles in the group as read---even the ticked and dormant
4320 articles (@code{gnus-summary-catchup-all}).
4321
4322 @item M H
4323 @kindex M H (Summary)
4324 @findex gnus-summary-catchup-to-here
4325 Catchup the current group to point
4326 (@code{gnus-summary-catchup-to-here}).
4327
4328 @item C-w
4329 @kindex C-w (Summary)
4330 @findex gnus-summary-mark-region-as-read
4331 Mark all articles between point and mark as read
4332 (@code{gnus-summary-mark-region-as-read}).
4333
4334 @item M V k
4335 @kindex M V k (Summary)
4336 @findex gnus-summary-kill-below
4337 Kill all articles with scores below the default score (or below the
4338 numeric prefix) (@code{gnus-summary-kill-below}).
4339
4340 @item M e
4341 @itemx E
4342 @kindex M e (Summary)
4343 @kindex E (Summary)
4344 @findex gnus-summary-mark-as-expirable
4345 Mark the current article as expirable
4346 (@code{gnus-summary-mark-as-expirable}).
4347
4348 @item M b
4349 @kindex M b (Summary)
4350 @findex gnus-summary-set-bookmark
4351 Set a bookmark in the current article
4352 (@code{gnus-summary-set-bookmark}).
4353
4354 @item M B
4355 @kindex M B (Summary)
4356 @findex gnus-summary-remove-bookmark
4357 Remove the bookmark from the current article
4358 (@code{gnus-summary-remove-bookmark}).
4359
4360 @item M V c
4361 @kindex M V c (Summary)
4362 @findex gnus-summary-clear-above
4363 Clear all marks from articles with scores over the default score (or
4364 over the numeric prefix) (@code{gnus-summary-clear-above}).
4365
4366 @item M V u
4367 @kindex M V u (Summary)
4368 @findex gnus-summary-tick-above
4369 Tick all articles with scores over the default score (or over the
4370 numeric prefix) (@code{gnus-summary-tick-above}).
4371
4372 @item M V m
4373 @kindex M V m (Summary)
4374 @findex gnus-summary-mark-above
4375 Prompt for a mark, and mark all articles with scores over the default
4376 score (or over the numeric prefix) with this mark
4377 (@code{gnus-summary-clear-above}).
4378 @end table
4379
4380 @vindex gnus-summary-goto-unread
4381 The @code{gnus-summary-goto-unread} variable controls what action should
4382 be taken after setting a mark.  If non-@code{nil}, point will move to
4383 the next/previous unread article.  If @code{nil}, point will just move
4384 one line up or down.  As a special case, if this variable is
4385 @code{never}, all the marking commands as well as other commands (like
4386 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4387 The default is @code{t}.
4388
4389
4390 @node Setting Process Marks
4391 @subsection Setting Process Marks
4392 @cindex setting process marks
4393
4394 @table @kbd
4395
4396 @item M P p
4397 @itemx #
4398 @kindex # (Summary)
4399 @kindex M P p (Summary)
4400 @findex gnus-summary-mark-as-processable
4401 Mark the current article with the process mark
4402 (@code{gnus-summary-mark-as-processable}).
4403 @findex gnus-summary-unmark-as-processable
4404
4405 @item M P u
4406 @itemx M-#
4407 @kindex M P u (Summary)
4408 @kindex M-# (Summary)
4409 Remove the process mark, if any, from the current article
4410 (@code{gnus-summary-unmark-as-processable}).
4411
4412 @item M P U
4413 @kindex M P U (Summary)
4414 @findex gnus-summary-unmark-all-processable
4415 Remove the process mark from all articles
4416 (@code{gnus-summary-unmark-all-processable}).
4417
4418 @item M P i
4419 @kindex M P i (Summary)
4420 @findex gnus-uu-invert-processable
4421 Invert the list of process marked articles
4422 (@code{gnus-uu-invert-processable}).
4423
4424 @item M P R
4425 @kindex M P R (Summary)
4426 @findex gnus-uu-mark-by-regexp
4427 Mark articles that have a @code{Subject} header that matches a regular
4428 expression (@code{gnus-uu-mark-by-regexp}).
4429
4430 @item M P r
4431 @kindex M P r (Summary)
4432 @findex gnus-uu-mark-region
4433 Mark articles in region (@code{gnus-uu-mark-region}).
4434
4435 @item M P t
4436 @kindex M P t (Summary)
4437 @findex gnus-uu-mark-thread
4438 Mark all articles in the current (sub)thread
4439 (@code{gnus-uu-mark-thread}).
4440
4441 @item M P T
4442 @kindex M P T (Summary)
4443 @findex gnus-uu-unmark-thread
4444 Unmark all articles in the current (sub)thread
4445 (@code{gnus-uu-unmark-thread}).
4446
4447 @item M P v
4448 @kindex M P v (Summary)
4449 @findex gnus-uu-mark-over
4450 Mark all articles that have a score above the prefix argument
4451 (@code{gnus-uu-mark-over}).
4452
4453 @item M P s
4454 @kindex M P s (Summary)
4455 @findex gnus-uu-mark-series
4456 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4457
4458 @item M P S
4459 @kindex M P S (Summary)
4460 @findex gnus-uu-mark-sparse
4461 Mark all series that have already had some articles marked
4462 (@code{gnus-uu-mark-sparse}).
4463
4464 @item M P a
4465 @kindex M P a (Summary)
4466 @findex gnus-uu-mark-all
4467 Mark all articles in series order (@code{gnus-uu-mark-series}).
4468
4469 @item M P b
4470 @kindex M P b (Summary)
4471 @findex gnus-uu-mark-buffer
4472 Mark all articles in the buffer in the order they appear
4473 (@code{gnus-uu-mark-buffer}).
4474
4475 @item M P k
4476 @kindex M P k (Summary)
4477 @findex gnus-summary-kill-process-mark
4478 Push the current process mark set onto the stack and unmark all articles
4479 (@code{gnus-summary-kill-process-mark}).
4480
4481 @item M P y
4482 @kindex M P y (Summary)
4483 @findex gnus-summary-yank-process-mark
4484 Pop the previous process mark set from the stack and restore it
4485 (@code{gnus-summary-yank-process-mark}).
4486
4487 @item M P w
4488 @kindex M P w (Summary)
4489 @findex gnus-summary-save-process-mark
4490 Push the current process mark set onto the stack
4491 (@code{gnus-summary-save-process-mark}).
4492
4493 @end table
4494
4495
4496 @node Limiting
4497 @section Limiting
4498 @cindex limiting
4499
4500 It can be convenient to limit the summary buffer to just show some
4501 subset of the articles currently in the group.  The effect most limit
4502 commands have is to remove a few (or many) articles from the summary
4503 buffer.
4504
4505 All limiting commands work on subsets of the articles already fetched
4506 from the servers.  None of these commands query the server for
4507 additional articles.
4508
4509 @table @kbd
4510
4511 @item / /
4512 @itemx / s
4513 @kindex / / (Summary)
4514 @findex gnus-summary-limit-to-subject
4515 Limit the summary buffer to articles that match some subject
4516 (@code{gnus-summary-limit-to-subject}).
4517
4518 @item / a
4519 @kindex / a (Summary)
4520 @findex gnus-summary-limit-to-author
4521 Limit the summary buffer to articles that match some author
4522 (@code{gnus-summary-limit-to-author}).
4523
4524 @item / u
4525 @itemx x
4526 @kindex / u (Summary)
4527 @kindex x (Summary)
4528 @findex gnus-summary-limit-to-unread
4529 Limit the summary buffer to articles not marked as read
4530 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4531 buffer to articles strictly unread.  This means that ticked and
4532 dormant articles will also be excluded.
4533
4534 @item / m
4535 @kindex / m (Summary)
4536 @findex gnus-summary-limit-to-marks
4537 Ask for a mark and then limit to all articles that have been marked
4538 with that mark (@code{gnus-summary-limit-to-marks}).
4539
4540 @item / t
4541 @kindex / t (Summary)
4542 @findex gnus-summary-limit-to-age
4543 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4544 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4545 articles younger than that number of days.
4546
4547 @item / n
4548 @kindex / n (Summary)
4549 @findex gnus-summary-limit-to-articles
4550 Limit the summary buffer to the current article
4551 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4552 convention (@pxref{Process/Prefix}).
4553
4554 @item / w
4555 @kindex / w (Summary)
4556 @findex gnus-summary-pop-limit
4557 Pop the previous limit off the stack and restore it
4558 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4559 the stack.
4560
4561 @item / v
4562 @kindex / v (Summary)
4563 @findex gnus-summary-limit-to-score
4564 Limit the summary buffer to articles that have a score at or above some
4565 score (@code{gnus-summary-limit-to-score}).
4566
4567 @item / E
4568 @itemx M S
4569 @kindex M S (Summary)
4570 @kindex / E (Summary)
4571 @findex gnus-summary-limit-include-expunged
4572 Include all expunged articles in the limit
4573 (@code{gnus-summary-limit-include-expunged}).
4574
4575 @item / D
4576 @kindex / D (Summary)
4577 @findex gnus-summary-limit-include-dormant
4578 Include all dormant articles in the limit
4579 (@code{gnus-summary-limit-include-dormant}).
4580
4581 @item / *
4582 @kindex / * (Summary)
4583 @findex gnus-summary-limit-include-cached
4584 Include all cached articles in the limit
4585 (@code{gnus-summary-limit-include-cached}).
4586
4587 @item / d
4588 @kindex / d (Summary)
4589 @findex gnus-summary-limit-exclude-dormant
4590 Exclude all dormant articles from the limit
4591 (@code{gnus-summary-limit-exclude-dormant}).
4592
4593 @item / T
4594 @kindex / T (Summary)
4595 @findex gnus-summary-limit-include-thread
4596 Include all the articles in the current thread in the limit.
4597
4598 @item / c
4599 @kindex / c (Summary)
4600 @findex gnus-summary-limit-exclude-childless-dormant
4601 Exclude all dormant articles that have no children from the limit
4602 (@code{gnus-summary-limit-exclude-childless-dormant}).
4603
4604 @item / C
4605 @kindex / C (Summary)
4606 @findex gnus-summary-limit-mark-excluded-as-read
4607 Mark all excluded unread articles as read
4608 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4609 also mark excluded ticked and dormant articles as read.
4610
4611 @end table
4612
4613
4614 @node Threading
4615 @section Threading
4616 @cindex threading
4617 @cindex article threading
4618
4619 Gnus threads articles by default.  @dfn{To thread} is to put responses
4620 to articles directly after the articles they respond to---in a
4621 hierarchical fashion.
4622
4623 Threading is done by looking at the @code{References} headers of the
4624 articles.  In a perfect world, this would be enough to build pretty
4625 trees, but unfortunately, the @code{References} header is often broken
4626 or simply missing.  Weird news propagation excarcerbates the problem,
4627 so one has to employ other heuristics to get pleasing results.  A
4628 plethora of approaches exists, as detailed in horrible detail in
4629 @pxref{Customizing Threading}.
4630
4631 First, a quick overview of the concepts:
4632
4633 @table @dfn
4634 @item root
4635 The top-most article in a thread; the first article in the thread.
4636
4637 @item thread
4638 A tree-like article structure.
4639
4640 @item sub-thread
4641 A small(er) section of this tree-like structure.
4642
4643 @item loose threads
4644 Threads often lose their roots due to article expiry, or due to the root
4645 already having been read in a previous session, and not displayed in the
4646 summary buffer.  We then typically have many sub-threads that really
4647 belong to one thread, but are without connecting roots.  These are
4648 called loose threads.
4649
4650 @item thread gathering
4651 An attempt to gather loose threads into bigger threads.
4652
4653 @item sparse threads
4654 A thread where the missing articles have been ``guessed'' at, and are
4655 displayed as empty lines in the summary buffer.
4656
4657 @end table
4658
4659
4660 @menu
4661 * Customizing Threading::     Variables you can change to affect the threading.
4662 * Thread Commands::           Thread based commands in the summary buffer.
4663 @end menu
4664
4665
4666 @node Customizing Threading
4667 @subsection Customizing Threading
4668 @cindex customizing threading
4669
4670 @menu
4671 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
4672 * Filling In Threads::   Making the threads displayed look fuller.
4673 * More Threading::       Even more variables for fiddling with threads.
4674 * Low-Level Threading::  You thought it was over... but you were wrong!
4675 @end menu
4676
4677
4678 @node Loose Threads
4679 @subsubsection Loose Threads
4680 @cindex <
4681 @cindex >
4682 @cindex loose threads
4683
4684 @table @code
4685 @item gnus-summary-make-false-root
4686 @vindex gnus-summary-make-false-root
4687 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4688 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4689 Yup.)  Loose subtrees occur when the real root has expired, or you've
4690 read or killed the root in a previous session.
4691
4692 When there is no real root of a thread, Gnus will have to fudge
4693 something.  This variable says what fudging method Gnus should use.
4694 There are four possible values:
4695
4696 @iftex
4697 @iflatex
4698 \gnusfigure{The Summary Buffer}{390}{
4699 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4700 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4701 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4702 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4703 }
4704 @end iflatex
4705 @end iftex
4706
4707 @cindex adopting articles
4708
4709 @table @code
4710
4711 @item adopt
4712 Gnus will make the first of the orphaned articles the parent.  This
4713 parent will adopt all the other articles.  The adopted articles will be
4714 marked as such by pointy brackets (@samp{<>}) instead of the standard
4715 square brackets (@samp{[]}).  This is the default method.
4716
4717 @item dummy
4718 @vindex gnus-summary-dummy-line-format
4719 Gnus will create a dummy summary line that will pretend to be the
4720 parent.  This dummy line does not correspond to any real article, so
4721 selecting it will just select the first real article after the dummy
4722 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4723 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4724 which is the subject of the article.  @xref{Formatting Variables}.
4725
4726 @item empty
4727 Gnus won't actually make any article the parent, but simply leave the
4728 subject field of all orphans except the first empty.  (Actually, it will
4729 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4730 Buffer Format}).)
4731
4732 @item none
4733 Don't make any article parent at all.  Just gather the threads and
4734 display them after one another.
4735
4736 @item nil
4737 Don't gather loose threads.
4738 @end table
4739
4740 @item gnus-summary-gather-subject-limit
4741 @vindex gnus-summary-gather-subject-limit
4742 Loose threads are gathered by comparing subjects of articles.  If this
4743 variable is @code{nil}, Gnus requires an exact match between the
4744 subjects of the loose threads before gathering them into one big
4745 super-thread.  This might be too strict a requirement, what with the
4746 presence of stupid newsreaders that chop off long subject lines.  If
4747 you think so, set this variable to, say, 20 to require that only the
4748 first 20 characters of the subjects have to match.  If you set this
4749 variable to a really low number, you'll find that Gnus will gather
4750 everything in sight into one thread, which isn't very helpful.
4751
4752 @cindex fuzzy article gathering
4753 If you set this variable to the special value @code{fuzzy}, Gnus will
4754 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4755 Matching}).
4756
4757 @item gnus-simplify-subject-fuzzy-regexp
4758 @vindex gnus-simplify-subject-fuzzy-regexp
4759 This can either be a regular expression or list of regular expressions
4760 that match strings that will be removed from subjects if fuzzy subject
4761 simplification is used.
4762
4763 @item gnus-simplify-ignored-prefixes
4764 @vindex gnus-simplify-ignored-prefixes
4765 If you set @code{gnus-summary-gather-subject-limit} to something as low
4766 as 10, you might consider setting this variable to something sensible:
4767
4768 @c Written by Michael Ernst <mernst@cs.rice.edu>
4769 @lisp
4770 (setq gnus-simplify-ignored-prefixes
4771       (concat
4772        "\\`\\[?\\("
4773        (mapconcat
4774         'identity
4775         '("looking"
4776           "wanted" "followup" "summary\\( of\\)?"
4777           "help" "query" "problem" "question"
4778           "answer" "reference" "announce"
4779           "How can I" "How to" "Comparison of"
4780           ;; ...
4781           )
4782         "\\|")
4783        "\\)\\s *\\("
4784        (mapconcat 'identity
4785                   '("for" "for reference" "with" "about")
4786                   "\\|")
4787        "\\)?\\]?:?[ \t]*"))
4788 @end lisp
4789
4790 All words that match this regexp will be removed before comparing two
4791 subjects.
4792
4793 @item gnus-simplify-subject-functions
4794 @vindex gnus-simplify-subject-functions
4795 If non-@code{nil}, this variable overrides
4796 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4797 list of functions to apply to the @code{Subject} string iteratively to
4798 arrive at the simplified version of the string.
4799
4800 Useful functions to put in this list include:
4801
4802 @table @code
4803 @item gnus-simplify-subject-re
4804 @findex gnus-simplify-subject-re
4805 Strip the leading @samp{Re:}.
4806
4807 @item gnus-simplify-subject-fuzzy
4808 @findex gnus-simplify-subject-fuzzy
4809 Simplify fuzzily.
4810
4811 @item gnus-simplify-whitespace
4812 @findex gnus-simplify-whitespace
4813 Remove excessive whitespace.
4814 @end table
4815
4816 You may also write your own functions, of course.
4817
4818
4819 @item gnus-summary-gather-exclude-subject
4820 @vindex gnus-summary-gather-exclude-subject
4821 Since loose thread gathering is done on subjects only, that might lead
4822 to many false hits, especially with certain common subjects like
4823 @samp{} and @samp{(none)}.  To make the situation slightly better,
4824 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4825 what subjects should be excluded from the gathering process.@*
4826 The default is @samp{^ *$\\|^(none)$}.
4827
4828 @item gnus-summary-thread-gathering-function
4829 @vindex gnus-summary-thread-gathering-function
4830 Gnus gathers threads by looking at @code{Subject} headers.  This means
4831 that totally unrelated articles may end up in the same ``thread'', which
4832 is confusing.  An alternate approach is to look at all the
4833 @code{Message-ID}s in all the @code{References} headers to find matches.
4834 This will ensure that no gathered threads ever include unrelated
4835 articles, but it also means that people who have posted with broken
4836 newsreaders won't be gathered properly.  The choice is yours---plague or
4837 cholera:
4838
4839 @table @code
4840 @item gnus-gather-threads-by-subject
4841 @findex gnus-gather-threads-by-subject
4842 This function is the default gathering function and looks at
4843 @code{Subject}s exclusively.
4844
4845 @item gnus-gather-threads-by-references
4846 @findex gnus-gather-threads-by-references
4847 This function looks at @code{References} headers exclusively.
4848 @end table
4849
4850 If you want to test gathering by @code{References}, you could say
4851 something like:
4852
4853 @lisp
4854 (setq gnus-summary-thread-gathering-function
4855       'gnus-gather-threads-by-references)
4856 @end lisp
4857
4858 @end table
4859
4860
4861 @node Filling In Threads
4862 @subsubsection Filling In Threads
4863
4864 @table @code
4865 @item gnus-fetch-old-headers
4866 @vindex gnus-fetch-old-headers
4867 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4868 more old headers---headers to articles marked as read.  If you
4869 would like to display as few summary lines as possible, but still
4870 connect as many loose threads as possible, you should set this variable
4871 to @code{some} or a number.  If you set it to a number, no more than
4872 that number of extra old headers will be fetched.  In either case,
4873 fetching old headers only works if the backend you are using carries
4874 overview files---this would normally be @code{nntp}, @code{nnspool} and
4875 @code{nnml}.  Also remember that if the root of the thread has been
4876 expired by the server, there's not much Gnus can do about that.
4877
4878 This variable can also be set to @code{invisible}.  This won't have any
4879 visible effects, but is useful if you use the @kbd{A T} command a lot
4880 (@pxref{Finding the Parent}).
4881
4882 @item gnus-build-sparse-threads
4883 @vindex gnus-build-sparse-threads
4884 Fetching old headers can be slow.  A low-rent similar effect can be
4885 gotten by setting this variable to @code{some}.  Gnus will then look at
4886 the complete @code{References} headers of all articles and try to string
4887 together articles that belong in the same thread.  This will leave
4888 @dfn{gaps} in the threading display where Gnus guesses that an article
4889 is missing from the thread.  (These gaps appear like normal summary
4890 lines.  If you select a gap, Gnus will try to fetch the article in
4891 question.)  If this variable is @code{t}, Gnus will display all these
4892 ``gaps'' without regard for whether they are useful for completing the
4893 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4894 off sparse leaf nodes that don't lead anywhere.  This variable is
4895 @code{nil} by default.
4896
4897 @end table
4898
4899
4900 @node More Threading
4901 @subsubsection More Threading
4902
4903 @table @code
4904 @item gnus-show-threads
4905 @vindex gnus-show-threads
4906 If this variable is @code{nil}, no threading will be done, and all of
4907 the rest of the variables here will have no effect.  Turning threading
4908 off will speed group selection up a bit, but it is sure to make reading
4909 slower and more awkward.
4910
4911 @item gnus-thread-hide-subtree
4912 @vindex gnus-thread-hide-subtree
4913 If non-@code{nil}, all threads will be hidden when the summary buffer is
4914 generated.
4915
4916 @item gnus-thread-expunge-below
4917 @vindex gnus-thread-expunge-below
4918 All threads that have a total score (as defined by
4919 @code{gnus-thread-score-function}) less than this number will be
4920 expunged.  This variable is @code{nil} by default, which means that no
4921 threads are expunged.
4922
4923 @item gnus-thread-hide-killed
4924 @vindex gnus-thread-hide-killed
4925 if you kill a thread and this variable is non-@code{nil}, the subtree
4926 will be hidden.
4927
4928 @item gnus-thread-ignore-subject
4929 @vindex gnus-thread-ignore-subject
4930 Sometimes somebody changes the subject in the middle of a thread.  If
4931 this variable is non-@code{nil}, the subject change is ignored.  If it
4932 is @code{nil}, which is the default, a change in the subject will result
4933 in a new thread.
4934
4935 @item gnus-thread-indent-level
4936 @vindex gnus-thread-indent-level
4937 This is a number that says how much each sub-thread should be indented.
4938 The default is 4.
4939
4940 @end table
4941
4942
4943 @node Low-Level Threading
4944 @subsubsection Low-Level Threading
4945
4946 @table @code
4947
4948 @item gnus-parse-headers-hook
4949 @vindex gnus-parse-headers-hook
4950 Hook run before parsing any headers.
4951
4952 @item gnus-alter-header-function
4953 @vindex gnus-alter-header-function
4954 If non-@code{nil}, this function will be called to allow alteration of
4955 article header structures.  The function is called with one parameter,
4956 the article header vector, which it may alter in any way.  For instance,
4957 if you have a mail-to-news gateway which alters the @code{Message-ID}s
4958 in systematic ways (by adding prefixes and such), you can use this
4959 variable to un-scramble the @code{Message-ID}s so that they are more
4960 meaningful.  Here's one example:
4961
4962 @lisp
4963 (setq gnus-alter-header-function 'my-alter-message-id)
4964
4965 (defun my-alter-message-id (header)
4966   (let ((id (mail-header-id header)))
4967     (when (string-match
4968            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
4969       (mail-header-set-id
4970        (concat (match-string 1 id) "@@" (match-string 2 id))
4971        header))))
4972 @end lisp
4973
4974 @end table
4975
4976
4977 @node Thread Commands
4978 @subsection Thread Commands
4979 @cindex thread commands
4980
4981 @table @kbd
4982
4983 @item T k
4984 @itemx M-C-k
4985 @kindex T k (Summary)
4986 @kindex M-C-k (Summary)
4987 @findex gnus-summary-kill-thread
4988 Mark all articles in the current (sub-)thread as read
4989 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4990 remove all marks instead.  If the prefix argument is negative, tick
4991 articles instead.
4992
4993 @item T l
4994 @itemx M-C-l
4995 @kindex T l (Summary)
4996 @kindex M-C-l (Summary)
4997 @findex gnus-summary-lower-thread
4998 Lower the score of the current (sub-)thread
4999 (@code{gnus-summary-lower-thread}).
5000
5001 @item T i
5002 @kindex T i (Summary)
5003 @findex gnus-summary-raise-thread
5004 Increase the score of the current (sub-)thread
5005 (@code{gnus-summary-raise-thread}).
5006
5007 @item T #
5008 @kindex T # (Summary)
5009 @findex gnus-uu-mark-thread
5010 Set the process mark on the current (sub-)thread
5011 (@code{gnus-uu-mark-thread}).
5012
5013 @item T M-#
5014 @kindex T M-# (Summary)
5015 @findex gnus-uu-unmark-thread
5016 Remove the process mark from the current (sub-)thread
5017 (@code{gnus-uu-unmark-thread}).
5018
5019 @item T T
5020 @kindex T T (Summary)
5021 @findex gnus-summary-toggle-threads
5022 Toggle threading (@code{gnus-summary-toggle-threads}).
5023
5024 @item T s
5025 @kindex T s (Summary)
5026 @findex gnus-summary-show-thread
5027 Expose the (sub-)thread hidden under the current article, if any
5028 (@code{gnus-summary-show-thread}).
5029
5030 @item T h
5031 @kindex T h (Summary)
5032 @findex gnus-summary-hide-thread
5033 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5034
5035 @item T S
5036 @kindex T S (Summary)
5037 @findex gnus-summary-show-all-threads
5038 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5039
5040 @item T H
5041 @kindex T H (Summary)
5042 @findex gnus-summary-hide-all-threads
5043 Hide all threads (@code{gnus-summary-hide-all-threads}).
5044
5045 @item T t
5046 @kindex T t (Summary)
5047 @findex gnus-summary-rethread-current
5048 Re-thread the current article's thread
5049 (@code{gnus-summary-rethread-current}).  This works even when the
5050 summary buffer is otherwise unthreaded.
5051
5052 @item T ^
5053 @kindex T ^ (Summary)
5054 @findex gnus-summary-reparent-thread
5055 Make the current article the child of the marked (or previous) article
5056 (@code{gnus-summary-reparent-thread}).
5057
5058 @end table
5059
5060 The following commands are thread movement commands.  They all
5061 understand the numeric prefix.
5062
5063 @table @kbd
5064
5065 @item T n
5066 @kindex T n (Summary)
5067 @findex gnus-summary-next-thread
5068 Go to the next thread (@code{gnus-summary-next-thread}).
5069
5070 @item T p
5071 @kindex T p (Summary)
5072 @findex gnus-summary-prev-thread
5073 Go to the previous thread (@code{gnus-summary-prev-thread}).
5074
5075 @item T d
5076 @kindex T d (Summary)
5077 @findex gnus-summary-down-thread
5078 Descend the thread (@code{gnus-summary-down-thread}).
5079
5080 @item T u
5081 @kindex T u (Summary)
5082 @findex gnus-summary-up-thread
5083 Ascend the thread (@code{gnus-summary-up-thread}).
5084
5085 @item T o
5086 @kindex T o (Summary)
5087 @findex gnus-summary-top-thread
5088 Go to the top of the thread (@code{gnus-summary-top-thread}).
5089 @end table
5090
5091 @vindex gnus-thread-operation-ignore-subject
5092 If you ignore subject while threading, you'll naturally end up with
5093 threads that have several different subjects in them.  If you then issue
5094 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5095 wish to kill the entire thread, but just those parts of the thread that
5096 have the same subject as the current article.  If you like this idea,
5097 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
5098 is non-@code{nil} (which it is by default), subjects will be ignored
5099 when doing thread commands.  If this variable is @code{nil}, articles in
5100 the same thread with different subjects will not be included in the
5101 operation in question.  If this variable is @code{fuzzy}, only articles
5102 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5103 Matching}).
5104
5105
5106 @node Sorting
5107 @section Sorting
5108
5109 @findex gnus-thread-sort-by-total-score
5110 @findex gnus-thread-sort-by-date
5111 @findex gnus-thread-sort-by-score
5112 @findex gnus-thread-sort-by-subject
5113 @findex gnus-thread-sort-by-author
5114 @findex gnus-thread-sort-by-number
5115 @vindex gnus-thread-sort-functions
5116 If you are using a threaded summary display, you can sort the threads by
5117 setting @code{gnus-thread-sort-functions}, which is a list of functions.
5118 By default, sorting is done on article numbers.  Ready-made sorting
5119 predicate functions include @code{gnus-thread-sort-by-number},
5120 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5121 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5122 @code{gnus-thread-sort-by-total-score}.
5123
5124 Each function takes two threads and returns non-@code{nil} if the first
5125 thread should be sorted before the other.  Note that sorting really is
5126 normally done by looking only at the roots of each thread.  If you use
5127 more than one function, the primary sort key should be the last function
5128 in the list.  You should probably always include
5129 @code{gnus-thread-sort-by-number} in the list of sorting
5130 functions---preferably first.  This will ensure that threads that are
5131 equal with respect to the other sort criteria will be displayed in
5132 ascending article order.
5133
5134 If you would like to sort by score, then by subject, and finally by
5135 number, you could do something like:
5136
5137 @lisp
5138 (setq gnus-thread-sort-functions
5139       '(gnus-thread-sort-by-number
5140         gnus-thread-sort-by-subject
5141         gnus-thread-sort-by-total-score))
5142 @end lisp
5143
5144 The threads that have highest score will be displayed first in the
5145 summary buffer.  When threads have the same score, they will be sorted
5146 alphabetically.  The threads that have the same score and the same
5147 subject will be sorted by number, which is (normally) the sequence in
5148 which the articles arrived.
5149
5150 If you want to sort by score and then reverse arrival order, you could
5151 say something like:
5152
5153 @lisp
5154 (setq gnus-thread-sort-functions
5155       '((lambda (t1 t2)
5156           (not (gnus-thread-sort-by-number t1 t2)))
5157         gnus-thread-sort-by-score))
5158 @end lisp
5159
5160 @vindex gnus-thread-score-function
5161 The function in the @code{gnus-thread-score-function} variable (default
5162 @code{+}) is used for calculating the total score of a thread.  Useful
5163 functions might be @code{max}, @code{min}, or squared means, or whatever
5164 tickles your fancy.
5165
5166 @findex gnus-article-sort-functions
5167 @findex gnus-article-sort-by-date
5168 @findex gnus-article-sort-by-score
5169 @findex gnus-article-sort-by-subject
5170 @findex gnus-article-sort-by-author
5171 @findex gnus-article-sort-by-number
5172 If you are using an unthreaded display for some strange reason or other,
5173 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5174 It is very similar to the @code{gnus-thread-sort-functions}, except that
5175 it uses slightly different functions for article comparison.  Available
5176 sorting predicate functions are @code{gnus-article-sort-by-number},
5177 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5178 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5179
5180 If you want to sort an unthreaded summary display by subject, you could
5181 say something like:
5182
5183 @lisp
5184 (setq gnus-article-sort-functions
5185       '(gnus-article-sort-by-number
5186         gnus-article-sort-by-subject))
5187 @end lisp
5188
5189
5190
5191 @node Asynchronous Fetching
5192 @section Asynchronous Article Fetching
5193 @cindex asynchronous article fetching
5194 @cindex article pre-fetch
5195 @cindex pre-fetch
5196
5197 If you read your news from an @sc{nntp} server that's far away, the
5198 network latencies may make reading articles a chore.  You have to wait
5199 for a while after pressing @kbd{n} to go to the next article before the
5200 article appears.  Why can't Gnus just go ahead and fetch the article
5201 while you are reading the previous one?  Why not, indeed.
5202
5203 First, some caveats.  There are some pitfalls to using asynchronous
5204 article fetching, especially the way Gnus does it.
5205
5206 Let's say you are reading article 1, which is short, and article 2 is
5207 quite long, and you are not interested in reading that.  Gnus does not
5208 know this, so it goes ahead and fetches article 2.  You decide to read
5209 article 3, but since Gnus is in the process of fetching article 2, the
5210 connection is blocked.
5211
5212 To avoid these situations, Gnus will open two (count 'em two)
5213 connections to the server.  Some people may think this isn't a very nice
5214 thing to do, but I don't see any real alternatives.  Setting up that
5215 extra connection takes some time, so Gnus startup will be slower.
5216
5217 Gnus will fetch more articles than you will read.  This will mean that
5218 the link between your machine and the @sc{nntp} server will become more
5219 loaded than if you didn't use article pre-fetch.  The server itself will
5220 also become more loaded---both with the extra article requests, and the
5221 extra connection.
5222
5223 Ok, so now you know that you shouldn't really use this thing...  unless
5224 you really want to.
5225
5226 @vindex gnus-asynchronous
5227 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5228 happen automatically.
5229
5230 @vindex gnus-use-article-prefetch
5231 You can control how many articles are to be pre-fetched by setting
5232 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5233 that when you read an article in the group, the backend will pre-fetch
5234 the next 30 articles.  If this variable is @code{t}, the backend will
5235 pre-fetch all the articles it can without bound.  If it is
5236 @code{nil}, no pre-fetching will be done.
5237
5238 @vindex gnus-async-prefetch-article-p
5239 @findex gnus-async-read-p
5240 There are probably some articles that you don't want to pre-fetch---read
5241 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5242 return non-@code{nil} when the article in question is to be
5243 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5244 @code{nil} on read articles.  The function is called with an article
5245 data structure as the only parameter.
5246
5247 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5248
5249 @lisp
5250 (defun my-async-short-unread-p (data)
5251   "Return non-nil for short, unread articles."
5252   (and (gnus-data-unread-p data)
5253        (< (mail-header-lines (gnus-data-header data))
5254           100)))
5255
5256 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5257 @end lisp
5258
5259 These functions will be called many, many times, so they should
5260 preferably be short and sweet to avoid slowing down Gnus too much.
5261 It's probably a good idea to byte-compile things like this.
5262
5263 @vindex gnus-prefetched-article-deletion-strategy
5264 Articles have to be removed from the asynch buffer sooner or later.  The
5265 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5266 articles.  This is a list that may contain the following elements:
5267
5268 @table @code
5269 @item read
5270 Remove articles when they are read.
5271
5272 @item exit
5273 Remove articles when exiting the group.
5274 @end table
5275
5276 The default value is @code{(read exit)}.
5277
5278 @c @vindex gnus-use-header-prefetch
5279 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5280 @c from the next group.
5281
5282
5283 @node Article Caching
5284 @section Article Caching
5285 @cindex article caching
5286 @cindex caching
5287
5288 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5289 consider turning article caching on.  Each article will then be stored
5290 locally under your home directory.  As you may surmise, this could
5291 potentially use @emph{huge} amounts of disk space, as well as eat up all
5292 your inodes so fast it will make your head swim.  In vodka.
5293
5294 Used carefully, though, it could be just an easier way to save articles.
5295
5296 @vindex gnus-use-long-file-name
5297 @vindex gnus-cache-directory
5298 @vindex gnus-use-cache
5299 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5300 all articles ticked or marked as dormant will then be copied
5301 over to your local cache (@code{gnus-cache-directory}).  Whether this
5302 cache is flat or hierarchal is controlled by the
5303 @code{gnus-use-long-file-name} variable, as usual.
5304
5305 When re-selecting a ticked or dormant article, it will be fetched from the
5306 cache instead of from the server.  As articles in your cache will never
5307 expire, this might serve as a method of saving articles while still
5308 keeping them where they belong.  Just mark all articles you want to save
5309 as dormant, and don't worry.
5310
5311 When an article is marked as read, is it removed from the cache.
5312
5313 @vindex gnus-cache-remove-articles
5314 @vindex gnus-cache-enter-articles
5315 The entering/removal of articles from the cache is controlled by the
5316 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5317 variables.  Both are lists of symbols.  The first is @code{(ticked
5318 dormant)} by default, meaning that ticked and dormant articles will be
5319 put in the cache.  The latter is @code{(read)} by default, meaning that
5320 articles marked as read are removed from the cache.  Possibly
5321 symbols in these two lists are @code{ticked}, @code{dormant},
5322 @code{unread} and @code{read}.
5323
5324 @findex gnus-jog-cache
5325 So where does the massive article-fetching and storing come into the
5326 picture?  The @code{gnus-jog-cache} command will go through all
5327 subscribed newsgroups, request all unread articles, score them, and
5328 store them in the cache.  You should only ever, ever ever ever, use this
5329 command if 1) your connection to the @sc{nntp} server is really, really,
5330 really slow and 2) you have a really, really, really huge disk.
5331 Seriously.  One way to cut down on the number of articles downloaded is
5332 to score unwanted articles down and have them marked as read.  They will
5333 not then be downloaded by this command.
5334
5335 @vindex gnus-uncacheable-groups
5336 @vindex gnus-cacheable-groups
5337 It is likely that you do not want caching on all groups.  For instance,
5338 if your @code{nnml} mail is located under your home directory, it makes no
5339 sense to cache it somewhere else under your home directory.  Unless you
5340 feel that it's neat to use twice as much space.  
5341
5342 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5343 regexp of groups to cache, @samp{^nntp} for instance, or set the
5344 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5345 Both variables are @code{nil} by default. If a group matches both
5346 variables, the group is not cached.
5347
5348 @findex gnus-cache-generate-nov-databases
5349 @findex gnus-cache-generate-active
5350 @vindex gnus-cache-active-file
5351 The cache stores information on what articles it contains in its active
5352 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5353 of the cache) becomes all messed up for some reason or other, Gnus
5354 offers two functions that will try to set things right.  @kbd{M-x
5355 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5356 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5357 file.
5358
5359
5360 @node Persistent Articles
5361 @section Persistent Articles
5362 @cindex persistent articles
5363
5364 Closely related to article caching, we have @dfn{persistent articles}.
5365 In fact, it's just a different way of looking at caching, and much more
5366 useful in my opinion.
5367
5368 Say you're reading a newsgroup, and you happen on to some valuable gem
5369 that you want to keep and treasure forever.  You'd normally just save it
5370 (using one of the many saving commands) in some file.  The problem with
5371 that is that it's just, well, yucky.  Ideally you'd prefer just having
5372 the article remain in the group where you found it forever; untouched by
5373 the expiry going on at the news server.
5374
5375 This is what a @dfn{persistent article} is---an article that just won't
5376 be deleted.  It's implemented using the normal cache functions, but
5377 you use two explicit commands for managing persistent articles:
5378
5379 @table @kbd
5380
5381 @item *
5382 @kindex * (Summary)
5383 @findex gnus-cache-enter-article
5384 Make the current article persistent (@code{gnus-cache-enter-article}).
5385
5386 @item M-*
5387 @kindex M-* (Summary)
5388 @findex gnus-cache-remove-article
5389 Remove the current article from the persistent articles
5390 (@code{gnus-cache-remove-article}).  This will normally delete the
5391 article.
5392 @end table
5393
5394 Both these commands understand the process/prefix convention.
5395
5396 To avoid having all ticked articles (and stuff) entered into the cache,
5397 you should set @code{gnus-use-cache} to @code{passive} if you're just
5398 interested in persistent articles:
5399
5400 @lisp
5401 (setq gnus-use-cache 'passive)
5402 @end lisp
5403
5404
5405 @node Article Backlog
5406 @section Article Backlog
5407 @cindex backlog
5408 @cindex article backlog
5409
5410 If you have a slow connection, but the idea of using caching seems
5411 unappealing to you (and it is, really), you can help the situation some
5412 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5413 already read articles so that it doesn't have to re-fetch articles
5414 you've already read.  This only helps if you are in the habit of
5415 re-selecting articles you've recently read, of course.  If you never do
5416 that, turning the backlog on will slow Gnus down a little bit, and
5417 increase memory usage some.
5418
5419 @vindex gnus-keep-backlog
5420 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5421 at most @var{n} old articles in a buffer for later re-fetching.  If this
5422 variable is non-@code{nil} and is not a number, Gnus will store
5423 @emph{all} read articles, which means that your Emacs will grow without
5424 bound before exploding and taking your machine down with you.  I put
5425 that in there just to keep y'all on your toes.
5426
5427 This variable is @code{nil} by default.
5428
5429
5430 @node Saving Articles
5431 @section Saving Articles
5432 @cindex saving articles
5433
5434 Gnus can save articles in a number of ways.  Below is the documentation
5435 for saving articles in a fairly straight-forward fashion (i.e., little
5436 processing of the article is done before it is saved).  For a different
5437 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5438 (@pxref{Decoding Articles}).
5439
5440 @vindex gnus-save-all-headers
5441 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5442 unwanted headers before saving the article.
5443
5444 @vindex gnus-saved-headers
5445 If the preceding variable is @code{nil}, all headers that match the
5446 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5447 deleted before saving.
5448
5449 @table @kbd
5450
5451 @item O o
5452 @itemx o
5453 @kindex O o (Summary)
5454 @kindex o (Summary)
5455 @findex gnus-summary-save-article
5456 @c @icon{gnus-summary-save-article}
5457 Save the current article using the default article saver
5458 (@code{gnus-summary-save-article}).
5459
5460 @item O m
5461 @kindex O m (Summary)
5462 @findex gnus-summary-save-article-mail
5463 Save the current article in mail format
5464 (@code{gnus-summary-save-article-mail}).
5465
5466 @item O r
5467 @kindex O r (Summary)
5468 @findex gnus-summary-save-article-rmail
5469 Save the current article in rmail format
5470 (@code{gnus-summary-save-article-rmail}).
5471
5472 @item O f
5473 @kindex O f (Summary)
5474 @findex gnus-summary-save-article-file
5475 @c @icon{gnus-summary-save-article-file}
5476 Save the current article in plain file format
5477 (@code{gnus-summary-save-article-file}).
5478
5479 @item O F
5480 @kindex O F (Summary)
5481 @findex gnus-summary-write-article-file
5482 Write the current article in plain file format, overwriting any previous
5483 file contents (@code{gnus-summary-write-article-file}).
5484
5485 @item O b
5486 @kindex O b (Summary)
5487 @findex gnus-summary-save-article-body-file
5488 Save the current article body in plain file format
5489 (@code{gnus-summary-save-article-body-file}).
5490
5491 @item O h
5492 @kindex O h (Summary)
5493 @findex gnus-summary-save-article-folder
5494 Save the current article in mh folder format
5495 (@code{gnus-summary-save-article-folder}).
5496
5497 @item O v
5498 @kindex O v (Summary)
5499 @findex gnus-summary-save-article-vm
5500 Save the current article in a VM folder
5501 (@code{gnus-summary-save-article-vm}).
5502
5503 @item O p
5504 @kindex O p (Summary)
5505 @findex gnus-summary-pipe-output
5506 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5507 the current article to a process (@code{gnus-summary-pipe-output}).
5508 @end table
5509
5510 @vindex gnus-prompt-before-saving
5511 All these commands use the process/prefix convention
5512 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5513 functions, you might get tired of being prompted for files to save each
5514 and every article in.  The prompting action is controlled by
5515 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5516 default, giving you that excessive prompting action you know and
5517 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5518 just once for each series of articles you save.  If you like to really
5519 have Gnus do all your thinking for you, you can even set this variable
5520 to @code{nil}, which means that you will never be prompted for files to
5521 save articles in.  Gnus will simply save all the articles in the default
5522 files.
5523
5524
5525 @vindex gnus-default-article-saver
5526 You can customize the @code{gnus-default-article-saver} variable to make
5527 Gnus do what you want it to.  You can use any of the six ready-made
5528 functions below, or you can create your own.
5529
5530 @table @code
5531
5532 @item gnus-summary-save-in-rmail
5533 @findex gnus-summary-save-in-rmail
5534 @vindex gnus-rmail-save-name
5535 @findex gnus-plain-save-name
5536 This is the default format, @dfn{babyl}.  Uses the function in the
5537 @code{gnus-rmail-save-name} variable to get a file name to save the
5538 article in.  The default is @code{gnus-plain-save-name}.
5539
5540 @item gnus-summary-save-in-mail
5541 @findex gnus-summary-save-in-mail
5542 @vindex gnus-mail-save-name
5543 Save in a Unix mail (mbox) file.  Uses the function in the
5544 @code{gnus-mail-save-name} variable to get a file name to save the
5545 article in.  The default is @code{gnus-plain-save-name}.
5546
5547 @item gnus-summary-save-in-file
5548 @findex gnus-summary-save-in-file
5549 @vindex gnus-file-save-name
5550 @findex gnus-numeric-save-name
5551 Append the article straight to an ordinary file.  Uses the function in
5552 the @code{gnus-file-save-name} variable to get a file name to save the
5553 article in.  The default is @code{gnus-numeric-save-name}.
5554
5555 @item gnus-summary-save-body-in-file
5556 @findex gnus-summary-save-body-in-file
5557 Append the article body to an ordinary file.  Uses the function in the
5558 @code{gnus-file-save-name} variable to get a file name to save the
5559 article in.  The default is @code{gnus-numeric-save-name}.
5560
5561 @item gnus-summary-save-in-folder
5562 @findex gnus-summary-save-in-folder
5563 @findex gnus-folder-save-name
5564 @findex gnus-Folder-save-name
5565 @vindex gnus-folder-save-name
5566 @cindex rcvstore
5567 @cindex MH folders
5568 Save the article to an MH folder using @code{rcvstore} from the MH
5569 library.  Uses the function in the @code{gnus-folder-save-name} variable
5570 to get a file name to save the article in.  The default is
5571 @code{gnus-folder-save-name}, but you can also use
5572 @code{gnus-Folder-save-name}, which creates capitalized names.
5573
5574 @item gnus-summary-save-in-vm
5575 @findex gnus-summary-save-in-vm
5576 Save the article in a VM folder.  You have to have the VM mail
5577 reader to use this setting.
5578 @end table
5579
5580 @vindex gnus-article-save-directory
5581 All of these functions, except for the last one, will save the article
5582 in the @code{gnus-article-save-directory}, which is initialized from the
5583 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5584 default.
5585
5586 As you can see above, the functions use different functions to find a
5587 suitable name of a file to save the article in.  Below is a list of
5588 available functions that generate names:
5589
5590 @table @code
5591
5592 @item gnus-Numeric-save-name
5593 @findex gnus-Numeric-save-name
5594 File names like @file{~/News/Alt.andrea-dworkin/45}.
5595
5596 @item gnus-numeric-save-name
5597 @findex gnus-numeric-save-name
5598 File names like @file{~/News/alt.andrea-dworkin/45}.
5599
5600 @item gnus-Plain-save-name
5601 @findex gnus-Plain-save-name
5602 File names like @file{~/News/Alt.andrea-dworkin}.
5603
5604 @item gnus-plain-save-name
5605 @findex gnus-plain-save-name
5606 File names like @file{~/News/alt.andrea-dworkin}.
5607 @end table
5608
5609 @vindex gnus-split-methods
5610 You can have Gnus suggest where to save articles by plonking a regexp into
5611 the @code{gnus-split-methods} alist.  For instance, if you would like to
5612 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5613 related to VM in @code{vm-stuff}, you could set this variable to something
5614 like:
5615
5616 @lisp
5617 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5618  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5619  (my-choosing-function "../other-dir/my-stuff")
5620  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5621 @end lisp
5622
5623 We see that this is a list where each element is a list that has two
5624 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5625 a string (in which case it is used as a regexp to match on the article
5626 head); it can be a symbol (which will be called as a function with the
5627 group name as a parameter); or it can be a list (which will be
5628 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5629 the @dfn{file} will be used as a default prompt.  In addition, the
5630 result of the operation itself will be used if the function or form
5631 called returns a string or a list of strings.
5632
5633 You basically end up with a list of file names that might be used when
5634 saving the current article.  (All ``matches'' will be used.)  You will
5635 then be prompted for what you really want to use as a name, with file
5636 name completion over the results from applying this variable.
5637
5638 This variable is @code{((gnus-article-archive-name))} by default, which
5639 means that Gnus will look at the articles it saves for an
5640 @code{Archive-name} line and use that as a suggestion for the file
5641 name.
5642
5643 Here's an example function to clean up file names somewhat.  If you have
5644 lots of mail groups called things like
5645 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5646 these group names before creating the file name to save to.  The
5647 following will do just that:
5648
5649 @lisp
5650 (defun my-save-name (group)
5651   (when (string-match "^nnml:mail." group)
5652     (substring group (match-end 0))))
5653
5654 (setq gnus-split-methods
5655       '((gnus-article-archive-name)
5656         (my-save-name)))
5657 @end lisp
5658
5659
5660 @vindex gnus-use-long-file-name
5661 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5662 @code{nil}, all the preceding functions will replace all periods
5663 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5664 the functions will generate hierarchies of directories instead of having
5665 all the files in the top level directory
5666 (@file{~/News/alt/andrea-dworkin} instead of
5667 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5668 on most systems.  However, for historical reasons, this is @code{nil} on
5669 Xenix and usg-unix-v machines by default.
5670
5671 This function also affects kill and score file names.  If this variable
5672 is a list, and the list contains the element @code{not-score}, long file
5673 names will not be used for score files, if it contains the element
5674 @code{not-save}, long file names will not be used for saving, and if it
5675 contains the element @code{not-kill}, long file names will not be used
5676 for kill files.
5677
5678 If you'd like to save articles in a hierarchy that looks something like
5679 a spool, you could
5680
5681 @lisp
5682 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5683 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5684 @end lisp
5685
5686 Then just save with @kbd{o}.  You'd then read this hierarchy with
5687 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5688 the top level directory as the argument (@file{~/News/}).  Then just walk
5689 around to the groups/directories with @code{nneething}.
5690
5691
5692 @node Decoding Articles
5693 @section Decoding Articles
5694 @cindex decoding articles
5695
5696 Sometime users post articles (or series of articles) that have been
5697 encoded in some way or other.  Gnus can decode them for you.
5698
5699 @menu
5700 * Uuencoded Articles::    Uudecode articles.
5701 * Shell Archives::        Unshar articles.
5702 * PostScript Files::      Split PostScript.
5703 * Other Files::           Plain save and binhex.
5704 * Decoding Variables::    Variables for a happy decoding.
5705 * Viewing Files::         You want to look at the result of the decoding?
5706 @end menu
5707
5708 @cindex series
5709 @cindex article series
5710 All these functions use the process/prefix convention
5711 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5712 the extension that a ``single article'' means ``a single series''.  Gnus
5713 can find out by itself what articles belong to a series, decode all the
5714 articles and unpack/view/save the resulting file(s).
5715
5716 Gnus guesses what articles are in the series according to the following
5717 simplish rule: The subjects must be (nearly) identical, except for the
5718 last two numbers of the line.  (Spaces are largely ignored, however.)
5719
5720 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5721 will find all the articles that match the regexp @samp{^cat.gif
5722 ([0-9]+/[0-9]+).*$}.
5723
5724 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5725 series}, will not be properly recognized by any of the automatic viewing
5726 commands, and you have to mark the articles manually with @kbd{#}.
5727
5728
5729 @node Uuencoded Articles
5730 @subsection Uuencoded Articles
5731 @cindex uudecode
5732 @cindex uuencoded articles
5733
5734 @table @kbd
5735
5736 @item X u
5737 @kindex X u (Summary)
5738 @findex gnus-uu-decode-uu
5739 @c @icon{gnus-uu-decode-uu}
5740 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5741
5742 @item X U
5743 @kindex X U (Summary)
5744 @findex gnus-uu-decode-uu-and-save
5745 Uudecodes and saves the current series
5746 (@code{gnus-uu-decode-uu-and-save}).
5747
5748 @item X v u
5749 @kindex X v u (Summary)
5750 @findex gnus-uu-decode-uu-view
5751 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5752
5753 @item X v U
5754 @kindex X v U (Summary)
5755 @findex gnus-uu-decode-uu-and-save-view
5756 Uudecodes, views and saves the current series
5757 (@code{gnus-uu-decode-uu-and-save-view}).
5758
5759 @end table
5760
5761 Remember that these all react to the presence of articles marked with
5762 the process mark.  If, for instance, you'd like to decode and save an
5763 entire newsgroup, you'd typically do @kbd{M P a}
5764 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5765 (@code{gnus-uu-decode-uu-and-save}).
5766
5767 All this is very much different from how @code{gnus-uu} worked with
5768 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5769 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5770 articles in some way (@pxref{Setting Process Marks}) and then press
5771 @kbd{X u}.
5772
5773 @vindex gnus-uu-notify-files
5774 Note: When trying to decode articles that have names matching
5775 @code{gnus-uu-notify-files}, which is hard-coded to
5776 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5777 automatically post an article on @samp{comp.unix.wizards} saying that
5778 you have just viewed the file in question.  This feature can't be turned
5779 off.
5780
5781
5782 @node Shell Archives
5783 @subsection Shell Archives
5784 @cindex unshar
5785 @cindex shell archives
5786 @cindex shared articles
5787
5788 Shell archives (``shar files'') used to be a popular way to distribute
5789 sources, but it isn't used all that much today.  In any case, we have
5790 some commands to deal with these:
5791
5792 @table @kbd
5793
5794 @item X s
5795 @kindex X s (Summary)
5796 @findex gnus-uu-decode-unshar
5797 Unshars the current series (@code{gnus-uu-decode-unshar}).
5798
5799 @item X S
5800 @kindex X S (Summary)
5801 @findex gnus-uu-decode-unshar-and-save
5802 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5803
5804 @item X v s
5805 @kindex X v s (Summary)
5806 @findex gnus-uu-decode-unshar-view
5807 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5808
5809 @item X v S
5810 @kindex X v S (Summary)
5811 @findex gnus-uu-decode-unshar-and-save-view
5812 Unshars, views and saves the current series
5813 (@code{gnus-uu-decode-unshar-and-save-view}).
5814 @end table
5815
5816
5817 @node PostScript Files
5818 @subsection PostScript Files
5819 @cindex PostScript
5820
5821 @table @kbd
5822
5823 @item X p
5824 @kindex X p (Summary)
5825 @findex gnus-uu-decode-postscript
5826 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5827
5828 @item X P
5829 @kindex X P (Summary)
5830 @findex gnus-uu-decode-postscript-and-save
5831 Unpack and save the current PostScript series
5832 (@code{gnus-uu-decode-postscript-and-save}).
5833
5834 @item X v p
5835 @kindex X v p (Summary)
5836 @findex gnus-uu-decode-postscript-view
5837 View the current PostScript series
5838 (@code{gnus-uu-decode-postscript-view}).
5839
5840 @item X v P
5841 @kindex X v P (Summary)
5842 @findex gnus-uu-decode-postscript-and-save-view
5843 View and save the current PostScript series
5844 (@code{gnus-uu-decode-postscript-and-save-view}).
5845 @end table
5846
5847
5848 @node Other Files
5849 @subsection Other Files
5850
5851 @table @kbd
5852 @item X o
5853 @kindex X o (Summary)
5854 @findex gnus-uu-decode-save
5855 Save the current series
5856 (@code{gnus-uu-decode-save}).
5857
5858 @item X b
5859 @kindex X b (Summary)
5860 @findex gnus-uu-decode-binhex
5861 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
5862 doesn't really work yet.
5863 @end table
5864
5865
5866 @node Decoding Variables
5867 @subsection Decoding Variables
5868
5869 Adjective, not verb.
5870
5871 @menu
5872 * Rule Variables::          Variables that say how a file is to be viewed.
5873 * Other Decode Variables::  Other decode variables.
5874 * Uuencoding and Posting::  Variables for customizing uuencoding.
5875 @end menu
5876
5877
5878 @node Rule Variables
5879 @subsubsection Rule Variables
5880 @cindex rule variables
5881
5882 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5883 variables are of the form
5884
5885 @lisp
5886       (list '(regexp1 command2)
5887             '(regexp2 command2)
5888             ...)
5889 @end lisp
5890
5891 @table @code
5892
5893 @item gnus-uu-user-view-rules
5894 @vindex gnus-uu-user-view-rules
5895 @cindex sox
5896 This variable is consulted first when viewing files.  If you wish to use,
5897 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5898 say something like:
5899 @lisp
5900 (setq gnus-uu-user-view-rules
5901       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5902 @end lisp
5903
5904 @item gnus-uu-user-view-rules-end
5905 @vindex gnus-uu-user-view-rules-end
5906 This variable is consulted if Gnus couldn't make any matches from the
5907 user and default view rules.
5908
5909 @item gnus-uu-user-archive-rules
5910 @vindex gnus-uu-user-archive-rules
5911 This variable can be used to say what commands should be used to unpack
5912 archives.
5913 @end table
5914
5915
5916 @node Other Decode Variables
5917 @subsubsection Other Decode Variables
5918
5919 @table @code
5920 @vindex gnus-uu-grabbed-file-functions
5921
5922 @item gnus-uu-grabbed-file-functions
5923 All functions in this list will be called right after each file has been
5924 successfully decoded---so that you can move or view files right away,
5925 and don't have to wait for all files to be decoded before you can do
5926 anything.  Ready-made functions you can put in this list are:
5927
5928 @table @code
5929
5930 @item gnus-uu-grab-view
5931 @findex gnus-uu-grab-view
5932 View the file.
5933
5934 @item gnus-uu-grab-move
5935 @findex gnus-uu-grab-move
5936 Move the file (if you're using a saving function.)
5937 @end table
5938
5939 @item gnus-uu-be-dangerous
5940 @vindex gnus-uu-be-dangerous
5941 Specifies what to do if unusual situations arise during decoding.  If
5942 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5943 that didn't work, and overwrite existing files.  Otherwise, ask each
5944 time.
5945
5946 @item gnus-uu-ignore-files-by-name
5947 @vindex gnus-uu-ignore-files-by-name
5948 Files with name matching this regular expression won't be viewed.
5949
5950 @item gnus-uu-ignore-files-by-type
5951 @vindex gnus-uu-ignore-files-by-type
5952 Files with a @sc{mime} type matching this variable won't be viewed.
5953 Note that Gnus tries to guess what type the file is based on the name.
5954 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5955 kludgey.
5956
5957 @item gnus-uu-tmp-dir
5958 @vindex gnus-uu-tmp-dir
5959 Where @code{gnus-uu} does its work.
5960
5961 @item gnus-uu-do-not-unpack-archives
5962 @vindex gnus-uu-do-not-unpack-archives
5963 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5964 looking for files to display.
5965
5966 @item gnus-uu-view-and-save
5967 @vindex gnus-uu-view-and-save
5968 Non-@code{nil} means that the user will always be asked to save a file
5969 after viewing it.
5970
5971 @item gnus-uu-ignore-default-view-rules
5972 @vindex gnus-uu-ignore-default-view-rules
5973 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5974 rules.
5975
5976 @item gnus-uu-ignore-default-archive-rules
5977 @vindex gnus-uu-ignore-default-archive-rules
5978 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5979 unpacking commands.
5980
5981 @item gnus-uu-kill-carriage-return
5982 @vindex gnus-uu-kill-carriage-return
5983 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5984 from articles.
5985
5986 @item gnus-uu-unmark-articles-not-decoded
5987 @vindex gnus-uu-unmark-articles-not-decoded
5988 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5989 decoded articles as unread.
5990
5991 @item gnus-uu-correct-stripped-uucode
5992 @vindex gnus-uu-correct-stripped-uucode
5993 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5994 uuencoded files that have had trailing spaces deleted.
5995
5996 @item gnus-uu-pre-uudecode-hook
5997 @vindex gnus-uu-pre-uudecode-hook
5998 Hook run before sending a message to @code{uudecode}.
5999
6000 @item gnus-uu-view-with-metamail
6001 @vindex gnus-uu-view-with-metamail
6002 @cindex metamail
6003 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6004 commands defined by the rule variables and just fudge a @sc{mime}
6005 content type based on the file name.  The result will be fed to
6006 @code{metamail} for viewing.
6007
6008 @item gnus-uu-save-in-digest
6009 @vindex gnus-uu-save-in-digest
6010 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6011 decoding, will save in digests.  If this variable is @code{nil},
6012 @code{gnus-uu} will just save everything in a file without any
6013 embellishments.  The digesting almost conforms to RFC1153---no easy way
6014 to specify any meaningful volume and issue numbers were found, so I
6015 simply dropped them.
6016
6017 @end table
6018
6019
6020 @node Uuencoding and Posting
6021 @subsubsection Uuencoding and Posting
6022
6023 @table @code
6024
6025 @item gnus-uu-post-include-before-composing
6026 @vindex gnus-uu-post-include-before-composing
6027 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6028 before you compose the article.  If this variable is @code{t}, you can
6029 either include an encoded file with @kbd{C-c C-i} or have one included
6030 for you when you post the article.
6031
6032 @item gnus-uu-post-length
6033 @vindex gnus-uu-post-length
6034 Maximum length of an article.  The encoded file will be split into how
6035 many articles it takes to post the entire file.
6036
6037 @item gnus-uu-post-threaded
6038 @vindex gnus-uu-post-threaded
6039 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6040 thread.  This may not be smart, as no other decoder I have seen is able
6041 to follow threads when collecting uuencoded articles.  (Well, I have
6042 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6043 think that counts...) Default is @code{nil}.
6044
6045 @item gnus-uu-post-separate-description
6046 @vindex gnus-uu-post-separate-description
6047 Non-@code{nil} means that the description will be posted in a separate
6048 article.  The first article will typically be numbered (0/x).  If this
6049 variable is @code{nil}, the description the user enters will be included
6050 at the beginning of the first article, which will be numbered (1/x).
6051 Default is @code{t}.
6052
6053 @end table
6054
6055
6056 @node Viewing Files
6057 @subsection Viewing Files
6058 @cindex viewing files
6059 @cindex pseudo-articles
6060
6061 After decoding, if the file is some sort of archive, Gnus will attempt
6062 to unpack the archive and see if any of the files in the archive can be
6063 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
6064 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6065 uncompress and de-tar the main file, and then view the two pictures.
6066 This unpacking process is recursive, so if the archive contains archives
6067 of archives, it'll all be unpacked.
6068
6069 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6070 extracted file into the summary buffer.  If you go to these
6071 ``articles'', you will be prompted for a command to run (usually Gnus
6072 will make a suggestion), and then the command will be run.
6073
6074 @vindex gnus-view-pseudo-asynchronously
6075 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6076 until the viewing is done before proceeding.
6077
6078 @vindex gnus-view-pseudos
6079 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6080 the pseudo-articles into the summary buffer, but view them
6081 immediately.  If this variable is @code{not-confirm}, the user won't even
6082 be asked for a confirmation before viewing is done.
6083
6084 @vindex gnus-view-pseudos-separately
6085 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6086 pseudo-article will be created for each file to be viewed.  If
6087 @code{nil}, all files that use the same viewing command will be given as
6088 a list of parameters to that command.
6089
6090 @vindex gnus-insert-pseudo-articles
6091 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6092 pseudo-articles when decoding.  It is @code{t} by default.
6093
6094 So; there you are, reading your @emph{pseudo-articles} in your
6095 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6096 Why isn't anything real anymore? How did we get here?
6097
6098
6099 @node Article Treatment
6100 @section Article Treatment
6101
6102 Reading through this huge manual, you may have quite forgotten that the
6103 object of newsreaders is to actually, like, read what people have
6104 written.  Reading articles.  Unfortunately, people are quite bad at
6105 writing, so there are tons of functions and variables to make reading
6106 these articles easier.
6107
6108 @menu
6109 * Article Highlighting::    You want to make the article look like fruit salad.
6110 * Article Fontisizing::     Making emphasized text look nice.
6111 * Article Hiding::          You also want to make certain info go away.
6112 * Article Washing::         Lots of way-neat functions to make life better.
6113 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6114 * Article Date::            Grumble, UT!
6115 * Article Signature::       What is a signature?
6116 @end menu
6117
6118
6119 @node Article Highlighting
6120 @subsection Article Highlighting
6121 @cindex highlighting
6122
6123 Not only do you want your article buffer to look like fruit salad, but
6124 you want it to look like technicolor fruit salad.  
6125
6126 @table @kbd
6127
6128 @item W H a
6129 @kindex W H a (Summary)
6130 @findex gnus-article-highlight
6131 @findex gnus-article-maybe-highlight
6132 Do much highlighting of the current article
6133 (@code{gnus-article-highlight}).  This function highlights header, cited
6134 text, the signature, and adds buttons to the body and the head.
6135
6136 Most users would prefer using @code{gnus-article-maybe-highlight} in
6137 @code{gnus-article-display-hook} (@pxref{Customizing Articles}) instead.
6138 This is a bit less agressive---it highlights only the headers, the
6139 signature and adds buttons.
6140
6141 @item W H h
6142 @kindex W H h (Summary)
6143 @findex gnus-article-highlight-headers
6144 @vindex gnus-header-face-alist
6145 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6146 highlighting will be done according to the @code{gnus-header-face-alist}
6147 variable, which is a list where each element has the form @var{(regexp
6148 name content)}.  @var{regexp} is a regular expression for matching the
6149 header, @var{name} is the face used for highlighting the header name
6150 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6151 the header value.  The first match made will be used.  Note that
6152 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6153
6154 @item W H c
6155 @kindex W H c (Summary)
6156 @findex gnus-article-highlight-citation
6157 Highlight cited text (@code{gnus-article-highlight-citation}).
6158
6159 Some variables to customize the citation highlights:
6160
6161 @table @code
6162 @vindex gnus-cite-parse-max-size
6163
6164 @item gnus-cite-parse-max-size
6165 If the article size if bigger than this variable (which is 25000 by
6166 default), no citation highlighting will be performed.
6167
6168 @item gnus-cite-prefix-regexp
6169 @vindex gnus-cite-prefix-regexp
6170 Regexp matching the longest possible citation prefix on a line.
6171
6172 @item gnus-cite-max-prefix
6173 @vindex gnus-cite-max-prefix
6174 Maximum possible length for a citation prefix (default 20).
6175
6176 @item gnus-cite-face-list
6177 @vindex gnus-cite-face-list
6178 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6179 When there are citations from multiple articles in the same message,
6180 Gnus will try to give each citation from each article its own face.
6181 This should make it easier to see who wrote what.
6182
6183 @item gnus-supercite-regexp
6184 @vindex gnus-supercite-regexp
6185 Regexp matching normal Supercite attribution lines.
6186
6187 @item gnus-supercite-secondary-regexp
6188 @vindex gnus-supercite-secondary-regexp
6189 Regexp matching mangled Supercite attribution lines.
6190
6191 @item gnus-cite-minimum-match-count
6192 @vindex gnus-cite-minimum-match-count
6193 Minimum number of identical prefixes we have to see before we believe
6194 that it's a citation.
6195
6196 @item gnus-cite-attribution-prefix
6197 @vindex gnus-cite-attribution-prefix
6198 Regexp matching the beginning of an attribution line.
6199
6200 @item gnus-cite-attribution-suffix
6201 @vindex gnus-cite-attribution-suffix
6202 Regexp matching the end of an attribution line.
6203
6204 @item gnus-cite-attribution-face
6205 @vindex gnus-cite-attribution-face
6206 Face used for attribution lines.  It is merged with the face for the
6207 cited text belonging to the attribution.
6208
6209 @end table
6210
6211
6212 @item W H s
6213 @kindex W H s (Summary)
6214 @vindex gnus-signature-separator
6215 @vindex gnus-signature-face
6216 @findex gnus-article-highlight-signature
6217 Highlight the signature (@code{gnus-article-highlight-signature}).
6218 Everything after @code{gnus-signature-separator} (@pxref{Article
6219 Signature}) in an article will be considered a signature and will be
6220 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6221 default.
6222
6223 @end table
6224
6225 @xref{Customizing Articles} for how to highlight articles automatically.
6226
6227
6228 @node Article Fontisizing
6229 @subsection Article Fontisizing
6230 @cindex emphasis
6231 @cindex article emphasis
6232
6233 @findex gnus-article-emphasize
6234 @kindex W e (Summary)
6235 People commonly add emphasis to words in news articles by writing things
6236 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
6237 running the article through the @kbd{W e}
6238 (@code{gnus-article-emphasize}) command.
6239
6240 @vindex gnus-emphasis-alist
6241 How the emphasis is computed is controlled by the
6242 @code{gnus-emphasis-alist} variable.  This is an alist where the first
6243 element is a regular expression to be matched.  The second is a number
6244 that says what regular expression grouping is used to find the entire
6245 emphasized word.  The third is a number that says what regexp grouping
6246 should be displayed and highlighted.  (The text between these two
6247 groupings will be hidden.)  The fourth is the face used for
6248 highlighting.
6249
6250 @lisp
6251 (setq gnus-article-emphasis
6252       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6253         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6254 @end lisp
6255
6256 @vindex gnus-emphasis-underline
6257 @vindex gnus-emphasis-bold
6258 @vindex gnus-emphasis-italic
6259 @vindex gnus-emphasis-underline-bold
6260 @vindex gnus-emphasis-underline-italic
6261 @vindex gnus-emphasis-bold-italic
6262 @vindex gnus-emphasis-underline-bold-italic
6263 By default, there are seven rules, and they use the following faces:
6264 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6265 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6266 @code{gnus-emphasis-underline-italic},
6267 @code{gnus-emphasis-underline-bold}, and
6268 @code{gnus-emphasis-underline-bold-italic}.
6269
6270 If you want to change these faces, you can either use @kbd{M-x
6271 customize}, or you can use @code{copy-face}.  For instance, if you want
6272 to make @code{gnus-emphasis-italic} use a red face instead, you could
6273 say something like:
6274
6275 @lisp
6276 (copy-face 'red 'gnus-emphasis-italic)
6277 @end lisp
6278
6279 @xref{Customizing Articles} for how to fontize articles automatically.
6280
6281
6282 @node Article Hiding
6283 @subsection Article Hiding
6284 @cindex article hiding
6285
6286 Or rather, hiding certain things in each article.  There usually is much
6287 too much cruft in most articles.
6288
6289 @table @kbd
6290
6291 @item W W a
6292 @kindex W W a (Summary)
6293 @findex gnus-article-hide
6294 Do quite a lot of hiding on the article buffer
6295 (@kbd{gnus-article-hide}).  In particular, this function will hide
6296 headers, PGP, cited text and the signature.  
6297
6298 @item W W h
6299 @kindex W W h (Summary)
6300 @findex gnus-article-hide-headers
6301 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
6302 Headers}.
6303
6304 @item W W b
6305 @kindex W W b (Summary)
6306 @findex gnus-article-hide-boring-headers
6307 Hide headers that aren't particularly interesting
6308 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6309
6310 @item W W s
6311 @kindex W W s (Summary)
6312 @findex gnus-article-hide-signature
6313 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6314 Signature}.
6315
6316 @item W W p
6317 @kindex W W p (Summary)
6318 @findex gnus-article-hide-pgp
6319 @vindex gnus-article-hide-pgp-hook
6320 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6321 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6322 signature has been hidden.  For example, to automatically verify
6323 articles that have signatures in them do:
6324 @lisp
6325 ;;; Hide pgp cruft if any.
6326
6327 (add-hook 'gnus-article-display-hook 'gnus-article-hide-pgp)
6328
6329 ;;; After hiding pgp, verify the message;
6330 ;;; only happens if pgp signature is found.
6331
6332 (add-hook 'gnus-article-hide-pgp-hook
6333           (lambda ()
6334             (save-excursion
6335               (set-buffer gnus-original-article-buffer)
6336               (mc-verify))))
6337 @end lisp
6338
6339 @item W W P
6340 @kindex W W P (Summary)
6341 @findex gnus-article-hide-pem
6342 Hide @sc{pem} (privacy enhanced messages) cruft
6343 (@code{gnus-article-hide-pem}).
6344
6345 @item W W c
6346 @kindex W W c (Summary)
6347 @findex gnus-article-hide-citation
6348 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6349 customizing the hiding:
6350
6351 @table @code
6352
6353 @item gnus-cited-opened-text-button-line-format
6354 @itemx gnus-cited-closed-text-button-line-format
6355 @vindex gnus-cited-closed-text-button-line-format
6356 @vindex gnus-cited-opened-text-button-line-format
6357 Gnus adds buttons to show where the cited text has been hidden, and to
6358 allow toggle hiding the text.  The format of the variable is specified
6359 by these format-like variable (@pxref{Formatting Variables}).  These
6360 specs are valid:
6361
6362 @table @samp
6363 @item b
6364 Starting point of the hidden text.
6365 @item e
6366 Ending point of the hidden text.
6367 @item l
6368 Number of characters in the hidden region.
6369 @item n
6370 Number of lines of hidden text.
6371 @end table
6372
6373 @item gnus-cited-lines-visible
6374 @vindex gnus-cited-lines-visible
6375 The number of lines at the beginning of the cited text to leave shown.
6376
6377 @end table
6378
6379 @item W W C-c
6380 @kindex W W C-c (Summary)
6381 @findex gnus-article-hide-citation-maybe
6382
6383 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6384 following two variables:
6385
6386 @table @code
6387 @item gnus-cite-hide-percentage
6388 @vindex gnus-cite-hide-percentage
6389 If the cited text is of a bigger percentage than this variable (default
6390 50), hide the cited text.
6391
6392 @item gnus-cite-hide-absolute
6393 @vindex gnus-cite-hide-absolute
6394 The cited text must have at least this length (default 10) before it
6395 is hidden.
6396 @end table
6397
6398 @item W W C
6399 @kindex W W C (Summary)
6400 @findex gnus-article-hide-citation-in-followups
6401 Hide cited text in articles that aren't roots
6402 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6403 useful as an interactive command, but might be a handy function to stick
6404 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
6405
6406 @end table
6407
6408 All these ``hiding'' commands are toggles, but if you give a negative
6409 prefix to these commands, they will show what they have previously
6410 hidden.  If you give a positive prefix, they will always hide.
6411
6412 Also @pxref{Article Highlighting} for further variables for
6413 citation customization.
6414
6415 @xref{Customizing Articles} for how to hide article elements
6416 automatically.
6417
6418
6419 @node Article Washing
6420 @subsection Article Washing
6421 @cindex washing
6422 @cindex article washing
6423
6424 We call this ``article washing'' for a really good reason.  Namely, the
6425 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6426
6427 @dfn{Washing} is defined by us as ``changing something from something to
6428 something else'', but normally results in something looking better.
6429 Cleaner, perhaps.
6430
6431 @table @kbd
6432
6433 @item W l
6434 @kindex W l (Summary)
6435 @findex gnus-summary-stop-page-breaking
6436 Remove page breaks from the current article
6437 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article} for page
6438 delimiters. 
6439
6440 @item W r
6441 @kindex W r (Summary)
6442 @findex gnus-summary-caesar-message
6443 @c @icon{gnus-summary-caesar-message}
6444 Do a Caesar rotate (rot13) on the article buffer
6445 (@code{gnus-summary-caesar-message}).
6446 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6447 (Typically offensive jokes and such.)
6448
6449 It's commonly called ``rot13'' because each letter is rotated 13
6450 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6451 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6452 is rumored to have employed this form of, uh, somewhat weak encryption.
6453
6454 @item W t
6455 @kindex W t (Summary)
6456 @findex gnus-summary-toggle-header
6457 Toggle whether to display all headers in the article buffer
6458 (@code{gnus-summary-toggle-header}).
6459
6460 @item W v
6461 @kindex W v (Summary)
6462 @findex gnus-summary-verbose-header
6463 Toggle whether to display all headers in the article buffer permanently
6464 (@code{gnus-summary-verbose-header}).
6465
6466 @item W m
6467 @kindex W m (Summary)
6468 @findex gnus-summary-toggle-mime
6469 Toggle whether to run the article through @sc{mime} before displaying
6470 (@code{gnus-summary-toggle-mime}).
6471
6472 @item W o
6473 @kindex W o (Summary)
6474 @findex gnus-article-treat-overstrike
6475 Treat overstrike (@code{gnus-article-treat-overstrike}).
6476
6477 @item W d
6478 @kindex W d (Summary)
6479 @findex gnus-article-treat-dumbquotes
6480 Treat M******** sm*rtq**t*s (@code{gnus-article-treat-dumbquotes}).
6481
6482 @item W w
6483 @kindex W w (Summary)
6484 @findex gnus-article-fill-cited-article
6485 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
6486 function in @code{gnus-article-display-hook}, it should be run fairly
6487 late and certainly after any highlighting.
6488
6489 You can give the command a numerical prefix to specify the width to use
6490 when filling.
6491
6492 @item W c
6493 @kindex W c (Summary)
6494 @findex gnus-article-remove-cr
6495 Remove CR (i. e., @samp{^M}s on the end of the lines)
6496 (@code{gnus-article-remove-cr}).
6497
6498 @item W q
6499 @kindex W q (Summary)
6500 @findex gnus-article-de-quoted-unreadable
6501 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6502 Quoted-Printable is one common @sc{mime} encoding employed when sending
6503 non-ASCII (i. e., 8-bit) articles.  It typically makes strings like
6504 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6505 readable to me.
6506
6507 @item W f
6508 @kindex W f (Summary)
6509 @cindex x-face
6510 @findex gnus-article-display-x-face
6511 @findex gnus-article-x-face-command
6512 @vindex gnus-article-x-face-command
6513 @vindex gnus-article-x-face-too-ugly
6514 @iftex
6515 @iflatex
6516 \include{xface}
6517 @end iflatex
6518 @end iftex
6519 Look for and display any X-Face headers
6520 (@code{gnus-article-display-x-face}).  The command executed by this
6521 function is given by the @code{gnus-article-x-face-command} variable.
6522 If this variable is a string, this string will be executed in a
6523 sub-shell.  If it is a function, this function will be called with the
6524 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6525 is a regexp) matches the @code{From} header, the face will not be shown.
6526 The default action under Emacs is to fork off an @code{xv} to view the
6527 face; under XEmacs the default action is to display the face before the
6528 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6529 support---that will make display somewhat faster.  If there's no native
6530 X-Face support, Gnus will try to convert the @code{X-Face} header using
6531 external programs from the @code{pbmplus} package and friends.)  If you
6532 want to have this function in the display hook, it should probably come
6533 last.
6534
6535 @item W b
6536 @kindex W b (Summary)
6537 @findex gnus-article-add-buttons
6538 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6539 @xref{Article Buttons}.
6540
6541 @item W B
6542 @kindex W B (Summary)
6543 @findex gnus-article-add-buttons-to-head
6544 Add clickable buttons to the article headers
6545 (@code{gnus-article-add-buttons-to-head}).
6546
6547 @item W E l
6548 @kindex W E l (Summary)
6549 @findex gnus-article-strip-leading-blank-lines
6550 Remove all blank lines from the beginning of the article
6551 (@code{gnus-article-strip-leading-blank-lines}).
6552
6553 @item W E m
6554 @kindex W E m (Summary)
6555 @findex gnus-article-strip-multiple-blank-lines
6556 Replace all blank lines with empty lines and then all multiple empty
6557 lines with a single empty line.
6558 (@code{gnus-article-strip-multiple-blank-lines}).
6559
6560 @item W E t
6561 @kindex W E t (Summary)
6562 @findex gnus-article-remove-trailing-blank-lines
6563 Remove all blank lines at the end of the article
6564 (@code{gnus-article-remove-trailing-blank-lines}).
6565
6566 @item W E a
6567 @kindex W E a (Summary)
6568 @findex gnus-article-strip-blank-lines
6569 Do all the three commands above
6570 (@code{gnus-article-strip-blank-lines}).
6571
6572 @item W E A
6573 @kindex W E A (Summary)
6574 @findex gnus-article-strip-all-blank-lines
6575 Remove all blank lines
6576 (@code{gnus-article-strip-all-blank-lines}).
6577
6578 @item W E s
6579 @kindex W E s (Summary)
6580 @findex gnus-article-strip-leading-space
6581 Remove all white space from the beginning of all lines of the article
6582 body (@code{gnus-article-strip-leading-space}).
6583
6584 @end table
6585
6586 @xref{Customizing Articles} for how to wash articles automatically.
6587
6588
6589 @node Article Buttons
6590 @subsection Article Buttons
6591 @cindex buttons
6592
6593 People often include references to other stuff in articles, and it would
6594 be nice if Gnus could just fetch whatever it is that people talk about
6595 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6596 button on these references.
6597
6598 Gnus adds @dfn{buttons} to certain standard references by default:
6599 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6600 two variables, one that handles article bodies and one that handles
6601 article heads:
6602
6603 @table @code
6604
6605 @item gnus-button-alist
6606 @vindex gnus-button-alist
6607 This is an alist where each entry has this form:
6608
6609 @lisp
6610 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6611 @end lisp
6612
6613 @table @var
6614
6615 @item regexp
6616 All text that match this regular expression will be considered an
6617 external reference.  Here's a typical regexp that matches embedded URLs:
6618 @samp{<URL:\\([^\n\r>]*\\)>}.
6619
6620 @item button-par
6621 Gnus has to know which parts of the matches is to be highlighted.  This
6622 is a number that says what sub-expression of the regexp is to be
6623 highlighted.  If you want it all highlighted, you use 0 here.
6624
6625 @item use-p
6626 This form will be @code{eval}ed, and if the result is non-@code{nil},
6627 this is considered a match.  This is useful if you want extra sifting to
6628 avoid false matches.
6629
6630 @item function
6631 This function will be called when you click on this button.
6632
6633 @item data-par
6634 As with @var{button-par}, this is a sub-expression number, but this one
6635 says which part of the match is to be sent as data to @var{function}.
6636
6637 @end table
6638
6639 So the full entry for buttonizing URLs is then
6640
6641 @lisp
6642 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6643 @end lisp
6644
6645 @item gnus-header-button-alist
6646 @vindex gnus-header-button-alist
6647 This is just like the other alist, except that it is applied to the
6648 article head only, and that each entry has an additional element that is
6649 used to say what headers to apply the buttonize coding to:
6650
6651 @lisp
6652 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6653 @end lisp
6654
6655 @var{HEADER} is a regular expression.
6656
6657 @item gnus-button-url-regexp
6658 @vindex gnus-button-url-regexp
6659 A regular expression that matches embedded URLs.  It is used in the
6660 default values of the variables above.
6661
6662 @item gnus-article-button-face
6663 @vindex gnus-article-button-face
6664 Face used on buttons.
6665
6666 @item gnus-article-mouse-face
6667 @vindex gnus-article-mouse-face
6668 Face used when the mouse cursor is over a button.
6669
6670 @end table
6671
6672 @xref{Customizing Articles} for how to buttonize articles automatically.
6673
6674
6675 @node Article Date
6676 @subsection Article Date
6677
6678 The date is most likely generated in some obscure timezone you've never
6679 heard of, so it's quite nice to be able to find out what the time was
6680 when the article was sent.
6681
6682 @table @kbd
6683
6684 @item W T u
6685 @kindex W T u (Summary)
6686 @findex gnus-article-date-ut
6687 Display the date in UT (aka. GMT, aka ZULU)
6688 (@code{gnus-article-date-ut}).
6689
6690 @item W T i
6691 @kindex W T i (Summary)
6692 @findex gnus-article-date-iso8601
6693 @cindex ISO 8601
6694 Display the date in international format, aka. ISO 8601
6695 (@code{gnus-article-date-iso8601}).
6696
6697 @item W T l
6698 @kindex W T l (Summary)
6699 @findex gnus-article-date-local
6700 Display the date in the local timezone (@code{gnus-article-date-local}).
6701
6702 @item W T s
6703 @kindex W T s (Summary)
6704 @vindex gnus-article-time-format
6705 @findex gnus-article-date-user
6706 @findex format-time-string
6707 Display the date using a user-defined format
6708 (@code{gnus-article-date-user}).  The format is specified by the
6709 @code{gnus-article-time-format} variable, and is a string that's passed
6710 to @code{format-time-string}.  See the documentation of that variable
6711 for a list of possible format specs.
6712
6713 @item W T e
6714 @kindex W T e (Summary)
6715 @findex gnus-article-date-lapsed
6716 @findex gnus-start-date-timer
6717 @findex gnus-stop-date-timer
6718 Say how much time has elapsed between the article was posted and now
6719 (@code{gnus-article-date-lapsed}).  If you want to have this line
6720 updated continually, you can put
6721
6722 @lisp
6723 (gnus-start-date-timer)
6724 @end lisp
6725
6726 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6727 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6728 command.
6729
6730 @item W T o
6731 @kindex W T o (Summary)
6732 @findex gnus-article-date-original
6733 Display the original date (@code{gnus-article-date-original}).  This can
6734 be useful if you normally use some other conversion function and are
6735 worried that it might be doing something totally wrong.  Say, claiming
6736 that the article was posted in 1854.  Although something like that is
6737 @emph{totally} impossible.  Don't you trust me? *titter*
6738
6739 @end table
6740
6741 @xref{Customizing Articles} for how to display the date in your
6742 preferred format automatically.
6743
6744
6745 @node Article Signature
6746 @subsection Article Signature
6747 @cindex signatures
6748 @cindex article signature
6749
6750 @vindex gnus-signature-separator
6751 Each article is divided into two parts---the head and the body.  The
6752 body can be divided into a signature part and a text part.  The variable
6753 that says what is to be considered a signature is
6754 @code{gnus-signature-separator}.  This is normally the standard
6755 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6756 non-standard signature separators, so this variable can also be a list
6757 of regular expressions to be tested, one by one.  (Searches are done
6758 from the end of the body towards the beginning.)  One likely value is:
6759
6760 @lisp
6761 (setq gnus-signature-separator
6762       '("^-- $"         ; The standard
6763         "^-- *$"        ; A common mangling
6764         "^-------*$"    ; Many people just use a looong
6765                         ; line of dashes.  Shame!
6766         "^ *--------*$" ; Double-shame!
6767         "^________*$"   ; Underscores are also popular
6768         "^========*$")) ; Pervert!
6769 @end lisp
6770
6771 The more permissive you are, the more likely it is that you'll get false
6772 positives.
6773
6774 @vindex gnus-signature-limit
6775 @code{gnus-signature-limit} provides a limit to what is considered a
6776 signature.
6777
6778 @enumerate
6779 @item
6780 If it is an integer, no signature may be longer (in characters) than
6781 that integer.
6782 @item
6783 If it is a floating point number, no signature may be longer (in lines)
6784 than that number.
6785 @item
6786 If it is a function, the function will be called without any parameters,
6787 and if it returns @code{nil}, there is no signature in the buffer.
6788 @item
6789 If it is a string, it will be used as a regexp.  If it matches, the text
6790 in question is not a signature.
6791 @end enumerate
6792
6793 This variable can also be a list where the elements may be of the types
6794 listed above.  Here's an example:
6795
6796 @lisp
6797 (setq gnus-signature-limit
6798       '(200.0 "^---*Forwarded article"))
6799 @end lisp
6800
6801 This means that if there are more than 200 lines after the signature
6802 separator, or the text after the signature separator is matched by
6803 the regular expression @samp{^---*Forwarded article}, then it isn't a
6804 signature after all.
6805
6806
6807 @node MIME Commands
6808 @section MIME Commands
6809 @cindex MIME decoding
6810
6811 @table @kbd
6812 @item W M w
6813 @kindex W M w (Summary)
6814 Decode RFC2047-encoded words in the article headers
6815 (@code{gnus-article-decode-mime-words}).
6816
6817 @item W M c
6818 @kindex W M c (Summary)
6819 Decode encoded article bodies as well as charsets
6820 (@code{gnus-article-decode-charset}).
6821
6822 This command looks in the @code{Content-Type} header to determine the
6823 charset.  If there is no such header in the article, you can give it a
6824 prefix, which will prompt for the charset to decode as.  In regional
6825 groups where people post using some common encoding (but do not include
6826 MIME headers), you can set the @code{charset} group/topic parameter to
6827 the required charset (@pxref{Group Parameters}).
6828
6829 @item W M v
6830 @kindex W M v (Summary)
6831 View all the @sc{mime} parts in the current article
6832 (@code{gnus-mime-view-all-parts}). 
6833
6834 @end table
6835
6836
6837 @node Article Commands
6838 @section Article Commands
6839
6840 @table @kbd
6841
6842 @item A P
6843 @cindex PostScript
6844 @cindex printing
6845 @kindex A P (Summary)
6846 @vindex gnus-ps-print-hook
6847 @findex gnus-summary-print-article
6848 Generate and print a PostScript image of the article buffer
6849 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6850 run just before printing the buffer.
6851
6852 @end table
6853
6854
6855 @node Summary Sorting
6856 @section Summary Sorting
6857 @cindex summary sorting
6858
6859 You can have the summary buffer sorted in various ways, even though I
6860 can't really see why you'd want that.
6861
6862 @table @kbd
6863
6864 @item C-c C-s C-n
6865 @kindex C-c C-s C-n (Summary)
6866 @findex gnus-summary-sort-by-number
6867 Sort by article number (@code{gnus-summary-sort-by-number}).
6868
6869 @item C-c C-s C-a
6870 @kindex C-c C-s C-a (Summary)
6871 @findex gnus-summary-sort-by-author
6872 Sort by author (@code{gnus-summary-sort-by-author}).
6873
6874 @item C-c C-s C-s
6875 @kindex C-c C-s C-s (Summary)
6876 @findex gnus-summary-sort-by-subject
6877 Sort by subject (@code{gnus-summary-sort-by-subject}).
6878
6879 @item C-c C-s C-d
6880 @kindex C-c C-s C-d (Summary)
6881 @findex gnus-summary-sort-by-date
6882 Sort by date (@code{gnus-summary-sort-by-date}).
6883
6884 @item C-c C-s C-l
6885 @kindex C-c C-s C-l (Summary)
6886 @findex gnus-summary-sort-by-lines
6887 Sort by lines (@code{gnus-summary-sort-by-lines}).
6888
6889 @item C-c C-s C-i
6890 @kindex C-c C-s C-i (Summary)
6891 @findex gnus-summary-sort-by-score
6892 Sort by score (@code{gnus-summary-sort-by-score}).
6893 @end table
6894
6895 These functions will work both when you use threading and when you don't
6896 use threading.  In the latter case, all summary lines will be sorted,
6897 line by line.  In the former case, sorting will be done on a
6898 root-by-root basis, which might not be what you were looking for.  To
6899 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6900 Commands}).
6901
6902
6903 @node Finding the Parent
6904 @section Finding the Parent
6905 @cindex parent articles
6906 @cindex referring articles
6907
6908 @table @kbd
6909 @item ^
6910 @kindex ^ (Summary)
6911 @findex gnus-summary-refer-parent-article
6912 If you'd like to read the parent of the current article, and it is not
6913 displayed in the summary buffer, you might still be able to.  That is,
6914 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6915 and the @code{References} in the current article are not mangled, you
6916 can just press @kbd{^} or @kbd{A r}
6917 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6918 you'll get the parent.  If the parent is already displayed in the
6919 summary buffer, point will just move to this article.
6920
6921 If given a positive numerical prefix, fetch that many articles back into
6922 the ancestry.  If given a negative numerical prefix, fetch just that
6923 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6924 grandparent and the grandgrandparent of the current article.  If you say
6925 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6926 article.
6927
6928 @item A R (Summary)
6929 @findex gnus-summary-refer-references
6930 @kindex A R (Summary)
6931 Fetch all articles mentioned in the @code{References} header of the
6932 article (@code{gnus-summary-refer-references}).
6933
6934 @item A T (Summary)
6935 @findex gnus-summary-refer-thread
6936 @kindex A T (Summary)
6937 Display the full thread where the current article appears
6938 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
6939 headers in the current group to work, so it usually takes a while.  If
6940 you do it often, you may consider setting @code{gnus-fetch-old-headers}
6941 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
6942 visible effects normally, but it'll make this command work a whole lot
6943 faster.  Of course, it'll make group entry somewhat slow.
6944
6945 @vindex gnus-refer-thread-limit
6946 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
6947 articles before the first displayed in the current group) headers to
6948 fetch when doing this command.  The default is 200.  If @code{t}, all
6949 the available headers will be fetched.  This variable can be overridden
6950 by giving the @kbd{A T} command a numerical prefix.
6951
6952 @item M-^ (Summary)
6953 @findex gnus-summary-refer-article
6954 @kindex M-^ (Summary)
6955 @cindex Message-ID
6956 @cindex fetching by Message-ID
6957 You can also ask the @sc{nntp} server for an arbitrary article, no
6958 matter what group it belongs to.  @kbd{M-^}
6959 (@code{gnus-summary-refer-article}) will ask you for a
6960 @code{Message-ID}, which is one of those long, hard-to-read thingies
6961 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6962 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6963 @end table
6964
6965 The current select method will be used when fetching by
6966 @code{Message-ID} from non-news select method, but you can override this
6967 by giving this command a prefix.
6968
6969 @vindex gnus-refer-article-method
6970 If the group you are reading is located on a backend that does not
6971 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6972 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6973 would, perhaps, be best if the @sc{nntp} server you consult is the one
6974 updating the spool you are reading from, but that's not really
6975 necessary.
6976
6977 Most of the mail backends support fetching by @code{Message-ID}, but do
6978 not do a particularly excellent job at it.  That is, @code{nnmbox} and
6979 @code{nnbabyl} are able to locate articles from any groups, while
6980 @code{nnml} and @code{nnfolder} are only able to locate articles that
6981 have been posted to the current group.  (Anything else would be too time
6982 consuming.)  @code{nnmh} does not support this at all.
6983
6984
6985 @node Alternative Approaches
6986 @section Alternative Approaches
6987
6988 Different people like to read news using different methods.  This being
6989 Gnus, we offer a small selection of minor modes for the summary buffers.
6990
6991 @menu
6992 * Pick and Read::               First mark articles and then read them.
6993 * Binary Groups::               Auto-decode all articles.
6994 @end menu
6995
6996
6997 @node Pick and Read
6998 @subsection Pick and Read
6999 @cindex pick and read
7000
7001 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7002 a two-phased reading interface.  The user first marks in a summary
7003 buffer the articles she wants to read.  Then she starts reading the
7004 articles with just an article buffer displayed.
7005
7006 @findex gnus-pick-mode
7007 @kindex M-x gnus-pick-mode
7008 Gnus provides a summary buffer minor mode that allows
7009 this---@code{gnus-pick-mode}.  This basically means that a few process
7010 mark commands become one-keystroke commands to allow easy marking, and
7011 it provides one additional command for switching to the summary buffer.
7012
7013 Here are the available keystrokes when using pick mode:
7014
7015 @table @kbd
7016 @item .
7017 @kindex . (Pick)
7018 @findex gnus-pick-article-or-thread
7019 Pick the article or thread on the current line
7020 (@code{gnus-pick-article-or-thread}).  If the variable
7021 @code{gnus-thread-hide-subtree} is true, then this key selects the
7022 entire thread when used at the first article of the thread.  Otherwise,
7023 it selects just the article. If given a numerical prefix, go to that
7024 thread or article and pick it.  (The line number is normally displayed
7025 at the beginning of the summary pick lines.)
7026
7027 @item SPACE
7028 @kindex SPACE (Pick)
7029 @findex gnus-pick-next-page
7030 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
7031 at the end of the buffer, start reading the picked articles.
7032
7033 @item u
7034 @kindex u (Pick)
7035 @findex gnus-pick-unmark-article-or-thread.
7036 Unpick the thread or article
7037 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
7038 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7039 thread if used at the first article of the thread.  Otherwise it unpicks 
7040 just the article.  You can give this key a numerical prefix to unpick
7041 the thread or article at that line.
7042
7043 @item RET
7044 @kindex RET (Pick)
7045 @findex gnus-pick-start-reading
7046 @vindex gnus-pick-display-summary
7047 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
7048 given a prefix, mark all unpicked articles as read first.  If
7049 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7050 will still be visible when you are reading.
7051
7052 @end table
7053
7054 All the normal summary mode commands are still available in the
7055 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
7056 which is mapped to the same function
7057 @code{gnus-summary-tick-article-forward}.
7058
7059 If this sounds like a good idea to you, you could say:
7060
7061 @lisp
7062 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7063 @end lisp
7064
7065 @vindex gnus-pick-mode-hook
7066 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7067
7068 @vindex gnus-mark-unpicked-articles-as-read
7069 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7070 all unpicked articles as read.  The default is @code{nil}.
7071
7072 @vindex gnus-summary-pick-line-format
7073 The summary line format in pick mode is slightly different from the
7074 standard format.  At the beginning of each line the line number is
7075 displayed.  The pick mode line format is controlled by the
7076 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7077 Variables}).  It accepts the same format specs that
7078 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7079
7080
7081 @node Binary Groups
7082 @subsection Binary Groups
7083 @cindex binary groups
7084
7085 @findex gnus-binary-mode
7086 @kindex M-x gnus-binary-mode
7087 If you spend much time in binary groups, you may grow tired of hitting
7088 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
7089 is a minor mode for summary buffers that makes all ordinary Gnus article
7090 selection functions uudecode series of articles and display the result
7091 instead of just displaying the articles the normal way.
7092
7093 @kindex g (Binary)
7094 @findex gnus-binary-show-article
7095 The only way, in fact, to see the actual articles is the @kbd{g}
7096 command, when you have turned on this mode
7097 (@code{gnus-binary-show-article}).
7098
7099 @vindex gnus-binary-mode-hook
7100 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7101
7102
7103 @node Tree Display
7104 @section Tree Display
7105 @cindex trees
7106
7107 @vindex gnus-use-trees
7108 If you don't like the normal Gnus summary display, you might try setting
7109 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
7110 additional @dfn{tree buffer}.  You can execute all summary mode commands
7111 in the tree buffer.
7112
7113 There are a few variables to customize the tree display, of course:
7114
7115 @table @code
7116 @item gnus-tree-mode-hook
7117 @vindex gnus-tree-mode-hook
7118 A hook called in all tree mode buffers.
7119
7120 @item gnus-tree-mode-line-format
7121 @vindex gnus-tree-mode-line-format
7122 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7123 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
7124 of valid specs, @pxref{Summary Buffer Mode Line}.
7125
7126 @item gnus-selected-tree-face
7127 @vindex gnus-selected-tree-face
7128 Face used for highlighting the selected article in the tree buffer.  The
7129 default is @code{modeline}.
7130
7131 @item gnus-tree-line-format
7132 @vindex gnus-tree-line-format
7133 A format string for the tree nodes.  The name is a bit of a misnomer,
7134 though---it doesn't define a line, but just the node.  The default value
7135 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7136 the name of the poster.  It is vital that all nodes are of the same
7137 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7138
7139 Valid specs are:
7140
7141 @table @samp
7142 @item n
7143 The name of the poster.
7144 @item f
7145 The @code{From} header.
7146 @item N
7147 The number of the article.
7148 @item [
7149 The opening bracket.
7150 @item ]
7151 The closing bracket.
7152 @item s
7153 The subject.
7154 @end table
7155
7156 @xref{Formatting Variables}.
7157
7158 Variables related to the display are:
7159
7160 @table @code
7161 @item gnus-tree-brackets
7162 @vindex gnus-tree-brackets
7163 This is used for differentiating between ``real'' articles and
7164 ``sparse'' articles.  The format is @var{((real-open . real-close)
7165 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7166 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7167
7168 @item gnus-tree-parent-child-edges
7169 @vindex gnus-tree-parent-child-edges
7170 This is a list that contains the characters used for connecting parent
7171 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
7172
7173 @end table
7174
7175 @item gnus-tree-minimize-window
7176 @vindex gnus-tree-minimize-window
7177 If this variable is non-@code{nil}, Gnus will try to keep the tree
7178 buffer as small as possible to allow more room for the other Gnus
7179 windows.  If this variable is a number, the tree buffer will never be
7180 higher than that number.  The default is @code{t}.  Note that if you
7181 have several windows displayed side-by-side in a frame and the tree
7182 buffer is one of these, minimizing the tree window will also resize all
7183 other windows displayed next to it.
7184
7185 @item gnus-generate-tree-function
7186 @vindex gnus-generate-tree-function
7187 @findex gnus-generate-horizontal-tree
7188 @findex gnus-generate-vertical-tree
7189 The function that actually generates the thread tree.  Two predefined
7190 functions are available: @code{gnus-generate-horizontal-tree} and
7191 @code{gnus-generate-vertical-tree} (which is the default).
7192
7193 @end table
7194
7195 Here's an example from a horizontal tree buffer:
7196
7197 @example
7198 @{***@}-(***)-[odd]-[Gun]
7199      |      \[Jan]
7200      |      \[odd]-[Eri]
7201      |      \(***)-[Eri]
7202      |            \[odd]-[Paa]
7203      \[Bjo]
7204      \[Gun]
7205      \[Gun]-[Jor]
7206 @end example
7207
7208 Here's the same thread displayed in a vertical tree buffer:
7209
7210 @example
7211 @{***@}
7212   |--------------------------\-----\-----\
7213 (***)                         [Bjo] [Gun] [Gun]
7214   |--\-----\-----\                          |
7215 [odd] [Jan] [odd] (***)                   [Jor]
7216   |           |     |--\
7217 [Gun]       [Eri] [Eri] [odd]
7218                           |
7219                         [Paa]
7220 @end example
7221
7222 If you're using horizontal trees, it might be nice to display the trees
7223 side-by-side with the summary buffer.  You could add something like the
7224 following to your @file{.gnus.el} file:
7225
7226 @lisp
7227 (setq gnus-use-trees t
7228       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7229       gnus-tree-minimize-window nil)
7230 (gnus-add-configuration
7231  '(article
7232    (vertical 1.0
7233              (horizontal 0.25
7234                          (summary 0.75 point)
7235                          (tree 1.0))
7236              (article 1.0))))
7237 @end lisp
7238
7239 @xref{Windows Configuration}.
7240
7241
7242 @node Mail Group Commands
7243 @section Mail Group Commands
7244 @cindex mail group commands
7245
7246 Some commands only make sense in mail groups.  If these commands are
7247 invalid in the current group, they will raise a hell and let you know.
7248
7249 All these commands (except the expiry and edit commands) use the
7250 process/prefix convention (@pxref{Process/Prefix}).
7251
7252 @table @kbd
7253
7254 @item B e
7255 @kindex B e (Summary)
7256 @findex gnus-summary-expire-articles
7257 Expire all expirable articles in the group
7258 (@code{gnus-summary-expire-articles}).
7259
7260 @item B M-C-e
7261 @kindex B M-C-e (Summary)
7262 @findex gnus-summary-expire-articles-now
7263 Delete all the expirable articles in the group
7264 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7265 articles eligible for expiry in the current group will
7266 disappear forever into that big @file{/dev/null} in the sky.
7267
7268 @item B DEL
7269 @kindex B DEL (Summary)
7270 @findex gnus-summary-delete-article
7271 @c @icon{gnus-summary-mail-delete}
7272 Delete the mail article.  This is ``delete'' as in ``delete it from your
7273 disk forever and ever, never to return again.'' Use with caution.
7274 (@code{gnus-summary-delete-article}).
7275
7276 @item B m
7277 @kindex B m (Summary)
7278 @cindex move mail
7279 @findex gnus-summary-move-article
7280 Move the article from one mail group to another
7281 (@code{gnus-summary-move-article}).
7282
7283 @item B c
7284 @kindex B c (Summary)
7285 @cindex copy mail
7286 @findex gnus-summary-copy-article
7287 @c @icon{gnus-summary-mail-copy}
7288 Copy the article from one group (mail group or not) to a mail group
7289 (@code{gnus-summary-copy-article}).
7290
7291 @item B B
7292 @kindex B B (Summary)
7293 @cindex crosspost mail
7294 @findex gnus-summary-crosspost-article
7295 Crosspost the current article to some other group
7296 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7297 the article in the other group, and the Xref headers of the article will
7298 be properly updated.
7299
7300 @item B i
7301 @kindex B i (Summary)
7302 @findex gnus-summary-import-article
7303 Import an arbitrary file into the current mail newsgroup
7304 (@code{gnus-summary-import-article}).  You will be prompted for a file
7305 name, a @code{From} header and a @code{Subject} header.
7306
7307 @item B r
7308 @kindex B r (Summary)
7309 @findex gnus-summary-respool-article
7310 Respool the mail article (@code{gnus-summary-respool-article}).
7311 @code{gnus-summary-respool-default-method} will be used as the default
7312 select method when respooling.  This variable is @code{nil} by default,
7313 which means that the current group select method will be used instead.
7314
7315 @item B w
7316 @itemx e
7317 @kindex B w (Summary)
7318 @kindex e (Summary)
7319 @findex gnus-summary-edit-article
7320 @kindex C-c C-c (Article)
7321 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7322 editing and make the changes permanent, type @kbd{C-c C-c}
7323 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7324 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7325
7326 @item B q
7327 @kindex B q (Summary)
7328 @findex gnus-summary-respool-query
7329 If you want to re-spool an article, you might be curious as to what group
7330 the article will end up in before you do the re-spooling.  This command
7331 will tell you (@code{gnus-summary-respool-query}).
7332
7333 @item B t
7334 @kindex B t (Summary)
7335 @findex gnus-summary-respool-trace
7336 Similarly, this command will display all fancy splitting patterns used
7337 when repooling, if any (@code{gnus-summary-respool-trace}).
7338
7339 @item B p
7340 @kindex B p (Summary)
7341 @findex gnus-summary-article-posted-p
7342 Some people have a tendency to send you "courtesy" copies when they
7343 follow up to articles you have posted.  These usually have a
7344 @code{Newsgroups} header in them, but not always.  This command
7345 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7346 article from your news server (or rather, from
7347 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7348 report back whether it found the article or not.  Even if it says that
7349 it didn't find the article, it may have been posted anyway---mail
7350 propagation is much faster than news propagation, and the news copy may
7351 just not have arrived yet.
7352
7353 @end table
7354
7355 @vindex gnus-move-split-methods
7356 @cindex moving articles
7357 If you move (or copy) articles regularly, you might wish to have Gnus
7358 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7359 variable that uses the same syntax as @code{gnus-split-methods}
7360 (@pxref{Saving Articles}).  You may customize that variable to create
7361 suggestions you find reasonable.
7362
7363 @lisp
7364 (setq gnus-move-split-methods
7365       '(("^From:.*Lars Magne" "nnml:junk")
7366         ("^Subject:.*gnus" "nnfolder:important")
7367         (".*" "nnml:misc")))
7368 @end lisp
7369
7370
7371 @node Various Summary Stuff
7372 @section Various Summary Stuff
7373
7374 @menu
7375 * Summary Group Information::         Information oriented commands.
7376 * Searching for Articles::            Multiple article commands.
7377 * Summary Generation Commands::       (Re)generating the summary buffer.
7378 * Really Various Summary Commands::   Those pesky non-conformant commands.
7379 @end menu
7380
7381 @table @code
7382 @vindex gnus-summary-mode-hook
7383 @item gnus-summary-mode-hook
7384 This hook is called when creating a summary mode buffer.
7385
7386 @vindex gnus-summary-generate-hook
7387 @item gnus-summary-generate-hook
7388 This is called as the last thing before doing the threading and the
7389 generation of the summary buffer.  It's quite convenient for customizing
7390 the threading variables based on what data the newsgroup has.  This hook
7391 is called from the summary buffer after most summary buffer variables
7392 have been set.
7393
7394 @vindex gnus-summary-prepare-hook
7395 @item gnus-summary-prepare-hook
7396 It is called after the summary buffer has been generated.  You might use
7397 it to, for instance, highlight lines or modify the look of the buffer in
7398 some other ungodly manner.  I don't care.
7399
7400 @vindex gnus-summary-prepared-hook
7401 @item gnus-summary-prepared-hook
7402 A hook called as the very last thing after the summary buffer has been
7403 generated.
7404
7405 @vindex gnus-summary-ignore-duplicates
7406 @item gnus-summary-ignore-duplicates
7407 When Gnus discovers two articles that have the same @code{Message-ID},
7408 it has to do something drastic.  No articles are allowed to have the
7409 same @code{Message-ID}, but this may happen when reading mail from some
7410 sources.  Gnus allows you to customize what happens with this variable.
7411 If it is @code{nil} (which is the default), Gnus will rename the
7412 @code{Message-ID} (for display purposes only) and display the article as
7413 any other article.  If this variable is @code{t}, it won't display the
7414 article---it'll be as if it never existed.
7415
7416 @end table
7417
7418
7419 @node Summary Group Information
7420 @subsection Summary Group Information
7421
7422 @table @kbd
7423
7424 @item H f
7425 @kindex H f (Summary)
7426 @findex gnus-summary-fetch-faq
7427 @vindex gnus-group-faq-directory
7428 Try to fetch the FAQ (list of frequently asked questions) for the
7429 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7430 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7431 on a remote machine.  This variable can also be a list of directories.
7432 In that case, giving a prefix to this command will allow you to choose
7433 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7434 be used for fetching the file.
7435
7436 @item H d
7437 @kindex H d (Summary)
7438 @findex gnus-summary-describe-group
7439 Give a brief description of the current group
7440 (@code{gnus-summary-describe-group}).  If given a prefix, force
7441 rereading the description from the server.
7442
7443 @item H h
7444 @kindex H h (Summary)
7445 @findex gnus-summary-describe-briefly
7446 Give an extremely brief description of the most important summary
7447 keystrokes (@code{gnus-summary-describe-briefly}).
7448
7449 @item H i
7450 @kindex H i (Summary)
7451 @findex gnus-info-find-node
7452 Go to the Gnus info node (@code{gnus-info-find-node}).
7453 @end table
7454
7455
7456 @node Searching for Articles
7457 @subsection Searching for Articles
7458
7459 @table @kbd
7460
7461 @item M-s
7462 @kindex M-s (Summary)
7463 @findex gnus-summary-search-article-forward
7464 Search through all subsequent articles for a regexp
7465 (@code{gnus-summary-search-article-forward}).
7466
7467 @item M-r
7468 @kindex M-r (Summary)
7469 @findex gnus-summary-search-article-backward
7470 Search through all previous articles for a regexp
7471 (@code{gnus-summary-search-article-backward}).
7472
7473 @item &
7474 @kindex & (Summary)
7475 @findex gnus-summary-execute-command
7476 This command will prompt you for a header field, a regular expression to
7477 match on this field, and a command to be executed if the match is made
7478 (@code{gnus-summary-execute-command}).  If given a prefix, search
7479 backward instead.
7480
7481 @item M-&
7482 @kindex M-& (Summary)
7483 @findex gnus-summary-universal-argument
7484 Perform any operation on all articles that have been marked with
7485 the process mark (@code{gnus-summary-universal-argument}).
7486 @end table
7487
7488 @node Summary Generation Commands
7489 @subsection Summary Generation Commands
7490
7491 @table @kbd
7492
7493 @item Y g
7494 @kindex Y g (Summary)
7495 @findex gnus-summary-prepare
7496 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7497
7498 @item Y c
7499 @kindex Y c (Summary)
7500 @findex gnus-summary-insert-cached-articles
7501 Pull all cached articles (for the current group) into the summary buffer
7502 (@code{gnus-summary-insert-cached-articles}).
7503
7504 @end table
7505
7506
7507 @node Really Various Summary Commands
7508 @subsection Really Various Summary Commands
7509
7510 @table @kbd
7511
7512 @item C-d
7513 @kindex C-d (Summary)
7514 @findex gnus-summary-enter-digest-group
7515 If the current article is a collection of other articles (for instance,
7516 a digest), you might use this command to enter a group based on the that
7517 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7518 guess what article type is currently displayed unless you give a prefix
7519 to this command, which forces a ``digest'' interpretation.  Basically,
7520 whenever you see a message that is a collection of other messages of
7521 some format, you @kbd{C-d} and read these messages in a more convenient
7522 fashion.
7523
7524 @item M-C-d
7525 @kindex M-C-d (Summary)
7526 @findex gnus-summary-read-document
7527 This command is very similar to the one above, but lets you gather
7528 several documents into one biiig group
7529 (@code{gnus-summary-read-document}).  It does this by opening several
7530 @code{nndoc} groups for each document, and then opening an
7531 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7532 command understands the process/prefix convention
7533 (@pxref{Process/Prefix}).
7534
7535 @item C-t
7536 @kindex C-t (Summary)
7537 @findex gnus-summary-toggle-truncation
7538 Toggle truncation of summary lines
7539 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7540 line centering function in the summary buffer, so it's not a good idea
7541 to have truncation switched off while reading articles.
7542
7543 @item =
7544 @kindex = (Summary)
7545 @findex gnus-summary-expand-window
7546 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7547 If given a prefix, force an @code{article} window configuration.
7548
7549 @item M-C-e
7550 @kindex M-C-e (Summary)
7551 @findex gnus-summary-edit-parameters
7552 Edit the group parameters (@pxref{Group Parameters}) of the current
7553 group (@code{gnus-summary-edit-parameters}).
7554
7555 @end table
7556
7557
7558 @node Exiting the Summary Buffer
7559 @section Exiting the Summary Buffer
7560 @cindex summary exit
7561 @cindex exiting groups
7562
7563 Exiting from the summary buffer will normally update all info on the
7564 group and return you to the group buffer.
7565
7566 @table @kbd
7567
7568 @item Z Z
7569 @itemx q
7570 @kindex Z Z (Summary)
7571 @kindex q (Summary)
7572 @findex gnus-summary-exit
7573 @vindex gnus-summary-exit-hook
7574 @vindex gnus-summary-prepare-exit-hook
7575 @c @icon{gnus-summary-exit}
7576 Exit the current group and update all information on the group
7577 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7578 called before doing much of the exiting, which calls
7579 @code{gnus-summary-expire-articles} by default.
7580 @code{gnus-summary-exit-hook} is called after finishing the exit
7581 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7582 group mode having no more (unread) groups.
7583
7584 @item Z E
7585 @itemx Q
7586 @kindex Z E (Summary)
7587 @kindex Q (Summary)
7588 @findex gnus-summary-exit-no-update
7589 Exit the current group without updating any information on the group
7590 (@code{gnus-summary-exit-no-update}).
7591
7592 @item Z c
7593 @itemx c
7594 @kindex Z c (Summary)
7595 @kindex c (Summary)
7596 @findex gnus-summary-catchup-and-exit
7597 @c @icon{gnus-summary-catchup-and-exit}
7598 Mark all unticked articles in the group as read and then exit
7599 (@code{gnus-summary-catchup-and-exit}).
7600
7601 @item Z C
7602 @kindex Z C (Summary)
7603 @findex gnus-summary-catchup-all-and-exit
7604 Mark all articles, even the ticked ones, as read and then exit
7605 (@code{gnus-summary-catchup-all-and-exit}).
7606
7607 @item Z n
7608 @kindex Z n (Summary)
7609 @findex gnus-summary-catchup-and-goto-next-group
7610 Mark all articles as read and go to the next group
7611 (@code{gnus-summary-catchup-and-goto-next-group}).
7612
7613 @item Z R
7614 @kindex Z R (Summary)
7615 @findex gnus-summary-reselect-current-group
7616 Exit this group, and then enter it again
7617 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7618 all articles, both read and unread.
7619
7620 @item Z G
7621 @itemx M-g
7622 @kindex Z G (Summary)
7623 @kindex M-g (Summary)
7624 @findex gnus-summary-rescan-group
7625 @c @icon{gnus-summary-mail-get}
7626 Exit the group, check for new articles in the group, and select the
7627 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7628 articles, both read and unread.
7629
7630 @item Z N
7631 @kindex Z N (Summary)
7632 @findex gnus-summary-next-group
7633 Exit the group and go to the next group
7634 (@code{gnus-summary-next-group}).
7635
7636 @item Z P
7637 @kindex Z P (Summary)
7638 @findex gnus-summary-prev-group
7639 Exit the group and go to the previous group
7640 (@code{gnus-summary-prev-group}).
7641
7642 @item Z s
7643 @kindex Z s (Summary)
7644 @findex gnus-summary-save-newsrc
7645 Save the current number of read/marked articles in the dribble buffer
7646 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7647 given a prefix, also save the @file{.newsrc} file(s).  Using this
7648 command will make exit without updating (the @kbd{Q} command) worthless.
7649 @end table
7650
7651 @vindex gnus-exit-group-hook
7652 @code{gnus-exit-group-hook} is called when you exit the current
7653 group.
7654
7655 @findex gnus-summary-wake-up-the-dead
7656 @findex gnus-dead-summary-mode
7657 @vindex gnus-kill-summary-on-exit
7658 If you're in the habit of exiting groups, and then changing your mind
7659 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7660 If you do that, Gnus won't kill the summary buffer when you exit it.
7661 (Quelle surprise!)  Instead it will change the name of the buffer to
7662 something like @samp{*Dead Summary ... *} and install a minor mode
7663 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7664 buffer, you'll find that all keys are mapped to a function called
7665 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7666 summary buffer will result in a live, normal summary buffer.
7667
7668 There will never be more than one dead summary buffer at any one time.
7669
7670 @vindex gnus-use-cross-reference
7671 The data on the current group will be updated (which articles you have
7672 read, which articles you have replied to, etc.) when you exit the
7673 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7674 @code{t} (which is the default), articles that are cross-referenced to
7675 this group and are marked as read, will also be marked as read in the
7676 other subscribed groups they were cross-posted to.  If this variable is
7677 neither @code{nil} nor @code{t}, the article will be marked as read in
7678 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7679
7680
7681 @node Crosspost Handling
7682 @section Crosspost Handling
7683
7684 @cindex velveeta
7685 @cindex spamming
7686 Marking cross-posted articles as read ensures that you'll never have to
7687 read the same article more than once.  Unless, of course, somebody has
7688 posted it to several groups separately.  Posting the same article to
7689 several groups (not cross-posting) is called @dfn{spamming}, and you are
7690 by law required to send nasty-grams to anyone who perpetrates such a
7691 heinous crime.  You may want to try NoCeM handling to filter out spam
7692 (@pxref{NoCeM}).
7693
7694 Remember: Cross-posting is kinda ok, but posting the same article
7695 separately to several groups is not.  Massive cross-posting (aka.
7696 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7697 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7698 excessive crossposting (@pxref{Summary Mail Commands}).
7699
7700 @cindex cross-posting
7701 @cindex Xref
7702 @cindex @sc{nov}
7703 One thing that may cause Gnus to not do the cross-posting thing
7704 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7705 (which is very nice, because it speeds things up considerably) which
7706 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7707 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7708 even with @sc{xover} by registering the @code{Xref} lines of all
7709 articles you actually read, but if you kill the articles, or just mark
7710 them as read without reading them, Gnus will not get a chance to snoop
7711 the @code{Xref} lines out of these articles, and will be unable to use
7712 the cross reference mechanism.
7713
7714 @cindex LIST overview.fmt
7715 @cindex overview.fmt
7716 To check whether your @sc{nntp} server includes the @code{Xref} header
7717 in its overview files, try @samp{telnet your.nntp.server nntp},
7718 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7719 overview.fmt}.  This may not work, but if it does, and the last line you
7720 get does not read @samp{Xref:full}, then you should shout and whine at
7721 your news admin until she includes the @code{Xref} header in the
7722 overview files.
7723
7724 @vindex gnus-nov-is-evil
7725 If you want Gnus to get the @code{Xref}s right all the time, you have to
7726 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7727 considerably.
7728
7729 C'est la vie.
7730
7731 For an alternative approach, @pxref{Duplicate Suppression}.
7732
7733
7734 @node Duplicate Suppression
7735 @section Duplicate Suppression
7736
7737 By default, Gnus tries to make sure that you don't have to read the same
7738 article more than once by utilizing the crossposting mechanism
7739 (@pxref{Crosspost Handling}).  However, that simple and efficient
7740 approach may not work satisfactory for some users for various
7741 reasons.
7742
7743 @enumerate
7744 @item
7745 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7746 is evil and not very common.
7747
7748 @item
7749 The @sc{nntp} server may fail to include the @code{Xref} header in the
7750 @file{.overview} data bases.  This is evil and all too common, alas.
7751
7752 @item
7753 You may be reading the same group (or several related groups) from
7754 different @sc{nntp} servers.
7755
7756 @item
7757 You may be getting mail that duplicates articles posted to groups.
7758 @end enumerate
7759
7760 I'm sure there are other situations where @code{Xref} handling fails as
7761 well, but these four are the most common situations.
7762
7763 If, and only if, @code{Xref} handling fails for you, then you may
7764 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7765 will remember the @code{Message-ID}s of all articles you have read or
7766 otherwise marked as read, and then, as if by magic, mark them as read
7767 all subsequent times you see them---in @emph{all} groups.  Using this
7768 mechanism is quite likely to be somewhat inefficient, but not overly
7769 so.  It's certainly preferable to reading the same articles more than
7770 once.
7771
7772 Duplicate suppression is not a very subtle instrument.  It's more like a
7773 sledge hammer than anything else.  It works in a very simple
7774 fashion---if you have marked an article as read, it adds this Message-ID
7775 to a cache.  The next time it sees this Message-ID, it will mark the
7776 article as read with the @samp{M} mark.  It doesn't care what group it
7777 saw the article in.
7778
7779 @table @code
7780 @item gnus-suppress-duplicates
7781 @vindex gnus-suppress-duplicates
7782 If non-@code{nil}, suppress duplicates.
7783
7784 @item gnus-save-duplicate-list
7785 @vindex gnus-save-duplicate-list
7786 If non-@code{nil}, save the list of duplicates to a file.  This will
7787 make startup and shutdown take longer, so the default is @code{nil}.
7788 However, this means that only duplicate articles read in a single Gnus
7789 session are suppressed.
7790
7791 @item gnus-duplicate-list-length
7792 @vindex gnus-duplicate-list-length
7793 This variable says how many @code{Message-ID}s to keep in the duplicate
7794 suppression list.  The default is 10000.
7795
7796 @item gnus-duplicate-file
7797 @vindex gnus-duplicate-file
7798 The name of the file to store the duplicate suppression list in.  The
7799 default is @file{~/News/suppression}.
7800 @end table
7801
7802 If you have a tendency to stop and start Gnus often, setting
7803 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7804 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7805 the other hand, saving the list makes startup and shutdown much slower,
7806 so that means that if you stop and start Gnus often, you should set
7807 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7808 to you to figure out, I think.
7809
7810
7811 @node The Article Buffer
7812 @chapter The Article Buffer
7813 @cindex article buffer
7814
7815 The articles are displayed in the article buffer, of which there is only
7816 one.  All the summary buffers share the same article buffer unless you
7817 tell Gnus otherwise.
7818
7819 @menu
7820 * Hiding Headers::        Deciding what headers should be displayed.
7821 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7822 * Customizing Articles::  Tailoring the look of the articles.
7823 * Article Keymap::        Keystrokes available in the article buffer.
7824 * Misc Article::          Other stuff.
7825 @end menu
7826
7827
7828 @node Hiding Headers
7829 @section Hiding Headers
7830 @cindex hiding headers
7831 @cindex deleting headers
7832
7833 The top section of each article is the @dfn{head}.  (The rest is the
7834 @dfn{body}, but you may have guessed that already.)
7835
7836 @vindex gnus-show-all-headers
7837 There is a lot of useful information in the head: the name of the person
7838 who wrote the article, the date it was written and the subject of the
7839 article.  That's well and nice, but there's also lots of information
7840 most people do not want to see---what systems the article has passed
7841 through before reaching you, the @code{Message-ID}, the
7842 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7843 of some of those lines.  If you want to keep all those lines in the
7844 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7845
7846 Gnus provides you with two variables for sifting headers:
7847
7848 @table @code
7849
7850 @item gnus-visible-headers
7851 @vindex gnus-visible-headers
7852 If this variable is non-@code{nil}, it should be a regular expression
7853 that says what headers you wish to keep in the article buffer.  All
7854 headers that do not match this variable will be hidden.
7855
7856 For instance, if you only want to see the name of the person who wrote
7857 the article and the subject, you'd say:
7858
7859 @lisp
7860 (setq gnus-visible-headers "^From:\\|^Subject:")
7861 @end lisp
7862
7863 This variable can also be a list of regexps to match headers to
7864 remain visible.
7865
7866 @item gnus-ignored-headers
7867 @vindex gnus-ignored-headers
7868 This variable is the reverse of @code{gnus-visible-headers}.  If this
7869 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7870 should be a regular expression that matches all lines that you want to
7871 hide.  All lines that do not match this variable will remain visible.
7872
7873 For instance, if you just want to get rid of the @code{References} line
7874 and the @code{Xref} line, you might say:
7875
7876 @lisp
7877 (setq gnus-ignored-headers "^References:\\|^Xref:")
7878 @end lisp
7879
7880 This variable can also be a list of regexps to match headers to
7881 be removed.
7882
7883 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7884 variable will have no effect.
7885
7886 @end table
7887
7888 @vindex gnus-sorted-header-list
7889 Gnus can also sort the headers for you.  (It does this by default.)  You
7890 can control the sorting by setting the @code{gnus-sorted-header-list}
7891 variable.  It is a list of regular expressions that says in what order
7892 the headers are to be displayed.
7893
7894 For instance, if you want the name of the author of the article first,
7895 and then the subject, you might say something like:
7896
7897 @lisp
7898 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7899 @end lisp
7900
7901 Any headers that are to remain visible, but are not listed in this
7902 variable, will be displayed in random order after all the headers listed in this variable.
7903
7904 @findex gnus-article-hide-boring-headers
7905 @vindex gnus-article-display-hook
7906 @vindex gnus-boring-article-headers
7907 You can hide further boring headers by entering
7908 @code{gnus-article-hide-boring-headers} into
7909 @code{gnus-article-display-hook}.  What this function does depends on
7910 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7911 list doesn't actually contain header names.  Instead is lists various
7912 @dfn{boring conditions} that Gnus can check and remove from sight.
7913
7914 These conditions are:
7915 @table @code
7916 @item empty
7917 Remove all empty headers.
7918 @item followup-to
7919 Remove the @code{Followup-To} header if it is identical to the
7920 @code{Newsgroups} header.
7921 @item reply-to
7922 Remove the @code{Reply-To} header if it lists the same address as the
7923 @code{From} header.
7924 @item newsgroups
7925 Remove the @code{Newsgroups} header if it only contains the current group
7926 name.
7927 @item date
7928 Remove the @code{Date} header if the article is less than three days
7929 old.
7930 @item long-to
7931 Remove the @code{To} header if it is very long.
7932 @item many-to
7933 Remove all @code{To} headers if there are more than one.
7934 @end table
7935
7936 To include the four three elements, you could say something like;
7937
7938 @lisp
7939 (setq gnus-boring-article-headers
7940       '(empty followup-to reply-to))
7941 @end lisp
7942
7943 This is also the default value for this variable.
7944
7945
7946 @node Using MIME
7947 @section Using @sc{mime}
7948 @cindex @sc{mime}
7949
7950 Mime is a standard for waving your hands through the air, aimlessly,
7951 while people stand around yawning.
7952
7953 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7954 while all newsreaders die of fear.
7955
7956 @sc{mime} may specify what character set the article uses, the encoding
7957 of the characters, and it also makes it possible to embed pictures and
7958 other naughty stuff in innocent-looking articles.
7959
7960 @vindex gnus-display-mime-function
7961 @findex gnus-display-mime
7962 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function} 
7963 to display the @sc{mime} parts.  This is @code{gnus-display-mime} by
7964 default, which creates a bundle of clickable buttons that can be used to 
7965 display, save and manipulate the @sc{mime} objects.  
7966
7967 The following commands are available when you have placed point over a
7968 @sc{mime} button:
7969
7970 @table @kbd
7971 @findex gnus-article-press-button
7972 @item RET (Article)
7973 @itemx BUTTON-2 (Article)
7974 Toggle displaying of the @sc{mime} object
7975 (@code{gnus-article-press-button}).
7976
7977 @findex gnus-mime-view-part
7978 @item M-RET (Article)
7979 @itemx v (Article)
7980 Prompt for a method, and then view the @sc{mime} object using this
7981 method (@code{gnus-mime-view-part}).
7982
7983 @findex gnus-mime-save-part
7984 @item o (Article)
7985 Prompt for a file name, and then save the @sc{mime} object
7986 (@code{gnus-mime-save-part}).
7987
7988 @findex gnus-mime-copy-part
7989 @item c (Article)
7990 Copy the @sc{mime} object to a fresh buffer and display this buffer
7991 (@code{gnus-mime-copy-part}).
7992
7993 @findex gnus-mime-pipe-part
7994 @item | (Article)
7995 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
7996 @end table
7997
7998 Gnus will display some @sc{mime} objects automatically.  The way Gnus
7999 determines which parts to do this with is described in the Emacs MIME
8000 manual.  
8001
8002 It might be best to just use the toggling functions from the article
8003 buffer to avoid getting nasty surprises.  (For instance, you enter the
8004 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
8005 decoded the sound file in the article and some horrible sing-a-long song
8006 comes screaming out your speakers, and you can't find the volume button,
8007 because there isn't one, and people are starting to look at you, and you
8008 try to stop the program, but you can't, and you can't find the program
8009 to control the volume, and everybody else in the room suddenly decides
8010 to look at you disdainfully, and you'll feel rather stupid.)
8011
8012 Any similarity to real events and people is purely coincidental.  Ahem.
8013
8014
8015 @node Customizing Articles
8016 @section Customizing Articles
8017 @cindex article customization
8018
8019 @vindex gnus-article-display-hook
8020 The @code{gnus-article-display-hook} is called after the article has
8021 been inserted into the article buffer.  It is meant to handle all
8022 treatment of the article before it is displayed.
8023
8024 @findex gnus-article-maybe-highlight
8025 @findex gnus-article-maybe-hide-headers
8026 By default this hook just contains
8027 @code{gnus-article-maybe-hide-headers},
8028 @code{gnus-hide-boring-headers}, @code{gnus-article-treat-overstrike},
8029 and @code{gnus-article-maybe-highlight} (and under XEmacs,
8030 @code{gnus-article-display-x-face}), but there are thousands, nay
8031 millions, of functions you can put in this hook.  For an overview of
8032 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
8033 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
8034 Date}.  Note that the order of functions in this hook might affect
8035 things, so you may have to fiddle a bit to get the desired results.
8036
8037 You can, of course, write your own functions.  The functions are called
8038 from the article buffer, and you can do anything you like, pretty much.
8039 There is no information that you have to keep in the buffer---you can
8040 change everything.  However, you shouldn't delete any headers.  Instead
8041 make them invisible if you want to make them go away.
8042
8043
8044 @node Article Keymap
8045 @section Article Keymap
8046
8047 Most of the keystrokes in the summary buffer can also be used in the
8048 article buffer.  They should behave as if you typed them in the summary
8049 buffer, which means that you don't actually have to have a summary
8050 buffer displayed while reading.  You can do it all from the article
8051 buffer.
8052
8053 A few additional keystrokes are available:
8054
8055 @table @kbd
8056
8057 @item SPACE
8058 @kindex SPACE (Article)
8059 @findex gnus-article-next-page
8060 Scroll forwards one page (@code{gnus-article-next-page}).
8061
8062 @item DEL
8063 @kindex DEL (Article)
8064 @findex gnus-article-prev-page
8065 Scroll backwards one page (@code{gnus-article-prev-page}).
8066
8067 @item C-c ^
8068 @kindex C-c ^ (Article)
8069 @findex gnus-article-refer-article
8070 If point is in the neighborhood of a @code{Message-ID} and you press
8071 @kbd{C-c ^}, Gnus will try to get that article from the server
8072 (@code{gnus-article-refer-article}).
8073
8074 @item C-c C-m
8075 @kindex C-c C-m (Article)
8076 @findex gnus-article-mail
8077 Send a reply to the address near point (@code{gnus-article-mail}).  If
8078 given a prefix, include the mail.
8079
8080 @item s
8081 @kindex s (Article)
8082 @findex gnus-article-show-summary
8083 Reconfigure the buffers so that the summary buffer becomes visible
8084 (@code{gnus-article-show-summary}).
8085
8086 @item ?
8087 @kindex ? (Article)
8088 @findex gnus-article-describe-briefly
8089 Give a very brief description of the available keystrokes
8090 (@code{gnus-article-describe-briefly}).
8091
8092 @item TAB
8093 @kindex TAB (Article)
8094 @findex gnus-article-next-button
8095 Go to the next button, if any (@code{gnus-article-next-button}).  This
8096 only makes sense if you have buttonizing turned on.
8097
8098 @item M-TAB
8099 @kindex M-TAB (Article)
8100 @findex gnus-article-prev-button
8101 Go to the previous button, if any (@code{gnus-article-prev-button}).
8102
8103 @end table
8104
8105
8106 @node Misc Article
8107 @section Misc Article
8108
8109 @table @code
8110
8111 @item gnus-single-article-buffer
8112 @vindex gnus-single-article-buffer
8113 If non-@code{nil}, use the same article buffer for all the groups.
8114 (This is the default.)  If @code{nil}, each group will have its own
8115 article buffer.
8116
8117 @vindex gnus-article-decode-hook
8118 @item gnus-article-decode-hook
8119 @cindex MIME
8120 Hook used to decode @sc{mime} articles.  The default value is
8121 @code{(article-decode-charset article-decode-encoded-words)}
8122
8123 @vindex gnus-article-prepare-hook
8124 @item gnus-article-prepare-hook
8125 This hook is called right after the article has been inserted into the
8126 article buffer.  It is mainly intended for functions that do something
8127 depending on the contents; it should probably not be used for changing
8128 the contents of the article buffer.
8129
8130 @vindex gnus-article-display-hook
8131 @item gnus-article-display-hook
8132 This hook is called as the last thing when displaying an article, and is
8133 intended for modifying the contents of the buffer, doing highlights,
8134 hiding headers, and the like.
8135
8136 @item gnus-article-mode-hook
8137 @vindex gnus-article-mode-hook
8138 Hook called in article mode buffers.
8139
8140 @item gnus-article-mode-syntax-table
8141 @vindex gnus-article-mode-syntax-table
8142 Syntax table used in article buffers.  It is initialized from
8143 @code{text-mode-syntax-table}.
8144
8145 @vindex gnus-article-mode-line-format
8146 @item gnus-article-mode-line-format
8147 This variable is a format string along the same lines as
8148 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
8149 accepts the same format specifications as that variable, with one
8150 extension:
8151
8152 @table @samp
8153 @item w
8154 The @dfn{wash status} of the article.  This is a short string with one
8155 character for each possible article wash operation that may have been
8156 performed.
8157 @end table
8158
8159 @vindex gnus-break-pages
8160
8161 @item gnus-break-pages
8162 Controls whether @dfn{page breaking} is to take place.  If this variable
8163 is non-@code{nil}, the articles will be divided into pages whenever a
8164 page delimiter appears in the article.  If this variable is @code{nil},
8165 paging will not be done.
8166
8167 @item gnus-page-delimiter
8168 @vindex gnus-page-delimiter
8169 This is the delimiter mentioned above.  By default, it is @samp{^L}
8170 (formfeed).
8171 @end table
8172
8173
8174 @node Composing Messages
8175 @chapter Composing Messages
8176 @cindex composing messages
8177 @cindex messages
8178 @cindex mail
8179 @cindex sending mail
8180 @cindex reply
8181 @cindex followup
8182 @cindex post
8183
8184 @kindex C-c C-c (Post)
8185 All commands for posting and mailing will put you in a message buffer
8186 where you can edit the article all you like, before you send the article
8187 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
8188 Manual}.  If you are in a foreign news group, and you wish to post the
8189 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8190 to make Gnus try to post using the foreign server.
8191
8192 @menu
8193 * Mail::                 Mailing and replying.
8194 * Post::                 Posting and following up.
8195 * Posting Server::       What server should you post via?
8196 * Mail and Post::        Mailing and posting at the same time.
8197 * Archived Messages::    Where Gnus stores the messages you've sent.
8198 * Posting Styles::       An easier way to specify who you are.
8199 * Drafts::               Postponing messages and rejected messages.
8200 * Rejected Articles::    What happens if the server doesn't like your article?
8201 @end menu
8202
8203 Also see @pxref{Canceling and Superseding} for information on how to
8204 remove articles you shouldn't have posted.
8205
8206
8207 @node Mail
8208 @section Mail
8209
8210 Variables for customizing outgoing mail:
8211
8212 @table @code
8213 @item gnus-uu-digest-headers
8214 @vindex gnus-uu-digest-headers
8215 List of regexps to match headers included in digested messages.  The
8216 headers will be included in the sequence they are matched.
8217
8218 @item gnus-add-to-list
8219 @vindex gnus-add-to-list
8220 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8221 that have none when you do a @kbd{a}.
8222
8223 @end table
8224
8225
8226 @node Post
8227 @section Post
8228
8229 Variables for composing news articles:
8230
8231 @table @code
8232 @item gnus-sent-message-ids-file
8233 @vindex gnus-sent-message-ids-file
8234 Gnus will keep a @code{Message-ID} history file of all the mails it has
8235 sent.  If it discovers that it has already sent a mail, it will ask the
8236 user whether to re-send the mail.  (This is primarily useful when
8237 dealing with @sc{soup} packets and the like where one is apt to send the
8238 same packet multiple times.)  This variable says what the name of this
8239 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8240 this variable to @code{nil} if you don't want Gnus to keep a history
8241 file.
8242
8243 @item gnus-sent-message-ids-length
8244 @vindex gnus-sent-message-ids-length
8245 This variable says how many @code{Message-ID}s to keep in the history
8246 file.  It is 1000 by default.
8247
8248 @end table
8249
8250
8251 @node Posting Server
8252 @section Posting Server
8253
8254 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8255 (extremely intelligent, of course) article, where does it go?
8256
8257 Thank you for asking.  I hate you.
8258
8259 @vindex gnus-post-method
8260
8261 It can be quite complicated.  Normally, Gnus will use the same native
8262 server.  However.  If your native server doesn't allow posting, just
8263 reading, you probably want to use some other server to post your
8264 (extremely intelligent and fabulously interesting) articles.  You can
8265 then set the @code{gnus-post-method} to some other method:
8266
8267 @lisp
8268 (setq gnus-post-method '(nnspool ""))
8269 @end lisp
8270
8271 Now, if you've done this, and then this server rejects your article, or
8272 this server is down, what do you do then?  To override this variable you
8273 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8274 the ``current'' server for posting.
8275
8276 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8277 Gnus will prompt you for what method to use for posting.
8278
8279 You can also set @code{gnus-post-method} to a list of select methods.
8280 If that's the case, Gnus will always prompt you for what method to use
8281 for posting.
8282
8283 Finally, if you want to always post using the same select method as
8284 you're reading from (which might be convenient if you're reading lots of
8285 groups from different private servers), you can set this variable to
8286 @code{current}. 
8287
8288
8289 @node Mail and Post
8290 @section Mail and Post
8291
8292 Here's a list of variables relevant to both mailing and
8293 posting:
8294
8295 @table @code
8296 @item gnus-mailing-list-groups
8297 @findex gnus-mailing-list-groups
8298 @cindex mailing lists
8299
8300 If your news server offers groups that are really mailing lists
8301 gatewayed to the @sc{nntp} server, you can read those groups without
8302 problems, but you can't post/followup to them without some difficulty.
8303 One solution is to add a @code{to-address} to the group parameters
8304 (@pxref{Group Parameters}).  An easier thing to do is set the
8305 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8306 really are mailing lists.  Then, at least, followups to the mailing
8307 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8308 still a pain, though.
8309
8310 @end table
8311
8312 You may want to do spell-checking on messages that you send out.  Or, if
8313 you don't want to spell-check by hand, you could add automatic
8314 spell-checking via the @code{ispell} package:
8315
8316 @cindex ispell
8317 @findex ispell-message
8318 @lisp
8319 (add-hook 'message-send-hook 'ispell-message)
8320 @end lisp
8321
8322
8323 @node Archived Messages
8324 @section Archived Messages
8325 @cindex archived messages
8326 @cindex sent messages
8327
8328 Gnus provides a few different methods for storing the mail and news you
8329 send.  The default method is to use the @dfn{archive virtual server} to
8330 store the messages.  If you want to disable this completely, the
8331 @code{gnus-message-archive-group} variable should be @code{nil}, which
8332 is the default.
8333
8334 @vindex gnus-message-archive-method
8335 @code{gnus-message-archive-method} says what virtual server Gnus is to
8336 use to store sent messages.  The default is:
8337
8338 @lisp
8339 (nnfolder "archive"
8340           (nnfolder-directory   "~/Mail/archive")
8341           (nnfolder-active-file "~/Mail/archive/active")
8342           (nnfolder-get-new-mail nil)
8343           (nnfolder-inhibit-expiry t))
8344 @end lisp
8345
8346 You can, however, use any mail select method (@code{nnml},
8347 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8348 for doing this sort of thing, though.  If you don't like the default
8349 directory chosen, you could say something like:
8350
8351 @lisp
8352 (setq gnus-message-archive-method
8353       '(nnfolder "archive"
8354                  (nnfolder-inhibit-expiry t)
8355                  (nnfolder-active-file "~/News/sent-mail/active")
8356                  (nnfolder-directory "~/News/sent-mail/")))
8357 @end lisp
8358
8359 @vindex gnus-message-archive-group
8360 @cindex Gcc
8361 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8362 to one or more group(s) on that server.  Which group to use is
8363 determined by the @code{gnus-message-archive-group} variable.
8364
8365 This variable can be used to do the following:
8366
8367 @itemize @bullet
8368 @item a string
8369 Messages will be saved in that group.
8370 @item a list of strings
8371 Messages will be saved in all those groups.
8372 @item an alist of regexps, functions and forms
8373 When a key ``matches'', the result is used.
8374 @item @code{nil}
8375 No message archiving will take place.  This is the default.
8376 @end itemize
8377
8378 Let's illustrate:
8379
8380 Just saving to a single group called @samp{MisK}:
8381 @lisp
8382 (setq gnus-message-archive-group "MisK")
8383 @end lisp
8384
8385 Saving to two groups, @samp{MisK} and @samp{safe}:
8386 @lisp
8387 (setq gnus-message-archive-group '("MisK" "safe"))
8388 @end lisp
8389
8390 Save to different groups based on what group you are in:
8391 @lisp
8392 (setq gnus-message-archive-group
8393       '(("^alt" "sent-to-alt")
8394         ("mail" "sent-to-mail")
8395         (".*" "sent-to-misc")))
8396 @end lisp
8397
8398 More complex stuff:
8399 @lisp
8400 (setq gnus-message-archive-group
8401       '((if (message-news-p)
8402             "misc-news"
8403           "misc-mail")))
8404 @end lisp
8405
8406 How about storing all news messages in one file, but storing all mail
8407 messages in one file per month:
8408
8409 @lisp
8410 (setq gnus-message-archive-group
8411       '((if (message-news-p)
8412             "misc-news"
8413           (concat "mail." (format-time-string
8414                            "%Y-%m" (current-time))))))
8415 @end lisp
8416
8417 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8418 use a different value for @code{gnus-message-archive-group} there.)
8419
8420 Now, when you send a message off, it will be stored in the appropriate
8421 group.  (If you want to disable storing for just one particular message,
8422 you can just remove the @code{Gcc} header that has been inserted.)  The
8423 archive group will appear in the group buffer the next time you start
8424 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
8425 enter it and read the articles in it just like you'd read any other
8426 group.  If the group gets really big and annoying, you can simply rename
8427 if (using @kbd{G r} in the group buffer) to something
8428 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8429 continue to be stored in the old (now empty) group.
8430
8431 That's the default method of archiving sent messages.  Gnus offers a
8432 different way for the people who don't like the default method.  In that
8433 case you should set @code{gnus-message-archive-group} to @code{nil};
8434 this will disable archiving.
8435
8436 @table @code
8437 @item gnus-outgoing-message-group
8438 @vindex gnus-outgoing-message-group
8439 All outgoing messages will be put in this group.  If you want to store
8440 all your outgoing mail and articles in the group @samp{nnml:archive},
8441 you set this variable to that value.  This variable can also be a list of
8442 group names.
8443
8444 If you want to have greater control over what group to put each
8445 message in, you can set this variable to a function that checks the
8446 current newsgroup name and then returns a suitable group name (or list
8447 of names).
8448
8449 This variable can be used instead of @code{gnus-message-archive-group},
8450 but the latter is the preferred method.
8451 @end table
8452
8453
8454 @node Posting Styles
8455 @section Posting Styles
8456 @cindex posting styles
8457 @cindex styles
8458
8459 All them variables, they make my head swim.
8460
8461 So what if you want a different @code{Organization} and signature based
8462 on what groups you post to?  And you post both from your home machine
8463 and your work machine, and you want different @code{From} lines, and so
8464 on?
8465
8466 @vindex gnus-posting-styles
8467 One way to do stuff like that is to write clever hooks that change the
8468 variables you need to have changed.  That's a bit boring, so somebody
8469 came up with the bright idea of letting the user specify these things in
8470 a handy alist.  Here's an example of a @code{gnus-posting-styles}
8471 variable:
8472
8473 @lisp
8474 ((".*"
8475   (signature "Peace and happiness")
8476   (organization "What me?"))
8477  ("^comp"
8478   (signature "Death to everybody"))
8479  ("comp.emacs.i-love-it"
8480   (organization "Emacs is it")))
8481 @end lisp
8482
8483 As you might surmise from this example, this alist consists of several
8484 @dfn{styles}.  Each style will be applicable if the first element
8485 ``matches'', in some form or other.  The entire alist will be iterated
8486 over, from the beginning towards the end, and each match will be
8487 applied, which means that attributes in later styles that match override
8488 the same attributes in earlier matching styles.  So
8489 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8490 signature and the @samp{What me?} @code{Organization} header.
8491
8492 The first element in each style is called the @code{match}.  If it's a
8493 string, then Gnus will try to regexp match it against the group name.
8494 If it's a function symbol, that function will be called with no
8495 arguments.  If it's a variable symbol, then the variable will be
8496 referenced.  If it's a list, then that list will be @code{eval}ed.  In
8497 any case, if this returns a non-@code{nil} value, then the style is said
8498 to @dfn{match}.
8499
8500 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8501 attribute consists of a @var{(name . value)} pair.  The attribute name
8502 can be one of @code{signature}, @code{signature-file},
8503 @code{organization}, @code{address}, @code{name} or @code{body}.  The
8504 attribute name can also be a string.  In that case, this will be used as
8505 a header name, and the value will be inserted in the headers of the
8506 article.
8507
8508 The attribute value can be a string (used verbatim), a function (the
8509 return value will be used), a variable (its value will be used) or a
8510 list (it will be @code{eval}ed and the return value will be used).
8511
8512 If you wish to check whether the message you are about to compose is
8513 meant to be a news article or a mail message, you can check the values
8514 of the two dynamically bound variables @code{message-this-is-news} and
8515 @code{message-this-is-mail}.
8516
8517 @vindex message-this-is-mail
8518 @vindex message-this-is-news
8519
8520 So here's a new example:
8521
8522 @lisp
8523 (setq gnus-posting-styles
8524       '((".*"
8525          (signature-file "~/.signature")
8526          (name "User Name")
8527          ("X-Home-Page" (getenv "WWW_HOME"))
8528          (organization "People's Front Against MWM"))
8529         ("^rec.humor"
8530          (signature my-funny-signature-randomizer))
8531         ((equal (system-name) "gnarly")
8532          (signature my-quote-randomizer))
8533         (message-this-is-news
8534          (signature my-news-signature))
8535         (posting-from-work-p
8536          (signature-file "~/.work-signature")
8537          (address "user@@bar.foo")
8538          (body "You are fired.\n\nSincerely, your boss.")
8539          (organization "Important Work, Inc"))
8540         ("^nn.+:"
8541          (signature-file "~/.mail-signature"))))
8542 @end lisp
8543
8544
8545 @node Drafts
8546 @section Drafts
8547 @cindex drafts
8548
8549 If you are writing a message (mail or news) and suddenly remember that
8550 you have a steak in the oven (or some pesto in the food processor, you
8551 craaazy vegetarians), you'll probably wish there was a method to save
8552 the message you are writing so that you can continue editing it some
8553 other day, and send it when you feel its finished.
8554
8555 Well, don't worry about it.  Whenever you start composing a message of
8556 some sort using the Gnus mail and post commands, the buffer you get will
8557 automatically associate to an article in a special @dfn{draft} group.
8558 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8559 article will be saved there.  (Auto-save files also go to the draft
8560 group.)
8561
8562 @cindex nndraft
8563 @vindex nndraft-directory
8564 The draft group is a special group (which is implemented as an
8565 @code{nndraft} group, if you absolutely have to know) called
8566 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8567 @code{nndraft} is to store its files.  What makes this group special is
8568 that you can't tick any articles in it or mark any articles as
8569 read---all articles in the group are permanently unread.
8570
8571 If the group doesn't exist, it will be created and you'll be subscribed
8572 to it.  The only way to make it disappear from the Group buffer is to
8573 unsubscribe it.
8574
8575 @c @findex gnus-dissociate-buffer-from-draft
8576 @c @kindex C-c M-d (Mail)
8577 @c @kindex C-c M-d (Post)
8578 @c @findex gnus-associate-buffer-with-draft
8579 @c @kindex C-c C-d (Mail)
8580 @c @kindex C-c C-d (Post)
8581 @c If you're writing some super-secret message that you later want to
8582 @c encode with PGP before sending, you may wish to turn the auto-saving
8583 @c (and association with the draft group) off.  You never know who might be
8584 @c interested in reading all your extremely valuable and terribly horrible
8585 @c and interesting secrets.  The @kbd{C-c M-d}
8586 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8587 @c If you change your mind and want to turn the auto-saving back on again,
8588 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8589 @c
8590 @c @vindex gnus-use-draft
8591 @c To leave association with the draft group off by default, set
8592 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
8593
8594 @findex gnus-draft-edit-message
8595 @kindex D e (Draft)
8596 When you want to continue editing the article, you simply enter the
8597 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8598 that.  You will be placed in a buffer where you left off.
8599
8600 Rejected articles will also be put in this draft group (@pxref{Rejected
8601 Articles}).
8602
8603 @findex gnus-draft-send-all-messages
8604 @findex gnus-draft-send-message
8605 If you have lots of rejected messages you want to post (or mail) without
8606 doing further editing, you can use the @kbd{D s} command
8607 (@code{gnus-draft-send-message}).  This command understands the
8608 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
8609 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8610 in the buffer.
8611
8612 If you have some messages that you wish not to send, you can use the
8613 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8614 as unsendable.  This is a toggling command.
8615
8616
8617 @node Rejected Articles
8618 @section Rejected Articles
8619 @cindex rejected articles
8620
8621 Sometimes a news server will reject an article.  Perhaps the server
8622 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
8623 @emph{there be demons}.  Perhaps you have included too much cited text.
8624 Perhaps the disk is full.  Perhaps the server is down.
8625
8626 These situations are, of course, totally beyond the control of Gnus.
8627 (Gnus, of course, loves the way you look, always feels great, has angels
8628 fluttering around inside of it, doesn't care about how much cited text
8629 you include, never runs full and never goes down.)  So Gnus saves these
8630 articles until some later time when the server feels better.
8631
8632 The rejected articles will automatically be put in a special draft group
8633 (@pxref{Drafts}).  When the server comes back up again, you'd then
8634 typically enter that group and send all the articles off.
8635
8636
8637 @node Select Methods
8638 @chapter Select Methods
8639 @cindex foreign groups
8640 @cindex select methods
8641
8642 A @dfn{foreign group} is a group not read by the usual (or
8643 default) means.  It could be, for instance, a group from a different
8644 @sc{nntp} server, it could be a virtual group, or it could be your own
8645 personal mail group.
8646
8647 A foreign group (or any group, really) is specified by a @dfn{name} and
8648 a @dfn{select method}.  To take the latter first, a select method is a
8649 list where the first element says what backend to use (e.g. @code{nntp},
8650 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8651 name}.  There may be additional elements in the select method, where the
8652 value may have special meaning for the backend in question.
8653
8654 One could say that a select method defines a @dfn{virtual server}---so
8655 we do just that (@pxref{The Server Buffer}).
8656
8657 The @dfn{name} of the group is the name the backend will recognize the
8658 group as.
8659
8660 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8661 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8662 method @code{(nntp "some.where.edu")}.  Gnus will call this group
8663 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8664 backend just knows this group as @samp{soc.motss}.
8665
8666 The different methods all have their peculiarities, of course.
8667
8668 @menu
8669 * The Server Buffer::     Making and editing virtual servers.
8670 * Getting News::          Reading USENET news with Gnus.
8671 * Getting Mail::          Reading your personal mail with Gnus.
8672 * Other Sources::         Reading directories, files, SOUP packets.
8673 * Combined Groups::       Combining groups into one group.
8674 * Gnus Unplugged::        Reading news and mail offline.
8675 @end menu
8676
8677
8678 @node The Server Buffer
8679 @section The Server Buffer
8680
8681 Traditionally, a @dfn{server} is a machine or a piece of software that
8682 one connects to, and then requests information from.  Gnus does not
8683 connect directly to any real servers, but does all transactions through
8684 one backend or other.  But that's just putting one layer more between
8685 the actual media and Gnus, so we might just as well say that each
8686 backend represents a virtual server.
8687
8688 For instance, the @code{nntp} backend may be used to connect to several
8689 different actual @sc{nntp} servers, or, perhaps, to many different ports
8690 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8691 use, and what parameters to set by specifying a @dfn{select method}.
8692
8693 These select method specifications can sometimes become quite
8694 complicated---say, for instance, that you want to read from the
8695 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8696 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8697 Anyways, if you had to specify that for each group that used this
8698 server, that would be too much work, so Gnus offers a way of naming
8699 select methods, which is what you do in the server buffer.
8700
8701 To enter the server buffer, use the @kbd{^}
8702 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8703
8704 @menu
8705 * Server Buffer Format::      You can customize the look of this buffer.
8706 * Server Commands::           Commands to manipulate servers.
8707 * Example Methods::           Examples server specifications.
8708 * Creating a Virtual Server:: An example session.
8709 * Server Variables::          Which variables to set.
8710 * Servers and Methods::       You can use server names as select methods.
8711 * Unavailable Servers::       Some servers you try to contact may be down.
8712 @end menu
8713
8714 @vindex gnus-server-mode-hook
8715 @code{gnus-server-mode-hook} is run when creating the server buffer.
8716
8717
8718 @node Server Buffer Format
8719 @subsection Server Buffer Format
8720 @cindex server buffer format
8721
8722 @vindex gnus-server-line-format
8723 You can change the look of the server buffer lines by changing the
8724 @code{gnus-server-line-format} variable.  This is a @code{format}-like
8725 variable, with some simple extensions:
8726
8727 @table @samp
8728
8729 @item h
8730 How the news is fetched---the backend name.
8731
8732 @item n
8733 The name of this server.
8734
8735 @item w
8736 Where the news is to be fetched from---the address.
8737
8738 @item s
8739 The opened/closed/denied status of the server.
8740 @end table
8741
8742 @vindex gnus-server-mode-line-format
8743 The mode line can also be customized by using the
8744 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
8745 Formatting}).  The following specs are understood:
8746
8747 @table @samp
8748 @item S
8749 Server name.
8750
8751 @item M
8752 Server method.
8753 @end table
8754
8755 Also @pxref{Formatting Variables}.
8756
8757
8758 @node Server Commands
8759 @subsection Server Commands
8760 @cindex server commands
8761
8762 @table @kbd
8763
8764 @item a
8765 @kindex a (Server)
8766 @findex gnus-server-add-server
8767 Add a new server (@code{gnus-server-add-server}).
8768
8769 @item e
8770 @kindex e (Server)
8771 @findex gnus-server-edit-server
8772 Edit a server (@code{gnus-server-edit-server}).
8773
8774 @item SPACE
8775 @kindex SPACE (Server)
8776 @findex gnus-server-read-server
8777 Browse the current server (@code{gnus-server-read-server}).
8778
8779 @item q
8780 @kindex q (Server)
8781 @findex gnus-server-exit
8782 Return to the group buffer (@code{gnus-server-exit}).
8783
8784 @item k
8785 @kindex k (Server)
8786 @findex gnus-server-kill-server
8787 Kill the current server (@code{gnus-server-kill-server}).
8788
8789 @item y
8790 @kindex y (Server)
8791 @findex gnus-server-yank-server
8792 Yank the previously killed server (@code{gnus-server-yank-server}).
8793
8794 @item c
8795 @kindex c (Server)
8796 @findex gnus-server-copy-server
8797 Copy the current server (@code{gnus-server-copy-server}).
8798
8799 @item l
8800 @kindex l (Server)
8801 @findex gnus-server-list-servers
8802 List all servers (@code{gnus-server-list-servers}).
8803
8804 @item s
8805 @kindex s (Server)
8806 @findex gnus-server-scan-server
8807 Request that the server scan its sources for new articles
8808 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8809 servers.
8810
8811 @item g
8812 @kindex g (Server)
8813 @findex gnus-server-regenerate-server
8814 Request that the server regenerate all its data structures
8815 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8816 a mail backend that has gotten out of synch.
8817
8818 @end table
8819
8820
8821 @node Example Methods
8822 @subsection Example Methods
8823
8824 Most select methods are pretty simple and self-explanatory:
8825
8826 @lisp
8827 (nntp "news.funet.fi")
8828 @end lisp
8829
8830 Reading directly from the spool is even simpler:
8831
8832 @lisp
8833 (nnspool "")
8834 @end lisp
8835
8836 As you can see, the first element in a select method is the name of the
8837 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8838 will.
8839
8840 After these two elements, there may be an arbitrary number of
8841 @var{(variable form)} pairs.
8842
8843 To go back to the first example---imagine that you want to read from
8844 port 15 on that machine.  This is what the select method should
8845 look like then:
8846
8847 @lisp
8848 (nntp "news.funet.fi" (nntp-port-number 15))
8849 @end lisp
8850
8851 You should read the documentation to each backend to find out what
8852 variables are relevant, but here's an @code{nnmh} example:
8853
8854 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8855 you have two structures that you wish to access: One is your private
8856 mail spool, and the other is a public one.  Here's the possible spec for
8857 your private mail:
8858
8859 @lisp
8860 (nnmh "private" (nnmh-directory "~/private/mail/"))
8861 @end lisp
8862
8863 (This server is then called @samp{private}, but you may have guessed
8864 that.)
8865
8866 Here's the method for a public spool:
8867
8868 @lisp
8869 (nnmh "public"
8870       (nnmh-directory "/usr/information/spool/")
8871       (nnmh-get-new-mail nil))
8872 @end lisp
8873
8874 If you are behind a firewall and only have access to the @sc{nntp}
8875 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8876 on the firewall machine and telnet from there to the @sc{nntp} server.
8877 Doing this can be rather fiddly, but your virtual server definition
8878 should probably look something like this:
8879
8880 @lisp
8881 (nntp "firewall"
8882       (nntp-address "the.firewall.machine")
8883       (nntp-open-connection-function nntp-open-rlogin)
8884       (nntp-end-of-line "\n")
8885       (nntp-rlogin-parameters
8886        ("telnet" "the.real.nntp.host" "nntp")))
8887 @end lisp
8888
8889 If you want to use the wonderful @code{ssh} program to provide a
8890 compressed connection over the modem line, you could create a virtual
8891 server that would look something like this:
8892
8893 @lisp
8894 (nntp "news"
8895        (nntp-address "copper.uio.no")
8896        (nntp-rlogin-program "ssh")
8897        (nntp-open-connection-function nntp-open-rlogin)
8898        (nntp-end-of-line "\n")
8899        (nntp-rlogin-parameters
8900         ("telnet" "news.uio.no" "nntp")))
8901 @end lisp
8902
8903 This means that you have to have set up @code{ssh-agent} correctly to
8904 provide automatic authorization, of course.  And to get a compressed
8905 connection, you have to have the @samp{Compression} option in the
8906 @code{ssh} @file{config} file.
8907
8908
8909 @node Creating a Virtual Server
8910 @subsection Creating a Virtual Server
8911
8912 If you're saving lots of articles in the cache by using persistent
8913 articles, you may want to create a virtual server to read the cache.
8914
8915 First you need to add a new server.  The @kbd{a} command does that.  It
8916 would probably be best to use @code{nnspool} to read the cache.  You
8917 could also use @code{nnml} or @code{nnmh}, though.
8918
8919 Type @kbd{a nnspool RET cache RET}.
8920
8921 You should now have a brand new @code{nnspool} virtual server called
8922 @samp{cache}.  You now need to edit it to have the right definitions.
8923 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8924 will contain the following:
8925
8926 @lisp
8927 (nnspool "cache")
8928 @end lisp
8929
8930 Change that to:
8931
8932 @lisp
8933 (nnspool "cache"
8934          (nnspool-spool-directory "~/News/cache/")
8935          (nnspool-nov-directory "~/News/cache/")
8936          (nnspool-active-file "~/News/cache/active"))
8937 @end lisp
8938
8939 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8940 @kbd{RET} over this virtual server, you should be entered into a browse
8941 buffer, and you should be able to enter any of the groups displayed.
8942
8943
8944 @node Server Variables
8945 @subsection Server Variables
8946
8947 One sticky point when defining variables (both on backends and in Emacs
8948 in general) is that some variables are typically initialized from other
8949 variables when the definition of the variables is being loaded.  If you
8950 change the "base" variable after the variables have been loaded, you
8951 won't change the "derived" variables.
8952
8953 This typically affects directory and file variables.  For instance,
8954 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8955 directory variables are initialized from that variable, so
8956 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8957 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8958 @code{nnml-directory}---you have to explicitly set all the file
8959 variables to be what you want them to be.  For a complete list of
8960 variables for each backend, see each backend's section later in this
8961 manual, but here's an example @code{nnml} definition:
8962
8963 @lisp
8964 (nnml "public"
8965       (nnml-directory "~/my-mail/")
8966       (nnml-active-file "~/my-mail/active")
8967       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8968 @end lisp
8969
8970
8971 @node Servers and Methods
8972 @subsection Servers and Methods
8973
8974 Wherever you would normally use a select method
8975 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8976 when browsing a foreign server) you can use a virtual server name
8977 instead.  This could potentially save lots of typing.  And it's nice all
8978 over.
8979
8980
8981 @node Unavailable Servers
8982 @subsection Unavailable Servers
8983
8984 If a server seems to be unreachable, Gnus will mark that server as
8985 @code{denied}.  That means that any subsequent attempt to make contact
8986 with that server will just be ignored.  ``It can't be opened,'' Gnus
8987 will tell you, without making the least effort to see whether that is
8988 actually the case or not.
8989
8990 That might seem quite naughty, but it does make sense most of the time.
8991 Let's say you have 10 groups subscribed to on server
8992 @samp{nephelococcygia.com}.  This server is located somewhere quite far
8993 away from you and the machine is quite slow, so it takes 1 minute just
8994 to find out that it refuses connection to you today.  If Gnus were to
8995 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8996 attempt to do that.  Once it has gotten a single ``connection refused'',
8997 it will regard that server as ``down''.
8998
8999 So, what happens if the machine was only feeling unwell temporarily?
9000 How do you test to see whether the machine has come up again?
9001
9002 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9003 with the following commands:
9004
9005 @table @kbd
9006
9007 @item O
9008 @kindex O (Server)
9009 @findex gnus-server-open-server
9010 Try to establish connection to the server on the current line
9011 (@code{gnus-server-open-server}).
9012
9013 @item C
9014 @kindex C (Server)
9015 @findex gnus-server-close-server
9016 Close the connection (if any) to the server
9017 (@code{gnus-server-close-server}).
9018
9019 @item D
9020 @kindex D (Server)
9021 @findex gnus-server-deny-server
9022 Mark the current server as unreachable
9023 (@code{gnus-server-deny-server}).
9024
9025 @item M-o
9026 @kindex M-o (Server)
9027 @findex gnus-server-open-all-servers
9028 Open the connections to all servers in the buffer
9029 (@code{gnus-server-open-all-servers}).
9030
9031 @item M-c
9032 @kindex M-c (Server)
9033 @findex gnus-server-close-all-servers
9034 Close the connections to all servers in the buffer
9035 (@code{gnus-server-close-all-servers}).
9036
9037 @item R
9038 @kindex R (Server)
9039 @findex gnus-server-remove-denials
9040 Remove all marks to whether Gnus was denied connection from any servers
9041 (@code{gnus-server-remove-denials}).
9042
9043 @end table
9044
9045
9046 @node Getting News
9047 @section Getting News
9048 @cindex reading news
9049 @cindex news backends
9050
9051 A newsreader is normally used for reading news.  Gnus currently provides
9052 only two methods of getting news---it can read from an @sc{nntp} server,
9053 or it can read from a local spool.
9054
9055 @menu
9056 * NNTP::               Reading news from an @sc{nntp} server.
9057 * News Spool::         Reading news from the local spool.
9058 @end menu
9059
9060
9061 @node NNTP
9062 @subsection @sc{nntp}
9063 @cindex nntp
9064
9065 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9066 You just specify @code{nntp} as method and the address of the @sc{nntp}
9067 server as the, uhm, address.
9068
9069 If the @sc{nntp} server is located at a non-standard port, setting the
9070 third element of the select method to this port number should allow you
9071 to connect to the right port.  You'll have to edit the group info for
9072 that (@pxref{Foreign Groups}).
9073
9074 The name of the foreign group can be the same as a native group.  In
9075 fact, you can subscribe to the same group from as many different servers
9076 you feel like.  There will be no name collisions.
9077
9078 The following variables can be used to create a virtual @code{nntp}
9079 server:
9080
9081 @table @code
9082
9083 @item nntp-server-opened-hook
9084 @vindex nntp-server-opened-hook
9085 @cindex @sc{mode reader}
9086 @cindex authinfo
9087 @cindex authentification
9088 @cindex nntp authentification
9089 @findex nntp-send-authinfo
9090 @findex nntp-send-mode-reader
9091 is run after a connection has been made.  It can be used to send
9092 commands to the @sc{nntp} server after it has been contacted.  By
9093 default it sends the command @code{MODE READER} to the server with the
9094 @code{nntp-send-mode-reader} function.  This function should always be
9095 present in this hook.
9096
9097 @item nntp-authinfo-function
9098 @vindex nntp-authinfo-function
9099 @findex nntp-send-authinfo
9100 @vindex nntp-authinfo-file
9101 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9102 server.  The default function is @code{nntp-send-authinfo}, which looks
9103 through your @file{~/.authinfo} (or whatever you've set the
9104 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
9105 are found, it will prompt you for a login name and a password.  The
9106 format of the @file{~/.authinfo} file is (almost) the same as the
9107 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9108 manual page, but here are the salient facts:
9109
9110 @enumerate
9111 @item
9112 The file contains one or more line, each of which define one server.
9113
9114 @item
9115 Each line may contain an arbitrary number of token/value pairs.  The
9116 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9117 @samp{default} and @samp{force}.  (The latter is not a valid
9118 @file{.netrc}/@code{ftp} token, which is the only way the
9119 @file{.authinfo} file format deviates from the @file{.netrc} file
9120 format.)
9121
9122 @end enumerate
9123
9124 Here's an example file:
9125
9126 @example
9127 machine news.uio.no login larsi password geheimnis
9128 machine nntp.ifi.uio.no login larsi force yes
9129 @end example
9130
9131 The token/value pairs may appear in any order; @samp{machine} doesn't
9132 have to be first, for instance.
9133
9134 In this example, both login name and password have been supplied for the
9135 former server, while the latter has only the login name listed, and the
9136 user will be prompted for the password.  The latter also has the
9137 @samp{force} tag, which means that the authinfo will be sent to the
9138 @var{nntp} server upon connection; the default (i.e., when there is not
9139 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9140 until the @var{nntp} server asks for it.
9141
9142 You can also add @samp{default} lines that will apply to all servers
9143 that don't have matching @samp{machine} lines.
9144
9145 @example
9146 default force yes
9147 @end example
9148
9149 This will force sending @samp{AUTHINFO} commands to all servers not
9150 previously mentioned.
9151
9152 Remember to not leave the @file{~/.authinfo} file world-readable.
9153
9154 @item nntp-server-action-alist
9155 @vindex nntp-server-action-alist
9156 This is a list of regexps to match on server types and actions to be
9157 taken when matches are made.  For instance, if you want Gnus to beep
9158 every time you connect to innd, you could say something like:
9159
9160 @lisp
9161 (setq nntp-server-action-alist
9162       '(("innd" (ding))))
9163 @end lisp
9164
9165 You probably don't want to do that, though.
9166
9167 The default value is
9168
9169 @lisp
9170 '(("nntpd 1\\.5\\.11t"
9171    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9172 @end lisp
9173
9174 This ensures that Gnus doesn't send the @code{MODE READER} command to
9175 nntpd 1.5.11t, since that command chokes that server, I've been told.
9176
9177 @item nntp-maximum-request
9178 @vindex nntp-maximum-request
9179 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9180 will collect headers by sending a series of @code{head} commands.  To
9181 speed things up, the backend sends lots of these commands without
9182 waiting for reply, and then reads all the replies.  This is controlled
9183 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
9184 your network is buggy, you should set this to 1.
9185
9186 @item nntp-connection-timeout
9187 @vindex nntp-connection-timeout
9188 If you have lots of foreign @code{nntp} groups that you connect to
9189 regularly, you're sure to have problems with @sc{nntp} servers not
9190 responding properly, or being too loaded to reply within reasonable
9191 time.  This is can lead to awkward problems, which can be helped
9192 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
9193 that says how many seconds the @code{nntp} backend should wait for a
9194 connection before giving up.  If it is @code{nil}, which is the default,
9195 no timeouts are done.
9196
9197 @c @item nntp-command-timeout
9198 @c @vindex nntp-command-timeout
9199 @c @cindex PPP connections
9200 @c @cindex dynamic IP addresses
9201 @c If you're running Gnus on a machine that has a dynamically assigned
9202 @c address, Gnus may become confused.  If the address of your machine
9203 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9204 @c waiting forever for replies from the server.  To help with this
9205 @c unfortunate problem, you can set this command to a number.  Gnus will
9206 @c then, if it sits waiting for a reply from the server longer than that
9207 @c number of seconds, shut down the connection, start a new one, and resend
9208 @c the command.  This should hopefully be transparent to the user.  A
9209 @c likely number is 30 seconds.
9210 @c
9211 @c @item nntp-retry-on-break
9212 @c @vindex nntp-retry-on-break
9213 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9214 @c hangs.  This will have much the same effect as the command timeout
9215 @c described above.
9216
9217 @item nntp-server-hook
9218 @vindex nntp-server-hook
9219 This hook is run as the last step when connecting to an @sc{nntp}
9220 server.
9221
9222 @findex nntp-open-rlogin
9223 @findex nntp-open-telnet
9224 @findex nntp-open-network-stream
9225 @item nntp-open-connection-function
9226 @vindex nntp-open-connection-function
9227 This function is used to connect to the remote system.  Four pre-made
9228 functions are supplied:
9229
9230 @table @code
9231 @item nntp-open-network-stream
9232 This is the default, and simply connects to some port or other on the
9233 remote system.
9234
9235 @item nntp-open-rlogin
9236 Does an @samp{rlogin} on the
9237 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9238 available there.
9239
9240 @code{nntp-open-rlogin}-related variables:
9241
9242 @table @code
9243
9244 @item nntp-rlogin-program
9245 @vindex nntp-rlogin-program
9246 Program used to log in on remote machines.  The default is @samp{rsh},
9247 but @samp{ssh} is a popular alternative.
9248
9249 @item nntp-rlogin-parameters
9250 @vindex nntp-rlogin-parameters
9251 This list will be used as the parameter list given to @code{rsh}.
9252
9253 @item nntp-rlogin-user-name
9254 @vindex nntp-rlogin-user-name
9255 User name on the remote system.
9256
9257 @end table
9258
9259 @item nntp-open-telnet
9260 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9261 to get to the @sc{nntp} server.
9262
9263 @code{nntp-open-telnet}-related variables:
9264
9265 @table @code
9266 @item nntp-telnet-command
9267 @vindex nntp-telnet-command
9268 Command used to start @code{telnet}.
9269
9270 @item nntp-telnet-switches
9271 @vindex nntp-telnet-switches
9272 List of strings to be used as the switches to the @code{telnet} command.
9273
9274 @item nntp-telnet-user-name
9275 @vindex nntp-telnet-user-name
9276 User name for log in on the remote system.
9277
9278 @item nntp-telnet-passwd
9279 @vindex nntp-telnet-passwd
9280 Password to use when logging in.
9281
9282 @item nntp-telnet-parameters
9283 @vindex nntp-telnet-parameters
9284 A list of strings executed as a command after logging in
9285 via @code{telnet}.
9286
9287 @item nntp-telnet-shell-prompt
9288 @vindex nntp-telnet-shell-prompt
9289 Regexp matching the shell prompt on the remote machine.  The default is
9290 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9291
9292 @item nntp-open-telnet-envuser
9293 @vindex nntp-open-telnet-envuser
9294 If non-@code{nil}, the @code{telnet} session (client and server both)
9295 will support the @code{ENVIRON} option and not prompt for login name.
9296 This works for Solaris @code{telnet}, for instance.
9297
9298 @end table
9299
9300 @findex nntp-open-ssl-stream
9301 @item nntp-open-ssl-stream
9302 Opens a connection to a server over a @dfn{secure} channel.  To use this
9303 you must have SSLay installed
9304 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9305 @file{ssl.el} (from the W3 distributeion, for instance).  You then
9306 define a server as follows:
9307
9308 @lisp
9309 ;; Type `C-c C-c' after you've finished editing.
9310 ;;
9311 ;; "snews" is port 563 and is predefined in our /etc/services
9312 ;;
9313 (nntp "snews.bar.com"
9314       (nntp-open-connection-function nntp-open-ssl-stream)
9315       (nntp-port-number "snews")
9316       (nntp-address "snews.bar.com"))
9317 @end lisp
9318
9319 @end table
9320
9321 @item nntp-end-of-line
9322 @vindex nntp-end-of-line
9323 String to use as end-of-line marker when talking to the @sc{nntp}
9324 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9325 using @code{rlogin} to talk to the server.
9326
9327 @item nntp-rlogin-user-name
9328 @vindex nntp-rlogin-user-name
9329 User name on the remote system when using the @code{rlogin} connect
9330 function.
9331
9332 @item nntp-address
9333 @vindex nntp-address
9334 The address of the remote system running the @sc{nntp} server.
9335
9336 @item nntp-port-number
9337 @vindex nntp-port-number
9338 Port number to connect to when using the @code{nntp-open-network-stream}
9339 connect function.
9340
9341 @item nntp-buggy-select
9342 @vindex nntp-buggy-select
9343 Set this to non-@code{nil} if your select routine is buggy.
9344
9345 @item nntp-nov-is-evil
9346 @vindex nntp-nov-is-evil
9347 If the @sc{nntp} server does not support @sc{nov}, you could set this
9348 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9349 can be used.
9350
9351 @item nntp-xover-commands
9352 @vindex nntp-xover-commands
9353 @cindex nov
9354 @cindex XOVER
9355 List of strings used as commands to fetch @sc{nov} lines from a
9356 server.  The default value of this variable is @code{("XOVER"
9357 "XOVERVIEW")}.
9358
9359 @item nntp-nov-gap
9360 @vindex nntp-nov-gap
9361 @code{nntp} normally sends just one big request for @sc{nov} lines to
9362 the server.  The server responds with one huge list of lines.  However,
9363 if you have read articles 2-5000 in the group, and only want to read
9364 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9365 lines that you will not need.  This variable says how
9366 big a gap between two consecutive articles is allowed to be before the
9367 @code{XOVER} request is split into several request.  Note that if your
9368 network is fast, setting this variable to a really small number means
9369 that fetching will probably be slower.  If this variable is @code{nil},
9370 @code{nntp} will never split requests.  The default is 5.
9371
9372 @item nntp-prepare-server-hook
9373 @vindex nntp-prepare-server-hook
9374 A hook run before attempting to connect to an @sc{nntp} server.
9375
9376 @item nntp-warn-about-losing-connection
9377 @vindex nntp-warn-about-losing-connection
9378 If this variable is non-@code{nil}, some noise will be made when a
9379 server closes connection.
9380
9381 @item nntp-record-commands
9382 @vindex nntp-record-commands
9383 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9384 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9385 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
9386 that doesn't seem to work.
9387
9388 @end table
9389
9390
9391 @node News Spool
9392 @subsection News Spool
9393 @cindex nnspool
9394 @cindex news spool
9395
9396 Subscribing to a foreign group from the local spool is extremely easy,
9397 and might be useful, for instance, to speed up reading groups that
9398 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9399 instance.
9400
9401 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9402 anything else) as the address.
9403
9404 If you have access to a local spool, you should probably use that as the
9405 native select method (@pxref{Finding the News}).  It is normally faster
9406 than using an @code{nntp} select method, but might not be.  It depends.
9407 You just have to try to find out what's best at your site.
9408
9409 @table @code
9410
9411 @item nnspool-inews-program
9412 @vindex nnspool-inews-program
9413 Program used to post an article.
9414
9415 @item nnspool-inews-switches
9416 @vindex nnspool-inews-switches
9417 Parameters given to the inews program when posting an article.
9418
9419 @item nnspool-spool-directory
9420 @vindex nnspool-spool-directory
9421 Where @code{nnspool} looks for the articles.  This is normally
9422 @file{/usr/spool/news/}.
9423
9424 @item nnspool-nov-directory
9425 @vindex nnspool-nov-directory
9426 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9427 @file{/usr/spool/news/over.view/}.
9428
9429 @item nnspool-lib-dir
9430 @vindex nnspool-lib-dir
9431 Where the news lib dir is (@file{/usr/lib/news/} by default).
9432
9433 @item nnspool-active-file
9434 @vindex nnspool-active-file
9435 The path to the active file.
9436
9437 @item nnspool-newsgroups-file
9438 @vindex nnspool-newsgroups-file
9439 The path to the group descriptions file.
9440
9441 @item nnspool-history-file
9442 @vindex nnspool-history-file
9443 The path to the news history file.
9444
9445 @item nnspool-active-times-file
9446 @vindex nnspool-active-times-file
9447 The path to the active date file.
9448
9449 @item nnspool-nov-is-evil
9450 @vindex nnspool-nov-is-evil
9451 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9452 that it finds.
9453
9454 @item nnspool-sift-nov-with-sed
9455 @vindex nnspool-sift-nov-with-sed
9456 @cindex sed
9457 If non-@code{nil}, which is the default, use @code{sed} to get the
9458 relevant portion from the overview file.  If nil, @code{nnspool} will
9459 load the entire file into a buffer and process it there.
9460
9461 @end table
9462
9463
9464 @node Getting Mail
9465 @section Getting Mail
9466 @cindex reading mail
9467 @cindex mail
9468
9469 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9470 course.
9471
9472 @menu
9473 * Getting Started Reading Mail:: A simple cookbook example.
9474 * Splitting Mail::               How to create mail groups.
9475 * Mail Backend Variables::       Variables for customizing mail handling.
9476 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9477 * Mail and Procmail::            Reading mail groups that procmail create.
9478 * Incorporating Old Mail::       What about the old mail you have?
9479 * Expiring Mail::                Getting rid of unwanted mail.
9480 * Washing Mail::                 Removing gruft from the mail you get.
9481 * Duplicates::                   Dealing with duplicated mail.
9482 * Not Reading Mail::             Using mail backends for reading other files.
9483 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9484 @end menu
9485
9486
9487 @node Getting Started Reading Mail
9488 @subsection Getting Started Reading Mail
9489
9490 It's quite easy to use Gnus to read your new mail.  You just plonk the
9491 mail backend of your choice into @code{gnus-secondary-select-methods},
9492 and things will happen automatically.
9493
9494 For instance, if you want to use @code{nnml} (which is a "one file per
9495 mail" backend), you could put the following in your @file{.gnus} file:
9496
9497 @lisp
9498 (setq gnus-secondary-select-methods
9499       '((nnml "private")))
9500 @end lisp
9501
9502 Now, the next time you start Gnus, this backend will be queried for new
9503 articles, and it will move all the messages in your spool file to its
9504 directory, which is @code{~/Mail/} by default.  The new group that will
9505 be created (@samp{mail.misc}) will be subscribed, and you can read it
9506 like any other group.
9507
9508 You will probably want to split the mail into several groups, though:
9509
9510 @lisp
9511 (setq nnmail-split-methods
9512       '(("junk" "^From:.*Lars Ingebrigtsen")
9513         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9514         ("other" "")))
9515 @end lisp
9516
9517 This will result in three new @code{nnml} mail groups being created:
9518 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
9519 mail that doesn't fit into the first two groups will be placed in the
9520 last group.
9521
9522 This should be sufficient for reading mail with Gnus.  You might want to
9523 give the other sections in this part of the manual a perusal, though.
9524 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9525
9526
9527 @node Splitting Mail
9528 @subsection Splitting Mail
9529 @cindex splitting mail
9530 @cindex mail splitting
9531
9532 @vindex nnmail-split-methods
9533 The @code{nnmail-split-methods} variable says how the incoming mail is
9534 to be split into groups.
9535
9536 @lisp
9537 (setq nnmail-split-methods
9538   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9539     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9540     ("mail.other" "")))
9541 @end lisp
9542
9543 This variable is a list of lists, where the first element of each of
9544 these lists is the name of the mail group (they do not have to be called
9545 something beginning with @samp{mail}, by the way), and the second
9546 element is a regular expression used on the header of each mail to
9547 determine if it belongs in this mail group.  The first string may
9548 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9549 insert sub-expressions from the matched text.  For instance:
9550
9551 @lisp
9552 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
9553 @end lisp
9554
9555 The second element can also be a function.  In that case, it will be
9556 called narrowed to the headers with the first element of the rule as the
9557 argument.  It should return a non-@code{nil} value if it thinks that the
9558 mail belongs in that group.
9559
9560 The last of these groups should always be a general one, and the regular
9561 expression should @emph{always} be @samp{} so that it matches any mails
9562 that haven't been matched by any of the other regexps.  (These rules are
9563 processed from the beginning of the alist toward the end.  The first
9564 rule to make a match will "win", unless you have crossposting enabled.
9565 In that case, all matching rules will "win".)
9566
9567 If you like to tinker with this yourself, you can set this variable to a
9568 function of your choice.  This function will be called without any
9569 arguments in a buffer narrowed to the headers of an incoming mail
9570 message.  The function should return a list of group names that it
9571 thinks should carry this mail message.
9572
9573 Note that the mail backends are free to maul the poor, innocent,
9574 incoming headers all they want to.  They all add @code{Lines} headers;
9575 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9576 @code{From<SPACE>} line to something else.
9577
9578 @vindex nnmail-crosspost
9579 The mail backends all support cross-posting.  If several regexps match,
9580 the mail will be ``cross-posted'' to all those groups.
9581 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
9582 that no articles are crossposted to the general (@samp{}) group.
9583
9584 @vindex nnmail-crosspost-link-function
9585 @cindex crosspost
9586 @cindex links
9587 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9588 the crossposted articles.  However, not all file systems support hard
9589 links.  If that's the case for you, set
9590 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
9591 variable is @code{add-name-to-file} by default.)
9592
9593 @kindex M-x nnmail-split-history
9594 @kindex nnmail-split-history
9595 If you wish to see where the previous mail split put the messages, you
9596 can use the @kbd{M-x nnmail-split-history} command.
9597
9598 Gnus gives you all the opportunity you could possibly want for shooting
9599 yourself in the foot.  Let's say you create a group that will contain
9600 all the mail you get from your boss.  And then you accidentally
9601 unsubscribe from the group.  Gnus will still put all the mail from your
9602 boss in the unsubscribed group, and so, when your boss mails you ``Have
9603 that report ready by Monday or you're fired!'', you'll never see it and,
9604 come Tuesday, you'll still believe that you're gainfully employed while
9605 you really should be out collecting empty bottles to save up for next
9606 month's rent money.
9607
9608
9609 @node Mail Backend Variables
9610 @subsection Mail Backend Variables
9611
9612 These variables are (for the most part) pertinent to all the various
9613 mail backends.
9614
9615 @table @code
9616 @vindex nnmail-read-incoming-hook
9617 @item nnmail-read-incoming-hook
9618 The mail backends all call this hook after reading new mail.  You can
9619 use this hook to notify any mail watch programs, if you want to.
9620
9621 @vindex nnmail-spool-file
9622 @item nnmail-spool-file
9623 @cindex POP mail
9624 @cindex MAILHOST
9625 @cindex movemail
9626 @vindex nnmail-pop-password
9627 @vindex nnmail-pop-password-required
9628 The backends will look for new mail in this file.  If this variable is
9629 @code{nil}, the mail backends will never attempt to fetch mail by
9630 themselves.  If you are using a POP mail server and your name is
9631 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
9632 your name is not @samp{larsi}, you should probably modify that
9633 slightly, but you may have guessed that already, you smart & handsome
9634 devil!  You can also set this variable to @code{pop}, and Gnus will try
9635 to figure out the POP mail string by itself.  In any case, Gnus will
9636 call @code{movemail} which will contact the POP server named in the
9637 @code{MAILHOST} environment variable.  If the POP server needs a
9638 password, you can either set @code{nnmail-pop-password-required} to
9639 @code{t} and be prompted for the password, or set
9640 @code{nnmail-pop-password} to the password itself.
9641
9642 @code{nnmail-spool-file} can also be a list of mailboxes.
9643
9644 Your Emacs has to have been configured with @samp{--with-pop} before
9645 compilation.  This is the default, but some installations have it
9646 switched off.
9647
9648 When you use a mail backend, Gnus will slurp all your mail from your
9649 inbox and plonk it down in your home directory.  Gnus doesn't move any
9650 mail if you're not using a mail backend---you have to do a lot of magic
9651 invocations first.  At the time when you have finished drawing the
9652 pentagram, lightened the candles, and sacrificed the goat, you really
9653 shouldn't be too surprised when Gnus moves your mail.
9654
9655 @vindex nnmail-use-procmail
9656 @vindex nnmail-procmail-suffix
9657 @item nnmail-use-procmail
9658 If non-@code{nil}, the mail backends will look in
9659 @code{nnmail-procmail-directory} for incoming mail.  All the files in
9660 that directory that have names ending in @code{nnmail-procmail-suffix}
9661 will be considered incoming mailboxes, and will be searched for new
9662 mail.
9663
9664 @vindex nnmail-crash-box
9665 @item nnmail-crash-box
9666 When a mail backend reads a spool file, mail is first moved to this
9667 file, which is @file{~/.gnus-crash-box} by default.  If this file
9668 already exists, it will always be read (and incorporated) before any
9669 other spool files.
9670
9671 @vindex nnmail-split-hook
9672 @item nnmail-split-hook
9673 @findex article-decode-encoded-words
9674 @findex RFC1522 decoding
9675 @findex RFC2047 decoding
9676 Hook run in the buffer where the mail headers of each message is kept
9677 just before the splitting based on these headers is done.  The hook is
9678 free to modify the buffer contents in any way it sees fit---the buffer
9679 is discarded after the splitting has been done, and no changes performed
9680 in the buffer will show up in any files.
9681 @code{gnus-article-decode-encoded-words} is one likely function to add
9682 to this hook.
9683
9684 @vindex nnmail-pre-get-new-mail-hook
9685 @vindex nnmail-post-get-new-mail-hook
9686 @item nnmail-pre-get-new-mail-hook
9687 @itemx nnmail-post-get-new-mail-hook
9688 These are two useful hooks executed when treating new incoming
9689 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9690 starting to handle the new mail) and
9691 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9692 is done).  Here's and example of using these two hooks to change the
9693 default file modes the new mail files get:
9694
9695 @lisp
9696 (add-hook 'gnus-pre-get-new-mail-hook
9697           (lambda () (set-default-file-modes 511)))
9698
9699 (add-hook 'gnus-post-get-new-mail-hook
9700           (lambda () (set-default-file-modes 551)))
9701 @end lisp
9702
9703 @item nnmail-tmp-directory
9704 @vindex nnmail-tmp-directory
9705 This variable says where to move incoming mail to -- while processing
9706 it.  This is usually done in the same directory that the mail backend
9707 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9708 it will be used instead.
9709
9710 @item nnmail-movemail-program
9711 @vindex nnmail-movemail-program
9712 This program is executed to move mail from the user's inbox to her home
9713 directory.  The default is @samp{movemail}.
9714
9715 This can also be a function.  In that case, the function will be called
9716 with two parameters -- the name of the inbox, and the file to be moved
9717 to.
9718
9719 @item nnmail-delete-incoming
9720 @vindex nnmail-delete-incoming
9721 @cindex incoming mail files
9722 @cindex deleting incoming files
9723 If non-@code{nil}, the mail backends will delete the temporary incoming
9724 file after splitting mail into the proper groups.  This is @code{t} by
9725 default.
9726
9727 @c This is @code{nil} by
9728 @c default for reasons of security.
9729
9730 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9731 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9732 lost mail, I think, but that's not the point.  (Except certain versions
9733 of Red Gnus.))  By not deleting the Incoming* files, one can be sure not
9734 to lose mail -- if Gnus totally whacks out, one can always recover what
9735 was lost.
9736
9737 You may delete the @file{Incoming*} files at will.
9738
9739 @item nnmail-use-long-file-names
9740 @vindex nnmail-use-long-file-names
9741 If non-@code{nil}, the mail backends will use long file and directory
9742 names.  Groups like @samp{mail.misc} will end up in directories
9743 (assuming use of @code{nnml} backend) or files (assuming use of
9744 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
9745 the same group will end up in @file{mail/misc}.
9746
9747 @item nnmail-delete-file-function
9748 @vindex nnmail-delete-file-function
9749 @findex delete-file
9750 Function called to delete files.  It is @code{delete-file} by default.
9751
9752 @item nnmail-cache-accepted-message-ids
9753 @vindex nnmail-cache-accepted-message-ids
9754 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9755 the backend (via @code{Gcc}, for instance) into the mail duplication
9756 discovery cache.  The default is @code{nil}.
9757
9758 @end table
9759
9760
9761 @node Fancy Mail Splitting
9762 @subsection Fancy Mail Splitting
9763 @cindex mail splitting
9764 @cindex fancy mail splitting
9765
9766 @vindex nnmail-split-fancy
9767 @findex nnmail-split-fancy
9768 If the rather simple, standard method for specifying how to split mail
9769 doesn't allow you to do what you want, you can set
9770 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
9771 play with the @code{nnmail-split-fancy} variable.
9772
9773 Let's look at an example value of this variable first:
9774
9775 @lisp
9776 ;; Messages from the mailer daemon are not crossposted to any of
9777 ;; the ordinary groups.  Warnings are put in a separate group
9778 ;; from real errors.
9779 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9780                    "mail.misc"))
9781    ;; Non-error messages are crossposted to all relevant
9782    ;; groups, but we don't crosspost between the group for the
9783    ;; (ding) list and the group for other (ding) related mail.
9784    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9785          ("subject" "ding" "ding.misc"))
9786       ;; Other mailing lists...
9787       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9788       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9789       ;; People...
9790       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9791    ;; Unmatched mail goes to the catch all group.
9792    "misc.misc")
9793 @end lisp
9794
9795 This variable has the format of a @dfn{split}.  A split is a (possibly)
9796 recursive structure where each split may contain other splits.  Here are
9797 the five possible split syntaxes:
9798
9799 @enumerate
9800
9801 @item
9802 @samp{group}: If the split is a string, that will be taken as a group
9803 name.  Normal regexp match expansion will be done.  See below for
9804 examples. 
9805
9806 @item
9807 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
9808 which is a string, then store the message as specified by SPLIT, if
9809 header FIELD (a regexp) contains VALUE (also a regexp).
9810
9811 @item
9812 @var{(| SPLIT...)}: If the split is a list, and the first element is
9813 @code{|} (vertical bar), then process each SPLIT until one of them
9814 matches.  A SPLIT is said to match if it will cause the mail message to
9815 be stored in one or more groups.
9816
9817 @item
9818 @var{(& SPLIT...)}: If the split is a list, and the first element is
9819 @code{&}, then process all SPLITs in the list.
9820
9821 @item
9822 @code{junk}: If the split is the symbol @code{junk}, then don't save
9823 this message. Use with extreme caution.
9824
9825 @item
9826 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
9827 element is @code{:}, then the second element will be called as a
9828 function with @var{args} given as arguments.  The function should return
9829 a SPLIT.
9830
9831 @item
9832 @code{nil}: If the split is @code{nil}, it is ignored.
9833
9834 @end enumerate
9835
9836 In these splits, @var{FIELD} must match a complete field name.
9837 @var{VALUE} must match a complete word according to the fundamental mode
9838 syntax table.  You can use @code{.*} in the regexps to match partial
9839 field names or words.  In other words, all @var{VALUE}'s are wrapped in
9840 @samp{\<} and @samp{\>} pairs.
9841
9842 @vindex nnmail-split-abbrev-alist
9843 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9844 are expanded as specified by the variable
9845 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
9846 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
9847 value.
9848
9849 @vindex nnmail-split-fancy-syntax-table
9850 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9851 when all this splitting is performed.
9852
9853 If you want to have Gnus create groups dynamically based on some
9854 information in the headers (i.e., do @code{replace-match}-like
9855 substitutions in the group names), you can say things like:
9856
9857 @example
9858 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
9859 @end example
9860
9861 If the string contains the element @samp{\&}, then the previously
9862 matched string will be substituted.  Similarly, the elements @samp{\\1}
9863 up to @samp{\\9} will be substituted with the text matched by the
9864 groupings 1 through 9.
9865
9866
9867 @node Mail and Procmail
9868 @subsection Mail and Procmail
9869 @cindex procmail
9870
9871 @cindex slocal
9872 @cindex elm
9873 Many people use @code{procmail} (or some other mail filter program or
9874 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9875 incoming mail into groups.  If you do that, you should set
9876 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9877 backends never ever try to fetch mail by themselves.
9878
9879 If you have a combined @code{procmail}/POP/mailbox setup, you can do
9880 something like the following:
9881
9882 @vindex nnmail-use-procmail
9883 @lisp
9884 (setq nnmail-use-procmail t)
9885 (setq nnmail-spool-file
9886       '("/usr/spool/mail/my-name" "po:my-name"))
9887 @end lisp
9888
9889 This also means that you probably don't want to set
9890 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9891 side effects.
9892
9893 When a mail backend is queried for what groups it carries, it replies
9894 with the contents of that variable, along with any groups it has figured
9895 out that it carries by other means.  None of the backends, except
9896 @code{nnmh}, actually go out to the disk and check what groups actually
9897 exist.  (It's not trivial to distinguish between what the user thinks is
9898 a basis for a newsgroup and what is just a plain old file or directory.)
9899
9900 This means that you have to tell Gnus (and the backends) by hand what
9901 groups exist.
9902
9903 Let's take the @code{nnmh} backend as an example:
9904
9905 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9906 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9907
9908 Go to the group buffer and type @kbd{G m}.  When prompted, answer
9909 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
9910 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
9911 to include all your mail groups.
9912
9913 That's it.  You are now set to read your mail.  An active file for this
9914 method will be created automatically.
9915
9916 @vindex nnmail-procmail-suffix
9917 @vindex nnmail-procmail-directory
9918 If you use @code{nnfolder} or any other backend that store more than a
9919 single article in each file, you should never have procmail add mails to
9920 the file that Gnus sees.  Instead, procmail should put all incoming mail
9921 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9922 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9923 name.  The mail backends will read the mail from these files.
9924
9925 @vindex nnmail-resplit-incoming
9926 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9927 put in the @code{mail.misc}, as one would expect.  However, if you want
9928 Gnus to split the mail the normal way, you could set
9929 @code{nnmail-resplit-incoming} to @code{t}.
9930
9931 @vindex nnmail-keep-last-article
9932 If you use @code{procmail} to split things directly into an @code{nnmh}
9933 directory (which you shouldn't do), you should set
9934 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9935 ever expiring the final article (i.e., the article with the highest
9936 article number) in a mail newsgroup.  This is quite, quite important.
9937
9938 Here's an example setup:  The incoming spools are located in
9939 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9940 spool files have the same names as the equivalent groups).  The
9941 @code{nnfolder} backend is to be used as the mail interface, and the
9942 @code{nnfolder} directory is @file{~/fMail/}.
9943
9944 @lisp
9945 (setq nnfolder-directory "~/fMail/")
9946 (setq nnmail-spool-file 'procmail)
9947 (setq nnmail-procmail-directory "~/incoming/")
9948 (setq gnus-secondary-select-methods '((nnfolder "")))
9949 (setq nnmail-procmail-suffix "")
9950 @end lisp
9951
9952
9953 @node Incorporating Old Mail
9954 @subsection Incorporating Old Mail
9955
9956 Most people have lots of old mail stored in various file formats.  If
9957 you have set up Gnus to read mail using one of the spiffy Gnus mail
9958 backends, you'll probably wish to have that old mail incorporated into
9959 your mail groups.
9960
9961 Doing so can be quite easy.
9962
9963 To take an example: You're reading mail using @code{nnml}
9964 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9965 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9966 file filled with important, but old, mail.  You want to move it into
9967 your @code{nnml} groups.
9968
9969 Here's how:
9970
9971 @enumerate
9972 @item
9973 Go to the group buffer.
9974
9975 @item
9976 Type `G f' and give the path to the mbox file when prompted to create an
9977 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9978
9979 @item
9980 Type `SPACE' to enter the newly created group.
9981
9982 @item
9983 Type `M P b' to process-mark all articles in this group's buffer
9984 (@pxref{Setting Process Marks}).
9985
9986 @item
9987 Type `B r' to respool all the process-marked articles, and answer
9988 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9989 @end enumerate
9990
9991 All the mail messages in the mbox file will now also be spread out over
9992 all your @code{nnml} groups.  Try entering them and check whether things
9993 have gone without a glitch.  If things look ok, you may consider
9994 deleting the mbox file, but I wouldn't do that unless I was absolutely
9995 sure that all the mail has ended up where it should be.
9996
9997 Respooling is also a handy thing to do if you're switching from one mail
9998 backend to another.  Just respool all the mail in the old mail groups
9999 using the new mail backend.
10000
10001
10002 @node Expiring Mail
10003 @subsection Expiring Mail
10004 @cindex article expiry
10005
10006 Traditional mail readers have a tendency to remove mail articles when
10007 you mark them as read, in some way.  Gnus takes a fundamentally
10008 different approach to mail reading.
10009
10010 Gnus basically considers mail just to be news that has been received in
10011 a rather peculiar manner.  It does not think that it has the power to
10012 actually change the mail, or delete any mail messages.  If you enter a
10013 mail group, and mark articles as ``read'', or kill them in some other
10014 fashion, the mail articles will still exist on the system.  I repeat:
10015 Gnus will not delete your old, read mail.  Unless you ask it to, of
10016 course.
10017
10018 To make Gnus get rid of your unwanted mail, you have to mark the
10019 articles as @dfn{expirable}.  This does not mean that the articles will
10020 disappear right away, however.  In general, a mail article will be
10021 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10022 more than one week old.  If you do not mark an article as expirable, it
10023 will remain on your system until hell freezes over.  This bears
10024 repeating one more time, with some spurious capitalizations: IF you do
10025 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10026
10027 @vindex gnus-auto-expirable-newsgroups
10028 You do not have to mark articles as expirable by hand.  Groups that
10029 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10030 have all articles that you read marked as expirable automatically.  All
10031 articles marked as expirable have an @samp{E} in the first
10032 column in the summary buffer.
10033
10034 By default, if you have auto expiry switched on, Gnus will mark all the
10035 articles you read as expirable, no matter if they were read or unread
10036 before.  To avoid having articles marked as read marked as expirable
10037 automatically, you can put something like the following in your
10038 @file{.gnus} file:
10039
10040 @vindex gnus-mark-article-hook
10041 @lisp
10042 (remove-hook 'gnus-mark-article-hook
10043              'gnus-summary-mark-read-and-unread-as-read)
10044 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10045 @end lisp
10046
10047 Note that making a group auto-expirable doesn't mean that all read
10048 articles are expired---only the articles marked as expirable
10049 will be expired.  Also note that using the @kbd{d} command won't make
10050 groups expirable---only semi-automatic marking of articles as read will
10051 mark the articles as expirable in auto-expirable groups.
10052
10053 Let's say you subscribe to a couple of mailing lists, and you want the
10054 articles you have read to disappear after a while:
10055
10056 @lisp
10057 (setq gnus-auto-expirable-newsgroups
10058       "mail.nonsense-list\\|mail.nice-list")
10059 @end lisp
10060
10061 Another way to have auto-expiry happen is to have the element
10062 @code{auto-expire} in the group parameters of the group.
10063
10064 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10065 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
10066 don't really mix very well.
10067
10068 @vindex nnmail-expiry-wait
10069 The @code{nnmail-expiry-wait} variable supplies the default time an
10070 expirable article has to live.  Gnus starts counting days from when the
10071 message @emph{arrived}, not from when it was sent.  The default is seven
10072 days.
10073
10074 Gnus also supplies a function that lets you fine-tune how long articles
10075 are to live, based on what group they are in.  Let's say you want to
10076 have one month expiry period in the @samp{mail.private} group, a one day
10077 expiry period in the @samp{mail.junk} group, and a six day expiry period
10078 everywhere else:
10079
10080 @vindex nnmail-expiry-wait-function
10081 @lisp
10082 (setq nnmail-expiry-wait-function
10083       (lambda (group)
10084        (cond ((string= group "mail.private")
10085                31)
10086              ((string= group "mail.junk")
10087                1)
10088              ((string= group "important")
10089                'never)
10090              (t
10091                6))))
10092 @end lisp
10093
10094 The group names this function is fed are ``unadorned'' group
10095 names---no @samp{nnml:} prefixes and the like.
10096
10097 The @code{nnmail-expiry-wait} variable and
10098 @code{nnmail-expiry-wait-function} function can either be a number (not
10099 necessarily an integer) or one of the symbols @code{immediate} or
10100 @code{never}.
10101
10102 You can also use the @code{expiry-wait} group parameter to selectively
10103 change the expiry period (@pxref{Group Parameters}).
10104
10105 @vindex nnmail-keep-last-article
10106 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10107 expire the final article in a mail newsgroup.  This is to make life
10108 easier for procmail users.
10109
10110 @vindex gnus-total-expirable-newsgroups
10111 By the way: That line up there, about Gnus never expiring non-expirable
10112 articles, is a lie.  If you put @code{total-expire} in the group
10113 parameters, articles will not be marked as expirable, but all read
10114 articles will be put through the expiry process.  Use with extreme
10115 caution.  Even more dangerous is the
10116 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
10117 this regexp will have all read articles put through the expiry process,
10118 which means that @emph{all} old mail articles in the groups in question
10119 will be deleted after a while.  Use with extreme caution, and don't come
10120 crying to me when you discover that the regexp you used matched the
10121 wrong group and all your important mail has disappeared.  Be a
10122 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
10123 with!  So there!
10124
10125 Most people make most of their mail groups total-expirable, though.
10126
10127
10128 @node Washing Mail
10129 @subsection Washing Mail
10130 @cindex mail washing
10131 @cindex list server brain damage
10132 @cindex incoming mail treatment
10133
10134 Mailers and list servers are notorious for doing all sorts of really,
10135 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
10136 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10137 end of all lines passing through our server, so let's do that!!!!1!''
10138 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
10139 considered to be self-evident were not discussed.  So.  Here we are.
10140
10141 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
10142 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
10143 be shocked and dismayed by this, but I haven't got the energy.  It is to
10144 laugh.
10145
10146 Gnus provides a plethora of functions for washing articles while
10147 displaying them, but it might be nicer to do the filtering before
10148 storing the mail to disc.  For that purpose, we have three hooks and
10149 various functions that can be put in these hooks.
10150
10151 @table @code
10152 @item nnmail-prepare-incoming-hook
10153 @vindex nnmail-prepare-incoming-hook
10154 This hook is called before doing anything with the mail and is meant for
10155 grand, sweeping gestures.  It is called in a buffer that contains all
10156 the new, incoming mail.  Functions to be used include:
10157
10158 @table @code
10159 @item nnheader-ms-strip-cr
10160 @findex nnheader-ms-strip-cr
10161 Remove trailing carriage returns from each line.  This is default on
10162 Emacs running on MS machines.
10163
10164 @end table
10165
10166 @item nnmail-prepare-incoming-header-hook
10167 @vindex nnmail-prepare-incoming-header-hook
10168 This hook is called narrowed to each header.  It can be used when
10169 cleaning up the headers.  Functions that can be used include:
10170
10171 @table @code
10172 @item nnmail-remove-leading-whitespace
10173 @findex nnmail-remove-leading-whitespace
10174 Clear leading white space that ``helpful'' listservs have added to the
10175 headers to make them look nice.  Aaah.
10176
10177 @item nnmail-remove-list-identifiers
10178 @findex nnmail-remove-list-identifiers
10179 Some list servers add an identifier---for example, @samp{(idm)}---to the
10180 beginning of all @code{Subject} headers.  I'm sure that's nice for
10181 people who use stone age mail readers.  This function will remove
10182 strings that match the @code{nnmail-list-identifiers} regexp, which can
10183 also be a list of regexp.
10184
10185 For instance, if you want to remove the @samp{(idm)} and the
10186 @samp{nagnagnag} identifiers:
10187
10188 @lisp
10189 (setq nnmail-list-identifiers
10190       '("(idm)" "nagnagnag"))
10191 @end lisp
10192
10193 @item nnmail-remove-tabs
10194 @findex nnmail-remove-tabs
10195 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10196
10197 @end table
10198
10199 @item nnmail-prepare-incoming-message-hook
10200 @vindex nnmail-prepare-incoming-message-hook
10201 This hook is called narrowed to each message.  Functions to be used
10202 include:
10203
10204 @table @code
10205 @item article-de-quoted-unreadable
10206 @findex article-de-quoted-unreadable
10207 Decode Quoted Readable encoding.
10208
10209 @end table
10210 @end table
10211
10212
10213 @node Duplicates
10214 @subsection Duplicates
10215
10216 @vindex nnmail-treat-duplicates
10217 @vindex nnmail-message-id-cache-length
10218 @vindex nnmail-message-id-cache-file
10219 @cindex duplicate mails
10220 If you are a member of a couple of mailing lists, you will sometimes
10221 receive two copies of the same mail.  This can be quite annoying, so
10222 @code{nnmail} checks for and treats any duplicates it might find.  To do
10223 this, it keeps a cache of old @code{Message-ID}s---
10224 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10225 default.  The approximate maximum number of @code{Message-ID}s stored
10226 there is controlled by the @code{nnmail-message-id-cache-length}
10227 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10228 stored.) If all this sounds scary to you, you can set
10229 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10230 default), and @code{nnmail} won't delete duplicate mails.  Instead it
10231 will insert a warning into the head of the mail saying that it thinks
10232 that this is a duplicate of a different message.
10233
10234 This variable can also be a function.  If that's the case, the function
10235 will be called from a buffer narrowed to the message in question with
10236 the @code{Message-ID} as a parameter.  The function must return either
10237 @code{nil}, @code{warn}, or @code{delete}.
10238
10239 You can turn this feature off completely by setting the variable to
10240 @code{nil}.
10241
10242 If you want all the duplicate mails to be put into a special
10243 @dfn{duplicates} group, you could do that using the normal mail split
10244 methods:
10245
10246 @lisp
10247 (setq nnmail-split-fancy
10248       '(| ;; Messages duplicates go to a separate group.
10249           ("gnus-warning" "duplication of message" "duplicate")
10250           ;; Message from daemons, postmaster, and the like to another.
10251           (any mail "mail.misc")
10252           ;; Other rules.
10253           [ ... ] ))
10254 @end lisp
10255
10256 Or something like:
10257 @lisp
10258 (setq nnmail-split-methods
10259       '(("duplicates" "^Gnus-Warning:")
10260         ;; Other rules.
10261         [...]))
10262 @end lisp
10263
10264 Here's a neat feature: If you know that the recipient reads her mail
10265 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10266 @code{delete}, you can send her as many insults as you like, just by
10267 using a @code{Message-ID} of a mail that you know that she's already
10268 received.  Think of all the fun!  She'll never see any of it!  Whee!
10269
10270
10271 @node Not Reading Mail
10272 @subsection Not Reading Mail
10273
10274 If you start using any of the mail backends, they have the annoying
10275 habit of assuming that you want to read mail with them.  This might not
10276 be unreasonable, but it might not be what you want.
10277
10278 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
10279 will ever attempt to read incoming mail, which should help.
10280
10281 @vindex nnbabyl-get-new-mail
10282 @vindex nnmbox-get-new-mail
10283 @vindex nnml-get-new-mail
10284 @vindex nnmh-get-new-mail
10285 @vindex nnfolder-get-new-mail
10286 This might be too much, if, for instance, you are reading mail quite
10287 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10288 file you have stashed away with @code{nnbabyl}.  All backends have
10289 variables called backend-@code{get-new-mail}.  If you want to disable
10290 the @code{nnbabyl} mail reading, you edit the virtual server for the
10291 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10292
10293 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10294 narrowed to the article to be saved before saving it when reading
10295 incoming mail.
10296
10297
10298 @node Choosing a Mail Backend
10299 @subsection Choosing a Mail Backend
10300
10301 Gnus will read the mail spool when you activate a mail group.  The mail
10302 file is first copied to your home directory.  What happens after that
10303 depends on what format you want to store your mail in.
10304
10305 @menu
10306 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10307 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10308 * Mail Spool::                  Store your mail in a private spool?
10309 * MH Spool::                    An mhspool-like backend.
10310 * Mail Folders::                Having one file for each group.
10311 @end menu
10312
10313
10314 @node Unix Mail Box
10315 @subsubsection Unix Mail Box
10316 @cindex nnmbox
10317 @cindex unix mail box
10318
10319 @vindex nnmbox-active-file
10320 @vindex nnmbox-mbox-file
10321 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10322 mail.  @code{nnmbox} will add extra headers to each mail article to say
10323 which group it belongs in.
10324
10325 Virtual server settings:
10326
10327 @table @code
10328 @item nnmbox-mbox-file
10329 @vindex nnmbox-mbox-file
10330 The name of the mail box in the user's home directory.
10331
10332 @item nnmbox-active-file
10333 @vindex nnmbox-active-file
10334 The name of the active file for the mail box.
10335
10336 @item nnmbox-get-new-mail
10337 @vindex nnmbox-get-new-mail
10338 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10339 into groups.
10340 @end table
10341
10342
10343 @node Rmail Babyl
10344 @subsubsection Rmail Babyl
10345 @cindex nnbabyl
10346 @cindex rmail mbox
10347
10348 @vindex nnbabyl-active-file
10349 @vindex nnbabyl-mbox-file
10350 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10351 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10352 article to say which group it belongs in.
10353
10354 Virtual server settings:
10355
10356 @table @code
10357 @item nnbabyl-mbox-file
10358 @vindex nnbabyl-mbox-file
10359 The name of the rmail mbox file.
10360
10361 @item nnbabyl-active-file
10362 @vindex nnbabyl-active-file
10363 The name of the active file for the rmail box.
10364
10365 @item nnbabyl-get-new-mail
10366 @vindex nnbabyl-get-new-mail
10367 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
10368 @end table
10369
10370
10371 @node Mail Spool
10372 @subsubsection Mail Spool
10373 @cindex nnml
10374 @cindex mail @sc{nov} spool
10375
10376 The @dfn{nnml} spool mail format isn't compatible with any other known
10377 format.  It should be used with some caution.
10378
10379 @vindex nnml-directory
10380 If you use this backend, Gnus will split all incoming mail into files,
10381 one file for each mail, and put the articles into the corresponding
10382 directories under the directory specified by the @code{nnml-directory}
10383 variable.  The default value is @file{~/Mail/}.
10384
10385 You do not have to create any directories beforehand; Gnus will take
10386 care of all that.
10387
10388 If you have a strict limit as to how many files you are allowed to store
10389 in your account, you should not use this backend.  As each mail gets its
10390 own file, you might very well occupy thousands of inodes within a few
10391 weeks.  If this is no problem for you, and it isn't a problem for you
10392 having your friendly systems administrator walking around, madly,
10393 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10394 know that this is probably the fastest format to use.  You do not have
10395 to trudge through a big mbox file just to read your new mail.
10396
10397 @code{nnml} is probably the slowest backend when it comes to article
10398 splitting.  It has to create lots of files, and it also generates
10399 @sc{nov} databases for the incoming mails.  This makes it the fastest
10400 backend when it comes to reading mail.
10401
10402 Virtual server settings:
10403
10404 @table @code
10405 @item nnml-directory
10406 @vindex nnml-directory
10407 All @code{nnml} directories will be placed under this directory.
10408
10409 @item nnml-active-file
10410 @vindex nnml-active-file
10411 The active file for the @code{nnml} server.
10412
10413 @item nnml-newsgroups-file
10414 @vindex nnml-newsgroups-file
10415 The @code{nnml} group descriptions file.  @xref{Newsgroups File
10416 Format}.
10417
10418 @item nnml-get-new-mail
10419 @vindex nnml-get-new-mail
10420 If non-@code{nil}, @code{nnml} will read incoming mail.
10421
10422 @item nnml-nov-is-evil
10423 @vindex nnml-nov-is-evil
10424 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10425
10426 @item nnml-nov-file-name
10427 @vindex nnml-nov-file-name
10428 The name of the @sc{nov} files.  The default is @file{.overview}.
10429
10430 @item nnml-prepare-save-mail-hook
10431 @vindex nnml-prepare-save-mail-hook
10432 Hook run narrowed to an article before saving.
10433
10434 @end table
10435
10436 @findex nnml-generate-nov-databases
10437 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10438 you can do a complete update by typing @kbd{M-x
10439 nnml-generate-nov-databases}.  This command will trawl through the
10440 entire @code{nnml} hierarchy, looking at each and every article, so it
10441 might take a while to complete.  A better interface to this
10442 functionality can be found in the server buffer (@pxref{Server
10443 Commands}).
10444
10445
10446 @node MH Spool
10447 @subsubsection MH Spool
10448 @cindex nnmh
10449 @cindex mh-e mail spool
10450
10451 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10452 @sc{nov} databases and it doesn't keep an active file.  This makes
10453 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10454 makes it easier to write procmail scripts for.
10455
10456 Virtual server settings:
10457
10458 @table @code
10459 @item nnmh-directory
10460 @vindex nnmh-directory
10461 All @code{nnmh} directories will be located under this directory.
10462
10463 @item nnmh-get-new-mail
10464 @vindex nnmh-get-new-mail
10465 If non-@code{nil}, @code{nnmh} will read incoming mail.
10466
10467 @item nnmh-be-safe
10468 @vindex nnmh-be-safe
10469 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10470 sure that the articles in the folder are actually what Gnus thinks they
10471 are.  It will check date stamps and stat everything in sight, so
10472 setting this to @code{t} will mean a serious slow-down.  If you never
10473 use anything but Gnus to read the @code{nnmh} articles, you do not have
10474 to set this variable to @code{t}.
10475 @end table
10476
10477
10478 @node Mail Folders
10479 @subsubsection Mail Folders
10480 @cindex nnfolder
10481 @cindex mbox folders
10482 @cindex mail folders
10483
10484 @code{nnfolder} is a backend for storing each mail group in a separate
10485 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
10486 will add extra headers to keep track of article numbers and arrival
10487 dates.
10488
10489 Virtual server settings:
10490
10491 @table @code
10492 @item nnfolder-directory
10493 @vindex nnfolder-directory
10494 All the @code{nnfolder} mail boxes will be stored under this directory.
10495
10496 @item nnfolder-active-file
10497 @vindex nnfolder-active-file
10498 The name of the active file.
10499
10500 @item nnfolder-newsgroups-file
10501 @vindex nnfolder-newsgroups-file
10502 The name of the group descriptions file.  @xref{Newsgroups File Format}.
10503
10504 @item nnfolder-get-new-mail
10505 @vindex nnfolder-get-new-mail
10506 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10507
10508 @item nnfolder-save-buffer-hook
10509 @vindex nnfolder-save-buffer-hook
10510 @cindex backup files
10511 Hook run before saving the folders.  Note that Emacs does the normal
10512 backup renaming of files even with the @code{nnfolder} buffers.  If you
10513 wish to switch this off, you could say something like the following in
10514 your @file{.emacs} file:
10515
10516 @lisp
10517 (defun turn-off-backup ()
10518   (set (make-local-variable 'backup-inhibited) t))
10519
10520 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
10521 @end lisp
10522
10523 @item nnfolder-delete-mail-hook
10524 @vindex nnfolder-delete-mail-hook
10525 Hook run in a buffer narrowed to the message that is to be deleted.
10526 This function can be used to copy the message to somewhere else, or to
10527 extract some information from it before removing it.  
10528
10529 @end table
10530
10531
10532 @findex nnfolder-generate-active-file
10533 @kindex M-x nnfolder-generate-active-file
10534 If you have lots of @code{nnfolder}-like files you'd like to read with
10535 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10536 command to make @code{nnfolder} aware of all likely files in
10537 @code{nnfolder-directory}.
10538
10539
10540 @node Other Sources
10541 @section Other Sources
10542
10543 Gnus can do more than just read news or mail.  The methods described
10544 below allow Gnus to view directories and files as if they were
10545 newsgroups.
10546
10547 @menu
10548 * Directory Groups::      You can read a directory as if it was a newsgroup.
10549 * Anything Groups::       Dired?  Who needs dired?
10550 * Document Groups::       Single files can be the basis of a group.
10551 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
10552 * Web Searches::          Creating groups from articles that match a string.
10553 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10554 @end menu
10555
10556
10557 @node Directory Groups
10558 @subsection Directory Groups
10559 @cindex nndir
10560 @cindex directory groups
10561
10562 If you have a directory that has lots of articles in separate files in
10563 it, you might treat it as a newsgroup.  The files have to have numerical
10564 names, of course.
10565
10566 This might be an opportune moment to mention @code{ange-ftp} (and its
10567 successor @code{efs}), that most wonderful of all wonderful Emacs
10568 packages.  When I wrote @code{nndir}, I didn't think much about it---a
10569 backend to read directories.  Big deal.
10570
10571 @code{ange-ftp} changes that picture dramatically.  For instance, if you
10572 enter the @code{ange-ftp} file name
10573 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10574 @code{ange-ftp} or @code{efs} will actually allow you to read this
10575 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
10576
10577 @code{nndir} will use @sc{nov} files if they are present.
10578
10579 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10580 articles with this method.  You can use @code{nnmh} or @code{nnml} for
10581 whatever you use @code{nndir} for, so you could switch to any of those
10582 methods if you feel the need to have a non-read-only @code{nndir}.
10583
10584
10585 @node Anything Groups
10586 @subsection Anything Groups
10587 @cindex nneething
10588
10589 From the @code{nndir} backend (which reads a single spool-like
10590 directory), it's just a hop and a skip to @code{nneething}, which
10591 pretends that any arbitrary directory is a newsgroup.  Strange, but
10592 true.
10593
10594 When @code{nneething} is presented with a directory, it will scan this
10595 directory and assign article numbers to each file.  When you enter such
10596 a group, @code{nneething} must create ``headers'' that Gnus can use.
10597 After all, Gnus is a newsreader, in case you're
10598 forgetting. @code{nneething} does this in a two-step process.  First, it
10599 snoops each file in question.  If the file looks like an article (i.e.,
10600 the first few lines look like headers), it will use this as the head.
10601 If this is just some arbitrary file without a head (e.g. a C source
10602 file), @code{nneething} will cobble up a header out of thin air.  It
10603 will use file ownership, name and date and do whatever it can with these
10604 elements.
10605
10606 All this should happen automatically for you, and you will be presented
10607 with something that looks very much like a newsgroup.  Totally like a
10608 newsgroup, to be precise.  If you select an article, it will be displayed
10609 in the article buffer, just as usual.
10610
10611 If you select a line that represents a directory, Gnus will pop you into
10612 a new summary buffer for this @code{nneething} group.  And so on.  You can
10613 traverse the entire disk this way, if you feel like, but remember that
10614 Gnus is not dired, really, and does not intend to be, either.
10615
10616 There are two overall modes to this action---ephemeral or solid.  When
10617 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10618 will not store information on what files you have read, and what files
10619 are new, and so on.  If you create a solid @code{nneething} group the
10620 normal way with @kbd{G m}, Gnus will store a mapping table between
10621 article numbers and file names, and you can treat this group like any
10622 other groups.  When you activate a solid @code{nneething} group, you will
10623 be told how many unread articles it contains, etc., etc.
10624
10625 Some variables:
10626
10627 @table @code
10628 @item nneething-map-file-directory
10629 @vindex nneething-map-file-directory
10630 All the mapping files for solid @code{nneething} groups will be stored
10631 in this directory, which defaults to @file{~/.nneething/}.
10632
10633 @item nneething-exclude-files
10634 @vindex nneething-exclude-files
10635 All files that match this regexp will be ignored.  Nice to use to exclude
10636 auto-save files and the like, which is what it does by default.
10637
10638 @item nneething-map-file
10639 @vindex nneething-map-file
10640 Name of the map files.
10641 @end table
10642
10643
10644 @node Document Groups
10645 @subsection Document Groups
10646 @cindex nndoc
10647 @cindex documentation group
10648 @cindex help group
10649
10650 @code{nndoc} is a cute little thing that will let you read a single file
10651 as a newsgroup.  Several files types are supported:
10652
10653 @table @code
10654 @cindex babyl
10655 @cindex rmail mbox
10656
10657 @item babyl
10658 The babyl (rmail) mail box.
10659 @cindex mbox
10660 @cindex Unix mbox
10661
10662 @item mbox
10663 The standard Unix mbox file.
10664
10665 @cindex MMDF mail box
10666 @item mmdf
10667 The MMDF mail box format.
10668
10669 @item news
10670 Several news articles appended into a file.
10671
10672 @item rnews
10673 @cindex rnews batch files
10674 The rnews batch transport format.
10675 @cindex forwarded messages
10676
10677 @item forward
10678 Forwarded articles.
10679
10680 @item mime-parts
10681 MIME multipart messages, besides digests.
10682
10683 @item mime-digest
10684 @cindex digest
10685 @cindex MIME digest
10686 @cindex 1153 digest
10687 @cindex RFC 1153 digest
10688 @cindex RFC 341 digest
10689 MIME (RFC 1341) digest format.
10690
10691 @item standard-digest
10692 The standard (RFC 1153) digest format.
10693
10694 @item slack-digest
10695 Non-standard digest format---matches most things, but does it badly.
10696 @end table
10697
10698 You can also use the special ``file type'' @code{guess}, which means
10699 that @code{nndoc} will try to guess what file type it is looking at.
10700 @code{digest} means that @code{nndoc} should guess what digest type the
10701 file is.
10702
10703 @code{nndoc} will not try to change the file or insert any extra headers into
10704 it---it will simply, like, let you use the file as the basis for a
10705 group.  And that's it.
10706
10707 If you have some old archived articles that you want to insert into your
10708 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10709 that.  Say you have an old @file{RMAIL} file with mail that you now want
10710 to split into your new @code{nnml} groups.  You look at that file using
10711 @code{nndoc} (using the @kbd{G f} command in the group buffer
10712 (@pxref{Foreign Groups})), set the process mark on all the articles in
10713 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10714 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
10715 file is now also stored in lots of @code{nnml} directories, and you can
10716 delete that pesky @file{RMAIL} file.  If you have the guts!
10717
10718 Virtual server variables:
10719
10720 @table @code
10721 @item nndoc-article-type
10722 @vindex nndoc-article-type
10723 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10724 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10725 @code{rfc822-forward}, @code{mime-parts}, @code{mime-digest},
10726 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs} or
10727 @code{guess}.
10728
10729 @item nndoc-post-type
10730 @vindex nndoc-post-type
10731 This variable says whether Gnus is to consider the group a news group or
10732 a mail group.  There are two valid values:  @code{mail} (the default)
10733 and @code{news}.
10734 @end table
10735
10736 @menu
10737 * Document Server Internals::   How to add your own document types.
10738 @end menu
10739
10740
10741 @node Document Server Internals
10742 @subsubsection Document Server Internals
10743
10744 Adding new document types to be recognized by @code{nndoc} isn't
10745 difficult.  You just have to whip up a definition of what the document
10746 looks like, write a predicate function to recognize that document type,
10747 and then hook into @code{nndoc}.
10748
10749 First, here's an example document type definition:
10750
10751 @example
10752 (mmdf
10753  (article-begin .  "^\^A\^A\^A\^A\n")
10754  (body-end .  "^\^A\^A\^A\^A\n"))
10755 @end example
10756
10757 The definition is simply a unique @dfn{name} followed by a series of
10758 regexp pseudo-variable settings.  Below are the possible
10759 variables---don't be daunted by the number of variables; most document
10760 types can be defined with very few settings:
10761
10762 @table @code
10763 @item first-article
10764 If present, @code{nndoc} will skip past all text until it finds
10765 something that match this regexp.  All text before this will be
10766 totally ignored.
10767
10768 @item article-begin
10769 This setting has to be present in all document type definitions.  It
10770 says what the beginning of each article looks like.
10771
10772 @item head-begin-function
10773 If present, this should be a function that moves point to the head of
10774 the article.
10775
10776 @item nndoc-head-begin
10777 If present, this should be a regexp that matches the head of the
10778 article.
10779
10780 @item nndoc-head-end
10781 This should match the end of the head of the article.  It defaults to
10782 @samp{^$}---the empty line.
10783
10784 @item body-begin-function
10785 If present, this function should move point to the beginning of the body
10786 of the article.
10787
10788 @item body-begin
10789 This should match the beginning of the body of the article.  It defaults
10790 to @samp{^\n}.
10791
10792 @item body-end-function
10793 If present, this function should move point to the end of the body of
10794 the article.
10795
10796 @item body-end
10797 If present, this should match the end of the body of the article.
10798
10799 @item file-end
10800 If present, this should match the end of the file.  All text after this
10801 regexp will be totally ignored.
10802
10803 @end table
10804
10805 So, using these variables @code{nndoc} is able to dissect a document
10806 file into a series of articles, each with a head and a body.  However, a
10807 few more variables are needed since not all document types are all that
10808 news-like---variables needed to transform the head or the body into
10809 something that's palatable for Gnus:
10810
10811 @table @code
10812 @item prepare-body-function
10813 If present, this function will be called when requesting an article.  It
10814 will be called with point at the start of the body, and is useful if the
10815 document has encoded some parts of its contents.
10816
10817 @item article-transform-function
10818 If present, this function is called when requesting an article.  It's
10819 meant to be used for more wide-ranging transformation of both head and
10820 body of the article.
10821
10822 @item generate-head-function
10823 If present, this function is called to generate a head that Gnus can
10824 understand.  It is called with the article number as a parameter, and is
10825 expected to generate a nice head for the article in question.  It is
10826 called when requesting the headers of all articles.
10827
10828 @end table
10829
10830 Let's look at the most complicated example I can come up with---standard
10831 digests:
10832
10833 @example
10834 (standard-digest
10835  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10836  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10837  (prepare-body-function . nndoc-unquote-dashes)
10838  (body-end-function . nndoc-digest-body-end)
10839  (head-end . "^ ?$")
10840  (body-begin . "^ ?\n")
10841  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10842  (subtype digest guess))
10843 @end example
10844
10845 We see that all text before a 70-width line of dashes is ignored; all
10846 text after a line that starts with that @samp{^End of} is also ignored;
10847 each article begins with a 30-width line of dashes; the line separating
10848 the head from the body may contain a single space; and that the body is
10849 run through @code{nndoc-unquote-dashes} before being delivered.
10850
10851 To hook your own document definition into @code{nndoc}, use the
10852 @code{nndoc-add-type} function.  It takes two parameters---the first is
10853 the definition itself and the second (optional) parameter says where in
10854 the document type definition alist to put this definition.  The alist is
10855 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
10856 is of @code{mmdf} type, and so on.  These type predicates should return
10857 @code{nil} if the document is not of the correct type; @code{t} if it is
10858 of the correct type; and a number if the document might be of the
10859 correct type.  A high number means high probability; a low number means
10860 low probability with @samp{0} being the lowest valid number.
10861
10862
10863 @node SOUP
10864 @subsection SOUP
10865 @cindex SOUP
10866 @cindex offline
10867
10868 In the PC world people often talk about ``offline'' newsreaders.  These
10869 are thingies that are combined reader/news transport monstrosities.
10870 With built-in modem programs.  Yecchh!
10871
10872 Of course, us Unix Weenie types of human beans use things like
10873 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10874 transport things like Ghod intended.  And then we just use normal
10875 newsreaders.
10876
10877 However, it can sometimes be convenient to do something a that's a bit
10878 easier on the brain if you have a very slow modem, and you're not really
10879 that interested in doing things properly.
10880
10881 A file format called @sc{soup} has been developed for transporting news
10882 and mail from servers to home machines and back again.  It can be a bit
10883 fiddly.
10884
10885 First some terminology:
10886
10887 @table @dfn
10888
10889 @item server
10890 This is the machine that is connected to the outside world and where you
10891 get news and/or mail from.
10892
10893 @item home machine
10894 This is the machine that you want to do the actual reading and responding
10895 on.  It is typically not connected to the rest of the world in any way.
10896
10897 @item packet
10898 Something that contains messages and/or commands.  There are two kinds
10899 of packets:
10900
10901 @table @dfn
10902 @item message packets
10903 These are packets made at the server, and typically contain lots of
10904 messages for you to read.  These are called @file{SoupoutX.tgz} by
10905 default, where @var{X} is a number.
10906
10907 @item response packets
10908 These are packets made at the home machine, and typically contains
10909 replies that you've written.  These are called @file{SoupinX.tgz} by
10910 default, where @var{X} is a number.
10911
10912 @end table
10913
10914 @end table
10915
10916
10917 @enumerate
10918
10919 @item
10920 You log in on the server and create a @sc{soup} packet.  You can either
10921 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10922 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10923 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10924
10925 @item
10926 You transfer the packet home.  Rail, boat, car or modem will do fine.
10927
10928 @item
10929 You put the packet in your home directory.
10930
10931 @item
10932 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10933 the native or secondary server.
10934
10935 @item
10936 You read articles and mail and answer and followup to the things you
10937 want (@pxref{SOUP Replies}).
10938
10939 @item
10940 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10941 packet.
10942
10943 @item
10944 You transfer this packet to the server.
10945
10946 @item
10947 You use Gnus to mail this packet out with the @kbd{G s s} command.
10948
10949 @item
10950 You then repeat until you die.
10951
10952 @end enumerate
10953
10954 So you basically have a bipartite system---you use @code{nnsoup} for
10955 reading and Gnus for packing/sending these @sc{soup} packets.
10956
10957 @menu
10958 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10959 * SOUP Groups::       A backend for reading @sc{soup} packets.
10960 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10961 @end menu
10962
10963
10964 @node SOUP Commands
10965 @subsubsection SOUP Commands
10966
10967 These are commands for creating and manipulating @sc{soup} packets.
10968
10969 @table @kbd
10970 @item G s b
10971 @kindex G s b (Group)
10972 @findex gnus-group-brew-soup
10973 Pack all unread articles in the current group
10974 (@code{gnus-group-brew-soup}).  This command understands the
10975 process/prefix convention.
10976
10977 @item G s w
10978 @kindex G s w (Group)
10979 @findex gnus-soup-save-areas
10980 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10981
10982 @item G s s
10983 @kindex G s s (Group)
10984 @findex gnus-soup-send-replies
10985 Send all replies from the replies packet
10986 (@code{gnus-soup-send-replies}).
10987
10988 @item G s p
10989 @kindex G s p (Group)
10990 @findex gnus-soup-pack-packet
10991 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
10992
10993 @item G s r
10994 @kindex G s r (Group)
10995 @findex nnsoup-pack-replies
10996 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
10997
10998 @item O s
10999 @kindex O s (Summary)
11000 @findex gnus-soup-add-article
11001 This summary-mode command adds the current article to a @sc{soup} packet
11002 (@code{gnus-soup-add-article}).  It understands the process/prefix
11003 convention (@pxref{Process/Prefix}).
11004
11005 @end table
11006
11007
11008 There are a few variables to customize where Gnus will put all these
11009 thingies:
11010
11011 @table @code
11012
11013 @item gnus-soup-directory
11014 @vindex gnus-soup-directory
11015 Directory where Gnus will save intermediate files while composing
11016 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
11017
11018 @item gnus-soup-replies-directory
11019 @vindex gnus-soup-replies-directory
11020 This is what Gnus will use as a temporary directory while sending our
11021 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
11022
11023 @item gnus-soup-prefix-file
11024 @vindex gnus-soup-prefix-file
11025 Name of the file where Gnus stores the last used prefix.  The default is
11026 @samp{gnus-prefix}.
11027
11028 @item gnus-soup-packer
11029 @vindex gnus-soup-packer
11030 A format string command for packing a @sc{soup} packet.  The default is
11031 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11032
11033 @item gnus-soup-unpacker
11034 @vindex gnus-soup-unpacker
11035 Format string command for unpacking a @sc{soup} packet.  The default is
11036 @samp{gunzip -c %s | tar xvf -}.
11037
11038 @item gnus-soup-packet-directory
11039 @vindex gnus-soup-packet-directory
11040 Where Gnus will look for reply packets.  The default is @file{~/}.
11041
11042 @item gnus-soup-packet-regexp
11043 @vindex gnus-soup-packet-regexp
11044 Regular expression matching @sc{soup} reply packets in
11045 @code{gnus-soup-packet-directory}.
11046
11047 @end table
11048
11049
11050 @node SOUP Groups
11051 @subsubsection @sc{soup} Groups
11052 @cindex nnsoup
11053
11054 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
11055 read incoming packets, unpack them, and put them in a directory where
11056 you can read them at leisure.
11057
11058 These are the variables you can use to customize its behavior:
11059
11060 @table @code
11061
11062 @item nnsoup-tmp-directory
11063 @vindex nnsoup-tmp-directory
11064 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11065 directory.  (@file{/tmp/} by default.)
11066
11067 @item nnsoup-directory
11068 @vindex nnsoup-directory
11069 @code{nnsoup} then moves each message and index file to this directory.
11070 The default is @file{~/SOUP/}.
11071
11072 @item nnsoup-replies-directory
11073 @vindex nnsoup-replies-directory
11074 All replies will be stored in this directory before being packed into a
11075 reply packet.  The default is @file{~/SOUP/replies/"}.
11076
11077 @item nnsoup-replies-format-type
11078 @vindex nnsoup-replies-format-type
11079 The @sc{soup} format of the replies packets.  The default is @samp{?n}
11080 (rnews), and I don't think you should touch that variable.  I probably
11081 shouldn't even have documented it.  Drats!  Too late!
11082
11083 @item nnsoup-replies-index-type
11084 @vindex nnsoup-replies-index-type
11085 The index type of the replies packet.  The default is @samp{?n}, which
11086 means ``none''.  Don't fiddle with this one either!
11087
11088 @item nnsoup-active-file
11089 @vindex nnsoup-active-file
11090 Where @code{nnsoup} stores lots of information.  This is not an ``active
11091 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
11092 this file or mess it up in any way, you're dead.  The default is
11093 @file{~/SOUP/active}.
11094
11095 @item nnsoup-packer
11096 @vindex nnsoup-packer
11097 Format string command for packing a reply @sc{soup} packet.  The default
11098 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11099
11100 @item nnsoup-unpacker
11101 @vindex nnsoup-unpacker
11102 Format string command for unpacking incoming @sc{soup} packets.  The
11103 default is @samp{gunzip -c %s | tar xvf -}.
11104
11105 @item nnsoup-packet-directory
11106 @vindex nnsoup-packet-directory
11107 Where @code{nnsoup} will look for incoming packets.  The default is
11108 @file{~/}.
11109
11110 @item nnsoup-packet-regexp
11111 @vindex nnsoup-packet-regexp
11112 Regular expression matching incoming @sc{soup} packets.  The default is
11113 @samp{Soupout}.
11114
11115 @item nnsoup-always-save
11116 @vindex nnsoup-always-save
11117 If non-@code{nil}, save the replies buffer after each posted message.
11118
11119 @end table
11120
11121
11122 @node SOUP Replies
11123 @subsubsection SOUP Replies
11124
11125 Just using @code{nnsoup} won't mean that your postings and mailings end
11126 up in @sc{soup} reply packets automagically.  You have to work a bit
11127 more for that to happen.
11128
11129 @findex nnsoup-set-variables
11130 The @code{nnsoup-set-variables} command will set the appropriate
11131 variables to ensure that all your followups and replies end up in the
11132 @sc{soup} system.
11133
11134 In specific, this is what it does:
11135
11136 @lisp
11137 (setq message-send-news-function 'nnsoup-request-post)
11138 (setq message-send-mail-function 'nnsoup-request-mail)
11139 @end lisp
11140
11141 And that's it, really.  If you only want news to go into the @sc{soup}
11142 system you just use the first line.  If you only want mail to be
11143 @sc{soup}ed you use the second.
11144
11145
11146 @node Web Searches
11147 @subsection Web Searches
11148 @cindex nnweb
11149 @cindex DejaNews
11150 @cindex Alta Vista
11151 @cindex InReference
11152 @cindex Usenet searches
11153 @cindex searching the Usenet
11154
11155 It's, like, too neat to search the Usenet for articles that match a
11156 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11157 those, like, Web browsers, and you, like, have to, rilly, like, look at
11158 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11159 searches without having to use a browser.
11160
11161 The @code{nnweb} backend allows an easy interface to the mighty search
11162 engine.  You create an @code{nnweb} group, enter a search pattern, and
11163 then enter the group and read the articles like you would any normal
11164 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
11165 Groups}) will do this in an easy-to-use fashion.
11166
11167 @code{nnweb} groups don't really lend themselves to being solid
11168 groups---they have a very fleeting idea of article numbers.  In fact,
11169 each time you enter an @code{nnweb} group (not even changing the search
11170 pattern), you are likely to get the articles ordered in a different
11171 manner.  Not even using duplicate suppression (@pxref{Duplicate
11172 Suppression}) will help, since @code{nnweb} doesn't even know the
11173 @code{Message-ID} of the articles before reading them using some search
11174 engines (DejaNews, for instance).  The only possible way to keep track
11175 of which articles you've read is by scoring on the @code{Date}
11176 header---mark all articles posted before the last date you read the
11177 group as read.
11178
11179 If the search engine changes its output substantially, @code{nnweb}
11180 won't be able to parse it and will fail.  One could hardly fault the Web
11181 providers if they were to do this---their @emph{raison d'être} is to
11182 make money off of advertisements, not to provide services to the
11183 community.  Since @code{nnweb} washes the ads off all the articles, one
11184 might think that the providers might be somewhat miffed.  We'll see.
11185
11186 You must have the @code{url} and @code{w3} package installed to be able
11187 to use @code{nnweb}.
11188
11189 Virtual server variables:
11190
11191 @table @code
11192 @item nnweb-type
11193 @vindex nnweb-type
11194 What search engine type is being used.  The currently supported types
11195 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11196 @code{reference}.
11197
11198 @item nnweb-search
11199 @vindex nnweb-search
11200 The search string to feed to the search engine.
11201
11202 @item nnweb-max-hits
11203 @vindex nnweb-max-hits
11204 Advisory maximum number of hits per search to display.  The default is
11205 100.
11206
11207 @item nnweb-type-definition
11208 @vindex nnweb-type-definition
11209 Type-to-definition alist.  This alist says what @code{nnweb} should do
11210 with the various search engine types.  The following elements must be
11211 present:
11212
11213 @table @code
11214 @item article
11215 Function to decode the article and provide something that Gnus
11216 understands.
11217
11218 @item map
11219 Function to create an article number to message header and URL alist.
11220
11221 @item search
11222 Function to send the search string to the search engine.
11223
11224 @item address
11225 The address the aforementioned function should send the search string
11226 to.
11227
11228 @item id
11229 Format string URL to fetch an article by @code{Message-ID}.
11230 @end table
11231
11232 @end table
11233
11234
11235
11236 @node Mail-To-News Gateways
11237 @subsection Mail-To-News Gateways
11238 @cindex mail-to-news gateways
11239 @cindex gateways
11240
11241 If your local @code{nntp} server doesn't allow posting, for some reason
11242 or other, you can post using one of the numerous mail-to-news gateways.
11243 The @code{nngateway} backend provides the interface.
11244
11245 Note that you can't read anything from this backend---it can only be
11246 used to post with.
11247
11248 Server variables:
11249
11250 @table @code
11251 @item nngateway-address
11252 @vindex nngateway-address
11253 This is the address of the mail-to-news gateway.
11254
11255 @item nngateway-header-transformation
11256 @vindex nngateway-header-transformation
11257 News headers often have to be transformed in some odd way or other
11258 for the mail-to-news gateway to accept it.  This variable says what
11259 transformation should be called, and defaults to
11260 @code{nngateway-simple-header-transformation}.  The function is called
11261 narrowed to the headers to be transformed and with one parameter---the
11262 gateway address.
11263
11264 This default function just inserts a new @code{To} header based on the
11265 @code{Newsgroups} header and the gateway address.
11266 For instance, an article with this @code{Newsgroups} header:
11267
11268 @example
11269 Newsgroups: alt.religion.emacs
11270 @end example
11271
11272 will get this @code{From} header inserted:
11273
11274 @example
11275 To: alt-religion-emacs@@GATEWAY
11276 @end example
11277
11278 The following pre-defined functions exist:
11279
11280 @findex nngateway-simple-header-transformation
11281 @table @code
11282
11283 @item nngateway-simple-header-transformation
11284 Creates a @code{To} header that looks like
11285 @var{newsgroup}@@@code{nngateway-address}.
11286
11287 @findex nngateway-mail2news-header-transformation
11288
11289 @item nngateway-mail2news-header-transformation
11290 Creates a @code{To} header that looks like
11291 @code{nngateway-address}.
11292
11293 Here's an example:
11294
11295 @lisp
11296 (setq gnus-post-method
11297       '(nngateway "mail2news@@replay.com"
11298                   (nngateway-header-transformation
11299                    nngateway-mail2news-header-transformation)))
11300 @end lisp
11301
11302 @end table
11303
11304
11305 @end table
11306
11307 So, to use this, simply say something like:
11308
11309 @lisp
11310 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
11311 @end lisp
11312
11313
11314 @node Combined Groups
11315 @section Combined Groups
11316
11317 Gnus allows combining a mixture of all the other group types into bigger
11318 groups.
11319
11320 @menu
11321 * Virtual Groups::     Combining articles from many groups.
11322 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
11323 @end menu
11324
11325
11326 @node Virtual Groups
11327 @subsection Virtual Groups
11328 @cindex nnvirtual
11329 @cindex virtual groups
11330 @cindex merging groups
11331
11332 An @dfn{nnvirtual group} is really nothing more than a collection of
11333 other groups.
11334
11335 For instance, if you are tired of reading many small groups, you can
11336 put them all in one big group, and then grow tired of reading one
11337 big, unwieldy group.  The joys of computing!
11338
11339 You specify @code{nnvirtual} as the method.  The address should be a
11340 regexp to match component groups.
11341
11342 All marks in the virtual group will stick to the articles in the
11343 component groups.  So if you tick an article in a virtual group, the
11344 article will also be ticked in the component group from whence it came.
11345 (And vice versa---marks from the component groups will also be shown in
11346 the virtual group.)
11347
11348 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
11349 newsgroups into one, big, happy newsgroup:
11350
11351 @lisp
11352 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11353 @end lisp
11354
11355 The component groups can be native or foreign; everything should work
11356 smoothly, but if your computer explodes, it was probably my fault.
11357
11358 Collecting the same group from several servers might actually be a good
11359 idea if users have set the Distribution header to limit distribution.
11360 If you would like to read @samp{soc.motss} both from a server in Japan
11361 and a server in Norway, you could use the following as the group regexp:
11362
11363 @example
11364 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
11365 @end example
11366
11367 (Remember, though, that if you're creating the group with @kbd{G m}, you
11368 shouldn't double the backslashes, and you should leave off the quote
11369 characters at the beginning and the end of the string.)
11370
11371 This should work kinda smoothly---all articles from both groups should
11372 end up in this one, and there should be no duplicates.  Threading (and
11373 the rest) will still work as usual, but there might be problems with the
11374 sequence of articles.  Sorting on date might be an option here
11375 (@pxref{Selecting a Group}).
11376
11377 One limitation, however---all groups included in a virtual
11378 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
11379 zombie groups can't be component groups for @code{nnvirtual} groups.
11380
11381 @vindex nnvirtual-always-rescan
11382 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11383 @code{nnvirtual} will always scan groups for unread articles when
11384 entering a virtual group.  If this variable is @code{nil} (which is the
11385 default) and you read articles in a component group after the virtual
11386 group has been activated, the read articles from the component group
11387 will show up when you enter the virtual group.  You'll also see this
11388 effect if you have two virtual groups that have a component group in
11389 common.  If that's the case, you should set this variable to @code{t}.
11390 Or you can just tap @code{M-g} on the virtual group every time before
11391 you enter it---it'll have much the same effect.
11392
11393 @code{nnvirtual} can have both mail and news groups as component groups.
11394 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
11395 has to ask the backend of the component group the article comes from
11396 whether it is a news or mail backend.  However, when you do a @kbd{^},
11397 there is typically no sure way for the component backend to know this,
11398 and in that case @code{nnvirtual} tells Gnus that the article came from a
11399 not-news backend.  (Just to be on the safe side.)
11400
11401 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
11402 line from the article you respond to in these cases.
11403
11404
11405
11406 @node Kibozed Groups
11407 @subsection Kibozed Groups
11408 @cindex nnkiboze
11409 @cindex kibozing
11410
11411 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11412 the news feed''.  @code{nnkiboze} is a backend that will do this for
11413 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
11414 with useless requests!  Oh happiness!
11415
11416 @kindex G k (Group)
11417 To create a kibozed group, use the @kbd{G k} command in the group
11418 buffer.
11419
11420 The address field of the @code{nnkiboze} method is, as with
11421 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11422 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
11423 and @code{nnvirtual} end.
11424
11425 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11426 must have a score file to say what articles are to be included in
11427 the group (@pxref{Scoring}).
11428
11429 @kindex M-x nnkiboze-generate-groups
11430 @findex nnkiboze-generate-groups
11431 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11432 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
11433 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
11434 all the articles in all the component groups and run them through the
11435 scoring process to determine if there are any articles in the groups
11436 that are to be part of the @code{nnkiboze} groups.
11437
11438 Please limit the number of component groups by using restrictive
11439 regexps.  Otherwise your sysadmin may become annoyed with you, and the
11440 @sc{nntp} site may throw you off and never let you back in again.
11441 Stranger things have happened.
11442
11443 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11444 and they can be foreign.  No restrictions.
11445
11446 @vindex nnkiboze-directory
11447 The generation of an @code{nnkiboze} group means writing two files in
11448 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
11449 contains the @sc{nov} header lines for all the articles in the group,
11450 and the other is an additional @file{.newsrc} file to store information
11451 on what groups have been searched through to find component articles.
11452
11453 Articles marked as read in the @code{nnkiboze} group will have
11454 their @sc{nov} lines removed from the @sc{nov} file.
11455
11456
11457 @node Gnus Unplugged
11458 @section Gnus Unplugged
11459 @cindex offline
11460 @cindex unplugged
11461 @cindex Agent
11462 @cindex Gnus Agent
11463 @cindex Gnus Unplugged
11464
11465 In olden times (ca. February '88), people used to run their newsreaders
11466 on big machines with permanent connections to the net.  News transport
11467 was dealt with by news servers, and all the newsreaders had to do was to
11468 read news.  Believe it or not.
11469
11470 Nowadays most people read news and mail at home, and use some sort of
11471 modem to connect to the net.  To avoid running up huge phone bills, it
11472 would be nice to have a way to slurp down all the news and mail, hang up
11473 the phone, read for several hours, and then upload any responses you
11474 have to make.  And then you repeat the procedure.
11475
11476 Of course, you can use news servers for doing this as well.  I've used
11477 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11478 for some years, but doing that's a bore.  Moving the news server
11479 functionality up to the newsreader makes sense if you're the only person
11480 reading news on a machine.
11481
11482 Using Gnus as an ``offline'' newsreader is quite simple.
11483
11484 @itemize @bullet
11485 @item
11486 First, set up Gnus as you would do if you were running it on a machine
11487 that has full connection to the net.  Go ahead.  I'll still be waiting
11488 here.
11489
11490 @item
11491 Then, put the following magical incantation at the end of your
11492 @file{.gnus.el} file:
11493
11494 @lisp
11495 (gnus-agentize)
11496 @end lisp
11497 @end itemize
11498
11499 That's it.  Gnus is now an ``offline'' newsreader.
11500
11501 Of course, to use it as such, you have to learn a few new commands.
11502
11503 @menu
11504 * Agent Basics::           How it all is supposed to work.
11505 * Agent Categories::       How to tell the Gnus Agent what to download.
11506 * Agent Commands::         New commands for all the buffers.
11507 * Agent Expiry::           How to make old articles go away.
11508 * Outgoing Messages::      What happens when you post/mail something?
11509 * Agent Variables::        Customizing is fun.
11510 * Example Setup::          An example @file{.gnus.el} file for offline people.
11511 * Batching Agents::        How to fetch news from a @code{cron} job.
11512 * Agent Caveats::          What you think it'll do and what it does.
11513 @end menu
11514
11515
11516 @node Agent Basics
11517 @subsection Agent Basics
11518
11519 First, let's get some terminology out of the way.
11520
11521 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11522 connection to the net (and notified the Agent that this is the case).
11523 When the connection to the net is up again (and Gnus knows this), the
11524 Agent is @dfn{plugged}.
11525
11526 The @dfn{local} machine is the one you're running on, and which isn't
11527 connected to the net continuously.
11528
11529 @dfn{Downloading} means fetching things from the net to your local
11530 machine.  @dfn{Uploading} is doing the opposite.
11531
11532 Let's take a typical Gnus session using the Agent.
11533
11534 @itemize @bullet
11535
11536 @item
11537 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
11538 Agent in a disconnected state.  You can read all the news that you have
11539 already fetched while in this mode.
11540
11541 @item
11542 You then decide to see whether any new news has arrived.  You connect
11543 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11544 to make Gnus become @dfn{plugged}.
11545
11546 @item
11547 You can then read the new news immediately, or you can download the news
11548 onto your local machine.  If you want to do the latter, you press @kbd{J
11549 s} to fetch all the eligible articles in all the groups.  (To let Gnus
11550 know which articles you want to download, @pxref{Agent Categories}.)
11551
11552 @item
11553 After fetching the articles, you press @kbd{J j} to make Gnus become
11554 unplugged again, and you shut down the PPP thing (or whatever).  And
11555 then you read the news offline.
11556
11557 @item
11558 And then you go to step 2.
11559 @end itemize
11560
11561 Here are some things you should do the first time (or so) that you use
11562 the Agent.
11563
11564 @itemize @bullet
11565
11566 @item
11567 Decide which servers should be covered by the Agent.  If you have a mail
11568 backend, it would probably be nonsensical to have it covered by the
11569 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
11570 @kbd{J a} the server (or servers) that you wish to have covered by the
11571 Agent (@pxref{Server Agent Commands}).  This will typically be only the
11572 primary select method, which is listed on the bottom in the buffer.
11573
11574 @item
11575 Decide on download policy.  @xref{Agent Categories}.
11576
11577 @item
11578 Uhm... that's it.
11579 @end itemize
11580
11581
11582 @node Agent Categories
11583 @subsection Agent Categories
11584
11585 One of the main reasons to integrate the news transport layer into the
11586 newsreader is to allow greater control over what articles to download.
11587 There's not much point in downloading huge amounts of articles, just to
11588 find out that you're not interested in reading any of them.  It's better
11589 to be somewhat more conservative in choosing what to download, and then
11590 mark the articles for downloading manually if it should turn out that
11591 you're interested in the articles anyway.
11592
11593 The main way to control what is to be downloaded is to create a
11594 @dfn{category} and then assign some (or all) groups to this category.
11595 Gnus has its own buffer for creating and managing categories.
11596
11597 @menu
11598 * Category Syntax::       What a category looks like.
11599 * The Category Buffer::   A buffer for maintaining categories.
11600 * Category Variables::    Customize'r'Us.
11601 @end menu
11602
11603
11604 @node Category Syntax
11605 @subsubsection Category Syntax
11606
11607 A category consists of two things.
11608
11609 @enumerate
11610 @item
11611 A predicate which (generally) gives a rough outline of which articles
11612 are eligible for downloading; and
11613
11614 @item
11615 a score rule which (generally) gives you a finer granularity when
11616 deciding what articles to download.  (Note that this @dfn{download
11617 score} is not necessarily related to normal scores.)
11618 @end enumerate
11619
11620 A predicate in its simplest form can be a single predicate such as
11621 @code{true} or @code{false}. These two will download every available
11622 article or nothing respectively. In the case of these two special
11623 predicates an additional score rule is superfluous.
11624
11625 Predicates of @code{high} or @code{low} download articles in respect of
11626 their scores in relationship to @code{gnus-agent-high-score} and
11627 @code{gnus-agent-low-score} as descibed below.
11628
11629 To gain even finer control of what is to be regarded eligible for
11630 download a predicate can consist of a number of predicates with logical
11631 operators sprinkled in between.
11632
11633 Perhaps some examples are in order.
11634
11635 Here's a simple predicate.  (It's the default predicate, in fact, used
11636 for all groups that don't belong to any other category.)
11637
11638 @lisp
11639 short
11640 @end lisp
11641
11642 Quite simple, eh?  This predicate is true if and only if the article is
11643 short (for some value of ``short'').
11644
11645 Here's a more complex predicate:
11646
11647 @lisp
11648 (or high
11649     (and
11650      (not low)
11651      (not long)))
11652 @end lisp
11653
11654 This means that an article should be downloaded if it has a high score,
11655 or if the score is not low and the article is not long.  You get the
11656 drift.
11657
11658 The available logical operators are @code{or}, @code{and} and
11659 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
11660 @samp{|}, @code{&} and @code{!} instead.)
11661
11662 The following predicates are pre-defined, but if none of these fit what
11663 you want to do, you can write your own.
11664
11665 @table @code
11666 @item short
11667 True iff the article is shorter than @code{gnus-agent-short-article}
11668 lines; default 100.
11669
11670 @item long
11671 True iff the article is longer than @code{gnus-agent-long-article}
11672 lines; default 200.
11673
11674 @item low
11675 True iff the article has a download score less than
11676 @code{gnus-agent-low-score}; default 0.
11677
11678 @item high
11679 True iff the article has a download score greater than
11680 @code{gnus-agent-high-score}; default 0.
11681
11682 @item spam
11683 True iff the Gnus Agent guesses that the article is spam.  The
11684 heuristics may change over time, but at present it just computes a
11685 checksum and sees whether articles match.
11686
11687 @item true
11688 Always true.
11689
11690 @item false
11691 Always false.
11692 @end table
11693
11694 If you want to create your own predicate function, here's what you have
11695 to know:  The functions are called with no parameters, but the
11696 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11697 useful values.
11698
11699 For example, you could decide that you don't want to download articles
11700 that were posted more than a certain number of days ago (e.g. posted
11701 more than @code{gnus-agent-expire-days} ago) you might write a function
11702 something along the lines of the following:
11703
11704 @lisp
11705 (defun my-article-old-p ()
11706   "Say whether an article is old."
11707   (< (time-to-day (date-to-time (mail-header-date gnus-headers)))
11708      (- (time-to-day (current-time)) gnus-agent-expire-days)))
11709 @end lisp
11710
11711 with the predicate then defined as:
11712
11713 @lisp
11714 (not my-article-old-p)
11715 @end lisp
11716
11717 or you could append your predicate to the predefined
11718 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
11719 wherever.  (Note: this would have to be at a point *after*
11720 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})   
11721
11722 @lisp
11723 (defvar  gnus-category-predicate-alist
11724   (append gnus-category-predicate-alist
11725          '((old . my-article-old-p))))
11726 @end lisp
11727
11728 and simply specify your predicate as:
11729
11730 @lisp
11731 (not old)
11732 @end lisp
11733
11734 If/when using something like the above, be aware that there are many
11735 misconfigured systems/mailers out there and so an article's date is not
11736 always a reliable indication of when it was posted. Hell, some people
11737 just don't give a damm.
11738
11739
11740 The above predicates apply to *all* the groups which belong to the
11741 category. However, if you wish to have a specific predicate for an
11742 individual group within a category, or you're just too lazy to set up a
11743 new category, you can enter a group's individual predicate in it's group 
11744 parameters like so:
11745
11746 @lisp
11747 (agent-predicate . short)
11748 @end lisp
11749
11750 This is the group parameter equivalent of the agent category
11751 default. Note that when specifying a single word predicate like this,
11752 the @code{agent-predicate} specification must be in dotted pair
11753 notation.
11754
11755 The equivalent of the longer example from above would be:
11756
11757 @lisp
11758 (agent-predicate or high (and (not low) (not long)))
11759 @end lisp
11760
11761 The outer parenthesis required in the category specification are not
11762 entered here as, not being in dotted pair notation, the value of the
11763 predicate is assumed to be a list. 
11764  
11765
11766 Now, the syntax of the download score is the same as the syntax of
11767 normal score files, except that all elements that require actually
11768 seeing the article itself are verboten.  This means that only the
11769 following headers can be scored on: @code{Subject}, @code{From},
11770 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
11771 @code{Lines}, and @code{Xref}.
11772
11773 As with predicates, the specification of the @code{download score rule}
11774 to use in respect of a group can be in either the category definition if
11775 it's to be applicable to all groups in therein, or a group's parameters
11776 if it's to be specific to that group.
11777
11778 In both of these places the @code{download score rule} can take one of
11779 three forms:
11780
11781 @enumerate
11782 @item 
11783 Score rule
11784
11785 This has the same syntax as a normal gnus score file except only a
11786 subset of scoring keywords are available as mentioned above.
11787
11788 example:
11789
11790 @itemize @bullet
11791 @item 
11792 Category specification
11793
11794 @lisp
11795 (("from"        
11796        ("Lars Ingebrigtsen" 1000000 nil s))
11797 ("lines"
11798        (500 -100 nil <)))
11799 @end lisp
11800
11801 @item 
11802 Group Parameter specification
11803
11804 @lisp
11805 (agent-score ("from"        
11806                    ("Lars Ingebrigtsen" 1000000 nil s))
11807              ("lines"
11808                    (500 -100 nil <)))
11809 @end lisp
11810
11811 Again, note the omission of the outermost parenthesis here.
11812 @end itemize
11813
11814 @item 
11815 Agent score file
11816
11817 These score files must *only* contain the permitted scoring keywords
11818 stated above.
11819
11820 example:
11821
11822 @itemize @bullet
11823 @item 
11824 Category specification
11825
11826 @lisp
11827 ("~/News/agent.SCORE")
11828 @end lisp
11829
11830 or perhaps
11831
11832 @lisp
11833 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
11834 @end lisp
11835
11836 @item 
11837 Group Parameter specification
11838
11839 @lisp
11840 (agent-score "~/News/agent.SCORE")
11841 @end lisp
11842
11843 Additional score files can be specified as above. Need I say anything
11844 about parenthesis.
11845 @end itemize
11846
11847 @item 
11848 Use @code{normal} score files
11849
11850 If you dont want to maintain two sets of scoring rules for a group, and
11851 your desired @code{downloading} criteria for a group are the same as your
11852 @code{reading} criteria then you can tell the agent to refer to your
11853 @code{normal} score files when deciding what to download.
11854
11855 These directives in either the category definition or a group's
11856 parameters will cause the agent to read in all the applicable score
11857 files for a group, *filtering out* those those sections that do not
11858 relate to one of the permitted subset of scoring keywords.
11859
11860 @itemize @bullet
11861 @item 
11862 Category Specification
11863
11864 @lisp
11865 file
11866 @end lisp
11867
11868 @item 
11869 Group Parameter specification
11870
11871 @lisp
11872 (agent-score . file)
11873 @end lisp
11874 @end itemize
11875 @end enumerate
11876  
11877 @node The Category Buffer
11878 @subsubsection The Category Buffer
11879
11880 You'd normally do all category maintenance from the category buffer.
11881 When you enter it for the first time (with the @kbd{J c} command from
11882 the group buffer), you'll only see the @code{default} category.
11883
11884 The following commands are available in this buffer:
11885
11886 @table @kbd
11887 @item q
11888 @kindex q (Category)
11889 @findex gnus-category-exit
11890 Return to the group buffer (@code{gnus-category-exit}).
11891
11892 @item k
11893 @kindex k (Category)
11894 @findex gnus-category-kill
11895 Kill the current category (@code{gnus-category-kill}).
11896
11897 @item c
11898 @kindex c (Category)
11899 @findex gnus-category-copy
11900 Copy the current category (@code{gnus-category-copy}).
11901
11902 @item a
11903 @kindex a (Category)
11904 @findex gnus-category-add
11905 Add a new category (@code{gnus-category-add}).
11906
11907 @item p
11908 @kindex p (Category)
11909 @findex gnus-category-edit-predicate
11910 Edit the predicate of the current category
11911 (@code{gnus-category-edit-predicate}).
11912
11913 @item g
11914 @kindex g (Category)
11915 @findex gnus-category-edit-groups
11916 Edit the list of groups belonging to the current category
11917 (@code{gnus-category-edit-groups}).
11918
11919 @item s
11920 @kindex s (Category)
11921 @findex gnus-category-edit-score
11922 Edit the download score rule of the current category
11923 (@code{gnus-category-edit-score}).
11924
11925 @item l
11926 @kindex l (Category)
11927 @findex gnus-category-list
11928 List all the categories (@code{gnus-category-list}).
11929 @end table
11930
11931
11932 @node Category Variables
11933 @subsubsection Category Variables
11934
11935 @table @code
11936 @item gnus-category-mode-hook
11937 @vindex gnus-category-mode-hook
11938 Hook run in category buffers.
11939
11940 @item gnus-category-line-format
11941 @vindex gnus-category-line-format
11942 Format of the lines in the category buffer (@pxref{Formatting
11943 Variables}).  Valid elements are:
11944
11945 @table @samp
11946 @item c
11947 The name of the category.
11948
11949 @item g
11950 The number of groups in the category.
11951 @end table
11952
11953 @item gnus-category-mode-line-format
11954 @vindex gnus-category-mode-line-format
11955 Format of the category mode line (@pxref{Mode Line Formatting}).
11956
11957 @item gnus-agent-short-article
11958 @vindex gnus-agent-short-article
11959 Articles that have fewer lines than this are short.  Default 100.
11960
11961 @item gnus-agent-long-article
11962 @vindex gnus-agent-long-article
11963 Articles that have more lines than this are long.  Default 200.
11964
11965 @item gnus-agent-low-score
11966 @vindex gnus-agent-low-score
11967 Articles that have a score lower than this have a low score.  Default
11968 0.
11969
11970 @item gnus-agent-high-score
11971 @vindex gnus-agent-high-score
11972 Articles that have a score higher than this have a high score.  Default
11973 0.
11974
11975 @end table
11976
11977
11978 @node Agent Commands
11979 @subsection Agent Commands
11980
11981 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
11982 (@code{gnus-agent-toggle-plugged} command works in all modes, and
11983 toggles the plugged/unplugged state of the Gnus Agent.
11984
11985
11986 @menu
11987 * Group Agent Commands::
11988 * Summary Agent Commands::
11989 * Server Agent Commands::
11990 @end menu
11991
11992 You can run a complete batch fetch from the command line with the
11993 following incantation:
11994
11995 @cindex gnus-agent-batch-fetch
11996 @example
11997 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
11998 @end example
11999
12000
12001
12002 @node Group Agent Commands
12003 @subsubsection Group Agent Commands
12004
12005 @table @kbd
12006 @item J u
12007 @kindex J u (Agent Group)
12008 @findex gnus-agent-fetch-groups
12009 Fetch all eligible articles in the current group
12010 (@code{gnus-agent-fetch-groups}).
12011
12012 @item J c
12013 @kindex J c (Agent Group)
12014 @findex gnus-enter-category-buffer
12015 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12016
12017 @item J s
12018 @kindex J s (Agent Group)
12019 @findex gnus-agent-fetch-session
12020 Fetch all eligible articles in all groups
12021 (@code{gnus-agent-fetch-session}).
12022
12023 @item J S
12024 @kindex J S (Agent Group)
12025 @findex gnus-group-send-drafts
12026 Send all sendable messages in the draft group
12027 (@code{gnus-agent-fetch-session}).  @xref{Drafts}.
12028
12029 @item J a
12030 @kindex J a (Agent Group)
12031 @findex gnus-agent-add-group
12032 Add the current group to an Agent category
12033 (@code{gnus-agent-add-group}).
12034
12035 @end table
12036
12037
12038 @node Summary Agent Commands
12039 @subsubsection Summary Agent Commands
12040
12041 @table @kbd
12042 @item J #
12043 @kindex J # (Agent Summary)
12044 @findex gnus-agent-mark-article
12045 Mark the article for downloading (@code{gnus-agent-mark-article}).
12046
12047 @item J M-#
12048 @kindex J M-# (Agent Summary)
12049 @findex gnus-agent-unmark-article
12050 Remove the downloading mark from the article
12051 (@code{gnus-agent-unmark-article}).
12052
12053 @item @@ 
12054 @kindex @@ (Agent Summary)
12055 @findex gnus-agent-toggle-mark
12056 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12057
12058 @item J c
12059 @kindex J c (Agent Summary)
12060 @findex gnus-agent-catchup
12061 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12062
12063 @end table
12064
12065
12066 @node Server Agent Commands
12067 @subsubsection Server Agent Commands
12068
12069 @table @kbd
12070 @item J a
12071 @kindex J a (Agent Server)
12072 @findex gnus-agent-add-server
12073 Add the current server to the list of servers covered by the Gnus Agent
12074 (@code{gnus-agent-add-server}).
12075
12076 @item J r
12077 @kindex J r (Agent Server)
12078 @findex gnus-agent-remove-server
12079 Remove the current server from the list of servers covered by the Gnus
12080 Agent (@code{gnus-agent-remove-server}).
12081
12082 @end table
12083
12084
12085 @node Agent Expiry
12086 @subsection Agent Expiry
12087
12088 @vindex gnus-agent-expire-days
12089 @findex gnus-agent-expire
12090 @kindex M-x gnus-agent-expire
12091 @cindex Agent expiry
12092 @cindex Gnus Agent expiry
12093 @cindex expiry
12094
12095 @code{nnagent} doesn't handle expiry.  Instead, there's a special
12096 @code{gnus-agent-expire} command that will expire all read articles that
12097 are older than @code{gnus-agent-expire-days} days.  It can be run
12098 whenever you feel that you're running out of space.  It's not
12099 particularly fast or efficient, and it's not a particularly good idea to
12100 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12101
12102 @vindex gnus-agent-expire-all
12103 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12104 expire all articles---unread, read, ticked and dormant.  If @code{nil}
12105 (which is the default), only read articles are eligible for expiry, and
12106 unread, ticked and dormant articles will be kept indefinitely.
12107
12108
12109 @node Outgoing Messages
12110 @subsection Outgoing Messages
12111
12112 When Gnus is unplugged, all outgoing messages (both mail and news) are
12113 stored in the draft groups (@pxref{Drafts}).  You can view them there
12114 after posting, and edit them at will.
12115
12116 When Gnus is plugged again, you can send the messages either from the
12117 draft group with the special commands available there, or you can use
12118 the @kbd{J S} command in the group buffer to send all the sendable
12119 messages in the draft group.
12120
12121
12122
12123 @node Agent Variables
12124 @subsection Agent Variables
12125
12126 @table @code
12127 @item gnus-agent-directory
12128 @vindex gnus-agent-directory
12129 Where the Gnus Agent will store its files.  The default is
12130 @file{~/News/agent/}.
12131
12132 @item gnus-agent-handle-level
12133 @vindex gnus-agent-handle-level
12134 Groups on levels (@pxref{Group Levels}) higher than this variable will
12135 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
12136 which means that only subscribed group will be considered by the Agent
12137 by default.
12138
12139 @item gnus-agent-plugged-hook
12140 @vindex gnus-agent-plugged-hook
12141 Hook run when connecting to the network.
12142
12143 @item gnus-agent-unplugged-hook
12144 @vindex gnus-agent-unplugged-hook
12145 Hook run when disconnecting from the network.
12146
12147 @end table
12148
12149
12150 @node Example Setup
12151 @subsection Example Setup
12152
12153 If you don't want to read this manual, and you have a fairly standard
12154 setup, you may be able to use something like the following as your
12155 @file{.gnus.el} file to get started.
12156
12157 @lisp
12158 ;;; Define how Gnus is to fetch news.  We do this over NNTP
12159 ;;; from your ISP's server.
12160 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
12161
12162 ;;; Define how Gnus is to read your mail.  We read mail from
12163 ;;; your ISP's POP server.
12164 (setenv "MAILHOST" "pop.your-isp.com")
12165 (setq nnmail-spool-file "po:username")
12166
12167 ;;; Say how Gnus is to store the mail.  We use nnml groups.
12168 (setq gnus-secondary-select-methods '((nnml "")))
12169
12170 ;;; Make Gnus into an offline newsreader.
12171 (gnus-agentize)
12172 @end lisp
12173
12174 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
12175 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12176 gnus}.
12177
12178 If this is the first time you've run Gnus, you will be subscribed
12179 automatically to a few default newsgroups.  You'll probably want to
12180 subscribe to more groups, and to do that, you have to query the
12181 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12182 command.  This usually takes quite a while, but you only have to do it
12183 once.
12184
12185 After reading and parsing a while, you'll be presented with a list of
12186 groups.  Subscribe to the ones you want to read with the @kbd{u}
12187 command.  @kbd{l} to make all the killed groups disappear after you've
12188 subscribe to all the groups you want to read.  (@kbd{A k} will bring
12189 back all the killed groups.)
12190
12191 You can now read the groups at once, or you can download the articles
12192 with the @kbd{J s} command.  And then read the rest of this manual to
12193 find out which of the other gazillion things you want to customize.
12194
12195
12196 @node Batching Agents
12197 @subsection Batching Agents
12198
12199 Having the Gnus Agent fetch articles (and post whatever messages you've
12200 written) is quite easy once you've gotten things set up properly.  The
12201 following shell script will do everything that is necessary:
12202
12203 @example
12204 #!/bin/sh
12205 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
12206 @end example
12207
12208
12209 @node Agent Caveats
12210 @subsection Agent Caveats
12211
12212 The Gnus Agent doesn't seem to work like most other offline
12213 newsreaders.  Here are some common questions that some imaginary people
12214 may ask:
12215
12216 @table @dfn
12217 @item If I read an article while plugged, do they get entered into the
12218 Agent?
12219
12220 @strong{No.}
12221
12222 @item If I read an article while plugged, and the article already exists
12223 in the Agent, will it get downloaded once more?
12224
12225 @strong{Yes.}
12226
12227 @end table
12228
12229 In short, when Gnus is unplugged, it only looks into the locally stored
12230 articles; when it's plugged, it only talks to your ISP.
12231
12232
12233 @node Scoring
12234 @chapter Scoring
12235 @cindex scoring
12236
12237 Other people use @dfn{kill files}, but we here at Gnus Towers like
12238 scoring better than killing, so we'd rather switch than fight.  They do
12239 something completely different as well, so sit up straight and pay
12240 attention!
12241
12242 @vindex gnus-summary-mark-below
12243 All articles have a default score (@code{gnus-summary-default-score}),
12244 which is 0 by default.  This score may be raised or lowered either
12245 interactively or by score files.  Articles that have a score lower than
12246 @code{gnus-summary-mark-below} are marked as read.
12247
12248 Gnus will read any @dfn{score files} that apply to the current group
12249 before generating the summary buffer.
12250
12251 There are several commands in the summary buffer that insert score
12252 entries based on the current article.  You can, for instance, ask Gnus to
12253 lower or increase the score of all articles with a certain subject.
12254
12255 There are two sorts of scoring entries: Permanent and temporary.
12256 Temporary score entries are self-expiring entries.  Any entries that are
12257 temporary and have not been used for, say, a week, will be removed
12258 silently to help keep the sizes of the score files down.
12259
12260 @menu
12261 * Summary Score Commands::   Adding score entries for the current group.
12262 * Group Score Commands::     General score commands.
12263 * Score Variables::          Customize your scoring.  (My, what terminology).
12264 * Score File Format::        What a score file may contain.
12265 * Score File Editing::       You can edit score files by hand as well.
12266 * Adaptive Scoring::         Big Sister Gnus knows what you read.
12267 * Home Score File::          How to say where new score entries are to go.
12268 * Followups To Yourself::    Having Gnus notice when people answer you.
12269 * Scoring Tips::             How to score effectively.
12270 * Reverse Scoring::          That problem child of old is not problem.
12271 * Global Score Files::       Earth-spanning, ear-splitting score files.
12272 * Kill Files::               They are still here, but they can be ignored.
12273 * Converting Kill Files::    Translating kill files to score files.
12274 * GroupLens::                Getting predictions on what you like to read.
12275 * Advanced Scoring::         Using logical expressions to build score rules.
12276 * Score Decays::             It can be useful to let scores wither away.
12277 @end menu
12278
12279
12280 @node Summary Score Commands
12281 @section Summary Score Commands
12282 @cindex score commands
12283
12284 The score commands that alter score entries do not actually modify real
12285 score files.  That would be too inefficient.  Gnus maintains a cache of
12286 previously loaded score files, one of which is considered the
12287 @dfn{current score file alist}.  The score commands simply insert
12288 entries into this list, and upon group exit, this list is saved.
12289
12290 The current score file is by default the group's local score file, even
12291 if no such score file actually exists.  To insert score commands into
12292 some other score file (e.g. @file{all.SCORE}), you must first make this
12293 score file the current one.
12294
12295 General score commands that don't actually change the score file:
12296
12297 @table @kbd
12298
12299 @item V s
12300 @kindex V s (Summary)
12301 @findex gnus-summary-set-score
12302 Set the score of the current article (@code{gnus-summary-set-score}).
12303
12304 @item V S
12305 @kindex V S (Summary)
12306 @findex gnus-summary-current-score
12307 Display the score of the current article
12308 (@code{gnus-summary-current-score}).
12309
12310 @item V t
12311 @kindex V t (Summary)
12312 @findex gnus-score-find-trace
12313 Display all score rules that have been used on the current article
12314 (@code{gnus-score-find-trace}).
12315
12316 @item V R
12317 @kindex V R (Summary)
12318 @findex gnus-summary-rescore
12319 Run the current summary through the scoring process
12320 (@code{gnus-summary-rescore}).  This might be useful if you're playing
12321 around with your score files behind Gnus' back and want to see the
12322 effect you're having.
12323
12324 @item V c
12325 @kindex V c (Summary)
12326 @findex gnus-score-change-score-file
12327 Make a different score file the current
12328 (@code{gnus-score-change-score-file}).
12329
12330 @item V e
12331 @kindex V e (Summary)
12332 @findex gnus-score-edit-current-scores
12333 Edit the current score file (@code{gnus-score-edit-current-scores}).
12334 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
12335 File Editing}).
12336
12337 @item V f
12338 @kindex V f (Summary)
12339 @findex gnus-score-edit-file
12340 Edit a score file and make this score file the current one
12341 (@code{gnus-score-edit-file}).
12342
12343 @item V F
12344 @kindex V F (Summary)
12345 @findex gnus-score-flush-cache
12346 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
12347 after editing score files.
12348
12349 @item V C
12350 @kindex V C (Summary)
12351 @findex gnus-score-customize
12352 Customize a score file in a visually pleasing manner
12353 (@code{gnus-score-customize}).
12354
12355 @end table
12356
12357 The rest of these commands modify the local score file.
12358
12359 @table @kbd
12360
12361 @item V m
12362 @kindex V m (Summary)
12363 @findex gnus-score-set-mark-below
12364 Prompt for a score, and mark all articles with a score below this as
12365 read (@code{gnus-score-set-mark-below}).
12366
12367 @item V x
12368 @kindex V x (Summary)
12369 @findex gnus-score-set-expunge-below
12370 Prompt for a score, and add a score rule to the current score file to
12371 expunge all articles below this score
12372 (@code{gnus-score-set-expunge-below}).
12373 @end table
12374
12375 The keystrokes for actually making score entries follow a very regular
12376 pattern, so there's no need to list all the commands.  (Hundreds of
12377 them.)
12378
12379 @findex gnus-summary-increase-score
12380 @findex gnus-summary-lower-score
12381
12382 @enumerate
12383 @item
12384 The first key is either @kbd{I} (upper case i) for increasing the score
12385 or @kbd{L} for lowering the score.
12386 @item
12387 The second key says what header you want to score on.  The following
12388 keys are available:
12389 @table @kbd
12390
12391 @item a
12392 Score on the author name.
12393
12394 @item s
12395 Score on the subject line.
12396
12397 @item x
12398 Score on the Xref line---i.e., the cross-posting line.
12399
12400 @item r
12401 Score on the References line.
12402
12403 @item d
12404 Score on the date.
12405
12406 @item l
12407 Score on the number of lines.
12408
12409 @item i
12410 Score on the Message-ID.
12411
12412 @item f
12413 Score on followups.
12414
12415 @item b
12416 Score on the body.
12417
12418 @item h
12419 Score on the head.
12420
12421 @item t
12422 Score on thead.
12423
12424 @end table
12425
12426 @item
12427 The third key is the match type.  Which match types are valid depends on
12428 what headers you are scoring on.
12429
12430 @table @code
12431
12432 @item strings
12433
12434 @table @kbd
12435
12436 @item e
12437 Exact matching.
12438
12439 @item s
12440 Substring matching.
12441
12442 @item f
12443 Fuzzy matching (@pxref{Fuzzy Matching}).
12444
12445 @item r
12446 Regexp matching
12447 @end table
12448
12449 @item date
12450 @table @kbd
12451
12452 @item b
12453 Before date.
12454
12455 @item a
12456 After date.
12457
12458 @item n
12459 This date.
12460 @end table
12461
12462 @item number
12463 @table @kbd
12464
12465 @item <
12466 Less than number.
12467
12468 @item =
12469 Equal to number.
12470
12471 @item >
12472 Greater than number.
12473 @end table
12474 @end table
12475
12476 @item
12477 The fourth and final key says whether this is a temporary (i.e., expiring)
12478 score entry, or a permanent (i.e., non-expiring) score entry, or whether
12479 it is to be done immediately, without adding to the score file.
12480 @table @kbd
12481
12482 @item t
12483 Temporary score entry.
12484
12485 @item p
12486 Permanent score entry.
12487
12488 @item i
12489 Immediately scoring.
12490 @end table
12491
12492 @end enumerate
12493
12494 So, let's say you want to increase the score on the current author with
12495 exact matching permanently: @kbd{I a e p}.  If you want to lower the
12496 score based on the subject line, using substring matching, and make a
12497 temporary score entry: @kbd{L s s t}.  Pretty easy.
12498
12499 To make things a bit more complicated, there are shortcuts.  If you use
12500 a capital letter on either the second or third keys, Gnus will use
12501 defaults for the remaining one or two keystrokes.  The defaults are
12502 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
12503 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
12504
12505 These functions take both the numerical prefix and the symbolic prefix
12506 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
12507 (or increase) the score of the article.  A symbolic prefix of @code{a}
12508 says to use the @file{all.SCORE} file for the command instead of the
12509 current score file.
12510
12511 @vindex gnus-score-mimic-keymap
12512 The @code{gnus-score-mimic-keymap} says whether these commands will
12513 pretend they are keymaps or not.
12514
12515
12516 @node Group Score Commands
12517 @section Group Score Commands
12518 @cindex group score commands
12519
12520 There aren't many of these as yet, I'm afraid.
12521
12522 @table @kbd
12523
12524 @item W f
12525 @kindex W f (Group)
12526 @findex gnus-score-flush-cache
12527 Gnus maintains a cache of score alists to avoid having to reload them
12528 all the time.  This command will flush the cache
12529 (@code{gnus-score-flush-cache}).
12530
12531 @end table
12532
12533 You can do scoring from the command line by saying something like:
12534
12535 @findex gnus-batch-score
12536 @cindex batch scoring
12537 @example
12538 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
12539 @end example
12540
12541
12542 @node Score Variables
12543 @section Score Variables
12544 @cindex score variables
12545
12546 @table @code
12547
12548 @item gnus-use-scoring
12549 @vindex gnus-use-scoring
12550 If @code{nil}, Gnus will not check for score files, and will not, in
12551 general, do any score-related work.  This is @code{t} by default.
12552
12553 @item gnus-kill-killed
12554 @vindex gnus-kill-killed
12555 If this variable is @code{nil}, Gnus will never apply score files to
12556 articles that have already been through the kill process.  While this
12557 may save you lots of time, it also means that if you apply a kill file
12558 to a group, and then change the kill file and want to run it over you
12559 group again to kill more articles, it won't work.  You have to set this
12560 variable to @code{t} to do that.  (It is @code{t} by default.)
12561
12562 @item gnus-kill-files-directory
12563 @vindex gnus-kill-files-directory
12564 All kill and score files will be stored in this directory, which is
12565 initialized from the @code{SAVEDIR} environment variable by default.
12566 This is @file{~/News/} by default.
12567
12568 @item gnus-score-file-suffix
12569 @vindex gnus-score-file-suffix
12570 Suffix to add to the group name to arrive at the score file name
12571 (@samp{SCORE} by default.)
12572
12573 @item gnus-score-uncacheable-files
12574 @vindex gnus-score-uncacheable-files
12575 @cindex score cache
12576 All score files are normally cached to avoid excessive re-loading of
12577 score files.  However, if this might make you Emacs grow big and
12578 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
12579 @file{all.SCORE}, while it might be a good idea to not cache
12580 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
12581 variable is @samp{ADAPT$} by default, so no adaptive score files will
12582 be cached.
12583
12584 @item gnus-save-score
12585 @vindex gnus-save-score
12586 If you have really complicated score files, and do lots of batch
12587 scoring, then you might set this variable to @code{t}.  This will make
12588 Gnus save the scores into the @file{.newsrc.eld} file.
12589
12590 @item gnus-score-interactive-default-score
12591 @vindex gnus-score-interactive-default-score
12592 Score used by all the interactive raise/lower commands to raise/lower
12593 score with.  Default is 1000, which may seem excessive, but this is to
12594 ensure that the adaptive scoring scheme gets enough room to play with.
12595 We don't want the small changes from the adaptive scoring to overwrite
12596 manually entered data.
12597
12598 @item gnus-summary-default-score
12599 @vindex gnus-summary-default-score
12600 Default score of an article, which is 0 by default.
12601
12602 @item gnus-summary-expunge-below
12603 @vindex gnus-summary-expunge-below
12604 Don't display the summary lines of articles that have scores lower than
12605 this variable.  This is @code{nil} by default, which means that no
12606 articles will be hidden.  This variable is local to the summary buffers,
12607 and has to be set from @code{gnus-summary-mode-hook}.
12608
12609 @item gnus-score-over-mark
12610 @vindex gnus-score-over-mark
12611 Mark (in the third column) used for articles with a score over the
12612 default.  Default is @samp{+}.
12613
12614 @item gnus-score-below-mark
12615 @vindex gnus-score-below-mark
12616 Mark (in the third column) used for articles with a score below the
12617 default.  Default is @samp{-}.
12618
12619 @item gnus-score-find-score-files-function
12620 @vindex gnus-score-find-score-files-function
12621 Function used to find score files for the current group.  This function
12622 is called with the name of the group as the argument.
12623
12624 Predefined functions available are:
12625 @table @code
12626
12627 @item gnus-score-find-single
12628 @findex gnus-score-find-single
12629 Only apply the group's own score file.
12630
12631 @item gnus-score-find-bnews
12632 @findex gnus-score-find-bnews
12633 Apply all score files that match, using bnews syntax.  This is the
12634 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
12635 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12636 @file{gnu.all.SCORE} would all apply.  In short, the instances of
12637 @samp{all} in the score file names are translated into @samp{.*}, and
12638 then a regexp match is done.
12639
12640 This means that if you have some score entries that you want to apply to
12641 all groups, then you put those entries in the @file{all.SCORE} file.
12642
12643 The score files are applied in a semi-random order, although Gnus will
12644 try to apply the more general score files before the more specific score
12645 files.  It does this by looking at the number of elements in the score
12646 file names---discarding the @samp{all} elements.
12647
12648 @item gnus-score-find-hierarchical
12649 @findex gnus-score-find-hierarchical
12650 Apply all score files from all the parent groups.  This means that you
12651 can't have score files like @file{all.SCORE}, but you can have
12652 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12653
12654 @end table
12655 This variable can also be a list of functions.  In that case, all these
12656 functions will be called, and all the returned lists of score files will
12657 be applied.  These functions can also return lists of score alists
12658 directly.  In that case, the functions that return these non-file score
12659 alists should probably be placed before the ``real'' score file
12660 functions, to ensure that the last score file returned is the local
12661 score file.  Phu.
12662
12663 @item gnus-score-expiry-days
12664 @vindex gnus-score-expiry-days
12665 This variable says how many days should pass before an unused score file
12666 entry is expired.  If this variable is @code{nil}, no score file entries
12667 are expired.  It's 7 by default.
12668
12669 @item gnus-update-score-entry-dates
12670 @vindex gnus-update-score-entry-dates
12671 If this variable is non-@code{nil}, matching score entries will have
12672 their dates updated.  (This is how Gnus controls expiry---all
12673 non-matching entries will become too old while matching entries will
12674 stay fresh and young.)  However, if you set this variable to @code{nil},
12675 even matching entries will grow old and will have to face that oh-so
12676 grim reaper.
12677
12678 @item gnus-score-after-write-file-function
12679 @vindex gnus-score-after-write-file-function
12680 Function called with the name of the score file just written.
12681
12682 @item gnus-score-thread-simplify
12683 @vindex gnus-score-thread-simplify
12684 If this variable is non-@code{nil}, article subjects will be simplified
12685 for subject scoring purposes in the same manner as with
12686 threading---according to the current value of
12687 gnus-simplify-subject-functions.  If the scoring entry uses
12688 @code{substring} or @code{exact} matching, the match will also be
12689 simplified in this manner.
12690
12691 @end table
12692
12693
12694 @node Score File Format
12695 @section Score File Format
12696 @cindex score file format
12697
12698 A score file is an @code{emacs-lisp} file that normally contains just a
12699 single form.  Casual users are not expected to edit these files;
12700 everything can be changed from the summary buffer.
12701
12702 Anyway, if you'd like to dig into it yourself, here's an example:
12703
12704 @lisp
12705 (("from"
12706   ("Lars Ingebrigtsen" -10000)
12707   ("Per Abrahamsen")
12708   ("larsi\\|lmi" -50000 nil R))
12709  ("subject"
12710   ("Ding is Badd" nil 728373))
12711  ("xref"
12712   ("alt.politics" -1000 728372 s))
12713  ("lines"
12714   (2 -100 nil <))
12715  (mark 0)
12716  (expunge -1000)
12717  (mark-and-expunge -10)
12718  (read-only nil)
12719  (orphan -10)
12720  (adapt t)
12721  (files "/hom/larsi/News/gnu.SCORE")
12722  (exclude-files "all.SCORE")
12723  (local (gnus-newsgroup-auto-expire t)
12724         (gnus-summary-make-false-root empty))
12725  (eval (ding)))
12726 @end lisp
12727
12728 This example demonstrates most score file elements.  For a different
12729 approach, see @pxref{Advanced Scoring}.
12730
12731 Even though this looks much like lisp code, nothing here is actually
12732 @code{eval}ed.  The lisp reader is used to read this form, though, so it
12733 has to be valid syntactically, if not semantically.
12734
12735 Six keys are supported by this alist:
12736
12737 @table @code
12738
12739 @item STRING
12740 If the key is a string, it is the name of the header to perform the
12741 match on.  Scoring can only be performed on these eight headers:
12742 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
12743 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
12744 these headers, there are three strings to tell Gnus to fetch the entire
12745 article and do the match on larger parts of the article: @code{Body}
12746 will perform the match on the body of the article, @code{Head} will
12747 perform the match on the head of the article, and @code{All} will
12748 perform the match on the entire article.  Note that using any of these
12749 last three keys will slow down group entry @emph{considerably}.  The
12750 final ``header'' you can score on is @code{Followup}.  These score
12751 entries will result in new score entries being added for all follow-ups
12752 to articles that matches these score entries.
12753
12754 Following this key is a arbitrary number of score entries, where each
12755 score entry has one to four elements.
12756 @enumerate
12757
12758 @item
12759 The first element is the @dfn{match element}.  On most headers this will
12760 be a string, but on the Lines and Chars headers, this must be an
12761 integer.
12762
12763 @item
12764 If the second element is present, it should be a number---the @dfn{score
12765 element}.  This number should be an integer in the neginf to posinf
12766 interval.  This number is added to the score of the article if the match
12767 is successful.  If this element is not present, the
12768 @code{gnus-score-interactive-default-score} number will be used
12769 instead.  This is 1000 by default.
12770
12771 @item
12772 If the third element is present, it should be a number---the @dfn{date
12773 element}.  This date says when the last time this score entry matched,
12774 which provides a mechanism for expiring the score entries.  It this
12775 element is not present, the score entry is permanent.  The date is
12776 represented by the number of days since December 31, 1 BCE.
12777
12778 @item
12779 If the fourth element is present, it should be a symbol---the @dfn{type
12780 element}.  This element specifies what function should be used to see
12781 whether this score entry matches the article.  What match types that can
12782 be used depends on what header you wish to perform the match on.
12783 @table @dfn
12784
12785 @item From, Subject, References, Xref, Message-ID
12786 For most header types, there are the @code{r} and @code{R} (regexp), as
12787 well as @code{s} and @code{S} (substring) types, and @code{e} and
12788 @code{E} (exact match), and @code{w} (word match) types.  If this
12789 element is not present, Gnus will assume that substring matching should
12790 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
12791 that the matches will be done in a case-sensitive manner.  All these
12792 one-letter types are really just abbreviations for the @code{regexp},
12793 @code{string}, @code{exact}, and @code{word} types, which you can use
12794 instead, if you feel like.
12795
12796 @item Lines, Chars
12797 These two headers use different match types: @code{<}, @code{>},
12798 @code{=}, @code{>=} and @code{<=}.
12799
12800 These predicates are true if
12801
12802 @example
12803 (PREDICATE HEADER MATCH)
12804 @end example
12805
12806 evaluates to non-@code{nil}.  For instance, the advanced match
12807 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
12808 following form:
12809
12810 @lisp
12811 (< header-value 4)
12812 @end lisp
12813
12814 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
12815 the match, we get the score added if the article has less than 4 lines.
12816 (It's easy to get confused and think it's the other way around.  But
12817 it's not.  I think.)
12818
12819 When matching on @code{Lines}, be careful because some backends (like
12820 @code{nndir}) do not generate @code{Lines} header, so every article ends
12821 up being marked as having 0 lines.  This can lead to strange results if
12822 you happen to lower score of the articles with few lines.
12823
12824 @item Date
12825 For the Date header we have three kinda silly match types:
12826 @code{before}, @code{at} and @code{after}.  I can't really imagine this
12827 ever being useful, but, like, it would feel kinda silly not to provide
12828 this function.  Just in case.  You never know.  Better safe than sorry.
12829 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
12830 sex on a first date.  (I have been told that at least one person, and I
12831 quote, ``found this function indispensable'', however.)
12832
12833 @cindex ISO8601
12834 @cindex date
12835 A more useful match type is @code{regexp}.  With it, you can match the
12836 date string using a regular expression.  The date is normalized to
12837 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
12838 you want to match all articles that have been posted on April 1st in
12839 every year, you could use @samp{....0401.........} as a match string,
12840 for instance.  (Note that the date is kept in its original time zone, so
12841 this will match articles that were posted when it was April 1st where
12842 the article was posted from.  Time zones are such wholesome fun for the
12843 whole family, eh?)
12844
12845 @item Head, Body, All
12846 These three match keys use the same match types as the @code{From} (etc)
12847 header uses.
12848
12849 @item Followup
12850 This match key is somewhat special, in that it will match the
12851 @code{From} header, and affect the score of not only the matching
12852 articles, but also all followups to the matching articles.  This allows
12853 you e.g. increase the score of followups to your own articles, or
12854 decrease the score of followups to the articles of some known
12855 trouble-maker.  Uses the same match types as the @code{From} header
12856 uses.  (Using this match key will lead to creation of @file{ADAPT}
12857 files.)
12858
12859 @item Thread
12860 This match key works along the same lines as the @code{Followup} match
12861 key.  If you say that you want to score on a (sub-)thread started by an article with a @code{Message-ID} @var{X}, then you add a
12862 @samp{thread} match.  This will add a new @samp{thread} match for each
12863 article that has @var{X} in its @code{References} header.  (These new
12864 @samp{thread} matches will use the @code{Message-ID}s of these matching
12865 articles.)  This will ensure that you can raise/lower the score of an
12866 entire thread, even though some articles in the thread may not have
12867 complete @code{References} headers.  Note that using this may lead to
12868 undeterministic scores of the articles in the thread.  (Using this match
12869 key will lead to creation of @file{ADAPT} files.)
12870 @end table
12871 @end enumerate
12872
12873 @cindex Score File Atoms
12874 @item mark
12875 The value of this entry should be a number.  Any articles with a score
12876 lower than this number will be marked as read.
12877
12878 @item expunge
12879 The value of this entry should be a number.  Any articles with a score
12880 lower than this number will be removed from the summary buffer.
12881
12882 @item mark-and-expunge
12883 The value of this entry should be a number.  Any articles with a score
12884 lower than this number will be marked as read and removed from the
12885 summary buffer.
12886
12887 @item thread-mark-and-expunge
12888 The value of this entry should be a number.  All articles that belong to
12889 a thread that has a total score below this number will be marked as read
12890 and removed from the summary buffer.  @code{gnus-thread-score-function}
12891 says how to compute the total score for a thread.
12892
12893 @item files
12894 The value of this entry should be any number of file names.  These files
12895 are assumed to be score files as well, and will be loaded the same way
12896 this one was.
12897
12898 @item exclude-files
12899 The clue of this entry should be any number of files.  These files will
12900 not be loaded, even though they would normally be so, for some reason or
12901 other.
12902
12903 @item eval
12904 The value of this entry will be @code{eval}el.  This element will be
12905 ignored when handling global score files.
12906
12907 @item read-only
12908 Read-only score files will not be updated or saved.  Global score files
12909 should feature this atom (@pxref{Global Score Files}).  (Note:
12910 @dfn{Global} here really means @dfn{global}; not your personal
12911 apply-to-all-groups score files.)
12912
12913 @item orphan
12914 The value of this entry should be a number.  Articles that do not have
12915 parents will get this number added to their scores.  Imagine you follow
12916 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
12917 will only follow a few of the threads, also want to see any new threads.
12918
12919 You can do this with the following two score file entries:
12920
12921 @example
12922         (orphan -500)
12923         (mark-and-expunge -100)
12924 @end example
12925
12926 When you enter the group the first time, you will only see the new
12927 threads.  You then raise the score of the threads that you find
12928 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
12929 rest.  Next time you enter the group, you will see new articles in the
12930 interesting threads, plus any new threads.
12931
12932 I.e.---the orphan score atom is for high-volume groups where there
12933 exist a few interesting threads which can't be found automatically by
12934 ordinary scoring rules.
12935
12936 @item adapt
12937 This entry controls the adaptive scoring.  If it is @code{t}, the
12938 default adaptive scoring rules will be used.  If it is @code{ignore}, no
12939 adaptive scoring will be performed on this group.  If it is a list, this
12940 list will be used as the adaptive scoring rules.  If it isn't present,
12941 or is something other than @code{t} or @code{ignore}, the default
12942 adaptive scoring rules will be used.  If you want to use adaptive
12943 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
12944 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
12945 not want adaptive scoring.  If you only want adaptive scoring in a few
12946 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
12947 insert @code{(adapt t)} in the score files of the groups where you want
12948 it.
12949
12950 @item adapt-file
12951 All adaptive score entries will go to the file named by this entry.  It
12952 will also be applied when entering the group.  This atom might be handy
12953 if you want to adapt on several groups at once, using the same adaptive
12954 file for a number of groups.
12955
12956 @item local
12957 @cindex local variables
12958 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
12959 Each @var{var} will be made buffer-local to the current summary buffer,
12960 and set to the value specified.  This is a convenient, if somewhat
12961 strange, way of setting variables in some groups if you don't like hooks
12962 much.  Note that the @var{value} won't be evaluated.
12963 @end table
12964
12965
12966 @node Score File Editing
12967 @section Score File Editing
12968
12969 You normally enter all scoring commands from the summary buffer, but you
12970 might feel the urge to edit them by hand as well, so we've supplied you
12971 with a mode for that.
12972
12973 It's simply a slightly customized @code{emacs-lisp} mode, with these
12974 additional commands:
12975
12976 @table @kbd
12977
12978 @item C-c C-c
12979 @kindex C-c C-c (Score)
12980 @findex gnus-score-edit-done
12981 Save the changes you have made and return to the summary buffer
12982 (@code{gnus-score-edit-done}).
12983
12984 @item C-c C-d
12985 @kindex C-c C-d (Score)
12986 @findex gnus-score-edit-insert-date
12987 Insert the current date in numerical format
12988 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
12989 you were wondering.
12990
12991 @item C-c C-p
12992 @kindex C-c C-p (Score)
12993 @findex gnus-score-pretty-print
12994 The adaptive score files are saved in an unformatted fashion.  If you
12995 intend to read one of these files, you want to @dfn{pretty print} it
12996 first.  This command (@code{gnus-score-pretty-print}) does that for
12997 you.
12998
12999 @end table
13000
13001 Type @kbd{M-x gnus-score-mode} to use this mode.
13002
13003 @vindex gnus-score-mode-hook
13004 @code{gnus-score-menu-hook} is run in score mode buffers.
13005
13006 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13007 e} to begin editing score files.
13008
13009
13010 @node Adaptive Scoring
13011 @section Adaptive Scoring
13012 @cindex adaptive scoring
13013
13014 If all this scoring is getting you down, Gnus has a way of making it all
13015 happen automatically---as if by magic.  Or rather, as if by artificial
13016 stupidity, to be precise.
13017
13018 @vindex gnus-use-adaptive-scoring
13019 When you read an article, or mark an article as read, or kill an
13020 article, you leave marks behind.  On exit from the group, Gnus can sniff
13021 these marks and add score elements depending on what marks it finds.
13022 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13023 @code{t} or @code{(line)}.  If you want score adaptively on separate
13024 words appearing in the subjects, you should set this variable to
13025 @code{(word)}.  If you want to use both adaptive methods, set this
13026 variable to @code{(word line)}.
13027
13028 @vindex gnus-default-adaptive-score-alist
13029 To give you complete control over the scoring process, you can customize
13030 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
13031 might look something like this:
13032
13033 @lisp
13034 (defvar gnus-default-adaptive-score-alist
13035   '((gnus-unread-mark)
13036     (gnus-ticked-mark (from 4))
13037     (gnus-dormant-mark (from 5))
13038     (gnus-del-mark (from -4) (subject -1))
13039     (gnus-read-mark (from 4) (subject 2))
13040     (gnus-expirable-mark (from -1) (subject -1))
13041     (gnus-killed-mark (from -1) (subject -3))
13042     (gnus-kill-file-mark)
13043     (gnus-ancient-mark)
13044     (gnus-low-score-mark)
13045     (gnus-catchup-mark (from -1) (subject -1))))
13046 @end lisp
13047
13048 As you see, each element in this alist has a mark as a key (either a
13049 variable name or a ``real'' mark---a character).  Following this key is
13050 a arbitrary number of header/score pairs.  If there are no header/score
13051 pairs following the key, no adaptive scoring will be done on articles
13052 that have that key as the article mark.  For instance, articles with
13053 @code{gnus-unread-mark} in the example above will not get adaptive score
13054 entries.
13055
13056 Each article can have only one mark, so just a single of these rules
13057 will be applied to each article.
13058
13059 To take @code{gnus-del-mark} as an example---this alist says that all
13060 articles that have that mark (i.e., are marked with @samp{D}) will have a
13061 score entry added to lower based on the @code{From} header by -4, and
13062 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
13063
13064 If you have marked 10 articles with the same subject with
13065 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13066 That means that that subject will get a score of ten times -1, which
13067 should be, unless I'm much mistaken, -10.
13068
13069 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13070 the read articles will be marked with the @samp{E} mark.  This'll
13071 probably make adaptive scoring slightly impossible, so auto-expiring and
13072 adaptive scoring doesn't really mix very well.
13073
13074 The headers you can score on are @code{from}, @code{subject},
13075 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13076 @code{chars} and @code{date}.  In addition, you can score on
13077 @code{followup}, which will create an adaptive score entry that matches
13078 on the @code{References} header using the @code{Message-ID} of the
13079 current article, thereby matching the following thread.
13080
13081 You can also score on @code{thread}, which will try to score all
13082 articles that appear in a thread.  @code{thread} matches uses a
13083 @code{Message-ID} to match on the @code{References} header of the
13084 article.  If the match is made, the @code{Message-ID} of the article is
13085 added to the @code{thread} rule.  (Think about it.  I'd recommend two
13086 aspirins afterwards.)
13087
13088 If you use this scheme, you should set the score file atom @code{mark}
13089 to something small---like -300, perhaps, to avoid having small random
13090 changes result in articles getting marked as read.
13091
13092 After using adaptive scoring for a week or so, Gnus should start to
13093 become properly trained and enhance the authors you like best, and kill
13094 the authors you like least, without you having to say so explicitly.
13095
13096 You can control what groups the adaptive scoring is to be performed on
13097 by using the score files (@pxref{Score File Format}).  This will also
13098 let you use different rules in different groups.
13099
13100 @vindex gnus-adaptive-file-suffix
13101 The adaptive score entries will be put into a file where the name is the
13102 group name with @code{gnus-adaptive-file-suffix} appended.  The default
13103 is @samp{ADAPT}.
13104
13105 @vindex gnus-score-exact-adapt-limit
13106 When doing adaptive scoring, substring or fuzzy matching would probably
13107 give you the best results in most cases.  However, if the header one
13108 matches is short, the possibility for false positives is great, so if
13109 the length of the match is less than
13110 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
13111 this variable is @code{nil}, exact matching will always be used to avoid
13112 this problem.
13113
13114 @vindex gnus-default-adaptive-word-score-alist
13115 As mentioned above, you can adapt either on individual words or entire
13116 headers.  If you adapt on words, the
13117 @code{gnus-default-adaptive-word-score-alist} variable says what score
13118 each instance of a word should add given a mark.
13119
13120 @lisp
13121 (setq gnus-default-adaptive-word-score-alist
13122       `((,gnus-read-mark . 30)
13123         (,gnus-catchup-mark . -10)
13124         (,gnus-killed-mark . -20)
13125         (,gnus-del-mark . -15)))
13126 @end lisp
13127
13128 This is the default value.  If you have adaption on words enabled, every
13129 word that appears in subjects of articles marked with
13130 @code{gnus-read-mark} will result in a score rule that increase the
13131 score with 30 points.
13132
13133 @vindex gnus-default-ignored-adaptive-words
13134 @vindex gnus-ignored-adaptive-words
13135 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13136 will be ignored.  If you wish to add more words to be ignored, use the
13137 @code{gnus-ignored-adaptive-words} list instead.
13138
13139 @vindex gnus-adaptive-word-syntax-table
13140 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13141 syntax table in effect.  It is similar to the standard syntax table, but
13142 it considers numbers to be non-word-constituent characters.
13143
13144 @vindex gnus-adaptive-word-minimum
13145 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13146 word scoring process will never bring down the score of an article to
13147 below this number.  The default is @code{nil}.
13148
13149 @vindex gnus-adaptive-word-no-group-words
13150 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13151 won't adaptively word score any of the words in the group name.  Useful
13152 for groups like @samp{comp.editors.emacs}, where most of the subject
13153 lines contain the word @samp{emacs}.
13154
13155 After using this scheme for a while, it might be nice to write a
13156 @code{gnus-psychoanalyze-user} command to go through the rules and see
13157 what words you like and what words you don't like.  Or perhaps not.
13158
13159 Note that the adaptive word scoring thing is highly experimental and is
13160 likely to change in the future.  Initial impressions seem to indicate
13161 that it's totally useless as it stands.  Some more work (involving more
13162 rigorous statistical methods) will have to be done to make this useful.
13163
13164
13165 @node Home Score File
13166 @section Home Score File
13167
13168 The score file where new score file entries will go is called the
13169 @dfn{home score file}.  This is normally (and by default) the score file
13170 for the group itself.  For instance, the home score file for
13171 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13172
13173 However, this may not be what you want.  It is often convenient to share
13174 a common home score file among many groups---all @samp{emacs} groups
13175 could perhaps use the same home score file.
13176
13177 @vindex gnus-home-score-file
13178 The variable that controls this is @code{gnus-home-score-file}.  It can
13179 be:
13180
13181 @enumerate
13182 @item
13183 A string.  Then this file will be used as the home score file for all
13184 groups.
13185
13186 @item
13187 A function. The result of this function will be used as the home score
13188 file.  The function will be called with the name of the group as the
13189 parameter.
13190
13191 @item
13192 A list.  The elements in this list can be:
13193
13194 @enumerate
13195 @item
13196 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
13197 the @var{file-name} will will be used as the home score file.
13198
13199 @item
13200 A function. If the function returns non-nil, the result will be used as
13201 the home score file.
13202
13203 @item
13204 A string.  Use the string as the home score file.
13205 @end enumerate
13206
13207 The list will be traversed from the beginning towards the end looking
13208 for matches.
13209
13210 @end enumerate
13211
13212 So, if you want to use just a single score file, you could say:
13213
13214 @lisp
13215 (setq gnus-home-score-file
13216       "my-total-score-file.SCORE")
13217 @end lisp
13218
13219 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
13220 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
13221
13222 @findex gnus-hierarchial-home-score-file
13223 @lisp
13224 (setq gnus-home-score-file
13225       'gnus-hierarchial-home-score-file)
13226 @end lisp
13227
13228 This is a ready-made function provided for your convenience.
13229 Other functions include
13230
13231 @table @code
13232 @item gnus-current-home-score-file
13233 @findex gnus-current-home-score-file
13234 Return the ``current'' regular score file.  This will make scoring
13235 commands add entry to the ``innermost'' matching score file.
13236
13237 @end table
13238
13239 If you want to have one score file for the @samp{emacs} groups and
13240 another for the @samp{comp} groups, while letting all other groups use
13241 their own home score files:
13242
13243 @lisp
13244 (setq gnus-home-score-file
13245       ;; All groups that match the regexp "\\.emacs"
13246       '(("\\.emacs" "emacs.SCORE")
13247         ;; All the comp groups in one score file
13248         ("^comp" "comp.SCORE")))
13249 @end lisp
13250
13251 @vindex gnus-home-adapt-file
13252 @code{gnus-home-adapt-file} works exactly the same way as
13253 @code{gnus-home-score-file}, but says what the home adaptive score file
13254 is instead.  All new adaptive file entries will go into the file
13255 specified by this variable, and the same syntax is allowed.
13256
13257 In addition to using @code{gnus-home-score-file} and
13258 @code{gnus-home-adapt-file}, you can also use group parameters
13259 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
13260 Parameters}) to achieve much the same.  Group and topic parameters take
13261 precedence over this variable.
13262
13263
13264 @node Followups To Yourself
13265 @section Followups To Yourself
13266
13267 Gnus offers two commands for picking out the @code{Message-ID} header in
13268 the current buffer.  Gnus will then add a score rule that scores using
13269 this @code{Message-ID} on the @code{References} header of other
13270 articles.  This will, in effect, increase the score of all articles that
13271 respond to the article in the current buffer.  Quite useful if you want
13272 to easily note when people answer what you've said.
13273
13274 @table @code
13275
13276 @item gnus-score-followup-article
13277 @findex gnus-score-followup-article
13278 This will add a score to articles that directly follow up your own
13279 article.
13280
13281 @item gnus-score-followup-thread
13282 @findex gnus-score-followup-thread
13283 This will add a score to all articles that appear in a thread ``below''
13284 your own article.
13285 @end table
13286
13287 @vindex message-sent-hook
13288 These two functions are both primarily meant to be used in hooks like
13289 @code{message-sent-hook}.
13290
13291 If you look closely at your own @code{Message-ID}, you'll notice that
13292 the first two or three characters are always the same.  Here's two of
13293 mine:
13294
13295 @example
13296 <x6u3u47icf.fsf@@eyesore.no>
13297 <x6sp9o7ibw.fsf@@eyesore.no>
13298 @end example
13299
13300 So ``my'' ident on this machine is @samp{x6}.  This can be
13301 exploited---the following rule will raise the score on all followups to
13302 myself:
13303
13304 @lisp
13305 ("references"
13306  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
13307   1000 nil r))
13308 @end lisp
13309
13310 Whether it's the first two or first three characters that are ``yours''
13311 is system-dependent.
13312
13313
13314 @node Scoring Tips
13315 @section Scoring Tips
13316 @cindex scoring tips
13317
13318 @table @dfn
13319
13320 @item Crossposts
13321 @cindex crossposts
13322 @cindex scoring crossposts
13323 If you want to lower the score of crossposts, the line to match on is
13324 the @code{Xref} header.
13325 @lisp
13326 ("xref" (" talk.politics.misc:" -1000))
13327 @end lisp
13328
13329 @item Multiple crossposts
13330 If you want to lower the score of articles that have been crossposted to
13331 more than, say, 3 groups:
13332 @lisp
13333 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
13334 @end lisp
13335
13336 @item Matching on the body
13337 This is generally not a very good idea---it takes a very long time.
13338 Gnus actually has to fetch each individual article from the server.  But
13339 you might want to anyway, I guess.  Even though there are three match
13340 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
13341 and stick with it in each score file.  If you use any two, each article
13342 will be fetched @emph{twice}.  If you want to match a bit on the
13343 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
13344 the matches.
13345
13346 @item Marking as read
13347 You will probably want to mark articles that has a score below a certain
13348 number as read.  This is most easily achieved by putting the following
13349 in your @file{all.SCORE} file:
13350 @lisp
13351 ((mark -100))
13352 @end lisp
13353 You may also consider doing something similar with @code{expunge}.
13354
13355 @item Negated character classes
13356 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
13357 That will match newlines, which might lead to, well, The Unknown.  Say
13358 @code{[^abcd\n]*} instead.
13359 @end table
13360
13361
13362 @node Reverse Scoring
13363 @section Reverse Scoring
13364 @cindex reverse scoring
13365
13366 If you want to keep just articles that have @samp{Sex with Emacs} in the
13367 subject header, and expunge all other articles, you could put something
13368 like this in your score file:
13369
13370 @lisp
13371 (("subject"
13372   ("Sex with Emacs" 2))
13373  (mark 1)
13374  (expunge 1))
13375 @end lisp
13376
13377 So, you raise all articles that match @samp{Sex with Emacs} and mark the
13378 rest as read, and expunge them to boot.
13379
13380
13381 @node Global Score Files
13382 @section Global Score Files
13383 @cindex global score files
13384
13385 Sure, other newsreaders have ``global kill files''.  These are usually
13386 nothing more than a single kill file that applies to all groups, stored
13387 in the user's home directory.  Bah!  Puny, weak newsreaders!
13388
13389 What I'm talking about here are Global Score Files.  Score files from
13390 all over the world, from users everywhere, uniting all nations in one
13391 big, happy score file union!  Ange-score!  New and untested!
13392
13393 @vindex gnus-global-score-files
13394 All you have to do to use other people's score files is to set the
13395 @code{gnus-global-score-files} variable.  One entry for each score file,
13396 or each score file directory.  Gnus will decide by itself what score
13397 files are applicable to which group.
13398
13399 Say you want to use the score file
13400 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
13401 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
13402
13403 @lisp
13404 (setq gnus-global-score-files
13405       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
13406         "/ftp@@ftp.some-where:/pub/score/"))
13407 @end lisp
13408
13409 @findex gnus-score-search-global-directories
13410 Simple, eh?  Directory names must end with a @samp{/}.  These
13411 directories are typically scanned only once during each Gnus session.
13412 If you feel the need to manually re-scan the remote directories, you can
13413 use the @code{gnus-score-search-global-directories} command.
13414
13415 Note that, at present, using this option will slow down group entry
13416 somewhat.  (That is---a lot.)
13417
13418 If you want to start maintaining score files for other people to use,
13419 just put your score file up for anonymous ftp and announce it to the
13420 world.  Become a retro-moderator!  Participate in the retro-moderator
13421 wars sure to ensue, where retro-moderators battle it out for the
13422 sympathy of the people, luring them to use their score files on false
13423 premises!  Yay!  The net is saved!
13424
13425 Here are some tips for the would-be retro-moderator, off the top of my
13426 head:
13427
13428 @itemize @bullet
13429
13430 @item
13431 Articles heavily crossposted are probably junk.
13432 @item
13433 To lower a single inappropriate article, lower by @code{Message-ID}.
13434 @item
13435 Particularly brilliant authors can be raised on a permanent basis.
13436 @item
13437 Authors that repeatedly post off-charter for the group can safely be
13438 lowered out of existence.
13439 @item
13440 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
13441 articles completely.
13442
13443 @item
13444 Use expiring score entries to keep the size of the file down.  You
13445 should probably have a long expiry period, though, as some sites keep
13446 old articles for a long time.
13447 @end itemize
13448
13449 ... I wonder whether other newsreaders will support global score files
13450 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
13451 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
13452 holding our breath yet?
13453
13454
13455 @node Kill Files
13456 @section Kill Files
13457 @cindex kill files
13458
13459 Gnus still supports those pesky old kill files.  In fact, the kill file
13460 entries can now be expiring, which is something I wrote before Daniel
13461 Quinlan thought of doing score files, so I've left the code in there.
13462
13463 In short, kill processing is a lot slower (and I do mean @emph{a lot})
13464 than score processing, so it might be a good idea to rewrite your kill
13465 files into score files.
13466
13467 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
13468 forms into this file, which means that you can use kill files as some
13469 sort of primitive hook function to be run on group entry, even though
13470 that isn't a very good idea.
13471
13472 Normal kill files look like this:
13473
13474 @lisp
13475 (gnus-kill "From" "Lars Ingebrigtsen")
13476 (gnus-kill "Subject" "ding")
13477 (gnus-expunge "X")
13478 @end lisp
13479
13480 This will mark every article written by me as read, and remove the
13481 marked articles from the summary buffer.  Very useful, you'll agree.
13482
13483 Other programs use a totally different kill file syntax.  If Gnus
13484 encounters what looks like a @code{rn} kill file, it will take a stab at
13485 interpreting it.
13486
13487 Two summary functions for editing a GNUS kill file:
13488
13489 @table @kbd
13490
13491 @item M-k
13492 @kindex M-k (Summary)
13493 @findex gnus-summary-edit-local-kill
13494 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
13495
13496 @item M-K
13497 @kindex M-K (Summary)
13498 @findex gnus-summary-edit-global-kill
13499 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
13500 @end table
13501
13502 Two group mode functions for editing the kill files:
13503
13504 @table @kbd
13505
13506 @item M-k
13507 @kindex M-k (Group)
13508 @findex gnus-group-edit-local-kill
13509 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
13510
13511 @item M-K
13512 @kindex M-K (Group)
13513 @findex gnus-group-edit-global-kill
13514 Edit the general kill file (@code{gnus-group-edit-global-kill}).
13515 @end table
13516
13517 Kill file variables:
13518
13519 @table @code
13520 @item gnus-kill-file-name
13521 @vindex gnus-kill-file-name
13522 A kill file for the group @samp{soc.motss} is normally called
13523 @file{soc.motss.KILL}.  The suffix appended to the group name to get
13524 this file name is detailed by the @code{gnus-kill-file-name} variable.
13525 The ``global'' kill file (not in the score file sense of ``global'', of
13526 course) is just called @file{KILL}.
13527
13528 @vindex gnus-kill-save-kill-file
13529 @item gnus-kill-save-kill-file
13530 If this variable is non-@code{nil}, Gnus will save the
13531 kill file after processing, which is necessary if you use expiring
13532 kills.
13533
13534 @item gnus-apply-kill-hook
13535 @vindex gnus-apply-kill-hook
13536 @findex gnus-apply-kill-file-unless-scored
13537 @findex gnus-apply-kill-file
13538 A hook called to apply kill files to a group.  It is
13539 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
13540 kill file if you have a score file for the same group, you can set this
13541 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
13542 kill files to be processed, you should set this variable to @code{nil}.
13543
13544 @item gnus-kill-file-mode-hook
13545 @vindex gnus-kill-file-mode-hook
13546 A hook called in kill-file mode buffers.
13547
13548 @end table
13549
13550
13551 @node Converting Kill Files
13552 @section Converting Kill Files
13553 @cindex kill files
13554 @cindex converting kill files
13555
13556 If you have loads of old kill files, you may want to convert them into
13557 score files.  If they are ``regular'', you can use
13558 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
13559 by hand.
13560
13561 The kill to score conversion package isn't included in Gnus by default.
13562 You can fetch it from
13563 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
13564
13565 If your old kill files are very complex---if they contain more
13566 non-@code{gnus-kill} forms than not, you'll have to convert them by
13567 hand.  Or just let them be as they are.  Gnus will still use them as
13568 before.
13569
13570
13571 @node GroupLens
13572 @section GroupLens
13573 @cindex GroupLens
13574
13575 GroupLens is a collaborative filtering system that helps you work
13576 together with other people to find the quality news articles out of the
13577 huge volume of news articles generated every day.
13578
13579 To accomplish this the GroupLens system combines your opinions about
13580 articles you have already read with the opinions of others who have done
13581 likewise and gives you a personalized prediction for each unread news
13582 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
13583 rate articles, and finds other people that rate articles the same way.
13584 Once it has found some people you agree with it tells you, in the form
13585 of a prediction, what they thought of the article.  You can use this
13586 prediction to help you decide whether or not you want to read the
13587 article.
13588
13589 @menu
13590 * Using GroupLens::          How to make Gnus use GroupLens.
13591 * Rating Articles::          Letting GroupLens know how you rate articles.
13592 * Displaying Predictions::   Displaying predictions given by GroupLens.
13593 * GroupLens Variables::      Customizing GroupLens.
13594 @end menu
13595
13596
13597 @node Using GroupLens
13598 @subsection Using GroupLens
13599
13600 To use GroupLens you must register a pseudonym with your local Better
13601 Bit Bureau (BBB).
13602 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
13603 better bit in town at the moment.
13604
13605 Once you have registered you'll need to set a couple of variables.
13606
13607 @table @code
13608
13609 @item gnus-use-grouplens
13610 @vindex gnus-use-grouplens
13611 Setting this variable to a non-@code{nil} value will make Gnus hook into
13612 all the relevant GroupLens functions.
13613
13614 @item grouplens-pseudonym
13615 @vindex grouplens-pseudonym
13616 This variable should be set to the pseudonym you got when registering
13617 with the Better Bit Bureau.
13618
13619 @item grouplens-newsgroups
13620 @vindex grouplens-newsgroups
13621 A list of groups that you want to get GroupLens predictions for.
13622
13623 @end table
13624
13625 That's the minimum of what you need to get up and running with GroupLens.
13626 Once you've registered, GroupLens will start giving you scores for
13627 articles based on the average of what other people think.  But, to get
13628 the real benefit of GroupLens you need to start rating articles
13629 yourself.  Then the scores GroupLens gives you will be personalized for
13630 you, based on how the people you usually agree with have already rated.
13631
13632
13633 @node Rating Articles
13634 @subsection Rating Articles
13635
13636 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
13637 Where 1 means something like this article is a waste of bandwidth and 5
13638 means that the article was really good.  The basic question to ask
13639 yourself is, "on a scale from 1 to 5 would I like to see more articles
13640 like this one?"
13641
13642 There are four ways to enter a rating for an article in GroupLens.
13643
13644 @table @kbd
13645
13646 @item r
13647 @kindex r (GroupLens)
13648 @findex bbb-summary-rate-article
13649 This function will prompt you for a rating on a scale of one to five.
13650
13651 @item k
13652 @kindex k (GroupLens)
13653 @findex grouplens-score-thread
13654 This function will prompt you for a rating, and rate all the articles in
13655 the thread.  This is really useful for some of those long running giant
13656 threads in rec.humor.
13657
13658 @end table
13659
13660 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13661 the score of the article you're reading.
13662
13663 @table @kbd
13664
13665 @item 1-5 n
13666 @kindex n (GroupLens)
13667 @findex grouplens-next-unread-article
13668 Rate the article and go to the next unread article.
13669
13670 @item 1-5 ,
13671 @kindex , (GroupLens)
13672 @findex grouplens-best-unread-article
13673 Rate the article and go to the next unread article with the highest score.
13674
13675 @end table
13676
13677 If you want to give the current article a score of 4 and then go to the
13678 next article, just type @kbd{4 n}.
13679
13680
13681 @node Displaying Predictions
13682 @subsection Displaying Predictions
13683
13684 GroupLens makes a prediction for you about how much you will like a
13685 news article.  The predictions from GroupLens are on a scale from 1 to
13686 5, where 1 is the worst and 5 is the best.  You can use the predictions
13687 from GroupLens in one of three ways controlled by the variable
13688 @code{gnus-grouplens-override-scoring}.
13689
13690 @vindex gnus-grouplens-override-scoring
13691 There are three ways to display predictions in grouplens.  You may
13692 choose to have the GroupLens scores contribute to, or override the
13693 regular gnus scoring mechanism. override is the default; however, some
13694 people prefer to see the Gnus scores plus the grouplens scores.  To get
13695 the separate scoring behavior you need to set
13696 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
13697 GroupLens predictions combined with the grouplens scores set it to
13698 @code{'override} and to combine the scores set
13699 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
13700 the combine option you will also want to set the values for
13701 @code{grouplens-prediction-offset} and
13702 @code{grouplens-score-scale-factor}.
13703
13704 @vindex grouplens-prediction-display
13705 In either case, GroupLens gives you a few choices for how you would like
13706 to see your predictions displayed.  The display of predictions is
13707 controlled by the @code{grouplens-prediction-display} variable.
13708
13709 The following are valid values for that variable.
13710
13711 @table @code
13712 @item prediction-spot
13713 The higher the prediction, the further to the right an @samp{*} is
13714 displayed.
13715
13716 @item confidence-interval
13717 A numeric confidence interval.
13718
13719 @item prediction-bar
13720 The higher the prediction, the longer the bar.
13721
13722 @item confidence-bar
13723 Numerical confidence.
13724
13725 @item confidence-spot
13726 The spot gets bigger with more confidence.
13727
13728 @item prediction-num
13729 Plain-old numeric value.
13730
13731 @item confidence-plus-minus
13732 Prediction +/- confidence.
13733
13734 @end table
13735
13736
13737 @node GroupLens Variables
13738 @subsection GroupLens Variables
13739
13740 @table @code
13741
13742 @item gnus-summary-grouplens-line-format
13743 The summary line format used in GroupLens-enhanced summary buffers.  It
13744 accepts the same specs as the normal summary line format (@pxref{Summary
13745 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
13746 %s\n}.
13747
13748 @item grouplens-bbb-host
13749 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
13750 default.
13751
13752 @item grouplens-bbb-port
13753 Port of the host running the bbbd server.  The default is 9000.
13754
13755 @item grouplens-score-offset
13756 Offset the prediction by this value.  In other words, subtract the
13757 prediction value by this number to arrive at the effective score.  The
13758 default is 0.
13759
13760 @item grouplens-score-scale-factor
13761 This variable allows the user to magnify the effect of GroupLens scores.
13762 The scale factor is applied after the offset.  The default is 1.
13763
13764 @end table
13765
13766
13767 @node Advanced Scoring
13768 @section Advanced Scoring
13769
13770 Scoring on Subjects and From headers is nice enough, but what if you're
13771 really interested in what a person has to say only when she's talking
13772 about a particular subject?  Or what if you really don't want to
13773 read what person A has to say when she's following up to person B, but
13774 want to read what she says when she's following up to person C?
13775
13776 By using advanced scoring rules you may create arbitrarily complex
13777 scoring patterns.
13778
13779 @menu
13780 * Advanced Scoring Syntax::     A definition.
13781 * Advanced Scoring Examples::   What they look like.
13782 * Advanced Scoring Tips::       Getting the most out of it.
13783 @end menu
13784
13785
13786 @node Advanced Scoring Syntax
13787 @subsection Advanced Scoring Syntax
13788
13789 Ordinary scoring rules have a string as the first element in the rule.
13790 Advanced scoring rules have a list as the first element.  The second
13791 element is the score to be applied if the first element evaluated to a
13792 non-@code{nil} value.
13793
13794 These lists may consist of three logical operators, one redirection
13795 operator, and various match operators.
13796
13797 Logical operators:
13798
13799 @table @code
13800 @item &
13801 @itemx and
13802 This logical operator will evaluate each of its arguments until it finds
13803 one that evaluates to @code{false}, and then it'll stop.  If all arguments
13804 evaluate to @code{true} values, then this operator will return
13805 @code{true}.
13806
13807 @item |
13808 @itemx or
13809 This logical operator will evaluate each of its arguments until it finds
13810 one that evaluates to @code{true}.  If no arguments are @code{true},
13811 then this operator will return @code{false}.
13812
13813 @item !
13814 @itemx not
13815 @itemx Â¬
13816 This logical operator only takes a single argument.  It returns the
13817 logical negation of the value of its argument.
13818
13819 @end table
13820
13821 There is an @dfn{indirection operator} that will make its arguments
13822 apply to the ancestors of the current article being scored.  For
13823 instance, @code{1-} will make score rules apply to the parent of the
13824 current article.  @code{2-} will make score rules apply to the
13825 grandparent of the current article.  Alternatively, you can write
13826 @code{^^}, where the number of @code{^}s (carets) says how far back into
13827 the ancestry you want to go.
13828
13829 Finally, we have the match operators.  These are the ones that do the
13830 real work.  Match operators are header name strings followed by a match
13831 and a match type.  A typical match operator looks like @samp{("from"
13832 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
13833 simple scoring, and the match types are also the same.
13834
13835
13836 @node Advanced Scoring Examples
13837 @subsection Advanced Scoring Examples
13838
13839 Let's say you want to increase the score of articles written by Lars
13840 when he's talking about Gnus:
13841
13842 @example
13843 ((&
13844   ("from" "Lars Ingebrigtsen")
13845   ("subject" "Gnus"))
13846  1000)
13847 @end example
13848
13849 Quite simple, huh?
13850
13851 When he writes long articles, he sometimes has something nice to say:
13852
13853 @example
13854 ((&
13855   ("from" "Lars Ingebrigtsen")
13856   (|
13857    ("subject" "Gnus")
13858    ("lines" 100 >)))
13859  1000)
13860 @end example
13861
13862 However, when he responds to things written by Reig Eigil Logge, you
13863 really don't want to read what he's written:
13864
13865 @example
13866 ((&
13867   ("from" "Lars Ingebrigtsen")
13868   (1- ("from" "Reig Eigir Logge")))
13869  -100000)
13870 @end example
13871
13872 Everybody that follows up Redmondo when he writes about disappearing
13873 socks should have their scores raised, but only when they talk about
13874 white socks.  However, when Lars talks about socks, it's usually not
13875 very interesting:
13876
13877 @example
13878 ((&
13879   (1-
13880    (&
13881     ("from" "redmondo@@.*no" r)
13882     ("body" "disappearing.*socks" t)))
13883   (! ("from" "Lars Ingebrigtsen"))
13884   ("body" "white.*socks"))
13885  1000)
13886 @end example
13887
13888 The possibilities are endless.
13889
13890
13891 @node Advanced Scoring Tips
13892 @subsection Advanced Scoring Tips
13893
13894 The @code{&} and @code{|} logical operators do short-circuit logic.
13895 That is, they stop processing their arguments when it's clear what the
13896 result of the operation will be.  For instance, if one of the arguments
13897 of an @code{&} evaluates to @code{false}, there's no point in evaluating
13898 the rest of the arguments.  This means that you should put slow matches
13899 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
13900 @samp{subject}) first.
13901
13902 The indirection arguments (@code{1-} and so on) will make their
13903 arguments work on previous generations of the thread.  If you say
13904 something like:
13905
13906 @example
13907 ...
13908 (1-
13909  (1-
13910   ("from" "lars")))
13911 ...
13912 @end example
13913
13914 Then that means "score on the from header of the grandparent of the
13915 current article".  An indirection is quite fast, but it's better to say:
13916
13917 @example
13918 (1-
13919  (&
13920   ("from" "Lars")
13921   ("subject" "Gnus")))
13922 @end example
13923
13924 than it is to say:
13925
13926 @example
13927 (&
13928  (1- ("from" "Lars"))
13929  (1- ("subject" "Gnus")))
13930 @end example
13931
13932
13933 @node Score Decays
13934 @section Score Decays
13935 @cindex score decays
13936 @cindex decays
13937
13938 You may find that your scores have a tendency to grow without
13939 bounds, especially if you're using adaptive scoring.  If scores get too
13940 big, they lose all meaning---they simply max out and it's difficult to
13941 use them in any sensible way.
13942
13943 @vindex gnus-decay-scores
13944 @findex gnus-decay-score
13945 @vindex gnus-decay-score-function
13946 Gnus provides a mechanism for decaying scores to help with this problem.
13947 When score files are loaded and @code{gnus-decay-scores} is
13948 non-@code{nil}, Gnus will run the score files through the decaying
13949 mechanism thereby lowering the scores of all non-permanent score rules.
13950 The decay itself if performed by the @code{gnus-decay-score-function}
13951 function, which is @code{gnus-decay-score} by default.  Here's the
13952 definition of that function:
13953
13954 @lisp
13955 (defun gnus-decay-score (score)
13956   "Decay SCORE.
13957 This is done according to `gnus-score-decay-constant'
13958 and `gnus-score-decay-scale'."
13959   (floor
13960    (- score
13961       (* (if (< score 0) 1 -1)
13962          (min (abs score)
13963               (max gnus-score-decay-constant
13964                    (* (abs score)
13965                       gnus-score-decay-scale)))))))
13966 @end lisp
13967
13968 @vindex gnus-score-decay-scale
13969 @vindex gnus-score-decay-constant
13970 @code{gnus-score-decay-constant} is 3 by default and
13971 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
13972
13973 @enumerate
13974 @item
13975 Scores between -3 and 3 will be set to 0 when this function is called.
13976
13977 @item
13978 Scores with magnitudes between 3 and 60 will be shrunk by 3.
13979
13980 @item
13981 Scores with magnitudes greater than 60 will be shrunk by 5% of the
13982 score.
13983 @end enumerate
13984
13985 If you don't like this decay function, write your own.  It is called
13986 with the score to be decayed as its only parameter, and it should return
13987 the new score, which should be an integer.
13988
13989 Gnus will try to decay scores once a day.  If you haven't run Gnus for
13990 four days, Gnus will decay the scores four times, for instance.
13991
13992
13993 @node Various
13994 @chapter Various
13995
13996 @menu
13997 * Process/Prefix::             A convention used by many treatment commands.
13998 * Interactive::                Making Gnus ask you many questions.
13999 * Symbolic Prefixes::          How to supply some Gnus functions with options.
14000 * Formatting Variables::       You can specify what buffers should look like.
14001 * Windows Configuration::      Configuring the Gnus buffer windows.
14002 * Faces and Fonts::            How to change how faces look.
14003 * Compilation::                How to speed Gnus up.
14004 * Mode Lines::                 Displaying information in the mode lines.
14005 * Highlighting and Menus::     Making buffers look all nice and cozy.
14006 * Buttons::                    Get tendonitis in ten easy steps!
14007 * Daemons::                    Gnus can do things behind your back.
14008 * NoCeM::                      How to avoid spam and other fatty foods.
14009 * Undo::                       Some actions can be undone.
14010 * Moderation::                 What to do if you're a moderator.
14011 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
14012 * Fuzzy Matching::             What's the big fuzz?
14013 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
14014 * Various Various::            Things that are really various.
14015 @end menu
14016
14017
14018 @node Process/Prefix
14019 @section Process/Prefix
14020 @cindex process/prefix convention
14021
14022 Many functions, among them functions for moving, decoding and saving
14023 articles, use what is known as the @dfn{Process/Prefix convention}.
14024
14025 This is a method for figuring out what articles the user wants the
14026 command to be performed on.
14027
14028 It goes like this:
14029
14030 If the numeric prefix is N, perform the operation on the next N
14031 articles, starting with the current one.  If the numeric prefix is
14032 negative, perform the operation on the previous N articles, starting
14033 with the current one.
14034
14035 @vindex transient-mark-mode
14036 If @code{transient-mark-mode} in non-@code{nil} and the region is
14037 active, all articles in the region will be worked upon.
14038
14039 If there is no numeric prefix, but some articles are marked with the
14040 process mark, perform the operation on the articles marked with
14041 the process mark.
14042
14043 If there is neither a numeric prefix nor any articles marked with the
14044 process mark, just perform the operation on the current article.
14045
14046 Quite simple, really, but it needs to be made clear so that surprises
14047 are avoided.
14048
14049 Commands that react to the process mark will push the current list of
14050 process marked articles onto a stack and will then clear all process
14051 marked articles.  You can restore the previous configuration with the
14052 @kbd{M P y} command (@pxref{Setting Process Marks}).
14053
14054 @vindex gnus-summary-goto-unread
14055 One thing that seems to shock & horrify lots of people is that, for
14056 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14057 Since each @kbd{d} (which marks the current article as read) by default
14058 goes to the next unread article after marking, this means that @kbd{3 d}
14059 will mark the next three unread articles as read, no matter what the
14060 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
14061 @code{nil} for a more straightforward action.
14062
14063
14064 @node Interactive
14065 @section Interactive
14066 @cindex interaction
14067
14068 @table @code
14069
14070 @item gnus-novice-user
14071 @vindex gnus-novice-user
14072 If this variable is non-@code{nil}, you are either a newcomer to the
14073 World of Usenet, or you are very cautious, which is a nice thing to be,
14074 really.  You will be given questions of the type ``Are you sure you want
14075 to do this?'' before doing anything dangerous.  This is @code{t} by
14076 default.
14077
14078 @item gnus-expert-user
14079 @vindex gnus-expert-user
14080 If this variable is non-@code{nil}, you will seldom be asked any
14081 questions by Gnus.  It will simply assume you know what you're doing, no
14082 matter how strange.
14083
14084 @item gnus-interactive-catchup
14085 @vindex gnus-interactive-catchup
14086 Require confirmation before catching up a group if non-@code{nil}.  It
14087 is @code{t} by default.
14088
14089 @item gnus-interactive-exit
14090 @vindex gnus-interactive-exit
14091 Require confirmation before exiting Gnus.  This variable is @code{t} by
14092 default.
14093 @end table
14094
14095
14096 @node Symbolic Prefixes
14097 @section Symbolic Prefixes
14098 @cindex symbolic prefixes
14099
14100 Quite a lot of Emacs commands react to the (numeric) prefix.  For
14101 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14102 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14103 rule of 900 to the current article.
14104
14105 This is all nice and well, but what if you want to give a command some
14106 additional information?  Well, what most commands do is interpret the
14107 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
14108 doesn't want a backup file to be created when saving the current buffer,
14109 for instance.  But what if you want to save without making a backup
14110 file, and you want Emacs to flash lights and play a nice tune at the
14111 same time?  You can't, and you're probably perfectly happy that way.
14112
14113 @kindex M-i (Summary)
14114 @findex gnus-symbolic-argument
14115 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
14116 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14117 character typed in is the value.  You can stack as many @kbd{M-i}
14118 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14119 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
14120 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14121 @code{b}''.  You get the drift.
14122
14123 Typing in symbolic prefixes to commands that don't accept them doesn't
14124 hurt, but it doesn't do any good either.  Currently not many Gnus
14125 functions make use of the symbolic prefix.
14126
14127 If you're interested in how Gnus implements this, @pxref{Extended
14128 Interactive}.
14129
14130
14131 @node Formatting Variables
14132 @section Formatting Variables
14133 @cindex formatting variables
14134
14135 Throughout this manual you've probably noticed lots of variables called
14136 things like @code{gnus-group-line-format} and
14137 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
14138 output lines in the various buffers.  There's quite a lot of them.
14139 Fortunately, they all use the same syntax, so there's not that much to
14140 be annoyed by.
14141
14142 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14143 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
14144 lots of percentages everywhere.
14145
14146 @menu
14147 * Formatting Basics::     A formatting variable is basically a format string.
14148 * Mode Line Formatting::  Some rules about mode line formatting variables.
14149 * Advanced Formatting::   Modifying output in various ways.
14150 * User-Defined Specs::    Having Gnus call your own functions.
14151 * Formatting Fonts::      Making the formatting look colorful and nice.
14152 @end menu
14153
14154 Currently Gnus uses the following formatting variables:
14155 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14156 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14157 @code{gnus-group-mode-line-format},
14158 @code{gnus-summary-mode-line-format},
14159 @code{gnus-article-mode-line-format},
14160 @code{gnus-server-mode-line-format}, and
14161 @code{gnus-summary-pick-line-format}.
14162
14163 All these format variables can also be arbitrary elisp forms.  In that
14164 case, they will be @code{eval}ed to insert the required lines.
14165
14166 @kindex M-x gnus-update-format
14167 @findex gnus-update-format
14168 Gnus includes a command to help you while creating your own format
14169 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
14170 update the spec in question and pop you to a buffer where you can
14171 examine the resulting lisp code to be run to generate the line.
14172
14173
14174
14175 @node Formatting Basics
14176 @subsection Formatting Basics
14177
14178 Each @samp{%} element will be replaced by some string or other when the
14179 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
14180 spec, and pad with spaces to get a 5-character field''.
14181
14182 As with normal C and Emacs Lisp formatting strings, the numerical
14183 modifier between the @samp{%} and the formatting type character will
14184 @dfn{pad} the output so that it is always at least that long.
14185 @samp{%5y} will make the field always (at least) five characters wide by
14186 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
14187 the right instead.
14188
14189 You may also wish to limit the length of the field to protect against
14190 particularly wide values.  For that you can say @samp{%4,6y}, which
14191 means that the field will never be more than 6 characters wide and never
14192 less than 4 characters wide.
14193
14194
14195 @node Mode Line Formatting
14196 @subsection Mode Line Formatting
14197
14198 Mode line formatting variables (e.g.,
14199 @code{gnus-summary-mode-line-format}) follow the same rules as other,
14200 buffer line oriented formatting variables (@pxref{Formatting Basics})
14201 with the following two differences:
14202
14203 @enumerate
14204
14205 @item
14206 There must be no newline (@samp{\n}) at the end.
14207
14208 @item
14209 The special @samp{%%b} spec can be used to display the buffer name.
14210 Well, it's no spec at all, really---@samp{%%} is just a way to quote
14211 @samp{%} to allow it to pass through the formatting machinery unmangled,
14212 so that Emacs receives @samp{%b}, which is something the Emacs mode line
14213 display interprets to mean ``show the buffer name''.  For a full list of
14214 mode line specs Emacs understands, see the documentation of the
14215 @code{mode-line-format} variable.
14216
14217 @end enumerate
14218
14219
14220 @node Advanced Formatting
14221 @subsection Advanced Formatting
14222
14223 It is frequently useful to post-process the fields in some way.
14224 Padding, limiting, cutting off parts and suppressing certain values can
14225 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
14226 look like @samp{%~(cut 3)~(ignore "0")y}.
14227
14228 These are the valid modifiers:
14229
14230 @table @code
14231 @item pad
14232 @itemx pad-left
14233 Pad the field to the left with spaces until it reaches the required
14234 length.
14235
14236 @item pad-right
14237 Pad the field to the right with spaces until it reaches the required
14238 length.
14239
14240 @item max
14241 @itemx max-left
14242 Cut off characters from the left until it reaches the specified length.
14243
14244 @item max-right
14245 Cut off characters from the right until it reaches the specified
14246 length.
14247
14248 @item cut
14249 @itemx cut-left
14250 Cut off the specified number of characters from the left.
14251
14252 @item cut-right
14253 Cut off the specified number of characters from the right.
14254
14255 @item ignore
14256 Return an empty string if the field is equal to the specified value.
14257
14258 @item form
14259 Use the specified form as the field value when the @samp{@@} spec is
14260 used.
14261 @end table
14262
14263 Let's take an example.  The @samp{%o} spec in the summary mode lines
14264 will return a date in compact ISO8601 format---@samp{19960809T230410}.
14265 This is quite a mouthful, so we want to shave off the century number and
14266 the time, leaving us with a six-character date.  That would be
14267 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
14268 maxing, and we need the padding to ensure that the date is never less
14269 than 6 characters to make it look nice in columns.)
14270
14271 Ignoring is done first; then cutting; then maxing; and then as the very
14272 last operation, padding.
14273
14274 If you use lots of these advanced thingies, you'll find that Gnus gets
14275 quite slow.  This can be helped enormously by running @kbd{M-x
14276 gnus-compile} when you are satisfied with the look of your lines.
14277 @xref{Compilation}.
14278
14279
14280 @node User-Defined Specs
14281 @subsection User-Defined Specs
14282
14283 All the specs allow for inserting user defined specifiers---@samp{u}.
14284 The next character in the format string should be a letter.  Gnus
14285 will call the function @code{gnus-user-format-function-}@samp{X}, where
14286 @samp{X} is the letter following @samp{%u}.  The function will be passed
14287 a single parameter---what the parameter means depends on what buffer
14288 it's being called from.  The function should return a string, which will
14289 be inserted into the buffer just like information from any other
14290 specifier.  This function may also be called with dummy values, so it
14291 should protect against that.
14292
14293 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
14294 much the same without defining new functions.  Here's an example:
14295 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
14296 given here will be evaluated to yield the current line number, and then
14297 inserted.
14298
14299
14300 @node Formatting Fonts
14301 @subsection Formatting Fonts
14302
14303 There are specs for highlighting, and these are shared by all the format
14304 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
14305 the special @code{mouse-face} property set, which means that it will be
14306 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
14307 over it.
14308
14309 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
14310 normal faces set using @code{gnus-face-0}, which is @code{bold} by
14311 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
14312 and so on.  Create as many faces as you wish.  The same goes for the
14313 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
14314 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
14315
14316 Here's an alternative recipe for the group buffer:
14317
14318 @lisp
14319 ;; Create three face types.
14320 (setq gnus-face-1 'bold)
14321 (setq gnus-face-3 'italic)
14322
14323 ;; We want the article count to be in
14324 ;; a bold and green face.  So we create
14325 ;; a new face called `my-green-bold'.
14326 (copy-face 'bold 'my-green-bold)
14327 ;; Set the color.
14328 (set-face-foreground 'my-green-bold "ForestGreen")
14329 (setq gnus-face-2 'my-green-bold)
14330
14331 ;; Set the new & fancy format.
14332 (setq gnus-group-line-format
14333       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
14334 @end lisp
14335
14336 I'm sure you'll be able to use this scheme to create totally unreadable
14337 and extremely vulgar displays.  Have fun!
14338
14339 Note that the @samp{%(} specs (and friends) do not make any sense on the
14340 mode-line variables.
14341
14342
14343 @node Windows Configuration
14344 @section Windows Configuration
14345 @cindex windows configuration
14346
14347 No, there's nothing here about X, so be quiet.
14348
14349 @vindex gnus-use-full-window
14350 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
14351 other windows and occupy the entire Emacs screen by itself.  It is
14352 @code{t} by default.
14353
14354 Setting this variable to @code{nil} kinda works, but there are
14355 glitches.  Use at your own peril.
14356
14357 @vindex gnus-buffer-configuration
14358 @code{gnus-buffer-configuration} describes how much space each Gnus
14359 buffer should be given.  Here's an excerpt of this variable:
14360
14361 @lisp
14362 ((group (vertical 1.0 (group 1.0 point)
14363                       (if gnus-carpal (group-carpal 4))))
14364  (article (vertical 1.0 (summary 0.25 point)
14365                         (article 1.0))))
14366 @end lisp
14367
14368 This is an alist.  The @dfn{key} is a symbol that names some action or
14369 other.  For instance, when displaying the group buffer, the window
14370 configuration function will use @code{group} as the key.  A full list of
14371 possible names is listed below.
14372
14373 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
14374 should occupy.  To take the @code{article} split as an example -
14375
14376 @lisp
14377 (article (vertical 1.0 (summary 0.25 point)
14378                        (article 1.0)))
14379 @end lisp
14380
14381 This @dfn{split} says that the summary buffer should occupy 25% of upper
14382 half of the screen, and that it is placed over the article buffer.  As
14383 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
14384 reaching for that calculator there).  However, the special number
14385 @code{1.0} is used to signal that this buffer should soak up all the
14386 rest of the space available after the rest of the buffers have taken
14387 whatever they need.  There should be only one buffer with the @code{1.0}
14388 size spec per split.
14389
14390 Point will be put in the buffer that has the optional third element
14391 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
14392 split where the tag @code{frame-focus} is a member (i.e. is the third or
14393 fourth element in the list, depending on whether the @code{point} tag is
14394 present) gets focus.
14395
14396 Here's a more complicated example:
14397
14398 @lisp
14399 (article (vertical 1.0 (group 4)
14400                        (summary 0.25 point)
14401                        (if gnus-carpal (summary-carpal 4))
14402                        (article 1.0)))
14403 @end lisp
14404
14405 If the size spec is an integer instead of a floating point number,
14406 then that number will be used to say how many lines a buffer should
14407 occupy, not a percentage.
14408
14409 If the @dfn{split} looks like something that can be @code{eval}ed (to be
14410 precise---if the @code{car} of the split is a function or a subr), this
14411 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
14412 be used as a split.  This means that there will be three buffers if
14413 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
14414 is non-@code{nil}.
14415
14416 Not complicated enough for you?  Well, try this on for size:
14417
14418 @lisp
14419 (article (horizontal 1.0
14420              (vertical 0.5
14421                  (group 1.0)
14422                  (gnus-carpal 4))
14423              (vertical 1.0
14424                  (summary 0.25 point)
14425                  (summary-carpal 4)
14426                  (article 1.0))))
14427 @end lisp
14428
14429 Whoops.  Two buffers with the mystery 100% tag.  And what's that
14430 @code{horizontal} thingie?
14431
14432 If the first element in one of the split is @code{horizontal}, Gnus will
14433 split the window horizontally, giving you two windows side-by-side.
14434 Inside each of these strips you may carry on all you like in the normal
14435 fashion.  The number following @code{horizontal} says what percentage of
14436 the screen is to be given to this strip.
14437
14438 For each split, there @emph{must} be one element that has the 100% tag.
14439 The splitting is never accurate, and this buffer will eat any leftover
14440 lines from the splits.
14441
14442 To be slightly more formal, here's a definition of what a valid split
14443 may look like:
14444
14445 @example
14446 split       = frame | horizontal | vertical | buffer | form
14447 frame       = "(frame " size *split ")"
14448 horizontal  = "(horizontal " size *split ")"
14449 vertical    = "(vertical " size *split ")"
14450 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
14451 size        = number | frame-params
14452 buffer-name = group | article | summary ...
14453 @end example
14454
14455 The limitations are that the @code{frame} split can only appear as the
14456 top-level split.  @var{form} should be an Emacs Lisp form that should
14457 return a valid split.  We see that each split is fully recursive, and
14458 may contain any number of @code{vertical} and @code{horizontal} splits.
14459
14460 @vindex gnus-window-min-width
14461 @vindex gnus-window-min-height
14462 @cindex window height
14463 @cindex window width
14464 Finding the right sizes can be a bit complicated.  No window may be less
14465 than @code{gnus-window-min-height} (default 1) characters high, and all
14466 windows must be at least @code{gnus-window-min-width} (default 1)
14467 characters wide.  Gnus will try to enforce this before applying the
14468 splits.  If you want to use the normal Emacs window width/height limit,
14469 you can just set these two variables to @code{nil}.
14470
14471 If you're not familiar with Emacs terminology, @code{horizontal} and
14472 @code{vertical} splits may work the opposite way of what you'd expect.
14473 Windows inside a @code{horizontal} split are shown side-by-side, and
14474 windows within a @code{vertical} split are shown above each other.
14475
14476 @findex gnus-configure-frame
14477 If you want to experiment with window placement, a good tip is to call
14478 @code{gnus-configure-frame} directly with a split.  This is the function
14479 that does all the real work when splitting buffers.  Below is a pretty
14480 nonsensical configuration with 5 windows; two for the group buffer and
14481 three for the article buffer.  (I said it was nonsensical.)  If you
14482 @code{eval} the statement below, you can get an idea of how that would
14483 look straight away, without going through the normal Gnus channels.
14484 Play with it until you're satisfied, and then use
14485 @code{gnus-add-configuration} to add your new creation to the buffer
14486 configuration list.
14487
14488 @lisp
14489 (gnus-configure-frame
14490  '(horizontal 1.0
14491     (vertical 10
14492       (group 1.0)
14493       (article 0.3 point))
14494     (vertical 1.0
14495       (article 1.0)
14496       (horizontal 4
14497         (group 1.0)
14498         (article 10)))))
14499 @end lisp
14500
14501 You might want to have several frames as well.  No prob---just use the
14502 @code{frame} split:
14503
14504 @lisp
14505 (gnus-configure-frame
14506  '(frame 1.0
14507          (vertical 1.0
14508                    (summary 0.25 point frame-focus)
14509                    (article 1.0))
14510          (vertical ((height . 5) (width . 15)
14511                     (user-position . t)
14512                     (left . -1) (top . 1))
14513                    (picon 1.0))))
14514
14515 @end lisp
14516
14517 This split will result in the familiar summary/article window
14518 configuration in the first (or ``main'') frame, while a small additional
14519 frame will be created where picons will be shown.  As you can see,
14520 instead of the normal @code{1.0} top-level spec, each additional split
14521 should have a frame parameter alist as the size spec.
14522 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
14523 Reference Manual}.  Under XEmacs, a frame property list will be
14524 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
14525 is such a plist.
14526
14527 Here's a list of all possible keys for
14528 @code{gnus-buffer-configuration}:
14529
14530 @code{group}, @code{summary}, @code{article}, @code{server},
14531 @code{browse}, @code{message}, @code{pick}, @code{info},
14532 @code{summary-faq}, @code{edit-group}, @code{edit-server},
14533 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
14534 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
14535 @code{bug}, @code{compose-bounce}, and @code{score-trace}.
14536
14537 Note that the @code{message} key is used for both
14538 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
14539 it is desirable to distinguish between the two, something like this
14540 might be used:
14541
14542 @lisp
14543 (message (horizontal 1.0
14544                      (vertical 1.0 (message 1.0 point))
14545                      (vertical 0.24
14546                                (if (buffer-live-p gnus-summary-buffer)
14547                                    '(summary 0.5))
14548                                (group 1.0)))))
14549 @end lisp
14550
14551 @findex gnus-add-configuration
14552 Since the @code{gnus-buffer-configuration} variable is so long and
14553 complicated, there's a function you can use to ease changing the config
14554 of a single setting: @code{gnus-add-configuration}.  If, for instance,
14555 you want to change the @code{article} setting, you could say:
14556
14557 @lisp
14558 (gnus-add-configuration
14559  '(article (vertical 1.0
14560                (group 4)
14561                (summary .25 point)
14562                (article 1.0))))
14563 @end lisp
14564
14565 You'd typically stick these @code{gnus-add-configuration} calls in your
14566 @file{.gnus.el} file or in some startup hook---they should be run after
14567 Gnus has been loaded.
14568
14569 @vindex gnus-always-force-window-configuration
14570 If all windows mentioned in the configuration are already visible, Gnus
14571 won't change the window configuration.  If you always want to force the
14572 ``right'' window configuration, you can set
14573 @code{gnus-always-force-window-configuration} to non-@code{nil}.
14574
14575
14576 @node Faces and Fonts
14577 @section Faces and Fonts
14578 @cindex faces
14579 @cindex fonts
14580 @cindex colors
14581
14582 Fiddling with fonts and faces used to be very difficult, but these days
14583 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
14584 the face you want to alter, and alter it via the standard Customize
14585 interface.
14586
14587
14588 @node Compilation
14589 @section Compilation
14590 @cindex compilation
14591 @cindex byte-compilation
14592
14593 @findex gnus-compile
14594
14595 Remember all those line format specification variables?
14596 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
14597 on.  Now, Gnus will of course heed whatever these variables are, but,
14598 unfortunately, changing them will mean a quite significant slow-down.
14599 (The default values of these variables have byte-compiled functions
14600 associated with them, while the user-generated versions do not, of
14601 course.)
14602
14603 To help with this, you can run @kbd{M-x gnus-compile} after you've
14604 fiddled around with the variables and feel that you're (kind of)
14605 satisfied.  This will result in the new specs being byte-compiled, and
14606 you'll get top speed again.  Gnus will save these compiled specs in the
14607 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
14608 this function, though---you should compile them yourself by sticking
14609 them into the @code{.gnus.el} file and byte-compiling that file.)
14610
14611
14612 @node Mode Lines
14613 @section Mode Lines
14614 @cindex mode lines
14615
14616 @vindex gnus-updated-mode-lines
14617 @code{gnus-updated-mode-lines} says what buffers should keep their mode
14618 lines updated.  It is a list of symbols.  Supported symbols include
14619 @code{group}, @code{article}, @code{summary}, @code{server},
14620 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
14621 Gnus will keep that mode line updated with information that may be
14622 pertinent.  If this variable is @code{nil}, screen refresh may be
14623 quicker.
14624
14625 @cindex display-time
14626
14627 @vindex gnus-mode-non-string-length
14628 By default, Gnus displays information on the current article in the mode
14629 lines of the summary and article buffers.  The information Gnus wishes
14630 to display (e.g. the subject of the article) is often longer than the
14631 mode lines, and therefore have to be cut off at some point.  The
14632 @code{gnus-mode-non-string-length} variable says how long the other
14633 elements on the line is (i.e., the non-info part).  If you put
14634 additional elements on the mode line (e.g. a clock), you should modify
14635 this variable:
14636
14637 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
14638 @lisp
14639 (add-hook 'display-time-hook
14640           (lambda () (setq gnus-mode-non-string-length
14641                            (+ 21
14642                               (if line-number-mode 5 0)
14643                               (if column-number-mode 4 0)
14644                               (length display-time-string)))))
14645 @end lisp
14646
14647 If this variable is @code{nil} (which is the default), the mode line
14648 strings won't be chopped off, and they won't be padded either.  Note
14649 that the default is unlikely to be desirable, as even the percentage
14650 complete in the buffer may be crowded off the mode line; the user should
14651 configure this variable appropriately for her configuration.
14652
14653
14654 @node Highlighting and Menus
14655 @section Highlighting and Menus
14656 @cindex visual
14657 @cindex highlighting
14658 @cindex menus
14659
14660 @vindex gnus-visual
14661 The @code{gnus-visual} variable controls most of the Gnus-prettifying
14662 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
14663 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
14664 file.
14665
14666 This variable can be a list of visual properties that are enabled.  The
14667 following elements are valid, and are all included by default:
14668
14669 @table @code
14670 @item group-highlight
14671 Do highlights in the group buffer.
14672 @item summary-highlight
14673 Do highlights in the summary buffer.
14674 @item article-highlight
14675 Do highlights according to @code{gnus-article-display-hook} in the
14676 article buffer.
14677 @item highlight
14678 Turn on highlighting in all buffers.
14679 @item group-menu
14680 Create menus in the group buffer.
14681 @item summary-menu
14682 Create menus in the summary buffers.
14683 @item article-menu
14684 Create menus in the article buffer.
14685 @item browse-menu
14686 Create menus in the browse buffer.
14687 @item server-menu
14688 Create menus in the server buffer.
14689 @item score-menu
14690 Create menus in the score buffers.
14691 @item menu
14692 Create menus in all buffers.
14693 @end table
14694
14695 So if you only want highlighting in the article buffer and menus in all
14696 buffers, you could say something like:
14697
14698 @lisp
14699 (setq gnus-visual '(article-highlight menu))
14700 @end lisp
14701
14702 If you want highlighting only and no menus whatsoever, you'd say:
14703
14704 @lisp
14705 (setq gnus-visual '(highlight))
14706 @end lisp
14707
14708 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14709 in all Gnus buffers.
14710
14711 Other general variables that influence the look of all buffers include:
14712
14713 @table @code
14714 @item gnus-mouse-face
14715 @vindex gnus-mouse-face
14716 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
14717 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
14718
14719 @end table
14720
14721 There are hooks associated with the creation of all the different menus:
14722
14723 @table @code
14724
14725 @item gnus-article-menu-hook
14726 @vindex gnus-article-menu-hook
14727 Hook called after creating the article mode menu.
14728
14729 @item gnus-group-menu-hook
14730 @vindex gnus-group-menu-hook
14731 Hook called after creating the group mode menu.
14732
14733 @item gnus-summary-menu-hook
14734 @vindex gnus-summary-menu-hook
14735 Hook called after creating the summary mode menu.
14736
14737 @item gnus-server-menu-hook
14738 @vindex gnus-server-menu-hook
14739 Hook called after creating the server mode menu.
14740
14741 @item gnus-browse-menu-hook
14742 @vindex gnus-browse-menu-hook
14743 Hook called after creating the browse mode menu.
14744
14745 @item gnus-score-menu-hook
14746 @vindex gnus-score-menu-hook
14747 Hook called after creating the score mode menu.
14748
14749 @end table
14750
14751
14752 @node Buttons
14753 @section Buttons
14754 @cindex buttons
14755 @cindex mouse
14756 @cindex click
14757
14758 Those new-fangled @dfn{mouse} contraptions is very popular with the
14759 young, hep kids who don't want to learn the proper way to do things
14760 these days.  Why, I remember way back in the summer of '89, when I was
14761 using Emacs on a Tops 20 system.  Three hundred users on one single
14762 machine, and every user was running Simula compilers.  Bah!
14763
14764 Right.
14765
14766 @vindex gnus-carpal
14767 Well, you can make Gnus display bufferfuls of buttons you can click to
14768 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
14769 really.  Tell the chiropractor I sent you.
14770
14771
14772 @table @code
14773
14774 @item gnus-carpal-mode-hook
14775 @vindex gnus-carpal-mode-hook
14776 Hook run in all carpal mode buffers.
14777
14778 @item gnus-carpal-button-face
14779 @vindex gnus-carpal-button-face
14780 Face used on buttons.
14781
14782 @item gnus-carpal-header-face
14783 @vindex gnus-carpal-header-face
14784 Face used on carpal buffer headers.
14785
14786 @item gnus-carpal-group-buffer-buttons
14787 @vindex gnus-carpal-group-buffer-buttons
14788 Buttons in the group buffer.
14789
14790 @item gnus-carpal-summary-buffer-buttons
14791 @vindex gnus-carpal-summary-buffer-buttons
14792 Buttons in the summary buffer.
14793
14794 @item gnus-carpal-server-buffer-buttons
14795 @vindex gnus-carpal-server-buffer-buttons
14796 Buttons in the server buffer.
14797
14798 @item gnus-carpal-browse-buffer-buttons
14799 @vindex gnus-carpal-browse-buffer-buttons
14800 Buttons in the browse buffer.
14801 @end table
14802
14803 All the @code{buttons} variables are lists.  The elements in these list
14804 are either cons cells where the @code{car} contains a text to be displayed and
14805 the @code{cdr} contains a function symbol, or a simple string.
14806
14807
14808 @node Daemons
14809 @section Daemons
14810 @cindex demons
14811 @cindex daemons
14812
14813 Gnus, being larger than any program ever written (allegedly), does lots
14814 of strange stuff that you may wish to have done while you're not
14815 present.  For instance, you may want it to check for new mail once in a
14816 while.  Or you may want it to close down all connections to all servers
14817 when you leave Emacs idle.  And stuff like that.
14818
14819 Gnus will let you do stuff like that by defining various
14820 @dfn{handlers}.  Each handler consists of three elements:  A
14821 @var{function}, a @var{time}, and an @var{idle} parameter.
14822
14823 Here's an example of a handler that closes connections when Emacs has
14824 been idle for thirty minutes:
14825
14826 @lisp
14827 (gnus-demon-close-connections nil 30)
14828 @end lisp
14829
14830 Here's a handler that scans for PGP headers every hour when Emacs is
14831 idle:
14832
14833 @lisp
14834 (gnus-demon-scan-pgp 60 t)
14835 @end lisp
14836
14837 This @var{time} parameter and than @var{idle} parameter work together
14838 in a strange, but wonderful fashion.  Basically, if @var{idle} is
14839 @code{nil}, then the function will be called every @var{time} minutes.
14840
14841 If @var{idle} is @code{t}, then the function will be called after
14842 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
14843 the function will never be called.  But once Emacs goes idle, the
14844 function will be called every @var{time} minutes.
14845
14846 If @var{idle} is a number and @var{time} is a number, the function will
14847 be called every @var{time} minutes only when Emacs has been idle for
14848 @var{idle} minutes.
14849
14850 If @var{idle} is a number and @var{time} is @code{nil}, the function
14851 will be called once every time Emacs has been idle for @var{idle}
14852 minutes.
14853
14854 And if @var{time} is a string, it should look like @samp{07:31}, and
14855 the function will then be called once every day somewhere near that
14856 time.  Modified by the @var{idle} parameter, of course.
14857
14858 @vindex gnus-demon-timestep
14859 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
14860 seconds.  This is 60 by default.  If you change that variable,
14861 all the timings in the handlers will be affected.)
14862
14863 @vindex gnus-use-demon
14864 To set the whole thing in motion, though, you have to set
14865 @code{gnus-use-demon} to @code{t}.
14866
14867 So, if you want to add a handler, you could put something like this in
14868 your @file{.gnus} file:
14869
14870 @findex gnus-demon-add-handler
14871 @lisp
14872 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
14873 @end lisp
14874
14875 @findex gnus-demon-add-nocem
14876 @findex gnus-demon-add-scanmail
14877 @findex gnus-demon-add-rescan
14878 @findex gnus-demon-add-scan-timestamps
14879 @findex gnus-demon-add-disconnection
14880 Some ready-made functions to do this have been created:
14881 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
14882 @code{gnus-demon-add-nntp-close-connection},
14883 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
14884 @code{gnus-demon-add-scanmail}.  Just put those functions in your
14885 @file{.gnus} if you want those abilities.
14886
14887 @findex gnus-demon-init
14888 @findex gnus-demon-cancel
14889 @vindex gnus-demon-handlers
14890 If you add handlers to @code{gnus-demon-handlers} directly, you should
14891 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
14892 daemons, you can use the @code{gnus-demon-cancel} function.
14893
14894 Note that adding daemons can be pretty naughty if you over do it.  Adding
14895 functions that scan all news and mail from all servers every two seconds
14896 is a sure-fire way of getting booted off any respectable system.  So
14897 behave.
14898
14899
14900 @node NoCeM
14901 @section NoCeM
14902 @cindex nocem
14903 @cindex spam
14904
14905 @dfn{Spamming} is posting the same article lots and lots of times.
14906 Spamming is bad.  Spamming is evil.
14907
14908 Spamming is usually canceled within a day or so by various anti-spamming
14909 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
14910 NoCeM is pronounced ``no see-'em'', and means what the name
14911 implies---these are messages that make the offending articles, like, go
14912 away.
14913
14914 What use are these NoCeM messages if the articles are canceled anyway?
14915 Some sites do not honor cancel messages and some sites just honor cancels
14916 from a select few people.  Then you may wish to make use of the NoCeM
14917 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
14918
14919 Gnus can read and parse the messages in this group automatically, and
14920 this will make spam disappear.
14921
14922 There are some variables to customize, of course:
14923
14924 @table @code
14925 @item gnus-use-nocem
14926 @vindex gnus-use-nocem
14927 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
14928 by default.
14929
14930 @item gnus-nocem-groups
14931 @vindex gnus-nocem-groups
14932 Gnus will look for NoCeM messages in the groups in this list.  The
14933 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
14934 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
14935
14936 @item gnus-nocem-issuers
14937 @vindex gnus-nocem-issuers
14938 There are many people issuing NoCeM messages.  This list says what
14939 people you want to listen to.  The default is @code{("Automoose-1"
14940 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
14941 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
14942 (Richard E. Depew)")}; fine, upstanding citizens all of them.
14943
14944 Known despammers that you can put in this list include:
14945
14946 @table @samp
14947 @item clewis@@ferret.ocunix.on.ca;
14948 @cindex Chris Lewis
14949 Chris Lewis---Major Canadian despammer who has probably canceled more
14950 usenet abuse than anybody else.
14951
14952 @item Automoose-1
14953 @cindex CancelMoose[tm]
14954 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
14955 Norwegian, and was the person(s) who invented NoCeM.
14956
14957 @item jem@@xpat.com;
14958 @cindex Jem
14959 John Milburn---despammer located in Korea who is getting very busy these
14960 days.
14961
14962 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
14963 Richard E. Depew---lone American despammer.  He mostly cancels binary
14964 postings to non-binary groups and removes spews (regurgitated articles).
14965 @end table
14966
14967 You do not have to heed NoCeM messages from all these people---just the
14968 ones you want to listen to.  You also don't have to accept all NoCeM
14969 messages from the people you like.  Each NoCeM message has a @dfn{type}
14970 header that gives the message a (more or less, usually less) rigorous
14971 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
14972 @samp{binary}, and @samp{troll}.  To specify this, you have to use
14973 @var{(issuer conditions ...)} elements in the list.  Each condition is
14974 either a string (which is a regexp that matches types you want to use)
14975 or a list on the form @code{(not STRING)}, where @var{string} is a
14976 regexp that matches types you don't want to use.
14977
14978 For instance, if you want all NoCeM messages from Chris Lewis except his
14979 @samp{troll} messages, you'd say:
14980
14981 @lisp
14982 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
14983 @end lisp
14984
14985 On the other hand, if you just want nothing but his @samp{spam} and
14986 @samp{spew} messages, you'd say:
14987
14988 @lisp
14989 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
14990 @end lisp
14991
14992 The specs are applied left-to-right.
14993
14994
14995 @item gnus-nocem-verifyer
14996 @vindex gnus-nocem-verifyer
14997 @findex mc-verify
14998 This should be a function for verifying that the NoCeM issuer is who she
14999 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
15000 function.  If this is too slow and you don't care for verification
15001 (which may be dangerous), you can set this variable to @code{nil}.
15002
15003 If you want signed NoCeM messages to be verified and unsigned messages
15004 not to be verified (but used anyway), you could do something like:
15005
15006 @lisp
15007 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15008
15009 (defun my-gnus-mc-verify ()
15010   (not (eq 'forged
15011            (ignore-errors
15012              (if (mc-verify)
15013                  t
15014                'forged)))))
15015 @end lisp
15016
15017 This might be dangerous, though.
15018
15019 @item gnus-nocem-directory
15020 @vindex gnus-nocem-directory
15021 This is where Gnus will store its NoCeM cache files.  The default is
15022 @file{~/News/NoCeM/}.
15023
15024 @item gnus-nocem-expiry-wait
15025 @vindex gnus-nocem-expiry-wait
15026 The number of days before removing old NoCeM entries from the cache.
15027 The default is 15.  If you make it shorter Gnus will be faster, but you
15028 might then see old spam.
15029
15030 @end table
15031
15032 Using NoCeM could potentially be a memory hog.  If you have many living
15033 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15034 big.  If this is a problem, you should kill off all (or most) of your
15035 unsubscribed groups (@pxref{Subscription Commands}).
15036
15037
15038 @node Undo
15039 @section Undo
15040 @cindex undo
15041
15042 It is very useful to be able to undo actions one has done.  In normal
15043 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15044 In Gnus buffers, however, it isn't that simple.
15045
15046 The things Gnus displays in its buffer is of no value whatsoever to
15047 Gnus---it's all just data designed to look nice to the user.
15048 Killing a group in the group buffer with @kbd{C-k} makes the line
15049 disappear, but that's just a side-effect of the real action---the
15050 removal of the group in question from the internal Gnus structures.
15051 Undoing something like that can't be done by the normal Emacs
15052 @code{undo} function.
15053
15054 Gnus tries to remedy this somewhat by keeping track of what the user
15055 does and coming up with actions that would reverse the actions the user
15056 takes.  When the user then presses the @code{undo} key, Gnus will run
15057 the code to reverse the previous action, or the previous actions.
15058 However, not all actions are easily reversible, so Gnus currently offers
15059 a few key functions to be undoable.  These include killing groups,
15060 yanking groups, and changing the list of read articles of groups.
15061 That's it, really.  More functions may be added in the future, but each
15062 added function means an increase in data to be stored, so Gnus will
15063 never be totally undoable.
15064
15065 @findex gnus-undo-mode
15066 @vindex gnus-use-undo
15067 @findex gnus-undo
15068 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
15069 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15070 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
15071 command, which should feel kinda like the normal Emacs @code{undo}
15072 command.
15073
15074
15075 @node Moderation
15076 @section Moderation
15077 @cindex moderation
15078
15079 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15080 It is not included in the standard Gnus package.  Write a mail to
15081 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15082 get a copy.
15083
15084 The moderation package is implemented as a minor mode for summary
15085 buffers.  Put
15086
15087 @lisp
15088 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15089 @end lisp
15090
15091 in your @file{.gnus.el} file.
15092
15093 If you are the moderator of @samp{rec.zoofle}, this is how it's
15094 supposed to work:
15095
15096 @enumerate
15097 @item
15098 You split your incoming mail by matching on
15099 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15100 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15101
15102 @item
15103 You enter that group once in a while and post articles using the @kbd{e}
15104 (edit-and-post) or @kbd{s} (just send unedited) commands.
15105
15106 @item
15107 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15108 articles that weren't approved by you, you can cancel them with the
15109 @kbd{c} command.
15110 @end enumerate
15111
15112 To use moderation mode in these two groups, say:
15113
15114 @lisp
15115 (setq gnus-moderated-list
15116       "^nnml:rec.zoofle$\\|^rec.zoofle$")
15117 @end lisp
15118
15119
15120 @node XEmacs Enhancements
15121 @section XEmacs Enhancements
15122 @cindex XEmacs
15123
15124 XEmacs is able to display pictures and stuff, so Gnus has taken
15125 advantage of that.
15126
15127 @menu
15128 * Picons::    How to display pictures of what your reading.
15129 * Smileys::   Show all those happy faces the way they were meant to be shown.
15130 * Toolbar::   Click'n'drool.
15131 * XVarious::  Other XEmacsy Gnusey variables.
15132 @end menu
15133
15134
15135 @node Picons
15136 @subsection Picons
15137
15138 @iftex
15139 @iflatex
15140 \include{picons}
15141 @end iflatex
15142 @end iftex
15143
15144 So...  You want to slow down your news reader even more!  This is a
15145 good way to do so.  Its also a great way to impress people staring
15146 over your shoulder as you read news.
15147
15148 @menu
15149 * Picon Basics::           What are picons and How do I get them.
15150 * Picon Requirements::     Don't go further if you aren't using XEmacs.
15151 * Easy Picons::            Displaying Picons---the easy way.
15152 * Hard Picons::            The way you should do it.  You'll learn something.
15153 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15154 @end menu
15155
15156
15157 @node Picon Basics
15158 @subsubsection Picon Basics
15159
15160 What are Picons?  To quote directly from the Picons Web site:
15161
15162 @iftex
15163 @iflatex
15164 \margindex{}
15165 @end iflatex
15166 @end iftex
15167
15168 @quotation
15169 @dfn{Picons} is short for ``personal icons''.  They're small,
15170 constrained images used to represent users and domains on the net,
15171 organized into databases so that the appropriate image for a given
15172 e-mail address can be found.  Besides users and domains, there are picon
15173 databases for Usenet newsgroups and weather forecasts.  The picons are
15174 in either monochrome @code{XBM} format or color @code{XPM} and
15175 @code{GIF} formats.
15176 @end quotation
15177
15178 @vindex gnus-picons-piconsearch-url
15179 If you have a permanent connection to the Internet you can use Steve
15180 Kinzler's Picons Search engine by setting
15181 @code{gnus-picons-piconsearch-url} to the string @*
15182 @file{http://www.cs.indiana.edu/picons/search.html}.
15183
15184 @vindex gnus-picons-database
15185 Otherwise you need a local copy of his database.  For instructions on
15186 obtaining and installing the picons databases, point your Web browser at @*
15187 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
15188 picons to be installed into a location pointed to by
15189 @code{gnus-picons-database}.
15190
15191
15192 @node Picon Requirements
15193 @subsubsection Picon Requirements
15194
15195 To have Gnus display Picons for you, you must be running XEmacs
15196 19.13 or greater since all other versions of Emacs aren't yet able to
15197 display images.
15198
15199 Additionally, you must have @code{x} support compiled into XEmacs.  To
15200 display color picons which are much nicer than the black & white one,
15201 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
15202
15203 @vindex gnus-picons-convert-x-face
15204 If you want to display faces from @code{X-Face} headers, you should have
15205 the @code{xface} support compiled into XEmacs.  Otherwise you must have
15206 the @code{netpbm} utilities installed, or munge the
15207 @code{gnus-picons-convert-x-face} variable to use something else.
15208
15209
15210 @node Easy Picons
15211 @subsubsection Easy Picons
15212
15213 To enable displaying picons, simply put the following line in your
15214 @file{~/.gnus} file and start Gnus.
15215
15216 @lisp
15217 (setq gnus-use-picons t)
15218 (add-hook 'gnus-article-display-hook
15219           'gnus-article-display-picons t)
15220 (add-hook 'gnus-article-display-hook
15221           'gnus-picons-article-display-x-face)
15222 @end lisp
15223
15224 and make sure @code{gnus-picons-database} points to the directory
15225 containing the Picons databases.
15226
15227 Alternatively if you want to use the web piconsearch engine add this:
15228
15229 @lisp
15230 (setq gnus-picons-piconsearch-url
15231       "http://www.cs.indiana.edu:800/piconsearch")
15232 @end lisp
15233
15234
15235 @node Hard Picons
15236 @subsubsection Hard Picons
15237
15238 @iftex
15239 @iflatex
15240 \margindex{}
15241 @end iflatex
15242 @end iftex
15243
15244 Gnus can display picons for you as you enter and leave groups and
15245 articles.  It knows how to interact with three sections of the picons
15246 database.  Namely, it can display the picons newsgroup pictures,
15247 author's face picture(s), and the authors domain.  To enable this
15248 feature, you need to select where to get the picons from, and where to
15249 display them.
15250
15251 @table @code
15252
15253 @item gnus-picons-database
15254 @vindex gnus-picons-database
15255 The location of the picons database.  Should point to a directory
15256 containing the @file{news}, @file{domains}, @file{users} (and so on)
15257 subdirectories.  This is only useful if
15258 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
15259 @file{/usr/local/faces/}.
15260
15261 @item gnus-picons-piconsearch-url
15262 @vindex gnus-picons-piconsearch-url
15263 The URL for the web picons search engine.  The only currently known
15264 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
15265 workaround network delays, icons will be fetched in the background.  If
15266 this is @code{nil} 'the default), then picons are fetched from local
15267 database indicated by @code{gnus-picons-database}.
15268
15269 @item gnus-picons-display-where
15270 @vindex gnus-picons-display-where
15271 Where the picon images should be displayed.  It is @code{picons} by
15272 default (which by default maps to the buffer @samp{*Picons*}).  Other
15273 valid places could be @code{article}, @code{summary}, or
15274 @samp{*scratch*} for all I care.  Just make sure that you've made the
15275 buffer visible using the standard Gnus window configuration
15276 routines---@pxref{Windows Configuration}.
15277
15278 @item gnus-picons-group-excluded-groups
15279 @vindex gnus-picons-group-excluded-groups
15280 Groups that are matched by this regexp won't have their group icons
15281 displayed.
15282
15283 @end table
15284
15285 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
15286 window configuration for you to include the @code{picons} buffer.
15287
15288 Now that you've made those decision, you need to add the following
15289 functions to the appropriate hooks so these pictures will get displayed
15290 at the right time.
15291
15292 @vindex gnus-article-display-hook
15293 @vindex gnus-picons-display-where
15294 @table @code
15295 @item gnus-article-display-picons
15296 @findex gnus-article-display-picons
15297 Looks up and displays the picons for the author and the author's domain
15298 in the @code{gnus-picons-display-where} buffer.  Should be added to the
15299 @code{gnus-article-display-hook}.
15300
15301 @item gnus-picons-article-display-x-face
15302 @findex gnus-article-display-picons
15303 Decodes and displays the X-Face header if present.  This function
15304 should be added to @code{gnus-article-display-hook}.
15305
15306 @end table
15307
15308 Note:  You must append them to the hook, so make sure to specify 't'
15309 for the append flag of @code{add-hook}:
15310
15311 @lisp
15312 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
15313 @end lisp
15314
15315
15316 @node Picon Useless Configuration
15317 @subsubsection Picon Useless Configuration
15318
15319 @iftex
15320 @iflatex
15321 \margindex{}
15322 @end iflatex
15323 @end iftex
15324
15325 The following variables offer further control over how things are
15326 done, where things are located, and other useless stuff you really
15327 don't need to worry about.
15328
15329 @table @code
15330
15331 @item gnus-picons-news-directories
15332 @vindex gnus-picons-news-directories
15333 List of subdirectories to search in @code{gnus-picons-database} for
15334 newsgroups faces.  @code{("news")} is the default.
15335
15336 @item gnus-picons-user-directories
15337 @vindex gnus-picons-user-directories
15338 List of subdirectories to search in @code{gnus-picons-database} for user
15339 faces.  @code{("local" "users" "usenix" "misc")} is the default.
15340
15341 @item gnus-picons-domain-directories
15342 @vindex gnus-picons-domain-directories
15343 List of subdirectories to search in @code{gnus-picons-database} for
15344 domain name faces.  Defaults to @code{("domains")}.  Some people may
15345 want to add @samp{"unknown"} to this list.
15346
15347 @item gnus-picons-convert-x-face
15348 @vindex gnus-picons-convert-x-face
15349 If you don't have @code{xface} support builtin XEmacs, this is the
15350 command to use to convert the @code{X-Face} header to an X bitmap
15351 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
15352 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
15353 gnus-picons-x-face-file-name)}
15354
15355 @item gnus-picons-x-face-file-name
15356 @vindex gnus-picons-x-face-file-name
15357 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
15358 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
15359
15360 @item gnus-picons-has-modeline-p
15361 @vindex gnus-picons-has-modeline-p
15362 If you have set @code{gnus-picons-display-where} to @code{picons}, your
15363 XEmacs frame will become really cluttered.  To alleviate this a bit you
15364 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
15365 remove the mode line from the Picons buffer.  This is only useful if
15366 @code{gnus-picons-display-where} is @code{picons}.
15367
15368 @item gnus-picons-refresh-before-display
15369 @vindex gnus-picons-refresh-before-display
15370 If non-nil, display the article buffer before computing the picons.
15371 Defaults to @code{nil}.
15372
15373 @item gnus-picons-display-as-address
15374 @vindex gnus-picons-display-as-address
15375 If @code{t} display textual email addresses along with pictures.
15376 Defaults to @code{t}.
15377
15378 @item gnus-picons-file-suffixes
15379 @vindex gnus-picons-file-suffixes
15380 Ordered list of suffixes on picon file names to try.  Defaults to
15381 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
15382
15383 @item gnus-picons-display-article-move-p
15384 @vindex gnus-picons-display-article-move-p
15385 Whether to move point to first empty line when displaying picons.  This
15386 has only an effect if `gnus-picons-display-where' has value `article'.
15387
15388 @item gnus-picons-clear-cache-on-shutdown
15389 @vindex gnus-picons-clear-cache-on-shutdown
15390 Whether to clear the picons cache when exiting gnus.  Gnus caches every
15391 picons it finds while it is running.  This saves some time in the search
15392 process but eats some memory.  If this variable is set to @code{nil},
15393 Gnus will never clear the cache itself; you will have to manually call
15394 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
15395 cleared every time you exit Gnus.  Defaults to @code{t}.
15396
15397 @iftex
15398 @iflatex
15399 \margindex{}
15400 @end iflatex
15401 @end iftex
15402
15403 @end table
15404
15405 @node Smileys
15406 @subsection Smileys
15407 @cindex smileys
15408
15409 @iftex
15410 @iflatex
15411 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
15412 \input{smiley}
15413 @end iflatex
15414 @end iftex
15415
15416 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
15417 currently the only package that uses Smiley, it is documented here.
15418
15419 In short---to use Smiley in Gnus, put the following in your
15420 @file{.gnus.el} file:
15421
15422 @lisp
15423 (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
15424 @end lisp
15425
15426 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
15427 the like---to pictures and displays those instead of the text smiley
15428 faces.  The conversion is controlled by a list of regexps that matches
15429 text and maps that to file names.
15430
15431 @vindex smiley-nosey-regexp-alist
15432 @vindex smiley-deformed-regexp-alist
15433 Smiley supplies two example conversion alists by default:
15434 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
15435 and so on), and @code{smiley-nosey-regexp-alist} (which matches
15436 @samp{:-)}, @samp{:-(} and so on).
15437
15438 The alist used is specified by the @code{smiley-regexp-alist} variable,
15439 which defaults to the value of @code{smiley-deformed-regexp-alist}.
15440
15441 The first item in each element is the regexp to be matched; the second
15442 element is the regexp match group that is to be replaced by the picture;
15443 and the third element is the name of the file to be displayed.
15444
15445 The following variables customize where Smiley will look for these
15446 files, as well as the color to be used and stuff:
15447
15448 @table @code
15449
15450 @item smiley-data-directory
15451 @vindex smiley-data-directory
15452 Where Smiley will look for smiley faces files.
15453
15454 @item smiley-flesh-color
15455 @vindex smiley-flesh-color
15456 Skin color.  The default is @samp{yellow}, which is really racist.
15457
15458 @item smiley-features-color
15459 @vindex smiley-features-color
15460 Color of the features of the face.  The default is @samp{black}.
15461
15462 @item smiley-tongue-color
15463 @vindex smiley-tongue-color
15464 Color of the tongue.  The default is @samp{red}.
15465
15466 @item smiley-circle-color
15467 @vindex smiley-circle-color
15468 Color of the circle around the face.  The default is @samp{black}.
15469
15470 @item smiley-mouse-face
15471 @vindex smiley-mouse-face
15472 Face used for mouse highlighting over the smiley face.
15473
15474 @end table
15475
15476
15477 @node Toolbar
15478 @subsection Toolbar
15479
15480 @table @code
15481
15482 @iftex
15483 @iflatex
15484 \margindex{}
15485 @end iflatex
15486 @end iftex
15487
15488 @item gnus-use-toolbar
15489 @vindex gnus-use-toolbar
15490 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
15491 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
15492 @code{right-toolbar}, or @code{left-toolbar}.
15493
15494 @item gnus-group-toolbar
15495 @vindex gnus-group-toolbar
15496 The toolbar in the group buffer.
15497
15498 @item gnus-summary-toolbar
15499 @vindex gnus-summary-toolbar
15500 The toolbar in the summary buffer.
15501
15502 @item gnus-summary-mail-toolbar
15503 @vindex gnus-summary-mail-toolbar
15504 The toolbar in the summary buffer of mail groups.
15505
15506 @end table
15507
15508
15509 @node XVarious
15510 @subsection Various XEmacs Variables
15511
15512 @table @code
15513 @item gnus-xmas-glyph-directory
15514 @vindex gnus-xmas-glyph-directory
15515 This is where Gnus will look for pictures.  Gnus will normally
15516 auto-detect this directory, but you may set it manually if you have an
15517 unusual directory structure.
15518
15519 @item gnus-xmas-logo-color-alist
15520 @vindex gnus-xmas-logo-color-alist
15521 This is an alist where the key is a type symbol and the values are the
15522 foreground and background color of the splash page glyph.
15523
15524 @item gnus-xmas-logo-color-style
15525 @vindex gnus-xmas-logo-color-style
15526 This is the key used to look up the color in the alist described above.
15527 Valid values include @code{flame}, @code{pine}, @code{moss},
15528 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
15529 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
15530
15531 @item gnus-xmas-modeline-glyph
15532 @vindex gnus-xmas-modeline-glyph
15533 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
15534 default.
15535
15536 @iftex
15537 @iflatex
15538 \margindex{}
15539 @end iflatex
15540 @end iftex
15541
15542 @end table
15543
15544
15545
15546
15547 @node Fuzzy Matching
15548 @section Fuzzy Matching
15549 @cindex fuzzy matching
15550
15551 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
15552 things like scoring, thread gathering and thread comparison.
15553
15554 As opposed to regular expression matching, fuzzy matching is very fuzzy.
15555 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
15556 means, and the implementation has changed over time.
15557
15558 Basically, it tries to remove all noise from lines before comparing.
15559 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
15560 out of the strings before comparing the results.  This often leads to
15561 adequate results---even when faced with strings generated by text
15562 manglers masquerading as newsreaders.
15563
15564
15565 @node Thwarting Email Spam
15566 @section Thwarting Email Spam
15567 @cindex email spam
15568 @cindex spam
15569 @cindex UCE
15570 @cindex unsolicited commercial email
15571
15572 In these last days of the Usenet, commercial vultures are hanging about
15573 and grepping through news like crazy to find email addresses they can
15574 foist off their scams and products to.  As a reaction to this, many
15575 people have started putting nonsense addresses into their @code{From}
15576 lines.  I think this is counterproductive---it makes it difficult for
15577 people to send you legitimate mail in response to things you write, as
15578 well as making it difficult to see who wrote what.  This rewriting may
15579 perhaps be a bigger menace than the unsolicited commercial email itself
15580 in the end.
15581
15582 The biggest problem I have with email spam is that it comes in under
15583 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
15584 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
15585 mail group, only to find two pyramid schemes, seven advertisements
15586 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
15587 and one mail asking me to repent and find some god.
15588
15589 This is annoying.
15590
15591 The way to deal with this is having Gnus split out all spam into a
15592 @samp{spam} mail group (@pxref{Splitting Mail}).
15593
15594 First, pick one (1) valid mail address that you can be reached at, and
15595 put it in your @code{From} header of all your news articles.  (I've
15596 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
15597 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
15598 sysadm whether your sendmail installation accepts keywords in the local
15599 part of the mail address.)
15600
15601 @lisp
15602 (setq message-default-news-headers
15603       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
15604 @end lisp
15605
15606 Then put the following split rule in @code{nnmail-split-fancy}
15607 (@pxref{Fancy Mail Splitting}):
15608
15609 @lisp
15610 (
15611  ...
15612  (to "larsi@@trym.ifi.uio.no"
15613       (| ("subject" "re:.*" "misc")
15614          ("references" ".*@@.*" "misc")
15615          "spam"))
15616  ...
15617 )
15618 @end lisp
15619
15620 This says that all mail to this address is suspect, but if it has a
15621 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
15622 header, it's probably ok.  All the rest goes to the @samp{spam} group.
15623 (This idea probably comes from Tim Pierce.)
15624
15625 In addition, many mail spammers talk directly to your @code{smtp} server
15626 and do not include your email address explicitly in the @code{To}
15627 header.  Why they do this is unknown---perhaps it's to thwart this
15628 thwarting scheme?  In any case, this is trivial to deal with---you just
15629 put anything not addressed to you in the @samp{spam} group by ending
15630 your fancy split rule in this way:
15631
15632 @lisp
15633 (
15634  ...
15635  (to "larsi" "misc")
15636  "spam")
15637 @end lisp
15638
15639 In my experience, this will sort virtually everything into the right
15640 group.  You still have to check the @samp{spam} group from time to time to
15641 check for legitimate mail, though.  If you feel like being a good net
15642 citizen, you can even send off complaints to the proper authorities on
15643 each unsolicited commercial email---at your leisure.
15644
15645 If you are also a lazy net citizen, you will probably prefer complaining
15646 automatically with the @file{gnus-junk.el} package, available FOR FREE
15647 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
15648 Since most e-mail spam is sent automatically, this may reconcile the
15649 cosmic balance somewhat.
15650
15651 This works for me.  It allows people an easy way to contact me (they can
15652 just press @kbd{r} in the usual way), and I'm not bothered at all with
15653 spam.  It's a win-win situation.  Forging @code{From} headers to point
15654 to non-existent domains is yucky, in my opinion.
15655
15656
15657 @node Various Various
15658 @section Various Various
15659 @cindex mode lines
15660 @cindex highlights
15661
15662 @table @code
15663
15664 @item gnus-home-directory
15665 All Gnus path variables will be initialized from this variable, which
15666 defaults to @file{~/}.
15667
15668 @item gnus-directory
15669 @vindex gnus-directory
15670 Most Gnus storage path variables will be initialized from this variable,
15671 which defaults to the @samp{SAVEDIR} environment variable, or
15672 @file{~/News/} if that variable isn't set.
15673
15674 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
15675 This means that other directory variables that are initialized from this
15676 variable won't be set properly if you set this variable in
15677 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
15678
15679 @item gnus-default-directory
15680 @vindex gnus-default-directory
15681 Not related to the above variable at all---this variable says what the
15682 default directory of all Gnus buffers should be.  If you issue commands
15683 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
15684 default directory.  If this variable is @code{nil} (which is the
15685 default), the default directory will be the default directory of the
15686 buffer you were in when you started Gnus.
15687
15688 @item gnus-verbose
15689 @vindex gnus-verbose
15690 This variable is an integer between zero and ten.  The higher the value,
15691 the more messages will be displayed.  If this variable is zero, Gnus
15692 will never flash any messages, if it is seven (which is the default),
15693 most important messages will be shown, and if it is ten, Gnus won't ever
15694 shut up, but will flash so many messages it will make your head swim.
15695
15696 @item gnus-verbose-backends
15697 @vindex gnus-verbose-backends
15698 This variable works the same way as @code{gnus-verbose}, but it applies
15699 to the Gnus backends instead of Gnus proper.
15700
15701 @item nnheader-max-head-length
15702 @vindex nnheader-max-head-length
15703 When the backends read straight heads of articles, they all try to read
15704 as little as possible.  This variable (default 4096) specifies
15705 the absolute max length the backends will try to read before giving up
15706 on finding a separator line between the head and the body.  If this
15707 variable is @code{nil}, there is no upper read bound.  If it is
15708 @code{t}, the backends won't try to read the articles piece by piece,
15709 but read the entire articles.  This makes sense with some versions of
15710 @code{ange-ftp} or @code{efs}.
15711
15712 @item nnheader-head-chop-length
15713 @vindex nnheader-head-chop-length
15714 This variable (default 2048) says how big a piece of each article to
15715 read when doing the operation described above.
15716
15717 @item nnheader-file-name-translation-alist
15718 @vindex nnheader-file-name-translation-alist
15719 @cindex file names
15720 @cindex invalid characters in file names
15721 @cindex characters in file names
15722 This is an alist that says how to translate characters in file names.
15723 For instance, if @samp{:} is invalid as a file character in file names
15724 on your system (you OS/2 user you), you could say something like:
15725
15726 @lisp
15727 (setq nnheader-file-name-translation-alist
15728       '((?: . ?_)))
15729 @end lisp
15730
15731 In fact, this is the default value for this variable on OS/2 and MS
15732 Windows (phooey) systems.
15733
15734 @item gnus-hidden-properties
15735 @vindex gnus-hidden-properties
15736 This is a list of properties to use to hide ``invisible'' text.  It is
15737 @code{(invisible t intangible t)} by default on most systems, which
15738 makes invisible text invisible and intangible.
15739
15740 @item gnus-parse-headers-hook
15741 @vindex gnus-parse-headers-hook
15742 A hook called before parsing headers.  It can be used, for instance, to
15743 gather statistics on the headers fetched, or perhaps you'd like to prune
15744 some headers.  I don't see why you'd want that, though.
15745
15746 @item gnus-shell-command-separator
15747 @vindex gnus-shell-command-separator
15748 String used to separate two shell commands.  The default is @samp{;}.
15749
15750
15751 @end table
15752
15753
15754 @node The End
15755 @chapter The End
15756
15757 Well, that's the manual---you can get on with your life now.  Keep in
15758 touch.  Say hello to your cats from me.
15759
15760 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
15761
15762 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
15763
15764 @quotation
15765 @strong{Te Deum}
15766
15767 @sp 1
15768 Not because of victories @*
15769 I sing,@*
15770 having none,@*
15771 but for the common sunshine,@*
15772 the breeze,@*
15773 the largess of the spring.
15774
15775 @sp 1
15776 Not for victory@*
15777 but for the day's work done@*
15778 as well as I was able;@*
15779 not for a seat upon the dais@*
15780 but at the common table.@*
15781 @end quotation
15782
15783
15784 @node Appendices
15785 @chapter Appendices
15786
15787 @menu
15788 * History::                        How Gnus got where it is today.
15789 * Terminology::                    We use really difficult, like, words here.
15790 * Customization::                  Tailoring Gnus to your needs.
15791 * Troubleshooting::                What you might try if things do not work.
15792 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
15793 * Emacs for Heathens::             A short introduction to Emacsian terms.
15794 * Frequently Asked Questions::     A question-and-answer session.
15795 @end menu
15796
15797
15798 @node History
15799 @section History
15800
15801 @cindex history
15802 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
15803 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
15804
15805 If you want to investigate the person responsible for this outrage, you
15806 can point your (feh!) web browser to
15807 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
15808 distribution point for the new and spiffy versions of Gnus, and is known
15809 as The Site That Destroys Newsrcs And Drives People Mad.
15810
15811 During the first extended alpha period of development, the new Gnus was
15812 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
15813 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
15814 (Besides, the ``Gnus'' in this abbreviation should probably be
15815 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
15816 appropriate name, don't you think?)
15817
15818 In any case, after spending all that energy on coming up with a new and
15819 spunky name, we decided that the name was @emph{too} spunky, so we
15820 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
15821 ``@sc{gnus}''.  New vs. old.
15822
15823 The first ``proper'' release of Gnus 5 was done in November 1995 when it
15824 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
15825 plus 15 Gnus 5.0 releases).
15826
15827 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
15828 releases)) was released under the name ``Gnus 5.2'' (40 releases).
15829
15830 On July 28th 1996 work on Red Gnus was begun, and it was released on
15831 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
15832
15833 On September 13th 1997, Quassia Gnus was started and lasted 37
15834 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
15835
15836 If you happen upon a version of Gnus that has a prefixed name --
15837 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
15838 don't panic.  Don't let it know that you're frightened.  Back away.
15839 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
15840 out of its reach.  Find a proper released version of Gnus and snuggle up
15841 to that instead.
15842
15843 @menu
15844 * Why?::                What's the point of Gnus?
15845 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
15846 * Conformity::          Gnus tries to conform to all standards.
15847 * Emacsen::             Gnus can be run on a few modern Emacsen.
15848 * Contributors::        Oodles of people.
15849 * New Features::        Pointers to some of the new stuff in Gnus.
15850 * Newest Features::     Features so new that they haven't been written yet.
15851 @end menu
15852
15853
15854 @node Why?
15855 @subsection Why?
15856
15857 What's the point of Gnus?
15858
15859 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
15860 newsreader, that lets you do anything you can think of.  That was my
15861 original motivation, but while working on Gnus, it has become clear to
15862 me that this generation of newsreaders really belong in the stone age.
15863 Newsreaders haven't developed much since the infancy of the net.  If the
15864 volume continues to rise with the current rate of increase, all current
15865 newsreaders will be pretty much useless.  How do you deal with
15866 newsgroups that have thousands of new articles each day?  How do you
15867 keep track of millions of people who post?
15868
15869 Gnus offers no real solutions to these questions, but I would very much
15870 like to see Gnus being used as a testing ground for new methods of
15871 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
15872 to separate the newsreader from the backends, Gnus now offers a simple
15873 interface for anybody who wants to write new backends for fetching mail
15874 and news from different sources.  I have added hooks for customizations
15875 everywhere I could imagine it being useful.  By doing so, I'm inviting
15876 every one of you to explore and invent.
15877
15878 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
15879 @kbd{C-u 100 M-x all-hail-xemacs}.
15880
15881
15882 @node Compatibility
15883 @subsection Compatibility
15884
15885 @cindex compatibility
15886 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
15887 bindings have been kept.  More key bindings have been added, of course,
15888 but only in one or two obscure cases have old bindings been changed.
15889
15890 Our motto is:
15891 @quotation
15892 @cartouche
15893 @center In a cloud bones of steel.
15894 @end cartouche
15895 @end quotation
15896
15897 All commands have kept their names.  Some internal functions have changed
15898 their names.
15899
15900 The @code{gnus-uu} package has changed drastically. @xref{Decoding
15901 Articles}.
15902
15903 One major compatibility question is the presence of several summary
15904 buffers.  All variables relevant while reading a group are
15905 buffer-local to the summary buffer they belong in.  Although many
15906 important variables have their values copied into their global
15907 counterparts whenever a command is executed in the summary buffer, this
15908 change might lead to incorrect values being used unless you are careful.
15909
15910 All code that relies on knowledge of @sc{gnus} internals will probably
15911 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
15912 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
15913 maintains a hash table that points to the entries in this alist (which
15914 speeds up many functions), and changing the alist directly will lead to
15915 peculiar results.
15916
15917 @cindex hilit19
15918 @cindex highlighting
15919 Old hilit19 code does not work at all.  In fact, you should probably
15920 remove all hilit code from all Gnus hooks
15921 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
15922 Gnus provides various integrated functions for highlighting.  These are
15923 faster and more accurate.  To make life easier for everybody, Gnus will
15924 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
15925 Away!
15926
15927 Packages like @code{expire-kill} will no longer work.  As a matter of
15928 fact, you should probably remove all old @sc{gnus} packages (and other
15929 code) when you start using Gnus.  More likely than not, Gnus already
15930 does what you have written code to make @sc{gnus} do.  (Snicker.)
15931
15932 Even though old methods of doing things are still supported, only the
15933 new methods are documented in this manual.  If you detect a new method of
15934 doing something while reading this manual, that does not mean you have
15935 to stop doing it the old way.
15936
15937 Gnus understands all @sc{gnus} startup files.
15938
15939 @kindex M-x gnus-bug
15940 @findex gnus-bug
15941 @cindex reporting bugs
15942 @cindex bugs
15943 Overall, a casual user who hasn't written much code that depends on
15944 @sc{gnus} internals should suffer no problems.  If problems occur,
15945 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
15946
15947 @vindex gnus-bug-create-help-buffer
15948 If you are in the habit of sending bug reports @emph{very} often, you
15949 may find the helpful help buffer annoying after a while.  If so, set
15950 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
15951 up at you.
15952
15953
15954 @node Conformity
15955 @subsection Conformity
15956
15957 No rebels without a clue here, ma'am.  We conform to all standards known
15958 to (wo)man.  Except for those standards and/or conventions we disagree
15959 with, of course.
15960
15961 @table @strong
15962
15963 @item RFC 822
15964 @cindex RFC 822
15965 There are no known breaches of this standard.
15966
15967 @item RFC 1036
15968 @cindex RFC 1036
15969 There are no known breaches of this standard, either.
15970
15971 @item Son-of-RFC 1036
15972 @cindex Son-of-RFC 1036
15973 We do have some breaches to this one.
15974
15975 @table @emph
15976
15977 @item MIME
15978 Gnus does not yet fully handle MIME, and this standard-to-be seems to
15979 think that MIME is the bees' knees, so we have major breakage here.
15980
15981 @item X-Newsreader
15982 This is considered to be a ``vanity header'', while I consider it to be
15983 consumer information.  After seeing so many badly formatted articles
15984 coming from @code{tin} and @code{Netscape} I know not to use either of
15985 those for posting articles.  I would not have known that if it wasn't
15986 for the @code{X-Newsreader} header.
15987 @end table
15988
15989 @item USEFOR
15990 @cindex USEFOR
15991 USEFOR is an IETF working group writing a successor to RFC 1036, based
15992 on Son-of-RFC 1036.  They have produced a number of drafts proposing
15993 various changes to the format of news articles.  The Gnus towers will
15994 look into implementing the changes when the draft is accepted as an RFC.
15995
15996 @end table
15997
15998 If you ever notice Gnus acting non-compliant with regards to the texts
15999 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16000 know.
16001
16002
16003 @node Emacsen
16004 @subsection Emacsen
16005 @cindex Emacsen
16006 @cindex XEmacs
16007 @cindex Mule
16008 @cindex Emacs
16009
16010 Gnus should work on :
16011
16012 @itemize @bullet
16013
16014 @item
16015 Emacs 20.2 and up.
16016
16017 @item
16018 XEmacs 20.4 and up.
16019
16020 @end itemize
16021
16022 Gnus will absolutely not work on any Emacsen older than that.  Not
16023 reliably, at least.
16024
16025 There are some vague differences between Gnus on the various
16026 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16027 other than that, things should look pretty much the same under all
16028 Emacsen.
16029
16030
16031 @node Contributors
16032 @subsection Contributors
16033 @cindex contributors
16034
16035 The new Gnus version couldn't have been done without the help of all the
16036 people on the (ding) mailing list.  Every day for over a year I have
16037 gotten billions of nice bug reports from them, filling me with joy,
16038 every single one of them.  Smooches.  The people on the list have been
16039 tried beyond endurance, what with my ``oh, that's a neat idea <type
16040 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16041 work at all <type type>, yup, I'll ship that one off right away <ship
16042 off> no, wait, that absolutely does not work'' policy for releases.
16043 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
16044 ``worser''? ``much worser''?  ``worsest''?)
16045
16046 I would like to take this opportunity to thank the Academy for...  oops,
16047 wrong show.
16048
16049 @itemize @bullet
16050
16051 @item
16052 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16053
16054 @item
16055 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16056 well as numerous other things).
16057
16058 @item
16059 Luis Fernandes---design and graphics.
16060
16061 @item
16062 Erik Naggum---help, ideas, support, code and stuff.
16063
16064 @item
16065 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16066 @dfn{picons} (@pxref{Picons}).
16067
16068 @item
16069 Kim-Minh Kaplan---further work on the picon code.
16070
16071 @item
16072 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16073 (@pxref{GroupLens}).
16074
16075 @item
16076 Sudish Joseph---innumerable bug fixes.
16077
16078 @item
16079 Ilja Weis---@file{gnus-topic.el}.
16080
16081 @item
16082 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16083
16084 @item
16085 Vladimir Alexiev---the refcard and reference booklets.
16086
16087 @item
16088 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16089 distribution by Felix Lee and JWZ.
16090
16091 @item
16092 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16093
16094 @item
16095 Peter Mutsaers---orphan article scoring code.
16096
16097 @item
16098 Ken Raeburn---POP mail support.
16099
16100 @item
16101 Hallvard B Furuseth---various bits and pieces, especially dealing with
16102 .newsrc files.
16103
16104 @item
16105 Brian Edmonds---@file{gnus-bbdb.el}.
16106
16107 @item
16108 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16109
16110 @item
16111 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16112
16113 @item
16114 François Pinard---many, many interesting and thorough bug reports, as
16115 well as autoconf support.
16116
16117 @end itemize
16118
16119 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16120 Borges, and Jost Krieger proof-reading parts of the manual.
16121
16122 The following people have contributed many patches and suggestions:
16123
16124 Christopher Davis,
16125 Andrew Eskilsson,
16126 Kai Grossjohann,
16127 David KÃ¥gedal,
16128 Richard Pieri,
16129 Fabrice Popineau,
16130 Daniel Quinlan,
16131 Jason L. Tibbitts, III,
16132 and
16133 Jack Vinson.
16134
16135 Also thanks to the following for patches and stuff:
16136
16137 Jari Aalto,
16138 Adrian Aichner,
16139 Vladimir Alexiev,
16140 Russ Allbery,
16141 Peter Arius,
16142 Matt Armstrong,
16143 Marc Auslander,
16144 Frank Bennett,
16145 Robert Bihlmeyer,
16146 Chris Bone,
16147 Mark Borges,
16148 Mark Boyns,
16149 Lance A. Brown,
16150 Kees de Bruin,
16151 Martin Buchholz,
16152 Joe Buehler,
16153 Kevin Buhr,
16154 Alastair Burt,
16155 Joao Cachopo,
16156 Zlatko Calusic,
16157 Massimo Campostrini,
16158 Castor,
16159 David Charlap,
16160 Dan Christensen,
16161 Kevin Christian,
16162 Michael R. Cook,
16163 Glenn Coombs,
16164 Frank D. Cringle,
16165 Geoffrey T. Dairiki,
16166 Andre Deparade,
16167 Ulrik Dickow,
16168 Dave Disser,
16169 Rui-Tao Dong, @c ?
16170 Joev Dubach,
16171 Michael Welsh Duggan,
16172 Dave Edmondson,
16173 Paul Eggert,
16174 Enami Tsugutomo, @c Enami
16175 Michael Ernst,
16176 Luc Van Eycken,
16177 Sam Falkner,
16178 Nelson Jose dos Santos Ferreira,
16179 Sigbjorn Finne,
16180 Paul Fisher,
16181 Decklin Foster,
16182 Gary D. Foster,
16183 Paul Franklin,
16184 Guy Geens,
16185 Arne Georg Gleditsch,
16186 David S. Goldberg,
16187 Michelangelo Grigni,
16188 D. Hall,
16189 Magnus Hammerin,
16190 Kenichi Handa, @c Handa
16191 Raja R. Harinath,
16192 Yoshiki Hayashi, @c ?
16193 P. E. Jareth Hein,
16194 Hisashige Kenji, @c Hisashige
16195 Marc Horowitz,
16196 Gunnar Horrigmo,
16197 Richard Hoskins,
16198 Brad Howes,
16199 François Felix Ingrand,
16200 Ishikawa Ichiro, @c Ishikawa
16201 Lee Iverson,
16202 Iwamuro Motonori, @c Iwamuro
16203 Rajappa Iyer,
16204 Andreas Jaeger,
16205 Randell Jesup,
16206 Fred Johansen,
16207 Gareth Jones,
16208 Simon Josefsson,
16209 Greg Klanderman,
16210 Karl Kleinpaste,
16211 Peter Skov Knudsen,
16212 Shuhei Kobayashi, @c Kobayashi
16213 Koseki Yoshinori, @c Koseki
16214 Thor Kristoffersen,
16215 Jens Lautenbacher,
16216 Martin Larose,
16217 Seokchan Lee, @c Lee
16218 Carsten Leonhardt,
16219 James LewisMoss,
16220 Christian Limpach,
16221 Markus Linnala,
16222 Dave Love,
16223 Mike McEwan,
16224 Tonny Madsen,
16225 Shlomo Mahlab,
16226 Nat Makarevitch,
16227 Istvan Marko,
16228 David Martin,
16229 Jason R. Mastaler,
16230 Gordon Matzigkeit,
16231 Timo Metzemakers,
16232 Richard Mlynarik,
16233 Lantz Moore,
16234 Morioka Tomohiko, @c Morioka
16235 Erik Toubro Nielsen,
16236 Hrvoje Niksic,
16237 Andy Norman,
16238 Fred Oberhauser,
16239 C. R. Oldham,
16240 Alexandre Oliva,
16241 Ken Olstad,
16242 Masaharu Onishi, @c Onishi
16243 Hideki Ono, @c Ono
16244 William Perry,
16245 Stephen Peters,
16246 Jens-Ulrik Holger Petersen,
16247 Ulrich Pfeifer,
16248 Matt Pharr,
16249 John McClary Prevost,
16250 Bill Pringlemeir,
16251 Mike Pullen,
16252 Jim Radford,
16253 Colin Rafferty,
16254 Lasse Rasinen,
16255 Lars Balker Rasmussen,
16256 Joe Reiss,
16257 Renaud Rioboo,
16258 Roland B. Roberts,
16259 Bart Robinson,
16260 Christian von Roques,
16261 Jason Rumney,
16262 Wolfgang Rupprecht,
16263 Jay Sachs,
16264 Dewey M. Sasser,
16265 Conrad Sauerwald,
16266 Loren Schall,
16267 Dan Schmidt,
16268 Ralph Schleicher,
16269 Philippe Schnoebelen,
16270 Andreas Schwab,
16271 Randal L. Schwartz,
16272 Justin Sheehy,
16273 Danny Siu,
16274 Matt Simmons,
16275 Paul D. Smith,
16276 Jeff Sparkes,
16277 Toby Speight,
16278 Michael Sperber,
16279 Darren Stalder,
16280 Richard Stallman,
16281 Greg Stark,
16282 Sam Steingold,
16283 Paul Stodghill,
16284 Kurt Swanson,
16285 Samuel Tardieu,
16286 Teddy,
16287 Chuck Thompson,
16288 Philippe Troin,
16289 James Troup,
16290 Trung Tran-Duc,
16291 Aaron M. Ucko,
16292 Aki Vehtari,
16293 Didier Verna,
16294 Jan Vroonhof,
16295 Stefan Waldherr,
16296 Pete Ware,
16297 Barry A. Warsaw,
16298 Christoph Wedler,
16299 Joe Wells,
16300 Katsumi Yamaoka, @c Yamaoka
16301 and
16302 Shenghuo Zhu. @c Zhu
16303
16304 For a full overview of what each person has done, the ChangeLogs
16305 included in the Gnus alpha distributions should give ample reading
16306 (550kB and counting).
16307
16308 Apologies to everybody that I've forgotten, of which there are many, I'm
16309 sure.
16310
16311 Gee, that's quite a list of people.  I guess that must mean that there
16312 actually are people who are using Gnus.  Who'd'a thunk it!
16313
16314
16315 @node New Features
16316 @subsection New Features
16317 @cindex new features
16318
16319 @menu
16320 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
16321 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
16322 * Red Gnus::           Third time best---Gnus 5.4/5.5.
16323 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
16324 @end menu
16325
16326 These lists are, of course, just @emph{short} overviews of the
16327 @emph{most} important new features.  No, really.  There are tons more.
16328 Yes, we have feeping creaturism in full effect.
16329
16330
16331 @node ding Gnus
16332 @subsubsection (ding) Gnus
16333
16334 New features in Gnus 5.0/5.1:
16335
16336 @itemize @bullet
16337
16338 @item
16339 The look of all buffers can be changed by setting format-like variables
16340 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
16341
16342 @item
16343 Local spool and several @sc{nntp} servers can be used at once
16344 (@pxref{Select Methods}).
16345
16346 @item
16347 You can combine groups into virtual groups (@pxref{Virtual Groups}).
16348
16349 @item
16350 You can read a number of different mail formats (@pxref{Getting Mail}).
16351 All the mail backends implement a convenient mail expiry scheme
16352 (@pxref{Expiring Mail}).
16353
16354 @item
16355 Gnus can use various strategies for gathering threads that have lost
16356 their roots (thereby gathering loose sub-threads into one thread) or it
16357 can go back and retrieve enough headers to build a complete thread
16358 (@pxref{Customizing Threading}).
16359
16360 @item
16361 Killed groups can be displayed in the group buffer, and you can read
16362 them as well (@pxref{Listing Groups}).
16363
16364 @item
16365 Gnus can do partial group updates---you do not have to retrieve the
16366 entire active file just to check for new articles in a few groups
16367 (@pxref{The Active File}).
16368
16369 @item
16370 Gnus implements a sliding scale of subscribedness to groups
16371 (@pxref{Group Levels}).
16372
16373 @item
16374 You can score articles according to any number of criteria
16375 (@pxref{Scoring}).  You can even get Gnus to find out how to score
16376 articles for you (@pxref{Adaptive Scoring}).
16377
16378 @item
16379 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
16380 manner, so it should be difficult to lose much data on what you have
16381 read if your machine should go down (@pxref{Auto Save}).
16382
16383 @item
16384 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
16385 the @file{.emacs} file.
16386
16387 @item
16388 You can set the process mark on both groups and articles and perform
16389 operations on all the marked items (@pxref{Process/Prefix}).
16390
16391 @item
16392 You can grep through a subset of groups and create a group from the
16393 results (@pxref{Kibozed Groups}).
16394
16395 @item
16396 You can list subsets of groups according to, well, anything
16397 (@pxref{Listing Groups}).
16398
16399 @item
16400 You can browse foreign servers and subscribe to groups from those
16401 servers (@pxref{Browse Foreign Server}).
16402
16403 @item
16404 Gnus can fetch articles, asynchronously, on a second connection to the
16405 server (@pxref{Asynchronous Fetching}).
16406
16407 @item
16408 You can cache articles locally (@pxref{Article Caching}).
16409
16410 @item
16411 The uudecode functions have been expanded and generalized
16412 (@pxref{Decoding Articles}).
16413
16414 @item
16415 You can still post uuencoded articles, which was a little-known feature
16416 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
16417
16418 @item
16419 Fetching parents (and other articles) now actually works without
16420 glitches (@pxref{Finding the Parent}).
16421
16422 @item
16423 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
16424
16425 @item
16426 Digests (and other files) can be used as the basis for groups
16427 (@pxref{Document Groups}).
16428
16429 @item
16430 Articles can be highlighted and customized (@pxref{Customizing
16431 Articles}).
16432
16433 @item
16434 URLs and other external references can be buttonized (@pxref{Article
16435 Buttons}).
16436
16437 @item
16438 You can do lots of strange stuff with the Gnus window & frame
16439 configuration (@pxref{Windows Configuration}).
16440
16441 @item
16442 You can click on buttons instead of using the keyboard
16443 (@pxref{Buttons}).
16444
16445 @end itemize
16446
16447
16448 @node September Gnus
16449 @subsubsection September Gnus
16450
16451 @iftex
16452 @iflatex
16453 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
16454 @end iflatex
16455 @end iftex
16456
16457 New features in Gnus 5.2/5.3:
16458
16459 @itemize @bullet
16460
16461 @item
16462 A new message composition mode is used.  All old customization variables
16463 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
16464 now obsolete.
16465
16466 @item
16467 Gnus is now able to generate @dfn{sparse} threads---threads where
16468 missing articles are represented by empty nodes (@pxref{Customizing
16469 Threading}).
16470
16471 @lisp
16472 (setq gnus-build-sparse-threads 'some)
16473 @end lisp
16474
16475 @item
16476 Outgoing articles are stored on a special archive server
16477 (@pxref{Archived Messages}).
16478
16479 @item
16480 Partial thread regeneration now happens when articles are
16481 referred.
16482
16483 @item
16484 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
16485
16486 @item
16487 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
16488
16489 @item
16490 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
16491
16492 @lisp
16493 (setq gnus-use-trees t)
16494 @end lisp
16495
16496 @item
16497 An @code{nn}-like pick-and-read minor mode is available for the summary
16498 buffers (@pxref{Pick and Read}).
16499
16500 @lisp
16501 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
16502 @end lisp
16503
16504 @item
16505 In binary groups you can use a special binary minor mode (@pxref{Binary
16506 Groups}).
16507
16508 @item
16509 Groups can be grouped in a folding topic hierarchy (@pxref{Group
16510 Topics}).
16511
16512 @lisp
16513 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
16514 @end lisp
16515
16516 @item
16517 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
16518
16519 @item
16520 Groups can now have a score, and bubbling based on entry frequency
16521 is possible (@pxref{Group Score}).
16522
16523 @lisp
16524 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
16525 @end lisp
16526
16527 @item
16528 Groups can be process-marked, and commands can be performed on
16529 groups of groups (@pxref{Marking Groups}).
16530
16531 @item
16532 Caching is possible in virtual groups.
16533
16534 @item
16535 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
16536 news batches, ClariNet briefs collections, and just about everything
16537 else (@pxref{Document Groups}).
16538
16539 @item
16540 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
16541 (@pxref{SOUP}).
16542
16543 @item
16544 The Gnus cache is much faster.
16545
16546 @item
16547 Groups can be sorted according to many criteria (@pxref{Sorting
16548 Groups}).
16549
16550 @item
16551 New group parameters have been introduced to set list-addresses and
16552 expiry times (@pxref{Group Parameters}).
16553
16554 @item
16555 All formatting specs allow specifying faces to be used
16556 (@pxref{Formatting Fonts}).
16557
16558 @item
16559 There are several more commands for setting/removing/acting on process
16560 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
16561
16562 @item
16563 The summary buffer can be limited to show parts of the available
16564 articles based on a wide range of criteria.  These commands have been
16565 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
16566
16567 @item
16568 Articles can be made persistent with the @kbd{*} command
16569 (@pxref{Persistent Articles}).
16570
16571 @item
16572 All functions for hiding article elements are now toggles.
16573
16574 @item
16575 Article headers can be buttonized (@pxref{Article Washing}).
16576
16577 @lisp
16578 (add-hook 'gnus-article-display-hook
16579           'gnus-article-add-buttons-to-head)
16580 @end lisp
16581
16582 @item
16583 All mail backends support fetching articles by @code{Message-ID}.
16584
16585 @item
16586 Duplicate mail can now be treated properly (@pxref{Duplicates}).
16587
16588 @item
16589 All summary mode commands are available directly from the article
16590 buffer (@pxref{Article Keymap}).
16591
16592 @item
16593 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
16594 Configuration}).
16595
16596 @item
16597 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
16598 @iftex
16599 @iflatex
16600 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
16601 @end iflatex
16602 @end iftex
16603
16604 @item
16605 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
16606
16607 @lisp
16608 (setq gnus-use-nocem t)
16609 @end lisp
16610
16611 @item
16612 Groups can be made permanently visible (@pxref{Listing Groups}).
16613
16614 @lisp
16615 (setq gnus-permanently-visible-groups "^nnml:")
16616 @end lisp
16617
16618 @item
16619 Many new hooks have been introduced to make customizing easier.
16620
16621 @item
16622 Gnus respects the @code{Mail-Copies-To} header.
16623
16624 @item
16625 Threads can be gathered by looking at the @code{References} header
16626 (@pxref{Customizing Threading}).
16627
16628 @lisp
16629 (setq gnus-summary-thread-gathering-function
16630       'gnus-gather-threads-by-references)
16631 @end lisp
16632
16633 @item
16634 Read articles can be stored in a special backlog buffer to avoid
16635 refetching (@pxref{Article Backlog}).
16636
16637 @lisp
16638 (setq gnus-keep-backlog 50)
16639 @end lisp
16640
16641 @item
16642 A clean copy of the current article is always stored in a separate
16643 buffer to allow easier treatment.
16644
16645 @item
16646 Gnus can suggest where to save articles (@pxref{Saving Articles}).
16647
16648 @item
16649 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
16650 Articles}).
16651
16652 @lisp
16653 (setq gnus-prompt-before-saving t)
16654 @end lisp
16655
16656 @item
16657 @code{gnus-uu} can view decoded files asynchronously while fetching
16658 articles (@pxref{Other Decode Variables}).
16659
16660 @lisp
16661 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
16662 @end lisp
16663
16664 @item
16665 Filling in the article buffer now works properly on cited text
16666 (@pxref{Article Washing}).
16667
16668 @item
16669 Hiding cited text adds buttons to toggle hiding, and how much
16670 cited text to hide is now customizable (@pxref{Article Hiding}).
16671
16672 @lisp
16673 (setq gnus-cited-lines-visible 2)
16674 @end lisp
16675
16676 @item
16677 Boring headers can be hidden (@pxref{Article Hiding}).
16678
16679 @lisp
16680 (add-hook 'gnus-article-display-hook
16681           'gnus-article-hide-boring-headers t)
16682 @end lisp
16683
16684 @item
16685 Default scoring values can now be set from the menu bar.
16686
16687 @item
16688 Further syntax checking of outgoing articles have been added.
16689
16690 @end itemize
16691
16692
16693 @node Red Gnus
16694 @subsubsection Red Gnus
16695
16696 New features in Gnus 5.4/5.5:
16697
16698 @iftex
16699 @iflatex
16700 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
16701 @end iflatex
16702 @end iftex
16703
16704 @itemize @bullet
16705
16706 @item
16707 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
16708
16709 @item
16710 Article prefetching functionality has been moved up into
16711 Gnus (@pxref{Asynchronous Fetching}).
16712
16713 @item
16714 Scoring can now be performed with logical operators like @code{and},
16715 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16716 Scoring}).
16717
16718 @item
16719 Article washing status can be displayed in the
16720 article mode line (@pxref{Misc Article}).
16721
16722 @item
16723 @file{gnus.el} has been split into many smaller files.
16724
16725 @item
16726 Suppression of duplicate articles based on Message-ID can be done
16727 (@pxref{Duplicate Suppression}).
16728
16729 @lisp
16730 (setq gnus-suppress-duplicates t)
16731 @end lisp
16732
16733 @item
16734 New variables for specifying what score and adapt files are to be
16735 considered home score and adapt files (@pxref{Home Score File}) have
16736 been added.
16737
16738 @item
16739 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
16740 Server Internals}).
16741
16742 @item
16743 Groups can inherit group parameters from parent topics (@pxref{Topic
16744 Parameters}).
16745
16746 @item
16747 Article editing has been revamped and is now actually usable.
16748
16749 @item
16750 Signatures can be recognized in more intelligent fashions
16751 (@pxref{Article Signature}).
16752
16753 @item
16754 Summary pick mode has been made to look more @code{nn}-like.  Line
16755 numbers are displayed and the @kbd{.} command can be used to pick
16756 articles (@code{Pick and Read}).
16757
16758 @item
16759 Commands for moving the @file{.newsrc.eld} from one server to
16760 another have been added (@pxref{Changing Servers}).
16761
16762 @item
16763 There's a way now to specify that ``uninteresting'' fields be suppressed
16764 when generating lines in buffers (@pxref{Advanced Formatting}).
16765
16766 @item
16767 Several commands in the group buffer can be undone with @kbd{M-C-_}
16768 (@pxref{Undo}).
16769
16770 @item
16771 Scoring can be done on words using the new score type @code{w}
16772 (@pxref{Score File Format}).
16773
16774 @item
16775 Adaptive scoring can be done on a Subject word-by-word basis
16776 (@pxref{Adaptive Scoring}).
16777
16778 @lisp
16779 (setq gnus-use-adaptive-scoring '(word))
16780 @end lisp
16781
16782 @item
16783 Scores can be decayed (@pxref{Score Decays}).
16784
16785 @lisp
16786 (setq gnus-decay-scores t)
16787 @end lisp
16788
16789 @item
16790 Scoring can be performed using a regexp on the Date header.  The Date is
16791 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
16792
16793 @item
16794 A new command has been added to remove all data on articles from
16795 the native server (@pxref{Changing Servers}).
16796
16797 @item
16798 A new command for reading collections of documents
16799 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
16800 (@pxref{Really Various Summary Commands}).
16801
16802 @item
16803 Process mark sets can be pushed and popped (@pxref{Setting Process
16804 Marks}).
16805
16806 @item
16807 A new mail-to-news backend makes it possible to post even when the NNTP
16808 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
16809
16810 @item
16811 A new backend for reading searches from Web search engines
16812 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
16813 (@pxref{Web Searches}).
16814
16815 @item
16816 Groups inside topics can now be sorted using the standard sorting
16817 functions, and each topic can be sorted independently (@pxref{Topic
16818 Sorting}).
16819
16820 @item
16821 Subsets of the groups can be sorted independently (@code{Sorting
16822 Groups}).
16823
16824 @item
16825 Cached articles can be pulled into the groups (@pxref{Summary Generation
16826 Commands}).
16827 @iftex
16828 @iflatex
16829 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
16830 @end iflatex
16831 @end iftex
16832
16833 @item
16834 Score files are now applied in a more reliable order (@pxref{Score
16835 Variables}).
16836
16837 @item
16838 Reports on where mail messages end up can be generated (@pxref{Splitting
16839 Mail}).
16840
16841 @item
16842 More hooks and functions have been added to remove junk from incoming
16843 mail before saving the mail (@pxref{Washing Mail}).
16844
16845 @item
16846 Emphasized text can be properly fontisized:
16847
16848 @lisp
16849 (add-hook 'gnus-article-display-hook
16850           'gnus-article-emphasize)
16851 @end lisp
16852
16853 @end itemize
16854
16855
16856 @node Quassia Gnus
16857 @subsubsection Quassia Gnus
16858
16859 New features in Gnus 5.6:
16860
16861 @itemize @bullet
16862
16863 @item
16864 New functionality for using Gnus as an offline newsreader has been
16865 added.  A plethora of new commands and modes have been added.  See
16866 @pxref{Gnus Unplugged} for the full story.
16867
16868 @item
16869  The @code{nndraft} backend has returned, but works differently than
16870 before.  All Message buffers are now also articles in the @code{nndraft}
16871 group, which is created automatically.
16872
16873 @item
16874 @code{gnus-alter-header-function} can now be used to alter header
16875 values.
16876
16877 @item
16878  @code{gnus-summary-goto-article} now accept Message-ID's.
16879
16880 @item
16881  A new Message command for deleting text in the body of a message
16882 outside the region: @kbd{C-c C-v}.
16883
16884 @item
16885  You can now post to component group in @code{nnvirtual} groups with
16886 @kbd{C-u C-c C-c}.
16887
16888 @item
16889  @code{nntp-rlogin-program}---new variable to ease customization.
16890
16891 @item
16892  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
16893 re-highlighting of the article buffer.
16894
16895 @item
16896  New element in @code{gnus-boring-article-headers}---@code{long-to}.
16897
16898 @item
16899  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
16900 Prefixes" in the Gnus manual for details.
16901
16902 @item
16903  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
16904 @kbd{a} to add the score rule to the "all.SCORE" file.
16905
16906 @item
16907  @code{gnus-simplify-subject-functions} variable to allow greater
16908 control over simplification.
16909
16910 @item
16911  @kbd{A T}---new command for fetching the current thread.
16912
16913 @item
16914  @kbd{/ T}---new command for including the current thread in the
16915 limit.
16916
16917 @item
16918  @kbd{M-RET} is a new Message command for breaking cited text.
16919
16920 @item
16921  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
16922
16923 @item
16924  The @code{custom-face-lookup} function has been removed.
16925 If you used this function in your initialization files, you must
16926 rewrite them to use @code{face-spec-set} instead.
16927
16928 @item
16929  Canceling now uses the current select method.  Symbolic prefix
16930 @kbd{a} forces normal posting method.
16931
16932 @item
16933  New command to translate M******** sm*rtq**t*s into proper
16934 text---@kbd{W d}.
16935
16936 @item
16937  For easier debugging of @code{nntp}, you can set
16938 @code{nntp-record-commands} to a non-@code{nil} value.
16939
16940 @item
16941  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
16942 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
16943
16944 @item
16945  A command for editing group parameters from the summary buffer
16946 has been added.
16947
16948 @item
16949  A history of where mails have been split is available.
16950
16951 @item
16952  A new article date command has been added---@code{article-date-iso8601}.
16953
16954 @item
16955  Subjects can be simplified when threading by setting
16956 @code{gnus-score-thread-simplify}.
16957
16958 @item
16959  A new function for citing in Message has been
16960 added---@code{message-cite-original-without-signature}.
16961
16962 @item
16963  @code{article-strip-all-blank-lines}---new article command.
16964
16965 @item
16966  A new Message command to kill to the end of the article has
16967 been added.
16968
16969 @item
16970  A minimum adaptive score can be specified by using the
16971 @code{gnus-adaptive-word-minimum} variable.
16972
16973 @item
16974  The "lapsed date" article header can be kept continually
16975 updated by the @code{gnus-start-date-timer} command.
16976
16977 @item
16978  Web listserv archives can be read with the @code{nnlistserv} backend.
16979
16980 @item
16981  Old dejanews archives can now be read by @code{nnweb}.
16982
16983 @end itemize
16984
16985
16986 @node Newest Features
16987 @subsection Newest Features
16988 @cindex todo
16989
16990 Also known as the @dfn{todo list}.  Sure to be implemented before the
16991 next millennium.
16992
16993 Be afraid.  Be very afraid.
16994
16995 (That a feature appears in this list doesn't necessarily mean that I've
16996 decided to actually implement it.  It just means that I think it sounds
16997 interesting.)
16998
16999 (Yes, this is the actual, up-to-the-second todo list.)
17000
17001 @itemize @bullet
17002
17003 @item
17004 Native @sc{mime} support is something that should be done.
17005
17006 @item
17007 Really do unbinhexing.
17008
17009 @item
17010  I would like the zombie-page to contain an URL to the source of the
17011 latest version of gnus or some explanation on where to find it.
17012
17013 @item
17014  A way to continue editing the latest Message composition.
17015
17016 @item
17017  http://www.sonicnet.com/feature/ari3/
17018
17019 @item
17020  facep is not declared.
17021
17022 @item
17023  Include a section in the manual on why the number of articles
17024 isn't the same in the group buffer and on the SPC prompt.
17025
17026 @item
17027  Interacting with rmail fcc isn't easy.
17028
17029 @item
17030 @example
17031  Hypermail:
17032 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17033 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17034 <URL:http://homer.ncm.com/>
17035 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17036 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17037 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17038 http://www.miranova.com/gnus-list/
17039
17040 @end example
17041
17042 @item
17043 @samp{^-- } is made into - in LaTeX.
17044
17045 @item
17046  gnus-kill is much slower than it was in GNUS 4.1.3.
17047
17048 @item
17049  when expunging articles on low score, the sparse nodes keep hanging on?
17050 @item
17051  starting the first time seems to hang Gnus on some systems.  Does
17052 NEWGROUPS answer too fast?
17053 @item
17054  nndir doesn't read gzipped files.
17055 @item
17056  FAQ doesn't have an up node?
17057 @item
17058  when moving mail from a procmail spool to the crash-box,
17059 the crash-box is only appropriate to one specific group.
17060 @item
17061  `t' `t' makes X-Faces disappear.
17062 @item
17063  nnmh-be-safe means that crossposted articles will
17064 be marked as unread.
17065 @item
17066  Orphan score entries don't show on "V t" score trace
17067 @item
17068  when clearing out data, the cache data should also be reset.
17069 @item
17070  rewrite gnus-summary-limit-children to be non-recursive
17071 to avoid exceeding lisp nesting on huge groups.
17072 @item
17073  expunged articles are counted when computing scores.
17074 @item
17075  implement gnus-batch-brew-soup
17076 @item
17077  ticked articles aren't easy to read in pick mode -- `n' and
17078 stuff just skips past them.  Read articles are the same.
17079 @item
17080  topics that contain just groups with ticked
17081 articles aren't displayed.
17082 @item
17083  nndoc should always allocate unique Message-IDs.
17084 @item
17085  If there are mail groups the first time you use Gnus, Gnus'll
17086 make the mail groups killed.
17087 @item
17088  no "no news is good news" when using topics.
17089 @item
17090  when doing crosspost marking, the cache has to be consulted
17091 and articles have to be removed.
17092 @item
17093  nnweb should fetch complete articles when they are split into several
17094 parts.
17095 @item
17096  scoring on head immediate doesn't work.
17097 @item
17098  finding short score file names takes forever.
17099 @item
17100  canceling articles in foreign groups.
17101 @item
17102  nntp-open-rlogin no longer works.
17103 @item
17104  C-u C-x C-s (Summary) switches to the group buffer.
17105 @item
17106  move nnmail-split-history out to the backends.
17107 @item
17108  nnweb doesn't work properly.
17109 @item
17110  using a virtual server name as `gnus-select-method' doesn't work?
17111 @item
17112  when killing/yanking a group from one topic to another in a slave, the
17113 master will yank it first to one topic and then add it to another.
17114 Perhaps.
17115
17116 @item
17117  warn user about `=' redirection of a group in the active file?
17118 @item
17119  really unbinhex binhex files.
17120 @item
17121  take over the XEmacs menubar and offer a toggle between the XEmacs
17122 bar and the Gnus bar.
17123 @item
17124 @example
17125  push active file and NOV file parsing down into C code.
17126 `(canonize-message-id id)'
17127 `(mail-parent-message-id references n)'
17128 `(parse-news-nov-line &optional dependency-hashtb)'
17129 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17130 `(parse-news-active-region beg end hashtb)'
17131
17132 @end example
17133
17134 @item
17135  nnml .overview directory with splits.
17136 @item
17137  asynchronous cache
17138 @item
17139  postponed commands.
17140 @item
17141  the selected article show have its Subject displayed in its summary line.
17142 @item
17143  when entering groups, get the real number of unread articles from
17144 the server?
17145 @item
17146  sort after gathering threads -- make false roots have the
17147 headers of the oldest orphan with a 0 article number?
17148 @item
17149  nndoc groups should inherit the score files of their parents?  Also
17150 inherit copy prompts and save files.
17151 @item
17152  command to start up Gnus (if not running) and enter a mail mode buffer.
17153 @item
17154  allow editing the group description from the group buffer
17155 for backends that support that.
17156 @item
17157 gnus-hide,show-all-topics
17158 @item
17159  groups and sub-topics should be allowed to mingle inside each topic,
17160 and not just list all subtopics at the end.
17161 @item
17162  a command to remove all read articles that are not needed to connect
17163 threads -- `gnus-summary-limit-to-sparse-unread'?
17164 @item
17165  a variable to turn off limiting/cutting of threads in the tree buffer.
17166 @item
17167  a variable to limit how many files are uudecoded.
17168 @item
17169  add zombie groups to a special "New Groups" topic.
17170 @item
17171  server mode command: close/open all connections
17172 @item
17173  put a file date in gnus-score-alist and check whether the file
17174 has been changed before using it.
17175 @item
17176  on exit from a digest group, go to the next article in the parent group.
17177 @item
17178  hide (sub)threads with low score.
17179 @item
17180  when expiring, remove all marks from expired articles.
17181 @item
17182  gnus-summary-limit-to-body
17183 @item
17184  a regexp alist that says what level groups are to be subscribed
17185 on.  Eg. -- `(("nnml:" . 1))'.
17186 @item
17187  easier interface to nnkiboze to create ephemeral groups that
17188 contain groups that match a regexp.
17189 @item
17190  allow newlines in <URL:> urls, but remove them before using
17191 the URL.
17192 @item
17193  If there is no From line, the mail backends should fudge one from the
17194 "From " line.
17195 @item
17196  fuzzy simplifying should strip all non-alpha-numerical info
17197 from subject lines.
17198 @item
17199  gnus-soup-brew-soup-with-high-scores.
17200 @item
17201  nntp-ping-before-connect
17202 @item
17203  command to check whether NOV is evil.  "list overview.fmt".
17204 @item
17205  when entering a group, Gnus should look through the score
17206 files very early for `local' atoms and set those local variables.
17207 @item
17208  message annotations.
17209 @item
17210  topics are always yanked before groups, and that's not good.
17211 @item
17212  (set-extent-property extent 'help-echo "String to display in minibuf")
17213 to display help in the minibuffer on buttons under XEmacs.
17214 @item
17215  allow group line format spec to say how many articles there
17216 are in the cache.
17217 @item
17218  AUTHINFO GENERIC
17219 @item
17220  support qmail maildir spools
17221 @item
17222  `run-with-idle-timer' in gnus-demon.
17223 @item
17224  stop using invisible text properties and start using overlays instead
17225 @item
17226  C-c C-f C-e to add an Expires header.
17227 @item
17228  go from one group to the next; everything is expunged; go to the
17229 next group instead of going to the group buffer.
17230 @item
17231  gnus-renumber-cache -- to renumber the cache using "low" numbers.
17232 @item
17233  record topic changes in the dribble buffer.
17234 @item
17235  `nnfolder-generate-active-file' should look at the folders it
17236 finds and generate proper active ranges.
17237 @item
17238  nneething-look-in-files-for-article-heads variable to control
17239 whether nneething should sniff all files in the directories.
17240 @item
17241  gnus-fetch-article -- start Gnus, enter group, display article
17242 @item
17243  gnus-dont-move-articles-to-same-group variable when respooling.
17244 @item
17245  when messages are crossposted between several auto-expirable groups,
17246 articles aren't properly marked as expirable.
17247 @item
17248  nneething should allow deletion/moving.
17249 @item
17250  TAB on the last button should go to the first button.
17251 @item
17252  if the car of an element in `mail-split-methods' is a function,
17253 and the function returns non-nil, use that as the name of the group(s) to
17254 save mail in.
17255 @item
17256  command for listing all score files that have been applied.
17257 @item
17258  a command in the article buffer to return to `summary' config.
17259 @item
17260  `gnus-always-post-using-current-server' -- variable to override
17261 `C-c C-c' when posting.
17262 @item
17263  nnmail-group-spool-alist -- says where each group should use
17264 as a spool file.
17265 @item
17266  when an article is crossposted to an auto-expirable group, the article
17267 should be marker as expirable.
17268 @item
17269  article mode command/menu for "send region as URL to browser".
17270 @item
17271  on errors, jump to info nodes that explain the error.  For instance,
17272 on invalid From headers, or on error messages from the nntp server.
17273 @item
17274  when gathering threads, make the article that has no "Re: " the parent.
17275 Also consult Date headers.
17276 @item
17277  a token in splits to call shrink-window-if-larger-than-buffer
17278 @item
17279  `1 0 A M' to do matches on the active hashtb.
17280 @item
17281  duplicates -- command to remove Gnus-Warning header, use the read
17282 Message-ID, delete the "original".
17283 @item
17284  when replying to several messages at once, put the "other" message-ids
17285 into a See-Also header.
17286 @item
17287  support setext: URL:http://www.bsdi.com/setext/
17288 @item
17289  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
17290 @item
17291  when browsing a foreign server, the groups that are already subscribed
17292 should be listed as such and not as "K".
17293 @item
17294  generate font names dynamically.
17295 @item
17296  score file mode auto-alist.
17297 @item
17298  allow nndoc to change/add/delete things from documents.  Implement
17299 methods for each format for adding an article to the document.
17300 @item
17301  `gnus-fetch-old-headers' `all' value to incorporate
17302 absolutely all headers there is.
17303 @item
17304  function like `|', but concatenate all marked articles
17305 and pipe them to the process.
17306 @item
17307  cache the list of killed (or active) groups in a separate file.  Update
17308 the file whenever we read the active file or the list
17309 of killed groups in the .eld file reaches a certain length.
17310 @item
17311  function for starting to edit a file to put into
17312 the current mail group.
17313 @item
17314  score-find-trace should display the total score of the article.
17315 @item
17316  "ghettozie" -- score on Xref header and nix it out after using it
17317 to avoid marking as read in other groups it has been crossposted to.
17318 @item
17319  look at procmail splitting.  The backends should create
17320 the groups automatically if a spool file exists for that group.
17321 @item
17322  function for backends to register themselves with Gnus.
17323 @item
17324  when replying to several process-marked articles,
17325 have all the From end up in Cc headers?  Variable to toggle.
17326 @item
17327  command to delete a crossposted mail article from all
17328 groups it has been mailed to.
17329 @item
17330  `B c' and `B m' should be crosspost aware.
17331 @item
17332  hide-pgp should also hide PGP public key blocks.
17333 @item
17334  Command in the group buffer to respool process-marked groups.
17335 @item
17336  `gnus-summary-find-matching' should accept
17337 pseudo-"headers" like "body", "head" and "all"
17338 @item
17339  When buttifying <URL: > things, all white space (including
17340 newlines) should be ignored.
17341 @item
17342  Process-marking all groups in a topic should process-mark
17343 groups in subtopics as well.
17344 @item
17345  Add non-native groups to the list of killed groups when killing them.
17346 @item
17347  nntp-suggest-kewl-config to probe the nntp server and suggest
17348 variable settings.
17349 @item
17350  add edit and forward secondary marks.
17351 @item
17352  nnml shouldn't visit its .overview files.
17353 @item
17354  allow customizing sorting within gathered threads.
17355 @item
17356  `B q' shouldn't select the current article.
17357 @item
17358  nnmbox should support a newsgroups file for descriptions.
17359 @item
17360  allow fetching mail from several pop servers.
17361 @item
17362  Be able to specify whether the saving commands save the original
17363 or the formatted article.
17364 @item
17365  a command to reparent with the child process-marked (cf. `T ^'.).
17366 @item
17367  I think the possibility to send a password with nntp-open-rlogin
17368 should be a feature in Red Gnus.
17369 @item
17370  The `Z n' command should be possible to execute from a mouse click.
17371 @item
17372  more limiting functions -- date, etc.
17373 @item
17374  be able to limit on a random header; on body; using reverse matches.
17375 @item
17376  a group parameter (`absofucking-total-expiry') that will make Gnus expire
17377 even unread articles.
17378 @item
17379  a command to print the article buffer as postscript.
17380 @item
17381  variable to disable password fetching when opening by nntp-open-telnet.
17382 @item
17383  manual: more example servers -- nntp with rlogin, telnet
17384 @item
17385  checking for bogus groups should clean topic alists as well.
17386 @item
17387  canceling articles in foreign groups.
17388 @item
17389  article number in folded topics isn't properly updated by
17390 Xref handling.
17391 @item
17392  Movement in the group buffer to the next unread group should go to the
17393 next closed topic with unread messages if no group can be found.
17394 @item
17395  Extensive info pages generated on the fly with help everywhere --
17396 in the "*Gnus edit*" buffers, for instance.
17397 @item
17398  Topic movement commands -- like thread movement.  Up, down, forward, next.
17399 @item
17400  a way to tick/mark as read Gcc'd articles.
17401 @item
17402  a way to say that all groups within a specific topic comes
17403 from a particular server?  Hm.
17404 @item
17405  `gnus-article-fill-if-long-lines' -- a function to fill
17406 the article buffer if there are any looong lines there.
17407 @item
17408  `T h' should jump to the parent topic and fold it.
17409 @item
17410  a command to create an ephemeral nndoc group out of a file,
17411 and then splitting it/moving it to some other group/backend.
17412 @item
17413  a group parameter for nnkiboze groups that says that
17414 all kibozed articles should be entered into the cache.
17415 @item
17416  It should also probably be possible to delimit what
17417 `gnus-jog-cache' does -- for instance, work on just some groups, or on
17418 some levels, and entering just articles that have a score higher than
17419 a certain number.
17420 @item
17421  nnfolder should append to the folder instead of re-writing
17422 the entire folder to disk when accepting new messages.
17423 @item
17424  allow all backends to do the proper thing with .gz files.
17425 @item
17426  a backend for reading collections of babyl files nnbabylfolder?
17427 @item
17428  a command for making the native groups into foreign groups.
17429 @item
17430  server mode command for clearing read marks from all groups
17431 from a server.
17432 @item
17433  when following up multiple articles, include all To, Cc, etc headers
17434 from all articles.
17435 @item
17436  a command for deciding what the total score of the current
17437 thread is.  Also a way to highlight based on this.
17438 @item
17439  command to show and edit group scores
17440 @item
17441  a gnus-tree-minimize-horizontal to minimize tree buffers
17442 horizontally.
17443 @item
17444  command to generate nnml overview file for one group.
17445 @item
17446  `C-u C-u a' -- prompt for many crossposted groups.
17447 @item
17448  keep track of which mail groups have received new articles (in this session).
17449 Be able to generate a report and perhaps do some marking in the group
17450 buffer.
17451 @item
17452  gnus-build-sparse-threads to a number -- build only sparse threads
17453 that are of that length.
17454 @item
17455  have nnmh respect mh's unseen sequence in .mh_profile.
17456 @item
17457  cache the newsgroups descriptions locally.
17458 @item
17459  asynchronous posting under nntp.
17460 @item
17461  be able to control word adaptive scoring from the score files.
17462 @item
17463  a variable to make `C-c C-c' post using the "current" select method.
17464 @item
17465  `limit-exclude-low-scored-articles'.
17466 @item
17467  if `gnus-summary-show-thread' is a number, hide threads that have
17468 a score lower than this number.
17469 @item
17470  split newsgroup subscription variable up into "order" and "method".
17471 @item
17472  buttonize ange-ftp file names.
17473 @item
17474  a command to make a duplicate copy of the current article
17475 so that each copy can be edited separately.
17476 @item
17477  nnweb should allow fetching from the local nntp server.
17478 @item
17479  record the sorting done in the summary buffer so that
17480 it can be repeated when limiting/regenerating the buffer.
17481 @item
17482  nnml-generate-nov-databses should generate for
17483 all nnml servers.
17484 @item
17485  when the user does commands in the group buffer, check
17486 the modification time of the .newsrc.eld file and use
17487 ask-user-about-supersession-threat.  Also warn when trying
17488 to save .newsrc.eld and it has changed.
17489 @item
17490  M-g on a topic will display all groups with 0 articles in
17491 the topic.
17492 @item
17493  command to remove all topic stuff.
17494 @item
17495  allow exploding incoming digests when reading incoming mail
17496 and splitting the resulting digests.
17497 @item
17498  nnsoup shouldn't set the `message-' variables.
17499 @item
17500  command to nix out all nnoo state information.
17501 @item
17502  nnmail-process-alist that calls functions if group names
17503 matches an alist -- before saving.
17504 @item
17505  use buffer-invisibility-spec everywhere for hiding text.
17506 @item
17507  variable to activate each group before entering them
17508 to get the (new) number of articles.  `gnus-activate-before-entering'.
17509 @item
17510  command to fetch a Message-ID from any buffer, even
17511 starting Gnus first if necessary.
17512 @item
17513  when posting and checking whether a group exists or not, just
17514 ask the nntp server instead of relying on the active hashtb.
17515 @item
17516  buttonize the output of `C-c C-a' in an apropos-like way.
17517 @item
17518  `G p' should understand process/prefix, and allow editing
17519 of several groups at once.
17520 @item
17521  command to create an ephemeral nnvirtual group that
17522 matches some regexp(s).
17523 @item
17524  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
17525 @item
17526  it should be possible to score "thread" on the From header.
17527 @item
17528  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
17529 @item
17530  `B i' should display the article at once in the summary buffer.
17531 @item
17532  remove the "*" mark at once when unticking an article.
17533 @item
17534  `M-s' should highlight the matching text.
17535 @item
17536  when checking for duplicated mails, use Resent-Message-ID if present.
17537 @item
17538  killing and yanking groups in topics should be better.  If killing one copy
17539 of a group that exists in multiple topics, only that copy should
17540 be removed.  Yanking should insert the copy, and yanking topics
17541 should be possible to be interspersed with the other yankings.
17542 @item
17543  command for enter a group just to read the cached articles.  A way to say
17544 "ignore the nntp connection; just read from the cache."
17545 @item
17546  `X u' should decode base64 articles.
17547 @item
17548  a way to hide all "inner" cited text, leaving just the most
17549 recently cited text.
17550 @item
17551  nnvirtual should be asynchronous.
17552 @item
17553  after editing an article, gnus-original-article-buffer should
17554 be invalidated.
17555 @item
17556  there should probably be a way to make Gnus not connect to the
17557 server and just read the articles in the server
17558 @item
17559  allow a `set-default' (or something) to change the default
17560 value of nnoo variables.
17561 @item
17562  a command to import group infos from a .newsrc.eld file.
17563 @item
17564  groups from secondary servers have the entire select method
17565 listed in each group info.
17566 @item
17567  a command for just switching from the summary buffer to the group
17568 buffer.
17569 @item
17570  a way to specify that some incoming mail washing functions
17571 should only be applied to some groups.
17572 @item
17573  Message `C-f C-t' should ask the user whether to heed
17574 mail-copies-to: never.
17575 @item
17576  new group parameter -- `post-to-server' that says to post
17577 using the current server.  Also a variable to do the same.
17578 @item
17579  the slave dribble files should autosave to the slave file names.
17580 @item
17581  a group parameter that says what articles to display on group entry, based
17582 on article marks.
17583 @item
17584  a way to visually distinguish slave Gnusae from masters.  (Whip instead
17585 of normal logo?)
17586 @item
17587  Use DJ Bernstein "From " quoting/dequoting, where applicable.
17588 @item
17589  Why is hide-citation-maybe and hide-citation different?  Also
17590 clear up info.
17591 @item
17592  group user-defined meta-parameters.
17593
17594
17595
17596 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
17597 @item
17598  I like the option for trying to retrieve the FAQ for a group and I was
17599 thinking it would be great if for those newsgroups that had archives
17600 you could also try to read the archive for that group.  Part of the
17601 problem is that archives are spread all over the net, unlike FAQs.
17602 What would be best I suppose is to find the one closest to your site.
17603
17604 In any case, there is a list of general news group archives at @*
17605 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
17606
17607
17608
17609
17610 @item
17611 @example
17612 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
17613 (add-hook 'gnus-select-group-hook
17614   (lambda ()
17615     (gnus-group-add-parameter group
17616        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
17617
17618 (defun gnus-user-format-function-d (headers)
17619   "Return the date the group was last read."
17620   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
17621       (t "")))
17622 @end example
17623
17624 @item
17625  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
17626 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
17627 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
17628 hatt forskjellige serveres startup-filer forskjellige steder.
17629
17630
17631 @item
17632 LMI> Well, nnbabyl could alter the group info to heed labels like
17633 LMI> answered and read, I guess.
17634
17635 It could also keep them updated (the same for the Status: header of
17636 unix mbox files).
17637
17638 They could be used like this:
17639
17640
17641 @example
17642 `M l <name> RET' add label <name> to current message.
17643 `M u <name> RET' remove label <name> from current message.
17644 `/ l <expr> RET' limit summary buffer according to <expr>.
17645
17646 <expr> would be a boolean expression on the labels, e.g.
17647
17648 `/ l bug & !fixed RET'
17649 @end example
17650
17651 would show all the messages which are labeled `bug' but not labeled
17652 `fixed'.
17653
17654 One could also imagine the labels being used for highlighting, or
17655 affect the summary line format.
17656
17657
17658 @item
17659 Sender: abraham@@dina.kvl.dk
17660
17661 I'd like a gnus-find-file which work like find file, except that it
17662 would recognize things that looks like messages or folders:
17663
17664 - If it is a directory containing numbered files, create an nndir
17665 summary buffer.
17666
17667 - For other directories, create a nneething summary buffer.
17668
17669 - For files matching "\\`From ", create a nndoc/mbox summary.
17670
17671 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
17672
17673 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
17674
17675 - For other files, just find them normally.
17676
17677 I'd like `nneething' to use this function, so it would work on a
17678 directory potentially containing mboxes or babyl files.
17679
17680 @item
17681 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
17682 tell him what you are doing.
17683
17684 @item
17685 Currently, I get prompted:
17686
17687 decend into sci?
17688 - type y
17689 decend into sci.something ?
17690 - type n
17691 decend into ucd?
17692
17693 The problem above is that since there is really only one subsection of
17694 science, shouldn't it prompt you for only descending sci.something?  If
17695 there was a sci.somethingelse group or section, then it should prompt
17696 for sci? first the sci.something? then sci.somethingelse?...
17697
17698 @item
17699 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
17700 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
17701 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
17702 "no.all.SCORE", osv.
17703
17704 @item
17705 What i want is for Gnus to treat any sequence or combination of the following
17706 as a single spoiler warning and hide it all, replacing it with a "Next Page"
17707 button:
17708
17709
17710 ^L's
17711
17712 more than n blank lines
17713
17714 more than m identical lines
17715 (which should be replaced with button to show them)
17716
17717 any whitespace surrounding any of the above
17718
17719
17720 @item
17721 Well, we could allow a new value to `gnus-thread-ignore-subject' --
17722 `spaces', or something.  (We could even default to that.)  And then
17723 subjects that differ in white space only could be considered the
17724 "same" subject for threading purposes.
17725
17726 @item
17727 Modes to preprocess the contents (e.g. jka-compr) use the second form
17728 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
17729 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
17730 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
17731
17732 @item
17733  Under XEmacs -- do funny article marks:
17734 tick - thumb tack
17735 killed - skull
17736 soup - bowl of soup
17737 score below - dim light bulb
17738 score over - bright light bulb
17739
17740 @item
17741 Yes. I think the algorithm is as follows:
17742
17743 @example
17744 Group-mode
17745
17746    show-list-of-articles-in-group
17747         if (key-pressed == SPACE)
17748                 if (no-more-articles-in-group-to-select)
17749                         if (articles-selected)
17750                                 start-reading-selected-articles;
17751                         junk-unread-articles;
17752                         next-group;
17753                  else
17754                         show-next-page;
17755
17756          else if (key-pressed = '.')
17757                 if (consolidated-menus)         # same as hide-thread in Gnus
17758                         select-thread-under-cursor;
17759                 else
17760                         select-article-under-cursor;
17761
17762
17763 Article-mode
17764         if (key-pressed == SPACE)
17765                 if (more-pages-in-article)
17766                         next-page;
17767                 else if (more-selected-articles-to-read)
17768                         next-article;
17769                 else
17770                         next-group;
17771 @end example
17772
17773 @item
17774 My precise need here would have been to limit files to Incoming*.
17775 One could think of some `nneething-only-files' variable, but I guess
17776 it would have been unacceptable if one was using many unrelated such
17777 nneething groups.
17778
17779 A more useful approach would be to, in response to the `G D' prompt, be
17780 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
17781 the top-level directory only (in case directories would be matched by
17782 the wildcard expression).
17783
17784 @item
17785 It would be nice if it also handled
17786
17787         <URL:news://sunsite.auc.dk/>
17788
17789 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
17790
17791
17792 @item
17793
17794   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
17795 really well.  Each menu is 'named' by a symbol that would be on a
17796 gnus-*-menus (where * would be whatever, but at least group, summary, and
17797 article versions) variable.
17798
17799   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
17800
17801   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
17802 the main menubar.  This approach works really well for Emacs-W3 and VM.
17803
17804
17805 @item
17806  nndoc should take care to create unique Message-IDs for all its
17807 articles.
17808 @item
17809  gnus-score-followup-article only works when you have a summary buffer
17810 active.  Make it work when posting from the group buffer as well.
17811 (message-sent-hook).
17812 @item
17813  rewrite gnus-demon to use run-with-idle-timers.
17814
17815 @item
17816  * Enhancements to Gnus:
17817
17818   Add two commands:
17819
17820   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
17821     straight to the server buffer, without opening any connections to
17822     servers first.
17823
17824   * gnus-server-read-server-newsrc--produces a buffer very similar to
17825     the group buffer, but with only groups from that server listed;
17826     quitting this buffer returns to the server buffer.
17827
17828 @item
17829  add a command to check the integrity of an nnfolder folder --
17830 go through the article numbers and see that there are no duplicates,
17831 and stuff.
17832
17833 @item
17834  `unsmileyfy-buffer' to undo smileification.
17835
17836 @item
17837  a command to give all relevant info on an article, including all
17838 secondary marks.
17839
17840 @item
17841  when doing `-request-accept-article', the backends should do
17842 the nnmail duplicate checking.
17843
17844 @item
17845  allow `message-signature-file' to be a function to return the
17846 value of the signature file.
17847
17848 @item
17849  In addition, I would love it if I could configure message-tab so that it
17850 could call `bbdb-complete-name' in other headers.  So, some sort of
17851 interface like
17852
17853 (setq message-tab-alist
17854       '((message-header-regexp message-expand-group)
17855         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
17856
17857 then you could run the relevant function to complete the information in
17858 the header
17859
17860 @item
17861  cache the newsgroups file locally to avoid reloading it all the time.
17862
17863 @item
17864  a command to import a buffer into a group.
17865
17866 @item
17867  nnweb should allow fetching by Message-ID from servers.
17868
17869 @item
17870  point in the article buffer doesn't always go to the
17871 beginning of the buffer when selecting new articles.
17872
17873 @item
17874  a command to process mark all unread articles.
17875
17876 @item
17877  `gnus-gather-threads-by-references-and-subject' -- first
17878 do gathering by references, and then go through the dummy roots and
17879 do more gathering by subject.
17880
17881 @item
17882  gnus-uu-mark-in-numerical-order -- process mark articles in
17883 article numerical order.
17884
17885 @item
17886  (gnus-thread-total-score
17887  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
17888 bind to a key.
17889
17890 @item
17891  sorting by score is wrong when using sparse threads.
17892
17893 @item
17894  a command to fetch an arbitrary article -- without having to be
17895 in the summary buffer.
17896
17897 @item
17898  a new nncvs backend.  Each group would show an article, using
17899 version branches as threading, checkin date as the date, etc.
17900
17901 @item
17902  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
17903 This filter allows one to construct advance queries on the Dejanews
17904 database such as specifying start and end dates, subject, author,
17905 and/or newsgroup name.
17906
17907 @item
17908  new Date header scoring type -- older, newer
17909
17910 @item
17911  use the summary toolbar in the article buffer.
17912
17913 @item
17914  a command to fetch all articles that are less than X days old.
17915
17916 @item
17917  in pick mode, `q' should save the list of selected articles in the
17918 group info.  The next time the group is selected, these articles
17919 will automatically get the process mark.
17920
17921 @item
17922  Isn't it possible to (also?) allow M-^ to automatically try the
17923 default server if it fails on the current server?  (controlled by a
17924 user variable, (nil, t, 'ask)).
17925
17926 @item
17927  make it possible to cancel articles using the select method for the
17928 current group.
17929
17930 @item
17931  `gnus-summary-select-article-on-entry' or something.  It'll default
17932 to t and will select whatever article decided by `gnus-auto-select-first'.
17933
17934 @item
17935  a new variable to control which selection commands should be unselecting.
17936 `first', `best', `next', `prev', `next-unread', `prev-unread' are
17937 candidates.
17938
17939 @item
17940  be able to select groups that have no articles in them
17941 to be able to post in them (using the current select method).
17942
17943 @item
17944  be able to post via DejaNews.
17945
17946 @item
17947  `x' should retain any sortings that have been performed.
17948
17949 @item
17950  allow the user to specify the precedence of the secondary marks.  Also
17951 allow them to be displayed separately.
17952
17953 @item
17954  gnus-summary-save-in-pipe should concatenate the results from
17955 the processes when doing a process marked pipe.
17956
17957 @item
17958  a new match type, like Followup, but which adds Thread matches on all
17959 articles that match a certain From header.
17960
17961 @item
17962  a function that can be read from kill-emacs-query-functions to offer
17963 saving living summary buffers.
17964
17965 @item
17966  a function for selecting a particular group which will contain
17967 the articles listed in a list of article numbers/id's.
17968
17969 @item
17970  a battery of character translation functions to translate common
17971 Mac, MS (etc) characters into ISO 8859-1.
17972
17973 @example
17974 (defun article-fix-m$word ()
17975   "Fix M$Word smartquotes in an article."
17976   (interactive)
17977   (save-excursion
17978     (let ((buffer-read-only nil))
17979       (goto-char (point-min))
17980       (while (search-forward "\221" nil t)
17981         (replace-match "`" t t))
17982       (goto-char (point-min))
17983       (while (search-forward "\222" nil t)
17984         (replace-match "'" t t))
17985       (goto-char (point-min))
17986       (while (search-forward "\223" nil t)
17987         (replace-match "\"" t t))
17988       (goto-char (point-min))
17989       (while (search-forward "\224" nil t)
17990         (replace-match "\"" t t)))))
17991 @end example
17992
17993 @item
17994 @example
17995  (add-hook 'gnus-exit-query-functions
17996 '(lambda ()
17997    (if (and (file-exists-p nnmail-spool-file)
17998             (> (nnheader-file-size nnmail-spool-file) 0))
17999        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
18000        (y-or-n-p "Are you sure you want to quit Gnus? "))))
18001 @end example
18002
18003 @item
18004  allow message-default-headers to be a function.
18005
18006 @item
18007  new Date score match types -- < > = (etc) that take floating point
18008 numbers and match on the age of the article.
18009
18010 @item
18011 @example
18012 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18013 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
18014 >  > > buffer in the frame that it was called from =:-O
18015 >
18016 >  > Hm.  How do you start up Gnus?  From the toolbar or with
18017 >  > `M-x gnus-other-frame'?
18018 >
18019 >    I normally start it up from the toolbar; at
18020 > least that's the way I've caught it doing the
18021 > deed before.
18022 @end example
18023
18024 @item
18025  all commands that react to the process mark should push
18026 the current process mark set onto the stack.
18027
18028 @item
18029  gnus-article-hide-pgp
18030 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
18031 @example
18032 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18033 @end example
18034 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
18035 er min type heuristikk og langt fra alles.
18036
18037 @item
18038  `gnus-subscribe-sorted' -- insert new groups where they would have been
18039 sorted to if `gnus-group-sort-function' were run.
18040
18041 @item
18042  gnus-(group,summary)-highlight should respect any `face' text props set
18043 on the lines.
18044
18045 @item
18046  use run-with-idle-timer for gnus-demon instead of the
18047 home-brewed stuff for better reliability.
18048
18049 @item
18050  add a way to select which NoCeM type to apply -- spam, troll, etc.
18051
18052 @item
18053  nndraft-request-group should tally autosave files.
18054
18055 @item
18056  implement nntp-retry-on-break and nntp-command-timeout.
18057
18058 @item
18059  gnus-article-highlight-limit that says when not to highlight (long)
18060 articles.
18061
18062 @item
18063  (nnoo-set SERVER VARIABLE VALUE)
18064
18065 @item
18066  nn*-spool-methods
18067
18068 @item
18069  interrupitng agent fetching of articles should save articles.
18070
18071 @item
18072  command to open a digest group, and copy all the articles there to the
18073 current group.
18074
18075 @item
18076  a variable to disable article body highlights if there's more than
18077 X characters in the body.
18078
18079 @item
18080  handle 480/381 authinfo requests separately.
18081
18082 @item
18083  include the texi/dir file in the distribution.
18084
18085 @item
18086  format spec to "tab" to a position.
18087
18088 @item
18089  Move all prompting to the new `M-n' default style.
18090
18091 @item
18092  command to display all dormant articles.
18093
18094 @item
18095  gnus-auto-select-next makeover -- list of things it should do.
18096
18097 @item
18098  a score match type that adds scores matching on From if From has replied
18099 to something someone else has said.
18100
18101 @item
18102  Read Netscape discussion groups:
18103 snews://secnews.netscape.com/netscape.communicator.unix
18104
18105 @item
18106 One command to edit the original version if an article, and one to edit
18107 the displayed version.
18108
18109 @item
18110 @kbd{T v} -- make all process-marked articles the children of the
18111 current article.
18112
18113 @item
18114 Switch from initial text to the new default text mechanism.
18115
18116 @item
18117 How about making it possible to expire local articles?  Will it be
18118 possible to make various constraints on when an article can be
18119 expired, e.g. (read), (age > 14 days), or the more interesting (read
18120 & age > 14 days)?
18121
18122 @item
18123 New limit command---limit to articles that have a certain string
18124 in the head or body.
18125
18126 @item
18127 Allow breaking lengthy NNTP commands.
18128
18129 @item
18130 gnus-article-highlight-limit, to disable highlighting in big articles.
18131
18132 @item
18133 Editing an article should put the article to be edited
18134 in a special, unique buffer.
18135
18136 @item
18137 A command to send a mail to the admin-address group param.
18138
18139 @item
18140 A Date scoring type that will match if the article
18141 is less than a certain number of days old.
18142
18143 @item
18144 New spec: %~(tab 56) to put point on column 56
18145
18146 @item
18147 Allow Gnus Agent scoring to use normal score files.
18148
18149 @item
18150 Rething the Agent active file thing.  `M-g' doesn't update the active
18151 file, for instance.
18152
18153 @item
18154 With dummy roots, `^' and then selecing the first article
18155 in any other dummy thread will make Gnus highlight the
18156 dummy root instead of the first article.
18157
18158 @item
18159 Propagate all group properties (marks, article numbers, etc) up to the
18160 topics for displaying.
18161
18162 @item
18163 `n' in the group buffer with topics should go to the next group
18164 with unread articles, even if that group is hidden in a topic.
18165
18166 @item
18167 gnus-posting-styles doesn't work in drafts.
18168
18169 @item
18170 gnus-summary-limit-include-cached is slow when there are
18171 many articles in the cache, since it regenerates big parts of the
18172 summary buffer for each article.
18173
18174 @item
18175 Implement gnus-batch-brew-soup.
18176
18177 @item
18178 Group parameters and summary commands for un/subscribing to mailing
18179 lists. 
18180
18181 @item
18182 Introduce nnmail-home-directory.
18183
18184 @item
18185 gnus-fetch-group and friends should exit Gnus when the user
18186 exits the group.
18187
18188 @item
18189 The jingle is only played on the second invocation of Gnus.
18190
18191 @item
18192 gnus-ignored-mime-types to avoid seeing buttons for Vcards and the
18193 like.
18194
18195 @item
18196 Bouncing articles should do MIME.
18197
18198 @item
18199 Crossposted articles should "inherit" the % or @ mark from the other
18200 groups it has been crossposted to, or something.  (Agent.)
18201
18202 @item
18203 Solve the halting problem.
18204
18205 @c TODO
18206 @end itemize
18207
18208 @iftex
18209
18210 @page
18211 @node The Manual
18212 @section The Manual
18213 @cindex colophon
18214 @cindex manual
18215
18216 This manual was generated from a TeXinfo file and then run through
18217 either @code{texi2dvi}
18218 @iflatex
18219 or my own home-brewed TeXinfo to \LaTeX\ transformer,
18220 and then run through @code{latex} and @code{dvips}
18221 @end iflatex
18222 to get what you hold in your hands now.
18223
18224 The following conventions have been used:
18225
18226 @enumerate
18227
18228 @item
18229 This is a @samp{string}
18230
18231 @item
18232 This is a @kbd{keystroke}
18233
18234 @item
18235 This is a @file{file}
18236
18237 @item
18238 This is a @code{symbol}
18239
18240 @end enumerate
18241
18242 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
18243 mean:
18244
18245 @lisp
18246 (setq flargnoze "yes")
18247 @end lisp
18248
18249 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
18250
18251 @lisp
18252 (setq flumphel 'yes)
18253 @end lisp
18254
18255 @samp{yes} and @code{yes} are two @emph{very} different things---don't
18256 ever get them confused.
18257
18258 @iflatex
18259 @c @head
18260 Of course, everything in this manual is of vital interest, so you should
18261 read it all.  Several times.  However, if you feel like skimming the
18262 manual, look for that gnu head you should see in the margin over
18263 there---it means that what's being discussed is of more importance than
18264 the rest of the stuff.  (On the other hand, if everything is infinitely
18265 important, how can anything be more important than that?  Just one more
18266 of the mysteries of this world, I guess.)
18267 @end iflatex
18268
18269 @end iftex
18270
18271
18272 @page
18273 @node Terminology
18274 @section Terminology
18275
18276 @cindex terminology
18277 @table @dfn
18278
18279 @item news
18280 @cindex news
18281 This is what you are supposed to use this thing for---reading news.
18282 News is generally fetched from a nearby @sc{nntp} server, and is
18283 generally publicly available to everybody.  If you post news, the entire
18284 world is likely to read just what you have written, and they'll all
18285 snigger mischievously.  Behind your back.
18286
18287 @item mail
18288 @cindex mail
18289 Everything that's delivered to you personally is mail.  Some news/mail
18290 readers (like Gnus) blur the distinction between mail and news, but
18291 there is a difference.  Mail is private.  News is public.  Mailing is
18292 not posting, and replying is not following up.
18293
18294 @item reply
18295 @cindex reply
18296 Send a mail to the person who has written what you are reading.
18297
18298 @item follow up
18299 @cindex follow up
18300 Post an article to the current newsgroup responding to the article you
18301 are reading.
18302
18303 @item backend
18304 @cindex backend
18305 Gnus gets fed articles from a number of backends, both news and mail
18306 backends.  Gnus does not handle the underlying media, so to speak---this
18307 is all done by the backends.
18308
18309 @item native
18310 @cindex native
18311 Gnus will always use one method (and backend) as the @dfn{native}, or
18312 default, way of getting news.
18313
18314 @item foreign
18315 @cindex foreign
18316 You can also have any number of foreign groups active at the same time.
18317 These are groups that use non-native non-secondary backends for getting
18318 news.
18319
18320 @item secondary
18321 @cindex secondary
18322 Secondary backends are somewhere half-way between being native and being
18323 foreign, but they mostly act like they are native.
18324
18325 @item article
18326 @cindex article
18327 A message that has been posted as news.
18328
18329 @item mail message
18330 @cindex mail message
18331 A message that has been mailed.
18332
18333 @item message
18334 @cindex message
18335 A mail message or news article
18336
18337 @item head
18338 @cindex head
18339 The top part of a message, where administrative information (etc.) is
18340 put.
18341
18342 @item body
18343 @cindex body
18344 The rest of an article.  Everything not in the head is in the
18345 body.
18346
18347 @item header
18348 @cindex header
18349 A line from the head of an article.
18350
18351 @item headers
18352 @cindex headers
18353 A collection of such lines, or a collection of heads.  Or even a
18354 collection of @sc{nov} lines.
18355
18356 @item @sc{nov}
18357 @cindex nov
18358 When Gnus enters a group, it asks the backend for the headers of all
18359 unread articles in the group.  Most servers support the News OverView
18360 format, which is more compact and much faster to read and parse than the
18361 normal @sc{head} format.
18362
18363 @item level
18364 @cindex levels
18365 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
18366 that have a lower level are ``more'' subscribed than the groups with a
18367 higher level.  In fact, groups on levels 1-5 are considered
18368 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
18369 are @dfn{killed}.  Commands for listing groups and scanning for new
18370 articles will all use the numeric prefix as @dfn{working level}.
18371
18372 @item killed groups
18373 @cindex killed groups
18374 No information on killed groups is stored or updated, which makes killed
18375 groups much easier to handle than subscribed groups.
18376
18377 @item zombie groups
18378 @cindex zombie groups
18379 Just like killed groups, only slightly less dead.
18380
18381 @item active file
18382 @cindex active file
18383 The news server has to keep track of what articles it carries, and what
18384 groups exist.  All this information in stored in the active file, which
18385 is rather large, as you might surmise.
18386
18387 @item bogus groups
18388 @cindex bogus groups
18389 A group that exists in the @file{.newsrc} file, but isn't known to the
18390 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
18391 This means that the group probably doesn't exist (any more).
18392
18393 @item activating
18394 @cindex activating groups
18395 The act of asking the server for info on a group and computing the
18396 number of unread articles is called @dfn{activating the group}.
18397 Un-activated groups are listed with @samp{*} in the group buffer.
18398
18399 @item server
18400 @cindex server
18401 A machine one can connect to and get news (or mail) from.
18402
18403 @item select method
18404 @cindex select method
18405 A structure that specifies the backend, the server and the virtual
18406 server settings.
18407
18408 @item virtual server
18409 @cindex virtual server
18410 A named select method.  Since a select method defines all there is to
18411 know about connecting to a (physical) server, taking the thing as a
18412 whole is a virtual server.
18413
18414 @item washing
18415 @cindex washing
18416 Taking a buffer and running it through a filter of some sort.  The
18417 result will (more often than not) be cleaner and more pleasing than the
18418 original.
18419
18420 @item ephemeral groups
18421 @cindex ephemeral groups
18422 Most groups store data on what articles you have read.  @dfn{Ephemeral}
18423 groups are groups that will have no data stored---when you exit the
18424 group, it'll disappear into the aether.
18425
18426 @item solid groups
18427 @cindex solid groups
18428 This is the opposite of ephemeral groups.  All groups listed in the
18429 group buffer are solid groups.
18430
18431 @item sparse articles
18432 @cindex sparse articles
18433 These are article placeholders shown in the summary buffer when
18434 @code{gnus-build-sparse-threads} has been switched on.
18435
18436 @item threading
18437 @cindex threading
18438 To put responses to articles directly after the articles they respond
18439 to---in a hierarchical fashion.
18440
18441 @item root
18442 @cindex root
18443 @cindex thread root
18444 The first article in a thread is the root.  It is the ancestor of all
18445 articles in the thread.
18446
18447 @item parent
18448 @cindex parent
18449 An article that has responses.
18450
18451 @item child
18452 @cindex child
18453 An article that responds to a different article---its parent.
18454
18455 @item digest
18456 @cindex digest
18457 A collection of messages in one file.  The most common digest format is
18458 specified by RFC1153.
18459
18460 @end table
18461
18462
18463 @page
18464 @node Customization
18465 @section Customization
18466 @cindex general customization
18467
18468 All variables are properly documented elsewhere in this manual.  This
18469 section is designed to give general pointers on how to customize Gnus
18470 for some quite common situations.
18471
18472 @menu
18473 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
18474 * Slow Terminal Connection::  You run a remote Emacs.
18475 * Little Disk Space::         You feel that having large setup files is icky.
18476 * Slow Machine::              You feel like buying a faster machine.
18477 @end menu
18478
18479
18480 @node Slow/Expensive Connection
18481 @subsection Slow/Expensive @sc{nntp} Connection
18482
18483 If you run Emacs on a machine locally, and get your news from a machine
18484 over some very thin strings, you want to cut down on the amount of data
18485 Gnus has to get from the @sc{nntp} server.
18486
18487 @table @code
18488
18489 @item gnus-read-active-file
18490 Set this to @code{nil}, which will inhibit Gnus from requesting the
18491 entire active file from the server.  This file is often v.  large.  You
18492 also have to set @code{gnus-check-new-newsgroups} and
18493 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
18494 doesn't suddenly decide to fetch the active file anyway.
18495
18496 @item gnus-nov-is-evil
18497 This one has to be @code{nil}.  If not, grabbing article headers from
18498 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
18499 support @sc{xover}; Gnus will detect this by itself.
18500 @end table
18501
18502
18503 @node Slow Terminal Connection
18504 @subsection Slow Terminal Connection
18505
18506 Let's say you use your home computer for dialing up the system that runs
18507 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
18508 possible) the amount of data sent over the wires.
18509
18510 @table @code
18511
18512 @item gnus-auto-center-summary
18513 Set this to @code{nil} to inhibit Gnus from re-centering the summary
18514 buffer all the time.  If it is @code{vertical}, do only vertical
18515 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
18516 horizontal and vertical recentering.
18517
18518 @item gnus-visible-headers
18519 Cut down on the headers included in the articles to the
18520 minimum.  You can, in fact, make do without them altogether---most of the
18521 useful data is in the summary buffer, anyway.  Set this variable to
18522 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
18523
18524 @item gnus-article-display-hook
18525 Set this hook to all the available hiding commands:
18526 @lisp
18527 (setq gnus-article-display-hook
18528       '(gnus-article-hide-headers
18529         gnus-article-hide-signature
18530         gnus-article-hide-citation))
18531 @end lisp
18532
18533 @item gnus-use-full-window
18534 By setting this to @code{nil}, you can make all the windows smaller.
18535 While this doesn't really cut down much generally, it means that you
18536 have to see smaller portions of articles before deciding that you didn't
18537 want to read them anyway.
18538
18539 @item gnus-thread-hide-subtree
18540 If this is non-@code{nil}, all threads in the summary buffer will be
18541 hidden initially.
18542
18543 @item gnus-updated-mode-lines
18544 If this is @code{nil}, Gnus will not put information in the buffer mode
18545 lines, which might save some time.
18546 @end table
18547
18548
18549 @node Little Disk Space
18550 @subsection Little Disk Space
18551 @cindex disk space
18552
18553 The startup files can get rather large, so you may want to cut their
18554 sizes a bit if you are running out of space.
18555
18556 @table @code
18557
18558 @item gnus-save-newsrc-file
18559 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
18560 only save @file{.newsrc.eld}.  This means that you will not be able to
18561 use any other newsreaders than Gnus.  This variable is @code{t} by
18562 default.
18563
18564 @item gnus-save-killed-list
18565 If this is @code{nil}, Gnus will not save the list of dead groups.  You
18566 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
18567 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
18568 variable to @code{nil}.  This variable is @code{t} by default.
18569
18570 @end table
18571
18572
18573 @node Slow Machine
18574 @subsection Slow Machine
18575 @cindex slow machine
18576
18577 If you have a slow machine, or are just really impatient, there are a
18578 few things you can do to make Gnus run faster.
18579
18580 Set @code{gnus-check-new-newsgroups} and
18581 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
18582
18583 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
18584 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
18585 summary buffer faster.
18586
18587 Set @code{gnus-article-display-hook} to @code{nil} to make article
18588 processing a bit faster.
18589
18590
18591 @page
18592 @node Troubleshooting
18593 @section Troubleshooting
18594 @cindex troubleshooting
18595
18596 Gnus works @emph{so} well straight out of the box---I can't imagine any
18597 problems, really.
18598
18599 Ahem.
18600
18601 @enumerate
18602
18603 @item
18604 Make sure your computer is switched on.
18605
18606 @item
18607 Make sure that you really load the current Gnus version.  If you have
18608 been running @sc{gnus}, you need to exit Emacs and start it up again before
18609 Gnus will work.
18610
18611 @item
18612 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
18613 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
18614 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
18615 flee}, you have some old @file{.el} files lying around.  Delete these.
18616
18617 @item
18618 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
18619 how-to.
18620
18621 @item
18622 @vindex max-lisp-eval-depth
18623 Gnus works on many recursive structures, and in some extreme (and very
18624 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
18625 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
18626 something like that.
18627 @end enumerate
18628
18629 If all else fails, report the problem as a bug.
18630
18631 @cindex bugs
18632 @cindex reporting bugs
18633
18634 @kindex M-x gnus-bug
18635 @findex gnus-bug
18636 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
18637 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
18638 me the backtrace.  I will fix bugs, but I can only fix them if you send
18639 me a precise description as to how to reproduce the bug.
18640
18641 You really can never be too detailed in a bug report.  Always use the
18642 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
18643 a 10Kb mail each time you use it, and even if you have sent me your
18644 environment 500 times before.  I don't care.  I want the full info each
18645 time.
18646
18647 It is also important to remember that I have no memory whatsoever.  If
18648 you send a bug report, and I send you a reply, and then you just send
18649 back ``No, it's not! Moron!'', I will have no idea what you are
18650 insulting me about.  Always over-explain everything.  It's much easier
18651 for all of us---if I don't have all the information I need, I will just
18652 mail you and ask for more info, and everything takes more time.
18653
18654 If the problem you're seeing is very visual, and you can't quite explain
18655 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
18656 it somewhere it can be reached, and include the URL of the picture in
18657 the bug report.
18658
18659 If you just need help, you are better off asking on
18660 @samp{gnu.emacs.gnus}.  I'm not very helpful.
18661
18662 @cindex gnu.emacs.gnus
18663 @cindex ding mailing list
18664 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
18665 Write to @samp{ding-request@@gnus.org} to subscribe.
18666
18667
18668 @page
18669 @node A Programmers Guide to Gnus
18670 @section A Programmer@'s Guide to Gnus
18671
18672 It is my hope that other people will figure out smart stuff that Gnus
18673 can do, and that other people will write those smart things as well.  To
18674 facilitate that I thought it would be a good idea to describe the inner
18675 workings of Gnus.  And some of the not-so-inner workings, while I'm at
18676 it.
18677
18678 You can never expect the internals of a program not to change, but I
18679 will be defining (in some details) the interface between Gnus and its
18680 backends (this is written in stone), the format of the score files
18681 (ditto), data structures (some are less likely to change than others)
18682 and general methods of operation.
18683
18684 @menu
18685 * Gnus Utility Functions::   Common functions and variable to use.
18686 * Backend Interface::        How Gnus communicates with the servers.
18687 * Score File Syntax::        A BNF definition of the score file standard.
18688 * Headers::                  How Gnus stores headers internally.
18689 * Ranges::                   A handy format for storing mucho numbers.
18690 * Group Info::               The group info format.
18691 * Extended Interactive::     Symbolic prefixes and stuff.
18692 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
18693 * Various File Formats::     Formats of files that Gnus use.
18694 @end menu
18695
18696
18697 @node Gnus Utility Functions
18698 @subsection Gnus Utility Functions
18699 @cindex Gnus utility functions
18700 @cindex utility functions
18701 @cindex functions
18702 @cindex internal variables
18703
18704 When writing small functions to be run from hooks (and stuff), it's
18705 vital to have access to the Gnus internal functions and variables.
18706 Below is a list of the most common ones.
18707
18708 @table @code
18709
18710 @item gnus-newsgroup-name
18711 @vindex gnus-newsgroup-name
18712 This variable holds the name of the current newsgroup.
18713
18714 @item gnus-find-method-for-group
18715 @findex gnus-find-method-for-group
18716 A function that returns the select method for @var{group}.
18717
18718 @item gnus-group-real-name
18719 @findex gnus-group-real-name
18720 Takes a full (prefixed) Gnus group name, and returns the unprefixed
18721 name.
18722
18723 @item gnus-group-prefixed-name
18724 @findex gnus-group-prefixed-name
18725 Takes an unprefixed group name and a select method, and returns the full
18726 (prefixed) Gnus group name.
18727
18728 @item gnus-get-info
18729 @findex gnus-get-info
18730 Returns the group info list for @var{group}.
18731
18732 @item gnus-group-unread
18733 @findex gnus-group-unread
18734 The number of unread articles in @var{group}, or @code{t} if that is
18735 unknown.
18736
18737 @item gnus-active
18738 @findex gnus-active
18739 The active entry for @var{group}.
18740
18741 @item gnus-set-active
18742 @findex gnus-set-active
18743 Set the active entry for @var{group}.
18744
18745 @item gnus-add-current-to-buffer-list
18746 @findex gnus-add-current-to-buffer-list
18747 Adds the current buffer to the list of buffers to be killed on Gnus
18748 exit.
18749
18750 @item gnus-continuum-version
18751 @findex gnus-continuum-version
18752 Takes a Gnus version string as a parameter and returns a floating point
18753 number.  Earlier versions will always get a lower number than later
18754 versions.
18755
18756 @item gnus-group-read-only-p
18757 @findex gnus-group-read-only-p
18758 Says whether @var{group} is read-only or not.
18759
18760 @item gnus-news-group-p
18761 @findex gnus-news-group-p
18762 Says whether @var{group} came from a news backend.
18763
18764 @item gnus-ephemeral-group-p
18765 @findex gnus-ephemeral-group-p
18766 Says whether @var{group} is ephemeral or not.
18767
18768 @item gnus-server-to-method
18769 @findex gnus-server-to-method
18770 Returns the select method corresponding to @var{server}.
18771
18772 @item gnus-server-equal
18773 @findex gnus-server-equal
18774 Says whether two virtual servers are equal.
18775
18776 @item gnus-group-native-p
18777 @findex gnus-group-native-p
18778 Says whether @var{group} is native or not.
18779
18780 @item gnus-group-secondary-p
18781 @findex gnus-group-secondary-p
18782 Says whether @var{group} is secondary or not.
18783
18784 @item gnus-group-foreign-p
18785 @findex gnus-group-foreign-p
18786 Says whether @var{group} is foreign or not.
18787
18788 @item group-group-find-parameter
18789 @findex group-group-find-parameter
18790 Returns the parameter list of @var{group}.  If given a second parameter,
18791 returns the value of that parameter for @var{group}.
18792
18793 @item gnus-group-set-parameter
18794 @findex gnus-group-set-parameter
18795 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
18796
18797 @item gnus-narrow-to-body
18798 @findex gnus-narrow-to-body
18799 Narrows the current buffer to the body of the article.
18800
18801 @item gnus-check-backend-function
18802 @findex gnus-check-backend-function
18803 Takes two parameters, @var{function} and @var{group}.  If the backend
18804 @var{group} comes from supports @var{function}, return non-@code{nil}.
18805
18806 @lisp
18807 (gnus-check-backend-function "request-scan" "nnml:misc")
18808 => t
18809 @end lisp
18810
18811 @item gnus-read-method
18812 @findex gnus-read-method
18813 Prompts the user for a select method.
18814
18815 @end table
18816
18817
18818 @node Backend Interface
18819 @subsection Backend Interface
18820
18821 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
18822 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
18823 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
18824 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
18825 examples of the latter we have @code{nntp-port-number} and
18826 @code{nnmbox-directory}.
18827
18828 When Gnus asks for information from a backend---say @code{nntp}---on
18829 something, it will normally include a virtual server name in the
18830 function parameters.  (If not, the backend should use the ``current''
18831 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
18832 server as its only (optional) parameter.  If this virtual server hasn't
18833 been opened, the function should fail.
18834
18835 Note that a virtual server name has no relation to some physical server
18836 name.  Take this example:
18837
18838 @lisp
18839 (nntp "odd-one"
18840       (nntp-address "ifi.uio.no")
18841       (nntp-port-number 4324))
18842 @end lisp
18843
18844 Here the virtual server name is @samp{odd-one} while the name of
18845 the physical server is @samp{ifi.uio.no}.
18846
18847 The backends should be able to switch between several virtual servers.
18848 The standard backends implement this by keeping an alist of virtual
18849 server environments that they pull down/push up when needed.
18850
18851 There are two groups of interface functions: @dfn{required functions},
18852 which must be present, and @dfn{optional functions}, which Gnus will
18853 always check for presence before attempting to call 'em.
18854
18855 All these functions are expected to return data in the buffer
18856 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
18857 unfortunately named, but we'll have to live with it.  When I talk about
18858 @dfn{resulting data}, I always refer to the data in that buffer.  When I
18859 talk about @dfn{return value}, I talk about the function value returned by
18860 the function call.  Functions that fail should return @code{nil} as the
18861 return value.
18862
18863 Some backends could be said to be @dfn{server-forming} backends, and
18864 some might be said not to be.  The latter are backends that generally
18865 only operate on one group at a time, and have no concept of ``server''
18866 -- they have a group, and they deliver info on that group and nothing
18867 more.
18868
18869 In the examples and definitions I will refer to the imaginary backend
18870 @code{nnchoke}.
18871
18872 @cindex @code{nnchoke}
18873
18874 @menu
18875 * Required Backend Functions::        Functions that must be implemented.
18876 * Optional Backend Functions::        Functions that need not be implemented.
18877 * Error Messaging::                   How to get messages and report errors.
18878 * Writing New Backends::              Extending old backends.
18879 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
18880 * Mail-like Backends::                Some tips on mail backends.
18881 @end menu
18882
18883
18884 @node Required Backend Functions
18885 @subsubsection Required Backend Functions
18886
18887 @table @code
18888
18889 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
18890
18891 @var{articles} is either a range of article numbers or a list of
18892 @code{Message-ID}s.  Current backends do not fully support either---only
18893 sequences (lists) of article numbers, and most backends do not support
18894 retrieval of @code{Message-ID}s.  But they should try for both.
18895
18896 The result data should either be HEADs or NOV lines, and the result
18897 value should either be @code{headers} or @code{nov} to reflect this.
18898 This might later be expanded to @code{various}, which will be a mixture
18899 of HEADs and NOV lines, but this is currently not supported by Gnus.
18900
18901 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
18902 headers", in some meaning of the word.  This is generally done by
18903 fetching (at most) @var{fetch-old} extra headers less than the smallest
18904 article number in @code{articles}, and filling the gaps as well.  The
18905 presence of this parameter can be ignored if the backend finds it
18906 cumbersome to follow the request.  If this is non-@code{nil} and not a
18907 number, do maximum fetches.
18908
18909 Here's an example HEAD:
18910
18911 @example
18912 221 1056 Article retrieved.
18913 Path: ifi.uio.no!sturles
18914 From: sturles@@ifi.uio.no (Sturle Sunde)
18915 Newsgroups: ifi.discussion
18916 Subject: Re: Something very droll
18917 Date: 27 Oct 1994 14:02:57 +0100
18918 Organization: Dept. of Informatics, University of Oslo, Norway
18919 Lines: 26
18920 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
18921 References: <38jdmq$4qu@@visbur.ifi.uio.no>
18922 NNTP-Posting-Host: holmenkollen.ifi.uio.no
18923 .
18924 @end example
18925
18926 So a @code{headers} return value would imply that there's a number of
18927 these in the data buffer.
18928
18929 Here's a BNF definition of such a buffer:
18930
18931 @example
18932 headers        = *head
18933 head           = error / valid-head
18934 error-message  = [ "4" / "5" ] 2number " " <error message> eol
18935 valid-head     = valid-message *header "." eol
18936 valid-message  = "221 " <number> " Article retrieved." eol
18937 header         = <text> eol
18938 @end example
18939
18940 If the return value is @code{nov}, the data buffer should contain
18941 @dfn{network overview database} lines.  These are basically fields
18942 separated by tabs.
18943
18944 @example
18945 nov-buffer = *nov-line
18946 nov-line   = 8*9 [ field <TAB> ] eol
18947 field      = <text except TAB>
18948 @end example
18949
18950 For a closer look at what should be in those fields,
18951 @pxref{Headers}.
18952
18953
18954 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
18955
18956 @var{server} is here the virtual server name.  @var{definitions} is a
18957 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
18958
18959 If the server can't be opened, no error should be signaled.  The backend
18960 may then choose to refuse further attempts at connecting to this
18961 server.  In fact, it should do so.
18962
18963 If the server is opened already, this function should return a
18964 non-@code{nil} value.  There should be no data returned.
18965
18966
18967 @item (nnchoke-close-server &optional SERVER)
18968
18969 Close connection to @var{server} and free all resources connected
18970 to it.  Return @code{nil} if the server couldn't be closed for some
18971 reason.
18972
18973 There should be no data returned.
18974
18975
18976 @item (nnchoke-request-close)
18977
18978 Close connection to all servers and free all resources that the backend
18979 have reserved.  All buffers that have been created by that backend
18980 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
18981 function is generally only called when Gnus is shutting down.
18982
18983 There should be no data returned.
18984
18985
18986 @item (nnchoke-server-opened &optional SERVER)
18987
18988 If @var{server} is the current virtual server, and the connection to the
18989 physical server is alive, then this function should return a
18990 non-@code{nil} vlue.  This function should under no circumstances
18991 attempt to reconnect to a server we have lost connection to.
18992
18993 There should be no data returned.
18994
18995
18996 @item (nnchoke-status-message &optional SERVER)
18997
18998 This function should return the last error message from @var{server}.
18999
19000 There should be no data returned.
19001
19002
19003 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19004
19005 The result data from this function should be the article specified by
19006 @var{article}.  This might either be a @code{Message-ID} or a number.
19007 It is optional whether to implement retrieval by @code{Message-ID}, but
19008 it would be nice if that were possible.
19009
19010 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19011 in this buffer instead of the normal data buffer.  This is to make it
19012 possible to avoid copying large amounts of data from one buffer to
19013 another, while Gnus mainly requests articles to be inserted directly
19014 into its article buffer.
19015
19016 If it is at all possible, this function should return a cons cell where
19017 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19018 the article number.  This will enable Gnus to find out what the real
19019 group and article numbers are when fetching articles by
19020 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
19021 on successful article retrieval.
19022
19023
19024 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19025
19026 Get data on @var{group}.  This function also has the side effect of
19027 making @var{group} the current group.
19028
19029 If @var{FAST}, don't bother to return useful data, just make @var{group}
19030 the current group.
19031
19032 Here's an example of some result data and a definition of the same:
19033
19034 @example
19035 211 56 1000 1059 ifi.discussion
19036 @end example
19037
19038 The first number is the status, which should be 211.  Next is the
19039 total number of articles in the group, the lowest article number, the
19040 highest article number, and finally the group name.  Note that the total
19041 number of articles may be less than one might think while just
19042 considering the highest and lowest article numbers, but some articles
19043 may have been canceled.  Gnus just discards the total-number, so
19044 whether one should take the bother to generate it properly (if that is a
19045 problem) is left as an exercise to the reader.
19046
19047 @example
19048 group-status = [ error / info ] eol
19049 error        = [ "4" / "5" ] 2<number> " " <Error message>
19050 info         = "211 " 3* [ <number> " " ] <string>
19051 @end example
19052
19053
19054 @item (nnchoke-close-group GROUP &optional SERVER)
19055
19056 Close @var{group} and free any resources connected to it.  This will be
19057 a no-op on most backends.
19058
19059 There should be no data returned.
19060
19061
19062 @item (nnchoke-request-list &optional SERVER)
19063
19064 Return a list of all groups available on @var{server}.  And that means
19065 @emph{all}.
19066
19067 Here's an example from a server that only carries two groups:
19068
19069 @example
19070 ifi.test 0000002200 0000002000 y
19071 ifi.discussion 3324 3300 n
19072 @end example
19073
19074 On each line we have a group name, then the highest article number in
19075 that group, the lowest article number, and finally a flag.
19076
19077 @example
19078 active-file = *active-line
19079 active-line = name " " <number> " " <number> " " flags eol
19080 name        = <string>
19081 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
19082 @end example
19083
19084 The flag says whether the group is read-only (@samp{n}), is moderated
19085 (@samp{m}), is dead (@samp{x}), is aliased to some other group
19086 (@samp{=other-group}) or none of the above (@samp{y}).
19087
19088
19089 @item (nnchoke-request-post &optional SERVER)
19090
19091 This function should post the current buffer.  It might return whether
19092 the posting was successful or not, but that's not required.  If, for
19093 instance, the posting is done asynchronously, it has generally not been
19094 completed by the time this function concludes.  In that case, this
19095 function should set up some kind of sentinel to beep the user loud and
19096 clear if the posting could not be completed.
19097
19098 There should be no result data from this function.
19099
19100 @end table
19101
19102
19103 @node Optional Backend Functions
19104 @subsubsection Optional Backend Functions
19105
19106 @table @code
19107
19108 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
19109
19110 @var{groups} is a list of groups, and this function should request data
19111 on all those groups.  How it does it is of no concern to Gnus, but it
19112 should attempt to do this in a speedy fashion.
19113
19114 The return value of this function can be either @code{active} or
19115 @code{group}, which says what the format of the result data is.  The
19116 former is in the same format as the data from
19117 @code{nnchoke-request-list}, while the latter is a buffer full of lines
19118 in the same format as @code{nnchoke-request-group} gives.
19119
19120 @example
19121 group-buffer = *active-line / *group-status
19122 @end example
19123
19124
19125 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
19126
19127 A Gnus group info (@pxref{Group Info}) is handed to the backend for
19128 alterations.  This comes in handy if the backend really carries all the
19129 information (as is the case with virtual and imap groups).  This
19130 function should destructively alter the info to suit its needs, and
19131 should return the (altered) group info.
19132
19133 There should be no result data from this function.
19134
19135
19136 @item (nnchoke-request-type GROUP &optional ARTICLE)
19137
19138 When the user issues commands for ``sending news'' (@kbd{F} in the
19139 summary buffer, for instance), Gnus has to know whether the article the
19140 user is following up on is news or mail.  This function should return
19141 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
19142 is mail and @code{unknown} if the type can't be decided.  (The
19143 @var{article} parameter is necessary in @code{nnvirtual} groups which
19144 might very well combine mail groups and news groups.)  Both @var{group}
19145 and @var{article} may be @code{nil}.
19146
19147 There should be no result data from this function.
19148
19149
19150 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
19151
19152 If the user tries to set a mark that the backend doesn't like, this
19153 function may change the mark.  Gnus will use whatever this function
19154 returns as the mark for @var{article} instead of the original
19155 @var{mark}.  If the backend doesn't care, it must return the original
19156 @var{mark}, and not @code{nil} or any other type of garbage.
19157
19158 The only use for this I can see is what @code{nnvirtual} does with
19159 it---if a component group is auto-expirable, marking an article as read
19160 in the virtual group should result in the article being marked as
19161 expirable.
19162
19163 There should be no result data from this function.
19164
19165
19166 @item (nnchoke-request-scan &optional GROUP SERVER)
19167
19168 This function may be called at any time (by Gnus or anything else) to
19169 request that the backend check for incoming articles, in one way or
19170 another.  A mail backend will typically read the spool file or query the
19171 POP server when this function is invoked.  The @var{group} doesn't have
19172 to be heeded---if the backend decides that it is too much work just
19173 scanning for a single group, it may do a total scan of all groups.  It
19174 would be nice, however, to keep things local if that's practical.
19175
19176 There should be no result data from this function.
19177
19178
19179 @item (nnchoke-request-group-description GROUP &optional SERVER)
19180
19181 The result data from this function should be a description of
19182 @var{group}.
19183
19184 @example
19185 description-line = name <TAB> description eol
19186 name             = <string>
19187 description      = <text>
19188 @end example
19189
19190 @item (nnchoke-request-list-newsgroups &optional SERVER)
19191
19192 The result data from this function should be the description of all
19193 groups available on the server.
19194
19195 @example
19196 description-buffer = *description-line
19197 @end example
19198
19199
19200 @item (nnchoke-request-newgroups DATE &optional SERVER)
19201
19202 The result data from this function should be all groups that were
19203 created after @samp{date}, which is in normal human-readable date
19204 format.  The data should be in the active buffer format.
19205
19206
19207 @item (nnchoke-request-create-group GROUP &optional SERVER)
19208
19209 This function should create an empty group with name @var{group}.
19210
19211 There should be no return data.
19212
19213
19214 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
19215
19216 This function should run the expiry process on all articles in the
19217 @var{articles} range (which is currently a simple list of article
19218 numbers.)  It is left up to the backend to decide how old articles
19219 should be before they are removed by this function.  If @var{force} is
19220 non-@code{nil}, all @var{articles} should be deleted, no matter how new
19221 they are.
19222
19223 This function should return a list of articles that it did not/was not
19224 able to delete.
19225
19226 There should be no result data returned.
19227
19228
19229 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
19230 &optional LAST)
19231
19232 This function should move @var{article} (which is a number) from
19233 @var{group} by calling @var{accept-form}.
19234
19235 This function should ready the article in question for moving by
19236 removing any header lines it has added to the article, and generally
19237 should ``tidy up'' the article.  Then it should @code{eval}
19238 @var{accept-form} in the buffer where the ``tidy'' article is.  This
19239 will do the actual copying.  If this @code{eval} returns a
19240 non-@code{nil} value, the article should be removed.
19241
19242 If @var{last} is @code{nil}, that means that there is a high likelihood
19243 that there will be more requests issued shortly, so that allows some
19244 optimizations.
19245
19246 The function should return a cons where the @code{car} is the group name and
19247 the @code{cdr} is the article number that the article was entered as.
19248
19249 There should be no data returned.
19250
19251
19252 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
19253
19254 This function takes the current buffer and inserts it into @var{group}.
19255 If @var{last} in @code{nil}, that means that there will be more calls to
19256 this function in short order.
19257
19258 The function should return a cons where the @code{car} is the group name and
19259 the @code{cdr} is the article number that the article was entered as.
19260
19261 There should be no data returned.
19262
19263
19264 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
19265
19266 This function should remove @var{article} (which is a number) from
19267 @var{group} and insert @var{buffer} there instead.
19268
19269 There should be no data returned.
19270
19271
19272 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
19273
19274 This function should delete @var{group}.  If @var{force}, it should
19275 really delete all the articles in the group, and then delete the group
19276 itself.  (If there is such a thing as ``the group itself''.)
19277
19278 There should be no data returned.
19279
19280
19281 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
19282
19283 This function should rename @var{group} into @var{new-name}.  All
19284 articles in @var{group} should move to @var{new-name}.
19285
19286 There should be no data returned.
19287
19288 @end table
19289
19290
19291 @node Error Messaging
19292 @subsubsection Error Messaging
19293
19294 @findex nnheader-report
19295 @findex nnheader-get-report
19296 The backends should use the function @code{nnheader-report} to report
19297 error conditions---they should not raise errors when they aren't able to
19298 perform a request.  The first argument to this function is the backend
19299 symbol, and the rest are interpreted as arguments to @code{format} if
19300 there are multiple of them, or just a string if there is one of them.
19301 This function must always returns @code{nil}.
19302
19303 @lisp
19304 (nnheader-report 'nnchoke "You did something totally bogus")
19305
19306 (nnheader-report 'nnchoke "Could not request group %s" group)
19307 @end lisp
19308
19309 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
19310 @code{nil} back from a server, and this function returns the most
19311 recently reported message for the backend in question.  This function
19312 takes one argument---the server symbol.
19313
19314 Internally, these functions access @var{backend}@code{-status-string},
19315 so the @code{nnchoke} backend will have its error message stored in
19316 @code{nnchoke-status-string}.
19317
19318
19319 @node Writing New Backends
19320 @subsubsection Writing New Backends
19321
19322 Many backends are quite similar.  @code{nnml} is just like
19323 @code{nnspool}, but it allows you to edit the articles on the server.
19324 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
19325 and it doesn't maintain overview databases.  @code{nndir} is just like
19326 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
19327 editing articles.
19328
19329 It would make sense if it were possible to ``inherit'' functions from
19330 backends when writing new backends.  And, indeed, you can do that if you
19331 want to.  (You don't have to if you don't want to, of course.)
19332
19333 All the backends declare their public variables and functions by using a
19334 package called @code{nnoo}.
19335
19336 To inherit functions from other backends (and allow other backends to
19337 inherit functions from the current backend), you should use the
19338 following macros:
19339
19340 @table @code
19341
19342 @item nnoo-declare
19343 This macro declares the first parameter to be a child of the subsequent
19344 parameters.  For instance:
19345
19346 @lisp
19347 (nnoo-declare nndir
19348   nnml nnmh)
19349 @end lisp
19350
19351 @code{nndir} has declared here that it intends to inherit functions from
19352 both @code{nnml} and @code{nnmh}.
19353
19354 @item defvoo
19355 This macro is equivalent to @code{defvar}, but registers the variable as
19356 a public server variable.  Most state-oriented variables should be
19357 declared with @code{defvoo} instead of @code{defvar}.
19358
19359 In addition to the normal @code{defvar} parameters, it takes a list of
19360 variables in the parent backends to map the variable to when executing
19361 a function in those backends.
19362
19363 @lisp
19364 (defvoo nndir-directory nil
19365   "Where nndir will look for groups."
19366   nnml-current-directory nnmh-current-directory)
19367 @end lisp
19368
19369 This means that @code{nnml-current-directory} will be set to
19370 @code{nndir-directory} when an @code{nnml} function is called on behalf
19371 of @code{nndir}.  (The same with @code{nnmh}.)
19372
19373 @item nnoo-define-basics
19374 This macro defines some common functions that almost all backends should
19375 have.
19376
19377 @example
19378 (nnoo-define-basics nndir)
19379 @end example
19380
19381 @item deffoo
19382 This macro is just like @code{defun} and takes the same parameters.  In
19383 addition to doing the normal @code{defun} things, it registers the
19384 function as being public so that other backends can inherit it.
19385
19386 @item nnoo-map-functions
19387 This macro allows mapping of functions from the current backend to
19388 functions from the parent backends.
19389
19390 @example
19391 (nnoo-map-functions nndir
19392   (nnml-retrieve-headers 0 nndir-current-group 0 0)
19393   (nnmh-request-article 0 nndir-current-group 0 0))
19394 @end example
19395
19396 This means that when @code{nndir-retrieve-headers} is called, the first,
19397 third, and fourth parameters will be passed on to
19398 @code{nnml-retrieve-headers}, while the second parameter is set to the
19399 value of @code{nndir-current-group}.
19400
19401 @item nnoo-import
19402 This macro allows importing functions from backends.  It should be the
19403 last thing in the source file, since it will only define functions that
19404 haven't already been defined.
19405
19406 @example
19407 (nnoo-import nndir
19408   (nnmh
19409    nnmh-request-list
19410    nnmh-request-newgroups)
19411   (nnml))
19412 @end example
19413
19414 This means that calls to @code{nndir-request-list} should just be passed
19415 on to @code{nnmh-request-list}, while all public functions from
19416 @code{nnml} that haven't been defined in @code{nndir} yet should be
19417 defined now.
19418
19419 @end table
19420
19421 Below is a slightly shortened version of the @code{nndir} backend.
19422
19423 @lisp
19424 ;;; nndir.el --- single directory newsgroup access for Gnus
19425 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
19426
19427 ;;; Code:
19428
19429 (require 'nnheader)
19430 (require 'nnmh)
19431 (require 'nnml)
19432 (require 'nnoo)
19433 (eval-when-compile (require 'cl))
19434
19435 (nnoo-declare nndir
19436   nnml nnmh)
19437
19438 (defvoo nndir-directory nil
19439   "Where nndir will look for groups."
19440   nnml-current-directory nnmh-current-directory)
19441
19442 (defvoo nndir-nov-is-evil nil
19443   "*Non-nil means that nndir will never retrieve NOV headers."
19444   nnml-nov-is-evil)
19445
19446 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
19447 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
19448 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
19449
19450 (defvoo nndir-status-string "" nil nnmh-status-string)
19451 (defconst nndir-version "nndir 1.0")
19452
19453 ;;; Interface functions.
19454
19455 (nnoo-define-basics nndir)
19456
19457 (deffoo nndir-open-server (server &optional defs)
19458   (setq nndir-directory
19459         (or (cadr (assq 'nndir-directory defs))
19460             server))
19461   (unless (assq 'nndir-directory defs)
19462     (push `(nndir-directory ,server) defs))
19463   (push `(nndir-current-group
19464           ,(file-name-nondirectory (directory-file-name nndir-directory)))
19465         defs)
19466   (push `(nndir-top-directory
19467           ,(file-name-directory (directory-file-name nndir-directory)))
19468         defs)
19469   (nnoo-change-server 'nndir server defs))
19470
19471 (nnoo-map-functions nndir
19472   (nnml-retrieve-headers 0 nndir-current-group 0 0)
19473   (nnmh-request-article 0 nndir-current-group 0 0)
19474   (nnmh-request-group nndir-current-group 0 0)
19475   (nnmh-close-group nndir-current-group 0))
19476
19477 (nnoo-import nndir
19478   (nnmh
19479    nnmh-status-message
19480    nnmh-request-list
19481    nnmh-request-newgroups))
19482
19483 (provide 'nndir)
19484 @end lisp
19485
19486
19487 @node Hooking New Backends Into Gnus
19488 @subsubsection Hooking New Backends Into Gnus
19489
19490 @vindex gnus-valid-select-methods
19491 Having Gnus start using your new backend is rather easy---you just
19492 declare it with the @code{gnus-declare-backend} functions.  This will
19493 enter the backend into the @code{gnus-valid-select-methods} variable.
19494
19495 @code{gnus-declare-backend} takes two parameters---the backend name and
19496 an arbitrary number of @dfn{abilities}.
19497
19498 Here's an example:
19499
19500 @lisp
19501 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
19502 @end lisp
19503
19504 The abilities can be:
19505
19506 @table @code
19507 @item mail
19508 This is a mailish backend---followups should (probably) go via mail.
19509 @item post
19510 This is a newsish backend---followups should (probably) go via news.
19511 @item post-mail
19512 This backend supports both mail and news.
19513 @item none
19514 This is neither a post nor mail backend---it's something completely
19515 different.
19516 @item respool
19517 It supports respooling---or rather, it is able to modify its source
19518 articles and groups.
19519 @item address
19520 The name of the server should be in the virtual server name.  This is
19521 true for almost all backends.
19522 @item prompt-address
19523 The user should be prompted for an address when doing commands like
19524 @kbd{B} in the group buffer.  This is true for backends like
19525 @code{nntp}, but not @code{nnmbox}, for instance.
19526 @end table
19527
19528
19529 @node Mail-like Backends
19530 @subsubsection Mail-like Backends
19531
19532 One of the things that separate the mail backends from the rest of the
19533 backends is the heavy dependence by the mail backends on common
19534 functions in @file{nnmail.el}.  For instance, here's the definition of
19535 @code{nnml-request-scan}:
19536
19537 @lisp
19538 (deffoo nnml-request-scan (&optional group server)
19539   (setq nnml-article-file-alist nil)
19540   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
19541 @end lisp
19542
19543 It simply calls @code{nnmail-get-new-mail} with a few parameters,
19544 and @code{nnmail} takes care of all the moving and splitting of the
19545 mail.
19546
19547 This function takes four parameters.
19548
19549 @table @var
19550 @item method
19551 This should be a symbol to designate which backend is responsible for
19552 the call.
19553
19554 @item exit-function
19555 This function should be called after the splitting has been performed.
19556
19557 @item temp-directory
19558 Where the temporary files should be stored.
19559
19560 @item group
19561 This optional argument should be a group name if the splitting is to be
19562 performed for one group only.
19563 @end table
19564
19565 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
19566 save each article.  @var{backend}@code{-active-number} will be called to
19567 find the article number assigned to this article.
19568
19569 The function also uses the following variables:
19570 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
19571 this backend); and @var{backend}@code{-group-alist} and
19572 @var{backend}@code{-active-file} to generate the new active file.
19573 @var{backend}@code{-group-alist} should be a group-active alist, like
19574 this:
19575
19576 @example
19577 (("a-group" (1 . 10))
19578  ("some-group" (34 . 39)))
19579 @end example
19580
19581
19582 @node Score File Syntax
19583 @subsection Score File Syntax
19584
19585 Score files are meant to be easily parseable, but yet extremely
19586 mallable.   It was decided that something that had the same read syntax
19587 as an Emacs Lisp list would fit that spec.
19588
19589 Here's a typical score file:
19590
19591 @lisp
19592 (("summary"
19593   ("win95" -10000 nil s)
19594   ("Gnus"))
19595  ("from"
19596   ("Lars" -1000))
19597  (mark -100))
19598 @end lisp
19599
19600 BNF definition of a score file:
19601
19602 @example
19603 score-file       = "" / "(" *element ")"
19604 element          = rule / atom
19605 rule             = string-rule / number-rule / date-rule
19606 string-rule      = "(" quote string-header quote space *string-match ")"
19607 number-rule      = "(" quote number-header quote space *number-match ")"
19608 date-rule        = "(" quote date-header quote space *date-match ")"
19609 quote            = <ascii 34>
19610 string-header    = "subject" / "from" / "references" / "message-id" /
19611                    "xref" / "body" / "head" / "all" / "followup"
19612 number-header    = "lines" / "chars"
19613 date-header      = "date"
19614 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
19615                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
19616 score            = "nil" / <integer>
19617 date             = "nil" / <natural number>
19618 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
19619                    "r" / "regex" / "R" / "Regex" /
19620                    "e" / "exact" / "E" / "Exact" /
19621                    "f" / "fuzzy" / "F" / "Fuzzy"
19622 number-match     = "(" <integer> [ "" / [ space score [ "" /
19623                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
19624 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
19625 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
19626                    space date [ "" / [ space date-match-t ] ] ] ] ")"
19627 date-match-t     = "nil" / "at" / "before" / "after"
19628 atom             = "(" [ required-atom / optional-atom ] ")"
19629 required-atom    = mark / expunge / mark-and-expunge / files /
19630                    exclude-files / read-only / touched
19631 optional-atom    = adapt / local / eval
19632 mark             = "mark" space nil-or-number
19633 nil-or-number    = "nil" / <integer>
19634 expunge          = "expunge" space nil-or-number
19635 mark-and-expunge = "mark-and-expunge" space nil-or-number
19636 files            = "files" *[ space <string> ]
19637 exclude-files    = "exclude-files" *[ space <string> ]
19638 read-only        = "read-only" [ space "nil" / space "t" ]
19639 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
19640 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
19641 local            = "local" *[ space "(" <string> space <form> ")" ]
19642 eval             = "eval" space <form>
19643 space            = *[ " " / <TAB> / <NEWLINE> ]
19644 @end example
19645
19646 Any unrecognized elements in a score file should be ignored, but not
19647 discarded.
19648
19649 As you can see, white space is needed, but the type and amount of white
19650 space is irrelevant.  This means that formatting of the score file is
19651 left up to the programmer---if it's simpler to just spew it all out on
19652 one looong line, then that's ok.
19653
19654 The meaning of the various atoms are explained elsewhere in this
19655 manual (@pxref{Score File Format}).
19656
19657
19658 @node Headers
19659 @subsection Headers
19660
19661 Internally Gnus uses a format for storing article headers that
19662 corresponds to the @sc{nov} format in a mysterious fashion.  One could
19663 almost suspect that the author looked at the @sc{nov} specification and
19664 just shamelessly @emph{stole} the entire thing, and one would be right.
19665
19666 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
19667 RFC1036 to talk about lines in the head of an article (e.g.,
19668 @code{From}).  It is used by many people as a synonym for
19669 ``head''---``the header and the body''.  (That should be avoided, in my
19670 opinion.)  And Gnus uses a format internally that it calls ``header'',
19671 which is what I'm talking about here.  This is a 9-element vector,
19672 basically, with each header (ouch) having one slot.
19673
19674 These slots are, in order: @code{number}, @code{subject}, @code{from},
19675 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
19676 @code{xref}.  There are macros for accessing and setting these
19677 slots---they all have predictable names beginning with
19678 @code{mail-header-} and @code{mail-header-set-}, respectively.
19679
19680 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
19681 be put in there.
19682
19683
19684 @node Ranges
19685 @subsection Ranges
19686
19687 @sc{gnus} introduced a concept that I found so useful that I've started
19688 using it a lot and have elaborated on it greatly.
19689
19690 The question is simple: If you have a large amount of objects that are
19691 identified by numbers (say, articles, to take a @emph{wild} example)
19692 that you want to qualify as being ``included'', a normal sequence isn't
19693 very useful.  (A 200,000 length sequence is a bit long-winded.)
19694
19695 The solution is as simple as the question: You just collapse the
19696 sequence.
19697
19698 @example
19699 (1 2 3 4 5 6 10 11 12)
19700 @end example
19701
19702 is transformed into
19703
19704 @example
19705 ((1 . 6) (10 . 12))
19706 @end example
19707
19708 To avoid having those nasty @samp{(13 . 13)} elements to denote a
19709 lonesome object, a @samp{13} is a valid element:
19710
19711 @example
19712 ((1 . 6) 7 (10 . 12))
19713 @end example
19714
19715 This means that comparing two ranges to find out whether they are equal
19716 is slightly tricky:
19717
19718 @example
19719 ((1 . 5) 7 8 (10 . 12))
19720 @end example
19721
19722 and
19723
19724 @example
19725 ((1 . 5) (7 . 8) (10 . 12))
19726 @end example
19727
19728 are equal.  In fact, any non-descending list is a range:
19729
19730 @example
19731 (1 2 3 4 5)
19732 @end example
19733
19734 is a perfectly valid range, although a pretty long-winded one.  This is
19735 also valid:
19736
19737 @example
19738 (1 . 5)
19739 @end example
19740
19741 and is equal to the previous range.
19742
19743 Here's a BNF definition of ranges.  Of course, one must remember the
19744 semantic requirement that the numbers are non-descending.  (Any number
19745 of repetition of the same number is allowed, but apt to disappear in
19746 range handling.)
19747
19748 @example
19749 range           = simple-range / normal-range
19750 simple-range    = "(" number " . " number ")"
19751 normal-range    = "(" start-contents ")"
19752 contents        = "" / simple-range *[ " " contents ] /
19753                   number *[ " " contents ]
19754 @end example
19755
19756 Gnus currently uses ranges to keep track of read articles and article
19757 marks.  I plan on implementing a number of range operators in C if The
19758 Powers That Be are willing to let me.  (I haven't asked yet, because I
19759 need to do some more thinking on what operators I need to make life
19760 totally range-based without ever having to convert back to normal
19761 sequences.)
19762
19763
19764 @node Group Info
19765 @subsection Group Info
19766
19767 Gnus stores all permanent info on groups in a @dfn{group info} list.
19768 This list is from three to six elements (or more) long and exhaustively
19769 describes the group.
19770
19771 Here are two example group infos; one is a very simple group while the
19772 second is a more complex one:
19773
19774 @example
19775 ("no.group" 5 (1 . 54324))
19776
19777 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
19778                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
19779                 (nnml "")
19780                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
19781 @end example
19782
19783 The first element is the @dfn{group name}---as Gnus knows the group,
19784 anyway.  The second element is the @dfn{subscription level}, which
19785 normally is a small integer.  (It can also be the @dfn{rank}, which is a
19786 cons cell where the @code{car} is the level and the @code{cdr} is the
19787 score.)  The third element is a list of ranges of read articles.  The
19788 fourth element is a list of lists of article marks of various kinds.
19789 The fifth element is the select method (or virtual server, if you like).
19790 The sixth element is a list of @dfn{group parameters}, which is what
19791 this section is about.
19792
19793 Any of the last three elements may be missing if they are not required.
19794 In fact, the vast majority of groups will normally only have the first
19795 three elements, which saves quite a lot of cons cells.
19796
19797 Here's a BNF definition of the group info format:
19798
19799 @example
19800 info          = "(" group space ralevel space read
19801                 [ "" / [ space marks-list [ "" / [ space method [ "" /
19802                 space parameters ] ] ] ] ] ")"
19803 group         = quote <string> quote
19804 ralevel       = rank / level
19805 level         = <integer in the range of 1 to inf>
19806 rank          = "(" level "." score ")"
19807 score         = <integer in the range of 1 to inf>
19808 read          = range
19809 marks-lists   = nil / "(" *marks ")"
19810 marks         = "(" <string> range ")"
19811 method        = "(" <string> *elisp-forms ")"
19812 parameters    = "(" *elisp-forms ")"
19813 @end example
19814
19815 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
19816 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
19817 in pseudo-BNF.
19818
19819 If you have a Gnus info and want to access the elements, Gnus offers a
19820 series of macros for getting/setting these elements.
19821
19822 @table @code
19823 @item gnus-info-group
19824 @itemx gnus-info-set-group
19825 @findex gnus-info-group
19826 @findex gnus-info-set-group
19827 Get/set the group name.
19828
19829 @item gnus-info-rank
19830 @itemx gnus-info-set-rank
19831 @findex gnus-info-rank
19832 @findex gnus-info-set-rank
19833 Get/set the group rank (@pxref{Group Score}).
19834
19835 @item gnus-info-level
19836 @itemx gnus-info-set-level
19837 @findex gnus-info-level
19838 @findex gnus-info-set-level
19839 Get/set the group level.
19840
19841 @item gnus-info-score
19842 @itemx gnus-info-set-score
19843 @findex gnus-info-score
19844 @findex gnus-info-set-score
19845 Get/set the group score (@pxref{Group Score}).
19846
19847 @item gnus-info-read
19848 @itemx gnus-info-set-read
19849 @findex gnus-info-read
19850 @findex gnus-info-set-read
19851 Get/set the ranges of read articles.
19852
19853 @item gnus-info-marks
19854 @itemx gnus-info-set-marks
19855 @findex gnus-info-marks
19856 @findex gnus-info-set-marks
19857 Get/set the lists of ranges of marked articles.
19858
19859 @item gnus-info-method
19860 @itemx gnus-info-set-method
19861 @findex gnus-info-method
19862 @findex gnus-info-set-method
19863 Get/set the group select method.
19864
19865 @item gnus-info-params
19866 @itemx gnus-info-set-params
19867 @findex gnus-info-params
19868 @findex gnus-info-set-params
19869 Get/set the group parameters.
19870 @end table
19871
19872 All the getter functions take one parameter---the info list.  The setter
19873 functions take two parameters---the info list and the new value.
19874
19875 The last three elements in the group info aren't mandatory, so it may be
19876 necessary to extend the group info before setting the element.  If this
19877 is necessary, you can just pass on a non-@code{nil} third parameter to
19878 the three final setter functions to have this happen automatically.
19879
19880
19881 @node Extended Interactive
19882 @subsection Extended Interactive
19883 @cindex interactive
19884 @findex gnus-interactive
19885
19886 Gnus extends the standard Emacs @code{interactive} specification
19887 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
19888 Prefixes}).  Here's an example of how this is used:
19889
19890 @lisp
19891 (defun gnus-summary-increase-score (&optional score symp)
19892   (interactive (gnus-interactive "P\ny"))
19893   ...
19894   )
19895 @end lisp
19896
19897 The best thing to do would have been to implement
19898 @code{gnus-interactive} as a macro which would have returned an
19899 @code{interactive} form, but this isn't possible since Emacs checks
19900 whether a function is interactive or not by simply doing an @code{assq}
19901 on the lambda form.  So, instead we have @code{gnus-interactive}
19902 function that takes a string and returns values that are usable to
19903 @code{interactive}.
19904
19905 This function accepts (almost) all normal @code{interactive} specs, but
19906 adds a few more.
19907
19908 @table @samp
19909 @item y
19910 @vindex gnus-current-prefix-symbol
19911 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
19912 variable.
19913
19914 @item Y
19915 @vindex gnus-current-prefix-symbols
19916 A list of the current symbolic prefixes---the
19917 @code{gnus-current-prefix-symbol} variable.
19918
19919 @item A
19920 The current article number---the @code{gnus-summary-article-number}
19921 function.
19922
19923 @item H
19924 The current article header---the @code{gnus-summary-article-header}
19925 function.
19926
19927 @item g
19928 The current group name---the @code{gnus-group-group-name}
19929 function.
19930
19931 @end table
19932
19933
19934 @node Emacs/XEmacs Code
19935 @subsection Emacs/XEmacs Code
19936 @cindex XEmacs
19937 @cindex Emacsen
19938
19939 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
19940 platforms must be the primary one.  I chose Emacs.  Not because I don't
19941 like XEmacs or Mule, but because it comes first alphabetically.
19942
19943 This means that Gnus will byte-compile under Emacs with nary a warning,
19944 while XEmacs will pump out gigabytes of warnings while byte-compiling.
19945 As I use byte-compilation warnings to help me root out trivial errors in
19946 Gnus, that's very useful.
19947
19948 I've also consistently used Emacs function interfaces, but have used
19949 Gnusey aliases for the functions.  To take an example:  Emacs defines a
19950 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
19951 function.  I then define a function called @code{gnus-run-at-time} that
19952 takes the same parameters as the Emacs @code{run-at-time}.  When running
19953 Gnus under Emacs, the former function is just an alias for the latter.
19954 However, when running under XEmacs, the former is an alias for the
19955 following function:
19956
19957 @lisp
19958 (defun gnus-xmas-run-at-time (time repeat function &rest args)
19959   (start-itimer
19960    "gnus-run-at-time"
19961    `(lambda ()
19962       (,function ,@@args))
19963    time repeat))
19964 @end lisp
19965
19966 This sort of thing has been done for bunches of functions.  Gnus does
19967 not redefine any native Emacs functions while running under XEmacs---it
19968 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
19969 all over.
19970
19971 In the cases where the XEmacs function interface was obviously cleaner,
19972 I used it instead.  For example @code{gnus-region-active-p} is an alias
19973 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
19974
19975 Of course, I could have chosen XEmacs as my native platform and done
19976 mapping functions the other way around.  But I didn't.  The performance
19977 hit these indirections impose on Gnus under XEmacs should be slight.
19978
19979
19980 @node Various File Formats
19981 @subsection Various File Formats
19982
19983 @menu
19984 * Active File Format::      Information on articles and groups available.
19985 * Newsgroups File Format::  Group descriptions.
19986 @end menu
19987
19988
19989 @node Active File Format
19990 @subsubsection Active File Format
19991
19992 The active file lists all groups available on the server in
19993 question.  It also lists the highest and lowest current article numbers
19994 in each group.
19995
19996 Here's an excerpt from a typical active file:
19997
19998 @example
19999 soc.motss 296030 293865 y
20000 alt.binaries.pictures.fractals 3922 3913 n
20001 comp.sources.unix 1605 1593 m
20002 comp.binaries.ibm.pc 5097 5089 y
20003 no.general 1000 900 y
20004 @end example
20005
20006 Here's a pseudo-BNF definition of this file:
20007
20008 @example
20009 active      = *group-line
20010 group-line  = group space high-number space low-number space flag <NEWLINE>
20011 group       = <non-white-space string>
20012 space       = " "
20013 high-number = <non-negative integer>
20014 low-number  = <positive integer>
20015 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
20016 @end example
20017
20018 For a full description of this file, see the manual pages for
20019 @samp{innd}, in particular @samp{active(5)}.
20020
20021
20022 @node Newsgroups File Format
20023 @subsubsection Newsgroups File Format
20024
20025 The newsgroups file lists groups along with their descriptions.  Not all
20026 groups on the server have to be listed,  and not all groups in the file
20027 have to exist on the server.  The file is meant purely as information to
20028 the user.
20029
20030 The format is quite simple; a group name, a tab, and the description.
20031 Here's the definition:
20032
20033 @example
20034 newsgroups    = *line
20035 line          = group tab description <NEWLINE>
20036 group         = <non-white-space string>
20037 tab           = <TAB>
20038 description   = <string>
20039 @end example
20040
20041
20042 @page
20043 @node Emacs for Heathens
20044 @section Emacs for Heathens
20045
20046 Believe it or not, but some people who use Gnus haven't really used
20047 Emacs much before they embarked on their journey on the Gnus Love Boat.
20048 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
20049 region'', and ``set @code{gnus-flargblossen} to an alist where the key
20050 is a regexp that is used for matching on the group name'' are magical
20051 phrases with little or no meaning, then this appendix is for you.  If
20052 you are already familiar with Emacs, just ignore this and go fondle your
20053 cat instead.
20054
20055 @menu
20056 * Keystrokes::      Entering text and executing commands.
20057 * Emacs Lisp::      The built-in Emacs programming language.
20058 @end menu
20059
20060
20061 @node Keystrokes
20062 @subsection Keystrokes
20063
20064 @itemize @bullet
20065 @item
20066 Q: What is an experienced Emacs user?
20067
20068 @item
20069 A: A person who wishes that the terminal had pedals.
20070 @end itemize
20071
20072 Yes, when you use Emacs, you are apt to use the control key, the shift
20073 key and the meta key a lot.  This is very annoying to some people
20074 (notably @code{vi}le users), and the rest of us just love the hell out
20075 of it.  Just give up and submit.  Emacs really does stand for
20076 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
20077 may have heard from other disreputable sources (like the Emacs author).
20078
20079 The shift keys are normally located near your pinky fingers, and are
20080 normally used to get capital letters and stuff.  You probably use it all
20081 the time.  The control key is normally marked ``CTRL'' or something like
20082 that.  The meta key is, funnily enough, never marked as such on any
20083 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
20084 which is the meta key on this keyboard.  It's usually located somewhere
20085 to the left hand side of the keyboard, usually on the bottom row.
20086
20087 Now, us Emacs people don't say ``press the meta-control-m key'',
20088 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
20089 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
20090 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
20091 down the control key, and hold it down while you press @kbd{k}''.
20092 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
20093 the control key and then press @kbd{k}''.  Simple, ay?
20094
20095 This is somewhat complicated by the fact that not all keyboards have a
20096 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
20097 means ``press escape, release escape, press @kbd{k}''.  That's much more
20098 work than if you have a meta key, so if that's the case, I respectfully
20099 suggest you get a real keyboard with a meta key.  You can't live without
20100 it.
20101
20102
20103
20104 @node Emacs Lisp
20105 @subsection Emacs Lisp
20106
20107 Emacs is the King of Editors because it's really a Lisp interpreter.
20108 Each and every key you tap runs some Emacs Lisp code snippet, and since
20109 Emacs Lisp is an interpreted language, that means that you can configure
20110 any key to run any arbitrary code.  You just, like, do it.
20111
20112 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
20113 functions.  (These are byte-compiled for speed, but it's still
20114 interpreted.)  If you decide that you don't like the way Gnus does
20115 certain things, it's trivial to have it do something a different way.
20116 (Well, at least if you know how to write Lisp code.)  However, that's
20117 beyond the scope of this manual, so we are simply going to talk about
20118 some common constructs that you normally use in your @file{.emacs} file
20119 to customize Gnus.
20120
20121 If you want to set the variable @code{gnus-florgbnize} to four (4), you
20122 write the following:
20123
20124 @lisp
20125 (setq gnus-florgbnize 4)
20126 @end lisp
20127
20128 This function (really ``special form'') @code{setq} is the one that can
20129 set a variable to some value.  This is really all you need to know.  Now
20130 you can go and fill your @code{.emacs} file with lots of these to change
20131 how Gnus works.
20132
20133 If you have put that thing in your @code{.emacs} file, it will be read
20134 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
20135 start Emacs.  If you want to change the variable right away, simply say
20136 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
20137 previous ``form'', which is a simple @code{setq} statement here.
20138
20139 Go ahead---just try it, if you're located at your Emacs.  After you
20140 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
20141 is the return value of the form you @code{eval}ed.
20142
20143 Some pitfalls:
20144
20145 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
20146 that means:
20147
20148 @lisp
20149 (setq gnus-read-active-file 'some)
20150 @end lisp
20151
20152 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
20153 @samp{nntp.ifi.uio.no}'', that means:
20154
20155 @lisp
20156 (setq gnus-nntp-server "nntp.ifi.uio.no")
20157 @end lisp
20158
20159 So be careful not to mix up strings (the latter) with symbols (the
20160 former).  The manual is unambiguous, but it can be confusing.
20161
20162 @page
20163 @include gnus-faq.texi
20164
20165 @node Index
20166 @chapter Index
20167 @printindex cp
20168
20169 @node Key Index
20170 @chapter Key Index
20171 @printindex ky
20172
20173 @summarycontents
20174 @contents
20175 @bye
20176
20177 @iftex
20178 @iflatex
20179 \end{document}
20180 @end iflatex
20181 @end iftex
20182
20183 @c End:
20184