c2f6e28471035346d7b93f636a9cb0862acf2616
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Quassia Gnus 0.31 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @iftex
9 @finalout
10 @end iftex
11 @setchapternewpage odd
12
13 @iftex
14 @iflatex
15 \documentclass[twoside,a4paper,openright,11pt]{book}
16 \usepackage[latin1]{inputenc}
17 \usepackage{pagestyle}
18 \usepackage{epsfig}
19 \usepackage{bembo}
20 \usepackage{pixidx}
21
22 \makeindex
23 \begin{document}
24
25 \newcommand{\gnuschaptername}{}
26 \newcommand{\gnussectionname}{}
27
28 \newcommand{\gnusbackslash}{/}
29
30 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
31 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
32
33 \newcommand{\gnuskindex}[1]{\index{#1}}
34 \newcommand{\gnusindex}[1]{\index{#1}}
35
36 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
37 \newcommand{\gnuscode}[1]{\gnustt{#1}}
38 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
39 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
40 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
41 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
42 \newcommand{\gnusdfn}[1]{\textit{#1}}
43 \newcommand{\gnusi}[1]{\textit{#1}}
44 \newcommand{\gnusstrong}[1]{\textbf{#1}}
45 \newcommand{\gnusemph}[1]{\textit{#1}}
46 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
47 \newcommand{\gnussc}[1]{\textsc{#1}}
48 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
49 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
50
51 \newcommand{\gnusbullet}{{${\bullet}$}}
52 \newcommand{\gnusdollar}{\$}
53 \newcommand{\gnusampersand}{\&}
54 \newcommand{\gnuspercent}{\%}
55 \newcommand{\gnushash}{\#}
56 \newcommand{\gnushat}{\symbol{"5E}}
57 \newcommand{\gnusunderline}{\symbol{"5F}}
58 \newcommand{\gnusnot}{$\neg$}
59 \newcommand{\gnustilde}{\symbol{"7E}}
60 \newcommand{\gnusless}{{$<$}}
61 \newcommand{\gnusgreater}{{$>$}}
62
63 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
64 \newcommand{\gnusinteresting}{
65 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
66 }
67
68 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
69
70 \newcommand{\gnuspagechapter}[1]{
71 {\mbox{}}
72 }
73
74 \newdimen{\gnusdimen}
75 \gnusdimen 0pt
76
77 \newcommand{\gnuschapter}[2]{
78 \gnuscleardoublepage
79 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
80 \chapter{#2}
81 \renewcommand{\gnussectionname}{}
82 \renewcommand{\gnuschaptername}{#2}
83 \thispagestyle{empty}
84 \hspace*{-2cm}
85 \begin{picture}(500,500)(0,0)
86 \put(480,350){\makebox(0,0)[tr]{#1}}
87 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
88 \end{picture}
89 \clearpage
90 }
91
92 \newcommand{\gnusfigure}[3]{
93 \begin{figure}
94 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
95 #3
96 \end{picture}
97 \caption{#1}
98 \end{figure}
99 }
100
101 \newcommand{\gnusicon}[1]{
102 \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}}}
103 }
104
105 \newcommand{\gnuspicon}[1]{
106 \margindex{\epsfig{figure=#1,width=2cm}}
107 }
108
109 \newcommand{\gnusxface}[2]{
110 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
111 }
112
113 \newcommand{\gnussmiley}[2]{
114 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
115 }
116
117 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
118
119 \newcommand{\gnussection}[1]{
120 \renewcommand{\gnussectionname}{#1}
121 \section{#1}
122 }
123
124 \newenvironment{codelist}%
125 {\begin{list}{}{
126 }
127 }{\end{list}}
128
129 \newenvironment{kbdlist}%
130 {\begin{list}{}{
131 \labelwidth=0cm
132 }
133 }{\end{list}}
134
135 \newenvironment{dfnlist}%
136 {\begin{list}{}{
137 }
138 }{\end{list}}
139
140 \newenvironment{stronglist}%
141 {\begin{list}{}{
142 }
143 }{\end{list}}
144
145 \newenvironment{samplist}%
146 {\begin{list}{}{
147 }
148 }{\end{list}}
149
150 \newenvironment{varlist}%
151 {\begin{list}{}{
152 }
153 }{\end{list}}
154
155 \newenvironment{emphlist}%
156 {\begin{list}{}{
157 }
158 }{\end{list}}
159
160 \newlength\gnusheadtextwidth
161 \setlength{\gnusheadtextwidth}{\headtextwidth}
162 \addtolength{\gnusheadtextwidth}{1cm}
163
164 \newpagestyle{gnuspreamble}%
165 {
166 {
167 \ifodd\count0
168 {
169 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
170 }
171 \else
172 {
173 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
174 }
175 }
176 \fi
177 }
178 }
179 {
180 \ifodd\count0
181 \mbox{} \hfill 
182 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
183 \else
184 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
185 \hfill \mbox{}
186 \fi
187 }
188
189 \newpagestyle{gnusindex}%
190 {
191 {
192 \ifodd\count0
193 {
194 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
195 }
196 \else
197 {
198 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
199 }
200 \fi
201 }
202 }
203 {
204 \ifodd\count0
205 \mbox{} \hfill 
206 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
207 \else
208 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
209 \hfill \mbox{}
210 \fi
211 }
212
213 \newpagestyle{gnus}%
214 {
215 {
216 \ifodd\count0
217 {
218 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
219 }
220 \else
221 {
222 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
223 }
224 \fi
225 }
226 }
227 {
228 \ifodd\count0
229 \mbox{} \hfill 
230 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
231 \else
232 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
233 \hfill \mbox{}
234 \fi
235 }
236
237 \pagenumbering{roman}
238 \pagestyle{gnuspreamble}
239
240 @end iflatex
241 @end iftex
242
243 @iftex
244 @iflatex
245 \begin{titlepage}
246 {
247
248 %\addtolength{\oddsidemargin}{-5cm}
249 %\addtolength{\evensidemargin}{-5cm}
250 \parindent=0cm
251 \addtolength{\textheight}{2cm}
252
253 \gnustitle{\gnustitlename}\\
254 \rule{15cm}{1mm}\\
255 \vfill
256 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
257 \vfill
258 \rule{15cm}{1mm}\\
259 \gnusauthor{by Lars Magne Ingebrigtsen}
260 \newpage
261 }
262
263 \mbox{}
264 \vfill
265
266 \thispagestyle{empty}
267
268 Copyright \copyright{} 1995,96,97 Free Software Foundation, Inc. 
269
270 Permission is granted to make and distribute verbatim copies of
271 this manual provided the copyright notice and this permission notice
272 are preserved on all copies.
273
274 Permission is granted to copy and distribute modified versions of this
275 manual under the conditions for verbatim copying, provided that the
276 entire resulting derived work is distributed under the terms of a
277 permission notice identical to this one.
278
279 Permission is granted to copy and distribute translations of this manual
280 into another language, under the above conditions for modified versions.
281
282 \newpage
283 \end{titlepage}
284 @end iflatex
285 @end iftex
286
287 @ifinfo
288
289 This file documents Gnus, the GNU Emacs newsreader.
290
291 Copyright (C) 1995,96 Free Software Foundation, Inc.
292
293 Permission is granted to make and distribute verbatim copies of
294 this manual provided the copyright notice and this permission notice
295 are preserved on all copies.
296
297 @ignore
298 Permission is granted to process this file through Tex and print the
299 results, provided the printed document carries copying permission
300 notice identical to this one except for the removal of this paragraph
301 (this paragraph not being relevant to the printed manual).
302
303 @end ignore
304 Permission is granted to copy and distribute modified versions of this
305 manual under the conditions for verbatim copying, provided also that the
306 entire resulting derived work is distributed under the terms of a
307 permission notice identical to this one.
308
309 Permission is granted to copy and distribute translations of this manual
310 into another language, under the above conditions for modified versions.
311 @end ifinfo
312
313 @tex
314
315 @titlepage
316 @title Quassia Gnus 0.31 Manual
317
318 @author by Lars Magne Ingebrigtsen
319 @page
320
321 @vskip 0pt plus 1filll
322 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc. 
323
324 Permission is granted to make and distribute verbatim copies of
325 this manual provided the copyright notice and this permission notice
326 are preserved on all copies.
327
328 Permission is granted to copy and distribute modified versions of this
329 manual under the conditions for verbatim copying, provided that the
330 entire resulting derived work is distributed under the terms of a
331 permission notice identical to this one.
332
333 Permission is granted to copy and distribute translations of this manual
334 into another language, under the above conditions for modified versions.
335
336 @end titlepage
337 @page
338
339 @end tex
340
341
342 @node Top
343 @top The Gnus Newsreader
344
345 @ifinfo
346
347 You can read news (and mail) from within Emacs by using Gnus.  The news
348 can be gotten by any nefarious means you can think of---@sc{nntp}, local
349 spool or your mbox file.  All at the same time, if you want to push your
350 luck.
351
352 This manual corresponds to Quassia Gnus 0.31.
353
354 @end ifinfo
355
356 @iftex
357
358 @iflatex
359 \tableofcontents
360 \gnuscleardoublepage
361 @end iflatex
362
363 Gnus is the advanced, self-documenting, customizable, extensible
364 unreal-time newsreader for GNU Emacs.  
365
366 Oops.  That sounds oddly familiar, so let's start over again to avoid
367 being accused of plagiarism:
368
369 Gnus is a message-reading laboratory.  It will let you look at just
370 about anything as if it were a newsgroup.  You can read mail with it,
371 you can browse directories with it, you can @code{ftp} with it---you can
372 even read news with it!
373
374 Gnus tries to empower people who read news the same way Emacs empowers
375 people who edit text.  Gnus sets no limits to what the user should be
376 allowed to do.  Users are encouraged to extend Gnus to make it behave
377 like they want it to behave.  A program should not control people;
378 people should be empowered to do what they want by using (or abusing)
379 the program.
380
381 @end iftex
382
383
384 @menu
385 * Starting Up::           Finding news can be a pain.
386 * The Group Buffer::      Selecting, subscribing and killing groups.
387 * The Summary Buffer::    Reading, saving and posting articles.
388 * The Article Buffer::    Displaying and handling articles.
389 * Composing Messages::    Information on sending mail and news.
390 * Select Methods::        Gnus reads all messages from various select methods.
391 * Scoring::               Assigning values to articles.
392 * Various::               General purpose settings.
393 * The End::               Farewell and goodbye.
394 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
395 * Index::                 Variable, function and concept index.
396 * Key Index::             Key Index.
397 @end menu
398
399 @node Starting Up
400 @chapter Starting Gnus
401 @cindex starting up
402
403 @kindex M-x gnus
404 @findex gnus
405 If your system administrator has set things up properly, starting Gnus
406 and reading news is extremely easy---you just type @kbd{M-x gnus} in
407 your Emacs. 
408
409 @findex gnus-other-frame
410 @kindex M-x gnus-other-frame
411 If you want to start Gnus in a different frame, you can use the command
412 @kbd{M-x gnus-other-frame} instead.
413
414 If things do not go smoothly at startup, you have to twiddle some
415 variables in your @file{~/.gnus} file.  This file is similar to
416 @file{~/.emacs}, but is read when gnus starts.
417
418 If you puzzle at any terms used in this manual, please refer to the
419 terminology section (@pxref{Terminology}).
420
421 @menu
422 * Finding the News::    Choosing a method for getting news.
423 * The First Time::      What does Gnus do the first time you start it?
424 * The Server is Down::  How can I read my mail then?
425 * Slave Gnusae::        You can have more than one Gnus active at a time.
426 * Fetching a Group::    Starting Gnus just to read a group.
427 * New Groups::          What is Gnus supposed to do with new groups?
428 * Startup Files::       Those pesky startup files---@file{.newsrc}.
429 * Auto Save::           Recovering from a crash.
430 * The Active File::     Reading the active file over a slow line Takes Time.
431 * Changing Servers::    You may want to move from one server to another.
432 * Startup Variables::   Other variables you might change.
433 @end menu
434
435
436 @node Finding the News
437 @section Finding the News
438 @cindex finding news
439
440 @vindex gnus-select-method
441 @c @head
442 The @code{gnus-select-method} variable says where Gnus should look for
443 news.  This variable should be a list where the first element says
444 @dfn{how} and the second element says @dfn{where}.  This method is your
445 native method.  All groups not fetched with this method are
446 foreign groups.
447
448 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
449 you want to get your daily dosage of news from, you'd say:
450
451 @lisp
452 (setq gnus-select-method '(nntp "news.somewhere.edu"))
453 @end lisp
454
455 If you want to read directly from the local spool, say:
456
457 @lisp
458 (setq gnus-select-method '(nnspool ""))
459 @end lisp
460
461 If you can use a local spool, you probably should, as it will almost
462 certainly be much faster.
463
464 @vindex gnus-nntpserver-file
465 @cindex NNTPSERVER
466 @cindex @sc{nntp} server
467 If this variable is not set, Gnus will take a look at the
468 @code{NNTPSERVER} environment variable.  If that variable isn't set,
469 Gnus will see whether @code{gnus-nntpserver-file}
470 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
471 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
472
473 @vindex gnus-nntp-server
474 If @code{gnus-nntp-server} is set, this variable will override
475 @code{gnus-select-method}.  You should therefore set
476 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
477
478 @vindex gnus-secondary-servers
479 You can also make Gnus prompt you interactively for the name of an
480 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
481 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
482 in the @code{gnus-secondary-servers} list (if any).  You can also just
483 type in the name of any server you feel like visiting.
484
485 @findex gnus-group-browse-foreign-server
486 @kindex B (Group)
487 However, if you use one @sc{nntp} server regularly and are just
488 interested in a couple of groups from a different server, you would be
489 better served by using the @kbd{B} command in the group buffer.  It will
490 let you have a look at what groups are available, and you can subscribe
491 to any of the groups you want to.  This also makes @file{.newsrc}
492 maintenance much tidier.  @xref{Foreign Groups}.
493
494 @vindex gnus-secondary-select-methods
495 @c @head
496 A slightly different approach to foreign groups is to set the
497 @code{gnus-secondary-select-methods} variable.  The select methods
498 listed in this variable are in many ways just as native as the
499 @code{gnus-select-method} server.  They will also be queried for active
500 files during startup (if that's required), and new newsgroups that
501 appear on these servers will be subscribed (or not) just as native
502 groups are.
503
504 For instance, if you use the @code{nnmbox} backend to read your mail, you
505 would typically set this variable to
506
507 @lisp
508 (setq gnus-secondary-select-methods '((nnmbox "")))
509 @end lisp
510
511
512 @node The First Time
513 @section The First Time
514 @cindex first time usage
515
516 If no startup files exist, Gnus will try to determine what groups should
517 be subscribed by default.
518
519 @vindex gnus-default-subscribed-newsgroups
520 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
521 will subscribe you to just those groups in that list, leaving the rest
522 killed.  Your system administrator should have set this variable to
523 something useful.
524
525 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
526 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
527 here as @dfn{whatever Lars thinks you should read}.)
528
529 You'll also be subscribed to the Gnus documentation group, which should
530 help you with most common problems.  
531
532 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
533 use the normal functions for handling new groups, and not do anything
534 special.
535
536
537 @node The Server is Down
538 @section The Server is Down
539 @cindex server errors
540
541 If the default server is down, Gnus will understandably have some
542 problems starting.  However, if you have some mail groups in addition to
543 the news groups, you may want to start Gnus anyway.
544
545 Gnus, being the trusting sort of program, will ask whether to proceed
546 without a native select method if that server can't be contacted.  This
547 will happen whether the server doesn't actually exist (i.e., you have
548 given the wrong address) or the server has just momentarily taken ill
549 for some reason or other.  If you decide to continue and have no foreign
550 groups, you'll find it difficult to actually do anything in the group
551 buffer.  But, hey, that's your problem.  Blllrph!
552
553 @findex gnus-no-server
554 @kindex M-x gnus-no-server
555 @c @head
556 If you know that the server is definitely down, or you just want to read
557 your mail without bothering with the server at all, you can use the
558 @code{gnus-no-server} command to start Gnus.  That might come in handy
559 if you're in a hurry as well.  This command will not attempt to contact
560 your primary server---instead, it will just activate all groups on level
561 1 and 2.  (You should preferably keep no native groups on those two
562 levels.)
563
564
565 @node Slave Gnusae
566 @section Slave Gnusae
567 @cindex slave
568
569 You might want to run more than one Emacs with more than one Gnus at the
570 same time.  If you are using different @file{.newsrc} files (e.g., if you
571 are using the two different Gnusae to read from two different servers),
572 that is no problem whatsoever.  You just do it.
573
574 The problem appears when you want to run two Gnusae that use the same
575 @code{.newsrc} file.
576
577 To work around that problem some, we here at the Think-Tank at the Gnus
578 Towers have come up with a new concept: @dfn{Masters} and
579 @dfn{slaves}.  (We have applied for a patent on this concept, and have
580 taken out a copyright on those words.  If you wish to use those words in
581 conjunction with each other, you have to send $1 per usage instance to
582 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
583 Applications}) will be much more expensive, of course.)
584
585 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
586 however you do it).  Each subsequent slave Gnusae should be started with
587 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
588 files, but instead save @dfn{slave files} that contain information only
589 on what groups have been read in the slave session.  When a master Gnus
590 starts, it will read (and delete) these slave files, incorporating all
591 information from them.  (The slave files will be read in the sequence
592 they were created, so the latest changes will have precedence.)
593
594 Information from the slave files has, of course, precedence over the
595 information in the normal (i.e., master) @code{.newsrc} file.
596
597
598 @node Fetching a Group
599 @section Fetching a Group
600 @cindex fetching a group
601
602 @findex gnus-fetch-group
603 It is sometimes convenient to be able to just say ``I want to read this
604 group and I don't care whether Gnus has been started or not''.  This is
605 perhaps more useful for people who write code than for users, but the
606 command @code{gnus-fetch-group} provides this functionality in any case.
607 It takes the group name as a parameter.
608
609
610 @node New Groups
611 @section New Groups
612 @cindex new groups
613 @cindex subscription
614
615 @vindex gnus-check-new-newsgroups
616 If you are satisfied that you really never want to see any new groups,
617 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
618 also save you some time at startup.  Even if this variable is
619 @code{nil}, you can always subscribe to the new groups just by pressing
620 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
621 is @code{ask-server} by default.  If you set this variable to
622 @code{always}, then Gnus will query the backends for new groups even
623 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
624
625 @menu
626 * Checking New Groups::      Determining what groups are new.
627 * Subscription Methods::     What Gnus should do with new groups.
628 * Filtering New Groups::     Making Gnus ignore certain new groups.
629 @end menu
630
631
632 @node Checking New Groups
633 @subsection Checking New Groups
634
635 Gnus normally determines whether a group is new or not by comparing the
636 list of groups from the active file(s) with the lists of subscribed and
637 dead groups.  This isn't a particularly fast method.  If
638 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
639 server for new groups since the last time.  This is both faster and
640 cheaper.  This also means that you can get rid of the list of killed
641 groups altogether, so you may set @code{gnus-save-killed-list} to
642 @code{nil}, which will save time both at startup, at exit, and all over.
643 Saves disk space, too.  Why isn't this the default, then?
644 Unfortunately, not all servers support this command. 
645
646 I bet I know what you're thinking now: How do I find out whether my
647 server supports @code{ask-server}?  No?  Good, because I don't have a
648 fail-safe answer.  I would suggest just setting this variable to
649 @code{ask-server} and see whether any new groups appear within the next
650 few days.  If any do, then it works.  If none do, then it doesn't
651 work.  I could write a function to make Gnus guess whether the server
652 supports @code{ask-server}, but it would just be a guess.  So I won't.
653 You could @code{telnet} to the server and say @code{HELP} and see
654 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
655 it does, then it might work.  (But there are servers that lists
656 @samp{NEWGROUPS} without supporting the function properly.)
657
658 This variable can also be a list of select methods.  If so, Gnus will
659 issue an @code{ask-server} command to each of the select methods, and
660 subscribe them (or not) using the normal methods.  This might be handy
661 if you are monitoring a few servers for new groups.  A side effect is
662 that startup will take much longer, so you can meditate while waiting.
663 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
664
665
666 @node Subscription Methods
667 @subsection Subscription Methods
668
669 @vindex gnus-subscribe-newsgroup-method
670 What Gnus does when it encounters a new group is determined by the
671 @code{gnus-subscribe-newsgroup-method} variable.
672
673 This variable should contain a function.  This function will be called
674 with the name of the new group as the only parameter.
675
676 Some handy pre-fab functions are:
677
678 @table @code
679
680 @item gnus-subscribe-zombies
681 @vindex gnus-subscribe-zombies
682 Make all new groups zombies.  This is the default.  You can browse the
683 zombies later (with @kbd{A z}) and either kill them all off properly
684 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
685
686 @item gnus-subscribe-randomly
687 @vindex gnus-subscribe-randomly
688 Subscribe all new groups in arbitrary order.  This really means that all
689 new groups will be added at ``the top'' of the group buffer.
690
691 @item gnus-subscribe-alphabetically
692 @vindex gnus-subscribe-alphabetically
693 Subscribe all new groups in alphabetical order.
694
695 @item gnus-subscribe-hierarchically
696 @vindex gnus-subscribe-hierarchically
697 Subscribe all new groups hierarchically.  The difference between this
698 function and @code{gnus-subscribe-alphabetically} is slight.
699 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
700 alphabetical fashion, while this function will enter groups into it's
701 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
702 @samp{comp} hierarchy, this function will not mess that configuration
703 up.  Or something like that.
704
705 @item gnus-subscribe-interactively
706 @vindex gnus-subscribe-interactively
707 Subscribe new groups interactively.  This means that Gnus will ask
708 you about @strong{all} new groups.  The groups you choose to subscribe
709 to will be subscribed hierarchically.
710
711 @item gnus-subscribe-killed
712 @vindex gnus-subscribe-killed
713 Kill all new groups.
714
715 @end table
716
717 @vindex gnus-subscribe-hierarchical-interactive
718 A closely related variable is
719 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
720 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
721 hierarchical fashion whether to subscribe to new groups or not.  Gnus
722 will ask you for each sub-hierarchy whether you want to descend the
723 hierarchy or not.  
724
725 One common mistake is to set the variable a few paragraphs above
726 (@code{gnus-subscribe-newsgroup-method}) to
727 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
728 will not work.  This is ga-ga.  So don't do it.
729
730
731 @node Filtering New Groups
732 @subsection Filtering New Groups
733
734 A nice and portable way to control which new newsgroups should be
735 subscribed (or ignored) is to put an @dfn{options} line at the start of
736 the @file{.newsrc} file.  Here's an example:
737
738 @example
739 options -n !alt.all !rec.all sci.all
740 @end example
741
742 @vindex gnus-subscribe-options-newsgroup-method
743 This line obviously belongs to a serious-minded intellectual scientific
744 person (or she may just be plain old boring), because it says that all
745 groups that have names beginning with @samp{alt} and @samp{rec} should
746 be ignored, and all groups with names beginning with @samp{sci} should
747 be subscribed.  Gnus will not use the normal subscription method for
748 subscribing these groups.
749 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
750 variable defaults to @code{gnus-subscribe-alphabetically}.
751
752 @vindex gnus-options-not-subscribe
753 @vindex gnus-options-subscribe
754 If you don't want to mess with your @file{.newsrc} file, you can just
755 set the two variables @code{gnus-options-subscribe} and
756 @code{gnus-options-not-subscribe}.  These two variables do exactly the
757 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
758 and if the new group matches the former, it will be unconditionally
759 subscribed, and if it matches the latter, it will be ignored.
760
761 @vindex gnus-auto-subscribed-groups
762 Yet another variable that meddles here is
763 @code{gnus-auto-subscribed-groups}.  It works exactly like
764 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
765 thought it would be nice to have two of these.  This variable is more
766 meant for setting some ground rules, while the other variable is used
767 more for user fiddling.  By default this variable makes all new groups
768 that come from mail backends (@code{nnml}, @code{nnbabyl},
769 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
770 don't like that, just set this variable to @code{nil}.
771
772 New groups that match this regexp are subscribed using
773 @code{gnus-subscribe-options-newsgroup-method}.
774
775
776 @node Changing Servers
777 @section Changing Servers
778 @cindex changing servers
779
780 Sometimes it is necessary to move from one @sc{nntp} server to another.
781 This happens very rarely, but perhaps you change jobs, or one server is
782 very flaky and you want to use another.  
783
784 Changing the server is pretty easy, right?  You just change
785 @code{gnus-select-method} to point to the new server?  
786
787 @emph{Wrong!}
788
789 Article numbers are not (in any way) kept synchronized between different
790 @sc{nntp} servers, and the only way Gnus keeps track of what articles
791 you have read is by keeping track of article numbers.  So when you
792 change @code{gnus-select-method}, your @file{.newsrc} file becomes
793 worthless.  
794
795 Gnus provides a few functions to attempt to translate a @file{.newsrc}
796 file from one server to another.  They all have one thing in
797 common---they take a looong time to run.  You don't want to use these
798 functions more than absolutely necessary.
799
800 @kindex M-x gnus-change-server
801 @findex gnus-change-server
802 If you have access to both servers, Gnus can request the headers for all
803 the articles you have read and compare @code{Message-ID}s and map the
804 article numbers of the read articles and article marks.  The @kbd{M-x
805 gnus-change-server} command will do this for all your native groups.  It
806 will prompt for the method you want to move to.
807
808 @kindex M-x gnus-group-move-group-to-server
809 @findex gnus-group-move-group-to-server
810 You can also move individual groups with the @kbd{M-x
811 gnus-group-move-group-to-server} command.  This is useful if you want to
812 move a (foreign) group from one server to another.
813
814 @kindex M-x gnus-group-clear-data-on-native-groups
815 @findex gnus-group-clear-data-on-native-groups
816 If you don't have access to both the old and new server, all your marks
817 and read ranges have become worthless.  You can use the @kbd{M-x
818 gnus-group-clear-data-on-native-groups} command to clear out all data
819 that you have on your native groups.  Use with caution.
820
821
822 @node Startup Files
823 @section Startup Files
824 @cindex startup files
825 @cindex .newsrc
826 @cindex .newsrc.el
827 @cindex .newsrc.eld
828
829 Now, you all know about the @file{.newsrc} file.  All subscription
830 information is traditionally stored in this file.
831
832 Things got a bit more complicated with @sc{gnus}.  In addition to
833 keeping the @file{.newsrc} file updated, it also used a file called
834 @file{.newsrc.el} for storing all the information that didn't fit into
835 the @file{.newsrc} file.  (Actually, it also duplicated everything in
836 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
837 files was the most recently saved, which enabled people to swap between
838 @sc{gnus} and other newsreaders.
839
840 That was kinda silly, so Gnus went one better: In addition to the
841 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
842 @file{.newsrc.eld}.  It will read whichever of these files that are most
843 recent, but it will never write a @file{.newsrc.el} file.  You should
844 never delete the @file{.newsrc.eld} file---it contains much information
845 not stored in the @file{.newsrc} file.
846
847 @vindex gnus-save-newsrc-file
848 You can turn off writing the @file{.newsrc} file by setting
849 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
850 the file and save some space, as well as making exit from Gnus faster.
851 However, this will make it impossible to use other newsreaders than
852 Gnus.  But hey, who would want to, right?
853
854 @vindex gnus-save-killed-list
855 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
856 will not save the list of killed groups to the startup file.  This will
857 save both time (when starting and quitting) and space (on disk).  It
858 will also mean that Gnus has no record of what groups are new or old,
859 so the automatic new groups subscription methods become meaningless.
860 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
861 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
862 Groups}).  This variable can also be a regular expression.  If that's
863 the case, remove all groups that do not match this regexp before
864 saving.  This can be useful in certain obscure situations that involve
865 several servers where not all servers support @code{ask-server}.
866
867 @vindex gnus-startup-file
868 The @code{gnus-startup-file} variable says where the startup files are.
869 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
870 file being whatever that one is, with a @samp{.eld} appended.
871
872 @vindex gnus-save-newsrc-hook
873 @vindex gnus-save-quick-newsrc-hook
874 @vindex gnus-save-standard-newsrc-hook
875 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
876 files, while @code{gnus-save-quick-newsrc-hook} is called just before
877 saving the @file{.newsrc.eld} file, and
878 @code{gnus-save-standard-newsrc-hook} is called just before saving the
879 @file{.newsrc} file.  The latter two are commonly used to turn version
880 control on or off.  Version control is on by default when saving the
881 startup files.  If you want to turn backup creation off, say something like: 
882
883 @lisp
884 (defun turn-off-backup ()
885   (set (make-local-variable 'backup-inhibited) t))
886
887 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
888 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
889 @end lisp
890
891 @vindex gnus-init-file
892 When Gnus starts, it will read the @code{gnus-site-init-file}
893 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
894 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
895 and can be used to avoid cluttering your @file{~/.emacs} and
896 @file{site-init} files with Gnus stuff.  Gnus will also check for files
897 with the same names as these, but with @file{.elc} and @file{.el}
898 suffixes.  In other words, if you have set @code{gnus-init-file} to
899 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
900 and finally @file{~/.gnus} (in this order).
901
902
903
904 @node Auto Save
905 @section Auto Save
906 @cindex dribble file
907 @cindex auto-save
908
909 Whenever you do something that changes the Gnus data (reading articles,
910 catching up, killing/subscribing groups), the change is added to a
911 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
912 Emacs way.  If your Emacs should crash before you have saved the
913 @file{.newsrc} files, all changes you have made can be recovered from
914 this file.
915
916 If Gnus detects this file at startup, it will ask the user whether to
917 read it.  The auto save file is deleted whenever the real startup file is
918 saved.
919
920 @vindex gnus-use-dribble-file
921 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
922 maintain a dribble buffer.  The default is @code{t}.
923
924 @vindex gnus-dribble-directory
925 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
926 this variable is @code{nil}, which it is by default, Gnus will dribble
927 into the directory where the @file{.newsrc} file is located.  (This is
928 normally the user's home directory.)  The dribble file will get the same
929 file permissions as the @code{.newsrc} file.
930
931
932 @node The Active File
933 @section The Active File
934 @cindex active file
935 @cindex ignored groups
936
937 When Gnus starts, or indeed whenever it tries to determine whether new
938 articles have arrived, it reads the active file.  This is a very large
939 file that lists all the active groups and articles on the server.
940
941 @vindex gnus-ignored-newsgroups
942 Before examining the active file, Gnus deletes all lines that match the
943 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
944 any groups with bogus names, but you can use this variable to make Gnus
945 ignore hierarchies you aren't ever interested in.  However, this is not
946 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
947 Groups} for an overview of other variables that can be used instead.
948
949 @c This variable is
950 @c @code{nil} by default, and will slow down active file handling somewhat
951 @c if you set it to anything else.
952
953 @vindex gnus-read-active-file
954 @c @head
955 The active file can be rather Huge, so if you have a slow network, you
956 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
957 reading the active file.  This variable is @code{some} by default.
958
959 Gnus will try to make do by getting information just on the groups that
960 you actually subscribe to.
961
962 Note that if you subscribe to lots and lots of groups, setting this
963 variable to @code{nil} will probably make Gnus slower, not faster.  At
964 present, having this variable @code{nil} will slow Gnus down
965 considerably, unless you read news over a 2400 baud modem.  
966
967 This variable can also have the value @code{some}.  Gnus will then
968 attempt to read active info only on the subscribed groups.  On some
969 servers this is quite fast (on sparkling, brand new INN servers that
970 support the @code{LIST ACTIVE group} command), on others this isn't fast
971 at all.  In any case, @code{some} should be faster than @code{nil}, and
972 is certainly faster than @code{t} over slow lines.
973
974 If this variable is @code{nil}, Gnus will ask for group info in total
975 lock-step, which isn't very fast.  If it is @code{some} and you use an
976 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
977 read all the replies in one swoop.  This will normally result in better
978 performance, but if the server does not support the aforementioned
979 @code{LIST ACTIVE group} command, this isn't very nice to the server.
980
981 In any case, if you use @code{some} or @code{nil}, you should definitely
982 kill all groups that you aren't interested in to speed things up.
983
984 Note that this variable also affects active file retrieval from
985 secondary select methods.
986
987
988 @node Startup Variables
989 @section Startup Variables
990
991 @table @code
992
993 @item gnus-load-hook
994 @vindex gnus-load-hook
995 A hook run while Gnus is being loaded.  Note that this hook will
996 normally be run just once in each Emacs session, no matter how many
997 times you start Gnus.
998
999 @item gnus-before-startup-hook
1000 @vindex gnus-before-startup-hook
1001 A hook run after starting up Gnus successfully.
1002
1003 @item gnus-startup-hook
1004 @vindex gnus-startup-hook
1005 A hook run as the very last thing after starting up Gnus
1006
1007 @item gnus-started-hook
1008 @vindex gnus-started-hook
1009 A hook that is run as the very last thing after starting up Gnus
1010 successfully.
1011
1012 @item gnus-started-hook
1013 @vindex gnus-started-hook
1014 A hook that is run after reading the @file{.newsrc} file(s), but before
1015 generating the group buffer.
1016
1017 @item gnus-check-bogus-newsgroups
1018 @vindex gnus-check-bogus-newsgroups
1019 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1020 startup.  A @dfn{bogus group} is a group that you have in your
1021 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1022 bogus groups can take quite a while, so to save time and resources it's
1023 best to leave this option off, and do the checking for bogus groups once
1024 in a while from the group buffer instead (@pxref{Group Maintenance}).
1025
1026 @item gnus-inhibit-startup-message
1027 @vindex gnus-inhibit-startup-message
1028 If non-@code{nil}, the startup message won't be displayed.  That way,
1029 your boss might not notice as easily that you are reading news instead
1030 of doing your job.  Note that this variable is used before
1031 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1032
1033 @item gnus-no-groups-message
1034 @vindex gnus-no-groups-message
1035 Message displayed by Gnus when no groups are available.
1036
1037 @item gnus-play-startup-jingle
1038 @vindex gnus-play-startup-jingle
1039 If non-@code{nil}, play the Gnus jingle at startup.
1040
1041 @item gnus-startup-jingle
1042 @vindex gnus-startup-jingle
1043 Jingle to be played if the above variable is non-@code{nil}.  The
1044 default is @samp{Tuxedomoon.Jingle4.au}.
1045
1046 @end table
1047
1048
1049 @node The Group Buffer
1050 @chapter The Group Buffer
1051 @cindex group buffer
1052
1053 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1054 is the first buffer shown when Gnus starts, and will never be killed as
1055 long as Gnus is active.
1056
1057 @iftex
1058 @iflatex
1059 \gnusfigure{The Group Buffer}{320}{
1060 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1061 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1062 \put(120,38){\vector(1,2){10}}
1063 \put(40,60){\makebox(0,0)[r]{Mode line}}
1064 \put(40,58){\vector(1,0){30}}
1065 \put(200,28){\makebox(0,0)[t]{Native select method}}
1066 \put(200,26){\vector(-1,2){15}}
1067 }
1068 @end iflatex
1069 @end iftex
1070
1071 @menu
1072 * Group Buffer Format::    Information listed and how you can change it.
1073 * Group Maneuvering::      Commands for moving in the group buffer.
1074 * Selecting a Group::      Actually reading news.
1075 * Group Data::             Changing the info for a group.
1076 * Subscription Commands::  Unsubscribing, killing, subscribing.
1077 * Group Levels::           Levels? What are those, then?
1078 * Group Score::            A mechanism for finding out what groups you like.
1079 * Marking Groups::         You can mark groups for later processing.
1080 * Foreign Groups::         Creating and editing groups.
1081 * Group Parameters::       Each group may have different parameters set.
1082 * Listing Groups::         Gnus can list various subsets of the groups.
1083 * Sorting Groups::         Re-arrange the group order.
1084 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1085 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1086 * Exiting Gnus::           Stop reading news and get some work done.
1087 * Group Topics::           A folding group mode divided into topics.
1088 * Misc Group Stuff::       Other stuff that you can to do.
1089 @end menu
1090
1091
1092 @node Group Buffer Format
1093 @section Group Buffer Format
1094
1095 @menu 
1096 * Group Line Specification::       Deciding how the group buffer is to look.
1097 * Group Modeline Specification::   The group buffer modeline.
1098 * Group Highlighting::             Having nice colors in the group buffer.
1099 @end menu
1100
1101
1102 @node Group Line Specification
1103 @subsection Group Line Specification
1104 @cindex group buffer format
1105
1106 The default format of the group buffer is nice and dull, but you can
1107 make it as exciting and ugly as you feel like.
1108
1109 Here's a couple of example group lines:
1110
1111 @example
1112      25: news.announce.newusers
1113  *    0: alt.fan.andrea-dworkin
1114 @end example
1115
1116 Quite simple, huh?
1117
1118 You can see that there are 25 unread articles in
1119 @samp{news.announce.newusers}.  There are no unread articles, but some
1120 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1121 asterisk at the beginning of the line?).
1122
1123 @vindex gnus-group-line-format
1124 You can change that format to whatever you want by fiddling with the
1125 @code{gnus-group-line-format} variable.  This variable works along the
1126 lines of a @code{format} specification, which is pretty much the same as
1127 a @code{printf} specifications, for those of you who use (feh!) C.
1128 @xref{Formatting Variables}. 
1129
1130 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1131
1132 There should always be a colon on the line; the cursor always moves to
1133 the colon after performing an operation.  Nothing else is required---not
1134 even the group name.  All displayed text is just window dressing, and is
1135 never examined by Gnus.  Gnus stores all real information it needs using
1136 text properties.
1137
1138 (Note that if you make a really strange, wonderful, spreadsheet-like
1139 layout, everybody will believe you are hard at work with the accounting
1140 instead of wasting time reading news.)
1141
1142 Here's a list of all available format characters:
1143
1144 @table @samp
1145
1146 @item M    
1147 An asterisk if the group only has marked articles.
1148
1149 @item S
1150 Whether the group is subscribed.
1151
1152 @item L    
1153 Level of subscribedness.
1154
1155 @item N
1156 Number of unread articles.
1157
1158 @item I
1159 Number of dormant articles.
1160
1161 @item T
1162 Number of ticked articles.
1163
1164 @item R
1165 Number of read articles.
1166
1167 @item t
1168 Estimated total number of articles.  (This is really @var{max-number}
1169 minus @var{min-number} plus 1.)
1170
1171 @item y
1172 Number of unread, unticked, non-dormant articles.
1173
1174 @item i
1175 Number of ticked and dormant articles.
1176
1177 @item g
1178 Full group name.
1179
1180 @item G
1181 Group name.
1182
1183 @item D
1184 Newsgroup description.
1185
1186 @item o
1187 @samp{m} if moderated.
1188
1189 @item O
1190 @samp{(m)} if moderated.
1191
1192 @item s
1193 Select method.
1194
1195 @item n
1196 Select from where.
1197
1198 @item z
1199 A string that looks like @samp{<%s:%n>} if a foreign select method is
1200 used.
1201
1202 @item P
1203 Indentation based on the level of the topic (@pxref{Group Topics}). 
1204
1205 @item c
1206 @vindex gnus-group-uncollapsed-levels
1207 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1208 variable says how many levels to leave at the end of the group name.
1209 The default is 1---this will mean that group names like
1210 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1211
1212 @item m
1213 @vindex gnus-new-mail-mark
1214 @cindex %
1215 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1216 the group lately.
1217
1218 @item d
1219 A string that says when you last read the group (@pxref{Group
1220 Timestamp}). 
1221
1222 @item u
1223 User defined specifier.  The next character in the format string should
1224 be a letter.  Gnus will call the function
1225 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1226 following @samp{%u}.  The function will be passed a single dummy
1227 parameter as argument.  The function should return a string, which will
1228 be inserted into the buffer just like information from any other
1229 specifier.
1230 @end table
1231
1232 @cindex *
1233 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1234 if no info is available---for instance, if it is a non-activated foreign
1235 group, or a bogus native group.
1236
1237
1238 @node Group Modeline Specification
1239 @subsection Group Modeline Specification
1240 @cindex group modeline
1241
1242 @vindex gnus-group-mode-line-format
1243 The mode line can be changed by setting
1244 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}).  It
1245 doesn't understand that many format specifiers:
1246
1247 @table @samp
1248 @item S
1249 The native news server.
1250 @item M
1251 The native select method.
1252 @end table
1253
1254
1255 @node Group Highlighting
1256 @subsection Group Highlighting
1257 @cindex highlighting
1258 @cindex group highlighting
1259
1260 @vindex gnus-group-highlight
1261 Highlighting in the group buffer is controlled by the
1262 @code{gnus-group-highlight} variable.  This is an alist with elements
1263 that look like @var{(form . face)}.  If @var{form} evaluates to
1264 something non-@code{nil}, the @var{face} will be used on the line.
1265
1266 Here's an example value for this variable that might look nice if the
1267 background is dark:
1268
1269 @lisp
1270 (face-spec-set 'my-group-face-1 '((t (:foreground "Red" :bold t))))
1271 (face-spec-set 'my-group-face-2 '((t (:foreground "SeaGreen" :bold t))))
1272 (face-spec-set 'my-group-face-3 '((t (:foreground "SpringGreen" :bold t))))
1273 (face-spec-set 'my-group-face-4 '((t (:foreground "SteelBlue" :bold t))))
1274 (face-spec-set 'my-group-face-5 '((t (:foreground "SkyBlue" :bold t))))
1275
1276 (setq gnus-group-highlight
1277       '(((> unread 200) . my-group-face-1)
1278         ((and (< level 3) (zerop unread)) . my-group-face-2)
1279         ((< level 3) . my-group-face-3)
1280         ((zerop unread) . my-group-face-4)
1281 (setq gnus-group-highlight
1282       `(((> unread 200) . 
1283          ,(custom-face-lookup "Red" nil nil t nil nil))
1284         ((and (< level 3) (zerop unread)) . 
1285          ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1286         ((< level 3) . 
1287          ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1288         ((zerop unread) . 
1289          ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1290         (t . 
1291          ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1292         (t . my-group-face-5)))
1293 @end lisp
1294
1295 Also @pxref{Faces and Fonts}.
1296
1297 Variables that are dynamically bound when the forms are evaluated
1298 include:
1299
1300 @table @code
1301 @item group
1302 The group name.
1303 @item unread
1304 The number of unread articles in the group.
1305 @item method
1306 The select method.
1307 @item mailp
1308 Whether the group is a mail group.
1309 @item level
1310 The level of the group.
1311 @item score
1312 The score of the group.
1313 @item ticked 
1314 The number of ticked articles in the group.
1315 @item total
1316 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1317 MIN-NUMBER plus one.
1318 @item topic
1319 When using the topic minor mode, this variable is bound to the current
1320 topic being inserted.
1321 @end table
1322
1323 When the forms are @code{eval}ed, point is at the beginning of the line
1324 of the group in question, so you can use many of the normal Gnus
1325 functions for snarfing info on the group.
1326
1327 @vindex gnus-group-update-hook
1328 @findex gnus-group-highlight-line
1329 @code{gnus-group-update-hook} is called when a group line is changed.
1330 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1331 calls @code{gnus-group-highlight-line} by default.
1332
1333
1334 @node Group Maneuvering
1335 @section Group Maneuvering
1336 @cindex group movement
1337
1338 All movement commands understand the numeric prefix and will behave as
1339 expected, hopefully. 
1340
1341 @table @kbd
1342
1343 @item n
1344 @kindex n (Group)
1345 @findex gnus-group-next-unread-group
1346 Go to the next group that has unread articles
1347 (@code{gnus-group-next-unread-group}).
1348
1349 @item p
1350 @itemx DEL
1351 @kindex DEL (Group)
1352 @kindex p (Group)
1353 @findex gnus-group-prev-unread-group
1354 Go to the previous group that has unread articles
1355 (@code{gnus-group-prev-unread-group}).
1356
1357 @item N
1358 @kindex N (Group)
1359 @findex gnus-group-next-group
1360 Go to the next group (@code{gnus-group-next-group}).
1361
1362 @item P
1363 @kindex P (Group)
1364 @findex gnus-group-prev-group
1365 Go to the previous group (@code{gnus-group-prev-group}).
1366
1367 @item M-p
1368 @kindex M-p (Group)
1369 @findex gnus-group-next-unread-group-same-level
1370 Go to the next unread group on the same (or lower) level
1371 (@code{gnus-group-next-unread-group-same-level}). 
1372
1373 @item M-n
1374 @kindex M-n (Group)
1375 @findex gnus-group-prev-unread-group-same-level
1376 Go to the previous unread group on the same (or lower) level
1377 (@code{gnus-group-prev-unread-group-same-level}). 
1378 @end table
1379
1380 Three commands for jumping to groups:
1381
1382 @table @kbd
1383
1384 @item j
1385 @kindex j (Group)
1386 @findex gnus-group-jump-to-group
1387 Jump to a group (and make it visible if it isn't already)
1388 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1389 like living groups.
1390
1391 @item ,
1392 @kindex , (Group)
1393 @findex gnus-group-best-unread-group
1394 Jump to the unread group with the lowest level
1395 (@code{gnus-group-best-unread-group}). 
1396
1397 @item .
1398 @kindex . (Group)
1399 @findex gnus-group-first-unread-group
1400 Jump to the first group with unread articles
1401 (@code{gnus-group-first-unread-group}).  
1402 @end table
1403
1404 @vindex gnus-group-goto-unread
1405 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1406 commands will move to the next group, not the next unread group.  Even
1407 the commands that say they move to the next unread group.  The default
1408 is @code{t}.
1409
1410
1411 @node Selecting a Group
1412 @section Selecting a Group
1413 @cindex group selection
1414
1415 @table @kbd
1416
1417 @item SPACE
1418 @kindex SPACE (Group)
1419 @findex gnus-group-read-group
1420 Select the current group, switch to the summary buffer and display the
1421 first unread article (@code{gnus-group-read-group}).  If there are no
1422 unread articles in the group, or if you give a non-numerical prefix to
1423 this command, Gnus will offer to fetch all the old articles in this
1424 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1425 determines the number of articles Gnus will fetch.  If @var{N} is
1426 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1427 negative, Gnus fetches the @var{abs(N)} oldest articles.
1428
1429 @item RET
1430 @kindex RET (Group)
1431 @findex gnus-group-select-group
1432 Select the current group and switch to the summary buffer
1433 (@code{gnus-group-select-group}).  Takes the same arguments as
1434 @code{gnus-group-read-group}---the only difference is that this command
1435 does not display the first unread article automatically upon group
1436 entry. 
1437
1438 @item M-RET
1439 @kindex M-RET (Group)
1440 @findex gnus-group-quick-select-group
1441 This does the same as the command above, but tries to do it with the
1442 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1443 scoring/killing will be performed, there will be no highlights and no
1444 expunging.  This might be useful if you're in a real hurry and have to
1445 enter some humongous group.  If you give a 0 prefix to this command
1446 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1447 which is useful if you want to toggle threading before generating the
1448 summary buffer (@pxref{Summary Generation Commands}).
1449
1450 @item M-SPACE
1451 @kindex M-SPACE (Group)
1452 @findex gnus-group-visible-select-group
1453 This is yet one more command that does the same as the @kbd{RET}
1454 command, but this one does it without expunging and hiding dormants
1455 (@code{gnus-group-visible-select-group}).
1456
1457 @item M-C-RET
1458 @kindex M-C-RET (Group)
1459 @findex gnus-group-select-group-ephemerally
1460 Finally, this command selects the current group ephemerally without
1461 doing any processing of its contents
1462 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1463 turned off.  Everything you do in the group after selecting it in this
1464 manner will have no permanent effects.
1465
1466 @end table
1467
1468 @vindex gnus-large-newsgroup
1469 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1470 to be a big group.  This is 200 by default.  If the group has more
1471 (unread and/or ticked) articles than this, Gnus will query the user
1472 before entering the group.  The user can then specify how many articles
1473 should be fetched from the server.  If the user specifies a negative
1474 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1475 is positive, the @code{n} articles that have arrived most recently will
1476 be fetched.
1477
1478 @vindex gnus-select-group-hook
1479 @vindex gnus-auto-select-first
1480 @code{gnus-auto-select-first} control whether any articles are selected
1481 automatically when entering a group with the @kbd{SPACE} command.
1482
1483 @table @code
1484
1485 @item nil
1486 Don't select any articles when entering the group.  Just display the
1487 full summary buffer.
1488
1489 @item t
1490 Select the first unread article when entering the group.  
1491
1492 @item best
1493 Select the most high-scored article in the group when entering the
1494 group. 
1495 @end table
1496         
1497 If you want to prevent automatic selection in some group (say, in a
1498 binary group with Huge articles) you can set this variable to @code{nil}
1499 in @code{gnus-select-group-hook}, which is called when a group is
1500 selected.
1501
1502
1503 @node Subscription Commands
1504 @section Subscription Commands
1505 @cindex subscription
1506
1507 @table @kbd
1508
1509 @item S t
1510 @itemx u
1511 @kindex S t (Group)
1512 @kindex u (Group)
1513 @findex gnus-group-unsubscribe-current-group
1514 @c @icon{gnus-group-unsubscribe}
1515 Toggle subscription to the current group
1516 (@code{gnus-group-unsubscribe-current-group}).  
1517
1518 @item S s
1519 @itemx U
1520 @kindex S s (Group)
1521 @kindex U (Group)
1522 @findex gnus-group-unsubscribe-group
1523 Prompt for a group to subscribe, and then subscribe it.  If it was
1524 subscribed already, unsubscribe it instead
1525 (@code{gnus-group-unsubscribe-group}).
1526
1527 @item S k
1528 @itemx C-k
1529 @kindex S k (Group)
1530 @kindex C-k (Group)
1531 @findex gnus-group-kill-group
1532 @c @icon{gnus-group-kill-group}
1533 Kill the current group (@code{gnus-group-kill-group}).
1534
1535 @item S y
1536 @itemx C-y
1537 @kindex S y (Group)
1538 @kindex C-y (Group)
1539 @findex gnus-group-yank-group
1540 Yank the last killed group (@code{gnus-group-yank-group}).
1541
1542 @item C-x C-t
1543 @kindex C-x C-t (Group)
1544 @findex gnus-group-transpose-groups
1545 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1546 really a subscription command, but you can use it instead of a
1547 kill-and-yank sequence sometimes.
1548
1549 @item S w
1550 @itemx C-w
1551 @kindex S w (Group)
1552 @kindex C-w (Group)
1553 @findex gnus-group-kill-region
1554 Kill all groups in the region (@code{gnus-group-kill-region}). 
1555
1556 @item S z
1557 @kindex S z (Group)
1558 @findex gnus-group-kill-all-zombies
1559 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1560
1561 @item S C-k
1562 @kindex S C-k (Group)
1563 @findex gnus-group-kill-level
1564 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1565 These groups can't be yanked back after killing, so this command should
1566 be used with some caution.  The only time where this command comes in
1567 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1568 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1569 kill off all unsubscribed groups that do not have message numbers in the
1570 @file{.newsrc} file.  
1571
1572 @end table
1573
1574 Also @pxref{Group Levels}.
1575
1576
1577 @node Group Data
1578 @section Group Data
1579
1580 @table @kbd
1581
1582 @item c
1583 @kindex c (Group)
1584 @findex gnus-group-catchup-current
1585 @vindex gnus-group-catchup-group-hook
1586 @c @icon{gnus-group-catchup-current}
1587 Mark all unticked articles in this group as read
1588 (@code{gnus-group-catchup-current}).
1589 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1590 the group buffer.
1591
1592 @item C
1593 @kindex C (Group)
1594 @findex gnus-group-catchup-current-all
1595 Mark all articles in this group, even the ticked ones, as read
1596 (@code{gnus-group-catchup-current-all}).   
1597
1598 @item M-c
1599 @kindex M-c (Group)
1600 @findex gnus-group-clear-data
1601 Clear the data from the current group---nix out marks and the list of
1602 read articles (@code{gnus-group-clear-data}).
1603
1604 @item M-x gnus-group-clear-data-on-native-groups
1605 @kindex M-x gnus-group-clear-data-on-native-groups
1606 @findex gnus-group-clear-data-on-native-groups
1607 If you have switched from one @sc{nntp} server to another, all your marks
1608 and read ranges have become worthless.  You can use this command to
1609 clear out all data that you have on your native groups.  Use with
1610 caution. 
1611
1612 @end table
1613
1614
1615 @node Group Levels
1616 @section Group Levels
1617 @cindex group level
1618 @cindex level
1619
1620 All groups have a level of @dfn{subscribedness}.  For instance, if a
1621 group is on level 2, it is more subscribed than a group on level 5.  You
1622 can ask Gnus to just list groups on a given level or lower
1623 (@pxref{Listing Groups}), or to just check for new articles in groups on
1624 a given level or lower (@pxref{Scanning New Messages}).
1625
1626 Remember:  The higher the level of the group, the less important it is. 
1627
1628 @table @kbd
1629
1630 @item S l
1631 @kindex S l (Group)
1632 @findex gnus-group-set-current-level
1633 Set the level of the current group.  If a numeric prefix is given, the
1634 next @var{n} groups will have their levels set.  The user will be
1635 prompted for a level.
1636 @end table
1637
1638 @vindex gnus-level-killed
1639 @vindex gnus-level-zombie
1640 @vindex gnus-level-unsubscribed
1641 @vindex gnus-level-subscribed
1642 Gnus considers groups from levels 1 to
1643 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1644 @code{gnus-level-subscribed} (exclusive) and
1645 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1646 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1647 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1648 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1649 same, but zombie and killed groups have no information on what articles
1650 you have read, etc, stored.  This distinction between dead and living
1651 groups isn't done because it is nice or clever, it is done purely for
1652 reasons of efficiency.
1653
1654 It is recommended that you keep all your mail groups (if any) on quite
1655 low levels (e.g. 1 or 2).
1656
1657 If you want to play with the level variables, you should show some care.
1658 Set them once, and don't touch them ever again.  Better yet, don't touch
1659 them at all unless you know exactly what you're doing.
1660
1661 @vindex gnus-level-default-unsubscribed
1662 @vindex gnus-level-default-subscribed
1663 Two closely related variables are @code{gnus-level-default-subscribed}
1664 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1665 which are the levels that new groups will be put on if they are
1666 (un)subscribed.  These two variables should, of course, be inside the
1667 relevant valid ranges.
1668
1669 @vindex gnus-keep-same-level
1670 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1671 will only move to groups of the same level (or lower).  In
1672 particular, going from the last article in one group to the next group
1673 will go to the next group of the same level (or lower).  This might be
1674 handy if you want to read the most important groups before you read the
1675 rest.
1676
1677 @vindex gnus-group-default-list-level
1678 All groups with a level less than or equal to
1679 @code{gnus-group-default-list-level} will be listed in the group buffer
1680 by default.
1681
1682 @vindex gnus-group-list-inactive-groups
1683 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1684 groups will be listed along with the unread groups.  This variable is
1685 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1686 listed. 
1687
1688 @vindex gnus-group-use-permanent-levels
1689 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1690 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1691 use this level as the ``work'' level.
1692
1693 @vindex gnus-activate-level
1694 Gnus will normally just activate (i. e., query the server about) groups
1695 on level @code{gnus-activate-level} or less.  If you don't want to
1696 activate unsubscribed groups, for instance, you might set this variable
1697 to 5.  The default is 6.
1698
1699
1700 @node Group Score
1701 @section Group Score
1702 @cindex group score
1703 @cindex group rank
1704 @cindex rank
1705
1706 You would normally keep important groups on high levels, but that scheme
1707 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1708 group buffer according to how often you read groups, perhaps?  Within
1709 reason?  
1710
1711 This is what @dfn{group score} is for.  You can assign a score to each
1712 group.  You can then sort the group buffer based on this score.
1713 Alternatively, you can sort on score and then level.  (Taken together,
1714 the level and the score is called the @dfn{rank} of the group.  A group
1715 that is on level 4 and has a score of 1 has a higher rank than a group
1716 on level 5 that has a score of 300.  (The level is the most significant
1717 part and the score is the least significant part.))
1718
1719 @findex gnus-summary-bubble-group
1720 If you want groups you read often to get higher scores than groups you
1721 read seldom you can add the @code{gnus-summary-bubble-group} function to
1722 the @code{gnus-summary-exit-hook} hook.  This will result (after
1723 sorting) in a bubbling sort of action.  If you want to see that in
1724 action after each summary exit, you can add
1725 @code{gnus-group-sort-groups-by-rank} or
1726 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1727 slow things down somewhat.
1728
1729
1730 @node Marking Groups
1731 @section Marking Groups
1732 @cindex marking groups
1733
1734 If you want to perform some command on several groups, and they appear
1735 subsequently in the group buffer, you would normally just give a
1736 numerical prefix to the command.  Most group commands will then do your
1737 bidding on those groups.
1738
1739 However, if the groups are not in sequential order, you can still
1740 perform a command on several groups.  You simply mark the groups first
1741 with the process mark and then execute the command.
1742
1743 @table @kbd
1744
1745 @item #
1746 @kindex # (Group)
1747 @itemx M m
1748 @kindex M m (Group)
1749 @findex gnus-group-mark-group
1750 Set the mark on the current group (@code{gnus-group-mark-group}). 
1751
1752 @item M-#
1753 @kindex M-# (Group)
1754 @itemx M u
1755 @kindex M u (Group)
1756 @findex gnus-group-unmark-group
1757 Remove the mark from the current group
1758 (@code{gnus-group-unmark-group}). 
1759
1760 @item M U
1761 @kindex M U (Group)
1762 @findex gnus-group-unmark-all-groups
1763 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). 
1764
1765 @item M w
1766 @kindex M w (Group)
1767 @findex gnus-group-mark-region
1768 Mark all groups between point and mark (@code{gnus-group-mark-region}). 
1769
1770 @item M b
1771 @kindex M b (Group)
1772 @findex gnus-group-mark-buffer
1773 Mark all groups in the buffer (@code{gnus-group-mark-buffer}). 
1774
1775 @item M r
1776 @kindex M r (Group)
1777 @findex gnus-group-mark-regexp
1778 Mark all groups that match some regular expression
1779 (@code{gnus-group-mark-regexp}).  
1780 @end table
1781
1782 Also @pxref{Process/Prefix}.
1783
1784 @findex gnus-group-universal-argument
1785 If you want to execute some command on all groups that have been marked
1786 with the process mark, you can use the @kbd{M-&}
1787 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1788 the command to be executed.
1789
1790
1791 @node Foreign Groups
1792 @section Foreign Groups
1793 @cindex foreign groups
1794
1795 Below are some group mode commands for making and editing general foreign
1796 groups, as well as commands to ease the creation of a few
1797 special-purpose groups.  All these commands insert the newly created
1798 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1799 consulted.
1800
1801 @table @kbd
1802
1803 @item G m
1804 @kindex G m (Group)
1805 @findex gnus-group-make-group
1806 @cindex making groups
1807 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1808 for a name, a method and possibly an @dfn{address}.  For an easier way
1809 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1810
1811 @item G r
1812 @kindex G r (Group)
1813 @findex gnus-group-rename-group
1814 @cindex renaming groups
1815 Rename the current group to something else
1816 (@code{gnus-group-rename-group}).  This is valid only on some
1817 groups---mail groups mostly.  This command might very well be quite slow
1818 on some backends.
1819
1820 @item G c
1821 @kindex G c (Group)
1822 @cindex customizing
1823 @findex gnus-group-customize
1824 Customize the group parameters (@code{gnus-group-customize}).
1825
1826 @item G e
1827 @kindex G e (Group)
1828 @findex gnus-group-edit-group-method
1829 @cindex renaming groups
1830 Enter a buffer where you can edit the select method of the current
1831 group (@code{gnus-group-edit-group-method}).
1832
1833 @item G p
1834 @kindex G p (Group)
1835 @findex gnus-group-edit-group-parameters
1836 Enter a buffer where you can edit the group parameters
1837 (@code{gnus-group-edit-group-parameters}). 
1838
1839 @item G E
1840 @kindex G E (Group)
1841 @findex gnus-group-edit-group
1842 Enter a buffer where you can edit the group info
1843 (@code{gnus-group-edit-group}).
1844
1845 @item G d
1846 @kindex G d (Group)
1847 @findex gnus-group-make-directory-group
1848 @cindex nndir
1849 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1850 for a directory name (@code{gnus-group-make-directory-group}).
1851
1852 @item G h 
1853 @kindex G h (Group)
1854 @cindex help group
1855 @findex gnus-group-make-help-group
1856 Make the Gnus help group (@code{gnus-group-make-help-group}).
1857
1858 @item G a
1859 @kindex G a (Group)
1860 @cindex (ding) archive
1861 @cindex archive group
1862 @findex gnus-group-make-archive-group
1863 @vindex gnus-group-archive-directory
1864 @vindex gnus-group-recent-archive-directory
1865 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1866 default a group pointing to the most recent articles will be created
1867 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1868 group will be created from @code{gnus-group-archive-directory}.
1869
1870 @item G k
1871 @kindex G k (Group)
1872 @findex gnus-group-make-kiboze-group
1873 @cindex nnkiboze
1874 Make a kiboze group.  You will be prompted for a name, for a regexp to
1875 match groups to be ``included'' in the kiboze group, and a series of
1876 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1877 @xref{Kibozed Groups}.
1878
1879 @item G D
1880 @kindex G D (Group)
1881 @findex gnus-group-enter-directory
1882 @cindex nneething
1883 Read an arbitrary directory as if it were a newsgroup with the
1884 @code{nneething} backend (@code{gnus-group-enter-directory}).
1885 @xref{Anything Groups}. 
1886
1887 @item G f
1888 @kindex G f (Group)
1889 @findex gnus-group-make-doc-group
1890 @cindex ClariNet Briefs
1891 @cindex nndoc
1892 Make a group based on some file or other
1893 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1894 command, you will be prompted for a file name and a file type.
1895 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1896 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1897 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1898 this command without a prefix, Gnus will guess at the file type.
1899 @xref{Document Groups}.
1900
1901 @item G w
1902 @kindex G w (Group)
1903 @findex gnus-group-make-web-group
1904 @cindex DejaNews
1905 @cindex Alta Vista
1906 @cindex InReference
1907 @cindex nnweb
1908 Make an ephemeral group based on a web search
1909 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1910 command, make a solid group instead.  You will be prompted for the
1911 search engine type and the search string.  Valid search engine types
1912 include @code{dejanews}, @code{altavista} and @code{reference}.
1913 @xref{Web Searches}.
1914
1915 @item G DEL
1916 @kindex G DEL (Group)
1917 @findex gnus-group-delete-group
1918 This function will delete the current group
1919 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1920 actually delete all the articles in the group, and forcibly remove the
1921 group itself from the face of the Earth.  Use a prefix only if you are
1922 absolutely sure of what you are doing.  This command can't be used on
1923 read-only groups (like @code{nntp} group), though.
1924
1925 @item G V
1926 @kindex G V (Group)
1927 @findex gnus-group-make-empty-virtual
1928 Make a new, fresh, empty @code{nnvirtual} group
1929 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1930
1931 @item G v
1932 @kindex G v (Group)
1933 @findex gnus-group-add-to-virtual
1934 Add the current group to an @code{nnvirtual} group
1935 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1936 @end table
1937
1938 @xref{Select Methods} for more information on the various select
1939 methods. 
1940
1941 @vindex gnus-activate-foreign-newsgroups
1942 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1943 Gnus will check all foreign groups with this level or lower at startup.
1944 This might take quite a while, especially if you subscribe to lots of
1945 groups from different @sc{nntp} servers.
1946
1947
1948 @node Group Parameters
1949 @section Group Parameters
1950 @cindex group parameters
1951
1952 The group parameters store information local to a particular group:
1953
1954 @table @code
1955 @item to-address
1956 @cindex to-address
1957 If the group parameter list contains an element that looks like
1958 @code{(to-address .  "some@@where.com")}, that address will be used by
1959 the backend when doing followups and posts.  This is primarily useful in
1960 mail groups that represent closed mailing lists---mailing lists where
1961 it's expected that everybody that writes to the mailing list is
1962 subscribed to it.  Since using this parameter ensures that the mail only
1963 goes to the mailing list itself, it means that members won't receive two
1964 copies of your followups.
1965
1966 Using @code{to-address} will actually work whether the group is foreign
1967 or not.  Let's say there's a group on the server that is called
1968 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1969 the articles from a mail-to-news gateway.  Posting directly to this
1970 group is therefore impossible---you have to send mail to the mailing
1971 list address instead. 
1972
1973 @item to-list
1974 @cindex to-list
1975 If the group parameter list has an element that looks like
1976 @code{(to-list . "some@@where.com")}, that address will be used when
1977 doing a @kbd{a} in that group.  It is totally ignored when doing a
1978 followup---except that if it is present in a news group, you'll get mail
1979 group semantics when doing @kbd{f}.
1980
1981 If you do an @kbd{a} command in a mail group and you don't have a
1982 @code{to-list} group parameter, one will be added automatically upon
1983 sending the message.
1984
1985 @item visible
1986 @cindex visible
1987 If the group parameter list has the element @code{(visible . t)},
1988 that group will always be visible in the Group buffer, regardless
1989 of whether it has any unread articles.
1990
1991 @item broken-reply-to
1992 @cindex broken-reply-to
1993 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1994 headers in this group are to be ignored.  This can be useful if you're
1995 reading a mailing list group where the listserv has inserted
1996 @code{Reply-To} headers that point back to the listserv itself.  This is
1997 broken behavior.  So there!
1998
1999 @item to-group
2000 @cindex to-group
2001 Elements like @code{(to-group . "some.group.name")} means that all
2002 posts in that group will be sent to @code{some.group.name}.  
2003
2004 @item newsgroup
2005 @cindex newsgroup
2006 If this symbol is present in the group parameter list, Gnus will treat
2007 all responses as if they were responses to news articles.  This can be
2008 useful if you have a mail group that's really a mirror of a news group. 
2009
2010 @item gcc-self
2011 @cindex gcc-self
2012 If this symbol is present in the group parameter list and set to
2013 @code{t}, newly composed messages will be @code{Gcc}'d to the current
2014 group. If it is present and set to @code{none}, no @code{Gcc:} header
2015 will be generated, if it is present and a string, this string will be
2016 inserted literally as a @code{gcc} header (this symbol takes precedence
2017 over any default @code{Gcc} rules as described later).  @xref{Archived
2018 Messages}
2019
2020 @item auto-expire
2021 @cindex auto-expire
2022 If the group parameter has an element that looks like @code{(auto-expire
2023 . t)}, all articles read will be marked as expirable.  For an
2024 alternative approach, @pxref{Expiring Mail}.
2025
2026 @item total-expire
2027 @cindex total-expire
2028 If the group parameter has an element that looks like
2029 @code{(total-expire . t)}, all read articles will be put through the
2030 expiry process, even if they are not marked as expirable.  Use with
2031 caution.  Unread, ticked and dormant articles are not eligible for
2032 expiry.
2033
2034 @item expiry-wait
2035 @cindex expiry-wait
2036 @vindex nnmail-expiry-wait-function
2037 If the group parameter has an element that looks like @code{(expiry-wait
2038 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2039 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2040 The value can either be a number of days (not necessarily an integer) or
2041 the symbols @code{never} or @code{immediate}.
2042
2043 @item score-file
2044 @cindex score file group parameter
2045 Elements that look like @code{(score-file . "file")} will make
2046 @file{file} into the current adaptive score file for the group in
2047 question.  All adaptive score entries will be put into this file.
2048
2049 @item adapt-file
2050 @cindex adapt file group parameter
2051 Elements that look like @code{(adapt-file . "file")} will make
2052 @file{file} into the current adaptive file for the group in question.
2053 All adaptive score entries will be put into this file.
2054
2055 @item admin-address
2056 When unsubscribing from a mailing list you should never send the
2057 unsubscription notice to the mailing list itself.  Instead, you'd send
2058 messages to the administrative address.  This parameter allows you to
2059 put the admin address somewhere convenient.
2060
2061 @item display
2062 Elements that look like @code{(display . MODE)} say which articles to
2063 display on entering the group.  Valid values are:
2064
2065 @table @code
2066 @item all
2067 Display all articles, both read and unread.
2068
2069 @item default
2070 Display the default visible articles, which normally includes unread and
2071 ticked articles.
2072 @end table
2073
2074 @item comment
2075 Elements that look like @code{(comment . "This is a comment")}
2076 are arbitrary comments on the group.  They are currently ignored by
2077 Gnus, but provide a place for you to store information on particular
2078 groups. 
2079
2080 @item @var{(variable form)}
2081 You can use the group parameters to set variables local to the group you
2082 are entering.  If you want to turn threading off in @samp{news.answers},
2083 you could put @code{(gnus-show-threads nil)} in the group parameters of
2084 that group.  @code{gnus-show-threads} will be made into a local variable
2085 in the summary buffer you enter, and the form @code{nil} will be
2086 @code{eval}ed there.
2087
2088 This can also be used as a group-specific hook function, if you'd like.
2089 If you want to hear a beep when you enter a group, you could put
2090 something like @code{(dummy-variable (ding))} in the parameters of that
2091 group.  @code{dummy-variable} will be set to the result of the
2092 @code{(ding)} form, but who cares?
2093
2094 @end table
2095
2096 Use the @kbd{G p} command to edit group parameters of a group.
2097
2098 @pxref{Topic Parameters}.
2099
2100 Here's an example group parameter list:
2101
2102 @example
2103 ((to-address . "ding@@gnus.org")
2104  (auto-expiry . t))
2105 @end example
2106
2107
2108 @node Listing Groups
2109 @section Listing Groups
2110 @cindex group listing
2111
2112 These commands all list various slices of the groups available.
2113
2114 @table @kbd
2115
2116 @item l
2117 @itemx A s
2118 @kindex A s (Group)
2119 @kindex l (Group)
2120 @findex gnus-group-list-groups
2121 List all groups that have unread articles
2122 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2123 command will list only groups of level ARG and lower.  By default, it
2124 only lists groups of level five (i. e.,
2125 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2126 groups).
2127
2128 @item L
2129 @itemx A u
2130 @kindex A u (Group)
2131 @kindex L (Group)
2132 @findex gnus-group-list-all-groups
2133 List all groups, whether they have unread articles or not
2134 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2135 this command will list only groups of level ARG and lower.  By default,
2136 it lists groups of level seven or lower (i.e., just subscribed and
2137 unsubscribed groups).
2138
2139 @item A l
2140 @kindex A l (Group)
2141 @findex gnus-group-list-level
2142 List all unread groups on a specific level
2143 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2144 with no unread articles.
2145
2146 @item A k
2147 @kindex A k (Group)
2148 @findex gnus-group-list-killed
2149 List all killed groups (@code{gnus-group-list-killed}).  If given a
2150 prefix argument, really list all groups that are available, but aren't
2151 currently (un)subscribed.  This could entail reading the active file
2152 from the server.
2153
2154 @item A z
2155 @kindex A z (Group)
2156 @findex gnus-group-list-zombies
2157 List all zombie groups (@code{gnus-group-list-zombies}).
2158
2159 @item A m
2160 @kindex A m (Group)
2161 @findex gnus-group-list-matching
2162 List all unread, subscribed groups with names that match a regexp
2163 (@code{gnus-group-list-matching}). 
2164
2165 @item A M
2166 @kindex A M (Group)
2167 @findex gnus-group-list-all-matching
2168 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2169
2170 @item A A
2171 @kindex A A (Group)
2172 @findex gnus-group-list-active
2173 List absolutely all groups in the active file(s) of the
2174 server(s) you are connected to (@code{gnus-group-list-active}).  This
2175 might very well take quite a while.  It might actually be a better idea
2176 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2177 thing to match on.  Also note that this command may list groups that
2178 don't exist (yet)---these will be listed as if they were killed groups.
2179 Take the output with some grains of salt.
2180
2181 @item A a
2182 @kindex A a (Group)
2183 @findex gnus-group-apropos
2184 List all groups that have names that match a regexp
2185 (@code{gnus-group-apropos}).
2186
2187 @item A d
2188 @kindex A d (Group)
2189 @findex gnus-group-description-apropos
2190 List all groups that have names or descriptions that match a regexp
2191 (@code{gnus-group-description-apropos}).
2192
2193 @end table
2194
2195 @vindex gnus-permanently-visible-groups
2196 @cindex visible group parameter
2197 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2198 always be shown, whether they have unread articles or not.  You can also
2199 add the @code{visible} element to the group parameters in question to
2200 get the same effect.
2201
2202 @vindex gnus-list-groups-with-ticked-articles
2203 Groups that have just ticked articles in it are normally listed in the
2204 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2205 @code{nil}, these groups will be treated just like totally empty
2206 groups.  It is @code{t} by default.
2207
2208
2209 @node Sorting Groups
2210 @section Sorting Groups
2211 @cindex sorting groups
2212
2213 @kindex C-c C-s (Group)
2214 @findex gnus-group-sort-groups
2215 @vindex gnus-group-sort-function
2216 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2217 group buffer according to the function(s) given by the
2218 @code{gnus-group-sort-function} variable.  Available sorting functions
2219 include: 
2220
2221 @table @code
2222
2223 @item gnus-group-sort-by-alphabet
2224 @findex gnus-group-sort-by-alphabet
2225 Sort the group names alphabetically.  This is the default.
2226
2227 @item gnus-group-sort-by-real-name
2228 @findex gnus-group-sort-by-real-name
2229 Sort the group alphabetically on the real (unprefixed) group names.
2230
2231 @item gnus-group-sort-by-level
2232 @findex gnus-group-sort-by-level
2233 Sort by group level.
2234
2235 @item gnus-group-sort-by-score
2236 @findex gnus-group-sort-by-score
2237 Sort by group score.  @xref{Group Score}.
2238
2239 @item gnus-group-sort-by-rank
2240 @findex gnus-group-sort-by-rank
2241 Sort by group score and then the group level.  The level and the score
2242 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2243
2244 @item gnus-group-sort-by-unread
2245 @findex gnus-group-sort-by-unread
2246 Sort by number of unread articles.
2247
2248 @item gnus-group-sort-by-method
2249 @findex gnus-group-sort-by-method
2250 Sort alphabetically on the select method.
2251
2252
2253 @end table
2254
2255 @code{gnus-group-sort-function} can also be a list of sorting
2256 functions.  In that case, the most significant sort key function must be
2257 the last one.
2258
2259
2260 There are also a number of commands for sorting directly according to
2261 some sorting criteria:
2262
2263 @table @kbd
2264 @item G S a
2265 @kindex G S a (Group)
2266 @findex gnus-group-sort-groups-by-alphabet
2267 Sort the group buffer alphabetically by group name
2268 (@code{gnus-group-sort-groups-by-alphabet}). 
2269
2270 @item G S u
2271 @kindex G S u (Group)
2272 @findex gnus-group-sort-groups-by-unread
2273 Sort the group buffer by the number of unread articles
2274 (@code{gnus-group-sort-groups-by-unread}).
2275
2276 @item G S l
2277 @kindex G S l (Group)
2278 @findex gnus-group-sort-groups-by-level
2279 Sort the group buffer by group level
2280 (@code{gnus-group-sort-groups-by-level}). 
2281
2282 @item G S v
2283 @kindex G S v (Group)
2284 @findex gnus-group-sort-groups-by-score
2285 Sort the group buffer by group score
2286 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2287
2288 @item G S r
2289 @kindex G S r (Group)
2290 @findex gnus-group-sort-groups-by-rank
2291 Sort the group buffer by group rank
2292 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2293
2294 @item G S m
2295 @kindex G S m (Group)
2296 @findex gnus-group-sort-groups-by-method
2297 Sort the group buffer alphabetically by backend name
2298 (@code{gnus-group-sort-groups-by-method}). 
2299
2300 @end table
2301
2302 When given a prefix, all these commands will sort in reverse order. 
2303
2304 You can also sort a subset of the groups:
2305
2306 @table @kbd
2307 @item G P a
2308 @kindex G P a (Group)
2309 @findex gnus-group-sort-selected-groups-by-alphabet
2310 Sort the process/prefixed groups in the group buffer alphabetically by
2311 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2312
2313 @item G P u
2314 @kindex G P u (Group)
2315 @findex gnus-group-sort-selected-groups-by-unread
2316 Sort the process/prefixed groups in the group buffer by the number of
2317 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2318
2319 @item G P l
2320 @kindex G P l (Group)
2321 @findex gnus-group-sort-selected-groups-by-level
2322 Sort the process/prefixed groups in the group buffer by group level
2323 (@code{gnus-group-sort-selected-groups-by-level}).
2324
2325 @item G P v
2326 @kindex G P v (Group)
2327 @findex gnus-group-sort-selected-groups-by-score
2328 Sort the process/prefixed groups in the group buffer by group score
2329 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2330
2331 @item G P r
2332 @kindex G P r (Group)
2333 @findex gnus-group-sort-selected-groups-by-rank
2334 Sort the process/prefixed groups in the group buffer by group rank
2335 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2336
2337 @item G P m
2338 @kindex G P m (Group)
2339 @findex gnus-group-sort-selected-groups-by-method
2340 Sort the process/prefixed groups in the group buffer alphabetically by
2341 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2342
2343 @end table
2344
2345
2346
2347 @node Group Maintenance
2348 @section Group Maintenance
2349 @cindex bogus groups
2350
2351 @table @kbd
2352 @item b
2353 @kindex b (Group)
2354 @findex gnus-group-check-bogus-groups
2355 Find bogus groups and delete them
2356 (@code{gnus-group-check-bogus-groups}).
2357
2358 @item F
2359 @kindex F (Group)
2360 @findex gnus-group-find-new-groups
2361 Find new groups and process them (@code{gnus-group-find-new-groups}).
2362 If given a prefix, use the @code{ask-server} method to query the server
2363 for new groups.
2364
2365 @item C-c C-x
2366 @kindex C-c C-x (Group)
2367 @findex gnus-group-expire-articles
2368 Run all expirable articles in the current group through the expiry
2369 process (if any) (@code{gnus-group-expire-articles}).
2370
2371 @item C-c M-C-x
2372 @kindex C-c M-C-x (Group)
2373 @findex gnus-group-expire-all-groups
2374 Run all articles in all groups through the expiry process
2375 (@code{gnus-group-expire-all-groups}).
2376
2377 @end table
2378
2379
2380 @node Browse Foreign Server
2381 @section Browse Foreign Server
2382 @cindex foreign servers
2383 @cindex browsing servers
2384
2385 @table @kbd
2386 @item B
2387 @kindex B (Group)
2388 @findex gnus-group-browse-foreign-server
2389 You will be queried for a select method and a server name.  Gnus will
2390 then attempt to contact this server and let you browse the groups there
2391 (@code{gnus-group-browse-foreign-server}).
2392 @end table
2393
2394 @findex gnus-browse-mode
2395 A new buffer with a list of available groups will appear.  This buffer
2396 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2397 a lot) like a normal group buffer.
2398
2399 Here's a list of keystrokes available in the browse mode:
2400
2401 @table @kbd
2402 @item n
2403 @kindex n (Browse)
2404 @findex gnus-group-next-group
2405 Go to the next group (@code{gnus-group-next-group}).
2406
2407 @item p
2408 @kindex p (Browse)
2409 @findex gnus-group-prev-group
2410 Go to the previous group (@code{gnus-group-prev-group}).
2411
2412 @item SPACE
2413 @kindex SPACE (Browse)
2414 @findex gnus-browse-read-group
2415 Enter the current group and display the first article
2416 (@code{gnus-browse-read-group}). 
2417
2418 @item RET
2419 @kindex RET (Browse)
2420 @findex gnus-browse-select-group
2421 Enter the current group (@code{gnus-browse-select-group}). 
2422
2423 @item u
2424 @kindex u (Browse)
2425 @findex gnus-browse-unsubscribe-current-group
2426 Unsubscribe to the current group, or, as will be the case here,
2427 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
2428
2429 @item l
2430 @itemx q
2431 @kindex q (Browse)
2432 @kindex l (Browse)
2433 @findex gnus-browse-exit
2434 Exit browse mode (@code{gnus-browse-exit}).
2435
2436 @item ?
2437 @kindex ? (Browse)
2438 @findex gnus-browse-describe-briefly
2439 Describe browse mode briefly (well, there's not much to describe, is
2440 there) (@code{gnus-browse-describe-briefly}).
2441 @end table
2442
2443
2444 @node Exiting Gnus
2445 @section Exiting Gnus
2446 @cindex exiting Gnus
2447
2448 Yes, Gnus is ex(c)iting.
2449
2450 @table @kbd
2451 @item z
2452 @kindex z (Group)
2453 @findex gnus-group-suspend
2454 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2455 but it kills all buffers except the Group buffer.  I'm not sure why this
2456 is a gain, but then who am I to judge?
2457
2458 @item q
2459 @kindex q (Group)
2460 @findex gnus-group-exit
2461 @c @icon{gnus-group-exit}
2462 Quit Gnus (@code{gnus-group-exit}).
2463
2464 @item Q
2465 @kindex Q (Group)
2466 @findex gnus-group-quit
2467 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2468 The dribble file will be saved, though (@pxref{Auto Save}).
2469 @end table
2470
2471 @vindex gnus-exit-gnus-hook
2472 @vindex gnus-suspend-gnus-hook
2473 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2474 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2475 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2476 exiting Gnus.
2477
2478 @findex gnus-unload
2479 @cindex unloading
2480 If you wish to completely unload Gnus and all its adherents, you can use
2481 the @code{gnus-unload} command.  This command is also very handy when
2482 trying to customize meta-variables.
2483
2484 Note:
2485
2486 @quotation
2487 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2488 numbly heavy and herself fall into a hazy trance as the boy sitting
2489 behind her drew repeated lines with his pencil across the back of her
2490 plastic chair.
2491 @end quotation
2492
2493
2494 @node Group Topics
2495 @section Group Topics
2496 @cindex topics
2497
2498 If you read lots and lots of groups, it might be convenient to group
2499 them hierarchically according to topics.  You put your Emacs groups over
2500 here, your sex groups over there, and the rest (what, two groups or so?)
2501 you put in some misc section that you never bother with anyway.  You can
2502 even group the Emacs sex groups as a sub-topic to either the Emacs
2503 groups or the sex groups---or both!  Go wild!
2504
2505 @iftex
2506 @iflatex
2507 \gnusfigure{Group Topics}{400}{
2508 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2509 }
2510 @end iflatex
2511 @end iftex
2512
2513 Here's an example:
2514
2515 @example
2516 Gnus
2517   Emacs -- I wuw it!
2518      3: comp.emacs
2519      2: alt.religion.emacs
2520     Naughty Emacs
2521      452: alt.sex.emacs
2522        0: comp.talk.emacs.recovery
2523   Misc
2524      8: comp.binaries.fractals
2525     13: comp.sources.unix
2526 @end example
2527
2528 @findex gnus-topic-mode
2529 @kindex t (Group)
2530 To get this @emph{fab} functionality you simply turn on (ooh!) the
2531 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2532 is a toggling command.)
2533
2534 Go ahead, just try it.  I'll still be here when you get back.  La de
2535 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2536 press @kbd{l}.  There.  All your groups are now listed under
2537 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2538 bothered?
2539
2540 If you want this permanently enabled, you should add that minor mode to
2541 the hook for the group mode:
2542
2543 @lisp
2544 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2545 @end lisp
2546
2547 @menu 
2548 * Topic Variables::    How to customize the topics the Lisp Way.
2549 * Topic Commands::     Interactive E-Z commands.
2550 * Topic Sorting::      Sorting each topic individually.
2551 * Topic Topology::     A map of the world.
2552 * Topic Parameters::   Parameters that apply to all groups in a topic.
2553 @end menu
2554
2555
2556 @node Topic Variables
2557 @subsection Topic Variables
2558 @cindex topic variables
2559
2560 Now, if you select a topic, it will fold/unfold that topic, which is
2561 really neat, I think.
2562
2563 @vindex gnus-topic-line-format
2564 The topic lines themselves are created according to the
2565 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2566 Valid elements are:
2567
2568 @table @samp
2569 @item i
2570 Indentation.
2571 @item n
2572 Topic name.
2573 @item v
2574 Visibility.
2575 @item l
2576 Level.
2577 @item g
2578 Number of groups in the topic.
2579 @item a
2580 Number of unread articles in the topic.
2581 @item A 
2582 Number of unread articles in the topic and all its subtopics. 
2583 @end table
2584
2585 @vindex gnus-topic-indent-level
2586 Each sub-topic (and the groups in the sub-topics) will be indented with
2587 @code{gnus-topic-indent-level} times the topic level number of spaces.
2588 The default is 2.
2589
2590 @vindex gnus-topic-mode-hook
2591 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2592
2593 @vindex gnus-topic-display-empty-topics
2594 The @code{gnus-topic-display-empty-topics} says whether to display even
2595 topics that have no unread articles in them.  The default is @code{t}.
2596
2597
2598 @node Topic Commands
2599 @subsection Topic Commands
2600 @cindex topic commands
2601
2602 When the topic minor mode is turned on, a new @kbd{T} submap will be
2603 available.  In addition, a few of the standard keys change their
2604 definitions slightly.
2605
2606 @table @kbd
2607
2608 @item T n
2609 @kindex T n (Topic)
2610 @findex gnus-topic-create-topic
2611 Prompt for a new topic name and create it 
2612 (@code{gnus-topic-create-topic}). 
2613
2614 @item T m
2615 @kindex T m (Topic)
2616 @findex gnus-topic-move-group
2617 Move the current group to some other topic
2618 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2619 convention (@pxref{Process/Prefix}).
2620
2621 @item T c
2622 @kindex T c (Topic)
2623 @findex gnus-topic-copy-group
2624 Copy the current group to some other topic
2625 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2626 convention (@pxref{Process/Prefix}).
2627
2628 @item T D
2629 @kindex T D (Topic)
2630 @findex gnus-topic-remove-group
2631 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2632 This command uses the process/prefix convention
2633 (@pxref{Process/Prefix}).
2634
2635 @item T M
2636 @kindex T M (Topic)
2637 @findex gnus-topic-move-matching
2638 Move all groups that match some regular expression to a topic
2639 (@code{gnus-topic-move-matching}). 
2640
2641 @item T C
2642 @kindex T C (Topic)
2643 @findex gnus-topic-copy-matching
2644 Copy all groups that match some regular expression to a topic
2645 (@code{gnus-topic-copy-matching}). 
2646
2647 @item T h
2648 @kindex T h (Topic)
2649 @findex gnus-topic-toggle-display-empty-topics
2650 Toggle hiding empty topics
2651 (@code{gnus-topic-toggle-display-empty-topics}). 
2652
2653 @item T #
2654 @kindex T # (Topic)
2655 @findex gnus-topic-mark-topic
2656 Mark all groups in the current topic with the process mark
2657 (@code{gnus-topic-mark-topic}). 
2658
2659 @item T M-#
2660 @kindex T M-# (Topic)
2661 @findex gnus-topic-unmark-topic
2662 Remove the process mark from all groups in the current topic
2663 (@code{gnus-topic-unmark-topic}). 
2664
2665 @item RET
2666 @kindex RET (Topic)
2667 @findex gnus-topic-select-group
2668 @itemx SPACE
2669 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2670 When you perform this command on a group, you'll enter the group, as
2671 usual.  When done on a topic line, the topic will be folded (if it was
2672 visible) or unfolded (if it was folded already).  So it's basically a
2673 toggling command on topics.  In addition, if you give a numerical
2674 prefix, group on that level (and lower) will be displayed.
2675
2676 @item T TAB
2677 @kindex T TAB (Topic)
2678 @findex gnus-topic-indent
2679 ``Indent'' the current topic so that it becomes a sub-topic of the
2680 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2681 ``un-indent'' the topic instead.
2682
2683 @item C-k
2684 @kindex C-k (Topic)
2685 @findex gnus-topic-kill-group
2686 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2687 topic will be removed along with the topic.
2688
2689 @item C-y
2690 @kindex C-y (Topic)
2691 @findex gnus-topic-yank-group
2692 Yank the previously killed group or topic
2693 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2694 before all groups. 
2695
2696 @item T r
2697 @kindex T r (Topic)
2698 @findex gnus-topic-rename
2699 Rename a topic (@code{gnus-topic-rename}). 
2700
2701 @item T DEL
2702 @kindex T DEL (Topic)
2703 @findex gnus-topic-delete
2704 Delete an empty topic (@code{gnus-topic-delete}). 
2705
2706 @item A T
2707 @kindex A T (Topic)
2708 @findex gnus-topic-list-active
2709 List all groups that Gnus knows about in a topics-ified way
2710 (@code{gnus-topic-list-active}).
2711
2712 @item G p
2713 @kindex G p (Topic)
2714 @findex gnus-topic-edit-parameters
2715 @cindex group parameters
2716 @cindex topic parameters
2717 @cindex parameters
2718 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2719 @xref{Topic Parameters}.
2720
2721 @end table
2722
2723
2724 @node Topic Sorting
2725 @subsection Topic Sorting
2726 @cindex topic sorting
2727
2728 You can sort the groups in each topic individually with the following
2729 commands: 
2730
2731
2732 @table @kbd
2733 @item T S a
2734 @kindex T S a (Topic)
2735 @findex gnus-topic-sort-groups-by-alphabet
2736 Sort the current topic alphabetically by group name
2737 (@code{gnus-topic-sort-groups-by-alphabet}). 
2738
2739 @item T S u
2740 @kindex T S u (Topic)
2741 @findex gnus-topic-sort-groups-by-unread
2742 Sort the current topic by the number of unread articles
2743 (@code{gnus-topic-sort-groups-by-unread}).
2744
2745 @item T S l
2746 @kindex T S l (Topic)
2747 @findex gnus-topic-sort-groups-by-level
2748 Sort the current topic by group level
2749 (@code{gnus-topic-sort-groups-by-level}). 
2750
2751 @item T S v
2752 @kindex T S v (Topic)
2753 @findex gnus-topic-sort-groups-by-score
2754 Sort the current topic by group score
2755 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2756
2757 @item T S r
2758 @kindex T S r (Topic)
2759 @findex gnus-topic-sort-groups-by-rank
2760 Sort the current topic by group rank
2761 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2762
2763 @item T S m
2764 @kindex T S m (Topic)
2765 @findex gnus-topic-sort-groups-by-method
2766 Sort the current topic alphabetically by backend name
2767 (@code{gnus-topic-sort-groups-by-method}). 
2768
2769 @end table
2770
2771 @xref{Sorting Groups} for more information about group sorting. 
2772
2773
2774 @node Topic Topology
2775 @subsection Topic Topology
2776 @cindex topic topology
2777 @cindex topology
2778
2779 So, let's have a look at an example group buffer:
2780
2781 @example
2782 Gnus
2783   Emacs -- I wuw it!
2784      3: comp.emacs
2785      2: alt.religion.emacs
2786     Naughty Emacs
2787      452: alt.sex.emacs
2788        0: comp.talk.emacs.recovery
2789   Misc
2790      8: comp.binaries.fractals
2791     13: comp.sources.unix
2792 @end example
2793
2794 So, here we have one top-level topic (@samp{Gnus}), two topics under
2795 that, and one sub-topic under one of the sub-topics.  (There is always
2796 just one (1) top-level topic).  This topology can be expressed as
2797 follows:
2798
2799 @lisp
2800 (("Gnus" visible)
2801  (("Emacs -- I wuw it!" visible) 
2802   (("Naughty Emacs" visible)))
2803  (("Misc" visible)))
2804 @end lisp
2805
2806 @vindex gnus-topic-topology
2807 This is in fact how the variable @code{gnus-topic-topology} would look
2808 for the display above.  That variable is saved in the @file{.newsrc.eld}
2809 file, and shouldn't be messed with manually---unless you really want
2810 to.  Since this variable is read from the @file{.newsrc.eld} file,
2811 setting it in any other startup files will have no effect.  
2812
2813 This topology shows what topics are sub-topics of what topics (right),
2814 and which topics are visible.  Two settings are currently
2815 allowed---@code{visible} and @code{invisible}.
2816
2817
2818 @node Topic Parameters
2819 @subsection Topic Parameters
2820 @cindex topic parameters
2821
2822 All groups in a topic will inherit group parameters from the parent (and
2823 ancestor) topic parameters.  All valid group parameters are valid topic
2824 parameters (@pxref{Group Parameters}).  
2825
2826 Group parameters (of course) override topic parameters, and topic
2827 parameters in sub-topics override topic parameters in super-topics.  You
2828 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2829 verb, although you may feel free to disagree with me here.)
2830
2831 @example
2832 Gnus
2833   Emacs
2834      3: comp.emacs
2835      2: alt.religion.emacs
2836    452: alt.sex.emacs
2837     Relief
2838      452: alt.sex.emacs
2839        0: comp.talk.emacs.recovery
2840   Misc
2841      8: comp.binaries.fractals
2842     13: comp.sources.unix
2843    452: alt.sex.emacs
2844 @end example
2845
2846 The @samp{Emacs} topic has the topic parameter @code{(score-file
2847 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2848 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2849 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2850 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2851 . "religion.SCORE")}.
2852
2853 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2854 will get the @file{relief.SCORE} home score file.  If you enter the same
2855 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2856 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2857 get the @file{religion.SCORE} home score file.
2858
2859 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2860 there are some problems, especially with the @code{total-expiry}
2861 parameter.  Say you have a mail group in two topics; one with
2862 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2863 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2864 of these topics you mean to expire articles from, so anything may
2865 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2866 happens.  You just have to be careful if you do stuff like that.
2867
2868
2869 @node Misc Group Stuff
2870 @section Misc Group Stuff
2871
2872 @menu
2873 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2874 * Group Information::     Information and help on groups and Gnus.
2875 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2876 * File Commands::         Reading and writing the Gnus files.
2877 @end menu
2878
2879 @table @kbd
2880
2881 @item ^
2882 @kindex ^ (Group)
2883 @findex gnus-group-enter-server-mode
2884 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2885 @xref{The Server Buffer}.
2886
2887 @item a
2888 @kindex a (Group)
2889 @findex gnus-group-post-news
2890 Post an article to a group (@code{gnus-group-post-news}).  If given a
2891 prefix, the current group name will be used as the default.
2892
2893 @item m
2894 @kindex m (Group)
2895 @findex gnus-group-mail
2896 Mail a message somewhere (@code{gnus-group-mail}).
2897
2898 @end table
2899
2900 Variables for the group buffer:
2901
2902 @table @code
2903
2904 @item gnus-group-mode-hook
2905 @vindex gnus-group-mode-hook
2906 is called after the group buffer has been
2907 created. 
2908
2909 @item gnus-group-prepare-hook
2910 @vindex gnus-group-prepare-hook
2911 is called after the group buffer is
2912 generated.  It may be used to modify the buffer in some strange,
2913 unnatural way.
2914
2915 @item gnus-group-prepared-hook
2916 @vindex gnus-group-prepare-hook
2917 is called as the very last thing after the group buffer has been
2918 generated.  It may be used to move point around, for instance.
2919
2920 @item gnus-permanently-visible-groups
2921 @vindex gnus-permanently-visible-groups
2922 Groups matching this regexp will always be listed in the group buffer,
2923 whether they are empty or not.
2924
2925 @end table
2926
2927
2928 @node Scanning New Messages
2929 @subsection Scanning New Messages
2930 @cindex new messages
2931 @cindex scanning new news
2932
2933 @table @kbd
2934
2935 @item g
2936 @kindex g (Group)
2937 @findex gnus-group-get-new-news
2938 @c @icon{gnus-group-get-new-news}
2939 Check the server(s) for new articles.  If the numerical prefix is used,
2940 this command will check only groups of level @var{arg} and lower
2941 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2942 command will force a total re-reading of the active file(s) from the
2943 backend(s).
2944
2945 @item M-g
2946 @kindex M-g (Group)
2947 @findex gnus-group-get-new-news-this-group
2948 @vindex gnus-goto-next-group-when-activating
2949 @c @icon{gnus-group-get-new-news-this-group}
2950 Check whether new articles have arrived in the current group
2951 (@code{gnus-group-get-new-news-this-group}).
2952 @code{gnus-goto-next-group-when-activating} says whether this command is
2953 to move point to the next group or not.  It is @code{t} by default.
2954
2955 @findex gnus-activate-all-groups
2956 @cindex activating groups
2957 @item C-c M-g
2958 @kindex C-c M-g (Group)
2959 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2960
2961 @item R
2962 @kindex R (Group)
2963 @cindex restarting
2964 @findex gnus-group-restart
2965 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2966 file(s), closes the connection to all servers, clears up all run-time
2967 Gnus variables, and then starts Gnus all over again.
2968
2969 @end table
2970
2971 @vindex gnus-get-new-news-hook
2972 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2973
2974 @vindex gnus-after-getting-new-news-hook
2975 @code{gnus-after-getting-new-news-hook} is run after checking for new
2976 news.
2977
2978
2979 @node Group Information
2980 @subsection Group Information
2981 @cindex group information
2982 @cindex information on groups
2983
2984 @table @kbd
2985
2986
2987 @item H f
2988 @kindex H f (Group)
2989 @findex gnus-group-fetch-faq
2990 @vindex gnus-group-faq-directory
2991 @cindex FAQ
2992 @cindex ange-ftp
2993 Try to fetch the FAQ for the current group
2994 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2995 @code{gnus-group-faq-directory}, which is usually a directory on a
2996 remote machine.  This variable can also be a list of directories.  In
2997 that case, giving a prefix to this command will allow you to choose
2998 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2999 for fetching the file.
3000
3001 If fetching from the first site is unsuccessful, Gnus will attempt to go
3002 through @code{gnus-group-faq-directory} and try to open them one by one.
3003
3004 @item H d
3005 @itemx C-c C-d
3006 @c @icon{gnus-group-describe-group}
3007 @kindex H d (Group)
3008 @kindex C-c C-d (Group)
3009 @cindex describing groups
3010 @cindex group description
3011 @findex gnus-group-describe-group
3012 Describe the current group (@code{gnus-group-describe-group}).  If given
3013 a prefix, force Gnus to re-read the description from the server.
3014
3015 @item M-d
3016 @kindex M-d (Group)
3017 @findex gnus-group-describe-all-groups
3018 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3019 prefix, force Gnus to re-read the description file from the server.
3020
3021 @item H v
3022 @itemx V
3023 @kindex V (Group)
3024 @kindex H v (Group)
3025 @cindex version
3026 @findex gnus-version
3027 Display current Gnus version numbers (@code{gnus-version}).
3028
3029 @item ?
3030 @kindex ? (Group)
3031 @findex gnus-group-describe-briefly
3032 Give a very short help message (@code{gnus-group-describe-briefly}).
3033
3034 @item C-c C-i
3035 @kindex C-c C-i (Group)
3036 @cindex info
3037 @cindex manual
3038 @findex gnus-info-find-node
3039 Go to the Gnus info node (@code{gnus-info-find-node}).
3040 @end table
3041
3042
3043 @node Group Timestamp
3044 @subsection Group Timestamp
3045 @cindex timestamps
3046 @cindex group timestamps
3047
3048 It can be convenient to let Gnus keep track of when you last read a
3049 group.  To set the ball rolling, you should add
3050 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3051
3052 @lisp
3053 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3054 @end lisp
3055
3056 After doing this, each time you enter a group, it'll be recorded.
3057
3058 This information can be displayed in various ways---the easiest is to
3059 use the @samp{%d} spec in the group line format:
3060
3061 @lisp
3062 (setq gnus-group-line-format 
3063       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3064 @end lisp
3065
3066 This will result in lines looking like:
3067
3068 @example
3069 *        0: mail.ding                                19961002T012943
3070          0: custom                                   19961002T012713
3071 @end example
3072
3073 As you can see, the date is displayed in compact ISO 8601 format.  This
3074 may be a bit too much, so to just display the date, you could say
3075 something like:
3076
3077 @lisp
3078 (setq gnus-group-line-format 
3079       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3080 @end lisp
3081
3082
3083 @node File Commands
3084 @subsection File Commands
3085 @cindex file commands
3086
3087 @table @kbd
3088
3089 @item r
3090 @kindex r (Group)
3091 @findex gnus-group-read-init-file
3092 @vindex gnus-init-file
3093 @cindex reading init file
3094 Re-read the init file (@code{gnus-init-file}, which defaults to
3095 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3096
3097 @item s
3098 @kindex s (Group)
3099 @findex gnus-group-save-newsrc
3100 @cindex saving .newsrc
3101 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3102 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3103 file(s) whether Gnus thinks it is necessary or not.
3104
3105 @c @item Z
3106 @c @kindex Z (Group)
3107 @c @findex gnus-group-clear-dribble
3108 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3109
3110 @end table
3111
3112
3113 @node The Summary Buffer
3114 @chapter The Summary Buffer
3115 @cindex summary buffer
3116
3117 A line for each article is displayed in the summary buffer.  You can
3118 move around, read articles, post articles and reply to articles.
3119
3120 The most common way to a summary buffer is to select a group from the
3121 group buffer (@pxref{Selecting a Group}).  
3122
3123 You can have as many summary buffers open as you wish.
3124
3125 @menu
3126 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3127 * Summary Maneuvering::         Moving around the summary buffer.
3128 * Choosing Articles::           Reading articles.
3129 * Paging the Article::          Scrolling the current article.
3130 * Reply Followup and Post::     Posting articles.
3131 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3132 * Marking Articles::            Marking articles as read, expirable, etc.
3133 * Limiting::                    You can limit the summary buffer.
3134 * Threading::                   How threads are made.
3135 * Sorting::                     How articles and threads are sorted.
3136 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3137 * Article Caching::             You may store articles in a cache.
3138 * Persistent Articles::         Making articles expiry-resistant.
3139 * Article Backlog::             Having already read articles hang around.
3140 * Saving Articles::             Ways of customizing article saving.
3141 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3142 * Article Treatment::           The article buffer can be mangled at will.
3143 * Article Commands::            Doing various things with the article buffer.
3144 * Summary Sorting::             Sorting the summary buffer in various ways.
3145 * Finding the Parent::          No child support? Get the parent.
3146 * Alternative Approaches::      Reading using non-default summaries.
3147 * Tree Display::                A more visual display of threads.
3148 * Mail Group Commands::         Some commands can only be used in mail groups.
3149 * Various Summary Stuff::       What didn't fit anywhere else.
3150 * Exiting the Summary Buffer::  Returning to the Group buffer.
3151 * Crosspost Handling::          How crossposted articles are dealt with.
3152 * Duplicate Suppression::       An alternative when crosspost handling fails.
3153 @end menu
3154
3155
3156 @node Summary Buffer Format
3157 @section Summary Buffer Format
3158 @cindex summary buffer format
3159
3160 @iftex
3161 @iflatex
3162 \gnusfigure{The Summary Buffer}{180}{
3163 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3164 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3165 }
3166 @end iflatex
3167 @end iftex
3168
3169 @menu
3170 * Summary Buffer Lines::     You can specify how summary lines should look.
3171 * Summary Buffer Mode Line:: You can say how the mode line should look.
3172 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3173 @end menu
3174
3175 @findex mail-extract-address-components
3176 @findex gnus-extract-address-components
3177 @vindex gnus-extract-address-components
3178 Gnus will use the value of the @code{gnus-extract-address-components}
3179 variable as a function for getting the name and address parts of a
3180 @code{From} header.  Two pre-defined functions exist:
3181 @code{gnus-extract-address-components}, which is the default, quite
3182 fast, and too simplistic solution; and
3183 @code{mail-extract-address-components}, which works very nicely, but is
3184 slower.  The default function will return the wrong answer in 5% of the
3185 cases.  If this is unacceptable to you, use the other function instead.
3186
3187 @vindex gnus-summary-same-subject
3188 @code{gnus-summary-same-subject} is a string indicating that the current
3189 article has the same subject as the previous.  This string will be used
3190 with those specs that require it.  The default is @code{""}.
3191
3192
3193 @node Summary Buffer Lines
3194 @subsection Summary Buffer Lines
3195
3196 @vindex gnus-summary-line-format
3197 You can change the format of the lines in the summary buffer by changing
3198 the @code{gnus-summary-line-format} variable.  It works along the same
3199 lines as a normal @code{format} string, with some extensions
3200 (@pxref{Formatting Variables}).
3201
3202 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3203
3204 The following format specification characters are understood:
3205
3206 @table @samp
3207 @item N 
3208 Article number.
3209 @item S
3210 Subject string.
3211 @item s
3212 Subject if the article is the root of the thread or the previous article
3213 had a different subject, @code{gnus-summary-same-subject} otherwise.
3214 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3215 @item F
3216 Full @code{From} header.
3217 @item n
3218 The name (from the @code{From} header).
3219 @item a
3220 The name (from the @code{From} header).  This differs from the @code{n}
3221 spec in that it uses the function designated by the
3222 @code{gnus-extract-address-components} variable, which is slower, but
3223 may be more thorough.
3224 @item A
3225 The address (from the @code{From} header).  This works the same way as
3226 the @code{a} spec.
3227 @item L
3228 Number of lines in the article.
3229 @item c
3230 Number of characters in the article.
3231 @item I
3232 Indentation based on thread level (@pxref{Customizing Threading}).
3233 @item T
3234 Nothing if the article is a root and lots of spaces if it isn't (it
3235 pushes everything after it off the screen).
3236 @item [
3237 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3238 for adopted articles (@pxref{Customizing Threading}).
3239 @item ]
3240 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3241 for adopted articles.
3242 @item >
3243 One space for each thread level.
3244 @item <
3245 Twenty minus thread level spaces.
3246 @item U
3247 Unread.
3248 @item R
3249 Replied.
3250 @item i
3251 Score as a number (@pxref{Scoring}).
3252 @item z
3253 @vindex gnus-summary-zcore-fuzz
3254 Zcore, @samp{+} if above the default level and @samp{-} if below the
3255 default level.  If the difference between
3256 @code{gnus-summary-default-level} and the score is less than
3257 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3258 @item V
3259 Total thread score.
3260 @item x
3261 @code{Xref}.
3262 @item D
3263 @code{Date}.
3264 @item d
3265 The @code{Date} in @code{DD-MMM} format.
3266 @item o
3267 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3268 @item M
3269 @code{Message-ID}.
3270 @item r
3271 @code{References}.
3272 @item t
3273 Number of articles in the current sub-thread.  Using this spec will slow
3274 down summary buffer generation somewhat.
3275 @item e
3276 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3277 article has any children.
3278 @item P
3279 The line number.
3280 @item O
3281 Download mark.
3282 @item u
3283 User defined specifier.  The next character in the format string should
3284 be a letter.  Gnus will call the function
3285 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3286 following @samp{%u}.  The function will be passed the current header as
3287 argument.  The function should return a string, which will be inserted
3288 into the summary just like information from any other summary specifier.
3289 @end table
3290
3291 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3292 have to be handled with care.  For reasons of efficiency, Gnus will
3293 compute what column these characters will end up in, and ``hard-code''
3294 that.  This means that it is invalid to have these specs after a
3295 variable-length spec.  Well, you might not be arrested, but your summary
3296 buffer will look strange, which is bad enough.
3297
3298 The smart choice is to have these specs as far to the left as possible.
3299 (Isn't that the case with everything, though?  But I digress.)
3300
3301 This restriction may disappear in later versions of Gnus.
3302
3303
3304 @node Summary Buffer Mode Line
3305 @subsection Summary Buffer Mode Line
3306
3307 @vindex gnus-summary-mode-line-format
3308 You can also change the format of the summary mode bar.  Set
3309 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3310 is @samp{Gnus: %%b [%A] %Z}.  
3311
3312 Here are the elements you can play with:
3313
3314 @table @samp
3315 @item G
3316 Group name.
3317 @item p
3318 Unprefixed group name.
3319 @item A
3320 Current article number.
3321 @item V
3322 Gnus version.
3323 @item U
3324 Number of unread articles in this group.
3325 @item e
3326 Number of unread articles in this group that aren't displayed in the
3327 summary buffer.
3328 @item Z
3329 A string with the number of unread and unselected articles represented
3330 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3331 articles, and just as @samp{<%U more>} if there are just unread articles
3332 and no unselected ones.
3333 @item g
3334 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3335 shortened to @samp{r.a.anime}. 
3336 @item S
3337 Subject of the current article.
3338 @item u
3339 User-defined spec (@pxref{User-Defined Specs}).
3340 @item s
3341 Name of the current score file (@pxref{Scoring}).
3342 @item d
3343 Number of dormant articles (@pxref{Unread Articles}).
3344 @item t
3345 Number of ticked articles (@pxref{Unread Articles}).
3346 @item r
3347 Number of articles that have been marked as read in this session. 
3348 @item E
3349 Number of articles expunged by the score files.
3350 @end table
3351
3352
3353 @node Summary Highlighting
3354 @subsection Summary Highlighting
3355
3356 @table @code
3357
3358 @item gnus-visual-mark-article-hook
3359 @vindex gnus-visual-mark-article-hook
3360 This hook is run after selecting an article.  It is meant to be used for
3361 highlighting the article in some way.  It is not run if
3362 @code{gnus-visual} is @code{nil}.
3363
3364 @item gnus-summary-update-hook
3365 @vindex gnus-summary-update-hook
3366 This hook is called when a summary line is changed.  It is not run if
3367 @code{gnus-visual} is @code{nil}.
3368
3369 @item gnus-summary-selected-face
3370 @vindex gnus-summary-selected-face
3371 This is the face (or @dfn{font} as some people call it) used to
3372 highlight the current article in the summary buffer.
3373
3374 @item gnus-summary-highlight
3375 @vindex gnus-summary-highlight
3376 Summary lines are highlighted according to this variable, which is a
3377 list where the elements are of the format @var{(FORM . FACE)}.  If you
3378 would, for instance, like ticked articles to be italic and high-scored
3379 articles to be bold, you could set this variable to something like
3380 @lisp
3381 (((eq mark gnus-ticked-mark) . italic)
3382  ((> score default) . bold))
3383 @end lisp
3384 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3385 @var{FACE} will be applied to the line.
3386 @end table
3387
3388
3389 @node Summary Maneuvering
3390 @section Summary Maneuvering
3391 @cindex summary movement
3392
3393 All the straight movement commands understand the numeric prefix and
3394 behave pretty much as you'd expect. 
3395
3396 None of these commands select articles.
3397
3398 @table @kbd
3399 @item G M-n
3400 @itemx M-n
3401 @kindex M-n (Summary)
3402 @kindex G M-n (Summary)
3403 @findex gnus-summary-next-unread-subject
3404 Go to the next summary line of an unread article
3405 (@code{gnus-summary-next-unread-subject}). 
3406
3407 @item G M-p
3408 @itemx M-p
3409 @kindex M-p (Summary)
3410 @kindex G M-p (Summary)
3411 @findex gnus-summary-prev-unread-subject
3412 Go to the previous summary line of an unread article
3413 (@code{gnus-summary-prev-unread-subject}). 
3414
3415 @item G j
3416 @itemx j
3417 @kindex j (Summary)
3418 @kindex G j (Summary)
3419 @findex gnus-summary-goto-article
3420 Ask for an article number or @code{Message-ID}, and then go to that
3421 article (@code{gnus-summary-goto-article}).
3422
3423 @item G g
3424 @kindex G g (Summary)
3425 @findex gnus-summary-goto-subject
3426 Ask for an article number and then go to the summary line of that article
3427 without displaying the article (@code{gnus-summary-goto-subject}).
3428 @end table
3429
3430 If Gnus asks you to press a key to confirm going to the next group, you
3431 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3432 buffer, searching for the next group to read without actually returning
3433 to the group buffer.
3434
3435 Variables related to summary movement:
3436
3437 @table @code
3438
3439 @vindex gnus-auto-select-next
3440 @item gnus-auto-select-next
3441 If you issue one of the movement commands (like @kbd{n}) and there are
3442 no more unread articles after the current one, Gnus will offer to go to
3443 the next group.  If this variable is @code{t} and the next group is
3444 empty, Gnus will exit summary mode and return to the group buffer.  If
3445 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3446 next group, no matter whether it has any unread articles or not.  As a
3447 special case, if this variable is @code{quietly}, Gnus will select the
3448 next group without asking for confirmation.  If this variable is
3449 @code{almost-quietly}, the same will happen only if you are located on
3450 the last article in the group.  Finally, if this variable is
3451 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3452 without confirmation.  Also @pxref{Group Levels}.
3453
3454 @item gnus-auto-select-same
3455 @vindex gnus-auto-select-same
3456 If non-@code{nil}, all the movement commands will try to go to the next
3457 article with the same subject as the current.  (@dfn{Same} here might
3458 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3459 for details (@pxref{Customizing Threading}).)  This variable is not
3460 particularly useful if you use a threaded display.
3461
3462 @item gnus-summary-check-current
3463 @vindex gnus-summary-check-current
3464 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3465 to the next (or previous) article if the current article is unread.
3466 Instead, they will choose the current article.
3467
3468 @item gnus-auto-center-summary
3469 @vindex gnus-auto-center-summary
3470 If non-@code{nil}, Gnus will keep the point in the summary buffer
3471 centered at all times.  This makes things quite tidy, but if you have a
3472 slow network connection, or simply do not like this un-Emacsism, you can
3473 set this variable to @code{nil} to get the normal Emacs scrolling
3474 action.  This will also inhibit horizontal re-centering of the summary
3475 buffer, which might make it more inconvenient to read extremely long
3476 threads.
3477
3478 @end table
3479
3480
3481 @node Choosing Articles
3482 @section Choosing Articles
3483 @cindex selecting articles
3484
3485 @menu
3486 * Choosing Commands::        Commands for choosing articles.
3487 * Choosing Variables::       Variables that influence these commands.
3488 @end menu
3489
3490
3491 @node Choosing Commands
3492 @subsection Choosing Commands
3493
3494 None of the following movement commands understand the numeric prefix,
3495 and they all select and display an article.
3496
3497 @table @kbd
3498 @item SPACE
3499 @kindex SPACE (Summary)
3500 @findex gnus-summary-next-page
3501 Select the current article, or, if that one's read already, the next
3502 unread article (@code{gnus-summary-next-page}).
3503
3504 @item G n
3505 @itemx n
3506 @kindex n (Summary)
3507 @kindex G n (Summary)
3508 @findex gnus-summary-next-unread-article
3509 @c @icon{gnus-summary-next-unread}
3510 Go to next unread article (@code{gnus-summary-next-unread-article}).
3511
3512 @item G p
3513 @itemx p
3514 @kindex p (Summary)
3515 @findex gnus-summary-prev-unread-article
3516 @c @icon{gnus-summary-prev-unread}
3517 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3518
3519 @item G N
3520 @itemx N
3521 @kindex N (Summary)
3522 @kindex G N (Summary)
3523 @findex gnus-summary-next-article
3524 Go to the next article (@code{gnus-summary-next-article}).
3525
3526 @item G P
3527 @itemx P
3528 @kindex P (Summary)
3529 @kindex G P (Summary)
3530 @findex gnus-summary-prev-article
3531 Go to the previous article (@code{gnus-summary-prev-article}).
3532
3533 @item G C-n
3534 @kindex G C-n (Summary)
3535 @findex gnus-summary-next-same-subject
3536 Go to the next article with the same subject
3537 (@code{gnus-summary-next-same-subject}). 
3538
3539 @item G C-p
3540 @kindex G C-p (Summary)
3541 @findex gnus-summary-prev-same-subject
3542 Go to the previous article with the same subject
3543 (@code{gnus-summary-prev-same-subject}). 
3544
3545 @item G f
3546 @itemx .
3547 @kindex G f  (Summary)
3548 @kindex .  (Summary)
3549 @findex gnus-summary-first-unread-article
3550 Go to the first unread article
3551 (@code{gnus-summary-first-unread-article}).
3552
3553 @item G b
3554 @itemx ,
3555 @kindex G b (Summary)
3556 @kindex , (Summary)
3557 @findex gnus-summary-best-unread-article
3558 Go to the article with the highest score
3559 (@code{gnus-summary-best-unread-article}). 
3560
3561 @item G l
3562 @itemx l
3563 @kindex l (Summary)
3564 @kindex G l (Summary)
3565 @findex gnus-summary-goto-last-article
3566 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3567
3568 @item G o
3569 @kindex G o (Summary)
3570 @findex gnus-summary-pop-article
3571 @cindex history
3572 @cindex article history
3573 Pop an article off the summary history and go to this article
3574 (@code{gnus-summary-pop-article}).  This command differs from the
3575 command above in that you can pop as many previous articles off the
3576 history as you like, while @kbd{l} toggles the two last read articles.
3577 For a somewhat related issue (if you use these commands a lot),
3578 @pxref{Article Backlog}.
3579 @end table
3580
3581
3582 @node Choosing Variables
3583 @subsection Choosing Variables
3584
3585 Some variables relevant for moving and selecting articles:
3586
3587 @table @code
3588 @item gnus-auto-extend-newsgroup
3589 @vindex gnus-auto-extend-newsgroup
3590 All the movement commands will try to go to the previous (or next)
3591 article, even if that article isn't displayed in the Summary buffer if
3592 this variable is non-@code{nil}.  Gnus will then fetch the article from
3593 the server and display it in the article buffer.
3594
3595 @item gnus-select-article-hook
3596 @vindex gnus-select-article-hook
3597 This hook is called whenever an article is selected.  By default it
3598 exposes any threads hidden under the selected article.
3599
3600 @item gnus-mark-article-hook
3601 @vindex gnus-mark-article-hook
3602 @findex gnus-summary-mark-unread-as-read
3603 @findex gnus-summary-mark-read-and-unread-as-read
3604 @findex gnus-unread-mark
3605 This hook is called whenever an article is selected.  It is intended to
3606 be used for marking articles as read.  The default value is
3607 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3608 mark of almost any article you read to @code{gnus-unread-mark}.  The
3609 only articles not affected by this function are ticked, dormant, and
3610 expirable articles.  If you'd instead like to just have unread articles
3611 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3612 instead.  It will leave marks like @code{gnus-low-score-mark},
3613 @code{gnus-del-mark} (and so on) alone.
3614
3615 @end table
3616
3617
3618 @node Paging the Article
3619 @section Scrolling the Article
3620 @cindex article scrolling
3621
3622 @table @kbd
3623
3624 @item SPACE
3625 @kindex SPACE (Summary)
3626 @findex gnus-summary-next-page
3627 Pressing @kbd{SPACE} will scroll the current article forward one page,
3628 or, if you have come to the end of the current article, will choose the
3629 next article (@code{gnus-summary-next-page}).
3630
3631 @item DEL
3632 @kindex DEL (Summary)
3633 @findex gnus-summary-prev-page
3634 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3635
3636 @item RET
3637 @kindex RET (Summary)
3638 @findex gnus-summary-scroll-up
3639 Scroll the current article one line forward
3640 (@code{gnus-summary-scroll-up}).
3641
3642 @item A g
3643 @itemx g
3644 @kindex A g (Summary)
3645 @kindex g (Summary)
3646 @findex gnus-summary-show-article
3647 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3648 given a prefix, fetch the current article, but don't run any of the
3649 article treatment functions.  This will give you a ``raw'' article, just
3650 the way it came from the server.
3651
3652 @item A <
3653 @itemx <
3654 @kindex < (Summary)
3655 @kindex A < (Summary)
3656 @findex gnus-summary-beginning-of-article
3657 Scroll to the beginning of the article
3658 (@code{gnus-summary-beginning-of-article}).
3659
3660 @item A >
3661 @itemx >
3662 @kindex > (Summary)
3663 @kindex A > (Summary)
3664 @findex gnus-summary-end-of-article
3665 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3666
3667 @item A s 
3668 @itemx s
3669 @kindex A s (Summary)
3670 @kindex s (Summary)
3671 @findex gnus-summary-isearch-article
3672 Perform an isearch in the article buffer
3673 (@code{gnus-summary-isearch-article}).
3674
3675 @item h
3676 @kindex h (Summary)
3677 @findex gnus-summary-select-article-buffer
3678 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3679
3680 @end table
3681
3682
3683 @node Reply Followup and Post
3684 @section Reply, Followup and Post
3685
3686 @menu
3687 * Summary Mail Commands::            Sending mail.
3688 * Summary Post Commands::            Sending news.
3689 @end menu
3690
3691
3692 @node Summary Mail Commands
3693 @subsection Summary Mail Commands
3694 @cindex mail
3695 @cindex composing mail
3696
3697 Commands for composing a mail message:
3698
3699 @table @kbd
3700
3701 @item S r
3702 @itemx r
3703 @kindex S r (Summary)
3704 @kindex r (Summary)
3705 @findex gnus-summary-reply
3706 @c @icon{gnus-summary-mail-reply}
3707 @c @icon{gnus-summary-reply}
3708 Mail a reply to the author of the current article
3709 (@code{gnus-summary-reply}). 
3710
3711 @item S R
3712 @itemx R
3713 @kindex R (Summary)
3714 @kindex S R (Summary)
3715 @findex gnus-summary-reply-with-original
3716 @c @icon{gnus-summary-reply-with-original}
3717 Mail a reply to the author of the current article and include the
3718 original message (@code{gnus-summary-reply-with-original}).  This
3719 command uses the process/prefix convention.
3720
3721 @item S w
3722 @kindex S w (Summary)
3723 @findex gnus-summary-wide-reply
3724 Mail a wide reply to the author of the current article
3725 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3726 goes out to all people listed in the @code{To}, @code{From} (or
3727 @code{Reply-to}) and @code{Cc} headers.
3728
3729 @item S W
3730 @kindex S W (Summary)
3731 @findex gnus-summary-wide-reply-with-original
3732 Mail a wide reply to the current article and include the original
3733 message (@code{gnus-summary-reply-with-original}).  This command uses
3734 the process/prefix convention.
3735
3736 @item S o m
3737 @kindex S o m (Summary)
3738 @findex gnus-summary-mail-forward
3739 @c @icon{gnus-summary-mail-forward}
3740 Forward the current article to some other person
3741 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3742 headers of the forwarded article.
3743
3744 @item S m
3745 @itemx m
3746 @kindex m (Summary)
3747 @kindex S m (Summary)
3748 @findex gnus-summary-mail-other-window
3749 @c @icon{gnus-summary-mail-originate}
3750 Send a mail to some other person
3751 (@code{gnus-summary-mail-other-window}).
3752
3753 @item S D b
3754 @kindex S D b (Summary)
3755 @findex gnus-summary-resend-bounced-mail
3756 @cindex bouncing mail
3757 If you have sent a mail, but the mail was bounced back to you for some
3758 reason (wrong address, transient failure), you can use this command to
3759 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3760 will be popped into a mail buffer where you can edit the headers before
3761 sending the mail off again.  If you give a prefix to this command, and
3762 the bounced mail is a reply to some other mail, Gnus will try to fetch
3763 that mail and display it for easy perusal of its headers.  This might
3764 very well fail, though.
3765
3766 @item S D r
3767 @kindex S D r (Summary)
3768 @findex gnus-summary-resend-message
3769 Not to be confused with the previous command,
3770 @code{gnus-summary-resend-message} will prompt you for an address to
3771 send the current message off to, and then send it to that place.  The
3772 headers of the message won't be altered---but lots of headers that say
3773 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3774 means that you actually send a mail to someone that has a @code{To}
3775 header that (probably) points to yourself.  This will confuse people.
3776 So, natcherly you'll only do that if you're really eVIl.  
3777
3778 This command is mainly used if you have several accounts and want to
3779 ship a mail to a different account of yours.  (If you're both
3780 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3781 to the @code{root} account, you may want to resend it to
3782 @code{postmaster}.  Ordnung muß sein!
3783
3784 This command understands the process/prefix convention
3785 (@pxref{Process/Prefix}). 
3786
3787 @item S O m
3788 @kindex S O m (Summary)
3789 @findex gnus-uu-digest-mail-forward
3790 Digest the current series (@pxref{Decoding Articles}) and forward the
3791 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
3792 uses the process/prefix convention (@pxref{Process/Prefix}).
3793
3794 @item S M-c
3795 @kindex S M-c (Summary)
3796 @findex gnus-summary-mail-crosspost-complaint
3797 @cindex crossposting
3798 @cindex excessive crossposting
3799 Send a complaint about excessive crossposting to the author of the
3800 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3801
3802 @findex gnus-crosspost-complaint
3803 This command is provided as a way to fight back agains the current
3804 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3805 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3806 command understands the process/prefix convention
3807 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3808
3809 @end table
3810
3811
3812 @node Summary Post Commands
3813 @subsection Summary Post Commands
3814 @cindex post
3815 @cindex composing news
3816
3817 Commands for posting a news article:
3818
3819 @table @kbd
3820 @item S p
3821 @itemx a
3822 @kindex a (Summary)
3823 @kindex S p (Summary)
3824 @findex gnus-summary-post-news
3825 @c @icon{gnus-summary-post-news}
3826 Post an article to the current group
3827 (@code{gnus-summary-post-news}).
3828
3829 @item S f
3830 @itemx f
3831 @kindex f (Summary)
3832 @kindex S f (Summary)
3833 @findex gnus-summary-followup
3834 @c @icon{gnus-summary-followup}
3835 Post a followup to the current article (@code{gnus-summary-followup}).
3836
3837 @item S F
3838 @itemx F
3839 @kindex S F (Summary)
3840 @kindex F (Summary)
3841 @c @icon{gnus-summary-followup-with-original}
3842 @findex gnus-summary-followup-with-original
3843 Post a followup to the current article and include the original message
3844 (@code{gnus-summary-followup-with-original}).   This command uses the
3845 process/prefix convention.
3846
3847 @item S n
3848 @kindex S n (Summary)
3849 @findex gnus-summary-followup-to-mail
3850 Post a followup to the current article via news, even if you got the
3851 message through mail (@code{gnus-summary-followup-to-mail}).
3852
3853 @item S n
3854 @kindex S n (Summary)
3855 @findex gnus-summary-followup-to-mail
3856 Post a followup to the current article via news, even if you got the
3857 message through mail and include the original message
3858 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3859 the process/prefix convention.
3860
3861 @item S o p
3862 @kindex S o p (Summary)
3863 @findex gnus-summary-post-forward
3864 Forward the current article to a newsgroup
3865 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3866 headers of the forwarded article.
3867
3868 @item S O p
3869 @kindex S O p (Summary)
3870 @findex gnus-uu-digest-post-forward
3871 @cindex digests
3872 @cindex making digests
3873 Digest the current series and forward the result to a newsgroup
3874 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3875 process/prefix convention.
3876
3877 @item S u
3878 @kindex S u (Summary)
3879 @findex gnus-uu-post-news
3880 @c @icon{gnus-uu-post-news}
3881 Uuencode a file, split it into parts, and post it as a series
3882 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3883 @end table
3884
3885
3886 @node Canceling and Superseding
3887 @section Canceling Articles
3888 @cindex canceling articles
3889 @cindex superseding articles
3890
3891 Have you ever written something, and then decided that you really,
3892 really, really wish you hadn't posted that?
3893
3894 Well, you can't cancel mail, but you can cancel posts.
3895
3896 @findex gnus-summary-cancel-article
3897 @kindex C (Summary)
3898 @c @icon{gnus-summary-cancel-article}
3899 Find the article you wish to cancel (you can only cancel your own
3900 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3901 c} (@code{gnus-summary-cancel-article}).  Your article will be
3902 canceled---machines all over the world will be deleting your article.
3903 This command uses the process/prefix convention (@pxref{Process/Prefix}).
3904
3905 Be aware, however, that not all sites honor cancels, so your article may
3906 live on here and there, while most sites will delete the article in
3907 question.
3908
3909 Gnus will use the ``current'' select method when cancelling.  If you
3910 want to use the standard posting method, use the @samp{a} symbolic
3911 prefix (@pxref{Symbolic Prefixes}).
3912
3913 If you discover that you have made some mistakes and want to do some
3914 corrections, you can post a @dfn{superseding} article that will replace
3915 your original article.
3916
3917 @findex gnus-summary-supersede-article
3918 @kindex S (Summary)
3919 Go to the original article and press @kbd{S s}
3920 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3921 where you can edit the article all you want before sending it off the
3922 usual way.
3923
3924 The same goes for superseding as for canceling, only more so: Some
3925 sites do not honor superseding.  On those sites, it will appear that you
3926 have posted almost the same article twice.
3927
3928 If you have just posted the article, and change your mind right away,
3929 there is a trick you can use to cancel/supersede the article without
3930 waiting for the article to appear on your site first.  You simply return
3931 to the post buffer (which is called @code{*sent ...*}).  There you will
3932 find the article you just posted, with all the headers intact.  Change
3933 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3934 header by substituting one of those words for the word
3935 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3936 you would do normally.  The previous article will be
3937 canceled/superseded.
3938
3939 Just remember, kids: There is no 'c' in 'supersede'.
3940
3941
3942 @node Marking Articles
3943 @section Marking Articles
3944 @cindex article marking
3945 @cindex article ticking
3946 @cindex marks
3947
3948 There are several marks you can set on an article. 
3949
3950 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3951 neologism ohoy!) of the article.  Alphabetic marks generally mean
3952 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3953
3954 In addition, you also have marks that do not affect readedness.
3955
3956 @menu
3957 * Unread Articles::      Marks for unread articles.
3958 * Read Articles::        Marks for read articles.
3959 * Other Marks::          Marks that do not affect readedness.
3960 @end menu
3961
3962 @ifinfo
3963 There's a plethora of commands for manipulating these marks:
3964 @end ifinfo
3965
3966 @menu
3967 * Setting Marks::           How to set and remove marks.
3968 * Setting Process Marks::   How to mark articles for later processing.
3969 @end menu
3970
3971
3972 @node Unread Articles
3973 @subsection Unread Articles
3974
3975 The following marks mark articles as (kinda) unread, in one form or
3976 other.
3977
3978 @table @samp
3979 @item !
3980 @vindex gnus-ticked-mark
3981 Marked as ticked (@code{gnus-ticked-mark}).
3982
3983 @dfn{Ticked articles} are articles that will remain visible always.  If
3984 you see an article that you find interesting, or you want to put off
3985 reading it, or replying to it, until sometime later, you'd typically
3986 tick it.  However, articles can be expired, so if you want to keep an
3987 article forever, you'll have to make it persistent (@pxref{Persistent
3988 Articles}).  
3989
3990 @item ?
3991 @vindex gnus-dormant-mark
3992 Marked as dormant (@code{gnus-dormant-mark}).  
3993
3994 @dfn{Dormant articles} will only appear in the summary buffer if there
3995 are followups to it.  If you want to see them even if they don't have
3996 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
3997
3998 @item SPACE
3999 @vindex gnus-unread-mark
4000 Markes as unread (@code{gnus-unread-mark}).
4001
4002 @dfn{Unread articles} are articles that haven't been read at all yet.
4003 @end table
4004
4005
4006 @node Read Articles
4007 @subsection Read Articles
4008 @cindex expirable mark
4009
4010 All the following marks mark articles as read.
4011
4012 @table @samp
4013
4014 @item r
4015 @vindex gnus-del-mark
4016 These are articles that the user has marked as read with the @kbd{d}
4017 command manually, more or less (@code{gnus-del-mark}).
4018
4019 @item R
4020 @vindex gnus-read-mark
4021 Articles that have actually been read (@code{gnus-read-mark}).
4022
4023 @item O
4024 @vindex gnus-ancient-mark
4025 Articles that were marked as read in previous sessions and are now
4026 @dfn{old} (@code{gnus-ancient-mark}).
4027
4028 @item K
4029 @vindex gnus-killed-mark
4030 Marked as killed (@code{gnus-killed-mark}).
4031
4032 @item X
4033 @vindex gnus-kill-file-mark
4034 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4035
4036 @item Y
4037 @vindex gnus-low-score-mark
4038 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4039
4040 @item C
4041 @vindex gnus-catchup-mark
4042 Marked as read by a catchup (@code{gnus-catchup-mark}).
4043
4044 @item G
4045 @vindex gnus-canceled-mark
4046 Canceled article (@code{gnus-canceled-mark})
4047
4048 @item F
4049 @vindex gnus-souped-mark
4050 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4051
4052 @item Q
4053 @vindex gnus-sparse-mark
4054 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4055 Threading}.
4056
4057 @item M
4058 @vindex gnus-duplicate-mark
4059 Article marked as read by duplicate suppression
4060 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4061
4062 @end table
4063
4064 All these marks just mean that the article is marked as read, really.
4065 They are interpreted differently when doing adaptive scoring, though.
4066
4067 One more special mark, though:
4068
4069 @table @samp
4070 @item E
4071 @vindex gnus-expirable-mark
4072 Marked as expirable (@code{gnus-expirable-mark}).
4073
4074 Marking articles as @dfn{expirable} (or have them marked as such
4075 automatically) doesn't make much sense in normal groups---a user doesn't
4076 control expiring of news articles, but in mail groups, for instance,
4077 articles marked as @dfn{expirable} can be deleted by Gnus at
4078 any time.
4079 @end table
4080
4081
4082 @node Other Marks
4083 @subsection Other Marks
4084 @cindex process mark
4085 @cindex bookmarks
4086
4087 There are some marks that have nothing to do with whether the article is
4088 read or not.
4089
4090 @itemize @bullet
4091
4092 @item 
4093 You can set a bookmark in the current article.  Say you are reading a
4094 long thesis on cats' urinary tracts, and have to go home for dinner
4095 before you've finished reading the thesis.  You can then set a bookmark
4096 in the article, and Gnus will jump to this bookmark the next time it
4097 encounters the article.  @xref{Setting Marks}
4098
4099 @item
4100 @vindex gnus-replied-mark
4101 All articles that you have replied to or made a followup to (i.e., have
4102 answered) will be marked with an @samp{A} in the second column
4103 (@code{gnus-replied-mark}).
4104
4105 @item 
4106 @vindex gnus-cached-mark
4107 Articles stored in the article cache will be marked with an @samp{*} in
4108 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}
4109
4110 @item 
4111 @vindex gnus-saved-mark
4112 Articles ``saved'' (in some manner or other; not necessarily
4113 religiously) are marked with an @samp{S} in the second column
4114 (@code{gnus-saved-mark}).
4115
4116 @item 
4117 @vindex gnus-not-empty-thread-mark
4118 @vindex gnus-empty-thread-mark
4119 If the @samp{%e} spec is used, the presence of threads or not will be
4120 marked with @code{gnus-not-empty-thread-mark} and
4121 @code{gnus-empty-thread-mark} in the third column, respectively.
4122
4123 @item 
4124 @vindex gnus-process-mark
4125 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4126 variety of commands react to the presence of the process mark.  For
4127 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4128 all articles that have been marked with the process mark.  Articles
4129 marked with the process mark have a @samp{#} in the second column.
4130
4131 @end itemize
4132
4133 You might have noticed that most of these ``non-readedness'' marks
4134 appear in the second column by default.  So if you have a cached, saved,
4135 replied article that you have process-marked, what will that look like?
4136
4137 Nothing much.  The precedence rules go as follows: process -> cache ->
4138 replied -> saved.  So if the article is in the cache and is replied,
4139 you'll only see the cache mark and not the replied mark.
4140
4141
4142 @node Setting Marks
4143 @subsection Setting Marks
4144 @cindex setting marks
4145
4146 All the marking commands understand the numeric prefix.
4147
4148 @table @kbd
4149 @item M c
4150 @itemx M-u
4151 @kindex M c (Summary)
4152 @kindex M-u (Summary)
4153 @findex gnus-summary-clear-mark-forward
4154 @cindex mark as unread
4155 Clear all readedness-marks from the current article
4156 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4157 article as unread.
4158
4159 @item M t
4160 @itemx !
4161 @kindex ! (Summary)
4162 @kindex M t (Summary)
4163 @findex gnus-summary-tick-article-forward
4164 Tick the current article (@code{gnus-summary-tick-article-forward}).
4165 @xref{Article Caching} 
4166
4167 @item M ?
4168 @itemx ?
4169 @kindex ? (Summary)
4170 @kindex M ? (Summary)
4171 @findex gnus-summary-mark-as-dormant
4172 Mark the current article as dormant
4173 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching} 
4174
4175 @item M d
4176 @itemx d
4177 @kindex M d (Summary)
4178 @kindex d (Summary)
4179 @findex gnus-summary-mark-as-read-forward
4180 Mark the current article as read
4181 (@code{gnus-summary-mark-as-read-forward}).
4182
4183 @item D
4184 @kindex D (Summary)
4185 @findex gnus-summary-mark-as-read-backward
4186 Mark the current article as read and move point to the previous line
4187 (@code{gnus-summary-mark-as-read-backward}).
4188
4189 @item M k
4190 @itemx k
4191 @kindex k (Summary)
4192 @kindex M k (Summary)
4193 @findex gnus-summary-kill-same-subject-and-select
4194 Mark all articles that have the same subject as the current one as read,
4195 and then select the next unread article
4196 (@code{gnus-summary-kill-same-subject-and-select}).
4197
4198 @item M K
4199 @itemx C-k
4200 @kindex M K (Summary)
4201 @kindex C-k (Summary)
4202 @findex gnus-summary-kill-same-subject
4203 Mark all articles that have the same subject as the current one as read
4204 (@code{gnus-summary-kill-same-subject}).  
4205
4206 @item M C
4207 @kindex M C (Summary)
4208 @findex gnus-summary-catchup
4209 @c @icon{gnus-summary-catchup}
4210 Mark all unread articles as read (@code{gnus-summary-catchup}).
4211
4212 @item M C-c
4213 @kindex M C-c (Summary)
4214 @findex gnus-summary-catchup-all
4215 Mark all articles in the group as read---even the ticked and dormant
4216 articles (@code{gnus-summary-catchup-all}).
4217
4218 @item M H
4219 @kindex M H (Summary)
4220 @findex gnus-summary-catchup-to-here
4221 Catchup the current group to point
4222 (@code{gnus-summary-catchup-to-here}). 
4223
4224 @item C-w
4225 @kindex C-w (Summary)
4226 @findex gnus-summary-mark-region-as-read
4227 Mark all articles between point and mark as read
4228 (@code{gnus-summary-mark-region-as-read}). 
4229
4230 @item M V k
4231 @kindex M V k (Summary)
4232 @findex gnus-summary-kill-below
4233 Kill all articles with scores below the default score (or below the
4234 numeric prefix) (@code{gnus-summary-kill-below}).
4235
4236 @item M e
4237 @itemx E
4238 @kindex M e (Summary)
4239 @kindex E (Summary)
4240 @findex gnus-summary-mark-as-expirable
4241 Mark the current article as expirable
4242 (@code{gnus-summary-mark-as-expirable}).
4243
4244 @item M b
4245 @kindex M b (Summary)
4246 @findex gnus-summary-set-bookmark
4247 Set a bookmark in the current article
4248 (@code{gnus-summary-set-bookmark}).
4249
4250 @item M B
4251 @kindex M B (Summary)
4252 @findex gnus-summary-remove-bookmark
4253 Remove the bookmark from the current article
4254 (@code{gnus-summary-remove-bookmark}).
4255
4256 @item M V c
4257 @kindex M V c (Summary)
4258 @findex gnus-summary-clear-above
4259 Clear all marks from articles with scores over the default score (or
4260 over the numeric prefix) (@code{gnus-summary-clear-above}).
4261
4262 @item M V u
4263 @kindex M V u (Summary)
4264 @findex gnus-summary-tick-above
4265 Tick all articles with scores over the default score (or over the
4266 numeric prefix) (@code{gnus-summary-tick-above}).
4267
4268 @item M V m
4269 @kindex M V m (Summary)
4270 @findex gnus-summary-mark-above
4271 Prompt for a mark, and mark all articles with scores over the default
4272 score (or over the numeric prefix) with this mark
4273 (@code{gnus-summary-clear-above}).
4274 @end table
4275
4276 @vindex gnus-summary-goto-unread
4277 The @code{gnus-summary-goto-unread} variable controls what action should
4278 be taken after setting a mark.  If non-@code{nil}, point will move to
4279 the next/previous unread article.  If @code{nil}, point will just move
4280 one line up or down.  As a special case, if this variable is
4281 @code{never}, all the marking commands as well as other commands (like
4282 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4283 The default is @code{t}.
4284
4285
4286 @node Setting Process Marks
4287 @subsection Setting Process Marks
4288 @cindex setting process marks
4289
4290 @table @kbd
4291
4292 @item M P p
4293 @itemx #
4294 @kindex # (Summary)
4295 @kindex M P p (Summary)
4296 @findex gnus-summary-mark-as-processable
4297 Mark the current article with the process mark
4298 (@code{gnus-summary-mark-as-processable}). 
4299 @findex gnus-summary-unmark-as-processable
4300
4301 @item M P u 
4302 @itemx M-#
4303 @kindex M P u (Summary)
4304 @kindex M-# (Summary)
4305 Remove the process mark, if any, from the current article
4306 (@code{gnus-summary-unmark-as-processable}).
4307
4308 @item M P U
4309 @kindex M P U (Summary)
4310 @findex gnus-summary-unmark-all-processable
4311 Remove the process mark from all articles
4312 (@code{gnus-summary-unmark-all-processable}). 
4313
4314 @item M P i
4315 @kindex M P i (Summary)
4316 @findex gnus-uu-invert-processable
4317 Invert the list of process marked articles
4318 (@code{gnus-uu-invert-processable}). 
4319
4320 @item M P R
4321 @kindex M P R (Summary)
4322 @findex gnus-uu-mark-by-regexp
4323 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4324
4325 @item M P r
4326 @kindex M P r (Summary)
4327 @findex gnus-uu-mark-region
4328 Mark articles in region (@code{gnus-uu-mark-region}).
4329
4330 @item M P t
4331 @kindex M P t (Summary)
4332 @findex gnus-uu-mark-thread
4333 Mark all articles in the current (sub)thread
4334 (@code{gnus-uu-mark-thread}).
4335
4336 @item M P T
4337 @kindex M P T (Summary)
4338 @findex gnus-uu-unmark-thread
4339 Unmark all articles in the current (sub)thread
4340 (@code{gnus-uu-unmark-thread}).
4341
4342 @item M P v
4343 @kindex M P v (Summary)
4344 @findex gnus-uu-mark-over
4345 Mark all articles that have a score above the prefix argument
4346 (@code{gnus-uu-mark-over}).
4347
4348 @item M P s
4349 @kindex M P s (Summary)
4350 @findex gnus-uu-mark-series
4351 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4352
4353 @item M P S
4354 @kindex M P S (Summary)
4355 @findex gnus-uu-mark-sparse
4356 Mark all series that have already had some articles marked
4357 (@code{gnus-uu-mark-sparse}).
4358
4359 @item M P a
4360 @kindex M P a (Summary)
4361 @findex gnus-uu-mark-all
4362 Mark all articles in series order (@code{gnus-uu-mark-series}).
4363
4364 @item M P b
4365 @kindex M P b (Summary)
4366 @findex gnus-uu-mark-buffer
4367 Mark all articles in the buffer in the order they appear
4368 (@code{gnus-uu-mark-buffer}). 
4369
4370 @item M P k
4371 @kindex M P k (Summary)
4372 @findex gnus-summary-kill-process-mark
4373 Push the current process mark set onto the stack and unmark all articles
4374 (@code{gnus-summary-kill-process-mark}).
4375
4376 @item M P y
4377 @kindex M P y (Summary)
4378 @findex gnus-summary-yank-process-mark
4379 Pop the previous process mark set from the stack and restore it
4380 (@code{gnus-summary-yank-process-mark}).
4381
4382 @item M P w
4383 @kindex M P w (Summary)
4384 @findex gnus-summary-save-process-mark
4385 Push the current process mark set onto the stack
4386 (@code{gnus-summary-save-process-mark}).
4387
4388 @end table
4389
4390
4391 @node Limiting
4392 @section Limiting
4393 @cindex limiting
4394
4395 It can be convenient to limit the summary buffer to just show some
4396 subset of the articles currently in the group.  The effect most limit
4397 commands have is to remove a few (or many) articles from the summary
4398 buffer. 
4399
4400 All limiting commands work on subsets of the articles already fetched
4401 from the servers.  None of these commands query the server for
4402 additional articles.
4403
4404 @table @kbd
4405
4406 @item / /
4407 @itemx / s
4408 @kindex / / (Summary)
4409 @findex gnus-summary-limit-to-subject
4410 Limit the summary buffer to articles that match some subject
4411 (@code{gnus-summary-limit-to-subject}). 
4412
4413 @item / a
4414 @kindex / a (Summary)
4415 @findex gnus-summary-limit-to-author
4416 Limit the summary buffer to articles that match some author
4417 (@code{gnus-summary-limit-to-author}).
4418
4419 @item / u
4420 @itemx x
4421 @kindex / u (Summary)
4422 @kindex x (Summary)
4423 @findex gnus-summary-limit-to-unread
4424 Limit the summary buffer to articles not marked as read
4425 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4426 buffer to articles strictly unread.  This means that ticked and
4427 dormant articles will also be excluded.
4428
4429 @item / m
4430 @kindex / m (Summary)
4431 @findex gnus-summary-limit-to-marks
4432 Ask for a mark and then limit to all articles that have not been marked
4433 with that mark (@code{gnus-summary-limit-to-marks}).
4434
4435 @item / t
4436 @kindex / t (Summary)
4437 @findex gnus-summary-limit-to-age
4438 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4439 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4440 articles younger than that number of days.
4441
4442 @item / n
4443 @kindex / n (Summary)
4444 @findex gnus-summary-limit-to-articles
4445 Limit the summary buffer to the current article
4446 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4447 convention (@pxref{Process/Prefix}).
4448
4449 @item / w
4450 @kindex / w (Summary)
4451 @findex gnus-summary-pop-limit
4452 Pop the previous limit off the stack and restore it
4453 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4454 the stack.
4455
4456 @item / v
4457 @kindex / v (Summary)
4458 @findex gnus-summary-limit-to-score
4459 Limit the summary buffer to articles that have a score at or above some
4460 score (@code{gnus-summary-limit-to-score}).
4461
4462 @item / E
4463 @itemx M S
4464 @kindex M S (Summary)
4465 @kindex / E (Summary)
4466 @findex gnus-summary-limit-include-expunged
4467 Display all expunged articles
4468 (@code{gnus-summary-limit-include-expunged}). 
4469
4470 @item / D
4471 @kindex / D (Summary)
4472 @findex gnus-summary-limit-include-dormant
4473 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4474
4475 @item / d
4476 @kindex / d (Summary)
4477 @findex gnus-summary-limit-exclude-dormant
4478 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4479
4480 @item / T
4481 @kindex / T (Summary)
4482 @findex gnus-summary-limit-include-thread
4483 Include all the articles in the current thread.
4484
4485 @item / c
4486 @kindex / c (Summary)
4487 @findex gnus-summary-limit-exclude-childless-dormant
4488 Hide all dormant articles that have no children
4489 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4490
4491 @item / C
4492 @kindex / C (Summary)
4493 @findex gnus-summary-limit-mark-excluded-as-read
4494 Mark all excluded unread articles as read
4495 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4496 also mark excluded ticked and dormant articles as read.
4497
4498 @end table
4499
4500
4501 @node Threading
4502 @section Threading
4503 @cindex threading
4504 @cindex article threading
4505
4506 Gnus threads articles by default.  @dfn{To thread} is to put responses
4507 to articles directly after the articles they respond to---in a
4508 hierarchical fashion.
4509
4510 Threading is done by looking at the @code{References} headers of the
4511 articles.  In a perfect world, this would be enough to build pretty
4512 trees, but unfortunately, the @code{References} header is often broken
4513 or simply missing.  Weird news propagration excarcerbates the problem,
4514 so one has to employ other heuristics to get pleasing results.  A
4515 plethora of approaches exists, as detailed in horrible detail in
4516 @pxref{Customizing Threading}. 
4517
4518 First, a quick overview of the concepts:
4519
4520 @table @dfn
4521 @item root
4522 The top-most article in a thread; the first article in the thread.
4523
4524 @item thread
4525 A tree-like article structure.
4526
4527 @item sub-thread
4528 A small(er) section of this tree-like structure.
4529
4530 @item loose threads
4531 Threads often lose their roots due to article expiry, or due to the root
4532 already having been read in a previous session, and not displayed in the
4533 summary buffer.  We then typicall have many sub-threads that really
4534 belong to one thread, but are without connecting roots.  These are
4535 called loose threads.
4536
4537 @item thread gathering
4538 An attempt to gather loose threads into bigger threads.
4539
4540 @item sparse threads
4541 A thread where the missing articles have been ``guessed'' at, and are
4542 displayed as empty lines in the summary buffer.
4543
4544 @end table
4545
4546
4547 @menu
4548 * Customizing Threading::     Variables you can change to affect the threading.
4549 * Thread Commands::           Thread based commands in the summary buffer.
4550 @end menu
4551
4552
4553 @node Customizing Threading
4554 @subsection Customizing Threading
4555 @cindex customizing threading
4556
4557 @menu
4558 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
4559 * Filling In Threads::   Making the threads displayed look fuller.
4560 * More Threading::       Even more variables for fiddling with threads.
4561 * Low-Level Threading::  You thought it was over... but you were wrong!
4562 @end menu
4563
4564
4565 @node Loose Threads
4566 @subsubsection Loose Threads
4567 @cindex <
4568 @cindex >
4569 @cindex loose threads
4570
4571 @table @code
4572 @item gnus-summary-make-false-root
4573 @vindex gnus-summary-make-false-root
4574 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4575 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4576 Yup.)  Loose subtrees occur when the real root has expired, or you've
4577 read or killed the root in a previous session.
4578
4579 When there is no real root of a thread, Gnus will have to fudge
4580 something.  This variable says what fudging method Gnus should use.
4581 There are four possible values:
4582
4583 @iftex
4584 @iflatex
4585 \gnusfigure{The Summary Buffer}{390}{
4586 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4587 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4588 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4589 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4590 }
4591 @end iflatex
4592 @end iftex
4593
4594 @cindex adopting articles
4595
4596 @table @code
4597
4598 @item adopt
4599 Gnus will make the first of the orphaned articles the parent.  This
4600 parent will adopt all the other articles.  The adopted articles will be
4601 marked as such by pointy brackets (@samp{<>}) instead of the standard
4602 square brackets (@samp{[]}).  This is the default method.
4603
4604 @item dummy
4605 @vindex gnus-summary-dummy-line-format
4606 Gnus will create a dummy summary line that will pretend to be the
4607 parent.  This dummy line does not correspond to any real article, so
4608 selecting it will just select the first real article after the dummy
4609 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4610 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4611 which is the subject of the article.  @xref{Formatting Variables}.
4612
4613 @item empty
4614 Gnus won't actually make any article the parent, but simply leave the
4615 subject field of all orphans except the first empty.  (Actually, it will
4616 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4617 Buffer Format}).)
4618
4619 @item none
4620 Don't make any article parent at all.  Just gather the threads and
4621 display them after one another.
4622
4623 @item nil
4624 Don't gather loose threads.
4625 @end table
4626
4627 @item gnus-summary-gather-subject-limit
4628 @vindex gnus-summary-gather-subject-limit
4629 Loose threads are gathered by comparing subjects of articles.  If this
4630 variable is @code{nil}, Gnus requires an exact match between the
4631 subjects of the loose threads before gathering them into one big
4632 super-thread.  This might be too strict a requirement, what with the
4633 presence of stupid newsreaders that chop off long subject lines.  If
4634 you think so, set this variable to, say, 20 to require that only the
4635 first 20 characters of the subjects have to match.  If you set this
4636 variable to a really low number, you'll find that Gnus will gather
4637 everything in sight into one thread, which isn't very helpful.
4638
4639 @cindex fuzzy article gathering
4640 If you set this variable to the special value @code{fuzzy}, Gnus will
4641 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4642 Matching}). 
4643
4644 @item gnus-simplify-subject-fuzzy-regexp
4645 @vindex gnus-simplify-subject-fuzzy-regexp
4646 This can either be a regular expression or list of regular expressions
4647 that match strings that will be removed from subjects if fuzzy subject
4648 simplification is used.
4649
4650 @item gnus-simplify-ignored-prefixes
4651 @vindex gnus-simplify-ignored-prefixes
4652 If you set @code{gnus-summary-gather-subject-limit} to something as low
4653 as 10, you might consider setting this variable to something sensible:
4654
4655 @c Written by Michael Ernst <mernst@cs.rice.edu>
4656 @lisp
4657 (setq gnus-simplify-ignored-prefixes
4658       (concat 
4659        "\\`\\[?\\("
4660        (mapconcat 
4661         'identity
4662         '("looking"
4663           "wanted" "followup" "summary\\( of\\)?"
4664           "help" "query" "problem" "question" 
4665           "answer" "reference" "announce"
4666           "How can I" "How to" "Comparison of"
4667           ;; ...
4668           )
4669         "\\|")
4670        "\\)\\s *\\("
4671        (mapconcat 'identity
4672                   '("for" "for reference" "with" "about")
4673                   "\\|")
4674        "\\)?\\]?:?[ \t]*"))
4675 @end lisp
4676
4677 All words that match this regexp will be removed before comparing two
4678 subjects. 
4679
4680 @item gnus-simplify-subject-functions
4681 @vindex gnus-simplify-subject-functions
4682 If non-@code{nil}, this variable overrides
4683 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4684 list of functions to apply to the @code{Subject} string iteratively to
4685 arrive at the simplified version of the string.
4686
4687 Useful functions to put in this list include:
4688
4689 @table @code
4690 @item gnus-simplify-subject-re
4691 @findex gnus-simplify-subject-re
4692 Strip the leading @samp{Re:}.
4693
4694 @item gnus-simplify-subject-fuzzy
4695 @findex gnus-simplify-subject-fuzzy
4696 Simplify fuzzily.
4697
4698 @item gnus-simplify-whitespace
4699 @findex gnus-simplify-whitespace
4700 Remove excessive whitespace.
4701 @end table
4702
4703 You may also write your own functions, of course.
4704
4705
4706 @item gnus-summary-gather-exclude-subject
4707 @vindex gnus-summary-gather-exclude-subject
4708 Since loose thread gathering is done on subjects only, that might lead
4709 to many false hits, especially with certain common subjects like
4710 @samp{} and @samp{(none)}.  To make the situation slightly better,
4711 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4712 what subjects should be excluded from the gathering process.@*
4713 The default is @samp{^ *$\\|^(none)$}.  
4714
4715 @item gnus-summary-thread-gathering-function
4716 @vindex gnus-summary-thread-gathering-function
4717 Gnus gathers threads by looking at @code{Subject} headers.  This means
4718 that totally unrelated articles may end up in the same ``thread'', which
4719 is confusing.  An alternate approach is to look at all the
4720 @code{Message-ID}s in all the @code{References} headers to find matches.
4721 This will ensure that no gathered threads ever include unrelated
4722 articles, but it also means that people who have posted with broken
4723 newsreaders won't be gathered properly.  The choice is yours---plague or
4724 cholera:
4725
4726 @table @code
4727 @item gnus-gather-threads-by-subject
4728 @findex gnus-gather-threads-by-subject
4729 This function is the default gathering function and looks at
4730 @code{Subject}s exclusively.
4731
4732 @item gnus-gather-threads-by-references
4733 @findex gnus-gather-threads-by-references
4734 This function looks at @code{References} headers exclusively.
4735 @end table
4736
4737 If you want to test gathering by @code{References}, you could say
4738 something like:
4739
4740 @lisp
4741 (setq gnus-summary-thread-gathering-function
4742       'gnus-gather-threads-by-references)
4743 @end lisp
4744
4745 @end table
4746
4747
4748 @node Filling In Threads
4749 @subsubsection Filling In Threads
4750
4751 @table @code
4752 @item gnus-fetch-old-headers
4753 @vindex gnus-fetch-old-headers
4754 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4755 more old headers---headers to articles marked as read.  If you
4756 would like to display as few summary lines as possible, but still
4757 connect as many loose threads as possible, you should set this variable
4758 to @code{some} or a number.  If you set it to a number, no more than
4759 that number of extra old headers will be fetched.  In either case,
4760 fetching old headers only works if the backend you are using carries
4761 overview files---this would normally be @code{nntp}, @code{nnspool} and
4762 @code{nnml}.  Also remember that if the root of the thread has been
4763 expired by the server, there's not much Gnus can do about that.
4764
4765 This variable can also be set to @code{invisible}.  This won't have any
4766 visible effects, but is useful if you use the @kbd{A T} command a lot
4767 (@pxref{Finding the Parent}). 
4768
4769 @item gnus-build-sparse-threads
4770 @vindex gnus-build-sparse-threads
4771 Fetching old headers can be slow.  A low-rent similar effect can be
4772 gotten by setting this variable to @code{some}.  Gnus will then look at
4773 the complete @code{References} headers of all articles and try to string
4774 together articles that belong in the same thread.  This will leave
4775 @dfn{gaps} in the threading display where Gnus guesses that an article
4776 is missing from the thread.  (These gaps appear like normal summary
4777 lines.  If you select a gap, Gnus will try to fetch the article in
4778 question.)  If this variable is @code{t}, Gnus will display all these
4779 ``gaps'' without regard for whether they are useful for completing the
4780 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4781 off sparse leaf nodes that don't lead anywhere.  This variable is
4782 @code{nil} by default.
4783
4784 @end table
4785
4786
4787 @node More Threading
4788 @subsubsection More Threading
4789
4790 @table @code
4791 @item gnus-show-threads
4792 @vindex gnus-show-threads
4793 If this variable is @code{nil}, no threading will be done, and all of
4794 the rest of the variables here will have no effect.  Turning threading
4795 off will speed group selection up a bit, but it is sure to make reading
4796 slower and more awkward.
4797
4798 @item gnus-thread-hide-subtree
4799 @vindex gnus-thread-hide-subtree
4800 If non-@code{nil}, all threads will be hidden when the summary buffer is
4801 generated.
4802
4803 @item gnus-thread-expunge-below
4804 @vindex gnus-thread-expunge-below
4805 All threads that have a total score (as defined by
4806 @code{gnus-thread-score-function}) less than this number will be
4807 expunged.  This variable is @code{nil} by default, which means that no
4808 threads are expunged.
4809
4810 @item gnus-thread-hide-killed
4811 @vindex gnus-thread-hide-killed
4812 if you kill a thread and this variable is non-@code{nil}, the subtree
4813 will be hidden.
4814
4815 @item gnus-thread-ignore-subject
4816 @vindex gnus-thread-ignore-subject
4817 Sometimes somebody changes the subject in the middle of a thread.  If
4818 this variable is non-@code{nil}, the subject change is ignored.  If it
4819 is @code{nil}, which is the default, a change in the subject will result
4820 in a new thread.
4821
4822 @item gnus-thread-indent-level
4823 @vindex gnus-thread-indent-level
4824 This is a number that says how much each sub-thread should be indented.
4825 The default is 4.
4826
4827 @end table
4828
4829
4830 @node Low-Level Threading
4831 @subsubsection Low-Level Threading
4832
4833 @table @code
4834
4835 @item gnus-parse-headers-hook
4836 @vindex gnus-parse-headers-hook
4837 Hook run before parsing any headers.  The default value is
4838 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4839 slightly decoded in a hackish way.  This is likely to change in the
4840 future when Gnus becomes @sc{MIME}ified.
4841
4842 @item gnus-alter-header-function
4843 @vindex gnus-alter-header-function
4844 If non-@code{nil}, this function will be called to allow alteration of
4845 article header structures.  The function is called with one parameter,
4846 the article header vector, which it may alter in any way.  For instance,
4847 if you have a mail-to-news gateway which alters the @code{Message-ID}s
4848 in systematic ways (by adding prefixes and such), you can use this
4849 variable to un-scramble the @code{Message-ID}s so that they are more
4850 meaningful.  Here's one example:
4851
4852 @lisp
4853 (setq gnus-alter-header-function 'my-alter-message-id)
4854
4855 (defun my-alter-message-id (header)
4856   (let ((id (mail-header-id header)))
4857     (when (string-match
4858            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
4859       (mail-header-set-id
4860        (concat (match-string 1 id) "@@" (match-string 2 id))
4861        header))))
4862 @end lisp
4863
4864 @end table
4865
4866
4867 @node Thread Commands
4868 @subsection Thread Commands
4869 @cindex thread commands
4870
4871 @table @kbd
4872
4873 @item T k
4874 @itemx M-C-k
4875 @kindex T k (Summary)
4876 @kindex M-C-k (Summary)
4877 @findex gnus-summary-kill-thread
4878 Mark all articles in the current (sub-)thread as read
4879 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4880 remove all marks instead.  If the prefix argument is negative, tick
4881 articles instead.
4882
4883 @item T l
4884 @itemx M-C-l
4885 @kindex T l (Summary)
4886 @kindex M-C-l (Summary)
4887 @findex gnus-summary-lower-thread
4888 Lower the score of the current (sub-)thread
4889 (@code{gnus-summary-lower-thread}). 
4890
4891 @item T i
4892 @kindex T i (Summary)
4893 @findex gnus-summary-raise-thread
4894 Increase the score of the current (sub-)thread
4895 (@code{gnus-summary-raise-thread}).
4896
4897 @item T #
4898 @kindex T # (Summary)
4899 @findex gnus-uu-mark-thread
4900 Set the process mark on the current (sub-)thread
4901 (@code{gnus-uu-mark-thread}).
4902
4903 @item T M-#
4904 @kindex T M-# (Summary)
4905 @findex gnus-uu-unmark-thread
4906 Remove the process mark from the current (sub-)thread
4907 (@code{gnus-uu-unmark-thread}).
4908
4909 @item T T
4910 @kindex T T (Summary)
4911 @findex gnus-summary-toggle-threads
4912 Toggle threading (@code{gnus-summary-toggle-threads}).
4913
4914 @item T s
4915 @kindex T s (Summary)
4916 @findex gnus-summary-show-thread
4917 Expose the (sub-)thread hidden under the current article, if any
4918 (@code{gnus-summary-show-thread}).
4919
4920 @item T h
4921 @kindex T h (Summary)
4922 @findex gnus-summary-hide-thread
4923 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4924
4925 @item T S
4926 @kindex T S (Summary)
4927 @findex gnus-summary-show-all-threads
4928 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4929
4930 @item T H
4931 @kindex T H (Summary)
4932 @findex gnus-summary-hide-all-threads
4933 Hide all threads (@code{gnus-summary-hide-all-threads}).
4934
4935 @item T t
4936 @kindex T t (Summary)
4937 @findex gnus-summary-rethread-current
4938 Re-thread the current article's thread
4939 (@code{gnus-summary-rethread-current}).  This works even when the
4940 summary buffer is otherwise unthreaded.
4941
4942 @item T ^
4943 @kindex T ^ (Summary)
4944 @findex gnus-summary-reparent-thread
4945 Make the current article the child of the marked (or previous) article
4946 (@code{gnus-summary-reparent-thread}).
4947
4948 @end table
4949
4950 The following commands are thread movement commands.  They all
4951 understand the numeric prefix.
4952
4953 @table @kbd
4954
4955 @item T n
4956 @kindex T n (Summary)
4957 @findex gnus-summary-next-thread
4958 Go to the next thread (@code{gnus-summary-next-thread}).
4959
4960 @item T p
4961 @kindex T p (Summary)
4962 @findex gnus-summary-prev-thread
4963 Go to the previous thread (@code{gnus-summary-prev-thread}).
4964
4965 @item T d
4966 @kindex T d (Summary)
4967 @findex gnus-summary-down-thread
4968 Descend the thread (@code{gnus-summary-down-thread}).
4969
4970 @item T u
4971 @kindex T u (Summary)
4972 @findex gnus-summary-up-thread
4973 Ascend the thread (@code{gnus-summary-up-thread}).
4974
4975 @item T o
4976 @kindex T o (Summary)
4977 @findex gnus-summary-top-thread
4978 Go to the top of the thread (@code{gnus-summary-top-thread}).
4979 @end table
4980
4981 @vindex gnus-thread-operation-ignore-subject 
4982 If you ignore subject while threading, you'll naturally end up with
4983 threads that have several different subjects in them.  If you then issue
4984 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4985 wish to kill the entire thread, but just those parts of the thread that
4986 have the same subject as the current article.  If you like this idea,
4987 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
4988 is non-@code{nil} (which it is by default), subjects will be ignored
4989 when doing thread commands.  If this variable is @code{nil}, articles in
4990 the same thread with different subjects will not be included in the
4991 operation in question.  If this variable is @code{fuzzy}, only articles
4992 that have subjects fuzzily equal will be included (@pxref{Fuzzy
4993 Matching}).
4994
4995
4996 @node Sorting
4997 @section Sorting
4998
4999 @findex gnus-thread-sort-by-total-score
5000 @findex gnus-thread-sort-by-date
5001 @findex gnus-thread-sort-by-score
5002 @findex gnus-thread-sort-by-subject
5003 @findex gnus-thread-sort-by-author
5004 @findex gnus-thread-sort-by-number
5005 @vindex gnus-thread-sort-functions
5006 If you are using a threaded summary display, you can sort the threads by
5007 setting @code{gnus-thread-sort-functions}, which is a list of functions.
5008 By default, sorting is done on article numbers.  Ready-made sorting
5009 predicate functions include @code{gnus-thread-sort-by-number},
5010 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5011 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5012 @code{gnus-thread-sort-by-total-score}.
5013
5014 Each function takes two threads and returns non-@code{nil} if the first
5015 thread should be sorted before the other.  Note that sorting really is
5016 normally done by looking only at the roots of each thread.  If you use
5017 more than one function, the primary sort key should be the last function
5018 in the list.  You should probably always include
5019 @code{gnus-thread-sort-by-number} in the list of sorting
5020 functions---preferably first.  This will ensure that threads that are
5021 equal with respect to the other sort criteria will be displayed in
5022 ascending article order.
5023
5024 If you would like to sort by score, then by subject, and finally by
5025 number, you could do something like:
5026
5027 @lisp
5028 (setq gnus-thread-sort-functions 
5029       '(gnus-thread-sort-by-number
5030         gnus-thread-sort-by-subject
5031         gnus-thread-sort-by-total-score))
5032 @end lisp
5033
5034 The threads that have highest score will be displayed first in the
5035 summary buffer.  When threads have the same score, they will be sorted
5036 alphabetically.  The threads that have the same score and the same
5037 subject will be sorted by number, which is (normally) the sequence in
5038 which the articles arrived.
5039
5040 If you want to sort by score and then reverse arrival order, you could
5041 say something like:
5042
5043 @lisp
5044 (setq gnus-thread-sort-functions
5045       '((lambda (t1 t2)
5046           (not (gnus-thread-sort-by-number t1 t2)))
5047         gnus-thread-sort-by-score))
5048 @end lisp
5049
5050 @vindex gnus-thread-score-function
5051 The function in the @code{gnus-thread-score-function} variable (default
5052 @code{+}) is used for calculating the total score of a thread.  Useful
5053 functions might be @code{max}, @code{min}, or squared means, or whatever
5054 tickles your fancy.
5055
5056 @findex gnus-article-sort-functions
5057 @findex gnus-article-sort-by-date
5058 @findex gnus-article-sort-by-score
5059 @findex gnus-article-sort-by-subject
5060 @findex gnus-article-sort-by-author
5061 @findex gnus-article-sort-by-number
5062 If you are using an unthreaded display for some strange reason or other,
5063 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5064 It is very similar to the @code{gnus-thread-sort-functions}, except that
5065 it uses slightly different functions for article comparison.  Available
5066 sorting predicate functions are @code{gnus-article-sort-by-number},
5067 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5068 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5069
5070 If you want to sort an unthreaded summary display by subject, you could
5071 say something like:
5072
5073 @lisp
5074 (setq gnus-article-sort-functions 
5075       '(gnus-article-sort-by-number
5076         gnus-article-sort-by-subject))
5077 @end lisp
5078
5079
5080
5081 @node Asynchronous Fetching
5082 @section Asynchronous Article Fetching
5083 @cindex asynchronous article fetching
5084 @cindex article pre-fetch
5085 @cindex pre-fetch
5086
5087 If you read your news from an @sc{nntp} server that's far away, the
5088 network latencies may make reading articles a chore.  You have to wait
5089 for a while after pressing @kbd{n} to go to the next article before the
5090 article appears.  Why can't Gnus just go ahead and fetch the article
5091 while you are reading the previous one?  Why not, indeed.
5092
5093 First, some caveats.  There are some pitfalls to using asynchronous
5094 article fetching, especially the way Gnus does it.  
5095
5096 Let's say you are reading article 1, which is short, and article 2 is
5097 quite long, and you are not interested in reading that.  Gnus does not
5098 know this, so it goes ahead and fetches article 2.  You decide to read
5099 article 3, but since Gnus is in the process of fetching article 2, the
5100 connection is blocked.
5101
5102 To avoid these situations, Gnus will open two (count 'em two)
5103 connections to the server.  Some people may think this isn't a very nice
5104 thing to do, but I don't see any real alternatives.  Setting up that
5105 extra connection takes some time, so Gnus startup will be slower.
5106
5107 Gnus will fetch more articles than you will read.  This will mean that
5108 the link between your machine and the @sc{nntp} server will become more
5109 loaded than if you didn't use article pre-fetch.  The server itself will
5110 also become more loaded---both with the extra article requests, and the
5111 extra connection.
5112
5113 Ok, so now you know that you shouldn't really use this thing...  unless
5114 you really want to.
5115
5116 @vindex gnus-asynchronous
5117 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5118 happen automatically.
5119
5120 @vindex gnus-use-article-prefetch
5121 You can control how many articles are to be pre-fetched by setting
5122 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5123 that when you read an article in the group, the backend will pre-fetch
5124 the next 30 articles.  If this variable is @code{t}, the backend will
5125 pre-fetch all the articles it can without bound.  If it is
5126 @code{nil}, no pre-fetching will be done.
5127
5128 @vindex gnus-async-prefetch-article-p
5129 @findex gnus-async-read-p
5130 There are probably some articles that you don't want to pre-fetch---read
5131 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5132 return non-@code{nil} when the article in question is to be
5133 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5134 @code{nil} on read articles.  The function is called with an article
5135 data structure as the only parameter.
5136
5137 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5138
5139 @lisp
5140 (defun my-async-short-unread-p (data)
5141   "Return non-nil for short, unread articles."
5142   (and (gnus-data-unread-p data)
5143        (< (mail-header-lines (gnus-data-header data))
5144           100)))
5145
5146 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5147 @end lisp
5148
5149 These functions will be called many, many times, so they should
5150 preferably be short and sweet to avoid slowing down Gnus too much.
5151 It's probably a good idea to byte-compile things like this.
5152
5153 @vindex gnus-prefetched-article-deletion-strategy
5154 Articles have to be removed from the asynch buffer sooner or later.  The
5155 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5156 articles.  This is a list that may contain the following elements:
5157
5158 @table @code
5159 @item read
5160 Remove articles when they are read.
5161
5162 @item exit
5163 Remove articles when exiting the group.
5164 @end table
5165
5166 The default value is @code{(read exit)}.
5167
5168 @vindex gnus-use-header-prefetch
5169 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5170 from the next group.
5171
5172
5173 @node Article Caching
5174 @section Article Caching
5175 @cindex article caching
5176 @cindex caching
5177
5178 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5179 consider turning article caching on.  Each article will then be stored
5180 locally under your home directory.  As you may surmise, this could
5181 potentially use @emph{huge} amounts of disk space, as well as eat up all
5182 your inodes so fast it will make your head swim.  In vodka.
5183
5184 Used carefully, though, it could be just an easier way to save articles.
5185
5186 @vindex gnus-use-long-file-name
5187 @vindex gnus-cache-directory
5188 @vindex gnus-use-cache
5189 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5190 all articles ticked or marked as dormant will then be copied
5191 over to your local cache (@code{gnus-cache-directory}).  Whether this
5192 cache is flat or hierarchal is controlled by the
5193 @code{gnus-use-long-file-name} variable, as usual.
5194
5195 When re-selecting a ticked or dormant article, it will be fetched from the
5196 cache instead of from the server.  As articles in your cache will never
5197 expire, this might serve as a method of saving articles while still
5198 keeping them where they belong.  Just mark all articles you want to save
5199 as dormant, and don't worry.
5200
5201 When an article is marked as read, is it removed from the cache.
5202
5203 @vindex gnus-cache-remove-articles
5204 @vindex gnus-cache-enter-articles
5205 The entering/removal of articles from the cache is controlled by the
5206 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5207 variables.  Both are lists of symbols.  The first is @code{(ticked
5208 dormant)} by default, meaning that ticked and dormant articles will be
5209 put in the cache.  The latter is @code{(read)} by default, meaning that
5210 articles marked as read are removed from the cache.  Possibly
5211 symbols in these two lists are @code{ticked}, @code{dormant},
5212 @code{unread} and @code{read}.
5213
5214 @findex gnus-jog-cache
5215 So where does the massive article-fetching and storing come into the
5216 picture?  The @code{gnus-jog-cache} command will go through all
5217 subscribed newsgroups, request all unread articles, score them, and
5218 store them in the cache.  You should only ever, ever ever ever, use this
5219 command if 1) your connection to the @sc{nntp} server is really, really,
5220 really slow and 2) you have a really, really, really huge disk.
5221 Seriously.  One way to cut down on the number of articles downloaded is
5222 to score unwanted articles down and have them marked as read.  They will
5223 not then be downloaded by this command.
5224
5225 @vindex gnus-uncacheable-groups
5226 It is likely that you do not want caching on some groups.  For instance,
5227 if your @code{nnml} mail is located under your home directory, it makes no
5228 sense to cache it somewhere else under your home directory.  Unless you
5229 feel that it's neat to use twice as much space.  To limit the caching,
5230 you could set the @code{gnus-uncacheable-groups} regexp to
5231 @samp{^nnml}, for instance.  This variable is @code{nil} by
5232 default.
5233
5234 @findex gnus-cache-generate-nov-databases
5235 @findex gnus-cache-generate-active
5236 @vindex gnus-cache-active-file
5237 The cache stores information on what articles it contains in its active
5238 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5239 of the cache) becomes all messed up for some reason or other, Gnus
5240 offers two functions that will try to set things right.  @kbd{M-x
5241 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5242 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5243 file.
5244
5245
5246 @node Persistent Articles
5247 @section Persistent Articles
5248 @cindex persistent articles
5249
5250 Closely related to article caching, we have @dfn{persistent articles}.
5251 In fact, it's just a different way of looking at caching, and much more
5252 useful in my opinion.
5253
5254 Say you're reading a newsgroup, and you happen on to some valuable gem
5255 that you want to keep and treasure forever.  You'd normally just save it
5256 (using one of the many saving commands) in some file.  The problem with
5257 that is that it's just, well, yucky.  Ideally you'd prefer just having
5258 the article remain in the group where you found it forever; untouched by
5259 the expiry going on at the news server.
5260
5261 This is what a @dfn{persistent article} is---an article that just won't
5262 be deleted.  It's implemented using the normal cache functions, but
5263 you use two explicit commands for managing persistent articles:
5264
5265 @table @kbd
5266
5267 @item *
5268 @kindex * (Summary)
5269 @findex gnus-cache-enter-article
5270 Make the current article persistent (@code{gnus-cache-enter-article}). 
5271
5272 @item M-*
5273 @kindex M-* (Summary)
5274 @findex gnus-cache-remove-article
5275 Remove the current article from the persistent articles
5276 (@code{gnus-cache-remove-article}).  This will normally delete the
5277 article. 
5278 @end table
5279
5280 Both these commands understand the process/prefix convention. 
5281
5282 To avoid having all ticked articles (and stuff) entered into the cache,
5283 you should set @code{gnus-use-cache} to @code{passive} if you're just
5284 interested in persistent articles:
5285
5286 @lisp
5287 (setq gnus-use-cache 'passive)
5288 @end lisp
5289
5290
5291 @node Article Backlog
5292 @section Article Backlog
5293 @cindex backlog
5294 @cindex article backlog
5295
5296 If you have a slow connection, but the idea of using caching seems
5297 unappealing to you (and it is, really), you can help the situation some
5298 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5299 already read articles so that it doesn't have to re-fetch articles
5300 you've already read.  This only helps if you are in the habit of
5301 re-selecting articles you've recently read, of course.  If you never do
5302 that, turning the backlog on will slow Gnus down a little bit, and
5303 increase memory usage some.
5304
5305 @vindex gnus-keep-backlog
5306 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5307 at most @var{n} old articles in a buffer for later re-fetching.  If this
5308 variable is non-@code{nil} and is not a number, Gnus will store
5309 @emph{all} read articles, which means that your Emacs will grow without
5310 bound before exploding and taking your machine down with you.  I put
5311 that in there just to keep y'all on your toes.  
5312
5313 This variable is @code{nil} by default.
5314
5315
5316 @node Saving Articles
5317 @section Saving Articles
5318 @cindex saving articles
5319
5320 Gnus can save articles in a number of ways.  Below is the documentation
5321 for saving articles in a fairly straight-forward fashion (i.e., little
5322 processing of the article is done before it is saved).  For a different
5323 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5324 (@pxref{Decoding Articles}).
5325
5326 @vindex gnus-save-all-headers
5327 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5328 unwanted headers before saving the article.
5329
5330 @vindex gnus-saved-headers
5331 If the preceding variable is @code{nil}, all headers that match the
5332 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5333 deleted before saving.
5334
5335 @table @kbd
5336
5337 @item O o
5338 @itemx o
5339 @kindex O o (Summary)
5340 @kindex o (Summary)
5341 @findex gnus-summary-save-article
5342 @c @icon{gnus-summary-save-article}
5343 Save the current article using the default article saver
5344 (@code{gnus-summary-save-article}). 
5345
5346 @item O m
5347 @kindex O m (Summary)
5348 @findex gnus-summary-save-article-mail
5349 Save the current article in mail format
5350 (@code{gnus-summary-save-article-mail}). 
5351
5352 @item O r
5353 @kindex O r (Summary)
5354 @findex gnus-summary-save-article-rmail
5355 Save the current article in rmail format
5356 (@code{gnus-summary-save-article-rmail}). 
5357
5358 @item O f
5359 @kindex O f (Summary)
5360 @findex gnus-summary-save-article-file
5361 @c @icon{gnus-summary-save-article-file}
5362 Save the current article in plain file format
5363 (@code{gnus-summary-save-article-file}). 
5364
5365 @item O F
5366 @kindex O F (Summary)
5367 @findex gnus-summary-write-article-file
5368 Write the current article in plain file format, overwriting any previous
5369 file contents (@code{gnus-summary-write-article-file}). 
5370
5371 @item O b
5372 @kindex O b (Summary)
5373 @findex gnus-summary-save-article-body-file
5374 Save the current article body in plain file format
5375 (@code{gnus-summary-save-article-body-file}). 
5376
5377 @item O h
5378 @kindex O h (Summary)
5379 @findex gnus-summary-save-article-folder
5380 Save the current article in mh folder format
5381 (@code{gnus-summary-save-article-folder}). 
5382
5383 @item O v
5384 @kindex O v (Summary)
5385 @findex gnus-summary-save-article-vm
5386 Save the current article in a VM folder
5387 (@code{gnus-summary-save-article-vm}).
5388
5389 @item O p
5390 @kindex O p (Summary)
5391 @findex gnus-summary-pipe-output
5392 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5393 the current article to a process (@code{gnus-summary-pipe-output}).
5394 @end table
5395
5396 @vindex gnus-prompt-before-saving
5397 All these commands use the process/prefix convention
5398 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5399 functions, you might get tired of being prompted for files to save each
5400 and every article in.  The prompting action is controlled by
5401 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5402 default, giving you that excessive prompting action you know and
5403 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5404 just once for each series of articles you save.  If you like to really
5405 have Gnus do all your thinking for you, you can even set this variable
5406 to @code{nil}, which means that you will never be prompted for files to
5407 save articles in.  Gnus will simply save all the articles in the default
5408 files. 
5409
5410
5411 @vindex gnus-default-article-saver
5412 You can customize the @code{gnus-default-article-saver} variable to make
5413 Gnus do what you want it to.  You can use any of the four ready-made
5414 functions below, or you can create your own.
5415
5416 @table @code
5417
5418 @item gnus-summary-save-in-rmail
5419 @findex gnus-summary-save-in-rmail
5420 @vindex gnus-rmail-save-name
5421 @findex gnus-plain-save-name
5422 This is the default format, @dfn{babyl}.  Uses the function in the
5423 @code{gnus-rmail-save-name} variable to get a file name to save the
5424 article in.  The default is @code{gnus-plain-save-name}.
5425
5426 @item gnus-summary-save-in-mail
5427 @findex gnus-summary-save-in-mail
5428 @vindex gnus-mail-save-name
5429 Save in a Unix mail (mbox) file.  Uses the function in the
5430 @code{gnus-mail-save-name} variable to get a file name to save the
5431 article in.  The default is @code{gnus-plain-save-name}.
5432
5433 @item gnus-summary-save-in-file
5434 @findex gnus-summary-save-in-file
5435 @vindex gnus-file-save-name
5436 @findex gnus-numeric-save-name
5437 Append the article straight to an ordinary file.  Uses the function in
5438 the @code{gnus-file-save-name} variable to get a file name to save the
5439 article in.  The default is @code{gnus-numeric-save-name}.
5440
5441 @item gnus-summary-save-body-in-file
5442 @findex gnus-summary-save-body-in-file
5443 Append the article body to an ordinary file.  Uses the function in the
5444 @code{gnus-file-save-name} variable to get a file name to save the
5445 article in.  The default is @code{gnus-numeric-save-name}.
5446
5447 @item gnus-summary-save-in-folder
5448 @findex gnus-summary-save-in-folder
5449 @findex gnus-folder-save-name
5450 @findex gnus-Folder-save-name
5451 @vindex gnus-folder-save-name
5452 @cindex rcvstore
5453 @cindex MH folders
5454 Save the article to an MH folder using @code{rcvstore} from the MH
5455 library.  Uses the function in the @code{gnus-folder-save-name} variable
5456 to get a file name to save the article in.  The default is
5457 @code{gnus-folder-save-name}, but you can also use
5458 @code{gnus-Folder-save-name}, which creates capitalized names.
5459
5460 @item gnus-summary-save-in-vm
5461 @findex gnus-summary-save-in-vm
5462 Save the article in a VM folder.  You have to have the VM mail
5463 reader to use this setting.
5464 @end table
5465
5466 @vindex gnus-article-save-directory
5467 All of these functions, except for the last one, will save the article
5468 in the @code{gnus-article-save-directory}, which is initialized from the
5469 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5470 default. 
5471
5472 As you can see above, the functions use different functions to find a
5473 suitable name of a file to save the article in.  Below is a list of
5474 available functions that generate names:
5475
5476 @table @code
5477
5478 @item gnus-Numeric-save-name
5479 @findex gnus-Numeric-save-name
5480 File names like @file{~/News/Alt.andrea-dworkin/45}.
5481
5482 @item gnus-numeric-save-name
5483 @findex gnus-numeric-save-name
5484 File names like @file{~/News/alt.andrea-dworkin/45}.
5485
5486 @item gnus-Plain-save-name
5487 @findex gnus-Plain-save-name
5488 File names like @file{~/News/Alt.andrea-dworkin}.
5489
5490 @item gnus-plain-save-name
5491 @findex gnus-plain-save-name
5492 File names like @file{~/News/alt.andrea-dworkin}.
5493 @end table
5494
5495 @vindex gnus-split-methods
5496 You can have Gnus suggest where to save articles by plonking a regexp into
5497 the @code{gnus-split-methods} alist.  For instance, if you would like to
5498 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5499 related to VM in @code{vm-stuff}, you could set this variable to something
5500 like:
5501
5502 @lisp
5503 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5504  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5505  (my-choosing-function "../other-dir/my-stuff")
5506  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5507 @end lisp
5508
5509 We see that this is a list where each element is a list that has two
5510 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5511 a string (in which case it is used as a regexp to match on the article
5512 head); it can be a symbol (which will be called as a function with the
5513 group name as a parameter); or it can be a list (which will be
5514 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5515 the @dfn{file} will be used as a default prompt.  In addition, the
5516 result of the operation itself will be used if the function or form
5517 called returns a string or a list of strings.
5518
5519 You basically end up with a list of file names that might be used when
5520 saving the current article.  (All ``matches'' will be used.)  You will
5521 then be prompted for what you really want to use as a name, with file
5522 name completion over the results from applying this variable.
5523
5524 This variable is @code{((gnus-article-archive-name))} by default, which
5525 means that Gnus will look at the articles it saves for an
5526 @code{Archive-name} line and use that as a suggestion for the file
5527 name. 
5528
5529 Here's an example function to clean up file names somewhat.  If you have
5530 lots of mail groups called things like
5531 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5532 these group names before creating the file name to save to.  The
5533 following will do just that:
5534
5535 @lisp
5536 (defun my-save-name (group)
5537   (when (string-match "^nnml:mail." group)
5538     (substring group (match-end 0))))
5539
5540 (setq gnus-split-methods
5541       '((gnus-article-archive-name)
5542         (my-save-name)))
5543 @end lisp
5544
5545
5546 @vindex gnus-use-long-file-name
5547 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5548 @code{nil}, all the preceding functions will replace all periods
5549 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5550 the functions will generate hierarchies of directories instead of having
5551 all the files in the toplevel directory
5552 (@file{~/News/alt/andrea-dworkin} instead of
5553 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5554 on most systems.  However, for historical reasons, this is @code{nil} on
5555 Xenix and usg-unix-v machines by default.
5556
5557 This function also affects kill and score file names.  If this variable
5558 is a list, and the list contains the element @code{not-score}, long file
5559 names will not be used for score files, if it contains the element
5560 @code{not-save}, long file names will not be used for saving, and if it
5561 contains the element @code{not-kill}, long file names will not be used
5562 for kill files.
5563
5564 If you'd like to save articles in a hierarchy that looks something like
5565 a spool, you could
5566
5567 @lisp
5568 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5569 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5570 @end lisp
5571
5572 Then just save with @kbd{o}.  You'd then read this hierarchy with
5573 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5574 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5575 around to the groups/directories with @code{nneething}.
5576
5577
5578 @node Decoding Articles
5579 @section Decoding Articles
5580 @cindex decoding articles
5581
5582 Sometime users post articles (or series of articles) that have been
5583 encoded in some way or other.  Gnus can decode them for you.
5584
5585 @menu 
5586 * Uuencoded Articles::    Uudecode articles.
5587 * Shell Archives::        Unshar articles.
5588 * PostScript Files::      Split PostScript.
5589 * Other Files::           Plain save and binhex.
5590 * Decoding Variables::    Variables for a happy decoding.
5591 * Viewing Files::         You want to look at the result of the decoding?
5592 @end menu
5593
5594 @cindex series
5595 @cindex article series
5596 All these functions use the process/prefix convention
5597 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5598 the extension that a ``single article'' means ``a single series''.  Gnus
5599 can find out by itself what articles belong to a series, decode all the
5600 articles and unpack/view/save the resulting file(s).
5601
5602 Gnus guesses what articles are in the series according to the following
5603 simplish rule: The subjects must be (nearly) identical, except for the
5604 last two numbers of the line.  (Spaces are largely ignored, however.)
5605
5606 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5607 will find all the articles that match the regexp @samp{^cat.gif
5608 ([0-9]+/[0-9]+).*$}.  
5609
5610 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5611 series}, will not be properly recognized by any of the automatic viewing
5612 commands, and you have to mark the articles manually with @kbd{#}.
5613
5614
5615 @node Uuencoded Articles
5616 @subsection Uuencoded Articles
5617 @cindex uudecode
5618 @cindex uuencoded articles
5619
5620 @table @kbd
5621
5622 @item X u
5623 @kindex X u (Summary)
5624 @findex gnus-uu-decode-uu
5625 @c @icon{gnus-uu-decode-uu}
5626 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5627
5628 @item X U
5629 @kindex X U (Summary)
5630 @findex gnus-uu-decode-uu-and-save
5631 Uudecodes and saves the current series
5632 (@code{gnus-uu-decode-uu-and-save}).
5633
5634 @item X v u
5635 @kindex X v u (Summary)
5636 @findex gnus-uu-decode-uu-view
5637 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5638
5639 @item X v U
5640 @kindex X v U (Summary)
5641 @findex gnus-uu-decode-uu-and-save-view
5642 Uudecodes, views and saves the current series
5643 (@code{gnus-uu-decode-uu-and-save-view}).
5644
5645 @end table
5646
5647 Remember that these all react to the presence of articles marked with
5648 the process mark.  If, for instance, you'd like to decode and save an
5649 entire newsgroup, you'd typically do @kbd{M P a}
5650 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5651 (@code{gnus-uu-decode-uu-and-save}).
5652
5653 All this is very much different from how @code{gnus-uu} worked with
5654 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5655 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5656 articles in some way (@pxref{Setting Process Marks}) and then press
5657 @kbd{X u}.
5658
5659 @vindex gnus-uu-notify-files
5660 Note: When trying to decode articles that have names matching
5661 @code{gnus-uu-notify-files}, which is hard-coded to
5662 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5663 automatically post an article on @samp{comp.unix.wizards} saying that
5664 you have just viewed the file in question.  This feature can't be turned
5665 off.
5666
5667
5668 @node Shell Archives
5669 @subsection Shell Archives
5670 @cindex unshar
5671 @cindex shell archives
5672 @cindex shared articles
5673
5674 Shell archives (``shar files'') used to be a popular way to distribute
5675 sources, but it isn't used all that much today.  In any case, we have
5676 some commands to deal with these:
5677
5678 @table @kbd
5679
5680 @item X s
5681 @kindex X s (Summary)
5682 @findex gnus-uu-decode-unshar
5683 Unshars the current series (@code{gnus-uu-decode-unshar}).
5684
5685 @item X S
5686 @kindex X S (Summary)
5687 @findex gnus-uu-decode-unshar-and-save
5688 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5689
5690 @item X v s
5691 @kindex X v s (Summary)
5692 @findex gnus-uu-decode-unshar-view
5693 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5694
5695 @item X v S
5696 @kindex X v S (Summary)
5697 @findex gnus-uu-decode-unshar-and-save-view
5698 Unshars, views and saves the current series
5699 (@code{gnus-uu-decode-unshar-and-save-view}). 
5700 @end table
5701
5702
5703 @node PostScript Files
5704 @subsection PostScript Files
5705 @cindex PostScript
5706
5707 @table @kbd
5708
5709 @item X p
5710 @kindex X p (Summary)
5711 @findex gnus-uu-decode-postscript
5712 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5713
5714 @item X P
5715 @kindex X P (Summary)
5716 @findex gnus-uu-decode-postscript-and-save
5717 Unpack and save the current PostScript series
5718 (@code{gnus-uu-decode-postscript-and-save}).
5719
5720 @item X v p
5721 @kindex X v p (Summary)
5722 @findex gnus-uu-decode-postscript-view
5723 View the current PostScript series
5724 (@code{gnus-uu-decode-postscript-view}).
5725
5726 @item X v P
5727 @kindex X v P (Summary)
5728 @findex gnus-uu-decode-postscript-and-save-view
5729 View and save the current PostScript series
5730 (@code{gnus-uu-decode-postscript-and-save-view}). 
5731 @end table
5732
5733
5734 @node Other Files
5735 @subsection Other Files
5736
5737 @table @kbd
5738 @item X o
5739 @kindex X o (Summary)
5740 @findex gnus-uu-decode-save
5741 Save the current series
5742 (@code{gnus-uu-decode-save}).
5743
5744 @item X b
5745 @kindex X b (Summary)
5746 @findex gnus-uu-decode-binhex
5747 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
5748 doesn't really work yet.
5749 @end table
5750
5751
5752 @node Decoding Variables
5753 @subsection Decoding Variables
5754
5755 Adjective, not verb.
5756
5757 @menu 
5758 * Rule Variables::          Variables that say how a file is to be viewed.
5759 * Other Decode Variables::  Other decode variables.
5760 * Uuencoding and Posting::  Variables for customizing uuencoding.
5761 @end menu
5762
5763
5764 @node Rule Variables
5765 @subsubsection Rule Variables
5766 @cindex rule variables
5767
5768 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5769 variables are of the form
5770   
5771 @lisp
5772       (list '(regexp1 command2)
5773             '(regexp2 command2)
5774             ...)
5775 @end lisp
5776
5777 @table @code
5778
5779 @item gnus-uu-user-view-rules
5780 @vindex gnus-uu-user-view-rules
5781 @cindex sox
5782 This variable is consulted first when viewing files.  If you wish to use,
5783 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5784 say something like:
5785 @lisp
5786 (setq gnus-uu-user-view-rules
5787       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5788 @end lisp
5789
5790 @item gnus-uu-user-view-rules-end
5791 @vindex gnus-uu-user-view-rules-end
5792 This variable is consulted if Gnus couldn't make any matches from the
5793 user and default view rules.
5794
5795 @item gnus-uu-user-archive-rules
5796 @vindex gnus-uu-user-archive-rules
5797 This variable can be used to say what commands should be used to unpack
5798 archives.
5799 @end table
5800
5801
5802 @node Other Decode Variables
5803 @subsubsection Other Decode Variables
5804
5805 @table @code
5806 @vindex gnus-uu-grabbed-file-functions
5807
5808 @item gnus-uu-grabbed-file-functions
5809 All functions in this list will be called right after each file has been
5810 successfully decoded---so that you can move or view files right away,
5811 and don't have to wait for all files to be decoded before you can do
5812 anything.  Ready-made functions you can put in this list are:
5813
5814 @table @code
5815
5816 @item gnus-uu-grab-view
5817 @findex gnus-uu-grab-view
5818 View the file.
5819
5820 @item gnus-uu-grab-move
5821 @findex gnus-uu-grab-move
5822 Move the file (if you're using a saving function.)
5823 @end table
5824
5825 @item gnus-uu-be-dangerous
5826 @vindex gnus-uu-be-dangerous
5827 Specifies what to do if unusual situations arise during decoding.  If
5828 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5829 that didn't work, and overwrite existing files.  Otherwise, ask each
5830 time.
5831
5832 @item gnus-uu-ignore-files-by-name
5833 @vindex gnus-uu-ignore-files-by-name
5834 Files with name matching this regular expression won't be viewed.
5835
5836 @item gnus-uu-ignore-files-by-type
5837 @vindex gnus-uu-ignore-files-by-type
5838 Files with a @sc{mime} type matching this variable won't be viewed.
5839 Note that Gnus tries to guess what type the file is based on the name.
5840 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5841 kludgey.
5842
5843 @item gnus-uu-tmp-dir
5844 @vindex gnus-uu-tmp-dir
5845 Where @code{gnus-uu} does its work.
5846
5847 @item gnus-uu-do-not-unpack-archives
5848 @vindex gnus-uu-do-not-unpack-archives
5849 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5850 looking for files to display.
5851
5852 @item gnus-uu-view-and-save
5853 @vindex gnus-uu-view-and-save
5854 Non-@code{nil} means that the user will always be asked to save a file
5855 after viewing it.
5856
5857 @item gnus-uu-ignore-default-view-rules
5858 @vindex gnus-uu-ignore-default-view-rules
5859 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5860 rules.
5861
5862 @item gnus-uu-ignore-default-archive-rules
5863 @vindex gnus-uu-ignore-default-archive-rules
5864 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5865 unpacking commands.
5866
5867 @item gnus-uu-kill-carriage-return
5868 @vindex gnus-uu-kill-carriage-return
5869 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5870 from articles.
5871
5872 @item gnus-uu-unmark-articles-not-decoded
5873 @vindex gnus-uu-unmark-articles-not-decoded
5874 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5875 decoded articles as unread.
5876
5877 @item gnus-uu-correct-stripped-uucode
5878 @vindex gnus-uu-correct-stripped-uucode
5879 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5880 uuencoded files that have had trailing spaces deleted.
5881
5882 @item gnus-uu-pre-uudecode-hook
5883 @vindex gnus-uu-pre-uudecode-hook
5884 Hook run before sending a message to @code{uudecode}.
5885
5886 @item gnus-uu-view-with-metamail
5887 @vindex gnus-uu-view-with-metamail
5888 @cindex metamail
5889 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5890 commands defined by the rule variables and just fudge a @sc{mime}
5891 content type based on the file name.  The result will be fed to
5892 @code{metamail} for viewing.
5893
5894 @item gnus-uu-save-in-digest
5895 @vindex gnus-uu-save-in-digest
5896 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5897 decoding, will save in digests.  If this variable is @code{nil},
5898 @code{gnus-uu} will just save everything in a file without any
5899 embellishments.  The digesting almost conforms to RFC1153---no easy way
5900 to specify any meaningful volume and issue numbers were found, so I
5901 simply dropped them.
5902
5903 @end table
5904
5905
5906 @node Uuencoding and Posting
5907 @subsubsection Uuencoding and Posting
5908
5909 @table @code
5910
5911 @item gnus-uu-post-include-before-composing
5912 @vindex gnus-uu-post-include-before-composing
5913 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5914 before you compose the article.  If this variable is @code{t}, you can
5915 either include an encoded file with @kbd{C-c C-i} or have one included
5916 for you when you post the article.
5917
5918 @item gnus-uu-post-length
5919 @vindex gnus-uu-post-length
5920 Maximum length of an article.  The encoded file will be split into how
5921 many articles it takes to post the entire file.
5922
5923 @item gnus-uu-post-threaded
5924 @vindex gnus-uu-post-threaded
5925 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5926 thread.  This may not be smart, as no other decoder I have seen is able
5927 to follow threads when collecting uuencoded articles.  (Well, I have
5928 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5929 think that counts...) Default is @code{nil}.
5930
5931 @item gnus-uu-post-separate-description
5932 @vindex gnus-uu-post-separate-description
5933 Non-@code{nil} means that the description will be posted in a separate
5934 article.  The first article will typically be numbered (0/x).  If this
5935 variable is @code{nil}, the description the user enters will be included
5936 at the beginning of the first article, which will be numbered (1/x).
5937 Default is @code{t}.
5938
5939 @end table
5940
5941
5942 @node Viewing Files
5943 @subsection Viewing Files
5944 @cindex viewing files
5945 @cindex pseudo-articles
5946
5947 After decoding, if the file is some sort of archive, Gnus will attempt
5948 to unpack the archive and see if any of the files in the archive can be
5949 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5950 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5951 uncompress and de-tar the main file, and then view the two pictures.
5952 This unpacking process is recursive, so if the archive contains archives
5953 of archives, it'll all be unpacked.
5954
5955 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5956 extracted file into the summary buffer.  If you go to these
5957 ``articles'', you will be prompted for a command to run (usually Gnus
5958 will make a suggestion), and then the command will be run.
5959
5960 @vindex gnus-view-pseudo-asynchronously
5961 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5962 until the viewing is done before proceeding.
5963
5964 @vindex gnus-view-pseudos
5965 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5966 the pseudo-articles into the summary buffer, but view them
5967 immediately.  If this variable is @code{not-confirm}, the user won't even
5968 be asked for a confirmation before viewing is done.
5969
5970 @vindex gnus-view-pseudos-separately 
5971 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5972 pseudo-article will be created for each file to be viewed.  If
5973 @code{nil}, all files that use the same viewing command will be given as
5974 a list of parameters to that command.
5975
5976 @vindex gnus-insert-pseudo-articles
5977 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5978 pseudo-articles when decoding.  It is @code{t} by default.
5979
5980 So; there you are, reading your @emph{pseudo-articles} in your
5981 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5982 Why isn't anything real anymore? How did we get here?
5983
5984
5985 @node Article Treatment
5986 @section Article Treatment
5987
5988 Reading through this huge manual, you may have quite forgotten that the
5989 object of newsreaders is to actually, like, read what people have
5990 written.  Reading articles.  Unfortunately, people are quite bad at
5991 writing, so there are tons of functions and variables to make reading
5992 these articles easier.
5993
5994 @menu
5995 * Article Highlighting::    You want to make the article look like fruit salad.
5996 * Article Fontisizing::     Making emphasized text look niced.
5997 * Article Hiding::          You also want to make certain info go away.
5998 * Article Washing::         Lots of way-neat functions to make life better.
5999 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6000 * Article Date::            Grumble, UT!
6001 * Article Signature::       What is a signature?
6002 @end menu
6003
6004
6005 @node Article Highlighting
6006 @subsection Article Highlighting
6007 @cindex highlight
6008
6009 Not only do you want your article buffer to look like fruit salad, but
6010 you want it to look like technicolor fruit salad.
6011
6012 @table @kbd
6013
6014 @item W H a
6015 @kindex W H a (Summary)
6016 @findex gnus-article-highlight
6017 Highlight the current article (@code{gnus-article-highlight}).
6018
6019 @item W H h
6020 @kindex W H h (Summary)
6021 @findex gnus-article-highlight-headers
6022 @vindex gnus-header-face-alist
6023 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6024 highlighting will be done according to the @code{gnus-header-face-alist}
6025 variable, which is a list where each element has the form @var{(regexp
6026 name content)}.  @var{regexp} is a regular expression for matching the
6027 header, @var{name} is the face used for highlighting the header name
6028 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6029 the header value.  The first match made will be used.  Note that
6030 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6031
6032 @item W H c
6033 @kindex W H c (Summary)
6034 @findex gnus-article-highlight-citation
6035 Highlight cited text (@code{gnus-article-highlight-citation}). 
6036
6037 Some variables to customize the citation highlights:
6038
6039 @table @code
6040 @vindex gnus-cite-parse-max-size
6041
6042 @item gnus-cite-parse-max-size
6043 If the article size if bigger than this variable (which is 25000 by
6044 default), no citation highlighting will be performed.  
6045
6046 @item gnus-cite-prefix-regexp
6047 @vindex gnus-cite-prefix-regexp
6048 Regexp matching the longest possible citation prefix on a line. 
6049
6050 @item gnus-cite-max-prefix
6051 @vindex gnus-cite-max-prefix
6052 Maximum possible length for a citation prefix (default 20).
6053
6054 @item gnus-cite-face-list
6055 @vindex gnus-cite-face-list
6056 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6057 When there are citations from multiple articles in the same message,
6058 Gnus will try to give each citation from each article its own face.
6059 This should make it easier to see who wrote what.
6060
6061 @item gnus-supercite-regexp
6062 @vindex gnus-supercite-regexp
6063 Regexp matching normal Supercite attribution lines.  
6064
6065 @item gnus-supercite-secondary-regexp
6066 @vindex gnus-supercite-secondary-regexp
6067 Regexp matching mangled Supercite attribution lines.
6068
6069 @item gnus-cite-minimum-match-count
6070 @vindex gnus-cite-minimum-match-count
6071 Minimum number of identical prefixes we have to see before we believe
6072 that it's a citation.
6073
6074 @item gnus-cite-attribution-prefix
6075 @vindex gnus-cite-attribution-prefix
6076 Regexp matching the beginning of an attribution line.
6077
6078 @item gnus-cite-attribution-suffix
6079 @vindex gnus-cite-attribution-suffix
6080 Regexp matching the end of an attribution line.
6081
6082 @item gnus-cite-attribution-face
6083 @vindex gnus-cite-attribution-face
6084 Face used for attribution lines.  It is merged with the face for the
6085 cited text belonging to the attribution.
6086
6087 @end table
6088
6089
6090 @item W H s
6091 @kindex W H s (Summary)
6092 @vindex gnus-signature-separator
6093 @vindex gnus-signature-face
6094 @findex gnus-article-highlight-signature
6095 Highlight the signature (@code{gnus-article-highlight-signature}).
6096 Everything after @code{gnus-signature-separator} (@pxref{Article
6097 Signature}) in an article will be considered a signature and will be
6098 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6099 default.
6100
6101 @end table
6102
6103
6104 @node Article Fontisizing
6105 @subsection Article Fontisizing
6106 @cindex emphasis
6107 @cindex article emphasis
6108
6109 @findex gnus-article-emphasize
6110 @kindex W e (Summary)
6111 People commonly add emphasis to words in news articles by writing things
6112 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
6113 running the article through the @kbd{W e}
6114 (@code{gnus-article-emphasize}) command.
6115
6116 @vindex gnus-article-emphasis
6117 How the emphasis is computed is controlled by the
6118 @code{gnus-article-emphasis} variable.  This is an alist where the first
6119 element is a regular expression to be matched.  The second is a number
6120 that says what regular expression grouping is used to find the entire
6121 emphasized word.  The third is a number that says what regexp grouping
6122 should be displayed and highlighted.  (The text between these two
6123 groupings will be hidden.)  The fourth is the face used for
6124 highlighting.
6125
6126 @lisp
6127 (setq gnus-article-emphasis
6128       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6129         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6130 @end lisp
6131
6132 @vindex gnus-emphasis-underline
6133 @vindex gnus-emphasis-bold
6134 @vindex gnus-emphasis-italic
6135 @vindex gnus-emphasis-underline-bold
6136 @vindex gnus-emphasis-underline-italic
6137 @vindex gnus-emphasis-bold-italic
6138 @vindex gnus-emphasis-underline-bold-italic
6139 By default, there are seven rules, and they use the following faces:
6140 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6141 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6142 @code{gnus-emphasis-underline-italic},
6143 @code{gnus-emphasis-underline-bold}, and
6144 @code{gnus-emphasis-underline-bold-italic}.  
6145
6146 If you want to change these faces, you can either use @kbd{M-x
6147 customize}, or you can use @code{copy-face}.  For instance, if you want
6148 to make @code{gnus-emphasis-italic} use a red face instead, you could
6149 say something like:
6150
6151 @lisp
6152 (copy-face 'red 'gnus-emphasis-italic)
6153 @end lisp
6154
6155
6156 @node Article Hiding
6157 @subsection Article Hiding
6158 @cindex article hiding
6159
6160 Or rather, hiding certain things in each article.  There usually is much
6161 too much cruft in most articles.  
6162
6163 @table @kbd
6164
6165 @item W W a
6166 @kindex W W a (Summary)
6167 @findex gnus-article-hide
6168 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
6169
6170 @item W W h
6171 @kindex W W h (Summary)
6172 @findex gnus-article-hide-headers
6173 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
6174 Headers}. 
6175
6176 @item W W b
6177 @kindex W W b (Summary)
6178 @findex gnus-article-hide-boring-headers
6179 Hide headers that aren't particularly interesting
6180 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6181
6182 @item W W s
6183 @kindex W W s (Summary)
6184 @findex gnus-article-hide-signature
6185 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6186 Signature}. 
6187
6188 @item W W p
6189 @kindex W W p (Summary)
6190 @findex gnus-article-hide-pgp
6191 @vindex gnus-article-hide-pgp-hook
6192 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6193 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6194 signature has been hidden.
6195
6196 @item W W P
6197 @kindex W W P (Summary)
6198 @findex gnus-article-hide-pem
6199 Hide @sc{pem} (privacy enhanced messages) cruft
6200 (@code{gnus-article-hide-pem}).
6201
6202 @item W W c
6203 @kindex W W c (Summary)
6204 @findex gnus-article-hide-citation
6205 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6206 customizing the hiding:
6207
6208 @table @code
6209
6210 @item gnus-cite-hide-percentage
6211 @vindex gnus-cite-hide-percentage
6212 If the cited text is of a bigger percentage than this variable (default
6213 50), hide the cited text.
6214
6215 @item gnus-cite-hide-absolute
6216 @vindex gnus-cite-hide-absolute
6217 The cited text must have at least this length (default 10) before it
6218 is hidden.
6219
6220 @item gnus-cited-text-button-line-format
6221 @vindex gnus-cited-text-button-line-format
6222 Gnus adds buttons to show where the cited text has been hidden, and to
6223 allow toggle hiding the text.  The format of the variable is specified
6224 by this format-like variable (@pxref{Formatting Variables}).  These
6225 specs are valid:
6226
6227 @table @samp
6228 @item b
6229 Start point of the hidden text.
6230 @item e
6231 End point of the hidden text.
6232 @item l
6233 Length of the hidden text.
6234 @end table
6235
6236 @item gnus-cited-lines-visible
6237 @vindex gnus-cited-lines-visible
6238 The number of lines at the beginning of the cited text to leave shown. 
6239
6240 @end table
6241
6242 @item W W C
6243 @kindex W W C (Summary)
6244 @findex gnus-article-hide-citation-in-followups
6245 Hide cited text in articles that aren't roots
6246 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6247 useful as an interactive command, but might be a handy function to stick
6248 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
6249
6250 @end table
6251
6252 All these ``hiding'' commands are toggles, but if you give a negative
6253 prefix to these commands, they will show what they have previously
6254 hidden.  If you give a positive prefix, they will always hide.
6255
6256 Also @pxref{Article Highlighting} for further variables for
6257 citation customization.
6258
6259
6260 @node Article Washing
6261 @subsection Article Washing
6262 @cindex washing
6263 @cindex article washing
6264
6265 We call this ``article washing'' for a really good reason.  Namely, the
6266 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6267
6268 @dfn{Washing} is defined by us as ``changing something from something to
6269 something else'', but normally results in something looking better.
6270 Cleaner, perhaps.
6271
6272 @table @kbd
6273
6274 @item W l
6275 @kindex W l (Summary)
6276 @findex gnus-summary-stop-page-breaking
6277 Remove page breaks from the current article
6278 (@code{gnus-summary-stop-page-breaking}).
6279
6280 @item W r
6281 @kindex W r (Summary)
6282 @findex gnus-summary-caesar-message
6283 @c @icon{gnus-summary-caesar-message}
6284 Do a Caesar rotate (rot13) on the article buffer
6285 (@code{gnus-summary-caesar-message}). 
6286 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6287 (Typically offensive jokes and such.)
6288
6289 It's commonly called ``rot13'' because each letter is rotated 13
6290 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6291 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6292 is rumoured to have employed this form of, uh, somewhat weak encryption.
6293
6294 @item W t
6295 @kindex W t (Summary)
6296 @findex gnus-summary-toggle-header
6297 Toggle whether to display all headers in the article buffer
6298 (@code{gnus-summary-toggle-header}). 
6299
6300 @item W v
6301 @kindex W v (Summary)
6302 @findex gnus-summary-verbose-header
6303 Toggle whether to display all headers in the article buffer permanently
6304 (@code{gnus-summary-verbose-header}).
6305
6306 @item W m
6307 @kindex W m (Summary)
6308 @findex gnus-summary-toggle-mime
6309 Toggle whether to run the article through @sc{mime} before displaying
6310 (@code{gnus-summary-toggle-mime}).
6311
6312 @item W o
6313 @kindex W o (Summary)
6314 @findex gnus-article-treat-overstrike
6315 Treat overstrike (@code{gnus-article-treat-overstrike}).
6316
6317 @item W d
6318 @kindex W d (Summary)
6319 @findex gnus-article-treat-dumbquotes
6320 Treat M******** sm*rtq**t*s (@code{gnus-article-treat-dumbquotes}).
6321
6322 @item W w
6323 @kindex W w (Summary)
6324 @findex gnus-article-fill-cited-article
6325 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
6326 function in @code{gnus-article-display-hook}, it should be run fairly
6327 late and certainly after any highlighting.
6328
6329 You can give the command a numerical prefix to specify the width to use
6330 when filling.
6331
6332 @item W c
6333 @kindex W c (Summary)
6334 @findex gnus-article-remove-cr
6335 Remove CR (i. e., @samp{^M}s on the end of the lines)
6336 (@code{gnus-article-remove-cr}).
6337
6338 @item W q
6339 @kindex W q (Summary)
6340 @findex gnus-article-de-quoted-unreadable
6341 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6342 Quoted-Printable is one common @sc{mime} encoding employed when sending
6343 non-ASCII (i. e., 8-bit) articles.  It typically makes strings like
6344 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6345 readable to me.
6346
6347 @item W f
6348 @kindex W f (Summary)
6349 @cindex x-face
6350 @findex gnus-article-display-x-face
6351 @findex gnus-article-x-face-command
6352 @vindex gnus-article-x-face-command
6353 @vindex gnus-article-x-face-too-ugly
6354 @iftex
6355 @iflatex
6356 \include{xface}
6357 @end iflatex
6358 @end iftex
6359 Look for and display any X-Face headers
6360 (@code{gnus-article-display-x-face}).  The command executed by this
6361 function is given by the @code{gnus-article-x-face-command} variable.
6362 If this variable is a string, this string will be executed in a
6363 sub-shell.  If it is a function, this function will be called with the
6364 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6365 is a regexp) matches the @code{From} header, the face will not be shown.
6366 The default action under Emacs is to fork off an @code{xv} to view the
6367 face; under XEmacs the default action is to display the face before the
6368 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6369 support---that will make display somewhat faster.  If there's no native
6370 X-Face support, Gnus will try to convert the @code{X-Face} header using
6371 external programs from the @code{pbmplus} package and friends.)  If you
6372 want to have this function in the display hook, it should probably come
6373 last.
6374
6375 @item W b
6376 @kindex W b (Summary)
6377 @findex gnus-article-add-buttons
6378 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6379 @xref{Article Buttons}
6380
6381 @item W B
6382 @kindex W B (Summary)
6383 @findex gnus-article-add-buttons-to-head
6384 Add clickable buttons to the article headers
6385 (@code{gnus-article-add-buttons-to-head}).  
6386
6387 @item W E l
6388 @kindex W E l (Summary)
6389 @findex gnus-article-strip-leading-blank-lines
6390 Remove all blank lines from the beginning of the article
6391 (@code{gnus-article-strip-leading-blank-lines}).
6392
6393 @item W E m
6394 @kindex W E m (Summary)
6395 @findex gnus-article-strip-multiple-blank-lines
6396 Replace all blank lines with empty lines and then all multiple empty
6397 lines with a single empty line.
6398 (@code{gnus-article-strip-multiple-blank-lines}).
6399
6400 @item W E t
6401 @kindex W E t (Summary)
6402 @findex gnus-article-remove-trailing-blank-lines
6403 Remove all blank lines at the end of the article
6404 (@code{gnus-article-remove-trailing-blank-lines}).
6405
6406 @item W E a
6407 @kindex W E a (Summary)
6408 @findex gnus-article-strip-blank-lines
6409 Do all the three commands above
6410 (@code{gnus-article-strip-blank-lines}).
6411
6412 @item W E A
6413 @kindex W E A (Summary)
6414 @findex gnus-article-strip-all-blank-lines
6415 Remove all blank lines
6416 (@code{gnus-article-strip-all-blank-lines}).
6417
6418 @item W E s
6419 @kindex W E s (Summary)
6420 @findex gnus-article-strip-leading-space
6421 Remove all white space from the beginning of all lines of the article
6422 body (@code{gnus-article-strip-leading-space}).
6423
6424 @end table
6425
6426
6427 @node Article Buttons
6428 @subsection Article Buttons
6429 @cindex buttons
6430
6431 People often include references to other stuff in articles, and it would
6432 be nice if Gnus could just fetch whatever it is that people talk about
6433 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6434 button on these references.
6435
6436 Gnus adds @dfn{buttons} to certain standard references by default:
6437 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6438 two variables, one that handles article bodies and one that handles
6439 article heads:
6440
6441 @table @code
6442
6443 @item gnus-button-alist
6444 @vindex gnus-button-alist
6445 This is an alist where each entry has this form:
6446
6447 @lisp
6448 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6449 @end lisp
6450
6451 @table @var
6452
6453 @item regexp
6454 All text that match this regular expression will be considered an
6455 external reference.  Here's a typical regexp that matches embedded URLs:
6456 @samp{<URL:\\([^\n\r>]*\\)>}. 
6457
6458 @item button-par
6459 Gnus has to know which parts of the matches is to be highlighted.  This
6460 is a number that says what sub-expression of the regexp is to be
6461 highlighted.  If you want it all highlighted, you use 0 here.
6462
6463 @item use-p
6464 This form will be @code{eval}ed, and if the result is non-@code{nil},
6465 this is considered a match.  This is useful if you want extra sifting to
6466 avoid false matches.
6467
6468 @item function
6469 This function will be called when you click on this button.
6470
6471 @item data-par
6472 As with @var{button-par}, this is a sub-expression number, but this one
6473 says which part of the match is to be sent as data to @var{function}. 
6474
6475 @end table
6476
6477 So the full entry for buttonizing URLs is then
6478
6479 @lisp
6480 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6481 @end lisp
6482
6483 @item gnus-header-button-alist
6484 @vindex gnus-header-button-alist
6485 This is just like the other alist, except that it is applied to the
6486 article head only, and that each entry has an additional element that is
6487 used to say what headers to apply the buttonize coding to:
6488
6489 @lisp
6490 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6491 @end lisp
6492
6493 @var{HEADER} is a regular expression.
6494
6495 @item gnus-button-url-regexp
6496 @vindex gnus-button-url-regexp
6497 A regular expression that matches embedded URLs.  It is used in the
6498 default values of the variables above.
6499
6500 @item gnus-article-button-face
6501 @vindex gnus-article-button-face
6502 Face used on buttons.
6503
6504 @item gnus-article-mouse-face
6505 @vindex gnus-article-mouse-face
6506 Face used when the mouse cursor is over a button.
6507
6508 @end table
6509
6510
6511 @node Article Date
6512 @subsection Article Date
6513
6514 The date is most likely generated in some obscure timezone you've never
6515 heard of, so it's quite nice to be able to find out what the time was
6516 when the article was sent.
6517
6518 @table @kbd
6519
6520 @item W T u
6521 @kindex W T u (Summary)
6522 @findex gnus-article-date-ut
6523 Display the date in UT (aka. GMT, aka ZULU)
6524 (@code{gnus-article-date-ut}). 
6525
6526 @item W T i
6527 @kindex W T i (Summary)
6528 @findex gnus-article-date-iso8601
6529 @cindex ISO 8601
6530 Display the date in international format, aka. ISO 8601
6531 (@code{gnus-article-date-iso8601}).
6532
6533 @item W T l
6534 @kindex W T l (Summary)
6535 @findex gnus-article-date-local
6536 Display the date in the local timezone (@code{gnus-article-date-local}).
6537
6538 @item W T s
6539 @kindex W T s (Summary)
6540 @vindex gnus-article-time-format
6541 @findex gnus-article-date-user
6542 @findex format-time-string
6543 Display the date using a user-defined format
6544 (@code{gnus-article-date-user}).  The format is specified by the
6545 @code{gnus-article-time-format} variable, and is a string that's passed
6546 to @code{format-time-string}.  See the documentation of that variable
6547 for a list of possible format specs.
6548
6549 @item W T e
6550 @kindex W T e (Summary)
6551 @findex gnus-article-date-lapsed
6552 @findex gnus-start-date-timer
6553 @findex gnus-stop-date-timer
6554 Say how much time has elapsed between the article was posted and now
6555 (@code{gnus-article-date-lapsed}).  If you want to have this line
6556 updated continually, you can put
6557
6558 @lisp
6559 (gnus-start-date-timer)
6560 @end lisp
6561
6562 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6563 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6564 command.
6565
6566 @item W T o
6567 @kindex W T o (Summary)
6568 @findex gnus-article-date-original
6569 Display the original date (@code{gnus-article-date-original}).  This can
6570 be useful if you normally use some other conversion function and are
6571 worried that it might be doing something totally wrong.  Say, claiming
6572 that the article was posted in 1854.  Although something like that is
6573 @emph{totally} impossible.  Don't you trust me? *titter*
6574
6575 @end table
6576
6577
6578 @node Article Signature
6579 @subsection Article Signature
6580 @cindex signatures
6581 @cindex article signature
6582
6583 @vindex gnus-signature-separator
6584 Each article is divided into two parts---the head and the body.  The
6585 body can be divided into a signature part and a text part.  The variable
6586 that says what is to be considered a signature is
6587 @code{gnus-signature-separator}.  This is normally the standard
6588 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6589 non-standard signature separators, so this variable can also be a list
6590 of regular expressions to be tested, one by one.  (Searches are done
6591 from the end of the body towards the beginning.)  One likely value is:
6592
6593 @lisp
6594 (setq gnus-signature-separator
6595       '("^-- $"         ; The standard
6596         "^-- *$"        ; A common mangling
6597         "^-------*$"    ; Many people just use a looong 
6598                         ; line of dashes.  Shame!
6599         "^ *--------*$" ; Double-shame!
6600         "^________*$"   ; Underscores are also popular
6601         "^========*$")) ; Pervert!
6602 @end lisp
6603
6604 The more permissive you are, the more likely it is that you'll get false
6605 positives.
6606
6607 @vindex gnus-signature-limit
6608 @code{gnus-signature-limit} provides a limit to what is considered a
6609 signature. 
6610
6611 @enumerate
6612 @item 
6613 If it is an integer, no signature may be longer (in characters) than
6614 that integer.
6615 @item 
6616 If it is a floating point number, no signature may be longer (in lines)
6617 than that number.
6618 @item 
6619 If it is a function, the function will be called without any parameters,
6620 and if it returns @code{nil}, there is no signature in the buffer.
6621 @item
6622 If it is a string, it will be used as a regexp.  If it matches, the text
6623 in question is not a signature.
6624 @end enumerate
6625
6626 This variable can also be a list where the elements may be of the types
6627 listed above.  Here's an example:
6628
6629 @lisp
6630 (setq gnus-signature-limit
6631       '(200.0 "^---*Forwarded article"))
6632 @end lisp
6633
6634 This means that if there are more than 200 lines after the signature
6635 separator, or the text after the signature separator is matched by
6636 the regular expression @samp{^---*Forwarded article}, then it isn't a
6637 signature after all.
6638
6639
6640 @node Article Commands
6641 @section Article Commands
6642
6643 @table @kbd
6644
6645 @item A P
6646 @cindex PostScript
6647 @cindex printing
6648 @kindex A P (Summary)
6649 @vindex gnus-ps-print-hook
6650 @findex gnus-summary-print-article 
6651 Generate and print a PostScript image of the article buffer
6652 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6653 run just before printing the buffer.
6654
6655 @end table
6656
6657
6658 @node Summary Sorting
6659 @section Summary Sorting
6660 @cindex summary sorting
6661
6662 You can have the summary buffer sorted in various ways, even though I
6663 can't really see why you'd want that.
6664
6665 @table @kbd
6666
6667 @item C-c C-s C-n
6668 @kindex C-c C-s C-n (Summary)
6669 @findex gnus-summary-sort-by-number
6670 Sort by article number (@code{gnus-summary-sort-by-number}).
6671
6672 @item C-c C-s C-a
6673 @kindex C-c C-s C-a (Summary)
6674 @findex gnus-summary-sort-by-author
6675 Sort by author (@code{gnus-summary-sort-by-author}).
6676
6677 @item C-c C-s C-s
6678 @kindex C-c C-s C-s (Summary)
6679 @findex gnus-summary-sort-by-subject
6680 Sort by subject (@code{gnus-summary-sort-by-subject}).
6681
6682 @item C-c C-s C-d
6683 @kindex C-c C-s C-d (Summary)
6684 @findex gnus-summary-sort-by-date
6685 Sort by date (@code{gnus-summary-sort-by-date}).
6686
6687 @item C-c C-s C-l
6688 @kindex C-c C-s C-l (Summary)
6689 @findex gnus-summary-sort-by-lines
6690 Sort by lines (@code{gnus-summary-sort-by-lines}).
6691
6692 @item C-c C-s C-i
6693 @kindex C-c C-s C-i (Summary)
6694 @findex gnus-summary-sort-by-score
6695 Sort by score (@code{gnus-summary-sort-by-score}).
6696 @end table
6697
6698 These functions will work both when you use threading and when you don't
6699 use threading.  In the latter case, all summary lines will be sorted,
6700 line by line.  In the former case, sorting will be done on a
6701 root-by-root basis, which might not be what you were looking for.  To
6702 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6703 Commands}).
6704
6705
6706 @node Finding the Parent
6707 @section Finding the Parent
6708 @cindex parent articles
6709 @cindex referring articles
6710
6711 @table @kbd
6712 @item ^
6713 @kindex ^ (Summary)
6714 @findex gnus-summary-refer-parent-article
6715 If you'd like to read the parent of the current article, and it is not
6716 displayed in the summary buffer, you might still be able to.  That is,
6717 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6718 and the @code{References} in the current article are not mangled, you
6719 can just press @kbd{^} or @kbd{A r}
6720 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6721 you'll get the parent.  If the parent is already displayed in the
6722 summary buffer, point will just move to this article.
6723
6724 If given a positive numerical prefix, fetch that many articles back into
6725 the ancestry.  If given a negative numerical prefix, fetch just that
6726 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6727 grandparent and the grandgrandparent of the current article.  If you say
6728 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6729 article. 
6730
6731 @item A R (Summary)
6732 @findex gnus-summary-refer-references
6733 @kindex A R (Summary)
6734 Fetch all articles mentioned in the @code{References} header of the
6735 article (@code{gnus-summary-refer-references}).
6736
6737 @item A T (Summary)
6738 @findex gnus-summary-refer-thread
6739 @kindex A T (Summary)
6740 Display the full thread where the current article appears
6741 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
6742 headers in the current group to work, so it usually takes a while.  If
6743 you do it often, you may consider setting @code{gnus-fetch-old-headers}
6744 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
6745 visible effects normally, but it'll make this command work a whole lot
6746 faster.  Of course, it'll make group entry somewhat slow.
6747
6748 @vindex gnus-refer-thread-limit
6749 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
6750 articles before the first displayed in the current group) headers to
6751 fetch when doing this command.  The default is 200.  If @code{t}, all
6752 the available headers will be fetched.  This variable can be overridden
6753 by giving the @kbd{A T} command a numerical prefix.
6754
6755 @item M-^ (Summary)
6756 @findex gnus-summary-refer-article
6757 @kindex M-^ (Summary)
6758 @cindex Message-ID
6759 @cindex fetching by Message-ID
6760 You can also ask the @sc{nntp} server for an arbitrary article, no
6761 matter what group it belongs to.  @kbd{M-^}
6762 (@code{gnus-summary-refer-article}) will ask you for a
6763 @code{Message-ID}, which is one of those long, hard-to-read thingies
6764 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6765 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6766 @end table
6767
6768 The current select method will be used when fetching by
6769 @code{Message-ID} from non-news select method, but you can override this
6770 by giving this command a prefix.
6771
6772 @vindex gnus-refer-article-method
6773 If the group you are reading is located on a backend that does not
6774 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6775 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6776 would, perhaps, be best if the @sc{nntp} server you consult is the one
6777 updating the spool you are reading from, but that's not really
6778 necessary.
6779
6780 Most of the mail backends support fetching by @code{Message-ID}, but do
6781 not do a particularly excellent job at it.  That is, @code{nnmbox} and
6782 @code{nnbabyl} are able to locate articles from any groups, while
6783 @code{nnml} and @code{nnfolder} are only able to locate articles that
6784 have been posted to the current group.  (Anything else would be too time
6785 consuming.)  @code{nnmh} does not support this at all.
6786
6787
6788 @node Alternative Approaches
6789 @section Alternative Approaches
6790
6791 Different people like to read news using different methods.  This being
6792 Gnus, we offer a small selection of minor modes for the summary buffers.
6793
6794 @menu
6795 * Pick and Read::               First mark articles and then read them.
6796 * Binary Groups::               Auto-decode all articles.
6797 @end menu
6798
6799
6800 @node Pick and Read
6801 @subsection Pick and Read
6802 @cindex pick and read
6803
6804 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6805 a two-phased reading interface.  The user first marks in a summary
6806 buffer the articles she wants to read.  Then she starts reading the
6807 articles with just an article buffer displayed.
6808
6809 @findex gnus-pick-mode
6810 @kindex M-x gnus-pick-mode
6811 Gnus provides a summary buffer minor mode that allows
6812 this---@code{gnus-pick-mode}.  This basically means that a few process
6813 mark commands become one-keystroke commands to allow easy marking, and
6814 it provides one additional command for switching to the summary buffer.
6815
6816 Here are the available keystrokes when using pick mode:
6817
6818 @table @kbd
6819 @item .
6820 @kindex . (Pick)
6821 @findex gnus-summary-mark-as-processable
6822 Pick the article on the current line
6823 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6824 go to that article and pick it.  (The line number is normally displayed
6825 at the beginning of the summary pick lines.)
6826
6827 @item SPACE
6828 @kindex SPACE (Pick)
6829 @findex gnus-pick-next-page
6830 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6831 at the end of the buffer, start reading the picked articles.
6832
6833 @item u
6834 @kindex u (Pick)
6835 @findex gnus-summary-unmark-as-processable
6836 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6837
6838 @item U
6839 @kindex U (Pick)
6840 @findex gnus-summary-unmark-all-processable
6841 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6842
6843 @item t
6844 @kindex t (Pick)
6845 @findex gnus-uu-mark-thread
6846 Pick the thread (@code{gnus-uu-mark-thread}). 
6847
6848 @item T
6849 @kindex T (Pick)
6850 @findex gnus-uu-unmark-thread
6851 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6852
6853 @item r
6854 @kindex r (Pick)
6855 @findex gnus-uu-mark-region
6856 Pick the region (@code{gnus-uu-mark-region}). 
6857
6858 @item R
6859 @kindex R (Pick)
6860 @findex gnus-uu-unmark-region
6861 Unpick the region (@code{gnus-uu-unmark-region}). 
6862
6863 @item e
6864 @kindex e (Pick)
6865 @findex gnus-uu-mark-by-regexp
6866 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6867
6868 @item E
6869 @kindex E (Pick)
6870 @findex gnus-uu-unmark-by-regexp
6871 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6872
6873 @item b
6874 @kindex b (Pick)
6875 @findex gnus-uu-mark-buffer
6876 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6877
6878 @item B
6879 @kindex B (Pick)
6880 @findex gnus-uu-unmark-buffer
6881 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6882
6883 @item RET
6884 @kindex RET (Pick)
6885 @findex gnus-pick-start-reading
6886 @vindex gnus-pick-display-summary
6887 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6888 given a prefix, mark all unpicked articles as read first.  If
6889 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6890 will still be visible when you are reading.
6891
6892 @end table
6893
6894 If this sounds like a good idea to you, you could say:
6895
6896 @lisp
6897 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6898 @end lisp
6899
6900 @vindex gnus-pick-mode-hook
6901 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6902
6903 @vindex gnus-mark-unpicked-articles-as-read
6904 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6905 all unpicked articles as read.  The default is @code{nil}.
6906
6907 @vindex gnus-summary-pick-line-format
6908 The summary line format in pick mode is slightly different from the
6909 standard format.  At the beginning of each line the line number is
6910 displayed.  The pick mode line format is controlled by the
6911 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6912 Variables}).  It accepts the same format specs that
6913 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6914
6915
6916 @node Binary Groups
6917 @subsection Binary Groups
6918 @cindex binary groups
6919
6920 @findex gnus-binary-mode
6921 @kindex M-x gnus-binary-mode
6922 If you spend much time in binary groups, you may grow tired of hitting
6923 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6924 is a minor mode for summary buffers that makes all ordinary Gnus article
6925 selection functions uudecode series of articles and display the result
6926 instead of just displaying the articles the normal way.  
6927
6928 @kindex g (Binary)
6929 @findex gnus-binary-show-article
6930 The only way, in fact, to see the actual articles is the @kbd{g}
6931 command, when you have turned on this mode
6932 (@code{gnus-binary-show-article}).
6933
6934 @vindex gnus-binary-mode-hook
6935 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6936
6937
6938 @node Tree Display
6939 @section Tree Display
6940 @cindex trees
6941
6942 @vindex gnus-use-trees
6943 If you don't like the normal Gnus summary display, you might try setting
6944 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6945 additional @dfn{tree buffer}.  You can execute all summary mode commands
6946 in the tree buffer.  
6947
6948 There are a few variables to customize the tree display, of course:
6949
6950 @table @code
6951 @item gnus-tree-mode-hook
6952 @vindex gnus-tree-mode-hook
6953 A hook called in all tree mode buffers.
6954
6955 @item gnus-tree-mode-line-format
6956 @vindex gnus-tree-mode-line-format
6957 A format string for the mode bar in the tree mode buffers.  The default
6958 is @samp{Gnus: %%b %S %Z}.  For a list of valid specs, @pxref{Summary
6959 Buffer Mode Line}. 
6960
6961 @item gnus-selected-tree-face
6962 @vindex gnus-selected-tree-face
6963 Face used for highlighting the selected article in the tree buffer.  The
6964 default is @code{modeline}.
6965
6966 @item gnus-tree-line-format
6967 @vindex gnus-tree-line-format
6968 A format string for the tree nodes.  The name is a bit of a misnomer,
6969 though---it doesn't define a line, but just the node.  The default value
6970 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6971 the name of the poster.  It is vital that all nodes are of the same
6972 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6973
6974 Valid specs are:
6975
6976 @table @samp
6977 @item n
6978 The name of the poster.
6979 @item f
6980 The @code{From} header.
6981 @item N
6982 The number of the article.
6983 @item [
6984 The opening bracket.
6985 @item ] 
6986 The closing bracket.
6987 @item s
6988 The subject.
6989 @end table
6990
6991 @xref{Formatting Variables}.
6992
6993 Variables related to the display are:
6994
6995 @table @code
6996 @item gnus-tree-brackets
6997 @vindex gnus-tree-brackets
6998 This is used for differentiating between ``real'' articles and
6999 ``sparse'' articles.  The format is @var{((real-open . real-close)
7000 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7001 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7002
7003 @item gnus-tree-parent-child-edges
7004 @vindex gnus-tree-parent-child-edges
7005 This is a list that contains the characters used for connecting parent
7006 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
7007
7008 @end table
7009
7010 @item gnus-tree-minimize-window
7011 @vindex gnus-tree-minimize-window
7012 If this variable is non-@code{nil}, Gnus will try to keep the tree
7013 buffer as small as possible to allow more room for the other Gnus
7014 windows.  If this variable is a number, the tree buffer will never be
7015 higher than that number.  The default is @code{t}.  Note that if you
7016 have several windows displayed side-by-side in a frame and the tree
7017 buffer is one of these, minimizing the tree window will also resize all
7018 other windows displayed next to it.
7019
7020 @item gnus-generate-tree-function
7021 @vindex gnus-generate-tree-function
7022 @findex gnus-generate-horizontal-tree
7023 @findex gnus-generate-vertical-tree
7024 The function that actually generates the thread tree.  Two predefined
7025 functions are available: @code{gnus-generate-horizontal-tree} and
7026 @code{gnus-generate-vertical-tree} (which is the default).
7027
7028 @end table
7029
7030 Here's an example from a horizontal tree buffer:
7031
7032 @example
7033 @{***@}-(***)-[odd]-[Gun]
7034      |      \[Jan]
7035      |      \[odd]-[Eri]
7036      |      \(***)-[Eri]
7037      |            \[odd]-[Paa]
7038      \[Bjo]
7039      \[Gun]
7040      \[Gun]-[Jor]
7041 @end example
7042
7043 Here's the same thread displayed in a vertical tree buffer:
7044
7045 @example
7046 @{***@}
7047   |--------------------------\-----\-----\
7048 (***)                         [Bjo] [Gun] [Gun]
7049   |--\-----\-----\                          |
7050 [odd] [Jan] [odd] (***)                   [Jor]
7051   |           |     |--\
7052 [Gun]       [Eri] [Eri] [odd]
7053                           |
7054                         [Paa]
7055 @end example
7056
7057 If you're using horizontal trees, it might be nice to display the trees
7058 side-by-side with the summary buffer.  You could add something like the
7059 following to your @file{.gnus.el} file:
7060
7061 @lisp
7062 (setq gnus-use-trees t
7063       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7064       gnus-tree-minimize-window nil)
7065 (gnus-add-configuration
7066  '(article
7067    (vertical 1.0
7068              (horizontal 0.25
7069                          (summary 0.75 point)
7070                          (tree 1.0))
7071              (article 1.0))))
7072 @end lisp
7073
7074 @xref{Windows Configuration}.
7075
7076
7077 @node Mail Group Commands
7078 @section Mail Group Commands
7079 @cindex mail group commands
7080
7081 Some commands only make sense in mail groups.  If these commands are
7082 invalid in the current group, they will raise a hell and let you know.
7083
7084 All these commands (except the expiry and edit commands) use the
7085 process/prefix convention (@pxref{Process/Prefix}).
7086
7087 @table @kbd
7088
7089 @item B e
7090 @kindex B e (Summary)
7091 @findex gnus-summary-expire-articles
7092 Expire all expirable articles in the group
7093 (@code{gnus-summary-expire-articles}).
7094
7095 @item B M-C-e
7096 @kindex B M-C-e (Summary)
7097 @findex gnus-summary-expire-articles-now
7098 Delete all the expirable articles in the group
7099 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7100 articles eligible for expiry in the current group will
7101 disappear forever into that big @file{/dev/null} in the sky.
7102
7103 @item B DEL
7104 @kindex B DEL (Summary)
7105 @findex gnus-summary-delete-article
7106 @c @icon{gnus-summary-mail-delete}
7107 Delete the mail article.  This is ``delete'' as in ``delete it from your
7108 disk forever and ever, never to return again.'' Use with caution.
7109 (@code{gnus-summary-delete-article}).
7110
7111 @item B m
7112 @kindex B m (Summary)
7113 @cindex move mail
7114 @findex gnus-summary-move-article
7115 Move the article from one mail group to another
7116 (@code{gnus-summary-move-article}). 
7117
7118 @item B c
7119 @kindex B c (Summary)
7120 @cindex copy mail
7121 @findex gnus-summary-copy-article
7122 @c @icon{gnus-summary-mail-copy}
7123 Copy the article from one group (mail group or not) to a mail group
7124 (@code{gnus-summary-copy-article}).
7125
7126 @item B B
7127 @kindex B B (Summary)
7128 @cindex crosspost mail
7129 @findex gnus-summary-crosspost-article
7130 Crosspost the current article to some other group
7131 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7132 the article in the other group, and the Xref headers of the article will
7133 be properly updated.
7134
7135 @item B i
7136 @kindex B i (Summary)
7137 @findex gnus-summary-import-article
7138 Import an arbitrary file into the current mail newsgroup
7139 (@code{gnus-summary-import-article}).  You will be prompted for a file
7140 name, a @code{From} header and a @code{Subject} header.
7141
7142 @item B r
7143 @kindex B r (Summary)
7144 @findex gnus-summary-respool-article
7145 Respool the mail article (@code{gnus-summary-move-article}).
7146 @code{gnus-summary-respool-default-method} will be used as the default
7147 select method when respooling.  This variable is @code{nil} by default,
7148 which means that the current group select method will be used instead.
7149
7150 @item B w
7151 @itemx e
7152 @kindex B w (Summary)
7153 @kindex e (Summary)
7154 @findex gnus-summary-edit-article
7155 @kindex C-c C-c (Article)
7156 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7157 editing and make the changes permanent, type @kbd{C-c C-c}
7158 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7159 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7160
7161 @item B q
7162 @kindex B q (Summary)
7163 @findex gnus-summary-respool-query
7164 If you want to re-spool an article, you might be curious as to what group
7165 the article will end up in before you do the re-spooling.  This command
7166 will tell you (@code{gnus-summary-respool-query}). 
7167
7168 @item B p
7169 @kindex B p (Summary)
7170 @findex gnus-summary-article-posted-p
7171 Some people have a tendency to send you "courtesy" copies when they
7172 follow up to articles you have posted.  These usually have a
7173 @code{Newsgroups} header in them, but not always.  This command
7174 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7175 article from your news server (or rather, from
7176 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7177 report back whether it found the article or not.  Even if it says that
7178 it didn't find the article, it may have been posted anyway---mail
7179 propagation is much faster than news propagation, and the news copy may
7180 just not have arrived yet.
7181
7182 @end table
7183
7184 @vindex gnus-move-split-methods
7185 @cindex moving articles
7186 If you move (or copy) articles regularly, you might wish to have Gnus
7187 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7188 variable that uses the same syntax as @code{gnus-split-methods}
7189 (@pxref{Saving Articles}).  You may customize that variable to create
7190 suggestions you find reasonable.
7191
7192 @lisp
7193 (setq gnus-move-split-methods
7194       '(("^From:.*Lars Magne" "nnml:junk")
7195         ("^Subject:.*gnus" "nnfolder:important")
7196         (".*" "nnml:misc")))
7197 @end lisp
7198
7199
7200 @node Various Summary Stuff
7201 @section Various Summary Stuff
7202
7203 @menu
7204 * Summary Group Information::         Information oriented commands.
7205 * Searching for Articles::            Multiple article commands.
7206 * Summary Generation Commands::       (Re)generating the summary buffer.
7207 * Really Various Summary Commands::   Those pesky non-conformant commands.
7208 @end menu
7209
7210 @table @code
7211 @vindex gnus-summary-mode-hook
7212 @item gnus-summary-mode-hook
7213 This hook is called when creating a summary mode buffer.
7214
7215 @vindex gnus-summary-generate-hook
7216 @item gnus-summary-generate-hook
7217 This is called as the last thing before doing the threading and the
7218 generation of the summary buffer.  It's quite convenient for customizing
7219 the threading variables based on what data the newsgroup has.  This hook
7220 is called from the summary buffer after most summary buffer variables
7221 have been set.
7222
7223 @vindex gnus-summary-prepare-hook
7224 @item gnus-summary-prepare-hook
7225 It is called after the summary buffer has been generated.  You might use
7226 it to, for instance, highlight lines or modify the look of the buffer in
7227 some other ungodly manner.  I don't care.
7228
7229 @vindex gnus-summary-ignore-duplicates
7230 @item gnus-summary-ignore-duplicates
7231 When Gnus discovers two articles that have the same @code{Message-ID},
7232 it has to do something drastic.  No articles are allowed to have the
7233 same @code{Message-ID}, but this may happen when reading mail from some
7234 sources.  Gnus allows you to customize what happens with this variable.
7235 If it is @code{nil} (which is the default), Gnus will rename the
7236 @code{Message-ID} (for display purposes only) and display the article as
7237 any other article.  If this variable is @code{t}, it won't display the
7238 article---it'll be as if it never existed.
7239
7240 @end table
7241
7242
7243 @node Summary Group Information
7244 @subsection Summary Group Information
7245
7246 @table @kbd
7247
7248 @item H f
7249 @kindex H f (Summary)
7250 @findex gnus-summary-fetch-faq
7251 @vindex gnus-group-faq-directory
7252 Try to fetch the FAQ (list of frequently asked questions) for the
7253 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7254 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7255 on a remote machine.  This variable can also be a list of directories.
7256 In that case, giving a prefix to this command will allow you to choose
7257 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7258 be used for fetching the file.
7259
7260 @item H d
7261 @kindex H d (Summary)
7262 @findex gnus-summary-describe-group
7263 Give a brief description of the current group
7264 (@code{gnus-summary-describe-group}).  If given a prefix, force
7265 rereading the description from the server.
7266
7267 @item H h
7268 @kindex H h (Summary)
7269 @findex gnus-summary-describe-briefly
7270 Give an extremely brief description of the most important summary
7271 keystrokes (@code{gnus-summary-describe-briefly}).
7272
7273 @item H i
7274 @kindex H i (Summary)
7275 @findex gnus-info-find-node
7276 Go to the Gnus info node (@code{gnus-info-find-node}).
7277 @end table
7278
7279
7280 @node Searching for Articles
7281 @subsection Searching for Articles
7282
7283 @table @kbd
7284
7285 @item M-s
7286 @kindex M-s (Summary)
7287 @findex gnus-summary-search-article-forward
7288 Search through all subsequent articles for a regexp
7289 (@code{gnus-summary-search-article-forward}). 
7290
7291 @item M-r
7292 @kindex M-r (Summary)
7293 @findex gnus-summary-search-article-backward
7294 Search through all previous articles for a regexp
7295 (@code{gnus-summary-search-article-backward}). 
7296
7297 @item &
7298 @kindex & (Summary)
7299 @findex gnus-summary-execute-command
7300 This command will prompt you for a header field, a regular expression to
7301 match on this field, and a command to be executed if the match is made
7302 (@code{gnus-summary-execute-command}).  If given a prefix, search
7303 backward instead.
7304
7305 @item M-&
7306 @kindex M-& (Summary)
7307 @findex gnus-summary-universal-argument
7308 Perform any operation on all articles that have been marked with
7309 the process mark (@code{gnus-summary-universal-argument}).
7310 @end table
7311
7312 @node Summary Generation Commands
7313 @subsection Summary Generation Commands
7314
7315 @table @kbd
7316
7317 @item Y g
7318 @kindex Y g (Summary)
7319 @findex gnus-summary-prepare
7320 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7321
7322 @item Y c 
7323 @kindex Y c (Summary)
7324 @findex gnus-summary-insert-cached-articles
7325 Pull all cached articles (for the current group) into the summary buffer
7326 (@code{gnus-summary-insert-cached-articles}).
7327
7328 @end table
7329
7330
7331 @node Really Various Summary Commands
7332 @subsection Really Various Summary Commands
7333
7334 @table @kbd
7335
7336 @item C-d
7337 @kindex C-d (Summary)
7338 @findex gnus-summary-enter-digest-group
7339 If the current article is a collection of other articles (for instance,
7340 a digest), you might use this command to enter a group based on the that
7341 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7342 guess what article type is currently displayed unless you give a prefix
7343 to this command, which forces a ``digest'' interpretation.  Basically,
7344 whenever you see a message that is a collection of other messages of
7345 some format, you @kbd{C-d} and read these messages in a more convenient
7346 fashion.
7347
7348 @item M-C-d
7349 @kindex M-C-d (Summary)
7350 @findex gnus-summary-read-document
7351 This command is very similar to the one above, but lets you gather
7352 several documents into one biiig group
7353 (@code{gnus-summary-read-document}).  It does this by opening several
7354 @code{nndoc} groups for each document, and then opening an
7355 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7356 command understands the process/prefix convention
7357 (@pxref{Process/Prefix}). 
7358
7359 @item C-t
7360 @kindex C-t (Summary)
7361 @findex gnus-summary-toggle-truncation
7362 Toggle truncation of summary lines
7363 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7364 line centering function in the summary buffer, so it's not a good idea
7365 to have truncation switched off while reading articles.
7366
7367 @item =
7368 @kindex = (Summary)
7369 @findex gnus-summary-expand-window
7370 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7371 If given a prefix, force an @code{article} window configuration. 
7372
7373 @item M-C-e
7374 @kindex M-C-e (Summary)
7375 @findex gnus-summary-edit-parameters
7376 Edit the group parameters (@pxref{Group Parameters}) of the current
7377 group (@code{gnus-summary-edit-parameters}).
7378
7379 @end table
7380
7381
7382 @node Exiting the Summary Buffer
7383 @section Exiting the Summary Buffer
7384 @cindex summary exit
7385 @cindex exiting groups
7386
7387 Exiting from the summary buffer will normally update all info on the
7388 group and return you to the group buffer. 
7389
7390 @table @kbd
7391
7392 @item Z Z
7393 @itemx q
7394 @kindex Z Z (Summary)
7395 @kindex q (Summary)
7396 @findex gnus-summary-exit
7397 @vindex gnus-summary-exit-hook
7398 @vindex gnus-summary-prepare-exit-hook
7399 @c @icon{gnus-summary-exit}
7400 Exit the current group and update all information on the group
7401 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7402 called before doing much of the exiting, which calls
7403 @code{gnus-summary-expire-articles} by default.
7404 @code{gnus-summary-exit-hook} is called after finishing the exit
7405 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7406 group mode having no more (unread) groups.
7407
7408 @item Z E
7409 @itemx Q
7410 @kindex Z E (Summary)
7411 @kindex Q (Summary)
7412 @findex gnus-summary-exit-no-update
7413 Exit the current group without updating any information on the group
7414 (@code{gnus-summary-exit-no-update}).
7415
7416 @item Z c
7417 @itemx c
7418 @kindex Z c (Summary)
7419 @kindex c (Summary)
7420 @findex gnus-summary-catchup-and-exit
7421 @c @icon{gnus-summary-catchup-and-exit}
7422 Mark all unticked articles in the group as read and then exit
7423 (@code{gnus-summary-catchup-and-exit}).
7424
7425 @item Z C
7426 @kindex Z C (Summary)
7427 @findex gnus-summary-catchup-all-and-exit
7428 Mark all articles, even the ticked ones, as read and then exit
7429 (@code{gnus-summary-catchup-all-and-exit}).
7430
7431 @item Z n
7432 @kindex Z n (Summary)
7433 @findex gnus-summary-catchup-and-goto-next-group
7434 Mark all articles as read and go to the next group
7435 (@code{gnus-summary-catchup-and-goto-next-group}). 
7436
7437 @item Z R
7438 @kindex Z R (Summary)
7439 @findex gnus-summary-reselect-current-group
7440 Exit this group, and then enter it again
7441 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7442 all articles, both read and unread.
7443
7444 @item Z G
7445 @itemx M-g
7446 @kindex Z G (Summary)
7447 @kindex M-g (Summary)
7448 @findex gnus-summary-rescan-group
7449 @c @icon{gnus-summary-mail-get}
7450 Exit the group, check for new articles in the group, and select the
7451 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7452 articles, both read and unread.
7453
7454 @item Z N
7455 @kindex Z N (Summary)
7456 @findex gnus-summary-next-group
7457 Exit the group and go to the next group
7458 (@code{gnus-summary-next-group}). 
7459
7460 @item Z P
7461 @kindex Z P (Summary)
7462 @findex gnus-summary-prev-group
7463 Exit the group and go to the previous group
7464 (@code{gnus-summary-prev-group}). 
7465
7466 @item Z s
7467 @kindex Z s (Summary)
7468 @findex gnus-summary-save-newsrc
7469 Save the current number of read/marked articles in the dribble buffer
7470 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7471 given a prefix, also save the @file{.newsrc} file(s).  Using this
7472 command will make exit without updating (the @kbd{Q} command) worthless.
7473 @end table
7474
7475 @vindex gnus-exit-group-hook
7476 @code{gnus-exit-group-hook} is called when you exit the current
7477 group.  
7478
7479 @findex gnus-summary-wake-up-the-dead
7480 @findex gnus-dead-summary-mode
7481 @vindex gnus-kill-summary-on-exit
7482 If you're in the habit of exiting groups, and then changing your mind
7483 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7484 If you do that, Gnus won't kill the summary buffer when you exit it.
7485 (Quelle surprise!)  Instead it will change the name of the buffer to
7486 something like @samp{*Dead Summary ... *} and install a minor mode
7487 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7488 buffer, you'll find that all keys are mapped to a function called
7489 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7490 summary buffer will result in a live, normal summary buffer.  
7491
7492 There will never be more than one dead summary buffer at any one time. 
7493
7494 @vindex gnus-use-cross-reference
7495 The data on the current group will be updated (which articles you have
7496 read, which articles you have replied to, etc.) when you exit the
7497 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7498 @code{t} (which is the default), articles that are cross-referenced to
7499 this group and are marked as read, will also be marked as read in the
7500 other subscribed groups they were cross-posted to.  If this variable is
7501 neither @code{nil} nor @code{t}, the article will be marked as read in
7502 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7503
7504
7505 @node Crosspost Handling
7506 @section Crosspost Handling
7507
7508 @cindex velveeta
7509 @cindex spamming
7510 Marking cross-posted articles as read ensures that you'll never have to
7511 read the same article more than once.  Unless, of course, somebody has
7512 posted it to several groups separately.  Posting the same article to
7513 several groups (not cross-posting) is called @dfn{spamming}, and you are
7514 by law required to send nasty-grams to anyone who perpetrates such a
7515 heinous crime.  You may want to try NoCeM handling to filter out spam
7516 (@pxref{NoCeM}). 
7517
7518 Remember: Cross-posting is kinda ok, but posting the same article
7519 separately to several groups is not.  Massive cross-posting (aka.
7520 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7521 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7522 excessive crossposting (@pxref{Summary Mail Commands}).
7523
7524 @cindex cross-posting
7525 @cindex Xref
7526 @cindex @sc{nov}
7527 One thing that may cause Gnus to not do the cross-posting thing
7528 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7529 (which is very nice, because it speeds things up considerably) which
7530 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7531 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7532 even with @sc{xover} by registering the @code{Xref} lines of all
7533 articles you actually read, but if you kill the articles, or just mark
7534 them as read without reading them, Gnus will not get a chance to snoop
7535 the @code{Xref} lines out of these articles, and will be unable to use
7536 the cross reference mechanism.
7537
7538 @cindex LIST overview.fmt
7539 @cindex overview.fmt
7540 To check whether your @sc{nntp} server includes the @code{Xref} header
7541 in its overview files, try @samp{telnet your.nntp.server nntp},
7542 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7543 overview.fmt}.  This may not work, but if it does, and the last line you
7544 get does not read @samp{Xref:full}, then you should shout and whine at
7545 your news admin until she includes the @code{Xref} header in the
7546 overview files.
7547
7548 @vindex gnus-nov-is-evil
7549 If you want Gnus to get the @code{Xref}s right all the time, you have to
7550 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7551 considerably.
7552
7553 C'est la vie.
7554
7555 For an alternative approach, @pxref{Duplicate Suppression}.
7556
7557
7558 @node Duplicate Suppression
7559 @section Duplicate Suppression
7560
7561 By default, Gnus tries to make sure that you don't have to read the same
7562 article more than once by utilizing the crossposting mechanism
7563 (@pxref{Crosspost Handling}).  However, that simple and efficient
7564 approach may not work satisfactory for some users for various
7565 reasons.  
7566
7567 @enumerate
7568 @item 
7569 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7570 is evil and not very common.
7571
7572 @item 
7573 The @sc{nntp} server may fail to include the @code{Xref} header in the
7574 @file{.overview} data bases.  This is evil and all too common, alas.
7575
7576 @item
7577 You may be reading the same group (or several related groups) from
7578 different @sc{nntp} servers.
7579
7580 @item
7581 You may be getting mail that duplicates articles posted to groups.
7582 @end enumerate
7583
7584 I'm sure there are other situations where @code{Xref} handling fails as
7585 well, but these four are the most common situations.
7586
7587 If, and only if, @code{Xref} handling fails for you, then you may
7588 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7589 will remember the @code{Message-ID}s of all articles you have read or
7590 otherwise marked as read, and then, as if by magic, mark them as read
7591 all subsequent times you see them---in @emph{all} groups.  Using this
7592 mechanism is quite likely to be somewhat inefficient, but not overly
7593 so.  It's certainly preferable to reading the same articles more than
7594 once.
7595
7596 Duplicate suppression is not a very subtle instrument.  It's more like a
7597 sledge hammer than anything else.  It works in a very simple
7598 fashion---if you have marked an article as read, it adds this Message-ID
7599 to a cache.  The next time it sees this Message-ID, it will mark the
7600 article as read with the @samp{M} mark.  It doesn't care what group it
7601 saw the article in.
7602
7603 @table @code
7604 @item gnus-suppress-duplicates
7605 @vindex gnus-suppress-duplicates
7606 If non-@code{nil}, suppress duplicates.
7607
7608 @item gnus-save-duplicate-list
7609 @vindex gnus-save-duplicate-list
7610 If non-@code{nil}, save the list of duplicates to a file.  This will
7611 make startup and shutdown take longer, so the default is @code{nil}.
7612 However, this means that only duplicate articles read in a single Gnus
7613 session are suppressed.
7614
7615 @item gnus-duplicate-list-length
7616 @vindex gnus-duplicate-list-length
7617 This variable says how many @code{Message-ID}s to keep in the duplicate
7618 suppression list.  The default is 10000.  
7619
7620 @item gnus-duplicate-file
7621 @vindex gnus-duplicate-file
7622 The name of the file to store the duplicate suppression list in.  The
7623 default is @file{~/News/suppression}.
7624 @end table
7625
7626 If you have a tendency to stop and start Gnus often, setting
7627 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7628 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7629 the other hand, saving the list makes startup and shutdown much slower,
7630 so that means that if you stop and start Gnus often, you should set
7631 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7632 to you to figure out, I think.
7633
7634
7635 @node The Article Buffer
7636 @chapter The Article Buffer
7637 @cindex article buffer
7638
7639 The articles are displayed in the article buffer, of which there is only
7640 one.  All the summary buffers share the same article buffer unless you
7641 tell Gnus otherwise.
7642
7643 @menu
7644 * Hiding Headers::        Deciding what headers should be displayed.
7645 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7646 * Customizing Articles::  Tailoring the look of the articles.
7647 * Article Keymap::        Keystrokes available in the article buffer.
7648 * Misc Article::          Other stuff.
7649 @end menu
7650
7651
7652 @node Hiding Headers
7653 @section Hiding Headers
7654 @cindex hiding headers
7655 @cindex deleting headers
7656
7657 The top section of each article is the @dfn{head}.  (The rest is the
7658 @dfn{body}, but you may have guessed that already.)
7659
7660 @vindex gnus-show-all-headers
7661 There is a lot of useful information in the head: the name of the person
7662 who wrote the article, the date it was written and the subject of the
7663 article.  That's well and nice, but there's also lots of information
7664 most people do not want to see---what systems the article has passed
7665 through before reaching you, the @code{Message-ID}, the
7666 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7667 of some of those lines.  If you want to keep all those lines in the
7668 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7669
7670 Gnus provides you with two variables for sifting headers:
7671
7672 @table @code
7673
7674 @item gnus-visible-headers
7675 @vindex gnus-visible-headers
7676 If this variable is non-@code{nil}, it should be a regular expression
7677 that says what headers you wish to keep in the article buffer.  All
7678 headers that do not match this variable will be hidden.
7679
7680 For instance, if you only want to see the name of the person who wrote
7681 the article and the subject, you'd say:
7682
7683 @lisp
7684 (setq gnus-visible-headers "^From:\\|^Subject:")
7685 @end lisp
7686
7687 This variable can also be a list of regexps to match headers to
7688 remain visible.
7689
7690 @item gnus-ignored-headers
7691 @vindex gnus-ignored-headers
7692 This variable is the reverse of @code{gnus-visible-headers}.  If this
7693 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7694 should be a regular expression that matches all lines that you want to
7695 hide.  All lines that do not match this variable will remain visible.
7696
7697 For instance, if you just want to get rid of the @code{References} line
7698 and the @code{Xref} line, you might say:
7699
7700 @lisp
7701 (setq gnus-ignored-headers "^References:\\|^Xref:")
7702 @end lisp
7703
7704 This variable can also be a list of regexps to match headers to
7705 be removed.
7706
7707 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7708 variable will have no effect.
7709
7710 @end table
7711
7712 @vindex gnus-sorted-header-list
7713 Gnus can also sort the headers for you.  (It does this by default.)  You
7714 can control the sorting by setting the @code{gnus-sorted-header-list}
7715 variable.  It is a list of regular expressions that says in what order
7716 the headers are to be displayed.
7717
7718 For instance, if you want the name of the author of the article first,
7719 and then the subject, you might say something like:
7720
7721 @lisp
7722 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7723 @end lisp
7724
7725 Any headers that are to remain visible, but are not listed in this
7726 variable, will be displayed in random order after all the headers listed in this variable.
7727
7728 @findex gnus-article-hide-boring-headers
7729 @vindex gnus-article-display-hook
7730 @vindex gnus-boring-article-headers
7731 You can hide further boring headers by entering
7732 @code{gnus-article-hide-boring-headers} into
7733 @code{gnus-article-display-hook}.  What this function does depends on
7734 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7735 list doesn't actually contain header names.  Instead is lists various
7736 @dfn{boring conditions} that Gnus can check and remove from sight.
7737
7738 These conditions are:
7739 @table @code
7740 @item empty
7741 Remove all empty headers.
7742 @item newsgroups
7743 Remove the @code{Newsgroups} header if it only contains the current group
7744 name. 
7745 @item followup-to
7746 Remove the @code{Followup-To} header if it is identical to the
7747 @code{Newsgroups} header.
7748 @item reply-to
7749 Remove the @code{Reply-To} header if it lists the same address as the
7750 @code{From} header.
7751 @item date
7752 Remove the @code{Date} header if the article is less than three days
7753 old.
7754 @item long-to
7755 Remove the @code{To} header if it is very long.
7756 @item many-to
7757 Remove all @code{To} headers if there are more than one.
7758 @end table
7759
7760 To include the four first elements, you could say something like;
7761
7762 @lisp
7763 (setq gnus-boring-article-headers 
7764       '(empty newsgroups followup-to reply-to))
7765 @end lisp
7766
7767 This is also the default value for this variable.
7768
7769
7770 @node Using MIME
7771 @section Using @sc{mime}
7772 @cindex @sc{mime}
7773
7774 Mime is a standard for waving your hands through the air, aimlessly,
7775 while people stand around yawning.
7776
7777 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7778 while all newsreaders die of fear.
7779
7780 @sc{mime} may specify what character set the article uses, the encoding
7781 of the characters, and it also makes it possible to embed pictures and
7782 other naughty stuff in innocent-looking articles.
7783
7784 @vindex gnus-show-mime
7785 @vindex gnus-show-mime-method
7786 @vindex gnus-strict-mime
7787 @findex metamail-buffer
7788 Gnus handles @sc{mime} by pushing the articles through
7789 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7790 default.  This function calls the external @code{metamail} program to
7791 actually do the work.  One common problem with this program is that is
7792 thinks that it can't display 8-bit things in the Emacs buffer.  To tell
7793 it the truth, put something like the following in your
7794 @file{.bash_profile} file.  (You do use @code{bash}, don't you?)
7795
7796 @example
7797 export MM_CHARSET="iso-8859-1"
7798 @end example
7799
7800 For more information on @code{metamail}, see its manual page.
7801
7802 Set @code{gnus-show-mime} to @code{t} if you want to use
7803 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7804 non-@code{nil}, the @sc{mime} method will only be used if there are
7805 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7806 set, then you'll see some unfortunate display glitches in the article
7807 buffer.  These can't be avoided.
7808
7809 It might be best to just use the toggling functions from the summary
7810 buffer to avoid getting nasty surprises. (For instance, you enter the
7811 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7812 decoded the sound file in the article and some horrible sing-a-long song
7813 comes screaming out your speakers, and you can't find the volume
7814 button, because there isn't one, and people are starting to look at you,
7815 and you try to stop the program, but you can't, and you can't find the
7816 program to control the volume, and everybody else in the room suddenly
7817 decides to look at you disdainfully, and you'll feel rather stupid.)
7818
7819 Any similarity to real events and people is purely coincidental.  Ahem.
7820
7821
7822 @node Customizing Articles
7823 @section Customizing Articles
7824 @cindex article customization
7825
7826 @vindex gnus-article-display-hook
7827 The @code{gnus-article-display-hook} is called after the article has
7828 been inserted into the article buffer.  It is meant to handle all
7829 treatment of the article before it is displayed. 
7830
7831 @findex gnus-article-maybe-highlight
7832 By default this hook just contains @code{gnus-article-hide-headers},
7833 @code{gnus-article-treat-overstrike}, and
7834 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7835 millions, of functions you can put in this hook.  For an overview of
7836 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7837 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7838 Date}.  Note that the order of functions in this hook might affect
7839 things, so you may have to fiddle a bit to get the desired results. 
7840
7841 You can, of course, write your own functions.  The functions are called
7842 from the article buffer, and you can do anything you like, pretty much.
7843 There is no information that you have to keep in the buffer---you can
7844 change everything.  However, you shouldn't delete any headers.  Instead
7845 make them invisible if you want to make them go away.
7846
7847
7848 @node Article Keymap
7849 @section Article Keymap
7850
7851 Most of the keystrokes in the summary buffer can also be used in the
7852 article buffer.  They should behave as if you typed them in the summary
7853 buffer, which means that you don't actually have to have a summary
7854 buffer displayed while reading.  You can do it all from the article
7855 buffer.
7856
7857 A few additional keystrokes are available:
7858
7859 @table @kbd
7860
7861 @item SPACE
7862 @kindex SPACE (Article)
7863 @findex gnus-article-next-page
7864 Scroll forwards one page (@code{gnus-article-next-page}).
7865
7866 @item DEL
7867 @kindex DEL (Article)
7868 @findex gnus-article-prev-page
7869 Scroll backwards one page (@code{gnus-article-prev-page}).
7870
7871 @item C-c ^
7872 @kindex C-c ^ (Article)
7873 @findex gnus-article-refer-article
7874 If point is in the neighborhood of a @code{Message-ID} and you press
7875 @kbd{r}, Gnus will try to get that article from the server
7876 (@code{gnus-article-refer-article}).
7877
7878 @item C-c C-m
7879 @kindex C-c C-m (Article)
7880 @findex gnus-article-mail
7881 Send a reply to the address near point (@code{gnus-article-mail}).  If
7882 given a prefix, include the mail.
7883
7884 @item s
7885 @kindex s (Article)
7886 @findex gnus-article-show-summary
7887 Reconfigure the buffers so that the summary buffer becomes visible
7888 (@code{gnus-article-show-summary}).
7889
7890 @item ?
7891 @kindex ? (Article)
7892 @findex gnus-article-describe-briefly
7893 Give a very brief description of the available keystrokes
7894 (@code{gnus-article-describe-briefly}). 
7895
7896 @item TAB
7897 @kindex TAB (Article)
7898 @findex gnus-article-next-button
7899 Go to the next button, if any (@code{gnus-article-next-button}).  This
7900 only makes sense if you have buttonizing turned on.
7901
7902 @item M-TAB
7903 @kindex M-TAB (Article)
7904 @findex gnus-article-prev-button
7905 Go to the previous button, if any (@code{gnus-article-prev-button}).  
7906
7907 @end table
7908
7909
7910 @node Misc Article
7911 @section Misc Article
7912
7913 @table @code
7914
7915 @item gnus-single-article-buffer
7916 @vindex gnus-single-article-buffer
7917 If non-@code{nil}, use the same article buffer for all the groups.
7918 (This is the default.)  If @code{nil}, each group will have its own
7919 article buffer.
7920
7921 @vindex gnus-article-prepare-hook
7922 @item gnus-article-prepare-hook
7923 This hook is called right after the article has been inserted into the
7924 article buffer.  It is mainly intended for functions that do something
7925 depending on the contents; it should probably not be used for changing
7926 the contents of the article buffer.
7927
7928 @vindex gnus-article-display-hook
7929 @item gnus-article-display-hook
7930 This hook is called as the last thing when displaying an article, and is
7931 intended for modifying the contents of the buffer, doing highlights,
7932 hiding headers, and the like.
7933
7934 @item gnus-article-mode-hook
7935 @vindex gnus-article-mode-hook
7936 Hook called in article mode buffers.
7937
7938 @item gnus-article-mode-syntax-table
7939 @vindex gnus-article-mode-syntax-table
7940 Syntax table used in article buffers.  It is initialized from
7941 @code{text-mode-syntax-table}. 
7942
7943 @vindex gnus-article-mode-line-format
7944 @item gnus-article-mode-line-format
7945 This variable is a format string along the same lines as
7946 @code{gnus-summary-mode-line-format}.  It accepts the same
7947 format specifications as that variable, with one extension:
7948
7949 @table @samp
7950 @item w
7951 The @dfn{wash status} of the article.  This is a short string with one
7952 character for each possible article wash operation that may have been
7953 performed. 
7954 @end table
7955
7956 @vindex gnus-break-pages
7957
7958 @item gnus-break-pages
7959 Controls whether @dfn{page breaking} is to take place.  If this variable
7960 is non-@code{nil}, the articles will be divided into pages whenever a
7961 page delimiter appears in the article.  If this variable is @code{nil},
7962 paging will not be done.
7963
7964 @item gnus-page-delimiter
7965 @vindex gnus-page-delimiter
7966 This is the delimiter mentioned above.  By default, it is @samp{^L}
7967 (formfeed).
7968 @end table
7969
7970
7971 @node Composing Messages
7972 @chapter Composing Messages
7973 @cindex composing messages
7974 @cindex messages
7975 @cindex mail
7976 @cindex sending mail
7977 @cindex reply
7978 @cindex followup
7979 @cindex post
7980
7981 @kindex C-c C-c (Post)
7982 All commands for posting and mailing will put you in a message buffer
7983 where you can edit the article all you like, before you send the article
7984 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7985 Manual}.  If you are in a foreign news group, and you wish to post the
7986 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7987 to make Gnus try to post using the foreign server.
7988
7989 @menu 
7990 * Mail::                 Mailing and replying.
7991 * Post::                 Posting and following up.
7992 * Posting Server::       What server should you post via?
7993 * Mail and Post::        Mailing and posting at the same time.
7994 * Archived Messages::    Where Gnus stores the messages you've sent.
7995 * Drafts::               Postponing messages and rejected messages.
7996 * Rejected Articles::    What happens if the server doesn't like your article?
7997 @end menu
7998
7999 Also see @pxref{Canceling and Superseding} for information on how to
8000 remove articles you shouldn't have posted.
8001
8002
8003 @node Mail
8004 @section Mail
8005
8006 Variables for customizing outgoing mail:
8007
8008 @table @code
8009 @item gnus-uu-digest-headers
8010 @vindex gnus-uu-digest-headers
8011 List of regexps to match headers included in digested messages.  The
8012 headers will be included in the sequence they are matched.
8013
8014 @item gnus-add-to-list
8015 @vindex gnus-add-to-list
8016 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8017 that have none when you do a @kbd{a}.
8018
8019 @end table
8020
8021
8022 @node Post
8023 @section Post
8024
8025 Variables for composing news articles:
8026
8027 @table @code
8028 @item gnus-sent-message-ids-file
8029 @vindex gnus-sent-message-ids-file
8030 Gnus will keep a @code{Message-ID} history file of all the mails it has
8031 sent.  If it discovers that it has already sent a mail, it will ask the
8032 user whether to re-send the mail.  (This is primarily useful when
8033 dealing with @sc{soup} packets and the like where one is apt to send the
8034 same packet multiple times.)  This variable says what the name of this
8035 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8036 this variable to @code{nil} if you don't want Gnus to keep a history
8037 file.
8038
8039 @item gnus-sent-message-ids-length
8040 @vindex gnus-sent-message-ids-length
8041 This variable says how many @code{Message-ID}s to keep in the history
8042 file.  It is 1000 by default.
8043
8044 @end table
8045
8046
8047 @node Posting Server
8048 @section Posting Server
8049
8050 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8051 (extremely intelligent, of course) article, where does it go?
8052
8053 Thank you for asking.  I hate you.
8054
8055 @vindex gnus-post-method
8056
8057 It can be quite complicated.  Normally, Gnus will use the same native
8058 server.  However.  If your native server doesn't allow posting, just
8059 reading, you probably want to use some other server to post your
8060 (extremely intelligent and fabulously interesting) articles.  You can
8061 then set the @code{gnus-post-method} to some other method:
8062
8063 @lisp
8064 (setq gnus-post-method '(nnspool ""))
8065 @end lisp
8066
8067 Now, if you've done this, and then this server rejects your article, or
8068 this server is down, what do you do then?  To override this variable you
8069 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8070 the ``current'' server for posting.
8071
8072 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8073 Gnus will prompt you for what method to use for posting.  
8074
8075 You can also set @code{gnus-post-method} to a list of select methods.
8076 If that's the case, Gnus will always prompt you for what method to use
8077 for posting. 
8078
8079
8080 @node Mail and Post
8081 @section Mail and Post
8082
8083 Here's a list of variables relevant to both mailing and
8084 posting:
8085
8086 @table @code
8087 @item gnus-mailing-list-groups
8088 @findex gnus-mailing-list-groups
8089 @cindex mailing lists
8090
8091 If your news server offers groups that are really mailing lists
8092 gatewayed to the @sc{nntp} server, you can read those groups without
8093 problems, but you can't post/followup to them without some difficulty.
8094 One solution is to add a @code{to-address} to the group parameters
8095 (@pxref{Group Parameters}).  An easier thing to do is set the
8096 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8097 really are mailing lists.  Then, at least, followups to the mailing
8098 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8099 still a pain, though.
8100
8101 @end table
8102
8103 You may want to do spell-checking on messages that you send out.  Or, if
8104 you don't want to spell-check by hand, you could add automatic
8105 spell-checking via the @code{ispell} package:
8106
8107 @cindex ispell
8108 @findex ispell-message
8109 @lisp
8110 (add-hook 'message-send-hook 'ispell-message) 
8111 @end lisp
8112
8113
8114 @node Archived Messages
8115 @section Archived Messages
8116 @cindex archived messages
8117 @cindex sent messages
8118
8119 Gnus provides a few different methods for storing the mail and news you
8120 send.  The default method is to use the @dfn{archive virtual server} to
8121 store the messages.  If you want to disable this completely, the
8122 @code{gnus-message-archive-group} variable should be @code{nil}, which
8123 is the default.
8124
8125 @vindex gnus-message-archive-method
8126 @code{gnus-message-archive-method} says what virtual server Gnus is to
8127 use to store sent messages.  The default is:
8128
8129 @lisp
8130 (nnfolder "archive"
8131           (nnfolder-directory   "~/Mail/archive")
8132           (nnfolder-active-file "~/Mail/archive/active")
8133           (nnfolder-get-new-mail nil)
8134           (nnfolder-inhibit-expiry t))
8135 @end lisp
8136
8137 You can, however, use any mail select method (@code{nnml},
8138 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8139 for doing this sort of thing, though.  If you don't like the default
8140 directory chosen, you could say something like:
8141
8142 @lisp
8143 (setq gnus-message-archive-method
8144       '(nnfolder "archive" 
8145                  (nnfolder-inhibit-expiry t)
8146                  (nnfolder-active-file "~/News/sent-mail/active")
8147                  (nnfolder-directory "~/News/sent-mail/")))
8148 @end lisp
8149
8150 @vindex gnus-message-archive-group
8151 @cindex Gcc
8152 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8153 to one or more group(s) on that server.  Which group to use is
8154 determined by the @code{gnus-message-archive-group} variable.  
8155
8156 This variable can be used to do the following:
8157
8158 @itemize @bullet
8159 @item a string
8160 Messages will be saved in that group.
8161 @item a list of strings
8162 Messages will be saved in all those groups.
8163 @item an alist of regexps, functions and forms
8164 When a key ``matches'', the result is used.
8165 @item @code{nil}
8166 No message archiving will take place.  This is the default.
8167 @end itemize
8168
8169 Let's illustrate:
8170
8171 Just saving to a single group called @samp{MisK}:
8172 @lisp
8173 (setq gnus-message-archive-group "MisK")
8174 @end lisp
8175
8176 Saving to two groups, @samp{MisK} and @samp{safe}:
8177 @lisp
8178 (setq gnus-message-archive-group '("MisK" "safe"))
8179 @end lisp
8180
8181 Save to different groups based on what group you are in:
8182 @lisp
8183 (setq gnus-message-archive-group 
8184       '(("^alt" "sent-to-alt")
8185         ("mail" "sent-to-mail")
8186         (".*" "sent-to-misc")))
8187 @end lisp
8188
8189 More complex stuff:
8190 @lisp
8191 (setq gnus-message-archive-group 
8192       '((if (message-news-p)
8193             "misc-news" 
8194           "misc-mail")))
8195 @end lisp       
8196
8197 How about storing all news messages in one file, but storing all mail
8198 messages in one file per month:
8199
8200 @lisp
8201 (setq gnus-message-archive-group
8202       '((if (message-news-p)
8203             "misc-news" 
8204           (concat "mail." (format-time-string 
8205                            "%Y-%m" (current-time))))))
8206 @end lisp
8207
8208 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8209 use a different value for @code{gnus-message-archive-group} there.)
8210
8211 Now, when you send a message off, it will be stored in the appropriate
8212 group.  (If you want to disable storing for just one particular message,
8213 you can just remove the @code{Gcc} header that has been inserted.)  The
8214 archive group will appear in the group buffer the next time you start
8215 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
8216 enter it and read the articles in it just like you'd read any other
8217 group.  If the group gets really big and annoying, you can simply rename
8218 if (using @kbd{G r} in the group buffer) to something
8219 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8220 continue to be stored in the old (now empty) group.
8221
8222 That's the default method of archiving sent messages.  Gnus offers a
8223 different way for the people who don't like the default method.  In that
8224 case you should set @code{gnus-message-archive-group} to @code{nil};
8225 this will disable archiving.
8226
8227 @table @code
8228 @item gnus-outgoing-message-group 
8229 @vindex gnus-outgoing-message-group 
8230 All outgoing messages will be put in this group.  If you want to store
8231 all your outgoing mail and articles in the group @samp{nnml:archive},
8232 you set this variable to that value.  This variable can also be a list of
8233 group names.
8234
8235 If you want to have greater control over what group to put each
8236 message in, you can set this variable to a function that checks the
8237 current newsgroup name and then returns a suitable group name (or list
8238 of names).
8239
8240 This variable can be used instead of @code{gnus-message-archive-group},
8241 but the latter is the preferred method.
8242 @end table
8243
8244
8245 @c @node Posting Styles
8246 @c @section Posting Styles
8247 @c @cindex posting styles
8248 @c @cindex styles
8249 @c 
8250 @c All them variables, they make my head swim.  
8251 @c 
8252 @c So what if you want a different @code{Organization} and signature based
8253 @c on what groups you post to?  And you post both from your home machine
8254 @c and your work machine, and you want different @code{From} lines, and so
8255 @c on? 
8256 @c 
8257 @c @vindex gnus-posting-styles
8258 @c One way to do stuff like that is to write clever hooks that change the
8259 @c variables you need to have changed.  That's a bit boring, so somebody
8260 @c came up with the bright idea of letting the user specify these things in
8261 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
8262 @c variable: 
8263 @c 
8264 @c @lisp
8265 @c ((".*" 
8266 @c   (signature . "Peace and happiness")
8267 @c   (organization . "What me?"))
8268 @c  ("^comp" 
8269 @c   (signature . "Death to everybody"))
8270 @c  ("comp.emacs.i-love-it" 
8271 @c   (organization . "Emacs is it")))
8272 @c @end lisp
8273 @c 
8274 @c As you might surmise from this example, this alist consists of several
8275 @c @dfn{styles}.  Each style will be applicable if the first element
8276 @c ``matches'', in some form or other.  The entire alist will be iterated
8277 @c over, from the beginning towards the end, and each match will be
8278 @c applied, which means that attributes in later styles that match override
8279 @c the same attributes in earlier matching styles.  So
8280 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
8281 @c signature and the @samp{What me?} @code{Organization} header.
8282 @c 
8283 @c The first element in each style is called the @code{match}.  If it's a
8284 @c string, then Gnus will try to regexp match it against the group name.
8285 @c If it's a function symbol, that function will be called with no
8286 @c arguments.  If it's a variable symbol, then the variable will be
8287 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
8288 @c any case, if this returns a non-@code{nil} value, then the style is said
8289 @c to @dfn{match}.
8290 @c 
8291 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8292 @c attribute consists of a @var{(name . value)} pair.  The attribute name
8293 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
8294 @c attribute name can also be a string.  In that case, this will be used as
8295 @c a header name, and the value will be inserted in the headers of the
8296 @c article.
8297 @c 
8298 @c The attribute value can be a string (used verbatim), a function (the
8299 @c return value will be used), a variable (its value will be used) or a
8300 @c list (it will be @code{eval}ed and the return value will be used).
8301 @c 
8302 @c So here's a new example:
8303 @c 
8304 @c @lisp
8305 @c (setq gnus-posting-styles
8306 @c       '((".*" 
8307 @c           (signature . "~/.signature") 
8308 @c           (from . "user@@foo (user)")
8309 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
8310 @c           (organization . "People's Front Against MWM"))
8311 @c         ("^rec.humor" 
8312 @c           (signature . my-funny-signature-randomizer))
8313 @c         ((equal (system-name) "gnarly")
8314 @c           (signature . my-quote-randomizer))
8315 @c         (posting-from-work-p
8316 @c           (signature . "~/.work-signature")
8317 @c           (from . "user@@bar.foo (user)")
8318 @c           (organization . "Important Work, Inc"))
8319 @c         ("^nn.+:" 
8320 @c           (signature . "~/.mail-signature"))))
8321 @c @end lisp
8322
8323 @node Drafts
8324 @section Drafts
8325 @cindex drafts
8326
8327 If you are writing a message (mail or news) and suddenly remember that
8328 you have a steak in the oven (or some pesto in the food processor, you
8329 craaazy vegetarians), you'll probably wish there was a method to save
8330 the message you are writing so that you can continue editing it some
8331 other day, and send it when you feel its finished.
8332
8333 Well, don't worry about it.  Whenever you start composing a message of
8334 some sort using the Gnus mail and post commands, the buffer you get will
8335 automatically associate to an article in a special @dfn{draft} group.
8336 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8337 article will be saved there.  (Auto-save files also go to the draft
8338 group.) 
8339
8340 @cindex nndraft
8341 @vindex nndraft-directory
8342 The draft group is a special group (which is implemented as an
8343 @code{nndraft} group, if you absolutely have to know) called
8344 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8345 @code{nndraft} is to store its files.  What makes this group special is
8346 that you can't tick any articles in it or mark any articles as
8347 read---all articles in the group are permanently unread.
8348
8349 If the group doesn't exist, it will be created and you'll be subscribed
8350 to it.  The only way to make it disappear from the Group buffer is to
8351 unsubscribe it. 
8352
8353 @c @findex gnus-dissociate-buffer-from-draft
8354 @c @kindex C-c M-d (Mail)
8355 @c @kindex C-c M-d (Post)
8356 @c @findex gnus-associate-buffer-with-draft
8357 @c @kindex C-c C-d (Mail)
8358 @c @kindex C-c C-d (Post)
8359 @c If you're writing some super-secret message that you later want to
8360 @c encode with PGP before sending, you may wish to turn the auto-saving
8361 @c (and association with the draft group) off.  You never know who might be
8362 @c interested in reading all your extremely valuable and terribly horrible
8363 @c and interesting secrets.  The @kbd{C-c M-d}
8364 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8365 @c If you change your mind and want to turn the auto-saving back on again,
8366 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8367 @c 
8368 @c @vindex gnus-use-draft
8369 @c To leave association with the draft group off by default, set
8370 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
8371
8372 @findex gnus-draft-edit-message
8373 @kindex D e (Draft)
8374 When you want to continue editing the article, you simply enter the
8375 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8376 that.  You will be placed in a buffer where you left off.
8377
8378 Rejected articles will also be put in this draft group (@pxref{Rejected
8379 Articles}).
8380
8381 @findex gnus-draft-send-all-messages
8382 @findex gnus-draft-send-message
8383 If you have lots of rejected messages you want to post (or mail) without
8384 doing further editing, you can use the @kbd{D s} command
8385 (@code{gnus-draft-send-message}).  This command understands the
8386 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
8387 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8388 in the buffer.
8389
8390 If you have some messages that you wish not to send, you can use the
8391 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8392 as unsendable.  This is a toggling command.
8393
8394
8395 @node Rejected Articles
8396 @section Rejected Articles
8397 @cindex rejected articles
8398
8399 Sometimes a news server will reject an article.  Perhaps the server
8400 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
8401 @emph{there be demons}.  Perhaps you have included too much cited text.
8402 Perhaps the disk is full.  Perhaps the server is down.
8403
8404 These situations are, of course, totally beyond the control of Gnus.
8405 (Gnus, of course, loves the way you look, always feels great, has angels
8406 fluttering around inside of it, doesn't care about how much cited text
8407 you include, never runs full and never goes down.)  So Gnus saves these
8408 articles until some later time when the server feels better.
8409
8410 The rejected articles will automatically be put in a special draft group
8411 (@pxref{Drafts}).  When the server comes back up again, you'd then
8412 typically enter that group and send all the articles off.
8413
8414
8415 @node Select Methods
8416 @chapter Select Methods
8417 @cindex foreign groups
8418 @cindex select methods
8419
8420 A @dfn{foreign group} is a group not read by the usual (or
8421 default) means.  It could be, for instance, a group from a different
8422 @sc{nntp} server, it could be a virtual group, or it could be your own
8423 personal mail group.
8424
8425 A foreign group (or any group, really) is specified by a @dfn{name} and
8426 a @dfn{select method}.  To take the latter first, a select method is a
8427 list where the first element says what backend to use (e.g. @code{nntp},
8428 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8429 name}.  There may be additional elements in the select method, where the
8430 value may have special meaning for the backend in question.
8431
8432 One could say that a select method defines a @dfn{virtual server}---so
8433 we do just that (@pxref{The Server Buffer}).
8434
8435 The @dfn{name} of the group is the name the backend will recognize the
8436 group as.
8437
8438 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8439 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8440 method @code{(nntp "some.where.edu")}.  Gnus will call this group
8441 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8442 backend just knows this group as @samp{soc.motss}.
8443
8444 The different methods all have their peculiarities, of course.
8445
8446 @menu
8447 * The Server Buffer::     Making and editing virtual servers.
8448 * Getting News::          Reading USENET news with Gnus.
8449 * Getting Mail::          Reading your personal mail with Gnus.
8450 * Other Sources::         Reading directories, files, SOUP packets.
8451 * Combined Groups::       Combining groups into one group.
8452 * Gnus Unplugged::        Reading news and mail offline.
8453 @end menu
8454
8455
8456 @node The Server Buffer
8457 @section The Server Buffer
8458
8459 Traditionally, a @dfn{server} is a machine or a piece of software that
8460 one connects to, and then requests information from.  Gnus does not
8461 connect directly to any real servers, but does all transactions through
8462 one backend or other.  But that's just putting one layer more between
8463 the actual media and Gnus, so we might just as well say that each
8464 backend represents a virtual server.
8465
8466 For instance, the @code{nntp} backend may be used to connect to several
8467 different actual @sc{nntp} servers, or, perhaps, to many different ports
8468 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8469 use, and what parameters to set by specifying a @dfn{select method}.
8470
8471 These select method specifications can sometimes become quite
8472 complicated---say, for instance, that you want to read from the
8473 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8474 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8475 Anyways, if you had to specify that for each group that used this
8476 server, that would be too much work, so Gnus offers a way of naming
8477 select methods, which is what you do in the server buffer.
8478
8479 To enter the server buffer, use the @kbd{^}
8480 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8481
8482 @menu
8483 * Server Buffer Format::      You can customize the look of this buffer.
8484 * Server Commands::           Commands to manipulate servers.
8485 * Example Methods::           Examples server specifications.
8486 * Creating a Virtual Server:: An example session.
8487 * Server Variables::          Which variables to set.
8488 * Servers and Methods::       You can use server names as select methods.
8489 * Unavailable Servers::       Some servers you try to contact may be down.
8490 @end menu
8491
8492 @vindex gnus-server-mode-hook
8493 @code{gnus-server-mode-hook} is run when creating the server buffer.
8494
8495
8496 @node Server Buffer Format
8497 @subsection Server Buffer Format
8498 @cindex server buffer format
8499
8500 @vindex gnus-server-line-format
8501 You can change the look of the server buffer lines by changing the
8502 @code{gnus-server-line-format} variable.  This is a @code{format}-like
8503 variable, with some simple extensions:
8504
8505 @table @samp
8506
8507 @item h 
8508 How the news is fetched---the backend name.
8509
8510 @item n
8511 The name of this server.
8512
8513 @item w
8514 Where the news is to be fetched from---the address.
8515
8516 @item s
8517 The opened/closed/denied status of the server.
8518 @end table
8519
8520 @vindex gnus-server-mode-line-format
8521 The mode line can also be customized by using the
8522 @code{gnus-server-mode-line-format} variable.  The following specs are
8523 understood: 
8524
8525 @table @samp
8526 @item S
8527 Server name.
8528
8529 @item M
8530 Server method.
8531 @end table
8532
8533 Also @pxref{Formatting Variables}.
8534
8535
8536 @node Server Commands
8537 @subsection Server Commands
8538 @cindex server commands
8539
8540 @table @kbd
8541
8542 @item a
8543 @kindex a (Server)
8544 @findex gnus-server-add-server
8545 Add a new server (@code{gnus-server-add-server}).
8546
8547 @item e
8548 @kindex e (Server)
8549 @findex gnus-server-edit-server
8550 Edit a server (@code{gnus-server-edit-server}).
8551
8552 @item SPACE
8553 @kindex SPACE (Server)
8554 @findex gnus-server-read-server
8555 Browse the current server (@code{gnus-server-read-server}).
8556
8557 @item q
8558 @kindex q (Server)
8559 @findex gnus-server-exit
8560 Return to the group buffer (@code{gnus-server-exit}).
8561
8562 @item k
8563 @kindex k (Server)
8564 @findex gnus-server-kill-server
8565 Kill the current server (@code{gnus-server-kill-server}).
8566
8567 @item y
8568 @kindex y (Server)
8569 @findex gnus-server-yank-server
8570 Yank the previously killed server (@code{gnus-server-yank-server}).
8571
8572 @item c
8573 @kindex c (Server)
8574 @findex gnus-server-copy-server
8575 Copy the current server (@code{gnus-server-copy-server}).
8576
8577 @item l
8578 @kindex l (Server)
8579 @findex gnus-server-list-servers
8580 List all servers (@code{gnus-server-list-servers}).
8581
8582 @item s
8583 @kindex s (Server)
8584 @findex gnus-server-scan-server
8585 Request that the server scan its sources for new articles
8586 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8587 servers. 
8588
8589 @item g
8590 @kindex g (Server)
8591 @findex gnus-server-regenerate-server
8592 Request that the server regenerate all its data structures
8593 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8594 a mail backend that has gotten out of synch.
8595
8596 @end table
8597
8598
8599 @node Example Methods
8600 @subsection Example Methods
8601
8602 Most select methods are pretty simple and self-explanatory: 
8603
8604 @lisp
8605 (nntp "news.funet.fi")
8606 @end lisp
8607
8608 Reading directly from the spool is even simpler:
8609
8610 @lisp
8611 (nnspool "")
8612 @end lisp
8613
8614 As you can see, the first element in a select method is the name of the
8615 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8616 will. 
8617
8618 After these two elements, there may be an arbitrary number of
8619 @var{(variable form)} pairs.
8620
8621 To go back to the first example---imagine that you want to read from
8622 port 15 on that machine.  This is what the select method should
8623 look like then:
8624
8625 @lisp
8626 (nntp "news.funet.fi" (nntp-port-number 15))
8627 @end lisp
8628
8629 You should read the documentation to each backend to find out what
8630 variables are relevant, but here's an @code{nnmh} example:
8631
8632 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8633 you have two structures that you wish to access: One is your private
8634 mail spool, and the other is a public one.  Here's the possible spec for
8635 your private mail:
8636
8637 @lisp
8638 (nnmh "private" (nnmh-directory "~/private/mail/"))
8639 @end lisp
8640
8641 (This server is then called @samp{private}, but you may have guessed
8642 that.)
8643
8644 Here's the method for a public spool:
8645
8646 @lisp
8647 (nnmh "public" 
8648       (nnmh-directory "/usr/information/spool/") 
8649       (nnmh-get-new-mail nil))
8650 @end lisp
8651
8652 If you are behind a firewall and only have access to the @sc{nntp}
8653 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8654 on the firewall machine and telnet from there to the @sc{nntp} server.
8655 Doing this can be rather fiddly, but your virtual server definition
8656 should probably look something like this:
8657
8658 @lisp
8659 (nntp "firewall"
8660       (nntp-address "the.firewall.machine")
8661       (nntp-open-connection-function nntp-open-rlogin)
8662       (nntp-end-of-line "\n")
8663       (nntp-rlogin-parameters
8664        ("telnet" "the.real.nntp.host" "nntp")))
8665 @end lisp
8666
8667
8668
8669 @node Creating a Virtual Server
8670 @subsection Creating a Virtual Server
8671
8672 If you're saving lots of articles in the cache by using persistent
8673 articles, you may want to create a virtual server to read the cache.
8674
8675 First you need to add a new server.  The @kbd{a} command does that.  It
8676 would probably be best to use @code{nnspool} to read the cache.  You
8677 could also use @code{nnml} or @code{nnmh}, though.
8678
8679 Type @kbd{a nnspool RET cache RET}.
8680
8681 You should now have a brand new @code{nnspool} virtual server called
8682 @samp{cache}.  You now need to edit it to have the right definitions.
8683 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8684 will contain the following:
8685
8686 @lisp
8687 (nnspool "cache")
8688 @end lisp
8689
8690 Change that to:
8691
8692 @lisp
8693 (nnspool "cache"
8694          (nnspool-spool-directory "~/News/cache/")
8695          (nnspool-nov-directory "~/News/cache/")
8696          (nnspool-active-file "~/News/cache/active"))
8697 @end lisp
8698
8699 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8700 @kbd{RET} over this virtual server, you should be entered into a browse
8701 buffer, and you should be able to enter any of the groups displayed.
8702
8703
8704 @node Server Variables
8705 @subsection Server Variables
8706
8707 One sticky point when defining variables (both on backends and in Emacs
8708 in general) is that some variables are typically initialized from other
8709 variables when the definition of the variables is being loaded.  If you
8710 change the "base" variable after the variables have been loaded, you
8711 won't change the "derived" variables.
8712
8713 This typically affects directory and file variables.  For instance,
8714 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8715 directory variables are initialized from that variable, so
8716 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8717 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8718 @code{nnml-directory}---you have to explicitly set all the file
8719 variables to be what you want them to be.  For a complete list of
8720 variables for each backend, see each backend's section later in this
8721 manual, but here's an example @code{nnml} definition:
8722
8723 @lisp
8724 (nnml "public" 
8725       (nnml-directory "~/my-mail/")
8726       (nnml-active-file "~/my-mail/active")
8727       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8728 @end lisp
8729
8730
8731 @node Servers and Methods
8732 @subsection Servers and Methods
8733
8734 Wherever you would normally use a select method
8735 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8736 when browsing a foreign server) you can use a virtual server name
8737 instead.  This could potentially save lots of typing.  And it's nice all
8738 over.
8739
8740
8741 @node Unavailable Servers
8742 @subsection Unavailable Servers
8743
8744 If a server seems to be unreachable, Gnus will mark that server as
8745 @code{denied}.  That means that any subsequent attempt to make contact
8746 with that server will just be ignored.  ``It can't be opened,'' Gnus
8747 will tell you, without making the least effort to see whether that is
8748 actually the case or not.
8749
8750 That might seem quite naughty, but it does make sense most of the time.
8751 Let's say you have 10 groups subscribed to on server
8752 @samp{nephelococcygia.com}.  This server is located somewhere quite far
8753 away from you and the machine is quite slow, so it takes 1 minute just
8754 to find out that it refuses connection to you today.  If Gnus were to
8755 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8756 attempt to do that.  Once it has gotten a single ``connection refused'',
8757 it will regard that server as ``down''.
8758
8759 So, what happens if the machine was only feeling unwell temporarily?
8760 How do you test to see whether the machine has come up again?
8761
8762 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8763 with the following commands:
8764
8765 @table @kbd
8766
8767 @item O
8768 @kindex O (Server)
8769 @findex gnus-server-open-server
8770 Try to establish connection to the server on the current line
8771 (@code{gnus-server-open-server}).
8772
8773 @item C
8774 @kindex C (Server)
8775 @findex gnus-server-close-server
8776 Close the connection (if any) to the server
8777 (@code{gnus-server-close-server}).
8778
8779 @item D
8780 @kindex D (Server)
8781 @findex gnus-server-deny-server
8782 Mark the current server as unreachable
8783 (@code{gnus-server-deny-server}). 
8784
8785 @item M-o
8786 @kindex M-o (Server)
8787 @findex gnus-server-open-all-servers
8788 Open the connections to all servers in the buffer
8789 (@code{gnus-server-open-all-servers}). 
8790
8791 @item M-c
8792 @kindex M-c (Server)
8793 @findex gnus-server-close-all-servers
8794 Close the connections to all servers in the buffer
8795 (@code{gnus-server-close-all-servers}). 
8796
8797 @item R
8798 @kindex R (Server)
8799 @findex gnus-server-remove-denials
8800 Remove all marks to whether Gnus was denied connection from any servers
8801 (@code{gnus-server-remove-denials}). 
8802
8803 @end table
8804
8805
8806 @node Getting News
8807 @section Getting News
8808 @cindex reading news
8809 @cindex news backends
8810
8811 A newsreader is normally used for reading news.  Gnus currently provides
8812 only two methods of getting news---it can read from an @sc{nntp} server,
8813 or it can read from a local spool.
8814
8815 @menu
8816 * NNTP::               Reading news from an @sc{nntp} server.
8817 * News Spool::         Reading news from the local spool.
8818 @end menu
8819
8820
8821 @node NNTP
8822 @subsection @sc{nntp}
8823 @cindex nntp
8824
8825 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8826 You just specify @code{nntp} as method and the address of the @sc{nntp}
8827 server as the, uhm, address.
8828
8829 If the @sc{nntp} server is located at a non-standard port, setting the
8830 third element of the select method to this port number should allow you
8831 to connect to the right port.  You'll have to edit the group info for
8832 that (@pxref{Foreign Groups}).
8833
8834 The name of the foreign group can be the same as a native group.  In
8835 fact, you can subscribe to the same group from as many different servers
8836 you feel like.  There will be no name collisions.
8837
8838 The following variables can be used to create a virtual @code{nntp}
8839 server: 
8840
8841 @table @code
8842
8843 @item nntp-server-opened-hook
8844 @vindex nntp-server-opened-hook
8845 @cindex @sc{mode reader}
8846 @cindex authinfo
8847 @cindex authentification
8848 @cindex nntp authentification
8849 @findex nntp-send-authinfo
8850 @findex nntp-send-mode-reader
8851 is run after a connection has been made.  It can be used to send
8852 commands to the @sc{nntp} server after it has been contacted.  By
8853 default it sends the command @code{MODE READER} to the server with the
8854 @code{nntp-send-mode-reader} function.  This function should always be
8855 present in this hook.
8856
8857 @item nntp-authinfo-function 
8858 @vindex nntp-authinfo-function 
8859 @findex nntp-send-authinfo
8860 @vindex nntp-authinforc-file
8861 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8862 server.  The default function is @code{nntp-send-authinfo}, which looks
8863 through your @file{~/.authinforc} (or whatever you've set the
8864 @code{nntp-authinforc-file} variable to) for applicable entries.  If
8865 none are found, it will prompt you for a login name and a password.  The
8866 format of the @file{~/.authinforc} file is the same as the @code{ftp}
8867 @file{~/.netrc} file, which is defined in the @code{ftp} manual page,
8868 but here are the salient facts:
8869
8870 @enumerate
8871 @item
8872 The file contains one or more line, each of which define one server.
8873
8874 @item
8875 Each line may contain an arbitrary number of token/value pairs.  The
8876 valid tokens include @samp{machine}, @samp{login}, and @samp{password}.
8877
8878 @end enumerate
8879
8880 Here's an example file:
8881
8882 @example
8883 machine news.uio.no login larsi password geheimnis
8884 machine nntp.ifi.uio.no login larsi
8885 @end example
8886
8887 The token/value pairs may appear in any order; @samp{machine} doesn't
8888 have to be first, for instance.
8889
8890 In this example, both login name and password have been supplied for the
8891 former server, while the latter has only the login name listed, and the
8892 user will be prompted for the password.
8893
8894 Remember to not leave the @file{~/.authinforc} file world-readable.
8895
8896 @item nntp-server-action-alist 
8897 @vindex nntp-server-action-alist 
8898 This is a list of regexps to match on server types and actions to be
8899 taken when matches are made.  For instance, if you want Gnus to beep
8900 every time you connect to innd, you could say something like:
8901
8902 @lisp
8903 (setq nntp-server-action-alist
8904       '(("innd" (ding))))
8905 @end lisp
8906
8907 You probably don't want to do that, though.
8908
8909 The default value is
8910
8911 @lisp
8912 '(("nntpd 1\\.5\\.11t" 
8913    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
8914 @end lisp
8915
8916 This ensures that Gnus doesn't send the @code{MODE READER} command to
8917 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8918
8919 @item nntp-maximum-request
8920 @vindex nntp-maximum-request
8921 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8922 will collect headers by sending a series of @code{head} commands.  To
8923 speed things up, the backend sends lots of these commands without
8924 waiting for reply, and then reads all the replies.  This is controlled
8925 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8926 your network is buggy, you should set this to 1.
8927
8928 @item nntp-connection-timeout
8929 @vindex nntp-connection-timeout
8930 If you have lots of foreign @code{nntp} groups that you connect to
8931 regularly, you're sure to have problems with @sc{nntp} servers not
8932 responding properly, or being too loaded to reply within reasonable
8933 time.  This is can lead to awkward problems, which can be helped
8934 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8935 that says how many seconds the @code{nntp} backend should wait for a
8936 connection before giving up.  If it is @code{nil}, which is the default,
8937 no timeouts are done.
8938
8939 @c @item nntp-command-timeout
8940 @c @vindex nntp-command-timeout
8941 @c @cindex PPP connections
8942 @c @cindex dynamic IP addresses
8943 @c If you're running Gnus on a machine that has a dynamically assigned
8944 @c address, Gnus may become confused.  If the address of your machine
8945 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
8946 @c waiting forever for replies from the server.  To help with this
8947 @c unfortunate problem, you can set this command to a number.  Gnus will
8948 @c then, if it sits waiting for a reply from the server longer than that
8949 @c number of seconds, shut down the connection, start a new one, and resend
8950 @c the command.  This should hopefully be transparent to the user.  A
8951 @c likely number is 30 seconds.
8952 @c 
8953 @c @item nntp-retry-on-break
8954 @c @vindex nntp-retry-on-break
8955 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8956 @c hangs.  This will have much the same effect as the command timeout
8957 @c described above.
8958
8959 @item nntp-server-hook
8960 @vindex nntp-server-hook
8961 This hook is run as the last step when connecting to an @sc{nntp}
8962 server.
8963
8964 @findex nntp-open-rlogin
8965 @findex nntp-open-telnet
8966 @findex nntp-open-network-stream
8967 @item nntp-open-connection-function
8968 @vindex nntp-open-connection-function
8969 This function is used to connect to the remote system.  Three pre-made
8970 functions are @code{nntp-open-network-stream}, which is the default, and
8971 simply connects to some port or other on the remote system.  The other
8972 two are @code{nntp-open-rlogin}, which does an @samp{rlogin} on the
8973 remote system, and then does a @samp{telnet} to the @sc{nntp} server
8974 available there, and @code{nntp-open-telnet}, which does a @samp{telnet}
8975 to the remote system and then another @samp{telnet} to get to the
8976 @sc{nntp} server.
8977
8978 @code{nntp-open-rlogin}-related variables:
8979
8980 @table @code
8981
8982 @item nntp-rlogin-program 
8983 @vindex nntp-rlogin-program 
8984 Program used to log in on remote machines.  The default is @samp{rsh},
8985 but @samp{ssh} is a popular alternative.
8986
8987 @item nntp-rlogin-parameters
8988 @vindex nntp-rlogin-parameters
8989 This list will be used as the parameter list given to @code{rsh}.
8990
8991 @item nntp-rlogin-user-name
8992 @vindex nntp-rlogin-user-name
8993 User name on the remote system.
8994
8995 @end table
8996
8997 @code{nntp-open-telnet}-related variables:
8998
8999 @table @code
9000 @item nntp-telnet-command
9001 @vindex nntp-telnet-command
9002 Command used to start @code{telnet}.
9003
9004 @item nntp-telnet-switches
9005 @vindex nntp-telnet-switches
9006 List of strings to be used as the switches to the @code{telnet} command.
9007
9008 @item nntp-telnet-user-name
9009 @vindex nntp-telnet-user-name
9010 User name for log in on the remote system.
9011
9012 @item nntp-telnet-passwd
9013 @vindex nntp-telnet-passwd
9014 Password to use when logging in.
9015
9016 @item nntp-telnet-parameters
9017 @vindex nntp-telnet-parameters
9018 A list of strings executed as a command after logging in
9019 via @code{telnet}.
9020
9021 @item nntp-telnet-shell-prompt
9022 @vindex nntp-telnet-shell-prompt
9023 Regexp matching the shell prompt on the remote machine.  The default is
9024 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9025
9026 @item nntp-open-telnet-envuser
9027 @vindex nntp-open-telnet-envuser
9028 If non-@code{nil}, the @code{telnet} session (client and server both)
9029 will support the @code{ENVIRON} option and not prompt for login name.
9030 This works for Solaris @code{telnet}, for instance.
9031
9032 @end table
9033
9034 @item nntp-end-of-line
9035 @vindex nntp-end-of-line
9036 String to use as end-of-line marker when talking to the @sc{nntp}
9037 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9038 using @code{rlogin} to talk to the server.
9039
9040 @item nntp-rlogin-user-name
9041 @vindex nntp-rlogin-user-name
9042 User name on the remote system when using the @code{rlogin} connect
9043 function. 
9044
9045 @item nntp-address
9046 @vindex nntp-address
9047 The address of the remote system running the @sc{nntp} server.
9048
9049 @item nntp-port-number
9050 @vindex nntp-port-number
9051 Port number to connect to when using the @code{nntp-open-network-stream}
9052 connect function.
9053
9054 @item nntp-buggy-select
9055 @vindex nntp-buggy-select
9056 Set this to non-@code{nil} if your select routine is buggy.
9057
9058 @item nntp-nov-is-evil 
9059 @vindex nntp-nov-is-evil 
9060 If the @sc{nntp} server does not support @sc{nov}, you could set this
9061 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9062 can be used.
9063
9064 @item nntp-xover-commands
9065 @vindex nntp-xover-commands
9066 @cindex nov
9067 @cindex XOVER
9068 List of strings used as commands to fetch @sc{nov} lines from a
9069 server.  The default value of this variable is @code{("XOVER"
9070 "XOVERVIEW")}. 
9071
9072 @item nntp-nov-gap
9073 @vindex nntp-nov-gap
9074 @code{nntp} normally sends just one big request for @sc{nov} lines to
9075 the server.  The server responds with one huge list of lines.  However,
9076 if you have read articles 2-5000 in the group, and only want to read
9077 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9078 lines that you will not need.  This variable says how
9079 big a gap between two consecutive articles is allowed to be before the
9080 @code{XOVER} request is split into several request.  Note that if your
9081 network is fast, setting this variable to a really small number means
9082 that fetching will probably be slower.  If this variable is @code{nil},
9083 @code{nntp} will never split requests.  The default is 5.
9084
9085 @item nntp-prepare-server-hook
9086 @vindex nntp-prepare-server-hook
9087 A hook run before attempting to connect to an @sc{nntp} server.
9088
9089 @item nntp-warn-about-losing-connection
9090 @vindex nntp-warn-about-losing-connection
9091 If this variable is non-@code{nil}, some noise will be made when a
9092 server closes connection.
9093
9094 @end table
9095
9096
9097 @node News Spool
9098 @subsection News Spool
9099 @cindex nnspool
9100 @cindex news spool
9101
9102 Subscribing to a foreign group from the local spool is extremely easy,
9103 and might be useful, for instance, to speed up reading groups that
9104 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9105 instance. 
9106
9107 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9108 anything else) as the address.
9109
9110 If you have access to a local spool, you should probably use that as the
9111 native select method (@pxref{Finding the News}).  It is normally faster
9112 than using an @code{nntp} select method, but might not be.  It depends.
9113 You just have to try to find out what's best at your site.
9114
9115 @table @code
9116
9117 @item nnspool-inews-program
9118 @vindex nnspool-inews-program
9119 Program used to post an article.
9120
9121 @item nnspool-inews-switches
9122 @vindex nnspool-inews-switches
9123 Parameters given to the inews program when posting an article. 
9124
9125 @item nnspool-spool-directory
9126 @vindex nnspool-spool-directory
9127 Where @code{nnspool} looks for the articles.  This is normally
9128 @file{/usr/spool/news/}.
9129
9130 @item nnspool-nov-directory 
9131 @vindex nnspool-nov-directory 
9132 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9133 @file{/usr/spool/news/over.view/}.
9134
9135 @item nnspool-lib-dir
9136 @vindex nnspool-lib-dir
9137 Where the news lib dir is (@file{/usr/lib/news/} by default).
9138
9139 @item nnspool-active-file
9140 @vindex nnspool-active-file
9141 The path to the active file.
9142
9143 @item nnspool-newsgroups-file
9144 @vindex nnspool-newsgroups-file
9145 The path to the group descriptions file.
9146
9147 @item nnspool-history-file
9148 @vindex nnspool-history-file
9149 The path to the news history file.
9150
9151 @item nnspool-active-times-file
9152 @vindex nnspool-active-times-file
9153 The path to the active date file.
9154
9155 @item nnspool-nov-is-evil
9156 @vindex nnspool-nov-is-evil
9157 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9158 that it finds.
9159
9160 @item nnspool-sift-nov-with-sed
9161 @vindex nnspool-sift-nov-with-sed
9162 @cindex sed
9163 If non-@code{nil}, which is the default, use @code{sed} to get the
9164 relevant portion from the overview file.  If nil, @code{nnspool} will
9165 load the entire file into a buffer and process it there.
9166
9167 @end table
9168
9169
9170 @node Getting Mail
9171 @section Getting Mail
9172 @cindex reading mail
9173 @cindex mail
9174
9175 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9176 course.
9177
9178 @menu
9179 * Getting Started Reading Mail:: A simple cookbook example.
9180 * Splitting Mail::               How to create mail groups.
9181 * Mail Backend Variables::       Variables for customizing mail handling.
9182 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9183 * Mail and Procmail::            Reading mail groups that procmail create.
9184 * Incorporating Old Mail::       What about the old mail you have?
9185 * Expiring Mail::                Getting rid of unwanted mail.
9186 * Washing Mail::                 Removing gruft from the mail you get.
9187 * Duplicates::                   Dealing with duplicated mail.
9188 * Not Reading Mail::             Using mail backends for reading other files.
9189 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9190 @end menu
9191
9192
9193 @node Getting Started Reading Mail
9194 @subsection Getting Started Reading Mail
9195
9196 It's quite easy to use Gnus to read your new mail.  You just plonk the
9197 mail backend of your choice into @code{gnus-secondary-select-methods},
9198 and things will happen automatically.
9199
9200 For instance, if you want to use @code{nnml} (which is a "one file per
9201 mail" backend), you could put the following in your @file{.gnus} file:
9202
9203 @lisp
9204 (setq gnus-secondary-select-methods
9205       '((nnml "private")))
9206 @end lisp
9207
9208 Now, the next time you start Gnus, this backend will be queried for new
9209 articles, and it will move all the messages in your spool file to its
9210 directory, which is @code{~/Mail/} by default.  The new group that will
9211 be created (@samp{mail.misc}) will be subscribed, and you can read it
9212 like any other group.
9213
9214 You will probably want to split the mail into several groups, though:
9215
9216 @lisp
9217 (setq nnmail-split-methods
9218       '(("junk" "^From:.*Lars Ingebrigtsen")
9219         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9220         ("other" "")))
9221 @end lisp
9222
9223 This will result in three new @code{nnml} mail groups being created:
9224 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
9225 mail that doesn't fit into the first two groups will be placed in the
9226 last group.
9227
9228 This should be sufficient for reading mail with Gnus.  You might want to
9229 give the other sections in this part of the manual a perusal, though.
9230 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
9231
9232
9233 @node Splitting Mail
9234 @subsection Splitting Mail
9235 @cindex splitting mail
9236 @cindex mail splitting
9237
9238 @vindex nnmail-split-methods
9239 The @code{nnmail-split-methods} variable says how the incoming mail is
9240 to be split into groups.
9241
9242 @lisp
9243 (setq nnmail-split-methods
9244   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9245     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9246     ("mail.other" "")))
9247 @end lisp
9248
9249 This variable is a list of lists, where the first element of each of
9250 these lists is the name of the mail group (they do not have to be called
9251 something beginning with @samp{mail}, by the way), and the second
9252 element is a regular expression used on the header of each mail to
9253 determine if it belongs in this mail group.  The first string may
9254 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9255 insert sub-expressions from the matched text.  For instance:
9256
9257 @lisp
9258 ("list.\\1" "From:.*\\(.*\\)-list@@majordomo.com")
9259 @end lisp
9260
9261 If the first element is the special symbol @code{junk}, then messages
9262 that match the regexp will disappear into the aether.  Use with
9263 extreme caution. 
9264
9265 The second element can also be a function.  In that case, it will be
9266 called narrowed to the headers with the first element of the rule as the
9267 argument.  It should return a non-@code{nil} value if it thinks that the
9268 mail belongs in that group.
9269
9270 The last of these groups should always be a general one, and the regular
9271 expression should @emph{always} be @samp{} so that it matches any mails
9272 that haven't been matched by any of the other regexps.  (These rules are
9273 processed from the beginning of the alist toward the end.  The first
9274 rule to make a match will "win", unless you have crossposting enabled.
9275 In that case, all matching rules will "win".)
9276
9277 If you like to tinker with this yourself, you can set this variable to a
9278 function of your choice.  This function will be called without any
9279 arguments in a buffer narrowed to the headers of an incoming mail
9280 message.  The function should return a list of group names that it
9281 thinks should carry this mail message.
9282
9283 Note that the mail backends are free to maul the poor, innocent,
9284 incoming headers all they want to.  They all add @code{Lines} headers;
9285 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9286 @code{From<SPACE>} line to something else.
9287
9288 @vindex nnmail-crosspost
9289 The mail backends all support cross-posting.  If several regexps match,
9290 the mail will be ``cross-posted'' to all those groups.
9291 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
9292 that no articles are crossposted to the general (@samp{}) group.
9293
9294 @vindex nnmail-crosspost-link-function
9295 @cindex crosspost
9296 @cindex links
9297 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9298 the crossposted articles.  However, not all file systems support hard
9299 links.  If that's the case for you, set
9300 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
9301 variable is @code{add-name-to-file} by default.)  
9302
9303 @kindex M-x nnmail-split-history
9304 @kindex nnmail-split-history
9305 If you wish to see where the previous mail split put the messages, you
9306 can use the @kbd{M-x nnmail-split-history} command.
9307
9308 Gnus gives you all the opportunity you could possibly want for shooting
9309 yourself in the foot.  Let's say you create a group that will contain
9310 all the mail you get from your boss.  And then you accidentally
9311 unsubscribe from the group.  Gnus will still put all the mail from your
9312 boss in the unsubscribed group, and so, when your boss mails you ``Have
9313 that report ready by Monday or you're fired!'', you'll never see it and,
9314 come Tuesday, you'll still believe that you're gainfully employed while
9315 you really should be out collecting empty bottles to save up for next
9316 month's rent money.
9317
9318
9319 @node Mail Backend Variables
9320 @subsection Mail Backend Variables
9321
9322 These variables are (for the most part) pertinent to all the various
9323 mail backends.
9324
9325 @table @code
9326 @vindex nnmail-read-incoming-hook
9327 @item nnmail-read-incoming-hook
9328 The mail backends all call this hook after reading new mail.  You can
9329 use this hook to notify any mail watch programs, if you want to.
9330
9331 @vindex nnmail-spool-file
9332 @item nnmail-spool-file
9333 @cindex POP mail
9334 @cindex MAILHOST
9335 @cindex movemail
9336 @vindex nnmail-pop-password
9337 @vindex nnmail-pop-password-required
9338 The backends will look for new mail in this file.  If this variable is
9339 @code{nil}, the mail backends will never attempt to fetch mail by
9340 themselves.  If you are using a POP mail server and your name is
9341 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
9342 your name is not @samp{larsi}, you should probably modify that
9343 slightly, but you may have guessed that already, you smart & handsome
9344 devil!  You can also set this variable to @code{pop}, and Gnus will try
9345 to figure out the POP mail string by itself.  In any case, Gnus will
9346 call @code{movemail} which will contact the POP server named in the
9347 @code{MAILHOST} environment variable.  If the POP server needs a
9348 password, you can either set @code{nnmail-pop-password-required} to
9349 @code{t} and be prompted for the password, or set
9350 @code{nnmail-pop-password} to the password itself.
9351
9352 @code{nnmail-spool-file} can also be a list of mailboxes.
9353
9354 Your Emacs has to have been configured with @samp{--with-pop} before
9355 compilation.  This is the default, but some installations have it
9356 switched off.
9357
9358 When you use a mail backend, Gnus will slurp all your mail from your
9359 inbox and plonk it down in your home directory.  Gnus doesn't move any
9360 mail if you're not using a mail backend---you have to do a lot of magic
9361 invocations first.  At the time when you have finished drawing the
9362 pentagram, lightened the candles, and sacrificed the goat, you really
9363 shouldn't be too surprised when Gnus moves your mail.
9364
9365 @vindex nnmail-use-procmail
9366 @vindex nnmail-procmail-suffix
9367 @item nnmail-use-procmail
9368 If non-@code{nil}, the mail backends will look in
9369 @code{nnmail-procmail-directory} for incoming mail.  All the files in
9370 that directory that have names ending in @code{nnmail-procmail-suffix}
9371 will be considered incoming mailboxes, and will be searched for new
9372 mail.
9373
9374 @vindex nnmail-crash-box
9375 @item nnmail-crash-box
9376 When a mail backend reads a spool file, mail is first moved to this
9377 file, which is @file{~/.gnus-crash-box} by default.  If this file
9378 already exists, it will always be read (and incorporated) before any
9379 other spool files.
9380
9381 @vindex nnmail-prepare-incoming-hook
9382 @item nnmail-prepare-incoming-hook
9383 This is run in a buffer that holds all the new incoming mail, and can be
9384 used for, well, anything, really.
9385
9386 @vindex nnmail-split-hook
9387 @item nnmail-split-hook
9388 @findex article-decode-rfc1522
9389 @findex RFC1522 decoding
9390 Hook run in the buffer where the mail headers of each message is kept
9391 just before the splitting based on these headers is done.  The hook is
9392 free to modify the buffer contents in any way it sees fit---the buffer
9393 is discarded after the splitting has been done, and no changes performed
9394 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
9395 is one likely function to add to this hook.
9396
9397 @vindex nnmail-pre-get-new-mail-hook
9398 @vindex nnmail-post-get-new-mail-hook
9399 @item nnmail-pre-get-new-mail-hook
9400 @itemx nnmail-post-get-new-mail-hook
9401 These are two useful hooks executed when treating new incoming
9402 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9403 starting to handle the new mail) and
9404 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9405 is done).  Here's and example of using these two hooks to change the
9406 default file modes the new mail files get:
9407
9408 @lisp
9409 (add-hook 'gnus-pre-get-new-mail-hook 
9410           (lambda () (set-default-file-modes 511)))
9411
9412 (add-hook 'gnus-post-get-new-mail-hook 
9413           (lambda () (set-default-file-modes 551)))
9414 @end lisp
9415
9416 @item nnmail-tmp-directory
9417 @vindex nnmail-tmp-directory
9418 This variable says where to move incoming mail to -- while processing
9419 it.  This is usually done in the same directory that the mail backend
9420 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9421 it will be used instead.
9422
9423 @item nnmail-movemail-program
9424 @vindex nnmail-movemail-program
9425 This program is executed to move mail from the user's inbox to her home
9426 directory.  The default is @samp{movemail}.
9427
9428 This can also be a function.  In that case, the function will be called
9429 with two parameters -- the name of the inbox, and the file to be moved
9430 to.
9431
9432 @item nnmail-delete-incoming
9433 @vindex nnmail-delete-incoming
9434 @cindex incoming mail files
9435 @cindex deleting incoming files
9436 If non-@code{nil}, the mail backends will delete the temporary incoming
9437 file after splitting mail into the proper groups.  This is @code{t} by
9438 default.
9439
9440 @c This is @code{nil} by
9441 @c default for reasons of security.
9442
9443 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9444 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9445 lost mail, I think, but that's not the point.  (Except certain versions
9446 of Red Gnus.))  By not deleting the Incoming* files, one can be sure not
9447 to lose mail -- if Gnus totally whacks out, one can always recover what
9448 was lost.
9449
9450 You may delete the @file{Incoming*} files at will.
9451
9452 @item nnmail-use-long-file-names
9453 @vindex nnmail-use-long-file-names
9454 If non-@code{nil}, the mail backends will use long file and directory
9455 names.  Groups like @samp{mail.misc} will end up in directories
9456 (assuming use of @code{nnml} backend) or files (assuming use of
9457 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
9458 the same group will end up in @file{mail/misc}.
9459
9460 @item nnmail-delete-file-function
9461 @vindex nnmail-delete-file-function
9462 @findex delete-file
9463 Function called to delete files.  It is @code{delete-file} by default. 
9464
9465 @item nnmail-cache-accepted-message-ids
9466 @vindex nnmail-cache-accepted-message-ids
9467 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9468 the backend (via @code{Gcc}, for instance) into the mail duplication
9469 discovery cache.  The default is @code{nil}.
9470
9471 @end table
9472
9473
9474 @node Fancy Mail Splitting
9475 @subsection Fancy Mail Splitting
9476 @cindex mail splitting
9477 @cindex fancy mail splitting
9478
9479 @vindex nnmail-split-fancy
9480 @findex nnmail-split-fancy
9481 If the rather simple, standard method for specifying how to split mail
9482 doesn't allow you to do what you want, you can set
9483 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
9484 play with the @code{nnmail-split-fancy} variable.
9485
9486 Let's look at an example value of this variable first:
9487
9488 @lisp
9489 ;; Messages from the mailer daemon are not crossposted to any of
9490 ;; the ordinary groups.  Warnings are put in a separate group
9491 ;; from real errors.
9492 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9493                    "mail.misc"))
9494    ;; Non-error messages are crossposted to all relevant
9495    ;; groups, but we don't crosspost between the group for the
9496    ;; (ding) list and the group for other (ding) related mail.
9497    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9498          ("subject" "ding" "ding.misc"))
9499       ;; Other mailing lists...
9500       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9501       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9502       ;; People...
9503       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9504    ;; Unmatched mail goes to the catch all group.
9505    "misc.misc")
9506 @end lisp
9507
9508 This variable has the format of a @dfn{split}.  A split is a (possibly)
9509 recursive structure where each split may contain other splits.  Here are
9510 the five possible split syntaxes:
9511
9512 @enumerate
9513
9514 @item 
9515 @samp{group}: If the split is a string, that will be taken as a group name. 
9516
9517 @item
9518 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
9519 which is a string, then store the message as specified by SPLIT, if
9520 header FIELD (a regexp) contains VALUE (also a regexp).
9521
9522 @item
9523 @var{(| SPLIT...)}: If the split is a list, and the first element is
9524 @code{|} (vertical bar), then process each SPLIT until one of them
9525 matches.  A SPLIT is said to match if it will cause the mail message to
9526 be stored in one or more groups.
9527
9528 @item
9529 @var{(& SPLIT...)}: If the split is a list, and the first element is
9530 @code{&}, then process all SPLITs in the list.
9531
9532 @item 
9533 @code{junk}: If the split is the symbol @code{junk}, then don't save
9534 this message.
9535
9536 @item
9537 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
9538 element is @code{:}, then the second element will be called as a
9539 function with @var{args} given as arguments.  The function should return
9540 a SPLIT.
9541
9542 @end enumerate
9543
9544 In these splits, @var{FIELD} must match a complete field name.
9545 @var{VALUE} must match a complete word according to the fundamental mode
9546 syntax table.  You can use @code{.*} in the regexps to match partial
9547 field names or words.  In other words, all @var{VALUE}'s are wrapped in
9548 @samp{\<} and @samp{\>} pairs.
9549
9550 @vindex nnmail-split-abbrev-alist
9551 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9552 are expanded as specified by the variable
9553 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
9554 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
9555 value.
9556
9557 @vindex nnmail-split-fancy-syntax-table
9558 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9559 when all this splitting is performed.
9560
9561 If you want to have Gnus create groups dynamically based on some
9562 information in the headers (i.e., do @code{replace-match}-like
9563 substitions in the group names), you can say things like:
9564
9565 @example
9566 (any "debian-\\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
9567 @end example
9568
9569 @node Mail and Procmail
9570 @subsection Mail and Procmail
9571 @cindex procmail
9572
9573 @cindex slocal
9574 @cindex elm
9575 Many people use @code{procmail} (or some other mail filter program or
9576 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9577 incoming mail into groups.  If you do that, you should set
9578 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9579 backends never ever try to fetch mail by themselves.
9580
9581 If you have a combined @code{procmail}/POP/mailbox setup, you can do
9582 something like the following:
9583
9584 @vindex nnmail-use-procmail
9585 @lisp
9586 (setq nnmail-use-procmail t)
9587 (setq nnmail-spool-file
9588       '("/usr/spool/mail/my-name" "po:my-name"))
9589 @end lisp
9590
9591 This also means that you probably don't want to set
9592 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9593 side effects.
9594
9595 When a mail backend is queried for what groups it carries, it replies
9596 with the contents of that variable, along with any groups it has figured
9597 out that it carries by other means.  None of the backends, except
9598 @code{nnmh}, actually go out to the disk and check what groups actually
9599 exist.  (It's not trivial to distinguish between what the user thinks is
9600 a basis for a newsgroup and what is just a plain old file or directory.)
9601
9602 This means that you have to tell Gnus (and the backends) by hand what
9603 groups exist.
9604
9605 Let's take the @code{nnmh} backend as an example:
9606
9607 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9608 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9609
9610 Go to the group buffer and type @kbd{G m}.  When prompted, answer
9611 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
9612 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
9613 to include all your mail groups.
9614
9615 That's it.  You are now set to read your mail.  An active file for this
9616 method will be created automatically.
9617
9618 @vindex nnmail-procmail-suffix
9619 @vindex nnmail-procmail-directory
9620 If you use @code{nnfolder} or any other backend that store more than a
9621 single article in each file, you should never have procmail add mails to
9622 the file that Gnus sees.  Instead, procmail should put all incoming mail
9623 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9624 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9625 name.  The mail backends will read the mail from these files.
9626
9627 @vindex nnmail-resplit-incoming
9628 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9629 put in the @code{mail.misc}, as one would expect.  However, if you want
9630 Gnus to split the mail the normal way, you could set
9631 @code{nnmail-resplit-incoming} to @code{t}.
9632
9633 @vindex nnmail-keep-last-article
9634 If you use @code{procmail} to split things directly into an @code{nnmh}
9635 directory (which you shouldn't do), you should set
9636 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9637 ever expiring the final article (i.e., the article with the highest
9638 article number) in a mail newsgroup.  This is quite, quite important.
9639
9640 Here's an example setup:  The incoming spools are located in
9641 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9642 spool files have the same names as the equivalent groups).  The
9643 @code{nnfolder} backend is to be used as the mail interface, and the
9644 @code{nnfolder} directory is @file{~/fMail/}.
9645
9646 @lisp
9647 (setq nnfolder-directory "~/fMail/")
9648 (setq nnmail-spool-file 'procmail)
9649 (setq nnmail-procmail-directory "~/incoming/")
9650 (setq gnus-secondary-select-methods '((nnfolder "")))
9651 (setq nnmail-procmail-suffix "")
9652 @end lisp
9653
9654
9655 @node Incorporating Old Mail
9656 @subsection Incorporating Old Mail
9657
9658 Most people have lots of old mail stored in various file formats.  If
9659 you have set up Gnus to read mail using one of the spiffy Gnus mail
9660 backends, you'll probably wish to have that old mail incorporated into
9661 your mail groups.
9662
9663 Doing so can be quite easy.
9664
9665 To take an example: You're reading mail using @code{nnml}
9666 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9667 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9668 file filled with important, but old, mail.  You want to move it into
9669 your @code{nnml} groups.
9670
9671 Here's how:
9672
9673 @enumerate
9674 @item
9675 Go to the group buffer.
9676
9677 @item 
9678 Type `G f' and give the path to the mbox file when prompted to create an
9679 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9680
9681 @item 
9682 Type `SPACE' to enter the newly created group.
9683
9684 @item
9685 Type `M P b' to process-mark all articles in this group's buffer
9686 (@pxref{Setting Process Marks}).
9687
9688 @item 
9689 Type `B r' to respool all the process-marked articles, and answer
9690 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9691 @end enumerate
9692
9693 All the mail messages in the mbox file will now also be spread out over
9694 all your @code{nnml} groups.  Try entering them and check whether things
9695 have gone without a glitch.  If things look ok, you may consider
9696 deleting the mbox file, but I wouldn't do that unless I was absolutely
9697 sure that all the mail has ended up where it should be.
9698
9699 Respooling is also a handy thing to do if you're switching from one mail
9700 backend to another.  Just respool all the mail in the old mail groups
9701 using the new mail backend.
9702
9703
9704 @node Expiring Mail
9705 @subsection Expiring Mail
9706 @cindex article expiry
9707
9708 Traditional mail readers have a tendency to remove mail articles when
9709 you mark them as read, in some way.  Gnus takes a fundamentally
9710 different approach to mail reading.
9711
9712 Gnus basically considers mail just to be news that has been received in
9713 a rather peculiar manner.  It does not think that it has the power to
9714 actually change the mail, or delete any mail messages.  If you enter a
9715 mail group, and mark articles as ``read'', or kill them in some other
9716 fashion, the mail articles will still exist on the system.  I repeat:
9717 Gnus will not delete your old, read mail.  Unless you ask it to, of
9718 course.
9719
9720 To make Gnus get rid of your unwanted mail, you have to mark the
9721 articles as @dfn{expirable}.  This does not mean that the articles will
9722 disappear right away, however.  In general, a mail article will be
9723 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9724 more than one week old.  If you do not mark an article as expirable, it
9725 will remain on your system until hell freezes over.  This bears
9726 repeating one more time, with some spurious capitalizations: IF you do
9727 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9728
9729 @vindex gnus-auto-expirable-newsgroups
9730 You do not have to mark articles as expirable by hand.  Groups that
9731 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9732 have all articles that you read marked as expirable automatically.  All
9733 articles marked as expirable have an @samp{E} in the first
9734 column in the summary buffer.
9735
9736 By default, if you have auto expiry switched on, Gnus will mark all the
9737 articles you read as expirable, no matter if they were read or unread
9738 before.  To avoid having articles marked as read marked as expirable
9739 automatically, you can put something like the following in your
9740 @file{.gnus} file:
9741
9742 @vindex gnus-mark-article-hook
9743 @lisp
9744 (remove-hook 'gnus-mark-article-hook                                
9745              'gnus-summary-mark-read-and-unread-as-read)            
9746 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9747 @end lisp
9748
9749 Note that making a group auto-expirable doesn't mean that all read
9750 articles are expired---only the articles marked as expirable
9751 will be expired.  Also note that using the @kbd{d} command won't make
9752 groups expirable---only semi-automatic marking of articles as read will
9753 mark the articles as expirable in auto-expirable groups.
9754
9755 Let's say you subscribe to a couple of mailing lists, and you want the
9756 articles you have read to disappear after a while:
9757
9758 @lisp
9759 (setq gnus-auto-expirable-newsgroups 
9760       "mail.nonsense-list\\|mail.nice-list")
9761 @end lisp
9762
9763 Another way to have auto-expiry happen is to have the element
9764 @code{auto-expire} in the group parameters of the group. 
9765
9766 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9767 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9768 don't really mix very well.  
9769
9770 @vindex nnmail-expiry-wait
9771 The @code{nnmail-expiry-wait} variable supplies the default time an
9772 expirable article has to live.  Gnus starts counting days from when the
9773 message @emph{arrived}, not from when it was sent.  The default is seven
9774 days.
9775
9776 Gnus also supplies a function that lets you fine-tune how long articles
9777 are to live, based on what group they are in.  Let's say you want to
9778 have one month expiry period in the @samp{mail.private} group, a one day
9779 expiry period in the @samp{mail.junk} group, and a six day expiry period
9780 everywhere else:
9781
9782 @vindex nnmail-expiry-wait-function
9783 @lisp
9784 (setq nnmail-expiry-wait-function
9785       (lambda (group)
9786        (cond ((string= group "mail.private")
9787                31)
9788              ((string= group "mail.junk")
9789                1)
9790              ((string= group "important")
9791                'never)
9792              (t
9793                6))))
9794 @end lisp
9795
9796 The group names this function is fed are ``unadorned'' group
9797 names---no @samp{nnml:} prefixes and the like.
9798
9799 The @code{nnmail-expiry-wait} variable and
9800 @code{nnmail-expiry-wait-function} function can either be a number (not
9801 necessarily an integer) or one of the symbols @code{immediate} or
9802 @code{never}.
9803
9804 You can also use the @code{expiry-wait} group parameter to selectively
9805 change the expiry period (@pxref{Group Parameters}).
9806
9807 @vindex nnmail-keep-last-article
9808 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9809 expire the final article in a mail newsgroup.  This is to make life
9810 easier for procmail users.
9811
9812 @vindex gnus-total-expirable-newsgroups
9813 By the way: That line up there, about Gnus never expiring non-expirable
9814 articles, is a lie.  If you put @code{total-expire} in the group
9815 parameters, articles will not be marked as expirable, but all read
9816 articles will be put through the expiry process.  Use with extreme
9817 caution.  Even more dangerous is the
9818 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9819 this regexp will have all read articles put through the expiry process,
9820 which means that @emph{all} old mail articles in the groups in question
9821 will be deleted after a while.  Use with extreme caution, and don't come
9822 crying to me when you discover that the regexp you used matched the
9823 wrong group and all your important mail has disappeared.  Be a
9824 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9825 with!  So there!
9826
9827 Most people make most of their mail groups total-expirable, though. 
9828
9829
9830 @node Washing Mail
9831 @subsection Washing Mail
9832 @cindex mail washing
9833 @cindex list server brain damage
9834 @cindex incoming mail treatment
9835
9836 Mailers and list servers are notorious for doing all sorts of really,
9837 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9838 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9839 end of all lines passing through our server, so let's do that!!!!1!''
9840 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9841 considered to be self-evident were not discussed.  So.  Here we are.
9842
9843 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9844 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9845 be shocked and dismayed by this, but I haven't got the energy.  It is to
9846 laugh.
9847
9848 Gnus provides a plethora of functions for washing articles while
9849 displaying them, but it might be nicer to do the filtering before
9850 storing the mail to disc.  For that purpose, we have three hooks and
9851 various functions that can be put in these hooks.
9852
9853 @table @code
9854 @item nnmail-prepare-incoming-hook
9855 @vindex nnmail-prepare-incoming-hook
9856 This hook is called before doing anything with the mail and is meant for
9857 grand, sweeping gestures.  Functions to be used include:
9858
9859 @table @code
9860 @item nnheader-ms-strip-cr
9861 @findex nnheader-ms-strip-cr
9862 Remove trailing carriage returns from each line.  This is default on
9863 Emacs running on MS machines.
9864
9865 @end table
9866
9867 @item nnmail-prepare-incoming-header-hook
9868 @vindex nnmail-prepare-incoming-header-hook
9869 This hook is called narrowed to each header.  It can be used when
9870 cleaning up the headers.  Functions that can be used include:
9871
9872 @table @code
9873 @item nnmail-remove-leading-whitespace
9874 @findex nnmail-remove-leading-whitespace
9875 Clear leading white space that ``helpful'' listservs have added to the
9876 headers to make them look nice.  Aaah.  
9877
9878 @item nnmail-remove-list-identifiers
9879 @findex nnmail-remove-list-identifiers
9880 Some list servers add an identifier---for example, @samp{(idm)}---to the
9881 beginning of all @code{Subject} headers.  I'm sure that's nice for
9882 people who use stone age mail readers.  This function will remove
9883 strings that match the @code{nnmail-list-identifiers} regexp, which can
9884 also be a list of regexp.
9885
9886 For instance, if you want to remove the @samp{(idm)} and the
9887 @samp{nagnagnag} identifiers:
9888
9889 @lisp
9890 (setq nnmail-list-identifiers
9891       '("(idm)" "nagnagnag"))
9892 @end lisp
9893
9894 @item nnmail-remove-tabs
9895 @findex nnmail-remove-tabs
9896 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9897
9898 @end table
9899
9900 @item nnmail-prepare-incoming-message-hook
9901 @vindex nnmail-prepare-incoming-message-hook
9902 This hook is called narrowed to each message.  Functions to be used
9903 include: 
9904
9905 @table @code
9906 @item article-de-quoted-unreadable
9907 @findex article-de-quoted-unreadable
9908 Decode Quoted Readable encoding.
9909
9910 @end table
9911 @end table
9912
9913
9914 @node Duplicates
9915 @subsection Duplicates
9916
9917 @vindex nnmail-treat-duplicates
9918 @vindex nnmail-message-id-cache-length
9919 @vindex nnmail-message-id-cache-file
9920 @cindex duplicate mails
9921 If you are a member of a couple of mailing lists, you will sometimes
9922 receive two copies of the same mail.  This can be quite annoying, so
9923 @code{nnmail} checks for and treats any duplicates it might find.  To do
9924 this, it keeps a cache of old @code{Message-ID}s---
9925 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9926 default.  The approximate maximum number of @code{Message-ID}s stored
9927 there is controlled by the @code{nnmail-message-id-cache-length}
9928 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9929 stored.) If all this sounds scary to you, you can set
9930 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9931 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9932 will insert a warning into the head of the mail saying that it thinks
9933 that this is a duplicate of a different message.
9934
9935 This variable can also be a function.  If that's the case, the function
9936 will be called from a buffer narrowed to the message in question with
9937 the @code{Message-ID} as a parameter.  The function must return either
9938 @code{nil}, @code{warn}, or @code{delete}.
9939
9940 You can turn this feature off completely by setting the variable to
9941 @code{nil}.
9942
9943 If you want all the duplicate mails to be put into a special
9944 @dfn{duplicates} group, you could do that using the normal mail split
9945 methods:
9946
9947 @lisp
9948 (setq nnmail-split-fancy
9949       '(| ;; Messages duplicates go to a separate group.
9950           ("gnus-warning" "duplication of message" "duplicate")
9951           ;; Message from daemons, postmaster, and the like to another.
9952           (any mail "mail.misc")
9953           ;; Other rules.
9954           [ ... ] ))
9955 @end lisp
9956
9957 Or something like:
9958 @lisp
9959 (setq nnmail-split-methods 
9960       '(("duplicates" "^Gnus-Warning:")
9961         ;; Other rules.
9962         [...]))
9963 @end lisp
9964
9965 Here's a neat feature: If you know that the recipient reads her mail
9966 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9967 @code{delete}, you can send her as many insults as you like, just by
9968 using a @code{Message-ID} of a mail that you know that she's already
9969 received.  Think of all the fun!  She'll never see any of it!  Whee!
9970
9971
9972 @node Not Reading Mail
9973 @subsection Not Reading Mail
9974
9975 If you start using any of the mail backends, they have the annoying
9976 habit of assuming that you want to read mail with them.  This might not
9977 be unreasonable, but it might not be what you want.
9978
9979 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9980 will ever attempt to read incoming mail, which should help.
9981
9982 @vindex nnbabyl-get-new-mail
9983 @vindex nnmbox-get-new-mail
9984 @vindex nnml-get-new-mail
9985 @vindex nnmh-get-new-mail
9986 @vindex nnfolder-get-new-mail
9987 This might be too much, if, for instance, you are reading mail quite
9988 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9989 file you have stashed away with @code{nnbabyl}.  All backends have
9990 variables called backend-@code{get-new-mail}.  If you want to disable
9991 the @code{nnbabyl} mail reading, you edit the virtual server for the
9992 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9993
9994 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9995 narrowed to the article to be saved before saving it when reading
9996 incoming mail.
9997
9998
9999 @node Choosing a Mail Backend
10000 @subsection Choosing a Mail Backend
10001
10002 Gnus will read the mail spool when you activate a mail group.  The mail
10003 file is first copied to your home directory.  What happens after that
10004 depends on what format you want to store your mail in.
10005
10006 @menu
10007 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10008 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10009 * Mail Spool::                  Store your mail in a private spool?
10010 * MH Spool::                    An mhspool-like backend.
10011 * Mail Folders::                Having one file for each group.
10012 @end menu
10013
10014
10015 @node Unix Mail Box
10016 @subsubsection Unix Mail Box
10017 @cindex nnmbox
10018 @cindex unix mail box
10019
10020 @vindex nnmbox-active-file
10021 @vindex nnmbox-mbox-file
10022 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10023 mail.  @code{nnmbox} will add extra headers to each mail article to say
10024 which group it belongs in.
10025
10026 Virtual server settings:
10027
10028 @table @code
10029 @item nnmbox-mbox-file
10030 @vindex nnmbox-mbox-file
10031 The name of the mail box in the user's home directory. 
10032
10033 @item nnmbox-active-file
10034 @vindex nnmbox-active-file
10035 The name of the active file for the mail box.
10036
10037 @item nnmbox-get-new-mail
10038 @vindex nnmbox-get-new-mail
10039 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10040 into groups.
10041 @end table
10042
10043
10044 @node Rmail Babyl
10045 @subsubsection Rmail Babyl
10046 @cindex nnbabyl
10047 @cindex rmail mbox
10048
10049 @vindex nnbabyl-active-file
10050 @vindex nnbabyl-mbox-file
10051 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10052 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10053 article to say which group it belongs in.
10054
10055 Virtual server settings:
10056
10057 @table @code
10058 @item nnbabyl-mbox-file
10059 @vindex nnbabyl-mbox-file
10060 The name of the rmail mbox file.
10061
10062 @item nnbabyl-active-file
10063 @vindex nnbabyl-active-file
10064 The name of the active file for the rmail box.
10065
10066 @item nnbabyl-get-new-mail
10067 @vindex nnbabyl-get-new-mail
10068 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
10069 @end table
10070
10071
10072 @node Mail Spool
10073 @subsubsection Mail Spool
10074 @cindex nnml
10075 @cindex mail @sc{nov} spool
10076
10077 The @dfn{nnml} spool mail format isn't compatible with any other known
10078 format.  It should be used with some caution.
10079
10080 @vindex nnml-directory
10081 If you use this backend, Gnus will split all incoming mail into files,
10082 one file for each mail, and put the articles into the corresponding
10083 directories under the directory specified by the @code{nnml-directory}
10084 variable.  The default value is @file{~/Mail/}.
10085
10086 You do not have to create any directories beforehand; Gnus will take
10087 care of all that.
10088
10089 If you have a strict limit as to how many files you are allowed to store
10090 in your account, you should not use this backend.  As each mail gets its
10091 own file, you might very well occupy thousands of inodes within a few
10092 weeks.  If this is no problem for you, and it isn't a problem for you
10093 having your friendly systems administrator walking around, madly,
10094 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10095 know that this is probably the fastest format to use.  You do not have
10096 to trudge through a big mbox file just to read your new mail.
10097
10098 @code{nnml} is probably the slowest backend when it comes to article
10099 splitting.  It has to create lots of files, and it also generates
10100 @sc{nov} databases for the incoming mails.  This makes it the fastest
10101 backend when it comes to reading mail.
10102
10103 Virtual server settings:
10104
10105 @table @code
10106 @item nnml-directory
10107 @vindex nnml-directory
10108 All @code{nnml} directories will be placed under this directory. 
10109
10110 @item nnml-active-file
10111 @vindex nnml-active-file
10112 The active file for the @code{nnml} server.
10113
10114 @item nnml-newsgroups-file
10115 @vindex nnml-newsgroups-file
10116 The @code{nnml} group descriptions file.  @xref{Newsgroups File
10117 Format}. 
10118
10119 @item nnml-get-new-mail
10120 @vindex nnml-get-new-mail
10121 If non-@code{nil}, @code{nnml} will read incoming mail.
10122
10123 @item nnml-nov-is-evil
10124 @vindex nnml-nov-is-evil
10125 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
10126
10127 @item nnml-nov-file-name
10128 @vindex nnml-nov-file-name
10129 The name of the @sc{nov} files.  The default is @file{.overview}. 
10130
10131 @item nnml-prepare-save-mail-hook
10132 @vindex nnml-prepare-save-mail-hook
10133 Hook run narrowed to an article before saving.
10134
10135 @end table
10136
10137 @findex nnml-generate-nov-databases
10138 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10139 you can do a complete update by typing @kbd{M-x
10140 nnml-generate-nov-databases}.  This command will trawl through the
10141 entire @code{nnml} hierarchy, looking at each and every article, so it
10142 might take a while to complete.  A better interface to this
10143 functionality can be found in the server buffer (@pxref{Server
10144 Commands}). 
10145
10146
10147 @node MH Spool
10148 @subsubsection MH Spool
10149 @cindex nnmh
10150 @cindex mh-e mail spool
10151
10152 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10153 @sc{nov} databases and it doesn't keep an active file.  This makes
10154 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10155 makes it easier to write procmail scripts for.
10156
10157 Virtual server settings:
10158
10159 @table @code
10160 @item nnmh-directory
10161 @vindex nnmh-directory
10162 All @code{nnmh} directories will be located under this directory.
10163
10164 @item nnmh-get-new-mail
10165 @vindex nnmh-get-new-mail
10166 If non-@code{nil}, @code{nnmh} will read incoming mail.
10167
10168 @item nnmh-be-safe
10169 @vindex nnmh-be-safe
10170 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10171 sure that the articles in the folder are actually what Gnus thinks they
10172 are.  It will check date stamps and stat everything in sight, so
10173 setting this to @code{t} will mean a serious slow-down.  If you never
10174 use anything but Gnus to read the @code{nnmh} articles, you do not have
10175 to set this variable to @code{t}.
10176 @end table
10177
10178
10179 @node Mail Folders
10180 @subsubsection Mail Folders
10181 @cindex nnfolder
10182 @cindex mbox folders
10183 @cindex mail folders
10184
10185 @code{nnfolder} is a backend for storing each mail group in a separate
10186 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
10187 will add extra headers to keep track of article numbers and arrival
10188 dates.
10189
10190 Virtual server settings:
10191
10192 @table @code
10193 @item nnfolder-directory
10194 @vindex nnfolder-directory
10195 All the @code{nnfolder} mail boxes will be stored under this directory. 
10196
10197 @item nnfolder-active-file
10198 @vindex nnfolder-active-file
10199 The name of the active file.
10200
10201 @item nnfolder-newsgroups-file
10202 @vindex nnfolder-newsgroups-file
10203 The name of the group descriptions file.  @xref{Newsgroups File Format}.
10204
10205 @item nnfolder-get-new-mail
10206 @vindex nnfolder-get-new-mail
10207 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10208 @end table
10209
10210 @findex nnfolder-generate-active-file
10211 @kindex M-x nnfolder-generate-active-file
10212 If you have lots of @code{nnfolder}-like files you'd like to read with
10213 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10214 command to make @code{nnfolder} aware of all likely files in
10215 @code{nnfolder-directory}.
10216
10217
10218 @node Other Sources
10219 @section Other Sources
10220
10221 Gnus can do more than just read news or mail.  The methods described
10222 below allow Gnus to view directories and files as if they were
10223 newsgroups.
10224
10225 @menu
10226 * Directory Groups::      You can read a directory as if it was a newsgroup.
10227 * Anything Groups::       Dired?  Who needs dired?
10228 * Document Groups::       Single files can be the basis of a group.
10229 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
10230 * Web Searches::          Creating groups from articles that match a string.
10231 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10232 @end menu
10233
10234
10235 @node Directory Groups
10236 @subsection Directory Groups
10237 @cindex nndir
10238 @cindex directory groups
10239
10240 If you have a directory that has lots of articles in separate files in
10241 it, you might treat it as a newsgroup.  The files have to have numerical
10242 names, of course.
10243
10244 This might be an opportune moment to mention @code{ange-ftp} (and its
10245 successor @code{efs}), that most wonderful of all wonderful Emacs
10246 packages.  When I wrote @code{nndir}, I didn't think much about it---a
10247 backend to read directories.  Big deal.
10248
10249 @code{ange-ftp} changes that picture dramatically.  For instance, if you
10250 enter the @code{ange-ftp} file name
10251 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10252 @code{ange-ftp} or @code{efs} will actually allow you to read this
10253 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
10254
10255 @code{nndir} will use @sc{nov} files if they are present.
10256
10257 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10258 articles with this method.  You can use @code{nnmh} or @code{nnml} for
10259 whatever you use @code{nndir} for, so you could switch to any of those
10260 methods if you feel the need to have a non-read-only @code{nndir}.
10261
10262
10263 @node Anything Groups
10264 @subsection Anything Groups
10265 @cindex nneething
10266
10267 From the @code{nndir} backend (which reads a single spool-like
10268 directory), it's just a hop and a skip to @code{nneething}, which
10269 pretends that any arbitrary directory is a newsgroup.  Strange, but
10270 true.
10271
10272 When @code{nneething} is presented with a directory, it will scan this
10273 directory and assign article numbers to each file.  When you enter such
10274 a group, @code{nneething} must create ``headers'' that Gnus can use.
10275 After all, Gnus is a newsreader, in case you're
10276 forgetting. @code{nneething} does this in a two-step process.  First, it
10277 snoops each file in question.  If the file looks like an article (i.e.,
10278 the first few lines look like headers), it will use this as the head.
10279 If this is just some arbitrary file without a head (e.g. a C source
10280 file), @code{nneething} will cobble up a header out of thin air.  It
10281 will use file ownership, name and date and do whatever it can with these
10282 elements.
10283
10284 All this should happen automatically for you, and you will be presented
10285 with something that looks very much like a newsgroup.  Totally like a
10286 newsgroup, to be precise.  If you select an article, it will be displayed
10287 in the article buffer, just as usual.
10288
10289 If you select a line that represents a directory, Gnus will pop you into
10290 a new summary buffer for this @code{nneething} group.  And so on.  You can
10291 traverse the entire disk this way, if you feel like, but remember that
10292 Gnus is not dired, really, and does not intend to be, either.
10293
10294 There are two overall modes to this action---ephemeral or solid.  When
10295 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10296 will not store information on what files you have read, and what files
10297 are new, and so on.  If you create a solid @code{nneething} group the
10298 normal way with @kbd{G m}, Gnus will store a mapping table between
10299 article numbers and file names, and you can treat this group like any
10300 other groups.  When you activate a solid @code{nneething} group, you will
10301 be told how many unread articles it contains, etc., etc.
10302
10303 Some variables:
10304
10305 @table @code
10306 @item nneething-map-file-directory
10307 @vindex nneething-map-file-directory
10308 All the mapping files for solid @code{nneething} groups will be stored
10309 in this directory, which defaults to @file{~/.nneething/}.
10310
10311 @item nneething-exclude-files
10312 @vindex nneething-exclude-files
10313 All files that match this regexp will be ignored.  Nice to use to exclude
10314 auto-save files and the like, which is what it does by default.
10315
10316 @item nneething-map-file
10317 @vindex nneething-map-file
10318 Name of the map files.
10319 @end table
10320
10321
10322 @node Document Groups
10323 @subsection Document Groups
10324 @cindex nndoc
10325 @cindex documentation group
10326 @cindex help group
10327
10328 @code{nndoc} is a cute little thing that will let you read a single file
10329 as a newsgroup.  Several files types are supported:
10330
10331 @table @code
10332 @cindex babyl
10333 @cindex rmail mbox
10334
10335 @item babyl
10336 The babyl (rmail) mail box.
10337 @cindex mbox
10338 @cindex Unix mbox
10339
10340 @item mbox
10341 The standard Unix mbox file.
10342
10343 @cindex MMDF mail box
10344 @item mmdf
10345 The MMDF mail box format.
10346
10347 @item news
10348 Several news articles appended into a file.
10349
10350 @item rnews
10351 @cindex rnews batch files
10352 The rnews batch transport format.
10353 @cindex forwarded messages
10354
10355 @item forward
10356 Forwarded articles.
10357
10358 @item mime-digest
10359 @cindex digest
10360 @cindex MIME digest
10361 @cindex 1153 digest
10362 @cindex RFC 1153 digest
10363 @cindex RFC 341 digest
10364 MIME (RFC 1341) digest format.
10365
10366 @item standard-digest
10367 The standard (RFC 1153) digest format.
10368
10369 @item slack-digest
10370 Non-standard digest format---matches most things, but does it badly. 
10371 @end table
10372
10373 You can also use the special ``file type'' @code{guess}, which means
10374 that @code{nndoc} will try to guess what file type it is looking at.
10375 @code{digest} means that @code{nndoc} should guess what digest type the
10376 file is.
10377
10378 @code{nndoc} will not try to change the file or insert any extra headers into
10379 it---it will simply, like, let you use the file as the basis for a
10380 group.  And that's it.
10381
10382 If you have some old archived articles that you want to insert into your
10383 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10384 that.  Say you have an old @file{RMAIL} file with mail that you now want
10385 to split into your new @code{nnml} groups.  You look at that file using
10386 @code{nndoc} (using the @kbd{G f} command in the group buffer
10387 (@pxref{Foreign Groups})), set the process mark on all the articles in
10388 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10389 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
10390 file is now also stored in lots of @code{nnml} directories, and you can
10391 delete that pesky @file{RMAIL} file.  If you have the guts!
10392
10393 Virtual server variables:
10394
10395 @table @code
10396 @item nndoc-article-type
10397 @vindex nndoc-article-type
10398 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10399 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10400 @code{rfc822-forward}, @code{mime-digest}, @code{standard-digest},
10401 @code{slack-digest}, @code{clari-briefs} or @code{guess}.
10402
10403 @item nndoc-post-type
10404 @vindex nndoc-post-type
10405 This variable says whether Gnus is to consider the group a news group or
10406 a mail group.  There are two valid values:  @code{mail} (the default)
10407 and @code{news}.
10408 @end table
10409
10410 @menu
10411 * Document Server Internals::   How to add your own document types.
10412 @end menu
10413
10414
10415 @node Document Server Internals
10416 @subsubsection Document Server Internals
10417
10418 Adding new document types to be recognized by @code{nndoc} isn't
10419 difficult.  You just have to whip up a definition of what the document
10420 looks like, write a predicate function to recognize that document type,
10421 and then hook into @code{nndoc}.
10422
10423 First, here's an example document type definition:
10424
10425 @example
10426 (mmdf 
10427  (article-begin .  "^\^A\^A\^A\^A\n")
10428  (body-end .  "^\^A\^A\^A\^A\n"))
10429 @end example
10430
10431 The definition is simply a unique @dfn{name} followed by a series of
10432 regexp pseudo-variable settings.  Below are the possible
10433 variables---don't be daunted by the number of variables; most document
10434 types can be defined with very few settings:
10435
10436 @table @code
10437 @item first-article
10438 If present, @code{nndoc} will skip past all text until it finds
10439 something that match this regexp.  All text before this will be
10440 totally ignored. 
10441
10442 @item article-begin
10443 This setting has to be present in all document type definitions.  It
10444 says what the beginning of each article looks like.
10445
10446 @item head-begin-function
10447 If present, this should be a function that moves point to the head of
10448 the article.
10449
10450 @item nndoc-head-begin
10451 If present, this should be a regexp that matches the head of the
10452 article. 
10453
10454 @item nndoc-head-end
10455 This should match the end of the head of the article.  It defaults to
10456 @samp{^$}---the empty line.
10457
10458 @item body-begin-function
10459 If present, this function should move point to the beginning of the body
10460 of the article.
10461
10462 @item body-begin
10463 This should match the beginning of the body of the article.  It defaults
10464 to @samp{^\n}.
10465
10466 @item body-end-function
10467 If present, this function should move point to the end of the body of
10468 the article.
10469
10470 @item body-end
10471 If present, this should match the end of the body of the article.
10472
10473 @item file-end
10474 If present, this should match the end of the file.  All text after this
10475 regexp will be totally ignored. 
10476
10477 @end table
10478
10479 So, using these variables @code{nndoc} is able to dissect a document
10480 file into a series of articles, each with a head and a body.  However, a
10481 few more variables are needed since not all document types are all that
10482 news-like---variables needed to transform the head or the body into
10483 something that's palatable for Gnus:
10484
10485 @table @code
10486 @item prepare-body-function
10487 If present, this function will be called when requesting an article.  It
10488 will be called with point at the start of the body, and is useful if the
10489 document has encoded some parts of its contents. 
10490
10491 @item article-transform-function
10492 If present, this function is called when requesting an article.  It's
10493 meant to be used for more wide-ranging transformation of both head and
10494 body of the article.
10495
10496 @item generate-head-function
10497 If present, this function is called to generate a head that Gnus can
10498 understand.  It is called with the article number as a parameter, and is
10499 expected to generate a nice head for the article in question.  It is
10500 called when requesting the headers of all articles.
10501
10502 @end table
10503
10504 Let's look at the most complicated example I can come up with---standard
10505 digests:
10506
10507 @example
10508 (standard-digest
10509  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10510  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10511  (prepare-body-function . nndoc-unquote-dashes)
10512  (body-end-function . nndoc-digest-body-end)
10513  (head-end . "^ ?$")
10514  (body-begin . "^ ?\n")
10515  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10516  (subtype digest guess))
10517 @end example
10518
10519 We see that all text before a 70-width line of dashes is ignored; all
10520 text after a line that starts with that @samp{^End of} is also ignored;
10521 each article begins with a 30-width line of dashes; the line separating
10522 the head from the body may contain a single space; and that the body is
10523 run through @code{nndoc-unquote-dashes} before being delivered.
10524
10525 To hook your own document definition into @code{nndoc}, use the
10526 @code{nndoc-add-type} function.  It takes two parameters---the first is
10527 the definition itself and the second (optional) parameter says where in
10528 the document type definition alist to put this definition.  The alist is
10529 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
10530 is of @code{mmdf} type, and so on.  These type predicates should return
10531 @code{nil} if the document is not of the correct type; @code{t} if it is
10532 of the correct type; and a number if the document might be of the
10533 correct type.  A high number means high probability; a low number means
10534 low probability with @samp{0} being the lowest valid number.
10535
10536
10537 @node SOUP
10538 @subsection SOUP
10539 @cindex SOUP
10540 @cindex offline
10541
10542 In the PC world people often talk about ``offline'' newsreaders.  These
10543 are thingies that are combined reader/news transport monstrosities.
10544 With built-in modem programs.  Yecchh!
10545
10546 Of course, us Unix Weenie types of human beans use things like
10547 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10548 transport things like Ghod intended.  And then we just use normal
10549 newsreaders.  
10550
10551 However, it can sometimes be convenient to do something a that's a bit
10552 easier on the brain if you have a very slow modem, and you're not really
10553 that interested in doing things properly.  
10554
10555 A file format called @sc{soup} has been developed for transporting news
10556 and mail from servers to home machines and back again.  It can be a bit
10557 fiddly.
10558
10559 First some terminology:
10560
10561 @table @dfn
10562
10563 @item server
10564 This is the machine that is connected to the outside world and where you
10565 get news and/or mail from.
10566
10567 @item home machine
10568 This is the machine that you want to do the actual reading and responding
10569 on.  It is typically not connected to the rest of the world in any way.
10570
10571 @item packet
10572 Something that contains messages and/or commands.  There are two kinds
10573 of packets:
10574
10575 @table @dfn
10576 @item message packets
10577 These are packets made at the server, and typically contain lots of
10578 messages for you to read.  These are called @file{SoupoutX.tgz} by
10579 default, where @var{X} is a number.
10580
10581 @item response packets
10582 These are packets made at the home machine, and typically contains
10583 replies that you've written.  These are called @file{SoupinX.tgz} by
10584 default, where @var{X} is a number.
10585
10586 @end table
10587
10588 @end table
10589
10590
10591 @enumerate
10592
10593 @item
10594 You log in on the server and create a @sc{soup} packet.  You can either
10595 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10596 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10597 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10598
10599 @item 
10600 You transfer the packet home.  Rail, boat, car or modem will do fine.
10601
10602 @item
10603 You put the packet in your home directory.
10604
10605 @item
10606 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10607 the native or secondary server.
10608
10609 @item
10610 You read articles and mail and answer and followup to the things you
10611 want (@pxref{SOUP Replies}).
10612
10613 @item 
10614 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10615 packet.
10616
10617 @item 
10618 You transfer this packet to the server.  
10619
10620 @item
10621 You use Gnus to mail this packet out with the @kbd{G s s} command.
10622
10623 @item
10624 You then repeat until you die.
10625
10626 @end enumerate
10627
10628 So you basically have a bipartite system---you use @code{nnsoup} for
10629 reading and Gnus for packing/sending these @sc{soup} packets.
10630
10631 @menu
10632 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10633 * SOUP Groups::       A backend for reading @sc{soup} packets.
10634 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10635 @end menu
10636
10637
10638 @node SOUP Commands
10639 @subsubsection SOUP Commands
10640
10641 These are commands for creating and manipulating @sc{soup} packets.
10642
10643 @table @kbd
10644 @item G s b
10645 @kindex G s b (Group)
10646 @findex gnus-group-brew-soup
10647 Pack all unread articles in the current group
10648 (@code{gnus-group-brew-soup}).  This command understands the
10649 process/prefix convention.
10650
10651 @item G s w
10652 @kindex G s w (Group)
10653 @findex gnus-soup-save-areas
10654 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10655
10656 @item G s s
10657 @kindex G s s (Group)
10658 @findex gnus-soup-send-replies
10659 Send all replies from the replies packet
10660 (@code{gnus-soup-send-replies}). 
10661
10662 @item G s p
10663 @kindex G s p (Group)
10664 @findex gnus-soup-pack-packet
10665 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
10666
10667 @item G s r
10668 @kindex G s r (Group)
10669 @findex nnsoup-pack-replies
10670 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
10671
10672 @item O s
10673 @kindex O s (Summary)
10674 @findex gnus-soup-add-article
10675 This summary-mode command adds the current article to a @sc{soup} packet
10676 (@code{gnus-soup-add-article}).  It understands the process/prefix
10677 convention (@pxref{Process/Prefix}). 
10678
10679 @end table
10680
10681
10682 There are a few variables to customize where Gnus will put all these
10683 thingies:  
10684
10685 @table @code
10686
10687 @item gnus-soup-directory
10688 @vindex gnus-soup-directory
10689 Directory where Gnus will save intermediate files while composing
10690 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
10691
10692 @item gnus-soup-replies-directory
10693 @vindex gnus-soup-replies-directory
10694 This is what Gnus will use as a temporary directory while sending our
10695 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10696
10697 @item gnus-soup-prefix-file
10698 @vindex gnus-soup-prefix-file
10699 Name of the file where Gnus stores the last used prefix.  The default is
10700 @samp{gnus-prefix}. 
10701
10702 @item gnus-soup-packer
10703 @vindex gnus-soup-packer
10704 A format string command for packing a @sc{soup} packet.  The default is
10705 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
10706
10707 @item gnus-soup-unpacker
10708 @vindex gnus-soup-unpacker
10709 Format string command for unpacking a @sc{soup} packet.  The default is
10710 @samp{gunzip -c %s | tar xvf -}.
10711
10712 @item gnus-soup-packet-directory
10713 @vindex gnus-soup-packet-directory
10714 Where Gnus will look for reply packets.  The default is @file{~/}. 
10715
10716 @item gnus-soup-packet-regexp
10717 @vindex gnus-soup-packet-regexp
10718 Regular expression matching @sc{soup} reply packets in
10719 @code{gnus-soup-packet-directory}. 
10720
10721 @end table
10722  
10723
10724 @node SOUP Groups
10725 @subsubsection @sc{soup} Groups
10726 @cindex nnsoup
10727
10728 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10729 read incoming packets, unpack them, and put them in a directory where
10730 you can read them at leisure.
10731
10732 These are the variables you can use to customize its behavior:
10733
10734 @table @code
10735
10736 @item nnsoup-tmp-directory
10737 @vindex nnsoup-tmp-directory
10738 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10739 directory.  (@file{/tmp/} by default.)  
10740
10741 @item nnsoup-directory
10742 @vindex nnsoup-directory
10743 @code{nnsoup} then moves each message and index file to this directory.
10744 The default is @file{~/SOUP/}.
10745
10746 @item nnsoup-replies-directory 
10747 @vindex nnsoup-replies-directory 
10748 All replies will be stored in this directory before being packed into a
10749 reply packet.  The default is @file{~/SOUP/replies/"}.
10750
10751 @item nnsoup-replies-format-type
10752 @vindex nnsoup-replies-format-type
10753 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10754 (rnews), and I don't think you should touch that variable.  I probably
10755 shouldn't even have documented it.  Drats!  Too late!
10756
10757 @item nnsoup-replies-index-type
10758 @vindex nnsoup-replies-index-type
10759 The index type of the replies packet.  The default is @samp{?n}, which
10760 means ``none''.  Don't fiddle with this one either!
10761
10762 @item nnsoup-active-file
10763 @vindex nnsoup-active-file
10764 Where @code{nnsoup} stores lots of information.  This is not an ``active
10765 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10766 this file or mess it up in any way, you're dead.  The default is
10767 @file{~/SOUP/active}.
10768
10769 @item nnsoup-packer
10770 @vindex nnsoup-packer
10771 Format string command for packing a reply @sc{soup} packet.  The default
10772 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
10773
10774 @item nnsoup-unpacker
10775 @vindex nnsoup-unpacker
10776 Format string command for unpacking incoming @sc{soup} packets.  The
10777 default is @samp{gunzip -c %s | tar xvf -}. 
10778
10779 @item nnsoup-packet-directory
10780 @vindex nnsoup-packet-directory
10781 Where @code{nnsoup} will look for incoming packets.  The default is
10782 @file{~/}.  
10783
10784 @item nnsoup-packet-regexp
10785 @vindex nnsoup-packet-regexp
10786 Regular expression matching incoming @sc{soup} packets.  The default is
10787 @samp{Soupout}.
10788
10789 @item nnsoup-always-save
10790 @vindex nnsoup-always-save
10791 If non-@code{nil}, save the replies buffer after each posted message.
10792
10793 @end table
10794
10795
10796 @node SOUP Replies
10797 @subsubsection SOUP Replies
10798
10799 Just using @code{nnsoup} won't mean that your postings and mailings end
10800 up in @sc{soup} reply packets automagically.  You have to work a bit
10801 more for that to happen.
10802
10803 @findex nnsoup-set-variables
10804 The @code{nnsoup-set-variables} command will set the appropriate
10805 variables to ensure that all your followups and replies end up in the
10806 @sc{soup} system.
10807
10808 In specific, this is what it does:
10809
10810 @lisp
10811 (setq message-send-news-function 'nnsoup-request-post)
10812 (setq message-send-mail-function 'nnsoup-request-mail)
10813 @end lisp
10814
10815 And that's it, really.  If you only want news to go into the @sc{soup}
10816 system you just use the first line.  If you only want mail to be
10817 @sc{soup}ed you use the second.
10818
10819
10820 @node Web Searches
10821 @subsection Web Searches
10822 @cindex nnweb
10823 @cindex DejaNews
10824 @cindex Alta Vista
10825 @cindex InReference
10826 @cindex Usenet searches
10827 @cindex searching the Usenet
10828
10829 It's, like, too neat to search the Usenet for articles that match a
10830 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10831 those, like, Web browsers, and you, like, have to, rilly, like, look at
10832 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10833 searches without having to use a browser.
10834
10835 The @code{nnweb} backend allows an easy interface to the mighty search
10836 engine.  You create an @code{nnweb} group, enter a search pattern, and
10837 then enter the group and read the articles like you would any normal
10838 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10839 Groups}) will do this in an easy-to-use fashion.
10840
10841 @code{nnweb} groups don't really lend themselves to being solid
10842 groups---they have a very fleeting idea of article numbers.  In fact,
10843 each time you enter an @code{nnweb} group (not even changing the search
10844 pattern), you are likely to get the articles ordered in a different
10845 manner.  Not even using duplicate suppression (@pxref{Duplicate
10846 Suppression}) will help, since @code{nnweb} doesn't even know the
10847 @code{Message-ID} of the articles before reading them using some search
10848 engines (DejaNews, for instance).  The only possible way to keep track
10849 of which articles you've read is by scoring on the @code{Date}
10850 header---mark all articles posted before the last date you read the
10851 group as read.
10852
10853 If the search engine changes its output substantially, @code{nnweb}
10854 won't be able to parse it and will fail.  One could hardly fault the Web
10855 providers if they were to do this---their @emph{raison d'être} is to
10856 make money off of advertisements, not to provide services to the
10857 community.  Since @code{nnweb} washes the ads off all the articles, one
10858 might think that the providers might be somewhat miffed.  We'll see.
10859
10860 You must have the @code{url} and @code{w3} package installed to be able
10861 to use @code{nnweb}.
10862
10863 Virtual server variables:
10864
10865 @table @code
10866 @item nnweb-type
10867 @vindex nnweb-type
10868 What search engine type is being used.  The currently supported types
10869 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
10870 @code{reference}.
10871
10872 @item nnweb-search
10873 @vindex nnweb-search
10874 The search string to feed to the search engine.
10875
10876 @item nnweb-max-hits
10877 @vindex nnweb-max-hits
10878 Advisory maximum number of hits per search to display.  The default is
10879 100.
10880
10881 @item nnweb-type-definition
10882 @vindex nnweb-type-definition
10883 Type-to-definition alist.  This alist says what @code{nnweb} should do
10884 with the various search engine types.  The following elements must be
10885 present: 
10886
10887 @table @code
10888 @item article
10889 Function to decode the article and provide something that Gnus
10890 understands. 
10891
10892 @item map
10893 Function to create an article number to message header and URL alist. 
10894
10895 @item search
10896 Function to send the search string to the search engine.
10897
10898 @item address
10899 The address the aforementioned function should send the search string
10900 to. 
10901
10902 @item id
10903 Format string URL to fetch an article by @code{Message-ID}.
10904 @end table
10905
10906 @end table
10907
10908
10909
10910 @node Mail-To-News Gateways
10911 @subsection Mail-To-News Gateways
10912 @cindex mail-to-news gateways
10913 @cindex gateways
10914
10915 If your local @code{nntp} server doesn't allow posting, for some reason
10916 or other, you can post using one of the numerous mail-to-news gateways.
10917 The @code{nngateway} backend provides the interface.
10918
10919 Note that you can't read anything from this backend---it can only be
10920 used to post with.
10921
10922 Server variables:
10923
10924 @table @code
10925 @item nngateway-address 
10926 @vindex nngateway-address 
10927 This is the address of the mail-to-news gateway.
10928
10929 @item nngateway-header-transformation
10930 @vindex nngateway-header-transformation
10931 News headers often have to be transformed in some odd way or other
10932 for the mail-to-news gateway to accept it.  This variable says what 
10933 transformation should be called, and defaults to
10934 @code{nngateway-simple-header-transformation}.  The function is called
10935 narrowed to the headers to be transformed and with one parameter---the
10936 gateway address.
10937
10938 This default function just inserts a new @code{To} header based on the
10939 @code{Newsgroups} header and the gateway address.
10940 For instance, an article with this @code{Newsgroups} header:
10941
10942 @example
10943 Newsgroups: alt.religion.emacs
10944 @end example
10945
10946 will get this @code{From} header inserted:
10947
10948 @example
10949 To: alt-religion-emacs@@GATEWAY
10950 @end example
10951
10952 @end table
10953
10954 So, to use this, simply say something like:
10955
10956 @lisp
10957 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10958 @end lisp
10959
10960
10961 @node Combined Groups
10962 @section Combined Groups
10963
10964 Gnus allows combining a mixture of all the other group types into bigger
10965 groups.
10966
10967 @menu
10968 * Virtual Groups::     Combining articles from many groups.
10969 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10970 @end menu
10971
10972
10973 @node Virtual Groups
10974 @subsection Virtual Groups
10975 @cindex nnvirtual
10976 @cindex virtual groups
10977
10978 An @dfn{nnvirtual group} is really nothing more than a collection of
10979 other groups.
10980
10981 For instance, if you are tired of reading many small groups, you can
10982 put them all in one big group, and then grow tired of reading one
10983 big, unwieldy group.  The joys of computing!
10984
10985 You specify @code{nnvirtual} as the method.  The address should be a
10986 regexp to match component groups.
10987
10988 All marks in the virtual group will stick to the articles in the
10989 component groups.  So if you tick an article in a virtual group, the
10990 article will also be ticked in the component group from whence it came.
10991 (And vice versa---marks from the component groups will also be shown in
10992 the virtual group.)
10993
10994 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10995 newsgroups into one, big, happy newsgroup:
10996
10997 @lisp
10998 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10999 @end lisp
11000
11001 The component groups can be native or foreign; everything should work
11002 smoothly, but if your computer explodes, it was probably my fault.
11003
11004 Collecting the same group from several servers might actually be a good
11005 idea if users have set the Distribution header to limit distribution.
11006 If you would like to read @samp{soc.motss} both from a server in Japan
11007 and a server in Norway, you could use the following as the group regexp:
11008
11009 @example
11010 "^nntp\\+some\\.server\\.jp:soc\\.motss$\\|^nntp\\+some\\.server\\.no:soc\\.motss$"
11011 @end example
11012
11013 (Remember, though, that if you're creating the group with @kbd{G m}, you
11014 shouldn't double the backslashes, and you should leave off the quote
11015 characters at the beginning and the end of the string.)
11016
11017 This should work kinda smoothly---all articles from both groups should
11018 end up in this one, and there should be no duplicates.  Threading (and
11019 the rest) will still work as usual, but there might be problems with the
11020 sequence of articles.  Sorting on date might be an option here
11021 (@pxref{Selecting a Group}).
11022
11023 One limitation, however---all groups included in a virtual
11024 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
11025 zombie groups can't be component groups for @code{nnvirtual} groups.
11026
11027 @vindex nnvirtual-always-rescan
11028 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11029 @code{nnvirtual} will always scan groups for unread articles when
11030 entering a virtual group.  If this variable is @code{nil} (which is the
11031 default) and you read articles in a component group after the virtual
11032 group has been activated, the read articles from the component group
11033 will show up when you enter the virtual group.  You'll also see this
11034 effect if you have two virtual groups that have a component group in
11035 common.  If that's the case, you should set this variable to @code{t}.
11036 Or you can just tap @code{M-g} on the virtual group every time before
11037 you enter it---it'll have much the same effect.
11038
11039
11040 @node Kibozed Groups
11041 @subsection Kibozed Groups
11042 @cindex nnkiboze
11043 @cindex kibozing
11044
11045 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11046 the news feed''.  @code{nnkiboze} is a backend that will do this for
11047 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
11048 with useless requests!  Oh happiness!
11049
11050 @kindex G k (Group)
11051 To create a kibozed group, use the @kbd{G k} command in the group
11052 buffer. 
11053
11054 The address field of the @code{nnkiboze} method is, as with
11055 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11056 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
11057 and @code{nnvirtual} end.
11058
11059 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11060 must have a score file to say what articles are to be included in
11061 the group (@pxref{Scoring}).
11062
11063 @kindex M-x nnkiboze-generate-groups
11064 @findex nnkiboze-generate-groups
11065 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11066 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
11067 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
11068 all the articles in all the component groups and run them through the
11069 scoring process to determine if there are any articles in the groups
11070 that are to be part of the @code{nnkiboze} groups.
11071
11072 Please limit the number of component groups by using restrictive
11073 regexps.  Otherwise your sysadmin may become annoyed with you, and the
11074 @sc{nntp} site may throw you off and never let you back in again.
11075 Stranger things have happened.
11076
11077 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11078 and they can be foreign.  No restrictions.
11079
11080 @vindex nnkiboze-directory
11081 The generation of an @code{nnkiboze} group means writing two files in
11082 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
11083 contains the @sc{nov} header lines for all the articles in the group,
11084 and the other is an additional @file{.newsrc} file to store information
11085 on what groups have been searched through to find component articles.
11086
11087 Articles marked as read in the @code{nnkiboze} group will have
11088 their @sc{nov} lines removed from the @sc{nov} file.
11089
11090
11091 @node Gnus Unplugged
11092 @section Gnus Unplugged
11093 @cindex offline
11094 @cindex unplugged
11095 @cindex Agent
11096 @cindex Gnus Agent
11097 @cindex Gnus Unplugged
11098
11099 In olden times (ca. February '88), people used to run their newsreaders
11100 on big machines with permanent connections to the net.  News transport
11101 was dealt with by news servers, and all the newsreaders had to do was to
11102 read news.  Believe it or not.
11103
11104 Nowadays most people read news and mail at home, and use some sort of
11105 modem to connect to the net.  To avoid running up huge phone bills, it
11106 would be nice to have a way to slurp down all the news and mail, hang up
11107 the phone, read for several hours, and then upload any responses you
11108 have to make.  And then you repeat the procedure.
11109
11110 Of course, you can use news servers for doing this as well.  I've used
11111 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11112 for some years, but doing that's a bore.  Moving the news server
11113 functionality up to the newsreader makes sense if you're the only person
11114 reading news on a machine.
11115
11116 Using Gnus as an ``offline'' newsreader is quite simple.
11117
11118 @itemize @bullet
11119 @item
11120 First, set up Gnus as you would do if you were running it on a machine
11121 that has full connection to the net.  Go ahead.  I'll still be waiting
11122 here.
11123
11124 @item
11125 Then, put the following magical incantation at the end of your
11126 @file{.gnus.el} file:
11127
11128 @lisp
11129 (gnus-agentize)
11130 @end lisp
11131 @end itemize
11132
11133 That's it.  Gnus is now an ``offline'' newsreader.
11134
11135 Of course, to use it as such, you have to learn a few new commands.
11136
11137 @menu
11138 * Agent Basics::           How it all is supposed to work.
11139 * Agent Categories::       How to tell the Gnus Agent what to download.
11140 * Agent Commands::         New commands for all the buffers.
11141 * Outgoing Messages::      What happens when you post/mail something?
11142 * Agent Variables::        Customizing is fun.
11143 * Example Setup::          An example @file{.gnus.el} file for offline people.
11144 * Batching Agents::        How to fetch news from a @code{cron} job.
11145 @end menu
11146
11147
11148 @node Agent Basics
11149 @subsection Agent Basics
11150
11151 First, let's get some terminology out of the way.
11152
11153 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11154 connection to the net (and notified the Agent that this is the case).
11155 When the connection to the net is up again (and Gnus knows this), the
11156 Agent is @dfn{plugged}.
11157
11158 The @dfn{local} machine is the one you're running on, and which isn't
11159 connected to the net continously.
11160
11161 @dfn{Downloading} means fetching things from the net to your local
11162 machine.  @dfn{Uploading} is doing the opposite.
11163
11164 Let's take a typical Gnus session using the Agent.
11165
11166 @itemize @bullet
11167
11168 @item
11169 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
11170 Agent in a disconnected state.  You can read all the news that you have
11171 already fetched while in this mode.
11172
11173 @item
11174 You then decide to see whether any new news has arrived.  You connect
11175 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11176 to make Gnus become @dfn{plugged}.
11177
11178 @item
11179 You can then read the new news immediately, or you can download the news
11180 onto your local machine.  If you want to do the latter, you press @kbd{J
11181 s} to fetch all the eligible articles in all the groups.  (To let Gnus
11182 know which articles you want to download, @pxref{Agent Categories}.)
11183
11184 @item
11185 After fetching the articles, you press @kbd{J j} to make Gnus become
11186 unplugged again, and you shut down the PPP thing (or whatever).  And
11187 then you read the news offline.
11188
11189 @item
11190 And then you go to step 2.
11191 @end itemize
11192
11193 Here are some things you should do the first time (or so) that you use
11194 the Agent.
11195
11196 @itemize @bullet
11197
11198 @item
11199 Decide which servers should be covered by the Agent.  If you have a mail
11200 backend, it would probably be nonsensical to have it covered by the
11201 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
11202 @kbd{J a} the server (or servers) that you wish to have covered by the
11203 Agent (@pxref{Server Agent Commands}).  This will typically be only the
11204 primary select method, which is listed on the bottom in the buffer.
11205
11206 @item
11207 Decide on download policy.  @xref{Agent Categories}
11208
11209 @item
11210 Uhm... that's it.
11211 @end itemize
11212
11213
11214 @node Agent Categories
11215 @subsection Agent Categories
11216
11217 One of the main reasons to integrate the news transport layer into the
11218 newsreader is to allow greater control over what articles to download.
11219 There's not much point in downloading huge amounts of articles, just to
11220 find out that you're not interested in reading any of them.  It's better
11221 to be somewhat more conservative in choosing what to download, and then
11222 mark the articles for downloading manually if it should turn out that
11223 you're interested in the articles anyway.
11224
11225 The main way to control what is to be downloaded is to create a
11226 @dfn{category} and then assign some (or all) groups to this category. 
11227 Gnus has its own buffer for creating and managing categories.
11228
11229 @menu
11230 * Category Syntax::       What a category looks like.
11231 * The Category Buffer::   A buffer for maintaining categories.
11232 * Category Variables::    Customize'r'Us.
11233 @end menu
11234
11235
11236 @node Category Syntax
11237 @subsubsection Category Syntax
11238
11239 A category consists of two things.
11240
11241 @enumerate
11242 @item
11243 A predicate which (generally) gives a rough outline of which articles
11244 are eligible for downloading; and
11245
11246 @item
11247 a score rule which (generally) gives you a finer granularity when
11248 deciding what articles to download.  (Note that this @dfn{download
11249 score} is wholly unrelated to normal scores.)
11250 @end enumerate
11251
11252 A predicate consists of predicates with logical operators sprinkled in
11253 between.
11254
11255 Perhaps some examples are in order.
11256
11257 Here's a simple predicate.  (It's the default predicate, in fact, used
11258 for all groups that don't belong to any other category.)
11259
11260 @lisp
11261 short
11262 @end lisp
11263
11264 Quite simple, eh?  This predicate is true if and only if the article is
11265 short (for some value of ``short'').
11266
11267 Here's a more complex predicate:
11268
11269 @lisp
11270 (or high
11271     (and
11272      (not low)
11273      (not long)))
11274 @end lisp
11275
11276 This means that an article should be downloaded if it has a high score,
11277 or if the score is not low and the article is not long.  You get the
11278 drift.
11279
11280 The available logical operators are @code{or}, @code{and} and
11281 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
11282 @samp{|}, @code{&} and @code{!} instead.)
11283
11284 The following predicates are pre-defined, but if none of these fit what
11285 you want to do, you can write your own.
11286
11287 @table @code
11288 @item short
11289 True iff the article is shorter than @code{gnus-agent-short-article}
11290 lines; default 100.
11291
11292 @item long
11293 True iff the article is longer than @code{gnus-agent-long-article}
11294 lines; default 200.
11295
11296 @item low
11297 True iff the article has a download score less than
11298 @code{gnus-agent-low-score}; default 0.
11299
11300 @item high
11301 True iff the article has a download score greater than
11302 @code{gnus-agent-high-score}; default 0.
11303
11304 @item spam
11305 True iff the Gnus Agent guesses that the article is spam.  The
11306 heuristics may change over time, but at present it just computes a
11307 checksum and sees whether articles match.
11308
11309 @item true
11310 Always true.
11311
11312 @item false
11313 Always false.
11314 @end table
11315
11316 If you want to create your own predicate function, here's what you have
11317 to know:  The functions are called with no parameters, but the
11318 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11319 useful values.
11320
11321 Now, the syntax of the download score is the same as the syntax of
11322 normal score files, except that all elements that require actually
11323 seeing the article itself are verboten.  This means that only the
11324 following headers can be scored on: @code{From}, @code{Subject},
11325 @code{Date}, @code{Xref}, @code{Lines}, @code{Chars}, @code{Message-ID},
11326 and @code{References}.
11327
11328
11329 @node The Category Buffer
11330 @subsubsection The Category Buffer
11331
11332 You'd normally do all category maintenance from the category buffer.
11333 When you enter it for the first time (with the @kbd{J c} command from
11334 the group buffer), you'll only see the @code{default} category.
11335
11336 The following commands are available in this buffer:
11337
11338 @table @kbd
11339 @item q
11340 @kindex q (Category)
11341 @findex gnus-category-exit
11342 Return to the group buffer (@code{gnus-category-exit}).
11343
11344 @item k
11345 @kindex k (Category)
11346 @findex gnus-category-kill
11347 Kill the current category (@code{gnus-category-kill}).
11348
11349 @item c
11350 @kindex c (Category)
11351 @findex gnus-category-copy
11352 Copy the current category (@code{gnus-category-copy}).
11353
11354 @item a
11355 @kindex a (Category)
11356 @findex gnus-category-add
11357 Add a new category (@code{gnus-category-add}).
11358
11359 @item p
11360 @kindex p (Category)
11361 @findex gnus-category-edit-predicate
11362 Edit the predicate of the current category
11363 (@code{gnus-category-edit-predicate}).
11364
11365 @item g
11366 @kindex g (Category)
11367 @findex gnus-category-edit-groups
11368 Edit the list of groups belonging to the current category
11369 (@code{gnus-category-edit-groups}).
11370
11371 @item s
11372 @kindex s (Category)
11373 @findex gnus-category-edit-score
11374 Edit the download score rule of the current category
11375 (@code{gnus-category-edit-score}).
11376
11377 @item l
11378 @kindex l (Category)
11379 @findex gnus-category-list
11380 List all the categories (@code{gnus-category-list}).
11381 @end table
11382
11383
11384 @node Category Variables
11385 @subsubsection Category Variables
11386
11387 @table @code
11388 @item gnus-category-mode-hook
11389 @vindex gnus-category-mode-hook
11390 Hook run in category buffers.
11391
11392 @item gnus-category-line-format
11393 @vindex gnus-category-line-format
11394 Format of the lines in the category buffer (@pxref{Formatting
11395 Variables}).  Legal elements are:
11396
11397 @table @samp
11398 @item c
11399 The name of the category.
11400
11401 @item g
11402 The number of groups in the category.
11403 @end table
11404
11405 @item gnus-category-mode-line-format
11406 @vindex gnus-category-mode-line-format
11407 Format of the category mode line.
11408
11409 @item gnus-agent-short-article 
11410 @vindex gnus-agent-short-article 
11411 Articles that have fewer lines than this are short.  Default 100.
11412
11413 @item gnus-agent-long-article 
11414 @vindex gnus-agent-long-article 
11415 Articles that have more lines than this are long.  Default 200.
11416
11417 @item gnus-agent-low-score 
11418 @vindex gnus-agent-low-score 
11419 Articles that have a score lower than this have a low score.  Default
11420 0. 
11421
11422 @item gnus-agent-high-score 
11423 @vindex gnus-agent-high-score 
11424 Articles that have a score higher than this have a high score.  Default
11425 0. 
11426
11427 @end table
11428
11429
11430 @node Agent Commands
11431 @subsection Agent Commands
11432
11433 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
11434 (@code{gnus-agent-toggle-plugged} command works in all modes, and
11435 toggles the plugged/unplugged state of the Gnus Agent.
11436
11437
11438 @menu
11439 * Group Agent Commands::
11440 * Summary Agent Commands::
11441 * Server Agent Commands::
11442 @end menu
11443
11444 You can run a complete batch fetch from the command line with the
11445 following incantation:
11446
11447 @cindex gnus-agent-batch-fetch
11448 @example
11449 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
11450 @end example
11451
11452
11453
11454 @node Group Agent Commands
11455 @subsubsection Group Agent Commands
11456
11457 @table @kbd
11458 @item J u 
11459 @kindex J u (Agent Group)
11460 @findex gnus-agent-fetch-groups
11461 Fetch all eligible articles in the current group
11462 (@code{gnus-agent-fetch-groups}).
11463
11464 @item J c
11465 @kindex J c (Agent Group)
11466 @findex gnus-enter-category-buffer
11467 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
11468
11469 @item J s
11470 @kindex J s (Agent Group)
11471 @findex gnus-agent-fetch-session
11472 Fetch all eligible articles in all groups
11473 (@code{gnus-agent-fetch-session}).
11474
11475 @item J S
11476 @kindex J S (Agent Group)
11477 @findex gnus-group-send-drafts
11478 Send all sendable messages in the draft group
11479 (@code{gnus-agent-fetch-session}).  @xref{Drafts}
11480
11481 @item J a
11482 @kindex J a (Agent Group)
11483 @findex gnus-agent-add-group
11484 Add the current group to an Agent category
11485 (@code{gnus-agent-add-group}).
11486
11487 @end table
11488
11489
11490 @node Summary Agent Commands
11491 @subsubsection Summary Agent Commands
11492
11493 @table @kbd
11494 @item J #
11495 @kindex J # (Agent Summary)
11496 @findex gnus-agent-mark-article
11497 Mark the article for downloading (@code{gnus-agent-mark-article}).
11498
11499 @item J M-#
11500 @kindex J M-# (Agent Summary)
11501 @findex gnus-agent-unmark-article
11502 Remove the downloading mark from the article
11503 (@code{gnus-agent-unmark-article}).
11504
11505 @item @@
11506 @kindex @@ (Agent Summary)
11507 @findex gnus-agent-toggle-mark
11508 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
11509
11510 @item J c
11511 @kindex J c (Agent Summary)
11512 @findex gnus-agent-catchup
11513 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
11514
11515 @end table
11516
11517
11518 @node Server Agent Commands
11519 @subsubsection Server Agent Commands
11520
11521 @table @kbd
11522 @item J a
11523 @kindex J a (Agent Server)
11524 @findex gnus-agent-add-server
11525 Add the current server to the list of servers covered by the Gnus Agent
11526 (@code{gnus-agent-add-server}).
11527
11528 @item J r
11529 @kindex J r (Agent Server)
11530 @findex gnus-agent-remove-server
11531 Remove the current server from the list of servers covered by the Gnus
11532 Agent (@code{gnus-agent-remove-server}).
11533
11534 @end table
11535
11536
11537 @node Outgoing Messages
11538 @subsection Outgoing Messages
11539
11540 When Gnus is unplugged, all outgoing messages (both mail and news) are
11541 stored in the draft groups (@pxref{Drafts}).  You can view them there
11542 after posting, and edit them at will.
11543
11544 When Gnus is plugged again, you can send the messages either from the
11545 draft group with the special commands available there, or you can use
11546 the @kbd{J S} command in the group buffer to send all the sendable
11547 messages in the draft group.
11548
11549
11550
11551 @node Agent Variables
11552 @subsection Agent Variables
11553
11554 @table @code
11555 @item gnus-agent-directory
11556 @vindex gnus-agent-directory
11557 Where the Gnus Agent will store its files.  The default is
11558 @file{~/News/agent/}.
11559
11560 @item gnus-agent-handle-level
11561 @vindex gnus-agent-handle-level
11562 Groups on levels (@pxref{Group Levels}) higher than this variable will
11563 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
11564 which means that only subscribed group will be considered by the Agent
11565 by default.
11566
11567 @item gnus-agent-plugged-hook
11568 @vindex gnus-agent-plugged-hook
11569 Hook run when connecting to the network.
11570
11571 @item gnus-agent-unplugged-hook
11572 @vindex gnus-agent-unplugged-hook
11573 Hook run when disconnecting from the network.
11574
11575 @end table
11576
11577
11578 @node Example Setup
11579 @subsection Example Setup
11580
11581 If you don't want to read this manual, and you have a fairly standard
11582 setup, you may be able to use something like the following as your
11583 @file{.gnus.el} file to get started.
11584
11585 @lisp
11586 ;;; Define how Gnus is to fetch news.  We do this over NNTP
11587 ;;; from your ISP's server.
11588 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
11589
11590 ;;; Define how Gnus is to read your mail.  We read mail from
11591 ;;; your ISP's POP server.
11592 (setenv "MAILHOST" "pop.your-isp.com")
11593 (setq nnmail-spool-file "po:username")
11594
11595 ;;; Say how Gnus is to store the mail.  We use nnml groups.
11596 (setq gnus-secondary-select-methods '((nnml "")))
11597
11598 ;;; Make Gnus into an offline newsreader.
11599 (gnus-agentize)
11600 @end lisp
11601
11602 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
11603 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
11604 gnus}.
11605
11606 If this is the first time you've run Gnus, you will be subscribed
11607 automatically to a few default newsgroups.  You'll probably want to
11608 subscribe to more groups, and to do that, you have to query the
11609 @sc{nntp} server for a complete list of groups with the @kbd{A A}
11610 command.  This usually takes quite a while, but you only have to do it
11611 once.
11612
11613 After reading and parsing a while, you'll be presented with a list of
11614 groups.  Subscribe to the ones you want to read with the @kbd{u}
11615 command.  @kbd{l} to make all the killed groups disappear after you've
11616 subscribe to all the groups you want to read.  (@kbd{A k} will bring
11617 back all the killed groups.)
11618
11619 You can now read the groups at once, or you can download the articles
11620 with the @kbd{J s} command.  And then read the rest of this manual to
11621 find out which of the other gazillion things you want to customize.
11622
11623
11624 @node Batching Agents
11625 @subsection Batching Agents
11626
11627 Having the Gnus Agent fetch articles (and post whatever messages you've
11628 written) is quite easy once you've gotten things set up properly.  The
11629 following shell script will do everything that is necessary:
11630
11631 @example
11632 #!/bin/sh
11633 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
11634 @end example
11635
11636
11637
11638 @node Scoring
11639 @chapter Scoring
11640 @cindex scoring
11641
11642 Other people use @dfn{kill files}, but we here at Gnus Towers like
11643 scoring better than killing, so we'd rather switch than fight.  They do
11644 something completely different as well, so sit up straight and pay
11645 attention!
11646
11647 @vindex gnus-summary-mark-below
11648 All articles have a default score (@code{gnus-summary-default-score}),
11649 which is 0 by default.  This score may be raised or lowered either
11650 interactively or by score files.  Articles that have a score lower than
11651 @code{gnus-summary-mark-below} are marked as read.
11652
11653 Gnus will read any @dfn{score files} that apply to the current group
11654 before generating the summary buffer.
11655
11656 There are several commands in the summary buffer that insert score
11657 entries based on the current article.  You can, for instance, ask Gnus to
11658 lower or increase the score of all articles with a certain subject.
11659
11660 There are two sorts of scoring entries: Permanent and temporary.
11661 Temporary score entries are self-expiring entries.  Any entries that are
11662 temporary and have not been used for, say, a week, will be removed
11663 silently to help keep the sizes of the score files down.
11664
11665 @menu 
11666 * Summary Score Commands::   Adding score entries for the current group.
11667 * Group Score Commands::     General score commands.
11668 * Score Variables::          Customize your scoring.  (My, what terminology).
11669 * Score File Format::        What a score file may contain.
11670 * Score File Editing::       You can edit score files by hand as well.
11671 * Adaptive Scoring::         Big Sister Gnus knows what you read.
11672 * Home Score File::          How to say where new score entries are to go.
11673 * Followups To Yourself::    Having Gnus notice when people answer you.
11674 * Scoring Tips::             How to score effectively.
11675 * Reverse Scoring::          That problem child of old is not problem.
11676 * Global Score Files::       Earth-spanning, ear-splitting score files.
11677 * Kill Files::               They are still here, but they can be ignored.
11678 * Converting Kill Files::    Translating kill files to score files.
11679 * GroupLens::                Getting predictions on what you like to read.
11680 * Advanced Scoring::         Using logical expressions to build score rules.
11681 * Score Decays::             It can be useful to let scores wither away.
11682 @end menu
11683
11684
11685 @node Summary Score Commands
11686 @section Summary Score Commands
11687 @cindex score commands
11688
11689 The score commands that alter score entries do not actually modify real
11690 score files.  That would be too inefficient.  Gnus maintains a cache of
11691 previously loaded score files, one of which is considered the
11692 @dfn{current score file alist}.  The score commands simply insert
11693 entries into this list, and upon group exit, this list is saved.
11694
11695 The current score file is by default the group's local score file, even
11696 if no such score file actually exists.  To insert score commands into
11697 some other score file (e.g. @file{all.SCORE}), you must first make this
11698 score file the current one.
11699
11700 General score commands that don't actually change the score file:
11701
11702 @table @kbd
11703
11704 @item V s
11705 @kindex V s (Summary)
11706 @findex gnus-summary-set-score
11707 Set the score of the current article (@code{gnus-summary-set-score}).  
11708
11709 @item V S
11710 @kindex V S (Summary)
11711 @findex gnus-summary-current-score
11712 Display the score of the current article
11713 (@code{gnus-summary-current-score}).   
11714
11715 @item V t
11716 @kindex V t (Summary)
11717 @findex gnus-score-find-trace
11718 Display all score rules that have been used on the current article
11719 (@code{gnus-score-find-trace}).   
11720
11721 @item V R
11722 @kindex V R (Summary)
11723 @findex gnus-summary-rescore
11724 Run the current summary through the scoring process
11725 (@code{gnus-summary-rescore}).  This might be useful if you're playing
11726 around with your score files behind Gnus' back and want to see the
11727 effect you're having.
11728
11729 @item V a
11730 @kindex V a (Summary)
11731 @findex gnus-summary-score-entry
11732 Add a new score entry, and allow specifying all elements 
11733 (@code{gnus-summary-score-entry}).
11734
11735 @item V c
11736 @kindex V c (Summary)
11737 @findex gnus-score-change-score-file
11738 Make a different score file the current
11739 (@code{gnus-score-change-score-file}). 
11740
11741 @item V e
11742 @kindex V e (Summary)
11743 @findex gnus-score-edit-current-scores
11744 Edit the current score file (@code{gnus-score-edit-current-scores}).
11745 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
11746 File Editing}).
11747
11748 @item V f
11749 @kindex V f (Summary)
11750 @findex gnus-score-edit-file
11751 Edit a score file and make this score file the current one
11752 (@code{gnus-score-edit-file}).
11753
11754 @item V F
11755 @kindex V F (Summary)
11756 @findex gnus-score-flush-cache
11757 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
11758 after editing score files.
11759
11760 @item V C
11761 @kindex V C (Summary)
11762 @findex gnus-score-customize
11763 Customize a score file in a visually pleasing manner
11764 (@code{gnus-score-customize}). 
11765
11766 @end table
11767
11768 The rest of these commands modify the local score file.
11769
11770 @table @kbd
11771
11772 @item V m
11773 @kindex V m (Summary)
11774 @findex gnus-score-set-mark-below
11775 Prompt for a score, and mark all articles with a score below this as
11776 read (@code{gnus-score-set-mark-below}).
11777
11778 @item V x
11779 @kindex V x (Summary)
11780 @findex gnus-score-set-expunge-below
11781 Prompt for a score, and add a score rule to the current score file to
11782 expunge all articles below this score
11783 (@code{gnus-score-set-expunge-below}).
11784 @end table
11785
11786 The keystrokes for actually making score entries follow a very regular
11787 pattern, so there's no need to list all the commands.  (Hundreds of
11788 them.)  
11789
11790 @findex gnus-summary-increase-score
11791 @findex gnus-summary-lower-score
11792
11793 @enumerate
11794 @item
11795 The first key is either @kbd{I} (upper case i) for increasing the score
11796 or @kbd{L} for lowering the score. 
11797 @item
11798 The second key says what header you want to score on.  The following
11799 keys are available:
11800 @table @kbd
11801
11802 @item a
11803 Score on the author name.
11804
11805 @item s
11806 Score on the subject line.
11807
11808 @item x
11809 Score on the Xref line---i.e., the cross-posting line.
11810
11811 @item t
11812 Score on thread---the References line.
11813
11814 @item d
11815 Score on the date.
11816
11817 @item l
11818 Score on the number of lines.
11819
11820 @item i
11821 Score on the Message-ID.
11822
11823 @item f
11824 Score on followups.
11825
11826 @item b
11827 Score on the body.
11828
11829 @item h
11830 Score on the head.
11831 @end table
11832
11833 @item
11834 The third key is the match type.  Which match types are valid depends on
11835 what headers you are scoring on.
11836
11837 @table @code
11838
11839 @item strings 
11840
11841 @table @kbd
11842
11843 @item e
11844 Exact matching.
11845
11846 @item s
11847 Substring matching.
11848
11849 @item f
11850 Fuzzy matching (@pxref{Fuzzy Matching}).
11851
11852 @item r
11853 Regexp matching
11854 @end table
11855
11856 @item date
11857 @table @kbd
11858
11859 @item b
11860 Before date.
11861
11862 @item a
11863 At date.
11864
11865 @item n
11866 This date.
11867 @end table
11868
11869 @item number
11870 @table @kbd
11871
11872 @item <
11873 Less than number.
11874
11875 @item =
11876 Equal to number.
11877
11878 @item >
11879 Greater than number.
11880 @end table
11881 @end table
11882
11883 @item 
11884 The fourth and final key says whether this is a temporary (i.e., expiring)
11885 score entry, or a permanent (i.e., non-expiring) score entry, or whether
11886 it is to be done immediately, without adding to the score file.
11887 @table @kbd
11888
11889 @item t
11890 Temporary score entry.
11891
11892 @item p
11893 Permanent score entry.
11894
11895 @item i
11896 Immediately scoring.
11897 @end table
11898
11899 @end enumerate
11900
11901 So, let's say you want to increase the score on the current author with
11902 exact matching permanently: @kbd{I a e p}.  If you want to lower the
11903 score based on the subject line, using substring matching, and make a
11904 temporary score entry: @kbd{L s s t}.  Pretty easy.
11905
11906 To make things a bit more complicated, there are shortcuts.  If you use
11907 a capital letter on either the second or third keys, Gnus will use
11908 defaults for the remaining one or two keystrokes.  The defaults are
11909 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
11910 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
11911
11912 These functions take both the numerical prefix and the symbolic prefix
11913 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
11914 (or increase) the score of the article.  A symbolic prefix of @code{a}
11915 says to use the @file{all.SCORE} file for the command instead of the
11916 current score file.
11917
11918 @vindex gnus-score-mimic-keymap
11919 The @code{gnus-score-mimic-keymap} says whether these commands will
11920 pretend they are keymaps or not.
11921
11922
11923 @node Group Score Commands
11924 @section Group Score Commands
11925 @cindex group score commands
11926
11927 There aren't many of these as yet, I'm afraid.
11928
11929 @table @kbd
11930
11931 @item W f
11932 @kindex W f (Group)
11933 @findex gnus-score-flush-cache
11934 Gnus maintains a cache of score alists to avoid having to reload them
11935 all the time.  This command will flush the cache
11936 (@code{gnus-score-flush-cache}). 
11937
11938 @end table
11939
11940 You can do scoring from the command line by saying something like:
11941
11942 @findex gnus-batch-score
11943 @cindex batch scoring
11944 @example
11945 $ emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score
11946 @end example
11947
11948
11949 @node Score Variables
11950 @section Score Variables
11951 @cindex score variables
11952
11953 @table @code
11954
11955 @item gnus-use-scoring
11956 @vindex gnus-use-scoring
11957 If @code{nil}, Gnus will not check for score files, and will not, in
11958 general, do any score-related work.  This is @code{t} by default.
11959
11960 @item gnus-kill-killed
11961 @vindex gnus-kill-killed
11962 If this variable is @code{nil}, Gnus will never apply score files to
11963 articles that have already been through the kill process.  While this
11964 may save you lots of time, it also means that if you apply a kill file
11965 to a group, and then change the kill file and want to run it over you
11966 group again to kill more articles, it won't work.  You have to set this
11967 variable to @code{t} to do that.  (It is @code{t} by default.)
11968
11969 @item gnus-kill-files-directory
11970 @vindex gnus-kill-files-directory
11971 All kill and score files will be stored in this directory, which is
11972 initialized from the @code{SAVEDIR} environment variable by default.
11973 This is @file{~/News/} by default.
11974
11975 @item gnus-score-file-suffix
11976 @vindex gnus-score-file-suffix
11977 Suffix to add to the group name to arrive at the score file name
11978 (@samp{SCORE} by default.)
11979
11980 @item gnus-score-uncacheable-files
11981 @vindex gnus-score-uncacheable-files
11982 @cindex score cache
11983 All score files are normally cached to avoid excessive re-loading of
11984 score files.  However, if this might make you Emacs grow big and
11985 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
11986 @file{all.SCORE}, while it might be a good idea to not cache
11987 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
11988 variable is @samp{ADAPT$} by default, so no adaptive score files will
11989 be cached.
11990
11991 @item gnus-save-score
11992 @vindex gnus-save-score
11993 If you have really complicated score files, and do lots of batch
11994 scoring, then you might set this variable to @code{t}.  This will make
11995 Gnus save the scores into the @file{.newsrc.eld} file.
11996
11997 @item gnus-score-interactive-default-score
11998 @vindex gnus-score-interactive-default-score
11999 Score used by all the interactive raise/lower commands to raise/lower
12000 score with.  Default is 1000, which may seem excessive, but this is to
12001 ensure that the adaptive scoring scheme gets enough room to play with.
12002 We don't want the small changes from the adaptive scoring to overwrite
12003 manually entered data.
12004
12005 @item gnus-summary-default-score
12006 @vindex gnus-summary-default-score
12007 Default score of an article, which is 0 by default.
12008
12009 @item gnus-summary-expunge-below
12010 @vindex gnus-summary-expunge-below
12011 Don't display the summary lines of articles that have scores lower than
12012 this variable.  This is @code{nil} by default, which means that no
12013 articles will be hidden.  This variable is local to the summary buffers,
12014 and has to be set from @code{gnus-summary-mode-hook}.
12015
12016 @item gnus-score-over-mark
12017 @vindex gnus-score-over-mark
12018 Mark (in the third column) used for articles with a score over the
12019 default.  Default is @samp{+}.
12020
12021 @item gnus-score-below-mark
12022 @vindex gnus-score-below-mark
12023 Mark (in the third column) used for articles with a score below the
12024 default.  Default is @samp{-}.
12025
12026 @item gnus-score-find-score-files-function
12027 @vindex gnus-score-find-score-files-function
12028 Function used to find score files for the current group.  This function
12029 is called with the name of the group as the argument. 
12030
12031 Predefined functions available are:
12032 @table @code
12033
12034 @item gnus-score-find-single
12035 @findex gnus-score-find-single
12036 Only apply the group's own score file.
12037
12038 @item gnus-score-find-bnews
12039 @findex gnus-score-find-bnews
12040 Apply all score files that match, using bnews syntax.  This is the
12041 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
12042 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12043 @file{gnu.all.SCORE} would all apply.  In short, the instances of
12044 @samp{all} in the score file names are translated into @samp{.*}, and
12045 then a regexp match is done.
12046
12047 This means that if you have some score entries that you want to apply to
12048 all groups, then you put those entries in the @file{all.SCORE} file. 
12049
12050 The score files are applied in a semi-random order, although Gnus will
12051 try to apply the more general score files before the more specific score
12052 files.  It does this by looking at the number of elements in the score
12053 file names---discarding the @samp{all} elements.
12054
12055 @item gnus-score-find-hierarchical
12056 @findex gnus-score-find-hierarchical
12057 Apply all score files from all the parent groups.  This means that you
12058 can't have score files like @file{all.SCORE}, but you can have
12059 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12060
12061 @end table
12062 This variable can also be a list of functions.  In that case, all these
12063 functions will be called, and all the returned lists of score files will
12064 be applied.  These functions can also return lists of score alists
12065 directly.  In that case, the functions that return these non-file score
12066 alists should probably be placed before the ``real'' score file
12067 functions, to ensure that the last score file returned is the local
12068 score file.  Phu.
12069
12070 @item gnus-score-expiry-days
12071 @vindex gnus-score-expiry-days
12072 This variable says how many days should pass before an unused score file
12073 entry is expired.  If this variable is @code{nil}, no score file entries
12074 are expired.  It's 7 by default.
12075
12076 @item gnus-update-score-entry-dates
12077 @vindex gnus-update-score-entry-dates
12078 If this variable is non-@code{nil}, matching score entries will have
12079 their dates updated.  (This is how Gnus controls expiry---all
12080 non-matching entries will become too old while matching entries will
12081 stay fresh and young.)  However, if you set this variable to @code{nil},
12082 even matching entries will grow old and will have to face that oh-so
12083 grim reaper.  
12084
12085 @item gnus-score-after-write-file-function
12086 @vindex gnus-score-after-write-file-function
12087 Function called with the name of the score file just written.
12088
12089 @item gnus-score-thread-simplify
12090 @vindex gnus-score-thread-simplify
12091 If this variable is non-@code{nil}, article subjects will be simplified
12092 for subject scoring purposes in the same manner as with
12093 threading---according to the current value of
12094 gnus-simplify-subject-functions.  If the scoring entry uses
12095 @code{substring} or @code{exact} matching, the match will also be
12096 simplified in this manner.
12097
12098 @end table
12099
12100
12101 @node Score File Format
12102 @section Score File Format
12103 @cindex score file format
12104
12105 A score file is an @code{emacs-lisp} file that normally contains just a
12106 single form.  Casual users are not expected to edit these files;
12107 everything can be changed from the summary buffer.
12108
12109 Anyway, if you'd like to dig into it yourself, here's an example:
12110
12111 @lisp
12112 (("from"
12113   ("Lars Ingebrigtsen" -10000)
12114   ("Per Abrahamsen")
12115   ("larsi\\|lmi" -50000 nil R))
12116  ("subject"
12117   ("Ding is Badd" nil 728373))
12118  ("xref"
12119   ("alt.politics" -1000 728372 s))
12120  ("lines"
12121   (2 -100 nil <))
12122  (mark 0)
12123  (expunge -1000)
12124  (mark-and-expunge -10)
12125  (read-only nil)
12126  (orphan -10)
12127  (adapt t)
12128  (files "/hom/larsi/News/gnu.SCORE")
12129  (exclude-files "all.SCORE")
12130  (local (gnus-newsgroup-auto-expire t)
12131         (gnus-summary-make-false-root empty))
12132  (eval (ding)))
12133 @end lisp
12134
12135 This example demonstrates most score file elements.  For a different
12136 approach, see @pxref{Advanced Scoring}.
12137
12138 Even though this looks much like lisp code, nothing here is actually
12139 @code{eval}ed.  The lisp reader is used to read this form, though, so it
12140 has to be valid syntactically, if not semantically.
12141
12142 Six keys are supported by this alist:
12143
12144 @table @code
12145
12146 @item STRING
12147 If the key is a string, it is the name of the header to perform the
12148 match on.  Scoring can only be performed on these eight headers:
12149 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
12150 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
12151 these headers, there are three strings to tell Gnus to fetch the entire
12152 article and do the match on larger parts of the article: @code{Body}
12153 will perform the match on the body of the article, @code{Head} will
12154 perform the match on the head of the article, and @code{All} will
12155 perform the match on the entire article.  Note that using any of these
12156 last three keys will slow down group entry @emph{considerably}.  The
12157 final ``header'' you can score on is @code{Followup}.  These score
12158 entries will result in new score entries being added for all follow-ups
12159 to articles that matches these score entries.
12160
12161 Following this key is a arbitrary number of score entries, where each
12162 score entry has one to four elements.
12163 @enumerate
12164
12165 @item 
12166 The first element is the @dfn{match element}.  On most headers this will
12167 be a string, but on the Lines and Chars headers, this must be an
12168 integer. 
12169
12170 @item 
12171 If the second element is present, it should be a number---the @dfn{score
12172 element}.  This number should be an integer in the neginf to posinf
12173 interval.  This number is added to the score of the article if the match
12174 is successful.  If this element is not present, the
12175 @code{gnus-score-interactive-default-score} number will be used
12176 instead.  This is 1000 by default.
12177
12178 @item 
12179 If the third element is present, it should be a number---the @dfn{date
12180 element}.  This date says when the last time this score entry matched,
12181 which provides a mechanism for expiring the score entries.  It this
12182 element is not present, the score entry is permanent.  The date is
12183 represented by the number of days since December 31, 1 BCE.
12184
12185 @item 
12186 If the fourth element is present, it should be a symbol---the @dfn{type
12187 element}.  This element specifies what function should be used to see
12188 whether this score entry matches the article.  What match types that can
12189 be used depends on what header you wish to perform the match on.
12190 @table @dfn
12191
12192 @item From, Subject, References, Xref, Message-ID
12193 For most header types, there are the @code{r} and @code{R} (regexp), as
12194 well as @code{s} and @code{S} (substring) types, and @code{e} and
12195 @code{E} (exact match), and @code{w} (word match) types.  If this
12196 element is not present, Gnus will assume that substring matching should
12197 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
12198 that the matches will be done in a case-sensitive manner.  All these
12199 one-letter types are really just abbreviations for the @code{regexp},
12200 @code{string}, @code{exact}, and @code{word} types, which you can use
12201 instead, if you feel like.
12202
12203 @item Lines, Chars
12204 These two headers use different match types: @code{<}, @code{>},
12205 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
12206 careful because some backends (like @code{nndir}) do not generate
12207 @code{Lines} header, so every article ends up being marked as having 0
12208 lines.  This can lead to strange results if you happen to lower score of
12209 the articles with few lines.
12210
12211 @item Date
12212 For the Date header we have three kinda silly match types:
12213 @code{before}, @code{at} and @code{after}.  I can't really imagine this
12214 ever being useful, but, like, it would feel kinda silly not to provide
12215 this function.  Just in case.  You never know.  Better safe than sorry.
12216 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
12217 sex on a first date.  (I have been told that at least one person, and I
12218 quote, ``found this function indispensable'', however.)
12219
12220 @cindex ISO8601
12221 @cindex date
12222 A more useful match type is @code{regexp}.  With it, you can match the
12223 date string using a regular expression.  The date is normalized to
12224 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
12225 you want to match all articles that have been posted on April 1st in
12226 every year, you could use @samp{....0401.........} as a match string,
12227 for instance.  (Note that the date is kept in its original time zone, so
12228 this will match articles that were posted when it was April 1st where
12229 the article was posted from.  Time zones are such wholesome fun for the
12230 whole family, eh?)
12231
12232 @item Head, Body, All
12233 These three match keys use the same match types as the @code{From} (etc)
12234 header uses.
12235
12236 @item Followup
12237 This match key is somewhat special, in that it will match the
12238 @code{From} header, and affect the score of not only the matching
12239 articles, but also all followups to the matching articles.  This allows
12240 you e.g. increase the score of followups to your own articles, or
12241 decrease the score of followups to the articles of some known
12242 trouble-maker.  Uses the same match types as the @code{From} header
12243 uses.  (Using this match key will lead to creation of @file{ADAPT}
12244 files.) 
12245
12246 @item Thread
12247 This match key works along the same lines as the @code{Followup} match
12248 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
12249 @samp{thread} match.  This will add a new @samp{thread} match for each
12250 article that has @var{X} in its @code{References} header.  (These new
12251 @samp{thread} matches will use the @code{Message-ID}s of these matching
12252 articles.)  This will ensure that you can raise/lower the score of an
12253 entire thread, even though some articles in the thread may not have
12254 complete @code{References} headers.  Note that using this may lead to
12255 undeterministic scores of the articles in the thread.  (Using this match
12256 key will lead to creation of @file{ADAPT} files.)
12257 @end table
12258 @end enumerate
12259
12260 @cindex Score File Atoms
12261 @item mark
12262 The value of this entry should be a number.  Any articles with a score
12263 lower than this number will be marked as read.
12264
12265 @item expunge
12266 The value of this entry should be a number.  Any articles with a score
12267 lower than this number will be removed from the summary buffer.
12268
12269 @item mark-and-expunge
12270 The value of this entry should be a number.  Any articles with a score
12271 lower than this number will be marked as read and removed from the
12272 summary buffer.
12273
12274 @item thread-mark-and-expunge
12275 The value of this entry should be a number.  All articles that belong to
12276 a thread that has a total score below this number will be marked as read
12277 and removed from the summary buffer.  @code{gnus-thread-score-function}
12278 says how to compute the total score for a thread.
12279
12280 @item files
12281 The value of this entry should be any number of file names.  These files
12282 are assumed to be score files as well, and will be loaded the same way
12283 this one was.
12284
12285 @item exclude-files
12286 The clue of this entry should be any number of files.  These files will
12287 not be loaded, even though they would normally be so, for some reason or
12288 other. 
12289
12290 @item eval
12291 The value of this entry will be @code{eval}el.  This element will be
12292 ignored when handling global score files. 
12293
12294 @item read-only
12295 Read-only score files will not be updated or saved.  Global score files
12296 should feature this atom (@pxref{Global Score Files}).  (Note:
12297 @dfn{Global} here really means @dfn{global}; not just your personal
12298 apply-to-all-groups score files.)
12299
12300 @item orphan
12301 The value of this entry should be a number.  Articles that do not have
12302 parents will get this number added to their scores.  Imagine you follow
12303 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
12304 will only follow a few of the threads, also want to see any new threads.
12305
12306 You can do this with the following two score file entries:
12307
12308 @example
12309         (orphan -500)
12310         (mark-and-expunge -100)
12311 @end example
12312
12313 When you enter the group the first time, you will only see the new
12314 threads.  You then raise the score of the threads that you find
12315 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
12316 rest.  Next time you enter the group, you will see new articles in the
12317 interesting threads, plus any new threads.
12318
12319 I.e.---the orphan score atom is for high-volume groups where there
12320 exist a few interesting threads which can't be found automatically by
12321 ordinary scoring rules.
12322
12323 @item adapt
12324 This entry controls the adaptive scoring.  If it is @code{t}, the
12325 default adaptive scoring rules will be used.  If it is @code{ignore}, no
12326 adaptive scoring will be performed on this group.  If it is a list, this
12327 list will be used as the adaptive scoring rules.  If it isn't present,
12328 or is something other than @code{t} or @code{ignore}, the default
12329 adaptive scoring rules will be used.  If you want to use adaptive
12330 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
12331 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
12332 not want adaptive scoring.  If you only want adaptive scoring in a few
12333 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
12334 insert @code{(adapt t)} in the score files of the groups where you want
12335 it. 
12336
12337 @item adapt-file
12338 All adaptive score entries will go to the file named by this entry.  It
12339 will also be applied when entering the group.  This atom might be handy
12340 if you want to adapt on several groups at once, using the same adaptive
12341 file for a number of groups.
12342
12343 @item local
12344 @cindex local variables
12345 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
12346 Each @var{var} will be made buffer-local to the current summary buffer,
12347 and set to the value specified.  This is a convenient, if somewhat
12348 strange, way of setting variables in some groups if you don't like hooks
12349 much.  Note that the @var{value} won't be evaluated.
12350 @end table
12351
12352
12353 @node Score File Editing
12354 @section Score File Editing
12355
12356 You normally enter all scoring commands from the summary buffer, but you
12357 might feel the urge to edit them by hand as well, so we've supplied you
12358 with a mode for that.  
12359
12360 It's simply a slightly customized @code{emacs-lisp} mode, with these
12361 additional commands:
12362
12363 @table @kbd
12364
12365 @item C-c C-c
12366 @kindex C-c C-c (Score)
12367 @findex gnus-score-edit-done
12368 Save the changes you have made and return to the summary buffer
12369 (@code{gnus-score-edit-done}). 
12370
12371 @item C-c C-d
12372 @kindex C-c C-d (Score)
12373 @findex gnus-score-edit-insert-date
12374 Insert the current date in numerical format
12375 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
12376 you were wondering.
12377
12378 @item C-c C-p
12379 @kindex C-c C-p (Score)
12380 @findex gnus-score-pretty-print
12381 The adaptive score files are saved in an unformatted fashion.  If you
12382 intend to read one of these files, you want to @dfn{pretty print} it
12383 first.  This command (@code{gnus-score-pretty-print}) does that for
12384 you. 
12385
12386 @end table
12387
12388 Type @kbd{M-x gnus-score-mode} to use this mode.
12389
12390 @vindex gnus-score-mode-hook
12391 @code{gnus-score-menu-hook} is run in score mode buffers.
12392
12393 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
12394 e} to begin editing score files.
12395
12396
12397 @node Adaptive Scoring
12398 @section Adaptive Scoring
12399 @cindex adaptive scoring
12400
12401 If all this scoring is getting you down, Gnus has a way of making it all
12402 happen automatically---as if by magic.  Or rather, as if by artificial
12403 stupidity, to be precise.
12404
12405 @vindex gnus-use-adaptive-scoring
12406 When you read an article, or mark an article as read, or kill an
12407 article, you leave marks behind.  On exit from the group, Gnus can sniff
12408 these marks and add score elements depending on what marks it finds.
12409 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
12410 @code{t} or @code{(line)}.  If you want score adaptively on separate
12411 words appearing in the subjects, you should set this variable to
12412 @code{(word)}.  If you want to use both adaptive methods, set this
12413 variable to @code{(word line)}.
12414
12415 @vindex gnus-default-adaptive-score-alist
12416 To give you complete control over the scoring process, you can customize
12417 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
12418 might look something like this:
12419
12420 @lisp
12421 (defvar gnus-default-adaptive-score-alist
12422   '((gnus-unread-mark)
12423     (gnus-ticked-mark (from 4))
12424     (gnus-dormant-mark (from 5))
12425     (gnus-del-mark (from -4) (subject -1))
12426     (gnus-read-mark (from 4) (subject 2))
12427     (gnus-expirable-mark (from -1) (subject -1))
12428     (gnus-killed-mark (from -1) (subject -3))
12429     (gnus-kill-file-mark)
12430     (gnus-ancient-mark)
12431     (gnus-low-score-mark)
12432     (gnus-catchup-mark (from -1) (subject -1))))
12433 @end lisp
12434
12435 As you see, each element in this alist has a mark as a key (either a
12436 variable name or a ``real'' mark---a character).  Following this key is
12437 a arbitrary number of header/score pairs.  If there are no header/score
12438 pairs following the key, no adaptive scoring will be done on articles
12439 that have that key as the article mark.  For instance, articles with
12440 @code{gnus-unread-mark} in the example above will not get adaptive score
12441 entries.
12442
12443 Each article can have only one mark, so just a single of these rules
12444 will be applied to each article.
12445
12446 To take @code{gnus-del-mark} as an example---this alist says that all
12447 articles that have that mark (i.e., are marked with @samp{D}) will have a
12448 score entry added to lower based on the @code{From} header by -4, and
12449 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
12450
12451 If you have marked 10 articles with the same subject with
12452 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
12453 That means that that subject will get a score of ten times -1, which
12454 should be, unless I'm much mistaken, -10.
12455
12456 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
12457 the read articles will be marked with the @samp{E} mark.  This'll
12458 probably make adaptive scoring slightly impossible, so auto-expiring and
12459 adaptive scoring doesn't really mix very well.
12460
12461 The headers you can score on are @code{from}, @code{subject},
12462 @code{message-id}, @code{references}, @code{xref}, @code{lines},
12463 @code{chars} and @code{date}.  In addition, you can score on
12464 @code{followup}, which will create an adaptive score entry that matches
12465 on the @code{References} header using the @code{Message-ID} of the
12466 current article, thereby matching the following thread.  
12467
12468 You can also score on @code{thread}, which will try to score all
12469 articles that appear in a thread.  @code{thread} matches uses a
12470 @code{Message-ID} to match on the @code{References} header of the
12471 article.  If the match is made, the @code{Message-ID} of the article is
12472 added to the @code{thread} rule.  (Think about it.  I'd recommend two
12473 aspirins afterwards.)
12474
12475 If you use this scheme, you should set the score file atom @code{mark}
12476 to something small---like -300, perhaps, to avoid having small random
12477 changes result in articles getting marked as read.
12478
12479 After using adaptive scoring for a week or so, Gnus should start to
12480 become properly trained and enhance the authors you like best, and kill
12481 the authors you like least, without you having to say so explicitly. 
12482
12483 You can control what groups the adaptive scoring is to be performed on
12484 by using the score files (@pxref{Score File Format}).  This will also
12485 let you use different rules in different groups.
12486
12487 @vindex gnus-adaptive-file-suffix
12488 The adaptive score entries will be put into a file where the name is the
12489 group name with @code{gnus-adaptive-file-suffix} appended.  The default
12490 is @samp{ADAPT}.
12491
12492 @vindex gnus-score-exact-adapt-limit
12493 When doing adaptive scoring, substring or fuzzy matching would probably
12494 give you the best results in most cases.  However, if the header one
12495 matches is short, the possibility for false positives is great, so if
12496 the length of the match is less than
12497 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
12498 this variable is @code{nil}, exact matching will always be used to avoid
12499 this problem.
12500
12501 @vindex gnus-default-adaptive-word-score-alist
12502 As mentioned above, you can adapt either on individual words or entire
12503 headers.  If you adapt on words, the
12504 @code{gnus-default-adaptive-word-score-alist} variable says what score
12505 each instance of a word should add given a mark.
12506
12507 @lisp
12508 (setq gnus-default-adaptive-word-score-alist  
12509       `((,gnus-read-mark . 30)
12510         (,gnus-catchup-mark . -10)
12511         (,gnus-killed-mark . -20)
12512         (,gnus-del-mark . -15)))
12513 @end lisp
12514
12515 This is the default value.  If you have adaption on words enabled, every
12516 word that appears in subjects of articles marked with
12517 @code{gnus-read-mark} will result in a score rule that increase the
12518 score with 30 points.
12519
12520 @vindex gnus-default-ignored-adaptive-words
12521 @vindex gnus-ignored-adaptive-words
12522 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
12523 will be ignored.  If you wish to add more words to be ignored, use the
12524 @code{gnus-ignored-adaptive-words} list instead.
12525
12526 @vindex gnus-adaptive-word-syntax-table
12527 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
12528 syntax table in effect.  It is similar to the standard syntax table, but
12529 it considers numbers to be non-word-constituent characters.
12530
12531 @vindex gnus-adaptive-word-minimum
12532 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
12533 word scoring process will never bring down the score of an article to
12534 below this number.  The default is @code{nil}.
12535
12536 After using this scheme for a while, it might be nice to write a
12537 @code{gnus-psychoanalyze-user} command to go through the rules and see
12538 what words you like and what words you don't like.  Or perhaps not.
12539
12540 Note that the adaptive word scoring thing is highly experimental and is
12541 likely to change in the future.  Initial impressions seem to indicate
12542 that it's totally useless as it stands.  Some more work (involving more
12543 rigorous statistical methods) will have to be done to make this useful. 
12544
12545
12546 @node Home Score File
12547 @section Home Score File
12548
12549 The score file where new score file entries will go is called the
12550 @dfn{home score file}.  This is normally (and by default) the score file
12551 for the group itself.  For instance, the home score file for
12552 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
12553
12554 However, this may not be what you want.  It is often convenient to share
12555 a common home score file among many groups---all @samp{emacs} groups
12556 could perhaps use the same home score file.
12557
12558 @vindex gnus-home-score-file
12559 The variable that controls this is @code{gnus-home-score-file}.  It can
12560 be:
12561
12562 @enumerate
12563 @item
12564 A string.  Then this file will be used as the home score file for all
12565 groups. 
12566
12567 @item
12568 A function. The result of this function will be used as the home score
12569 file.  The function will be called with the name of the group as the
12570 parameter. 
12571
12572 @item
12573 A list.  The elements in this list can be:
12574
12575 @enumerate
12576 @item 
12577 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
12578 the @var{file-name} will will be used as the home score file.
12579
12580 @item 
12581 A function. If the function returns non-nil, the result will be used as
12582 the home score file.
12583
12584 @item 
12585 A string.  Use the string as the home score file.
12586 @end enumerate
12587
12588 The list will be traversed from the beginning towards the end looking
12589 for matches.
12590
12591 @end enumerate
12592
12593 So, if you want to use just a single score file, you could say:
12594
12595 @lisp
12596 (setq gnus-home-score-file
12597       "my-total-score-file.SCORE")
12598 @end lisp
12599
12600 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
12601 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
12602
12603 @lisp
12604 (setq gnus-home-score-file
12605       'gnus-hierarchial-home-score-file)
12606 @end lisp
12607
12608 This is a ready-made function provided for your convenience.
12609
12610 If you want to have one score file for the @samp{emacs} groups and
12611 another for the @samp{comp} groups, while letting all other groups use
12612 their own home score files:
12613
12614 @lisp
12615 (setq gnus-home-score-file
12616       ;; All groups that match the regexp "\\.emacs"
12617       '("\\.emacs" "emacs.SCORE")
12618       ;; All the comp groups in one score file
12619        ("^comp" "comp.SCORE"))
12620 @end lisp
12621    
12622 @vindex gnus-home-adapt-file
12623 @code{gnus-home-adapt-file} works exactly the same way as
12624 @code{gnus-home-score-file}, but says what the home adaptive score file
12625 is instead.  All new adaptive file entries will go into the file
12626 specified by this variable, and the same syntax is allowed.
12627
12628 In addition to using @code{gnus-home-score-file} and
12629 @code{gnus-home-adapt-file}, you can also use group parameters
12630 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
12631 Parameters}) to achieve much the same.  Group and topic parameters take
12632 precedence over this variable.
12633
12634
12635 @node Followups To Yourself
12636 @section Followups To Yourself
12637
12638 Gnus offers two commands for picking out the @code{Message-ID} header in
12639 the current buffer.  Gnus will then add a score rule that scores using
12640 this @code{Message-ID} on the @code{References} header of other
12641 articles.  This will, in effect, increase the score of all articles that
12642 respond to the article in the current buffer.  Quite useful if you want
12643 to easily note when people answer what you've said.
12644
12645 @table @code
12646
12647 @item gnus-score-followup-article
12648 @findex gnus-score-followup-article
12649 This will add a score to articles that directly follow up your own
12650 article. 
12651
12652 @item gnus-score-followup-thread
12653 @findex gnus-score-followup-thread
12654 This will add a score to all articles that appear in a thread ``below''
12655 your own article.
12656 @end table
12657
12658 @vindex message-sent-hook
12659 These two functions are both primarily meant to be used in hooks like
12660 @code{message-sent-hook}.  
12661
12662 If you look closely at your own @code{Message-ID}, you'll notice that
12663 the first two or three characters are always the same.  Here's two of
12664 mine:  
12665
12666 @example
12667 <x6u3u47icf.fsf@@eyesore.no>
12668 <x6sp9o7ibw.fsf@@eyesore.no>
12669 @end example
12670
12671 So ``my'' ident on this machine is @samp{x6}.  This can be
12672 exploited---the following rule will raise the score on all followups to
12673 myself: 
12674
12675 @lisp
12676 ("references"
12677  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
12678   1000 nil r))
12679 @end lisp
12680
12681 Whether it's the first two or first three characters that are ``yours''
12682 is system-dependent.
12683
12684
12685 @node Scoring Tips
12686 @section Scoring Tips
12687 @cindex scoring tips
12688
12689 @table @dfn
12690
12691 @item Crossposts
12692 @cindex crossposts
12693 @cindex scoring crossposts
12694 If you want to lower the score of crossposts, the line to match on is
12695 the @code{Xref} header.
12696 @lisp
12697 ("xref" (" talk.politics.misc:" -1000))
12698 @end lisp
12699
12700 @item Multiple crossposts
12701 If you want to lower the score of articles that have been crossposted to
12702 more than, say, 3 groups:
12703 @lisp
12704 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
12705 @end lisp
12706
12707 @item Matching on the body
12708 This is generally not a very good idea---it takes a very long time.
12709 Gnus actually has to fetch each individual article from the server.  But
12710 you might want to anyway, I guess.  Even though there are three match
12711 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
12712 and stick with it in each score file.  If you use any two, each article
12713 will be fetched @emph{twice}.  If you want to match a bit on the
12714 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
12715 the matches.  
12716
12717 @item Marking as read
12718 You will probably want to mark articles that has a score below a certain
12719 number as read.  This is most easily achieved by putting the following
12720 in your @file{all.SCORE} file:
12721 @lisp
12722 ((mark -100))
12723 @end lisp
12724 You may also consider doing something similar with @code{expunge}.  
12725
12726 @item Negated character classes
12727 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
12728 That will match newlines, which might lead to, well, The Unknown.  Say
12729 @code{[^abcd\n]*} instead.
12730 @end table
12731
12732
12733 @node Reverse Scoring
12734 @section Reverse Scoring
12735 @cindex reverse scoring
12736
12737 If you want to keep just articles that have @samp{Sex with Emacs} in the
12738 subject header, and expunge all other articles, you could put something
12739 like this in your score file:
12740
12741 @lisp
12742 (("subject"
12743   ("Sex with Emacs" 2))
12744  (mark 1)
12745  (expunge 1))
12746 @end lisp
12747
12748 So, you raise all articles that match @samp{Sex with Emacs} and mark the
12749 rest as read, and expunge them to boot.
12750
12751
12752 @node Global Score Files
12753 @section Global Score Files
12754 @cindex global score files
12755
12756 Sure, other newsreaders have ``global kill files''.  These are usually
12757 nothing more than a single kill file that applies to all groups, stored
12758 in the user's home directory.  Bah!  Puny, weak newsreaders!
12759
12760 What I'm talking about here are Global Score Files.  Score files from
12761 all over the world, from users everywhere, uniting all nations in one
12762 big, happy score file union!  Ange-score!  New and untested!
12763
12764 @vindex gnus-global-score-files
12765 All you have to do to use other people's score files is to set the
12766 @code{gnus-global-score-files} variable.  One entry for each score file,
12767 or each score file directory.  Gnus will decide by itself what score
12768 files are applicable to which group.
12769
12770 Say you want to use the score file
12771 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
12772 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
12773
12774 @lisp
12775 (setq gnus-global-score-files
12776       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
12777         "/ftp@@ftp.some-where:/pub/score/"))
12778 @end lisp
12779
12780 @findex gnus-score-search-global-directories
12781 Simple, eh?  Directory names must end with a @samp{/}.  These
12782 directories are typically scanned only once during each Gnus session.
12783 If you feel the need to manually re-scan the remote directories, you can
12784 use the @code{gnus-score-search-global-directories} command.
12785
12786 Note that, at present, using this option will slow down group entry
12787 somewhat.  (That is---a lot.)
12788
12789 If you want to start maintaining score files for other people to use,
12790 just put your score file up for anonymous ftp and announce it to the
12791 world.  Become a retro-moderator!  Participate in the retro-moderator
12792 wars sure to ensue, where retro-moderators battle it out for the
12793 sympathy of the people, luring them to use their score files on false
12794 premises!  Yay!  The net is saved!
12795
12796 Here are some tips for the would-be retro-moderator, off the top of my
12797 head: 
12798
12799 @itemize @bullet
12800
12801 @item 
12802 Articles heavily crossposted are probably junk. 
12803 @item
12804 To lower a single inappropriate article, lower by @code{Message-ID}.
12805 @item
12806 Particularly brilliant authors can be raised on a permanent basis. 
12807 @item
12808 Authors that repeatedly post off-charter for the group can safely be
12809 lowered out of existence.
12810 @item
12811 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
12812 articles completely.
12813
12814 @item 
12815 Use expiring score entries to keep the size of the file down.  You
12816 should probably have a long expiry period, though, as some sites keep
12817 old articles for a long time.
12818 @end itemize
12819
12820 ... I wonder whether other newsreaders will support global score files
12821 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
12822 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
12823 holding our breath yet?
12824
12825
12826 @node Kill Files
12827 @section Kill Files
12828 @cindex kill files
12829
12830 Gnus still supports those pesky old kill files.  In fact, the kill file
12831 entries can now be expiring, which is something I wrote before Daniel
12832 Quinlan thought of doing score files, so I've left the code in there.
12833
12834 In short, kill processing is a lot slower (and I do mean @emph{a lot})
12835 than score processing, so it might be a good idea to rewrite your kill
12836 files into score files.
12837
12838 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
12839 forms into this file, which means that you can use kill files as some
12840 sort of primitive hook function to be run on group entry, even though
12841 that isn't a very good idea.
12842
12843 Normal kill files look like this:
12844
12845 @lisp
12846 (gnus-kill "From" "Lars Ingebrigtsen")
12847 (gnus-kill "Subject" "ding")
12848 (gnus-expunge "X")
12849 @end lisp
12850
12851 This will mark every article written by me as read, and remove the
12852 marked articles from the summary buffer.  Very useful, you'll agree.
12853
12854 Other programs use a totally different kill file syntax.  If Gnus
12855 encounters what looks like a @code{rn} kill file, it will take a stab at
12856 interpreting it. 
12857
12858 Two summary functions for editing a GNUS kill file:
12859
12860 @table @kbd
12861
12862 @item M-k
12863 @kindex M-k (Summary)
12864 @findex gnus-summary-edit-local-kill
12865 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
12866
12867 @item M-K
12868 @kindex M-K (Summary)
12869 @findex gnus-summary-edit-global-kill
12870 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
12871 @end table
12872
12873 Two group mode functions for editing the kill files:
12874
12875 @table @kbd
12876
12877 @item M-k
12878 @kindex M-k (Group)
12879 @findex gnus-group-edit-local-kill
12880 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
12881
12882 @item M-K
12883 @kindex M-K (Group)
12884 @findex gnus-group-edit-global-kill
12885 Edit the general kill file (@code{gnus-group-edit-global-kill}).
12886 @end table
12887
12888 Kill file variables:
12889
12890 @table @code
12891 @item gnus-kill-file-name
12892 @vindex gnus-kill-file-name
12893 A kill file for the group @samp{soc.motss} is normally called
12894 @file{soc.motss.KILL}.  The suffix appended to the group name to get
12895 this file name is detailed by the @code{gnus-kill-file-name} variable.
12896 The ``global'' kill file (not in the score file sense of ``global'', of
12897 course) is just called @file{KILL}.
12898
12899 @vindex gnus-kill-save-kill-file
12900 @item gnus-kill-save-kill-file
12901 If this variable is non-@code{nil}, Gnus will save the
12902 kill file after processing, which is necessary if you use expiring
12903 kills. 
12904
12905 @item gnus-apply-kill-hook
12906 @vindex gnus-apply-kill-hook
12907 @findex gnus-apply-kill-file-unless-scored
12908 @findex gnus-apply-kill-file
12909 A hook called to apply kill files to a group.  It is
12910 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
12911 kill file if you have a score file for the same group, you can set this
12912 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
12913 kill files to be processed, you should set this variable to @code{nil}.
12914
12915 @item gnus-kill-file-mode-hook
12916 @vindex gnus-kill-file-mode-hook
12917 A hook called in kill-file mode buffers.
12918
12919 @end table
12920
12921
12922 @node Converting Kill Files
12923 @section Converting Kill Files
12924 @cindex kill files
12925 @cindex converting kill files
12926
12927 If you have loads of old kill files, you may want to convert them into
12928 score files.  If they are ``regular'', you can use
12929 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
12930 by hand.
12931
12932 The kill to score conversion package isn't included in Gnus by default.
12933 You can fetch it from
12934 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
12935
12936 If your old kill files are very complex---if they contain more
12937 non-@code{gnus-kill} forms than not, you'll have to convert them by
12938 hand.  Or just let them be as they are.  Gnus will still use them as
12939 before. 
12940
12941
12942 @node GroupLens
12943 @section GroupLens
12944 @cindex GroupLens
12945
12946 GroupLens is a collaborative filtering system that helps you work
12947 together with other people to find the quality news articles out of the
12948 huge volume of news articles generated every day.
12949
12950 To accomplish this the GroupLens system combines your opinions about
12951 articles you have already read with the opinions of others who have done
12952 likewise and gives you a personalized prediction for each unread news
12953 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
12954 rate articles, and finds other people that rate articles the same way.
12955 Once it has found some people you agree with it tells you, in the form
12956 of a prediction, what they thought of the article.  You can use this
12957 prediction to help you decide whether or not you want to read the
12958 article.
12959
12960 @menu
12961 * Using GroupLens::          How to make Gnus use GroupLens.
12962 * Rating Articles::          Letting GroupLens know how you rate articles.
12963 * Displaying Predictions::   Displaying predictions given by GroupLens.
12964 * GroupLens Variables::      Customizing GroupLens.
12965 @end menu
12966
12967
12968 @node Using GroupLens
12969 @subsection Using GroupLens
12970
12971 To use GroupLens you must register a pseudonym with your local Better
12972 Bit Bureau (BBB).
12973 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
12974 better bit in town at the moment.
12975
12976 Once you have registered you'll need to set a couple of variables.
12977
12978 @table @code
12979
12980 @item gnus-use-grouplens
12981 @vindex gnus-use-grouplens
12982 Setting this variable to a non-@code{nil} value will make Gnus hook into
12983 all the relevant GroupLens functions.
12984
12985 @item grouplens-pseudonym
12986 @vindex grouplens-pseudonym
12987 This variable should be set to the pseudonym you got when registering
12988 with the Better Bit Bureau.
12989
12990 @item grouplens-newsgroups
12991 @vindex grouplens-newsgroups
12992 A list of groups that you want to get GroupLens predictions for. 
12993
12994 @end table
12995
12996 That's the minimum of what you need to get up and running with GroupLens.
12997 Once you've registered, GroupLens will start giving you scores for
12998 articles based on the average of what other people think.  But, to get
12999 the real benefit of GroupLens you need to start rating articles
13000 yourself.  Then the scores GroupLens gives you will be personalized for
13001 you, based on how the people you usually agree with have already rated.
13002
13003
13004 @node Rating Articles
13005 @subsection Rating Articles
13006
13007 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
13008 Where 1 means something like this article is a waste of bandwidth and 5
13009 means that the article was really good.  The basic question to ask
13010 yourself is, "on a scale from 1 to 5 would I like to see more articles
13011 like this one?"
13012
13013 There are four ways to enter a rating for an article in GroupLens.
13014
13015 @table @kbd
13016
13017 @item r
13018 @kindex r (GroupLens)
13019 @findex bbb-summary-rate-article
13020 This function will prompt you for a rating on a scale of one to five.
13021
13022 @item k
13023 @kindex k (GroupLens)
13024 @findex grouplens-score-thread
13025 This function will prompt you for a rating, and rate all the articles in
13026 the thread.  This is really useful for some of those long running giant
13027 threads in rec.humor.
13028
13029 @end table
13030
13031 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13032 the score of the article you're reading.
13033
13034 @table @kbd
13035
13036 @item 1-5 n
13037 @kindex n (GroupLens)
13038 @findex grouplens-next-unread-article
13039 Rate the article and go to the next unread article.
13040
13041 @item 1-5 ,
13042 @kindex , (GroupLens)
13043 @findex grouplens-best-unread-article
13044 Rate the article and go to the next unread article with the highest score.
13045
13046 @end table
13047
13048 If you want to give the current article a score of 4 and then go to the
13049 next article, just type @kbd{4 n}.
13050
13051
13052 @node Displaying Predictions
13053 @subsection Displaying Predictions
13054
13055 GroupLens makes a prediction for you about how much you will like a
13056 news article.  The predictions from GroupLens are on a scale from 1 to
13057 5, where 1 is the worst and 5 is the best.  You can use the predictions
13058 from GroupLens in one of three ways controlled by the variable
13059 @code{gnus-grouplens-override-scoring}.
13060
13061 @vindex gnus-grouplens-override-scoring
13062 There are three ways to display predictions in grouplens.  You may
13063 choose to have the GroupLens scores contribute to, or override the
13064 regular gnus scoring mechanism. override is the default; however, some
13065 people prefer to see the Gnus scores plus the grouplens scores.  To get
13066 the separate scoring behavior you need to set
13067 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
13068 GroupLens predictions combined with the grouplens scores set it to
13069 @code{'override} and to combine the scores set
13070 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
13071 the combine option you will also want to set the values for
13072 @code{grouplens-prediction-offset} and
13073 @code{grouplens-score-scale-factor}.
13074
13075 @vindex grouplens-prediction-display
13076 In either case, GroupLens gives you a few choices for how you would like
13077 to see your predictions displayed.  The display of predictions is
13078 controlled by the @code{grouplens-prediction-display} variable.
13079
13080 The following are valid values for that variable.
13081
13082 @table @code
13083 @item prediction-spot
13084 The higher the prediction, the further to the right an @samp{*} is
13085 displayed. 
13086
13087 @item confidence-interval
13088 A numeric confidence interval.
13089
13090 @item prediction-bar
13091 The higher the prediction, the longer the bar.
13092
13093 @item confidence-bar
13094 Numerical confidence.
13095
13096 @item confidence-spot
13097 The spot gets bigger with more confidence.
13098
13099 @item prediction-num
13100 Plain-old numeric value.
13101
13102 @item confidence-plus-minus
13103 Prediction +/- confidence.
13104
13105 @end table
13106
13107
13108 @node GroupLens Variables
13109 @subsection GroupLens Variables
13110
13111 @table @code
13112
13113 @item gnus-summary-grouplens-line-format
13114 The summary line format used in GroupLens-enhanced summary buffers.  It
13115 accepts the same specs as the normal summary line format (@pxref{Summary
13116 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
13117 %s\n}.
13118
13119 @item grouplens-bbb-host
13120 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
13121 default.
13122
13123 @item grouplens-bbb-port
13124 Port of the host running the bbbd server.  The default is 9000.
13125
13126 @item grouplens-score-offset
13127 Offset the prediction by this value.  In other words, subtract the
13128 prediction value by this number to arrive at the effective score.  The
13129 default is 0.
13130
13131 @item grouplens-score-scale-factor 
13132 This variable allows the user to magnify the effect of GroupLens scores.
13133 The scale factor is applied after the offset.  The default is 1.
13134
13135 @end table
13136
13137
13138 @node Advanced Scoring
13139 @section Advanced Scoring
13140
13141 Scoring on Subjects and From headers is nice enough, but what if you're
13142 really interested in what a person has to say only when she's talking
13143 about a particular subject?  Or what if you really don't want to
13144 read what person A has to say when she's following up to person B, but
13145 want to read what she says when she's following up to person C?
13146
13147 By using advanced scoring rules you may create arbitrarily complex
13148 scoring patterns.
13149
13150 @menu
13151 * Advanced Scoring Syntax::     A definition.
13152 * Advanced Scoring Examples::   What they look like.
13153 * Advanced Scoring Tips::       Getting the most out of it.
13154 @end menu
13155
13156
13157 @node Advanced Scoring Syntax
13158 @subsection Advanced Scoring Syntax
13159
13160 Ordinary scoring rules have a string as the first element in the rule.
13161 Advanced scoring rules have a list as the first element.  The second
13162 element is the score to be applied if the first element evaluated to a
13163 non-@code{nil} value.
13164
13165 These lists may consist of three logical operators, one redirection
13166 operator, and various match operators.
13167
13168 Logical operators:
13169
13170 @table @code
13171 @item &
13172 @itemx and
13173 This logical operator will evaluate each of its arguments until it finds
13174 one that evaluates to @code{false}, and then it'll stop.  If all arguments
13175 evaluate to @code{true} values, then this operator will return
13176 @code{true}. 
13177
13178 @item |
13179 @itemx or
13180 This logical operator will evaluate each of its arguments until it finds
13181 one that evaluates to @code{true}.  If no arguments are @code{true},
13182 then this operator will return @code{false}.
13183
13184 @item !
13185 @itemx not
13186 @itemx Â¬
13187 This logical operator only takes a single argument.  It returns the
13188 logical negation of the value of its argument.
13189
13190 @end table
13191
13192 There is an @dfn{indirection operator} that will make its arguments
13193 apply to the ancestors of the current article being scored.  For
13194 instance, @code{1-} will make score rules apply to the parent of the
13195 current article.  @code{2-} will make score rules apply to the
13196 grandparent of the current article.  Alternatively, you can write
13197 @code{^^}, where the number of @code{^}s (carets) says how far back into
13198 the ancestry you want to go.
13199
13200 Finally, we have the match operators.  These are the ones that do the
13201 real work.  Match operators are header name strings followed by a match
13202 and a match type.  A typical match operator looks like @samp{("from"
13203 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
13204 simple scoring, and the match types are also the same.
13205
13206
13207 @node Advanced Scoring Examples
13208 @subsection Advanced Scoring Examples
13209
13210 Let's say you want to increase the score of articles written by Lars
13211 when he's talking about Gnus:
13212
13213 @example
13214 ((& 
13215   ("from" "Lars Ingebrigtsen")
13216   ("subject" "Gnus"))
13217  1000)
13218 @end example
13219
13220 Quite simple, huh?
13221
13222 When he writes long articles, he sometimes has something nice to say: 
13223
13224 @example
13225 ((& 
13226   ("from" "Lars Ingebrigtsen")
13227   (|
13228    ("subject" "Gnus")
13229    ("lines" 100 >)))
13230  1000)
13231 @end example
13232
13233 However, when he responds to things written by Reig Eigil Logge, you
13234 really don't want to read what he's written:
13235
13236 @example
13237 ((&
13238   ("from" "Lars Ingebrigtsen")
13239   (1- ("from" "Reig Eigir Logge")))
13240  -100000)
13241 @end example
13242
13243 Everybody that follows up Redmondo when he writes about disappearing
13244 socks should have their scores raised, but only when they talk about
13245 white socks.  However, when Lars talks about socks, it's usually not
13246 very interesting:
13247
13248 @example
13249 ((&
13250   (1-
13251    (&
13252     ("from" "redmondo@@.*no" r)
13253     ("body" "disappearing.*socks" t)))
13254   (! ("from" "Lars Ingebrigtsen"))
13255   ("body" "white.*socks"))
13256  1000)
13257 @end example
13258
13259 The possibilities are endless.
13260
13261
13262 @node Advanced Scoring Tips
13263 @subsection Advanced Scoring Tips
13264
13265 The @code{&} and @code{|} logical operators do short-circuit logic.
13266 That is, they stop processing their arguments when it's clear what the
13267 result of the operation will be.  For instance, if one of the arguments
13268 of an @code{&} evaluates to @code{false}, there's no point in evaluating
13269 the rest of the arguments.  This means that you should put slow matches
13270 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
13271 @samp{subject}) first.
13272
13273 The indirection arguments (@code{1-} and so on) will make their
13274 arguments work on previous generations of the thread.  If you say
13275 something like:
13276
13277 @example
13278 ...
13279 (1-
13280  (1-
13281   ("from" "lars")))
13282 ...
13283 @end example
13284
13285 Then that means "score on the from header of the grandparent of the
13286 current article".  An indirection is quite fast, but it's better to say:
13287
13288 @example
13289 (1-
13290  (& 
13291   ("from" "Lars")
13292   ("subject" "Gnus")))
13293 @end example
13294
13295 than it is to say:
13296
13297 @example
13298 (&
13299  (1- ("from" "Lars"))
13300  (1- ("subject" "Gnus")))
13301 @end example
13302
13303
13304 @node Score Decays
13305 @section Score Decays
13306 @cindex score decays
13307 @cindex decays
13308
13309 You may find that your scores have a tendency to grow without
13310 bounds, especially if you're using adaptive scoring.  If scores get too
13311 big, they lose all meaning---they simply max out and it's difficult to
13312 use them in any sensible way.
13313
13314 @vindex gnus-decay-scores
13315 @findex gnus-decay-score
13316 @vindex gnus-score-decay-function
13317 Gnus provides a mechanism for decaying scores to help with this problem.
13318 When score files are loaded and @code{gnus-decay-scores} is
13319 non-@code{nil}, Gnus will run the score files through the decaying
13320 mechanism thereby lowering the scores of all non-permanent score rules.
13321 The decay itself if performed by the @code{gnus-score-decay-function}
13322 function, which is @code{gnus-decay-score} by default.  Here's the
13323 definition of that function:
13324
13325 @lisp
13326 (defun gnus-decay-score (score)
13327   "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'."
13328   (floor
13329    (- score
13330       (* (if (< score 0) 1 -1)
13331          (min (abs score)
13332               (max gnus-score-decay-constant
13333                    (* (abs score)
13334                       gnus-score-decay-scale)))))))
13335 @end lisp
13336
13337 @vindex gnus-score-decay-scale
13338 @vindex gnus-score-decay-constant
13339 @code{gnus-score-decay-constant} is 3 by default and
13340 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
13341
13342 @enumerate
13343 @item
13344 Scores between -3 and 3 will be set to 0 when this function is called.
13345
13346 @item
13347 Scores with magnitudes between 3 and 60 will be shrunk by 3.
13348
13349 @item
13350 Scores with magnitudes greater than 60 will be shrunk by 5% of the
13351 score.
13352 @end enumerate
13353
13354 If you don't like this decay function, write your own.  It is called
13355 with the score to be decayed as its only parameter, and it should return
13356 the new score, which should be an integer.
13357
13358 Gnus will try to decay scores once a day.  If you haven't run Gnus for
13359 four days, Gnus will decay the scores four times, for instance.
13360
13361
13362 @node Various
13363 @chapter Various
13364
13365 @menu
13366 * Process/Prefix::             A convention used by many treatment commands.
13367 * Interactive::                Making Gnus ask you many questions.
13368 * Symbolic Prefixes::          How to supply some Gnus functions with options.
13369 * Formatting Variables::       You can specify what buffers should look like.
13370 * Windows Configuration::      Configuring the Gnus buffer windows.
13371 * Faces and Fonts::            How to change how faces look.
13372 * Compilation::                How to speed Gnus up.
13373 * Mode Lines::                 Displaying information in the mode lines.
13374 * Highlighting and Menus::     Making buffers look all nice and cozy.
13375 * Buttons::                    Get tendonitis in ten easy steps!
13376 * Daemons::                    Gnus can do things behind your back.
13377 * NoCeM::                      How to avoid spam and other fatty foods.
13378 * Undo::                       Some actions can be undone.
13379 * Moderation::                 What to do if you're a moderator.
13380 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
13381 * Fuzzy Matching::             What's the big fuzz?
13382 * Thwarting Email Spam::       A how-to on avoiding unsolited commercial email.
13383 * Various Various::            Things that are really various.
13384 @end menu
13385
13386
13387 @node Process/Prefix
13388 @section Process/Prefix
13389 @cindex process/prefix convention
13390
13391 Many functions, among them functions for moving, decoding and saving
13392 articles, use what is known as the @dfn{Process/Prefix convention}.
13393
13394 This is a method for figuring out what articles the user wants the
13395 command to be performed on.
13396
13397 It goes like this:
13398
13399 If the numeric prefix is N, perform the operation on the next N
13400 articles, starting with the current one.  If the numeric prefix is
13401 negative, perform the operation on the previous N articles, starting
13402 with the current one.
13403
13404 @vindex transient-mark-mode
13405 If @code{transient-mark-mode} in non-@code{nil} and the region is
13406 active, all articles in the region will be worked upon.
13407
13408 If there is no numeric prefix, but some articles are marked with the
13409 process mark, perform the operation on the articles marked with
13410 the process mark.
13411
13412 If there is neither a numeric prefix nor any articles marked with the
13413 process mark, just perform the operation on the current article.
13414
13415 Quite simple, really, but it needs to be made clear so that surprises
13416 are avoided.
13417
13418 Commands that react to the process mark will push the current list of
13419 process marked articles onto a stack and will then clear all process
13420 marked articles.  You can restore the previous configuration with the
13421 @kbd{M P y} command (@pxref{Setting Process Marks}).
13422
13423 @vindex gnus-summary-goto-unread
13424 One thing that seems to shock & horrify lots of people is that, for
13425 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
13426 Since each @kbd{d} (which marks the current article as read) by default
13427 goes to the next unread article after marking, this means that @kbd{3 d}
13428 will mark the next three unread articles as read, no matter what the
13429 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
13430 @code{nil} for a more straightforward action.
13431
13432
13433 @node Interactive
13434 @section Interactive
13435 @cindex interaction
13436
13437 @table @code
13438
13439 @item gnus-novice-user
13440 @vindex gnus-novice-user
13441 If this variable is non-@code{nil}, you are either a newcomer to the
13442 World of Usenet, or you are very cautious, which is a nice thing to be,
13443 really.  You will be given questions of the type ``Are you sure you want
13444 to do this?'' before doing anything dangerous.  This is @code{t} by
13445 default.
13446
13447 @item gnus-expert-user
13448 @vindex gnus-expert-user
13449 If this variable is non-@code{nil}, you will seldom be asked any
13450 questions by Gnus.  It will simply assume you know what you're doing, no
13451 matter how strange.
13452
13453 @item gnus-interactive-catchup
13454 @vindex gnus-interactive-catchup
13455 Require confirmation before catching up a group if non-@code{nil}.  It
13456 is @code{t} by default.
13457
13458 @item gnus-interactive-exit
13459 @vindex gnus-interactive-exit
13460 Require confirmation before exiting Gnus.  This variable is @code{t} by
13461 default. 
13462 @end table
13463
13464
13465 @node Symbolic Prefixes
13466 @section Symbolic Prefixes
13467 @cindex symbolic prefixes
13468
13469 Quite a lot of Emacs commands react to the (numeric) prefix.  For
13470 instance, @kbd{C-u 4 C-f} moves point four charaters forward, and
13471 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
13472 rule of 900 to the current article.
13473
13474 This is all nice and well, but what if you want to give a command some
13475 additional information?  Well, what most commands do is interpret the
13476 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
13477 doesn't want a backup file to be created when saving the current buffer,
13478 for instance.  But what if you want to save without making a backup
13479 file, and you want Emacs to flash lights and play a nice tune at the
13480 same time?  You can't, and you're probably perfectly happy that way.
13481
13482 @kindex M-i (Summary)
13483 @findex gnus-symbolic-argument
13484 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
13485 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
13486 character typed in is the value.  You can stack as many @kbd{M-i}
13487 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
13488 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
13489 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
13490 @code{b}''.  You get the drift.
13491
13492 Typing in symbolic prefixes to commands that don't accept them doesn't
13493 hurt, but it doesn't do any good either.  Currently not many Gnus
13494 functions make use of the symbolic prefix.
13495
13496 If you're interested in how Gnus implements this, @pxref{Extended
13497 Interactive}.
13498
13499
13500 @node Formatting Variables
13501 @section Formatting Variables
13502 @cindex formatting variables
13503
13504 Throughout this manual you've probably noticed lots of variables called things like @code{gnus-group-line-format} and
13505 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
13506 output lines in the various buffers.  There's quite a lot of them.
13507 Fortunately, they all use the same syntax, so there's not that much to
13508 be annoyed by.
13509
13510 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
13511 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
13512 lots of percentages everywhere.  
13513
13514 @menu 
13515 * Formatting Basics::     A formatting variable is basically a format string.
13516 * Advanced Formatting::   Modifying output in various ways.
13517 * User-Defined Specs::    Having Gnus call your own functions.
13518 * Formatting Fonts::      Making the formatting look colorful and nice.
13519 @end menu
13520
13521 Currently Gnus uses the following formatting variables:
13522 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
13523 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
13524 @code{gnus-group-mode-line-format},
13525 @code{gnus-summary-mode-line-format},
13526 @code{gnus-article-mode-line-format},
13527 @code{gnus-server-mode-line-format}, and
13528 @code{gnus-summary-pick-line-format}.
13529
13530 All these format variables can also be arbitrary elisp forms.  In that
13531 case, they will be @code{eval}ed to insert the required lines.
13532
13533 @kindex M-x gnus-update-format
13534 @findex gnus-update-format
13535 Gnus includes a command to help you while creating your own format
13536 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
13537 update the spec in question and pop you to a buffer where you can
13538 examine the resulting lisp code to be run to generate the line.  
13539
13540
13541
13542 @node Formatting Basics
13543 @subsection Formatting Basics
13544
13545 Each @samp{%} element will be replaced by some string or other when the
13546 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
13547 spec, and pad with spaces to get a 5-character field''.
13548
13549 As with normal C and Emacs Lisp formatting strings, the numerical
13550 modifier between the @samp{%} and the formatting type character will
13551 @dfn{pad} the output so that it is always at least that long.
13552 @samp{%5y} will make the field always (at least) five characters wide by
13553 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
13554 the right instead.
13555
13556 You may also wish to limit the length of the field to protect against
13557 particularly wide values.  For that you can say @samp{%4,6y}, which
13558 means that the field will never be more than 6 characters wide and never
13559 less than 4 characters wide.
13560
13561
13562 @node Advanced Formatting
13563 @subsection Advanced Formatting
13564
13565 It is frequently useful to post-process the fields in some way.
13566 Padding, limiting, cutting off parts and suppressing certain values can
13567 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
13568 look like @samp{%~(cut 3)~(ignore "0")y}.
13569
13570 These are the valid modifiers:
13571
13572 @table @code
13573 @item pad
13574 @itemx pad-left
13575 Pad the field to the left with spaces until it reaches the required
13576 length.
13577
13578 @item pad-right
13579 Pad the field to the right with spaces until it reaches the required
13580 length.
13581
13582 @item max
13583 @itemx max-left
13584 Cut off characters from the left until it reaches the specified length.
13585
13586 @item max-right
13587 Cut off characters from the right until it reaches the specified
13588 length. 
13589
13590 @item cut
13591 @itemx cut-left
13592 Cut off the specified number of characters from the left.
13593
13594 @item cut-right
13595 Cut off the specified number of characters from the right.
13596
13597 @item ignore
13598 Return an empty string if the field is equal to the specified value. 
13599
13600 @item form
13601 Use the specified form as the field value when the @samp{@@} spec is
13602 used. 
13603 @end table
13604
13605 Let's take an example.  The @samp{%o} spec in the summary mode lines
13606 will return a date in compact ISO8601 format---@samp{19960809T230410}.
13607 This is quite a mouthful, so we want to shave off the century number and
13608 the time, leaving us with a six-character date.  That would be
13609 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
13610 maxing, and we need the padding to ensure that the date is never less
13611 than 6 characters to make it look nice in columns.)
13612
13613 Ignoring is done first; then cutting; then maxing; and then as the very
13614 last operation, padding.  
13615
13616 If you use lots of these advanced thingies, you'll find that Gnus gets
13617 quite slow.  This can be helped enormously by running @kbd{M-x
13618 gnus-compile} when you are satisfied with the look of your lines.
13619 @xref{Compilation}. 
13620
13621
13622 @node User-Defined Specs
13623 @subsection User-Defined Specs
13624
13625 All the specs allow for inserting user defined specifiers---@samp{u}.
13626 The next character in the format string should be a letter.  Gnus
13627 will call the function @code{gnus-user-format-function-}@samp{X}, where
13628 @samp{X} is the letter following @samp{%u}.  The function will be passed
13629 a single parameter---what the parameter means depends on what buffer
13630 it's being called from.  The function should return a string, which will
13631 be inserted into the buffer just like information from any other
13632 specifier.  This function may also be called with dummy values, so it
13633 should protect against that.
13634
13635 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
13636 much the same without defining new functions.  Here's an example:
13637 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
13638 given here will be evaluated to yield the current line number, and then
13639 inserted.
13640
13641
13642 @node Formatting Fonts
13643 @subsection Formatting Fonts
13644
13645 There are specs for highlighting, and these are shared by all the format
13646 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
13647 the special @code{mouse-face} property set, which means that it will be
13648 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
13649 over it.
13650
13651 Text inside the @samp{%[} and @samp{%]} specifiers will have their
13652 normal faces set using @code{gnus-face-0}, which is @code{bold} by
13653 default.  If you say @samp{%1[}, you'll get @code{gnus-face-1} instead,
13654 and so on.  Create as many faces as you wish.  The same goes for the
13655 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
13656 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
13657
13658 Here's an alternative recipe for the group buffer:
13659
13660 @lisp
13661 ;; Create three face types.
13662 (setq gnus-face-1 'bold)
13663 (setq gnus-face-3 'italic)
13664
13665 ;; We want the article count to be in 
13666 ;; a bold and green face.  So we create 
13667 ;; a new face called `my-green-bold'.
13668 (copy-face 'bold 'my-green-bold)
13669 ;; Set the color.
13670 (set-face-foreground 'my-green-bold "ForestGreen")
13671 (setq gnus-face-2 'my-green-bold)
13672
13673 ;; Set the new & fancy format.
13674 (setq gnus-group-line-format 
13675       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
13676 @end lisp
13677
13678 I'm sure you'll be able to use this scheme to create totally unreadable
13679 and extremely vulgar displays.  Have fun!
13680
13681 Note that the @samp{%(} specs (and friends) do not make any sense on the
13682 mode-line variables.
13683
13684
13685 @node Windows Configuration
13686 @section Windows Configuration
13687 @cindex windows configuration
13688
13689 No, there's nothing here about X, so be quiet.
13690
13691 @vindex gnus-use-full-window
13692 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
13693 other windows and occupy the entire Emacs screen by itself.  It is
13694 @code{t} by default.
13695
13696 @vindex gnus-buffer-configuration
13697 @code{gnus-buffer-configuration} describes how much space each Gnus
13698 buffer should be given.  Here's an excerpt of this variable:
13699
13700 @lisp
13701 ((group (vertical 1.0 (group 1.0 point)
13702                       (if gnus-carpal (group-carpal 4))))
13703  (article (vertical 1.0 (summary 0.25 point) 
13704                         (article 1.0))))
13705 @end lisp
13706
13707 This is an alist.  The @dfn{key} is a symbol that names some action or
13708 other.  For instance, when displaying the group buffer, the window
13709 configuration function will use @code{group} as the key.  A full list of
13710 possible names is listed below.
13711
13712 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
13713 should occupy.  To take the @code{article} split as an example -
13714
13715 @lisp
13716 (article (vertical 1.0 (summary 0.25 point)
13717                        (article 1.0)))
13718 @end lisp
13719
13720 This @dfn{split} says that the summary buffer should occupy 25% of upper
13721 half of the screen, and that it is placed over the article buffer.  As
13722 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
13723 reaching for that calculator there).  However, the special number
13724 @code{1.0} is used to signal that this buffer should soak up all the
13725 rest of the space available after the rest of the buffers have taken
13726 whatever they need.  There should be only one buffer with the @code{1.0}
13727 size spec per split.
13728
13729 Point will be put in the buffer that has the optional third element
13730 @code{point}. 
13731
13732 Here's a more complicated example:
13733
13734 @lisp
13735 (article (vertical 1.0 (group 4)
13736                        (summary 0.25 point)
13737                        (if gnus-carpal (summary-carpal 4))
13738                        (article 1.0)))
13739 @end lisp
13740
13741 If the size spec is an integer instead of a floating point number, 
13742 then that number will be used to say how many lines a buffer should
13743 occupy, not a percentage.
13744
13745 If the @dfn{split} looks like something that can be @code{eval}ed (to be
13746 precise---if the @code{car} of the split is a function or a subr), this
13747 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
13748 be used as a split.  This means that there will be three buffers if
13749 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
13750 is non-@code{nil}.
13751
13752 Not complicated enough for you?  Well, try this on for size:
13753
13754 @lisp
13755 (article (horizontal 1.0 
13756              (vertical 0.5
13757                  (group 1.0)
13758                  (gnus-carpal 4))
13759              (vertical 1.0
13760                  (summary 0.25 point)
13761                  (summary-carpal 4)
13762                  (article 1.0))))
13763 @end lisp
13764
13765 Whoops.  Two buffers with the mystery 100% tag.  And what's that
13766 @code{horizontal} thingie?  
13767
13768 If the first element in one of the split is @code{horizontal}, Gnus will
13769 split the window horizontally, giving you two windows side-by-side.
13770 Inside each of these strips you may carry on all you like in the normal
13771 fashion.  The number following @code{horizontal} says what percentage of
13772 the screen is to be given to this strip.
13773
13774 For each split, there @emph{must} be one element that has the 100% tag.
13775 The splitting is never accurate, and this buffer will eat any leftover
13776 lines from the splits.
13777
13778 To be slightly more formal, here's a definition of what a valid split
13779 may look like:
13780
13781 @example
13782 split       = frame | horizontal | vertical | buffer | form
13783 frame       = "(frame " size *split ")"
13784 horizontal  = "(horizontal " size *split ")"
13785 vertical    = "(vertical " size *split ")"
13786 buffer      = "(" buffer-name " " size *[ "point" ] ")"
13787 size        = number | frame-params
13788 buffer-name = group | article | summary ...
13789 @end example
13790
13791 The limitations are that the @code{frame} split can only appear as the
13792 top-level split.  @var{form} should be an Emacs Lisp form that should
13793 return a valid split.  We see that each split is fully recursive, and
13794 may contain any number of @code{vertical} and @code{horizontal} splits. 
13795
13796 @vindex gnus-window-min-width
13797 @vindex gnus-window-min-height
13798 @cindex window height
13799 @cindex window width
13800 Finding the right sizes can be a bit complicated.  No window may be less
13801 than @code{gnus-window-min-height} (default 1) characters high, and all
13802 windows must be at least @code{gnus-window-min-width} (default 1)
13803 characters wide.  Gnus will try to enforce this before applying the
13804 splits.  If you want to use the normal Emacs window width/height limit,
13805 you can just set these two variables to @code{nil}.
13806
13807 If you're not familiar with Emacs terminology, @code{horizontal} and
13808 @code{vertical} splits may work the opposite way of what you'd expect.
13809 Windows inside a @code{horizontal} split are shown side-by-side, and
13810 windows within a @code{vertical} split are shown above each other.
13811
13812 @findex gnus-configure-frame
13813 If you want to experiment with window placement, a good tip is to call
13814 @code{gnus-configure-frame} directly with a split.  This is the function
13815 that does all the real work when splitting buffers.  Below is a pretty
13816 nonsensical configuration with 5 windows; two for the group buffer and
13817 three for the article buffer.  (I said it was nonsensical.)  If you
13818 @code{eval} the statement below, you can get an idea of how that would
13819 look straight away, without going through the normal Gnus channels.
13820 Play with it until you're satisfied, and then use
13821 @code{gnus-add-configuration} to add your new creation to the buffer
13822 configuration list. 
13823
13824 @lisp
13825 (gnus-configure-frame
13826  '(horizontal 1.0
13827     (vertical 10
13828       (group 1.0)
13829       (article 0.3 point))
13830     (vertical 1.0
13831       (article 1.0)
13832       (horizontal 4
13833         (group 1.0)
13834         (article 10)))))
13835 @end lisp
13836
13837 You might want to have several frames as well.  No prob---just use the
13838 @code{frame} split:
13839
13840 @lisp
13841 (gnus-configure-frame
13842  '(frame 1.0
13843          (vertical 1.0
13844                    (summary 0.25 point)
13845                    (article 1.0))
13846          (vertical ((height . 5) (width . 15)
13847                     (user-position . t)
13848                     (left . -1) (top . 1))
13849                    (picon 1.0))))
13850
13851 @end lisp
13852
13853 This split will result in the familiar summary/article window
13854 configuration in the first (or ``main'') frame, while a small additional
13855 frame will be created where picons will be shown.  As you can see,
13856 instead of the normal @code{1.0} top-level spec, each additional split
13857 should have a frame parameter alist as the size spec.
13858 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
13859 Reference Manual}.  Under XEmacs, a frame property list will be
13860 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
13861 is such a plist.
13862
13863 Here's a list of all possible keys for
13864 @code{gnus-buffer-configuration}:
13865
13866 @code{group}, @code{summary}, @code{article}, @code{server},
13867 @code{browse}, @code{message}, @code{pick}, @code{info},
13868 @code{summary-faq}, @code{edit-group}, @code{edit-server},
13869 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
13870 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
13871 @code{bug}, @code{compose-bounce}, and @code{score-trace}.
13872
13873 Note that the @code{message} key is used for both
13874 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
13875 it is desirable to distinguish between the two, something like this
13876 might be used:
13877
13878 @lisp
13879 (message (horizontal 1.0
13880                      (vertical 1.0 (message 1.0 point))
13881                      (vertical 0.24
13882                                (if (buffer-live-p gnus-summary-buffer)
13883                                    '(summary 0.5))
13884                                (group 1.0)))))
13885 @end lisp
13886
13887 @findex gnus-add-configuration
13888 Since the @code{gnus-buffer-configuration} variable is so long and
13889 complicated, there's a function you can use to ease changing the config
13890 of a single setting: @code{gnus-add-configuration}.  If, for instance,
13891 you want to change the @code{article} setting, you could say:
13892
13893 @lisp
13894 (gnus-add-configuration
13895  '(article (vertical 1.0
13896                (group 4)
13897                (summary .25 point)
13898                (article 1.0))))
13899 @end lisp
13900
13901 You'd typically stick these @code{gnus-add-configuration} calls in your
13902 @file{.gnus.el} file or in some startup hook---they should be run after
13903 Gnus has been loaded.
13904
13905 @vindex gnus-always-force-window-configuration
13906 If all windows mentioned in the configuration are already visible, Gnus
13907 won't change the window configuration.  If you always want to force the
13908 ``right'' window configuration, you can set
13909 @code{gnus-always-force-window-configuration} to non-@code{nil}.
13910
13911
13912 @node Faces and Fonts
13913 @section Faces and Fonts
13914 @cindex faces
13915 @cindex fonts
13916 @cindex colors
13917
13918 Fiddling with fonts and faces used to be very difficult, but these days
13919 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
13920 the face you want to alter, and alter it via the standard Customize
13921 interface.  
13922
13923
13924 @node Compilation
13925 @section Compilation
13926 @cindex compilation
13927 @cindex byte-compilation
13928
13929 @findex gnus-compile
13930
13931 Remember all those line format specification variables?
13932 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
13933 on.  Now, Gnus will of course heed whatever these variables are, but,
13934 unfortunately, changing them will mean a quite significant slow-down.
13935 (The default values of these variables have byte-compiled functions
13936 associated with them, while the user-generated versions do not, of
13937 course.) 
13938
13939 To help with this, you can run @kbd{M-x gnus-compile} after you've
13940 fiddled around with the variables and feel that you're (kind of)
13941 satisfied.  This will result in the new specs being byte-compiled, and
13942 you'll get top speed again.  Gnus will save these compiled specs in the
13943 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
13944 this function, though---you should compile them yourself by sticking
13945 them into the @code{.gnus.el} file and byte-compiling that file.)
13946
13947
13948 @node Mode Lines
13949 @section Mode Lines
13950 @cindex mode lines
13951
13952 @vindex gnus-updated-mode-lines
13953 @code{gnus-updated-mode-lines} says what buffers should keep their mode
13954 lines updated.  It is a list of symbols.  Supported symbols include
13955 @code{group}, @code{article}, @code{summary}, @code{server},
13956 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
13957 Gnus will keep that mode line updated with information that may be
13958 pertinent.  If this variable is @code{nil}, screen refresh may be
13959 quicker.
13960
13961 @cindex display-time
13962
13963 @vindex gnus-mode-non-string-length
13964 By default, Gnus displays information on the current article in the mode
13965 lines of the summary and article buffers.  The information Gnus wishes
13966 to display (e.g. the subject of the article) is often longer than the
13967 mode lines, and therefore have to be cut off at some point.  The
13968 @code{gnus-mode-non-string-length} variable says how long the other
13969 elements on the line is (i.e., the non-info part).  If you put
13970 additional elements on the mode line (e.g. a clock), you should modify
13971 this variable:
13972
13973 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
13974 @lisp
13975 (add-hook 'display-time-hook
13976           (lambda () (setq gnus-mode-non-string-length
13977                            (+ 21
13978                               (if line-number-mode 5 0)
13979                               (if column-number-mode 4 0)
13980                               (length display-time-string)))))
13981 @end lisp
13982
13983 If this variable is @code{nil} (which is the default), the mode line
13984 strings won't be chopped off, and they won't be padded either.  Note
13985 that the default is unlikely to be desirable, as even the percentage
13986 complete in the buffer may be crowded off the mode line; the user should
13987 configure this variable appropriately for her configuration.
13988
13989
13990 @node Highlighting and Menus
13991 @section Highlighting and Menus
13992 @cindex visual
13993 @cindex highlighting
13994 @cindex menus
13995
13996 @vindex gnus-visual
13997 The @code{gnus-visual} variable controls most of the Gnus-prettifying
13998 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
13999 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
14000 file.
14001
14002 This variable can be a list of visual properties that are enabled.  The
14003 following elements are valid, and are all included by default:
14004
14005 @table @code
14006 @item group-highlight
14007 Do highlights in the group buffer.
14008 @item summary-highlight
14009 Do highlights in the summary buffer.
14010 @item article-highlight
14011 Do highlights in the article buffer.
14012 @item highlight
14013 Turn on highlighting in all buffers.
14014 @item group-menu
14015 Create menus in the group buffer.
14016 @item summary-menu
14017 Create menus in the summary buffers.
14018 @item article-menu
14019 Create menus in the article buffer.
14020 @item browse-menu
14021 Create menus in the browse buffer.
14022 @item server-menu
14023 Create menus in the server buffer.
14024 @item score-menu
14025 Create menus in the score buffers.
14026 @item menu
14027 Create menus in all buffers.
14028 @end table
14029
14030 So if you only want highlighting in the article buffer and menus in all
14031 buffers, you could say something like:
14032
14033 @lisp
14034 (setq gnus-visual '(article-highlight menu))
14035 @end lisp
14036
14037 If you want highlighting only and no menus whatsoever, you'd say:
14038
14039 @lisp
14040 (setq gnus-visual '(highlight))
14041 @end lisp
14042
14043 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14044 in all Gnus buffers.
14045
14046 Other general variables that influence the look of all buffers include:
14047
14048 @table @code
14049 @item gnus-mouse-face
14050 @vindex gnus-mouse-face
14051 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
14052 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
14053
14054 @end table
14055
14056 There are hooks associated with the creation of all the different menus:
14057
14058 @table @code
14059
14060 @item gnus-article-menu-hook
14061 @vindex gnus-article-menu-hook
14062 Hook called after creating the article mode menu.
14063
14064 @item gnus-group-menu-hook
14065 @vindex gnus-group-menu-hook
14066 Hook called after creating the group mode menu.
14067
14068 @item gnus-summary-menu-hook
14069 @vindex gnus-summary-menu-hook
14070 Hook called after creating the summary mode menu.
14071
14072 @item gnus-server-menu-hook
14073 @vindex gnus-server-menu-hook
14074 Hook called after creating the server mode menu.
14075
14076 @item gnus-browse-menu-hook
14077 @vindex gnus-browse-menu-hook
14078 Hook called after creating the browse mode menu.
14079
14080 @item gnus-score-menu-hook
14081 @vindex gnus-score-menu-hook
14082 Hook called after creating the score mode menu.
14083
14084 @end table
14085
14086
14087 @node Buttons
14088 @section Buttons
14089 @cindex buttons
14090 @cindex mouse
14091 @cindex click
14092
14093 Those new-fangled @dfn{mouse} contraptions is very popular with the
14094 young, hep kids who don't want to learn the proper way to do things
14095 these days.  Why, I remember way back in the summer of '89, when I was
14096 using Emacs on a Tops 20 system.  Three hundred users on one single
14097 machine, and every user was running Simula compilers.  Bah!
14098
14099 Right.
14100
14101 @vindex gnus-carpal
14102 Well, you can make Gnus display bufferfuls of buttons you can click to
14103 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
14104 really.  Tell the chiropractor I sent you.
14105
14106
14107 @table @code
14108
14109 @item gnus-carpal-mode-hook
14110 @vindex gnus-carpal-mode-hook
14111 Hook run in all carpal mode buffers.
14112
14113 @item gnus-carpal-button-face
14114 @vindex gnus-carpal-button-face
14115 Face used on buttons.
14116
14117 @item gnus-carpal-header-face
14118 @vindex gnus-carpal-header-face
14119 Face used on carpal buffer headers.
14120
14121 @item gnus-carpal-group-buffer-buttons
14122 @vindex gnus-carpal-group-buffer-buttons
14123 Buttons in the group buffer.
14124
14125 @item gnus-carpal-summary-buffer-buttons
14126 @vindex gnus-carpal-summary-buffer-buttons
14127 Buttons in the summary buffer.
14128
14129 @item gnus-carpal-server-buffer-buttons
14130 @vindex gnus-carpal-server-buffer-buttons
14131 Buttons in the server buffer.
14132
14133 @item gnus-carpal-browse-buffer-buttons
14134 @vindex gnus-carpal-browse-buffer-buttons
14135 Buttons in the browse buffer.
14136 @end table
14137
14138 All the @code{buttons} variables are lists.  The elements in these list
14139 are either cons cells where the @code{car} contains a text to be displayed and
14140 the @code{cdr} contains a function symbol, or a simple string.
14141
14142
14143 @node Daemons
14144 @section Daemons
14145 @cindex demons
14146 @cindex daemons
14147
14148 Gnus, being larger than any program ever written (allegedly), does lots
14149 of strange stuff that you may wish to have done while you're not
14150 present.  For instance, you may want it to check for new mail once in a
14151 while.  Or you may want it to close down all connections to all servers
14152 when you leave Emacs idle.  And stuff like that.
14153
14154 Gnus will let you do stuff like that by defining various
14155 @dfn{handlers}.  Each handler consists of three elements:  A
14156 @var{function}, a @var{time}, and an @var{idle} parameter.
14157
14158 Here's an example of a handler that closes connections when Emacs has
14159 been idle for thirty minutes:
14160
14161 @lisp
14162 (gnus-demon-close-connections nil 30)
14163 @end lisp
14164
14165 Here's a handler that scans for PGP headers every hour when Emacs is
14166 idle: 
14167
14168 @lisp
14169 (gnus-demon-scan-pgp 60 t)
14170 @end lisp
14171
14172 This @var{time} parameter and than @var{idle} parameter work together
14173 in a strange, but wonderful fashion.  Basically, if @var{idle} is
14174 @code{nil}, then the function will be called every @var{time} minutes.
14175
14176 If @var{idle} is @code{t}, then the function will be called after
14177 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
14178 the function will never be called.  But once Emacs goes idle, the
14179 function will be called every @var{time} minutes.
14180
14181 If @var{idle} is a number and @var{time} is a number, the function will
14182 be called every @var{time} minutes only when Emacs has been idle for
14183 @var{idle} minutes.
14184
14185 If @var{idle} is a number and @var{time} is @code{nil}, the function
14186 will be called once every time Emacs has been idle for @var{idle}
14187 minutes.  
14188
14189 And if @var{time} is a string, it should look like @samp{07:31}, and
14190 the function will then be called once every day somewhere near that
14191 time.  Modified by the @var{idle} parameter, of course.
14192
14193 @vindex gnus-demon-timestep
14194 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
14195 seconds.  This is 60 by default.  If you change that variable,
14196 all the timings in the handlers will be affected.)
14197
14198 @vindex gnus-use-demon
14199 To set the whole thing in motion, though, you have to set
14200 @code{gnus-use-demon} to @code{t}.
14201
14202 So, if you want to add a handler, you could put something like this in
14203 your @file{.gnus} file:
14204
14205 @findex gnus-demon-add-handler
14206 @lisp
14207 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
14208 @end lisp
14209
14210 @findex gnus-demon-add-nocem
14211 @findex gnus-demon-add-scanmail
14212 @findex gnus-demon-add-rescan
14213 @findex gnus-demon-add-scan-timestamps
14214 @findex gnus-demon-add-disconnection
14215 Some ready-made functions to do this have been created:
14216 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
14217 @code{gnus-demon-add-nntp-close-connection}, 
14218 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
14219 @code{gnus-demon-add-scanmail}.  Just put those functions in your
14220 @file{.gnus} if you want those abilities.
14221
14222 @findex gnus-demon-init
14223 @findex gnus-demon-cancel
14224 @vindex gnus-demon-handlers
14225 If you add handlers to @code{gnus-demon-handlers} directly, you should
14226 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
14227 daemons, you can use the @code{gnus-demon-cancel} function.
14228
14229 Note that adding daemons can be pretty naughty if you overdo it.  Adding
14230 functions that scan all news and mail from all servers every two seconds
14231 is a sure-fire way of getting booted off any respectable system.  So
14232 behave.
14233
14234
14235 @node NoCeM
14236 @section NoCeM
14237 @cindex nocem
14238 @cindex spam
14239
14240 @dfn{Spamming} is posting the same article lots and lots of times.
14241 Spamming is bad.  Spamming is evil.  
14242
14243 Spamming is usually canceled within a day or so by various anti-spamming
14244 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
14245 NoCeM is pronounced ``no see-'em'', and means what the name
14246 implies---these are messages that make the offending articles, like, go
14247 away.  
14248
14249 What use are these NoCeM messages if the articles are canceled anyway?
14250 Some sites do not honor cancel messages and some sites just honor cancels
14251 from a select few people.  Then you may wish to make use of the NoCeM
14252 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
14253
14254 Gnus can read and parse the messages in this group automatically, and
14255 this will make spam disappear.  
14256
14257 There are some variables to customize, of course:
14258
14259 @table @code
14260 @item gnus-use-nocem
14261 @vindex gnus-use-nocem
14262 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
14263 by default. 
14264
14265 @item gnus-nocem-groups
14266 @vindex gnus-nocem-groups
14267 Gnus will look for NoCeM messages in the groups in this list.  The
14268 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
14269 "alt.nocem.misc" "news.admin.net-abuse.announce")}. 
14270
14271 @item gnus-nocem-issuers
14272 @vindex gnus-nocem-issuers
14273 There are many people issuing NoCeM messages.  This list says what
14274 people you want to listen to.  The default is @code{("Automoose-1"
14275 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
14276 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
14277 (Richard E. Depew)")}; fine, upstanding citizens all of them.
14278
14279 Known despammers that you can put in this list include:
14280
14281 @table @samp
14282 @item clewis@@ferret.ocunix.on.ca;
14283 @cindex Chris Lewis
14284 Chris Lewis---Major Canadian despammer who has probably canceled more
14285 usenet abuse than anybody else.
14286
14287 @item Automoose-1
14288 @cindex CancelMoose[tm]
14289 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
14290 Norwegian, and was the person(s) who invented NoCeM.  
14291
14292 @item jem@@xpat.com;
14293 @cindex Jem
14294 John Milburn---despammer located in Korea who is getting very busy these
14295 days.
14296
14297 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
14298 Richard E. Depew---lone American despammer.  He mostly cancels binary
14299 postings to non-binary groups and removes spews (regurgitated articles).
14300 @end table
14301
14302 You do not have to heed NoCeM messages from all these people---just the
14303 ones you want to listen to.  You also don't have to accept all NoCeM
14304 messages from the people you like.  Each NoCeM message has a @dfn{type}
14305 header that gives the message a (more or less, usually less) rigorous
14306 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
14307 @samp{binary}, and @samp{troll}.  To specify this, you have to use
14308 @var{(issuer conditions ...)} elements in the list.  Each condition is
14309 either a string (which is a regexp that matches types you want to use)
14310 or a list on the form @code{(not STRING)}, where @var{string} is a
14311 regexp that matches types you don't want to use.
14312
14313 For instance, if you want all NoCeM messages from Chris Lewis except his
14314 @samp{troll} messages, you'd say:
14315
14316 @lisp
14317 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
14318 @end lisp
14319
14320 On the other hand, if you just want nothing but his @samp{spam} and
14321 @samp{spew} messages, you'd say:
14322
14323 @lisp
14324 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
14325 @end lisp
14326
14327 The specs are applied left-to-right.
14328
14329
14330 @item gnus-nocem-verifyer
14331 @vindex gnus-nocem-verifyer
14332 @findex mc-verify
14333 This should be a function for verifying that the NoCeM issuer is who she
14334 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
14335 function.  If this is too slow and you don't care for verification
14336 (which may be dangerous), you can set this variable to @code{nil}.
14337
14338 If you want signed NoCeM messages to be verified and unsigned messages
14339 not to be verified (but used anyway), you could do something like:
14340
14341 @lisp
14342 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
14343
14344 (defun my-gnus-mc-verify ()
14345   (not (eq 'forged
14346            (ignore-errors
14347              (if (mc-verify)
14348                  t
14349                'forged)))))
14350 @end lisp
14351
14352 This might be dangerous, though.
14353
14354 @item gnus-nocem-directory
14355 @vindex gnus-nocem-directory
14356 This is where Gnus will store its NoCeM cache files.  The default is
14357 @file{~/News/NoCeM/}. 
14358
14359 @item gnus-nocem-expiry-wait
14360 @vindex gnus-nocem-expiry-wait
14361 The number of days before removing old NoCeM entries from the cache.
14362 The default is 15.  If you make it shorter Gnus will be faster, but you
14363 might then see old spam.
14364
14365 @end table
14366
14367 Using NoCeM could potentially be a memory hog.  If you have many living
14368 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
14369 big.  If this is a problem, you should kill off all (or most) of your
14370 unsubscribed groups (@pxref{Subscription Commands}).
14371
14372
14373 @node Undo
14374 @section Undo
14375 @cindex undo
14376
14377 It is very useful to be able to undo actions one has done.  In normal
14378 Emacs buffers, it's easy enough---you just push the @code{undo} button.
14379 In Gnus buffers, however, it isn't that simple.
14380
14381 The things Gnus displays in its buffer is of no value whatsoever to
14382 Gnus---it's all just data designed to look nice to the user.
14383 Killing a group in the group buffer with @kbd{C-k} makes the line
14384 disappear, but that's just a side-effect of the real action---the
14385 removal of the group in question from the internal Gnus structures.
14386 Undoing something like that can't be done by the normal Emacs
14387 @code{undo} function.
14388
14389 Gnus tries to remedy this somewhat by keeping track of what the user
14390 does and coming up with actions that would reverse the actions the user
14391 takes.  When the user then presses the @code{undo} key, Gnus will run
14392 the code to reverse the previous action, or the previous actions.
14393 However, not all actions are easily reversible, so Gnus currently offers
14394 a few key functions to be undoable.  These include killing groups,
14395 yanking groups, and changing the list of read articles of groups.
14396 That's it, really.  More functions may be added in the future, but each
14397 added function means an increase in data to be stored, so Gnus will
14398 never be totally undoable.
14399
14400 @findex gnus-undo-mode
14401 @vindex gnus-use-undo
14402 @findex gnus-undo
14403 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
14404 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
14405 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
14406 command, which should feel kinda like the normal Emacs @code{undo}
14407 command. 
14408
14409
14410 @node Moderation
14411 @section Moderation
14412 @cindex moderation
14413
14414 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
14415 It is not included in the standard Gnus package.  Write a mail to
14416 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
14417 get a copy.
14418
14419 The moderation package is implemented as a minor mode for summary
14420 buffers.  Put
14421
14422 @lisp
14423 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
14424 @end lisp
14425
14426 in your @file{.gnus.el} file.
14427
14428 If you are the moderator of @samp{rec.zoofle}, this is how it's
14429 supposed to work:
14430
14431 @enumerate
14432 @item 
14433 You split your incoming mail by matching on
14434 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
14435 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
14436
14437 @item
14438 You enter that group once in a while and post articles using the @kbd{e}
14439 (edit-and-post) or @kbd{s} (just send unedited) commands.
14440
14441 @item
14442 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
14443 articles that weren't approved by you, you can cancel them with the
14444 @kbd{c} command.
14445 @end enumerate
14446
14447 To use moderation mode in these two groups, say:
14448
14449 @lisp
14450 (setq gnus-moderated-list
14451       "^nnml:rec.zoofle$\\|^rec.zoofle$")
14452 @end lisp
14453
14454
14455 @node XEmacs Enhancements
14456 @section XEmacs Enhancements
14457 @cindex XEmacs
14458
14459 XEmacs is able to display pictures and stuff, so Gnus has taken
14460 advantage of that.
14461
14462 @menu
14463 * Picons::    How to display pictures of what your reading.
14464 * Smileys::   Show all those happy faces the way they were meant to be shown.
14465 * Toolbar::   Click'n'drool.
14466 * XVarious::  Other XEmacsy Gnusey variables.
14467 @end menu
14468
14469
14470 @node Picons
14471 @subsection Picons
14472
14473 @iftex
14474 @iflatex
14475 \include{picons}
14476 @end iflatex
14477 @end iftex
14478
14479 So...  You want to slow down your news reader even more!  This is a
14480 good way to do so.  Its also a great way to impress people staring
14481 over your shoulder as you read news.
14482
14483 @menu
14484 * Picon Basics::           What are picons and How do I get them.
14485 * Picon Requirements::     Don't go further if you aren't using XEmacs.
14486 * Easy Picons::            Displaying Picons---the easy way.
14487 * Hard Picons::            The way you should do it.  You'll learn something.
14488 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
14489 @end menu
14490
14491
14492 @node Picon Basics
14493 @subsubsection Picon Basics
14494
14495 What are Picons?  To quote directly from the Picons Web site:
14496
14497 @iftex
14498 @iflatex
14499 \margindex{}
14500 @end iflatex
14501 @end iftex
14502
14503 @quotation 
14504 @dfn{Picons} is short for ``personal icons''.  They're small,
14505 constrained images used to represent users and domains on the net,
14506 organized into databases so that the appropriate image for a given
14507 e-mail address can be found.  Besides users and domains, there are picon
14508 databases for Usenet newsgroups and weather forecasts.  The picons are
14509 in either monochrome @code{XBM} format or color @code{XPM} and
14510 @code{GIF} formats.
14511 @end quotation
14512
14513 @vindex gnus-picons-piconsearch-url
14514 If you have a permanent connection to the Internet you can use Steve
14515 Kinzler's Picons Search engine by setting
14516 @code{gnus-picons-piconsearch-url} to the string
14517 @file{http://www.cs.indiana.edu/picons/search.html}.
14518
14519 @vindex gnus-picons-database
14520 Otherwise you need a local copy of his database.  For instructions on
14521 obtaining and installing the picons databases, point your Web browser at
14522 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
14523 picons to be installed into a location pointed to by
14524 @code{gnus-picons-database}.
14525
14526
14527 @node Picon Requirements
14528 @subsubsection Picon Requirements
14529
14530 To have Gnus display Picons for you, you must be running XEmacs
14531 19.13 or greater since all other versions of Emacs aren't yet able to
14532 display images.
14533
14534 Additionally, you must have @code{x} support compiled into XEmacs.  To
14535 display color picons which are much nicer than the black & white one,
14536 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
14537
14538 @vindex gnus-picons-convert-x-face
14539 If you want to display faces from @code{X-Face} headers, you should have
14540 the @code{xface} support compiled into XEmacs.  Otherwise you must have
14541 the @code{netpbm} utilities installed, or munge the
14542 @code{gnus-picons-convert-x-face} variable to use something else.
14543
14544
14545 @node Easy Picons
14546 @subsubsection Easy Picons
14547
14548 To enable displaying picons, simply put the following line in your
14549 @file{~/.gnus} file and start Gnus.
14550
14551 @lisp
14552 (setq gnus-use-picons t)
14553 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14554 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
14555 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
14556 @end lisp
14557
14558 and make sure @code{gnus-picons-database} points to the directory
14559 containing the Picons databases.
14560
14561 Alternatively if you want to use the web piconsearch engine add this:
14562
14563 @lisp
14564 (setq gnus-picons-piconsearch-url "http://www.cs.indiana.edu:800/piconsearch")
14565 @end lisp
14566
14567
14568 @node Hard Picons
14569 @subsubsection Hard Picons 
14570
14571 @iftex
14572 @iflatex
14573 \margindex{}
14574 @end iflatex
14575 @end iftex
14576
14577 Gnus can display picons for you as you enter and leave groups and
14578 articles.  It knows how to interact with three sections of the picons
14579 database.  Namely, it can display the picons newsgroup pictures,
14580 author's face picture(s), and the authors domain.  To enable this
14581 feature, you need to select where to get the picons from, and where to
14582 display them.
14583
14584 @table @code 
14585
14586 @item gnus-picons-database
14587 @vindex gnus-picons-database
14588 The location of the picons database.  Should point to a directory
14589 containing the @file{news}, @file{domains}, @file{users} (and so on)
14590 subdirectories.  This is only useful if
14591 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
14592 @file{/usr/local/faces/}.
14593
14594 @item gnus-picons-piconsearch-url
14595 @vindex gnus-picons-piconsearch-url
14596 The URL for the web picons search engine.  The only currently known
14597 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
14598 workaround network delays, icons will be fetched in the background.  If
14599 this is @code{nil} 'the default), then picons are fetched from local
14600 database indicated by @code{gnus-picons-database}.
14601
14602 @item gnus-picons-display-where 
14603 @vindex gnus-picons-display-where 
14604 Where the picon images should be displayed.  It is @code{picons} by
14605 default (which by default maps to the buffer @samp{*Picons*}).  Other
14606 valid places could be @code{article}, @code{summary}, or
14607 @samp{*scratch*} for all I care.  Just make sure that you've made the
14608 buffer visible using the standard Gnus window configuration
14609 routines---@pxref{Windows Configuration}.
14610
14611 @item gnus-picons-group-excluded-groups
14612 @vindex gnus-picons-group-excluded-groups
14613 Groups that are matched by this regexp won't have their group icons
14614 displayed. 
14615
14616 @end table
14617
14618 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
14619 window configuration for you to include the @code{picons} buffer.
14620
14621 Now that you've made those decision, you need to add the following
14622 functions to the appropriate hooks so these pictures will get displayed
14623 at the right time.
14624
14625 @vindex gnus-article-display-hook
14626 @vindex gnus-picons-display-where
14627 @table @code
14628 @item gnus-article-display-picons
14629 @findex gnus-article-display-picons
14630 Looks up and displays the picons for the author and the author's domain
14631 in the @code{gnus-picons-display-where} buffer.  Should be added to the
14632 @code{gnus-article-display-hook}.
14633
14634 @item gnus-group-display-picons
14635 @findex gnus-article-display-picons
14636 Displays picons representing the current group.  This function should
14637 be added to the @code{gnus-summary-prepare-hook} or to the
14638 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
14639 is set to @code{article}.
14640
14641 @item gnus-picons-article-display-x-face
14642 @findex gnus-article-display-picons
14643 Decodes and displays the X-Face header if present.  This function
14644 should be added to @code{gnus-article-display-hook}.
14645
14646 @end table
14647
14648 Note:  You must append them to the hook, so make sure to specify 't'
14649 for the append flag of @code{add-hook}:
14650
14651 @lisp
14652 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14653 @end lisp
14654
14655
14656 @node Picon Useless Configuration
14657 @subsubsection Picon Useless Configuration
14658
14659 @iftex
14660 @iflatex
14661 \margindex{}
14662 @end iflatex
14663 @end iftex
14664
14665 The following variables offer further control over how things are
14666 done, where things are located, and other useless stuff you really
14667 don't need to worry about.
14668
14669 @table @code
14670
14671 @item gnus-picons-news-directories
14672 @vindex gnus-picons-news-directories
14673 List of subdirectories to search in @code{gnus-picons-database} for
14674 newsgroups faces.  @code{("news")} is the default.
14675
14676 @item gnus-picons-user-directories
14677 @vindex gnus-picons-user-directories
14678 List of subdirectories to search in @code{gnus-picons-database} for user
14679 faces.  @code{("local" "users" "usenix" "misc")} is the default.
14680
14681 @item gnus-picons-domain-directories
14682 @vindex gnus-picons-domain-directories
14683 List of subdirectories to search in @code{gnus-picons-database} for
14684 domain name faces.  Defaults to @code{("domains")}.  Some people may
14685 want to add @samp{"unknown"} to this list.
14686
14687 @item gnus-picons-convert-x-face
14688 @vindex gnus-picons-convert-x-face
14689 If you don't have @code{xface} support builtin XEmacs, this is the
14690 command to use to convert the @code{X-Face} header to an X bitmap
14691 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
14692 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
14693 gnus-picons-x-face-file-name)}
14694
14695 @item gnus-picons-x-face-file-name
14696 @vindex gnus-picons-x-face-file-name
14697 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
14698 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
14699
14700 @item gnus-picons-has-modeline-p
14701 @vindex gnus-picons-has-modeline-p
14702 If you have set @code{gnus-picons-display-where} to @code{picons}, your
14703 XEmacs frame will become really cluttered.  To alleviate this a bit you
14704 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
14705 remove the mode line from the Picons buffer.  This is only useful if
14706 @code{gnus-picons-display-where} is @code{picons}.
14707
14708 @item gnus-picons-refresh-before-display
14709 @vindex gnus-picons-refresh-before-display
14710 If non-nil, display the article buffer before computing the picons.
14711 Defaults to @code{nil}.
14712
14713 @item gnus-picons-display-as-address
14714 @vindex gnus-picons-display-as-address
14715 If @code{t} display textual email addresses along with pictures.
14716 Defaults to @code{t}.
14717
14718 @item gnus-picons-file-suffixes
14719 @vindex gnus-picons-file-suffixes
14720 Ordered list of suffixes on picon file names to try.  Defaults to
14721 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
14722
14723 @item gnus-picons-display-article-move-p
14724 @vindex gnus-picons-display-article-move-p
14725 Whether to move point to first empty line when displaying picons.  This
14726 has only an effect if `gnus-picons-display-where' has value `article'.
14727
14728 @item gnus-picons-clear-cache-on-shutdown
14729 @vindex gnus-picons-clear-cache-on-shutdown
14730 Whether to clear the picons cache when exiting gnus.  Gnus caches every
14731 picons it finds while it is running.  This saves some time in the search
14732 process but eats some memory.  If this variable is set to @code{nil},
14733 Gnus will never clear the cache itself; you will have to manually call
14734 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
14735 cleared every time you exit Gnus.  Defaults to @code{t}.
14736
14737 @iftex
14738 @iflatex
14739 \margindex{}
14740 @end iflatex
14741 @end iftex
14742
14743 @end table
14744
14745 @node Smileys
14746 @subsection Smileys
14747 @cindex smileys
14748
14749 @iftex
14750 @iflatex
14751 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
14752 \input{smiley}
14753 @end iflatex
14754 @end iftex
14755
14756 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
14757 currently the only package that uses Smiley, it is documented here.
14758
14759 In short---to use Smiley in Gnus, put the following in your
14760 @file{.gnus.el} file:
14761
14762 @lisp
14763 (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
14764 @end lisp
14765
14766 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
14767 the like---to pictures and displays those instead of the text smiley
14768 faces.  The conversion is controlled by a list of regexps that matches
14769 text and maps that to file names.
14770
14771 @vindex smiley-nosey-regexp-alist
14772 @vindex smiley-deformed-regexp-alist
14773 Smiley supplies two example conversion alists by default:
14774 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
14775 and so on), and @code{smiley-nosey-regexp-alist} (which matches
14776 @samp{:-)}, @samp{:-(} and so on).
14777
14778 The alist used is specified by the @code{smiley-regexp-alist} variable,
14779 which defaults to the value of @code{smiley-deformed-regexp-alist}.
14780
14781 The first item in each element is the regexp to be matched; the second
14782 element is the regexp match group that is to be replaced by the picture;
14783 and the third element is the name of the file to be displayed.
14784
14785 The following variables customize where Smiley will look for these
14786 files, as well as the color to be used and stuff:
14787
14788 @table @code
14789
14790 @item smiley-data-directory
14791 @vindex smiley-data-directory
14792 Where Smiley will look for smiley faces files.
14793
14794 @item smiley-flesh-color
14795 @vindex smiley-flesh-color
14796 Skin color.  The default is @samp{yellow}, which is really racist.
14797
14798 @item smiley-features-color
14799 @vindex smiley-features-color
14800 Color of the features of the face.  The default is @samp{black}.
14801
14802 @item smiley-tongue-color
14803 @vindex smiley-tongue-color
14804 Color of the tongue.  The default is @samp{red}.
14805
14806 @item smiley-circle-color
14807 @vindex smiley-circle-color
14808 Color of the circle around the face.  The default is @samp{black}.
14809
14810 @item smiley-mouse-face
14811 @vindex smiley-mouse-face
14812 Face used for mouse highlighting over the smiley face.
14813
14814 @end table
14815
14816
14817 @node Toolbar
14818 @subsection Toolbar
14819
14820 @table @code
14821
14822 @iftex
14823 @iflatex
14824 \margindex{}
14825 @end iflatex
14826 @end iftex
14827
14828 @item gnus-use-toolbar
14829 @vindex gnus-use-toolbar
14830 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
14831 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
14832 @code{right-toolbar}, or @code{left-toolbar}.
14833
14834 @item gnus-group-toolbar
14835 @vindex gnus-group-toolbar
14836 The toolbar in the group buffer.
14837
14838 @item gnus-summary-toolbar
14839 @vindex gnus-summary-toolbar
14840 The toolbar in the summary buffer.
14841
14842 @item gnus-summary-mail-toolbar
14843 @vindex gnus-summary-mail-toolbar
14844 The toolbar in the summary buffer of mail groups.
14845
14846 @end table
14847
14848
14849 @node XVarious
14850 @subsection Various XEmacs Variables
14851
14852 @table @code
14853 @item gnus-xmas-glyph-directory
14854 @vindex gnus-xmas-glyph-directory
14855 This is where Gnus will look for pictures.  Gnus will normally
14856 auto-detect this directory, but you may set it manually if you have an
14857 unusual directory structure.
14858
14859 @item gnus-xmas-logo-color-alist
14860 @vindex gnus-xmas-logo-color-alist
14861 This is an alist where the key is a type symbol and the values are the
14862 foreground and background color of the splash page glyph.
14863
14864 @item gnus-xmas-logo-color-style
14865 @vindex gnus-xmas-logo-color-style
14866 This is the key used to look up the color in the alist described above.
14867 Legal values include @code{flame}, @code{pine}, @code{moss},
14868 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
14869 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
14870
14871 @item gnus-xmas-modeline-glyph
14872 @vindex gnus-xmas-modeline-glyph
14873 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
14874 default. 
14875
14876 @iftex
14877 @iflatex
14878 \margindex{}
14879 @end iflatex
14880 @end iftex
14881
14882 @end table
14883
14884
14885
14886
14887 @node Fuzzy Matching
14888 @section Fuzzy Matching
14889 @cindex fuzzy matching
14890
14891 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
14892 things like scoring, thread gathering and thread comparison.  
14893
14894 As opposed to regular expression matching, fuzzy matching is very fuzzy.
14895 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
14896 means, and the implementation has changed over time.
14897
14898 Basically, it tries to remove all noise from lines before comparing.
14899 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
14900 out of the strings before comparing the results.  This often leads to
14901 adequate results---even when faced with strings generated by text
14902 manglers masquerading as newsreaders.
14903
14904
14905 @node Thwarting Email Spam
14906 @section Thwarting Email Spam
14907 @cindex email spam
14908 @cindex spam
14909 @cindex UCE
14910 @cindex unsolicited commercial email
14911
14912 In these last days of the Usenet, commercial vultures are hanging about
14913 and grepping through news like crazy to find email addresses they can
14914 foist off their scams and products to.  As a reaction to this, many
14915 people have started putting nonsense addresses into their @code{From}
14916 lines.  I think this is counterproductive---it makes it difficult for
14917 people to send you legitimate mail in response to things you write, as
14918 well as making it difficult to see who wrote what.  This rewriting may
14919 perhaps be a bigger menace than the unsolicited commercial email itself
14920 in the end.
14921
14922 The biggest problem I have with email spam is that it comes in under
14923 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
14924 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
14925 mail group, only to find two pyramid schemes, seven advertisements
14926 (``New!  Miracle tonic for growing full, lustrouos hair on your toes!'')
14927 and one mail asking me to repent and find some god.
14928
14929 This is annoying.
14930
14931 The way to deal with this is having Gnus split out all spam into a
14932 @samp{spam} mail group (@pxref{Splitting Mail}).
14933
14934 First, pick one (1) valid mail address that you can be reached at, and
14935 put it in your @code{From} header of all your news articles.  (I've
14936 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
14937 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
14938 sysadm whether your sendmail installation accepts keywords in the local
14939 part of the mail address.)
14940
14941 @lisp
14942 (setq message-default-news-headers
14943       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
14944 @end lisp
14945
14946 Then put the following split rule in @code{nnmail-split-fancy}
14947 (@pxref{Fancy Mail Splitting}):
14948
14949 @lisp
14950 (
14951  ...
14952  (to "larsi@@trym.ifi.uio.no"
14953       (| ("subject" "re:.*" "misc")
14954          ("references" ".*@@.*" "misc")
14955          "spam"))
14956  ...
14957 )
14958 @end lisp
14959
14960 This says that all mail to this address is suspect, but if it has a
14961 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
14962 header, it's probably ok.  All the rest goes to the @samp{spam} group.
14963 (This idea probably comes from Tim Pierce.)
14964
14965 In addition, many mail spammers talk directly to your @code{smtp} server
14966 and do not include your email address explicitly in the @code{To}
14967 header.  Why they do this is unknown---perhaps it's to thwart this
14968 twarting scheme?  In any case, this is trivial to deal with---you just
14969 put anything not addressed to you in the @samp{spam} group by ending
14970 your fancy split rule in this way:
14971
14972 @lisp
14973 (
14974  ...
14975  (to "larsi" "misc")
14976  "spam")
14977 @end lisp
14978
14979 In my experience, this will sort virtually everything into the right
14980 group.  You still have to check the @samp{spam} group from time to time to
14981 check for legitimate mail, though.  If you feel like being a good net
14982 citizen, you can even send off complaints to the proper authorities on
14983 each unsolicited commercial email---at your leisure.
14984
14985 If you are also a lazy net citizen, you will probably prefer complaining
14986 automatically with the @file{gnus-junk.el} package, availiable FOR FREE
14987 at @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
14988 Since most e-mail spam is sent automatically, this may reconcile the
14989 cosmic balance somewhat.
14990
14991 This works for me.  It allows people an easy way to contact me (they can
14992 just press @kbd{r} in the usual way), and I'm not bothered at all with
14993 spam.  It's a win-win situation.  Forging @code{From} headers to point
14994 to non-existant domains is yucky, in my opinion.
14995
14996
14997 @node Various Various
14998 @section Various Various
14999 @cindex mode lines
15000 @cindex highlights
15001
15002 @table @code
15003
15004 @item gnus-home-directory
15005 All Gnus path variables will be initialized from this variable, which
15006 defaults to @file{~/}.
15007
15008 @item gnus-directory
15009 @vindex gnus-directory
15010 Most Gnus storage path variables will be initialized from this variable,
15011 which defaults to the @samp{SAVEDIR} environment variable, or
15012 @file{~/News/} if that variable isn't set.
15013
15014 @item gnus-default-directory
15015 @vindex gnus-default-directory
15016 Not related to the above variable at all---this variable says what the
15017 default directory of all Gnus buffers should be.  If you issue commands
15018 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
15019 default directory.  If this variable is @code{nil} (which is the
15020 default), the default directory will be the default directory of the
15021 buffer you were in when you started Gnus.
15022
15023 @item gnus-verbose
15024 @vindex gnus-verbose
15025 This variable is an integer between zero and ten.  The higher the value,
15026 the more messages will be displayed.  If this variable is zero, Gnus
15027 will never flash any messages, if it is seven (which is the default),
15028 most important messages will be shown, and if it is ten, Gnus won't ever
15029 shut up, but will flash so many messages it will make your head swim.
15030
15031 @item gnus-verbose-backends
15032 @vindex gnus-verbose-backends
15033 This variable works the same way as @code{gnus-verbose}, but it applies
15034 to the Gnus backends instead of Gnus proper.
15035
15036 @item nnheader-max-head-length
15037 @vindex nnheader-max-head-length
15038 When the backends read straight heads of articles, they all try to read
15039 as little as possible.  This variable (default 4096) specifies
15040 the absolute max length the backends will try to read before giving up
15041 on finding a separator line between the head and the body.  If this
15042 variable is @code{nil}, there is no upper read bound.  If it is
15043 @code{t}, the backends won't try to read the articles piece by piece,
15044 but read the entire articles.  This makes sense with some versions of
15045 @code{ange-ftp} or @code{efs}. 
15046
15047 @item nnheader-head-chop-length
15048 @vindex nnheader-head-chop-length
15049 This variable (default 2048) says how big a piece of each article to
15050 read when doing the operation described above.
15051
15052 @item nnheader-file-name-translation-alist 
15053 @vindex nnheader-file-name-translation-alist 
15054 @cindex file names
15055 @cindex invalid characters in file names
15056 @cindex characters in file names
15057 This is an alist that says how to translate characters in file names.
15058 For instance, if @samp{:} is invalid as a file character in file names
15059 on your system (you OS/2 user you), you could say something like:
15060
15061 @lisp
15062 (setq nnheader-file-name-translation-alist 
15063       '((?: . ?_)))
15064 @end lisp
15065
15066 In fact, this is the default value for this variable on OS/2 and MS
15067 Windows (phooey) systems.
15068
15069 @item gnus-hidden-properties
15070 @vindex gnus-hidden-properties
15071 This is a list of properties to use to hide ``invisible'' text.  It is
15072 @code{(invisible t intangible t)} by default on most systems, which
15073 makes invisible text invisible and intangible.
15074
15075 @item gnus-parse-headers-hook
15076 @vindex gnus-parse-headers-hook
15077 A hook called before parsing headers.  It can be used, for instance, to
15078 gather statistics on the headers fetched, or perhaps you'd like to prune
15079 some headers.  I don't see why you'd want that, though.
15080
15081 @item gnus-shell-command-separator
15082 @vindex gnus-shell-command-separator
15083 String used to separate two shell commands.  The default is @samp{;}. 
15084
15085
15086 @end table
15087
15088
15089 @node The End
15090 @chapter The End
15091
15092 Well, that's the manual---you can get on with your life now.  Keep in
15093 touch.  Say hello to your cats from me.  
15094
15095 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
15096
15097 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
15098
15099 @quotation
15100 @strong{Te Deum}
15101
15102 @sp 1
15103 Not because of victories @*
15104 I sing,@*
15105 having none,@*
15106 but for the common sunshine,@*
15107 the breeze,@*
15108 the largess of the spring.
15109
15110 @sp 1
15111 Not for victory@*
15112 but for the day's work done@*
15113 as well as I was able;@*
15114 not for a seat upon the dais@*
15115 but at the common table.@*
15116 @end quotation
15117
15118
15119 @node Appendices
15120 @chapter Appendices
15121
15122 @menu
15123 * History::                        How Gnus got where it is today.
15124 * Terminology::                    We use really difficult, like, words here.
15125 * Customization::                  Tailoring Gnus to your needs.
15126 * Troubleshooting::                What you might try if things do not work.
15127 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
15128 * Emacs for Heathens::             A short introduction to Emacsian terms.
15129 * Frequently Asked Questions::     A question-and-answer session.
15130 @end menu
15131
15132
15133 @node History
15134 @section History
15135
15136 @cindex history
15137 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
15138 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
15139
15140 If you want to investigate the person responsible for this outrage, you
15141 can point your (feh!) web browser to
15142 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
15143 distribution point for the new and spiffy versions of Gnus, and is known
15144 as The Site That Destroys Newsrcs And Drives People Mad.
15145
15146 During the first extended alpha period of development, the new Gnus was
15147 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
15148 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
15149 (Besides, the ``Gnus'' in this abbreviation should probably be
15150 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
15151 appropriate name, don't you think?)
15152
15153 In any case, after spending all that energy on coming up with a new and
15154 spunky name, we decided that the name was @emph{too} spunky, so we
15155 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
15156 ``@sc{gnus}''.  New vs. old.
15157
15158 The first ``proper'' release of Gnus 5 was done in November 1995 when it
15159 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
15160 plus 15 Gnus 5.0 releases).
15161
15162 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
15163 releases)) was released under the name ``Gnus 5.2'' (40 releases).
15164
15165 On July 28th 1996 work on Red Gnus was begun, and it was released on
15166 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
15167
15168 If you happen upon a version of Gnus that has a prefixed name --
15169 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
15170 don't panic.  Don't let it know that you're frightened.  Back away.
15171 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
15172 out of its reach.  Find a proper released version of Gnus and snuggle up
15173 to that instead.
15174
15175 @menu
15176 * Why?::                What's the point of Gnus?
15177 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
15178 * Conformity::          Gnus tries to conform to all standards.
15179 * Emacsen::             Gnus can be run on a few modern Emacsen.
15180 * Contributors::        Oodles of people.  
15181 * New Features::        Pointers to some of the new stuff in Gnus.
15182 * Newest Features::     Features so new that they haven't been written yet.
15183 @end menu
15184
15185
15186 @node Why?
15187 @subsection Why?
15188
15189 What's the point of Gnus?  
15190
15191 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
15192 newsreader, that lets you do anything you can think of.  That was my
15193 original motivation, but while working on Gnus, it has become clear to
15194 me that this generation of newsreaders really belong in the stone age.
15195 Newsreaders haven't developed much since the infancy of the net.  If the
15196 volume continues to rise with the current rate of increase, all current
15197 newsreaders will be pretty much useless.  How do you deal with
15198 newsgroups that have thousands of new articles each day?  How do you
15199 keep track of millions of people who post?
15200
15201 Gnus offers no real solutions to these questions, but I would very much
15202 like to see Gnus being used as a testing ground for new methods of
15203 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
15204 to separate the newsreader from the backends, Gnus now offers a simple
15205 interface for anybody who wants to write new backends for fetching mail
15206 and news from different sources.  I have added hooks for customizations
15207 everywhere I could imagine it being useful.  By doing so, I'm inviting
15208 every one of you to explore and invent.
15209
15210 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
15211 @kbd{C-u 100 M-x all-hail-xemacs}.
15212
15213
15214 @node Compatibility
15215 @subsection Compatibility
15216
15217 @cindex compatibility
15218 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
15219 bindings have been kept.  More key bindings have been added, of course,
15220 but only in one or two obscure cases have old bindings been changed.
15221
15222 Our motto is:
15223 @quotation
15224 @cartouche
15225 @center In a cloud bones of steel.
15226 @end cartouche
15227 @end quotation
15228
15229 All commands have kept their names.  Some internal functions have changed
15230 their names.
15231
15232 The @code{gnus-uu} package has changed drastically. @xref{Decoding
15233 Articles}. 
15234
15235 One major compatibility question is the presence of several summary
15236 buffers.  All variables relevant while reading a group are
15237 buffer-local to the summary buffer they belong in.  Although many
15238 important variables have their values copied into their global
15239 counterparts whenever a command is executed in the summary buffer, this
15240 change might lead to incorrect values being used unless you are careful.
15241
15242 All code that relies on knowledge of @sc{gnus} internals will probably
15243 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
15244 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
15245 maintains a hash table that points to the entries in this alist (which
15246 speeds up many functions), and changing the alist directly will lead to
15247 peculiar results.
15248
15249 @cindex hilit19
15250 @cindex highlighting
15251 Old hilit19 code does not work at all.  In fact, you should probably
15252 remove all hilit code from all Gnus hooks
15253 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
15254 Gnus provides various integrated functions for highlighting.  These are
15255 faster and more accurate.  To make life easier for everybody, Gnus will
15256 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
15257 Away!
15258
15259 Packages like @code{expire-kill} will no longer work.  As a matter of
15260 fact, you should probably remove all old @sc{gnus} packages (and other
15261 code) when you start using Gnus.  More likely than not, Gnus already
15262 does what you have written code to make @sc{gnus} do.  (Snicker.)
15263
15264 Even though old methods of doing things are still supported, only the
15265 new methods are documented in this manual.  If you detect a new method of
15266 doing something while reading this manual, that does not mean you have
15267 to stop doing it the old way.
15268
15269 Gnus understands all @sc{gnus} startup files.
15270
15271 @kindex M-x gnus-bug
15272 @findex gnus-bug
15273 @cindex reporting bugs
15274 @cindex bugs
15275 Overall, a casual user who hasn't written much code that depends on
15276 @sc{gnus} internals should suffer no problems.  If problems occur,
15277 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
15278
15279
15280 @node Conformity
15281 @subsection Conformity
15282
15283 No rebels without a clue here, ma'am.  We conform to all standards known
15284 to (wo)man.  Except for those standards and/or conventions we disagree
15285 with, of course.
15286
15287 @table @strong
15288
15289 @item RFC 822
15290 @cindex RFC 822
15291 There are no known breaches of this standard.
15292
15293 @item RFC 1036
15294 @cindex RFC 1036
15295 There are no known breaches of this standard, either.
15296
15297 @item Son-of-RFC 1036
15298 @cindex Son-of-RFC 1036
15299 We do have some breaches to this one.
15300
15301 @table @emph
15302
15303 @item MIME
15304 Gnus does no MIME handling, and this standard-to-be seems to think that
15305 MIME is the bees' knees, so we have major breakage here.
15306
15307 @item X-Newsreader
15308 This is considered to be a ``vanity header'', while I consider it to be
15309 consumer information.  After seeing so many badly formatted articles
15310 coming from @code{tin} and @code{Netscape} I know not to use either of
15311 those for posting articles.  I would not have known that if it wasn't
15312 for the @code{X-Newsreader} header.
15313 @end table
15314
15315 @end table
15316
15317 If you ever notice Gnus acting non-compliant with regards to the texts
15318 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
15319 know.
15320
15321
15322 @node Emacsen
15323 @subsection Emacsen
15324 @cindex Emacsen
15325 @cindex XEmacs
15326 @cindex Mule
15327 @cindex Emacs
15328
15329 Gnus should work on :
15330
15331 @itemize @bullet 
15332
15333 @item
15334 Emacs 19.32 and up.
15335
15336 @item
15337 XEmacs 19.14 and up.
15338
15339 @item 
15340 Mule versions based on Emacs 19.32 and up.
15341
15342 @end itemize
15343
15344 Gnus will absolutely not work on any Emacsen older than that.  Not
15345 reliably, at least. 
15346
15347 There are some vague differences between Gnus on the various
15348 platforms---XEmacs features more graphics (a logo and a toolbar)---but
15349 other than that, things should look pretty much the same under all
15350 Emacsen. 
15351
15352
15353 @node Contributors
15354 @subsection Contributors
15355 @cindex contributors
15356
15357 The new Gnus version couldn't have been done without the help of all the
15358 people on the (ding) mailing list.  Every day for over a year I have
15359 gotten billions of nice bug reports from them, filling me with joy,
15360 every single one of them.  Smooches.  The people on the list have been
15361 tried beyond endurance, what with my ``oh, that's a neat idea <type
15362 type>, yup, I'll release it right away <ship off> no wait, that doesn't
15363 work at all <type type>, yup, I'll ship that one off right away <ship
15364 off> no, wait, that absolutely does not work'' policy for releases.
15365 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
15366 ``worser''? ``much worser''?  ``worsest''?)
15367
15368 I would like to take this opportunity to thank the Academy for...  oops,
15369 wrong show.
15370
15371 @itemize @bullet
15372
15373 @item 
15374 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
15375
15376 @item 
15377 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
15378 well as numerous other things).
15379
15380 @item 
15381 Luis Fernandes---design and graphics.
15382
15383 @item
15384 Erik Naggum---help, ideas, support, code and stuff.
15385
15386 @item 
15387 Wes Hardaker---@file{gnus-picon.el} and the manual section on
15388 @dfn{picons} (@pxref{Picons}).
15389
15390 @item
15391 Kim-Minh Kaplan---further work on the picon code.
15392
15393 @item 
15394 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
15395 (@pxref{GroupLens}).
15396
15397 @item 
15398 Sudish Joseph---innumerable bug fixes.
15399
15400 @item 
15401 Ilja Weis---@file{gnus-topic.el}.
15402
15403 @item 
15404 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
15405
15406 @item 
15407 Vladimir Alexiev---the refcard and reference booklets.
15408
15409 @item 
15410 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
15411 distribution by Felix Lee and JWZ.
15412
15413 @item 
15414 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
15415
15416 @item 
15417 Peter Mutsaers---orphan article scoring code.
15418
15419 @item 
15420 Ken Raeburn---POP mail support.
15421
15422 @item 
15423 Hallvard B Furuseth---various bits and pieces, especially dealing with
15424 .newsrc files.
15425
15426 @item 
15427 Brian Edmonds---@file{gnus-bbdb.el}.
15428
15429 @item
15430 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
15431
15432 @item 
15433 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
15434
15435 @item
15436 François Pinard---many, many interesting and thorough bug reports.
15437
15438 @end itemize
15439
15440 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
15441 Borges, and Jost Krieger proof-reading parts of the manual.
15442
15443 The following people have contributed many patches and suggestions: 
15444
15445 Christopher Davis,
15446 Andrew Eskilsson,
15447 Kai Grossjohann,
15448 David KÃ¥gedal,
15449 Richard Pieri,
15450 Fabrice Popineau, 
15451 Daniel Quinlan, 
15452 Jason L. Tibbitts, III,
15453 and
15454 Jack Vinson.
15455
15456 Also thanks to the following for patches and stuff:
15457
15458 Jari Aalto,
15459 Adrian Aichner,
15460 Russ Allbery,
15461 Peter Arius, 
15462 Matt Armstrong,
15463 Marc Auslander,
15464 Robert Bihlmeyer,
15465 Chris Bone,
15466 Mark Borges,
15467 Mark Boyns,
15468 Lance A. Brown,
15469 Kees de Bruin,
15470 Martin Buchholz,
15471 Kevin Buhr,
15472 Alastair Burt,
15473 Joao Cachopo,
15474 Zlatko Calusic,
15475 Massimo Campostrini,
15476 Dan Christensen,
15477 Michael R. Cook,
15478 Glenn Coombs, 
15479 Frank D. Cringle, 
15480 Geoffrey T. Dairiki,
15481 Andre Deparade,
15482 Ulrik Dickow,
15483 Dave Disser,
15484 Joev Dubach,
15485 Michael Welsh Duggan,
15486 Dave Edmondson,
15487 Paul Eggert,
15488 Enami Tsugutomo, @c Enami
15489 Michael Ernst,
15490 Luc Van Eycken,
15491 Sam Falkner,
15492 Nelson Jose dos Santos Ferreira,
15493 Sigbjorn Finne,
15494 Gary D. Foster,
15495 Paul Franklin, 
15496 Guy Geens,
15497 Arne Georg Gleditsch,
15498 David S. Goldberg,
15499 Michelangelo Grigni,
15500 D. Hall, 
15501 Magnus Hammerin,
15502 Kenichi Handa, @c Handa
15503 Raja R. Harinath,
15504 Hisashige Kenji, @c Hisashige
15505 Marc Horowitz,
15506 Gunnar Horrigmo,
15507 Richard Hoskins,
15508 Brad Howes,
15509 François Felix Ingrand,
15510 Ishikawa Ichiro, @c Ishikawa
15511 Lee Iverson, 
15512 Iwamuro Motonori, @c Iwamuro
15513 Rajappa Iyer,
15514 Andreas Jaeger,
15515 Randell Jesup,
15516 Fred Johansen, 
15517 Simon Josefsson,
15518 Greg Klanderman,
15519 Karl Kleinpaste,
15520 Peter Skov Knudsen,
15521 Shuhei Kobayashi, @c Kobayashi
15522 Thor Kristoffersen,
15523 Jens Lautenbacher,
15524 Seokchan Lee, @c Lee
15525 Carsten Leonhardt,
15526 James LewisMoss,
15527 Christian Limpach,
15528 Markus Linnala,
15529 Dave Love,
15530 Tonny Madsen,
15531 Shlomo Mahlab,
15532 Nat Makarevitch,
15533 Istvan Marko,
15534 David Martin,
15535 Gordon Matzigkeit,
15536 Timo Metzemakers,
15537 Richard Mlynarik,
15538 Lantz Moore,
15539 Morioka Tomohiko, @c Morioka
15540 Erik Toubro Nielsen,
15541 Hrvoje Niksic,
15542 Andy Norman,
15543 Fred Oberhauser,
15544 C. R. Oldham,
15545 Alexandre Oliva,
15546 Ken Olstad,
15547 Masaharu Onishi, @c Onishi
15548 Hideki Ono, @c Ono
15549 William Perry,
15550 Stephen Peters,
15551 Ulrich Pfeifer,
15552 John McClary Prevost,
15553 Colin Rafferty,
15554 Lars Balker Rasmussen,
15555 Joe Reiss,
15556 Renaud Rioboo,
15557 Roland B. Roberts,
15558 Bart Robinson,
15559 Christian von Roques,
15560 Jason Rumney,
15561 Jay Sachs,
15562 Dewey M. Sasser,
15563 Loren Schall,
15564 Dan Schmidt,
15565 Ralph Schleicher,
15566 Philippe Schnoebelen,
15567 Randal L. Schwartz,
15568 Justin Sheehy,
15569 Danny Siu, 
15570 Matt Simmons,
15571 Paul D. Smith,
15572 Jeff Sparkes,
15573 Toby Speight,
15574 Michael Sperber,
15575 Darren Stalder,
15576 Richard Stallman,
15577 Greg Stark, 
15578 Paul Stodghill,
15579 Kurt Swanson,
15580 Samuel Tardieu, 
15581 Teddy,
15582 Chuck Thompson,
15583 Philippe Troin,
15584 James Troup,
15585 Aaron M. Ucko, 
15586 Aki Vehtari,
15587 Didier Verna,
15588 Jan Vroonhof,
15589 Stefan Waldherr,
15590 Pete Ware,
15591 Barry A. Warsaw,
15592 Christoph Wedler,
15593 Joe Wells,
15594 and
15595 Katsumi Yamaoka. @c Yamaoka
15596
15597 For a full overview of what each person has done, the ChangeLogs
15598 included in the Gnus alpha distributions should give ample reading
15599 (550kB and counting).
15600
15601 Apologies to everybody that I've forgotten, of which there are many, I'm
15602 sure.  
15603
15604 Gee, that's quite a list of people.  I guess that must mean that there
15605 actually are people who are using Gnus.  Who'd'a thunk it!
15606
15607
15608 @node New Features
15609 @subsection New Features
15610 @cindex new features
15611
15612 @menu
15613 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
15614 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
15615 * Red Gnus::           Third time best---Gnus 5.4/5.5.
15616 @end menu
15617
15618 These lists are, of course, just @emph{short} overviews of the
15619 @emph{most} important new features.  No, really.  There are tons more.
15620 Yes, we have feeping creaturism in full effect.
15621
15622
15623 @node ding Gnus
15624 @subsubsection (ding) Gnus
15625
15626 New features in Gnus 5.0/5.1:
15627
15628 @itemize @bullet
15629
15630 @item
15631 The look of all buffers can be changed by setting format-like variables
15632 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
15633  
15634 @item 
15635 Local spool and several @sc{nntp} servers can be used at once
15636 (@pxref{Select Methods}).  
15637
15638 @item 
15639 You can combine groups into virtual groups (@pxref{Virtual Groups}).
15640
15641 @item 
15642 You can read a number of different mail formats (@pxref{Getting Mail}).
15643 All the mail backends implement a convenient mail expiry scheme
15644 (@pxref{Expiring Mail}). 
15645
15646 @item
15647 Gnus can use various strategies for gathering threads that have lost
15648 their roots (thereby gathering loose sub-threads into one thread) or it
15649 can go back and retrieve enough headers to build a complete thread
15650 (@pxref{Customizing Threading}).
15651
15652 @item 
15653 Killed groups can be displayed in the group buffer, and you can read
15654 them as well (@pxref{Listing Groups}).
15655
15656 @item 
15657 Gnus can do partial group updates---you do not have to retrieve the
15658 entire active file just to check for new articles in a few groups
15659 (@pxref{The Active File}).
15660
15661 @item 
15662 Gnus implements a sliding scale of subscribedness to groups
15663 (@pxref{Group Levels}).
15664
15665 @item 
15666 You can score articles according to any number of criteria
15667 (@pxref{Scoring}).  You can even get Gnus to find out how to score
15668 articles for you (@pxref{Adaptive Scoring}).
15669
15670 @item 
15671 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
15672 manner, so it should be difficult to lose much data on what you have
15673 read if your machine should go down (@pxref{Auto Save}). 
15674
15675 @item 
15676 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
15677 the @file{.emacs} file.
15678
15679 @item 
15680 You can set the process mark on both groups and articles and perform
15681 operations on all the marked items (@pxref{Process/Prefix}).
15682
15683 @item 
15684 You can grep through a subset of groups and create a group from the
15685 results (@pxref{Kibozed Groups}). 
15686
15687 @item 
15688 You can list subsets of groups according to, well, anything
15689 (@pxref{Listing Groups}). 
15690
15691 @item 
15692 You can browse foreign servers and subscribe to groups from those
15693 servers (@pxref{Browse Foreign Server}). 
15694
15695 @item 
15696 Gnus can fetch articles, asynchronously, on a second connection to the
15697 server (@pxref{Asynchronous Fetching}).
15698
15699 @item 
15700 You can cache articles locally (@pxref{Article Caching}). 
15701
15702 @item 
15703 The uudecode functions have been expanded and generalized
15704 (@pxref{Decoding Articles}). 
15705
15706 @item
15707 You can still post uuencoded articles, which was a little-known feature
15708 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
15709
15710 @item
15711 Fetching parents (and other articles) now actually works without
15712 glitches (@pxref{Finding the Parent}). 
15713
15714 @item
15715 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
15716
15717 @item
15718 Digests (and other files) can be used as the basis for groups
15719 (@pxref{Document Groups}).
15720
15721 @item 
15722 Articles can be highlighted and customized (@pxref{Customizing
15723 Articles}). 
15724
15725 @item 
15726 URLs and other external references can be buttonized (@pxref{Article
15727 Buttons}). 
15728
15729 @item
15730 You can do lots of strange stuff with the Gnus window & frame
15731 configuration (@pxref{Windows Configuration}).
15732
15733 @item
15734 You can click on buttons instead of using the keyboard
15735 (@pxref{Buttons}). 
15736
15737 @end itemize
15738
15739
15740 @node September Gnus
15741 @subsubsection September Gnus
15742
15743 @iftex
15744 @iflatex
15745 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
15746 @end iflatex
15747 @end iftex
15748
15749 New features in Gnus 5.2/5.3:
15750
15751 @itemize @bullet
15752
15753 @item
15754 A new message composition mode is used.  All old customization variables
15755 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
15756 now obsolete.
15757
15758 @item
15759 Gnus is now able to generate @dfn{sparse} threads---threads where
15760 missing articles are represented by empty nodes (@pxref{Customizing
15761 Threading}). 
15762
15763 @lisp
15764 (setq gnus-build-sparse-threads 'some)
15765 @end lisp
15766
15767 @item
15768 Outgoing articles are stored on a special archive server
15769 (@pxref{Archived Messages}). 
15770
15771 @item
15772 Partial thread regeneration now happens when articles are
15773 referred. 
15774
15775 @item
15776 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
15777
15778 @item
15779 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
15780
15781 @item
15782 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
15783
15784 @lisp
15785 (setq gnus-use-trees t)
15786 @end lisp
15787
15788 @item
15789 An @code{nn}-like pick-and-read minor mode is available for the summary
15790 buffers (@pxref{Pick and Read}).
15791
15792 @lisp
15793 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
15794 @end lisp
15795
15796 @item
15797 In binary groups you can use a special binary minor mode (@pxref{Binary
15798 Groups}). 
15799
15800 @item
15801 Groups can be grouped in a folding topic hierarchy (@pxref{Group
15802 Topics}).
15803
15804 @lisp
15805 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
15806 @end lisp
15807
15808 @item
15809 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
15810
15811 @item
15812 Groups can now have a score, and bubbling based on entry frequency
15813 is possible (@pxref{Group Score}).
15814
15815 @lisp
15816 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
15817 @end lisp
15818
15819 @item
15820 Groups can be process-marked, and commands can be performed on
15821 groups of groups (@pxref{Marking Groups}).
15822
15823 @item
15824 Caching is possible in virtual groups.
15825
15826 @item
15827 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
15828 news batches, ClariNet briefs collections, and just about everything
15829 else (@pxref{Document Groups}).
15830
15831 @item
15832 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
15833 (@pxref{SOUP}).
15834
15835 @item
15836 The Gnus cache is much faster.
15837
15838 @item
15839 Groups can be sorted according to many criteria (@pxref{Sorting
15840 Groups}).
15841
15842 @item
15843 New group parameters have been introduced to set list-addresses and
15844 expiry times (@pxref{Group Parameters}).
15845
15846 @item
15847 All formatting specs allow specifying faces to be used
15848 (@pxref{Formatting Fonts}).
15849
15850 @item
15851 There are several more commands for setting/removing/acting on process
15852 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
15853
15854 @item
15855 The summary buffer can be limited to show parts of the available
15856 articles based on a wide range of criteria.  These commands have been
15857 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
15858
15859 @item
15860 Articles can be made persistent with the @kbd{*} command
15861 (@pxref{Persistent Articles}).
15862
15863 @item
15864 All functions for hiding article elements are now toggles.
15865
15866 @item
15867 Article headers can be buttonized (@pxref{Article Washing}).
15868
15869 @lisp
15870 (add-hook 'gnus-article-display-hook 
15871           'gnus-article-add-buttons-to-head)
15872 @end lisp
15873
15874 @item
15875 All mail backends support fetching articles by @code{Message-ID}.
15876
15877 @item
15878 Duplicate mail can now be treated properly (@pxref{Duplicates}).
15879
15880 @item
15881 All summary mode commands are available directly from the article
15882 buffer (@pxref{Article Keymap}). 
15883
15884 @item
15885 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
15886 Configuration}).
15887
15888 @item
15889 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
15890 @iftex
15891 @iflatex
15892 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
15893 @end iflatex
15894 @end iftex
15895
15896 @item
15897 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
15898
15899 @lisp
15900 (setq gnus-use-nocem t)
15901 @end lisp
15902
15903 @item
15904 Groups can be made permanently visible (@pxref{Listing Groups}).
15905
15906 @lisp
15907 (setq gnus-permanently-visible-groups "^nnml:")
15908 @end lisp
15909
15910 @item
15911 Many new hooks have been introduced to make customizing easier. 
15912
15913 @item
15914 Gnus respects the @code{Mail-Copies-To} header.
15915
15916 @item
15917 Threads can be gathered by looking at the @code{References} header
15918 (@pxref{Customizing Threading}).
15919
15920 @lisp
15921 (setq gnus-summary-thread-gathering-function 
15922       'gnus-gather-threads-by-references)
15923 @end lisp
15924
15925 @item
15926 Read articles can be stored in a special backlog buffer to avoid
15927 refetching (@pxref{Article Backlog}).  
15928
15929 @lisp
15930 (setq gnus-keep-backlog 50)
15931 @end lisp
15932
15933 @item
15934 A clean copy of the current article is always stored in a separate
15935 buffer to allow easier treatment.
15936
15937 @item
15938 Gnus can suggest where to save articles (@pxref{Saving Articles}).
15939
15940 @item
15941 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
15942 Articles}). 
15943
15944 @lisp
15945 (setq gnus-prompt-before-saving t)
15946 @end lisp
15947
15948 @item
15949 @code{gnus-uu} can view decoded files asynchronously while fetching
15950 articles (@pxref{Other Decode Variables}). 
15951
15952 @lisp
15953 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
15954 @end lisp
15955
15956 @item
15957 Filling in the article buffer now works properly on cited text
15958 (@pxref{Article Washing}).
15959
15960 @item
15961 Hiding cited text adds buttons to toggle hiding, and how much
15962 cited text to hide is now customizable (@pxref{Article Hiding}).
15963
15964 @lisp
15965 (setq gnus-cited-lines-visible 2)
15966 @end lisp
15967
15968 @item
15969 Boring headers can be hidden (@pxref{Article Hiding}).
15970
15971 @lisp
15972 (add-hook 'gnus-article-display-hook 
15973           'gnus-article-hide-boring-headers t)
15974 @end lisp
15975
15976 @item
15977 Default scoring values can now be set from the menu bar.
15978
15979 @item
15980 Further syntax checking of outgoing articles have been added.
15981
15982 @end itemize
15983
15984
15985 @node Red Gnus
15986 @subsubsection Red Gnus
15987
15988 New features in Gnus 5.4/5.5:
15989
15990 @iftex
15991 @iflatex
15992 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
15993 @end iflatex
15994 @end iftex
15995
15996 @itemize @bullet
15997
15998 @item
15999 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
16000
16001 @item
16002 Article prefetching functionality has been moved up into 
16003 Gnus (@pxref{Asynchronous Fetching}).  
16004
16005 @item
16006 Scoring can now be performed with logical operators like @code{and},
16007 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16008 Scoring}).
16009
16010 @item
16011 Article washing status can be displayed in the
16012 article mode line (@pxref{Misc Article}).
16013
16014 @item
16015 @file{gnus.el} has been split into many smaller files.
16016
16017 @item
16018 Suppression of duplicate articles based on Message-ID can be done
16019 (@pxref{Duplicate Suppression}).
16020
16021 @lisp
16022 (setq gnus-suppress-duplicates t)
16023 @end lisp
16024
16025 @item
16026 New variables for specifying what score and adapt files are to be
16027 considered home score and adapt files (@pxref{Home Score File}) have
16028 been added.
16029
16030 @item
16031 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
16032 Server Internals}). 
16033
16034 @item
16035 Groups can inherit group parameters from parent topics (@pxref{Topic
16036 Parameters}).
16037
16038 @item
16039 Article editing has been revamped and is now actually usable.
16040
16041 @item
16042 Signatures can be recognized in more intelligent fashions
16043 (@pxref{Article Signature}).
16044
16045 @item
16046 Summary pick mode has been made to look more @code{nn}-like.  Line
16047 numbers are displayed and the @kbd{.} command can be used to pick
16048 articles (@code{Pick and Read}).
16049
16050 @item
16051 Commands for moving the @file{.newsrc.eld} from one server to
16052 another have been added (@pxref{Changing Servers}).
16053
16054 @item
16055 There's a way now to specify that ``uninteresting'' fields be suppressed
16056 when generating lines in buffers (@pxref{Advanced Formatting}).
16057
16058 @item
16059 Several commands in the group buffer can be undone with @kbd{M-C-_}
16060 (@pxref{Undo}).
16061
16062 @item
16063 Scoring can be done on words using the new score type @code{w}
16064 (@pxref{Score File Format}).
16065
16066 @item
16067 Adaptive scoring can be done on a Subject word-by-word basis
16068 (@pxref{Adaptive Scoring}). 
16069
16070 @lisp
16071 (setq gnus-use-adaptive-scoring '(word))
16072 @end lisp
16073
16074 @item
16075 Scores can be decayed (@pxref{Score Decays}).
16076  
16077 @lisp
16078 (setq gnus-decay-scores t)
16079 @end lisp
16080
16081 @item
16082 Scoring can be performed using a regexp on the Date header.  The Date is
16083 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
16084
16085 @item
16086 A new command has been added to remove all data on articles from
16087 the native server (@pxref{Changing Servers}).
16088
16089 @item
16090 A new command for reading collections of documents
16091 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
16092 (@pxref{Really Various Summary Commands}). 
16093
16094 @item
16095 Process mark sets can be pushed and popped (@pxref{Setting Process
16096 Marks}).
16097
16098 @item
16099 A new mail-to-news backend makes it possible to post even when the NNTP
16100 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
16101
16102 @item
16103 A new backend for reading searches from Web search engines
16104 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
16105 (@pxref{Web Searches}).
16106
16107 @item
16108 Groups inside topics can now be sorted using the standard sorting
16109 functions, and each topic can be sorted independently (@pxref{Topic
16110 Sorting}).
16111
16112 @item
16113 Subsets of the groups can be sorted independently (@code{Sorting
16114 Groups}).
16115
16116 @item
16117 Cached articles can be pulled into the groups (@pxref{Summary Generation
16118 Commands}).
16119 @iftex
16120 @iflatex
16121 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
16122 @end iflatex
16123 @end iftex
16124
16125 @item
16126 Score files are now applied in a more reliable order (@pxref{Score
16127 Variables}).
16128
16129 @item
16130 Reports on where mail messages end up can be generated (@pxref{Splitting
16131 Mail}).
16132
16133 @item
16134 More hooks and functions have been added to remove junk from incoming
16135 mail before saving the mail (@pxref{Washing Mail}).
16136
16137 @item
16138 Emphasized text can be properly fontisized:
16139
16140 @lisp
16141 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
16142 @end lisp
16143  
16144 @end itemize
16145
16146
16147 @node Newest Features
16148 @subsection Newest Features
16149 @cindex todo
16150
16151 Also known as the @dfn{todo list}.  Sure to be implemented before the
16152 next millennium. 
16153
16154 Be afraid.  Be very afraid.
16155
16156 (That a feature appears in this list doesn't necessarily mean that I've
16157 decided to actually implement it.  It just means that I think it sounds
16158 interesting.)
16159
16160 (Yes, this is the actual, up-to-the-second todo list.)
16161
16162 @itemize @bullet
16163
16164 @item
16165 Native @sc{mime} support is something that should be done.  
16166
16167 @item
16168 Really do unbinhexing.
16169
16170 @item
16171  I would like the zombie-page to contain an URL to the source of the
16172 latest version of gnus or some explanation on where to find it.
16173
16174 @item
16175  A way to continue editing the latest Message composition.
16176
16177 @item
16178  http://www.sonicnet.com/feature/ari3/
16179
16180 @item
16181  facep is not declared.
16182
16183 @item
16184  Include a section in the manual on why the number of articles
16185 isn't the same in the group buffer and on the SPC prompt.
16186
16187 @item
16188  Interacting with rmail fcc isn't easy.
16189
16190 @item
16191 @example
16192  Hypermail:
16193 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
16194 <URL:http://www.eit.com/software/hypermail/hypermail.html>
16195 <URL:http://homer.ncm.com/>
16196 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
16197 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
16198 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
16199 http://www.miranova.com/gnus-list/
16200
16201 @end example
16202
16203 @item
16204 @samp{^-- } is made into - in LaTeX.
16205
16206 @item
16207  gnus-kill is much slower than it was in GNUS 4.1.3.
16208
16209 @item
16210  when expunging articles on low score, the sparse nodes keep hanging on?
16211 @item
16212  starting the first time seems to hang Gnus on some systems.  Does
16213 NEWGROUPS answer too fast?
16214 @item
16215  nndir doesn't read gzipped files.
16216 @item
16217  FAQ doesn't have an up node?
16218 @item
16219  when moving mail from a procmail spool to the crash-box,
16220 the crash-box is only appropriate to one specific group.
16221 @item
16222  `t' `t' makes X-Faces disappear.
16223 @item
16224  nnmh-be-safe means that crossposted articles will
16225 be marked as unread.
16226 @item
16227  Orphan score entries dont show on "V t" score trace
16228 @item
16229  when clearing out data, the cache data should also be reset.
16230 @item
16231  rewrite gnus-summary-limit-children to be non-recursive
16232 to avoid exceeding lisp nesting on huge groups.
16233 @item
16234  expinged articles are counted when computing scores.
16235 @item
16236  implement gnus-batch-brew-soup
16237 @item
16238  ticked articles aren't easy to read in pick mode -- `n' and
16239 stuff just skips past them.  Read articles are the same.
16240 @item
16241  topics that contain just groups with ticked
16242 articles aren't displayed.
16243 @item
16244  nndoc should always allocate unique Message-IDs.
16245 @item
16246  implement gnus-score-thread
16247 @item
16248  If there are mail groups the first time you use Gnus, Gnus'll
16249 make the mail groups killed. 
16250 @item
16251  no "no news is good news" when using topics.
16252 @item
16253  when doing crosspost marking, the cache has to be consulted
16254 and articles have to be removed.
16255 @item
16256  nnweb should fetch complete articles when they are split into several
16257 parts.
16258 @item
16259  scoring on head immediate doesn't work.
16260 @item
16261  finding short score file names takes forever.
16262 @item
16263  canceling articles in foreign groups.
16264 @item
16265  nntp-open-rlogin no longer works.
16266 @item
16267  C-u C-x C-s (Summary) switches to the group buffer.
16268 @item
16269  move nnmail-split-history out to the backends.
16270 @item
16271  nnweb doesn't work properly.
16272 @item
16273  using a virtual server name as `gnus-select-method' doesn't work?
16274 @item
16275  when killing/yanking a group from one topic to another in a slave, the 
16276 master will yank it first to one topic and then add it to another.  
16277 Perhaps.
16278
16279 @item
16280  warn user about `=' redirection of a group in the active file?
16281 @item
16282  really unbinhex binhex files.
16283 @item
16284  take over the XEmacs menubar and offer a toggle between the XEmacs
16285 bar and the Gnus bar.
16286 @item
16287 @example
16288  push active file and NOV file parsing down into C code.
16289 `(canonize-message-id id)'
16290 `(mail-parent-message-id references n)'
16291 `(parse-news-nov-line &optional dependency-hashtb)'
16292 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
16293 `(parse-news-active-region beg end hashtb)'
16294
16295 @end example
16296
16297 @item
16298  nnml .overview directory with splits.
16299 @item
16300  asynchronous cache
16301 @item
16302  postponed commands.
16303 @item
16304  the selected article show have its Subject displayed in its summary line.
16305 @item
16306  when entering groups, get the real number of unread articles from
16307 the server?  
16308 @item
16309  sort after gathering threads -- make false roots have the
16310 headers of the oldest orhpan with a 0 article number?
16311 @item
16312  nndoc groups should inherit the score files of their parents?  Also
16313 inherit copy prompts and save files.
16314 @item
16315  command to start up Gnus (if not running) and enter a mail mode buffer.
16316 @item
16317  allow editing the group description from the group buffer
16318 for backends that support that.
16319 @item
16320 gnus-hide,show-all-topics
16321 @item
16322  groups and sub-topics should be allowed to mingle inside each topic,
16323 and not just list all subtopics at the end.
16324 @item
16325  a command to remove all read articles that are not needed to connect
16326 threads -- `gnus-summary-limit-to-sparse-unread'?
16327 @item
16328  a variable to turn off limiting/cutting of threads in the tree buffer.
16329 @item
16330  a variable to limit how many files are uudecoded.
16331 @item
16332  add zombie groups to a special "New Groups" topic.
16333 @item
16334  server mode command: close/open all connections
16335 @item
16336  put a file date in gnus-score-alist and check whether the file
16337 has been changed before using it.
16338 @item
16339  on exit from a digest group, go to the next article in the parent group.
16340 @item
16341  hide (sub)threads with low score.
16342 @item
16343  when expiring, remove all marks from expired articles.
16344 @item
16345  gnus-summary-limit-to-body
16346 @item
16347  a regexp alist that says what level groups are to be subscribed
16348 on.  Eg. -- `(("nnml:" . 1))'.
16349 @item
16350  easier interface to nnkiboze to create ephemeral groups that
16351 contaion groups that match a regexp.
16352 @item
16353  allow newlines in <URL:> urls, but remove them before using
16354 the URL.
16355 @item
16356  If there is no From line, the mail backends should fudge one from the
16357 "From " line.
16358 @item
16359  fuzzy simplifying should strip all non-alpha-numerical info
16360 from subject lines.
16361 @item
16362  gnus-soup-brew-soup-with-high-scores.
16363 @item
16364  nntp-ping-before-connect
16365 @item
16366  command to check whether NOV is evil.  "list overview.fmt".
16367 @item
16368  when entering a group, Gnus should look through the score
16369 files very early for `local' atoms and set those local variables.
16370 @item
16371  message annotations.
16372 @item
16373  topics are always yanked before groups, and that's not good.
16374 @item
16375  (set-extent-property extent 'help-echo "String to display in minibuf")
16376 to display help in the minibuffer on buttons under XEmacs.
16377 @item
16378  allow group line format spec to say how many articles there
16379 are in the cache.
16380 @item
16381  AUTHINFO GENERIC
16382 @item
16383  support qmail maildir spools
16384 @item
16385  `run-with-idle-timer' in gnus-demon.
16386 @item
16387  stop using invisible text properties and start using overlays instead
16388 @item
16389  C-c C-f C-e to add an Expires header.
16390 @item
16391  go from one group to the next; everything is expunged; go to the
16392 next group instead of going to the group buffer.
16393 @item
16394  gnus-renumber-cache -- to renumber the cache using "low" numbers.
16395 @item
16396  record topic changes in the dribble buffer.
16397 @item
16398  `nnfolder-generate-active-file' should look at the folders it
16399 finds and generate proper active ranges.
16400 @item
16401  nneething-look-in-files-for-article-heads variable to control
16402 whether nneething should sniff all files in the directories.
16403 @item
16404  gnus-fetch-article -- start Gnus, enter group, display article
16405 @item
16406  gnus-dont-move-articles-to-same-group variable when respooling.
16407 @item
16408  when messages are crossposted between several auto-expirable groups, 
16409 articles aren't properly marked as expirable.
16410 @item
16411  nneething should allow deletion/moving.
16412 @item
16413  TAB on the last button should go to the first button.
16414 @item
16415  if the car of an element in `mail-split-methods' is a function,
16416 and the function returns non-nil, use that as the name of the group(s) to 
16417 save mail in.
16418 @item
16419  command for listing all score files that have been applied.
16420 @item
16421  a command in the article buffer to return to `summary' config.
16422 @item
16423  `gnus-always-post-using-current-server' -- variable to override
16424 `C-c C-c' when posting.
16425 @item
16426  nnmail-group-spool-alist -- says where each group should use
16427 as a spool file.
16428 @item
16429  when an article is crossposted to an auto-expirable group, the article 
16430 should be marker as expirable.
16431 @item
16432  article mode command/menu for "send region as URL to browser".
16433 @item
16434  on errors, jump to info nodes that explain the error.  For instance,
16435 on invalid From headers, or on error messages from the nntp server.
16436 @item
16437  when gathering threads, make the article that has no "Re: " the parent.
16438 Also consult Date headers.
16439 @item
16440  a token in splits to call shrink-window-if-larger-than-buffer
16441 @item
16442  `1 0 A M' to do matches on the active hashtb.
16443 @item
16444  duplicates -- command to remove Gnus-Warning header, use the read 
16445 Message-ID, delete the "original".
16446 @item
16447  when replying to several messages at once, put the "other" message-ids
16448 into a See-Also header.
16449 @item
16450  support setext: URL:http://www.bsdi.com/setext/
16451 @item
16452  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
16453 @item
16454  when browsing a foreign server, the groups that are already subscribed
16455 should be listed as such and not as "K".
16456 @item
16457  generate font names dynamically.
16458 @item
16459  score file mode auto-alist.
16460 @item
16461  allow nndoc to change/add/delete things from documents.  Implement
16462 methods for each format for adding an article to the document.
16463 @item
16464  `gnus-fetch-old-headers' `all' value to incorporate
16465 absolutely all headers there is.
16466 @item
16467  function like `|', but concatenate all marked articles
16468 and pipe them to the process.
16469 @item
16470  cache the list of killed (or active) groups in a separate file.  Update
16471 the file whenever we read the active file or the list
16472 of killed groups in the .eld file reaches a certain length.
16473 @item
16474  function for starting to edit a file to put into 
16475 the current mail group.
16476 @item
16477  score-find-trace should display the total score of the article. 
16478 @item
16479  "ghettozie" -- score on Xref header and nix it out after using it 
16480 to avoid marking as read in other groups it has been crossposted to.
16481 @item
16482  look at procmail splitting.  The backends should create
16483 the groups automatically if a spool file exists for that group.
16484 @item
16485  function for backends to register themselves with Gnus.
16486 @item
16487  when replying to several process-marked articles, 
16488 have all the From end up in Cc headers?  Variable to toggle.
16489 @item
16490  command to delete a crossposted mail article from all 
16491 groups it has been mailed to.
16492 @item
16493  `B c' and `B m' should be crosspost aware.  
16494 @item
16495  hide-pgp should also hide PGP public key blocks.
16496 @item
16497  Command in the group buffer to respoll process-marked groups.
16498 @item
16499  `gnus-summary-find-matching' should accept
16500 pseudo-"headers" like "body", "head" and "all"
16501 @item
16502  When buttifying <URL: > things, all white space (including
16503 newlines) should be ignored.
16504 @item
16505  Process-marking all groups in a topic should process-mark
16506 groups in subtopics as well.
16507 @item
16508  Add non-native groups to the list of killed groups when killing them. 
16509 @item
16510  nntp-suggest-kewl-config to probe the nntp server and suggest
16511 variable settings.
16512 @item
16513  add edit and forward secondary marks.
16514 @item
16515  nnml shouldn't visit its .overview files.
16516 @item
16517  allow customizing sorting within gathered threads.
16518 @item
16519  `B q' shouldn't select the current article.
16520 @item
16521  nnmbox should support a newsgroups file for descriptions.
16522 @item
16523  allow fetching mail from several pop servers.
16524 @item
16525  Be able to specify whether the saving commands save the original
16526 or the formatted article.
16527 @item
16528  a command to reparent with the child process-marked (cf. `T ^'.).
16529 @item
16530  I think the possibility to send a password with nntp-open-rlogin
16531 should be a feature in Red Gnus.
16532 @item
16533  The `Z n' command should be possible to execute from a mouse click.
16534 @item
16535  more limiting functions -- date, etc.
16536 @item
16537  be able to limit on a random header; on body; using reverse matches.
16538 @item
16539  a group parameter (`absofucking-total-expiry') that will make Gnus expire
16540 even unread articles.
16541 @item
16542  a command to print the article buffer as postscript.
16543 @item
16544  variable to disable password fetching when opening by nntp-open-telnet.
16545 @item
16546  manual: more example servers -- nntp with rlogin, telnet
16547 @item
16548  checking for bogus groups should clean topic alists as well.
16549 @item
16550  cancelling articles in foreign groups.
16551 @item
16552  article number in folded topics isn't properly updated by
16553 Xref handling.
16554 @item
16555  Movement in the group buffer to the next unread group should go to the
16556 next closed topic with unread messages if no group can be found.
16557 @item
16558  Extensive info pages generated on the fly with help everywhere --
16559 in the "*Gnus edit*" buffers, for instance.
16560 @item
16561  Topic movement commands -- like thread movement.  Up, down, forward, next.
16562 @item
16563  a way to tick/mark as read Gcc'd articles.
16564 @item
16565  a way to say that all groups within a specific topic comes
16566 from a particular server?  Hm.
16567 @item
16568  `gnus-article-fill-if-long-lines' -- a function to fill
16569 the article buffer if there are any looong lines there.
16570 @item
16571  `T h' should jump to the parent topic and fold it.
16572 @item
16573  a command to create an ephemeral nndoc group out of a file,
16574 and then splitting it/moving it to some other group/backend.
16575 @item
16576  a group parameter for nnkiboze groups that says that
16577 all kibozed articles should be entered into the cache.
16578 @item
16579  It should also probably be possible to delimit what
16580 `gnus-jog-cache' does -- for instance, work on just some groups, or on
16581 some levels, and entering just articles that have a score higher than
16582 a certain number.
16583 @item
16584  nnfolder should append to the folder instead of re-writing
16585 the entire folder to disk when accepting new messages.
16586 @item
16587  allow all backends to do the proper thing with .gz files.
16588 @item
16589  a backend for reading collections of babyl files nnbabylfolder?
16590 @item
16591  a command for making the native groups into foreign groups. 
16592 @item
16593  server mode command for clearing read marks from all groups
16594 from a server.
16595 @item
16596  when following up mulitple articles, include all To, Cc, etc headers
16597 from all articles.
16598 @item
16599  a command for deciding what the total score of the current
16600 thread is.  Also a way to highlight based on this.
16601 @item
16602  command to show and edit group scores
16603 @item
16604  a gnus-tree-minimize-horizontal to minimize tree buffers
16605 horizontally.
16606 @item
16607  command to generate nnml overview file for one group.
16608 @item
16609  `C-u C-u a' -- prompt for many crossposted groups.
16610 @item
16611  keep track of which mail groups have received new articles (in this session).
16612 Be able to generate a report and perhaps do some marking in the group
16613 buffer.
16614 @item
16615  gnus-build-sparse-threads to a number -- build only sparse threads
16616 that are of that length.
16617 @item
16618  have nnmh respect mh's unseen sequence in .mh_profile.
16619 @item
16620  cache the newsgroups descriptions locally.
16621 @item
16622  asynchronous posting under nntp.
16623 @item
16624  be able to control word adaptive scoring from the score files.
16625 @item
16626  a variable to make `C-c C-c' post using the "current" select method. 
16627 @item
16628  `limit-exclude-low-scored-articles'.
16629 @item
16630  if `gnus-summary-show-thread' is a number, hide threads that have
16631 a score lower than this number.
16632 @item
16633  split newsgroup subscription variable up into "order" and "method".
16634 @item
16635  buttonize ange-ftp file names.
16636 @item
16637  a command to make a duplicate copy of the current article
16638 so that each copy can be edited separately.
16639 @item
16640  nnweb should allow fetching from the local nntp server.
16641 @item
16642  record the sorting done in the summary buffer so that
16643 it can be repeated when limiting/regenerating the buffer.
16644 @item
16645  nnml-generate-nov-databses should generate for
16646 all nnml servers.
16647 @item
16648  when the user does commands in the group buffer, check
16649 the modification time of the .newsrc.eld file and use
16650 ask-user-about-supersession-threat.  Also warn when trying
16651 to save .newsrc.eld and it has changed.
16652 @item
16653  M-g on a topic will display all groups with 0 articles in
16654 the topic.
16655 @item
16656  command to remove all topic stuff.
16657 @item
16658  allow exploding incoming digests when reading incoming mail
16659 and splitting the resulting digests.
16660 @item
16661  nnsoup shouldn't set the `message-' variables.
16662 @item
16663  command to nix out all nnoo state information.
16664 @item
16665  nnmail-process-alist that calls functions if group names 
16666 matches an alist -- before saving.
16667 @item
16668  use buffer-invisibility-spec everywhere for hiding text.
16669 @item
16670  variable to activate each group before entering them
16671 to get the (new) number of articles.  `gnus-activate-before-entering'.
16672 @item
16673  command to fetch a Message-ID from any buffer, even
16674 starting Gnus first if necessary.
16675 @item
16676  when posting and checking whether a group exists or not, just 
16677 ask the nntp server instead of relying on the active hashtb.
16678 @item
16679  buttonize the output of `C-c C-a' in an apropos-like way.
16680 @item
16681  `G p' should understand process/prefix, and allow editing
16682 of several groups at once.
16683 @item
16684  command to create an ephemeral nnvirtual group that
16685 matches some regexp(s).
16686 @item
16687  nndoc should understand "Content-Type: message/rfc822" forwarded messages. 
16688 @item
16689  it should be possible to score "thread" on the From header.
16690 @item
16691  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
16692 @item
16693  `B i' should display the article at once in the summary buffer.
16694 @item
16695  remove the "*" mark at once when unticking an article.
16696 @item
16697  `M-s' should highlight the matching text.
16698 @item
16699  when checking for duplicated mails, use Resent-Message-ID if present.
16700 @item
16701  killing and yanking groups in topics should be better.  If killing one copy
16702 of a group that exists in multiple topics, only that copy should
16703 be removed.  Yanking should insert the copy, and yanking topics
16704 should be possible to be interspersed with the other yankings.
16705 @item
16706  command for enter a group just to read the cached articles.  A way to say
16707 "ignore the nntp connection; just read from the cache."
16708 @item
16709  `X u' should decode base64 articles.
16710 @item
16711  a way to hide all "inner" cited text, leaving just the most
16712 recently cited text.
16713 @item
16714  nnvirtual should be asynchronous.
16715 @item
16716  after editing an article, gnus-original-article-buffer should
16717 be invalidated.
16718 @item
16719  there should probably be a way to make Gnus not connect to the
16720 server and just read the articles in the server
16721 @item
16722  allow a `set-default' (or something) to change the default
16723 value of nnoo variables.
16724 @item
16725  a command to import group infos from a .newsrc.eld file.
16726 @item
16727  groups from secondary servers have the entire select method
16728 listed in each group info.
16729 @item
16730  a command for just switching from the summary buffer to the group
16731 buffer.
16732 @item
16733  a way to specify that some incoming mail washing functions
16734 should only be applied to some groups.
16735 @item
16736  Message `C-f C-t' should ask the user whether to heed
16737 mail-copies-to: never.
16738 @item
16739  new group parameter -- `post-to-server' that says to post
16740 using the current server.  Also a variable to do the same.
16741 @item
16742  the slave dribble files should autosave to the slave file names.
16743 @item
16744  a group parameter that says what articles to display on group entry, based
16745 on article marks.
16746 @item
16747  a way to visually distinguish slave Gnusae from masters.  (Whip instead
16748 of normal logo?)
16749 @item
16750  Use DJ Bernstein "From " quoting/dequoting, where appliccable.
16751 @item
16752  Why is hide-citation-maybe and hide-citation different?  Also
16753 clear up info.
16754 @item
16755  group user-defined meta-parameters.
16756
16757
16758
16759 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
16760 @item
16761  I like the option for trying to retrieve the FAQ for a group and I was
16762 thinking it would be great if for those newsgroups that had archives
16763 you could also try to read the archive for that group.  Part of the
16764 problem is that archives are spread all over the net, unlike FAQs.
16765 What would be best I suppose is to find the one closest to your site.
16766
16767 In any case, there is a list of general news group archives at
16768 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
16769
16770
16771
16772
16773 @item
16774 @example
16775 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
16776 (add-hook 'gnus-select-group-hook
16777   (lambda ()
16778     (gnus-group-add-parameter group
16779        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
16780
16781 (defun gnus-user-format-function-d (headers)
16782   "Return the date the group was last read."
16783   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
16784       (t "")))
16785 @end example
16786
16787 @item
16788  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
16789 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
16790 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
16791 hatt forskjellige serveres startup-filer forskjellige steder.
16792
16793
16794 @item
16795 LMI> Well, nnbabyl could alter the group info to heed labels like
16796 LMI> answered and read, I guess.  
16797
16798 It could also keep them updated (the same for the Status: header of
16799 unix mbox files).
16800
16801 They could be used like this:
16802
16803
16804 @example
16805 `M l <name> RET' add label <name> to current message.
16806 `M u <name> RET' remove label <name> from current message.
16807 `/ l <expr> RET' limit summary buffer according to <expr>.
16808
16809 <expr> would be a boolean expression on the labels, e.g. 
16810
16811         `/ l bug & !fixed RET'
16812 @end example
16813
16814 would show all the messages which are labeled `bug' but not labeled
16815 `fixed'. 
16816
16817 One could also immagine the labels being used for highliting, or
16818 affect the summary line format.
16819
16820
16821 @item
16822 Sender: abraham@@dina.kvl.dk
16823
16824 I'd like a gnus-find-file which work like find file, except that it
16825 would recognize things that looks like messages or folders:
16826
16827 - If it is a directory containing numbered files, create an nndir
16828 summary buffer.
16829
16830 - For other directories, create a nneething summaru buffer.
16831
16832 - For files matching "\\`From ", create a nndoc/mbox summary.
16833
16834 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
16835
16836 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
16837
16838 - For other files, just find them normally.
16839
16840 I'd like `nneething' to use this function, so it would work on a
16841 directory potentially containing mboxes or babyl files.
16842
16843 @item
16844 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
16845 tell him what you are doing.
16846
16847 @item
16848 Currently, I get prompted:
16849
16850 decend into sci?
16851 - type y
16852 decend into sci.something ?
16853 - type n
16854 decend into ucd?
16855
16856 The problem above is that since there is really only one subsection of
16857 science, shouldn't it prompt you for only decending sci.something?  If
16858 there was a sci.somethingelse group or section, then it should prompt
16859 for sci? first the sci.something? then sci.somethingelse?...
16860
16861 @item
16862 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
16863 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
16864 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
16865 "no.all.SCORE", osv.
16866
16867 @item
16868 What i want is for Gnus to treat any sequence or combination of the following
16869 as a single spoiler warning and hide it all, replacing it with a "Next Page"
16870 button:
16871  
16872
16873         ^L's
16874
16875         more than n blank lines
16876         
16877         more than m identical lines 
16878         (which should be replaced with button to show them)
16879
16880         any whitespace surrounding any of the above
16881
16882
16883 @item
16884 Well, we could allow a new value to `gnus-thread-ignore-subject' --
16885 `spaces', or something.  (We could even default to that.)  And then
16886 subjects that differ in white space only could be considered the
16887 "same" subject for threading purposes. 
16888
16889 @item
16890 Modes to preprocess the contents (e.g. jka-compr) use the second form
16891 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
16892 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
16893 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
16894
16895 @item
16896  Under XEmacs -- do funny article marks:
16897 tick - thumb tack
16898 killed - skull
16899 soup - bowl of soup
16900 score below - dim light bulb
16901 score over - bright light bulb
16902
16903 @item
16904 Yes. I think the algorithm is as follows:
16905
16906 @example
16907 Group-mode
16908
16909    show-list-of-articles-in-group
16910         if (key-pressed == SPACE) 
16911                 if (no-more-articles-in-group-to-select) 
16912                         if (articles-selected)
16913                                 start-reading-selected-articles;
16914                         junk-unread-articles;
16915                         next-group;
16916                  else 
16917                         show-next-page;
16918                 
16919          else if (key-pressed = '.') 
16920                 if (consolidated-menus)         # same as hide-thread in Gnus
16921                         select-thread-under-cursor;
16922                 else
16923                         select-article-under-cursor;
16924         
16925
16926 Article-mode
16927         if (key-pressed == SPACE) 
16928                 if (more-pages-in-article)
16929                         next-page;
16930                 else if (more-selected-articles-to-read)
16931                         next-article;
16932                 else 
16933                         next-group;
16934 @end example
16935
16936 @item
16937 My precise need here would have been to limit files to Incoming*.
16938 One could think of some `nneething-only-files' variable, but I guess
16939 it would have been unacceptable if one was using many unrelated such
16940 nneething groups.
16941
16942 A more useful approach would be to, in response to the `G D' prompt, be
16943 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
16944 the top-level directory only (in case directories would be matched by
16945 the wildcard expression).
16946
16947 @item
16948 It would be nice if it also handled 
16949
16950         <URL:news://sunsite.auc.dk/>
16951
16952 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
16953
16954
16955 @item
16956
16957   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
16958 really well.  Each menu is 'named' by a symbol that would be on a
16959 gnus-*-menus (where * would be whatever, but at least group, summary, and
16960 article versions) variable.
16961
16962   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
16963
16964   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
16965 the main menubar.  This approach works really well for Emacs-W3 and VM.
16966
16967
16968 @item
16969  nndoc should take care to create unique Message-IDs for all its
16970 articles.
16971 @item
16972  gnus-score-followup-article only works when you have a summary buffer
16973 active.  Make it work when posting from the group buffer as well.
16974 (message-sent-hook).
16975 @item
16976  rewrite gnus-demon to use run-with-idle-timers.
16977
16978 @item
16979  * Enhancements to Gnus:
16980
16981   Add two commands:
16982
16983   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
16984     straight to the server buffer, without opening any connections to
16985     servers first.
16986
16987   * gnus-server-read-server-newsrc--produces a buffer very similar to
16988     the group buffer, but with only groups from that server listed;
16989     quitting this buffer returns to the server buffer.
16990
16991 @item
16992  add a command to check the integrity of an nnfolder folder --
16993 go through the article numbers and see that there are no duplicates,
16994 and stuff.
16995
16996 @item
16997  `unsmileyfy-buffer' to undo smileification.
16998
16999 @item
17000  a command to give all relevant info on an article, including all
17001 secondary marks.
17002
17003 @item
17004  when doing `-request-accept-article', the backends should do
17005 the nnmail duplicate checking.
17006
17007 @item
17008  allow `message-signature-file' to be a function to return the
17009 value of the signature file.
17010
17011 @item
17012  In addition, I would love it if I could configure message-tab so that it
17013 could call `bbdb-complete-name' in other headers.  So, some sort of
17014 interface like
17015
17016 (setq message-tab-alist
17017       '((message-header-regexp message-expand-group)
17018         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
17019
17020 then you could run the relevant function to complete the information in
17021 the header
17022
17023 @item
17024  cache the newsgroups file locally to avoid reloading it all the time.
17025
17026 @item
17027  a command to import a buffer into a group.
17028
17029 @item
17030  nnweb should allow fetching by Message-ID from servers.
17031
17032 @item
17033  point in the article buffer doesn't always go to the
17034 beginning of the buffer when selecting new articles.
17035
17036 @item
17037  a command to process mark all unread articles.
17038
17039 @item
17040  `gnus-gather-threads-by-references-and-subject' -- first
17041 do gathering by references, and then go through the dummy roots and
17042 do more gathering by subject.
17043
17044 @item
17045  gnus-uu-mark-in-numerical-order -- process mark articles in
17046 article numerical order.
17047
17048 @item
17049  (gnus-thread-total-score
17050  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
17051 bind to a key.
17052
17053 @item
17054  sorting by score is wrong when using sparse threads.
17055
17056 @item
17057  a command to fetch an arbitrary article -- without having to be
17058 in the summary buffer.
17059
17060 @item
17061  a new nncvs backend.  Each group would show an article, using
17062 version branches as threading, checkin date as the date, etc.
17063
17064 @item
17065  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
17066 This filter allows one to construct advance queries on the Dejanews
17067 database such as specifying start and end dates, subject, author,
17068 and/or newsgroup name.
17069
17070 @item
17071  new Date header scoring type -- older, newer
17072
17073 @item
17074  use the summary toolbar in the article buffer.
17075
17076 @item
17077  a command to fetch all articles that are less than X days old.
17078
17079 @item
17080  in pick mode, `q' should save the list of selected articles in the
17081 group info.  The next time the group is selected, these articles
17082 will automatically get the process mark.
17083
17084 @item
17085  Isn't it possible to (also?) allow M-^ to automatically try the
17086 default server if it fails on the current server?  (controlled by a
17087 user variable, (nil, t, 'ask)).
17088
17089 @item
17090  make it possible to cancel articles using the select method for the
17091 current group.
17092
17093 @item
17094  `gnus-summary-select-article-on-entry' or something.  It'll default
17095 to t and will select whatever article decided by `gnus-auto-select-first'.
17096
17097 @item
17098  a new variable to control which selection commands should be unselecting.
17099 `first', `best', `next', `prev', `next-unread', `prev-unread' are
17100 candidates.
17101
17102 @item
17103  be able to select groups that have no articles in them
17104 to be able to post in them (using the current select method).
17105
17106 @item
17107  be able to post via DejaNews.
17108
17109 @item
17110  `x' should retain any sortings that have been performed.
17111
17112 @item
17113  allow the user to specify the presedence of the secondary marks.  Also
17114 allow them to be displayed separately.
17115
17116 @item
17117  gnus-summary-save-in-pipe should concatenate the results from
17118 the processes when doing a process marked pipe.
17119
17120 @item
17121  a new match type, like Followup, but which adds Thread matches on all
17122 articles that match a certain From header.
17123
17124 @item
17125  a function that can be read from kill-emacs-query-functions to offer
17126 saving living summary buffers.
17127
17128 @item
17129  a function for selecting a particular group which will contain
17130 the articles listed in a list of article numbers/id's.
17131
17132 @item
17133  a battery of character translation functions to translate common
17134 Mac, MS (etc) characters into ISO 8859-1.
17135
17136 @example
17137 (defun article-fix-m$word ()
17138   "Fix M$Word smartquotes in an article."
17139   (interactive)
17140   (save-excursion
17141     (let ((buffer-read-only nil))
17142       (goto-char (point-min))
17143       (while (search-forward "\221" nil t)
17144         (replace-match "`" t t))
17145       (goto-char (point-min))
17146       (while (search-forward "\222" nil t)
17147         (replace-match "'" t t))
17148       (goto-char (point-min))
17149       (while (search-forward "\223" nil t)
17150         (replace-match "\"" t t))
17151       (goto-char (point-min))
17152       (while (search-forward "\224" nil t)
17153         (replace-match "\"" t t)))))
17154 @end example
17155
17156 @item
17157 @example
17158  (add-hook 'gnus-exit-query-functions
17159 '(lambda ()
17160    (if (and (file-exists-p nnmail-spool-file)
17161             (> (nnheader-file-size nnmail-spool-file) 0))
17162        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
17163        (y-or-n-p "Are you sure you want to quit Gnus? "))))
17164 @end example
17165
17166 @item
17167  allow message-default-headers to be a function.
17168
17169 @item
17170  new Date score match types -- < > = (etc) that take floating point
17171 numbers and match on the age of the article.
17172
17173 @item
17174  gnus-cacheable-groups
17175
17176 @item
17177 @example
17178 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
17179 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
17180 >  > > buffer in the frame that it was called from =:-O
17181
17182 >  > Hm.  How do you start up Gnus?  From the toolbar or with
17183 >  > `M-x gnus-other-frame'?  
17184
17185 >    I normally start it up from the toolbar; at
17186 > least that's the way I've caught it doing the
17187 > deed before.
17188 @end example
17189
17190 @item
17191  all commands that react to the process mark should push
17192 the current process mark set onto the stack.
17193
17194 @item
17195  gnus-article-hide-pgp
17196 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
17197 @example
17198 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
17199 @end example
17200 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
17201 er min type heuristikk og langt fra alles.
17202
17203 @item
17204  `gnus-subscribe-sorted' -- insert new groups where they would have been
17205 sorted to if `gnus-group-sort-function' were run.
17206
17207 @item
17208  gnus-(group,summary)-highlight should respect any `face' text props set
17209 on the lines.
17210
17211 @item
17212  use run-with-idle-timer for gnus-demon instead of the
17213 home-brewed stuff for better reliability.
17214
17215 @item
17216  add a way to select which NoCeM type to apply -- spam, troll, etc.
17217
17218 @item
17219  nndraft-request-group should tally autosave files.
17220
17221 @item
17222  implement nntp-retry-on-break and nntp-command-timeout.
17223
17224 @item
17225  gnus-article-highlight-limit that says when not to highlight (long)
17226 articles.
17227
17228 @item
17229  (nnoo-set SERVER VARIABLE VALUE)
17230
17231 @item
17232  nn*-spool-methods
17233
17234 @item
17235  interrupitng agent fetching of articles should save articles.
17236
17237 @item
17238  command to open a digest group, and copy all the articles there to the
17239 current group.
17240
17241 @item
17242  a variable to disable article body highlights if there's more than
17243 X characters in the body.
17244
17245 @item
17246  handle 480/381 authinfo requests separately.
17247
17248 @item
17249  include the texi/dir file in the distribution.
17250
17251 @item
17252  format spec to "tab" to a position.
17253
17254 @item
17255  Move all prompting to the new `M-n' default style.
17256
17257 @item
17258  command to display all dormant articles.
17259
17260 @item
17261  gnus-auto-select-next makeover -- list of things it should do.
17262
17263 @item
17264  a score match type that adds scores matching on From if From has replied
17265 to something someone else has said.
17266
17267 @item
17268  Read Netscape discussion groups:
17269 snews://secnews.netscape.com/netscape.communicator.unix 
17270
17271 @item
17272 One command to edit the original version if an article, and one to edit
17273 the displayed version.
17274
17275 @item
17276 @kbd{T v} -- make all process-marked articles the children of the
17277 current article.
17278
17279 @item
17280 Switch from initial text to the new default text mechanism.
17281
17282 @item
17283 How about making it possible to expire local articles?  Will it be
17284 possible to make various constraints on when an article can be
17285 expired, e.g. (read), (age > 14 days), or the more interesting (read
17286 & age > 14 days)?
17287
17288 @item
17289 New limit command---limit to articles that have a certain string
17290 in the head or body.
17291
17292 @item
17293 Allow breaking lengthy NNTP commands.
17294
17295 @item
17296 Solve the halting problem.
17297
17298 @c TODO
17299 @end itemize
17300
17301 @iftex
17302
17303 @page
17304 @node The Manual
17305 @section The Manual
17306 @cindex colophon
17307 @cindex manual
17308
17309 This manual was generated from a TeXinfo file and then run through
17310 either @code{texi2dvi}
17311 @iflatex
17312 or my own home-brewed TeXinfo to \LaTeX\ transformer,
17313 and then run through @code{latex} and @code{dvips} 
17314 @end iflatex
17315 to get what you hold in your hands now.
17316
17317 The following conventions have been used:
17318
17319 @enumerate
17320
17321 @item
17322 This is a @samp{string}
17323
17324 @item
17325 This is a @kbd{keystroke}
17326
17327 @item
17328 This is a @file{file}
17329
17330 @item 
17331 This is a @code{symbol}
17332
17333 @end enumerate
17334
17335 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
17336 mean:
17337
17338 @lisp
17339 (setq flargnoze "yes")
17340 @end lisp
17341
17342 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
17343
17344 @lisp
17345 (setq flumphel 'yes)
17346 @end lisp
17347
17348 @samp{yes} and @code{yes} are two @emph{very} different things---don't
17349 ever get them confused.
17350
17351 @iflatex
17352 @c @head
17353 Of course, everything in this manual is of vital interest, so you should
17354 read it all.  Several times.  However, if you feel like skimming the
17355 manual, look for that gnu head you should see in the margin over
17356 there---it means that what's being discussed is of more importance than
17357 the rest of the stuff.  (On the other hand, if everything is infinitely
17358 important, how can anything be more important than that?  Just one more
17359 of the mysteries of this world, I guess.)
17360 @end iflatex
17361
17362 @end iftex
17363
17364
17365 @page
17366 @node Terminology
17367 @section Terminology
17368
17369 @cindex terminology
17370 @table @dfn
17371
17372 @item news
17373 @cindex news
17374 This is what you are supposed to use this thing for---reading news.
17375 News is generally fetched from a nearby @sc{nntp} server, and is
17376 generally publicly available to everybody.  If you post news, the entire
17377 world is likely to read just what you have written, and they'll all
17378 snigger mischievously.  Behind your back.
17379
17380 @item mail
17381 @cindex mail
17382 Everything that's delivered to you personally is mail.  Some news/mail
17383 readers (like Gnus) blur the distinction between mail and news, but
17384 there is a difference.  Mail is private.  News is public.  Mailing is
17385 not posting, and replying is not following up.
17386
17387 @item reply
17388 @cindex reply
17389 Send a mail to the person who has written what you are reading.
17390
17391 @item follow up
17392 @cindex follow up
17393 Post an article to the current newsgroup responding to the article you
17394 are reading.
17395
17396 @item backend
17397 @cindex backend
17398 Gnus gets fed articles from a number of backends, both news and mail
17399 backends.  Gnus does not handle the underlying media, so to speak---this
17400 is all done by the backends.
17401
17402 @item native
17403 @cindex native
17404 Gnus will always use one method (and backend) as the @dfn{native}, or
17405 default, way of getting news.
17406
17407 @item foreign
17408 @cindex foreign
17409 You can also have any number of foreign groups active at the same time.
17410 These are groups that use non-native non-secondary backends for getting
17411 news.
17412
17413 @item secondary
17414 @cindex secondary
17415 Secondary backends are somewhere half-way between being native and being
17416 foreign, but they mostly act like they are native.
17417
17418 @item article
17419 @cindex article
17420 A message that has been posted as news.
17421
17422 @item mail message
17423 @cindex mail message
17424 A message that has been mailed.
17425
17426 @item message 
17427 @cindex message
17428 A mail message or news article
17429
17430 @item head
17431 @cindex head
17432 The top part of a message, where administrative information (etc.) is
17433 put.
17434
17435 @item body
17436 @cindex body
17437 The rest of an article.  Everything not in the head is in the
17438 body. 
17439
17440 @item header
17441 @cindex header
17442 A line from the head of an article. 
17443
17444 @item headers
17445 @cindex headers
17446 A collection of such lines, or a collection of heads.  Or even a
17447 collection of @sc{nov} lines.
17448
17449 @item @sc{nov}
17450 @cindex nov
17451 When Gnus enters a group, it asks the backend for the headers of all
17452 unread articles in the group.  Most servers support the News OverView
17453 format, which is more compact and much faster to read and parse than the
17454 normal @sc{head} format.
17455
17456 @item level
17457 @cindex levels
17458 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
17459 that have a lower level are ``more'' subscribed than the groups with a
17460 higher level.  In fact, groups on levels 1-5 are considered
17461 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
17462 are @dfn{killed}.  Commands for listing groups and scanning for new
17463 articles will all use the numeric prefix as @dfn{working level}.
17464
17465 @item killed groups
17466 @cindex killed groups
17467 No information on killed groups is stored or updated, which makes killed
17468 groups much easier to handle than subscribed groups.
17469
17470 @item zombie groups
17471 @cindex zombie groups
17472 Just like killed groups, only slightly less dead.
17473
17474 @item active file
17475 @cindex active file
17476 The news server has to keep track of what articles it carries, and what
17477 groups exist.  All this information in stored in the active file, which
17478 is rather large, as you might surmise.
17479
17480 @item bogus groups
17481 @cindex bogus groups
17482 A group that exists in the @file{.newsrc} file, but isn't known to the
17483 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
17484 This means that the group probably doesn't exist (any more).
17485
17486 @item activating
17487 @cindex activating groups
17488 The act of asking the server for info on a group and computing the
17489 number of unread articles is called @dfn{activating the group}.
17490 Un-activated groups are listed with @samp{*} in the group buffer.
17491
17492 @item server 
17493 @cindex server
17494 A machine one can connect to and get news (or mail) from.
17495
17496 @item select method
17497 @cindex select method
17498 A structure that specifies the backend, the server and the virtual
17499 server settings.
17500
17501 @item virtual server
17502 @cindex virtual server
17503 A named select method.  Since a select method defines all there is to
17504 know about connecting to a (physical) server, taking the thing as a
17505 whole is a virtual server.
17506
17507 @item washing
17508 @cindex washing
17509 Taking a buffer and running it through a filter of some sort.  The
17510 result will (more often than not) be cleaner and more pleasing than the
17511 original. 
17512
17513 @item ephemeral groups
17514 @cindex ephemeral groups
17515 Most groups store data on what articles you have read.  @dfn{Ephemeral}
17516 groups are groups that will have no data stored---when you exit the
17517 group, it'll disappear into the aether.  
17518
17519 @item solid groups
17520 @cindex solid groups
17521 This is the opposite of ephemeral groups.  All groups listed in the
17522 group buffer are solid groups.
17523
17524 @item sparse articles
17525 @cindex sparse articles
17526 These are article placeholders shown in the summary buffer when
17527 @code{gnus-build-sparse-threads} has been switched on.
17528
17529 @item threading
17530 @cindex threading
17531 To put responses to articles directly after the articles they respond
17532 to---in a hierarchical fashion.
17533
17534 @item root
17535 @cindex root
17536 @cindex thread root
17537 The first article in a thread is the root.  It is the ancestor of all
17538 articles in the thread.
17539
17540 @item parent
17541 @cindex parent
17542 An article that has responses.
17543
17544 @item child
17545 @cindex child
17546 An article that responds to a different article---its parent.
17547
17548 @item digest
17549 @cindex digest
17550 A collection of messages in one file.  The most common digest format is
17551 specified by RFC1153.
17552
17553 @end table
17554
17555
17556 @page
17557 @node Customization
17558 @section Customization
17559 @cindex general customization
17560
17561 All variables are properly documented elsewhere in this manual.  This
17562 section is designed to give general pointers on how to customize Gnus
17563 for some quite common situations.
17564
17565 @menu
17566 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
17567 * Slow Terminal Connection::  You run a remote Emacs.
17568 * Little Disk Space::         You feel that having large setup files is icky.
17569 * Slow Machine::              You feel like buying a faster machine.
17570 @end menu
17571
17572
17573 @node Slow/Expensive Connection
17574 @subsection Slow/Expensive @sc{nntp} Connection
17575
17576 If you run Emacs on a machine locally, and get your news from a machine
17577 over some very thin strings, you want to cut down on the amount of data
17578 Gnus has to get from the @sc{nntp} server.
17579
17580 @table @code
17581
17582 @item gnus-read-active-file
17583 Set this to @code{nil}, which will inhibit Gnus from requesting the
17584 entire active file from the server.  This file is often v.  large.  You
17585 also have to set @code{gnus-check-new-newsgroups} and
17586 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
17587 doesn't suddenly decide to fetch the active file anyway.
17588
17589 @item gnus-nov-is-evil
17590 This one has to be @code{nil}.  If not, grabbing article headers from
17591 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
17592 support @sc{xover}; Gnus will detect this by itself.
17593 @end table
17594
17595
17596 @node Slow Terminal Connection
17597 @subsection Slow Terminal Connection
17598
17599 Let's say you use your home computer for dialing up the system that runs
17600 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
17601 possible) the amount of data sent over the wires.
17602
17603 @table @code
17604
17605 @item gnus-auto-center-summary
17606 Set this to @code{nil} to inhibit Gnus from re-centering the summary
17607 buffer all the time.  If it is @code{vertical}, do only vertical
17608 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
17609 horizontal and vertical recentering.
17610
17611 @item gnus-visible-headers
17612 Cut down on the headers included in the articles to the
17613 minimum.  You can, in fact, make do without them altogether---most of the
17614 useful data is in the summary buffer, anyway.  Set this variable to
17615 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
17616
17617 @item gnus-article-display-hook
17618 Set this hook to all the available hiding commands:
17619 @lisp
17620 (setq gnus-article-display-hook 
17621       '(gnus-article-hide-headers gnus-article-hide-signature
17622         gnus-article-hide-citation))
17623 @end lisp
17624
17625 @item gnus-use-full-window
17626 By setting this to @code{nil}, you can make all the windows smaller.
17627 While this doesn't really cut down much generally, it means that you
17628 have to see smaller portions of articles before deciding that you didn't
17629 want to read them anyway.
17630
17631 @item gnus-thread-hide-subtree
17632 If this is non-@code{nil}, all threads in the summary buffer will be
17633 hidden initially.
17634
17635 @item gnus-updated-mode-lines
17636 If this is @code{nil}, Gnus will not put information in the buffer mode
17637 lines, which might save some time.
17638 @end table
17639
17640
17641 @node Little Disk Space
17642 @subsection Little Disk Space
17643 @cindex disk space
17644
17645 The startup files can get rather large, so you may want to cut their
17646 sizes a bit if you are running out of space.
17647
17648 @table @code
17649
17650 @item gnus-save-newsrc-file
17651 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
17652 only save @file{.newsrc.eld}.  This means that you will not be able to
17653 use any other newsreaders than Gnus.  This variable is @code{t} by
17654 default. 
17655
17656 @item gnus-save-killed-list
17657 If this is @code{nil}, Gnus will not save the list of dead groups.  You
17658 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
17659 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
17660 variable to @code{nil}.  This variable is @code{t} by default.
17661
17662 @end table
17663
17664
17665 @node Slow Machine
17666 @subsection Slow Machine
17667 @cindex slow machine
17668
17669 If you have a slow machine, or are just really impatient, there are a
17670 few things you can do to make Gnus run faster.
17671
17672 Set @code{gnus-check-new-newsgroups} and
17673 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
17674
17675 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
17676 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
17677 summary buffer faster.
17678
17679 Set @code{gnus-article-display-hook} to @code{nil} to make article
17680 processing a bit faster.
17681
17682
17683 @page
17684 @node Troubleshooting
17685 @section Troubleshooting
17686 @cindex troubleshooting
17687
17688 Gnus works @emph{so} well straight out of the box---I can't imagine any
17689 problems, really.
17690
17691 Ahem.
17692
17693 @enumerate
17694
17695 @item
17696 Make sure your computer is switched on.
17697
17698 @item
17699 Make sure that you really load the current Gnus version.  If you have
17700 been running @sc{gnus}, you need to exit Emacs and start it up again before
17701 Gnus will work.
17702
17703 @item
17704 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
17705 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
17706 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
17707 flee}, you have some old @file{.el} files lying around.  Delete these.
17708
17709 @item
17710 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
17711 how-to. 
17712
17713 @item
17714 @vindex max-lisp-eval-depth
17715 Gnus works on many recursive structures, and in some extreme (and very
17716 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
17717 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
17718 something like that.
17719 @end enumerate
17720
17721 If all else fails, report the problem as a bug.
17722
17723 @cindex bugs
17724 @cindex reporting bugs
17725
17726 @kindex M-x gnus-bug
17727 @findex gnus-bug
17728 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
17729 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
17730 me the backtrace.  I will fix bugs, but I can only fix them if you send
17731 me a precise description as to how to reproduce the bug.
17732
17733 You really can never be too detailed in a bug report.  Always use the
17734 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
17735 a 10Kb mail each time you use it, and even if you have sent me your
17736 environment 500 times before.  I don't care.  I want the full info each
17737 time.  
17738
17739 It is also important to remember that I have no memory whatsoever.  If
17740 you send a bug report, and I send you a reply, and then you just send
17741 back ``No, it's not! Moron!'', I will have no idea what you are
17742 insulting me about.  Always over-explain everything.  It's much easier
17743 for all of us---if I don't have all the information I need, I will just
17744 mail you and ask for more info, and everything takes more time.
17745
17746 If the problem you're seeing is very visual, and you can't quite explain
17747 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
17748 it somewhere it can be reached, and include the URL of the picture in
17749 the bug report.
17750
17751 If you just need help, you are better off asking on
17752 @samp{gnu.emacs.gnus}.  I'm not very helpful.
17753
17754 @cindex gnu.emacs.gnus
17755 @cindex ding mailing list
17756 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
17757 Write to @samp{ding-request@@gnus.org} to subscribe.
17758
17759
17760 @page
17761 @node A Programmers Guide to Gnus
17762 @section A Programmer@'s Guide to Gnus
17763
17764 It is my hope that other people will figure out smart stuff that Gnus
17765 can do, and that other people will write those smart things as well.  To
17766 facilitate that I thought it would be a good idea to describe the inner
17767 workings of Gnus.  And some of the not-so-inner workings, while I'm at
17768 it.
17769
17770 You can never expect the internals of a program not to change, but I
17771 will be defining (in some details) the interface between Gnus and its
17772 backends (this is written in stone), the format of the score files
17773 (ditto), data structures (some are less likely to change than others)
17774 and general methods of operation.
17775
17776 @menu 
17777 * Gnus Utility Functions::   Common functions and variable to use.
17778 * Backend Interface::        How Gnus communicates with the servers.
17779 * Score File Syntax::        A BNF definition of the score file standard.
17780 * Headers::                  How Gnus stores headers internally.
17781 * Ranges::                   A handy format for storing mucho numbers.
17782 * Group Info::               The group info format.
17783 * Extended Interactive::     Symbolic prefixes and stuff.
17784 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
17785 * Various File Formats::     Formats of files that Gnus use.
17786 @end menu
17787
17788
17789 @node Gnus Utility Functions
17790 @subsection Gnus Utility Functions
17791 @cindex Gnus utility functions
17792 @cindex utility functions
17793 @cindex functions
17794 @cindex internal variables
17795
17796 When writing small functions to be run from hooks (and stuff), it's
17797 vital to have access to the Gnus internal functions and variables.
17798 Below is a list of the most common ones.
17799
17800 @table @code
17801
17802 @item gnus-newsgroup-name
17803 @vindex gnus-newsgroup-name
17804 This variable holds the name of the current newsgroup.
17805
17806 @item gnus-find-method-for-group
17807 @findex gnus-find-method-for-group
17808 A function that returns the select method for @var{group}.
17809
17810 @item gnus-group-real-name
17811 @findex gnus-group-real-name
17812 Takes a full (prefixed) Gnus group name, and returns the unprefixed
17813 name.
17814
17815 @item gnus-group-prefixed-name
17816 @findex gnus-group-prefixed-name
17817 Takes an unprefixed group name and a select method, and returns the full
17818 (prefixed) Gnus group name.
17819
17820 @item gnus-get-info
17821 @findex gnus-get-info
17822 Returns the group info list for @var{group}.
17823
17824 @item gnus-add-current-to-buffer-list
17825 @findex gnus-add-current-to-buffer-list
17826 Adds the current buffer to the list of buffers to be killed on Gnus
17827 exit.
17828
17829 @item gnus-continuum-version
17830 @findex gnus-continuum-version
17831 Takes a Gnus version string as a parameter and returns a floating point
17832 number.  Earlier versions will always get a lower number than later
17833 versions.
17834
17835 @item gnus-group-read-only-p
17836 @findex gnus-group-read-only-p
17837 Says whether @var{group} is read-only or not.
17838
17839 @item gnus-news-group-p
17840 @findex gnus-news-group-p
17841 Says whether @var{group} came from a news backend.
17842
17843 @item gnus-ephemeral-group-p
17844 @findex gnus-ephemeral-group-p
17845 Says whether @var{group} is ephemeral or not.
17846
17847 @item gnus-server-to-method
17848 @findex gnus-server-to-method
17849 Returns the select method corresponding to @var{server}.
17850
17851 @item gnus-server-equal
17852 @findex gnus-server-equal
17853 Says whether two virtual servers are equal.
17854
17855 @item gnus-group-native-p
17856 @findex gnus-group-native-p
17857 Says whether @var{group} is native or not.
17858
17859 @item gnus-group-secondary-p
17860 @findex gnus-group-secondary-p
17861 Says whether @var{group} is secondary or not.
17862
17863 @item gnus-group-foreign-p
17864 @findex gnus-group-foreign-p
17865 Says whether @var{group} is foreign or not.
17866
17867 @item group-group-find-parameter
17868 @findex group-group-find-parameter
17869 Returns the parameter list of @var{group}.  If given a second parameter,
17870 returns the value of that parameter for @var{group}.
17871
17872 @item gnus-group-set-parameter
17873 @findex gnus-group-set-parameter
17874 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
17875
17876 @item gnus-narrow-to-body
17877 @findex gnus-narrow-to-body
17878 Narrows the current buffer to the body of the article.
17879
17880 @item gnus-check-backend-function
17881 @findex gnus-check-backend-function
17882 Takes two parameters, @var{function} and @var{group}.  If the backend
17883 @var{group} comes from supports @var{function}, return non-@code{nil}.
17884
17885 @lisp
17886 (gnus-check-backend-function "request-scan" "nnml:misc")
17887 => t
17888 @end lisp
17889
17890 @item gnus-read-method
17891 @findex gnus-read-method
17892 Prompts the user for a select method.
17893
17894 @end table
17895
17896
17897 @node Backend Interface
17898 @subsection Backend Interface
17899
17900 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
17901 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
17902 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
17903 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
17904 examples of the latter we have @code{nntp-port-number} and
17905 @code{nnmbox-directory}.
17906
17907 When Gnus asks for information from a backend---say @code{nntp}---on
17908 something, it will normally include a virtual server name in the
17909 function parameters.  (If not, the backend should use the ``current''
17910 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
17911 server as its only (optional) parameter.  If this virtual server hasn't
17912 been opened, the function should fail.
17913
17914 Note that a virtual server name has no relation to some physical server
17915 name.  Take this example:
17916
17917 @lisp
17918 (nntp "odd-one" 
17919       (nntp-address "ifi.uio.no") 
17920       (nntp-port-number 4324))
17921 @end lisp
17922
17923 Here the virtual server name is @samp{odd-one} while the name of
17924 the physical server is @samp{ifi.uio.no}. 
17925
17926 The backends should be able to switch between several virtual servers.
17927 The standard backends implement this by keeping an alist of virtual
17928 server environments that they pull down/push up when needed.  
17929
17930 There are two groups of interface functions: @dfn{required functions},
17931 which must be present, and @dfn{optional functions}, which Gnus will
17932 always check for presence before attempting to call 'em.
17933
17934 All these functions are expected to return data in the buffer
17935 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
17936 unfortunately named, but we'll have to live with it.  When I talk about
17937 @dfn{resulting data}, I always refer to the data in that buffer.  When I
17938 talk about @dfn{return value}, I talk about the function value returned by
17939 the function call.  Functions that fail should return @code{nil} as the
17940 return value.
17941
17942 Some backends could be said to be @dfn{server-forming} backends, and
17943 some might be said not to be.  The latter are backends that generally
17944 only operate on one group at a time, and have no concept of ``server''
17945 -- they have a group, and they deliver info on that group and nothing
17946 more.
17947
17948 In the examples and definitions I will refer to the imaginary backend
17949 @code{nnchoke}. 
17950
17951 @cindex @code{nnchoke}
17952
17953 @menu
17954 * Required Backend Functions::        Functions that must be implemented.
17955 * Optional Backend Functions::        Functions that need not be implemented.
17956 * Error Messaging::                   How to get messages and report errors.
17957 * Writing New Backends::              Extending old backends.
17958 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
17959 * Mail-like Backends::                Some tips on mail backends.
17960 @end menu
17961
17962
17963 @node Required Backend Functions
17964 @subsubsection Required Backend Functions
17965
17966 @table @code
17967
17968 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
17969
17970 @var{articles} is either a range of article numbers or a list of
17971 @code{Message-ID}s.  Current backends do not fully support either---only
17972 sequences (lists) of article numbers, and most backends do not support
17973 retrieval of @code{Message-ID}s.  But they should try for both. 
17974
17975 The result data should either be HEADs or NOV lines, and the result
17976 value should either be @code{headers} or @code{nov} to reflect this.
17977 This might later be expanded to @code{various}, which will be a mixture
17978 of HEADs and NOV lines, but this is currently not supported by Gnus.  
17979
17980 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
17981 headers", in some meaning of the word.  This is generally done by
17982 fetching (at most) @var{fetch-old} extra headers less than the smallest
17983 article number in @code{articles}, and filling the gaps as well.  The
17984 presence of this parameter can be ignored if the backend finds it
17985 cumbersome to follow the request.  If this is non-@code{nil} and not a
17986 number, do maximum fetches.
17987
17988 Here's an example HEAD:
17989
17990 @example
17991 221 1056 Article retrieved.
17992 Path: ifi.uio.no!sturles
17993 From: sturles@@ifi.uio.no (Sturle Sunde)
17994 Newsgroups: ifi.discussion
17995 Subject: Re: Something very droll
17996 Date: 27 Oct 1994 14:02:57 +0100
17997 Organization: Dept. of Informatics, University of Oslo, Norway
17998 Lines: 26
17999 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
18000 References: <38jdmq$4qu@@visbur.ifi.uio.no>
18001 NNTP-Posting-Host: holmenkollen.ifi.uio.no
18002 .
18003 @end example
18004
18005 So a @code{headers} return value would imply that there's a number of
18006 these in the data buffer.
18007
18008 Here's a BNF definition of such a buffer:
18009
18010 @example
18011 headers        = *head
18012 head           = error / valid-head
18013 error-message  = [ "4" / "5" ] 2number " " <error message> eol
18014 valid-head     = valid-message *header "." eol
18015 valid-message  = "221 " <number> " Article retrieved." eol
18016 header         = <text> eol
18017 @end example
18018
18019 If the return value is @code{nov}, the data buffer should contain
18020 @dfn{network overview database} lines.  These are basically fields
18021 separated by tabs. 
18022
18023 @example
18024 nov-buffer = *nov-line
18025 nov-line   = 8*9 [ field <TAB> ] eol
18026 field      = <text except TAB>
18027 @end example
18028
18029 For a closer look at what should be in those fields,
18030 @pxref{Headers}. 
18031
18032
18033 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
18034
18035 @var{server} is here the virtual server name.  @var{definitions} is a
18036 list of @code{(VARIABLE VALUE)} pairs that define this virtual server. 
18037
18038 If the server can't be opened, no error should be signaled.  The backend
18039 may then choose to refuse further attempts at connecting to this
18040 server.  In fact, it should do so. 
18041
18042 If the server is opened already, this function should return a
18043 non-@code{nil} value.  There should be no data returned.
18044
18045
18046 @item (nnchoke-close-server &optional SERVER)
18047
18048 Close connection to @var{server} and free all resources connected
18049 to it.  Return @code{nil} if the server couldn't be closed for some
18050 reason.
18051
18052 There should be no data returned.
18053
18054
18055 @item (nnchoke-request-close)
18056
18057 Close connection to all servers and free all resources that the backend
18058 have reserved.  All buffers that have been created by that backend
18059 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
18060 function is generally only called when Gnus is shutting down.
18061
18062 There should be no data returned. 
18063
18064
18065 @item (nnchoke-server-opened &optional SERVER)
18066
18067 If @var{server} is the current virtual server, and the connection to the
18068 physical server is alive, then this function should return a
18069 non-@code{nil} vlue.  This function should under no circumstances
18070 attempt to reconnect to a server we have lost connection to.
18071
18072 There should be no data returned.
18073
18074
18075 @item (nnchoke-status-message &optional SERVER)
18076
18077 This function should return the last error message from @var{server}. 
18078
18079 There should be no data returned.
18080
18081
18082 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
18083
18084 The result data from this function should be the article specified by
18085 @var{article}.  This might either be a @code{Message-ID} or a number.
18086 It is optional whether to implement retrieval by @code{Message-ID}, but
18087 it would be nice if that were possible.
18088
18089 If @var{to-buffer} is non-@code{nil}, the result data should be returned
18090 in this buffer instead of the normal data buffer.  This is to make it
18091 possible to avoid copying large amounts of data from one buffer to
18092 another, while Gnus mainly requests articles to be inserted directly
18093 into its article buffer.
18094
18095 If it is at all possible, this function should return a cons cell where
18096 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
18097 the article number.  This will enable Gnus to find out what the real
18098 group and article numbers are when fetching articles by
18099 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
18100 on successful article retrieval.
18101
18102
18103 @item (nnchoke-request-group GROUP &optional SERVER FAST)
18104
18105 Get data on @var{group}.  This function also has the side effect of
18106 making @var{group} the current group. 
18107
18108 If @var{FAST}, don't bother to return useful data, just make @var{group}
18109 the current group.
18110
18111 Here's an example of some result data and a definition of the same:
18112
18113 @example
18114 211 56 1000 1059 ifi.discussion
18115 @end example
18116
18117 The first number is the status, which should be 211.  Next is the
18118 total number of articles in the group, the lowest article number, the
18119 highest article number, and finally the group name.  Note that the total
18120 number of articles may be less than one might think while just
18121 considering the highest and lowest article numbers, but some articles
18122 may have been canceled.  Gnus just discards the total-number, so
18123 whether one should take the bother to generate it properly (if that is a
18124 problem) is left as an exercise to the reader.
18125
18126 @example
18127 group-status = [ error / info ] eol
18128 error        = [ "4" / "5" ] 2<number> " " <Error message>
18129 info         = "211 " 3* [ <number> " " ] <string>
18130 @end example
18131
18132
18133 @item (nnchoke-close-group GROUP &optional SERVER)
18134
18135 Close @var{group} and free any resources connected to it.  This will be
18136 a no-op on most backends. 
18137
18138 There should be no data returned.
18139
18140
18141 @item (nnchoke-request-list &optional SERVER)
18142
18143 Return a list of all groups available on @var{server}.  And that means
18144 @emph{all}. 
18145
18146 Here's an example from a server that only carries two groups:
18147
18148 @example
18149 ifi.test 0000002200 0000002000 y
18150 ifi.discussion 3324 3300 n
18151 @end example
18152
18153 On each line we have a group name, then the highest article number in
18154 that group, the lowest article number, and finally a flag.
18155
18156 @example
18157 active-file = *active-line
18158 active-line = name " " <number> " " <number> " " flags eol
18159 name        = <string>
18160 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
18161 @end example
18162
18163 The flag says whether the group is read-only (@samp{n}), is moderated
18164 (@samp{m}), is dead (@samp{x}), is aliased to some other group
18165 (@samp{=other-group}) or none of the above (@samp{y}). 
18166
18167
18168 @item (nnchoke-request-post &optional SERVER)
18169
18170 This function should post the current buffer.  It might return whether
18171 the posting was successful or not, but that's not required.  If, for
18172 instance, the posting is done asynchronously, it has generally not been
18173 completed by the time this function concludes.  In that case, this
18174 function should set up some kind of sentinel to beep the user loud and
18175 clear if the posting could not be completed.
18176
18177 There should be no result data from this function. 
18178
18179 @end table
18180
18181
18182 @node Optional Backend Functions
18183 @subsubsection Optional Backend Functions
18184
18185 @table @code
18186
18187 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
18188
18189 @var{groups} is a list of groups, and this function should request data
18190 on all those groups.  How it does it is of no concern to Gnus, but it
18191 should attempt to do this in a speedy fashion.
18192
18193 The return value of this function can be either @code{active} or
18194 @code{group}, which says what the format of the result data is.  The
18195 former is in the same format as the data from
18196 @code{nnchoke-request-list}, while the latter is a buffer full of lines
18197 in the same format as @code{nnchoke-request-group} gives.
18198
18199 @example
18200 group-buffer = *active-line / *group-status
18201 @end example
18202
18203
18204 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
18205
18206 A Gnus group info (@pxref{Group Info}) is handed to the backend for
18207 alterations.  This comes in handy if the backend really carries all the
18208 information (as is the case with virtual and imap groups).  This
18209 function should destructively alter the info to suit its needs, and
18210 should return the (altered) group info.
18211
18212 There should be no result data from this function.
18213
18214
18215 @item (nnchoke-request-type GROUP &optional ARTICLE)
18216
18217 When the user issues commands for ``sending news'' (@kbd{F} in the
18218 summary buffer, for instance), Gnus has to know whether the article the
18219 user is following up on is news or mail.  This function should return
18220 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
18221 is mail and @code{unknown} if the type can't be decided.  (The
18222 @var{article} parameter is necessary in @code{nnvirtual} groups which
18223 might very well combine mail groups and news groups.)  Both @var{group}
18224 and @var{article} may be @code{nil}.
18225
18226 There should be no result data from this function.
18227
18228
18229 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
18230
18231 If the user tries to set a mark that the backend doesn't like, this
18232 function may change the mark.  Gnus will use whatever this function
18233 returns as the mark for @var{article} instead of the original
18234 @var{mark}.  If the backend doesn't care, it must return the original
18235 @var{mark}, and not @code{nil} or any other type of garbage.  
18236
18237 The only use for this I can see is what @code{nnvirtual} does with
18238 it---if a component group is auto-expirable, marking an article as read
18239 in the virtual group should result in the article being marked as
18240 expirable. 
18241
18242 There should be no result data from this function.
18243
18244
18245 @item (nnchoke-request-scan &optional GROUP SERVER)
18246
18247 This function may be called at any time (by Gnus or anything else) to
18248 request that the backend check for incoming articles, in one way or
18249 another.  A mail backend will typically read the spool file or query the
18250 POP server when this function is invoked.  The @var{group} doesn't have
18251 to be heeded---if the backend decides that it is too much work just
18252 scanning for a single group, it may do a total scan of all groups.  It
18253 would be nice, however, to keep things local if that's practical.
18254
18255 There should be no result data from this function.
18256
18257
18258 @item (nnchoke-request-group-description GROUP &optional SERVER)
18259
18260 The result data from this function should be a description of
18261 @var{group}. 
18262
18263 @example
18264 description-line = name <TAB> description eol
18265 name             = <string>
18266 description      = <text>
18267 @end example
18268
18269 @item (nnchoke-request-list-newsgroups &optional SERVER)
18270
18271 The result data from this function should be the description of all
18272 groups available on the server.
18273
18274 @example
18275 description-buffer = *description-line
18276 @end example
18277
18278
18279 @item (nnchoke-request-newgroups DATE &optional SERVER)
18280
18281 The result data from this function should be all groups that were
18282 created after @samp{date}, which is in normal human-readable date
18283 format.  The data should be in the active buffer format.
18284
18285
18286 @item (nnchoke-request-create-group GROUP &optional SERVER)
18287
18288 This function should create an empty group with name @var{group}.  
18289
18290 There should be no return data.
18291
18292
18293 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
18294
18295 This function should run the expiry process on all articles in the
18296 @var{articles} range (which is currently a simple list of article
18297 numbers.)  It is left up to the backend to decide how old articles
18298 should be before they are removed by this function.  If @var{force} is
18299 non-@code{nil}, all @var{articles} should be deleted, no matter how new
18300 they are. 
18301
18302 This function should return a list of articles that it did not/was not
18303 able to delete.
18304
18305 There should be no result data returned.
18306
18307
18308 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
18309 &optional LAST)
18310
18311 This function should move @var{article} (which is a number) from
18312 @var{group} by calling @var{accept-form}.  
18313
18314 This function should ready the article in question for moving by
18315 removing any header lines it has added to the article, and generally
18316 should ``tidy up'' the article.  Then it should @code{eval}
18317 @var{accept-form} in the buffer where the ``tidy'' article is.  This
18318 will do the actual copying.  If this @code{eval} returns a
18319 non-@code{nil} value, the article should be removed.
18320
18321 If @var{last} is @code{nil}, that means that there is a high likelihood
18322 that there will be more requests issued shortly, so that allows some
18323 optimizations. 
18324
18325 The function should return a cons where the @code{car} is the group name and
18326 the @code{cdr} is the article number that the article was entered as.
18327
18328 There should be no data returned. 
18329
18330
18331 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
18332
18333 This function takes the current buffer and inserts it into @var{group}.
18334 If @var{last} in @code{nil}, that means that there will be more calls to
18335 this function in short order.
18336
18337 The function should return a cons where the @code{car} is the group name and
18338 the @code{cdr} is the article number that the article was entered as.
18339
18340 There should be no data returned.
18341
18342
18343 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
18344
18345 This function should remove @var{article} (which is a number) from
18346 @var{group} and insert @var{buffer} there instead.
18347
18348 There should be no data returned.
18349
18350
18351 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
18352
18353 This function should delete @var{group}.  If @var{force}, it should
18354 really delete all the articles in the group, and then delete the group
18355 itself.  (If there is such a thing as ``the group itself''.)
18356
18357 There should be no data returned.
18358
18359
18360 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
18361
18362 This function should rename @var{group} into @var{new-name}.  All
18363 articles in @var{group} should move to @var{new-name}.
18364
18365 There should be no data returned.
18366
18367 @end table
18368
18369
18370 @node Error Messaging
18371 @subsubsection Error Messaging
18372
18373 @findex nnheader-report
18374 @findex nnheader-get-report
18375 The backends should use the function @code{nnheader-report} to report
18376 error conditions---they should not raise errors when they aren't able to
18377 perform a request.  The first argument to this function is the backend
18378 symbol, and the rest are interpreted as arguments to @code{format} if
18379 there are multiple of them, or just a string if there is one of them.
18380 This function must always returns @code{nil}.
18381
18382 @lisp
18383 (nnheader-report 'nnchoke "You did something totally bogus")
18384
18385 (nnheader-report 'nnchoke "Could not request group %s" group)
18386 @end lisp
18387
18388 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
18389 @code{nil} back from a server, and this function returns the most
18390 recently reported message for the backend in question.  This function
18391 takes one argument---the server symbol.
18392
18393 Internally, these functions access @var{backend}@code{-status-string},
18394 so the @code{nnchoke} backend will have its error message stored in
18395 @code{nnchoke-status-string}.
18396
18397
18398 @node Writing New Backends
18399 @subsubsection Writing New Backends
18400
18401 Many backends are quite similar.  @code{nnml} is just like
18402 @code{nnspool}, but it allows you to edit the articles on the server.
18403 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
18404 and it doesn't maintain overview databases.  @code{nndir} is just like
18405 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
18406 editing articles.
18407
18408 It would make sense if it were possible to ``inherit'' functions from
18409 backends when writing new backends.  And, indeed, you can do that if you
18410 want to.  (You don't have to if you don't want to, of course.)  
18411
18412 All the backends declare their public variables and functions by using a
18413 package called @code{nnoo}.  
18414
18415 To inherit functions from other backends (and allow other backends to
18416 inherit functions from the current backend), you should use the
18417 following macros:
18418
18419 @table @code
18420
18421 @item nnoo-declare
18422 This macro declares the first parameter to be a child of the subsequent
18423 parameters.  For instance:
18424
18425 @lisp
18426 (nnoo-declare nndir
18427   nnml nnmh)
18428 @end lisp
18429
18430 @code{nndir} has declared here that it intends to inherit functions from
18431 both @code{nnml} and @code{nnmh}.
18432
18433 @item defvoo
18434 This macro is equivalent to @code{defvar}, but registers the variable as
18435 a public server variable.  Most state-oriented variables should be
18436 declared with @code{defvoo} instead of @code{defvar}.  
18437
18438 In addition to the normal @code{defvar} parameters, it takes a list of
18439 variables in the parent backends to map the variable to when executing
18440 a function in those backends.
18441
18442 @lisp
18443 (defvoo nndir-directory nil
18444   "Where nndir will look for groups."
18445   nnml-current-directory nnmh-current-directory)
18446 @end lisp
18447
18448 This means that @code{nnml-current-directory} will be set to
18449 @code{nndir-directory} when an @code{nnml} function is called on behalf
18450 of @code{nndir}.  (The same with @code{nnmh}.)  
18451
18452 @item nnoo-define-basics
18453 This macro defines some common functions that almost all backends should
18454 have.
18455
18456 @example
18457 (nnoo-define-basics nndir)
18458 @end example
18459
18460 @item deffoo
18461 This macro is just like @code{defun} and takes the same parameters.  In
18462 addition to doing the normal @code{defun} things, it registers the
18463 function as being public so that other backends can inherit it.
18464
18465 @item nnoo-map-functions
18466 This macro allows mapping of functions from the current backend to
18467 functions from the parent backends.
18468
18469 @example
18470 (nnoo-map-functions nndir
18471   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18472   (nnmh-request-article 0 nndir-current-group 0 0))
18473 @end example
18474
18475 This means that when @code{nndir-retrieve-headers} is called, the first,
18476 third, and fourth parameters will be passed on to
18477 @code{nnml-retrieve-headers}, while the second parameter is set to the
18478 value of @code{nndir-current-group}.
18479
18480 @item nnoo-import
18481 This macro allows importing functions from backends.  It should be the
18482 last thing in the source file, since it will only define functions that
18483 haven't already been defined.
18484
18485 @example
18486 (nnoo-import nndir
18487   (nnmh
18488    nnmh-request-list
18489    nnmh-request-newgroups)
18490   (nnml))
18491 @end example
18492
18493 This means that calls to @code{nndir-request-list} should just be passed
18494 on to @code{nnmh-request-list}, while all public functions from
18495 @code{nnml} that haven't been defined in @code{nndir} yet should be
18496 defined now.
18497
18498 @end table
18499
18500 Below is a slightly shortened version of the @code{nndir} backend.
18501
18502 @lisp
18503 ;;; nndir.el --- single directory newsgroup access for Gnus
18504 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
18505
18506 ;;; Code:
18507
18508 (require 'nnheader)
18509 (require 'nnmh)
18510 (require 'nnml)
18511 (require 'nnoo)
18512 (eval-when-compile (require 'cl))
18513
18514 (nnoo-declare nndir
18515   nnml nnmh)
18516
18517 (defvoo nndir-directory nil
18518   "Where nndir will look for groups."
18519   nnml-current-directory nnmh-current-directory)
18520
18521 (defvoo nndir-nov-is-evil nil
18522   "*Non-nil means that nndir will never retrieve NOV headers."
18523   nnml-nov-is-evil)
18524
18525 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
18526 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
18527 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
18528
18529 (defvoo nndir-status-string "" nil nnmh-status-string)
18530 (defconst nndir-version "nndir 1.0")
18531
18532 ;;; Interface functions.
18533
18534 (nnoo-define-basics nndir)
18535
18536 (deffoo nndir-open-server (server &optional defs)
18537   (setq nndir-directory
18538         (or (cadr (assq 'nndir-directory defs))
18539             server))
18540   (unless (assq 'nndir-directory defs)
18541     (push `(nndir-directory ,server) defs))
18542   (push `(nndir-current-group
18543           ,(file-name-nondirectory (directory-file-name nndir-directory)))
18544         defs)
18545   (push `(nndir-top-directory
18546           ,(file-name-directory (directory-file-name nndir-directory)))
18547         defs)
18548   (nnoo-change-server 'nndir server defs))
18549
18550 (nnoo-map-functions nndir
18551   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18552   (nnmh-request-article 0 nndir-current-group 0 0)
18553   (nnmh-request-group nndir-current-group 0 0)
18554   (nnmh-close-group nndir-current-group 0))
18555
18556 (nnoo-import nndir
18557   (nnmh
18558    nnmh-status-message
18559    nnmh-request-list
18560    nnmh-request-newgroups))
18561
18562 (provide 'nndir)
18563 @end lisp
18564
18565
18566 @node Hooking New Backends Into Gnus
18567 @subsubsection Hooking New Backends Into Gnus
18568
18569 @vindex gnus-valid-select-methods
18570 Having Gnus start using your new backend is rather easy---you just
18571 declare it with the @code{gnus-declare-backend} functions.  This will
18572 enter the backend into the @code{gnus-valid-select-methods} variable.
18573
18574 @code{gnus-declare-backend} takes two parameters---the backend name and
18575 an arbitrary number of @dfn{abilities}.
18576
18577 Here's an example:
18578
18579 @lisp
18580 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
18581 @end lisp
18582
18583 The abilities can be:
18584
18585 @table @code
18586 @item mail
18587 This is a mailish backend---followups should (probably) go via mail.
18588 @item post
18589 This is a newsish backend---followups should (probably) go via news. 
18590 @item post-mail
18591 This backend supports both mail and news.
18592 @item none
18593 This is neither a post nor mail backend---it's something completely
18594 different. 
18595 @item respool
18596 It supports respooling---or rather, it is able to modify its source
18597 articles and groups.
18598 @item address
18599 The name of the server should be in the virtual server name.  This is
18600 true for almost all backends.
18601 @item prompt-address
18602 The user should be prompted for an address when doing commands like
18603 @kbd{B} in the group buffer.  This is true for backends like
18604 @code{nntp}, but not @code{nnmbox}, for instance. 
18605 @end table
18606
18607
18608 @node Mail-like Backends
18609 @subsubsection Mail-like Backends
18610
18611 One of the things that separate the mail backends from the rest of the
18612 backends is the heavy dependence by the mail backends on common
18613 functions in @file{nnmail.el}.  For instance, here's the definition of
18614 @code{nnml-request-scan}: 
18615
18616 @lisp
18617 (deffoo nnml-request-scan (&optional group server)
18618   (setq nnml-article-file-alist nil)
18619   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
18620 @end lisp
18621
18622 It simply calls @code{nnmail-get-new-mail} with a few parameters,
18623 and @code{nnmail} takes care of all the moving and splitting of the
18624 mail.  
18625
18626 This function takes four parameters.
18627
18628 @table @var
18629 @item method
18630 This should be a symbol to designate which backend is responsible for
18631 the call.
18632
18633 @item exit-function
18634 This function should be called after the splitting has been performed.
18635
18636 @item temp-directory
18637 Where the temporary files should be stored.
18638
18639 @item group
18640 This optional argument should be a group name if the splitting is to be
18641 performed for one group only.
18642 @end table
18643
18644 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
18645 save each article.  @var{backend}@code{-active-number} will be called to
18646 find the article number assigned to this article.  
18647
18648 The function also uses the following variables:
18649 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
18650 this backend); and @var{backend}@code{-group-alist} and
18651 @var{backend}@code{-active-file} to generate the new active file.
18652 @var{backend}@code{-group-alist} should be a group-active alist, like
18653 this:
18654
18655 @example
18656 (("a-group" (1 . 10))
18657  ("some-group" (34 . 39)))
18658 @end example
18659
18660
18661 @node Score File Syntax
18662 @subsection Score File Syntax
18663
18664 Score files are meant to be easily parsable, but yet extremely
18665 mallable.   It was decided that something that had the same read syntax
18666 as an Emacs Lisp list would fit that spec.
18667
18668 Here's a typical score file:
18669
18670 @lisp
18671 (("summary"
18672   ("win95" -10000 nil s)
18673   ("Gnus"))
18674  ("from"
18675   ("Lars" -1000))
18676  (mark -100))
18677 @end lisp
18678
18679 BNF definition of a score file:
18680
18681 @example
18682 score-file       = "" / "(" *element ")"
18683 element          = rule / atom
18684 rule             = string-rule / number-rule / date-rule
18685 string-rule      = "(" quote string-header quote space *string-match ")"
18686 number-rule      = "(" quote number-header quote space *number-match ")"
18687 date-rule        = "(" quote date-header quote space *date-match ")"
18688 quote            = <ascii 34>
18689 string-header    = "subject" / "from" / "references" / "message-id" / 
18690                    "xref" / "body" / "head" / "all" / "followup"
18691 number-header    = "lines" / "chars"
18692 date-header      = "date"
18693 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
18694                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
18695 score            = "nil" / <integer>
18696 date             = "nil" / <natural number>
18697 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
18698                    "r" / "regex" / "R" / "Regex" /
18699                    "e" / "exact" / "E" / "Exact" /
18700                    "f" / "fuzzy" / "F" / "Fuzzy"
18701 number-match     = "(" <integer> [ "" / [ space score [ "" / 
18702                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
18703 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
18704 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
18705                    space date [ "" / [ space date-match-t ] ] ] ] ")"
18706 date-match-t     = "nil" / "at" / "before" / "after"
18707 atom             = "(" [ required-atom / optional-atom ] ")"
18708 required-atom    = mark / expunge / mark-and-expunge / files /
18709                    exclude-files / read-only / touched
18710 optional-atom    = adapt / local / eval 
18711 mark             = "mark" space nil-or-number
18712 nil-or-number    = "nil" / <integer>
18713 expunge          = "expunge" space nil-or-number
18714 mark-and-expunge = "mark-and-expunge" space nil-or-number
18715 files            = "files" *[ space <string> ]
18716 exclude-files    = "exclude-files" *[ space <string> ]
18717 read-only        = "read-only" [ space "nil" / space "t" ]
18718 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
18719 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
18720 local            = "local" *[ space "(" <string> space <form> ")" ]
18721 eval             = "eval" space <form>
18722 space            = *[ " " / <TAB> / <NEWLINE> ]
18723 @end example
18724
18725 Any unrecognized elements in a score file should be ignored, but not
18726 discarded.  
18727
18728 As you can see, white space is needed, but the type and amount of white
18729 space is irrelevant.  This means that formatting of the score file is
18730 left up to the programmer---if it's simpler to just spew it all out on
18731 one looong line, then that's ok.
18732
18733 The meaning of the various atoms are explained elsewhere in this
18734 manual (@pxref{Score File Format}).
18735
18736
18737 @node Headers
18738 @subsection Headers
18739
18740 Internally Gnus uses a format for storing article headers that
18741 corresponds to the @sc{nov} format in a mysterious fashion.  One could
18742 almost suspect that the author looked at the @sc{nov} specification and
18743 just shamelessly @emph{stole} the entire thing, and one would be right.
18744
18745 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
18746 RFC1036 to talk about lines in the head of an article (e.g.,
18747 @code{From}).  It is used by many people as a synonym for
18748 ``head''---``the header and the body''.  (That should be avoided, in my
18749 opinion.)  And Gnus uses a format internally that it calls ``header'',
18750 which is what I'm talking about here.  This is a 9-element vector,
18751 basically, with each header (ouch) having one slot.
18752
18753 These slots are, in order: @code{number}, @code{subject}, @code{from},
18754 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
18755 @code{xref}.  There are macros for accessing and setting these
18756 slots---they all have predictable names beginning with
18757 @code{mail-header-} and @code{mail-header-set-}, respectively.
18758
18759 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
18760 be put in there.
18761
18762
18763 @node Ranges
18764 @subsection Ranges
18765
18766 @sc{gnus} introduced a concept that I found so useful that I've started
18767 using it a lot and have elaborated on it greatly. 
18768
18769 The question is simple: If you have a large amount of objects that are
18770 identified by numbers (say, articles, to take a @emph{wild} example)
18771 that you want to qualify as being ``included'', a normal sequence isn't
18772 very useful.  (A 200,000 length sequence is a bit long-winded.)
18773
18774 The solution is as simple as the question: You just collapse the
18775 sequence. 
18776
18777 @example
18778 (1 2 3 4 5 6 10 11 12)
18779 @end example
18780
18781 is transformed into
18782
18783 @example
18784 ((1 . 6) (10 . 12))
18785 @end example
18786
18787 To avoid having those nasty @samp{(13 . 13)} elements to denote a
18788 lonesome object, a @samp{13} is a valid element:
18789
18790 @example
18791 ((1 . 6) 7 (10 . 12))
18792 @end example
18793
18794 This means that comparing two ranges to find out whether they are equal
18795 is slightly tricky:
18796
18797 @example
18798 ((1 . 5) 7 8 (10 . 12))
18799 @end example
18800
18801 and
18802
18803 @example
18804 ((1 . 5) (7 . 8) (10 . 12))
18805 @end example
18806
18807 are equal.  In fact, any non-descending list is a range:
18808
18809 @example
18810 (1 2 3 4 5)
18811 @end example
18812
18813 is a perfectly valid range, although a pretty long-winded one.  This is
18814 also valid:
18815
18816 @example
18817 (1 . 5)
18818 @end example
18819
18820 and is equal to the previous range.
18821
18822 Here's a BNF definition of ranges.  Of course, one must remember the
18823 semantic requirement that the numbers are non-descending.  (Any number
18824 of repetition of the same number is allowed, but apt to disappear in
18825 range handling.)
18826
18827 @example
18828 range           = simple-range / normal-range
18829 simple-range    = "(" number " . " number ")"
18830 normal-range    = "(" start-contents ")"
18831 contents        = "" / simple-range *[ " " contents ] / 
18832                   number *[ " " contents ]
18833 @end example
18834
18835 Gnus currently uses ranges to keep track of read articles and article
18836 marks.  I plan on implementing a number of range operators in C if The
18837 Powers That Be are willing to let me.  (I haven't asked yet, because I
18838 need to do some more thinking on what operators I need to make life
18839 totally range-based without ever having to convert back to normal
18840 sequences.) 
18841
18842
18843 @node Group Info
18844 @subsection Group Info
18845
18846 Gnus stores all permanent info on groups in a @dfn{group info} list.
18847 This list is from three to six elements (or more) long and exhaustively
18848 describes the group.
18849
18850 Here are two example group infos; one is a very simple group while the
18851 second is a more complex one:
18852
18853 @example
18854 ("no.group" 5 (1 . 54324))
18855
18856 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
18857                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
18858                 (nnml "")
18859                 (auto-expire (to-address "ding@@gnus.org")))
18860 @end example
18861
18862 The first element is the @dfn{group name}---as Gnus knows the group,
18863 anyway.  The second element is the @dfn{subscription level}, which
18864 normally is a small integer.  (It can also be the @dfn{rank}, which is a
18865 cons cell where the @code{car} is the level and the @code{cdr} is the
18866 score.)  The third element is a list of ranges of read articles.  The
18867 fourth element is a list of lists of article marks of various kinds.
18868 The fifth element is the select method (or virtual server, if you like).
18869 The sixth element is a list of @dfn{group parameters}, which is what
18870 this section is about.
18871
18872 Any of the last three elements may be missing if they are not required.
18873 In fact, the vast majority of groups will normally only have the first
18874 three elements, which saves quite a lot of cons cells.
18875
18876 Here's a BNF definition of the group info format:
18877
18878 @example
18879 info          = "(" group space ralevel space read 
18880                 [ "" / [ space marks-list [ "" / [ space method [ "" /
18881                 space parameters ] ] ] ] ] ")" 
18882 group         = quote <string> quote
18883 ralevel       = rank / level
18884 level         = <integer in the range of 1 to inf>
18885 rank          = "(" level "." score ")"
18886 score         = <integer in the range of 1 to inf>
18887 read          = range
18888 marks-lists   = nil / "(" *marks ")"
18889 marks         = "(" <string> range ")"
18890 method        = "(" <string> *elisp-forms ")"
18891 parameters    = "(" *elisp-forms ")"
18892 @end example
18893
18894 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
18895 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
18896 in pseudo-BNF.
18897
18898 If you have a Gnus info and want to access the elements, Gnus offers a
18899 series of macros for getting/setting these elements.
18900
18901 @table @code
18902 @item gnus-info-group
18903 @itemx gnus-info-set-group
18904 @findex gnus-info-group
18905 @findex gnus-info-set-group
18906 Get/set the group name.
18907
18908 @item gnus-info-rank
18909 @itemx gnus-info-set-rank
18910 @findex gnus-info-rank
18911 @findex gnus-info-set-rank
18912 Get/set the group rank (@pxref{Group Score}).
18913
18914 @item gnus-info-level
18915 @itemx gnus-info-set-level
18916 @findex gnus-info-level
18917 @findex gnus-info-set-level
18918 Get/set the group level.
18919
18920 @item gnus-info-score
18921 @itemx gnus-info-set-score
18922 @findex gnus-info-score
18923 @findex gnus-info-set-score
18924 Get/set the group score (@pxref{Group Score}).
18925
18926 @item gnus-info-read
18927 @itemx gnus-info-set-read
18928 @findex gnus-info-read
18929 @findex gnus-info-set-read
18930 Get/set the ranges of read articles.
18931
18932 @item gnus-info-marks
18933 @itemx gnus-info-set-marks
18934 @findex gnus-info-marks
18935 @findex gnus-info-set-marks
18936 Get/set the lists of ranges of marked articles.
18937
18938 @item gnus-info-method
18939 @itemx gnus-info-set-method
18940 @findex gnus-info-method
18941 @findex gnus-info-set-method
18942 Get/set the group select method.
18943
18944 @item gnus-info-params
18945 @itemx gnus-info-set-params
18946 @findex gnus-info-params
18947 @findex gnus-info-set-params
18948 Get/set the group parameters.
18949 @end table
18950
18951 All the getter functions take one parameter---the info list.  The setter
18952 functions take two parameters---the info list and the new value.
18953
18954 The last three elements in the group info aren't mandatory, so it may be
18955 necessary to extend the group info before setting the element.  If this
18956 is necessary, you can just pass on a non-@code{nil} third parameter to
18957 the three final setter functions to have this happen automatically.
18958
18959
18960 @node Extended Interactive
18961 @subsection Extended Interactive
18962 @cindex interactive
18963 @findex gnus-interactive
18964
18965 Gnus extends the standard Emacs @code{interactive} specification
18966 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
18967 Prefixes}).  Here's an example of how this is used:
18968
18969 @lisp
18970 (defun gnus-summary-increase-score (&optional score symp)
18971   (interactive (gnus-interactive "P\ny"))
18972   ...
18973   )
18974 @end lisp
18975
18976 The best thing to do would have been to implement
18977 @code{gnus-interactive} as a macro which would have returned an
18978 @code{interactive} form, but this isn't possible since Emacs checks
18979 whether a function is interactive or not by simply doing an @code{assq}
18980 on the lambda form.  So, instead we have @code{gnus-interactive}
18981 function that takes a string and returns values that are usable to
18982 @code{interactive}.
18983
18984 This function accepts (almost) all normal @code{interactive} specs, but
18985 adds a few more.
18986
18987 @table @samp
18988 @item y
18989 @vindex gnus-current-prefix-symbol
18990 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
18991 variable.
18992
18993 @item Y
18994 @vindex gnus-current-prefix-symbols
18995 A list of the current symbolic prefixes---the
18996 @code{gnus-current-prefix-symbol} variable.
18997
18998 @item A
18999 The current article number---the @code{gnus-summary-article-number}
19000 function. 
19001
19002 @item H
19003 The current article header---the @code{gnus-summary-article-header}
19004 function. 
19005
19006 @item g
19007 The current group name---the @code{gnus-group-group-name}
19008 function. 
19009
19010 @end table
19011
19012
19013 @node Emacs/XEmacs Code
19014 @subsection Emacs/XEmacs Code
19015 @cindex XEmacs
19016 @cindex Emacsen
19017
19018 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
19019 platforms must be the primary one.  I chose Emacs.  Not because I don't
19020 like XEmacs or Mule, but because it comes first alphabetically.
19021
19022 This means that Gnus will byte-compile under Emacs with nary a warning,
19023 while XEmacs will pump out gigabytes of warnings while byte-compiling.
19024 As I use byte-compilation warnings to help me root out trivial errors in
19025 Gnus, that's very useful.  
19026
19027 I've also consistently used Emacs function interfaces, but have used
19028 Gnusey aliases for the functions.  To take an example:  Emacs defines a
19029 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
19030 function.  I then define a function called @code{gnus-run-at-time} that
19031 takes the same parameters as the Emacs @code{run-at-time}.  When running
19032 Gnus under Emacs, the former function is just an alias for the latter.
19033 However, when running under XEmacs, the former is an alias for the
19034 following function:
19035
19036 @lisp
19037 (defun gnus-xmas-run-at-time (time repeat function &rest args)
19038   (start-itimer
19039    "gnus-run-at-time"
19040    `(lambda ()
19041       (,function ,@@args))
19042    time repeat))
19043 @end lisp
19044
19045 This sort of thing has been done for bunches of functions.  Gnus does
19046 not redefine any native Emacs functions while running under XEmacs---it
19047 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
19048 all over.
19049
19050 In the cases where the XEmacs function interface was obviously cleaner,
19051 I used it instead.  For example @code{gnus-region-active-p} is an alias
19052 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
19053
19054 Of course, I could have chosen XEmacs as my native platform and done
19055 mapping functions the other way around.  But I didn't.  The performance
19056 hit these indirections impose on Gnus under XEmacs should be slight.
19057
19058
19059 @node Various File Formats
19060 @subsection Various File Formats
19061
19062 @menu
19063 * Active File Format::      Information on articles and groups available.
19064 * Newsgroups File Format::  Group descriptions.
19065 @end menu
19066
19067
19068 @node Active File Format
19069 @subsubsection Active File Format
19070
19071 The active file lists all groups available on the server in
19072 question.  It also lists the highest and lowest current article numbers
19073 in each group.  
19074
19075 Here's an excerpt from a typical active file:
19076
19077 @example
19078 soc.motss 296030 293865 y
19079 alt.binaries.pictures.fractals 3922 3913 n
19080 comp.sources.unix 1605 1593 m
19081 comp.binaries.ibm.pc 5097 5089 y
19082 no.general 1000 900 y
19083 @end example
19084
19085 Here's a pseudo-BNF definition of this file:
19086
19087 @example
19088 active      = *group-line
19089 group-line  = group space high-number space low-number space flag <NEWLINE>
19090 group       = <non-white-space string>
19091 space       = " "
19092 high-number = <non-negative integer>
19093 low-number  = <positive integer>
19094 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
19095 @end example
19096
19097 For a full description of this file, see the manual pages for
19098 @samp{innd}, in particular @samp{active(5)}.
19099
19100
19101 @node Newsgroups File Format
19102 @subsubsection Newsgroups File Format
19103
19104 The newsgroups file lists groups along with their descriptions.  Not all
19105 groups on the server have to be listed,  and not all groups in the file
19106 have to exist on the server.  The file is meant purely as information to
19107 the user.
19108
19109 The format is quite simple; a group name, a tab, and the description.
19110 Here's the definition:
19111
19112 @example
19113 newsgroups    = *line
19114 line          = group tab description <NEWLINE>
19115 group         = <non-white-space string>
19116 tab           = <TAB>
19117 description   = <string>
19118 @end example
19119
19120
19121 @page
19122 @node Emacs for Heathens
19123 @section Emacs for Heathens
19124
19125 Believe it or not, but some people who use Gnus haven't really used
19126 Emacs much before they embarked on their journey on the Gnus Love Boat.
19127 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
19128 region'', and ``set @code{gnus-flargblossen} to an alist where the key
19129 is a regexp that is used for matching on the group name'' are magical
19130 phrases with little or no meaning, then this appendix is for you.  If
19131 you are already familiar with Emacs, just ignore this and go fondle your
19132 cat instead.
19133
19134 @menu
19135 * Keystrokes::      Entering text and executing commands.
19136 * Emacs Lisp::      The built-in Emacs programming language.
19137 @end menu
19138
19139
19140 @node Keystrokes
19141 @subsection Keystrokes
19142
19143 @itemize @bullet
19144 @item
19145 Q: What is an experienced Emacs user?
19146
19147 @item 
19148 A: A person who wishes that the terminal had pedals.
19149 @end itemize
19150
19151 Yes, when you use Emacs, you are apt to use the control key, the shift
19152 key and the meta key a lot.  This is very annoying to some people
19153 (notably @code{vi}le users), and the rest of us just love the hell out
19154 of it.  Just give up and submit.  Emacs really does stand for
19155 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
19156 may have heard from other disreputable sources (like the Emacs author).
19157
19158 The shift keys are normally located near your pinky fingers, and are
19159 normally used to get capital letters and stuff.  You probably use it all
19160 the time.  The control key is normally marked ``CTRL'' or something like
19161 that.  The meta key is, funnily enough, never marked as such on any
19162 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
19163 which is the meta key on this keyboard.  It's usually located somewhere
19164 to the left hand side of the keyboard, usually on the bottom row.
19165
19166 Now, us Emacs people don't say ``press the meta-control-m key'',
19167 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
19168 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
19169 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
19170 down the control key, and hold it down while you press @kbd{k}''.
19171 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
19172 the control key and then press @kbd{k}''.  Simple, ay?
19173
19174 This is somewhat complicated by the fact that not all keyboards have a
19175 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
19176 means ``press escape, release escape, press @kbd{k}''.  That's much more
19177 work than if you have a meta key, so if that's the case, I respectfully
19178 suggest you get a real keyboard with a meta key.  You can't live without
19179 it.
19180
19181
19182
19183 @node Emacs Lisp
19184 @subsection Emacs Lisp
19185
19186 Emacs is the King of Editors because it's really a Lisp interpreter.
19187 Each and every key you tap runs some Emacs Lisp code snippet, and since
19188 Emacs Lisp is an interpreted language, that means that you can configure
19189 any key to run any arbitrary code.  You just, like, do it.
19190
19191 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
19192 functions.  (These are byte-compiled for speed, but it's still
19193 interpreted.)  If you decide that you don't like the way Gnus does
19194 certain things, it's trivial to have it do something a different way.
19195 (Well, at least if you know how to write Lisp code.)  However, that's
19196 beyond the scope of this manual, so we are simply going to talk about
19197 some common constructs that you normally use in your @file{.emacs} file
19198 to customize Gnus.
19199
19200 If you want to set the variable @code{gnus-florgbnize} to four (4), you
19201 write the following:
19202
19203 @lisp
19204 (setq gnus-florgbnize 4)
19205 @end lisp
19206
19207 This function (really ``special form'') @code{setq} is the one that can
19208 set a variable to some value.  This is really all you need to know.  Now
19209 you can go and fill your @code{.emacs} file with lots of these to change
19210 how Gnus works.
19211
19212 If you have put that thing in your @code{.emacs} file, it will be read
19213 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
19214 start Emacs.  If you want to change the variable right away, simply say
19215 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
19216 previous ``form'', which is a simple @code{setq} statement here.
19217
19218 Go ahead---just try it, if you're located at your Emacs.  After you
19219 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
19220 is the return value of the form you @code{eval}ed.
19221
19222 Some pitfalls:
19223
19224 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
19225 that means:
19226
19227 @lisp
19228 (setq gnus-read-active-file 'some)
19229 @end lisp
19230
19231 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
19232 @samp{nntp.ifi.uio.no}'', that means:
19233
19234 @lisp
19235 (setq gnus-nntp-server "nntp.ifi.uio.no")
19236 @end lisp
19237
19238 So be careful not to mix up strings (the latter) with symbols (the
19239 former).  The manual is unambiguous, but it can be confusing.
19240
19241 @page
19242 @include gnus-faq.texi
19243
19244 @node Index
19245 @chapter Index
19246 @printindex cp
19247
19248 @node Key Index
19249 @chapter Key Index
19250 @printindex ky
19251
19252 @summarycontents
19253 @contents
19254 @bye
19255
19256 @iftex
19257 @iflatex
19258 \end{document}
19259 @end iflatex
19260 @end iftex
19261
19262 @c End:
19263