Importing gnus-5.6.39
[elisp/gnus.git-] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Gnus 5.6.33 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @c @direntry
9 @c * Gnus: (gnus).         The newsreader Gnus.
10 @c @end direntry
11 @iftex
12 @finalout
13 @end iftex
14 @setchapternewpage odd
15
16 @iftex
17 @iflatex
18 \documentclass[twoside,a4paper,openright,11pt]{book}
19 \usepackage[latin1]{inputenc}
20 \usepackage{pagestyle}
21 \usepackage{epsfig}
22 \usepackage{bembo}
23 \usepackage{pixidx}
24
25 \makeindex
26 \begin{document}
27
28 \newcommand{\gnuschaptername}{}
29 \newcommand{\gnussectionname}{}
30
31 \newcommand{\gnusbackslash}{/}
32
33 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
34 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
35
36 \newcommand{\gnuskindex}[1]{\index{#1}}
37 \newcommand{\gnusindex}[1]{\index{#1}}
38
39 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
40 \newcommand{\gnuscode}[1]{\gnustt{#1}}
41 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
42 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
43 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusdfn}[1]{\textit{#1}}
46 \newcommand{\gnusi}[1]{\textit{#1}}
47 \newcommand{\gnusstrong}[1]{\textbf{#1}}
48 \newcommand{\gnusemph}[1]{\textit{#1}}
49 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
50 \newcommand{\gnussc}[1]{\textsc{#1}}
51 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
52 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
53
54 \newcommand{\gnusbullet}{{${\bullet}$}}
55 \newcommand{\gnusdollar}{\$}
56 \newcommand{\gnusampersand}{\&}
57 \newcommand{\gnuspercent}{\%}
58 \newcommand{\gnushash}{\#}
59 \newcommand{\gnushat}{\symbol{"5E}}
60 \newcommand{\gnusunderline}{\symbol{"5F}}
61 \newcommand{\gnusnot}{$\neg$}
62 \newcommand{\gnustilde}{\symbol{"7E}}
63 \newcommand{\gnusless}{{$<$}}
64 \newcommand{\gnusgreater}{{$>$}}
65 \newcommand{\gnusbraceleft}{{$>$}}
66 \newcommand{\gnusbraceright}{{$>$}}
67
68 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
69 \newcommand{\gnusinteresting}{
70 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
71 }
72
73 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
74
75 \newcommand{\gnuspagechapter}[1]{
76 {\mbox{}}
77 }
78
79 \newdimen{\gnusdimen}
80 \gnusdimen 0pt
81
82 \newcommand{\gnuschapter}[2]{
83 \gnuscleardoublepage
84 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
85 \chapter{#2}
86 \renewcommand{\gnussectionname}{}
87 \renewcommand{\gnuschaptername}{#2}
88 \thispagestyle{empty}
89 \hspace*{-2cm}
90 \begin{picture}(500,500)(0,0)
91 \put(480,350){\makebox(0,0)[tr]{#1}}
92 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
93 \end{picture}
94 \clearpage
95 }
96
97 \newcommand{\gnusfigure}[3]{
98 \begin{figure}
99 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
100 #3
101 \end{picture}
102 \caption{#1}
103 \end{figure}
104 }
105
106 \newcommand{\gnusicon}[1]{
107 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
108 }
109
110 \newcommand{\gnuspicon}[1]{
111 \margindex{\epsfig{figure=#1,width=2cm}}
112 }
113
114 \newcommand{\gnusxface}[2]{
115 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
116 }
117
118 \newcommand{\gnussmiley}[2]{
119 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
120 }
121
122 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
123
124 \newcommand{\gnussection}[1]{
125 \renewcommand{\gnussectionname}{#1}
126 \section{#1}
127 }
128
129 \newenvironment{codelist}%
130 {\begin{list}{}{
131 }
132 }{\end{list}}
133
134 \newenvironment{kbdlist}%
135 {\begin{list}{}{
136 \labelwidth=0cm
137 }
138 }{\end{list}}
139
140 \newenvironment{dfnlist}%
141 {\begin{list}{}{
142 }
143 }{\end{list}}
144
145 \newenvironment{stronglist}%
146 {\begin{list}{}{
147 }
148 }{\end{list}}
149
150 \newenvironment{samplist}%
151 {\begin{list}{}{
152 }
153 }{\end{list}}
154
155 \newenvironment{varlist}%
156 {\begin{list}{}{
157 }
158 }{\end{list}}
159
160 \newenvironment{emphlist}%
161 {\begin{list}{}{
162 }
163 }{\end{list}}
164
165 \newlength\gnusheadtextwidth
166 \setlength{\gnusheadtextwidth}{\headtextwidth}
167 \addtolength{\gnusheadtextwidth}{1cm}
168
169 \newpagestyle{gnuspreamble}%
170 {
171 {
172 \ifodd\count0
173 {
174 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
175 }
176 \else
177 {
178 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
179 }
180 }
181 \fi
182 }
183 }
184 {
185 \ifodd\count0
186 \mbox{} \hfill
187 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
188 \else
189 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
190 \hfill \mbox{}
191 \fi
192 }
193
194 \newpagestyle{gnusindex}%
195 {
196 {
197 \ifodd\count0
198 {
199 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
200 }
201 \else
202 {
203 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
204 }
205 \fi
206 }
207 }
208 {
209 \ifodd\count0
210 \mbox{} \hfill
211 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
212 \else
213 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
214 \hfill \mbox{}
215 \fi
216 }
217
218 \newpagestyle{gnus}%
219 {
220 {
221 \ifodd\count0
222 {
223 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
224 }
225 \else
226 {
227 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
228 }
229 \fi
230 }
231 }
232 {
233 \ifodd\count0
234 \mbox{} \hfill
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
236 \else
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
238 \hfill \mbox{}
239 \fi
240 }
241
242 \pagenumbering{roman}
243 \pagestyle{gnuspreamble}
244
245 @end iflatex
246 @end iftex
247
248 @iftex
249 @iflatex
250 \begin{titlepage}
251 {
252
253 %\addtolength{\oddsidemargin}{-5cm}
254 %\addtolength{\evensidemargin}{-5cm}
255 \parindent=0cm
256 \addtolength{\textheight}{2cm}
257
258 \gnustitle{\gnustitlename}\\
259 \rule{15cm}{1mm}\\
260 \vfill
261 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
262 \vfill
263 \rule{15cm}{1mm}\\
264 \gnusauthor{by Lars Magne Ingebrigtsen}
265 \newpage
266 }
267
268 \mbox{}
269 \vfill
270
271 \thispagestyle{empty}
272
273 Copyright \copyright{} 1995,96,97 Free Software Foundation, Inc.
274
275 Permission is granted to make and distribute verbatim copies of
276 this manual provided the copyright notice and this permission notice
277 are preserved on all copies.
278
279 Permission is granted to copy and distribute modified versions of this
280 manual under the conditions for verbatim copying, provided that the
281 entire resulting derived work is distributed under the terms of a
282 permission notice identical to this one.
283
284 Permission is granted to copy and distribute translations of this manual
285 into another language, under the above conditions for modified versions.
286
287 \newpage
288 \end{titlepage}
289 @end iflatex
290 @end iftex
291
292 @ifinfo
293
294 This file documents Gnus, the GNU Emacs newsreader.
295
296 Copyright (C) 1995,96 Free Software Foundation, Inc.
297
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
301
302 @ignore
303 Permission is granted to process this file through Tex and print the
304 results, provided the printed document carries copying permission
305 notice identical to this one except for the removal of this paragraph
306 (this paragraph not being relevant to the printed manual).
307
308 @end ignore
309 Permission is granted to copy and distribute modified versions of this
310 manual under the conditions for verbatim copying, provided also that the
311 entire resulting derived work is distributed under the terms of a
312 permission notice identical to this one.
313
314 Permission is granted to copy and distribute translations of this manual
315 into another language, under the above conditions for modified versions.
316 @end ifinfo
317
318 @tex
319
320 @titlepage
321 @title Gnus 5.6.33 Manual
322
323 @author by Lars Magne Ingebrigtsen
324 @page
325
326 @vskip 0pt plus 1filll
327 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc.
328
329 Permission is granted to make and distribute verbatim copies of
330 this manual provided the copyright notice and this permission notice
331 are preserved on all copies.
332
333 Permission is granted to copy and distribute modified versions of this
334 manual under the conditions for verbatim copying, provided that the
335 entire resulting derived work is distributed under the terms of a
336 permission notice identical to this one.
337
338 Permission is granted to copy and distribute translations of this manual
339 into another language, under the above conditions for modified versions.
340
341 @end titlepage
342 @page
343
344 @end tex
345
346
347 @node Top
348 @top The Gnus Newsreader
349
350 @ifinfo
351
352 You can read news (and mail) from within Emacs by using Gnus.  The news
353 can be gotten by any nefarious means you can think of---@sc{nntp}, local
354 spool or your mbox file.  All at the same time, if you want to push your
355 luck.
356
357 This manual corresponds to Gnus 5.6.33.
358
359 @end ifinfo
360
361 @iftex
362
363 @iflatex
364 \tableofcontents
365 \gnuscleardoublepage
366 @end iflatex
367
368 Gnus is the advanced, self-documenting, customizable, extensible
369 unreal-time newsreader for GNU Emacs.
370
371 Oops.  That sounds oddly familiar, so let's start over again to avoid
372 being accused of plagiarism:
373
374 Gnus is a message-reading laboratory.  It will let you look at just
375 about anything as if it were a newsgroup.  You can read mail with it,
376 you can browse directories with it, you can @code{ftp} with it---you can
377 even read news with it!
378
379 Gnus tries to empower people who read news the same way Emacs empowers
380 people who edit text.  Gnus sets no limits to what the user should be
381 allowed to do.  Users are encouraged to extend Gnus to make it behave
382 like they want it to behave.  A program should not control people;
383 people should be empowered to do what they want by using (or abusing)
384 the program.
385
386 @end iftex
387
388
389 @menu
390 * Starting Up::           Finding news can be a pain.
391 * The Group Buffer::      Selecting, subscribing and killing groups.
392 * The Summary Buffer::    Reading, saving and posting articles.
393 * The Article Buffer::    Displaying and handling articles.
394 * Composing Messages::    Information on sending mail and news.
395 * Select Methods::        Gnus reads all messages from various select methods.
396 * Scoring::               Assigning values to articles.
397 * Various::               General purpose settings.
398 * The End::               Farewell and goodbye.
399 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
400 * Index::                 Variable, function and concept index.
401 * Key Index::             Key Index.
402 @end menu
403
404 @node Starting Up
405 @chapter Starting Gnus
406 @cindex starting up
407
408 @kindex M-x gnus
409 @findex gnus
410 If your system administrator has set things up properly, starting Gnus
411 and reading news is extremely easy---you just type @kbd{M-x gnus} in
412 your Emacs.
413
414 @findex gnus-other-frame
415 @kindex M-x gnus-other-frame
416 If you want to start Gnus in a different frame, you can use the command
417 @kbd{M-x gnus-other-frame} instead.
418
419 If things do not go smoothly at startup, you have to twiddle some
420 variables in your @file{~/.gnus} file.  This file is similar to
421 @file{~/.emacs}, but is read when gnus starts.
422
423 If you puzzle at any terms used in this manual, please refer to the
424 terminology section (@pxref{Terminology}).
425
426 @menu
427 * Finding the News::    Choosing a method for getting news.
428 * The First Time::      What does Gnus do the first time you start it?
429 * The Server is Down::  How can I read my mail then?
430 * Slave Gnusae::        You can have more than one Gnus active at a time.
431 * Fetching a Group::    Starting Gnus just to read a group.
432 * New Groups::          What is Gnus supposed to do with new groups?
433 * Startup Files::       Those pesky startup files---@file{.newsrc}.
434 * Auto Save::           Recovering from a crash.
435 * The Active File::     Reading the active file over a slow line Takes Time.
436 * Changing Servers::    You may want to move from one server to another.
437 * Startup Variables::   Other variables you might change.
438 @end menu
439
440
441 @node Finding the News
442 @section Finding the News
443 @cindex finding news
444
445 @vindex gnus-select-method
446 @c @head
447 The @code{gnus-select-method} variable says where Gnus should look for
448 news.  This variable should be a list where the first element says
449 @dfn{how} and the second element says @dfn{where}.  This method is your
450 native method.  All groups not fetched with this method are
451 foreign groups.
452
453 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
454 you want to get your daily dosage of news from, you'd say:
455
456 @lisp
457 (setq gnus-select-method '(nntp "news.somewhere.edu"))
458 @end lisp
459
460 If you want to read directly from the local spool, say:
461
462 @lisp
463 (setq gnus-select-method '(nnspool ""))
464 @end lisp
465
466 If you can use a local spool, you probably should, as it will almost
467 certainly be much faster.
468
469 @vindex gnus-nntpserver-file
470 @cindex NNTPSERVER
471 @cindex @sc{nntp} server
472 If this variable is not set, Gnus will take a look at the
473 @code{NNTPSERVER} environment variable.  If that variable isn't set,
474 Gnus will see whether @code{gnus-nntpserver-file}
475 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
476 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
477
478 @vindex gnus-nntp-server
479 If @code{gnus-nntp-server} is set, this variable will override
480 @code{gnus-select-method}.  You should therefore set
481 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
482
483 @vindex gnus-secondary-servers
484 You can also make Gnus prompt you interactively for the name of an
485 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
486 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
487 in the @code{gnus-secondary-servers} list (if any).  You can also just
488 type in the name of any server you feel like visiting.
489
490 @findex gnus-group-browse-foreign-server
491 @kindex B (Group)
492 However, if you use one @sc{nntp} server regularly and are just
493 interested in a couple of groups from a different server, you would be
494 better served by using the @kbd{B} command in the group buffer.  It will
495 let you have a look at what groups are available, and you can subscribe
496 to any of the groups you want to.  This also makes @file{.newsrc}
497 maintenance much tidier.  @xref{Foreign Groups}.
498
499 @vindex gnus-secondary-select-methods
500 @c @head
501 A slightly different approach to foreign groups is to set the
502 @code{gnus-secondary-select-methods} variable.  The select methods
503 listed in this variable are in many ways just as native as the
504 @code{gnus-select-method} server.  They will also be queried for active
505 files during startup (if that's required), and new newsgroups that
506 appear on these servers will be subscribed (or not) just as native
507 groups are.
508
509 For instance, if you use the @code{nnmbox} backend to read your mail, you
510 would typically set this variable to
511
512 @lisp
513 (setq gnus-secondary-select-methods '((nnmbox "")))
514 @end lisp
515
516
517 @node The First Time
518 @section The First Time
519 @cindex first time usage
520
521 If no startup files exist, Gnus will try to determine what groups should
522 be subscribed by default.
523
524 @vindex gnus-default-subscribed-newsgroups
525 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
526 will subscribe you to just those groups in that list, leaving the rest
527 killed.  Your system administrator should have set this variable to
528 something useful.
529
530 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
531 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
532 here as @dfn{whatever Lars thinks you should read}.)
533
534 You'll also be subscribed to the Gnus documentation group, which should
535 help you with most common problems.
536
537 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
538 use the normal functions for handling new groups, and not do anything
539 special.
540
541
542 @node The Server is Down
543 @section The Server is Down
544 @cindex server errors
545
546 If the default server is down, Gnus will understandably have some
547 problems starting.  However, if you have some mail groups in addition to
548 the news groups, you may want to start Gnus anyway.
549
550 Gnus, being the trusting sort of program, will ask whether to proceed
551 without a native select method if that server can't be contacted.  This
552 will happen whether the server doesn't actually exist (i.e., you have
553 given the wrong address) or the server has just momentarily taken ill
554 for some reason or other.  If you decide to continue and have no foreign
555 groups, you'll find it difficult to actually do anything in the group
556 buffer.  But, hey, that's your problem.  Blllrph!
557
558 @findex gnus-no-server
559 @kindex M-x gnus-no-server
560 @c @head
561 If you know that the server is definitely down, or you just want to read
562 your mail without bothering with the server at all, you can use the
563 @code{gnus-no-server} command to start Gnus.  That might come in handy
564 if you're in a hurry as well.  This command will not attempt to contact
565 your primary server---instead, it will just activate all groups on level
566 1 and 2.  (You should preferably keep no native groups on those two
567 levels.)
568
569
570 @node Slave Gnusae
571 @section Slave Gnusae
572 @cindex slave
573
574 You might want to run more than one Emacs with more than one Gnus at the
575 same time.  If you are using different @file{.newsrc} files (e.g., if you
576 are using the two different Gnusae to read from two different servers),
577 that is no problem whatsoever.  You just do it.
578
579 The problem appears when you want to run two Gnusae that use the same
580 @code{.newsrc} file.
581
582 To work around that problem some, we here at the Think-Tank at the Gnus
583 Towers have come up with a new concept: @dfn{Masters} and
584 @dfn{slaves}.  (We have applied for a patent on this concept, and have
585 taken out a copyright on those words.  If you wish to use those words in
586 conjunction with each other, you have to send $1 per usage instance to
587 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
588 Applications}) will be much more expensive, of course.)
589
590 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
591 however you do it).  Each subsequent slave Gnusae should be started with
592 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
593 files, but instead save @dfn{slave files} that contain information only
594 on what groups have been read in the slave session.  When a master Gnus
595 starts, it will read (and delete) these slave files, incorporating all
596 information from them.  (The slave files will be read in the sequence
597 they were created, so the latest changes will have precedence.)
598
599 Information from the slave files has, of course, precedence over the
600 information in the normal (i.e., master) @code{.newsrc} file.
601
602
603 @node Fetching a Group
604 @section Fetching a Group
605 @cindex fetching a group
606
607 @findex gnus-fetch-group
608 It is sometimes convenient to be able to just say ``I want to read this
609 group and I don't care whether Gnus has been started or not''.  This is
610 perhaps more useful for people who write code than for users, but the
611 command @code{gnus-fetch-group} provides this functionality in any case.
612 It takes the group name as a parameter.
613
614
615 @node New Groups
616 @section New Groups
617 @cindex new groups
618 @cindex subscription
619
620 @vindex gnus-check-new-newsgroups
621 If you are satisfied that you really never want to see any new groups,
622 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
623 also save you some time at startup.  Even if this variable is
624 @code{nil}, you can always subscribe to the new groups just by pressing
625 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
626 is @code{ask-server} by default.  If you set this variable to
627 @code{always}, then Gnus will query the backends for new groups even
628 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
629
630 @menu
631 * Checking New Groups::      Determining what groups are new.
632 * Subscription Methods::     What Gnus should do with new groups.
633 * Filtering New Groups::     Making Gnus ignore certain new groups.
634 @end menu
635
636
637 @node Checking New Groups
638 @subsection Checking New Groups
639
640 Gnus normally determines whether a group is new or not by comparing the
641 list of groups from the active file(s) with the lists of subscribed and
642 dead groups.  This isn't a particularly fast method.  If
643 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
644 server for new groups since the last time.  This is both faster and
645 cheaper.  This also means that you can get rid of the list of killed
646 groups altogether, so you may set @code{gnus-save-killed-list} to
647 @code{nil}, which will save time both at startup, at exit, and all over.
648 Saves disk space, too.  Why isn't this the default, then?
649 Unfortunately, not all servers support this command.
650
651 I bet I know what you're thinking now: How do I find out whether my
652 server supports @code{ask-server}?  No?  Good, because I don't have a
653 fail-safe answer.  I would suggest just setting this variable to
654 @code{ask-server} and see whether any new groups appear within the next
655 few days.  If any do, then it works.  If none do, then it doesn't
656 work.  I could write a function to make Gnus guess whether the server
657 supports @code{ask-server}, but it would just be a guess.  So I won't.
658 You could @code{telnet} to the server and say @code{HELP} and see
659 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
660 it does, then it might work.  (But there are servers that lists
661 @samp{NEWGROUPS} without supporting the function properly.)
662
663 This variable can also be a list of select methods.  If so, Gnus will
664 issue an @code{ask-server} command to each of the select methods, and
665 subscribe them (or not) using the normal methods.  This might be handy
666 if you are monitoring a few servers for new groups.  A side effect is
667 that startup will take much longer, so you can meditate while waiting.
668 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
669
670
671 @node Subscription Methods
672 @subsection Subscription Methods
673
674 @vindex gnus-subscribe-newsgroup-method
675 What Gnus does when it encounters a new group is determined by the
676 @code{gnus-subscribe-newsgroup-method} variable.
677
678 This variable should contain a function.  This function will be called
679 with the name of the new group as the only parameter.
680
681 Some handy pre-fab functions are:
682
683 @table @code
684
685 @item gnus-subscribe-zombies
686 @vindex gnus-subscribe-zombies
687 Make all new groups zombies.  This is the default.  You can browse the
688 zombies later (with @kbd{A z}) and either kill them all off properly
689 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
690
691 @item gnus-subscribe-randomly
692 @vindex gnus-subscribe-randomly
693 Subscribe all new groups in arbitrary order.  This really means that all
694 new groups will be added at ``the top'' of the group buffer.
695
696 @item gnus-subscribe-alphabetically
697 @vindex gnus-subscribe-alphabetically
698 Subscribe all new groups in alphabetical order.
699
700 @item gnus-subscribe-hierarchically
701 @vindex gnus-subscribe-hierarchically
702 Subscribe all new groups hierarchically.  The difference between this
703 function and @code{gnus-subscribe-alphabetically} is slight.
704 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
705 alphabetical fashion, while this function will enter groups into it's
706 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
707 @samp{comp} hierarchy, this function will not mess that configuration
708 up.  Or something like that.
709
710 @item gnus-subscribe-interactively
711 @vindex gnus-subscribe-interactively
712 Subscribe new groups interactively.  This means that Gnus will ask
713 you about @strong{all} new groups.  The groups you choose to subscribe
714 to will be subscribed hierarchically.
715
716 @item gnus-subscribe-killed
717 @vindex gnus-subscribe-killed
718 Kill all new groups.
719
720 @end table
721
722 @vindex gnus-subscribe-hierarchical-interactive
723 A closely related variable is
724 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
725 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
726 hierarchical fashion whether to subscribe to new groups or not.  Gnus
727 will ask you for each sub-hierarchy whether you want to descend the
728 hierarchy or not.
729
730 One common mistake is to set the variable a few paragraphs above
731 (@code{gnus-subscribe-newsgroup-method}) to
732 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
733 will not work.  This is ga-ga.  So don't do it.
734
735
736 @node Filtering New Groups
737 @subsection Filtering New Groups
738
739 A nice and portable way to control which new newsgroups should be
740 subscribed (or ignored) is to put an @dfn{options} line at the start of
741 the @file{.newsrc} file.  Here's an example:
742
743 @example
744 options -n !alt.all !rec.all sci.all
745 @end example
746
747 @vindex gnus-subscribe-options-newsgroup-method
748 This line obviously belongs to a serious-minded intellectual scientific
749 person (or she may just be plain old boring), because it says that all
750 groups that have names beginning with @samp{alt} and @samp{rec} should
751 be ignored, and all groups with names beginning with @samp{sci} should
752 be subscribed.  Gnus will not use the normal subscription method for
753 subscribing these groups.
754 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
755 variable defaults to @code{gnus-subscribe-alphabetically}.
756
757 @vindex gnus-options-not-subscribe
758 @vindex gnus-options-subscribe
759 If you don't want to mess with your @file{.newsrc} file, you can just
760 set the two variables @code{gnus-options-subscribe} and
761 @code{gnus-options-not-subscribe}.  These two variables do exactly the
762 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
763 and if the new group matches the former, it will be unconditionally
764 subscribed, and if it matches the latter, it will be ignored.
765
766 @vindex gnus-auto-subscribed-groups
767 Yet another variable that meddles here is
768 @code{gnus-auto-subscribed-groups}.  It works exactly like
769 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
770 thought it would be nice to have two of these.  This variable is more
771 meant for setting some ground rules, while the other variable is used
772 more for user fiddling.  By default this variable makes all new groups
773 that come from mail backends (@code{nnml}, @code{nnbabyl},
774 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
775 don't like that, just set this variable to @code{nil}.
776
777 New groups that match this regexp are subscribed using
778 @code{gnus-subscribe-options-newsgroup-method}.
779
780
781 @node Changing Servers
782 @section Changing Servers
783 @cindex changing servers
784
785 Sometimes it is necessary to move from one @sc{nntp} server to another.
786 This happens very rarely, but perhaps you change jobs, or one server is
787 very flaky and you want to use another.
788
789 Changing the server is pretty easy, right?  You just change
790 @code{gnus-select-method} to point to the new server?
791
792 @emph{Wrong!}
793
794 Article numbers are not (in any way) kept synchronized between different
795 @sc{nntp} servers, and the only way Gnus keeps track of what articles
796 you have read is by keeping track of article numbers.  So when you
797 change @code{gnus-select-method}, your @file{.newsrc} file becomes
798 worthless.
799
800 Gnus provides a few functions to attempt to translate a @file{.newsrc}
801 file from one server to another.  They all have one thing in
802 common---they take a looong time to run.  You don't want to use these
803 functions more than absolutely necessary.
804
805 @kindex M-x gnus-change-server
806 @findex gnus-change-server
807 If you have access to both servers, Gnus can request the headers for all
808 the articles you have read and compare @code{Message-ID}s and map the
809 article numbers of the read articles and article marks.  The @kbd{M-x
810 gnus-change-server} command will do this for all your native groups.  It
811 will prompt for the method you want to move to.
812
813 @kindex M-x gnus-group-move-group-to-server
814 @findex gnus-group-move-group-to-server
815 You can also move individual groups with the @kbd{M-x
816 gnus-group-move-group-to-server} command.  This is useful if you want to
817 move a (foreign) group from one server to another.
818
819 @kindex M-x gnus-group-clear-data-on-native-groups
820 @findex gnus-group-clear-data-on-native-groups
821 If you don't have access to both the old and new server, all your marks
822 and read ranges have become worthless.  You can use the @kbd{M-x
823 gnus-group-clear-data-on-native-groups} command to clear out all data
824 that you have on your native groups.  Use with caution.
825
826
827 @node Startup Files
828 @section Startup Files
829 @cindex startup files
830 @cindex .newsrc
831 @cindex .newsrc.el
832 @cindex .newsrc.eld
833
834 Now, you all know about the @file{.newsrc} file.  All subscription
835 information is traditionally stored in this file.
836
837 Things got a bit more complicated with @sc{gnus}.  In addition to
838 keeping the @file{.newsrc} file updated, it also used a file called
839 @file{.newsrc.el} for storing all the information that didn't fit into
840 the @file{.newsrc} file.  (Actually, it also duplicated everything in
841 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
842 files was the most recently saved, which enabled people to swap between
843 @sc{gnus} and other newsreaders.
844
845 That was kinda silly, so Gnus went one better: In addition to the
846 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
847 @file{.newsrc.eld}.  It will read whichever of these files that are most
848 recent, but it will never write a @file{.newsrc.el} file.  You should
849 never delete the @file{.newsrc.eld} file---it contains much information
850 not stored in the @file{.newsrc} file.
851
852 @vindex gnus-save-newsrc-file
853 You can turn off writing the @file{.newsrc} file by setting
854 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
855 the file and save some space, as well as exiting from Gnus faster.
856 However, this will make it impossible to use other newsreaders than
857 Gnus.  But hey, who would want to, right?
858
859 @vindex gnus-save-killed-list
860 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
861 will not save the list of killed groups to the startup file.  This will
862 save both time (when starting and quitting) and space (on disk).  It
863 will also mean that Gnus has no record of what groups are new or old,
864 so the automatic new groups subscription methods become meaningless.
865 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
866 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
867 Groups}).  This variable can also be a regular expression.  If that's
868 the case, remove all groups that do not match this regexp before
869 saving.  This can be useful in certain obscure situations that involve
870 several servers where not all servers support @code{ask-server}.
871
872 @vindex gnus-startup-file
873 The @code{gnus-startup-file} variable says where the startup files are.
874 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
875 file being whatever that one is, with a @samp{.eld} appended.
876
877 @vindex gnus-save-newsrc-hook
878 @vindex gnus-save-quick-newsrc-hook
879 @vindex gnus-save-standard-newsrc-hook
880 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
881 files, while @code{gnus-save-quick-newsrc-hook} is called just before
882 saving the @file{.newsrc.eld} file, and
883 @code{gnus-save-standard-newsrc-hook} is called just before saving the
884 @file{.newsrc} file.  The latter two are commonly used to turn version
885 control on or off.  Version control is on by default when saving the
886 startup files.  If you want to turn backup creation off, say something like:
887
888 @lisp
889 (defun turn-off-backup ()
890   (set (make-local-variable 'backup-inhibited) t))
891
892 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
893 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
894 @end lisp
895
896 @vindex gnus-init-file
897 When Gnus starts, it will read the @code{gnus-site-init-file}
898 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
899 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
900 and can be used to avoid cluttering your @file{~/.emacs} and
901 @file{site-init} files with Gnus stuff.  Gnus will also check for files
902 with the same names as these, but with @file{.elc} and @file{.el}
903 suffixes.  In other words, if you have set @code{gnus-init-file} to
904 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
905 and finally @file{~/.gnus} (in this order).
906
907
908
909 @node Auto Save
910 @section Auto Save
911 @cindex dribble file
912 @cindex auto-save
913
914 Whenever you do something that changes the Gnus data (reading articles,
915 catching up, killing/subscribing groups), the change is added to a
916 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
917 Emacs way.  If your Emacs should crash before you have saved the
918 @file{.newsrc} files, all changes you have made can be recovered from
919 this file.
920
921 If Gnus detects this file at startup, it will ask the user whether to
922 read it.  The auto save file is deleted whenever the real startup file is
923 saved.
924
925 @vindex gnus-use-dribble-file
926 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
927 maintain a dribble buffer.  The default is @code{t}.
928
929 @vindex gnus-dribble-directory
930 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
931 this variable is @code{nil}, which it is by default, Gnus will dribble
932 into the directory where the @file{.newsrc} file is located.  (This is
933 normally the user's home directory.)  The dribble file will get the same
934 file permissions as the @code{.newsrc} file.
935
936 @vindex gnus-always-read-dribble-file
937 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
938 read the dribble file on startup without querying the user.
939
940
941 @node The Active File
942 @section The Active File
943 @cindex active file
944 @cindex ignored groups
945
946 When Gnus starts, or indeed whenever it tries to determine whether new
947 articles have arrived, it reads the active file.  This is a very large
948 file that lists all the active groups and articles on the server.
949
950 @vindex gnus-ignored-newsgroups
951 Before examining the active file, Gnus deletes all lines that match the
952 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
953 any groups with bogus names, but you can use this variable to make Gnus
954 ignore hierarchies you aren't ever interested in.  However, this is not
955 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
956 Groups} for an overview of other variables that can be used instead.
957
958 @c This variable is
959 @c @code{nil} by default, and will slow down active file handling somewhat
960 @c if you set it to anything else.
961
962 @vindex gnus-read-active-file
963 @c @head
964 The active file can be rather Huge, so if you have a slow network, you
965 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
966 reading the active file.  This variable is @code{some} by default.
967
968 Gnus will try to make do by getting information just on the groups that
969 you actually subscribe to.
970
971 Note that if you subscribe to lots and lots of groups, setting this
972 variable to @code{nil} will probably make Gnus slower, not faster.  At
973 present, having this variable @code{nil} will slow Gnus down
974 considerably, unless you read news over a 2400 baud modem.
975
976 This variable can also have the value @code{some}.  Gnus will then
977 attempt to read active info only on the subscribed groups.  On some
978 servers this is quite fast (on sparkling, brand new INN servers that
979 support the @code{LIST ACTIVE group} command), on others this isn't fast
980 at all.  In any case, @code{some} should be faster than @code{nil}, and
981 is certainly faster than @code{t} over slow lines.
982
983 If this variable is @code{nil}, Gnus will ask for group info in total
984 lock-step, which isn't very fast.  If it is @code{some} and you use an
985 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
986 read all the replies in one swoop.  This will normally result in better
987 performance, but if the server does not support the aforementioned
988 @code{LIST ACTIVE group} command, this isn't very nice to the server.
989
990 In any case, if you use @code{some} or @code{nil}, you should definitely
991 kill all groups that you aren't interested in to speed things up.
992
993 Note that this variable also affects active file retrieval from
994 secondary select methods.
995
996
997 @node Startup Variables
998 @section Startup Variables
999
1000 @table @code
1001
1002 @item gnus-load-hook
1003 @vindex gnus-load-hook
1004 A hook run while Gnus is being loaded.  Note that this hook will
1005 normally be run just once in each Emacs session, no matter how many
1006 times you start Gnus.
1007
1008 @item gnus-before-startup-hook
1009 @vindex gnus-before-startup-hook
1010 A hook run after starting up Gnus successfully.
1011
1012 @item gnus-startup-hook
1013 @vindex gnus-startup-hook
1014 A hook run as the very last thing after starting up Gnus
1015
1016 @item gnus-started-hook
1017 @vindex gnus-started-hook
1018 A hook that is run as the very last thing after starting up Gnus
1019 successfully.
1020
1021 @item gnus-started-hook
1022 @vindex gnus-started-hook
1023 A hook that is run after reading the @file{.newsrc} file(s), but before
1024 generating the group buffer.
1025
1026 @item gnus-check-bogus-newsgroups
1027 @vindex gnus-check-bogus-newsgroups
1028 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1029 startup.  A @dfn{bogus group} is a group that you have in your
1030 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1031 bogus groups can take quite a while, so to save time and resources it's
1032 best to leave this option off, and do the checking for bogus groups once
1033 in a while from the group buffer instead (@pxref{Group Maintenance}).
1034
1035 @item gnus-inhibit-startup-message
1036 @vindex gnus-inhibit-startup-message
1037 If non-@code{nil}, the startup message won't be displayed.  That way,
1038 your boss might not notice as easily that you are reading news instead
1039 of doing your job.  Note that this variable is used before
1040 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1041
1042 @item gnus-no-groups-message
1043 @vindex gnus-no-groups-message
1044 Message displayed by Gnus when no groups are available.
1045
1046 @item gnus-play-startup-jingle
1047 @vindex gnus-play-startup-jingle
1048 If non-@code{nil}, play the Gnus jingle at startup.
1049
1050 @item gnus-startup-jingle
1051 @vindex gnus-startup-jingle
1052 Jingle to be played if the above variable is non-@code{nil}.  The
1053 default is @samp{Tuxedomoon.Jingle4.au}.
1054
1055 @end table
1056
1057
1058 @node The Group Buffer
1059 @chapter The Group Buffer
1060 @cindex group buffer
1061
1062 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1063 is the first buffer shown when Gnus starts, and will never be killed as
1064 long as Gnus is active.
1065
1066 @iftex
1067 @iflatex
1068 \gnusfigure{The Group Buffer}{320}{
1069 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1070 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1071 \put(120,38){\vector(1,2){10}}
1072 \put(40,60){\makebox(0,0)[r]{Mode line}}
1073 \put(40,58){\vector(1,0){30}}
1074 \put(200,28){\makebox(0,0)[t]{Native select method}}
1075 \put(200,26){\vector(-1,2){15}}
1076 }
1077 @end iflatex
1078 @end iftex
1079
1080 @menu
1081 * Group Buffer Format::    Information listed and how you can change it.
1082 * Group Maneuvering::      Commands for moving in the group buffer.
1083 * Selecting a Group::      Actually reading news.
1084 * Group Data::             Changing the info for a group.
1085 * Subscription Commands::  Unsubscribing, killing, subscribing.
1086 * Group Levels::           Levels? What are those, then?
1087 * Group Score::            A mechanism for finding out what groups you like.
1088 * Marking Groups::         You can mark groups for later processing.
1089 * Foreign Groups::         Creating and editing groups.
1090 * Group Parameters::       Each group may have different parameters set.
1091 * Listing Groups::         Gnus can list various subsets of the groups.
1092 * Sorting Groups::         Re-arrange the group order.
1093 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1094 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1095 * Exiting Gnus::           Stop reading news and get some work done.
1096 * Group Topics::           A folding group mode divided into topics.
1097 * Misc Group Stuff::       Other stuff that you can to do.
1098 @end menu
1099
1100
1101 @node Group Buffer Format
1102 @section Group Buffer Format
1103
1104 @menu
1105 * Group Line Specification::       Deciding how the group buffer is to look.
1106 * Group Modeline Specification::   The group buffer modeline.
1107 * Group Highlighting::             Having nice colors in the group buffer.
1108 @end menu
1109
1110
1111 @node Group Line Specification
1112 @subsection Group Line Specification
1113 @cindex group buffer format
1114
1115 The default format of the group buffer is nice and dull, but you can
1116 make it as exciting and ugly as you feel like.
1117
1118 Here's a couple of example group lines:
1119
1120 @example
1121      25: news.announce.newusers
1122  *    0: alt.fan.andrea-dworkin
1123 @end example
1124
1125 Quite simple, huh?
1126
1127 You can see that there are 25 unread articles in
1128 @samp{news.announce.newusers}.  There are no unread articles, but some
1129 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1130 asterisk at the beginning of the line?).
1131
1132 @vindex gnus-group-line-format
1133 You can change that format to whatever you want by fiddling with the
1134 @code{gnus-group-line-format} variable.  This variable works along the
1135 lines of a @code{format} specification, which is pretty much the same as
1136 a @code{printf} specifications, for those of you who use (feh!) C.
1137 @xref{Formatting Variables}.
1138
1139 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1140
1141 There should always be a colon on the line; the cursor always moves to
1142 the colon after performing an operation.  Nothing else is required---not
1143 even the group name.  All displayed text is just window dressing, and is
1144 never examined by Gnus.  Gnus stores all real information it needs using
1145 text properties.
1146
1147 (Note that if you make a really strange, wonderful, spreadsheet-like
1148 layout, everybody will believe you are hard at work with the accounting
1149 instead of wasting time reading news.)
1150
1151 Here's a list of all available format characters:
1152
1153 @table @samp
1154
1155 @item M
1156 An asterisk if the group only has marked articles.
1157
1158 @item S
1159 Whether the group is subscribed.
1160
1161 @item L
1162 Level of subscribedness.
1163
1164 @item N
1165 Number of unread articles.
1166
1167 @item I
1168 Number of dormant articles.
1169
1170 @item T
1171 Number of ticked articles.
1172
1173 @item R
1174 Number of read articles.
1175
1176 @item t
1177 Estimated total number of articles.  (This is really @var{max-number}
1178 minus @var{min-number} plus 1.)
1179
1180 @item y
1181 Number of unread, unticked, non-dormant articles.
1182
1183 @item i
1184 Number of ticked and dormant articles.
1185
1186 @item g
1187 Full group name.
1188
1189 @item G
1190 Group name.
1191
1192 @item D
1193 Newsgroup description.
1194
1195 @item o
1196 @samp{m} if moderated.
1197
1198 @item O
1199 @samp{(m)} if moderated.
1200
1201 @item s
1202 Select method.
1203
1204 @item n
1205 Select from where.
1206
1207 @item z
1208 A string that looks like @samp{<%s:%n>} if a foreign select method is
1209 used.
1210
1211 @item P
1212 Indentation based on the level of the topic (@pxref{Group Topics}).
1213
1214 @item c
1215 @vindex gnus-group-uncollapsed-levels
1216 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1217 variable says how many levels to leave at the end of the group name.
1218 The default is 1---this will mean that group names like
1219 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1220
1221 @item m
1222 @vindex gnus-new-mail-mark
1223 @cindex %
1224 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1225 the group lately.
1226
1227 @item d
1228 A string that says when you last read the group (@pxref{Group
1229 Timestamp}).
1230
1231 @item u
1232 User defined specifier.  The next character in the format string should
1233 be a letter.  Gnus will call the function
1234 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1235 following @samp{%u}.  The function will be passed a single dummy
1236 parameter as argument.  The function should return a string, which will
1237 be inserted into the buffer just like information from any other
1238 specifier.
1239 @end table
1240
1241 @cindex *
1242 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1243 if no info is available---for instance, if it is a non-activated foreign
1244 group, or a bogus native group.
1245
1246
1247 @node Group Modeline Specification
1248 @subsection Group Modeline Specification
1249 @cindex group modeline
1250
1251 @vindex gnus-group-mode-line-format
1252 The mode line can be changed by setting
1253 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1254 doesn't understand that many format specifiers:
1255
1256 @table @samp
1257 @item S
1258 The native news server.
1259 @item M
1260 The native select method.
1261 @end table
1262
1263
1264 @node Group Highlighting
1265 @subsection Group Highlighting
1266 @cindex highlighting
1267 @cindex group highlighting
1268
1269 @vindex gnus-group-highlight
1270 Highlighting in the group buffer is controlled by the
1271 @code{gnus-group-highlight} variable.  This is an alist with elements
1272 that look like @var{(form . face)}.  If @var{form} evaluates to
1273 something non-@code{nil}, the @var{face} will be used on the line.
1274
1275 Here's an example value for this variable that might look nice if the
1276 background is dark:
1277
1278 @lisp
1279 (face-spec-set 'my-group-face-1
1280                '((t (:foreground "Red" :bold t))))
1281 (face-spec-set 'my-group-face-2
1282                '((t (:foreground "SeaGreen" :bold t))))
1283 (face-spec-set 'my-group-face-3
1284                '((t (:foreground "SpringGreen" :bold t))))
1285 (face-spec-set 'my-group-face-4
1286                '((t (:foreground "SteelBlue" :bold t))))
1287 (face-spec-set 'my-group-face-5
1288                '((t (:foreground "SkyBlue" :bold t))))
1289
1290 (setq gnus-group-highlight
1291       '(((> unread 200) . my-group-face-1)
1292         ((and (< level 3) (zerop unread)) . my-group-face-2)
1293         ((< level 3) . my-group-face-3)
1294         ((zerop unread) . my-group-face-4)
1295         (t . my-group-face-5)))
1296 @end lisp
1297
1298 Also @pxref{Faces and Fonts}.
1299
1300 Variables that are dynamically bound when the forms are evaluated
1301 include:
1302
1303 @table @code
1304 @item group
1305 The group name.
1306 @item unread
1307 The number of unread articles in the group.
1308 @item method
1309 The select method.
1310 @item mailp
1311 Whether the group is a mail group.
1312 @item level
1313 The level of the group.
1314 @item score
1315 The score of the group.
1316 @item ticked
1317 The number of ticked articles in the group.
1318 @item total
1319 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1320 MIN-NUMBER plus one.
1321 @item topic
1322 When using the topic minor mode, this variable is bound to the current
1323 topic being inserted.
1324 @end table
1325
1326 When the forms are @code{eval}ed, point is at the beginning of the line
1327 of the group in question, so you can use many of the normal Gnus
1328 functions for snarfing info on the group.
1329
1330 @vindex gnus-group-update-hook
1331 @findex gnus-group-highlight-line
1332 @code{gnus-group-update-hook} is called when a group line is changed.
1333 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1334 calls @code{gnus-group-highlight-line} by default.
1335
1336
1337 @node Group Maneuvering
1338 @section Group Maneuvering
1339 @cindex group movement
1340
1341 All movement commands understand the numeric prefix and will behave as
1342 expected, hopefully.
1343
1344 @table @kbd
1345
1346 @item n
1347 @kindex n (Group)
1348 @findex gnus-group-next-unread-group
1349 Go to the next group that has unread articles
1350 (@code{gnus-group-next-unread-group}).
1351
1352 @item p
1353 @itemx DEL
1354 @kindex DEL (Group)
1355 @kindex p (Group)
1356 @findex gnus-group-prev-unread-group
1357 Go to the previous group that has unread articles
1358 (@code{gnus-group-prev-unread-group}).
1359
1360 @item N
1361 @kindex N (Group)
1362 @findex gnus-group-next-group
1363 Go to the next group (@code{gnus-group-next-group}).
1364
1365 @item P
1366 @kindex P (Group)
1367 @findex gnus-group-prev-group
1368 Go to the previous group (@code{gnus-group-prev-group}).
1369
1370 @item M-n
1371 @kindex M-n (Group)
1372 @findex gnus-group-next-unread-group-same-level
1373 Go to the next unread group on the same (or lower) level
1374 (@code{gnus-group-next-unread-group-same-level}).
1375
1376 @item M-p
1377 @kindex M-p (Group)
1378 @findex gnus-group-prev-unread-group-same-level
1379 Go to the previous unread group on the same (or lower) level
1380 (@code{gnus-group-prev-unread-group-same-level}).
1381 @end table
1382
1383 Three commands for jumping to groups:
1384
1385 @table @kbd
1386
1387 @item j
1388 @kindex j (Group)
1389 @findex gnus-group-jump-to-group
1390 Jump to a group (and make it visible if it isn't already)
1391 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1392 like living groups.
1393
1394 @item ,
1395 @kindex , (Group)
1396 @findex gnus-group-best-unread-group
1397 Jump to the unread group with the lowest level
1398 (@code{gnus-group-best-unread-group}).
1399
1400 @item .
1401 @kindex . (Group)
1402 @findex gnus-group-first-unread-group
1403 Jump to the first group with unread articles
1404 (@code{gnus-group-first-unread-group}).
1405 @end table
1406
1407 @vindex gnus-group-goto-unread
1408 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1409 commands will move to the next group, not the next unread group.  Even
1410 the commands that say they move to the next unread group.  The default
1411 is @code{t}.
1412
1413
1414 @node Selecting a Group
1415 @section Selecting a Group
1416 @cindex group selection
1417
1418 @table @kbd
1419
1420 @item SPACE
1421 @kindex SPACE (Group)
1422 @findex gnus-group-read-group
1423 Select the current group, switch to the summary buffer and display the
1424 first unread article (@code{gnus-group-read-group}).  If there are no
1425 unread articles in the group, or if you give a non-numerical prefix to
1426 this command, Gnus will offer to fetch all the old articles in this
1427 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1428 determines the number of articles Gnus will fetch.  If @var{N} is
1429 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1430 negative, Gnus fetches the @var{abs(N)} oldest articles.
1431
1432 @item RET
1433 @kindex RET (Group)
1434 @findex gnus-group-select-group
1435 Select the current group and switch to the summary buffer
1436 (@code{gnus-group-select-group}).  Takes the same arguments as
1437 @code{gnus-group-read-group}---the only difference is that this command
1438 does not display the first unread article automatically upon group
1439 entry.
1440
1441 @item M-RET
1442 @kindex M-RET (Group)
1443 @findex gnus-group-quick-select-group
1444 This does the same as the command above, but tries to do it with the
1445 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1446 scoring/killing will be performed, there will be no highlights and no
1447 expunging.  This might be useful if you're in a real hurry and have to
1448 enter some humongous group.  If you give a 0 prefix to this command
1449 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1450 which is useful if you want to toggle threading before generating the
1451 summary buffer (@pxref{Summary Generation Commands}).
1452
1453 @item M-SPACE
1454 @kindex M-SPACE (Group)
1455 @findex gnus-group-visible-select-group
1456 This is yet one more command that does the same as the @kbd{RET}
1457 command, but this one does it without expunging and hiding dormants
1458 (@code{gnus-group-visible-select-group}).
1459
1460 @item M-C-RET
1461 @kindex M-C-RET (Group)
1462 @findex gnus-group-select-group-ephemerally
1463 Finally, this command selects the current group ephemerally without
1464 doing any processing of its contents
1465 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1466 turned off.  Everything you do in the group after selecting it in this
1467 manner will have no permanent effects.
1468
1469 @end table
1470
1471 @vindex gnus-large-newsgroup
1472 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1473 to be a big group.  This is 200 by default.  If the group has more
1474 (unread and/or ticked) articles than this, Gnus will query the user
1475 before entering the group.  The user can then specify how many articles
1476 should be fetched from the server.  If the user specifies a negative
1477 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1478 is positive, the @code{n} articles that have arrived most recently will
1479 be fetched.
1480
1481 @vindex gnus-select-group-hook
1482 @vindex gnus-auto-select-first
1483 @code{gnus-auto-select-first} control whether any articles are selected
1484 automatically when entering a group with the @kbd{SPACE} command.
1485
1486 @table @code
1487
1488 @item nil
1489 Don't select any articles when entering the group.  Just display the
1490 full summary buffer.
1491
1492 @item t
1493 Select the first unread article when entering the group.
1494
1495 @item best
1496 Select the highest scored article in the group when entering the
1497 group.
1498 @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 u
1905 @kindex G u (Group)
1906 @vindex gnus-useful-groups
1907 @findex gnus-group-make-useful-group
1908 Create one of the groups mentioned in @code{gnus-useful-groups}
1909 (@code{gnus-group-make-useful-group}).
1910
1911 @item G w
1912 @kindex G w (Group)
1913 @findex gnus-group-make-web-group
1914 @cindex DejaNews
1915 @cindex Alta Vista
1916 @cindex InReference
1917 @cindex nnweb
1918 Make an ephemeral group based on a web search
1919 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1920 command, make a solid group instead.  You will be prompted for the
1921 search engine type and the search string.  Valid search engine types
1922 include @code{dejanews}, @code{altavista} and @code{reference}.
1923 @xref{Web Searches}.
1924
1925 If you use the @code{dejanews} search engine, you can limit the search
1926 to a particular group by using a match string like
1927 @samp{~g alt.sysadmin.recovery shaving}.
1928
1929 @item G DEL
1930 @kindex G DEL (Group)
1931 @findex gnus-group-delete-group
1932 This function will delete the current group
1933 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1934 actually delete all the articles in the group, and forcibly remove the
1935 group itself from the face of the Earth.  Use a prefix only if you are
1936 absolutely sure of what you are doing.  This command can't be used on
1937 read-only groups (like @code{nntp} group), though.
1938
1939 @item G V
1940 @kindex G V (Group)
1941 @findex gnus-group-make-empty-virtual
1942 Make a new, fresh, empty @code{nnvirtual} group
1943 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1944
1945 @item G v
1946 @kindex G v (Group)
1947 @findex gnus-group-add-to-virtual
1948 Add the current group to an @code{nnvirtual} group
1949 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1950 @end table
1951
1952 @xref{Select Methods} for more information on the various select
1953 methods.
1954
1955 @vindex gnus-activate-foreign-newsgroups
1956 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1957 Gnus will check all foreign groups with this level or lower at startup.
1958 This might take quite a while, especially if you subscribe to lots of
1959 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
1960 @code{gnus-activate-level} also affects activation of foreign
1961 newsgroups. 
1962
1963
1964 @node Group Parameters
1965 @section Group Parameters
1966 @cindex group parameters
1967
1968 The group parameters store information local to a particular group.
1969 Here's an example group parameter list:
1970
1971 @example
1972 ((to-address . "ding@@gnus.org")
1973  (auto-expire . t))
1974 @end example
1975
1976 We see that each element consists of a "dotted pair"---the thing before
1977 the dot is the key, while the thing after the dot is the value.  All the
1978 parameters have this form @emph{except} local variable specs, which are
1979 not dotted pairs, but proper lists.
1980
1981 The following group parameters can be used:
1982
1983 @table @code
1984 @item to-address
1985 @cindex to-address
1986 Address used by when doing followups and new posts.
1987
1988 @example
1989 (to-address .  "some@@where.com")
1990 @end example
1991
1992 This is primarily useful in mail groups that represent closed mailing
1993 lists---mailing lists where it's expected that everybody that writes to
1994 the mailing list is subscribed to it.  Since using this parameter
1995 ensures that the mail only goes to the mailing list itself, it means
1996 that members won't receive two copies of your followups.
1997
1998 Using @code{to-address} will actually work whether the group is foreign
1999 or not.  Let's say there's a group on the server that is called
2000 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2001 the articles from a mail-to-news gateway.  Posting directly to this
2002 group is therefore impossible---you have to send mail to the mailing
2003 list address instead.
2004
2005 @item to-list
2006 @cindex to-list
2007 Address used when doing a @kbd{a} in that group.
2008
2009 @example
2010 (to-list . "some@@where.com")
2011 @end example
2012
2013 It is totally ignored
2014 when doing a followup---except that if it is present in a news group,
2015 you'll get mail group semantics when doing @kbd{f}.
2016
2017 If you do an @kbd{a} command in a mail group and you have neither a
2018 @code{to-list} group parameter nor a @code{to-address} group parameter,
2019 then a @code{to-list} group parameter will be added automatically upon
2020 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2021 @vindex gnus-add-to-list
2022
2023 If you do an @kbd{a} command in a mail group and you don't have a
2024 @code{to-list} group parameter, one will be added automatically upon
2025 sending the message.
2026
2027 @item visible
2028 @cindex visible
2029 If the group parameter list has the element @code{(visible . t)},
2030 that group will always be visible in the Group buffer, regardless
2031 of whether it has any unread articles.
2032
2033 @item broken-reply-to
2034 @cindex broken-reply-to
2035 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2036 headers in this group are to be ignored.  This can be useful if you're
2037 reading a mailing list group where the listserv has inserted
2038 @code{Reply-To} headers that point back to the listserv itself.  This is
2039 broken behavior.  So there!
2040
2041 @item to-group
2042 @cindex to-group
2043 Elements like @code{(to-group . "some.group.name")} means that all
2044 posts in that group will be sent to @code{some.group.name}.
2045
2046 @item newsgroup
2047 @cindex newsgroup
2048 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2049 will treat all responses as if they were responses to news articles.
2050 This can be useful if you have a mail group that's really a mirror of a
2051 news group.
2052
2053 @item gcc-self
2054 @cindex gcc-self
2055 If @code{(gcc-self . t)} is present in the group parameter list, newly
2056 composed messages will be @code{Gcc}'d to the current group. If
2057 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2058 generated, if @code{(gcc-self . "string")} is present, this string will
2059 be inserted literally as a @code{gcc} header.  This parameter takes
2060 precedence over any default @code{Gcc} rules as described later
2061 (@pxref{Archived Messages}).
2062
2063 @item auto-expire
2064 @cindex auto-expire
2065 If the group parameter has an element that looks like @code{(auto-expire
2066 . t)}, all articles read will be marked as expirable.  For an
2067 alternative approach, @pxref{Expiring Mail}.
2068
2069 @item total-expire
2070 @cindex total-expire
2071 If the group parameter has an element that looks like
2072 @code{(total-expire . t)}, all read articles will be put through the
2073 expiry process, even if they are not marked as expirable.  Use with
2074 caution.  Unread, ticked and dormant articles are not eligible for
2075 expiry.
2076
2077 @item expiry-wait
2078 @cindex expiry-wait
2079 @vindex nnmail-expiry-wait-function
2080 If the group parameter has an element that looks like @code{(expiry-wait
2081 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2082 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2083 The value can either be a number of days (not necessarily an integer) or
2084 the symbols @code{never} or @code{immediate}.
2085
2086 @item score-file
2087 @cindex score file group parameter
2088 Elements that look like @code{(score-file . "file")} will make
2089 @file{file} into the current score file for the group in question.  All
2090 interactive score entries will be put into this file.
2091
2092 @item adapt-file
2093 @cindex adapt file group parameter
2094 Elements that look like @code{(adapt-file . "file")} will make
2095 @file{file} into the current adaptive file for the group in question.
2096 All adaptive score entries will be put into this file.
2097
2098 @item admin-address
2099 When unsubscribing from a mailing list you should never send the
2100 unsubscription notice to the mailing list itself.  Instead, you'd send
2101 messages to the administrative address.  This parameter allows you to
2102 put the admin address somewhere convenient.
2103
2104 @item display
2105 Elements that look like @code{(display . MODE)} say which articles to
2106 display on entering the group.  Valid values are:
2107
2108 @table @code
2109 @item all
2110 Display all articles, both read and unread.
2111
2112 @item default
2113 Display the default visible articles, which normally includes unread and
2114 ticked articles.
2115 @end table
2116
2117 @item comment
2118 Elements that look like @code{(comment . "This is a comment")}
2119 are arbitrary comments on the group.  They are currently ignored by
2120 Gnus, but provide a place for you to store information on particular
2121 groups.
2122
2123 @item @var{(variable form)}
2124 You can use the group parameters to set variables local to the group you
2125 are entering.  If you want to turn threading off in @samp{news.answers},
2126 you could put @code{(gnus-show-threads nil)} in the group parameters of
2127 that group.  @code{gnus-show-threads} will be made into a local variable
2128 in the summary buffer you enter, and the form @code{nil} will be
2129 @code{eval}ed there.
2130
2131 This can also be used as a group-specific hook function, if you'd like.
2132 If you want to hear a beep when you enter a group, you could put
2133 something like @code{(dummy-variable (ding))} in the parameters of that
2134 group.  @code{dummy-variable} will be set to the result of the
2135 @code{(ding)} form, but who cares?
2136
2137 @end table
2138
2139 Use the @kbd{G p} command to edit group parameters of a group.  You
2140 might also be interested in reading about topic parameters (@pxref{Topic
2141 Parameters}).
2142
2143
2144 @node Listing Groups
2145 @section Listing Groups
2146 @cindex group listing
2147
2148 These commands all list various slices of the groups available.
2149
2150 @table @kbd
2151
2152 @item l
2153 @itemx A s
2154 @kindex A s (Group)
2155 @kindex l (Group)
2156 @findex gnus-group-list-groups
2157 List all groups that have unread articles
2158 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2159 command will list only groups of level ARG and lower.  By default, it
2160 only lists groups of level five (i. e.,
2161 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2162 groups).
2163
2164 @item L
2165 @itemx A u
2166 @kindex A u (Group)
2167 @kindex L (Group)
2168 @findex gnus-group-list-all-groups
2169 List all groups, whether they have unread articles or not
2170 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2171 this command will list only groups of level ARG and lower.  By default,
2172 it lists groups of level seven or lower (i.e., just subscribed and
2173 unsubscribed groups).
2174
2175 @item A l
2176 @kindex A l (Group)
2177 @findex gnus-group-list-level
2178 List all unread groups on a specific level
2179 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2180 with no unread articles.
2181
2182 @item A k
2183 @kindex A k (Group)
2184 @findex gnus-group-list-killed
2185 List all killed groups (@code{gnus-group-list-killed}).  If given a
2186 prefix argument, really list all groups that are available, but aren't
2187 currently (un)subscribed.  This could entail reading the active file
2188 from the server.
2189
2190 @item A z
2191 @kindex A z (Group)
2192 @findex gnus-group-list-zombies
2193 List all zombie groups (@code{gnus-group-list-zombies}).
2194
2195 @item A m
2196 @kindex A m (Group)
2197 @findex gnus-group-list-matching
2198 List all unread, subscribed groups with names that match a regexp
2199 (@code{gnus-group-list-matching}).
2200
2201 @item A M
2202 @kindex A M (Group)
2203 @findex gnus-group-list-all-matching
2204 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2205
2206 @item A A
2207 @kindex A A (Group)
2208 @findex gnus-group-list-active
2209 List absolutely all groups in the active file(s) of the
2210 server(s) you are connected to (@code{gnus-group-list-active}).  This
2211 might very well take quite a while.  It might actually be a better idea
2212 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2213 thing to match on.  Also note that this command may list groups that
2214 don't exist (yet)---these will be listed as if they were killed groups.
2215 Take the output with some grains of salt.
2216
2217 @item A a
2218 @kindex A a (Group)
2219 @findex gnus-group-apropos
2220 List all groups that have names that match a regexp
2221 (@code{gnus-group-apropos}).
2222
2223 @item A d
2224 @kindex A d (Group)
2225 @findex gnus-group-description-apropos
2226 List all groups that have names or descriptions that match a regexp
2227 (@code{gnus-group-description-apropos}).
2228
2229 @end table
2230
2231 @vindex gnus-permanently-visible-groups
2232 @cindex visible group parameter
2233 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2234 always be shown, whether they have unread articles or not.  You can also
2235 add the @code{visible} element to the group parameters in question to
2236 get the same effect.
2237
2238 @vindex gnus-list-groups-with-ticked-articles
2239 Groups that have just ticked articles in it are normally listed in the
2240 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2241 @code{nil}, these groups will be treated just like totally empty
2242 groups.  It is @code{t} by default.
2243
2244
2245 @node Sorting Groups
2246 @section Sorting Groups
2247 @cindex sorting groups
2248
2249 @kindex C-c C-s (Group)
2250 @findex gnus-group-sort-groups
2251 @vindex gnus-group-sort-function
2252 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2253 group buffer according to the function(s) given by the
2254 @code{gnus-group-sort-function} variable.  Available sorting functions
2255 include:
2256
2257 @table @code
2258
2259 @item gnus-group-sort-by-alphabet
2260 @findex gnus-group-sort-by-alphabet
2261 Sort the group names alphabetically.  This is the default.
2262
2263 @item gnus-group-sort-by-real-name
2264 @findex gnus-group-sort-by-real-name
2265 Sort the group alphabetically on the real (unprefixed) group names.
2266
2267 @item gnus-group-sort-by-level
2268 @findex gnus-group-sort-by-level
2269 Sort by group level.
2270
2271 @item gnus-group-sort-by-score
2272 @findex gnus-group-sort-by-score
2273 Sort by group score.  @xref{Group Score}.
2274
2275 @item gnus-group-sort-by-rank
2276 @findex gnus-group-sort-by-rank
2277 Sort by group score and then the group level.  The level and the score
2278 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2279
2280 @item gnus-group-sort-by-unread
2281 @findex gnus-group-sort-by-unread
2282 Sort by number of unread articles.
2283
2284 @item gnus-group-sort-by-method
2285 @findex gnus-group-sort-by-method
2286 Sort alphabetically on the select method.
2287
2288
2289 @end table
2290
2291 @code{gnus-group-sort-function} can also be a list of sorting
2292 functions.  In that case, the most significant sort key function must be
2293 the last one.
2294
2295
2296 There are also a number of commands for sorting directly according to
2297 some sorting criteria:
2298
2299 @table @kbd
2300 @item G S a
2301 @kindex G S a (Group)
2302 @findex gnus-group-sort-groups-by-alphabet
2303 Sort the group buffer alphabetically by group name
2304 (@code{gnus-group-sort-groups-by-alphabet}).
2305
2306 @item G S u
2307 @kindex G S u (Group)
2308 @findex gnus-group-sort-groups-by-unread
2309 Sort the group buffer by the number of unread articles
2310 (@code{gnus-group-sort-groups-by-unread}).
2311
2312 @item G S l
2313 @kindex G S l (Group)
2314 @findex gnus-group-sort-groups-by-level
2315 Sort the group buffer by group level
2316 (@code{gnus-group-sort-groups-by-level}).
2317
2318 @item G S v
2319 @kindex G S v (Group)
2320 @findex gnus-group-sort-groups-by-score
2321 Sort the group buffer by group score
2322 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2323
2324 @item G S r
2325 @kindex G S r (Group)
2326 @findex gnus-group-sort-groups-by-rank
2327 Sort the group buffer by group rank
2328 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2329
2330 @item G S m
2331 @kindex G S m (Group)
2332 @findex gnus-group-sort-groups-by-method
2333 Sort the group buffer alphabetically by backend name
2334 (@code{gnus-group-sort-groups-by-method}).
2335
2336 @end table
2337
2338 When given a prefix, all these commands will sort in reverse order.
2339
2340 You can also sort a subset of the groups:
2341
2342 @table @kbd
2343 @item G P a
2344 @kindex G P a (Group)
2345 @findex gnus-group-sort-selected-groups-by-alphabet
2346 Sort the process/prefixed groups in the group buffer alphabetically by
2347 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2348
2349 @item G P u
2350 @kindex G P u (Group)
2351 @findex gnus-group-sort-selected-groups-by-unread
2352 Sort the process/prefixed groups in the group buffer by the number of
2353 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2354
2355 @item G P l
2356 @kindex G P l (Group)
2357 @findex gnus-group-sort-selected-groups-by-level
2358 Sort the process/prefixed groups in the group buffer by group level
2359 (@code{gnus-group-sort-selected-groups-by-level}).
2360
2361 @item G P v
2362 @kindex G P v (Group)
2363 @findex gnus-group-sort-selected-groups-by-score
2364 Sort the process/prefixed groups in the group buffer by group score
2365 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2366
2367 @item G P r
2368 @kindex G P r (Group)
2369 @findex gnus-group-sort-selected-groups-by-rank
2370 Sort the process/prefixed groups in the group buffer by group rank
2371 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2372
2373 @item G P m
2374 @kindex G P m (Group)
2375 @findex gnus-group-sort-selected-groups-by-method
2376 Sort the process/prefixed groups in the group buffer alphabetically by
2377 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2378
2379 @end table
2380
2381
2382
2383 @node Group Maintenance
2384 @section Group Maintenance
2385 @cindex bogus groups
2386
2387 @table @kbd
2388 @item b
2389 @kindex b (Group)
2390 @findex gnus-group-check-bogus-groups
2391 Find bogus groups and delete them
2392 (@code{gnus-group-check-bogus-groups}).
2393
2394 @item F
2395 @kindex F (Group)
2396 @findex gnus-group-find-new-groups
2397 Find new groups and process them (@code{gnus-group-find-new-groups}).
2398 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2399 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
2400 to query the server for new groups, and subscribe the new groups as
2401 zombies.
2402
2403 @item C-c C-x
2404 @kindex C-c C-x (Group)
2405 @findex gnus-group-expire-articles
2406 Run all expirable articles in the current group through the expiry
2407 process (if any) (@code{gnus-group-expire-articles}).
2408
2409 @item C-c M-C-x
2410 @kindex C-c M-C-x (Group)
2411 @findex gnus-group-expire-all-groups
2412 Run all articles in all groups through the expiry process
2413 (@code{gnus-group-expire-all-groups}).
2414
2415 @end table
2416
2417
2418 @node Browse Foreign Server
2419 @section Browse Foreign Server
2420 @cindex foreign servers
2421 @cindex browsing servers
2422
2423 @table @kbd
2424 @item B
2425 @kindex B (Group)
2426 @findex gnus-group-browse-foreign-server
2427 You will be queried for a select method and a server name.  Gnus will
2428 then attempt to contact this server and let you browse the groups there
2429 (@code{gnus-group-browse-foreign-server}).
2430 @end table
2431
2432 @findex gnus-browse-mode
2433 A new buffer with a list of available groups will appear.  This buffer
2434 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2435 a lot) like a normal group buffer.
2436
2437 Here's a list of keystrokes available in the browse mode:
2438
2439 @table @kbd
2440 @item n
2441 @kindex n (Browse)
2442 @findex gnus-group-next-group
2443 Go to the next group (@code{gnus-group-next-group}).
2444
2445 @item p
2446 @kindex p (Browse)
2447 @findex gnus-group-prev-group
2448 Go to the previous group (@code{gnus-group-prev-group}).
2449
2450 @item SPACE
2451 @kindex SPACE (Browse)
2452 @findex gnus-browse-read-group
2453 Enter the current group and display the first article
2454 (@code{gnus-browse-read-group}).
2455
2456 @item RET
2457 @kindex RET (Browse)
2458 @findex gnus-browse-select-group
2459 Enter the current group (@code{gnus-browse-select-group}).
2460
2461 @item u
2462 @kindex u (Browse)
2463 @findex gnus-browse-unsubscribe-current-group
2464 Unsubscribe to the current group, or, as will be the case here,
2465 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2466
2467 @item l
2468 @itemx q
2469 @kindex q (Browse)
2470 @kindex l (Browse)
2471 @findex gnus-browse-exit
2472 Exit browse mode (@code{gnus-browse-exit}).
2473
2474 @item ?
2475 @kindex ? (Browse)
2476 @findex gnus-browse-describe-briefly
2477 Describe browse mode briefly (well, there's not much to describe, is
2478 there) (@code{gnus-browse-describe-briefly}).
2479 @end table
2480
2481
2482 @node Exiting Gnus
2483 @section Exiting Gnus
2484 @cindex exiting Gnus
2485
2486 Yes, Gnus is ex(c)iting.
2487
2488 @table @kbd
2489 @item z
2490 @kindex z (Group)
2491 @findex gnus-group-suspend
2492 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2493 but it kills all buffers except the Group buffer.  I'm not sure why this
2494 is a gain, but then who am I to judge?
2495
2496 @item q
2497 @kindex q (Group)
2498 @findex gnus-group-exit
2499 @c @icon{gnus-group-exit}
2500 Quit Gnus (@code{gnus-group-exit}).
2501
2502 @item Q
2503 @kindex Q (Group)
2504 @findex gnus-group-quit
2505 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2506 The dribble file will be saved, though (@pxref{Auto Save}).
2507 @end table
2508
2509 @vindex gnus-exit-gnus-hook
2510 @vindex gnus-suspend-gnus-hook
2511 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2512 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2513 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2514 exiting Gnus.
2515
2516 @findex gnus-unload
2517 @cindex unloading
2518 If you wish to completely unload Gnus and all its adherents, you can use
2519 the @code{gnus-unload} command.  This command is also very handy when
2520 trying to customize meta-variables.
2521
2522 Note:
2523
2524 @quotation
2525 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2526 numbly heavy and herself fall into a hazy trance as the boy sitting
2527 behind her drew repeated lines with his pencil across the back of her
2528 plastic chair.
2529 @end quotation
2530
2531
2532 @node Group Topics
2533 @section Group Topics
2534 @cindex topics
2535
2536 If you read lots and lots of groups, it might be convenient to group
2537 them hierarchically according to topics.  You put your Emacs groups over
2538 here, your sex groups over there, and the rest (what, two groups or so?)
2539 you put in some misc section that you never bother with anyway.  You can
2540 even group the Emacs sex groups as a sub-topic to either the Emacs
2541 groups or the sex groups---or both!  Go wild!
2542
2543 @iftex
2544 @iflatex
2545 \gnusfigure{Group Topics}{400}{
2546 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2547 }
2548 @end iflatex
2549 @end iftex
2550
2551 Here's an example:
2552
2553 @example
2554 Gnus
2555   Emacs -- I wuw it!
2556      3: comp.emacs
2557      2: alt.religion.emacs
2558     Naughty Emacs
2559      452: alt.sex.emacs
2560        0: comp.talk.emacs.recovery
2561   Misc
2562      8: comp.binaries.fractals
2563     13: comp.sources.unix
2564 @end example
2565
2566 @findex gnus-topic-mode
2567 @kindex t (Group)
2568 To get this @emph{fab} functionality you simply turn on (ooh!) the
2569 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2570 is a toggling command.)
2571
2572 Go ahead, just try it.  I'll still be here when you get back.  La de
2573 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2574 press @kbd{l}.  There.  All your groups are now listed under
2575 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2576 bothered?
2577
2578 If you want this permanently enabled, you should add that minor mode to
2579 the hook for the group mode:
2580
2581 @lisp
2582 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2583 @end lisp
2584
2585 @menu
2586 * Topic Variables::    How to customize the topics the Lisp Way.
2587 * Topic Commands::     Interactive E-Z commands.
2588 * Topic Sorting::      Sorting each topic individually.
2589 * Topic Topology::     A map of the world.
2590 * Topic Parameters::   Parameters that apply to all groups in a topic.
2591 @end menu
2592
2593
2594 @node Topic Variables
2595 @subsection Topic Variables
2596 @cindex topic variables
2597
2598 Now, if you select a topic, it will fold/unfold that topic, which is
2599 really neat, I think.
2600
2601 @vindex gnus-topic-line-format
2602 The topic lines themselves are created according to the
2603 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2604 Valid elements are:
2605
2606 @table @samp
2607 @item i
2608 Indentation.
2609 @item n
2610 Topic name.
2611 @item v
2612 Visibility.
2613 @item l
2614 Level.
2615 @item g
2616 Number of groups in the topic.
2617 @item a
2618 Number of unread articles in the topic.
2619 @item A
2620 Number of unread articles in the topic and all its subtopics.
2621 @end table
2622
2623 @vindex gnus-topic-indent-level
2624 Each sub-topic (and the groups in the sub-topics) will be indented with
2625 @code{gnus-topic-indent-level} times the topic level number of spaces.
2626 The default is 2.
2627
2628 @vindex gnus-topic-mode-hook
2629 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2630
2631 @vindex gnus-topic-display-empty-topics
2632 The @code{gnus-topic-display-empty-topics} says whether to display even
2633 topics that have no unread articles in them.  The default is @code{t}.
2634
2635
2636 @node Topic Commands
2637 @subsection Topic Commands
2638 @cindex topic commands
2639
2640 When the topic minor mode is turned on, a new @kbd{T} submap will be
2641 available.  In addition, a few of the standard keys change their
2642 definitions slightly.
2643
2644 @table @kbd
2645
2646 @item T n
2647 @kindex T n (Topic)
2648 @findex gnus-topic-create-topic
2649 Prompt for a new topic name and create it
2650 (@code{gnus-topic-create-topic}).
2651
2652 @item T m
2653 @kindex T m (Topic)
2654 @findex gnus-topic-move-group
2655 Move the current group to some other topic
2656 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2657 convention (@pxref{Process/Prefix}).
2658
2659 @item T c
2660 @kindex T c (Topic)
2661 @findex gnus-topic-copy-group
2662 Copy the current group to some other topic
2663 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2664 convention (@pxref{Process/Prefix}).
2665
2666 @item T D
2667 @kindex T D (Topic)
2668 @findex gnus-topic-remove-group
2669 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2670 This command is mainly useful if you have the same group in several
2671 topics and wish to remove it from one of the topics.  You may also
2672 remove a group from all topics, but in that case, Gnus will add it to
2673 the root topic the next time you start Gnus.  In fact, all new groups
2674 (which, naturally, don't belong to any topic) will show up in the root
2675 topic. 
2676
2677 This command uses the process/prefix convention
2678 (@pxref{Process/Prefix}).
2679
2680 @item T M
2681 @kindex T M (Topic)
2682 @findex gnus-topic-move-matching
2683 Move all groups that match some regular expression to a topic
2684 (@code{gnus-topic-move-matching}).
2685
2686 @item T C
2687 @kindex T C (Topic)
2688 @findex gnus-topic-copy-matching
2689 Copy all groups that match some regular expression to a topic
2690 (@code{gnus-topic-copy-matching}).
2691
2692 @item T H
2693 @kindex T H (Topic)
2694 @findex gnus-topic-toggle-display-empty-topics
2695 Toggle hiding empty topics
2696 (@code{gnus-topic-toggle-display-empty-topics}).
2697
2698 @item T #
2699 @kindex T # (Topic)
2700 @findex gnus-topic-mark-topic
2701 Mark all groups in the current topic with the process mark
2702 (@code{gnus-topic-mark-topic}).
2703
2704 @item T M-#
2705 @kindex T M-# (Topic)
2706 @findex gnus-topic-unmark-topic
2707 Remove the process mark from all groups in the current topic
2708 (@code{gnus-topic-unmark-topic}).
2709
2710 @item RET
2711 @kindex RET (Topic)
2712 @findex gnus-topic-select-group
2713 @itemx SPACE
2714 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2715 When you perform this command on a group, you'll enter the group, as
2716 usual.  When done on a topic line, the topic will be folded (if it was
2717 visible) or unfolded (if it was folded already).  So it's basically a
2718 toggling command on topics.  In addition, if you give a numerical
2719 prefix, group on that level (and lower) will be displayed.
2720
2721 @item T TAB
2722 @itemx TAB
2723 @kindex T TAB (Topic)
2724 @kindex TAB (Topic)
2725 @findex gnus-topic-indent
2726 ``Indent'' the current topic so that it becomes a sub-topic of the
2727 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2728 ``un-indent'' the topic instead.
2729
2730 @item M-TAB
2731 @kindex M-TAB (Topic)
2732 @findex gnus-topic-unindent
2733 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2734 parent of its current parent (@code{gnus-topic-unindent}).  
2735
2736 @item C-k
2737 @kindex C-k (Topic)
2738 @findex gnus-topic-kill-group
2739 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2740 topic will be removed along with the topic.
2741
2742 @item C-y
2743 @kindex C-y (Topic)
2744 @findex gnus-topic-yank-group
2745 Yank the previously killed group or topic
2746 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2747 before all groups.
2748
2749 @item T r
2750 @kindex T r (Topic)
2751 @findex gnus-topic-rename
2752 Rename a topic (@code{gnus-topic-rename}).
2753
2754 @item T DEL
2755 @kindex T DEL (Topic)
2756 @findex gnus-topic-delete
2757 Delete an empty topic (@code{gnus-topic-delete}).
2758
2759 @item A T
2760 @kindex A T (Topic)
2761 @findex gnus-topic-list-active
2762 List all groups that Gnus knows about in a topics-ified way
2763 (@code{gnus-topic-list-active}).
2764
2765 @item G p
2766 @kindex G p (Topic)
2767 @findex gnus-topic-edit-parameters
2768 @cindex group parameters
2769 @cindex topic parameters
2770 @cindex parameters
2771 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2772 @xref{Topic Parameters}.
2773
2774 @end table
2775
2776
2777 @node Topic Sorting
2778 @subsection Topic Sorting
2779 @cindex topic sorting
2780
2781 You can sort the groups in each topic individually with the following
2782 commands:
2783
2784
2785 @table @kbd
2786 @item T S a
2787 @kindex T S a (Topic)
2788 @findex gnus-topic-sort-groups-by-alphabet
2789 Sort the current topic alphabetically by group name
2790 (@code{gnus-topic-sort-groups-by-alphabet}).
2791
2792 @item T S u
2793 @kindex T S u (Topic)
2794 @findex gnus-topic-sort-groups-by-unread
2795 Sort the current topic by the number of unread articles
2796 (@code{gnus-topic-sort-groups-by-unread}).
2797
2798 @item T S l
2799 @kindex T S l (Topic)
2800 @findex gnus-topic-sort-groups-by-level
2801 Sort the current topic by group level
2802 (@code{gnus-topic-sort-groups-by-level}).
2803
2804 @item T S v
2805 @kindex T S v (Topic)
2806 @findex gnus-topic-sort-groups-by-score
2807 Sort the current topic by group score
2808 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2809
2810 @item T S r
2811 @kindex T S r (Topic)
2812 @findex gnus-topic-sort-groups-by-rank
2813 Sort the current topic by group rank
2814 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2815
2816 @item T S m
2817 @kindex T S m (Topic)
2818 @findex gnus-topic-sort-groups-by-method
2819 Sort the current topic alphabetically by backend name
2820 (@code{gnus-topic-sort-groups-by-method}).
2821
2822 @end table
2823
2824 @xref{Sorting Groups} for more information about group sorting.
2825
2826
2827 @node Topic Topology
2828 @subsection Topic Topology
2829 @cindex topic topology
2830 @cindex topology
2831
2832 So, let's have a look at an example group buffer:
2833
2834 @example
2835 Gnus
2836   Emacs -- I wuw it!
2837      3: comp.emacs
2838      2: alt.religion.emacs
2839     Naughty Emacs
2840      452: alt.sex.emacs
2841        0: comp.talk.emacs.recovery
2842   Misc
2843      8: comp.binaries.fractals
2844     13: comp.sources.unix
2845 @end example
2846
2847 So, here we have one top-level topic (@samp{Gnus}), two topics under
2848 that, and one sub-topic under one of the sub-topics.  (There is always
2849 just one (1) top-level topic).  This topology can be expressed as
2850 follows:
2851
2852 @lisp
2853 (("Gnus" visible)
2854  (("Emacs -- I wuw it!" visible)
2855   (("Naughty Emacs" visible)))
2856  (("Misc" visible)))
2857 @end lisp
2858
2859 @vindex gnus-topic-topology
2860 This is in fact how the variable @code{gnus-topic-topology} would look
2861 for the display above.  That variable is saved in the @file{.newsrc.eld}
2862 file, and shouldn't be messed with manually---unless you really want
2863 to.  Since this variable is read from the @file{.newsrc.eld} file,
2864 setting it in any other startup files will have no effect.
2865
2866 This topology shows what topics are sub-topics of what topics (right),
2867 and which topics are visible.  Two settings are currently
2868 allowed---@code{visible} and @code{invisible}.
2869
2870
2871 @node Topic Parameters
2872 @subsection Topic Parameters
2873 @cindex topic parameters
2874
2875 All groups in a topic will inherit group parameters from the parent (and
2876 ancestor) topic parameters.  All valid group parameters are valid topic
2877 parameters (@pxref{Group Parameters}).
2878
2879 Group parameters (of course) override topic parameters, and topic
2880 parameters in sub-topics override topic parameters in super-topics.  You
2881 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2882 verb, although you may feel free to disagree with me here.)
2883
2884 @example
2885 Gnus
2886   Emacs
2887      3: comp.emacs
2888      2: alt.religion.emacs
2889    452: alt.sex.emacs
2890     Relief
2891      452: alt.sex.emacs
2892        0: comp.talk.emacs.recovery
2893   Misc
2894      8: comp.binaries.fractals
2895     13: comp.sources.unix
2896    452: alt.sex.emacs
2897 @end example
2898
2899 The @samp{Emacs} topic has the topic parameter @code{(score-file
2900 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2901 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2902 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2903 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2904 . "religion.SCORE")}.
2905
2906 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2907 will get the @file{relief.SCORE} home score file.  If you enter the same
2908 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2909 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2910 get the @file{religion.SCORE} home score file.
2911
2912 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2913 there are some problems, especially with the @code{total-expiry}
2914 parameter.  Say you have a mail group in two topics; one with
2915 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2916 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2917 of these topics you mean to expire articles from, so anything may
2918 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2919 happens.  You just have to be careful if you do stuff like that.
2920
2921
2922 @node Misc Group Stuff
2923 @section Misc Group Stuff
2924
2925 @menu
2926 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2927 * Group Information::     Information and help on groups and Gnus.
2928 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2929 * File Commands::         Reading and writing the Gnus files.
2930 @end menu
2931
2932 @table @kbd
2933
2934 @item ^
2935 @kindex ^ (Group)
2936 @findex gnus-group-enter-server-mode
2937 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2938 @xref{The Server Buffer}.
2939
2940 @item a
2941 @kindex a (Group)
2942 @findex gnus-group-post-news
2943 Post an article to a group (@code{gnus-group-post-news}).  If given a
2944 prefix, the current group name will be used as the default.
2945
2946 @item m
2947 @kindex m (Group)
2948 @findex gnus-group-mail
2949 Mail a message somewhere (@code{gnus-group-mail}).
2950
2951 @end table
2952
2953 Variables for the group buffer:
2954
2955 @table @code
2956
2957 @item gnus-group-mode-hook
2958 @vindex gnus-group-mode-hook
2959 is called after the group buffer has been
2960 created.
2961
2962 @item gnus-group-prepare-hook
2963 @vindex gnus-group-prepare-hook
2964 is called after the group buffer is
2965 generated.  It may be used to modify the buffer in some strange,
2966 unnatural way.
2967
2968 @item gnus-group-prepared-hook
2969 @vindex gnus-group-prepare-hook
2970 is called as the very last thing after the group buffer has been
2971 generated.  It may be used to move point around, for instance.
2972
2973 @item gnus-permanently-visible-groups
2974 @vindex gnus-permanently-visible-groups
2975 Groups matching this regexp will always be listed in the group buffer,
2976 whether they are empty or not.
2977
2978 @end table
2979
2980
2981 @node Scanning New Messages
2982 @subsection Scanning New Messages
2983 @cindex new messages
2984 @cindex scanning new news
2985
2986 @table @kbd
2987
2988 @item g
2989 @kindex g (Group)
2990 @findex gnus-group-get-new-news
2991 @c @icon{gnus-group-get-new-news}
2992 Check the server(s) for new articles.  If the numerical prefix is used,
2993 this command will check only groups of level @var{arg} and lower
2994 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2995 command will force a total re-reading of the active file(s) from the
2996 backend(s).
2997
2998 @item M-g
2999 @kindex M-g (Group)
3000 @findex gnus-group-get-new-news-this-group
3001 @vindex gnus-goto-next-group-when-activating
3002 @c @icon{gnus-group-get-new-news-this-group}
3003 Check whether new articles have arrived in the current group
3004 (@code{gnus-group-get-new-news-this-group}).
3005 @code{gnus-goto-next-group-when-activating} says whether this command is
3006 to move point to the next group or not.  It is @code{t} by default.
3007
3008 @findex gnus-activate-all-groups
3009 @cindex activating groups
3010 @item C-c M-g
3011 @kindex C-c M-g (Group)
3012 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3013
3014 @item R
3015 @kindex R (Group)
3016 @cindex restarting
3017 @findex gnus-group-restart
3018 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3019 file(s), closes the connection to all servers, clears up all run-time
3020 Gnus variables, and then starts Gnus all over again.
3021
3022 @end table
3023
3024 @vindex gnus-get-new-news-hook
3025 @code{gnus-get-new-news-hook} is run just before checking for new news.
3026
3027 @vindex gnus-after-getting-new-news-hook
3028 @code{gnus-after-getting-new-news-hook} is run after checking for new
3029 news.
3030
3031
3032 @node Group Information
3033 @subsection Group Information
3034 @cindex group information
3035 @cindex information on groups
3036
3037 @table @kbd
3038
3039
3040 @item H f
3041 @kindex H f (Group)
3042 @findex gnus-group-fetch-faq
3043 @vindex gnus-group-faq-directory
3044 @cindex FAQ
3045 @cindex ange-ftp
3046 Try to fetch the FAQ for the current group
3047 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3048 @code{gnus-group-faq-directory}, which is usually a directory on a
3049 remote machine.  This variable can also be a list of directories.  In
3050 that case, giving a prefix to this command will allow you to choose
3051 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3052 for fetching the file.
3053
3054 If fetching from the first site is unsuccessful, Gnus will attempt to go
3055 through @code{gnus-group-faq-directory} and try to open them one by one.
3056
3057 @item H d
3058 @itemx C-c C-d
3059 @c @icon{gnus-group-describe-group}
3060 @kindex H d (Group)
3061 @kindex C-c C-d (Group)
3062 @cindex describing groups
3063 @cindex group description
3064 @findex gnus-group-describe-group
3065 Describe the current group (@code{gnus-group-describe-group}).  If given
3066 a prefix, force Gnus to re-read the description from the server.
3067
3068 @item M-d
3069 @kindex M-d (Group)
3070 @findex gnus-group-describe-all-groups
3071 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3072 prefix, force Gnus to re-read the description file from the server.
3073
3074 @item H v
3075 @itemx V
3076 @kindex V (Group)
3077 @kindex H v (Group)
3078 @cindex version
3079 @findex gnus-version
3080 Display current Gnus version numbers (@code{gnus-version}).
3081
3082 @item ?
3083 @kindex ? (Group)
3084 @findex gnus-group-describe-briefly
3085 Give a very short help message (@code{gnus-group-describe-briefly}).
3086
3087 @item C-c C-i
3088 @kindex C-c C-i (Group)
3089 @cindex info
3090 @cindex manual
3091 @findex gnus-info-find-node
3092 Go to the Gnus info node (@code{gnus-info-find-node}).
3093 @end table
3094
3095
3096 @node Group Timestamp
3097 @subsection Group Timestamp
3098 @cindex timestamps
3099 @cindex group timestamps
3100
3101 It can be convenient to let Gnus keep track of when you last read a
3102 group.  To set the ball rolling, you should add
3103 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3104
3105 @lisp
3106 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3107 @end lisp
3108
3109 After doing this, each time you enter a group, it'll be recorded.
3110
3111 This information can be displayed in various ways---the easiest is to
3112 use the @samp{%d} spec in the group line format:
3113
3114 @lisp
3115 (setq gnus-group-line-format
3116       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3117 @end lisp
3118
3119 This will result in lines looking like:
3120
3121 @example
3122 *        0: mail.ding                                19961002T012943
3123          0: custom                                   19961002T012713
3124 @end example
3125
3126 As you can see, the date is displayed in compact ISO 8601 format.  This
3127 may be a bit too much, so to just display the date, you could say
3128 something like:
3129
3130 @lisp
3131 (setq gnus-group-line-format
3132       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3133 @end lisp
3134
3135
3136 @node File Commands
3137 @subsection File Commands
3138 @cindex file commands
3139
3140 @table @kbd
3141
3142 @item r
3143 @kindex r (Group)
3144 @findex gnus-group-read-init-file
3145 @vindex gnus-init-file
3146 @cindex reading init file
3147 Re-read the init file (@code{gnus-init-file}, which defaults to
3148 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3149
3150 @item s
3151 @kindex s (Group)
3152 @findex gnus-group-save-newsrc
3153 @cindex saving .newsrc
3154 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3155 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3156 file(s) whether Gnus thinks it is necessary or not.
3157
3158 @c @item Z
3159 @c @kindex Z (Group)
3160 @c @findex gnus-group-clear-dribble
3161 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3162
3163 @end table
3164
3165
3166 @node The Summary Buffer
3167 @chapter The Summary Buffer
3168 @cindex summary buffer
3169
3170 A line for each article is displayed in the summary buffer.  You can
3171 move around, read articles, post articles and reply to articles.
3172
3173 The most common way to a summary buffer is to select a group from the
3174 group buffer (@pxref{Selecting a Group}).
3175
3176 You can have as many summary buffers open as you wish.
3177
3178 @menu
3179 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3180 * Summary Maneuvering::         Moving around the summary buffer.
3181 * Choosing Articles::           Reading articles.
3182 * Paging the Article::          Scrolling the current article.
3183 * Reply Followup and Post::     Posting articles.
3184 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3185 * Marking Articles::            Marking articles as read, expirable, etc.
3186 * Limiting::                    You can limit the summary buffer.
3187 * Threading::                   How threads are made.
3188 * Sorting::                     How articles and threads are sorted.
3189 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3190 * Article Caching::             You may store articles in a cache.
3191 * Persistent Articles::         Making articles expiry-resistant.
3192 * Article Backlog::             Having already read articles hang around.
3193 * Saving Articles::             Ways of customizing article saving.
3194 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3195 * Article Treatment::           The article buffer can be mangled at will.
3196 * Article Commands::            Doing various things with the article buffer.
3197 * Summary Sorting::             Sorting the summary buffer in various ways.
3198 * Finding the Parent::          No child support? Get the parent.
3199 * Alternative Approaches::      Reading using non-default summaries.
3200 * Tree Display::                A more visual display of threads.
3201 * Mail Group Commands::         Some commands can only be used in mail groups.
3202 * Various Summary Stuff::       What didn't fit anywhere else.
3203 * Exiting the Summary Buffer::  Returning to the Group buffer.
3204 * Crosspost Handling::          How crossposted articles are dealt with.
3205 * Duplicate Suppression::       An alternative when crosspost handling fails.
3206 @end menu
3207
3208
3209 @node Summary Buffer Format
3210 @section Summary Buffer Format
3211 @cindex summary buffer format
3212
3213 @iftex
3214 @iflatex
3215 \gnusfigure{The Summary Buffer}{180}{
3216 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3217 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3218 }
3219 @end iflatex
3220 @end iftex
3221
3222 @menu
3223 * Summary Buffer Lines::     You can specify how summary lines should look.
3224 * Summary Buffer Mode Line:: You can say how the mode line should look.
3225 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3226 @end menu
3227
3228 @findex mail-extract-address-components
3229 @findex gnus-extract-address-components
3230 @vindex gnus-extract-address-components
3231 Gnus will use the value of the @code{gnus-extract-address-components}
3232 variable as a function for getting the name and address parts of a
3233 @code{From} header.  Two pre-defined functions exist:
3234 @code{gnus-extract-address-components}, which is the default, quite
3235 fast, and too simplistic solution; and
3236 @code{mail-extract-address-components}, which works very nicely, but is
3237 slower.  The default function will return the wrong answer in 5% of the
3238 cases.  If this is unacceptable to you, use the other function instead.
3239
3240 @vindex gnus-summary-same-subject
3241 @code{gnus-summary-same-subject} is a string indicating that the current
3242 article has the same subject as the previous.  This string will be used
3243 with those specs that require it.  The default is @code{""}.
3244
3245
3246 @node Summary Buffer Lines
3247 @subsection Summary Buffer Lines
3248
3249 @vindex gnus-summary-line-format
3250 You can change the format of the lines in the summary buffer by changing
3251 the @code{gnus-summary-line-format} variable.  It works along the same
3252 lines as a normal @code{format} string, with some extensions
3253 (@pxref{Formatting Variables}).
3254
3255 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3256
3257 The following format specification characters are understood:
3258
3259 @table @samp
3260 @item N
3261 Article number.
3262 @item S
3263 Subject string.
3264 @item s
3265 Subject if the article is the root of the thread or the previous article
3266 had a different subject, @code{gnus-summary-same-subject} otherwise.
3267 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3268 @item F
3269 Full @code{From} header.
3270 @item n
3271 The name (from the @code{From} header).
3272 @item a
3273 The name (from the @code{From} header).  This differs from the @code{n}
3274 spec in that it uses the function designated by the
3275 @code{gnus-extract-address-components} variable, which is slower, but
3276 may be more thorough.
3277 @item A
3278 The address (from the @code{From} header).  This works the same way as
3279 the @code{a} spec.
3280 @item L
3281 Number of lines in the article.
3282 @item c
3283 Number of characters in the article.
3284 @item I
3285 Indentation based on thread level (@pxref{Customizing Threading}).
3286 @item T
3287 Nothing if the article is a root and lots of spaces if it isn't (it
3288 pushes everything after it off the screen).
3289 @item [
3290 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3291 for adopted articles (@pxref{Customizing Threading}).
3292 @item ]
3293 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3294 for adopted articles.
3295 @item >
3296 One space for each thread level.
3297 @item <
3298 Twenty minus thread level spaces.
3299 @item U
3300 Unread.
3301
3302 @item R
3303 This misleadingly named specifier is the @dfn{secondary mark}.  This
3304 mark will say whether the article has been replied to, has been cached,
3305 or has been saved.  
3306
3307 @item i
3308 Score as a number (@pxref{Scoring}).
3309 @item z
3310 @vindex gnus-summary-zcore-fuzz
3311 Zcore, @samp{+} if above the default level and @samp{-} if below the
3312 default level.  If the difference between
3313 @code{gnus-summary-default-score} and the score is less than
3314 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3315 @item V
3316 Total thread score.
3317 @item x
3318 @code{Xref}.
3319 @item D
3320 @code{Date}.
3321 @item d
3322 The @code{Date} in @code{DD-MMM} format.
3323 @item o
3324 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3325 @item M
3326 @code{Message-ID}.
3327 @item r
3328 @code{References}.
3329 @item t
3330 Number of articles in the current sub-thread.  Using this spec will slow
3331 down summary buffer generation somewhat.
3332 @item e
3333 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3334 article has any children.
3335 @item P
3336 The line number.
3337 @item O
3338 Download mark.
3339 @item u
3340 User defined specifier.  The next character in the format string should
3341 be a letter.  Gnus will call the function
3342 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3343 following @samp{%u}.  The function will be passed the current header as
3344 argument.  The function should return a string, which will be inserted
3345 into the summary just like information from any other summary specifier.
3346 @end table
3347
3348 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3349 have to be handled with care.  For reasons of efficiency, Gnus will
3350 compute what column these characters will end up in, and ``hard-code''
3351 that.  This means that it is invalid to have these specs after a
3352 variable-length spec.  Well, you might not be arrested, but your summary
3353 buffer will look strange, which is bad enough.
3354
3355 The smart choice is to have these specs as far to the left as possible.
3356 (Isn't that the case with everything, though?  But I digress.)
3357
3358 This restriction may disappear in later versions of Gnus.
3359
3360
3361 @node Summary Buffer Mode Line
3362 @subsection Summary Buffer Mode Line
3363
3364 @vindex gnus-summary-mode-line-format
3365 You can also change the format of the summary mode bar (@pxref{Mode Line
3366 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
3367 like.  The default is @samp{Gnus: %%b [%A] %Z}.
3368
3369 Here are the elements you can play with:
3370
3371 @table @samp
3372 @item G
3373 Group name.
3374 @item p
3375 Unprefixed group name.
3376 @item A
3377 Current article number.
3378 @item z
3379 Current article score.
3380 @item V
3381 Gnus version.
3382 @item U
3383 Number of unread articles in this group.
3384 @item e
3385 Number of unread articles in this group that aren't displayed in the
3386 summary buffer.
3387 @item Z
3388 A string with the number of unread and unselected articles represented
3389 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3390 articles, and just as @samp{<%U more>} if there are just unread articles
3391 and no unselected ones.
3392 @item g
3393 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3394 shortened to @samp{r.a.anime}.
3395 @item S
3396 Subject of the current article.
3397 @item u
3398 User-defined spec (@pxref{User-Defined Specs}).
3399 @item s
3400 Name of the current score file (@pxref{Scoring}).
3401 @item d
3402 Number of dormant articles (@pxref{Unread Articles}).
3403 @item t
3404 Number of ticked articles (@pxref{Unread Articles}).
3405 @item r
3406 Number of articles that have been marked as read in this session.
3407 @item E
3408 Number of articles expunged by the score files.
3409 @end table
3410
3411
3412 @node Summary Highlighting
3413 @subsection Summary Highlighting
3414
3415 @table @code
3416
3417 @item gnus-visual-mark-article-hook
3418 @vindex gnus-visual-mark-article-hook
3419 This hook is run after selecting an article.  It is meant to be used for
3420 highlighting the article in some way.  It is not run if
3421 @code{gnus-visual} is @code{nil}.
3422
3423 @item gnus-summary-update-hook
3424 @vindex gnus-summary-update-hook
3425 This hook is called when a summary line is changed.  It is not run if
3426 @code{gnus-visual} is @code{nil}.
3427
3428 @item gnus-summary-selected-face
3429 @vindex gnus-summary-selected-face
3430 This is the face (or @dfn{font} as some people call it) used to
3431 highlight the current article in the summary buffer.
3432
3433 @item gnus-summary-highlight
3434 @vindex gnus-summary-highlight
3435 Summary lines are highlighted according to this variable, which is a
3436 list where the elements are of the format @var{(FORM . FACE)}.  If you
3437 would, for instance, like ticked articles to be italic and high-scored
3438 articles to be bold, you could set this variable to something like
3439 @lisp
3440 (((eq mark gnus-ticked-mark) . italic)
3441  ((> score default) . bold))
3442 @end lisp
3443 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3444 @var{FACE} will be applied to the line.
3445 @end table
3446
3447
3448 @node Summary Maneuvering
3449 @section Summary Maneuvering
3450 @cindex summary movement
3451
3452 All the straight movement commands understand the numeric prefix and
3453 behave pretty much as you'd expect.
3454
3455 None of these commands select articles.
3456
3457 @table @kbd
3458 @item G M-n
3459 @itemx M-n
3460 @kindex M-n (Summary)
3461 @kindex G M-n (Summary)
3462 @findex gnus-summary-next-unread-subject
3463 Go to the next summary line of an unread article
3464 (@code{gnus-summary-next-unread-subject}).
3465
3466 @item G M-p
3467 @itemx M-p
3468 @kindex M-p (Summary)
3469 @kindex G M-p (Summary)
3470 @findex gnus-summary-prev-unread-subject
3471 Go to the previous summary line of an unread article
3472 (@code{gnus-summary-prev-unread-subject}).
3473
3474 @item G j
3475 @itemx j
3476 @kindex j (Summary)
3477 @kindex G j (Summary)
3478 @findex gnus-summary-goto-article
3479 Ask for an article number or @code{Message-ID}, and then go to that
3480 article (@code{gnus-summary-goto-article}).
3481
3482 @item G g
3483 @kindex G g (Summary)
3484 @findex gnus-summary-goto-subject
3485 Ask for an article number and then go to the summary line of that article
3486 without displaying the article (@code{gnus-summary-goto-subject}).
3487 @end table
3488
3489 If Gnus asks you to press a key to confirm going to the next group, you
3490 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3491 buffer, searching for the next group to read without actually returning
3492 to the group buffer.
3493
3494 Variables related to summary movement:
3495
3496 @table @code
3497
3498 @vindex gnus-auto-select-next
3499 @item gnus-auto-select-next
3500 If you issue one of the movement commands (like @kbd{n}) and there are
3501 no more unread articles after the current one, Gnus will offer to go to
3502 the next group.  If this variable is @code{t} and the next group is
3503 empty, Gnus will exit summary mode and return to the group buffer.  If
3504 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3505 next group, no matter whether it has any unread articles or not.  As a
3506 special case, if this variable is @code{quietly}, Gnus will select the
3507 next group without asking for confirmation.  If this variable is
3508 @code{almost-quietly}, the same will happen only if you are located on
3509 the last article in the group.  Finally, if this variable is
3510 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3511 without confirmation.  Also @pxref{Group Levels}.
3512
3513 @item gnus-auto-select-same
3514 @vindex gnus-auto-select-same
3515 If non-@code{nil}, all the movement commands will try to go to the next
3516 article with the same subject as the current.  (@dfn{Same} here might
3517 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3518 for details (@pxref{Customizing Threading}).)  If there are no more
3519 articles with the same subject, go to the first unread article.
3520
3521 This variable is not particularly useful if you use a threaded display.
3522
3523 @item gnus-summary-check-current
3524 @vindex gnus-summary-check-current
3525 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3526 to the next (or previous) article if the current article is unread.
3527 Instead, they will choose the current article.
3528
3529 @item gnus-auto-center-summary
3530 @vindex gnus-auto-center-summary
3531 If non-@code{nil}, Gnus will keep the point in the summary buffer
3532 centered at all times.  This makes things quite tidy, but if you have a
3533 slow network connection, or simply do not like this un-Emacsism, you can
3534 set this variable to @code{nil} to get the normal Emacs scrolling
3535 action.  This will also inhibit horizontal re-centering of the summary
3536 buffer, which might make it more inconvenient to read extremely long
3537 threads.
3538
3539 @end table
3540
3541
3542 @node Choosing Articles
3543 @section Choosing Articles
3544 @cindex selecting articles
3545
3546 @menu
3547 * Choosing Commands::        Commands for choosing articles.
3548 * Choosing Variables::       Variables that influence these commands.
3549 @end menu
3550
3551
3552 @node Choosing Commands
3553 @subsection Choosing Commands
3554
3555 None of the following movement commands understand the numeric prefix,
3556 and they all select and display an article.
3557
3558 @table @kbd
3559 @item SPACE
3560 @kindex SPACE (Summary)
3561 @findex gnus-summary-next-page
3562 Select the current article, or, if that one's read already, the next
3563 unread article (@code{gnus-summary-next-page}).
3564
3565 @item G n
3566 @itemx n
3567 @kindex n (Summary)
3568 @kindex G n (Summary)
3569 @findex gnus-summary-next-unread-article
3570 @c @icon{gnus-summary-next-unread}
3571 Go to next unread article (@code{gnus-summary-next-unread-article}).
3572
3573 @item G p
3574 @itemx p
3575 @kindex p (Summary)
3576 @findex gnus-summary-prev-unread-article
3577 @c @icon{gnus-summary-prev-unread}
3578 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3579
3580 @item G N
3581 @itemx N
3582 @kindex N (Summary)
3583 @kindex G N (Summary)
3584 @findex gnus-summary-next-article
3585 Go to the next article (@code{gnus-summary-next-article}).
3586
3587 @item G P
3588 @itemx P
3589 @kindex P (Summary)
3590 @kindex G P (Summary)
3591 @findex gnus-summary-prev-article
3592 Go to the previous article (@code{gnus-summary-prev-article}).
3593
3594 @item G C-n
3595 @kindex G C-n (Summary)
3596 @findex gnus-summary-next-same-subject
3597 Go to the next article with the same subject
3598 (@code{gnus-summary-next-same-subject}).
3599
3600 @item G C-p
3601 @kindex G C-p (Summary)
3602 @findex gnus-summary-prev-same-subject
3603 Go to the previous article with the same subject
3604 (@code{gnus-summary-prev-same-subject}).
3605
3606 @item G f
3607 @itemx .
3608 @kindex G f  (Summary)
3609 @kindex .  (Summary)
3610 @findex gnus-summary-first-unread-article
3611 Go to the first unread article
3612 (@code{gnus-summary-first-unread-article}).
3613
3614 @item G b
3615 @itemx ,
3616 @kindex G b (Summary)
3617 @kindex , (Summary)
3618 @findex gnus-summary-best-unread-article
3619 Go to the article with the highest score
3620 (@code{gnus-summary-best-unread-article}).
3621
3622 @item G l
3623 @itemx l
3624 @kindex l (Summary)
3625 @kindex G l (Summary)
3626 @findex gnus-summary-goto-last-article
3627 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3628
3629 @item G o
3630 @kindex G o (Summary)
3631 @findex gnus-summary-pop-article
3632 @cindex history
3633 @cindex article history
3634 Pop an article off the summary history and go to this article
3635 (@code{gnus-summary-pop-article}).  This command differs from the
3636 command above in that you can pop as many previous articles off the
3637 history as you like, while @kbd{l} toggles the two last read articles.
3638 For a somewhat related issue (if you use these commands a lot),
3639 @pxref{Article Backlog}.
3640 @end table
3641
3642
3643 @node Choosing Variables
3644 @subsection Choosing Variables
3645
3646 Some variables relevant for moving and selecting articles:
3647
3648 @table @code
3649 @item gnus-auto-extend-newsgroup
3650 @vindex gnus-auto-extend-newsgroup
3651 All the movement commands will try to go to the previous (or next)
3652 article, even if that article isn't displayed in the Summary buffer if
3653 this variable is non-@code{nil}.  Gnus will then fetch the article from
3654 the server and display it in the article buffer.
3655
3656 @item gnus-select-article-hook
3657 @vindex gnus-select-article-hook
3658 This hook is called whenever an article is selected.  By default it
3659 exposes any threads hidden under the selected article.
3660
3661 @item gnus-mark-article-hook
3662 @vindex gnus-mark-article-hook
3663 @findex gnus-summary-mark-unread-as-read
3664 @findex gnus-summary-mark-read-and-unread-as-read
3665 @findex gnus-unread-mark
3666 This hook is called whenever an article is selected.  It is intended to
3667 be used for marking articles as read.  The default value is
3668 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3669 mark of almost any article you read to @code{gnus-unread-mark}.  The
3670 only articles not affected by this function are ticked, dormant, and
3671 expirable articles.  If you'd instead like to just have unread articles
3672 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3673 instead.  It will leave marks like @code{gnus-low-score-mark},
3674 @code{gnus-del-mark} (and so on) alone.
3675
3676 @end table
3677
3678
3679 @node Paging the Article
3680 @section Scrolling the Article
3681 @cindex article scrolling
3682
3683 @table @kbd
3684
3685 @item SPACE
3686 @kindex SPACE (Summary)
3687 @findex gnus-summary-next-page
3688 Pressing @kbd{SPACE} will scroll the current article forward one page,
3689 or, if you have come to the end of the current article, will choose the
3690 next article (@code{gnus-summary-next-page}).
3691
3692 @item DEL
3693 @kindex DEL (Summary)
3694 @findex gnus-summary-prev-page
3695 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3696
3697 @item RET
3698 @kindex RET (Summary)
3699 @findex gnus-summary-scroll-up
3700 Scroll the current article one line forward
3701 (@code{gnus-summary-scroll-up}).
3702
3703 @item M-RET
3704 @kindex M-RET (Summary)
3705 @findex gnus-summary-scroll-down
3706 Scroll the current article one line backward
3707 (@code{gnus-summary-scroll-down}).
3708
3709 @item A g
3710 @itemx g
3711 @kindex A g (Summary)
3712 @kindex g (Summary)
3713 @findex gnus-summary-show-article
3714 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3715 given a prefix, fetch the current article, but don't run any of the
3716 article treatment functions.  This will give you a ``raw'' article, just
3717 the way it came from the server.
3718
3719 @item A <
3720 @itemx <
3721 @kindex < (Summary)
3722 @kindex A < (Summary)
3723 @findex gnus-summary-beginning-of-article
3724 Scroll to the beginning of the article
3725 (@code{gnus-summary-beginning-of-article}).
3726
3727 @item A >
3728 @itemx >
3729 @kindex > (Summary)
3730 @kindex A > (Summary)
3731 @findex gnus-summary-end-of-article
3732 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3733
3734 @item A s
3735 @itemx s
3736 @kindex A s (Summary)
3737 @kindex s (Summary)
3738 @findex gnus-summary-isearch-article
3739 Perform an isearch in the article buffer
3740 (@code{gnus-summary-isearch-article}).
3741
3742 @item h
3743 @kindex h (Summary)
3744 @findex gnus-summary-select-article-buffer
3745 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3746
3747 @end table
3748
3749
3750 @node Reply Followup and Post
3751 @section Reply, Followup and Post
3752
3753 @menu
3754 * Summary Mail Commands::            Sending mail.
3755 * Summary Post Commands::            Sending news.
3756 @end menu
3757
3758
3759 @node Summary Mail Commands
3760 @subsection Summary Mail Commands
3761 @cindex mail
3762 @cindex composing mail
3763
3764 Commands for composing a mail message:
3765
3766 @table @kbd
3767
3768 @item S r
3769 @itemx r
3770 @kindex S r (Summary)
3771 @kindex r (Summary)
3772 @findex gnus-summary-reply
3773 @c @icon{gnus-summary-mail-reply}
3774 @c @icon{gnus-summary-reply}
3775 Mail a reply to the author of the current article
3776 (@code{gnus-summary-reply}).
3777
3778 @item S R
3779 @itemx R
3780 @kindex R (Summary)
3781 @kindex S R (Summary)
3782 @findex gnus-summary-reply-with-original
3783 @c @icon{gnus-summary-reply-with-original}
3784 Mail a reply to the author of the current article and include the
3785 original message (@code{gnus-summary-reply-with-original}).  This
3786 command uses the process/prefix convention.
3787
3788 @item S w
3789 @kindex S w (Summary)
3790 @findex gnus-summary-wide-reply
3791 Mail a wide reply to the author of the current article
3792 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3793 goes out to all people listed in the @code{To}, @code{From} (or
3794 @code{Reply-to}) and @code{Cc} headers.
3795
3796 @item S W
3797 @kindex S W (Summary)
3798 @findex gnus-summary-wide-reply-with-original
3799 Mail a wide reply to the current article and include the original
3800 message (@code{gnus-summary-reply-with-original}).  This command uses
3801 the process/prefix convention.
3802
3803 @item S o m
3804 @kindex S o m (Summary)
3805 @findex gnus-summary-mail-forward
3806 @c @icon{gnus-summary-mail-forward}
3807 Forward the current article to some other person
3808 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3809 headers of the forwarded article.
3810
3811 @item S m
3812 @itemx m
3813 @kindex m (Summary)
3814 @kindex S m (Summary)
3815 @findex gnus-summary-mail-other-window
3816 @c @icon{gnus-summary-mail-originate}
3817 Send a mail to some other person
3818 (@code{gnus-summary-mail-other-window}).
3819
3820 @item S D b
3821 @kindex S D b (Summary)
3822 @findex gnus-summary-resend-bounced-mail
3823 @cindex bouncing mail
3824 If you have sent a mail, but the mail was bounced back to you for some
3825 reason (wrong address, transient failure), you can use this command to
3826 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3827 will be popped into a mail buffer where you can edit the headers before
3828 sending the mail off again.  If you give a prefix to this command, and
3829 the bounced mail is a reply to some other mail, Gnus will try to fetch
3830 that mail and display it for easy perusal of its headers.  This might
3831 very well fail, though.
3832
3833 @item S D r
3834 @kindex S D r (Summary)
3835 @findex gnus-summary-resend-message
3836 Not to be confused with the previous command,
3837 @code{gnus-summary-resend-message} will prompt you for an address to
3838 send the current message off to, and then send it to that place.  The
3839 headers of the message won't be altered---but lots of headers that say
3840 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3841 means that you actually send a mail to someone that has a @code{To}
3842 header that (probably) points to yourself.  This will confuse people.
3843 So, natcherly you'll only do that if you're really eVIl.
3844
3845 This command is mainly used if you have several accounts and want to
3846 ship a mail to a different account of yours.  (If you're both
3847 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3848 to the @code{root} account, you may want to resend it to
3849 @code{postmaster}.  Ordnung muß sein!
3850
3851 This command understands the process/prefix convention
3852 (@pxref{Process/Prefix}).
3853
3854 @item S O m
3855 @kindex S O m (Summary)
3856 @findex gnus-uu-digest-mail-forward
3857 Digest the current series (@pxref{Decoding Articles}) and forward the
3858 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
3859 uses the process/prefix convention (@pxref{Process/Prefix}).
3860
3861 @item S M-c
3862 @kindex S M-c (Summary)
3863 @findex gnus-summary-mail-crosspost-complaint
3864 @cindex crossposting
3865 @cindex excessive crossposting
3866 Send a complaint about excessive crossposting to the author of the
3867 current article (@code{gnus-summary-mail-crosspost-complaint}).
3868
3869 @findex gnus-crosspost-complaint
3870 This command is provided as a way to fight back against the current
3871 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3872 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3873 command understands the process/prefix convention
3874 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3875
3876 @end table
3877
3878 Also @pxref{(message)Header Commands} for more information.
3879
3880
3881 @node Summary Post Commands
3882 @subsection Summary Post Commands
3883 @cindex post
3884 @cindex composing news
3885
3886 Commands for posting a news article:
3887
3888 @table @kbd
3889 @item S p
3890 @itemx a
3891 @kindex a (Summary)
3892 @kindex S p (Summary)
3893 @findex gnus-summary-post-news
3894 @c @icon{gnus-summary-post-news}
3895 Post an article to the current group
3896 (@code{gnus-summary-post-news}).
3897
3898 @item S f
3899 @itemx f
3900 @kindex f (Summary)
3901 @kindex S f (Summary)
3902 @findex gnus-summary-followup
3903 @c @icon{gnus-summary-followup}
3904 Post a followup to the current article (@code{gnus-summary-followup}).
3905
3906 @item S F
3907 @itemx F
3908 @kindex S F (Summary)
3909 @kindex F (Summary)
3910 @c @icon{gnus-summary-followup-with-original}
3911 @findex gnus-summary-followup-with-original
3912 Post a followup to the current article and include the original message
3913 (@code{gnus-summary-followup-with-original}).   This command uses the
3914 process/prefix convention.
3915
3916 @item S n
3917 @kindex S n (Summary)
3918 @findex gnus-summary-followup-to-mail
3919 Post a followup to the current article via news, even if you got the
3920 message through mail (@code{gnus-summary-followup-to-mail}).
3921
3922 @item S N
3923 @kindex S N (Summary)
3924 @findex gnus-summary-followup-to-mail-with-original
3925 Post a followup to the current article via news, even if you got the
3926 message through mail and include the original message
3927 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3928 the process/prefix convention.
3929
3930 @item S o p
3931 @kindex S o p (Summary)
3932 @findex gnus-summary-post-forward
3933 Forward the current article to a newsgroup
3934 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3935 headers of the forwarded article.
3936
3937 @item S O p
3938 @kindex S O p (Summary)
3939 @findex gnus-uu-digest-post-forward
3940 @cindex digests
3941 @cindex making digests
3942 Digest the current series and forward the result to a newsgroup
3943 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3944 process/prefix convention.
3945
3946 @item S u
3947 @kindex S u (Summary)
3948 @findex gnus-uu-post-news
3949 @c @icon{gnus-uu-post-news}
3950 Uuencode a file, split it into parts, and post it as a series
3951 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3952 @end table
3953
3954 Also @pxref{(message)Header Commands} for more information.
3955
3956
3957 @node Canceling and Superseding
3958 @section Canceling Articles
3959 @cindex canceling articles
3960 @cindex superseding articles
3961
3962 Have you ever written something, and then decided that you really,
3963 really, really wish you hadn't posted that?
3964
3965 Well, you can't cancel mail, but you can cancel posts.
3966
3967 @findex gnus-summary-cancel-article
3968 @kindex C (Summary)
3969 @c @icon{gnus-summary-cancel-article}
3970 Find the article you wish to cancel (you can only cancel your own
3971 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3972 c} (@code{gnus-summary-cancel-article}).  Your article will be
3973 canceled---machines all over the world will be deleting your article.
3974 This command uses the process/prefix convention (@pxref{Process/Prefix}).
3975
3976 Be aware, however, that not all sites honor cancels, so your article may
3977 live on here and there, while most sites will delete the article in
3978 question.
3979
3980 Gnus will use the ``current'' select method when canceling.  If you
3981 want to use the standard posting method, use the @samp{a} symbolic
3982 prefix (@pxref{Symbolic Prefixes}).
3983
3984 If you discover that you have made some mistakes and want to do some
3985 corrections, you can post a @dfn{superseding} article that will replace
3986 your original article.
3987
3988 @findex gnus-summary-supersede-article
3989 @kindex S (Summary)
3990 Go to the original article and press @kbd{S s}
3991 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3992 where you can edit the article all you want before sending it off the
3993 usual way.
3994
3995 The same goes for superseding as for canceling, only more so: Some
3996 sites do not honor superseding.  On those sites, it will appear that you
3997 have posted almost the same article twice.
3998
3999 If you have just posted the article, and change your mind right away,
4000 there is a trick you can use to cancel/supersede the article without
4001 waiting for the article to appear on your site first.  You simply return
4002 to the post buffer (which is called @code{*sent ...*}).  There you will
4003 find the article you just posted, with all the headers intact.  Change
4004 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4005 header by substituting one of those words for the word
4006 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
4007 you would do normally.  The previous article will be
4008 canceled/superseded.
4009
4010 Just remember, kids: There is no 'c' in 'supersede'.
4011
4012
4013 @node Marking Articles
4014 @section Marking Articles
4015 @cindex article marking
4016 @cindex article ticking
4017 @cindex marks
4018
4019 There are several marks you can set on an article.
4020
4021 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4022 neologism ohoy!) of the article.  Alphabetic marks generally mean
4023 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4024
4025 In addition, you also have marks that do not affect readedness.
4026
4027 @menu
4028 * Unread Articles::      Marks for unread articles.
4029 * Read Articles::        Marks for read articles.
4030 * Other Marks::          Marks that do not affect readedness.
4031 @end menu
4032
4033 @ifinfo
4034 There's a plethora of commands for manipulating these marks:
4035 @end ifinfo
4036
4037 @menu
4038 * Setting Marks::           How to set and remove marks.
4039 * Setting Process Marks::   How to mark articles for later processing.
4040 @end menu
4041
4042
4043 @node Unread Articles
4044 @subsection Unread Articles
4045
4046 The following marks mark articles as (kinda) unread, in one form or
4047 other.
4048
4049 @table @samp
4050 @item !
4051 @vindex gnus-ticked-mark
4052 Marked as ticked (@code{gnus-ticked-mark}).
4053
4054 @dfn{Ticked articles} are articles that will remain visible always.  If
4055 you see an article that you find interesting, or you want to put off
4056 reading it, or replying to it, until sometime later, you'd typically
4057 tick it.  However, articles can be expired, so if you want to keep an
4058 article forever, you'll have to make it persistent (@pxref{Persistent
4059 Articles}).
4060
4061 @item ?
4062 @vindex gnus-dormant-mark
4063 Marked as dormant (@code{gnus-dormant-mark}).
4064
4065 @dfn{Dormant articles} will only appear in the summary buffer if there
4066 are followups to it.  If you want to see them even if they don't have
4067 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4068
4069 @item SPACE
4070 @vindex gnus-unread-mark
4071 Marked as unread (@code{gnus-unread-mark}).
4072
4073 @dfn{Unread articles} are articles that haven't been read at all yet.
4074 @end table
4075
4076
4077 @node Read Articles
4078 @subsection Read Articles
4079 @cindex expirable mark
4080
4081 All the following marks mark articles as read.
4082
4083 @table @samp
4084
4085 @item r
4086 @vindex gnus-del-mark
4087 These are articles that the user has marked as read with the @kbd{d}
4088 command manually, more or less (@code{gnus-del-mark}).
4089
4090 @item R
4091 @vindex gnus-read-mark
4092 Articles that have actually been read (@code{gnus-read-mark}).
4093
4094 @item O
4095 @vindex gnus-ancient-mark
4096 Articles that were marked as read in previous sessions and are now
4097 @dfn{old} (@code{gnus-ancient-mark}).
4098
4099 @item K
4100 @vindex gnus-killed-mark
4101 Marked as killed (@code{gnus-killed-mark}).
4102
4103 @item X
4104 @vindex gnus-kill-file-mark
4105 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4106
4107 @item Y
4108 @vindex gnus-low-score-mark
4109 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4110
4111 @item C
4112 @vindex gnus-catchup-mark
4113 Marked as read by a catchup (@code{gnus-catchup-mark}).
4114
4115 @item G
4116 @vindex gnus-canceled-mark
4117 Canceled article (@code{gnus-canceled-mark})
4118
4119 @item F
4120 @vindex gnus-souped-mark
4121 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4122
4123 @item Q
4124 @vindex gnus-sparse-mark
4125 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4126 Threading}.
4127
4128 @item M
4129 @vindex gnus-duplicate-mark
4130 Article marked as read by duplicate suppression
4131 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4132
4133 @end table
4134
4135 All these marks just mean that the article is marked as read, really.
4136 They are interpreted differently when doing adaptive scoring, though.
4137
4138 One more special mark, though:
4139
4140 @table @samp
4141 @item E
4142 @vindex gnus-expirable-mark
4143 Marked as expirable (@code{gnus-expirable-mark}).
4144
4145 Marking articles as @dfn{expirable} (or have them marked as such
4146 automatically) doesn't make much sense in normal groups---a user doesn't
4147 control expiring of news articles, but in mail groups, for instance,
4148 articles marked as @dfn{expirable} can be deleted by Gnus at
4149 any time.
4150 @end table
4151
4152
4153 @node Other Marks
4154 @subsection Other Marks
4155 @cindex process mark
4156 @cindex bookmarks
4157
4158 There are some marks that have nothing to do with whether the article is
4159 read or not.
4160
4161 @itemize @bullet
4162
4163 @item
4164 You can set a bookmark in the current article.  Say you are reading a
4165 long thesis on cats' urinary tracts, and have to go home for dinner
4166 before you've finished reading the thesis.  You can then set a bookmark
4167 in the article, and Gnus will jump to this bookmark the next time it
4168 encounters the article.  @xref{Setting Marks}
4169
4170 @item
4171 @vindex gnus-replied-mark
4172 All articles that you have replied to or made a followup to (i.e., have
4173 answered) will be marked with an @samp{A} in the second column
4174 (@code{gnus-replied-mark}).
4175
4176 @item
4177 @vindex gnus-cached-mark
4178 Articles stored in the article cache will be marked with an @samp{*} in
4179 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}
4180
4181 @item
4182 @vindex gnus-saved-mark
4183 Articles ``saved'' (in some manner or other; not necessarily
4184 religiously) are marked with an @samp{S} in the second column
4185 (@code{gnus-saved-mark}).
4186
4187 @item
4188 @vindex gnus-not-empty-thread-mark
4189 @vindex gnus-empty-thread-mark
4190 If the @samp{%e} spec is used, the presence of threads or not will be
4191 marked with @code{gnus-not-empty-thread-mark} and
4192 @code{gnus-empty-thread-mark} in the third column, respectively.
4193
4194 @item
4195 @vindex gnus-process-mark
4196 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4197 variety of commands react to the presence of the process mark.  For
4198 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4199 all articles that have been marked with the process mark.  Articles
4200 marked with the process mark have a @samp{#} in the second column.
4201
4202 @end itemize
4203
4204 You might have noticed that most of these ``non-readedness'' marks
4205 appear in the second column by default.  So if you have a cached, saved,
4206 replied article that you have process-marked, what will that look like?
4207
4208 Nothing much.  The precedence rules go as follows: process -> cache ->
4209 replied -> saved.  So if the article is in the cache and is replied,
4210 you'll only see the cache mark and not the replied mark.
4211
4212
4213 @node Setting Marks
4214 @subsection Setting Marks
4215 @cindex setting marks
4216
4217 All the marking commands understand the numeric prefix.
4218
4219 @table @kbd
4220 @item M c
4221 @itemx M-u
4222 @kindex M c (Summary)
4223 @kindex M-u (Summary)
4224 @findex gnus-summary-clear-mark-forward
4225 @cindex mark as unread
4226 Clear all readedness-marks from the current article
4227 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4228 article as unread.
4229
4230 @item M t
4231 @itemx !
4232 @kindex ! (Summary)
4233 @kindex M t (Summary)
4234 @findex gnus-summary-tick-article-forward
4235 Tick the current article (@code{gnus-summary-tick-article-forward}).
4236 @xref{Article Caching}
4237
4238 @item M ?
4239 @itemx ?
4240 @kindex ? (Summary)
4241 @kindex M ? (Summary)
4242 @findex gnus-summary-mark-as-dormant
4243 Mark the current article as dormant
4244 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}
4245
4246 @item M d
4247 @itemx d
4248 @kindex M d (Summary)
4249 @kindex d (Summary)
4250 @findex gnus-summary-mark-as-read-forward
4251 Mark the current article as read
4252 (@code{gnus-summary-mark-as-read-forward}).
4253
4254 @item D
4255 @kindex D (Summary)
4256 @findex gnus-summary-mark-as-read-backward
4257 Mark the current article as read and move point to the previous line
4258 (@code{gnus-summary-mark-as-read-backward}).
4259
4260 @item M k
4261 @itemx k
4262 @kindex k (Summary)
4263 @kindex M k (Summary)
4264 @findex gnus-summary-kill-same-subject-and-select
4265 Mark all articles that have the same subject as the current one as read,
4266 and then select the next unread article
4267 (@code{gnus-summary-kill-same-subject-and-select}).
4268
4269 @item M K
4270 @itemx C-k
4271 @kindex M K (Summary)
4272 @kindex C-k (Summary)
4273 @findex gnus-summary-kill-same-subject
4274 Mark all articles that have the same subject as the current one as read
4275 (@code{gnus-summary-kill-same-subject}).
4276
4277 @item M C
4278 @kindex M C (Summary)
4279 @findex gnus-summary-catchup
4280 @c @icon{gnus-summary-catchup}
4281 Mark all unread articles as read (@code{gnus-summary-catchup}).
4282
4283 @item M C-c
4284 @kindex M C-c (Summary)
4285 @findex gnus-summary-catchup-all
4286 Mark all articles in the group as read---even the ticked and dormant
4287 articles (@code{gnus-summary-catchup-all}).
4288
4289 @item M H
4290 @kindex M H (Summary)
4291 @findex gnus-summary-catchup-to-here
4292 Catchup the current group to point
4293 (@code{gnus-summary-catchup-to-here}).
4294
4295 @item C-w
4296 @kindex C-w (Summary)
4297 @findex gnus-summary-mark-region-as-read
4298 Mark all articles between point and mark as read
4299 (@code{gnus-summary-mark-region-as-read}).
4300
4301 @item M V k
4302 @kindex M V k (Summary)
4303 @findex gnus-summary-kill-below
4304 Kill all articles with scores below the default score (or below the
4305 numeric prefix) (@code{gnus-summary-kill-below}).
4306
4307 @item M e
4308 @itemx E
4309 @kindex M e (Summary)
4310 @kindex E (Summary)
4311 @findex gnus-summary-mark-as-expirable
4312 Mark the current article as expirable
4313 (@code{gnus-summary-mark-as-expirable}).
4314
4315 @item M b
4316 @kindex M b (Summary)
4317 @findex gnus-summary-set-bookmark
4318 Set a bookmark in the current article
4319 (@code{gnus-summary-set-bookmark}).
4320
4321 @item M B
4322 @kindex M B (Summary)
4323 @findex gnus-summary-remove-bookmark
4324 Remove the bookmark from the current article
4325 (@code{gnus-summary-remove-bookmark}).
4326
4327 @item M V c
4328 @kindex M V c (Summary)
4329 @findex gnus-summary-clear-above
4330 Clear all marks from articles with scores over the default score (or
4331 over the numeric prefix) (@code{gnus-summary-clear-above}).
4332
4333 @item M V u
4334 @kindex M V u (Summary)
4335 @findex gnus-summary-tick-above
4336 Tick all articles with scores over the default score (or over the
4337 numeric prefix) (@code{gnus-summary-tick-above}).
4338
4339 @item M V m
4340 @kindex M V m (Summary)
4341 @findex gnus-summary-mark-above
4342 Prompt for a mark, and mark all articles with scores over the default
4343 score (or over the numeric prefix) with this mark
4344 (@code{gnus-summary-clear-above}).
4345 @end table
4346
4347 @vindex gnus-summary-goto-unread
4348 The @code{gnus-summary-goto-unread} variable controls what action should
4349 be taken after setting a mark.  If non-@code{nil}, point will move to
4350 the next/previous unread article.  If @code{nil}, point will just move
4351 one line up or down.  As a special case, if this variable is
4352 @code{never}, all the marking commands as well as other commands (like
4353 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4354 The default is @code{t}.
4355
4356
4357 @node Setting Process Marks
4358 @subsection Setting Process Marks
4359 @cindex setting process marks
4360
4361 @table @kbd
4362
4363 @item M P p
4364 @itemx #
4365 @kindex # (Summary)
4366 @kindex M P p (Summary)
4367 @findex gnus-summary-mark-as-processable
4368 Mark the current article with the process mark
4369 (@code{gnus-summary-mark-as-processable}).
4370 @findex gnus-summary-unmark-as-processable
4371
4372 @item M P u
4373 @itemx M-#
4374 @kindex M P u (Summary)
4375 @kindex M-# (Summary)
4376 Remove the process mark, if any, from the current article
4377 (@code{gnus-summary-unmark-as-processable}).
4378
4379 @item M P U
4380 @kindex M P U (Summary)
4381 @findex gnus-summary-unmark-all-processable
4382 Remove the process mark from all articles
4383 (@code{gnus-summary-unmark-all-processable}).
4384
4385 @item M P i
4386 @kindex M P i (Summary)
4387 @findex gnus-uu-invert-processable
4388 Invert the list of process marked articles
4389 (@code{gnus-uu-invert-processable}).
4390
4391 @item M P R
4392 @kindex M P R (Summary)
4393 @findex gnus-uu-mark-by-regexp
4394 Mark articles that have a @code{Subject} header that matches a regular
4395 expression (@code{gnus-uu-mark-by-regexp}).
4396
4397 @item M P r
4398 @kindex M P r (Summary)
4399 @findex gnus-uu-mark-region
4400 Mark articles in region (@code{gnus-uu-mark-region}).
4401
4402 @item M P t
4403 @kindex M P t (Summary)
4404 @findex gnus-uu-mark-thread
4405 Mark all articles in the current (sub)thread
4406 (@code{gnus-uu-mark-thread}).
4407
4408 @item M P T
4409 @kindex M P T (Summary)
4410 @findex gnus-uu-unmark-thread
4411 Unmark all articles in the current (sub)thread
4412 (@code{gnus-uu-unmark-thread}).
4413
4414 @item M P v
4415 @kindex M P v (Summary)
4416 @findex gnus-uu-mark-over
4417 Mark all articles that have a score above the prefix argument
4418 (@code{gnus-uu-mark-over}).
4419
4420 @item M P s
4421 @kindex M P s (Summary)
4422 @findex gnus-uu-mark-series
4423 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4424
4425 @item M P S
4426 @kindex M P S (Summary)
4427 @findex gnus-uu-mark-sparse
4428 Mark all series that have already had some articles marked
4429 (@code{gnus-uu-mark-sparse}).
4430
4431 @item M P a
4432 @kindex M P a (Summary)
4433 @findex gnus-uu-mark-all
4434 Mark all articles in series order (@code{gnus-uu-mark-series}).
4435
4436 @item M P b
4437 @kindex M P b (Summary)
4438 @findex gnus-uu-mark-buffer
4439 Mark all articles in the buffer in the order they appear
4440 (@code{gnus-uu-mark-buffer}).
4441
4442 @item M P k
4443 @kindex M P k (Summary)
4444 @findex gnus-summary-kill-process-mark
4445 Push the current process mark set onto the stack and unmark all articles
4446 (@code{gnus-summary-kill-process-mark}).
4447
4448 @item M P y
4449 @kindex M P y (Summary)
4450 @findex gnus-summary-yank-process-mark
4451 Pop the previous process mark set from the stack and restore it
4452 (@code{gnus-summary-yank-process-mark}).
4453
4454 @item M P w
4455 @kindex M P w (Summary)
4456 @findex gnus-summary-save-process-mark
4457 Push the current process mark set onto the stack
4458 (@code{gnus-summary-save-process-mark}).
4459
4460 @end table
4461
4462
4463 @node Limiting
4464 @section Limiting
4465 @cindex limiting
4466
4467 It can be convenient to limit the summary buffer to just show some
4468 subset of the articles currently in the group.  The effect most limit
4469 commands have is to remove a few (or many) articles from the summary
4470 buffer.
4471
4472 All limiting commands work on subsets of the articles already fetched
4473 from the servers.  None of these commands query the server for
4474 additional articles.
4475
4476 @table @kbd
4477
4478 @item / /
4479 @itemx / s
4480 @kindex / / (Summary)
4481 @findex gnus-summary-limit-to-subject
4482 Limit the summary buffer to articles that match some subject
4483 (@code{gnus-summary-limit-to-subject}).
4484
4485 @item / a
4486 @kindex / a (Summary)
4487 @findex gnus-summary-limit-to-author
4488 Limit the summary buffer to articles that match some author
4489 (@code{gnus-summary-limit-to-author}).
4490
4491 @item / u
4492 @itemx x
4493 @kindex / u (Summary)
4494 @kindex x (Summary)
4495 @findex gnus-summary-limit-to-unread
4496 Limit the summary buffer to articles not marked as read
4497 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4498 buffer to articles strictly unread.  This means that ticked and
4499 dormant articles will also be excluded.
4500
4501 @item / m
4502 @kindex / m (Summary)
4503 @findex gnus-summary-limit-to-marks
4504 Ask for a mark and then limit to all articles that have been marked
4505 with that mark (@code{gnus-summary-limit-to-marks}).
4506
4507 @item / t
4508 @kindex / t (Summary)
4509 @findex gnus-summary-limit-to-age
4510 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4511 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4512 articles younger than that number of days.
4513
4514 @item / n
4515 @kindex / n (Summary)
4516 @findex gnus-summary-limit-to-articles
4517 Limit the summary buffer to the current article
4518 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4519 convention (@pxref{Process/Prefix}).
4520
4521 @item / w
4522 @kindex / w (Summary)
4523 @findex gnus-summary-pop-limit
4524 Pop the previous limit off the stack and restore it
4525 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4526 the stack.
4527
4528 @item / v
4529 @kindex / v (Summary)
4530 @findex gnus-summary-limit-to-score
4531 Limit the summary buffer to articles that have a score at or above some
4532 score (@code{gnus-summary-limit-to-score}).
4533
4534 @item / E
4535 @itemx M S
4536 @kindex M S (Summary)
4537 @kindex / E (Summary)
4538 @findex gnus-summary-limit-include-expunged
4539 Include all expunged articles in the limit
4540 (@code{gnus-summary-limit-include-expunged}).
4541
4542 @item / D
4543 @kindex / D (Summary)
4544 @findex gnus-summary-limit-include-dormant
4545 Include all dormant articles in the limit
4546 (@code{gnus-summary-limit-include-dormant}).
4547
4548 @item / *
4549 @kindex / * (Summary)
4550 @findex gnus-summary-limit-include-cached
4551 Include all cached articles in the limit
4552 (@code{gnus-summary-limit-include-cached}).
4553
4554 @item / d
4555 @kindex / d (Summary)
4556 @findex gnus-summary-limit-exclude-dormant
4557 Exclude all dormant articles from the limit
4558 (@code{gnus-summary-limit-exclude-dormant}).
4559
4560 @item / T
4561 @kindex / T (Summary)
4562 @findex gnus-summary-limit-include-thread
4563 Include all the articles in the current thread in the limit.
4564
4565 @item / c
4566 @kindex / c (Summary)
4567 @findex gnus-summary-limit-exclude-childless-dormant
4568 Exclude all dormant articles that have no children from the limit
4569 (@code{gnus-summary-limit-exclude-childless-dormant}).
4570
4571 @item / C
4572 @kindex / C (Summary)
4573 @findex gnus-summary-limit-mark-excluded-as-read
4574 Mark all excluded unread articles as read
4575 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4576 also mark excluded ticked and dormant articles as read.
4577
4578 @end table
4579
4580
4581 @node Threading
4582 @section Threading
4583 @cindex threading
4584 @cindex article threading
4585
4586 Gnus threads articles by default.  @dfn{To thread} is to put responses
4587 to articles directly after the articles they respond to---in a
4588 hierarchical fashion.
4589
4590 Threading is done by looking at the @code{References} headers of the
4591 articles.  In a perfect world, this would be enough to build pretty
4592 trees, but unfortunately, the @code{References} header is often broken
4593 or simply missing.  Weird news propagation excarcerbates the problem,
4594 so one has to employ other heuristics to get pleasing results.  A
4595 plethora of approaches exists, as detailed in horrible detail in
4596 @pxref{Customizing Threading}.
4597
4598 First, a quick overview of the concepts:
4599
4600 @table @dfn
4601 @item root
4602 The top-most article in a thread; the first article in the thread.
4603
4604 @item thread
4605 A tree-like article structure.
4606
4607 @item sub-thread
4608 A small(er) section of this tree-like structure.
4609
4610 @item loose threads
4611 Threads often lose their roots due to article expiry, or due to the root
4612 already having been read in a previous session, and not displayed in the
4613 summary buffer.  We then typically have many sub-threads that really
4614 belong to one thread, but are without connecting roots.  These are
4615 called loose threads.
4616
4617 @item thread gathering
4618 An attempt to gather loose threads into bigger threads.
4619
4620 @item sparse threads
4621 A thread where the missing articles have been ``guessed'' at, and are
4622 displayed as empty lines in the summary buffer.
4623
4624 @end table
4625
4626
4627 @menu
4628 * Customizing Threading::     Variables you can change to affect the threading.
4629 * Thread Commands::           Thread based commands in the summary buffer.
4630 @end menu
4631
4632
4633 @node Customizing Threading
4634 @subsection Customizing Threading
4635 @cindex customizing threading
4636
4637 @menu
4638 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
4639 * Filling In Threads::   Making the threads displayed look fuller.
4640 * More Threading::       Even more variables for fiddling with threads.
4641 * Low-Level Threading::  You thought it was over... but you were wrong!
4642 @end menu
4643
4644
4645 @node Loose Threads
4646 @subsubsection Loose Threads
4647 @cindex <
4648 @cindex >
4649 @cindex loose threads
4650
4651 @table @code
4652 @item gnus-summary-make-false-root
4653 @vindex gnus-summary-make-false-root
4654 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4655 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4656 Yup.)  Loose subtrees occur when the real root has expired, or you've
4657 read or killed the root in a previous session.
4658
4659 When there is no real root of a thread, Gnus will have to fudge
4660 something.  This variable says what fudging method Gnus should use.
4661 There are four possible values:
4662
4663 @iftex
4664 @iflatex
4665 \gnusfigure{The Summary Buffer}{390}{
4666 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4667 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4668 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4669 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4670 }
4671 @end iflatex
4672 @end iftex
4673
4674 @cindex adopting articles
4675
4676 @table @code
4677
4678 @item adopt
4679 Gnus will make the first of the orphaned articles the parent.  This
4680 parent will adopt all the other articles.  The adopted articles will be
4681 marked as such by pointy brackets (@samp{<>}) instead of the standard
4682 square brackets (@samp{[]}).  This is the default method.
4683
4684 @item dummy
4685 @vindex gnus-summary-dummy-line-format
4686 Gnus will create a dummy summary line that will pretend to be the
4687 parent.  This dummy line does not correspond to any real article, so
4688 selecting it will just select the first real article after the dummy
4689 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4690 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4691 which is the subject of the article.  @xref{Formatting Variables}.
4692
4693 @item empty
4694 Gnus won't actually make any article the parent, but simply leave the
4695 subject field of all orphans except the first empty.  (Actually, it will
4696 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4697 Buffer Format}).)
4698
4699 @item none
4700 Don't make any article parent at all.  Just gather the threads and
4701 display them after one another.
4702
4703 @item nil
4704 Don't gather loose threads.
4705 @end table
4706
4707 @item gnus-summary-gather-subject-limit
4708 @vindex gnus-summary-gather-subject-limit
4709 Loose threads are gathered by comparing subjects of articles.  If this
4710 variable is @code{nil}, Gnus requires an exact match between the
4711 subjects of the loose threads before gathering them into one big
4712 super-thread.  This might be too strict a requirement, what with the
4713 presence of stupid newsreaders that chop off long subject lines.  If
4714 you think so, set this variable to, say, 20 to require that only the
4715 first 20 characters of the subjects have to match.  If you set this
4716 variable to a really low number, you'll find that Gnus will gather
4717 everything in sight into one thread, which isn't very helpful.
4718
4719 @cindex fuzzy article gathering
4720 If you set this variable to the special value @code{fuzzy}, Gnus will
4721 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4722 Matching}).
4723
4724 @item gnus-simplify-subject-fuzzy-regexp
4725 @vindex gnus-simplify-subject-fuzzy-regexp
4726 This can either be a regular expression or list of regular expressions
4727 that match strings that will be removed from subjects if fuzzy subject
4728 simplification is used.
4729
4730 @item gnus-simplify-ignored-prefixes
4731 @vindex gnus-simplify-ignored-prefixes
4732 If you set @code{gnus-summary-gather-subject-limit} to something as low
4733 as 10, you might consider setting this variable to something sensible:
4734
4735 @c Written by Michael Ernst <mernst@cs.rice.edu>
4736 @lisp
4737 (setq gnus-simplify-ignored-prefixes
4738       (concat
4739        "\\`\\[?\\("
4740        (mapconcat
4741         'identity
4742         '("looking"
4743           "wanted" "followup" "summary\\( of\\)?"
4744           "help" "query" "problem" "question"
4745           "answer" "reference" "announce"
4746           "How can I" "How to" "Comparison of"
4747           ;; ...
4748           )
4749         "\\|")
4750        "\\)\\s *\\("
4751        (mapconcat 'identity
4752                   '("for" "for reference" "with" "about")
4753                   "\\|")
4754        "\\)?\\]?:?[ \t]*"))
4755 @end lisp
4756
4757 All words that match this regexp will be removed before comparing two
4758 subjects.
4759
4760 @item gnus-simplify-subject-functions
4761 @vindex gnus-simplify-subject-functions
4762 If non-@code{nil}, this variable overrides
4763 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4764 list of functions to apply to the @code{Subject} string iteratively to
4765 arrive at the simplified version of the string.
4766
4767 Useful functions to put in this list include:
4768
4769 @table @code
4770 @item gnus-simplify-subject-re
4771 @findex gnus-simplify-subject-re
4772 Strip the leading @samp{Re:}.
4773
4774 @item gnus-simplify-subject-fuzzy
4775 @findex gnus-simplify-subject-fuzzy
4776 Simplify fuzzily.
4777
4778 @item gnus-simplify-whitespace
4779 @findex gnus-simplify-whitespace
4780 Remove excessive whitespace.
4781 @end table
4782
4783 You may also write your own functions, of course.
4784
4785
4786 @item gnus-summary-gather-exclude-subject
4787 @vindex gnus-summary-gather-exclude-subject
4788 Since loose thread gathering is done on subjects only, that might lead
4789 to many false hits, especially with certain common subjects like
4790 @samp{} and @samp{(none)}.  To make the situation slightly better,
4791 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4792 what subjects should be excluded from the gathering process.@*
4793 The default is @samp{^ *$\\|^(none)$}.
4794
4795 @item gnus-summary-thread-gathering-function
4796 @vindex gnus-summary-thread-gathering-function
4797 Gnus gathers threads by looking at @code{Subject} headers.  This means
4798 that totally unrelated articles may end up in the same ``thread'', which
4799 is confusing.  An alternate approach is to look at all the
4800 @code{Message-ID}s in all the @code{References} headers to find matches.
4801 This will ensure that no gathered threads ever include unrelated
4802 articles, but it also means that people who have posted with broken
4803 newsreaders won't be gathered properly.  The choice is yours---plague or
4804 cholera:
4805
4806 @table @code
4807 @item gnus-gather-threads-by-subject
4808 @findex gnus-gather-threads-by-subject
4809 This function is the default gathering function and looks at
4810 @code{Subject}s exclusively.
4811
4812 @item gnus-gather-threads-by-references
4813 @findex gnus-gather-threads-by-references
4814 This function looks at @code{References} headers exclusively.
4815 @end table
4816
4817 If you want to test gathering by @code{References}, you could say
4818 something like:
4819
4820 @lisp
4821 (setq gnus-summary-thread-gathering-function
4822       'gnus-gather-threads-by-references)
4823 @end lisp
4824
4825 @end table
4826
4827
4828 @node Filling In Threads
4829 @subsubsection Filling In Threads
4830
4831 @table @code
4832 @item gnus-fetch-old-headers
4833 @vindex gnus-fetch-old-headers
4834 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4835 more old headers---headers to articles marked as read.  If you
4836 would like to display as few summary lines as possible, but still
4837 connect as many loose threads as possible, you should set this variable
4838 to @code{some} or a number.  If you set it to a number, no more than
4839 that number of extra old headers will be fetched.  In either case,
4840 fetching old headers only works if the backend you are using carries
4841 overview files---this would normally be @code{nntp}, @code{nnspool} and
4842 @code{nnml}.  Also remember that if the root of the thread has been
4843 expired by the server, there's not much Gnus can do about that.
4844
4845 This variable can also be set to @code{invisible}.  This won't have any
4846 visible effects, but is useful if you use the @kbd{A T} command a lot
4847 (@pxref{Finding the Parent}).
4848
4849 @item gnus-build-sparse-threads
4850 @vindex gnus-build-sparse-threads
4851 Fetching old headers can be slow.  A low-rent similar effect can be
4852 gotten by setting this variable to @code{some}.  Gnus will then look at
4853 the complete @code{References} headers of all articles and try to string
4854 together articles that belong in the same thread.  This will leave
4855 @dfn{gaps} in the threading display where Gnus guesses that an article
4856 is missing from the thread.  (These gaps appear like normal summary
4857 lines.  If you select a gap, Gnus will try to fetch the article in
4858 question.)  If this variable is @code{t}, Gnus will display all these
4859 ``gaps'' without regard for whether they are useful for completing the
4860 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4861 off sparse leaf nodes that don't lead anywhere.  This variable is
4862 @code{nil} by default.
4863
4864 @end table
4865
4866
4867 @node More Threading
4868 @subsubsection More Threading
4869
4870 @table @code
4871 @item gnus-show-threads
4872 @vindex gnus-show-threads
4873 If this variable is @code{nil}, no threading will be done, and all of
4874 the rest of the variables here will have no effect.  Turning threading
4875 off will speed group selection up a bit, but it is sure to make reading
4876 slower and more awkward.
4877
4878 @item gnus-thread-hide-subtree
4879 @vindex gnus-thread-hide-subtree
4880 If non-@code{nil}, all threads will be hidden when the summary buffer is
4881 generated.
4882
4883 @item gnus-thread-expunge-below
4884 @vindex gnus-thread-expunge-below
4885 All threads that have a total score (as defined by
4886 @code{gnus-thread-score-function}) less than this number will be
4887 expunged.  This variable is @code{nil} by default, which means that no
4888 threads are expunged.
4889
4890 @item gnus-thread-hide-killed
4891 @vindex gnus-thread-hide-killed
4892 if you kill a thread and this variable is non-@code{nil}, the subtree
4893 will be hidden.
4894
4895 @item gnus-thread-ignore-subject
4896 @vindex gnus-thread-ignore-subject
4897 Sometimes somebody changes the subject in the middle of a thread.  If
4898 this variable is non-@code{nil}, the subject change is ignored.  If it
4899 is @code{nil}, which is the default, a change in the subject will result
4900 in a new thread.
4901
4902 @item gnus-thread-indent-level
4903 @vindex gnus-thread-indent-level
4904 This is a number that says how much each sub-thread should be indented.
4905 The default is 4.
4906
4907 @end table
4908
4909
4910 @node Low-Level Threading
4911 @subsubsection Low-Level Threading
4912
4913 @table @code
4914
4915 @item gnus-parse-headers-hook
4916 @vindex gnus-parse-headers-hook
4917 Hook run before parsing any headers.  The default value is
4918 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4919 slightly decoded in a hackish way.  This is likely to change in the
4920 future when Gnus becomes @sc{MIME}ified.
4921
4922 @item gnus-alter-header-function
4923 @vindex gnus-alter-header-function
4924 If non-@code{nil}, this function will be called to allow alteration of
4925 article header structures.  The function is called with one parameter,
4926 the article header vector, which it may alter in any way.  For instance,
4927 if you have a mail-to-news gateway which alters the @code{Message-ID}s
4928 in systematic ways (by adding prefixes and such), you can use this
4929 variable to un-scramble the @code{Message-ID}s so that they are more
4930 meaningful.  Here's one example:
4931
4932 @lisp
4933 (setq gnus-alter-header-function 'my-alter-message-id)
4934
4935 (defun my-alter-message-id (header)
4936   (let ((id (mail-header-id header)))
4937     (when (string-match
4938            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
4939       (mail-header-set-id
4940        (concat (match-string 1 id) "@@" (match-string 2 id))
4941        header))))
4942 @end lisp
4943
4944 @end table
4945
4946
4947 @node Thread Commands
4948 @subsection Thread Commands
4949 @cindex thread commands
4950
4951 @table @kbd
4952
4953 @item T k
4954 @itemx M-C-k
4955 @kindex T k (Summary)
4956 @kindex M-C-k (Summary)
4957 @findex gnus-summary-kill-thread
4958 Mark all articles in the current (sub-)thread as read
4959 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4960 remove all marks instead.  If the prefix argument is negative, tick
4961 articles instead.
4962
4963 @item T l
4964 @itemx M-C-l
4965 @kindex T l (Summary)
4966 @kindex M-C-l (Summary)
4967 @findex gnus-summary-lower-thread
4968 Lower the score of the current (sub-)thread
4969 (@code{gnus-summary-lower-thread}).
4970
4971 @item T i
4972 @kindex T i (Summary)
4973 @findex gnus-summary-raise-thread
4974 Increase the score of the current (sub-)thread
4975 (@code{gnus-summary-raise-thread}).
4976
4977 @item T #
4978 @kindex T # (Summary)
4979 @findex gnus-uu-mark-thread
4980 Set the process mark on the current (sub-)thread
4981 (@code{gnus-uu-mark-thread}).
4982
4983 @item T M-#
4984 @kindex T M-# (Summary)
4985 @findex gnus-uu-unmark-thread
4986 Remove the process mark from the current (sub-)thread
4987 (@code{gnus-uu-unmark-thread}).
4988
4989 @item T T
4990 @kindex T T (Summary)
4991 @findex gnus-summary-toggle-threads
4992 Toggle threading (@code{gnus-summary-toggle-threads}).
4993
4994 @item T s
4995 @kindex T s (Summary)
4996 @findex gnus-summary-show-thread
4997 Expose the (sub-)thread hidden under the current article, if any
4998 (@code{gnus-summary-show-thread}).
4999
5000 @item T h
5001 @kindex T h (Summary)
5002 @findex gnus-summary-hide-thread
5003 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5004
5005 @item T S
5006 @kindex T S (Summary)
5007 @findex gnus-summary-show-all-threads
5008 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5009
5010 @item T H
5011 @kindex T H (Summary)
5012 @findex gnus-summary-hide-all-threads
5013 Hide all threads (@code{gnus-summary-hide-all-threads}).
5014
5015 @item T t
5016 @kindex T t (Summary)
5017 @findex gnus-summary-rethread-current
5018 Re-thread the current article's thread
5019 (@code{gnus-summary-rethread-current}).  This works even when the
5020 summary buffer is otherwise unthreaded.
5021
5022 @item T ^
5023 @kindex T ^ (Summary)
5024 @findex gnus-summary-reparent-thread
5025 Make the current article the child of the marked (or previous) article
5026 (@code{gnus-summary-reparent-thread}).
5027
5028 @end table
5029
5030 The following commands are thread movement commands.  They all
5031 understand the numeric prefix.
5032
5033 @table @kbd
5034
5035 @item T n
5036 @kindex T n (Summary)
5037 @findex gnus-summary-next-thread
5038 Go to the next thread (@code{gnus-summary-next-thread}).
5039
5040 @item T p
5041 @kindex T p (Summary)
5042 @findex gnus-summary-prev-thread
5043 Go to the previous thread (@code{gnus-summary-prev-thread}).
5044
5045 @item T d
5046 @kindex T d (Summary)
5047 @findex gnus-summary-down-thread
5048 Descend the thread (@code{gnus-summary-down-thread}).
5049
5050 @item T u
5051 @kindex T u (Summary)
5052 @findex gnus-summary-up-thread
5053 Ascend the thread (@code{gnus-summary-up-thread}).
5054
5055 @item T o
5056 @kindex T o (Summary)
5057 @findex gnus-summary-top-thread
5058 Go to the top of the thread (@code{gnus-summary-top-thread}).
5059 @end table
5060
5061 @vindex gnus-thread-operation-ignore-subject
5062 If you ignore subject while threading, you'll naturally end up with
5063 threads that have several different subjects in them.  If you then issue
5064 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5065 wish to kill the entire thread, but just those parts of the thread that
5066 have the same subject as the current article.  If you like this idea,
5067 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
5068 is non-@code{nil} (which it is by default), subjects will be ignored
5069 when doing thread commands.  If this variable is @code{nil}, articles in
5070 the same thread with different subjects will not be included in the
5071 operation in question.  If this variable is @code{fuzzy}, only articles
5072 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5073 Matching}).
5074
5075
5076 @node Sorting
5077 @section Sorting
5078
5079 @findex gnus-thread-sort-by-total-score
5080 @findex gnus-thread-sort-by-date
5081 @findex gnus-thread-sort-by-score
5082 @findex gnus-thread-sort-by-subject
5083 @findex gnus-thread-sort-by-author
5084 @findex gnus-thread-sort-by-number
5085 @vindex gnus-thread-sort-functions
5086 If you are using a threaded summary display, you can sort the threads by
5087 setting @code{gnus-thread-sort-functions}, which is a list of functions.
5088 By default, sorting is done on article numbers.  Ready-made sorting
5089 predicate functions include @code{gnus-thread-sort-by-number},
5090 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5091 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5092 @code{gnus-thread-sort-by-total-score}.
5093
5094 Each function takes two threads and returns non-@code{nil} if the first
5095 thread should be sorted before the other.  Note that sorting really is
5096 normally done by looking only at the roots of each thread.  If you use
5097 more than one function, the primary sort key should be the last function
5098 in the list.  You should probably always include
5099 @code{gnus-thread-sort-by-number} in the list of sorting
5100 functions---preferably first.  This will ensure that threads that are
5101 equal with respect to the other sort criteria will be displayed in
5102 ascending article order.
5103
5104 If you would like to sort by score, then by subject, and finally by
5105 number, you could do something like:
5106
5107 @lisp
5108 (setq gnus-thread-sort-functions
5109       '(gnus-thread-sort-by-number
5110         gnus-thread-sort-by-subject
5111         gnus-thread-sort-by-total-score))
5112 @end lisp
5113
5114 The threads that have highest score will be displayed first in the
5115 summary buffer.  When threads have the same score, they will be sorted
5116 alphabetically.  The threads that have the same score and the same
5117 subject will be sorted by number, which is (normally) the sequence in
5118 which the articles arrived.
5119
5120 If you want to sort by score and then reverse arrival order, you could
5121 say something like:
5122
5123 @lisp
5124 (setq gnus-thread-sort-functions
5125       '((lambda (t1 t2)
5126           (not (gnus-thread-sort-by-number t1 t2)))
5127         gnus-thread-sort-by-score))
5128 @end lisp
5129
5130 @vindex gnus-thread-score-function
5131 The function in the @code{gnus-thread-score-function} variable (default
5132 @code{+}) is used for calculating the total score of a thread.  Useful
5133 functions might be @code{max}, @code{min}, or squared means, or whatever
5134 tickles your fancy.
5135
5136 @findex gnus-article-sort-functions
5137 @findex gnus-article-sort-by-date
5138 @findex gnus-article-sort-by-score
5139 @findex gnus-article-sort-by-subject
5140 @findex gnus-article-sort-by-author
5141 @findex gnus-article-sort-by-number
5142 If you are using an unthreaded display for some strange reason or other,
5143 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5144 It is very similar to the @code{gnus-thread-sort-functions}, except that
5145 it uses slightly different functions for article comparison.  Available
5146 sorting predicate functions are @code{gnus-article-sort-by-number},
5147 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5148 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5149
5150 If you want to sort an unthreaded summary display by subject, you could
5151 say something like:
5152
5153 @lisp
5154 (setq gnus-article-sort-functions
5155       '(gnus-article-sort-by-number
5156         gnus-article-sort-by-subject))
5157 @end lisp
5158
5159
5160
5161 @node Asynchronous Fetching
5162 @section Asynchronous Article Fetching
5163 @cindex asynchronous article fetching
5164 @cindex article pre-fetch
5165 @cindex pre-fetch
5166
5167 If you read your news from an @sc{nntp} server that's far away, the
5168 network latencies may make reading articles a chore.  You have to wait
5169 for a while after pressing @kbd{n} to go to the next article before the
5170 article appears.  Why can't Gnus just go ahead and fetch the article
5171 while you are reading the previous one?  Why not, indeed.
5172
5173 First, some caveats.  There are some pitfalls to using asynchronous
5174 article fetching, especially the way Gnus does it.
5175
5176 Let's say you are reading article 1, which is short, and article 2 is
5177 quite long, and you are not interested in reading that.  Gnus does not
5178 know this, so it goes ahead and fetches article 2.  You decide to read
5179 article 3, but since Gnus is in the process of fetching article 2, the
5180 connection is blocked.
5181
5182 To avoid these situations, Gnus will open two (count 'em two)
5183 connections to the server.  Some people may think this isn't a very nice
5184 thing to do, but I don't see any real alternatives.  Setting up that
5185 extra connection takes some time, so Gnus startup will be slower.
5186
5187 Gnus will fetch more articles than you will read.  This will mean that
5188 the link between your machine and the @sc{nntp} server will become more
5189 loaded than if you didn't use article pre-fetch.  The server itself will
5190 also become more loaded---both with the extra article requests, and the
5191 extra connection.
5192
5193 Ok, so now you know that you shouldn't really use this thing...  unless
5194 you really want to.
5195
5196 @vindex gnus-asynchronous
5197 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5198 happen automatically.
5199
5200 @vindex gnus-use-article-prefetch
5201 You can control how many articles are to be pre-fetched by setting
5202 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5203 that when you read an article in the group, the backend will pre-fetch
5204 the next 30 articles.  If this variable is @code{t}, the backend will
5205 pre-fetch all the articles it can without bound.  If it is
5206 @code{nil}, no pre-fetching will be done.
5207
5208 @vindex gnus-async-prefetch-article-p
5209 @findex gnus-async-read-p
5210 There are probably some articles that you don't want to pre-fetch---read
5211 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5212 return non-@code{nil} when the article in question is to be
5213 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5214 @code{nil} on read articles.  The function is called with an article
5215 data structure as the only parameter.
5216
5217 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5218
5219 @lisp
5220 (defun my-async-short-unread-p (data)
5221   "Return non-nil for short, unread articles."
5222   (and (gnus-data-unread-p data)
5223        (< (mail-header-lines (gnus-data-header data))
5224           100)))
5225
5226 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5227 @end lisp
5228
5229 These functions will be called many, many times, so they should
5230 preferably be short and sweet to avoid slowing down Gnus too much.
5231 It's probably a good idea to byte-compile things like this.
5232
5233 @vindex gnus-prefetched-article-deletion-strategy
5234 Articles have to be removed from the asynch buffer sooner or later.  The
5235 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5236 articles.  This is a list that may contain the following elements:
5237
5238 @table @code
5239 @item read
5240 Remove articles when they are read.
5241
5242 @item exit
5243 Remove articles when exiting the group.
5244 @end table
5245
5246 The default value is @code{(read exit)}.
5247
5248 @c @vindex gnus-use-header-prefetch
5249 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5250 @c from the next group.
5251
5252
5253 @node Article Caching
5254 @section Article Caching
5255 @cindex article caching
5256 @cindex caching
5257
5258 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5259 consider turning article caching on.  Each article will then be stored
5260 locally under your home directory.  As you may surmise, this could
5261 potentially use @emph{huge} amounts of disk space, as well as eat up all
5262 your inodes so fast it will make your head swim.  In vodka.
5263
5264 Used carefully, though, it could be just an easier way to save articles.
5265
5266 @vindex gnus-use-long-file-name
5267 @vindex gnus-cache-directory
5268 @vindex gnus-use-cache
5269 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5270 all articles ticked or marked as dormant will then be copied
5271 over to your local cache (@code{gnus-cache-directory}).  Whether this
5272 cache is flat or hierarchal is controlled by the
5273 @code{gnus-use-long-file-name} variable, as usual.
5274
5275 When re-selecting a ticked or dormant article, it will be fetched from the
5276 cache instead of from the server.  As articles in your cache will never
5277 expire, this might serve as a method of saving articles while still
5278 keeping them where they belong.  Just mark all articles you want to save
5279 as dormant, and don't worry.
5280
5281 When an article is marked as read, is it removed from the cache.
5282
5283 @vindex gnus-cache-remove-articles
5284 @vindex gnus-cache-enter-articles
5285 The entering/removal of articles from the cache is controlled by the
5286 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5287 variables.  Both are lists of symbols.  The first is @code{(ticked
5288 dormant)} by default, meaning that ticked and dormant articles will be
5289 put in the cache.  The latter is @code{(read)} by default, meaning that
5290 articles marked as read are removed from the cache.  Possibly
5291 symbols in these two lists are @code{ticked}, @code{dormant},
5292 @code{unread} and @code{read}.
5293
5294 @findex gnus-jog-cache
5295 So where does the massive article-fetching and storing come into the
5296 picture?  The @code{gnus-jog-cache} command will go through all
5297 subscribed newsgroups, request all unread articles, score them, and
5298 store them in the cache.  You should only ever, ever ever ever, use this
5299 command if 1) your connection to the @sc{nntp} server is really, really,
5300 really slow and 2) you have a really, really, really huge disk.
5301 Seriously.  One way to cut down on the number of articles downloaded is
5302 to score unwanted articles down and have them marked as read.  They will
5303 not then be downloaded by this command.
5304
5305 @vindex gnus-uncacheable-groups
5306 @vindex gnus-cacheable-groups
5307 It is likely that you do not want caching on all groups.  For instance,
5308 if your @code{nnml} mail is located under your home directory, it makes no
5309 sense to cache it somewhere else under your home directory.  Unless you
5310 feel that it's neat to use twice as much space.  
5311
5312 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5313 regexp of groups to cache, @samp{^nntp} for instance, or set the
5314 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5315 Both variables are @code{nil} by default. If a group matches both
5316 variables, the group is not cached.
5317
5318 @findex gnus-cache-generate-nov-databases
5319 @findex gnus-cache-generate-active
5320 @vindex gnus-cache-active-file
5321 The cache stores information on what articles it contains in its active
5322 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5323 of the cache) becomes all messed up for some reason or other, Gnus
5324 offers two functions that will try to set things right.  @kbd{M-x
5325 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5326 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5327 file.
5328
5329
5330 @node Persistent Articles
5331 @section Persistent Articles
5332 @cindex persistent articles
5333
5334 Closely related to article caching, we have @dfn{persistent articles}.
5335 In fact, it's just a different way of looking at caching, and much more
5336 useful in my opinion.
5337
5338 Say you're reading a newsgroup, and you happen on to some valuable gem
5339 that you want to keep and treasure forever.  You'd normally just save it
5340 (using one of the many saving commands) in some file.  The problem with
5341 that is that it's just, well, yucky.  Ideally you'd prefer just having
5342 the article remain in the group where you found it forever; untouched by
5343 the expiry going on at the news server.
5344
5345 This is what a @dfn{persistent article} is---an article that just won't
5346 be deleted.  It's implemented using the normal cache functions, but
5347 you use two explicit commands for managing persistent articles:
5348
5349 @table @kbd
5350
5351 @item *
5352 @kindex * (Summary)
5353 @findex gnus-cache-enter-article
5354 Make the current article persistent (@code{gnus-cache-enter-article}).
5355
5356 @item M-*
5357 @kindex M-* (Summary)
5358 @findex gnus-cache-remove-article
5359 Remove the current article from the persistent articles
5360 (@code{gnus-cache-remove-article}).  This will normally delete the
5361 article.
5362 @end table
5363
5364 Both these commands understand the process/prefix convention.
5365
5366 To avoid having all ticked articles (and stuff) entered into the cache,
5367 you should set @code{gnus-use-cache} to @code{passive} if you're just
5368 interested in persistent articles:
5369
5370 @lisp
5371 (setq gnus-use-cache 'passive)
5372 @end lisp
5373
5374
5375 @node Article Backlog
5376 @section Article Backlog
5377 @cindex backlog
5378 @cindex article backlog
5379
5380 If you have a slow connection, but the idea of using caching seems
5381 unappealing to you (and it is, really), you can help the situation some
5382 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5383 already read articles so that it doesn't have to re-fetch articles
5384 you've already read.  This only helps if you are in the habit of
5385 re-selecting articles you've recently read, of course.  If you never do
5386 that, turning the backlog on will slow Gnus down a little bit, and
5387 increase memory usage some.
5388
5389 @vindex gnus-keep-backlog
5390 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5391 at most @var{n} old articles in a buffer for later re-fetching.  If this
5392 variable is non-@code{nil} and is not a number, Gnus will store
5393 @emph{all} read articles, which means that your Emacs will grow without
5394 bound before exploding and taking your machine down with you.  I put
5395 that in there just to keep y'all on your toes.
5396
5397 This variable is @code{nil} by default.
5398
5399
5400 @node Saving Articles
5401 @section Saving Articles
5402 @cindex saving articles
5403
5404 Gnus can save articles in a number of ways.  Below is the documentation
5405 for saving articles in a fairly straight-forward fashion (i.e., little
5406 processing of the article is done before it is saved).  For a different
5407 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5408 (@pxref{Decoding Articles}).
5409
5410 @vindex gnus-save-all-headers
5411 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5412 unwanted headers before saving the article.
5413
5414 @vindex gnus-saved-headers
5415 If the preceding variable is @code{nil}, all headers that match the
5416 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5417 deleted before saving.
5418
5419 @table @kbd
5420
5421 @item O o
5422 @itemx o
5423 @kindex O o (Summary)
5424 @kindex o (Summary)
5425 @findex gnus-summary-save-article
5426 @c @icon{gnus-summary-save-article}
5427 Save the current article using the default article saver
5428 (@code{gnus-summary-save-article}).
5429
5430 @item O m
5431 @kindex O m (Summary)
5432 @findex gnus-summary-save-article-mail
5433 Save the current article in mail format
5434 (@code{gnus-summary-save-article-mail}).
5435
5436 @item O r
5437 @kindex O r (Summary)
5438 @findex gnus-summary-save-article-rmail
5439 Save the current article in rmail format
5440 (@code{gnus-summary-save-article-rmail}).
5441
5442 @item O f
5443 @kindex O f (Summary)
5444 @findex gnus-summary-save-article-file
5445 @c @icon{gnus-summary-save-article-file}
5446 Save the current article in plain file format
5447 (@code{gnus-summary-save-article-file}).
5448
5449 @item O F
5450 @kindex O F (Summary)
5451 @findex gnus-summary-write-article-file
5452 Write the current article in plain file format, overwriting any previous
5453 file contents (@code{gnus-summary-write-article-file}).
5454
5455 @item O b
5456 @kindex O b (Summary)
5457 @findex gnus-summary-save-article-body-file
5458 Save the current article body in plain file format
5459 (@code{gnus-summary-save-article-body-file}).
5460
5461 @item O h
5462 @kindex O h (Summary)
5463 @findex gnus-summary-save-article-folder
5464 Save the current article in mh folder format
5465 (@code{gnus-summary-save-article-folder}).
5466
5467 @item O v
5468 @kindex O v (Summary)
5469 @findex gnus-summary-save-article-vm
5470 Save the current article in a VM folder
5471 (@code{gnus-summary-save-article-vm}).
5472
5473 @item O p
5474 @kindex O p (Summary)
5475 @findex gnus-summary-pipe-output
5476 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5477 the current article to a process (@code{gnus-summary-pipe-output}).
5478 @end table
5479
5480 @vindex gnus-prompt-before-saving
5481 All these commands use the process/prefix convention
5482 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5483 functions, you might get tired of being prompted for files to save each
5484 and every article in.  The prompting action is controlled by
5485 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5486 default, giving you that excessive prompting action you know and
5487 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5488 just once for each series of articles you save.  If you like to really
5489 have Gnus do all your thinking for you, you can even set this variable
5490 to @code{nil}, which means that you will never be prompted for files to
5491 save articles in.  Gnus will simply save all the articles in the default
5492 files.
5493
5494
5495 @vindex gnus-default-article-saver
5496 You can customize the @code{gnus-default-article-saver} variable to make
5497 Gnus do what you want it to.  You can use any of the four ready-made
5498 functions below, or you can create your own.
5499
5500 @table @code
5501
5502 @item gnus-summary-save-in-rmail
5503 @findex gnus-summary-save-in-rmail
5504 @vindex gnus-rmail-save-name
5505 @findex gnus-plain-save-name
5506 This is the default format, @dfn{babyl}.  Uses the function in the
5507 @code{gnus-rmail-save-name} variable to get a file name to save the
5508 article in.  The default is @code{gnus-plain-save-name}.
5509
5510 @item gnus-summary-save-in-mail
5511 @findex gnus-summary-save-in-mail
5512 @vindex gnus-mail-save-name
5513 Save in a Unix mail (mbox) file.  Uses the function in the
5514 @code{gnus-mail-save-name} variable to get a file name to save the
5515 article in.  The default is @code{gnus-plain-save-name}.
5516
5517 @item gnus-summary-save-in-file
5518 @findex gnus-summary-save-in-file
5519 @vindex gnus-file-save-name
5520 @findex gnus-numeric-save-name
5521 Append the article straight to an ordinary file.  Uses the function in
5522 the @code{gnus-file-save-name} variable to get a file name to save the
5523 article in.  The default is @code{gnus-numeric-save-name}.
5524
5525 @item gnus-summary-save-body-in-file
5526 @findex gnus-summary-save-body-in-file
5527 Append the article body to an ordinary file.  Uses the function in the
5528 @code{gnus-file-save-name} variable to get a file name to save the
5529 article in.  The default is @code{gnus-numeric-save-name}.
5530
5531 @item gnus-summary-save-in-folder
5532 @findex gnus-summary-save-in-folder
5533 @findex gnus-folder-save-name
5534 @findex gnus-Folder-save-name
5535 @vindex gnus-folder-save-name
5536 @cindex rcvstore
5537 @cindex MH folders
5538 Save the article to an MH folder using @code{rcvstore} from the MH
5539 library.  Uses the function in the @code{gnus-folder-save-name} variable
5540 to get a file name to save the article in.  The default is
5541 @code{gnus-folder-save-name}, but you can also use
5542 @code{gnus-Folder-save-name}, which creates capitalized names.
5543
5544 @item gnus-summary-save-in-vm
5545 @findex gnus-summary-save-in-vm
5546 Save the article in a VM folder.  You have to have the VM mail
5547 reader to use this setting.
5548 @end table
5549
5550 @vindex gnus-article-save-directory
5551 All of these functions, except for the last one, will save the article
5552 in the @code{gnus-article-save-directory}, which is initialized from the
5553 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5554 default.
5555
5556 As you can see above, the functions use different functions to find a
5557 suitable name of a file to save the article in.  Below is a list of
5558 available functions that generate names:
5559
5560 @table @code
5561
5562 @item gnus-Numeric-save-name
5563 @findex gnus-Numeric-save-name
5564 File names like @file{~/News/Alt.andrea-dworkin/45}.
5565
5566 @item gnus-numeric-save-name
5567 @findex gnus-numeric-save-name
5568 File names like @file{~/News/alt.andrea-dworkin/45}.
5569
5570 @item gnus-Plain-save-name
5571 @findex gnus-Plain-save-name
5572 File names like @file{~/News/Alt.andrea-dworkin}.
5573
5574 @item gnus-plain-save-name
5575 @findex gnus-plain-save-name
5576 File names like @file{~/News/alt.andrea-dworkin}.
5577 @end table
5578
5579 @vindex gnus-split-methods
5580 You can have Gnus suggest where to save articles by plonking a regexp into
5581 the @code{gnus-split-methods} alist.  For instance, if you would like to
5582 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5583 related to VM in @code{vm-stuff}, you could set this variable to something
5584 like:
5585
5586 @lisp
5587 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5588  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5589  (my-choosing-function "../other-dir/my-stuff")
5590  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5591 @end lisp
5592
5593 We see that this is a list where each element is a list that has two
5594 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5595 a string (in which case it is used as a regexp to match on the article
5596 head); it can be a symbol (which will be called as a function with the
5597 group name as a parameter); or it can be a list (which will be
5598 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5599 the @dfn{file} will be used as a default prompt.  In addition, the
5600 result of the operation itself will be used if the function or form
5601 called returns a string or a list of strings.
5602
5603 You basically end up with a list of file names that might be used when
5604 saving the current article.  (All ``matches'' will be used.)  You will
5605 then be prompted for what you really want to use as a name, with file
5606 name completion over the results from applying this variable.
5607
5608 This variable is @code{((gnus-article-archive-name))} by default, which
5609 means that Gnus will look at the articles it saves for an
5610 @code{Archive-name} line and use that as a suggestion for the file
5611 name.
5612
5613 Here's an example function to clean up file names somewhat.  If you have
5614 lots of mail groups called things like
5615 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5616 these group names before creating the file name to save to.  The
5617 following will do just that:
5618
5619 @lisp
5620 (defun my-save-name (group)
5621   (when (string-match "^nnml:mail." group)
5622     (substring group (match-end 0))))
5623
5624 (setq gnus-split-methods
5625       '((gnus-article-archive-name)
5626         (my-save-name)))
5627 @end lisp
5628
5629
5630 @vindex gnus-use-long-file-name
5631 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5632 @code{nil}, all the preceding functions will replace all periods
5633 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5634 the functions will generate hierarchies of directories instead of having
5635 all the files in the top level directory
5636 (@file{~/News/alt/andrea-dworkin} instead of
5637 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5638 on most systems.  However, for historical reasons, this is @code{nil} on
5639 Xenix and usg-unix-v machines by default.
5640
5641 This function also affects kill and score file names.  If this variable
5642 is a list, and the list contains the element @code{not-score}, long file
5643 names will not be used for score files, if it contains the element
5644 @code{not-save}, long file names will not be used for saving, and if it
5645 contains the element @code{not-kill}, long file names will not be used
5646 for kill files.
5647
5648 If you'd like to save articles in a hierarchy that looks something like
5649 a spool, you could
5650
5651 @lisp
5652 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5653 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5654 @end lisp
5655
5656 Then just save with @kbd{o}.  You'd then read this hierarchy with
5657 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5658 the top level directory as the argument (@file{~/News/}).  Then just walk
5659 around to the groups/directories with @code{nneething}.
5660
5661
5662 @node Decoding Articles
5663 @section Decoding Articles
5664 @cindex decoding articles
5665
5666 Sometime users post articles (or series of articles) that have been
5667 encoded in some way or other.  Gnus can decode them for you.
5668
5669 @menu
5670 * Uuencoded Articles::    Uudecode articles.
5671 * Shell Archives::        Unshar articles.
5672 * PostScript Files::      Split PostScript.
5673 * Other Files::           Plain save and binhex.
5674 * Decoding Variables::    Variables for a happy decoding.
5675 * Viewing Files::         You want to look at the result of the decoding?
5676 @end menu
5677
5678 @cindex series
5679 @cindex article series
5680 All these functions use the process/prefix convention
5681 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5682 the extension that a ``single article'' means ``a single series''.  Gnus
5683 can find out by itself what articles belong to a series, decode all the
5684 articles and unpack/view/save the resulting file(s).
5685
5686 Gnus guesses what articles are in the series according to the following
5687 simplish rule: The subjects must be (nearly) identical, except for the
5688 last two numbers of the line.  (Spaces are largely ignored, however.)
5689
5690 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5691 will find all the articles that match the regexp @samp{^cat.gif
5692 ([0-9]+/[0-9]+).*$}.
5693
5694 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5695 series}, will not be properly recognized by any of the automatic viewing
5696 commands, and you have to mark the articles manually with @kbd{#}.
5697
5698
5699 @node Uuencoded Articles
5700 @subsection Uuencoded Articles
5701 @cindex uudecode
5702 @cindex uuencoded articles
5703
5704 @table @kbd
5705
5706 @item X u
5707 @kindex X u (Summary)
5708 @findex gnus-uu-decode-uu
5709 @c @icon{gnus-uu-decode-uu}
5710 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5711
5712 @item X U
5713 @kindex X U (Summary)
5714 @findex gnus-uu-decode-uu-and-save
5715 Uudecodes and saves the current series
5716 (@code{gnus-uu-decode-uu-and-save}).
5717
5718 @item X v u
5719 @kindex X v u (Summary)
5720 @findex gnus-uu-decode-uu-view
5721 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5722
5723 @item X v U
5724 @kindex X v U (Summary)
5725 @findex gnus-uu-decode-uu-and-save-view
5726 Uudecodes, views and saves the current series
5727 (@code{gnus-uu-decode-uu-and-save-view}).
5728
5729 @end table
5730
5731 Remember that these all react to the presence of articles marked with
5732 the process mark.  If, for instance, you'd like to decode and save an
5733 entire newsgroup, you'd typically do @kbd{M P a}
5734 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5735 (@code{gnus-uu-decode-uu-and-save}).
5736
5737 All this is very much different from how @code{gnus-uu} worked with
5738 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5739 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5740 articles in some way (@pxref{Setting Process Marks}) and then press
5741 @kbd{X u}.
5742
5743 @vindex gnus-uu-notify-files
5744 Note: When trying to decode articles that have names matching
5745 @code{gnus-uu-notify-files}, which is hard-coded to
5746 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5747 automatically post an article on @samp{comp.unix.wizards} saying that
5748 you have just viewed the file in question.  This feature can't be turned
5749 off.
5750
5751
5752 @node Shell Archives
5753 @subsection Shell Archives
5754 @cindex unshar
5755 @cindex shell archives
5756 @cindex shared articles
5757
5758 Shell archives (``shar files'') used to be a popular way to distribute
5759 sources, but it isn't used all that much today.  In any case, we have
5760 some commands to deal with these:
5761
5762 @table @kbd
5763
5764 @item X s
5765 @kindex X s (Summary)
5766 @findex gnus-uu-decode-unshar
5767 Unshars the current series (@code{gnus-uu-decode-unshar}).
5768
5769 @item X S
5770 @kindex X S (Summary)
5771 @findex gnus-uu-decode-unshar-and-save
5772 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5773
5774 @item X v s
5775 @kindex X v s (Summary)
5776 @findex gnus-uu-decode-unshar-view
5777 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5778
5779 @item X v S
5780 @kindex X v S (Summary)
5781 @findex gnus-uu-decode-unshar-and-save-view
5782 Unshars, views and saves the current series
5783 (@code{gnus-uu-decode-unshar-and-save-view}).
5784 @end table
5785
5786
5787 @node PostScript Files
5788 @subsection PostScript Files
5789 @cindex PostScript
5790
5791 @table @kbd
5792
5793 @item X p
5794 @kindex X p (Summary)
5795 @findex gnus-uu-decode-postscript
5796 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5797
5798 @item X P
5799 @kindex X P (Summary)
5800 @findex gnus-uu-decode-postscript-and-save
5801 Unpack and save the current PostScript series
5802 (@code{gnus-uu-decode-postscript-and-save}).
5803
5804 @item X v p
5805 @kindex X v p (Summary)
5806 @findex gnus-uu-decode-postscript-view
5807 View the current PostScript series
5808 (@code{gnus-uu-decode-postscript-view}).
5809
5810 @item X v P
5811 @kindex X v P (Summary)
5812 @findex gnus-uu-decode-postscript-and-save-view
5813 View and save the current PostScript series
5814 (@code{gnus-uu-decode-postscript-and-save-view}).
5815 @end table
5816
5817
5818 @node Other Files
5819 @subsection Other Files
5820
5821 @table @kbd
5822 @item X o
5823 @kindex X o (Summary)
5824 @findex gnus-uu-decode-save
5825 Save the current series
5826 (@code{gnus-uu-decode-save}).
5827
5828 @item X b
5829 @kindex X b (Summary)
5830 @findex gnus-uu-decode-binhex
5831 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
5832 doesn't really work yet.
5833 @end table
5834
5835
5836 @node Decoding Variables
5837 @subsection Decoding Variables
5838
5839 Adjective, not verb.
5840
5841 @menu
5842 * Rule Variables::          Variables that say how a file is to be viewed.
5843 * Other Decode Variables::  Other decode variables.
5844 * Uuencoding and Posting::  Variables for customizing uuencoding.
5845 @end menu
5846
5847
5848 @node Rule Variables
5849 @subsubsection Rule Variables
5850 @cindex rule variables
5851
5852 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5853 variables are of the form
5854
5855 @lisp
5856       (list '(regexp1 command2)
5857             '(regexp2 command2)
5858             ...)
5859 @end lisp
5860
5861 @table @code
5862
5863 @item gnus-uu-user-view-rules
5864 @vindex gnus-uu-user-view-rules
5865 @cindex sox
5866 This variable is consulted first when viewing files.  If you wish to use,
5867 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5868 say something like:
5869 @lisp
5870 (setq gnus-uu-user-view-rules
5871       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5872 @end lisp
5873
5874 @item gnus-uu-user-view-rules-end
5875 @vindex gnus-uu-user-view-rules-end
5876 This variable is consulted if Gnus couldn't make any matches from the
5877 user and default view rules.
5878
5879 @item gnus-uu-user-archive-rules
5880 @vindex gnus-uu-user-archive-rules
5881 This variable can be used to say what commands should be used to unpack
5882 archives.
5883 @end table
5884
5885
5886 @node Other Decode Variables
5887 @subsubsection Other Decode Variables
5888
5889 @table @code
5890 @vindex gnus-uu-grabbed-file-functions
5891
5892 @item gnus-uu-grabbed-file-functions
5893 All functions in this list will be called right after each file has been
5894 successfully decoded---so that you can move or view files right away,
5895 and don't have to wait for all files to be decoded before you can do
5896 anything.  Ready-made functions you can put in this list are:
5897
5898 @table @code
5899
5900 @item gnus-uu-grab-view
5901 @findex gnus-uu-grab-view
5902 View the file.
5903
5904 @item gnus-uu-grab-move
5905 @findex gnus-uu-grab-move
5906 Move the file (if you're using a saving function.)
5907 @end table
5908
5909 @item gnus-uu-be-dangerous
5910 @vindex gnus-uu-be-dangerous
5911 Specifies what to do if unusual situations arise during decoding.  If
5912 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5913 that didn't work, and overwrite existing files.  Otherwise, ask each
5914 time.
5915
5916 @item gnus-uu-ignore-files-by-name
5917 @vindex gnus-uu-ignore-files-by-name
5918 Files with name matching this regular expression won't be viewed.
5919
5920 @item gnus-uu-ignore-files-by-type
5921 @vindex gnus-uu-ignore-files-by-type
5922 Files with a @sc{mime} type matching this variable won't be viewed.
5923 Note that Gnus tries to guess what type the file is based on the name.
5924 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5925 kludgey.
5926
5927 @item gnus-uu-tmp-dir
5928 @vindex gnus-uu-tmp-dir
5929 Where @code{gnus-uu} does its work.
5930
5931 @item gnus-uu-do-not-unpack-archives
5932 @vindex gnus-uu-do-not-unpack-archives
5933 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5934 looking for files to display.
5935
5936 @item gnus-uu-view-and-save
5937 @vindex gnus-uu-view-and-save
5938 Non-@code{nil} means that the user will always be asked to save a file
5939 after viewing it.
5940
5941 @item gnus-uu-ignore-default-view-rules
5942 @vindex gnus-uu-ignore-default-view-rules
5943 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5944 rules.
5945
5946 @item gnus-uu-ignore-default-archive-rules
5947 @vindex gnus-uu-ignore-default-archive-rules
5948 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5949 unpacking commands.
5950
5951 @item gnus-uu-kill-carriage-return
5952 @vindex gnus-uu-kill-carriage-return
5953 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5954 from articles.
5955
5956 @item gnus-uu-unmark-articles-not-decoded
5957 @vindex gnus-uu-unmark-articles-not-decoded
5958 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5959 decoded articles as unread.
5960
5961 @item gnus-uu-correct-stripped-uucode
5962 @vindex gnus-uu-correct-stripped-uucode
5963 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5964 uuencoded files that have had trailing spaces deleted.
5965
5966 @item gnus-uu-pre-uudecode-hook
5967 @vindex gnus-uu-pre-uudecode-hook
5968 Hook run before sending a message to @code{uudecode}.
5969
5970 @item gnus-uu-view-with-metamail
5971 @vindex gnus-uu-view-with-metamail
5972 @cindex metamail
5973 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5974 commands defined by the rule variables and just fudge a @sc{mime}
5975 content type based on the file name.  The result will be fed to
5976 @code{metamail} for viewing.
5977
5978 @item gnus-uu-save-in-digest
5979 @vindex gnus-uu-save-in-digest
5980 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5981 decoding, will save in digests.  If this variable is @code{nil},
5982 @code{gnus-uu} will just save everything in a file without any
5983 embellishments.  The digesting almost conforms to RFC1153---no easy way
5984 to specify any meaningful volume and issue numbers were found, so I
5985 simply dropped them.
5986
5987 @end table
5988
5989
5990 @node Uuencoding and Posting
5991 @subsubsection Uuencoding and Posting
5992
5993 @table @code
5994
5995 @item gnus-uu-post-include-before-composing
5996 @vindex gnus-uu-post-include-before-composing
5997 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5998 before you compose the article.  If this variable is @code{t}, you can
5999 either include an encoded file with @kbd{C-c C-i} or have one included
6000 for you when you post the article.
6001
6002 @item gnus-uu-post-length
6003 @vindex gnus-uu-post-length
6004 Maximum length of an article.  The encoded file will be split into how
6005 many articles it takes to post the entire file.
6006
6007 @item gnus-uu-post-threaded
6008 @vindex gnus-uu-post-threaded
6009 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6010 thread.  This may not be smart, as no other decoder I have seen is able
6011 to follow threads when collecting uuencoded articles.  (Well, I have
6012 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6013 think that counts...) Default is @code{nil}.
6014
6015 @item gnus-uu-post-separate-description
6016 @vindex gnus-uu-post-separate-description
6017 Non-@code{nil} means that the description will be posted in a separate
6018 article.  The first article will typically be numbered (0/x).  If this
6019 variable is @code{nil}, the description the user enters will be included
6020 at the beginning of the first article, which will be numbered (1/x).
6021 Default is @code{t}.
6022
6023 @end table
6024
6025
6026 @node Viewing Files
6027 @subsection Viewing Files
6028 @cindex viewing files
6029 @cindex pseudo-articles
6030
6031 After decoding, if the file is some sort of archive, Gnus will attempt
6032 to unpack the archive and see if any of the files in the archive can be
6033 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
6034 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6035 uncompress and de-tar the main file, and then view the two pictures.
6036 This unpacking process is recursive, so if the archive contains archives
6037 of archives, it'll all be unpacked.
6038
6039 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6040 extracted file into the summary buffer.  If you go to these
6041 ``articles'', you will be prompted for a command to run (usually Gnus
6042 will make a suggestion), and then the command will be run.
6043
6044 @vindex gnus-view-pseudo-asynchronously
6045 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6046 until the viewing is done before proceeding.
6047
6048 @vindex gnus-view-pseudos
6049 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6050 the pseudo-articles into the summary buffer, but view them
6051 immediately.  If this variable is @code{not-confirm}, the user won't even
6052 be asked for a confirmation before viewing is done.
6053
6054 @vindex gnus-view-pseudos-separately
6055 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6056 pseudo-article will be created for each file to be viewed.  If
6057 @code{nil}, all files that use the same viewing command will be given as
6058 a list of parameters to that command.
6059
6060 @vindex gnus-insert-pseudo-articles
6061 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6062 pseudo-articles when decoding.  It is @code{t} by default.
6063
6064 So; there you are, reading your @emph{pseudo-articles} in your
6065 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6066 Why isn't anything real anymore? How did we get here?
6067
6068
6069 @node Article Treatment
6070 @section Article Treatment
6071
6072 Reading through this huge manual, you may have quite forgotten that the
6073 object of newsreaders is to actually, like, read what people have
6074 written.  Reading articles.  Unfortunately, people are quite bad at
6075 writing, so there are tons of functions and variables to make reading
6076 these articles easier.
6077
6078 @menu
6079 * Article Highlighting::    You want to make the article look like fruit salad.
6080 * Article Fontisizing::     Making emphasized text look nice.
6081 * Article Hiding::          You also want to make certain info go away.
6082 * Article Washing::         Lots of way-neat functions to make life better.
6083 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6084 * Article Date::            Grumble, UT!
6085 * Article Signature::       What is a signature?
6086 @end menu
6087
6088
6089 @node Article Highlighting
6090 @subsection Article Highlighting
6091 @cindex highlighting
6092
6093 Not only do you want your article buffer to look like fruit salad, but
6094 you want it to look like technicolor fruit salad.  
6095
6096 @table @kbd
6097
6098 @item W H a
6099 @kindex W H a (Summary)
6100 @findex gnus-article-highlight
6101 @findex gnus-article-maybe-highlight
6102 Do much highlighting of the current article
6103 (@code{gnus-article-highlight}).  This function highlights header, cited
6104 text, the signature, and adds buttons to the body and the head.
6105
6106 Most users would prefer using @code{gnus-article-maybe-highlight} in
6107 @code{gnus-article-display-hook} (@pxref{Customizing Articles}) instead.
6108 This is a bit less agressive---it highlights only the headers, the
6109 signature and adds buttons.
6110
6111 @item W H h
6112 @kindex W H h (Summary)
6113 @findex gnus-article-highlight-headers
6114 @vindex gnus-header-face-alist
6115 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6116 highlighting will be done according to the @code{gnus-header-face-alist}
6117 variable, which is a list where each element has the form @var{(regexp
6118 name content)}.  @var{regexp} is a regular expression for matching the
6119 header, @var{name} is the face used for highlighting the header name
6120 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6121 the header value.  The first match made will be used.  Note that
6122 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6123
6124 @item W H c
6125 @kindex W H c (Summary)
6126 @findex gnus-article-highlight-citation
6127 Highlight cited text (@code{gnus-article-highlight-citation}).
6128
6129 Some variables to customize the citation highlights:
6130
6131 @table @code
6132 @vindex gnus-cite-parse-max-size
6133
6134 @item gnus-cite-parse-max-size
6135 If the article size if bigger than this variable (which is 25000 by
6136 default), no citation highlighting will be performed.
6137
6138 @item gnus-cite-prefix-regexp
6139 @vindex gnus-cite-prefix-regexp
6140 Regexp matching the longest possible citation prefix on a line.
6141
6142 @item gnus-cite-max-prefix
6143 @vindex gnus-cite-max-prefix
6144 Maximum possible length for a citation prefix (default 20).
6145
6146 @item gnus-cite-face-list
6147 @vindex gnus-cite-face-list
6148 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6149 When there are citations from multiple articles in the same message,
6150 Gnus will try to give each citation from each article its own face.
6151 This should make it easier to see who wrote what.
6152
6153 @item gnus-supercite-regexp
6154 @vindex gnus-supercite-regexp
6155 Regexp matching normal Supercite attribution lines.
6156
6157 @item gnus-supercite-secondary-regexp
6158 @vindex gnus-supercite-secondary-regexp
6159 Regexp matching mangled Supercite attribution lines.
6160
6161 @item gnus-cite-minimum-match-count
6162 @vindex gnus-cite-minimum-match-count
6163 Minimum number of identical prefixes we have to see before we believe
6164 that it's a citation.
6165
6166 @item gnus-cite-attribution-prefix
6167 @vindex gnus-cite-attribution-prefix
6168 Regexp matching the beginning of an attribution line.
6169
6170 @item gnus-cite-attribution-suffix
6171 @vindex gnus-cite-attribution-suffix
6172 Regexp matching the end of an attribution line.
6173
6174 @item gnus-cite-attribution-face
6175 @vindex gnus-cite-attribution-face
6176 Face used for attribution lines.  It is merged with the face for the
6177 cited text belonging to the attribution.
6178
6179 @end table
6180
6181
6182 @item W H s
6183 @kindex W H s (Summary)
6184 @vindex gnus-signature-separator
6185 @vindex gnus-signature-face
6186 @findex gnus-article-highlight-signature
6187 Highlight the signature (@code{gnus-article-highlight-signature}).
6188 Everything after @code{gnus-signature-separator} (@pxref{Article
6189 Signature}) in an article will be considered a signature and will be
6190 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6191 default.
6192
6193 @end table
6194
6195 @xref{Customizing Articles} for how to highlight articles automatically.
6196
6197
6198 @node Article Fontisizing
6199 @subsection Article Fontisizing
6200 @cindex emphasis
6201 @cindex article emphasis
6202
6203 @findex gnus-article-emphasize
6204 @kindex W e (Summary)
6205 People commonly add emphasis to words in news articles by writing things
6206 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
6207 running the article through the @kbd{W e}
6208 (@code{gnus-article-emphasize}) command.
6209
6210 @vindex gnus-emphasis-alist
6211 How the emphasis is computed is controlled by the
6212 @code{gnus-emphasis-alist} variable.  This is an alist where the first
6213 element is a regular expression to be matched.  The second is a number
6214 that says what regular expression grouping is used to find the entire
6215 emphasized word.  The third is a number that says what regexp grouping
6216 should be displayed and highlighted.  (The text between these two
6217 groupings will be hidden.)  The fourth is the face used for
6218 highlighting.
6219
6220 @lisp
6221 (setq gnus-article-emphasis
6222       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6223         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6224 @end lisp
6225
6226 @vindex gnus-emphasis-underline
6227 @vindex gnus-emphasis-bold
6228 @vindex gnus-emphasis-italic
6229 @vindex gnus-emphasis-underline-bold
6230 @vindex gnus-emphasis-underline-italic
6231 @vindex gnus-emphasis-bold-italic
6232 @vindex gnus-emphasis-underline-bold-italic
6233 By default, there are seven rules, and they use the following faces:
6234 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6235 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6236 @code{gnus-emphasis-underline-italic},
6237 @code{gnus-emphasis-underline-bold}, and
6238 @code{gnus-emphasis-underline-bold-italic}.
6239
6240 If you want to change these faces, you can either use @kbd{M-x
6241 customize}, or you can use @code{copy-face}.  For instance, if you want
6242 to make @code{gnus-emphasis-italic} use a red face instead, you could
6243 say something like:
6244
6245 @lisp
6246 (copy-face 'red 'gnus-emphasis-italic)
6247 @end lisp
6248
6249 @xref{Customizing Articles} for how to fontize articles automatically.
6250
6251
6252 @node Article Hiding
6253 @subsection Article Hiding
6254 @cindex article hiding
6255
6256 Or rather, hiding certain things in each article.  There usually is much
6257 too much cruft in most articles.
6258
6259 @table @kbd
6260
6261 @item W W a
6262 @kindex W W a (Summary)
6263 @findex gnus-article-hide
6264 Do quite a lot of hiding on the article buffer
6265 (@kbd{gnus-article-hide}).  In particular, this function will hide
6266 headers, PGP, cited text and the signature.  
6267
6268 @item W W h
6269 @kindex W W h (Summary)
6270 @findex gnus-article-hide-headers
6271 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
6272 Headers}.
6273
6274 @item W W b
6275 @kindex W W b (Summary)
6276 @findex gnus-article-hide-boring-headers
6277 Hide headers that aren't particularly interesting
6278 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6279
6280 @item W W s
6281 @kindex W W s (Summary)
6282 @findex gnus-article-hide-signature
6283 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6284 Signature}.
6285
6286 @item W W p
6287 @kindex W W p (Summary)
6288 @findex gnus-article-hide-pgp
6289 @vindex gnus-article-hide-pgp-hook
6290 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6291 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6292 signature has been hidden.
6293
6294 @item W W P
6295 @kindex W W P (Summary)
6296 @findex gnus-article-hide-pem
6297 Hide @sc{pem} (privacy enhanced messages) cruft
6298 (@code{gnus-article-hide-pem}).
6299
6300 @item W W c
6301 @kindex W W c (Summary)
6302 @findex gnus-article-hide-citation
6303 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6304 customizing the hiding:
6305
6306 @table @code
6307
6308 @item gnus-cited-opened-text-button-line-format
6309 @itemx gnus-cited-closed-text-button-line-format
6310 @vindex gnus-cited-closed-text-button-line-format
6311 @vindex gnus-cited-opened-text-button-line-format
6312 Gnus adds buttons to show where the cited text has been hidden, and to
6313 allow toggle hiding the text.  The format of the variable is specified
6314 by these format-like variable (@pxref{Formatting Variables}).  These
6315 specs are valid:
6316
6317 @table @samp
6318 @item b
6319 Starting point of the hidden text.
6320 @item e
6321 Ending point of the hidden text.
6322 @item l
6323 Number of characters in the hidden region.
6324 @item n
6325 Number of lines of hidden text.
6326 @end table
6327
6328 @item gnus-cited-lines-visible
6329 @vindex gnus-cited-lines-visible
6330 The number of lines at the beginning of the cited text to leave shown.
6331
6332 @end table
6333
6334 @item W W C-c
6335 @kindex W W C-c (Summary)
6336 @findex gnus-article-hide-citation-maybe
6337
6338 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6339 following two variables:
6340
6341 @table @code
6342 @item gnus-cite-hide-percentage
6343 @vindex gnus-cite-hide-percentage
6344 If the cited text is of a bigger percentage than this variable (default
6345 50), hide the cited text.
6346
6347 @item gnus-cite-hide-absolute
6348 @vindex gnus-cite-hide-absolute
6349 The cited text must have at least this length (default 10) before it
6350 is hidden.
6351 @end table
6352
6353 @item W W C
6354 @kindex W W C (Summary)
6355 @findex gnus-article-hide-citation-in-followups
6356 Hide cited text in articles that aren't roots
6357 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6358 useful as an interactive command, but might be a handy function to stick
6359 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
6360
6361 @end table
6362
6363 All these ``hiding'' commands are toggles, but if you give a negative
6364 prefix to these commands, they will show what they have previously
6365 hidden.  If you give a positive prefix, they will always hide.
6366
6367 Also @pxref{Article Highlighting} for further variables for
6368 citation customization.
6369
6370 @xref{Customizing Articles} for how to hide article elements
6371 automatically.
6372
6373
6374 @node Article Washing
6375 @subsection Article Washing
6376 @cindex washing
6377 @cindex article washing
6378
6379 We call this ``article washing'' for a really good reason.  Namely, the
6380 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6381
6382 @dfn{Washing} is defined by us as ``changing something from something to
6383 something else'', but normally results in something looking better.
6384 Cleaner, perhaps.
6385
6386 @table @kbd
6387
6388 @item W l
6389 @kindex W l (Summary)
6390 @findex gnus-summary-stop-page-breaking
6391 Remove page breaks from the current article
6392 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article} for page
6393 delimiters. 
6394
6395 @item W r
6396 @kindex W r (Summary)
6397 @findex gnus-summary-caesar-message
6398 @c @icon{gnus-summary-caesar-message}
6399 Do a Caesar rotate (rot13) on the article buffer
6400 (@code{gnus-summary-caesar-message}).
6401 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6402 (Typically offensive jokes and such.)
6403
6404 It's commonly called ``rot13'' because each letter is rotated 13
6405 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6406 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6407 is rumored to have employed this form of, uh, somewhat weak encryption.
6408
6409 @item W t
6410 @kindex W t (Summary)
6411 @findex gnus-summary-toggle-header
6412 Toggle whether to display all headers in the article buffer
6413 (@code{gnus-summary-toggle-header}).
6414
6415 @item W v
6416 @kindex W v (Summary)
6417 @findex gnus-summary-verbose-header
6418 Toggle whether to display all headers in the article buffer permanently
6419 (@code{gnus-summary-verbose-header}).
6420
6421 @item W m
6422 @kindex W m (Summary)
6423 @findex gnus-summary-toggle-mime
6424 Toggle whether to run the article through @sc{mime} before displaying
6425 (@code{gnus-summary-toggle-mime}).
6426
6427 @item W o
6428 @kindex W o (Summary)
6429 @findex gnus-article-treat-overstrike
6430 Treat overstrike (@code{gnus-article-treat-overstrike}).
6431
6432 @item W d
6433 @kindex W d (Summary)
6434 @findex gnus-article-treat-dumbquotes
6435 Treat M******** sm*rtq**t*s (@code{gnus-article-treat-dumbquotes}).
6436
6437 @item W w
6438 @kindex W w (Summary)
6439 @findex gnus-article-fill-cited-article
6440 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
6441 function in @code{gnus-article-display-hook}, it should be run fairly
6442 late and certainly after any highlighting.
6443
6444 You can give the command a numerical prefix to specify the width to use
6445 when filling.
6446
6447 @item W c
6448 @kindex W c (Summary)
6449 @findex gnus-article-remove-cr
6450 Remove CR (i. e., @samp{^M}s on the end of the lines)
6451 (@code{gnus-article-remove-cr}).
6452
6453 @item W q
6454 @kindex W q (Summary)
6455 @findex gnus-article-de-quoted-unreadable
6456 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6457 Quoted-Printable is one common @sc{mime} encoding employed when sending
6458 non-ASCII (i. e., 8-bit) articles.  It typically makes strings like
6459 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6460 readable to me.
6461
6462 @item W f
6463 @kindex W f (Summary)
6464 @cindex x-face
6465 @findex gnus-article-display-x-face
6466 @findex gnus-article-x-face-command
6467 @vindex gnus-article-x-face-command
6468 @vindex gnus-article-x-face-too-ugly
6469 @iftex
6470 @iflatex
6471 \include{xface}
6472 @end iflatex
6473 @end iftex
6474 Look for and display any X-Face headers
6475 (@code{gnus-article-display-x-face}).  The command executed by this
6476 function is given by the @code{gnus-article-x-face-command} variable.
6477 If this variable is a string, this string will be executed in a
6478 sub-shell.  If it is a function, this function will be called with the
6479 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6480 is a regexp) matches the @code{From} header, the face will not be shown.
6481 The default action under Emacs is to fork off an @code{xv} to view the
6482 face; under XEmacs the default action is to display the face before the
6483 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6484 support---that will make display somewhat faster.  If there's no native
6485 X-Face support, Gnus will try to convert the @code{X-Face} header using
6486 external programs from the @code{pbmplus} package and friends.)  If you
6487 want to have this function in the display hook, it should probably come
6488 last.
6489
6490 @item W b
6491 @kindex W b (Summary)
6492 @findex gnus-article-add-buttons
6493 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6494 @xref{Article Buttons}
6495
6496 @item W B
6497 @kindex W B (Summary)
6498 @findex gnus-article-add-buttons-to-head
6499 Add clickable buttons to the article headers
6500 (@code{gnus-article-add-buttons-to-head}).
6501
6502 @item W E l
6503 @kindex W E l (Summary)
6504 @findex gnus-article-strip-leading-blank-lines
6505 Remove all blank lines from the beginning of the article
6506 (@code{gnus-article-strip-leading-blank-lines}).
6507
6508 @item W E m
6509 @kindex W E m (Summary)
6510 @findex gnus-article-strip-multiple-blank-lines
6511 Replace all blank lines with empty lines and then all multiple empty
6512 lines with a single empty line.
6513 (@code{gnus-article-strip-multiple-blank-lines}).
6514
6515 @item W E t
6516 @kindex W E t (Summary)
6517 @findex gnus-article-remove-trailing-blank-lines
6518 Remove all blank lines at the end of the article
6519 (@code{gnus-article-remove-trailing-blank-lines}).
6520
6521 @item W E a
6522 @kindex W E a (Summary)
6523 @findex gnus-article-strip-blank-lines
6524 Do all the three commands above
6525 (@code{gnus-article-strip-blank-lines}).
6526
6527 @item W E A
6528 @kindex W E A (Summary)
6529 @findex gnus-article-strip-all-blank-lines
6530 Remove all blank lines
6531 (@code{gnus-article-strip-all-blank-lines}).
6532
6533 @item W E s
6534 @kindex W E s (Summary)
6535 @findex gnus-article-strip-leading-space
6536 Remove all white space from the beginning of all lines of the article
6537 body (@code{gnus-article-strip-leading-space}).
6538
6539 @end table
6540
6541 @xref{Customizing Articles} for how to wash articles automatically.
6542
6543
6544 @node Article Buttons
6545 @subsection Article Buttons
6546 @cindex buttons
6547
6548 People often include references to other stuff in articles, and it would
6549 be nice if Gnus could just fetch whatever it is that people talk about
6550 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6551 button on these references.
6552
6553 Gnus adds @dfn{buttons} to certain standard references by default:
6554 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6555 two variables, one that handles article bodies and one that handles
6556 article heads:
6557
6558 @table @code
6559
6560 @item gnus-button-alist
6561 @vindex gnus-button-alist
6562 This is an alist where each entry has this form:
6563
6564 @lisp
6565 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6566 @end lisp
6567
6568 @table @var
6569
6570 @item regexp
6571 All text that match this regular expression will be considered an
6572 external reference.  Here's a typical regexp that matches embedded URLs:
6573 @samp{<URL:\\([^\n\r>]*\\)>}.
6574
6575 @item button-par
6576 Gnus has to know which parts of the matches is to be highlighted.  This
6577 is a number that says what sub-expression of the regexp is to be
6578 highlighted.  If you want it all highlighted, you use 0 here.
6579
6580 @item use-p
6581 This form will be @code{eval}ed, and if the result is non-@code{nil},
6582 this is considered a match.  This is useful if you want extra sifting to
6583 avoid false matches.
6584
6585 @item function
6586 This function will be called when you click on this button.
6587
6588 @item data-par
6589 As with @var{button-par}, this is a sub-expression number, but this one
6590 says which part of the match is to be sent as data to @var{function}.
6591
6592 @end table
6593
6594 So the full entry for buttonizing URLs is then
6595
6596 @lisp
6597 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6598 @end lisp
6599
6600 @item gnus-header-button-alist
6601 @vindex gnus-header-button-alist
6602 This is just like the other alist, except that it is applied to the
6603 article head only, and that each entry has an additional element that is
6604 used to say what headers to apply the buttonize coding to:
6605
6606 @lisp
6607 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6608 @end lisp
6609
6610 @var{HEADER} is a regular expression.
6611
6612 @item gnus-button-url-regexp
6613 @vindex gnus-button-url-regexp
6614 A regular expression that matches embedded URLs.  It is used in the
6615 default values of the variables above.
6616
6617 @item gnus-article-button-face
6618 @vindex gnus-article-button-face
6619 Face used on buttons.
6620
6621 @item gnus-article-mouse-face
6622 @vindex gnus-article-mouse-face
6623 Face used when the mouse cursor is over a button.
6624
6625 @end table
6626
6627 @xref{Customizing Articles} for how to buttonize articles automatically.
6628
6629
6630 @node Article Date
6631 @subsection Article Date
6632
6633 The date is most likely generated in some obscure timezone you've never
6634 heard of, so it's quite nice to be able to find out what the time was
6635 when the article was sent.
6636
6637 @table @kbd
6638
6639 @item W T u
6640 @kindex W T u (Summary)
6641 @findex gnus-article-date-ut
6642 Display the date in UT (aka. GMT, aka ZULU)
6643 (@code{gnus-article-date-ut}).
6644
6645 @item W T i
6646 @kindex W T i (Summary)
6647 @findex gnus-article-date-iso8601
6648 @cindex ISO 8601
6649 Display the date in international format, aka. ISO 8601
6650 (@code{gnus-article-date-iso8601}).
6651
6652 @item W T l
6653 @kindex W T l (Summary)
6654 @findex gnus-article-date-local
6655 Display the date in the local timezone (@code{gnus-article-date-local}).
6656
6657 @item W T s
6658 @kindex W T s (Summary)
6659 @vindex gnus-article-time-format
6660 @findex gnus-article-date-user
6661 @findex format-time-string
6662 Display the date using a user-defined format
6663 (@code{gnus-article-date-user}).  The format is specified by the
6664 @code{gnus-article-time-format} variable, and is a string that's passed
6665 to @code{format-time-string}.  See the documentation of that variable
6666 for a list of possible format specs.
6667
6668 @item W T e
6669 @kindex W T e (Summary)
6670 @findex gnus-article-date-lapsed
6671 @findex gnus-start-date-timer
6672 @findex gnus-stop-date-timer
6673 Say how much time has elapsed between the article was posted and now
6674 (@code{gnus-article-date-lapsed}).  If you want to have this line
6675 updated continually, you can put
6676
6677 @lisp
6678 (gnus-start-date-timer)
6679 @end lisp
6680
6681 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6682 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6683 command.
6684
6685 @item W T o
6686 @kindex W T o (Summary)
6687 @findex gnus-article-date-original
6688 Display the original date (@code{gnus-article-date-original}).  This can
6689 be useful if you normally use some other conversion function and are
6690 worried that it might be doing something totally wrong.  Say, claiming
6691 that the article was posted in 1854.  Although something like that is
6692 @emph{totally} impossible.  Don't you trust me? *titter*
6693
6694 @end table
6695
6696 @xref{Customizing Articles} for how to display the date in your
6697 preferred format automatically.
6698
6699
6700 @node Article Signature
6701 @subsection Article Signature
6702 @cindex signatures
6703 @cindex article signature
6704
6705 @vindex gnus-signature-separator
6706 Each article is divided into two parts---the head and the body.  The
6707 body can be divided into a signature part and a text part.  The variable
6708 that says what is to be considered a signature is
6709 @code{gnus-signature-separator}.  This is normally the standard
6710 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6711 non-standard signature separators, so this variable can also be a list
6712 of regular expressions to be tested, one by one.  (Searches are done
6713 from the end of the body towards the beginning.)  One likely value is:
6714
6715 @lisp
6716 (setq gnus-signature-separator
6717       '("^-- $"         ; The standard
6718         "^-- *$"        ; A common mangling
6719         "^-------*$"    ; Many people just use a looong
6720                         ; line of dashes.  Shame!
6721         "^ *--------*$" ; Double-shame!
6722         "^________*$"   ; Underscores are also popular
6723         "^========*$")) ; Pervert!
6724 @end lisp
6725
6726 The more permissive you are, the more likely it is that you'll get false
6727 positives.
6728
6729 @vindex gnus-signature-limit
6730 @code{gnus-signature-limit} provides a limit to what is considered a
6731 signature.
6732
6733 @enumerate
6734 @item
6735 If it is an integer, no signature may be longer (in characters) than
6736 that integer.
6737 @item
6738 If it is a floating point number, no signature may be longer (in lines)
6739 than that number.
6740 @item
6741 If it is a function, the function will be called without any parameters,
6742 and if it returns @code{nil}, there is no signature in the buffer.
6743 @item
6744 If it is a string, it will be used as a regexp.  If it matches, the text
6745 in question is not a signature.
6746 @end enumerate
6747
6748 This variable can also be a list where the elements may be of the types
6749 listed above.  Here's an example:
6750
6751 @lisp
6752 (setq gnus-signature-limit
6753       '(200.0 "^---*Forwarded article"))
6754 @end lisp
6755
6756 This means that if there are more than 200 lines after the signature
6757 separator, or the text after the signature separator is matched by
6758 the regular expression @samp{^---*Forwarded article}, then it isn't a
6759 signature after all.
6760
6761
6762 @node Article Commands
6763 @section Article Commands
6764
6765 @table @kbd
6766
6767 @item A P
6768 @cindex PostScript
6769 @cindex printing
6770 @kindex A P (Summary)
6771 @vindex gnus-ps-print-hook
6772 @findex gnus-summary-print-article
6773 Generate and print a PostScript image of the article buffer
6774 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6775 run just before printing the buffer.
6776
6777 @end table
6778
6779
6780 @node Summary Sorting
6781 @section Summary Sorting
6782 @cindex summary sorting
6783
6784 You can have the summary buffer sorted in various ways, even though I
6785 can't really see why you'd want that.
6786
6787 @table @kbd
6788
6789 @item C-c C-s C-n
6790 @kindex C-c C-s C-n (Summary)
6791 @findex gnus-summary-sort-by-number
6792 Sort by article number (@code{gnus-summary-sort-by-number}).
6793
6794 @item C-c C-s C-a
6795 @kindex C-c C-s C-a (Summary)
6796 @findex gnus-summary-sort-by-author
6797 Sort by author (@code{gnus-summary-sort-by-author}).
6798
6799 @item C-c C-s C-s
6800 @kindex C-c C-s C-s (Summary)
6801 @findex gnus-summary-sort-by-subject
6802 Sort by subject (@code{gnus-summary-sort-by-subject}).
6803
6804 @item C-c C-s C-d
6805 @kindex C-c C-s C-d (Summary)
6806 @findex gnus-summary-sort-by-date
6807 Sort by date (@code{gnus-summary-sort-by-date}).
6808
6809 @item C-c C-s C-l
6810 @kindex C-c C-s C-l (Summary)
6811 @findex gnus-summary-sort-by-lines
6812 Sort by lines (@code{gnus-summary-sort-by-lines}).
6813
6814 @item C-c C-s C-i
6815 @kindex C-c C-s C-i (Summary)
6816 @findex gnus-summary-sort-by-score
6817 Sort by score (@code{gnus-summary-sort-by-score}).
6818 @end table
6819
6820 These functions will work both when you use threading and when you don't
6821 use threading.  In the latter case, all summary lines will be sorted,
6822 line by line.  In the former case, sorting will be done on a
6823 root-by-root basis, which might not be what you were looking for.  To
6824 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6825 Commands}).
6826
6827
6828 @node Finding the Parent
6829 @section Finding the Parent
6830 @cindex parent articles
6831 @cindex referring articles
6832
6833 @table @kbd
6834 @item ^
6835 @kindex ^ (Summary)
6836 @findex gnus-summary-refer-parent-article
6837 If you'd like to read the parent of the current article, and it is not
6838 displayed in the summary buffer, you might still be able to.  That is,
6839 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6840 and the @code{References} in the current article are not mangled, you
6841 can just press @kbd{^} or @kbd{A r}
6842 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6843 you'll get the parent.  If the parent is already displayed in the
6844 summary buffer, point will just move to this article.
6845
6846 If given a positive numerical prefix, fetch that many articles back into
6847 the ancestry.  If given a negative numerical prefix, fetch just that
6848 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6849 grandparent and the grandgrandparent of the current article.  If you say
6850 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6851 article.
6852
6853 @item A R (Summary)
6854 @findex gnus-summary-refer-references
6855 @kindex A R (Summary)
6856 Fetch all articles mentioned in the @code{References} header of the
6857 article (@code{gnus-summary-refer-references}).
6858
6859 @item A T (Summary)
6860 @findex gnus-summary-refer-thread
6861 @kindex A T (Summary)
6862 Display the full thread where the current article appears
6863 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
6864 headers in the current group to work, so it usually takes a while.  If
6865 you do it often, you may consider setting @code{gnus-fetch-old-headers}
6866 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
6867 visible effects normally, but it'll make this command work a whole lot
6868 faster.  Of course, it'll make group entry somewhat slow.
6869
6870 @vindex gnus-refer-thread-limit
6871 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
6872 articles before the first displayed in the current group) headers to
6873 fetch when doing this command.  The default is 200.  If @code{t}, all
6874 the available headers will be fetched.  This variable can be overridden
6875 by giving the @kbd{A T} command a numerical prefix.
6876
6877 @item M-^ (Summary)
6878 @findex gnus-summary-refer-article
6879 @kindex M-^ (Summary)
6880 @cindex Message-ID
6881 @cindex fetching by Message-ID
6882 You can also ask the @sc{nntp} server for an arbitrary article, no
6883 matter what group it belongs to.  @kbd{M-^}
6884 (@code{gnus-summary-refer-article}) will ask you for a
6885 @code{Message-ID}, which is one of those long, hard-to-read thingies
6886 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6887 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6888 @end table
6889
6890 The current select method will be used when fetching by
6891 @code{Message-ID} from non-news select method, but you can override this
6892 by giving this command a prefix.
6893
6894 @vindex gnus-refer-article-method
6895 If the group you are reading is located on a backend that does not
6896 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6897 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6898 would, perhaps, be best if the @sc{nntp} server you consult is the one
6899 updating the spool you are reading from, but that's not really
6900 necessary.
6901
6902 Most of the mail backends support fetching by @code{Message-ID}, but do
6903 not do a particularly excellent job at it.  That is, @code{nnmbox} and
6904 @code{nnbabyl} are able to locate articles from any groups, while
6905 @code{nnml} and @code{nnfolder} are only able to locate articles that
6906 have been posted to the current group.  (Anything else would be too time
6907 consuming.)  @code{nnmh} does not support this at all.
6908
6909
6910 @node Alternative Approaches
6911 @section Alternative Approaches
6912
6913 Different people like to read news using different methods.  This being
6914 Gnus, we offer a small selection of minor modes for the summary buffers.
6915
6916 @menu
6917 * Pick and Read::               First mark articles and then read them.
6918 * Binary Groups::               Auto-decode all articles.
6919 @end menu
6920
6921
6922 @node Pick and Read
6923 @subsection Pick and Read
6924 @cindex pick and read
6925
6926 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6927 a two-phased reading interface.  The user first marks in a summary
6928 buffer the articles she wants to read.  Then she starts reading the
6929 articles with just an article buffer displayed.
6930
6931 @findex gnus-pick-mode
6932 @kindex M-x gnus-pick-mode
6933 Gnus provides a summary buffer minor mode that allows
6934 this---@code{gnus-pick-mode}.  This basically means that a few process
6935 mark commands become one-keystroke commands to allow easy marking, and
6936 it provides one additional command for switching to the summary buffer.
6937
6938 Here are the available keystrokes when using pick mode:
6939
6940 @table @kbd
6941 @item .
6942 @kindex . (Pick)
6943 @findex gnus-pick-article-or-thread
6944 Pick the article or thread on the current line
6945 (@code{gnus-pick-article-or-thread}).  If the variable
6946 @code{gnus-thread-hide-subtree} is true, then this key selects the
6947 entire thread when used at the first article of the thread.  Otherwise,
6948 it selects just the article. If given a numerical prefix, go to that
6949 thread or article and pick it.  (The line number is normally displayed
6950 at the beginning of the summary pick lines.)
6951
6952 @item SPACE
6953 @kindex SPACE (Pick)
6954 @findex gnus-pick-next-page
6955 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6956 at the end of the buffer, start reading the picked articles.
6957
6958 @item u
6959 @kindex u (Pick)
6960 @findex gnus-pick-unmark-article-or-thread.
6961 Unpick the thread or article
6962 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
6963 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
6964 thread if used at the first article of the thread.  Otherwise it unpicks 
6965 just the article.  You can give this key a numerical prefix to unpick
6966 the thread or article at that line.
6967
6968 @item RET
6969 @kindex RET (Pick)
6970 @findex gnus-pick-start-reading
6971 @vindex gnus-pick-display-summary
6972 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6973 given a prefix, mark all unpicked articles as read first.  If
6974 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6975 will still be visible when you are reading.
6976
6977 @end table
6978
6979 All the normal summary mode commands are still available in the
6980 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
6981 which is mapped to the same function
6982 @code{gnus-summary-tick-article-forward}.
6983
6984 If this sounds like a good idea to you, you could say:
6985
6986 @lisp
6987 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6988 @end lisp
6989
6990 @vindex gnus-pick-mode-hook
6991 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6992
6993 @vindex gnus-mark-unpicked-articles-as-read
6994 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6995 all unpicked articles as read.  The default is @code{nil}.
6996
6997 @vindex gnus-summary-pick-line-format
6998 The summary line format in pick mode is slightly different from the
6999 standard format.  At the beginning of each line the line number is
7000 displayed.  The pick mode line format is controlled by the
7001 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7002 Variables}).  It accepts the same format specs that
7003 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7004
7005
7006 @node Binary Groups
7007 @subsection Binary Groups
7008 @cindex binary groups
7009
7010 @findex gnus-binary-mode
7011 @kindex M-x gnus-binary-mode
7012 If you spend much time in binary groups, you may grow tired of hitting
7013 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
7014 is a minor mode for summary buffers that makes all ordinary Gnus article
7015 selection functions uudecode series of articles and display the result
7016 instead of just displaying the articles the normal way.
7017
7018 @kindex g (Binary)
7019 @findex gnus-binary-show-article
7020 The only way, in fact, to see the actual articles is the @kbd{g}
7021 command, when you have turned on this mode
7022 (@code{gnus-binary-show-article}).
7023
7024 @vindex gnus-binary-mode-hook
7025 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7026
7027
7028 @node Tree Display
7029 @section Tree Display
7030 @cindex trees
7031
7032 @vindex gnus-use-trees
7033 If you don't like the normal Gnus summary display, you might try setting
7034 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
7035 additional @dfn{tree buffer}.  You can execute all summary mode commands
7036 in the tree buffer.
7037
7038 There are a few variables to customize the tree display, of course:
7039
7040 @table @code
7041 @item gnus-tree-mode-hook
7042 @vindex gnus-tree-mode-hook
7043 A hook called in all tree mode buffers.
7044
7045 @item gnus-tree-mode-line-format
7046 @vindex gnus-tree-mode-line-format
7047 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7048 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
7049 of valid specs, @pxref{Summary Buffer Mode Line}.
7050
7051 @item gnus-selected-tree-face
7052 @vindex gnus-selected-tree-face
7053 Face used for highlighting the selected article in the tree buffer.  The
7054 default is @code{modeline}.
7055
7056 @item gnus-tree-line-format
7057 @vindex gnus-tree-line-format
7058 A format string for the tree nodes.  The name is a bit of a misnomer,
7059 though---it doesn't define a line, but just the node.  The default value
7060 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7061 the name of the poster.  It is vital that all nodes are of the same
7062 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7063
7064 Valid specs are:
7065
7066 @table @samp
7067 @item n
7068 The name of the poster.
7069 @item f
7070 The @code{From} header.
7071 @item N
7072 The number of the article.
7073 @item [
7074 The opening bracket.
7075 @item ]
7076 The closing bracket.
7077 @item s
7078 The subject.
7079 @end table
7080
7081 @xref{Formatting Variables}.
7082
7083 Variables related to the display are:
7084
7085 @table @code
7086 @item gnus-tree-brackets
7087 @vindex gnus-tree-brackets
7088 This is used for differentiating between ``real'' articles and
7089 ``sparse'' articles.  The format is @var{((real-open . real-close)
7090 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7091 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7092
7093 @item gnus-tree-parent-child-edges
7094 @vindex gnus-tree-parent-child-edges
7095 This is a list that contains the characters used for connecting parent
7096 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
7097
7098 @end table
7099
7100 @item gnus-tree-minimize-window
7101 @vindex gnus-tree-minimize-window
7102 If this variable is non-@code{nil}, Gnus will try to keep the tree
7103 buffer as small as possible to allow more room for the other Gnus
7104 windows.  If this variable is a number, the tree buffer will never be
7105 higher than that number.  The default is @code{t}.  Note that if you
7106 have several windows displayed side-by-side in a frame and the tree
7107 buffer is one of these, minimizing the tree window will also resize all
7108 other windows displayed next to it.
7109
7110 @item gnus-generate-tree-function
7111 @vindex gnus-generate-tree-function
7112 @findex gnus-generate-horizontal-tree
7113 @findex gnus-generate-vertical-tree
7114 The function that actually generates the thread tree.  Two predefined
7115 functions are available: @code{gnus-generate-horizontal-tree} and
7116 @code{gnus-generate-vertical-tree} (which is the default).
7117
7118 @end table
7119
7120 Here's an example from a horizontal tree buffer:
7121
7122 @example
7123 @{***@}-(***)-[odd]-[Gun]
7124      |      \[Jan]
7125      |      \[odd]-[Eri]
7126      |      \(***)-[Eri]
7127      |            \[odd]-[Paa]
7128      \[Bjo]
7129      \[Gun]
7130      \[Gun]-[Jor]
7131 @end example
7132
7133 Here's the same thread displayed in a vertical tree buffer:
7134
7135 @example
7136 @{***@}
7137   |--------------------------\-----\-----\
7138 (***)                         [Bjo] [Gun] [Gun]
7139   |--\-----\-----\                          |
7140 [odd] [Jan] [odd] (***)                   [Jor]
7141   |           |     |--\
7142 [Gun]       [Eri] [Eri] [odd]
7143                           |
7144                         [Paa]
7145 @end example
7146
7147 If you're using horizontal trees, it might be nice to display the trees
7148 side-by-side with the summary buffer.  You could add something like the
7149 following to your @file{.gnus.el} file:
7150
7151 @lisp
7152 (setq gnus-use-trees t
7153       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7154       gnus-tree-minimize-window nil)
7155 (gnus-add-configuration
7156  '(article
7157    (vertical 1.0
7158              (horizontal 0.25
7159                          (summary 0.75 point)
7160                          (tree 1.0))
7161              (article 1.0))))
7162 @end lisp
7163
7164 @xref{Windows Configuration}.
7165
7166
7167 @node Mail Group Commands
7168 @section Mail Group Commands
7169 @cindex mail group commands
7170
7171 Some commands only make sense in mail groups.  If these commands are
7172 invalid in the current group, they will raise a hell and let you know.
7173
7174 All these commands (except the expiry and edit commands) use the
7175 process/prefix convention (@pxref{Process/Prefix}).
7176
7177 @table @kbd
7178
7179 @item B e
7180 @kindex B e (Summary)
7181 @findex gnus-summary-expire-articles
7182 Expire all expirable articles in the group
7183 (@code{gnus-summary-expire-articles}).
7184
7185 @item B M-C-e
7186 @kindex B M-C-e (Summary)
7187 @findex gnus-summary-expire-articles-now
7188 Delete all the expirable articles in the group
7189 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7190 articles eligible for expiry in the current group will
7191 disappear forever into that big @file{/dev/null} in the sky.
7192
7193 @item B DEL
7194 @kindex B DEL (Summary)
7195 @findex gnus-summary-delete-article
7196 @c @icon{gnus-summary-mail-delete}
7197 Delete the mail article.  This is ``delete'' as in ``delete it from your
7198 disk forever and ever, never to return again.'' Use with caution.
7199 (@code{gnus-summary-delete-article}).
7200
7201 @item B m
7202 @kindex B m (Summary)
7203 @cindex move mail
7204 @findex gnus-summary-move-article
7205 Move the article from one mail group to another
7206 (@code{gnus-summary-move-article}).
7207
7208 @item B c
7209 @kindex B c (Summary)
7210 @cindex copy mail
7211 @findex gnus-summary-copy-article
7212 @c @icon{gnus-summary-mail-copy}
7213 Copy the article from one group (mail group or not) to a mail group
7214 (@code{gnus-summary-copy-article}).
7215
7216 @item B B
7217 @kindex B B (Summary)
7218 @cindex crosspost mail
7219 @findex gnus-summary-crosspost-article
7220 Crosspost the current article to some other group
7221 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7222 the article in the other group, and the Xref headers of the article will
7223 be properly updated.
7224
7225 @item B i
7226 @kindex B i (Summary)
7227 @findex gnus-summary-import-article
7228 Import an arbitrary file into the current mail newsgroup
7229 (@code{gnus-summary-import-article}).  You will be prompted for a file
7230 name, a @code{From} header and a @code{Subject} header.
7231
7232 @item B r
7233 @kindex B r (Summary)
7234 @findex gnus-summary-respool-article
7235 Respool the mail article (@code{gnus-summary-respool-article}).
7236 @code{gnus-summary-respool-default-method} will be used as the default
7237 select method when respooling.  This variable is @code{nil} by default,
7238 which means that the current group select method will be used instead.
7239
7240 @item B w
7241 @itemx e
7242 @kindex B w (Summary)
7243 @kindex e (Summary)
7244 @findex gnus-summary-edit-article
7245 @kindex C-c C-c (Article)
7246 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7247 editing and make the changes permanent, type @kbd{C-c C-c}
7248 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7249 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7250
7251 @item B q
7252 @kindex B q (Summary)
7253 @findex gnus-summary-respool-query
7254 If you want to re-spool an article, you might be curious as to what group
7255 the article will end up in before you do the re-spooling.  This command
7256 will tell you (@code{gnus-summary-respool-query}).
7257
7258 @item B t
7259 @kindex B t (Summary)
7260 @findex gnus-summary-respool-trace
7261 Similarly, this command will display all fancy splitting patterns used
7262 when repooling, if any (@code{gnus-summary-respool-trace}).
7263
7264 @item B p
7265 @kindex B p (Summary)
7266 @findex gnus-summary-article-posted-p
7267 Some people have a tendency to send you "courtesy" copies when they
7268 follow up to articles you have posted.  These usually have a
7269 @code{Newsgroups} header in them, but not always.  This command
7270 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7271 article from your news server (or rather, from
7272 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7273 report back whether it found the article or not.  Even if it says that
7274 it didn't find the article, it may have been posted anyway---mail
7275 propagation is much faster than news propagation, and the news copy may
7276 just not have arrived yet.
7277
7278 @end table
7279
7280 @vindex gnus-move-split-methods
7281 @cindex moving articles
7282 If you move (or copy) articles regularly, you might wish to have Gnus
7283 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7284 variable that uses the same syntax as @code{gnus-split-methods}
7285 (@pxref{Saving Articles}).  You may customize that variable to create
7286 suggestions you find reasonable.
7287
7288 @lisp
7289 (setq gnus-move-split-methods
7290       '(("^From:.*Lars Magne" "nnml:junk")
7291         ("^Subject:.*gnus" "nnfolder:important")
7292         (".*" "nnml:misc")))
7293 @end lisp
7294
7295
7296 @node Various Summary Stuff
7297 @section Various Summary Stuff
7298
7299 @menu
7300 * Summary Group Information::         Information oriented commands.
7301 * Searching for Articles::            Multiple article commands.
7302 * Summary Generation Commands::       (Re)generating the summary buffer.
7303 * Really Various Summary Commands::   Those pesky non-conformant commands.
7304 @end menu
7305
7306 @table @code
7307 @vindex gnus-summary-mode-hook
7308 @item gnus-summary-mode-hook
7309 This hook is called when creating a summary mode buffer.
7310
7311 @vindex gnus-summary-generate-hook
7312 @item gnus-summary-generate-hook
7313 This is called as the last thing before doing the threading and the
7314 generation of the summary buffer.  It's quite convenient for customizing
7315 the threading variables based on what data the newsgroup has.  This hook
7316 is called from the summary buffer after most summary buffer variables
7317 have been set.
7318
7319 @vindex gnus-summary-prepare-hook
7320 @item gnus-summary-prepare-hook
7321 It is called after the summary buffer has been generated.  You might use
7322 it to, for instance, highlight lines or modify the look of the buffer in
7323 some other ungodly manner.  I don't care.
7324
7325 @vindex gnus-summary-ignore-duplicates
7326 @item gnus-summary-ignore-duplicates
7327 When Gnus discovers two articles that have the same @code{Message-ID},
7328 it has to do something drastic.  No articles are allowed to have the
7329 same @code{Message-ID}, but this may happen when reading mail from some
7330 sources.  Gnus allows you to customize what happens with this variable.
7331 If it is @code{nil} (which is the default), Gnus will rename the
7332 @code{Message-ID} (for display purposes only) and display the article as
7333 any other article.  If this variable is @code{t}, it won't display the
7334 article---it'll be as if it never existed.
7335
7336 @end table
7337
7338
7339 @node Summary Group Information
7340 @subsection Summary Group Information
7341
7342 @table @kbd
7343
7344 @item H f
7345 @kindex H f (Summary)
7346 @findex gnus-summary-fetch-faq
7347 @vindex gnus-group-faq-directory
7348 Try to fetch the FAQ (list of frequently asked questions) for the
7349 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7350 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7351 on a remote machine.  This variable can also be a list of directories.
7352 In that case, giving a prefix to this command will allow you to choose
7353 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7354 be used for fetching the file.
7355
7356 @item H d
7357 @kindex H d (Summary)
7358 @findex gnus-summary-describe-group
7359 Give a brief description of the current group
7360 (@code{gnus-summary-describe-group}).  If given a prefix, force
7361 rereading the description from the server.
7362
7363 @item H h
7364 @kindex H h (Summary)
7365 @findex gnus-summary-describe-briefly
7366 Give an extremely brief description of the most important summary
7367 keystrokes (@code{gnus-summary-describe-briefly}).
7368
7369 @item H i
7370 @kindex H i (Summary)
7371 @findex gnus-info-find-node
7372 Go to the Gnus info node (@code{gnus-info-find-node}).
7373 @end table
7374
7375
7376 @node Searching for Articles
7377 @subsection Searching for Articles
7378
7379 @table @kbd
7380
7381 @item M-s
7382 @kindex M-s (Summary)
7383 @findex gnus-summary-search-article-forward
7384 Search through all subsequent articles for a regexp
7385 (@code{gnus-summary-search-article-forward}).
7386
7387 @item M-r
7388 @kindex M-r (Summary)
7389 @findex gnus-summary-search-article-backward
7390 Search through all previous articles for a regexp
7391 (@code{gnus-summary-search-article-backward}).
7392
7393 @item &
7394 @kindex & (Summary)
7395 @findex gnus-summary-execute-command
7396 This command will prompt you for a header field, a regular expression to
7397 match on this field, and a command to be executed if the match is made
7398 (@code{gnus-summary-execute-command}).  If given a prefix, search
7399 backward instead.
7400
7401 @item M-&
7402 @kindex M-& (Summary)
7403 @findex gnus-summary-universal-argument
7404 Perform any operation on all articles that have been marked with
7405 the process mark (@code{gnus-summary-universal-argument}).
7406 @end table
7407
7408 @node Summary Generation Commands
7409 @subsection Summary Generation Commands
7410
7411 @table @kbd
7412
7413 @item Y g
7414 @kindex Y g (Summary)
7415 @findex gnus-summary-prepare
7416 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7417
7418 @item Y c
7419 @kindex Y c (Summary)
7420 @findex gnus-summary-insert-cached-articles
7421 Pull all cached articles (for the current group) into the summary buffer
7422 (@code{gnus-summary-insert-cached-articles}).
7423
7424 @end table
7425
7426
7427 @node Really Various Summary Commands
7428 @subsection Really Various Summary Commands
7429
7430 @table @kbd
7431
7432 @item C-d
7433 @kindex C-d (Summary)
7434 @findex gnus-summary-enter-digest-group
7435 If the current article is a collection of other articles (for instance,
7436 a digest), you might use this command to enter a group based on the that
7437 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7438 guess what article type is currently displayed unless you give a prefix
7439 to this command, which forces a ``digest'' interpretation.  Basically,
7440 whenever you see a message that is a collection of other messages of
7441 some format, you @kbd{C-d} and read these messages in a more convenient
7442 fashion.
7443
7444 @item M-C-d
7445 @kindex M-C-d (Summary)
7446 @findex gnus-summary-read-document
7447 This command is very similar to the one above, but lets you gather
7448 several documents into one biiig group
7449 (@code{gnus-summary-read-document}).  It does this by opening several
7450 @code{nndoc} groups for each document, and then opening an
7451 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7452 command understands the process/prefix convention
7453 (@pxref{Process/Prefix}).
7454
7455 @item C-t
7456 @kindex C-t (Summary)
7457 @findex gnus-summary-toggle-truncation
7458 Toggle truncation of summary lines
7459 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7460 line centering function in the summary buffer, so it's not a good idea
7461 to have truncation switched off while reading articles.
7462
7463 @item =
7464 @kindex = (Summary)
7465 @findex gnus-summary-expand-window
7466 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7467 If given a prefix, force an @code{article} window configuration.
7468
7469 @item M-C-e
7470 @kindex M-C-e (Summary)
7471 @findex gnus-summary-edit-parameters
7472 Edit the group parameters (@pxref{Group Parameters}) of the current
7473 group (@code{gnus-summary-edit-parameters}).
7474
7475 @end table
7476
7477
7478 @node Exiting the Summary Buffer
7479 @section Exiting the Summary Buffer
7480 @cindex summary exit
7481 @cindex exiting groups
7482
7483 Exiting from the summary buffer will normally update all info on the
7484 group and return you to the group buffer.
7485
7486 @table @kbd
7487
7488 @item Z Z
7489 @itemx q
7490 @kindex Z Z (Summary)
7491 @kindex q (Summary)
7492 @findex gnus-summary-exit
7493 @vindex gnus-summary-exit-hook
7494 @vindex gnus-summary-prepare-exit-hook
7495 @c @icon{gnus-summary-exit}
7496 Exit the current group and update all information on the group
7497 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7498 called before doing much of the exiting, which calls
7499 @code{gnus-summary-expire-articles} by default.
7500 @code{gnus-summary-exit-hook} is called after finishing the exit
7501 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7502 group mode having no more (unread) groups.
7503
7504 @item Z E
7505 @itemx Q
7506 @kindex Z E (Summary)
7507 @kindex Q (Summary)
7508 @findex gnus-summary-exit-no-update
7509 Exit the current group without updating any information on the group
7510 (@code{gnus-summary-exit-no-update}).
7511
7512 @item Z c
7513 @itemx c
7514 @kindex Z c (Summary)
7515 @kindex c (Summary)
7516 @findex gnus-summary-catchup-and-exit
7517 @c @icon{gnus-summary-catchup-and-exit}
7518 Mark all unticked articles in the group as read and then exit
7519 (@code{gnus-summary-catchup-and-exit}).
7520
7521 @item Z C
7522 @kindex Z C (Summary)
7523 @findex gnus-summary-catchup-all-and-exit
7524 Mark all articles, even the ticked ones, as read and then exit
7525 (@code{gnus-summary-catchup-all-and-exit}).
7526
7527 @item Z n
7528 @kindex Z n (Summary)
7529 @findex gnus-summary-catchup-and-goto-next-group
7530 Mark all articles as read and go to the next group
7531 (@code{gnus-summary-catchup-and-goto-next-group}).
7532
7533 @item Z R
7534 @kindex Z R (Summary)
7535 @findex gnus-summary-reselect-current-group
7536 Exit this group, and then enter it again
7537 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7538 all articles, both read and unread.
7539
7540 @item Z G
7541 @itemx M-g
7542 @kindex Z G (Summary)
7543 @kindex M-g (Summary)
7544 @findex gnus-summary-rescan-group
7545 @c @icon{gnus-summary-mail-get}
7546 Exit the group, check for new articles in the group, and select the
7547 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7548 articles, both read and unread.
7549
7550 @item Z N
7551 @kindex Z N (Summary)
7552 @findex gnus-summary-next-group
7553 Exit the group and go to the next group
7554 (@code{gnus-summary-next-group}).
7555
7556 @item Z P
7557 @kindex Z P (Summary)
7558 @findex gnus-summary-prev-group
7559 Exit the group and go to the previous group
7560 (@code{gnus-summary-prev-group}).
7561
7562 @item Z s
7563 @kindex Z s (Summary)
7564 @findex gnus-summary-save-newsrc
7565 Save the current number of read/marked articles in the dribble buffer
7566 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7567 given a prefix, also save the @file{.newsrc} file(s).  Using this
7568 command will make exit without updating (the @kbd{Q} command) worthless.
7569 @end table
7570
7571 @vindex gnus-exit-group-hook
7572 @code{gnus-exit-group-hook} is called when you exit the current
7573 group.
7574
7575 @findex gnus-summary-wake-up-the-dead
7576 @findex gnus-dead-summary-mode
7577 @vindex gnus-kill-summary-on-exit
7578 If you're in the habit of exiting groups, and then changing your mind
7579 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7580 If you do that, Gnus won't kill the summary buffer when you exit it.
7581 (Quelle surprise!)  Instead it will change the name of the buffer to
7582 something like @samp{*Dead Summary ... *} and install a minor mode
7583 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7584 buffer, you'll find that all keys are mapped to a function called
7585 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7586 summary buffer will result in a live, normal summary buffer.
7587
7588 There will never be more than one dead summary buffer at any one time.
7589
7590 @vindex gnus-use-cross-reference
7591 The data on the current group will be updated (which articles you have
7592 read, which articles you have replied to, etc.) when you exit the
7593 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7594 @code{t} (which is the default), articles that are cross-referenced to
7595 this group and are marked as read, will also be marked as read in the
7596 other subscribed groups they were cross-posted to.  If this variable is
7597 neither @code{nil} nor @code{t}, the article will be marked as read in
7598 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7599
7600
7601 @node Crosspost Handling
7602 @section Crosspost Handling
7603
7604 @cindex velveeta
7605 @cindex spamming
7606 Marking cross-posted articles as read ensures that you'll never have to
7607 read the same article more than once.  Unless, of course, somebody has
7608 posted it to several groups separately.  Posting the same article to
7609 several groups (not cross-posting) is called @dfn{spamming}, and you are
7610 by law required to send nasty-grams to anyone who perpetrates such a
7611 heinous crime.  You may want to try NoCeM handling to filter out spam
7612 (@pxref{NoCeM}).
7613
7614 Remember: Cross-posting is kinda ok, but posting the same article
7615 separately to several groups is not.  Massive cross-posting (aka.
7616 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7617 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7618 excessive crossposting (@pxref{Summary Mail Commands}).
7619
7620 @cindex cross-posting
7621 @cindex Xref
7622 @cindex @sc{nov}
7623 One thing that may cause Gnus to not do the cross-posting thing
7624 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7625 (which is very nice, because it speeds things up considerably) which
7626 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7627 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7628 even with @sc{xover} by registering the @code{Xref} lines of all
7629 articles you actually read, but if you kill the articles, or just mark
7630 them as read without reading them, Gnus will not get a chance to snoop
7631 the @code{Xref} lines out of these articles, and will be unable to use
7632 the cross reference mechanism.
7633
7634 @cindex LIST overview.fmt
7635 @cindex overview.fmt
7636 To check whether your @sc{nntp} server includes the @code{Xref} header
7637 in its overview files, try @samp{telnet your.nntp.server nntp},
7638 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7639 overview.fmt}.  This may not work, but if it does, and the last line you
7640 get does not read @samp{Xref:full}, then you should shout and whine at
7641 your news admin until she includes the @code{Xref} header in the
7642 overview files.
7643
7644 @vindex gnus-nov-is-evil
7645 If you want Gnus to get the @code{Xref}s right all the time, you have to
7646 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7647 considerably.
7648
7649 C'est la vie.
7650
7651 For an alternative approach, @pxref{Duplicate Suppression}.
7652
7653
7654 @node Duplicate Suppression
7655 @section Duplicate Suppression
7656
7657 By default, Gnus tries to make sure that you don't have to read the same
7658 article more than once by utilizing the crossposting mechanism
7659 (@pxref{Crosspost Handling}).  However, that simple and efficient
7660 approach may not work satisfactory for some users for various
7661 reasons.
7662
7663 @enumerate
7664 @item
7665 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7666 is evil and not very common.
7667
7668 @item
7669 The @sc{nntp} server may fail to include the @code{Xref} header in the
7670 @file{.overview} data bases.  This is evil and all too common, alas.
7671
7672 @item
7673 You may be reading the same group (or several related groups) from
7674 different @sc{nntp} servers.
7675
7676 @item
7677 You may be getting mail that duplicates articles posted to groups.
7678 @end enumerate
7679
7680 I'm sure there are other situations where @code{Xref} handling fails as
7681 well, but these four are the most common situations.
7682
7683 If, and only if, @code{Xref} handling fails for you, then you may
7684 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7685 will remember the @code{Message-ID}s of all articles you have read or
7686 otherwise marked as read, and then, as if by magic, mark them as read
7687 all subsequent times you see them---in @emph{all} groups.  Using this
7688 mechanism is quite likely to be somewhat inefficient, but not overly
7689 so.  It's certainly preferable to reading the same articles more than
7690 once.
7691
7692 Duplicate suppression is not a very subtle instrument.  It's more like a
7693 sledge hammer than anything else.  It works in a very simple
7694 fashion---if you have marked an article as read, it adds this Message-ID
7695 to a cache.  The next time it sees this Message-ID, it will mark the
7696 article as read with the @samp{M} mark.  It doesn't care what group it
7697 saw the article in.
7698
7699 @table @code
7700 @item gnus-suppress-duplicates
7701 @vindex gnus-suppress-duplicates
7702 If non-@code{nil}, suppress duplicates.
7703
7704 @item gnus-save-duplicate-list
7705 @vindex gnus-save-duplicate-list
7706 If non-@code{nil}, save the list of duplicates to a file.  This will
7707 make startup and shutdown take longer, so the default is @code{nil}.
7708 However, this means that only duplicate articles read in a single Gnus
7709 session are suppressed.
7710
7711 @item gnus-duplicate-list-length
7712 @vindex gnus-duplicate-list-length
7713 This variable says how many @code{Message-ID}s to keep in the duplicate
7714 suppression list.  The default is 10000.
7715
7716 @item gnus-duplicate-file
7717 @vindex gnus-duplicate-file
7718 The name of the file to store the duplicate suppression list in.  The
7719 default is @file{~/News/suppression}.
7720 @end table
7721
7722 If you have a tendency to stop and start Gnus often, setting
7723 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7724 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7725 the other hand, saving the list makes startup and shutdown much slower,
7726 so that means that if you stop and start Gnus often, you should set
7727 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7728 to you to figure out, I think.
7729
7730
7731 @node The Article Buffer
7732 @chapter The Article Buffer
7733 @cindex article buffer
7734
7735 The articles are displayed in the article buffer, of which there is only
7736 one.  All the summary buffers share the same article buffer unless you
7737 tell Gnus otherwise.
7738
7739 @menu
7740 * Hiding Headers::        Deciding what headers should be displayed.
7741 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7742 * Customizing Articles::  Tailoring the look of the articles.
7743 * Article Keymap::        Keystrokes available in the article buffer.
7744 * Misc Article::          Other stuff.
7745 @end menu
7746
7747
7748 @node Hiding Headers
7749 @section Hiding Headers
7750 @cindex hiding headers
7751 @cindex deleting headers
7752
7753 The top section of each article is the @dfn{head}.  (The rest is the
7754 @dfn{body}, but you may have guessed that already.)
7755
7756 @vindex gnus-show-all-headers
7757 There is a lot of useful information in the head: the name of the person
7758 who wrote the article, the date it was written and the subject of the
7759 article.  That's well and nice, but there's also lots of information
7760 most people do not want to see---what systems the article has passed
7761 through before reaching you, the @code{Message-ID}, the
7762 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7763 of some of those lines.  If you want to keep all those lines in the
7764 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7765
7766 Gnus provides you with two variables for sifting headers:
7767
7768 @table @code
7769
7770 @item gnus-visible-headers
7771 @vindex gnus-visible-headers
7772 If this variable is non-@code{nil}, it should be a regular expression
7773 that says what headers you wish to keep in the article buffer.  All
7774 headers that do not match this variable will be hidden.
7775
7776 For instance, if you only want to see the name of the person who wrote
7777 the article and the subject, you'd say:
7778
7779 @lisp
7780 (setq gnus-visible-headers "^From:\\|^Subject:")
7781 @end lisp
7782
7783 This variable can also be a list of regexps to match headers to
7784 remain visible.
7785
7786 @item gnus-ignored-headers
7787 @vindex gnus-ignored-headers
7788 This variable is the reverse of @code{gnus-visible-headers}.  If this
7789 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7790 should be a regular expression that matches all lines that you want to
7791 hide.  All lines that do not match this variable will remain visible.
7792
7793 For instance, if you just want to get rid of the @code{References} line
7794 and the @code{Xref} line, you might say:
7795
7796 @lisp
7797 (setq gnus-ignored-headers "^References:\\|^Xref:")
7798 @end lisp
7799
7800 This variable can also be a list of regexps to match headers to
7801 be removed.
7802
7803 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7804 variable will have no effect.
7805
7806 @end table
7807
7808 @vindex gnus-sorted-header-list
7809 Gnus can also sort the headers for you.  (It does this by default.)  You
7810 can control the sorting by setting the @code{gnus-sorted-header-list}
7811 variable.  It is a list of regular expressions that says in what order
7812 the headers are to be displayed.
7813
7814 For instance, if you want the name of the author of the article first,
7815 and then the subject, you might say something like:
7816
7817 @lisp
7818 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7819 @end lisp
7820
7821 Any headers that are to remain visible, but are not listed in this
7822 variable, will be displayed in random order after all the headers listed in this variable.
7823
7824 @findex gnus-article-hide-boring-headers
7825 @vindex gnus-article-display-hook
7826 @vindex gnus-boring-article-headers
7827 You can hide further boring headers by entering
7828 @code{gnus-article-hide-boring-headers} into
7829 @code{gnus-article-display-hook}.  What this function does depends on
7830 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7831 list doesn't actually contain header names.  Instead is lists various
7832 @dfn{boring conditions} that Gnus can check and remove from sight.
7833
7834 These conditions are:
7835 @table @code
7836 @item empty
7837 Remove all empty headers.
7838 @item followup-to
7839 Remove the @code{Followup-To} header if it is identical to the
7840 @code{Newsgroups} header.
7841 @item reply-to
7842 Remove the @code{Reply-To} header if it lists the same address as the
7843 @code{From} header.
7844 @item newsgroups
7845 Remove the @code{Newsgroups} header if it only contains the current group
7846 name.
7847 @item date
7848 Remove the @code{Date} header if the article is less than three days
7849 old.
7850 @item long-to
7851 Remove the @code{To} header if it is very long.
7852 @item many-to
7853 Remove all @code{To} headers if there are more than one.
7854 @end table
7855
7856 To include the four three elements, you could say something like;
7857
7858 @lisp
7859 (setq gnus-boring-article-headers
7860       '(empty followup-to reply-to))
7861 @end lisp
7862
7863 This is also the default value for this variable.
7864
7865
7866 @node Using MIME
7867 @section Using @sc{mime}
7868 @cindex @sc{mime}
7869
7870 Mime is a standard for waving your hands through the air, aimlessly,
7871 while people stand around yawning.
7872
7873 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7874 while all newsreaders die of fear.
7875
7876 @sc{mime} may specify what character set the article uses, the encoding
7877 of the characters, and it also makes it possible to embed pictures and
7878 other naughty stuff in innocent-looking articles.
7879
7880 @vindex gnus-show-mime
7881 @vindex gnus-show-mime-method
7882 @vindex gnus-strict-mime
7883 @findex metamail-buffer
7884 Gnus handles @sc{mime} by pushing the articles through
7885 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7886 default.  This function calls the external @code{metamail} program to
7887 actually do the work.  One common problem with this program is that is
7888 thinks that it can't display 8-bit things in the Emacs buffer.  To tell
7889 it the truth, put something like the following in your
7890 @file{.bash_profile} file.  (You do use @code{bash}, don't you?)
7891
7892 @example
7893 export MM_CHARSET="iso-8859-1"
7894 @end example
7895
7896 For more information on @code{metamail}, see its manual page.
7897
7898 Set @code{gnus-show-mime} to @code{t} if you want to use
7899 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7900 non-@code{nil}, the @sc{mime} method will only be used if there are
7901 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7902 set, then you'll see some unfortunate display glitches in the article
7903 buffer.  These can't be avoided.
7904
7905 It might be best to just use the toggling functions from the summary
7906 buffer to avoid getting nasty surprises. (For instance, you enter the
7907 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7908 decoded the sound file in the article and some horrible sing-a-long song
7909 comes screaming out your speakers, and you can't find the volume
7910 button, because there isn't one, and people are starting to look at you,
7911 and you try to stop the program, but you can't, and you can't find the
7912 program to control the volume, and everybody else in the room suddenly
7913 decides to look at you disdainfully, and you'll feel rather stupid.)
7914
7915 Any similarity to real events and people is purely coincidental.  Ahem.
7916
7917
7918 @node Customizing Articles
7919 @section Customizing Articles
7920 @cindex article customization
7921
7922 @vindex gnus-article-display-hook
7923 The @code{gnus-article-display-hook} is called after the article has
7924 been inserted into the article buffer.  It is meant to handle all
7925 treatment of the article before it is displayed.
7926
7927 @findex gnus-article-maybe-highlight
7928 @findex gnus-article-maybe-hide-headers
7929 By default this hook just contains
7930 @code{gnus-article-maybe-hide-headers},
7931 @code{gnus-hide-boring-headers}, @code{gnus-article-treat-overstrike},
7932 and @code{gnus-article-maybe-highlight} (and under XEmacs,
7933 @code{gnus-article-display-x-face}), but there are thousands, nay
7934 millions, of functions you can put in this hook.  For an overview of
7935 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7936 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7937 Date}.  Note that the order of functions in this hook might affect
7938 things, so you may have to fiddle a bit to get the desired results.
7939
7940 You can, of course, write your own functions.  The functions are called
7941 from the article buffer, and you can do anything you like, pretty much.
7942 There is no information that you have to keep in the buffer---you can
7943 change everything.  However, you shouldn't delete any headers.  Instead
7944 make them invisible if you want to make them go away.
7945
7946
7947 @node Article Keymap
7948 @section Article Keymap
7949
7950 Most of the keystrokes in the summary buffer can also be used in the
7951 article buffer.  They should behave as if you typed them in the summary
7952 buffer, which means that you don't actually have to have a summary
7953 buffer displayed while reading.  You can do it all from the article
7954 buffer.
7955
7956 A few additional keystrokes are available:
7957
7958 @table @kbd
7959
7960 @item SPACE
7961 @kindex SPACE (Article)
7962 @findex gnus-article-next-page
7963 Scroll forwards one page (@code{gnus-article-next-page}).
7964
7965 @item DEL
7966 @kindex DEL (Article)
7967 @findex gnus-article-prev-page
7968 Scroll backwards one page (@code{gnus-article-prev-page}).
7969
7970 @item C-c ^
7971 @kindex C-c ^ (Article)
7972 @findex gnus-article-refer-article
7973 If point is in the neighborhood of a @code{Message-ID} and you press
7974 @kbd{C-c ^}, Gnus will try to get that article from the server
7975 (@code{gnus-article-refer-article}).
7976
7977 @item C-c C-m
7978 @kindex C-c C-m (Article)
7979 @findex gnus-article-mail
7980 Send a reply to the address near point (@code{gnus-article-mail}).  If
7981 given a prefix, include the mail.
7982
7983 @item s
7984 @kindex s (Article)
7985 @findex gnus-article-show-summary
7986 Reconfigure the buffers so that the summary buffer becomes visible
7987 (@code{gnus-article-show-summary}).
7988
7989 @item ?
7990 @kindex ? (Article)
7991 @findex gnus-article-describe-briefly
7992 Give a very brief description of the available keystrokes
7993 (@code{gnus-article-describe-briefly}).
7994
7995 @item TAB
7996 @kindex TAB (Article)
7997 @findex gnus-article-next-button
7998 Go to the next button, if any (@code{gnus-article-next-button}).  This
7999 only makes sense if you have buttonizing turned on.
8000
8001 @item M-TAB
8002 @kindex M-TAB (Article)
8003 @findex gnus-article-prev-button
8004 Go to the previous button, if any (@code{gnus-article-prev-button}).
8005
8006 @end table
8007
8008
8009 @node Misc Article
8010 @section Misc Article
8011
8012 @table @code
8013
8014 @item gnus-single-article-buffer
8015 @vindex gnus-single-article-buffer
8016 If non-@code{nil}, use the same article buffer for all the groups.
8017 (This is the default.)  If @code{nil}, each group will have its own
8018 article buffer.
8019
8020 @vindex gnus-article-prepare-hook
8021 @item gnus-article-prepare-hook
8022 This hook is called right after the article has been inserted into the
8023 article buffer.  It is mainly intended for functions that do something
8024 depending on the contents; it should probably not be used for changing
8025 the contents of the article buffer.
8026
8027 @vindex gnus-article-display-hook
8028 @item gnus-article-display-hook
8029 This hook is called as the last thing when displaying an article, and is
8030 intended for modifying the contents of the buffer, doing highlights,
8031 hiding headers, and the like.
8032
8033 @item gnus-article-mode-hook
8034 @vindex gnus-article-mode-hook
8035 Hook called in article mode buffers.
8036
8037 @item gnus-article-mode-syntax-table
8038 @vindex gnus-article-mode-syntax-table
8039 Syntax table used in article buffers.  It is initialized from
8040 @code{text-mode-syntax-table}.
8041
8042 @vindex gnus-article-mode-line-format
8043 @item gnus-article-mode-line-format
8044 This variable is a format string along the same lines as
8045 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
8046 accepts the same format specifications as that variable, with one
8047 extension:
8048
8049 @table @samp
8050 @item w
8051 The @dfn{wash status} of the article.  This is a short string with one
8052 character for each possible article wash operation that may have been
8053 performed.
8054 @end table
8055
8056 @vindex gnus-break-pages
8057
8058 @item gnus-break-pages
8059 Controls whether @dfn{page breaking} is to take place.  If this variable
8060 is non-@code{nil}, the articles will be divided into pages whenever a
8061 page delimiter appears in the article.  If this variable is @code{nil},
8062 paging will not be done.
8063
8064 @item gnus-page-delimiter
8065 @vindex gnus-page-delimiter
8066 This is the delimiter mentioned above.  By default, it is @samp{^L}
8067 (formfeed).
8068 @end table
8069
8070
8071 @node Composing Messages
8072 @chapter Composing Messages
8073 @cindex composing messages
8074 @cindex messages
8075 @cindex mail
8076 @cindex sending mail
8077 @cindex reply
8078 @cindex followup
8079 @cindex post
8080
8081 @kindex C-c C-c (Post)
8082 All commands for posting and mailing will put you in a message buffer
8083 where you can edit the article all you like, before you send the article
8084 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
8085 Manual}.  If you are in a foreign news group, and you wish to post the
8086 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8087 to make Gnus try to post using the foreign server.
8088
8089 @menu
8090 * Mail::                 Mailing and replying.
8091 * Post::                 Posting and following up.
8092 * Posting Server::       What server should you post via?
8093 * Mail and Post::        Mailing and posting at the same time.
8094 * Archived Messages::    Where Gnus stores the messages you've sent.
8095 * Posting Styles::       An easier way to specify who you are.
8096 * Drafts::               Postponing messages and rejected messages.
8097 * Rejected Articles::    What happens if the server doesn't like your article?
8098 @end menu
8099
8100 Also see @pxref{Canceling and Superseding} for information on how to
8101 remove articles you shouldn't have posted.
8102
8103
8104 @node Mail
8105 @section Mail
8106
8107 Variables for customizing outgoing mail:
8108
8109 @table @code
8110 @item gnus-uu-digest-headers
8111 @vindex gnus-uu-digest-headers
8112 List of regexps to match headers included in digested messages.  The
8113 headers will be included in the sequence they are matched.
8114
8115 @item gnus-add-to-list
8116 @vindex gnus-add-to-list
8117 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8118 that have none when you do a @kbd{a}.
8119
8120 @end table
8121
8122
8123 @node Post
8124 @section Post
8125
8126 Variables for composing news articles:
8127
8128 @table @code
8129 @item gnus-sent-message-ids-file
8130 @vindex gnus-sent-message-ids-file
8131 Gnus will keep a @code{Message-ID} history file of all the mails it has
8132 sent.  If it discovers that it has already sent a mail, it will ask the
8133 user whether to re-send the mail.  (This is primarily useful when
8134 dealing with @sc{soup} packets and the like where one is apt to send the
8135 same packet multiple times.)  This variable says what the name of this
8136 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8137 this variable to @code{nil} if you don't want Gnus to keep a history
8138 file.
8139
8140 @item gnus-sent-message-ids-length
8141 @vindex gnus-sent-message-ids-length
8142 This variable says how many @code{Message-ID}s to keep in the history
8143 file.  It is 1000 by default.
8144
8145 @end table
8146
8147
8148 @node Posting Server
8149 @section Posting Server
8150
8151 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8152 (extremely intelligent, of course) article, where does it go?
8153
8154 Thank you for asking.  I hate you.
8155
8156 @vindex gnus-post-method
8157
8158 It can be quite complicated.  Normally, Gnus will use the same native
8159 server.  However.  If your native server doesn't allow posting, just
8160 reading, you probably want to use some other server to post your
8161 (extremely intelligent and fabulously interesting) articles.  You can
8162 then set the @code{gnus-post-method} to some other method:
8163
8164 @lisp
8165 (setq gnus-post-method '(nnspool ""))
8166 @end lisp
8167
8168 Now, if you've done this, and then this server rejects your article, or
8169 this server is down, what do you do then?  To override this variable you
8170 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8171 the ``current'' server for posting.
8172
8173 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8174 Gnus will prompt you for what method to use for posting.
8175
8176 You can also set @code{gnus-post-method} to a list of select methods.
8177 If that's the case, Gnus will always prompt you for what method to use
8178 for posting.
8179
8180 Finally, if you want to always post using the same select method as
8181 you're reading from (which might be convenient if you're reading lots of
8182 groups from different private servers), you can set this variable to
8183 @code{current}. 
8184
8185
8186 @node Mail and Post
8187 @section Mail and Post
8188
8189 Here's a list of variables relevant to both mailing and
8190 posting:
8191
8192 @table @code
8193 @item gnus-mailing-list-groups
8194 @findex gnus-mailing-list-groups
8195 @cindex mailing lists
8196
8197 If your news server offers groups that are really mailing lists
8198 gatewayed to the @sc{nntp} server, you can read those groups without
8199 problems, but you can't post/followup to them without some difficulty.
8200 One solution is to add a @code{to-address} to the group parameters
8201 (@pxref{Group Parameters}).  An easier thing to do is set the
8202 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8203 really are mailing lists.  Then, at least, followups to the mailing
8204 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8205 still a pain, though.
8206
8207 @end table
8208
8209 You may want to do spell-checking on messages that you send out.  Or, if
8210 you don't want to spell-check by hand, you could add automatic
8211 spell-checking via the @code{ispell} package:
8212
8213 @cindex ispell
8214 @findex ispell-message
8215 @lisp
8216 (add-hook 'message-send-hook 'ispell-message)
8217 @end lisp
8218
8219
8220 @node Archived Messages
8221 @section Archived Messages
8222 @cindex archived messages
8223 @cindex sent messages
8224
8225 Gnus provides a few different methods for storing the mail and news you
8226 send.  The default method is to use the @dfn{archive virtual server} to
8227 store the messages.  If you want to disable this completely, the
8228 @code{gnus-message-archive-group} variable should be @code{nil}, which
8229 is the default.
8230
8231 @vindex gnus-message-archive-method
8232 @code{gnus-message-archive-method} says what virtual server Gnus is to
8233 use to store sent messages.  The default is:
8234
8235 @lisp
8236 (nnfolder "archive"
8237           (nnfolder-directory   "~/Mail/archive")
8238           (nnfolder-active-file "~/Mail/archive/active")
8239           (nnfolder-get-new-mail nil)
8240           (nnfolder-inhibit-expiry t))
8241 @end lisp
8242
8243 You can, however, use any mail select method (@code{nnml},
8244 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8245 for doing this sort of thing, though.  If you don't like the default
8246 directory chosen, you could say something like:
8247
8248 @lisp
8249 (setq gnus-message-archive-method
8250       '(nnfolder "archive"
8251                  (nnfolder-inhibit-expiry t)
8252                  (nnfolder-active-file "~/News/sent-mail/active")
8253                  (nnfolder-directory "~/News/sent-mail/")))
8254 @end lisp
8255
8256 @vindex gnus-message-archive-group
8257 @cindex Gcc
8258 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8259 to one or more group(s) on that server.  Which group to use is
8260 determined by the @code{gnus-message-archive-group} variable.
8261
8262 This variable can be used to do the following:
8263
8264 @itemize @bullet
8265 @item a string
8266 Messages will be saved in that group.
8267 @item a list of strings
8268 Messages will be saved in all those groups.
8269 @item an alist of regexps, functions and forms
8270 When a key ``matches'', the result is used.
8271 @item @code{nil}
8272 No message archiving will take place.  This is the default.
8273 @end itemize
8274
8275 Let's illustrate:
8276
8277 Just saving to a single group called @samp{MisK}:
8278 @lisp
8279 (setq gnus-message-archive-group "MisK")
8280 @end lisp
8281
8282 Saving to two groups, @samp{MisK} and @samp{safe}:
8283 @lisp
8284 (setq gnus-message-archive-group '("MisK" "safe"))
8285 @end lisp
8286
8287 Save to different groups based on what group you are in:
8288 @lisp
8289 (setq gnus-message-archive-group
8290       '(("^alt" "sent-to-alt")
8291         ("mail" "sent-to-mail")
8292         (".*" "sent-to-misc")))
8293 @end lisp
8294
8295 More complex stuff:
8296 @lisp
8297 (setq gnus-message-archive-group
8298       '((if (message-news-p)
8299             "misc-news"
8300           "misc-mail")))
8301 @end lisp
8302
8303 How about storing all news messages in one file, but storing all mail
8304 messages in one file per month:
8305
8306 @lisp
8307 (setq gnus-message-archive-group
8308       '((if (message-news-p)
8309             "misc-news"
8310           (concat "mail." (format-time-string
8311                            "%Y-%m" (current-time))))))
8312 @end lisp
8313
8314 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8315 use a different value for @code{gnus-message-archive-group} there.)
8316
8317 Now, when you send a message off, it will be stored in the appropriate
8318 group.  (If you want to disable storing for just one particular message,
8319 you can just remove the @code{Gcc} header that has been inserted.)  The
8320 archive group will appear in the group buffer the next time you start
8321 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
8322 enter it and read the articles in it just like you'd read any other
8323 group.  If the group gets really big and annoying, you can simply rename
8324 if (using @kbd{G r} in the group buffer) to something
8325 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8326 continue to be stored in the old (now empty) group.
8327
8328 That's the default method of archiving sent messages.  Gnus offers a
8329 different way for the people who don't like the default method.  In that
8330 case you should set @code{gnus-message-archive-group} to @code{nil};
8331 this will disable archiving.
8332
8333 @table @code
8334 @item gnus-outgoing-message-group
8335 @vindex gnus-outgoing-message-group
8336 All outgoing messages will be put in this group.  If you want to store
8337 all your outgoing mail and articles in the group @samp{nnml:archive},
8338 you set this variable to that value.  This variable can also be a list of
8339 group names.
8340
8341 If you want to have greater control over what group to put each
8342 message in, you can set this variable to a function that checks the
8343 current newsgroup name and then returns a suitable group name (or list
8344 of names).
8345
8346 This variable can be used instead of @code{gnus-message-archive-group},
8347 but the latter is the preferred method.
8348 @end table
8349
8350
8351 @node Posting Styles
8352 @section Posting Styles
8353 @cindex posting styles
8354 @cindex styles
8355
8356 All them variables, they make my head swim.
8357
8358 So what if you want a different @code{Organization} and signature based
8359 on what groups you post to?  And you post both from your home machine
8360 and your work machine, and you want different @code{From} lines, and so
8361 on?
8362
8363 @vindex gnus-posting-styles
8364 One way to do stuff like that is to write clever hooks that change the
8365 variables you need to have changed.  That's a bit boring, so somebody
8366 came up with the bright idea of letting the user specify these things in
8367 a handy alist.  Here's an example of a @code{gnus-posting-styles}
8368 variable:
8369
8370 @lisp
8371 ((".*"
8372   (signature "Peace and happiness")
8373   (organization "What me?"))
8374  ("^comp"
8375   (signature "Death to everybody"))
8376  ("comp.emacs.i-love-it"
8377   (organization "Emacs is it")))
8378 @end lisp
8379
8380 As you might surmise from this example, this alist consists of several
8381 @dfn{styles}.  Each style will be applicable if the first element
8382 ``matches'', in some form or other.  The entire alist will be iterated
8383 over, from the beginning towards the end, and each match will be
8384 applied, which means that attributes in later styles that match override
8385 the same attributes in earlier matching styles.  So
8386 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8387 signature and the @samp{What me?} @code{Organization} header.
8388
8389 The first element in each style is called the @code{match}.  If it's a
8390 string, then Gnus will try to regexp match it against the group name.
8391 If it's a function symbol, that function will be called with no
8392 arguments.  If it's a variable symbol, then the variable will be
8393 referenced.  If it's a list, then that list will be @code{eval}ed.  In
8394 any case, if this returns a non-@code{nil} value, then the style is said
8395 to @dfn{match}.
8396
8397 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8398 attribute consists of a @var{(name . value)} pair.  The attribute name
8399 can be one of @code{signature}, @code{signature-file},
8400 @code{organization}, @code{address}, @code{name} or @code{body}.  The
8401 attribute name can also be a string.  In that case, this will be used as
8402 a header name, and the value will be inserted in the headers of the
8403 article.
8404
8405 The attribute value can be a string (used verbatim), a function (the
8406 return value will be used), a variable (its value will be used) or a
8407 list (it will be @code{eval}ed and the return value will be used).
8408
8409 So here's a new example:
8410
8411 @lisp
8412 (setq gnus-posting-styles
8413       '((".*"
8414          (signature-file "~/.signature")
8415          (name "User Name")
8416          ("X-Home-Page" (getenv "WWW_HOME"))
8417          (organization "People's Front Against MWM"))
8418         ("^rec.humor"
8419          (signature my-funny-signature-randomizer))
8420         ((equal (system-name) "gnarly")
8421          (signature my-quote-randomizer))
8422         (posting-from-work-p
8423          (signature-file "~/.work-signature")
8424          (address "user@@bar.foo")
8425          (body "You are fired.\n\nSincerely, your boss.")
8426          (organization "Important Work, Inc"))
8427         ("^nn.+:"
8428          (signature-file "~/.mail-signature"))))
8429 @end lisp
8430
8431
8432 @node Drafts
8433 @section Drafts
8434 @cindex drafts
8435
8436 If you are writing a message (mail or news) and suddenly remember that
8437 you have a steak in the oven (or some pesto in the food processor, you
8438 craaazy vegetarians), you'll probably wish there was a method to save
8439 the message you are writing so that you can continue editing it some
8440 other day, and send it when you feel its finished.
8441
8442 Well, don't worry about it.  Whenever you start composing a message of
8443 some sort using the Gnus mail and post commands, the buffer you get will
8444 automatically associate to an article in a special @dfn{draft} group.
8445 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8446 article will be saved there.  (Auto-save files also go to the draft
8447 group.)
8448
8449 @cindex nndraft
8450 @vindex nndraft-directory
8451 The draft group is a special group (which is implemented as an
8452 @code{nndraft} group, if you absolutely have to know) called
8453 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8454 @code{nndraft} is to store its files.  What makes this group special is
8455 that you can't tick any articles in it or mark any articles as
8456 read---all articles in the group are permanently unread.
8457
8458 If the group doesn't exist, it will be created and you'll be subscribed
8459 to it.  The only way to make it disappear from the Group buffer is to
8460 unsubscribe it.
8461
8462 @c @findex gnus-dissociate-buffer-from-draft
8463 @c @kindex C-c M-d (Mail)
8464 @c @kindex C-c M-d (Post)
8465 @c @findex gnus-associate-buffer-with-draft
8466 @c @kindex C-c C-d (Mail)
8467 @c @kindex C-c C-d (Post)
8468 @c If you're writing some super-secret message that you later want to
8469 @c encode with PGP before sending, you may wish to turn the auto-saving
8470 @c (and association with the draft group) off.  You never know who might be
8471 @c interested in reading all your extremely valuable and terribly horrible
8472 @c and interesting secrets.  The @kbd{C-c M-d}
8473 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8474 @c If you change your mind and want to turn the auto-saving back on again,
8475 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8476 @c
8477 @c @vindex gnus-use-draft
8478 @c To leave association with the draft group off by default, set
8479 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
8480
8481 @findex gnus-draft-edit-message
8482 @kindex D e (Draft)
8483 When you want to continue editing the article, you simply enter the
8484 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8485 that.  You will be placed in a buffer where you left off.
8486
8487 Rejected articles will also be put in this draft group (@pxref{Rejected
8488 Articles}).
8489
8490 @findex gnus-draft-send-all-messages
8491 @findex gnus-draft-send-message
8492 If you have lots of rejected messages you want to post (or mail) without
8493 doing further editing, you can use the @kbd{D s} command
8494 (@code{gnus-draft-send-message}).  This command understands the
8495 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
8496 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8497 in the buffer.
8498
8499 If you have some messages that you wish not to send, you can use the
8500 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8501 as unsendable.  This is a toggling command.
8502
8503
8504 @node Rejected Articles
8505 @section Rejected Articles
8506 @cindex rejected articles
8507
8508 Sometimes a news server will reject an article.  Perhaps the server
8509 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
8510 @emph{there be demons}.  Perhaps you have included too much cited text.
8511 Perhaps the disk is full.  Perhaps the server is down.
8512
8513 These situations are, of course, totally beyond the control of Gnus.
8514 (Gnus, of course, loves the way you look, always feels great, has angels
8515 fluttering around inside of it, doesn't care about how much cited text
8516 you include, never runs full and never goes down.)  So Gnus saves these
8517 articles until some later time when the server feels better.
8518
8519 The rejected articles will automatically be put in a special draft group
8520 (@pxref{Drafts}).  When the server comes back up again, you'd then
8521 typically enter that group and send all the articles off.
8522
8523
8524 @node Select Methods
8525 @chapter Select Methods
8526 @cindex foreign groups
8527 @cindex select methods
8528
8529 A @dfn{foreign group} is a group not read by the usual (or
8530 default) means.  It could be, for instance, a group from a different
8531 @sc{nntp} server, it could be a virtual group, or it could be your own
8532 personal mail group.
8533
8534 A foreign group (or any group, really) is specified by a @dfn{name} and
8535 a @dfn{select method}.  To take the latter first, a select method is a
8536 list where the first element says what backend to use (e.g. @code{nntp},
8537 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8538 name}.  There may be additional elements in the select method, where the
8539 value may have special meaning for the backend in question.
8540
8541 One could say that a select method defines a @dfn{virtual server}---so
8542 we do just that (@pxref{The Server Buffer}).
8543
8544 The @dfn{name} of the group is the name the backend will recognize the
8545 group as.
8546
8547 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8548 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8549 method @code{(nntp "some.where.edu")}.  Gnus will call this group
8550 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8551 backend just knows this group as @samp{soc.motss}.
8552
8553 The different methods all have their peculiarities, of course.
8554
8555 @menu
8556 * The Server Buffer::     Making and editing virtual servers.
8557 * Getting News::          Reading USENET news with Gnus.
8558 * Getting Mail::          Reading your personal mail with Gnus.
8559 * Other Sources::         Reading directories, files, SOUP packets.
8560 * Combined Groups::       Combining groups into one group.
8561 * Gnus Unplugged::        Reading news and mail offline.
8562 @end menu
8563
8564
8565 @node The Server Buffer
8566 @section The Server Buffer
8567
8568 Traditionally, a @dfn{server} is a machine or a piece of software that
8569 one connects to, and then requests information from.  Gnus does not
8570 connect directly to any real servers, but does all transactions through
8571 one backend or other.  But that's just putting one layer more between
8572 the actual media and Gnus, so we might just as well say that each
8573 backend represents a virtual server.
8574
8575 For instance, the @code{nntp} backend may be used to connect to several
8576 different actual @sc{nntp} servers, or, perhaps, to many different ports
8577 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8578 use, and what parameters to set by specifying a @dfn{select method}.
8579
8580 These select method specifications can sometimes become quite
8581 complicated---say, for instance, that you want to read from the
8582 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8583 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8584 Anyways, if you had to specify that for each group that used this
8585 server, that would be too much work, so Gnus offers a way of naming
8586 select methods, which is what you do in the server buffer.
8587
8588 To enter the server buffer, use the @kbd{^}
8589 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8590
8591 @menu
8592 * Server Buffer Format::      You can customize the look of this buffer.
8593 * Server Commands::           Commands to manipulate servers.
8594 * Example Methods::           Examples server specifications.
8595 * Creating a Virtual Server:: An example session.
8596 * Server Variables::          Which variables to set.
8597 * Servers and Methods::       You can use server names as select methods.
8598 * Unavailable Servers::       Some servers you try to contact may be down.
8599 @end menu
8600
8601 @vindex gnus-server-mode-hook
8602 @code{gnus-server-mode-hook} is run when creating the server buffer.
8603
8604
8605 @node Server Buffer Format
8606 @subsection Server Buffer Format
8607 @cindex server buffer format
8608
8609 @vindex gnus-server-line-format
8610 You can change the look of the server buffer lines by changing the
8611 @code{gnus-server-line-format} variable.  This is a @code{format}-like
8612 variable, with some simple extensions:
8613
8614 @table @samp
8615
8616 @item h
8617 How the news is fetched---the backend name.
8618
8619 @item n
8620 The name of this server.
8621
8622 @item w
8623 Where the news is to be fetched from---the address.
8624
8625 @item s
8626 The opened/closed/denied status of the server.
8627 @end table
8628
8629 @vindex gnus-server-mode-line-format
8630 The mode line can also be customized by using the
8631 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
8632 Formatting}).  The following specs are understood:
8633
8634 @table @samp
8635 @item S
8636 Server name.
8637
8638 @item M
8639 Server method.
8640 @end table
8641
8642 Also @pxref{Formatting Variables}.
8643
8644
8645 @node Server Commands
8646 @subsection Server Commands
8647 @cindex server commands
8648
8649 @table @kbd
8650
8651 @item a
8652 @kindex a (Server)
8653 @findex gnus-server-add-server
8654 Add a new server (@code{gnus-server-add-server}).
8655
8656 @item e
8657 @kindex e (Server)
8658 @findex gnus-server-edit-server
8659 Edit a server (@code{gnus-server-edit-server}).
8660
8661 @item SPACE
8662 @kindex SPACE (Server)
8663 @findex gnus-server-read-server
8664 Browse the current server (@code{gnus-server-read-server}).
8665
8666 @item q
8667 @kindex q (Server)
8668 @findex gnus-server-exit
8669 Return to the group buffer (@code{gnus-server-exit}).
8670
8671 @item k
8672 @kindex k (Server)
8673 @findex gnus-server-kill-server
8674 Kill the current server (@code{gnus-server-kill-server}).
8675
8676 @item y
8677 @kindex y (Server)
8678 @findex gnus-server-yank-server
8679 Yank the previously killed server (@code{gnus-server-yank-server}).
8680
8681 @item c
8682 @kindex c (Server)
8683 @findex gnus-server-copy-server
8684 Copy the current server (@code{gnus-server-copy-server}).
8685
8686 @item l
8687 @kindex l (Server)
8688 @findex gnus-server-list-servers
8689 List all servers (@code{gnus-server-list-servers}).
8690
8691 @item s
8692 @kindex s (Server)
8693 @findex gnus-server-scan-server
8694 Request that the server scan its sources for new articles
8695 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8696 servers.
8697
8698 @item g
8699 @kindex g (Server)
8700 @findex gnus-server-regenerate-server
8701 Request that the server regenerate all its data structures
8702 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8703 a mail backend that has gotten out of synch.
8704
8705 @end table
8706
8707
8708 @node Example Methods
8709 @subsection Example Methods
8710
8711 Most select methods are pretty simple and self-explanatory:
8712
8713 @lisp
8714 (nntp "news.funet.fi")
8715 @end lisp
8716
8717 Reading directly from the spool is even simpler:
8718
8719 @lisp
8720 (nnspool "")
8721 @end lisp
8722
8723 As you can see, the first element in a select method is the name of the
8724 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8725 will.
8726
8727 After these two elements, there may be an arbitrary number of
8728 @var{(variable form)} pairs.
8729
8730 To go back to the first example---imagine that you want to read from
8731 port 15 on that machine.  This is what the select method should
8732 look like then:
8733
8734 @lisp
8735 (nntp "news.funet.fi" (nntp-port-number 15))
8736 @end lisp
8737
8738 You should read the documentation to each backend to find out what
8739 variables are relevant, but here's an @code{nnmh} example:
8740
8741 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8742 you have two structures that you wish to access: One is your private
8743 mail spool, and the other is a public one.  Here's the possible spec for
8744 your private mail:
8745
8746 @lisp
8747 (nnmh "private" (nnmh-directory "~/private/mail/"))
8748 @end lisp
8749
8750 (This server is then called @samp{private}, but you may have guessed
8751 that.)
8752
8753 Here's the method for a public spool:
8754
8755 @lisp
8756 (nnmh "public"
8757       (nnmh-directory "/usr/information/spool/")
8758       (nnmh-get-new-mail nil))
8759 @end lisp
8760
8761 If you are behind a firewall and only have access to the @sc{nntp}
8762 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8763 on the firewall machine and telnet from there to the @sc{nntp} server.
8764 Doing this can be rather fiddly, but your virtual server definition
8765 should probably look something like this:
8766
8767 @lisp
8768 (nntp "firewall"
8769       (nntp-address "the.firewall.machine")
8770       (nntp-open-connection-function nntp-open-rlogin)
8771       (nntp-end-of-line "\n")
8772       (nntp-rlogin-parameters
8773        ("telnet" "the.real.nntp.host" "nntp")))
8774 @end lisp
8775
8776 If you want to use the wonderful @code{ssh} program to provide a
8777 compressed connection over the modem line, you could create a virtual
8778 server that would look something like this:
8779
8780 @lisp
8781 (nntp "news"
8782        (nntp-address "copper.uio.no")
8783        (nntp-rlogin-program "ssh")
8784        (nntp-open-connection-function nntp-open-rlogin)
8785        (nntp-end-of-line "\n")
8786        (nntp-rlogin-parameters
8787         ("telnet" "news.uio.no" "nntp")))
8788 @end lisp
8789
8790 This means that you have to have set up @code{ssh-agent} correctly to
8791 provide automatic authorization, of course.  And to get a compressed
8792 connection, you have to have the @samp{Compression} option in the
8793 @code{ssh} @file{config} file.
8794
8795
8796 @node Creating a Virtual Server
8797 @subsection Creating a Virtual Server
8798
8799 If you're saving lots of articles in the cache by using persistent
8800 articles, you may want to create a virtual server to read the cache.
8801
8802 First you need to add a new server.  The @kbd{a} command does that.  It
8803 would probably be best to use @code{nnspool} to read the cache.  You
8804 could also use @code{nnml} or @code{nnmh}, though.
8805
8806 Type @kbd{a nnspool RET cache RET}.
8807
8808 You should now have a brand new @code{nnspool} virtual server called
8809 @samp{cache}.  You now need to edit it to have the right definitions.
8810 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8811 will contain the following:
8812
8813 @lisp
8814 (nnspool "cache")
8815 @end lisp
8816
8817 Change that to:
8818
8819 @lisp
8820 (nnspool "cache"
8821          (nnspool-spool-directory "~/News/cache/")
8822          (nnspool-nov-directory "~/News/cache/")
8823          (nnspool-active-file "~/News/cache/active"))
8824 @end lisp
8825
8826 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8827 @kbd{RET} over this virtual server, you should be entered into a browse
8828 buffer, and you should be able to enter any of the groups displayed.
8829
8830
8831 @node Server Variables
8832 @subsection Server Variables
8833
8834 One sticky point when defining variables (both on backends and in Emacs
8835 in general) is that some variables are typically initialized from other
8836 variables when the definition of the variables is being loaded.  If you
8837 change the "base" variable after the variables have been loaded, you
8838 won't change the "derived" variables.
8839
8840 This typically affects directory and file variables.  For instance,
8841 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8842 directory variables are initialized from that variable, so
8843 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8844 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8845 @code{nnml-directory}---you have to explicitly set all the file
8846 variables to be what you want them to be.  For a complete list of
8847 variables for each backend, see each backend's section later in this
8848 manual, but here's an example @code{nnml} definition:
8849
8850 @lisp
8851 (nnml "public"
8852       (nnml-directory "~/my-mail/")
8853       (nnml-active-file "~/my-mail/active")
8854       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8855 @end lisp
8856
8857
8858 @node Servers and Methods
8859 @subsection Servers and Methods
8860
8861 Wherever you would normally use a select method
8862 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8863 when browsing a foreign server) you can use a virtual server name
8864 instead.  This could potentially save lots of typing.  And it's nice all
8865 over.
8866
8867
8868 @node Unavailable Servers
8869 @subsection Unavailable Servers
8870
8871 If a server seems to be unreachable, Gnus will mark that server as
8872 @code{denied}.  That means that any subsequent attempt to make contact
8873 with that server will just be ignored.  ``It can't be opened,'' Gnus
8874 will tell you, without making the least effort to see whether that is
8875 actually the case or not.
8876
8877 That might seem quite naughty, but it does make sense most of the time.
8878 Let's say you have 10 groups subscribed to on server
8879 @samp{nephelococcygia.com}.  This server is located somewhere quite far
8880 away from you and the machine is quite slow, so it takes 1 minute just
8881 to find out that it refuses connection to you today.  If Gnus were to
8882 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8883 attempt to do that.  Once it has gotten a single ``connection refused'',
8884 it will regard that server as ``down''.
8885
8886 So, what happens if the machine was only feeling unwell temporarily?
8887 How do you test to see whether the machine has come up again?
8888
8889 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8890 with the following commands:
8891
8892 @table @kbd
8893
8894 @item O
8895 @kindex O (Server)
8896 @findex gnus-server-open-server
8897 Try to establish connection to the server on the current line
8898 (@code{gnus-server-open-server}).
8899
8900 @item C
8901 @kindex C (Server)
8902 @findex gnus-server-close-server
8903 Close the connection (if any) to the server
8904 (@code{gnus-server-close-server}).
8905
8906 @item D
8907 @kindex D (Server)
8908 @findex gnus-server-deny-server
8909 Mark the current server as unreachable
8910 (@code{gnus-server-deny-server}).
8911
8912 @item M-o
8913 @kindex M-o (Server)
8914 @findex gnus-server-open-all-servers
8915 Open the connections to all servers in the buffer
8916 (@code{gnus-server-open-all-servers}).
8917
8918 @item M-c
8919 @kindex M-c (Server)
8920 @findex gnus-server-close-all-servers
8921 Close the connections to all servers in the buffer
8922 (@code{gnus-server-close-all-servers}).
8923
8924 @item R
8925 @kindex R (Server)
8926 @findex gnus-server-remove-denials
8927 Remove all marks to whether Gnus was denied connection from any servers
8928 (@code{gnus-server-remove-denials}).
8929
8930 @end table
8931
8932
8933 @node Getting News
8934 @section Getting News
8935 @cindex reading news
8936 @cindex news backends
8937
8938 A newsreader is normally used for reading news.  Gnus currently provides
8939 only two methods of getting news---it can read from an @sc{nntp} server,
8940 or it can read from a local spool.
8941
8942 @menu
8943 * NNTP::               Reading news from an @sc{nntp} server.
8944 * News Spool::         Reading news from the local spool.
8945 @end menu
8946
8947
8948 @node NNTP
8949 @subsection @sc{nntp}
8950 @cindex nntp
8951
8952 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8953 You just specify @code{nntp} as method and the address of the @sc{nntp}
8954 server as the, uhm, address.
8955
8956 If the @sc{nntp} server is located at a non-standard port, setting the
8957 third element of the select method to this port number should allow you
8958 to connect to the right port.  You'll have to edit the group info for
8959 that (@pxref{Foreign Groups}).
8960
8961 The name of the foreign group can be the same as a native group.  In
8962 fact, you can subscribe to the same group from as many different servers
8963 you feel like.  There will be no name collisions.
8964
8965 The following variables can be used to create a virtual @code{nntp}
8966 server:
8967
8968 @table @code
8969
8970 @item nntp-server-opened-hook
8971 @vindex nntp-server-opened-hook
8972 @cindex @sc{mode reader}
8973 @cindex authinfo
8974 @cindex authentification
8975 @cindex nntp authentification
8976 @findex nntp-send-authinfo
8977 @findex nntp-send-mode-reader
8978 is run after a connection has been made.  It can be used to send
8979 commands to the @sc{nntp} server after it has been contacted.  By
8980 default it sends the command @code{MODE READER} to the server with the
8981 @code{nntp-send-mode-reader} function.  This function should always be
8982 present in this hook.
8983
8984 @item nntp-authinfo-function
8985 @vindex nntp-authinfo-function
8986 @findex nntp-send-authinfo
8987 @vindex nntp-authinfo-file
8988 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8989 server.  The default function is @code{nntp-send-authinfo}, which looks
8990 through your @file{~/.authinfo} (or whatever you've set the
8991 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
8992 are found, it will prompt you for a login name and a password.  The
8993 format of the @file{~/.authinfo} file is (almost) the same as the
8994 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
8995 manual page, but here are the salient facts:
8996
8997 @enumerate
8998 @item
8999 The file contains one or more line, each of which define one server.
9000
9001 @item
9002 Each line may contain an arbitrary number of token/value pairs.  The
9003 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9004 @samp{default} and @samp{force}.  (The latter is not a valid
9005 @file{.netrc}/@code{ftp} token, which is the only way the
9006 @file{.authinfo} file format deviates from the @file{.netrc} file
9007 format.)
9008
9009 @end enumerate
9010
9011 Here's an example file:
9012
9013 @example
9014 machine news.uio.no login larsi password geheimnis
9015 machine nntp.ifi.uio.no login larsi force yes
9016 @end example
9017
9018 The token/value pairs may appear in any order; @samp{machine} doesn't
9019 have to be first, for instance.
9020
9021 In this example, both login name and password have been supplied for the
9022 former server, while the latter has only the login name listed, and the
9023 user will be prompted for the password.  The latter also has the
9024 @samp{force} tag, which means that the authinfo will be sent to the
9025 @var{nntp} server upon connection; the default (i.e., when there is not
9026 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9027 until the @var{nntp} server asks for it.
9028
9029 You can also add @samp{default} lines that will apply to all servers
9030 that don't have matching @samp{machine} lines.
9031
9032 @example
9033 default force yes
9034 @end example
9035
9036 This will force sending @samp{AUTHINFO} commands to all servers not
9037 previously mentioned.
9038
9039 Remember to not leave the @file{~/.authinfo} file world-readable.
9040
9041 @item nntp-server-action-alist
9042 @vindex nntp-server-action-alist
9043 This is a list of regexps to match on server types and actions to be
9044 taken when matches are made.  For instance, if you want Gnus to beep
9045 every time you connect to innd, you could say something like:
9046
9047 @lisp
9048 (setq nntp-server-action-alist
9049       '(("innd" (ding))))
9050 @end lisp
9051
9052 You probably don't want to do that, though.
9053
9054 The default value is
9055
9056 @lisp
9057 '(("nntpd 1\\.5\\.11t"
9058    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9059 @end lisp
9060
9061 This ensures that Gnus doesn't send the @code{MODE READER} command to
9062 nntpd 1.5.11t, since that command chokes that server, I've been told.
9063
9064 @item nntp-maximum-request
9065 @vindex nntp-maximum-request
9066 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9067 will collect headers by sending a series of @code{head} commands.  To
9068 speed things up, the backend sends lots of these commands without
9069 waiting for reply, and then reads all the replies.  This is controlled
9070 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
9071 your network is buggy, you should set this to 1.
9072
9073 @item nntp-connection-timeout
9074 @vindex nntp-connection-timeout
9075 If you have lots of foreign @code{nntp} groups that you connect to
9076 regularly, you're sure to have problems with @sc{nntp} servers not
9077 responding properly, or being too loaded to reply within reasonable
9078 time.  This is can lead to awkward problems, which can be helped
9079 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
9080 that says how many seconds the @code{nntp} backend should wait for a
9081 connection before giving up.  If it is @code{nil}, which is the default,
9082 no timeouts are done.
9083
9084 @c @item nntp-command-timeout
9085 @c @vindex nntp-command-timeout
9086 @c @cindex PPP connections
9087 @c @cindex dynamic IP addresses
9088 @c If you're running Gnus on a machine that has a dynamically assigned
9089 @c address, Gnus may become confused.  If the address of your machine
9090 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9091 @c waiting forever for replies from the server.  To help with this
9092 @c unfortunate problem, you can set this command to a number.  Gnus will
9093 @c then, if it sits waiting for a reply from the server longer than that
9094 @c number of seconds, shut down the connection, start a new one, and resend
9095 @c the command.  This should hopefully be transparent to the user.  A
9096 @c likely number is 30 seconds.
9097 @c
9098 @c @item nntp-retry-on-break
9099 @c @vindex nntp-retry-on-break
9100 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9101 @c hangs.  This will have much the same effect as the command timeout
9102 @c described above.
9103
9104 @item nntp-server-hook
9105 @vindex nntp-server-hook
9106 This hook is run as the last step when connecting to an @sc{nntp}
9107 server.
9108
9109 @findex nntp-open-rlogin
9110 @findex nntp-open-telnet
9111 @findex nntp-open-network-stream
9112 @item nntp-open-connection-function
9113 @vindex nntp-open-connection-function
9114 This function is used to connect to the remote system.  Four pre-made
9115 functions are supplied:
9116
9117 @table @code
9118 @item nntp-open-network-stream
9119 This is the default, and simply connects to some port or other on the
9120 remote system.
9121
9122 @item nntp-open-rlogin
9123 Does an @samp{rlogin} on the
9124 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9125 available there.
9126
9127 @code{nntp-open-rlogin}-related variables:
9128
9129 @table @code
9130
9131 @item nntp-rlogin-program
9132 @vindex nntp-rlogin-program
9133 Program used to log in on remote machines.  The default is @samp{rsh},
9134 but @samp{ssh} is a popular alternative.
9135
9136 @item nntp-rlogin-parameters
9137 @vindex nntp-rlogin-parameters
9138 This list will be used as the parameter list given to @code{rsh}.
9139
9140 @item nntp-rlogin-user-name
9141 @vindex nntp-rlogin-user-name
9142 User name on the remote system.
9143
9144 @end table
9145
9146 @item nntp-open-telnet
9147 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9148 to get to the @sc{nntp} server.
9149
9150 @code{nntp-open-telnet}-related variables:
9151
9152 @table @code
9153 @item nntp-telnet-command
9154 @vindex nntp-telnet-command
9155 Command used to start @code{telnet}.
9156
9157 @item nntp-telnet-switches
9158 @vindex nntp-telnet-switches
9159 List of strings to be used as the switches to the @code{telnet} command.
9160
9161 @item nntp-telnet-user-name
9162 @vindex nntp-telnet-user-name
9163 User name for log in on the remote system.
9164
9165 @item nntp-telnet-passwd
9166 @vindex nntp-telnet-passwd
9167 Password to use when logging in.
9168
9169 @item nntp-telnet-parameters
9170 @vindex nntp-telnet-parameters
9171 A list of strings executed as a command after logging in
9172 via @code{telnet}.
9173
9174 @item nntp-telnet-shell-prompt
9175 @vindex nntp-telnet-shell-prompt
9176 Regexp matching the shell prompt on the remote machine.  The default is
9177 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9178
9179 @item nntp-open-telnet-envuser
9180 @vindex nntp-open-telnet-envuser
9181 If non-@code{nil}, the @code{telnet} session (client and server both)
9182 will support the @code{ENVIRON} option and not prompt for login name.
9183 This works for Solaris @code{telnet}, for instance.
9184
9185 @end table
9186
9187 @findex nntp-open-ssl-stream
9188 @item nntp-open-ssl-stream
9189 Opens a connection to a server over a @dfn{secure} channel.  To use this
9190 you must have SSLay installed
9191 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9192 @file{ssl.el} (from the W3 distributeion, for instance).  You then
9193 define a server as follows:
9194
9195 @lisp
9196 ;; Type `C-c C-c' after you've finished editing.
9197 ;;
9198 ;; "snews" is port 563 and is predefined in our /etc/services
9199 ;;
9200 (nntp "snews.bar.com"
9201       (nntp-open-connection-function nntp-open-ssl-stream)
9202       (nntp-port-number "snews")
9203       (nntp-address "snews.bar.com"))
9204 @end lisp
9205
9206 @end table
9207
9208 @item nntp-end-of-line
9209 @vindex nntp-end-of-line
9210 String to use as end-of-line marker when talking to the @sc{nntp}
9211 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9212 using @code{rlogin} to talk to the server.
9213
9214 @item nntp-rlogin-user-name
9215 @vindex nntp-rlogin-user-name
9216 User name on the remote system when using the @code{rlogin} connect
9217 function.
9218
9219 @item nntp-address
9220 @vindex nntp-address
9221 The address of the remote system running the @sc{nntp} server.
9222
9223 @item nntp-port-number
9224 @vindex nntp-port-number
9225 Port number to connect to when using the @code{nntp-open-network-stream}
9226 connect function.
9227
9228 @item nntp-buggy-select
9229 @vindex nntp-buggy-select
9230 Set this to non-@code{nil} if your select routine is buggy.
9231
9232 @item nntp-nov-is-evil
9233 @vindex nntp-nov-is-evil
9234 If the @sc{nntp} server does not support @sc{nov}, you could set this
9235 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9236 can be used.
9237
9238 @item nntp-xover-commands
9239 @vindex nntp-xover-commands
9240 @cindex nov
9241 @cindex XOVER
9242 List of strings used as commands to fetch @sc{nov} lines from a
9243 server.  The default value of this variable is @code{("XOVER"
9244 "XOVERVIEW")}.
9245
9246 @item nntp-nov-gap
9247 @vindex nntp-nov-gap
9248 @code{nntp} normally sends just one big request for @sc{nov} lines to
9249 the server.  The server responds with one huge list of lines.  However,
9250 if you have read articles 2-5000 in the group, and only want to read
9251 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9252 lines that you will not need.  This variable says how
9253 big a gap between two consecutive articles is allowed to be before the
9254 @code{XOVER} request is split into several request.  Note that if your
9255 network is fast, setting this variable to a really small number means
9256 that fetching will probably be slower.  If this variable is @code{nil},
9257 @code{nntp} will never split requests.  The default is 5.
9258
9259 @item nntp-prepare-server-hook
9260 @vindex nntp-prepare-server-hook
9261 A hook run before attempting to connect to an @sc{nntp} server.
9262
9263 @item nntp-warn-about-losing-connection
9264 @vindex nntp-warn-about-losing-connection
9265 If this variable is non-@code{nil}, some noise will be made when a
9266 server closes connection.
9267
9268 @item nntp-record-commands
9269 @vindex nntp-record-commands
9270 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9271 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9272 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
9273 that doesn't seem to work.
9274
9275 @end table
9276
9277
9278 @node News Spool
9279 @subsection News Spool
9280 @cindex nnspool
9281 @cindex news spool
9282
9283 Subscribing to a foreign group from the local spool is extremely easy,
9284 and might be useful, for instance, to speed up reading groups that
9285 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9286 instance.
9287
9288 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9289 anything else) as the address.
9290
9291 If you have access to a local spool, you should probably use that as the
9292 native select method (@pxref{Finding the News}).  It is normally faster
9293 than using an @code{nntp} select method, but might not be.  It depends.
9294 You just have to try to find out what's best at your site.
9295
9296 @table @code
9297
9298 @item nnspool-inews-program
9299 @vindex nnspool-inews-program
9300 Program used to post an article.
9301
9302 @item nnspool-inews-switches
9303 @vindex nnspool-inews-switches
9304 Parameters given to the inews program when posting an article.
9305
9306 @item nnspool-spool-directory
9307 @vindex nnspool-spool-directory
9308 Where @code{nnspool} looks for the articles.  This is normally
9309 @file{/usr/spool/news/}.
9310
9311 @item nnspool-nov-directory
9312 @vindex nnspool-nov-directory
9313 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9314 @file{/usr/spool/news/over.view/}.
9315
9316 @item nnspool-lib-dir
9317 @vindex nnspool-lib-dir
9318 Where the news lib dir is (@file{/usr/lib/news/} by default).
9319
9320 @item nnspool-active-file
9321 @vindex nnspool-active-file
9322 The path to the active file.
9323
9324 @item nnspool-newsgroups-file
9325 @vindex nnspool-newsgroups-file
9326 The path to the group descriptions file.
9327
9328 @item nnspool-history-file
9329 @vindex nnspool-history-file
9330 The path to the news history file.
9331
9332 @item nnspool-active-times-file
9333 @vindex nnspool-active-times-file
9334 The path to the active date file.
9335
9336 @item nnspool-nov-is-evil
9337 @vindex nnspool-nov-is-evil
9338 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9339 that it finds.
9340
9341 @item nnspool-sift-nov-with-sed
9342 @vindex nnspool-sift-nov-with-sed
9343 @cindex sed
9344 If non-@code{nil}, which is the default, use @code{sed} to get the
9345 relevant portion from the overview file.  If nil, @code{nnspool} will
9346 load the entire file into a buffer and process it there.
9347
9348 @end table
9349
9350
9351 @node Getting Mail
9352 @section Getting Mail
9353 @cindex reading mail
9354 @cindex mail
9355
9356 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9357 course.
9358
9359 @menu
9360 * Getting Started Reading Mail:: A simple cookbook example.
9361 * Splitting Mail::               How to create mail groups.
9362 * Mail Backend Variables::       Variables for customizing mail handling.
9363 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9364 * Mail and Procmail::            Reading mail groups that procmail create.
9365 * Incorporating Old Mail::       What about the old mail you have?
9366 * Expiring Mail::                Getting rid of unwanted mail.
9367 * Washing Mail::                 Removing gruft from the mail you get.
9368 * Duplicates::                   Dealing with duplicated mail.
9369 * Not Reading Mail::             Using mail backends for reading other files.
9370 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9371 @end menu
9372
9373
9374 @node Getting Started Reading Mail
9375 @subsection Getting Started Reading Mail
9376
9377 It's quite easy to use Gnus to read your new mail.  You just plonk the
9378 mail backend of your choice into @code{gnus-secondary-select-methods},
9379 and things will happen automatically.
9380
9381 For instance, if you want to use @code{nnml} (which is a "one file per
9382 mail" backend), you could put the following in your @file{.gnus} file:
9383
9384 @lisp
9385 (setq gnus-secondary-select-methods
9386       '((nnml "private")))
9387 @end lisp
9388
9389 Now, the next time you start Gnus, this backend will be queried for new
9390 articles, and it will move all the messages in your spool file to its
9391 directory, which is @code{~/Mail/} by default.  The new group that will
9392 be created (@samp{mail.misc}) will be subscribed, and you can read it
9393 like any other group.
9394
9395 You will probably want to split the mail into several groups, though:
9396
9397 @lisp
9398 (setq nnmail-split-methods
9399       '(("junk" "^From:.*Lars Ingebrigtsen")
9400         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9401         ("other" "")))
9402 @end lisp
9403
9404 This will result in three new @code{nnml} mail groups being created:
9405 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
9406 mail that doesn't fit into the first two groups will be placed in the
9407 last group.
9408
9409 This should be sufficient for reading mail with Gnus.  You might want to
9410 give the other sections in this part of the manual a perusal, though.
9411 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9412
9413
9414 @node Splitting Mail
9415 @subsection Splitting Mail
9416 @cindex splitting mail
9417 @cindex mail splitting
9418
9419 @vindex nnmail-split-methods
9420 The @code{nnmail-split-methods} variable says how the incoming mail is
9421 to be split into groups.
9422
9423 @lisp
9424 (setq nnmail-split-methods
9425   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9426     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9427     ("mail.other" "")))
9428 @end lisp
9429
9430 This variable is a list of lists, where the first element of each of
9431 these lists is the name of the mail group (they do not have to be called
9432 something beginning with @samp{mail}, by the way), and the second
9433 element is a regular expression used on the header of each mail to
9434 determine if it belongs in this mail group.  The first string may
9435 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9436 insert sub-expressions from the matched text.  For instance:
9437
9438 @lisp
9439 ("list.\\1" "From:.*\\(.*\\)-list@@majordomo.com")
9440 @end lisp
9441
9442 The second element can also be a function.  In that case, it will be
9443 called narrowed to the headers with the first element of the rule as the
9444 argument.  It should return a non-@code{nil} value if it thinks that the
9445 mail belongs in that group.
9446
9447 The last of these groups should always be a general one, and the regular
9448 expression should @emph{always} be @samp{} so that it matches any mails
9449 that haven't been matched by any of the other regexps.  (These rules are
9450 processed from the beginning of the alist toward the end.  The first
9451 rule to make a match will "win", unless you have crossposting enabled.
9452 In that case, all matching rules will "win".)
9453
9454 If you like to tinker with this yourself, you can set this variable to a
9455 function of your choice.  This function will be called without any
9456 arguments in a buffer narrowed to the headers of an incoming mail
9457 message.  The function should return a list of group names that it
9458 thinks should carry this mail message.
9459
9460 Note that the mail backends are free to maul the poor, innocent,
9461 incoming headers all they want to.  They all add @code{Lines} headers;
9462 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9463 @code{From<SPACE>} line to something else.
9464
9465 @vindex nnmail-crosspost
9466 The mail backends all support cross-posting.  If several regexps match,
9467 the mail will be ``cross-posted'' to all those groups.
9468 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
9469 that no articles are crossposted to the general (@samp{}) group.
9470
9471 @vindex nnmail-crosspost-link-function
9472 @cindex crosspost
9473 @cindex links
9474 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9475 the crossposted articles.  However, not all file systems support hard
9476 links.  If that's the case for you, set
9477 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
9478 variable is @code{add-name-to-file} by default.)
9479
9480 @kindex M-x nnmail-split-history
9481 @kindex nnmail-split-history
9482 If you wish to see where the previous mail split put the messages, you
9483 can use the @kbd{M-x nnmail-split-history} command.
9484
9485 Gnus gives you all the opportunity you could possibly want for shooting
9486 yourself in the foot.  Let's say you create a group that will contain
9487 all the mail you get from your boss.  And then you accidentally
9488 unsubscribe from the group.  Gnus will still put all the mail from your
9489 boss in the unsubscribed group, and so, when your boss mails you ``Have
9490 that report ready by Monday or you're fired!'', you'll never see it and,
9491 come Tuesday, you'll still believe that you're gainfully employed while
9492 you really should be out collecting empty bottles to save up for next
9493 month's rent money.
9494
9495
9496 @node Mail Backend Variables
9497 @subsection Mail Backend Variables
9498
9499 These variables are (for the most part) pertinent to all the various
9500 mail backends.
9501
9502 @table @code
9503 @vindex nnmail-read-incoming-hook
9504 @item nnmail-read-incoming-hook
9505 The mail backends all call this hook after reading new mail.  You can
9506 use this hook to notify any mail watch programs, if you want to.
9507
9508 @vindex nnmail-spool-file
9509 @item nnmail-spool-file
9510 @cindex POP mail
9511 @cindex MAILHOST
9512 @cindex movemail
9513 @vindex nnmail-pop-password
9514 @vindex nnmail-pop-password-required
9515 The backends will look for new mail in this file.  If this variable is
9516 @code{nil}, the mail backends will never attempt to fetch mail by
9517 themselves.  If you are using a POP mail server and your name is
9518 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
9519 your name is not @samp{larsi}, you should probably modify that
9520 slightly, but you may have guessed that already, you smart & handsome
9521 devil!  You can also set this variable to @code{pop}, and Gnus will try
9522 to figure out the POP mail string by itself.  In any case, Gnus will
9523 call @code{movemail} which will contact the POP server named in the
9524 @code{MAILHOST} environment variable.  If the POP server needs a
9525 password, you can either set @code{nnmail-pop-password-required} to
9526 @code{t} and be prompted for the password, or set
9527 @code{nnmail-pop-password} to the password itself.
9528
9529 @code{nnmail-spool-file} can also be a list of mailboxes.
9530
9531 Your Emacs has to have been configured with @samp{--with-pop} before
9532 compilation.  This is the default, but some installations have it
9533 switched off.
9534
9535 When you use a mail backend, Gnus will slurp all your mail from your
9536 inbox and plonk it down in your home directory.  Gnus doesn't move any
9537 mail if you're not using a mail backend---you have to do a lot of magic
9538 invocations first.  At the time when you have finished drawing the
9539 pentagram, lightened the candles, and sacrificed the goat, you really
9540 shouldn't be too surprised when Gnus moves your mail.
9541
9542 @vindex nnmail-use-procmail
9543 @vindex nnmail-procmail-suffix
9544 @item nnmail-use-procmail
9545 If non-@code{nil}, the mail backends will look in
9546 @code{nnmail-procmail-directory} for incoming mail.  All the files in
9547 that directory that have names ending in @code{nnmail-procmail-suffix}
9548 will be considered incoming mailboxes, and will be searched for new
9549 mail.
9550
9551 @vindex nnmail-crash-box
9552 @item nnmail-crash-box
9553 When a mail backend reads a spool file, mail is first moved to this
9554 file, which is @file{~/.gnus-crash-box} by default.  If this file
9555 already exists, it will always be read (and incorporated) before any
9556 other spool files.
9557
9558 @vindex nnmail-prepare-incoming-hook
9559 @item nnmail-prepare-incoming-hook
9560 This is run in a buffer that holds all the new incoming mail, and can be
9561 used for, well, anything, really.
9562
9563 @vindex nnmail-split-hook
9564 @item nnmail-split-hook
9565 @findex article-decode-rfc1522
9566 @findex RFC1522 decoding
9567 Hook run in the buffer where the mail headers of each message is kept
9568 just before the splitting based on these headers is done.  The hook is
9569 free to modify the buffer contents in any way it sees fit---the buffer
9570 is discarded after the splitting has been done, and no changes performed
9571 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
9572 is one likely function to add to this hook.
9573
9574 @vindex nnmail-pre-get-new-mail-hook
9575 @vindex nnmail-post-get-new-mail-hook
9576 @item nnmail-pre-get-new-mail-hook
9577 @itemx nnmail-post-get-new-mail-hook
9578 These are two useful hooks executed when treating new incoming
9579 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9580 starting to handle the new mail) and
9581 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9582 is done).  Here's and example of using these two hooks to change the
9583 default file modes the new mail files get:
9584
9585 @lisp
9586 (add-hook 'gnus-pre-get-new-mail-hook
9587           (lambda () (set-default-file-modes 511)))
9588
9589 (add-hook 'gnus-post-get-new-mail-hook
9590           (lambda () (set-default-file-modes 551)))
9591 @end lisp
9592
9593 @item nnmail-tmp-directory
9594 @vindex nnmail-tmp-directory
9595 This variable says where to move incoming mail to -- while processing
9596 it.  This is usually done in the same directory that the mail backend
9597 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9598 it will be used instead.
9599
9600 @item nnmail-movemail-program
9601 @vindex nnmail-movemail-program
9602 This program is executed to move mail from the user's inbox to her home
9603 directory.  The default is @samp{movemail}.
9604
9605 This can also be a function.  In that case, the function will be called
9606 with two parameters -- the name of the inbox, and the file to be moved
9607 to.
9608
9609 @item nnmail-delete-incoming
9610 @vindex nnmail-delete-incoming
9611 @cindex incoming mail files
9612 @cindex deleting incoming files
9613 If non-@code{nil}, the mail backends will delete the temporary incoming
9614 file after splitting mail into the proper groups.  This is @code{t} by
9615 default.
9616
9617 @c This is @code{nil} by
9618 @c default for reasons of security.
9619
9620 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9621 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9622 lost mail, I think, but that's not the point.  (Except certain versions
9623 of Red Gnus.))  By not deleting the Incoming* files, one can be sure not
9624 to lose mail -- if Gnus totally whacks out, one can always recover what
9625 was lost.
9626
9627 You may delete the @file{Incoming*} files at will.
9628
9629 @item nnmail-use-long-file-names
9630 @vindex nnmail-use-long-file-names
9631 If non-@code{nil}, the mail backends will use long file and directory
9632 names.  Groups like @samp{mail.misc} will end up in directories
9633 (assuming use of @code{nnml} backend) or files (assuming use of
9634 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
9635 the same group will end up in @file{mail/misc}.
9636
9637 @item nnmail-delete-file-function
9638 @vindex nnmail-delete-file-function
9639 @findex delete-file
9640 Function called to delete files.  It is @code{delete-file} by default.
9641
9642 @item nnmail-cache-accepted-message-ids
9643 @vindex nnmail-cache-accepted-message-ids
9644 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9645 the backend (via @code{Gcc}, for instance) into the mail duplication
9646 discovery cache.  The default is @code{nil}.
9647
9648 @end table
9649
9650
9651 @node Fancy Mail Splitting
9652 @subsection Fancy Mail Splitting
9653 @cindex mail splitting
9654 @cindex fancy mail splitting
9655
9656 @vindex nnmail-split-fancy
9657 @findex nnmail-split-fancy
9658 If the rather simple, standard method for specifying how to split mail
9659 doesn't allow you to do what you want, you can set
9660 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
9661 play with the @code{nnmail-split-fancy} variable.
9662
9663 Let's look at an example value of this variable first:
9664
9665 @lisp
9666 ;; Messages from the mailer daemon are not crossposted to any of
9667 ;; the ordinary groups.  Warnings are put in a separate group
9668 ;; from real errors.
9669 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9670                    "mail.misc"))
9671    ;; Non-error messages are crossposted to all relevant
9672    ;; groups, but we don't crosspost between the group for the
9673    ;; (ding) list and the group for other (ding) related mail.
9674    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9675          ("subject" "ding" "ding.misc"))
9676       ;; Other mailing lists...
9677       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9678       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9679       ;; People...
9680       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9681    ;; Unmatched mail goes to the catch all group.
9682    "misc.misc")
9683 @end lisp
9684
9685 This variable has the format of a @dfn{split}.  A split is a (possibly)
9686 recursive structure where each split may contain other splits.  Here are
9687 the five possible split syntaxes:
9688
9689 @enumerate
9690
9691 @item
9692 @samp{group}: If the split is a string, that will be taken as a group
9693 name.  Normal regexp match expansion will be done.  See below for
9694 examples. 
9695
9696 @item
9697 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
9698 which is a string, then store the message as specified by SPLIT, if
9699 header FIELD (a regexp) contains VALUE (also a regexp).
9700
9701 @item
9702 @var{(| SPLIT...)}: If the split is a list, and the first element is
9703 @code{|} (vertical bar), then process each SPLIT until one of them
9704 matches.  A SPLIT is said to match if it will cause the mail message to
9705 be stored in one or more groups.
9706
9707 @item
9708 @var{(& SPLIT...)}: If the split is a list, and the first element is
9709 @code{&}, then process all SPLITs in the list.
9710
9711 @item
9712 @code{junk}: If the split is the symbol @code{junk}, then don't save
9713 this message. Use with extreme caution.
9714
9715 @item
9716 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
9717 element is @code{:}, then the second element will be called as a
9718 function with @var{args} given as arguments.  The function should return
9719 a SPLIT.
9720
9721 @item
9722 @code{nil}: If the split is @code{nil}, it is ignored.
9723
9724 @end enumerate
9725
9726 In these splits, @var{FIELD} must match a complete field name.
9727 @var{VALUE} must match a complete word according to the fundamental mode
9728 syntax table.  You can use @code{.*} in the regexps to match partial
9729 field names or words.  In other words, all @var{VALUE}'s are wrapped in
9730 @samp{\<} and @samp{\>} pairs.
9731
9732 @vindex nnmail-split-abbrev-alist
9733 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9734 are expanded as specified by the variable
9735 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
9736 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
9737 value.
9738
9739 @vindex nnmail-split-fancy-syntax-table
9740 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9741 when all this splitting is performed.
9742
9743 If you want to have Gnus create groups dynamically based on some
9744 information in the headers (i.e., do @code{replace-match}-like
9745 substitutions in the group names), you can say things like:
9746
9747 @example
9748 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
9749 @end example
9750
9751 If the string contains the element @samp{\&}, then the previously
9752 matched string will be substituted.  Similarly, the elements @samp{\\1}
9753 up to @samp{\\9} will be substituted with the text matched by the
9754 groupings 1 through 9.
9755
9756
9757 @node Mail and Procmail
9758 @subsection Mail and Procmail
9759 @cindex procmail
9760
9761 @cindex slocal
9762 @cindex elm
9763 Many people use @code{procmail} (or some other mail filter program or
9764 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9765 incoming mail into groups.  If you do that, you should set
9766 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9767 backends never ever try to fetch mail by themselves.
9768
9769 If you have a combined @code{procmail}/POP/mailbox setup, you can do
9770 something like the following:
9771
9772 @vindex nnmail-use-procmail
9773 @lisp
9774 (setq nnmail-use-procmail t)
9775 (setq nnmail-spool-file
9776       '("/usr/spool/mail/my-name" "po:my-name"))
9777 @end lisp
9778
9779 This also means that you probably don't want to set
9780 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9781 side effects.
9782
9783 When a mail backend is queried for what groups it carries, it replies
9784 with the contents of that variable, along with any groups it has figured
9785 out that it carries by other means.  None of the backends, except
9786 @code{nnmh}, actually go out to the disk and check what groups actually
9787 exist.  (It's not trivial to distinguish between what the user thinks is
9788 a basis for a newsgroup and what is just a plain old file or directory.)
9789
9790 This means that you have to tell Gnus (and the backends) by hand what
9791 groups exist.
9792
9793 Let's take the @code{nnmh} backend as an example:
9794
9795 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9796 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9797
9798 Go to the group buffer and type @kbd{G m}.  When prompted, answer
9799 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
9800 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
9801 to include all your mail groups.
9802
9803 That's it.  You are now set to read your mail.  An active file for this
9804 method will be created automatically.
9805
9806 @vindex nnmail-procmail-suffix
9807 @vindex nnmail-procmail-directory
9808 If you use @code{nnfolder} or any other backend that store more than a
9809 single article in each file, you should never have procmail add mails to
9810 the file that Gnus sees.  Instead, procmail should put all incoming mail
9811 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9812 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9813 name.  The mail backends will read the mail from these files.
9814
9815 @vindex nnmail-resplit-incoming
9816 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9817 put in the @code{mail.misc}, as one would expect.  However, if you want
9818 Gnus to split the mail the normal way, you could set
9819 @code{nnmail-resplit-incoming} to @code{t}.
9820
9821 @vindex nnmail-keep-last-article
9822 If you use @code{procmail} to split things directly into an @code{nnmh}
9823 directory (which you shouldn't do), you should set
9824 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9825 ever expiring the final article (i.e., the article with the highest
9826 article number) in a mail newsgroup.  This is quite, quite important.
9827
9828 Here's an example setup:  The incoming spools are located in
9829 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9830 spool files have the same names as the equivalent groups).  The
9831 @code{nnfolder} backend is to be used as the mail interface, and the
9832 @code{nnfolder} directory is @file{~/fMail/}.
9833
9834 @lisp
9835 (setq nnfolder-directory "~/fMail/")
9836 (setq nnmail-spool-file 'procmail)
9837 (setq nnmail-procmail-directory "~/incoming/")
9838 (setq gnus-secondary-select-methods '((nnfolder "")))
9839 (setq nnmail-procmail-suffix "")
9840 @end lisp
9841
9842
9843 @node Incorporating Old Mail
9844 @subsection Incorporating Old Mail
9845
9846 Most people have lots of old mail stored in various file formats.  If
9847 you have set up Gnus to read mail using one of the spiffy Gnus mail
9848 backends, you'll probably wish to have that old mail incorporated into
9849 your mail groups.
9850
9851 Doing so can be quite easy.
9852
9853 To take an example: You're reading mail using @code{nnml}
9854 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9855 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9856 file filled with important, but old, mail.  You want to move it into
9857 your @code{nnml} groups.
9858
9859 Here's how:
9860
9861 @enumerate
9862 @item
9863 Go to the group buffer.
9864
9865 @item
9866 Type `G f' and give the path to the mbox file when prompted to create an
9867 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9868
9869 @item
9870 Type `SPACE' to enter the newly created group.
9871
9872 @item
9873 Type `M P b' to process-mark all articles in this group's buffer
9874 (@pxref{Setting Process Marks}).
9875
9876 @item
9877 Type `B r' to respool all the process-marked articles, and answer
9878 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9879 @end enumerate
9880
9881 All the mail messages in the mbox file will now also be spread out over
9882 all your @code{nnml} groups.  Try entering them and check whether things
9883 have gone without a glitch.  If things look ok, you may consider
9884 deleting the mbox file, but I wouldn't do that unless I was absolutely
9885 sure that all the mail has ended up where it should be.
9886
9887 Respooling is also a handy thing to do if you're switching from one mail
9888 backend to another.  Just respool all the mail in the old mail groups
9889 using the new mail backend.
9890
9891
9892 @node Expiring Mail
9893 @subsection Expiring Mail
9894 @cindex article expiry
9895
9896 Traditional mail readers have a tendency to remove mail articles when
9897 you mark them as read, in some way.  Gnus takes a fundamentally
9898 different approach to mail reading.
9899
9900 Gnus basically considers mail just to be news that has been received in
9901 a rather peculiar manner.  It does not think that it has the power to
9902 actually change the mail, or delete any mail messages.  If you enter a
9903 mail group, and mark articles as ``read'', or kill them in some other
9904 fashion, the mail articles will still exist on the system.  I repeat:
9905 Gnus will not delete your old, read mail.  Unless you ask it to, of
9906 course.
9907
9908 To make Gnus get rid of your unwanted mail, you have to mark the
9909 articles as @dfn{expirable}.  This does not mean that the articles will
9910 disappear right away, however.  In general, a mail article will be
9911 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9912 more than one week old.  If you do not mark an article as expirable, it
9913 will remain on your system until hell freezes over.  This bears
9914 repeating one more time, with some spurious capitalizations: IF you do
9915 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9916
9917 @vindex gnus-auto-expirable-newsgroups
9918 You do not have to mark articles as expirable by hand.  Groups that
9919 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9920 have all articles that you read marked as expirable automatically.  All
9921 articles marked as expirable have an @samp{E} in the first
9922 column in the summary buffer.
9923
9924 By default, if you have auto expiry switched on, Gnus will mark all the
9925 articles you read as expirable, no matter if they were read or unread
9926 before.  To avoid having articles marked as read marked as expirable
9927 automatically, you can put something like the following in your
9928 @file{.gnus} file:
9929
9930 @vindex gnus-mark-article-hook
9931 @lisp
9932 (remove-hook 'gnus-mark-article-hook
9933              'gnus-summary-mark-read-and-unread-as-read)
9934 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9935 @end lisp
9936
9937 Note that making a group auto-expirable doesn't mean that all read
9938 articles are expired---only the articles marked as expirable
9939 will be expired.  Also note that using the @kbd{d} command won't make
9940 groups expirable---only semi-automatic marking of articles as read will
9941 mark the articles as expirable in auto-expirable groups.
9942
9943 Let's say you subscribe to a couple of mailing lists, and you want the
9944 articles you have read to disappear after a while:
9945
9946 @lisp
9947 (setq gnus-auto-expirable-newsgroups
9948       "mail.nonsense-list\\|mail.nice-list")
9949 @end lisp
9950
9951 Another way to have auto-expiry happen is to have the element
9952 @code{auto-expire} in the group parameters of the group.
9953
9954 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9955 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9956 don't really mix very well.
9957
9958 @vindex nnmail-expiry-wait
9959 The @code{nnmail-expiry-wait} variable supplies the default time an
9960 expirable article has to live.  Gnus starts counting days from when the
9961 message @emph{arrived}, not from when it was sent.  The default is seven
9962 days.
9963
9964 Gnus also supplies a function that lets you fine-tune how long articles
9965 are to live, based on what group they are in.  Let's say you want to
9966 have one month expiry period in the @samp{mail.private} group, a one day
9967 expiry period in the @samp{mail.junk} group, and a six day expiry period
9968 everywhere else:
9969
9970 @vindex nnmail-expiry-wait-function
9971 @lisp
9972 (setq nnmail-expiry-wait-function
9973       (lambda (group)
9974        (cond ((string= group "mail.private")
9975                31)
9976              ((string= group "mail.junk")
9977                1)
9978              ((string= group "important")
9979                'never)
9980              (t
9981                6))))
9982 @end lisp
9983
9984 The group names this function is fed are ``unadorned'' group
9985 names---no @samp{nnml:} prefixes and the like.
9986
9987 The @code{nnmail-expiry-wait} variable and
9988 @code{nnmail-expiry-wait-function} function can either be a number (not
9989 necessarily an integer) or one of the symbols @code{immediate} or
9990 @code{never}.
9991
9992 You can also use the @code{expiry-wait} group parameter to selectively
9993 change the expiry period (@pxref{Group Parameters}).
9994
9995 @vindex nnmail-keep-last-article
9996 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9997 expire the final article in a mail newsgroup.  This is to make life
9998 easier for procmail users.
9999
10000 @vindex gnus-total-expirable-newsgroups
10001 By the way: That line up there, about Gnus never expiring non-expirable
10002 articles, is a lie.  If you put @code{total-expire} in the group
10003 parameters, articles will not be marked as expirable, but all read
10004 articles will be put through the expiry process.  Use with extreme
10005 caution.  Even more dangerous is the
10006 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
10007 this regexp will have all read articles put through the expiry process,
10008 which means that @emph{all} old mail articles in the groups in question
10009 will be deleted after a while.  Use with extreme caution, and don't come
10010 crying to me when you discover that the regexp you used matched the
10011 wrong group and all your important mail has disappeared.  Be a
10012 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
10013 with!  So there!
10014
10015 Most people make most of their mail groups total-expirable, though.
10016
10017
10018 @node Washing Mail
10019 @subsection Washing Mail
10020 @cindex mail washing
10021 @cindex list server brain damage
10022 @cindex incoming mail treatment
10023
10024 Mailers and list servers are notorious for doing all sorts of really,
10025 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
10026 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10027 end of all lines passing through our server, so let's do that!!!!1!''
10028 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
10029 considered to be self-evident were not discussed.  So.  Here we are.
10030
10031 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
10032 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
10033 be shocked and dismayed by this, but I haven't got the energy.  It is to
10034 laugh.
10035
10036 Gnus provides a plethora of functions for washing articles while
10037 displaying them, but it might be nicer to do the filtering before
10038 storing the mail to disc.  For that purpose, we have three hooks and
10039 various functions that can be put in these hooks.
10040
10041 @table @code
10042 @item nnmail-prepare-incoming-hook
10043 @vindex nnmail-prepare-incoming-hook
10044 This hook is called before doing anything with the mail and is meant for
10045 grand, sweeping gestures.  Functions to be used include:
10046
10047 @table @code
10048 @item nnheader-ms-strip-cr
10049 @findex nnheader-ms-strip-cr
10050 Remove trailing carriage returns from each line.  This is default on
10051 Emacs running on MS machines.
10052
10053 @end table
10054
10055 @item nnmail-prepare-incoming-header-hook
10056 @vindex nnmail-prepare-incoming-header-hook
10057 This hook is called narrowed to each header.  It can be used when
10058 cleaning up the headers.  Functions that can be used include:
10059
10060 @table @code
10061 @item nnmail-remove-leading-whitespace
10062 @findex nnmail-remove-leading-whitespace
10063 Clear leading white space that ``helpful'' listservs have added to the
10064 headers to make them look nice.  Aaah.
10065
10066 @item nnmail-remove-list-identifiers
10067 @findex nnmail-remove-list-identifiers
10068 Some list servers add an identifier---for example, @samp{(idm)}---to the
10069 beginning of all @code{Subject} headers.  I'm sure that's nice for
10070 people who use stone age mail readers.  This function will remove
10071 strings that match the @code{nnmail-list-identifiers} regexp, which can
10072 also be a list of regexp.
10073
10074 For instance, if you want to remove the @samp{(idm)} and the
10075 @samp{nagnagnag} identifiers:
10076
10077 @lisp
10078 (setq nnmail-list-identifiers
10079       '("(idm)" "nagnagnag"))
10080 @end lisp
10081
10082 @item nnmail-remove-tabs
10083 @findex nnmail-remove-tabs
10084 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10085
10086 @end table
10087
10088 @item nnmail-prepare-incoming-message-hook
10089 @vindex nnmail-prepare-incoming-message-hook
10090 This hook is called narrowed to each message.  Functions to be used
10091 include:
10092
10093 @table @code
10094 @item article-de-quoted-unreadable
10095 @findex article-de-quoted-unreadable
10096 Decode Quoted Readable encoding.
10097
10098 @end table
10099 @end table
10100
10101
10102 @node Duplicates
10103 @subsection Duplicates
10104
10105 @vindex nnmail-treat-duplicates
10106 @vindex nnmail-message-id-cache-length
10107 @vindex nnmail-message-id-cache-file
10108 @cindex duplicate mails
10109 If you are a member of a couple of mailing lists, you will sometimes
10110 receive two copies of the same mail.  This can be quite annoying, so
10111 @code{nnmail} checks for and treats any duplicates it might find.  To do
10112 this, it keeps a cache of old @code{Message-ID}s---
10113 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10114 default.  The approximate maximum number of @code{Message-ID}s stored
10115 there is controlled by the @code{nnmail-message-id-cache-length}
10116 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10117 stored.) If all this sounds scary to you, you can set
10118 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10119 default), and @code{nnmail} won't delete duplicate mails.  Instead it
10120 will insert a warning into the head of the mail saying that it thinks
10121 that this is a duplicate of a different message.
10122
10123 This variable can also be a function.  If that's the case, the function
10124 will be called from a buffer narrowed to the message in question with
10125 the @code{Message-ID} as a parameter.  The function must return either
10126 @code{nil}, @code{warn}, or @code{delete}.
10127
10128 You can turn this feature off completely by setting the variable to
10129 @code{nil}.
10130
10131 If you want all the duplicate mails to be put into a special
10132 @dfn{duplicates} group, you could do that using the normal mail split
10133 methods:
10134
10135 @lisp
10136 (setq nnmail-split-fancy
10137       '(| ;; Messages duplicates go to a separate group.
10138           ("gnus-warning" "duplication of message" "duplicate")
10139           ;; Message from daemons, postmaster, and the like to another.
10140           (any mail "mail.misc")
10141           ;; Other rules.
10142           [ ... ] ))
10143 @end lisp
10144
10145 Or something like:
10146 @lisp
10147 (setq nnmail-split-methods
10148       '(("duplicates" "^Gnus-Warning:")
10149         ;; Other rules.
10150         [...]))
10151 @end lisp
10152
10153 Here's a neat feature: If you know that the recipient reads her mail
10154 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10155 @code{delete}, you can send her as many insults as you like, just by
10156 using a @code{Message-ID} of a mail that you know that she's already
10157 received.  Think of all the fun!  She'll never see any of it!  Whee!
10158
10159
10160 @node Not Reading Mail
10161 @subsection Not Reading Mail
10162
10163 If you start using any of the mail backends, they have the annoying
10164 habit of assuming that you want to read mail with them.  This might not
10165 be unreasonable, but it might not be what you want.
10166
10167 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
10168 will ever attempt to read incoming mail, which should help.
10169
10170 @vindex nnbabyl-get-new-mail
10171 @vindex nnmbox-get-new-mail
10172 @vindex nnml-get-new-mail
10173 @vindex nnmh-get-new-mail
10174 @vindex nnfolder-get-new-mail
10175 This might be too much, if, for instance, you are reading mail quite
10176 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10177 file you have stashed away with @code{nnbabyl}.  All backends have
10178 variables called backend-@code{get-new-mail}.  If you want to disable
10179 the @code{nnbabyl} mail reading, you edit the virtual server for the
10180 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10181
10182 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10183 narrowed to the article to be saved before saving it when reading
10184 incoming mail.
10185
10186
10187 @node Choosing a Mail Backend
10188 @subsection Choosing a Mail Backend
10189
10190 Gnus will read the mail spool when you activate a mail group.  The mail
10191 file is first copied to your home directory.  What happens after that
10192 depends on what format you want to store your mail in.
10193
10194 @menu
10195 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10196 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10197 * Mail Spool::                  Store your mail in a private spool?
10198 * MH Spool::                    An mhspool-like backend.
10199 * Mail Folders::                Having one file for each group.
10200 @end menu
10201
10202
10203 @node Unix Mail Box
10204 @subsubsection Unix Mail Box
10205 @cindex nnmbox
10206 @cindex unix mail box
10207
10208 @vindex nnmbox-active-file
10209 @vindex nnmbox-mbox-file
10210 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10211 mail.  @code{nnmbox} will add extra headers to each mail article to say
10212 which group it belongs in.
10213
10214 Virtual server settings:
10215
10216 @table @code
10217 @item nnmbox-mbox-file
10218 @vindex nnmbox-mbox-file
10219 The name of the mail box in the user's home directory.
10220
10221 @item nnmbox-active-file
10222 @vindex nnmbox-active-file
10223 The name of the active file for the mail box.
10224
10225 @item nnmbox-get-new-mail
10226 @vindex nnmbox-get-new-mail
10227 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10228 into groups.
10229 @end table
10230
10231
10232 @node Rmail Babyl
10233 @subsubsection Rmail Babyl
10234 @cindex nnbabyl
10235 @cindex rmail mbox
10236
10237 @vindex nnbabyl-active-file
10238 @vindex nnbabyl-mbox-file
10239 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10240 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10241 article to say which group it belongs in.
10242
10243 Virtual server settings:
10244
10245 @table @code
10246 @item nnbabyl-mbox-file
10247 @vindex nnbabyl-mbox-file
10248 The name of the rmail mbox file.
10249
10250 @item nnbabyl-active-file
10251 @vindex nnbabyl-active-file
10252 The name of the active file for the rmail box.
10253
10254 @item nnbabyl-get-new-mail
10255 @vindex nnbabyl-get-new-mail
10256 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
10257 @end table
10258
10259
10260 @node Mail Spool
10261 @subsubsection Mail Spool
10262 @cindex nnml
10263 @cindex mail @sc{nov} spool
10264
10265 The @dfn{nnml} spool mail format isn't compatible with any other known
10266 format.  It should be used with some caution.
10267
10268 @vindex nnml-directory
10269 If you use this backend, Gnus will split all incoming mail into files,
10270 one file for each mail, and put the articles into the corresponding
10271 directories under the directory specified by the @code{nnml-directory}
10272 variable.  The default value is @file{~/Mail/}.
10273
10274 You do not have to create any directories beforehand; Gnus will take
10275 care of all that.
10276
10277 If you have a strict limit as to how many files you are allowed to store
10278 in your account, you should not use this backend.  As each mail gets its
10279 own file, you might very well occupy thousands of inodes within a few
10280 weeks.  If this is no problem for you, and it isn't a problem for you
10281 having your friendly systems administrator walking around, madly,
10282 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10283 know that this is probably the fastest format to use.  You do not have
10284 to trudge through a big mbox file just to read your new mail.
10285
10286 @code{nnml} is probably the slowest backend when it comes to article
10287 splitting.  It has to create lots of files, and it also generates
10288 @sc{nov} databases for the incoming mails.  This makes it the fastest
10289 backend when it comes to reading mail.
10290
10291 Virtual server settings:
10292
10293 @table @code
10294 @item nnml-directory
10295 @vindex nnml-directory
10296 All @code{nnml} directories will be placed under this directory.
10297
10298 @item nnml-active-file
10299 @vindex nnml-active-file
10300 The active file for the @code{nnml} server.
10301
10302 @item nnml-newsgroups-file
10303 @vindex nnml-newsgroups-file
10304 The @code{nnml} group descriptions file.  @xref{Newsgroups File
10305 Format}.
10306
10307 @item nnml-get-new-mail
10308 @vindex nnml-get-new-mail
10309 If non-@code{nil}, @code{nnml} will read incoming mail.
10310
10311 @item nnml-nov-is-evil
10312 @vindex nnml-nov-is-evil
10313 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10314
10315 @item nnml-nov-file-name
10316 @vindex nnml-nov-file-name
10317 The name of the @sc{nov} files.  The default is @file{.overview}.
10318
10319 @item nnml-prepare-save-mail-hook
10320 @vindex nnml-prepare-save-mail-hook
10321 Hook run narrowed to an article before saving.
10322
10323 @end table
10324
10325 @findex nnml-generate-nov-databases
10326 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10327 you can do a complete update by typing @kbd{M-x
10328 nnml-generate-nov-databases}.  This command will trawl through the
10329 entire @code{nnml} hierarchy, looking at each and every article, so it
10330 might take a while to complete.  A better interface to this
10331 functionality can be found in the server buffer (@pxref{Server
10332 Commands}).
10333
10334
10335 @node MH Spool
10336 @subsubsection MH Spool
10337 @cindex nnmh
10338 @cindex mh-e mail spool
10339
10340 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10341 @sc{nov} databases and it doesn't keep an active file.  This makes
10342 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10343 makes it easier to write procmail scripts for.
10344
10345 Virtual server settings:
10346
10347 @table @code
10348 @item nnmh-directory
10349 @vindex nnmh-directory
10350 All @code{nnmh} directories will be located under this directory.
10351
10352 @item nnmh-get-new-mail
10353 @vindex nnmh-get-new-mail
10354 If non-@code{nil}, @code{nnmh} will read incoming mail.
10355
10356 @item nnmh-be-safe
10357 @vindex nnmh-be-safe
10358 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10359 sure that the articles in the folder are actually what Gnus thinks they
10360 are.  It will check date stamps and stat everything in sight, so
10361 setting this to @code{t} will mean a serious slow-down.  If you never
10362 use anything but Gnus to read the @code{nnmh} articles, you do not have
10363 to set this variable to @code{t}.
10364 @end table
10365
10366
10367 @node Mail Folders
10368 @subsubsection Mail Folders
10369 @cindex nnfolder
10370 @cindex mbox folders
10371 @cindex mail folders
10372
10373 @code{nnfolder} is a backend for storing each mail group in a separate
10374 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
10375 will add extra headers to keep track of article numbers and arrival
10376 dates.
10377
10378 Virtual server settings:
10379
10380 @table @code
10381 @item nnfolder-directory
10382 @vindex nnfolder-directory
10383 All the @code{nnfolder} mail boxes will be stored under this directory.
10384
10385 @item nnfolder-active-file
10386 @vindex nnfolder-active-file
10387 The name of the active file.
10388
10389 @item nnfolder-newsgroups-file
10390 @vindex nnfolder-newsgroups-file
10391 The name of the group descriptions file.  @xref{Newsgroups File Format}.
10392
10393 @item nnfolder-get-new-mail
10394 @vindex nnfolder-get-new-mail
10395 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10396 @end table
10397
10398 @findex nnfolder-generate-active-file
10399 @kindex M-x nnfolder-generate-active-file
10400 If you have lots of @code{nnfolder}-like files you'd like to read with
10401 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10402 command to make @code{nnfolder} aware of all likely files in
10403 @code{nnfolder-directory}.
10404
10405
10406 @node Other Sources
10407 @section Other Sources
10408
10409 Gnus can do more than just read news or mail.  The methods described
10410 below allow Gnus to view directories and files as if they were
10411 newsgroups.
10412
10413 @menu
10414 * Directory Groups::      You can read a directory as if it was a newsgroup.
10415 * Anything Groups::       Dired?  Who needs dired?
10416 * Document Groups::       Single files can be the basis of a group.
10417 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
10418 * Web Searches::          Creating groups from articles that match a string.
10419 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10420 @end menu
10421
10422
10423 @node Directory Groups
10424 @subsection Directory Groups
10425 @cindex nndir
10426 @cindex directory groups
10427
10428 If you have a directory that has lots of articles in separate files in
10429 it, you might treat it as a newsgroup.  The files have to have numerical
10430 names, of course.
10431
10432 This might be an opportune moment to mention @code{ange-ftp} (and its
10433 successor @code{efs}), that most wonderful of all wonderful Emacs
10434 packages.  When I wrote @code{nndir}, I didn't think much about it---a
10435 backend to read directories.  Big deal.
10436
10437 @code{ange-ftp} changes that picture dramatically.  For instance, if you
10438 enter the @code{ange-ftp} file name
10439 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10440 @code{ange-ftp} or @code{efs} will actually allow you to read this
10441 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
10442
10443 @code{nndir} will use @sc{nov} files if they are present.
10444
10445 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10446 articles with this method.  You can use @code{nnmh} or @code{nnml} for
10447 whatever you use @code{nndir} for, so you could switch to any of those
10448 methods if you feel the need to have a non-read-only @code{nndir}.
10449
10450
10451 @node Anything Groups
10452 @subsection Anything Groups
10453 @cindex nneething
10454
10455 From the @code{nndir} backend (which reads a single spool-like
10456 directory), it's just a hop and a skip to @code{nneething}, which
10457 pretends that any arbitrary directory is a newsgroup.  Strange, but
10458 true.
10459
10460 When @code{nneething} is presented with a directory, it will scan this
10461 directory and assign article numbers to each file.  When you enter such
10462 a group, @code{nneething} must create ``headers'' that Gnus can use.
10463 After all, Gnus is a newsreader, in case you're
10464 forgetting. @code{nneething} does this in a two-step process.  First, it
10465 snoops each file in question.  If the file looks like an article (i.e.,
10466 the first few lines look like headers), it will use this as the head.
10467 If this is just some arbitrary file without a head (e.g. a C source
10468 file), @code{nneething} will cobble up a header out of thin air.  It
10469 will use file ownership, name and date and do whatever it can with these
10470 elements.
10471
10472 All this should happen automatically for you, and you will be presented
10473 with something that looks very much like a newsgroup.  Totally like a
10474 newsgroup, to be precise.  If you select an article, it will be displayed
10475 in the article buffer, just as usual.
10476
10477 If you select a line that represents a directory, Gnus will pop you into
10478 a new summary buffer for this @code{nneething} group.  And so on.  You can
10479 traverse the entire disk this way, if you feel like, but remember that
10480 Gnus is not dired, really, and does not intend to be, either.
10481
10482 There are two overall modes to this action---ephemeral or solid.  When
10483 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10484 will not store information on what files you have read, and what files
10485 are new, and so on.  If you create a solid @code{nneething} group the
10486 normal way with @kbd{G m}, Gnus will store a mapping table between
10487 article numbers and file names, and you can treat this group like any
10488 other groups.  When you activate a solid @code{nneething} group, you will
10489 be told how many unread articles it contains, etc., etc.
10490
10491 Some variables:
10492
10493 @table @code
10494 @item nneething-map-file-directory
10495 @vindex nneething-map-file-directory
10496 All the mapping files for solid @code{nneething} groups will be stored
10497 in this directory, which defaults to @file{~/.nneething/}.
10498
10499 @item nneething-exclude-files
10500 @vindex nneething-exclude-files
10501 All files that match this regexp will be ignored.  Nice to use to exclude
10502 auto-save files and the like, which is what it does by default.
10503
10504 @item nneething-map-file
10505 @vindex nneething-map-file
10506 Name of the map files.
10507 @end table
10508
10509
10510 @node Document Groups
10511 @subsection Document Groups
10512 @cindex nndoc
10513 @cindex documentation group
10514 @cindex help group
10515
10516 @code{nndoc} is a cute little thing that will let you read a single file
10517 as a newsgroup.  Several files types are supported:
10518
10519 @table @code
10520 @cindex babyl
10521 @cindex rmail mbox
10522
10523 @item babyl
10524 The babyl (rmail) mail box.
10525 @cindex mbox
10526 @cindex Unix mbox
10527
10528 @item mbox
10529 The standard Unix mbox file.
10530
10531 @cindex MMDF mail box
10532 @item mmdf
10533 The MMDF mail box format.
10534
10535 @item news
10536 Several news articles appended into a file.
10537
10538 @item rnews
10539 @cindex rnews batch files
10540 The rnews batch transport format.
10541 @cindex forwarded messages
10542
10543 @item forward
10544 Forwarded articles.
10545
10546 @item mime-parts
10547 MIME multipart messages, besides digests.
10548
10549 @item mime-digest
10550 @cindex digest
10551 @cindex MIME digest
10552 @cindex 1153 digest
10553 @cindex RFC 1153 digest
10554 @cindex RFC 341 digest
10555 MIME (RFC 1341) digest format.
10556
10557 @item standard-digest
10558 The standard (RFC 1153) digest format.
10559
10560 @item slack-digest
10561 Non-standard digest format---matches most things, but does it badly.
10562 @end table
10563
10564 You can also use the special ``file type'' @code{guess}, which means
10565 that @code{nndoc} will try to guess what file type it is looking at.
10566 @code{digest} means that @code{nndoc} should guess what digest type the
10567 file is.
10568
10569 @code{nndoc} will not try to change the file or insert any extra headers into
10570 it---it will simply, like, let you use the file as the basis for a
10571 group.  And that's it.
10572
10573 If you have some old archived articles that you want to insert into your
10574 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10575 that.  Say you have an old @file{RMAIL} file with mail that you now want
10576 to split into your new @code{nnml} groups.  You look at that file using
10577 @code{nndoc} (using the @kbd{G f} command in the group buffer
10578 (@pxref{Foreign Groups})), set the process mark on all the articles in
10579 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10580 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
10581 file is now also stored in lots of @code{nnml} directories, and you can
10582 delete that pesky @file{RMAIL} file.  If you have the guts!
10583
10584 Virtual server variables:
10585
10586 @table @code
10587 @item nndoc-article-type
10588 @vindex nndoc-article-type
10589 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10590 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10591 @code{rfc822-forward}, @code{mime-parts}, @code{mime-digest},
10592 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs} or
10593 @code{guess}.
10594
10595 @item nndoc-post-type
10596 @vindex nndoc-post-type
10597 This variable says whether Gnus is to consider the group a news group or
10598 a mail group.  There are two valid values:  @code{mail} (the default)
10599 and @code{news}.
10600 @end table
10601
10602 @menu
10603 * Document Server Internals::   How to add your own document types.
10604 @end menu
10605
10606
10607 @node Document Server Internals
10608 @subsubsection Document Server Internals
10609
10610 Adding new document types to be recognized by @code{nndoc} isn't
10611 difficult.  You just have to whip up a definition of what the document
10612 looks like, write a predicate function to recognize that document type,
10613 and then hook into @code{nndoc}.
10614
10615 First, here's an example document type definition:
10616
10617 @example
10618 (mmdf
10619  (article-begin .  "^\^A\^A\^A\^A\n")
10620  (body-end .  "^\^A\^A\^A\^A\n"))
10621 @end example
10622
10623 The definition is simply a unique @dfn{name} followed by a series of
10624 regexp pseudo-variable settings.  Below are the possible
10625 variables---don't be daunted by the number of variables; most document
10626 types can be defined with very few settings:
10627
10628 @table @code
10629 @item first-article
10630 If present, @code{nndoc} will skip past all text until it finds
10631 something that match this regexp.  All text before this will be
10632 totally ignored.
10633
10634 @item article-begin
10635 This setting has to be present in all document type definitions.  It
10636 says what the beginning of each article looks like.
10637
10638 @item head-begin-function
10639 If present, this should be a function that moves point to the head of
10640 the article.
10641
10642 @item nndoc-head-begin
10643 If present, this should be a regexp that matches the head of the
10644 article.
10645
10646 @item nndoc-head-end
10647 This should match the end of the head of the article.  It defaults to
10648 @samp{^$}---the empty line.
10649
10650 @item body-begin-function
10651 If present, this function should move point to the beginning of the body
10652 of the article.
10653
10654 @item body-begin
10655 This should match the beginning of the body of the article.  It defaults
10656 to @samp{^\n}.
10657
10658 @item body-end-function
10659 If present, this function should move point to the end of the body of
10660 the article.
10661
10662 @item body-end
10663 If present, this should match the end of the body of the article.
10664
10665 @item file-end
10666 If present, this should match the end of the file.  All text after this
10667 regexp will be totally ignored.
10668
10669 @end table
10670
10671 So, using these variables @code{nndoc} is able to dissect a document
10672 file into a series of articles, each with a head and a body.  However, a
10673 few more variables are needed since not all document types are all that
10674 news-like---variables needed to transform the head or the body into
10675 something that's palatable for Gnus:
10676
10677 @table @code
10678 @item prepare-body-function
10679 If present, this function will be called when requesting an article.  It
10680 will be called with point at the start of the body, and is useful if the
10681 document has encoded some parts of its contents.
10682
10683 @item article-transform-function
10684 If present, this function is called when requesting an article.  It's
10685 meant to be used for more wide-ranging transformation of both head and
10686 body of the article.
10687
10688 @item generate-head-function
10689 If present, this function is called to generate a head that Gnus can
10690 understand.  It is called with the article number as a parameter, and is
10691 expected to generate a nice head for the article in question.  It is
10692 called when requesting the headers of all articles.
10693
10694 @end table
10695
10696 Let's look at the most complicated example I can come up with---standard
10697 digests:
10698
10699 @example
10700 (standard-digest
10701  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10702  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10703  (prepare-body-function . nndoc-unquote-dashes)
10704  (body-end-function . nndoc-digest-body-end)
10705  (head-end . "^ ?$")
10706  (body-begin . "^ ?\n")
10707  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10708  (subtype digest guess))
10709 @end example
10710
10711 We see that all text before a 70-width line of dashes is ignored; all
10712 text after a line that starts with that @samp{^End of} is also ignored;
10713 each article begins with a 30-width line of dashes; the line separating
10714 the head from the body may contain a single space; and that the body is
10715 run through @code{nndoc-unquote-dashes} before being delivered.
10716
10717 To hook your own document definition into @code{nndoc}, use the
10718 @code{nndoc-add-type} function.  It takes two parameters---the first is
10719 the definition itself and the second (optional) parameter says where in
10720 the document type definition alist to put this definition.  The alist is
10721 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
10722 is of @code{mmdf} type, and so on.  These type predicates should return
10723 @code{nil} if the document is not of the correct type; @code{t} if it is
10724 of the correct type; and a number if the document might be of the
10725 correct type.  A high number means high probability; a low number means
10726 low probability with @samp{0} being the lowest valid number.
10727
10728
10729 @node SOUP
10730 @subsection SOUP
10731 @cindex SOUP
10732 @cindex offline
10733
10734 In the PC world people often talk about ``offline'' newsreaders.  These
10735 are thingies that are combined reader/news transport monstrosities.
10736 With built-in modem programs.  Yecchh!
10737
10738 Of course, us Unix Weenie types of human beans use things like
10739 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10740 transport things like Ghod intended.  And then we just use normal
10741 newsreaders.
10742
10743 However, it can sometimes be convenient to do something a that's a bit
10744 easier on the brain if you have a very slow modem, and you're not really
10745 that interested in doing things properly.
10746
10747 A file format called @sc{soup} has been developed for transporting news
10748 and mail from servers to home machines and back again.  It can be a bit
10749 fiddly.
10750
10751 First some terminology:
10752
10753 @table @dfn
10754
10755 @item server
10756 This is the machine that is connected to the outside world and where you
10757 get news and/or mail from.
10758
10759 @item home machine
10760 This is the machine that you want to do the actual reading and responding
10761 on.  It is typically not connected to the rest of the world in any way.
10762
10763 @item packet
10764 Something that contains messages and/or commands.  There are two kinds
10765 of packets:
10766
10767 @table @dfn
10768 @item message packets
10769 These are packets made at the server, and typically contain lots of
10770 messages for you to read.  These are called @file{SoupoutX.tgz} by
10771 default, where @var{X} is a number.
10772
10773 @item response packets
10774 These are packets made at the home machine, and typically contains
10775 replies that you've written.  These are called @file{SoupinX.tgz} by
10776 default, where @var{X} is a number.
10777
10778 @end table
10779
10780 @end table
10781
10782
10783 @enumerate
10784
10785 @item
10786 You log in on the server and create a @sc{soup} packet.  You can either
10787 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10788 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10789 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10790
10791 @item
10792 You transfer the packet home.  Rail, boat, car or modem will do fine.
10793
10794 @item
10795 You put the packet in your home directory.
10796
10797 @item
10798 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10799 the native or secondary server.
10800
10801 @item
10802 You read articles and mail and answer and followup to the things you
10803 want (@pxref{SOUP Replies}).
10804
10805 @item
10806 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10807 packet.
10808
10809 @item
10810 You transfer this packet to the server.
10811
10812 @item
10813 You use Gnus to mail this packet out with the @kbd{G s s} command.
10814
10815 @item
10816 You then repeat until you die.
10817
10818 @end enumerate
10819
10820 So you basically have a bipartite system---you use @code{nnsoup} for
10821 reading and Gnus for packing/sending these @sc{soup} packets.
10822
10823 @menu
10824 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10825 * SOUP Groups::       A backend for reading @sc{soup} packets.
10826 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10827 @end menu
10828
10829
10830 @node SOUP Commands
10831 @subsubsection SOUP Commands
10832
10833 These are commands for creating and manipulating @sc{soup} packets.
10834
10835 @table @kbd
10836 @item G s b
10837 @kindex G s b (Group)
10838 @findex gnus-group-brew-soup
10839 Pack all unread articles in the current group
10840 (@code{gnus-group-brew-soup}).  This command understands the
10841 process/prefix convention.
10842
10843 @item G s w
10844 @kindex G s w (Group)
10845 @findex gnus-soup-save-areas
10846 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10847
10848 @item G s s
10849 @kindex G s s (Group)
10850 @findex gnus-soup-send-replies
10851 Send all replies from the replies packet
10852 (@code{gnus-soup-send-replies}).
10853
10854 @item G s p
10855 @kindex G s p (Group)
10856 @findex gnus-soup-pack-packet
10857 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
10858
10859 @item G s r
10860 @kindex G s r (Group)
10861 @findex nnsoup-pack-replies
10862 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
10863
10864 @item O s
10865 @kindex O s (Summary)
10866 @findex gnus-soup-add-article
10867 This summary-mode command adds the current article to a @sc{soup} packet
10868 (@code{gnus-soup-add-article}).  It understands the process/prefix
10869 convention (@pxref{Process/Prefix}).
10870
10871 @end table
10872
10873
10874 There are a few variables to customize where Gnus will put all these
10875 thingies:
10876
10877 @table @code
10878
10879 @item gnus-soup-directory
10880 @vindex gnus-soup-directory
10881 Directory where Gnus will save intermediate files while composing
10882 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
10883
10884 @item gnus-soup-replies-directory
10885 @vindex gnus-soup-replies-directory
10886 This is what Gnus will use as a temporary directory while sending our
10887 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10888
10889 @item gnus-soup-prefix-file
10890 @vindex gnus-soup-prefix-file
10891 Name of the file where Gnus stores the last used prefix.  The default is
10892 @samp{gnus-prefix}.
10893
10894 @item gnus-soup-packer
10895 @vindex gnus-soup-packer
10896 A format string command for packing a @sc{soup} packet.  The default is
10897 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
10898
10899 @item gnus-soup-unpacker
10900 @vindex gnus-soup-unpacker
10901 Format string command for unpacking a @sc{soup} packet.  The default is
10902 @samp{gunzip -c %s | tar xvf -}.
10903
10904 @item gnus-soup-packet-directory
10905 @vindex gnus-soup-packet-directory
10906 Where Gnus will look for reply packets.  The default is @file{~/}.
10907
10908 @item gnus-soup-packet-regexp
10909 @vindex gnus-soup-packet-regexp
10910 Regular expression matching @sc{soup} reply packets in
10911 @code{gnus-soup-packet-directory}.
10912
10913 @end table
10914
10915
10916 @node SOUP Groups
10917 @subsubsection @sc{soup} Groups
10918 @cindex nnsoup
10919
10920 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10921 read incoming packets, unpack them, and put them in a directory where
10922 you can read them at leisure.
10923
10924 These are the variables you can use to customize its behavior:
10925
10926 @table @code
10927
10928 @item nnsoup-tmp-directory
10929 @vindex nnsoup-tmp-directory
10930 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10931 directory.  (@file{/tmp/} by default.)
10932
10933 @item nnsoup-directory
10934 @vindex nnsoup-directory
10935 @code{nnsoup} then moves each message and index file to this directory.
10936 The default is @file{~/SOUP/}.
10937
10938 @item nnsoup-replies-directory
10939 @vindex nnsoup-replies-directory
10940 All replies will be stored in this directory before being packed into a
10941 reply packet.  The default is @file{~/SOUP/replies/"}.
10942
10943 @item nnsoup-replies-format-type
10944 @vindex nnsoup-replies-format-type
10945 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10946 (rnews), and I don't think you should touch that variable.  I probably
10947 shouldn't even have documented it.  Drats!  Too late!
10948
10949 @item nnsoup-replies-index-type
10950 @vindex nnsoup-replies-index-type
10951 The index type of the replies packet.  The default is @samp{?n}, which
10952 means ``none''.  Don't fiddle with this one either!
10953
10954 @item nnsoup-active-file
10955 @vindex nnsoup-active-file
10956 Where @code{nnsoup} stores lots of information.  This is not an ``active
10957 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10958 this file or mess it up in any way, you're dead.  The default is
10959 @file{~/SOUP/active}.
10960
10961 @item nnsoup-packer
10962 @vindex nnsoup-packer
10963 Format string command for packing a reply @sc{soup} packet.  The default
10964 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
10965
10966 @item nnsoup-unpacker
10967 @vindex nnsoup-unpacker
10968 Format string command for unpacking incoming @sc{soup} packets.  The
10969 default is @samp{gunzip -c %s | tar xvf -}.
10970
10971 @item nnsoup-packet-directory
10972 @vindex nnsoup-packet-directory
10973 Where @code{nnsoup} will look for incoming packets.  The default is
10974 @file{~/}.
10975
10976 @item nnsoup-packet-regexp
10977 @vindex nnsoup-packet-regexp
10978 Regular expression matching incoming @sc{soup} packets.  The default is
10979 @samp{Soupout}.
10980
10981 @item nnsoup-always-save
10982 @vindex nnsoup-always-save
10983 If non-@code{nil}, save the replies buffer after each posted message.
10984
10985 @end table
10986
10987
10988 @node SOUP Replies
10989 @subsubsection SOUP Replies
10990
10991 Just using @code{nnsoup} won't mean that your postings and mailings end
10992 up in @sc{soup} reply packets automagically.  You have to work a bit
10993 more for that to happen.
10994
10995 @findex nnsoup-set-variables
10996 The @code{nnsoup-set-variables} command will set the appropriate
10997 variables to ensure that all your followups and replies end up in the
10998 @sc{soup} system.
10999
11000 In specific, this is what it does:
11001
11002 @lisp
11003 (setq message-send-news-function 'nnsoup-request-post)
11004 (setq message-send-mail-function 'nnsoup-request-mail)
11005 @end lisp
11006
11007 And that's it, really.  If you only want news to go into the @sc{soup}
11008 system you just use the first line.  If you only want mail to be
11009 @sc{soup}ed you use the second.
11010
11011
11012 @node Web Searches
11013 @subsection Web Searches
11014 @cindex nnweb
11015 @cindex DejaNews
11016 @cindex Alta Vista
11017 @cindex InReference
11018 @cindex Usenet searches
11019 @cindex searching the Usenet
11020
11021 It's, like, too neat to search the Usenet for articles that match a
11022 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11023 those, like, Web browsers, and you, like, have to, rilly, like, look at
11024 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11025 searches without having to use a browser.
11026
11027 The @code{nnweb} backend allows an easy interface to the mighty search
11028 engine.  You create an @code{nnweb} group, enter a search pattern, and
11029 then enter the group and read the articles like you would any normal
11030 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
11031 Groups}) will do this in an easy-to-use fashion.
11032
11033 @code{nnweb} groups don't really lend themselves to being solid
11034 groups---they have a very fleeting idea of article numbers.  In fact,
11035 each time you enter an @code{nnweb} group (not even changing the search
11036 pattern), you are likely to get the articles ordered in a different
11037 manner.  Not even using duplicate suppression (@pxref{Duplicate
11038 Suppression}) will help, since @code{nnweb} doesn't even know the
11039 @code{Message-ID} of the articles before reading them using some search
11040 engines (DejaNews, for instance).  The only possible way to keep track
11041 of which articles you've read is by scoring on the @code{Date}
11042 header---mark all articles posted before the last date you read the
11043 group as read.
11044
11045 If the search engine changes its output substantially, @code{nnweb}
11046 won't be able to parse it and will fail.  One could hardly fault the Web
11047 providers if they were to do this---their @emph{raison d'être} is to
11048 make money off of advertisements, not to provide services to the
11049 community.  Since @code{nnweb} washes the ads off all the articles, one
11050 might think that the providers might be somewhat miffed.  We'll see.
11051
11052 You must have the @code{url} and @code{w3} package installed to be able
11053 to use @code{nnweb}.
11054
11055 Virtual server variables:
11056
11057 @table @code
11058 @item nnweb-type
11059 @vindex nnweb-type
11060 What search engine type is being used.  The currently supported types
11061 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11062 @code{reference}.
11063
11064 @item nnweb-search
11065 @vindex nnweb-search
11066 The search string to feed to the search engine.
11067
11068 @item nnweb-max-hits
11069 @vindex nnweb-max-hits
11070 Advisory maximum number of hits per search to display.  The default is
11071 100.
11072
11073 @item nnweb-type-definition
11074 @vindex nnweb-type-definition
11075 Type-to-definition alist.  This alist says what @code{nnweb} should do
11076 with the various search engine types.  The following elements must be
11077 present:
11078
11079 @table @code
11080 @item article
11081 Function to decode the article and provide something that Gnus
11082 understands.
11083
11084 @item map
11085 Function to create an article number to message header and URL alist.
11086
11087 @item search
11088 Function to send the search string to the search engine.
11089
11090 @item address
11091 The address the aforementioned function should send the search string
11092 to.
11093
11094 @item id
11095 Format string URL to fetch an article by @code{Message-ID}.
11096 @end table
11097
11098 @end table
11099
11100
11101
11102 @node Mail-To-News Gateways
11103 @subsection Mail-To-News Gateways
11104 @cindex mail-to-news gateways
11105 @cindex gateways
11106
11107 If your local @code{nntp} server doesn't allow posting, for some reason
11108 or other, you can post using one of the numerous mail-to-news gateways.
11109 The @code{nngateway} backend provides the interface.
11110
11111 Note that you can't read anything from this backend---it can only be
11112 used to post with.
11113
11114 Server variables:
11115
11116 @table @code
11117 @item nngateway-address
11118 @vindex nngateway-address
11119 This is the address of the mail-to-news gateway.
11120
11121 @item nngateway-header-transformation
11122 @vindex nngateway-header-transformation
11123 News headers often have to be transformed in some odd way or other
11124 for the mail-to-news gateway to accept it.  This variable says what
11125 transformation should be called, and defaults to
11126 @code{nngateway-simple-header-transformation}.  The function is called
11127 narrowed to the headers to be transformed and with one parameter---the
11128 gateway address.
11129
11130 This default function just inserts a new @code{To} header based on the
11131 @code{Newsgroups} header and the gateway address.
11132 For instance, an article with this @code{Newsgroups} header:
11133
11134 @example
11135 Newsgroups: alt.religion.emacs
11136 @end example
11137
11138 will get this @code{From} header inserted:
11139
11140 @example
11141 To: alt-religion-emacs@@GATEWAY
11142 @end example
11143
11144 The following pre-defined functions exist:
11145
11146 @findex nngateway-simple-header-transformation
11147 @table @code
11148
11149 @item nngateway-simple-header-transformation
11150 Creates a @code{To} header that looks like
11151 @var{newsgroup}@@@code{nngateway-address}.
11152
11153 @findex nngateway-mail2news-header-transformation
11154
11155 @item nngateway-mail2news-header-transformation
11156 Creates a @code{To} header that looks like
11157 @code{nngateway-address}.
11158
11159 Here's an example:
11160
11161 @lisp
11162 (setq gnus-post-method
11163       '(nngateway "mail2news@@replay.com"
11164                   (nngateway-header-transformation
11165                    nngateway-mail2news-header-transformation)))
11166 @end lisp
11167
11168 @end table
11169
11170
11171 @end table
11172
11173 So, to use this, simply say something like:
11174
11175 @lisp
11176 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
11177 @end lisp
11178
11179
11180 @node Combined Groups
11181 @section Combined Groups
11182
11183 Gnus allows combining a mixture of all the other group types into bigger
11184 groups.
11185
11186 @menu
11187 * Virtual Groups::     Combining articles from many groups.
11188 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
11189 @end menu
11190
11191
11192 @node Virtual Groups
11193 @subsection Virtual Groups
11194 @cindex nnvirtual
11195 @cindex virtual groups
11196 @cindex merging groups
11197
11198 An @dfn{nnvirtual group} is really nothing more than a collection of
11199 other groups.
11200
11201 For instance, if you are tired of reading many small groups, you can
11202 put them all in one big group, and then grow tired of reading one
11203 big, unwieldy group.  The joys of computing!
11204
11205 You specify @code{nnvirtual} as the method.  The address should be a
11206 regexp to match component groups.
11207
11208 All marks in the virtual group will stick to the articles in the
11209 component groups.  So if you tick an article in a virtual group, the
11210 article will also be ticked in the component group from whence it came.
11211 (And vice versa---marks from the component groups will also be shown in
11212 the virtual group.)
11213
11214 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
11215 newsgroups into one, big, happy newsgroup:
11216
11217 @lisp
11218 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11219 @end lisp
11220
11221 The component groups can be native or foreign; everything should work
11222 smoothly, but if your computer explodes, it was probably my fault.
11223
11224 Collecting the same group from several servers might actually be a good
11225 idea if users have set the Distribution header to limit distribution.
11226 If you would like to read @samp{soc.motss} both from a server in Japan
11227 and a server in Norway, you could use the following as the group regexp:
11228
11229 @example
11230 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
11231 @end example
11232
11233 (Remember, though, that if you're creating the group with @kbd{G m}, you
11234 shouldn't double the backslashes, and you should leave off the quote
11235 characters at the beginning and the end of the string.)
11236
11237 This should work kinda smoothly---all articles from both groups should
11238 end up in this one, and there should be no duplicates.  Threading (and
11239 the rest) will still work as usual, but there might be problems with the
11240 sequence of articles.  Sorting on date might be an option here
11241 (@pxref{Selecting a Group}).
11242
11243 One limitation, however---all groups included in a virtual
11244 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
11245 zombie groups can't be component groups for @code{nnvirtual} groups.
11246
11247 @vindex nnvirtual-always-rescan
11248 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11249 @code{nnvirtual} will always scan groups for unread articles when
11250 entering a virtual group.  If this variable is @code{nil} (which is the
11251 default) and you read articles in a component group after the virtual
11252 group has been activated, the read articles from the component group
11253 will show up when you enter the virtual group.  You'll also see this
11254 effect if you have two virtual groups that have a component group in
11255 common.  If that's the case, you should set this variable to @code{t}.
11256 Or you can just tap @code{M-g} on the virtual group every time before
11257 you enter it---it'll have much the same effect.
11258
11259
11260 @node Kibozed Groups
11261 @subsection Kibozed Groups
11262 @cindex nnkiboze
11263 @cindex kibozing
11264
11265 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11266 the news feed''.  @code{nnkiboze} is a backend that will do this for
11267 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
11268 with useless requests!  Oh happiness!
11269
11270 @kindex G k (Group)
11271 To create a kibozed group, use the @kbd{G k} command in the group
11272 buffer.
11273
11274 The address field of the @code{nnkiboze} method is, as with
11275 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11276 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
11277 and @code{nnvirtual} end.
11278
11279 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11280 must have a score file to say what articles are to be included in
11281 the group (@pxref{Scoring}).
11282
11283 @kindex M-x nnkiboze-generate-groups
11284 @findex nnkiboze-generate-groups
11285 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11286 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
11287 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
11288 all the articles in all the component groups and run them through the
11289 scoring process to determine if there are any articles in the groups
11290 that are to be part of the @code{nnkiboze} groups.
11291
11292 Please limit the number of component groups by using restrictive
11293 regexps.  Otherwise your sysadmin may become annoyed with you, and the
11294 @sc{nntp} site may throw you off and never let you back in again.
11295 Stranger things have happened.
11296
11297 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11298 and they can be foreign.  No restrictions.
11299
11300 @vindex nnkiboze-directory
11301 The generation of an @code{nnkiboze} group means writing two files in
11302 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
11303 contains the @sc{nov} header lines for all the articles in the group,
11304 and the other is an additional @file{.newsrc} file to store information
11305 on what groups have been searched through to find component articles.
11306
11307 Articles marked as read in the @code{nnkiboze} group will have
11308 their @sc{nov} lines removed from the @sc{nov} file.
11309
11310
11311 @node Gnus Unplugged
11312 @section Gnus Unplugged
11313 @cindex offline
11314 @cindex unplugged
11315 @cindex Agent
11316 @cindex Gnus Agent
11317 @cindex Gnus Unplugged
11318
11319 In olden times (ca. February '88), people used to run their newsreaders
11320 on big machines with permanent connections to the net.  News transport
11321 was dealt with by news servers, and all the newsreaders had to do was to
11322 read news.  Believe it or not.
11323
11324 Nowadays most people read news and mail at home, and use some sort of
11325 modem to connect to the net.  To avoid running up huge phone bills, it
11326 would be nice to have a way to slurp down all the news and mail, hang up
11327 the phone, read for several hours, and then upload any responses you
11328 have to make.  And then you repeat the procedure.
11329
11330 Of course, you can use news servers for doing this as well.  I've used
11331 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11332 for some years, but doing that's a bore.  Moving the news server
11333 functionality up to the newsreader makes sense if you're the only person
11334 reading news on a machine.
11335
11336 Using Gnus as an ``offline'' newsreader is quite simple.
11337
11338 @itemize @bullet
11339 @item
11340 First, set up Gnus as you would do if you were running it on a machine
11341 that has full connection to the net.  Go ahead.  I'll still be waiting
11342 here.
11343
11344 @item
11345 Then, put the following magical incantation at the end of your
11346 @file{.gnus.el} file:
11347
11348 @lisp
11349 (gnus-agentize)
11350 @end lisp
11351 @end itemize
11352
11353 That's it.  Gnus is now an ``offline'' newsreader.
11354
11355 Of course, to use it as such, you have to learn a few new commands.
11356
11357 @menu
11358 * Agent Basics::           How it all is supposed to work.
11359 * Agent Categories::       How to tell the Gnus Agent what to download.
11360 * Agent Commands::         New commands for all the buffers.
11361 * Agent Expiry::           How to make old articles go away.
11362 * Outgoing Messages::      What happens when you post/mail something?
11363 * Agent Variables::        Customizing is fun.
11364 * Example Setup::          An example @file{.gnus.el} file for offline people.
11365 * Batching Agents::        How to fetch news from a @code{cron} job.
11366 @end menu
11367
11368
11369 @node Agent Basics
11370 @subsection Agent Basics
11371
11372 First, let's get some terminology out of the way.
11373
11374 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11375 connection to the net (and notified the Agent that this is the case).
11376 When the connection to the net is up again (and Gnus knows this), the
11377 Agent is @dfn{plugged}.
11378
11379 The @dfn{local} machine is the one you're running on, and which isn't
11380 connected to the net continuously.
11381
11382 @dfn{Downloading} means fetching things from the net to your local
11383 machine.  @dfn{Uploading} is doing the opposite.
11384
11385 Let's take a typical Gnus session using the Agent.
11386
11387 @itemize @bullet
11388
11389 @item
11390 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
11391 Agent in a disconnected state.  You can read all the news that you have
11392 already fetched while in this mode.
11393
11394 @item
11395 You then decide to see whether any new news has arrived.  You connect
11396 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11397 to make Gnus become @dfn{plugged}.
11398
11399 @item
11400 You can then read the new news immediately, or you can download the news
11401 onto your local machine.  If you want to do the latter, you press @kbd{J
11402 s} to fetch all the eligible articles in all the groups.  (To let Gnus
11403 know which articles you want to download, @pxref{Agent Categories}.)
11404
11405 @item
11406 After fetching the articles, you press @kbd{J j} to make Gnus become
11407 unplugged again, and you shut down the PPP thing (or whatever).  And
11408 then you read the news offline.
11409
11410 @item
11411 And then you go to step 2.
11412 @end itemize
11413
11414 Here are some things you should do the first time (or so) that you use
11415 the Agent.
11416
11417 @itemize @bullet
11418
11419 @item
11420 Decide which servers should be covered by the Agent.  If you have a mail
11421 backend, it would probably be nonsensical to have it covered by the
11422 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
11423 @kbd{J a} the server (or servers) that you wish to have covered by the
11424 Agent (@pxref{Server Agent Commands}).  This will typically be only the
11425 primary select method, which is listed on the bottom in the buffer.
11426
11427 @item
11428 Decide on download policy.  @xref{Agent Categories}
11429
11430 @item
11431 Uhm... that's it.
11432 @end itemize
11433
11434
11435 @node Agent Categories
11436 @subsection Agent Categories
11437
11438 One of the main reasons to integrate the news transport layer into the
11439 newsreader is to allow greater control over what articles to download.
11440 There's not much point in downloading huge amounts of articles, just to
11441 find out that you're not interested in reading any of them.  It's better
11442 to be somewhat more conservative in choosing what to download, and then
11443 mark the articles for downloading manually if it should turn out that
11444 you're interested in the articles anyway.
11445
11446 The main way to control what is to be downloaded is to create a
11447 @dfn{category} and then assign some (or all) groups to this category.
11448 Gnus has its own buffer for creating and managing categories.
11449
11450 @menu
11451 * Category Syntax::       What a category looks like.
11452 * The Category Buffer::   A buffer for maintaining categories.
11453 * Category Variables::    Customize'r'Us.
11454 @end menu
11455
11456
11457 @node Category Syntax
11458 @subsubsection Category Syntax
11459
11460 A category consists of two things.
11461
11462 @enumerate
11463 @item
11464 A predicate which (generally) gives a rough outline of which articles
11465 are eligible for downloading; and
11466
11467 @item
11468 a score rule which (generally) gives you a finer granularity when
11469 deciding what articles to download.  (Note that this @dfn{download
11470 score} is wholly unrelated to normal scores.)
11471 @end enumerate
11472
11473 A predicate consists of predicates with logical operators sprinkled in
11474 between.
11475
11476 Perhaps some examples are in order.
11477
11478 Here's a simple predicate.  (It's the default predicate, in fact, used
11479 for all groups that don't belong to any other category.)
11480
11481 @lisp
11482 short
11483 @end lisp
11484
11485 Quite simple, eh?  This predicate is true if and only if the article is
11486 short (for some value of ``short'').
11487
11488 Here's a more complex predicate:
11489
11490 @lisp
11491 (or high
11492     (and
11493      (not low)
11494      (not long)))
11495 @end lisp
11496
11497 This means that an article should be downloaded if it has a high score,
11498 or if the score is not low and the article is not long.  You get the
11499 drift.
11500
11501 The available logical operators are @code{or}, @code{and} and
11502 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
11503 @samp{|}, @code{&} and @code{!} instead.)
11504
11505 The following predicates are pre-defined, but if none of these fit what
11506 you want to do, you can write your own.
11507
11508 @table @code
11509 @item short
11510 True iff the article is shorter than @code{gnus-agent-short-article}
11511 lines; default 100.
11512
11513 @item long
11514 True iff the article is longer than @code{gnus-agent-long-article}
11515 lines; default 200.
11516
11517 @item low
11518 True iff the article has a download score less than
11519 @code{gnus-agent-low-score}; default 0.
11520
11521 @item high
11522 True iff the article has a download score greater than
11523 @code{gnus-agent-high-score}; default 0.
11524
11525 @item spam
11526 True iff the Gnus Agent guesses that the article is spam.  The
11527 heuristics may change over time, but at present it just computes a
11528 checksum and sees whether articles match.
11529
11530 @item true
11531 Always true.
11532
11533 @item false
11534 Always false.
11535 @end table
11536
11537 If you want to create your own predicate function, here's what you have
11538 to know:  The functions are called with no parameters, but the
11539 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11540 useful values.
11541
11542 Now, the syntax of the download score is the same as the syntax of
11543 normal score files, except that all elements that require actually
11544 seeing the article itself are verboten.  This means that only the
11545 following headers can be scored on: @code{From}, @code{Subject},
11546 @code{Date}, @code{Xref}, @code{Lines}, @code{Chars}, @code{Message-ID},
11547 and @code{References}.
11548
11549
11550 @node The Category Buffer
11551 @subsubsection The Category Buffer
11552
11553 You'd normally do all category maintenance from the category buffer.
11554 When you enter it for the first time (with the @kbd{J c} command from
11555 the group buffer), you'll only see the @code{default} category.
11556
11557 The following commands are available in this buffer:
11558
11559 @table @kbd
11560 @item q
11561 @kindex q (Category)
11562 @findex gnus-category-exit
11563 Return to the group buffer (@code{gnus-category-exit}).
11564
11565 @item k
11566 @kindex k (Category)
11567 @findex gnus-category-kill
11568 Kill the current category (@code{gnus-category-kill}).
11569
11570 @item c
11571 @kindex c (Category)
11572 @findex gnus-category-copy
11573 Copy the current category (@code{gnus-category-copy}).
11574
11575 @item a
11576 @kindex a (Category)
11577 @findex gnus-category-add
11578 Add a new category (@code{gnus-category-add}).
11579
11580 @item p
11581 @kindex p (Category)
11582 @findex gnus-category-edit-predicate
11583 Edit the predicate of the current category
11584 (@code{gnus-category-edit-predicate}).
11585
11586 @item g
11587 @kindex g (Category)
11588 @findex gnus-category-edit-groups
11589 Edit the list of groups belonging to the current category
11590 (@code{gnus-category-edit-groups}).
11591
11592 @item s
11593 @kindex s (Category)
11594 @findex gnus-category-edit-score
11595 Edit the download score rule of the current category
11596 (@code{gnus-category-edit-score}).
11597
11598 @item l
11599 @kindex l (Category)
11600 @findex gnus-category-list
11601 List all the categories (@code{gnus-category-list}).
11602 @end table
11603
11604
11605 @node Category Variables
11606 @subsubsection Category Variables
11607
11608 @table @code
11609 @item gnus-category-mode-hook
11610 @vindex gnus-category-mode-hook
11611 Hook run in category buffers.
11612
11613 @item gnus-category-line-format
11614 @vindex gnus-category-line-format
11615 Format of the lines in the category buffer (@pxref{Formatting
11616 Variables}).  Valid elements are:
11617
11618 @table @samp
11619 @item c
11620 The name of the category.
11621
11622 @item g
11623 The number of groups in the category.
11624 @end table
11625
11626 @item gnus-category-mode-line-format
11627 @vindex gnus-category-mode-line-format
11628 Format of the category mode line (@pxref{Mode Line Formatting}).
11629
11630 @item gnus-agent-short-article
11631 @vindex gnus-agent-short-article
11632 Articles that have fewer lines than this are short.  Default 100.
11633
11634 @item gnus-agent-long-article
11635 @vindex gnus-agent-long-article
11636 Articles that have more lines than this are long.  Default 200.
11637
11638 @item gnus-agent-low-score
11639 @vindex gnus-agent-low-score
11640 Articles that have a score lower than this have a low score.  Default
11641 0.
11642
11643 @item gnus-agent-high-score
11644 @vindex gnus-agent-high-score
11645 Articles that have a score higher than this have a high score.  Default
11646 0.
11647
11648 @end table
11649
11650
11651 @node Agent Commands
11652 @subsection Agent Commands
11653
11654 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
11655 (@code{gnus-agent-toggle-plugged} command works in all modes, and
11656 toggles the plugged/unplugged state of the Gnus Agent.
11657
11658
11659 @menu
11660 * Group Agent Commands::
11661 * Summary Agent Commands::
11662 * Server Agent Commands::
11663 @end menu
11664
11665 You can run a complete batch fetch from the command line with the
11666 following incantation:
11667
11668 @cindex gnus-agent-batch-fetch
11669 @example
11670 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
11671 @end example
11672
11673
11674
11675 @node Group Agent Commands
11676 @subsubsection Group Agent Commands
11677
11678 @table @kbd
11679 @item J u
11680 @kindex J u (Agent Group)
11681 @findex gnus-agent-fetch-groups
11682 Fetch all eligible articles in the current group
11683 (@code{gnus-agent-fetch-groups}).
11684
11685 @item J c
11686 @kindex J c (Agent Group)
11687 @findex gnus-enter-category-buffer
11688 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
11689
11690 @item J s
11691 @kindex J s (Agent Group)
11692 @findex gnus-agent-fetch-session
11693 Fetch all eligible articles in all groups
11694 (@code{gnus-agent-fetch-session}).
11695
11696 @item J S
11697 @kindex J S (Agent Group)
11698 @findex gnus-group-send-drafts
11699 Send all sendable messages in the draft group
11700 (@code{gnus-agent-fetch-session}).  @xref{Drafts}
11701
11702 @item J a
11703 @kindex J a (Agent Group)
11704 @findex gnus-agent-add-group
11705 Add the current group to an Agent category
11706 (@code{gnus-agent-add-group}).
11707
11708 @end table
11709
11710
11711 @node Summary Agent Commands
11712 @subsubsection Summary Agent Commands
11713
11714 @table @kbd
11715 @item J #
11716 @kindex J # (Agent Summary)
11717 @findex gnus-agent-mark-article
11718 Mark the article for downloading (@code{gnus-agent-mark-article}).
11719
11720 @item J M-#
11721 @kindex J M-# (Agent Summary)
11722 @findex gnus-agent-unmark-article
11723 Remove the downloading mark from the article
11724 (@code{gnus-agent-unmark-article}).
11725
11726 @item @@ 
11727 @kindex @@ (Agent Summary)
11728 @findex gnus-agent-toggle-mark
11729 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
11730
11731 @item J c
11732 @kindex J c (Agent Summary)
11733 @findex gnus-agent-catchup
11734 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
11735
11736 @end table
11737
11738
11739 @node Server Agent Commands
11740 @subsubsection Server Agent Commands
11741
11742 @table @kbd
11743 @item J a
11744 @kindex J a (Agent Server)
11745 @findex gnus-agent-add-server
11746 Add the current server to the list of servers covered by the Gnus Agent
11747 (@code{gnus-agent-add-server}).
11748
11749 @item J r
11750 @kindex J r (Agent Server)
11751 @findex gnus-agent-remove-server
11752 Remove the current server from the list of servers covered by the Gnus
11753 Agent (@code{gnus-agent-remove-server}).
11754
11755 @end table
11756
11757
11758 @node Agent Expiry
11759 @subsection Agent Expiry
11760
11761 @vindex gnus-agent-expiry-days
11762 @findex gnus-agent-expiry
11763 @kindex M-x gnus-agent-expiry
11764 @cindex Agent expiry
11765 @cindex Gnus Agent expiry
11766 @cindex expiry
11767
11768 @code{nnagent} doesn't handle expiry.  Instead, there's a special
11769 @code{gnus-agent-expiry} command that will expire all read articles that
11770 are older than @code{gnus-agent-expiry-days} days.  It can be run
11771 whenever you feel that you're running out of space.  It's not
11772 particularly fast or efficient, and it's not a particularly good idea to
11773 interrupt it (with @kbd{C-g} or anything else) once you've started it.
11774
11775 @vindex gnus-agent-expire-all
11776 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
11777 expire all articles---unread, read, ticked and dormant.  If @code{nil}
11778 (which is the default), only read articles are eligible for expiry, and
11779 unread, ticked and dormant articles will be kept indefinitely.
11780
11781
11782 @node Outgoing Messages
11783 @subsection Outgoing Messages
11784
11785 When Gnus is unplugged, all outgoing messages (both mail and news) are
11786 stored in the draft groups (@pxref{Drafts}).  You can view them there
11787 after posting, and edit them at will.
11788
11789 When Gnus is plugged again, you can send the messages either from the
11790 draft group with the special commands available there, or you can use
11791 the @kbd{J S} command in the group buffer to send all the sendable
11792 messages in the draft group.
11793
11794
11795
11796 @node Agent Variables
11797 @subsection Agent Variables
11798
11799 @table @code
11800 @item gnus-agent-directory
11801 @vindex gnus-agent-directory
11802 Where the Gnus Agent will store its files.  The default is
11803 @file{~/News/agent/}.
11804
11805 @item gnus-agent-handle-level
11806 @vindex gnus-agent-handle-level
11807 Groups on levels (@pxref{Group Levels}) higher than this variable will
11808 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
11809 which means that only subscribed group will be considered by the Agent
11810 by default.
11811
11812 @item gnus-agent-plugged-hook
11813 @vindex gnus-agent-plugged-hook
11814 Hook run when connecting to the network.
11815
11816 @item gnus-agent-unplugged-hook
11817 @vindex gnus-agent-unplugged-hook
11818 Hook run when disconnecting from the network.
11819
11820 @end table
11821
11822
11823 @node Example Setup
11824 @subsection Example Setup
11825
11826 If you don't want to read this manual, and you have a fairly standard
11827 setup, you may be able to use something like the following as your
11828 @file{.gnus.el} file to get started.
11829
11830 @lisp
11831 ;;; Define how Gnus is to fetch news.  We do this over NNTP
11832 ;;; from your ISP's server.
11833 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
11834
11835 ;;; Define how Gnus is to read your mail.  We read mail from
11836 ;;; your ISP's POP server.
11837 (setenv "MAILHOST" "pop.your-isp.com")
11838 (setq nnmail-spool-file "po:username")
11839
11840 ;;; Say how Gnus is to store the mail.  We use nnml groups.
11841 (setq gnus-secondary-select-methods '((nnml "")))
11842
11843 ;;; Make Gnus into an offline newsreader.
11844 (gnus-agentize)
11845 @end lisp
11846
11847 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
11848 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
11849 gnus}.
11850
11851 If this is the first time you've run Gnus, you will be subscribed
11852 automatically to a few default newsgroups.  You'll probably want to
11853 subscribe to more groups, and to do that, you have to query the
11854 @sc{nntp} server for a complete list of groups with the @kbd{A A}
11855 command.  This usually takes quite a while, but you only have to do it
11856 once.
11857
11858 After reading and parsing a while, you'll be presented with a list of
11859 groups.  Subscribe to the ones you want to read with the @kbd{u}
11860 command.  @kbd{l} to make all the killed groups disappear after you've
11861 subscribe to all the groups you want to read.  (@kbd{A k} will bring
11862 back all the killed groups.)
11863
11864 You can now read the groups at once, or you can download the articles
11865 with the @kbd{J s} command.  And then read the rest of this manual to
11866 find out which of the other gazillion things you want to customize.
11867
11868
11869 @node Batching Agents
11870 @subsection Batching Agents
11871
11872 Having the Gnus Agent fetch articles (and post whatever messages you've
11873 written) is quite easy once you've gotten things set up properly.  The
11874 following shell script will do everything that is necessary:
11875
11876 @example
11877 #!/bin/sh
11878 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
11879 @end example
11880
11881
11882
11883 @node Scoring
11884 @chapter Scoring
11885 @cindex scoring
11886
11887 Other people use @dfn{kill files}, but we here at Gnus Towers like
11888 scoring better than killing, so we'd rather switch than fight.  They do
11889 something completely different as well, so sit up straight and pay
11890 attention!
11891
11892 @vindex gnus-summary-mark-below
11893 All articles have a default score (@code{gnus-summary-default-score}),
11894 which is 0 by default.  This score may be raised or lowered either
11895 interactively or by score files.  Articles that have a score lower than
11896 @code{gnus-summary-mark-below} are marked as read.
11897
11898 Gnus will read any @dfn{score files} that apply to the current group
11899 before generating the summary buffer.
11900
11901 There are several commands in the summary buffer that insert score
11902 entries based on the current article.  You can, for instance, ask Gnus to
11903 lower or increase the score of all articles with a certain subject.
11904
11905 There are two sorts of scoring entries: Permanent and temporary.
11906 Temporary score entries are self-expiring entries.  Any entries that are
11907 temporary and have not been used for, say, a week, will be removed
11908 silently to help keep the sizes of the score files down.
11909
11910 @menu
11911 * Summary Score Commands::   Adding score entries for the current group.
11912 * Group Score Commands::     General score commands.
11913 * Score Variables::          Customize your scoring.  (My, what terminology).
11914 * Score File Format::        What a score file may contain.
11915 * Score File Editing::       You can edit score files by hand as well.
11916 * Adaptive Scoring::         Big Sister Gnus knows what you read.
11917 * Home Score File::          How to say where new score entries are to go.
11918 * Followups To Yourself::    Having Gnus notice when people answer you.
11919 * Scoring Tips::             How to score effectively.
11920 * Reverse Scoring::          That problem child of old is not problem.
11921 * Global Score Files::       Earth-spanning, ear-splitting score files.
11922 * Kill Files::               They are still here, but they can be ignored.
11923 * Converting Kill Files::    Translating kill files to score files.
11924 * GroupLens::                Getting predictions on what you like to read.
11925 * Advanced Scoring::         Using logical expressions to build score rules.
11926 * Score Decays::             It can be useful to let scores wither away.
11927 @end menu
11928
11929
11930 @node Summary Score Commands
11931 @section Summary Score Commands
11932 @cindex score commands
11933
11934 The score commands that alter score entries do not actually modify real
11935 score files.  That would be too inefficient.  Gnus maintains a cache of
11936 previously loaded score files, one of which is considered the
11937 @dfn{current score file alist}.  The score commands simply insert
11938 entries into this list, and upon group exit, this list is saved.
11939
11940 The current score file is by default the group's local score file, even
11941 if no such score file actually exists.  To insert score commands into
11942 some other score file (e.g. @file{all.SCORE}), you must first make this
11943 score file the current one.
11944
11945 General score commands that don't actually change the score file:
11946
11947 @table @kbd
11948
11949 @item V s
11950 @kindex V s (Summary)
11951 @findex gnus-summary-set-score
11952 Set the score of the current article (@code{gnus-summary-set-score}).
11953
11954 @item V S
11955 @kindex V S (Summary)
11956 @findex gnus-summary-current-score
11957 Display the score of the current article
11958 (@code{gnus-summary-current-score}).
11959
11960 @item V t
11961 @kindex V t (Summary)
11962 @findex gnus-score-find-trace
11963 Display all score rules that have been used on the current article
11964 (@code{gnus-score-find-trace}).
11965
11966 @item V R
11967 @kindex V R (Summary)
11968 @findex gnus-summary-rescore
11969 Run the current summary through the scoring process
11970 (@code{gnus-summary-rescore}).  This might be useful if you're playing
11971 around with your score files behind Gnus' back and want to see the
11972 effect you're having.
11973
11974 @item V c
11975 @kindex V c (Summary)
11976 @findex gnus-score-change-score-file
11977 Make a different score file the current
11978 (@code{gnus-score-change-score-file}).
11979
11980 @item V e
11981 @kindex V e (Summary)
11982 @findex gnus-score-edit-current-scores
11983 Edit the current score file (@code{gnus-score-edit-current-scores}).
11984 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
11985 File Editing}).
11986
11987 @item V f
11988 @kindex V f (Summary)
11989 @findex gnus-score-edit-file
11990 Edit a score file and make this score file the current one
11991 (@code{gnus-score-edit-file}).
11992
11993 @item V F
11994 @kindex V F (Summary)
11995 @findex gnus-score-flush-cache
11996 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
11997 after editing score files.
11998
11999 @item V C
12000 @kindex V C (Summary)
12001 @findex gnus-score-customize
12002 Customize a score file in a visually pleasing manner
12003 (@code{gnus-score-customize}).
12004
12005 @end table
12006
12007 The rest of these commands modify the local score file.
12008
12009 @table @kbd
12010
12011 @item V m
12012 @kindex V m (Summary)
12013 @findex gnus-score-set-mark-below
12014 Prompt for a score, and mark all articles with a score below this as
12015 read (@code{gnus-score-set-mark-below}).
12016
12017 @item V x
12018 @kindex V x (Summary)
12019 @findex gnus-score-set-expunge-below
12020 Prompt for a score, and add a score rule to the current score file to
12021 expunge all articles below this score
12022 (@code{gnus-score-set-expunge-below}).
12023 @end table
12024
12025 The keystrokes for actually making score entries follow a very regular
12026 pattern, so there's no need to list all the commands.  (Hundreds of
12027 them.)
12028
12029 @findex gnus-summary-increase-score
12030 @findex gnus-summary-lower-score
12031
12032 @enumerate
12033 @item
12034 The first key is either @kbd{I} (upper case i) for increasing the score
12035 or @kbd{L} for lowering the score.
12036 @item
12037 The second key says what header you want to score on.  The following
12038 keys are available:
12039 @table @kbd
12040
12041 @item a
12042 Score on the author name.
12043
12044 @item s
12045 Score on the subject line.
12046
12047 @item x
12048 Score on the Xref line---i.e., the cross-posting line.
12049
12050 @item r
12051 Score on the References line.
12052
12053 @item d
12054 Score on the date.
12055
12056 @item l
12057 Score on the number of lines.
12058
12059 @item i
12060 Score on the Message-ID.
12061
12062 @item f
12063 Score on followups.
12064
12065 @item b
12066 Score on the body.
12067
12068 @item h
12069 Score on the head.
12070
12071 @item t
12072 Score on thead.
12073
12074 @end table
12075
12076 @item
12077 The third key is the match type.  Which match types are valid depends on
12078 what headers you are scoring on.
12079
12080 @table @code
12081
12082 @item strings
12083
12084 @table @kbd
12085
12086 @item e
12087 Exact matching.
12088
12089 @item s
12090 Substring matching.
12091
12092 @item f
12093 Fuzzy matching (@pxref{Fuzzy Matching}).
12094
12095 @item r
12096 Regexp matching
12097 @end table
12098
12099 @item date
12100 @table @kbd
12101
12102 @item b
12103 Before date.
12104
12105 @item a
12106 After date.
12107
12108 @item n
12109 This date.
12110 @end table
12111
12112 @item number
12113 @table @kbd
12114
12115 @item <
12116 Less than number.
12117
12118 @item =
12119 Equal to number.
12120
12121 @item >
12122 Greater than number.
12123 @end table
12124 @end table
12125
12126 @item
12127 The fourth and final key says whether this is a temporary (i.e., expiring)
12128 score entry, or a permanent (i.e., non-expiring) score entry, or whether
12129 it is to be done immediately, without adding to the score file.
12130 @table @kbd
12131
12132 @item t
12133 Temporary score entry.
12134
12135 @item p
12136 Permanent score entry.
12137
12138 @item i
12139 Immediately scoring.
12140 @end table
12141
12142 @end enumerate
12143
12144 So, let's say you want to increase the score on the current author with
12145 exact matching permanently: @kbd{I a e p}.  If you want to lower the
12146 score based on the subject line, using substring matching, and make a
12147 temporary score entry: @kbd{L s s t}.  Pretty easy.
12148
12149 To make things a bit more complicated, there are shortcuts.  If you use
12150 a capital letter on either the second or third keys, Gnus will use
12151 defaults for the remaining one or two keystrokes.  The defaults are
12152 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
12153 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
12154
12155 These functions take both the numerical prefix and the symbolic prefix
12156 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
12157 (or increase) the score of the article.  A symbolic prefix of @code{a}
12158 says to use the @file{all.SCORE} file for the command instead of the
12159 current score file.
12160
12161 @vindex gnus-score-mimic-keymap
12162 The @code{gnus-score-mimic-keymap} says whether these commands will
12163 pretend they are keymaps or not.
12164
12165
12166 @node Group Score Commands
12167 @section Group Score Commands
12168 @cindex group score commands
12169
12170 There aren't many of these as yet, I'm afraid.
12171
12172 @table @kbd
12173
12174 @item W f
12175 @kindex W f (Group)
12176 @findex gnus-score-flush-cache
12177 Gnus maintains a cache of score alists to avoid having to reload them
12178 all the time.  This command will flush the cache
12179 (@code{gnus-score-flush-cache}).
12180
12181 @end table
12182
12183 You can do scoring from the command line by saying something like:
12184
12185 @findex gnus-batch-score
12186 @cindex batch scoring
12187 @example
12188 $ emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score
12189 @end example
12190
12191
12192 @node Score Variables
12193 @section Score Variables
12194 @cindex score variables
12195
12196 @table @code
12197
12198 @item gnus-use-scoring
12199 @vindex gnus-use-scoring
12200 If @code{nil}, Gnus will not check for score files, and will not, in
12201 general, do any score-related work.  This is @code{t} by default.
12202
12203 @item gnus-kill-killed
12204 @vindex gnus-kill-killed
12205 If this variable is @code{nil}, Gnus will never apply score files to
12206 articles that have already been through the kill process.  While this
12207 may save you lots of time, it also means that if you apply a kill file
12208 to a group, and then change the kill file and want to run it over you
12209 group again to kill more articles, it won't work.  You have to set this
12210 variable to @code{t} to do that.  (It is @code{t} by default.)
12211
12212 @item gnus-kill-files-directory
12213 @vindex gnus-kill-files-directory
12214 All kill and score files will be stored in this directory, which is
12215 initialized from the @code{SAVEDIR} environment variable by default.
12216 This is @file{~/News/} by default.
12217
12218 @item gnus-score-file-suffix
12219 @vindex gnus-score-file-suffix
12220 Suffix to add to the group name to arrive at the score file name
12221 (@samp{SCORE} by default.)
12222
12223 @item gnus-score-uncacheable-files
12224 @vindex gnus-score-uncacheable-files
12225 @cindex score cache
12226 All score files are normally cached to avoid excessive re-loading of
12227 score files.  However, if this might make you Emacs grow big and
12228 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
12229 @file{all.SCORE}, while it might be a good idea to not cache
12230 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
12231 variable is @samp{ADAPT$} by default, so no adaptive score files will
12232 be cached.
12233
12234 @item gnus-save-score
12235 @vindex gnus-save-score
12236 If you have really complicated score files, and do lots of batch
12237 scoring, then you might set this variable to @code{t}.  This will make
12238 Gnus save the scores into the @file{.newsrc.eld} file.
12239
12240 @item gnus-score-interactive-default-score
12241 @vindex gnus-score-interactive-default-score
12242 Score used by all the interactive raise/lower commands to raise/lower
12243 score with.  Default is 1000, which may seem excessive, but this is to
12244 ensure that the adaptive scoring scheme gets enough room to play with.
12245 We don't want the small changes from the adaptive scoring to overwrite
12246 manually entered data.
12247
12248 @item gnus-summary-default-score
12249 @vindex gnus-summary-default-score
12250 Default score of an article, which is 0 by default.
12251
12252 @item gnus-summary-expunge-below
12253 @vindex gnus-summary-expunge-below
12254 Don't display the summary lines of articles that have scores lower than
12255 this variable.  This is @code{nil} by default, which means that no
12256 articles will be hidden.  This variable is local to the summary buffers,
12257 and has to be set from @code{gnus-summary-mode-hook}.
12258
12259 @item gnus-score-over-mark
12260 @vindex gnus-score-over-mark
12261 Mark (in the third column) used for articles with a score over the
12262 default.  Default is @samp{+}.
12263
12264 @item gnus-score-below-mark
12265 @vindex gnus-score-below-mark
12266 Mark (in the third column) used for articles with a score below the
12267 default.  Default is @samp{-}.
12268
12269 @item gnus-score-find-score-files-function
12270 @vindex gnus-score-find-score-files-function
12271 Function used to find score files for the current group.  This function
12272 is called with the name of the group as the argument.
12273
12274 Predefined functions available are:
12275 @table @code
12276
12277 @item gnus-score-find-single
12278 @findex gnus-score-find-single
12279 Only apply the group's own score file.
12280
12281 @item gnus-score-find-bnews
12282 @findex gnus-score-find-bnews
12283 Apply all score files that match, using bnews syntax.  This is the
12284 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
12285 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12286 @file{gnu.all.SCORE} would all apply.  In short, the instances of
12287 @samp{all} in the score file names are translated into @samp{.*}, and
12288 then a regexp match is done.
12289
12290 This means that if you have some score entries that you want to apply to
12291 all groups, then you put those entries in the @file{all.SCORE} file.
12292
12293 The score files are applied in a semi-random order, although Gnus will
12294 try to apply the more general score files before the more specific score
12295 files.  It does this by looking at the number of elements in the score
12296 file names---discarding the @samp{all} elements.
12297
12298 @item gnus-score-find-hierarchical
12299 @findex gnus-score-find-hierarchical
12300 Apply all score files from all the parent groups.  This means that you
12301 can't have score files like @file{all.SCORE}, but you can have
12302 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12303
12304 @end table
12305 This variable can also be a list of functions.  In that case, all these
12306 functions will be called, and all the returned lists of score files will
12307 be applied.  These functions can also return lists of score alists
12308 directly.  In that case, the functions that return these non-file score
12309 alists should probably be placed before the ``real'' score file
12310 functions, to ensure that the last score file returned is the local
12311 score file.  Phu.
12312
12313 @item gnus-score-expiry-days
12314 @vindex gnus-score-expiry-days
12315 This variable says how many days should pass before an unused score file
12316 entry is expired.  If this variable is @code{nil}, no score file entries
12317 are expired.  It's 7 by default.
12318
12319 @item gnus-update-score-entry-dates
12320 @vindex gnus-update-score-entry-dates
12321 If this variable is non-@code{nil}, matching score entries will have
12322 their dates updated.  (This is how Gnus controls expiry---all
12323 non-matching entries will become too old while matching entries will
12324 stay fresh and young.)  However, if you set this variable to @code{nil},
12325 even matching entries will grow old and will have to face that oh-so
12326 grim reaper.
12327
12328 @item gnus-score-after-write-file-function
12329 @vindex gnus-score-after-write-file-function
12330 Function called with the name of the score file just written.
12331
12332 @item gnus-score-thread-simplify
12333 @vindex gnus-score-thread-simplify
12334 If this variable is non-@code{nil}, article subjects will be simplified
12335 for subject scoring purposes in the same manner as with
12336 threading---according to the current value of
12337 gnus-simplify-subject-functions.  If the scoring entry uses
12338 @code{substring} or @code{exact} matching, the match will also be
12339 simplified in this manner.
12340
12341 @end table
12342
12343
12344 @node Score File Format
12345 @section Score File Format
12346 @cindex score file format
12347
12348 A score file is an @code{emacs-lisp} file that normally contains just a
12349 single form.  Casual users are not expected to edit these files;
12350 everything can be changed from the summary buffer.
12351
12352 Anyway, if you'd like to dig into it yourself, here's an example:
12353
12354 @lisp
12355 (("from"
12356   ("Lars Ingebrigtsen" -10000)
12357   ("Per Abrahamsen")
12358   ("larsi\\|lmi" -50000 nil R))
12359  ("subject"
12360   ("Ding is Badd" nil 728373))
12361  ("xref"
12362   ("alt.politics" -1000 728372 s))
12363  ("lines"
12364   (2 -100 nil <))
12365  (mark 0)
12366  (expunge -1000)
12367  (mark-and-expunge -10)
12368  (read-only nil)
12369  (orphan -10)
12370  (adapt t)
12371  (files "/hom/larsi/News/gnu.SCORE")
12372  (exclude-files "all.SCORE")
12373  (local (gnus-newsgroup-auto-expire t)
12374         (gnus-summary-make-false-root empty))
12375  (eval (ding)))
12376 @end lisp
12377
12378 This example demonstrates most score file elements.  For a different
12379 approach, see @pxref{Advanced Scoring}.
12380
12381 Even though this looks much like lisp code, nothing here is actually
12382 @code{eval}ed.  The lisp reader is used to read this form, though, so it
12383 has to be valid syntactically, if not semantically.
12384
12385 Six keys are supported by this alist:
12386
12387 @table @code
12388
12389 @item STRING
12390 If the key is a string, it is the name of the header to perform the
12391 match on.  Scoring can only be performed on these eight headers:
12392 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
12393 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
12394 these headers, there are three strings to tell Gnus to fetch the entire
12395 article and do the match on larger parts of the article: @code{Body}
12396 will perform the match on the body of the article, @code{Head} will
12397 perform the match on the head of the article, and @code{All} will
12398 perform the match on the entire article.  Note that using any of these
12399 last three keys will slow down group entry @emph{considerably}.  The
12400 final ``header'' you can score on is @code{Followup}.  These score
12401 entries will result in new score entries being added for all follow-ups
12402 to articles that matches these score entries.
12403
12404 Following this key is a arbitrary number of score entries, where each
12405 score entry has one to four elements.
12406 @enumerate
12407
12408 @item
12409 The first element is the @dfn{match element}.  On most headers this will
12410 be a string, but on the Lines and Chars headers, this must be an
12411 integer.
12412
12413 @item
12414 If the second element is present, it should be a number---the @dfn{score
12415 element}.  This number should be an integer in the neginf to posinf
12416 interval.  This number is added to the score of the article if the match
12417 is successful.  If this element is not present, the
12418 @code{gnus-score-interactive-default-score} number will be used
12419 instead.  This is 1000 by default.
12420
12421 @item
12422 If the third element is present, it should be a number---the @dfn{date
12423 element}.  This date says when the last time this score entry matched,
12424 which provides a mechanism for expiring the score entries.  It this
12425 element is not present, the score entry is permanent.  The date is
12426 represented by the number of days since December 31, 1 BCE.
12427
12428 @item
12429 If the fourth element is present, it should be a symbol---the @dfn{type
12430 element}.  This element specifies what function should be used to see
12431 whether this score entry matches the article.  What match types that can
12432 be used depends on what header you wish to perform the match on.
12433 @table @dfn
12434
12435 @item From, Subject, References, Xref, Message-ID
12436 For most header types, there are the @code{r} and @code{R} (regexp), as
12437 well as @code{s} and @code{S} (substring) types, and @code{e} and
12438 @code{E} (exact match), and @code{w} (word match) types.  If this
12439 element is not present, Gnus will assume that substring matching should
12440 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
12441 that the matches will be done in a case-sensitive manner.  All these
12442 one-letter types are really just abbreviations for the @code{regexp},
12443 @code{string}, @code{exact}, and @code{word} types, which you can use
12444 instead, if you feel like.
12445
12446 @item Lines, Chars
12447 These two headers use different match types: @code{<}, @code{>},
12448 @code{=}, @code{>=} and @code{<=}.
12449
12450 These predicates are true if
12451
12452 @example
12453 (PREDICATE HEADER MATCH)
12454 @end example
12455
12456 evaluates to non-@code{nil}.  For instance, the advanced match
12457 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
12458 following form:
12459
12460 @lisp
12461 (< header-value 4)
12462 @end lisp
12463
12464 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
12465 the match, we get the score added if the article has less than 4 lines.
12466 (It's easy to get confused and think it's the other way around.  But
12467 it's not.  I think.)
12468
12469 When matching on @code{Lines}, be careful because some backends (like
12470 @code{nndir}) do not generate @code{Lines} header, so every article ends
12471 up being marked as having 0 lines.  This can lead to strange results if
12472 you happen to lower score of the articles with few lines.
12473
12474 @item Date
12475 For the Date header we have three kinda silly match types:
12476 @code{before}, @code{at} and @code{after}.  I can't really imagine this
12477 ever being useful, but, like, it would feel kinda silly not to provide
12478 this function.  Just in case.  You never know.  Better safe than sorry.
12479 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
12480 sex on a first date.  (I have been told that at least one person, and I
12481 quote, ``found this function indispensable'', however.)
12482
12483 @cindex ISO8601
12484 @cindex date
12485 A more useful match type is @code{regexp}.  With it, you can match the
12486 date string using a regular expression.  The date is normalized to
12487 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
12488 you want to match all articles that have been posted on April 1st in
12489 every year, you could use @samp{....0401.........} as a match string,
12490 for instance.  (Note that the date is kept in its original time zone, so
12491 this will match articles that were posted when it was April 1st where
12492 the article was posted from.  Time zones are such wholesome fun for the
12493 whole family, eh?)
12494
12495 @item Head, Body, All
12496 These three match keys use the same match types as the @code{From} (etc)
12497 header uses.
12498
12499 @item Followup
12500 This match key is somewhat special, in that it will match the
12501 @code{From} header, and affect the score of not only the matching
12502 articles, but also all followups to the matching articles.  This allows
12503 you e.g. increase the score of followups to your own articles, or
12504 decrease the score of followups to the articles of some known
12505 trouble-maker.  Uses the same match types as the @code{From} header
12506 uses.  (Using this match key will lead to creation of @file{ADAPT}
12507 files.)
12508
12509 @item Thread
12510 This match key works along the same lines as the @code{Followup} match
12511 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
12512 @samp{thread} match.  This will add a new @samp{thread} match for each
12513 article that has @var{X} in its @code{References} header.  (These new
12514 @samp{thread} matches will use the @code{Message-ID}s of these matching
12515 articles.)  This will ensure that you can raise/lower the score of an
12516 entire thread, even though some articles in the thread may not have
12517 complete @code{References} headers.  Note that using this may lead to
12518 undeterministic scores of the articles in the thread.  (Using this match
12519 key will lead to creation of @file{ADAPT} files.)
12520 @end table
12521 @end enumerate
12522
12523 @cindex Score File Atoms
12524 @item mark
12525 The value of this entry should be a number.  Any articles with a score
12526 lower than this number will be marked as read.
12527
12528 @item expunge
12529 The value of this entry should be a number.  Any articles with a score
12530 lower than this number will be removed from the summary buffer.
12531
12532 @item mark-and-expunge
12533 The value of this entry should be a number.  Any articles with a score
12534 lower than this number will be marked as read and removed from the
12535 summary buffer.
12536
12537 @item thread-mark-and-expunge
12538 The value of this entry should be a number.  All articles that belong to
12539 a thread that has a total score below this number will be marked as read
12540 and removed from the summary buffer.  @code{gnus-thread-score-function}
12541 says how to compute the total score for a thread.
12542
12543 @item files
12544 The value of this entry should be any number of file names.  These files
12545 are assumed to be score files as well, and will be loaded the same way
12546 this one was.
12547
12548 @item exclude-files
12549 The clue of this entry should be any number of files.  These files will
12550 not be loaded, even though they would normally be so, for some reason or
12551 other.
12552
12553 @item eval
12554 The value of this entry will be @code{eval}el.  This element will be
12555 ignored when handling global score files.
12556
12557 @item read-only
12558 Read-only score files will not be updated or saved.  Global score files
12559 should feature this atom (@pxref{Global Score Files}).  (Note:
12560 @dfn{Global} here really means @dfn{global}; not your personal
12561 apply-to-all-groups score files.)
12562
12563 @item orphan
12564 The value of this entry should be a number.  Articles that do not have
12565 parents will get this number added to their scores.  Imagine you follow
12566 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
12567 will only follow a few of the threads, also want to see any new threads.
12568
12569 You can do this with the following two score file entries:
12570
12571 @example
12572         (orphan -500)
12573         (mark-and-expunge -100)
12574 @end example
12575
12576 When you enter the group the first time, you will only see the new
12577 threads.  You then raise the score of the threads that you find
12578 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
12579 rest.  Next time you enter the group, you will see new articles in the
12580 interesting threads, plus any new threads.
12581
12582 I.e.---the orphan score atom is for high-volume groups where there
12583 exist a few interesting threads which can't be found automatically by
12584 ordinary scoring rules.
12585
12586 @item adapt
12587 This entry controls the adaptive scoring.  If it is @code{t}, the
12588 default adaptive scoring rules will be used.  If it is @code{ignore}, no
12589 adaptive scoring will be performed on this group.  If it is a list, this
12590 list will be used as the adaptive scoring rules.  If it isn't present,
12591 or is something other than @code{t} or @code{ignore}, the default
12592 adaptive scoring rules will be used.  If you want to use adaptive
12593 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
12594 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
12595 not want adaptive scoring.  If you only want adaptive scoring in a few
12596 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
12597 insert @code{(adapt t)} in the score files of the groups where you want
12598 it.
12599
12600 @item adapt-file
12601 All adaptive score entries will go to the file named by this entry.  It
12602 will also be applied when entering the group.  This atom might be handy
12603 if you want to adapt on several groups at once, using the same adaptive
12604 file for a number of groups.
12605
12606 @item local
12607 @cindex local variables
12608 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
12609 Each @var{var} will be made buffer-local to the current summary buffer,
12610 and set to the value specified.  This is a convenient, if somewhat
12611 strange, way of setting variables in some groups if you don't like hooks
12612 much.  Note that the @var{value} won't be evaluated.
12613 @end table
12614
12615
12616 @node Score File Editing
12617 @section Score File Editing
12618
12619 You normally enter all scoring commands from the summary buffer, but you
12620 might feel the urge to edit them by hand as well, so we've supplied you
12621 with a mode for that.
12622
12623 It's simply a slightly customized @code{emacs-lisp} mode, with these
12624 additional commands:
12625
12626 @table @kbd
12627
12628 @item C-c C-c
12629 @kindex C-c C-c (Score)
12630 @findex gnus-score-edit-done
12631 Save the changes you have made and return to the summary buffer
12632 (@code{gnus-score-edit-done}).
12633
12634 @item C-c C-d
12635 @kindex C-c C-d (Score)
12636 @findex gnus-score-edit-insert-date
12637 Insert the current date in numerical format
12638 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
12639 you were wondering.
12640
12641 @item C-c C-p
12642 @kindex C-c C-p (Score)
12643 @findex gnus-score-pretty-print
12644 The adaptive score files are saved in an unformatted fashion.  If you
12645 intend to read one of these files, you want to @dfn{pretty print} it
12646 first.  This command (@code{gnus-score-pretty-print}) does that for
12647 you.
12648
12649 @end table
12650
12651 Type @kbd{M-x gnus-score-mode} to use this mode.
12652
12653 @vindex gnus-score-mode-hook
12654 @code{gnus-score-menu-hook} is run in score mode buffers.
12655
12656 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
12657 e} to begin editing score files.
12658
12659
12660 @node Adaptive Scoring
12661 @section Adaptive Scoring
12662 @cindex adaptive scoring
12663
12664 If all this scoring is getting you down, Gnus has a way of making it all
12665 happen automatically---as if by magic.  Or rather, as if by artificial
12666 stupidity, to be precise.
12667
12668 @vindex gnus-use-adaptive-scoring
12669 When you read an article, or mark an article as read, or kill an
12670 article, you leave marks behind.  On exit from the group, Gnus can sniff
12671 these marks and add score elements depending on what marks it finds.
12672 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
12673 @code{t} or @code{(line)}.  If you want score adaptively on separate
12674 words appearing in the subjects, you should set this variable to
12675 @code{(word)}.  If you want to use both adaptive methods, set this
12676 variable to @code{(word line)}.
12677
12678 @vindex gnus-default-adaptive-score-alist
12679 To give you complete control over the scoring process, you can customize
12680 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
12681 might look something like this:
12682
12683 @lisp
12684 (defvar gnus-default-adaptive-score-alist
12685   '((gnus-unread-mark)
12686     (gnus-ticked-mark (from 4))
12687     (gnus-dormant-mark (from 5))
12688     (gnus-del-mark (from -4) (subject -1))
12689     (gnus-read-mark (from 4) (subject 2))
12690     (gnus-expirable-mark (from -1) (subject -1))
12691     (gnus-killed-mark (from -1) (subject -3))
12692     (gnus-kill-file-mark)
12693     (gnus-ancient-mark)
12694     (gnus-low-score-mark)
12695     (gnus-catchup-mark (from -1) (subject -1))))
12696 @end lisp
12697
12698 As you see, each element in this alist has a mark as a key (either a
12699 variable name or a ``real'' mark---a character).  Following this key is
12700 a arbitrary number of header/score pairs.  If there are no header/score
12701 pairs following the key, no adaptive scoring will be done on articles
12702 that have that key as the article mark.  For instance, articles with
12703 @code{gnus-unread-mark} in the example above will not get adaptive score
12704 entries.
12705
12706 Each article can have only one mark, so just a single of these rules
12707 will be applied to each article.
12708
12709 To take @code{gnus-del-mark} as an example---this alist says that all
12710 articles that have that mark (i.e., are marked with @samp{D}) will have a
12711 score entry added to lower based on the @code{From} header by -4, and
12712 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
12713
12714 If you have marked 10 articles with the same subject with
12715 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
12716 That means that that subject will get a score of ten times -1, which
12717 should be, unless I'm much mistaken, -10.
12718
12719 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
12720 the read articles will be marked with the @samp{E} mark.  This'll
12721 probably make adaptive scoring slightly impossible, so auto-expiring and
12722 adaptive scoring doesn't really mix very well.
12723
12724 The headers you can score on are @code{from}, @code{subject},
12725 @code{message-id}, @code{references}, @code{xref}, @code{lines},
12726 @code{chars} and @code{date}.  In addition, you can score on
12727 @code{followup}, which will create an adaptive score entry that matches
12728 on the @code{References} header using the @code{Message-ID} of the
12729 current article, thereby matching the following thread.
12730
12731 You can also score on @code{thread}, which will try to score all
12732 articles that appear in a thread.  @code{thread} matches uses a
12733 @code{Message-ID} to match on the @code{References} header of the
12734 article.  If the match is made, the @code{Message-ID} of the article is
12735 added to the @code{thread} rule.  (Think about it.  I'd recommend two
12736 aspirins afterwards.)
12737
12738 If you use this scheme, you should set the score file atom @code{mark}
12739 to something small---like -300, perhaps, to avoid having small random
12740 changes result in articles getting marked as read.
12741
12742 After using adaptive scoring for a week or so, Gnus should start to
12743 become properly trained and enhance the authors you like best, and kill
12744 the authors you like least, without you having to say so explicitly.
12745
12746 You can control what groups the adaptive scoring is to be performed on
12747 by using the score files (@pxref{Score File Format}).  This will also
12748 let you use different rules in different groups.
12749
12750 @vindex gnus-adaptive-file-suffix
12751 The adaptive score entries will be put into a file where the name is the
12752 group name with @code{gnus-adaptive-file-suffix} appended.  The default
12753 is @samp{ADAPT}.
12754
12755 @vindex gnus-score-exact-adapt-limit
12756 When doing adaptive scoring, substring or fuzzy matching would probably
12757 give you the best results in most cases.  However, if the header one
12758 matches is short, the possibility for false positives is great, so if
12759 the length of the match is less than
12760 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
12761 this variable is @code{nil}, exact matching will always be used to avoid
12762 this problem.
12763
12764 @vindex gnus-default-adaptive-word-score-alist
12765 As mentioned above, you can adapt either on individual words or entire
12766 headers.  If you adapt on words, the
12767 @code{gnus-default-adaptive-word-score-alist} variable says what score
12768 each instance of a word should add given a mark.
12769
12770 @lisp
12771 (setq gnus-default-adaptive-word-score-alist
12772       `((,gnus-read-mark . 30)
12773         (,gnus-catchup-mark . -10)
12774         (,gnus-killed-mark . -20)
12775         (,gnus-del-mark . -15)))
12776 @end lisp
12777
12778 This is the default value.  If you have adaption on words enabled, every
12779 word that appears in subjects of articles marked with
12780 @code{gnus-read-mark} will result in a score rule that increase the
12781 score with 30 points.
12782
12783 @vindex gnus-default-ignored-adaptive-words
12784 @vindex gnus-ignored-adaptive-words
12785 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
12786 will be ignored.  If you wish to add more words to be ignored, use the
12787 @code{gnus-ignored-adaptive-words} list instead.
12788
12789 @vindex gnus-adaptive-word-syntax-table
12790 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
12791 syntax table in effect.  It is similar to the standard syntax table, but
12792 it considers numbers to be non-word-constituent characters.
12793
12794 @vindex gnus-adaptive-word-minimum
12795 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
12796 word scoring process will never bring down the score of an article to
12797 below this number.  The default is @code{nil}.
12798
12799 After using this scheme for a while, it might be nice to write a
12800 @code{gnus-psychoanalyze-user} command to go through the rules and see
12801 what words you like and what words you don't like.  Or perhaps not.
12802
12803 Note that the adaptive word scoring thing is highly experimental and is
12804 likely to change in the future.  Initial impressions seem to indicate
12805 that it's totally useless as it stands.  Some more work (involving more
12806 rigorous statistical methods) will have to be done to make this useful.
12807
12808
12809 @node Home Score File
12810 @section Home Score File
12811
12812 The score file where new score file entries will go is called the
12813 @dfn{home score file}.  This is normally (and by default) the score file
12814 for the group itself.  For instance, the home score file for
12815 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
12816
12817 However, this may not be what you want.  It is often convenient to share
12818 a common home score file among many groups---all @samp{emacs} groups
12819 could perhaps use the same home score file.
12820
12821 @vindex gnus-home-score-file
12822 The variable that controls this is @code{gnus-home-score-file}.  It can
12823 be:
12824
12825 @enumerate
12826 @item
12827 A string.  Then this file will be used as the home score file for all
12828 groups.
12829
12830 @item
12831 A function. The result of this function will be used as the home score
12832 file.  The function will be called with the name of the group as the
12833 parameter.
12834
12835 @item
12836 A list.  The elements in this list can be:
12837
12838 @enumerate
12839 @item
12840 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
12841 the @var{file-name} will will be used as the home score file.
12842
12843 @item
12844 A function. If the function returns non-nil, the result will be used as
12845 the home score file.
12846
12847 @item
12848 A string.  Use the string as the home score file.
12849 @end enumerate
12850
12851 The list will be traversed from the beginning towards the end looking
12852 for matches.
12853
12854 @end enumerate
12855
12856 So, if you want to use just a single score file, you could say:
12857
12858 @lisp
12859 (setq gnus-home-score-file
12860       "my-total-score-file.SCORE")
12861 @end lisp
12862
12863 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
12864 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
12865
12866 @findex gnus-hierarchial-home-score-file
12867 @lisp
12868 (setq gnus-home-score-file
12869       'gnus-hierarchial-home-score-file)
12870 @end lisp
12871
12872 This is a ready-made function provided for your convenience.
12873 Other functions include
12874
12875 @table @code
12876 @item gnus-current-home-score-file
12877 @findex gnus-current-home-score-file
12878 Return the ``current'' regular score file.  This will make scoring
12879 commands add entry to the ``innermost'' matching score file.
12880
12881 @end table
12882
12883 If you want to have one score file for the @samp{emacs} groups and
12884 another for the @samp{comp} groups, while letting all other groups use
12885 their own home score files:
12886
12887 @lisp
12888 (setq gnus-home-score-file
12889       ;; All groups that match the regexp "\\.emacs"
12890       '(("\\.emacs" "emacs.SCORE")
12891         ;; All the comp groups in one score file
12892         ("^comp" "comp.SCORE")))
12893 @end lisp
12894
12895 @vindex gnus-home-adapt-file
12896 @code{gnus-home-adapt-file} works exactly the same way as
12897 @code{gnus-home-score-file}, but says what the home adaptive score file
12898 is instead.  All new adaptive file entries will go into the file
12899 specified by this variable, and the same syntax is allowed.
12900
12901 In addition to using @code{gnus-home-score-file} and
12902 @code{gnus-home-adapt-file}, you can also use group parameters
12903 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
12904 Parameters}) to achieve much the same.  Group and topic parameters take
12905 precedence over this variable.
12906
12907
12908 @node Followups To Yourself
12909 @section Followups To Yourself
12910
12911 Gnus offers two commands for picking out the @code{Message-ID} header in
12912 the current buffer.  Gnus will then add a score rule that scores using
12913 this @code{Message-ID} on the @code{References} header of other
12914 articles.  This will, in effect, increase the score of all articles that
12915 respond to the article in the current buffer.  Quite useful if you want
12916 to easily note when people answer what you've said.
12917
12918 @table @code
12919
12920 @item gnus-score-followup-article
12921 @findex gnus-score-followup-article
12922 This will add a score to articles that directly follow up your own
12923 article.
12924
12925 @item gnus-score-followup-thread
12926 @findex gnus-score-followup-thread
12927 This will add a score to all articles that appear in a thread ``below''
12928 your own article.
12929 @end table
12930
12931 @vindex message-sent-hook
12932 These two functions are both primarily meant to be used in hooks like
12933 @code{message-sent-hook}.
12934
12935 If you look closely at your own @code{Message-ID}, you'll notice that
12936 the first two or three characters are always the same.  Here's two of
12937 mine:
12938
12939 @example
12940 <x6u3u47icf.fsf@@eyesore.no>
12941 <x6sp9o7ibw.fsf@@eyesore.no>
12942 @end example
12943
12944 So ``my'' ident on this machine is @samp{x6}.  This can be
12945 exploited---the following rule will raise the score on all followups to
12946 myself:
12947
12948 @lisp
12949 ("references"
12950  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
12951   1000 nil r))
12952 @end lisp
12953
12954 Whether it's the first two or first three characters that are ``yours''
12955 is system-dependent.
12956
12957
12958 @node Scoring Tips
12959 @section Scoring Tips
12960 @cindex scoring tips
12961
12962 @table @dfn
12963
12964 @item Crossposts
12965 @cindex crossposts
12966 @cindex scoring crossposts
12967 If you want to lower the score of crossposts, the line to match on is
12968 the @code{Xref} header.
12969 @lisp
12970 ("xref" (" talk.politics.misc:" -1000))
12971 @end lisp
12972
12973 @item Multiple crossposts
12974 If you want to lower the score of articles that have been crossposted to
12975 more than, say, 3 groups:
12976 @lisp
12977 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
12978 @end lisp
12979
12980 @item Matching on the body
12981 This is generally not a very good idea---it takes a very long time.
12982 Gnus actually has to fetch each individual article from the server.  But
12983 you might want to anyway, I guess.  Even though there are three match
12984 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
12985 and stick with it in each score file.  If you use any two, each article
12986 will be fetched @emph{twice}.  If you want to match a bit on the
12987 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
12988 the matches.
12989
12990 @item Marking as read
12991 You will probably want to mark articles that has a score below a certain
12992 number as read.  This is most easily achieved by putting the following
12993 in your @file{all.SCORE} file:
12994 @lisp
12995 ((mark -100))
12996 @end lisp
12997 You may also consider doing something similar with @code{expunge}.
12998
12999 @item Negated character classes
13000 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
13001 That will match newlines, which might lead to, well, The Unknown.  Say
13002 @code{[^abcd\n]*} instead.
13003 @end table
13004
13005
13006 @node Reverse Scoring
13007 @section Reverse Scoring
13008 @cindex reverse scoring
13009
13010 If you want to keep just articles that have @samp{Sex with Emacs} in the
13011 subject header, and expunge all other articles, you could put something
13012 like this in your score file:
13013
13014 @lisp
13015 (("subject"
13016   ("Sex with Emacs" 2))
13017  (mark 1)
13018  (expunge 1))
13019 @end lisp
13020
13021 So, you raise all articles that match @samp{Sex with Emacs} and mark the
13022 rest as read, and expunge them to boot.
13023
13024
13025 @node Global Score Files
13026 @section Global Score Files
13027 @cindex global score files
13028
13029 Sure, other newsreaders have ``global kill files''.  These are usually
13030 nothing more than a single kill file that applies to all groups, stored
13031 in the user's home directory.  Bah!  Puny, weak newsreaders!
13032
13033 What I'm talking about here are Global Score Files.  Score files from
13034 all over the world, from users everywhere, uniting all nations in one
13035 big, happy score file union!  Ange-score!  New and untested!
13036
13037 @vindex gnus-global-score-files
13038 All you have to do to use other people's score files is to set the
13039 @code{gnus-global-score-files} variable.  One entry for each score file,
13040 or each score file directory.  Gnus will decide by itself what score
13041 files are applicable to which group.
13042
13043 Say you want to use the score file
13044 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
13045 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
13046
13047 @lisp
13048 (setq gnus-global-score-files
13049       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
13050         "/ftp@@ftp.some-where:/pub/score/"))
13051 @end lisp
13052
13053 @findex gnus-score-search-global-directories
13054 Simple, eh?  Directory names must end with a @samp{/}.  These
13055 directories are typically scanned only once during each Gnus session.
13056 If you feel the need to manually re-scan the remote directories, you can
13057 use the @code{gnus-score-search-global-directories} command.
13058
13059 Note that, at present, using this option will slow down group entry
13060 somewhat.  (That is---a lot.)
13061
13062 If you want to start maintaining score files for other people to use,
13063 just put your score file up for anonymous ftp and announce it to the
13064 world.  Become a retro-moderator!  Participate in the retro-moderator
13065 wars sure to ensue, where retro-moderators battle it out for the
13066 sympathy of the people, luring them to use their score files on false
13067 premises!  Yay!  The net is saved!
13068
13069 Here are some tips for the would-be retro-moderator, off the top of my
13070 head:
13071
13072 @itemize @bullet
13073
13074 @item
13075 Articles heavily crossposted are probably junk.
13076 @item
13077 To lower a single inappropriate article, lower by @code{Message-ID}.
13078 @item
13079 Particularly brilliant authors can be raised on a permanent basis.
13080 @item
13081 Authors that repeatedly post off-charter for the group can safely be
13082 lowered out of existence.
13083 @item
13084 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
13085 articles completely.
13086
13087 @item
13088 Use expiring score entries to keep the size of the file down.  You
13089 should probably have a long expiry period, though, as some sites keep
13090 old articles for a long time.
13091 @end itemize
13092
13093 ... I wonder whether other newsreaders will support global score files
13094 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
13095 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
13096 holding our breath yet?
13097
13098
13099 @node Kill Files
13100 @section Kill Files
13101 @cindex kill files
13102
13103 Gnus still supports those pesky old kill files.  In fact, the kill file
13104 entries can now be expiring, which is something I wrote before Daniel
13105 Quinlan thought of doing score files, so I've left the code in there.
13106
13107 In short, kill processing is a lot slower (and I do mean @emph{a lot})
13108 than score processing, so it might be a good idea to rewrite your kill
13109 files into score files.
13110
13111 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
13112 forms into this file, which means that you can use kill files as some
13113 sort of primitive hook function to be run on group entry, even though
13114 that isn't a very good idea.
13115
13116 Normal kill files look like this:
13117
13118 @lisp
13119 (gnus-kill "From" "Lars Ingebrigtsen")
13120 (gnus-kill "Subject" "ding")
13121 (gnus-expunge "X")
13122 @end lisp
13123
13124 This will mark every article written by me as read, and remove the
13125 marked articles from the summary buffer.  Very useful, you'll agree.
13126
13127 Other programs use a totally different kill file syntax.  If Gnus
13128 encounters what looks like a @code{rn} kill file, it will take a stab at
13129 interpreting it.
13130
13131 Two summary functions for editing a GNUS kill file:
13132
13133 @table @kbd
13134
13135 @item M-k
13136 @kindex M-k (Summary)
13137 @findex gnus-summary-edit-local-kill
13138 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
13139
13140 @item M-K
13141 @kindex M-K (Summary)
13142 @findex gnus-summary-edit-global-kill
13143 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
13144 @end table
13145
13146 Two group mode functions for editing the kill files:
13147
13148 @table @kbd
13149
13150 @item M-k
13151 @kindex M-k (Group)
13152 @findex gnus-group-edit-local-kill
13153 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
13154
13155 @item M-K
13156 @kindex M-K (Group)
13157 @findex gnus-group-edit-global-kill
13158 Edit the general kill file (@code{gnus-group-edit-global-kill}).
13159 @end table
13160
13161 Kill file variables:
13162
13163 @table @code
13164 @item gnus-kill-file-name
13165 @vindex gnus-kill-file-name
13166 A kill file for the group @samp{soc.motss} is normally called
13167 @file{soc.motss.KILL}.  The suffix appended to the group name to get
13168 this file name is detailed by the @code{gnus-kill-file-name} variable.
13169 The ``global'' kill file (not in the score file sense of ``global'', of
13170 course) is just called @file{KILL}.
13171
13172 @vindex gnus-kill-save-kill-file
13173 @item gnus-kill-save-kill-file
13174 If this variable is non-@code{nil}, Gnus will save the
13175 kill file after processing, which is necessary if you use expiring
13176 kills.
13177
13178 @item gnus-apply-kill-hook
13179 @vindex gnus-apply-kill-hook
13180 @findex gnus-apply-kill-file-unless-scored
13181 @findex gnus-apply-kill-file
13182 A hook called to apply kill files to a group.  It is
13183 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
13184 kill file if you have a score file for the same group, you can set this
13185 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
13186 kill files to be processed, you should set this variable to @code{nil}.
13187
13188 @item gnus-kill-file-mode-hook
13189 @vindex gnus-kill-file-mode-hook
13190 A hook called in kill-file mode buffers.
13191
13192 @end table
13193
13194
13195 @node Converting Kill Files
13196 @section Converting Kill Files
13197 @cindex kill files
13198 @cindex converting kill files
13199
13200 If you have loads of old kill files, you may want to convert them into
13201 score files.  If they are ``regular'', you can use
13202 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
13203 by hand.
13204
13205 The kill to score conversion package isn't included in Gnus by default.
13206 You can fetch it from
13207 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
13208
13209 If your old kill files are very complex---if they contain more
13210 non-@code{gnus-kill} forms than not, you'll have to convert them by
13211 hand.  Or just let them be as they are.  Gnus will still use them as
13212 before.
13213
13214
13215 @node GroupLens
13216 @section GroupLens
13217 @cindex GroupLens
13218
13219 GroupLens is a collaborative filtering system that helps you work
13220 together with other people to find the quality news articles out of the
13221 huge volume of news articles generated every day.
13222
13223 To accomplish this the GroupLens system combines your opinions about
13224 articles you have already read with the opinions of others who have done
13225 likewise and gives you a personalized prediction for each unread news
13226 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
13227 rate articles, and finds other people that rate articles the same way.
13228 Once it has found some people you agree with it tells you, in the form
13229 of a prediction, what they thought of the article.  You can use this
13230 prediction to help you decide whether or not you want to read the
13231 article.
13232
13233 @menu
13234 * Using GroupLens::          How to make Gnus use GroupLens.
13235 * Rating Articles::          Letting GroupLens know how you rate articles.
13236 * Displaying Predictions::   Displaying predictions given by GroupLens.
13237 * GroupLens Variables::      Customizing GroupLens.
13238 @end menu
13239
13240
13241 @node Using GroupLens
13242 @subsection Using GroupLens
13243
13244 To use GroupLens you must register a pseudonym with your local Better
13245 Bit Bureau (BBB).
13246 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
13247 better bit in town at the moment.
13248
13249 Once you have registered you'll need to set a couple of variables.
13250
13251 @table @code
13252
13253 @item gnus-use-grouplens
13254 @vindex gnus-use-grouplens
13255 Setting this variable to a non-@code{nil} value will make Gnus hook into
13256 all the relevant GroupLens functions.
13257
13258 @item grouplens-pseudonym
13259 @vindex grouplens-pseudonym
13260 This variable should be set to the pseudonym you got when registering
13261 with the Better Bit Bureau.
13262
13263 @item grouplens-newsgroups
13264 @vindex grouplens-newsgroups
13265 A list of groups that you want to get GroupLens predictions for.
13266
13267 @end table
13268
13269 That's the minimum of what you need to get up and running with GroupLens.
13270 Once you've registered, GroupLens will start giving you scores for
13271 articles based on the average of what other people think.  But, to get
13272 the real benefit of GroupLens you need to start rating articles
13273 yourself.  Then the scores GroupLens gives you will be personalized for
13274 you, based on how the people you usually agree with have already rated.
13275
13276
13277 @node Rating Articles
13278 @subsection Rating Articles
13279
13280 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
13281 Where 1 means something like this article is a waste of bandwidth and 5
13282 means that the article was really good.  The basic question to ask
13283 yourself is, "on a scale from 1 to 5 would I like to see more articles
13284 like this one?"
13285
13286 There are four ways to enter a rating for an article in GroupLens.
13287
13288 @table @kbd
13289
13290 @item r
13291 @kindex r (GroupLens)
13292 @findex bbb-summary-rate-article
13293 This function will prompt you for a rating on a scale of one to five.
13294
13295 @item k
13296 @kindex k (GroupLens)
13297 @findex grouplens-score-thread
13298 This function will prompt you for a rating, and rate all the articles in
13299 the thread.  This is really useful for some of those long running giant
13300 threads in rec.humor.
13301
13302 @end table
13303
13304 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13305 the score of the article you're reading.
13306
13307 @table @kbd
13308
13309 @item 1-5 n
13310 @kindex n (GroupLens)
13311 @findex grouplens-next-unread-article
13312 Rate the article and go to the next unread article.
13313
13314 @item 1-5 ,
13315 @kindex , (GroupLens)
13316 @findex grouplens-best-unread-article
13317 Rate the article and go to the next unread article with the highest score.
13318
13319 @end table
13320
13321 If you want to give the current article a score of 4 and then go to the
13322 next article, just type @kbd{4 n}.
13323
13324
13325 @node Displaying Predictions
13326 @subsection Displaying Predictions
13327
13328 GroupLens makes a prediction for you about how much you will like a
13329 news article.  The predictions from GroupLens are on a scale from 1 to
13330 5, where 1 is the worst and 5 is the best.  You can use the predictions
13331 from GroupLens in one of three ways controlled by the variable
13332 @code{gnus-grouplens-override-scoring}.
13333
13334 @vindex gnus-grouplens-override-scoring
13335 There are three ways to display predictions in grouplens.  You may
13336 choose to have the GroupLens scores contribute to, or override the
13337 regular gnus scoring mechanism. override is the default; however, some
13338 people prefer to see the Gnus scores plus the grouplens scores.  To get
13339 the separate scoring behavior you need to set
13340 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
13341 GroupLens predictions combined with the grouplens scores set it to
13342 @code{'override} and to combine the scores set
13343 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
13344 the combine option you will also want to set the values for
13345 @code{grouplens-prediction-offset} and
13346 @code{grouplens-score-scale-factor}.
13347
13348 @vindex grouplens-prediction-display
13349 In either case, GroupLens gives you a few choices for how you would like
13350 to see your predictions displayed.  The display of predictions is
13351 controlled by the @code{grouplens-prediction-display} variable.
13352
13353 The following are valid values for that variable.
13354
13355 @table @code
13356 @item prediction-spot
13357 The higher the prediction, the further to the right an @samp{*} is
13358 displayed.
13359
13360 @item confidence-interval
13361 A numeric confidence interval.
13362
13363 @item prediction-bar
13364 The higher the prediction, the longer the bar.
13365
13366 @item confidence-bar
13367 Numerical confidence.
13368
13369 @item confidence-spot
13370 The spot gets bigger with more confidence.
13371
13372 @item prediction-num
13373 Plain-old numeric value.
13374
13375 @item confidence-plus-minus
13376 Prediction +/- confidence.
13377
13378 @end table
13379
13380
13381 @node GroupLens Variables
13382 @subsection GroupLens Variables
13383
13384 @table @code
13385
13386 @item gnus-summary-grouplens-line-format
13387 The summary line format used in GroupLens-enhanced summary buffers.  It
13388 accepts the same specs as the normal summary line format (@pxref{Summary
13389 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
13390 %s\n}.
13391
13392 @item grouplens-bbb-host
13393 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
13394 default.
13395
13396 @item grouplens-bbb-port
13397 Port of the host running the bbbd server.  The default is 9000.
13398
13399 @item grouplens-score-offset
13400 Offset the prediction by this value.  In other words, subtract the
13401 prediction value by this number to arrive at the effective score.  The
13402 default is 0.
13403
13404 @item grouplens-score-scale-factor
13405 This variable allows the user to magnify the effect of GroupLens scores.
13406 The scale factor is applied after the offset.  The default is 1.
13407
13408 @end table
13409
13410
13411 @node Advanced Scoring
13412 @section Advanced Scoring
13413
13414 Scoring on Subjects and From headers is nice enough, but what if you're
13415 really interested in what a person has to say only when she's talking
13416 about a particular subject?  Or what if you really don't want to
13417 read what person A has to say when she's following up to person B, but
13418 want to read what she says when she's following up to person C?
13419
13420 By using advanced scoring rules you may create arbitrarily complex
13421 scoring patterns.
13422
13423 @menu
13424 * Advanced Scoring Syntax::     A definition.
13425 * Advanced Scoring Examples::   What they look like.
13426 * Advanced Scoring Tips::       Getting the most out of it.
13427 @end menu
13428
13429
13430 @node Advanced Scoring Syntax
13431 @subsection Advanced Scoring Syntax
13432
13433 Ordinary scoring rules have a string as the first element in the rule.
13434 Advanced scoring rules have a list as the first element.  The second
13435 element is the score to be applied if the first element evaluated to a
13436 non-@code{nil} value.
13437
13438 These lists may consist of three logical operators, one redirection
13439 operator, and various match operators.
13440
13441 Logical operators:
13442
13443 @table @code
13444 @item &
13445 @itemx and
13446 This logical operator will evaluate each of its arguments until it finds
13447 one that evaluates to @code{false}, and then it'll stop.  If all arguments
13448 evaluate to @code{true} values, then this operator will return
13449 @code{true}.
13450
13451 @item |
13452 @itemx or
13453 This logical operator will evaluate each of its arguments until it finds
13454 one that evaluates to @code{true}.  If no arguments are @code{true},
13455 then this operator will return @code{false}.
13456
13457 @item !
13458 @itemx not
13459 @itemx Â¬
13460 This logical operator only takes a single argument.  It returns the
13461 logical negation of the value of its argument.
13462
13463 @end table
13464
13465 There is an @dfn{indirection operator} that will make its arguments
13466 apply to the ancestors of the current article being scored.  For
13467 instance, @code{1-} will make score rules apply to the parent of the
13468 current article.  @code{2-} will make score rules apply to the
13469 grandparent of the current article.  Alternatively, you can write
13470 @code{^^}, where the number of @code{^}s (carets) says how far back into
13471 the ancestry you want to go.
13472
13473 Finally, we have the match operators.  These are the ones that do the
13474 real work.  Match operators are header name strings followed by a match
13475 and a match type.  A typical match operator looks like @samp{("from"
13476 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
13477 simple scoring, and the match types are also the same.
13478
13479
13480 @node Advanced Scoring Examples
13481 @subsection Advanced Scoring Examples
13482
13483 Let's say you want to increase the score of articles written by Lars
13484 when he's talking about Gnus:
13485
13486 @example
13487 ((&
13488   ("from" "Lars Ingebrigtsen")
13489   ("subject" "Gnus"))
13490  1000)
13491 @end example
13492
13493 Quite simple, huh?
13494
13495 When he writes long articles, he sometimes has something nice to say:
13496
13497 @example
13498 ((&
13499   ("from" "Lars Ingebrigtsen")
13500   (|
13501    ("subject" "Gnus")
13502    ("lines" 100 >)))
13503  1000)
13504 @end example
13505
13506 However, when he responds to things written by Reig Eigil Logge, you
13507 really don't want to read what he's written:
13508
13509 @example
13510 ((&
13511   ("from" "Lars Ingebrigtsen")
13512   (1- ("from" "Reig Eigir Logge")))
13513  -100000)
13514 @end example
13515
13516 Everybody that follows up Redmondo when he writes about disappearing
13517 socks should have their scores raised, but only when they talk about
13518 white socks.  However, when Lars talks about socks, it's usually not
13519 very interesting:
13520
13521 @example
13522 ((&
13523   (1-
13524    (&
13525     ("from" "redmondo@@.*no" r)
13526     ("body" "disappearing.*socks" t)))
13527   (! ("from" "Lars Ingebrigtsen"))
13528   ("body" "white.*socks"))
13529  1000)
13530 @end example
13531
13532 The possibilities are endless.
13533
13534
13535 @node Advanced Scoring Tips
13536 @subsection Advanced Scoring Tips
13537
13538 The @code{&} and @code{|} logical operators do short-circuit logic.
13539 That is, they stop processing their arguments when it's clear what the
13540 result of the operation will be.  For instance, if one of the arguments
13541 of an @code{&} evaluates to @code{false}, there's no point in evaluating
13542 the rest of the arguments.  This means that you should put slow matches
13543 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
13544 @samp{subject}) first.
13545
13546 The indirection arguments (@code{1-} and so on) will make their
13547 arguments work on previous generations of the thread.  If you say
13548 something like:
13549
13550 @example
13551 ...
13552 (1-
13553  (1-
13554   ("from" "lars")))
13555 ...
13556 @end example
13557
13558 Then that means "score on the from header of the grandparent of the
13559 current article".  An indirection is quite fast, but it's better to say:
13560
13561 @example
13562 (1-
13563  (&
13564   ("from" "Lars")
13565   ("subject" "Gnus")))
13566 @end example
13567
13568 than it is to say:
13569
13570 @example
13571 (&
13572  (1- ("from" "Lars"))
13573  (1- ("subject" "Gnus")))
13574 @end example
13575
13576
13577 @node Score Decays
13578 @section Score Decays
13579 @cindex score decays
13580 @cindex decays
13581
13582 You may find that your scores have a tendency to grow without
13583 bounds, especially if you're using adaptive scoring.  If scores get too
13584 big, they lose all meaning---they simply max out and it's difficult to
13585 use them in any sensible way.
13586
13587 @vindex gnus-decay-scores
13588 @findex gnus-decay-score
13589 @vindex gnus-decay-score-function
13590 Gnus provides a mechanism for decaying scores to help with this problem.
13591 When score files are loaded and @code{gnus-decay-scores} is
13592 non-@code{nil}, Gnus will run the score files through the decaying
13593 mechanism thereby lowering the scores of all non-permanent score rules.
13594 The decay itself if performed by the @code{gnus-decay-score-function}
13595 function, which is @code{gnus-decay-score} by default.  Here's the
13596 definition of that function:
13597
13598 @lisp
13599 (defun gnus-decay-score (score)
13600   "Decay SCORE.
13601 This is done according to `gnus-score-decay-constant'
13602 and `gnus-score-decay-scale'."
13603   (floor
13604    (- score
13605       (* (if (< score 0) 1 -1)
13606          (min (abs score)
13607               (max gnus-score-decay-constant
13608                    (* (abs score)
13609                       gnus-score-decay-scale)))))))
13610 @end lisp
13611
13612 @vindex gnus-score-decay-scale
13613 @vindex gnus-score-decay-constant
13614 @code{gnus-score-decay-constant} is 3 by default and
13615 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
13616
13617 @enumerate
13618 @item
13619 Scores between -3 and 3 will be set to 0 when this function is called.
13620
13621 @item
13622 Scores with magnitudes between 3 and 60 will be shrunk by 3.
13623
13624 @item
13625 Scores with magnitudes greater than 60 will be shrunk by 5% of the
13626 score.
13627 @end enumerate
13628
13629 If you don't like this decay function, write your own.  It is called
13630 with the score to be decayed as its only parameter, and it should return
13631 the new score, which should be an integer.
13632
13633 Gnus will try to decay scores once a day.  If you haven't run Gnus for
13634 four days, Gnus will decay the scores four times, for instance.
13635
13636
13637 @node Various
13638 @chapter Various
13639
13640 @menu
13641 * Process/Prefix::             A convention used by many treatment commands.
13642 * Interactive::                Making Gnus ask you many questions.
13643 * Symbolic Prefixes::          How to supply some Gnus functions with options.
13644 * Formatting Variables::       You can specify what buffers should look like.
13645 * Windows Configuration::      Configuring the Gnus buffer windows.
13646 * Faces and Fonts::            How to change how faces look.
13647 * Compilation::                How to speed Gnus up.
13648 * Mode Lines::                 Displaying information in the mode lines.
13649 * Highlighting and Menus::     Making buffers look all nice and cozy.
13650 * Buttons::                    Get tendonitis in ten easy steps!
13651 * Daemons::                    Gnus can do things behind your back.
13652 * NoCeM::                      How to avoid spam and other fatty foods.
13653 * Undo::                       Some actions can be undone.
13654 * Moderation::                 What to do if you're a moderator.
13655 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
13656 * Fuzzy Matching::             What's the big fuzz?
13657 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
13658 * Various Various::            Things that are really various.
13659 @end menu
13660
13661
13662 @node Process/Prefix
13663 @section Process/Prefix
13664 @cindex process/prefix convention
13665
13666 Many functions, among them functions for moving, decoding and saving
13667 articles, use what is known as the @dfn{Process/Prefix convention}.
13668
13669 This is a method for figuring out what articles the user wants the
13670 command to be performed on.
13671
13672 It goes like this:
13673
13674 If the numeric prefix is N, perform the operation on the next N
13675 articles, starting with the current one.  If the numeric prefix is
13676 negative, perform the operation on the previous N articles, starting
13677 with the current one.
13678
13679 @vindex transient-mark-mode
13680 If @code{transient-mark-mode} in non-@code{nil} and the region is
13681 active, all articles in the region will be worked upon.
13682
13683 If there is no numeric prefix, but some articles are marked with the
13684 process mark, perform the operation on the articles marked with
13685 the process mark.
13686
13687 If there is neither a numeric prefix nor any articles marked with the
13688 process mark, just perform the operation on the current article.
13689
13690 Quite simple, really, but it needs to be made clear so that surprises
13691 are avoided.
13692
13693 Commands that react to the process mark will push the current list of
13694 process marked articles onto a stack and will then clear all process
13695 marked articles.  You can restore the previous configuration with the
13696 @kbd{M P y} command (@pxref{Setting Process Marks}).
13697
13698 @vindex gnus-summary-goto-unread
13699 One thing that seems to shock & horrify lots of people is that, for
13700 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
13701 Since each @kbd{d} (which marks the current article as read) by default
13702 goes to the next unread article after marking, this means that @kbd{3 d}
13703 will mark the next three unread articles as read, no matter what the
13704 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
13705 @code{nil} for a more straightforward action.
13706
13707
13708 @node Interactive
13709 @section Interactive
13710 @cindex interaction
13711
13712 @table @code
13713
13714 @item gnus-novice-user
13715 @vindex gnus-novice-user
13716 If this variable is non-@code{nil}, you are either a newcomer to the
13717 World of Usenet, or you are very cautious, which is a nice thing to be,
13718 really.  You will be given questions of the type ``Are you sure you want
13719 to do this?'' before doing anything dangerous.  This is @code{t} by
13720 default.
13721
13722 @item gnus-expert-user
13723 @vindex gnus-expert-user
13724 If this variable is non-@code{nil}, you will seldom be asked any
13725 questions by Gnus.  It will simply assume you know what you're doing, no
13726 matter how strange.
13727
13728 @item gnus-interactive-catchup
13729 @vindex gnus-interactive-catchup
13730 Require confirmation before catching up a group if non-@code{nil}.  It
13731 is @code{t} by default.
13732
13733 @item gnus-interactive-exit
13734 @vindex gnus-interactive-exit
13735 Require confirmation before exiting Gnus.  This variable is @code{t} by
13736 default.
13737 @end table
13738
13739
13740 @node Symbolic Prefixes
13741 @section Symbolic Prefixes
13742 @cindex symbolic prefixes
13743
13744 Quite a lot of Emacs commands react to the (numeric) prefix.  For
13745 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
13746 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
13747 rule of 900 to the current article.
13748
13749 This is all nice and well, but what if you want to give a command some
13750 additional information?  Well, what most commands do is interpret the
13751 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
13752 doesn't want a backup file to be created when saving the current buffer,
13753 for instance.  But what if you want to save without making a backup
13754 file, and you want Emacs to flash lights and play a nice tune at the
13755 same time?  You can't, and you're probably perfectly happy that way.
13756
13757 @kindex M-i (Summary)
13758 @findex gnus-symbolic-argument
13759 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
13760 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
13761 character typed in is the value.  You can stack as many @kbd{M-i}
13762 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
13763 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
13764 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
13765 @code{b}''.  You get the drift.
13766
13767 Typing in symbolic prefixes to commands that don't accept them doesn't
13768 hurt, but it doesn't do any good either.  Currently not many Gnus
13769 functions make use of the symbolic prefix.
13770
13771 If you're interested in how Gnus implements this, @pxref{Extended
13772 Interactive}.
13773
13774
13775 @node Formatting Variables
13776 @section Formatting Variables
13777 @cindex formatting variables
13778
13779 Throughout this manual you've probably noticed lots of variables called
13780 things like @code{gnus-group-line-format} and
13781 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
13782 output lines in the various buffers.  There's quite a lot of them.
13783 Fortunately, they all use the same syntax, so there's not that much to
13784 be annoyed by.
13785
13786 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
13787 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
13788 lots of percentages everywhere.
13789
13790 @menu
13791 * Formatting Basics::     A formatting variable is basically a format string.
13792 * Mode Line Formatting::  Some rules about mode line formatting variables.
13793 * Advanced Formatting::   Modifying output in various ways.
13794 * User-Defined Specs::    Having Gnus call your own functions.
13795 * Formatting Fonts::      Making the formatting look colorful and nice.
13796 @end menu
13797
13798 Currently Gnus uses the following formatting variables:
13799 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
13800 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
13801 @code{gnus-group-mode-line-format},
13802 @code{gnus-summary-mode-line-format},
13803 @code{gnus-article-mode-line-format},
13804 @code{gnus-server-mode-line-format}, and
13805 @code{gnus-summary-pick-line-format}.
13806
13807 All these format variables can also be arbitrary elisp forms.  In that
13808 case, they will be @code{eval}ed to insert the required lines.
13809
13810 @kindex M-x gnus-update-format
13811 @findex gnus-update-format
13812 Gnus includes a command to help you while creating your own format
13813 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
13814 update the spec in question and pop you to a buffer where you can
13815 examine the resulting lisp code to be run to generate the line.
13816
13817
13818
13819 @node Formatting Basics
13820 @subsection Formatting Basics
13821
13822 Each @samp{%} element will be replaced by some string or other when the
13823 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
13824 spec, and pad with spaces to get a 5-character field''.
13825
13826 As with normal C and Emacs Lisp formatting strings, the numerical
13827 modifier between the @samp{%} and the formatting type character will
13828 @dfn{pad} the output so that it is always at least that long.
13829 @samp{%5y} will make the field always (at least) five characters wide by
13830 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
13831 the right instead.
13832
13833 You may also wish to limit the length of the field to protect against
13834 particularly wide values.  For that you can say @samp{%4,6y}, which
13835 means that the field will never be more than 6 characters wide and never
13836 less than 4 characters wide.
13837
13838
13839 @node Mode Line Formatting
13840 @subsection Mode Line Formatting
13841
13842 Mode line formatting variables (e.g.,
13843 @code{gnus-summary-mode-line-format}) follow the same rules as other,
13844 buffer line oriented formatting variables (@pxref{Formatting Basics})
13845 with the following two differences:
13846
13847 @enumerate
13848
13849 @item
13850 There must be no newline (@samp{\n}) at the end.
13851
13852 @item
13853 The special @samp{%%b} spec can be used to display the buffer name.
13854 Well, it's no spec at all, really---@samp{%%} is just a way to quote
13855 @samp{%} to allow it to pass through the formatting machinery unmangled,
13856 so that Emacs receives @samp{%b}, which is something the Emacs mode line
13857 display interprets to mean ``show the buffer name''.  For a full list of
13858 mode line specs Emacs understands, see the documentation of the
13859 @code{mode-line-format} variable.
13860
13861 @end enumerate
13862
13863
13864 @node Advanced Formatting
13865 @subsection Advanced Formatting
13866
13867 It is frequently useful to post-process the fields in some way.
13868 Padding, limiting, cutting off parts and suppressing certain values can
13869 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
13870 look like @samp{%~(cut 3)~(ignore "0")y}.
13871
13872 These are the valid modifiers:
13873
13874 @table @code
13875 @item pad
13876 @itemx pad-left
13877 Pad the field to the left with spaces until it reaches the required
13878 length.
13879
13880 @item pad-right
13881 Pad the field to the right with spaces until it reaches the required
13882 length.
13883
13884 @item max
13885 @itemx max-left
13886 Cut off characters from the left until it reaches the specified length.
13887
13888 @item max-right
13889 Cut off characters from the right until it reaches the specified
13890 length.
13891
13892 @item cut
13893 @itemx cut-left
13894 Cut off the specified number of characters from the left.
13895
13896 @item cut-right
13897 Cut off the specified number of characters from the right.
13898
13899 @item ignore
13900 Return an empty string if the field is equal to the specified value.
13901
13902 @item form
13903 Use the specified form as the field value when the @samp{@@} spec is
13904 used.
13905 @end table
13906
13907 Let's take an example.  The @samp{%o} spec in the summary mode lines
13908 will return a date in compact ISO8601 format---@samp{19960809T230410}.
13909 This is quite a mouthful, so we want to shave off the century number and
13910 the time, leaving us with a six-character date.  That would be
13911 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
13912 maxing, and we need the padding to ensure that the date is never less
13913 than 6 characters to make it look nice in columns.)
13914
13915 Ignoring is done first; then cutting; then maxing; and then as the very
13916 last operation, padding.
13917
13918 If you use lots of these advanced thingies, you'll find that Gnus gets
13919 quite slow.  This can be helped enormously by running @kbd{M-x
13920 gnus-compile} when you are satisfied with the look of your lines.
13921 @xref{Compilation}.
13922
13923
13924 @node User-Defined Specs
13925 @subsection User-Defined Specs
13926
13927 All the specs allow for inserting user defined specifiers---@samp{u}.
13928 The next character in the format string should be a letter.  Gnus
13929 will call the function @code{gnus-user-format-function-}@samp{X}, where
13930 @samp{X} is the letter following @samp{%u}.  The function will be passed
13931 a single parameter---what the parameter means depends on what buffer
13932 it's being called from.  The function should return a string, which will
13933 be inserted into the buffer just like information from any other
13934 specifier.  This function may also be called with dummy values, so it
13935 should protect against that.
13936
13937 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
13938 much the same without defining new functions.  Here's an example:
13939 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
13940 given here will be evaluated to yield the current line number, and then
13941 inserted.
13942
13943
13944 @node Formatting Fonts
13945 @subsection Formatting Fonts
13946
13947 There are specs for highlighting, and these are shared by all the format
13948 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
13949 the special @code{mouse-face} property set, which means that it will be
13950 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
13951 over it.
13952
13953 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
13954 normal faces set using @code{gnus-face-0}, which is @code{bold} by
13955 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
13956 and so on.  Create as many faces as you wish.  The same goes for the
13957 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
13958 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
13959
13960 Here's an alternative recipe for the group buffer:
13961
13962 @lisp
13963 ;; Create three face types.
13964 (setq gnus-face-1 'bold)
13965 (setq gnus-face-3 'italic)
13966
13967 ;; We want the article count to be in
13968 ;; a bold and green face.  So we create
13969 ;; a new face called `my-green-bold'.
13970 (copy-face 'bold 'my-green-bold)
13971 ;; Set the color.
13972 (set-face-foreground 'my-green-bold "ForestGreen")
13973 (setq gnus-face-2 'my-green-bold)
13974
13975 ;; Set the new & fancy format.
13976 (setq gnus-group-line-format
13977       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
13978 @end lisp
13979
13980 I'm sure you'll be able to use this scheme to create totally unreadable
13981 and extremely vulgar displays.  Have fun!
13982
13983 Note that the @samp{%(} specs (and friends) do not make any sense on the
13984 mode-line variables.
13985
13986
13987 @node Windows Configuration
13988 @section Windows Configuration
13989 @cindex windows configuration
13990
13991 No, there's nothing here about X, so be quiet.
13992
13993 @vindex gnus-use-full-window
13994 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
13995 other windows and occupy the entire Emacs screen by itself.  It is
13996 @code{t} by default.
13997
13998 @vindex gnus-buffer-configuration
13999 @code{gnus-buffer-configuration} describes how much space each Gnus
14000 buffer should be given.  Here's an excerpt of this variable:
14001
14002 @lisp
14003 ((group (vertical 1.0 (group 1.0 point)
14004                       (if gnus-carpal (group-carpal 4))))
14005  (article (vertical 1.0 (summary 0.25 point)
14006                         (article 1.0))))
14007 @end lisp
14008
14009 This is an alist.  The @dfn{key} is a symbol that names some action or
14010 other.  For instance, when displaying the group buffer, the window
14011 configuration function will use @code{group} as the key.  A full list of
14012 possible names is listed below.
14013
14014 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
14015 should occupy.  To take the @code{article} split as an example -
14016
14017 @lisp
14018 (article (vertical 1.0 (summary 0.25 point)
14019                        (article 1.0)))
14020 @end lisp
14021
14022 This @dfn{split} says that the summary buffer should occupy 25% of upper
14023 half of the screen, and that it is placed over the article buffer.  As
14024 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
14025 reaching for that calculator there).  However, the special number
14026 @code{1.0} is used to signal that this buffer should soak up all the
14027 rest of the space available after the rest of the buffers have taken
14028 whatever they need.  There should be only one buffer with the @code{1.0}
14029 size spec per split.
14030
14031 Point will be put in the buffer that has the optional third element
14032 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
14033 split where the tag @code{frame-focus} is a member (i.e. is the third or
14034 fourth element in the list, depending on whether the @code{point} tag is
14035 present) gets focus.
14036
14037 Here's a more complicated example:
14038
14039 @lisp
14040 (article (vertical 1.0 (group 4)
14041                        (summary 0.25 point)
14042                        (if gnus-carpal (summary-carpal 4))
14043                        (article 1.0)))
14044 @end lisp
14045
14046 If the size spec is an integer instead of a floating point number,
14047 then that number will be used to say how many lines a buffer should
14048 occupy, not a percentage.
14049
14050 If the @dfn{split} looks like something that can be @code{eval}ed (to be
14051 precise---if the @code{car} of the split is a function or a subr), this
14052 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
14053 be used as a split.  This means that there will be three buffers if
14054 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
14055 is non-@code{nil}.
14056
14057 Not complicated enough for you?  Well, try this on for size:
14058
14059 @lisp
14060 (article (horizontal 1.0
14061              (vertical 0.5
14062                  (group 1.0)
14063                  (gnus-carpal 4))
14064              (vertical 1.0
14065                  (summary 0.25 point)
14066                  (summary-carpal 4)
14067                  (article 1.0))))
14068 @end lisp
14069
14070 Whoops.  Two buffers with the mystery 100% tag.  And what's that
14071 @code{horizontal} thingie?
14072
14073 If the first element in one of the split is @code{horizontal}, Gnus will
14074 split the window horizontally, giving you two windows side-by-side.
14075 Inside each of these strips you may carry on all you like in the normal
14076 fashion.  The number following @code{horizontal} says what percentage of
14077 the screen is to be given to this strip.
14078
14079 For each split, there @emph{must} be one element that has the 100% tag.
14080 The splitting is never accurate, and this buffer will eat any leftover
14081 lines from the splits.
14082
14083 To be slightly more formal, here's a definition of what a valid split
14084 may look like:
14085
14086 @example
14087 split       = frame | horizontal | vertical | buffer | form
14088 frame       = "(frame " size *split ")"
14089 horizontal  = "(horizontal " size *split ")"
14090 vertical    = "(vertical " size *split ")"
14091 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
14092 size        = number | frame-params
14093 buffer-name = group | article | summary ...
14094 @end example
14095
14096 The limitations are that the @code{frame} split can only appear as the
14097 top-level split.  @var{form} should be an Emacs Lisp form that should
14098 return a valid split.  We see that each split is fully recursive, and
14099 may contain any number of @code{vertical} and @code{horizontal} splits.
14100
14101 @vindex gnus-window-min-width
14102 @vindex gnus-window-min-height
14103 @cindex window height
14104 @cindex window width
14105 Finding the right sizes can be a bit complicated.  No window may be less
14106 than @code{gnus-window-min-height} (default 1) characters high, and all
14107 windows must be at least @code{gnus-window-min-width} (default 1)
14108 characters wide.  Gnus will try to enforce this before applying the
14109 splits.  If you want to use the normal Emacs window width/height limit,
14110 you can just set these two variables to @code{nil}.
14111
14112 If you're not familiar with Emacs terminology, @code{horizontal} and
14113 @code{vertical} splits may work the opposite way of what you'd expect.
14114 Windows inside a @code{horizontal} split are shown side-by-side, and
14115 windows within a @code{vertical} split are shown above each other.
14116
14117 @findex gnus-configure-frame
14118 If you want to experiment with window placement, a good tip is to call
14119 @code{gnus-configure-frame} directly with a split.  This is the function
14120 that does all the real work when splitting buffers.  Below is a pretty
14121 nonsensical configuration with 5 windows; two for the group buffer and
14122 three for the article buffer.  (I said it was nonsensical.)  If you
14123 @code{eval} the statement below, you can get an idea of how that would
14124 look straight away, without going through the normal Gnus channels.
14125 Play with it until you're satisfied, and then use
14126 @code{gnus-add-configuration} to add your new creation to the buffer
14127 configuration list.
14128
14129 @lisp
14130 (gnus-configure-frame
14131  '(horizontal 1.0
14132     (vertical 10
14133       (group 1.0)
14134       (article 0.3 point))
14135     (vertical 1.0
14136       (article 1.0)
14137       (horizontal 4
14138         (group 1.0)
14139         (article 10)))))
14140 @end lisp
14141
14142 You might want to have several frames as well.  No prob---just use the
14143 @code{frame} split:
14144
14145 @lisp
14146 (gnus-configure-frame
14147  '(frame 1.0
14148          (vertical 1.0
14149                    (summary 0.25 point frame-focus)
14150                    (article 1.0))
14151          (vertical ((height . 5) (width . 15)
14152                     (user-position . t)
14153                     (left . -1) (top . 1))
14154                    (picon 1.0))))
14155
14156 @end lisp
14157
14158 This split will result in the familiar summary/article window
14159 configuration in the first (or ``main'') frame, while a small additional
14160 frame will be created where picons will be shown.  As you can see,
14161 instead of the normal @code{1.0} top-level spec, each additional split
14162 should have a frame parameter alist as the size spec.
14163 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
14164 Reference Manual}.  Under XEmacs, a frame property list will be
14165 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
14166 is such a plist.
14167
14168 Here's a list of all possible keys for
14169 @code{gnus-buffer-configuration}:
14170
14171 @code{group}, @code{summary}, @code{article}, @code{server},
14172 @code{browse}, @code{message}, @code{pick}, @code{info},
14173 @code{summary-faq}, @code{edit-group}, @code{edit-server},
14174 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
14175 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
14176 @code{bug}, @code{compose-bounce}, and @code{score-trace}.
14177
14178 Note that the @code{message} key is used for both
14179 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
14180 it is desirable to distinguish between the two, something like this
14181 might be used:
14182
14183 @lisp
14184 (message (horizontal 1.0
14185                      (vertical 1.0 (message 1.0 point))
14186                      (vertical 0.24
14187                                (if (buffer-live-p gnus-summary-buffer)
14188                                    '(summary 0.5))
14189                                (group 1.0)))))
14190 @end lisp
14191
14192 @findex gnus-add-configuration
14193 Since the @code{gnus-buffer-configuration} variable is so long and
14194 complicated, there's a function you can use to ease changing the config
14195 of a single setting: @code{gnus-add-configuration}.  If, for instance,
14196 you want to change the @code{article} setting, you could say:
14197
14198 @lisp
14199 (gnus-add-configuration
14200  '(article (vertical 1.0
14201                (group 4)
14202                (summary .25 point)
14203                (article 1.0))))
14204 @end lisp
14205
14206 You'd typically stick these @code{gnus-add-configuration} calls in your
14207 @file{.gnus.el} file or in some startup hook---they should be run after
14208 Gnus has been loaded.
14209
14210 @vindex gnus-always-force-window-configuration
14211 If all windows mentioned in the configuration are already visible, Gnus
14212 won't change the window configuration.  If you always want to force the
14213 ``right'' window configuration, you can set
14214 @code{gnus-always-force-window-configuration} to non-@code{nil}.
14215
14216
14217 @node Faces and Fonts
14218 @section Faces and Fonts
14219 @cindex faces
14220 @cindex fonts
14221 @cindex colors
14222
14223 Fiddling with fonts and faces used to be very difficult, but these days
14224 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
14225 the face you want to alter, and alter it via the standard Customize
14226 interface.
14227
14228
14229 @node Compilation
14230 @section Compilation
14231 @cindex compilation
14232 @cindex byte-compilation
14233
14234 @findex gnus-compile
14235
14236 Remember all those line format specification variables?
14237 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
14238 on.  Now, Gnus will of course heed whatever these variables are, but,
14239 unfortunately, changing them will mean a quite significant slow-down.
14240 (The default values of these variables have byte-compiled functions
14241 associated with them, while the user-generated versions do not, of
14242 course.)
14243
14244 To help with this, you can run @kbd{M-x gnus-compile} after you've
14245 fiddled around with the variables and feel that you're (kind of)
14246 satisfied.  This will result in the new specs being byte-compiled, and
14247 you'll get top speed again.  Gnus will save these compiled specs in the
14248 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
14249 this function, though---you should compile them yourself by sticking
14250 them into the @code{.gnus.el} file and byte-compiling that file.)
14251
14252
14253 @node Mode Lines
14254 @section Mode Lines
14255 @cindex mode lines
14256
14257 @vindex gnus-updated-mode-lines
14258 @code{gnus-updated-mode-lines} says what buffers should keep their mode
14259 lines updated.  It is a list of symbols.  Supported symbols include
14260 @code{group}, @code{article}, @code{summary}, @code{server},
14261 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
14262 Gnus will keep that mode line updated with information that may be
14263 pertinent.  If this variable is @code{nil}, screen refresh may be
14264 quicker.
14265
14266 @cindex display-time
14267
14268 @vindex gnus-mode-non-string-length
14269 By default, Gnus displays information on the current article in the mode
14270 lines of the summary and article buffers.  The information Gnus wishes
14271 to display (e.g. the subject of the article) is often longer than the
14272 mode lines, and therefore have to be cut off at some point.  The
14273 @code{gnus-mode-non-string-length} variable says how long the other
14274 elements on the line is (i.e., the non-info part).  If you put
14275 additional elements on the mode line (e.g. a clock), you should modify
14276 this variable:
14277
14278 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
14279 @lisp
14280 (add-hook 'display-time-hook
14281           (lambda () (setq gnus-mode-non-string-length
14282                            (+ 21
14283                               (if line-number-mode 5 0)
14284                               (if column-number-mode 4 0)
14285                               (length display-time-string)))))
14286 @end lisp
14287
14288 If this variable is @code{nil} (which is the default), the mode line
14289 strings won't be chopped off, and they won't be padded either.  Note
14290 that the default is unlikely to be desirable, as even the percentage
14291 complete in the buffer may be crowded off the mode line; the user should
14292 configure this variable appropriately for her configuration.
14293
14294
14295 @node Highlighting and Menus
14296 @section Highlighting and Menus
14297 @cindex visual
14298 @cindex highlighting
14299 @cindex menus
14300
14301 @vindex gnus-visual
14302 The @code{gnus-visual} variable controls most of the Gnus-prettifying
14303 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
14304 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
14305 file.
14306
14307 This variable can be a list of visual properties that are enabled.  The
14308 following elements are valid, and are all included by default:
14309
14310 @table @code
14311 @item group-highlight
14312 Do highlights in the group buffer.
14313 @item summary-highlight
14314 Do highlights in the summary buffer.
14315 @item article-highlight
14316 Do highlights in the article buffer.
14317 @item highlight
14318 Turn on highlighting in all buffers.
14319 @item group-menu
14320 Create menus in the group buffer.
14321 @item summary-menu
14322 Create menus in the summary buffers.
14323 @item article-menu
14324 Create menus in the article buffer.
14325 @item browse-menu
14326 Create menus in the browse buffer.
14327 @item server-menu
14328 Create menus in the server buffer.
14329 @item score-menu
14330 Create menus in the score buffers.
14331 @item menu
14332 Create menus in all buffers.
14333 @end table
14334
14335 So if you only want highlighting in the article buffer and menus in all
14336 buffers, you could say something like:
14337
14338 @lisp
14339 (setq gnus-visual '(article-highlight menu))
14340 @end lisp
14341
14342 If you want highlighting only and no menus whatsoever, you'd say:
14343
14344 @lisp
14345 (setq gnus-visual '(highlight))
14346 @end lisp
14347
14348 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14349 in all Gnus buffers.
14350
14351 Other general variables that influence the look of all buffers include:
14352
14353 @table @code
14354 @item gnus-mouse-face
14355 @vindex gnus-mouse-face
14356 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
14357 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
14358
14359 @end table
14360
14361 There are hooks associated with the creation of all the different menus:
14362
14363 @table @code
14364
14365 @item gnus-article-menu-hook
14366 @vindex gnus-article-menu-hook
14367 Hook called after creating the article mode menu.
14368
14369 @item gnus-group-menu-hook
14370 @vindex gnus-group-menu-hook
14371 Hook called after creating the group mode menu.
14372
14373 @item gnus-summary-menu-hook
14374 @vindex gnus-summary-menu-hook
14375 Hook called after creating the summary mode menu.
14376
14377 @item gnus-server-menu-hook
14378 @vindex gnus-server-menu-hook
14379 Hook called after creating the server mode menu.
14380
14381 @item gnus-browse-menu-hook
14382 @vindex gnus-browse-menu-hook
14383 Hook called after creating the browse mode menu.
14384
14385 @item gnus-score-menu-hook
14386 @vindex gnus-score-menu-hook
14387 Hook called after creating the score mode menu.
14388
14389 @end table
14390
14391
14392 @node Buttons
14393 @section Buttons
14394 @cindex buttons
14395 @cindex mouse
14396 @cindex click
14397
14398 Those new-fangled @dfn{mouse} contraptions is very popular with the
14399 young, hep kids who don't want to learn the proper way to do things
14400 these days.  Why, I remember way back in the summer of '89, when I was
14401 using Emacs on a Tops 20 system.  Three hundred users on one single
14402 machine, and every user was running Simula compilers.  Bah!
14403
14404 Right.
14405
14406 @vindex gnus-carpal
14407 Well, you can make Gnus display bufferfuls of buttons you can click to
14408 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
14409 really.  Tell the chiropractor I sent you.
14410
14411
14412 @table @code
14413
14414 @item gnus-carpal-mode-hook
14415 @vindex gnus-carpal-mode-hook
14416 Hook run in all carpal mode buffers.
14417
14418 @item gnus-carpal-button-face
14419 @vindex gnus-carpal-button-face
14420 Face used on buttons.
14421
14422 @item gnus-carpal-header-face
14423 @vindex gnus-carpal-header-face
14424 Face used on carpal buffer headers.
14425
14426 @item gnus-carpal-group-buffer-buttons
14427 @vindex gnus-carpal-group-buffer-buttons
14428 Buttons in the group buffer.
14429
14430 @item gnus-carpal-summary-buffer-buttons
14431 @vindex gnus-carpal-summary-buffer-buttons
14432 Buttons in the summary buffer.
14433
14434 @item gnus-carpal-server-buffer-buttons
14435 @vindex gnus-carpal-server-buffer-buttons
14436 Buttons in the server buffer.
14437
14438 @item gnus-carpal-browse-buffer-buttons
14439 @vindex gnus-carpal-browse-buffer-buttons
14440 Buttons in the browse buffer.
14441 @end table
14442
14443 All the @code{buttons} variables are lists.  The elements in these list
14444 are either cons cells where the @code{car} contains a text to be displayed and
14445 the @code{cdr} contains a function symbol, or a simple string.
14446
14447
14448 @node Daemons
14449 @section Daemons
14450 @cindex demons
14451 @cindex daemons
14452
14453 Gnus, being larger than any program ever written (allegedly), does lots
14454 of strange stuff that you may wish to have done while you're not
14455 present.  For instance, you may want it to check for new mail once in a
14456 while.  Or you may want it to close down all connections to all servers
14457 when you leave Emacs idle.  And stuff like that.
14458
14459 Gnus will let you do stuff like that by defining various
14460 @dfn{handlers}.  Each handler consists of three elements:  A
14461 @var{function}, a @var{time}, and an @var{idle} parameter.
14462
14463 Here's an example of a handler that closes connections when Emacs has
14464 been idle for thirty minutes:
14465
14466 @lisp
14467 (gnus-demon-close-connections nil 30)
14468 @end lisp
14469
14470 Here's a handler that scans for PGP headers every hour when Emacs is
14471 idle:
14472
14473 @lisp
14474 (gnus-demon-scan-pgp 60 t)
14475 @end lisp
14476
14477 This @var{time} parameter and than @var{idle} parameter work together
14478 in a strange, but wonderful fashion.  Basically, if @var{idle} is
14479 @code{nil}, then the function will be called every @var{time} minutes.
14480
14481 If @var{idle} is @code{t}, then the function will be called after
14482 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
14483 the function will never be called.  But once Emacs goes idle, the
14484 function will be called every @var{time} minutes.
14485
14486 If @var{idle} is a number and @var{time} is a number, the function will
14487 be called every @var{time} minutes only when Emacs has been idle for
14488 @var{idle} minutes.
14489
14490 If @var{idle} is a number and @var{time} is @code{nil}, the function
14491 will be called once every time Emacs has been idle for @var{idle}
14492 minutes.
14493
14494 And if @var{time} is a string, it should look like @samp{07:31}, and
14495 the function will then be called once every day somewhere near that
14496 time.  Modified by the @var{idle} parameter, of course.
14497
14498 @vindex gnus-demon-timestep
14499 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
14500 seconds.  This is 60 by default.  If you change that variable,
14501 all the timings in the handlers will be affected.)
14502
14503 @vindex gnus-use-demon
14504 To set the whole thing in motion, though, you have to set
14505 @code{gnus-use-demon} to @code{t}.
14506
14507 So, if you want to add a handler, you could put something like this in
14508 your @file{.gnus} file:
14509
14510 @findex gnus-demon-add-handler
14511 @lisp
14512 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
14513 @end lisp
14514
14515 @findex gnus-demon-add-nocem
14516 @findex gnus-demon-add-scanmail
14517 @findex gnus-demon-add-rescan
14518 @findex gnus-demon-add-scan-timestamps
14519 @findex gnus-demon-add-disconnection
14520 Some ready-made functions to do this have been created:
14521 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
14522 @code{gnus-demon-add-nntp-close-connection},
14523 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
14524 @code{gnus-demon-add-scanmail}.  Just put those functions in your
14525 @file{.gnus} if you want those abilities.
14526
14527 @findex gnus-demon-init
14528 @findex gnus-demon-cancel
14529 @vindex gnus-demon-handlers
14530 If you add handlers to @code{gnus-demon-handlers} directly, you should
14531 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
14532 daemons, you can use the @code{gnus-demon-cancel} function.
14533
14534 Note that adding daemons can be pretty naughty if you over do it.  Adding
14535 functions that scan all news and mail from all servers every two seconds
14536 is a sure-fire way of getting booted off any respectable system.  So
14537 behave.
14538
14539
14540 @node NoCeM
14541 @section NoCeM
14542 @cindex nocem
14543 @cindex spam
14544
14545 @dfn{Spamming} is posting the same article lots and lots of times.
14546 Spamming is bad.  Spamming is evil.
14547
14548 Spamming is usually canceled within a day or so by various anti-spamming
14549 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
14550 NoCeM is pronounced ``no see-'em'', and means what the name
14551 implies---these are messages that make the offending articles, like, go
14552 away.
14553
14554 What use are these NoCeM messages if the articles are canceled anyway?
14555 Some sites do not honor cancel messages and some sites just honor cancels
14556 from a select few people.  Then you may wish to make use of the NoCeM
14557 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
14558
14559 Gnus can read and parse the messages in this group automatically, and
14560 this will make spam disappear.
14561
14562 There are some variables to customize, of course:
14563
14564 @table @code
14565 @item gnus-use-nocem
14566 @vindex gnus-use-nocem
14567 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
14568 by default.
14569
14570 @item gnus-nocem-groups
14571 @vindex gnus-nocem-groups
14572 Gnus will look for NoCeM messages in the groups in this list.  The
14573 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
14574 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
14575
14576 @item gnus-nocem-issuers
14577 @vindex gnus-nocem-issuers
14578 There are many people issuing NoCeM messages.  This list says what
14579 people you want to listen to.  The default is @code{("Automoose-1"
14580 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
14581 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
14582 (Richard E. Depew)")}; fine, upstanding citizens all of them.
14583
14584 Known despammers that you can put in this list include:
14585
14586 @table @samp
14587 @item clewis@@ferret.ocunix.on.ca;
14588 @cindex Chris Lewis
14589 Chris Lewis---Major Canadian despammer who has probably canceled more
14590 usenet abuse than anybody else.
14591
14592 @item Automoose-1
14593 @cindex CancelMoose[tm]
14594 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
14595 Norwegian, and was the person(s) who invented NoCeM.
14596
14597 @item jem@@xpat.com;
14598 @cindex Jem
14599 John Milburn---despammer located in Korea who is getting very busy these
14600 days.
14601
14602 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
14603 Richard E. Depew---lone American despammer.  He mostly cancels binary
14604 postings to non-binary groups and removes spews (regurgitated articles).
14605 @end table
14606
14607 You do not have to heed NoCeM messages from all these people---just the
14608 ones you want to listen to.  You also don't have to accept all NoCeM
14609 messages from the people you like.  Each NoCeM message has a @dfn{type}
14610 header that gives the message a (more or less, usually less) rigorous
14611 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
14612 @samp{binary}, and @samp{troll}.  To specify this, you have to use
14613 @var{(issuer conditions ...)} elements in the list.  Each condition is
14614 either a string (which is a regexp that matches types you want to use)
14615 or a list on the form @code{(not STRING)}, where @var{string} is a
14616 regexp that matches types you don't want to use.
14617
14618 For instance, if you want all NoCeM messages from Chris Lewis except his
14619 @samp{troll} messages, you'd say:
14620
14621 @lisp
14622 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
14623 @end lisp
14624
14625 On the other hand, if you just want nothing but his @samp{spam} and
14626 @samp{spew} messages, you'd say:
14627
14628 @lisp
14629 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
14630 @end lisp
14631
14632 The specs are applied left-to-right.
14633
14634
14635 @item gnus-nocem-verifyer
14636 @vindex gnus-nocem-verifyer
14637 @findex mc-verify
14638 This should be a function for verifying that the NoCeM issuer is who she
14639 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
14640 function.  If this is too slow and you don't care for verification
14641 (which may be dangerous), you can set this variable to @code{nil}.
14642
14643 If you want signed NoCeM messages to be verified and unsigned messages
14644 not to be verified (but used anyway), you could do something like:
14645
14646 @lisp
14647 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
14648
14649 (defun my-gnus-mc-verify ()
14650   (not (eq 'forged
14651            (ignore-errors
14652              (if (mc-verify)
14653                  t
14654                'forged)))))
14655 @end lisp
14656
14657 This might be dangerous, though.
14658
14659 @item gnus-nocem-directory
14660 @vindex gnus-nocem-directory
14661 This is where Gnus will store its NoCeM cache files.  The default is
14662 @file{~/News/NoCeM/}.
14663
14664 @item gnus-nocem-expiry-wait
14665 @vindex gnus-nocem-expiry-wait
14666 The number of days before removing old NoCeM entries from the cache.
14667 The default is 15.  If you make it shorter Gnus will be faster, but you
14668 might then see old spam.
14669
14670 @end table
14671
14672 Using NoCeM could potentially be a memory hog.  If you have many living
14673 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
14674 big.  If this is a problem, you should kill off all (or most) of your
14675 unsubscribed groups (@pxref{Subscription Commands}).
14676
14677
14678 @node Undo
14679 @section Undo
14680 @cindex undo
14681
14682 It is very useful to be able to undo actions one has done.  In normal
14683 Emacs buffers, it's easy enough---you just push the @code{undo} button.
14684 In Gnus buffers, however, it isn't that simple.
14685
14686 The things Gnus displays in its buffer is of no value whatsoever to
14687 Gnus---it's all just data designed to look nice to the user.
14688 Killing a group in the group buffer with @kbd{C-k} makes the line
14689 disappear, but that's just a side-effect of the real action---the
14690 removal of the group in question from the internal Gnus structures.
14691 Undoing something like that can't be done by the normal Emacs
14692 @code{undo} function.
14693
14694 Gnus tries to remedy this somewhat by keeping track of what the user
14695 does and coming up with actions that would reverse the actions the user
14696 takes.  When the user then presses the @code{undo} key, Gnus will run
14697 the code to reverse the previous action, or the previous actions.
14698 However, not all actions are easily reversible, so Gnus currently offers
14699 a few key functions to be undoable.  These include killing groups,
14700 yanking groups, and changing the list of read articles of groups.
14701 That's it, really.  More functions may be added in the future, but each
14702 added function means an increase in data to be stored, so Gnus will
14703 never be totally undoable.
14704
14705 @findex gnus-undo-mode
14706 @vindex gnus-use-undo
14707 @findex gnus-undo
14708 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
14709 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
14710 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
14711 command, which should feel kinda like the normal Emacs @code{undo}
14712 command.
14713
14714
14715 @node Moderation
14716 @section Moderation
14717 @cindex moderation
14718
14719 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
14720 It is not included in the standard Gnus package.  Write a mail to
14721 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
14722 get a copy.
14723
14724 The moderation package is implemented as a minor mode for summary
14725 buffers.  Put
14726
14727 @lisp
14728 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
14729 @end lisp
14730
14731 in your @file{.gnus.el} file.
14732
14733 If you are the moderator of @samp{rec.zoofle}, this is how it's
14734 supposed to work:
14735
14736 @enumerate
14737 @item
14738 You split your incoming mail by matching on
14739 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
14740 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
14741
14742 @item
14743 You enter that group once in a while and post articles using the @kbd{e}
14744 (edit-and-post) or @kbd{s} (just send unedited) commands.
14745
14746 @item
14747 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
14748 articles that weren't approved by you, you can cancel them with the
14749 @kbd{c} command.
14750 @end enumerate
14751
14752 To use moderation mode in these two groups, say:
14753
14754 @lisp
14755 (setq gnus-moderated-list
14756       "^nnml:rec.zoofle$\\|^rec.zoofle$")
14757 @end lisp
14758
14759
14760 @node XEmacs Enhancements
14761 @section XEmacs Enhancements
14762 @cindex XEmacs
14763
14764 XEmacs is able to display pictures and stuff, so Gnus has taken
14765 advantage of that.
14766
14767 @menu
14768 * Picons::    How to display pictures of what your reading.
14769 * Smileys::   Show all those happy faces the way they were meant to be shown.
14770 * Toolbar::   Click'n'drool.
14771 * XVarious::  Other XEmacsy Gnusey variables.
14772 @end menu
14773
14774
14775 @node Picons
14776 @subsection Picons
14777
14778 @iftex
14779 @iflatex
14780 \include{picons}
14781 @end iflatex
14782 @end iftex
14783
14784 So...  You want to slow down your news reader even more!  This is a
14785 good way to do so.  Its also a great way to impress people staring
14786 over your shoulder as you read news.
14787
14788 @menu
14789 * Picon Basics::           What are picons and How do I get them.
14790 * Picon Requirements::     Don't go further if you aren't using XEmacs.
14791 * Easy Picons::            Displaying Picons---the easy way.
14792 * Hard Picons::            The way you should do it.  You'll learn something.
14793 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
14794 @end menu
14795
14796
14797 @node Picon Basics
14798 @subsubsection Picon Basics
14799
14800 What are Picons?  To quote directly from the Picons Web site:
14801
14802 @iftex
14803 @iflatex
14804 \margindex{}
14805 @end iflatex
14806 @end iftex
14807
14808 @quotation
14809 @dfn{Picons} is short for ``personal icons''.  They're small,
14810 constrained images used to represent users and domains on the net,
14811 organized into databases so that the appropriate image for a given
14812 e-mail address can be found.  Besides users and domains, there are picon
14813 databases for Usenet newsgroups and weather forecasts.  The picons are
14814 in either monochrome @code{XBM} format or color @code{XPM} and
14815 @code{GIF} formats.
14816 @end quotation
14817
14818 @vindex gnus-picons-piconsearch-url
14819 If you have a permanent connection to the Internet you can use Steve
14820 Kinzler's Picons Search engine by setting
14821 @code{gnus-picons-piconsearch-url} to the string @*
14822 @file{http://www.cs.indiana.edu/picons/search.html}.
14823
14824 @vindex gnus-picons-database
14825 Otherwise you need a local copy of his database.  For instructions on
14826 obtaining and installing the picons databases, point your Web browser at @*
14827 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
14828 picons to be installed into a location pointed to by
14829 @code{gnus-picons-database}.
14830
14831
14832 @node Picon Requirements
14833 @subsubsection Picon Requirements
14834
14835 To have Gnus display Picons for you, you must be running XEmacs
14836 19.13 or greater since all other versions of Emacs aren't yet able to
14837 display images.
14838
14839 Additionally, you must have @code{x} support compiled into XEmacs.  To
14840 display color picons which are much nicer than the black & white one,
14841 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
14842
14843 @vindex gnus-picons-convert-x-face
14844 If you want to display faces from @code{X-Face} headers, you should have
14845 the @code{xface} support compiled into XEmacs.  Otherwise you must have
14846 the @code{netpbm} utilities installed, or munge the
14847 @code{gnus-picons-convert-x-face} variable to use something else.
14848
14849
14850 @node Easy Picons
14851 @subsubsection Easy Picons
14852
14853 To enable displaying picons, simply put the following line in your
14854 @file{~/.gnus} file and start Gnus.
14855
14856 @lisp
14857 (setq gnus-use-picons t)
14858 (add-hook 'gnus-article-display-hook
14859           'gnus-article-display-picons t)
14860 (add-hook 'gnus-article-display-hook
14861           'gnus-picons-article-display-x-face)
14862 @end lisp
14863
14864 and make sure @code{gnus-picons-database} points to the directory
14865 containing the Picons databases.
14866
14867 Alternatively if you want to use the web piconsearch engine add this:
14868
14869 @lisp
14870 (setq gnus-picons-piconsearch-url
14871       "http://www.cs.indiana.edu:800/piconsearch")
14872 @end lisp
14873
14874
14875 @node Hard Picons
14876 @subsubsection Hard Picons
14877
14878 @iftex
14879 @iflatex
14880 \margindex{}
14881 @end iflatex
14882 @end iftex
14883
14884 Gnus can display picons for you as you enter and leave groups and
14885 articles.  It knows how to interact with three sections of the picons
14886 database.  Namely, it can display the picons newsgroup pictures,
14887 author's face picture(s), and the authors domain.  To enable this
14888 feature, you need to select where to get the picons from, and where to
14889 display them.
14890
14891 @table @code
14892
14893 @item gnus-picons-database
14894 @vindex gnus-picons-database
14895 The location of the picons database.  Should point to a directory
14896 containing the @file{news}, @file{domains}, @file{users} (and so on)
14897 subdirectories.  This is only useful if
14898 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
14899 @file{/usr/local/faces/}.
14900
14901 @item gnus-picons-piconsearch-url
14902 @vindex gnus-picons-piconsearch-url
14903 The URL for the web picons search engine.  The only currently known
14904 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
14905 workaround network delays, icons will be fetched in the background.  If
14906 this is @code{nil} 'the default), then picons are fetched from local
14907 database indicated by @code{gnus-picons-database}.
14908
14909 @item gnus-picons-display-where
14910 @vindex gnus-picons-display-where
14911 Where the picon images should be displayed.  It is @code{picons} by
14912 default (which by default maps to the buffer @samp{*Picons*}).  Other
14913 valid places could be @code{article}, @code{summary}, or
14914 @samp{*scratch*} for all I care.  Just make sure that you've made the
14915 buffer visible using the standard Gnus window configuration
14916 routines---@pxref{Windows Configuration}.
14917
14918 @item gnus-picons-group-excluded-groups
14919 @vindex gnus-picons-group-excluded-groups
14920 Groups that are matched by this regexp won't have their group icons
14921 displayed.
14922
14923 @end table
14924
14925 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
14926 window configuration for you to include the @code{picons} buffer.
14927
14928 Now that you've made those decision, you need to add the following
14929 functions to the appropriate hooks so these pictures will get displayed
14930 at the right time.
14931
14932 @vindex gnus-article-display-hook
14933 @vindex gnus-picons-display-where
14934 @table @code
14935 @item gnus-article-display-picons
14936 @findex gnus-article-display-picons
14937 Looks up and displays the picons for the author and the author's domain
14938 in the @code{gnus-picons-display-where} buffer.  Should be added to the
14939 @code{gnus-article-display-hook}.
14940
14941 @item gnus-picons-article-display-x-face
14942 @findex gnus-article-display-picons
14943 Decodes and displays the X-Face header if present.  This function
14944 should be added to @code{gnus-article-display-hook}.
14945
14946 @end table
14947
14948 Note:  You must append them to the hook, so make sure to specify 't'
14949 for the append flag of @code{add-hook}:
14950
14951 @lisp
14952 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14953 @end lisp
14954
14955
14956 @node Picon Useless Configuration
14957 @subsubsection Picon Useless Configuration
14958
14959 @iftex
14960 @iflatex
14961 \margindex{}
14962 @end iflatex
14963 @end iftex
14964
14965 The following variables offer further control over how things are
14966 done, where things are located, and other useless stuff you really
14967 don't need to worry about.
14968
14969 @table @code
14970
14971 @item gnus-picons-news-directories
14972 @vindex gnus-picons-news-directories
14973 List of subdirectories to search in @code{gnus-picons-database} for
14974 newsgroups faces.  @code{("news")} is the default.
14975
14976 @item gnus-picons-user-directories
14977 @vindex gnus-picons-user-directories
14978 List of subdirectories to search in @code{gnus-picons-database} for user
14979 faces.  @code{("local" "users" "usenix" "misc")} is the default.
14980
14981 @item gnus-picons-domain-directories
14982 @vindex gnus-picons-domain-directories
14983 List of subdirectories to search in @code{gnus-picons-database} for
14984 domain name faces.  Defaults to @code{("domains")}.  Some people may
14985 want to add @samp{"unknown"} to this list.
14986
14987 @item gnus-picons-convert-x-face
14988 @vindex gnus-picons-convert-x-face
14989 If you don't have @code{xface} support builtin XEmacs, this is the
14990 command to use to convert the @code{X-Face} header to an X bitmap
14991 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
14992 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
14993 gnus-picons-x-face-file-name)}
14994
14995 @item gnus-picons-x-face-file-name
14996 @vindex gnus-picons-x-face-file-name
14997 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
14998 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
14999
15000 @item gnus-picons-has-modeline-p
15001 @vindex gnus-picons-has-modeline-p
15002 If you have set @code{gnus-picons-display-where} to @code{picons}, your
15003 XEmacs frame will become really cluttered.  To alleviate this a bit you
15004 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
15005 remove the mode line from the Picons buffer.  This is only useful if
15006 @code{gnus-picons-display-where} is @code{picons}.
15007
15008 @item gnus-picons-refresh-before-display
15009 @vindex gnus-picons-refresh-before-display
15010 If non-nil, display the article buffer before computing the picons.
15011 Defaults to @code{nil}.
15012
15013 @item gnus-picons-display-as-address
15014 @vindex gnus-picons-display-as-address
15015 If @code{t} display textual email addresses along with pictures.
15016 Defaults to @code{t}.
15017
15018 @item gnus-picons-file-suffixes
15019 @vindex gnus-picons-file-suffixes
15020 Ordered list of suffixes on picon file names to try.  Defaults to
15021 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
15022
15023 @item gnus-picons-display-article-move-p
15024 @vindex gnus-picons-display-article-move-p
15025 Whether to move point to first empty line when displaying picons.  This
15026 has only an effect if `gnus-picons-display-where' has value `article'.
15027
15028 @item gnus-picons-clear-cache-on-shutdown
15029 @vindex gnus-picons-clear-cache-on-shutdown
15030 Whether to clear the picons cache when exiting gnus.  Gnus caches every
15031 picons it finds while it is running.  This saves some time in the search
15032 process but eats some memory.  If this variable is set to @code{nil},
15033 Gnus will never clear the cache itself; you will have to manually call
15034 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
15035 cleared every time you exit Gnus.  Defaults to @code{t}.
15036
15037 @iftex
15038 @iflatex
15039 \margindex{}
15040 @end iflatex
15041 @end iftex
15042
15043 @end table
15044
15045 @node Smileys
15046 @subsection Smileys
15047 @cindex smileys
15048
15049 @iftex
15050 @iflatex
15051 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
15052 \input{smiley}
15053 @end iflatex
15054 @end iftex
15055
15056 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
15057 currently the only package that uses Smiley, it is documented here.
15058
15059 In short---to use Smiley in Gnus, put the following in your
15060 @file{.gnus.el} file:
15061
15062 @lisp
15063 (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
15064 @end lisp
15065
15066 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
15067 the like---to pictures and displays those instead of the text smiley
15068 faces.  The conversion is controlled by a list of regexps that matches
15069 text and maps that to file names.
15070
15071 @vindex smiley-nosey-regexp-alist
15072 @vindex smiley-deformed-regexp-alist
15073 Smiley supplies two example conversion alists by default:
15074 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
15075 and so on), and @code{smiley-nosey-regexp-alist} (which matches
15076 @samp{:-)}, @samp{:-(} and so on).
15077
15078 The alist used is specified by the @code{smiley-regexp-alist} variable,
15079 which defaults to the value of @code{smiley-deformed-regexp-alist}.
15080
15081 The first item in each element is the regexp to be matched; the second
15082 element is the regexp match group that is to be replaced by the picture;
15083 and the third element is the name of the file to be displayed.
15084
15085 The following variables customize where Smiley will look for these
15086 files, as well as the color to be used and stuff:
15087
15088 @table @code
15089
15090 @item smiley-data-directory
15091 @vindex smiley-data-directory
15092 Where Smiley will look for smiley faces files.
15093
15094 @item smiley-flesh-color
15095 @vindex smiley-flesh-color
15096 Skin color.  The default is @samp{yellow}, which is really racist.
15097
15098 @item smiley-features-color
15099 @vindex smiley-features-color
15100 Color of the features of the face.  The default is @samp{black}.
15101
15102 @item smiley-tongue-color
15103 @vindex smiley-tongue-color
15104 Color of the tongue.  The default is @samp{red}.
15105
15106 @item smiley-circle-color
15107 @vindex smiley-circle-color
15108 Color of the circle around the face.  The default is @samp{black}.
15109
15110 @item smiley-mouse-face
15111 @vindex smiley-mouse-face
15112 Face used for mouse highlighting over the smiley face.
15113
15114 @end table
15115
15116
15117 @node Toolbar
15118 @subsection Toolbar
15119
15120 @table @code
15121
15122 @iftex
15123 @iflatex
15124 \margindex{}
15125 @end iflatex
15126 @end iftex
15127
15128 @item gnus-use-toolbar
15129 @vindex gnus-use-toolbar
15130 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
15131 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
15132 @code{right-toolbar}, or @code{left-toolbar}.
15133
15134 @item gnus-group-toolbar
15135 @vindex gnus-group-toolbar
15136 The toolbar in the group buffer.
15137
15138 @item gnus-summary-toolbar
15139 @vindex gnus-summary-toolbar
15140 The toolbar in the summary buffer.
15141
15142 @item gnus-summary-mail-toolbar
15143 @vindex gnus-summary-mail-toolbar
15144 The toolbar in the summary buffer of mail groups.
15145
15146 @end table
15147
15148
15149 @node XVarious
15150 @subsection Various XEmacs Variables
15151
15152 @table @code
15153 @item gnus-xmas-glyph-directory
15154 @vindex gnus-xmas-glyph-directory
15155 This is where Gnus will look for pictures.  Gnus will normally
15156 auto-detect this directory, but you may set it manually if you have an
15157 unusual directory structure.
15158
15159 @item gnus-xmas-logo-color-alist
15160 @vindex gnus-xmas-logo-color-alist
15161 This is an alist where the key is a type symbol and the values are the
15162 foreground and background color of the splash page glyph.
15163
15164 @item gnus-xmas-logo-color-style
15165 @vindex gnus-xmas-logo-color-style
15166 This is the key used to look up the color in the alist described above.
15167 Valid values include @code{flame}, @code{pine}, @code{moss},
15168 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
15169 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
15170
15171 @item gnus-xmas-modeline-glyph
15172 @vindex gnus-xmas-modeline-glyph
15173 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
15174 default.
15175
15176 @iftex
15177 @iflatex
15178 \margindex{}
15179 @end iflatex
15180 @end iftex
15181
15182 @end table
15183
15184
15185
15186
15187 @node Fuzzy Matching
15188 @section Fuzzy Matching
15189 @cindex fuzzy matching
15190
15191 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
15192 things like scoring, thread gathering and thread comparison.
15193
15194 As opposed to regular expression matching, fuzzy matching is very fuzzy.
15195 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
15196 means, and the implementation has changed over time.
15197
15198 Basically, it tries to remove all noise from lines before comparing.
15199 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
15200 out of the strings before comparing the results.  This often leads to
15201 adequate results---even when faced with strings generated by text
15202 manglers masquerading as newsreaders.
15203
15204
15205 @node Thwarting Email Spam
15206 @section Thwarting Email Spam
15207 @cindex email spam
15208 @cindex spam
15209 @cindex UCE
15210 @cindex unsolicited commercial email
15211
15212 In these last days of the Usenet, commercial vultures are hanging about
15213 and grepping through news like crazy to find email addresses they can
15214 foist off their scams and products to.  As a reaction to this, many
15215 people have started putting nonsense addresses into their @code{From}
15216 lines.  I think this is counterproductive---it makes it difficult for
15217 people to send you legitimate mail in response to things you write, as
15218 well as making it difficult to see who wrote what.  This rewriting may
15219 perhaps be a bigger menace than the unsolicited commercial email itself
15220 in the end.
15221
15222 The biggest problem I have with email spam is that it comes in under
15223 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
15224 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
15225 mail group, only to find two pyramid schemes, seven advertisements
15226 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
15227 and one mail asking me to repent and find some god.
15228
15229 This is annoying.
15230
15231 The way to deal with this is having Gnus split out all spam into a
15232 @samp{spam} mail group (@pxref{Splitting Mail}).
15233
15234 First, pick one (1) valid mail address that you can be reached at, and
15235 put it in your @code{From} header of all your news articles.  (I've
15236 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
15237 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
15238 sysadm whether your sendmail installation accepts keywords in the local
15239 part of the mail address.)
15240
15241 @lisp
15242 (setq message-default-news-headers
15243       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
15244 @end lisp
15245
15246 Then put the following split rule in @code{nnmail-split-fancy}
15247 (@pxref{Fancy Mail Splitting}):
15248
15249 @lisp
15250 (
15251  ...
15252  (to "larsi@@trym.ifi.uio.no"
15253       (| ("subject" "re:.*" "misc")
15254          ("references" ".*@@.*" "misc")
15255          "spam"))
15256  ...
15257 )
15258 @end lisp
15259
15260 This says that all mail to this address is suspect, but if it has a
15261 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
15262 header, it's probably ok.  All the rest goes to the @samp{spam} group.
15263 (This idea probably comes from Tim Pierce.)
15264
15265 In addition, many mail spammers talk directly to your @code{smtp} server
15266 and do not include your email address explicitly in the @code{To}
15267 header.  Why they do this is unknown---perhaps it's to thwart this
15268 thwarting scheme?  In any case, this is trivial to deal with---you just
15269 put anything not addressed to you in the @samp{spam} group by ending
15270 your fancy split rule in this way:
15271
15272 @lisp
15273 (
15274  ...
15275  (to "larsi" "misc")
15276  "spam")
15277 @end lisp
15278
15279 In my experience, this will sort virtually everything into the right
15280 group.  You still have to check the @samp{spam} group from time to time to
15281 check for legitimate mail, though.  If you feel like being a good net
15282 citizen, you can even send off complaints to the proper authorities on
15283 each unsolicited commercial email---at your leisure.
15284
15285 If you are also a lazy net citizen, you will probably prefer complaining
15286 automatically with the @file{gnus-junk.el} package, available FOR FREE
15287 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
15288 Since most e-mail spam is sent automatically, this may reconcile the
15289 cosmic balance somewhat.
15290
15291 This works for me.  It allows people an easy way to contact me (they can
15292 just press @kbd{r} in the usual way), and I'm not bothered at all with
15293 spam.  It's a win-win situation.  Forging @code{From} headers to point
15294 to non-existent domains is yucky, in my opinion.
15295
15296
15297 @node Various Various
15298 @section Various Various
15299 @cindex mode lines
15300 @cindex highlights
15301
15302 @table @code
15303
15304 @item gnus-home-directory
15305 All Gnus path variables will be initialized from this variable, which
15306 defaults to @file{~/}.
15307
15308 @item gnus-directory
15309 @vindex gnus-directory
15310 Most Gnus storage path variables will be initialized from this variable,
15311 which defaults to the @samp{SAVEDIR} environment variable, or
15312 @file{~/News/} if that variable isn't set.
15313
15314 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
15315 This means that other directory variables that are initialized from this
15316 variable won't be set properly if you set this variable in
15317 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
15318
15319 @item gnus-default-directory
15320 @vindex gnus-default-directory
15321 Not related to the above variable at all---this variable says what the
15322 default directory of all Gnus buffers should be.  If you issue commands
15323 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
15324 default directory.  If this variable is @code{nil} (which is the
15325 default), the default directory will be the default directory of the
15326 buffer you were in when you started Gnus.
15327
15328 @item gnus-verbose
15329 @vindex gnus-verbose
15330 This variable is an integer between zero and ten.  The higher the value,
15331 the more messages will be displayed.  If this variable is zero, Gnus
15332 will never flash any messages, if it is seven (which is the default),
15333 most important messages will be shown, and if it is ten, Gnus won't ever
15334 shut up, but will flash so many messages it will make your head swim.
15335
15336 @item gnus-verbose-backends
15337 @vindex gnus-verbose-backends
15338 This variable works the same way as @code{gnus-verbose}, but it applies
15339 to the Gnus backends instead of Gnus proper.
15340
15341 @item nnheader-max-head-length
15342 @vindex nnheader-max-head-length
15343 When the backends read straight heads of articles, they all try to read
15344 as little as possible.  This variable (default 4096) specifies
15345 the absolute max length the backends will try to read before giving up
15346 on finding a separator line between the head and the body.  If this
15347 variable is @code{nil}, there is no upper read bound.  If it is
15348 @code{t}, the backends won't try to read the articles piece by piece,
15349 but read the entire articles.  This makes sense with some versions of
15350 @code{ange-ftp} or @code{efs}.
15351
15352 @item nnheader-head-chop-length
15353 @vindex nnheader-head-chop-length
15354 This variable (default 2048) says how big a piece of each article to
15355 read when doing the operation described above.
15356
15357 @item nnheader-file-name-translation-alist
15358 @vindex nnheader-file-name-translation-alist
15359 @cindex file names
15360 @cindex invalid characters in file names
15361 @cindex characters in file names
15362 This is an alist that says how to translate characters in file names.
15363 For instance, if @samp{:} is invalid as a file character in file names
15364 on your system (you OS/2 user you), you could say something like:
15365
15366 @lisp
15367 (setq nnheader-file-name-translation-alist
15368       '((?: . ?_)))
15369 @end lisp
15370
15371 In fact, this is the default value for this variable on OS/2 and MS
15372 Windows (phooey) systems.
15373
15374 @item gnus-hidden-properties
15375 @vindex gnus-hidden-properties
15376 This is a list of properties to use to hide ``invisible'' text.  It is
15377 @code{(invisible t intangible t)} by default on most systems, which
15378 makes invisible text invisible and intangible.
15379
15380 @item gnus-parse-headers-hook
15381 @vindex gnus-parse-headers-hook
15382 A hook called before parsing headers.  It can be used, for instance, to
15383 gather statistics on the headers fetched, or perhaps you'd like to prune
15384 some headers.  I don't see why you'd want that, though.
15385
15386 @item gnus-shell-command-separator
15387 @vindex gnus-shell-command-separator
15388 String used to separate two shell commands.  The default is @samp{;}.
15389
15390
15391 @end table
15392
15393
15394 @node The End
15395 @chapter The End
15396
15397 Well, that's the manual---you can get on with your life now.  Keep in
15398 touch.  Say hello to your cats from me.
15399
15400 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
15401
15402 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
15403
15404 @quotation
15405 @strong{Te Deum}
15406
15407 @sp 1
15408 Not because of victories @*
15409 I sing,@*
15410 having none,@*
15411 but for the common sunshine,@*
15412 the breeze,@*
15413 the largess of the spring.
15414
15415 @sp 1
15416 Not for victory@*
15417 but for the day's work done@*
15418 as well as I was able;@*
15419 not for a seat upon the dais@*
15420 but at the common table.@*
15421 @end quotation
15422
15423
15424 @node Appendices
15425 @chapter Appendices
15426
15427 @menu
15428 * History::                        How Gnus got where it is today.
15429 * Terminology::                    We use really difficult, like, words here.
15430 * Customization::                  Tailoring Gnus to your needs.
15431 * Troubleshooting::                What you might try if things do not work.
15432 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
15433 * Emacs for Heathens::             A short introduction to Emacsian terms.
15434 * Frequently Asked Questions::     A question-and-answer session.
15435 @end menu
15436
15437
15438 @node History
15439 @section History
15440
15441 @cindex history
15442 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
15443 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
15444
15445 If you want to investigate the person responsible for this outrage, you
15446 can point your (feh!) web browser to
15447 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
15448 distribution point for the new and spiffy versions of Gnus, and is known
15449 as The Site That Destroys Newsrcs And Drives People Mad.
15450
15451 During the first extended alpha period of development, the new Gnus was
15452 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
15453 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
15454 (Besides, the ``Gnus'' in this abbreviation should probably be
15455 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
15456 appropriate name, don't you think?)
15457
15458 In any case, after spending all that energy on coming up with a new and
15459 spunky name, we decided that the name was @emph{too} spunky, so we
15460 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
15461 ``@sc{gnus}''.  New vs. old.
15462
15463 The first ``proper'' release of Gnus 5 was done in November 1995 when it
15464 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
15465 plus 15 Gnus 5.0 releases).
15466
15467 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
15468 releases)) was released under the name ``Gnus 5.2'' (40 releases).
15469
15470 On July 28th 1996 work on Red Gnus was begun, and it was released on
15471 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
15472
15473 On September 13th 1997, Quassia Gnus was started and lasted 37
15474 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
15475
15476 If you happen upon a version of Gnus that has a prefixed name --
15477 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
15478 don't panic.  Don't let it know that you're frightened.  Back away.
15479 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
15480 out of its reach.  Find a proper released version of Gnus and snuggle up
15481 to that instead.
15482
15483 @menu
15484 * Why?::                What's the point of Gnus?
15485 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
15486 * Conformity::          Gnus tries to conform to all standards.
15487 * Emacsen::             Gnus can be run on a few modern Emacsen.
15488 * Contributors::        Oodles of people.
15489 * New Features::        Pointers to some of the new stuff in Gnus.
15490 * Newest Features::     Features so new that they haven't been written yet.
15491 @end menu
15492
15493
15494 @node Why?
15495 @subsection Why?
15496
15497 What's the point of Gnus?
15498
15499 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
15500 newsreader, that lets you do anything you can think of.  That was my
15501 original motivation, but while working on Gnus, it has become clear to
15502 me that this generation of newsreaders really belong in the stone age.
15503 Newsreaders haven't developed much since the infancy of the net.  If the
15504 volume continues to rise with the current rate of increase, all current
15505 newsreaders will be pretty much useless.  How do you deal with
15506 newsgroups that have thousands of new articles each day?  How do you
15507 keep track of millions of people who post?
15508
15509 Gnus offers no real solutions to these questions, but I would very much
15510 like to see Gnus being used as a testing ground for new methods of
15511 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
15512 to separate the newsreader from the backends, Gnus now offers a simple
15513 interface for anybody who wants to write new backends for fetching mail
15514 and news from different sources.  I have added hooks for customizations
15515 everywhere I could imagine it being useful.  By doing so, I'm inviting
15516 every one of you to explore and invent.
15517
15518 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
15519 @kbd{C-u 100 M-x all-hail-xemacs}.
15520
15521
15522 @node Compatibility
15523 @subsection Compatibility
15524
15525 @cindex compatibility
15526 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
15527 bindings have been kept.  More key bindings have been added, of course,
15528 but only in one or two obscure cases have old bindings been changed.
15529
15530 Our motto is:
15531 @quotation
15532 @cartouche
15533 @center In a cloud bones of steel.
15534 @end cartouche
15535 @end quotation
15536
15537 All commands have kept their names.  Some internal functions have changed
15538 their names.
15539
15540 The @code{gnus-uu} package has changed drastically. @xref{Decoding
15541 Articles}.
15542
15543 One major compatibility question is the presence of several summary
15544 buffers.  All variables relevant while reading a group are
15545 buffer-local to the summary buffer they belong in.  Although many
15546 important variables have their values copied into their global
15547 counterparts whenever a command is executed in the summary buffer, this
15548 change might lead to incorrect values being used unless you are careful.
15549
15550 All code that relies on knowledge of @sc{gnus} internals will probably
15551 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
15552 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
15553 maintains a hash table that points to the entries in this alist (which
15554 speeds up many functions), and changing the alist directly will lead to
15555 peculiar results.
15556
15557 @cindex hilit19
15558 @cindex highlighting
15559 Old hilit19 code does not work at all.  In fact, you should probably
15560 remove all hilit code from all Gnus hooks
15561 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
15562 Gnus provides various integrated functions for highlighting.  These are
15563 faster and more accurate.  To make life easier for everybody, Gnus will
15564 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
15565 Away!
15566
15567 Packages like @code{expire-kill} will no longer work.  As a matter of
15568 fact, you should probably remove all old @sc{gnus} packages (and other
15569 code) when you start using Gnus.  More likely than not, Gnus already
15570 does what you have written code to make @sc{gnus} do.  (Snicker.)
15571
15572 Even though old methods of doing things are still supported, only the
15573 new methods are documented in this manual.  If you detect a new method of
15574 doing something while reading this manual, that does not mean you have
15575 to stop doing it the old way.
15576
15577 Gnus understands all @sc{gnus} startup files.
15578
15579 @kindex M-x gnus-bug
15580 @findex gnus-bug
15581 @cindex reporting bugs
15582 @cindex bugs
15583 Overall, a casual user who hasn't written much code that depends on
15584 @sc{gnus} internals should suffer no problems.  If problems occur,
15585 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
15586
15587 @vindex gnus-bug-create-help-buffer
15588 If you are in the habit of sending bug reports @emph{very} often, you
15589 may find the helpful help buffer annoying after a while.  If so, set
15590 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
15591 up at you.
15592
15593
15594 @node Conformity
15595 @subsection Conformity
15596
15597 No rebels without a clue here, ma'am.  We conform to all standards known
15598 to (wo)man.  Except for those standards and/or conventions we disagree
15599 with, of course.
15600
15601 @table @strong
15602
15603 @item RFC 822
15604 @cindex RFC 822
15605 There are no known breaches of this standard.
15606
15607 @item RFC 1036
15608 @cindex RFC 1036
15609 There are no known breaches of this standard, either.
15610
15611 @item Son-of-RFC 1036
15612 @cindex Son-of-RFC 1036
15613 We do have some breaches to this one.
15614
15615 @table @emph
15616
15617 @item MIME
15618 Gnus does no MIME handling, and this standard-to-be seems to think that
15619 MIME is the bees' knees, so we have major breakage here.
15620
15621 @item X-Newsreader
15622 This is considered to be a ``vanity header'', while I consider it to be
15623 consumer information.  After seeing so many badly formatted articles
15624 coming from @code{tin} and @code{Netscape} I know not to use either of
15625 those for posting articles.  I would not have known that if it wasn't
15626 for the @code{X-Newsreader} header.
15627 @end table
15628
15629 @end table
15630
15631 If you ever notice Gnus acting non-compliant with regards to the texts
15632 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
15633 know.
15634
15635
15636 @node Emacsen
15637 @subsection Emacsen
15638 @cindex Emacsen
15639 @cindex XEmacs
15640 @cindex Mule
15641 @cindex Emacs
15642
15643 Gnus should work on :
15644
15645 @itemize @bullet
15646
15647 @item
15648 Emacs 19.32 and up.
15649
15650 @item
15651 XEmacs 19.14 and up.
15652
15653 @item
15654 Mule versions based on Emacs 19.32 and up.
15655
15656 @end itemize
15657
15658 Gnus will absolutely not work on any Emacsen older than that.  Not
15659 reliably, at least.
15660
15661 There are some vague differences between Gnus on the various
15662 platforms---XEmacs features more graphics (a logo and a toolbar)---but
15663 other than that, things should look pretty much the same under all
15664 Emacsen.
15665
15666
15667 @node Contributors
15668 @subsection Contributors
15669 @cindex contributors
15670
15671 The new Gnus version couldn't have been done without the help of all the
15672 people on the (ding) mailing list.  Every day for over a year I have
15673 gotten billions of nice bug reports from them, filling me with joy,
15674 every single one of them.  Smooches.  The people on the list have been
15675 tried beyond endurance, what with my ``oh, that's a neat idea <type
15676 type>, yup, I'll release it right away <ship off> no wait, that doesn't
15677 work at all <type type>, yup, I'll ship that one off right away <ship
15678 off> no, wait, that absolutely does not work'' policy for releases.
15679 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
15680 ``worser''? ``much worser''?  ``worsest''?)
15681
15682 I would like to take this opportunity to thank the Academy for...  oops,
15683 wrong show.
15684
15685 @itemize @bullet
15686
15687 @item
15688 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
15689
15690 @item
15691 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
15692 well as numerous other things).
15693
15694 @item
15695 Luis Fernandes---design and graphics.
15696
15697 @item
15698 Erik Naggum---help, ideas, support, code and stuff.
15699
15700 @item
15701 Wes Hardaker---@file{gnus-picon.el} and the manual section on
15702 @dfn{picons} (@pxref{Picons}).
15703
15704 @item
15705 Kim-Minh Kaplan---further work on the picon code.
15706
15707 @item
15708 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
15709 (@pxref{GroupLens}).
15710
15711 @item
15712 Sudish Joseph---innumerable bug fixes.
15713
15714 @item
15715 Ilja Weis---@file{gnus-topic.el}.
15716
15717 @item
15718 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
15719
15720 @item
15721 Vladimir Alexiev---the refcard and reference booklets.
15722
15723 @item
15724 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
15725 distribution by Felix Lee and JWZ.
15726
15727 @item
15728 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
15729
15730 @item
15731 Peter Mutsaers---orphan article scoring code.
15732
15733 @item
15734 Ken Raeburn---POP mail support.
15735
15736 @item
15737 Hallvard B Furuseth---various bits and pieces, especially dealing with
15738 .newsrc files.
15739
15740 @item
15741 Brian Edmonds---@file{gnus-bbdb.el}.
15742
15743 @item
15744 David Moore---rewrite of @file{nnvirtual.el} and many other things.
15745
15746 @item
15747 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
15748
15749 @item
15750 François Pinard---many, many interesting and thorough bug reports, as
15751 well as autoconf support.
15752
15753 @end itemize
15754
15755 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
15756 Borges, and Jost Krieger proof-reading parts of the manual.
15757
15758 The following people have contributed many patches and suggestions:
15759
15760 Christopher Davis,
15761 Andrew Eskilsson,
15762 Kai Grossjohann,
15763 David KÃ¥gedal,
15764 Richard Pieri,
15765 Fabrice Popineau,
15766 Daniel Quinlan,
15767 Jason L. Tibbitts, III,
15768 and
15769 Jack Vinson.
15770
15771 Also thanks to the following for patches and stuff:
15772
15773 Jari Aalto,
15774 Adrian Aichner,
15775 Vladimir Alexiev,
15776 Russ Allbery,
15777 Peter Arius,
15778 Matt Armstrong,
15779 Marc Auslander,
15780 Frank Bennett,
15781 Robert Bihlmeyer,
15782 Chris Bone,
15783 Mark Borges,
15784 Mark Boyns,
15785 Lance A. Brown,
15786 Kees de Bruin,
15787 Martin Buchholz,
15788 Joe Buehler,
15789 Kevin Buhr,
15790 Alastair Burt,
15791 Joao Cachopo,
15792 Zlatko Calusic,
15793 Massimo Campostrini,
15794 Castor,
15795 David Charlap,
15796 Dan Christensen,
15797 Kevin Christian,
15798 Michael R. Cook,
15799 Glenn Coombs,
15800 Frank D. Cringle,
15801 Geoffrey T. Dairiki,
15802 Andre Deparade,
15803 Ulrik Dickow,
15804 Dave Disser,
15805 Rui-Tao Dong, @c ?
15806 Joev Dubach,
15807 Michael Welsh Duggan,
15808 Dave Edmondson,
15809 Paul Eggert,
15810 Enami Tsugutomo, @c Enami
15811 Michael Ernst,
15812 Luc Van Eycken,
15813 Sam Falkner,
15814 Nelson Jose dos Santos Ferreira,
15815 Sigbjorn Finne,
15816 Decklin Foster,
15817 Gary D. Foster,
15818 Paul Franklin,
15819 Guy Geens,
15820 Arne Georg Gleditsch,
15821 David S. Goldberg,
15822 Michelangelo Grigni,
15823 D. Hall,
15824 Magnus Hammerin,
15825 Kenichi Handa, @c Handa
15826 Raja R. Harinath,
15827 Yoshiki Hayashi, @c ?
15828 P. E. Jareth Hein,
15829 Hisashige Kenji, @c Hisashige
15830 Marc Horowitz,
15831 Gunnar Horrigmo,
15832 Richard Hoskins,
15833 Brad Howes,
15834 François Felix Ingrand,
15835 Ishikawa Ichiro, @c Ishikawa
15836 Lee Iverson,
15837 Iwamuro Motonori, @c Iwamuro
15838 Rajappa Iyer,
15839 Andreas Jaeger,
15840 Randell Jesup,
15841 Fred Johansen,
15842 Gareth Jones,
15843 Simon Josefsson,
15844 Greg Klanderman,
15845 Karl Kleinpaste,
15846 Peter Skov Knudsen,
15847 Shuhei Kobayashi, @c Kobayashi
15848 Koseki Yoshinori, @c Koseki
15849 Thor Kristoffersen,
15850 Jens Lautenbacher,
15851 Martin Larose,
15852 Seokchan Lee, @c Lee
15853 Carsten Leonhardt,
15854 James LewisMoss,
15855 Christian Limpach,
15856 Markus Linnala,
15857 Dave Love,
15858 Mike McEwan,
15859 Tonny Madsen,
15860 Shlomo Mahlab,
15861 Nat Makarevitch,
15862 Istvan Marko,
15863 David Martin,
15864 Jason R. Mastaler,
15865 Gordon Matzigkeit,
15866 Timo Metzemakers,
15867 Richard Mlynarik,
15868 Lantz Moore,
15869 Morioka Tomohiko, @c Morioka
15870 Erik Toubro Nielsen,
15871 Hrvoje Niksic,
15872 Andy Norman,
15873 Fred Oberhauser,
15874 C. R. Oldham,
15875 Alexandre Oliva,
15876 Ken Olstad,
15877 Masaharu Onishi, @c Onishi
15878 Hideki Ono, @c Ono
15879 William Perry,
15880 Stephen Peters,
15881 Jens-Ulrik Holger Petersen,
15882 Ulrich Pfeifer,
15883 Matt Pharr,
15884 John McClary Prevost,
15885 Bill Pringlemeir,
15886 Mike Pullen,
15887 Jim Radford,
15888 Colin Rafferty,
15889 Lasse Rasinen,
15890 Lars Balker Rasmussen,
15891 Joe Reiss,
15892 Renaud Rioboo,
15893 Roland B. Roberts,
15894 Bart Robinson,
15895 Christian von Roques,
15896 Jason Rumney,
15897 Wolfgang Rupprecht,
15898 Jay Sachs,
15899 Dewey M. Sasser,
15900 Loren Schall,
15901 Dan Schmidt,
15902 Ralph Schleicher,
15903 Philippe Schnoebelen,
15904 Andreas Schwab,
15905 Randal L. Schwartz,
15906 Justin Sheehy,
15907 Danny Siu,
15908 Matt Simmons,
15909 Paul D. Smith,
15910 Jeff Sparkes,
15911 Toby Speight,
15912 Michael Sperber,
15913 Darren Stalder,
15914 Richard Stallman,
15915 Greg Stark,
15916 Sam Steingold,
15917 Paul Stodghill,
15918 Kurt Swanson,
15919 Samuel Tardieu,
15920 Teddy,
15921 Chuck Thompson,
15922 Philippe Troin,
15923 James Troup,
15924 Trung Tran-Duc,
15925 Aaron M. Ucko,
15926 Aki Vehtari,
15927 Didier Verna,
15928 Jan Vroonhof,
15929 Stefan Waldherr,
15930 Pete Ware,
15931 Barry A. Warsaw,
15932 Christoph Wedler,
15933 Joe Wells,
15934 Katsumi Yamaoka, @c Yamaoka
15935 and
15936 Shenghuo Zhu. @c Zhu
15937
15938 For a full overview of what each person has done, the ChangeLogs
15939 included in the Gnus alpha distributions should give ample reading
15940 (550kB and counting).
15941
15942 Apologies to everybody that I've forgotten, of which there are many, I'm
15943 sure.
15944
15945 Gee, that's quite a list of people.  I guess that must mean that there
15946 actually are people who are using Gnus.  Who'd'a thunk it!
15947
15948
15949 @node New Features
15950 @subsection New Features
15951 @cindex new features
15952
15953 @menu
15954 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
15955 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
15956 * Red Gnus::           Third time best---Gnus 5.4/5.5.
15957 * Quassia Gnus::       Two times two is four, or Gnus 5.6.
15958 @end menu
15959
15960 These lists are, of course, just @emph{short} overviews of the
15961 @emph{most} important new features.  No, really.  There are tons more.
15962 Yes, we have feeping creaturism in full effect.
15963
15964
15965 @node ding Gnus
15966 @subsubsection (ding) Gnus
15967
15968 New features in Gnus 5.0/5.1:
15969
15970 @itemize @bullet
15971
15972 @item
15973 The look of all buffers can be changed by setting format-like variables
15974 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
15975
15976 @item
15977 Local spool and several @sc{nntp} servers can be used at once
15978 (@pxref{Select Methods}).
15979
15980 @item
15981 You can combine groups into virtual groups (@pxref{Virtual Groups}).
15982
15983 @item
15984 You can read a number of different mail formats (@pxref{Getting Mail}).
15985 All the mail backends implement a convenient mail expiry scheme
15986 (@pxref{Expiring Mail}).
15987
15988 @item
15989 Gnus can use various strategies for gathering threads that have lost
15990 their roots (thereby gathering loose sub-threads into one thread) or it
15991 can go back and retrieve enough headers to build a complete thread
15992 (@pxref{Customizing Threading}).
15993
15994 @item
15995 Killed groups can be displayed in the group buffer, and you can read
15996 them as well (@pxref{Listing Groups}).
15997
15998 @item
15999 Gnus can do partial group updates---you do not have to retrieve the
16000 entire active file just to check for new articles in a few groups
16001 (@pxref{The Active File}).
16002
16003 @item
16004 Gnus implements a sliding scale of subscribedness to groups
16005 (@pxref{Group Levels}).
16006
16007 @item
16008 You can score articles according to any number of criteria
16009 (@pxref{Scoring}).  You can even get Gnus to find out how to score
16010 articles for you (@pxref{Adaptive Scoring}).
16011
16012 @item
16013 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
16014 manner, so it should be difficult to lose much data on what you have
16015 read if your machine should go down (@pxref{Auto Save}).
16016
16017 @item
16018 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
16019 the @file{.emacs} file.
16020
16021 @item
16022 You can set the process mark on both groups and articles and perform
16023 operations on all the marked items (@pxref{Process/Prefix}).
16024
16025 @item
16026 You can grep through a subset of groups and create a group from the
16027 results (@pxref{Kibozed Groups}).
16028
16029 @item
16030 You can list subsets of groups according to, well, anything
16031 (@pxref{Listing Groups}).
16032
16033 @item
16034 You can browse foreign servers and subscribe to groups from those
16035 servers (@pxref{Browse Foreign Server}).
16036
16037 @item
16038 Gnus can fetch articles, asynchronously, on a second connection to the
16039 server (@pxref{Asynchronous Fetching}).
16040
16041 @item
16042 You can cache articles locally (@pxref{Article Caching}).
16043
16044 @item
16045 The uudecode functions have been expanded and generalized
16046 (@pxref{Decoding Articles}).
16047
16048 @item
16049 You can still post uuencoded articles, which was a little-known feature
16050 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
16051
16052 @item
16053 Fetching parents (and other articles) now actually works without
16054 glitches (@pxref{Finding the Parent}).
16055
16056 @item
16057 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
16058
16059 @item
16060 Digests (and other files) can be used as the basis for groups
16061 (@pxref{Document Groups}).
16062
16063 @item
16064 Articles can be highlighted and customized (@pxref{Customizing
16065 Articles}).
16066
16067 @item
16068 URLs and other external references can be buttonized (@pxref{Article
16069 Buttons}).
16070
16071 @item
16072 You can do lots of strange stuff with the Gnus window & frame
16073 configuration (@pxref{Windows Configuration}).
16074
16075 @item
16076 You can click on buttons instead of using the keyboard
16077 (@pxref{Buttons}).
16078
16079 @end itemize
16080
16081
16082 @node September Gnus
16083 @subsubsection September Gnus
16084
16085 @iftex
16086 @iflatex
16087 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
16088 @end iflatex
16089 @end iftex
16090
16091 New features in Gnus 5.2/5.3:
16092
16093 @itemize @bullet
16094
16095 @item
16096 A new message composition mode is used.  All old customization variables
16097 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
16098 now obsolete.
16099
16100 @item
16101 Gnus is now able to generate @dfn{sparse} threads---threads where
16102 missing articles are represented by empty nodes (@pxref{Customizing
16103 Threading}).
16104
16105 @lisp
16106 (setq gnus-build-sparse-threads 'some)
16107 @end lisp
16108
16109 @item
16110 Outgoing articles are stored on a special archive server
16111 (@pxref{Archived Messages}).
16112
16113 @item
16114 Partial thread regeneration now happens when articles are
16115 referred.
16116
16117 @item
16118 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
16119
16120 @item
16121 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
16122
16123 @item
16124 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
16125
16126 @lisp
16127 (setq gnus-use-trees t)
16128 @end lisp
16129
16130 @item
16131 An @code{nn}-like pick-and-read minor mode is available for the summary
16132 buffers (@pxref{Pick and Read}).
16133
16134 @lisp
16135 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
16136 @end lisp
16137
16138 @item
16139 In binary groups you can use a special binary minor mode (@pxref{Binary
16140 Groups}).
16141
16142 @item
16143 Groups can be grouped in a folding topic hierarchy (@pxref{Group
16144 Topics}).
16145
16146 @lisp
16147 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
16148 @end lisp
16149
16150 @item
16151 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
16152
16153 @item
16154 Groups can now have a score, and bubbling based on entry frequency
16155 is possible (@pxref{Group Score}).
16156
16157 @lisp
16158 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
16159 @end lisp
16160
16161 @item
16162 Groups can be process-marked, and commands can be performed on
16163 groups of groups (@pxref{Marking Groups}).
16164
16165 @item
16166 Caching is possible in virtual groups.
16167
16168 @item
16169 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
16170 news batches, ClariNet briefs collections, and just about everything
16171 else (@pxref{Document Groups}).
16172
16173 @item
16174 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
16175 (@pxref{SOUP}).
16176
16177 @item
16178 The Gnus cache is much faster.
16179
16180 @item
16181 Groups can be sorted according to many criteria (@pxref{Sorting
16182 Groups}).
16183
16184 @item
16185 New group parameters have been introduced to set list-addresses and
16186 expiry times (@pxref{Group Parameters}).
16187
16188 @item
16189 All formatting specs allow specifying faces to be used
16190 (@pxref{Formatting Fonts}).
16191
16192 @item
16193 There are several more commands for setting/removing/acting on process
16194 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
16195
16196 @item
16197 The summary buffer can be limited to show parts of the available
16198 articles based on a wide range of criteria.  These commands have been
16199 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
16200
16201 @item
16202 Articles can be made persistent with the @kbd{*} command
16203 (@pxref{Persistent Articles}).
16204
16205 @item
16206 All functions for hiding article elements are now toggles.
16207
16208 @item
16209 Article headers can be buttonized (@pxref{Article Washing}).
16210
16211 @lisp
16212 (add-hook 'gnus-article-display-hook
16213           'gnus-article-add-buttons-to-head)
16214 @end lisp
16215
16216 @item
16217 All mail backends support fetching articles by @code{Message-ID}.
16218
16219 @item
16220 Duplicate mail can now be treated properly (@pxref{Duplicates}).
16221
16222 @item
16223 All summary mode commands are available directly from the article
16224 buffer (@pxref{Article Keymap}).
16225
16226 @item
16227 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
16228 Configuration}).
16229
16230 @item
16231 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
16232 @iftex
16233 @iflatex
16234 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
16235 @end iflatex
16236 @end iftex
16237
16238 @item
16239 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
16240
16241 @lisp
16242 (setq gnus-use-nocem t)
16243 @end lisp
16244
16245 @item
16246 Groups can be made permanently visible (@pxref{Listing Groups}).
16247
16248 @lisp
16249 (setq gnus-permanently-visible-groups "^nnml:")
16250 @end lisp
16251
16252 @item
16253 Many new hooks have been introduced to make customizing easier.
16254
16255 @item
16256 Gnus respects the @code{Mail-Copies-To} header.
16257
16258 @item
16259 Threads can be gathered by looking at the @code{References} header
16260 (@pxref{Customizing Threading}).
16261
16262 @lisp
16263 (setq gnus-summary-thread-gathering-function
16264       'gnus-gather-threads-by-references)
16265 @end lisp
16266
16267 @item
16268 Read articles can be stored in a special backlog buffer to avoid
16269 refetching (@pxref{Article Backlog}).
16270
16271 @lisp
16272 (setq gnus-keep-backlog 50)
16273 @end lisp
16274
16275 @item
16276 A clean copy of the current article is always stored in a separate
16277 buffer to allow easier treatment.
16278
16279 @item
16280 Gnus can suggest where to save articles (@pxref{Saving Articles}).
16281
16282 @item
16283 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
16284 Articles}).
16285
16286 @lisp
16287 (setq gnus-prompt-before-saving t)
16288 @end lisp
16289
16290 @item
16291 @code{gnus-uu} can view decoded files asynchronously while fetching
16292 articles (@pxref{Other Decode Variables}).
16293
16294 @lisp
16295 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
16296 @end lisp
16297
16298 @item
16299 Filling in the article buffer now works properly on cited text
16300 (@pxref{Article Washing}).
16301
16302 @item
16303 Hiding cited text adds buttons to toggle hiding, and how much
16304 cited text to hide is now customizable (@pxref{Article Hiding}).
16305
16306 @lisp
16307 (setq gnus-cited-lines-visible 2)
16308 @end lisp
16309
16310 @item
16311 Boring headers can be hidden (@pxref{Article Hiding}).
16312
16313 @lisp
16314 (add-hook 'gnus-article-display-hook
16315           'gnus-article-hide-boring-headers t)
16316 @end lisp
16317
16318 @item
16319 Default scoring values can now be set from the menu bar.
16320
16321 @item
16322 Further syntax checking of outgoing articles have been added.
16323
16324 @end itemize
16325
16326
16327 @node Red Gnus
16328 @subsubsection Red Gnus
16329
16330 New features in Gnus 5.4/5.5:
16331
16332 @iftex
16333 @iflatex
16334 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
16335 @end iflatex
16336 @end iftex
16337
16338 @itemize @bullet
16339
16340 @item
16341 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
16342
16343 @item
16344 Article prefetching functionality has been moved up into
16345 Gnus (@pxref{Asynchronous Fetching}).
16346
16347 @item
16348 Scoring can now be performed with logical operators like @code{and},
16349 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16350 Scoring}).
16351
16352 @item
16353 Article washing status can be displayed in the
16354 article mode line (@pxref{Misc Article}).
16355
16356 @item
16357 @file{gnus.el} has been split into many smaller files.
16358
16359 @item
16360 Suppression of duplicate articles based on Message-ID can be done
16361 (@pxref{Duplicate Suppression}).
16362
16363 @lisp
16364 (setq gnus-suppress-duplicates t)
16365 @end lisp
16366
16367 @item
16368 New variables for specifying what score and adapt files are to be
16369 considered home score and adapt files (@pxref{Home Score File}) have
16370 been added.
16371
16372 @item
16373 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
16374 Server Internals}).
16375
16376 @item
16377 Groups can inherit group parameters from parent topics (@pxref{Topic
16378 Parameters}).
16379
16380 @item
16381 Article editing has been revamped and is now actually usable.
16382
16383 @item
16384 Signatures can be recognized in more intelligent fashions
16385 (@pxref{Article Signature}).
16386
16387 @item
16388 Summary pick mode has been made to look more @code{nn}-like.  Line
16389 numbers are displayed and the @kbd{.} command can be used to pick
16390 articles (@code{Pick and Read}).
16391
16392 @item
16393 Commands for moving the @file{.newsrc.eld} from one server to
16394 another have been added (@pxref{Changing Servers}).
16395
16396 @item
16397 There's a way now to specify that ``uninteresting'' fields be suppressed
16398 when generating lines in buffers (@pxref{Advanced Formatting}).
16399
16400 @item
16401 Several commands in the group buffer can be undone with @kbd{M-C-_}
16402 (@pxref{Undo}).
16403
16404 @item
16405 Scoring can be done on words using the new score type @code{w}
16406 (@pxref{Score File Format}).
16407
16408 @item
16409 Adaptive scoring can be done on a Subject word-by-word basis
16410 (@pxref{Adaptive Scoring}).
16411
16412 @lisp
16413 (setq gnus-use-adaptive-scoring '(word))
16414 @end lisp
16415
16416 @item
16417 Scores can be decayed (@pxref{Score Decays}).
16418
16419 @lisp
16420 (setq gnus-decay-scores t)
16421 @end lisp
16422
16423 @item
16424 Scoring can be performed using a regexp on the Date header.  The Date is
16425 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
16426
16427 @item
16428 A new command has been added to remove all data on articles from
16429 the native server (@pxref{Changing Servers}).
16430
16431 @item
16432 A new command for reading collections of documents
16433 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
16434 (@pxref{Really Various Summary Commands}).
16435
16436 @item
16437 Process mark sets can be pushed and popped (@pxref{Setting Process
16438 Marks}).
16439
16440 @item
16441 A new mail-to-news backend makes it possible to post even when the NNTP
16442 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
16443
16444 @item
16445 A new backend for reading searches from Web search engines
16446 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
16447 (@pxref{Web Searches}).
16448
16449 @item
16450 Groups inside topics can now be sorted using the standard sorting
16451 functions, and each topic can be sorted independently (@pxref{Topic
16452 Sorting}).
16453
16454 @item
16455 Subsets of the groups can be sorted independently (@code{Sorting
16456 Groups}).
16457
16458 @item
16459 Cached articles can be pulled into the groups (@pxref{Summary Generation
16460 Commands}).
16461 @iftex
16462 @iflatex
16463 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
16464 @end iflatex
16465 @end iftex
16466
16467 @item
16468 Score files are now applied in a more reliable order (@pxref{Score
16469 Variables}).
16470
16471 @item
16472 Reports on where mail messages end up can be generated (@pxref{Splitting
16473 Mail}).
16474
16475 @item
16476 More hooks and functions have been added to remove junk from incoming
16477 mail before saving the mail (@pxref{Washing Mail}).
16478
16479 @item
16480 Emphasized text can be properly fontisized:
16481
16482 @lisp
16483 (add-hook 'gnus-article-display-hook
16484           'gnus-article-emphasize)
16485 @end lisp
16486
16487 @end itemize
16488
16489
16490 @node Quassia Gnus
16491 @subsubsection Quassia Gnus
16492
16493 New features in Gnus 5.6:
16494
16495 @itemize @bullet
16496
16497 @item
16498 New functionality for using Gnus as an offline newsreader has been
16499 added.  A plethora of new commands and modes have been added.  See
16500 @pxref{Gnus Unplugged} for the full story.
16501
16502 @item
16503  The @code{nndraft} backend has returned, but works differently than
16504 before.  All Message buffers are now also articles in the @code{nndraft}
16505 group, which is created automatically.
16506
16507 @item
16508 @code{gnus-alter-header-function} can now be used to alter header
16509 values.
16510
16511 @item
16512  @code{gnus-summary-goto-article} now accept Message-ID's.
16513
16514 @item
16515  A new Message command for deleting text in the body of a message
16516 outside the region: @kbd{C-c C-v}.
16517
16518 @item
16519  You can now post to component group in @code{nnvirtual} groups with
16520 @kbd{C-u C-c C-c}.
16521
16522 @item
16523  @code{nntp-rlogin-program}---new variable to ease customization.
16524
16525 @item
16526  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
16527 re-highlighting of the article buffer.
16528
16529 @item
16530  New element in @code{gnus-boring-article-headers}---@code{long-to}.
16531
16532 @item
16533  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
16534 Prefixes" in the Gnus manual for details.
16535
16536 @item
16537  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
16538 @kbd{a} to add the score rule to the "all.SCORE" file.
16539
16540 @item
16541  @code{gnus-simplify-subject-functions} variable to allow greater
16542 control over simplification.
16543
16544 @item
16545  @kbd{A T}---new command for fetching the current thread.
16546
16547 @item
16548  @kbd{/ T}---new command for including the current thread in the
16549 limit.
16550
16551 @item
16552  @kbd{M-RET} is a new Message command for breaking cited text.
16553
16554 @item
16555  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
16556
16557 @item
16558  The @code{custom-face-lookup} function has been removed.
16559 If you used this function in your initialization files, you must
16560 rewrite them to use @code{face-spec-set} instead.
16561
16562 @item
16563  Canceling now uses the current select method.  Symbolic prefix
16564 @kbd{a} forces normal posting method.
16565
16566 @item
16567  New command to translate M******** sm*rtq**t*s into proper
16568 text---@kbd{W d}.
16569
16570 @item
16571  For easier debugging of @code{nntp}, you can set
16572 @code{nntp-record-commands} to a non-@code{nil} value.
16573
16574 @item
16575  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
16576 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
16577
16578 @item
16579  A command for editing group parameters from the summary buffer
16580 has been added.
16581
16582 @item
16583  A history of where mails have been split is available.
16584
16585 @item
16586  A new article date command has been added---@code{article-date-iso8601}.
16587
16588 @item
16589  Subjects can be simplified when threading by setting
16590 @code{gnus-score-thread-simplify}.
16591
16592 @item
16593  A new function for citing in Message has been
16594 added---@code{message-cite-original-without-signature}.
16595
16596 @item
16597  @code{article-strip-all-blank-lines}---new article command.
16598
16599 @item
16600  A new Message command to kill to the end of the article has
16601 been added.
16602
16603 @item
16604  A minimum adaptive score can be specified by using the
16605 @code{gnus-adaptive-word-minimum} variable.
16606
16607 @item
16608  The "lapsed date" article header can be kept continually
16609 updated by the @code{gnus-start-date-timer} command.
16610
16611 @item
16612  Web listserv archives can be read with the @code{nnlistserv} backend.
16613
16614 @item
16615  Old dejanews archives can now be read by @code{nnweb}.
16616
16617 @end itemize
16618
16619
16620 @node Newest Features
16621 @subsection Newest Features
16622 @cindex todo
16623
16624 Also known as the @dfn{todo list}.  Sure to be implemented before the
16625 next millennium.
16626
16627 Be afraid.  Be very afraid.
16628
16629 (That a feature appears in this list doesn't necessarily mean that I've
16630 decided to actually implement it.  It just means that I think it sounds
16631 interesting.)
16632
16633 (Yes, this is the actual, up-to-the-second todo list.)
16634
16635 @itemize @bullet
16636
16637 @item
16638 Native @sc{mime} support is something that should be done.
16639
16640 @item
16641 Really do unbinhexing.
16642
16643 @item
16644  I would like the zombie-page to contain an URL to the source of the
16645 latest version of gnus or some explanation on where to find it.
16646
16647 @item
16648  A way to continue editing the latest Message composition.
16649
16650 @item
16651  http://www.sonicnet.com/feature/ari3/
16652
16653 @item
16654  facep is not declared.
16655
16656 @item
16657  Include a section in the manual on why the number of articles
16658 isn't the same in the group buffer and on the SPC prompt.
16659
16660 @item
16661  Interacting with rmail fcc isn't easy.
16662
16663 @item
16664 @example
16665  Hypermail:
16666 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
16667 <URL:http://www.eit.com/software/hypermail/hypermail.html>
16668 <URL:http://homer.ncm.com/>
16669 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
16670 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
16671 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
16672 http://www.miranova.com/gnus-list/
16673
16674 @end example
16675
16676 @item
16677 @samp{^-- } is made into - in LaTeX.
16678
16679 @item
16680  gnus-kill is much slower than it was in GNUS 4.1.3.
16681
16682 @item
16683  when expunging articles on low score, the sparse nodes keep hanging on?
16684 @item
16685  starting the first time seems to hang Gnus on some systems.  Does
16686 NEWGROUPS answer too fast?
16687 @item
16688  nndir doesn't read gzipped files.
16689 @item
16690  FAQ doesn't have an up node?
16691 @item
16692  when moving mail from a procmail spool to the crash-box,
16693 the crash-box is only appropriate to one specific group.
16694 @item
16695  `t' `t' makes X-Faces disappear.
16696 @item
16697  nnmh-be-safe means that crossposted articles will
16698 be marked as unread.
16699 @item
16700  Orphan score entries don't show on "V t" score trace
16701 @item
16702  when clearing out data, the cache data should also be reset.
16703 @item
16704  rewrite gnus-summary-limit-children to be non-recursive
16705 to avoid exceeding lisp nesting on huge groups.
16706 @item
16707  expunged articles are counted when computing scores.
16708 @item
16709  implement gnus-batch-brew-soup
16710 @item
16711  ticked articles aren't easy to read in pick mode -- `n' and
16712 stuff just skips past them.  Read articles are the same.
16713 @item
16714  topics that contain just groups with ticked
16715 articles aren't displayed.
16716 @item
16717  nndoc should always allocate unique Message-IDs.
16718 @item
16719  If there are mail groups the first time you use Gnus, Gnus'll
16720 make the mail groups killed.
16721 @item
16722  no "no news is good news" when using topics.
16723 @item
16724  when doing crosspost marking, the cache has to be consulted
16725 and articles have to be removed.
16726 @item
16727  nnweb should fetch complete articles when they are split into several
16728 parts.
16729 @item
16730  scoring on head immediate doesn't work.
16731 @item
16732  finding short score file names takes forever.
16733 @item
16734  canceling articles in foreign groups.
16735 @item
16736  nntp-open-rlogin no longer works.
16737 @item
16738  C-u C-x C-s (Summary) switches to the group buffer.
16739 @item
16740  move nnmail-split-history out to the backends.
16741 @item
16742  nnweb doesn't work properly.
16743 @item
16744  using a virtual server name as `gnus-select-method' doesn't work?
16745 @item
16746  when killing/yanking a group from one topic to another in a slave, the
16747 master will yank it first to one topic and then add it to another.
16748 Perhaps.
16749
16750 @item
16751  warn user about `=' redirection of a group in the active file?
16752 @item
16753  really unbinhex binhex files.
16754 @item
16755  take over the XEmacs menubar and offer a toggle between the XEmacs
16756 bar and the Gnus bar.
16757 @item
16758 @example
16759  push active file and NOV file parsing down into C code.
16760 `(canonize-message-id id)'
16761 `(mail-parent-message-id references n)'
16762 `(parse-news-nov-line &optional dependency-hashtb)'
16763 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
16764 `(parse-news-active-region beg end hashtb)'
16765
16766 @end example
16767
16768 @item
16769  nnml .overview directory with splits.
16770 @item
16771  asynchronous cache
16772 @item
16773  postponed commands.
16774 @item
16775  the selected article show have its Subject displayed in its summary line.
16776 @item
16777  when entering groups, get the real number of unread articles from
16778 the server?
16779 @item
16780  sort after gathering threads -- make false roots have the
16781 headers of the oldest orphan with a 0 article number?
16782 @item
16783  nndoc groups should inherit the score files of their parents?  Also
16784 inherit copy prompts and save files.
16785 @item
16786  command to start up Gnus (if not running) and enter a mail mode buffer.
16787 @item
16788  allow editing the group description from the group buffer
16789 for backends that support that.
16790 @item
16791 gnus-hide,show-all-topics
16792 @item
16793  groups and sub-topics should be allowed to mingle inside each topic,
16794 and not just list all subtopics at the end.
16795 @item
16796  a command to remove all read articles that are not needed to connect
16797 threads -- `gnus-summary-limit-to-sparse-unread'?
16798 @item
16799  a variable to turn off limiting/cutting of threads in the tree buffer.
16800 @item
16801  a variable to limit how many files are uudecoded.
16802 @item
16803  add zombie groups to a special "New Groups" topic.
16804 @item
16805  server mode command: close/open all connections
16806 @item
16807  put a file date in gnus-score-alist and check whether the file
16808 has been changed before using it.
16809 @item
16810  on exit from a digest group, go to the next article in the parent group.
16811 @item
16812  hide (sub)threads with low score.
16813 @item
16814  when expiring, remove all marks from expired articles.
16815 @item
16816  gnus-summary-limit-to-body
16817 @item
16818  a regexp alist that says what level groups are to be subscribed
16819 on.  Eg. -- `(("nnml:" . 1))'.
16820 @item
16821  easier interface to nnkiboze to create ephemeral groups that
16822 contain groups that match a regexp.
16823 @item
16824  allow newlines in <URL:> urls, but remove them before using
16825 the URL.
16826 @item
16827  If there is no From line, the mail backends should fudge one from the
16828 "From " line.
16829 @item
16830  fuzzy simplifying should strip all non-alpha-numerical info
16831 from subject lines.
16832 @item
16833  gnus-soup-brew-soup-with-high-scores.
16834 @item
16835  nntp-ping-before-connect
16836 @item
16837  command to check whether NOV is evil.  "list overview.fmt".
16838 @item
16839  when entering a group, Gnus should look through the score
16840 files very early for `local' atoms and set those local variables.
16841 @item
16842  message annotations.
16843 @item
16844  topics are always yanked before groups, and that's not good.
16845 @item
16846  (set-extent-property extent 'help-echo "String to display in minibuf")
16847 to display help in the minibuffer on buttons under XEmacs.
16848 @item
16849  allow group line format spec to say how many articles there
16850 are in the cache.
16851 @item
16852  AUTHINFO GENERIC
16853 @item
16854  support qmail maildir spools
16855 @item
16856  `run-with-idle-timer' in gnus-demon.
16857 @item
16858  stop using invisible text properties and start using overlays instead
16859 @item
16860  C-c C-f C-e to add an Expires header.
16861 @item
16862  go from one group to the next; everything is expunged; go to the
16863 next group instead of going to the group buffer.
16864 @item
16865  gnus-renumber-cache -- to renumber the cache using "low" numbers.
16866 @item
16867  record topic changes in the dribble buffer.
16868 @item
16869  `nnfolder-generate-active-file' should look at the folders it
16870 finds and generate proper active ranges.
16871 @item
16872  nneething-look-in-files-for-article-heads variable to control
16873 whether nneething should sniff all files in the directories.
16874 @item
16875  gnus-fetch-article -- start Gnus, enter group, display article
16876 @item
16877  gnus-dont-move-articles-to-same-group variable when respooling.
16878 @item
16879  when messages are crossposted between several auto-expirable groups,
16880 articles aren't properly marked as expirable.
16881 @item
16882  nneething should allow deletion/moving.
16883 @item
16884  TAB on the last button should go to the first button.
16885 @item
16886  if the car of an element in `mail-split-methods' is a function,
16887 and the function returns non-nil, use that as the name of the group(s) to
16888 save mail in.
16889 @item
16890  command for listing all score files that have been applied.
16891 @item
16892  a command in the article buffer to return to `summary' config.
16893 @item
16894  `gnus-always-post-using-current-server' -- variable to override
16895 `C-c C-c' when posting.
16896 @item
16897  nnmail-group-spool-alist -- says where each group should use
16898 as a spool file.
16899 @item
16900  when an article is crossposted to an auto-expirable group, the article
16901 should be marker as expirable.
16902 @item
16903  article mode command/menu for "send region as URL to browser".
16904 @item
16905  on errors, jump to info nodes that explain the error.  For instance,
16906 on invalid From headers, or on error messages from the nntp server.
16907 @item
16908  when gathering threads, make the article that has no "Re: " the parent.
16909 Also consult Date headers.
16910 @item
16911  a token in splits to call shrink-window-if-larger-than-buffer
16912 @item
16913  `1 0 A M' to do matches on the active hashtb.
16914 @item
16915  duplicates -- command to remove Gnus-Warning header, use the read
16916 Message-ID, delete the "original".
16917 @item
16918  when replying to several messages at once, put the "other" message-ids
16919 into a See-Also header.
16920 @item
16921  support setext: URL:http://www.bsdi.com/setext/
16922 @item
16923  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
16924 @item
16925  when browsing a foreign server, the groups that are already subscribed
16926 should be listed as such and not as "K".
16927 @item
16928  generate font names dynamically.
16929 @item
16930  score file mode auto-alist.
16931 @item
16932  allow nndoc to change/add/delete things from documents.  Implement
16933 methods for each format for adding an article to the document.
16934 @item
16935  `gnus-fetch-old-headers' `all' value to incorporate
16936 absolutely all headers there is.
16937 @item
16938  function like `|', but concatenate all marked articles
16939 and pipe them to the process.
16940 @item
16941  cache the list of killed (or active) groups in a separate file.  Update
16942 the file whenever we read the active file or the list
16943 of killed groups in the .eld file reaches a certain length.
16944 @item
16945  function for starting to edit a file to put into
16946 the current mail group.
16947 @item
16948  score-find-trace should display the total score of the article.
16949 @item
16950  "ghettozie" -- score on Xref header and nix it out after using it
16951 to avoid marking as read in other groups it has been crossposted to.
16952 @item
16953  look at procmail splitting.  The backends should create
16954 the groups automatically if a spool file exists for that group.
16955 @item
16956  function for backends to register themselves with Gnus.
16957 @item
16958  when replying to several process-marked articles,
16959 have all the From end up in Cc headers?  Variable to toggle.
16960 @item
16961  command to delete a crossposted mail article from all
16962 groups it has been mailed to.
16963 @item
16964  `B c' and `B m' should be crosspost aware.
16965 @item
16966  hide-pgp should also hide PGP public key blocks.
16967 @item
16968  Command in the group buffer to respool process-marked groups.
16969 @item
16970  `gnus-summary-find-matching' should accept
16971 pseudo-"headers" like "body", "head" and "all"
16972 @item
16973  When buttifying <URL: > things, all white space (including
16974 newlines) should be ignored.
16975 @item
16976  Process-marking all groups in a topic should process-mark
16977 groups in subtopics as well.
16978 @item
16979  Add non-native groups to the list of killed groups when killing them.
16980 @item
16981  nntp-suggest-kewl-config to probe the nntp server and suggest
16982 variable settings.
16983 @item
16984  add edit and forward secondary marks.
16985 @item
16986  nnml shouldn't visit its .overview files.
16987 @item
16988  allow customizing sorting within gathered threads.
16989 @item
16990  `B q' shouldn't select the current article.
16991 @item
16992  nnmbox should support a newsgroups file for descriptions.
16993 @item
16994  allow fetching mail from several pop servers.
16995 @item
16996  Be able to specify whether the saving commands save the original
16997 or the formatted article.
16998 @item
16999  a command to reparent with the child process-marked (cf. `T ^'.).
17000 @item
17001  I think the possibility to send a password with nntp-open-rlogin
17002 should be a feature in Red Gnus.
17003 @item
17004  The `Z n' command should be possible to execute from a mouse click.
17005 @item
17006  more limiting functions -- date, etc.
17007 @item
17008  be able to limit on a random header; on body; using reverse matches.
17009 @item
17010  a group parameter (`absofucking-total-expiry') that will make Gnus expire
17011 even unread articles.
17012 @item
17013  a command to print the article buffer as postscript.
17014 @item
17015  variable to disable password fetching when opening by nntp-open-telnet.
17016 @item
17017  manual: more example servers -- nntp with rlogin, telnet
17018 @item
17019  checking for bogus groups should clean topic alists as well.
17020 @item
17021  canceling articles in foreign groups.
17022 @item
17023  article number in folded topics isn't properly updated by
17024 Xref handling.
17025 @item
17026  Movement in the group buffer to the next unread group should go to the
17027 next closed topic with unread messages if no group can be found.
17028 @item
17029  Extensive info pages generated on the fly with help everywhere --
17030 in the "*Gnus edit*" buffers, for instance.
17031 @item
17032  Topic movement commands -- like thread movement.  Up, down, forward, next.
17033 @item
17034  a way to tick/mark as read Gcc'd articles.
17035 @item
17036  a way to say that all groups within a specific topic comes
17037 from a particular server?  Hm.
17038 @item
17039  `gnus-article-fill-if-long-lines' -- a function to fill
17040 the article buffer if there are any looong lines there.
17041 @item
17042  `T h' should jump to the parent topic and fold it.
17043 @item
17044  a command to create an ephemeral nndoc group out of a file,
17045 and then splitting it/moving it to some other group/backend.
17046 @item
17047  a group parameter for nnkiboze groups that says that
17048 all kibozed articles should be entered into the cache.
17049 @item
17050  It should also probably be possible to delimit what
17051 `gnus-jog-cache' does -- for instance, work on just some groups, or on
17052 some levels, and entering just articles that have a score higher than
17053 a certain number.
17054 @item
17055  nnfolder should append to the folder instead of re-writing
17056 the entire folder to disk when accepting new messages.
17057 @item
17058  allow all backends to do the proper thing with .gz files.
17059 @item
17060  a backend for reading collections of babyl files nnbabylfolder?
17061 @item
17062  a command for making the native groups into foreign groups.
17063 @item
17064  server mode command for clearing read marks from all groups
17065 from a server.
17066 @item
17067  when following up multiple articles, include all To, Cc, etc headers
17068 from all articles.
17069 @item
17070  a command for deciding what the total score of the current
17071 thread is.  Also a way to highlight based on this.
17072 @item
17073  command to show and edit group scores
17074 @item
17075  a gnus-tree-minimize-horizontal to minimize tree buffers
17076 horizontally.
17077 @item
17078  command to generate nnml overview file for one group.
17079 @item
17080  `C-u C-u a' -- prompt for many crossposted groups.
17081 @item
17082  keep track of which mail groups have received new articles (in this session).
17083 Be able to generate a report and perhaps do some marking in the group
17084 buffer.
17085 @item
17086  gnus-build-sparse-threads to a number -- build only sparse threads
17087 that are of that length.
17088 @item
17089  have nnmh respect mh's unseen sequence in .mh_profile.
17090 @item
17091  cache the newsgroups descriptions locally.
17092 @item
17093  asynchronous posting under nntp.
17094 @item
17095  be able to control word adaptive scoring from the score files.
17096 @item
17097  a variable to make `C-c C-c' post using the "current" select method.
17098 @item
17099  `limit-exclude-low-scored-articles'.
17100 @item
17101  if `gnus-summary-show-thread' is a number, hide threads that have
17102 a score lower than this number.
17103 @item
17104  split newsgroup subscription variable up into "order" and "method".
17105 @item
17106  buttonize ange-ftp file names.
17107 @item
17108  a command to make a duplicate copy of the current article
17109 so that each copy can be edited separately.
17110 @item
17111  nnweb should allow fetching from the local nntp server.
17112 @item
17113  record the sorting done in the summary buffer so that
17114 it can be repeated when limiting/regenerating the buffer.
17115 @item
17116  nnml-generate-nov-databses should generate for
17117 all nnml servers.
17118 @item
17119  when the user does commands in the group buffer, check
17120 the modification time of the .newsrc.eld file and use
17121 ask-user-about-supersession-threat.  Also warn when trying
17122 to save .newsrc.eld and it has changed.
17123 @item
17124  M-g on a topic will display all groups with 0 articles in
17125 the topic.
17126 @item
17127  command to remove all topic stuff.
17128 @item
17129  allow exploding incoming digests when reading incoming mail
17130 and splitting the resulting digests.
17131 @item
17132  nnsoup shouldn't set the `message-' variables.
17133 @item
17134  command to nix out all nnoo state information.
17135 @item
17136  nnmail-process-alist that calls functions if group names
17137 matches an alist -- before saving.
17138 @item
17139  use buffer-invisibility-spec everywhere for hiding text.
17140 @item
17141  variable to activate each group before entering them
17142 to get the (new) number of articles.  `gnus-activate-before-entering'.
17143 @item
17144  command to fetch a Message-ID from any buffer, even
17145 starting Gnus first if necessary.
17146 @item
17147  when posting and checking whether a group exists or not, just
17148 ask the nntp server instead of relying on the active hashtb.
17149 @item
17150  buttonize the output of `C-c C-a' in an apropos-like way.
17151 @item
17152  `G p' should understand process/prefix, and allow editing
17153 of several groups at once.
17154 @item
17155  command to create an ephemeral nnvirtual group that
17156 matches some regexp(s).
17157 @item
17158  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
17159 @item
17160  it should be possible to score "thread" on the From header.
17161 @item
17162  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
17163 @item
17164  `B i' should display the article at once in the summary buffer.
17165 @item
17166  remove the "*" mark at once when unticking an article.
17167 @item
17168  `M-s' should highlight the matching text.
17169 @item
17170  when checking for duplicated mails, use Resent-Message-ID if present.
17171 @item
17172  killing and yanking groups in topics should be better.  If killing one copy
17173 of a group that exists in multiple topics, only that copy should
17174 be removed.  Yanking should insert the copy, and yanking topics
17175 should be possible to be interspersed with the other yankings.
17176 @item
17177  command for enter a group just to read the cached articles.  A way to say
17178 "ignore the nntp connection; just read from the cache."
17179 @item
17180  `X u' should decode base64 articles.
17181 @item
17182  a way to hide all "inner" cited text, leaving just the most
17183 recently cited text.
17184 @item
17185  nnvirtual should be asynchronous.
17186 @item
17187  after editing an article, gnus-original-article-buffer should
17188 be invalidated.
17189 @item
17190  there should probably be a way to make Gnus not connect to the
17191 server and just read the articles in the server
17192 @item
17193  allow a `set-default' (or something) to change the default
17194 value of nnoo variables.
17195 @item
17196  a command to import group infos from a .newsrc.eld file.
17197 @item
17198  groups from secondary servers have the entire select method
17199 listed in each group info.
17200 @item
17201  a command for just switching from the summary buffer to the group
17202 buffer.
17203 @item
17204  a way to specify that some incoming mail washing functions
17205 should only be applied to some groups.
17206 @item
17207  Message `C-f C-t' should ask the user whether to heed
17208 mail-copies-to: never.
17209 @item
17210  new group parameter -- `post-to-server' that says to post
17211 using the current server.  Also a variable to do the same.
17212 @item
17213  the slave dribble files should autosave to the slave file names.
17214 @item
17215  a group parameter that says what articles to display on group entry, based
17216 on article marks.
17217 @item
17218  a way to visually distinguish slave Gnusae from masters.  (Whip instead
17219 of normal logo?)
17220 @item
17221  Use DJ Bernstein "From " quoting/dequoting, where applicable.
17222 @item
17223  Why is hide-citation-maybe and hide-citation different?  Also
17224 clear up info.
17225 @item
17226  group user-defined meta-parameters.
17227
17228
17229
17230 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
17231 @item
17232  I like the option for trying to retrieve the FAQ for a group and I was
17233 thinking it would be great if for those newsgroups that had archives
17234 you could also try to read the archive for that group.  Part of the
17235 problem is that archives are spread all over the net, unlike FAQs.
17236 What would be best I suppose is to find the one closest to your site.
17237
17238 In any case, there is a list of general news group archives at @*
17239 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
17240
17241
17242
17243
17244 @item
17245 @example
17246 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
17247 (add-hook 'gnus-select-group-hook
17248   (lambda ()
17249     (gnus-group-add-parameter group
17250        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
17251
17252 (defun gnus-user-format-function-d (headers)
17253   "Return the date the group was last read."
17254   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
17255       (t "")))
17256 @end example
17257
17258 @item
17259  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
17260 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
17261 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
17262 hatt forskjellige serveres startup-filer forskjellige steder.
17263
17264
17265 @item
17266 LMI> Well, nnbabyl could alter the group info to heed labels like
17267 LMI> answered and read, I guess.
17268
17269 It could also keep them updated (the same for the Status: header of
17270 unix mbox files).
17271
17272 They could be used like this:
17273
17274
17275 @example
17276 `M l <name> RET' add label <name> to current message.
17277 `M u <name> RET' remove label <name> from current message.
17278 `/ l <expr> RET' limit summary buffer according to <expr>.
17279
17280 <expr> would be a boolean expression on the labels, e.g.
17281
17282 `/ l bug & !fixed RET'
17283 @end example
17284
17285 would show all the messages which are labeled `bug' but not labeled
17286 `fixed'.
17287
17288 One could also imagine the labels being used for highlighting, or
17289 affect the summary line format.
17290
17291
17292 @item
17293 Sender: abraham@@dina.kvl.dk
17294
17295 I'd like a gnus-find-file which work like find file, except that it
17296 would recognize things that looks like messages or folders:
17297
17298 - If it is a directory containing numbered files, create an nndir
17299 summary buffer.
17300
17301 - For other directories, create a nneething summary buffer.
17302
17303 - For files matching "\\`From ", create a nndoc/mbox summary.
17304
17305 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
17306
17307 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
17308
17309 - For other files, just find them normally.
17310
17311 I'd like `nneething' to use this function, so it would work on a
17312 directory potentially containing mboxes or babyl files.
17313
17314 @item
17315 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
17316 tell him what you are doing.
17317
17318 @item
17319 Currently, I get prompted:
17320
17321 decend into sci?
17322 - type y
17323 decend into sci.something ?
17324 - type n
17325 decend into ucd?
17326
17327 The problem above is that since there is really only one subsection of
17328 science, shouldn't it prompt you for only descending sci.something?  If
17329 there was a sci.somethingelse group or section, then it should prompt
17330 for sci? first the sci.something? then sci.somethingelse?...
17331
17332 @item
17333 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
17334 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
17335 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
17336 "no.all.SCORE", osv.
17337
17338 @item
17339 What i want is for Gnus to treat any sequence or combination of the following
17340 as a single spoiler warning and hide it all, replacing it with a "Next Page"
17341 button:
17342
17343
17344 ^L's
17345
17346 more than n blank lines
17347
17348 more than m identical lines
17349 (which should be replaced with button to show them)
17350
17351 any whitespace surrounding any of the above
17352
17353
17354 @item
17355 Well, we could allow a new value to `gnus-thread-ignore-subject' --
17356 `spaces', or something.  (We could even default to that.)  And then
17357 subjects that differ in white space only could be considered the
17358 "same" subject for threading purposes.
17359
17360 @item
17361 Modes to preprocess the contents (e.g. jka-compr) use the second form
17362 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
17363 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
17364 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
17365
17366 @item
17367  Under XEmacs -- do funny article marks:
17368 tick - thumb tack
17369 killed - skull
17370 soup - bowl of soup
17371 score below - dim light bulb
17372 score over - bright light bulb
17373
17374 @item
17375 Yes. I think the algorithm is as follows:
17376
17377 @example
17378 Group-mode
17379
17380    show-list-of-articles-in-group
17381         if (key-pressed == SPACE)
17382                 if (no-more-articles-in-group-to-select)
17383                         if (articles-selected)
17384                                 start-reading-selected-articles;
17385                         junk-unread-articles;
17386                         next-group;
17387                  else
17388                         show-next-page;
17389
17390          else if (key-pressed = '.')
17391                 if (consolidated-menus)         # same as hide-thread in Gnus
17392                         select-thread-under-cursor;
17393                 else
17394                         select-article-under-cursor;
17395
17396
17397 Article-mode
17398         if (key-pressed == SPACE)
17399                 if (more-pages-in-article)
17400                         next-page;
17401                 else if (more-selected-articles-to-read)
17402                         next-article;
17403                 else
17404                         next-group;
17405 @end example
17406
17407 @item
17408 My precise need here would have been to limit files to Incoming*.
17409 One could think of some `nneething-only-files' variable, but I guess
17410 it would have been unacceptable if one was using many unrelated such
17411 nneething groups.
17412
17413 A more useful approach would be to, in response to the `G D' prompt, be
17414 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
17415 the top-level directory only (in case directories would be matched by
17416 the wildcard expression).
17417
17418 @item
17419 It would be nice if it also handled
17420
17421         <URL:news://sunsite.auc.dk/>
17422
17423 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
17424
17425
17426 @item
17427
17428   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
17429 really well.  Each menu is 'named' by a symbol that would be on a
17430 gnus-*-menus (where * would be whatever, but at least group, summary, and
17431 article versions) variable.
17432
17433   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
17434
17435   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
17436 the main menubar.  This approach works really well for Emacs-W3 and VM.
17437
17438
17439 @item
17440  nndoc should take care to create unique Message-IDs for all its
17441 articles.
17442 @item
17443  gnus-score-followup-article only works when you have a summary buffer
17444 active.  Make it work when posting from the group buffer as well.
17445 (message-sent-hook).
17446 @item
17447  rewrite gnus-demon to use run-with-idle-timers.
17448
17449 @item
17450  * Enhancements to Gnus:
17451
17452   Add two commands:
17453
17454   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
17455     straight to the server buffer, without opening any connections to
17456     servers first.
17457
17458   * gnus-server-read-server-newsrc--produces a buffer very similar to
17459     the group buffer, but with only groups from that server listed;
17460     quitting this buffer returns to the server buffer.
17461
17462 @item
17463  add a command to check the integrity of an nnfolder folder --
17464 go through the article numbers and see that there are no duplicates,
17465 and stuff.
17466
17467 @item
17468  `unsmileyfy-buffer' to undo smileification.
17469
17470 @item
17471  a command to give all relevant info on an article, including all
17472 secondary marks.
17473
17474 @item
17475  when doing `-request-accept-article', the backends should do
17476 the nnmail duplicate checking.
17477
17478 @item
17479  allow `message-signature-file' to be a function to return the
17480 value of the signature file.
17481
17482 @item
17483  In addition, I would love it if I could configure message-tab so that it
17484 could call `bbdb-complete-name' in other headers.  So, some sort of
17485 interface like
17486
17487 (setq message-tab-alist
17488       '((message-header-regexp message-expand-group)
17489         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
17490
17491 then you could run the relevant function to complete the information in
17492 the header
17493
17494 @item
17495  cache the newsgroups file locally to avoid reloading it all the time.
17496
17497 @item
17498  a command to import a buffer into a group.
17499
17500 @item
17501  nnweb should allow fetching by Message-ID from servers.
17502
17503 @item
17504  point in the article buffer doesn't always go to the
17505 beginning of the buffer when selecting new articles.
17506
17507 @item
17508  a command to process mark all unread articles.
17509
17510 @item
17511  `gnus-gather-threads-by-references-and-subject' -- first
17512 do gathering by references, and then go through the dummy roots and
17513 do more gathering by subject.
17514
17515 @item
17516  gnus-uu-mark-in-numerical-order -- process mark articles in
17517 article numerical order.
17518
17519 @item
17520  (gnus-thread-total-score
17521  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
17522 bind to a key.
17523
17524 @item
17525  sorting by score is wrong when using sparse threads.
17526
17527 @item
17528  a command to fetch an arbitrary article -- without having to be
17529 in the summary buffer.
17530
17531 @item
17532  a new nncvs backend.  Each group would show an article, using
17533 version branches as threading, checkin date as the date, etc.
17534
17535 @item
17536  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
17537 This filter allows one to construct advance queries on the Dejanews
17538 database such as specifying start and end dates, subject, author,
17539 and/or newsgroup name.
17540
17541 @item
17542  new Date header scoring type -- older, newer
17543
17544 @item
17545  use the summary toolbar in the article buffer.
17546
17547 @item
17548  a command to fetch all articles that are less than X days old.
17549
17550 @item
17551  in pick mode, `q' should save the list of selected articles in the
17552 group info.  The next time the group is selected, these articles
17553 will automatically get the process mark.
17554
17555 @item
17556  Isn't it possible to (also?) allow M-^ to automatically try the
17557 default server if it fails on the current server?  (controlled by a
17558 user variable, (nil, t, 'ask)).
17559
17560 @item
17561  make it possible to cancel articles using the select method for the
17562 current group.
17563
17564 @item
17565  `gnus-summary-select-article-on-entry' or something.  It'll default
17566 to t and will select whatever article decided by `gnus-auto-select-first'.
17567
17568 @item
17569  a new variable to control which selection commands should be unselecting.
17570 `first', `best', `next', `prev', `next-unread', `prev-unread' are
17571 candidates.
17572
17573 @item
17574  be able to select groups that have no articles in them
17575 to be able to post in them (using the current select method).
17576
17577 @item
17578  be able to post via DejaNews.
17579
17580 @item
17581  `x' should retain any sortings that have been performed.
17582
17583 @item
17584  allow the user to specify the precedence of the secondary marks.  Also
17585 allow them to be displayed separately.
17586
17587 @item
17588  gnus-summary-save-in-pipe should concatenate the results from
17589 the processes when doing a process marked pipe.
17590
17591 @item
17592  a new match type, like Followup, but which adds Thread matches on all
17593 articles that match a certain From header.
17594
17595 @item
17596  a function that can be read from kill-emacs-query-functions to offer
17597 saving living summary buffers.
17598
17599 @item
17600  a function for selecting a particular group which will contain
17601 the articles listed in a list of article numbers/id's.
17602
17603 @item
17604  a battery of character translation functions to translate common
17605 Mac, MS (etc) characters into ISO 8859-1.
17606
17607 @example
17608 (defun article-fix-m$word ()
17609   "Fix M$Word smartquotes in an article."
17610   (interactive)
17611   (save-excursion
17612     (let ((buffer-read-only nil))
17613       (goto-char (point-min))
17614       (while (search-forward "\221" nil t)
17615         (replace-match "`" t t))
17616       (goto-char (point-min))
17617       (while (search-forward "\222" nil t)
17618         (replace-match "'" t t))
17619       (goto-char (point-min))
17620       (while (search-forward "\223" nil t)
17621         (replace-match "\"" t t))
17622       (goto-char (point-min))
17623       (while (search-forward "\224" nil t)
17624         (replace-match "\"" t t)))))
17625 @end example
17626
17627 @item
17628 @example
17629  (add-hook 'gnus-exit-query-functions
17630 '(lambda ()
17631    (if (and (file-exists-p nnmail-spool-file)
17632             (> (nnheader-file-size nnmail-spool-file) 0))
17633        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
17634        (y-or-n-p "Are you sure you want to quit Gnus? "))))
17635 @end example
17636
17637 @item
17638  allow message-default-headers to be a function.
17639
17640 @item
17641  new Date score match types -- < > = (etc) that take floating point
17642 numbers and match on the age of the article.
17643
17644 @item
17645 @example
17646 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
17647 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
17648 >  > > buffer in the frame that it was called from =:-O
17649 >
17650 >  > Hm.  How do you start up Gnus?  From the toolbar or with
17651 >  > `M-x gnus-other-frame'?
17652 >
17653 >    I normally start it up from the toolbar; at
17654 > least that's the way I've caught it doing the
17655 > deed before.
17656 @end example
17657
17658 @item
17659  all commands that react to the process mark should push
17660 the current process mark set onto the stack.
17661
17662 @item
17663  gnus-article-hide-pgp
17664 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
17665 @example
17666 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
17667 @end example
17668 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
17669 er min type heuristikk og langt fra alles.
17670
17671 @item
17672  `gnus-subscribe-sorted' -- insert new groups where they would have been
17673 sorted to if `gnus-group-sort-function' were run.
17674
17675 @item
17676  gnus-(group,summary)-highlight should respect any `face' text props set
17677 on the lines.
17678
17679 @item
17680  use run-with-idle-timer for gnus-demon instead of the
17681 home-brewed stuff for better reliability.
17682
17683 @item
17684  add a way to select which NoCeM type to apply -- spam, troll, etc.
17685
17686 @item
17687  nndraft-request-group should tally autosave files.
17688
17689 @item
17690  implement nntp-retry-on-break and nntp-command-timeout.
17691
17692 @item
17693  gnus-article-highlight-limit that says when not to highlight (long)
17694 articles.
17695
17696 @item
17697  (nnoo-set SERVER VARIABLE VALUE)
17698
17699 @item
17700  nn*-spool-methods
17701
17702 @item
17703  interrupitng agent fetching of articles should save articles.
17704
17705 @item
17706  command to open a digest group, and copy all the articles there to the
17707 current group.
17708
17709 @item
17710  a variable to disable article body highlights if there's more than
17711 X characters in the body.
17712
17713 @item
17714  handle 480/381 authinfo requests separately.
17715
17716 @item
17717  include the texi/dir file in the distribution.
17718
17719 @item
17720  format spec to "tab" to a position.
17721
17722 @item
17723  Move all prompting to the new `M-n' default style.
17724
17725 @item
17726  command to display all dormant articles.
17727
17728 @item
17729  gnus-auto-select-next makeover -- list of things it should do.
17730
17731 @item
17732  a score match type that adds scores matching on From if From has replied
17733 to something someone else has said.
17734
17735 @item
17736  Read Netscape discussion groups:
17737 snews://secnews.netscape.com/netscape.communicator.unix
17738
17739 @item
17740 One command to edit the original version if an article, and one to edit
17741 the displayed version.
17742
17743 @item
17744 @kbd{T v} -- make all process-marked articles the children of the
17745 current article.
17746
17747 @item
17748 Switch from initial text to the new default text mechanism.
17749
17750 @item
17751 How about making it possible to expire local articles?  Will it be
17752 possible to make various constraints on when an article can be
17753 expired, e.g. (read), (age > 14 days), or the more interesting (read
17754 & age > 14 days)?
17755
17756 @item
17757 New limit command---limit to articles that have a certain string
17758 in the head or body.
17759
17760 @item
17761 Allow breaking lengthy NNTP commands.
17762
17763 @item
17764 gnus-article-highlight-limit, to disable highlighting in big articles.
17765
17766 @item
17767 Editing an article should put the article to be edited
17768 in a special, unique buffer.
17769
17770 @item
17771 A command to send a mail to the admin-address group param.
17772
17773 @item
17774 A Date scoring type that will match if the article
17775 is less than a certain number of days old.
17776
17777 @item
17778 New spec: %~(tab 56) to put point on column 56
17779
17780 @item
17781 Allow Gnus Agent scoring to use normal score files.
17782
17783 @item
17784 Rething the Agent active file thing.  `M-g' doesn't update the active
17785 file, for instance.
17786
17787 @item
17788 With dummy roots, `^' and then selecing the first article
17789 in any other dummy thread will make Gnus highlight the
17790 dummy root instead of the first article.
17791
17792 @item
17793 Propagate all group properties (marks, article numbers, etc) up to the
17794 topics for displaying.
17795
17796 @item
17797 `n' in the group buffer with topics should go to the next group
17798 with unread articles, even if that group is hidden in a topic.
17799
17800 @item
17801 gnus-posting-styles doesn't work in drafts.
17802
17803 @item
17804 gnus-summary-limit-include-cached is slow when there are
17805 many articles in the cache, since it regenerates big parts of the
17806 summary buffer for each article.
17807
17808 @item
17809 Implement gnus-batch-brew-soup.
17810
17811 @item
17812 Group parameters and summary commands for un/subscribing to mailing
17813 lists. 
17814
17815 @item
17816 Solve the halting problem.
17817
17818 @c TODO
17819 @end itemize
17820
17821 @iftex
17822
17823 @page
17824 @node The Manual
17825 @section The Manual
17826 @cindex colophon
17827 @cindex manual
17828
17829 This manual was generated from a TeXinfo file and then run through
17830 either @code{texi2dvi}
17831 @iflatex
17832 or my own home-brewed TeXinfo to \LaTeX\ transformer,
17833 and then run through @code{latex} and @code{dvips}
17834 @end iflatex
17835 to get what you hold in your hands now.
17836
17837 The following conventions have been used:
17838
17839 @enumerate
17840
17841 @item
17842 This is a @samp{string}
17843
17844 @item
17845 This is a @kbd{keystroke}
17846
17847 @item
17848 This is a @file{file}
17849
17850 @item
17851 This is a @code{symbol}
17852
17853 @end enumerate
17854
17855 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
17856 mean:
17857
17858 @lisp
17859 (setq flargnoze "yes")
17860 @end lisp
17861
17862 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
17863
17864 @lisp
17865 (setq flumphel 'yes)
17866 @end lisp
17867
17868 @samp{yes} and @code{yes} are two @emph{very} different things---don't
17869 ever get them confused.
17870
17871 @iflatex
17872 @c @head
17873 Of course, everything in this manual is of vital interest, so you should
17874 read it all.  Several times.  However, if you feel like skimming the
17875 manual, look for that gnu head you should see in the margin over
17876 there---it means that what's being discussed is of more importance than
17877 the rest of the stuff.  (On the other hand, if everything is infinitely
17878 important, how can anything be more important than that?  Just one more
17879 of the mysteries of this world, I guess.)
17880 @end iflatex
17881
17882 @end iftex
17883
17884
17885 @page
17886 @node Terminology
17887 @section Terminology
17888
17889 @cindex terminology
17890 @table @dfn
17891
17892 @item news
17893 @cindex news
17894 This is what you are supposed to use this thing for---reading news.
17895 News is generally fetched from a nearby @sc{nntp} server, and is
17896 generally publicly available to everybody.  If you post news, the entire
17897 world is likely to read just what you have written, and they'll all
17898 snigger mischievously.  Behind your back.
17899
17900 @item mail
17901 @cindex mail
17902 Everything that's delivered to you personally is mail.  Some news/mail
17903 readers (like Gnus) blur the distinction between mail and news, but
17904 there is a difference.  Mail is private.  News is public.  Mailing is
17905 not posting, and replying is not following up.
17906
17907 @item reply
17908 @cindex reply
17909 Send a mail to the person who has written what you are reading.
17910
17911 @item follow up
17912 @cindex follow up
17913 Post an article to the current newsgroup responding to the article you
17914 are reading.
17915
17916 @item backend
17917 @cindex backend
17918 Gnus gets fed articles from a number of backends, both news and mail
17919 backends.  Gnus does not handle the underlying media, so to speak---this
17920 is all done by the backends.
17921
17922 @item native
17923 @cindex native
17924 Gnus will always use one method (and backend) as the @dfn{native}, or
17925 default, way of getting news.
17926
17927 @item foreign
17928 @cindex foreign
17929 You can also have any number of foreign groups active at the same time.
17930 These are groups that use non-native non-secondary backends for getting
17931 news.
17932
17933 @item secondary
17934 @cindex secondary
17935 Secondary backends are somewhere half-way between being native and being
17936 foreign, but they mostly act like they are native.
17937
17938 @item article
17939 @cindex article
17940 A message that has been posted as news.
17941
17942 @item mail message
17943 @cindex mail message
17944 A message that has been mailed.
17945
17946 @item message
17947 @cindex message
17948 A mail message or news article
17949
17950 @item head
17951 @cindex head
17952 The top part of a message, where administrative information (etc.) is
17953 put.
17954
17955 @item body
17956 @cindex body
17957 The rest of an article.  Everything not in the head is in the
17958 body.
17959
17960 @item header
17961 @cindex header
17962 A line from the head of an article.
17963
17964 @item headers
17965 @cindex headers
17966 A collection of such lines, or a collection of heads.  Or even a
17967 collection of @sc{nov} lines.
17968
17969 @item @sc{nov}
17970 @cindex nov
17971 When Gnus enters a group, it asks the backend for the headers of all
17972 unread articles in the group.  Most servers support the News OverView
17973 format, which is more compact and much faster to read and parse than the
17974 normal @sc{head} format.
17975
17976 @item level
17977 @cindex levels
17978 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
17979 that have a lower level are ``more'' subscribed than the groups with a
17980 higher level.  In fact, groups on levels 1-5 are considered
17981 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
17982 are @dfn{killed}.  Commands for listing groups and scanning for new
17983 articles will all use the numeric prefix as @dfn{working level}.
17984
17985 @item killed groups
17986 @cindex killed groups
17987 No information on killed groups is stored or updated, which makes killed
17988 groups much easier to handle than subscribed groups.
17989
17990 @item zombie groups
17991 @cindex zombie groups
17992 Just like killed groups, only slightly less dead.
17993
17994 @item active file
17995 @cindex active file
17996 The news server has to keep track of what articles it carries, and what
17997 groups exist.  All this information in stored in the active file, which
17998 is rather large, as you might surmise.
17999
18000 @item bogus groups
18001 @cindex bogus groups
18002 A group that exists in the @file{.newsrc} file, but isn't known to the
18003 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
18004 This means that the group probably doesn't exist (any more).
18005
18006 @item activating
18007 @cindex activating groups
18008 The act of asking the server for info on a group and computing the
18009 number of unread articles is called @dfn{activating the group}.
18010 Un-activated groups are listed with @samp{*} in the group buffer.
18011
18012 @item server
18013 @cindex server
18014 A machine one can connect to and get news (or mail) from.
18015
18016 @item select method
18017 @cindex select method
18018 A structure that specifies the backend, the server and the virtual
18019 server settings.
18020
18021 @item virtual server
18022 @cindex virtual server
18023 A named select method.  Since a select method defines all there is to
18024 know about connecting to a (physical) server, taking the thing as a
18025 whole is a virtual server.
18026
18027 @item washing
18028 @cindex washing
18029 Taking a buffer and running it through a filter of some sort.  The
18030 result will (more often than not) be cleaner and more pleasing than the
18031 original.
18032
18033 @item ephemeral groups
18034 @cindex ephemeral groups
18035 Most groups store data on what articles you have read.  @dfn{Ephemeral}
18036 groups are groups that will have no data stored---when you exit the
18037 group, it'll disappear into the aether.
18038
18039 @item solid groups
18040 @cindex solid groups
18041 This is the opposite of ephemeral groups.  All groups listed in the
18042 group buffer are solid groups.
18043
18044 @item sparse articles
18045 @cindex sparse articles
18046 These are article placeholders shown in the summary buffer when
18047 @code{gnus-build-sparse-threads} has been switched on.
18048
18049 @item threading
18050 @cindex threading
18051 To put responses to articles directly after the articles they respond
18052 to---in a hierarchical fashion.
18053
18054 @item root
18055 @cindex root
18056 @cindex thread root
18057 The first article in a thread is the root.  It is the ancestor of all
18058 articles in the thread.
18059
18060 @item parent
18061 @cindex parent
18062 An article that has responses.
18063
18064 @item child
18065 @cindex child
18066 An article that responds to a different article---its parent.
18067
18068 @item digest
18069 @cindex digest
18070 A collection of messages in one file.  The most common digest format is
18071 specified by RFC1153.
18072
18073 @end table
18074
18075
18076 @page
18077 @node Customization
18078 @section Customization
18079 @cindex general customization
18080
18081 All variables are properly documented elsewhere in this manual.  This
18082 section is designed to give general pointers on how to customize Gnus
18083 for some quite common situations.
18084
18085 @menu
18086 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
18087 * Slow Terminal Connection::  You run a remote Emacs.
18088 * Little Disk Space::         You feel that having large setup files is icky.
18089 * Slow Machine::              You feel like buying a faster machine.
18090 @end menu
18091
18092
18093 @node Slow/Expensive Connection
18094 @subsection Slow/Expensive @sc{nntp} Connection
18095
18096 If you run Emacs on a machine locally, and get your news from a machine
18097 over some very thin strings, you want to cut down on the amount of data
18098 Gnus has to get from the @sc{nntp} server.
18099
18100 @table @code
18101
18102 @item gnus-read-active-file
18103 Set this to @code{nil}, which will inhibit Gnus from requesting the
18104 entire active file from the server.  This file is often v.  large.  You
18105 also have to set @code{gnus-check-new-newsgroups} and
18106 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
18107 doesn't suddenly decide to fetch the active file anyway.
18108
18109 @item gnus-nov-is-evil
18110 This one has to be @code{nil}.  If not, grabbing article headers from
18111 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
18112 support @sc{xover}; Gnus will detect this by itself.
18113 @end table
18114
18115
18116 @node Slow Terminal Connection
18117 @subsection Slow Terminal Connection
18118
18119 Let's say you use your home computer for dialing up the system that runs
18120 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
18121 possible) the amount of data sent over the wires.
18122
18123 @table @code
18124
18125 @item gnus-auto-center-summary
18126 Set this to @code{nil} to inhibit Gnus from re-centering the summary
18127 buffer all the time.  If it is @code{vertical}, do only vertical
18128 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
18129 horizontal and vertical recentering.
18130
18131 @item gnus-visible-headers
18132 Cut down on the headers included in the articles to the
18133 minimum.  You can, in fact, make do without them altogether---most of the
18134 useful data is in the summary buffer, anyway.  Set this variable to
18135 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
18136
18137 @item gnus-article-display-hook
18138 Set this hook to all the available hiding commands:
18139 @lisp
18140 (setq gnus-article-display-hook
18141       '(gnus-article-hide-headers
18142         gnus-article-hide-signature
18143         gnus-article-hide-citation))
18144 @end lisp
18145
18146 @item gnus-use-full-window
18147 By setting this to @code{nil}, you can make all the windows smaller.
18148 While this doesn't really cut down much generally, it means that you
18149 have to see smaller portions of articles before deciding that you didn't
18150 want to read them anyway.
18151
18152 @item gnus-thread-hide-subtree
18153 If this is non-@code{nil}, all threads in the summary buffer will be
18154 hidden initially.
18155
18156 @item gnus-updated-mode-lines
18157 If this is @code{nil}, Gnus will not put information in the buffer mode
18158 lines, which might save some time.
18159 @end table
18160
18161
18162 @node Little Disk Space
18163 @subsection Little Disk Space
18164 @cindex disk space
18165
18166 The startup files can get rather large, so you may want to cut their
18167 sizes a bit if you are running out of space.
18168
18169 @table @code
18170
18171 @item gnus-save-newsrc-file
18172 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
18173 only save @file{.newsrc.eld}.  This means that you will not be able to
18174 use any other newsreaders than Gnus.  This variable is @code{t} by
18175 default.
18176
18177 @item gnus-save-killed-list
18178 If this is @code{nil}, Gnus will not save the list of dead groups.  You
18179 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
18180 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
18181 variable to @code{nil}.  This variable is @code{t} by default.
18182
18183 @end table
18184
18185
18186 @node Slow Machine
18187 @subsection Slow Machine
18188 @cindex slow machine
18189
18190 If you have a slow machine, or are just really impatient, there are a
18191 few things you can do to make Gnus run faster.
18192
18193 Set @code{gnus-check-new-newsgroups} and
18194 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
18195
18196 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
18197 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
18198 summary buffer faster.
18199
18200 Set @code{gnus-article-display-hook} to @code{nil} to make article
18201 processing a bit faster.
18202
18203
18204 @page
18205 @node Troubleshooting
18206 @section Troubleshooting
18207 @cindex troubleshooting
18208
18209 Gnus works @emph{so} well straight out of the box---I can't imagine any
18210 problems, really.
18211
18212 Ahem.
18213
18214 @enumerate
18215
18216 @item
18217 Make sure your computer is switched on.
18218
18219 @item
18220 Make sure that you really load the current Gnus version.  If you have
18221 been running @sc{gnus}, you need to exit Emacs and start it up again before
18222 Gnus will work.
18223
18224 @item
18225 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
18226 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
18227 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
18228 flee}, you have some old @file{.el} files lying around.  Delete these.
18229
18230 @item
18231 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
18232 how-to.
18233
18234 @item
18235 @vindex max-lisp-eval-depth
18236 Gnus works on many recursive structures, and in some extreme (and very
18237 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
18238 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
18239 something like that.
18240 @end enumerate
18241
18242 If all else fails, report the problem as a bug.
18243
18244 @cindex bugs
18245 @cindex reporting bugs
18246
18247 @kindex M-x gnus-bug
18248 @findex gnus-bug
18249 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
18250 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
18251 me the backtrace.  I will fix bugs, but I can only fix them if you send
18252 me a precise description as to how to reproduce the bug.
18253
18254 You really can never be too detailed in a bug report.  Always use the
18255 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
18256 a 10Kb mail each time you use it, and even if you have sent me your
18257 environment 500 times before.  I don't care.  I want the full info each
18258 time.
18259
18260 It is also important to remember that I have no memory whatsoever.  If
18261 you send a bug report, and I send you a reply, and then you just send
18262 back ``No, it's not! Moron!'', I will have no idea what you are
18263 insulting me about.  Always over-explain everything.  It's much easier
18264 for all of us---if I don't have all the information I need, I will just
18265 mail you and ask for more info, and everything takes more time.
18266
18267 If the problem you're seeing is very visual, and you can't quite explain
18268 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
18269 it somewhere it can be reached, and include the URL of the picture in
18270 the bug report.
18271
18272 If you just need help, you are better off asking on
18273 @samp{gnu.emacs.gnus}.  I'm not very helpful.
18274
18275 @cindex gnu.emacs.gnus
18276 @cindex ding mailing list
18277 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
18278 Write to @samp{ding-request@@gnus.org} to subscribe.
18279
18280
18281 @page
18282 @node A Programmers Guide to Gnus
18283 @section A Programmer@'s Guide to Gnus
18284
18285 It is my hope that other people will figure out smart stuff that Gnus
18286 can do, and that other people will write those smart things as well.  To
18287 facilitate that I thought it would be a good idea to describe the inner
18288 workings of Gnus.  And some of the not-so-inner workings, while I'm at
18289 it.
18290
18291 You can never expect the internals of a program not to change, but I
18292 will be defining (in some details) the interface between Gnus and its
18293 backends (this is written in stone), the format of the score files
18294 (ditto), data structures (some are less likely to change than others)
18295 and general methods of operation.
18296
18297 @menu
18298 * Gnus Utility Functions::   Common functions and variable to use.
18299 * Backend Interface::        How Gnus communicates with the servers.
18300 * Score File Syntax::        A BNF definition of the score file standard.
18301 * Headers::                  How Gnus stores headers internally.
18302 * Ranges::                   A handy format for storing mucho numbers.
18303 * Group Info::               The group info format.
18304 * Extended Interactive::     Symbolic prefixes and stuff.
18305 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
18306 * Various File Formats::     Formats of files that Gnus use.
18307 @end menu
18308
18309
18310 @node Gnus Utility Functions
18311 @subsection Gnus Utility Functions
18312 @cindex Gnus utility functions
18313 @cindex utility functions
18314 @cindex functions
18315 @cindex internal variables
18316
18317 When writing small functions to be run from hooks (and stuff), it's
18318 vital to have access to the Gnus internal functions and variables.
18319 Below is a list of the most common ones.
18320
18321 @table @code
18322
18323 @item gnus-newsgroup-name
18324 @vindex gnus-newsgroup-name
18325 This variable holds the name of the current newsgroup.
18326
18327 @item gnus-find-method-for-group
18328 @findex gnus-find-method-for-group
18329 A function that returns the select method for @var{group}.
18330
18331 @item gnus-group-real-name
18332 @findex gnus-group-real-name
18333 Takes a full (prefixed) Gnus group name, and returns the unprefixed
18334 name.
18335
18336 @item gnus-group-prefixed-name
18337 @findex gnus-group-prefixed-name
18338 Takes an unprefixed group name and a select method, and returns the full
18339 (prefixed) Gnus group name.
18340
18341 @item gnus-get-info
18342 @findex gnus-get-info
18343 Returns the group info list for @var{group}.
18344
18345 @item gnus-group-unread
18346 @findex gnus-group-unread
18347 The number of unread articles in @var{group}, or @code{t} if that is
18348 unknown.
18349
18350 @item gnus-active
18351 @findex gnus-active
18352 The active entry for @var{group}.
18353
18354 @item gnus-set-active
18355 @findex gnus-set-active
18356 Set the active entry for @var{group}.
18357
18358 @item gnus-add-current-to-buffer-list
18359 @findex gnus-add-current-to-buffer-list
18360 Adds the current buffer to the list of buffers to be killed on Gnus
18361 exit.
18362
18363 @item gnus-continuum-version
18364 @findex gnus-continuum-version
18365 Takes a Gnus version string as a parameter and returns a floating point
18366 number.  Earlier versions will always get a lower number than later
18367 versions.
18368
18369 @item gnus-group-read-only-p
18370 @findex gnus-group-read-only-p
18371 Says whether @var{group} is read-only or not.
18372
18373 @item gnus-news-group-p
18374 @findex gnus-news-group-p
18375 Says whether @var{group} came from a news backend.
18376
18377 @item gnus-ephemeral-group-p
18378 @findex gnus-ephemeral-group-p
18379 Says whether @var{group} is ephemeral or not.
18380
18381 @item gnus-server-to-method
18382 @findex gnus-server-to-method
18383 Returns the select method corresponding to @var{server}.
18384
18385 @item gnus-server-equal
18386 @findex gnus-server-equal
18387 Says whether two virtual servers are equal.
18388
18389 @item gnus-group-native-p
18390 @findex gnus-group-native-p
18391 Says whether @var{group} is native or not.
18392
18393 @item gnus-group-secondary-p
18394 @findex gnus-group-secondary-p
18395 Says whether @var{group} is secondary or not.
18396
18397 @item gnus-group-foreign-p
18398 @findex gnus-group-foreign-p
18399 Says whether @var{group} is foreign or not.
18400
18401 @item group-group-find-parameter
18402 @findex group-group-find-parameter
18403 Returns the parameter list of @var{group}.  If given a second parameter,
18404 returns the value of that parameter for @var{group}.
18405
18406 @item gnus-group-set-parameter
18407 @findex gnus-group-set-parameter
18408 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
18409
18410 @item gnus-narrow-to-body
18411 @findex gnus-narrow-to-body
18412 Narrows the current buffer to the body of the article.
18413
18414 @item gnus-check-backend-function
18415 @findex gnus-check-backend-function
18416 Takes two parameters, @var{function} and @var{group}.  If the backend
18417 @var{group} comes from supports @var{function}, return non-@code{nil}.
18418
18419 @lisp
18420 (gnus-check-backend-function "request-scan" "nnml:misc")
18421 => t
18422 @end lisp
18423
18424 @item gnus-read-method
18425 @findex gnus-read-method
18426 Prompts the user for a select method.
18427
18428 @end table
18429
18430
18431 @node Backend Interface
18432 @subsection Backend Interface
18433
18434 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
18435 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
18436 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
18437 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
18438 examples of the latter we have @code{nntp-port-number} and
18439 @code{nnmbox-directory}.
18440
18441 When Gnus asks for information from a backend---say @code{nntp}---on
18442 something, it will normally include a virtual server name in the
18443 function parameters.  (If not, the backend should use the ``current''
18444 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
18445 server as its only (optional) parameter.  If this virtual server hasn't
18446 been opened, the function should fail.
18447
18448 Note that a virtual server name has no relation to some physical server
18449 name.  Take this example:
18450
18451 @lisp
18452 (nntp "odd-one"
18453       (nntp-address "ifi.uio.no")
18454       (nntp-port-number 4324))
18455 @end lisp
18456
18457 Here the virtual server name is @samp{odd-one} while the name of
18458 the physical server is @samp{ifi.uio.no}.
18459
18460 The backends should be able to switch between several virtual servers.
18461 The standard backends implement this by keeping an alist of virtual
18462 server environments that they pull down/push up when needed.
18463
18464 There are two groups of interface functions: @dfn{required functions},
18465 which must be present, and @dfn{optional functions}, which Gnus will
18466 always check for presence before attempting to call 'em.
18467
18468 All these functions are expected to return data in the buffer
18469 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
18470 unfortunately named, but we'll have to live with it.  When I talk about
18471 @dfn{resulting data}, I always refer to the data in that buffer.  When I
18472 talk about @dfn{return value}, I talk about the function value returned by
18473 the function call.  Functions that fail should return @code{nil} as the
18474 return value.
18475
18476 Some backends could be said to be @dfn{server-forming} backends, and
18477 some might be said not to be.  The latter are backends that generally
18478 only operate on one group at a time, and have no concept of ``server''
18479 -- they have a group, and they deliver info on that group and nothing
18480 more.
18481
18482 In the examples and definitions I will refer to the imaginary backend
18483 @code{nnchoke}.
18484
18485 @cindex @code{nnchoke}
18486
18487 @menu
18488 * Required Backend Functions::        Functions that must be implemented.
18489 * Optional Backend Functions::        Functions that need not be implemented.
18490 * Error Messaging::                   How to get messages and report errors.
18491 * Writing New Backends::              Extending old backends.
18492 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
18493 * Mail-like Backends::                Some tips on mail backends.
18494 @end menu
18495
18496
18497 @node Required Backend Functions
18498 @subsubsection Required Backend Functions
18499
18500 @table @code
18501
18502 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
18503
18504 @var{articles} is either a range of article numbers or a list of
18505 @code{Message-ID}s.  Current backends do not fully support either---only
18506 sequences (lists) of article numbers, and most backends do not support
18507 retrieval of @code{Message-ID}s.  But they should try for both.
18508
18509 The result data should either be HEADs or NOV lines, and the result
18510 value should either be @code{headers} or @code{nov} to reflect this.
18511 This might later be expanded to @code{various}, which will be a mixture
18512 of HEADs and NOV lines, but this is currently not supported by Gnus.
18513
18514 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
18515 headers", in some meaning of the word.  This is generally done by
18516 fetching (at most) @var{fetch-old} extra headers less than the smallest
18517 article number in @code{articles}, and filling the gaps as well.  The
18518 presence of this parameter can be ignored if the backend finds it
18519 cumbersome to follow the request.  If this is non-@code{nil} and not a
18520 number, do maximum fetches.
18521
18522 Here's an example HEAD:
18523
18524 @example
18525 221 1056 Article retrieved.
18526 Path: ifi.uio.no!sturles
18527 From: sturles@@ifi.uio.no (Sturle Sunde)
18528 Newsgroups: ifi.discussion
18529 Subject: Re: Something very droll
18530 Date: 27 Oct 1994 14:02:57 +0100
18531 Organization: Dept. of Informatics, University of Oslo, Norway
18532 Lines: 26
18533 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
18534 References: <38jdmq$4qu@@visbur.ifi.uio.no>
18535 NNTP-Posting-Host: holmenkollen.ifi.uio.no
18536 .
18537 @end example
18538
18539 So a @code{headers} return value would imply that there's a number of
18540 these in the data buffer.
18541
18542 Here's a BNF definition of such a buffer:
18543
18544 @example
18545 headers        = *head
18546 head           = error / valid-head
18547 error-message  = [ "4" / "5" ] 2number " " <error message> eol
18548 valid-head     = valid-message *header "." eol
18549 valid-message  = "221 " <number> " Article retrieved." eol
18550 header         = <text> eol
18551 @end example
18552
18553 If the return value is @code{nov}, the data buffer should contain
18554 @dfn{network overview database} lines.  These are basically fields
18555 separated by tabs.
18556
18557 @example
18558 nov-buffer = *nov-line
18559 nov-line   = 8*9 [ field <TAB> ] eol
18560 field      = <text except TAB>
18561 @end example
18562
18563 For a closer look at what should be in those fields,
18564 @pxref{Headers}.
18565
18566
18567 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
18568
18569 @var{server} is here the virtual server name.  @var{definitions} is a
18570 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
18571
18572 If the server can't be opened, no error should be signaled.  The backend
18573 may then choose to refuse further attempts at connecting to this
18574 server.  In fact, it should do so.
18575
18576 If the server is opened already, this function should return a
18577 non-@code{nil} value.  There should be no data returned.
18578
18579
18580 @item (nnchoke-close-server &optional SERVER)
18581
18582 Close connection to @var{server} and free all resources connected
18583 to it.  Return @code{nil} if the server couldn't be closed for some
18584 reason.
18585
18586 There should be no data returned.
18587
18588
18589 @item (nnchoke-request-close)
18590
18591 Close connection to all servers and free all resources that the backend
18592 have reserved.  All buffers that have been created by that backend
18593 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
18594 function is generally only called when Gnus is shutting down.
18595
18596 There should be no data returned.
18597
18598
18599 @item (nnchoke-server-opened &optional SERVER)
18600
18601 If @var{server} is the current virtual server, and the connection to the
18602 physical server is alive, then this function should return a
18603 non-@code{nil} vlue.  This function should under no circumstances
18604 attempt to reconnect to a server we have lost connection to.
18605
18606 There should be no data returned.
18607
18608
18609 @item (nnchoke-status-message &optional SERVER)
18610
18611 This function should return the last error message from @var{server}.
18612
18613 There should be no data returned.
18614
18615
18616 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
18617
18618 The result data from this function should be the article specified by
18619 @var{article}.  This might either be a @code{Message-ID} or a number.
18620 It is optional whether to implement retrieval by @code{Message-ID}, but
18621 it would be nice if that were possible.
18622
18623 If @var{to-buffer} is non-@code{nil}, the result data should be returned
18624 in this buffer instead of the normal data buffer.  This is to make it
18625 possible to avoid copying large amounts of data from one buffer to
18626 another, while Gnus mainly requests articles to be inserted directly
18627 into its article buffer.
18628
18629 If it is at all possible, this function should return a cons cell where
18630 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
18631 the article number.  This will enable Gnus to find out what the real
18632 group and article numbers are when fetching articles by
18633 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
18634 on successful article retrieval.
18635
18636
18637 @item (nnchoke-request-group GROUP &optional SERVER FAST)
18638
18639 Get data on @var{group}.  This function also has the side effect of
18640 making @var{group} the current group.
18641
18642 If @var{FAST}, don't bother to return useful data, just make @var{group}
18643 the current group.
18644
18645 Here's an example of some result data and a definition of the same:
18646
18647 @example
18648 211 56 1000 1059 ifi.discussion
18649 @end example
18650
18651 The first number is the status, which should be 211.  Next is the
18652 total number of articles in the group, the lowest article number, the
18653 highest article number, and finally the group name.  Note that the total
18654 number of articles may be less than one might think while just
18655 considering the highest and lowest article numbers, but some articles
18656 may have been canceled.  Gnus just discards the total-number, so
18657 whether one should take the bother to generate it properly (if that is a
18658 problem) is left as an exercise to the reader.
18659
18660 @example
18661 group-status = [ error / info ] eol
18662 error        = [ "4" / "5" ] 2<number> " " <Error message>
18663 info         = "211 " 3* [ <number> " " ] <string>
18664 @end example
18665
18666
18667 @item (nnchoke-close-group GROUP &optional SERVER)
18668
18669 Close @var{group} and free any resources connected to it.  This will be
18670 a no-op on most backends.
18671
18672 There should be no data returned.
18673
18674
18675 @item (nnchoke-request-list &optional SERVER)
18676
18677 Return a list of all groups available on @var{server}.  And that means
18678 @emph{all}.
18679
18680 Here's an example from a server that only carries two groups:
18681
18682 @example
18683 ifi.test 0000002200 0000002000 y
18684 ifi.discussion 3324 3300 n
18685 @end example
18686
18687 On each line we have a group name, then the highest article number in
18688 that group, the lowest article number, and finally a flag.
18689
18690 @example
18691 active-file = *active-line
18692 active-line = name " " <number> " " <number> " " flags eol
18693 name        = <string>
18694 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
18695 @end example
18696
18697 The flag says whether the group is read-only (@samp{n}), is moderated
18698 (@samp{m}), is dead (@samp{x}), is aliased to some other group
18699 (@samp{=other-group}) or none of the above (@samp{y}).
18700
18701
18702 @item (nnchoke-request-post &optional SERVER)
18703
18704 This function should post the current buffer.  It might return whether
18705 the posting was successful or not, but that's not required.  If, for
18706 instance, the posting is done asynchronously, it has generally not been
18707 completed by the time this function concludes.  In that case, this
18708 function should set up some kind of sentinel to beep the user loud and
18709 clear if the posting could not be completed.
18710
18711 There should be no result data from this function.
18712
18713 @end table
18714
18715
18716 @node Optional Backend Functions
18717 @subsubsection Optional Backend Functions
18718
18719 @table @code
18720
18721 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
18722
18723 @var{groups} is a list of groups, and this function should request data
18724 on all those groups.  How it does it is of no concern to Gnus, but it
18725 should attempt to do this in a speedy fashion.
18726
18727 The return value of this function can be either @code{active} or
18728 @code{group}, which says what the format of the result data is.  The
18729 former is in the same format as the data from
18730 @code{nnchoke-request-list}, while the latter is a buffer full of lines
18731 in the same format as @code{nnchoke-request-group} gives.
18732
18733 @example
18734 group-buffer = *active-line / *group-status
18735 @end example
18736
18737
18738 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
18739
18740 A Gnus group info (@pxref{Group Info}) is handed to the backend for
18741 alterations.  This comes in handy if the backend really carries all the
18742 information (as is the case with virtual and imap groups).  This
18743 function should destructively alter the info to suit its needs, and
18744 should return the (altered) group info.
18745
18746 There should be no result data from this function.
18747
18748
18749 @item (nnchoke-request-type GROUP &optional ARTICLE)
18750
18751 When the user issues commands for ``sending news'' (@kbd{F} in the
18752 summary buffer, for instance), Gnus has to know whether the article the
18753 user is following up on is news or mail.  This function should return
18754 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
18755 is mail and @code{unknown} if the type can't be decided.  (The
18756 @var{article} parameter is necessary in @code{nnvirtual} groups which
18757 might very well combine mail groups and news groups.)  Both @var{group}
18758 and @var{article} may be @code{nil}.
18759
18760 There should be no result data from this function.
18761
18762
18763 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
18764
18765 If the user tries to set a mark that the backend doesn't like, this
18766 function may change the mark.  Gnus will use whatever this function
18767 returns as the mark for @var{article} instead of the original
18768 @var{mark}.  If the backend doesn't care, it must return the original
18769 @var{mark}, and not @code{nil} or any other type of garbage.
18770
18771 The only use for this I can see is what @code{nnvirtual} does with
18772 it---if a component group is auto-expirable, marking an article as read
18773 in the virtual group should result in the article being marked as
18774 expirable.
18775
18776 There should be no result data from this function.
18777
18778
18779 @item (nnchoke-request-scan &optional GROUP SERVER)
18780
18781 This function may be called at any time (by Gnus or anything else) to
18782 request that the backend check for incoming articles, in one way or
18783 another.  A mail backend will typically read the spool file or query the
18784 POP server when this function is invoked.  The @var{group} doesn't have
18785 to be heeded---if the backend decides that it is too much work just
18786 scanning for a single group, it may do a total scan of all groups.  It
18787 would be nice, however, to keep things local if that's practical.
18788
18789 There should be no result data from this function.
18790
18791
18792 @item (nnchoke-request-group-description GROUP &optional SERVER)
18793
18794 The result data from this function should be a description of
18795 @var{group}.
18796
18797 @example
18798 description-line = name <TAB> description eol
18799 name             = <string>
18800 description      = <text>
18801 @end example
18802
18803 @item (nnchoke-request-list-newsgroups &optional SERVER)
18804
18805 The result data from this function should be the description of all
18806 groups available on the server.
18807
18808 @example
18809 description-buffer = *description-line
18810 @end example
18811
18812
18813 @item (nnchoke-request-newgroups DATE &optional SERVER)
18814
18815 The result data from this function should be all groups that were
18816 created after @samp{date}, which is in normal human-readable date
18817 format.  The data should be in the active buffer format.
18818
18819
18820 @item (nnchoke-request-create-group GROUP &optional SERVER)
18821
18822 This function should create an empty group with name @var{group}.
18823
18824 There should be no return data.
18825
18826
18827 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
18828
18829 This function should run the expiry process on all articles in the
18830 @var{articles} range (which is currently a simple list of article
18831 numbers.)  It is left up to the backend to decide how old articles
18832 should be before they are removed by this function.  If @var{force} is
18833 non-@code{nil}, all @var{articles} should be deleted, no matter how new
18834 they are.
18835
18836 This function should return a list of articles that it did not/was not
18837 able to delete.
18838
18839 There should be no result data returned.
18840
18841
18842 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
18843 &optional LAST)
18844
18845 This function should move @var{article} (which is a number) from
18846 @var{group} by calling @var{accept-form}.
18847
18848 This function should ready the article in question for moving by
18849 removing any header lines it has added to the article, and generally
18850 should ``tidy up'' the article.  Then it should @code{eval}
18851 @var{accept-form} in the buffer where the ``tidy'' article is.  This
18852 will do the actual copying.  If this @code{eval} returns a
18853 non-@code{nil} value, the article should be removed.
18854
18855 If @var{last} is @code{nil}, that means that there is a high likelihood
18856 that there will be more requests issued shortly, so that allows some
18857 optimizations.
18858
18859 The function should return a cons where the @code{car} is the group name and
18860 the @code{cdr} is the article number that the article was entered as.
18861
18862 There should be no data returned.
18863
18864
18865 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
18866
18867 This function takes the current buffer and inserts it into @var{group}.
18868 If @var{last} in @code{nil}, that means that there will be more calls to
18869 this function in short order.
18870
18871 The function should return a cons where the @code{car} is the group name and
18872 the @code{cdr} is the article number that the article was entered as.
18873
18874 There should be no data returned.
18875
18876
18877 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
18878
18879 This function should remove @var{article} (which is a number) from
18880 @var{group} and insert @var{buffer} there instead.
18881
18882 There should be no data returned.
18883
18884
18885 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
18886
18887 This function should delete @var{group}.  If @var{force}, it should
18888 really delete all the articles in the group, and then delete the group
18889 itself.  (If there is such a thing as ``the group itself''.)
18890
18891 There should be no data returned.
18892
18893
18894 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
18895
18896 This function should rename @var{group} into @var{new-name}.  All
18897 articles in @var{group} should move to @var{new-name}.
18898
18899 There should be no data returned.
18900
18901 @end table
18902
18903
18904 @node Error Messaging
18905 @subsubsection Error Messaging
18906
18907 @findex nnheader-report
18908 @findex nnheader-get-report
18909 The backends should use the function @code{nnheader-report} to report
18910 error conditions---they should not raise errors when they aren't able to
18911 perform a request.  The first argument to this function is the backend
18912 symbol, and the rest are interpreted as arguments to @code{format} if
18913 there are multiple of them, or just a string if there is one of them.
18914 This function must always returns @code{nil}.
18915
18916 @lisp
18917 (nnheader-report 'nnchoke "You did something totally bogus")
18918
18919 (nnheader-report 'nnchoke "Could not request group %s" group)
18920 @end lisp
18921
18922 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
18923 @code{nil} back from a server, and this function returns the most
18924 recently reported message for the backend in question.  This function
18925 takes one argument---the server symbol.
18926
18927 Internally, these functions access @var{backend}@code{-status-string},
18928 so the @code{nnchoke} backend will have its error message stored in
18929 @code{nnchoke-status-string}.
18930
18931
18932 @node Writing New Backends
18933 @subsubsection Writing New Backends
18934
18935 Many backends are quite similar.  @code{nnml} is just like
18936 @code{nnspool}, but it allows you to edit the articles on the server.
18937 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
18938 and it doesn't maintain overview databases.  @code{nndir} is just like
18939 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
18940 editing articles.
18941
18942 It would make sense if it were possible to ``inherit'' functions from
18943 backends when writing new backends.  And, indeed, you can do that if you
18944 want to.  (You don't have to if you don't want to, of course.)
18945
18946 All the backends declare their public variables and functions by using a
18947 package called @code{nnoo}.
18948
18949 To inherit functions from other backends (and allow other backends to
18950 inherit functions from the current backend), you should use the
18951 following macros:
18952
18953 @table @code
18954
18955 @item nnoo-declare
18956 This macro declares the first parameter to be a child of the subsequent
18957 parameters.  For instance:
18958
18959 @lisp
18960 (nnoo-declare nndir
18961   nnml nnmh)
18962 @end lisp
18963
18964 @code{nndir} has declared here that it intends to inherit functions from
18965 both @code{nnml} and @code{nnmh}.
18966
18967 @item defvoo
18968 This macro is equivalent to @code{defvar}, but registers the variable as
18969 a public server variable.  Most state-oriented variables should be
18970 declared with @code{defvoo} instead of @code{defvar}.
18971
18972 In addition to the normal @code{defvar} parameters, it takes a list of
18973 variables in the parent backends to map the variable to when executing
18974 a function in those backends.
18975
18976 @lisp
18977 (defvoo nndir-directory nil
18978   "Where nndir will look for groups."
18979   nnml-current-directory nnmh-current-directory)
18980 @end lisp
18981
18982 This means that @code{nnml-current-directory} will be set to
18983 @code{nndir-directory} when an @code{nnml} function is called on behalf
18984 of @code{nndir}.  (The same with @code{nnmh}.)
18985
18986 @item nnoo-define-basics
18987 This macro defines some common functions that almost all backends should
18988 have.
18989
18990 @example
18991 (nnoo-define-basics nndir)
18992 @end example
18993
18994 @item deffoo
18995 This macro is just like @code{defun} and takes the same parameters.  In
18996 addition to doing the normal @code{defun} things, it registers the
18997 function as being public so that other backends can inherit it.
18998
18999 @item nnoo-map-functions
19000 This macro allows mapping of functions from the current backend to
19001 functions from the parent backends.
19002
19003 @example
19004 (nnoo-map-functions nndir
19005   (nnml-retrieve-headers 0 nndir-current-group 0 0)
19006   (nnmh-request-article 0 nndir-current-group 0 0))
19007 @end example
19008
19009 This means that when @code{nndir-retrieve-headers} is called, the first,
19010 third, and fourth parameters will be passed on to
19011 @code{nnml-retrieve-headers}, while the second parameter is set to the
19012 value of @code{nndir-current-group}.
19013
19014 @item nnoo-import
19015 This macro allows importing functions from backends.  It should be the
19016 last thing in the source file, since it will only define functions that
19017 haven't already been defined.
19018
19019 @example
19020 (nnoo-import nndir
19021   (nnmh
19022    nnmh-request-list
19023    nnmh-request-newgroups)
19024   (nnml))
19025 @end example
19026
19027 This means that calls to @code{nndir-request-list} should just be passed
19028 on to @code{nnmh-request-list}, while all public functions from
19029 @code{nnml} that haven't been defined in @code{nndir} yet should be
19030 defined now.
19031
19032 @end table
19033
19034 Below is a slightly shortened version of the @code{nndir} backend.
19035
19036 @lisp
19037 ;;; nndir.el --- single directory newsgroup access for Gnus
19038 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
19039
19040 ;;; Code:
19041
19042 (require 'nnheader)
19043 (require 'nnmh)
19044 (require 'nnml)
19045 (require 'nnoo)
19046 (eval-when-compile (require 'cl))
19047
19048 (nnoo-declare nndir
19049   nnml nnmh)
19050
19051 (defvoo nndir-directory nil
19052   "Where nndir will look for groups."
19053   nnml-current-directory nnmh-current-directory)
19054
19055 (defvoo nndir-nov-is-evil nil
19056   "*Non-nil means that nndir will never retrieve NOV headers."
19057   nnml-nov-is-evil)
19058
19059 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
19060 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
19061 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
19062
19063 (defvoo nndir-status-string "" nil nnmh-status-string)
19064 (defconst nndir-version "nndir 1.0")
19065
19066 ;;; Interface functions.
19067
19068 (nnoo-define-basics nndir)
19069
19070 (deffoo nndir-open-server (server &optional defs)
19071   (setq nndir-directory
19072         (or (cadr (assq 'nndir-directory defs))
19073             server))
19074   (unless (assq 'nndir-directory defs)
19075     (push `(nndir-directory ,server) defs))
19076   (push `(nndir-current-group
19077           ,(file-name-nondirectory (directory-file-name nndir-directory)))
19078         defs)
19079   (push `(nndir-top-directory
19080           ,(file-name-directory (directory-file-name nndir-directory)))
19081         defs)
19082   (nnoo-change-server 'nndir server defs))
19083
19084 (nnoo-map-functions nndir
19085   (nnml-retrieve-headers 0 nndir-current-group 0 0)
19086   (nnmh-request-article 0 nndir-current-group 0 0)
19087   (nnmh-request-group nndir-current-group 0 0)
19088   (nnmh-close-group nndir-current-group 0))
19089
19090 (nnoo-import nndir
19091   (nnmh
19092    nnmh-status-message
19093    nnmh-request-list
19094    nnmh-request-newgroups))
19095
19096 (provide 'nndir)
19097 @end lisp
19098
19099
19100 @node Hooking New Backends Into Gnus
19101 @subsubsection Hooking New Backends Into Gnus
19102
19103 @vindex gnus-valid-select-methods
19104 Having Gnus start using your new backend is rather easy---you just
19105 declare it with the @code{gnus-declare-backend} functions.  This will
19106 enter the backend into the @code{gnus-valid-select-methods} variable.
19107
19108 @code{gnus-declare-backend} takes two parameters---the backend name and
19109 an arbitrary number of @dfn{abilities}.
19110
19111 Here's an example:
19112
19113 @lisp
19114 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
19115 @end lisp
19116
19117 The abilities can be:
19118
19119 @table @code
19120 @item mail
19121 This is a mailish backend---followups should (probably) go via mail.
19122 @item post
19123 This is a newsish backend---followups should (probably) go via news.
19124 @item post-mail
19125 This backend supports both mail and news.
19126 @item none
19127 This is neither a post nor mail backend---it's something completely
19128 different.
19129 @item respool
19130 It supports respooling---or rather, it is able to modify its source
19131 articles and groups.
19132 @item address
19133 The name of the server should be in the virtual server name.  This is
19134 true for almost all backends.
19135 @item prompt-address
19136 The user should be prompted for an address when doing commands like
19137 @kbd{B} in the group buffer.  This is true for backends like
19138 @code{nntp}, but not @code{nnmbox}, for instance.
19139 @end table
19140
19141
19142 @node Mail-like Backends
19143 @subsubsection Mail-like Backends
19144
19145 One of the things that separate the mail backends from the rest of the
19146 backends is the heavy dependence by the mail backends on common
19147 functions in @file{nnmail.el}.  For instance, here's the definition of
19148 @code{nnml-request-scan}:
19149
19150 @lisp
19151 (deffoo nnml-request-scan (&optional group server)
19152   (setq nnml-article-file-alist nil)
19153   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
19154 @end lisp
19155
19156 It simply calls @code{nnmail-get-new-mail} with a few parameters,
19157 and @code{nnmail} takes care of all the moving and splitting of the
19158 mail.
19159
19160 This function takes four parameters.
19161
19162 @table @var
19163 @item method
19164 This should be a symbol to designate which backend is responsible for
19165 the call.
19166
19167 @item exit-function
19168 This function should be called after the splitting has been performed.
19169
19170 @item temp-directory
19171 Where the temporary files should be stored.
19172
19173 @item group
19174 This optional argument should be a group name if the splitting is to be
19175 performed for one group only.
19176 @end table
19177
19178 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
19179 save each article.  @var{backend}@code{-active-number} will be called to
19180 find the article number assigned to this article.
19181
19182 The function also uses the following variables:
19183 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
19184 this backend); and @var{backend}@code{-group-alist} and
19185 @var{backend}@code{-active-file} to generate the new active file.
19186 @var{backend}@code{-group-alist} should be a group-active alist, like
19187 this:
19188
19189 @example
19190 (("a-group" (1 . 10))
19191  ("some-group" (34 . 39)))
19192 @end example
19193
19194
19195 @node Score File Syntax
19196 @subsection Score File Syntax
19197
19198 Score files are meant to be easily parseable, but yet extremely
19199 mallable.   It was decided that something that had the same read syntax
19200 as an Emacs Lisp list would fit that spec.
19201
19202 Here's a typical score file:
19203
19204 @lisp
19205 (("summary"
19206   ("win95" -10000 nil s)
19207   ("Gnus"))
19208  ("from"
19209   ("Lars" -1000))
19210  (mark -100))
19211 @end lisp
19212
19213 BNF definition of a score file:
19214
19215 @example
19216 score-file       = "" / "(" *element ")"
19217 element          = rule / atom
19218 rule             = string-rule / number-rule / date-rule
19219 string-rule      = "(" quote string-header quote space *string-match ")"
19220 number-rule      = "(" quote number-header quote space *number-match ")"
19221 date-rule        = "(" quote date-header quote space *date-match ")"
19222 quote            = <ascii 34>
19223 string-header    = "subject" / "from" / "references" / "message-id" /
19224                    "xref" / "body" / "head" / "all" / "followup"
19225 number-header    = "lines" / "chars"
19226 date-header      = "date"
19227 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
19228                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
19229 score            = "nil" / <integer>
19230 date             = "nil" / <natural number>
19231 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
19232                    "r" / "regex" / "R" / "Regex" /
19233                    "e" / "exact" / "E" / "Exact" /
19234                    "f" / "fuzzy" / "F" / "Fuzzy"
19235 number-match     = "(" <integer> [ "" / [ space score [ "" /
19236                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
19237 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
19238 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
19239                    space date [ "" / [ space date-match-t ] ] ] ] ")"
19240 date-match-t     = "nil" / "at" / "before" / "after"
19241 atom             = "(" [ required-atom / optional-atom ] ")"
19242 required-atom    = mark / expunge / mark-and-expunge / files /
19243                    exclude-files / read-only / touched
19244 optional-atom    = adapt / local / eval
19245 mark             = "mark" space nil-or-number
19246 nil-or-number    = "nil" / <integer>
19247 expunge          = "expunge" space nil-or-number
19248 mark-and-expunge = "mark-and-expunge" space nil-or-number
19249 files            = "files" *[ space <string> ]
19250 exclude-files    = "exclude-files" *[ space <string> ]
19251 read-only        = "read-only" [ space "nil" / space "t" ]
19252 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
19253 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
19254 local            = "local" *[ space "(" <string> space <form> ")" ]
19255 eval             = "eval" space <form>
19256 space            = *[ " " / <TAB> / <NEWLINE> ]
19257 @end example
19258
19259 Any unrecognized elements in a score file should be ignored, but not
19260 discarded.
19261
19262 As you can see, white space is needed, but the type and amount of white
19263 space is irrelevant.  This means that formatting of the score file is
19264 left up to the programmer---if it's simpler to just spew it all out on
19265 one looong line, then that's ok.
19266
19267 The meaning of the various atoms are explained elsewhere in this
19268 manual (@pxref{Score File Format}).
19269
19270
19271 @node Headers
19272 @subsection Headers
19273
19274 Internally Gnus uses a format for storing article headers that
19275 corresponds to the @sc{nov} format in a mysterious fashion.  One could
19276 almost suspect that the author looked at the @sc{nov} specification and
19277 just shamelessly @emph{stole} the entire thing, and one would be right.
19278
19279 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
19280 RFC1036 to talk about lines in the head of an article (e.g.,
19281 @code{From}).  It is used by many people as a synonym for
19282 ``head''---``the header and the body''.  (That should be avoided, in my
19283 opinion.)  And Gnus uses a format internally that it calls ``header'',
19284 which is what I'm talking about here.  This is a 9-element vector,
19285 basically, with each header (ouch) having one slot.
19286
19287 These slots are, in order: @code{number}, @code{subject}, @code{from},
19288 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
19289 @code{xref}.  There are macros for accessing and setting these
19290 slots---they all have predictable names beginning with
19291 @code{mail-header-} and @code{mail-header-set-}, respectively.
19292
19293 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
19294 be put in there.
19295
19296
19297 @node Ranges
19298 @subsection Ranges
19299
19300 @sc{gnus} introduced a concept that I found so useful that I've started
19301 using it a lot and have elaborated on it greatly.
19302
19303 The question is simple: If you have a large amount of objects that are
19304 identified by numbers (say, articles, to take a @emph{wild} example)
19305 that you want to qualify as being ``included'', a normal sequence isn't
19306 very useful.  (A 200,000 length sequence is a bit long-winded.)
19307
19308 The solution is as simple as the question: You just collapse the
19309 sequence.
19310
19311 @example
19312 (1 2 3 4 5 6 10 11 12)
19313 @end example
19314
19315 is transformed into
19316
19317 @example
19318 ((1 . 6) (10 . 12))
19319 @end example
19320
19321 To avoid having those nasty @samp{(13 . 13)} elements to denote a
19322 lonesome object, a @samp{13} is a valid element:
19323
19324 @example
19325 ((1 . 6) 7 (10 . 12))
19326 @end example
19327
19328 This means that comparing two ranges to find out whether they are equal
19329 is slightly tricky:
19330
19331 @example
19332 ((1 . 5) 7 8 (10 . 12))
19333 @end example
19334
19335 and
19336
19337 @example
19338 ((1 . 5) (7 . 8) (10 . 12))
19339 @end example
19340
19341 are equal.  In fact, any non-descending list is a range:
19342
19343 @example
19344 (1 2 3 4 5)
19345 @end example
19346
19347 is a perfectly valid range, although a pretty long-winded one.  This is
19348 also valid:
19349
19350 @example
19351 (1 . 5)
19352 @end example
19353
19354 and is equal to the previous range.
19355
19356 Here's a BNF definition of ranges.  Of course, one must remember the
19357 semantic requirement that the numbers are non-descending.  (Any number
19358 of repetition of the same number is allowed, but apt to disappear in
19359 range handling.)
19360
19361 @example
19362 range           = simple-range / normal-range
19363 simple-range    = "(" number " . " number ")"
19364 normal-range    = "(" start-contents ")"
19365 contents        = "" / simple-range *[ " " contents ] /
19366                   number *[ " " contents ]
19367 @end example
19368
19369 Gnus currently uses ranges to keep track of read articles and article
19370 marks.  I plan on implementing a number of range operators in C if The
19371 Powers That Be are willing to let me.  (I haven't asked yet, because I
19372 need to do some more thinking on what operators I need to make life
19373 totally range-based without ever having to convert back to normal
19374 sequences.)
19375
19376
19377 @node Group Info
19378 @subsection Group Info
19379
19380 Gnus stores all permanent info on groups in a @dfn{group info} list.
19381 This list is from three to six elements (or more) long and exhaustively
19382 describes the group.
19383
19384 Here are two example group infos; one is a very simple group while the
19385 second is a more complex one:
19386
19387 @example
19388 ("no.group" 5 (1 . 54324))
19389
19390 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
19391                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
19392                 (nnml "")
19393                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
19394 @end example
19395
19396 The first element is the @dfn{group name}---as Gnus knows the group,
19397 anyway.  The second element is the @dfn{subscription level}, which
19398 normally is a small integer.  (It can also be the @dfn{rank}, which is a
19399 cons cell where the @code{car} is the level and the @code{cdr} is the
19400 score.)  The third element is a list of ranges of read articles.  The
19401 fourth element is a list of lists of article marks of various kinds.
19402 The fifth element is the select method (or virtual server, if you like).
19403 The sixth element is a list of @dfn{group parameters}, which is what
19404 this section is about.
19405
19406 Any of the last three elements may be missing if they are not required.
19407 In fact, the vast majority of groups will normally only have the first
19408 three elements, which saves quite a lot of cons cells.
19409
19410 Here's a BNF definition of the group info format:
19411
19412 @example
19413 info          = "(" group space ralevel space read
19414                 [ "" / [ space marks-list [ "" / [ space method [ "" /
19415                 space parameters ] ] ] ] ] ")"
19416 group         = quote <string> quote
19417 ralevel       = rank / level
19418 level         = <integer in the range of 1 to inf>
19419 rank          = "(" level "." score ")"
19420 score         = <integer in the range of 1 to inf>
19421 read          = range
19422 marks-lists   = nil / "(" *marks ")"
19423 marks         = "(" <string> range ")"
19424 method        = "(" <string> *elisp-forms ")"
19425 parameters    = "(" *elisp-forms ")"
19426 @end example
19427
19428 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
19429 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
19430 in pseudo-BNF.
19431
19432 If you have a Gnus info and want to access the elements, Gnus offers a
19433 series of macros for getting/setting these elements.
19434
19435 @table @code
19436 @item gnus-info-group
19437 @itemx gnus-info-set-group
19438 @findex gnus-info-group
19439 @findex gnus-info-set-group
19440 Get/set the group name.
19441
19442 @item gnus-info-rank
19443 @itemx gnus-info-set-rank
19444 @findex gnus-info-rank
19445 @findex gnus-info-set-rank
19446 Get/set the group rank (@pxref{Group Score}).
19447
19448 @item gnus-info-level
19449 @itemx gnus-info-set-level
19450 @findex gnus-info-level
19451 @findex gnus-info-set-level
19452 Get/set the group level.
19453
19454 @item gnus-info-score
19455 @itemx gnus-info-set-score
19456 @findex gnus-info-score
19457 @findex gnus-info-set-score
19458 Get/set the group score (@pxref{Group Score}).
19459
19460 @item gnus-info-read
19461 @itemx gnus-info-set-read
19462 @findex gnus-info-read
19463 @findex gnus-info-set-read
19464 Get/set the ranges of read articles.
19465
19466 @item gnus-info-marks
19467 @itemx gnus-info-set-marks
19468 @findex gnus-info-marks
19469 @findex gnus-info-set-marks
19470 Get/set the lists of ranges of marked articles.
19471
19472 @item gnus-info-method
19473 @itemx gnus-info-set-method
19474 @findex gnus-info-method
19475 @findex gnus-info-set-method
19476 Get/set the group select method.
19477
19478 @item gnus-info-params
19479 @itemx gnus-info-set-params
19480 @findex gnus-info-params
19481 @findex gnus-info-set-params
19482 Get/set the group parameters.
19483 @end table
19484
19485 All the getter functions take one parameter---the info list.  The setter
19486 functions take two parameters---the info list and the new value.
19487
19488 The last three elements in the group info aren't mandatory, so it may be
19489 necessary to extend the group info before setting the element.  If this
19490 is necessary, you can just pass on a non-@code{nil} third parameter to
19491 the three final setter functions to have this happen automatically.
19492
19493
19494 @node Extended Interactive
19495 @subsection Extended Interactive
19496 @cindex interactive
19497 @findex gnus-interactive
19498
19499 Gnus extends the standard Emacs @code{interactive} specification
19500 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
19501 Prefixes}).  Here's an example of how this is used:
19502
19503 @lisp
19504 (defun gnus-summary-increase-score (&optional score symp)
19505   (interactive (gnus-interactive "P\ny"))
19506   ...
19507   )
19508 @end lisp
19509
19510 The best thing to do would have been to implement
19511 @code{gnus-interactive} as a macro which would have returned an
19512 @code{interactive} form, but this isn't possible since Emacs checks
19513 whether a function is interactive or not by simply doing an @code{assq}
19514 on the lambda form.  So, instead we have @code{gnus-interactive}
19515 function that takes a string and returns values that are usable to
19516 @code{interactive}.
19517
19518 This function accepts (almost) all normal @code{interactive} specs, but
19519 adds a few more.
19520
19521 @table @samp
19522 @item y
19523 @vindex gnus-current-prefix-symbol
19524 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
19525 variable.
19526
19527 @item Y
19528 @vindex gnus-current-prefix-symbols
19529 A list of the current symbolic prefixes---the
19530 @code{gnus-current-prefix-symbol} variable.
19531
19532 @item A
19533 The current article number---the @code{gnus-summary-article-number}
19534 function.
19535
19536 @item H
19537 The current article header---the @code{gnus-summary-article-header}
19538 function.
19539
19540 @item g
19541 The current group name---the @code{gnus-group-group-name}
19542 function.
19543
19544 @end table
19545
19546
19547 @node Emacs/XEmacs Code
19548 @subsection Emacs/XEmacs Code
19549 @cindex XEmacs
19550 @cindex Emacsen
19551
19552 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
19553 platforms must be the primary one.  I chose Emacs.  Not because I don't
19554 like XEmacs or Mule, but because it comes first alphabetically.
19555
19556 This means that Gnus will byte-compile under Emacs with nary a warning,
19557 while XEmacs will pump out gigabytes of warnings while byte-compiling.
19558 As I use byte-compilation warnings to help me root out trivial errors in
19559 Gnus, that's very useful.
19560
19561 I've also consistently used Emacs function interfaces, but have used
19562 Gnusey aliases for the functions.  To take an example:  Emacs defines a
19563 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
19564 function.  I then define a function called @code{gnus-run-at-time} that
19565 takes the same parameters as the Emacs @code{run-at-time}.  When running
19566 Gnus under Emacs, the former function is just an alias for the latter.
19567 However, when running under XEmacs, the former is an alias for the
19568 following function:
19569
19570 @lisp
19571 (defun gnus-xmas-run-at-time (time repeat function &rest args)
19572   (start-itimer
19573    "gnus-run-at-time"
19574    `(lambda ()
19575       (,function ,@@args))
19576    time repeat))
19577 @end lisp
19578
19579 This sort of thing has been done for bunches of functions.  Gnus does
19580 not redefine any native Emacs functions while running under XEmacs---it
19581 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
19582 all over.
19583
19584 In the cases where the XEmacs function interface was obviously cleaner,
19585 I used it instead.  For example @code{gnus-region-active-p} is an alias
19586 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
19587
19588 Of course, I could have chosen XEmacs as my native platform and done
19589 mapping functions the other way around.  But I didn't.  The performance
19590 hit these indirections impose on Gnus under XEmacs should be slight.
19591
19592
19593 @node Various File Formats
19594 @subsection Various File Formats
19595
19596 @menu
19597 * Active File Format::      Information on articles and groups available.
19598 * Newsgroups File Format::  Group descriptions.
19599 @end menu
19600
19601
19602 @node Active File Format
19603 @subsubsection Active File Format
19604
19605 The active file lists all groups available on the server in
19606 question.  It also lists the highest and lowest current article numbers
19607 in each group.
19608
19609 Here's an excerpt from a typical active file:
19610
19611 @example
19612 soc.motss 296030 293865 y
19613 alt.binaries.pictures.fractals 3922 3913 n
19614 comp.sources.unix 1605 1593 m
19615 comp.binaries.ibm.pc 5097 5089 y
19616 no.general 1000 900 y
19617 @end example
19618
19619 Here's a pseudo-BNF definition of this file:
19620
19621 @example
19622 active      = *group-line
19623 group-line  = group space high-number space low-number space flag <NEWLINE>
19624 group       = <non-white-space string>
19625 space       = " "
19626 high-number = <non-negative integer>
19627 low-number  = <positive integer>
19628 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
19629 @end example
19630
19631 For a full description of this file, see the manual pages for
19632 @samp{innd}, in particular @samp{active(5)}.
19633
19634
19635 @node Newsgroups File Format
19636 @subsubsection Newsgroups File Format
19637
19638 The newsgroups file lists groups along with their descriptions.  Not all
19639 groups on the server have to be listed,  and not all groups in the file
19640 have to exist on the server.  The file is meant purely as information to
19641 the user.
19642
19643 The format is quite simple; a group name, a tab, and the description.
19644 Here's the definition:
19645
19646 @example
19647 newsgroups    = *line
19648 line          = group tab description <NEWLINE>
19649 group         = <non-white-space string>
19650 tab           = <TAB>
19651 description   = <string>
19652 @end example
19653
19654
19655 @page
19656 @node Emacs for Heathens
19657 @section Emacs for Heathens
19658
19659 Believe it or not, but some people who use Gnus haven't really used
19660 Emacs much before they embarked on their journey on the Gnus Love Boat.
19661 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
19662 region'', and ``set @code{gnus-flargblossen} to an alist where the key
19663 is a regexp that is used for matching on the group name'' are magical
19664 phrases with little or no meaning, then this appendix is for you.  If
19665 you are already familiar with Emacs, just ignore this and go fondle your
19666 cat instead.
19667
19668 @menu
19669 * Keystrokes::      Entering text and executing commands.
19670 * Emacs Lisp::      The built-in Emacs programming language.
19671 @end menu
19672
19673
19674 @node Keystrokes
19675 @subsection Keystrokes
19676
19677 @itemize @bullet
19678 @item
19679 Q: What is an experienced Emacs user?
19680
19681 @item
19682 A: A person who wishes that the terminal had pedals.
19683 @end itemize
19684
19685 Yes, when you use Emacs, you are apt to use the control key, the shift
19686 key and the meta key a lot.  This is very annoying to some people
19687 (notably @code{vi}le users), and the rest of us just love the hell out
19688 of it.  Just give up and submit.  Emacs really does stand for
19689 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
19690 may have heard from other disreputable sources (like the Emacs author).
19691
19692 The shift keys are normally located near your pinky fingers, and are
19693 normally used to get capital letters and stuff.  You probably use it all
19694 the time.  The control key is normally marked ``CTRL'' or something like
19695 that.  The meta key is, funnily enough, never marked as such on any
19696 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
19697 which is the meta key on this keyboard.  It's usually located somewhere
19698 to the left hand side of the keyboard, usually on the bottom row.
19699
19700 Now, us Emacs people don't say ``press the meta-control-m key'',
19701 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
19702 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
19703 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
19704 down the control key, and hold it down while you press @kbd{k}''.
19705 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
19706 the control key and then press @kbd{k}''.  Simple, ay?
19707
19708 This is somewhat complicated by the fact that not all keyboards have a
19709 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
19710 means ``press escape, release escape, press @kbd{k}''.  That's much more
19711 work than if you have a meta key, so if that's the case, I respectfully
19712 suggest you get a real keyboard with a meta key.  You can't live without
19713 it.
19714
19715
19716
19717 @node Emacs Lisp
19718 @subsection Emacs Lisp
19719
19720 Emacs is the King of Editors because it's really a Lisp interpreter.
19721 Each and every key you tap runs some Emacs Lisp code snippet, and since
19722 Emacs Lisp is an interpreted language, that means that you can configure
19723 any key to run any arbitrary code.  You just, like, do it.
19724
19725 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
19726 functions.  (These are byte-compiled for speed, but it's still
19727 interpreted.)  If you decide that you don't like the way Gnus does
19728 certain things, it's trivial to have it do something a different way.
19729 (Well, at least if you know how to write Lisp code.)  However, that's
19730 beyond the scope of this manual, so we are simply going to talk about
19731 some common constructs that you normally use in your @file{.emacs} file
19732 to customize Gnus.
19733
19734 If you want to set the variable @code{gnus-florgbnize} to four (4), you
19735 write the following:
19736
19737 @lisp
19738 (setq gnus-florgbnize 4)
19739 @end lisp
19740
19741 This function (really ``special form'') @code{setq} is the one that can
19742 set a variable to some value.  This is really all you need to know.  Now
19743 you can go and fill your @code{.emacs} file with lots of these to change
19744 how Gnus works.
19745
19746 If you have put that thing in your @code{.emacs} file, it will be read
19747 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
19748 start Emacs.  If you want to change the variable right away, simply say
19749 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
19750 previous ``form'', which is a simple @code{setq} statement here.
19751
19752 Go ahead---just try it, if you're located at your Emacs.  After you
19753 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
19754 is the return value of the form you @code{eval}ed.
19755
19756 Some pitfalls:
19757
19758 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
19759 that means:
19760
19761 @lisp
19762 (setq gnus-read-active-file 'some)
19763 @end lisp
19764
19765 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
19766 @samp{nntp.ifi.uio.no}'', that means:
19767
19768 @lisp
19769 (setq gnus-nntp-server "nntp.ifi.uio.no")
19770 @end lisp
19771
19772 So be careful not to mix up strings (the latter) with symbols (the
19773 former).  The manual is unambiguous, but it can be confusing.
19774
19775 @page
19776 @include gnus-faq.texi
19777
19778 @node Index
19779 @chapter Index
19780 @printindex cp
19781
19782 @node Key Index
19783 @chapter Key Index
19784 @printindex ky
19785
19786 @summarycontents
19787 @contents
19788 @bye
19789
19790 @iftex
19791 @iflatex
19792 \end{document}
19793 @end iflatex
19794 @end iftex
19795
19796 @c End:
19797