*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Quassia Gnus 0.34 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @c @direntry
9 @c * Gnus: (gnus).         The news reader Gnus.
10 @c @end direntry
11 @iftex
12 @finalout
13 @end iftex
14 @setchapternewpage odd
15
16 @iftex
17 @iflatex
18 \documentclass[twoside,a4paper,openright,11pt]{book}
19 \usepackage[latin1]{inputenc}
20 \usepackage{pagestyle}
21 \usepackage{epsfig}
22 \usepackage{bembo}
23 \usepackage{pixidx}
24
25 \makeindex
26 \begin{document}
27
28 \newcommand{\gnuschaptername}{}
29 \newcommand{\gnussectionname}{}
30
31 \newcommand{\gnusbackslash}{/}
32
33 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
34 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
35
36 \newcommand{\gnuskindex}[1]{\index{#1}}
37 \newcommand{\gnusindex}[1]{\index{#1}}
38
39 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
40 \newcommand{\gnuscode}[1]{\gnustt{#1}}
41 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
42 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
43 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusdfn}[1]{\textit{#1}}
46 \newcommand{\gnusi}[1]{\textit{#1}}
47 \newcommand{\gnusstrong}[1]{\textbf{#1}}
48 \newcommand{\gnusemph}[1]{\textit{#1}}
49 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
50 \newcommand{\gnussc}[1]{\textsc{#1}}
51 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
52 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
53
54 \newcommand{\gnusbullet}{{${\bullet}$}}
55 \newcommand{\gnusdollar}{\$}
56 \newcommand{\gnusampersand}{\&}
57 \newcommand{\gnuspercent}{\%}
58 \newcommand{\gnushash}{\#}
59 \newcommand{\gnushat}{\symbol{"5E}}
60 \newcommand{\gnusunderline}{\symbol{"5F}}
61 \newcommand{\gnusnot}{$\neg$}
62 \newcommand{\gnustilde}{\symbol{"7E}}
63 \newcommand{\gnusless}{{$<$}}
64 \newcommand{\gnusgreater}{{$>$}}
65
66 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
67 \newcommand{\gnusinteresting}{
68 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
69 }
70
71 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
72
73 \newcommand{\gnuspagechapter}[1]{
74 {\mbox{}}
75 }
76
77 \newdimen{\gnusdimen}
78 \gnusdimen 0pt
79
80 \newcommand{\gnuschapter}[2]{
81 \gnuscleardoublepage
82 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
83 \chapter{#2}
84 \renewcommand{\gnussectionname}{}
85 \renewcommand{\gnuschaptername}{#2}
86 \thispagestyle{empty}
87 \hspace*{-2cm}
88 \begin{picture}(500,500)(0,0)
89 \put(480,350){\makebox(0,0)[tr]{#1}}
90 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
91 \end{picture}
92 \clearpage
93 }
94
95 \newcommand{\gnusfigure}[3]{
96 \begin{figure}
97 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
98 #3
99 \end{picture}
100 \caption{#1}
101 \end{figure}
102 }
103
104 \newcommand{\gnusicon}[1]{
105 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
106 }
107
108 \newcommand{\gnuspicon}[1]{
109 \margindex{\epsfig{figure=#1,width=2cm}}
110 }
111
112 \newcommand{\gnusxface}[2]{
113 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
114 }
115
116 \newcommand{\gnussmiley}[2]{
117 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
118 }
119
120 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
121
122 \newcommand{\gnussection}[1]{
123 \renewcommand{\gnussectionname}{#1}
124 \section{#1}
125 }
126
127 \newenvironment{codelist}%
128 {\begin{list}{}{
129 }
130 }{\end{list}}
131
132 \newenvironment{kbdlist}%
133 {\begin{list}{}{
134 \labelwidth=0cm
135 }
136 }{\end{list}}
137
138 \newenvironment{dfnlist}%
139 {\begin{list}{}{
140 }
141 }{\end{list}}
142
143 \newenvironment{stronglist}%
144 {\begin{list}{}{
145 }
146 }{\end{list}}
147
148 \newenvironment{samplist}%
149 {\begin{list}{}{
150 }
151 }{\end{list}}
152
153 \newenvironment{varlist}%
154 {\begin{list}{}{
155 }
156 }{\end{list}}
157
158 \newenvironment{emphlist}%
159 {\begin{list}{}{
160 }
161 }{\end{list}}
162
163 \newlength\gnusheadtextwidth
164 \setlength{\gnusheadtextwidth}{\headtextwidth}
165 \addtolength{\gnusheadtextwidth}{1cm}
166
167 \newpagestyle{gnuspreamble}%
168 {
169 {
170 \ifodd\count0
171 {
172 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
173 }
174 \else
175 {
176 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
177 }
178 }
179 \fi
180 }
181 }
182 {
183 \ifodd\count0
184 \mbox{} \hfill 
185 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
186 \else
187 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
188 \hfill \mbox{}
189 \fi
190 }
191
192 \newpagestyle{gnusindex}%
193 {
194 {
195 \ifodd\count0
196 {
197 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
198 }
199 \else
200 {
201 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
202 }
203 \fi
204 }
205 }
206 {
207 \ifodd\count0
208 \mbox{} \hfill 
209 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
210 \else
211 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
212 \hfill \mbox{}
213 \fi
214 }
215
216 \newpagestyle{gnus}%
217 {
218 {
219 \ifodd\count0
220 {
221 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
222 }
223 \else
224 {
225 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
226 }
227 \fi
228 }
229 }
230 {
231 \ifodd\count0
232 \mbox{} \hfill 
233 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
234 \else
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
236 \hfill \mbox{}
237 \fi
238 }
239
240 \pagenumbering{roman}
241 \pagestyle{gnuspreamble}
242
243 @end iflatex
244 @end iftex
245
246 @iftex
247 @iflatex
248 \begin{titlepage}
249 {
250
251 %\addtolength{\oddsidemargin}{-5cm}
252 %\addtolength{\evensidemargin}{-5cm}
253 \parindent=0cm
254 \addtolength{\textheight}{2cm}
255
256 \gnustitle{\gnustitlename}\\
257 \rule{15cm}{1mm}\\
258 \vfill
259 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
260 \vfill
261 \rule{15cm}{1mm}\\
262 \gnusauthor{by Lars Magne Ingebrigtsen}
263 \newpage
264 }
265
266 \mbox{}
267 \vfill
268
269 \thispagestyle{empty}
270
271 Copyright \copyright{} 1995,96,97 Free Software Foundation, Inc. 
272
273 Permission is granted to make and distribute verbatim copies of
274 this manual provided the copyright notice and this permission notice
275 are preserved on all copies.
276
277 Permission is granted to copy and distribute modified versions of this
278 manual under the conditions for verbatim copying, provided that the
279 entire resulting derived work is distributed under the terms of a
280 permission notice identical to this one.
281
282 Permission is granted to copy and distribute translations of this manual
283 into another language, under the above conditions for modified versions.
284
285 \newpage
286 \end{titlepage}
287 @end iflatex
288 @end iftex
289
290 @ifinfo
291
292 This file documents Gnus, the GNU Emacs newsreader.
293
294 Copyright (C) 1995,96 Free Software Foundation, Inc.
295
296 Permission is granted to make and distribute verbatim copies of
297 this manual provided the copyright notice and this permission notice
298 are preserved on all copies.
299
300 @ignore
301 Permission is granted to process this file through Tex and print the
302 results, provided the printed document carries copying permission
303 notice identical to this one except for the removal of this paragraph
304 (this paragraph not being relevant to the printed manual).
305
306 @end ignore
307 Permission is granted to copy and distribute modified versions of this
308 manual under the conditions for verbatim copying, provided also that the
309 entire resulting derived work is distributed under the terms of a
310 permission notice identical to this one.
311
312 Permission is granted to copy and distribute translations of this manual
313 into another language, under the above conditions for modified versions.
314 @end ifinfo
315
316 @tex
317
318 @titlepage
319 @title Quassia Gnus 0.34 Manual
320
321 @author by Lars Magne Ingebrigtsen
322 @page
323
324 @vskip 0pt plus 1filll
325 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc. 
326
327 Permission is granted to make and distribute verbatim copies of
328 this manual provided the copyright notice and this permission notice
329 are preserved on all copies.
330
331 Permission is granted to copy and distribute modified versions of this
332 manual under the conditions for verbatim copying, provided that the
333 entire resulting derived work is distributed under the terms of a
334 permission notice identical to this one.
335
336 Permission is granted to copy and distribute translations of this manual
337 into another language, under the above conditions for modified versions.
338
339 @end titlepage
340 @page
341
342 @end tex
343
344
345 @node Top
346 @top The Gnus Newsreader
347
348 @ifinfo
349
350 You can read news (and mail) from within Emacs by using Gnus.  The news
351 can be gotten by any nefarious means you can think of---@sc{nntp}, local
352 spool or your mbox file.  All at the same time, if you want to push your
353 luck.
354
355 This manual corresponds to Quassia Gnus 0.34.
356
357 @end ifinfo
358
359 @iftex
360
361 @iflatex
362 \tableofcontents
363 \gnuscleardoublepage
364 @end iflatex
365
366 Gnus is the advanced, self-documenting, customizable, extensible
367 unreal-time newsreader for GNU Emacs.  
368
369 Oops.  That sounds oddly familiar, so let's start over again to avoid
370 being accused of plagiarism:
371
372 Gnus is a message-reading laboratory.  It will let you look at just
373 about anything as if it were a newsgroup.  You can read mail with it,
374 you can browse directories with it, you can @code{ftp} with it---you can
375 even read news with it!
376
377 Gnus tries to empower people who read news the same way Emacs empowers
378 people who edit text.  Gnus sets no limits to what the user should be
379 allowed to do.  Users are encouraged to extend Gnus to make it behave
380 like they want it to behave.  A program should not control people;
381 people should be empowered to do what they want by using (or abusing)
382 the program.
383
384 @end iftex
385
386
387 @menu
388 * Starting Up::           Finding news can be a pain.
389 * The Group Buffer::      Selecting, subscribing and killing groups.
390 * The Summary Buffer::    Reading, saving and posting articles.
391 * The Article Buffer::    Displaying and handling articles.
392 * Composing Messages::    Information on sending mail and news.
393 * Select Methods::        Gnus reads all messages from various select methods.
394 * Scoring::               Assigning values to articles.
395 * Various::               General purpose settings.
396 * The End::               Farewell and goodbye.
397 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
398 * Index::                 Variable, function and concept index.
399 * Key Index::             Key Index.
400 @end menu
401
402 @node Starting Up
403 @chapter Starting Gnus
404 @cindex starting up
405
406 @kindex M-x gnus
407 @findex gnus
408 If your system administrator has set things up properly, starting Gnus
409 and reading news is extremely easy---you just type @kbd{M-x gnus} in
410 your Emacs. 
411
412 @findex gnus-other-frame
413 @kindex M-x gnus-other-frame
414 If you want to start Gnus in a different frame, you can use the command
415 @kbd{M-x gnus-other-frame} instead.
416
417 If things do not go smoothly at startup, you have to twiddle some
418 variables in your @file{~/.gnus} file.  This file is similar to
419 @file{~/.emacs}, but is read when gnus starts.
420
421 If you puzzle at any terms used in this manual, please refer to the
422 terminology section (@pxref{Terminology}).
423
424 @menu
425 * Finding the News::    Choosing a method for getting news.
426 * The First Time::      What does Gnus do the first time you start it?
427 * The Server is Down::  How can I read my mail then?
428 * Slave Gnusae::        You can have more than one Gnus active at a time.
429 * Fetching a Group::    Starting Gnus just to read a group.
430 * New Groups::          What is Gnus supposed to do with new groups?
431 * Startup Files::       Those pesky startup files---@file{.newsrc}.
432 * Auto Save::           Recovering from a crash.
433 * The Active File::     Reading the active file over a slow line Takes Time.
434 * Changing Servers::    You may want to move from one server to another.
435 * Startup Variables::   Other variables you might change.
436 @end menu
437
438
439 @node Finding the News
440 @section Finding the News
441 @cindex finding news
442
443 @vindex gnus-select-method
444 @c @head
445 The @code{gnus-select-method} variable says where Gnus should look for
446 news.  This variable should be a list where the first element says
447 @dfn{how} and the second element says @dfn{where}.  This method is your
448 native method.  All groups not fetched with this method are
449 foreign groups.
450
451 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
452 you want to get your daily dosage of news from, you'd say:
453
454 @lisp
455 (setq gnus-select-method '(nntp "news.somewhere.edu"))
456 @end lisp
457
458 If you want to read directly from the local spool, say:
459
460 @lisp
461 (setq gnus-select-method '(nnspool ""))
462 @end lisp
463
464 If you can use a local spool, you probably should, as it will almost
465 certainly be much faster.
466
467 @vindex gnus-nntpserver-file
468 @cindex NNTPSERVER
469 @cindex @sc{nntp} server
470 If this variable is not set, Gnus will take a look at the
471 @code{NNTPSERVER} environment variable.  If that variable isn't set,
472 Gnus will see whether @code{gnus-nntpserver-file}
473 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
474 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
475
476 @vindex gnus-nntp-server
477 If @code{gnus-nntp-server} is set, this variable will override
478 @code{gnus-select-method}.  You should therefore set
479 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
480
481 @vindex gnus-secondary-servers
482 You can also make Gnus prompt you interactively for the name of an
483 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
484 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
485 in the @code{gnus-secondary-servers} list (if any).  You can also just
486 type in the name of any server you feel like visiting.
487
488 @findex gnus-group-browse-foreign-server
489 @kindex B (Group)
490 However, if you use one @sc{nntp} server regularly and are just
491 interested in a couple of groups from a different server, you would be
492 better served by using the @kbd{B} command in the group buffer.  It will
493 let you have a look at what groups are available, and you can subscribe
494 to any of the groups you want to.  This also makes @file{.newsrc}
495 maintenance much tidier.  @xref{Foreign Groups}.
496
497 @vindex gnus-secondary-select-methods
498 @c @head
499 A slightly different approach to foreign groups is to set the
500 @code{gnus-secondary-select-methods} variable.  The select methods
501 listed in this variable are in many ways just as native as the
502 @code{gnus-select-method} server.  They will also be queried for active
503 files during startup (if that's required), and new newsgroups that
504 appear on these servers will be subscribed (or not) just as native
505 groups are.
506
507 For instance, if you use the @code{nnmbox} backend to read your mail, you
508 would typically set this variable to
509
510 @lisp
511 (setq gnus-secondary-select-methods '((nnmbox "")))
512 @end lisp
513
514
515 @node The First Time
516 @section The First Time
517 @cindex first time usage
518
519 If no startup files exist, Gnus will try to determine what groups should
520 be subscribed by default.
521
522 @vindex gnus-default-subscribed-newsgroups
523 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
524 will subscribe you to just those groups in that list, leaving the rest
525 killed.  Your system administrator should have set this variable to
526 something useful.
527
528 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
529 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
530 here as @dfn{whatever Lars thinks you should read}.)
531
532 You'll also be subscribed to the Gnus documentation group, which should
533 help you with most common problems.  
534
535 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
536 use the normal functions for handling new groups, and not do anything
537 special.
538
539
540 @node The Server is Down
541 @section The Server is Down
542 @cindex server errors
543
544 If the default server is down, Gnus will understandably have some
545 problems starting.  However, if you have some mail groups in addition to
546 the news groups, you may want to start Gnus anyway.
547
548 Gnus, being the trusting sort of program, will ask whether to proceed
549 without a native select method if that server can't be contacted.  This
550 will happen whether the server doesn't actually exist (i.e., you have
551 given the wrong address) or the server has just momentarily taken ill
552 for some reason or other.  If you decide to continue and have no foreign
553 groups, you'll find it difficult to actually do anything in the group
554 buffer.  But, hey, that's your problem.  Blllrph!
555
556 @findex gnus-no-server
557 @kindex M-x gnus-no-server
558 @c @head
559 If you know that the server is definitely down, or you just want to read
560 your mail without bothering with the server at all, you can use the
561 @code{gnus-no-server} command to start Gnus.  That might come in handy
562 if you're in a hurry as well.  This command will not attempt to contact
563 your primary server---instead, it will just activate all groups on level
564 1 and 2.  (You should preferably keep no native groups on those two
565 levels.)
566
567
568 @node Slave Gnusae
569 @section Slave Gnusae
570 @cindex slave
571
572 You might want to run more than one Emacs with more than one Gnus at the
573 same time.  If you are using different @file{.newsrc} files (e.g., if you
574 are using the two different Gnusae to read from two different servers),
575 that is no problem whatsoever.  You just do it.
576
577 The problem appears when you want to run two Gnusae that use the same
578 @code{.newsrc} file.
579
580 To work around that problem some, we here at the Think-Tank at the Gnus
581 Towers have come up with a new concept: @dfn{Masters} and
582 @dfn{slaves}.  (We have applied for a patent on this concept, and have
583 taken out a copyright on those words.  If you wish to use those words in
584 conjunction with each other, you have to send $1 per usage instance to
585 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
586 Applications}) will be much more expensive, of course.)
587
588 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
589 however you do it).  Each subsequent slave Gnusae should be started with
590 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
591 files, but instead save @dfn{slave files} that contain information only
592 on what groups have been read in the slave session.  When a master Gnus
593 starts, it will read (and delete) these slave files, incorporating all
594 information from them.  (The slave files will be read in the sequence
595 they were created, so the latest changes will have precedence.)
596
597 Information from the slave files has, of course, precedence over the
598 information in the normal (i.e., master) @code{.newsrc} file.
599
600
601 @node Fetching a Group
602 @section Fetching a Group
603 @cindex fetching a group
604
605 @findex gnus-fetch-group
606 It is sometimes convenient to be able to just say ``I want to read this
607 group and I don't care whether Gnus has been started or not''.  This is
608 perhaps more useful for people who write code than for users, but the
609 command @code{gnus-fetch-group} provides this functionality in any case.
610 It takes the group name as a parameter.
611
612
613 @node New Groups
614 @section New Groups
615 @cindex new groups
616 @cindex subscription
617
618 @vindex gnus-check-new-newsgroups
619 If you are satisfied that you really never want to see any new groups,
620 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
621 also save you some time at startup.  Even if this variable is
622 @code{nil}, you can always subscribe to the new groups just by pressing
623 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
624 is @code{ask-server} by default.  If you set this variable to
625 @code{always}, then Gnus will query the backends for new groups even
626 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
627
628 @menu
629 * Checking New Groups::      Determining what groups are new.
630 * Subscription Methods::     What Gnus should do with new groups.
631 * Filtering New Groups::     Making Gnus ignore certain new groups.
632 @end menu
633
634
635 @node Checking New Groups
636 @subsection Checking New Groups
637
638 Gnus normally determines whether a group is new or not by comparing the
639 list of groups from the active file(s) with the lists of subscribed and
640 dead groups.  This isn't a particularly fast method.  If
641 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
642 server for new groups since the last time.  This is both faster and
643 cheaper.  This also means that you can get rid of the list of killed
644 groups altogether, so you may set @code{gnus-save-killed-list} to
645 @code{nil}, which will save time both at startup, at exit, and all over.
646 Saves disk space, too.  Why isn't this the default, then?
647 Unfortunately, not all servers support this command. 
648
649 I bet I know what you're thinking now: How do I find out whether my
650 server supports @code{ask-server}?  No?  Good, because I don't have a
651 fail-safe answer.  I would suggest just setting this variable to
652 @code{ask-server} and see whether any new groups appear within the next
653 few days.  If any do, then it works.  If none do, then it doesn't
654 work.  I could write a function to make Gnus guess whether the server
655 supports @code{ask-server}, but it would just be a guess.  So I won't.
656 You could @code{telnet} to the server and say @code{HELP} and see
657 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
658 it does, then it might work.  (But there are servers that lists
659 @samp{NEWGROUPS} without supporting the function properly.)
660
661 This variable can also be a list of select methods.  If so, Gnus will
662 issue an @code{ask-server} command to each of the select methods, and
663 subscribe them (or not) using the normal methods.  This might be handy
664 if you are monitoring a few servers for new groups.  A side effect is
665 that startup will take much longer, so you can meditate while waiting.
666 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
667
668
669 @node Subscription Methods
670 @subsection Subscription Methods
671
672 @vindex gnus-subscribe-newsgroup-method
673 What Gnus does when it encounters a new group is determined by the
674 @code{gnus-subscribe-newsgroup-method} variable.
675
676 This variable should contain a function.  This function will be called
677 with the name of the new group as the only parameter.
678
679 Some handy pre-fab functions are:
680
681 @table @code
682
683 @item gnus-subscribe-zombies
684 @vindex gnus-subscribe-zombies
685 Make all new groups zombies.  This is the default.  You can browse the
686 zombies later (with @kbd{A z}) and either kill them all off properly
687 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
688
689 @item gnus-subscribe-randomly
690 @vindex gnus-subscribe-randomly
691 Subscribe all new groups in arbitrary order.  This really means that all
692 new groups will be added at ``the top'' of the group buffer.
693
694 @item gnus-subscribe-alphabetically
695 @vindex gnus-subscribe-alphabetically
696 Subscribe all new groups in alphabetical order.
697
698 @item gnus-subscribe-hierarchically
699 @vindex gnus-subscribe-hierarchically
700 Subscribe all new groups hierarchically.  The difference between this
701 function and @code{gnus-subscribe-alphabetically} is slight.
702 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
703 alphabetical fashion, while this function will enter groups into it's
704 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
705 @samp{comp} hierarchy, this function will not mess that configuration
706 up.  Or something like that.
707
708 @item gnus-subscribe-interactively
709 @vindex gnus-subscribe-interactively
710 Subscribe new groups interactively.  This means that Gnus will ask
711 you about @strong{all} new groups.  The groups you choose to subscribe
712 to will be subscribed hierarchically.
713
714 @item gnus-subscribe-killed
715 @vindex gnus-subscribe-killed
716 Kill all new groups.
717
718 @end table
719
720 @vindex gnus-subscribe-hierarchical-interactive
721 A closely related variable is
722 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
723 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
724 hierarchical fashion whether to subscribe to new groups or not.  Gnus
725 will ask you for each sub-hierarchy whether you want to descend the
726 hierarchy or not.  
727
728 One common mistake is to set the variable a few paragraphs above
729 (@code{gnus-subscribe-newsgroup-method}) to
730 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
731 will not work.  This is ga-ga.  So don't do it.
732
733
734 @node Filtering New Groups
735 @subsection Filtering New Groups
736
737 A nice and portable way to control which new newsgroups should be
738 subscribed (or ignored) is to put an @dfn{options} line at the start of
739 the @file{.newsrc} file.  Here's an example:
740
741 @example
742 options -n !alt.all !rec.all sci.all
743 @end example
744
745 @vindex gnus-subscribe-options-newsgroup-method
746 This line obviously belongs to a serious-minded intellectual scientific
747 person (or she may just be plain old boring), because it says that all
748 groups that have names beginning with @samp{alt} and @samp{rec} should
749 be ignored, and all groups with names beginning with @samp{sci} should
750 be subscribed.  Gnus will not use the normal subscription method for
751 subscribing these groups.
752 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
753 variable defaults to @code{gnus-subscribe-alphabetically}.
754
755 @vindex gnus-options-not-subscribe
756 @vindex gnus-options-subscribe
757 If you don't want to mess with your @file{.newsrc} file, you can just
758 set the two variables @code{gnus-options-subscribe} and
759 @code{gnus-options-not-subscribe}.  These two variables do exactly the
760 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
761 and if the new group matches the former, it will be unconditionally
762 subscribed, and if it matches the latter, it will be ignored.
763
764 @vindex gnus-auto-subscribed-groups
765 Yet another variable that meddles here is
766 @code{gnus-auto-subscribed-groups}.  It works exactly like
767 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
768 thought it would be nice to have two of these.  This variable is more
769 meant for setting some ground rules, while the other variable is used
770 more for user fiddling.  By default this variable makes all new groups
771 that come from mail backends (@code{nnml}, @code{nnbabyl},
772 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
773 don't like that, just set this variable to @code{nil}.
774
775 New groups that match this regexp are subscribed using
776 @code{gnus-subscribe-options-newsgroup-method}.
777
778
779 @node Changing Servers
780 @section Changing Servers
781 @cindex changing servers
782
783 Sometimes it is necessary to move from one @sc{nntp} server to another.
784 This happens very rarely, but perhaps you change jobs, or one server is
785 very flaky and you want to use another.  
786
787 Changing the server is pretty easy, right?  You just change
788 @code{gnus-select-method} to point to the new server?  
789
790 @emph{Wrong!}
791
792 Article numbers are not (in any way) kept synchronized between different
793 @sc{nntp} servers, and the only way Gnus keeps track of what articles
794 you have read is by keeping track of article numbers.  So when you
795 change @code{gnus-select-method}, your @file{.newsrc} file becomes
796 worthless.  
797
798 Gnus provides a few functions to attempt to translate a @file{.newsrc}
799 file from one server to another.  They all have one thing in
800 common---they take a looong time to run.  You don't want to use these
801 functions more than absolutely necessary.
802
803 @kindex M-x gnus-change-server
804 @findex gnus-change-server
805 If you have access to both servers, Gnus can request the headers for all
806 the articles you have read and compare @code{Message-ID}s and map the
807 article numbers of the read articles and article marks.  The @kbd{M-x
808 gnus-change-server} command will do this for all your native groups.  It
809 will prompt for the method you want to move to.
810
811 @kindex M-x gnus-group-move-group-to-server
812 @findex gnus-group-move-group-to-server
813 You can also move individual groups with the @kbd{M-x
814 gnus-group-move-group-to-server} command.  This is useful if you want to
815 move a (foreign) group from one server to another.
816
817 @kindex M-x gnus-group-clear-data-on-native-groups
818 @findex gnus-group-clear-data-on-native-groups
819 If you don't have access to both the old and new server, all your marks
820 and read ranges have become worthless.  You can use the @kbd{M-x
821 gnus-group-clear-data-on-native-groups} command to clear out all data
822 that you have on your native groups.  Use with caution.
823
824
825 @node Startup Files
826 @section Startup Files
827 @cindex startup files
828 @cindex .newsrc
829 @cindex .newsrc.el
830 @cindex .newsrc.eld
831
832 Now, you all know about the @file{.newsrc} file.  All subscription
833 information is traditionally stored in this file.
834
835 Things got a bit more complicated with @sc{gnus}.  In addition to
836 keeping the @file{.newsrc} file updated, it also used a file called
837 @file{.newsrc.el} for storing all the information that didn't fit into
838 the @file{.newsrc} file.  (Actually, it also duplicated everything in
839 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
840 files was the most recently saved, which enabled people to swap between
841 @sc{gnus} and other newsreaders.
842
843 That was kinda silly, so Gnus went one better: In addition to the
844 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
845 @file{.newsrc.eld}.  It will read whichever of these files that are most
846 recent, but it will never write a @file{.newsrc.el} file.  You should
847 never delete the @file{.newsrc.eld} file---it contains much information
848 not stored in the @file{.newsrc} file.
849
850 @vindex gnus-save-newsrc-file
851 You can turn off writing the @file{.newsrc} file by setting
852 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
853 the file and save some space, as well as making exit from Gnus faster.
854 However, this will make it impossible to use other newsreaders than
855 Gnus.  But hey, who would want to, right?
856
857 @vindex gnus-save-killed-list
858 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
859 will not save the list of killed groups to the startup file.  This will
860 save both time (when starting and quitting) and space (on disk).  It
861 will also mean that Gnus has no record of what groups are new or old,
862 so the automatic new groups subscription methods become meaningless.
863 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
864 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
865 Groups}).  This variable can also be a regular expression.  If that's
866 the case, remove all groups that do not match this regexp before
867 saving.  This can be useful in certain obscure situations that involve
868 several servers where not all servers support @code{ask-server}.
869
870 @vindex gnus-startup-file
871 The @code{gnus-startup-file} variable says where the startup files are.
872 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
873 file being whatever that one is, with a @samp{.eld} appended.
874
875 @vindex gnus-save-newsrc-hook
876 @vindex gnus-save-quick-newsrc-hook
877 @vindex gnus-save-standard-newsrc-hook
878 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
879 files, while @code{gnus-save-quick-newsrc-hook} is called just before
880 saving the @file{.newsrc.eld} file, and
881 @code{gnus-save-standard-newsrc-hook} is called just before saving the
882 @file{.newsrc} file.  The latter two are commonly used to turn version
883 control on or off.  Version control is on by default when saving the
884 startup files.  If you want to turn backup creation off, say something like: 
885
886 @lisp
887 (defun turn-off-backup ()
888   (set (make-local-variable 'backup-inhibited) t))
889
890 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
891 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
892 @end lisp
893
894 @vindex gnus-init-file
895 When Gnus starts, it will read the @code{gnus-site-init-file}
896 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
897 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
898 and can be used to avoid cluttering your @file{~/.emacs} and
899 @file{site-init} files with Gnus stuff.  Gnus will also check for files
900 with the same names as these, but with @file{.elc} and @file{.el}
901 suffixes.  In other words, if you have set @code{gnus-init-file} to
902 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
903 and finally @file{~/.gnus} (in this order).
904
905
906
907 @node Auto Save
908 @section Auto Save
909 @cindex dribble file
910 @cindex auto-save
911
912 Whenever you do something that changes the Gnus data (reading articles,
913 catching up, killing/subscribing groups), the change is added to a
914 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
915 Emacs way.  If your Emacs should crash before you have saved the
916 @file{.newsrc} files, all changes you have made can be recovered from
917 this file.
918
919 If Gnus detects this file at startup, it will ask the user whether to
920 read it.  The auto save file is deleted whenever the real startup file is
921 saved.
922
923 @vindex gnus-use-dribble-file
924 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
925 maintain a dribble buffer.  The default is @code{t}.
926
927 @vindex gnus-dribble-directory
928 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
929 this variable is @code{nil}, which it is by default, Gnus will dribble
930 into the directory where the @file{.newsrc} file is located.  (This is
931 normally the user's home directory.)  The dribble file will get the same
932 file permissions as the @code{.newsrc} file.
933
934
935 @node The Active File
936 @section The Active File
937 @cindex active file
938 @cindex ignored groups
939
940 When Gnus starts, or indeed whenever it tries to determine whether new
941 articles have arrived, it reads the active file.  This is a very large
942 file that lists all the active groups and articles on the server.
943
944 @vindex gnus-ignored-newsgroups
945 Before examining the active file, Gnus deletes all lines that match the
946 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
947 any groups with bogus names, but you can use this variable to make Gnus
948 ignore hierarchies you aren't ever interested in.  However, this is not
949 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
950 Groups} for an overview of other variables that can be used instead.
951
952 @c This variable is
953 @c @code{nil} by default, and will slow down active file handling somewhat
954 @c if you set it to anything else.
955
956 @vindex gnus-read-active-file
957 @c @head
958 The active file can be rather Huge, so if you have a slow network, you
959 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
960 reading the active file.  This variable is @code{some} by default.
961
962 Gnus will try to make do by getting information just on the groups that
963 you actually subscribe to.
964
965 Note that if you subscribe to lots and lots of groups, setting this
966 variable to @code{nil} will probably make Gnus slower, not faster.  At
967 present, having this variable @code{nil} will slow Gnus down
968 considerably, unless you read news over a 2400 baud modem.  
969
970 This variable can also have the value @code{some}.  Gnus will then
971 attempt to read active info only on the subscribed groups.  On some
972 servers this is quite fast (on sparkling, brand new INN servers that
973 support the @code{LIST ACTIVE group} command), on others this isn't fast
974 at all.  In any case, @code{some} should be faster than @code{nil}, and
975 is certainly faster than @code{t} over slow lines.
976
977 If this variable is @code{nil}, Gnus will ask for group info in total
978 lock-step, which isn't very fast.  If it is @code{some} and you use an
979 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
980 read all the replies in one swoop.  This will normally result in better
981 performance, but if the server does not support the aforementioned
982 @code{LIST ACTIVE group} command, this isn't very nice to the server.
983
984 In any case, if you use @code{some} or @code{nil}, you should definitely
985 kill all groups that you aren't interested in to speed things up.
986
987 Note that this variable also affects active file retrieval from
988 secondary select methods.
989
990
991 @node Startup Variables
992 @section Startup Variables
993
994 @table @code
995
996 @item gnus-load-hook
997 @vindex gnus-load-hook
998 A hook run while Gnus is being loaded.  Note that this hook will
999 normally be run just once in each Emacs session, no matter how many
1000 times you start Gnus.
1001
1002 @item gnus-before-startup-hook
1003 @vindex gnus-before-startup-hook
1004 A hook run after starting up Gnus successfully.
1005
1006 @item gnus-startup-hook
1007 @vindex gnus-startup-hook
1008 A hook run as the very last thing after starting up Gnus
1009
1010 @item gnus-started-hook
1011 @vindex gnus-started-hook
1012 A hook that is run as the very last thing after starting up Gnus
1013 successfully.
1014
1015 @item gnus-started-hook
1016 @vindex gnus-started-hook
1017 A hook that is run after reading the @file{.newsrc} file(s), but before
1018 generating the group buffer.
1019
1020 @item gnus-check-bogus-newsgroups
1021 @vindex gnus-check-bogus-newsgroups
1022 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1023 startup.  A @dfn{bogus group} is a group that you have in your
1024 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1025 bogus groups can take quite a while, so to save time and resources it's
1026 best to leave this option off, and do the checking for bogus groups once
1027 in a while from the group buffer instead (@pxref{Group Maintenance}).
1028
1029 @item gnus-inhibit-startup-message
1030 @vindex gnus-inhibit-startup-message
1031 If non-@code{nil}, the startup message won't be displayed.  That way,
1032 your boss might not notice as easily that you are reading news instead
1033 of doing your job.  Note that this variable is used before
1034 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1035
1036 @item gnus-no-groups-message
1037 @vindex gnus-no-groups-message
1038 Message displayed by Gnus when no groups are available.
1039
1040 @item gnus-play-startup-jingle
1041 @vindex gnus-play-startup-jingle
1042 If non-@code{nil}, play the Gnus jingle at startup.
1043
1044 @item gnus-startup-jingle
1045 @vindex gnus-startup-jingle
1046 Jingle to be played if the above variable is non-@code{nil}.  The
1047 default is @samp{Tuxedomoon.Jingle4.au}.
1048
1049 @end table
1050
1051
1052 @node The Group Buffer
1053 @chapter The Group Buffer
1054 @cindex group buffer
1055
1056 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1057 is the first buffer shown when Gnus starts, and will never be killed as
1058 long as Gnus is active.
1059
1060 @iftex
1061 @iflatex
1062 \gnusfigure{The Group Buffer}{320}{
1063 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1064 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1065 \put(120,38){\vector(1,2){10}}
1066 \put(40,60){\makebox(0,0)[r]{Mode line}}
1067 \put(40,58){\vector(1,0){30}}
1068 \put(200,28){\makebox(0,0)[t]{Native select method}}
1069 \put(200,26){\vector(-1,2){15}}
1070 }
1071 @end iflatex
1072 @end iftex
1073
1074 @menu
1075 * Group Buffer Format::    Information listed and how you can change it.
1076 * Group Maneuvering::      Commands for moving in the group buffer.
1077 * Selecting a Group::      Actually reading news.
1078 * Group Data::             Changing the info for a group.
1079 * Subscription Commands::  Unsubscribing, killing, subscribing.
1080 * Group Levels::           Levels? What are those, then?
1081 * Group Score::            A mechanism for finding out what groups you like.
1082 * Marking Groups::         You can mark groups for later processing.
1083 * Foreign Groups::         Creating and editing groups.
1084 * Group Parameters::       Each group may have different parameters set.
1085 * Listing Groups::         Gnus can list various subsets of the groups.
1086 * Sorting Groups::         Re-arrange the group order.
1087 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1088 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1089 * Exiting Gnus::           Stop reading news and get some work done.
1090 * Group Topics::           A folding group mode divided into topics.
1091 * Misc Group Stuff::       Other stuff that you can to do.
1092 @end menu
1093
1094
1095 @node Group Buffer Format
1096 @section Group Buffer Format
1097
1098 @menu 
1099 * Group Line Specification::       Deciding how the group buffer is to look.
1100 * Group Modeline Specification::   The group buffer modeline.
1101 * Group Highlighting::             Having nice colors in the group buffer.
1102 @end menu
1103
1104
1105 @node Group Line Specification
1106 @subsection Group Line Specification
1107 @cindex group buffer format
1108
1109 The default format of the group buffer is nice and dull, but you can
1110 make it as exciting and ugly as you feel like.
1111
1112 Here's a couple of example group lines:
1113
1114 @example
1115      25: news.announce.newusers
1116  *    0: alt.fan.andrea-dworkin
1117 @end example
1118
1119 Quite simple, huh?
1120
1121 You can see that there are 25 unread articles in
1122 @samp{news.announce.newusers}.  There are no unread articles, but some
1123 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1124 asterisk at the beginning of the line?).
1125
1126 @vindex gnus-group-line-format
1127 You can change that format to whatever you want by fiddling with the
1128 @code{gnus-group-line-format} variable.  This variable works along the
1129 lines of a @code{format} specification, which is pretty much the same as
1130 a @code{printf} specifications, for those of you who use (feh!) C.
1131 @xref{Formatting Variables}. 
1132
1133 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1134
1135 There should always be a colon on the line; the cursor always moves to
1136 the colon after performing an operation.  Nothing else is required---not
1137 even the group name.  All displayed text is just window dressing, and is
1138 never examined by Gnus.  Gnus stores all real information it needs using
1139 text properties.
1140
1141 (Note that if you make a really strange, wonderful, spreadsheet-like
1142 layout, everybody will believe you are hard at work with the accounting
1143 instead of wasting time reading news.)
1144
1145 Here's a list of all available format characters:
1146
1147 @table @samp
1148
1149 @item M    
1150 An asterisk if the group only has marked articles.
1151
1152 @item S
1153 Whether the group is subscribed.
1154
1155 @item L    
1156 Level of subscribedness.
1157
1158 @item N
1159 Number of unread articles.
1160
1161 @item I
1162 Number of dormant articles.
1163
1164 @item T
1165 Number of ticked articles.
1166
1167 @item R
1168 Number of read articles.
1169
1170 @item t
1171 Estimated total number of articles.  (This is really @var{max-number}
1172 minus @var{min-number} plus 1.)
1173
1174 @item y
1175 Number of unread, unticked, non-dormant articles.
1176
1177 @item i
1178 Number of ticked and dormant articles.
1179
1180 @item g
1181 Full group name.
1182
1183 @item G
1184 Group name.
1185
1186 @item D
1187 Newsgroup description.
1188
1189 @item o
1190 @samp{m} if moderated.
1191
1192 @item O
1193 @samp{(m)} if moderated.
1194
1195 @item s
1196 Select method.
1197
1198 @item n
1199 Select from where.
1200
1201 @item z
1202 A string that looks like @samp{<%s:%n>} if a foreign select method is
1203 used.
1204
1205 @item P
1206 Indentation based on the level of the topic (@pxref{Group Topics}). 
1207
1208 @item c
1209 @vindex gnus-group-uncollapsed-levels
1210 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1211 variable says how many levels to leave at the end of the group name.
1212 The default is 1---this will mean that group names like
1213 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1214
1215 @item m
1216 @vindex gnus-new-mail-mark
1217 @cindex %
1218 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1219 the group lately.
1220
1221 @item d
1222 A string that says when you last read the group (@pxref{Group
1223 Timestamp}). 
1224
1225 @item u
1226 User defined specifier.  The next character in the format string should
1227 be a letter.  Gnus will call the function
1228 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1229 following @samp{%u}.  The function will be passed a single dummy
1230 parameter as argument.  The function should return a string, which will
1231 be inserted into the buffer just like information from any other
1232 specifier.
1233 @end table
1234
1235 @cindex *
1236 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1237 if no info is available---for instance, if it is a non-activated foreign
1238 group, or a bogus native group.
1239
1240
1241 @node Group Modeline Specification
1242 @subsection Group Modeline Specification
1243 @cindex group modeline
1244
1245 @vindex gnus-group-mode-line-format
1246 The mode line can be changed by setting
1247 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}).  It
1248 doesn't understand that many format specifiers:
1249
1250 @table @samp
1251 @item S
1252 The native news server.
1253 @item M
1254 The native select method.
1255 @end table
1256
1257
1258 @node Group Highlighting
1259 @subsection Group Highlighting
1260 @cindex highlighting
1261 @cindex group highlighting
1262
1263 @vindex gnus-group-highlight
1264 Highlighting in the group buffer is controlled by the
1265 @code{gnus-group-highlight} variable.  This is an alist with elements
1266 that look like @var{(form . face)}.  If @var{form} evaluates to
1267 something non-@code{nil}, the @var{face} will be used on the line.
1268
1269 Here's an example value for this variable that might look nice if the
1270 background is dark:
1271
1272 @lisp
1273 (face-spec-set 'my-group-face-1 '((t (:foreground "Red" :bold t))))
1274 (face-spec-set 'my-group-face-2 '((t (:foreground "SeaGreen" :bold t))))
1275 (face-spec-set 'my-group-face-3 '((t (:foreground "SpringGreen" :bold t))))
1276 (face-spec-set 'my-group-face-4 '((t (:foreground "SteelBlue" :bold t))))
1277 (face-spec-set 'my-group-face-5 '((t (:foreground "SkyBlue" :bold t))))
1278
1279 (setq gnus-group-highlight
1280       '(((> unread 200) . my-group-face-1)
1281         ((and (< level 3) (zerop unread)) . my-group-face-2)
1282         ((< level 3) . my-group-face-3)
1283         ((zerop unread) . my-group-face-4)
1284 (setq gnus-group-highlight
1285       `(((> unread 200) . 
1286          ,(custom-face-lookup "Red" nil nil t nil nil))
1287         ((and (< level 3) (zerop unread)) . 
1288          ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1289         ((< level 3) . 
1290          ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1291         ((zerop unread) . 
1292          ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1293         (t . 
1294          ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1295         (t . my-group-face-5)))
1296 @end lisp
1297
1298 Also @pxref{Faces and Fonts}.
1299
1300 Variables that are dynamically bound when the forms are evaluated
1301 include:
1302
1303 @table @code
1304 @item group
1305 The group name.
1306 @item unread
1307 The number of unread articles in the group.
1308 @item method
1309 The select method.
1310 @item mailp
1311 Whether the group is a mail group.
1312 @item level
1313 The level of the group.
1314 @item score
1315 The score of the group.
1316 @item ticked 
1317 The number of ticked articles in the group.
1318 @item total
1319 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1320 MIN-NUMBER plus one.
1321 @item topic
1322 When using the topic minor mode, this variable is bound to the current
1323 topic being inserted.
1324 @end table
1325
1326 When the forms are @code{eval}ed, point is at the beginning of the line
1327 of the group in question, so you can use many of the normal Gnus
1328 functions for snarfing info on the group.
1329
1330 @vindex gnus-group-update-hook
1331 @findex gnus-group-highlight-line
1332 @code{gnus-group-update-hook} is called when a group line is changed.
1333 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1334 calls @code{gnus-group-highlight-line} by default.
1335
1336
1337 @node Group Maneuvering
1338 @section Group Maneuvering
1339 @cindex group movement
1340
1341 All movement commands understand the numeric prefix and will behave as
1342 expected, hopefully. 
1343
1344 @table @kbd
1345
1346 @item n
1347 @kindex n (Group)
1348 @findex gnus-group-next-unread-group
1349 Go to the next group that has unread articles
1350 (@code{gnus-group-next-unread-group}).
1351
1352 @item p
1353 @itemx DEL
1354 @kindex DEL (Group)
1355 @kindex p (Group)
1356 @findex gnus-group-prev-unread-group
1357 Go to the previous group that has unread articles
1358 (@code{gnus-group-prev-unread-group}).
1359
1360 @item N
1361 @kindex N (Group)
1362 @findex gnus-group-next-group
1363 Go to the next group (@code{gnus-group-next-group}).
1364
1365 @item P
1366 @kindex P (Group)
1367 @findex gnus-group-prev-group
1368 Go to the previous group (@code{gnus-group-prev-group}).
1369
1370 @item M-p
1371 @kindex M-p (Group)
1372 @findex gnus-group-next-unread-group-same-level
1373 Go to the next unread group on the same (or lower) level
1374 (@code{gnus-group-next-unread-group-same-level}). 
1375
1376 @item M-n
1377 @kindex M-n (Group)
1378 @findex gnus-group-prev-unread-group-same-level
1379 Go to the previous unread group on the same (or lower) level
1380 (@code{gnus-group-prev-unread-group-same-level}). 
1381 @end table
1382
1383 Three commands for jumping to groups:
1384
1385 @table @kbd
1386
1387 @item j
1388 @kindex j (Group)
1389 @findex gnus-group-jump-to-group
1390 Jump to a group (and make it visible if it isn't already)
1391 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1392 like living groups.
1393
1394 @item ,
1395 @kindex , (Group)
1396 @findex gnus-group-best-unread-group
1397 Jump to the unread group with the lowest level
1398 (@code{gnus-group-best-unread-group}). 
1399
1400 @item .
1401 @kindex . (Group)
1402 @findex gnus-group-first-unread-group
1403 Jump to the first group with unread articles
1404 (@code{gnus-group-first-unread-group}).  
1405 @end table
1406
1407 @vindex gnus-group-goto-unread
1408 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1409 commands will move to the next group, not the next unread group.  Even
1410 the commands that say they move to the next unread group.  The default
1411 is @code{t}.
1412
1413
1414 @node Selecting a Group
1415 @section Selecting a Group
1416 @cindex group selection
1417
1418 @table @kbd
1419
1420 @item SPACE
1421 @kindex SPACE (Group)
1422 @findex gnus-group-read-group
1423 Select the current group, switch to the summary buffer and display the
1424 first unread article (@code{gnus-group-read-group}).  If there are no
1425 unread articles in the group, or if you give a non-numerical prefix to
1426 this command, Gnus will offer to fetch all the old articles in this
1427 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1428 determines the number of articles Gnus will fetch.  If @var{N} is
1429 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1430 negative, Gnus fetches the @var{abs(N)} oldest articles.
1431
1432 @item RET
1433 @kindex RET (Group)
1434 @findex gnus-group-select-group
1435 Select the current group and switch to the summary buffer
1436 (@code{gnus-group-select-group}).  Takes the same arguments as
1437 @code{gnus-group-read-group}---the only difference is that this command
1438 does not display the first unread article automatically upon group
1439 entry. 
1440
1441 @item M-RET
1442 @kindex M-RET (Group)
1443 @findex gnus-group-quick-select-group
1444 This does the same as the command above, but tries to do it with the
1445 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1446 scoring/killing will be performed, there will be no highlights and no
1447 expunging.  This might be useful if you're in a real hurry and have to
1448 enter some humongous group.  If you give a 0 prefix to this command
1449 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1450 which is useful if you want to toggle threading before generating the
1451 summary buffer (@pxref{Summary Generation Commands}).
1452
1453 @item M-SPACE
1454 @kindex M-SPACE (Group)
1455 @findex gnus-group-visible-select-group
1456 This is yet one more command that does the same as the @kbd{RET}
1457 command, but this one does it without expunging and hiding dormants
1458 (@code{gnus-group-visible-select-group}).
1459
1460 @item M-C-RET
1461 @kindex M-C-RET (Group)
1462 @findex gnus-group-select-group-ephemerally
1463 Finally, this command selects the current group ephemerally without
1464 doing any processing of its contents
1465 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1466 turned off.  Everything you do in the group after selecting it in this
1467 manner will have no permanent effects.
1468
1469 @end table
1470
1471 @vindex gnus-large-newsgroup
1472 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1473 to be a big group.  This is 200 by default.  If the group has more
1474 (unread and/or ticked) articles than this, Gnus will query the user
1475 before entering the group.  The user can then specify how many articles
1476 should be fetched from the server.  If the user specifies a negative
1477 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1478 is positive, the @code{n} articles that have arrived most recently will
1479 be fetched.
1480
1481 @vindex gnus-select-group-hook
1482 @vindex gnus-auto-select-first
1483 @code{gnus-auto-select-first} control whether any articles are selected
1484 automatically when entering a group with the @kbd{SPACE} command.
1485
1486 @table @code
1487
1488 @item nil
1489 Don't select any articles when entering the group.  Just display the
1490 full summary buffer.
1491
1492 @item t
1493 Select the first unread article when entering the group.  
1494
1495 @item best
1496 Select the most high-scored article in the group when entering the
1497 group. 
1498 @end table
1499         
1500 If you want to prevent automatic selection in some group (say, in a
1501 binary group with Huge articles) you can set this variable to @code{nil}
1502 in @code{gnus-select-group-hook}, which is called when a group is
1503 selected.
1504
1505
1506 @node Subscription Commands
1507 @section Subscription Commands
1508 @cindex subscription
1509
1510 @table @kbd
1511
1512 @item S t
1513 @itemx u
1514 @kindex S t (Group)
1515 @kindex u (Group)
1516 @findex gnus-group-unsubscribe-current-group
1517 @c @icon{gnus-group-unsubscribe}
1518 Toggle subscription to the current group
1519 (@code{gnus-group-unsubscribe-current-group}).  
1520
1521 @item S s
1522 @itemx U
1523 @kindex S s (Group)
1524 @kindex U (Group)
1525 @findex gnus-group-unsubscribe-group
1526 Prompt for a group to subscribe, and then subscribe it.  If it was
1527 subscribed already, unsubscribe it instead
1528 (@code{gnus-group-unsubscribe-group}).
1529
1530 @item S k
1531 @itemx C-k
1532 @kindex S k (Group)
1533 @kindex C-k (Group)
1534 @findex gnus-group-kill-group
1535 @c @icon{gnus-group-kill-group}
1536 Kill the current group (@code{gnus-group-kill-group}).
1537
1538 @item S y
1539 @itemx C-y
1540 @kindex S y (Group)
1541 @kindex C-y (Group)
1542 @findex gnus-group-yank-group
1543 Yank the last killed group (@code{gnus-group-yank-group}).
1544
1545 @item C-x C-t
1546 @kindex C-x C-t (Group)
1547 @findex gnus-group-transpose-groups
1548 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1549 really a subscription command, but you can use it instead of a
1550 kill-and-yank sequence sometimes.
1551
1552 @item S w
1553 @itemx C-w
1554 @kindex S w (Group)
1555 @kindex C-w (Group)
1556 @findex gnus-group-kill-region
1557 Kill all groups in the region (@code{gnus-group-kill-region}). 
1558
1559 @item S z
1560 @kindex S z (Group)
1561 @findex gnus-group-kill-all-zombies
1562 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1563
1564 @item S C-k
1565 @kindex S C-k (Group)
1566 @findex gnus-group-kill-level
1567 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1568 These groups can't be yanked back after killing, so this command should
1569 be used with some caution.  The only time where this command comes in
1570 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1571 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1572 kill off all unsubscribed groups that do not have message numbers in the
1573 @file{.newsrc} file.  
1574
1575 @end table
1576
1577 Also @pxref{Group Levels}.
1578
1579
1580 @node Group Data
1581 @section Group Data
1582
1583 @table @kbd
1584
1585 @item c
1586 @kindex c (Group)
1587 @findex gnus-group-catchup-current
1588 @vindex gnus-group-catchup-group-hook
1589 @c @icon{gnus-group-catchup-current}
1590 Mark all unticked articles in this group as read
1591 (@code{gnus-group-catchup-current}).
1592 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1593 the group buffer.
1594
1595 @item C
1596 @kindex C (Group)
1597 @findex gnus-group-catchup-current-all
1598 Mark all articles in this group, even the ticked ones, as read
1599 (@code{gnus-group-catchup-current-all}).   
1600
1601 @item M-c
1602 @kindex M-c (Group)
1603 @findex gnus-group-clear-data
1604 Clear the data from the current group---nix out marks and the list of
1605 read articles (@code{gnus-group-clear-data}).
1606
1607 @item M-x gnus-group-clear-data-on-native-groups
1608 @kindex M-x gnus-group-clear-data-on-native-groups
1609 @findex gnus-group-clear-data-on-native-groups
1610 If you have switched from one @sc{nntp} server to another, all your marks
1611 and read ranges have become worthless.  You can use this command to
1612 clear out all data that you have on your native groups.  Use with
1613 caution. 
1614
1615 @end table
1616
1617
1618 @node Group Levels
1619 @section Group Levels
1620 @cindex group level
1621 @cindex level
1622
1623 All groups have a level of @dfn{subscribedness}.  For instance, if a
1624 group is on level 2, it is more subscribed than a group on level 5.  You
1625 can ask Gnus to just list groups on a given level or lower
1626 (@pxref{Listing Groups}), or to just check for new articles in groups on
1627 a given level or lower (@pxref{Scanning New Messages}).
1628
1629 Remember:  The higher the level of the group, the less important it is. 
1630
1631 @table @kbd
1632
1633 @item S l
1634 @kindex S l (Group)
1635 @findex gnus-group-set-current-level
1636 Set the level of the current group.  If a numeric prefix is given, the
1637 next @var{n} groups will have their levels set.  The user will be
1638 prompted for a level.
1639 @end table
1640
1641 @vindex gnus-level-killed
1642 @vindex gnus-level-zombie
1643 @vindex gnus-level-unsubscribed
1644 @vindex gnus-level-subscribed
1645 Gnus considers groups from levels 1 to
1646 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1647 @code{gnus-level-subscribed} (exclusive) and
1648 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1649 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1650 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1651 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1652 same, but zombie and killed groups have no information on what articles
1653 you have read, etc, stored.  This distinction between dead and living
1654 groups isn't done because it is nice or clever, it is done purely for
1655 reasons of efficiency.
1656
1657 It is recommended that you keep all your mail groups (if any) on quite
1658 low levels (e.g. 1 or 2).
1659
1660 If you want to play with the level variables, you should show some care.
1661 Set them once, and don't touch them ever again.  Better yet, don't touch
1662 them at all unless you know exactly what you're doing.
1663
1664 @vindex gnus-level-default-unsubscribed
1665 @vindex gnus-level-default-subscribed
1666 Two closely related variables are @code{gnus-level-default-subscribed}
1667 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1668 which are the levels that new groups will be put on if they are
1669 (un)subscribed.  These two variables should, of course, be inside the
1670 relevant valid ranges.
1671
1672 @vindex gnus-keep-same-level
1673 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1674 will only move to groups of the same level (or lower).  In
1675 particular, going from the last article in one group to the next group
1676 will go to the next group of the same level (or lower).  This might be
1677 handy if you want to read the most important groups before you read the
1678 rest.
1679
1680 @vindex gnus-group-default-list-level
1681 All groups with a level less than or equal to
1682 @code{gnus-group-default-list-level} will be listed in the group buffer
1683 by default.
1684
1685 @vindex gnus-group-list-inactive-groups
1686 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1687 groups will be listed along with the unread groups.  This variable is
1688 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1689 listed. 
1690
1691 @vindex gnus-group-use-permanent-levels
1692 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1693 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1694 use this level as the ``work'' level.
1695
1696 @vindex gnus-activate-level
1697 Gnus will normally just activate (i. e., query the server about) groups
1698 on level @code{gnus-activate-level} or less.  If you don't want to
1699 activate unsubscribed groups, for instance, you might set this variable
1700 to 5.  The default is 6.
1701
1702
1703 @node Group Score
1704 @section Group Score
1705 @cindex group score
1706 @cindex group rank
1707 @cindex rank
1708
1709 You would normally keep important groups on high levels, but that scheme
1710 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1711 group buffer according to how often you read groups, perhaps?  Within
1712 reason?  
1713
1714 This is what @dfn{group score} is for.  You can assign a score to each
1715 group.  You can then sort the group buffer based on this score.
1716 Alternatively, you can sort on score and then level.  (Taken together,
1717 the level and the score is called the @dfn{rank} of the group.  A group
1718 that is on level 4 and has a score of 1 has a higher rank than a group
1719 on level 5 that has a score of 300.  (The level is the most significant
1720 part and the score is the least significant part.))
1721
1722 @findex gnus-summary-bubble-group
1723 If you want groups you read often to get higher scores than groups you
1724 read seldom you can add the @code{gnus-summary-bubble-group} function to
1725 the @code{gnus-summary-exit-hook} hook.  This will result (after
1726 sorting) in a bubbling sort of action.  If you want to see that in
1727 action after each summary exit, you can add
1728 @code{gnus-group-sort-groups-by-rank} or
1729 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1730 slow things down somewhat.
1731
1732
1733 @node Marking Groups
1734 @section Marking Groups
1735 @cindex marking groups
1736
1737 If you want to perform some command on several groups, and they appear
1738 subsequently in the group buffer, you would normally just give a
1739 numerical prefix to the command.  Most group commands will then do your
1740 bidding on those groups.
1741
1742 However, if the groups are not in sequential order, you can still
1743 perform a command on several groups.  You simply mark the groups first
1744 with the process mark and then execute the command.
1745
1746 @table @kbd
1747
1748 @item #
1749 @kindex # (Group)
1750 @itemx M m
1751 @kindex M m (Group)
1752 @findex gnus-group-mark-group
1753 Set the mark on the current group (@code{gnus-group-mark-group}). 
1754
1755 @item M-#
1756 @kindex M-# (Group)
1757 @itemx M u
1758 @kindex M u (Group)
1759 @findex gnus-group-unmark-group
1760 Remove the mark from the current group
1761 (@code{gnus-group-unmark-group}). 
1762
1763 @item M U
1764 @kindex M U (Group)
1765 @findex gnus-group-unmark-all-groups
1766 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). 
1767
1768 @item M w
1769 @kindex M w (Group)
1770 @findex gnus-group-mark-region
1771 Mark all groups between point and mark (@code{gnus-group-mark-region}). 
1772
1773 @item M b
1774 @kindex M b (Group)
1775 @findex gnus-group-mark-buffer
1776 Mark all groups in the buffer (@code{gnus-group-mark-buffer}). 
1777
1778 @item M r
1779 @kindex M r (Group)
1780 @findex gnus-group-mark-regexp
1781 Mark all groups that match some regular expression
1782 (@code{gnus-group-mark-regexp}).  
1783 @end table
1784
1785 Also @pxref{Process/Prefix}.
1786
1787 @findex gnus-group-universal-argument
1788 If you want to execute some command on all groups that have been marked
1789 with the process mark, you can use the @kbd{M-&}
1790 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1791 the command to be executed.
1792
1793
1794 @node Foreign Groups
1795 @section Foreign Groups
1796 @cindex foreign groups
1797
1798 Below are some group mode commands for making and editing general foreign
1799 groups, as well as commands to ease the creation of a few
1800 special-purpose groups.  All these commands insert the newly created
1801 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1802 consulted.
1803
1804 @table @kbd
1805
1806 @item G m
1807 @kindex G m (Group)
1808 @findex gnus-group-make-group
1809 @cindex making groups
1810 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1811 for a name, a method and possibly an @dfn{address}.  For an easier way
1812 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1813
1814 @item G r
1815 @kindex G r (Group)
1816 @findex gnus-group-rename-group
1817 @cindex renaming groups
1818 Rename the current group to something else
1819 (@code{gnus-group-rename-group}).  This is valid only on some
1820 groups---mail groups mostly.  This command might very well be quite slow
1821 on some backends.
1822
1823 @item G c
1824 @kindex G c (Group)
1825 @cindex customizing
1826 @findex gnus-group-customize
1827 Customize the group parameters (@code{gnus-group-customize}).
1828
1829 @item G e
1830 @kindex G e (Group)
1831 @findex gnus-group-edit-group-method
1832 @cindex renaming groups
1833 Enter a buffer where you can edit the select method of the current
1834 group (@code{gnus-group-edit-group-method}).
1835
1836 @item G p
1837 @kindex G p (Group)
1838 @findex gnus-group-edit-group-parameters
1839 Enter a buffer where you can edit the group parameters
1840 (@code{gnus-group-edit-group-parameters}). 
1841
1842 @item G E
1843 @kindex G E (Group)
1844 @findex gnus-group-edit-group
1845 Enter a buffer where you can edit the group info
1846 (@code{gnus-group-edit-group}).
1847
1848 @item G d
1849 @kindex G d (Group)
1850 @findex gnus-group-make-directory-group
1851 @cindex nndir
1852 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1853 for a directory name (@code{gnus-group-make-directory-group}).
1854
1855 @item G h 
1856 @kindex G h (Group)
1857 @cindex help group
1858 @findex gnus-group-make-help-group
1859 Make the Gnus help group (@code{gnus-group-make-help-group}).
1860
1861 @item G a
1862 @kindex G a (Group)
1863 @cindex (ding) archive
1864 @cindex archive group
1865 @findex gnus-group-make-archive-group
1866 @vindex gnus-group-archive-directory
1867 @vindex gnus-group-recent-archive-directory
1868 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1869 default a group pointing to the most recent articles will be created
1870 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1871 group will be created from @code{gnus-group-archive-directory}.
1872
1873 @item G k
1874 @kindex G k (Group)
1875 @findex gnus-group-make-kiboze-group
1876 @cindex nnkiboze
1877 Make a kiboze group.  You will be prompted for a name, for a regexp to
1878 match groups to be ``included'' in the kiboze group, and a series of
1879 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1880 @xref{Kibozed Groups}.
1881
1882 @item G D
1883 @kindex G D (Group)
1884 @findex gnus-group-enter-directory
1885 @cindex nneething
1886 Read an arbitrary directory as if it were a newsgroup with the
1887 @code{nneething} backend (@code{gnus-group-enter-directory}).
1888 @xref{Anything Groups}. 
1889
1890 @item G f
1891 @kindex G f (Group)
1892 @findex gnus-group-make-doc-group
1893 @cindex ClariNet Briefs
1894 @cindex nndoc
1895 Make a group based on some file or other
1896 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1897 command, you will be prompted for a file name and a file type.
1898 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1899 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1900 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1901 this command without a prefix, Gnus will guess at the file type.
1902 @xref{Document Groups}.
1903
1904 @item G w
1905 @kindex G w (Group)
1906 @findex gnus-group-make-web-group
1907 @cindex DejaNews
1908 @cindex Alta Vista
1909 @cindex InReference
1910 @cindex nnweb
1911 Make an ephemeral group based on a web search
1912 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1913 command, make a solid group instead.  You will be prompted for the
1914 search engine type and the search string.  Valid search engine types
1915 include @code{dejanews}, @code{altavista} and @code{reference}.
1916 @xref{Web Searches}.
1917
1918 @item G DEL
1919 @kindex G DEL (Group)
1920 @findex gnus-group-delete-group
1921 This function will delete the current group
1922 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1923 actually delete all the articles in the group, and forcibly remove the
1924 group itself from the face of the Earth.  Use a prefix only if you are
1925 absolutely sure of what you are doing.  This command can't be used on
1926 read-only groups (like @code{nntp} group), though.
1927
1928 @item G V
1929 @kindex G V (Group)
1930 @findex gnus-group-make-empty-virtual
1931 Make a new, fresh, empty @code{nnvirtual} group
1932 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1933
1934 @item G v
1935 @kindex G v (Group)
1936 @findex gnus-group-add-to-virtual
1937 Add the current group to an @code{nnvirtual} group
1938 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1939 @end table
1940
1941 @xref{Select Methods} for more information on the various select
1942 methods. 
1943
1944 @vindex gnus-activate-foreign-newsgroups
1945 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1946 Gnus will check all foreign groups with this level or lower at startup.
1947 This might take quite a while, especially if you subscribe to lots of
1948 groups from different @sc{nntp} servers.
1949
1950
1951 @node Group Parameters
1952 @section Group Parameters
1953 @cindex group parameters
1954
1955 The group parameters store information local to a particular group:
1956
1957 @table @code
1958 @item to-address
1959 @cindex to-address
1960 If the group parameter list contains an element that looks like
1961 @code{(to-address .  "some@@where.com")}, that address will be used by
1962 the backend when doing followups and posts.  This is primarily useful in
1963 mail groups that represent closed mailing lists---mailing lists where
1964 it's expected that everybody that writes to the mailing list is
1965 subscribed to it.  Since using this parameter ensures that the mail only
1966 goes to the mailing list itself, it means that members won't receive two
1967 copies of your followups.
1968
1969 Using @code{to-address} will actually work whether the group is foreign
1970 or not.  Let's say there's a group on the server that is called
1971 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1972 the articles from a mail-to-news gateway.  Posting directly to this
1973 group is therefore impossible---you have to send mail to the mailing
1974 list address instead. 
1975
1976 @item to-list
1977 @cindex to-list
1978 If the group parameter list has an element that looks like
1979 @code{(to-list . "some@@where.com")}, that address will be used when
1980 doing a @kbd{a} in that group.  It is totally ignored when doing a
1981 followup---except that if it is present in a news group, you'll get mail
1982 group semantics when doing @kbd{f}.
1983
1984 If you do an @kbd{a} command in a mail group and you don't have a
1985 @code{to-list} group parameter, one will be added automatically upon
1986 sending the message.
1987
1988 @item visible
1989 @cindex visible
1990 If the group parameter list has the element @code{(visible . t)},
1991 that group will always be visible in the Group buffer, regardless
1992 of whether it has any unread articles.
1993
1994 @item broken-reply-to
1995 @cindex broken-reply-to
1996 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1997 headers in this group are to be ignored.  This can be useful if you're
1998 reading a mailing list group where the listserv has inserted
1999 @code{Reply-To} headers that point back to the listserv itself.  This is
2000 broken behavior.  So there!
2001
2002 @item to-group
2003 @cindex to-group
2004 Elements like @code{(to-group . "some.group.name")} means that all
2005 posts in that group will be sent to @code{some.group.name}.  
2006
2007 @item newsgroup
2008 @cindex newsgroup
2009 If this symbol is present in the group parameter list, Gnus will treat
2010 all responses as if they were responses to news articles.  This can be
2011 useful if you have a mail group that's really a mirror of a news group. 
2012
2013 @item gcc-self
2014 @cindex gcc-self
2015 If this symbol is present in the group parameter list and set to
2016 @code{t}, newly composed messages will be @code{Gcc}'d to the current
2017 group. If it is present and set to @code{none}, no @code{Gcc:} header
2018 will be generated, if it is present and a string, this string will be
2019 inserted literally as a @code{gcc} header (this symbol takes precedence
2020 over any default @code{Gcc} rules as described later).  @xref{Archived
2021 Messages}
2022
2023 @item auto-expire
2024 @cindex auto-expire
2025 If the group parameter has an element that looks like @code{(auto-expire
2026 . t)}, all articles read will be marked as expirable.  For an
2027 alternative approach, @pxref{Expiring Mail}.
2028
2029 @item total-expire
2030 @cindex total-expire
2031 If the group parameter has an element that looks like
2032 @code{(total-expire . t)}, all read articles will be put through the
2033 expiry process, even if they are not marked as expirable.  Use with
2034 caution.  Unread, ticked and dormant articles are not eligible for
2035 expiry.
2036
2037 @item expiry-wait
2038 @cindex expiry-wait
2039 @vindex nnmail-expiry-wait-function
2040 If the group parameter has an element that looks like @code{(expiry-wait
2041 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2042 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2043 The value can either be a number of days (not necessarily an integer) or
2044 the symbols @code{never} or @code{immediate}.
2045
2046 @item score-file
2047 @cindex score file group parameter
2048 Elements that look like @code{(score-file . "file")} will make
2049 @file{file} into the current adaptive score file for the group in
2050 question.  All adaptive score entries will be put into this file.
2051
2052 @item adapt-file
2053 @cindex adapt file group parameter
2054 Elements that look like @code{(adapt-file . "file")} will make
2055 @file{file} into the current adaptive file for the group in question.
2056 All adaptive score entries will be put into this file.
2057
2058 @item admin-address
2059 When unsubscribing from a mailing list you should never send the
2060 unsubscription notice to the mailing list itself.  Instead, you'd send
2061 messages to the administrative address.  This parameter allows you to
2062 put the admin address somewhere convenient.
2063
2064 @item display
2065 Elements that look like @code{(display . MODE)} say which articles to
2066 display on entering the group.  Valid values are:
2067
2068 @table @code
2069 @item all
2070 Display all articles, both read and unread.
2071
2072 @item default
2073 Display the default visible articles, which normally includes unread and
2074 ticked articles.
2075 @end table
2076
2077 @item comment
2078 Elements that look like @code{(comment . "This is a comment")}
2079 are arbitrary comments on the group.  They are currently ignored by
2080 Gnus, but provide a place for you to store information on particular
2081 groups. 
2082
2083 @item @var{(variable form)}
2084 You can use the group parameters to set variables local to the group you
2085 are entering.  If you want to turn threading off in @samp{news.answers},
2086 you could put @code{(gnus-show-threads nil)} in the group parameters of
2087 that group.  @code{gnus-show-threads} will be made into a local variable
2088 in the summary buffer you enter, and the form @code{nil} will be
2089 @code{eval}ed there.
2090
2091 This can also be used as a group-specific hook function, if you'd like.
2092 If you want to hear a beep when you enter a group, you could put
2093 something like @code{(dummy-variable (ding))} in the parameters of that
2094 group.  @code{dummy-variable} will be set to the result of the
2095 @code{(ding)} form, but who cares?
2096
2097 @end table
2098
2099 Use the @kbd{G p} command to edit group parameters of a group.
2100
2101 @pxref{Topic Parameters}.
2102
2103 Here's an example group parameter list:
2104
2105 @example
2106 ((to-address . "ding@@gnus.org")
2107  (auto-expiry . t))
2108 @end example
2109
2110
2111 @node Listing Groups
2112 @section Listing Groups
2113 @cindex group listing
2114
2115 These commands all list various slices of the groups available.
2116
2117 @table @kbd
2118
2119 @item l
2120 @itemx A s
2121 @kindex A s (Group)
2122 @kindex l (Group)
2123 @findex gnus-group-list-groups
2124 List all groups that have unread articles
2125 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2126 command will list only groups of level ARG and lower.  By default, it
2127 only lists groups of level five (i. e.,
2128 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2129 groups).
2130
2131 @item L
2132 @itemx A u
2133 @kindex A u (Group)
2134 @kindex L (Group)
2135 @findex gnus-group-list-all-groups
2136 List all groups, whether they have unread articles or not
2137 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2138 this command will list only groups of level ARG and lower.  By default,
2139 it lists groups of level seven or lower (i.e., just subscribed and
2140 unsubscribed groups).
2141
2142 @item A l
2143 @kindex A l (Group)
2144 @findex gnus-group-list-level
2145 List all unread groups on a specific level
2146 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2147 with no unread articles.
2148
2149 @item A k
2150 @kindex A k (Group)
2151 @findex gnus-group-list-killed
2152 List all killed groups (@code{gnus-group-list-killed}).  If given a
2153 prefix argument, really list all groups that are available, but aren't
2154 currently (un)subscribed.  This could entail reading the active file
2155 from the server.
2156
2157 @item A z
2158 @kindex A z (Group)
2159 @findex gnus-group-list-zombies
2160 List all zombie groups (@code{gnus-group-list-zombies}).
2161
2162 @item A m
2163 @kindex A m (Group)
2164 @findex gnus-group-list-matching
2165 List all unread, subscribed groups with names that match a regexp
2166 (@code{gnus-group-list-matching}). 
2167
2168 @item A M
2169 @kindex A M (Group)
2170 @findex gnus-group-list-all-matching
2171 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2172
2173 @item A A
2174 @kindex A A (Group)
2175 @findex gnus-group-list-active
2176 List absolutely all groups in the active file(s) of the
2177 server(s) you are connected to (@code{gnus-group-list-active}).  This
2178 might very well take quite a while.  It might actually be a better idea
2179 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2180 thing to match on.  Also note that this command may list groups that
2181 don't exist (yet)---these will be listed as if they were killed groups.
2182 Take the output with some grains of salt.
2183
2184 @item A a
2185 @kindex A a (Group)
2186 @findex gnus-group-apropos
2187 List all groups that have names that match a regexp
2188 (@code{gnus-group-apropos}).
2189
2190 @item A d
2191 @kindex A d (Group)
2192 @findex gnus-group-description-apropos
2193 List all groups that have names or descriptions that match a regexp
2194 (@code{gnus-group-description-apropos}).
2195
2196 @end table
2197
2198 @vindex gnus-permanently-visible-groups
2199 @cindex visible group parameter
2200 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2201 always be shown, whether they have unread articles or not.  You can also
2202 add the @code{visible} element to the group parameters in question to
2203 get the same effect.
2204
2205 @vindex gnus-list-groups-with-ticked-articles
2206 Groups that have just ticked articles in it are normally listed in the
2207 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2208 @code{nil}, these groups will be treated just like totally empty
2209 groups.  It is @code{t} by default.
2210
2211
2212 @node Sorting Groups
2213 @section Sorting Groups
2214 @cindex sorting groups
2215
2216 @kindex C-c C-s (Group)
2217 @findex gnus-group-sort-groups
2218 @vindex gnus-group-sort-function
2219 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2220 group buffer according to the function(s) given by the
2221 @code{gnus-group-sort-function} variable.  Available sorting functions
2222 include: 
2223
2224 @table @code
2225
2226 @item gnus-group-sort-by-alphabet
2227 @findex gnus-group-sort-by-alphabet
2228 Sort the group names alphabetically.  This is the default.
2229
2230 @item gnus-group-sort-by-real-name
2231 @findex gnus-group-sort-by-real-name
2232 Sort the group alphabetically on the real (unprefixed) group names.
2233
2234 @item gnus-group-sort-by-level
2235 @findex gnus-group-sort-by-level
2236 Sort by group level.
2237
2238 @item gnus-group-sort-by-score
2239 @findex gnus-group-sort-by-score
2240 Sort by group score.  @xref{Group Score}.
2241
2242 @item gnus-group-sort-by-rank
2243 @findex gnus-group-sort-by-rank
2244 Sort by group score and then the group level.  The level and the score
2245 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2246
2247 @item gnus-group-sort-by-unread
2248 @findex gnus-group-sort-by-unread
2249 Sort by number of unread articles.
2250
2251 @item gnus-group-sort-by-method
2252 @findex gnus-group-sort-by-method
2253 Sort alphabetically on the select method.
2254
2255
2256 @end table
2257
2258 @code{gnus-group-sort-function} can also be a list of sorting
2259 functions.  In that case, the most significant sort key function must be
2260 the last one.
2261
2262
2263 There are also a number of commands for sorting directly according to
2264 some sorting criteria:
2265
2266 @table @kbd
2267 @item G S a
2268 @kindex G S a (Group)
2269 @findex gnus-group-sort-groups-by-alphabet
2270 Sort the group buffer alphabetically by group name
2271 (@code{gnus-group-sort-groups-by-alphabet}). 
2272
2273 @item G S u
2274 @kindex G S u (Group)
2275 @findex gnus-group-sort-groups-by-unread
2276 Sort the group buffer by the number of unread articles
2277 (@code{gnus-group-sort-groups-by-unread}).
2278
2279 @item G S l
2280 @kindex G S l (Group)
2281 @findex gnus-group-sort-groups-by-level
2282 Sort the group buffer by group level
2283 (@code{gnus-group-sort-groups-by-level}). 
2284
2285 @item G S v
2286 @kindex G S v (Group)
2287 @findex gnus-group-sort-groups-by-score
2288 Sort the group buffer by group score
2289 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2290
2291 @item G S r
2292 @kindex G S r (Group)
2293 @findex gnus-group-sort-groups-by-rank
2294 Sort the group buffer by group rank
2295 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2296
2297 @item G S m
2298 @kindex G S m (Group)
2299 @findex gnus-group-sort-groups-by-method
2300 Sort the group buffer alphabetically by backend name
2301 (@code{gnus-group-sort-groups-by-method}). 
2302
2303 @end table
2304
2305 When given a prefix, all these commands will sort in reverse order. 
2306
2307 You can also sort a subset of the groups:
2308
2309 @table @kbd
2310 @item G P a
2311 @kindex G P a (Group)
2312 @findex gnus-group-sort-selected-groups-by-alphabet
2313 Sort the process/prefixed groups in the group buffer alphabetically by
2314 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2315
2316 @item G P u
2317 @kindex G P u (Group)
2318 @findex gnus-group-sort-selected-groups-by-unread
2319 Sort the process/prefixed groups in the group buffer by the number of
2320 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2321
2322 @item G P l
2323 @kindex G P l (Group)
2324 @findex gnus-group-sort-selected-groups-by-level
2325 Sort the process/prefixed groups in the group buffer by group level
2326 (@code{gnus-group-sort-selected-groups-by-level}).
2327
2328 @item G P v
2329 @kindex G P v (Group)
2330 @findex gnus-group-sort-selected-groups-by-score
2331 Sort the process/prefixed groups in the group buffer by group score
2332 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2333
2334 @item G P r
2335 @kindex G P r (Group)
2336 @findex gnus-group-sort-selected-groups-by-rank
2337 Sort the process/prefixed groups in the group buffer by group rank
2338 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2339
2340 @item G P m
2341 @kindex G P m (Group)
2342 @findex gnus-group-sort-selected-groups-by-method
2343 Sort the process/prefixed groups in the group buffer alphabetically by
2344 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2345
2346 @end table
2347
2348
2349
2350 @node Group Maintenance
2351 @section Group Maintenance
2352 @cindex bogus groups
2353
2354 @table @kbd
2355 @item b
2356 @kindex b (Group)
2357 @findex gnus-group-check-bogus-groups
2358 Find bogus groups and delete them
2359 (@code{gnus-group-check-bogus-groups}).
2360
2361 @item F
2362 @kindex F (Group)
2363 @findex gnus-group-find-new-groups
2364 Find new groups and process them (@code{gnus-group-find-new-groups}).
2365 If given a prefix, use the @code{ask-server} method to query the server
2366 for new groups.
2367
2368 @item C-c C-x
2369 @kindex C-c C-x (Group)
2370 @findex gnus-group-expire-articles
2371 Run all expirable articles in the current group through the expiry
2372 process (if any) (@code{gnus-group-expire-articles}).
2373
2374 @item C-c M-C-x
2375 @kindex C-c M-C-x (Group)
2376 @findex gnus-group-expire-all-groups
2377 Run all articles in all groups through the expiry process
2378 (@code{gnus-group-expire-all-groups}).
2379
2380 @end table
2381
2382
2383 @node Browse Foreign Server
2384 @section Browse Foreign Server
2385 @cindex foreign servers
2386 @cindex browsing servers
2387
2388 @table @kbd
2389 @item B
2390 @kindex B (Group)
2391 @findex gnus-group-browse-foreign-server
2392 You will be queried for a select method and a server name.  Gnus will
2393 then attempt to contact this server and let you browse the groups there
2394 (@code{gnus-group-browse-foreign-server}).
2395 @end table
2396
2397 @findex gnus-browse-mode
2398 A new buffer with a list of available groups will appear.  This buffer
2399 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2400 a lot) like a normal group buffer.
2401
2402 Here's a list of keystrokes available in the browse mode:
2403
2404 @table @kbd
2405 @item n
2406 @kindex n (Browse)
2407 @findex gnus-group-next-group
2408 Go to the next group (@code{gnus-group-next-group}).
2409
2410 @item p
2411 @kindex p (Browse)
2412 @findex gnus-group-prev-group
2413 Go to the previous group (@code{gnus-group-prev-group}).
2414
2415 @item SPACE
2416 @kindex SPACE (Browse)
2417 @findex gnus-browse-read-group
2418 Enter the current group and display the first article
2419 (@code{gnus-browse-read-group}). 
2420
2421 @item RET
2422 @kindex RET (Browse)
2423 @findex gnus-browse-select-group
2424 Enter the current group (@code{gnus-browse-select-group}). 
2425
2426 @item u
2427 @kindex u (Browse)
2428 @findex gnus-browse-unsubscribe-current-group
2429 Unsubscribe to the current group, or, as will be the case here,
2430 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
2431
2432 @item l
2433 @itemx q
2434 @kindex q (Browse)
2435 @kindex l (Browse)
2436 @findex gnus-browse-exit
2437 Exit browse mode (@code{gnus-browse-exit}).
2438
2439 @item ?
2440 @kindex ? (Browse)
2441 @findex gnus-browse-describe-briefly
2442 Describe browse mode briefly (well, there's not much to describe, is
2443 there) (@code{gnus-browse-describe-briefly}).
2444 @end table
2445
2446
2447 @node Exiting Gnus
2448 @section Exiting Gnus
2449 @cindex exiting Gnus
2450
2451 Yes, Gnus is ex(c)iting.
2452
2453 @table @kbd
2454 @item z
2455 @kindex z (Group)
2456 @findex gnus-group-suspend
2457 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2458 but it kills all buffers except the Group buffer.  I'm not sure why this
2459 is a gain, but then who am I to judge?
2460
2461 @item q
2462 @kindex q (Group)
2463 @findex gnus-group-exit
2464 @c @icon{gnus-group-exit}
2465 Quit Gnus (@code{gnus-group-exit}).
2466
2467 @item Q
2468 @kindex Q (Group)
2469 @findex gnus-group-quit
2470 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2471 The dribble file will be saved, though (@pxref{Auto Save}).
2472 @end table
2473
2474 @vindex gnus-exit-gnus-hook
2475 @vindex gnus-suspend-gnus-hook
2476 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2477 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2478 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2479 exiting Gnus.
2480
2481 @findex gnus-unload
2482 @cindex unloading
2483 If you wish to completely unload Gnus and all its adherents, you can use
2484 the @code{gnus-unload} command.  This command is also very handy when
2485 trying to customize meta-variables.
2486
2487 Note:
2488
2489 @quotation
2490 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2491 numbly heavy and herself fall into a hazy trance as the boy sitting
2492 behind her drew repeated lines with his pencil across the back of her
2493 plastic chair.
2494 @end quotation
2495
2496
2497 @node Group Topics
2498 @section Group Topics
2499 @cindex topics
2500
2501 If you read lots and lots of groups, it might be convenient to group
2502 them hierarchically according to topics.  You put your Emacs groups over
2503 here, your sex groups over there, and the rest (what, two groups or so?)
2504 you put in some misc section that you never bother with anyway.  You can
2505 even group the Emacs sex groups as a sub-topic to either the Emacs
2506 groups or the sex groups---or both!  Go wild!
2507
2508 @iftex
2509 @iflatex
2510 \gnusfigure{Group Topics}{400}{
2511 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2512 }
2513 @end iflatex
2514 @end iftex
2515
2516 Here's an example:
2517
2518 @example
2519 Gnus
2520   Emacs -- I wuw it!
2521      3: comp.emacs
2522      2: alt.religion.emacs
2523     Naughty Emacs
2524      452: alt.sex.emacs
2525        0: comp.talk.emacs.recovery
2526   Misc
2527      8: comp.binaries.fractals
2528     13: comp.sources.unix
2529 @end example
2530
2531 @findex gnus-topic-mode
2532 @kindex t (Group)
2533 To get this @emph{fab} functionality you simply turn on (ooh!) the
2534 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2535 is a toggling command.)
2536
2537 Go ahead, just try it.  I'll still be here when you get back.  La de
2538 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2539 press @kbd{l}.  There.  All your groups are now listed under
2540 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2541 bothered?
2542
2543 If you want this permanently enabled, you should add that minor mode to
2544 the hook for the group mode:
2545
2546 @lisp
2547 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2548 @end lisp
2549
2550 @menu 
2551 * Topic Variables::    How to customize the topics the Lisp Way.
2552 * Topic Commands::     Interactive E-Z commands.
2553 * Topic Sorting::      Sorting each topic individually.
2554 * Topic Topology::     A map of the world.
2555 * Topic Parameters::   Parameters that apply to all groups in a topic.
2556 @end menu
2557
2558
2559 @node Topic Variables
2560 @subsection Topic Variables
2561 @cindex topic variables
2562
2563 Now, if you select a topic, it will fold/unfold that topic, which is
2564 really neat, I think.
2565
2566 @vindex gnus-topic-line-format
2567 The topic lines themselves are created according to the
2568 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2569 Valid elements are:
2570
2571 @table @samp
2572 @item i
2573 Indentation.
2574 @item n
2575 Topic name.
2576 @item v
2577 Visibility.
2578 @item l
2579 Level.
2580 @item g
2581 Number of groups in the topic.
2582 @item a
2583 Number of unread articles in the topic.
2584 @item A 
2585 Number of unread articles in the topic and all its subtopics. 
2586 @end table
2587
2588 @vindex gnus-topic-indent-level
2589 Each sub-topic (and the groups in the sub-topics) will be indented with
2590 @code{gnus-topic-indent-level} times the topic level number of spaces.
2591 The default is 2.
2592
2593 @vindex gnus-topic-mode-hook
2594 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2595
2596 @vindex gnus-topic-display-empty-topics
2597 The @code{gnus-topic-display-empty-topics} says whether to display even
2598 topics that have no unread articles in them.  The default is @code{t}.
2599
2600
2601 @node Topic Commands
2602 @subsection Topic Commands
2603 @cindex topic commands
2604
2605 When the topic minor mode is turned on, a new @kbd{T} submap will be
2606 available.  In addition, a few of the standard keys change their
2607 definitions slightly.
2608
2609 @table @kbd
2610
2611 @item T n
2612 @kindex T n (Topic)
2613 @findex gnus-topic-create-topic
2614 Prompt for a new topic name and create it 
2615 (@code{gnus-topic-create-topic}). 
2616
2617 @item T m
2618 @kindex T m (Topic)
2619 @findex gnus-topic-move-group
2620 Move the current group to some other topic
2621 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2622 convention (@pxref{Process/Prefix}).
2623
2624 @item T c
2625 @kindex T c (Topic)
2626 @findex gnus-topic-copy-group
2627 Copy the current group to some other topic
2628 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2629 convention (@pxref{Process/Prefix}).
2630
2631 @item T D
2632 @kindex T D (Topic)
2633 @findex gnus-topic-remove-group
2634 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2635 This command uses the process/prefix convention
2636 (@pxref{Process/Prefix}).
2637
2638 @item T M
2639 @kindex T M (Topic)
2640 @findex gnus-topic-move-matching
2641 Move all groups that match some regular expression to a topic
2642 (@code{gnus-topic-move-matching}). 
2643
2644 @item T C
2645 @kindex T C (Topic)
2646 @findex gnus-topic-copy-matching
2647 Copy all groups that match some regular expression to a topic
2648 (@code{gnus-topic-copy-matching}). 
2649
2650 @item T h
2651 @kindex T h (Topic)
2652 @findex gnus-topic-toggle-display-empty-topics
2653 Toggle hiding empty topics
2654 (@code{gnus-topic-toggle-display-empty-topics}). 
2655
2656 @item T #
2657 @kindex T # (Topic)
2658 @findex gnus-topic-mark-topic
2659 Mark all groups in the current topic with the process mark
2660 (@code{gnus-topic-mark-topic}). 
2661
2662 @item T M-#
2663 @kindex T M-# (Topic)
2664 @findex gnus-topic-unmark-topic
2665 Remove the process mark from all groups in the current topic
2666 (@code{gnus-topic-unmark-topic}). 
2667
2668 @item RET
2669 @kindex RET (Topic)
2670 @findex gnus-topic-select-group
2671 @itemx SPACE
2672 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2673 When you perform this command on a group, you'll enter the group, as
2674 usual.  When done on a topic line, the topic will be folded (if it was
2675 visible) or unfolded (if it was folded already).  So it's basically a
2676 toggling command on topics.  In addition, if you give a numerical
2677 prefix, group on that level (and lower) will be displayed.
2678
2679 @item T TAB
2680 @kindex T TAB (Topic)
2681 @findex gnus-topic-indent
2682 ``Indent'' the current topic so that it becomes a sub-topic of the
2683 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2684 ``un-indent'' the topic instead.
2685
2686 @item C-k
2687 @kindex C-k (Topic)
2688 @findex gnus-topic-kill-group
2689 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2690 topic will be removed along with the topic.
2691
2692 @item C-y
2693 @kindex C-y (Topic)
2694 @findex gnus-topic-yank-group
2695 Yank the previously killed group or topic
2696 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2697 before all groups. 
2698
2699 @item T r
2700 @kindex T r (Topic)
2701 @findex gnus-topic-rename
2702 Rename a topic (@code{gnus-topic-rename}). 
2703
2704 @item T DEL
2705 @kindex T DEL (Topic)
2706 @findex gnus-topic-delete
2707 Delete an empty topic (@code{gnus-topic-delete}). 
2708
2709 @item A T
2710 @kindex A T (Topic)
2711 @findex gnus-topic-list-active
2712 List all groups that Gnus knows about in a topics-ified way
2713 (@code{gnus-topic-list-active}).
2714
2715 @item G p
2716 @kindex G p (Topic)
2717 @findex gnus-topic-edit-parameters
2718 @cindex group parameters
2719 @cindex topic parameters
2720 @cindex parameters
2721 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2722 @xref{Topic Parameters}.
2723
2724 @end table
2725
2726
2727 @node Topic Sorting
2728 @subsection Topic Sorting
2729 @cindex topic sorting
2730
2731 You can sort the groups in each topic individually with the following
2732 commands: 
2733
2734
2735 @table @kbd
2736 @item T S a
2737 @kindex T S a (Topic)
2738 @findex gnus-topic-sort-groups-by-alphabet
2739 Sort the current topic alphabetically by group name
2740 (@code{gnus-topic-sort-groups-by-alphabet}). 
2741
2742 @item T S u
2743 @kindex T S u (Topic)
2744 @findex gnus-topic-sort-groups-by-unread
2745 Sort the current topic by the number of unread articles
2746 (@code{gnus-topic-sort-groups-by-unread}).
2747
2748 @item T S l
2749 @kindex T S l (Topic)
2750 @findex gnus-topic-sort-groups-by-level
2751 Sort the current topic by group level
2752 (@code{gnus-topic-sort-groups-by-level}). 
2753
2754 @item T S v
2755 @kindex T S v (Topic)
2756 @findex gnus-topic-sort-groups-by-score
2757 Sort the current topic by group score
2758 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2759
2760 @item T S r
2761 @kindex T S r (Topic)
2762 @findex gnus-topic-sort-groups-by-rank
2763 Sort the current topic by group rank
2764 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2765
2766 @item T S m
2767 @kindex T S m (Topic)
2768 @findex gnus-topic-sort-groups-by-method
2769 Sort the current topic alphabetically by backend name
2770 (@code{gnus-topic-sort-groups-by-method}). 
2771
2772 @end table
2773
2774 @xref{Sorting Groups} for more information about group sorting. 
2775
2776
2777 @node Topic Topology
2778 @subsection Topic Topology
2779 @cindex topic topology
2780 @cindex topology
2781
2782 So, let's have a look at an example group buffer:
2783
2784 @example
2785 Gnus
2786   Emacs -- I wuw it!
2787      3: comp.emacs
2788      2: alt.religion.emacs
2789     Naughty Emacs
2790      452: alt.sex.emacs
2791        0: comp.talk.emacs.recovery
2792   Misc
2793      8: comp.binaries.fractals
2794     13: comp.sources.unix
2795 @end example
2796
2797 So, here we have one top-level topic (@samp{Gnus}), two topics under
2798 that, and one sub-topic under one of the sub-topics.  (There is always
2799 just one (1) top-level topic).  This topology can be expressed as
2800 follows:
2801
2802 @lisp
2803 (("Gnus" visible)
2804  (("Emacs -- I wuw it!" visible) 
2805   (("Naughty Emacs" visible)))
2806  (("Misc" visible)))
2807 @end lisp
2808
2809 @vindex gnus-topic-topology
2810 This is in fact how the variable @code{gnus-topic-topology} would look
2811 for the display above.  That variable is saved in the @file{.newsrc.eld}
2812 file, and shouldn't be messed with manually---unless you really want
2813 to.  Since this variable is read from the @file{.newsrc.eld} file,
2814 setting it in any other startup files will have no effect.  
2815
2816 This topology shows what topics are sub-topics of what topics (right),
2817 and which topics are visible.  Two settings are currently
2818 allowed---@code{visible} and @code{invisible}.
2819
2820
2821 @node Topic Parameters
2822 @subsection Topic Parameters
2823 @cindex topic parameters
2824
2825 All groups in a topic will inherit group parameters from the parent (and
2826 ancestor) topic parameters.  All valid group parameters are valid topic
2827 parameters (@pxref{Group Parameters}).  
2828
2829 Group parameters (of course) override topic parameters, and topic
2830 parameters in sub-topics override topic parameters in super-topics.  You
2831 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2832 verb, although you may feel free to disagree with me here.)
2833
2834 @example
2835 Gnus
2836   Emacs
2837      3: comp.emacs
2838      2: alt.religion.emacs
2839    452: alt.sex.emacs
2840     Relief
2841      452: alt.sex.emacs
2842        0: comp.talk.emacs.recovery
2843   Misc
2844      8: comp.binaries.fractals
2845     13: comp.sources.unix
2846    452: alt.sex.emacs
2847 @end example
2848
2849 The @samp{Emacs} topic has the topic parameter @code{(score-file
2850 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2851 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2852 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2853 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2854 . "religion.SCORE")}.
2855
2856 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2857 will get the @file{relief.SCORE} home score file.  If you enter the same
2858 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2859 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2860 get the @file{religion.SCORE} home score file.
2861
2862 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2863 there are some problems, especially with the @code{total-expiry}
2864 parameter.  Say you have a mail group in two topics; one with
2865 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2866 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2867 of these topics you mean to expire articles from, so anything may
2868 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2869 happens.  You just have to be careful if you do stuff like that.
2870
2871
2872 @node Misc Group Stuff
2873 @section Misc Group Stuff
2874
2875 @menu
2876 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2877 * Group Information::     Information and help on groups and Gnus.
2878 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2879 * File Commands::         Reading and writing the Gnus files.
2880 @end menu
2881
2882 @table @kbd
2883
2884 @item ^
2885 @kindex ^ (Group)
2886 @findex gnus-group-enter-server-mode
2887 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2888 @xref{The Server Buffer}.
2889
2890 @item a
2891 @kindex a (Group)
2892 @findex gnus-group-post-news
2893 Post an article to a group (@code{gnus-group-post-news}).  If given a
2894 prefix, the current group name will be used as the default.
2895
2896 @item m
2897 @kindex m (Group)
2898 @findex gnus-group-mail
2899 Mail a message somewhere (@code{gnus-group-mail}).
2900
2901 @end table
2902
2903 Variables for the group buffer:
2904
2905 @table @code
2906
2907 @item gnus-group-mode-hook
2908 @vindex gnus-group-mode-hook
2909 is called after the group buffer has been
2910 created. 
2911
2912 @item gnus-group-prepare-hook
2913 @vindex gnus-group-prepare-hook
2914 is called after the group buffer is
2915 generated.  It may be used to modify the buffer in some strange,
2916 unnatural way.
2917
2918 @item gnus-group-prepared-hook
2919 @vindex gnus-group-prepare-hook
2920 is called as the very last thing after the group buffer has been
2921 generated.  It may be used to move point around, for instance.
2922
2923 @item gnus-permanently-visible-groups
2924 @vindex gnus-permanently-visible-groups
2925 Groups matching this regexp will always be listed in the group buffer,
2926 whether they are empty or not.
2927
2928 @end table
2929
2930
2931 @node Scanning New Messages
2932 @subsection Scanning New Messages
2933 @cindex new messages
2934 @cindex scanning new news
2935
2936 @table @kbd
2937
2938 @item g
2939 @kindex g (Group)
2940 @findex gnus-group-get-new-news
2941 @c @icon{gnus-group-get-new-news}
2942 Check the server(s) for new articles.  If the numerical prefix is used,
2943 this command will check only groups of level @var{arg} and lower
2944 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2945 command will force a total re-reading of the active file(s) from the
2946 backend(s).
2947
2948 @item M-g
2949 @kindex M-g (Group)
2950 @findex gnus-group-get-new-news-this-group
2951 @vindex gnus-goto-next-group-when-activating
2952 @c @icon{gnus-group-get-new-news-this-group}
2953 Check whether new articles have arrived in the current group
2954 (@code{gnus-group-get-new-news-this-group}).
2955 @code{gnus-goto-next-group-when-activating} says whether this command is
2956 to move point to the next group or not.  It is @code{t} by default.
2957
2958 @findex gnus-activate-all-groups
2959 @cindex activating groups
2960 @item C-c M-g
2961 @kindex C-c M-g (Group)
2962 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2963
2964 @item R
2965 @kindex R (Group)
2966 @cindex restarting
2967 @findex gnus-group-restart
2968 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2969 file(s), closes the connection to all servers, clears up all run-time
2970 Gnus variables, and then starts Gnus all over again.
2971
2972 @end table
2973
2974 @vindex gnus-get-new-news-hook
2975 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2976
2977 @vindex gnus-after-getting-new-news-hook
2978 @code{gnus-after-getting-new-news-hook} is run after checking for new
2979 news.
2980
2981
2982 @node Group Information
2983 @subsection Group Information
2984 @cindex group information
2985 @cindex information on groups
2986
2987 @table @kbd
2988
2989
2990 @item H f
2991 @kindex H f (Group)
2992 @findex gnus-group-fetch-faq
2993 @vindex gnus-group-faq-directory
2994 @cindex FAQ
2995 @cindex ange-ftp
2996 Try to fetch the FAQ for the current group
2997 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2998 @code{gnus-group-faq-directory}, which is usually a directory on a
2999 remote machine.  This variable can also be a list of directories.  In
3000 that case, giving a prefix to this command will allow you to choose
3001 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3002 for fetching the file.
3003
3004 If fetching from the first site is unsuccessful, Gnus will attempt to go
3005 through @code{gnus-group-faq-directory} and try to open them one by one.
3006
3007 @item H d
3008 @itemx C-c C-d
3009 @c @icon{gnus-group-describe-group}
3010 @kindex H d (Group)
3011 @kindex C-c C-d (Group)
3012 @cindex describing groups
3013 @cindex group description
3014 @findex gnus-group-describe-group
3015 Describe the current group (@code{gnus-group-describe-group}).  If given
3016 a prefix, force Gnus to re-read the description from the server.
3017
3018 @item M-d
3019 @kindex M-d (Group)
3020 @findex gnus-group-describe-all-groups
3021 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3022 prefix, force Gnus to re-read the description file from the server.
3023
3024 @item H v
3025 @itemx V
3026 @kindex V (Group)
3027 @kindex H v (Group)
3028 @cindex version
3029 @findex gnus-version
3030 Display current Gnus version numbers (@code{gnus-version}).
3031
3032 @item ?
3033 @kindex ? (Group)
3034 @findex gnus-group-describe-briefly
3035 Give a very short help message (@code{gnus-group-describe-briefly}).
3036
3037 @item C-c C-i
3038 @kindex C-c C-i (Group)
3039 @cindex info
3040 @cindex manual
3041 @findex gnus-info-find-node
3042 Go to the Gnus info node (@code{gnus-info-find-node}).
3043 @end table
3044
3045
3046 @node Group Timestamp
3047 @subsection Group Timestamp
3048 @cindex timestamps
3049 @cindex group timestamps
3050
3051 It can be convenient to let Gnus keep track of when you last read a
3052 group.  To set the ball rolling, you should add
3053 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3054
3055 @lisp
3056 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3057 @end lisp
3058
3059 After doing this, each time you enter a group, it'll be recorded.
3060
3061 This information can be displayed in various ways---the easiest is to
3062 use the @samp{%d} spec in the group line format:
3063
3064 @lisp
3065 (setq gnus-group-line-format 
3066       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3067 @end lisp
3068
3069 This will result in lines looking like:
3070
3071 @example
3072 *        0: mail.ding                                19961002T012943
3073          0: custom                                   19961002T012713
3074 @end example
3075
3076 As you can see, the date is displayed in compact ISO 8601 format.  This
3077 may be a bit too much, so to just display the date, you could say
3078 something like:
3079
3080 @lisp
3081 (setq gnus-group-line-format 
3082       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3083 @end lisp
3084
3085
3086 @node File Commands
3087 @subsection File Commands
3088 @cindex file commands
3089
3090 @table @kbd
3091
3092 @item r
3093 @kindex r (Group)
3094 @findex gnus-group-read-init-file
3095 @vindex gnus-init-file
3096 @cindex reading init file
3097 Re-read the init file (@code{gnus-init-file}, which defaults to
3098 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3099
3100 @item s
3101 @kindex s (Group)
3102 @findex gnus-group-save-newsrc
3103 @cindex saving .newsrc
3104 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3105 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3106 file(s) whether Gnus thinks it is necessary or not.
3107
3108 @c @item Z
3109 @c @kindex Z (Group)
3110 @c @findex gnus-group-clear-dribble
3111 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3112
3113 @end table
3114
3115
3116 @node The Summary Buffer
3117 @chapter The Summary Buffer
3118 @cindex summary buffer
3119
3120 A line for each article is displayed in the summary buffer.  You can
3121 move around, read articles, post articles and reply to articles.
3122
3123 The most common way to a summary buffer is to select a group from the
3124 group buffer (@pxref{Selecting a Group}).  
3125
3126 You can have as many summary buffers open as you wish.
3127
3128 @menu
3129 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3130 * Summary Maneuvering::         Moving around the summary buffer.
3131 * Choosing Articles::           Reading articles.
3132 * Paging the Article::          Scrolling the current article.
3133 * Reply Followup and Post::     Posting articles.
3134 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3135 * Marking Articles::            Marking articles as read, expirable, etc.
3136 * Limiting::                    You can limit the summary buffer.
3137 * Threading::                   How threads are made.
3138 * Sorting::                     How articles and threads are sorted.
3139 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3140 * Article Caching::             You may store articles in a cache.
3141 * Persistent Articles::         Making articles expiry-resistant.
3142 * Article Backlog::             Having already read articles hang around.
3143 * Saving Articles::             Ways of customizing article saving.
3144 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3145 * Article Treatment::           The article buffer can be mangled at will.
3146 * Article Commands::            Doing various things with the article buffer.
3147 * Summary Sorting::             Sorting the summary buffer in various ways.
3148 * Finding the Parent::          No child support? Get the parent.
3149 * Alternative Approaches::      Reading using non-default summaries.
3150 * Tree Display::                A more visual display of threads.
3151 * Mail Group Commands::         Some commands can only be used in mail groups.
3152 * Various Summary Stuff::       What didn't fit anywhere else.
3153 * Exiting the Summary Buffer::  Returning to the Group buffer.
3154 * Crosspost Handling::          How crossposted articles are dealt with.
3155 * Duplicate Suppression::       An alternative when crosspost handling fails.
3156 @end menu
3157
3158
3159 @node Summary Buffer Format
3160 @section Summary Buffer Format
3161 @cindex summary buffer format
3162
3163 @iftex
3164 @iflatex
3165 \gnusfigure{The Summary Buffer}{180}{
3166 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3167 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3168 }
3169 @end iflatex
3170 @end iftex
3171
3172 @menu
3173 * Summary Buffer Lines::     You can specify how summary lines should look.
3174 * Summary Buffer Mode Line:: You can say how the mode line should look.
3175 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3176 @end menu
3177
3178 @findex mail-extract-address-components
3179 @findex gnus-extract-address-components
3180 @vindex gnus-extract-address-components
3181 Gnus will use the value of the @code{gnus-extract-address-components}
3182 variable as a function for getting the name and address parts of a
3183 @code{From} header.  Two pre-defined functions exist:
3184 @code{gnus-extract-address-components}, which is the default, quite
3185 fast, and too simplistic solution; and
3186 @code{mail-extract-address-components}, which works very nicely, but is
3187 slower.  The default function will return the wrong answer in 5% of the
3188 cases.  If this is unacceptable to you, use the other function instead.
3189
3190 @vindex gnus-summary-same-subject
3191 @code{gnus-summary-same-subject} is a string indicating that the current
3192 article has the same subject as the previous.  This string will be used
3193 with those specs that require it.  The default is @code{""}.
3194
3195
3196 @node Summary Buffer Lines
3197 @subsection Summary Buffer Lines
3198
3199 @vindex gnus-summary-line-format
3200 You can change the format of the lines in the summary buffer by changing
3201 the @code{gnus-summary-line-format} variable.  It works along the same
3202 lines as a normal @code{format} string, with some extensions
3203 (@pxref{Formatting Variables}).
3204
3205 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3206
3207 The following format specification characters are understood:
3208
3209 @table @samp
3210 @item N 
3211 Article number.
3212 @item S
3213 Subject string.
3214 @item s
3215 Subject if the article is the root of the thread or the previous article
3216 had a different subject, @code{gnus-summary-same-subject} otherwise.
3217 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3218 @item F
3219 Full @code{From} header.
3220 @item n
3221 The name (from the @code{From} header).
3222 @item a
3223 The name (from the @code{From} header).  This differs from the @code{n}
3224 spec in that it uses the function designated by the
3225 @code{gnus-extract-address-components} variable, which is slower, but
3226 may be more thorough.
3227 @item A
3228 The address (from the @code{From} header).  This works the same way as
3229 the @code{a} spec.
3230 @item L
3231 Number of lines in the article.
3232 @item c
3233 Number of characters in the article.
3234 @item I
3235 Indentation based on thread level (@pxref{Customizing Threading}).
3236 @item T
3237 Nothing if the article is a root and lots of spaces if it isn't (it
3238 pushes everything after it off the screen).
3239 @item [
3240 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3241 for adopted articles (@pxref{Customizing Threading}).
3242 @item ]
3243 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3244 for adopted articles.
3245 @item >
3246 One space for each thread level.
3247 @item <
3248 Twenty minus thread level spaces.
3249 @item U
3250 Unread.
3251 @item R
3252 Replied.
3253 @item i
3254 Score as a number (@pxref{Scoring}).
3255 @item z
3256 @vindex gnus-summary-zcore-fuzz
3257 Zcore, @samp{+} if above the default level and @samp{-} if below the
3258 default level.  If the difference between
3259 @code{gnus-summary-default-level} and the score is less than
3260 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3261 @item V
3262 Total thread score.
3263 @item x
3264 @code{Xref}.
3265 @item D
3266 @code{Date}.
3267 @item d
3268 The @code{Date} in @code{DD-MMM} format.
3269 @item o
3270 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3271 @item M
3272 @code{Message-ID}.
3273 @item r
3274 @code{References}.
3275 @item t
3276 Number of articles in the current sub-thread.  Using this spec will slow
3277 down summary buffer generation somewhat.
3278 @item e
3279 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3280 article has any children.
3281 @item P
3282 The line number.
3283 @item O
3284 Download mark.
3285 @item u
3286 User defined specifier.  The next character in the format string should
3287 be a letter.  Gnus will call the function
3288 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3289 following @samp{%u}.  The function will be passed the current header as
3290 argument.  The function should return a string, which will be inserted
3291 into the summary just like information from any other summary specifier.
3292 @end table
3293
3294 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3295 have to be handled with care.  For reasons of efficiency, Gnus will
3296 compute what column these characters will end up in, and ``hard-code''
3297 that.  This means that it is invalid to have these specs after a
3298 variable-length spec.  Well, you might not be arrested, but your summary
3299 buffer will look strange, which is bad enough.
3300
3301 The smart choice is to have these specs as far to the left as possible.
3302 (Isn't that the case with everything, though?  But I digress.)
3303
3304 This restriction may disappear in later versions of Gnus.
3305
3306
3307 @node Summary Buffer Mode Line
3308 @subsection Summary Buffer Mode Line
3309
3310 @vindex gnus-summary-mode-line-format
3311 You can also change the format of the summary mode bar.  Set
3312 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3313 is @samp{Gnus: %%b [%A] %Z}.  
3314
3315 Here are the elements you can play with:
3316
3317 @table @samp
3318 @item G
3319 Group name.
3320 @item p
3321 Unprefixed group name.
3322 @item A
3323 Current article number.
3324 @item V
3325 Gnus version.
3326 @item U
3327 Number of unread articles in this group.
3328 @item e
3329 Number of unread articles in this group that aren't displayed in the
3330 summary buffer.
3331 @item Z
3332 A string with the number of unread and unselected articles represented
3333 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3334 articles, and just as @samp{<%U more>} if there are just unread articles
3335 and no unselected ones.
3336 @item g
3337 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3338 shortened to @samp{r.a.anime}. 
3339 @item S
3340 Subject of the current article.
3341 @item u
3342 User-defined spec (@pxref{User-Defined Specs}).
3343 @item s
3344 Name of the current score file (@pxref{Scoring}).
3345 @item d
3346 Number of dormant articles (@pxref{Unread Articles}).
3347 @item t
3348 Number of ticked articles (@pxref{Unread Articles}).
3349 @item r
3350 Number of articles that have been marked as read in this session. 
3351 @item E
3352 Number of articles expunged by the score files.
3353 @end table
3354
3355
3356 @node Summary Highlighting
3357 @subsection Summary Highlighting
3358
3359 @table @code
3360
3361 @item gnus-visual-mark-article-hook
3362 @vindex gnus-visual-mark-article-hook
3363 This hook is run after selecting an article.  It is meant to be used for
3364 highlighting the article in some way.  It is not run if
3365 @code{gnus-visual} is @code{nil}.
3366
3367 @item gnus-summary-update-hook
3368 @vindex gnus-summary-update-hook
3369 This hook is called when a summary line is changed.  It is not run if
3370 @code{gnus-visual} is @code{nil}.
3371
3372 @item gnus-summary-selected-face
3373 @vindex gnus-summary-selected-face
3374 This is the face (or @dfn{font} as some people call it) used to
3375 highlight the current article in the summary buffer.
3376
3377 @item gnus-summary-highlight
3378 @vindex gnus-summary-highlight
3379 Summary lines are highlighted according to this variable, which is a
3380 list where the elements are of the format @var{(FORM . FACE)}.  If you
3381 would, for instance, like ticked articles to be italic and high-scored
3382 articles to be bold, you could set this variable to something like
3383 @lisp
3384 (((eq mark gnus-ticked-mark) . italic)
3385  ((> score default) . bold))
3386 @end lisp
3387 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3388 @var{FACE} will be applied to the line.
3389 @end table
3390
3391
3392 @node Summary Maneuvering
3393 @section Summary Maneuvering
3394 @cindex summary movement
3395
3396 All the straight movement commands understand the numeric prefix and
3397 behave pretty much as you'd expect. 
3398
3399 None of these commands select articles.
3400
3401 @table @kbd
3402 @item G M-n
3403 @itemx M-n
3404 @kindex M-n (Summary)
3405 @kindex G M-n (Summary)
3406 @findex gnus-summary-next-unread-subject
3407 Go to the next summary line of an unread article
3408 (@code{gnus-summary-next-unread-subject}). 
3409
3410 @item G M-p
3411 @itemx M-p
3412 @kindex M-p (Summary)
3413 @kindex G M-p (Summary)
3414 @findex gnus-summary-prev-unread-subject
3415 Go to the previous summary line of an unread article
3416 (@code{gnus-summary-prev-unread-subject}). 
3417
3418 @item G j
3419 @itemx j
3420 @kindex j (Summary)
3421 @kindex G j (Summary)
3422 @findex gnus-summary-goto-article
3423 Ask for an article number or @code{Message-ID}, and then go to that
3424 article (@code{gnus-summary-goto-article}).
3425
3426 @item G g
3427 @kindex G g (Summary)
3428 @findex gnus-summary-goto-subject
3429 Ask for an article number and then go to the summary line of that article
3430 without displaying the article (@code{gnus-summary-goto-subject}).
3431 @end table
3432
3433 If Gnus asks you to press a key to confirm going to the next group, you
3434 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3435 buffer, searching for the next group to read without actually returning
3436 to the group buffer.
3437
3438 Variables related to summary movement:
3439
3440 @table @code
3441
3442 @vindex gnus-auto-select-next
3443 @item gnus-auto-select-next
3444 If you issue one of the movement commands (like @kbd{n}) and there are
3445 no more unread articles after the current one, Gnus will offer to go to
3446 the next group.  If this variable is @code{t} and the next group is
3447 empty, Gnus will exit summary mode and return to the group buffer.  If
3448 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3449 next group, no matter whether it has any unread articles or not.  As a
3450 special case, if this variable is @code{quietly}, Gnus will select the
3451 next group without asking for confirmation.  If this variable is
3452 @code{almost-quietly}, the same will happen only if you are located on
3453 the last article in the group.  Finally, if this variable is
3454 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3455 without confirmation.  Also @pxref{Group Levels}.
3456
3457 @item gnus-auto-select-same
3458 @vindex gnus-auto-select-same
3459 If non-@code{nil}, all the movement commands will try to go to the next
3460 article with the same subject as the current.  (@dfn{Same} here might
3461 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3462 for details (@pxref{Customizing Threading}).)  This variable is not
3463 particularly useful if you use a threaded display.
3464
3465 @item gnus-summary-check-current
3466 @vindex gnus-summary-check-current
3467 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3468 to the next (or previous) article if the current article is unread.
3469 Instead, they will choose the current article.
3470
3471 @item gnus-auto-center-summary
3472 @vindex gnus-auto-center-summary
3473 If non-@code{nil}, Gnus will keep the point in the summary buffer
3474 centered at all times.  This makes things quite tidy, but if you have a
3475 slow network connection, or simply do not like this un-Emacsism, you can
3476 set this variable to @code{nil} to get the normal Emacs scrolling
3477 action.  This will also inhibit horizontal re-centering of the summary
3478 buffer, which might make it more inconvenient to read extremely long
3479 threads.
3480
3481 @end table
3482
3483
3484 @node Choosing Articles
3485 @section Choosing Articles
3486 @cindex selecting articles
3487
3488 @menu
3489 * Choosing Commands::        Commands for choosing articles.
3490 * Choosing Variables::       Variables that influence these commands.
3491 @end menu
3492
3493
3494 @node Choosing Commands
3495 @subsection Choosing Commands
3496
3497 None of the following movement commands understand the numeric prefix,
3498 and they all select and display an article.
3499
3500 @table @kbd
3501 @item SPACE
3502 @kindex SPACE (Summary)
3503 @findex gnus-summary-next-page
3504 Select the current article, or, if that one's read already, the next
3505 unread article (@code{gnus-summary-next-page}).
3506
3507 @item G n
3508 @itemx n
3509 @kindex n (Summary)
3510 @kindex G n (Summary)
3511 @findex gnus-summary-next-unread-article
3512 @c @icon{gnus-summary-next-unread}
3513 Go to next unread article (@code{gnus-summary-next-unread-article}).
3514
3515 @item G p
3516 @itemx p
3517 @kindex p (Summary)
3518 @findex gnus-summary-prev-unread-article
3519 @c @icon{gnus-summary-prev-unread}
3520 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3521
3522 @item G N
3523 @itemx N
3524 @kindex N (Summary)
3525 @kindex G N (Summary)
3526 @findex gnus-summary-next-article
3527 Go to the next article (@code{gnus-summary-next-article}).
3528
3529 @item G P
3530 @itemx P
3531 @kindex P (Summary)
3532 @kindex G P (Summary)
3533 @findex gnus-summary-prev-article
3534 Go to the previous article (@code{gnus-summary-prev-article}).
3535
3536 @item G C-n
3537 @kindex G C-n (Summary)
3538 @findex gnus-summary-next-same-subject
3539 Go to the next article with the same subject
3540 (@code{gnus-summary-next-same-subject}). 
3541
3542 @item G C-p
3543 @kindex G C-p (Summary)
3544 @findex gnus-summary-prev-same-subject
3545 Go to the previous article with the same subject
3546 (@code{gnus-summary-prev-same-subject}). 
3547
3548 @item G f
3549 @itemx .
3550 @kindex G f  (Summary)
3551 @kindex .  (Summary)
3552 @findex gnus-summary-first-unread-article
3553 Go to the first unread article
3554 (@code{gnus-summary-first-unread-article}).
3555
3556 @item G b
3557 @itemx ,
3558 @kindex G b (Summary)
3559 @kindex , (Summary)
3560 @findex gnus-summary-best-unread-article
3561 Go to the article with the highest score
3562 (@code{gnus-summary-best-unread-article}). 
3563
3564 @item G l
3565 @itemx l
3566 @kindex l (Summary)
3567 @kindex G l (Summary)
3568 @findex gnus-summary-goto-last-article
3569 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3570
3571 @item G o
3572 @kindex G o (Summary)
3573 @findex gnus-summary-pop-article
3574 @cindex history
3575 @cindex article history
3576 Pop an article off the summary history and go to this article
3577 (@code{gnus-summary-pop-article}).  This command differs from the
3578 command above in that you can pop as many previous articles off the
3579 history as you like, while @kbd{l} toggles the two last read articles.
3580 For a somewhat related issue (if you use these commands a lot),
3581 @pxref{Article Backlog}.
3582 @end table
3583
3584
3585 @node Choosing Variables
3586 @subsection Choosing Variables
3587
3588 Some variables relevant for moving and selecting articles:
3589
3590 @table @code
3591 @item gnus-auto-extend-newsgroup
3592 @vindex gnus-auto-extend-newsgroup
3593 All the movement commands will try to go to the previous (or next)
3594 article, even if that article isn't displayed in the Summary buffer if
3595 this variable is non-@code{nil}.  Gnus will then fetch the article from
3596 the server and display it in the article buffer.
3597
3598 @item gnus-select-article-hook
3599 @vindex gnus-select-article-hook
3600 This hook is called whenever an article is selected.  By default it
3601 exposes any threads hidden under the selected article.
3602
3603 @item gnus-mark-article-hook
3604 @vindex gnus-mark-article-hook
3605 @findex gnus-summary-mark-unread-as-read
3606 @findex gnus-summary-mark-read-and-unread-as-read
3607 @findex gnus-unread-mark
3608 This hook is called whenever an article is selected.  It is intended to
3609 be used for marking articles as read.  The default value is
3610 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3611 mark of almost any article you read to @code{gnus-unread-mark}.  The
3612 only articles not affected by this function are ticked, dormant, and
3613 expirable articles.  If you'd instead like to just have unread articles
3614 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3615 instead.  It will leave marks like @code{gnus-low-score-mark},
3616 @code{gnus-del-mark} (and so on) alone.
3617
3618 @end table
3619
3620
3621 @node Paging the Article
3622 @section Scrolling the Article
3623 @cindex article scrolling
3624
3625 @table @kbd
3626
3627 @item SPACE
3628 @kindex SPACE (Summary)
3629 @findex gnus-summary-next-page
3630 Pressing @kbd{SPACE} will scroll the current article forward one page,
3631 or, if you have come to the end of the current article, will choose the
3632 next article (@code{gnus-summary-next-page}).
3633
3634 @item DEL
3635 @kindex DEL (Summary)
3636 @findex gnus-summary-prev-page
3637 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3638
3639 @item RET
3640 @kindex RET (Summary)
3641 @findex gnus-summary-scroll-up
3642 Scroll the current article one line forward
3643 (@code{gnus-summary-scroll-up}).
3644
3645 @item A g
3646 @itemx g
3647 @kindex A g (Summary)
3648 @kindex g (Summary)
3649 @findex gnus-summary-show-article
3650 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3651 given a prefix, fetch the current article, but don't run any of the
3652 article treatment functions.  This will give you a ``raw'' article, just
3653 the way it came from the server.
3654
3655 @item A <
3656 @itemx <
3657 @kindex < (Summary)
3658 @kindex A < (Summary)
3659 @findex gnus-summary-beginning-of-article
3660 Scroll to the beginning of the article
3661 (@code{gnus-summary-beginning-of-article}).
3662
3663 @item A >
3664 @itemx >
3665 @kindex > (Summary)
3666 @kindex A > (Summary)
3667 @findex gnus-summary-end-of-article
3668 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3669
3670 @item A s 
3671 @itemx s
3672 @kindex A s (Summary)
3673 @kindex s (Summary)
3674 @findex gnus-summary-isearch-article
3675 Perform an isearch in the article buffer
3676 (@code{gnus-summary-isearch-article}).
3677
3678 @item h
3679 @kindex h (Summary)
3680 @findex gnus-summary-select-article-buffer
3681 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3682
3683 @end table
3684
3685
3686 @node Reply Followup and Post
3687 @section Reply, Followup and Post
3688
3689 @menu
3690 * Summary Mail Commands::            Sending mail.
3691 * Summary Post Commands::            Sending news.
3692 @end menu
3693
3694
3695 @node Summary Mail Commands
3696 @subsection Summary Mail Commands
3697 @cindex mail
3698 @cindex composing mail
3699
3700 Commands for composing a mail message:
3701
3702 @table @kbd
3703
3704 @item S r
3705 @itemx r
3706 @kindex S r (Summary)
3707 @kindex r (Summary)
3708 @findex gnus-summary-reply
3709 @c @icon{gnus-summary-mail-reply}
3710 @c @icon{gnus-summary-reply}
3711 Mail a reply to the author of the current article
3712 (@code{gnus-summary-reply}). 
3713
3714 @item S R
3715 @itemx R
3716 @kindex R (Summary)
3717 @kindex S R (Summary)
3718 @findex gnus-summary-reply-with-original
3719 @c @icon{gnus-summary-reply-with-original}
3720 Mail a reply to the author of the current article and include the
3721 original message (@code{gnus-summary-reply-with-original}).  This
3722 command uses the process/prefix convention.
3723
3724 @item S w
3725 @kindex S w (Summary)
3726 @findex gnus-summary-wide-reply
3727 Mail a wide reply to the author of the current article
3728 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3729 goes out to all people listed in the @code{To}, @code{From} (or
3730 @code{Reply-to}) and @code{Cc} headers.
3731
3732 @item S W
3733 @kindex S W (Summary)
3734 @findex gnus-summary-wide-reply-with-original
3735 Mail a wide reply to the current article and include the original
3736 message (@code{gnus-summary-reply-with-original}).  This command uses
3737 the process/prefix convention.
3738
3739 @item S o m
3740 @kindex S o m (Summary)
3741 @findex gnus-summary-mail-forward
3742 @c @icon{gnus-summary-mail-forward}
3743 Forward the current article to some other person
3744 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3745 headers of the forwarded article.
3746
3747 @item S m
3748 @itemx m
3749 @kindex m (Summary)
3750 @kindex S m (Summary)
3751 @findex gnus-summary-mail-other-window
3752 @c @icon{gnus-summary-mail-originate}
3753 Send a mail to some other person
3754 (@code{gnus-summary-mail-other-window}).
3755
3756 @item S D b
3757 @kindex S D b (Summary)
3758 @findex gnus-summary-resend-bounced-mail
3759 @cindex bouncing mail
3760 If you have sent a mail, but the mail was bounced back to you for some
3761 reason (wrong address, transient failure), you can use this command to
3762 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3763 will be popped into a mail buffer where you can edit the headers before
3764 sending the mail off again.  If you give a prefix to this command, and
3765 the bounced mail is a reply to some other mail, Gnus will try to fetch
3766 that mail and display it for easy perusal of its headers.  This might
3767 very well fail, though.
3768
3769 @item S D r
3770 @kindex S D r (Summary)
3771 @findex gnus-summary-resend-message
3772 Not to be confused with the previous command,
3773 @code{gnus-summary-resend-message} will prompt you for an address to
3774 send the current message off to, and then send it to that place.  The
3775 headers of the message won't be altered---but lots of headers that say
3776 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3777 means that you actually send a mail to someone that has a @code{To}
3778 header that (probably) points to yourself.  This will confuse people.
3779 So, natcherly you'll only do that if you're really eVIl.  
3780
3781 This command is mainly used if you have several accounts and want to
3782 ship a mail to a different account of yours.  (If you're both
3783 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3784 to the @code{root} account, you may want to resend it to
3785 @code{postmaster}.  Ordnung muß sein!
3786
3787 This command understands the process/prefix convention
3788 (@pxref{Process/Prefix}). 
3789
3790 @item S O m
3791 @kindex S O m (Summary)
3792 @findex gnus-uu-digest-mail-forward
3793 Digest the current series (@pxref{Decoding Articles}) and forward the
3794 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
3795 uses the process/prefix convention (@pxref{Process/Prefix}).
3796
3797 @item S M-c
3798 @kindex S M-c (Summary)
3799 @findex gnus-summary-mail-crosspost-complaint
3800 @cindex crossposting
3801 @cindex excessive crossposting
3802 Send a complaint about excessive crossposting to the author of the
3803 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3804
3805 @findex gnus-crosspost-complaint
3806 This command is provided as a way to fight back agains the current
3807 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3808 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3809 command understands the process/prefix convention
3810 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3811
3812 @end table
3813
3814
3815 @node Summary Post Commands
3816 @subsection Summary Post Commands
3817 @cindex post
3818 @cindex composing news
3819
3820 Commands for posting a news article:
3821
3822 @table @kbd
3823 @item S p
3824 @itemx a
3825 @kindex a (Summary)
3826 @kindex S p (Summary)
3827 @findex gnus-summary-post-news
3828 @c @icon{gnus-summary-post-news}
3829 Post an article to the current group
3830 (@code{gnus-summary-post-news}).
3831
3832 @item S f
3833 @itemx f
3834 @kindex f (Summary)
3835 @kindex S f (Summary)
3836 @findex gnus-summary-followup
3837 @c @icon{gnus-summary-followup}
3838 Post a followup to the current article (@code{gnus-summary-followup}).
3839
3840 @item S F
3841 @itemx F
3842 @kindex S F (Summary)
3843 @kindex F (Summary)
3844 @c @icon{gnus-summary-followup-with-original}
3845 @findex gnus-summary-followup-with-original
3846 Post a followup to the current article and include the original message
3847 (@code{gnus-summary-followup-with-original}).   This command uses the
3848 process/prefix convention.
3849
3850 @item S n
3851 @kindex S n (Summary)
3852 @findex gnus-summary-followup-to-mail
3853 Post a followup to the current article via news, even if you got the
3854 message through mail (@code{gnus-summary-followup-to-mail}).
3855
3856 @item S n
3857 @kindex S n (Summary)
3858 @findex gnus-summary-followup-to-mail
3859 Post a followup to the current article via news, even if you got the
3860 message through mail and include the original message
3861 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3862 the process/prefix convention.
3863
3864 @item S o p
3865 @kindex S o p (Summary)
3866 @findex gnus-summary-post-forward
3867 Forward the current article to a newsgroup
3868 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3869 headers of the forwarded article.
3870
3871 @item S O p
3872 @kindex S O p (Summary)
3873 @findex gnus-uu-digest-post-forward
3874 @cindex digests
3875 @cindex making digests
3876 Digest the current series and forward the result to a newsgroup
3877 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3878 process/prefix convention.
3879
3880 @item S u
3881 @kindex S u (Summary)
3882 @findex gnus-uu-post-news
3883 @c @icon{gnus-uu-post-news}
3884 Uuencode a file, split it into parts, and post it as a series
3885 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3886 @end table
3887
3888
3889 @node Canceling and Superseding
3890 @section Canceling Articles
3891 @cindex canceling articles
3892 @cindex superseding articles
3893
3894 Have you ever written something, and then decided that you really,
3895 really, really wish you hadn't posted that?
3896
3897 Well, you can't cancel mail, but you can cancel posts.
3898
3899 @findex gnus-summary-cancel-article
3900 @kindex C (Summary)
3901 @c @icon{gnus-summary-cancel-article}
3902 Find the article you wish to cancel (you can only cancel your own
3903 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3904 c} (@code{gnus-summary-cancel-article}).  Your article will be
3905 canceled---machines all over the world will be deleting your article.
3906 This command uses the process/prefix convention (@pxref{Process/Prefix}).
3907
3908 Be aware, however, that not all sites honor cancels, so your article may
3909 live on here and there, while most sites will delete the article in
3910 question.
3911
3912 Gnus will use the ``current'' select method when cancelling.  If you
3913 want to use the standard posting method, use the @samp{a} symbolic
3914 prefix (@pxref{Symbolic Prefixes}).
3915
3916 If you discover that you have made some mistakes and want to do some
3917 corrections, you can post a @dfn{superseding} article that will replace
3918 your original article.
3919
3920 @findex gnus-summary-supersede-article
3921 @kindex S (Summary)
3922 Go to the original article and press @kbd{S s}
3923 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3924 where you can edit the article all you want before sending it off the
3925 usual way.
3926
3927 The same goes for superseding as for canceling, only more so: Some
3928 sites do not honor superseding.  On those sites, it will appear that you
3929 have posted almost the same article twice.
3930
3931 If you have just posted the article, and change your mind right away,
3932 there is a trick you can use to cancel/supersede the article without
3933 waiting for the article to appear on your site first.  You simply return
3934 to the post buffer (which is called @code{*sent ...*}).  There you will
3935 find the article you just posted, with all the headers intact.  Change
3936 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3937 header by substituting one of those words for the word
3938 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3939 you would do normally.  The previous article will be
3940 canceled/superseded.
3941
3942 Just remember, kids: There is no 'c' in 'supersede'.
3943
3944
3945 @node Marking Articles
3946 @section Marking Articles
3947 @cindex article marking
3948 @cindex article ticking
3949 @cindex marks
3950
3951 There are several marks you can set on an article. 
3952
3953 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3954 neologism ohoy!) of the article.  Alphabetic marks generally mean
3955 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3956
3957 In addition, you also have marks that do not affect readedness.
3958
3959 @menu
3960 * Unread Articles::      Marks for unread articles.
3961 * Read Articles::        Marks for read articles.
3962 * Other Marks::          Marks that do not affect readedness.
3963 @end menu
3964
3965 @ifinfo
3966 There's a plethora of commands for manipulating these marks:
3967 @end ifinfo
3968
3969 @menu
3970 * Setting Marks::           How to set and remove marks.
3971 * Setting Process Marks::   How to mark articles for later processing.
3972 @end menu
3973
3974
3975 @node Unread Articles
3976 @subsection Unread Articles
3977
3978 The following marks mark articles as (kinda) unread, in one form or
3979 other.
3980
3981 @table @samp
3982 @item !
3983 @vindex gnus-ticked-mark
3984 Marked as ticked (@code{gnus-ticked-mark}).
3985
3986 @dfn{Ticked articles} are articles that will remain visible always.  If
3987 you see an article that you find interesting, or you want to put off
3988 reading it, or replying to it, until sometime later, you'd typically
3989 tick it.  However, articles can be expired, so if you want to keep an
3990 article forever, you'll have to make it persistent (@pxref{Persistent
3991 Articles}).  
3992
3993 @item ?
3994 @vindex gnus-dormant-mark
3995 Marked as dormant (@code{gnus-dormant-mark}).  
3996
3997 @dfn{Dormant articles} will only appear in the summary buffer if there
3998 are followups to it.  If you want to see them even if they don't have
3999 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4000
4001 @item SPACE
4002 @vindex gnus-unread-mark
4003 Markes as unread (@code{gnus-unread-mark}).
4004
4005 @dfn{Unread articles} are articles that haven't been read at all yet.
4006 @end table
4007
4008
4009 @node Read Articles
4010 @subsection Read Articles
4011 @cindex expirable mark
4012
4013 All the following marks mark articles as read.
4014
4015 @table @samp
4016
4017 @item r
4018 @vindex gnus-del-mark
4019 These are articles that the user has marked as read with the @kbd{d}
4020 command manually, more or less (@code{gnus-del-mark}).
4021
4022 @item R
4023 @vindex gnus-read-mark
4024 Articles that have actually been read (@code{gnus-read-mark}).
4025
4026 @item O
4027 @vindex gnus-ancient-mark
4028 Articles that were marked as read in previous sessions and are now
4029 @dfn{old} (@code{gnus-ancient-mark}).
4030
4031 @item K
4032 @vindex gnus-killed-mark
4033 Marked as killed (@code{gnus-killed-mark}).
4034
4035 @item X
4036 @vindex gnus-kill-file-mark
4037 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4038
4039 @item Y
4040 @vindex gnus-low-score-mark
4041 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4042
4043 @item C
4044 @vindex gnus-catchup-mark
4045 Marked as read by a catchup (@code{gnus-catchup-mark}).
4046
4047 @item G
4048 @vindex gnus-canceled-mark
4049 Canceled article (@code{gnus-canceled-mark})
4050
4051 @item F
4052 @vindex gnus-souped-mark
4053 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4054
4055 @item Q
4056 @vindex gnus-sparse-mark
4057 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4058 Threading}.
4059
4060 @item M
4061 @vindex gnus-duplicate-mark
4062 Article marked as read by duplicate suppression
4063 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4064
4065 @end table
4066
4067 All these marks just mean that the article is marked as read, really.
4068 They are interpreted differently when doing adaptive scoring, though.
4069
4070 One more special mark, though:
4071
4072 @table @samp
4073 @item E
4074 @vindex gnus-expirable-mark
4075 Marked as expirable (@code{gnus-expirable-mark}).
4076
4077 Marking articles as @dfn{expirable} (or have them marked as such
4078 automatically) doesn't make much sense in normal groups---a user doesn't
4079 control expiring of news articles, but in mail groups, for instance,
4080 articles marked as @dfn{expirable} can be deleted by Gnus at
4081 any time.
4082 @end table
4083
4084
4085 @node Other Marks
4086 @subsection Other Marks
4087 @cindex process mark
4088 @cindex bookmarks
4089
4090 There are some marks that have nothing to do with whether the article is
4091 read or not.
4092
4093 @itemize @bullet
4094
4095 @item 
4096 You can set a bookmark in the current article.  Say you are reading a
4097 long thesis on cats' urinary tracts, and have to go home for dinner
4098 before you've finished reading the thesis.  You can then set a bookmark
4099 in the article, and Gnus will jump to this bookmark the next time it
4100 encounters the article.  @xref{Setting Marks}
4101
4102 @item
4103 @vindex gnus-replied-mark
4104 All articles that you have replied to or made a followup to (i.e., have
4105 answered) will be marked with an @samp{A} in the second column
4106 (@code{gnus-replied-mark}).
4107
4108 @item 
4109 @vindex gnus-cached-mark
4110 Articles stored in the article cache will be marked with an @samp{*} in
4111 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}
4112
4113 @item 
4114 @vindex gnus-saved-mark
4115 Articles ``saved'' (in some manner or other; not necessarily
4116 religiously) are marked with an @samp{S} in the second column
4117 (@code{gnus-saved-mark}).
4118
4119 @item 
4120 @vindex gnus-not-empty-thread-mark
4121 @vindex gnus-empty-thread-mark
4122 If the @samp{%e} spec is used, the presence of threads or not will be
4123 marked with @code{gnus-not-empty-thread-mark} and
4124 @code{gnus-empty-thread-mark} in the third column, respectively.
4125
4126 @item 
4127 @vindex gnus-process-mark
4128 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4129 variety of commands react to the presence of the process mark.  For
4130 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4131 all articles that have been marked with the process mark.  Articles
4132 marked with the process mark have a @samp{#} in the second column.
4133
4134 @end itemize
4135
4136 You might have noticed that most of these ``non-readedness'' marks
4137 appear in the second column by default.  So if you have a cached, saved,
4138 replied article that you have process-marked, what will that look like?
4139
4140 Nothing much.  The precedence rules go as follows: process -> cache ->
4141 replied -> saved.  So if the article is in the cache and is replied,
4142 you'll only see the cache mark and not the replied mark.
4143
4144
4145 @node Setting Marks
4146 @subsection Setting Marks
4147 @cindex setting marks
4148
4149 All the marking commands understand the numeric prefix.
4150
4151 @table @kbd
4152 @item M c
4153 @itemx M-u
4154 @kindex M c (Summary)
4155 @kindex M-u (Summary)
4156 @findex gnus-summary-clear-mark-forward
4157 @cindex mark as unread
4158 Clear all readedness-marks from the current article
4159 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4160 article as unread.
4161
4162 @item M t
4163 @itemx !
4164 @kindex ! (Summary)
4165 @kindex M t (Summary)
4166 @findex gnus-summary-tick-article-forward
4167 Tick the current article (@code{gnus-summary-tick-article-forward}).
4168 @xref{Article Caching} 
4169
4170 @item M ?
4171 @itemx ?
4172 @kindex ? (Summary)
4173 @kindex M ? (Summary)
4174 @findex gnus-summary-mark-as-dormant
4175 Mark the current article as dormant
4176 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching} 
4177
4178 @item M d
4179 @itemx d
4180 @kindex M d (Summary)
4181 @kindex d (Summary)
4182 @findex gnus-summary-mark-as-read-forward
4183 Mark the current article as read
4184 (@code{gnus-summary-mark-as-read-forward}).
4185
4186 @item D
4187 @kindex D (Summary)
4188 @findex gnus-summary-mark-as-read-backward
4189 Mark the current article as read and move point to the previous line
4190 (@code{gnus-summary-mark-as-read-backward}).
4191
4192 @item M k
4193 @itemx k
4194 @kindex k (Summary)
4195 @kindex M k (Summary)
4196 @findex gnus-summary-kill-same-subject-and-select
4197 Mark all articles that have the same subject as the current one as read,
4198 and then select the next unread article
4199 (@code{gnus-summary-kill-same-subject-and-select}).
4200
4201 @item M K
4202 @itemx C-k
4203 @kindex M K (Summary)
4204 @kindex C-k (Summary)
4205 @findex gnus-summary-kill-same-subject
4206 Mark all articles that have the same subject as the current one as read
4207 (@code{gnus-summary-kill-same-subject}).  
4208
4209 @item M C
4210 @kindex M C (Summary)
4211 @findex gnus-summary-catchup
4212 @c @icon{gnus-summary-catchup}
4213 Mark all unread articles as read (@code{gnus-summary-catchup}).
4214
4215 @item M C-c
4216 @kindex M C-c (Summary)
4217 @findex gnus-summary-catchup-all
4218 Mark all articles in the group as read---even the ticked and dormant
4219 articles (@code{gnus-summary-catchup-all}).
4220
4221 @item M H
4222 @kindex M H (Summary)
4223 @findex gnus-summary-catchup-to-here
4224 Catchup the current group to point
4225 (@code{gnus-summary-catchup-to-here}). 
4226
4227 @item C-w
4228 @kindex C-w (Summary)
4229 @findex gnus-summary-mark-region-as-read
4230 Mark all articles between point and mark as read
4231 (@code{gnus-summary-mark-region-as-read}). 
4232
4233 @item M V k
4234 @kindex M V k (Summary)
4235 @findex gnus-summary-kill-below
4236 Kill all articles with scores below the default score (or below the
4237 numeric prefix) (@code{gnus-summary-kill-below}).
4238
4239 @item M e
4240 @itemx E
4241 @kindex M e (Summary)
4242 @kindex E (Summary)
4243 @findex gnus-summary-mark-as-expirable
4244 Mark the current article as expirable
4245 (@code{gnus-summary-mark-as-expirable}).
4246
4247 @item M b
4248 @kindex M b (Summary)
4249 @findex gnus-summary-set-bookmark
4250 Set a bookmark in the current article
4251 (@code{gnus-summary-set-bookmark}).
4252
4253 @item M B
4254 @kindex M B (Summary)
4255 @findex gnus-summary-remove-bookmark
4256 Remove the bookmark from the current article
4257 (@code{gnus-summary-remove-bookmark}).
4258
4259 @item M V c
4260 @kindex M V c (Summary)
4261 @findex gnus-summary-clear-above
4262 Clear all marks from articles with scores over the default score (or
4263 over the numeric prefix) (@code{gnus-summary-clear-above}).
4264
4265 @item M V u
4266 @kindex M V u (Summary)
4267 @findex gnus-summary-tick-above
4268 Tick all articles with scores over the default score (or over the
4269 numeric prefix) (@code{gnus-summary-tick-above}).
4270
4271 @item M V m
4272 @kindex M V m (Summary)
4273 @findex gnus-summary-mark-above
4274 Prompt for a mark, and mark all articles with scores over the default
4275 score (or over the numeric prefix) with this mark
4276 (@code{gnus-summary-clear-above}).
4277 @end table
4278
4279 @vindex gnus-summary-goto-unread
4280 The @code{gnus-summary-goto-unread} variable controls what action should
4281 be taken after setting a mark.  If non-@code{nil}, point will move to
4282 the next/previous unread article.  If @code{nil}, point will just move
4283 one line up or down.  As a special case, if this variable is
4284 @code{never}, all the marking commands as well as other commands (like
4285 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4286 The default is @code{t}.
4287
4288
4289 @node Setting Process Marks
4290 @subsection Setting Process Marks
4291 @cindex setting process marks
4292
4293 @table @kbd
4294
4295 @item M P p
4296 @itemx #
4297 @kindex # (Summary)
4298 @kindex M P p (Summary)
4299 @findex gnus-summary-mark-as-processable
4300 Mark the current article with the process mark
4301 (@code{gnus-summary-mark-as-processable}). 
4302 @findex gnus-summary-unmark-as-processable
4303
4304 @item M P u 
4305 @itemx M-#
4306 @kindex M P u (Summary)
4307 @kindex M-# (Summary)
4308 Remove the process mark, if any, from the current article
4309 (@code{gnus-summary-unmark-as-processable}).
4310
4311 @item M P U
4312 @kindex M P U (Summary)
4313 @findex gnus-summary-unmark-all-processable
4314 Remove the process mark from all articles
4315 (@code{gnus-summary-unmark-all-processable}). 
4316
4317 @item M P i
4318 @kindex M P i (Summary)
4319 @findex gnus-uu-invert-processable
4320 Invert the list of process marked articles
4321 (@code{gnus-uu-invert-processable}). 
4322
4323 @item M P R
4324 @kindex M P R (Summary)
4325 @findex gnus-uu-mark-by-regexp
4326 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4327
4328 @item M P r
4329 @kindex M P r (Summary)
4330 @findex gnus-uu-mark-region
4331 Mark articles in region (@code{gnus-uu-mark-region}).
4332
4333 @item M P t
4334 @kindex M P t (Summary)
4335 @findex gnus-uu-mark-thread
4336 Mark all articles in the current (sub)thread
4337 (@code{gnus-uu-mark-thread}).
4338
4339 @item M P T
4340 @kindex M P T (Summary)
4341 @findex gnus-uu-unmark-thread
4342 Unmark all articles in the current (sub)thread
4343 (@code{gnus-uu-unmark-thread}).
4344
4345 @item M P v
4346 @kindex M P v (Summary)
4347 @findex gnus-uu-mark-over
4348 Mark all articles that have a score above the prefix argument
4349 (@code{gnus-uu-mark-over}).
4350
4351 @item M P s
4352 @kindex M P s (Summary)
4353 @findex gnus-uu-mark-series
4354 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4355
4356 @item M P S
4357 @kindex M P S (Summary)
4358 @findex gnus-uu-mark-sparse
4359 Mark all series that have already had some articles marked
4360 (@code{gnus-uu-mark-sparse}).
4361
4362 @item M P a
4363 @kindex M P a (Summary)
4364 @findex gnus-uu-mark-all
4365 Mark all articles in series order (@code{gnus-uu-mark-series}).
4366
4367 @item M P b
4368 @kindex M P b (Summary)
4369 @findex gnus-uu-mark-buffer
4370 Mark all articles in the buffer in the order they appear
4371 (@code{gnus-uu-mark-buffer}). 
4372
4373 @item M P k
4374 @kindex M P k (Summary)
4375 @findex gnus-summary-kill-process-mark
4376 Push the current process mark set onto the stack and unmark all articles
4377 (@code{gnus-summary-kill-process-mark}).
4378
4379 @item M P y
4380 @kindex M P y (Summary)
4381 @findex gnus-summary-yank-process-mark
4382 Pop the previous process mark set from the stack and restore it
4383 (@code{gnus-summary-yank-process-mark}).
4384
4385 @item M P w
4386 @kindex M P w (Summary)
4387 @findex gnus-summary-save-process-mark
4388 Push the current process mark set onto the stack
4389 (@code{gnus-summary-save-process-mark}).
4390
4391 @end table
4392
4393
4394 @node Limiting
4395 @section Limiting
4396 @cindex limiting
4397
4398 It can be convenient to limit the summary buffer to just show some
4399 subset of the articles currently in the group.  The effect most limit
4400 commands have is to remove a few (or many) articles from the summary
4401 buffer. 
4402
4403 All limiting commands work on subsets of the articles already fetched
4404 from the servers.  None of these commands query the server for
4405 additional articles.
4406
4407 @table @kbd
4408
4409 @item / /
4410 @itemx / s
4411 @kindex / / (Summary)
4412 @findex gnus-summary-limit-to-subject
4413 Limit the summary buffer to articles that match some subject
4414 (@code{gnus-summary-limit-to-subject}). 
4415
4416 @item / a
4417 @kindex / a (Summary)
4418 @findex gnus-summary-limit-to-author
4419 Limit the summary buffer to articles that match some author
4420 (@code{gnus-summary-limit-to-author}).
4421
4422 @item / u
4423 @itemx x
4424 @kindex / u (Summary)
4425 @kindex x (Summary)
4426 @findex gnus-summary-limit-to-unread
4427 Limit the summary buffer to articles not marked as read
4428 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4429 buffer to articles strictly unread.  This means that ticked and
4430 dormant articles will also be excluded.
4431
4432 @item / m
4433 @kindex / m (Summary)
4434 @findex gnus-summary-limit-to-marks
4435 Ask for a mark and then limit to all articles that have not been marked
4436 with that mark (@code{gnus-summary-limit-to-marks}).
4437
4438 @item / t
4439 @kindex / t (Summary)
4440 @findex gnus-summary-limit-to-age
4441 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4442 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4443 articles younger than that number of days.
4444
4445 @item / n
4446 @kindex / n (Summary)
4447 @findex gnus-summary-limit-to-articles
4448 Limit the summary buffer to the current article
4449 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4450 convention (@pxref{Process/Prefix}).
4451
4452 @item / w
4453 @kindex / w (Summary)
4454 @findex gnus-summary-pop-limit
4455 Pop the previous limit off the stack and restore it
4456 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4457 the stack.
4458
4459 @item / v
4460 @kindex / v (Summary)
4461 @findex gnus-summary-limit-to-score
4462 Limit the summary buffer to articles that have a score at or above some
4463 score (@code{gnus-summary-limit-to-score}).
4464
4465 @item / E
4466 @itemx M S
4467 @kindex M S (Summary)
4468 @kindex / E (Summary)
4469 @findex gnus-summary-limit-include-expunged
4470 Display all expunged articles
4471 (@code{gnus-summary-limit-include-expunged}). 
4472
4473 @item / D
4474 @kindex / D (Summary)
4475 @findex gnus-summary-limit-include-dormant
4476 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4477
4478 @item / d
4479 @kindex / d (Summary)
4480 @findex gnus-summary-limit-exclude-dormant
4481 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4482
4483 @item / T
4484 @kindex / T (Summary)
4485 @findex gnus-summary-limit-include-thread
4486 Include all the articles in the current thread.
4487
4488 @item / c
4489 @kindex / c (Summary)
4490 @findex gnus-summary-limit-exclude-childless-dormant
4491 Hide all dormant articles that have no children
4492 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4493
4494 @item / C
4495 @kindex / C (Summary)
4496 @findex gnus-summary-limit-mark-excluded-as-read
4497 Mark all excluded unread articles as read
4498 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4499 also mark excluded ticked and dormant articles as read.
4500
4501 @end table
4502
4503
4504 @node Threading
4505 @section Threading
4506 @cindex threading
4507 @cindex article threading
4508
4509 Gnus threads articles by default.  @dfn{To thread} is to put responses
4510 to articles directly after the articles they respond to---in a
4511 hierarchical fashion.
4512
4513 Threading is done by looking at the @code{References} headers of the
4514 articles.  In a perfect world, this would be enough to build pretty
4515 trees, but unfortunately, the @code{References} header is often broken
4516 or simply missing.  Weird news propagration excarcerbates the problem,
4517 so one has to employ other heuristics to get pleasing results.  A
4518 plethora of approaches exists, as detailed in horrible detail in
4519 @pxref{Customizing Threading}. 
4520
4521 First, a quick overview of the concepts:
4522
4523 @table @dfn
4524 @item root
4525 The top-most article in a thread; the first article in the thread.
4526
4527 @item thread
4528 A tree-like article structure.
4529
4530 @item sub-thread
4531 A small(er) section of this tree-like structure.
4532
4533 @item loose threads
4534 Threads often lose their roots due to article expiry, or due to the root
4535 already having been read in a previous session, and not displayed in the
4536 summary buffer.  We then typicall have many sub-threads that really
4537 belong to one thread, but are without connecting roots.  These are
4538 called loose threads.
4539
4540 @item thread gathering
4541 An attempt to gather loose threads into bigger threads.
4542
4543 @item sparse threads
4544 A thread where the missing articles have been ``guessed'' at, and are
4545 displayed as empty lines in the summary buffer.
4546
4547 @end table
4548
4549
4550 @menu
4551 * Customizing Threading::     Variables you can change to affect the threading.
4552 * Thread Commands::           Thread based commands in the summary buffer.
4553 @end menu
4554
4555
4556 @node Customizing Threading
4557 @subsection Customizing Threading
4558 @cindex customizing threading
4559
4560 @menu
4561 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
4562 * Filling In Threads::   Making the threads displayed look fuller.
4563 * More Threading::       Even more variables for fiddling with threads.
4564 * Low-Level Threading::  You thought it was over... but you were wrong!
4565 @end menu
4566
4567
4568 @node Loose Threads
4569 @subsubsection Loose Threads
4570 @cindex <
4571 @cindex >
4572 @cindex loose threads
4573
4574 @table @code
4575 @item gnus-summary-make-false-root
4576 @vindex gnus-summary-make-false-root
4577 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4578 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4579 Yup.)  Loose subtrees occur when the real root has expired, or you've
4580 read or killed the root in a previous session.
4581
4582 When there is no real root of a thread, Gnus will have to fudge
4583 something.  This variable says what fudging method Gnus should use.
4584 There are four possible values:
4585
4586 @iftex
4587 @iflatex
4588 \gnusfigure{The Summary Buffer}{390}{
4589 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4590 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4591 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4592 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4593 }
4594 @end iflatex
4595 @end iftex
4596
4597 @cindex adopting articles
4598
4599 @table @code
4600
4601 @item adopt
4602 Gnus will make the first of the orphaned articles the parent.  This
4603 parent will adopt all the other articles.  The adopted articles will be
4604 marked as such by pointy brackets (@samp{<>}) instead of the standard
4605 square brackets (@samp{[]}).  This is the default method.
4606
4607 @item dummy
4608 @vindex gnus-summary-dummy-line-format
4609 Gnus will create a dummy summary line that will pretend to be the
4610 parent.  This dummy line does not correspond to any real article, so
4611 selecting it will just select the first real article after the dummy
4612 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4613 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4614 which is the subject of the article.  @xref{Formatting Variables}.
4615
4616 @item empty
4617 Gnus won't actually make any article the parent, but simply leave the
4618 subject field of all orphans except the first empty.  (Actually, it will
4619 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4620 Buffer Format}).)
4621
4622 @item none
4623 Don't make any article parent at all.  Just gather the threads and
4624 display them after one another.
4625
4626 @item nil
4627 Don't gather loose threads.
4628 @end table
4629
4630 @item gnus-summary-gather-subject-limit
4631 @vindex gnus-summary-gather-subject-limit
4632 Loose threads are gathered by comparing subjects of articles.  If this
4633 variable is @code{nil}, Gnus requires an exact match between the
4634 subjects of the loose threads before gathering them into one big
4635 super-thread.  This might be too strict a requirement, what with the
4636 presence of stupid newsreaders that chop off long subject lines.  If
4637 you think so, set this variable to, say, 20 to require that only the
4638 first 20 characters of the subjects have to match.  If you set this
4639 variable to a really low number, you'll find that Gnus will gather
4640 everything in sight into one thread, which isn't very helpful.
4641
4642 @cindex fuzzy article gathering
4643 If you set this variable to the special value @code{fuzzy}, Gnus will
4644 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4645 Matching}). 
4646
4647 @item gnus-simplify-subject-fuzzy-regexp
4648 @vindex gnus-simplify-subject-fuzzy-regexp
4649 This can either be a regular expression or list of regular expressions
4650 that match strings that will be removed from subjects if fuzzy subject
4651 simplification is used.
4652
4653 @item gnus-simplify-ignored-prefixes
4654 @vindex gnus-simplify-ignored-prefixes
4655 If you set @code{gnus-summary-gather-subject-limit} to something as low
4656 as 10, you might consider setting this variable to something sensible:
4657
4658 @c Written by Michael Ernst <mernst@cs.rice.edu>
4659 @lisp
4660 (setq gnus-simplify-ignored-prefixes
4661       (concat 
4662        "\\`\\[?\\("
4663        (mapconcat 
4664         'identity
4665         '("looking"
4666           "wanted" "followup" "summary\\( of\\)?"
4667           "help" "query" "problem" "question" 
4668           "answer" "reference" "announce"
4669           "How can I" "How to" "Comparison of"
4670           ;; ...
4671           )
4672         "\\|")
4673        "\\)\\s *\\("
4674        (mapconcat 'identity
4675                   '("for" "for reference" "with" "about")
4676                   "\\|")
4677        "\\)?\\]?:?[ \t]*"))
4678 @end lisp
4679
4680 All words that match this regexp will be removed before comparing two
4681 subjects. 
4682
4683 @item gnus-simplify-subject-functions
4684 @vindex gnus-simplify-subject-functions
4685 If non-@code{nil}, this variable overrides
4686 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4687 list of functions to apply to the @code{Subject} string iteratively to
4688 arrive at the simplified version of the string.
4689
4690 Useful functions to put in this list include:
4691
4692 @table @code
4693 @item gnus-simplify-subject-re
4694 @findex gnus-simplify-subject-re
4695 Strip the leading @samp{Re:}.
4696
4697 @item gnus-simplify-subject-fuzzy
4698 @findex gnus-simplify-subject-fuzzy
4699 Simplify fuzzily.
4700
4701 @item gnus-simplify-whitespace
4702 @findex gnus-simplify-whitespace
4703 Remove excessive whitespace.
4704 @end table
4705
4706 You may also write your own functions, of course.
4707
4708
4709 @item gnus-summary-gather-exclude-subject
4710 @vindex gnus-summary-gather-exclude-subject
4711 Since loose thread gathering is done on subjects only, that might lead
4712 to many false hits, especially with certain common subjects like
4713 @samp{} and @samp{(none)}.  To make the situation slightly better,
4714 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4715 what subjects should be excluded from the gathering process.@*
4716 The default is @samp{^ *$\\|^(none)$}.  
4717
4718 @item gnus-summary-thread-gathering-function
4719 @vindex gnus-summary-thread-gathering-function
4720 Gnus gathers threads by looking at @code{Subject} headers.  This means
4721 that totally unrelated articles may end up in the same ``thread'', which
4722 is confusing.  An alternate approach is to look at all the
4723 @code{Message-ID}s in all the @code{References} headers to find matches.
4724 This will ensure that no gathered threads ever include unrelated
4725 articles, but it also means that people who have posted with broken
4726 newsreaders won't be gathered properly.  The choice is yours---plague or
4727 cholera:
4728
4729 @table @code
4730 @item gnus-gather-threads-by-subject
4731 @findex gnus-gather-threads-by-subject
4732 This function is the default gathering function and looks at
4733 @code{Subject}s exclusively.
4734
4735 @item gnus-gather-threads-by-references
4736 @findex gnus-gather-threads-by-references
4737 This function looks at @code{References} headers exclusively.
4738 @end table
4739
4740 If you want to test gathering by @code{References}, you could say
4741 something like:
4742
4743 @lisp
4744 (setq gnus-summary-thread-gathering-function
4745       'gnus-gather-threads-by-references)
4746 @end lisp
4747
4748 @end table
4749
4750
4751 @node Filling In Threads
4752 @subsubsection Filling In Threads
4753
4754 @table @code
4755 @item gnus-fetch-old-headers
4756 @vindex gnus-fetch-old-headers
4757 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4758 more old headers---headers to articles marked as read.  If you
4759 would like to display as few summary lines as possible, but still
4760 connect as many loose threads as possible, you should set this variable
4761 to @code{some} or a number.  If you set it to a number, no more than
4762 that number of extra old headers will be fetched.  In either case,
4763 fetching old headers only works if the backend you are using carries
4764 overview files---this would normally be @code{nntp}, @code{nnspool} and
4765 @code{nnml}.  Also remember that if the root of the thread has been
4766 expired by the server, there's not much Gnus can do about that.
4767
4768 This variable can also be set to @code{invisible}.  This won't have any
4769 visible effects, but is useful if you use the @kbd{A T} command a lot
4770 (@pxref{Finding the Parent}). 
4771
4772 @item gnus-build-sparse-threads
4773 @vindex gnus-build-sparse-threads
4774 Fetching old headers can be slow.  A low-rent similar effect can be
4775 gotten by setting this variable to @code{some}.  Gnus will then look at
4776 the complete @code{References} headers of all articles and try to string
4777 together articles that belong in the same thread.  This will leave
4778 @dfn{gaps} in the threading display where Gnus guesses that an article
4779 is missing from the thread.  (These gaps appear like normal summary
4780 lines.  If you select a gap, Gnus will try to fetch the article in
4781 question.)  If this variable is @code{t}, Gnus will display all these
4782 ``gaps'' without regard for whether they are useful for completing the
4783 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4784 off sparse leaf nodes that don't lead anywhere.  This variable is
4785 @code{nil} by default.
4786
4787 @end table
4788
4789
4790 @node More Threading
4791 @subsubsection More Threading
4792
4793 @table @code
4794 @item gnus-show-threads
4795 @vindex gnus-show-threads
4796 If this variable is @code{nil}, no threading will be done, and all of
4797 the rest of the variables here will have no effect.  Turning threading
4798 off will speed group selection up a bit, but it is sure to make reading
4799 slower and more awkward.
4800
4801 @item gnus-thread-hide-subtree
4802 @vindex gnus-thread-hide-subtree
4803 If non-@code{nil}, all threads will be hidden when the summary buffer is
4804 generated.
4805
4806 @item gnus-thread-expunge-below
4807 @vindex gnus-thread-expunge-below
4808 All threads that have a total score (as defined by
4809 @code{gnus-thread-score-function}) less than this number will be
4810 expunged.  This variable is @code{nil} by default, which means that no
4811 threads are expunged.
4812
4813 @item gnus-thread-hide-killed
4814 @vindex gnus-thread-hide-killed
4815 if you kill a thread and this variable is non-@code{nil}, the subtree
4816 will be hidden.
4817
4818 @item gnus-thread-ignore-subject
4819 @vindex gnus-thread-ignore-subject
4820 Sometimes somebody changes the subject in the middle of a thread.  If
4821 this variable is non-@code{nil}, the subject change is ignored.  If it
4822 is @code{nil}, which is the default, a change in the subject will result
4823 in a new thread.
4824
4825 @item gnus-thread-indent-level
4826 @vindex gnus-thread-indent-level
4827 This is a number that says how much each sub-thread should be indented.
4828 The default is 4.
4829
4830 @end table
4831
4832
4833 @node Low-Level Threading
4834 @subsubsection Low-Level Threading
4835
4836 @table @code
4837
4838 @item gnus-parse-headers-hook
4839 @vindex gnus-parse-headers-hook
4840 Hook run before parsing any headers.  The default value is
4841 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4842 slightly decoded in a hackish way.  This is likely to change in the
4843 future when Gnus becomes @sc{MIME}ified.
4844
4845 @item gnus-alter-header-function
4846 @vindex gnus-alter-header-function
4847 If non-@code{nil}, this function will be called to allow alteration of
4848 article header structures.  The function is called with one parameter,
4849 the article header vector, which it may alter in any way.  For instance,
4850 if you have a mail-to-news gateway which alters the @code{Message-ID}s
4851 in systematic ways (by adding prefixes and such), you can use this
4852 variable to un-scramble the @code{Message-ID}s so that they are more
4853 meaningful.  Here's one example:
4854
4855 @lisp
4856 (setq gnus-alter-header-function 'my-alter-message-id)
4857
4858 (defun my-alter-message-id (header)
4859   (let ((id (mail-header-id header)))
4860     (when (string-match
4861            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
4862       (mail-header-set-id
4863        (concat (match-string 1 id) "@@" (match-string 2 id))
4864        header))))
4865 @end lisp
4866
4867 @end table
4868
4869
4870 @node Thread Commands
4871 @subsection Thread Commands
4872 @cindex thread commands
4873
4874 @table @kbd
4875
4876 @item T k
4877 @itemx M-C-k
4878 @kindex T k (Summary)
4879 @kindex M-C-k (Summary)
4880 @findex gnus-summary-kill-thread
4881 Mark all articles in the current (sub-)thread as read
4882 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4883 remove all marks instead.  If the prefix argument is negative, tick
4884 articles instead.
4885
4886 @item T l
4887 @itemx M-C-l
4888 @kindex T l (Summary)
4889 @kindex M-C-l (Summary)
4890 @findex gnus-summary-lower-thread
4891 Lower the score of the current (sub-)thread
4892 (@code{gnus-summary-lower-thread}). 
4893
4894 @item T i
4895 @kindex T i (Summary)
4896 @findex gnus-summary-raise-thread
4897 Increase the score of the current (sub-)thread
4898 (@code{gnus-summary-raise-thread}).
4899
4900 @item T #
4901 @kindex T # (Summary)
4902 @findex gnus-uu-mark-thread
4903 Set the process mark on the current (sub-)thread
4904 (@code{gnus-uu-mark-thread}).
4905
4906 @item T M-#
4907 @kindex T M-# (Summary)
4908 @findex gnus-uu-unmark-thread
4909 Remove the process mark from the current (sub-)thread
4910 (@code{gnus-uu-unmark-thread}).
4911
4912 @item T T
4913 @kindex T T (Summary)
4914 @findex gnus-summary-toggle-threads
4915 Toggle threading (@code{gnus-summary-toggle-threads}).
4916
4917 @item T s
4918 @kindex T s (Summary)
4919 @findex gnus-summary-show-thread
4920 Expose the (sub-)thread hidden under the current article, if any
4921 (@code{gnus-summary-show-thread}).
4922
4923 @item T h
4924 @kindex T h (Summary)
4925 @findex gnus-summary-hide-thread
4926 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4927
4928 @item T S
4929 @kindex T S (Summary)
4930 @findex gnus-summary-show-all-threads
4931 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4932
4933 @item T H
4934 @kindex T H (Summary)
4935 @findex gnus-summary-hide-all-threads
4936 Hide all threads (@code{gnus-summary-hide-all-threads}).
4937
4938 @item T t
4939 @kindex T t (Summary)
4940 @findex gnus-summary-rethread-current
4941 Re-thread the current article's thread
4942 (@code{gnus-summary-rethread-current}).  This works even when the
4943 summary buffer is otherwise unthreaded.
4944
4945 @item T ^
4946 @kindex T ^ (Summary)
4947 @findex gnus-summary-reparent-thread
4948 Make the current article the child of the marked (or previous) article
4949 (@code{gnus-summary-reparent-thread}).
4950
4951 @end table
4952
4953 The following commands are thread movement commands.  They all
4954 understand the numeric prefix.
4955
4956 @table @kbd
4957
4958 @item T n
4959 @kindex T n (Summary)
4960 @findex gnus-summary-next-thread
4961 Go to the next thread (@code{gnus-summary-next-thread}).
4962
4963 @item T p
4964 @kindex T p (Summary)
4965 @findex gnus-summary-prev-thread
4966 Go to the previous thread (@code{gnus-summary-prev-thread}).
4967
4968 @item T d
4969 @kindex T d (Summary)
4970 @findex gnus-summary-down-thread
4971 Descend the thread (@code{gnus-summary-down-thread}).
4972
4973 @item T u
4974 @kindex T u (Summary)
4975 @findex gnus-summary-up-thread
4976 Ascend the thread (@code{gnus-summary-up-thread}).
4977
4978 @item T o
4979 @kindex T o (Summary)
4980 @findex gnus-summary-top-thread
4981 Go to the top of the thread (@code{gnus-summary-top-thread}).
4982 @end table
4983
4984 @vindex gnus-thread-operation-ignore-subject 
4985 If you ignore subject while threading, you'll naturally end up with
4986 threads that have several different subjects in them.  If you then issue
4987 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4988 wish to kill the entire thread, but just those parts of the thread that
4989 have the same subject as the current article.  If you like this idea,
4990 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
4991 is non-@code{nil} (which it is by default), subjects will be ignored
4992 when doing thread commands.  If this variable is @code{nil}, articles in
4993 the same thread with different subjects will not be included in the
4994 operation in question.  If this variable is @code{fuzzy}, only articles
4995 that have subjects fuzzily equal will be included (@pxref{Fuzzy
4996 Matching}).
4997
4998
4999 @node Sorting
5000 @section Sorting
5001
5002 @findex gnus-thread-sort-by-total-score
5003 @findex gnus-thread-sort-by-date
5004 @findex gnus-thread-sort-by-score
5005 @findex gnus-thread-sort-by-subject
5006 @findex gnus-thread-sort-by-author
5007 @findex gnus-thread-sort-by-number
5008 @vindex gnus-thread-sort-functions
5009 If you are using a threaded summary display, you can sort the threads by
5010 setting @code{gnus-thread-sort-functions}, which is a list of functions.
5011 By default, sorting is done on article numbers.  Ready-made sorting
5012 predicate functions include @code{gnus-thread-sort-by-number},
5013 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5014 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5015 @code{gnus-thread-sort-by-total-score}.
5016
5017 Each function takes two threads and returns non-@code{nil} if the first
5018 thread should be sorted before the other.  Note that sorting really is
5019 normally done by looking only at the roots of each thread.  If you use
5020 more than one function, the primary sort key should be the last function
5021 in the list.  You should probably always include
5022 @code{gnus-thread-sort-by-number} in the list of sorting
5023 functions---preferably first.  This will ensure that threads that are
5024 equal with respect to the other sort criteria will be displayed in
5025 ascending article order.
5026
5027 If you would like to sort by score, then by subject, and finally by
5028 number, you could do something like:
5029
5030 @lisp
5031 (setq gnus-thread-sort-functions 
5032       '(gnus-thread-sort-by-number
5033         gnus-thread-sort-by-subject
5034         gnus-thread-sort-by-total-score))
5035 @end lisp
5036
5037 The threads that have highest score will be displayed first in the
5038 summary buffer.  When threads have the same score, they will be sorted
5039 alphabetically.  The threads that have the same score and the same
5040 subject will be sorted by number, which is (normally) the sequence in
5041 which the articles arrived.
5042
5043 If you want to sort by score and then reverse arrival order, you could
5044 say something like:
5045
5046 @lisp
5047 (setq gnus-thread-sort-functions
5048       '((lambda (t1 t2)
5049           (not (gnus-thread-sort-by-number t1 t2)))
5050         gnus-thread-sort-by-score))
5051 @end lisp
5052
5053 @vindex gnus-thread-score-function
5054 The function in the @code{gnus-thread-score-function} variable (default
5055 @code{+}) is used for calculating the total score of a thread.  Useful
5056 functions might be @code{max}, @code{min}, or squared means, or whatever
5057 tickles your fancy.
5058
5059 @findex gnus-article-sort-functions
5060 @findex gnus-article-sort-by-date
5061 @findex gnus-article-sort-by-score
5062 @findex gnus-article-sort-by-subject
5063 @findex gnus-article-sort-by-author
5064 @findex gnus-article-sort-by-number
5065 If you are using an unthreaded display for some strange reason or other,
5066 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5067 It is very similar to the @code{gnus-thread-sort-functions}, except that
5068 it uses slightly different functions for article comparison.  Available
5069 sorting predicate functions are @code{gnus-article-sort-by-number},
5070 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5071 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5072
5073 If you want to sort an unthreaded summary display by subject, you could
5074 say something like:
5075
5076 @lisp
5077 (setq gnus-article-sort-functions 
5078       '(gnus-article-sort-by-number
5079         gnus-article-sort-by-subject))
5080 @end lisp
5081
5082
5083
5084 @node Asynchronous Fetching
5085 @section Asynchronous Article Fetching
5086 @cindex asynchronous article fetching
5087 @cindex article pre-fetch
5088 @cindex pre-fetch
5089
5090 If you read your news from an @sc{nntp} server that's far away, the
5091 network latencies may make reading articles a chore.  You have to wait
5092 for a while after pressing @kbd{n} to go to the next article before the
5093 article appears.  Why can't Gnus just go ahead and fetch the article
5094 while you are reading the previous one?  Why not, indeed.
5095
5096 First, some caveats.  There are some pitfalls to using asynchronous
5097 article fetching, especially the way Gnus does it.  
5098
5099 Let's say you are reading article 1, which is short, and article 2 is
5100 quite long, and you are not interested in reading that.  Gnus does not
5101 know this, so it goes ahead and fetches article 2.  You decide to read
5102 article 3, but since Gnus is in the process of fetching article 2, the
5103 connection is blocked.
5104
5105 To avoid these situations, Gnus will open two (count 'em two)
5106 connections to the server.  Some people may think this isn't a very nice
5107 thing to do, but I don't see any real alternatives.  Setting up that
5108 extra connection takes some time, so Gnus startup will be slower.
5109
5110 Gnus will fetch more articles than you will read.  This will mean that
5111 the link between your machine and the @sc{nntp} server will become more
5112 loaded than if you didn't use article pre-fetch.  The server itself will
5113 also become more loaded---both with the extra article requests, and the
5114 extra connection.
5115
5116 Ok, so now you know that you shouldn't really use this thing...  unless
5117 you really want to.
5118
5119 @vindex gnus-asynchronous
5120 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5121 happen automatically.
5122
5123 @vindex gnus-use-article-prefetch
5124 You can control how many articles are to be pre-fetched by setting
5125 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5126 that when you read an article in the group, the backend will pre-fetch
5127 the next 30 articles.  If this variable is @code{t}, the backend will
5128 pre-fetch all the articles it can without bound.  If it is
5129 @code{nil}, no pre-fetching will be done.
5130
5131 @vindex gnus-async-prefetch-article-p
5132 @findex gnus-async-read-p
5133 There are probably some articles that you don't want to pre-fetch---read
5134 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5135 return non-@code{nil} when the article in question is to be
5136 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5137 @code{nil} on read articles.  The function is called with an article
5138 data structure as the only parameter.
5139
5140 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5141
5142 @lisp
5143 (defun my-async-short-unread-p (data)
5144   "Return non-nil for short, unread articles."
5145   (and (gnus-data-unread-p data)
5146        (< (mail-header-lines (gnus-data-header data))
5147           100)))
5148
5149 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5150 @end lisp
5151
5152 These functions will be called many, many times, so they should
5153 preferably be short and sweet to avoid slowing down Gnus too much.
5154 It's probably a good idea to byte-compile things like this.
5155
5156 @vindex gnus-prefetched-article-deletion-strategy
5157 Articles have to be removed from the asynch buffer sooner or later.  The
5158 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5159 articles.  This is a list that may contain the following elements:
5160
5161 @table @code
5162 @item read
5163 Remove articles when they are read.
5164
5165 @item exit
5166 Remove articles when exiting the group.
5167 @end table
5168
5169 The default value is @code{(read exit)}.
5170
5171 @vindex gnus-use-header-prefetch
5172 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5173 from the next group.
5174
5175
5176 @node Article Caching
5177 @section Article Caching
5178 @cindex article caching
5179 @cindex caching
5180
5181 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5182 consider turning article caching on.  Each article will then be stored
5183 locally under your home directory.  As you may surmise, this could
5184 potentially use @emph{huge} amounts of disk space, as well as eat up all
5185 your inodes so fast it will make your head swim.  In vodka.
5186
5187 Used carefully, though, it could be just an easier way to save articles.
5188
5189 @vindex gnus-use-long-file-name
5190 @vindex gnus-cache-directory
5191 @vindex gnus-use-cache
5192 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5193 all articles ticked or marked as dormant will then be copied
5194 over to your local cache (@code{gnus-cache-directory}).  Whether this
5195 cache is flat or hierarchal is controlled by the
5196 @code{gnus-use-long-file-name} variable, as usual.
5197
5198 When re-selecting a ticked or dormant article, it will be fetched from the
5199 cache instead of from the server.  As articles in your cache will never
5200 expire, this might serve as a method of saving articles while still
5201 keeping them where they belong.  Just mark all articles you want to save
5202 as dormant, and don't worry.
5203
5204 When an article is marked as read, is it removed from the cache.
5205
5206 @vindex gnus-cache-remove-articles
5207 @vindex gnus-cache-enter-articles
5208 The entering/removal of articles from the cache is controlled by the
5209 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5210 variables.  Both are lists of symbols.  The first is @code{(ticked
5211 dormant)} by default, meaning that ticked and dormant articles will be
5212 put in the cache.  The latter is @code{(read)} by default, meaning that
5213 articles marked as read are removed from the cache.  Possibly
5214 symbols in these two lists are @code{ticked}, @code{dormant},
5215 @code{unread} and @code{read}.
5216
5217 @findex gnus-jog-cache
5218 So where does the massive article-fetching and storing come into the
5219 picture?  The @code{gnus-jog-cache} command will go through all
5220 subscribed newsgroups, request all unread articles, score them, and
5221 store them in the cache.  You should only ever, ever ever ever, use this
5222 command if 1) your connection to the @sc{nntp} server is really, really,
5223 really slow and 2) you have a really, really, really huge disk.
5224 Seriously.  One way to cut down on the number of articles downloaded is
5225 to score unwanted articles down and have them marked as read.  They will
5226 not then be downloaded by this command.
5227
5228 @vindex gnus-uncacheable-groups
5229 It is likely that you do not want caching on some groups.  For instance,
5230 if your @code{nnml} mail is located under your home directory, it makes no
5231 sense to cache it somewhere else under your home directory.  Unless you
5232 feel that it's neat to use twice as much space.  To limit the caching,
5233 you could set the @code{gnus-uncacheable-groups} regexp to
5234 @samp{^nnml}, for instance.  This variable is @code{nil} by
5235 default.
5236
5237 @findex gnus-cache-generate-nov-databases
5238 @findex gnus-cache-generate-active
5239 @vindex gnus-cache-active-file
5240 The cache stores information on what articles it contains in its active
5241 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5242 of the cache) becomes all messed up for some reason or other, Gnus
5243 offers two functions that will try to set things right.  @kbd{M-x
5244 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5245 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5246 file.
5247
5248
5249 @node Persistent Articles
5250 @section Persistent Articles
5251 @cindex persistent articles
5252
5253 Closely related to article caching, we have @dfn{persistent articles}.
5254 In fact, it's just a different way of looking at caching, and much more
5255 useful in my opinion.
5256
5257 Say you're reading a newsgroup, and you happen on to some valuable gem
5258 that you want to keep and treasure forever.  You'd normally just save it
5259 (using one of the many saving commands) in some file.  The problem with
5260 that is that it's just, well, yucky.  Ideally you'd prefer just having
5261 the article remain in the group where you found it forever; untouched by
5262 the expiry going on at the news server.
5263
5264 This is what a @dfn{persistent article} is---an article that just won't
5265 be deleted.  It's implemented using the normal cache functions, but
5266 you use two explicit commands for managing persistent articles:
5267
5268 @table @kbd
5269
5270 @item *
5271 @kindex * (Summary)
5272 @findex gnus-cache-enter-article
5273 Make the current article persistent (@code{gnus-cache-enter-article}). 
5274
5275 @item M-*
5276 @kindex M-* (Summary)
5277 @findex gnus-cache-remove-article
5278 Remove the current article from the persistent articles
5279 (@code{gnus-cache-remove-article}).  This will normally delete the
5280 article. 
5281 @end table
5282
5283 Both these commands understand the process/prefix convention. 
5284
5285 To avoid having all ticked articles (and stuff) entered into the cache,
5286 you should set @code{gnus-use-cache} to @code{passive} if you're just
5287 interested in persistent articles:
5288
5289 @lisp
5290 (setq gnus-use-cache 'passive)
5291 @end lisp
5292
5293
5294 @node Article Backlog
5295 @section Article Backlog
5296 @cindex backlog
5297 @cindex article backlog
5298
5299 If you have a slow connection, but the idea of using caching seems
5300 unappealing to you (and it is, really), you can help the situation some
5301 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5302 already read articles so that it doesn't have to re-fetch articles
5303 you've already read.  This only helps if you are in the habit of
5304 re-selecting articles you've recently read, of course.  If you never do
5305 that, turning the backlog on will slow Gnus down a little bit, and
5306 increase memory usage some.
5307
5308 @vindex gnus-keep-backlog
5309 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5310 at most @var{n} old articles in a buffer for later re-fetching.  If this
5311 variable is non-@code{nil} and is not a number, Gnus will store
5312 @emph{all} read articles, which means that your Emacs will grow without
5313 bound before exploding and taking your machine down with you.  I put
5314 that in there just to keep y'all on your toes.  
5315
5316 This variable is @code{nil} by default.
5317
5318
5319 @node Saving Articles
5320 @section Saving Articles
5321 @cindex saving articles
5322
5323 Gnus can save articles in a number of ways.  Below is the documentation
5324 for saving articles in a fairly straight-forward fashion (i.e., little
5325 processing of the article is done before it is saved).  For a different
5326 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5327 (@pxref{Decoding Articles}).
5328
5329 @vindex gnus-save-all-headers
5330 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5331 unwanted headers before saving the article.
5332
5333 @vindex gnus-saved-headers
5334 If the preceding variable is @code{nil}, all headers that match the
5335 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5336 deleted before saving.
5337
5338 @table @kbd
5339
5340 @item O o
5341 @itemx o
5342 @kindex O o (Summary)
5343 @kindex o (Summary)
5344 @findex gnus-summary-save-article
5345 @c @icon{gnus-summary-save-article}
5346 Save the current article using the default article saver
5347 (@code{gnus-summary-save-article}). 
5348
5349 @item O m
5350 @kindex O m (Summary)
5351 @findex gnus-summary-save-article-mail
5352 Save the current article in mail format
5353 (@code{gnus-summary-save-article-mail}). 
5354
5355 @item O r
5356 @kindex O r (Summary)
5357 @findex gnus-summary-save-article-rmail
5358 Save the current article in rmail format
5359 (@code{gnus-summary-save-article-rmail}). 
5360
5361 @item O f
5362 @kindex O f (Summary)
5363 @findex gnus-summary-save-article-file
5364 @c @icon{gnus-summary-save-article-file}
5365 Save the current article in plain file format
5366 (@code{gnus-summary-save-article-file}). 
5367
5368 @item O F
5369 @kindex O F (Summary)
5370 @findex gnus-summary-write-article-file
5371 Write the current article in plain file format, overwriting any previous
5372 file contents (@code{gnus-summary-write-article-file}). 
5373
5374 @item O b
5375 @kindex O b (Summary)
5376 @findex gnus-summary-save-article-body-file
5377 Save the current article body in plain file format
5378 (@code{gnus-summary-save-article-body-file}). 
5379
5380 @item O h
5381 @kindex O h (Summary)
5382 @findex gnus-summary-save-article-folder
5383 Save the current article in mh folder format
5384 (@code{gnus-summary-save-article-folder}). 
5385
5386 @item O v
5387 @kindex O v (Summary)
5388 @findex gnus-summary-save-article-vm
5389 Save the current article in a VM folder
5390 (@code{gnus-summary-save-article-vm}).
5391
5392 @item O p
5393 @kindex O p (Summary)
5394 @findex gnus-summary-pipe-output
5395 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5396 the current article to a process (@code{gnus-summary-pipe-output}).
5397 @end table
5398
5399 @vindex gnus-prompt-before-saving
5400 All these commands use the process/prefix convention
5401 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5402 functions, you might get tired of being prompted for files to save each
5403 and every article in.  The prompting action is controlled by
5404 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5405 default, giving you that excessive prompting action you know and
5406 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5407 just once for each series of articles you save.  If you like to really
5408 have Gnus do all your thinking for you, you can even set this variable
5409 to @code{nil}, which means that you will never be prompted for files to
5410 save articles in.  Gnus will simply save all the articles in the default
5411 files. 
5412
5413
5414 @vindex gnus-default-article-saver
5415 You can customize the @code{gnus-default-article-saver} variable to make
5416 Gnus do what you want it to.  You can use any of the four ready-made
5417 functions below, or you can create your own.
5418
5419 @table @code
5420
5421 @item gnus-summary-save-in-rmail
5422 @findex gnus-summary-save-in-rmail
5423 @vindex gnus-rmail-save-name
5424 @findex gnus-plain-save-name
5425 This is the default format, @dfn{babyl}.  Uses the function in the
5426 @code{gnus-rmail-save-name} variable to get a file name to save the
5427 article in.  The default is @code{gnus-plain-save-name}.
5428
5429 @item gnus-summary-save-in-mail
5430 @findex gnus-summary-save-in-mail
5431 @vindex gnus-mail-save-name
5432 Save in a Unix mail (mbox) file.  Uses the function in the
5433 @code{gnus-mail-save-name} variable to get a file name to save the
5434 article in.  The default is @code{gnus-plain-save-name}.
5435
5436 @item gnus-summary-save-in-file
5437 @findex gnus-summary-save-in-file
5438 @vindex gnus-file-save-name
5439 @findex gnus-numeric-save-name
5440 Append the article straight to an ordinary file.  Uses the function in
5441 the @code{gnus-file-save-name} variable to get a file name to save the
5442 article in.  The default is @code{gnus-numeric-save-name}.
5443
5444 @item gnus-summary-save-body-in-file
5445 @findex gnus-summary-save-body-in-file
5446 Append the article body to an ordinary file.  Uses the function in the
5447 @code{gnus-file-save-name} variable to get a file name to save the
5448 article in.  The default is @code{gnus-numeric-save-name}.
5449
5450 @item gnus-summary-save-in-folder
5451 @findex gnus-summary-save-in-folder
5452 @findex gnus-folder-save-name
5453 @findex gnus-Folder-save-name
5454 @vindex gnus-folder-save-name
5455 @cindex rcvstore
5456 @cindex MH folders
5457 Save the article to an MH folder using @code{rcvstore} from the MH
5458 library.  Uses the function in the @code{gnus-folder-save-name} variable
5459 to get a file name to save the article in.  The default is
5460 @code{gnus-folder-save-name}, but you can also use
5461 @code{gnus-Folder-save-name}, which creates capitalized names.
5462
5463 @item gnus-summary-save-in-vm
5464 @findex gnus-summary-save-in-vm
5465 Save the article in a VM folder.  You have to have the VM mail
5466 reader to use this setting.
5467 @end table
5468
5469 @vindex gnus-article-save-directory
5470 All of these functions, except for the last one, will save the article
5471 in the @code{gnus-article-save-directory}, which is initialized from the
5472 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5473 default. 
5474
5475 As you can see above, the functions use different functions to find a
5476 suitable name of a file to save the article in.  Below is a list of
5477 available functions that generate names:
5478
5479 @table @code
5480
5481 @item gnus-Numeric-save-name
5482 @findex gnus-Numeric-save-name
5483 File names like @file{~/News/Alt.andrea-dworkin/45}.
5484
5485 @item gnus-numeric-save-name
5486 @findex gnus-numeric-save-name
5487 File names like @file{~/News/alt.andrea-dworkin/45}.
5488
5489 @item gnus-Plain-save-name
5490 @findex gnus-Plain-save-name
5491 File names like @file{~/News/Alt.andrea-dworkin}.
5492
5493 @item gnus-plain-save-name
5494 @findex gnus-plain-save-name
5495 File names like @file{~/News/alt.andrea-dworkin}.
5496 @end table
5497
5498 @vindex gnus-split-methods
5499 You can have Gnus suggest where to save articles by plonking a regexp into
5500 the @code{gnus-split-methods} alist.  For instance, if you would like to
5501 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5502 related to VM in @code{vm-stuff}, you could set this variable to something
5503 like:
5504
5505 @lisp
5506 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5507  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5508  (my-choosing-function "../other-dir/my-stuff")
5509  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5510 @end lisp
5511
5512 We see that this is a list where each element is a list that has two
5513 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5514 a string (in which case it is used as a regexp to match on the article
5515 head); it can be a symbol (which will be called as a function with the
5516 group name as a parameter); or it can be a list (which will be
5517 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5518 the @dfn{file} will be used as a default prompt.  In addition, the
5519 result of the operation itself will be used if the function or form
5520 called returns a string or a list of strings.
5521
5522 You basically end up with a list of file names that might be used when
5523 saving the current article.  (All ``matches'' will be used.)  You will
5524 then be prompted for what you really want to use as a name, with file
5525 name completion over the results from applying this variable.
5526
5527 This variable is @code{((gnus-article-archive-name))} by default, which
5528 means that Gnus will look at the articles it saves for an
5529 @code{Archive-name} line and use that as a suggestion for the file
5530 name. 
5531
5532 Here's an example function to clean up file names somewhat.  If you have
5533 lots of mail groups called things like
5534 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5535 these group names before creating the file name to save to.  The
5536 following will do just that:
5537
5538 @lisp
5539 (defun my-save-name (group)
5540   (when (string-match "^nnml:mail." group)
5541     (substring group (match-end 0))))
5542
5543 (setq gnus-split-methods
5544       '((gnus-article-archive-name)
5545         (my-save-name)))
5546 @end lisp
5547
5548
5549 @vindex gnus-use-long-file-name
5550 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5551 @code{nil}, all the preceding functions will replace all periods
5552 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5553 the functions will generate hierarchies of directories instead of having
5554 all the files in the toplevel directory
5555 (@file{~/News/alt/andrea-dworkin} instead of
5556 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5557 on most systems.  However, for historical reasons, this is @code{nil} on
5558 Xenix and usg-unix-v machines by default.
5559
5560 This function also affects kill and score file names.  If this variable
5561 is a list, and the list contains the element @code{not-score}, long file
5562 names will not be used for score files, if it contains the element
5563 @code{not-save}, long file names will not be used for saving, and if it
5564 contains the element @code{not-kill}, long file names will not be used
5565 for kill files.
5566
5567 If you'd like to save articles in a hierarchy that looks something like
5568 a spool, you could
5569
5570 @lisp
5571 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5572 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5573 @end lisp
5574
5575 Then just save with @kbd{o}.  You'd then read this hierarchy with
5576 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5577 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5578 around to the groups/directories with @code{nneething}.
5579
5580
5581 @node Decoding Articles
5582 @section Decoding Articles
5583 @cindex decoding articles
5584
5585 Sometime users post articles (or series of articles) that have been
5586 encoded in some way or other.  Gnus can decode them for you.
5587
5588 @menu 
5589 * Uuencoded Articles::    Uudecode articles.
5590 * Shell Archives::        Unshar articles.
5591 * PostScript Files::      Split PostScript.
5592 * Other Files::           Plain save and binhex.
5593 * Decoding Variables::    Variables for a happy decoding.
5594 * Viewing Files::         You want to look at the result of the decoding?
5595 @end menu
5596
5597 @cindex series
5598 @cindex article series
5599 All these functions use the process/prefix convention
5600 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5601 the extension that a ``single article'' means ``a single series''.  Gnus
5602 can find out by itself what articles belong to a series, decode all the
5603 articles and unpack/view/save the resulting file(s).
5604
5605 Gnus guesses what articles are in the series according to the following
5606 simplish rule: The subjects must be (nearly) identical, except for the
5607 last two numbers of the line.  (Spaces are largely ignored, however.)
5608
5609 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5610 will find all the articles that match the regexp @samp{^cat.gif
5611 ([0-9]+/[0-9]+).*$}.  
5612
5613 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5614 series}, will not be properly recognized by any of the automatic viewing
5615 commands, and you have to mark the articles manually with @kbd{#}.
5616
5617
5618 @node Uuencoded Articles
5619 @subsection Uuencoded Articles
5620 @cindex uudecode
5621 @cindex uuencoded articles
5622
5623 @table @kbd
5624
5625 @item X u
5626 @kindex X u (Summary)
5627 @findex gnus-uu-decode-uu
5628 @c @icon{gnus-uu-decode-uu}
5629 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5630
5631 @item X U
5632 @kindex X U (Summary)
5633 @findex gnus-uu-decode-uu-and-save
5634 Uudecodes and saves the current series
5635 (@code{gnus-uu-decode-uu-and-save}).
5636
5637 @item X v u
5638 @kindex X v u (Summary)
5639 @findex gnus-uu-decode-uu-view
5640 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5641
5642 @item X v U
5643 @kindex X v U (Summary)
5644 @findex gnus-uu-decode-uu-and-save-view
5645 Uudecodes, views and saves the current series
5646 (@code{gnus-uu-decode-uu-and-save-view}).
5647
5648 @end table
5649
5650 Remember that these all react to the presence of articles marked with
5651 the process mark.  If, for instance, you'd like to decode and save an
5652 entire newsgroup, you'd typically do @kbd{M P a}
5653 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5654 (@code{gnus-uu-decode-uu-and-save}).
5655
5656 All this is very much different from how @code{gnus-uu} worked with
5657 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5658 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5659 articles in some way (@pxref{Setting Process Marks}) and then press
5660 @kbd{X u}.
5661
5662 @vindex gnus-uu-notify-files
5663 Note: When trying to decode articles that have names matching
5664 @code{gnus-uu-notify-files}, which is hard-coded to
5665 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5666 automatically post an article on @samp{comp.unix.wizards} saying that
5667 you have just viewed the file in question.  This feature can't be turned
5668 off.
5669
5670
5671 @node Shell Archives
5672 @subsection Shell Archives
5673 @cindex unshar
5674 @cindex shell archives
5675 @cindex shared articles
5676
5677 Shell archives (``shar files'') used to be a popular way to distribute
5678 sources, but it isn't used all that much today.  In any case, we have
5679 some commands to deal with these:
5680
5681 @table @kbd
5682
5683 @item X s
5684 @kindex X s (Summary)
5685 @findex gnus-uu-decode-unshar
5686 Unshars the current series (@code{gnus-uu-decode-unshar}).
5687
5688 @item X S
5689 @kindex X S (Summary)
5690 @findex gnus-uu-decode-unshar-and-save
5691 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5692
5693 @item X v s
5694 @kindex X v s (Summary)
5695 @findex gnus-uu-decode-unshar-view
5696 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5697
5698 @item X v S
5699 @kindex X v S (Summary)
5700 @findex gnus-uu-decode-unshar-and-save-view
5701 Unshars, views and saves the current series
5702 (@code{gnus-uu-decode-unshar-and-save-view}). 
5703 @end table
5704
5705
5706 @node PostScript Files
5707 @subsection PostScript Files
5708 @cindex PostScript
5709
5710 @table @kbd
5711
5712 @item X p
5713 @kindex X p (Summary)
5714 @findex gnus-uu-decode-postscript
5715 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5716
5717 @item X P
5718 @kindex X P (Summary)
5719 @findex gnus-uu-decode-postscript-and-save
5720 Unpack and save the current PostScript series
5721 (@code{gnus-uu-decode-postscript-and-save}).
5722
5723 @item X v p
5724 @kindex X v p (Summary)
5725 @findex gnus-uu-decode-postscript-view
5726 View the current PostScript series
5727 (@code{gnus-uu-decode-postscript-view}).
5728
5729 @item X v P
5730 @kindex X v P (Summary)
5731 @findex gnus-uu-decode-postscript-and-save-view
5732 View and save the current PostScript series
5733 (@code{gnus-uu-decode-postscript-and-save-view}). 
5734 @end table
5735
5736
5737 @node Other Files
5738 @subsection Other Files
5739
5740 @table @kbd
5741 @item X o
5742 @kindex X o (Summary)
5743 @findex gnus-uu-decode-save
5744 Save the current series
5745 (@code{gnus-uu-decode-save}).
5746
5747 @item X b
5748 @kindex X b (Summary)
5749 @findex gnus-uu-decode-binhex
5750 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
5751 doesn't really work yet.
5752 @end table
5753
5754
5755 @node Decoding Variables
5756 @subsection Decoding Variables
5757
5758 Adjective, not verb.
5759
5760 @menu 
5761 * Rule Variables::          Variables that say how a file is to be viewed.
5762 * Other Decode Variables::  Other decode variables.
5763 * Uuencoding and Posting::  Variables for customizing uuencoding.
5764 @end menu
5765
5766
5767 @node Rule Variables
5768 @subsubsection Rule Variables
5769 @cindex rule variables
5770
5771 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5772 variables are of the form
5773   
5774 @lisp
5775       (list '(regexp1 command2)
5776             '(regexp2 command2)
5777             ...)
5778 @end lisp
5779
5780 @table @code
5781
5782 @item gnus-uu-user-view-rules
5783 @vindex gnus-uu-user-view-rules
5784 @cindex sox
5785 This variable is consulted first when viewing files.  If you wish to use,
5786 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5787 say something like:
5788 @lisp
5789 (setq gnus-uu-user-view-rules
5790       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5791 @end lisp
5792
5793 @item gnus-uu-user-view-rules-end
5794 @vindex gnus-uu-user-view-rules-end
5795 This variable is consulted if Gnus couldn't make any matches from the
5796 user and default view rules.
5797
5798 @item gnus-uu-user-archive-rules
5799 @vindex gnus-uu-user-archive-rules
5800 This variable can be used to say what commands should be used to unpack
5801 archives.
5802 @end table
5803
5804
5805 @node Other Decode Variables
5806 @subsubsection Other Decode Variables
5807
5808 @table @code
5809 @vindex gnus-uu-grabbed-file-functions
5810
5811 @item gnus-uu-grabbed-file-functions
5812 All functions in this list will be called right after each file has been
5813 successfully decoded---so that you can move or view files right away,
5814 and don't have to wait for all files to be decoded before you can do
5815 anything.  Ready-made functions you can put in this list are:
5816
5817 @table @code
5818
5819 @item gnus-uu-grab-view
5820 @findex gnus-uu-grab-view
5821 View the file.
5822
5823 @item gnus-uu-grab-move
5824 @findex gnus-uu-grab-move
5825 Move the file (if you're using a saving function.)
5826 @end table
5827
5828 @item gnus-uu-be-dangerous
5829 @vindex gnus-uu-be-dangerous
5830 Specifies what to do if unusual situations arise during decoding.  If
5831 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5832 that didn't work, and overwrite existing files.  Otherwise, ask each
5833 time.
5834
5835 @item gnus-uu-ignore-files-by-name
5836 @vindex gnus-uu-ignore-files-by-name
5837 Files with name matching this regular expression won't be viewed.
5838
5839 @item gnus-uu-ignore-files-by-type
5840 @vindex gnus-uu-ignore-files-by-type
5841 Files with a @sc{mime} type matching this variable won't be viewed.
5842 Note that Gnus tries to guess what type the file is based on the name.
5843 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5844 kludgey.
5845
5846 @item gnus-uu-tmp-dir
5847 @vindex gnus-uu-tmp-dir
5848 Where @code{gnus-uu} does its work.
5849
5850 @item gnus-uu-do-not-unpack-archives
5851 @vindex gnus-uu-do-not-unpack-archives
5852 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5853 looking for files to display.
5854
5855 @item gnus-uu-view-and-save
5856 @vindex gnus-uu-view-and-save
5857 Non-@code{nil} means that the user will always be asked to save a file
5858 after viewing it.
5859
5860 @item gnus-uu-ignore-default-view-rules
5861 @vindex gnus-uu-ignore-default-view-rules
5862 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5863 rules.
5864
5865 @item gnus-uu-ignore-default-archive-rules
5866 @vindex gnus-uu-ignore-default-archive-rules
5867 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5868 unpacking commands.
5869
5870 @item gnus-uu-kill-carriage-return
5871 @vindex gnus-uu-kill-carriage-return
5872 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5873 from articles.
5874
5875 @item gnus-uu-unmark-articles-not-decoded
5876 @vindex gnus-uu-unmark-articles-not-decoded
5877 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5878 decoded articles as unread.
5879
5880 @item gnus-uu-correct-stripped-uucode
5881 @vindex gnus-uu-correct-stripped-uucode
5882 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5883 uuencoded files that have had trailing spaces deleted.
5884
5885 @item gnus-uu-pre-uudecode-hook
5886 @vindex gnus-uu-pre-uudecode-hook
5887 Hook run before sending a message to @code{uudecode}.
5888
5889 @item gnus-uu-view-with-metamail
5890 @vindex gnus-uu-view-with-metamail
5891 @cindex metamail
5892 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5893 commands defined by the rule variables and just fudge a @sc{mime}
5894 content type based on the file name.  The result will be fed to
5895 @code{metamail} for viewing.
5896
5897 @item gnus-uu-save-in-digest
5898 @vindex gnus-uu-save-in-digest
5899 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5900 decoding, will save in digests.  If this variable is @code{nil},
5901 @code{gnus-uu} will just save everything in a file without any
5902 embellishments.  The digesting almost conforms to RFC1153---no easy way
5903 to specify any meaningful volume and issue numbers were found, so I
5904 simply dropped them.
5905
5906 @end table
5907
5908
5909 @node Uuencoding and Posting
5910 @subsubsection Uuencoding and Posting
5911
5912 @table @code
5913
5914 @item gnus-uu-post-include-before-composing
5915 @vindex gnus-uu-post-include-before-composing
5916 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5917 before you compose the article.  If this variable is @code{t}, you can
5918 either include an encoded file with @kbd{C-c C-i} or have one included
5919 for you when you post the article.
5920
5921 @item gnus-uu-post-length
5922 @vindex gnus-uu-post-length
5923 Maximum length of an article.  The encoded file will be split into how
5924 many articles it takes to post the entire file.
5925
5926 @item gnus-uu-post-threaded
5927 @vindex gnus-uu-post-threaded
5928 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5929 thread.  This may not be smart, as no other decoder I have seen is able
5930 to follow threads when collecting uuencoded articles.  (Well, I have
5931 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5932 think that counts...) Default is @code{nil}.
5933
5934 @item gnus-uu-post-separate-description
5935 @vindex gnus-uu-post-separate-description
5936 Non-@code{nil} means that the description will be posted in a separate
5937 article.  The first article will typically be numbered (0/x).  If this
5938 variable is @code{nil}, the description the user enters will be included
5939 at the beginning of the first article, which will be numbered (1/x).
5940 Default is @code{t}.
5941
5942 @end table
5943
5944
5945 @node Viewing Files
5946 @subsection Viewing Files
5947 @cindex viewing files
5948 @cindex pseudo-articles
5949
5950 After decoding, if the file is some sort of archive, Gnus will attempt
5951 to unpack the archive and see if any of the files in the archive can be
5952 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5953 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5954 uncompress and de-tar the main file, and then view the two pictures.
5955 This unpacking process is recursive, so if the archive contains archives
5956 of archives, it'll all be unpacked.
5957
5958 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5959 extracted file into the summary buffer.  If you go to these
5960 ``articles'', you will be prompted for a command to run (usually Gnus
5961 will make a suggestion), and then the command will be run.
5962
5963 @vindex gnus-view-pseudo-asynchronously
5964 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5965 until the viewing is done before proceeding.
5966
5967 @vindex gnus-view-pseudos
5968 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5969 the pseudo-articles into the summary buffer, but view them
5970 immediately.  If this variable is @code{not-confirm}, the user won't even
5971 be asked for a confirmation before viewing is done.
5972
5973 @vindex gnus-view-pseudos-separately 
5974 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5975 pseudo-article will be created for each file to be viewed.  If
5976 @code{nil}, all files that use the same viewing command will be given as
5977 a list of parameters to that command.
5978
5979 @vindex gnus-insert-pseudo-articles
5980 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5981 pseudo-articles when decoding.  It is @code{t} by default.
5982
5983 So; there you are, reading your @emph{pseudo-articles} in your
5984 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5985 Why isn't anything real anymore? How did we get here?
5986
5987
5988 @node Article Treatment
5989 @section Article Treatment
5990
5991 Reading through this huge manual, you may have quite forgotten that the
5992 object of newsreaders is to actually, like, read what people have
5993 written.  Reading articles.  Unfortunately, people are quite bad at
5994 writing, so there are tons of functions and variables to make reading
5995 these articles easier.
5996
5997 @menu
5998 * Article Highlighting::    You want to make the article look like fruit salad.
5999 * Article Fontisizing::     Making emphasized text look niced.
6000 * Article Hiding::          You also want to make certain info go away.
6001 * Article Washing::         Lots of way-neat functions to make life better.
6002 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6003 * Article Date::            Grumble, UT!
6004 * Article Signature::       What is a signature?
6005 @end menu
6006
6007
6008 @node Article Highlighting
6009 @subsection Article Highlighting
6010 @cindex highlight
6011
6012 Not only do you want your article buffer to look like fruit salad, but
6013 you want it to look like technicolor fruit salad.
6014
6015 @table @kbd
6016
6017 @item W H a
6018 @kindex W H a (Summary)
6019 @findex gnus-article-highlight
6020 Highlight the current article (@code{gnus-article-highlight}).
6021
6022 @item W H h
6023 @kindex W H h (Summary)
6024 @findex gnus-article-highlight-headers
6025 @vindex gnus-header-face-alist
6026 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6027 highlighting will be done according to the @code{gnus-header-face-alist}
6028 variable, which is a list where each element has the form @var{(regexp
6029 name content)}.  @var{regexp} is a regular expression for matching the
6030 header, @var{name} is the face used for highlighting the header name
6031 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6032 the header value.  The first match made will be used.  Note that
6033 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6034
6035 @item W H c
6036 @kindex W H c (Summary)
6037 @findex gnus-article-highlight-citation
6038 Highlight cited text (@code{gnus-article-highlight-citation}). 
6039
6040 Some variables to customize the citation highlights:
6041
6042 @table @code
6043 @vindex gnus-cite-parse-max-size
6044
6045 @item gnus-cite-parse-max-size
6046 If the article size if bigger than this variable (which is 25000 by
6047 default), no citation highlighting will be performed.  
6048
6049 @item gnus-cite-prefix-regexp
6050 @vindex gnus-cite-prefix-regexp
6051 Regexp matching the longest possible citation prefix on a line. 
6052
6053 @item gnus-cite-max-prefix
6054 @vindex gnus-cite-max-prefix
6055 Maximum possible length for a citation prefix (default 20).
6056
6057 @item gnus-cite-face-list
6058 @vindex gnus-cite-face-list
6059 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6060 When there are citations from multiple articles in the same message,
6061 Gnus will try to give each citation from each article its own face.
6062 This should make it easier to see who wrote what.
6063
6064 @item gnus-supercite-regexp
6065 @vindex gnus-supercite-regexp
6066 Regexp matching normal Supercite attribution lines.  
6067
6068 @item gnus-supercite-secondary-regexp
6069 @vindex gnus-supercite-secondary-regexp
6070 Regexp matching mangled Supercite attribution lines.
6071
6072 @item gnus-cite-minimum-match-count
6073 @vindex gnus-cite-minimum-match-count
6074 Minimum number of identical prefixes we have to see before we believe
6075 that it's a citation.
6076
6077 @item gnus-cite-attribution-prefix
6078 @vindex gnus-cite-attribution-prefix
6079 Regexp matching the beginning of an attribution line.
6080
6081 @item gnus-cite-attribution-suffix
6082 @vindex gnus-cite-attribution-suffix
6083 Regexp matching the end of an attribution line.
6084
6085 @item gnus-cite-attribution-face
6086 @vindex gnus-cite-attribution-face
6087 Face used for attribution lines.  It is merged with the face for the
6088 cited text belonging to the attribution.
6089
6090 @end table
6091
6092
6093 @item W H s
6094 @kindex W H s (Summary)
6095 @vindex gnus-signature-separator
6096 @vindex gnus-signature-face
6097 @findex gnus-article-highlight-signature
6098 Highlight the signature (@code{gnus-article-highlight-signature}).
6099 Everything after @code{gnus-signature-separator} (@pxref{Article
6100 Signature}) in an article will be considered a signature and will be
6101 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6102 default.
6103
6104 @end table
6105
6106
6107 @node Article Fontisizing
6108 @subsection Article Fontisizing
6109 @cindex emphasis
6110 @cindex article emphasis
6111
6112 @findex gnus-article-emphasize
6113 @kindex W e (Summary)
6114 People commonly add emphasis to words in news articles by writing things
6115 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
6116 running the article through the @kbd{W e}
6117 (@code{gnus-article-emphasize}) command.
6118
6119 @vindex gnus-article-emphasis
6120 How the emphasis is computed is controlled by the
6121 @code{gnus-article-emphasis} variable.  This is an alist where the first
6122 element is a regular expression to be matched.  The second is a number
6123 that says what regular expression grouping is used to find the entire
6124 emphasized word.  The third is a number that says what regexp grouping
6125 should be displayed and highlighted.  (The text between these two
6126 groupings will be hidden.)  The fourth is the face used for
6127 highlighting.
6128
6129 @lisp
6130 (setq gnus-article-emphasis
6131       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6132         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6133 @end lisp
6134
6135 @vindex gnus-emphasis-underline
6136 @vindex gnus-emphasis-bold
6137 @vindex gnus-emphasis-italic
6138 @vindex gnus-emphasis-underline-bold
6139 @vindex gnus-emphasis-underline-italic
6140 @vindex gnus-emphasis-bold-italic
6141 @vindex gnus-emphasis-underline-bold-italic
6142 By default, there are seven rules, and they use the following faces:
6143 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6144 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6145 @code{gnus-emphasis-underline-italic},
6146 @code{gnus-emphasis-underline-bold}, and
6147 @code{gnus-emphasis-underline-bold-italic}.  
6148
6149 If you want to change these faces, you can either use @kbd{M-x
6150 customize}, or you can use @code{copy-face}.  For instance, if you want
6151 to make @code{gnus-emphasis-italic} use a red face instead, you could
6152 say something like:
6153
6154 @lisp
6155 (copy-face 'red 'gnus-emphasis-italic)
6156 @end lisp
6157
6158
6159 @node Article Hiding
6160 @subsection Article Hiding
6161 @cindex article hiding
6162
6163 Or rather, hiding certain things in each article.  There usually is much
6164 too much cruft in most articles.  
6165
6166 @table @kbd
6167
6168 @item W W a
6169 @kindex W W a (Summary)
6170 @findex gnus-article-hide
6171 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
6172
6173 @item W W h
6174 @kindex W W h (Summary)
6175 @findex gnus-article-hide-headers
6176 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
6177 Headers}. 
6178
6179 @item W W b
6180 @kindex W W b (Summary)
6181 @findex gnus-article-hide-boring-headers
6182 Hide headers that aren't particularly interesting
6183 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6184
6185 @item W W s
6186 @kindex W W s (Summary)
6187 @findex gnus-article-hide-signature
6188 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6189 Signature}. 
6190
6191 @item W W p
6192 @kindex W W p (Summary)
6193 @findex gnus-article-hide-pgp
6194 @vindex gnus-article-hide-pgp-hook
6195 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6196 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6197 signature has been hidden.
6198
6199 @item W W P
6200 @kindex W W P (Summary)
6201 @findex gnus-article-hide-pem
6202 Hide @sc{pem} (privacy enhanced messages) cruft
6203 (@code{gnus-article-hide-pem}).
6204
6205 @item W W c
6206 @kindex W W c (Summary)
6207 @findex gnus-article-hide-citation
6208 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6209 customizing the hiding:
6210
6211 @table @code
6212
6213 @item gnus-cite-hide-percentage
6214 @vindex gnus-cite-hide-percentage
6215 If the cited text is of a bigger percentage than this variable (default
6216 50), hide the cited text.
6217
6218 @item gnus-cite-hide-absolute
6219 @vindex gnus-cite-hide-absolute
6220 The cited text must have at least this length (default 10) before it
6221 is hidden.
6222
6223 @item gnus-cited-text-button-line-format
6224 @vindex gnus-cited-text-button-line-format
6225 Gnus adds buttons to show where the cited text has been hidden, and to
6226 allow toggle hiding the text.  The format of the variable is specified
6227 by this format-like variable (@pxref{Formatting Variables}).  These
6228 specs are valid:
6229
6230 @table @samp
6231 @item b
6232 Start point of the hidden text.
6233 @item e
6234 End point of the hidden text.
6235 @item l
6236 Length of the hidden text.
6237 @end table
6238
6239 @item gnus-cited-lines-visible
6240 @vindex gnus-cited-lines-visible
6241 The number of lines at the beginning of the cited text to leave shown. 
6242
6243 @end table
6244
6245 @item W W C
6246 @kindex W W C (Summary)
6247 @findex gnus-article-hide-citation-in-followups
6248 Hide cited text in articles that aren't roots
6249 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6250 useful as an interactive command, but might be a handy function to stick
6251 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
6252
6253 @end table
6254
6255 All these ``hiding'' commands are toggles, but if you give a negative
6256 prefix to these commands, they will show what they have previously
6257 hidden.  If you give a positive prefix, they will always hide.
6258
6259 Also @pxref{Article Highlighting} for further variables for
6260 citation customization.
6261
6262
6263 @node Article Washing
6264 @subsection Article Washing
6265 @cindex washing
6266 @cindex article washing
6267
6268 We call this ``article washing'' for a really good reason.  Namely, the
6269 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6270
6271 @dfn{Washing} is defined by us as ``changing something from something to
6272 something else'', but normally results in something looking better.
6273 Cleaner, perhaps.
6274
6275 @table @kbd
6276
6277 @item W l
6278 @kindex W l (Summary)
6279 @findex gnus-summary-stop-page-breaking
6280 Remove page breaks from the current article
6281 (@code{gnus-summary-stop-page-breaking}).
6282
6283 @item W r
6284 @kindex W r (Summary)
6285 @findex gnus-summary-caesar-message
6286 @c @icon{gnus-summary-caesar-message}
6287 Do a Caesar rotate (rot13) on the article buffer
6288 (@code{gnus-summary-caesar-message}). 
6289 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6290 (Typically offensive jokes and such.)
6291
6292 It's commonly called ``rot13'' because each letter is rotated 13
6293 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6294 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6295 is rumoured to have employed this form of, uh, somewhat weak encryption.
6296
6297 @item W t
6298 @kindex W t (Summary)
6299 @findex gnus-summary-toggle-header
6300 Toggle whether to display all headers in the article buffer
6301 (@code{gnus-summary-toggle-header}). 
6302
6303 @item W v
6304 @kindex W v (Summary)
6305 @findex gnus-summary-verbose-header
6306 Toggle whether to display all headers in the article buffer permanently
6307 (@code{gnus-summary-verbose-header}).
6308
6309 @item W m
6310 @kindex W m (Summary)
6311 @findex gnus-summary-toggle-mime
6312 Toggle whether to run the article through @sc{mime} before displaying
6313 (@code{gnus-summary-toggle-mime}).
6314
6315 @item W o
6316 @kindex W o (Summary)
6317 @findex gnus-article-treat-overstrike
6318 Treat overstrike (@code{gnus-article-treat-overstrike}).
6319
6320 @item W d
6321 @kindex W d (Summary)
6322 @findex gnus-article-treat-dumbquotes
6323 Treat M******** sm*rtq**t*s (@code{gnus-article-treat-dumbquotes}).
6324
6325 @item W w
6326 @kindex W w (Summary)
6327 @findex gnus-article-fill-cited-article
6328 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
6329 function in @code{gnus-article-display-hook}, it should be run fairly
6330 late and certainly after any highlighting.
6331
6332 You can give the command a numerical prefix to specify the width to use
6333 when filling.
6334
6335 @item W c
6336 @kindex W c (Summary)
6337 @findex gnus-article-remove-cr
6338 Remove CR (i. e., @samp{^M}s on the end of the lines)
6339 (@code{gnus-article-remove-cr}).
6340
6341 @item W q
6342 @kindex W q (Summary)
6343 @findex gnus-article-de-quoted-unreadable
6344 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6345 Quoted-Printable is one common @sc{mime} encoding employed when sending
6346 non-ASCII (i. e., 8-bit) articles.  It typically makes strings like
6347 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6348 readable to me.
6349
6350 @item W f
6351 @kindex W f (Summary)
6352 @cindex x-face
6353 @findex gnus-article-display-x-face
6354 @findex gnus-article-x-face-command
6355 @vindex gnus-article-x-face-command
6356 @vindex gnus-article-x-face-too-ugly
6357 @iftex
6358 @iflatex
6359 \include{xface}
6360 @end iflatex
6361 @end iftex
6362 Look for and display any X-Face headers
6363 (@code{gnus-article-display-x-face}).  The command executed by this
6364 function is given by the @code{gnus-article-x-face-command} variable.
6365 If this variable is a string, this string will be executed in a
6366 sub-shell.  If it is a function, this function will be called with the
6367 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6368 is a regexp) matches the @code{From} header, the face will not be shown.
6369 The default action under Emacs is to fork off an @code{xv} to view the
6370 face; under XEmacs the default action is to display the face before the
6371 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6372 support---that will make display somewhat faster.  If there's no native
6373 X-Face support, Gnus will try to convert the @code{X-Face} header using
6374 external programs from the @code{pbmplus} package and friends.)  If you
6375 want to have this function in the display hook, it should probably come
6376 last.
6377
6378 @item W b
6379 @kindex W b (Summary)
6380 @findex gnus-article-add-buttons
6381 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6382 @xref{Article Buttons}
6383
6384 @item W B
6385 @kindex W B (Summary)
6386 @findex gnus-article-add-buttons-to-head
6387 Add clickable buttons to the article headers
6388 (@code{gnus-article-add-buttons-to-head}).  
6389
6390 @item W E l
6391 @kindex W E l (Summary)
6392 @findex gnus-article-strip-leading-blank-lines
6393 Remove all blank lines from the beginning of the article
6394 (@code{gnus-article-strip-leading-blank-lines}).
6395
6396 @item W E m
6397 @kindex W E m (Summary)
6398 @findex gnus-article-strip-multiple-blank-lines
6399 Replace all blank lines with empty lines and then all multiple empty
6400 lines with a single empty line.
6401 (@code{gnus-article-strip-multiple-blank-lines}).
6402
6403 @item W E t
6404 @kindex W E t (Summary)
6405 @findex gnus-article-remove-trailing-blank-lines
6406 Remove all blank lines at the end of the article
6407 (@code{gnus-article-remove-trailing-blank-lines}).
6408
6409 @item W E a
6410 @kindex W E a (Summary)
6411 @findex gnus-article-strip-blank-lines
6412 Do all the three commands above
6413 (@code{gnus-article-strip-blank-lines}).
6414
6415 @item W E A
6416 @kindex W E A (Summary)
6417 @findex gnus-article-strip-all-blank-lines
6418 Remove all blank lines
6419 (@code{gnus-article-strip-all-blank-lines}).
6420
6421 @item W E s
6422 @kindex W E s (Summary)
6423 @findex gnus-article-strip-leading-space
6424 Remove all white space from the beginning of all lines of the article
6425 body (@code{gnus-article-strip-leading-space}).
6426
6427 @end table
6428
6429
6430 @node Article Buttons
6431 @subsection Article Buttons
6432 @cindex buttons
6433
6434 People often include references to other stuff in articles, and it would
6435 be nice if Gnus could just fetch whatever it is that people talk about
6436 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6437 button on these references.
6438
6439 Gnus adds @dfn{buttons} to certain standard references by default:
6440 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6441 two variables, one that handles article bodies and one that handles
6442 article heads:
6443
6444 @table @code
6445
6446 @item gnus-button-alist
6447 @vindex gnus-button-alist
6448 This is an alist where each entry has this form:
6449
6450 @lisp
6451 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6452 @end lisp
6453
6454 @table @var
6455
6456 @item regexp
6457 All text that match this regular expression will be considered an
6458 external reference.  Here's a typical regexp that matches embedded URLs:
6459 @samp{<URL:\\([^\n\r>]*\\)>}. 
6460
6461 @item button-par
6462 Gnus has to know which parts of the matches is to be highlighted.  This
6463 is a number that says what sub-expression of the regexp is to be
6464 highlighted.  If you want it all highlighted, you use 0 here.
6465
6466 @item use-p
6467 This form will be @code{eval}ed, and if the result is non-@code{nil},
6468 this is considered a match.  This is useful if you want extra sifting to
6469 avoid false matches.
6470
6471 @item function
6472 This function will be called when you click on this button.
6473
6474 @item data-par
6475 As with @var{button-par}, this is a sub-expression number, but this one
6476 says which part of the match is to be sent as data to @var{function}. 
6477
6478 @end table
6479
6480 So the full entry for buttonizing URLs is then
6481
6482 @lisp
6483 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6484 @end lisp
6485
6486 @item gnus-header-button-alist
6487 @vindex gnus-header-button-alist
6488 This is just like the other alist, except that it is applied to the
6489 article head only, and that each entry has an additional element that is
6490 used to say what headers to apply the buttonize coding to:
6491
6492 @lisp
6493 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6494 @end lisp
6495
6496 @var{HEADER} is a regular expression.
6497
6498 @item gnus-button-url-regexp
6499 @vindex gnus-button-url-regexp
6500 A regular expression that matches embedded URLs.  It is used in the
6501 default values of the variables above.
6502
6503 @item gnus-article-button-face
6504 @vindex gnus-article-button-face
6505 Face used on buttons.
6506
6507 @item gnus-article-mouse-face
6508 @vindex gnus-article-mouse-face
6509 Face used when the mouse cursor is over a button.
6510
6511 @end table
6512
6513
6514 @node Article Date
6515 @subsection Article Date
6516
6517 The date is most likely generated in some obscure timezone you've never
6518 heard of, so it's quite nice to be able to find out what the time was
6519 when the article was sent.
6520
6521 @table @kbd
6522
6523 @item W T u
6524 @kindex W T u (Summary)
6525 @findex gnus-article-date-ut
6526 Display the date in UT (aka. GMT, aka ZULU)
6527 (@code{gnus-article-date-ut}). 
6528
6529 @item W T i
6530 @kindex W T i (Summary)
6531 @findex gnus-article-date-iso8601
6532 @cindex ISO 8601
6533 Display the date in international format, aka. ISO 8601
6534 (@code{gnus-article-date-iso8601}).
6535
6536 @item W T l
6537 @kindex W T l (Summary)
6538 @findex gnus-article-date-local
6539 Display the date in the local timezone (@code{gnus-article-date-local}).
6540
6541 @item W T s
6542 @kindex W T s (Summary)
6543 @vindex gnus-article-time-format
6544 @findex gnus-article-date-user
6545 @findex format-time-string
6546 Display the date using a user-defined format
6547 (@code{gnus-article-date-user}).  The format is specified by the
6548 @code{gnus-article-time-format} variable, and is a string that's passed
6549 to @code{format-time-string}.  See the documentation of that variable
6550 for a list of possible format specs.
6551
6552 @item W T e
6553 @kindex W T e (Summary)
6554 @findex gnus-article-date-lapsed
6555 @findex gnus-start-date-timer
6556 @findex gnus-stop-date-timer
6557 Say how much time has elapsed between the article was posted and now
6558 (@code{gnus-article-date-lapsed}).  If you want to have this line
6559 updated continually, you can put
6560
6561 @lisp
6562 (gnus-start-date-timer)
6563 @end lisp
6564
6565 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6566 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6567 command.
6568
6569 @item W T o
6570 @kindex W T o (Summary)
6571 @findex gnus-article-date-original
6572 Display the original date (@code{gnus-article-date-original}).  This can
6573 be useful if you normally use some other conversion function and are
6574 worried that it might be doing something totally wrong.  Say, claiming
6575 that the article was posted in 1854.  Although something like that is
6576 @emph{totally} impossible.  Don't you trust me? *titter*
6577
6578 @end table
6579
6580
6581 @node Article Signature
6582 @subsection Article Signature
6583 @cindex signatures
6584 @cindex article signature
6585
6586 @vindex gnus-signature-separator
6587 Each article is divided into two parts---the head and the body.  The
6588 body can be divided into a signature part and a text part.  The variable
6589 that says what is to be considered a signature is
6590 @code{gnus-signature-separator}.  This is normally the standard
6591 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6592 non-standard signature separators, so this variable can also be a list
6593 of regular expressions to be tested, one by one.  (Searches are done
6594 from the end of the body towards the beginning.)  One likely value is:
6595
6596 @lisp
6597 (setq gnus-signature-separator
6598       '("^-- $"         ; The standard
6599         "^-- *$"        ; A common mangling
6600         "^-------*$"    ; Many people just use a looong 
6601                         ; line of dashes.  Shame!
6602         "^ *--------*$" ; Double-shame!
6603         "^________*$"   ; Underscores are also popular
6604         "^========*$")) ; Pervert!
6605 @end lisp
6606
6607 The more permissive you are, the more likely it is that you'll get false
6608 positives.
6609
6610 @vindex gnus-signature-limit
6611 @code{gnus-signature-limit} provides a limit to what is considered a
6612 signature. 
6613
6614 @enumerate
6615 @item 
6616 If it is an integer, no signature may be longer (in characters) than
6617 that integer.
6618 @item 
6619 If it is a floating point number, no signature may be longer (in lines)
6620 than that number.
6621 @item 
6622 If it is a function, the function will be called without any parameters,
6623 and if it returns @code{nil}, there is no signature in the buffer.
6624 @item
6625 If it is a string, it will be used as a regexp.  If it matches, the text
6626 in question is not a signature.
6627 @end enumerate
6628
6629 This variable can also be a list where the elements may be of the types
6630 listed above.  Here's an example:
6631
6632 @lisp
6633 (setq gnus-signature-limit
6634       '(200.0 "^---*Forwarded article"))
6635 @end lisp
6636
6637 This means that if there are more than 200 lines after the signature
6638 separator, or the text after the signature separator is matched by
6639 the regular expression @samp{^---*Forwarded article}, then it isn't a
6640 signature after all.
6641
6642
6643 @node Article Commands
6644 @section Article Commands
6645
6646 @table @kbd
6647
6648 @item A P
6649 @cindex PostScript
6650 @cindex printing
6651 @kindex A P (Summary)
6652 @vindex gnus-ps-print-hook
6653 @findex gnus-summary-print-article 
6654 Generate and print a PostScript image of the article buffer
6655 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6656 run just before printing the buffer.
6657
6658 @end table
6659
6660
6661 @node Summary Sorting
6662 @section Summary Sorting
6663 @cindex summary sorting
6664
6665 You can have the summary buffer sorted in various ways, even though I
6666 can't really see why you'd want that.
6667
6668 @table @kbd
6669
6670 @item C-c C-s C-n
6671 @kindex C-c C-s C-n (Summary)
6672 @findex gnus-summary-sort-by-number
6673 Sort by article number (@code{gnus-summary-sort-by-number}).
6674
6675 @item C-c C-s C-a
6676 @kindex C-c C-s C-a (Summary)
6677 @findex gnus-summary-sort-by-author
6678 Sort by author (@code{gnus-summary-sort-by-author}).
6679
6680 @item C-c C-s C-s
6681 @kindex C-c C-s C-s (Summary)
6682 @findex gnus-summary-sort-by-subject
6683 Sort by subject (@code{gnus-summary-sort-by-subject}).
6684
6685 @item C-c C-s C-d
6686 @kindex C-c C-s C-d (Summary)
6687 @findex gnus-summary-sort-by-date
6688 Sort by date (@code{gnus-summary-sort-by-date}).
6689
6690 @item C-c C-s C-l
6691 @kindex C-c C-s C-l (Summary)
6692 @findex gnus-summary-sort-by-lines
6693 Sort by lines (@code{gnus-summary-sort-by-lines}).
6694
6695 @item C-c C-s C-i
6696 @kindex C-c C-s C-i (Summary)
6697 @findex gnus-summary-sort-by-score
6698 Sort by score (@code{gnus-summary-sort-by-score}).
6699 @end table
6700
6701 These functions will work both when you use threading and when you don't
6702 use threading.  In the latter case, all summary lines will be sorted,
6703 line by line.  In the former case, sorting will be done on a
6704 root-by-root basis, which might not be what you were looking for.  To
6705 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6706 Commands}).
6707
6708
6709 @node Finding the Parent
6710 @section Finding the Parent
6711 @cindex parent articles
6712 @cindex referring articles
6713
6714 @table @kbd
6715 @item ^
6716 @kindex ^ (Summary)
6717 @findex gnus-summary-refer-parent-article
6718 If you'd like to read the parent of the current article, and it is not
6719 displayed in the summary buffer, you might still be able to.  That is,
6720 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6721 and the @code{References} in the current article are not mangled, you
6722 can just press @kbd{^} or @kbd{A r}
6723 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6724 you'll get the parent.  If the parent is already displayed in the
6725 summary buffer, point will just move to this article.
6726
6727 If given a positive numerical prefix, fetch that many articles back into
6728 the ancestry.  If given a negative numerical prefix, fetch just that
6729 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6730 grandparent and the grandgrandparent of the current article.  If you say
6731 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6732 article. 
6733
6734 @item A R (Summary)
6735 @findex gnus-summary-refer-references
6736 @kindex A R (Summary)
6737 Fetch all articles mentioned in the @code{References} header of the
6738 article (@code{gnus-summary-refer-references}).
6739
6740 @item A T (Summary)
6741 @findex gnus-summary-refer-thread
6742 @kindex A T (Summary)
6743 Display the full thread where the current article appears
6744 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
6745 headers in the current group to work, so it usually takes a while.  If
6746 you do it often, you may consider setting @code{gnus-fetch-old-headers}
6747 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
6748 visible effects normally, but it'll make this command work a whole lot
6749 faster.  Of course, it'll make group entry somewhat slow.
6750
6751 @vindex gnus-refer-thread-limit
6752 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
6753 articles before the first displayed in the current group) headers to
6754 fetch when doing this command.  The default is 200.  If @code{t}, all
6755 the available headers will be fetched.  This variable can be overridden
6756 by giving the @kbd{A T} command a numerical prefix.
6757
6758 @item M-^ (Summary)
6759 @findex gnus-summary-refer-article
6760 @kindex M-^ (Summary)
6761 @cindex Message-ID
6762 @cindex fetching by Message-ID
6763 You can also ask the @sc{nntp} server for an arbitrary article, no
6764 matter what group it belongs to.  @kbd{M-^}
6765 (@code{gnus-summary-refer-article}) will ask you for a
6766 @code{Message-ID}, which is one of those long, hard-to-read thingies
6767 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6768 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6769 @end table
6770
6771 The current select method will be used when fetching by
6772 @code{Message-ID} from non-news select method, but you can override this
6773 by giving this command a prefix.
6774
6775 @vindex gnus-refer-article-method
6776 If the group you are reading is located on a backend that does not
6777 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6778 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6779 would, perhaps, be best if the @sc{nntp} server you consult is the one
6780 updating the spool you are reading from, but that's not really
6781 necessary.
6782
6783 Most of the mail backends support fetching by @code{Message-ID}, but do
6784 not do a particularly excellent job at it.  That is, @code{nnmbox} and
6785 @code{nnbabyl} are able to locate articles from any groups, while
6786 @code{nnml} and @code{nnfolder} are only able to locate articles that
6787 have been posted to the current group.  (Anything else would be too time
6788 consuming.)  @code{nnmh} does not support this at all.
6789
6790
6791 @node Alternative Approaches
6792 @section Alternative Approaches
6793
6794 Different people like to read news using different methods.  This being
6795 Gnus, we offer a small selection of minor modes for the summary buffers.
6796
6797 @menu
6798 * Pick and Read::               First mark articles and then read them.
6799 * Binary Groups::               Auto-decode all articles.
6800 @end menu
6801
6802
6803 @node Pick and Read
6804 @subsection Pick and Read
6805 @cindex pick and read
6806
6807 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6808 a two-phased reading interface.  The user first marks in a summary
6809 buffer the articles she wants to read.  Then she starts reading the
6810 articles with just an article buffer displayed.
6811
6812 @findex gnus-pick-mode
6813 @kindex M-x gnus-pick-mode
6814 Gnus provides a summary buffer minor mode that allows
6815 this---@code{gnus-pick-mode}.  This basically means that a few process
6816 mark commands become one-keystroke commands to allow easy marking, and
6817 it provides one additional command for switching to the summary buffer.
6818
6819 Here are the available keystrokes when using pick mode:
6820
6821 @table @kbd
6822 @item .
6823 @kindex . (Pick)
6824 @findex gnus-summary-mark-as-processable
6825 Pick the article on the current line
6826 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6827 go to that article and pick it.  (The line number is normally displayed
6828 at the beginning of the summary pick lines.)
6829
6830 @item SPACE
6831 @kindex SPACE (Pick)
6832 @findex gnus-pick-next-page
6833 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6834 at the end of the buffer, start reading the picked articles.
6835
6836 @item u
6837 @kindex u (Pick)
6838 @findex gnus-summary-unmark-as-processable
6839 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6840
6841 @item U
6842 @kindex U (Pick)
6843 @findex gnus-summary-unmark-all-processable
6844 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6845
6846 @item t
6847 @kindex t (Pick)
6848 @findex gnus-uu-mark-thread
6849 Pick the thread (@code{gnus-uu-mark-thread}). 
6850
6851 @item T
6852 @kindex T (Pick)
6853 @findex gnus-uu-unmark-thread
6854 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6855
6856 @item r
6857 @kindex r (Pick)
6858 @findex gnus-uu-mark-region
6859 Pick the region (@code{gnus-uu-mark-region}). 
6860
6861 @item R
6862 @kindex R (Pick)
6863 @findex gnus-uu-unmark-region
6864 Unpick the region (@code{gnus-uu-unmark-region}). 
6865
6866 @item e
6867 @kindex e (Pick)
6868 @findex gnus-uu-mark-by-regexp
6869 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6870
6871 @item E
6872 @kindex E (Pick)
6873 @findex gnus-uu-unmark-by-regexp
6874 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6875
6876 @item b
6877 @kindex b (Pick)
6878 @findex gnus-uu-mark-buffer
6879 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6880
6881 @item B
6882 @kindex B (Pick)
6883 @findex gnus-uu-unmark-buffer
6884 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6885
6886 @item RET
6887 @kindex RET (Pick)
6888 @findex gnus-pick-start-reading
6889 @vindex gnus-pick-display-summary
6890 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6891 given a prefix, mark all unpicked articles as read first.  If
6892 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6893 will still be visible when you are reading.
6894
6895 @end table
6896
6897 If this sounds like a good idea to you, you could say:
6898
6899 @lisp
6900 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6901 @end lisp
6902
6903 @vindex gnus-pick-mode-hook
6904 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6905
6906 @vindex gnus-mark-unpicked-articles-as-read
6907 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6908 all unpicked articles as read.  The default is @code{nil}.
6909
6910 @vindex gnus-summary-pick-line-format
6911 The summary line format in pick mode is slightly different from the
6912 standard format.  At the beginning of each line the line number is
6913 displayed.  The pick mode line format is controlled by the
6914 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6915 Variables}).  It accepts the same format specs that
6916 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6917
6918
6919 @node Binary Groups
6920 @subsection Binary Groups
6921 @cindex binary groups
6922
6923 @findex gnus-binary-mode
6924 @kindex M-x gnus-binary-mode
6925 If you spend much time in binary groups, you may grow tired of hitting
6926 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6927 is a minor mode for summary buffers that makes all ordinary Gnus article
6928 selection functions uudecode series of articles and display the result
6929 instead of just displaying the articles the normal way.  
6930
6931 @kindex g (Binary)
6932 @findex gnus-binary-show-article
6933 The only way, in fact, to see the actual articles is the @kbd{g}
6934 command, when you have turned on this mode
6935 (@code{gnus-binary-show-article}).
6936
6937 @vindex gnus-binary-mode-hook
6938 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6939
6940
6941 @node Tree Display
6942 @section Tree Display
6943 @cindex trees
6944
6945 @vindex gnus-use-trees
6946 If you don't like the normal Gnus summary display, you might try setting
6947 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6948 additional @dfn{tree buffer}.  You can execute all summary mode commands
6949 in the tree buffer.  
6950
6951 There are a few variables to customize the tree display, of course:
6952
6953 @table @code
6954 @item gnus-tree-mode-hook
6955 @vindex gnus-tree-mode-hook
6956 A hook called in all tree mode buffers.
6957
6958 @item gnus-tree-mode-line-format
6959 @vindex gnus-tree-mode-line-format
6960 A format string for the mode bar in the tree mode buffers.  The default
6961 is @samp{Gnus: %%b %S %Z}.  For a list of valid specs, @pxref{Summary
6962 Buffer Mode Line}. 
6963
6964 @item gnus-selected-tree-face
6965 @vindex gnus-selected-tree-face
6966 Face used for highlighting the selected article in the tree buffer.  The
6967 default is @code{modeline}.
6968
6969 @item gnus-tree-line-format
6970 @vindex gnus-tree-line-format
6971 A format string for the tree nodes.  The name is a bit of a misnomer,
6972 though---it doesn't define a line, but just the node.  The default value
6973 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6974 the name of the poster.  It is vital that all nodes are of the same
6975 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6976
6977 Valid specs are:
6978
6979 @table @samp
6980 @item n
6981 The name of the poster.
6982 @item f
6983 The @code{From} header.
6984 @item N
6985 The number of the article.
6986 @item [
6987 The opening bracket.
6988 @item ] 
6989 The closing bracket.
6990 @item s
6991 The subject.
6992 @end table
6993
6994 @xref{Formatting Variables}.
6995
6996 Variables related to the display are:
6997
6998 @table @code
6999 @item gnus-tree-brackets
7000 @vindex gnus-tree-brackets
7001 This is used for differentiating between ``real'' articles and
7002 ``sparse'' articles.  The format is @var{((real-open . real-close)
7003 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7004 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7005
7006 @item gnus-tree-parent-child-edges
7007 @vindex gnus-tree-parent-child-edges
7008 This is a list that contains the characters used for connecting parent
7009 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
7010
7011 @end table
7012
7013 @item gnus-tree-minimize-window
7014 @vindex gnus-tree-minimize-window
7015 If this variable is non-@code{nil}, Gnus will try to keep the tree
7016 buffer as small as possible to allow more room for the other Gnus
7017 windows.  If this variable is a number, the tree buffer will never be
7018 higher than that number.  The default is @code{t}.  Note that if you
7019 have several windows displayed side-by-side in a frame and the tree
7020 buffer is one of these, minimizing the tree window will also resize all
7021 other windows displayed next to it.
7022
7023 @item gnus-generate-tree-function
7024 @vindex gnus-generate-tree-function
7025 @findex gnus-generate-horizontal-tree
7026 @findex gnus-generate-vertical-tree
7027 The function that actually generates the thread tree.  Two predefined
7028 functions are available: @code{gnus-generate-horizontal-tree} and
7029 @code{gnus-generate-vertical-tree} (which is the default).
7030
7031 @end table
7032
7033 Here's an example from a horizontal tree buffer:
7034
7035 @example
7036 @{***@}-(***)-[odd]-[Gun]
7037      |      \[Jan]
7038      |      \[odd]-[Eri]
7039      |      \(***)-[Eri]
7040      |            \[odd]-[Paa]
7041      \[Bjo]
7042      \[Gun]
7043      \[Gun]-[Jor]
7044 @end example
7045
7046 Here's the same thread displayed in a vertical tree buffer:
7047
7048 @example
7049 @{***@}
7050   |--------------------------\-----\-----\
7051 (***)                         [Bjo] [Gun] [Gun]
7052   |--\-----\-----\                          |
7053 [odd] [Jan] [odd] (***)                   [Jor]
7054   |           |     |--\
7055 [Gun]       [Eri] [Eri] [odd]
7056                           |
7057                         [Paa]
7058 @end example
7059
7060 If you're using horizontal trees, it might be nice to display the trees
7061 side-by-side with the summary buffer.  You could add something like the
7062 following to your @file{.gnus.el} file:
7063
7064 @lisp
7065 (setq gnus-use-trees t
7066       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7067       gnus-tree-minimize-window nil)
7068 (gnus-add-configuration
7069  '(article
7070    (vertical 1.0
7071              (horizontal 0.25
7072                          (summary 0.75 point)
7073                          (tree 1.0))
7074              (article 1.0))))
7075 @end lisp
7076
7077 @xref{Windows Configuration}.
7078
7079
7080 @node Mail Group Commands
7081 @section Mail Group Commands
7082 @cindex mail group commands
7083
7084 Some commands only make sense in mail groups.  If these commands are
7085 invalid in the current group, they will raise a hell and let you know.
7086
7087 All these commands (except the expiry and edit commands) use the
7088 process/prefix convention (@pxref{Process/Prefix}).
7089
7090 @table @kbd
7091
7092 @item B e
7093 @kindex B e (Summary)
7094 @findex gnus-summary-expire-articles
7095 Expire all expirable articles in the group
7096 (@code{gnus-summary-expire-articles}).
7097
7098 @item B M-C-e
7099 @kindex B M-C-e (Summary)
7100 @findex gnus-summary-expire-articles-now
7101 Delete all the expirable articles in the group
7102 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7103 articles eligible for expiry in the current group will
7104 disappear forever into that big @file{/dev/null} in the sky.
7105
7106 @item B DEL
7107 @kindex B DEL (Summary)
7108 @findex gnus-summary-delete-article
7109 @c @icon{gnus-summary-mail-delete}
7110 Delete the mail article.  This is ``delete'' as in ``delete it from your
7111 disk forever and ever, never to return again.'' Use with caution.
7112 (@code{gnus-summary-delete-article}).
7113
7114 @item B m
7115 @kindex B m (Summary)
7116 @cindex move mail
7117 @findex gnus-summary-move-article
7118 Move the article from one mail group to another
7119 (@code{gnus-summary-move-article}). 
7120
7121 @item B c
7122 @kindex B c (Summary)
7123 @cindex copy mail
7124 @findex gnus-summary-copy-article
7125 @c @icon{gnus-summary-mail-copy}
7126 Copy the article from one group (mail group or not) to a mail group
7127 (@code{gnus-summary-copy-article}).
7128
7129 @item B B
7130 @kindex B B (Summary)
7131 @cindex crosspost mail
7132 @findex gnus-summary-crosspost-article
7133 Crosspost the current article to some other group
7134 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7135 the article in the other group, and the Xref headers of the article will
7136 be properly updated.
7137
7138 @item B i
7139 @kindex B i (Summary)
7140 @findex gnus-summary-import-article
7141 Import an arbitrary file into the current mail newsgroup
7142 (@code{gnus-summary-import-article}).  You will be prompted for a file
7143 name, a @code{From} header and a @code{Subject} header.
7144
7145 @item B r
7146 @kindex B r (Summary)
7147 @findex gnus-summary-respool-article
7148 Respool the mail article (@code{gnus-summary-move-article}).
7149 @code{gnus-summary-respool-default-method} will be used as the default
7150 select method when respooling.  This variable is @code{nil} by default,
7151 which means that the current group select method will be used instead.
7152
7153 @item B w
7154 @itemx e
7155 @kindex B w (Summary)
7156 @kindex e (Summary)
7157 @findex gnus-summary-edit-article
7158 @kindex C-c C-c (Article)
7159 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7160 editing and make the changes permanent, type @kbd{C-c C-c}
7161 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7162 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7163
7164 @item B q
7165 @kindex B q (Summary)
7166 @findex gnus-summary-respool-query
7167 If you want to re-spool an article, you might be curious as to what group
7168 the article will end up in before you do the re-spooling.  This command
7169 will tell you (@code{gnus-summary-respool-query}). 
7170
7171 @item B p
7172 @kindex B p (Summary)
7173 @findex gnus-summary-article-posted-p
7174 Some people have a tendency to send you "courtesy" copies when they
7175 follow up to articles you have posted.  These usually have a
7176 @code{Newsgroups} header in them, but not always.  This command
7177 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7178 article from your news server (or rather, from
7179 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7180 report back whether it found the article or not.  Even if it says that
7181 it didn't find the article, it may have been posted anyway---mail
7182 propagation is much faster than news propagation, and the news copy may
7183 just not have arrived yet.
7184
7185 @end table
7186
7187 @vindex gnus-move-split-methods
7188 @cindex moving articles
7189 If you move (or copy) articles regularly, you might wish to have Gnus
7190 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7191 variable that uses the same syntax as @code{gnus-split-methods}
7192 (@pxref{Saving Articles}).  You may customize that variable to create
7193 suggestions you find reasonable.
7194
7195 @lisp
7196 (setq gnus-move-split-methods
7197       '(("^From:.*Lars Magne" "nnml:junk")
7198         ("^Subject:.*gnus" "nnfolder:important")
7199         (".*" "nnml:misc")))
7200 @end lisp
7201
7202
7203 @node Various Summary Stuff
7204 @section Various Summary Stuff
7205
7206 @menu
7207 * Summary Group Information::         Information oriented commands.
7208 * Searching for Articles::            Multiple article commands.
7209 * Summary Generation Commands::       (Re)generating the summary buffer.
7210 * Really Various Summary Commands::   Those pesky non-conformant commands.
7211 @end menu
7212
7213 @table @code
7214 @vindex gnus-summary-mode-hook
7215 @item gnus-summary-mode-hook
7216 This hook is called when creating a summary mode buffer.
7217
7218 @vindex gnus-summary-generate-hook
7219 @item gnus-summary-generate-hook
7220 This is called as the last thing before doing the threading and the
7221 generation of the summary buffer.  It's quite convenient for customizing
7222 the threading variables based on what data the newsgroup has.  This hook
7223 is called from the summary buffer after most summary buffer variables
7224 have been set.
7225
7226 @vindex gnus-summary-prepare-hook
7227 @item gnus-summary-prepare-hook
7228 It is called after the summary buffer has been generated.  You might use
7229 it to, for instance, highlight lines or modify the look of the buffer in
7230 some other ungodly manner.  I don't care.
7231
7232 @vindex gnus-summary-ignore-duplicates
7233 @item gnus-summary-ignore-duplicates
7234 When Gnus discovers two articles that have the same @code{Message-ID},
7235 it has to do something drastic.  No articles are allowed to have the
7236 same @code{Message-ID}, but this may happen when reading mail from some
7237 sources.  Gnus allows you to customize what happens with this variable.
7238 If it is @code{nil} (which is the default), Gnus will rename the
7239 @code{Message-ID} (for display purposes only) and display the article as
7240 any other article.  If this variable is @code{t}, it won't display the
7241 article---it'll be as if it never existed.
7242
7243 @end table
7244
7245
7246 @node Summary Group Information
7247 @subsection Summary Group Information
7248
7249 @table @kbd
7250
7251 @item H f
7252 @kindex H f (Summary)
7253 @findex gnus-summary-fetch-faq
7254 @vindex gnus-group-faq-directory
7255 Try to fetch the FAQ (list of frequently asked questions) for the
7256 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7257 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7258 on a remote machine.  This variable can also be a list of directories.
7259 In that case, giving a prefix to this command will allow you to choose
7260 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7261 be used for fetching the file.
7262
7263 @item H d
7264 @kindex H d (Summary)
7265 @findex gnus-summary-describe-group
7266 Give a brief description of the current group
7267 (@code{gnus-summary-describe-group}).  If given a prefix, force
7268 rereading the description from the server.
7269
7270 @item H h
7271 @kindex H h (Summary)
7272 @findex gnus-summary-describe-briefly
7273 Give an extremely brief description of the most important summary
7274 keystrokes (@code{gnus-summary-describe-briefly}).
7275
7276 @item H i
7277 @kindex H i (Summary)
7278 @findex gnus-info-find-node
7279 Go to the Gnus info node (@code{gnus-info-find-node}).
7280 @end table
7281
7282
7283 @node Searching for Articles
7284 @subsection Searching for Articles
7285
7286 @table @kbd
7287
7288 @item M-s
7289 @kindex M-s (Summary)
7290 @findex gnus-summary-search-article-forward
7291 Search through all subsequent articles for a regexp
7292 (@code{gnus-summary-search-article-forward}). 
7293
7294 @item M-r
7295 @kindex M-r (Summary)
7296 @findex gnus-summary-search-article-backward
7297 Search through all previous articles for a regexp
7298 (@code{gnus-summary-search-article-backward}). 
7299
7300 @item &
7301 @kindex & (Summary)
7302 @findex gnus-summary-execute-command
7303 This command will prompt you for a header field, a regular expression to
7304 match on this field, and a command to be executed if the match is made
7305 (@code{gnus-summary-execute-command}).  If given a prefix, search
7306 backward instead.
7307
7308 @item M-&
7309 @kindex M-& (Summary)
7310 @findex gnus-summary-universal-argument
7311 Perform any operation on all articles that have been marked with
7312 the process mark (@code{gnus-summary-universal-argument}).
7313 @end table
7314
7315 @node Summary Generation Commands
7316 @subsection Summary Generation Commands
7317
7318 @table @kbd
7319
7320 @item Y g
7321 @kindex Y g (Summary)
7322 @findex gnus-summary-prepare
7323 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7324
7325 @item Y c 
7326 @kindex Y c (Summary)
7327 @findex gnus-summary-insert-cached-articles
7328 Pull all cached articles (for the current group) into the summary buffer
7329 (@code{gnus-summary-insert-cached-articles}).
7330
7331 @end table
7332
7333
7334 @node Really Various Summary Commands
7335 @subsection Really Various Summary Commands
7336
7337 @table @kbd
7338
7339 @item C-d
7340 @kindex C-d (Summary)
7341 @findex gnus-summary-enter-digest-group
7342 If the current article is a collection of other articles (for instance,
7343 a digest), you might use this command to enter a group based on the that
7344 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7345 guess what article type is currently displayed unless you give a prefix
7346 to this command, which forces a ``digest'' interpretation.  Basically,
7347 whenever you see a message that is a collection of other messages of
7348 some format, you @kbd{C-d} and read these messages in a more convenient
7349 fashion.
7350
7351 @item M-C-d
7352 @kindex M-C-d (Summary)
7353 @findex gnus-summary-read-document
7354 This command is very similar to the one above, but lets you gather
7355 several documents into one biiig group
7356 (@code{gnus-summary-read-document}).  It does this by opening several
7357 @code{nndoc} groups for each document, and then opening an
7358 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7359 command understands the process/prefix convention
7360 (@pxref{Process/Prefix}). 
7361
7362 @item C-t
7363 @kindex C-t (Summary)
7364 @findex gnus-summary-toggle-truncation
7365 Toggle truncation of summary lines
7366 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7367 line centering function in the summary buffer, so it's not a good idea
7368 to have truncation switched off while reading articles.
7369
7370 @item =
7371 @kindex = (Summary)
7372 @findex gnus-summary-expand-window
7373 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7374 If given a prefix, force an @code{article} window configuration. 
7375
7376 @item M-C-e
7377 @kindex M-C-e (Summary)
7378 @findex gnus-summary-edit-parameters
7379 Edit the group parameters (@pxref{Group Parameters}) of the current
7380 group (@code{gnus-summary-edit-parameters}).
7381
7382 @end table
7383
7384
7385 @node Exiting the Summary Buffer
7386 @section Exiting the Summary Buffer
7387 @cindex summary exit
7388 @cindex exiting groups
7389
7390 Exiting from the summary buffer will normally update all info on the
7391 group and return you to the group buffer. 
7392
7393 @table @kbd
7394
7395 @item Z Z
7396 @itemx q
7397 @kindex Z Z (Summary)
7398 @kindex q (Summary)
7399 @findex gnus-summary-exit
7400 @vindex gnus-summary-exit-hook
7401 @vindex gnus-summary-prepare-exit-hook
7402 @c @icon{gnus-summary-exit}
7403 Exit the current group and update all information on the group
7404 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7405 called before doing much of the exiting, which calls
7406 @code{gnus-summary-expire-articles} by default.
7407 @code{gnus-summary-exit-hook} is called after finishing the exit
7408 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7409 group mode having no more (unread) groups.
7410
7411 @item Z E
7412 @itemx Q
7413 @kindex Z E (Summary)
7414 @kindex Q (Summary)
7415 @findex gnus-summary-exit-no-update
7416 Exit the current group without updating any information on the group
7417 (@code{gnus-summary-exit-no-update}).
7418
7419 @item Z c
7420 @itemx c
7421 @kindex Z c (Summary)
7422 @kindex c (Summary)
7423 @findex gnus-summary-catchup-and-exit
7424 @c @icon{gnus-summary-catchup-and-exit}
7425 Mark all unticked articles in the group as read and then exit
7426 (@code{gnus-summary-catchup-and-exit}).
7427
7428 @item Z C
7429 @kindex Z C (Summary)
7430 @findex gnus-summary-catchup-all-and-exit
7431 Mark all articles, even the ticked ones, as read and then exit
7432 (@code{gnus-summary-catchup-all-and-exit}).
7433
7434 @item Z n
7435 @kindex Z n (Summary)
7436 @findex gnus-summary-catchup-and-goto-next-group
7437 Mark all articles as read and go to the next group
7438 (@code{gnus-summary-catchup-and-goto-next-group}). 
7439
7440 @item Z R
7441 @kindex Z R (Summary)
7442 @findex gnus-summary-reselect-current-group
7443 Exit this group, and then enter it again
7444 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7445 all articles, both read and unread.
7446
7447 @item Z G
7448 @itemx M-g
7449 @kindex Z G (Summary)
7450 @kindex M-g (Summary)
7451 @findex gnus-summary-rescan-group
7452 @c @icon{gnus-summary-mail-get}
7453 Exit the group, check for new articles in the group, and select the
7454 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7455 articles, both read and unread.
7456
7457 @item Z N
7458 @kindex Z N (Summary)
7459 @findex gnus-summary-next-group
7460 Exit the group and go to the next group
7461 (@code{gnus-summary-next-group}). 
7462
7463 @item Z P
7464 @kindex Z P (Summary)
7465 @findex gnus-summary-prev-group
7466 Exit the group and go to the previous group
7467 (@code{gnus-summary-prev-group}). 
7468
7469 @item Z s
7470 @kindex Z s (Summary)
7471 @findex gnus-summary-save-newsrc
7472 Save the current number of read/marked articles in the dribble buffer
7473 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7474 given a prefix, also save the @file{.newsrc} file(s).  Using this
7475 command will make exit without updating (the @kbd{Q} command) worthless.
7476 @end table
7477
7478 @vindex gnus-exit-group-hook
7479 @code{gnus-exit-group-hook} is called when you exit the current
7480 group.  
7481
7482 @findex gnus-summary-wake-up-the-dead
7483 @findex gnus-dead-summary-mode
7484 @vindex gnus-kill-summary-on-exit
7485 If you're in the habit of exiting groups, and then changing your mind
7486 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7487 If you do that, Gnus won't kill the summary buffer when you exit it.
7488 (Quelle surprise!)  Instead it will change the name of the buffer to
7489 something like @samp{*Dead Summary ... *} and install a minor mode
7490 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7491 buffer, you'll find that all keys are mapped to a function called
7492 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7493 summary buffer will result in a live, normal summary buffer.  
7494
7495 There will never be more than one dead summary buffer at any one time. 
7496
7497 @vindex gnus-use-cross-reference
7498 The data on the current group will be updated (which articles you have
7499 read, which articles you have replied to, etc.) when you exit the
7500 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7501 @code{t} (which is the default), articles that are cross-referenced to
7502 this group and are marked as read, will also be marked as read in the
7503 other subscribed groups they were cross-posted to.  If this variable is
7504 neither @code{nil} nor @code{t}, the article will be marked as read in
7505 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7506
7507
7508 @node Crosspost Handling
7509 @section Crosspost Handling
7510
7511 @cindex velveeta
7512 @cindex spamming
7513 Marking cross-posted articles as read ensures that you'll never have to
7514 read the same article more than once.  Unless, of course, somebody has
7515 posted it to several groups separately.  Posting the same article to
7516 several groups (not cross-posting) is called @dfn{spamming}, and you are
7517 by law required to send nasty-grams to anyone who perpetrates such a
7518 heinous crime.  You may want to try NoCeM handling to filter out spam
7519 (@pxref{NoCeM}). 
7520
7521 Remember: Cross-posting is kinda ok, but posting the same article
7522 separately to several groups is not.  Massive cross-posting (aka.
7523 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7524 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7525 excessive crossposting (@pxref{Summary Mail Commands}).
7526
7527 @cindex cross-posting
7528 @cindex Xref
7529 @cindex @sc{nov}
7530 One thing that may cause Gnus to not do the cross-posting thing
7531 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7532 (which is very nice, because it speeds things up considerably) which
7533 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7534 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7535 even with @sc{xover} by registering the @code{Xref} lines of all
7536 articles you actually read, but if you kill the articles, or just mark
7537 them as read without reading them, Gnus will not get a chance to snoop
7538 the @code{Xref} lines out of these articles, and will be unable to use
7539 the cross reference mechanism.
7540
7541 @cindex LIST overview.fmt
7542 @cindex overview.fmt
7543 To check whether your @sc{nntp} server includes the @code{Xref} header
7544 in its overview files, try @samp{telnet your.nntp.server nntp},
7545 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7546 overview.fmt}.  This may not work, but if it does, and the last line you
7547 get does not read @samp{Xref:full}, then you should shout and whine at
7548 your news admin until she includes the @code{Xref} header in the
7549 overview files.
7550
7551 @vindex gnus-nov-is-evil
7552 If you want Gnus to get the @code{Xref}s right all the time, you have to
7553 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7554 considerably.
7555
7556 C'est la vie.
7557
7558 For an alternative approach, @pxref{Duplicate Suppression}.
7559
7560
7561 @node Duplicate Suppression
7562 @section Duplicate Suppression
7563
7564 By default, Gnus tries to make sure that you don't have to read the same
7565 article more than once by utilizing the crossposting mechanism
7566 (@pxref{Crosspost Handling}).  However, that simple and efficient
7567 approach may not work satisfactory for some users for various
7568 reasons.  
7569
7570 @enumerate
7571 @item 
7572 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7573 is evil and not very common.
7574
7575 @item 
7576 The @sc{nntp} server may fail to include the @code{Xref} header in the
7577 @file{.overview} data bases.  This is evil and all too common, alas.
7578
7579 @item
7580 You may be reading the same group (or several related groups) from
7581 different @sc{nntp} servers.
7582
7583 @item
7584 You may be getting mail that duplicates articles posted to groups.
7585 @end enumerate
7586
7587 I'm sure there are other situations where @code{Xref} handling fails as
7588 well, but these four are the most common situations.
7589
7590 If, and only if, @code{Xref} handling fails for you, then you may
7591 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7592 will remember the @code{Message-ID}s of all articles you have read or
7593 otherwise marked as read, and then, as if by magic, mark them as read
7594 all subsequent times you see them---in @emph{all} groups.  Using this
7595 mechanism is quite likely to be somewhat inefficient, but not overly
7596 so.  It's certainly preferable to reading the same articles more than
7597 once.
7598
7599 Duplicate suppression is not a very subtle instrument.  It's more like a
7600 sledge hammer than anything else.  It works in a very simple
7601 fashion---if you have marked an article as read, it adds this Message-ID
7602 to a cache.  The next time it sees this Message-ID, it will mark the
7603 article as read with the @samp{M} mark.  It doesn't care what group it
7604 saw the article in.
7605
7606 @table @code
7607 @item gnus-suppress-duplicates
7608 @vindex gnus-suppress-duplicates
7609 If non-@code{nil}, suppress duplicates.
7610
7611 @item gnus-save-duplicate-list
7612 @vindex gnus-save-duplicate-list
7613 If non-@code{nil}, save the list of duplicates to a file.  This will
7614 make startup and shutdown take longer, so the default is @code{nil}.
7615 However, this means that only duplicate articles read in a single Gnus
7616 session are suppressed.
7617
7618 @item gnus-duplicate-list-length
7619 @vindex gnus-duplicate-list-length
7620 This variable says how many @code{Message-ID}s to keep in the duplicate
7621 suppression list.  The default is 10000.  
7622
7623 @item gnus-duplicate-file
7624 @vindex gnus-duplicate-file
7625 The name of the file to store the duplicate suppression list in.  The
7626 default is @file{~/News/suppression}.
7627 @end table
7628
7629 If you have a tendency to stop and start Gnus often, setting
7630 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7631 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7632 the other hand, saving the list makes startup and shutdown much slower,
7633 so that means that if you stop and start Gnus often, you should set
7634 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7635 to you to figure out, I think.
7636
7637
7638 @node The Article Buffer
7639 @chapter The Article Buffer
7640 @cindex article buffer
7641
7642 The articles are displayed in the article buffer, of which there is only
7643 one.  All the summary buffers share the same article buffer unless you
7644 tell Gnus otherwise.
7645
7646 @menu
7647 * Hiding Headers::        Deciding what headers should be displayed.
7648 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7649 * Customizing Articles::  Tailoring the look of the articles.
7650 * Article Keymap::        Keystrokes available in the article buffer.
7651 * Misc Article::          Other stuff.
7652 @end menu
7653
7654
7655 @node Hiding Headers
7656 @section Hiding Headers
7657 @cindex hiding headers
7658 @cindex deleting headers
7659
7660 The top section of each article is the @dfn{head}.  (The rest is the
7661 @dfn{body}, but you may have guessed that already.)
7662
7663 @vindex gnus-show-all-headers
7664 There is a lot of useful information in the head: the name of the person
7665 who wrote the article, the date it was written and the subject of the
7666 article.  That's well and nice, but there's also lots of information
7667 most people do not want to see---what systems the article has passed
7668 through before reaching you, the @code{Message-ID}, the
7669 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7670 of some of those lines.  If you want to keep all those lines in the
7671 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7672
7673 Gnus provides you with two variables for sifting headers:
7674
7675 @table @code
7676
7677 @item gnus-visible-headers
7678 @vindex gnus-visible-headers
7679 If this variable is non-@code{nil}, it should be a regular expression
7680 that says what headers you wish to keep in the article buffer.  All
7681 headers that do not match this variable will be hidden.
7682
7683 For instance, if you only want to see the name of the person who wrote
7684 the article and the subject, you'd say:
7685
7686 @lisp
7687 (setq gnus-visible-headers "^From:\\|^Subject:")
7688 @end lisp
7689
7690 This variable can also be a list of regexps to match headers to
7691 remain visible.
7692
7693 @item gnus-ignored-headers
7694 @vindex gnus-ignored-headers
7695 This variable is the reverse of @code{gnus-visible-headers}.  If this
7696 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7697 should be a regular expression that matches all lines that you want to
7698 hide.  All lines that do not match this variable will remain visible.
7699
7700 For instance, if you just want to get rid of the @code{References} line
7701 and the @code{Xref} line, you might say:
7702
7703 @lisp
7704 (setq gnus-ignored-headers "^References:\\|^Xref:")
7705 @end lisp
7706
7707 This variable can also be a list of regexps to match headers to
7708 be removed.
7709
7710 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7711 variable will have no effect.
7712
7713 @end table
7714
7715 @vindex gnus-sorted-header-list
7716 Gnus can also sort the headers for you.  (It does this by default.)  You
7717 can control the sorting by setting the @code{gnus-sorted-header-list}
7718 variable.  It is a list of regular expressions that says in what order
7719 the headers are to be displayed.
7720
7721 For instance, if you want the name of the author of the article first,
7722 and then the subject, you might say something like:
7723
7724 @lisp
7725 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7726 @end lisp
7727
7728 Any headers that are to remain visible, but are not listed in this
7729 variable, will be displayed in random order after all the headers listed in this variable.
7730
7731 @findex gnus-article-hide-boring-headers
7732 @vindex gnus-article-display-hook
7733 @vindex gnus-boring-article-headers
7734 You can hide further boring headers by entering
7735 @code{gnus-article-hide-boring-headers} into
7736 @code{gnus-article-display-hook}.  What this function does depends on
7737 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7738 list doesn't actually contain header names.  Instead is lists various
7739 @dfn{boring conditions} that Gnus can check and remove from sight.
7740
7741 These conditions are:
7742 @table @code
7743 @item empty
7744 Remove all empty headers.
7745 @item newsgroups
7746 Remove the @code{Newsgroups} header if it only contains the current group
7747 name. 
7748 @item followup-to
7749 Remove the @code{Followup-To} header if it is identical to the
7750 @code{Newsgroups} header.
7751 @item reply-to
7752 Remove the @code{Reply-To} header if it lists the same address as the
7753 @code{From} header.
7754 @item date
7755 Remove the @code{Date} header if the article is less than three days
7756 old.
7757 @item long-to
7758 Remove the @code{To} header if it is very long.
7759 @item many-to
7760 Remove all @code{To} headers if there are more than one.
7761 @end table
7762
7763 To include the four first elements, you could say something like;
7764
7765 @lisp
7766 (setq gnus-boring-article-headers 
7767       '(empty newsgroups followup-to reply-to))
7768 @end lisp
7769
7770 This is also the default value for this variable.
7771
7772
7773 @node Using MIME
7774 @section Using @sc{mime}
7775 @cindex @sc{mime}
7776
7777 Mime is a standard for waving your hands through the air, aimlessly,
7778 while people stand around yawning.
7779
7780 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7781 while all newsreaders die of fear.
7782
7783 @sc{mime} may specify what character set the article uses, the encoding
7784 of the characters, and it also makes it possible to embed pictures and
7785 other naughty stuff in innocent-looking articles.
7786
7787 @vindex gnus-show-mime
7788 @vindex gnus-show-mime-method
7789 @vindex gnus-strict-mime
7790 @findex metamail-buffer
7791 Gnus handles @sc{mime} by pushing the articles through
7792 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7793 default.  This function calls the external @code{metamail} program to
7794 actually do the work.  One common problem with this program is that is
7795 thinks that it can't display 8-bit things in the Emacs buffer.  To tell
7796 it the truth, put something like the following in your
7797 @file{.bash_profile} file.  (You do use @code{bash}, don't you?)
7798
7799 @example
7800 export MM_CHARSET="iso-8859-1"
7801 @end example
7802
7803 For more information on @code{metamail}, see its manual page.
7804
7805 Set @code{gnus-show-mime} to @code{t} if you want to use
7806 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7807 non-@code{nil}, the @sc{mime} method will only be used if there are
7808 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7809 set, then you'll see some unfortunate display glitches in the article
7810 buffer.  These can't be avoided.
7811
7812 It might be best to just use the toggling functions from the summary
7813 buffer to avoid getting nasty surprises. (For instance, you enter the
7814 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7815 decoded the sound file in the article and some horrible sing-a-long song
7816 comes screaming out your speakers, and you can't find the volume
7817 button, because there isn't one, and people are starting to look at you,
7818 and you try to stop the program, but you can't, and you can't find the
7819 program to control the volume, and everybody else in the room suddenly
7820 decides to look at you disdainfully, and you'll feel rather stupid.)
7821
7822 Any similarity to real events and people is purely coincidental.  Ahem.
7823
7824
7825 @node Customizing Articles
7826 @section Customizing Articles
7827 @cindex article customization
7828
7829 @vindex gnus-article-display-hook
7830 The @code{gnus-article-display-hook} is called after the article has
7831 been inserted into the article buffer.  It is meant to handle all
7832 treatment of the article before it is displayed. 
7833
7834 @findex gnus-article-maybe-highlight
7835 By default this hook just contains @code{gnus-article-hide-headers},
7836 @code{gnus-article-treat-overstrike}, and
7837 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7838 millions, of functions you can put in this hook.  For an overview of
7839 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7840 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7841 Date}.  Note that the order of functions in this hook might affect
7842 things, so you may have to fiddle a bit to get the desired results. 
7843
7844 You can, of course, write your own functions.  The functions are called
7845 from the article buffer, and you can do anything you like, pretty much.
7846 There is no information that you have to keep in the buffer---you can
7847 change everything.  However, you shouldn't delete any headers.  Instead
7848 make them invisible if you want to make them go away.
7849
7850
7851 @node Article Keymap
7852 @section Article Keymap
7853
7854 Most of the keystrokes in the summary buffer can also be used in the
7855 article buffer.  They should behave as if you typed them in the summary
7856 buffer, which means that you don't actually have to have a summary
7857 buffer displayed while reading.  You can do it all from the article
7858 buffer.
7859
7860 A few additional keystrokes are available:
7861
7862 @table @kbd
7863
7864 @item SPACE
7865 @kindex SPACE (Article)
7866 @findex gnus-article-next-page
7867 Scroll forwards one page (@code{gnus-article-next-page}).
7868
7869 @item DEL
7870 @kindex DEL (Article)
7871 @findex gnus-article-prev-page
7872 Scroll backwards one page (@code{gnus-article-prev-page}).
7873
7874 @item C-c ^
7875 @kindex C-c ^ (Article)
7876 @findex gnus-article-refer-article
7877 If point is in the neighborhood of a @code{Message-ID} and you press
7878 @kbd{r}, Gnus will try to get that article from the server
7879 (@code{gnus-article-refer-article}).
7880
7881 @item C-c C-m
7882 @kindex C-c C-m (Article)
7883 @findex gnus-article-mail
7884 Send a reply to the address near point (@code{gnus-article-mail}).  If
7885 given a prefix, include the mail.
7886
7887 @item s
7888 @kindex s (Article)
7889 @findex gnus-article-show-summary
7890 Reconfigure the buffers so that the summary buffer becomes visible
7891 (@code{gnus-article-show-summary}).
7892
7893 @item ?
7894 @kindex ? (Article)
7895 @findex gnus-article-describe-briefly
7896 Give a very brief description of the available keystrokes
7897 (@code{gnus-article-describe-briefly}). 
7898
7899 @item TAB
7900 @kindex TAB (Article)
7901 @findex gnus-article-next-button
7902 Go to the next button, if any (@code{gnus-article-next-button}).  This
7903 only makes sense if you have buttonizing turned on.
7904
7905 @item M-TAB
7906 @kindex M-TAB (Article)
7907 @findex gnus-article-prev-button
7908 Go to the previous button, if any (@code{gnus-article-prev-button}).  
7909
7910 @end table
7911
7912
7913 @node Misc Article
7914 @section Misc Article
7915
7916 @table @code
7917
7918 @item gnus-single-article-buffer
7919 @vindex gnus-single-article-buffer
7920 If non-@code{nil}, use the same article buffer for all the groups.
7921 (This is the default.)  If @code{nil}, each group will have its own
7922 article buffer.
7923
7924 @vindex gnus-article-prepare-hook
7925 @item gnus-article-prepare-hook
7926 This hook is called right after the article has been inserted into the
7927 article buffer.  It is mainly intended for functions that do something
7928 depending on the contents; it should probably not be used for changing
7929 the contents of the article buffer.
7930
7931 @vindex gnus-article-display-hook
7932 @item gnus-article-display-hook
7933 This hook is called as the last thing when displaying an article, and is
7934 intended for modifying the contents of the buffer, doing highlights,
7935 hiding headers, and the like.
7936
7937 @item gnus-article-mode-hook
7938 @vindex gnus-article-mode-hook
7939 Hook called in article mode buffers.
7940
7941 @item gnus-article-mode-syntax-table
7942 @vindex gnus-article-mode-syntax-table
7943 Syntax table used in article buffers.  It is initialized from
7944 @code{text-mode-syntax-table}. 
7945
7946 @vindex gnus-article-mode-line-format
7947 @item gnus-article-mode-line-format
7948 This variable is a format string along the same lines as
7949 @code{gnus-summary-mode-line-format}.  It accepts the same
7950 format specifications as that variable, with one extension:
7951
7952 @table @samp
7953 @item w
7954 The @dfn{wash status} of the article.  This is a short string with one
7955 character for each possible article wash operation that may have been
7956 performed. 
7957 @end table
7958
7959 @vindex gnus-break-pages
7960
7961 @item gnus-break-pages
7962 Controls whether @dfn{page breaking} is to take place.  If this variable
7963 is non-@code{nil}, the articles will be divided into pages whenever a
7964 page delimiter appears in the article.  If this variable is @code{nil},
7965 paging will not be done.
7966
7967 @item gnus-page-delimiter
7968 @vindex gnus-page-delimiter
7969 This is the delimiter mentioned above.  By default, it is @samp{^L}
7970 (formfeed).
7971 @end table
7972
7973
7974 @node Composing Messages
7975 @chapter Composing Messages
7976 @cindex composing messages
7977 @cindex messages
7978 @cindex mail
7979 @cindex sending mail
7980 @cindex reply
7981 @cindex followup
7982 @cindex post
7983
7984 @kindex C-c C-c (Post)
7985 All commands for posting and mailing will put you in a message buffer
7986 where you can edit the article all you like, before you send the article
7987 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7988 Manual}.  If you are in a foreign news group, and you wish to post the
7989 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7990 to make Gnus try to post using the foreign server.
7991
7992 @menu 
7993 * Mail::                 Mailing and replying.
7994 * Post::                 Posting and following up.
7995 * Posting Server::       What server should you post via?
7996 * Mail and Post::        Mailing and posting at the same time.
7997 * Archived Messages::    Where Gnus stores the messages you've sent.
7998 * Drafts::               Postponing messages and rejected messages.
7999 * Rejected Articles::    What happens if the server doesn't like your article?
8000 @end menu
8001
8002 Also see @pxref{Canceling and Superseding} for information on how to
8003 remove articles you shouldn't have posted.
8004
8005
8006 @node Mail
8007 @section Mail
8008
8009 Variables for customizing outgoing mail:
8010
8011 @table @code
8012 @item gnus-uu-digest-headers
8013 @vindex gnus-uu-digest-headers
8014 List of regexps to match headers included in digested messages.  The
8015 headers will be included in the sequence they are matched.
8016
8017 @item gnus-add-to-list
8018 @vindex gnus-add-to-list
8019 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8020 that have none when you do a @kbd{a}.
8021
8022 @end table
8023
8024
8025 @node Post
8026 @section Post
8027
8028 Variables for composing news articles:
8029
8030 @table @code
8031 @item gnus-sent-message-ids-file
8032 @vindex gnus-sent-message-ids-file
8033 Gnus will keep a @code{Message-ID} history file of all the mails it has
8034 sent.  If it discovers that it has already sent a mail, it will ask the
8035 user whether to re-send the mail.  (This is primarily useful when
8036 dealing with @sc{soup} packets and the like where one is apt to send the
8037 same packet multiple times.)  This variable says what the name of this
8038 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8039 this variable to @code{nil} if you don't want Gnus to keep a history
8040 file.
8041
8042 @item gnus-sent-message-ids-length
8043 @vindex gnus-sent-message-ids-length
8044 This variable says how many @code{Message-ID}s to keep in the history
8045 file.  It is 1000 by default.
8046
8047 @end table
8048
8049
8050 @node Posting Server
8051 @section Posting Server
8052
8053 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8054 (extremely intelligent, of course) article, where does it go?
8055
8056 Thank you for asking.  I hate you.
8057
8058 @vindex gnus-post-method
8059
8060 It can be quite complicated.  Normally, Gnus will use the same native
8061 server.  However.  If your native server doesn't allow posting, just
8062 reading, you probably want to use some other server to post your
8063 (extremely intelligent and fabulously interesting) articles.  You can
8064 then set the @code{gnus-post-method} to some other method:
8065
8066 @lisp
8067 (setq gnus-post-method '(nnspool ""))
8068 @end lisp
8069
8070 Now, if you've done this, and then this server rejects your article, or
8071 this server is down, what do you do then?  To override this variable you
8072 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8073 the ``current'' server for posting.
8074
8075 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8076 Gnus will prompt you for what method to use for posting.  
8077
8078 You can also set @code{gnus-post-method} to a list of select methods.
8079 If that's the case, Gnus will always prompt you for what method to use
8080 for posting. 
8081
8082
8083 @node Mail and Post
8084 @section Mail and Post
8085
8086 Here's a list of variables relevant to both mailing and
8087 posting:
8088
8089 @table @code
8090 @item gnus-mailing-list-groups
8091 @findex gnus-mailing-list-groups
8092 @cindex mailing lists
8093
8094 If your news server offers groups that are really mailing lists
8095 gatewayed to the @sc{nntp} server, you can read those groups without
8096 problems, but you can't post/followup to them without some difficulty.
8097 One solution is to add a @code{to-address} to the group parameters
8098 (@pxref{Group Parameters}).  An easier thing to do is set the
8099 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8100 really are mailing lists.  Then, at least, followups to the mailing
8101 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8102 still a pain, though.
8103
8104 @end table
8105
8106 You may want to do spell-checking on messages that you send out.  Or, if
8107 you don't want to spell-check by hand, you could add automatic
8108 spell-checking via the @code{ispell} package:
8109
8110 @cindex ispell
8111 @findex ispell-message
8112 @lisp
8113 (add-hook 'message-send-hook 'ispell-message) 
8114 @end lisp
8115
8116
8117 @node Archived Messages
8118 @section Archived Messages
8119 @cindex archived messages
8120 @cindex sent messages
8121
8122 Gnus provides a few different methods for storing the mail and news you
8123 send.  The default method is to use the @dfn{archive virtual server} to
8124 store the messages.  If you want to disable this completely, the
8125 @code{gnus-message-archive-group} variable should be @code{nil}, which
8126 is the default.
8127
8128 @vindex gnus-message-archive-method
8129 @code{gnus-message-archive-method} says what virtual server Gnus is to
8130 use to store sent messages.  The default is:
8131
8132 @lisp
8133 (nnfolder "archive"
8134           (nnfolder-directory   "~/Mail/archive")
8135           (nnfolder-active-file "~/Mail/archive/active")
8136           (nnfolder-get-new-mail nil)
8137           (nnfolder-inhibit-expiry t))
8138 @end lisp
8139
8140 You can, however, use any mail select method (@code{nnml},
8141 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8142 for doing this sort of thing, though.  If you don't like the default
8143 directory chosen, you could say something like:
8144
8145 @lisp
8146 (setq gnus-message-archive-method
8147       '(nnfolder "archive" 
8148                  (nnfolder-inhibit-expiry t)
8149                  (nnfolder-active-file "~/News/sent-mail/active")
8150                  (nnfolder-directory "~/News/sent-mail/")))
8151 @end lisp
8152
8153 @vindex gnus-message-archive-group
8154 @cindex Gcc
8155 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8156 to one or more group(s) on that server.  Which group to use is
8157 determined by the @code{gnus-message-archive-group} variable.  
8158
8159 This variable can be used to do the following:
8160
8161 @itemize @bullet
8162 @item a string
8163 Messages will be saved in that group.
8164 @item a list of strings
8165 Messages will be saved in all those groups.
8166 @item an alist of regexps, functions and forms
8167 When a key ``matches'', the result is used.
8168 @item @code{nil}
8169 No message archiving will take place.  This is the default.
8170 @end itemize
8171
8172 Let's illustrate:
8173
8174 Just saving to a single group called @samp{MisK}:
8175 @lisp
8176 (setq gnus-message-archive-group "MisK")
8177 @end lisp
8178
8179 Saving to two groups, @samp{MisK} and @samp{safe}:
8180 @lisp
8181 (setq gnus-message-archive-group '("MisK" "safe"))
8182 @end lisp
8183
8184 Save to different groups based on what group you are in:
8185 @lisp
8186 (setq gnus-message-archive-group 
8187       '(("^alt" "sent-to-alt")
8188         ("mail" "sent-to-mail")
8189         (".*" "sent-to-misc")))
8190 @end lisp
8191
8192 More complex stuff:
8193 @lisp
8194 (setq gnus-message-archive-group 
8195       '((if (message-news-p)
8196             "misc-news" 
8197           "misc-mail")))
8198 @end lisp       
8199
8200 How about storing all news messages in one file, but storing all mail
8201 messages in one file per month:
8202
8203 @lisp
8204 (setq gnus-message-archive-group
8205       '((if (message-news-p)
8206             "misc-news" 
8207           (concat "mail." (format-time-string 
8208                            "%Y-%m" (current-time))))))
8209 @end lisp
8210
8211 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8212 use a different value for @code{gnus-message-archive-group} there.)
8213
8214 Now, when you send a message off, it will be stored in the appropriate
8215 group.  (If you want to disable storing for just one particular message,
8216 you can just remove the @code{Gcc} header that has been inserted.)  The
8217 archive group will appear in the group buffer the next time you start
8218 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
8219 enter it and read the articles in it just like you'd read any other
8220 group.  If the group gets really big and annoying, you can simply rename
8221 if (using @kbd{G r} in the group buffer) to something
8222 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8223 continue to be stored in the old (now empty) group.
8224
8225 That's the default method of archiving sent messages.  Gnus offers a
8226 different way for the people who don't like the default method.  In that
8227 case you should set @code{gnus-message-archive-group} to @code{nil};
8228 this will disable archiving.
8229
8230 @table @code
8231 @item gnus-outgoing-message-group 
8232 @vindex gnus-outgoing-message-group 
8233 All outgoing messages will be put in this group.  If you want to store
8234 all your outgoing mail and articles in the group @samp{nnml:archive},
8235 you set this variable to that value.  This variable can also be a list of
8236 group names.
8237
8238 If you want to have greater control over what group to put each
8239 message in, you can set this variable to a function that checks the
8240 current newsgroup name and then returns a suitable group name (or list
8241 of names).
8242
8243 This variable can be used instead of @code{gnus-message-archive-group},
8244 but the latter is the preferred method.
8245 @end table
8246
8247
8248 @c @node Posting Styles
8249 @c @section Posting Styles
8250 @c @cindex posting styles
8251 @c @cindex styles
8252 @c 
8253 @c All them variables, they make my head swim.  
8254 @c 
8255 @c So what if you want a different @code{Organization} and signature based
8256 @c on what groups you post to?  And you post both from your home machine
8257 @c and your work machine, and you want different @code{From} lines, and so
8258 @c on? 
8259 @c 
8260 @c @vindex gnus-posting-styles
8261 @c One way to do stuff like that is to write clever hooks that change the
8262 @c variables you need to have changed.  That's a bit boring, so somebody
8263 @c came up with the bright idea of letting the user specify these things in
8264 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
8265 @c variable: 
8266 @c 
8267 @c @lisp
8268 @c ((".*" 
8269 @c   (signature . "Peace and happiness")
8270 @c   (organization . "What me?"))
8271 @c  ("^comp" 
8272 @c   (signature . "Death to everybody"))
8273 @c  ("comp.emacs.i-love-it" 
8274 @c   (organization . "Emacs is it")))
8275 @c @end lisp
8276 @c 
8277 @c As you might surmise from this example, this alist consists of several
8278 @c @dfn{styles}.  Each style will be applicable if the first element
8279 @c ``matches'', in some form or other.  The entire alist will be iterated
8280 @c over, from the beginning towards the end, and each match will be
8281 @c applied, which means that attributes in later styles that match override
8282 @c the same attributes in earlier matching styles.  So
8283 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
8284 @c signature and the @samp{What me?} @code{Organization} header.
8285 @c 
8286 @c The first element in each style is called the @code{match}.  If it's a
8287 @c string, then Gnus will try to regexp match it against the group name.
8288 @c If it's a function symbol, that function will be called with no
8289 @c arguments.  If it's a variable symbol, then the variable will be
8290 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
8291 @c any case, if this returns a non-@code{nil} value, then the style is said
8292 @c to @dfn{match}.
8293 @c 
8294 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8295 @c attribute consists of a @var{(name . value)} pair.  The attribute name
8296 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
8297 @c attribute name can also be a string.  In that case, this will be used as
8298 @c a header name, and the value will be inserted in the headers of the
8299 @c article.
8300 @c 
8301 @c The attribute value can be a string (used verbatim), a function (the
8302 @c return value will be used), a variable (its value will be used) or a
8303 @c list (it will be @code{eval}ed and the return value will be used).
8304 @c 
8305 @c So here's a new example:
8306 @c 
8307 @c @lisp
8308 @c (setq gnus-posting-styles
8309 @c       '((".*" 
8310 @c           (signature . "~/.signature") 
8311 @c           (from . "user@@foo (user)")
8312 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
8313 @c           (organization . "People's Front Against MWM"))
8314 @c         ("^rec.humor" 
8315 @c           (signature . my-funny-signature-randomizer))
8316 @c         ((equal (system-name) "gnarly")
8317 @c           (signature . my-quote-randomizer))
8318 @c         (posting-from-work-p
8319 @c           (signature . "~/.work-signature")
8320 @c           (from . "user@@bar.foo (user)")
8321 @c           (organization . "Important Work, Inc"))
8322 @c         ("^nn.+:" 
8323 @c           (signature . "~/.mail-signature"))))
8324 @c @end lisp
8325
8326 @node Drafts
8327 @section Drafts
8328 @cindex drafts
8329
8330 If you are writing a message (mail or news) and suddenly remember that
8331 you have a steak in the oven (or some pesto in the food processor, you
8332 craaazy vegetarians), you'll probably wish there was a method to save
8333 the message you are writing so that you can continue editing it some
8334 other day, and send it when you feel its finished.
8335
8336 Well, don't worry about it.  Whenever you start composing a message of
8337 some sort using the Gnus mail and post commands, the buffer you get will
8338 automatically associate to an article in a special @dfn{draft} group.
8339 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8340 article will be saved there.  (Auto-save files also go to the draft
8341 group.) 
8342
8343 @cindex nndraft
8344 @vindex nndraft-directory
8345 The draft group is a special group (which is implemented as an
8346 @code{nndraft} group, if you absolutely have to know) called
8347 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8348 @code{nndraft} is to store its files.  What makes this group special is
8349 that you can't tick any articles in it or mark any articles as
8350 read---all articles in the group are permanently unread.
8351
8352 If the group doesn't exist, it will be created and you'll be subscribed
8353 to it.  The only way to make it disappear from the Group buffer is to
8354 unsubscribe it. 
8355
8356 @c @findex gnus-dissociate-buffer-from-draft
8357 @c @kindex C-c M-d (Mail)
8358 @c @kindex C-c M-d (Post)
8359 @c @findex gnus-associate-buffer-with-draft
8360 @c @kindex C-c C-d (Mail)
8361 @c @kindex C-c C-d (Post)
8362 @c If you're writing some super-secret message that you later want to
8363 @c encode with PGP before sending, you may wish to turn the auto-saving
8364 @c (and association with the draft group) off.  You never know who might be
8365 @c interested in reading all your extremely valuable and terribly horrible
8366 @c and interesting secrets.  The @kbd{C-c M-d}
8367 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8368 @c If you change your mind and want to turn the auto-saving back on again,
8369 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8370 @c 
8371 @c @vindex gnus-use-draft
8372 @c To leave association with the draft group off by default, set
8373 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
8374
8375 @findex gnus-draft-edit-message
8376 @kindex D e (Draft)
8377 When you want to continue editing the article, you simply enter the
8378 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8379 that.  You will be placed in a buffer where you left off.
8380
8381 Rejected articles will also be put in this draft group (@pxref{Rejected
8382 Articles}).
8383
8384 @findex gnus-draft-send-all-messages
8385 @findex gnus-draft-send-message
8386 If you have lots of rejected messages you want to post (or mail) without
8387 doing further editing, you can use the @kbd{D s} command
8388 (@code{gnus-draft-send-message}).  This command understands the
8389 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
8390 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8391 in the buffer.
8392
8393 If you have some messages that you wish not to send, you can use the
8394 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8395 as unsendable.  This is a toggling command.
8396
8397
8398 @node Rejected Articles
8399 @section Rejected Articles
8400 @cindex rejected articles
8401
8402 Sometimes a news server will reject an article.  Perhaps the server
8403 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
8404 @emph{there be demons}.  Perhaps you have included too much cited text.
8405 Perhaps the disk is full.  Perhaps the server is down.
8406
8407 These situations are, of course, totally beyond the control of Gnus.
8408 (Gnus, of course, loves the way you look, always feels great, has angels
8409 fluttering around inside of it, doesn't care about how much cited text
8410 you include, never runs full and never goes down.)  So Gnus saves these
8411 articles until some later time when the server feels better.
8412
8413 The rejected articles will automatically be put in a special draft group
8414 (@pxref{Drafts}).  When the server comes back up again, you'd then
8415 typically enter that group and send all the articles off.
8416
8417
8418 @node Select Methods
8419 @chapter Select Methods
8420 @cindex foreign groups
8421 @cindex select methods
8422
8423 A @dfn{foreign group} is a group not read by the usual (or
8424 default) means.  It could be, for instance, a group from a different
8425 @sc{nntp} server, it could be a virtual group, or it could be your own
8426 personal mail group.
8427
8428 A foreign group (or any group, really) is specified by a @dfn{name} and
8429 a @dfn{select method}.  To take the latter first, a select method is a
8430 list where the first element says what backend to use (e.g. @code{nntp},
8431 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8432 name}.  There may be additional elements in the select method, where the
8433 value may have special meaning for the backend in question.
8434
8435 One could say that a select method defines a @dfn{virtual server}---so
8436 we do just that (@pxref{The Server Buffer}).
8437
8438 The @dfn{name} of the group is the name the backend will recognize the
8439 group as.
8440
8441 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8442 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8443 method @code{(nntp "some.where.edu")}.  Gnus will call this group
8444 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8445 backend just knows this group as @samp{soc.motss}.
8446
8447 The different methods all have their peculiarities, of course.
8448
8449 @menu
8450 * The Server Buffer::     Making and editing virtual servers.
8451 * Getting News::          Reading USENET news with Gnus.
8452 * Getting Mail::          Reading your personal mail with Gnus.
8453 * Other Sources::         Reading directories, files, SOUP packets.
8454 * Combined Groups::       Combining groups into one group.
8455 * Gnus Unplugged::        Reading news and mail offline.
8456 @end menu
8457
8458
8459 @node The Server Buffer
8460 @section The Server Buffer
8461
8462 Traditionally, a @dfn{server} is a machine or a piece of software that
8463 one connects to, and then requests information from.  Gnus does not
8464 connect directly to any real servers, but does all transactions through
8465 one backend or other.  But that's just putting one layer more between
8466 the actual media and Gnus, so we might just as well say that each
8467 backend represents a virtual server.
8468
8469 For instance, the @code{nntp} backend may be used to connect to several
8470 different actual @sc{nntp} servers, or, perhaps, to many different ports
8471 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8472 use, and what parameters to set by specifying a @dfn{select method}.
8473
8474 These select method specifications can sometimes become quite
8475 complicated---say, for instance, that you want to read from the
8476 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8477 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8478 Anyways, if you had to specify that for each group that used this
8479 server, that would be too much work, so Gnus offers a way of naming
8480 select methods, which is what you do in the server buffer.
8481
8482 To enter the server buffer, use the @kbd{^}
8483 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8484
8485 @menu
8486 * Server Buffer Format::      You can customize the look of this buffer.
8487 * Server Commands::           Commands to manipulate servers.
8488 * Example Methods::           Examples server specifications.
8489 * Creating a Virtual Server:: An example session.
8490 * Server Variables::          Which variables to set.
8491 * Servers and Methods::       You can use server names as select methods.
8492 * Unavailable Servers::       Some servers you try to contact may be down.
8493 @end menu
8494
8495 @vindex gnus-server-mode-hook
8496 @code{gnus-server-mode-hook} is run when creating the server buffer.
8497
8498
8499 @node Server Buffer Format
8500 @subsection Server Buffer Format
8501 @cindex server buffer format
8502
8503 @vindex gnus-server-line-format
8504 You can change the look of the server buffer lines by changing the
8505 @code{gnus-server-line-format} variable.  This is a @code{format}-like
8506 variable, with some simple extensions:
8507
8508 @table @samp
8509
8510 @item h 
8511 How the news is fetched---the backend name.
8512
8513 @item n
8514 The name of this server.
8515
8516 @item w
8517 Where the news is to be fetched from---the address.
8518
8519 @item s
8520 The opened/closed/denied status of the server.
8521 @end table
8522
8523 @vindex gnus-server-mode-line-format
8524 The mode line can also be customized by using the
8525 @code{gnus-server-mode-line-format} variable.  The following specs are
8526 understood: 
8527
8528 @table @samp
8529 @item S
8530 Server name.
8531
8532 @item M
8533 Server method.
8534 @end table
8535
8536 Also @pxref{Formatting Variables}.
8537
8538
8539 @node Server Commands
8540 @subsection Server Commands
8541 @cindex server commands
8542
8543 @table @kbd
8544
8545 @item a
8546 @kindex a (Server)
8547 @findex gnus-server-add-server
8548 Add a new server (@code{gnus-server-add-server}).
8549
8550 @item e
8551 @kindex e (Server)
8552 @findex gnus-server-edit-server
8553 Edit a server (@code{gnus-server-edit-server}).
8554
8555 @item SPACE
8556 @kindex SPACE (Server)
8557 @findex gnus-server-read-server
8558 Browse the current server (@code{gnus-server-read-server}).
8559
8560 @item q
8561 @kindex q (Server)
8562 @findex gnus-server-exit
8563 Return to the group buffer (@code{gnus-server-exit}).
8564
8565 @item k
8566 @kindex k (Server)
8567 @findex gnus-server-kill-server
8568 Kill the current server (@code{gnus-server-kill-server}).
8569
8570 @item y
8571 @kindex y (Server)
8572 @findex gnus-server-yank-server
8573 Yank the previously killed server (@code{gnus-server-yank-server}).
8574
8575 @item c
8576 @kindex c (Server)
8577 @findex gnus-server-copy-server
8578 Copy the current server (@code{gnus-server-copy-server}).
8579
8580 @item l
8581 @kindex l (Server)
8582 @findex gnus-server-list-servers
8583 List all servers (@code{gnus-server-list-servers}).
8584
8585 @item s
8586 @kindex s (Server)
8587 @findex gnus-server-scan-server
8588 Request that the server scan its sources for new articles
8589 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8590 servers. 
8591
8592 @item g
8593 @kindex g (Server)
8594 @findex gnus-server-regenerate-server
8595 Request that the server regenerate all its data structures
8596 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8597 a mail backend that has gotten out of synch.
8598
8599 @end table
8600
8601
8602 @node Example Methods
8603 @subsection Example Methods
8604
8605 Most select methods are pretty simple and self-explanatory: 
8606
8607 @lisp
8608 (nntp "news.funet.fi")
8609 @end lisp
8610
8611 Reading directly from the spool is even simpler:
8612
8613 @lisp
8614 (nnspool "")
8615 @end lisp
8616
8617 As you can see, the first element in a select method is the name of the
8618 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8619 will. 
8620
8621 After these two elements, there may be an arbitrary number of
8622 @var{(variable form)} pairs.
8623
8624 To go back to the first example---imagine that you want to read from
8625 port 15 on that machine.  This is what the select method should
8626 look like then:
8627
8628 @lisp
8629 (nntp "news.funet.fi" (nntp-port-number 15))
8630 @end lisp
8631
8632 You should read the documentation to each backend to find out what
8633 variables are relevant, but here's an @code{nnmh} example:
8634
8635 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8636 you have two structures that you wish to access: One is your private
8637 mail spool, and the other is a public one.  Here's the possible spec for
8638 your private mail:
8639
8640 @lisp
8641 (nnmh "private" (nnmh-directory "~/private/mail/"))
8642 @end lisp
8643
8644 (This server is then called @samp{private}, but you may have guessed
8645 that.)
8646
8647 Here's the method for a public spool:
8648
8649 @lisp
8650 (nnmh "public" 
8651       (nnmh-directory "/usr/information/spool/") 
8652       (nnmh-get-new-mail nil))
8653 @end lisp
8654
8655 If you are behind a firewall and only have access to the @sc{nntp}
8656 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8657 on the firewall machine and telnet from there to the @sc{nntp} server.
8658 Doing this can be rather fiddly, but your virtual server definition
8659 should probably look something like this:
8660
8661 @lisp
8662 (nntp "firewall"
8663       (nntp-address "the.firewall.machine")
8664       (nntp-open-connection-function nntp-open-rlogin)
8665       (nntp-end-of-line "\n")
8666       (nntp-rlogin-parameters
8667        ("telnet" "the.real.nntp.host" "nntp")))
8668 @end lisp
8669
8670
8671
8672 @node Creating a Virtual Server
8673 @subsection Creating a Virtual Server
8674
8675 If you're saving lots of articles in the cache by using persistent
8676 articles, you may want to create a virtual server to read the cache.
8677
8678 First you need to add a new server.  The @kbd{a} command does that.  It
8679 would probably be best to use @code{nnspool} to read the cache.  You
8680 could also use @code{nnml} or @code{nnmh}, though.
8681
8682 Type @kbd{a nnspool RET cache RET}.
8683
8684 You should now have a brand new @code{nnspool} virtual server called
8685 @samp{cache}.  You now need to edit it to have the right definitions.
8686 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8687 will contain the following:
8688
8689 @lisp
8690 (nnspool "cache")
8691 @end lisp
8692
8693 Change that to:
8694
8695 @lisp
8696 (nnspool "cache"
8697          (nnspool-spool-directory "~/News/cache/")
8698          (nnspool-nov-directory "~/News/cache/")
8699          (nnspool-active-file "~/News/cache/active"))
8700 @end lisp
8701
8702 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8703 @kbd{RET} over this virtual server, you should be entered into a browse
8704 buffer, and you should be able to enter any of the groups displayed.
8705
8706
8707 @node Server Variables
8708 @subsection Server Variables
8709
8710 One sticky point when defining variables (both on backends and in Emacs
8711 in general) is that some variables are typically initialized from other
8712 variables when the definition of the variables is being loaded.  If you
8713 change the "base" variable after the variables have been loaded, you
8714 won't change the "derived" variables.
8715
8716 This typically affects directory and file variables.  For instance,
8717 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8718 directory variables are initialized from that variable, so
8719 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8720 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8721 @code{nnml-directory}---you have to explicitly set all the file
8722 variables to be what you want them to be.  For a complete list of
8723 variables for each backend, see each backend's section later in this
8724 manual, but here's an example @code{nnml} definition:
8725
8726 @lisp
8727 (nnml "public" 
8728       (nnml-directory "~/my-mail/")
8729       (nnml-active-file "~/my-mail/active")
8730       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8731 @end lisp
8732
8733
8734 @node Servers and Methods
8735 @subsection Servers and Methods
8736
8737 Wherever you would normally use a select method
8738 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8739 when browsing a foreign server) you can use a virtual server name
8740 instead.  This could potentially save lots of typing.  And it's nice all
8741 over.
8742
8743
8744 @node Unavailable Servers
8745 @subsection Unavailable Servers
8746
8747 If a server seems to be unreachable, Gnus will mark that server as
8748 @code{denied}.  That means that any subsequent attempt to make contact
8749 with that server will just be ignored.  ``It can't be opened,'' Gnus
8750 will tell you, without making the least effort to see whether that is
8751 actually the case or not.
8752
8753 That might seem quite naughty, but it does make sense most of the time.
8754 Let's say you have 10 groups subscribed to on server
8755 @samp{nephelococcygia.com}.  This server is located somewhere quite far
8756 away from you and the machine is quite slow, so it takes 1 minute just
8757 to find out that it refuses connection to you today.  If Gnus were to
8758 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8759 attempt to do that.  Once it has gotten a single ``connection refused'',
8760 it will regard that server as ``down''.
8761
8762 So, what happens if the machine was only feeling unwell temporarily?
8763 How do you test to see whether the machine has come up again?
8764
8765 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8766 with the following commands:
8767
8768 @table @kbd
8769
8770 @item O
8771 @kindex O (Server)
8772 @findex gnus-server-open-server
8773 Try to establish connection to the server on the current line
8774 (@code{gnus-server-open-server}).
8775
8776 @item C
8777 @kindex C (Server)
8778 @findex gnus-server-close-server
8779 Close the connection (if any) to the server
8780 (@code{gnus-server-close-server}).
8781
8782 @item D
8783 @kindex D (Server)
8784 @findex gnus-server-deny-server
8785 Mark the current server as unreachable
8786 (@code{gnus-server-deny-server}). 
8787
8788 @item M-o
8789 @kindex M-o (Server)
8790 @findex gnus-server-open-all-servers
8791 Open the connections to all servers in the buffer
8792 (@code{gnus-server-open-all-servers}). 
8793
8794 @item M-c
8795 @kindex M-c (Server)
8796 @findex gnus-server-close-all-servers
8797 Close the connections to all servers in the buffer
8798 (@code{gnus-server-close-all-servers}). 
8799
8800 @item R
8801 @kindex R (Server)
8802 @findex gnus-server-remove-denials
8803 Remove all marks to whether Gnus was denied connection from any servers
8804 (@code{gnus-server-remove-denials}). 
8805
8806 @end table
8807
8808
8809 @node Getting News
8810 @section Getting News
8811 @cindex reading news
8812 @cindex news backends
8813
8814 A newsreader is normally used for reading news.  Gnus currently provides
8815 only two methods of getting news---it can read from an @sc{nntp} server,
8816 or it can read from a local spool.
8817
8818 @menu
8819 * NNTP::               Reading news from an @sc{nntp} server.
8820 * News Spool::         Reading news from the local spool.
8821 @end menu
8822
8823
8824 @node NNTP
8825 @subsection @sc{nntp}
8826 @cindex nntp
8827
8828 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8829 You just specify @code{nntp} as method and the address of the @sc{nntp}
8830 server as the, uhm, address.
8831
8832 If the @sc{nntp} server is located at a non-standard port, setting the
8833 third element of the select method to this port number should allow you
8834 to connect to the right port.  You'll have to edit the group info for
8835 that (@pxref{Foreign Groups}).
8836
8837 The name of the foreign group can be the same as a native group.  In
8838 fact, you can subscribe to the same group from as many different servers
8839 you feel like.  There will be no name collisions.
8840
8841 The following variables can be used to create a virtual @code{nntp}
8842 server: 
8843
8844 @table @code
8845
8846 @item nntp-server-opened-hook
8847 @vindex nntp-server-opened-hook
8848 @cindex @sc{mode reader}
8849 @cindex authinfo
8850 @cindex authentification
8851 @cindex nntp authentification
8852 @findex nntp-send-authinfo
8853 @findex nntp-send-mode-reader
8854 is run after a connection has been made.  It can be used to send
8855 commands to the @sc{nntp} server after it has been contacted.  By
8856 default it sends the command @code{MODE READER} to the server with the
8857 @code{nntp-send-mode-reader} function.  This function should always be
8858 present in this hook.
8859
8860 @item nntp-authinfo-function 
8861 @vindex nntp-authinfo-function 
8862 @findex nntp-send-authinfo
8863 @vindex nntp-authinforc-file
8864 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8865 server.  The default function is @code{nntp-send-authinfo}, which looks
8866 through your @file{~/.authinforc} (or whatever you've set the
8867 @code{nntp-authinforc-file} variable to) for applicable entries.  If
8868 none are found, it will prompt you for a login name and a password.  The
8869 format of the @file{~/.authinforc} file is the same as the @code{ftp}
8870 @file{~/.netrc} file, which is defined in the @code{ftp} manual page,
8871 but here are the salient facts:
8872
8873 @enumerate
8874 @item
8875 The file contains one or more line, each of which define one server.
8876
8877 @item
8878 Each line may contain an arbitrary number of token/value pairs.  The
8879 valid tokens include @samp{machine}, @samp{login}, and @samp{password}.
8880
8881 @end enumerate
8882
8883 Here's an example file:
8884
8885 @example
8886 machine news.uio.no login larsi password geheimnis
8887 machine nntp.ifi.uio.no login larsi
8888 @end example
8889
8890 The token/value pairs may appear in any order; @samp{machine} doesn't
8891 have to be first, for instance.
8892
8893 In this example, both login name and password have been supplied for the
8894 former server, while the latter has only the login name listed, and the
8895 user will be prompted for the password.
8896
8897 Remember to not leave the @file{~/.authinforc} file world-readable.
8898
8899 @item nntp-server-action-alist 
8900 @vindex nntp-server-action-alist 
8901 This is a list of regexps to match on server types and actions to be
8902 taken when matches are made.  For instance, if you want Gnus to beep
8903 every time you connect to innd, you could say something like:
8904
8905 @lisp
8906 (setq nntp-server-action-alist
8907       '(("innd" (ding))))
8908 @end lisp
8909
8910 You probably don't want to do that, though.
8911
8912 The default value is
8913
8914 @lisp
8915 '(("nntpd 1\\.5\\.11t" 
8916    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
8917 @end lisp
8918
8919 This ensures that Gnus doesn't send the @code{MODE READER} command to
8920 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8921
8922 @item nntp-maximum-request
8923 @vindex nntp-maximum-request
8924 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8925 will collect headers by sending a series of @code{head} commands.  To
8926 speed things up, the backend sends lots of these commands without
8927 waiting for reply, and then reads all the replies.  This is controlled
8928 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8929 your network is buggy, you should set this to 1.
8930
8931 @item nntp-connection-timeout
8932 @vindex nntp-connection-timeout
8933 If you have lots of foreign @code{nntp} groups that you connect to
8934 regularly, you're sure to have problems with @sc{nntp} servers not
8935 responding properly, or being too loaded to reply within reasonable
8936 time.  This is can lead to awkward problems, which can be helped
8937 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8938 that says how many seconds the @code{nntp} backend should wait for a
8939 connection before giving up.  If it is @code{nil}, which is the default,
8940 no timeouts are done.
8941
8942 @c @item nntp-command-timeout
8943 @c @vindex nntp-command-timeout
8944 @c @cindex PPP connections
8945 @c @cindex dynamic IP addresses
8946 @c If you're running Gnus on a machine that has a dynamically assigned
8947 @c address, Gnus may become confused.  If the address of your machine
8948 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
8949 @c waiting forever for replies from the server.  To help with this
8950 @c unfortunate problem, you can set this command to a number.  Gnus will
8951 @c then, if it sits waiting for a reply from the server longer than that
8952 @c number of seconds, shut down the connection, start a new one, and resend
8953 @c the command.  This should hopefully be transparent to the user.  A
8954 @c likely number is 30 seconds.
8955 @c 
8956 @c @item nntp-retry-on-break
8957 @c @vindex nntp-retry-on-break
8958 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8959 @c hangs.  This will have much the same effect as the command timeout
8960 @c described above.
8961
8962 @item nntp-server-hook
8963 @vindex nntp-server-hook
8964 This hook is run as the last step when connecting to an @sc{nntp}
8965 server.
8966
8967 @findex nntp-open-rlogin
8968 @findex nntp-open-telnet
8969 @findex nntp-open-network-stream
8970 @item nntp-open-connection-function
8971 @vindex nntp-open-connection-function
8972 This function is used to connect to the remote system.  Three pre-made
8973 functions are @code{nntp-open-network-stream}, which is the default, and
8974 simply connects to some port or other on the remote system.  The other
8975 two are @code{nntp-open-rlogin}, which does an @samp{rlogin} on the
8976 remote system, and then does a @samp{telnet} to the @sc{nntp} server
8977 available there, and @code{nntp-open-telnet}, which does a @samp{telnet}
8978 to the remote system and then another @samp{telnet} to get to the
8979 @sc{nntp} server.
8980
8981 @code{nntp-open-rlogin}-related variables:
8982
8983 @table @code
8984
8985 @item nntp-rlogin-program 
8986 @vindex nntp-rlogin-program 
8987 Program used to log in on remote machines.  The default is @samp{rsh},
8988 but @samp{ssh} is a popular alternative.
8989
8990 @item nntp-rlogin-parameters
8991 @vindex nntp-rlogin-parameters
8992 This list will be used as the parameter list given to @code{rsh}.
8993
8994 @item nntp-rlogin-user-name
8995 @vindex nntp-rlogin-user-name
8996 User name on the remote system.
8997
8998 @end table
8999
9000 @code{nntp-open-telnet}-related variables:
9001
9002 @table @code
9003 @item nntp-telnet-command
9004 @vindex nntp-telnet-command
9005 Command used to start @code{telnet}.
9006
9007 @item nntp-telnet-switches
9008 @vindex nntp-telnet-switches
9009 List of strings to be used as the switches to the @code{telnet} command.
9010
9011 @item nntp-telnet-user-name
9012 @vindex nntp-telnet-user-name
9013 User name for log in on the remote system.
9014
9015 @item nntp-telnet-passwd
9016 @vindex nntp-telnet-passwd
9017 Password to use when logging in.
9018
9019 @item nntp-telnet-parameters
9020 @vindex nntp-telnet-parameters
9021 A list of strings executed as a command after logging in
9022 via @code{telnet}.
9023
9024 @item nntp-telnet-shell-prompt
9025 @vindex nntp-telnet-shell-prompt
9026 Regexp matching the shell prompt on the remote machine.  The default is
9027 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9028
9029 @item nntp-open-telnet-envuser
9030 @vindex nntp-open-telnet-envuser
9031 If non-@code{nil}, the @code{telnet} session (client and server both)
9032 will support the @code{ENVIRON} option and not prompt for login name.
9033 This works for Solaris @code{telnet}, for instance.
9034
9035 @end table
9036
9037 @item nntp-end-of-line
9038 @vindex nntp-end-of-line
9039 String to use as end-of-line marker when talking to the @sc{nntp}
9040 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9041 using @code{rlogin} to talk to the server.
9042
9043 @item nntp-rlogin-user-name
9044 @vindex nntp-rlogin-user-name
9045 User name on the remote system when using the @code{rlogin} connect
9046 function. 
9047
9048 @item nntp-address
9049 @vindex nntp-address
9050 The address of the remote system running the @sc{nntp} server.
9051
9052 @item nntp-port-number
9053 @vindex nntp-port-number
9054 Port number to connect to when using the @code{nntp-open-network-stream}
9055 connect function.
9056
9057 @item nntp-buggy-select
9058 @vindex nntp-buggy-select
9059 Set this to non-@code{nil} if your select routine is buggy.
9060
9061 @item nntp-nov-is-evil 
9062 @vindex nntp-nov-is-evil 
9063 If the @sc{nntp} server does not support @sc{nov}, you could set this
9064 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9065 can be used.
9066
9067 @item nntp-xover-commands
9068 @vindex nntp-xover-commands
9069 @cindex nov
9070 @cindex XOVER
9071 List of strings used as commands to fetch @sc{nov} lines from a
9072 server.  The default value of this variable is @code{("XOVER"
9073 "XOVERVIEW")}. 
9074
9075 @item nntp-nov-gap
9076 @vindex nntp-nov-gap
9077 @code{nntp} normally sends just one big request for @sc{nov} lines to
9078 the server.  The server responds with one huge list of lines.  However,
9079 if you have read articles 2-5000 in the group, and only want to read
9080 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9081 lines that you will not need.  This variable says how
9082 big a gap between two consecutive articles is allowed to be before the
9083 @code{XOVER} request is split into several request.  Note that if your
9084 network is fast, setting this variable to a really small number means
9085 that fetching will probably be slower.  If this variable is @code{nil},
9086 @code{nntp} will never split requests.  The default is 5.
9087
9088 @item nntp-prepare-server-hook
9089 @vindex nntp-prepare-server-hook
9090 A hook run before attempting to connect to an @sc{nntp} server.
9091
9092 @item nntp-warn-about-losing-connection
9093 @vindex nntp-warn-about-losing-connection
9094 If this variable is non-@code{nil}, some noise will be made when a
9095 server closes connection.
9096
9097 @end table
9098
9099
9100 @node News Spool
9101 @subsection News Spool
9102 @cindex nnspool
9103 @cindex news spool
9104
9105 Subscribing to a foreign group from the local spool is extremely easy,
9106 and might be useful, for instance, to speed up reading groups that
9107 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9108 instance. 
9109
9110 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9111 anything else) as the address.
9112
9113 If you have access to a local spool, you should probably use that as the
9114 native select method (@pxref{Finding the News}).  It is normally faster
9115 than using an @code{nntp} select method, but might not be.  It depends.
9116 You just have to try to find out what's best at your site.
9117
9118 @table @code
9119
9120 @item nnspool-inews-program
9121 @vindex nnspool-inews-program
9122 Program used to post an article.
9123
9124 @item nnspool-inews-switches
9125 @vindex nnspool-inews-switches
9126 Parameters given to the inews program when posting an article. 
9127
9128 @item nnspool-spool-directory
9129 @vindex nnspool-spool-directory
9130 Where @code{nnspool} looks for the articles.  This is normally
9131 @file{/usr/spool/news/}.
9132
9133 @item nnspool-nov-directory 
9134 @vindex nnspool-nov-directory 
9135 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9136 @file{/usr/spool/news/over.view/}.
9137
9138 @item nnspool-lib-dir
9139 @vindex nnspool-lib-dir
9140 Where the news lib dir is (@file{/usr/lib/news/} by default).
9141
9142 @item nnspool-active-file
9143 @vindex nnspool-active-file
9144 The path to the active file.
9145
9146 @item nnspool-newsgroups-file
9147 @vindex nnspool-newsgroups-file
9148 The path to the group descriptions file.
9149
9150 @item nnspool-history-file
9151 @vindex nnspool-history-file
9152 The path to the news history file.
9153
9154 @item nnspool-active-times-file
9155 @vindex nnspool-active-times-file
9156 The path to the active date file.
9157
9158 @item nnspool-nov-is-evil
9159 @vindex nnspool-nov-is-evil
9160 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9161 that it finds.
9162
9163 @item nnspool-sift-nov-with-sed
9164 @vindex nnspool-sift-nov-with-sed
9165 @cindex sed
9166 If non-@code{nil}, which is the default, use @code{sed} to get the
9167 relevant portion from the overview file.  If nil, @code{nnspool} will
9168 load the entire file into a buffer and process it there.
9169
9170 @end table
9171
9172
9173 @node Getting Mail
9174 @section Getting Mail
9175 @cindex reading mail
9176 @cindex mail
9177
9178 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9179 course.
9180
9181 @menu
9182 * Getting Started Reading Mail:: A simple cookbook example.
9183 * Splitting Mail::               How to create mail groups.
9184 * Mail Backend Variables::       Variables for customizing mail handling.
9185 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9186 * Mail and Procmail::            Reading mail groups that procmail create.
9187 * Incorporating Old Mail::       What about the old mail you have?
9188 * Expiring Mail::                Getting rid of unwanted mail.
9189 * Washing Mail::                 Removing gruft from the mail you get.
9190 * Duplicates::                   Dealing with duplicated mail.
9191 * Not Reading Mail::             Using mail backends for reading other files.
9192 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9193 @end menu
9194
9195
9196 @node Getting Started Reading Mail
9197 @subsection Getting Started Reading Mail
9198
9199 It's quite easy to use Gnus to read your new mail.  You just plonk the
9200 mail backend of your choice into @code{gnus-secondary-select-methods},
9201 and things will happen automatically.
9202
9203 For instance, if you want to use @code{nnml} (which is a "one file per
9204 mail" backend), you could put the following in your @file{.gnus} file:
9205
9206 @lisp
9207 (setq gnus-secondary-select-methods
9208       '((nnml "private")))
9209 @end lisp
9210
9211 Now, the next time you start Gnus, this backend will be queried for new
9212 articles, and it will move all the messages in your spool file to its
9213 directory, which is @code{~/Mail/} by default.  The new group that will
9214 be created (@samp{mail.misc}) will be subscribed, and you can read it
9215 like any other group.
9216
9217 You will probably want to split the mail into several groups, though:
9218
9219 @lisp
9220 (setq nnmail-split-methods
9221       '(("junk" "^From:.*Lars Ingebrigtsen")
9222         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9223         ("other" "")))
9224 @end lisp
9225
9226 This will result in three new @code{nnml} mail groups being created:
9227 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
9228 mail that doesn't fit into the first two groups will be placed in the
9229 last group.
9230
9231 This should be sufficient for reading mail with Gnus.  You might want to
9232 give the other sections in this part of the manual a perusal, though.
9233 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
9234
9235
9236 @node Splitting Mail
9237 @subsection Splitting Mail
9238 @cindex splitting mail
9239 @cindex mail splitting
9240
9241 @vindex nnmail-split-methods
9242 The @code{nnmail-split-methods} variable says how the incoming mail is
9243 to be split into groups.
9244
9245 @lisp
9246 (setq nnmail-split-methods
9247   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9248     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9249     ("mail.other" "")))
9250 @end lisp
9251
9252 This variable is a list of lists, where the first element of each of
9253 these lists is the name of the mail group (they do not have to be called
9254 something beginning with @samp{mail}, by the way), and the second
9255 element is a regular expression used on the header of each mail to
9256 determine if it belongs in this mail group.  The first string may
9257 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9258 insert sub-expressions from the matched text.  For instance:
9259
9260 @lisp
9261 ("list.\\1" "From:.*\\(.*\\)-list@@majordomo.com")
9262 @end lisp
9263
9264 If the first element is the special symbol @code{junk}, then messages
9265 that match the regexp will disappear into the aether.  Use with
9266 extreme caution. 
9267
9268 The second element can also be a function.  In that case, it will be
9269 called narrowed to the headers with the first element of the rule as the
9270 argument.  It should return a non-@code{nil} value if it thinks that the
9271 mail belongs in that group.
9272
9273 The last of these groups should always be a general one, and the regular
9274 expression should @emph{always} be @samp{} so that it matches any mails
9275 that haven't been matched by any of the other regexps.  (These rules are
9276 processed from the beginning of the alist toward the end.  The first
9277 rule to make a match will "win", unless you have crossposting enabled.
9278 In that case, all matching rules will "win".)
9279
9280 If you like to tinker with this yourself, you can set this variable to a
9281 function of your choice.  This function will be called without any
9282 arguments in a buffer narrowed to the headers of an incoming mail
9283 message.  The function should return a list of group names that it
9284 thinks should carry this mail message.
9285
9286 Note that the mail backends are free to maul the poor, innocent,
9287 incoming headers all they want to.  They all add @code{Lines} headers;
9288 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9289 @code{From<SPACE>} line to something else.
9290
9291 @vindex nnmail-crosspost
9292 The mail backends all support cross-posting.  If several regexps match,
9293 the mail will be ``cross-posted'' to all those groups.
9294 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
9295 that no articles are crossposted to the general (@samp{}) group.
9296
9297 @vindex nnmail-crosspost-link-function
9298 @cindex crosspost
9299 @cindex links
9300 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9301 the crossposted articles.  However, not all file systems support hard
9302 links.  If that's the case for you, set
9303 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
9304 variable is @code{add-name-to-file} by default.)  
9305
9306 @kindex M-x nnmail-split-history
9307 @kindex nnmail-split-history
9308 If you wish to see where the previous mail split put the messages, you
9309 can use the @kbd{M-x nnmail-split-history} command.
9310
9311 Gnus gives you all the opportunity you could possibly want for shooting
9312 yourself in the foot.  Let's say you create a group that will contain
9313 all the mail you get from your boss.  And then you accidentally
9314 unsubscribe from the group.  Gnus will still put all the mail from your
9315 boss in the unsubscribed group, and so, when your boss mails you ``Have
9316 that report ready by Monday or you're fired!'', you'll never see it and,
9317 come Tuesday, you'll still believe that you're gainfully employed while
9318 you really should be out collecting empty bottles to save up for next
9319 month's rent money.
9320
9321
9322 @node Mail Backend Variables
9323 @subsection Mail Backend Variables
9324
9325 These variables are (for the most part) pertinent to all the various
9326 mail backends.
9327
9328 @table @code
9329 @vindex nnmail-read-incoming-hook
9330 @item nnmail-read-incoming-hook
9331 The mail backends all call this hook after reading new mail.  You can
9332 use this hook to notify any mail watch programs, if you want to.
9333
9334 @vindex nnmail-spool-file
9335 @item nnmail-spool-file
9336 @cindex POP mail
9337 @cindex MAILHOST
9338 @cindex movemail
9339 @vindex nnmail-pop-password
9340 @vindex nnmail-pop-password-required
9341 The backends will look for new mail in this file.  If this variable is
9342 @code{nil}, the mail backends will never attempt to fetch mail by
9343 themselves.  If you are using a POP mail server and your name is
9344 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
9345 your name is not @samp{larsi}, you should probably modify that
9346 slightly, but you may have guessed that already, you smart & handsome
9347 devil!  You can also set this variable to @code{pop}, and Gnus will try
9348 to figure out the POP mail string by itself.  In any case, Gnus will
9349 call @code{movemail} which will contact the POP server named in the
9350 @code{MAILHOST} environment variable.  If the POP server needs a
9351 password, you can either set @code{nnmail-pop-password-required} to
9352 @code{t} and be prompted for the password, or set
9353 @code{nnmail-pop-password} to the password itself.
9354
9355 @code{nnmail-spool-file} can also be a list of mailboxes.
9356
9357 Your Emacs has to have been configured with @samp{--with-pop} before
9358 compilation.  This is the default, but some installations have it
9359 switched off.
9360
9361 When you use a mail backend, Gnus will slurp all your mail from your
9362 inbox and plonk it down in your home directory.  Gnus doesn't move any
9363 mail if you're not using a mail backend---you have to do a lot of magic
9364 invocations first.  At the time when you have finished drawing the
9365 pentagram, lightened the candles, and sacrificed the goat, you really
9366 shouldn't be too surprised when Gnus moves your mail.
9367
9368 @vindex nnmail-use-procmail
9369 @vindex nnmail-procmail-suffix
9370 @item nnmail-use-procmail
9371 If non-@code{nil}, the mail backends will look in
9372 @code{nnmail-procmail-directory} for incoming mail.  All the files in
9373 that directory that have names ending in @code{nnmail-procmail-suffix}
9374 will be considered incoming mailboxes, and will be searched for new
9375 mail.
9376
9377 @vindex nnmail-crash-box
9378 @item nnmail-crash-box
9379 When a mail backend reads a spool file, mail is first moved to this
9380 file, which is @file{~/.gnus-crash-box} by default.  If this file
9381 already exists, it will always be read (and incorporated) before any
9382 other spool files.
9383
9384 @vindex nnmail-prepare-incoming-hook
9385 @item nnmail-prepare-incoming-hook
9386 This is run in a buffer that holds all the new incoming mail, and can be
9387 used for, well, anything, really.
9388
9389 @vindex nnmail-split-hook
9390 @item nnmail-split-hook
9391 @findex article-decode-rfc1522
9392 @findex RFC1522 decoding
9393 Hook run in the buffer where the mail headers of each message is kept
9394 just before the splitting based on these headers is done.  The hook is
9395 free to modify the buffer contents in any way it sees fit---the buffer
9396 is discarded after the splitting has been done, and no changes performed
9397 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
9398 is one likely function to add to this hook.
9399
9400 @vindex nnmail-pre-get-new-mail-hook
9401 @vindex nnmail-post-get-new-mail-hook
9402 @item nnmail-pre-get-new-mail-hook
9403 @itemx nnmail-post-get-new-mail-hook
9404 These are two useful hooks executed when treating new incoming
9405 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9406 starting to handle the new mail) and
9407 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9408 is done).  Here's and example of using these two hooks to change the
9409 default file modes the new mail files get:
9410
9411 @lisp
9412 (add-hook 'gnus-pre-get-new-mail-hook 
9413           (lambda () (set-default-file-modes 511)))
9414
9415 (add-hook 'gnus-post-get-new-mail-hook 
9416           (lambda () (set-default-file-modes 551)))
9417 @end lisp
9418
9419 @item nnmail-tmp-directory
9420 @vindex nnmail-tmp-directory
9421 This variable says where to move incoming mail to -- while processing
9422 it.  This is usually done in the same directory that the mail backend
9423 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9424 it will be used instead.
9425
9426 @item nnmail-movemail-program
9427 @vindex nnmail-movemail-program
9428 This program is executed to move mail from the user's inbox to her home
9429 directory.  The default is @samp{movemail}.
9430
9431 This can also be a function.  In that case, the function will be called
9432 with two parameters -- the name of the inbox, and the file to be moved
9433 to.
9434
9435 @item nnmail-delete-incoming
9436 @vindex nnmail-delete-incoming
9437 @cindex incoming mail files
9438 @cindex deleting incoming files
9439 If non-@code{nil}, the mail backends will delete the temporary incoming
9440 file after splitting mail into the proper groups.  This is @code{t} by
9441 default.
9442
9443 @c This is @code{nil} by
9444 @c default for reasons of security.
9445
9446 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9447 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9448 lost mail, I think, but that's not the point.  (Except certain versions
9449 of Red Gnus.))  By not deleting the Incoming* files, one can be sure not
9450 to lose mail -- if Gnus totally whacks out, one can always recover what
9451 was lost.
9452
9453 You may delete the @file{Incoming*} files at will.
9454
9455 @item nnmail-use-long-file-names
9456 @vindex nnmail-use-long-file-names
9457 If non-@code{nil}, the mail backends will use long file and directory
9458 names.  Groups like @samp{mail.misc} will end up in directories
9459 (assuming use of @code{nnml} backend) or files (assuming use of
9460 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
9461 the same group will end up in @file{mail/misc}.
9462
9463 @item nnmail-delete-file-function
9464 @vindex nnmail-delete-file-function
9465 @findex delete-file
9466 Function called to delete files.  It is @code{delete-file} by default. 
9467
9468 @item nnmail-cache-accepted-message-ids
9469 @vindex nnmail-cache-accepted-message-ids
9470 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9471 the backend (via @code{Gcc}, for instance) into the mail duplication
9472 discovery cache.  The default is @code{nil}.
9473
9474 @end table
9475
9476
9477 @node Fancy Mail Splitting
9478 @subsection Fancy Mail Splitting
9479 @cindex mail splitting
9480 @cindex fancy mail splitting
9481
9482 @vindex nnmail-split-fancy
9483 @findex nnmail-split-fancy
9484 If the rather simple, standard method for specifying how to split mail
9485 doesn't allow you to do what you want, you can set
9486 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
9487 play with the @code{nnmail-split-fancy} variable.
9488
9489 Let's look at an example value of this variable first:
9490
9491 @lisp
9492 ;; Messages from the mailer daemon are not crossposted to any of
9493 ;; the ordinary groups.  Warnings are put in a separate group
9494 ;; from real errors.
9495 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9496                    "mail.misc"))
9497    ;; Non-error messages are crossposted to all relevant
9498    ;; groups, but we don't crosspost between the group for the
9499    ;; (ding) list and the group for other (ding) related mail.
9500    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9501          ("subject" "ding" "ding.misc"))
9502       ;; Other mailing lists...
9503       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9504       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9505       ;; People...
9506       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9507    ;; Unmatched mail goes to the catch all group.
9508    "misc.misc")
9509 @end lisp
9510
9511 This variable has the format of a @dfn{split}.  A split is a (possibly)
9512 recursive structure where each split may contain other splits.  Here are
9513 the five possible split syntaxes:
9514
9515 @enumerate
9516
9517 @item 
9518 @samp{group}: If the split is a string, that will be taken as a group name. 
9519
9520 @item
9521 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
9522 which is a string, then store the message as specified by SPLIT, if
9523 header FIELD (a regexp) contains VALUE (also a regexp).
9524
9525 @item
9526 @var{(| SPLIT...)}: If the split is a list, and the first element is
9527 @code{|} (vertical bar), then process each SPLIT until one of them
9528 matches.  A SPLIT is said to match if it will cause the mail message to
9529 be stored in one or more groups.
9530
9531 @item
9532 @var{(& SPLIT...)}: If the split is a list, and the first element is
9533 @code{&}, then process all SPLITs in the list.
9534
9535 @item 
9536 @code{junk}: If the split is the symbol @code{junk}, then don't save
9537 this message.
9538
9539 @item
9540 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
9541 element is @code{:}, then the second element will be called as a
9542 function with @var{args} given as arguments.  The function should return
9543 a SPLIT.
9544
9545 @end enumerate
9546
9547 In these splits, @var{FIELD} must match a complete field name.
9548 @var{VALUE} must match a complete word according to the fundamental mode
9549 syntax table.  You can use @code{.*} in the regexps to match partial
9550 field names or words.  In other words, all @var{VALUE}'s are wrapped in
9551 @samp{\<} and @samp{\>} pairs.
9552
9553 @vindex nnmail-split-abbrev-alist
9554 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9555 are expanded as specified by the variable
9556 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
9557 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
9558 value.
9559
9560 @vindex nnmail-split-fancy-syntax-table
9561 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9562 when all this splitting is performed.
9563
9564 If you want to have Gnus create groups dynamically based on some
9565 information in the headers (i.e., do @code{replace-match}-like
9566 substitions in the group names), you can say things like:
9567
9568 @example
9569 (any "debian-\\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
9570 @end example
9571
9572 @node Mail and Procmail
9573 @subsection Mail and Procmail
9574 @cindex procmail
9575
9576 @cindex slocal
9577 @cindex elm
9578 Many people use @code{procmail} (or some other mail filter program or
9579 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9580 incoming mail into groups.  If you do that, you should set
9581 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9582 backends never ever try to fetch mail by themselves.
9583
9584 If you have a combined @code{procmail}/POP/mailbox setup, you can do
9585 something like the following:
9586
9587 @vindex nnmail-use-procmail
9588 @lisp
9589 (setq nnmail-use-procmail t)
9590 (setq nnmail-spool-file
9591       '("/usr/spool/mail/my-name" "po:my-name"))
9592 @end lisp
9593
9594 This also means that you probably don't want to set
9595 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9596 side effects.
9597
9598 When a mail backend is queried for what groups it carries, it replies
9599 with the contents of that variable, along with any groups it has figured
9600 out that it carries by other means.  None of the backends, except
9601 @code{nnmh}, actually go out to the disk and check what groups actually
9602 exist.  (It's not trivial to distinguish between what the user thinks is
9603 a basis for a newsgroup and what is just a plain old file or directory.)
9604
9605 This means that you have to tell Gnus (and the backends) by hand what
9606 groups exist.
9607
9608 Let's take the @code{nnmh} backend as an example:
9609
9610 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9611 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9612
9613 Go to the group buffer and type @kbd{G m}.  When prompted, answer
9614 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
9615 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
9616 to include all your mail groups.
9617
9618 That's it.  You are now set to read your mail.  An active file for this
9619 method will be created automatically.
9620
9621 @vindex nnmail-procmail-suffix
9622 @vindex nnmail-procmail-directory
9623 If you use @code{nnfolder} or any other backend that store more than a
9624 single article in each file, you should never have procmail add mails to
9625 the file that Gnus sees.  Instead, procmail should put all incoming mail
9626 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9627 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9628 name.  The mail backends will read the mail from these files.
9629
9630 @vindex nnmail-resplit-incoming
9631 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9632 put in the @code{mail.misc}, as one would expect.  However, if you want
9633 Gnus to split the mail the normal way, you could set
9634 @code{nnmail-resplit-incoming} to @code{t}.
9635
9636 @vindex nnmail-keep-last-article
9637 If you use @code{procmail} to split things directly into an @code{nnmh}
9638 directory (which you shouldn't do), you should set
9639 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9640 ever expiring the final article (i.e., the article with the highest
9641 article number) in a mail newsgroup.  This is quite, quite important.
9642
9643 Here's an example setup:  The incoming spools are located in
9644 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9645 spool files have the same names as the equivalent groups).  The
9646 @code{nnfolder} backend is to be used as the mail interface, and the
9647 @code{nnfolder} directory is @file{~/fMail/}.
9648
9649 @lisp
9650 (setq nnfolder-directory "~/fMail/")
9651 (setq nnmail-spool-file 'procmail)
9652 (setq nnmail-procmail-directory "~/incoming/")
9653 (setq gnus-secondary-select-methods '((nnfolder "")))
9654 (setq nnmail-procmail-suffix "")
9655 @end lisp
9656
9657
9658 @node Incorporating Old Mail
9659 @subsection Incorporating Old Mail
9660
9661 Most people have lots of old mail stored in various file formats.  If
9662 you have set up Gnus to read mail using one of the spiffy Gnus mail
9663 backends, you'll probably wish to have that old mail incorporated into
9664 your mail groups.
9665
9666 Doing so can be quite easy.
9667
9668 To take an example: You're reading mail using @code{nnml}
9669 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9670 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9671 file filled with important, but old, mail.  You want to move it into
9672 your @code{nnml} groups.
9673
9674 Here's how:
9675
9676 @enumerate
9677 @item
9678 Go to the group buffer.
9679
9680 @item 
9681 Type `G f' and give the path to the mbox file when prompted to create an
9682 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9683
9684 @item 
9685 Type `SPACE' to enter the newly created group.
9686
9687 @item
9688 Type `M P b' to process-mark all articles in this group's buffer
9689 (@pxref{Setting Process Marks}).
9690
9691 @item 
9692 Type `B r' to respool all the process-marked articles, and answer
9693 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9694 @end enumerate
9695
9696 All the mail messages in the mbox file will now also be spread out over
9697 all your @code{nnml} groups.  Try entering them and check whether things
9698 have gone without a glitch.  If things look ok, you may consider
9699 deleting the mbox file, but I wouldn't do that unless I was absolutely
9700 sure that all the mail has ended up where it should be.
9701
9702 Respooling is also a handy thing to do if you're switching from one mail
9703 backend to another.  Just respool all the mail in the old mail groups
9704 using the new mail backend.
9705
9706
9707 @node Expiring Mail
9708 @subsection Expiring Mail
9709 @cindex article expiry
9710
9711 Traditional mail readers have a tendency to remove mail articles when
9712 you mark them as read, in some way.  Gnus takes a fundamentally
9713 different approach to mail reading.
9714
9715 Gnus basically considers mail just to be news that has been received in
9716 a rather peculiar manner.  It does not think that it has the power to
9717 actually change the mail, or delete any mail messages.  If you enter a
9718 mail group, and mark articles as ``read'', or kill them in some other
9719 fashion, the mail articles will still exist on the system.  I repeat:
9720 Gnus will not delete your old, read mail.  Unless you ask it to, of
9721 course.
9722
9723 To make Gnus get rid of your unwanted mail, you have to mark the
9724 articles as @dfn{expirable}.  This does not mean that the articles will
9725 disappear right away, however.  In general, a mail article will be
9726 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9727 more than one week old.  If you do not mark an article as expirable, it
9728 will remain on your system until hell freezes over.  This bears
9729 repeating one more time, with some spurious capitalizations: IF you do
9730 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9731
9732 @vindex gnus-auto-expirable-newsgroups
9733 You do not have to mark articles as expirable by hand.  Groups that
9734 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9735 have all articles that you read marked as expirable automatically.  All
9736 articles marked as expirable have an @samp{E} in the first
9737 column in the summary buffer.
9738
9739 By default, if you have auto expiry switched on, Gnus will mark all the
9740 articles you read as expirable, no matter if they were read or unread
9741 before.  To avoid having articles marked as read marked as expirable
9742 automatically, you can put something like the following in your
9743 @file{.gnus} file:
9744
9745 @vindex gnus-mark-article-hook
9746 @lisp
9747 (remove-hook 'gnus-mark-article-hook                                
9748              'gnus-summary-mark-read-and-unread-as-read)            
9749 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9750 @end lisp
9751
9752 Note that making a group auto-expirable doesn't mean that all read
9753 articles are expired---only the articles marked as expirable
9754 will be expired.  Also note that using the @kbd{d} command won't make
9755 groups expirable---only semi-automatic marking of articles as read will
9756 mark the articles as expirable in auto-expirable groups.
9757
9758 Let's say you subscribe to a couple of mailing lists, and you want the
9759 articles you have read to disappear after a while:
9760
9761 @lisp
9762 (setq gnus-auto-expirable-newsgroups 
9763       "mail.nonsense-list\\|mail.nice-list")
9764 @end lisp
9765
9766 Another way to have auto-expiry happen is to have the element
9767 @code{auto-expire} in the group parameters of the group. 
9768
9769 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9770 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9771 don't really mix very well.  
9772
9773 @vindex nnmail-expiry-wait
9774 The @code{nnmail-expiry-wait} variable supplies the default time an
9775 expirable article has to live.  Gnus starts counting days from when the
9776 message @emph{arrived}, not from when it was sent.  The default is seven
9777 days.
9778
9779 Gnus also supplies a function that lets you fine-tune how long articles
9780 are to live, based on what group they are in.  Let's say you want to
9781 have one month expiry period in the @samp{mail.private} group, a one day
9782 expiry period in the @samp{mail.junk} group, and a six day expiry period
9783 everywhere else:
9784
9785 @vindex nnmail-expiry-wait-function
9786 @lisp
9787 (setq nnmail-expiry-wait-function
9788       (lambda (group)
9789        (cond ((string= group "mail.private")
9790                31)
9791              ((string= group "mail.junk")
9792                1)
9793              ((string= group "important")
9794                'never)
9795              (t
9796                6))))
9797 @end lisp
9798
9799 The group names this function is fed are ``unadorned'' group
9800 names---no @samp{nnml:} prefixes and the like.
9801
9802 The @code{nnmail-expiry-wait} variable and
9803 @code{nnmail-expiry-wait-function} function can either be a number (not
9804 necessarily an integer) or one of the symbols @code{immediate} or
9805 @code{never}.
9806
9807 You can also use the @code{expiry-wait} group parameter to selectively
9808 change the expiry period (@pxref{Group Parameters}).
9809
9810 @vindex nnmail-keep-last-article
9811 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9812 expire the final article in a mail newsgroup.  This is to make life
9813 easier for procmail users.
9814
9815 @vindex gnus-total-expirable-newsgroups
9816 By the way: That line up there, about Gnus never expiring non-expirable
9817 articles, is a lie.  If you put @code{total-expire} in the group
9818 parameters, articles will not be marked as expirable, but all read
9819 articles will be put through the expiry process.  Use with extreme
9820 caution.  Even more dangerous is the
9821 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9822 this regexp will have all read articles put through the expiry process,
9823 which means that @emph{all} old mail articles in the groups in question
9824 will be deleted after a while.  Use with extreme caution, and don't come
9825 crying to me when you discover that the regexp you used matched the
9826 wrong group and all your important mail has disappeared.  Be a
9827 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9828 with!  So there!
9829
9830 Most people make most of their mail groups total-expirable, though. 
9831
9832
9833 @node Washing Mail
9834 @subsection Washing Mail
9835 @cindex mail washing
9836 @cindex list server brain damage
9837 @cindex incoming mail treatment
9838
9839 Mailers and list servers are notorious for doing all sorts of really,
9840 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9841 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9842 end of all lines passing through our server, so let's do that!!!!1!''
9843 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9844 considered to be self-evident were not discussed.  So.  Here we are.
9845
9846 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9847 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9848 be shocked and dismayed by this, but I haven't got the energy.  It is to
9849 laugh.
9850
9851 Gnus provides a plethora of functions for washing articles while
9852 displaying them, but it might be nicer to do the filtering before
9853 storing the mail to disc.  For that purpose, we have three hooks and
9854 various functions that can be put in these hooks.
9855
9856 @table @code
9857 @item nnmail-prepare-incoming-hook
9858 @vindex nnmail-prepare-incoming-hook
9859 This hook is called before doing anything with the mail and is meant for
9860 grand, sweeping gestures.  Functions to be used include:
9861
9862 @table @code
9863 @item nnheader-ms-strip-cr
9864 @findex nnheader-ms-strip-cr
9865 Remove trailing carriage returns from each line.  This is default on
9866 Emacs running on MS machines.
9867
9868 @end table
9869
9870 @item nnmail-prepare-incoming-header-hook
9871 @vindex nnmail-prepare-incoming-header-hook
9872 This hook is called narrowed to each header.  It can be used when
9873 cleaning up the headers.  Functions that can be used include:
9874
9875 @table @code
9876 @item nnmail-remove-leading-whitespace
9877 @findex nnmail-remove-leading-whitespace
9878 Clear leading white space that ``helpful'' listservs have added to the
9879 headers to make them look nice.  Aaah.  
9880
9881 @item nnmail-remove-list-identifiers
9882 @findex nnmail-remove-list-identifiers
9883 Some list servers add an identifier---for example, @samp{(idm)}---to the
9884 beginning of all @code{Subject} headers.  I'm sure that's nice for
9885 people who use stone age mail readers.  This function will remove
9886 strings that match the @code{nnmail-list-identifiers} regexp, which can
9887 also be a list of regexp.
9888
9889 For instance, if you want to remove the @samp{(idm)} and the
9890 @samp{nagnagnag} identifiers:
9891
9892 @lisp
9893 (setq nnmail-list-identifiers
9894       '("(idm)" "nagnagnag"))
9895 @end lisp
9896
9897 @item nnmail-remove-tabs
9898 @findex nnmail-remove-tabs
9899 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9900
9901 @end table
9902
9903 @item nnmail-prepare-incoming-message-hook
9904 @vindex nnmail-prepare-incoming-message-hook
9905 This hook is called narrowed to each message.  Functions to be used
9906 include: 
9907
9908 @table @code
9909 @item article-de-quoted-unreadable
9910 @findex article-de-quoted-unreadable
9911 Decode Quoted Readable encoding.
9912
9913 @end table
9914 @end table
9915
9916
9917 @node Duplicates
9918 @subsection Duplicates
9919
9920 @vindex nnmail-treat-duplicates
9921 @vindex nnmail-message-id-cache-length
9922 @vindex nnmail-message-id-cache-file
9923 @cindex duplicate mails
9924 If you are a member of a couple of mailing lists, you will sometimes
9925 receive two copies of the same mail.  This can be quite annoying, so
9926 @code{nnmail} checks for and treats any duplicates it might find.  To do
9927 this, it keeps a cache of old @code{Message-ID}s---
9928 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9929 default.  The approximate maximum number of @code{Message-ID}s stored
9930 there is controlled by the @code{nnmail-message-id-cache-length}
9931 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9932 stored.) If all this sounds scary to you, you can set
9933 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9934 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9935 will insert a warning into the head of the mail saying that it thinks
9936 that this is a duplicate of a different message.
9937
9938 This variable can also be a function.  If that's the case, the function
9939 will be called from a buffer narrowed to the message in question with
9940 the @code{Message-ID} as a parameter.  The function must return either
9941 @code{nil}, @code{warn}, or @code{delete}.
9942
9943 You can turn this feature off completely by setting the variable to
9944 @code{nil}.
9945
9946 If you want all the duplicate mails to be put into a special
9947 @dfn{duplicates} group, you could do that using the normal mail split
9948 methods:
9949
9950 @lisp
9951 (setq nnmail-split-fancy
9952       '(| ;; Messages duplicates go to a separate group.
9953           ("gnus-warning" "duplication of message" "duplicate")
9954           ;; Message from daemons, postmaster, and the like to another.
9955           (any mail "mail.misc")
9956           ;; Other rules.
9957           [ ... ] ))
9958 @end lisp
9959
9960 Or something like:
9961 @lisp
9962 (setq nnmail-split-methods 
9963       '(("duplicates" "^Gnus-Warning:")
9964         ;; Other rules.
9965         [...]))
9966 @end lisp
9967
9968 Here's a neat feature: If you know that the recipient reads her mail
9969 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9970 @code{delete}, you can send her as many insults as you like, just by
9971 using a @code{Message-ID} of a mail that you know that she's already
9972 received.  Think of all the fun!  She'll never see any of it!  Whee!
9973
9974
9975 @node Not Reading Mail
9976 @subsection Not Reading Mail
9977
9978 If you start using any of the mail backends, they have the annoying
9979 habit of assuming that you want to read mail with them.  This might not
9980 be unreasonable, but it might not be what you want.
9981
9982 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9983 will ever attempt to read incoming mail, which should help.
9984
9985 @vindex nnbabyl-get-new-mail
9986 @vindex nnmbox-get-new-mail
9987 @vindex nnml-get-new-mail
9988 @vindex nnmh-get-new-mail
9989 @vindex nnfolder-get-new-mail
9990 This might be too much, if, for instance, you are reading mail quite
9991 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9992 file you have stashed away with @code{nnbabyl}.  All backends have
9993 variables called backend-@code{get-new-mail}.  If you want to disable
9994 the @code{nnbabyl} mail reading, you edit the virtual server for the
9995 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9996
9997 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9998 narrowed to the article to be saved before saving it when reading
9999 incoming mail.
10000
10001
10002 @node Choosing a Mail Backend
10003 @subsection Choosing a Mail Backend
10004
10005 Gnus will read the mail spool when you activate a mail group.  The mail
10006 file is first copied to your home directory.  What happens after that
10007 depends on what format you want to store your mail in.
10008
10009 @menu
10010 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10011 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10012 * Mail Spool::                  Store your mail in a private spool?
10013 * MH Spool::                    An mhspool-like backend.
10014 * Mail Folders::                Having one file for each group.
10015 @end menu
10016
10017
10018 @node Unix Mail Box
10019 @subsubsection Unix Mail Box
10020 @cindex nnmbox
10021 @cindex unix mail box
10022
10023 @vindex nnmbox-active-file
10024 @vindex nnmbox-mbox-file
10025 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10026 mail.  @code{nnmbox} will add extra headers to each mail article to say
10027 which group it belongs in.
10028
10029 Virtual server settings:
10030
10031 @table @code
10032 @item nnmbox-mbox-file
10033 @vindex nnmbox-mbox-file
10034 The name of the mail box in the user's home directory. 
10035
10036 @item nnmbox-active-file
10037 @vindex nnmbox-active-file
10038 The name of the active file for the mail box.
10039
10040 @item nnmbox-get-new-mail
10041 @vindex nnmbox-get-new-mail
10042 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10043 into groups.
10044 @end table
10045
10046
10047 @node Rmail Babyl
10048 @subsubsection Rmail Babyl
10049 @cindex nnbabyl
10050 @cindex rmail mbox
10051
10052 @vindex nnbabyl-active-file
10053 @vindex nnbabyl-mbox-file
10054 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10055 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10056 article to say which group it belongs in.
10057
10058 Virtual server settings:
10059
10060 @table @code
10061 @item nnbabyl-mbox-file
10062 @vindex nnbabyl-mbox-file
10063 The name of the rmail mbox file.
10064
10065 @item nnbabyl-active-file
10066 @vindex nnbabyl-active-file
10067 The name of the active file for the rmail box.
10068
10069 @item nnbabyl-get-new-mail
10070 @vindex nnbabyl-get-new-mail
10071 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
10072 @end table
10073
10074
10075 @node Mail Spool
10076 @subsubsection Mail Spool
10077 @cindex nnml
10078 @cindex mail @sc{nov} spool
10079
10080 The @dfn{nnml} spool mail format isn't compatible with any other known
10081 format.  It should be used with some caution.
10082
10083 @vindex nnml-directory
10084 If you use this backend, Gnus will split all incoming mail into files,
10085 one file for each mail, and put the articles into the corresponding
10086 directories under the directory specified by the @code{nnml-directory}
10087 variable.  The default value is @file{~/Mail/}.
10088
10089 You do not have to create any directories beforehand; Gnus will take
10090 care of all that.
10091
10092 If you have a strict limit as to how many files you are allowed to store
10093 in your account, you should not use this backend.  As each mail gets its
10094 own file, you might very well occupy thousands of inodes within a few
10095 weeks.  If this is no problem for you, and it isn't a problem for you
10096 having your friendly systems administrator walking around, madly,
10097 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10098 know that this is probably the fastest format to use.  You do not have
10099 to trudge through a big mbox file just to read your new mail.
10100
10101 @code{nnml} is probably the slowest backend when it comes to article
10102 splitting.  It has to create lots of files, and it also generates
10103 @sc{nov} databases for the incoming mails.  This makes it the fastest
10104 backend when it comes to reading mail.
10105
10106 Virtual server settings:
10107
10108 @table @code
10109 @item nnml-directory
10110 @vindex nnml-directory
10111 All @code{nnml} directories will be placed under this directory. 
10112
10113 @item nnml-active-file
10114 @vindex nnml-active-file
10115 The active file for the @code{nnml} server.
10116
10117 @item nnml-newsgroups-file
10118 @vindex nnml-newsgroups-file
10119 The @code{nnml} group descriptions file.  @xref{Newsgroups File
10120 Format}. 
10121
10122 @item nnml-get-new-mail
10123 @vindex nnml-get-new-mail
10124 If non-@code{nil}, @code{nnml} will read incoming mail.
10125
10126 @item nnml-nov-is-evil
10127 @vindex nnml-nov-is-evil
10128 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
10129
10130 @item nnml-nov-file-name
10131 @vindex nnml-nov-file-name
10132 The name of the @sc{nov} files.  The default is @file{.overview}. 
10133
10134 @item nnml-prepare-save-mail-hook
10135 @vindex nnml-prepare-save-mail-hook
10136 Hook run narrowed to an article before saving.
10137
10138 @end table
10139
10140 @findex nnml-generate-nov-databases
10141 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10142 you can do a complete update by typing @kbd{M-x
10143 nnml-generate-nov-databases}.  This command will trawl through the
10144 entire @code{nnml} hierarchy, looking at each and every article, so it
10145 might take a while to complete.  A better interface to this
10146 functionality can be found in the server buffer (@pxref{Server
10147 Commands}). 
10148
10149
10150 @node MH Spool
10151 @subsubsection MH Spool
10152 @cindex nnmh
10153 @cindex mh-e mail spool
10154
10155 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10156 @sc{nov} databases and it doesn't keep an active file.  This makes
10157 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10158 makes it easier to write procmail scripts for.
10159
10160 Virtual server settings:
10161
10162 @table @code
10163 @item nnmh-directory
10164 @vindex nnmh-directory
10165 All @code{nnmh} directories will be located under this directory.
10166
10167 @item nnmh-get-new-mail
10168 @vindex nnmh-get-new-mail
10169 If non-@code{nil}, @code{nnmh} will read incoming mail.
10170
10171 @item nnmh-be-safe
10172 @vindex nnmh-be-safe
10173 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10174 sure that the articles in the folder are actually what Gnus thinks they
10175 are.  It will check date stamps and stat everything in sight, so
10176 setting this to @code{t} will mean a serious slow-down.  If you never
10177 use anything but Gnus to read the @code{nnmh} articles, you do not have
10178 to set this variable to @code{t}.
10179 @end table
10180
10181
10182 @node Mail Folders
10183 @subsubsection Mail Folders
10184 @cindex nnfolder
10185 @cindex mbox folders
10186 @cindex mail folders
10187
10188 @code{nnfolder} is a backend for storing each mail group in a separate
10189 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
10190 will add extra headers to keep track of article numbers and arrival
10191 dates.
10192
10193 Virtual server settings:
10194
10195 @table @code
10196 @item nnfolder-directory
10197 @vindex nnfolder-directory
10198 All the @code{nnfolder} mail boxes will be stored under this directory. 
10199
10200 @item nnfolder-active-file
10201 @vindex nnfolder-active-file
10202 The name of the active file.
10203
10204 @item nnfolder-newsgroups-file
10205 @vindex nnfolder-newsgroups-file
10206 The name of the group descriptions file.  @xref{Newsgroups File Format}.
10207
10208 @item nnfolder-get-new-mail
10209 @vindex nnfolder-get-new-mail
10210 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10211 @end table
10212
10213 @findex nnfolder-generate-active-file
10214 @kindex M-x nnfolder-generate-active-file
10215 If you have lots of @code{nnfolder}-like files you'd like to read with
10216 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10217 command to make @code{nnfolder} aware of all likely files in
10218 @code{nnfolder-directory}.
10219
10220
10221 @node Other Sources
10222 @section Other Sources
10223
10224 Gnus can do more than just read news or mail.  The methods described
10225 below allow Gnus to view directories and files as if they were
10226 newsgroups.
10227
10228 @menu
10229 * Directory Groups::      You can read a directory as if it was a newsgroup.
10230 * Anything Groups::       Dired?  Who needs dired?
10231 * Document Groups::       Single files can be the basis of a group.
10232 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
10233 * Web Searches::          Creating groups from articles that match a string.
10234 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10235 @end menu
10236
10237
10238 @node Directory Groups
10239 @subsection Directory Groups
10240 @cindex nndir
10241 @cindex directory groups
10242
10243 If you have a directory that has lots of articles in separate files in
10244 it, you might treat it as a newsgroup.  The files have to have numerical
10245 names, of course.
10246
10247 This might be an opportune moment to mention @code{ange-ftp} (and its
10248 successor @code{efs}), that most wonderful of all wonderful Emacs
10249 packages.  When I wrote @code{nndir}, I didn't think much about it---a
10250 backend to read directories.  Big deal.
10251
10252 @code{ange-ftp} changes that picture dramatically.  For instance, if you
10253 enter the @code{ange-ftp} file name
10254 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10255 @code{ange-ftp} or @code{efs} will actually allow you to read this
10256 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
10257
10258 @code{nndir} will use @sc{nov} files if they are present.
10259
10260 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10261 articles with this method.  You can use @code{nnmh} or @code{nnml} for
10262 whatever you use @code{nndir} for, so you could switch to any of those
10263 methods if you feel the need to have a non-read-only @code{nndir}.
10264
10265
10266 @node Anything Groups
10267 @subsection Anything Groups
10268 @cindex nneething
10269
10270 From the @code{nndir} backend (which reads a single spool-like
10271 directory), it's just a hop and a skip to @code{nneething}, which
10272 pretends that any arbitrary directory is a newsgroup.  Strange, but
10273 true.
10274
10275 When @code{nneething} is presented with a directory, it will scan this
10276 directory and assign article numbers to each file.  When you enter such
10277 a group, @code{nneething} must create ``headers'' that Gnus can use.
10278 After all, Gnus is a newsreader, in case you're
10279 forgetting. @code{nneething} does this in a two-step process.  First, it
10280 snoops each file in question.  If the file looks like an article (i.e.,
10281 the first few lines look like headers), it will use this as the head.
10282 If this is just some arbitrary file without a head (e.g. a C source
10283 file), @code{nneething} will cobble up a header out of thin air.  It
10284 will use file ownership, name and date and do whatever it can with these
10285 elements.
10286
10287 All this should happen automatically for you, and you will be presented
10288 with something that looks very much like a newsgroup.  Totally like a
10289 newsgroup, to be precise.  If you select an article, it will be displayed
10290 in the article buffer, just as usual.
10291
10292 If you select a line that represents a directory, Gnus will pop you into
10293 a new summary buffer for this @code{nneething} group.  And so on.  You can
10294 traverse the entire disk this way, if you feel like, but remember that
10295 Gnus is not dired, really, and does not intend to be, either.
10296
10297 There are two overall modes to this action---ephemeral or solid.  When
10298 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10299 will not store information on what files you have read, and what files
10300 are new, and so on.  If you create a solid @code{nneething} group the
10301 normal way with @kbd{G m}, Gnus will store a mapping table between
10302 article numbers and file names, and you can treat this group like any
10303 other groups.  When you activate a solid @code{nneething} group, you will
10304 be told how many unread articles it contains, etc., etc.
10305
10306 Some variables:
10307
10308 @table @code
10309 @item nneething-map-file-directory
10310 @vindex nneething-map-file-directory
10311 All the mapping files for solid @code{nneething} groups will be stored
10312 in this directory, which defaults to @file{~/.nneething/}.
10313
10314 @item nneething-exclude-files
10315 @vindex nneething-exclude-files
10316 All files that match this regexp will be ignored.  Nice to use to exclude
10317 auto-save files and the like, which is what it does by default.
10318
10319 @item nneething-map-file
10320 @vindex nneething-map-file
10321 Name of the map files.
10322 @end table
10323
10324
10325 @node Document Groups
10326 @subsection Document Groups
10327 @cindex nndoc
10328 @cindex documentation group
10329 @cindex help group
10330
10331 @code{nndoc} is a cute little thing that will let you read a single file
10332 as a newsgroup.  Several files types are supported:
10333
10334 @table @code
10335 @cindex babyl
10336 @cindex rmail mbox
10337
10338 @item babyl
10339 The babyl (rmail) mail box.
10340 @cindex mbox
10341 @cindex Unix mbox
10342
10343 @item mbox
10344 The standard Unix mbox file.
10345
10346 @cindex MMDF mail box
10347 @item mmdf
10348 The MMDF mail box format.
10349
10350 @item news
10351 Several news articles appended into a file.
10352
10353 @item rnews
10354 @cindex rnews batch files
10355 The rnews batch transport format.
10356 @cindex forwarded messages
10357
10358 @item forward
10359 Forwarded articles.
10360
10361 @item mime-digest
10362 @cindex digest
10363 @cindex MIME digest
10364 @cindex 1153 digest
10365 @cindex RFC 1153 digest
10366 @cindex RFC 341 digest
10367 MIME (RFC 1341) digest format.
10368
10369 @item standard-digest
10370 The standard (RFC 1153) digest format.
10371
10372 @item slack-digest
10373 Non-standard digest format---matches most things, but does it badly. 
10374 @end table
10375
10376 You can also use the special ``file type'' @code{guess}, which means
10377 that @code{nndoc} will try to guess what file type it is looking at.
10378 @code{digest} means that @code{nndoc} should guess what digest type the
10379 file is.
10380
10381 @code{nndoc} will not try to change the file or insert any extra headers into
10382 it---it will simply, like, let you use the file as the basis for a
10383 group.  And that's it.
10384
10385 If you have some old archived articles that you want to insert into your
10386 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10387 that.  Say you have an old @file{RMAIL} file with mail that you now want
10388 to split into your new @code{nnml} groups.  You look at that file using
10389 @code{nndoc} (using the @kbd{G f} command in the group buffer
10390 (@pxref{Foreign Groups})), set the process mark on all the articles in
10391 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10392 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
10393 file is now also stored in lots of @code{nnml} directories, and you can
10394 delete that pesky @file{RMAIL} file.  If you have the guts!
10395
10396 Virtual server variables:
10397
10398 @table @code
10399 @item nndoc-article-type
10400 @vindex nndoc-article-type
10401 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10402 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10403 @code{rfc822-forward}, @code{mime-digest}, @code{standard-digest},
10404 @code{slack-digest}, @code{clari-briefs} or @code{guess}.
10405
10406 @item nndoc-post-type
10407 @vindex nndoc-post-type
10408 This variable says whether Gnus is to consider the group a news group or
10409 a mail group.  There are two valid values:  @code{mail} (the default)
10410 and @code{news}.
10411 @end table
10412
10413 @menu
10414 * Document Server Internals::   How to add your own document types.
10415 @end menu
10416
10417
10418 @node Document Server Internals
10419 @subsubsection Document Server Internals
10420
10421 Adding new document types to be recognized by @code{nndoc} isn't
10422 difficult.  You just have to whip up a definition of what the document
10423 looks like, write a predicate function to recognize that document type,
10424 and then hook into @code{nndoc}.
10425
10426 First, here's an example document type definition:
10427
10428 @example
10429 (mmdf 
10430  (article-begin .  "^\^A\^A\^A\^A\n")
10431  (body-end .  "^\^A\^A\^A\^A\n"))
10432 @end example
10433
10434 The definition is simply a unique @dfn{name} followed by a series of
10435 regexp pseudo-variable settings.  Below are the possible
10436 variables---don't be daunted by the number of variables; most document
10437 types can be defined with very few settings:
10438
10439 @table @code
10440 @item first-article
10441 If present, @code{nndoc} will skip past all text until it finds
10442 something that match this regexp.  All text before this will be
10443 totally ignored. 
10444
10445 @item article-begin
10446 This setting has to be present in all document type definitions.  It
10447 says what the beginning of each article looks like.
10448
10449 @item head-begin-function
10450 If present, this should be a function that moves point to the head of
10451 the article.
10452
10453 @item nndoc-head-begin
10454 If present, this should be a regexp that matches the head of the
10455 article. 
10456
10457 @item nndoc-head-end
10458 This should match the end of the head of the article.  It defaults to
10459 @samp{^$}---the empty line.
10460
10461 @item body-begin-function
10462 If present, this function should move point to the beginning of the body
10463 of the article.
10464
10465 @item body-begin
10466 This should match the beginning of the body of the article.  It defaults
10467 to @samp{^\n}.
10468
10469 @item body-end-function
10470 If present, this function should move point to the end of the body of
10471 the article.
10472
10473 @item body-end
10474 If present, this should match the end of the body of the article.
10475
10476 @item file-end
10477 If present, this should match the end of the file.  All text after this
10478 regexp will be totally ignored. 
10479
10480 @end table
10481
10482 So, using these variables @code{nndoc} is able to dissect a document
10483 file into a series of articles, each with a head and a body.  However, a
10484 few more variables are needed since not all document types are all that
10485 news-like---variables needed to transform the head or the body into
10486 something that's palatable for Gnus:
10487
10488 @table @code
10489 @item prepare-body-function
10490 If present, this function will be called when requesting an article.  It
10491 will be called with point at the start of the body, and is useful if the
10492 document has encoded some parts of its contents. 
10493
10494 @item article-transform-function
10495 If present, this function is called when requesting an article.  It's
10496 meant to be used for more wide-ranging transformation of both head and
10497 body of the article.
10498
10499 @item generate-head-function
10500 If present, this function is called to generate a head that Gnus can
10501 understand.  It is called with the article number as a parameter, and is
10502 expected to generate a nice head for the article in question.  It is
10503 called when requesting the headers of all articles.
10504
10505 @end table
10506
10507 Let's look at the most complicated example I can come up with---standard
10508 digests:
10509
10510 @example
10511 (standard-digest
10512  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10513  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10514  (prepare-body-function . nndoc-unquote-dashes)
10515  (body-end-function . nndoc-digest-body-end)
10516  (head-end . "^ ?$")
10517  (body-begin . "^ ?\n")
10518  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10519  (subtype digest guess))
10520 @end example
10521
10522 We see that all text before a 70-width line of dashes is ignored; all
10523 text after a line that starts with that @samp{^End of} is also ignored;
10524 each article begins with a 30-width line of dashes; the line separating
10525 the head from the body may contain a single space; and that the body is
10526 run through @code{nndoc-unquote-dashes} before being delivered.
10527
10528 To hook your own document definition into @code{nndoc}, use the
10529 @code{nndoc-add-type} function.  It takes two parameters---the first is
10530 the definition itself and the second (optional) parameter says where in
10531 the document type definition alist to put this definition.  The alist is
10532 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
10533 is of @code{mmdf} type, and so on.  These type predicates should return
10534 @code{nil} if the document is not of the correct type; @code{t} if it is
10535 of the correct type; and a number if the document might be of the
10536 correct type.  A high number means high probability; a low number means
10537 low probability with @samp{0} being the lowest valid number.
10538
10539
10540 @node SOUP
10541 @subsection SOUP
10542 @cindex SOUP
10543 @cindex offline
10544
10545 In the PC world people often talk about ``offline'' newsreaders.  These
10546 are thingies that are combined reader/news transport monstrosities.
10547 With built-in modem programs.  Yecchh!
10548
10549 Of course, us Unix Weenie types of human beans use things like
10550 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10551 transport things like Ghod intended.  And then we just use normal
10552 newsreaders.  
10553
10554 However, it can sometimes be convenient to do something a that's a bit
10555 easier on the brain if you have a very slow modem, and you're not really
10556 that interested in doing things properly.  
10557
10558 A file format called @sc{soup} has been developed for transporting news
10559 and mail from servers to home machines and back again.  It can be a bit
10560 fiddly.
10561
10562 First some terminology:
10563
10564 @table @dfn
10565
10566 @item server
10567 This is the machine that is connected to the outside world and where you
10568 get news and/or mail from.
10569
10570 @item home machine
10571 This is the machine that you want to do the actual reading and responding
10572 on.  It is typically not connected to the rest of the world in any way.
10573
10574 @item packet
10575 Something that contains messages and/or commands.  There are two kinds
10576 of packets:
10577
10578 @table @dfn
10579 @item message packets
10580 These are packets made at the server, and typically contain lots of
10581 messages for you to read.  These are called @file{SoupoutX.tgz} by
10582 default, where @var{X} is a number.
10583
10584 @item response packets
10585 These are packets made at the home machine, and typically contains
10586 replies that you've written.  These are called @file{SoupinX.tgz} by
10587 default, where @var{X} is a number.
10588
10589 @end table
10590
10591 @end table
10592
10593
10594 @enumerate
10595
10596 @item
10597 You log in on the server and create a @sc{soup} packet.  You can either
10598 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10599 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10600 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10601
10602 @item 
10603 You transfer the packet home.  Rail, boat, car or modem will do fine.
10604
10605 @item
10606 You put the packet in your home directory.
10607
10608 @item
10609 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10610 the native or secondary server.
10611
10612 @item
10613 You read articles and mail and answer and followup to the things you
10614 want (@pxref{SOUP Replies}).
10615
10616 @item 
10617 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10618 packet.
10619
10620 @item 
10621 You transfer this packet to the server.  
10622
10623 @item
10624 You use Gnus to mail this packet out with the @kbd{G s s} command.
10625
10626 @item
10627 You then repeat until you die.
10628
10629 @end enumerate
10630
10631 So you basically have a bipartite system---you use @code{nnsoup} for
10632 reading and Gnus for packing/sending these @sc{soup} packets.
10633
10634 @menu
10635 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10636 * SOUP Groups::       A backend for reading @sc{soup} packets.
10637 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10638 @end menu
10639
10640
10641 @node SOUP Commands
10642 @subsubsection SOUP Commands
10643
10644 These are commands for creating and manipulating @sc{soup} packets.
10645
10646 @table @kbd
10647 @item G s b
10648 @kindex G s b (Group)
10649 @findex gnus-group-brew-soup
10650 Pack all unread articles in the current group
10651 (@code{gnus-group-brew-soup}).  This command understands the
10652 process/prefix convention.
10653
10654 @item G s w
10655 @kindex G s w (Group)
10656 @findex gnus-soup-save-areas
10657 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10658
10659 @item G s s
10660 @kindex G s s (Group)
10661 @findex gnus-soup-send-replies
10662 Send all replies from the replies packet
10663 (@code{gnus-soup-send-replies}). 
10664
10665 @item G s p
10666 @kindex G s p (Group)
10667 @findex gnus-soup-pack-packet
10668 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
10669
10670 @item G s r
10671 @kindex G s r (Group)
10672 @findex nnsoup-pack-replies
10673 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
10674
10675 @item O s
10676 @kindex O s (Summary)
10677 @findex gnus-soup-add-article
10678 This summary-mode command adds the current article to a @sc{soup} packet
10679 (@code{gnus-soup-add-article}).  It understands the process/prefix
10680 convention (@pxref{Process/Prefix}). 
10681
10682 @end table
10683
10684
10685 There are a few variables to customize where Gnus will put all these
10686 thingies:  
10687
10688 @table @code
10689
10690 @item gnus-soup-directory
10691 @vindex gnus-soup-directory
10692 Directory where Gnus will save intermediate files while composing
10693 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
10694
10695 @item gnus-soup-replies-directory
10696 @vindex gnus-soup-replies-directory
10697 This is what Gnus will use as a temporary directory while sending our
10698 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10699
10700 @item gnus-soup-prefix-file
10701 @vindex gnus-soup-prefix-file
10702 Name of the file where Gnus stores the last used prefix.  The default is
10703 @samp{gnus-prefix}. 
10704
10705 @item gnus-soup-packer
10706 @vindex gnus-soup-packer
10707 A format string command for packing a @sc{soup} packet.  The default is
10708 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
10709
10710 @item gnus-soup-unpacker
10711 @vindex gnus-soup-unpacker
10712 Format string command for unpacking a @sc{soup} packet.  The default is
10713 @samp{gunzip -c %s | tar xvf -}.
10714
10715 @item gnus-soup-packet-directory
10716 @vindex gnus-soup-packet-directory
10717 Where Gnus will look for reply packets.  The default is @file{~/}. 
10718
10719 @item gnus-soup-packet-regexp
10720 @vindex gnus-soup-packet-regexp
10721 Regular expression matching @sc{soup} reply packets in
10722 @code{gnus-soup-packet-directory}. 
10723
10724 @end table
10725  
10726
10727 @node SOUP Groups
10728 @subsubsection @sc{soup} Groups
10729 @cindex nnsoup
10730
10731 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10732 read incoming packets, unpack them, and put them in a directory where
10733 you can read them at leisure.
10734
10735 These are the variables you can use to customize its behavior:
10736
10737 @table @code
10738
10739 @item nnsoup-tmp-directory
10740 @vindex nnsoup-tmp-directory
10741 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10742 directory.  (@file{/tmp/} by default.)  
10743
10744 @item nnsoup-directory
10745 @vindex nnsoup-directory
10746 @code{nnsoup} then moves each message and index file to this directory.
10747 The default is @file{~/SOUP/}.
10748
10749 @item nnsoup-replies-directory 
10750 @vindex nnsoup-replies-directory 
10751 All replies will be stored in this directory before being packed into a
10752 reply packet.  The default is @file{~/SOUP/replies/"}.
10753
10754 @item nnsoup-replies-format-type
10755 @vindex nnsoup-replies-format-type
10756 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10757 (rnews), and I don't think you should touch that variable.  I probably
10758 shouldn't even have documented it.  Drats!  Too late!
10759
10760 @item nnsoup-replies-index-type
10761 @vindex nnsoup-replies-index-type
10762 The index type of the replies packet.  The default is @samp{?n}, which
10763 means ``none''.  Don't fiddle with this one either!
10764
10765 @item nnsoup-active-file
10766 @vindex nnsoup-active-file
10767 Where @code{nnsoup} stores lots of information.  This is not an ``active
10768 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10769 this file or mess it up in any way, you're dead.  The default is
10770 @file{~/SOUP/active}.
10771
10772 @item nnsoup-packer
10773 @vindex nnsoup-packer
10774 Format string command for packing a reply @sc{soup} packet.  The default
10775 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
10776
10777 @item nnsoup-unpacker
10778 @vindex nnsoup-unpacker
10779 Format string command for unpacking incoming @sc{soup} packets.  The
10780 default is @samp{gunzip -c %s | tar xvf -}. 
10781
10782 @item nnsoup-packet-directory
10783 @vindex nnsoup-packet-directory
10784 Where @code{nnsoup} will look for incoming packets.  The default is
10785 @file{~/}.  
10786
10787 @item nnsoup-packet-regexp
10788 @vindex nnsoup-packet-regexp
10789 Regular expression matching incoming @sc{soup} packets.  The default is
10790 @samp{Soupout}.
10791
10792 @item nnsoup-always-save
10793 @vindex nnsoup-always-save
10794 If non-@code{nil}, save the replies buffer after each posted message.
10795
10796 @end table
10797
10798
10799 @node SOUP Replies
10800 @subsubsection SOUP Replies
10801
10802 Just using @code{nnsoup} won't mean that your postings and mailings end
10803 up in @sc{soup} reply packets automagically.  You have to work a bit
10804 more for that to happen.
10805
10806 @findex nnsoup-set-variables
10807 The @code{nnsoup-set-variables} command will set the appropriate
10808 variables to ensure that all your followups and replies end up in the
10809 @sc{soup} system.
10810
10811 In specific, this is what it does:
10812
10813 @lisp
10814 (setq message-send-news-function 'nnsoup-request-post)
10815 (setq message-send-mail-function 'nnsoup-request-mail)
10816 @end lisp
10817
10818 And that's it, really.  If you only want news to go into the @sc{soup}
10819 system you just use the first line.  If you only want mail to be
10820 @sc{soup}ed you use the second.
10821
10822
10823 @node Web Searches
10824 @subsection Web Searches
10825 @cindex nnweb
10826 @cindex DejaNews
10827 @cindex Alta Vista
10828 @cindex InReference
10829 @cindex Usenet searches
10830 @cindex searching the Usenet
10831
10832 It's, like, too neat to search the Usenet for articles that match a
10833 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10834 those, like, Web browsers, and you, like, have to, rilly, like, look at
10835 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10836 searches without having to use a browser.
10837
10838 The @code{nnweb} backend allows an easy interface to the mighty search
10839 engine.  You create an @code{nnweb} group, enter a search pattern, and
10840 then enter the group and read the articles like you would any normal
10841 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10842 Groups}) will do this in an easy-to-use fashion.
10843
10844 @code{nnweb} groups don't really lend themselves to being solid
10845 groups---they have a very fleeting idea of article numbers.  In fact,
10846 each time you enter an @code{nnweb} group (not even changing the search
10847 pattern), you are likely to get the articles ordered in a different
10848 manner.  Not even using duplicate suppression (@pxref{Duplicate
10849 Suppression}) will help, since @code{nnweb} doesn't even know the
10850 @code{Message-ID} of the articles before reading them using some search
10851 engines (DejaNews, for instance).  The only possible way to keep track
10852 of which articles you've read is by scoring on the @code{Date}
10853 header---mark all articles posted before the last date you read the
10854 group as read.
10855
10856 If the search engine changes its output substantially, @code{nnweb}
10857 won't be able to parse it and will fail.  One could hardly fault the Web
10858 providers if they were to do this---their @emph{raison d'être} is to
10859 make money off of advertisements, not to provide services to the
10860 community.  Since @code{nnweb} washes the ads off all the articles, one
10861 might think that the providers might be somewhat miffed.  We'll see.
10862
10863 You must have the @code{url} and @code{w3} package installed to be able
10864 to use @code{nnweb}.
10865
10866 Virtual server variables:
10867
10868 @table @code
10869 @item nnweb-type
10870 @vindex nnweb-type
10871 What search engine type is being used.  The currently supported types
10872 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
10873 @code{reference}.
10874
10875 @item nnweb-search
10876 @vindex nnweb-search
10877 The search string to feed to the search engine.
10878
10879 @item nnweb-max-hits
10880 @vindex nnweb-max-hits
10881 Advisory maximum number of hits per search to display.  The default is
10882 100.
10883
10884 @item nnweb-type-definition
10885 @vindex nnweb-type-definition
10886 Type-to-definition alist.  This alist says what @code{nnweb} should do
10887 with the various search engine types.  The following elements must be
10888 present: 
10889
10890 @table @code
10891 @item article
10892 Function to decode the article and provide something that Gnus
10893 understands. 
10894
10895 @item map
10896 Function to create an article number to message header and URL alist. 
10897
10898 @item search
10899 Function to send the search string to the search engine.
10900
10901 @item address
10902 The address the aforementioned function should send the search string
10903 to. 
10904
10905 @item id
10906 Format string URL to fetch an article by @code{Message-ID}.
10907 @end table
10908
10909 @end table
10910
10911
10912
10913 @node Mail-To-News Gateways
10914 @subsection Mail-To-News Gateways
10915 @cindex mail-to-news gateways
10916 @cindex gateways
10917
10918 If your local @code{nntp} server doesn't allow posting, for some reason
10919 or other, you can post using one of the numerous mail-to-news gateways.
10920 The @code{nngateway} backend provides the interface.
10921
10922 Note that you can't read anything from this backend---it can only be
10923 used to post with.
10924
10925 Server variables:
10926
10927 @table @code
10928 @item nngateway-address 
10929 @vindex nngateway-address 
10930 This is the address of the mail-to-news gateway.
10931
10932 @item nngateway-header-transformation
10933 @vindex nngateway-header-transformation
10934 News headers often have to be transformed in some odd way or other
10935 for the mail-to-news gateway to accept it.  This variable says what 
10936 transformation should be called, and defaults to
10937 @code{nngateway-simple-header-transformation}.  The function is called
10938 narrowed to the headers to be transformed and with one parameter---the
10939 gateway address.
10940
10941 This default function just inserts a new @code{To} header based on the
10942 @code{Newsgroups} header and the gateway address.
10943 For instance, an article with this @code{Newsgroups} header:
10944
10945 @example
10946 Newsgroups: alt.religion.emacs
10947 @end example
10948
10949 will get this @code{From} header inserted:
10950
10951 @example
10952 To: alt-religion-emacs@@GATEWAY
10953 @end example
10954
10955 @end table
10956
10957 So, to use this, simply say something like:
10958
10959 @lisp
10960 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10961 @end lisp
10962
10963
10964 @node Combined Groups
10965 @section Combined Groups
10966
10967 Gnus allows combining a mixture of all the other group types into bigger
10968 groups.
10969
10970 @menu
10971 * Virtual Groups::     Combining articles from many groups.
10972 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10973 @end menu
10974
10975
10976 @node Virtual Groups
10977 @subsection Virtual Groups
10978 @cindex nnvirtual
10979 @cindex virtual groups
10980
10981 An @dfn{nnvirtual group} is really nothing more than a collection of
10982 other groups.
10983
10984 For instance, if you are tired of reading many small groups, you can
10985 put them all in one big group, and then grow tired of reading one
10986 big, unwieldy group.  The joys of computing!
10987
10988 You specify @code{nnvirtual} as the method.  The address should be a
10989 regexp to match component groups.
10990
10991 All marks in the virtual group will stick to the articles in the
10992 component groups.  So if you tick an article in a virtual group, the
10993 article will also be ticked in the component group from whence it came.
10994 (And vice versa---marks from the component groups will also be shown in
10995 the virtual group.)
10996
10997 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10998 newsgroups into one, big, happy newsgroup:
10999
11000 @lisp
11001 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11002 @end lisp
11003
11004 The component groups can be native or foreign; everything should work
11005 smoothly, but if your computer explodes, it was probably my fault.
11006
11007 Collecting the same group from several servers might actually be a good
11008 idea if users have set the Distribution header to limit distribution.
11009 If you would like to read @samp{soc.motss} both from a server in Japan
11010 and a server in Norway, you could use the following as the group regexp:
11011
11012 @example
11013 "^nntp\\+some\\.server\\.jp:soc\\.motss$\\|^nntp\\+some\\.server\\.no:soc\\.motss$"
11014 @end example
11015
11016 (Remember, though, that if you're creating the group with @kbd{G m}, you
11017 shouldn't double the backslashes, and you should leave off the quote
11018 characters at the beginning and the end of the string.)
11019
11020 This should work kinda smoothly---all articles from both groups should
11021 end up in this one, and there should be no duplicates.  Threading (and
11022 the rest) will still work as usual, but there might be problems with the
11023 sequence of articles.  Sorting on date might be an option here
11024 (@pxref{Selecting a Group}).
11025
11026 One limitation, however---all groups included in a virtual
11027 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
11028 zombie groups can't be component groups for @code{nnvirtual} groups.
11029
11030 @vindex nnvirtual-always-rescan
11031 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11032 @code{nnvirtual} will always scan groups for unread articles when
11033 entering a virtual group.  If this variable is @code{nil} (which is the
11034 default) and you read articles in a component group after the virtual
11035 group has been activated, the read articles from the component group
11036 will show up when you enter the virtual group.  You'll also see this
11037 effect if you have two virtual groups that have a component group in
11038 common.  If that's the case, you should set this variable to @code{t}.
11039 Or you can just tap @code{M-g} on the virtual group every time before
11040 you enter it---it'll have much the same effect.
11041
11042
11043 @node Kibozed Groups
11044 @subsection Kibozed Groups
11045 @cindex nnkiboze
11046 @cindex kibozing
11047
11048 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11049 the news feed''.  @code{nnkiboze} is a backend that will do this for
11050 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
11051 with useless requests!  Oh happiness!
11052
11053 @kindex G k (Group)
11054 To create a kibozed group, use the @kbd{G k} command in the group
11055 buffer. 
11056
11057 The address field of the @code{nnkiboze} method is, as with
11058 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11059 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
11060 and @code{nnvirtual} end.
11061
11062 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11063 must have a score file to say what articles are to be included in
11064 the group (@pxref{Scoring}).
11065
11066 @kindex M-x nnkiboze-generate-groups
11067 @findex nnkiboze-generate-groups
11068 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11069 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
11070 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
11071 all the articles in all the component groups and run them through the
11072 scoring process to determine if there are any articles in the groups
11073 that are to be part of the @code{nnkiboze} groups.
11074
11075 Please limit the number of component groups by using restrictive
11076 regexps.  Otherwise your sysadmin may become annoyed with you, and the
11077 @sc{nntp} site may throw you off and never let you back in again.
11078 Stranger things have happened.
11079
11080 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11081 and they can be foreign.  No restrictions.
11082
11083 @vindex nnkiboze-directory
11084 The generation of an @code{nnkiboze} group means writing two files in
11085 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
11086 contains the @sc{nov} header lines for all the articles in the group,
11087 and the other is an additional @file{.newsrc} file to store information
11088 on what groups have been searched through to find component articles.
11089
11090 Articles marked as read in the @code{nnkiboze} group will have
11091 their @sc{nov} lines removed from the @sc{nov} file.
11092
11093
11094 @node Gnus Unplugged
11095 @section Gnus Unplugged
11096 @cindex offline
11097 @cindex unplugged
11098 @cindex Agent
11099 @cindex Gnus Agent
11100 @cindex Gnus Unplugged
11101
11102 In olden times (ca. February '88), people used to run their newsreaders
11103 on big machines with permanent connections to the net.  News transport
11104 was dealt with by news servers, and all the newsreaders had to do was to
11105 read news.  Believe it or not.
11106
11107 Nowadays most people read news and mail at home, and use some sort of
11108 modem to connect to the net.  To avoid running up huge phone bills, it
11109 would be nice to have a way to slurp down all the news and mail, hang up
11110 the phone, read for several hours, and then upload any responses you
11111 have to make.  And then you repeat the procedure.
11112
11113 Of course, you can use news servers for doing this as well.  I've used
11114 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11115 for some years, but doing that's a bore.  Moving the news server
11116 functionality up to the newsreader makes sense if you're the only person
11117 reading news on a machine.
11118
11119 Using Gnus as an ``offline'' newsreader is quite simple.
11120
11121 @itemize @bullet
11122 @item
11123 First, set up Gnus as you would do if you were running it on a machine
11124 that has full connection to the net.  Go ahead.  I'll still be waiting
11125 here.
11126
11127 @item
11128 Then, put the following magical incantation at the end of your
11129 @file{.gnus.el} file:
11130
11131 @lisp
11132 (gnus-agentize)
11133 @end lisp
11134 @end itemize
11135
11136 That's it.  Gnus is now an ``offline'' newsreader.
11137
11138 Of course, to use it as such, you have to learn a few new commands.
11139
11140 @menu
11141 * Agent Basics::           How it all is supposed to work.
11142 * Agent Categories::       How to tell the Gnus Agent what to download.
11143 * Agent Commands::         New commands for all the buffers.
11144 * Outgoing Messages::      What happens when you post/mail something?
11145 * Agent Variables::        Customizing is fun.
11146 * Example Setup::          An example @file{.gnus.el} file for offline people.
11147 * Batching Agents::        How to fetch news from a @code{cron} job.
11148 @end menu
11149
11150
11151 @node Agent Basics
11152 @subsection Agent Basics
11153
11154 First, let's get some terminology out of the way.
11155
11156 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11157 connection to the net (and notified the Agent that this is the case).
11158 When the connection to the net is up again (and Gnus knows this), the
11159 Agent is @dfn{plugged}.
11160
11161 The @dfn{local} machine is the one you're running on, and which isn't
11162 connected to the net continously.
11163
11164 @dfn{Downloading} means fetching things from the net to your local
11165 machine.  @dfn{Uploading} is doing the opposite.
11166
11167 Let's take a typical Gnus session using the Agent.
11168
11169 @itemize @bullet
11170
11171 @item
11172 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
11173 Agent in a disconnected state.  You can read all the news that you have
11174 already fetched while in this mode.
11175
11176 @item
11177 You then decide to see whether any new news has arrived.  You connect
11178 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11179 to make Gnus become @dfn{plugged}.
11180
11181 @item
11182 You can then read the new news immediately, or you can download the news
11183 onto your local machine.  If you want to do the latter, you press @kbd{J
11184 s} to fetch all the eligible articles in all the groups.  (To let Gnus
11185 know which articles you want to download, @pxref{Agent Categories}.)
11186
11187 @item
11188 After fetching the articles, you press @kbd{J j} to make Gnus become
11189 unplugged again, and you shut down the PPP thing (or whatever).  And
11190 then you read the news offline.
11191
11192 @item
11193 And then you go to step 2.
11194 @end itemize
11195
11196 Here are some things you should do the first time (or so) that you use
11197 the Agent.
11198
11199 @itemize @bullet
11200
11201 @item
11202 Decide which servers should be covered by the Agent.  If you have a mail
11203 backend, it would probably be nonsensical to have it covered by the
11204 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
11205 @kbd{J a} the server (or servers) that you wish to have covered by the
11206 Agent (@pxref{Server Agent Commands}).  This will typically be only the
11207 primary select method, which is listed on the bottom in the buffer.
11208
11209 @item
11210 Decide on download policy.  @xref{Agent Categories}
11211
11212 @item
11213 Uhm... that's it.
11214 @end itemize
11215
11216
11217 @node Agent Categories
11218 @subsection Agent Categories
11219
11220 One of the main reasons to integrate the news transport layer into the
11221 newsreader is to allow greater control over what articles to download.
11222 There's not much point in downloading huge amounts of articles, just to
11223 find out that you're not interested in reading any of them.  It's better
11224 to be somewhat more conservative in choosing what to download, and then
11225 mark the articles for downloading manually if it should turn out that
11226 you're interested in the articles anyway.
11227
11228 The main way to control what is to be downloaded is to create a
11229 @dfn{category} and then assign some (or all) groups to this category. 
11230 Gnus has its own buffer for creating and managing categories.
11231
11232 @menu
11233 * Category Syntax::       What a category looks like.
11234 * The Category Buffer::   A buffer for maintaining categories.
11235 * Category Variables::    Customize'r'Us.
11236 @end menu
11237
11238
11239 @node Category Syntax
11240 @subsubsection Category Syntax
11241
11242 A category consists of two things.
11243
11244 @enumerate
11245 @item
11246 A predicate which (generally) gives a rough outline of which articles
11247 are eligible for downloading; and
11248
11249 @item
11250 a score rule which (generally) gives you a finer granularity when
11251 deciding what articles to download.  (Note that this @dfn{download
11252 score} is wholly unrelated to normal scores.)
11253 @end enumerate
11254
11255 A predicate consists of predicates with logical operators sprinkled in
11256 between.
11257
11258 Perhaps some examples are in order.
11259
11260 Here's a simple predicate.  (It's the default predicate, in fact, used
11261 for all groups that don't belong to any other category.)
11262
11263 @lisp
11264 short
11265 @end lisp
11266
11267 Quite simple, eh?  This predicate is true if and only if the article is
11268 short (for some value of ``short'').
11269
11270 Here's a more complex predicate:
11271
11272 @lisp
11273 (or high
11274     (and
11275      (not low)
11276      (not long)))
11277 @end lisp
11278
11279 This means that an article should be downloaded if it has a high score,
11280 or if the score is not low and the article is not long.  You get the
11281 drift.
11282
11283 The available logical operators are @code{or}, @code{and} and
11284 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
11285 @samp{|}, @code{&} and @code{!} instead.)
11286
11287 The following predicates are pre-defined, but if none of these fit what
11288 you want to do, you can write your own.
11289
11290 @table @code
11291 @item short
11292 True iff the article is shorter than @code{gnus-agent-short-article}
11293 lines; default 100.
11294
11295 @item long
11296 True iff the article is longer than @code{gnus-agent-long-article}
11297 lines; default 200.
11298
11299 @item low
11300 True iff the article has a download score less than
11301 @code{gnus-agent-low-score}; default 0.
11302
11303 @item high
11304 True iff the article has a download score greater than
11305 @code{gnus-agent-high-score}; default 0.
11306
11307 @item spam
11308 True iff the Gnus Agent guesses that the article is spam.  The
11309 heuristics may change over time, but at present it just computes a
11310 checksum and sees whether articles match.
11311
11312 @item true
11313 Always true.
11314
11315 @item false
11316 Always false.
11317 @end table
11318
11319 If you want to create your own predicate function, here's what you have
11320 to know:  The functions are called with no parameters, but the
11321 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11322 useful values.
11323
11324 Now, the syntax of the download score is the same as the syntax of
11325 normal score files, except that all elements that require actually
11326 seeing the article itself are verboten.  This means that only the
11327 following headers can be scored on: @code{From}, @code{Subject},
11328 @code{Date}, @code{Xref}, @code{Lines}, @code{Chars}, @code{Message-ID},
11329 and @code{References}.
11330
11331
11332 @node The Category Buffer
11333 @subsubsection The Category Buffer
11334
11335 You'd normally do all category maintenance from the category buffer.
11336 When you enter it for the first time (with the @kbd{J c} command from
11337 the group buffer), you'll only see the @code{default} category.
11338
11339 The following commands are available in this buffer:
11340
11341 @table @kbd
11342 @item q
11343 @kindex q (Category)
11344 @findex gnus-category-exit
11345 Return to the group buffer (@code{gnus-category-exit}).
11346
11347 @item k
11348 @kindex k (Category)
11349 @findex gnus-category-kill
11350 Kill the current category (@code{gnus-category-kill}).
11351
11352 @item c
11353 @kindex c (Category)
11354 @findex gnus-category-copy
11355 Copy the current category (@code{gnus-category-copy}).
11356
11357 @item a
11358 @kindex a (Category)
11359 @findex gnus-category-add
11360 Add a new category (@code{gnus-category-add}).
11361
11362 @item p
11363 @kindex p (Category)
11364 @findex gnus-category-edit-predicate
11365 Edit the predicate of the current category
11366 (@code{gnus-category-edit-predicate}).
11367
11368 @item g
11369 @kindex g (Category)
11370 @findex gnus-category-edit-groups
11371 Edit the list of groups belonging to the current category
11372 (@code{gnus-category-edit-groups}).
11373
11374 @item s
11375 @kindex s (Category)
11376 @findex gnus-category-edit-score
11377 Edit the download score rule of the current category
11378 (@code{gnus-category-edit-score}).
11379
11380 @item l
11381 @kindex l (Category)
11382 @findex gnus-category-list
11383 List all the categories (@code{gnus-category-list}).
11384 @end table
11385
11386
11387 @node Category Variables
11388 @subsubsection Category Variables
11389
11390 @table @code
11391 @item gnus-category-mode-hook
11392 @vindex gnus-category-mode-hook
11393 Hook run in category buffers.
11394
11395 @item gnus-category-line-format
11396 @vindex gnus-category-line-format
11397 Format of the lines in the category buffer (@pxref{Formatting
11398 Variables}).  Legal elements are:
11399
11400 @table @samp
11401 @item c
11402 The name of the category.
11403
11404 @item g
11405 The number of groups in the category.
11406 @end table
11407
11408 @item gnus-category-mode-line-format
11409 @vindex gnus-category-mode-line-format
11410 Format of the category mode line.
11411
11412 @item gnus-agent-short-article 
11413 @vindex gnus-agent-short-article 
11414 Articles that have fewer lines than this are short.  Default 100.
11415
11416 @item gnus-agent-long-article 
11417 @vindex gnus-agent-long-article 
11418 Articles that have more lines than this are long.  Default 200.
11419
11420 @item gnus-agent-low-score 
11421 @vindex gnus-agent-low-score 
11422 Articles that have a score lower than this have a low score.  Default
11423 0. 
11424
11425 @item gnus-agent-high-score 
11426 @vindex gnus-agent-high-score 
11427 Articles that have a score higher than this have a high score.  Default
11428 0. 
11429
11430 @end table
11431
11432
11433 @node Agent Commands
11434 @subsection Agent Commands
11435
11436 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
11437 (@code{gnus-agent-toggle-plugged} command works in all modes, and
11438 toggles the plugged/unplugged state of the Gnus Agent.
11439
11440
11441 @menu
11442 * Group Agent Commands::
11443 * Summary Agent Commands::
11444 * Server Agent Commands::
11445 @end menu
11446
11447 You can run a complete batch fetch from the command line with the
11448 following incantation:
11449
11450 @cindex gnus-agent-batch-fetch
11451 @example
11452 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
11453 @end example
11454
11455
11456
11457 @node Group Agent Commands
11458 @subsubsection Group Agent Commands
11459
11460 @table @kbd
11461 @item J u 
11462 @kindex J u (Agent Group)
11463 @findex gnus-agent-fetch-groups
11464 Fetch all eligible articles in the current group
11465 (@code{gnus-agent-fetch-groups}).
11466
11467 @item J c
11468 @kindex J c (Agent Group)
11469 @findex gnus-enter-category-buffer
11470 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
11471
11472 @item J s
11473 @kindex J s (Agent Group)
11474 @findex gnus-agent-fetch-session
11475 Fetch all eligible articles in all groups
11476 (@code{gnus-agent-fetch-session}).
11477
11478 @item J S
11479 @kindex J S (Agent Group)
11480 @findex gnus-group-send-drafts
11481 Send all sendable messages in the draft group
11482 (@code{gnus-agent-fetch-session}).  @xref{Drafts}
11483
11484 @item J a
11485 @kindex J a (Agent Group)
11486 @findex gnus-agent-add-group
11487 Add the current group to an Agent category
11488 (@code{gnus-agent-add-group}).
11489
11490 @end table
11491
11492
11493 @node Summary Agent Commands
11494 @subsubsection Summary Agent Commands
11495
11496 @table @kbd
11497 @item J #
11498 @kindex J # (Agent Summary)
11499 @findex gnus-agent-mark-article
11500 Mark the article for downloading (@code{gnus-agent-mark-article}).
11501
11502 @item J M-#
11503 @kindex J M-# (Agent Summary)
11504 @findex gnus-agent-unmark-article
11505 Remove the downloading mark from the article
11506 (@code{gnus-agent-unmark-article}).
11507
11508 @item @@
11509 @kindex @@ (Agent Summary)
11510 @findex gnus-agent-toggle-mark
11511 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
11512
11513 @item J c
11514 @kindex J c (Agent Summary)
11515 @findex gnus-agent-catchup
11516 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
11517
11518 @end table
11519
11520
11521 @node Server Agent Commands
11522 @subsubsection Server Agent Commands
11523
11524 @table @kbd
11525 @item J a
11526 @kindex J a (Agent Server)
11527 @findex gnus-agent-add-server
11528 Add the current server to the list of servers covered by the Gnus Agent
11529 (@code{gnus-agent-add-server}).
11530
11531 @item J r
11532 @kindex J r (Agent Server)
11533 @findex gnus-agent-remove-server
11534 Remove the current server from the list of servers covered by the Gnus
11535 Agent (@code{gnus-agent-remove-server}).
11536
11537 @end table
11538
11539
11540 @node Outgoing Messages
11541 @subsection Outgoing Messages
11542
11543 When Gnus is unplugged, all outgoing messages (both mail and news) are
11544 stored in the draft groups (@pxref{Drafts}).  You can view them there
11545 after posting, and edit them at will.
11546
11547 When Gnus is plugged again, you can send the messages either from the
11548 draft group with the special commands available there, or you can use
11549 the @kbd{J S} command in the group buffer to send all the sendable
11550 messages in the draft group.
11551
11552
11553
11554 @node Agent Variables
11555 @subsection Agent Variables
11556
11557 @table @code
11558 @item gnus-agent-directory
11559 @vindex gnus-agent-directory
11560 Where the Gnus Agent will store its files.  The default is
11561 @file{~/News/agent/}.
11562
11563 @item gnus-agent-handle-level
11564 @vindex gnus-agent-handle-level
11565 Groups on levels (@pxref{Group Levels}) higher than this variable will
11566 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
11567 which means that only subscribed group will be considered by the Agent
11568 by default.
11569
11570 @item gnus-agent-plugged-hook
11571 @vindex gnus-agent-plugged-hook
11572 Hook run when connecting to the network.
11573
11574 @item gnus-agent-unplugged-hook
11575 @vindex gnus-agent-unplugged-hook
11576 Hook run when disconnecting from the network.
11577
11578 @end table
11579
11580
11581 @node Example Setup
11582 @subsection Example Setup
11583
11584 If you don't want to read this manual, and you have a fairly standard
11585 setup, you may be able to use something like the following as your
11586 @file{.gnus.el} file to get started.
11587
11588 @lisp
11589 ;;; Define how Gnus is to fetch news.  We do this over NNTP
11590 ;;; from your ISP's server.
11591 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
11592
11593 ;;; Define how Gnus is to read your mail.  We read mail from
11594 ;;; your ISP's POP server.
11595 (setenv "MAILHOST" "pop.your-isp.com")
11596 (setq nnmail-spool-file "po:username")
11597
11598 ;;; Say how Gnus is to store the mail.  We use nnml groups.
11599 (setq gnus-secondary-select-methods '((nnml "")))
11600
11601 ;;; Make Gnus into an offline newsreader.
11602 (gnus-agentize)
11603 @end lisp
11604
11605 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
11606 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
11607 gnus}.
11608
11609 If this is the first time you've run Gnus, you will be subscribed
11610 automatically to a few default newsgroups.  You'll probably want to
11611 subscribe to more groups, and to do that, you have to query the
11612 @sc{nntp} server for a complete list of groups with the @kbd{A A}
11613 command.  This usually takes quite a while, but you only have to do it
11614 once.
11615
11616 After reading and parsing a while, you'll be presented with a list of
11617 groups.  Subscribe to the ones you want to read with the @kbd{u}
11618 command.  @kbd{l} to make all the killed groups disappear after you've
11619 subscribe to all the groups you want to read.  (@kbd{A k} will bring
11620 back all the killed groups.)
11621
11622 You can now read the groups at once, or you can download the articles
11623 with the @kbd{J s} command.  And then read the rest of this manual to
11624 find out which of the other gazillion things you want to customize.
11625
11626
11627 @node Batching Agents
11628 @subsection Batching Agents
11629
11630 Having the Gnus Agent fetch articles (and post whatever messages you've
11631 written) is quite easy once you've gotten things set up properly.  The
11632 following shell script will do everything that is necessary:
11633
11634 @example
11635 #!/bin/sh
11636 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
11637 @end example
11638
11639
11640
11641 @node Scoring
11642 @chapter Scoring
11643 @cindex scoring
11644
11645 Other people use @dfn{kill files}, but we here at Gnus Towers like
11646 scoring better than killing, so we'd rather switch than fight.  They do
11647 something completely different as well, so sit up straight and pay
11648 attention!
11649
11650 @vindex gnus-summary-mark-below
11651 All articles have a default score (@code{gnus-summary-default-score}),
11652 which is 0 by default.  This score may be raised or lowered either
11653 interactively or by score files.  Articles that have a score lower than
11654 @code{gnus-summary-mark-below} are marked as read.
11655
11656 Gnus will read any @dfn{score files} that apply to the current group
11657 before generating the summary buffer.
11658
11659 There are several commands in the summary buffer that insert score
11660 entries based on the current article.  You can, for instance, ask Gnus to
11661 lower or increase the score of all articles with a certain subject.
11662
11663 There are two sorts of scoring entries: Permanent and temporary.
11664 Temporary score entries are self-expiring entries.  Any entries that are
11665 temporary and have not been used for, say, a week, will be removed
11666 silently to help keep the sizes of the score files down.
11667
11668 @menu 
11669 * Summary Score Commands::   Adding score entries for the current group.
11670 * Group Score Commands::     General score commands.
11671 * Score Variables::          Customize your scoring.  (My, what terminology).
11672 * Score File Format::        What a score file may contain.
11673 * Score File Editing::       You can edit score files by hand as well.
11674 * Adaptive Scoring::         Big Sister Gnus knows what you read.
11675 * Home Score File::          How to say where new score entries are to go.
11676 * Followups To Yourself::    Having Gnus notice when people answer you.
11677 * Scoring Tips::             How to score effectively.
11678 * Reverse Scoring::          That problem child of old is not problem.
11679 * Global Score Files::       Earth-spanning, ear-splitting score files.
11680 * Kill Files::               They are still here, but they can be ignored.
11681 * Converting Kill Files::    Translating kill files to score files.
11682 * GroupLens::                Getting predictions on what you like to read.
11683 * Advanced Scoring::         Using logical expressions to build score rules.
11684 * Score Decays::             It can be useful to let scores wither away.
11685 @end menu
11686
11687
11688 @node Summary Score Commands
11689 @section Summary Score Commands
11690 @cindex score commands
11691
11692 The score commands that alter score entries do not actually modify real
11693 score files.  That would be too inefficient.  Gnus maintains a cache of
11694 previously loaded score files, one of which is considered the
11695 @dfn{current score file alist}.  The score commands simply insert
11696 entries into this list, and upon group exit, this list is saved.
11697
11698 The current score file is by default the group's local score file, even
11699 if no such score file actually exists.  To insert score commands into
11700 some other score file (e.g. @file{all.SCORE}), you must first make this
11701 score file the current one.
11702
11703 General score commands that don't actually change the score file:
11704
11705 @table @kbd
11706
11707 @item V s
11708 @kindex V s (Summary)
11709 @findex gnus-summary-set-score
11710 Set the score of the current article (@code{gnus-summary-set-score}).  
11711
11712 @item V S
11713 @kindex V S (Summary)
11714 @findex gnus-summary-current-score
11715 Display the score of the current article
11716 (@code{gnus-summary-current-score}).   
11717
11718 @item V t
11719 @kindex V t (Summary)
11720 @findex gnus-score-find-trace
11721 Display all score rules that have been used on the current article
11722 (@code{gnus-score-find-trace}).   
11723
11724 @item V R
11725 @kindex V R (Summary)
11726 @findex gnus-summary-rescore
11727 Run the current summary through the scoring process
11728 (@code{gnus-summary-rescore}).  This might be useful if you're playing
11729 around with your score files behind Gnus' back and want to see the
11730 effect you're having.
11731
11732 @item V a
11733 @kindex V a (Summary)
11734 @findex gnus-summary-score-entry
11735 Add a new score entry, and allow specifying all elements 
11736 (@code{gnus-summary-score-entry}).
11737
11738 @item V c
11739 @kindex V c (Summary)
11740 @findex gnus-score-change-score-file
11741 Make a different score file the current
11742 (@code{gnus-score-change-score-file}). 
11743
11744 @item V e
11745 @kindex V e (Summary)
11746 @findex gnus-score-edit-current-scores
11747 Edit the current score file (@code{gnus-score-edit-current-scores}).
11748 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
11749 File Editing}).
11750
11751 @item V f
11752 @kindex V f (Summary)
11753 @findex gnus-score-edit-file
11754 Edit a score file and make this score file the current one
11755 (@code{gnus-score-edit-file}).
11756
11757 @item V F
11758 @kindex V F (Summary)
11759 @findex gnus-score-flush-cache
11760 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
11761 after editing score files.
11762
11763 @item V C
11764 @kindex V C (Summary)
11765 @findex gnus-score-customize
11766 Customize a score file in a visually pleasing manner
11767 (@code{gnus-score-customize}). 
11768
11769 @end table
11770
11771 The rest of these commands modify the local score file.
11772
11773 @table @kbd
11774
11775 @item V m
11776 @kindex V m (Summary)
11777 @findex gnus-score-set-mark-below
11778 Prompt for a score, and mark all articles with a score below this as
11779 read (@code{gnus-score-set-mark-below}).
11780
11781 @item V x
11782 @kindex V x (Summary)
11783 @findex gnus-score-set-expunge-below
11784 Prompt for a score, and add a score rule to the current score file to
11785 expunge all articles below this score
11786 (@code{gnus-score-set-expunge-below}).
11787 @end table
11788
11789 The keystrokes for actually making score entries follow a very regular
11790 pattern, so there's no need to list all the commands.  (Hundreds of
11791 them.)  
11792
11793 @findex gnus-summary-increase-score
11794 @findex gnus-summary-lower-score
11795
11796 @enumerate
11797 @item
11798 The first key is either @kbd{I} (upper case i) for increasing the score
11799 or @kbd{L} for lowering the score. 
11800 @item
11801 The second key says what header you want to score on.  The following
11802 keys are available:
11803 @table @kbd
11804
11805 @item a
11806 Score on the author name.
11807
11808 @item s
11809 Score on the subject line.
11810
11811 @item x
11812 Score on the Xref line---i.e., the cross-posting line.
11813
11814 @item t
11815 Score on thread---the References line.
11816
11817 @item d
11818 Score on the date.
11819
11820 @item l
11821 Score on the number of lines.
11822
11823 @item i
11824 Score on the Message-ID.
11825
11826 @item f
11827 Score on followups.
11828
11829 @item b
11830 Score on the body.
11831
11832 @item h
11833 Score on the head.
11834 @end table
11835
11836 @item
11837 The third key is the match type.  Which match types are valid depends on
11838 what headers you are scoring on.
11839
11840 @table @code
11841
11842 @item strings 
11843
11844 @table @kbd
11845
11846 @item e
11847 Exact matching.
11848
11849 @item s
11850 Substring matching.
11851
11852 @item f
11853 Fuzzy matching (@pxref{Fuzzy Matching}).
11854
11855 @item r
11856 Regexp matching
11857 @end table
11858
11859 @item date
11860 @table @kbd
11861
11862 @item b
11863 Before date.
11864
11865 @item a
11866 At date.
11867
11868 @item n
11869 This date.
11870 @end table
11871
11872 @item number
11873 @table @kbd
11874
11875 @item <
11876 Less than number.
11877
11878 @item =
11879 Equal to number.
11880
11881 @item >
11882 Greater than number.
11883 @end table
11884 @end table
11885
11886 @item 
11887 The fourth and final key says whether this is a temporary (i.e., expiring)
11888 score entry, or a permanent (i.e., non-expiring) score entry, or whether
11889 it is to be done immediately, without adding to the score file.
11890 @table @kbd
11891
11892 @item t
11893 Temporary score entry.
11894
11895 @item p
11896 Permanent score entry.
11897
11898 @item i
11899 Immediately scoring.
11900 @end table
11901
11902 @end enumerate
11903
11904 So, let's say you want to increase the score on the current author with
11905 exact matching permanently: @kbd{I a e p}.  If you want to lower the
11906 score based on the subject line, using substring matching, and make a
11907 temporary score entry: @kbd{L s s t}.  Pretty easy.
11908
11909 To make things a bit more complicated, there are shortcuts.  If you use
11910 a capital letter on either the second or third keys, Gnus will use
11911 defaults for the remaining one or two keystrokes.  The defaults are
11912 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
11913 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
11914
11915 These functions take both the numerical prefix and the symbolic prefix
11916 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
11917 (or increase) the score of the article.  A symbolic prefix of @code{a}
11918 says to use the @file{all.SCORE} file for the command instead of the
11919 current score file.
11920
11921 @vindex gnus-score-mimic-keymap
11922 The @code{gnus-score-mimic-keymap} says whether these commands will
11923 pretend they are keymaps or not.
11924
11925
11926 @node Group Score Commands
11927 @section Group Score Commands
11928 @cindex group score commands
11929
11930 There aren't many of these as yet, I'm afraid.
11931
11932 @table @kbd
11933
11934 @item W f
11935 @kindex W f (Group)
11936 @findex gnus-score-flush-cache
11937 Gnus maintains a cache of score alists to avoid having to reload them
11938 all the time.  This command will flush the cache
11939 (@code{gnus-score-flush-cache}). 
11940
11941 @end table
11942
11943 You can do scoring from the command line by saying something like:
11944
11945 @findex gnus-batch-score
11946 @cindex batch scoring
11947 @example
11948 $ emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score
11949 @end example
11950
11951
11952 @node Score Variables
11953 @section Score Variables
11954 @cindex score variables
11955
11956 @table @code
11957
11958 @item gnus-use-scoring
11959 @vindex gnus-use-scoring
11960 If @code{nil}, Gnus will not check for score files, and will not, in
11961 general, do any score-related work.  This is @code{t} by default.
11962
11963 @item gnus-kill-killed
11964 @vindex gnus-kill-killed
11965 If this variable is @code{nil}, Gnus will never apply score files to
11966 articles that have already been through the kill process.  While this
11967 may save you lots of time, it also means that if you apply a kill file
11968 to a group, and then change the kill file and want to run it over you
11969 group again to kill more articles, it won't work.  You have to set this
11970 variable to @code{t} to do that.  (It is @code{t} by default.)
11971
11972 @item gnus-kill-files-directory
11973 @vindex gnus-kill-files-directory
11974 All kill and score files will be stored in this directory, which is
11975 initialized from the @code{SAVEDIR} environment variable by default.
11976 This is @file{~/News/} by default.
11977
11978 @item gnus-score-file-suffix
11979 @vindex gnus-score-file-suffix
11980 Suffix to add to the group name to arrive at the score file name
11981 (@samp{SCORE} by default.)
11982
11983 @item gnus-score-uncacheable-files
11984 @vindex gnus-score-uncacheable-files
11985 @cindex score cache
11986 All score files are normally cached to avoid excessive re-loading of
11987 score files.  However, if this might make you Emacs grow big and
11988 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
11989 @file{all.SCORE}, while it might be a good idea to not cache
11990 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
11991 variable is @samp{ADAPT$} by default, so no adaptive score files will
11992 be cached.
11993
11994 @item gnus-save-score
11995 @vindex gnus-save-score
11996 If you have really complicated score files, and do lots of batch
11997 scoring, then you might set this variable to @code{t}.  This will make
11998 Gnus save the scores into the @file{.newsrc.eld} file.
11999
12000 @item gnus-score-interactive-default-score
12001 @vindex gnus-score-interactive-default-score
12002 Score used by all the interactive raise/lower commands to raise/lower
12003 score with.  Default is 1000, which may seem excessive, but this is to
12004 ensure that the adaptive scoring scheme gets enough room to play with.
12005 We don't want the small changes from the adaptive scoring to overwrite
12006 manually entered data.
12007
12008 @item gnus-summary-default-score
12009 @vindex gnus-summary-default-score
12010 Default score of an article, which is 0 by default.
12011
12012 @item gnus-summary-expunge-below
12013 @vindex gnus-summary-expunge-below
12014 Don't display the summary lines of articles that have scores lower than
12015 this variable.  This is @code{nil} by default, which means that no
12016 articles will be hidden.  This variable is local to the summary buffers,
12017 and has to be set from @code{gnus-summary-mode-hook}.
12018
12019 @item gnus-score-over-mark
12020 @vindex gnus-score-over-mark
12021 Mark (in the third column) used for articles with a score over the
12022 default.  Default is @samp{+}.
12023
12024 @item gnus-score-below-mark
12025 @vindex gnus-score-below-mark
12026 Mark (in the third column) used for articles with a score below the
12027 default.  Default is @samp{-}.
12028
12029 @item gnus-score-find-score-files-function
12030 @vindex gnus-score-find-score-files-function
12031 Function used to find score files for the current group.  This function
12032 is called with the name of the group as the argument. 
12033
12034 Predefined functions available are:
12035 @table @code
12036
12037 @item gnus-score-find-single
12038 @findex gnus-score-find-single
12039 Only apply the group's own score file.
12040
12041 @item gnus-score-find-bnews
12042 @findex gnus-score-find-bnews
12043 Apply all score files that match, using bnews syntax.  This is the
12044 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
12045 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12046 @file{gnu.all.SCORE} would all apply.  In short, the instances of
12047 @samp{all} in the score file names are translated into @samp{.*}, and
12048 then a regexp match is done.
12049
12050 This means that if you have some score entries that you want to apply to
12051 all groups, then you put those entries in the @file{all.SCORE} file. 
12052
12053 The score files are applied in a semi-random order, although Gnus will
12054 try to apply the more general score files before the more specific score
12055 files.  It does this by looking at the number of elements in the score
12056 file names---discarding the @samp{all} elements.
12057
12058 @item gnus-score-find-hierarchical
12059 @findex gnus-score-find-hierarchical
12060 Apply all score files from all the parent groups.  This means that you
12061 can't have score files like @file{all.SCORE}, but you can have
12062 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12063
12064 @end table
12065 This variable can also be a list of functions.  In that case, all these
12066 functions will be called, and all the returned lists of score files will
12067 be applied.  These functions can also return lists of score alists
12068 directly.  In that case, the functions that return these non-file score
12069 alists should probably be placed before the ``real'' score file
12070 functions, to ensure that the last score file returned is the local
12071 score file.  Phu.
12072
12073 @item gnus-score-expiry-days
12074 @vindex gnus-score-expiry-days
12075 This variable says how many days should pass before an unused score file
12076 entry is expired.  If this variable is @code{nil}, no score file entries
12077 are expired.  It's 7 by default.
12078
12079 @item gnus-update-score-entry-dates
12080 @vindex gnus-update-score-entry-dates
12081 If this variable is non-@code{nil}, matching score entries will have
12082 their dates updated.  (This is how Gnus controls expiry---all
12083 non-matching entries will become too old while matching entries will
12084 stay fresh and young.)  However, if you set this variable to @code{nil},
12085 even matching entries will grow old and will have to face that oh-so
12086 grim reaper.  
12087
12088 @item gnus-score-after-write-file-function
12089 @vindex gnus-score-after-write-file-function
12090 Function called with the name of the score file just written.
12091
12092 @item gnus-score-thread-simplify
12093 @vindex gnus-score-thread-simplify
12094 If this variable is non-@code{nil}, article subjects will be simplified
12095 for subject scoring purposes in the same manner as with
12096 threading---according to the current value of
12097 gnus-simplify-subject-functions.  If the scoring entry uses
12098 @code{substring} or @code{exact} matching, the match will also be
12099 simplified in this manner.
12100
12101 @end table
12102
12103
12104 @node Score File Format
12105 @section Score File Format
12106 @cindex score file format
12107
12108 A score file is an @code{emacs-lisp} file that normally contains just a
12109 single form.  Casual users are not expected to edit these files;
12110 everything can be changed from the summary buffer.
12111
12112 Anyway, if you'd like to dig into it yourself, here's an example:
12113
12114 @lisp
12115 (("from"
12116   ("Lars Ingebrigtsen" -10000)
12117   ("Per Abrahamsen")
12118   ("larsi\\|lmi" -50000 nil R))
12119  ("subject"
12120   ("Ding is Badd" nil 728373))
12121  ("xref"
12122   ("alt.politics" -1000 728372 s))
12123  ("lines"
12124   (2 -100 nil <))
12125  (mark 0)
12126  (expunge -1000)
12127  (mark-and-expunge -10)
12128  (read-only nil)
12129  (orphan -10)
12130  (adapt t)
12131  (files "/hom/larsi/News/gnu.SCORE")
12132  (exclude-files "all.SCORE")
12133  (local (gnus-newsgroup-auto-expire t)
12134         (gnus-summary-make-false-root empty))
12135  (eval (ding)))
12136 @end lisp
12137
12138 This example demonstrates most score file elements.  For a different
12139 approach, see @pxref{Advanced Scoring}.
12140
12141 Even though this looks much like lisp code, nothing here is actually
12142 @code{eval}ed.  The lisp reader is used to read this form, though, so it
12143 has to be valid syntactically, if not semantically.
12144
12145 Six keys are supported by this alist:
12146
12147 @table @code
12148
12149 @item STRING
12150 If the key is a string, it is the name of the header to perform the
12151 match on.  Scoring can only be performed on these eight headers:
12152 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
12153 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
12154 these headers, there are three strings to tell Gnus to fetch the entire
12155 article and do the match on larger parts of the article: @code{Body}
12156 will perform the match on the body of the article, @code{Head} will
12157 perform the match on the head of the article, and @code{All} will
12158 perform the match on the entire article.  Note that using any of these
12159 last three keys will slow down group entry @emph{considerably}.  The
12160 final ``header'' you can score on is @code{Followup}.  These score
12161 entries will result in new score entries being added for all follow-ups
12162 to articles that matches these score entries.
12163
12164 Following this key is a arbitrary number of score entries, where each
12165 score entry has one to four elements.
12166 @enumerate
12167
12168 @item 
12169 The first element is the @dfn{match element}.  On most headers this will
12170 be a string, but on the Lines and Chars headers, this must be an
12171 integer. 
12172
12173 @item 
12174 If the second element is present, it should be a number---the @dfn{score
12175 element}.  This number should be an integer in the neginf to posinf
12176 interval.  This number is added to the score of the article if the match
12177 is successful.  If this element is not present, the
12178 @code{gnus-score-interactive-default-score} number will be used
12179 instead.  This is 1000 by default.
12180
12181 @item 
12182 If the third element is present, it should be a number---the @dfn{date
12183 element}.  This date says when the last time this score entry matched,
12184 which provides a mechanism for expiring the score entries.  It this
12185 element is not present, the score entry is permanent.  The date is
12186 represented by the number of days since December 31, 1 BCE.
12187
12188 @item 
12189 If the fourth element is present, it should be a symbol---the @dfn{type
12190 element}.  This element specifies what function should be used to see
12191 whether this score entry matches the article.  What match types that can
12192 be used depends on what header you wish to perform the match on.
12193 @table @dfn
12194
12195 @item From, Subject, References, Xref, Message-ID
12196 For most header types, there are the @code{r} and @code{R} (regexp), as
12197 well as @code{s} and @code{S} (substring) types, and @code{e} and
12198 @code{E} (exact match), and @code{w} (word match) types.  If this
12199 element is not present, Gnus will assume that substring matching should
12200 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
12201 that the matches will be done in a case-sensitive manner.  All these
12202 one-letter types are really just abbreviations for the @code{regexp},
12203 @code{string}, @code{exact}, and @code{word} types, which you can use
12204 instead, if you feel like.
12205
12206 @item Lines, Chars
12207 These two headers use different match types: @code{<}, @code{>},
12208 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
12209 careful because some backends (like @code{nndir}) do not generate
12210 @code{Lines} header, so every article ends up being marked as having 0
12211 lines.  This can lead to strange results if you happen to lower score of
12212 the articles with few lines.
12213
12214 @item Date
12215 For the Date header we have three kinda silly match types:
12216 @code{before}, @code{at} and @code{after}.  I can't really imagine this
12217 ever being useful, but, like, it would feel kinda silly not to provide
12218 this function.  Just in case.  You never know.  Better safe than sorry.
12219 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
12220 sex on a first date.  (I have been told that at least one person, and I
12221 quote, ``found this function indispensable'', however.)
12222
12223 @cindex ISO8601
12224 @cindex date
12225 A more useful match type is @code{regexp}.  With it, you can match the
12226 date string using a regular expression.  The date is normalized to
12227 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
12228 you want to match all articles that have been posted on April 1st in
12229 every year, you could use @samp{....0401.........} as a match string,
12230 for instance.  (Note that the date is kept in its original time zone, so
12231 this will match articles that were posted when it was April 1st where
12232 the article was posted from.  Time zones are such wholesome fun for the
12233 whole family, eh?)
12234
12235 @item Head, Body, All
12236 These three match keys use the same match types as the @code{From} (etc)
12237 header uses.
12238
12239 @item Followup
12240 This match key is somewhat special, in that it will match the
12241 @code{From} header, and affect the score of not only the matching
12242 articles, but also all followups to the matching articles.  This allows
12243 you e.g. increase the score of followups to your own articles, or
12244 decrease the score of followups to the articles of some known
12245 trouble-maker.  Uses the same match types as the @code{From} header
12246 uses.  (Using this match key will lead to creation of @file{ADAPT}
12247 files.) 
12248
12249 @item Thread
12250 This match key works along the same lines as the @code{Followup} match
12251 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
12252 @samp{thread} match.  This will add a new @samp{thread} match for each
12253 article that has @var{X} in its @code{References} header.  (These new
12254 @samp{thread} matches will use the @code{Message-ID}s of these matching
12255 articles.)  This will ensure that you can raise/lower the score of an
12256 entire thread, even though some articles in the thread may not have
12257 complete @code{References} headers.  Note that using this may lead to
12258 undeterministic scores of the articles in the thread.  (Using this match
12259 key will lead to creation of @file{ADAPT} files.)
12260 @end table
12261 @end enumerate
12262
12263 @cindex Score File Atoms
12264 @item mark
12265 The value of this entry should be a number.  Any articles with a score
12266 lower than this number will be marked as read.
12267
12268 @item expunge
12269 The value of this entry should be a number.  Any articles with a score
12270 lower than this number will be removed from the summary buffer.
12271
12272 @item mark-and-expunge
12273 The value of this entry should be a number.  Any articles with a score
12274 lower than this number will be marked as read and removed from the
12275 summary buffer.
12276
12277 @item thread-mark-and-expunge
12278 The value of this entry should be a number.  All articles that belong to
12279 a thread that has a total score below this number will be marked as read
12280 and removed from the summary buffer.  @code{gnus-thread-score-function}
12281 says how to compute the total score for a thread.
12282
12283 @item files
12284 The value of this entry should be any number of file names.  These files
12285 are assumed to be score files as well, and will be loaded the same way
12286 this one was.
12287
12288 @item exclude-files
12289 The clue of this entry should be any number of files.  These files will
12290 not be loaded, even though they would normally be so, for some reason or
12291 other. 
12292
12293 @item eval
12294 The value of this entry will be @code{eval}el.  This element will be
12295 ignored when handling global score files. 
12296
12297 @item read-only
12298 Read-only score files will not be updated or saved.  Global score files
12299 should feature this atom (@pxref{Global Score Files}).  (Note:
12300 @dfn{Global} here really means @dfn{global}; not your personal
12301 apply-to-all-groups score files.)
12302
12303 @item orphan
12304 The value of this entry should be a number.  Articles that do not have
12305 parents will get this number added to their scores.  Imagine you follow
12306 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
12307 will only follow a few of the threads, also want to see any new threads.
12308
12309 You can do this with the following two score file entries:
12310
12311 @example
12312         (orphan -500)
12313         (mark-and-expunge -100)
12314 @end example
12315
12316 When you enter the group the first time, you will only see the new
12317 threads.  You then raise the score of the threads that you find
12318 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
12319 rest.  Next time you enter the group, you will see new articles in the
12320 interesting threads, plus any new threads.
12321
12322 I.e.---the orphan score atom is for high-volume groups where there
12323 exist a few interesting threads which can't be found automatically by
12324 ordinary scoring rules.
12325
12326 @item adapt
12327 This entry controls the adaptive scoring.  If it is @code{t}, the
12328 default adaptive scoring rules will be used.  If it is @code{ignore}, no
12329 adaptive scoring will be performed on this group.  If it is a list, this
12330 list will be used as the adaptive scoring rules.  If it isn't present,
12331 or is something other than @code{t} or @code{ignore}, the default
12332 adaptive scoring rules will be used.  If you want to use adaptive
12333 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
12334 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
12335 not want adaptive scoring.  If you only want adaptive scoring in a few
12336 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
12337 insert @code{(adapt t)} in the score files of the groups where you want
12338 it. 
12339
12340 @item adapt-file
12341 All adaptive score entries will go to the file named by this entry.  It
12342 will also be applied when entering the group.  This atom might be handy
12343 if you want to adapt on several groups at once, using the same adaptive
12344 file for a number of groups.
12345
12346 @item local
12347 @cindex local variables
12348 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
12349 Each @var{var} will be made buffer-local to the current summary buffer,
12350 and set to the value specified.  This is a convenient, if somewhat
12351 strange, way of setting variables in some groups if you don't like hooks
12352 much.  Note that the @var{value} won't be evaluated.
12353 @end table
12354
12355
12356 @node Score File Editing
12357 @section Score File Editing
12358
12359 You normally enter all scoring commands from the summary buffer, but you
12360 might feel the urge to edit them by hand as well, so we've supplied you
12361 with a mode for that.  
12362
12363 It's simply a slightly customized @code{emacs-lisp} mode, with these
12364 additional commands:
12365
12366 @table @kbd
12367
12368 @item C-c C-c
12369 @kindex C-c C-c (Score)
12370 @findex gnus-score-edit-done
12371 Save the changes you have made and return to the summary buffer
12372 (@code{gnus-score-edit-done}). 
12373
12374 @item C-c C-d
12375 @kindex C-c C-d (Score)
12376 @findex gnus-score-edit-insert-date
12377 Insert the current date in numerical format
12378 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
12379 you were wondering.
12380
12381 @item C-c C-p
12382 @kindex C-c C-p (Score)
12383 @findex gnus-score-pretty-print
12384 The adaptive score files are saved in an unformatted fashion.  If you
12385 intend to read one of these files, you want to @dfn{pretty print} it
12386 first.  This command (@code{gnus-score-pretty-print}) does that for
12387 you. 
12388
12389 @end table
12390
12391 Type @kbd{M-x gnus-score-mode} to use this mode.
12392
12393 @vindex gnus-score-mode-hook
12394 @code{gnus-score-menu-hook} is run in score mode buffers.
12395
12396 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
12397 e} to begin editing score files.
12398
12399
12400 @node Adaptive Scoring
12401 @section Adaptive Scoring
12402 @cindex adaptive scoring
12403
12404 If all this scoring is getting you down, Gnus has a way of making it all
12405 happen automatically---as if by magic.  Or rather, as if by artificial
12406 stupidity, to be precise.
12407
12408 @vindex gnus-use-adaptive-scoring
12409 When you read an article, or mark an article as read, or kill an
12410 article, you leave marks behind.  On exit from the group, Gnus can sniff
12411 these marks and add score elements depending on what marks it finds.
12412 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
12413 @code{t} or @code{(line)}.  If you want score adaptively on separate
12414 words appearing in the subjects, you should set this variable to
12415 @code{(word)}.  If you want to use both adaptive methods, set this
12416 variable to @code{(word line)}.
12417
12418 @vindex gnus-default-adaptive-score-alist
12419 To give you complete control over the scoring process, you can customize
12420 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
12421 might look something like this:
12422
12423 @lisp
12424 (defvar gnus-default-adaptive-score-alist
12425   '((gnus-unread-mark)
12426     (gnus-ticked-mark (from 4))
12427     (gnus-dormant-mark (from 5))
12428     (gnus-del-mark (from -4) (subject -1))
12429     (gnus-read-mark (from 4) (subject 2))
12430     (gnus-expirable-mark (from -1) (subject -1))
12431     (gnus-killed-mark (from -1) (subject -3))
12432     (gnus-kill-file-mark)
12433     (gnus-ancient-mark)
12434     (gnus-low-score-mark)
12435     (gnus-catchup-mark (from -1) (subject -1))))
12436 @end lisp
12437
12438 As you see, each element in this alist has a mark as a key (either a
12439 variable name or a ``real'' mark---a character).  Following this key is
12440 a arbitrary number of header/score pairs.  If there are no header/score
12441 pairs following the key, no adaptive scoring will be done on articles
12442 that have that key as the article mark.  For instance, articles with
12443 @code{gnus-unread-mark} in the example above will not get adaptive score
12444 entries.
12445
12446 Each article can have only one mark, so just a single of these rules
12447 will be applied to each article.
12448
12449 To take @code{gnus-del-mark} as an example---this alist says that all
12450 articles that have that mark (i.e., are marked with @samp{D}) will have a
12451 score entry added to lower based on the @code{From} header by -4, and
12452 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
12453
12454 If you have marked 10 articles with the same subject with
12455 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
12456 That means that that subject will get a score of ten times -1, which
12457 should be, unless I'm much mistaken, -10.
12458
12459 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
12460 the read articles will be marked with the @samp{E} mark.  This'll
12461 probably make adaptive scoring slightly impossible, so auto-expiring and
12462 adaptive scoring doesn't really mix very well.
12463
12464 The headers you can score on are @code{from}, @code{subject},
12465 @code{message-id}, @code{references}, @code{xref}, @code{lines},
12466 @code{chars} and @code{date}.  In addition, you can score on
12467 @code{followup}, which will create an adaptive score entry that matches
12468 on the @code{References} header using the @code{Message-ID} of the
12469 current article, thereby matching the following thread.  
12470
12471 You can also score on @code{thread}, which will try to score all
12472 articles that appear in a thread.  @code{thread} matches uses a
12473 @code{Message-ID} to match on the @code{References} header of the
12474 article.  If the match is made, the @code{Message-ID} of the article is
12475 added to the @code{thread} rule.  (Think about it.  I'd recommend two
12476 aspirins afterwards.)
12477
12478 If you use this scheme, you should set the score file atom @code{mark}
12479 to something small---like -300, perhaps, to avoid having small random
12480 changes result in articles getting marked as read.
12481
12482 After using adaptive scoring for a week or so, Gnus should start to
12483 become properly trained and enhance the authors you like best, and kill
12484 the authors you like least, without you having to say so explicitly. 
12485
12486 You can control what groups the adaptive scoring is to be performed on
12487 by using the score files (@pxref{Score File Format}).  This will also
12488 let you use different rules in different groups.
12489
12490 @vindex gnus-adaptive-file-suffix
12491 The adaptive score entries will be put into a file where the name is the
12492 group name with @code{gnus-adaptive-file-suffix} appended.  The default
12493 is @samp{ADAPT}.
12494
12495 @vindex gnus-score-exact-adapt-limit
12496 When doing adaptive scoring, substring or fuzzy matching would probably
12497 give you the best results in most cases.  However, if the header one
12498 matches is short, the possibility for false positives is great, so if
12499 the length of the match is less than
12500 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
12501 this variable is @code{nil}, exact matching will always be used to avoid
12502 this problem.
12503
12504 @vindex gnus-default-adaptive-word-score-alist
12505 As mentioned above, you can adapt either on individual words or entire
12506 headers.  If you adapt on words, the
12507 @code{gnus-default-adaptive-word-score-alist} variable says what score
12508 each instance of a word should add given a mark.
12509
12510 @lisp
12511 (setq gnus-default-adaptive-word-score-alist  
12512       `((,gnus-read-mark . 30)
12513         (,gnus-catchup-mark . -10)
12514         (,gnus-killed-mark . -20)
12515         (,gnus-del-mark . -15)))
12516 @end lisp
12517
12518 This is the default value.  If you have adaption on words enabled, every
12519 word that appears in subjects of articles marked with
12520 @code{gnus-read-mark} will result in a score rule that increase the
12521 score with 30 points.
12522
12523 @vindex gnus-default-ignored-adaptive-words
12524 @vindex gnus-ignored-adaptive-words
12525 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
12526 will be ignored.  If you wish to add more words to be ignored, use the
12527 @code{gnus-ignored-adaptive-words} list instead.
12528
12529 @vindex gnus-adaptive-word-syntax-table
12530 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
12531 syntax table in effect.  It is similar to the standard syntax table, but
12532 it considers numbers to be non-word-constituent characters.
12533
12534 @vindex gnus-adaptive-word-minimum
12535 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
12536 word scoring process will never bring down the score of an article to
12537 below this number.  The default is @code{nil}.
12538
12539 After using this scheme for a while, it might be nice to write a
12540 @code{gnus-psychoanalyze-user} command to go through the rules and see
12541 what words you like and what words you don't like.  Or perhaps not.
12542
12543 Note that the adaptive word scoring thing is highly experimental and is
12544 likely to change in the future.  Initial impressions seem to indicate
12545 that it's totally useless as it stands.  Some more work (involving more
12546 rigorous statistical methods) will have to be done to make this useful. 
12547
12548
12549 @node Home Score File
12550 @section Home Score File
12551
12552 The score file where new score file entries will go is called the
12553 @dfn{home score file}.  This is normally (and by default) the score file
12554 for the group itself.  For instance, the home score file for
12555 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
12556
12557 However, this may not be what you want.  It is often convenient to share
12558 a common home score file among many groups---all @samp{emacs} groups
12559 could perhaps use the same home score file.
12560
12561 @vindex gnus-home-score-file
12562 The variable that controls this is @code{gnus-home-score-file}.  It can
12563 be:
12564
12565 @enumerate
12566 @item
12567 A string.  Then this file will be used as the home score file for all
12568 groups. 
12569
12570 @item
12571 A function. The result of this function will be used as the home score
12572 file.  The function will be called with the name of the group as the
12573 parameter. 
12574
12575 @item
12576 A list.  The elements in this list can be:
12577
12578 @enumerate
12579 @item 
12580 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
12581 the @var{file-name} will will be used as the home score file.
12582
12583 @item 
12584 A function. If the function returns non-nil, the result will be used as
12585 the home score file.
12586
12587 @item 
12588 A string.  Use the string as the home score file.
12589 @end enumerate
12590
12591 The list will be traversed from the beginning towards the end looking
12592 for matches.
12593
12594 @end enumerate
12595
12596 So, if you want to use just a single score file, you could say:
12597
12598 @lisp
12599 (setq gnus-home-score-file
12600       "my-total-score-file.SCORE")
12601 @end lisp
12602
12603 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
12604 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
12605
12606 @lisp
12607 (setq gnus-home-score-file
12608       'gnus-hierarchial-home-score-file)
12609 @end lisp
12610
12611 This is a ready-made function provided for your convenience.
12612
12613 If you want to have one score file for the @samp{emacs} groups and
12614 another for the @samp{comp} groups, while letting all other groups use
12615 their own home score files:
12616
12617 @lisp
12618 (setq gnus-home-score-file
12619       ;; All groups that match the regexp "\\.emacs"
12620       '("\\.emacs" "emacs.SCORE")
12621       ;; All the comp groups in one score file
12622        ("^comp" "comp.SCORE"))
12623 @end lisp
12624    
12625 @vindex gnus-home-adapt-file
12626 @code{gnus-home-adapt-file} works exactly the same way as
12627 @code{gnus-home-score-file}, but says what the home adaptive score file
12628 is instead.  All new adaptive file entries will go into the file
12629 specified by this variable, and the same syntax is allowed.
12630
12631 In addition to using @code{gnus-home-score-file} and
12632 @code{gnus-home-adapt-file}, you can also use group parameters
12633 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
12634 Parameters}) to achieve much the same.  Group and topic parameters take
12635 precedence over this variable.
12636
12637
12638 @node Followups To Yourself
12639 @section Followups To Yourself
12640
12641 Gnus offers two commands for picking out the @code{Message-ID} header in
12642 the current buffer.  Gnus will then add a score rule that scores using
12643 this @code{Message-ID} on the @code{References} header of other
12644 articles.  This will, in effect, increase the score of all articles that
12645 respond to the article in the current buffer.  Quite useful if you want
12646 to easily note when people answer what you've said.
12647
12648 @table @code
12649
12650 @item gnus-score-followup-article
12651 @findex gnus-score-followup-article
12652 This will add a score to articles that directly follow up your own
12653 article. 
12654
12655 @item gnus-score-followup-thread
12656 @findex gnus-score-followup-thread
12657 This will add a score to all articles that appear in a thread ``below''
12658 your own article.
12659 @end table
12660
12661 @vindex message-sent-hook
12662 These two functions are both primarily meant to be used in hooks like
12663 @code{message-sent-hook}.  
12664
12665 If you look closely at your own @code{Message-ID}, you'll notice that
12666 the first two or three characters are always the same.  Here's two of
12667 mine:  
12668
12669 @example
12670 <x6u3u47icf.fsf@@eyesore.no>
12671 <x6sp9o7ibw.fsf@@eyesore.no>
12672 @end example
12673
12674 So ``my'' ident on this machine is @samp{x6}.  This can be
12675 exploited---the following rule will raise the score on all followups to
12676 myself: 
12677
12678 @lisp
12679 ("references"
12680  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
12681   1000 nil r))
12682 @end lisp
12683
12684 Whether it's the first two or first three characters that are ``yours''
12685 is system-dependent.
12686
12687
12688 @node Scoring Tips
12689 @section Scoring Tips
12690 @cindex scoring tips
12691
12692 @table @dfn
12693
12694 @item Crossposts
12695 @cindex crossposts
12696 @cindex scoring crossposts
12697 If you want to lower the score of crossposts, the line to match on is
12698 the @code{Xref} header.
12699 @lisp
12700 ("xref" (" talk.politics.misc:" -1000))
12701 @end lisp
12702
12703 @item Multiple crossposts
12704 If you want to lower the score of articles that have been crossposted to
12705 more than, say, 3 groups:
12706 @lisp
12707 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
12708 @end lisp
12709
12710 @item Matching on the body
12711 This is generally not a very good idea---it takes a very long time.
12712 Gnus actually has to fetch each individual article from the server.  But
12713 you might want to anyway, I guess.  Even though there are three match
12714 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
12715 and stick with it in each score file.  If you use any two, each article
12716 will be fetched @emph{twice}.  If you want to match a bit on the
12717 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
12718 the matches.  
12719
12720 @item Marking as read
12721 You will probably want to mark articles that has a score below a certain
12722 number as read.  This is most easily achieved by putting the following
12723 in your @file{all.SCORE} file:
12724 @lisp
12725 ((mark -100))
12726 @end lisp
12727 You may also consider doing something similar with @code{expunge}.  
12728
12729 @item Negated character classes
12730 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
12731 That will match newlines, which might lead to, well, The Unknown.  Say
12732 @code{[^abcd\n]*} instead.
12733 @end table
12734
12735
12736 @node Reverse Scoring
12737 @section Reverse Scoring
12738 @cindex reverse scoring
12739
12740 If you want to keep just articles that have @samp{Sex with Emacs} in the
12741 subject header, and expunge all other articles, you could put something
12742 like this in your score file:
12743
12744 @lisp
12745 (("subject"
12746   ("Sex with Emacs" 2))
12747  (mark 1)
12748  (expunge 1))
12749 @end lisp
12750
12751 So, you raise all articles that match @samp{Sex with Emacs} and mark the
12752 rest as read, and expunge them to boot.
12753
12754
12755 @node Global Score Files
12756 @section Global Score Files
12757 @cindex global score files
12758
12759 Sure, other newsreaders have ``global kill files''.  These are usually
12760 nothing more than a single kill file that applies to all groups, stored
12761 in the user's home directory.  Bah!  Puny, weak newsreaders!
12762
12763 What I'm talking about here are Global Score Files.  Score files from
12764 all over the world, from users everywhere, uniting all nations in one
12765 big, happy score file union!  Ange-score!  New and untested!
12766
12767 @vindex gnus-global-score-files
12768 All you have to do to use other people's score files is to set the
12769 @code{gnus-global-score-files} variable.  One entry for each score file,
12770 or each score file directory.  Gnus will decide by itself what score
12771 files are applicable to which group.
12772
12773 Say you want to use the score file
12774 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
12775 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
12776
12777 @lisp
12778 (setq gnus-global-score-files
12779       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
12780         "/ftp@@ftp.some-where:/pub/score/"))
12781 @end lisp
12782
12783 @findex gnus-score-search-global-directories
12784 Simple, eh?  Directory names must end with a @samp{/}.  These
12785 directories are typically scanned only once during each Gnus session.
12786 If you feel the need to manually re-scan the remote directories, you can
12787 use the @code{gnus-score-search-global-directories} command.
12788
12789 Note that, at present, using this option will slow down group entry
12790 somewhat.  (That is---a lot.)
12791
12792 If you want to start maintaining score files for other people to use,
12793 just put your score file up for anonymous ftp and announce it to the
12794 world.  Become a retro-moderator!  Participate in the retro-moderator
12795 wars sure to ensue, where retro-moderators battle it out for the
12796 sympathy of the people, luring them to use their score files on false
12797 premises!  Yay!  The net is saved!
12798
12799 Here are some tips for the would-be retro-moderator, off the top of my
12800 head: 
12801
12802 @itemize @bullet
12803
12804 @item 
12805 Articles heavily crossposted are probably junk. 
12806 @item
12807 To lower a single inappropriate article, lower by @code{Message-ID}.
12808 @item
12809 Particularly brilliant authors can be raised on a permanent basis. 
12810 @item
12811 Authors that repeatedly post off-charter for the group can safely be
12812 lowered out of existence.
12813 @item
12814 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
12815 articles completely.
12816
12817 @item 
12818 Use expiring score entries to keep the size of the file down.  You
12819 should probably have a long expiry period, though, as some sites keep
12820 old articles for a long time.
12821 @end itemize
12822
12823 ... I wonder whether other newsreaders will support global score files
12824 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
12825 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
12826 holding our breath yet?
12827
12828
12829 @node Kill Files
12830 @section Kill Files
12831 @cindex kill files
12832
12833 Gnus still supports those pesky old kill files.  In fact, the kill file
12834 entries can now be expiring, which is something I wrote before Daniel
12835 Quinlan thought of doing score files, so I've left the code in there.
12836
12837 In short, kill processing is a lot slower (and I do mean @emph{a lot})
12838 than score processing, so it might be a good idea to rewrite your kill
12839 files into score files.
12840
12841 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
12842 forms into this file, which means that you can use kill files as some
12843 sort of primitive hook function to be run on group entry, even though
12844 that isn't a very good idea.
12845
12846 Normal kill files look like this:
12847
12848 @lisp
12849 (gnus-kill "From" "Lars Ingebrigtsen")
12850 (gnus-kill "Subject" "ding")
12851 (gnus-expunge "X")
12852 @end lisp
12853
12854 This will mark every article written by me as read, and remove the
12855 marked articles from the summary buffer.  Very useful, you'll agree.
12856
12857 Other programs use a totally different kill file syntax.  If Gnus
12858 encounters what looks like a @code{rn} kill file, it will take a stab at
12859 interpreting it. 
12860
12861 Two summary functions for editing a GNUS kill file:
12862
12863 @table @kbd
12864
12865 @item M-k
12866 @kindex M-k (Summary)
12867 @findex gnus-summary-edit-local-kill
12868 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
12869
12870 @item M-K
12871 @kindex M-K (Summary)
12872 @findex gnus-summary-edit-global-kill
12873 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
12874 @end table
12875
12876 Two group mode functions for editing the kill files:
12877
12878 @table @kbd
12879
12880 @item M-k
12881 @kindex M-k (Group)
12882 @findex gnus-group-edit-local-kill
12883 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
12884
12885 @item M-K
12886 @kindex M-K (Group)
12887 @findex gnus-group-edit-global-kill
12888 Edit the general kill file (@code{gnus-group-edit-global-kill}).
12889 @end table
12890
12891 Kill file variables:
12892
12893 @table @code
12894 @item gnus-kill-file-name
12895 @vindex gnus-kill-file-name
12896 A kill file for the group @samp{soc.motss} is normally called
12897 @file{soc.motss.KILL}.  The suffix appended to the group name to get
12898 this file name is detailed by the @code{gnus-kill-file-name} variable.
12899 The ``global'' kill file (not in the score file sense of ``global'', of
12900 course) is just called @file{KILL}.
12901
12902 @vindex gnus-kill-save-kill-file
12903 @item gnus-kill-save-kill-file
12904 If this variable is non-@code{nil}, Gnus will save the
12905 kill file after processing, which is necessary if you use expiring
12906 kills. 
12907
12908 @item gnus-apply-kill-hook
12909 @vindex gnus-apply-kill-hook
12910 @findex gnus-apply-kill-file-unless-scored
12911 @findex gnus-apply-kill-file
12912 A hook called to apply kill files to a group.  It is
12913 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
12914 kill file if you have a score file for the same group, you can set this
12915 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
12916 kill files to be processed, you should set this variable to @code{nil}.
12917
12918 @item gnus-kill-file-mode-hook
12919 @vindex gnus-kill-file-mode-hook
12920 A hook called in kill-file mode buffers.
12921
12922 @end table
12923
12924
12925 @node Converting Kill Files
12926 @section Converting Kill Files
12927 @cindex kill files
12928 @cindex converting kill files
12929
12930 If you have loads of old kill files, you may want to convert them into
12931 score files.  If they are ``regular'', you can use
12932 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
12933 by hand.
12934
12935 The kill to score conversion package isn't included in Gnus by default.
12936 You can fetch it from
12937 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
12938
12939 If your old kill files are very complex---if they contain more
12940 non-@code{gnus-kill} forms than not, you'll have to convert them by
12941 hand.  Or just let them be as they are.  Gnus will still use them as
12942 before. 
12943
12944
12945 @node GroupLens
12946 @section GroupLens
12947 @cindex GroupLens
12948
12949 GroupLens is a collaborative filtering system that helps you work
12950 together with other people to find the quality news articles out of the
12951 huge volume of news articles generated every day.
12952
12953 To accomplish this the GroupLens system combines your opinions about
12954 articles you have already read with the opinions of others who have done
12955 likewise and gives you a personalized prediction for each unread news
12956 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
12957 rate articles, and finds other people that rate articles the same way.
12958 Once it has found some people you agree with it tells you, in the form
12959 of a prediction, what they thought of the article.  You can use this
12960 prediction to help you decide whether or not you want to read the
12961 article.
12962
12963 @menu
12964 * Using GroupLens::          How to make Gnus use GroupLens.
12965 * Rating Articles::          Letting GroupLens know how you rate articles.
12966 * Displaying Predictions::   Displaying predictions given by GroupLens.
12967 * GroupLens Variables::      Customizing GroupLens.
12968 @end menu
12969
12970
12971 @node Using GroupLens
12972 @subsection Using GroupLens
12973
12974 To use GroupLens you must register a pseudonym with your local Better
12975 Bit Bureau (BBB).
12976 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
12977 better bit in town at the moment.
12978
12979 Once you have registered you'll need to set a couple of variables.
12980
12981 @table @code
12982
12983 @item gnus-use-grouplens
12984 @vindex gnus-use-grouplens
12985 Setting this variable to a non-@code{nil} value will make Gnus hook into
12986 all the relevant GroupLens functions.
12987
12988 @item grouplens-pseudonym
12989 @vindex grouplens-pseudonym
12990 This variable should be set to the pseudonym you got when registering
12991 with the Better Bit Bureau.
12992
12993 @item grouplens-newsgroups
12994 @vindex grouplens-newsgroups
12995 A list of groups that you want to get GroupLens predictions for. 
12996
12997 @end table
12998
12999 That's the minimum of what you need to get up and running with GroupLens.
13000 Once you've registered, GroupLens will start giving you scores for
13001 articles based on the average of what other people think.  But, to get
13002 the real benefit of GroupLens you need to start rating articles
13003 yourself.  Then the scores GroupLens gives you will be personalized for
13004 you, based on how the people you usually agree with have already rated.
13005
13006
13007 @node Rating Articles
13008 @subsection Rating Articles
13009
13010 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
13011 Where 1 means something like this article is a waste of bandwidth and 5
13012 means that the article was really good.  The basic question to ask
13013 yourself is, "on a scale from 1 to 5 would I like to see more articles
13014 like this one?"
13015
13016 There are four ways to enter a rating for an article in GroupLens.
13017
13018 @table @kbd
13019
13020 @item r
13021 @kindex r (GroupLens)
13022 @findex bbb-summary-rate-article
13023 This function will prompt you for a rating on a scale of one to five.
13024
13025 @item k
13026 @kindex k (GroupLens)
13027 @findex grouplens-score-thread
13028 This function will prompt you for a rating, and rate all the articles in
13029 the thread.  This is really useful for some of those long running giant
13030 threads in rec.humor.
13031
13032 @end table
13033
13034 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13035 the score of the article you're reading.
13036
13037 @table @kbd
13038
13039 @item 1-5 n
13040 @kindex n (GroupLens)
13041 @findex grouplens-next-unread-article
13042 Rate the article and go to the next unread article.
13043
13044 @item 1-5 ,
13045 @kindex , (GroupLens)
13046 @findex grouplens-best-unread-article
13047 Rate the article and go to the next unread article with the highest score.
13048
13049 @end table
13050
13051 If you want to give the current article a score of 4 and then go to the
13052 next article, just type @kbd{4 n}.
13053
13054
13055 @node Displaying Predictions
13056 @subsection Displaying Predictions
13057
13058 GroupLens makes a prediction for you about how much you will like a
13059 news article.  The predictions from GroupLens are on a scale from 1 to
13060 5, where 1 is the worst and 5 is the best.  You can use the predictions
13061 from GroupLens in one of three ways controlled by the variable
13062 @code{gnus-grouplens-override-scoring}.
13063
13064 @vindex gnus-grouplens-override-scoring
13065 There are three ways to display predictions in grouplens.  You may
13066 choose to have the GroupLens scores contribute to, or override the
13067 regular gnus scoring mechanism. override is the default; however, some
13068 people prefer to see the Gnus scores plus the grouplens scores.  To get
13069 the separate scoring behavior you need to set
13070 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
13071 GroupLens predictions combined with the grouplens scores set it to
13072 @code{'override} and to combine the scores set
13073 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
13074 the combine option you will also want to set the values for
13075 @code{grouplens-prediction-offset} and
13076 @code{grouplens-score-scale-factor}.
13077
13078 @vindex grouplens-prediction-display
13079 In either case, GroupLens gives you a few choices for how you would like
13080 to see your predictions displayed.  The display of predictions is
13081 controlled by the @code{grouplens-prediction-display} variable.
13082
13083 The following are valid values for that variable.
13084
13085 @table @code
13086 @item prediction-spot
13087 The higher the prediction, the further to the right an @samp{*} is
13088 displayed. 
13089
13090 @item confidence-interval
13091 A numeric confidence interval.
13092
13093 @item prediction-bar
13094 The higher the prediction, the longer the bar.
13095
13096 @item confidence-bar
13097 Numerical confidence.
13098
13099 @item confidence-spot
13100 The spot gets bigger with more confidence.
13101
13102 @item prediction-num
13103 Plain-old numeric value.
13104
13105 @item confidence-plus-minus
13106 Prediction +/- confidence.
13107
13108 @end table
13109
13110
13111 @node GroupLens Variables
13112 @subsection GroupLens Variables
13113
13114 @table @code
13115
13116 @item gnus-summary-grouplens-line-format
13117 The summary line format used in GroupLens-enhanced summary buffers.  It
13118 accepts the same specs as the normal summary line format (@pxref{Summary
13119 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
13120 %s\n}.
13121
13122 @item grouplens-bbb-host
13123 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
13124 default.
13125
13126 @item grouplens-bbb-port
13127 Port of the host running the bbbd server.  The default is 9000.
13128
13129 @item grouplens-score-offset
13130 Offset the prediction by this value.  In other words, subtract the
13131 prediction value by this number to arrive at the effective score.  The
13132 default is 0.
13133
13134 @item grouplens-score-scale-factor 
13135 This variable allows the user to magnify the effect of GroupLens scores.
13136 The scale factor is applied after the offset.  The default is 1.
13137
13138 @end table
13139
13140
13141 @node Advanced Scoring
13142 @section Advanced Scoring
13143
13144 Scoring on Subjects and From headers is nice enough, but what if you're
13145 really interested in what a person has to say only when she's talking
13146 about a particular subject?  Or what if you really don't want to
13147 read what person A has to say when she's following up to person B, but
13148 want to read what she says when she's following up to person C?
13149
13150 By using advanced scoring rules you may create arbitrarily complex
13151 scoring patterns.
13152
13153 @menu
13154 * Advanced Scoring Syntax::     A definition.
13155 * Advanced Scoring Examples::   What they look like.
13156 * Advanced Scoring Tips::       Getting the most out of it.
13157 @end menu
13158
13159
13160 @node Advanced Scoring Syntax
13161 @subsection Advanced Scoring Syntax
13162
13163 Ordinary scoring rules have a string as the first element in the rule.
13164 Advanced scoring rules have a list as the first element.  The second
13165 element is the score to be applied if the first element evaluated to a
13166 non-@code{nil} value.
13167
13168 These lists may consist of three logical operators, one redirection
13169 operator, and various match operators.
13170
13171 Logical operators:
13172
13173 @table @code
13174 @item &
13175 @itemx and
13176 This logical operator will evaluate each of its arguments until it finds
13177 one that evaluates to @code{false}, and then it'll stop.  If all arguments
13178 evaluate to @code{true} values, then this operator will return
13179 @code{true}. 
13180
13181 @item |
13182 @itemx or
13183 This logical operator will evaluate each of its arguments until it finds
13184 one that evaluates to @code{true}.  If no arguments are @code{true},
13185 then this operator will return @code{false}.
13186
13187 @item !
13188 @itemx not
13189 @itemx Â¬
13190 This logical operator only takes a single argument.  It returns the
13191 logical negation of the value of its argument.
13192
13193 @end table
13194
13195 There is an @dfn{indirection operator} that will make its arguments
13196 apply to the ancestors of the current article being scored.  For
13197 instance, @code{1-} will make score rules apply to the parent of the
13198 current article.  @code{2-} will make score rules apply to the
13199 grandparent of the current article.  Alternatively, you can write
13200 @code{^^}, where the number of @code{^}s (carets) says how far back into
13201 the ancestry you want to go.
13202
13203 Finally, we have the match operators.  These are the ones that do the
13204 real work.  Match operators are header name strings followed by a match
13205 and a match type.  A typical match operator looks like @samp{("from"
13206 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
13207 simple scoring, and the match types are also the same.
13208
13209
13210 @node Advanced Scoring Examples
13211 @subsection Advanced Scoring Examples
13212
13213 Let's say you want to increase the score of articles written by Lars
13214 when he's talking about Gnus:
13215
13216 @example
13217 ((& 
13218   ("from" "Lars Ingebrigtsen")
13219   ("subject" "Gnus"))
13220  1000)
13221 @end example
13222
13223 Quite simple, huh?
13224
13225 When he writes long articles, he sometimes has something nice to say: 
13226
13227 @example
13228 ((& 
13229   ("from" "Lars Ingebrigtsen")
13230   (|
13231    ("subject" "Gnus")
13232    ("lines" 100 >)))
13233  1000)
13234 @end example
13235
13236 However, when he responds to things written by Reig Eigil Logge, you
13237 really don't want to read what he's written:
13238
13239 @example
13240 ((&
13241   ("from" "Lars Ingebrigtsen")
13242   (1- ("from" "Reig Eigir Logge")))
13243  -100000)
13244 @end example
13245
13246 Everybody that follows up Redmondo when he writes about disappearing
13247 socks should have their scores raised, but only when they talk about
13248 white socks.  However, when Lars talks about socks, it's usually not
13249 very interesting:
13250
13251 @example
13252 ((&
13253   (1-
13254    (&
13255     ("from" "redmondo@@.*no" r)
13256     ("body" "disappearing.*socks" t)))
13257   (! ("from" "Lars Ingebrigtsen"))
13258   ("body" "white.*socks"))
13259  1000)
13260 @end example
13261
13262 The possibilities are endless.
13263
13264
13265 @node Advanced Scoring Tips
13266 @subsection Advanced Scoring Tips
13267
13268 The @code{&} and @code{|} logical operators do short-circuit logic.
13269 That is, they stop processing their arguments when it's clear what the
13270 result of the operation will be.  For instance, if one of the arguments
13271 of an @code{&} evaluates to @code{false}, there's no point in evaluating
13272 the rest of the arguments.  This means that you should put slow matches
13273 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
13274 @samp{subject}) first.
13275
13276 The indirection arguments (@code{1-} and so on) will make their
13277 arguments work on previous generations of the thread.  If you say
13278 something like:
13279
13280 @example
13281 ...
13282 (1-
13283  (1-
13284   ("from" "lars")))
13285 ...
13286 @end example
13287
13288 Then that means "score on the from header of the grandparent of the
13289 current article".  An indirection is quite fast, but it's better to say:
13290
13291 @example
13292 (1-
13293  (& 
13294   ("from" "Lars")
13295   ("subject" "Gnus")))
13296 @end example
13297
13298 than it is to say:
13299
13300 @example
13301 (&
13302  (1- ("from" "Lars"))
13303  (1- ("subject" "Gnus")))
13304 @end example
13305
13306
13307 @node Score Decays
13308 @section Score Decays
13309 @cindex score decays
13310 @cindex decays
13311
13312 You may find that your scores have a tendency to grow without
13313 bounds, especially if you're using adaptive scoring.  If scores get too
13314 big, they lose all meaning---they simply max out and it's difficult to
13315 use them in any sensible way.
13316
13317 @vindex gnus-decay-scores
13318 @findex gnus-decay-score
13319 @vindex gnus-score-decay-function
13320 Gnus provides a mechanism for decaying scores to help with this problem.
13321 When score files are loaded and @code{gnus-decay-scores} is
13322 non-@code{nil}, Gnus will run the score files through the decaying
13323 mechanism thereby lowering the scores of all non-permanent score rules.
13324 The decay itself if performed by the @code{gnus-score-decay-function}
13325 function, which is @code{gnus-decay-score} by default.  Here's the
13326 definition of that function:
13327
13328 @lisp
13329 (defun gnus-decay-score (score)
13330   "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'."
13331   (floor
13332    (- score
13333       (* (if (< score 0) 1 -1)
13334          (min (abs score)
13335               (max gnus-score-decay-constant
13336                    (* (abs score)
13337                       gnus-score-decay-scale)))))))
13338 @end lisp
13339
13340 @vindex gnus-score-decay-scale
13341 @vindex gnus-score-decay-constant
13342 @code{gnus-score-decay-constant} is 3 by default and
13343 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
13344
13345 @enumerate
13346 @item
13347 Scores between -3 and 3 will be set to 0 when this function is called.
13348
13349 @item
13350 Scores with magnitudes between 3 and 60 will be shrunk by 3.
13351
13352 @item
13353 Scores with magnitudes greater than 60 will be shrunk by 5% of the
13354 score.
13355 @end enumerate
13356
13357 If you don't like this decay function, write your own.  It is called
13358 with the score to be decayed as its only parameter, and it should return
13359 the new score, which should be an integer.
13360
13361 Gnus will try to decay scores once a day.  If you haven't run Gnus for
13362 four days, Gnus will decay the scores four times, for instance.
13363
13364
13365 @node Various
13366 @chapter Various
13367
13368 @menu
13369 * Process/Prefix::             A convention used by many treatment commands.
13370 * Interactive::                Making Gnus ask you many questions.
13371 * Symbolic Prefixes::          How to supply some Gnus functions with options.
13372 * Formatting Variables::       You can specify what buffers should look like.
13373 * Windows Configuration::      Configuring the Gnus buffer windows.
13374 * Faces and Fonts::            How to change how faces look.
13375 * Compilation::                How to speed Gnus up.
13376 * Mode Lines::                 Displaying information in the mode lines.
13377 * Highlighting and Menus::     Making buffers look all nice and cozy.
13378 * Buttons::                    Get tendonitis in ten easy steps!
13379 * Daemons::                    Gnus can do things behind your back.
13380 * NoCeM::                      How to avoid spam and other fatty foods.
13381 * Undo::                       Some actions can be undone.
13382 * Moderation::                 What to do if you're a moderator.
13383 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
13384 * Fuzzy Matching::             What's the big fuzz?
13385 * Thwarting Email Spam::       A how-to on avoiding unsolited commercial email.
13386 * Various Various::            Things that are really various.
13387 @end menu
13388
13389
13390 @node Process/Prefix
13391 @section Process/Prefix
13392 @cindex process/prefix convention
13393
13394 Many functions, among them functions for moving, decoding and saving
13395 articles, use what is known as the @dfn{Process/Prefix convention}.
13396
13397 This is a method for figuring out what articles the user wants the
13398 command to be performed on.
13399
13400 It goes like this:
13401
13402 If the numeric prefix is N, perform the operation on the next N
13403 articles, starting with the current one.  If the numeric prefix is
13404 negative, perform the operation on the previous N articles, starting
13405 with the current one.
13406
13407 @vindex transient-mark-mode
13408 If @code{transient-mark-mode} in non-@code{nil} and the region is
13409 active, all articles in the region will be worked upon.
13410
13411 If there is no numeric prefix, but some articles are marked with the
13412 process mark, perform the operation on the articles marked with
13413 the process mark.
13414
13415 If there is neither a numeric prefix nor any articles marked with the
13416 process mark, just perform the operation on the current article.
13417
13418 Quite simple, really, but it needs to be made clear so that surprises
13419 are avoided.
13420
13421 Commands that react to the process mark will push the current list of
13422 process marked articles onto a stack and will then clear all process
13423 marked articles.  You can restore the previous configuration with the
13424 @kbd{M P y} command (@pxref{Setting Process Marks}).
13425
13426 @vindex gnus-summary-goto-unread
13427 One thing that seems to shock & horrify lots of people is that, for
13428 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
13429 Since each @kbd{d} (which marks the current article as read) by default
13430 goes to the next unread article after marking, this means that @kbd{3 d}
13431 will mark the next three unread articles as read, no matter what the
13432 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
13433 @code{nil} for a more straightforward action.
13434
13435
13436 @node Interactive
13437 @section Interactive
13438 @cindex interaction
13439
13440 @table @code
13441
13442 @item gnus-novice-user
13443 @vindex gnus-novice-user
13444 If this variable is non-@code{nil}, you are either a newcomer to the
13445 World of Usenet, or you are very cautious, which is a nice thing to be,
13446 really.  You will be given questions of the type ``Are you sure you want
13447 to do this?'' before doing anything dangerous.  This is @code{t} by
13448 default.
13449
13450 @item gnus-expert-user
13451 @vindex gnus-expert-user
13452 If this variable is non-@code{nil}, you will seldom be asked any
13453 questions by Gnus.  It will simply assume you know what you're doing, no
13454 matter how strange.
13455
13456 @item gnus-interactive-catchup
13457 @vindex gnus-interactive-catchup
13458 Require confirmation before catching up a group if non-@code{nil}.  It
13459 is @code{t} by default.
13460
13461 @item gnus-interactive-exit
13462 @vindex gnus-interactive-exit
13463 Require confirmation before exiting Gnus.  This variable is @code{t} by
13464 default. 
13465 @end table
13466
13467
13468 @node Symbolic Prefixes
13469 @section Symbolic Prefixes
13470 @cindex symbolic prefixes
13471
13472 Quite a lot of Emacs commands react to the (numeric) prefix.  For
13473 instance, @kbd{C-u 4 C-f} moves point four charaters forward, and
13474 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
13475 rule of 900 to the current article.
13476
13477 This is all nice and well, but what if you want to give a command some
13478 additional information?  Well, what most commands do is interpret the
13479 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
13480 doesn't want a backup file to be created when saving the current buffer,
13481 for instance.  But what if you want to save without making a backup
13482 file, and you want Emacs to flash lights and play a nice tune at the
13483 same time?  You can't, and you're probably perfectly happy that way.
13484
13485 @kindex M-i (Summary)
13486 @findex gnus-symbolic-argument
13487 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
13488 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
13489 character typed in is the value.  You can stack as many @kbd{M-i}
13490 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
13491 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
13492 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
13493 @code{b}''.  You get the drift.
13494
13495 Typing in symbolic prefixes to commands that don't accept them doesn't
13496 hurt, but it doesn't do any good either.  Currently not many Gnus
13497 functions make use of the symbolic prefix.
13498
13499 If you're interested in how Gnus implements this, @pxref{Extended
13500 Interactive}.
13501
13502
13503 @node Formatting Variables
13504 @section Formatting Variables
13505 @cindex formatting variables
13506
13507 Throughout this manual you've probably noticed lots of variables called things like @code{gnus-group-line-format} and
13508 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
13509 output lines in the various buffers.  There's quite a lot of them.
13510 Fortunately, they all use the same syntax, so there's not that much to
13511 be annoyed by.
13512
13513 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
13514 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
13515 lots of percentages everywhere.  
13516
13517 @menu 
13518 * Formatting Basics::     A formatting variable is basically a format string.
13519 * Advanced Formatting::   Modifying output in various ways.
13520 * User-Defined Specs::    Having Gnus call your own functions.
13521 * Formatting Fonts::      Making the formatting look colorful and nice.
13522 @end menu
13523
13524 Currently Gnus uses the following formatting variables:
13525 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
13526 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
13527 @code{gnus-group-mode-line-format},
13528 @code{gnus-summary-mode-line-format},
13529 @code{gnus-article-mode-line-format},
13530 @code{gnus-server-mode-line-format}, and
13531 @code{gnus-summary-pick-line-format}.
13532
13533 All these format variables can also be arbitrary elisp forms.  In that
13534 case, they will be @code{eval}ed to insert the required lines.
13535
13536 @kindex M-x gnus-update-format
13537 @findex gnus-update-format
13538 Gnus includes a command to help you while creating your own format
13539 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
13540 update the spec in question and pop you to a buffer where you can
13541 examine the resulting lisp code to be run to generate the line.  
13542
13543
13544
13545 @node Formatting Basics
13546 @subsection Formatting Basics
13547
13548 Each @samp{%} element will be replaced by some string or other when the
13549 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
13550 spec, and pad with spaces to get a 5-character field''.
13551
13552 As with normal C and Emacs Lisp formatting strings, the numerical
13553 modifier between the @samp{%} and the formatting type character will
13554 @dfn{pad} the output so that it is always at least that long.
13555 @samp{%5y} will make the field always (at least) five characters wide by
13556 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
13557 the right instead.
13558
13559 You may also wish to limit the length of the field to protect against
13560 particularly wide values.  For that you can say @samp{%4,6y}, which
13561 means that the field will never be more than 6 characters wide and never
13562 less than 4 characters wide.
13563
13564
13565 @node Advanced Formatting
13566 @subsection Advanced Formatting
13567
13568 It is frequently useful to post-process the fields in some way.
13569 Padding, limiting, cutting off parts and suppressing certain values can
13570 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
13571 look like @samp{%~(cut 3)~(ignore "0")y}.
13572
13573 These are the valid modifiers:
13574
13575 @table @code
13576 @item pad
13577 @itemx pad-left
13578 Pad the field to the left with spaces until it reaches the required
13579 length.
13580
13581 @item pad-right
13582 Pad the field to the right with spaces until it reaches the required
13583 length.
13584
13585 @item max
13586 @itemx max-left
13587 Cut off characters from the left until it reaches the specified length.
13588
13589 @item max-right
13590 Cut off characters from the right until it reaches the specified
13591 length. 
13592
13593 @item cut
13594 @itemx cut-left
13595 Cut off the specified number of characters from the left.
13596
13597 @item cut-right
13598 Cut off the specified number of characters from the right.
13599
13600 @item ignore
13601 Return an empty string if the field is equal to the specified value. 
13602
13603 @item form
13604 Use the specified form as the field value when the @samp{@@} spec is
13605 used. 
13606 @end table
13607
13608 Let's take an example.  The @samp{%o} spec in the summary mode lines
13609 will return a date in compact ISO8601 format---@samp{19960809T230410}.
13610 This is quite a mouthful, so we want to shave off the century number and
13611 the time, leaving us with a six-character date.  That would be
13612 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
13613 maxing, and we need the padding to ensure that the date is never less
13614 than 6 characters to make it look nice in columns.)
13615
13616 Ignoring is done first; then cutting; then maxing; and then as the very
13617 last operation, padding.  
13618
13619 If you use lots of these advanced thingies, you'll find that Gnus gets
13620 quite slow.  This can be helped enormously by running @kbd{M-x
13621 gnus-compile} when you are satisfied with the look of your lines.
13622 @xref{Compilation}. 
13623
13624
13625 @node User-Defined Specs
13626 @subsection User-Defined Specs
13627
13628 All the specs allow for inserting user defined specifiers---@samp{u}.
13629 The next character in the format string should be a letter.  Gnus
13630 will call the function @code{gnus-user-format-function-}@samp{X}, where
13631 @samp{X} is the letter following @samp{%u}.  The function will be passed
13632 a single parameter---what the parameter means depends on what buffer
13633 it's being called from.  The function should return a string, which will
13634 be inserted into the buffer just like information from any other
13635 specifier.  This function may also be called with dummy values, so it
13636 should protect against that.
13637
13638 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
13639 much the same without defining new functions.  Here's an example:
13640 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
13641 given here will be evaluated to yield the current line number, and then
13642 inserted.
13643
13644
13645 @node Formatting Fonts
13646 @subsection Formatting Fonts
13647
13648 There are specs for highlighting, and these are shared by all the format
13649 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
13650 the special @code{mouse-face} property set, which means that it will be
13651 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
13652 over it.
13653
13654 Text inside the @samp{%[} and @samp{%]} specifiers will have their
13655 normal faces set using @code{gnus-face-0}, which is @code{bold} by
13656 default.  If you say @samp{%1[}, you'll get @code{gnus-face-1} instead,
13657 and so on.  Create as many faces as you wish.  The same goes for the
13658 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
13659 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
13660
13661 Here's an alternative recipe for the group buffer:
13662
13663 @lisp
13664 ;; Create three face types.
13665 (setq gnus-face-1 'bold)
13666 (setq gnus-face-3 'italic)
13667
13668 ;; We want the article count to be in 
13669 ;; a bold and green face.  So we create 
13670 ;; a new face called `my-green-bold'.
13671 (copy-face 'bold 'my-green-bold)
13672 ;; Set the color.
13673 (set-face-foreground 'my-green-bold "ForestGreen")
13674 (setq gnus-face-2 'my-green-bold)
13675
13676 ;; Set the new & fancy format.
13677 (setq gnus-group-line-format 
13678       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
13679 @end lisp
13680
13681 I'm sure you'll be able to use this scheme to create totally unreadable
13682 and extremely vulgar displays.  Have fun!
13683
13684 Note that the @samp{%(} specs (and friends) do not make any sense on the
13685 mode-line variables.
13686
13687
13688 @node Windows Configuration
13689 @section Windows Configuration
13690 @cindex windows configuration
13691
13692 No, there's nothing here about X, so be quiet.
13693
13694 @vindex gnus-use-full-window
13695 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
13696 other windows and occupy the entire Emacs screen by itself.  It is
13697 @code{t} by default.
13698
13699 @vindex gnus-buffer-configuration
13700 @code{gnus-buffer-configuration} describes how much space each Gnus
13701 buffer should be given.  Here's an excerpt of this variable:
13702
13703 @lisp
13704 ((group (vertical 1.0 (group 1.0 point)
13705                       (if gnus-carpal (group-carpal 4))))
13706  (article (vertical 1.0 (summary 0.25 point) 
13707                         (article 1.0))))
13708 @end lisp
13709
13710 This is an alist.  The @dfn{key} is a symbol that names some action or
13711 other.  For instance, when displaying the group buffer, the window
13712 configuration function will use @code{group} as the key.  A full list of
13713 possible names is listed below.
13714
13715 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
13716 should occupy.  To take the @code{article} split as an example -
13717
13718 @lisp
13719 (article (vertical 1.0 (summary 0.25 point)
13720                        (article 1.0)))
13721 @end lisp
13722
13723 This @dfn{split} says that the summary buffer should occupy 25% of upper
13724 half of the screen, and that it is placed over the article buffer.  As
13725 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
13726 reaching for that calculator there).  However, the special number
13727 @code{1.0} is used to signal that this buffer should soak up all the
13728 rest of the space available after the rest of the buffers have taken
13729 whatever they need.  There should be only one buffer with the @code{1.0}
13730 size spec per split.
13731
13732 Point will be put in the buffer that has the optional third element
13733 @code{point}. 
13734
13735 Here's a more complicated example:
13736
13737 @lisp
13738 (article (vertical 1.0 (group 4)
13739                        (summary 0.25 point)
13740                        (if gnus-carpal (summary-carpal 4))
13741                        (article 1.0)))
13742 @end lisp
13743
13744 If the size spec is an integer instead of a floating point number, 
13745 then that number will be used to say how many lines a buffer should
13746 occupy, not a percentage.
13747
13748 If the @dfn{split} looks like something that can be @code{eval}ed (to be
13749 precise---if the @code{car} of the split is a function or a subr), this
13750 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
13751 be used as a split.  This means that there will be three buffers if
13752 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
13753 is non-@code{nil}.
13754
13755 Not complicated enough for you?  Well, try this on for size:
13756
13757 @lisp
13758 (article (horizontal 1.0 
13759              (vertical 0.5
13760                  (group 1.0)
13761                  (gnus-carpal 4))
13762              (vertical 1.0
13763                  (summary 0.25 point)
13764                  (summary-carpal 4)
13765                  (article 1.0))))
13766 @end lisp
13767
13768 Whoops.  Two buffers with the mystery 100% tag.  And what's that
13769 @code{horizontal} thingie?  
13770
13771 If the first element in one of the split is @code{horizontal}, Gnus will
13772 split the window horizontally, giving you two windows side-by-side.
13773 Inside each of these strips you may carry on all you like in the normal
13774 fashion.  The number following @code{horizontal} says what percentage of
13775 the screen is to be given to this strip.
13776
13777 For each split, there @emph{must} be one element that has the 100% tag.
13778 The splitting is never accurate, and this buffer will eat any leftover
13779 lines from the splits.
13780
13781 To be slightly more formal, here's a definition of what a valid split
13782 may look like:
13783
13784 @example
13785 split       = frame | horizontal | vertical | buffer | form
13786 frame       = "(frame " size *split ")"
13787 horizontal  = "(horizontal " size *split ")"
13788 vertical    = "(vertical " size *split ")"
13789 buffer      = "(" buffer-name " " size *[ "point" ] ")"
13790 size        = number | frame-params
13791 buffer-name = group | article | summary ...
13792 @end example
13793
13794 The limitations are that the @code{frame} split can only appear as the
13795 top-level split.  @var{form} should be an Emacs Lisp form that should
13796 return a valid split.  We see that each split is fully recursive, and
13797 may contain any number of @code{vertical} and @code{horizontal} splits. 
13798
13799 @vindex gnus-window-min-width
13800 @vindex gnus-window-min-height
13801 @cindex window height
13802 @cindex window width
13803 Finding the right sizes can be a bit complicated.  No window may be less
13804 than @code{gnus-window-min-height} (default 1) characters high, and all
13805 windows must be at least @code{gnus-window-min-width} (default 1)
13806 characters wide.  Gnus will try to enforce this before applying the
13807 splits.  If you want to use the normal Emacs window width/height limit,
13808 you can just set these two variables to @code{nil}.
13809
13810 If you're not familiar with Emacs terminology, @code{horizontal} and
13811 @code{vertical} splits may work the opposite way of what you'd expect.
13812 Windows inside a @code{horizontal} split are shown side-by-side, and
13813 windows within a @code{vertical} split are shown above each other.
13814
13815 @findex gnus-configure-frame
13816 If you want to experiment with window placement, a good tip is to call
13817 @code{gnus-configure-frame} directly with a split.  This is the function
13818 that does all the real work when splitting buffers.  Below is a pretty
13819 nonsensical configuration with 5 windows; two for the group buffer and
13820 three for the article buffer.  (I said it was nonsensical.)  If you
13821 @code{eval} the statement below, you can get an idea of how that would
13822 look straight away, without going through the normal Gnus channels.
13823 Play with it until you're satisfied, and then use
13824 @code{gnus-add-configuration} to add your new creation to the buffer
13825 configuration list. 
13826
13827 @lisp
13828 (gnus-configure-frame
13829  '(horizontal 1.0
13830     (vertical 10
13831       (group 1.0)
13832       (article 0.3 point))
13833     (vertical 1.0
13834       (article 1.0)
13835       (horizontal 4
13836         (group 1.0)
13837         (article 10)))))
13838 @end lisp
13839
13840 You might want to have several frames as well.  No prob---just use the
13841 @code{frame} split:
13842
13843 @lisp
13844 (gnus-configure-frame
13845  '(frame 1.0
13846          (vertical 1.0
13847                    (summary 0.25 point)
13848                    (article 1.0))
13849          (vertical ((height . 5) (width . 15)
13850                     (user-position . t)
13851                     (left . -1) (top . 1))
13852                    (picon 1.0))))
13853
13854 @end lisp
13855
13856 This split will result in the familiar summary/article window
13857 configuration in the first (or ``main'') frame, while a small additional
13858 frame will be created where picons will be shown.  As you can see,
13859 instead of the normal @code{1.0} top-level spec, each additional split
13860 should have a frame parameter alist as the size spec.
13861 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
13862 Reference Manual}.  Under XEmacs, a frame property list will be
13863 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
13864 is such a plist.
13865
13866 Here's a list of all possible keys for
13867 @code{gnus-buffer-configuration}:
13868
13869 @code{group}, @code{summary}, @code{article}, @code{server},
13870 @code{browse}, @code{message}, @code{pick}, @code{info},
13871 @code{summary-faq}, @code{edit-group}, @code{edit-server},
13872 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
13873 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
13874 @code{bug}, @code{compose-bounce}, and @code{score-trace}.
13875
13876 Note that the @code{message} key is used for both
13877 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
13878 it is desirable to distinguish between the two, something like this
13879 might be used:
13880
13881 @lisp
13882 (message (horizontal 1.0
13883                      (vertical 1.0 (message 1.0 point))
13884                      (vertical 0.24
13885                                (if (buffer-live-p gnus-summary-buffer)
13886                                    '(summary 0.5))
13887                                (group 1.0)))))
13888 @end lisp
13889
13890 @findex gnus-add-configuration
13891 Since the @code{gnus-buffer-configuration} variable is so long and
13892 complicated, there's a function you can use to ease changing the config
13893 of a single setting: @code{gnus-add-configuration}.  If, for instance,
13894 you want to change the @code{article} setting, you could say:
13895
13896 @lisp
13897 (gnus-add-configuration
13898  '(article (vertical 1.0
13899                (group 4)
13900                (summary .25 point)
13901                (article 1.0))))
13902 @end lisp
13903
13904 You'd typically stick these @code{gnus-add-configuration} calls in your
13905 @file{.gnus.el} file or in some startup hook---they should be run after
13906 Gnus has been loaded.
13907
13908 @vindex gnus-always-force-window-configuration
13909 If all windows mentioned in the configuration are already visible, Gnus
13910 won't change the window configuration.  If you always want to force the
13911 ``right'' window configuration, you can set
13912 @code{gnus-always-force-window-configuration} to non-@code{nil}.
13913
13914
13915 @node Faces and Fonts
13916 @section Faces and Fonts
13917 @cindex faces
13918 @cindex fonts
13919 @cindex colors
13920
13921 Fiddling with fonts and faces used to be very difficult, but these days
13922 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
13923 the face you want to alter, and alter it via the standard Customize
13924 interface.  
13925
13926
13927 @node Compilation
13928 @section Compilation
13929 @cindex compilation
13930 @cindex byte-compilation
13931
13932 @findex gnus-compile
13933
13934 Remember all those line format specification variables?
13935 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
13936 on.  Now, Gnus will of course heed whatever these variables are, but,
13937 unfortunately, changing them will mean a quite significant slow-down.
13938 (The default values of these variables have byte-compiled functions
13939 associated with them, while the user-generated versions do not, of
13940 course.) 
13941
13942 To help with this, you can run @kbd{M-x gnus-compile} after you've
13943 fiddled around with the variables and feel that you're (kind of)
13944 satisfied.  This will result in the new specs being byte-compiled, and
13945 you'll get top speed again.  Gnus will save these compiled specs in the
13946 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
13947 this function, though---you should compile them yourself by sticking
13948 them into the @code{.gnus.el} file and byte-compiling that file.)
13949
13950
13951 @node Mode Lines
13952 @section Mode Lines
13953 @cindex mode lines
13954
13955 @vindex gnus-updated-mode-lines
13956 @code{gnus-updated-mode-lines} says what buffers should keep their mode
13957 lines updated.  It is a list of symbols.  Supported symbols include
13958 @code{group}, @code{article}, @code{summary}, @code{server},
13959 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
13960 Gnus will keep that mode line updated with information that may be
13961 pertinent.  If this variable is @code{nil}, screen refresh may be
13962 quicker.
13963
13964 @cindex display-time
13965
13966 @vindex gnus-mode-non-string-length
13967 By default, Gnus displays information on the current article in the mode
13968 lines of the summary and article buffers.  The information Gnus wishes
13969 to display (e.g. the subject of the article) is often longer than the
13970 mode lines, and therefore have to be cut off at some point.  The
13971 @code{gnus-mode-non-string-length} variable says how long the other
13972 elements on the line is (i.e., the non-info part).  If you put
13973 additional elements on the mode line (e.g. a clock), you should modify
13974 this variable:
13975
13976 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
13977 @lisp
13978 (add-hook 'display-time-hook
13979           (lambda () (setq gnus-mode-non-string-length
13980                            (+ 21
13981                               (if line-number-mode 5 0)
13982                               (if column-number-mode 4 0)
13983                               (length display-time-string)))))
13984 @end lisp
13985
13986 If this variable is @code{nil} (which is the default), the mode line
13987 strings won't be chopped off, and they won't be padded either.  Note
13988 that the default is unlikely to be desirable, as even the percentage
13989 complete in the buffer may be crowded off the mode line; the user should
13990 configure this variable appropriately for her configuration.
13991
13992
13993 @node Highlighting and Menus
13994 @section Highlighting and Menus
13995 @cindex visual
13996 @cindex highlighting
13997 @cindex menus
13998
13999 @vindex gnus-visual
14000 The @code{gnus-visual} variable controls most of the Gnus-prettifying
14001 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
14002 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
14003 file.
14004
14005 This variable can be a list of visual properties that are enabled.  The
14006 following elements are valid, and are all included by default:
14007
14008 @table @code
14009 @item group-highlight
14010 Do highlights in the group buffer.
14011 @item summary-highlight
14012 Do highlights in the summary buffer.
14013 @item article-highlight
14014 Do highlights in the article buffer.
14015 @item highlight
14016 Turn on highlighting in all buffers.
14017 @item group-menu
14018 Create menus in the group buffer.
14019 @item summary-menu
14020 Create menus in the summary buffers.
14021 @item article-menu
14022 Create menus in the article buffer.
14023 @item browse-menu
14024 Create menus in the browse buffer.
14025 @item server-menu
14026 Create menus in the server buffer.
14027 @item score-menu
14028 Create menus in the score buffers.
14029 @item menu
14030 Create menus in all buffers.
14031 @end table
14032
14033 So if you only want highlighting in the article buffer and menus in all
14034 buffers, you could say something like:
14035
14036 @lisp
14037 (setq gnus-visual '(article-highlight menu))
14038 @end lisp
14039
14040 If you want highlighting only and no menus whatsoever, you'd say:
14041
14042 @lisp
14043 (setq gnus-visual '(highlight))
14044 @end lisp
14045
14046 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14047 in all Gnus buffers.
14048
14049 Other general variables that influence the look of all buffers include:
14050
14051 @table @code
14052 @item gnus-mouse-face
14053 @vindex gnus-mouse-face
14054 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
14055 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
14056
14057 @end table
14058
14059 There are hooks associated with the creation of all the different menus:
14060
14061 @table @code
14062
14063 @item gnus-article-menu-hook
14064 @vindex gnus-article-menu-hook
14065 Hook called after creating the article mode menu.
14066
14067 @item gnus-group-menu-hook
14068 @vindex gnus-group-menu-hook
14069 Hook called after creating the group mode menu.
14070
14071 @item gnus-summary-menu-hook
14072 @vindex gnus-summary-menu-hook
14073 Hook called after creating the summary mode menu.
14074
14075 @item gnus-server-menu-hook
14076 @vindex gnus-server-menu-hook
14077 Hook called after creating the server mode menu.
14078
14079 @item gnus-browse-menu-hook
14080 @vindex gnus-browse-menu-hook
14081 Hook called after creating the browse mode menu.
14082
14083 @item gnus-score-menu-hook
14084 @vindex gnus-score-menu-hook
14085 Hook called after creating the score mode menu.
14086
14087 @end table
14088
14089
14090 @node Buttons
14091 @section Buttons
14092 @cindex buttons
14093 @cindex mouse
14094 @cindex click
14095
14096 Those new-fangled @dfn{mouse} contraptions is very popular with the
14097 young, hep kids who don't want to learn the proper way to do things
14098 these days.  Why, I remember way back in the summer of '89, when I was
14099 using Emacs on a Tops 20 system.  Three hundred users on one single
14100 machine, and every user was running Simula compilers.  Bah!
14101
14102 Right.
14103
14104 @vindex gnus-carpal
14105 Well, you can make Gnus display bufferfuls of buttons you can click to
14106 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
14107 really.  Tell the chiropractor I sent you.
14108
14109
14110 @table @code
14111
14112 @item gnus-carpal-mode-hook
14113 @vindex gnus-carpal-mode-hook
14114 Hook run in all carpal mode buffers.
14115
14116 @item gnus-carpal-button-face
14117 @vindex gnus-carpal-button-face
14118 Face used on buttons.
14119
14120 @item gnus-carpal-header-face
14121 @vindex gnus-carpal-header-face
14122 Face used on carpal buffer headers.
14123
14124 @item gnus-carpal-group-buffer-buttons
14125 @vindex gnus-carpal-group-buffer-buttons
14126 Buttons in the group buffer.
14127
14128 @item gnus-carpal-summary-buffer-buttons
14129 @vindex gnus-carpal-summary-buffer-buttons
14130 Buttons in the summary buffer.
14131
14132 @item gnus-carpal-server-buffer-buttons
14133 @vindex gnus-carpal-server-buffer-buttons
14134 Buttons in the server buffer.
14135
14136 @item gnus-carpal-browse-buffer-buttons
14137 @vindex gnus-carpal-browse-buffer-buttons
14138 Buttons in the browse buffer.
14139 @end table
14140
14141 All the @code{buttons} variables are lists.  The elements in these list
14142 are either cons cells where the @code{car} contains a text to be displayed and
14143 the @code{cdr} contains a function symbol, or a simple string.
14144
14145
14146 @node Daemons
14147 @section Daemons
14148 @cindex demons
14149 @cindex daemons
14150
14151 Gnus, being larger than any program ever written (allegedly), does lots
14152 of strange stuff that you may wish to have done while you're not
14153 present.  For instance, you may want it to check for new mail once in a
14154 while.  Or you may want it to close down all connections to all servers
14155 when you leave Emacs idle.  And stuff like that.
14156
14157 Gnus will let you do stuff like that by defining various
14158 @dfn{handlers}.  Each handler consists of three elements:  A
14159 @var{function}, a @var{time}, and an @var{idle} parameter.
14160
14161 Here's an example of a handler that closes connections when Emacs has
14162 been idle for thirty minutes:
14163
14164 @lisp
14165 (gnus-demon-close-connections nil 30)
14166 @end lisp
14167
14168 Here's a handler that scans for PGP headers every hour when Emacs is
14169 idle: 
14170
14171 @lisp
14172 (gnus-demon-scan-pgp 60 t)
14173 @end lisp
14174
14175 This @var{time} parameter and than @var{idle} parameter work together
14176 in a strange, but wonderful fashion.  Basically, if @var{idle} is
14177 @code{nil}, then the function will be called every @var{time} minutes.
14178
14179 If @var{idle} is @code{t}, then the function will be called after
14180 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
14181 the function will never be called.  But once Emacs goes idle, the
14182 function will be called every @var{time} minutes.
14183
14184 If @var{idle} is a number and @var{time} is a number, the function will
14185 be called every @var{time} minutes only when Emacs has been idle for
14186 @var{idle} minutes.
14187
14188 If @var{idle} is a number and @var{time} is @code{nil}, the function
14189 will be called once every time Emacs has been idle for @var{idle}
14190 minutes.  
14191
14192 And if @var{time} is a string, it should look like @samp{07:31}, and
14193 the function will then be called once every day somewhere near that
14194 time.  Modified by the @var{idle} parameter, of course.
14195
14196 @vindex gnus-demon-timestep
14197 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
14198 seconds.  This is 60 by default.  If you change that variable,
14199 all the timings in the handlers will be affected.)
14200
14201 @vindex gnus-use-demon
14202 To set the whole thing in motion, though, you have to set
14203 @code{gnus-use-demon} to @code{t}.
14204
14205 So, if you want to add a handler, you could put something like this in
14206 your @file{.gnus} file:
14207
14208 @findex gnus-demon-add-handler
14209 @lisp
14210 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
14211 @end lisp
14212
14213 @findex gnus-demon-add-nocem
14214 @findex gnus-demon-add-scanmail
14215 @findex gnus-demon-add-rescan
14216 @findex gnus-demon-add-scan-timestamps
14217 @findex gnus-demon-add-disconnection
14218 Some ready-made functions to do this have been created:
14219 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
14220 @code{gnus-demon-add-nntp-close-connection}, 
14221 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
14222 @code{gnus-demon-add-scanmail}.  Just put those functions in your
14223 @file{.gnus} if you want those abilities.
14224
14225 @findex gnus-demon-init
14226 @findex gnus-demon-cancel
14227 @vindex gnus-demon-handlers
14228 If you add handlers to @code{gnus-demon-handlers} directly, you should
14229 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
14230 daemons, you can use the @code{gnus-demon-cancel} function.
14231
14232 Note that adding daemons can be pretty naughty if you overdo it.  Adding
14233 functions that scan all news and mail from all servers every two seconds
14234 is a sure-fire way of getting booted off any respectable system.  So
14235 behave.
14236
14237
14238 @node NoCeM
14239 @section NoCeM
14240 @cindex nocem
14241 @cindex spam
14242
14243 @dfn{Spamming} is posting the same article lots and lots of times.
14244 Spamming is bad.  Spamming is evil.  
14245
14246 Spamming is usually canceled within a day or so by various anti-spamming
14247 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
14248 NoCeM is pronounced ``no see-'em'', and means what the name
14249 implies---these are messages that make the offending articles, like, go
14250 away.  
14251
14252 What use are these NoCeM messages if the articles are canceled anyway?
14253 Some sites do not honor cancel messages and some sites just honor cancels
14254 from a select few people.  Then you may wish to make use of the NoCeM
14255 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
14256
14257 Gnus can read and parse the messages in this group automatically, and
14258 this will make spam disappear.  
14259
14260 There are some variables to customize, of course:
14261
14262 @table @code
14263 @item gnus-use-nocem
14264 @vindex gnus-use-nocem
14265 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
14266 by default. 
14267
14268 @item gnus-nocem-groups
14269 @vindex gnus-nocem-groups
14270 Gnus will look for NoCeM messages in the groups in this list.  The
14271 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
14272 "alt.nocem.misc" "news.admin.net-abuse.announce")}. 
14273
14274 @item gnus-nocem-issuers
14275 @vindex gnus-nocem-issuers
14276 There are many people issuing NoCeM messages.  This list says what
14277 people you want to listen to.  The default is @code{("Automoose-1"
14278 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
14279 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
14280 (Richard E. Depew)")}; fine, upstanding citizens all of them.
14281
14282 Known despammers that you can put in this list include:
14283
14284 @table @samp
14285 @item clewis@@ferret.ocunix.on.ca;
14286 @cindex Chris Lewis
14287 Chris Lewis---Major Canadian despammer who has probably canceled more
14288 usenet abuse than anybody else.
14289
14290 @item Automoose-1
14291 @cindex CancelMoose[tm]
14292 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
14293 Norwegian, and was the person(s) who invented NoCeM.  
14294
14295 @item jem@@xpat.com;
14296 @cindex Jem
14297 John Milburn---despammer located in Korea who is getting very busy these
14298 days.
14299
14300 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
14301 Richard E. Depew---lone American despammer.  He mostly cancels binary
14302 postings to non-binary groups and removes spews (regurgitated articles).
14303 @end table
14304
14305 You do not have to heed NoCeM messages from all these people---just the
14306 ones you want to listen to.  You also don't have to accept all NoCeM
14307 messages from the people you like.  Each NoCeM message has a @dfn{type}
14308 header that gives the message a (more or less, usually less) rigorous
14309 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
14310 @samp{binary}, and @samp{troll}.  To specify this, you have to use
14311 @var{(issuer conditions ...)} elements in the list.  Each condition is
14312 either a string (which is a regexp that matches types you want to use)
14313 or a list on the form @code{(not STRING)}, where @var{string} is a
14314 regexp that matches types you don't want to use.
14315
14316 For instance, if you want all NoCeM messages from Chris Lewis except his
14317 @samp{troll} messages, you'd say:
14318
14319 @lisp
14320 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
14321 @end lisp
14322
14323 On the other hand, if you just want nothing but his @samp{spam} and
14324 @samp{spew} messages, you'd say:
14325
14326 @lisp
14327 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
14328 @end lisp
14329
14330 The specs are applied left-to-right.
14331
14332
14333 @item gnus-nocem-verifyer
14334 @vindex gnus-nocem-verifyer
14335 @findex mc-verify
14336 This should be a function for verifying that the NoCeM issuer is who she
14337 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
14338 function.  If this is too slow and you don't care for verification
14339 (which may be dangerous), you can set this variable to @code{nil}.
14340
14341 If you want signed NoCeM messages to be verified and unsigned messages
14342 not to be verified (but used anyway), you could do something like:
14343
14344 @lisp
14345 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
14346
14347 (defun my-gnus-mc-verify ()
14348   (not (eq 'forged
14349            (ignore-errors
14350              (if (mc-verify)
14351                  t
14352                'forged)))))
14353 @end lisp
14354
14355 This might be dangerous, though.
14356
14357 @item gnus-nocem-directory
14358 @vindex gnus-nocem-directory
14359 This is where Gnus will store its NoCeM cache files.  The default is
14360 @file{~/News/NoCeM/}. 
14361
14362 @item gnus-nocem-expiry-wait
14363 @vindex gnus-nocem-expiry-wait
14364 The number of days before removing old NoCeM entries from the cache.
14365 The default is 15.  If you make it shorter Gnus will be faster, but you
14366 might then see old spam.
14367
14368 @end table
14369
14370 Using NoCeM could potentially be a memory hog.  If you have many living
14371 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
14372 big.  If this is a problem, you should kill off all (or most) of your
14373 unsubscribed groups (@pxref{Subscription Commands}).
14374
14375
14376 @node Undo
14377 @section Undo
14378 @cindex undo
14379
14380 It is very useful to be able to undo actions one has done.  In normal
14381 Emacs buffers, it's easy enough---you just push the @code{undo} button.
14382 In Gnus buffers, however, it isn't that simple.
14383
14384 The things Gnus displays in its buffer is of no value whatsoever to
14385 Gnus---it's all just data designed to look nice to the user.
14386 Killing a group in the group buffer with @kbd{C-k} makes the line
14387 disappear, but that's just a side-effect of the real action---the
14388 removal of the group in question from the internal Gnus structures.
14389 Undoing something like that can't be done by the normal Emacs
14390 @code{undo} function.
14391
14392 Gnus tries to remedy this somewhat by keeping track of what the user
14393 does and coming up with actions that would reverse the actions the user
14394 takes.  When the user then presses the @code{undo} key, Gnus will run
14395 the code to reverse the previous action, or the previous actions.
14396 However, not all actions are easily reversible, so Gnus currently offers
14397 a few key functions to be undoable.  These include killing groups,
14398 yanking groups, and changing the list of read articles of groups.
14399 That's it, really.  More functions may be added in the future, but each
14400 added function means an increase in data to be stored, so Gnus will
14401 never be totally undoable.
14402
14403 @findex gnus-undo-mode
14404 @vindex gnus-use-undo
14405 @findex gnus-undo
14406 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
14407 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
14408 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
14409 command, which should feel kinda like the normal Emacs @code{undo}
14410 command. 
14411
14412
14413 @node Moderation
14414 @section Moderation
14415 @cindex moderation
14416
14417 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
14418 It is not included in the standard Gnus package.  Write a mail to
14419 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
14420 get a copy.
14421
14422 The moderation package is implemented as a minor mode for summary
14423 buffers.  Put
14424
14425 @lisp
14426 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
14427 @end lisp
14428
14429 in your @file{.gnus.el} file.
14430
14431 If you are the moderator of @samp{rec.zoofle}, this is how it's
14432 supposed to work:
14433
14434 @enumerate
14435 @item 
14436 You split your incoming mail by matching on
14437 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
14438 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
14439
14440 @item
14441 You enter that group once in a while and post articles using the @kbd{e}
14442 (edit-and-post) or @kbd{s} (just send unedited) commands.
14443
14444 @item
14445 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
14446 articles that weren't approved by you, you can cancel them with the
14447 @kbd{c} command.
14448 @end enumerate
14449
14450 To use moderation mode in these two groups, say:
14451
14452 @lisp
14453 (setq gnus-moderated-list
14454       "^nnml:rec.zoofle$\\|^rec.zoofle$")
14455 @end lisp
14456
14457
14458 @node XEmacs Enhancements
14459 @section XEmacs Enhancements
14460 @cindex XEmacs
14461
14462 XEmacs is able to display pictures and stuff, so Gnus has taken
14463 advantage of that.
14464
14465 @menu
14466 * Picons::    How to display pictures of what your reading.
14467 * Smileys::   Show all those happy faces the way they were meant to be shown.
14468 * Toolbar::   Click'n'drool.
14469 * XVarious::  Other XEmacsy Gnusey variables.
14470 @end menu
14471
14472
14473 @node Picons
14474 @subsection Picons
14475
14476 @iftex
14477 @iflatex
14478 \include{picons}
14479 @end iflatex
14480 @end iftex
14481
14482 So...  You want to slow down your news reader even more!  This is a
14483 good way to do so.  Its also a great way to impress people staring
14484 over your shoulder as you read news.
14485
14486 @menu
14487 * Picon Basics::           What are picons and How do I get them.
14488 * Picon Requirements::     Don't go further if you aren't using XEmacs.
14489 * Easy Picons::            Displaying Picons---the easy way.
14490 * Hard Picons::            The way you should do it.  You'll learn something.
14491 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
14492 @end menu
14493
14494
14495 @node Picon Basics
14496 @subsubsection Picon Basics
14497
14498 What are Picons?  To quote directly from the Picons Web site:
14499
14500 @iftex
14501 @iflatex
14502 \margindex{}
14503 @end iflatex
14504 @end iftex
14505
14506 @quotation 
14507 @dfn{Picons} is short for ``personal icons''.  They're small,
14508 constrained images used to represent users and domains on the net,
14509 organized into databases so that the appropriate image for a given
14510 e-mail address can be found.  Besides users and domains, there are picon
14511 databases for Usenet newsgroups and weather forecasts.  The picons are
14512 in either monochrome @code{XBM} format or color @code{XPM} and
14513 @code{GIF} formats.
14514 @end quotation
14515
14516 @vindex gnus-picons-piconsearch-url
14517 If you have a permanent connection to the Internet you can use Steve
14518 Kinzler's Picons Search engine by setting
14519 @code{gnus-picons-piconsearch-url} to the string
14520 @file{http://www.cs.indiana.edu/picons/search.html}.
14521
14522 @vindex gnus-picons-database
14523 Otherwise you need a local copy of his database.  For instructions on
14524 obtaining and installing the picons databases, point your Web browser at
14525 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
14526 picons to be installed into a location pointed to by
14527 @code{gnus-picons-database}.
14528
14529
14530 @node Picon Requirements
14531 @subsubsection Picon Requirements
14532
14533 To have Gnus display Picons for you, you must be running XEmacs
14534 19.13 or greater since all other versions of Emacs aren't yet able to
14535 display images.
14536
14537 Additionally, you must have @code{x} support compiled into XEmacs.  To
14538 display color picons which are much nicer than the black & white one,
14539 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
14540
14541 @vindex gnus-picons-convert-x-face
14542 If you want to display faces from @code{X-Face} headers, you should have
14543 the @code{xface} support compiled into XEmacs.  Otherwise you must have
14544 the @code{netpbm} utilities installed, or munge the
14545 @code{gnus-picons-convert-x-face} variable to use something else.
14546
14547
14548 @node Easy Picons
14549 @subsubsection Easy Picons
14550
14551 To enable displaying picons, simply put the following line in your
14552 @file{~/.gnus} file and start Gnus.
14553
14554 @lisp
14555 (setq gnus-use-picons t)
14556 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14557 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
14558 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
14559 @end lisp
14560
14561 and make sure @code{gnus-picons-database} points to the directory
14562 containing the Picons databases.
14563
14564 Alternatively if you want to use the web piconsearch engine add this:
14565
14566 @lisp
14567 (setq gnus-picons-piconsearch-url "http://www.cs.indiana.edu:800/piconsearch")
14568 @end lisp
14569
14570
14571 @node Hard Picons
14572 @subsubsection Hard Picons 
14573
14574 @iftex
14575 @iflatex
14576 \margindex{}
14577 @end iflatex
14578 @end iftex
14579
14580 Gnus can display picons for you as you enter and leave groups and
14581 articles.  It knows how to interact with three sections of the picons
14582 database.  Namely, it can display the picons newsgroup pictures,
14583 author's face picture(s), and the authors domain.  To enable this
14584 feature, you need to select where to get the picons from, and where to
14585 display them.
14586
14587 @table @code 
14588
14589 @item gnus-picons-database
14590 @vindex gnus-picons-database
14591 The location of the picons database.  Should point to a directory
14592 containing the @file{news}, @file{domains}, @file{users} (and so on)
14593 subdirectories.  This is only useful if
14594 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
14595 @file{/usr/local/faces/}.
14596
14597 @item gnus-picons-piconsearch-url
14598 @vindex gnus-picons-piconsearch-url
14599 The URL for the web picons search engine.  The only currently known
14600 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
14601 workaround network delays, icons will be fetched in the background.  If
14602 this is @code{nil} 'the default), then picons are fetched from local
14603 database indicated by @code{gnus-picons-database}.
14604
14605 @item gnus-picons-display-where 
14606 @vindex gnus-picons-display-where 
14607 Where the picon images should be displayed.  It is @code{picons} by
14608 default (which by default maps to the buffer @samp{*Picons*}).  Other
14609 valid places could be @code{article}, @code{summary}, or
14610 @samp{*scratch*} for all I care.  Just make sure that you've made the
14611 buffer visible using the standard Gnus window configuration
14612 routines---@pxref{Windows Configuration}.
14613
14614 @item gnus-picons-group-excluded-groups
14615 @vindex gnus-picons-group-excluded-groups
14616 Groups that are matched by this regexp won't have their group icons
14617 displayed. 
14618
14619 @end table
14620
14621 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
14622 window configuration for you to include the @code{picons} buffer.
14623
14624 Now that you've made those decision, you need to add the following
14625 functions to the appropriate hooks so these pictures will get displayed
14626 at the right time.
14627
14628 @vindex gnus-article-display-hook
14629 @vindex gnus-picons-display-where
14630 @table @code
14631 @item gnus-article-display-picons
14632 @findex gnus-article-display-picons
14633 Looks up and displays the picons for the author and the author's domain
14634 in the @code{gnus-picons-display-where} buffer.  Should be added to the
14635 @code{gnus-article-display-hook}.
14636
14637 @item gnus-group-display-picons
14638 @findex gnus-article-display-picons
14639 Displays picons representing the current group.  This function should
14640 be added to the @code{gnus-summary-prepare-hook} or to the
14641 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
14642 is set to @code{article}.
14643
14644 @item gnus-picons-article-display-x-face
14645 @findex gnus-article-display-picons
14646 Decodes and displays the X-Face header if present.  This function
14647 should be added to @code{gnus-article-display-hook}.
14648
14649 @end table
14650
14651 Note:  You must append them to the hook, so make sure to specify 't'
14652 for the append flag of @code{add-hook}:
14653
14654 @lisp
14655 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14656 @end lisp
14657
14658
14659 @node Picon Useless Configuration
14660 @subsubsection Picon Useless Configuration
14661
14662 @iftex
14663 @iflatex
14664 \margindex{}
14665 @end iflatex
14666 @end iftex
14667
14668 The following variables offer further control over how things are
14669 done, where things are located, and other useless stuff you really
14670 don't need to worry about.
14671
14672 @table @code
14673
14674 @item gnus-picons-news-directories
14675 @vindex gnus-picons-news-directories
14676 List of subdirectories to search in @code{gnus-picons-database} for
14677 newsgroups faces.  @code{("news")} is the default.
14678
14679 @item gnus-picons-user-directories
14680 @vindex gnus-picons-user-directories
14681 List of subdirectories to search in @code{gnus-picons-database} for user
14682 faces.  @code{("local" "users" "usenix" "misc")} is the default.
14683
14684 @item gnus-picons-domain-directories
14685 @vindex gnus-picons-domain-directories
14686 List of subdirectories to search in @code{gnus-picons-database} for
14687 domain name faces.  Defaults to @code{("domains")}.  Some people may
14688 want to add @samp{"unknown"} to this list.
14689
14690 @item gnus-picons-convert-x-face
14691 @vindex gnus-picons-convert-x-face
14692 If you don't have @code{xface} support builtin XEmacs, this is the
14693 command to use to convert the @code{X-Face} header to an X bitmap
14694 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
14695 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
14696 gnus-picons-x-face-file-name)}
14697
14698 @item gnus-picons-x-face-file-name
14699 @vindex gnus-picons-x-face-file-name
14700 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
14701 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
14702
14703 @item gnus-picons-has-modeline-p
14704 @vindex gnus-picons-has-modeline-p
14705 If you have set @code{gnus-picons-display-where} to @code{picons}, your
14706 XEmacs frame will become really cluttered.  To alleviate this a bit you
14707 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
14708 remove the mode line from the Picons buffer.  This is only useful if
14709 @code{gnus-picons-display-where} is @code{picons}.
14710
14711 @item gnus-picons-refresh-before-display
14712 @vindex gnus-picons-refresh-before-display
14713 If non-nil, display the article buffer before computing the picons.
14714 Defaults to @code{nil}.
14715
14716 @item gnus-picons-display-as-address
14717 @vindex gnus-picons-display-as-address
14718 If @code{t} display textual email addresses along with pictures.
14719 Defaults to @code{t}.
14720
14721 @item gnus-picons-file-suffixes
14722 @vindex gnus-picons-file-suffixes
14723 Ordered list of suffixes on picon file names to try.  Defaults to
14724 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
14725
14726 @item gnus-picons-display-article-move-p
14727 @vindex gnus-picons-display-article-move-p
14728 Whether to move point to first empty line when displaying picons.  This
14729 has only an effect if `gnus-picons-display-where' has value `article'.
14730
14731 @item gnus-picons-clear-cache-on-shutdown
14732 @vindex gnus-picons-clear-cache-on-shutdown
14733 Whether to clear the picons cache when exiting gnus.  Gnus caches every
14734 picons it finds while it is running.  This saves some time in the search
14735 process but eats some memory.  If this variable is set to @code{nil},
14736 Gnus will never clear the cache itself; you will have to manually call
14737 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
14738 cleared every time you exit Gnus.  Defaults to @code{t}.
14739
14740 @iftex
14741 @iflatex
14742 \margindex{}
14743 @end iflatex
14744 @end iftex
14745
14746 @end table
14747
14748 @node Smileys
14749 @subsection Smileys
14750 @cindex smileys
14751
14752 @iftex
14753 @iflatex
14754 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
14755 \input{smiley}
14756 @end iflatex
14757 @end iftex
14758
14759 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
14760 currently the only package that uses Smiley, it is documented here.
14761
14762 In short---to use Smiley in Gnus, put the following in your
14763 @file{.gnus.el} file:
14764
14765 @lisp
14766 (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
14767 @end lisp
14768
14769 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
14770 the like---to pictures and displays those instead of the text smiley
14771 faces.  The conversion is controlled by a list of regexps that matches
14772 text and maps that to file names.
14773
14774 @vindex smiley-nosey-regexp-alist
14775 @vindex smiley-deformed-regexp-alist
14776 Smiley supplies two example conversion alists by default:
14777 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
14778 and so on), and @code{smiley-nosey-regexp-alist} (which matches
14779 @samp{:-)}, @samp{:-(} and so on).
14780
14781 The alist used is specified by the @code{smiley-regexp-alist} variable,
14782 which defaults to the value of @code{smiley-deformed-regexp-alist}.
14783
14784 The first item in each element is the regexp to be matched; the second
14785 element is the regexp match group that is to be replaced by the picture;
14786 and the third element is the name of the file to be displayed.
14787
14788 The following variables customize where Smiley will look for these
14789 files, as well as the color to be used and stuff:
14790
14791 @table @code
14792
14793 @item smiley-data-directory
14794 @vindex smiley-data-directory
14795 Where Smiley will look for smiley faces files.
14796
14797 @item smiley-flesh-color
14798 @vindex smiley-flesh-color
14799 Skin color.  The default is @samp{yellow}, which is really racist.
14800
14801 @item smiley-features-color
14802 @vindex smiley-features-color
14803 Color of the features of the face.  The default is @samp{black}.
14804
14805 @item smiley-tongue-color
14806 @vindex smiley-tongue-color
14807 Color of the tongue.  The default is @samp{red}.
14808
14809 @item smiley-circle-color
14810 @vindex smiley-circle-color
14811 Color of the circle around the face.  The default is @samp{black}.
14812
14813 @item smiley-mouse-face
14814 @vindex smiley-mouse-face
14815 Face used for mouse highlighting over the smiley face.
14816
14817 @end table
14818
14819
14820 @node Toolbar
14821 @subsection Toolbar
14822
14823 @table @code
14824
14825 @iftex
14826 @iflatex
14827 \margindex{}
14828 @end iflatex
14829 @end iftex
14830
14831 @item gnus-use-toolbar
14832 @vindex gnus-use-toolbar
14833 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
14834 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
14835 @code{right-toolbar}, or @code{left-toolbar}.
14836
14837 @item gnus-group-toolbar
14838 @vindex gnus-group-toolbar
14839 The toolbar in the group buffer.
14840
14841 @item gnus-summary-toolbar
14842 @vindex gnus-summary-toolbar
14843 The toolbar in the summary buffer.
14844
14845 @item gnus-summary-mail-toolbar
14846 @vindex gnus-summary-mail-toolbar
14847 The toolbar in the summary buffer of mail groups.
14848
14849 @end table
14850
14851
14852 @node XVarious
14853 @subsection Various XEmacs Variables
14854
14855 @table @code
14856 @item gnus-xmas-glyph-directory
14857 @vindex gnus-xmas-glyph-directory
14858 This is where Gnus will look for pictures.  Gnus will normally
14859 auto-detect this directory, but you may set it manually if you have an
14860 unusual directory structure.
14861
14862 @item gnus-xmas-logo-color-alist
14863 @vindex gnus-xmas-logo-color-alist
14864 This is an alist where the key is a type symbol and the values are the
14865 foreground and background color of the splash page glyph.
14866
14867 @item gnus-xmas-logo-color-style
14868 @vindex gnus-xmas-logo-color-style
14869 This is the key used to look up the color in the alist described above.
14870 Legal values include @code{flame}, @code{pine}, @code{moss},
14871 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
14872 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
14873
14874 @item gnus-xmas-modeline-glyph
14875 @vindex gnus-xmas-modeline-glyph
14876 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
14877 default. 
14878
14879 @iftex
14880 @iflatex
14881 \margindex{}
14882 @end iflatex
14883 @end iftex
14884
14885 @end table
14886
14887
14888
14889
14890 @node Fuzzy Matching
14891 @section Fuzzy Matching
14892 @cindex fuzzy matching
14893
14894 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
14895 things like scoring, thread gathering and thread comparison.  
14896
14897 As opposed to regular expression matching, fuzzy matching is very fuzzy.
14898 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
14899 means, and the implementation has changed over time.
14900
14901 Basically, it tries to remove all noise from lines before comparing.
14902 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
14903 out of the strings before comparing the results.  This often leads to
14904 adequate results---even when faced with strings generated by text
14905 manglers masquerading as newsreaders.
14906
14907
14908 @node Thwarting Email Spam
14909 @section Thwarting Email Spam
14910 @cindex email spam
14911 @cindex spam
14912 @cindex UCE
14913 @cindex unsolicited commercial email
14914
14915 In these last days of the Usenet, commercial vultures are hanging about
14916 and grepping through news like crazy to find email addresses they can
14917 foist off their scams and products to.  As a reaction to this, many
14918 people have started putting nonsense addresses into their @code{From}
14919 lines.  I think this is counterproductive---it makes it difficult for
14920 people to send you legitimate mail in response to things you write, as
14921 well as making it difficult to see who wrote what.  This rewriting may
14922 perhaps be a bigger menace than the unsolicited commercial email itself
14923 in the end.
14924
14925 The biggest problem I have with email spam is that it comes in under
14926 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
14927 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
14928 mail group, only to find two pyramid schemes, seven advertisements
14929 (``New!  Miracle tonic for growing full, lustrouos hair on your toes!'')
14930 and one mail asking me to repent and find some god.
14931
14932 This is annoying.
14933
14934 The way to deal with this is having Gnus split out all spam into a
14935 @samp{spam} mail group (@pxref{Splitting Mail}).
14936
14937 First, pick one (1) valid mail address that you can be reached at, and
14938 put it in your @code{From} header of all your news articles.  (I've
14939 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
14940 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
14941 sysadm whether your sendmail installation accepts keywords in the local
14942 part of the mail address.)
14943
14944 @lisp
14945 (setq message-default-news-headers
14946       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
14947 @end lisp
14948
14949 Then put the following split rule in @code{nnmail-split-fancy}
14950 (@pxref{Fancy Mail Splitting}):
14951
14952 @lisp
14953 (
14954  ...
14955  (to "larsi@@trym.ifi.uio.no"
14956       (| ("subject" "re:.*" "misc")
14957          ("references" ".*@@.*" "misc")
14958          "spam"))
14959  ...
14960 )
14961 @end lisp
14962
14963 This says that all mail to this address is suspect, but if it has a
14964 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
14965 header, it's probably ok.  All the rest goes to the @samp{spam} group.
14966 (This idea probably comes from Tim Pierce.)
14967
14968 In addition, many mail spammers talk directly to your @code{smtp} server
14969 and do not include your email address explicitly in the @code{To}
14970 header.  Why they do this is unknown---perhaps it's to thwart this
14971 twarting scheme?  In any case, this is trivial to deal with---you just
14972 put anything not addressed to you in the @samp{spam} group by ending
14973 your fancy split rule in this way:
14974
14975 @lisp
14976 (
14977  ...
14978  (to "larsi" "misc")
14979  "spam")
14980 @end lisp
14981
14982 In my experience, this will sort virtually everything into the right
14983 group.  You still have to check the @samp{spam} group from time to time to
14984 check for legitimate mail, though.  If you feel like being a good net
14985 citizen, you can even send off complaints to the proper authorities on
14986 each unsolicited commercial email---at your leisure.
14987
14988 If you are also a lazy net citizen, you will probably prefer complaining
14989 automatically with the @file{gnus-junk.el} package, availiable FOR FREE
14990 at @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
14991 Since most e-mail spam is sent automatically, this may reconcile the
14992 cosmic balance somewhat.
14993
14994 This works for me.  It allows people an easy way to contact me (they can
14995 just press @kbd{r} in the usual way), and I'm not bothered at all with
14996 spam.  It's a win-win situation.  Forging @code{From} headers to point
14997 to non-existant domains is yucky, in my opinion.
14998
14999
15000 @node Various Various
15001 @section Various Various
15002 @cindex mode lines
15003 @cindex highlights
15004
15005 @table @code
15006
15007 @item gnus-home-directory
15008 All Gnus path variables will be initialized from this variable, which
15009 defaults to @file{~/}.
15010
15011 @item gnus-directory
15012 @vindex gnus-directory
15013 Most Gnus storage path variables will be initialized from this variable,
15014 which defaults to the @samp{SAVEDIR} environment variable, or
15015 @file{~/News/} if that variable isn't set.
15016
15017 @item gnus-default-directory
15018 @vindex gnus-default-directory
15019 Not related to the above variable at all---this variable says what the
15020 default directory of all Gnus buffers should be.  If you issue commands
15021 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
15022 default directory.  If this variable is @code{nil} (which is the
15023 default), the default directory will be the default directory of the
15024 buffer you were in when you started Gnus.
15025
15026 @item gnus-verbose
15027 @vindex gnus-verbose
15028 This variable is an integer between zero and ten.  The higher the value,
15029 the more messages will be displayed.  If this variable is zero, Gnus
15030 will never flash any messages, if it is seven (which is the default),
15031 most important messages will be shown, and if it is ten, Gnus won't ever
15032 shut up, but will flash so many messages it will make your head swim.
15033
15034 @item gnus-verbose-backends
15035 @vindex gnus-verbose-backends
15036 This variable works the same way as @code{gnus-verbose}, but it applies
15037 to the Gnus backends instead of Gnus proper.
15038
15039 @item nnheader-max-head-length
15040 @vindex nnheader-max-head-length
15041 When the backends read straight heads of articles, they all try to read
15042 as little as possible.  This variable (default 4096) specifies
15043 the absolute max length the backends will try to read before giving up
15044 on finding a separator line between the head and the body.  If this
15045 variable is @code{nil}, there is no upper read bound.  If it is
15046 @code{t}, the backends won't try to read the articles piece by piece,
15047 but read the entire articles.  This makes sense with some versions of
15048 @code{ange-ftp} or @code{efs}. 
15049
15050 @item nnheader-head-chop-length
15051 @vindex nnheader-head-chop-length
15052 This variable (default 2048) says how big a piece of each article to
15053 read when doing the operation described above.
15054
15055 @item nnheader-file-name-translation-alist 
15056 @vindex nnheader-file-name-translation-alist 
15057 @cindex file names
15058 @cindex invalid characters in file names
15059 @cindex characters in file names
15060 This is an alist that says how to translate characters in file names.
15061 For instance, if @samp{:} is invalid as a file character in file names
15062 on your system (you OS/2 user you), you could say something like:
15063
15064 @lisp
15065 (setq nnheader-file-name-translation-alist 
15066       '((?: . ?_)))
15067 @end lisp
15068
15069 In fact, this is the default value for this variable on OS/2 and MS
15070 Windows (phooey) systems.
15071
15072 @item gnus-hidden-properties
15073 @vindex gnus-hidden-properties
15074 This is a list of properties to use to hide ``invisible'' text.  It is
15075 @code{(invisible t intangible t)} by default on most systems, which
15076 makes invisible text invisible and intangible.
15077
15078 @item gnus-parse-headers-hook
15079 @vindex gnus-parse-headers-hook
15080 A hook called before parsing headers.  It can be used, for instance, to
15081 gather statistics on the headers fetched, or perhaps you'd like to prune
15082 some headers.  I don't see why you'd want that, though.
15083
15084 @item gnus-shell-command-separator
15085 @vindex gnus-shell-command-separator
15086 String used to separate two shell commands.  The default is @samp{;}. 
15087
15088
15089 @end table
15090
15091
15092 @node The End
15093 @chapter The End
15094
15095 Well, that's the manual---you can get on with your life now.  Keep in
15096 touch.  Say hello to your cats from me.  
15097
15098 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
15099
15100 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
15101
15102 @quotation
15103 @strong{Te Deum}
15104
15105 @sp 1
15106 Not because of victories @*
15107 I sing,@*
15108 having none,@*
15109 but for the common sunshine,@*
15110 the breeze,@*
15111 the largess of the spring.
15112
15113 @sp 1
15114 Not for victory@*
15115 but for the day's work done@*
15116 as well as I was able;@*
15117 not for a seat upon the dais@*
15118 but at the common table.@*
15119 @end quotation
15120
15121
15122 @node Appendices
15123 @chapter Appendices
15124
15125 @menu
15126 * History::                        How Gnus got where it is today.
15127 * Terminology::                    We use really difficult, like, words here.
15128 * Customization::                  Tailoring Gnus to your needs.
15129 * Troubleshooting::                What you might try if things do not work.
15130 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
15131 * Emacs for Heathens::             A short introduction to Emacsian terms.
15132 * Frequently Asked Questions::     A question-and-answer session.
15133 @end menu
15134
15135
15136 @node History
15137 @section History
15138
15139 @cindex history
15140 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
15141 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
15142
15143 If you want to investigate the person responsible for this outrage, you
15144 can point your (feh!) web browser to
15145 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
15146 distribution point for the new and spiffy versions of Gnus, and is known
15147 as The Site That Destroys Newsrcs And Drives People Mad.
15148
15149 During the first extended alpha period of development, the new Gnus was
15150 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
15151 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
15152 (Besides, the ``Gnus'' in this abbreviation should probably be
15153 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
15154 appropriate name, don't you think?)
15155
15156 In any case, after spending all that energy on coming up with a new and
15157 spunky name, we decided that the name was @emph{too} spunky, so we
15158 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
15159 ``@sc{gnus}''.  New vs. old.
15160
15161 The first ``proper'' release of Gnus 5 was done in November 1995 when it
15162 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
15163 plus 15 Gnus 5.0 releases).
15164
15165 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
15166 releases)) was released under the name ``Gnus 5.2'' (40 releases).
15167
15168 On July 28th 1996 work on Red Gnus was begun, and it was released on
15169 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
15170
15171 If you happen upon a version of Gnus that has a prefixed name --
15172 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
15173 don't panic.  Don't let it know that you're frightened.  Back away.
15174 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
15175 out of its reach.  Find a proper released version of Gnus and snuggle up
15176 to that instead.
15177
15178 @menu
15179 * Why?::                What's the point of Gnus?
15180 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
15181 * Conformity::          Gnus tries to conform to all standards.
15182 * Emacsen::             Gnus can be run on a few modern Emacsen.
15183 * Contributors::        Oodles of people.  
15184 * New Features::        Pointers to some of the new stuff in Gnus.
15185 * Newest Features::     Features so new that they haven't been written yet.
15186 @end menu
15187
15188
15189 @node Why?
15190 @subsection Why?
15191
15192 What's the point of Gnus?  
15193
15194 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
15195 newsreader, that lets you do anything you can think of.  That was my
15196 original motivation, but while working on Gnus, it has become clear to
15197 me that this generation of newsreaders really belong in the stone age.
15198 Newsreaders haven't developed much since the infancy of the net.  If the
15199 volume continues to rise with the current rate of increase, all current
15200 newsreaders will be pretty much useless.  How do you deal with
15201 newsgroups that have thousands of new articles each day?  How do you
15202 keep track of millions of people who post?
15203
15204 Gnus offers no real solutions to these questions, but I would very much
15205 like to see Gnus being used as a testing ground for new methods of
15206 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
15207 to separate the newsreader from the backends, Gnus now offers a simple
15208 interface for anybody who wants to write new backends for fetching mail
15209 and news from different sources.  I have added hooks for customizations
15210 everywhere I could imagine it being useful.  By doing so, I'm inviting
15211 every one of you to explore and invent.
15212
15213 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
15214 @kbd{C-u 100 M-x all-hail-xemacs}.
15215
15216
15217 @node Compatibility
15218 @subsection Compatibility
15219
15220 @cindex compatibility
15221 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
15222 bindings have been kept.  More key bindings have been added, of course,
15223 but only in one or two obscure cases have old bindings been changed.
15224
15225 Our motto is:
15226 @quotation
15227 @cartouche
15228 @center In a cloud bones of steel.
15229 @end cartouche
15230 @end quotation
15231
15232 All commands have kept their names.  Some internal functions have changed
15233 their names.
15234
15235 The @code{gnus-uu} package has changed drastically. @xref{Decoding
15236 Articles}. 
15237
15238 One major compatibility question is the presence of several summary
15239 buffers.  All variables relevant while reading a group are
15240 buffer-local to the summary buffer they belong in.  Although many
15241 important variables have their values copied into their global
15242 counterparts whenever a command is executed in the summary buffer, this
15243 change might lead to incorrect values being used unless you are careful.
15244
15245 All code that relies on knowledge of @sc{gnus} internals will probably
15246 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
15247 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
15248 maintains a hash table that points to the entries in this alist (which
15249 speeds up many functions), and changing the alist directly will lead to
15250 peculiar results.
15251
15252 @cindex hilit19
15253 @cindex highlighting
15254 Old hilit19 code does not work at all.  In fact, you should probably
15255 remove all hilit code from all Gnus hooks
15256 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
15257 Gnus provides various integrated functions for highlighting.  These are
15258 faster and more accurate.  To make life easier for everybody, Gnus will
15259 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
15260 Away!
15261
15262 Packages like @code{expire-kill} will no longer work.  As a matter of
15263 fact, you should probably remove all old @sc{gnus} packages (and other
15264 code) when you start using Gnus.  More likely than not, Gnus already
15265 does what you have written code to make @sc{gnus} do.  (Snicker.)
15266
15267 Even though old methods of doing things are still supported, only the
15268 new methods are documented in this manual.  If you detect a new method of
15269 doing something while reading this manual, that does not mean you have
15270 to stop doing it the old way.
15271
15272 Gnus understands all @sc{gnus} startup files.
15273
15274 @kindex M-x gnus-bug
15275 @findex gnus-bug
15276 @cindex reporting bugs
15277 @cindex bugs
15278 Overall, a casual user who hasn't written much code that depends on
15279 @sc{gnus} internals should suffer no problems.  If problems occur,
15280 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
15281
15282
15283 @node Conformity
15284 @subsection Conformity
15285
15286 No rebels without a clue here, ma'am.  We conform to all standards known
15287 to (wo)man.  Except for those standards and/or conventions we disagree
15288 with, of course.
15289
15290 @table @strong
15291
15292 @item RFC 822
15293 @cindex RFC 822
15294 There are no known breaches of this standard.
15295
15296 @item RFC 1036
15297 @cindex RFC 1036
15298 There are no known breaches of this standard, either.
15299
15300 @item Son-of-RFC 1036
15301 @cindex Son-of-RFC 1036
15302 We do have some breaches to this one.
15303
15304 @table @emph
15305
15306 @item MIME
15307 Gnus does no MIME handling, and this standard-to-be seems to think that
15308 MIME is the bees' knees, so we have major breakage here.
15309
15310 @item X-Newsreader
15311 This is considered to be a ``vanity header'', while I consider it to be
15312 consumer information.  After seeing so many badly formatted articles
15313 coming from @code{tin} and @code{Netscape} I know not to use either of
15314 those for posting articles.  I would not have known that if it wasn't
15315 for the @code{X-Newsreader} header.
15316 @end table
15317
15318 @end table
15319
15320 If you ever notice Gnus acting non-compliant with regards to the texts
15321 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
15322 know.
15323
15324
15325 @node Emacsen
15326 @subsection Emacsen
15327 @cindex Emacsen
15328 @cindex XEmacs
15329 @cindex Mule
15330 @cindex Emacs
15331
15332 Gnus should work on :
15333
15334 @itemize @bullet 
15335
15336 @item
15337 Emacs 19.32 and up.
15338
15339 @item
15340 XEmacs 19.14 and up.
15341
15342 @item 
15343 Mule versions based on Emacs 19.32 and up.
15344
15345 @end itemize
15346
15347 Gnus will absolutely not work on any Emacsen older than that.  Not
15348 reliably, at least. 
15349
15350 There are some vague differences between Gnus on the various
15351 platforms---XEmacs features more graphics (a logo and a toolbar)---but
15352 other than that, things should look pretty much the same under all
15353 Emacsen. 
15354
15355
15356 @node Contributors
15357 @subsection Contributors
15358 @cindex contributors
15359
15360 The new Gnus version couldn't have been done without the help of all the
15361 people on the (ding) mailing list.  Every day for over a year I have
15362 gotten billions of nice bug reports from them, filling me with joy,
15363 every single one of them.  Smooches.  The people on the list have been
15364 tried beyond endurance, what with my ``oh, that's a neat idea <type
15365 type>, yup, I'll release it right away <ship off> no wait, that doesn't
15366 work at all <type type>, yup, I'll ship that one off right away <ship
15367 off> no, wait, that absolutely does not work'' policy for releases.
15368 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
15369 ``worser''? ``much worser''?  ``worsest''?)
15370
15371 I would like to take this opportunity to thank the Academy for...  oops,
15372 wrong show.
15373
15374 @itemize @bullet
15375
15376 @item 
15377 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
15378
15379 @item 
15380 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
15381 well as numerous other things).
15382
15383 @item 
15384 Luis Fernandes---design and graphics.
15385
15386 @item
15387 Erik Naggum---help, ideas, support, code and stuff.
15388
15389 @item 
15390 Wes Hardaker---@file{gnus-picon.el} and the manual section on
15391 @dfn{picons} (@pxref{Picons}).
15392
15393 @item
15394 Kim-Minh Kaplan---further work on the picon code.
15395
15396 @item 
15397 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
15398 (@pxref{GroupLens}).
15399
15400 @item 
15401 Sudish Joseph---innumerable bug fixes.
15402
15403 @item 
15404 Ilja Weis---@file{gnus-topic.el}.
15405
15406 @item 
15407 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
15408
15409 @item 
15410 Vladimir Alexiev---the refcard and reference booklets.
15411
15412 @item 
15413 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
15414 distribution by Felix Lee and JWZ.
15415
15416 @item 
15417 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
15418
15419 @item 
15420 Peter Mutsaers---orphan article scoring code.
15421
15422 @item 
15423 Ken Raeburn---POP mail support.
15424
15425 @item 
15426 Hallvard B Furuseth---various bits and pieces, especially dealing with
15427 .newsrc files.
15428
15429 @item 
15430 Brian Edmonds---@file{gnus-bbdb.el}.
15431
15432 @item
15433 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
15434
15435 @item 
15436 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
15437
15438 @item
15439 François Pinard---many, many interesting and thorough bug reports.
15440
15441 @end itemize
15442
15443 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
15444 Borges, and Jost Krieger proof-reading parts of the manual.
15445
15446 The following people have contributed many patches and suggestions: 
15447
15448 Christopher Davis,
15449 Andrew Eskilsson,
15450 Kai Grossjohann,
15451 David KÃ¥gedal,
15452 Richard Pieri,
15453 Fabrice Popineau, 
15454 Daniel Quinlan, 
15455 Jason L. Tibbitts, III,
15456 and
15457 Jack Vinson.
15458
15459 Also thanks to the following for patches and stuff:
15460
15461 Jari Aalto,
15462 Adrian Aichner,
15463 Russ Allbery,
15464 Peter Arius, 
15465 Matt Armstrong,
15466 Marc Auslander,
15467 Robert Bihlmeyer,
15468 Chris Bone,
15469 Mark Borges,
15470 Mark Boyns,
15471 Lance A. Brown,
15472 Kees de Bruin,
15473 Martin Buchholz,
15474 Kevin Buhr,
15475 Alastair Burt,
15476 Joao Cachopo,
15477 Zlatko Calusic,
15478 Massimo Campostrini,
15479 Dan Christensen,
15480 Michael R. Cook,
15481 Glenn Coombs, 
15482 Frank D. Cringle, 
15483 Geoffrey T. Dairiki,
15484 Andre Deparade,
15485 Ulrik Dickow,
15486 Dave Disser,
15487 Joev Dubach,
15488 Michael Welsh Duggan,
15489 Dave Edmondson,
15490 Paul Eggert,
15491 Enami Tsugutomo, @c Enami
15492 Michael Ernst,
15493 Luc Van Eycken,
15494 Sam Falkner,
15495 Nelson Jose dos Santos Ferreira,
15496 Sigbjorn Finne,
15497 Gary D. Foster,
15498 Paul Franklin, 
15499 Guy Geens,
15500 Arne Georg Gleditsch,
15501 David S. Goldberg,
15502 Michelangelo Grigni,
15503 D. Hall, 
15504 Magnus Hammerin,
15505 Kenichi Handa, @c Handa
15506 Raja R. Harinath,
15507 Hisashige Kenji, @c Hisashige
15508 Marc Horowitz,
15509 Gunnar Horrigmo,
15510 Richard Hoskins,
15511 Brad Howes,
15512 François Felix Ingrand,
15513 Ishikawa Ichiro, @c Ishikawa
15514 Lee Iverson, 
15515 Iwamuro Motonori, @c Iwamuro
15516 Rajappa Iyer,
15517 Andreas Jaeger,
15518 Randell Jesup,
15519 Fred Johansen, 
15520 Simon Josefsson,
15521 Greg Klanderman,
15522 Karl Kleinpaste,
15523 Peter Skov Knudsen,
15524 Shuhei Kobayashi, @c Kobayashi
15525 Thor Kristoffersen,
15526 Jens Lautenbacher,
15527 Seokchan Lee, @c Lee
15528 Carsten Leonhardt,
15529 James LewisMoss,
15530 Christian Limpach,
15531 Markus Linnala,
15532 Dave Love,
15533 Tonny Madsen,
15534 Shlomo Mahlab,
15535 Nat Makarevitch,
15536 Istvan Marko,
15537 David Martin,
15538 Gordon Matzigkeit,
15539 Timo Metzemakers,
15540 Richard Mlynarik,
15541 Lantz Moore,
15542 Morioka Tomohiko, @c Morioka
15543 Erik Toubro Nielsen,
15544 Hrvoje Niksic,
15545 Andy Norman,
15546 Fred Oberhauser,
15547 C. R. Oldham,
15548 Alexandre Oliva,
15549 Ken Olstad,
15550 Masaharu Onishi, @c Onishi
15551 Hideki Ono, @c Ono
15552 William Perry,
15553 Stephen Peters,
15554 Ulrich Pfeifer,
15555 John McClary Prevost,
15556 Colin Rafferty,
15557 Lars Balker Rasmussen,
15558 Joe Reiss,
15559 Renaud Rioboo,
15560 Roland B. Roberts,
15561 Bart Robinson,
15562 Christian von Roques,
15563 Jason Rumney,
15564 Jay Sachs,
15565 Dewey M. Sasser,
15566 Loren Schall,
15567 Dan Schmidt,
15568 Ralph Schleicher,
15569 Philippe Schnoebelen,
15570 Randal L. Schwartz,
15571 Justin Sheehy,
15572 Danny Siu, 
15573 Matt Simmons,
15574 Paul D. Smith,
15575 Jeff Sparkes,
15576 Toby Speight,
15577 Michael Sperber,
15578 Darren Stalder,
15579 Richard Stallman,
15580 Greg Stark, 
15581 Paul Stodghill,
15582 Kurt Swanson,
15583 Samuel Tardieu, 
15584 Teddy,
15585 Chuck Thompson,
15586 Philippe Troin,
15587 James Troup,
15588 Aaron M. Ucko, 
15589 Aki Vehtari,
15590 Didier Verna,
15591 Jan Vroonhof,
15592 Stefan Waldherr,
15593 Pete Ware,
15594 Barry A. Warsaw,
15595 Christoph Wedler,
15596 Joe Wells,
15597 and
15598 Katsumi Yamaoka. @c Yamaoka
15599
15600 For a full overview of what each person has done, the ChangeLogs
15601 included in the Gnus alpha distributions should give ample reading
15602 (550kB and counting).
15603
15604 Apologies to everybody that I've forgotten, of which there are many, I'm
15605 sure.  
15606
15607 Gee, that's quite a list of people.  I guess that must mean that there
15608 actually are people who are using Gnus.  Who'd'a thunk it!
15609
15610
15611 @node New Features
15612 @subsection New Features
15613 @cindex new features
15614
15615 @menu
15616 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
15617 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
15618 * Red Gnus::           Third time best---Gnus 5.4/5.5.
15619 @end menu
15620
15621 These lists are, of course, just @emph{short} overviews of the
15622 @emph{most} important new features.  No, really.  There are tons more.
15623 Yes, we have feeping creaturism in full effect.
15624
15625
15626 @node ding Gnus
15627 @subsubsection (ding) Gnus
15628
15629 New features in Gnus 5.0/5.1:
15630
15631 @itemize @bullet
15632
15633 @item
15634 The look of all buffers can be changed by setting format-like variables
15635 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
15636  
15637 @item 
15638 Local spool and several @sc{nntp} servers can be used at once
15639 (@pxref{Select Methods}).  
15640
15641 @item 
15642 You can combine groups into virtual groups (@pxref{Virtual Groups}).
15643
15644 @item 
15645 You can read a number of different mail formats (@pxref{Getting Mail}).
15646 All the mail backends implement a convenient mail expiry scheme
15647 (@pxref{Expiring Mail}). 
15648
15649 @item
15650 Gnus can use various strategies for gathering threads that have lost
15651 their roots (thereby gathering loose sub-threads into one thread) or it
15652 can go back and retrieve enough headers to build a complete thread
15653 (@pxref{Customizing Threading}).
15654
15655 @item 
15656 Killed groups can be displayed in the group buffer, and you can read
15657 them as well (@pxref{Listing Groups}).
15658
15659 @item 
15660 Gnus can do partial group updates---you do not have to retrieve the
15661 entire active file just to check for new articles in a few groups
15662 (@pxref{The Active File}).
15663
15664 @item 
15665 Gnus implements a sliding scale of subscribedness to groups
15666 (@pxref{Group Levels}).
15667
15668 @item 
15669 You can score articles according to any number of criteria
15670 (@pxref{Scoring}).  You can even get Gnus to find out how to score
15671 articles for you (@pxref{Adaptive Scoring}).
15672
15673 @item 
15674 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
15675 manner, so it should be difficult to lose much data on what you have
15676 read if your machine should go down (@pxref{Auto Save}). 
15677
15678 @item 
15679 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
15680 the @file{.emacs} file.
15681
15682 @item 
15683 You can set the process mark on both groups and articles and perform
15684 operations on all the marked items (@pxref{Process/Prefix}).
15685
15686 @item 
15687 You can grep through a subset of groups and create a group from the
15688 results (@pxref{Kibozed Groups}). 
15689
15690 @item 
15691 You can list subsets of groups according to, well, anything
15692 (@pxref{Listing Groups}). 
15693
15694 @item 
15695 You can browse foreign servers and subscribe to groups from those
15696 servers (@pxref{Browse Foreign Server}). 
15697
15698 @item 
15699 Gnus can fetch articles, asynchronously, on a second connection to the
15700 server (@pxref{Asynchronous Fetching}).
15701
15702 @item 
15703 You can cache articles locally (@pxref{Article Caching}). 
15704
15705 @item 
15706 The uudecode functions have been expanded and generalized
15707 (@pxref{Decoding Articles}). 
15708
15709 @item
15710 You can still post uuencoded articles, which was a little-known feature
15711 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
15712
15713 @item
15714 Fetching parents (and other articles) now actually works without
15715 glitches (@pxref{Finding the Parent}). 
15716
15717 @item
15718 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
15719
15720 @item
15721 Digests (and other files) can be used as the basis for groups
15722 (@pxref{Document Groups}).
15723
15724 @item 
15725 Articles can be highlighted and customized (@pxref{Customizing
15726 Articles}). 
15727
15728 @item 
15729 URLs and other external references can be buttonized (@pxref{Article
15730 Buttons}). 
15731
15732 @item
15733 You can do lots of strange stuff with the Gnus window & frame
15734 configuration (@pxref{Windows Configuration}).
15735
15736 @item
15737 You can click on buttons instead of using the keyboard
15738 (@pxref{Buttons}). 
15739
15740 @end itemize
15741
15742
15743 @node September Gnus
15744 @subsubsection September Gnus
15745
15746 @iftex
15747 @iflatex
15748 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
15749 @end iflatex
15750 @end iftex
15751
15752 New features in Gnus 5.2/5.3:
15753
15754 @itemize @bullet
15755
15756 @item
15757 A new message composition mode is used.  All old customization variables
15758 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
15759 now obsolete.
15760
15761 @item
15762 Gnus is now able to generate @dfn{sparse} threads---threads where
15763 missing articles are represented by empty nodes (@pxref{Customizing
15764 Threading}). 
15765
15766 @lisp
15767 (setq gnus-build-sparse-threads 'some)
15768 @end lisp
15769
15770 @item
15771 Outgoing articles are stored on a special archive server
15772 (@pxref{Archived Messages}). 
15773
15774 @item
15775 Partial thread regeneration now happens when articles are
15776 referred. 
15777
15778 @item
15779 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
15780
15781 @item
15782 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
15783
15784 @item
15785 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
15786
15787 @lisp
15788 (setq gnus-use-trees t)
15789 @end lisp
15790
15791 @item
15792 An @code{nn}-like pick-and-read minor mode is available for the summary
15793 buffers (@pxref{Pick and Read}).
15794
15795 @lisp
15796 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
15797 @end lisp
15798
15799 @item
15800 In binary groups you can use a special binary minor mode (@pxref{Binary
15801 Groups}). 
15802
15803 @item
15804 Groups can be grouped in a folding topic hierarchy (@pxref{Group
15805 Topics}).
15806
15807 @lisp
15808 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
15809 @end lisp
15810
15811 @item
15812 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
15813
15814 @item
15815 Groups can now have a score, and bubbling based on entry frequency
15816 is possible (@pxref{Group Score}).
15817
15818 @lisp
15819 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
15820 @end lisp
15821
15822 @item
15823 Groups can be process-marked, and commands can be performed on
15824 groups of groups (@pxref{Marking Groups}).
15825
15826 @item
15827 Caching is possible in virtual groups.
15828
15829 @item
15830 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
15831 news batches, ClariNet briefs collections, and just about everything
15832 else (@pxref{Document Groups}).
15833
15834 @item
15835 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
15836 (@pxref{SOUP}).
15837
15838 @item
15839 The Gnus cache is much faster.
15840
15841 @item
15842 Groups can be sorted according to many criteria (@pxref{Sorting
15843 Groups}).
15844
15845 @item
15846 New group parameters have been introduced to set list-addresses and
15847 expiry times (@pxref{Group Parameters}).
15848
15849 @item
15850 All formatting specs allow specifying faces to be used
15851 (@pxref{Formatting Fonts}).
15852
15853 @item
15854 There are several more commands for setting/removing/acting on process
15855 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
15856
15857 @item
15858 The summary buffer can be limited to show parts of the available
15859 articles based on a wide range of criteria.  These commands have been
15860 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
15861
15862 @item
15863 Articles can be made persistent with the @kbd{*} command
15864 (@pxref{Persistent Articles}).
15865
15866 @item
15867 All functions for hiding article elements are now toggles.
15868
15869 @item
15870 Article headers can be buttonized (@pxref{Article Washing}).
15871
15872 @lisp
15873 (add-hook 'gnus-article-display-hook 
15874           'gnus-article-add-buttons-to-head)
15875 @end lisp
15876
15877 @item
15878 All mail backends support fetching articles by @code{Message-ID}.
15879
15880 @item
15881 Duplicate mail can now be treated properly (@pxref{Duplicates}).
15882
15883 @item
15884 All summary mode commands are available directly from the article
15885 buffer (@pxref{Article Keymap}). 
15886
15887 @item
15888 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
15889 Configuration}).
15890
15891 @item
15892 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
15893 @iftex
15894 @iflatex
15895 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
15896 @end iflatex
15897 @end iftex
15898
15899 @item
15900 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
15901
15902 @lisp
15903 (setq gnus-use-nocem t)
15904 @end lisp
15905
15906 @item
15907 Groups can be made permanently visible (@pxref{Listing Groups}).
15908
15909 @lisp
15910 (setq gnus-permanently-visible-groups "^nnml:")
15911 @end lisp
15912
15913 @item
15914 Many new hooks have been introduced to make customizing easier. 
15915
15916 @item
15917 Gnus respects the @code{Mail-Copies-To} header.
15918
15919 @item
15920 Threads can be gathered by looking at the @code{References} header
15921 (@pxref{Customizing Threading}).
15922
15923 @lisp
15924 (setq gnus-summary-thread-gathering-function 
15925       'gnus-gather-threads-by-references)
15926 @end lisp
15927
15928 @item
15929 Read articles can be stored in a special backlog buffer to avoid
15930 refetching (@pxref{Article Backlog}).  
15931
15932 @lisp
15933 (setq gnus-keep-backlog 50)
15934 @end lisp
15935
15936 @item
15937 A clean copy of the current article is always stored in a separate
15938 buffer to allow easier treatment.
15939
15940 @item
15941 Gnus can suggest where to save articles (@pxref{Saving Articles}).
15942
15943 @item
15944 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
15945 Articles}). 
15946
15947 @lisp
15948 (setq gnus-prompt-before-saving t)
15949 @end lisp
15950
15951 @item
15952 @code{gnus-uu} can view decoded files asynchronously while fetching
15953 articles (@pxref{Other Decode Variables}). 
15954
15955 @lisp
15956 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
15957 @end lisp
15958
15959 @item
15960 Filling in the article buffer now works properly on cited text
15961 (@pxref{Article Washing}).
15962
15963 @item
15964 Hiding cited text adds buttons to toggle hiding, and how much
15965 cited text to hide is now customizable (@pxref{Article Hiding}).
15966
15967 @lisp
15968 (setq gnus-cited-lines-visible 2)
15969 @end lisp
15970
15971 @item
15972 Boring headers can be hidden (@pxref{Article Hiding}).
15973
15974 @lisp
15975 (add-hook 'gnus-article-display-hook 
15976           'gnus-article-hide-boring-headers t)
15977 @end lisp
15978
15979 @item
15980 Default scoring values can now be set from the menu bar.
15981
15982 @item
15983 Further syntax checking of outgoing articles have been added.
15984
15985 @end itemize
15986
15987
15988 @node Red Gnus
15989 @subsubsection Red Gnus
15990
15991 New features in Gnus 5.4/5.5:
15992
15993 @iftex
15994 @iflatex
15995 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
15996 @end iflatex
15997 @end iftex
15998
15999 @itemize @bullet
16000
16001 @item
16002 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
16003
16004 @item
16005 Article prefetching functionality has been moved up into 
16006 Gnus (@pxref{Asynchronous Fetching}).  
16007
16008 @item
16009 Scoring can now be performed with logical operators like @code{and},
16010 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16011 Scoring}).
16012
16013 @item
16014 Article washing status can be displayed in the
16015 article mode line (@pxref{Misc Article}).
16016
16017 @item
16018 @file{gnus.el} has been split into many smaller files.
16019
16020 @item
16021 Suppression of duplicate articles based on Message-ID can be done
16022 (@pxref{Duplicate Suppression}).
16023
16024 @lisp
16025 (setq gnus-suppress-duplicates t)
16026 @end lisp
16027
16028 @item
16029 New variables for specifying what score and adapt files are to be
16030 considered home score and adapt files (@pxref{Home Score File}) have
16031 been added.
16032
16033 @item
16034 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
16035 Server Internals}). 
16036
16037 @item
16038 Groups can inherit group parameters from parent topics (@pxref{Topic
16039 Parameters}).
16040
16041 @item
16042 Article editing has been revamped and is now actually usable.
16043
16044 @item
16045 Signatures can be recognized in more intelligent fashions
16046 (@pxref{Article Signature}).
16047
16048 @item
16049 Summary pick mode has been made to look more @code{nn}-like.  Line
16050 numbers are displayed and the @kbd{.} command can be used to pick
16051 articles (@code{Pick and Read}).
16052
16053 @item
16054 Commands for moving the @file{.newsrc.eld} from one server to
16055 another have been added (@pxref{Changing Servers}).
16056
16057 @item
16058 There's a way now to specify that ``uninteresting'' fields be suppressed
16059 when generating lines in buffers (@pxref{Advanced Formatting}).
16060
16061 @item
16062 Several commands in the group buffer can be undone with @kbd{M-C-_}
16063 (@pxref{Undo}).
16064
16065 @item
16066 Scoring can be done on words using the new score type @code{w}
16067 (@pxref{Score File Format}).
16068
16069 @item
16070 Adaptive scoring can be done on a Subject word-by-word basis
16071 (@pxref{Adaptive Scoring}). 
16072
16073 @lisp
16074 (setq gnus-use-adaptive-scoring '(word))
16075 @end lisp
16076
16077 @item
16078 Scores can be decayed (@pxref{Score Decays}).
16079  
16080 @lisp
16081 (setq gnus-decay-scores t)
16082 @end lisp
16083
16084 @item
16085 Scoring can be performed using a regexp on the Date header.  The Date is
16086 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
16087
16088 @item
16089 A new command has been added to remove all data on articles from
16090 the native server (@pxref{Changing Servers}).
16091
16092 @item
16093 A new command for reading collections of documents
16094 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
16095 (@pxref{Really Various Summary Commands}). 
16096
16097 @item
16098 Process mark sets can be pushed and popped (@pxref{Setting Process
16099 Marks}).
16100
16101 @item
16102 A new mail-to-news backend makes it possible to post even when the NNTP
16103 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
16104
16105 @item
16106 A new backend for reading searches from Web search engines
16107 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
16108 (@pxref{Web Searches}).
16109
16110 @item
16111 Groups inside topics can now be sorted using the standard sorting
16112 functions, and each topic can be sorted independently (@pxref{Topic
16113 Sorting}).
16114
16115 @item
16116 Subsets of the groups can be sorted independently (@code{Sorting
16117 Groups}).
16118
16119 @item
16120 Cached articles can be pulled into the groups (@pxref{Summary Generation
16121 Commands}).
16122 @iftex
16123 @iflatex
16124 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
16125 @end iflatex
16126 @end iftex
16127
16128 @item
16129 Score files are now applied in a more reliable order (@pxref{Score
16130 Variables}).
16131
16132 @item
16133 Reports on where mail messages end up can be generated (@pxref{Splitting
16134 Mail}).
16135
16136 @item
16137 More hooks and functions have been added to remove junk from incoming
16138 mail before saving the mail (@pxref{Washing Mail}).
16139
16140 @item
16141 Emphasized text can be properly fontisized:
16142
16143 @lisp
16144 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
16145 @end lisp
16146  
16147 @end itemize
16148
16149
16150 @node Newest Features
16151 @subsection Newest Features
16152 @cindex todo
16153
16154 Also known as the @dfn{todo list}.  Sure to be implemented before the
16155 next millennium. 
16156
16157 Be afraid.  Be very afraid.
16158
16159 (That a feature appears in this list doesn't necessarily mean that I've
16160 decided to actually implement it.  It just means that I think it sounds
16161 interesting.)
16162
16163 (Yes, this is the actual, up-to-the-second todo list.)
16164
16165 @itemize @bullet
16166
16167 @item
16168 Native @sc{mime} support is something that should be done.  
16169
16170 @item
16171 Really do unbinhexing.
16172
16173 @item
16174  I would like the zombie-page to contain an URL to the source of the
16175 latest version of gnus or some explanation on where to find it.
16176
16177 @item
16178  A way to continue editing the latest Message composition.
16179
16180 @item
16181  http://www.sonicnet.com/feature/ari3/
16182
16183 @item
16184  facep is not declared.
16185
16186 @item
16187  Include a section in the manual on why the number of articles
16188 isn't the same in the group buffer and on the SPC prompt.
16189
16190 @item
16191  Interacting with rmail fcc isn't easy.
16192
16193 @item
16194 @example
16195  Hypermail:
16196 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
16197 <URL:http://www.eit.com/software/hypermail/hypermail.html>
16198 <URL:http://homer.ncm.com/>
16199 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
16200 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
16201 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
16202 http://www.miranova.com/gnus-list/
16203
16204 @end example
16205
16206 @item
16207 @samp{^-- } is made into - in LaTeX.
16208
16209 @item
16210  gnus-kill is much slower than it was in GNUS 4.1.3.
16211
16212 @item
16213  when expunging articles on low score, the sparse nodes keep hanging on?
16214 @item
16215  starting the first time seems to hang Gnus on some systems.  Does
16216 NEWGROUPS answer too fast?
16217 @item
16218  nndir doesn't read gzipped files.
16219 @item
16220  FAQ doesn't have an up node?
16221 @item
16222  when moving mail from a procmail spool to the crash-box,
16223 the crash-box is only appropriate to one specific group.
16224 @item
16225  `t' `t' makes X-Faces disappear.
16226 @item
16227  nnmh-be-safe means that crossposted articles will
16228 be marked as unread.
16229 @item
16230  Orphan score entries dont show on "V t" score trace
16231 @item
16232  when clearing out data, the cache data should also be reset.
16233 @item
16234  rewrite gnus-summary-limit-children to be non-recursive
16235 to avoid exceeding lisp nesting on huge groups.
16236 @item
16237  expinged articles are counted when computing scores.
16238 @item
16239  implement gnus-batch-brew-soup
16240 @item
16241  ticked articles aren't easy to read in pick mode -- `n' and
16242 stuff just skips past them.  Read articles are the same.
16243 @item
16244  topics that contain just groups with ticked
16245 articles aren't displayed.
16246 @item
16247  nndoc should always allocate unique Message-IDs.
16248 @item
16249  implement gnus-score-thread
16250 @item
16251  If there are mail groups the first time you use Gnus, Gnus'll
16252 make the mail groups killed. 
16253 @item
16254  no "no news is good news" when using topics.
16255 @item
16256  when doing crosspost marking, the cache has to be consulted
16257 and articles have to be removed.
16258 @item
16259  nnweb should fetch complete articles when they are split into several
16260 parts.
16261 @item
16262  scoring on head immediate doesn't work.
16263 @item
16264  finding short score file names takes forever.
16265 @item
16266  canceling articles in foreign groups.
16267 @item
16268  nntp-open-rlogin no longer works.
16269 @item
16270  C-u C-x C-s (Summary) switches to the group buffer.
16271 @item
16272  move nnmail-split-history out to the backends.
16273 @item
16274  nnweb doesn't work properly.
16275 @item
16276  using a virtual server name as `gnus-select-method' doesn't work?
16277 @item
16278  when killing/yanking a group from one topic to another in a slave, the 
16279 master will yank it first to one topic and then add it to another.  
16280 Perhaps.
16281
16282 @item
16283  warn user about `=' redirection of a group in the active file?
16284 @item
16285  really unbinhex binhex files.
16286 @item
16287  take over the XEmacs menubar and offer a toggle between the XEmacs
16288 bar and the Gnus bar.
16289 @item
16290 @example
16291  push active file and NOV file parsing down into C code.
16292 `(canonize-message-id id)'
16293 `(mail-parent-message-id references n)'
16294 `(parse-news-nov-line &optional dependency-hashtb)'
16295 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
16296 `(parse-news-active-region beg end hashtb)'
16297
16298 @end example
16299
16300 @item
16301  nnml .overview directory with splits.
16302 @item
16303  asynchronous cache
16304 @item
16305  postponed commands.
16306 @item
16307  the selected article show have its Subject displayed in its summary line.
16308 @item
16309  when entering groups, get the real number of unread articles from
16310 the server?  
16311 @item
16312  sort after gathering threads -- make false roots have the
16313 headers of the oldest orhpan with a 0 article number?
16314 @item
16315  nndoc groups should inherit the score files of their parents?  Also
16316 inherit copy prompts and save files.
16317 @item
16318  command to start up Gnus (if not running) and enter a mail mode buffer.
16319 @item
16320  allow editing the group description from the group buffer
16321 for backends that support that.
16322 @item
16323 gnus-hide,show-all-topics
16324 @item
16325  groups and sub-topics should be allowed to mingle inside each topic,
16326 and not just list all subtopics at the end.
16327 @item
16328  a command to remove all read articles that are not needed to connect
16329 threads -- `gnus-summary-limit-to-sparse-unread'?
16330 @item
16331  a variable to turn off limiting/cutting of threads in the tree buffer.
16332 @item
16333  a variable to limit how many files are uudecoded.
16334 @item
16335  add zombie groups to a special "New Groups" topic.
16336 @item
16337  server mode command: close/open all connections
16338 @item
16339  put a file date in gnus-score-alist and check whether the file
16340 has been changed before using it.
16341 @item
16342  on exit from a digest group, go to the next article in the parent group.
16343 @item
16344  hide (sub)threads with low score.
16345 @item
16346  when expiring, remove all marks from expired articles.
16347 @item
16348  gnus-summary-limit-to-body
16349 @item
16350  a regexp alist that says what level groups are to be subscribed
16351 on.  Eg. -- `(("nnml:" . 1))'.
16352 @item
16353  easier interface to nnkiboze to create ephemeral groups that
16354 contaion groups that match a regexp.
16355 @item
16356  allow newlines in <URL:> urls, but remove them before using
16357 the URL.
16358 @item
16359  If there is no From line, the mail backends should fudge one from the
16360 "From " line.
16361 @item
16362  fuzzy simplifying should strip all non-alpha-numerical info
16363 from subject lines.
16364 @item
16365  gnus-soup-brew-soup-with-high-scores.
16366 @item
16367  nntp-ping-before-connect
16368 @item
16369  command to check whether NOV is evil.  "list overview.fmt".
16370 @item
16371  when entering a group, Gnus should look through the score
16372 files very early for `local' atoms and set those local variables.
16373 @item
16374  message annotations.
16375 @item
16376  topics are always yanked before groups, and that's not good.
16377 @item
16378  (set-extent-property extent 'help-echo "String to display in minibuf")
16379 to display help in the minibuffer on buttons under XEmacs.
16380 @item
16381  allow group line format spec to say how many articles there
16382 are in the cache.
16383 @item
16384  AUTHINFO GENERIC
16385 @item
16386  support qmail maildir spools
16387 @item
16388  `run-with-idle-timer' in gnus-demon.
16389 @item
16390  stop using invisible text properties and start using overlays instead
16391 @item
16392  C-c C-f C-e to add an Expires header.
16393 @item
16394  go from one group to the next; everything is expunged; go to the
16395 next group instead of going to the group buffer.
16396 @item
16397  gnus-renumber-cache -- to renumber the cache using "low" numbers.
16398 @item
16399  record topic changes in the dribble buffer.
16400 @item
16401  `nnfolder-generate-active-file' should look at the folders it
16402 finds and generate proper active ranges.
16403 @item
16404  nneething-look-in-files-for-article-heads variable to control
16405 whether nneething should sniff all files in the directories.
16406 @item
16407  gnus-fetch-article -- start Gnus, enter group, display article
16408 @item
16409  gnus-dont-move-articles-to-same-group variable when respooling.
16410 @item
16411  when messages are crossposted between several auto-expirable groups, 
16412 articles aren't properly marked as expirable.
16413 @item
16414  nneething should allow deletion/moving.
16415 @item
16416  TAB on the last button should go to the first button.
16417 @item
16418  if the car of an element in `mail-split-methods' is a function,
16419 and the function returns non-nil, use that as the name of the group(s) to 
16420 save mail in.
16421 @item
16422  command for listing all score files that have been applied.
16423 @item
16424  a command in the article buffer to return to `summary' config.
16425 @item
16426  `gnus-always-post-using-current-server' -- variable to override
16427 `C-c C-c' when posting.
16428 @item
16429  nnmail-group-spool-alist -- says where each group should use
16430 as a spool file.
16431 @item
16432  when an article is crossposted to an auto-expirable group, the article 
16433 should be marker as expirable.
16434 @item
16435  article mode command/menu for "send region as URL to browser".
16436 @item
16437  on errors, jump to info nodes that explain the error.  For instance,
16438 on invalid From headers, or on error messages from the nntp server.
16439 @item
16440  when gathering threads, make the article that has no "Re: " the parent.
16441 Also consult Date headers.
16442 @item
16443  a token in splits to call shrink-window-if-larger-than-buffer
16444 @item
16445  `1 0 A M' to do matches on the active hashtb.
16446 @item
16447  duplicates -- command to remove Gnus-Warning header, use the read 
16448 Message-ID, delete the "original".
16449 @item
16450  when replying to several messages at once, put the "other" message-ids
16451 into a See-Also header.
16452 @item
16453  support setext: URL:http://www.bsdi.com/setext/
16454 @item
16455  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
16456 @item
16457  when browsing a foreign server, the groups that are already subscribed
16458 should be listed as such and not as "K".
16459 @item
16460  generate font names dynamically.
16461 @item
16462  score file mode auto-alist.
16463 @item
16464  allow nndoc to change/add/delete things from documents.  Implement
16465 methods for each format for adding an article to the document.
16466 @item
16467  `gnus-fetch-old-headers' `all' value to incorporate
16468 absolutely all headers there is.
16469 @item
16470  function like `|', but concatenate all marked articles
16471 and pipe them to the process.
16472 @item
16473  cache the list of killed (or active) groups in a separate file.  Update
16474 the file whenever we read the active file or the list
16475 of killed groups in the .eld file reaches a certain length.
16476 @item
16477  function for starting to edit a file to put into 
16478 the current mail group.
16479 @item
16480  score-find-trace should display the total score of the article. 
16481 @item
16482  "ghettozie" -- score on Xref header and nix it out after using it 
16483 to avoid marking as read in other groups it has been crossposted to.
16484 @item
16485  look at procmail splitting.  The backends should create
16486 the groups automatically if a spool file exists for that group.
16487 @item
16488  function for backends to register themselves with Gnus.
16489 @item
16490  when replying to several process-marked articles, 
16491 have all the From end up in Cc headers?  Variable to toggle.
16492 @item
16493  command to delete a crossposted mail article from all 
16494 groups it has been mailed to.
16495 @item
16496  `B c' and `B m' should be crosspost aware.  
16497 @item
16498  hide-pgp should also hide PGP public key blocks.
16499 @item
16500  Command in the group buffer to respoll process-marked groups.
16501 @item
16502  `gnus-summary-find-matching' should accept
16503 pseudo-"headers" like "body", "head" and "all"
16504 @item
16505  When buttifying <URL: > things, all white space (including
16506 newlines) should be ignored.
16507 @item
16508  Process-marking all groups in a topic should process-mark
16509 groups in subtopics as well.
16510 @item
16511  Add non-native groups to the list of killed groups when killing them. 
16512 @item
16513  nntp-suggest-kewl-config to probe the nntp server and suggest
16514 variable settings.
16515 @item
16516  add edit and forward secondary marks.
16517 @item
16518  nnml shouldn't visit its .overview files.
16519 @item
16520  allow customizing sorting within gathered threads.
16521 @item
16522  `B q' shouldn't select the current article.
16523 @item
16524  nnmbox should support a newsgroups file for descriptions.
16525 @item
16526  allow fetching mail from several pop servers.
16527 @item
16528  Be able to specify whether the saving commands save the original
16529 or the formatted article.
16530 @item
16531  a command to reparent with the child process-marked (cf. `T ^'.).
16532 @item
16533  I think the possibility to send a password with nntp-open-rlogin
16534 should be a feature in Red Gnus.
16535 @item
16536  The `Z n' command should be possible to execute from a mouse click.
16537 @item
16538  more limiting functions -- date, etc.
16539 @item
16540  be able to limit on a random header; on body; using reverse matches.
16541 @item
16542  a group parameter (`absofucking-total-expiry') that will make Gnus expire
16543 even unread articles.
16544 @item
16545  a command to print the article buffer as postscript.
16546 @item
16547  variable to disable password fetching when opening by nntp-open-telnet.
16548 @item
16549  manual: more example servers -- nntp with rlogin, telnet
16550 @item
16551  checking for bogus groups should clean topic alists as well.
16552 @item
16553  cancelling articles in foreign groups.
16554 @item
16555  article number in folded topics isn't properly updated by
16556 Xref handling.
16557 @item
16558  Movement in the group buffer to the next unread group should go to the
16559 next closed topic with unread messages if no group can be found.
16560 @item
16561  Extensive info pages generated on the fly with help everywhere --
16562 in the "*Gnus edit*" buffers, for instance.
16563 @item
16564  Topic movement commands -- like thread movement.  Up, down, forward, next.
16565 @item
16566  a way to tick/mark as read Gcc'd articles.
16567 @item
16568  a way to say that all groups within a specific topic comes
16569 from a particular server?  Hm.
16570 @item
16571  `gnus-article-fill-if-long-lines' -- a function to fill
16572 the article buffer if there are any looong lines there.
16573 @item
16574  `T h' should jump to the parent topic and fold it.
16575 @item
16576  a command to create an ephemeral nndoc group out of a file,
16577 and then splitting it/moving it to some other group/backend.
16578 @item
16579  a group parameter for nnkiboze groups that says that
16580 all kibozed articles should be entered into the cache.
16581 @item
16582  It should also probably be possible to delimit what
16583 `gnus-jog-cache' does -- for instance, work on just some groups, or on
16584 some levels, and entering just articles that have a score higher than
16585 a certain number.
16586 @item
16587  nnfolder should append to the folder instead of re-writing
16588 the entire folder to disk when accepting new messages.
16589 @item
16590  allow all backends to do the proper thing with .gz files.
16591 @item
16592  a backend for reading collections of babyl files nnbabylfolder?
16593 @item
16594  a command for making the native groups into foreign groups. 
16595 @item
16596  server mode command for clearing read marks from all groups
16597 from a server.
16598 @item
16599  when following up mulitple articles, include all To, Cc, etc headers
16600 from all articles.
16601 @item
16602  a command for deciding what the total score of the current
16603 thread is.  Also a way to highlight based on this.
16604 @item
16605  command to show and edit group scores
16606 @item
16607  a gnus-tree-minimize-horizontal to minimize tree buffers
16608 horizontally.
16609 @item
16610  command to generate nnml overview file for one group.
16611 @item
16612  `C-u C-u a' -- prompt for many crossposted groups.
16613 @item
16614  keep track of which mail groups have received new articles (in this session).
16615 Be able to generate a report and perhaps do some marking in the group
16616 buffer.
16617 @item
16618  gnus-build-sparse-threads to a number -- build only sparse threads
16619 that are of that length.
16620 @item
16621  have nnmh respect mh's unseen sequence in .mh_profile.
16622 @item
16623  cache the newsgroups descriptions locally.
16624 @item
16625  asynchronous posting under nntp.
16626 @item
16627  be able to control word adaptive scoring from the score files.
16628 @item
16629  a variable to make `C-c C-c' post using the "current" select method. 
16630 @item
16631  `limit-exclude-low-scored-articles'.
16632 @item
16633  if `gnus-summary-show-thread' is a number, hide threads that have
16634 a score lower than this number.
16635 @item
16636  split newsgroup subscription variable up into "order" and "method".
16637 @item
16638  buttonize ange-ftp file names.
16639 @item
16640  a command to make a duplicate copy of the current article
16641 so that each copy can be edited separately.
16642 @item
16643  nnweb should allow fetching from the local nntp server.
16644 @item
16645  record the sorting done in the summary buffer so that
16646 it can be repeated when limiting/regenerating the buffer.
16647 @item
16648  nnml-generate-nov-databses should generate for
16649 all nnml servers.
16650 @item
16651  when the user does commands in the group buffer, check
16652 the modification time of the .newsrc.eld file and use
16653 ask-user-about-supersession-threat.  Also warn when trying
16654 to save .newsrc.eld and it has changed.
16655 @item
16656  M-g on a topic will display all groups with 0 articles in
16657 the topic.
16658 @item
16659  command to remove all topic stuff.
16660 @item
16661  allow exploding incoming digests when reading incoming mail
16662 and splitting the resulting digests.
16663 @item
16664  nnsoup shouldn't set the `message-' variables.
16665 @item
16666  command to nix out all nnoo state information.
16667 @item
16668  nnmail-process-alist that calls functions if group names 
16669 matches an alist -- before saving.
16670 @item
16671  use buffer-invisibility-spec everywhere for hiding text.
16672 @item
16673  variable to activate each group before entering them
16674 to get the (new) number of articles.  `gnus-activate-before-entering'.
16675 @item
16676  command to fetch a Message-ID from any buffer, even
16677 starting Gnus first if necessary.
16678 @item
16679  when posting and checking whether a group exists or not, just 
16680 ask the nntp server instead of relying on the active hashtb.
16681 @item
16682  buttonize the output of `C-c C-a' in an apropos-like way.
16683 @item
16684  `G p' should understand process/prefix, and allow editing
16685 of several groups at once.
16686 @item
16687  command to create an ephemeral nnvirtual group that
16688 matches some regexp(s).
16689 @item
16690  nndoc should understand "Content-Type: message/rfc822" forwarded messages. 
16691 @item
16692  it should be possible to score "thread" on the From header.
16693 @item
16694  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
16695 @item
16696  `B i' should display the article at once in the summary buffer.
16697 @item
16698  remove the "*" mark at once when unticking an article.
16699 @item
16700  `M-s' should highlight the matching text.
16701 @item
16702  when checking for duplicated mails, use Resent-Message-ID if present.
16703 @item
16704  killing and yanking groups in topics should be better.  If killing one copy
16705 of a group that exists in multiple topics, only that copy should
16706 be removed.  Yanking should insert the copy, and yanking topics
16707 should be possible to be interspersed with the other yankings.
16708 @item
16709  command for enter a group just to read the cached articles.  A way to say
16710 "ignore the nntp connection; just read from the cache."
16711 @item
16712  `X u' should decode base64 articles.
16713 @item
16714  a way to hide all "inner" cited text, leaving just the most
16715 recently cited text.
16716 @item
16717  nnvirtual should be asynchronous.
16718 @item
16719  after editing an article, gnus-original-article-buffer should
16720 be invalidated.
16721 @item
16722  there should probably be a way to make Gnus not connect to the
16723 server and just read the articles in the server
16724 @item
16725  allow a `set-default' (or something) to change the default
16726 value of nnoo variables.
16727 @item
16728  a command to import group infos from a .newsrc.eld file.
16729 @item
16730  groups from secondary servers have the entire select method
16731 listed in each group info.
16732 @item
16733  a command for just switching from the summary buffer to the group
16734 buffer.
16735 @item
16736  a way to specify that some incoming mail washing functions
16737 should only be applied to some groups.
16738 @item
16739  Message `C-f C-t' should ask the user whether to heed
16740 mail-copies-to: never.
16741 @item
16742  new group parameter -- `post-to-server' that says to post
16743 using the current server.  Also a variable to do the same.
16744 @item
16745  the slave dribble files should autosave to the slave file names.
16746 @item
16747  a group parameter that says what articles to display on group entry, based
16748 on article marks.
16749 @item
16750  a way to visually distinguish slave Gnusae from masters.  (Whip instead
16751 of normal logo?)
16752 @item
16753  Use DJ Bernstein "From " quoting/dequoting, where appliccable.
16754 @item
16755  Why is hide-citation-maybe and hide-citation different?  Also
16756 clear up info.
16757 @item
16758  group user-defined meta-parameters.
16759
16760
16761
16762 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
16763 @item
16764  I like the option for trying to retrieve the FAQ for a group and I was
16765 thinking it would be great if for those newsgroups that had archives
16766 you could also try to read the archive for that group.  Part of the
16767 problem is that archives are spread all over the net, unlike FAQs.
16768 What would be best I suppose is to find the one closest to your site.
16769
16770 In any case, there is a list of general news group archives at
16771 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
16772
16773
16774
16775
16776 @item
16777 @example
16778 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
16779 (add-hook 'gnus-select-group-hook
16780   (lambda ()
16781     (gnus-group-add-parameter group
16782        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
16783
16784 (defun gnus-user-format-function-d (headers)
16785   "Return the date the group was last read."
16786   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
16787       (t "")))
16788 @end example
16789
16790 @item
16791  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
16792 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
16793 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
16794 hatt forskjellige serveres startup-filer forskjellige steder.
16795
16796
16797 @item
16798 LMI> Well, nnbabyl could alter the group info to heed labels like
16799 LMI> answered and read, I guess.  
16800
16801 It could also keep them updated (the same for the Status: header of
16802 unix mbox files).
16803
16804 They could be used like this:
16805
16806
16807 @example
16808 `M l <name> RET' add label <name> to current message.
16809 `M u <name> RET' remove label <name> from current message.
16810 `/ l <expr> RET' limit summary buffer according to <expr>.
16811
16812 <expr> would be a boolean expression on the labels, e.g. 
16813
16814         `/ l bug & !fixed RET'
16815 @end example
16816
16817 would show all the messages which are labeled `bug' but not labeled
16818 `fixed'. 
16819
16820 One could also immagine the labels being used for highliting, or
16821 affect the summary line format.
16822
16823
16824 @item
16825 Sender: abraham@@dina.kvl.dk
16826
16827 I'd like a gnus-find-file which work like find file, except that it
16828 would recognize things that looks like messages or folders:
16829
16830 - If it is a directory containing numbered files, create an nndir
16831 summary buffer.
16832
16833 - For other directories, create a nneething summaru buffer.
16834
16835 - For files matching "\\`From ", create a nndoc/mbox summary.
16836
16837 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
16838
16839 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
16840
16841 - For other files, just find them normally.
16842
16843 I'd like `nneething' to use this function, so it would work on a
16844 directory potentially containing mboxes or babyl files.
16845
16846 @item
16847 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
16848 tell him what you are doing.
16849
16850 @item
16851 Currently, I get prompted:
16852
16853 decend into sci?
16854 - type y
16855 decend into sci.something ?
16856 - type n
16857 decend into ucd?
16858
16859 The problem above is that since there is really only one subsection of
16860 science, shouldn't it prompt you for only decending sci.something?  If
16861 there was a sci.somethingelse group or section, then it should prompt
16862 for sci? first the sci.something? then sci.somethingelse?...
16863
16864 @item
16865 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
16866 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
16867 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
16868 "no.all.SCORE", osv.
16869
16870 @item
16871 What i want is for Gnus to treat any sequence or combination of the following
16872 as a single spoiler warning and hide it all, replacing it with a "Next Page"
16873 button:
16874  
16875
16876         ^L's
16877
16878         more than n blank lines
16879         
16880         more than m identical lines 
16881         (which should be replaced with button to show them)
16882
16883         any whitespace surrounding any of the above
16884
16885
16886 @item
16887 Well, we could allow a new value to `gnus-thread-ignore-subject' --
16888 `spaces', or something.  (We could even default to that.)  And then
16889 subjects that differ in white space only could be considered the
16890 "same" subject for threading purposes. 
16891
16892 @item
16893 Modes to preprocess the contents (e.g. jka-compr) use the second form
16894 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
16895 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
16896 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
16897
16898 @item
16899  Under XEmacs -- do funny article marks:
16900 tick - thumb tack
16901 killed - skull
16902 soup - bowl of soup
16903 score below - dim light bulb
16904 score over - bright light bulb
16905
16906 @item
16907 Yes. I think the algorithm is as follows:
16908
16909 @example
16910 Group-mode
16911
16912    show-list-of-articles-in-group
16913         if (key-pressed == SPACE) 
16914                 if (no-more-articles-in-group-to-select) 
16915                         if (articles-selected)
16916                                 start-reading-selected-articles;
16917                         junk-unread-articles;
16918                         next-group;
16919                  else 
16920                         show-next-page;
16921                 
16922          else if (key-pressed = '.') 
16923                 if (consolidated-menus)         # same as hide-thread in Gnus
16924                         select-thread-under-cursor;
16925                 else
16926                         select-article-under-cursor;
16927         
16928
16929 Article-mode
16930         if (key-pressed == SPACE) 
16931                 if (more-pages-in-article)
16932                         next-page;
16933                 else if (more-selected-articles-to-read)
16934                         next-article;
16935                 else 
16936                         next-group;
16937 @end example
16938
16939 @item
16940 My precise need here would have been to limit files to Incoming*.
16941 One could think of some `nneething-only-files' variable, but I guess
16942 it would have been unacceptable if one was using many unrelated such
16943 nneething groups.
16944
16945 A more useful approach would be to, in response to the `G D' prompt, be
16946 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
16947 the top-level directory only (in case directories would be matched by
16948 the wildcard expression).
16949
16950 @item
16951 It would be nice if it also handled 
16952
16953         <URL:news://sunsite.auc.dk/>
16954
16955 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
16956
16957
16958 @item
16959
16960   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
16961 really well.  Each menu is 'named' by a symbol that would be on a
16962 gnus-*-menus (where * would be whatever, but at least group, summary, and
16963 article versions) variable.
16964
16965   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
16966
16967   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
16968 the main menubar.  This approach works really well for Emacs-W3 and VM.
16969
16970
16971 @item
16972  nndoc should take care to create unique Message-IDs for all its
16973 articles.
16974 @item
16975  gnus-score-followup-article only works when you have a summary buffer
16976 active.  Make it work when posting from the group buffer as well.
16977 (message-sent-hook).
16978 @item
16979  rewrite gnus-demon to use run-with-idle-timers.
16980
16981 @item
16982  * Enhancements to Gnus:
16983
16984   Add two commands:
16985
16986   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
16987     straight to the server buffer, without opening any connections to
16988     servers first.
16989
16990   * gnus-server-read-server-newsrc--produces a buffer very similar to
16991     the group buffer, but with only groups from that server listed;
16992     quitting this buffer returns to the server buffer.
16993
16994 @item
16995  add a command to check the integrity of an nnfolder folder --
16996 go through the article numbers and see that there are no duplicates,
16997 and stuff.
16998
16999 @item
17000  `unsmileyfy-buffer' to undo smileification.
17001
17002 @item
17003  a command to give all relevant info on an article, including all
17004 secondary marks.
17005
17006 @item
17007  when doing `-request-accept-article', the backends should do
17008 the nnmail duplicate checking.
17009
17010 @item
17011  allow `message-signature-file' to be a function to return the
17012 value of the signature file.
17013
17014 @item
17015  In addition, I would love it if I could configure message-tab so that it
17016 could call `bbdb-complete-name' in other headers.  So, some sort of
17017 interface like
17018
17019 (setq message-tab-alist
17020       '((message-header-regexp message-expand-group)
17021         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
17022
17023 then you could run the relevant function to complete the information in
17024 the header
17025
17026 @item
17027  cache the newsgroups file locally to avoid reloading it all the time.
17028
17029 @item
17030  a command to import a buffer into a group.
17031
17032 @item
17033  nnweb should allow fetching by Message-ID from servers.
17034
17035 @item
17036  point in the article buffer doesn't always go to the
17037 beginning of the buffer when selecting new articles.
17038
17039 @item
17040  a command to process mark all unread articles.
17041
17042 @item
17043  `gnus-gather-threads-by-references-and-subject' -- first
17044 do gathering by references, and then go through the dummy roots and
17045 do more gathering by subject.
17046
17047 @item
17048  gnus-uu-mark-in-numerical-order -- process mark articles in
17049 article numerical order.
17050
17051 @item
17052  (gnus-thread-total-score
17053  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
17054 bind to a key.
17055
17056 @item
17057  sorting by score is wrong when using sparse threads.
17058
17059 @item
17060  a command to fetch an arbitrary article -- without having to be
17061 in the summary buffer.
17062
17063 @item
17064  a new nncvs backend.  Each group would show an article, using
17065 version branches as threading, checkin date as the date, etc.
17066
17067 @item
17068  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
17069 This filter allows one to construct advance queries on the Dejanews
17070 database such as specifying start and end dates, subject, author,
17071 and/or newsgroup name.
17072
17073 @item
17074  new Date header scoring type -- older, newer
17075
17076 @item
17077  use the summary toolbar in the article buffer.
17078
17079 @item
17080  a command to fetch all articles that are less than X days old.
17081
17082 @item
17083  in pick mode, `q' should save the list of selected articles in the
17084 group info.  The next time the group is selected, these articles
17085 will automatically get the process mark.
17086
17087 @item
17088  Isn't it possible to (also?) allow M-^ to automatically try the
17089 default server if it fails on the current server?  (controlled by a
17090 user variable, (nil, t, 'ask)).
17091
17092 @item
17093  make it possible to cancel articles using the select method for the
17094 current group.
17095
17096 @item
17097  `gnus-summary-select-article-on-entry' or something.  It'll default
17098 to t and will select whatever article decided by `gnus-auto-select-first'.
17099
17100 @item
17101  a new variable to control which selection commands should be unselecting.
17102 `first', `best', `next', `prev', `next-unread', `prev-unread' are
17103 candidates.
17104
17105 @item
17106  be able to select groups that have no articles in them
17107 to be able to post in them (using the current select method).
17108
17109 @item
17110  be able to post via DejaNews.
17111
17112 @item
17113  `x' should retain any sortings that have been performed.
17114
17115 @item
17116  allow the user to specify the presedence of the secondary marks.  Also
17117 allow them to be displayed separately.
17118
17119 @item
17120  gnus-summary-save-in-pipe should concatenate the results from
17121 the processes when doing a process marked pipe.
17122
17123 @item
17124  a new match type, like Followup, but which adds Thread matches on all
17125 articles that match a certain From header.
17126
17127 @item
17128  a function that can be read from kill-emacs-query-functions to offer
17129 saving living summary buffers.
17130
17131 @item
17132  a function for selecting a particular group which will contain
17133 the articles listed in a list of article numbers/id's.
17134
17135 @item
17136  a battery of character translation functions to translate common
17137 Mac, MS (etc) characters into ISO 8859-1.
17138
17139 @example
17140 (defun article-fix-m$word ()
17141   "Fix M$Word smartquotes in an article."
17142   (interactive)
17143   (save-excursion
17144     (let ((buffer-read-only nil))
17145       (goto-char (point-min))
17146       (while (search-forward "\221" nil t)
17147         (replace-match "`" t t))
17148       (goto-char (point-min))
17149       (while (search-forward "\222" nil t)
17150         (replace-match "'" t t))
17151       (goto-char (point-min))
17152       (while (search-forward "\223" nil t)
17153         (replace-match "\"" t t))
17154       (goto-char (point-min))
17155       (while (search-forward "\224" nil t)
17156         (replace-match "\"" t t)))))
17157 @end example
17158
17159 @item
17160 @example
17161  (add-hook 'gnus-exit-query-functions
17162 '(lambda ()
17163    (if (and (file-exists-p nnmail-spool-file)
17164             (> (nnheader-file-size nnmail-spool-file) 0))
17165        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
17166        (y-or-n-p "Are you sure you want to quit Gnus? "))))
17167 @end example
17168
17169 @item
17170  allow message-default-headers to be a function.
17171
17172 @item
17173  new Date score match types -- < > = (etc) that take floating point
17174 numbers and match on the age of the article.
17175
17176 @item
17177  gnus-cacheable-groups
17178
17179 @item
17180 @example
17181 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
17182 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
17183 >  > > buffer in the frame that it was called from =:-O
17184
17185 >  > Hm.  How do you start up Gnus?  From the toolbar or with
17186 >  > `M-x gnus-other-frame'?  
17187
17188 >    I normally start it up from the toolbar; at
17189 > least that's the way I've caught it doing the
17190 > deed before.
17191 @end example
17192
17193 @item
17194  all commands that react to the process mark should push
17195 the current process mark set onto the stack.
17196
17197 @item
17198  gnus-article-hide-pgp
17199 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
17200 @example
17201 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
17202 @end example
17203 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
17204 er min type heuristikk og langt fra alles.
17205
17206 @item
17207  `gnus-subscribe-sorted' -- insert new groups where they would have been
17208 sorted to if `gnus-group-sort-function' were run.
17209
17210 @item
17211  gnus-(group,summary)-highlight should respect any `face' text props set
17212 on the lines.
17213
17214 @item
17215  use run-with-idle-timer for gnus-demon instead of the
17216 home-brewed stuff for better reliability.
17217
17218 @item
17219  add a way to select which NoCeM type to apply -- spam, troll, etc.
17220
17221 @item
17222  nndraft-request-group should tally autosave files.
17223
17224 @item
17225  implement nntp-retry-on-break and nntp-command-timeout.
17226
17227 @item
17228  gnus-article-highlight-limit that says when not to highlight (long)
17229 articles.
17230
17231 @item
17232  (nnoo-set SERVER VARIABLE VALUE)
17233
17234 @item
17235  nn*-spool-methods
17236
17237 @item
17238  interrupitng agent fetching of articles should save articles.
17239
17240 @item
17241  command to open a digest group, and copy all the articles there to the
17242 current group.
17243
17244 @item
17245  a variable to disable article body highlights if there's more than
17246 X characters in the body.
17247
17248 @item
17249  handle 480/381 authinfo requests separately.
17250
17251 @item
17252  include the texi/dir file in the distribution.
17253
17254 @item
17255  format spec to "tab" to a position.
17256
17257 @item
17258  Move all prompting to the new `M-n' default style.
17259
17260 @item
17261  command to display all dormant articles.
17262
17263 @item
17264  gnus-auto-select-next makeover -- list of things it should do.
17265
17266 @item
17267  a score match type that adds scores matching on From if From has replied
17268 to something someone else has said.
17269
17270 @item
17271  Read Netscape discussion groups:
17272 snews://secnews.netscape.com/netscape.communicator.unix 
17273
17274 @item
17275 One command to edit the original version if an article, and one to edit
17276 the displayed version.
17277
17278 @item
17279 @kbd{T v} -- make all process-marked articles the children of the
17280 current article.
17281
17282 @item
17283 Switch from initial text to the new default text mechanism.
17284
17285 @item
17286 How about making it possible to expire local articles?  Will it be
17287 possible to make various constraints on when an article can be
17288 expired, e.g. (read), (age > 14 days), or the more interesting (read
17289 & age > 14 days)?
17290
17291 @item
17292 New limit command---limit to articles that have a certain string
17293 in the head or body.
17294
17295 @item
17296 Allow breaking lengthy NNTP commands.
17297
17298 @item
17299 gnus-article-highlight-limit, to disable highlighting in big articles. 
17300
17301 @item
17302 Editing an article should put the article to be edited
17303 in a special, unique buffer.
17304
17305 @item
17306 Solve the halting problem.
17307
17308 @c TODO
17309 @end itemize
17310
17311 @iftex
17312
17313 @page
17314 @node The Manual
17315 @section The Manual
17316 @cindex colophon
17317 @cindex manual
17318
17319 This manual was generated from a TeXinfo file and then run through
17320 either @code{texi2dvi}
17321 @iflatex
17322 or my own home-brewed TeXinfo to \LaTeX\ transformer,
17323 and then run through @code{latex} and @code{dvips} 
17324 @end iflatex
17325 to get what you hold in your hands now.
17326
17327 The following conventions have been used:
17328
17329 @enumerate
17330
17331 @item
17332 This is a @samp{string}
17333
17334 @item
17335 This is a @kbd{keystroke}
17336
17337 @item
17338 This is a @file{file}
17339
17340 @item 
17341 This is a @code{symbol}
17342
17343 @end enumerate
17344
17345 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
17346 mean:
17347
17348 @lisp
17349 (setq flargnoze "yes")
17350 @end lisp
17351
17352 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
17353
17354 @lisp
17355 (setq flumphel 'yes)
17356 @end lisp
17357
17358 @samp{yes} and @code{yes} are two @emph{very} different things---don't
17359 ever get them confused.
17360
17361 @iflatex
17362 @c @head
17363 Of course, everything in this manual is of vital interest, so you should
17364 read it all.  Several times.  However, if you feel like skimming the
17365 manual, look for that gnu head you should see in the margin over
17366 there---it means that what's being discussed is of more importance than
17367 the rest of the stuff.  (On the other hand, if everything is infinitely
17368 important, how can anything be more important than that?  Just one more
17369 of the mysteries of this world, I guess.)
17370 @end iflatex
17371
17372 @end iftex
17373
17374
17375 @page
17376 @node Terminology
17377 @section Terminology
17378
17379 @cindex terminology
17380 @table @dfn
17381
17382 @item news
17383 @cindex news
17384 This is what you are supposed to use this thing for---reading news.
17385 News is generally fetched from a nearby @sc{nntp} server, and is
17386 generally publicly available to everybody.  If you post news, the entire
17387 world is likely to read just what you have written, and they'll all
17388 snigger mischievously.  Behind your back.
17389
17390 @item mail
17391 @cindex mail
17392 Everything that's delivered to you personally is mail.  Some news/mail
17393 readers (like Gnus) blur the distinction between mail and news, but
17394 there is a difference.  Mail is private.  News is public.  Mailing is
17395 not posting, and replying is not following up.
17396
17397 @item reply
17398 @cindex reply
17399 Send a mail to the person who has written what you are reading.
17400
17401 @item follow up
17402 @cindex follow up
17403 Post an article to the current newsgroup responding to the article you
17404 are reading.
17405
17406 @item backend
17407 @cindex backend
17408 Gnus gets fed articles from a number of backends, both news and mail
17409 backends.  Gnus does not handle the underlying media, so to speak---this
17410 is all done by the backends.
17411
17412 @item native
17413 @cindex native
17414 Gnus will always use one method (and backend) as the @dfn{native}, or
17415 default, way of getting news.
17416
17417 @item foreign
17418 @cindex foreign
17419 You can also have any number of foreign groups active at the same time.
17420 These are groups that use non-native non-secondary backends for getting
17421 news.
17422
17423 @item secondary
17424 @cindex secondary
17425 Secondary backends are somewhere half-way between being native and being
17426 foreign, but they mostly act like they are native.
17427
17428 @item article
17429 @cindex article
17430 A message that has been posted as news.
17431
17432 @item mail message
17433 @cindex mail message
17434 A message that has been mailed.
17435
17436 @item message 
17437 @cindex message
17438 A mail message or news article
17439
17440 @item head
17441 @cindex head
17442 The top part of a message, where administrative information (etc.) is
17443 put.
17444
17445 @item body
17446 @cindex body
17447 The rest of an article.  Everything not in the head is in the
17448 body. 
17449
17450 @item header
17451 @cindex header
17452 A line from the head of an article. 
17453
17454 @item headers
17455 @cindex headers
17456 A collection of such lines, or a collection of heads.  Or even a
17457 collection of @sc{nov} lines.
17458
17459 @item @sc{nov}
17460 @cindex nov
17461 When Gnus enters a group, it asks the backend for the headers of all
17462 unread articles in the group.  Most servers support the News OverView
17463 format, which is more compact and much faster to read and parse than the
17464 normal @sc{head} format.
17465
17466 @item level
17467 @cindex levels
17468 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
17469 that have a lower level are ``more'' subscribed than the groups with a
17470 higher level.  In fact, groups on levels 1-5 are considered
17471 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
17472 are @dfn{killed}.  Commands for listing groups and scanning for new
17473 articles will all use the numeric prefix as @dfn{working level}.
17474
17475 @item killed groups
17476 @cindex killed groups
17477 No information on killed groups is stored or updated, which makes killed
17478 groups much easier to handle than subscribed groups.
17479
17480 @item zombie groups
17481 @cindex zombie groups
17482 Just like killed groups, only slightly less dead.
17483
17484 @item active file
17485 @cindex active file
17486 The news server has to keep track of what articles it carries, and what
17487 groups exist.  All this information in stored in the active file, which
17488 is rather large, as you might surmise.
17489
17490 @item bogus groups
17491 @cindex bogus groups
17492 A group that exists in the @file{.newsrc} file, but isn't known to the
17493 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
17494 This means that the group probably doesn't exist (any more).
17495
17496 @item activating
17497 @cindex activating groups
17498 The act of asking the server for info on a group and computing the
17499 number of unread articles is called @dfn{activating the group}.
17500 Un-activated groups are listed with @samp{*} in the group buffer.
17501
17502 @item server 
17503 @cindex server
17504 A machine one can connect to and get news (or mail) from.
17505
17506 @item select method
17507 @cindex select method
17508 A structure that specifies the backend, the server and the virtual
17509 server settings.
17510
17511 @item virtual server
17512 @cindex virtual server
17513 A named select method.  Since a select method defines all there is to
17514 know about connecting to a (physical) server, taking the thing as a
17515 whole is a virtual server.
17516
17517 @item washing
17518 @cindex washing
17519 Taking a buffer and running it through a filter of some sort.  The
17520 result will (more often than not) be cleaner and more pleasing than the
17521 original. 
17522
17523 @item ephemeral groups
17524 @cindex ephemeral groups
17525 Most groups store data on what articles you have read.  @dfn{Ephemeral}
17526 groups are groups that will have no data stored---when you exit the
17527 group, it'll disappear into the aether.  
17528
17529 @item solid groups
17530 @cindex solid groups
17531 This is the opposite of ephemeral groups.  All groups listed in the
17532 group buffer are solid groups.
17533
17534 @item sparse articles
17535 @cindex sparse articles
17536 These are article placeholders shown in the summary buffer when
17537 @code{gnus-build-sparse-threads} has been switched on.
17538
17539 @item threading
17540 @cindex threading
17541 To put responses to articles directly after the articles they respond
17542 to---in a hierarchical fashion.
17543
17544 @item root
17545 @cindex root
17546 @cindex thread root
17547 The first article in a thread is the root.  It is the ancestor of all
17548 articles in the thread.
17549
17550 @item parent
17551 @cindex parent
17552 An article that has responses.
17553
17554 @item child
17555 @cindex child
17556 An article that responds to a different article---its parent.
17557
17558 @item digest
17559 @cindex digest
17560 A collection of messages in one file.  The most common digest format is
17561 specified by RFC1153.
17562
17563 @end table
17564
17565
17566 @page
17567 @node Customization
17568 @section Customization
17569 @cindex general customization
17570
17571 All variables are properly documented elsewhere in this manual.  This
17572 section is designed to give general pointers on how to customize Gnus
17573 for some quite common situations.
17574
17575 @menu
17576 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
17577 * Slow Terminal Connection::  You run a remote Emacs.
17578 * Little Disk Space::         You feel that having large setup files is icky.
17579 * Slow Machine::              You feel like buying a faster machine.
17580 @end menu
17581
17582
17583 @node Slow/Expensive Connection
17584 @subsection Slow/Expensive @sc{nntp} Connection
17585
17586 If you run Emacs on a machine locally, and get your news from a machine
17587 over some very thin strings, you want to cut down on the amount of data
17588 Gnus has to get from the @sc{nntp} server.
17589
17590 @table @code
17591
17592 @item gnus-read-active-file
17593 Set this to @code{nil}, which will inhibit Gnus from requesting the
17594 entire active file from the server.  This file is often v.  large.  You
17595 also have to set @code{gnus-check-new-newsgroups} and
17596 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
17597 doesn't suddenly decide to fetch the active file anyway.
17598
17599 @item gnus-nov-is-evil
17600 This one has to be @code{nil}.  If not, grabbing article headers from
17601 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
17602 support @sc{xover}; Gnus will detect this by itself.
17603 @end table
17604
17605
17606 @node Slow Terminal Connection
17607 @subsection Slow Terminal Connection
17608
17609 Let's say you use your home computer for dialing up the system that runs
17610 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
17611 possible) the amount of data sent over the wires.
17612
17613 @table @code
17614
17615 @item gnus-auto-center-summary
17616 Set this to @code{nil} to inhibit Gnus from re-centering the summary
17617 buffer all the time.  If it is @code{vertical}, do only vertical
17618 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
17619 horizontal and vertical recentering.
17620
17621 @item gnus-visible-headers
17622 Cut down on the headers included in the articles to the
17623 minimum.  You can, in fact, make do without them altogether---most of the
17624 useful data is in the summary buffer, anyway.  Set this variable to
17625 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
17626
17627 @item gnus-article-display-hook
17628 Set this hook to all the available hiding commands:
17629 @lisp
17630 (setq gnus-article-display-hook 
17631       '(gnus-article-hide-headers gnus-article-hide-signature
17632         gnus-article-hide-citation))
17633 @end lisp
17634
17635 @item gnus-use-full-window
17636 By setting this to @code{nil}, you can make all the windows smaller.
17637 While this doesn't really cut down much generally, it means that you
17638 have to see smaller portions of articles before deciding that you didn't
17639 want to read them anyway.
17640
17641 @item gnus-thread-hide-subtree
17642 If this is non-@code{nil}, all threads in the summary buffer will be
17643 hidden initially.
17644
17645 @item gnus-updated-mode-lines
17646 If this is @code{nil}, Gnus will not put information in the buffer mode
17647 lines, which might save some time.
17648 @end table
17649
17650
17651 @node Little Disk Space
17652 @subsection Little Disk Space
17653 @cindex disk space
17654
17655 The startup files can get rather large, so you may want to cut their
17656 sizes a bit if you are running out of space.
17657
17658 @table @code
17659
17660 @item gnus-save-newsrc-file
17661 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
17662 only save @file{.newsrc.eld}.  This means that you will not be able to
17663 use any other newsreaders than Gnus.  This variable is @code{t} by
17664 default. 
17665
17666 @item gnus-save-killed-list
17667 If this is @code{nil}, Gnus will not save the list of dead groups.  You
17668 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
17669 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
17670 variable to @code{nil}.  This variable is @code{t} by default.
17671
17672 @end table
17673
17674
17675 @node Slow Machine
17676 @subsection Slow Machine
17677 @cindex slow machine
17678
17679 If you have a slow machine, or are just really impatient, there are a
17680 few things you can do to make Gnus run faster.
17681
17682 Set @code{gnus-check-new-newsgroups} and
17683 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
17684
17685 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
17686 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
17687 summary buffer faster.
17688
17689 Set @code{gnus-article-display-hook} to @code{nil} to make article
17690 processing a bit faster.
17691
17692
17693 @page
17694 @node Troubleshooting
17695 @section Troubleshooting
17696 @cindex troubleshooting
17697
17698 Gnus works @emph{so} well straight out of the box---I can't imagine any
17699 problems, really.
17700
17701 Ahem.
17702
17703 @enumerate
17704
17705 @item
17706 Make sure your computer is switched on.
17707
17708 @item
17709 Make sure that you really load the current Gnus version.  If you have
17710 been running @sc{gnus}, you need to exit Emacs and start it up again before
17711 Gnus will work.
17712
17713 @item
17714 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
17715 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
17716 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
17717 flee}, you have some old @file{.el} files lying around.  Delete these.
17718
17719 @item
17720 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
17721 how-to. 
17722
17723 @item
17724 @vindex max-lisp-eval-depth
17725 Gnus works on many recursive structures, and in some extreme (and very
17726 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
17727 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
17728 something like that.
17729 @end enumerate
17730
17731 If all else fails, report the problem as a bug.
17732
17733 @cindex bugs
17734 @cindex reporting bugs
17735
17736 @kindex M-x gnus-bug
17737 @findex gnus-bug
17738 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
17739 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
17740 me the backtrace.  I will fix bugs, but I can only fix them if you send
17741 me a precise description as to how to reproduce the bug.
17742
17743 You really can never be too detailed in a bug report.  Always use the
17744 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
17745 a 10Kb mail each time you use it, and even if you have sent me your
17746 environment 500 times before.  I don't care.  I want the full info each
17747 time.  
17748
17749 It is also important to remember that I have no memory whatsoever.  If
17750 you send a bug report, and I send you a reply, and then you just send
17751 back ``No, it's not! Moron!'', I will have no idea what you are
17752 insulting me about.  Always over-explain everything.  It's much easier
17753 for all of us---if I don't have all the information I need, I will just
17754 mail you and ask for more info, and everything takes more time.
17755
17756 If the problem you're seeing is very visual, and you can't quite explain
17757 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
17758 it somewhere it can be reached, and include the URL of the picture in
17759 the bug report.
17760
17761 If you just need help, you are better off asking on
17762 @samp{gnu.emacs.gnus}.  I'm not very helpful.
17763
17764 @cindex gnu.emacs.gnus
17765 @cindex ding mailing list
17766 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
17767 Write to @samp{ding-request@@gnus.org} to subscribe.
17768
17769
17770 @page
17771 @node A Programmers Guide to Gnus
17772 @section A Programmer@'s Guide to Gnus
17773
17774 It is my hope that other people will figure out smart stuff that Gnus
17775 can do, and that other people will write those smart things as well.  To
17776 facilitate that I thought it would be a good idea to describe the inner
17777 workings of Gnus.  And some of the not-so-inner workings, while I'm at
17778 it.
17779
17780 You can never expect the internals of a program not to change, but I
17781 will be defining (in some details) the interface between Gnus and its
17782 backends (this is written in stone), the format of the score files
17783 (ditto), data structures (some are less likely to change than others)
17784 and general methods of operation.
17785
17786 @menu 
17787 * Gnus Utility Functions::   Common functions and variable to use.
17788 * Backend Interface::        How Gnus communicates with the servers.
17789 * Score File Syntax::        A BNF definition of the score file standard.
17790 * Headers::                  How Gnus stores headers internally.
17791 * Ranges::                   A handy format for storing mucho numbers.
17792 * Group Info::               The group info format.
17793 * Extended Interactive::     Symbolic prefixes and stuff.
17794 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
17795 * Various File Formats::     Formats of files that Gnus use.
17796 @end menu
17797
17798
17799 @node Gnus Utility Functions
17800 @subsection Gnus Utility Functions
17801 @cindex Gnus utility functions
17802 @cindex utility functions
17803 @cindex functions
17804 @cindex internal variables
17805
17806 When writing small functions to be run from hooks (and stuff), it's
17807 vital to have access to the Gnus internal functions and variables.
17808 Below is a list of the most common ones.
17809
17810 @table @code
17811
17812 @item gnus-newsgroup-name
17813 @vindex gnus-newsgroup-name
17814 This variable holds the name of the current newsgroup.
17815
17816 @item gnus-find-method-for-group
17817 @findex gnus-find-method-for-group
17818 A function that returns the select method for @var{group}.
17819
17820 @item gnus-group-real-name
17821 @findex gnus-group-real-name
17822 Takes a full (prefixed) Gnus group name, and returns the unprefixed
17823 name.
17824
17825 @item gnus-group-prefixed-name
17826 @findex gnus-group-prefixed-name
17827 Takes an unprefixed group name and a select method, and returns the full
17828 (prefixed) Gnus group name.
17829
17830 @item gnus-get-info
17831 @findex gnus-get-info
17832 Returns the group info list for @var{group}.
17833
17834 @item gnus-add-current-to-buffer-list
17835 @findex gnus-add-current-to-buffer-list
17836 Adds the current buffer to the list of buffers to be killed on Gnus
17837 exit.
17838
17839 @item gnus-continuum-version
17840 @findex gnus-continuum-version
17841 Takes a Gnus version string as a parameter and returns a floating point
17842 number.  Earlier versions will always get a lower number than later
17843 versions.
17844
17845 @item gnus-group-read-only-p
17846 @findex gnus-group-read-only-p
17847 Says whether @var{group} is read-only or not.
17848
17849 @item gnus-news-group-p
17850 @findex gnus-news-group-p
17851 Says whether @var{group} came from a news backend.
17852
17853 @item gnus-ephemeral-group-p
17854 @findex gnus-ephemeral-group-p
17855 Says whether @var{group} is ephemeral or not.
17856
17857 @item gnus-server-to-method
17858 @findex gnus-server-to-method
17859 Returns the select method corresponding to @var{server}.
17860
17861 @item gnus-server-equal
17862 @findex gnus-server-equal
17863 Says whether two virtual servers are equal.
17864
17865 @item gnus-group-native-p
17866 @findex gnus-group-native-p
17867 Says whether @var{group} is native or not.
17868
17869 @item gnus-group-secondary-p
17870 @findex gnus-group-secondary-p
17871 Says whether @var{group} is secondary or not.
17872
17873 @item gnus-group-foreign-p
17874 @findex gnus-group-foreign-p
17875 Says whether @var{group} is foreign or not.
17876
17877 @item group-group-find-parameter
17878 @findex group-group-find-parameter
17879 Returns the parameter list of @var{group}.  If given a second parameter,
17880 returns the value of that parameter for @var{group}.
17881
17882 @item gnus-group-set-parameter
17883 @findex gnus-group-set-parameter
17884 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
17885
17886 @item gnus-narrow-to-body
17887 @findex gnus-narrow-to-body
17888 Narrows the current buffer to the body of the article.
17889
17890 @item gnus-check-backend-function
17891 @findex gnus-check-backend-function
17892 Takes two parameters, @var{function} and @var{group}.  If the backend
17893 @var{group} comes from supports @var{function}, return non-@code{nil}.
17894
17895 @lisp
17896 (gnus-check-backend-function "request-scan" "nnml:misc")
17897 => t
17898 @end lisp
17899
17900 @item gnus-read-method
17901 @findex gnus-read-method
17902 Prompts the user for a select method.
17903
17904 @end table
17905
17906
17907 @node Backend Interface
17908 @subsection Backend Interface
17909
17910 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
17911 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
17912 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
17913 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
17914 examples of the latter we have @code{nntp-port-number} and
17915 @code{nnmbox-directory}.
17916
17917 When Gnus asks for information from a backend---say @code{nntp}---on
17918 something, it will normally include a virtual server name in the
17919 function parameters.  (If not, the backend should use the ``current''
17920 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
17921 server as its only (optional) parameter.  If this virtual server hasn't
17922 been opened, the function should fail.
17923
17924 Note that a virtual server name has no relation to some physical server
17925 name.  Take this example:
17926
17927 @lisp
17928 (nntp "odd-one" 
17929       (nntp-address "ifi.uio.no") 
17930       (nntp-port-number 4324))
17931 @end lisp
17932
17933 Here the virtual server name is @samp{odd-one} while the name of
17934 the physical server is @samp{ifi.uio.no}. 
17935
17936 The backends should be able to switch between several virtual servers.
17937 The standard backends implement this by keeping an alist of virtual
17938 server environments that they pull down/push up when needed.  
17939
17940 There are two groups of interface functions: @dfn{required functions},
17941 which must be present, and @dfn{optional functions}, which Gnus will
17942 always check for presence before attempting to call 'em.
17943
17944 All these functions are expected to return data in the buffer
17945 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
17946 unfortunately named, but we'll have to live with it.  When I talk about
17947 @dfn{resulting data}, I always refer to the data in that buffer.  When I
17948 talk about @dfn{return value}, I talk about the function value returned by
17949 the function call.  Functions that fail should return @code{nil} as the
17950 return value.
17951
17952 Some backends could be said to be @dfn{server-forming} backends, and
17953 some might be said not to be.  The latter are backends that generally
17954 only operate on one group at a time, and have no concept of ``server''
17955 -- they have a group, and they deliver info on that group and nothing
17956 more.
17957
17958 In the examples and definitions I will refer to the imaginary backend
17959 @code{nnchoke}. 
17960
17961 @cindex @code{nnchoke}
17962
17963 @menu
17964 * Required Backend Functions::        Functions that must be implemented.
17965 * Optional Backend Functions::        Functions that need not be implemented.
17966 * Error Messaging::                   How to get messages and report errors.
17967 * Writing New Backends::              Extending old backends.
17968 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
17969 * Mail-like Backends::                Some tips on mail backends.
17970 @end menu
17971
17972
17973 @node Required Backend Functions
17974 @subsubsection Required Backend Functions
17975
17976 @table @code
17977
17978 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
17979
17980 @var{articles} is either a range of article numbers or a list of
17981 @code{Message-ID}s.  Current backends do not fully support either---only
17982 sequences (lists) of article numbers, and most backends do not support
17983 retrieval of @code{Message-ID}s.  But they should try for both. 
17984
17985 The result data should either be HEADs or NOV lines, and the result
17986 value should either be @code{headers} or @code{nov} to reflect this.
17987 This might later be expanded to @code{various}, which will be a mixture
17988 of HEADs and NOV lines, but this is currently not supported by Gnus.  
17989
17990 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
17991 headers", in some meaning of the word.  This is generally done by
17992 fetching (at most) @var{fetch-old} extra headers less than the smallest
17993 article number in @code{articles}, and filling the gaps as well.  The
17994 presence of this parameter can be ignored if the backend finds it
17995 cumbersome to follow the request.  If this is non-@code{nil} and not a
17996 number, do maximum fetches.
17997
17998 Here's an example HEAD:
17999
18000 @example
18001 221 1056 Article retrieved.
18002 Path: ifi.uio.no!sturles
18003 From: sturles@@ifi.uio.no (Sturle Sunde)
18004 Newsgroups: ifi.discussion
18005 Subject: Re: Something very droll
18006 Date: 27 Oct 1994 14:02:57 +0100
18007 Organization: Dept. of Informatics, University of Oslo, Norway
18008 Lines: 26
18009 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
18010 References: <38jdmq$4qu@@visbur.ifi.uio.no>
18011 NNTP-Posting-Host: holmenkollen.ifi.uio.no
18012 .
18013 @end example
18014
18015 So a @code{headers} return value would imply that there's a number of
18016 these in the data buffer.
18017
18018 Here's a BNF definition of such a buffer:
18019
18020 @example
18021 headers        = *head
18022 head           = error / valid-head
18023 error-message  = [ "4" / "5" ] 2number " " <error message> eol
18024 valid-head     = valid-message *header "." eol
18025 valid-message  = "221 " <number> " Article retrieved." eol
18026 header         = <text> eol
18027 @end example
18028
18029 If the return value is @code{nov}, the data buffer should contain
18030 @dfn{network overview database} lines.  These are basically fields
18031 separated by tabs. 
18032
18033 @example
18034 nov-buffer = *nov-line
18035 nov-line   = 8*9 [ field <TAB> ] eol
18036 field      = <text except TAB>
18037 @end example
18038
18039 For a closer look at what should be in those fields,
18040 @pxref{Headers}. 
18041
18042
18043 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
18044
18045 @var{server} is here the virtual server name.  @var{definitions} is a
18046 list of @code{(VARIABLE VALUE)} pairs that define this virtual server. 
18047
18048 If the server can't be opened, no error should be signaled.  The backend
18049 may then choose to refuse further attempts at connecting to this
18050 server.  In fact, it should do so. 
18051
18052 If the server is opened already, this function should return a
18053 non-@code{nil} value.  There should be no data returned.
18054
18055
18056 @item (nnchoke-close-server &optional SERVER)
18057
18058 Close connection to @var{server} and free all resources connected
18059 to it.  Return @code{nil} if the server couldn't be closed for some
18060 reason.
18061
18062 There should be no data returned.
18063
18064
18065 @item (nnchoke-request-close)
18066
18067 Close connection to all servers and free all resources that the backend
18068 have reserved.  All buffers that have been created by that backend
18069 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
18070 function is generally only called when Gnus is shutting down.
18071
18072 There should be no data returned. 
18073
18074
18075 @item (nnchoke-server-opened &optional SERVER)
18076
18077 If @var{server} is the current virtual server, and the connection to the
18078 physical server is alive, then this function should return a
18079 non-@code{nil} vlue.  This function should under no circumstances
18080 attempt to reconnect to a server we have lost connection to.
18081
18082 There should be no data returned.
18083
18084
18085 @item (nnchoke-status-message &optional SERVER)
18086
18087 This function should return the last error message from @var{server}. 
18088
18089 There should be no data returned.
18090
18091
18092 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
18093
18094 The result data from this function should be the article specified by
18095 @var{article}.  This might either be a @code{Message-ID} or a number.
18096 It is optional whether to implement retrieval by @code{Message-ID}, but
18097 it would be nice if that were possible.
18098
18099 If @var{to-buffer} is non-@code{nil}, the result data should be returned
18100 in this buffer instead of the normal data buffer.  This is to make it
18101 possible to avoid copying large amounts of data from one buffer to
18102 another, while Gnus mainly requests articles to be inserted directly
18103 into its article buffer.
18104
18105 If it is at all possible, this function should return a cons cell where
18106 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
18107 the article number.  This will enable Gnus to find out what the real
18108 group and article numbers are when fetching articles by
18109 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
18110 on successful article retrieval.
18111
18112
18113 @item (nnchoke-request-group GROUP &optional SERVER FAST)
18114
18115 Get data on @var{group}.  This function also has the side effect of
18116 making @var{group} the current group. 
18117
18118 If @var{FAST}, don't bother to return useful data, just make @var{group}
18119 the current group.
18120
18121 Here's an example of some result data and a definition of the same:
18122
18123 @example
18124 211 56 1000 1059 ifi.discussion
18125 @end example
18126
18127 The first number is the status, which should be 211.  Next is the
18128 total number of articles in the group, the lowest article number, the
18129 highest article number, and finally the group name.  Note that the total
18130 number of articles may be less than one might think while just
18131 considering the highest and lowest article numbers, but some articles
18132 may have been canceled.  Gnus just discards the total-number, so
18133 whether one should take the bother to generate it properly (if that is a
18134 problem) is left as an exercise to the reader.
18135
18136 @example
18137 group-status = [ error / info ] eol
18138 error        = [ "4" / "5" ] 2<number> " " <Error message>
18139 info         = "211 " 3* [ <number> " " ] <string>
18140 @end example
18141
18142
18143 @item (nnchoke-close-group GROUP &optional SERVER)
18144
18145 Close @var{group} and free any resources connected to it.  This will be
18146 a no-op on most backends. 
18147
18148 There should be no data returned.
18149
18150
18151 @item (nnchoke-request-list &optional SERVER)
18152
18153 Return a list of all groups available on @var{server}.  And that means
18154 @emph{all}. 
18155
18156 Here's an example from a server that only carries two groups:
18157
18158 @example
18159 ifi.test 0000002200 0000002000 y
18160 ifi.discussion 3324 3300 n
18161 @end example
18162
18163 On each line we have a group name, then the highest article number in
18164 that group, the lowest article number, and finally a flag.
18165
18166 @example
18167 active-file = *active-line
18168 active-line = name " " <number> " " <number> " " flags eol
18169 name        = <string>
18170 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
18171 @end example
18172
18173 The flag says whether the group is read-only (@samp{n}), is moderated
18174 (@samp{m}), is dead (@samp{x}), is aliased to some other group
18175 (@samp{=other-group}) or none of the above (@samp{y}). 
18176
18177
18178 @item (nnchoke-request-post &optional SERVER)
18179
18180 This function should post the current buffer.  It might return whether
18181 the posting was successful or not, but that's not required.  If, for
18182 instance, the posting is done asynchronously, it has generally not been
18183 completed by the time this function concludes.  In that case, this
18184 function should set up some kind of sentinel to beep the user loud and
18185 clear if the posting could not be completed.
18186
18187 There should be no result data from this function. 
18188
18189 @end table
18190
18191
18192 @node Optional Backend Functions
18193 @subsubsection Optional Backend Functions
18194
18195 @table @code
18196
18197 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
18198
18199 @var{groups} is a list of groups, and this function should request data
18200 on all those groups.  How it does it is of no concern to Gnus, but it
18201 should attempt to do this in a speedy fashion.
18202
18203 The return value of this function can be either @code{active} or
18204 @code{group}, which says what the format of the result data is.  The
18205 former is in the same format as the data from
18206 @code{nnchoke-request-list}, while the latter is a buffer full of lines
18207 in the same format as @code{nnchoke-request-group} gives.
18208
18209 @example
18210 group-buffer = *active-line / *group-status
18211 @end example
18212
18213
18214 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
18215
18216 A Gnus group info (@pxref{Group Info}) is handed to the backend for
18217 alterations.  This comes in handy if the backend really carries all the
18218 information (as is the case with virtual and imap groups).  This
18219 function should destructively alter the info to suit its needs, and
18220 should return the (altered) group info.
18221
18222 There should be no result data from this function.
18223
18224
18225 @item (nnchoke-request-type GROUP &optional ARTICLE)
18226
18227 When the user issues commands for ``sending news'' (@kbd{F} in the
18228 summary buffer, for instance), Gnus has to know whether the article the
18229 user is following up on is news or mail.  This function should return
18230 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
18231 is mail and @code{unknown} if the type can't be decided.  (The
18232 @var{article} parameter is necessary in @code{nnvirtual} groups which
18233 might very well combine mail groups and news groups.)  Both @var{group}
18234 and @var{article} may be @code{nil}.
18235
18236 There should be no result data from this function.
18237
18238
18239 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
18240
18241 If the user tries to set a mark that the backend doesn't like, this
18242 function may change the mark.  Gnus will use whatever this function
18243 returns as the mark for @var{article} instead of the original
18244 @var{mark}.  If the backend doesn't care, it must return the original
18245 @var{mark}, and not @code{nil} or any other type of garbage.  
18246
18247 The only use for this I can see is what @code{nnvirtual} does with
18248 it---if a component group is auto-expirable, marking an article as read
18249 in the virtual group should result in the article being marked as
18250 expirable. 
18251
18252 There should be no result data from this function.
18253
18254
18255 @item (nnchoke-request-scan &optional GROUP SERVER)
18256
18257 This function may be called at any time (by Gnus or anything else) to
18258 request that the backend check for incoming articles, in one way or
18259 another.  A mail backend will typically read the spool file or query the
18260 POP server when this function is invoked.  The @var{group} doesn't have
18261 to be heeded---if the backend decides that it is too much work just
18262 scanning for a single group, it may do a total scan of all groups.  It
18263 would be nice, however, to keep things local if that's practical.
18264
18265 There should be no result data from this function.
18266
18267
18268 @item (nnchoke-request-group-description GROUP &optional SERVER)
18269
18270 The result data from this function should be a description of
18271 @var{group}. 
18272
18273 @example
18274 description-line = name <TAB> description eol
18275 name             = <string>
18276 description      = <text>
18277 @end example
18278
18279 @item (nnchoke-request-list-newsgroups &optional SERVER)
18280
18281 The result data from this function should be the description of all
18282 groups available on the server.
18283
18284 @example
18285 description-buffer = *description-line
18286 @end example
18287
18288
18289 @item (nnchoke-request-newgroups DATE &optional SERVER)
18290
18291 The result data from this function should be all groups that were
18292 created after @samp{date}, which is in normal human-readable date
18293 format.  The data should be in the active buffer format.
18294
18295
18296 @item (nnchoke-request-create-group GROUP &optional SERVER)
18297
18298 This function should create an empty group with name @var{group}.  
18299
18300 There should be no return data.
18301
18302
18303 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
18304
18305 This function should run the expiry process on all articles in the
18306 @var{articles} range (which is currently a simple list of article
18307 numbers.)  It is left up to the backend to decide how old articles
18308 should be before they are removed by this function.  If @var{force} is
18309 non-@code{nil}, all @var{articles} should be deleted, no matter how new
18310 they are. 
18311
18312 This function should return a list of articles that it did not/was not
18313 able to delete.
18314
18315 There should be no result data returned.
18316
18317
18318 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
18319 &optional LAST)
18320
18321 This function should move @var{article} (which is a number) from
18322 @var{group} by calling @var{accept-form}.  
18323
18324 This function should ready the article in question for moving by
18325 removing any header lines it has added to the article, and generally
18326 should ``tidy up'' the article.  Then it should @code{eval}
18327 @var{accept-form} in the buffer where the ``tidy'' article is.  This
18328 will do the actual copying.  If this @code{eval} returns a
18329 non-@code{nil} value, the article should be removed.
18330
18331 If @var{last} is @code{nil}, that means that there is a high likelihood
18332 that there will be more requests issued shortly, so that allows some
18333 optimizations. 
18334
18335 The function should return a cons where the @code{car} is the group name and
18336 the @code{cdr} is the article number that the article was entered as.
18337
18338 There should be no data returned. 
18339
18340
18341 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
18342
18343 This function takes the current buffer and inserts it into @var{group}.
18344 If @var{last} in @code{nil}, that means that there will be more calls to
18345 this function in short order.
18346
18347 The function should return a cons where the @code{car} is the group name and
18348 the @code{cdr} is the article number that the article was entered as.
18349
18350 There should be no data returned.
18351
18352
18353 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
18354
18355 This function should remove @var{article} (which is a number) from
18356 @var{group} and insert @var{buffer} there instead.
18357
18358 There should be no data returned.
18359
18360
18361 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
18362
18363 This function should delete @var{group}.  If @var{force}, it should
18364 really delete all the articles in the group, and then delete the group
18365 itself.  (If there is such a thing as ``the group itself''.)
18366
18367 There should be no data returned.
18368
18369
18370 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
18371
18372 This function should rename @var{group} into @var{new-name}.  All
18373 articles in @var{group} should move to @var{new-name}.
18374
18375 There should be no data returned.
18376
18377 @end table
18378
18379
18380 @node Error Messaging
18381 @subsubsection Error Messaging
18382
18383 @findex nnheader-report
18384 @findex nnheader-get-report
18385 The backends should use the function @code{nnheader-report} to report
18386 error conditions---they should not raise errors when they aren't able to
18387 perform a request.  The first argument to this function is the backend
18388 symbol, and the rest are interpreted as arguments to @code{format} if
18389 there are multiple of them, or just a string if there is one of them.
18390 This function must always returns @code{nil}.
18391
18392 @lisp
18393 (nnheader-report 'nnchoke "You did something totally bogus")
18394
18395 (nnheader-report 'nnchoke "Could not request group %s" group)
18396 @end lisp
18397
18398 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
18399 @code{nil} back from a server, and this function returns the most
18400 recently reported message for the backend in question.  This function
18401 takes one argument---the server symbol.
18402
18403 Internally, these functions access @var{backend}@code{-status-string},
18404 so the @code{nnchoke} backend will have its error message stored in
18405 @code{nnchoke-status-string}.
18406
18407
18408 @node Writing New Backends
18409 @subsubsection Writing New Backends
18410
18411 Many backends are quite similar.  @code{nnml} is just like
18412 @code{nnspool}, but it allows you to edit the articles on the server.
18413 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
18414 and it doesn't maintain overview databases.  @code{nndir} is just like
18415 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
18416 editing articles.
18417
18418 It would make sense if it were possible to ``inherit'' functions from
18419 backends when writing new backends.  And, indeed, you can do that if you
18420 want to.  (You don't have to if you don't want to, of course.)  
18421
18422 All the backends declare their public variables and functions by using a
18423 package called @code{nnoo}.  
18424
18425 To inherit functions from other backends (and allow other backends to
18426 inherit functions from the current backend), you should use the
18427 following macros:
18428
18429 @table @code
18430
18431 @item nnoo-declare
18432 This macro declares the first parameter to be a child of the subsequent
18433 parameters.  For instance:
18434
18435 @lisp
18436 (nnoo-declare nndir
18437   nnml nnmh)
18438 @end lisp
18439
18440 @code{nndir} has declared here that it intends to inherit functions from
18441 both @code{nnml} and @code{nnmh}.
18442
18443 @item defvoo
18444 This macro is equivalent to @code{defvar}, but registers the variable as
18445 a public server variable.  Most state-oriented variables should be
18446 declared with @code{defvoo} instead of @code{defvar}.  
18447
18448 In addition to the normal @code{defvar} parameters, it takes a list of
18449 variables in the parent backends to map the variable to when executing
18450 a function in those backends.
18451
18452 @lisp
18453 (defvoo nndir-directory nil
18454   "Where nndir will look for groups."
18455   nnml-current-directory nnmh-current-directory)
18456 @end lisp
18457
18458 This means that @code{nnml-current-directory} will be set to
18459 @code{nndir-directory} when an @code{nnml} function is called on behalf
18460 of @code{nndir}.  (The same with @code{nnmh}.)  
18461
18462 @item nnoo-define-basics
18463 This macro defines some common functions that almost all backends should
18464 have.
18465
18466 @example
18467 (nnoo-define-basics nndir)
18468 @end example
18469
18470 @item deffoo
18471 This macro is just like @code{defun} and takes the same parameters.  In
18472 addition to doing the normal @code{defun} things, it registers the
18473 function as being public so that other backends can inherit it.
18474
18475 @item nnoo-map-functions
18476 This macro allows mapping of functions from the current backend to
18477 functions from the parent backends.
18478
18479 @example
18480 (nnoo-map-functions nndir
18481   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18482   (nnmh-request-article 0 nndir-current-group 0 0))
18483 @end example
18484
18485 This means that when @code{nndir-retrieve-headers} is called, the first,
18486 third, and fourth parameters will be passed on to
18487 @code{nnml-retrieve-headers}, while the second parameter is set to the
18488 value of @code{nndir-current-group}.
18489
18490 @item nnoo-import
18491 This macro allows importing functions from backends.  It should be the
18492 last thing in the source file, since it will only define functions that
18493 haven't already been defined.
18494
18495 @example
18496 (nnoo-import nndir
18497   (nnmh
18498    nnmh-request-list
18499    nnmh-request-newgroups)
18500   (nnml))
18501 @end example
18502
18503 This means that calls to @code{nndir-request-list} should just be passed
18504 on to @code{nnmh-request-list}, while all public functions from
18505 @code{nnml} that haven't been defined in @code{nndir} yet should be
18506 defined now.
18507
18508 @end table
18509
18510 Below is a slightly shortened version of the @code{nndir} backend.
18511
18512 @lisp
18513 ;;; nndir.el --- single directory newsgroup access for Gnus
18514 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
18515
18516 ;;; Code:
18517
18518 (require 'nnheader)
18519 (require 'nnmh)
18520 (require 'nnml)
18521 (require 'nnoo)
18522 (eval-when-compile (require 'cl))
18523
18524 (nnoo-declare nndir
18525   nnml nnmh)
18526
18527 (defvoo nndir-directory nil
18528   "Where nndir will look for groups."
18529   nnml-current-directory nnmh-current-directory)
18530
18531 (defvoo nndir-nov-is-evil nil
18532   "*Non-nil means that nndir will never retrieve NOV headers."
18533   nnml-nov-is-evil)
18534
18535 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
18536 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
18537 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
18538
18539 (defvoo nndir-status-string "" nil nnmh-status-string)
18540 (defconst nndir-version "nndir 1.0")
18541
18542 ;;; Interface functions.
18543
18544 (nnoo-define-basics nndir)
18545
18546 (deffoo nndir-open-server (server &optional defs)
18547   (setq nndir-directory
18548         (or (cadr (assq 'nndir-directory defs))
18549             server))
18550   (unless (assq 'nndir-directory defs)
18551     (push `(nndir-directory ,server) defs))
18552   (push `(nndir-current-group
18553           ,(file-name-nondirectory (directory-file-name nndir-directory)))
18554         defs)
18555   (push `(nndir-top-directory
18556           ,(file-name-directory (directory-file-name nndir-directory)))
18557         defs)
18558   (nnoo-change-server 'nndir server defs))
18559
18560 (nnoo-map-functions nndir
18561   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18562   (nnmh-request-article 0 nndir-current-group 0 0)
18563   (nnmh-request-group nndir-current-group 0 0)
18564   (nnmh-close-group nndir-current-group 0))
18565
18566 (nnoo-import nndir
18567   (nnmh
18568    nnmh-status-message
18569    nnmh-request-list
18570    nnmh-request-newgroups))
18571
18572 (provide 'nndir)
18573 @end lisp
18574
18575
18576 @node Hooking New Backends Into Gnus
18577 @subsubsection Hooking New Backends Into Gnus
18578
18579 @vindex gnus-valid-select-methods
18580 Having Gnus start using your new backend is rather easy---you just
18581 declare it with the @code{gnus-declare-backend} functions.  This will
18582 enter the backend into the @code{gnus-valid-select-methods} variable.
18583
18584 @code{gnus-declare-backend} takes two parameters---the backend name and
18585 an arbitrary number of @dfn{abilities}.
18586
18587 Here's an example:
18588
18589 @lisp
18590 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
18591 @end lisp
18592
18593 The abilities can be:
18594
18595 @table @code
18596 @item mail
18597 This is a mailish backend---followups should (probably) go via mail.
18598 @item post
18599 This is a newsish backend---followups should (probably) go via news. 
18600 @item post-mail
18601 This backend supports both mail and news.
18602 @item none
18603 This is neither a post nor mail backend---it's something completely
18604 different. 
18605 @item respool
18606 It supports respooling---or rather, it is able to modify its source
18607 articles and groups.
18608 @item address
18609 The name of the server should be in the virtual server name.  This is
18610 true for almost all backends.
18611 @item prompt-address
18612 The user should be prompted for an address when doing commands like
18613 @kbd{B} in the group buffer.  This is true for backends like
18614 @code{nntp}, but not @code{nnmbox}, for instance. 
18615 @end table
18616
18617
18618 @node Mail-like Backends
18619 @subsubsection Mail-like Backends
18620
18621 One of the things that separate the mail backends from the rest of the
18622 backends is the heavy dependence by the mail backends on common
18623 functions in @file{nnmail.el}.  For instance, here's the definition of
18624 @code{nnml-request-scan}: 
18625
18626 @lisp
18627 (deffoo nnml-request-scan (&optional group server)
18628   (setq nnml-article-file-alist nil)
18629   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
18630 @end lisp
18631
18632 It simply calls @code{nnmail-get-new-mail} with a few parameters,
18633 and @code{nnmail} takes care of all the moving and splitting of the
18634 mail.  
18635
18636 This function takes four parameters.
18637
18638 @table @var
18639 @item method
18640 This should be a symbol to designate which backend is responsible for
18641 the call.
18642
18643 @item exit-function
18644 This function should be called after the splitting has been performed.
18645
18646 @item temp-directory
18647 Where the temporary files should be stored.
18648
18649 @item group
18650 This optional argument should be a group name if the splitting is to be
18651 performed for one group only.
18652 @end table
18653
18654 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
18655 save each article.  @var{backend}@code{-active-number} will be called to
18656 find the article number assigned to this article.  
18657
18658 The function also uses the following variables:
18659 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
18660 this backend); and @var{backend}@code{-group-alist} and
18661 @var{backend}@code{-active-file} to generate the new active file.
18662 @var{backend}@code{-group-alist} should be a group-active alist, like
18663 this:
18664
18665 @example
18666 (("a-group" (1 . 10))
18667  ("some-group" (34 . 39)))
18668 @end example
18669
18670
18671 @node Score File Syntax
18672 @subsection Score File Syntax
18673
18674 Score files are meant to be easily parsable, but yet extremely
18675 mallable.   It was decided that something that had the same read syntax
18676 as an Emacs Lisp list would fit that spec.
18677
18678 Here's a typical score file:
18679
18680 @lisp
18681 (("summary"
18682   ("win95" -10000 nil s)
18683   ("Gnus"))
18684  ("from"
18685   ("Lars" -1000))
18686  (mark -100))
18687 @end lisp
18688
18689 BNF definition of a score file:
18690
18691 @example
18692 score-file       = "" / "(" *element ")"
18693 element          = rule / atom
18694 rule             = string-rule / number-rule / date-rule
18695 string-rule      = "(" quote string-header quote space *string-match ")"
18696 number-rule      = "(" quote number-header quote space *number-match ")"
18697 date-rule        = "(" quote date-header quote space *date-match ")"
18698 quote            = <ascii 34>
18699 string-header    = "subject" / "from" / "references" / "message-id" / 
18700                    "xref" / "body" / "head" / "all" / "followup"
18701 number-header    = "lines" / "chars"
18702 date-header      = "date"
18703 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
18704                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
18705 score            = "nil" / <integer>
18706 date             = "nil" / <natural number>
18707 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
18708                    "r" / "regex" / "R" / "Regex" /
18709                    "e" / "exact" / "E" / "Exact" /
18710                    "f" / "fuzzy" / "F" / "Fuzzy"
18711 number-match     = "(" <integer> [ "" / [ space score [ "" / 
18712                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
18713 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
18714 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
18715                    space date [ "" / [ space date-match-t ] ] ] ] ")"
18716 date-match-t     = "nil" / "at" / "before" / "after"
18717 atom             = "(" [ required-atom / optional-atom ] ")"
18718 required-atom    = mark / expunge / mark-and-expunge / files /
18719                    exclude-files / read-only / touched
18720 optional-atom    = adapt / local / eval 
18721 mark             = "mark" space nil-or-number
18722 nil-or-number    = "nil" / <integer>
18723 expunge          = "expunge" space nil-or-number
18724 mark-and-expunge = "mark-and-expunge" space nil-or-number
18725 files            = "files" *[ space <string> ]
18726 exclude-files    = "exclude-files" *[ space <string> ]
18727 read-only        = "read-only" [ space "nil" / space "t" ]
18728 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
18729 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
18730 local            = "local" *[ space "(" <string> space <form> ")" ]
18731 eval             = "eval" space <form>
18732 space            = *[ " " / <TAB> / <NEWLINE> ]
18733 @end example
18734
18735 Any unrecognized elements in a score file should be ignored, but not
18736 discarded.  
18737
18738 As you can see, white space is needed, but the type and amount of white
18739 space is irrelevant.  This means that formatting of the score file is
18740 left up to the programmer---if it's simpler to just spew it all out on
18741 one looong line, then that's ok.
18742
18743 The meaning of the various atoms are explained elsewhere in this
18744 manual (@pxref{Score File Format}).
18745
18746
18747 @node Headers
18748 @subsection Headers
18749
18750 Internally Gnus uses a format for storing article headers that
18751 corresponds to the @sc{nov} format in a mysterious fashion.  One could
18752 almost suspect that the author looked at the @sc{nov} specification and
18753 just shamelessly @emph{stole} the entire thing, and one would be right.
18754
18755 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
18756 RFC1036 to talk about lines in the head of an article (e.g.,
18757 @code{From}).  It is used by many people as a synonym for
18758 ``head''---``the header and the body''.  (That should be avoided, in my
18759 opinion.)  And Gnus uses a format internally that it calls ``header'',
18760 which is what I'm talking about here.  This is a 9-element vector,
18761 basically, with each header (ouch) having one slot.
18762
18763 These slots are, in order: @code{number}, @code{subject}, @code{from},
18764 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
18765 @code{xref}.  There are macros for accessing and setting these
18766 slots---they all have predictable names beginning with
18767 @code{mail-header-} and @code{mail-header-set-}, respectively.
18768
18769 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
18770 be put in there.
18771
18772
18773 @node Ranges
18774 @subsection Ranges
18775
18776 @sc{gnus} introduced a concept that I found so useful that I've started
18777 using it a lot and have elaborated on it greatly. 
18778
18779 The question is simple: If you have a large amount of objects that are
18780 identified by numbers (say, articles, to take a @emph{wild} example)
18781 that you want to qualify as being ``included'', a normal sequence isn't
18782 very useful.  (A 200,000 length sequence is a bit long-winded.)
18783
18784 The solution is as simple as the question: You just collapse the
18785 sequence. 
18786
18787 @example
18788 (1 2 3 4 5 6 10 11 12)
18789 @end example
18790
18791 is transformed into
18792
18793 @example
18794 ((1 . 6) (10 . 12))
18795 @end example
18796
18797 To avoid having those nasty @samp{(13 . 13)} elements to denote a
18798 lonesome object, a @samp{13} is a valid element:
18799
18800 @example
18801 ((1 . 6) 7 (10 . 12))
18802 @end example
18803
18804 This means that comparing two ranges to find out whether they are equal
18805 is slightly tricky:
18806
18807 @example
18808 ((1 . 5) 7 8 (10 . 12))
18809 @end example
18810
18811 and
18812
18813 @example
18814 ((1 . 5) (7 . 8) (10 . 12))
18815 @end example
18816
18817 are equal.  In fact, any non-descending list is a range:
18818
18819 @example
18820 (1 2 3 4 5)
18821 @end example
18822
18823 is a perfectly valid range, although a pretty long-winded one.  This is
18824 also valid:
18825
18826 @example
18827 (1 . 5)
18828 @end example
18829
18830 and is equal to the previous range.
18831
18832 Here's a BNF definition of ranges.  Of course, one must remember the
18833 semantic requirement that the numbers are non-descending.  (Any number
18834 of repetition of the same number is allowed, but apt to disappear in
18835 range handling.)
18836
18837 @example
18838 range           = simple-range / normal-range
18839 simple-range    = "(" number " . " number ")"
18840 normal-range    = "(" start-contents ")"
18841 contents        = "" / simple-range *[ " " contents ] / 
18842                   number *[ " " contents ]
18843 @end example
18844
18845 Gnus currently uses ranges to keep track of read articles and article
18846 marks.  I plan on implementing a number of range operators in C if The
18847 Powers That Be are willing to let me.  (I haven't asked yet, because I
18848 need to do some more thinking on what operators I need to make life
18849 totally range-based without ever having to convert back to normal
18850 sequences.) 
18851
18852
18853 @node Group Info
18854 @subsection Group Info
18855
18856 Gnus stores all permanent info on groups in a @dfn{group info} list.
18857 This list is from three to six elements (or more) long and exhaustively
18858 describes the group.
18859
18860 Here are two example group infos; one is a very simple group while the
18861 second is a more complex one:
18862
18863 @example
18864 ("no.group" 5 (1 . 54324))
18865
18866 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
18867                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
18868                 (nnml "")
18869                 (auto-expire (to-address "ding@@gnus.org")))
18870 @end example
18871
18872 The first element is the @dfn{group name}---as Gnus knows the group,
18873 anyway.  The second element is the @dfn{subscription level}, which
18874 normally is a small integer.  (It can also be the @dfn{rank}, which is a
18875 cons cell where the @code{car} is the level and the @code{cdr} is the
18876 score.)  The third element is a list of ranges of read articles.  The
18877 fourth element is a list of lists of article marks of various kinds.
18878 The fifth element is the select method (or virtual server, if you like).
18879 The sixth element is a list of @dfn{group parameters}, which is what
18880 this section is about.
18881
18882 Any of the last three elements may be missing if they are not required.
18883 In fact, the vast majority of groups will normally only have the first
18884 three elements, which saves quite a lot of cons cells.
18885
18886 Here's a BNF definition of the group info format:
18887
18888 @example
18889 info          = "(" group space ralevel space read 
18890                 [ "" / [ space marks-list [ "" / [ space method [ "" /
18891                 space parameters ] ] ] ] ] ")" 
18892 group         = quote <string> quote
18893 ralevel       = rank / level
18894 level         = <integer in the range of 1 to inf>
18895 rank          = "(" level "." score ")"
18896 score         = <integer in the range of 1 to inf>
18897 read          = range
18898 marks-lists   = nil / "(" *marks ")"
18899 marks         = "(" <string> range ")"
18900 method        = "(" <string> *elisp-forms ")"
18901 parameters    = "(" *elisp-forms ")"
18902 @end example
18903
18904 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
18905 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
18906 in pseudo-BNF.
18907
18908 If you have a Gnus info and want to access the elements, Gnus offers a
18909 series of macros for getting/setting these elements.
18910
18911 @table @code
18912 @item gnus-info-group
18913 @itemx gnus-info-set-group
18914 @findex gnus-info-group
18915 @findex gnus-info-set-group
18916 Get/set the group name.
18917
18918 @item gnus-info-rank
18919 @itemx gnus-info-set-rank
18920 @findex gnus-info-rank
18921 @findex gnus-info-set-rank
18922 Get/set the group rank (@pxref{Group Score}).
18923
18924 @item gnus-info-level
18925 @itemx gnus-info-set-level
18926 @findex gnus-info-level
18927 @findex gnus-info-set-level
18928 Get/set the group level.
18929
18930 @item gnus-info-score
18931 @itemx gnus-info-set-score
18932 @findex gnus-info-score
18933 @findex gnus-info-set-score
18934 Get/set the group score (@pxref{Group Score}).
18935
18936 @item gnus-info-read
18937 @itemx gnus-info-set-read
18938 @findex gnus-info-read
18939 @findex gnus-info-set-read
18940 Get/set the ranges of read articles.
18941
18942 @item gnus-info-marks
18943 @itemx gnus-info-set-marks
18944 @findex gnus-info-marks
18945 @findex gnus-info-set-marks
18946 Get/set the lists of ranges of marked articles.
18947
18948 @item gnus-info-method
18949 @itemx gnus-info-set-method
18950 @findex gnus-info-method
18951 @findex gnus-info-set-method
18952 Get/set the group select method.
18953
18954 @item gnus-info-params
18955 @itemx gnus-info-set-params
18956 @findex gnus-info-params
18957 @findex gnus-info-set-params
18958 Get/set the group parameters.
18959 @end table
18960
18961 All the getter functions take one parameter---the info list.  The setter
18962 functions take two parameters---the info list and the new value.
18963
18964 The last three elements in the group info aren't mandatory, so it may be
18965 necessary to extend the group info before setting the element.  If this
18966 is necessary, you can just pass on a non-@code{nil} third parameter to
18967 the three final setter functions to have this happen automatically.
18968
18969
18970 @node Extended Interactive
18971 @subsection Extended Interactive
18972 @cindex interactive
18973 @findex gnus-interactive
18974
18975 Gnus extends the standard Emacs @code{interactive} specification
18976 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
18977 Prefixes}).  Here's an example of how this is used:
18978
18979 @lisp
18980 (defun gnus-summary-increase-score (&optional score symp)
18981   (interactive (gnus-interactive "P\ny"))
18982   ...
18983   )
18984 @end lisp
18985
18986 The best thing to do would have been to implement
18987 @code{gnus-interactive} as a macro which would have returned an
18988 @code{interactive} form, but this isn't possible since Emacs checks
18989 whether a function is interactive or not by simply doing an @code{assq}
18990 on the lambda form.  So, instead we have @code{gnus-interactive}
18991 function that takes a string and returns values that are usable to
18992 @code{interactive}.
18993
18994 This function accepts (almost) all normal @code{interactive} specs, but
18995 adds a few more.
18996
18997 @table @samp
18998 @item y
18999 @vindex gnus-current-prefix-symbol
19000 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
19001 variable.
19002
19003 @item Y
19004 @vindex gnus-current-prefix-symbols
19005 A list of the current symbolic prefixes---the
19006 @code{gnus-current-prefix-symbol} variable.
19007
19008 @item A
19009 The current article number---the @code{gnus-summary-article-number}
19010 function. 
19011
19012 @item H
19013 The current article header---the @code{gnus-summary-article-header}
19014 function. 
19015
19016 @item g
19017 The current group name---the @code{gnus-group-group-name}
19018 function. 
19019
19020 @end table
19021
19022
19023 @node Emacs/XEmacs Code
19024 @subsection Emacs/XEmacs Code
19025 @cindex XEmacs
19026 @cindex Emacsen
19027
19028 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
19029 platforms must be the primary one.  I chose Emacs.  Not because I don't
19030 like XEmacs or Mule, but because it comes first alphabetically.
19031
19032 This means that Gnus will byte-compile under Emacs with nary a warning,
19033 while XEmacs will pump out gigabytes of warnings while byte-compiling.
19034 As I use byte-compilation warnings to help me root out trivial errors in
19035 Gnus, that's very useful.  
19036
19037 I've also consistently used Emacs function interfaces, but have used
19038 Gnusey aliases for the functions.  To take an example:  Emacs defines a
19039 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
19040 function.  I then define a function called @code{gnus-run-at-time} that
19041 takes the same parameters as the Emacs @code{run-at-time}.  When running
19042 Gnus under Emacs, the former function is just an alias for the latter.
19043 However, when running under XEmacs, the former is an alias for the
19044 following function:
19045
19046 @lisp
19047 (defun gnus-xmas-run-at-time (time repeat function &rest args)
19048   (start-itimer
19049    "gnus-run-at-time"
19050    `(lambda ()
19051       (,function ,@@args))
19052    time repeat))
19053 @end lisp
19054
19055 This sort of thing has been done for bunches of functions.  Gnus does
19056 not redefine any native Emacs functions while running under XEmacs---it
19057 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
19058 all over.
19059
19060 In the cases where the XEmacs function interface was obviously cleaner,
19061 I used it instead.  For example @code{gnus-region-active-p} is an alias
19062 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
19063
19064 Of course, I could have chosen XEmacs as my native platform and done
19065 mapping functions the other way around.  But I didn't.  The performance
19066 hit these indirections impose on Gnus under XEmacs should be slight.
19067
19068
19069 @node Various File Formats
19070 @subsection Various File Formats
19071
19072 @menu
19073 * Active File Format::      Information on articles and groups available.
19074 * Newsgroups File Format::  Group descriptions.
19075 @end menu
19076
19077
19078 @node Active File Format
19079 @subsubsection Active File Format
19080
19081 The active file lists all groups available on the server in
19082 question.  It also lists the highest and lowest current article numbers
19083 in each group.  
19084
19085 Here's an excerpt from a typical active file:
19086
19087 @example
19088 soc.motss 296030 293865 y
19089 alt.binaries.pictures.fractals 3922 3913 n
19090 comp.sources.unix 1605 1593 m
19091 comp.binaries.ibm.pc 5097 5089 y
19092 no.general 1000 900 y
19093 @end example
19094
19095 Here's a pseudo-BNF definition of this file:
19096
19097 @example
19098 active      = *group-line
19099 group-line  = group space high-number space low-number space flag <NEWLINE>
19100 group       = <non-white-space string>
19101 space       = " "
19102 high-number = <non-negative integer>
19103 low-number  = <positive integer>
19104 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
19105 @end example
19106
19107 For a full description of this file, see the manual pages for
19108 @samp{innd}, in particular @samp{active(5)}.
19109
19110
19111 @node Newsgroups File Format
19112 @subsubsection Newsgroups File Format
19113
19114 The newsgroups file lists groups along with their descriptions.  Not all
19115 groups on the server have to be listed,  and not all groups in the file
19116 have to exist on the server.  The file is meant purely as information to
19117 the user.
19118
19119 The format is quite simple; a group name, a tab, and the description.
19120 Here's the definition:
19121
19122 @example
19123 newsgroups    = *line
19124 line          = group tab description <NEWLINE>
19125 group         = <non-white-space string>
19126 tab           = <TAB>
19127 description   = <string>
19128 @end example
19129
19130
19131 @page
19132 @node Emacs for Heathens
19133 @section Emacs for Heathens
19134
19135 Believe it or not, but some people who use Gnus haven't really used
19136 Emacs much before they embarked on their journey on the Gnus Love Boat.
19137 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
19138 region'', and ``set @code{gnus-flargblossen} to an alist where the key
19139 is a regexp that is used for matching on the group name'' are magical
19140 phrases with little or no meaning, then this appendix is for you.  If
19141 you are already familiar with Emacs, just ignore this and go fondle your
19142 cat instead.
19143
19144 @menu
19145 * Keystrokes::      Entering text and executing commands.
19146 * Emacs Lisp::      The built-in Emacs programming language.
19147 @end menu
19148
19149
19150 @node Keystrokes
19151 @subsection Keystrokes
19152
19153 @itemize @bullet
19154 @item
19155 Q: What is an experienced Emacs user?
19156
19157 @item 
19158 A: A person who wishes that the terminal had pedals.
19159 @end itemize
19160
19161 Yes, when you use Emacs, you are apt to use the control key, the shift
19162 key and the meta key a lot.  This is very annoying to some people
19163 (notably @code{vi}le users), and the rest of us just love the hell out
19164 of it.  Just give up and submit.  Emacs really does stand for
19165 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
19166 may have heard from other disreputable sources (like the Emacs author).
19167
19168 The shift keys are normally located near your pinky fingers, and are
19169 normally used to get capital letters and stuff.  You probably use it all
19170 the time.  The control key is normally marked ``CTRL'' or something like
19171 that.  The meta key is, funnily enough, never marked as such on any
19172 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
19173 which is the meta key on this keyboard.  It's usually located somewhere
19174 to the left hand side of the keyboard, usually on the bottom row.
19175
19176 Now, us Emacs people don't say ``press the meta-control-m key'',
19177 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
19178 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
19179 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
19180 down the control key, and hold it down while you press @kbd{k}''.
19181 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
19182 the control key and then press @kbd{k}''.  Simple, ay?
19183
19184 This is somewhat complicated by the fact that not all keyboards have a
19185 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
19186 means ``press escape, release escape, press @kbd{k}''.  That's much more
19187 work than if you have a meta key, so if that's the case, I respectfully
19188 suggest you get a real keyboard with a meta key.  You can't live without
19189 it.
19190
19191
19192
19193 @node Emacs Lisp
19194 @subsection Emacs Lisp
19195
19196 Emacs is the King of Editors because it's really a Lisp interpreter.
19197 Each and every key you tap runs some Emacs Lisp code snippet, and since
19198 Emacs Lisp is an interpreted language, that means that you can configure
19199 any key to run any arbitrary code.  You just, like, do it.
19200
19201 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
19202 functions.  (These are byte-compiled for speed, but it's still
19203 interpreted.)  If you decide that you don't like the way Gnus does
19204 certain things, it's trivial to have it do something a different way.
19205 (Well, at least if you know how to write Lisp code.)  However, that's
19206 beyond the scope of this manual, so we are simply going to talk about
19207 some common constructs that you normally use in your @file{.emacs} file
19208 to customize Gnus.
19209
19210 If you want to set the variable @code{gnus-florgbnize} to four (4), you
19211 write the following:
19212
19213 @lisp
19214 (setq gnus-florgbnize 4)
19215 @end lisp
19216
19217 This function (really ``special form'') @code{setq} is the one that can
19218 set a variable to some value.  This is really all you need to know.  Now
19219 you can go and fill your @code{.emacs} file with lots of these to change
19220 how Gnus works.
19221
19222 If you have put that thing in your @code{.emacs} file, it will be read
19223 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
19224 start Emacs.  If you want to change the variable right away, simply say
19225 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
19226 previous ``form'', which is a simple @code{setq} statement here.
19227
19228 Go ahead---just try it, if you're located at your Emacs.  After you
19229 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
19230 is the return value of the form you @code{eval}ed.
19231
19232 Some pitfalls:
19233
19234 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
19235 that means:
19236
19237 @lisp
19238 (setq gnus-read-active-file 'some)
19239 @end lisp
19240
19241 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
19242 @samp{nntp.ifi.uio.no}'', that means:
19243
19244 @lisp
19245 (setq gnus-nntp-server "nntp.ifi.uio.no")
19246 @end lisp
19247
19248 So be careful not to mix up strings (the latter) with symbols (the
19249 former).  The manual is unambiguous, but it can be confusing.
19250
19251 @page
19252 @include gnus-faq.texi
19253
19254 @node Index
19255 @chapter Index
19256 @printindex cp
19257
19258 @node Key Index
19259 @chapter Key Index
19260 @printindex ky
19261
19262 @summarycontents
19263 @contents
19264 @bye
19265
19266 @iftex
19267 @iflatex
19268 \end{document}
19269 @end iflatex
19270 @end iftex
19271
19272 @c End:
19273