d9f92280723ee43c2e803d82f457a6a27c626869
[elisp/gnus.git-] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Semi-gnus 6.10.059 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @c @direntry
9 @c * Gnus: (gnus).         The newsreader Gnus.
10 @c @end direntry
11 @iftex
12 @finalout
13 @end iftex
14 @setchapternewpage odd
15
16 @iftex
17 @iflatex
18 \documentclass[twoside,a4paper,openright,11pt]{book}
19 \usepackage[latin1]{inputenc}
20 \usepackage{pagestyle}
21 \usepackage{epsfig}
22 \usepackage{bembo}
23 \usepackage{pixidx}
24
25 \makeindex
26 \begin{document}
27
28 \newcommand{\gnuschaptername}{}
29 \newcommand{\gnussectionname}{}
30
31 \newcommand{\gnusbackslash}{/}
32
33 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
34 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
35
36 \newcommand{\gnuskindex}[1]{\index{#1}}
37 \newcommand{\gnusindex}[1]{\index{#1}}
38
39 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
40 \newcommand{\gnuscode}[1]{\gnustt{#1}}
41 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
42 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
43 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusdfn}[1]{\textit{#1}}
46 \newcommand{\gnusi}[1]{\textit{#1}}
47 \newcommand{\gnusstrong}[1]{\textbf{#1}}
48 \newcommand{\gnusemph}[1]{\textit{#1}}
49 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
50 \newcommand{\gnussc}[1]{\textsc{#1}}
51 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
52 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
53
54 \newcommand{\gnusbullet}{{${\bullet}$}}
55 \newcommand{\gnusdollar}{\$}
56 \newcommand{\gnusampersand}{\&}
57 \newcommand{\gnuspercent}{\%}
58 \newcommand{\gnushash}{\#}
59 \newcommand{\gnushat}{\symbol{"5E}}
60 \newcommand{\gnusunderline}{\symbol{"5F}}
61 \newcommand{\gnusnot}{$\neg$}
62 \newcommand{\gnustilde}{\symbol{"7E}}
63 \newcommand{\gnusless}{{$<$}}
64 \newcommand{\gnusgreater}{{$>$}}
65 \newcommand{\gnusbraceleft}{{$>$}}
66 \newcommand{\gnusbraceright}{{$>$}}
67
68 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
69 \newcommand{\gnusinteresting}{
70 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
71 }
72
73 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
74
75 \newcommand{\gnuspagechapter}[1]{
76 {\mbox{}}
77 }
78
79 \newdimen{\gnusdimen}
80 \gnusdimen 0pt
81
82 \newcommand{\gnuschapter}[2]{
83 \gnuscleardoublepage
84 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
85 \chapter{#2}
86 \renewcommand{\gnussectionname}{}
87 \renewcommand{\gnuschaptername}{#2}
88 \thispagestyle{empty}
89 \hspace*{-2cm}
90 \begin{picture}(500,500)(0,0)
91 \put(480,350){\makebox(0,0)[tr]{#1}}
92 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
93 \end{picture}
94 \clearpage
95 }
96
97 \newcommand{\gnusfigure}[3]{
98 \begin{figure}
99 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
100 #3
101 \end{picture}
102 \caption{#1}
103 \end{figure}
104 }
105
106 \newcommand{\gnusicon}[1]{
107 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
108 }
109
110 \newcommand{\gnuspicon}[1]{
111 \margindex{\epsfig{figure=#1,width=2cm}}
112 }
113
114 \newcommand{\gnusxface}[2]{
115 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
116 }
117
118 \newcommand{\gnussmiley}[2]{
119 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
120 }
121
122 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
123
124 \newcommand{\gnussection}[1]{
125 \renewcommand{\gnussectionname}{#1}
126 \section{#1}
127 }
128
129 \newenvironment{codelist}%
130 {\begin{list}{}{
131 }
132 }{\end{list}}
133
134 \newenvironment{kbdlist}%
135 {\begin{list}{}{
136 \labelwidth=0cm
137 }
138 }{\end{list}}
139
140 \newenvironment{dfnlist}%
141 {\begin{list}{}{
142 }
143 }{\end{list}}
144
145 \newenvironment{stronglist}%
146 {\begin{list}{}{
147 }
148 }{\end{list}}
149
150 \newenvironment{samplist}%
151 {\begin{list}{}{
152 }
153 }{\end{list}}
154
155 \newenvironment{varlist}%
156 {\begin{list}{}{
157 }
158 }{\end{list}}
159
160 \newenvironment{emphlist}%
161 {\begin{list}{}{
162 }
163 }{\end{list}}
164
165 \newlength\gnusheadtextwidth
166 \setlength{\gnusheadtextwidth}{\headtextwidth}
167 \addtolength{\gnusheadtextwidth}{1cm}
168
169 \newpagestyle{gnuspreamble}%
170 {
171 {
172 \ifodd\count0
173 {
174 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
175 }
176 \else
177 {
178 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
179 }
180 }
181 \fi
182 }
183 }
184 {
185 \ifodd\count0
186 \mbox{} \hfill
187 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
188 \else
189 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
190 \hfill \mbox{}
191 \fi
192 }
193
194 \newpagestyle{gnusindex}%
195 {
196 {
197 \ifodd\count0
198 {
199 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
200 }
201 \else
202 {
203 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
204 }
205 \fi
206 }
207 }
208 {
209 \ifodd\count0
210 \mbox{} \hfill
211 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
212 \else
213 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
214 \hfill \mbox{}
215 \fi
216 }
217
218 \newpagestyle{gnus}%
219 {
220 {
221 \ifodd\count0
222 {
223 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
224 }
225 \else
226 {
227 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
228 }
229 \fi
230 }
231 }
232 {
233 \ifodd\count0
234 \mbox{} \hfill
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
236 \else
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
238 \hfill \mbox{}
239 \fi
240 }
241
242 \pagenumbering{roman}
243 \pagestyle{gnuspreamble}
244
245 @end iflatex
246 @end iftex
247
248 @iftex
249 @iflatex
250 \begin{titlepage}
251 {
252
253 %\addtolength{\oddsidemargin}{-5cm}
254 %\addtolength{\evensidemargin}{-5cm}
255 \parindent=0cm
256 \addtolength{\textheight}{2cm}
257
258 \gnustitle{\gnustitlename}\\
259 \rule{15cm}{1mm}\\
260 \vfill
261 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
262 \vfill
263 \rule{15cm}{1mm}\\
264 \gnusauthor{by Lars Magne Ingebrigtsen}
265 \newpage
266 }
267
268 \mbox{}
269 \vfill
270
271 \thispagestyle{empty}
272
273 Copyright \copyright{} 1995,96,97,98,99 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,97,98,99 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 Semi-gnus 6.10.059 Manual
322
323 @author by Lars Magne Ingebrigtsen
324 @page
325
326 @vskip 0pt plus 1filll
327 Copyright @copyright{} 1995,96,97,98,99 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 Semi-gnus provides MIME features based on SEMI API.  So Semi-gnus
358 supports your right to read strange messages including big images or
359 other various kinds of formats.  Semi-gnus also supports
360 internationalization/localization and multiscript features based on MULE
361 API.  So Semi-gnus does not discriminate various language communities.
362 Oh, if you are a Klingon, please wait Unicode Next Generation.
363
364 This manual corresponds to Semi-gnus 6.10.059.
365
366 @end ifinfo
367
368 @iftex
369
370 @iflatex
371 \tableofcontents
372 \gnuscleardoublepage
373 @end iflatex
374
375 Gnus is the advanced, self-documenting, customizable, extensible
376 unreal-time newsreader for GNU Emacs.
377
378 Oops.  That sounds oddly familiar, so let's start over again to avoid
379 being accused of plagiarism:
380
381 Gnus is a message-reading laboratory.  It will let you look at just
382 about anything as if it were a newsgroup.  You can read mail with it,
383 you can browse directories with it, you can @code{ftp} with it---you can
384 even read news with it!
385
386 Gnus tries to empower people who read news the same way Emacs empowers
387 people who edit text.  Gnus sets no limits to what the user should be
388 allowed to do.  Users are encouraged to extend gnus to make it behave
389 like they want it to behave.  A program should not control people;
390 people should be empowered to do what they want by using (or abusing)
391 the program.
392
393 @end iftex
394
395
396 @menu
397 * Starting Up::           Finding news can be a pain.
398 * The Group Buffer::      Selecting, subscribing and killing groups.
399 * The Summary Buffer::    Reading, saving and posting articles.
400 * The Article Buffer::    Displaying and handling articles.
401 * Composing Messages::    Information on sending mail and news.
402 * Select Methods::        Gnus reads all messages from various select methods.
403 * Scoring::               Assigning values to articles.
404 * Various::               General purpose settings.
405 * The End::               Farewell and goodbye.
406 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
407 * Index::                 Variable, function and concept index.
408 * Key Index::             Key Index.
409 @end menu
410
411 @node Starting Up
412 @chapter Starting gnus
413 @cindex starting up
414
415 @kindex M-x gnus
416 @findex gnus
417 If your system administrator has set things up properly, starting gnus
418 and reading news is extremely easy---you just type @kbd{M-x gnus} in
419 your Emacs.
420
421 @findex gnus-other-frame
422 @kindex M-x gnus-other-frame
423 If you want to start gnus in a different frame, you can use the command
424 @kbd{M-x gnus-other-frame} instead.
425
426 If things do not go smoothly at startup, you have to twiddle some
427 variables in your @file{~/.gnus} file.  This file is similar to
428 @file{~/.emacs}, but is read when gnus starts.
429
430 If you puzzle at any terms used in this manual, please refer to the
431 terminology section (@pxref{Terminology}).
432
433 @menu
434 * Finding the News::    Choosing a method for getting news.
435 * The First Time::      What does gnus do the first time you start it?
436 * The Server is Down::  How can I read my mail then?
437 * Slave Gnusae::        You can have more than one gnus active at a time.
438 * Fetching a Group::    Starting gnus just to read a group.
439 * New Groups::          What is gnus supposed to do with new groups?
440 * Startup Files::       Those pesky startup files---@file{.newsrc}.
441 * Auto Save::           Recovering from a crash.
442 * The Active File::     Reading the active file over a slow line Takes Time.
443 * Changing Servers::    You may want to move from one server to another.
444 * Startup Variables::   Other variables you might change.
445 @end menu
446
447
448 @node Finding the News
449 @section Finding the News
450 @cindex finding news
451
452 @vindex gnus-select-method
453 @c @head
454 The @code{gnus-select-method} variable says where gnus should look for
455 news.  This variable should be a list where the first element says
456 @dfn{how} and the second element says @dfn{where}.  This method is your
457 native method.  All groups not fetched with this method are
458 foreign groups.
459
460 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
461 you want to get your daily dosage of news from, you'd say:
462
463 @lisp
464 (setq gnus-select-method '(nntp "news.somewhere.edu"))
465 @end lisp
466
467 If you want to read directly from the local spool, say:
468
469 @lisp
470 (setq gnus-select-method '(nnspool ""))
471 @end lisp
472
473 If you can use a local spool, you probably should, as it will almost
474 certainly be much faster.
475
476 @vindex gnus-nntpserver-file
477 @cindex NNTPSERVER
478 @cindex @sc{nntp} server
479 If this variable is not set, gnus will take a look at the
480 @code{NNTPSERVER} environment variable.  If that variable isn't set,
481 gnus will see whether @code{gnus-nntpserver-file}
482 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
483 that fails as well, gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
484
485 @vindex gnus-nntp-server
486 If @code{gnus-nntp-server} is set, this variable will override
487 @code{gnus-select-method}.  You should therefore set
488 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
489
490 @vindex gnus-secondary-servers
491 @vindex gnus-nntp-server
492 You can also make gnus prompt you interactively for the name of an
493 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
494 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
495 in the @code{gnus-secondary-servers} list (if any).  You can also just
496 type in the name of any server you feel like visiting.  (Note that this
497 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
498 gnus} later in the same Emacs session, Gnus will contact the same
499 server.)
500
501 @findex gnus-group-browse-foreign-server
502 @kindex B (Group)
503 However, if you use one @sc{nntp} server regularly and are just
504 interested in a couple of groups from a different server, you would be
505 better served by using the @kbd{B} command in the group buffer.  It will
506 let you have a look at what groups are available, and you can subscribe
507 to any of the groups you want to.  This also makes @file{.newsrc}
508 maintenance much tidier.  @xref{Foreign Groups}.
509
510 @vindex gnus-secondary-select-methods
511 @c @head
512 A slightly different approach to foreign groups is to set the
513 @code{gnus-secondary-select-methods} variable.  The select methods
514 listed in this variable are in many ways just as native as the
515 @code{gnus-select-method} server.  They will also be queried for active
516 files during startup (if that's required), and new newsgroups that
517 appear on these servers will be subscribed (or not) just as native
518 groups are.
519
520 For instance, if you use the @code{nnmbox} backend to read your mail, you
521 would typically set this variable to
522
523 @lisp
524 (setq gnus-secondary-select-methods '((nnmbox "")))
525 @end lisp
526
527
528 @node The First Time
529 @section The First Time
530 @cindex first time usage
531
532 If no startup files exist, gnus will try to determine what groups should
533 be subscribed by default.
534
535 @vindex gnus-default-subscribed-newsgroups
536 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
537 will subscribe you to just those groups in that list, leaving the rest
538 killed.  Your system administrator should have set this variable to
539 something useful.
540
541 Since she hasn't, gnus will just subscribe you to a few arbitrarily
542 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
543 here as @dfn{whatever Lars thinks you should read}.)
544
545 You'll also be subscribed to the gnus documentation group, which should
546 help you with most common problems.
547
548 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
549 use the normal functions for handling new groups, and not do anything
550 special.
551
552
553 @node The Server is Down
554 @section The Server is Down
555 @cindex server errors
556
557 If the default server is down, gnus will understandably have some
558 problems starting.  However, if you have some mail groups in addition to
559 the news groups, you may want to start gnus anyway.
560
561 Gnus, being the trusting sort of program, will ask whether to proceed
562 without a native select method if that server can't be contacted.  This
563 will happen whether the server doesn't actually exist (i.e., you have
564 given the wrong address) or the server has just momentarily taken ill
565 for some reason or other.  If you decide to continue and have no foreign
566 groups, you'll find it difficult to actually do anything in the group
567 buffer.  But, hey, that's your problem.  Blllrph!
568
569 @findex gnus-no-server
570 @kindex M-x gnus-no-server
571 @c @head
572 If you know that the server is definitely down, or you just want to read
573 your mail without bothering with the server at all, you can use the
574 @code{gnus-no-server} command to start gnus.  That might come in handy
575 if you're in a hurry as well.  This command will not attempt to contact
576 your primary server---instead, it will just activate all groups on level
577 1 and 2.  (You should preferably keep no native groups on those two
578 levels.)
579
580
581 @node Slave Gnusae
582 @section Slave Gnusae
583 @cindex slave
584
585 You might want to run more than one Emacs with more than one gnus at the
586 same time.  If you are using different @file{.newsrc} files (e.g., if you
587 are using the two different gnusae to read from two different servers),
588 that is no problem whatsoever.  You just do it.
589
590 The problem appears when you want to run two Gnusae that use the same
591 @code{.newsrc} file.
592
593 To work around that problem some, we here at the Think-Tank at the gnus
594 Towers have come up with a new concept: @dfn{Masters} and
595 @dfn{slaves}.  (We have applied for a patent on this concept, and have
596 taken out a copyright on those words.  If you wish to use those words in
597 conjunction with each other, you have to send $1 per usage instance to
598 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
599 Applications}) will be much more expensive, of course.)
600
601 Anyways, you start one gnus up the normal way with @kbd{M-x gnus} (or
602 however you do it).  Each subsequent slave gnusae should be started with
603 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
604 files, but instead save @dfn{slave files} that contain information only
605 on what groups have been read in the slave session.  When a master gnus
606 starts, it will read (and delete) these slave files, incorporating all
607 information from them.  (The slave files will be read in the sequence
608 they were created, so the latest changes will have precedence.)
609
610 Information from the slave files has, of course, precedence over the
611 information in the normal (i.e., master) @code{.newsrc} file.
612
613
614 @node Fetching a Group
615 @section Fetching a Group
616 @cindex fetching a group
617
618 @findex gnus-fetch-group
619 It is sometimes convenient to be able to just say ``I want to read this
620 group and I don't care whether gnus has been started or not''.  This is
621 perhaps more useful for people who write code than for users, but the
622 command @code{gnus-fetch-group} provides this functionality in any case.
623 It takes the group name as a parameter.
624
625
626 @node New Groups
627 @section New Groups
628 @cindex new groups
629 @cindex subscription
630
631 @vindex gnus-check-new-newsgroups
632 If you are satisfied that you really never want to see any new groups,
633 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
634 also save you some time at startup.  Even if this variable is
635 @code{nil}, you can always subscribe to the new groups just by pressing
636 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
637 is @code{ask-server} by default.  If you set this variable to
638 @code{always}, then gnus will query the backends for new groups even
639 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
640
641 @menu
642 * Checking New Groups::      Determining what groups are new.
643 * Subscription Methods::     What gnus should do with new groups.
644 * Filtering New Groups::     Making gnus ignore certain new groups.
645 @end menu
646
647
648 @node Checking New Groups
649 @subsection Checking New Groups
650
651 Gnus normally determines whether a group is new or not by comparing the
652 list of groups from the active file(s) with the lists of subscribed and
653 dead groups.  This isn't a particularly fast method.  If
654 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
655 server for new groups since the last time.  This is both faster and
656 cheaper.  This also means that you can get rid of the list of killed
657 groups altogether, so you may set @code{gnus-save-killed-list} to
658 @code{nil}, which will save time both at startup, at exit, and all over.
659 Saves disk space, too.  Why isn't this the default, then?
660 Unfortunately, not all servers support this command.
661
662 I bet I know what you're thinking now: How do I find out whether my
663 server supports @code{ask-server}?  No?  Good, because I don't have a
664 fail-safe answer.  I would suggest just setting this variable to
665 @code{ask-server} and see whether any new groups appear within the next
666 few days.  If any do, then it works.  If none do, then it doesn't
667 work.  I could write a function to make gnus guess whether the server
668 supports @code{ask-server}, but it would just be a guess.  So I won't.
669 You could @code{telnet} to the server and say @code{HELP} and see
670 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
671 it does, then it might work.  (But there are servers that lists
672 @samp{NEWGROUPS} without supporting the function properly.)
673
674 This variable can also be a list of select methods.  If so, gnus will
675 issue an @code{ask-server} command to each of the select methods, and
676 subscribe them (or not) using the normal methods.  This might be handy
677 if you are monitoring a few servers for new groups.  A side effect is
678 that startup will take much longer, so you can meditate while waiting.
679 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
680
681
682 @node Subscription Methods
683 @subsection Subscription Methods
684
685 @vindex gnus-subscribe-newsgroup-method
686 What gnus does when it encounters a new group is determined by the
687 @code{gnus-subscribe-newsgroup-method} variable.
688
689 This variable should contain a function.  This function will be called
690 with the name of the new group as the only parameter.
691
692 Some handy pre-fab functions are:
693
694 @table @code
695
696 @item gnus-subscribe-zombies
697 @vindex gnus-subscribe-zombies
698 Make all new groups zombies.  This is the default.  You can browse the
699 zombies later (with @kbd{A z}) and either kill them all off properly
700 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
701
702 @item gnus-subscribe-randomly
703 @vindex gnus-subscribe-randomly
704 Subscribe all new groups in arbitrary order.  This really means that all
705 new groups will be added at ``the top'' of the group buffer.
706
707 @item gnus-subscribe-alphabetically
708 @vindex gnus-subscribe-alphabetically
709 Subscribe all new groups in alphabetical order.
710
711 @item gnus-subscribe-hierarchically
712 @vindex gnus-subscribe-hierarchically
713 Subscribe all new groups hierarchically.  The difference between this
714 function and @code{gnus-subscribe-alphabetically} is slight.
715 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
716 alphabetical fashion, while this function will enter groups into it's
717 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
718 @samp{comp} hierarchy, this function will not mess that configuration
719 up.  Or something like that.
720
721 @item gnus-subscribe-interactively
722 @vindex gnus-subscribe-interactively
723 Subscribe new groups interactively.  This means that gnus will ask
724 you about @strong{all} new groups.  The groups you choose to subscribe
725 to will be subscribed hierarchically.
726
727 @item gnus-subscribe-killed
728 @vindex gnus-subscribe-killed
729 Kill all new groups.
730
731 @end table
732
733 @vindex gnus-subscribe-hierarchical-interactive
734 A closely related variable is
735 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
736 mouthful.)  If this variable is non-@code{nil}, gnus will ask you in a
737 hierarchical fashion whether to subscribe to new groups or not.  Gnus
738 will ask you for each sub-hierarchy whether you want to descend the
739 hierarchy or not.
740
741 One common mistake is to set the variable a few paragraphs above
742 (@code{gnus-subscribe-newsgroup-method}) to
743 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
744 will not work.  This is ga-ga.  So don't do it.
745
746
747 @node Filtering New Groups
748 @subsection Filtering New Groups
749
750 A nice and portable way to control which new newsgroups should be
751 subscribed (or ignored) is to put an @dfn{options} line at the start of
752 the @file{.newsrc} file.  Here's an example:
753
754 @example
755 options -n !alt.all !rec.all sci.all
756 @end example
757
758 @vindex gnus-subscribe-options-newsgroup-method
759 This line obviously belongs to a serious-minded intellectual scientific
760 person (or she may just be plain old boring), because it says that all
761 groups that have names beginning with @samp{alt} and @samp{rec} should
762 be ignored, and all groups with names beginning with @samp{sci} should
763 be subscribed.  Gnus will not use the normal subscription method for
764 subscribing these groups.
765 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
766 variable defaults to @code{gnus-subscribe-alphabetically}.
767
768 @vindex gnus-options-not-subscribe
769 @vindex gnus-options-subscribe
770 If you don't want to mess with your @file{.newsrc} file, you can just
771 set the two variables @code{gnus-options-subscribe} and
772 @code{gnus-options-not-subscribe}.  These two variables do exactly the
773 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
774 and if the new group matches the former, it will be unconditionally
775 subscribed, and if it matches the latter, it will be ignored.
776
777 @vindex gnus-auto-subscribed-groups
778 Yet another variable that meddles here is
779 @code{gnus-auto-subscribed-groups}.  It works exactly like
780 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
781 thought it would be nice to have two of these.  This variable is more
782 meant for setting some ground rules, while the other variable is used
783 more for user fiddling.  By default this variable makes all new groups
784 that come from mail backends (@code{nnml}, @code{nnbabyl},
785 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
786 don't like that, just set this variable to @code{nil}.
787
788 New groups that match this regexp are subscribed using
789 @code{gnus-subscribe-options-newsgroup-method}.
790
791
792 @node Changing Servers
793 @section Changing Servers
794 @cindex changing servers
795
796 Sometimes it is necessary to move from one @sc{nntp} server to another.
797 This happens very rarely, but perhaps you change jobs, or one server is
798 very flaky and you want to use another.
799
800 Changing the server is pretty easy, right?  You just change
801 @code{gnus-select-method} to point to the new server?
802
803 @emph{Wrong!}
804
805 Article numbers are not (in any way) kept synchronized between different
806 @sc{nntp} servers, and the only way Gnus keeps track of what articles
807 you have read is by keeping track of article numbers.  So when you
808 change @code{gnus-select-method}, your @file{.newsrc} file becomes
809 worthless.
810
811 Gnus provides a few functions to attempt to translate a @file{.newsrc}
812 file from one server to another.  They all have one thing in
813 common---they take a looong time to run.  You don't want to use these
814 functions more than absolutely necessary.
815
816 @kindex M-x gnus-change-server
817 @findex gnus-change-server
818 If you have access to both servers, Gnus can request the headers for all
819 the articles you have read and compare @code{Message-ID}s and map the
820 article numbers of the read articles and article marks.  The @kbd{M-x
821 gnus-change-server} command will do this for all your native groups.  It
822 will prompt for the method you want to move to.
823
824 @kindex M-x gnus-group-move-group-to-server
825 @findex gnus-group-move-group-to-server
826 You can also move individual groups with the @kbd{M-x
827 gnus-group-move-group-to-server} command.  This is useful if you want to
828 move a (foreign) group from one server to another.
829
830 @kindex M-x gnus-group-clear-data-on-native-groups
831 @findex gnus-group-clear-data-on-native-groups
832 If you don't have access to both the old and new server, all your marks
833 and read ranges have become worthless.  You can use the @kbd{M-x
834 gnus-group-clear-data-on-native-groups} command to clear out all data
835 that you have on your native groups.  Use with caution.
836
837 After changing servers, you @strong{must} move the cache hierarchy away,
838 since the cached articles will have wrong article numbers, which will
839 affect which articles Gnus thinks are read.
840
841
842 @node Startup Files
843 @section Startup Files
844 @cindex startup files
845 @cindex .newsrc
846 @cindex .newsrc.el
847 @cindex .newsrc.eld
848
849 Now, you all know about the @file{.newsrc} file.  All subscription
850 information is traditionally stored in this file.
851
852 Things got a bit more complicated with @sc{GNUS}.  In addition to
853 keeping the @file{.newsrc} file updated, it also used a file called
854 @file{.newsrc.el} for storing all the information that didn't fit into
855 the @file{.newsrc} file.  (Actually, it also duplicated everything in
856 the @file{.newsrc} file.)  @sc{GNUS} would read whichever one of these
857 files was the most recently saved, which enabled people to swap between
858 @sc{gnus} and other newsreaders.
859
860 That was kinda silly, so Gnus went one better: In addition to the
861 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
862 @file{.newsrc.eld}.  It will read whichever of these files that are most
863 recent, but it will never write a @file{.newsrc.el} file.  You should
864 never delete the @file{.newsrc.eld} file---it contains much information
865 not stored in the @file{.newsrc} file.
866
867 @vindex gnus-save-newsrc-file
868 You can turn off writing the @file{.newsrc} file by setting
869 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
870 the file and save some space, as well as exiting from gnus faster.
871 However, this will make it impossible to use other newsreaders than
872 gnus.  But hey, who would want to, right?
873
874 @vindex gnus-save-killed-list
875 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
876 will not save the list of killed groups to the startup file.  This will
877 save both time (when starting and quitting) and space (on disk).  It
878 will also mean that Gnus has no record of what groups are new or old,
879 so the automatic new groups subscription methods become meaningless.
880 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
881 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
882 Groups}).  This variable can also be a regular expression.  If that's
883 the case, remove all groups that do not match this regexp before
884 saving.  This can be useful in certain obscure situations that involve
885 several servers where not all servers support @code{ask-server}.
886
887 @vindex gnus-startup-file
888 The @code{gnus-startup-file} variable says where the startup files are.
889 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
890 file being whatever that one is, with a @samp{.eld} appended.
891
892 @vindex gnus-save-newsrc-hook
893 @vindex gnus-save-quick-newsrc-hook
894 @vindex gnus-save-standard-newsrc-hook
895 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
896 files, while @code{gnus-save-quick-newsrc-hook} is called just before
897 saving the @file{.newsrc.eld} file, and
898 @code{gnus-save-standard-newsrc-hook} is called just before saving the
899 @file{.newsrc} file.  The latter two are commonly used to turn version
900 control on or off.  Version control is on by default when saving the
901 startup files.  If you want to turn backup creation off, say something like:
902
903 @lisp
904 (defun turn-off-backup ()
905   (set (make-local-variable 'backup-inhibited) t))
906
907 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
908 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
909 @end lisp
910
911 @vindex gnus-init-file
912 When gnus starts, it will read the @code{gnus-site-init-file}
913 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
914 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
915 and can be used to avoid cluttering your @file{~/.emacs} and
916 @file{site-init} files with gnus stuff.  Gnus will also check for files
917 with the same names as these, but with @file{.elc} and @file{.el}
918 suffixes.  In other words, if you have set @code{gnus-init-file} to
919 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
920 and finally @file{~/.gnus} (in this order).
921
922
923
924 @node Auto Save
925 @section Auto Save
926 @cindex dribble file
927 @cindex auto-save
928
929 Whenever you do something that changes the gnus data (reading articles,
930 catching up, killing/subscribing groups), the change is added to a
931 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
932 Emacs way.  If your Emacs should crash before you have saved the
933 @file{.newsrc} files, all changes you have made can be recovered from
934 this file.
935
936 If gnus detects this file at startup, it will ask the user whether to
937 read it.  The auto save file is deleted whenever the real startup file is
938 saved.
939
940 @vindex gnus-use-dribble-file
941 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
942 maintain a dribble buffer.  The default is @code{t}.
943
944 @vindex gnus-dribble-directory
945 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
946 this variable is @code{nil}, which it is by default, gnus will dribble
947 into the directory where the @file{.newsrc} file is located.  (This is
948 normally the user's home directory.)  The dribble file will get the same
949 file permissions as the @code{.newsrc} file.
950
951 @vindex gnus-always-read-dribble-file
952 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
953 read the dribble file on startup without querying the user.
954
955
956 @node The Active File
957 @section The Active File
958 @cindex active file
959 @cindex ignored groups
960
961 When gnus starts, or indeed whenever it tries to determine whether new
962 articles have arrived, it reads the active file.  This is a very large
963 file that lists all the active groups and articles on the server.
964
965 @vindex gnus-ignored-newsgroups
966 Before examining the active file, gnus deletes all lines that match the
967 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
968 any groups with bogus names, but you can use this variable to make gnus
969 ignore hierarchies you aren't ever interested in.  However, this is not
970 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
971 Groups} for an overview of other variables that can be used instead.
972
973 @c This variable is
974 @c @code{nil} by default, and will slow down active file handling somewhat
975 @c if you set it to anything else.
976
977 @vindex gnus-read-active-file
978 @c @head
979 The active file can be rather Huge, so if you have a slow network, you
980 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
981 reading the active file.  This variable is @code{some} by default.
982
983 Gnus will try to make do by getting information just on the groups that
984 you actually subscribe to.
985
986 Note that if you subscribe to lots and lots of groups, setting this
987 variable to @code{nil} will probably make gnus slower, not faster.  At
988 present, having this variable @code{nil} will slow gnus down
989 considerably, unless you read news over a 2400 baud modem.
990
991 This variable can also have the value @code{some}.  Gnus will then
992 attempt to read active info only on the subscribed groups.  On some
993 servers this is quite fast (on sparkling, brand new INN servers that
994 support the @code{LIST ACTIVE group} command), on others this isn't fast
995 at all.  In any case, @code{some} should be faster than @code{nil}, and
996 is certainly faster than @code{t} over slow lines.
997
998 If this variable is @code{nil}, gnus will ask for group info in total
999 lock-step, which isn't very fast.  If it is @code{some} and you use an
1000 @sc{nntp} server, gnus will pump out commands as fast as it can, and
1001 read all the replies in one swoop.  This will normally result in better
1002 performance, but if the server does not support the aforementioned
1003 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1004
1005 In any case, if you use @code{some} or @code{nil}, you should definitely
1006 kill all groups that you aren't interested in to speed things up.
1007
1008 Note that this variable also affects active file retrieval from
1009 secondary select methods.
1010
1011
1012 @node Startup Variables
1013 @section Startup Variables
1014
1015 @table @code
1016
1017 @item gnus-load-hook
1018 @vindex gnus-load-hook
1019 A hook run while gnus is being loaded.  Note that this hook will
1020 normally be run just once in each Emacs session, no matter how many
1021 times you start gnus.
1022
1023 @item gnus-before-startup-hook
1024 @vindex gnus-before-startup-hook
1025 A hook run after starting up gnus successfully.
1026
1027 @item gnus-startup-hook
1028 @vindex gnus-startup-hook
1029 A hook run as the very last thing after starting up gnus
1030
1031 @item gnus-started-hook
1032 @vindex gnus-started-hook
1033 A hook that is run as the very last thing after starting up gnus
1034 successfully.
1035
1036 @item gnus-started-hook
1037 @vindex gnus-started-hook
1038 A hook that is run after reading the @file{.newsrc} file(s), but before
1039 generating the group buffer.
1040
1041 @item gnus-check-bogus-newsgroups
1042 @vindex gnus-check-bogus-newsgroups
1043 If non-@code{nil}, gnus will check for and delete all bogus groups at
1044 startup.  A @dfn{bogus group} is a group that you have in your
1045 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1046 bogus groups can take quite a while, so to save time and resources it's
1047 best to leave this option off, and do the checking for bogus groups once
1048 in a while from the group buffer instead (@pxref{Group Maintenance}).
1049
1050 @item gnus-inhibit-startup-message
1051 @vindex gnus-inhibit-startup-message
1052 If non-@code{nil}, the startup message won't be displayed.  That way,
1053 your boss might not notice as easily that you are reading news instead
1054 of doing your job.  Note that this variable is used before
1055 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1056
1057 @item gnus-no-groups-message
1058 @vindex gnus-no-groups-message
1059 Message displayed by gnus when no groups are available.
1060
1061 @item gnus-play-startup-jingle
1062 @vindex gnus-play-startup-jingle
1063 If non-@code{nil}, play the gnus jingle at startup.
1064
1065 @item gnus-startup-jingle
1066 @vindex gnus-startup-jingle
1067 Jingle to be played if the above variable is non-@code{nil}.  The
1068 default is @samp{Tuxedomoon.Jingle4.au}.
1069
1070 @end table
1071
1072
1073 @node The Group Buffer
1074 @chapter The Group Buffer
1075 @cindex group buffer
1076
1077 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1078 is the first buffer shown when gnus starts, and will never be killed as
1079 long as gnus is active.
1080
1081 @iftex
1082 @iflatex
1083 \gnusfigure{The Group Buffer}{320}{
1084 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1085 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1086 \put(120,38){\vector(1,2){10}}
1087 \put(40,60){\makebox(0,0)[r]{Mode line}}
1088 \put(40,58){\vector(1,0){30}}
1089 \put(200,28){\makebox(0,0)[t]{Native select method}}
1090 \put(200,26){\vector(-1,2){15}}
1091 }
1092 @end iflatex
1093 @end iftex
1094
1095 @menu
1096 * Group Buffer Format::    Information listed and how you can change it.
1097 * Group Maneuvering::      Commands for moving in the group buffer.
1098 * Selecting a Group::      Actually reading news.
1099 * Group Data::             Changing the info for a group.
1100 * Subscription Commands::  Unsubscribing, killing, subscribing.
1101 * Group Levels::           Levels? What are those, then?
1102 * Group Score::            A mechanism for finding out what groups you like.
1103 * Marking Groups::         You can mark groups for later processing.
1104 * Foreign Groups::         Creating and editing groups.
1105 * Group Parameters::       Each group may have different parameters set.
1106 * Listing Groups::         Gnus can list various subsets of the groups.
1107 * Sorting Groups::         Re-arrange the group order.
1108 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1109 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1110 * Exiting Gnus::           Stop reading news and get some work done.
1111 * Group Topics::           A folding group mode divided into topics.
1112 * Misc Group Stuff::       Other stuff that you can to do.
1113 @end menu
1114
1115
1116 @node Group Buffer Format
1117 @section Group Buffer Format
1118
1119 @menu
1120 * Group Line Specification::       Deciding how the group buffer is to look.
1121 * Group Modeline Specification::   The group buffer modeline.
1122 * Group Highlighting::             Having nice colors in the group buffer.
1123 @end menu
1124
1125
1126 @node Group Line Specification
1127 @subsection Group Line Specification
1128 @cindex group buffer format
1129
1130 The default format of the group buffer is nice and dull, but you can
1131 make it as exciting and ugly as you feel like.
1132
1133 Here's a couple of example group lines:
1134
1135 @example
1136      25: news.announce.newusers
1137  *    0: alt.fan.andrea-dworkin
1138 @end example
1139
1140 Quite simple, huh?
1141
1142 You can see that there are 25 unread articles in
1143 @samp{news.announce.newusers}.  There are no unread articles, but some
1144 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1145 asterisk at the beginning of the line?).
1146
1147 @vindex gnus-group-line-format
1148 You can change that format to whatever you want by fiddling with the
1149 @code{gnus-group-line-format} variable.  This variable works along the
1150 lines of a @code{format} specification, which is pretty much the same as
1151 a @code{printf} specifications, for those of you who use (feh!) C.
1152 @xref{Formatting Variables}.
1153
1154 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1155
1156 There should always be a colon on the line; the cursor always moves to
1157 the colon after performing an operation.  Nothing else is required---not
1158 even the group name.  All displayed text is just window dressing, and is
1159 never examined by gnus.  Gnus stores all real information it needs using
1160 text properties.
1161
1162 (Note that if you make a really strange, wonderful, spreadsheet-like
1163 layout, everybody will believe you are hard at work with the accounting
1164 instead of wasting time reading news.)
1165
1166 Here's a list of all available format characters:
1167
1168 @table @samp
1169
1170 @item M
1171 An asterisk if the group only has marked articles.
1172
1173 @item S
1174 Whether the group is subscribed.
1175
1176 @item L
1177 Level of subscribedness.
1178
1179 @item N
1180 Number of unread articles.
1181
1182 @item I
1183 Number of dormant articles.
1184
1185 @item T
1186 Number of ticked articles.
1187
1188 @item R
1189 Number of read articles.
1190
1191 @item t
1192 Estimated total number of articles.  (This is really @var{max-number}
1193 minus @var{min-number} plus 1.)
1194
1195 @item y
1196 Number of unread, unticked, non-dormant articles.
1197
1198 @item i
1199 Number of ticked and dormant articles.
1200
1201 @item g
1202 Full group name.
1203
1204 @item G
1205 Group name.
1206
1207 @item D
1208 Newsgroup description.
1209
1210 @item o
1211 @samp{m} if moderated.
1212
1213 @item O
1214 @samp{(m)} if moderated.
1215
1216 @item s
1217 Select method.
1218
1219 @item n
1220 Select from where.
1221
1222 @item z
1223 A string that looks like @samp{<%s:%n>} if a foreign select method is
1224 used.
1225
1226 @item P
1227 Indentation based on the level of the topic (@pxref{Group Topics}).
1228
1229 @item c
1230 @vindex gnus-group-uncollapsed-levels
1231 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1232 variable says how many levels to leave at the end of the group name.
1233 The default is 1---this will mean that group names like
1234 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1235
1236 @item m
1237 @vindex gnus-new-mail-mark
1238 @cindex %
1239 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1240 the group lately.
1241
1242 @item d
1243 A string that says when you last read the group (@pxref{Group
1244 Timestamp}).
1245
1246 @item u
1247 User defined specifier.  The next character in the format string should
1248 be a letter.  Gnus will call the function
1249 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1250 following @samp{%u}.  The function will be passed a single dummy
1251 parameter as argument.  The function should return a string, which will
1252 be inserted into the buffer just like information from any other
1253 specifier.
1254 @end table
1255
1256 @cindex *
1257 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1258 if no info is available---for instance, if it is a non-activated foreign
1259 group, or a bogus native group.
1260
1261
1262 @node Group Modeline Specification
1263 @subsection Group Modeline Specification
1264 @cindex group modeline
1265
1266 @vindex gnus-group-mode-line-format
1267 The mode line can be changed by setting
1268 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1269 doesn't understand that many format specifiers:
1270
1271 @table @samp
1272 @item S
1273 The native news server.
1274 @item M
1275 The native select method.
1276 @end table
1277
1278
1279 @node Group Highlighting
1280 @subsection Group Highlighting
1281 @cindex highlighting
1282 @cindex group highlighting
1283
1284 @vindex gnus-group-highlight
1285 Highlighting in the group buffer is controlled by the
1286 @code{gnus-group-highlight} variable.  This is an alist with elements
1287 that look like @var{(form . face)}.  If @var{form} evaluates to
1288 something non-@code{nil}, the @var{face} will be used on the line.
1289
1290 Here's an example value for this variable that might look nice if the
1291 background is dark:
1292
1293 @lisp
1294 (face-spec-set 'my-group-face-1
1295                '((t (:foreground "Red" :bold t))))
1296 (face-spec-set 'my-group-face-2
1297                '((t (:foreground "SeaGreen" :bold t))))
1298 (face-spec-set 'my-group-face-3
1299                '((t (:foreground "SpringGreen" :bold t))))
1300 (face-spec-set 'my-group-face-4
1301                '((t (:foreground "SteelBlue" :bold t))))
1302 (face-spec-set 'my-group-face-5
1303                '((t (:foreground "SkyBlue" :bold t))))
1304
1305 (setq gnus-group-highlight
1306       '(((> unread 200) . my-group-face-1)
1307         ((and (< level 3) (zerop unread)) . my-group-face-2)
1308         ((< level 3) . my-group-face-3)
1309         ((zerop unread) . my-group-face-4)
1310         (t . my-group-face-5)))
1311 @end lisp
1312
1313 Also @pxref{Faces and Fonts}.
1314
1315 Variables that are dynamically bound when the forms are evaluated
1316 include:
1317
1318 @table @code
1319 @item group
1320 The group name.
1321 @item unread
1322 The number of unread articles in the group.
1323 @item method
1324 The select method.
1325 @item mailp
1326 Whether the group is a mail group.
1327 @item level
1328 The level of the group.
1329 @item score
1330 The score of the group.
1331 @item ticked
1332 The number of ticked articles in the group.
1333 @item total
1334 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1335 MIN-NUMBER plus one.
1336 @item topic
1337 When using the topic minor mode, this variable is bound to the current
1338 topic being inserted.
1339 @end table
1340
1341 When the forms are @code{eval}ed, point is at the beginning of the line
1342 of the group in question, so you can use many of the normal gnus
1343 functions for snarfing info on the group.
1344
1345 @vindex gnus-group-update-hook
1346 @findex gnus-group-highlight-line
1347 @code{gnus-group-update-hook} is called when a group line is changed.
1348 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1349 calls @code{gnus-group-highlight-line} by default.
1350
1351
1352 @node Group Maneuvering
1353 @section Group Maneuvering
1354 @cindex group movement
1355
1356 All movement commands understand the numeric prefix and will behave as
1357 expected, hopefully.
1358
1359 @table @kbd
1360
1361 @item n
1362 @kindex n (Group)
1363 @findex gnus-group-next-unread-group
1364 Go to the next group that has unread articles
1365 (@code{gnus-group-next-unread-group}).
1366
1367 @item p
1368 @itemx DEL
1369 @kindex DEL (Group)
1370 @kindex p (Group)
1371 @findex gnus-group-prev-unread-group
1372 Go to the previous group that has unread articles
1373 (@code{gnus-group-prev-unread-group}).
1374
1375 @item N
1376 @kindex N (Group)
1377 @findex gnus-group-next-group
1378 Go to the next group (@code{gnus-group-next-group}).
1379
1380 @item P
1381 @kindex P (Group)
1382 @findex gnus-group-prev-group
1383 Go to the previous group (@code{gnus-group-prev-group}).
1384
1385 @item M-n
1386 @kindex M-n (Group)
1387 @findex gnus-group-next-unread-group-same-level
1388 Go to the next unread group on the same (or lower) level
1389 (@code{gnus-group-next-unread-group-same-level}).
1390
1391 @item M-p
1392 @kindex M-p (Group)
1393 @findex gnus-group-prev-unread-group-same-level
1394 Go to the previous unread group on the same (or lower) level
1395 (@code{gnus-group-prev-unread-group-same-level}).
1396 @end table
1397
1398 Three commands for jumping to groups:
1399
1400 @table @kbd
1401
1402 @item j
1403 @kindex j (Group)
1404 @findex gnus-group-jump-to-group
1405 Jump to a group (and make it visible if it isn't already)
1406 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1407 like living groups.
1408
1409 @item ,
1410 @kindex , (Group)
1411 @findex gnus-group-best-unread-group
1412 Jump to the unread group with the lowest level
1413 (@code{gnus-group-best-unread-group}).
1414
1415 @item .
1416 @kindex . (Group)
1417 @findex gnus-group-first-unread-group
1418 Jump to the first group with unread articles
1419 (@code{gnus-group-first-unread-group}).
1420 @end table
1421
1422 @vindex gnus-group-goto-unread
1423 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1424 commands will move to the next group, not the next unread group.  Even
1425 the commands that say they move to the next unread group.  The default
1426 is @code{t}.
1427
1428
1429 @node Selecting a Group
1430 @section Selecting a Group
1431 @cindex group selection
1432
1433 @table @kbd
1434
1435 @item SPACE
1436 @kindex SPACE (Group)
1437 @findex gnus-group-read-group
1438 Select the current group, switch to the summary buffer and display the
1439 first unread article (@code{gnus-group-read-group}).  If there are no
1440 unread articles in the group, or if you give a non-numerical prefix to
1441 this command, gnus will offer to fetch all the old articles in this
1442 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1443 determines the number of articles gnus will fetch.  If @var{N} is
1444 positive, gnus fetches the @var{N} newest articles, if @var{N} is
1445 negative, gnus fetches the @var{abs(N)} oldest articles.
1446
1447 @item RET
1448 @kindex RET (Group)
1449 @findex gnus-group-select-group
1450 Select the current group and switch to the summary buffer
1451 (@code{gnus-group-select-group}).  Takes the same arguments as
1452 @code{gnus-group-read-group}---the only difference is that this command
1453 does not display the first unread article automatically upon group
1454 entry.
1455
1456 @item M-RET
1457 @kindex M-RET (Group)
1458 @findex gnus-group-quick-select-group
1459 This does the same as the command above, but tries to do it with the
1460 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1461 scoring/killing will be performed, there will be no highlights and no
1462 expunging.  This might be useful if you're in a real hurry and have to
1463 enter some humongous group.  If you give a 0 prefix to this command
1464 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
1465 which is useful if you want to toggle threading before generating the
1466 summary buffer (@pxref{Summary Generation Commands}).
1467
1468 @item M-SPACE
1469 @kindex M-SPACE (Group)
1470 @findex gnus-group-visible-select-group
1471 This is yet one more command that does the same as the @kbd{RET}
1472 command, but this one does it without expunging and hiding dormants
1473 (@code{gnus-group-visible-select-group}).
1474
1475 @item M-C-RET
1476 @kindex M-C-RET (Group)
1477 @findex gnus-group-select-group-ephemerally
1478 Finally, this command selects the current group ephemerally without
1479 doing any processing of its contents
1480 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1481 turned off.  Everything you do in the group after selecting it in this
1482 manner will have no permanent effects.
1483
1484 @end table
1485
1486 @vindex gnus-large-newsgroup
1487 The @code{gnus-large-newsgroup} variable says what gnus should consider
1488 to be a big group.  This is 200 by default.  If the group has more
1489 (unread and/or ticked) articles than this, gnus will query the user
1490 before entering the group.  The user can then specify how many articles
1491 should be fetched from the server.  If the user specifies a negative
1492 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1493 is positive, the @code{n} articles that have arrived most recently will
1494 be fetched.
1495
1496 @vindex gnus-select-group-hook
1497 @vindex gnus-auto-select-first
1498 @code{gnus-auto-select-first} control whether any articles are selected
1499 automatically when entering a group with the @kbd{SPACE} command.
1500
1501 @table @code
1502
1503 @item nil
1504 Don't select any articles when entering the group.  Just display the
1505 full summary buffer.
1506
1507 @item t
1508 Select the first unread article when entering the group.
1509
1510 @item best
1511 Select the highest scored article in the group when entering the
1512 group.
1513
1514 @end table
1515
1516 This variable can also be a function.  In that case, that function will
1517 be called to place point on a subject line, and/or select some article.
1518 Useful functions include:
1519
1520 @table @code
1521 @item gnus-summary-first-unread-subject
1522 Place point on the subject line of the first unread article, but
1523 don't select the article.
1524
1525 @item gnus-summary-first-unread-article
1526 Select the first unread article.
1527
1528 @item gnus-summary-best-unread-article
1529 Select the highest-scored unread article.
1530 @end table
1531
1532
1533 If you want to prevent automatic selection in some group (say, in a
1534 binary group with Huge articles) you can set this variable to @code{nil}
1535 in @code{gnus-select-group-hook}, which is called when a group is
1536 selected.
1537
1538
1539 @node Subscription Commands
1540 @section Subscription Commands
1541 @cindex subscription
1542
1543 @table @kbd
1544
1545 @item S t
1546 @itemx u
1547 @kindex S t (Group)
1548 @kindex u (Group)
1549 @findex gnus-group-unsubscribe-current-group
1550 @c @icon{gnus-group-unsubscribe}
1551 Toggle subscription to the current group
1552 (@code{gnus-group-unsubscribe-current-group}).
1553
1554 @item S s
1555 @itemx U
1556 @kindex S s (Group)
1557 @kindex U (Group)
1558 @findex gnus-group-unsubscribe-group
1559 Prompt for a group to subscribe, and then subscribe it.  If it was
1560 subscribed already, unsubscribe it instead
1561 (@code{gnus-group-unsubscribe-group}).
1562
1563 @item S k
1564 @itemx C-k
1565 @kindex S k (Group)
1566 @kindex C-k (Group)
1567 @findex gnus-group-kill-group
1568 @c @icon{gnus-group-kill-group}
1569 Kill the current group (@code{gnus-group-kill-group}).
1570
1571 @item S y
1572 @itemx C-y
1573 @kindex S y (Group)
1574 @kindex C-y (Group)
1575 @findex gnus-group-yank-group
1576 Yank the last killed group (@code{gnus-group-yank-group}).
1577
1578 @item C-x C-t
1579 @kindex C-x C-t (Group)
1580 @findex gnus-group-transpose-groups
1581 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1582 really a subscription command, but you can use it instead of a
1583 kill-and-yank sequence sometimes.
1584
1585 @item S w
1586 @itemx C-w
1587 @kindex S w (Group)
1588 @kindex C-w (Group)
1589 @findex gnus-group-kill-region
1590 Kill all groups in the region (@code{gnus-group-kill-region}).
1591
1592 @item S z
1593 @kindex S z (Group)
1594 @findex gnus-group-kill-all-zombies
1595 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1596
1597 @item S C-k
1598 @kindex S C-k (Group)
1599 @findex gnus-group-kill-level
1600 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1601 These groups can't be yanked back after killing, so this command should
1602 be used with some caution.  The only time where this command comes in
1603 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1604 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1605 kill off all unsubscribed groups that do not have message numbers in the
1606 @file{.newsrc} file.
1607
1608 @end table
1609
1610 Also @pxref{Group Levels}.
1611
1612
1613 @node Group Data
1614 @section Group Data
1615
1616 @table @kbd
1617
1618 @item c
1619 @kindex c (Group)
1620 @findex gnus-group-catchup-current
1621 @vindex gnus-group-catchup-group-hook
1622 @c @icon{gnus-group-catchup-current}
1623 Mark all unticked articles in this group as read
1624 (@code{gnus-group-catchup-current}).
1625 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1626 the group buffer.
1627
1628 @item C
1629 @kindex C (Group)
1630 @findex gnus-group-catchup-current-all
1631 Mark all articles in this group, even the ticked ones, as read
1632 (@code{gnus-group-catchup-current-all}).
1633
1634 @item M-c
1635 @kindex M-c (Group)
1636 @findex gnus-group-clear-data
1637 Clear the data from the current group---nix out marks and the list of
1638 read articles (@code{gnus-group-clear-data}).
1639
1640 @item M-x gnus-group-clear-data-on-native-groups
1641 @kindex M-x gnus-group-clear-data-on-native-groups
1642 @findex gnus-group-clear-data-on-native-groups
1643 If you have switched from one @sc{nntp} server to another, all your marks
1644 and read ranges have become worthless.  You can use this command to
1645 clear out all data that you have on your native groups.  Use with
1646 caution.
1647
1648 @end table
1649
1650
1651 @node Group Levels
1652 @section Group Levels
1653 @cindex group level
1654 @cindex level
1655
1656 All groups have a level of @dfn{subscribedness}.  For instance, if a
1657 group is on level 2, it is more subscribed than a group on level 5.  You
1658 can ask gnus to just list groups on a given level or lower
1659 (@pxref{Listing Groups}), or to just check for new articles in groups on
1660 a given level or lower (@pxref{Scanning New Messages}).
1661
1662 Remember:  The higher the level of the group, the less important it is.
1663
1664 @table @kbd
1665
1666 @item S l
1667 @kindex S l (Group)
1668 @findex gnus-group-set-current-level
1669 Set the level of the current group.  If a numeric prefix is given, the
1670 next @var{n} groups will have their levels set.  The user will be
1671 prompted for a level.
1672 @end table
1673
1674 @vindex gnus-level-killed
1675 @vindex gnus-level-zombie
1676 @vindex gnus-level-unsubscribed
1677 @vindex gnus-level-subscribed
1678 Gnus considers groups from levels 1 to
1679 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1680 @code{gnus-level-subscribed} (exclusive) and
1681 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1682 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1683 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1684 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1685 same, but zombie and killed groups have no information on what articles
1686 you have read, etc, stored.  This distinction between dead and living
1687 groups isn't done because it is nice or clever, it is done purely for
1688 reasons of efficiency.
1689
1690 It is recommended that you keep all your mail groups (if any) on quite
1691 low levels (e.g. 1 or 2).
1692
1693 If you want to play with the level variables, you should show some care.
1694 Set them once, and don't touch them ever again.  Better yet, don't touch
1695 them at all unless you know exactly what you're doing.
1696
1697 @vindex gnus-level-default-unsubscribed
1698 @vindex gnus-level-default-subscribed
1699 Two closely related variables are @code{gnus-level-default-subscribed}
1700 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1701 which are the levels that new groups will be put on if they are
1702 (un)subscribed.  These two variables should, of course, be inside the
1703 relevant valid ranges.
1704
1705 @vindex gnus-keep-same-level
1706 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1707 will only move to groups of the same level (or lower).  In
1708 particular, going from the last article in one group to the next group
1709 will go to the next group of the same level (or lower).  This might be
1710 handy if you want to read the most important groups before you read the
1711 rest.
1712
1713 @vindex gnus-group-default-list-level
1714 All groups with a level less than or equal to
1715 @code{gnus-group-default-list-level} will be listed in the group buffer
1716 by default.
1717
1718 @vindex gnus-group-list-inactive-groups
1719 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1720 groups will be listed along with the unread groups.  This variable is
1721 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1722 listed.
1723
1724 @vindex gnus-group-use-permanent-levels
1725 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1726 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1727 use this level as the ``work'' level.
1728
1729 @vindex gnus-activate-level
1730 Gnus will normally just activate (i. e., query the server about) groups
1731 on level @code{gnus-activate-level} or less.  If you don't want to
1732 activate unsubscribed groups, for instance, you might set this variable
1733 to 5.  The default is 6.
1734
1735
1736 @node Group Score
1737 @section Group Score
1738 @cindex group score
1739 @cindex group rank
1740 @cindex rank
1741
1742 You would normally keep important groups on high levels, but that scheme
1743 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1744 group buffer according to how often you read groups, perhaps?  Within
1745 reason?
1746
1747 This is what @dfn{group score} is for.  You can assign a score to each
1748 group.  You can then sort the group buffer based on this score.
1749 Alternatively, you can sort on score and then level.  (Taken together,
1750 the level and the score is called the @dfn{rank} of the group.  A group
1751 that is on level 4 and has a score of 1 has a higher rank than a group
1752 on level 5 that has a score of 300.  (The level is the most significant
1753 part and the score is the least significant part.))
1754
1755 @findex gnus-summary-bubble-group
1756 If you want groups you read often to get higher scores than groups you
1757 read seldom you can add the @code{gnus-summary-bubble-group} function to
1758 the @code{gnus-summary-exit-hook} hook.  This will result (after
1759 sorting) in a bubbling sort of action.  If you want to see that in
1760 action after each summary exit, you can add
1761 @code{gnus-group-sort-groups-by-rank} or
1762 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1763 slow things down somewhat.
1764
1765
1766 @node Marking Groups
1767 @section Marking Groups
1768 @cindex marking groups
1769
1770 If you want to perform some command on several groups, and they appear
1771 subsequently in the group buffer, you would normally just give a
1772 numerical prefix to the command.  Most group commands will then do your
1773 bidding on those groups.
1774
1775 However, if the groups are not in sequential order, you can still
1776 perform a command on several groups.  You simply mark the groups first
1777 with the process mark and then execute the command.
1778
1779 @table @kbd
1780
1781 @item #
1782 @kindex # (Group)
1783 @itemx M m
1784 @kindex M m (Group)
1785 @findex gnus-group-mark-group
1786 Set the mark on the current group (@code{gnus-group-mark-group}).
1787
1788 @item M-#
1789 @kindex M-# (Group)
1790 @itemx M u
1791 @kindex M u (Group)
1792 @findex gnus-group-unmark-group
1793 Remove the mark from the current group
1794 (@code{gnus-group-unmark-group}).
1795
1796 @item M U
1797 @kindex M U (Group)
1798 @findex gnus-group-unmark-all-groups
1799 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1800
1801 @item M w
1802 @kindex M w (Group)
1803 @findex gnus-group-mark-region
1804 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1805
1806 @item M b
1807 @kindex M b (Group)
1808 @findex gnus-group-mark-buffer
1809 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1810
1811 @item M r
1812 @kindex M r (Group)
1813 @findex gnus-group-mark-regexp
1814 Mark all groups that match some regular expression
1815 (@code{gnus-group-mark-regexp}).
1816 @end table
1817
1818 Also @pxref{Process/Prefix}.
1819
1820 @findex gnus-group-universal-argument
1821 If you want to execute some command on all groups that have been marked
1822 with the process mark, you can use the @kbd{M-&}
1823 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1824 the command to be executed.
1825
1826
1827 @node Foreign Groups
1828 @section Foreign Groups
1829 @cindex foreign groups
1830
1831 Below are some group mode commands for making and editing general foreign
1832 groups, as well as commands to ease the creation of a few
1833 special-purpose groups.  All these commands insert the newly created
1834 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1835 consulted.
1836
1837 @table @kbd
1838
1839 @item G m
1840 @kindex G m (Group)
1841 @findex gnus-group-make-group
1842 @cindex making groups
1843 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1844 for a name, a method and possibly an @dfn{address}.  For an easier way
1845 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1846
1847 @item G r
1848 @kindex G r (Group)
1849 @findex gnus-group-rename-group
1850 @cindex renaming groups
1851 Rename the current group to something else
1852 (@code{gnus-group-rename-group}).  This is valid only on some
1853 groups---mail groups mostly.  This command might very well be quite slow
1854 on some backends.
1855
1856 @item G c
1857 @kindex G c (Group)
1858 @cindex customizing
1859 @findex gnus-group-customize
1860 Customize the group parameters (@code{gnus-group-customize}).
1861
1862 @item G e
1863 @kindex G e (Group)
1864 @findex gnus-group-edit-group-method
1865 @cindex renaming groups
1866 Enter a buffer where you can edit the select method of the current
1867 group (@code{gnus-group-edit-group-method}).
1868
1869 @item G p
1870 @kindex G p (Group)
1871 @findex gnus-group-edit-group-parameters
1872 Enter a buffer where you can edit the group parameters
1873 (@code{gnus-group-edit-group-parameters}).
1874
1875 @item G E
1876 @kindex G E (Group)
1877 @findex gnus-group-edit-group
1878 Enter a buffer where you can edit the group info
1879 (@code{gnus-group-edit-group}).
1880
1881 @item G d
1882 @kindex G d (Group)
1883 @findex gnus-group-make-directory-group
1884 @cindex nndir
1885 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1886 for a directory name (@code{gnus-group-make-directory-group}).
1887
1888 @item G h
1889 @kindex G h (Group)
1890 @cindex help group
1891 @findex gnus-group-make-help-group
1892 Make the gnus help group (@code{gnus-group-make-help-group}).
1893
1894 @item G a
1895 @kindex G a (Group)
1896 @cindex (ding) archive
1897 @cindex archive group
1898 @findex gnus-group-make-archive-group
1899 @vindex gnus-group-archive-directory
1900 @vindex gnus-group-recent-archive-directory
1901 Make a gnus archive group (@code{gnus-group-make-archive-group}).  By
1902 default a group pointing to the most recent articles will be created
1903 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1904 group will be created from @code{gnus-group-archive-directory}.
1905
1906 @item G k
1907 @kindex G k (Group)
1908 @findex gnus-group-make-kiboze-group
1909 @cindex nnkiboze
1910 Make a kiboze group.  You will be prompted for a name, for a regexp to
1911 match groups to be ``included'' in the kiboze group, and a series of
1912 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1913 @xref{Kibozed Groups}.
1914
1915 @item G D
1916 @kindex G D (Group)
1917 @findex gnus-group-enter-directory
1918 @cindex nneething
1919 Read an arbitrary directory as if it were a newsgroup with the
1920 @code{nneething} backend (@code{gnus-group-enter-directory}).
1921 @xref{Anything Groups}.
1922
1923 @item G f
1924 @kindex G f (Group)
1925 @findex gnus-group-make-doc-group
1926 @cindex ClariNet Briefs
1927 @cindex nndoc
1928 Make a group based on some file or other
1929 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1930 command, you will be prompted for a file name and a file type.
1931 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1932 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1933 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1934 this command without a prefix, gnus will guess at the file type.
1935 @xref{Document Groups}.
1936
1937 @item G u
1938 @kindex G u (Group)
1939 @vindex gnus-useful-groups
1940 @findex gnus-group-make-useful-group
1941 Create one of the groups mentioned in @code{gnus-useful-groups}
1942 (@code{gnus-group-make-useful-group}).
1943
1944 @item G w
1945 @kindex G w (Group)
1946 @findex gnus-group-make-web-group
1947 @cindex DejaNews
1948 @cindex Alta Vista
1949 @cindex InReference
1950 @cindex nnweb
1951 Make an ephemeral group based on a web search
1952 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1953 command, make a solid group instead.  You will be prompted for the
1954 search engine type and the search string.  Valid search engine types
1955 include @code{dejanews}, @code{altavista} and @code{reference}.
1956 @xref{Web Searches}.
1957
1958 If you use the @code{dejanews} search engine, you can limit the search
1959 to a particular group by using a match string like
1960 @samp{~g alt.sysadmin.recovery shaving}.
1961
1962 @item G DEL
1963 @kindex G DEL (Group)
1964 @findex gnus-group-delete-group
1965 This function will delete the current group
1966 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1967 actually delete all the articles in the group, and forcibly remove the
1968 group itself from the face of the Earth.  Use a prefix only if you are
1969 absolutely sure of what you are doing.  This command can't be used on
1970 read-only groups (like @code{nntp} group), though.
1971
1972 @item G V
1973 @kindex G V (Group)
1974 @findex gnus-group-make-empty-virtual
1975 Make a new, fresh, empty @code{nnvirtual} group
1976 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1977
1978 @item G v
1979 @kindex G v (Group)
1980 @findex gnus-group-add-to-virtual
1981 Add the current group to an @code{nnvirtual} group
1982 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1983 @end table
1984
1985 @xref{Select Methods} for more information on the various select
1986 methods.
1987
1988 @vindex gnus-activate-foreign-newsgroups
1989 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1990 gnus will check all foreign groups with this level or lower at startup.
1991 This might take quite a while, especially if you subscribe to lots of
1992 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
1993 @code{gnus-activate-level} also affects activation of foreign
1994 newsgroups.
1995
1996
1997 @node Group Parameters
1998 @section Group Parameters
1999 @cindex group parameters
2000
2001 The group parameters store information local to a particular group.
2002 Here's an example group parameter list:
2003
2004 @example
2005 ((to-address . "ding@@gnus.org")
2006  (auto-expire . t))
2007 @end example
2008
2009 We see that each element consists of a "dotted pair"---the thing before
2010 the dot is the key, while the thing after the dot is the value.  All the
2011 parameters have this form @emph{except} local variable specs, which are
2012 not dotted pairs, but proper lists.
2013
2014 The following group parameters can be used:
2015
2016 @table @code
2017 @item to-address
2018 @cindex to-address
2019 Address used by when doing followups and new posts.
2020
2021 @example
2022 (to-address .  "some@@where.com")
2023 @end example
2024
2025 This is primarily useful in mail groups that represent closed mailing
2026 lists---mailing lists where it's expected that everybody that writes to
2027 the mailing list is subscribed to it.  Since using this parameter
2028 ensures that the mail only goes to the mailing list itself, it means
2029 that members won't receive two copies of your followups.
2030
2031 Using @code{to-address} will actually work whether the group is foreign
2032 or not.  Let's say there's a group on the server that is called
2033 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2034 the articles from a mail-to-news gateway.  Posting directly to this
2035 group is therefore impossible---you have to send mail to the mailing
2036 list address instead.
2037
2038 @item to-list
2039 @cindex to-list
2040 Address used when doing a @kbd{a} in that group.
2041
2042 @example
2043 (to-list . "some@@where.com")
2044 @end example
2045
2046 It is totally ignored
2047 when doing a followup---except that if it is present in a news group,
2048 you'll get mail group semantics when doing @kbd{f}.
2049
2050 If you do an @kbd{a} command in a mail group and you have neither a
2051 @code{to-list} group parameter nor a @code{to-address} group parameter,
2052 then a @code{to-list} group parameter will be added automatically upon
2053 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2054 @vindex gnus-add-to-list
2055
2056 If you do an @kbd{a} command in a mail group and you don't have a
2057 @code{to-list} group parameter, one will be added automatically upon
2058 sending the message.
2059
2060 @item visible
2061 @cindex visible
2062 If the group parameter list has the element @code{(visible . t)},
2063 that group will always be visible in the Group buffer, regardless
2064 of whether it has any unread articles.
2065
2066 @item broken-reply-to
2067 @cindex broken-reply-to
2068 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2069 headers in this group are to be ignored.  This can be useful if you're
2070 reading a mailing list group where the listserv has inserted
2071 @code{Reply-To} headers that point back to the listserv itself.  This is
2072 broken behavior.  So there!
2073
2074 @item to-group
2075 @cindex to-group
2076 Elements like @code{(to-group . "some.group.name")} means that all
2077 posts in that group will be sent to @code{some.group.name}.
2078
2079 @item newsgroup
2080 @cindex newsgroup
2081 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2082 will treat all responses as if they were responses to news articles.
2083 This can be useful if you have a mail group that's really a mirror of a
2084 news group.
2085
2086 @item gcc-self
2087 @cindex gcc-self
2088 If @code{(gcc-self . t)} is present in the group parameter list, newly
2089 composed messages will be @code{Gcc}'d to the current group. If
2090 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2091 generated, if @code{(gcc-self . "string")} is present, this string will
2092 be inserted literally as a @code{gcc} header.  This parameter takes
2093 precedence over any default @code{Gcc} rules as described later
2094 (@pxref{Archived Messages}).
2095
2096 @item auto-expire
2097 @cindex auto-expire
2098 If the group parameter has an element that looks like @code{(auto-expire
2099 . t)}, all articles read will be marked as expirable.  For an
2100 alternative approach, @pxref{Expiring Mail}.
2101
2102 @item total-expire
2103 @cindex total-expire
2104 If the group parameter has an element that looks like
2105 @code{(total-expire . t)}, all read articles will be put through the
2106 expiry process, even if they are not marked as expirable.  Use with
2107 caution.  Unread, ticked and dormant articles are not eligible for
2108 expiry.
2109
2110 @item expiry-wait
2111 @cindex expiry-wait
2112 @vindex nnmail-expiry-wait-function
2113 If the group parameter has an element that looks like @code{(expiry-wait
2114 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2115 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2116 The value can either be a number of days (not necessarily an integer) or
2117 the symbols @code{never} or @code{immediate}.
2118
2119 @item score-file
2120 @cindex score file group parameter
2121 Elements that look like @code{(score-file . "file")} will make
2122 @file{file} into the current score file for the group in question.  All
2123 interactive score entries will be put into this file.
2124
2125 @item adapt-file
2126 @cindex adapt file group parameter
2127 Elements that look like @code{(adapt-file . "file")} will make
2128 @file{file} into the current adaptive file for the group in question.
2129 All adaptive score entries will be put into this file.
2130
2131 @item admin-address
2132 When unsubscribing from a mailing list you should never send the
2133 unsubscription notice to the mailing list itself.  Instead, you'd send
2134 messages to the administrative address.  This parameter allows you to
2135 put the admin address somewhere convenient.
2136
2137 @item display
2138 Elements that look like @code{(display . MODE)} say which articles to
2139 display on entering the group.  Valid values are:
2140
2141 @table @code
2142 @item all
2143 Display all articles, both read and unread.
2144
2145 @item default
2146 Display the default visible articles, which normally includes unread and
2147 ticked articles.
2148 @end table
2149
2150 @item comment
2151 Elements that look like @code{(comment . "This is a comment")}
2152 are arbitrary comments on the group.  They are currently ignored by
2153 gnus, but provide a place for you to store information on particular
2154 groups.
2155
2156 @item charset
2157 Elements that look like @code{(charset . iso-8859-1)} will make
2158 @code{iso-8859-1} the default charset; that is, the charset that will be
2159 used for all articles that do not specify a charset.
2160
2161 @item @var{(variable form)}
2162 You can use the group parameters to set variables local to the group you
2163 are entering.  If you want to turn threading off in @samp{news.answers},
2164 you could put @code{(gnus-show-threads nil)} in the group parameters of
2165 that group.  @code{gnus-show-threads} will be made into a local variable
2166 in the summary buffer you enter, and the form @code{nil} will be
2167 @code{eval}ed there.
2168
2169 This can also be used as a group-specific hook function, if you'd like.
2170 If you want to hear a beep when you enter a group, you could put
2171 something like @code{(dummy-variable (ding))} in the parameters of that
2172 group.  @code{dummy-variable} will be set to the result of the
2173 @code{(ding)} form, but who cares?
2174
2175 @item posting-style
2176 You can store additional posting style information for this group only
2177 here (@pxref{Posting Styles}). The format is that of an entry in the
2178 @code{gnus-posting-styles} alist, except that there's no regexp matching
2179 the group name (of course). Style elements in this group parameter will
2180 take precedence over the ones found in @code{gnus-posting-styles}.
2181
2182 For instance, if you want a funky name and signature in this group only,
2183 instead of hacking @code{gnus-posting-styles}, you could put something
2184 like this in the group parameters:
2185
2186 @example
2187 (posting-style
2188   (name "Funky Name")
2189   (signature "Funky Signature"))
2190 @end example
2191
2192 @end table
2193
2194 Use the @kbd{G p} command to edit group parameters of a group.  You
2195 might also be interested in reading about topic parameters (@pxref{Topic
2196 Parameters}).
2197
2198
2199 @node Listing Groups
2200 @section Listing Groups
2201 @cindex group listing
2202
2203 These commands all list various slices of the groups available.
2204
2205 @table @kbd
2206
2207 @item l
2208 @itemx A s
2209 @kindex A s (Group)
2210 @kindex l (Group)
2211 @findex gnus-group-list-groups
2212 List all groups that have unread articles
2213 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2214 command will list only groups of level ARG and lower.  By default, it
2215 only lists groups of level five (i. e.,
2216 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2217 groups).
2218
2219 @item L
2220 @itemx A u
2221 @kindex A u (Group)
2222 @kindex L (Group)
2223 @findex gnus-group-list-all-groups
2224 List all groups, whether they have unread articles or not
2225 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2226 this command will list only groups of level ARG and lower.  By default,
2227 it lists groups of level seven or lower (i.e., just subscribed and
2228 unsubscribed groups).
2229
2230 @item A l
2231 @kindex A l (Group)
2232 @findex gnus-group-list-level
2233 List all unread groups on a specific level
2234 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2235 with no unread articles.
2236
2237 @item A k
2238 @kindex A k (Group)
2239 @findex gnus-group-list-killed
2240 List all killed groups (@code{gnus-group-list-killed}).  If given a
2241 prefix argument, really list all groups that are available, but aren't
2242 currently (un)subscribed.  This could entail reading the active file
2243 from the server.
2244
2245 @item A z
2246 @kindex A z (Group)
2247 @findex gnus-group-list-zombies
2248 List all zombie groups (@code{gnus-group-list-zombies}).
2249
2250 @item A m
2251 @kindex A m (Group)
2252 @findex gnus-group-list-matching
2253 List all unread, subscribed groups with names that match a regexp
2254 (@code{gnus-group-list-matching}).
2255
2256 @item A M
2257 @kindex A M (Group)
2258 @findex gnus-group-list-all-matching
2259 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2260
2261 @item A A
2262 @kindex A A (Group)
2263 @findex gnus-group-list-active
2264 List absolutely all groups in the active file(s) of the
2265 server(s) you are connected to (@code{gnus-group-list-active}).  This
2266 might very well take quite a while.  It might actually be a better idea
2267 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2268 thing to match on.  Also note that this command may list groups that
2269 don't exist (yet)---these will be listed as if they were killed groups.
2270 Take the output with some grains of salt.
2271
2272 @item A a
2273 @kindex A a (Group)
2274 @findex gnus-group-apropos
2275 List all groups that have names that match a regexp
2276 (@code{gnus-group-apropos}).
2277
2278 @item A d
2279 @kindex A d (Group)
2280 @findex gnus-group-description-apropos
2281 List all groups that have names or descriptions that match a regexp
2282 (@code{gnus-group-description-apropos}).
2283
2284 @end table
2285
2286 @vindex gnus-permanently-visible-groups
2287 @cindex visible group parameter
2288 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2289 always be shown, whether they have unread articles or not.  You can also
2290 add the @code{visible} element to the group parameters in question to
2291 get the same effect.
2292
2293 @vindex gnus-list-groups-with-ticked-articles
2294 Groups that have just ticked articles in it are normally listed in the
2295 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2296 @code{nil}, these groups will be treated just like totally empty
2297 groups.  It is @code{t} by default.
2298
2299
2300 @node Sorting Groups
2301 @section Sorting Groups
2302 @cindex sorting groups
2303
2304 @kindex C-c C-s (Group)
2305 @findex gnus-group-sort-groups
2306 @vindex gnus-group-sort-function
2307 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2308 group buffer according to the function(s) given by the
2309 @code{gnus-group-sort-function} variable.  Available sorting functions
2310 include:
2311
2312 @table @code
2313
2314 @item gnus-group-sort-by-alphabet
2315 @findex gnus-group-sort-by-alphabet
2316 Sort the group names alphabetically.  This is the default.
2317
2318 @item gnus-group-sort-by-real-name
2319 @findex gnus-group-sort-by-real-name
2320 Sort the group alphabetically on the real (unprefixed) group names.
2321
2322 @item gnus-group-sort-by-level
2323 @findex gnus-group-sort-by-level
2324 Sort by group level.
2325
2326 @item gnus-group-sort-by-score
2327 @findex gnus-group-sort-by-score
2328 Sort by group score.  @xref{Group Score}.
2329
2330 @item gnus-group-sort-by-rank
2331 @findex gnus-group-sort-by-rank
2332 Sort by group score and then the group level.  The level and the score
2333 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2334
2335 @item gnus-group-sort-by-unread
2336 @findex gnus-group-sort-by-unread
2337 Sort by number of unread articles.
2338
2339 @item gnus-group-sort-by-method
2340 @findex gnus-group-sort-by-method
2341 Sort alphabetically on the select method.
2342
2343
2344 @end table
2345
2346 @code{gnus-group-sort-function} can also be a list of sorting
2347 functions.  In that case, the most significant sort key function must be
2348 the last one.
2349
2350
2351 There are also a number of commands for sorting directly according to
2352 some sorting criteria:
2353
2354 @table @kbd
2355 @item G S a
2356 @kindex G S a (Group)
2357 @findex gnus-group-sort-groups-by-alphabet
2358 Sort the group buffer alphabetically by group name
2359 (@code{gnus-group-sort-groups-by-alphabet}).
2360
2361 @item G S u
2362 @kindex G S u (Group)
2363 @findex gnus-group-sort-groups-by-unread
2364 Sort the group buffer by the number of unread articles
2365 (@code{gnus-group-sort-groups-by-unread}).
2366
2367 @item G S l
2368 @kindex G S l (Group)
2369 @findex gnus-group-sort-groups-by-level
2370 Sort the group buffer by group level
2371 (@code{gnus-group-sort-groups-by-level}).
2372
2373 @item G S v
2374 @kindex G S v (Group)
2375 @findex gnus-group-sort-groups-by-score
2376 Sort the group buffer by group score
2377 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2378
2379 @item G S r
2380 @kindex G S r (Group)
2381 @findex gnus-group-sort-groups-by-rank
2382 Sort the group buffer by group rank
2383 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2384
2385 @item G S m
2386 @kindex G S m (Group)
2387 @findex gnus-group-sort-groups-by-method
2388 Sort the group buffer alphabetically by backend name
2389 (@code{gnus-group-sort-groups-by-method}).
2390
2391 @end table
2392
2393 All the commands below obeys the process/prefix convention
2394 (@pxref{Process/Prefix}).
2395
2396 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2397 commands will sort in reverse order.
2398
2399 You can also sort a subset of the groups:
2400
2401 @table @kbd
2402 @item G P a
2403 @kindex G P a (Group)
2404 @findex gnus-group-sort-selected-groups-by-alphabet
2405 Sort the groups alphabetically by group name
2406 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2407
2408 @item G P u
2409 @kindex G P u (Group)
2410 @findex gnus-group-sort-selected-groups-by-unread
2411 Sort the groups by the number of unread articles
2412 (@code{gnus-group-sort-selected-groups-by-unread}).
2413
2414 @item G P l
2415 @kindex G P l (Group)
2416 @findex gnus-group-sort-selected-groups-by-level
2417 Sort the groups by group level
2418 (@code{gnus-group-sort-selected-groups-by-level}).
2419
2420 @item G P v
2421 @kindex G P v (Group)
2422 @findex gnus-group-sort-selected-groups-by-score
2423 Sort the groups by group score
2424 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2425
2426 @item G P r
2427 @kindex G P r (Group)
2428 @findex gnus-group-sort-selected-groups-by-rank
2429 Sort the groups by group rank
2430 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2431
2432 @item G P m
2433 @kindex G P m (Group)
2434 @findex gnus-group-sort-selected-groups-by-method
2435 Sort the groups alphabetically by backend name
2436 (@code{gnus-group-sort-selected-groups-by-method}).
2437
2438 @end table
2439
2440
2441
2442 @node Group Maintenance
2443 @section Group Maintenance
2444 @cindex bogus groups
2445
2446 @table @kbd
2447 @item b
2448 @kindex b (Group)
2449 @findex gnus-group-check-bogus-groups
2450 Find bogus groups and delete them
2451 (@code{gnus-group-check-bogus-groups}).
2452
2453 @item F
2454 @kindex F (Group)
2455 @findex gnus-group-find-new-groups
2456 Find new groups and process them (@code{gnus-group-find-new-groups}).
2457 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2458 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
2459 to query the server for new groups, and subscribe the new groups as
2460 zombies.
2461
2462 @item C-c C-x
2463 @kindex C-c C-x (Group)
2464 @findex gnus-group-expire-articles
2465 Run all expirable articles in the current group through the expiry
2466 process (if any) (@code{gnus-group-expire-articles}).
2467
2468 @item C-c M-C-x
2469 @kindex C-c M-C-x (Group)
2470 @findex gnus-group-expire-all-groups
2471 Run all articles in all groups through the expiry process
2472 (@code{gnus-group-expire-all-groups}).
2473
2474 @end table
2475
2476
2477 @node Browse Foreign Server
2478 @section Browse Foreign Server
2479 @cindex foreign servers
2480 @cindex browsing servers
2481
2482 @table @kbd
2483 @item B
2484 @kindex B (Group)
2485 @findex gnus-group-browse-foreign-server
2486 You will be queried for a select method and a server name.  Gnus will
2487 then attempt to contact this server and let you browse the groups there
2488 (@code{gnus-group-browse-foreign-server}).
2489 @end table
2490
2491 @findex gnus-browse-mode
2492 A new buffer with a list of available groups will appear.  This buffer
2493 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2494 a lot) like a normal group buffer.
2495
2496 Here's a list of keystrokes available in the browse mode:
2497
2498 @table @kbd
2499 @item n
2500 @kindex n (Browse)
2501 @findex gnus-group-next-group
2502 Go to the next group (@code{gnus-group-next-group}).
2503
2504 @item p
2505 @kindex p (Browse)
2506 @findex gnus-group-prev-group
2507 Go to the previous group (@code{gnus-group-prev-group}).
2508
2509 @item SPACE
2510 @kindex SPACE (Browse)
2511 @findex gnus-browse-read-group
2512 Enter the current group and display the first article
2513 (@code{gnus-browse-read-group}).
2514
2515 @item RET
2516 @kindex RET (Browse)
2517 @findex gnus-browse-select-group
2518 Enter the current group (@code{gnus-browse-select-group}).
2519
2520 @item u
2521 @kindex u (Browse)
2522 @findex gnus-browse-unsubscribe-current-group
2523 Unsubscribe to the current group, or, as will be the case here,
2524 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2525
2526 @item l
2527 @itemx q
2528 @kindex q (Browse)
2529 @kindex l (Browse)
2530 @findex gnus-browse-exit
2531 Exit browse mode (@code{gnus-browse-exit}).
2532
2533 @item ?
2534 @kindex ? (Browse)
2535 @findex gnus-browse-describe-briefly
2536 Describe browse mode briefly (well, there's not much to describe, is
2537 there) (@code{gnus-browse-describe-briefly}).
2538 @end table
2539
2540
2541 @node Exiting Gnus
2542 @section Exiting gnus
2543 @cindex exiting gnus
2544
2545 Yes, gnus is ex(c)iting.
2546
2547 @table @kbd
2548 @item z
2549 @kindex z (Group)
2550 @findex gnus-group-suspend
2551 Suspend gnus (@code{gnus-group-suspend}).  This doesn't really exit gnus,
2552 but it kills all buffers except the Group buffer.  I'm not sure why this
2553 is a gain, but then who am I to judge?
2554
2555 @item q
2556 @kindex q (Group)
2557 @findex gnus-group-exit
2558 @c @icon{gnus-group-exit}
2559 Quit gnus (@code{gnus-group-exit}).
2560
2561 @item Q
2562 @kindex Q (Group)
2563 @findex gnus-group-quit
2564 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2565 The dribble file will be saved, though (@pxref{Auto Save}).
2566 @end table
2567
2568 @vindex gnus-exit-gnus-hook
2569 @vindex gnus-suspend-gnus-hook
2570 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
2571 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
2572 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2573 exiting gnus.
2574
2575 @findex gnus-unload
2576 @cindex unloading
2577 If you wish to completely unload gnus and all its adherents, you can use
2578 the @code{gnus-unload} command.  This command is also very handy when
2579 trying to customize meta-variables.
2580
2581 Note:
2582
2583 @quotation
2584 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2585 numbly heavy and herself fall into a hazy trance as the boy sitting
2586 behind her drew repeated lines with his pencil across the back of her
2587 plastic chair.
2588 @end quotation
2589
2590
2591 @node Group Topics
2592 @section Group Topics
2593 @cindex topics
2594
2595 If you read lots and lots of groups, it might be convenient to group
2596 them hierarchically according to topics.  You put your Emacs groups over
2597 here, your sex groups over there, and the rest (what, two groups or so?)
2598 you put in some misc section that you never bother with anyway.  You can
2599 even group the Emacs sex groups as a sub-topic to either the Emacs
2600 groups or the sex groups---or both!  Go wild!
2601
2602 @iftex
2603 @iflatex
2604 \gnusfigure{Group Topics}{400}{
2605 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2606 }
2607 @end iflatex
2608 @end iftex
2609
2610 Here's an example:
2611
2612 @example
2613 Gnus
2614   Emacs -- I wuw it!
2615      3: comp.emacs
2616      2: alt.religion.emacs
2617     Naughty Emacs
2618      452: alt.sex.emacs
2619        0: comp.talk.emacs.recovery
2620   Misc
2621      8: comp.binaries.fractals
2622     13: comp.sources.unix
2623 @end example
2624
2625 @findex gnus-topic-mode
2626 @kindex t (Group)
2627 To get this @emph{fab} functionality you simply turn on (ooh!) the
2628 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2629 is a toggling command.)
2630
2631 Go ahead, just try it.  I'll still be here when you get back.  La de
2632 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2633 press @kbd{l}.  There.  All your groups are now listed under
2634 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2635 bothered?
2636
2637 If you want this permanently enabled, you should add that minor mode to
2638 the hook for the group mode:
2639
2640 @lisp
2641 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2642 @end lisp
2643
2644 @menu
2645 * Topic Variables::    How to customize the topics the Lisp Way.
2646 * Topic Commands::     Interactive E-Z commands.
2647 * Topic Sorting::      Sorting each topic individually.
2648 * Topic Topology::     A map of the world.
2649 * Topic Parameters::   Parameters that apply to all groups in a topic.
2650 @end menu
2651
2652
2653 @node Topic Variables
2654 @subsection Topic Variables
2655 @cindex topic variables
2656
2657 Now, if you select a topic, it will fold/unfold that topic, which is
2658 really neat, I think.
2659
2660 @vindex gnus-topic-line-format
2661 The topic lines themselves are created according to the
2662 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2663 Valid elements are:
2664
2665 @table @samp
2666 @item i
2667 Indentation.
2668 @item n
2669 Topic name.
2670 @item v
2671 Visibility.
2672 @item l
2673 Level.
2674 @item g
2675 Number of groups in the topic.
2676 @item a
2677 Number of unread articles in the topic.
2678 @item A
2679 Number of unread articles in the topic and all its subtopics.
2680 @end table
2681
2682 @vindex gnus-topic-indent-level
2683 Each sub-topic (and the groups in the sub-topics) will be indented with
2684 @code{gnus-topic-indent-level} times the topic level number of spaces.
2685 The default is 2.
2686
2687 @vindex gnus-topic-mode-hook
2688 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2689
2690 @vindex gnus-topic-display-empty-topics
2691 The @code{gnus-topic-display-empty-topics} says whether to display even
2692 topics that have no unread articles in them.  The default is @code{t}.
2693
2694
2695 @node Topic Commands
2696 @subsection Topic Commands
2697 @cindex topic commands
2698
2699 When the topic minor mode is turned on, a new @kbd{T} submap will be
2700 available.  In addition, a few of the standard keys change their
2701 definitions slightly.
2702
2703 @table @kbd
2704
2705 @item T n
2706 @kindex T n (Topic)
2707 @findex gnus-topic-create-topic
2708 Prompt for a new topic name and create it
2709 (@code{gnus-topic-create-topic}).
2710
2711 @item T m
2712 @kindex T m (Topic)
2713 @findex gnus-topic-move-group
2714 Move the current group to some other topic
2715 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2716 convention (@pxref{Process/Prefix}).
2717
2718 @item T c
2719 @kindex T c (Topic)
2720 @findex gnus-topic-copy-group
2721 Copy the current group to some other topic
2722 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2723 convention (@pxref{Process/Prefix}).
2724
2725 @item T D
2726 @kindex T D (Topic)
2727 @findex gnus-topic-remove-group
2728 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2729 This command is mainly useful if you have the same group in several
2730 topics and wish to remove it from one of the topics.  You may also
2731 remove a group from all topics, but in that case, Gnus will add it to
2732 the root topic the next time you start Gnus.  In fact, all new groups
2733 (which, naturally, don't belong to any topic) will show up in the root
2734 topic.
2735
2736 This command uses the process/prefix convention
2737 (@pxref{Process/Prefix}).
2738
2739 @item T M
2740 @kindex T M (Topic)
2741 @findex gnus-topic-move-matching
2742 Move all groups that match some regular expression to a topic
2743 (@code{gnus-topic-move-matching}).
2744
2745 @item T C
2746 @kindex T C (Topic)
2747 @findex gnus-topic-copy-matching
2748 Copy all groups that match some regular expression to a topic
2749 (@code{gnus-topic-copy-matching}).
2750
2751 @item T H
2752 @kindex T H (Topic)
2753 @findex gnus-topic-toggle-display-empty-topics
2754 Toggle hiding empty topics
2755 (@code{gnus-topic-toggle-display-empty-topics}).
2756
2757 @item T #
2758 @kindex T # (Topic)
2759 @findex gnus-topic-mark-topic
2760 Mark all groups in the current topic with the process mark
2761 (@code{gnus-topic-mark-topic}).
2762
2763 @item T M-#
2764 @kindex T M-# (Topic)
2765 @findex gnus-topic-unmark-topic
2766 Remove the process mark from all groups in the current topic
2767 (@code{gnus-topic-unmark-topic}).
2768
2769 @item T TAB
2770 @itemx TAB
2771 @kindex T TAB (Topic)
2772 @kindex TAB (Topic)
2773 @findex gnus-topic-indent
2774 ``Indent'' the current topic so that it becomes a sub-topic of the
2775 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2776 ``un-indent'' the topic instead.
2777
2778 @item M-TAB
2779 @kindex M-TAB (Topic)
2780 @findex gnus-topic-unindent
2781 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2782 parent of its current parent (@code{gnus-topic-unindent}).
2783
2784 @item RET
2785 @kindex RET (Topic)
2786 @findex gnus-topic-select-group
2787 @itemx SPACE
2788 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2789 When you perform this command on a group, you'll enter the group, as
2790 usual.  When done on a topic line, the topic will be folded (if it was
2791 visible) or unfolded (if it was folded already).  So it's basically a
2792 toggling command on topics.  In addition, if you give a numerical
2793 prefix, group on that level (and lower) will be displayed.
2794
2795 @item C-c C-x
2796 @kindex C-c C-x (Topic)
2797 @findex gnus-topic-expire-articles
2798 Run all expirable articles in the current group or topic through the expiry
2799 process (if any) (@code{gnus-topic-expire-articles}).
2800
2801 @item C-k
2802 @kindex C-k (Topic)
2803 @findex gnus-topic-kill-group
2804 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2805 topic will be removed along with the topic.
2806
2807 @item C-y
2808 @kindex C-y (Topic)
2809 @findex gnus-topic-yank-group
2810 Yank the previously killed group or topic
2811 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2812 before all groups.
2813
2814 @item T r
2815 @kindex T r (Topic)
2816 @findex gnus-topic-rename
2817 Rename a topic (@code{gnus-topic-rename}).
2818
2819 @item T DEL
2820 @kindex T DEL (Topic)
2821 @findex gnus-topic-delete
2822 Delete an empty topic (@code{gnus-topic-delete}).
2823
2824 @item A T
2825 @kindex A T (Topic)
2826 @findex gnus-topic-list-active
2827 List all groups that gnus knows about in a topics-ified way
2828 (@code{gnus-topic-list-active}).
2829
2830 @item G p
2831 @kindex G p (Topic)
2832 @findex gnus-topic-edit-parameters
2833 @cindex group parameters
2834 @cindex topic parameters
2835 @cindex parameters
2836 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2837 @xref{Topic Parameters}.
2838
2839 @end table
2840
2841
2842 @node Topic Sorting
2843 @subsection Topic Sorting
2844 @cindex topic sorting
2845
2846 You can sort the groups in each topic individually with the following
2847 commands:
2848
2849
2850 @table @kbd
2851 @item T S a
2852 @kindex T S a (Topic)
2853 @findex gnus-topic-sort-groups-by-alphabet
2854 Sort the current topic alphabetically by group name
2855 (@code{gnus-topic-sort-groups-by-alphabet}).
2856
2857 @item T S u
2858 @kindex T S u (Topic)
2859 @findex gnus-topic-sort-groups-by-unread
2860 Sort the current topic by the number of unread articles
2861 (@code{gnus-topic-sort-groups-by-unread}).
2862
2863 @item T S l
2864 @kindex T S l (Topic)
2865 @findex gnus-topic-sort-groups-by-level
2866 Sort the current topic by group level
2867 (@code{gnus-topic-sort-groups-by-level}).
2868
2869 @item T S v
2870 @kindex T S v (Topic)
2871 @findex gnus-topic-sort-groups-by-score
2872 Sort the current topic by group score
2873 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2874
2875 @item T S r
2876 @kindex T S r (Topic)
2877 @findex gnus-topic-sort-groups-by-rank
2878 Sort the current topic by group rank
2879 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2880
2881 @item T S m
2882 @kindex T S m (Topic)
2883 @findex gnus-topic-sort-groups-by-method
2884 Sort the current topic alphabetically by backend name
2885 (@code{gnus-topic-sort-groups-by-method}).
2886
2887 @end table
2888
2889 @xref{Sorting Groups} for more information about group sorting.
2890
2891
2892 @node Topic Topology
2893 @subsection Topic Topology
2894 @cindex topic topology
2895 @cindex topology
2896
2897 So, let's have a look at an example group buffer:
2898
2899 @example
2900 Gnus
2901   Emacs -- I wuw it!
2902      3: comp.emacs
2903      2: alt.religion.emacs
2904     Naughty Emacs
2905      452: alt.sex.emacs
2906        0: comp.talk.emacs.recovery
2907   Misc
2908      8: comp.binaries.fractals
2909     13: comp.sources.unix
2910 @end example
2911
2912 So, here we have one top-level topic (@samp{Gnus}), two topics under
2913 that, and one sub-topic under one of the sub-topics.  (There is always
2914 just one (1) top-level topic).  This topology can be expressed as
2915 follows:
2916
2917 @lisp
2918 (("Gnus" visible)
2919  (("Emacs -- I wuw it!" visible)
2920   (("Naughty Emacs" visible)))
2921  (("Misc" visible)))
2922 @end lisp
2923
2924 @vindex gnus-topic-topology
2925 This is in fact how the variable @code{gnus-topic-topology} would look
2926 for the display above.  That variable is saved in the @file{.newsrc.eld}
2927 file, and shouldn't be messed with manually---unless you really want
2928 to.  Since this variable is read from the @file{.newsrc.eld} file,
2929 setting it in any other startup files will have no effect.
2930
2931 This topology shows what topics are sub-topics of what topics (right),
2932 and which topics are visible.  Two settings are currently
2933 allowed---@code{visible} and @code{invisible}.
2934
2935
2936 @node Topic Parameters
2937 @subsection Topic Parameters
2938 @cindex topic parameters
2939
2940 All groups in a topic will inherit group parameters from the parent (and
2941 ancestor) topic parameters.  All valid group parameters are valid topic
2942 parameters (@pxref{Group Parameters}).
2943
2944 Group parameters (of course) override topic parameters, and topic
2945 parameters in sub-topics override topic parameters in super-topics.  You
2946 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2947 verb, although you may feel free to disagree with me here.)
2948
2949 @example
2950 Gnus
2951   Emacs
2952      3: comp.emacs
2953      2: alt.religion.emacs
2954    452: alt.sex.emacs
2955     Relief
2956      452: alt.sex.emacs
2957        0: comp.talk.emacs.recovery
2958   Misc
2959      8: comp.binaries.fractals
2960     13: comp.sources.unix
2961    452: alt.sex.emacs
2962 @end example
2963
2964 The @samp{Emacs} topic has the topic parameter @code{(score-file
2965 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2966 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2967 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2968 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2969 . "religion.SCORE")}.
2970
2971 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2972 will get the @file{relief.SCORE} home score file.  If you enter the same
2973 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2974 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2975 get the @file{religion.SCORE} home score file.
2976
2977 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2978 there are some problems, especially with the @code{total-expiry}
2979 parameter.  Say you have a mail group in two topics; one with
2980 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2981 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2982 of these topics you mean to expire articles from, so anything may
2983 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2984 happens.  You just have to be careful if you do stuff like that.
2985
2986
2987 @node Misc Group Stuff
2988 @section Misc Group Stuff
2989
2990 @menu
2991 * Scanning New Messages:: Asking gnus to see whether new messages have arrived.
2992 * Group Information::     Information and help on groups and gnus.
2993 * Group Timestamp::       Making gnus keep track of when you last read a group.
2994 * File Commands::         Reading and writing the gnus files.
2995 @end menu
2996
2997 @table @kbd
2998
2999 @item ^
3000 @kindex ^ (Group)
3001 @findex gnus-group-enter-server-mode
3002 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3003 @xref{The Server Buffer}.
3004
3005 @item a
3006 @kindex a (Group)
3007 @findex gnus-group-post-news
3008 Post an article to a group (@code{gnus-group-post-news}).  If given a
3009 prefix, the current group name will be used as the default.
3010
3011 @item m
3012 @kindex m (Group)
3013 @findex gnus-group-mail
3014 Mail a message somewhere (@code{gnus-group-mail}).
3015
3016 @end table
3017
3018 Variables for the group buffer:
3019
3020 @table @code
3021
3022 @item gnus-group-mode-hook
3023 @vindex gnus-group-mode-hook
3024 is called after the group buffer has been
3025 created.
3026
3027 @item gnus-group-prepare-hook
3028 @vindex gnus-group-prepare-hook
3029 is called after the group buffer is
3030 generated.  It may be used to modify the buffer in some strange,
3031 unnatural way.
3032
3033 @item gnus-group-prepared-hook
3034 @vindex gnus-group-prepare-hook
3035 is called as the very last thing after the group buffer has been
3036 generated.  It may be used to move point around, for instance.
3037
3038 @item gnus-permanently-visible-groups
3039 @vindex gnus-permanently-visible-groups
3040 Groups matching this regexp will always be listed in the group buffer,
3041 whether they are empty or not.
3042
3043 @end table
3044
3045
3046 @node Scanning New Messages
3047 @subsection Scanning New Messages
3048 @cindex new messages
3049 @cindex scanning new news
3050
3051 @table @kbd
3052
3053 @item g
3054 @kindex g (Group)
3055 @findex gnus-group-get-new-news
3056 @c @icon{gnus-group-get-new-news}
3057 Check the server(s) for new articles.  If the numerical prefix is used,
3058 this command will check only groups of level @var{arg} and lower
3059 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
3060 command will force a total re-reading of the active file(s) from the
3061 backend(s).
3062
3063 @item M-g
3064 @kindex M-g (Group)
3065 @findex gnus-group-get-new-news-this-group
3066 @vindex gnus-goto-next-group-when-activating
3067 @c @icon{gnus-group-get-new-news-this-group}
3068 Check whether new articles have arrived in the current group
3069 (@code{gnus-group-get-new-news-this-group}).
3070 @code{gnus-goto-next-group-when-activating} says whether this command is
3071 to move point to the next group or not.  It is @code{t} by default.
3072
3073 @findex gnus-activate-all-groups
3074 @cindex activating groups
3075 @item C-c M-g
3076 @kindex C-c M-g (Group)
3077 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3078
3079 @item R
3080 @kindex R (Group)
3081 @cindex restarting
3082 @findex gnus-group-restart
3083 Restart gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3084 file(s), closes the connection to all servers, clears up all run-time
3085 gnus variables, and then starts gnus all over again.
3086
3087 @end table
3088
3089 @vindex gnus-get-new-news-hook
3090 @code{gnus-get-new-news-hook} is run just before checking for new news.
3091
3092 @vindex gnus-after-getting-new-news-hook
3093 @code{gnus-after-getting-new-news-hook} is run after checking for new
3094 news.
3095
3096
3097 @node Group Information
3098 @subsection Group Information
3099 @cindex group information
3100 @cindex information on groups
3101
3102 @table @kbd
3103
3104
3105 @item H f
3106 @kindex H f (Group)
3107 @findex gnus-group-fetch-faq
3108 @vindex gnus-group-faq-directory
3109 @cindex FAQ
3110 @cindex ange-ftp
3111 Try to fetch the FAQ for the current group
3112 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3113 @code{gnus-group-faq-directory}, which is usually a directory on a
3114 remote machine.  This variable can also be a list of directories.  In
3115 that case, giving a prefix to this command will allow you to choose
3116 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3117 for fetching the file.
3118
3119 If fetching from the first site is unsuccessful, gnus will attempt to go
3120 through @code{gnus-group-faq-directory} and try to open them one by one.
3121
3122 @item H d
3123 @itemx C-c C-d
3124 @c @icon{gnus-group-describe-group}
3125 @kindex H d (Group)
3126 @kindex C-c C-d (Group)
3127 @cindex describing groups
3128 @cindex group description
3129 @findex gnus-group-describe-group
3130 Describe the current group (@code{gnus-group-describe-group}).  If given
3131 a prefix, force Gnus to re-read the description from the server.
3132
3133 @item M-d
3134 @kindex M-d (Group)
3135 @findex gnus-group-describe-all-groups
3136 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3137 prefix, force gnus to re-read the description file from the server.
3138
3139 @item H v
3140 @itemx V
3141 @kindex V (Group)
3142 @kindex H v (Group)
3143 @cindex version
3144 @findex gnus-version
3145 Display current gnus version numbers (@code{gnus-version}).
3146
3147 @item ?
3148 @kindex ? (Group)
3149 @findex gnus-group-describe-briefly
3150 Give a very short help message (@code{gnus-group-describe-briefly}).
3151
3152 @item C-c C-i
3153 @kindex C-c C-i (Group)
3154 @cindex info
3155 @cindex manual
3156 @findex gnus-info-find-node
3157 Go to the gnus info node (@code{gnus-info-find-node}).
3158 @end table
3159
3160
3161 @node Group Timestamp
3162 @subsection Group Timestamp
3163 @cindex timestamps
3164 @cindex group timestamps
3165
3166 It can be convenient to let gnus keep track of when you last read a
3167 group.  To set the ball rolling, you should add
3168 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3169
3170 @lisp
3171 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3172 @end lisp
3173
3174 After doing this, each time you enter a group, it'll be recorded.
3175
3176 This information can be displayed in various ways---the easiest is to
3177 use the @samp{%d} spec in the group line format:
3178
3179 @lisp
3180 (setq gnus-group-line-format
3181       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3182 @end lisp
3183
3184 This will result in lines looking like:
3185
3186 @example
3187 *        0: mail.ding                                19961002T012943
3188          0: custom                                   19961002T012713
3189 @end example
3190
3191 As you can see, the date is displayed in compact ISO 8601 format.  This
3192 may be a bit too much, so to just display the date, you could say
3193 something like:
3194
3195 @lisp
3196 (setq gnus-group-line-format
3197       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3198 @end lisp
3199
3200
3201 @node File Commands
3202 @subsection File Commands
3203 @cindex file commands
3204
3205 @table @kbd
3206
3207 @item r
3208 @kindex r (Group)
3209 @findex gnus-group-read-init-file
3210 @vindex gnus-init-file
3211 @cindex reading init file
3212 Re-read the init file (@code{gnus-init-file}, which defaults to
3213 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3214
3215 @item s
3216 @kindex s (Group)
3217 @findex gnus-group-save-newsrc
3218 @cindex saving .newsrc
3219 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3220 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3221 file(s) whether Gnus thinks it is necessary or not.
3222
3223 @c @item Z
3224 @c @kindex Z (Group)
3225 @c @findex gnus-group-clear-dribble
3226 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3227
3228 @end table
3229
3230
3231 @node The Summary Buffer
3232 @chapter The Summary Buffer
3233 @cindex summary buffer
3234
3235 A line for each article is displayed in the summary buffer.  You can
3236 move around, read articles, post articles and reply to articles.
3237
3238 The most common way to a summary buffer is to select a group from the
3239 group buffer (@pxref{Selecting a Group}).
3240
3241 You can have as many summary buffers open as you wish.
3242
3243 @menu
3244 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3245 * Summary Maneuvering::         Moving around the summary buffer.
3246 * Choosing Articles::           Reading articles.
3247 * Paging the Article::          Scrolling the current article.
3248 * Reply Followup and Post::     Posting articles.
3249 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3250 * Marking Articles::            Marking articles as read, expirable, etc.
3251 * Limiting::                    You can limit the summary buffer.
3252 * Threading::                   How threads are made.
3253 * Sorting::                     How articles and threads are sorted.
3254 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3255 * Article Caching::             You may store articles in a cache.
3256 * Persistent Articles::         Making articles expiry-resistant.
3257 * Article Backlog::             Having already read articles hang around.
3258 * Saving Articles::             Ways of customizing article saving.
3259 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3260 * Article Treatment::           The article buffer can be mangled at will.
3261 * MIME Commands::               Doing MIMEy things with the articles.
3262 * Charsets::                    Character set issues.
3263 * Article Commands::            Doing various things with the article buffer.
3264 * Summary Sorting::             Sorting the summary buffer in various ways.
3265 * Finding the Parent::          No child support? Get the parent.
3266 * Alternative Approaches::      Reading using non-default summaries.
3267 * Tree Display::                A more visual display of threads.
3268 * Mail Group Commands::         Some commands can only be used in mail groups.
3269 * Various Summary Stuff::       What didn't fit anywhere else.
3270 * Exiting the Summary Buffer::  Returning to the Group buffer.
3271 * Crosspost Handling::          How crossposted articles are dealt with.
3272 * Duplicate Suppression::       An alternative when crosspost handling fails.
3273 @end menu
3274
3275
3276 @node Summary Buffer Format
3277 @section Summary Buffer Format
3278 @cindex summary buffer format
3279
3280 @iftex
3281 @iflatex
3282 \gnusfigure{The Summary Buffer}{180}{
3283 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3284 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3285 }
3286 @end iflatex
3287 @end iftex
3288
3289 @menu
3290 * Summary Buffer Lines::     You can specify how summary lines should look.
3291 * To From Newsgroups::       How to not display your own name.
3292 * Summary Buffer Mode Line:: You can say how the mode line should look.
3293 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3294 @end menu
3295
3296 @findex mail-extract-address-components
3297 @findex gnus-extract-address-components
3298 @vindex gnus-extract-address-components
3299 Gnus will use the value of the @code{gnus-extract-address-components}
3300 variable as a function for getting the name and address parts of a
3301 @code{From} header.  Three pre-defined functions exist:
3302 @code{gnus-extract-address-components}, which is the default, quite
3303 fast, and too simplistic solution;
3304 @code{mail-extract-address-components}, which works nicely, but is
3305 slower; and @code{std11-extract-address-components}, which works very
3306 nicely, but is slower.  The default function will return the wrong
3307 answer in 5% of the cases.  If this is unacceptable to you, use the
3308 other function instead:
3309
3310 @lisp
3311 (setq gnus-extract-address-components
3312       'mail-extract-address-components)
3313 @end lisp
3314
3315 @vindex gnus-summary-same-subject
3316 @code{gnus-summary-same-subject} is a string indicating that the current
3317 article has the same subject as the previous.  This string will be used
3318 with those specs that require it.  The default is @code{""}.
3319
3320
3321 @node Summary Buffer Lines
3322 @subsection Summary Buffer Lines
3323
3324 @vindex gnus-summary-line-format
3325 You can change the format of the lines in the summary buffer by changing
3326 the @code{gnus-summary-line-format} variable.  It works along the same
3327 lines as a normal @code{format} string, with some extensions
3328 (@pxref{Formatting Variables}).
3329
3330 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3331
3332 The following format specification characters are understood:
3333
3334 @table @samp
3335 @item N
3336 Article number.
3337 @item S
3338 Subject string.
3339 @item s
3340 Subject if the article is the root of the thread or the previous article
3341 had a different subject, @code{gnus-summary-same-subject} otherwise.
3342 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3343 @item F
3344 Full @code{From} header.
3345 @item n
3346 The name (from the @code{From} header).
3347 @item f
3348 The name, code @code{To} header or the @code{Newsgroups} header
3349 (@pxref{To From Newsgroups}).
3350 @item a
3351 The name (from the @code{From} header).  This differs from the @code{n}
3352 spec in that it uses the function designated by the
3353 @code{gnus-extract-address-components} variable, which is slower, but
3354 may be more thorough.
3355 @item A
3356 The address (from the @code{From} header).  This works the same way as
3357 the @code{a} spec.
3358 @item L
3359 Number of lines in the article.
3360 @item c
3361 Number of characters in the article.
3362 @item I
3363 Indentation based on thread level (@pxref{Customizing Threading}).
3364 @item T
3365 Nothing if the article is a root and lots of spaces if it isn't (it
3366 pushes everything after it off the screen).
3367 @item [
3368 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3369 for adopted articles (@pxref{Customizing Threading}).
3370 @item ]
3371 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3372 for adopted articles.
3373 @item >
3374 One space for each thread level.
3375 @item <
3376 Twenty minus thread level spaces.
3377 @item U
3378 Unread.
3379
3380 @item R
3381 This misleadingly named specifier is the @dfn{secondary mark}.  This
3382 mark will say whether the article has been replied to, has been cached,
3383 or has been saved.
3384
3385 @item i
3386 Score as a number (@pxref{Scoring}).
3387 @item z
3388 @vindex gnus-summary-zcore-fuzz
3389 Zcore, @samp{+} if above the default level and @samp{-} if below the
3390 default level.  If the difference between
3391 @code{gnus-summary-default-score} and the score is less than
3392 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3393 @item V
3394 Total thread score.
3395 @item x
3396 @code{Xref}.
3397 @item D
3398 @code{Date}.
3399 @item d
3400 The @code{Date} in @code{DD-MMM} format.
3401 @item o
3402 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3403 @item M
3404 @code{Message-ID}.
3405 @item r
3406 @code{References}.
3407 @item t
3408 Number of articles in the current sub-thread.  Using this spec will slow
3409 down summary buffer generation somewhat.
3410 @item e
3411 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3412 article has any children.
3413 @item P
3414 The line number.
3415 @item O
3416 Download mark.
3417 @item u
3418 User defined specifier.  The next character in the format string should
3419 be a letter.  Gnus will call the function
3420 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3421 following @samp{%u}.  The function will be passed the current header as
3422 argument.  The function should return a string, which will be inserted
3423 into the summary just like information from any other summary specifier.
3424 @end table
3425
3426 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3427 have to be handled with care.  For reasons of efficiency, gnus will
3428 compute what column these characters will end up in, and ``hard-code''
3429 that.  This means that it is invalid to have these specs after a
3430 variable-length spec.  Well, you might not be arrested, but your summary
3431 buffer will look strange, which is bad enough.
3432
3433 The smart choice is to have these specs as far to the left as possible.
3434 (Isn't that the case with everything, though?  But I digress.)
3435
3436 This restriction may disappear in later versions of gnus.
3437
3438
3439 @node To From Newsgroups
3440 @subsection To From Newsgroups
3441 @cindex To
3442 @cindex Newsgroups
3443
3444 In some groups (particularly in archive groups), the @code{From} header
3445 isn't very interesting, since all the articles there are written by
3446 you.  To display the information in the @code{To} or @code{Newsgroups}
3447 headers instead, you need to decide three things: What information to
3448 gather; where to display it; and when to display it.
3449
3450 @enumerate
3451 @item
3452 @vindex gnus-extra-headers
3453 The reading of extra header information is controlled by the
3454 @code{gnus-extra-headers}.  This is a list of header symbols.  For
3455 instance:
3456
3457 @lisp
3458 (setq gnus-extra-headers
3459       '(To Newsgroups X-Newsreader))
3460 @end lisp
3461
3462 This will result in Gnus trying to obtain these three headers, and
3463 storing it in header structures for later easy retrieval.
3464
3465 @item
3466 @findex gnus-extra-header
3467 The value of these extra headers can be accessed via the
3468 @code{gnus-extra-header} function.  Here's a format line spec that will
3469 access the @code{X-Newsreader} header:
3470
3471 @example
3472 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3473 @end example
3474
3475 @item
3476 @vindex gnus-ignored-from-addresses
3477 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3478 summary line spec returns the @code{To}, @code{Newsreader} or
3479 @code{From} header.  If this regexp matches the contents of the
3480 @code{From} header, the value of the @code{To} or @code{Newsreader}
3481 headers are used instead.
3482
3483 @end enumerate
3484
3485 @vindex nnmail-extra-headers
3486 A related variable is @code{nnmail-extra-headers}, which controls when
3487 to include extra headers when generating overview (@sc{nov}) files.  If
3488 you have old overview files, you should regenerate them after changing
3489 this variable.
3490
3491 @vindex gnus-summary-line-format
3492 You also have to instruct Gnus to display the data by changing the
3493 @code{%n} spec to the @code{%f} spec in the
3494 @code{gnus-summary-line-format} variable.
3495
3496 In summary, you'd typically do something like the following:
3497
3498 @lisp
3499 (setq gnus-extra-headers
3500       '(To Newsgroups))
3501 (setq nnmail-extra-headers gnus-extra-headers)
3502 (setq gnus-summary-line-format
3503       "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3504 (setq gnus-ignored-from-addresses
3505       "Your Name Here")
3506 @end lisp
3507
3508 Now, this is mostly useful for mail groups, where you have control over
3509 the @sc{nov} files that are created.  However, if you can persuade your
3510 nntp admin to add:
3511
3512 @example
3513 Newsgroups:full
3514 @end example
3515
3516 to the end of her @file{overview.fmt} file, then you can use that just
3517 as you would the extra headers from the mail groups.
3518
3519
3520 @node Summary Buffer Mode Line
3521 @subsection Summary Buffer Mode Line
3522
3523 @vindex gnus-summary-mode-line-format
3524 You can also change the format of the summary mode bar (@pxref{Mode Line
3525 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
3526 like.  The default is @samp{Gnus: %%b [%A] %Z}.
3527
3528 Here are the elements you can play with:
3529
3530 @table @samp
3531 @item G
3532 Group name.
3533 @item p
3534 Unprefixed group name.
3535 @item A
3536 Current article number.
3537 @item z
3538 Current article score.
3539 @item V
3540 Gnus version.
3541 @item U
3542 Number of unread articles in this group.
3543 @item e
3544 Number of unread articles in this group that aren't displayed in the
3545 summary buffer.
3546 @item Z
3547 A string with the number of unread and unselected articles represented
3548 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3549 articles, and just as @samp{<%U more>} if there are just unread articles
3550 and no unselected ones.
3551 @item g
3552 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3553 shortened to @samp{r.a.anime}.
3554 @item S
3555 Subject of the current article.
3556 @item u
3557 User-defined spec (@pxref{User-Defined Specs}).
3558 @item s
3559 Name of the current score file (@pxref{Scoring}).
3560 @item d
3561 Number of dormant articles (@pxref{Unread Articles}).
3562 @item t
3563 Number of ticked articles (@pxref{Unread Articles}).
3564 @item r
3565 Number of articles that have been marked as read in this session.
3566 @item E
3567 Number of articles expunged by the score files.
3568 @end table
3569
3570
3571 @node Summary Highlighting
3572 @subsection Summary Highlighting
3573
3574 @table @code
3575
3576 @item gnus-visual-mark-article-hook
3577 @vindex gnus-visual-mark-article-hook
3578 This hook is run after selecting an article.  It is meant to be used for
3579 highlighting the article in some way.  It is not run if
3580 @code{gnus-visual} is @code{nil}.
3581
3582 @item gnus-summary-update-hook
3583 @vindex gnus-summary-update-hook
3584 This hook is called when a summary line is changed.  It is not run if
3585 @code{gnus-visual} is @code{nil}.
3586
3587 @item gnus-summary-selected-face
3588 @vindex gnus-summary-selected-face
3589 This is the face (or @dfn{font} as some people call it) used to
3590 highlight the current article in the summary buffer.
3591
3592 @item gnus-summary-highlight
3593 @vindex gnus-summary-highlight
3594 Summary lines are highlighted according to this variable, which is a
3595 list where the elements are of the format @var{(FORM . FACE)}.  If you
3596 would, for instance, like ticked articles to be italic and high-scored
3597 articles to be bold, you could set this variable to something like
3598 @lisp
3599 (((eq mark gnus-ticked-mark) . italic)
3600  ((> score default) . bold))
3601 @end lisp
3602 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3603 @var{FACE} will be applied to the line.
3604 @end table
3605
3606
3607 @node Summary Maneuvering
3608 @section Summary Maneuvering
3609 @cindex summary movement
3610
3611 All the straight movement commands understand the numeric prefix and
3612 behave pretty much as you'd expect.
3613
3614 None of these commands select articles.
3615
3616 @table @kbd
3617 @item G M-n
3618 @itemx M-n
3619 @kindex M-n (Summary)
3620 @kindex G M-n (Summary)
3621 @findex gnus-summary-next-unread-subject
3622 Go to the next summary line of an unread article
3623 (@code{gnus-summary-next-unread-subject}).
3624
3625 @item G M-p
3626 @itemx M-p
3627 @kindex M-p (Summary)
3628 @kindex G M-p (Summary)
3629 @findex gnus-summary-prev-unread-subject
3630 Go to the previous summary line of an unread article
3631 (@code{gnus-summary-prev-unread-subject}).
3632
3633 @item G j
3634 @itemx j
3635 @kindex j (Summary)
3636 @kindex G j (Summary)
3637 @findex gnus-summary-goto-article
3638 Ask for an article number or @code{Message-ID}, and then go to that
3639 article (@code{gnus-summary-goto-article}).
3640
3641 @item G g
3642 @kindex G g (Summary)
3643 @findex gnus-summary-goto-subject
3644 Ask for an article number and then go to the summary line of that article
3645 without displaying the article (@code{gnus-summary-goto-subject}).
3646 @end table
3647
3648 If gnus asks you to press a key to confirm going to the next group, you
3649 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3650 buffer, searching for the next group to read without actually returning
3651 to the group buffer.
3652
3653 Variables related to summary movement:
3654
3655 @table @code
3656
3657 @vindex gnus-auto-select-next
3658 @item gnus-auto-select-next
3659 If you issue one of the movement commands (like @kbd{n}) and there are
3660 no more unread articles after the current one, gnus will offer to go to
3661 the next group.  If this variable is @code{t} and the next group is
3662 empty, gnus will exit summary mode and return to the group buffer.  If
3663 this variable is neither @code{t} nor @code{nil}, gnus will select the
3664 next group, no matter whether it has any unread articles or not.  As a
3665 special case, if this variable is @code{quietly}, gnus will select the
3666 next group without asking for confirmation.  If this variable is
3667 @code{almost-quietly}, the same will happen only if you are located on
3668 the last article in the group.  Finally, if this variable is
3669 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3670 without confirmation.  Also @pxref{Group Levels}.
3671
3672 @item gnus-auto-select-same
3673 @vindex gnus-auto-select-same
3674 If non-@code{nil}, all the movement commands will try to go to the next
3675 article with the same subject as the current.  (@dfn{Same} here might
3676 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3677 for details (@pxref{Customizing Threading}).)  If there are no more
3678 articles with the same subject, go to the first unread article.
3679
3680 This variable is not particularly useful if you use a threaded display.
3681
3682 @item gnus-summary-check-current
3683 @vindex gnus-summary-check-current
3684 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3685 to the next (or previous) article if the current article is unread.
3686 Instead, they will choose the current article.
3687
3688 @item gnus-auto-center-summary
3689 @vindex gnus-auto-center-summary
3690 If non-@code{nil}, gnus will keep the point in the summary buffer
3691 centered at all times.  This makes things quite tidy, but if you have a
3692 slow network connection, or simply do not like this un-Emacsism, you can
3693 set this variable to @code{nil} to get the normal Emacs scrolling
3694 action.  This will also inhibit horizontal re-centering of the summary
3695 buffer, which might make it more inconvenient to read extremely long
3696 threads.
3697
3698 This variable can also be a number.  In that case, center the window at
3699 the given number of lines from the top.
3700
3701 @end table
3702
3703
3704 @node Choosing Articles
3705 @section Choosing Articles
3706 @cindex selecting articles
3707
3708 @menu
3709 * Choosing Commands::        Commands for choosing articles.
3710 * Choosing Variables::       Variables that influence these commands.
3711 @end menu
3712
3713
3714 @node Choosing Commands
3715 @subsection Choosing Commands
3716
3717 None of the following movement commands understand the numeric prefix,
3718 and they all select and display an article.
3719
3720 @table @kbd
3721 @item SPACE
3722 @kindex SPACE (Summary)
3723 @findex gnus-summary-next-page
3724 Select the current article, or, if that one's read already, the next
3725 unread article (@code{gnus-summary-next-page}).
3726
3727 @item G n
3728 @itemx n
3729 @kindex n (Summary)
3730 @kindex G n (Summary)
3731 @findex gnus-summary-next-unread-article
3732 @c @icon{gnus-summary-next-unread}
3733 Go to next unread article (@code{gnus-summary-next-unread-article}).
3734
3735 @item G p
3736 @itemx p
3737 @kindex p (Summary)
3738 @findex gnus-summary-prev-unread-article
3739 @c @icon{gnus-summary-prev-unread}
3740 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3741
3742 @item G N
3743 @itemx N
3744 @kindex N (Summary)
3745 @kindex G N (Summary)
3746 @findex gnus-summary-next-article
3747 Go to the next article (@code{gnus-summary-next-article}).
3748
3749 @item G P
3750 @itemx P
3751 @kindex P (Summary)
3752 @kindex G P (Summary)
3753 @findex gnus-summary-prev-article
3754 Go to the previous article (@code{gnus-summary-prev-article}).
3755
3756 @item G C-n
3757 @kindex G C-n (Summary)
3758 @findex gnus-summary-next-same-subject
3759 Go to the next article with the same subject
3760 (@code{gnus-summary-next-same-subject}).
3761
3762 @item G C-p
3763 @kindex G C-p (Summary)
3764 @findex gnus-summary-prev-same-subject
3765 Go to the previous article with the same subject
3766 (@code{gnus-summary-prev-same-subject}).
3767
3768 @item G f
3769 @itemx .
3770 @kindex G f  (Summary)
3771 @kindex .  (Summary)
3772 @findex gnus-summary-first-unread-article
3773 Go to the first unread article
3774 (@code{gnus-summary-first-unread-article}).
3775
3776 @item G b
3777 @itemx ,
3778 @kindex G b (Summary)
3779 @kindex , (Summary)
3780 @findex gnus-summary-best-unread-article
3781 Go to the article with the highest score
3782 (@code{gnus-summary-best-unread-article}).
3783
3784 @item G l
3785 @itemx l
3786 @kindex l (Summary)
3787 @kindex G l (Summary)
3788 @findex gnus-summary-goto-last-article
3789 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3790
3791 @item G o
3792 @kindex G o (Summary)
3793 @findex gnus-summary-pop-article
3794 @cindex history
3795 @cindex article history
3796 Pop an article off the summary history and go to this article
3797 (@code{gnus-summary-pop-article}).  This command differs from the
3798 command above in that you can pop as many previous articles off the
3799 history as you like, while @kbd{l} toggles the two last read articles.
3800 For a somewhat related issue (if you use these commands a lot),
3801 @pxref{Article Backlog}.
3802 @end table
3803
3804
3805 @node Choosing Variables
3806 @subsection Choosing Variables
3807
3808 Some variables relevant for moving and selecting articles:
3809
3810 @table @code
3811 @item gnus-auto-extend-newsgroup
3812 @vindex gnus-auto-extend-newsgroup
3813 All the movement commands will try to go to the previous (or next)
3814 article, even if that article isn't displayed in the Summary buffer if
3815 this variable is non-@code{nil}.  Gnus will then fetch the article from
3816 the server and display it in the article buffer.
3817
3818 @item gnus-select-article-hook
3819 @vindex gnus-select-article-hook
3820 This hook is called whenever an article is selected.  By default it
3821 exposes any threads hidden under the selected article.
3822
3823 @item gnus-mark-article-hook
3824 @vindex gnus-mark-article-hook
3825 @findex gnus-summary-mark-unread-as-read
3826 @findex gnus-summary-mark-read-and-unread-as-read
3827 @findex gnus-unread-mark
3828 This hook is called whenever an article is selected.  It is intended to
3829 be used for marking articles as read.  The default value is
3830 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3831 mark of almost any article you read to @code{gnus-unread-mark}.  The
3832 only articles not affected by this function are ticked, dormant, and
3833 expirable articles.  If you'd instead like to just have unread articles
3834 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3835 instead.  It will leave marks like @code{gnus-low-score-mark},
3836 @code{gnus-del-mark} (and so on) alone.
3837
3838 @end table
3839
3840
3841 @node Paging the Article
3842 @section Scrolling the Article
3843 @cindex article scrolling
3844
3845 @table @kbd
3846
3847 @item SPACE
3848 @kindex SPACE (Summary)
3849 @findex gnus-summary-next-page
3850 Pressing @kbd{SPACE} will scroll the current article forward one page,
3851 or, if you have come to the end of the current article, will choose the
3852 next article (@code{gnus-summary-next-page}).
3853
3854 @item DEL
3855 @kindex DEL (Summary)
3856 @findex gnus-summary-prev-page
3857 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3858
3859 @item RET
3860 @kindex RET (Summary)
3861 @findex gnus-summary-scroll-up
3862 Scroll the current article one line forward
3863 (@code{gnus-summary-scroll-up}).
3864
3865 @item M-RET
3866 @kindex M-RET (Summary)
3867 @findex gnus-summary-scroll-down
3868 Scroll the current article one line backward
3869 (@code{gnus-summary-scroll-down}).
3870
3871 @item A g
3872 @itemx g
3873 @kindex A g (Summary)
3874 @kindex g (Summary)
3875 @findex gnus-summary-show-article
3876 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3877 given a prefix, fetch the current article, but don't run any of the
3878 article treatment functions.  This will give you a ``raw'' article, just
3879 the way it came from the server.
3880
3881 @item A <
3882 @itemx <
3883 @kindex < (Summary)
3884 @kindex A < (Summary)
3885 @findex gnus-summary-beginning-of-article
3886 Scroll to the beginning of the article
3887 (@code{gnus-summary-beginning-of-article}).
3888
3889 @item A >
3890 @itemx >
3891 @kindex > (Summary)
3892 @kindex A > (Summary)
3893 @findex gnus-summary-end-of-article
3894 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3895
3896 @item A s
3897 @itemx s
3898 @kindex A s (Summary)
3899 @kindex s (Summary)
3900 @findex gnus-summary-isearch-article
3901 Perform an isearch in the article buffer
3902 (@code{gnus-summary-isearch-article}).
3903
3904 @item h
3905 @kindex h (Summary)
3906 @findex gnus-summary-select-article-buffer
3907 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3908
3909 @end table
3910
3911
3912 @node Reply Followup and Post
3913 @section Reply, Followup and Post
3914
3915 @menu
3916 * Summary Mail Commands::            Sending mail.
3917 * Summary Post Commands::            Sending news.
3918 @end menu
3919
3920
3921 @node Summary Mail Commands
3922 @subsection Summary Mail Commands
3923 @cindex mail
3924 @cindex composing mail
3925
3926 Commands for composing a mail message:
3927
3928 @table @kbd
3929
3930 @item S r
3931 @itemx r
3932 @kindex S r (Summary)
3933 @kindex r (Summary)
3934 @findex gnus-summary-reply
3935 @c @icon{gnus-summary-mail-reply}
3936 @c @icon{gnus-summary-reply}
3937 Mail a reply to the author of the current article
3938 (@code{gnus-summary-reply}).
3939
3940 @item S R
3941 @itemx R
3942 @kindex R (Summary)
3943 @kindex S R (Summary)
3944 @findex gnus-summary-reply-with-original
3945 @c @icon{gnus-summary-reply-with-original}
3946 Mail a reply to the author of the current article and include the
3947 original message (@code{gnus-summary-reply-with-original}).  This
3948 command uses the process/prefix convention.
3949
3950 @item S w
3951 @kindex S w (Summary)
3952 @findex gnus-summary-wide-reply
3953 Mail a wide reply to the author of the current article
3954 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3955 goes out to all people listed in the @code{To}, @code{From} (or
3956 @code{Reply-to}) and @code{Cc} headers.
3957
3958 @item S W
3959 @kindex S W (Summary)
3960 @findex gnus-summary-wide-reply-with-original
3961 Mail a wide reply to the current article and include the original
3962 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
3963 the process/prefix convention.
3964
3965 @item S o m
3966 @kindex S o m (Summary)
3967 @findex gnus-summary-mail-forward
3968 @c @icon{gnus-summary-mail-forward}
3969 Forward the current article to some other person
3970 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3971 headers of the forwarded article.
3972
3973 @item S m
3974 @itemx m
3975 @kindex m (Summary)
3976 @kindex S m (Summary)
3977 @findex gnus-summary-mail-other-window
3978 @c @icon{gnus-summary-mail-originate}
3979 Send a mail to some other person
3980 (@code{gnus-summary-mail-other-window}).
3981
3982 @item S D b
3983 @kindex S D b (Summary)
3984 @findex gnus-summary-resend-bounced-mail
3985 @cindex bouncing mail
3986 If you have sent a mail, but the mail was bounced back to you for some
3987 reason (wrong address, transient failure), you can use this command to
3988 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3989 will be popped into a mail buffer where you can edit the headers before
3990 sending the mail off again.  If you give a prefix to this command, and
3991 the bounced mail is a reply to some other mail, gnus will try to fetch
3992 that mail and display it for easy perusal of its headers.  This might
3993 very well fail, though.
3994
3995 @item S D r
3996 @kindex S D r (Summary)
3997 @findex gnus-summary-resend-message
3998 Not to be confused with the previous command,
3999 @code{gnus-summary-resend-message} will prompt you for an address to
4000 send the current message off to, and then send it to that place.  The
4001 headers of the message won't be altered---but lots of headers that say
4002 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
4003 means that you actually send a mail to someone that has a @code{To}
4004 header that (probably) points to yourself.  This will confuse people.
4005 So, natcherly you'll only do that if you're really eVIl.
4006
4007 This command is mainly used if you have several accounts and want to
4008 ship a mail to a different account of yours.  (If you're both
4009 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4010 to the @code{root} account, you may want to resend it to
4011 @code{postmaster}.  Ordnung muß sein!
4012
4013 This command understands the process/prefix convention
4014 (@pxref{Process/Prefix}).
4015
4016 @item S O m
4017 @kindex S O m (Summary)
4018 @findex gnus-uu-digest-mail-forward
4019 Digest the current series (@pxref{Decoding Articles}) and forward the
4020 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
4021 uses the process/prefix convention (@pxref{Process/Prefix}).
4022
4023 @item S M-c
4024 @kindex S M-c (Summary)
4025 @findex gnus-summary-mail-crosspost-complaint
4026 @cindex crossposting
4027 @cindex excessive crossposting
4028 Send a complaint about excessive crossposting to the author of the
4029 current article (@code{gnus-summary-mail-crosspost-complaint}).
4030
4031 @findex gnus-crosspost-complaint
4032 This command is provided as a way to fight back against the current
4033 crossposting pandemic that's sweeping Usenet.  It will compose a reply
4034 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
4035 command understands the process/prefix convention
4036 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4037
4038 @end table
4039
4040 Also @pxref{(message)Header Commands} for more information.
4041
4042
4043 @node Summary Post Commands
4044 @subsection Summary Post Commands
4045 @cindex post
4046 @cindex composing news
4047
4048 Commands for posting a news article:
4049
4050 @table @kbd
4051 @item S p
4052 @itemx a
4053 @kindex a (Summary)
4054 @kindex S p (Summary)
4055 @findex gnus-summary-post-news
4056 @c @icon{gnus-summary-post-news}
4057 Post an article to the current group
4058 (@code{gnus-summary-post-news}).
4059
4060 @item S f
4061 @itemx f
4062 @kindex f (Summary)
4063 @kindex S f (Summary)
4064 @findex gnus-summary-followup
4065 @c @icon{gnus-summary-followup}
4066 Post a followup to the current article (@code{gnus-summary-followup}).
4067
4068 @item S F
4069 @itemx F
4070 @kindex S F (Summary)
4071 @kindex F (Summary)
4072 @c @icon{gnus-summary-followup-with-original}
4073 @findex gnus-summary-followup-with-original
4074 Post a followup to the current article and include the original message
4075 (@code{gnus-summary-followup-with-original}).   This command uses the
4076 process/prefix convention.
4077
4078 @item S n
4079 @kindex S n (Summary)
4080 @findex gnus-summary-followup-to-mail
4081 Post a followup to the current article via news, even if you got the
4082 message through mail (@code{gnus-summary-followup-to-mail}).
4083
4084 @item S N
4085 @kindex S N (Summary)
4086 @findex gnus-summary-followup-to-mail-with-original
4087 Post a followup to the current article via news, even if you got the
4088 message through mail and include the original message
4089 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
4090 the process/prefix convention.
4091
4092 @item S o p
4093 @kindex S o p (Summary)
4094 @findex gnus-summary-post-forward
4095 Forward the current article to a newsgroup
4096 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
4097 headers of the forwarded article.
4098
4099 @item S O p
4100 @kindex S O p (Summary)
4101 @findex gnus-uu-digest-post-forward
4102 @cindex digests
4103 @cindex making digests
4104 Digest the current series and forward the result to a newsgroup
4105 (@code{gnus-uu-digest-mail-forward}).  This command uses the
4106 process/prefix convention.
4107
4108 @item S u
4109 @kindex S u (Summary)
4110 @findex gnus-uu-post-news
4111 @c @icon{gnus-uu-post-news}
4112 Uuencode a file, split it into parts, and post it as a series
4113 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4114 @end table
4115
4116 Also @pxref{(message)Header Commands} for more information.
4117
4118
4119 @node Canceling and Superseding
4120 @section Canceling Articles
4121 @cindex canceling articles
4122 @cindex superseding articles
4123
4124 Have you ever written something, and then decided that you really,
4125 really, really wish you hadn't posted that?
4126
4127 Well, you can't cancel mail, but you can cancel posts.
4128
4129 @findex gnus-summary-cancel-article
4130 @kindex C (Summary)
4131 @c @icon{gnus-summary-cancel-article}
4132 Find the article you wish to cancel (you can only cancel your own
4133 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
4134 c} (@code{gnus-summary-cancel-article}).  Your article will be
4135 canceled---machines all over the world will be deleting your article.
4136 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4137
4138 Be aware, however, that not all sites honor cancels, so your article may
4139 live on here and there, while most sites will delete the article in
4140 question.
4141
4142 Gnus will use the ``current'' select method when canceling.  If you
4143 want to use the standard posting method, use the @samp{a} symbolic
4144 prefix (@pxref{Symbolic Prefixes}).
4145
4146 If you discover that you have made some mistakes and want to do some
4147 corrections, you can post a @dfn{superseding} article that will replace
4148 your original article.
4149
4150 @findex gnus-summary-supersede-article
4151 @kindex S (Summary)
4152 Go to the original article and press @kbd{S s}
4153 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
4154 where you can edit the article all you want before sending it off the
4155 usual way.
4156
4157 The same goes for superseding as for canceling, only more so: Some
4158 sites do not honor superseding.  On those sites, it will appear that you
4159 have posted almost the same article twice.
4160
4161 If you have just posted the article, and change your mind right away,
4162 there is a trick you can use to cancel/supersede the article without
4163 waiting for the article to appear on your site first.  You simply return
4164 to the post buffer (which is called @code{*sent ...*}).  There you will
4165 find the article you just posted, with all the headers intact.  Change
4166 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4167 header by substituting one of those words for the word
4168 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
4169 you would do normally.  The previous article will be
4170 canceled/superseded.
4171
4172 Just remember, kids: There is no 'c' in 'supersede'.
4173
4174
4175 @node Marking Articles
4176 @section Marking Articles
4177 @cindex article marking
4178 @cindex article ticking
4179 @cindex marks
4180
4181 There are several marks you can set on an article.
4182
4183 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4184 neologism ohoy!) of the article.  Alphabetic marks generally mean
4185 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4186
4187 In addition, you also have marks that do not affect readedness.
4188
4189 @menu
4190 * Unread Articles::      Marks for unread articles.
4191 * Read Articles::        Marks for read articles.
4192 * Other Marks::          Marks that do not affect readedness.
4193 @end menu
4194
4195 @ifinfo
4196 There's a plethora of commands for manipulating these marks:
4197 @end ifinfo
4198
4199 @menu
4200 * Setting Marks::           How to set and remove marks.
4201 * Setting Process Marks::   How to mark articles for later processing.
4202 @end menu
4203
4204
4205 @node Unread Articles
4206 @subsection Unread Articles
4207
4208 The following marks mark articles as (kinda) unread, in one form or
4209 other.
4210
4211 @table @samp
4212 @item !
4213 @vindex gnus-ticked-mark
4214 Marked as ticked (@code{gnus-ticked-mark}).
4215
4216 @dfn{Ticked articles} are articles that will remain visible always.  If
4217 you see an article that you find interesting, or you want to put off
4218 reading it, or replying to it, until sometime later, you'd typically
4219 tick it.  However, articles can be expired, so if you want to keep an
4220 article forever, you'll have to make it persistent (@pxref{Persistent
4221 Articles}).
4222
4223 @item ?
4224 @vindex gnus-dormant-mark
4225 Marked as dormant (@code{gnus-dormant-mark}).
4226
4227 @dfn{Dormant articles} will only appear in the summary buffer if there
4228 are followups to it.  If you want to see them even if they don't have
4229 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4230
4231 @item SPACE
4232 @vindex gnus-unread-mark
4233 Marked as unread (@code{gnus-unread-mark}).
4234
4235 @dfn{Unread articles} are articles that haven't been read at all yet.
4236 @end table
4237
4238
4239 @node Read Articles
4240 @subsection Read Articles
4241 @cindex expirable mark
4242
4243 All the following marks mark articles as read.
4244
4245 @table @samp
4246
4247 @item r
4248 @vindex gnus-del-mark
4249 These are articles that the user has marked as read with the @kbd{d}
4250 command manually, more or less (@code{gnus-del-mark}).
4251
4252 @item R
4253 @vindex gnus-read-mark
4254 Articles that have actually been read (@code{gnus-read-mark}).
4255
4256 @item O
4257 @vindex gnus-ancient-mark
4258 Articles that were marked as read in previous sessions and are now
4259 @dfn{old} (@code{gnus-ancient-mark}).
4260
4261 @item K
4262 @vindex gnus-killed-mark
4263 Marked as killed (@code{gnus-killed-mark}).
4264
4265 @item X
4266 @vindex gnus-kill-file-mark
4267 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4268
4269 @item Y
4270 @vindex gnus-low-score-mark
4271 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4272
4273 @item C
4274 @vindex gnus-catchup-mark
4275 Marked as read by a catchup (@code{gnus-catchup-mark}).
4276
4277 @item G
4278 @vindex gnus-canceled-mark
4279 Canceled article (@code{gnus-canceled-mark})
4280
4281 @item F
4282 @vindex gnus-souped-mark
4283 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4284
4285 @item Q
4286 @vindex gnus-sparse-mark
4287 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4288 Threading}.
4289
4290 @item M
4291 @vindex gnus-duplicate-mark
4292 Article marked as read by duplicate suppression
4293 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4294
4295 @end table
4296
4297 All these marks just mean that the article is marked as read, really.
4298 They are interpreted differently when doing adaptive scoring, though.
4299
4300 One more special mark, though:
4301
4302 @table @samp
4303 @item E
4304 @vindex gnus-expirable-mark
4305 Marked as expirable (@code{gnus-expirable-mark}).
4306
4307 Marking articles as @dfn{expirable} (or have them marked as such
4308 automatically) doesn't make much sense in normal groups---a user doesn't
4309 control expiring of news articles, but in mail groups, for instance,
4310 articles marked as @dfn{expirable} can be deleted by gnus at
4311 any time.
4312 @end table
4313
4314
4315 @node Other Marks
4316 @subsection Other Marks
4317 @cindex process mark
4318 @cindex bookmarks
4319
4320 There are some marks that have nothing to do with whether the article is
4321 read or not.
4322
4323 @itemize @bullet
4324
4325 @item
4326 You can set a bookmark in the current article.  Say you are reading a
4327 long thesis on cats' urinary tracts, and have to go home for dinner
4328 before you've finished reading the thesis.  You can then set a bookmark
4329 in the article, and gnus will jump to this bookmark the next time it
4330 encounters the article.  @xref{Setting Marks}.
4331
4332 @item
4333 @vindex gnus-replied-mark
4334 All articles that you have replied to or made a followup to (i.e., have
4335 answered) will be marked with an @samp{A} in the second column
4336 (@code{gnus-replied-mark}).
4337
4338 @item
4339 @vindex gnus-cached-mark
4340 Articles stored in the article cache will be marked with an @samp{*} in
4341 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
4342
4343 @item
4344 @vindex gnus-saved-mark
4345 Articles ``saved'' (in some manner or other; not necessarily
4346 religiously) are marked with an @samp{S} in the second column
4347 (@code{gnus-saved-mark}).
4348
4349 @item
4350 @vindex gnus-not-empty-thread-mark
4351 @vindex gnus-empty-thread-mark
4352 If the @samp{%e} spec is used, the presence of threads or not will be
4353 marked with @code{gnus-not-empty-thread-mark} and
4354 @code{gnus-empty-thread-mark} in the third column, respectively.
4355
4356 @item
4357 @vindex gnus-process-mark
4358 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4359 variety of commands react to the presence of the process mark.  For
4360 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4361 all articles that have been marked with the process mark.  Articles
4362 marked with the process mark have a @samp{#} in the second column.
4363
4364 @end itemize
4365
4366 You might have noticed that most of these ``non-readedness'' marks
4367 appear in the second column by default.  So if you have a cached, saved,
4368 replied article that you have process-marked, what will that look like?
4369
4370 Nothing much.  The precedence rules go as follows: process -> cache ->
4371 replied -> saved.  So if the article is in the cache and is replied,
4372 you'll only see the cache mark and not the replied mark.
4373
4374
4375 @node Setting Marks
4376 @subsection Setting Marks
4377 @cindex setting marks
4378
4379 All the marking commands understand the numeric prefix.
4380
4381 @table @kbd
4382 @item M c
4383 @itemx M-u
4384 @kindex M c (Summary)
4385 @kindex M-u (Summary)
4386 @findex gnus-summary-clear-mark-forward
4387 @cindex mark as unread
4388 Clear all readedness-marks from the current article
4389 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4390 article as unread.
4391
4392 @item M t
4393 @itemx !
4394 @kindex ! (Summary)
4395 @kindex M t (Summary)
4396 @findex gnus-summary-tick-article-forward
4397 Tick the current article (@code{gnus-summary-tick-article-forward}).
4398 @xref{Article Caching}.
4399
4400 @item M ?
4401 @itemx ?
4402 @kindex ? (Summary)
4403 @kindex M ? (Summary)
4404 @findex gnus-summary-mark-as-dormant
4405 Mark the current article as dormant
4406 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
4407
4408 @item M d
4409 @itemx d
4410 @kindex M d (Summary)
4411 @kindex d (Summary)
4412 @findex gnus-summary-mark-as-read-forward
4413 Mark the current article as read
4414 (@code{gnus-summary-mark-as-read-forward}).
4415
4416 @item D
4417 @kindex D (Summary)
4418 @findex gnus-summary-mark-as-read-backward
4419 Mark the current article as read and move point to the previous line
4420 (@code{gnus-summary-mark-as-read-backward}).
4421
4422 @item M k
4423 @itemx k
4424 @kindex k (Summary)
4425 @kindex M k (Summary)
4426 @findex gnus-summary-kill-same-subject-and-select
4427 Mark all articles that have the same subject as the current one as read,
4428 and then select the next unread article
4429 (@code{gnus-summary-kill-same-subject-and-select}).
4430
4431 @item M K
4432 @itemx C-k
4433 @kindex M K (Summary)
4434 @kindex C-k (Summary)
4435 @findex gnus-summary-kill-same-subject
4436 Mark all articles that have the same subject as the current one as read
4437 (@code{gnus-summary-kill-same-subject}).
4438
4439 @item M C
4440 @kindex M C (Summary)
4441 @findex gnus-summary-catchup
4442 @c @icon{gnus-summary-catchup}
4443 Mark all unread articles as read (@code{gnus-summary-catchup}).
4444
4445 @item M C-c
4446 @kindex M C-c (Summary)
4447 @findex gnus-summary-catchup-all
4448 Mark all articles in the group as read---even the ticked and dormant
4449 articles (@code{gnus-summary-catchup-all}).
4450
4451 @item M H
4452 @kindex M H (Summary)
4453 @findex gnus-summary-catchup-to-here
4454 Catchup the current group to point
4455 (@code{gnus-summary-catchup-to-here}).
4456
4457 @item C-w
4458 @kindex C-w (Summary)
4459 @findex gnus-summary-mark-region-as-read
4460 Mark all articles between point and mark as read
4461 (@code{gnus-summary-mark-region-as-read}).
4462
4463 @item M V k
4464 @kindex M V k (Summary)
4465 @findex gnus-summary-kill-below
4466 Kill all articles with scores below the default score (or below the
4467 numeric prefix) (@code{gnus-summary-kill-below}).
4468
4469 @item M e
4470 @itemx E
4471 @kindex M e (Summary)
4472 @kindex E (Summary)
4473 @findex gnus-summary-mark-as-expirable
4474 Mark the current article as expirable
4475 (@code{gnus-summary-mark-as-expirable}).
4476
4477 @item M b
4478 @kindex M b (Summary)
4479 @findex gnus-summary-set-bookmark
4480 Set a bookmark in the current article
4481 (@code{gnus-summary-set-bookmark}).
4482
4483 @item M B
4484 @kindex M B (Summary)
4485 @findex gnus-summary-remove-bookmark
4486 Remove the bookmark from the current article
4487 (@code{gnus-summary-remove-bookmark}).
4488
4489 @item M V c
4490 @kindex M V c (Summary)
4491 @findex gnus-summary-clear-above
4492 Clear all marks from articles with scores over the default score (or
4493 over the numeric prefix) (@code{gnus-summary-clear-above}).
4494
4495 @item M V u
4496 @kindex M V u (Summary)
4497 @findex gnus-summary-tick-above
4498 Tick all articles with scores over the default score (or over the
4499 numeric prefix) (@code{gnus-summary-tick-above}).
4500
4501 @item M V m
4502 @kindex M V m (Summary)
4503 @findex gnus-summary-mark-above
4504 Prompt for a mark, and mark all articles with scores over the default
4505 score (or over the numeric prefix) with this mark
4506 (@code{gnus-summary-clear-above}).
4507 @end table
4508
4509 @vindex gnus-summary-goto-unread
4510 The @code{gnus-summary-goto-unread} variable controls what action should
4511 be taken after setting a mark.  If non-@code{nil}, point will move to
4512 the next/previous unread article.  If @code{nil}, point will just move
4513 one line up or down.  As a special case, if this variable is
4514 @code{never}, all the marking commands as well as other commands (like
4515 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4516 The default is @code{t}.
4517
4518
4519 @node Setting Process Marks
4520 @subsection Setting Process Marks
4521 @cindex setting process marks
4522
4523 @table @kbd
4524
4525 @item M P p
4526 @itemx #
4527 @kindex # (Summary)
4528 @kindex M P p (Summary)
4529 @findex gnus-summary-mark-as-processable
4530 Mark the current article with the process mark
4531 (@code{gnus-summary-mark-as-processable}).
4532 @findex gnus-summary-unmark-as-processable
4533
4534 @item M P u
4535 @itemx M-#
4536 @kindex M P u (Summary)
4537 @kindex M-# (Summary)
4538 Remove the process mark, if any, from the current article
4539 (@code{gnus-summary-unmark-as-processable}).
4540
4541 @item M P U
4542 @kindex M P U (Summary)
4543 @findex gnus-summary-unmark-all-processable
4544 Remove the process mark from all articles
4545 (@code{gnus-summary-unmark-all-processable}).
4546
4547 @item M P i
4548 @kindex M P i (Summary)
4549 @findex gnus-uu-invert-processable
4550 Invert the list of process marked articles
4551 (@code{gnus-uu-invert-processable}).
4552
4553 @item M P R
4554 @kindex M P R (Summary)
4555 @findex gnus-uu-mark-by-regexp
4556 Mark articles that have a @code{Subject} header that matches a regular
4557 expression (@code{gnus-uu-mark-by-regexp}).
4558
4559 @item M P r
4560 @kindex M P r (Summary)
4561 @findex gnus-uu-mark-region
4562 Mark articles in region (@code{gnus-uu-mark-region}).
4563
4564 @item M P t
4565 @kindex M P t (Summary)
4566 @findex gnus-uu-mark-thread
4567 Mark all articles in the current (sub)thread
4568 (@code{gnus-uu-mark-thread}).
4569
4570 @item M P T
4571 @kindex M P T (Summary)
4572 @findex gnus-uu-unmark-thread
4573 Unmark all articles in the current (sub)thread
4574 (@code{gnus-uu-unmark-thread}).
4575
4576 @item M P v
4577 @kindex M P v (Summary)
4578 @findex gnus-uu-mark-over
4579 Mark all articles that have a score above the prefix argument
4580 (@code{gnus-uu-mark-over}).
4581
4582 @item M P s
4583 @kindex M P s (Summary)
4584 @findex gnus-uu-mark-series
4585 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4586
4587 @item M P S
4588 @kindex M P S (Summary)
4589 @findex gnus-uu-mark-sparse
4590 Mark all series that have already had some articles marked
4591 (@code{gnus-uu-mark-sparse}).
4592
4593 @item M P a
4594 @kindex M P a (Summary)
4595 @findex gnus-uu-mark-all
4596 Mark all articles in series order (@code{gnus-uu-mark-series}).
4597
4598 @item M P b
4599 @kindex M P b (Summary)
4600 @findex gnus-uu-mark-buffer
4601 Mark all articles in the buffer in the order they appear
4602 (@code{gnus-uu-mark-buffer}).
4603
4604 @item M P k
4605 @kindex M P k (Summary)
4606 @findex gnus-summary-kill-process-mark
4607 Push the current process mark set onto the stack and unmark all articles
4608 (@code{gnus-summary-kill-process-mark}).
4609
4610 @item M P y
4611 @kindex M P y (Summary)
4612 @findex gnus-summary-yank-process-mark
4613 Pop the previous process mark set from the stack and restore it
4614 (@code{gnus-summary-yank-process-mark}).
4615
4616 @item M P w
4617 @kindex M P w (Summary)
4618 @findex gnus-summary-save-process-mark
4619 Push the current process mark set onto the stack
4620 (@code{gnus-summary-save-process-mark}).
4621
4622 @end table
4623
4624
4625 @node Limiting
4626 @section Limiting
4627 @cindex limiting
4628
4629 It can be convenient to limit the summary buffer to just show some
4630 subset of the articles currently in the group.  The effect most limit
4631 commands have is to remove a few (or many) articles from the summary
4632 buffer.
4633
4634 All limiting commands work on subsets of the articles already fetched
4635 from the servers.  None of these commands query the server for
4636 additional articles.
4637
4638 @table @kbd
4639
4640 @item / /
4641 @itemx / s
4642 @kindex / / (Summary)
4643 @findex gnus-summary-limit-to-subject
4644 Limit the summary buffer to articles that match some subject
4645 (@code{gnus-summary-limit-to-subject}).
4646
4647 @item / a
4648 @kindex / a (Summary)
4649 @findex gnus-summary-limit-to-author
4650 Limit the summary buffer to articles that match some author
4651 (@code{gnus-summary-limit-to-author}).
4652
4653 @item / u
4654 @itemx x
4655 @kindex / u (Summary)
4656 @kindex x (Summary)
4657 @findex gnus-summary-limit-to-unread
4658 Limit the summary buffer to articles not marked as read
4659 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4660 buffer to articles strictly unread.  This means that ticked and
4661 dormant articles will also be excluded.
4662
4663 @item / m
4664 @kindex / m (Summary)
4665 @findex gnus-summary-limit-to-marks
4666 Ask for a mark and then limit to all articles that have been marked
4667 with that mark (@code{gnus-summary-limit-to-marks}).
4668
4669 @item / t
4670 @kindex / t (Summary)
4671 @findex gnus-summary-limit-to-age
4672 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4673 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4674 articles younger than that number of days.
4675
4676 @item / n
4677 @kindex / n (Summary)
4678 @findex gnus-summary-limit-to-articles
4679 Limit the summary buffer to the current article
4680 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4681 convention (@pxref{Process/Prefix}).
4682
4683 @item / w
4684 @kindex / w (Summary)
4685 @findex gnus-summary-pop-limit
4686 Pop the previous limit off the stack and restore it
4687 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4688 the stack.
4689
4690 @item / v
4691 @kindex / v (Summary)
4692 @findex gnus-summary-limit-to-score
4693 Limit the summary buffer to articles that have a score at or above some
4694 score (@code{gnus-summary-limit-to-score}).
4695
4696 @item / E
4697 @itemx M S
4698 @kindex M S (Summary)
4699 @kindex / E (Summary)
4700 @findex gnus-summary-limit-include-expunged
4701 Include all expunged articles in the limit
4702 (@code{gnus-summary-limit-include-expunged}).
4703
4704 @item / D
4705 @kindex / D (Summary)
4706 @findex gnus-summary-limit-include-dormant
4707 Include all dormant articles in the limit
4708 (@code{gnus-summary-limit-include-dormant}).
4709
4710 @item / *
4711 @kindex / * (Summary)
4712 @findex gnus-summary-limit-include-cached
4713 Include all cached articles in the limit
4714 (@code{gnus-summary-limit-include-cached}).
4715
4716 @item / d
4717 @kindex / d (Summary)
4718 @findex gnus-summary-limit-exclude-dormant
4719 Exclude all dormant articles from the limit
4720 (@code{gnus-summary-limit-exclude-dormant}).
4721
4722 @item / M
4723 @kindex / M (Summary)
4724 @findex gnus-summary-limit-exclude-marks
4725 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}). 
4726
4727 @item / T
4728 @kindex / T (Summary)
4729 @findex gnus-summary-limit-include-thread
4730 Include all the articles in the current thread in the limit.
4731
4732 @item / c
4733 @kindex / c (Summary)
4734 @findex gnus-summary-limit-exclude-childless-dormant
4735 Exclude all dormant articles that have no children from the limit
4736 (@code{gnus-summary-limit-exclude-childless-dormant}).
4737
4738 @item / C
4739 @kindex / C (Summary)
4740 @findex gnus-summary-limit-mark-excluded-as-read
4741 Mark all excluded unread articles as read
4742 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4743 also mark excluded ticked and dormant articles as read.
4744
4745 @end table
4746
4747
4748 @node Threading
4749 @section Threading
4750 @cindex threading
4751 @cindex article threading
4752
4753 Gnus threads articles by default.  @dfn{To thread} is to put responses
4754 to articles directly after the articles they respond to---in a
4755 hierarchical fashion.
4756
4757 Threading is done by looking at the @code{References} headers of the
4758 articles.  In a perfect world, this would be enough to build pretty
4759 trees, but unfortunately, the @code{References} header is often broken
4760 or simply missing.  Weird news propagation excarcerbates the problem,
4761 so one has to employ other heuristics to get pleasing results.  A
4762 plethora of approaches exists, as detailed in horrible detail in
4763 @pxref{Customizing Threading}.
4764
4765 First, a quick overview of the concepts:
4766
4767 @table @dfn
4768 @item root
4769 The top-most article in a thread; the first article in the thread.
4770
4771 @item thread
4772 A tree-like article structure.
4773
4774 @item sub-thread
4775 A small(er) section of this tree-like structure.
4776
4777 @item loose threads
4778 Threads often lose their roots due to article expiry, or due to the root
4779 already having been read in a previous session, and not displayed in the
4780 summary buffer.  We then typically have many sub-threads that really
4781 belong to one thread, but are without connecting roots.  These are
4782 called loose threads.
4783
4784 @item thread gathering
4785 An attempt to gather loose threads into bigger threads.
4786
4787 @item sparse threads
4788 A thread where the missing articles have been ``guessed'' at, and are
4789 displayed as empty lines in the summary buffer.
4790
4791 @end table
4792
4793
4794 @menu
4795 * Customizing Threading::     Variables you can change to affect the threading.
4796 * Thread Commands::           Thread based commands in the summary buffer.
4797 @end menu
4798
4799
4800 @node Customizing Threading
4801 @subsection Customizing Threading
4802 @cindex customizing threading
4803
4804 @menu
4805 * Loose Threads::        How gnus gathers loose threads into bigger threads.
4806 * Filling In Threads::   Making the threads displayed look fuller.
4807 * More Threading::       Even more variables for fiddling with threads.
4808 * Low-Level Threading::  You thought it was over... but you were wrong!
4809 @end menu
4810
4811
4812 @node Loose Threads
4813 @subsubsection Loose Threads
4814 @cindex <
4815 @cindex >
4816 @cindex loose threads
4817
4818 @table @code
4819 @item gnus-summary-make-false-root
4820 @vindex gnus-summary-make-false-root
4821 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
4822 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4823 Yup.)  Loose subtrees occur when the real root has expired, or you've
4824 read or killed the root in a previous session.
4825
4826 When there is no real root of a thread, gnus will have to fudge
4827 something.  This variable says what fudging method gnus should use.
4828 There are four possible values:
4829
4830 @iftex
4831 @iflatex
4832 \gnusfigure{The Summary Buffer}{390}{
4833 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4834 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4835 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4836 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4837 }
4838 @end iflatex
4839 @end iftex
4840
4841 @cindex adopting articles
4842
4843 @table @code
4844
4845 @item adopt
4846 Gnus will make the first of the orphaned articles the parent.  This
4847 parent will adopt all the other articles.  The adopted articles will be
4848 marked as such by pointy brackets (@samp{<>}) instead of the standard
4849 square brackets (@samp{[]}).  This is the default method.
4850
4851 @item dummy
4852 @vindex gnus-summary-dummy-line-format
4853 Gnus will create a dummy summary line that will pretend to be the
4854 parent.  This dummy line does not correspond to any real article, so
4855 selecting it will just select the first real article after the dummy
4856 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4857 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4858 which is the subject of the article.  @xref{Formatting Variables}.
4859
4860 @item empty
4861 Gnus won't actually make any article the parent, but simply leave the
4862 subject field of all orphans except the first empty.  (Actually, it will
4863 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4864 Buffer Format}).)
4865
4866 @item none
4867 Don't make any article parent at all.  Just gather the threads and
4868 display them after one another.
4869
4870 @item nil
4871 Don't gather loose threads.
4872 @end table
4873
4874 @item gnus-summary-gather-subject-limit
4875 @vindex gnus-summary-gather-subject-limit
4876 Loose threads are gathered by comparing subjects of articles.  If this
4877 variable is @code{nil}, gnus requires an exact match between the
4878 subjects of the loose threads before gathering them into one big
4879 super-thread.  This might be too strict a requirement, what with the
4880 presence of stupid newsreaders that chop off long subject lines.  If
4881 you think so, set this variable to, say, 20 to require that only the
4882 first 20 characters of the subjects have to match.  If you set this
4883 variable to a really low number, you'll find that gnus will gather
4884 everything in sight into one thread, which isn't very helpful.
4885
4886 @cindex fuzzy article gathering
4887 If you set this variable to the special value @code{fuzzy}, gnus will
4888 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4889 Matching}).
4890
4891 @item gnus-simplify-subject-fuzzy-regexp
4892 @vindex gnus-simplify-subject-fuzzy-regexp
4893 This can either be a regular expression or list of regular expressions
4894 that match strings that will be removed from subjects if fuzzy subject
4895 simplification is used.
4896
4897 @item gnus-simplify-ignored-prefixes
4898 @vindex gnus-simplify-ignored-prefixes
4899 If you set @code{gnus-summary-gather-subject-limit} to something as low
4900 as 10, you might consider setting this variable to something sensible:
4901
4902 @c Written by Michael Ernst <mernst@cs.rice.edu>
4903 @lisp
4904 (setq gnus-simplify-ignored-prefixes
4905       (concat
4906        "\\`\\[?\\("
4907        (mapconcat
4908         'identity
4909         '("looking"
4910           "wanted" "followup" "summary\\( of\\)?"
4911           "help" "query" "problem" "question"
4912           "answer" "reference" "announce"
4913           "How can I" "How to" "Comparison of"
4914           ;; ...
4915           )
4916         "\\|")
4917        "\\)\\s *\\("
4918        (mapconcat 'identity
4919                   '("for" "for reference" "with" "about")
4920                   "\\|")
4921        "\\)?\\]?:?[ \t]*"))
4922 @end lisp
4923
4924 All words that match this regexp will be removed before comparing two
4925 subjects.
4926
4927 @item gnus-simplify-subject-functions
4928 @vindex gnus-simplify-subject-functions
4929 If non-@code{nil}, this variable overrides
4930 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4931 list of functions to apply to the @code{Subject} string iteratively to
4932 arrive at the simplified version of the string.
4933
4934 Useful functions to put in this list include:
4935
4936 @table @code
4937 @item gnus-simplify-subject-re
4938 @findex gnus-simplify-subject-re
4939 Strip the leading @samp{Re:}.
4940
4941 @item gnus-simplify-subject-fuzzy
4942 @findex gnus-simplify-subject-fuzzy
4943 Simplify fuzzily.
4944
4945 @item gnus-simplify-whitespace
4946 @findex gnus-simplify-whitespace
4947 Remove excessive whitespace.
4948 @end table
4949
4950 You may also write your own functions, of course.
4951
4952
4953 @item gnus-summary-gather-exclude-subject
4954 @vindex gnus-summary-gather-exclude-subject
4955 Since loose thread gathering is done on subjects only, that might lead
4956 to many false hits, especially with certain common subjects like
4957 @samp{} and @samp{(none)}.  To make the situation slightly better,
4958 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4959 what subjects should be excluded from the gathering process.@*
4960 The default is @samp{^ *$\\|^(none)$}.
4961
4962 @item gnus-summary-thread-gathering-function
4963 @vindex gnus-summary-thread-gathering-function
4964 Gnus gathers threads by looking at @code{Subject} headers.  This means
4965 that totally unrelated articles may end up in the same ``thread'', which
4966 is confusing.  An alternate approach is to look at all the
4967 @code{Message-ID}s in all the @code{References} headers to find matches.
4968 This will ensure that no gathered threads ever include unrelated
4969 articles, but it also means that people who have posted with broken
4970 newsreaders won't be gathered properly.  The choice is yours---plague or
4971 cholera:
4972
4973 @table @code
4974 @item gnus-gather-threads-by-subject
4975 @findex gnus-gather-threads-by-subject
4976 This function is the default gathering function and looks at
4977 @code{Subject}s exclusively.
4978
4979 @item gnus-gather-threads-by-references
4980 @findex gnus-gather-threads-by-references
4981 This function looks at @code{References} headers exclusively.
4982 @end table
4983
4984 If you want to test gathering by @code{References}, you could say
4985 something like:
4986
4987 @lisp
4988 (setq gnus-summary-thread-gathering-function
4989       'gnus-gather-threads-by-references)
4990 @end lisp
4991
4992 @end table
4993
4994
4995 @node Filling In Threads
4996 @subsubsection Filling In Threads
4997
4998 @table @code
4999 @item gnus-fetch-old-headers
5000 @vindex gnus-fetch-old-headers
5001 If non-@code{nil}, gnus will attempt to build old threads by fetching
5002 more old headers---headers to articles marked as read.  If you
5003 would like to display as few summary lines as possible, but still
5004 connect as many loose threads as possible, you should set this variable
5005 to @code{some} or a number.  If you set it to a number, no more than
5006 that number of extra old headers will be fetched.  In either case,
5007 fetching old headers only works if the backend you are using carries
5008 overview files---this would normally be @code{nntp}, @code{nnspool} and
5009 @code{nnml}.  Also remember that if the root of the thread has been
5010 expired by the server, there's not much gnus can do about that.
5011
5012 This variable can also be set to @code{invisible}.  This won't have any
5013 visible effects, but is useful if you use the @kbd{A T} command a lot
5014 (@pxref{Finding the Parent}).
5015
5016 @item gnus-build-sparse-threads
5017 @vindex gnus-build-sparse-threads
5018 Fetching old headers can be slow.  A low-rent similar effect can be
5019 gotten by setting this variable to @code{some}.  Gnus will then look at
5020 the complete @code{References} headers of all articles and try to string
5021 together articles that belong in the same thread.  This will leave
5022 @dfn{gaps} in the threading display where gnus guesses that an article
5023 is missing from the thread.  (These gaps appear like normal summary
5024 lines.  If you select a gap, gnus will try to fetch the article in
5025 question.)  If this variable is @code{t}, gnus will display all these
5026 ``gaps'' without regard for whether they are useful for completing the
5027 thread or not.  Finally, if this variable is @code{more}, gnus won't cut
5028 off sparse leaf nodes that don't lead anywhere.  This variable is
5029 @code{nil} by default.
5030
5031 @end table
5032
5033
5034 @node More Threading
5035 @subsubsection More Threading
5036
5037 @table @code
5038 @item gnus-show-threads
5039 @vindex gnus-show-threads
5040 If this variable is @code{nil}, no threading will be done, and all of
5041 the rest of the variables here will have no effect.  Turning threading
5042 off will speed group selection up a bit, but it is sure to make reading
5043 slower and more awkward.
5044
5045 @item gnus-thread-hide-subtree
5046 @vindex gnus-thread-hide-subtree
5047 If non-@code{nil}, all threads will be hidden when the summary buffer is
5048 generated.
5049
5050 @item gnus-thread-expunge-below
5051 @vindex gnus-thread-expunge-below
5052 All threads that have a total score (as defined by
5053 @code{gnus-thread-score-function}) less than this number will be
5054 expunged.  This variable is @code{nil} by default, which means that no
5055 threads are expunged.
5056
5057 @item gnus-thread-hide-killed
5058 @vindex gnus-thread-hide-killed
5059 if you kill a thread and this variable is non-@code{nil}, the subtree
5060 will be hidden.
5061
5062 @item gnus-thread-ignore-subject
5063 @vindex gnus-thread-ignore-subject
5064 Sometimes somebody changes the subject in the middle of a thread.  If
5065 this variable is non-@code{nil}, the subject change is ignored.  If it
5066 is @code{nil}, which is the default, a change in the subject will result
5067 in a new thread.
5068
5069 @item gnus-thread-indent-level
5070 @vindex gnus-thread-indent-level
5071 This is a number that says how much each sub-thread should be indented.
5072 The default is 4.
5073
5074 @end table
5075
5076
5077 @node Low-Level Threading
5078 @subsubsection Low-Level Threading
5079
5080 @table @code
5081
5082 @item gnus-parse-headers-hook
5083 @vindex gnus-parse-headers-hook
5084 Hook run before parsing any headers.  The default value is
5085 @code{(gnus-set-summary-default-charset)}, which sets up local value of
5086 @code{default-mime-charset} in summary buffer based on variable
5087 @code{gnus-newsgroup-default-charset-alist}.
5088
5089 @item gnus-alter-header-function
5090 @vindex gnus-alter-header-function
5091 If non-@code{nil}, this function will be called to allow alteration of
5092 article header structures.  The function is called with one parameter,
5093 the article header vector, which it may alter in any way.  For instance,
5094 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5095 in systematic ways (by adding prefixes and such), you can use this
5096 variable to un-scramble the @code{Message-ID}s so that they are more
5097 meaningful.  Here's one example:
5098
5099 @lisp
5100 (setq gnus-alter-header-function 'my-alter-message-id)
5101
5102 (defun my-alter-message-id (header)
5103   (let ((id (mail-header-id header)))
5104     (when (string-match
5105            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5106       (mail-header-set-id
5107        (concat (match-string 1 id) "@@" (match-string 2 id))
5108        header))))
5109 @end lisp
5110
5111 @end table
5112
5113
5114 @node Thread Commands
5115 @subsection Thread Commands
5116 @cindex thread commands
5117
5118 @table @kbd
5119
5120 @item T k
5121 @itemx M-C-k
5122 @kindex T k (Summary)
5123 @kindex M-C-k (Summary)
5124 @findex gnus-summary-kill-thread
5125 Mark all articles in the current (sub-)thread as read
5126 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
5127 remove all marks instead.  If the prefix argument is negative, tick
5128 articles instead.
5129
5130 @item T l
5131 @itemx M-C-l
5132 @kindex T l (Summary)
5133 @kindex M-C-l (Summary)
5134 @findex gnus-summary-lower-thread
5135 Lower the score of the current (sub-)thread
5136 (@code{gnus-summary-lower-thread}).
5137
5138 @item T i
5139 @kindex T i (Summary)
5140 @findex gnus-summary-raise-thread
5141 Increase the score of the current (sub-)thread
5142 (@code{gnus-summary-raise-thread}).
5143
5144 @item T #
5145 @kindex T # (Summary)
5146 @findex gnus-uu-mark-thread
5147 Set the process mark on the current (sub-)thread
5148 (@code{gnus-uu-mark-thread}).
5149
5150 @item T M-#
5151 @kindex T M-# (Summary)
5152 @findex gnus-uu-unmark-thread
5153 Remove the process mark from the current (sub-)thread
5154 (@code{gnus-uu-unmark-thread}).
5155
5156 @item T T
5157 @kindex T T (Summary)
5158 @findex gnus-summary-toggle-threads
5159 Toggle threading (@code{gnus-summary-toggle-threads}).
5160
5161 @item T s
5162 @kindex T s (Summary)
5163 @findex gnus-summary-show-thread
5164 Expose the (sub-)thread hidden under the current article, if any
5165 (@code{gnus-summary-show-thread}).
5166
5167 @item T h
5168 @kindex T h (Summary)
5169 @findex gnus-summary-hide-thread
5170 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5171
5172 @item T S
5173 @kindex T S (Summary)
5174 @findex gnus-summary-show-all-threads
5175 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5176
5177 @item T H
5178 @kindex T H (Summary)
5179 @findex gnus-summary-hide-all-threads
5180 Hide all threads (@code{gnus-summary-hide-all-threads}).
5181
5182 @item T t
5183 @kindex T t (Summary)
5184 @findex gnus-summary-rethread-current
5185 Re-thread the current article's thread
5186 (@code{gnus-summary-rethread-current}).  This works even when the
5187 summary buffer is otherwise unthreaded.
5188
5189 @item T ^
5190 @kindex T ^ (Summary)
5191 @findex gnus-summary-reparent-thread
5192 Make the current article the child of the marked (or previous) article
5193 (@code{gnus-summary-reparent-thread}).
5194
5195 @end table
5196
5197 The following commands are thread movement commands.  They all
5198 understand the numeric prefix.
5199
5200 @table @kbd
5201
5202 @item T n
5203 @kindex T n (Summary)
5204 @findex gnus-summary-next-thread
5205 Go to the next thread (@code{gnus-summary-next-thread}).
5206
5207 @item T p
5208 @kindex T p (Summary)
5209 @findex gnus-summary-prev-thread
5210 Go to the previous thread (@code{gnus-summary-prev-thread}).
5211
5212 @item T d
5213 @kindex T d (Summary)
5214 @findex gnus-summary-down-thread
5215 Descend the thread (@code{gnus-summary-down-thread}).
5216
5217 @item T u
5218 @kindex T u (Summary)
5219 @findex gnus-summary-up-thread
5220 Ascend the thread (@code{gnus-summary-up-thread}).
5221
5222 @item T o
5223 @kindex T o (Summary)
5224 @findex gnus-summary-top-thread
5225 Go to the top of the thread (@code{gnus-summary-top-thread}).
5226 @end table
5227
5228 @vindex gnus-thread-operation-ignore-subject
5229 If you ignore subject while threading, you'll naturally end up with
5230 threads that have several different subjects in them.  If you then issue
5231 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5232 wish to kill the entire thread, but just those parts of the thread that
5233 have the same subject as the current article.  If you like this idea,
5234 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
5235 is non-@code{nil} (which it is by default), subjects will be ignored
5236 when doing thread commands.  If this variable is @code{nil}, articles in
5237 the same thread with different subjects will not be included in the
5238 operation in question.  If this variable is @code{fuzzy}, only articles
5239 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5240 Matching}).
5241
5242
5243 @node Sorting
5244 @section Sorting
5245
5246 @findex gnus-thread-sort-by-total-score
5247 @findex gnus-thread-sort-by-date
5248 @findex gnus-thread-sort-by-score
5249 @findex gnus-thread-sort-by-subject
5250 @findex gnus-thread-sort-by-author
5251 @findex gnus-thread-sort-by-number
5252 @vindex gnus-thread-sort-functions
5253 If you are using a threaded summary display, you can sort the threads by
5254 setting @code{gnus-thread-sort-functions}, which can be either a single
5255 function, a list of functions, or a list containing functions and
5256 @code{(not some-function)} elements.
5257
5258 By default, sorting is done on article numbers.  Ready-made sorting
5259 predicate functions include @code{gnus-thread-sort-by-number},
5260 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5261 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5262 @code{gnus-thread-sort-by-total-score}.
5263
5264 Each function takes two threads and returns non-@code{nil} if the first
5265 thread should be sorted before the other.  Note that sorting really is
5266 normally done by looking only at the roots of each thread.
5267
5268 If you use more than one function, the primary sort key should be the
5269 last function in the list.  You should probably always include
5270 @code{gnus-thread-sort-by-number} in the list of sorting
5271 functions---preferably first.  This will ensure that threads that are
5272 equal with respect to the other sort criteria will be displayed in
5273 ascending article order.
5274
5275 If you would like to sort by reverse score, then by subject, and finally
5276 by number, you could do something like:
5277
5278 @lisp
5279 (setq gnus-thread-sort-functions
5280       '(gnus-thread-sort-by-number
5281         gnus-thread-sort-by-subject
5282         (reverse gnus-thread-sort-by-total-score)))
5283 @end lisp
5284
5285 The threads that have highest score will be displayed first in the
5286 summary buffer.  When threads have the same score, they will be sorted
5287 alphabetically.  The threads that have the same score and the same
5288 subject will be sorted by number, which is (normally) the sequence in
5289 which the articles arrived.
5290
5291 If you want to sort by score and then reverse arrival order, you could
5292 say something like:
5293
5294 @lisp
5295 (setq gnus-thread-sort-functions
5296       '((lambda (t1 t2)
5297           (not (gnus-thread-sort-by-number t1 t2)))
5298         gnus-thread-sort-by-score))
5299 @end lisp
5300
5301 @vindex gnus-thread-score-function
5302 The function in the @code{gnus-thread-score-function} variable (default
5303 @code{+}) is used for calculating the total score of a thread.  Useful
5304 functions might be @code{max}, @code{min}, or squared means, or whatever
5305 tickles your fancy.
5306
5307 @findex gnus-article-sort-functions
5308 @findex gnus-article-sort-by-date
5309 @findex gnus-article-sort-by-score
5310 @findex gnus-article-sort-by-subject
5311 @findex gnus-article-sort-by-author
5312 @findex gnus-article-sort-by-number
5313 If you are using an unthreaded display for some strange reason or other,
5314 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5315 It is very similar to the @code{gnus-thread-sort-functions}, except that
5316 it uses slightly different functions for article comparison.  Available
5317 sorting predicate functions are @code{gnus-article-sort-by-number},
5318 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5319 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5320
5321 If you want to sort an unthreaded summary display by subject, you could
5322 say something like:
5323
5324 @lisp
5325 (setq gnus-article-sort-functions
5326       '(gnus-article-sort-by-number
5327         gnus-article-sort-by-subject))
5328 @end lisp
5329
5330
5331
5332 @node Asynchronous Fetching
5333 @section Asynchronous Article Fetching
5334 @cindex asynchronous article fetching
5335 @cindex article pre-fetch
5336 @cindex pre-fetch
5337
5338 If you read your news from an @sc{nntp} server that's far away, the
5339 network latencies may make reading articles a chore.  You have to wait
5340 for a while after pressing @kbd{n} to go to the next article before the
5341 article appears.  Why can't gnus just go ahead and fetch the article
5342 while you are reading the previous one?  Why not, indeed.
5343
5344 First, some caveats.  There are some pitfalls to using asynchronous
5345 article fetching, especially the way gnus does it.
5346
5347 Let's say you are reading article 1, which is short, and article 2 is
5348 quite long, and you are not interested in reading that.  Gnus does not
5349 know this, so it goes ahead and fetches article 2.  You decide to read
5350 article 3, but since gnus is in the process of fetching article 2, the
5351 connection is blocked.
5352
5353 To avoid these situations, gnus will open two (count 'em two)
5354 connections to the server.  Some people may think this isn't a very nice
5355 thing to do, but I don't see any real alternatives.  Setting up that
5356 extra connection takes some time, so gnus startup will be slower.
5357
5358 Gnus will fetch more articles than you will read.  This will mean that
5359 the link between your machine and the @sc{nntp} server will become more
5360 loaded than if you didn't use article pre-fetch.  The server itself will
5361 also become more loaded---both with the extra article requests, and the
5362 extra connection.
5363
5364 Ok, so now you know that you shouldn't really use this thing...  unless
5365 you really want to.
5366
5367 @vindex gnus-asynchronous
5368 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5369 happen automatically.
5370
5371 @vindex gnus-use-article-prefetch
5372 You can control how many articles are to be pre-fetched by setting
5373 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5374 that when you read an article in the group, the backend will pre-fetch
5375 the next 30 articles.  If this variable is @code{t}, the backend will
5376 pre-fetch all the articles it can without bound.  If it is
5377 @code{nil}, no pre-fetching will be done.
5378
5379 @vindex gnus-async-prefetch-article-p
5380 @findex gnus-async-read-p
5381 There are probably some articles that you don't want to pre-fetch---read
5382 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5383 return non-@code{nil} when the article in question is to be
5384 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5385 @code{nil} on read articles.  The function is called with an article
5386 data structure as the only parameter.
5387
5388 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5389
5390 @lisp
5391 (defun my-async-short-unread-p (data)
5392   "Return non-nil for short, unread articles."
5393   (and (gnus-data-unread-p data)
5394        (< (mail-header-lines (gnus-data-header data))
5395           100)))
5396
5397 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5398 @end lisp
5399
5400 These functions will be called many, many times, so they should
5401 preferably be short and sweet to avoid slowing down gnus too much.
5402 It's probably a good idea to byte-compile things like this.
5403
5404 @vindex gnus-prefetched-article-deletion-strategy
5405 Articles have to be removed from the asynch buffer sooner or later.  The
5406 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5407 articles.  This is a list that may contain the following elements:
5408
5409 @table @code
5410 @item read
5411 Remove articles when they are read.
5412
5413 @item exit
5414 Remove articles when exiting the group.
5415 @end table
5416
5417 The default value is @code{(read exit)}.
5418
5419 @c @vindex gnus-use-header-prefetch
5420 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5421 @c from the next group.
5422
5423
5424 @node Article Caching
5425 @section Article Caching
5426 @cindex article caching
5427 @cindex caching
5428
5429 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5430 consider turning article caching on.  Each article will then be stored
5431 locally under your home directory.  As you may surmise, this could
5432 potentially use @emph{huge} amounts of disk space, as well as eat up all
5433 your inodes so fast it will make your head swim.  In vodka.
5434
5435 Used carefully, though, it could be just an easier way to save articles.
5436
5437 @vindex gnus-use-long-file-name
5438 @vindex gnus-cache-directory
5439 @vindex gnus-use-cache
5440 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5441 all articles ticked or marked as dormant will then be copied
5442 over to your local cache (@code{gnus-cache-directory}).  Whether this
5443 cache is flat or hierarchal is controlled by the
5444 @code{gnus-use-long-file-name} variable, as usual.
5445
5446 When re-selecting a ticked or dormant article, it will be fetched from the
5447 cache instead of from the server.  As articles in your cache will never
5448 expire, this might serve as a method of saving articles while still
5449 keeping them where they belong.  Just mark all articles you want to save
5450 as dormant, and don't worry.
5451
5452 When an article is marked as read, is it removed from the cache.
5453
5454 @vindex gnus-cache-remove-articles
5455 @vindex gnus-cache-enter-articles
5456 The entering/removal of articles from the cache is controlled by the
5457 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5458 variables.  Both are lists of symbols.  The first is @code{(ticked
5459 dormant)} by default, meaning that ticked and dormant articles will be
5460 put in the cache.  The latter is @code{(read)} by default, meaning that
5461 articles marked as read are removed from the cache.  Possibly
5462 symbols in these two lists are @code{ticked}, @code{dormant},
5463 @code{unread} and @code{read}.
5464
5465 @findex gnus-jog-cache
5466 So where does the massive article-fetching and storing come into the
5467 picture?  The @code{gnus-jog-cache} command will go through all
5468 subscribed newsgroups, request all unread articles, score them, and
5469 store them in the cache.  You should only ever, ever ever ever, use this
5470 command if 1) your connection to the @sc{nntp} server is really, really,
5471 really slow and 2) you have a really, really, really huge disk.
5472 Seriously.  One way to cut down on the number of articles downloaded is
5473 to score unwanted articles down and have them marked as read.  They will
5474 not then be downloaded by this command.
5475
5476 @vindex gnus-uncacheable-groups
5477 @vindex gnus-cacheable-groups
5478 It is likely that you do not want caching on all groups.  For instance,
5479 if your @code{nnml} mail is located under your home directory, it makes no
5480 sense to cache it somewhere else under your home directory.  Unless you
5481 feel that it's neat to use twice as much space.
5482
5483 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5484 regexp of groups to cache, @samp{^nntp} for instance, or set the
5485 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5486 Both variables are @code{nil} by default. If a group matches both
5487 variables, the group is not cached.
5488
5489 @findex gnus-cache-generate-nov-databases
5490 @findex gnus-cache-generate-active
5491 @vindex gnus-cache-active-file
5492 The cache stores information on what articles it contains in its active
5493 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5494 of the cache) becomes all messed up for some reason or other, gnus
5495 offers two functions that will try to set things right.  @kbd{M-x
5496 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5497 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5498 file.
5499
5500
5501 @node Persistent Articles
5502 @section Persistent Articles
5503 @cindex persistent articles
5504
5505 Closely related to article caching, we have @dfn{persistent articles}.
5506 In fact, it's just a different way of looking at caching, and much more
5507 useful in my opinion.
5508
5509 Say you're reading a newsgroup, and you happen on to some valuable gem
5510 that you want to keep and treasure forever.  You'd normally just save it
5511 (using one of the many saving commands) in some file.  The problem with
5512 that is that it's just, well, yucky.  Ideally you'd prefer just having
5513 the article remain in the group where you found it forever; untouched by
5514 the expiry going on at the news server.
5515
5516 This is what a @dfn{persistent article} is---an article that just won't
5517 be deleted.  It's implemented using the normal cache functions, but
5518 you use two explicit commands for managing persistent articles:
5519
5520 @table @kbd
5521
5522 @item *
5523 @kindex * (Summary)
5524 @findex gnus-cache-enter-article
5525 Make the current article persistent (@code{gnus-cache-enter-article}).
5526
5527 @item M-*
5528 @kindex M-* (Summary)
5529 @findex gnus-cache-remove-article
5530 Remove the current article from the persistent articles
5531 (@code{gnus-cache-remove-article}).  This will normally delete the
5532 article.
5533 @end table
5534
5535 Both these commands understand the process/prefix convention.
5536
5537 To avoid having all ticked articles (and stuff) entered into the cache,
5538 you should set @code{gnus-use-cache} to @code{passive} if you're just
5539 interested in persistent articles:
5540
5541 @lisp
5542 (setq gnus-use-cache 'passive)
5543 @end lisp
5544
5545
5546 @node Article Backlog
5547 @section Article Backlog
5548 @cindex backlog
5549 @cindex article backlog
5550
5551 If you have a slow connection, but the idea of using caching seems
5552 unappealing to you (and it is, really), you can help the situation some
5553 by switching on the @dfn{backlog}.  This is where gnus will buffer
5554 already read articles so that it doesn't have to re-fetch articles
5555 you've already read.  This only helps if you are in the habit of
5556 re-selecting articles you've recently read, of course.  If you never do
5557 that, turning the backlog on will slow gnus down a little bit, and
5558 increase memory usage some.
5559
5560 @vindex gnus-keep-backlog
5561 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
5562 at most @var{n} old articles in a buffer for later re-fetching.  If this
5563 variable is non-@code{nil} and is not a number, gnus will store
5564 @emph{all} read articles, which means that your Emacs will grow without
5565 bound before exploding and taking your machine down with you.  I put
5566 that in there just to keep y'all on your toes.
5567
5568 This variable is @code{nil} by default.
5569
5570
5571 @node Saving Articles
5572 @section Saving Articles
5573 @cindex saving articles
5574
5575 Gnus can save articles in a number of ways.  Below is the documentation
5576 for saving articles in a fairly straight-forward fashion (i.e., little
5577 processing of the article is done before it is saved).  For a different
5578 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5579 (@pxref{Decoding Articles}).
5580
5581 @vindex gnus-save-all-headers
5582 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
5583 unwanted headers before saving the article.
5584
5585 @vindex gnus-saved-headers
5586 If the preceding variable is @code{nil}, all headers that match the
5587 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5588 deleted before saving.
5589
5590 @table @kbd
5591
5592 @item O o
5593 @itemx o
5594 @kindex O o (Summary)
5595 @kindex o (Summary)
5596 @findex gnus-summary-save-article
5597 @c @icon{gnus-summary-save-article}
5598 Save the current article using the default article saver
5599 (@code{gnus-summary-save-article}).
5600
5601 @item O m
5602 @kindex O m (Summary)
5603 @findex gnus-summary-save-article-mail
5604 Save the current article in mail format
5605 (@code{gnus-summary-save-article-mail}).
5606
5607 @item O r
5608 @kindex O r (Summary)
5609 @findex gnus-summary-save-article-rmail
5610 Save the current article in rmail format
5611 (@code{gnus-summary-save-article-rmail}).
5612
5613 @item O f
5614 @kindex O f (Summary)
5615 @findex gnus-summary-save-article-file
5616 @c @icon{gnus-summary-save-article-file}
5617 Save the current article in plain file format
5618 (@code{gnus-summary-save-article-file}).
5619
5620 @item O F
5621 @kindex O F (Summary)
5622 @findex gnus-summary-write-article-file
5623 Write the current article in plain file format, overwriting any previous
5624 file contents (@code{gnus-summary-write-article-file}).
5625
5626 @item O b
5627 @kindex O b (Summary)
5628 @findex gnus-summary-save-article-body-file
5629 Save the current article body in plain file format
5630 (@code{gnus-summary-save-article-body-file}).
5631
5632 @item O h
5633 @kindex O h (Summary)
5634 @findex gnus-summary-save-article-folder
5635 Save the current article in mh folder format
5636 (@code{gnus-summary-save-article-folder}).
5637
5638 @item O v
5639 @kindex O v (Summary)
5640 @findex gnus-summary-save-article-vm
5641 Save the current article in a VM folder
5642 (@code{gnus-summary-save-article-vm}).
5643
5644 @item O p
5645 @kindex O p (Summary)
5646 @findex gnus-summary-pipe-output
5647 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5648 the current article to a process (@code{gnus-summary-pipe-output}).
5649 @end table
5650
5651 @vindex gnus-prompt-before-saving
5652 All these commands use the process/prefix convention
5653 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5654 functions, you might get tired of being prompted for files to save each
5655 and every article in.  The prompting action is controlled by
5656 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5657 default, giving you that excessive prompting action you know and
5658 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5659 just once for each series of articles you save.  If you like to really
5660 have Gnus do all your thinking for you, you can even set this variable
5661 to @code{nil}, which means that you will never be prompted for files to
5662 save articles in.  Gnus will simply save all the articles in the default
5663 files.
5664
5665
5666 @vindex gnus-default-article-saver
5667 You can customize the @code{gnus-default-article-saver} variable to make
5668 gnus do what you want it to.  You can use any of the four ready-made
5669 functions below, or you can create your own.
5670
5671 @table @code
5672
5673 @item gnus-summary-save-in-rmail
5674 @findex gnus-summary-save-in-rmail
5675 @vindex gnus-rmail-save-name
5676 @findex gnus-plain-save-name
5677 This is the default format, @dfn{babyl}.  Uses the function in the
5678 @code{gnus-rmail-save-name} variable to get a file name to save the
5679 article in.  The default is @code{gnus-plain-save-name}.
5680
5681 @item gnus-summary-save-in-mail
5682 @findex gnus-summary-save-in-mail
5683 @vindex gnus-mail-save-name
5684 Save in a Unix mail (mbox) file.  Uses the function in the
5685 @code{gnus-mail-save-name} variable to get a file name to save the
5686 article in.  The default is @code{gnus-plain-save-name}.
5687
5688 @item gnus-summary-save-in-file
5689 @findex gnus-summary-save-in-file
5690 @vindex gnus-file-save-name
5691 @findex gnus-numeric-save-name
5692 Append the article straight to an ordinary file.  Uses the function in
5693 the @code{gnus-file-save-name} variable to get a file name to save the
5694 article in.  The default is @code{gnus-numeric-save-name}.
5695
5696 @item gnus-summary-save-body-in-file
5697 @findex gnus-summary-save-body-in-file
5698 Append the article body to an ordinary file.  Uses the function in the
5699 @code{gnus-file-save-name} variable to get a file name to save the
5700 article in.  The default is @code{gnus-numeric-save-name}.
5701
5702 @item gnus-summary-save-in-folder
5703 @findex gnus-summary-save-in-folder
5704 @findex gnus-folder-save-name
5705 @findex gnus-Folder-save-name
5706 @vindex gnus-folder-save-name
5707 @cindex rcvstore
5708 @cindex MH folders
5709 Save the article to an MH folder using @code{rcvstore} from the MH
5710 library.  Uses the function in the @code{gnus-folder-save-name} variable
5711 to get a file name to save the article in.  The default is
5712 @code{gnus-folder-save-name}, but you can also use
5713 @code{gnus-Folder-save-name}, which creates capitalized names.
5714
5715 @item gnus-summary-save-in-vm
5716 @findex gnus-summary-save-in-vm
5717 Save the article in a VM folder.  You have to have the VM mail
5718 reader to use this setting.
5719 @end table
5720
5721 @vindex gnus-article-save-directory
5722 All of these functions, except for the last one, will save the article
5723 in the @code{gnus-article-save-directory}, which is initialized from the
5724 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5725 default.
5726
5727 As you can see above, the functions use different functions to find a
5728 suitable name of a file to save the article in.  Below is a list of
5729 available functions that generate names:
5730
5731 @table @code
5732
5733 @item gnus-Numeric-save-name
5734 @findex gnus-Numeric-save-name
5735 File names like @file{~/News/Alt.andrea-dworkin/45}.
5736
5737 @item gnus-numeric-save-name
5738 @findex gnus-numeric-save-name
5739 File names like @file{~/News/alt.andrea-dworkin/45}.
5740
5741 @item gnus-Plain-save-name
5742 @findex gnus-Plain-save-name
5743 File names like @file{~/News/Alt.andrea-dworkin}.
5744
5745 @item gnus-plain-save-name
5746 @findex gnus-plain-save-name
5747 File names like @file{~/News/alt.andrea-dworkin}.
5748 @end table
5749
5750 @vindex gnus-split-methods
5751 You can have gnus suggest where to save articles by plonking a regexp into
5752 the @code{gnus-split-methods} alist.  For instance, if you would like to
5753 save articles related to gnus in the file @file{gnus-stuff}, and articles
5754 related to VM in @code{vm-stuff}, you could set this variable to something
5755 like:
5756
5757 @lisp
5758 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5759  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5760  (my-choosing-function "../other-dir/my-stuff")
5761  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5762 @end lisp
5763
5764 We see that this is a list where each element is a list that has two
5765 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5766 a string (in which case it is used as a regexp to match on the article
5767 head); it can be a symbol (which will be called as a function with the
5768 group name as a parameter); or it can be a list (which will be
5769 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5770 the @dfn{file} will be used as a default prompt.  In addition, the
5771 result of the operation itself will be used if the function or form
5772 called returns a string or a list of strings.
5773
5774 You basically end up with a list of file names that might be used when
5775 saving the current article.  (All ``matches'' will be used.)  You will
5776 then be prompted for what you really want to use as a name, with file
5777 name completion over the results from applying this variable.
5778
5779 This variable is @code{((gnus-article-archive-name))} by default, which
5780 means that gnus will look at the articles it saves for an
5781 @code{Archive-name} line and use that as a suggestion for the file
5782 name.
5783
5784 Here's an example function to clean up file names somewhat.  If you have
5785 lots of mail groups called things like
5786 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5787 these group names before creating the file name to save to.  The
5788 following will do just that:
5789
5790 @lisp
5791 (defun my-save-name (group)
5792   (when (string-match "^nnml:mail." group)
5793     (substring group (match-end 0))))
5794
5795 (setq gnus-split-methods
5796       '((gnus-article-archive-name)
5797         (my-save-name)))
5798 @end lisp
5799
5800
5801 @vindex gnus-use-long-file-name
5802 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5803 @code{nil}, all the preceding functions will replace all periods
5804 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5805 the functions will generate hierarchies of directories instead of having
5806 all the files in the top level directory
5807 (@file{~/News/alt/andrea-dworkin} instead of
5808 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5809 on most systems.  However, for historical reasons, this is @code{nil} on
5810 Xenix and usg-unix-v machines by default.
5811
5812 This function also affects kill and score file names.  If this variable
5813 is a list, and the list contains the element @code{not-score}, long file
5814 names will not be used for score files, if it contains the element
5815 @code{not-save}, long file names will not be used for saving, and if it
5816 contains the element @code{not-kill}, long file names will not be used
5817 for kill files.
5818
5819 If you'd like to save articles in a hierarchy that looks something like
5820 a spool, you could
5821
5822 @lisp
5823 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5824 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5825 @end lisp
5826
5827 Then just save with @kbd{o}.  You'd then read this hierarchy with
5828 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5829 the top level directory as the argument (@file{~/News/}).  Then just walk
5830 around to the groups/directories with @code{nneething}.
5831
5832
5833 @node Decoding Articles
5834 @section Decoding Articles
5835 @cindex decoding articles
5836
5837 Sometime users post articles (or series of articles) that have been
5838 encoded in some way or other.  Gnus can decode them for you.
5839
5840 @menu
5841 * Uuencoded Articles::    Uudecode articles.
5842 * Shell Archives::        Unshar articles.
5843 * PostScript Files::      Split PostScript.
5844 * Other Files::           Plain save and binhex.
5845 * Decoding Variables::    Variables for a happy decoding.
5846 * Viewing Files::         You want to look at the result of the decoding?
5847 @end menu
5848
5849 @cindex series
5850 @cindex article series
5851 All these functions use the process/prefix convention
5852 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5853 the extension that a ``single article'' means ``a single series''.  Gnus
5854 can find out by itself what articles belong to a series, decode all the
5855 articles and unpack/view/save the resulting file(s).
5856
5857 Gnus guesses what articles are in the series according to the following
5858 simplish rule: The subjects must be (nearly) identical, except for the
5859 last two numbers of the line.  (Spaces are largely ignored, however.)
5860
5861 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
5862 will find all the articles that match the regexp @samp{^cat.gif
5863 ([0-9]+/[0-9]+).*$}.
5864
5865 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5866 series}, will not be properly recognized by any of the automatic viewing
5867 commands, and you have to mark the articles manually with @kbd{#}.
5868
5869
5870 @node Uuencoded Articles
5871 @subsection Uuencoded Articles
5872 @cindex uudecode
5873 @cindex uuencoded articles
5874
5875 @table @kbd
5876
5877 @item X u
5878 @kindex X u (Summary)
5879 @findex gnus-uu-decode-uu
5880 @c @icon{gnus-uu-decode-uu}
5881 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5882
5883 @item X U
5884 @kindex X U (Summary)
5885 @findex gnus-uu-decode-uu-and-save
5886 Uudecodes and saves the current series
5887 (@code{gnus-uu-decode-uu-and-save}).
5888
5889 @item X v u
5890 @kindex X v u (Summary)
5891 @findex gnus-uu-decode-uu-view
5892 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5893
5894 @item X v U
5895 @kindex X v U (Summary)
5896 @findex gnus-uu-decode-uu-and-save-view
5897 Uudecodes, views and saves the current series
5898 (@code{gnus-uu-decode-uu-and-save-view}).
5899
5900 @end table
5901
5902 Remember that these all react to the presence of articles marked with
5903 the process mark.  If, for instance, you'd like to decode and save an
5904 entire newsgroup, you'd typically do @kbd{M P a}
5905 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5906 (@code{gnus-uu-decode-uu-and-save}).
5907
5908 All this is very much different from how @code{gnus-uu} worked with
5909 @sc{GNUS 4.1}, where you had explicit keystrokes for everything under
5910 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5911 articles in some way (@pxref{Setting Process Marks}) and then press
5912 @kbd{X u}.
5913
5914 @vindex gnus-uu-notify-files
5915 Note: When trying to decode articles that have names matching
5916 @code{gnus-uu-notify-files}, which is hard-coded to
5917 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5918 automatically post an article on @samp{comp.unix.wizards} saying that
5919 you have just viewed the file in question.  This feature can't be turned
5920 off.
5921
5922
5923 @node Shell Archives
5924 @subsection Shell Archives
5925 @cindex unshar
5926 @cindex shell archives
5927 @cindex shared articles
5928
5929 Shell archives (``shar files'') used to be a popular way to distribute
5930 sources, but it isn't used all that much today.  In any case, we have
5931 some commands to deal with these:
5932
5933 @table @kbd
5934
5935 @item X s
5936 @kindex X s (Summary)
5937 @findex gnus-uu-decode-unshar
5938 Unshars the current series (@code{gnus-uu-decode-unshar}).
5939
5940 @item X S
5941 @kindex X S (Summary)
5942 @findex gnus-uu-decode-unshar-and-save
5943 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5944
5945 @item X v s
5946 @kindex X v s (Summary)
5947 @findex gnus-uu-decode-unshar-view
5948 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5949
5950 @item X v S
5951 @kindex X v S (Summary)
5952 @findex gnus-uu-decode-unshar-and-save-view
5953 Unshars, views and saves the current series
5954 (@code{gnus-uu-decode-unshar-and-save-view}).
5955 @end table
5956
5957
5958 @node PostScript Files
5959 @subsection PostScript Files
5960 @cindex PostScript
5961
5962 @table @kbd
5963
5964 @item X p
5965 @kindex X p (Summary)
5966 @findex gnus-uu-decode-postscript
5967 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5968
5969 @item X P
5970 @kindex X P (Summary)
5971 @findex gnus-uu-decode-postscript-and-save
5972 Unpack and save the current PostScript series
5973 (@code{gnus-uu-decode-postscript-and-save}).
5974
5975 @item X v p
5976 @kindex X v p (Summary)
5977 @findex gnus-uu-decode-postscript-view
5978 View the current PostScript series
5979 (@code{gnus-uu-decode-postscript-view}).
5980
5981 @item X v P
5982 @kindex X v P (Summary)
5983 @findex gnus-uu-decode-postscript-and-save-view
5984 View and save the current PostScript series
5985 (@code{gnus-uu-decode-postscript-and-save-view}).
5986 @end table
5987
5988
5989 @node Other Files
5990 @subsection Other Files
5991
5992 @table @kbd
5993 @item X o
5994 @kindex X o (Summary)
5995 @findex gnus-uu-decode-save
5996 Save the current series
5997 (@code{gnus-uu-decode-save}).
5998
5999 @item X b
6000 @kindex X b (Summary)
6001 @findex gnus-uu-decode-binhex
6002 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
6003 doesn't really work yet.
6004 @end table
6005
6006
6007 @node Decoding Variables
6008 @subsection Decoding Variables
6009
6010 Adjective, not verb.
6011
6012 @menu
6013 * Rule Variables::          Variables that say how a file is to be viewed.
6014 * Other Decode Variables::  Other decode variables.
6015 * Uuencoding and Posting::  Variables for customizing uuencoding.
6016 @end menu
6017
6018
6019 @node Rule Variables
6020 @subsubsection Rule Variables
6021 @cindex rule variables
6022
6023 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
6024 variables are of the form
6025
6026 @lisp
6027       (list '(regexp1 command2)
6028             '(regexp2 command2)
6029             ...)
6030 @end lisp
6031
6032 @table @code
6033
6034 @item gnus-uu-user-view-rules
6035 @vindex gnus-uu-user-view-rules
6036 @cindex sox
6037 This variable is consulted first when viewing files.  If you wish to use,
6038 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6039 say something like:
6040 @lisp
6041 (setq gnus-uu-user-view-rules
6042       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6043 @end lisp
6044
6045 @item gnus-uu-user-view-rules-end
6046 @vindex gnus-uu-user-view-rules-end
6047 This variable is consulted if gnus couldn't make any matches from the
6048 user and default view rules.
6049
6050 @item gnus-uu-user-archive-rules
6051 @vindex gnus-uu-user-archive-rules
6052 This variable can be used to say what commands should be used to unpack
6053 archives.
6054 @end table
6055
6056
6057 @node Other Decode Variables
6058 @subsubsection Other Decode Variables
6059
6060 @table @code
6061 @vindex gnus-uu-grabbed-file-functions
6062
6063 @item gnus-uu-grabbed-file-functions
6064 All functions in this list will be called right after each file has been
6065 successfully decoded---so that you can move or view files right away,
6066 and don't have to wait for all files to be decoded before you can do
6067 anything.  Ready-made functions you can put in this list are:
6068
6069 @table @code
6070
6071 @item gnus-uu-grab-view
6072 @findex gnus-uu-grab-view
6073 View the file.
6074
6075 @item gnus-uu-grab-move
6076 @findex gnus-uu-grab-move
6077 Move the file (if you're using a saving function.)
6078 @end table
6079
6080 @item gnus-uu-be-dangerous
6081 @vindex gnus-uu-be-dangerous
6082 Specifies what to do if unusual situations arise during decoding.  If
6083 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
6084 that didn't work, and overwrite existing files.  Otherwise, ask each
6085 time.
6086
6087 @item gnus-uu-ignore-files-by-name
6088 @vindex gnus-uu-ignore-files-by-name
6089 Files with name matching this regular expression won't be viewed.
6090
6091 @item gnus-uu-ignore-files-by-type
6092 @vindex gnus-uu-ignore-files-by-type
6093 Files with a @sc{mime} type matching this variable won't be viewed.
6094 Note that Gnus tries to guess what type the file is based on the name.
6095 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6096 kludgey.
6097
6098 @item gnus-uu-tmp-dir
6099 @vindex gnus-uu-tmp-dir
6100 Where @code{gnus-uu} does its work.
6101
6102 @item gnus-uu-do-not-unpack-archives
6103 @vindex gnus-uu-do-not-unpack-archives
6104 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6105 looking for files to display.
6106
6107 @item gnus-uu-view-and-save
6108 @vindex gnus-uu-view-and-save
6109 Non-@code{nil} means that the user will always be asked to save a file
6110 after viewing it.
6111
6112 @item gnus-uu-ignore-default-view-rules
6113 @vindex gnus-uu-ignore-default-view-rules
6114 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6115 rules.
6116
6117 @item gnus-uu-ignore-default-archive-rules
6118 @vindex gnus-uu-ignore-default-archive-rules
6119 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6120 unpacking commands.
6121
6122 @item gnus-uu-kill-carriage-return
6123 @vindex gnus-uu-kill-carriage-return
6124 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6125 from articles.
6126
6127 @item gnus-uu-unmark-articles-not-decoded
6128 @vindex gnus-uu-unmark-articles-not-decoded
6129 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6130 decoded articles as unread.
6131
6132 @item gnus-uu-correct-stripped-uucode
6133 @vindex gnus-uu-correct-stripped-uucode
6134 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6135 uuencoded files that have had trailing spaces deleted.
6136
6137 @item gnus-uu-pre-uudecode-hook
6138 @vindex gnus-uu-pre-uudecode-hook
6139 Hook run before sending a message to @code{uudecode}.
6140
6141 @item gnus-uu-view-with-metamail
6142 @vindex gnus-uu-view-with-metamail
6143 @cindex metamail
6144 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6145 commands defined by the rule variables and just fudge a @sc{mime}
6146 content type based on the file name.  The result will be fed to
6147 @code{metamail} for viewing.
6148
6149 @item gnus-uu-save-in-digest
6150 @vindex gnus-uu-save-in-digest
6151 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6152 decoding, will save in digests.  If this variable is @code{nil},
6153 @code{gnus-uu} will just save everything in a file without any
6154 embellishments.  The digesting almost conforms to RFC1153---no easy way
6155 to specify any meaningful volume and issue numbers were found, so I
6156 simply dropped them.
6157
6158 @end table
6159
6160
6161 @node Uuencoding and Posting
6162 @subsubsection Uuencoding and Posting
6163
6164 @table @code
6165
6166 @item gnus-uu-post-include-before-composing
6167 @vindex gnus-uu-post-include-before-composing
6168 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6169 before you compose the article.  If this variable is @code{t}, you can
6170 either include an encoded file with @kbd{C-c C-i} or have one included
6171 for you when you post the article.
6172
6173 @item gnus-uu-post-length
6174 @vindex gnus-uu-post-length
6175 Maximum length of an article.  The encoded file will be split into how
6176 many articles it takes to post the entire file.
6177
6178 @item gnus-uu-post-threaded
6179 @vindex gnus-uu-post-threaded
6180 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6181 thread.  This may not be smart, as no other decoder I have seen is able
6182 to follow threads when collecting uuencoded articles.  (Well, I have
6183 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6184 think that counts...) Default is @code{nil}.
6185
6186 @item gnus-uu-post-separate-description
6187 @vindex gnus-uu-post-separate-description
6188 Non-@code{nil} means that the description will be posted in a separate
6189 article.  The first article will typically be numbered (0/x).  If this
6190 variable is @code{nil}, the description the user enters will be included
6191 at the beginning of the first article, which will be numbered (1/x).
6192 Default is @code{t}.
6193
6194 @end table
6195
6196
6197 @node Viewing Files
6198 @subsection Viewing Files
6199 @cindex viewing files
6200 @cindex pseudo-articles
6201
6202 After decoding, if the file is some sort of archive, gnus will attempt
6203 to unpack the archive and see if any of the files in the archive can be
6204 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
6205 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
6206 uncompress and de-tar the main file, and then view the two pictures.
6207 This unpacking process is recursive, so if the archive contains archives
6208 of archives, it'll all be unpacked.
6209
6210 Finally, gnus will normally insert a @dfn{pseudo-article} for each
6211 extracted file into the summary buffer.  If you go to these
6212 ``articles'', you will be prompted for a command to run (usually Gnus
6213 will make a suggestion), and then the command will be run.
6214
6215 @vindex gnus-view-pseudo-asynchronously
6216 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6217 until the viewing is done before proceeding.
6218
6219 @vindex gnus-view-pseudos
6220 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6221 the pseudo-articles into the summary buffer, but view them
6222 immediately.  If this variable is @code{not-confirm}, the user won't even
6223 be asked for a confirmation before viewing is done.
6224
6225 @vindex gnus-view-pseudos-separately
6226 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6227 pseudo-article will be created for each file to be viewed.  If
6228 @code{nil}, all files that use the same viewing command will be given as
6229 a list of parameters to that command.
6230
6231 @vindex gnus-insert-pseudo-articles
6232 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6233 pseudo-articles when decoding.  It is @code{t} by default.
6234
6235 So; there you are, reading your @emph{pseudo-articles} in your
6236 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6237 Why isn't anything real anymore? How did we get here?
6238
6239
6240 @node Article Treatment
6241 @section Article Treatment
6242
6243 Reading through this huge manual, you may have quite forgotten that the
6244 object of newsreaders is to actually, like, read what people have
6245 written.  Reading articles.  Unfortunately, people are quite bad at
6246 writing, so there are tons of functions and variables to make reading
6247 these articles easier.
6248
6249 @menu
6250 * Article Highlighting::    You want to make the article look like fruit salad.
6251 * Article Fontisizing::     Making emphasized text look nice.
6252 * Article Hiding::          You also want to make certain info go away.
6253 * Article Washing::         Lots of way-neat functions to make life better.
6254 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6255 * Article Date::            Grumble, UT!
6256 * Article Signature::       What is a signature?
6257 @end menu
6258
6259
6260 @node Article Highlighting
6261 @subsection Article Highlighting
6262 @cindex highlighting
6263
6264 Not only do you want your article buffer to look like fruit salad, but
6265 you want it to look like technicolor fruit salad.
6266
6267 @table @kbd
6268
6269 @item W H a
6270 @kindex W H a (Summary)
6271 @findex gnus-article-highlight
6272 @findex gnus-article-maybe-highlight
6273 Do much highlighting of the current article
6274 (@code{gnus-article-highlight}).  This function highlights header, cited
6275 text, the signature, and adds buttons to the body and the head.
6276
6277 @item W H h
6278 @kindex W H h (Summary)
6279 @findex gnus-article-highlight-headers
6280 @vindex gnus-header-face-alist
6281 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6282 highlighting will be done according to the @code{gnus-header-face-alist}
6283 variable, which is a list where each element has the form @var{(regexp
6284 name content)}.  @var{regexp} is a regular expression for matching the
6285 header, @var{name} is the face used for highlighting the header name
6286 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6287 the header value.  The first match made will be used.  Note that
6288 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6289
6290 @item W H c
6291 @kindex W H c (Summary)
6292 @findex gnus-article-highlight-citation
6293 Highlight cited text (@code{gnus-article-highlight-citation}).
6294
6295 Some variables to customize the citation highlights:
6296
6297 @table @code
6298 @vindex gnus-cite-parse-max-size
6299
6300 @item gnus-cite-parse-max-size
6301 If the article size if bigger than this variable (which is 25000 by
6302 default), no citation highlighting will be performed.
6303
6304 @item gnus-cite-prefix-regexp
6305 @vindex gnus-cite-prefix-regexp
6306 Regexp matching the longest possible citation prefix on a line.
6307
6308 @item gnus-cite-max-prefix
6309 @vindex gnus-cite-max-prefix
6310 Maximum possible length for a citation prefix (default 20).
6311
6312 @item gnus-cite-face-list
6313 @vindex gnus-cite-face-list
6314 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6315 When there are citations from multiple articles in the same message,
6316 gnus will try to give each citation from each article its own face.
6317 This should make it easier to see who wrote what.
6318
6319 @item gnus-supercite-regexp
6320 @vindex gnus-supercite-regexp
6321 Regexp matching normal Supercite attribution lines.
6322
6323 @item gnus-supercite-secondary-regexp
6324 @vindex gnus-supercite-secondary-regexp
6325 Regexp matching mangled Supercite attribution lines.
6326
6327 @item gnus-cite-minimum-match-count
6328 @vindex gnus-cite-minimum-match-count
6329 Minimum number of identical prefixes we have to see before we believe
6330 that it's a citation.
6331
6332 @item gnus-cite-attribution-prefix
6333 @vindex gnus-cite-attribution-prefix
6334 Regexp matching the beginning of an attribution line.
6335
6336 @item gnus-cite-attribution-suffix
6337 @vindex gnus-cite-attribution-suffix
6338 Regexp matching the end of an attribution line.
6339
6340 @item gnus-cite-attribution-face
6341 @vindex gnus-cite-attribution-face
6342 Face used for attribution lines.  It is merged with the face for the
6343 cited text belonging to the attribution.
6344
6345 @end table
6346
6347
6348 @item W H s
6349 @kindex W H s (Summary)
6350 @vindex gnus-signature-separator
6351 @vindex gnus-signature-face
6352 @findex gnus-article-highlight-signature
6353 Highlight the signature (@code{gnus-article-highlight-signature}).
6354 Everything after @code{gnus-signature-separator} (@pxref{Article
6355 Signature}) in an article will be considered a signature and will be
6356 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6357 default.
6358
6359 @end table
6360
6361 @xref{Customizing Articles} for how to highlight articles automatically.
6362
6363
6364 @node Article Fontisizing
6365 @subsection Article Fontisizing
6366 @cindex emphasis
6367 @cindex article emphasis
6368
6369 @findex gnus-article-emphasize
6370 @kindex W e (Summary)
6371 People commonly add emphasis to words in news articles by writing things
6372 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
6373 running the article through the @kbd{W e}
6374 (@code{gnus-article-emphasize}) command.
6375
6376 @vindex gnus-emphasis-alist
6377 How the emphasis is computed is controlled by the
6378 @code{gnus-emphasis-alist} variable.  This is an alist where the first
6379 element is a regular expression to be matched.  The second is a number
6380 that says what regular expression grouping is used to find the entire
6381 emphasized word.  The third is a number that says what regexp grouping
6382 should be displayed and highlighted.  (The text between these two
6383 groupings will be hidden.)  The fourth is the face used for
6384 highlighting.
6385
6386 @lisp
6387 (setq gnus-article-emphasis
6388       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6389         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6390 @end lisp
6391
6392 @vindex gnus-emphasis-underline
6393 @vindex gnus-emphasis-bold
6394 @vindex gnus-emphasis-italic
6395 @vindex gnus-emphasis-underline-bold
6396 @vindex gnus-emphasis-underline-italic
6397 @vindex gnus-emphasis-bold-italic
6398 @vindex gnus-emphasis-underline-bold-italic
6399 By default, there are seven rules, and they use the following faces:
6400 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6401 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6402 @code{gnus-emphasis-underline-italic},
6403 @code{gnus-emphasis-underline-bold}, and
6404 @code{gnus-emphasis-underline-bold-italic}.
6405
6406 If you want to change these faces, you can either use @kbd{M-x
6407 customize}, or you can use @code{copy-face}.  For instance, if you want
6408 to make @code{gnus-emphasis-italic} use a red face instead, you could
6409 say something like:
6410
6411 @lisp
6412 (copy-face 'red 'gnus-emphasis-italic)
6413 @end lisp
6414
6415 @xref{Customizing Articles} for how to fontize articles automatically.
6416
6417
6418 @node Article Hiding
6419 @subsection Article Hiding
6420 @cindex article hiding
6421
6422 Or rather, hiding certain things in each article.  There usually is much
6423 too much cruft in most articles.
6424
6425 @table @kbd
6426
6427 @item W W a
6428 @kindex W W a (Summary)
6429 @findex gnus-article-hide
6430 Do quite a lot of hiding on the article buffer
6431 (@kbd{gnus-article-hide}).  In particular, this function will hide
6432 headers, PGP, cited text and the signature.
6433
6434 @item W W h
6435 @kindex W W h (Summary)
6436 @findex gnus-article-hide-headers
6437 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
6438 Headers}.
6439
6440 @item W W b
6441 @kindex W W b (Summary)
6442 @findex gnus-article-hide-boring-headers
6443 Hide headers that aren't particularly interesting
6444 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6445
6446 @item W W s
6447 @kindex W W s (Summary)
6448 @findex gnus-article-hide-signature
6449 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6450 Signature}.
6451
6452 @item W W p
6453 @kindex W W p (Summary)
6454 @findex gnus-article-hide-pgp
6455 @vindex gnus-article-hide-pgp-hook
6456 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6457 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6458 signature has been hidden.  For example, to automatically verify
6459 articles that have signatures in them do:
6460 @lisp
6461 ;;; Hide pgp cruft if any.
6462
6463 (setq gnus-treat-strip-pgp t)
6464
6465 ;;; After hiding pgp, verify the message;
6466 ;;; only happens if pgp signature is found.
6467
6468 (add-hook 'gnus-article-hide-pgp-hook
6469           (lambda ()
6470             (save-excursion
6471               (set-buffer gnus-original-article-buffer)
6472               (mc-verify))))
6473 @end lisp
6474
6475 @item W W P
6476 @kindex W W P (Summary)
6477 @findex gnus-article-hide-pem
6478 Hide @sc{pem} (privacy enhanced messages) cruft
6479 (@code{gnus-article-hide-pem}).
6480
6481 @item W W B
6482 @kindex W W B (Summary)
6483 @findex gnus-article-strip-banner
6484 Strip the banner specified by the @code{banner} group parameter
6485 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
6486 annoying banners and/or signatures that some mailing lists and moderated
6487 groups adds to all the messages.  The way to use this function is to add
6488 the @code{banner} group parameter (@pxref{Group Parameters}) to the
6489 group you want banners stripped from.  The parameter either be a string,
6490 which will be interpreted as a regulax expression matching text to be
6491 removed, or the symbol @code{signature}, meaning that the (last)
6492 signature should be removed.
6493
6494 @item W W c
6495 @kindex W W c (Summary)
6496 @findex gnus-article-hide-citation
6497 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6498 customizing the hiding:
6499
6500 @table @code
6501
6502 @item gnus-cited-opened-text-button-line-format
6503 @itemx gnus-cited-closed-text-button-line-format
6504 @vindex gnus-cited-closed-text-button-line-format
6505 @vindex gnus-cited-opened-text-button-line-format
6506 Gnus adds buttons to show where the cited text has been hidden, and to
6507 allow toggle hiding the text.  The format of the variable is specified
6508 by these format-like variable (@pxref{Formatting Variables}).  These
6509 specs are valid:
6510
6511 @table @samp
6512 @item b
6513 Starting point of the hidden text.
6514 @item e
6515 Ending point of the hidden text.
6516 @item l
6517 Number of characters in the hidden region.
6518 @item n
6519 Number of lines of hidden text.
6520 @end table
6521
6522 @item gnus-cited-lines-visible
6523 @vindex gnus-cited-lines-visible
6524 The number of lines at the beginning of the cited text to leave shown.
6525
6526 @end table
6527
6528 @item W W C-c
6529 @kindex W W C-c (Summary)
6530 @findex gnus-article-hide-citation-maybe
6531
6532 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6533 following two variables:
6534
6535 @table @code
6536 @item gnus-cite-hide-percentage
6537 @vindex gnus-cite-hide-percentage
6538 If the cited text is of a bigger percentage than this variable (default
6539 50), hide the cited text.
6540
6541 @item gnus-cite-hide-absolute
6542 @vindex gnus-cite-hide-absolute
6543 The cited text must have at least this length (default 10) before it
6544 is hidden.
6545 @end table
6546
6547 @item W W C
6548 @kindex W W C (Summary)
6549 @findex gnus-article-hide-citation-in-followups
6550 Hide cited text in articles that aren't roots
6551 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6552 useful as an interactive command, but might be a handy function to stick
6553 have happen automatically (@pxref{Customizing Articles}).
6554
6555 @end table
6556
6557 All these ``hiding'' commands are toggles, but if you give a negative
6558 prefix to these commands, they will show what they have previously
6559 hidden.  If you give a positive prefix, they will always hide.
6560
6561 Also @pxref{Article Highlighting} for further variables for
6562 citation customization.
6563
6564 @xref{Customizing Articles} for how to hide article elements
6565 automatically.
6566
6567
6568 @node Article Washing
6569 @subsection Article Washing
6570 @cindex washing
6571 @cindex article washing
6572
6573 We call this ``article washing'' for a really good reason.  Namely, the
6574 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6575
6576 @dfn{Washing} is defined by us as ``changing something from something to
6577 something else'', but normally results in something looking better.
6578 Cleaner, perhaps.
6579
6580 @table @kbd
6581
6582 @item W l
6583 @kindex W l (Summary)
6584 @findex gnus-summary-stop-page-breaking
6585 Remove page breaks from the current article
6586 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article} for page
6587 delimiters.
6588
6589 @item W r
6590 @kindex W r (Summary)
6591 @findex gnus-summary-caesar-message
6592 @c @icon{gnus-summary-caesar-message}
6593 Do a Caesar rotate (rot13) on the article buffer
6594 (@code{gnus-summary-caesar-message}).
6595 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6596 (Typically offensive jokes and such.)
6597
6598 It's commonly called ``rot13'' because each letter is rotated 13
6599 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6600 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6601 is rumored to have employed this form of, uh, somewhat weak encryption.
6602
6603 @item W t
6604 @kindex W t (Summary)
6605 @findex gnus-summary-toggle-header
6606 Toggle whether to display all headers in the article buffer
6607 (@code{gnus-summary-toggle-header}).
6608
6609 @item W v
6610 @kindex W v (Summary)
6611 @findex gnus-summary-verbose-header
6612 Toggle whether to display all headers in the article buffer permanently
6613 (@code{gnus-summary-verbose-header}).
6614
6615 @item W m
6616 @kindex W m (Summary)
6617 @findex gnus-summary-toggle-mime
6618 Toggle whether to run the article through @sc{mime} before displaying
6619 (@code{gnus-summary-toggle-mime}).
6620
6621 @item W o
6622 @kindex W o (Summary)
6623 @findex gnus-article-treat-overstrike
6624 Treat overstrike (@code{gnus-article-treat-overstrike}).
6625
6626 @item W d
6627 @kindex W d (Summary)
6628 @findex gnus-article-treat-dumbquotes
6629 @vindex gnus-article-dumbquotes-map
6630 @cindex Smartquotes
6631 @cindex M******** sm*rtq**t*s
6632 @cindex Latin 1
6633 Treat M******** sm*rtq**t*s according to
6634 @code{gnus-article-dumbquotes-map}
6635 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
6636 whether a character is a sm*rtq**t* or not, so it should only be used
6637 interactively.
6638
6639 @item W w
6640 @kindex W w (Summary)
6641 @findex gnus-article-fill-cited-article
6642 Do word wrap (@code{gnus-article-fill-cited-article}).
6643
6644 You can give the command a numerical prefix to specify the width to use
6645 when filling.
6646
6647 @item W q
6648 @kindex W q (Summary)
6649 @findex gnus-article-fill-long-lines
6650 Fill long lines (@code{gnus-article-fill-long-lines}).
6651
6652 @item W C
6653 @kindex W C (Summary)
6654 @findex gnus-article-capitalize-sentencse
6655 Capitalize the first word in each sentence
6656 (@code{gnus-article-capitalize-sentences}).
6657
6658 @item W c
6659 @kindex W c (Summary)
6660 @findex gnus-article-remove-cr
6661 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6662 (this takes care of DOS line endings), and then translate any remaining
6663 CRs into LF (this takes care of Mac line endings)
6664 (@code{gnus-article-remove-cr}).
6665
6666 @item W f
6667 @kindex W f (Summary)
6668 @cindex x-face
6669 @findex gnus-article-display-x-face
6670 @findex gnus-article-x-face-command
6671 @vindex gnus-article-x-face-command
6672 @vindex gnus-article-x-face-too-ugly
6673 @iftex
6674 @iflatex
6675 \include{xface}
6676 @end iflatex
6677 @end iftex
6678 Look for and display any X-Face headers
6679 (@code{gnus-article-display-x-face}).  The command executed by this
6680 function is given by the @code{gnus-article-x-face-command} variable.
6681 If this variable is a string, this string will be executed in a
6682 sub-shell.  If it is a function, this function will be called with the
6683 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6684 is a regexp) matches the @code{From} header, the face will not be shown.
6685 The default action under Emacs is to fork off an @code{xv} to view the
6686 face; under XEmacs the default action is to display the face before the
6687 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6688 support---that will make display somewhat faster.  If there's no native
6689 X-Face support, Gnus will try to convert the @code{X-Face} header using
6690 external programs from the @code{pbmplus} package and friends.)  If you
6691 want to have this function in the display hook, it should probably come
6692 last.
6693
6694 @item W b
6695 @kindex W b (Summary)
6696 @findex gnus-article-add-buttons
6697 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6698 @xref{Article Buttons}.
6699
6700 @item W B
6701 @kindex W B (Summary)
6702 @findex gnus-article-add-buttons-to-head
6703 Add clickable buttons to the article headers
6704 (@code{gnus-article-add-buttons-to-head}).
6705
6706 @item W E l
6707 @kindex W E l (Summary)
6708 @findex gnus-article-strip-leading-blank-lines
6709 Remove all blank lines from the beginning of the article
6710 (@code{gnus-article-strip-leading-blank-lines}).
6711
6712 @item W E m
6713 @kindex W E m (Summary)
6714 @findex gnus-article-strip-multiple-blank-lines
6715 Replace all blank lines with empty lines and then all multiple empty
6716 lines with a single empty line.
6717 (@code{gnus-article-strip-multiple-blank-lines}).
6718
6719 @item W E t
6720 @kindex W E t (Summary)
6721 @findex gnus-article-remove-trailing-blank-lines
6722 Remove all blank lines at the end of the article
6723 (@code{gnus-article-remove-trailing-blank-lines}).
6724
6725 @item W E a
6726 @kindex W E a (Summary)
6727 @findex gnus-article-strip-blank-lines
6728 Do all the three commands above
6729 (@code{gnus-article-strip-blank-lines}).
6730
6731 @item W E A
6732 @kindex W E A (Summary)
6733 @findex gnus-article-strip-all-blank-lines
6734 Remove all blank lines
6735 (@code{gnus-article-strip-all-blank-lines}).
6736
6737 @item W E s
6738 @kindex W E s (Summary)
6739 @findex gnus-article-strip-leading-space
6740 Remove all white space from the beginning of all lines of the article
6741 body (@code{gnus-article-strip-leading-space}).
6742
6743 @item W E e
6744 @kindex W E e (Summary)
6745 @findex gnus-article-strip-trailing-space
6746 Remove all white space from the end of all lines of the article
6747 body (@code{gnus-article-strip-trailing-space}).
6748
6749 @end table
6750
6751 @xref{Customizing Articles} for how to wash articles automatically.
6752
6753
6754 @node Article Buttons
6755 @subsection Article Buttons
6756 @cindex buttons
6757
6758 People often include references to other stuff in articles, and it would
6759 be nice if Gnus could just fetch whatever it is that people talk about
6760 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6761 button on these references.
6762
6763 Gnus adds @dfn{buttons} to certain standard references by default:
6764 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6765 two variables, one that handles article bodies and one that handles
6766 article heads:
6767
6768 @table @code
6769
6770 @item gnus-button-alist
6771 @vindex gnus-button-alist
6772 This is an alist where each entry has this form:
6773
6774 @lisp
6775 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6776 @end lisp
6777
6778 @table @var
6779
6780 @item regexp
6781 All text that match this regular expression will be considered an
6782 external reference.  Here's a typical regexp that matches embedded URLs:
6783 @samp{<URL:\\([^\n\r>]*\\)>}.
6784
6785 @item button-par
6786 Gnus has to know which parts of the matches is to be highlighted.  This
6787 is a number that says what sub-expression of the regexp is to be
6788 highlighted.  If you want it all highlighted, you use 0 here.
6789
6790 @item use-p
6791 This form will be @code{eval}ed, and if the result is non-@code{nil},
6792 this is considered a match.  This is useful if you want extra sifting to
6793 avoid false matches.
6794
6795 @item function
6796 This function will be called when you click on this button.
6797
6798 @item data-par
6799 As with @var{button-par}, this is a sub-expression number, but this one
6800 says which part of the match is to be sent as data to @var{function}.
6801
6802 @end table
6803
6804 So the full entry for buttonizing URLs is then
6805
6806 @lisp
6807 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6808 @end lisp
6809
6810 @item gnus-header-button-alist
6811 @vindex gnus-header-button-alist
6812 This is just like the other alist, except that it is applied to the
6813 article head only, and that each entry has an additional element that is
6814 used to say what headers to apply the buttonize coding to:
6815
6816 @lisp
6817 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6818 @end lisp
6819
6820 @var{HEADER} is a regular expression.
6821
6822 @item gnus-button-url-regexp
6823 @vindex gnus-button-url-regexp
6824 A regular expression that matches embedded URLs.  It is used in the
6825 default values of the variables above.
6826
6827 @item gnus-article-button-face
6828 @vindex gnus-article-button-face
6829 Face used on buttons.
6830
6831 @item gnus-article-mouse-face
6832 @vindex gnus-article-mouse-face
6833 Face used when the mouse cursor is over a button.
6834
6835 @end table
6836
6837 @xref{Customizing Articles} for how to buttonize articles automatically.
6838
6839
6840 @node Article Date
6841 @subsection Article Date
6842
6843 The date is most likely generated in some obscure timezone you've never
6844 heard of, so it's quite nice to be able to find out what the time was
6845 when the article was sent.
6846
6847 @table @kbd
6848
6849 @item W T u
6850 @kindex W T u (Summary)
6851 @findex gnus-article-date-ut
6852 Display the date in UT (aka. GMT, aka ZULU)
6853 (@code{gnus-article-date-ut}).
6854
6855 @item W T i
6856 @kindex W T i (Summary)
6857 @findex gnus-article-date-iso8601
6858 @cindex ISO 8601
6859 Display the date in international format, aka. ISO 8601
6860 (@code{gnus-article-date-iso8601}).
6861
6862 @item W T l
6863 @kindex W T l (Summary)
6864 @findex gnus-article-date-local
6865 Display the date in the local timezone (@code{gnus-article-date-local}).
6866
6867 @item W T s
6868 @kindex W T s (Summary)
6869 @vindex gnus-article-time-format
6870 @findex gnus-article-date-user
6871 @findex format-time-string
6872 Display the date using a user-defined format
6873 (@code{gnus-article-date-user}).  The format is specified by the
6874 @code{gnus-article-time-format} variable, and is a string that's passed
6875 to @code{format-time-string}.  See the documentation of that variable
6876 for a list of possible format specs.
6877
6878 @item W T e
6879 @kindex W T e (Summary)
6880 @findex gnus-article-date-lapsed
6881 @findex gnus-start-date-timer
6882 @findex gnus-stop-date-timer
6883 Say how much time has elapsed between the article was posted and now
6884 (@code{gnus-article-date-lapsed}).  If you want to have this line
6885 updated continually, you can put
6886
6887 @lisp
6888 (gnus-start-date-timer)
6889 @end lisp
6890
6891 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6892 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6893 command.
6894
6895 @item W T o
6896 @kindex W T o (Summary)
6897 @findex gnus-article-date-original
6898 Display the original date (@code{gnus-article-date-original}).  This can
6899 be useful if you normally use some other conversion function and are
6900 worried that it might be doing something totally wrong.  Say, claiming
6901 that the article was posted in 1854.  Although something like that is
6902 @emph{totally} impossible.  Don't you trust me? *titter*
6903
6904 @end table
6905
6906 @xref{Customizing Articles} for how to display the date in your
6907 preferred format automatically.
6908
6909
6910 @node Article Signature
6911 @subsection Article Signature
6912 @cindex signatures
6913 @cindex article signature
6914
6915 @vindex gnus-signature-separator
6916 Each article is divided into two parts---the head and the body.  The
6917 body can be divided into a signature part and a text part.  The variable
6918 that says what is to be considered a signature is
6919 @code{gnus-signature-separator}.  This is normally the standard
6920 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6921 non-standard signature separators, so this variable can also be a list
6922 of regular expressions to be tested, one by one.  (Searches are done
6923 from the end of the body towards the beginning.)  One likely value is:
6924
6925 @lisp
6926 (setq gnus-signature-separator
6927       '("^-- $"         ; The standard
6928         "^-- *$"        ; A common mangling
6929         "^-------*$"    ; Many people just use a looong
6930                         ; line of dashes.  Shame!
6931         "^ *--------*$" ; Double-shame!
6932         "^________*$"   ; Underscores are also popular
6933         "^========*$")) ; Pervert!
6934 @end lisp
6935
6936 The more permissive you are, the more likely it is that you'll get false
6937 positives.
6938
6939 @vindex gnus-signature-limit
6940 @code{gnus-signature-limit} provides a limit to what is considered a
6941 signature.
6942
6943 @enumerate
6944 @item
6945 If it is an integer, no signature may be longer (in characters) than
6946 that integer.
6947 @item
6948 If it is a floating point number, no signature may be longer (in lines)
6949 than that number.
6950 @item
6951 If it is a function, the function will be called without any parameters,
6952 and if it returns @code{nil}, there is no signature in the buffer.
6953 @item
6954 If it is a string, it will be used as a regexp.  If it matches, the text
6955 in question is not a signature.
6956 @end enumerate
6957
6958 This variable can also be a list where the elements may be of the types
6959 listed above.  Here's an example:
6960
6961 @lisp
6962 (setq gnus-signature-limit
6963       '(200.0 "^---*Forwarded article"))
6964 @end lisp
6965
6966 This means that if there are more than 200 lines after the signature
6967 separator, or the text after the signature separator is matched by
6968 the regular expression @samp{^---*Forwarded article}, then it isn't a
6969 signature after all.
6970
6971
6972 @node MIME Commands
6973 @section MIME Commands
6974 @cindex MIME decoding
6975
6976 @table @kbd
6977 @item M-t
6978 @kindex M-t (Summary)
6979 @findex gnus-summary-display-buttonized
6980 Toggle the buttonized display of the article buffer
6981 (@code{gnus-summary-toggle-display-buttonized}).
6982
6983 @item W M w
6984 @kindex W M w (Summary)
6985 Decode RFC2047-encoded words in the article headers
6986 (@code{gnus-article-decode-mime-words}).
6987
6988 @item W M c
6989 @kindex W M c (Summary)
6990 Decode encoded article bodies as well as charsets
6991 (@code{gnus-article-decode-charset}).
6992
6993 This command looks in the @code{Content-Type} header to determine the
6994 charset.  If there is no such header in the article, you can give it a
6995 prefix, which will prompt for the charset to decode as.  In regional
6996 groups where people post using some common encoding (but do not include
6997 MIME headers), you can set the @code{charset} group/topic parameter to
6998 the required charset (@pxref{Group Parameters}).
6999
7000 @item W M v
7001 @kindex W M v (Summary)
7002 View all the @sc{mime} parts in the current article
7003 (@code{gnus-mime-view-all-parts}).
7004
7005 @end table
7006
7007 Relevant variables:
7008
7009 @table @code
7010 @item gnus-ignored-mime-types
7011 @vindex gnus-ignored-mime-types
7012 This is a list of regexps.  @sc{mime} types that match a regexp from
7013 this list will be completely ignored by Gnus.  The default value is
7014 @code{nil}.
7015
7016 To have all Vcards be ignored, you'd say something like this:
7017
7018 @lisp
7019 (setq gnus-ignored-mime-types
7020       '("text/x-vcard"))
7021 @end lisp
7022
7023 @item gnus-unbuttonized-mime-types
7024 @vindex gnus-unbuttonized-mime-types
7025 This is a list of regexps.  @sc{mime} types that match a regexp from
7026 this list won't have @sc{mime} buttons inserted unless they aren't
7027 displayed.  The default value is @code{(".*/.*")}.
7028
7029 @item gnus-article-mime-part-function
7030 @vindex gnus-article-mime-part-function
7031 For each @sc{mime} part, this function will be called with the @sc{mime}
7032 handle as the parameter.  The function is meant to be used to allow
7033 users to gather information from the article (e. g., add Vcard info to
7034 the bbdb database) or to do actions based on parts (e. g., automatically
7035 save all jpegs into some directory).
7036
7037 Here's an example function the does the latter:
7038
7039 @lisp
7040 (defun my-save-all-jpeg-parts (handle)
7041   (when (equal (car (mm-handle-type handle)) "image/jpeg")
7042     (with-temp-buffer
7043       (insert (mm-get-part handle))
7044       (write-region (point-min) (point-max)
7045                     (read-file-name "Save jpeg to: ")))))
7046 (setq gnus-article-mime-part-function
7047       'my-save-all-jpeg-parts)
7048 @end lisp
7049
7050 @end table
7051
7052
7053 @node Charsets
7054 @section Charsets
7055 @cindex charsets
7056
7057 People use different charsets, and we have @sc{mime} to let us know what
7058 charsets they use.  Or rather, we wish we had.  Many people use
7059 newsreaders and mailers that do not understand or use @sc{mime}, and
7060 just send out messages without saying what character sets they use.  To
7061 help a bit with this, some local news hierarchies have policies that say
7062 what character set is the default.  For instance, the @samp{fj}
7063 hierarchy uses @code{iso-2022-jp-2}.
7064
7065 @vindex gnus-group-charset-alist
7066 This knowledge is encoded in the @code{gnus-group-charset-alist}
7067 variable, which is an alist of regexps (to match group names) and
7068 default charsets to be used when reading these groups.
7069
7070 In addition, some people do use soi-disant @sc{mime}-aware agents that
7071 aren't.  These blitely mark messages as being in @code{iso-8859-1} even
7072 if they really are in @code{koi-8}.  To help here, the
7073 @code{gnus-newsgroup-ignored-charsets} variable can be used.  The
7074 charsets that are listed here will be ignored.  The variable can be set
7075 on a group-by-group basis using the group parameters (@pxref{Group
7076 Parameters}).  The default value is @code{(unknown-8bit)}, which is
7077 something some agents insist on having in there.
7078
7079
7080 @node Article Commands
7081 @section Article Commands
7082
7083 @table @kbd
7084
7085 @item A P
7086 @cindex PostScript
7087 @cindex printing
7088 @kindex A P (Summary)
7089 @vindex gnus-ps-print-hook
7090 @findex gnus-summary-print-article
7091 Generate and print a PostScript image of the article buffer
7092 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
7093 run just before printing the buffer.
7094
7095 @end table
7096
7097
7098 @node Summary Sorting
7099 @section Summary Sorting
7100 @cindex summary sorting
7101
7102 You can have the summary buffer sorted in various ways, even though I
7103 can't really see why you'd want that.
7104
7105 @table @kbd
7106
7107 @item C-c C-s C-n
7108 @kindex C-c C-s C-n (Summary)
7109 @findex gnus-summary-sort-by-number
7110 Sort by article number (@code{gnus-summary-sort-by-number}).
7111
7112 @item C-c C-s C-a
7113 @kindex C-c C-s C-a (Summary)
7114 @findex gnus-summary-sort-by-author
7115 Sort by author (@code{gnus-summary-sort-by-author}).
7116
7117 @item C-c C-s C-s
7118 @kindex C-c C-s C-s (Summary)
7119 @findex gnus-summary-sort-by-subject
7120 Sort by subject (@code{gnus-summary-sort-by-subject}).
7121
7122 @item C-c C-s C-d
7123 @kindex C-c C-s C-d (Summary)
7124 @findex gnus-summary-sort-by-date
7125 Sort by date (@code{gnus-summary-sort-by-date}).
7126
7127 @item C-c C-s C-l
7128 @kindex C-c C-s C-l (Summary)
7129 @findex gnus-summary-sort-by-lines
7130 Sort by lines (@code{gnus-summary-sort-by-lines}).
7131
7132 @item C-c C-s C-i
7133 @kindex C-c C-s C-i (Summary)
7134 @findex gnus-summary-sort-by-score
7135 Sort by score (@code{gnus-summary-sort-by-score}).
7136 @end table
7137
7138 These functions will work both when you use threading and when you don't
7139 use threading.  In the latter case, all summary lines will be sorted,
7140 line by line.  In the former case, sorting will be done on a
7141 root-by-root basis, which might not be what you were looking for.  To
7142 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7143 Commands}).
7144
7145
7146 @node Finding the Parent
7147 @section Finding the Parent
7148 @cindex parent articles
7149 @cindex referring articles
7150
7151 @table @kbd
7152 @item ^
7153 @kindex ^ (Summary)
7154 @findex gnus-summary-refer-parent-article
7155 If you'd like to read the parent of the current article, and it is not
7156 displayed in the summary buffer, you might still be able to.  That is,
7157 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7158 and the @code{References} in the current article are not mangled, you
7159 can just press @kbd{^} or @kbd{A r}
7160 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
7161 you'll get the parent.  If the parent is already displayed in the
7162 summary buffer, point will just move to this article.
7163
7164 If given a positive numerical prefix, fetch that many articles back into
7165 the ancestry.  If given a negative numerical prefix, fetch just that
7166 ancestor.  So if you say @kbd{3 ^}, gnus will fetch the parent, the
7167 grandparent and the grandgrandparent of the current article.  If you say
7168 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
7169 article.
7170
7171 @item A R (Summary)
7172 @findex gnus-summary-refer-references
7173 @kindex A R (Summary)
7174 Fetch all articles mentioned in the @code{References} header of the
7175 article (@code{gnus-summary-refer-references}).
7176
7177 @item A T (Summary)
7178 @findex gnus-summary-refer-thread
7179 @kindex A T (Summary)
7180 Display the full thread where the current article appears
7181 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
7182 headers in the current group to work, so it usually takes a while.  If
7183 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7184 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
7185 visible effects normally, but it'll make this command work a whole lot
7186 faster.  Of course, it'll make group entry somewhat slow.
7187
7188 @vindex gnus-refer-thread-limit
7189 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7190 articles before the first displayed in the current group) headers to
7191 fetch when doing this command.  The default is 200.  If @code{t}, all
7192 the available headers will be fetched.  This variable can be overridden
7193 by giving the @kbd{A T} command a numerical prefix.
7194
7195 @item M-^ (Summary)
7196 @findex gnus-summary-refer-article
7197 @kindex M-^ (Summary)
7198 @cindex Message-ID
7199 @cindex fetching by Message-ID
7200 You can also ask the @sc{nntp} server for an arbitrary article, no
7201 matter what group it belongs to.  @kbd{M-^}
7202 (@code{gnus-summary-refer-article}) will ask you for a
7203 @code{Message-ID}, which is one of those long, hard-to-read thingies
7204 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
7205 have to get it all exactly right.  No fuzzy searches, I'm afraid.
7206 @end table
7207
7208 The current select method will be used when fetching by
7209 @code{Message-ID} from non-news select method, but you can override this
7210 by giving this command a prefix.
7211
7212 @vindex gnus-refer-article-method
7213 If the group you are reading is located on a backend that does not
7214 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7215 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
7216 would, perhaps, be best if the @sc{nntp} server you consult is the one
7217 updating the spool you are reading from, but that's not really
7218 necessary.
7219
7220 Most of the mail backends support fetching by @code{Message-ID}, but do
7221 not do a particularly excellent job at it.  That is, @code{nnmbox} and
7222 @code{nnbabyl} are able to locate articles from any groups, while
7223 @code{nnml} and @code{nnfolder} are only able to locate articles that
7224 have been posted to the current group.  (Anything else would be too time
7225 consuming.)  @code{nnmh} does not support this at all.
7226
7227
7228 @node Alternative Approaches
7229 @section Alternative Approaches
7230
7231 Different people like to read news using different methods.  This being
7232 gnus, we offer a small selection of minor modes for the summary buffers.
7233
7234 @menu
7235 * Pick and Read::               First mark articles and then read them.
7236 * Binary Groups::               Auto-decode all articles.
7237 @end menu
7238
7239
7240 @node Pick and Read
7241 @subsection Pick and Read
7242 @cindex pick and read
7243
7244 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7245 a two-phased reading interface.  The user first marks in a summary
7246 buffer the articles she wants to read.  Then she starts reading the
7247 articles with just an article buffer displayed.
7248
7249 @findex gnus-pick-mode
7250 @kindex M-x gnus-pick-mode
7251 Gnus provides a summary buffer minor mode that allows
7252 this---@code{gnus-pick-mode}.  This basically means that a few process
7253 mark commands become one-keystroke commands to allow easy marking, and
7254 it provides one additional command for switching to the summary buffer.
7255
7256 Here are the available keystrokes when using pick mode:
7257
7258 @table @kbd
7259 @item .
7260 @kindex . (Pick)
7261 @findex gnus-pick-article-or-thread
7262 Pick the article or thread on the current line
7263 (@code{gnus-pick-article-or-thread}).  If the variable
7264 @code{gnus-thread-hide-subtree} is true, then this key selects the
7265 entire thread when used at the first article of the thread.  Otherwise,
7266 it selects just the article. If given a numerical prefix, go to that
7267 thread or article and pick it.  (The line number is normally displayed
7268 at the beginning of the summary pick lines.)
7269
7270 @item SPACE
7271 @kindex SPACE (Pick)
7272 @findex gnus-pick-next-page
7273 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
7274 at the end of the buffer, start reading the picked articles.
7275
7276 @item u
7277 @kindex u (Pick)
7278 @findex gnus-pick-unmark-article-or-thread.
7279 Unpick the thread or article
7280 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
7281 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7282 thread if used at the first article of the thread.  Otherwise it unpicks
7283 just the article.  You can give this key a numerical prefix to unpick
7284 the thread or article at that line.
7285
7286 @item RET
7287 @kindex RET (Pick)
7288 @findex gnus-pick-start-reading
7289 @vindex gnus-pick-display-summary
7290 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
7291 given a prefix, mark all unpicked articles as read first.  If
7292 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7293 will still be visible when you are reading.
7294
7295 @end table
7296
7297 All the normal summary mode commands are still available in the
7298 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
7299 which is mapped to the same function
7300 @code{gnus-summary-tick-article-forward}.
7301
7302 If this sounds like a good idea to you, you could say:
7303
7304 @lisp
7305 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7306 @end lisp
7307
7308 @vindex gnus-pick-mode-hook
7309 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7310
7311 @vindex gnus-mark-unpicked-articles-as-read
7312 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7313 all unpicked articles as read.  The default is @code{nil}.
7314
7315 @vindex gnus-summary-pick-line-format
7316 The summary line format in pick mode is slightly different from the
7317 standard format.  At the beginning of each line the line number is
7318 displayed.  The pick mode line format is controlled by the
7319 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7320 Variables}).  It accepts the same format specs that
7321 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7322
7323
7324 @node Binary Groups
7325 @subsection Binary Groups
7326 @cindex binary groups
7327
7328 @findex gnus-binary-mode
7329 @kindex M-x gnus-binary-mode
7330 If you spend much time in binary groups, you may grow tired of hitting
7331 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
7332 is a minor mode for summary buffers that makes all ordinary Gnus article
7333 selection functions uudecode series of articles and display the result
7334 instead of just displaying the articles the normal way.
7335
7336 @kindex g (Binary)
7337 @findex gnus-binary-show-article
7338 The only way, in fact, to see the actual articles is the @kbd{g}
7339 command, when you have turned on this mode
7340 (@code{gnus-binary-show-article}).
7341
7342 @vindex gnus-binary-mode-hook
7343 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7344
7345
7346 @node Tree Display
7347 @section Tree Display
7348 @cindex trees
7349
7350 @vindex gnus-use-trees
7351 If you don't like the normal gnus summary display, you might try setting
7352 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
7353 additional @dfn{tree buffer}.  You can execute all summary mode commands
7354 in the tree buffer.
7355
7356 There are a few variables to customize the tree display, of course:
7357
7358 @table @code
7359 @item gnus-tree-mode-hook
7360 @vindex gnus-tree-mode-hook
7361 A hook called in all tree mode buffers.
7362
7363 @item gnus-tree-mode-line-format
7364 @vindex gnus-tree-mode-line-format
7365 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7366 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
7367 of valid specs, @pxref{Summary Buffer Mode Line}.
7368
7369 @item gnus-selected-tree-face
7370 @vindex gnus-selected-tree-face
7371 Face used for highlighting the selected article in the tree buffer.  The
7372 default is @code{modeline}.
7373
7374 @item gnus-tree-line-format
7375 @vindex gnus-tree-line-format
7376 A format string for the tree nodes.  The name is a bit of a misnomer,
7377 though---it doesn't define a line, but just the node.  The default value
7378 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7379 the name of the poster.  It is vital that all nodes are of the same
7380 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7381
7382 Valid specs are:
7383
7384 @table @samp
7385 @item n
7386 The name of the poster.
7387 @item f
7388 The @code{From} header.
7389 @item N
7390 The number of the article.
7391 @item [
7392 The opening bracket.
7393 @item ]
7394 The closing bracket.
7395 @item s
7396 The subject.
7397 @end table
7398
7399 @xref{Formatting Variables}.
7400
7401 Variables related to the display are:
7402
7403 @table @code
7404 @item gnus-tree-brackets
7405 @vindex gnus-tree-brackets
7406 This is used for differentiating between ``real'' articles and
7407 ``sparse'' articles.  The format is @var{((real-open . real-close)
7408 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7409 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7410
7411 @item gnus-tree-parent-child-edges
7412 @vindex gnus-tree-parent-child-edges
7413 This is a list that contains the characters used for connecting parent
7414 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
7415
7416 @end table
7417
7418 @item gnus-tree-minimize-window
7419 @vindex gnus-tree-minimize-window
7420 If this variable is non-@code{nil}, gnus will try to keep the tree
7421 buffer as small as possible to allow more room for the other gnus
7422 windows.  If this variable is a number, the tree buffer will never be
7423 higher than that number.  The default is @code{t}.  Note that if you
7424 have several windows displayed side-by-side in a frame and the tree
7425 buffer is one of these, minimizing the tree window will also resize all
7426 other windows displayed next to it.
7427
7428 @item gnus-generate-tree-function
7429 @vindex gnus-generate-tree-function
7430 @findex gnus-generate-horizontal-tree
7431 @findex gnus-generate-vertical-tree
7432 The function that actually generates the thread tree.  Two predefined
7433 functions are available: @code{gnus-generate-horizontal-tree} and
7434 @code{gnus-generate-vertical-tree} (which is the default).
7435
7436 @end table
7437
7438 Here's an example from a horizontal tree buffer:
7439
7440 @example
7441 @{***@}-(***)-[odd]-[Gun]
7442      |      \[Jan]
7443      |      \[odd]-[Eri]
7444      |      \(***)-[Eri]
7445      |            \[odd]-[Paa]
7446      \[Bjo]
7447      \[Gun]
7448      \[Gun]-[Jor]
7449 @end example
7450
7451 Here's the same thread displayed in a vertical tree buffer:
7452
7453 @example
7454 @{***@}
7455   |--------------------------\-----\-----\
7456 (***)                         [Bjo] [Gun] [Gun]
7457   |--\-----\-----\                          |
7458 [odd] [Jan] [odd] (***)                   [Jor]
7459   |           |     |--\
7460 [Gun]       [Eri] [Eri] [odd]
7461                           |
7462                         [Paa]
7463 @end example
7464
7465 If you're using horizontal trees, it might be nice to display the trees
7466 side-by-side with the summary buffer.  You could add something like the
7467 following to your @file{.gnus.el} file:
7468
7469 @lisp
7470 (setq gnus-use-trees t
7471       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7472       gnus-tree-minimize-window nil)
7473 (gnus-add-configuration
7474  '(article
7475    (vertical 1.0
7476              (horizontal 0.25
7477                          (summary 0.75 point)
7478                          (tree 1.0))
7479              (article 1.0))))
7480 @end lisp
7481
7482 @xref{Windows Configuration}.
7483
7484
7485 @node Mail Group Commands
7486 @section Mail Group Commands
7487 @cindex mail group commands
7488
7489 Some commands only make sense in mail groups.  If these commands are
7490 invalid in the current group, they will raise a hell and let you know.
7491
7492 All these commands (except the expiry and edit commands) use the
7493 process/prefix convention (@pxref{Process/Prefix}).
7494
7495 @table @kbd
7496
7497 @item B e
7498 @kindex B e (Summary)
7499 @findex gnus-summary-expire-articles
7500 Expire all expirable articles in the group
7501 (@code{gnus-summary-expire-articles}).
7502
7503 @item B M-C-e
7504 @kindex B M-C-e (Summary)
7505 @findex gnus-summary-expire-articles-now
7506 Delete all the expirable articles in the group
7507 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7508 articles eligible for expiry in the current group will
7509 disappear forever into that big @file{/dev/null} in the sky.
7510
7511 @item B DEL
7512 @kindex B DEL (Summary)
7513 @findex gnus-summary-delete-article
7514 @c @icon{gnus-summary-mail-delete}
7515 Delete the mail article.  This is ``delete'' as in ``delete it from your
7516 disk forever and ever, never to return again.'' Use with caution.
7517 (@code{gnus-summary-delete-article}).
7518
7519 @item B m
7520 @kindex B m (Summary)
7521 @cindex move mail
7522 @findex gnus-summary-move-article
7523 Move the article from one mail group to another
7524 (@code{gnus-summary-move-article}).
7525
7526 @item B c
7527 @kindex B c (Summary)
7528 @cindex copy mail
7529 @findex gnus-summary-copy-article
7530 @c @icon{gnus-summary-mail-copy}
7531 Copy the article from one group (mail group or not) to a mail group
7532 (@code{gnus-summary-copy-article}).
7533
7534 @item B B
7535 @kindex B B (Summary)
7536 @cindex crosspost mail
7537 @findex gnus-summary-crosspost-article
7538 Crosspost the current article to some other group
7539 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7540 the article in the other group, and the Xref headers of the article will
7541 be properly updated.
7542
7543 @item B i
7544 @kindex B i (Summary)
7545 @findex gnus-summary-import-article
7546 Import an arbitrary file into the current mail newsgroup
7547 (@code{gnus-summary-import-article}).  You will be prompted for a file
7548 name, a @code{From} header and a @code{Subject} header.
7549
7550 @item B r
7551 @kindex B r (Summary)
7552 @findex gnus-summary-respool-article
7553 Respool the mail article (@code{gnus-summary-respool-article}).
7554 @code{gnus-summary-respool-default-method} will be used as the default
7555 select method when respooling.  This variable is @code{nil} by default,
7556 which means that the current group select method will be used instead.
7557
7558 @item B w
7559 @itemx e
7560 @kindex B w (Summary)
7561 @kindex e (Summary)
7562 @findex gnus-summary-edit-article
7563 @kindex C-c C-c (Article)
7564 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7565 editing and make the changes permanent, type @kbd{C-c C-c}
7566 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7567 @kbd{C-c C-c} command, gnus won't re-highlight the article.
7568
7569 @item B q
7570 @kindex B q (Summary)
7571 @findex gnus-summary-respool-query
7572 If you want to re-spool an article, you might be curious as to what group
7573 the article will end up in before you do the re-spooling.  This command
7574 will tell you (@code{gnus-summary-respool-query}).
7575
7576 @item B t
7577 @kindex B t (Summary)
7578 @findex gnus-summary-respool-trace
7579 Similarly, this command will display all fancy splitting patterns used
7580 when repooling, if any (@code{gnus-summary-respool-trace}).
7581
7582 @item B p
7583 @kindex B p (Summary)
7584 @findex gnus-summary-article-posted-p
7585 Some people have a tendency to send you "courtesy" copies when they
7586 follow up to articles you have posted.  These usually have a
7587 @code{Newsgroups} header in them, but not always.  This command
7588 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7589 article from your news server (or rather, from
7590 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7591 report back whether it found the article or not.  Even if it says that
7592 it didn't find the article, it may have been posted anyway---mail
7593 propagation is much faster than news propagation, and the news copy may
7594 just not have arrived yet.
7595
7596 @end table
7597
7598 @vindex gnus-move-split-methods
7599 @cindex moving articles
7600 If you move (or copy) articles regularly, you might wish to have gnus
7601 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7602 variable that uses the same syntax as @code{gnus-split-methods}
7603 (@pxref{Saving Articles}).  You may customize that variable to create
7604 suggestions you find reasonable.
7605
7606 @lisp
7607 (setq gnus-move-split-methods
7608       '(("^From:.*Lars Magne" "nnml:junk")
7609         ("^Subject:.*gnus" "nnfolder:important")
7610         (".*" "nnml:misc")))
7611 @end lisp
7612
7613
7614 @node Various Summary Stuff
7615 @section Various Summary Stuff
7616
7617 @menu
7618 * Summary Group Information::         Information oriented commands.
7619 * Searching for Articles::            Multiple article commands.
7620 * Summary Generation Commands::       (Re)generating the summary buffer.
7621 * Really Various Summary Commands::   Those pesky non-conformant commands.
7622 @end menu
7623
7624 @table @code
7625 @vindex gnus-summary-mode-hook
7626 @item gnus-summary-mode-hook
7627 This hook is called when creating a summary mode buffer.
7628
7629 @vindex gnus-summary-generate-hook
7630 @item gnus-summary-generate-hook
7631 This is called as the last thing before doing the threading and the
7632 generation of the summary buffer.  It's quite convenient for customizing
7633 the threading variables based on what data the newsgroup has.  This hook
7634 is called from the summary buffer after most summary buffer variables
7635 have been set.
7636
7637 @vindex gnus-summary-prepare-hook
7638 @item gnus-summary-prepare-hook
7639 It is called after the summary buffer has been generated.  You might use
7640 it to, for instance, highlight lines or modify the look of the buffer in
7641 some other ungodly manner.  I don't care.
7642
7643 @vindex gnus-summary-prepared-hook
7644 @item gnus-summary-prepared-hook
7645 A hook called as the very last thing after the summary buffer has been
7646 generated.
7647
7648 @vindex gnus-summary-ignore-duplicates
7649 @item gnus-summary-ignore-duplicates
7650 When gnus discovers two articles that have the same @code{Message-ID},
7651 it has to do something drastic.  No articles are allowed to have the
7652 same @code{Message-ID}, but this may happen when reading mail from some
7653 sources.  Gnus allows you to customize what happens with this variable.
7654 If it is @code{nil} (which is the default), gnus will rename the
7655 @code{Message-ID} (for display purposes only) and display the article as
7656 any other article.  If this variable is @code{t}, it won't display the
7657 article---it'll be as if it never existed.
7658
7659 @end table
7660
7661
7662 @node Summary Group Information
7663 @subsection Summary Group Information
7664
7665 @table @kbd
7666
7667 @item H f
7668 @kindex H f (Summary)
7669 @findex gnus-summary-fetch-faq
7670 @vindex gnus-group-faq-directory
7671 Try to fetch the FAQ (list of frequently asked questions) for the
7672 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7673 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7674 on a remote machine.  This variable can also be a list of directories.
7675 In that case, giving a prefix to this command will allow you to choose
7676 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7677 be used for fetching the file.
7678
7679 @item H d
7680 @kindex H d (Summary)
7681 @findex gnus-summary-describe-group
7682 Give a brief description of the current group
7683 (@code{gnus-summary-describe-group}).  If given a prefix, force
7684 rereading the description from the server.
7685
7686 @item H h
7687 @kindex H h (Summary)
7688 @findex gnus-summary-describe-briefly
7689 Give an extremely brief description of the most important summary
7690 keystrokes (@code{gnus-summary-describe-briefly}).
7691
7692 @item H i
7693 @kindex H i (Summary)
7694 @findex gnus-info-find-node
7695 Go to the gnus info node (@code{gnus-info-find-node}).
7696 @end table
7697
7698
7699 @node Searching for Articles
7700 @subsection Searching for Articles
7701
7702 @table @kbd
7703
7704 @item M-s
7705 @kindex M-s (Summary)
7706 @findex gnus-summary-search-article-forward
7707 Search through all subsequent articles for a regexp
7708 (@code{gnus-summary-search-article-forward}).
7709
7710 @item M-r
7711 @kindex M-r (Summary)
7712 @findex gnus-summary-search-article-backward
7713 Search through all previous articles for a regexp
7714 (@code{gnus-summary-search-article-backward}).
7715
7716 @item &
7717 @kindex & (Summary)
7718 @findex gnus-summary-execute-command
7719 This command will prompt you for a header field, a regular expression to
7720 match on this field, and a command to be executed if the match is made
7721 (@code{gnus-summary-execute-command}).  If given a prefix, search
7722 backward instead.
7723
7724 @item M-&
7725 @kindex M-& (Summary)
7726 @findex gnus-summary-universal-argument
7727 Perform any operation on all articles that have been marked with
7728 the process mark (@code{gnus-summary-universal-argument}).
7729 @end table
7730
7731 @node Summary Generation Commands
7732 @subsection Summary Generation Commands
7733
7734 @table @kbd
7735
7736 @item Y g
7737 @kindex Y g (Summary)
7738 @findex gnus-summary-prepare
7739 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7740
7741 @item Y c
7742 @kindex Y c (Summary)
7743 @findex gnus-summary-insert-cached-articles
7744 Pull all cached articles (for the current group) into the summary buffer
7745 (@code{gnus-summary-insert-cached-articles}).
7746
7747 @end table
7748
7749
7750 @node Really Various Summary Commands
7751 @subsection Really Various Summary Commands
7752
7753 @table @kbd
7754
7755 @item C-d
7756 @kindex C-d (Summary)
7757 @findex gnus-summary-enter-digest-group
7758 If the current article is a collection of other articles (for instance,
7759 a digest), you might use this command to enter a group based on the that
7760 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7761 guess what article type is currently displayed unless you give a prefix
7762 to this command, which forces a ``digest'' interpretation.  Basically,
7763 whenever you see a message that is a collection of other messages of
7764 some format, you @kbd{C-d} and read these messages in a more convenient
7765 fashion.
7766
7767 @item M-C-d
7768 @kindex M-C-d (Summary)
7769 @findex gnus-summary-read-document
7770 This command is very similar to the one above, but lets you gather
7771 several documents into one biiig group
7772 (@code{gnus-summary-read-document}).  It does this by opening several
7773 @code{nndoc} groups for each document, and then opening an
7774 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7775 command understands the process/prefix convention
7776 (@pxref{Process/Prefix}).
7777
7778 @item C-t
7779 @kindex C-t (Summary)
7780 @findex gnus-summary-toggle-truncation
7781 Toggle truncation of summary lines
7782 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7783 line centering function in the summary buffer, so it's not a good idea
7784 to have truncation switched off while reading articles.
7785
7786 @item =
7787 @kindex = (Summary)
7788 @findex gnus-summary-expand-window
7789 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7790 If given a prefix, force an @code{article} window configuration.
7791
7792 @item M-C-e
7793 @kindex M-C-e (Summary)
7794 @findex gnus-summary-edit-parameters
7795 Edit the group parameters (@pxref{Group Parameters}) of the current
7796 group (@code{gnus-summary-edit-parameters}).
7797
7798 @item M-C-g
7799 @kindex M-C-g (Summary)
7800 @findex gnus-summary-customize-parameters
7801 Customize the group parameters (@pxref{Group Parameters}) of the current
7802 group (@code{gnus-summary-customize-parameters}).
7803
7804 @end table
7805
7806
7807 @node Exiting the Summary Buffer
7808 @section Exiting the Summary Buffer
7809 @cindex summary exit
7810 @cindex exiting groups
7811
7812 Exiting from the summary buffer will normally update all info on the
7813 group and return you to the group buffer.
7814
7815 @table @kbd
7816
7817 @item Z Z
7818 @itemx q
7819 @kindex Z Z (Summary)
7820 @kindex q (Summary)
7821 @findex gnus-summary-exit
7822 @vindex gnus-summary-exit-hook
7823 @vindex gnus-summary-prepare-exit-hook
7824 @c @icon{gnus-summary-exit}
7825 Exit the current group and update all information on the group
7826 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7827 called before doing much of the exiting, which calls
7828 @code{gnus-summary-expire-articles} by default.
7829 @code{gnus-summary-exit-hook} is called after finishing the exit
7830 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7831 group mode having no more (unread) groups.
7832
7833 @item Z E
7834 @itemx Q
7835 @kindex Z E (Summary)
7836 @kindex Q (Summary)
7837 @findex gnus-summary-exit-no-update
7838 Exit the current group without updating any information on the group
7839 (@code{gnus-summary-exit-no-update}).
7840
7841 @item Z c
7842 @itemx c
7843 @kindex Z c (Summary)
7844 @kindex c (Summary)
7845 @findex gnus-summary-catchup-and-exit
7846 @c @icon{gnus-summary-catchup-and-exit}
7847 Mark all unticked articles in the group as read and then exit
7848 (@code{gnus-summary-catchup-and-exit}).
7849
7850 @item Z C
7851 @kindex Z C (Summary)
7852 @findex gnus-summary-catchup-all-and-exit
7853 Mark all articles, even the ticked ones, as read and then exit
7854 (@code{gnus-summary-catchup-all-and-exit}).
7855
7856 @item Z n
7857 @kindex Z n (Summary)
7858 @findex gnus-summary-catchup-and-goto-next-group
7859 Mark all articles as read and go to the next group
7860 (@code{gnus-summary-catchup-and-goto-next-group}).
7861
7862 @item Z R
7863 @kindex Z R (Summary)
7864 @findex gnus-summary-reselect-current-group
7865 Exit this group, and then enter it again
7866 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7867 all articles, both read and unread.
7868
7869 @item Z G
7870 @itemx M-g
7871 @kindex Z G (Summary)
7872 @kindex M-g (Summary)
7873 @findex gnus-summary-rescan-group
7874 @c @icon{gnus-summary-mail-get}
7875 Exit the group, check for new articles in the group, and select the
7876 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7877 articles, both read and unread.
7878
7879 @item Z N
7880 @kindex Z N (Summary)
7881 @findex gnus-summary-next-group
7882 Exit the group and go to the next group
7883 (@code{gnus-summary-next-group}).
7884
7885 @item Z P
7886 @kindex Z P (Summary)
7887 @findex gnus-summary-prev-group
7888 Exit the group and go to the previous group
7889 (@code{gnus-summary-prev-group}).
7890
7891 @item Z s
7892 @kindex Z s (Summary)
7893 @findex gnus-summary-save-newsrc
7894 Save the current number of read/marked articles in the dribble buffer
7895 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7896 given a prefix, also save the @file{.newsrc} file(s).  Using this
7897 command will make exit without updating (the @kbd{Q} command) worthless.
7898 @end table
7899
7900 @vindex gnus-exit-group-hook
7901 @code{gnus-exit-group-hook} is called when you exit the current
7902 group.
7903
7904 @findex gnus-summary-wake-up-the-dead
7905 @findex gnus-dead-summary-mode
7906 @vindex gnus-kill-summary-on-exit
7907 If you're in the habit of exiting groups, and then changing your mind
7908 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7909 If you do that, gnus won't kill the summary buffer when you exit it.
7910 (Quelle surprise!)  Instead it will change the name of the buffer to
7911 something like @samp{*Dead Summary ... *} and install a minor mode
7912 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7913 buffer, you'll find that all keys are mapped to a function called
7914 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7915 summary buffer will result in a live, normal summary buffer.
7916
7917 There will never be more than one dead summary buffer at any one time.
7918
7919 @vindex gnus-use-cross-reference
7920 The data on the current group will be updated (which articles you have
7921 read, which articles you have replied to, etc.) when you exit the
7922 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7923 @code{t} (which is the default), articles that are cross-referenced to
7924 this group and are marked as read, will also be marked as read in the
7925 other subscribed groups they were cross-posted to.  If this variable is
7926 neither @code{nil} nor @code{t}, the article will be marked as read in
7927 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7928
7929
7930 @node Crosspost Handling
7931 @section Crosspost Handling
7932
7933 @cindex velveeta
7934 @cindex spamming
7935 Marking cross-posted articles as read ensures that you'll never have to
7936 read the same article more than once.  Unless, of course, somebody has
7937 posted it to several groups separately.  Posting the same article to
7938 several groups (not cross-posting) is called @dfn{spamming}, and you are
7939 by law required to send nasty-grams to anyone who perpetrates such a
7940 heinous crime.  You may want to try NoCeM handling to filter out spam
7941 (@pxref{NoCeM}).
7942
7943 Remember: Cross-posting is kinda ok, but posting the same article
7944 separately to several groups is not.  Massive cross-posting (aka.
7945 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7946 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7947 excessive crossposting (@pxref{Summary Mail Commands}).
7948
7949 @cindex cross-posting
7950 @cindex Xref
7951 @cindex @sc{nov}
7952 One thing that may cause Gnus to not do the cross-posting thing
7953 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7954 (which is very nice, because it speeds things up considerably) which
7955 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7956 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7957 even with @sc{xover} by registering the @code{Xref} lines of all
7958 articles you actually read, but if you kill the articles, or just mark
7959 them as read without reading them, Gnus will not get a chance to snoop
7960 the @code{Xref} lines out of these articles, and will be unable to use
7961 the cross reference mechanism.
7962
7963 @cindex LIST overview.fmt
7964 @cindex overview.fmt
7965 To check whether your @sc{nntp} server includes the @code{Xref} header
7966 in its overview files, try @samp{telnet your.nntp.server nntp},
7967 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7968 overview.fmt}.  This may not work, but if it does, and the last line you
7969 get does not read @samp{Xref:full}, then you should shout and whine at
7970 your news admin until she includes the @code{Xref} header in the
7971 overview files.
7972
7973 @vindex gnus-nov-is-evil
7974 If you want Gnus to get the @code{Xref}s right all the time, you have to
7975 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7976 considerably.
7977
7978 C'est la vie.
7979
7980 For an alternative approach, @pxref{Duplicate Suppression}.
7981
7982
7983 @node Duplicate Suppression
7984 @section Duplicate Suppression
7985
7986 By default, gnus tries to make sure that you don't have to read the same
7987 article more than once by utilizing the crossposting mechanism
7988 (@pxref{Crosspost Handling}).  However, that simple and efficient
7989 approach may not work satisfactory for some users for various
7990 reasons.
7991
7992 @enumerate
7993 @item
7994 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7995 is evil and not very common.
7996
7997 @item
7998 The @sc{nntp} server may fail to include the @code{Xref} header in the
7999 @file{.overview} data bases.  This is evil and all too common, alas.
8000
8001 @item
8002 You may be reading the same group (or several related groups) from
8003 different @sc{nntp} servers.
8004
8005 @item
8006 You may be getting mail that duplicates articles posted to groups.
8007 @end enumerate
8008
8009 I'm sure there are other situations where @code{Xref} handling fails as
8010 well, but these four are the most common situations.
8011
8012 If, and only if, @code{Xref} handling fails for you, then you may
8013 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
8014 will remember the @code{Message-ID}s of all articles you have read or
8015 otherwise marked as read, and then, as if by magic, mark them as read
8016 all subsequent times you see them---in @emph{all} groups.  Using this
8017 mechanism is quite likely to be somewhat inefficient, but not overly
8018 so.  It's certainly preferable to reading the same articles more than
8019 once.
8020
8021 Duplicate suppression is not a very subtle instrument.  It's more like a
8022 sledge hammer than anything else.  It works in a very simple
8023 fashion---if you have marked an article as read, it adds this Message-ID
8024 to a cache.  The next time it sees this Message-ID, it will mark the
8025 article as read with the @samp{M} mark.  It doesn't care what group it
8026 saw the article in.
8027
8028 @table @code
8029 @item gnus-suppress-duplicates
8030 @vindex gnus-suppress-duplicates
8031 If non-@code{nil}, suppress duplicates.
8032
8033 @item gnus-save-duplicate-list
8034 @vindex gnus-save-duplicate-list
8035 If non-@code{nil}, save the list of duplicates to a file.  This will
8036 make startup and shutdown take longer, so the default is @code{nil}.
8037 However, this means that only duplicate articles read in a single gnus
8038 session are suppressed.
8039
8040 @item gnus-duplicate-list-length
8041 @vindex gnus-duplicate-list-length
8042 This variable says how many @code{Message-ID}s to keep in the duplicate
8043 suppression list.  The default is 10000.
8044
8045 @item gnus-duplicate-file
8046 @vindex gnus-duplicate-file
8047 The name of the file to store the duplicate suppression list in.  The
8048 default is @file{~/News/suppression}.
8049 @end table
8050
8051 If you have a tendency to stop and start gnus often, setting
8052 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
8053 you leave gnus running for weeks on end, you may have it @code{nil}.  On
8054 the other hand, saving the list makes startup and shutdown much slower,
8055 so that means that if you stop and start gnus often, you should set
8056 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
8057 to you to figure out, I think.
8058
8059
8060 @node The Article Buffer
8061 @chapter The Article Buffer
8062 @cindex article buffer
8063
8064 The articles are displayed in the article buffer, of which there is only
8065 one.  All the summary buffers share the same article buffer unless you
8066 tell gnus otherwise.
8067
8068 @menu
8069 * Hiding Headers::        Deciding what headers should be displayed.
8070 * Using MIME::            Pushing to mime articles as @sc{mime} messages.
8071 * Customizing Articles::  Tailoring the look of the articles.
8072 * Article Keymap::        Keystrokes available in the article buffer.
8073 * Misc Article::          Other stuff.
8074 @end menu
8075
8076
8077 @node Hiding Headers
8078 @section Hiding Headers
8079 @cindex hiding headers
8080 @cindex deleting headers
8081
8082 The top section of each article is the @dfn{head}.  (The rest is the
8083 @dfn{body}, but you may have guessed that already.)
8084
8085 @vindex gnus-show-all-headers
8086 There is a lot of useful information in the head: the name of the person
8087 who wrote the article, the date it was written and the subject of the
8088 article.  That's well and nice, but there's also lots of information
8089 most people do not want to see---what systems the article has passed
8090 through before reaching you, the @code{Message-ID}, the
8091 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8092 of some of those lines.  If you want to keep all those lines in the
8093 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8094
8095 Gnus provides you with two variables for sifting headers:
8096
8097 @table @code
8098
8099 @item gnus-visible-headers
8100 @vindex gnus-visible-headers
8101 If this variable is non-@code{nil}, it should be a regular expression
8102 that says what headers you wish to keep in the article buffer.  All
8103 headers that do not match this variable will be hidden.
8104
8105 For instance, if you only want to see the name of the person who wrote
8106 the article and the subject, you'd say:
8107
8108 @lisp
8109 (setq gnus-visible-headers "^From:\\|^Subject:")
8110 @end lisp
8111
8112 This variable can also be a list of regexps to match headers to
8113 remain visible.
8114
8115 @item gnus-ignored-headers
8116 @vindex gnus-ignored-headers
8117 This variable is the reverse of @code{gnus-visible-headers}.  If this
8118 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8119 should be a regular expression that matches all lines that you want to
8120 hide.  All lines that do not match this variable will remain visible.
8121
8122 For instance, if you just want to get rid of the @code{References} field
8123 and the @code{Xref} field, you might say:
8124
8125 @lisp
8126 (setq gnus-ignored-headers "^References:\\|^Xref:")
8127 @end lisp
8128
8129 This variable can also be a list of regexps to match headers to
8130 be removed.
8131
8132 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8133 variable will have no effect.
8134
8135 @end table
8136
8137 @vindex gnus-sorted-header-list
8138 Gnus can also sort the headers for you.  (It does this by default.)  You
8139 can control the sorting by setting the @code{gnus-sorted-header-list}
8140 variable.  It is a list of regular expressions that says in what order
8141 the headers are to be displayed.
8142
8143 For instance, if you want the name of the author of the article first,
8144 and then the subject, you might say something like:
8145
8146 @lisp
8147 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8148 @end lisp
8149
8150 Any headers that are to remain visible, but are not listed in this
8151 variable, will be displayed in random order after all the headers listed in this variable.
8152
8153 @findex gnus-article-hide-boring-headers
8154 @vindex gnus-boring-article-headers
8155 You can hide further boring headers by setting
8156 @code{gnus-treat-hide-boring-headers} to @code{head}.  What this function
8157 does depends on the @code{gnus-boring-article-headers} variable.  It's a
8158 list, but this list doesn't actually contain header names.  Instead is
8159 lists various @dfn{boring conditions} that Gnus can check and remove
8160 from sight.
8161
8162 These conditions are:
8163 @table @code
8164 @item empty
8165 Remove all empty headers.
8166 @item followup-to
8167 Remove the @code{Followup-To} header if it is identical to the
8168 @code{Newsgroups} header.
8169 @item reply-to
8170 Remove the @code{Reply-To} header if it lists the same address as the
8171 @code{From} header.
8172 @item newsgroups
8173 Remove the @code{Newsgroups} header if it only contains the current group
8174 name.
8175 @item date
8176 Remove the @code{Date} header if the article is less than three days
8177 old.
8178 @item long-to
8179 Remove the @code{To} header if it is very long.
8180 @item many-to
8181 Remove all @code{To} headers if there are more than one.
8182 @end table
8183
8184 To include the four three elements, you could say something like;
8185
8186 @lisp
8187 (setq gnus-boring-article-headers
8188       '(empty followup-to reply-to))
8189 @end lisp
8190
8191 This is also the default value for this variable.
8192
8193
8194 @node Using MIME
8195 @section Using @sc{mime}
8196 @cindex @sc{mime}
8197
8198 Mime is a standard for waving your hands through the air, aimlessly,
8199 while people stand around yawning.
8200
8201 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8202 while all newsreaders die of fear.
8203
8204 @sc{mime} may specify what character set the article uses, the encoding
8205 of the characters, and it also makes it possible to embed pictures and
8206 other naughty stuff in innocent-looking articles.
8207
8208 @vindex gnus-show-mime
8209 @vindex gnus-article-display-method-for-mime
8210 @vindex gnus-strict-mime
8211 @findex gnus-article-display-mime-message
8212 Gnus handles @sc{mime} by pushing the articles through
8213 @code{gnus-article-display-method-for-mime}, which is
8214 @code{gnus-article-display-mime-message} by default.  This function
8215 calls the SEMI MIME-View program to actually do the work.  For more
8216 information on SEMI MIME-View, see its manual page (however it is not
8217 existed yet, sorry).
8218
8219 Set @code{gnus-show-mime} to @code{t} if you want to use
8220 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
8221 non-@code{nil}, the @sc{mime} method will only be used if there are
8222 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
8223 set, then you'll see some unfortunate display glitches in the article
8224 buffer.  These can't be avoided.
8225
8226 In GNUS or Gnus, it might be best to just use the toggling functions
8227 from the summary buffer to avoid getting nasty surprises. (For instance,
8228 you enter the group @samp{alt.sing-a-long} and, before you know it,
8229 @sc{mime} has decoded the sound file in the article and some horrible
8230 sing-a-long song comes screaming out your speakers, and you can't find
8231 the volume button, because there isn't one, and people are starting to
8232 look at you, and you try to stop the program, but you can't, and you
8233 can't find the program to control the volume, and everybody else in the
8234 room suddenly decides to look at you disdainfully, and you'll feel
8235 rather stupid.)
8236
8237 Any similarity to real events and people is purely coincidental.  Ahem.
8238
8239 To avoid such kind of situation, gnus stops to use
8240 @code{metamail-buffer}.  So now, you can set @code{gnus-show-mime} to
8241 non-@code{nil} every-time, then you can push button in the article
8242 buffer when there are nobody else.
8243
8244
8245 @node Customizing Articles
8246 @section Customizing Articles
8247 @cindex article customization
8248
8249 A slew of functions for customizing how the articles are to look like
8250 exist.  You can call these functions interactively, or you can have them
8251 called automatically when you select the articles.
8252
8253 To have them called automatically, you should set the corresponding
8254 ``treatment'' variable.  For instance, to have headers hidden, you'd set
8255 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
8256 be set, but first we discuss the values these variables can have.
8257
8258 @enumerate
8259 @item
8260 @code{nil}: Don't do this treatment.
8261
8262 @item
8263 @code{t}: Do this treatment on all body parts.
8264
8265 @item
8266 @code{head}: Do the treatment on the headers.
8267
8268 @item
8269 @code{last}: Do this treatment on the last part.
8270
8271 @item
8272 An integer: Do this treatment on all body parts that have a length less
8273 than this number.
8274
8275 @item
8276 A list:
8277
8278 The list is evaluated recursively.  The first element of the list is a
8279 predicate.  The following predicates are recognized: @code{or},
8280 @code{and}, @code{not} and @code{typep}.  Here's an example:
8281
8282 @lisp
8283 (or last
8284     (typep "text/x-vcard"))
8285 @end lisp
8286
8287 @end enumerate
8288
8289 You may have noticed that the word @dfn{part} is used here.  This refers
8290 to the fact that some messages are @sc{mime} multipart articles that may
8291 be divided into several parts.  Articles that are not multiparts are
8292 considered to contain just a single part.
8293
8294 @vindex gnus-article-treat-types
8295 Are the treatments applied to all sorts of multipart parts?  Yes, if you
8296 want to, but by default, only @samp{text/plain} parts are given the
8297 treatment.  This is controlled by the @code{gnus-article-treat-types}
8298 variable, which is a list of regular expressions that are matched to the
8299 type of the part.  This variable is ignored if the value of the
8300 controlling variable is a predicate list, as described above.
8301
8302 The following treatment options are available.  The easiest way to
8303 customize this is to examine the @code{gnus-article-treat} customization
8304 group.
8305
8306 @table @code
8307 @item gnus-treat-highlight-signature
8308 @item gnus-treat-buttonize
8309 @item gnus-treat-buttonize-head
8310 @item gnus-treat-emphasize
8311 @item gnus-treat-fill-article
8312 @item gnus-treat-strip-cr
8313 @item gnus-treat-hide-headers
8314 @item gnus-treat-hide-boring-headers
8315 @item gnus-treat-hide-signature
8316 @item gnus-treat-hide-citation
8317 @item gnus-treat-strip-pgp
8318 @item gnus-treat-strip-pem
8319 @item gnus-treat-highlight-headers
8320 @item gnus-treat-highlight-citation
8321 @item gnus-treat-highlight-signature
8322 @item gnus-treat-date-ut
8323 @item gnus-treat-date-local
8324 @item gnus-treat-date-lapsed
8325 @item gnus-treat-date-original
8326 @item gnus-treat-strip-trailing-blank-lines
8327 @item gnus-treat-strip-leading-blank-lines
8328 @item gnus-treat-strip-multiple-blank-lines
8329 @item gnus-treat-strip-blank-lines
8330 @item gnus-treat-overstrike
8331 @item gnus-treat-display-xface
8332 @item gnus-treat-display-smileys
8333 @item gnus-treat-display-picons
8334 @end table
8335
8336 @vindex gnus-part-display-hook
8337 You can, of course, write your own functions to be called from
8338 @code{gnus-part-display-hook}.  The functions are called narrowed to the
8339 part, and you can do anything you like, pretty much.  There is no
8340 information that you have to keep in the buffer---you can change
8341 everything.  However, you shouldn't delete any headers.  Instead make
8342 them invisible if you want to make them go away.
8343
8344
8345 @node Article Keymap
8346 @section Article Keymap
8347
8348 Most of the keystrokes in the summary buffer can also be used in the
8349 article buffer.  They should behave as if you typed them in the summary
8350 buffer, which means that you don't actually have to have a summary
8351 buffer displayed while reading.  You can do it all from the article
8352 buffer.
8353
8354 A few additional keystrokes are available:
8355
8356 @table @kbd
8357
8358 @item SPACE
8359 @kindex SPACE (Article)
8360 @findex gnus-article-next-page
8361 Scroll forwards one page (@code{gnus-article-next-page}).
8362
8363 @item DEL
8364 @kindex DEL (Article)
8365 @findex gnus-article-prev-page
8366 Scroll backwards one page (@code{gnus-article-prev-page}).
8367
8368 @item C-c ^
8369 @kindex C-c ^ (Article)
8370 @findex gnus-article-refer-article
8371 If point is in the neighborhood of a @code{Message-ID} and you press
8372 @kbd{C-c ^}, Gnus will try to get that article from the server
8373 (@code{gnus-article-refer-article}).
8374
8375 @item C-c C-m
8376 @kindex C-c C-m (Article)
8377 @findex gnus-article-mail
8378 Send a reply to the address near point (@code{gnus-article-mail}).  If
8379 given a prefix, include the mail.
8380
8381 @item s
8382 @kindex s (Article)
8383 @findex gnus-article-show-summary
8384 Reconfigure the buffers so that the summary buffer becomes visible
8385 (@code{gnus-article-show-summary}).
8386
8387 @item ?
8388 @kindex ? (Article)
8389 @findex gnus-article-describe-briefly
8390 Give a very brief description of the available keystrokes
8391 (@code{gnus-article-describe-briefly}).
8392
8393 @item TAB
8394 @kindex TAB (Article)
8395 @findex gnus-article-next-button
8396 Go to the next button, if any (@code{gnus-article-next-button}).  This
8397 only makes sense if you have buttonizing turned on.
8398
8399 @item M-TAB
8400 @kindex M-TAB (Article)
8401 @findex gnus-article-prev-button
8402 Go to the previous button, if any (@code{gnus-article-prev-button}).
8403
8404 @end table
8405
8406
8407 @node Misc Article
8408 @section Misc Article
8409
8410 @table @code
8411
8412 @item gnus-single-article-buffer
8413 @vindex gnus-single-article-buffer
8414 If non-@code{nil}, use the same article buffer for all the groups.
8415 (This is the default.)  If @code{nil}, each group will have its own
8416 article buffer.
8417
8418 @vindex gnus-article-decode-hook
8419 @item gnus-article-decode-hook
8420 @cindex MIME
8421 Hook used to decode @sc{mime} articles.  The default value is
8422 @code{(article-decode-charset article-decode-encoded-words)}
8423
8424 @vindex gnus-article-prepare-hook
8425 @item gnus-article-prepare-hook
8426 This hook is called right after the article has been inserted into the
8427 article buffer.  It is mainly intended for functions that do something
8428 depending on the contents; it should probably not be used for changing
8429 the contents of the article buffer.
8430
8431 @item gnus-article-mode-hook
8432 @vindex gnus-article-mode-hook
8433 Hook called in article mode buffers.
8434
8435 @item gnus-article-mode-syntax-table
8436 @vindex gnus-article-mode-syntax-table
8437 Syntax table used in article buffers.  It is initialized from
8438 @code{text-mode-syntax-table}.
8439
8440 @vindex gnus-article-mode-line-format
8441 @item gnus-article-mode-line-format
8442 This variable is a format string along the same lines as
8443 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
8444 accepts the same format specifications as that variable, with one
8445 extension:
8446
8447 @table @samp
8448 @item w
8449 The @dfn{wash status} of the article.  This is a short string with one
8450 character for each possible article wash operation that may have been
8451 performed.
8452 @item m
8453 The number of @sc{mime} parts in the article.
8454 @end table
8455
8456 @vindex gnus-break-pages
8457
8458 @item gnus-break-pages
8459 Controls whether @dfn{page breaking} is to take place.  If this variable
8460 is non-@code{nil}, the articles will be divided into pages whenever a
8461 page delimiter appears in the article.  If this variable is @code{nil},
8462 paging will not be done.
8463
8464 @item gnus-page-delimiter
8465 @vindex gnus-page-delimiter
8466 This is the delimiter mentioned above.  By default, it is @samp{^L}
8467 (formfeed).
8468 @end table
8469
8470
8471 @node Composing Messages
8472 @chapter Composing Messages
8473 @cindex composing messages
8474 @cindex messages
8475 @cindex mail
8476 @cindex sending mail
8477 @cindex reply
8478 @cindex followup
8479 @cindex post
8480
8481 @kindex C-c C-c (Post)
8482 All commands for posting and mailing will put you in a message buffer
8483 where you can edit the article all you like, before you send the article
8484 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
8485 Manual}.  If you are in a foreign news group, and you wish to post the
8486 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8487 to make gnus try to post using the foreign server.
8488
8489 @menu
8490 * Mail::                 Mailing and replying.
8491 * Post::                 Posting and following up.
8492 * Posting Server::       What server should you post via?
8493 * Mail and Post::        Mailing and posting at the same time.
8494 * Archived Messages::    Where gnus stores the messages you've sent.
8495 * Posting Styles::       An easier way to specify who you are.
8496 * Drafts::               Postponing messages and rejected messages.
8497 * Rejected Articles::    What happens if the server doesn't like your article?
8498 @end menu
8499
8500 Also see @pxref{Canceling and Superseding} for information on how to
8501 remove articles you shouldn't have posted.
8502
8503
8504 @node Mail
8505 @section Mail
8506
8507 Variables for customizing outgoing mail:
8508
8509 @table @code
8510 @item gnus-uu-digest-headers
8511 @vindex gnus-uu-digest-headers
8512 List of regexps to match headers included in digested messages.  The
8513 headers will be included in the sequence they are matched.
8514
8515 @item gnus-add-to-list
8516 @vindex gnus-add-to-list
8517 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8518 that have none when you do a @kbd{a}.
8519
8520 @end table
8521
8522
8523 @node Post
8524 @section Post
8525
8526 Variables for composing news articles:
8527
8528 @table @code
8529 @item gnus-sent-message-ids-file
8530 @vindex gnus-sent-message-ids-file
8531 Gnus will keep a @code{Message-ID} history file of all the mails it has
8532 sent.  If it discovers that it has already sent a mail, it will ask the
8533 user whether to re-send the mail.  (This is primarily useful when
8534 dealing with @sc{soup} packets and the like where one is apt to send the
8535 same packet multiple times.)  This variable says what the name of this
8536 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8537 this variable to @code{nil} if you don't want gnus to keep a history
8538 file.
8539
8540 @item gnus-sent-message-ids-length
8541 @vindex gnus-sent-message-ids-length
8542 This variable says how many @code{Message-ID}s to keep in the history
8543 file.  It is 1000 by default.
8544
8545 @end table
8546
8547
8548 @node Posting Server
8549 @section Posting Server
8550
8551 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8552 (extremely intelligent, of course) article, where does it go?
8553
8554 Thank you for asking.  I hate you.
8555
8556 @vindex gnus-post-method
8557
8558 It can be quite complicated.  Normally, gnus will use the same native
8559 server.  However.  If your native server doesn't allow posting, just
8560 reading, you probably want to use some other server to post your
8561 (extremely intelligent and fabulously interesting) articles.  You can
8562 then set the @code{gnus-post-method} to some other method:
8563
8564 @lisp
8565 (setq gnus-post-method '(nnspool ""))
8566 @end lisp
8567
8568 Now, if you've done this, and then this server rejects your article, or
8569 this server is down, what do you do then?  To override this variable you
8570 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8571 the ``current'' server for posting.
8572
8573 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8574 gnus will prompt you for what method to use for posting.
8575
8576 You can also set @code{gnus-post-method} to a list of select methods.
8577 If that's the case, gnus will always prompt you for what method to use
8578 for posting.
8579
8580 Finally, if you want to always post using the same select method as
8581 you're reading from (which might be convenient if you're reading lots of
8582 groups from different private servers), you can set this variable to
8583 @code{current}.
8584
8585
8586 @node Mail and Post
8587 @section Mail and Post
8588
8589 Here's a list of variables relevant to both mailing and
8590 posting:
8591
8592 @table @code
8593 @item gnus-mailing-list-groups
8594 @findex gnus-mailing-list-groups
8595 @cindex mailing lists
8596
8597 If your news server offers groups that are really mailing lists
8598 gatewayed to the @sc{nntp} server, you can read those groups without
8599 problems, but you can't post/followup to them without some difficulty.
8600 One solution is to add a @code{to-address} to the group parameters
8601 (@pxref{Group Parameters}).  An easier thing to do is set the
8602 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8603 really are mailing lists.  Then, at least, followups to the mailing
8604 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8605 still a pain, though.
8606
8607 @end table
8608
8609 You may want to do spell-checking on messages that you send out.  Or, if
8610 you don't want to spell-check by hand, you could add automatic
8611 spell-checking via the @code{ispell} package:
8612
8613 @cindex ispell
8614 @findex ispell-message
8615 @lisp
8616 (add-hook 'message-send-hook 'ispell-message)
8617 @end lisp
8618
8619
8620 @node Archived Messages
8621 @section Archived Messages
8622 @cindex archived messages
8623 @cindex sent messages
8624
8625 Gnus provides a few different methods for storing the mail and news you
8626 send.  The default method is to use the @dfn{archive virtual server} to
8627 store the messages.  If you want to disable this completely, the
8628 @code{gnus-message-archive-group} variable should be @code{nil}, which
8629 is the default.
8630
8631 @vindex gnus-message-archive-method
8632 @code{gnus-message-archive-method} says what virtual server gnus is to
8633 use to store sent messages.  The default is:
8634
8635 @lisp
8636 (nnfolder "archive"
8637           (nnfolder-directory   "~/Mail/archive")
8638           (nnfolder-active-file "~/Mail/archive/active")
8639           (nnfolder-get-new-mail nil)
8640           (nnfolder-inhibit-expiry t))
8641 @end lisp
8642
8643 You can, however, use any mail select method (@code{nnml},
8644 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8645 for doing this sort of thing, though.  If you don't like the default
8646 directory chosen, you could say something like:
8647
8648 @lisp
8649 (setq gnus-message-archive-method
8650       '(nnfolder "archive"
8651                  (nnfolder-inhibit-expiry t)
8652                  (nnfolder-active-file "~/News/sent-mail/active")
8653                  (nnfolder-directory "~/News/sent-mail/")))
8654 @end lisp
8655
8656 @vindex gnus-message-archive-group
8657 @cindex Gcc
8658 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8659 to one or more group(s) on that server.  Which group to use is
8660 determined by the @code{gnus-message-archive-group} variable.
8661
8662 This variable can be used to do the following:
8663
8664 @itemize @bullet
8665 @item a string
8666 Messages will be saved in that group.
8667 @item a list of strings
8668 Messages will be saved in all those groups.
8669 @item an alist of regexps, functions and forms
8670 When a key ``matches'', the result is used.
8671 @item @code{nil}
8672 No message archiving will take place.  This is the default.
8673 @end itemize
8674
8675 Let's illustrate:
8676
8677 Just saving to a single group called @samp{MisK}:
8678 @lisp
8679 (setq gnus-message-archive-group "MisK")
8680 @end lisp
8681
8682 Saving to two groups, @samp{MisK} and @samp{safe}:
8683 @lisp
8684 (setq gnus-message-archive-group '("MisK" "safe"))
8685 @end lisp
8686
8687 Save to different groups based on what group you are in:
8688 @lisp
8689 (setq gnus-message-archive-group
8690       '(("^alt" "sent-to-alt")
8691         ("mail" "sent-to-mail")
8692         (".*" "sent-to-misc")))
8693 @end lisp
8694
8695 More complex stuff:
8696 @lisp
8697 (setq gnus-message-archive-group
8698       '((if (message-news-p)
8699             "misc-news"
8700           "misc-mail")))
8701 @end lisp
8702
8703 How about storing all news messages in one file, but storing all mail
8704 messages in one file per month:
8705
8706 @lisp
8707 (setq gnus-message-archive-group
8708       '((if (message-news-p)
8709             "misc-news"
8710           (concat "mail." (format-time-string
8711                            "%Y-%m" (current-time))))))
8712 @end lisp
8713
8714 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8715 use a different value for @code{gnus-message-archive-group} there.)
8716
8717 Now, when you send a message off, it will be stored in the appropriate
8718 group.  (If you want to disable storing for just one particular message,
8719 you can just remove the @code{Gcc} header that has been inserted.)  The
8720 archive group will appear in the group buffer the next time you start
8721 gnus, or the next time you press @kbd{F} in the group buffer.  You can
8722 enter it and read the articles in it just like you'd read any other
8723 group.  If the group gets really big and annoying, you can simply rename
8724 if (using @kbd{G r} in the group buffer) to something
8725 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8726 continue to be stored in the old (now empty) group.
8727
8728 That's the default method of archiving sent messages.  Gnus offers a
8729 different way for the people who don't like the default method.  In that
8730 case you should set @code{gnus-message-archive-group} to @code{nil};
8731 this will disable archiving.
8732
8733 @table @code
8734 @item gnus-outgoing-message-group
8735 @vindex gnus-outgoing-message-group
8736 All outgoing messages will be put in this group.  If you want to store
8737 all your outgoing mail and articles in the group @samp{nnml:archive},
8738 you set this variable to that value.  This variable can also be a list of
8739 group names.
8740
8741 If you want to have greater control over what group to put each
8742 message in, you can set this variable to a function that checks the
8743 current newsgroup name and then returns a suitable group name (or list
8744 of names).
8745
8746 This variable can be used instead of @code{gnus-message-archive-group},
8747 but the latter is the preferred method.
8748 @end table
8749
8750
8751 @node Posting Styles
8752 @section Posting Styles
8753 @cindex posting styles
8754 @cindex styles
8755
8756 All them variables, they make my head swim.
8757
8758 So what if you want a different @code{Organization} and signature based
8759 on what groups you post to?  And you post both from your home machine
8760 and your work machine, and you want different @code{From} lines, and so
8761 on?
8762
8763 @vindex gnus-posting-styles
8764 One way to do stuff like that is to write clever hooks that change the
8765 variables you need to have changed.  That's a bit boring, so somebody
8766 came up with the bright idea of letting the user specify these things in
8767 a handy alist.  Here's an example of a @code{gnus-posting-styles}
8768 variable:
8769
8770 @lisp
8771 ((".*"
8772   (signature "Peace and happiness")
8773   (organization "What me?"))
8774  ("^comp"
8775   (signature "Death to everybody"))
8776  ("comp.emacs.i-love-it"
8777   (organization "Emacs is it")))
8778 @end lisp
8779
8780 As you might surmise from this example, this alist consists of several
8781 @dfn{styles}.  Each style will be applicable if the first element
8782 ``matches'', in some form or other.  The entire alist will be iterated
8783 over, from the beginning towards the end, and each match will be
8784 applied, which means that attributes in later styles that match override
8785 the same attributes in earlier matching styles.  So
8786 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8787 signature and the @samp{What me?} @code{Organization} header.
8788
8789 The first element in each style is called the @code{match}.  If it's a
8790 string, then Gnus will try to regexp match it against the group name.
8791 If it's a function symbol, that function will be called with no
8792 arguments.  If it's a variable symbol, then the variable will be
8793 referenced.  If it's a list, then that list will be @code{eval}ed.  In
8794 any case, if this returns a non-@code{nil} value, then the style is said
8795 to @dfn{match}.
8796
8797 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8798 attribute consists of a @var{(name . value)} pair.  The attribute name
8799 can be one of @code{signature}, @code{signature-file},
8800 @code{organization}, @code{address}, @code{name} or @code{body}.  The
8801 attribute name can also be a string.  In that case, this will be used as
8802 a header name, and the value will be inserted in the headers of the
8803 article.
8804
8805 The attribute value can be a string (used verbatim), a function (the
8806 return value will be used), a variable (its value will be used) or a
8807 list (it will be @code{eval}ed and the return value will be used).
8808
8809 If you wish to check whether the message you are about to compose is
8810 meant to be a news article or a mail message, you can check the values
8811 of the two dynamically bound variables @code{message-this-is-news} and
8812 @code{message-this-is-mail}.
8813
8814 @vindex message-this-is-mail
8815 @vindex message-this-is-news
8816
8817 So here's a new example:
8818
8819 @lisp
8820 (setq gnus-posting-styles
8821       '((".*"
8822          (signature-file "~/.signature")
8823          (name "User Name")
8824          ("X-Home-Page" (getenv "WWW_HOME"))
8825          (organization "People's Front Against MWM"))
8826         ("^rec.humor"
8827          (signature my-funny-signature-randomizer))
8828         ((equal (system-name) "gnarly")
8829          (signature my-quote-randomizer))
8830         (message-this-is-news
8831          (signature my-news-signature))
8832         (posting-from-work-p
8833          (signature-file "~/.work-signature")
8834          (address "user@@bar.foo")
8835          (body "You are fired.\n\nSincerely, your boss.")
8836          (organization "Important Work, Inc"))
8837         ("^nn.+:"
8838          (signature-file "~/.mail-signature"))))
8839 @end lisp
8840
8841
8842 @node Drafts
8843 @section Drafts
8844 @cindex drafts
8845
8846 If you are writing a message (mail or news) and suddenly remember that
8847 you have a steak in the oven (or some pesto in the food processor, you
8848 craaazy vegetarians), you'll probably wish there was a method to save
8849 the message you are writing so that you can continue editing it some
8850 other day, and send it when you feel its finished.
8851
8852 Well, don't worry about it.  Whenever you start composing a message of
8853 some sort using the gnus mail and post commands, the buffer you get will
8854 automatically associate to an article in a special @dfn{draft} group.
8855 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8856 article will be saved there.  (Auto-save files also go to the draft
8857 group.)
8858
8859 @cindex nndraft
8860 @vindex nndraft-directory
8861 The draft group is a special group (which is implemented as an
8862 @code{nndraft} group, if you absolutely have to know) called
8863 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8864 @code{nndraft} is to store its files.  What makes this group special is
8865 that you can't tick any articles in it or mark any articles as
8866 read---all articles in the group are permanently unread.
8867
8868 If the group doesn't exist, it will be created and you'll be subscribed
8869 to it.  The only way to make it disappear from the Group buffer is to
8870 unsubscribe it.
8871
8872 @c @findex gnus-dissociate-buffer-from-draft
8873 @c @kindex C-c M-d (Mail)
8874 @c @kindex C-c M-d (Post)
8875 @c @findex gnus-associate-buffer-with-draft
8876 @c @kindex C-c C-d (Mail)
8877 @c @kindex C-c C-d (Post)
8878 @c If you're writing some super-secret message that you later want to
8879 @c encode with PGP before sending, you may wish to turn the auto-saving
8880 @c (and association with the draft group) off.  You never know who might be
8881 @c interested in reading all your extremely valuable and terribly horrible
8882 @c and interesting secrets.  The @kbd{C-c M-d}
8883 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8884 @c If you change your mind and want to turn the auto-saving back on again,
8885 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8886 @c
8887 @c @vindex gnus-use-draft
8888 @c To leave association with the draft group off by default, set
8889 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
8890
8891 @findex gnus-draft-edit-message
8892 @kindex D e (Draft)
8893 When you want to continue editing the article, you simply enter the
8894 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8895 that.  You will be placed in a buffer where you left off.
8896
8897 Rejected articles will also be put in this draft group (@pxref{Rejected
8898 Articles}).
8899
8900 @findex gnus-draft-send-all-messages
8901 @findex gnus-draft-send-message
8902 If you have lots of rejected messages you want to post (or mail) without
8903 doing further editing, you can use the @kbd{D s} command
8904 (@code{gnus-draft-send-message}).  This command understands the
8905 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
8906 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8907 in the buffer.
8908
8909 If you have some messages that you wish not to send, you can use the
8910 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8911 as unsendable.  This is a toggling command.
8912
8913
8914 @node Rejected Articles
8915 @section Rejected Articles
8916 @cindex rejected articles
8917
8918 Sometimes a news server will reject an article.  Perhaps the server
8919 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
8920 @emph{there be demons}.  Perhaps you have included too much cited text.
8921 Perhaps the disk is full.  Perhaps the server is down.
8922
8923 These situations are, of course, totally beyond the control of gnus.
8924 (Gnus, of course, loves the way you look, always feels great, has angels
8925 fluttering around inside of it, doesn't care about how much cited text
8926 you include, never runs full and never goes down.)  So gnus saves these
8927 articles until some later time when the server feels better.
8928
8929 The rejected articles will automatically be put in a special draft group
8930 (@pxref{Drafts}).  When the server comes back up again, you'd then
8931 typically enter that group and send all the articles off.
8932
8933
8934 @node Select Methods
8935 @chapter Select Methods
8936 @cindex foreign groups
8937 @cindex select methods
8938
8939 A @dfn{foreign group} is a group not read by the usual (or
8940 default) means.  It could be, for instance, a group from a different
8941 @sc{nntp} server, it could be a virtual group, or it could be your own
8942 personal mail group.
8943
8944 A foreign group (or any group, really) is specified by a @dfn{name} and
8945 a @dfn{select method}.  To take the latter first, a select method is a
8946 list where the first element says what backend to use (e.g. @code{nntp},
8947 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8948 name}.  There may be additional elements in the select method, where the
8949 value may have special meaning for the backend in question.
8950
8951 One could say that a select method defines a @dfn{virtual server}---so
8952 we do just that (@pxref{The Server Buffer}).
8953
8954 The @dfn{name} of the group is the name the backend will recognize the
8955 group as.
8956
8957 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8958 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8959 method @code{(nntp "some.where.edu")}.  Gnus will call this group
8960 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8961 backend just knows this group as @samp{soc.motss}.
8962
8963 The different methods all have their peculiarities, of course.
8964
8965 @menu
8966 * The Server Buffer::     Making and editing virtual servers.
8967 * Getting News::          Reading USENET news with Gnus.
8968 * Getting Mail::          Reading your personal mail with Gnus.
8969 * Other Sources::         Reading directories, files, SOUP packets.
8970 * Combined Groups::       Combining groups into one group.
8971 * Gnus Unplugged::        Reading news and mail offline.
8972 @end menu
8973
8974
8975 @node The Server Buffer
8976 @section The Server Buffer
8977
8978 Traditionally, a @dfn{server} is a machine or a piece of software that
8979 one connects to, and then requests information from.  Gnus does not
8980 connect directly to any real servers, but does all transactions through
8981 one backend or other.  But that's just putting one layer more between
8982 the actual media and Gnus, so we might just as well say that each
8983 backend represents a virtual server.
8984
8985 For instance, the @code{nntp} backend may be used to connect to several
8986 different actual @sc{nntp} servers, or, perhaps, to many different ports
8987 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8988 use, and what parameters to set by specifying a @dfn{select method}.
8989
8990 These select method specifications can sometimes become quite
8991 complicated---say, for instance, that you want to read from the
8992 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8993 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8994 Anyways, if you had to specify that for each group that used this
8995 server, that would be too much work, so Gnus offers a way of naming
8996 select methods, which is what you do in the server buffer.
8997
8998 To enter the server buffer, use the @kbd{^}
8999 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9000
9001 @menu
9002 * Server Buffer Format::      You can customize the look of this buffer.
9003 * Server Commands::           Commands to manipulate servers.
9004 * Example Methods::           Examples server specifications.
9005 * Creating a Virtual Server:: An example session.
9006 * Server Variables::          Which variables to set.
9007 * Servers and Methods::       You can use server names as select methods.
9008 * Unavailable Servers::       Some servers you try to contact may be down.
9009 @end menu
9010
9011 @vindex gnus-server-mode-hook
9012 @code{gnus-server-mode-hook} is run when creating the server buffer.
9013
9014
9015 @node Server Buffer Format
9016 @subsection Server Buffer Format
9017 @cindex server buffer format
9018
9019 @vindex gnus-server-line-format
9020 You can change the look of the server buffer lines by changing the
9021 @code{gnus-server-line-format} variable.  This is a @code{format}-like
9022 variable, with some simple extensions:
9023
9024 @table @samp
9025
9026 @item h
9027 How the news is fetched---the backend name.
9028
9029 @item n
9030 The name of this server.
9031
9032 @item w
9033 Where the news is to be fetched from---the address.
9034
9035 @item s
9036 The opened/closed/denied status of the server.
9037 @end table
9038
9039 @vindex gnus-server-mode-line-format
9040 The mode line can also be customized by using the
9041 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9042 Formatting}).  The following specs are understood:
9043
9044 @table @samp
9045 @item S
9046 Server name.
9047
9048 @item M
9049 Server method.
9050 @end table
9051
9052 Also @pxref{Formatting Variables}.
9053
9054
9055 @node Server Commands
9056 @subsection Server Commands
9057 @cindex server commands
9058
9059 @table @kbd
9060
9061 @item a
9062 @kindex a (Server)
9063 @findex gnus-server-add-server
9064 Add a new server (@code{gnus-server-add-server}).
9065
9066 @item e
9067 @kindex e (Server)
9068 @findex gnus-server-edit-server
9069 Edit a server (@code{gnus-server-edit-server}).
9070
9071 @item SPACE
9072 @kindex SPACE (Server)
9073 @findex gnus-server-read-server
9074 Browse the current server (@code{gnus-server-read-server}).
9075
9076 @item q
9077 @kindex q (Server)
9078 @findex gnus-server-exit
9079 Return to the group buffer (@code{gnus-server-exit}).
9080
9081 @item k
9082 @kindex k (Server)
9083 @findex gnus-server-kill-server
9084 Kill the current server (@code{gnus-server-kill-server}).
9085
9086 @item y
9087 @kindex y (Server)
9088 @findex gnus-server-yank-server
9089 Yank the previously killed server (@code{gnus-server-yank-server}).
9090
9091 @item c
9092 @kindex c (Server)
9093 @findex gnus-server-copy-server
9094 Copy the current server (@code{gnus-server-copy-server}).
9095
9096 @item l
9097 @kindex l (Server)
9098 @findex gnus-server-list-servers
9099 List all servers (@code{gnus-server-list-servers}).
9100
9101 @item s
9102 @kindex s (Server)
9103 @findex gnus-server-scan-server
9104 Request that the server scan its sources for new articles
9105 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
9106 servers.
9107
9108 @item g
9109 @kindex g (Server)
9110 @findex gnus-server-regenerate-server
9111 Request that the server regenerate all its data structures
9112 (@code{gnus-server-regenerate-server}).  This can be useful if you have
9113 a mail backend that has gotten out of synch.
9114
9115 @end table
9116
9117
9118 @node Example Methods
9119 @subsection Example Methods
9120
9121 Most select methods are pretty simple and self-explanatory:
9122
9123 @lisp
9124 (nntp "news.funet.fi")
9125 @end lisp
9126
9127 Reading directly from the spool is even simpler:
9128
9129 @lisp
9130 (nnspool "")
9131 @end lisp
9132
9133 As you can see, the first element in a select method is the name of the
9134 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9135 will.
9136
9137 After these two elements, there may be an arbitrary number of
9138 @var{(variable form)} pairs.
9139
9140 To go back to the first example---imagine that you want to read from
9141 port 15 on that machine.  This is what the select method should
9142 look like then:
9143
9144 @lisp
9145 (nntp "news.funet.fi" (nntp-port-number 15))
9146 @end lisp
9147
9148 You should read the documentation to each backend to find out what
9149 variables are relevant, but here's an @code{nnmh} example:
9150
9151 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
9152 you have two structures that you wish to access: One is your private
9153 mail spool, and the other is a public one.  Here's the possible spec for
9154 your private mail:
9155
9156 @lisp
9157 (nnmh "private" (nnmh-directory "~/private/mail/"))
9158 @end lisp
9159
9160 (This server is then called @samp{private}, but you may have guessed
9161 that.)
9162
9163 Here's the method for a public spool:
9164
9165 @lisp
9166 (nnmh "public"
9167       (nnmh-directory "/usr/information/spool/")
9168       (nnmh-get-new-mail nil))
9169 @end lisp
9170
9171 If you are behind a firewall and only have access to the @sc{nntp}
9172 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9173 on the firewall machine and telnet from there to the @sc{nntp} server.
9174 Doing this can be rather fiddly, but your virtual server definition
9175 should probably look something like this:
9176
9177 @lisp
9178 (nntp "firewall"
9179       (nntp-address "the.firewall.machine")
9180       (nntp-open-connection-function nntp-open-rlogin)
9181       (nntp-end-of-line "\n")
9182       (nntp-rlogin-parameters
9183        ("telnet" "the.real.nntp.host" "nntp")))
9184 @end lisp
9185
9186 If you want to use the wonderful @code{ssh} program to provide a
9187 compressed connection over the modem line, you could create a virtual
9188 server that would look something like this:
9189
9190 @lisp
9191 (nntp "news"
9192        (nntp-address "copper.uio.no")
9193        (nntp-rlogin-program "ssh")
9194        (nntp-open-connection-function nntp-open-rlogin)
9195        (nntp-end-of-line "\n")
9196        (nntp-rlogin-parameters
9197         ("telnet" "news.uio.no" "nntp")))
9198 @end lisp
9199
9200 This means that you have to have set up @code{ssh-agent} correctly to
9201 provide automatic authorization, of course.  And to get a compressed
9202 connection, you have to have the @samp{Compression} option in the
9203 @code{ssh} @file{config} file.
9204
9205
9206 @node Creating a Virtual Server
9207 @subsection Creating a Virtual Server
9208
9209 If you're saving lots of articles in the cache by using persistent
9210 articles, you may want to create a virtual server to read the cache.
9211
9212 First you need to add a new server.  The @kbd{a} command does that.  It
9213 would probably be best to use @code{nnspool} to read the cache.  You
9214 could also use @code{nnml} or @code{nnmh}, though.
9215
9216 Type @kbd{a nnspool RET cache RET}.
9217
9218 You should now have a brand new @code{nnspool} virtual server called
9219 @samp{cache}.  You now need to edit it to have the right definitions.
9220 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
9221 will contain the following:
9222
9223 @lisp
9224 (nnspool "cache")
9225 @end lisp
9226
9227 Change that to:
9228
9229 @lisp
9230 (nnspool "cache"
9231          (nnspool-spool-directory "~/News/cache/")
9232          (nnspool-nov-directory "~/News/cache/")
9233          (nnspool-active-file "~/News/cache/active"))
9234 @end lisp
9235
9236 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
9237 @kbd{RET} over this virtual server, you should be entered into a browse
9238 buffer, and you should be able to enter any of the groups displayed.
9239
9240
9241 @node Server Variables
9242 @subsection Server Variables
9243
9244 One sticky point when defining variables (both on backends and in Emacs
9245 in general) is that some variables are typically initialized from other
9246 variables when the definition of the variables is being loaded.  If you
9247 change the "base" variable after the variables have been loaded, you
9248 won't change the "derived" variables.
9249
9250 This typically affects directory and file variables.  For instance,
9251 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9252 directory variables are initialized from that variable, so
9253 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
9254 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9255 @code{nnml-directory}---you have to explicitly set all the file
9256 variables to be what you want them to be.  For a complete list of
9257 variables for each backend, see each backend's section later in this
9258 manual, but here's an example @code{nnml} definition:
9259
9260 @lisp
9261 (nnml "public"
9262       (nnml-directory "~/my-mail/")
9263       (nnml-active-file "~/my-mail/active")
9264       (nnml-newsgroups-file "~/my-mail/newsgroups"))
9265 @end lisp
9266
9267
9268 @node Servers and Methods
9269 @subsection Servers and Methods
9270
9271 Wherever you would normally use a select method
9272 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9273 when browsing a foreign server) you can use a virtual server name
9274 instead.  This could potentially save lots of typing.  And it's nice all
9275 over.
9276
9277
9278 @node Unavailable Servers
9279 @subsection Unavailable Servers
9280
9281 If a server seems to be unreachable, Gnus will mark that server as
9282 @code{denied}.  That means that any subsequent attempt to make contact
9283 with that server will just be ignored.  ``It can't be opened,'' Gnus
9284 will tell you, without making the least effort to see whether that is
9285 actually the case or not.
9286
9287 That might seem quite naughty, but it does make sense most of the time.
9288 Let's say you have 10 groups subscribed to on server
9289 @samp{nephelococcygia.com}.  This server is located somewhere quite far
9290 away from you and the machine is quite slow, so it takes 1 minute just
9291 to find out that it refuses connection to you today.  If Gnus were to
9292 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9293 attempt to do that.  Once it has gotten a single ``connection refused'',
9294 it will regard that server as ``down''.
9295
9296 So, what happens if the machine was only feeling unwell temporarily?
9297 How do you test to see whether the machine has come up again?
9298
9299 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9300 with the following commands:
9301
9302 @table @kbd
9303
9304 @item O
9305 @kindex O (Server)
9306 @findex gnus-server-open-server
9307 Try to establish connection to the server on the current line
9308 (@code{gnus-server-open-server}).
9309
9310 @item C
9311 @kindex C (Server)
9312 @findex gnus-server-close-server
9313 Close the connection (if any) to the server
9314 (@code{gnus-server-close-server}).
9315
9316 @item D
9317 @kindex D (Server)
9318 @findex gnus-server-deny-server
9319 Mark the current server as unreachable
9320 (@code{gnus-server-deny-server}).
9321
9322 @item M-o
9323 @kindex M-o (Server)
9324 @findex gnus-server-open-all-servers
9325 Open the connections to all servers in the buffer
9326 (@code{gnus-server-open-all-servers}).
9327
9328 @item M-c
9329 @kindex M-c (Server)
9330 @findex gnus-server-close-all-servers
9331 Close the connections to all servers in the buffer
9332 (@code{gnus-server-close-all-servers}).
9333
9334 @item R
9335 @kindex R (Server)
9336 @findex gnus-server-remove-denials
9337 Remove all marks to whether Gnus was denied connection from any servers
9338 (@code{gnus-server-remove-denials}).
9339
9340 @end table
9341
9342
9343 @node Getting News
9344 @section Getting News
9345 @cindex reading news
9346 @cindex news backends
9347
9348 A newsreader is normally used for reading news.  Gnus currently provides
9349 only two methods of getting news---it can read from an @sc{nntp} server,
9350 or it can read from a local spool.
9351
9352 @menu
9353 * NNTP::               Reading news from an @sc{nntp} server.
9354 * News Spool::         Reading news from the local spool.
9355 @end menu
9356
9357
9358 @node NNTP
9359 @subsection @sc{nntp}
9360 @cindex nntp
9361
9362 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9363 You just specify @code{nntp} as method and the address of the @sc{nntp}
9364 server as the, uhm, address.
9365
9366 If the @sc{nntp} server is located at a non-standard port, setting the
9367 third element of the select method to this port number should allow you
9368 to connect to the right port.  You'll have to edit the group info for
9369 that (@pxref{Foreign Groups}).
9370
9371 The name of the foreign group can be the same as a native group.  In
9372 fact, you can subscribe to the same group from as many different servers
9373 you feel like.  There will be no name collisions.
9374
9375 The following variables can be used to create a virtual @code{nntp}
9376 server:
9377
9378 @table @code
9379
9380 @item nntp-server-opened-hook
9381 @vindex nntp-server-opened-hook
9382 @cindex @sc{mode reader}
9383 @cindex authinfo
9384 @cindex authentification
9385 @cindex nntp authentification
9386 @findex nntp-send-authinfo
9387 @findex nntp-send-mode-reader
9388 is run after a connection has been made.  It can be used to send
9389 commands to the @sc{nntp} server after it has been contacted.  By
9390 default it sends the command @code{MODE READER} to the server with the
9391 @code{nntp-send-mode-reader} function.  This function should always be
9392 present in this hook.
9393
9394 @item nntp-authinfo-function
9395 @vindex nntp-authinfo-function
9396 @findex nntp-send-authinfo
9397 @vindex nntp-authinfo-file
9398 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9399 server.  The default function is @code{nntp-send-authinfo}, which looks
9400 through your @file{~/.authinfo} (or whatever you've set the
9401 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
9402 are found, it will prompt you for a login name and a password.  The
9403 format of the @file{~/.authinfo} file is (almost) the same as the
9404 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9405 manual page, but here are the salient facts:
9406
9407 @enumerate
9408 @item
9409 The file contains one or more line, each of which define one server.
9410
9411 @item
9412 Each line may contain an arbitrary number of token/value pairs.  The
9413 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9414 @samp{default} and @samp{force}.  (The latter is not a valid
9415 @file{.netrc}/@code{ftp} token, which is the only way the
9416 @file{.authinfo} file format deviates from the @file{.netrc} file
9417 format.)
9418
9419 @end enumerate
9420
9421 Here's an example file:
9422
9423 @example
9424 machine news.uio.no login larsi password geheimnis
9425 machine nntp.ifi.uio.no login larsi force yes
9426 @end example
9427
9428 The token/value pairs may appear in any order; @samp{machine} doesn't
9429 have to be first, for instance.
9430
9431 In this example, both login name and password have been supplied for the
9432 former server, while the latter has only the login name listed, and the
9433 user will be prompted for the password.  The latter also has the
9434 @samp{force} tag, which means that the authinfo will be sent to the
9435 @var{nntp} server upon connection; the default (i.e., when there is not
9436 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9437 until the @var{nntp} server asks for it.
9438
9439 You can also add @samp{default} lines that will apply to all servers
9440 that don't have matching @samp{machine} lines.
9441
9442 @example
9443 default force yes
9444 @end example
9445
9446 This will force sending @samp{AUTHINFO} commands to all servers not
9447 previously mentioned.
9448
9449 Remember to not leave the @file{~/.authinfo} file world-readable.
9450
9451 @item nntp-server-action-alist
9452 @vindex nntp-server-action-alist
9453 This is a list of regexps to match on server types and actions to be
9454 taken when matches are made.  For instance, if you want Gnus to beep
9455 every time you connect to innd, you could say something like:
9456
9457 @lisp
9458 (setq nntp-server-action-alist
9459       '(("innd" (ding))))
9460 @end lisp
9461
9462 You probably don't want to do that, though.
9463
9464 The default value is
9465
9466 @lisp
9467 '(("nntpd 1\\.5\\.11t"
9468    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9469 @end lisp
9470
9471 This ensures that Gnus doesn't send the @code{MODE READER} command to
9472 nntpd 1.5.11t, since that command chokes that server, I've been told.
9473
9474 @item nntp-maximum-request
9475 @vindex nntp-maximum-request
9476 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9477 will collect headers by sending a series of @code{head} commands.  To
9478 speed things up, the backend sends lots of these commands without
9479 waiting for reply, and then reads all the replies.  This is controlled
9480 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
9481 your network is buggy, you should set this to 1.
9482
9483 @item nntp-connection-timeout
9484 @vindex nntp-connection-timeout
9485 If you have lots of foreign @code{nntp} groups that you connect to
9486 regularly, you're sure to have problems with @sc{nntp} servers not
9487 responding properly, or being too loaded to reply within reasonable
9488 time.  This is can lead to awkward problems, which can be helped
9489 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
9490 that says how many seconds the @code{nntp} backend should wait for a
9491 connection before giving up.  If it is @code{nil}, which is the default,
9492 no timeouts are done.
9493
9494 @c @item nntp-command-timeout
9495 @c @vindex nntp-command-timeout
9496 @c @cindex PPP connections
9497 @c @cindex dynamic IP addresses
9498 @c If you're running Gnus on a machine that has a dynamically assigned
9499 @c address, Gnus may become confused.  If the address of your machine
9500 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9501 @c waiting forever for replies from the server.  To help with this
9502 @c unfortunate problem, you can set this command to a number.  Gnus will
9503 @c then, if it sits waiting for a reply from the server longer than that
9504 @c number of seconds, shut down the connection, start a new one, and resend
9505 @c the command.  This should hopefully be transparent to the user.  A
9506 @c likely number is 30 seconds.
9507 @c
9508 @c @item nntp-retry-on-break
9509 @c @vindex nntp-retry-on-break
9510 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9511 @c hangs.  This will have much the same effect as the command timeout
9512 @c described above.
9513
9514 @item nntp-server-hook
9515 @vindex nntp-server-hook
9516 This hook is run as the last step when connecting to an @sc{nntp}
9517 server.
9518
9519 @findex nntp-open-rlogin
9520 @findex nntp-open-telnet
9521 @findex nntp-open-network-stream
9522 @item nntp-open-connection-function
9523 @vindex nntp-open-connection-function
9524 This function is used to connect to the remote system.  Four pre-made
9525 functions are supplied:
9526
9527 @table @code
9528 @item nntp-open-network-stream
9529 This is the default, and simply connects to some port or other on the
9530 remote system.
9531
9532 @item nntp-open-rlogin
9533 Does an @samp{rlogin} on the
9534 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9535 available there.
9536
9537 @code{nntp-open-rlogin}-related variables:
9538
9539 @table @code
9540
9541 @item nntp-rlogin-program
9542 @vindex nntp-rlogin-program
9543 Program used to log in on remote machines.  The default is @samp{rsh},
9544 but @samp{ssh} is a popular alternative.
9545
9546 @item nntp-rlogin-parameters
9547 @vindex nntp-rlogin-parameters
9548 This list will be used as the parameter list given to @code{rsh}.
9549
9550 @item nntp-rlogin-user-name
9551 @vindex nntp-rlogin-user-name
9552 User name on the remote system.
9553
9554 @end table
9555
9556 @item nntp-open-telnet
9557 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9558 to get to the @sc{nntp} server.
9559
9560 @code{nntp-open-telnet}-related variables:
9561
9562 @table @code
9563 @item nntp-telnet-command
9564 @vindex nntp-telnet-command
9565 Command used to start @code{telnet}.
9566
9567 @item nntp-telnet-switches
9568 @vindex nntp-telnet-switches
9569 List of strings to be used as the switches to the @code{telnet} command.
9570
9571 @item nntp-telnet-user-name
9572 @vindex nntp-telnet-user-name
9573 User name for log in on the remote system.
9574
9575 @item nntp-telnet-passwd
9576 @vindex nntp-telnet-passwd
9577 Password to use when logging in.
9578
9579 @item nntp-telnet-parameters
9580 @vindex nntp-telnet-parameters
9581 A list of strings executed as a command after logging in
9582 via @code{telnet}.
9583
9584 @item nntp-telnet-shell-prompt
9585 @vindex nntp-telnet-shell-prompt
9586 Regexp matching the shell prompt on the remote machine.  The default is
9587 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9588
9589 @item nntp-open-telnet-envuser
9590 @vindex nntp-open-telnet-envuser
9591 If non-@code{nil}, the @code{telnet} session (client and server both)
9592 will support the @code{ENVIRON} option and not prompt for login name.
9593 This works for Solaris @code{telnet}, for instance.
9594
9595 @end table
9596
9597 @findex nntp-open-ssl-stream
9598 @item nntp-open-ssl-stream
9599 Opens a connection to a server over a @dfn{secure} channel.  To use this
9600 you must have SSLay installed
9601 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9602 @file{ssl.el} (from the W3 distributeion, for instance).  You then
9603 define a server as follows:
9604
9605 @lisp
9606 ;; Type `C-c C-c' after you've finished editing.
9607 ;;
9608 ;; "snews" is port 563 and is predefined in our /etc/services
9609 ;;
9610 (nntp "snews.bar.com"
9611       (nntp-open-connection-function nntp-open-ssl-stream)
9612       (nntp-port-number "snews")
9613       (nntp-address "snews.bar.com"))
9614 @end lisp
9615
9616 @end table
9617
9618 @item nntp-end-of-line
9619 @vindex nntp-end-of-line
9620 String to use as end-of-line marker when talking to the @sc{nntp}
9621 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9622 using @code{rlogin} to talk to the server.
9623
9624 @item nntp-rlogin-user-name
9625 @vindex nntp-rlogin-user-name
9626 User name on the remote system when using the @code{rlogin} connect
9627 function.
9628
9629 @item nntp-address
9630 @vindex nntp-address
9631 The address of the remote system running the @sc{nntp} server.
9632
9633 @item nntp-port-number
9634 @vindex nntp-port-number
9635 Port number to connect to when using the @code{nntp-open-network-stream}
9636 connect function.
9637
9638 @item nntp-buggy-select
9639 @vindex nntp-buggy-select
9640 Set this to non-@code{nil} if your select routine is buggy.
9641
9642 @item nntp-nov-is-evil
9643 @vindex nntp-nov-is-evil
9644 If the @sc{nntp} server does not support @sc{nov}, you could set this
9645 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9646 can be used.
9647
9648 @item nntp-xover-commands
9649 @vindex nntp-xover-commands
9650 @cindex nov
9651 @cindex XOVER
9652 List of strings used as commands to fetch @sc{nov} lines from a
9653 server.  The default value of this variable is @code{("XOVER"
9654 "XOVERVIEW")}.
9655
9656 @item nntp-nov-gap
9657 @vindex nntp-nov-gap
9658 @code{nntp} normally sends just one big request for @sc{nov} lines to
9659 the server.  The server responds with one huge list of lines.  However,
9660 if you have read articles 2-5000 in the group, and only want to read
9661 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9662 lines that you will not need.  This variable says how
9663 big a gap between two consecutive articles is allowed to be before the
9664 @code{XOVER} request is split into several request.  Note that if your
9665 network is fast, setting this variable to a really small number means
9666 that fetching will probably be slower.  If this variable is @code{nil},
9667 @code{nntp} will never split requests.  The default is 5.
9668
9669 @item nntp-prepare-server-hook
9670 @vindex nntp-prepare-server-hook
9671 A hook run before attempting to connect to an @sc{nntp} server.
9672
9673 @item nntp-warn-about-losing-connection
9674 @vindex nntp-warn-about-losing-connection
9675 If this variable is non-@code{nil}, some noise will be made when a
9676 server closes connection.
9677
9678 @item nntp-record-commands
9679 @vindex nntp-record-commands
9680 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9681 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9682 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
9683 that doesn't seem to work.
9684
9685 @end table
9686
9687
9688 @node News Spool
9689 @subsection News Spool
9690 @cindex nnspool
9691 @cindex news spool
9692
9693 Subscribing to a foreign group from the local spool is extremely easy,
9694 and might be useful, for instance, to speed up reading groups that
9695 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9696 instance.
9697
9698 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9699 anything else) as the address.
9700
9701 If you have access to a local spool, you should probably use that as the
9702 native select method (@pxref{Finding the News}).  It is normally faster
9703 than using an @code{nntp} select method, but might not be.  It depends.
9704 You just have to try to find out what's best at your site.
9705
9706 @table @code
9707
9708 @item nnspool-inews-program
9709 @vindex nnspool-inews-program
9710 Program used to post an article.
9711
9712 @item nnspool-inews-switches
9713 @vindex nnspool-inews-switches
9714 Parameters given to the inews program when posting an article.
9715
9716 @item nnspool-spool-directory
9717 @vindex nnspool-spool-directory
9718 Where @code{nnspool} looks for the articles.  This is normally
9719 @file{/usr/spool/news/}.
9720
9721 @item nnspool-nov-directory
9722 @vindex nnspool-nov-directory
9723 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9724 @file{/usr/spool/news/over.view/}.
9725
9726 @item nnspool-lib-dir
9727 @vindex nnspool-lib-dir
9728 Where the news lib dir is (@file{/usr/lib/news/} by default).
9729
9730 @item nnspool-active-file
9731 @vindex nnspool-active-file
9732 The path to the active file.
9733
9734 @item nnspool-newsgroups-file
9735 @vindex nnspool-newsgroups-file
9736 The path to the group descriptions file.
9737
9738 @item nnspool-history-file
9739 @vindex nnspool-history-file
9740 The path to the news history file.
9741
9742 @item nnspool-active-times-file
9743 @vindex nnspool-active-times-file
9744 The path to the active date file.
9745
9746 @item nnspool-nov-is-evil
9747 @vindex nnspool-nov-is-evil
9748 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9749 that it finds.
9750
9751 @item nnspool-sift-nov-with-sed
9752 @vindex nnspool-sift-nov-with-sed
9753 @cindex sed
9754 If non-@code{nil}, which is the default, use @code{sed} to get the
9755 relevant portion from the overview file.  If nil, @code{nnspool} will
9756 load the entire file into a buffer and process it there.
9757
9758 @end table
9759
9760
9761 @node Getting Mail
9762 @section Getting Mail
9763 @cindex reading mail
9764 @cindex mail
9765
9766 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9767 course.
9768
9769 @menu
9770 * Getting Started Reading Mail:: A simple cookbook example.
9771 * Splitting Mail::               How to create mail groups.
9772 * Mail Sources::                 How to tell Gnus where to get mail from.
9773 * Mail Backend Variables::       Variables for customizing mail handling.
9774 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9775 * Incorporating Old Mail::       What about the old mail you have?
9776 * Expiring Mail::                Getting rid of unwanted mail.
9777 * Washing Mail::                 Removing gruft from the mail you get.
9778 * Duplicates::                   Dealing with duplicated mail.
9779 * Not Reading Mail::             Using mail backends for reading other files.
9780 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9781 @end menu
9782
9783
9784 @node Getting Started Reading Mail
9785 @subsection Getting Started Reading Mail
9786
9787 It's quite easy to use Gnus to read your new mail.  You just plonk the
9788 mail backend of your choice into @code{gnus-secondary-select-methods},
9789 and things will happen automatically.
9790
9791 For instance, if you want to use @code{nnml} (which is a "one file per
9792 mail" backend), you could put the following in your @file{.gnus} file:
9793
9794 @lisp
9795 (setq gnus-secondary-select-methods
9796       '((nnml "private")))
9797 @end lisp
9798
9799 Now, the next time you start Gnus, this backend will be queried for new
9800 articles, and it will move all the messages in your spool file to its
9801 directory, which is @code{~/Mail/} by default.  The new group that will
9802 be created (@samp{mail.misc}) will be subscribed, and you can read it
9803 like any other group.
9804
9805 You will probably want to split the mail into several groups, though:
9806
9807 @lisp
9808 (setq nnmail-split-methods
9809       '(("junk" "^From:.*Lars Ingebrigtsen")
9810         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9811         ("other" "")))
9812 @end lisp
9813
9814 This will result in three new @code{nnml} mail groups being created:
9815 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
9816 mail that doesn't fit into the first two groups will be placed in the
9817 last group.
9818
9819 This should be sufficient for reading mail with Gnus.  You might want to
9820 give the other sections in this part of the manual a perusal, though.
9821 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9822
9823
9824 @node Splitting Mail
9825 @subsection Splitting Mail
9826 @cindex splitting mail
9827 @cindex mail splitting
9828
9829 @vindex nnmail-split-methods
9830 The @code{nnmail-split-methods} variable says how the incoming mail is
9831 to be split into groups.
9832
9833 @lisp
9834 (setq nnmail-split-methods
9835   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9836     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9837     ("mail.other" "")))
9838 @end lisp
9839
9840 This variable is a list of lists, where the first element of each of
9841 these lists is the name of the mail group (they do not have to be called
9842 something beginning with @samp{mail}, by the way), and the second
9843 element is a regular expression used on the header of each mail to
9844 determine if it belongs in this mail group.  The first string may
9845 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9846 insert sub-expressions from the matched text.  For instance:
9847
9848 @lisp
9849 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
9850 @end lisp
9851
9852 The second element can also be a function.  In that case, it will be
9853 called narrowed to the headers with the first element of the rule as the
9854 argument.  It should return a non-@code{nil} value if it thinks that the
9855 mail belongs in that group.
9856
9857 The last of these groups should always be a general one, and the regular
9858 expression should @emph{always} be @samp{} so that it matches any mails
9859 that haven't been matched by any of the other regexps.  (These rules are
9860 processed from the beginning of the alist toward the end.  The first
9861 rule to make a match will "win", unless you have crossposting enabled.
9862 In that case, all matching rules will "win".)
9863
9864 If you like to tinker with this yourself, you can set this variable to a
9865 function of your choice.  This function will be called without any
9866 arguments in a buffer narrowed to the headers of an incoming mail
9867 message.  The function should return a list of group names that it
9868 thinks should carry this mail message.
9869
9870 Note that the mail backends are free to maul the poor, innocent,
9871 incoming headers all they want to.  They all add @code{Lines} headers;
9872 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9873 @code{From<SPACE>} line to something else.
9874
9875 @vindex nnmail-crosspost
9876 The mail backends all support cross-posting.  If several regexps match,
9877 the mail will be ``cross-posted'' to all those groups.
9878 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
9879 that no articles are crossposted to the general (@samp{}) group.
9880
9881 @vindex nnmail-crosspost-link-function
9882 @cindex crosspost
9883 @cindex links
9884 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9885 the crossposted articles.  However, not all file systems support hard
9886 links.  If that's the case for you, set
9887 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
9888 variable is @code{add-name-to-file} by default.)
9889
9890 @findex nnmail-split-header-length-limit
9891 Header lines may be arbitrarily long.  However, the longer a line is,
9892 the longer it takes to match them.  Very long lines may lead to Gnus
9893 taking forever to split the mail, so Gnus excludes lines that are longer
9894 than @code{nnmail-split-header-length-limit} (which defaults to 1024).
9895
9896 @kindex M-x nnmail-split-history
9897 @kindex nnmail-split-history
9898 If you wish to see where the previous mail split put the messages, you
9899 can use the @kbd{M-x nnmail-split-history} command.
9900
9901 Gnus gives you all the opportunity you could possibly want for shooting
9902 yourself in the foot.  Let's say you create a group that will contain
9903 all the mail you get from your boss.  And then you accidentally
9904 unsubscribe from the group.  Gnus will still put all the mail from your
9905 boss in the unsubscribed group, and so, when your boss mails you ``Have
9906 that report ready by Monday or you're fired!'', you'll never see it and,
9907 come Tuesday, you'll still believe that you're gainfully employed while
9908 you really should be out collecting empty bottles to save up for next
9909 month's rent money.
9910
9911
9912 @node Mail Sources
9913 @subsection Mail Sources
9914
9915 Mail can be gotten from many different sources---the mail spool, from a
9916 POP mail server, or from a procmail directory, for instance.
9917
9918 @menu
9919 * Mail Source Specifiers::       How to specify what a mail source is.
9920 * Mail Source Customization::    Some variables that influence things.
9921 * Fetching Mail::                Using the mail source specifiers.
9922 @end menu
9923
9924
9925 @node Mail Source Specifiers
9926 @subsubsection Mail Source Specifiers
9927 @cindex POP
9928 @cindex mail server
9929 @cindex procmail
9930 @cindex mail spool
9931 @cindex mail source
9932
9933 You tell Gnus how to fetch mail by creating a @dfn{mail source
9934 specifier}.
9935
9936 Here's an example:
9937
9938 @lisp
9939 (pop :server "pop3.mailserver.com" :user "myname")
9940 @end lisp
9941
9942 As can be observed, a mail source specifier is a list where the first
9943 element is a @dfn{mail source type}, followed by an arbitrary number of
9944 @dfn{keywords}.  Keywords that are not explicitly specified are given
9945 default values.
9946
9947 The following mail source types are available:
9948
9949 @table @code
9950 @item file
9951 Get mail from a single file; typically from the mail spool.
9952
9953 Keywords:
9954
9955 @table @code
9956 @item :path
9957 The path of the file.  Defaults to the value of the @code{MAIL}
9958 environment variable or @file{/usr/mail/spool/user-name}.
9959 @end table
9960
9961 An example file mail source:
9962
9963 @lisp
9964 (file :path "/usr/spool/mail/user-name")
9965 @end lisp
9966
9967 Or using the default path:
9968
9969 @lisp
9970 (file)
9971 @end lisp
9972
9973 @item directory
9974 Get mail from several files in a directory.  This is typically used when
9975 you have procmail split the incoming mail into several files.
9976
9977 Keywords:
9978
9979 @table @code
9980 @item :path
9981 The path of the directory where the files are.  There is no default
9982 value.
9983
9984 @item :suffix
9985 Only files ending with this suffix are used.  The default is
9986 @samp{.spool}.
9987
9988 @item :predicate
9989 Only files that have this predicate return non-@code{nil} are returned.
9990 The default is @code{identity}.  This is used as an additional
9991 filter---only files that have the right suffix @emph{and} satisfy this
9992 predicate are considered.
9993
9994 @end table
9995
9996 An example directory mail source:
9997
9998 @lisp
9999 (directory :path "/home/user-name/procmail-dir/"
10000            :suffix ".prcml")
10001 @end lisp
10002
10003 @item pop
10004 Get mail from a POP server.
10005
10006 Keywords:
10007
10008 @table @code
10009 @item :server
10010 The name of the POP server.  The default is taken from the
10011 @code{MAILHOST} environment variable.
10012
10013 @item :port
10014 The port number of the POP server.  The default is @samp{pop3}.
10015
10016 @item :user
10017 The user name to give to the POP server.  The default is the login
10018 name.
10019
10020 @item :password
10021 The password to give to the POP server.  If not specified, the user is
10022 prompted.
10023
10024 @item :program
10025 The program to use to fetch mail from the POP server.  This is should be
10026 a @code{format}-like string.  Here's an example:
10027
10028 @example
10029 fetchmail %u@@%s -P %p %t
10030 @end example
10031
10032 The valid format specifier characters are:
10033
10034 @table @samp
10035 @item t
10036 The name of the file the mail is to be moved to.  This must always be
10037 included in this string.
10038
10039 @item s
10040 The name of the server.
10041
10042 @item P
10043 The port number of the server.
10044
10045 @item u
10046 The user name to use.
10047
10048 @item p
10049 The password to use.
10050 @end table
10051
10052 The values used for these specs are taken from the values you give the
10053 corresponding keywords.
10054
10055 @item :prescript
10056 A script to be run before fetching the mail.  The syntax is the same as
10057 the @code{:program} keyword.  This can also be a function to be run.
10058
10059 @item :postscript
10060 A script to be run after fetching the mail.  The syntax is the same as
10061 the @code{:program} keyword.  This can also be a function to be run.
10062
10063 @item :function
10064 The function to use to fetch mail from the POP server.  The function is
10065 called with one parameter---the name of the file where the mail should
10066 be moved to.
10067
10068 @item :authentication
10069 This can be either the symbol @code{password} or the symbol @code{apop}
10070 and says what authentication scheme to use.  The default is
10071 @code{password}.
10072
10073 @end table
10074
10075 If the @code{:program} and @code{:function} keywords aren't specified,
10076 @code{pop3-movemail} will be used.
10077
10078 Here are some examples.  Fetch from the default POP server, using the
10079 default user name, and default fetcher:
10080
10081 @lisp
10082 (pop)
10083 @end lisp
10084
10085 Fetch from a named server with a named user and password:
10086
10087 @lisp
10088 (pop :server "my.pop.server"
10089      :user "user-name" :password "secret")
10090 @end lisp
10091
10092 Use @samp{movemail} to move the mail:
10093
10094 @lisp
10095 (pop :program "movemail"
10096      :args (format "po:%s %s %s" user mail-source-crash-box password))
10097 @end lisp
10098
10099 @item maildir
10100 Get mail from a maildir. This is a type of mailbox currently only
10101 supported by qmail, where each file in a special directory contains
10102 exactly one mail.
10103
10104 Keywords:
10105
10106 @table @code
10107 @item :path
10108 The path of the directory where the mails are stored.  The default is 
10109 @samp{~/Maildir/new}.
10110
10111 If you sometimes look at your mail through a pop3 daemon before fetching
10112 them with Gnus, you may also have to fetch your mails from the
10113 @code{cur} directory inside the maildir, like in the following example.
10114
10115 @end table
10116
10117 An example maildir mail source:
10118
10119 @lisp
10120 (maildir :path "/home/user-name/Maildir/cur")
10121 @end lisp
10122
10123 @end table
10124
10125
10126 @node Mail Source Customization
10127 @subsubsection Mail Source Customization
10128
10129 The following is a list of variables that influence how the mail is
10130 fetched.  You would normally not need to set or change any of these
10131 variables.
10132
10133 @table @code
10134 @item mail-source-movemail-program
10135 @vindex mail-source-movemail-program
10136 A command to be executed to move mail from the inbox.  The default is
10137 @samp{movemail}.
10138
10139 This can also be a function.  In that case, the function will be
10140 called with two parameters -- the name of the INBOX file, and the file
10141 to be moved to.
10142
10143 @item mail-source-movemail-args
10144 @vindex mail-source-movemail-args
10145 Extra arguments to give to the command described above.
10146
10147 @item mail-source-crash-box
10148 @vindex mail-source-crash-box
10149 File where mail will be stored while processing it.  The default is
10150 @file{~/.emacs-mail-crash-box}.
10151
10152 @item mail-source-delete-incoming
10153 @vindex mail-source-delete-incoming
10154 If non-@code{nil}, delete incoming files after handling them.
10155
10156 @item mail-source-directory
10157 @vindex mail-source-directory
10158 Directory where files (if any) will be stored.  The default is
10159 @file{~/Mail/}.  At present, the only thing this is used for is to say
10160 where the incoming files will be stored if the previous variable is
10161 @code{nil}.
10162
10163 @item mail-source-default-file-modes
10164 @vindex mail-source-default-file-modes
10165 All new mail files will get this file mode.  The default is 384.
10166
10167 @end table
10168
10169
10170 @node Fetching Mail
10171 @subsubsection Fetching Mail
10172
10173 The way to actually tell Gnus where to get new mail from is to set
10174 @code{nnmail-spool-file} to a list of mail source specifiers
10175 (@pxref{Mail Source Specifiers}).
10176
10177 If this variable is @code{nil}, the mail backends will never attempt to
10178 fetch mail by themselves.
10179
10180 If you want to fetch mail both from your local spool as well as a POP
10181 mail server, you'd say something like:
10182
10183 @lisp
10184 (setq nnmail-spool-file
10185       '((file)
10186         (pop :server "pop3.mail.server"
10187              :password "secret")))
10188 @end lisp
10189
10190 Or, if you don't want to use any of the keyword defaults:
10191
10192 @lisp
10193 (setq nnmail-spool-file
10194       '((file :path "/var/spool/mail/user-name")
10195         (pop :server "pop3.mail.server"
10196              :user "user-name"
10197              :port "pop3"
10198              :password "secret")))
10199 @end lisp
10200
10201
10202 When you use a mail backend, Gnus will slurp all your mail from your
10203 inbox and plonk it down in your home directory.  Gnus doesn't move any
10204 mail if you're not using a mail backend---you have to do a lot of magic
10205 invocations first.  At the time when you have finished drawing the
10206 pentagram, lightened the candles, and sacrificed the goat, you really
10207 shouldn't be too surprised when Gnus moves your mail.
10208
10209
10210
10211 @node Mail Backend Variables
10212 @subsection Mail Backend Variables
10213
10214 These variables are (for the most part) pertinent to all the various
10215 mail backends.
10216
10217 @table @code
10218 @vindex nnmail-read-incoming-hook
10219 @item nnmail-read-incoming-hook
10220 The mail backends all call this hook after reading new mail.  You can
10221 use this hook to notify any mail watch programs, if you want to.
10222
10223 @vindex nnmail-split-hook
10224 @item nnmail-split-hook
10225 @findex article-decode-encoded-words
10226 @findex RFC1522 decoding
10227 @findex RFC2047 decoding
10228 Hook run in the buffer where the mail headers of each message is kept
10229 just before the splitting based on these headers is done.  The hook is
10230 free to modify the buffer contents in any way it sees fit---the buffer
10231 is discarded after the splitting has been done, and no changes performed
10232 in the buffer will show up in any files.
10233 @code{gnus-article-decode-encoded-words} is one likely function to add
10234 to this hook.
10235
10236 @vindex nnmail-pre-get-new-mail-hook
10237 @vindex nnmail-post-get-new-mail-hook
10238 @item nnmail-pre-get-new-mail-hook
10239 @itemx nnmail-post-get-new-mail-hook
10240 These are two useful hooks executed when treating new incoming
10241 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10242 starting to handle the new mail) and
10243 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10244 is done).  Here's and example of using these two hooks to change the
10245 default file modes the new mail files get:
10246
10247 @lisp
10248 (add-hook 'gnus-pre-get-new-mail-hook
10249           (lambda () (set-default-file-modes 511)))
10250
10251 (add-hook 'gnus-post-get-new-mail-hook
10252           (lambda () (set-default-file-modes 551)))
10253 @end lisp
10254
10255 @item nnmail-use-long-file-names
10256 @vindex nnmail-use-long-file-names
10257 If non-@code{nil}, the mail backends will use long file and directory
10258 names.  Groups like @samp{mail.misc} will end up in directories
10259 (assuming use of @code{nnml} backend) or files (assuming use of
10260 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
10261 the same group will end up in @file{mail/misc}.
10262
10263 @item nnmail-delete-file-function
10264 @vindex nnmail-delete-file-function
10265 @findex delete-file
10266 Function called to delete files.  It is @code{delete-file} by default.
10267
10268 @item nnmail-cache-accepted-message-ids
10269 @vindex nnmail-cache-accepted-message-ids
10270 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10271 the backend (via @code{Gcc}, for instance) into the mail duplication
10272 discovery cache.  The default is @code{nil}.
10273
10274 @end table
10275
10276
10277 @node Fancy Mail Splitting
10278 @subsection Fancy Mail Splitting
10279 @cindex mail splitting
10280 @cindex fancy mail splitting
10281
10282 @vindex nnmail-split-fancy
10283 @findex nnmail-split-fancy
10284 If the rather simple, standard method for specifying how to split mail
10285 doesn't allow you to do what you want, you can set
10286 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
10287 play with the @code{nnmail-split-fancy} variable.
10288
10289 Let's look at an example value of this variable first:
10290
10291 @lisp
10292 ;; Messages from the mailer daemon are not crossposted to any of
10293 ;; the ordinary groups.  Warnings are put in a separate group
10294 ;; from real errors.
10295 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10296                    "mail.misc"))
10297    ;; Non-error messages are crossposted to all relevant
10298    ;; groups, but we don't crosspost between the group for the
10299    ;; (ding) list and the group for other (ding) related mail.
10300    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10301          ("subject" "ding" "ding.misc"))
10302       ;; Other mailing lists...
10303       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10304       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10305       ;; People...
10306       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10307    ;; Unmatched mail goes to the catch all group.
10308    "misc.misc")
10309 @end lisp
10310
10311 This variable has the format of a @dfn{split}.  A split is a (possibly)
10312 recursive structure where each split may contain other splits.  Here are
10313 the five possible split syntaxes:
10314
10315 @enumerate
10316
10317 @item
10318 @samp{group}: If the split is a string, that will be taken as a group
10319 name.  Normal regexp match expansion will be done.  See below for
10320 examples.
10321
10322 @item
10323 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
10324 which is a string, then store the message as specified by SPLIT, if
10325 header FIELD (a regexp) contains VALUE (also a regexp).
10326
10327 @item
10328 @var{(| SPLIT...)}: If the split is a list, and the first element is
10329 @code{|} (vertical bar), then process each SPLIT until one of them
10330 matches.  A SPLIT is said to match if it will cause the mail message to
10331 be stored in one or more groups.
10332
10333 @item
10334 @var{(& SPLIT...)}: If the split is a list, and the first element is
10335 @code{&}, then process all SPLITs in the list.
10336
10337 @item
10338 @code{junk}: If the split is the symbol @code{junk}, then don't save
10339 this message. Use with extreme caution.
10340
10341 @item
10342 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
10343 element is @code{:}, then the second element will be called as a
10344 function with @var{args} given as arguments.  The function should return
10345 a SPLIT.
10346
10347 @item
10348 @code{nil}: If the split is @code{nil}, it is ignored.
10349
10350 @end enumerate
10351
10352 In these splits, @var{FIELD} must match a complete field name.
10353 @var{VALUE} must match a complete word according to the fundamental mode
10354 syntax table.  You can use @code{.*} in the regexps to match partial
10355 field names or words.  In other words, all @var{VALUE}'s are wrapped in
10356 @samp{\<} and @samp{\>} pairs.
10357
10358 @vindex nnmail-split-abbrev-alist
10359 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10360 are expanded as specified by the variable
10361 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
10362 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10363 value.
10364
10365 @vindex nnmail-split-fancy-syntax-table
10366 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10367 when all this splitting is performed.
10368
10369 If you want to have Gnus create groups dynamically based on some
10370 information in the headers (i.e., do @code{replace-match}-like
10371 substitutions in the group names), you can say things like:
10372
10373 @example
10374 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10375 @end example
10376
10377 If the string contains the element @samp{\&}, then the previously
10378 matched string will be substituted.  Similarly, the elements @samp{\\1}
10379 up to @samp{\\9} will be substituted with the text matched by the
10380 groupings 1 through 9.
10381
10382
10383 @node Incorporating Old Mail
10384 @subsection Incorporating Old Mail
10385
10386 Most people have lots of old mail stored in various file formats.  If
10387 you have set up Gnus to read mail using one of the spiffy Gnus mail
10388 backends, you'll probably wish to have that old mail incorporated into
10389 your mail groups.
10390
10391 Doing so can be quite easy.
10392
10393 To take an example: You're reading mail using @code{nnml}
10394 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10395 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
10396 file filled with important, but old, mail.  You want to move it into
10397 your @code{nnml} groups.
10398
10399 Here's how:
10400
10401 @enumerate
10402 @item
10403 Go to the group buffer.
10404
10405 @item
10406 Type `G f' and give the path to the mbox file when prompted to create an
10407 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10408
10409 @item
10410 Type `SPACE' to enter the newly created group.
10411
10412 @item
10413 Type `M P b' to process-mark all articles in this group's buffer
10414 (@pxref{Setting Process Marks}).
10415
10416 @item
10417 Type `B r' to respool all the process-marked articles, and answer
10418 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10419 @end enumerate
10420
10421 All the mail messages in the mbox file will now also be spread out over
10422 all your @code{nnml} groups.  Try entering them and check whether things
10423 have gone without a glitch.  If things look ok, you may consider
10424 deleting the mbox file, but I wouldn't do that unless I was absolutely
10425 sure that all the mail has ended up where it should be.
10426
10427 Respooling is also a handy thing to do if you're switching from one mail
10428 backend to another.  Just respool all the mail in the old mail groups
10429 using the new mail backend.
10430
10431
10432 @node Expiring Mail
10433 @subsection Expiring Mail
10434 @cindex article expiry
10435
10436 Traditional mail readers have a tendency to remove mail articles when
10437 you mark them as read, in some way.  Gnus takes a fundamentally
10438 different approach to mail reading.
10439
10440 Gnus basically considers mail just to be news that has been received in
10441 a rather peculiar manner.  It does not think that it has the power to
10442 actually change the mail, or delete any mail messages.  If you enter a
10443 mail group, and mark articles as ``read'', or kill them in some other
10444 fashion, the mail articles will still exist on the system.  I repeat:
10445 Gnus will not delete your old, read mail.  Unless you ask it to, of
10446 course.
10447
10448 To make Gnus get rid of your unwanted mail, you have to mark the
10449 articles as @dfn{expirable}.  This does not mean that the articles will
10450 disappear right away, however.  In general, a mail article will be
10451 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10452 more than one week old.  If you do not mark an article as expirable, it
10453 will remain on your system until hell freezes over.  This bears
10454 repeating one more time, with some spurious capitalizations: IF you do
10455 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10456
10457 @vindex gnus-auto-expirable-newsgroups
10458 You do not have to mark articles as expirable by hand.  Groups that
10459 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10460 have all articles that you read marked as expirable automatically.  All
10461 articles marked as expirable have an @samp{E} in the first
10462 column in the summary buffer.
10463
10464 By default, if you have auto expiry switched on, Gnus will mark all the
10465 articles you read as expirable, no matter if they were read or unread
10466 before.  To avoid having articles marked as read marked as expirable
10467 automatically, you can put something like the following in your
10468 @file{.gnus} file:
10469
10470 @vindex gnus-mark-article-hook
10471 @lisp
10472 (remove-hook 'gnus-mark-article-hook
10473              'gnus-summary-mark-read-and-unread-as-read)
10474 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10475 @end lisp
10476
10477 Note that making a group auto-expirable doesn't mean that all read
10478 articles are expired---only the articles marked as expirable
10479 will be expired.  Also note that using the @kbd{d} command won't make
10480 groups expirable---only semi-automatic marking of articles as read will
10481 mark the articles as expirable in auto-expirable groups.
10482
10483 Let's say you subscribe to a couple of mailing lists, and you want the
10484 articles you have read to disappear after a while:
10485
10486 @lisp
10487 (setq gnus-auto-expirable-newsgroups
10488       "mail.nonsense-list\\|mail.nice-list")
10489 @end lisp
10490
10491 Another way to have auto-expiry happen is to have the element
10492 @code{auto-expire} in the group parameters of the group.
10493
10494 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10495 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
10496 don't really mix very well.
10497
10498 @vindex nnmail-expiry-wait
10499 The @code{nnmail-expiry-wait} variable supplies the default time an
10500 expirable article has to live.  Gnus starts counting days from when the
10501 message @emph{arrived}, not from when it was sent.  The default is seven
10502 days.
10503
10504 Gnus also supplies a function that lets you fine-tune how long articles
10505 are to live, based on what group they are in.  Let's say you want to
10506 have one month expiry period in the @samp{mail.private} group, a one day
10507 expiry period in the @samp{mail.junk} group, and a six day expiry period
10508 everywhere else:
10509
10510 @vindex nnmail-expiry-wait-function
10511 @lisp
10512 (setq nnmail-expiry-wait-function
10513       (lambda (group)
10514        (cond ((string= group "mail.private")
10515                31)
10516              ((string= group "mail.junk")
10517                1)
10518              ((string= group "important")
10519                'never)
10520              (t
10521                6))))
10522 @end lisp
10523
10524 The group names this function is fed are ``unadorned'' group
10525 names---no @samp{nnml:} prefixes and the like.
10526
10527 The @code{nnmail-expiry-wait} variable and
10528 @code{nnmail-expiry-wait-function} function can either be a number (not
10529 necessarily an integer) or one of the symbols @code{immediate} or
10530 @code{never}.
10531
10532 You can also use the @code{expiry-wait} group parameter to selectively
10533 change the expiry period (@pxref{Group Parameters}).
10534
10535 @vindex nnmail-keep-last-article
10536 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10537 expire the final article in a mail newsgroup.  This is to make life
10538 easier for procmail users.
10539
10540 @vindex gnus-total-expirable-newsgroups
10541 By the way: That line up there, about Gnus never expiring non-expirable
10542 articles, is a lie.  If you put @code{total-expire} in the group
10543 parameters, articles will not be marked as expirable, but all read
10544 articles will be put through the expiry process.  Use with extreme
10545 caution.  Even more dangerous is the
10546 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
10547 this regexp will have all read articles put through the expiry process,
10548 which means that @emph{all} old mail articles in the groups in question
10549 will be deleted after a while.  Use with extreme caution, and don't come
10550 crying to me when you discover that the regexp you used matched the
10551 wrong group and all your important mail has disappeared.  Be a
10552 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
10553 with!  So there!
10554
10555 Most people make most of their mail groups total-expirable, though.
10556
10557 @vindex gnus-inhibit-user-auto-expire
10558 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10559 commands will not mark an article as expirable, even if the group has
10560 auto-expire turned on.
10561
10562
10563 @node Washing Mail
10564 @subsection Washing Mail
10565 @cindex mail washing
10566 @cindex list server brain damage
10567 @cindex incoming mail treatment
10568
10569 Mailers and list servers are notorious for doing all sorts of really,
10570 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
10571 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10572 end of all lines passing through our server, so let's do that!!!!1!''
10573 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
10574 considered to be self-evident were not discussed.  So.  Here we are.
10575
10576 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
10577 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
10578 be shocked and dismayed by this, but I haven't got the energy.  It is to
10579 laugh.
10580
10581 Gnus provides a plethora of functions for washing articles while
10582 displaying them, but it might be nicer to do the filtering before
10583 storing the mail to disc.  For that purpose, we have three hooks and
10584 various functions that can be put in these hooks.
10585
10586 @table @code
10587 @item nnmail-prepare-incoming-hook
10588 @vindex nnmail-prepare-incoming-hook
10589 This hook is called before doing anything with the mail and is meant for
10590 grand, sweeping gestures.  It is called in a buffer that contains all
10591 the new, incoming mail.  Functions to be used include:
10592
10593 @table @code
10594 @item nnheader-ms-strip-cr
10595 @findex nnheader-ms-strip-cr
10596 Remove trailing carriage returns from each line.  This is default on
10597 Emacs running on MS machines.
10598
10599 @end table
10600
10601 @item nnmail-prepare-incoming-header-hook
10602 @vindex nnmail-prepare-incoming-header-hook
10603 This hook is called narrowed to each header.  It can be used when
10604 cleaning up the headers.  Functions that can be used include:
10605
10606 @table @code
10607 @item nnmail-remove-leading-whitespace
10608 @findex nnmail-remove-leading-whitespace
10609 Clear leading white space that ``helpful'' listservs have added to the
10610 headers to make them look nice.  Aaah.
10611
10612 @item nnmail-remove-list-identifiers
10613 @findex nnmail-remove-list-identifiers
10614 Some list servers add an identifier---for example, @samp{(idm)}---to the
10615 beginning of all @code{Subject} headers.  I'm sure that's nice for
10616 people who use stone age mail readers.  This function will remove
10617 strings that match the @code{nnmail-list-identifiers} regexp, which can
10618 also be a list of regexp.
10619
10620 For instance, if you want to remove the @samp{(idm)} and the
10621 @samp{nagnagnag} identifiers:
10622
10623 @lisp
10624 (setq nnmail-list-identifiers
10625       '("(idm)" "nagnagnag"))
10626 @end lisp
10627
10628 @item nnmail-remove-tabs
10629 @findex nnmail-remove-tabs
10630 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10631
10632 @item nnmail-fix-eudora-headers
10633 @findex nnmail-fix-eudora-headers
10634 @cindex Eudora
10635 Eudora produces broken @code{References} headers, but OK
10636 @code{In-Reply-To} headers.  This function will get rid of the
10637 @code{References} headers.
10638
10639 @end table
10640
10641 @item nnmail-prepare-incoming-message-hook
10642 @vindex nnmail-prepare-incoming-message-hook
10643 This hook is called narrowed to each message.  Functions to be used
10644 include:
10645
10646 @table @code
10647 @item article-de-quoted-unreadable
10648 @findex article-de-quoted-unreadable
10649 Decode Quoted Readable encoding.
10650
10651 @end table
10652 @end table
10653
10654
10655 @node Duplicates
10656 @subsection Duplicates
10657
10658 @vindex nnmail-treat-duplicates
10659 @vindex nnmail-message-id-cache-length
10660 @vindex nnmail-message-id-cache-file
10661 @cindex duplicate mails
10662 If you are a member of a couple of mailing lists, you will sometimes
10663 receive two copies of the same mail.  This can be quite annoying, so
10664 @code{nnmail} checks for and treats any duplicates it might find.  To do
10665 this, it keeps a cache of old @code{Message-ID}s---
10666 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10667 default.  The approximate maximum number of @code{Message-ID}s stored
10668 there is controlled by the @code{nnmail-message-id-cache-length}
10669 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10670 stored.) If all this sounds scary to you, you can set
10671 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10672 default), and @code{nnmail} won't delete duplicate mails.  Instead it
10673 will insert a warning into the head of the mail saying that it thinks
10674 that this is a duplicate of a different message.
10675
10676 This variable can also be a function.  If that's the case, the function
10677 will be called from a buffer narrowed to the message in question with
10678 the @code{Message-ID} as a parameter.  The function must return either
10679 @code{nil}, @code{warn}, or @code{delete}.
10680
10681 You can turn this feature off completely by setting the variable to
10682 @code{nil}.
10683
10684 If you want all the duplicate mails to be put into a special
10685 @dfn{duplicates} group, you could do that using the normal mail split
10686 methods:
10687
10688 @lisp
10689 (setq nnmail-split-fancy
10690       '(| ;; Messages duplicates go to a separate group.
10691           ("gnus-warning" "duplication of message" "duplicate")
10692           ;; Message from daemons, postmaster, and the like to another.
10693           (any mail "mail.misc")
10694           ;; Other rules.
10695           [ ... ] ))
10696 @end lisp
10697
10698 Or something like:
10699 @lisp
10700 (setq nnmail-split-methods
10701       '(("duplicates" "^Gnus-Warning:")
10702         ;; Other rules.
10703         [...]))
10704 @end lisp
10705
10706 Here's a neat feature: If you know that the recipient reads her mail
10707 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10708 @code{delete}, you can send her as many insults as you like, just by
10709 using a @code{Message-ID} of a mail that you know that she's already
10710 received.  Think of all the fun!  She'll never see any of it!  Whee!
10711
10712
10713 @node Not Reading Mail
10714 @subsection Not Reading Mail
10715
10716 If you start using any of the mail backends, they have the annoying
10717 habit of assuming that you want to read mail with them.  This might not
10718 be unreasonable, but it might not be what you want.
10719
10720 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
10721 will ever attempt to read incoming mail, which should help.
10722
10723 @vindex nnbabyl-get-new-mail
10724 @vindex nnmbox-get-new-mail
10725 @vindex nnml-get-new-mail
10726 @vindex nnmh-get-new-mail
10727 @vindex nnfolder-get-new-mail
10728 This might be too much, if, for instance, you are reading mail quite
10729 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10730 file you have stashed away with @code{nnbabyl}.  All backends have
10731 variables called backend-@code{get-new-mail}.  If you want to disable
10732 the @code{nnbabyl} mail reading, you edit the virtual server for the
10733 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10734
10735 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10736 narrowed to the article to be saved before saving it when reading
10737 incoming mail.
10738
10739
10740 @node Choosing a Mail Backend
10741 @subsection Choosing a Mail Backend
10742
10743 Gnus will read the mail spool when you activate a mail group.  The mail
10744 file is first copied to your home directory.  What happens after that
10745 depends on what format you want to store your mail in.
10746
10747 @menu
10748 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10749 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10750 * Mail Spool::                  Store your mail in a private spool?
10751 * MH Spool::                    An mhspool-like backend.
10752 * Mail Folders::                Having one file for each group.
10753 @end menu
10754
10755
10756 @node Unix Mail Box
10757 @subsubsection Unix Mail Box
10758 @cindex nnmbox
10759 @cindex unix mail box
10760
10761 @vindex nnmbox-active-file
10762 @vindex nnmbox-mbox-file
10763 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10764 mail.  @code{nnmbox} will add extra headers to each mail article to say
10765 which group it belongs in.
10766
10767 Virtual server settings:
10768
10769 @table @code
10770 @item nnmbox-mbox-file
10771 @vindex nnmbox-mbox-file
10772 The name of the mail box in the user's home directory.
10773
10774 @item nnmbox-active-file
10775 @vindex nnmbox-active-file
10776 The name of the active file for the mail box.
10777
10778 @item nnmbox-get-new-mail
10779 @vindex nnmbox-get-new-mail
10780 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10781 into groups.
10782 @end table
10783
10784
10785 @node Rmail Babyl
10786 @subsubsection Rmail Babyl
10787 @cindex nnbabyl
10788 @cindex rmail mbox
10789
10790 @vindex nnbabyl-active-file
10791 @vindex nnbabyl-mbox-file
10792 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10793 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10794 article to say which group it belongs in.
10795
10796 Virtual server settings:
10797
10798 @table @code
10799 @item nnbabyl-mbox-file
10800 @vindex nnbabyl-mbox-file
10801 The name of the rmail mbox file.
10802
10803 @item nnbabyl-active-file
10804 @vindex nnbabyl-active-file
10805 The name of the active file for the rmail box.
10806
10807 @item nnbabyl-get-new-mail
10808 @vindex nnbabyl-get-new-mail
10809 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
10810 @end table
10811
10812
10813 @node Mail Spool
10814 @subsubsection Mail Spool
10815 @cindex nnml
10816 @cindex mail @sc{nov} spool
10817
10818 The @dfn{nnml} spool mail format isn't compatible with any other known
10819 format.  It should be used with some caution.
10820
10821 @vindex nnml-directory
10822 If you use this backend, Gnus will split all incoming mail into files,
10823 one file for each mail, and put the articles into the corresponding
10824 directories under the directory specified by the @code{nnml-directory}
10825 variable.  The default value is @file{~/Mail/}.
10826
10827 You do not have to create any directories beforehand; Gnus will take
10828 care of all that.
10829
10830 If you have a strict limit as to how many files you are allowed to store
10831 in your account, you should not use this backend.  As each mail gets its
10832 own file, you might very well occupy thousands of inodes within a few
10833 weeks.  If this is no problem for you, and it isn't a problem for you
10834 having your friendly systems administrator walking around, madly,
10835 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10836 know that this is probably the fastest format to use.  You do not have
10837 to trudge through a big mbox file just to read your new mail.
10838
10839 @code{nnml} is probably the slowest backend when it comes to article
10840 splitting.  It has to create lots of files, and it also generates
10841 @sc{nov} databases for the incoming mails.  This makes it the fastest
10842 backend when it comes to reading mail.
10843
10844 Virtual server settings:
10845
10846 @table @code
10847 @item nnml-directory
10848 @vindex nnml-directory
10849 All @code{nnml} directories will be placed under this directory.
10850
10851 @item nnml-active-file
10852 @vindex nnml-active-file
10853 The active file for the @code{nnml} server.
10854
10855 @item nnml-newsgroups-file
10856 @vindex nnml-newsgroups-file
10857 The @code{nnml} group descriptions file.  @xref{Newsgroups File
10858 Format}.
10859
10860 @item nnml-get-new-mail
10861 @vindex nnml-get-new-mail
10862 If non-@code{nil}, @code{nnml} will read incoming mail.
10863
10864 @item nnml-nov-is-evil
10865 @vindex nnml-nov-is-evil
10866 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10867
10868 @item nnml-nov-file-name
10869 @vindex nnml-nov-file-name
10870 The name of the @sc{nov} files.  The default is @file{.overview}.
10871
10872 @item nnml-prepare-save-mail-hook
10873 @vindex nnml-prepare-save-mail-hook
10874 Hook run narrowed to an article before saving.
10875
10876 @end table
10877
10878 @findex nnml-generate-nov-databases
10879 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10880 you can do a complete update by typing @kbd{M-x
10881 nnml-generate-nov-databases}.  This command will trawl through the
10882 entire @code{nnml} hierarchy, looking at each and every article, so it
10883 might take a while to complete.  A better interface to this
10884 functionality can be found in the server buffer (@pxref{Server
10885 Commands}).
10886
10887
10888 @node MH Spool
10889 @subsubsection MH Spool
10890 @cindex nnmh
10891 @cindex mh-e mail spool
10892
10893 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10894 @sc{nov} databases and it doesn't keep an active file.  This makes
10895 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10896 makes it easier to write procmail scripts for.
10897
10898 Virtual server settings:
10899
10900 @table @code
10901 @item nnmh-directory
10902 @vindex nnmh-directory
10903 All @code{nnmh} directories will be located under this directory.
10904
10905 @item nnmh-get-new-mail
10906 @vindex nnmh-get-new-mail
10907 If non-@code{nil}, @code{nnmh} will read incoming mail.
10908
10909 @item nnmh-be-safe
10910 @vindex nnmh-be-safe
10911 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10912 sure that the articles in the folder are actually what Gnus thinks they
10913 are.  It will check date stamps and stat everything in sight, so
10914 setting this to @code{t} will mean a serious slow-down.  If you never
10915 use anything but Gnus to read the @code{nnmh} articles, you do not have
10916 to set this variable to @code{t}.
10917 @end table
10918
10919
10920 @node Mail Folders
10921 @subsubsection Mail Folders
10922 @cindex nnfolder
10923 @cindex mbox folders
10924 @cindex mail folders
10925
10926 @code{nnfolder} is a backend for storing each mail group in a separate
10927 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
10928 will add extra headers to keep track of article numbers and arrival
10929 dates.
10930
10931 Virtual server settings:
10932
10933 @table @code
10934 @item nnfolder-directory
10935 @vindex nnfolder-directory
10936 All the @code{nnfolder} mail boxes will be stored under this directory.
10937
10938 @item nnfolder-active-file
10939 @vindex nnfolder-active-file
10940 The name of the active file.
10941
10942 @item nnfolder-newsgroups-file
10943 @vindex nnfolder-newsgroups-file
10944 The name of the group descriptions file.  @xref{Newsgroups File Format}.
10945
10946 @item nnfolder-get-new-mail
10947 @vindex nnfolder-get-new-mail
10948 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10949
10950 @item nnfolder-save-buffer-hook
10951 @vindex nnfolder-save-buffer-hook
10952 @cindex backup files
10953 Hook run before saving the folders.  Note that Emacs does the normal
10954 backup renaming of files even with the @code{nnfolder} buffers.  If you
10955 wish to switch this off, you could say something like the following in
10956 your @file{.emacs} file:
10957
10958 @lisp
10959 (defun turn-off-backup ()
10960   (set (make-local-variable 'backup-inhibited) t))
10961
10962 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
10963 @end lisp
10964
10965 @item nnfolder-delete-mail-hook
10966 @vindex nnfolder-delete-mail-hook
10967 Hook run in a buffer narrowed to the message that is to be deleted.
10968 This function can be used to copy the message to somewhere else, or to
10969 extract some information from it before removing it.
10970
10971 @end table
10972
10973
10974 @findex nnfolder-generate-active-file
10975 @kindex M-x nnfolder-generate-active-file
10976 If you have lots of @code{nnfolder}-like files you'd like to read with
10977 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10978 command to make @code{nnfolder} aware of all likely files in
10979 @code{nnfolder-directory}.  This only works if you use long file names,
10980 though.
10981
10982
10983 @node Other Sources
10984 @section Other Sources
10985
10986 Gnus can do more than just read news or mail.  The methods described
10987 below allow Gnus to view directories and files as if they were
10988 newsgroups.
10989
10990 @menu
10991 * Directory Groups::      You can read a directory as if it was a newsgroup.
10992 * Anything Groups::       Dired?  Who needs dired?
10993 * Document Groups::       Single files can be the basis of a group.
10994 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
10995 * Web Searches::          Creating groups from articles that match a string.
10996 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10997 @end menu
10998
10999
11000 @node Directory Groups
11001 @subsection Directory Groups
11002 @cindex nndir
11003 @cindex directory groups
11004
11005 If you have a directory that has lots of articles in separate files in
11006 it, you might treat it as a newsgroup.  The files have to have numerical
11007 names, of course.
11008
11009 This might be an opportune moment to mention @code{ange-ftp} (and its
11010 successor @code{efs}), that most wonderful of all wonderful Emacs
11011 packages.  When I wrote @code{nndir}, I didn't think much about it---a
11012 backend to read directories.  Big deal.
11013
11014 @code{ange-ftp} changes that picture dramatically.  For instance, if you
11015 enter the @code{ange-ftp} file name
11016 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11017 @code{ange-ftp} or @code{efs} will actually allow you to read this
11018 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
11019
11020 @code{nndir} will use @sc{nov} files if they are present.
11021
11022 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11023 articles with this method.  You can use @code{nnmh} or @code{nnml} for
11024 whatever you use @code{nndir} for, so you could switch to any of those
11025 methods if you feel the need to have a non-read-only @code{nndir}.
11026
11027
11028 @node Anything Groups
11029 @subsection Anything Groups
11030 @cindex nneething
11031
11032 From the @code{nndir} backend (which reads a single spool-like
11033 directory), it's just a hop and a skip to @code{nneething}, which
11034 pretends that any arbitrary directory is a newsgroup.  Strange, but
11035 true.
11036
11037 When @code{nneething} is presented with a directory, it will scan this
11038 directory and assign article numbers to each file.  When you enter such
11039 a group, @code{nneething} must create ``headers'' that Gnus can use.
11040 After all, Gnus is a newsreader, in case you're
11041 forgetting. @code{nneething} does this in a two-step process.  First, it
11042 snoops each file in question.  If the file looks like an article (i.e.,
11043 the first few lines look like headers), it will use this as the head.
11044 If this is just some arbitrary file without a head (e.g. a C source
11045 file), @code{nneething} will cobble up a header out of thin air.  It
11046 will use file ownership, name and date and do whatever it can with these
11047 elements.
11048
11049 All this should happen automatically for you, and you will be presented
11050 with something that looks very much like a newsgroup.  Totally like a
11051 newsgroup, to be precise.  If you select an article, it will be displayed
11052 in the article buffer, just as usual.
11053
11054 If you select a line that represents a directory, Gnus will pop you into
11055 a new summary buffer for this @code{nneething} group.  And so on.  You can
11056 traverse the entire disk this way, if you feel like, but remember that
11057 Gnus is not dired, really, and does not intend to be, either.
11058
11059 There are two overall modes to this action---ephemeral or solid.  When
11060 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11061 will not store information on what files you have read, and what files
11062 are new, and so on.  If you create a solid @code{nneething} group the
11063 normal way with @kbd{G m}, Gnus will store a mapping table between
11064 article numbers and file names, and you can treat this group like any
11065 other groups.  When you activate a solid @code{nneething} group, you will
11066 be told how many unread articles it contains, etc., etc.
11067
11068 Some variables:
11069
11070 @table @code
11071 @item nneething-map-file-directory
11072 @vindex nneething-map-file-directory
11073 All the mapping files for solid @code{nneething} groups will be stored
11074 in this directory, which defaults to @file{~/.nneething/}.
11075
11076 @item nneething-exclude-files
11077 @vindex nneething-exclude-files
11078 All files that match this regexp will be ignored.  Nice to use to exclude
11079 auto-save files and the like, which is what it does by default.
11080
11081 @item nneething-include-files
11082 @vindex nneething-include-files
11083 Regexp saying what files to include in the group.  If this variable is
11084 non-@code{nil}, only files matching this regexp will be included.
11085
11086 @item nneething-map-file
11087 @vindex nneething-map-file
11088 Name of the map files.
11089 @end table
11090
11091
11092 @node Document Groups
11093 @subsection Document Groups
11094 @cindex nndoc
11095 @cindex documentation group
11096 @cindex help group
11097
11098 @code{nndoc} is a cute little thing that will let you read a single file
11099 as a newsgroup.  Several files types are supported:
11100
11101 @table @code
11102 @cindex babyl
11103 @cindex rmail mbox
11104
11105 @item babyl
11106 The babyl (rmail) mail box.
11107 @cindex mbox
11108 @cindex Unix mbox
11109
11110 @item mbox
11111 The standard Unix mbox file.
11112
11113 @cindex MMDF mail box
11114 @item mmdf
11115 The MMDF mail box format.
11116
11117 @item news
11118 Several news articles appended into a file.
11119
11120 @item rnews
11121 @cindex rnews batch files
11122 The rnews batch transport format.
11123 @cindex forwarded messages
11124
11125 @item forward
11126 Forwarded articles.
11127
11128 @item mime-parts
11129 MIME multipart messages.
11130
11131 @item standard-digest
11132 The standard (RFC 1153) digest format.
11133
11134 @item slack-digest
11135 Non-standard digest format---matches most things, but does it badly.
11136 @end table
11137
11138 You can also use the special ``file type'' @code{guess}, which means
11139 that @code{nndoc} will try to guess what file type it is looking at.
11140 @code{digest} means that @code{nndoc} should guess what digest type the
11141 file is.
11142
11143 @code{nndoc} will not try to change the file or insert any extra headers into
11144 it---it will simply, like, let you use the file as the basis for a
11145 group.  And that's it.
11146
11147 If you have some old archived articles that you want to insert into your
11148 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
11149 that.  Say you have an old @file{RMAIL} file with mail that you now want
11150 to split into your new @code{nnml} groups.  You look at that file using
11151 @code{nndoc} (using the @kbd{G f} command in the group buffer
11152 (@pxref{Foreign Groups})), set the process mark on all the articles in
11153 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
11154 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
11155 file is now also stored in lots of @code{nnml} directories, and you can
11156 delete that pesky @file{RMAIL} file.  If you have the guts!
11157
11158 Virtual server variables:
11159
11160 @table @code
11161 @item nndoc-article-type
11162 @vindex nndoc-article-type
11163 This should be one of @code{mbox}, @code{babyl}, @code{digest},
11164 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
11165 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
11166 @code{slack-digest}, @code{clari-briefs} or @code{guess}.
11167
11168 @item nndoc-post-type
11169 @vindex nndoc-post-type
11170 This variable says whether Gnus is to consider the group a news group or
11171 a mail group.  There are two valid values:  @code{mail} (the default)
11172 and @code{news}.
11173 @end table
11174
11175 @menu
11176 * Document Server Internals::   How to add your own document types.
11177 @end menu
11178
11179
11180 @node Document Server Internals
11181 @subsubsection Document Server Internals
11182
11183 Adding new document types to be recognized by @code{nndoc} isn't
11184 difficult.  You just have to whip up a definition of what the document
11185 looks like, write a predicate function to recognize that document type,
11186 and then hook into @code{nndoc}.
11187
11188 First, here's an example document type definition:
11189
11190 @example
11191 (mmdf
11192  (article-begin .  "^\^A\^A\^A\^A\n")
11193  (body-end .  "^\^A\^A\^A\^A\n"))
11194 @end example
11195
11196 The definition is simply a unique @dfn{name} followed by a series of
11197 regexp pseudo-variable settings.  Below are the possible
11198 variables---don't be daunted by the number of variables; most document
11199 types can be defined with very few settings:
11200
11201 @table @code
11202 @item first-article
11203 If present, @code{nndoc} will skip past all text until it finds
11204 something that match this regexp.  All text before this will be
11205 totally ignored.
11206
11207 @item article-begin
11208 This setting has to be present in all document type definitions.  It
11209 says what the beginning of each article looks like.
11210
11211 @item head-begin-function
11212 If present, this should be a function that moves point to the head of
11213 the article.
11214
11215 @item nndoc-head-begin
11216 If present, this should be a regexp that matches the head of the
11217 article.
11218
11219 @item nndoc-head-end
11220 This should match the end of the head of the article.  It defaults to
11221 @samp{^$}---the empty line.
11222
11223 @item body-begin-function
11224 If present, this function should move point to the beginning of the body
11225 of the article.
11226
11227 @item body-begin
11228 This should match the beginning of the body of the article.  It defaults
11229 to @samp{^\n}.
11230
11231 @item body-end-function
11232 If present, this function should move point to the end of the body of
11233 the article.
11234
11235 @item body-end
11236 If present, this should match the end of the body of the article.
11237
11238 @item file-end
11239 If present, this should match the end of the file.  All text after this
11240 regexp will be totally ignored.
11241
11242 @end table
11243
11244 So, using these variables @code{nndoc} is able to dissect a document
11245 file into a series of articles, each with a head and a body.  However, a
11246 few more variables are needed since not all document types are all that
11247 news-like---variables needed to transform the head or the body into
11248 something that's palatable for Gnus:
11249
11250 @table @code
11251 @item prepare-body-function
11252 If present, this function will be called when requesting an article.  It
11253 will be called with point at the start of the body, and is useful if the
11254 document has encoded some parts of its contents.
11255
11256 @item article-transform-function
11257 If present, this function is called when requesting an article.  It's
11258 meant to be used for more wide-ranging transformation of both head and
11259 body of the article.
11260
11261 @item generate-head-function
11262 If present, this function is called to generate a head that Gnus can
11263 understand.  It is called with the article number as a parameter, and is
11264 expected to generate a nice head for the article in question.  It is
11265 called when requesting the headers of all articles.
11266
11267 @end table
11268
11269 Let's look at the most complicated example I can come up with---standard
11270 digests:
11271
11272 @example
11273 (standard-digest
11274  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11275  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11276  (prepare-body-function . nndoc-unquote-dashes)
11277  (body-end-function . nndoc-digest-body-end)
11278  (head-end . "^ ?$")
11279  (body-begin . "^ ?\n")
11280  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11281  (subtype digest guess))
11282 @end example
11283
11284 We see that all text before a 70-width line of dashes is ignored; all
11285 text after a line that starts with that @samp{^End of} is also ignored;
11286 each article begins with a 30-width line of dashes; the line separating
11287 the head from the body may contain a single space; and that the body is
11288 run through @code{nndoc-unquote-dashes} before being delivered.
11289
11290 To hook your own document definition into @code{nndoc}, use the
11291 @code{nndoc-add-type} function.  It takes two parameters---the first is
11292 the definition itself and the second (optional) parameter says where in
11293 the document type definition alist to put this definition.  The alist is
11294 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
11295 is of @code{mmdf} type, and so on.  These type predicates should return
11296 @code{nil} if the document is not of the correct type; @code{t} if it is
11297 of the correct type; and a number if the document might be of the
11298 correct type.  A high number means high probability; a low number means
11299 low probability with @samp{0} being the lowest valid number.
11300
11301
11302 @node SOUP
11303 @subsection SOUP
11304 @cindex SOUP
11305 @cindex offline
11306
11307 In the PC world people often talk about ``offline'' newsreaders.  These
11308 are thingies that are combined reader/news transport monstrosities.
11309 With built-in modem programs.  Yecchh!
11310
11311 Of course, us Unix Weenie types of human beans use things like
11312 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11313 transport things like Ghod intended.  And then we just use normal
11314 newsreaders.
11315
11316 However, it can sometimes be convenient to do something a that's a bit
11317 easier on the brain if you have a very slow modem, and you're not really
11318 that interested in doing things properly.
11319
11320 A file format called @sc{soup} has been developed for transporting news
11321 and mail from servers to home machines and back again.  It can be a bit
11322 fiddly.
11323
11324 First some terminology:
11325
11326 @table @dfn
11327
11328 @item server
11329 This is the machine that is connected to the outside world and where you
11330 get news and/or mail from.
11331
11332 @item home machine
11333 This is the machine that you want to do the actual reading and responding
11334 on.  It is typically not connected to the rest of the world in any way.
11335
11336 @item packet
11337 Something that contains messages and/or commands.  There are two kinds
11338 of packets:
11339
11340 @table @dfn
11341 @item message packets
11342 These are packets made at the server, and typically contain lots of
11343 messages for you to read.  These are called @file{SoupoutX.tgz} by
11344 default, where @var{X} is a number.
11345
11346 @item response packets
11347 These are packets made at the home machine, and typically contains
11348 replies that you've written.  These are called @file{SoupinX.tgz} by
11349 default, where @var{X} is a number.
11350
11351 @end table
11352
11353 @end table
11354
11355
11356 @enumerate
11357
11358 @item
11359 You log in on the server and create a @sc{soup} packet.  You can either
11360 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11361 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11362 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11363
11364 @item
11365 You transfer the packet home.  Rail, boat, car or modem will do fine.
11366
11367 @item
11368 You put the packet in your home directory.
11369
11370 @item
11371 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11372 the native or secondary server.
11373
11374 @item
11375 You read articles and mail and answer and followup to the things you
11376 want (@pxref{SOUP Replies}).
11377
11378 @item
11379 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11380 packet.
11381
11382 @item
11383 You transfer this packet to the server.
11384
11385 @item
11386 You use Gnus to mail this packet out with the @kbd{G s s} command.
11387
11388 @item
11389 You then repeat until you die.
11390
11391 @end enumerate
11392
11393 So you basically have a bipartite system---you use @code{nnsoup} for
11394 reading and Gnus for packing/sending these @sc{soup} packets.
11395
11396 @menu
11397 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
11398 * SOUP Groups::       A backend for reading @sc{soup} packets.
11399 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
11400 @end menu
11401
11402
11403 @node SOUP Commands
11404 @subsubsection SOUP Commands
11405
11406 These are commands for creating and manipulating @sc{soup} packets.
11407
11408 @table @kbd
11409 @item G s b
11410 @kindex G s b (Group)
11411 @findex gnus-group-brew-soup
11412 Pack all unread articles in the current group
11413 (@code{gnus-group-brew-soup}).  This command understands the
11414 process/prefix convention.
11415
11416 @item G s w
11417 @kindex G s w (Group)
11418 @findex gnus-soup-save-areas
11419 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11420
11421 @item G s s
11422 @kindex G s s (Group)
11423 @findex gnus-soup-send-replies
11424 Send all replies from the replies packet
11425 (@code{gnus-soup-send-replies}).
11426
11427 @item G s p
11428 @kindex G s p (Group)
11429 @findex gnus-soup-pack-packet
11430 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11431
11432 @item G s r
11433 @kindex G s r (Group)
11434 @findex nnsoup-pack-replies
11435 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11436
11437 @item O s
11438 @kindex O s (Summary)
11439 @findex gnus-soup-add-article
11440 This summary-mode command adds the current article to a @sc{soup} packet
11441 (@code{gnus-soup-add-article}).  It understands the process/prefix
11442 convention (@pxref{Process/Prefix}).
11443
11444 @end table
11445
11446
11447 There are a few variables to customize where Gnus will put all these
11448 thingies:
11449
11450 @table @code
11451
11452 @item gnus-soup-directory
11453 @vindex gnus-soup-directory
11454 Directory where Gnus will save intermediate files while composing
11455 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
11456
11457 @item gnus-soup-replies-directory
11458 @vindex gnus-soup-replies-directory
11459 This is what Gnus will use as a temporary directory while sending our
11460 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
11461
11462 @item gnus-soup-prefix-file
11463 @vindex gnus-soup-prefix-file
11464 Name of the file where Gnus stores the last used prefix.  The default is
11465 @samp{gnus-prefix}.
11466
11467 @item gnus-soup-packer
11468 @vindex gnus-soup-packer
11469 A format string command for packing a @sc{soup} packet.  The default is
11470 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11471
11472 @item gnus-soup-unpacker
11473 @vindex gnus-soup-unpacker
11474 Format string command for unpacking a @sc{soup} packet.  The default is
11475 @samp{gunzip -c %s | tar xvf -}.
11476
11477 @item gnus-soup-packet-directory
11478 @vindex gnus-soup-packet-directory
11479 Where Gnus will look for reply packets.  The default is @file{~/}.
11480
11481 @item gnus-soup-packet-regexp
11482 @vindex gnus-soup-packet-regexp
11483 Regular expression matching @sc{soup} reply packets in
11484 @code{gnus-soup-packet-directory}.
11485
11486 @end table
11487
11488
11489 @node SOUP Groups
11490 @subsubsection @sc{soup} Groups
11491 @cindex nnsoup
11492
11493 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
11494 read incoming packets, unpack them, and put them in a directory where
11495 you can read them at leisure.
11496
11497 These are the variables you can use to customize its behavior:
11498
11499 @table @code
11500
11501 @item nnsoup-tmp-directory
11502 @vindex nnsoup-tmp-directory
11503 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11504 directory.  (@file{/tmp/} by default.)
11505
11506 @item nnsoup-directory
11507 @vindex nnsoup-directory
11508 @code{nnsoup} then moves each message and index file to this directory.
11509 The default is @file{~/SOUP/}.
11510
11511 @item nnsoup-replies-directory
11512 @vindex nnsoup-replies-directory
11513 All replies will be stored in this directory before being packed into a
11514 reply packet.  The default is @file{~/SOUP/replies/"}.
11515
11516 @item nnsoup-replies-format-type
11517 @vindex nnsoup-replies-format-type
11518 The @sc{soup} format of the replies packets.  The default is @samp{?n}
11519 (rnews), and I don't think you should touch that variable.  I probably
11520 shouldn't even have documented it.  Drats!  Too late!
11521
11522 @item nnsoup-replies-index-type
11523 @vindex nnsoup-replies-index-type
11524 The index type of the replies packet.  The default is @samp{?n}, which
11525 means ``none''.  Don't fiddle with this one either!
11526
11527 @item nnsoup-active-file
11528 @vindex nnsoup-active-file
11529 Where @code{nnsoup} stores lots of information.  This is not an ``active
11530 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
11531 this file or mess it up in any way, you're dead.  The default is
11532 @file{~/SOUP/active}.
11533
11534 @item nnsoup-packer
11535 @vindex nnsoup-packer
11536 Format string command for packing a reply @sc{soup} packet.  The default
11537 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11538
11539 @item nnsoup-unpacker
11540 @vindex nnsoup-unpacker
11541 Format string command for unpacking incoming @sc{soup} packets.  The
11542 default is @samp{gunzip -c %s | tar xvf -}.
11543
11544 @item nnsoup-packet-directory
11545 @vindex nnsoup-packet-directory
11546 Where @code{nnsoup} will look for incoming packets.  The default is
11547 @file{~/}.
11548
11549 @item nnsoup-packet-regexp
11550 @vindex nnsoup-packet-regexp
11551 Regular expression matching incoming @sc{soup} packets.  The default is
11552 @samp{Soupout}.
11553
11554 @item nnsoup-always-save
11555 @vindex nnsoup-always-save
11556 If non-@code{nil}, save the replies buffer after each posted message.
11557
11558 @end table
11559
11560
11561 @node SOUP Replies
11562 @subsubsection SOUP Replies
11563
11564 Just using @code{nnsoup} won't mean that your postings and mailings end
11565 up in @sc{soup} reply packets automagically.  You have to work a bit
11566 more for that to happen.
11567
11568 @findex nnsoup-set-variables
11569 The @code{nnsoup-set-variables} command will set the appropriate
11570 variables to ensure that all your followups and replies end up in the
11571 @sc{soup} system.
11572
11573 In specific, this is what it does:
11574
11575 @lisp
11576 (setq message-send-news-function 'nnsoup-request-post)
11577 (setq message-send-mail-function 'nnsoup-request-mail)
11578 @end lisp
11579
11580 And that's it, really.  If you only want news to go into the @sc{soup}
11581 system you just use the first line.  If you only want mail to be
11582 @sc{soup}ed you use the second.
11583
11584
11585 @node Web Searches
11586 @subsection Web Searches
11587 @cindex nnweb
11588 @cindex DejaNews
11589 @cindex Alta Vista
11590 @cindex InReference
11591 @cindex Usenet searches
11592 @cindex searching the Usenet
11593
11594 It's, like, too neat to search the Usenet for articles that match a
11595 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11596 those, like, Web browsers, and you, like, have to, rilly, like, look at
11597 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11598 searches without having to use a browser.
11599
11600 The @code{nnweb} backend allows an easy interface to the mighty search
11601 engine.  You create an @code{nnweb} group, enter a search pattern, and
11602 then enter the group and read the articles like you would any normal
11603 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
11604 Groups}) will do this in an easy-to-use fashion.
11605
11606 @code{nnweb} groups don't really lend themselves to being solid
11607 groups---they have a very fleeting idea of article numbers.  In fact,
11608 each time you enter an @code{nnweb} group (not even changing the search
11609 pattern), you are likely to get the articles ordered in a different
11610 manner.  Not even using duplicate suppression (@pxref{Duplicate
11611 Suppression}) will help, since @code{nnweb} doesn't even know the
11612 @code{Message-ID} of the articles before reading them using some search
11613 engines (DejaNews, for instance).  The only possible way to keep track
11614 of which articles you've read is by scoring on the @code{Date}
11615 header---mark all articles posted before the last date you read the
11616 group as read.
11617
11618 If the search engine changes its output substantially, @code{nnweb}
11619 won't be able to parse it and will fail.  One could hardly fault the Web
11620 providers if they were to do this---their @emph{raison d'être} is to
11621 make money off of advertisements, not to provide services to the
11622 community.  Since @code{nnweb} washes the ads off all the articles, one
11623 might think that the providers might be somewhat miffed.  We'll see.
11624
11625 You must have the @code{url} and @code{w3} package installed to be able
11626 to use @code{nnweb}.
11627
11628 Virtual server variables:
11629
11630 @table @code
11631 @item nnweb-type
11632 @vindex nnweb-type
11633 What search engine type is being used.  The currently supported types
11634 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11635 @code{reference}.
11636
11637 @item nnweb-search
11638 @vindex nnweb-search
11639 The search string to feed to the search engine.
11640
11641 @item nnweb-max-hits
11642 @vindex nnweb-max-hits
11643 Advisory maximum number of hits per search to display.  The default is
11644 100.
11645
11646 @item nnweb-type-definition
11647 @vindex nnweb-type-definition
11648 Type-to-definition alist.  This alist says what @code{nnweb} should do
11649 with the various search engine types.  The following elements must be
11650 present:
11651
11652 @table @code
11653 @item article
11654 Function to decode the article and provide something that Gnus
11655 understands.
11656
11657 @item map
11658 Function to create an article number to message header and URL alist.
11659
11660 @item search
11661 Function to send the search string to the search engine.
11662
11663 @item address
11664 The address the aforementioned function should send the search string
11665 to.
11666
11667 @item id
11668 Format string URL to fetch an article by @code{Message-ID}.
11669 @end table
11670
11671 @end table
11672
11673
11674
11675 @node Mail-To-News Gateways
11676 @subsection Mail-To-News Gateways
11677 @cindex mail-to-news gateways
11678 @cindex gateways
11679
11680 If your local @code{nntp} server doesn't allow posting, for some reason
11681 or other, you can post using one of the numerous mail-to-news gateways.
11682 The @code{nngateway} backend provides the interface.
11683
11684 Note that you can't read anything from this backend---it can only be
11685 used to post with.
11686
11687 Server variables:
11688
11689 @table @code
11690 @item nngateway-address
11691 @vindex nngateway-address
11692 This is the address of the mail-to-news gateway.
11693
11694 @item nngateway-header-transformation
11695 @vindex nngateway-header-transformation
11696 News headers often have to be transformed in some odd way or other
11697 for the mail-to-news gateway to accept it.  This variable says what
11698 transformation should be called, and defaults to
11699 @code{nngateway-simple-header-transformation}.  The function is called
11700 narrowed to the headers to be transformed and with one parameter---the
11701 gateway address.
11702
11703 This default function just inserts a new @code{To} header based on the
11704 @code{Newsgroups} header and the gateway address.
11705 For instance, an article with this @code{Newsgroups} header:
11706
11707 @example
11708 Newsgroups: alt.religion.emacs
11709 @end example
11710
11711 will get this @code{From} header inserted:
11712
11713 @example
11714 To: alt-religion-emacs@@GATEWAY
11715 @end example
11716
11717 The following pre-defined functions exist:
11718
11719 @findex nngateway-simple-header-transformation
11720 @table @code
11721
11722 @item nngateway-simple-header-transformation
11723 Creates a @code{To} header that looks like
11724 @var{newsgroup}@@@code{nngateway-address}.
11725
11726 @findex nngateway-mail2news-header-transformation
11727
11728 @item nngateway-mail2news-header-transformation
11729 Creates a @code{To} header that looks like
11730 @code{nngateway-address}.
11731
11732 Here's an example:
11733
11734 @lisp
11735 (setq gnus-post-method
11736       '(nngateway "mail2news@@replay.com"
11737                   (nngateway-header-transformation
11738                    nngateway-mail2news-header-transformation)))
11739 @end lisp
11740
11741 @end table
11742
11743
11744 @end table
11745
11746 So, to use this, simply say something like:
11747
11748 @lisp
11749 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
11750 @end lisp
11751
11752
11753 @node Combined Groups
11754 @section Combined Groups
11755
11756 Gnus allows combining a mixture of all the other group types into bigger
11757 groups.
11758
11759 @menu
11760 * Virtual Groups::     Combining articles from many groups.
11761 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
11762 @end menu
11763
11764
11765 @node Virtual Groups
11766 @subsection Virtual Groups
11767 @cindex nnvirtual
11768 @cindex virtual groups
11769 @cindex merging groups
11770
11771 An @dfn{nnvirtual group} is really nothing more than a collection of
11772 other groups.
11773
11774 For instance, if you are tired of reading many small groups, you can
11775 put them all in one big group, and then grow tired of reading one
11776 big, unwieldy group.  The joys of computing!
11777
11778 You specify @code{nnvirtual} as the method.  The address should be a
11779 regexp to match component groups.
11780
11781 All marks in the virtual group will stick to the articles in the
11782 component groups.  So if you tick an article in a virtual group, the
11783 article will also be ticked in the component group from whence it came.
11784 (And vice versa---marks from the component groups will also be shown in
11785 the virtual group.)
11786
11787 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
11788 newsgroups into one, big, happy newsgroup:
11789
11790 @lisp
11791 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11792 @end lisp
11793
11794 The component groups can be native or foreign; everything should work
11795 smoothly, but if your computer explodes, it was probably my fault.
11796
11797 Collecting the same group from several servers might actually be a good
11798 idea if users have set the Distribution header to limit distribution.
11799 If you would like to read @samp{soc.motss} both from a server in Japan
11800 and a server in Norway, you could use the following as the group regexp:
11801
11802 @example
11803 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
11804 @end example
11805
11806 (Remember, though, that if you're creating the group with @kbd{G m}, you
11807 shouldn't double the backslashes, and you should leave off the quote
11808 characters at the beginning and the end of the string.)
11809
11810 This should work kinda smoothly---all articles from both groups should
11811 end up in this one, and there should be no duplicates.  Threading (and
11812 the rest) will still work as usual, but there might be problems with the
11813 sequence of articles.  Sorting on date might be an option here
11814 (@pxref{Selecting a Group}).
11815
11816 One limitation, however---all groups included in a virtual
11817 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
11818 zombie groups can't be component groups for @code{nnvirtual} groups.
11819
11820 @vindex nnvirtual-always-rescan
11821 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11822 @code{nnvirtual} will always scan groups for unread articles when
11823 entering a virtual group.  If this variable is @code{nil} (which is the
11824 default) and you read articles in a component group after the virtual
11825 group has been activated, the read articles from the component group
11826 will show up when you enter the virtual group.  You'll also see this
11827 effect if you have two virtual groups that have a component group in
11828 common.  If that's the case, you should set this variable to @code{t}.
11829 Or you can just tap @code{M-g} on the virtual group every time before
11830 you enter it---it'll have much the same effect.
11831
11832 @code{nnvirtual} can have both mail and news groups as component groups.
11833 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
11834 has to ask the backend of the component group the article comes from
11835 whether it is a news or mail backend.  However, when you do a @kbd{^},
11836 there is typically no sure way for the component backend to know this,
11837 and in that case @code{nnvirtual} tells Gnus that the article came from a
11838 not-news backend.  (Just to be on the safe side.)
11839
11840 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
11841 line from the article you respond to in these cases.
11842
11843
11844
11845 @node Kibozed Groups
11846 @subsection Kibozed Groups
11847 @cindex nnkiboze
11848 @cindex kibozing
11849
11850 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11851 the news feed''.  @code{nnkiboze} is a backend that will do this for
11852 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
11853 with useless requests!  Oh happiness!
11854
11855 @kindex G k (Group)
11856 To create a kibozed group, use the @kbd{G k} command in the group
11857 buffer.
11858
11859 The address field of the @code{nnkiboze} method is, as with
11860 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11861 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
11862 and @code{nnvirtual} end.
11863
11864 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11865 must have a score file to say what articles are to be included in
11866 the group (@pxref{Scoring}).
11867
11868 @kindex M-x nnkiboze-generate-groups
11869 @findex nnkiboze-generate-groups
11870 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11871 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
11872 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
11873 all the articles in all the component groups and run them through the
11874 scoring process to determine if there are any articles in the groups
11875 that are to be part of the @code{nnkiboze} groups.
11876
11877 Please limit the number of component groups by using restrictive
11878 regexps.  Otherwise your sysadmin may become annoyed with you, and the
11879 @sc{nntp} site may throw you off and never let you back in again.
11880 Stranger things have happened.
11881
11882 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11883 and they can be foreign.  No restrictions.
11884
11885 @vindex nnkiboze-directory
11886 The generation of an @code{nnkiboze} group means writing two files in
11887 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
11888 contains the @sc{nov} header lines for all the articles in the group,
11889 and the other is an additional @file{.newsrc} file to store information
11890 on what groups have been searched through to find component articles.
11891
11892 Articles marked as read in the @code{nnkiboze} group will have
11893 their @sc{nov} lines removed from the @sc{nov} file.
11894
11895
11896 @node Gnus Unplugged
11897 @section Gnus Unplugged
11898 @cindex offline
11899 @cindex unplugged
11900 @cindex Agent
11901 @cindex Gnus Agent
11902 @cindex Gnus Unplugged
11903
11904 In olden times (ca. February '88), people used to run their newsreaders
11905 on big machines with permanent connections to the net.  News transport
11906 was dealt with by news servers, and all the newsreaders had to do was to
11907 read news.  Believe it or not.
11908
11909 Nowadays most people read news and mail at home, and use some sort of
11910 modem to connect to the net.  To avoid running up huge phone bills, it
11911 would be nice to have a way to slurp down all the news and mail, hang up
11912 the phone, read for several hours, and then upload any responses you
11913 have to make.  And then you repeat the procedure.
11914
11915 Of course, you can use news servers for doing this as well.  I've used
11916 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11917 for some years, but doing that's a bore.  Moving the news server
11918 functionality up to the newsreader makes sense if you're the only person
11919 reading news on a machine.
11920
11921 Using Gnus as an ``offline'' newsreader is quite simple.
11922
11923 @itemize @bullet
11924 @item
11925 First, set up Gnus as you would do if you were running it on a machine
11926 that has full connection to the net.  Go ahead.  I'll still be waiting
11927 here.
11928
11929 @item
11930 Then, put the following magical incantation at the end of your
11931 @file{.gnus.el} file:
11932
11933 @lisp
11934 (gnus-agentize)
11935 @end lisp
11936 @end itemize
11937
11938 That's it.  Gnus is now an ``offline'' newsreader.
11939
11940 Of course, to use it as such, you have to learn a few new commands.
11941
11942 @menu
11943 * Agent Basics::           How it all is supposed to work.
11944 * Agent Categories::       How to tell the Gnus Agent what to download.
11945 * Agent Commands::         New commands for all the buffers.
11946 * Agent Expiry::           How to make old articles go away.
11947 * Outgoing Messages::      What happens when you post/mail something?
11948 * Agent Variables::        Customizing is fun.
11949 * Example Setup::          An example @file{.gnus.el} file for offline people.
11950 * Batching Agents::        How to fetch news from a @code{cron} job.
11951 * Agent Caveats::          What you think it'll do and what it does.
11952 @end menu
11953
11954
11955 @node Agent Basics
11956 @subsection Agent Basics
11957
11958 First, let's get some terminology out of the way.
11959
11960 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11961 connection to the net (and notified the Agent that this is the case).
11962 When the connection to the net is up again (and Gnus knows this), the
11963 Agent is @dfn{plugged}.
11964
11965 The @dfn{local} machine is the one you're running on, and which isn't
11966 connected to the net continuously.
11967
11968 @dfn{Downloading} means fetching things from the net to your local
11969 machine.  @dfn{Uploading} is doing the opposite.
11970
11971 Let's take a typical Gnus session using the Agent.
11972
11973 @itemize @bullet
11974
11975 @item
11976 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
11977 Agent in a disconnected state.  You can read all the news that you have
11978 already fetched while in this mode.
11979
11980 @item
11981 You then decide to see whether any new news has arrived.  You connect
11982 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11983 to make Gnus become @dfn{plugged}.
11984
11985 @item
11986 You can then read the new news immediately, or you can download the news
11987 onto your local machine.  If you want to do the latter, you press @kbd{J
11988 s} to fetch all the eligible articles in all the groups.  (To let Gnus
11989 know which articles you want to download, @pxref{Agent Categories}.)
11990
11991 @item
11992 After fetching the articles, you press @kbd{J j} to make Gnus become
11993 unplugged again, and you shut down the PPP thing (or whatever).  And
11994 then you read the news offline.
11995
11996 @item
11997 And then you go to step 2.
11998 @end itemize
11999
12000 Here are some things you should do the first time (or so) that you use
12001 the Agent.
12002
12003 @itemize @bullet
12004
12005 @item
12006 Decide which servers should be covered by the Agent.  If you have a mail
12007 backend, it would probably be nonsensical to have it covered by the
12008 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
12009 @kbd{J a} the server (or servers) that you wish to have covered by the
12010 Agent (@pxref{Server Agent Commands}).  This will typically be only the
12011 primary select method, which is listed on the bottom in the buffer.
12012
12013 @item
12014 Decide on download policy.  @xref{Agent Categories}.
12015
12016 @item
12017 Uhm... that's it.
12018 @end itemize
12019
12020
12021 @node Agent Categories
12022 @subsection Agent Categories
12023
12024 One of the main reasons to integrate the news transport layer into the
12025 newsreader is to allow greater control over what articles to download.
12026 There's not much point in downloading huge amounts of articles, just to
12027 find out that you're not interested in reading any of them.  It's better
12028 to be somewhat more conservative in choosing what to download, and then
12029 mark the articles for downloading manually if it should turn out that
12030 you're interested in the articles anyway.
12031
12032 The main way to control what is to be downloaded is to create a
12033 @dfn{category} and then assign some (or all) groups to this category.
12034 Gnus has its own buffer for creating and managing categories.
12035
12036 @menu
12037 * Category Syntax::       What a category looks like.
12038 * The Category Buffer::   A buffer for maintaining categories.
12039 * Category Variables::    Customize'r'Us.
12040 @end menu
12041
12042
12043 @node Category Syntax
12044 @subsubsection Category Syntax
12045
12046 A category consists of two things.
12047
12048 @enumerate
12049 @item
12050 A predicate which (generally) gives a rough outline of which articles
12051 are eligible for downloading; and
12052
12053 @item
12054 a score rule which (generally) gives you a finer granularity when
12055 deciding what articles to download.  (Note that this @dfn{download
12056 score} is not necessarily related to normal scores.)
12057 @end enumerate
12058
12059 A predicate in its simplest form can be a single predicate such as
12060 @code{true} or @code{false}. These two will download every available
12061 article or nothing respectively. In the case of these two special
12062 predicates an additional score rule is superfluous.
12063
12064 Predicates of @code{high} or @code{low} download articles in respect of
12065 their scores in relationship to @code{gnus-agent-high-score} and
12066 @code{gnus-agent-low-score} as descibed below.
12067
12068 To gain even finer control of what is to be regarded eligible for
12069 download a predicate can consist of a number of predicates with logical
12070 operators sprinkled in between.
12071
12072 Perhaps some examples are in order.
12073
12074 Here's a simple predicate.  (It's the default predicate, in fact, used
12075 for all groups that don't belong to any other category.)
12076
12077 @lisp
12078 short
12079 @end lisp
12080
12081 Quite simple, eh?  This predicate is true if and only if the article is
12082 short (for some value of ``short'').
12083
12084 Here's a more complex predicate:
12085
12086 @lisp
12087 (or high
12088     (and
12089      (not low)
12090      (not long)))
12091 @end lisp
12092
12093 This means that an article should be downloaded if it has a high score,
12094 or if the score is not low and the article is not long.  You get the
12095 drift.
12096
12097 The available logical operators are @code{or}, @code{and} and
12098 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
12099 @samp{|}, @code{&} and @code{!} instead.)
12100
12101 The following predicates are pre-defined, but if none of these fit what
12102 you want to do, you can write your own.
12103
12104 @table @code
12105 @item short
12106 True iff the article is shorter than @code{gnus-agent-short-article}
12107 lines; default 100.
12108
12109 @item long
12110 True iff the article is longer than @code{gnus-agent-long-article}
12111 lines; default 200.
12112
12113 @item low
12114 True iff the article has a download score less than
12115 @code{gnus-agent-low-score}; default 0.
12116
12117 @item high
12118 True iff the article has a download score greater than
12119 @code{gnus-agent-high-score}; default 0.
12120
12121 @item spam
12122 True iff the Gnus Agent guesses that the article is spam.  The
12123 heuristics may change over time, but at present it just computes a
12124 checksum and sees whether articles match.
12125
12126 @item true
12127 Always true.
12128
12129 @item false
12130 Always false.
12131 @end table
12132
12133 If you want to create your own predicate function, here's what you have
12134 to know:  The functions are called with no parameters, but the
12135 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
12136 useful values.
12137
12138 For example, you could decide that you don't want to download articles
12139 that were posted more than a certain number of days ago (e.g. posted
12140 more than @code{gnus-agent-expire-days} ago) you might write a function
12141 something along the lines of the following:
12142
12143 @lisp
12144 (defun my-article-old-p ()
12145   "Say whether an article is old."
12146   (< (time-to-day (date-to-time (mail-header-date gnus-headers)))
12147      (- (time-to-day (current-time)) gnus-agent-expire-days)))
12148 @end lisp
12149
12150 with the predicate then defined as:
12151
12152 @lisp
12153 (not my-article-old-p)
12154 @end lisp
12155
12156 or you could append your predicate to the predefined
12157 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
12158 wherever.  (Note: this would have to be at a point *after*
12159 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
12160
12161 @lisp
12162 (defvar  gnus-category-predicate-alist
12163   (append gnus-category-predicate-alist
12164          '((old . my-article-old-p))))
12165 @end lisp
12166
12167 and simply specify your predicate as:
12168
12169 @lisp
12170 (not old)
12171 @end lisp
12172
12173 If/when using something like the above, be aware that there are many
12174 misconfigured systems/mailers out there and so an article's date is not
12175 always a reliable indication of when it was posted. Hell, some people
12176 just don't give a damm.
12177
12178
12179 The above predicates apply to *all* the groups which belong to the
12180 category. However, if you wish to have a specific predicate for an
12181 individual group within a category, or you're just too lazy to set up a
12182 new category, you can enter a group's individual predicate in it's group
12183 parameters like so:
12184
12185 @lisp
12186 (agent-predicate . short)
12187 @end lisp
12188
12189 This is the group parameter equivalent of the agent category
12190 default. Note that when specifying a single word predicate like this,
12191 the @code{agent-predicate} specification must be in dotted pair
12192 notation.
12193
12194 The equivalent of the longer example from above would be:
12195
12196 @lisp
12197 (agent-predicate or high (and (not low) (not long)))
12198 @end lisp
12199
12200 The outer parenthesis required in the category specification are not
12201 entered here as, not being in dotted pair notation, the value of the
12202 predicate is assumed to be a list.
12203
12204
12205 Now, the syntax of the download score is the same as the syntax of
12206 normal score files, except that all elements that require actually
12207 seeing the article itself are verboten.  This means that only the
12208 following headers can be scored on: @code{Subject}, @code{From},
12209 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12210 @code{Lines}, and @code{Xref}.
12211
12212 As with predicates, the specification of the @code{download score rule}
12213 to use in respect of a group can be in either the category definition if
12214 it's to be applicable to all groups in therein, or a group's parameters
12215 if it's to be specific to that group.
12216
12217 In both of these places the @code{download score rule} can take one of
12218 three forms:
12219
12220 @enumerate
12221 @item
12222 Score rule
12223
12224 This has the same syntax as a normal gnus score file except only a
12225 subset of scoring keywords are available as mentioned above.
12226
12227 example:
12228
12229 @itemize @bullet
12230 @item
12231 Category specification
12232
12233 @lisp
12234 (("from"
12235        ("Lars Ingebrigtsen" 1000000 nil s))
12236 ("lines"
12237        (500 -100 nil <)))
12238 @end lisp
12239
12240 @item
12241 Group Parameter specification
12242
12243 @lisp
12244 (agent-score ("from"
12245                    ("Lars Ingebrigtsen" 1000000 nil s))
12246              ("lines"
12247                    (500 -100 nil <)))
12248 @end lisp
12249
12250 Again, note the omission of the outermost parenthesis here.
12251 @end itemize
12252
12253 @item
12254 Agent score file
12255
12256 These score files must *only* contain the permitted scoring keywords
12257 stated above.
12258
12259 example:
12260
12261 @itemize @bullet
12262 @item
12263 Category specification
12264
12265 @lisp
12266 ("~/News/agent.SCORE")
12267 @end lisp
12268
12269 or perhaps
12270
12271 @lisp
12272 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12273 @end lisp
12274
12275 @item
12276 Group Parameter specification
12277
12278 @lisp
12279 (agent-score "~/News/agent.SCORE")
12280 @end lisp
12281
12282 Additional score files can be specified as above. Need I say anything
12283 about parenthesis.
12284 @end itemize
12285
12286 @item
12287 Use @code{normal} score files
12288
12289 If you dont want to maintain two sets of scoring rules for a group, and
12290 your desired @code{downloading} criteria for a group are the same as your
12291 @code{reading} criteria then you can tell the agent to refer to your
12292 @code{normal} score files when deciding what to download.
12293
12294 These directives in either the category definition or a group's
12295 parameters will cause the agent to read in all the applicable score
12296 files for a group, *filtering out* those those sections that do not
12297 relate to one of the permitted subset of scoring keywords.
12298
12299 @itemize @bullet
12300 @item
12301 Category Specification
12302
12303 @lisp
12304 file
12305 @end lisp
12306
12307 @item
12308 Group Parameter specification
12309
12310 @lisp
12311 (agent-score . file)
12312 @end lisp
12313 @end itemize
12314 @end enumerate
12315
12316 @node The Category Buffer
12317 @subsubsection The Category Buffer
12318
12319 You'd normally do all category maintenance from the category buffer.
12320 When you enter it for the first time (with the @kbd{J c} command from
12321 the group buffer), you'll only see the @code{default} category.
12322
12323 The following commands are available in this buffer:
12324
12325 @table @kbd
12326 @item q
12327 @kindex q (Category)
12328 @findex gnus-category-exit
12329 Return to the group buffer (@code{gnus-category-exit}).
12330
12331 @item k
12332 @kindex k (Category)
12333 @findex gnus-category-kill
12334 Kill the current category (@code{gnus-category-kill}).
12335
12336 @item c
12337 @kindex c (Category)
12338 @findex gnus-category-copy
12339 Copy the current category (@code{gnus-category-copy}).
12340
12341 @item a
12342 @kindex a (Category)
12343 @findex gnus-category-add
12344 Add a new category (@code{gnus-category-add}).
12345
12346 @item p
12347 @kindex p (Category)
12348 @findex gnus-category-edit-predicate
12349 Edit the predicate of the current category
12350 (@code{gnus-category-edit-predicate}).
12351
12352 @item g
12353 @kindex g (Category)
12354 @findex gnus-category-edit-groups
12355 Edit the list of groups belonging to the current category
12356 (@code{gnus-category-edit-groups}).
12357
12358 @item s
12359 @kindex s (Category)
12360 @findex gnus-category-edit-score
12361 Edit the download score rule of the current category
12362 (@code{gnus-category-edit-score}).
12363
12364 @item l
12365 @kindex l (Category)
12366 @findex gnus-category-list
12367 List all the categories (@code{gnus-category-list}).
12368 @end table
12369
12370
12371 @node Category Variables
12372 @subsubsection Category Variables
12373
12374 @table @code
12375 @item gnus-category-mode-hook
12376 @vindex gnus-category-mode-hook
12377 Hook run in category buffers.
12378
12379 @item gnus-category-line-format
12380 @vindex gnus-category-line-format
12381 Format of the lines in the category buffer (@pxref{Formatting
12382 Variables}).  Valid elements are:
12383
12384 @table @samp
12385 @item c
12386 The name of the category.
12387
12388 @item g
12389 The number of groups in the category.
12390 @end table
12391
12392 @item gnus-category-mode-line-format
12393 @vindex gnus-category-mode-line-format
12394 Format of the category mode line (@pxref{Mode Line Formatting}).
12395
12396 @item gnus-agent-short-article
12397 @vindex gnus-agent-short-article
12398 Articles that have fewer lines than this are short.  Default 100.
12399
12400 @item gnus-agent-long-article
12401 @vindex gnus-agent-long-article
12402 Articles that have more lines than this are long.  Default 200.
12403
12404 @item gnus-agent-low-score
12405 @vindex gnus-agent-low-score
12406 Articles that have a score lower than this have a low score.  Default
12407 0.
12408
12409 @item gnus-agent-high-score
12410 @vindex gnus-agent-high-score
12411 Articles that have a score higher than this have a high score.  Default
12412 0.
12413
12414 @end table
12415
12416
12417 @node Agent Commands
12418 @subsection Agent Commands
12419
12420 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
12421 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12422 toggles the plugged/unplugged state of the Gnus Agent.
12423
12424
12425 @menu
12426 * Group Agent Commands::
12427 * Summary Agent Commands::
12428 * Server Agent Commands::
12429 @end menu
12430
12431 You can run a complete batch fetch from the command line with the
12432 following incantation:
12433
12434 @cindex gnus-agent-batch-fetch
12435 @example
12436 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12437 @end example
12438
12439
12440
12441 @node Group Agent Commands
12442 @subsubsection Group Agent Commands
12443
12444 @table @kbd
12445 @item J u
12446 @kindex J u (Agent Group)
12447 @findex gnus-agent-fetch-groups
12448 Fetch all eligible articles in the current group
12449 (@code{gnus-agent-fetch-groups}).
12450
12451 @item J c
12452 @kindex J c (Agent Group)
12453 @findex gnus-enter-category-buffer
12454 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12455
12456 @item J s
12457 @kindex J s (Agent Group)
12458 @findex gnus-agent-fetch-session
12459 Fetch all eligible articles in all groups
12460 (@code{gnus-agent-fetch-session}).
12461
12462 @item J S
12463 @kindex J S (Agent Group)
12464 @findex gnus-group-send-drafts
12465 Send all sendable messages in the draft group
12466 (@code{gnus-agent-fetch-session}).  @xref{Drafts}.
12467
12468 @item J a
12469 @kindex J a (Agent Group)
12470 @findex gnus-agent-add-group
12471 Add the current group to an Agent category
12472 (@code{gnus-agent-add-group}).  This command understands the
12473 process/prefix convention (@pxref{Process/Prefix}).
12474
12475 @item J r
12476 @kindex J r (Agent Group)
12477 @findex gnus-agent-remove-group
12478 Remove the current group from its category, if any
12479 (@code{gnus-agent-remove-group}).  This command understands the
12480 process/prefix convention (@pxref{Process/Prefix}).
12481
12482 @end table
12483
12484
12485 @node Summary Agent Commands
12486 @subsubsection Summary Agent Commands
12487
12488 @table @kbd
12489 @item J #
12490 @kindex J # (Agent Summary)
12491 @findex gnus-agent-mark-article
12492 Mark the article for downloading (@code{gnus-agent-mark-article}).
12493
12494 @item J M-#
12495 @kindex J M-# (Agent Summary)
12496 @findex gnus-agent-unmark-article
12497 Remove the downloading mark from the article
12498 (@code{gnus-agent-unmark-article}).
12499
12500 @item @@
12501 @kindex @@ (Agent Summary)
12502 @findex gnus-agent-toggle-mark
12503 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12504
12505 @item J c
12506 @kindex J c (Agent Summary)
12507 @findex gnus-agent-catchup
12508 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12509
12510 @end table
12511
12512
12513 @node Server Agent Commands
12514 @subsubsection Server Agent Commands
12515
12516 @table @kbd
12517 @item J a
12518 @kindex J a (Agent Server)
12519 @findex gnus-agent-add-server
12520 Add the current server to the list of servers covered by the Gnus Agent
12521 (@code{gnus-agent-add-server}).
12522
12523 @item J r
12524 @kindex J r (Agent Server)
12525 @findex gnus-agent-remove-server
12526 Remove the current server from the list of servers covered by the Gnus
12527 Agent (@code{gnus-agent-remove-server}).
12528
12529 @end table
12530
12531
12532 @node Agent Expiry
12533 @subsection Agent Expiry
12534
12535 @vindex gnus-agent-expire-days
12536 @findex gnus-agent-expire
12537 @kindex M-x gnus-agent-expire
12538 @cindex Agent expiry
12539 @cindex Gnus Agent expiry
12540 @cindex expiry
12541
12542 @code{nnagent} doesn't handle expiry.  Instead, there's a special
12543 @code{gnus-agent-expire} command that will expire all read articles that
12544 are older than @code{gnus-agent-expire-days} days.  It can be run
12545 whenever you feel that you're running out of space.  It's not
12546 particularly fast or efficient, and it's not a particularly good idea to
12547 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12548
12549 @vindex gnus-agent-expire-all
12550 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12551 expire all articles---unread, read, ticked and dormant.  If @code{nil}
12552 (which is the default), only read articles are eligible for expiry, and
12553 unread, ticked and dormant articles will be kept indefinitely.
12554
12555
12556 @node Outgoing Messages
12557 @subsection Outgoing Messages
12558
12559 When Gnus is unplugged, all outgoing messages (both mail and news) are
12560 stored in the draft groups (@pxref{Drafts}).  You can view them there
12561 after posting, and edit them at will.
12562
12563 When Gnus is plugged again, you can send the messages either from the
12564 draft group with the special commands available there, or you can use
12565 the @kbd{J S} command in the group buffer to send all the sendable
12566 messages in the draft group.
12567
12568
12569
12570 @node Agent Variables
12571 @subsection Agent Variables
12572
12573 @table @code
12574 @item gnus-agent-directory
12575 @vindex gnus-agent-directory
12576 Where the Gnus Agent will store its files.  The default is
12577 @file{~/News/agent/}.
12578
12579 @item gnus-agent-handle-level
12580 @vindex gnus-agent-handle-level
12581 Groups on levels (@pxref{Group Levels}) higher than this variable will
12582 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
12583 which means that only subscribed group will be considered by the Agent
12584 by default.
12585
12586 @item gnus-agent-plugged-hook
12587 @vindex gnus-agent-plugged-hook
12588 Hook run when connecting to the network.
12589
12590 @item gnus-agent-unplugged-hook
12591 @vindex gnus-agent-unplugged-hook
12592 Hook run when disconnecting from the network.
12593
12594 @end table
12595
12596
12597 @node Example Setup
12598 @subsection Example Setup
12599
12600 If you don't want to read this manual, and you have a fairly standard
12601 setup, you may be able to use something like the following as your
12602 @file{.gnus.el} file to get started.
12603
12604 @lisp
12605 ;;; Define how Gnus is to fetch news.  We do this over NNTP
12606 ;;; from your ISP's server.
12607 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
12608
12609 ;;; Define how Gnus is to read your mail.  We read mail from
12610 ;;; your ISP's POP server.
12611 (setenv "MAILHOST" "pop.your-isp.com")
12612 (setq nnmail-spool-file "po:username")
12613
12614 ;;; Say how Gnus is to store the mail.  We use nnml groups.
12615 (setq gnus-secondary-select-methods '((nnml "")))
12616
12617 ;;; Make Gnus into an offline newsreader.
12618 (gnus-agentize)
12619 @end lisp
12620
12621 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
12622 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12623 gnus}.
12624
12625 If this is the first time you've run Gnus, you will be subscribed
12626 automatically to a few default newsgroups.  You'll probably want to
12627 subscribe to more groups, and to do that, you have to query the
12628 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12629 command.  This usually takes quite a while, but you only have to do it
12630 once.
12631
12632 After reading and parsing a while, you'll be presented with a list of
12633 groups.  Subscribe to the ones you want to read with the @kbd{u}
12634 command.  @kbd{l} to make all the killed groups disappear after you've
12635 subscribe to all the groups you want to read.  (@kbd{A k} will bring
12636 back all the killed groups.)
12637
12638 You can now read the groups at once, or you can download the articles
12639 with the @kbd{J s} command.  And then read the rest of this manual to
12640 find out which of the other gazillion things you want to customize.
12641
12642
12643 @node Batching Agents
12644 @subsection Batching Agents
12645
12646 Having the Gnus Agent fetch articles (and post whatever messages you've
12647 written) is quite easy once you've gotten things set up properly.  The
12648 following shell script will do everything that is necessary:
12649
12650 @example
12651 #!/bin/sh
12652 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
12653 @end example
12654
12655
12656 @node Agent Caveats
12657 @subsection Agent Caveats
12658
12659 The Gnus Agent doesn't seem to work like most other offline
12660 newsreaders.  Here are some common questions that some imaginary people
12661 may ask:
12662
12663 @table @dfn
12664 @item If I read an article while plugged, do they get entered into the
12665 Agent?
12666
12667 @strong{No.}
12668
12669 @item If I read an article while plugged, and the article already exists
12670 in the Agent, will it get downloaded once more?
12671
12672 @strong{Yes.}
12673
12674 @end table
12675
12676 In short, when Gnus is unplugged, it only looks into the locally stored
12677 articles; when it's plugged, it only talks to your ISP.
12678
12679
12680 @node Scoring
12681 @chapter Scoring
12682 @cindex scoring
12683
12684 Other people use @dfn{kill files}, but we here at Gnus Towers like
12685 scoring better than killing, so we'd rather switch than fight.  They do
12686 something completely different as well, so sit up straight and pay
12687 attention!
12688
12689 @vindex gnus-summary-mark-below
12690 All articles have a default score (@code{gnus-summary-default-score}),
12691 which is 0 by default.  This score may be raised or lowered either
12692 interactively or by score files.  Articles that have a score lower than
12693 @code{gnus-summary-mark-below} are marked as read.
12694
12695 Gnus will read any @dfn{score files} that apply to the current group
12696 before generating the summary buffer.
12697
12698 There are several commands in the summary buffer that insert score
12699 entries based on the current article.  You can, for instance, ask Gnus to
12700 lower or increase the score of all articles with a certain subject.
12701
12702 There are two sorts of scoring entries: Permanent and temporary.
12703 Temporary score entries are self-expiring entries.  Any entries that are
12704 temporary and have not been used for, say, a week, will be removed
12705 silently to help keep the sizes of the score files down.
12706
12707 @menu
12708 * Summary Score Commands::   Adding score entries for the current group.
12709 * Group Score Commands::     General score commands.
12710 * Score Variables::          Customize your scoring.  (My, what terminology).
12711 * Score File Format::        What a score file may contain.
12712 * Score File Editing::       You can edit score files by hand as well.
12713 * Adaptive Scoring::         Big Sister Gnus knows what you read.
12714 * Home Score File::          How to say where new score entries are to go.
12715 * Followups To Yourself::    Having Gnus notice when people answer you.
12716 * Scoring Tips::             How to score effectively.
12717 * Reverse Scoring::          That problem child of old is not problem.
12718 * Global Score Files::       Earth-spanning, ear-splitting score files.
12719 * Kill Files::               They are still here, but they can be ignored.
12720 * Converting Kill Files::    Translating kill files to score files.
12721 * GroupLens::                Getting predictions on what you like to read.
12722 * Advanced Scoring::         Using logical expressions to build score rules.
12723 * Score Decays::             It can be useful to let scores wither away.
12724 @end menu
12725
12726
12727 @node Summary Score Commands
12728 @section Summary Score Commands
12729 @cindex score commands
12730
12731 The score commands that alter score entries do not actually modify real
12732 score files.  That would be too inefficient.  Gnus maintains a cache of
12733 previously loaded score files, one of which is considered the
12734 @dfn{current score file alist}.  The score commands simply insert
12735 entries into this list, and upon group exit, this list is saved.
12736
12737 The current score file is by default the group's local score file, even
12738 if no such score file actually exists.  To insert score commands into
12739 some other score file (e.g. @file{all.SCORE}), you must first make this
12740 score file the current one.
12741
12742 General score commands that don't actually change the score file:
12743
12744 @table @kbd
12745
12746 @item V s
12747 @kindex V s (Summary)
12748 @findex gnus-summary-set-score
12749 Set the score of the current article (@code{gnus-summary-set-score}).
12750
12751 @item V S
12752 @kindex V S (Summary)
12753 @findex gnus-summary-current-score
12754 Display the score of the current article
12755 (@code{gnus-summary-current-score}).
12756
12757 @item V t
12758 @kindex V t (Summary)
12759 @findex gnus-score-find-trace
12760 Display all score rules that have been used on the current article
12761 (@code{gnus-score-find-trace}).
12762
12763 @item V R
12764 @kindex V R (Summary)
12765 @findex gnus-summary-rescore
12766 Run the current summary through the scoring process
12767 (@code{gnus-summary-rescore}).  This might be useful if you're playing
12768 around with your score files behind Gnus' back and want to see the
12769 effect you're having.
12770
12771 @item V c
12772 @kindex V c (Summary)
12773 @findex gnus-score-change-score-file
12774 Make a different score file the current
12775 (@code{gnus-score-change-score-file}).
12776
12777 @item V e
12778 @kindex V e (Summary)
12779 @findex gnus-score-edit-current-scores
12780 Edit the current score file (@code{gnus-score-edit-current-scores}).
12781 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
12782 File Editing}).
12783
12784 @item V f
12785 @kindex V f (Summary)
12786 @findex gnus-score-edit-file
12787 Edit a score file and make this score file the current one
12788 (@code{gnus-score-edit-file}).
12789
12790 @item V F
12791 @kindex V F (Summary)
12792 @findex gnus-score-flush-cache
12793 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
12794 after editing score files.
12795
12796 @item V C
12797 @kindex V C (Summary)
12798 @findex gnus-score-customize
12799 Customize a score file in a visually pleasing manner
12800 (@code{gnus-score-customize}).
12801
12802 @end table
12803
12804 The rest of these commands modify the local score file.
12805
12806 @table @kbd
12807
12808 @item V m
12809 @kindex V m (Summary)
12810 @findex gnus-score-set-mark-below
12811 Prompt for a score, and mark all articles with a score below this as
12812 read (@code{gnus-score-set-mark-below}).
12813
12814 @item V x
12815 @kindex V x (Summary)
12816 @findex gnus-score-set-expunge-below
12817 Prompt for a score, and add a score rule to the current score file to
12818 expunge all articles below this score
12819 (@code{gnus-score-set-expunge-below}).
12820 @end table
12821
12822 The keystrokes for actually making score entries follow a very regular
12823 pattern, so there's no need to list all the commands.  (Hundreds of
12824 them.)
12825
12826 @findex gnus-summary-increase-score
12827 @findex gnus-summary-lower-score
12828
12829 @enumerate
12830 @item
12831 The first key is either @kbd{I} (upper case i) for increasing the score
12832 or @kbd{L} for lowering the score.
12833 @item
12834 The second key says what header you want to score on.  The following
12835 keys are available:
12836 @table @kbd
12837
12838 @item a
12839 Score on the author name.
12840
12841 @item s
12842 Score on the subject line.
12843
12844 @item x
12845 Score on the @code{Xref} line---i.e., the cross-posting line.
12846
12847 @item r
12848 Score on the @code{References} line.
12849
12850 @item d
12851 Score on the date.
12852
12853 @item l
12854 Score on the number of lines.
12855
12856 @item i
12857 Score on the @code{Message-ID} header.
12858
12859 @item f
12860 Score on followups---this matches the author name, and adds scores to
12861 the followups to this author.
12862
12863 @item b
12864 Score on the body.
12865
12866 @item h
12867 Score on the head.
12868
12869 @item t
12870 Score on thread.
12871
12872 @end table
12873
12874 @item
12875 The third key is the match type.  Which match types are valid depends on
12876 what headers you are scoring on.
12877
12878 @table @code
12879
12880 @item strings
12881
12882 @table @kbd
12883
12884 @item e
12885 Exact matching.
12886
12887 @item s
12888 Substring matching.
12889
12890 @item f
12891 Fuzzy matching (@pxref{Fuzzy Matching}).
12892
12893 @item r
12894 Regexp matching
12895 @end table
12896
12897 @item date
12898 @table @kbd
12899
12900 @item b
12901 Before date.
12902
12903 @item a
12904 After date.
12905
12906 @item n
12907 This date.
12908 @end table
12909
12910 @item number
12911 @table @kbd
12912
12913 @item <
12914 Less than number.
12915
12916 @item =
12917 Equal to number.
12918
12919 @item >
12920 Greater than number.
12921 @end table
12922 @end table
12923
12924 @item
12925 The fourth and final key says whether this is a temporary (i.e., expiring)
12926 score entry, or a permanent (i.e., non-expiring) score entry, or whether
12927 it is to be done immediately, without adding to the score file.
12928 @table @kbd
12929
12930 @item t
12931 Temporary score entry.
12932
12933 @item p
12934 Permanent score entry.
12935
12936 @item i
12937 Immediately scoring.
12938 @end table
12939
12940 @end enumerate
12941
12942 So, let's say you want to increase the score on the current author with
12943 exact matching permanently: @kbd{I a e p}.  If you want to lower the
12944 score based on the subject line, using substring matching, and make a
12945 temporary score entry: @kbd{L s s t}.  Pretty easy.
12946
12947 To make things a bit more complicated, there are shortcuts.  If you use
12948 a capital letter on either the second or third keys, Gnus will use
12949 defaults for the remaining one or two keystrokes.  The defaults are
12950 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
12951 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
12952
12953 These functions take both the numerical prefix and the symbolic prefix
12954 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
12955 (or increase) the score of the article.  A symbolic prefix of @code{a}
12956 says to use the @file{all.SCORE} file for the command instead of the
12957 current score file.
12958
12959 @vindex gnus-score-mimic-keymap
12960 The @code{gnus-score-mimic-keymap} says whether these commands will
12961 pretend they are keymaps or not.
12962
12963
12964 @node Group Score Commands
12965 @section Group Score Commands
12966 @cindex group score commands
12967
12968 There aren't many of these as yet, I'm afraid.
12969
12970 @table @kbd
12971
12972 @item W f
12973 @kindex W f (Group)
12974 @findex gnus-score-flush-cache
12975 Gnus maintains a cache of score alists to avoid having to reload them
12976 all the time.  This command will flush the cache
12977 (@code{gnus-score-flush-cache}).
12978
12979 @end table
12980
12981 You can do scoring from the command line by saying something like:
12982
12983 @findex gnus-batch-score
12984 @cindex batch scoring
12985 @example
12986 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
12987 @end example
12988
12989
12990 @node Score Variables
12991 @section Score Variables
12992 @cindex score variables
12993
12994 @table @code
12995
12996 @item gnus-use-scoring
12997 @vindex gnus-use-scoring
12998 If @code{nil}, Gnus will not check for score files, and will not, in
12999 general, do any score-related work.  This is @code{t} by default.
13000
13001 @item gnus-kill-killed
13002 @vindex gnus-kill-killed
13003 If this variable is @code{nil}, Gnus will never apply score files to
13004 articles that have already been through the kill process.  While this
13005 may save you lots of time, it also means that if you apply a kill file
13006 to a group, and then change the kill file and want to run it over you
13007 group again to kill more articles, it won't work.  You have to set this
13008 variable to @code{t} to do that.  (It is @code{t} by default.)
13009
13010 @item gnus-kill-files-directory
13011 @vindex gnus-kill-files-directory
13012 All kill and score files will be stored in this directory, which is
13013 initialized from the @code{SAVEDIR} environment variable by default.
13014 This is @file{~/News/} by default.
13015
13016 @item gnus-score-file-suffix
13017 @vindex gnus-score-file-suffix
13018 Suffix to add to the group name to arrive at the score file name
13019 (@samp{SCORE} by default.)
13020
13021 @item gnus-score-uncacheable-files
13022 @vindex gnus-score-uncacheable-files
13023 @cindex score cache
13024 All score files are normally cached to avoid excessive re-loading of
13025 score files.  However, if this might make you Emacs grow big and
13026 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
13027 @file{all.SCORE}, while it might be a good idea to not cache
13028 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
13029 variable is @samp{ADAPT$} by default, so no adaptive score files will
13030 be cached.
13031
13032 @item gnus-save-score
13033 @vindex gnus-save-score
13034 If you have really complicated score files, and do lots of batch
13035 scoring, then you might set this variable to @code{t}.  This will make
13036 Gnus save the scores into the @file{.newsrc.eld} file.
13037
13038 @item gnus-score-interactive-default-score
13039 @vindex gnus-score-interactive-default-score
13040 Score used by all the interactive raise/lower commands to raise/lower
13041 score with.  Default is 1000, which may seem excessive, but this is to
13042 ensure that the adaptive scoring scheme gets enough room to play with.
13043 We don't want the small changes from the adaptive scoring to overwrite
13044 manually entered data.
13045
13046 @item gnus-summary-default-score
13047 @vindex gnus-summary-default-score
13048 Default score of an article, which is 0 by default.
13049
13050 @item gnus-summary-expunge-below
13051 @vindex gnus-summary-expunge-below
13052 Don't display the summary lines of articles that have scores lower than
13053 this variable.  This is @code{nil} by default, which means that no
13054 articles will be hidden.  This variable is local to the summary buffers,
13055 and has to be set from @code{gnus-summary-mode-hook}.
13056
13057 @item gnus-score-over-mark
13058 @vindex gnus-score-over-mark
13059 Mark (in the third column) used for articles with a score over the
13060 default.  Default is @samp{+}.
13061
13062 @item gnus-score-below-mark
13063 @vindex gnus-score-below-mark
13064 Mark (in the third column) used for articles with a score below the
13065 default.  Default is @samp{-}.
13066
13067 @item gnus-score-find-score-files-function
13068 @vindex gnus-score-find-score-files-function
13069 Function used to find score files for the current group.  This function
13070 is called with the name of the group as the argument.
13071
13072 Predefined functions available are:
13073 @table @code
13074
13075 @item gnus-score-find-single
13076 @findex gnus-score-find-single
13077 Only apply the group's own score file.
13078
13079 @item gnus-score-find-bnews
13080 @findex gnus-score-find-bnews
13081 Apply all score files that match, using bnews syntax.  This is the
13082 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
13083 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
13084 @file{gnu.all.SCORE} would all apply.  In short, the instances of
13085 @samp{all} in the score file names are translated into @samp{.*}, and
13086 then a regexp match is done.
13087
13088 This means that if you have some score entries that you want to apply to
13089 all groups, then you put those entries in the @file{all.SCORE} file.
13090
13091 The score files are applied in a semi-random order, although Gnus will
13092 try to apply the more general score files before the more specific score
13093 files.  It does this by looking at the number of elements in the score
13094 file names---discarding the @samp{all} elements.
13095
13096 @item gnus-score-find-hierarchical
13097 @findex gnus-score-find-hierarchical
13098 Apply all score files from all the parent groups.  This means that you
13099 can't have score files like @file{all.SCORE}, but you can have
13100 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
13101
13102 @end table
13103 This variable can also be a list of functions.  In that case, all these
13104 functions will be called, and all the returned lists of score files will
13105 be applied.  These functions can also return lists of score alists
13106 directly.  In that case, the functions that return these non-file score
13107 alists should probably be placed before the ``real'' score file
13108 functions, to ensure that the last score file returned is the local
13109 score file.  Phu.
13110
13111 @item gnus-score-expiry-days
13112 @vindex gnus-score-expiry-days
13113 This variable says how many days should pass before an unused score file
13114 entry is expired.  If this variable is @code{nil}, no score file entries
13115 are expired.  It's 7 by default.
13116
13117 @item gnus-update-score-entry-dates
13118 @vindex gnus-update-score-entry-dates
13119 If this variable is non-@code{nil}, matching score entries will have
13120 their dates updated.  (This is how Gnus controls expiry---all
13121 non-matching entries will become too old while matching entries will
13122 stay fresh and young.)  However, if you set this variable to @code{nil},
13123 even matching entries will grow old and will have to face that oh-so
13124 grim reaper.
13125
13126 @item gnus-score-after-write-file-function
13127 @vindex gnus-score-after-write-file-function
13128 Function called with the name of the score file just written.
13129
13130 @item gnus-score-thread-simplify
13131 @vindex gnus-score-thread-simplify
13132 If this variable is non-@code{nil}, article subjects will be simplified
13133 for subject scoring purposes in the same manner as with
13134 threading---according to the current value of
13135 gnus-simplify-subject-functions.  If the scoring entry uses
13136 @code{substring} or @code{exact} matching, the match will also be
13137 simplified in this manner.
13138
13139 @end table
13140
13141
13142 @node Score File Format
13143 @section Score File Format
13144 @cindex score file format
13145
13146 A score file is an @code{emacs-lisp} file that normally contains just a
13147 single form.  Casual users are not expected to edit these files;
13148 everything can be changed from the summary buffer.
13149
13150 Anyway, if you'd like to dig into it yourself, here's an example:
13151
13152 @lisp
13153 (("from"
13154   ("Lars Ingebrigtsen" -10000)
13155   ("Per Abrahamsen")
13156   ("larsi\\|lmi" -50000 nil R))
13157  ("subject"
13158   ("Ding is Badd" nil 728373))
13159  ("xref"
13160   ("alt.politics" -1000 728372 s))
13161  ("lines"
13162   (2 -100 nil <))
13163  (mark 0)
13164  (expunge -1000)
13165  (mark-and-expunge -10)
13166  (read-only nil)
13167  (orphan -10)
13168  (adapt t)
13169  (files "/hom/larsi/News/gnu.SCORE")
13170  (exclude-files "all.SCORE")
13171  (local (gnus-newsgroup-auto-expire t)
13172         (gnus-summary-make-false-root empty))
13173  (eval (ding)))
13174 @end lisp
13175
13176 This example demonstrates most score file elements.  For a different
13177 approach, see @pxref{Advanced Scoring}.
13178
13179 Even though this looks much like lisp code, nothing here is actually
13180 @code{eval}ed.  The lisp reader is used to read this form, though, so it
13181 has to be valid syntactically, if not semantically.
13182
13183 Six keys are supported by this alist:
13184
13185 @table @code
13186
13187 @item STRING
13188 If the key is a string, it is the name of the header to perform the
13189 match on.  Scoring can only be performed on these eight headers:
13190 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13191 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
13192 these headers, there are three strings to tell Gnus to fetch the entire
13193 article and do the match on larger parts of the article: @code{Body}
13194 will perform the match on the body of the article, @code{Head} will
13195 perform the match on the head of the article, and @code{All} will
13196 perform the match on the entire article.  Note that using any of these
13197 last three keys will slow down group entry @emph{considerably}.  The
13198 final ``header'' you can score on is @code{Followup}.  These score
13199 entries will result in new score entries being added for all follow-ups
13200 to articles that matches these score entries.
13201
13202 Following this key is a arbitrary number of score entries, where each
13203 score entry has one to four elements.
13204 @enumerate
13205
13206 @item
13207 The first element is the @dfn{match element}.  On most headers this will
13208 be a string, but on the Lines and Chars headers, this must be an
13209 integer.
13210
13211 @item
13212 If the second element is present, it should be a number---the @dfn{score
13213 element}.  This number should be an integer in the neginf to posinf
13214 interval.  This number is added to the score of the article if the match
13215 is successful.  If this element is not present, the
13216 @code{gnus-score-interactive-default-score} number will be used
13217 instead.  This is 1000 by default.
13218
13219 @item
13220 If the third element is present, it should be a number---the @dfn{date
13221 element}.  This date says when the last time this score entry matched,
13222 which provides a mechanism for expiring the score entries.  It this
13223 element is not present, the score entry is permanent.  The date is
13224 represented by the number of days since December 31, 1 BCE.
13225
13226 @item
13227 If the fourth element is present, it should be a symbol---the @dfn{type
13228 element}.  This element specifies what function should be used to see
13229 whether this score entry matches the article.  What match types that can
13230 be used depends on what header you wish to perform the match on.
13231 @table @dfn
13232
13233 @item From, Subject, References, Xref, Message-ID
13234 For most header types, there are the @code{r} and @code{R} (regexp), as
13235 well as @code{s} and @code{S} (substring) types, and @code{e} and
13236 @code{E} (exact match), and @code{w} (word match) types.  If this
13237 element is not present, Gnus will assume that substring matching should
13238 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
13239 that the matches will be done in a case-sensitive manner.  All these
13240 one-letter types are really just abbreviations for the @code{regexp},
13241 @code{string}, @code{exact}, and @code{word} types, which you can use
13242 instead, if you feel like.
13243
13244 @item Lines, Chars
13245 These two headers use different match types: @code{<}, @code{>},
13246 @code{=}, @code{>=} and @code{<=}.
13247
13248 These predicates are true if
13249
13250 @example
13251 (PREDICATE HEADER MATCH)
13252 @end example
13253
13254 evaluates to non-@code{nil}.  For instance, the advanced match
13255 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13256 following form:
13257
13258 @lisp
13259 (< header-value 4)
13260 @end lisp
13261
13262 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13263 the match, we get the score added if the article has less than 4 lines.
13264 (It's easy to get confused and think it's the other way around.  But
13265 it's not.  I think.)
13266
13267 When matching on @code{Lines}, be careful because some backends (like
13268 @code{nndir}) do not generate @code{Lines} header, so every article ends
13269 up being marked as having 0 lines.  This can lead to strange results if
13270 you happen to lower score of the articles with few lines.
13271
13272 @item Date
13273 For the Date header we have three kinda silly match types:
13274 @code{before}, @code{at} and @code{after}.  I can't really imagine this
13275 ever being useful, but, like, it would feel kinda silly not to provide
13276 this function.  Just in case.  You never know.  Better safe than sorry.
13277 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
13278 sex on a first date.  (I have been told that at least one person, and I
13279 quote, ``found this function indispensable'', however.)
13280
13281 @cindex ISO8601
13282 @cindex date
13283 A more useful match type is @code{regexp}.  With it, you can match the
13284 date string using a regular expression.  The date is normalized to
13285 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
13286 you want to match all articles that have been posted on April 1st in
13287 every year, you could use @samp{....0401.........} as a match string,
13288 for instance.  (Note that the date is kept in its original time zone, so
13289 this will match articles that were posted when it was April 1st where
13290 the article was posted from.  Time zones are such wholesome fun for the
13291 whole family, eh?)
13292
13293 @item Head, Body, All
13294 These three match keys use the same match types as the @code{From} (etc)
13295 header uses.
13296
13297 @item Followup
13298 This match key is somewhat special, in that it will match the
13299 @code{From} header, and affect the score of not only the matching
13300 articles, but also all followups to the matching articles.  This allows
13301 you e.g. increase the score of followups to your own articles, or
13302 decrease the score of followups to the articles of some known
13303 trouble-maker.  Uses the same match types as the @code{From} header
13304 uses.  (Using this match key will lead to creation of @file{ADAPT}
13305 files.)
13306
13307 @item Thread
13308 This match key works along the same lines as the @code{Followup} match
13309 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
13310 @samp{thread} match.  This will add a new @samp{thread} match for each
13311 article that has @var{X} in its @code{References} header.  (These new
13312 @samp{thread} matches will use the @code{Message-ID}s of these matching
13313 articles.)  This will ensure that you can raise/lower the score of an
13314 entire thread, even though some articles in the thread may not have
13315 complete @code{References} headers.  Note that using this may lead to
13316 undeterministic scores of the articles in the thread.  (Using this match
13317 key will lead to creation of @file{ADAPT} files.)
13318 @end table
13319 @end enumerate
13320
13321 @cindex Score File Atoms
13322 @item mark
13323 The value of this entry should be a number.  Any articles with a score
13324 lower than this number will be marked as read.
13325
13326 @item expunge
13327 The value of this entry should be a number.  Any articles with a score
13328 lower than this number will be removed from the summary buffer.
13329
13330 @item mark-and-expunge
13331 The value of this entry should be a number.  Any articles with a score
13332 lower than this number will be marked as read and removed from the
13333 summary buffer.
13334
13335 @item thread-mark-and-expunge
13336 The value of this entry should be a number.  All articles that belong to
13337 a thread that has a total score below this number will be marked as read
13338 and removed from the summary buffer.  @code{gnus-thread-score-function}
13339 says how to compute the total score for a thread.
13340
13341 @item files
13342 The value of this entry should be any number of file names.  These files
13343 are assumed to be score files as well, and will be loaded the same way
13344 this one was.
13345
13346 @item exclude-files
13347 The clue of this entry should be any number of files.  These files will
13348 not be loaded, even though they would normally be so, for some reason or
13349 other.
13350
13351 @item eval
13352 The value of this entry will be @code{eval}el.  This element will be
13353 ignored when handling global score files.
13354
13355 @item read-only
13356 Read-only score files will not be updated or saved.  Global score files
13357 should feature this atom (@pxref{Global Score Files}).  (Note:
13358 @dfn{Global} here really means @dfn{global}; not your personal
13359 apply-to-all-groups score files.)
13360
13361 @item orphan
13362 The value of this entry should be a number.  Articles that do not have
13363 parents will get this number added to their scores.  Imagine you follow
13364 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
13365 will only follow a few of the threads, also want to see any new threads.
13366
13367 You can do this with the following two score file entries:
13368
13369 @example
13370         (orphan -500)
13371         (mark-and-expunge -100)
13372 @end example
13373
13374 When you enter the group the first time, you will only see the new
13375 threads.  You then raise the score of the threads that you find
13376 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13377 rest.  Next time you enter the group, you will see new articles in the
13378 interesting threads, plus any new threads.
13379
13380 I.e.---the orphan score atom is for high-volume groups where there
13381 exist a few interesting threads which can't be found automatically by
13382 ordinary scoring rules.
13383
13384 @item adapt
13385 This entry controls the adaptive scoring.  If it is @code{t}, the
13386 default adaptive scoring rules will be used.  If it is @code{ignore}, no
13387 adaptive scoring will be performed on this group.  If it is a list, this
13388 list will be used as the adaptive scoring rules.  If it isn't present,
13389 or is something other than @code{t} or @code{ignore}, the default
13390 adaptive scoring rules will be used.  If you want to use adaptive
13391 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13392 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13393 not want adaptive scoring.  If you only want adaptive scoring in a few
13394 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13395 insert @code{(adapt t)} in the score files of the groups where you want
13396 it.
13397
13398 @item adapt-file
13399 All adaptive score entries will go to the file named by this entry.  It
13400 will also be applied when entering the group.  This atom might be handy
13401 if you want to adapt on several groups at once, using the same adaptive
13402 file for a number of groups.
13403
13404 @item local
13405 @cindex local variables
13406 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13407 Each @var{var} will be made buffer-local to the current summary buffer,
13408 and set to the value specified.  This is a convenient, if somewhat
13409 strange, way of setting variables in some groups if you don't like hooks
13410 much.  Note that the @var{value} won't be evaluated.
13411 @end table
13412
13413
13414 @node Score File Editing
13415 @section Score File Editing
13416
13417 You normally enter all scoring commands from the summary buffer, but you
13418 might feel the urge to edit them by hand as well, so we've supplied you
13419 with a mode for that.
13420
13421 It's simply a slightly customized @code{emacs-lisp} mode, with these
13422 additional commands:
13423
13424 @table @kbd
13425
13426 @item C-c C-c
13427 @kindex C-c C-c (Score)
13428 @findex gnus-score-edit-done
13429 Save the changes you have made and return to the summary buffer
13430 (@code{gnus-score-edit-done}).
13431
13432 @item C-c C-d
13433 @kindex C-c C-d (Score)
13434 @findex gnus-score-edit-insert-date
13435 Insert the current date in numerical format
13436 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
13437 you were wondering.
13438
13439 @item C-c C-p
13440 @kindex C-c C-p (Score)
13441 @findex gnus-score-pretty-print
13442 The adaptive score files are saved in an unformatted fashion.  If you
13443 intend to read one of these files, you want to @dfn{pretty print} it
13444 first.  This command (@code{gnus-score-pretty-print}) does that for
13445 you.
13446
13447 @end table
13448
13449 Type @kbd{M-x gnus-score-mode} to use this mode.
13450
13451 @vindex gnus-score-mode-hook
13452 @code{gnus-score-menu-hook} is run in score mode buffers.
13453
13454 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13455 e} to begin editing score files.
13456
13457
13458 @node Adaptive Scoring
13459 @section Adaptive Scoring
13460 @cindex adaptive scoring
13461
13462 If all this scoring is getting you down, Gnus has a way of making it all
13463 happen automatically---as if by magic.  Or rather, as if by artificial
13464 stupidity, to be precise.
13465
13466 @vindex gnus-use-adaptive-scoring
13467 When you read an article, or mark an article as read, or kill an
13468 article, you leave marks behind.  On exit from the group, Gnus can sniff
13469 these marks and add score elements depending on what marks it finds.
13470 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13471 @code{t} or @code{(line)}.  If you want score adaptively on separate
13472 words appearing in the subjects, you should set this variable to
13473 @code{(word)}.  If you want to use both adaptive methods, set this
13474 variable to @code{(word line)}.
13475
13476 @vindex gnus-default-adaptive-score-alist
13477 To give you complete control over the scoring process, you can customize
13478 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
13479 might look something like this:
13480
13481 @lisp
13482 (defvar gnus-default-adaptive-score-alist
13483   '((gnus-unread-mark)
13484     (gnus-ticked-mark (from 4))
13485     (gnus-dormant-mark (from 5))
13486     (gnus-del-mark (from -4) (subject -1))
13487     (gnus-read-mark (from 4) (subject 2))
13488     (gnus-expirable-mark (from -1) (subject -1))
13489     (gnus-killed-mark (from -1) (subject -3))
13490     (gnus-kill-file-mark)
13491     (gnus-ancient-mark)
13492     (gnus-low-score-mark)
13493     (gnus-catchup-mark (from -1) (subject -1))))
13494 @end lisp
13495
13496 As you see, each element in this alist has a mark as a key (either a
13497 variable name or a ``real'' mark---a character).  Following this key is
13498 a arbitrary number of header/score pairs.  If there are no header/score
13499 pairs following the key, no adaptive scoring will be done on articles
13500 that have that key as the article mark.  For instance, articles with
13501 @code{gnus-unread-mark} in the example above will not get adaptive score
13502 entries.
13503
13504 Each article can have only one mark, so just a single of these rules
13505 will be applied to each article.
13506
13507 To take @code{gnus-del-mark} as an example---this alist says that all
13508 articles that have that mark (i.e., are marked with @samp{D}) will have a
13509 score entry added to lower based on the @code{From} header by -4, and
13510 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
13511
13512 If you have marked 10 articles with the same subject with
13513 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13514 That means that that subject will get a score of ten times -1, which
13515 should be, unless I'm much mistaken, -10.
13516
13517 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13518 the read articles will be marked with the @samp{E} mark.  This'll
13519 probably make adaptive scoring slightly impossible, so auto-expiring and
13520 adaptive scoring doesn't really mix very well.
13521
13522 The headers you can score on are @code{from}, @code{subject},
13523 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13524 @code{chars} and @code{date}.  In addition, you can score on
13525 @code{followup}, which will create an adaptive score entry that matches
13526 on the @code{References} header using the @code{Message-ID} of the
13527 current article, thereby matching the following thread.
13528
13529 You can also score on @code{thread}, which will try to score all
13530 articles that appear in a thread.  @code{thread} matches uses a
13531 @code{Message-ID} to match on the @code{References} header of the
13532 article.  If the match is made, the @code{Message-ID} of the article is
13533 added to the @code{thread} rule.  (Think about it.  I'd recommend two
13534 aspirins afterwards.)
13535
13536 If you use this scheme, you should set the score file atom @code{mark}
13537 to something small---like -300, perhaps, to avoid having small random
13538 changes result in articles getting marked as read.
13539
13540 After using adaptive scoring for a week or so, Gnus should start to
13541 become properly trained and enhance the authors you like best, and kill
13542 the authors you like least, without you having to say so explicitly.
13543
13544 You can control what groups the adaptive scoring is to be performed on
13545 by using the score files (@pxref{Score File Format}).  This will also
13546 let you use different rules in different groups.
13547
13548 @vindex gnus-adaptive-file-suffix
13549 The adaptive score entries will be put into a file where the name is the
13550 group name with @code{gnus-adaptive-file-suffix} appended.  The default
13551 is @samp{ADAPT}.
13552
13553 @vindex gnus-score-exact-adapt-limit
13554 When doing adaptive scoring, substring or fuzzy matching would probably
13555 give you the best results in most cases.  However, if the header one
13556 matches is short, the possibility for false positives is great, so if
13557 the length of the match is less than
13558 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
13559 this variable is @code{nil}, exact matching will always be used to avoid
13560 this problem.
13561
13562 @vindex gnus-default-adaptive-word-score-alist
13563 As mentioned above, you can adapt either on individual words or entire
13564 headers.  If you adapt on words, the
13565 @code{gnus-default-adaptive-word-score-alist} variable says what score
13566 each instance of a word should add given a mark.
13567
13568 @lisp
13569 (setq gnus-default-adaptive-word-score-alist
13570       `((,gnus-read-mark . 30)
13571         (,gnus-catchup-mark . -10)
13572         (,gnus-killed-mark . -20)
13573         (,gnus-del-mark . -15)))
13574 @end lisp
13575
13576 This is the default value.  If you have adaption on words enabled, every
13577 word that appears in subjects of articles marked with
13578 @code{gnus-read-mark} will result in a score rule that increase the
13579 score with 30 points.
13580
13581 @vindex gnus-default-ignored-adaptive-words
13582 @vindex gnus-ignored-adaptive-words
13583 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13584 will be ignored.  If you wish to add more words to be ignored, use the
13585 @code{gnus-ignored-adaptive-words} list instead.
13586
13587 @vindex gnus-adaptive-word-syntax-table
13588 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13589 syntax table in effect.  It is similar to the standard syntax table, but
13590 it considers numbers to be non-word-constituent characters.
13591
13592 @vindex gnus-adaptive-word-minimum
13593 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13594 word scoring process will never bring down the score of an article to
13595 below this number.  The default is @code{nil}.
13596
13597 @vindex gnus-adaptive-word-no-group-words
13598 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13599 won't adaptively word score any of the words in the group name.  Useful
13600 for groups like @samp{comp.editors.emacs}, where most of the subject
13601 lines contain the word @samp{emacs}.
13602
13603 After using this scheme for a while, it might be nice to write a
13604 @code{gnus-psychoanalyze-user} command to go through the rules and see
13605 what words you like and what words you don't like.  Or perhaps not.
13606
13607 Note that the adaptive word scoring thing is highly experimental and is
13608 likely to change in the future.  Initial impressions seem to indicate
13609 that it's totally useless as it stands.  Some more work (involving more
13610 rigorous statistical methods) will have to be done to make this useful.
13611
13612
13613 @node Home Score File
13614 @section Home Score File
13615
13616 The score file where new score file entries will go is called the
13617 @dfn{home score file}.  This is normally (and by default) the score file
13618 for the group itself.  For instance, the home score file for
13619 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13620
13621 However, this may not be what you want.  It is often convenient to share
13622 a common home score file among many groups---all @samp{emacs} groups
13623 could perhaps use the same home score file.
13624
13625 @vindex gnus-home-score-file
13626 The variable that controls this is @code{gnus-home-score-file}.  It can
13627 be:
13628
13629 @enumerate
13630 @item
13631 A string.  Then this file will be used as the home score file for all
13632 groups.
13633
13634 @item
13635 A function. The result of this function will be used as the home score
13636 file.  The function will be called with the name of the group as the
13637 parameter.
13638
13639 @item
13640 A list.  The elements in this list can be:
13641
13642 @enumerate
13643 @item
13644 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
13645 the @var{file-name} will will be used as the home score file.
13646
13647 @item
13648 A function. If the function returns non-nil, the result will be used as
13649 the home score file.
13650
13651 @item
13652 A string.  Use the string as the home score file.
13653 @end enumerate
13654
13655 The list will be traversed from the beginning towards the end looking
13656 for matches.
13657
13658 @end enumerate
13659
13660 So, if you want to use just a single score file, you could say:
13661
13662 @lisp
13663 (setq gnus-home-score-file
13664       "my-total-score-file.SCORE")
13665 @end lisp
13666
13667 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
13668 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
13669
13670 @findex gnus-hierarchial-home-score-file
13671 @lisp
13672 (setq gnus-home-score-file
13673       'gnus-hierarchial-home-score-file)
13674 @end lisp
13675
13676 This is a ready-made function provided for your convenience.
13677 Other functions include
13678
13679 @table @code
13680 @item gnus-current-home-score-file
13681 @findex gnus-current-home-score-file
13682 Return the ``current'' regular score file.  This will make scoring
13683 commands add entry to the ``innermost'' matching score file.
13684
13685 @end table
13686
13687 If you want to have one score file for the @samp{emacs} groups and
13688 another for the @samp{comp} groups, while letting all other groups use
13689 their own home score files:
13690
13691 @lisp
13692 (setq gnus-home-score-file
13693       ;; All groups that match the regexp "\\.emacs"
13694       '(("\\.emacs" "emacs.SCORE")
13695         ;; All the comp groups in one score file
13696         ("^comp" "comp.SCORE")))
13697 @end lisp
13698
13699 @vindex gnus-home-adapt-file
13700 @code{gnus-home-adapt-file} works exactly the same way as
13701 @code{gnus-home-score-file}, but says what the home adaptive score file
13702 is instead.  All new adaptive file entries will go into the file
13703 specified by this variable, and the same syntax is allowed.
13704
13705 In addition to using @code{gnus-home-score-file} and
13706 @code{gnus-home-adapt-file}, you can also use group parameters
13707 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
13708 Parameters}) to achieve much the same.  Group and topic parameters take
13709 precedence over this variable.
13710
13711
13712 @node Followups To Yourself
13713 @section Followups To Yourself
13714
13715 Gnus offers two commands for picking out the @code{Message-ID} header in
13716 the current buffer.  Gnus will then add a score rule that scores using
13717 this @code{Message-ID} on the @code{References} header of other
13718 articles.  This will, in effect, increase the score of all articles that
13719 respond to the article in the current buffer.  Quite useful if you want
13720 to easily note when people answer what you've said.
13721
13722 @table @code
13723
13724 @item gnus-score-followup-article
13725 @findex gnus-score-followup-article
13726 This will add a score to articles that directly follow up your own
13727 article.
13728
13729 @item gnus-score-followup-thread
13730 @findex gnus-score-followup-thread
13731 This will add a score to all articles that appear in a thread ``below''
13732 your own article.
13733 @end table
13734
13735 @vindex message-sent-hook
13736 These two functions are both primarily meant to be used in hooks like
13737 @code{message-sent-hook}.
13738
13739 If you look closely at your own @code{Message-ID}, you'll notice that
13740 the first two or three characters are always the same.  Here's two of
13741 mine:
13742
13743 @example
13744 <x6u3u47icf.fsf@@eyesore.no>
13745 <x6sp9o7ibw.fsf@@eyesore.no>
13746 @end example
13747
13748 So ``my'' ident on this machine is @samp{x6}.  This can be
13749 exploited---the following rule will raise the score on all followups to
13750 myself:
13751
13752 @lisp
13753 ("references"
13754  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
13755   1000 nil r))
13756 @end lisp
13757
13758 Whether it's the first two or first three characters that are ``yours''
13759 is system-dependent.
13760
13761
13762 @node Scoring Tips
13763 @section Scoring Tips
13764 @cindex scoring tips
13765
13766 @table @dfn
13767
13768 @item Crossposts
13769 @cindex crossposts
13770 @cindex scoring crossposts
13771 If you want to lower the score of crossposts, the line to match on is
13772 the @code{Xref} header.
13773 @lisp
13774 ("xref" (" talk.politics.misc:" -1000))
13775 @end lisp
13776
13777 @item Multiple crossposts
13778 If you want to lower the score of articles that have been crossposted to
13779 more than, say, 3 groups:
13780 @lisp
13781 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
13782 @end lisp
13783
13784 @item Matching on the body
13785 This is generally not a very good idea---it takes a very long time.
13786 Gnus actually has to fetch each individual article from the server.  But
13787 you might want to anyway, I guess.  Even though there are three match
13788 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
13789 and stick with it in each score file.  If you use any two, each article
13790 will be fetched @emph{twice}.  If you want to match a bit on the
13791 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
13792 the matches.
13793
13794 @item Marking as read
13795 You will probably want to mark articles that has a score below a certain
13796 number as read.  This is most easily achieved by putting the following
13797 in your @file{all.SCORE} file:
13798 @lisp
13799 ((mark -100))
13800 @end lisp
13801 You may also consider doing something similar with @code{expunge}.
13802
13803 @item Negated character classes
13804 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
13805 That will match newlines, which might lead to, well, The Unknown.  Say
13806 @code{[^abcd\n]*} instead.
13807 @end table
13808
13809
13810 @node Reverse Scoring
13811 @section Reverse Scoring
13812 @cindex reverse scoring
13813
13814 If you want to keep just articles that have @samp{Sex with Emacs} in the
13815 subject header, and expunge all other articles, you could put something
13816 like this in your score file:
13817
13818 @lisp
13819 (("subject"
13820   ("Sex with Emacs" 2))
13821  (mark 1)
13822  (expunge 1))
13823 @end lisp
13824
13825 So, you raise all articles that match @samp{Sex with Emacs} and mark the
13826 rest as read, and expunge them to boot.
13827
13828
13829 @node Global Score Files
13830 @section Global Score Files
13831 @cindex global score files
13832
13833 Sure, other newsreaders have ``global kill files''.  These are usually
13834 nothing more than a single kill file that applies to all groups, stored
13835 in the user's home directory.  Bah!  Puny, weak newsreaders!
13836
13837 What I'm talking about here are Global Score Files.  Score files from
13838 all over the world, from users everywhere, uniting all nations in one
13839 big, happy score file union!  Ange-score!  New and untested!
13840
13841 @vindex gnus-global-score-files
13842 All you have to do to use other people's score files is to set the
13843 @code{gnus-global-score-files} variable.  One entry for each score file,
13844 or each score file directory.  Gnus will decide by itself what score
13845 files are applicable to which group.
13846
13847 Say you want to use the score file
13848 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
13849 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
13850
13851 @lisp
13852 (setq gnus-global-score-files
13853       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
13854         "/ftp@@ftp.some-where:/pub/score/"))
13855 @end lisp
13856
13857 @findex gnus-score-search-global-directories
13858 Simple, eh?  Directory names must end with a @samp{/}.  These
13859 directories are typically scanned only once during each Gnus session.
13860 If you feel the need to manually re-scan the remote directories, you can
13861 use the @code{gnus-score-search-global-directories} command.
13862
13863 Note that, at present, using this option will slow down group entry
13864 somewhat.  (That is---a lot.)
13865
13866 If you want to start maintaining score files for other people to use,
13867 just put your score file up for anonymous ftp and announce it to the
13868 world.  Become a retro-moderator!  Participate in the retro-moderator
13869 wars sure to ensue, where retro-moderators battle it out for the
13870 sympathy of the people, luring them to use their score files on false
13871 premises!  Yay!  The net is saved!
13872
13873 Here are some tips for the would-be retro-moderator, off the top of my
13874 head:
13875
13876 @itemize @bullet
13877
13878 @item
13879 Articles heavily crossposted are probably junk.
13880 @item
13881 To lower a single inappropriate article, lower by @code{Message-ID}.
13882 @item
13883 Particularly brilliant authors can be raised on a permanent basis.
13884 @item
13885 Authors that repeatedly post off-charter for the group can safely be
13886 lowered out of existence.
13887 @item
13888 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
13889 articles completely.
13890
13891 @item
13892 Use expiring score entries to keep the size of the file down.  You
13893 should probably have a long expiry period, though, as some sites keep
13894 old articles for a long time.
13895 @end itemize
13896
13897 ... I wonder whether other newsreaders will support global score files
13898 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
13899 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
13900 holding our breath yet?
13901
13902
13903 @node Kill Files
13904 @section Kill Files
13905 @cindex kill files
13906
13907 Gnus still supports those pesky old kill files.  In fact, the kill file
13908 entries can now be expiring, which is something I wrote before Daniel
13909 Quinlan thought of doing score files, so I've left the code in there.
13910
13911 In short, kill processing is a lot slower (and I do mean @emph{a lot})
13912 than score processing, so it might be a good idea to rewrite your kill
13913 files into score files.
13914
13915 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
13916 forms into this file, which means that you can use kill files as some
13917 sort of primitive hook function to be run on group entry, even though
13918 that isn't a very good idea.
13919
13920 Normal kill files look like this:
13921
13922 @lisp
13923 (gnus-kill "From" "Lars Ingebrigtsen")
13924 (gnus-kill "Subject" "ding")
13925 (gnus-expunge "X")
13926 @end lisp
13927
13928 This will mark every article written by me as read, and remove the
13929 marked articles from the summary buffer.  Very useful, you'll agree.
13930
13931 Other programs use a totally different kill file syntax.  If Gnus
13932 encounters what looks like a @code{rn} kill file, it will take a stab at
13933 interpreting it.
13934
13935 Two summary functions for editing a GNUS kill file:
13936
13937 @table @kbd
13938
13939 @item M-k
13940 @kindex M-k (Summary)
13941 @findex gnus-summary-edit-local-kill
13942 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
13943
13944 @item M-K
13945 @kindex M-K (Summary)
13946 @findex gnus-summary-edit-global-kill
13947 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
13948 @end table
13949
13950 Two group mode functions for editing the kill files:
13951
13952 @table @kbd
13953
13954 @item M-k
13955 @kindex M-k (Group)
13956 @findex gnus-group-edit-local-kill
13957 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
13958
13959 @item M-K
13960 @kindex M-K (Group)
13961 @findex gnus-group-edit-global-kill
13962 Edit the general kill file (@code{gnus-group-edit-global-kill}).
13963 @end table
13964
13965 Kill file variables:
13966
13967 @table @code
13968 @item gnus-kill-file-name
13969 @vindex gnus-kill-file-name
13970 A kill file for the group @samp{soc.motss} is normally called
13971 @file{soc.motss.KILL}.  The suffix appended to the group name to get
13972 this file name is detailed by the @code{gnus-kill-file-name} variable.
13973 The ``global'' kill file (not in the score file sense of ``global'', of
13974 course) is just called @file{KILL}.
13975
13976 @vindex gnus-kill-save-kill-file
13977 @item gnus-kill-save-kill-file
13978 If this variable is non-@code{nil}, Gnus will save the
13979 kill file after processing, which is necessary if you use expiring
13980 kills.
13981
13982 @item gnus-apply-kill-hook
13983 @vindex gnus-apply-kill-hook
13984 @findex gnus-apply-kill-file-unless-scored
13985 @findex gnus-apply-kill-file
13986 A hook called to apply kill files to a group.  It is
13987 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
13988 kill file if you have a score file for the same group, you can set this
13989 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
13990 kill files to be processed, you should set this variable to @code{nil}.
13991
13992 @item gnus-kill-file-mode-hook
13993 @vindex gnus-kill-file-mode-hook
13994 A hook called in kill-file mode buffers.
13995
13996 @end table
13997
13998
13999 @node Converting Kill Files
14000 @section Converting Kill Files
14001 @cindex kill files
14002 @cindex converting kill files
14003
14004 If you have loads of old kill files, you may want to convert them into
14005 score files.  If they are ``regular'', you can use
14006 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
14007 by hand.
14008
14009 The kill to score conversion package isn't included in Gnus by default.
14010 You can fetch it from
14011 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
14012
14013 If your old kill files are very complex---if they contain more
14014 non-@code{gnus-kill} forms than not, you'll have to convert them by
14015 hand.  Or just let them be as they are.  Gnus will still use them as
14016 before.
14017
14018
14019 @node GroupLens
14020 @section GroupLens
14021 @cindex GroupLens
14022
14023 GroupLens is a collaborative filtering system that helps you work
14024 together with other people to find the quality news articles out of the
14025 huge volume of news articles generated every day.
14026
14027 To accomplish this the GroupLens system combines your opinions about
14028 articles you have already read with the opinions of others who have done
14029 likewise and gives you a personalized prediction for each unread news
14030 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
14031 rate articles, and finds other people that rate articles the same way.
14032 Once it has found some people you agree with it tells you, in the form
14033 of a prediction, what they thought of the article.  You can use this
14034 prediction to help you decide whether or not you want to read the
14035 article.
14036
14037 @menu
14038 * Using GroupLens::          How to make Gnus use GroupLens.
14039 * Rating Articles::          Letting GroupLens know how you rate articles.
14040 * Displaying Predictions::   Displaying predictions given by GroupLens.
14041 * GroupLens Variables::      Customizing GroupLens.
14042 @end menu
14043
14044
14045 @node Using GroupLens
14046 @subsection Using GroupLens
14047
14048 To use GroupLens you must register a pseudonym with your local Better
14049 Bit Bureau (BBB).
14050 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
14051 better bit in town at the moment.
14052
14053 Once you have registered you'll need to set a couple of variables.
14054
14055 @table @code
14056
14057 @item gnus-use-grouplens
14058 @vindex gnus-use-grouplens
14059 Setting this variable to a non-@code{nil} value will make Gnus hook into
14060 all the relevant GroupLens functions.
14061
14062 @item grouplens-pseudonym
14063 @vindex grouplens-pseudonym
14064 This variable should be set to the pseudonym you got when registering
14065 with the Better Bit Bureau.
14066
14067 @item grouplens-newsgroups
14068 @vindex grouplens-newsgroups
14069 A list of groups that you want to get GroupLens predictions for.
14070
14071 @end table
14072
14073 That's the minimum of what you need to get up and running with GroupLens.
14074 Once you've registered, GroupLens will start giving you scores for
14075 articles based on the average of what other people think.  But, to get
14076 the real benefit of GroupLens you need to start rating articles
14077 yourself.  Then the scores GroupLens gives you will be personalized for
14078 you, based on how the people you usually agree with have already rated.
14079
14080
14081 @node Rating Articles
14082 @subsection Rating Articles
14083
14084 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
14085 Where 1 means something like this article is a waste of bandwidth and 5
14086 means that the article was really good.  The basic question to ask
14087 yourself is, "on a scale from 1 to 5 would I like to see more articles
14088 like this one?"
14089
14090 There are four ways to enter a rating for an article in GroupLens.
14091
14092 @table @kbd
14093
14094 @item r
14095 @kindex r (GroupLens)
14096 @findex bbb-summary-rate-article
14097 This function will prompt you for a rating on a scale of one to five.
14098
14099 @item k
14100 @kindex k (GroupLens)
14101 @findex grouplens-score-thread
14102 This function will prompt you for a rating, and rate all the articles in
14103 the thread.  This is really useful for some of those long running giant
14104 threads in rec.humor.
14105
14106 @end table
14107
14108 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
14109 the score of the article you're reading.
14110
14111 @table @kbd
14112
14113 @item 1-5 n
14114 @kindex n (GroupLens)
14115 @findex grouplens-next-unread-article
14116 Rate the article and go to the next unread article.
14117
14118 @item 1-5 ,
14119 @kindex , (GroupLens)
14120 @findex grouplens-best-unread-article
14121 Rate the article and go to the next unread article with the highest score.
14122
14123 @end table
14124
14125 If you want to give the current article a score of 4 and then go to the
14126 next article, just type @kbd{4 n}.
14127
14128
14129 @node Displaying Predictions
14130 @subsection Displaying Predictions
14131
14132 GroupLens makes a prediction for you about how much you will like a
14133 news article.  The predictions from GroupLens are on a scale from 1 to
14134 5, where 1 is the worst and 5 is the best.  You can use the predictions
14135 from GroupLens in one of three ways controlled by the variable
14136 @code{gnus-grouplens-override-scoring}.
14137
14138 @vindex gnus-grouplens-override-scoring
14139 There are three ways to display predictions in grouplens.  You may
14140 choose to have the GroupLens scores contribute to, or override the
14141 regular gnus scoring mechanism. override is the default; however, some
14142 people prefer to see the Gnus scores plus the grouplens scores.  To get
14143 the separate scoring behavior you need to set
14144 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
14145 GroupLens predictions combined with the grouplens scores set it to
14146 @code{'override} and to combine the scores set
14147 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
14148 the combine option you will also want to set the values for
14149 @code{grouplens-prediction-offset} and
14150 @code{grouplens-score-scale-factor}.
14151
14152 @vindex grouplens-prediction-display
14153 In either case, GroupLens gives you a few choices for how you would like
14154 to see your predictions displayed.  The display of predictions is
14155 controlled by the @code{grouplens-prediction-display} variable.
14156
14157 The following are valid values for that variable.
14158
14159 @table @code
14160 @item prediction-spot
14161 The higher the prediction, the further to the right an @samp{*} is
14162 displayed.
14163
14164 @item confidence-interval
14165 A numeric confidence interval.
14166
14167 @item prediction-bar
14168 The higher the prediction, the longer the bar.
14169
14170 @item confidence-bar
14171 Numerical confidence.
14172
14173 @item confidence-spot
14174 The spot gets bigger with more confidence.
14175
14176 @item prediction-num
14177 Plain-old numeric value.
14178
14179 @item confidence-plus-minus
14180 Prediction +/- confidence.
14181
14182 @end table
14183
14184
14185 @node GroupLens Variables
14186 @subsection GroupLens Variables
14187
14188 @table @code
14189
14190 @item gnus-summary-grouplens-line-format
14191 The summary line format used in GroupLens-enhanced summary buffers.  It
14192 accepts the same specs as the normal summary line format (@pxref{Summary
14193 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14194 %s\n}.
14195
14196 @item grouplens-bbb-host
14197 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
14198 default.
14199
14200 @item grouplens-bbb-port
14201 Port of the host running the bbbd server.  The default is 9000.
14202
14203 @item grouplens-score-offset
14204 Offset the prediction by this value.  In other words, subtract the
14205 prediction value by this number to arrive at the effective score.  The
14206 default is 0.
14207
14208 @item grouplens-score-scale-factor
14209 This variable allows the user to magnify the effect of GroupLens scores.
14210 The scale factor is applied after the offset.  The default is 1.
14211
14212 @end table
14213
14214
14215 @node Advanced Scoring
14216 @section Advanced Scoring
14217
14218 Scoring on Subjects and From headers is nice enough, but what if you're
14219 really interested in what a person has to say only when she's talking
14220 about a particular subject?  Or what if you really don't want to
14221 read what person A has to say when she's following up to person B, but
14222 want to read what she says when she's following up to person C?
14223
14224 By using advanced scoring rules you may create arbitrarily complex
14225 scoring patterns.
14226
14227 @menu
14228 * Advanced Scoring Syntax::     A definition.
14229 * Advanced Scoring Examples::   What they look like.
14230 * Advanced Scoring Tips::       Getting the most out of it.
14231 @end menu
14232
14233
14234 @node Advanced Scoring Syntax
14235 @subsection Advanced Scoring Syntax
14236
14237 Ordinary scoring rules have a string as the first element in the rule.
14238 Advanced scoring rules have a list as the first element.  The second
14239 element is the score to be applied if the first element evaluated to a
14240 non-@code{nil} value.
14241
14242 These lists may consist of three logical operators, one redirection
14243 operator, and various match operators.
14244
14245 Logical operators:
14246
14247 @table @code
14248 @item &
14249 @itemx and
14250 This logical operator will evaluate each of its arguments until it finds
14251 one that evaluates to @code{false}, and then it'll stop.  If all arguments
14252 evaluate to @code{true} values, then this operator will return
14253 @code{true}.
14254
14255 @item |
14256 @itemx or
14257 This logical operator will evaluate each of its arguments until it finds
14258 one that evaluates to @code{true}.  If no arguments are @code{true},
14259 then this operator will return @code{false}.
14260
14261 @item !
14262 @itemx not
14263 @itemx Â¬
14264 This logical operator only takes a single argument.  It returns the
14265 logical negation of the value of its argument.
14266
14267 @end table
14268
14269 There is an @dfn{indirection operator} that will make its arguments
14270 apply to the ancestors of the current article being scored.  For
14271 instance, @code{1-} will make score rules apply to the parent of the
14272 current article.  @code{2-} will make score rules apply to the
14273 grandparent of the current article.  Alternatively, you can write
14274 @code{^^}, where the number of @code{^}s (carets) says how far back into
14275 the ancestry you want to go.
14276
14277 Finally, we have the match operators.  These are the ones that do the
14278 real work.  Match operators are header name strings followed by a match
14279 and a match type.  A typical match operator looks like @samp{("from"
14280 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
14281 simple scoring, and the match types are also the same.
14282
14283
14284 @node Advanced Scoring Examples
14285 @subsection Advanced Scoring Examples
14286
14287 Let's say you want to increase the score of articles written by Lars
14288 when he's talking about Gnus:
14289
14290 @example
14291 ((&
14292   ("from" "Lars Ingebrigtsen")
14293   ("subject" "Gnus"))
14294  1000)
14295 @end example
14296
14297 Quite simple, huh?
14298
14299 When he writes long articles, he sometimes has something nice to say:
14300
14301 @example
14302 ((&
14303   ("from" "Lars Ingebrigtsen")
14304   (|
14305    ("subject" "Gnus")
14306    ("lines" 100 >)))
14307  1000)
14308 @end example
14309
14310 However, when he responds to things written by Reig Eigil Logge, you
14311 really don't want to read what he's written:
14312
14313 @example
14314 ((&
14315   ("from" "Lars Ingebrigtsen")
14316   (1- ("from" "Reig Eigir Logge")))
14317  -100000)
14318 @end example
14319
14320 Everybody that follows up Redmondo when he writes about disappearing
14321 socks should have their scores raised, but only when they talk about
14322 white socks.  However, when Lars talks about socks, it's usually not
14323 very interesting:
14324
14325 @example
14326 ((&
14327   (1-
14328    (&
14329     ("from" "redmondo@@.*no" r)
14330     ("body" "disappearing.*socks" t)))
14331   (! ("from" "Lars Ingebrigtsen"))
14332   ("body" "white.*socks"))
14333  1000)
14334 @end example
14335
14336 The possibilities are endless.
14337
14338
14339 @node Advanced Scoring Tips
14340 @subsection Advanced Scoring Tips
14341
14342 The @code{&} and @code{|} logical operators do short-circuit logic.
14343 That is, they stop processing their arguments when it's clear what the
14344 result of the operation will be.  For instance, if one of the arguments
14345 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14346 the rest of the arguments.  This means that you should put slow matches
14347 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14348 @samp{subject}) first.
14349
14350 The indirection arguments (@code{1-} and so on) will make their
14351 arguments work on previous generations of the thread.  If you say
14352 something like:
14353
14354 @example
14355 ...
14356 (1-
14357  (1-
14358   ("from" "lars")))
14359 ...
14360 @end example
14361
14362 Then that means "score on the from header of the grandparent of the
14363 current article".  An indirection is quite fast, but it's better to say:
14364
14365 @example
14366 (1-
14367  (&
14368   ("from" "Lars")
14369   ("subject" "Gnus")))
14370 @end example
14371
14372 than it is to say:
14373
14374 @example
14375 (&
14376  (1- ("from" "Lars"))
14377  (1- ("subject" "Gnus")))
14378 @end example
14379
14380
14381 @node Score Decays
14382 @section Score Decays
14383 @cindex score decays
14384 @cindex decays
14385
14386 You may find that your scores have a tendency to grow without
14387 bounds, especially if you're using adaptive scoring.  If scores get too
14388 big, they lose all meaning---they simply max out and it's difficult to
14389 use them in any sensible way.
14390
14391 @vindex gnus-decay-scores
14392 @findex gnus-decay-score
14393 @vindex gnus-decay-score-function
14394 Gnus provides a mechanism for decaying scores to help with this problem.
14395 When score files are loaded and @code{gnus-decay-scores} is
14396 non-@code{nil}, Gnus will run the score files through the decaying
14397 mechanism thereby lowering the scores of all non-permanent score rules.
14398 The decay itself if performed by the @code{gnus-decay-score-function}
14399 function, which is @code{gnus-decay-score} by default.  Here's the
14400 definition of that function:
14401
14402 @lisp
14403 (defun gnus-decay-score (score)
14404   "Decay SCORE.
14405 This is done according to `gnus-score-decay-constant'
14406 and `gnus-score-decay-scale'."
14407   (floor
14408    (- score
14409       (* (if (< score 0) 1 -1)
14410          (min (abs score)
14411               (max gnus-score-decay-constant
14412                    (* (abs score)
14413                       gnus-score-decay-scale)))))))
14414 @end lisp
14415
14416 @vindex gnus-score-decay-scale
14417 @vindex gnus-score-decay-constant
14418 @code{gnus-score-decay-constant} is 3 by default and
14419 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
14420
14421 @enumerate
14422 @item
14423 Scores between -3 and 3 will be set to 0 when this function is called.
14424
14425 @item
14426 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14427
14428 @item
14429 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14430 score.
14431 @end enumerate
14432
14433 If you don't like this decay function, write your own.  It is called
14434 with the score to be decayed as its only parameter, and it should return
14435 the new score, which should be an integer.
14436
14437 Gnus will try to decay scores once a day.  If you haven't run Gnus for
14438 four days, Gnus will decay the scores four times, for instance.
14439
14440
14441 @node Various
14442 @chapter Various
14443
14444 @menu
14445 * Process/Prefix::             A convention used by many treatment commands.
14446 * Interactive::                Making Gnus ask you many questions.
14447 * Symbolic Prefixes::          How to supply some Gnus functions with options.
14448 * Formatting Variables::       You can specify what buffers should look like.
14449 * Windows Configuration::      Configuring the Gnus buffer windows.
14450 * Faces and Fonts::            How to change how faces look.
14451 * Compilation::                How to speed Gnus up.
14452 * Mode Lines::                 Displaying information in the mode lines.
14453 * Highlighting and Menus::     Making buffers look all nice and cozy.
14454 * Buttons::                    Get tendonitis in ten easy steps!
14455 * Daemons::                    Gnus can do things behind your back.
14456 * NoCeM::                      How to avoid spam and other fatty foods.
14457 * Undo::                       Some actions can be undone.
14458 * Moderation::                 What to do if you're a moderator.
14459 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
14460 * Fuzzy Matching::             What's the big fuzz?
14461 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
14462 * Various Various::            Things that are really various.
14463 @end menu
14464
14465
14466 @node Process/Prefix
14467 @section Process/Prefix
14468 @cindex process/prefix convention
14469
14470 Many functions, among them functions for moving, decoding and saving
14471 articles, use what is known as the @dfn{Process/Prefix convention}.
14472
14473 This is a method for figuring out what articles the user wants the
14474 command to be performed on.
14475
14476 It goes like this:
14477
14478 If the numeric prefix is N, perform the operation on the next N
14479 articles, starting with the current one.  If the numeric prefix is
14480 negative, perform the operation on the previous N articles, starting
14481 with the current one.
14482
14483 @vindex transient-mark-mode
14484 If @code{transient-mark-mode} in non-@code{nil} and the region is
14485 active, all articles in the region will be worked upon.
14486
14487 If there is no numeric prefix, but some articles are marked with the
14488 process mark, perform the operation on the articles marked with
14489 the process mark.
14490
14491 If there is neither a numeric prefix nor any articles marked with the
14492 process mark, just perform the operation on the current article.
14493
14494 Quite simple, really, but it needs to be made clear so that surprises
14495 are avoided.
14496
14497 Commands that react to the process mark will push the current list of
14498 process marked articles onto a stack and will then clear all process
14499 marked articles.  You can restore the previous configuration with the
14500 @kbd{M P y} command (@pxref{Setting Process Marks}).
14501
14502 @vindex gnus-summary-goto-unread
14503 One thing that seems to shock & horrify lots of people is that, for
14504 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14505 Since each @kbd{d} (which marks the current article as read) by default
14506 goes to the next unread article after marking, this means that @kbd{3 d}
14507 will mark the next three unread articles as read, no matter what the
14508 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
14509 @code{nil} for a more straightforward action.
14510
14511
14512 @node Interactive
14513 @section Interactive
14514 @cindex interaction
14515
14516 @table @code
14517
14518 @item gnus-novice-user
14519 @vindex gnus-novice-user
14520 If this variable is non-@code{nil}, you are either a newcomer to the
14521 World of Usenet, or you are very cautious, which is a nice thing to be,
14522 really.  You will be given questions of the type ``Are you sure you want
14523 to do this?'' before doing anything dangerous.  This is @code{t} by
14524 default.
14525
14526 @item gnus-expert-user
14527 @vindex gnus-expert-user
14528 If this variable is non-@code{nil}, you will seldom be asked any
14529 questions by Gnus.  It will simply assume you know what you're doing, no
14530 matter how strange.
14531
14532 @item gnus-interactive-catchup
14533 @vindex gnus-interactive-catchup
14534 Require confirmation before catching up a group if non-@code{nil}.  It
14535 is @code{t} by default.
14536
14537 @item gnus-interactive-exit
14538 @vindex gnus-interactive-exit
14539 Require confirmation before exiting Gnus.  This variable is @code{t} by
14540 default.
14541 @end table
14542
14543
14544 @node Symbolic Prefixes
14545 @section Symbolic Prefixes
14546 @cindex symbolic prefixes
14547
14548 Quite a lot of Emacs commands react to the (numeric) prefix.  For
14549 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14550 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14551 rule of 900 to the current article.
14552
14553 This is all nice and well, but what if you want to give a command some
14554 additional information?  Well, what most commands do is interpret the
14555 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
14556 doesn't want a backup file to be created when saving the current buffer,
14557 for instance.  But what if you want to save without making a backup
14558 file, and you want Emacs to flash lights and play a nice tune at the
14559 same time?  You can't, and you're probably perfectly happy that way.
14560
14561 @kindex M-i (Summary)
14562 @findex gnus-symbolic-argument
14563 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
14564 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14565 character typed in is the value.  You can stack as many @kbd{M-i}
14566 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14567 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
14568 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14569 @code{b}''.  You get the drift.
14570
14571 Typing in symbolic prefixes to commands that don't accept them doesn't
14572 hurt, but it doesn't do any good either.  Currently not many Gnus
14573 functions make use of the symbolic prefix.
14574
14575 If you're interested in how Gnus implements this, @pxref{Extended
14576 Interactive}.
14577
14578
14579 @node Formatting Variables
14580 @section Formatting Variables
14581 @cindex formatting variables
14582
14583 Throughout this manual you've probably noticed lots of variables called
14584 things like @code{gnus-group-line-format} and
14585 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
14586 output lines in the various buffers.  There's quite a lot of them.
14587 Fortunately, they all use the same syntax, so there's not that much to
14588 be annoyed by.
14589
14590 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14591 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
14592 lots of percentages everywhere.
14593
14594 @menu
14595 * Formatting Basics::     A formatting variable is basically a format string.
14596 * Mode Line Formatting::  Some rules about mode line formatting variables.
14597 * Advanced Formatting::   Modifying output in various ways.
14598 * User-Defined Specs::    Having Gnus call your own functions.
14599 * Formatting Fonts::      Making the formatting look colorful and nice.
14600 @end menu
14601
14602 Currently Gnus uses the following formatting variables:
14603 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14604 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14605 @code{gnus-group-mode-line-format},
14606 @code{gnus-summary-mode-line-format},
14607 @code{gnus-article-mode-line-format},
14608 @code{gnus-server-mode-line-format}, and
14609 @code{gnus-summary-pick-line-format}.
14610
14611 All these format variables can also be arbitrary elisp forms.  In that
14612 case, they will be @code{eval}ed to insert the required lines.
14613
14614 @kindex M-x gnus-update-format
14615 @findex gnus-update-format
14616 Gnus includes a command to help you while creating your own format
14617 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
14618 update the spec in question and pop you to a buffer where you can
14619 examine the resulting lisp code to be run to generate the line.
14620
14621
14622
14623 @node Formatting Basics
14624 @subsection Formatting Basics
14625
14626 Each @samp{%} element will be replaced by some string or other when the
14627 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
14628 spec, and pad with spaces to get a 5-character field''.
14629
14630 As with normal C and Emacs Lisp formatting strings, the numerical
14631 modifier between the @samp{%} and the formatting type character will
14632 @dfn{pad} the output so that it is always at least that long.
14633 @samp{%5y} will make the field always (at least) five characters wide by
14634 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
14635 the right instead.
14636
14637 You may also wish to limit the length of the field to protect against
14638 particularly wide values.  For that you can say @samp{%4,6y}, which
14639 means that the field will never be more than 6 characters wide and never
14640 less than 4 characters wide.
14641
14642
14643 @node Mode Line Formatting
14644 @subsection Mode Line Formatting
14645
14646 Mode line formatting variables (e.g.,
14647 @code{gnus-summary-mode-line-format}) follow the same rules as other,
14648 buffer line oriented formatting variables (@pxref{Formatting Basics})
14649 with the following two differences:
14650
14651 @enumerate
14652
14653 @item
14654 There must be no newline (@samp{\n}) at the end.
14655
14656 @item
14657 The special @samp{%%b} spec can be used to display the buffer name.
14658 Well, it's no spec at all, really---@samp{%%} is just a way to quote
14659 @samp{%} to allow it to pass through the formatting machinery unmangled,
14660 so that Emacs receives @samp{%b}, which is something the Emacs mode line
14661 display interprets to mean ``show the buffer name''.  For a full list of
14662 mode line specs Emacs understands, see the documentation of the
14663 @code{mode-line-format} variable.
14664
14665 @end enumerate
14666
14667
14668 @node Advanced Formatting
14669 @subsection Advanced Formatting
14670
14671 It is frequently useful to post-process the fields in some way.
14672 Padding, limiting, cutting off parts and suppressing certain values can
14673 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
14674 look like @samp{%~(cut 3)~(ignore "0")y}.
14675
14676 These are the valid modifiers:
14677
14678 @table @code
14679 @item pad
14680 @itemx pad-left
14681 Pad the field to the left with spaces until it reaches the required
14682 length.
14683
14684 @item pad-right
14685 Pad the field to the right with spaces until it reaches the required
14686 length.
14687
14688 @item max
14689 @itemx max-left
14690 Cut off characters from the left until it reaches the specified length.
14691
14692 @item max-right
14693 Cut off characters from the right until it reaches the specified
14694 length.
14695
14696 @item cut
14697 @itemx cut-left
14698 Cut off the specified number of characters from the left.
14699
14700 @item cut-right
14701 Cut off the specified number of characters from the right.
14702
14703 @item ignore
14704 Return an empty string if the field is equal to the specified value.
14705
14706 @item form
14707 Use the specified form as the field value when the @samp{@@} spec is
14708 used.
14709 @end table
14710
14711 Let's take an example.  The @samp{%o} spec in the summary mode lines
14712 will return a date in compact ISO8601 format---@samp{19960809T230410}.
14713 This is quite a mouthful, so we want to shave off the century number and
14714 the time, leaving us with a six-character date.  That would be
14715 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
14716 maxing, and we need the padding to ensure that the date is never less
14717 than 6 characters to make it look nice in columns.)
14718
14719 Ignoring is done first; then cutting; then maxing; and then as the very
14720 last operation, padding.
14721
14722 If you use lots of these advanced thingies, you'll find that Gnus gets
14723 quite slow.  This can be helped enormously by running @kbd{M-x
14724 gnus-compile} when you are satisfied with the look of your lines.
14725 @xref{Compilation}.
14726
14727
14728 @node User-Defined Specs
14729 @subsection User-Defined Specs
14730
14731 All the specs allow for inserting user defined specifiers---@samp{u}.
14732 The next character in the format string should be a letter.  Gnus
14733 will call the function @code{gnus-user-format-function-}@samp{X}, where
14734 @samp{X} is the letter following @samp{%u}.  The function will be passed
14735 a single parameter---what the parameter means depends on what buffer
14736 it's being called from.  The function should return a string, which will
14737 be inserted into the buffer just like information from any other
14738 specifier.  This function may also be called with dummy values, so it
14739 should protect against that.
14740
14741 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
14742 much the same without defining new functions.  Here's an example:
14743 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
14744 given here will be evaluated to yield the current line number, and then
14745 inserted.
14746
14747
14748 @node Formatting Fonts
14749 @subsection Formatting Fonts
14750
14751 There are specs for highlighting, and these are shared by all the format
14752 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
14753 the special @code{mouse-face} property set, which means that it will be
14754 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
14755 over it.
14756
14757 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
14758 normal faces set using @code{gnus-face-0}, which is @code{bold} by
14759 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
14760 and so on.  Create as many faces as you wish.  The same goes for the
14761 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
14762 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
14763
14764 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
14765 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
14766 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
14767 @code{gnus-balloon-face-*} variables should be either strings or
14768 symbols naming functions that return a string. Under @code{balloon-help-mode},
14769 when the mouse passes over text with this property set, a balloon window
14770 will appear and display the string. Please refer to the doc string of
14771 @code{balloon-help-mode} for more information on this.
14772
14773 Here's an alternative recipe for the group buffer:
14774
14775 @lisp
14776 ;; Create three face types.
14777 (setq gnus-face-1 'bold)
14778 (setq gnus-face-3 'italic)
14779
14780 ;; We want the article count to be in
14781 ;; a bold and green face.  So we create
14782 ;; a new face called `my-green-bold'.
14783 (copy-face 'bold 'my-green-bold)
14784 ;; Set the color.
14785 (set-face-foreground 'my-green-bold "ForestGreen")
14786 (setq gnus-face-2 'my-green-bold)
14787
14788 ;; Set the new & fancy format.
14789 (setq gnus-group-line-format
14790       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
14791 @end lisp
14792
14793 I'm sure you'll be able to use this scheme to create totally unreadable
14794 and extremely vulgar displays.  Have fun!
14795
14796 Note that the @samp{%(} specs (and friends) do not make any sense on the
14797 mode-line variables.
14798
14799
14800 @node Windows Configuration
14801 @section Windows Configuration
14802 @cindex windows configuration
14803
14804 No, there's nothing here about X, so be quiet.
14805
14806 @vindex gnus-use-full-window
14807 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
14808 other windows and occupy the entire Emacs screen by itself.  It is
14809 @code{t} by default.
14810
14811 Setting this variable to @code{nil} kinda works, but there are
14812 glitches.  Use at your own peril.
14813
14814 @vindex gnus-buffer-configuration
14815 @code{gnus-buffer-configuration} describes how much space each Gnus
14816 buffer should be given.  Here's an excerpt of this variable:
14817
14818 @lisp
14819 ((group (vertical 1.0 (group 1.0 point)
14820                       (if gnus-carpal (group-carpal 4))))
14821  (article (vertical 1.0 (summary 0.25 point)
14822                         (article 1.0))))
14823 @end lisp
14824
14825 This is an alist.  The @dfn{key} is a symbol that names some action or
14826 other.  For instance, when displaying the group buffer, the window
14827 configuration function will use @code{group} as the key.  A full list of
14828 possible names is listed below.
14829
14830 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
14831 should occupy.  To take the @code{article} split as an example -
14832
14833 @lisp
14834 (article (vertical 1.0 (summary 0.25 point)
14835                        (article 1.0)))
14836 @end lisp
14837
14838 This @dfn{split} says that the summary buffer should occupy 25% of upper
14839 half of the screen, and that it is placed over the article buffer.  As
14840 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
14841 reaching for that calculator there).  However, the special number
14842 @code{1.0} is used to signal that this buffer should soak up all the
14843 rest of the space available after the rest of the buffers have taken
14844 whatever they need.  There should be only one buffer with the @code{1.0}
14845 size spec per split.
14846
14847 Point will be put in the buffer that has the optional third element
14848 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
14849 split where the tag @code{frame-focus} is a member (i.e. is the third or
14850 fourth element in the list, depending on whether the @code{point} tag is
14851 present) gets focus.
14852
14853 Here's a more complicated example:
14854
14855 @lisp
14856 (article (vertical 1.0 (group 4)
14857                        (summary 0.25 point)
14858                        (if gnus-carpal (summary-carpal 4))
14859                        (article 1.0)))
14860 @end lisp
14861
14862 If the size spec is an integer instead of a floating point number,
14863 then that number will be used to say how many lines a buffer should
14864 occupy, not a percentage.
14865
14866 If the @dfn{split} looks like something that can be @code{eval}ed (to be
14867 precise---if the @code{car} of the split is a function or a subr), this
14868 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
14869 be used as a split.  This means that there will be three buffers if
14870 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
14871 is non-@code{nil}.
14872
14873 Not complicated enough for you?  Well, try this on for size:
14874
14875 @lisp
14876 (article (horizontal 1.0
14877              (vertical 0.5
14878                  (group 1.0)
14879                  (gnus-carpal 4))
14880              (vertical 1.0
14881                  (summary 0.25 point)
14882                  (summary-carpal 4)
14883                  (article 1.0))))
14884 @end lisp
14885
14886 Whoops.  Two buffers with the mystery 100% tag.  And what's that
14887 @code{horizontal} thingie?
14888
14889 If the first element in one of the split is @code{horizontal}, Gnus will
14890 split the window horizontally, giving you two windows side-by-side.
14891 Inside each of these strips you may carry on all you like in the normal
14892 fashion.  The number following @code{horizontal} says what percentage of
14893 the screen is to be given to this strip.
14894
14895 For each split, there @emph{must} be one element that has the 100% tag.
14896 The splitting is never accurate, and this buffer will eat any leftover
14897 lines from the splits.
14898
14899 To be slightly more formal, here's a definition of what a valid split
14900 may look like:
14901
14902 @example
14903 split       = frame | horizontal | vertical | buffer | form
14904 frame       = "(frame " size *split ")"
14905 horizontal  = "(horizontal " size *split ")"
14906 vertical    = "(vertical " size *split ")"
14907 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
14908 size        = number | frame-params
14909 buffer-name = group | article | summary ...
14910 @end example
14911
14912 The limitations are that the @code{frame} split can only appear as the
14913 top-level split.  @var{form} should be an Emacs Lisp form that should
14914 return a valid split.  We see that each split is fully recursive, and
14915 may contain any number of @code{vertical} and @code{horizontal} splits.
14916
14917 @vindex gnus-window-min-width
14918 @vindex gnus-window-min-height
14919 @cindex window height
14920 @cindex window width
14921 Finding the right sizes can be a bit complicated.  No window may be less
14922 than @code{gnus-window-min-height} (default 1) characters high, and all
14923 windows must be at least @code{gnus-window-min-width} (default 1)
14924 characters wide.  Gnus will try to enforce this before applying the
14925 splits.  If you want to use the normal Emacs window width/height limit,
14926 you can just set these two variables to @code{nil}.
14927
14928 If you're not familiar with Emacs terminology, @code{horizontal} and
14929 @code{vertical} splits may work the opposite way of what you'd expect.
14930 Windows inside a @code{horizontal} split are shown side-by-side, and
14931 windows within a @code{vertical} split are shown above each other.
14932
14933 @findex gnus-configure-frame
14934 If you want to experiment with window placement, a good tip is to call
14935 @code{gnus-configure-frame} directly with a split.  This is the function
14936 that does all the real work when splitting buffers.  Below is a pretty
14937 nonsensical configuration with 5 windows; two for the group buffer and
14938 three for the article buffer.  (I said it was nonsensical.)  If you
14939 @code{eval} the statement below, you can get an idea of how that would
14940 look straight away, without going through the normal Gnus channels.
14941 Play with it until you're satisfied, and then use
14942 @code{gnus-add-configuration} to add your new creation to the buffer
14943 configuration list.
14944
14945 @lisp
14946 (gnus-configure-frame
14947  '(horizontal 1.0
14948     (vertical 10
14949       (group 1.0)
14950       (article 0.3 point))
14951     (vertical 1.0
14952       (article 1.0)
14953       (horizontal 4
14954         (group 1.0)
14955         (article 10)))))
14956 @end lisp
14957
14958 You might want to have several frames as well.  No prob---just use the
14959 @code{frame} split:
14960
14961 @lisp
14962 (gnus-configure-frame
14963  '(frame 1.0
14964          (vertical 1.0
14965                    (summary 0.25 point frame-focus)
14966                    (article 1.0))
14967          (vertical ((height . 5) (width . 15)
14968                     (user-position . t)
14969                     (left . -1) (top . 1))
14970                    (picon 1.0))))
14971
14972 @end lisp
14973
14974 This split will result in the familiar summary/article window
14975 configuration in the first (or ``main'') frame, while a small additional
14976 frame will be created where picons will be shown.  As you can see,
14977 instead of the normal @code{1.0} top-level spec, each additional split
14978 should have a frame parameter alist as the size spec.
14979 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
14980 Reference Manual}.  Under XEmacs, a frame property list will be
14981 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
14982 is such a plist.
14983 The list of all possible keys for @code{gnus-buffer-configuration} can
14984 be found in its default value.
14985
14986 Note that the @code{message} key is used for both
14987 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
14988 it is desirable to distinguish between the two, something like this
14989 might be used:
14990
14991 @lisp
14992 (message (horizontal 1.0
14993                      (vertical 1.0 (message 1.0 point))
14994                      (vertical 0.24
14995                                (if (buffer-live-p gnus-summary-buffer)
14996                                    '(summary 0.5))
14997                                (group 1.0)))))
14998 @end lisp
14999
15000 One common desire for a multiple frame split is to have a separate frame
15001 for composing mail and news while leaving the original frame intact.  To
15002 accomplish that, something like the following can be done:
15003
15004 @lisp
15005 (message (frame 1.0
15006                 (if (not (buffer-live-p gnus-summary-buffer))
15007                     (car (cdr (assoc 'group gnus-buffer-configuration)))
15008                   (car (cdr (assoc 'summary gnus-buffer-configuration))))
15009                 (vertical ((user-position . t) (top . 1) (left . 1)
15010                            (name . "Message"))
15011                           (message 1.0 point))))
15012 @end lisp
15013
15014 @findex gnus-add-configuration
15015 Since the @code{gnus-buffer-configuration} variable is so long and
15016 complicated, there's a function you can use to ease changing the config
15017 of a single setting: @code{gnus-add-configuration}.  If, for instance,
15018 you want to change the @code{article} setting, you could say:
15019
15020 @lisp
15021 (gnus-add-configuration
15022  '(article (vertical 1.0
15023                (group 4)
15024                (summary .25 point)
15025                (article 1.0))))
15026 @end lisp
15027
15028 You'd typically stick these @code{gnus-add-configuration} calls in your
15029 @file{.gnus.el} file or in some startup hook---they should be run after
15030 Gnus has been loaded.
15031
15032 @vindex gnus-always-force-window-configuration
15033 If all windows mentioned in the configuration are already visible, Gnus
15034 won't change the window configuration.  If you always want to force the
15035 ``right'' window configuration, you can set
15036 @code{gnus-always-force-window-configuration} to non-@code{nil}.
15037
15038 If you're using tree displays (@pxref{Tree Display}), and the tree
15039 window is displayed vertically next to another window, you may also want
15040 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
15041 windows resized.
15042
15043
15044 @node Faces and Fonts
15045 @section Faces and Fonts
15046 @cindex faces
15047 @cindex fonts
15048 @cindex colors
15049
15050 Fiddling with fonts and faces used to be very difficult, but these days
15051 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
15052 the face you want to alter, and alter it via the standard Customize
15053 interface.
15054
15055
15056 @node Compilation
15057 @section Compilation
15058 @cindex compilation
15059 @cindex byte-compilation
15060
15061 @findex gnus-compile
15062
15063 Remember all those line format specification variables?
15064 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
15065 on.  Now, Gnus will of course heed whatever these variables are, but,
15066 unfortunately, changing them will mean a quite significant slow-down.
15067 (The default values of these variables have byte-compiled functions
15068 associated with them, while the user-generated versions do not, of
15069 course.)
15070
15071 To help with this, you can run @kbd{M-x gnus-compile} after you've
15072 fiddled around with the variables and feel that you're (kind of)
15073 satisfied.  This will result in the new specs being byte-compiled, and
15074 you'll get top speed again.  Gnus will save these compiled specs in the
15075 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
15076 this function, though---you should compile them yourself by sticking
15077 them into the @code{.gnus.el} file and byte-compiling that file.)
15078
15079
15080 @node Mode Lines
15081 @section Mode Lines
15082 @cindex mode lines
15083
15084 @vindex gnus-updated-mode-lines
15085 @code{gnus-updated-mode-lines} says what buffers should keep their mode
15086 lines updated.  It is a list of symbols.  Supported symbols include
15087 @code{group}, @code{article}, @code{summary}, @code{server},
15088 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
15089 Gnus will keep that mode line updated with information that may be
15090 pertinent.  If this variable is @code{nil}, screen refresh may be
15091 quicker.
15092
15093 @cindex display-time
15094
15095 @vindex gnus-mode-non-string-length
15096 By default, Gnus displays information on the current article in the mode
15097 lines of the summary and article buffers.  The information Gnus wishes
15098 to display (e.g. the subject of the article) is often longer than the
15099 mode lines, and therefore have to be cut off at some point.  The
15100 @code{gnus-mode-non-string-length} variable says how long the other
15101 elements on the line is (i.e., the non-info part).  If you put
15102 additional elements on the mode line (e.g. a clock), you should modify
15103 this variable:
15104
15105 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
15106 @lisp
15107 (add-hook 'display-time-hook
15108           (lambda () (setq gnus-mode-non-string-length
15109                            (+ 21
15110                               (if line-number-mode 5 0)
15111                               (if column-number-mode 4 0)
15112                               (length display-time-string)))))
15113 @end lisp
15114
15115 If this variable is @code{nil} (which is the default), the mode line
15116 strings won't be chopped off, and they won't be padded either.  Note
15117 that the default is unlikely to be desirable, as even the percentage
15118 complete in the buffer may be crowded off the mode line; the user should
15119 configure this variable appropriately for her configuration.
15120
15121
15122 @node Highlighting and Menus
15123 @section Highlighting and Menus
15124 @cindex visual
15125 @cindex highlighting
15126 @cindex menus
15127
15128 @vindex gnus-visual
15129 The @code{gnus-visual} variable controls most of the Gnus-prettifying
15130 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
15131 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
15132 file.
15133
15134 This variable can be a list of visual properties that are enabled.  The
15135 following elements are valid, and are all included by default:
15136
15137 @table @code
15138 @item group-highlight
15139 Do highlights in the group buffer.
15140 @item summary-highlight
15141 Do highlights in the summary buffer.
15142 @item article-highlight
15143 Do highlights in the article buffer.
15144 @item highlight
15145 Turn on highlighting in all buffers.
15146 @item group-menu
15147 Create menus in the group buffer.
15148 @item summary-menu
15149 Create menus in the summary buffers.
15150 @item article-menu
15151 Create menus in the article buffer.
15152 @item browse-menu
15153 Create menus in the browse buffer.
15154 @item server-menu
15155 Create menus in the server buffer.
15156 @item score-menu
15157 Create menus in the score buffers.
15158 @item menu
15159 Create menus in all buffers.
15160 @end table
15161
15162 So if you only want highlighting in the article buffer and menus in all
15163 buffers, you could say something like:
15164
15165 @lisp
15166 (setq gnus-visual '(article-highlight menu))
15167 @end lisp
15168
15169 If you want highlighting only and no menus whatsoever, you'd say:
15170
15171 @lisp
15172 (setq gnus-visual '(highlight))
15173 @end lisp
15174
15175 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
15176 in all Gnus buffers.
15177
15178 Other general variables that influence the look of all buffers include:
15179
15180 @table @code
15181 @item gnus-mouse-face
15182 @vindex gnus-mouse-face
15183 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
15184 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15185
15186 @end table
15187
15188 There are hooks associated with the creation of all the different menus:
15189
15190 @table @code
15191
15192 @item gnus-article-menu-hook
15193 @vindex gnus-article-menu-hook
15194 Hook called after creating the article mode menu.
15195
15196 @item gnus-group-menu-hook
15197 @vindex gnus-group-menu-hook
15198 Hook called after creating the group mode menu.
15199
15200 @item gnus-summary-menu-hook
15201 @vindex gnus-summary-menu-hook
15202 Hook called after creating the summary mode menu.
15203
15204 @item gnus-server-menu-hook
15205 @vindex gnus-server-menu-hook
15206 Hook called after creating the server mode menu.
15207
15208 @item gnus-browse-menu-hook
15209 @vindex gnus-browse-menu-hook
15210 Hook called after creating the browse mode menu.
15211
15212 @item gnus-score-menu-hook
15213 @vindex gnus-score-menu-hook
15214 Hook called after creating the score mode menu.
15215
15216 @end table
15217
15218
15219 @node Buttons
15220 @section Buttons
15221 @cindex buttons
15222 @cindex mouse
15223 @cindex click
15224
15225 Those new-fangled @dfn{mouse} contraptions is very popular with the
15226 young, hep kids who don't want to learn the proper way to do things
15227 these days.  Why, I remember way back in the summer of '89, when I was
15228 using Emacs on a Tops 20 system.  Three hundred users on one single
15229 machine, and every user was running Simula compilers.  Bah!
15230
15231 Right.
15232
15233 @vindex gnus-carpal
15234 Well, you can make Gnus display bufferfuls of buttons you can click to
15235 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
15236 really.  Tell the chiropractor I sent you.
15237
15238
15239 @table @code
15240
15241 @item gnus-carpal-mode-hook
15242 @vindex gnus-carpal-mode-hook
15243 Hook run in all carpal mode buffers.
15244
15245 @item gnus-carpal-button-face
15246 @vindex gnus-carpal-button-face
15247 Face used on buttons.
15248
15249 @item gnus-carpal-header-face
15250 @vindex gnus-carpal-header-face
15251 Face used on carpal buffer headers.
15252
15253 @item gnus-carpal-group-buffer-buttons
15254 @vindex gnus-carpal-group-buffer-buttons
15255 Buttons in the group buffer.
15256
15257 @item gnus-carpal-summary-buffer-buttons
15258 @vindex gnus-carpal-summary-buffer-buttons
15259 Buttons in the summary buffer.
15260
15261 @item gnus-carpal-server-buffer-buttons
15262 @vindex gnus-carpal-server-buffer-buttons
15263 Buttons in the server buffer.
15264
15265 @item gnus-carpal-browse-buffer-buttons
15266 @vindex gnus-carpal-browse-buffer-buttons
15267 Buttons in the browse buffer.
15268 @end table
15269
15270 All the @code{buttons} variables are lists.  The elements in these list
15271 are either cons cells where the @code{car} contains a text to be displayed and
15272 the @code{cdr} contains a function symbol, or a simple string.
15273
15274
15275 @node Daemons
15276 @section Daemons
15277 @cindex demons
15278 @cindex daemons
15279
15280 Gnus, being larger than any program ever written (allegedly), does lots
15281 of strange stuff that you may wish to have done while you're not
15282 present.  For instance, you may want it to check for new mail once in a
15283 while.  Or you may want it to close down all connections to all servers
15284 when you leave Emacs idle.  And stuff like that.
15285
15286 Gnus will let you do stuff like that by defining various
15287 @dfn{handlers}.  Each handler consists of three elements:  A
15288 @var{function}, a @var{time}, and an @var{idle} parameter.
15289
15290 Here's an example of a handler that closes connections when Emacs has
15291 been idle for thirty minutes:
15292
15293 @lisp
15294 (gnus-demon-close-connections nil 30)
15295 @end lisp
15296
15297 Here's a handler that scans for PGP headers every hour when Emacs is
15298 idle:
15299
15300 @lisp
15301 (gnus-demon-scan-pgp 60 t)
15302 @end lisp
15303
15304 This @var{time} parameter and than @var{idle} parameter work together
15305 in a strange, but wonderful fashion.  Basically, if @var{idle} is
15306 @code{nil}, then the function will be called every @var{time} minutes.
15307
15308 If @var{idle} is @code{t}, then the function will be called after
15309 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
15310 the function will never be called.  But once Emacs goes idle, the
15311 function will be called every @var{time} minutes.
15312
15313 If @var{idle} is a number and @var{time} is a number, the function will
15314 be called every @var{time} minutes only when Emacs has been idle for
15315 @var{idle} minutes.
15316
15317 If @var{idle} is a number and @var{time} is @code{nil}, the function
15318 will be called once every time Emacs has been idle for @var{idle}
15319 minutes.
15320
15321 And if @var{time} is a string, it should look like @samp{07:31}, and
15322 the function will then be called once every day somewhere near that
15323 time.  Modified by the @var{idle} parameter, of course.
15324
15325 @vindex gnus-demon-timestep
15326 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15327 seconds.  This is 60 by default.  If you change that variable,
15328 all the timings in the handlers will be affected.)
15329
15330 So, if you want to add a handler, you could put something like this in
15331 your @file{.gnus} file:
15332
15333 @findex gnus-demon-add-handler
15334 @lisp
15335 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15336 @end lisp
15337
15338 @findex gnus-demon-add-nocem
15339 @findex gnus-demon-add-scanmail
15340 @findex gnus-demon-add-rescan
15341 @findex gnus-demon-add-scan-timestamps
15342 @findex gnus-demon-add-disconnection
15343 Some ready-made functions to do this have been created:
15344 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15345 @code{gnus-demon-add-nntp-close-connection},
15346 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15347 @code{gnus-demon-add-scanmail}.  Just put those functions in your
15348 @file{.gnus} if you want those abilities.
15349
15350 @findex gnus-demon-init
15351 @findex gnus-demon-cancel
15352 @vindex gnus-demon-handlers
15353 If you add handlers to @code{gnus-demon-handlers} directly, you should
15354 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
15355 daemons, you can use the @code{gnus-demon-cancel} function.
15356
15357 Note that adding daemons can be pretty naughty if you over do it.  Adding
15358 functions that scan all news and mail from all servers every two seconds
15359 is a sure-fire way of getting booted off any respectable system.  So
15360 behave.
15361
15362
15363 @node NoCeM
15364 @section NoCeM
15365 @cindex nocem
15366 @cindex spam
15367
15368 @dfn{Spamming} is posting the same article lots and lots of times.
15369 Spamming is bad.  Spamming is evil.
15370
15371 Spamming is usually canceled within a day or so by various anti-spamming
15372 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
15373 NoCeM is pronounced ``no see-'em'', and means what the name
15374 implies---these are messages that make the offending articles, like, go
15375 away.
15376
15377 What use are these NoCeM messages if the articles are canceled anyway?
15378 Some sites do not honor cancel messages and some sites just honor cancels
15379 from a select few people.  Then you may wish to make use of the NoCeM
15380 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15381
15382 Gnus can read and parse the messages in this group automatically, and
15383 this will make spam disappear.
15384
15385 There are some variables to customize, of course:
15386
15387 @table @code
15388 @item gnus-use-nocem
15389 @vindex gnus-use-nocem
15390 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
15391 by default.
15392
15393 @item gnus-nocem-groups
15394 @vindex gnus-nocem-groups
15395 Gnus will look for NoCeM messages in the groups in this list.  The
15396 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15397 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15398
15399 @item gnus-nocem-issuers
15400 @vindex gnus-nocem-issuers
15401 There are many people issuing NoCeM messages.  This list says what
15402 people you want to listen to.  The default is @code{("Automoose-1"
15403 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15404 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15405 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15406
15407 Known despammers that you can put in this list include:
15408
15409 @table @samp
15410 @item clewis@@ferret.ocunix.on.ca;
15411 @cindex Chris Lewis
15412 Chris Lewis---Major Canadian despammer who has probably canceled more
15413 usenet abuse than anybody else.
15414
15415 @item Automoose-1
15416 @cindex CancelMoose[tm]
15417 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
15418 Norwegian, and was the person(s) who invented NoCeM.
15419
15420 @item jem@@xpat.com;
15421 @cindex Jem
15422 John Milburn---despammer located in Korea who is getting very busy these
15423 days.
15424
15425 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15426 Richard E. Depew---lone American despammer.  He mostly cancels binary
15427 postings to non-binary groups and removes spews (regurgitated articles).
15428 @end table
15429
15430 You do not have to heed NoCeM messages from all these people---just the
15431 ones you want to listen to.  You also don't have to accept all NoCeM
15432 messages from the people you like.  Each NoCeM message has a @dfn{type}
15433 header that gives the message a (more or less, usually less) rigorous
15434 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15435 @samp{binary}, and @samp{troll}.  To specify this, you have to use
15436 @var{(issuer conditions ...)} elements in the list.  Each condition is
15437 either a string (which is a regexp that matches types you want to use)
15438 or a list on the form @code{(not STRING)}, where @var{string} is a
15439 regexp that matches types you don't want to use.
15440
15441 For instance, if you want all NoCeM messages from Chris Lewis except his
15442 @samp{troll} messages, you'd say:
15443
15444 @lisp
15445 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15446 @end lisp
15447
15448 On the other hand, if you just want nothing but his @samp{spam} and
15449 @samp{spew} messages, you'd say:
15450
15451 @lisp
15452 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15453 @end lisp
15454
15455 The specs are applied left-to-right.
15456
15457
15458 @item gnus-nocem-verifyer
15459 @vindex gnus-nocem-verifyer
15460 @findex mc-verify
15461 This should be a function for verifying that the NoCeM issuer is who she
15462 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
15463 function.  If this is too slow and you don't care for verification
15464 (which may be dangerous), you can set this variable to @code{nil}.
15465
15466 If you want signed NoCeM messages to be verified and unsigned messages
15467 not to be verified (but used anyway), you could do something like:
15468
15469 @lisp
15470 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15471
15472 (defun my-gnus-mc-verify ()
15473   (not (eq 'forged
15474            (ignore-errors
15475              (if (mc-verify)
15476                  t
15477                'forged)))))
15478 @end lisp
15479
15480 This might be dangerous, though.
15481
15482 @item gnus-nocem-directory
15483 @vindex gnus-nocem-directory
15484 This is where Gnus will store its NoCeM cache files.  The default is
15485 @file{~/News/NoCeM/}.
15486
15487 @item gnus-nocem-expiry-wait
15488 @vindex gnus-nocem-expiry-wait
15489 The number of days before removing old NoCeM entries from the cache.
15490 The default is 15.  If you make it shorter Gnus will be faster, but you
15491 might then see old spam.
15492
15493 @end table
15494
15495 Using NoCeM could potentially be a memory hog.  If you have many living
15496 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15497 big.  If this is a problem, you should kill off all (or most) of your
15498 unsubscribed groups (@pxref{Subscription Commands}).
15499
15500
15501 @node Undo
15502 @section Undo
15503 @cindex undo
15504
15505 It is very useful to be able to undo actions one has done.  In normal
15506 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15507 In Gnus buffers, however, it isn't that simple.
15508
15509 The things Gnus displays in its buffer is of no value whatsoever to
15510 Gnus---it's all just data designed to look nice to the user.
15511 Killing a group in the group buffer with @kbd{C-k} makes the line
15512 disappear, but that's just a side-effect of the real action---the
15513 removal of the group in question from the internal Gnus structures.
15514 Undoing something like that can't be done by the normal Emacs
15515 @code{undo} function.
15516
15517 Gnus tries to remedy this somewhat by keeping track of what the user
15518 does and coming up with actions that would reverse the actions the user
15519 takes.  When the user then presses the @code{undo} key, Gnus will run
15520 the code to reverse the previous action, or the previous actions.
15521 However, not all actions are easily reversible, so Gnus currently offers
15522 a few key functions to be undoable.  These include killing groups,
15523 yanking groups, and changing the list of read articles of groups.
15524 That's it, really.  More functions may be added in the future, but each
15525 added function means an increase in data to be stored, so Gnus will
15526 never be totally undoable.
15527
15528 @findex gnus-undo-mode
15529 @vindex gnus-use-undo
15530 @findex gnus-undo
15531 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
15532 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15533 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
15534 command, which should feel kinda like the normal Emacs @code{undo}
15535 command.
15536
15537
15538 @node Moderation
15539 @section Moderation
15540 @cindex moderation
15541
15542 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15543 It is not included in the standard Gnus package.  Write a mail to
15544 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15545 get a copy.
15546
15547 The moderation package is implemented as a minor mode for summary
15548 buffers.  Put
15549
15550 @lisp
15551 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15552 @end lisp
15553
15554 in your @file{.gnus.el} file.
15555
15556 If you are the moderator of @samp{rec.zoofle}, this is how it's
15557 supposed to work:
15558
15559 @enumerate
15560 @item
15561 You split your incoming mail by matching on
15562 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15563 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15564
15565 @item
15566 You enter that group once in a while and post articles using the @kbd{e}
15567 (edit-and-post) or @kbd{s} (just send unedited) commands.
15568
15569 @item
15570 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15571 articles that weren't approved by you, you can cancel them with the
15572 @kbd{c} command.
15573 @end enumerate
15574
15575 To use moderation mode in these two groups, say:
15576
15577 @lisp
15578 (setq gnus-moderated-list
15579       "^nnml:rec.zoofle$\\|^rec.zoofle$")
15580 @end lisp
15581
15582
15583 @node XEmacs Enhancements
15584 @section XEmacs Enhancements
15585 @cindex XEmacs
15586
15587 XEmacs is able to display pictures and stuff, so Gnus has taken
15588 advantage of that.
15589
15590 @menu
15591 * Picons::    How to display pictures of what your reading.
15592 * Smileys::   Show all those happy faces the way they were meant to be shown.
15593 * Toolbar::   Click'n'drool.
15594 * XVarious::  Other XEmacsy Gnusey variables.
15595 @end menu
15596
15597
15598 @node Picons
15599 @subsection Picons
15600
15601 @iftex
15602 @iflatex
15603 \include{picons}
15604 @end iflatex
15605 @end iftex
15606
15607 So...  You want to slow down your news reader even more!  This is a
15608 good way to do so.  Its also a great way to impress people staring
15609 over your shoulder as you read news.
15610
15611 @menu
15612 * Picon Basics::           What are picons and How do I get them.
15613 * Picon Requirements::     Don't go further if you aren't using XEmacs.
15614 * Easy Picons::            Displaying Picons---the easy way.
15615 * Hard Picons::            The way you should do it.  You'll learn something.
15616 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15617 @end menu
15618
15619
15620 @node Picon Basics
15621 @subsubsection Picon Basics
15622
15623 What are Picons?  To quote directly from the Picons Web site:
15624
15625 @iftex
15626 @iflatex
15627 \margindex{}
15628 @end iflatex
15629 @end iftex
15630
15631 @quotation
15632 @dfn{Picons} is short for ``personal icons''.  They're small,
15633 constrained images used to represent users and domains on the net,
15634 organized into databases so that the appropriate image for a given
15635 e-mail address can be found.  Besides users and domains, there are picon
15636 databases for Usenet newsgroups and weather forecasts.  The picons are
15637 in either monochrome @code{XBM} format or color @code{XPM} and
15638 @code{GIF} formats.
15639 @end quotation
15640
15641 @vindex gnus-picons-piconsearch-url
15642 If you have a permanent connection to the Internet you can use Steve
15643 Kinzler's Picons Search engine by setting
15644 @code{gnus-picons-piconsearch-url} to the string @*
15645 @file{http://www.cs.indiana.edu/picons/search.html}.
15646
15647 @vindex gnus-picons-database
15648 Otherwise you need a local copy of his database.  For instructions on
15649 obtaining and installing the picons databases, point your Web browser at @*
15650 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
15651 picons to be installed into a location pointed to by
15652 @code{gnus-picons-database}.
15653
15654
15655 @node Picon Requirements
15656 @subsubsection Picon Requirements
15657
15658 To have Gnus display Picons for you, you must be running XEmacs
15659 19.13 or greater since all other versions of Emacs aren't yet able to
15660 display images.
15661
15662 Additionally, you must have @code{x} support compiled into XEmacs.  To
15663 display color picons which are much nicer than the black & white one,
15664 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
15665
15666 @vindex gnus-picons-convert-x-face
15667 If you want to display faces from @code{X-Face} headers, you should have
15668 the @code{xface} support compiled into XEmacs.  Otherwise you must have
15669 the @code{netpbm} utilities installed, or munge the
15670 @code{gnus-picons-convert-x-face} variable to use something else.
15671
15672
15673 @node Easy Picons
15674 @subsubsection Easy Picons
15675
15676 To enable displaying picons, simply put the following line in your
15677 @file{~/.gnus} file and start Gnus.
15678
15679 @lisp
15680 (setq gnus-use-picons t)
15681 (setq gnus-treat-display-picons t)
15682 @end lisp
15683
15684 and make sure @code{gnus-picons-database} points to the directory
15685 containing the Picons databases.
15686
15687 Alternatively if you want to use the web piconsearch engine add this:
15688
15689 @lisp
15690 (setq gnus-picons-piconsearch-url
15691       "http://www.cs.indiana.edu:800/piconsearch")
15692 @end lisp
15693
15694
15695 @node Hard Picons
15696 @subsubsection Hard Picons
15697
15698 @iftex
15699 @iflatex
15700 \margindex{}
15701 @end iflatex
15702 @end iftex
15703
15704 Gnus can display picons for you as you enter and leave groups and
15705 articles.  It knows how to interact with three sections of the picons
15706 database.  Namely, it can display the picons newsgroup pictures,
15707 author's face picture(s), and the authors domain.  To enable this
15708 feature, you need to select where to get the picons from, and where to
15709 display them.
15710
15711 @table @code
15712
15713 @item gnus-picons-database
15714 @vindex gnus-picons-database
15715 The location of the picons database.  Should point to a directory
15716 containing the @file{news}, @file{domains}, @file{users} (and so on)
15717 subdirectories.  This is only useful if
15718 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
15719 @file{/usr/local/faces/}.
15720
15721 @item gnus-picons-piconsearch-url
15722 @vindex gnus-picons-piconsearch-url
15723 The URL for the web picons search engine.  The only currently known
15724 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
15725 workaround network delays, icons will be fetched in the background.  If
15726 this is @code{nil} 'the default), then picons are fetched from local
15727 database indicated by @code{gnus-picons-database}.
15728
15729 @item gnus-picons-display-where
15730 @vindex gnus-picons-display-where
15731 Where the picon images should be displayed.  It is @code{picons} by
15732 default (which by default maps to the buffer @samp{*Picons*}).  Other
15733 valid places could be @code{article}, @code{summary}, or
15734 @samp{*scratch*} for all I care.  Just make sure that you've made the
15735 buffer visible using the standard Gnus window configuration
15736 routines---@pxref{Windows Configuration}.
15737
15738 @item gnus-picons-group-excluded-groups
15739 @vindex gnus-picons-group-excluded-groups
15740 Groups that are matched by this regexp won't have their group icons
15741 displayed.
15742
15743 @end table
15744
15745 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
15746 window configuration for you to include the @code{picons} buffer.
15747
15748 Now that you've made those decision, you need to add the following
15749 functions to the appropriate hooks so these pictures will get displayed
15750 at the right time.
15751
15752 @vindex gnus-picons-display-where
15753 @table @code
15754 @item gnus-article-display-picons
15755 @findex gnus-article-display-picons
15756 Looks up and displays the picons for the author and the author's domain
15757 in the @code{gnus-picons-display-where} buffer.
15758
15759 @item gnus-picons-article-display-x-face
15760 @findex gnus-article-display-picons
15761 Decodes and displays the X-Face header if present.
15762
15763 @end table
15764
15765
15766
15767 @node Picon Useless Configuration
15768 @subsubsection Picon Useless Configuration
15769
15770 @iftex
15771 @iflatex
15772 \margindex{}
15773 @end iflatex
15774 @end iftex
15775
15776 The following variables offer further control over how things are
15777 done, where things are located, and other useless stuff you really
15778 don't need to worry about.
15779
15780 @table @code
15781
15782 @item gnus-picons-news-directories
15783 @vindex gnus-picons-news-directories
15784 List of subdirectories to search in @code{gnus-picons-database} for
15785 newsgroups faces.  @code{("news")} is the default.
15786
15787 @item gnus-picons-user-directories
15788 @vindex gnus-picons-user-directories
15789 List of subdirectories to search in @code{gnus-picons-database} for user
15790 faces.  @code{("local" "users" "usenix" "misc")} is the default.
15791
15792 @item gnus-picons-domain-directories
15793 @vindex gnus-picons-domain-directories
15794 List of subdirectories to search in @code{gnus-picons-database} for
15795 domain name faces.  Defaults to @code{("domains")}.  Some people may
15796 want to add @samp{"unknown"} to this list.
15797
15798 @item gnus-picons-convert-x-face
15799 @vindex gnus-picons-convert-x-face
15800 If you don't have @code{xface} support builtin XEmacs, this is the
15801 command to use to convert the @code{X-Face} header to an X bitmap
15802 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
15803 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
15804 gnus-picons-x-face-file-name)}
15805
15806 @item gnus-picons-x-face-file-name
15807 @vindex gnus-picons-x-face-file-name
15808 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
15809 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
15810
15811 @item gnus-picons-has-modeline-p
15812 @vindex gnus-picons-has-modeline-p
15813 If you have set @code{gnus-picons-display-where} to @code{picons}, your
15814 XEmacs frame will become really cluttered.  To alleviate this a bit you
15815 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
15816 remove the mode line from the Picons buffer.  This is only useful if
15817 @code{gnus-picons-display-where} is @code{picons}.
15818
15819 @item gnus-picons-refresh-before-display
15820 @vindex gnus-picons-refresh-before-display
15821 If non-nil, display the article buffer before computing the picons.
15822 Defaults to @code{nil}.
15823
15824 @item gnus-picons-display-as-address
15825 @vindex gnus-picons-display-as-address
15826 If @code{t} display textual email addresses along with pictures.
15827 Defaults to @code{t}.
15828
15829 @item gnus-picons-file-suffixes
15830 @vindex gnus-picons-file-suffixes
15831 Ordered list of suffixes on picon file names to try.  Defaults to
15832 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
15833
15834 @item gnus-picons-setup-hook
15835 @vindex gnus-picons-setup-hook
15836 Hook run in the picon buffer, if that is displayed.
15837
15838 @item gnus-picons-display-article-move-p
15839 @vindex gnus-picons-display-article-move-p
15840 Whether to move point to first empty line when displaying picons.  This
15841 has only an effect if `gnus-picons-display-where' has value `article'.
15842
15843 If @code{nil}, display the picons in the @code{From} and
15844 @code{Newsgroups} lines.  This is the defailt.
15845
15846 @item gnus-picons-clear-cache-on-shutdown
15847 @vindex gnus-picons-clear-cache-on-shutdown
15848 Whether to clear the picons cache when exiting gnus.  Gnus caches every
15849 picons it finds while it is running.  This saves some time in the search
15850 process but eats some memory.  If this variable is set to @code{nil},
15851 Gnus will never clear the cache itself; you will have to manually call
15852 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
15853 cleared every time you exit Gnus.  Defaults to @code{t}.
15854
15855 @iftex
15856 @iflatex
15857 \margindex{}
15858 @end iflatex
15859 @end iftex
15860
15861 @end table
15862
15863 @node Smileys
15864 @subsection Smileys
15865 @cindex smileys
15866
15867 @iftex
15868 @iflatex
15869 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
15870 \input{smiley}
15871 @end iflatex
15872 @end iftex
15873
15874 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
15875 currently the only package that uses Smiley, it is documented here.
15876
15877 In short---to use Smiley in Gnus, put the following in your
15878 @file{.gnus.el} file:
15879
15880 @lisp
15881 (setq gnus-treat-display-smiley t)
15882 @end lisp
15883
15884 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
15885 the like---to pictures and displays those instead of the text smiley
15886 faces.  The conversion is controlled by a list of regexps that matches
15887 text and maps that to file names.
15888
15889 @vindex smiley-nosey-regexp-alist
15890 @vindex smiley-deformed-regexp-alist
15891 Smiley supplies two example conversion alists by default:
15892 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
15893 and so on), and @code{smiley-nosey-regexp-alist} (which matches
15894 @samp{:-)}, @samp{:-(} and so on).
15895
15896 The alist used is specified by the @code{smiley-regexp-alist} variable,
15897 which defaults to the value of @code{smiley-deformed-regexp-alist}.
15898
15899 The first item in each element is the regexp to be matched; the second
15900 element is the regexp match group that is to be replaced by the picture;
15901 and the third element is the name of the file to be displayed.
15902
15903 The following variables customize where Smiley will look for these
15904 files, as well as the color to be used and stuff:
15905
15906 @table @code
15907
15908 @item smiley-data-directory
15909 @vindex smiley-data-directory
15910 Where Smiley will look for smiley faces files.
15911
15912 @item smiley-flesh-color
15913 @vindex smiley-flesh-color
15914 Skin color.  The default is @samp{yellow}, which is really racist.
15915
15916 @item smiley-features-color
15917 @vindex smiley-features-color
15918 Color of the features of the face.  The default is @samp{black}.
15919
15920 @item smiley-tongue-color
15921 @vindex smiley-tongue-color
15922 Color of the tongue.  The default is @samp{red}.
15923
15924 @item smiley-circle-color
15925 @vindex smiley-circle-color
15926 Color of the circle around the face.  The default is @samp{black}.
15927
15928 @item smiley-mouse-face
15929 @vindex smiley-mouse-face
15930 Face used for mouse highlighting over the smiley face.
15931
15932 @end table
15933
15934
15935 @node Toolbar
15936 @subsection Toolbar
15937
15938 @table @code
15939
15940 @iftex
15941 @iflatex
15942 \margindex{}
15943 @end iflatex
15944 @end iftex
15945
15946 @item gnus-use-toolbar
15947 @vindex gnus-use-toolbar
15948 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
15949 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
15950 @code{right-toolbar}, or @code{left-toolbar}.
15951
15952 @item gnus-group-toolbar
15953 @vindex gnus-group-toolbar
15954 The toolbar in the group buffer.
15955
15956 @item gnus-summary-toolbar
15957 @vindex gnus-summary-toolbar
15958 The toolbar in the summary buffer.
15959
15960 @item gnus-summary-mail-toolbar
15961 @vindex gnus-summary-mail-toolbar
15962 The toolbar in the summary buffer of mail groups.
15963
15964 @end table
15965
15966
15967 @node XVarious
15968 @subsection Various XEmacs Variables
15969
15970 @table @code
15971 @item gnus-xmas-glyph-directory
15972 @vindex gnus-xmas-glyph-directory
15973 This is where Gnus will look for pictures.  Gnus will normally
15974 auto-detect this directory, but you may set it manually if you have an
15975 unusual directory structure.
15976
15977 @item gnus-xmas-logo-color-alist
15978 @vindex gnus-xmas-logo-color-alist
15979 This is an alist where the key is a type symbol and the values are the
15980 foreground and background color of the splash page glyph.
15981
15982 @item gnus-xmas-logo-color-style
15983 @vindex gnus-xmas-logo-color-style
15984 This is the key used to look up the color in the alist described above.
15985 Valid values include @code{flame}, @code{pine}, @code{moss},
15986 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
15987 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
15988
15989 @item gnus-xmas-modeline-glyph
15990 @vindex gnus-xmas-modeline-glyph
15991 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
15992 default.
15993
15994 @iftex
15995 @iflatex
15996 \margindex{}
15997 @end iflatex
15998 @end iftex
15999
16000 @end table
16001
16002
16003
16004
16005 @node Fuzzy Matching
16006 @section Fuzzy Matching
16007 @cindex fuzzy matching
16008
16009 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
16010 things like scoring, thread gathering and thread comparison.
16011
16012 As opposed to regular expression matching, fuzzy matching is very fuzzy.
16013 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
16014 means, and the implementation has changed over time.
16015
16016 Basically, it tries to remove all noise from lines before comparing.
16017 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
16018 out of the strings before comparing the results.  This often leads to
16019 adequate results---even when faced with strings generated by text
16020 manglers masquerading as newsreaders.
16021
16022
16023 @node Thwarting Email Spam
16024 @section Thwarting Email Spam
16025 @cindex email spam
16026 @cindex spam
16027 @cindex UCE
16028 @cindex unsolicited commercial email
16029
16030 In these last days of the Usenet, commercial vultures are hanging about
16031 and grepping through news like crazy to find email addresses they can
16032 foist off their scams and products to.  As a reaction to this, many
16033 people have started putting nonsense addresses into their @code{From}
16034 lines.  I think this is counterproductive---it makes it difficult for
16035 people to send you legitimate mail in response to things you write, as
16036 well as making it difficult to see who wrote what.  This rewriting may
16037 perhaps be a bigger menace than the unsolicited commercial email itself
16038 in the end.
16039
16040 The biggest problem I have with email spam is that it comes in under
16041 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
16042 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
16043 mail group, only to find two pyramid schemes, seven advertisements
16044 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
16045 and one mail asking me to repent and find some god.
16046
16047 This is annoying.
16048
16049 The way to deal with this is having Gnus split out all spam into a
16050 @samp{spam} mail group (@pxref{Splitting Mail}).
16051
16052 First, pick one (1) valid mail address that you can be reached at, and
16053 put it in your @code{From} header of all your news articles.  (I've
16054 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
16055 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
16056 sysadm whether your sendmail installation accepts keywords in the local
16057 part of the mail address.)
16058
16059 @lisp
16060 (setq message-default-news-headers
16061       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
16062 @end lisp
16063
16064 Then put the following split rule in @code{nnmail-split-fancy}
16065 (@pxref{Fancy Mail Splitting}):
16066
16067 @lisp
16068 (
16069  ...
16070  (to "larsi@@trym.ifi.uio.no"
16071       (| ("subject" "re:.*" "misc")
16072          ("references" ".*@@.*" "misc")
16073          "spam"))
16074  ...
16075 )
16076 @end lisp
16077
16078 This says that all mail to this address is suspect, but if it has a
16079 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
16080 header, it's probably ok.  All the rest goes to the @samp{spam} group.
16081 (This idea probably comes from Tim Pierce.)
16082
16083 In addition, many mail spammers talk directly to your @code{smtp} server
16084 and do not include your email address explicitly in the @code{To}
16085 header.  Why they do this is unknown---perhaps it's to thwart this
16086 thwarting scheme?  In any case, this is trivial to deal with---you just
16087 put anything not addressed to you in the @samp{spam} group by ending
16088 your fancy split rule in this way:
16089
16090 @lisp
16091 (
16092  ...
16093  (to "larsi" "misc")
16094  "spam")
16095 @end lisp
16096
16097 In my experience, this will sort virtually everything into the right
16098 group.  You still have to check the @samp{spam} group from time to time to
16099 check for legitimate mail, though.  If you feel like being a good net
16100 citizen, you can even send off complaints to the proper authorities on
16101 each unsolicited commercial email---at your leisure.
16102
16103 If you are also a lazy net citizen, you will probably prefer complaining
16104 automatically with the @file{gnus-junk.el} package, available FOR FREE
16105 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
16106 Since most e-mail spam is sent automatically, this may reconcile the
16107 cosmic balance somewhat.
16108
16109 This works for me.  It allows people an easy way to contact me (they can
16110 just press @kbd{r} in the usual way), and I'm not bothered at all with
16111 spam.  It's a win-win situation.  Forging @code{From} headers to point
16112 to non-existent domains is yucky, in my opinion.
16113
16114
16115 @node Various Various
16116 @section Various Various
16117 @cindex mode lines
16118 @cindex highlights
16119
16120 @table @code
16121
16122 @item gnus-home-directory
16123 All Gnus path variables will be initialized from this variable, which
16124 defaults to @file{~/}.
16125
16126 @item gnus-directory
16127 @vindex gnus-directory
16128 Most Gnus storage path variables will be initialized from this variable,
16129 which defaults to the @samp{SAVEDIR} environment variable, or
16130 @file{~/News/} if that variable isn't set.
16131
16132 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
16133 This means that other directory variables that are initialized from this
16134 variable won't be set properly if you set this variable in
16135 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
16136
16137 @item gnus-default-directory
16138 @vindex gnus-default-directory
16139 Not related to the above variable at all---this variable says what the
16140 default directory of all Gnus buffers should be.  If you issue commands
16141 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
16142 default directory.  If this variable is @code{nil} (which is the
16143 default), the default directory will be the default directory of the
16144 buffer you were in when you started Gnus.
16145
16146 @item gnus-verbose
16147 @vindex gnus-verbose
16148 This variable is an integer between zero and ten.  The higher the value,
16149 the more messages will be displayed.  If this variable is zero, Gnus
16150 will never flash any messages, if it is seven (which is the default),
16151 most important messages will be shown, and if it is ten, Gnus won't ever
16152 shut up, but will flash so many messages it will make your head swim.
16153
16154 @item gnus-verbose-backends
16155 @vindex gnus-verbose-backends
16156 This variable works the same way as @code{gnus-verbose}, but it applies
16157 to the Gnus backends instead of Gnus proper.
16158
16159 @item nnheader-max-head-length
16160 @vindex nnheader-max-head-length
16161 When the backends read straight heads of articles, they all try to read
16162 as little as possible.  This variable (default 4096) specifies
16163 the absolute max length the backends will try to read before giving up
16164 on finding a separator line between the head and the body.  If this
16165 variable is @code{nil}, there is no upper read bound.  If it is
16166 @code{t}, the backends won't try to read the articles piece by piece,
16167 but read the entire articles.  This makes sense with some versions of
16168 @code{ange-ftp} or @code{efs}.
16169
16170 @item nnheader-head-chop-length
16171 @vindex nnheader-head-chop-length
16172 This variable (default 2048) says how big a piece of each article to
16173 read when doing the operation described above.
16174
16175 @item nnheader-file-name-translation-alist
16176 @vindex nnheader-file-name-translation-alist
16177 @cindex file names
16178 @cindex invalid characters in file names
16179 @cindex characters in file names
16180 This is an alist that says how to translate characters in file names.
16181 For instance, if @samp{:} is invalid as a file character in file names
16182 on your system (you OS/2 user you), you could say something like:
16183
16184 @lisp
16185 (setq nnheader-file-name-translation-alist
16186       '((?: . ?_)))
16187 @end lisp
16188
16189 In fact, this is the default value for this variable on OS/2 and MS
16190 Windows (phooey) systems.
16191
16192 @item gnus-hidden-properties
16193 @vindex gnus-hidden-properties
16194 This is a list of properties to use to hide ``invisible'' text.  It is
16195 @code{(invisible t intangible t)} by default on most systems, which
16196 makes invisible text invisible and intangible.
16197
16198 @item gnus-parse-headers-hook
16199 @vindex gnus-parse-headers-hook
16200 A hook called before parsing headers.  It can be used, for instance, to
16201 gather statistics on the headers fetched, or perhaps you'd like to prune
16202 some headers.  I don't see why you'd want that, though.
16203
16204 @item gnus-shell-command-separator
16205 @vindex gnus-shell-command-separator
16206 String used to separate two shell commands.  The default is @samp{;}.
16207
16208
16209 @end table
16210
16211
16212 @node The End
16213 @chapter The End
16214
16215 Well, that's the manual---you can get on with your life now.  Keep in
16216 touch.  Say hello to your cats from me.
16217
16218 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
16219
16220 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16221
16222 @quotation
16223 @strong{Te Deum}
16224
16225 @sp 1
16226 Not because of victories @*
16227 I sing,@*
16228 having none,@*
16229 but for the common sunshine,@*
16230 the breeze,@*
16231 the largess of the spring.
16232
16233 @sp 1
16234 Not for victory@*
16235 but for the day's work done@*
16236 as well as I was able;@*
16237 not for a seat upon the dais@*
16238 but at the common table.@*
16239 @end quotation
16240
16241
16242 @node Appendices
16243 @chapter Appendices
16244
16245 @menu
16246 * History::                        How Gnus got where it is today.
16247 * Terminology::                    We use really difficult, like, words here.
16248 * Customization::                  Tailoring Gnus to your needs.
16249 * Troubleshooting::                What you might try if things do not work.
16250 * Gnus Reference Guide::           Rilly, rilly technical stuff.
16251 * Emacs for Heathens::             A short introduction to Emacsian terms.
16252 * Frequently Asked Questions::     A question-and-answer session.
16253 @end menu
16254
16255
16256 @node History
16257 @section History
16258
16259 @cindex history
16260 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
16261 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16262
16263 If you want to investigate the person responsible for this outrage, you
16264 can point your (feh!) web browser to
16265 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
16266 distribution point for the new and spiffy versions of Gnus, and is known
16267 as The Site That Destroys Newsrcs And Drives People Mad.
16268
16269 During the first extended alpha period of development, the new Gnus was
16270 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
16271 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16272 (Besides, the ``Gnus'' in this abbreviation should probably be
16273 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16274 appropriate name, don't you think?)
16275
16276 In any case, after spending all that energy on coming up with a new and
16277 spunky name, we decided that the name was @emph{too} spunky, so we
16278 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
16279 ``@sc{gnus}''.  New vs. old.
16280
16281 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16282 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16283 plus 15 Gnus 5.0 releases).
16284
16285 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16286 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16287
16288 On July 28th 1996 work on Red Gnus was begun, and it was released on
16289 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16290
16291 On September 13th 1997, Quassia Gnus was started and lasted 37
16292 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
16293
16294 If you happen upon a version of Gnus that has a prefixed name --
16295 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16296 don't panic.  Don't let it know that you're frightened.  Back away.
16297 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
16298 out of its reach.  Find a proper released version of Gnus and snuggle up
16299 to that instead.
16300
16301 @menu
16302 * Why?::                What's the point of Gnus?
16303 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
16304 * Conformity::          Gnus tries to conform to all standards.
16305 * Emacsen::             Gnus can be run on a few modern Emacsen.
16306 * Contributors::        Oodles of people.
16307 * New Features::        Pointers to some of the new stuff in Gnus.
16308 * Newest Features::     Features so new that they haven't been written yet.
16309 @end menu
16310
16311
16312 @node Why?
16313 @subsection Why?
16314
16315 What's the point of Gnus?
16316
16317 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16318 newsreader, that lets you do anything you can think of.  That was my
16319 original motivation, but while working on Gnus, it has become clear to
16320 me that this generation of newsreaders really belong in the stone age.
16321 Newsreaders haven't developed much since the infancy of the net.  If the
16322 volume continues to rise with the current rate of increase, all current
16323 newsreaders will be pretty much useless.  How do you deal with
16324 newsgroups that have thousands of new articles each day?  How do you
16325 keep track of millions of people who post?
16326
16327 Gnus offers no real solutions to these questions, but I would very much
16328 like to see Gnus being used as a testing ground for new methods of
16329 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
16330 to separate the newsreader from the backends, Gnus now offers a simple
16331 interface for anybody who wants to write new backends for fetching mail
16332 and news from different sources.  I have added hooks for customizations
16333 everywhere I could imagine it being useful.  By doing so, I'm inviting
16334 every one of you to explore and invent.
16335
16336 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16337 @kbd{C-u 100 M-x all-hail-xemacs}.
16338
16339
16340 @node Compatibility
16341 @subsection Compatibility
16342
16343 @cindex compatibility
16344 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
16345 bindings have been kept.  More key bindings have been added, of course,
16346 but only in one or two obscure cases have old bindings been changed.
16347
16348 Our motto is:
16349 @quotation
16350 @cartouche
16351 @center In a cloud bones of steel.
16352 @end cartouche
16353 @end quotation
16354
16355 All commands have kept their names.  Some internal functions have changed
16356 their names.
16357
16358 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16359 Articles}.
16360
16361 One major compatibility question is the presence of several summary
16362 buffers.  All variables relevant while reading a group are
16363 buffer-local to the summary buffer they belong in.  Although many
16364 important variables have their values copied into their global
16365 counterparts whenever a command is executed in the summary buffer, this
16366 change might lead to incorrect values being used unless you are careful.
16367
16368 All code that relies on knowledge of @sc{gnus} internals will probably
16369 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
16370 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
16371 maintains a hash table that points to the entries in this alist (which
16372 speeds up many functions), and changing the alist directly will lead to
16373 peculiar results.
16374
16375 @cindex hilit19
16376 @cindex highlighting
16377 Old hilit19 code does not work at all.  In fact, you should probably
16378 remove all hilit code from all Gnus hooks
16379 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16380 Gnus provides various integrated functions for highlighting.  These are
16381 faster and more accurate.  To make life easier for everybody, Gnus will
16382 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
16383 Away!
16384
16385 Packages like @code{expire-kill} will no longer work.  As a matter of
16386 fact, you should probably remove all old @sc{gnus} packages (and other
16387 code) when you start using Gnus.  More likely than not, Gnus already
16388 does what you have written code to make @sc{gnus} do.  (Snicker.)
16389
16390 Even though old methods of doing things are still supported, only the
16391 new methods are documented in this manual.  If you detect a new method of
16392 doing something while reading this manual, that does not mean you have
16393 to stop doing it the old way.
16394
16395 Gnus understands all @sc{gnus} startup files.
16396
16397 @kindex M-x gnus-bug
16398 @findex gnus-bug
16399 @cindex reporting bugs
16400 @cindex bugs
16401 Overall, a casual user who hasn't written much code that depends on
16402 @sc{gnus} internals should suffer no problems.  If problems occur,
16403 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16404
16405 @vindex gnus-bug-create-help-buffer
16406 If you are in the habit of sending bug reports @emph{very} often, you
16407 may find the helpful help buffer annoying after a while.  If so, set
16408 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16409 up at you.
16410
16411
16412 @node Conformity
16413 @subsection Conformity
16414
16415 No rebels without a clue here, ma'am.  We conform to all standards known
16416 to (wo)man.  Except for those standards and/or conventions we disagree
16417 with, of course.
16418
16419 @table @strong
16420
16421 @item RFC 822
16422 @cindex RFC 822
16423 There are no known breaches of this standard.
16424
16425 @item RFC 1036
16426 @cindex RFC 1036
16427 There are no known breaches of this standard, either.
16428
16429 @item Son-of-RFC 1036
16430 @cindex Son-of-RFC 1036
16431 We do have some breaches to this one.
16432
16433 @table @emph
16434
16435 @item X-Newsreader
16436 @itemx User-Agent
16437 These are considered to be ``vanity headers'', while I consider them
16438 to be consumer information.  After seeing so many badly formatted
16439 articles coming from @code{tin} and @code{Netscape} I know not to use
16440 either of those for posting articles.  I would not have known that if
16441 it wasn't for the @code{X-Newsreader} header.
16442 @end table
16443
16444 @item USEFOR
16445 @cindex USEFOR
16446 USEFOR is an IETF working group writing a successor to RFC 1036, based
16447 on Son-of-RFC 1036.  They have produced a number of drafts proposing
16448 various changes to the format of news articles.  The Gnus towers will
16449 look into implementing the changes when the draft is accepted as an RFC.
16450
16451 @end table
16452
16453 If you ever notice Gnus acting non-compliant with regards to the texts
16454 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16455 know.
16456
16457
16458 @node Emacsen
16459 @subsection Emacsen
16460 @cindex Emacsen
16461 @cindex XEmacs
16462 @cindex Mule
16463 @cindex Emacs
16464
16465 Gnus should work on :
16466
16467 @itemize @bullet
16468
16469 @item
16470 Emacs 20.3 and up.
16471
16472 @item
16473 XEmacs 20.4 and up.
16474
16475 @end itemize
16476
16477 This Gnus version will absolutely not work on any Emacsen older than
16478 that.  Not reliably, at least.  Older versions of Gnus may work on older
16479 Emacs versions.
16480
16481 There are some vague differences between Gnus on the various
16482 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16483 other than that, things should look pretty much the same under all
16484 Emacsen.
16485
16486
16487 @node Contributors
16488 @subsection Contributors
16489 @cindex contributors
16490
16491 The new Gnus version couldn't have been done without the help of all the
16492 people on the (ding) mailing list.  Every day for over a year I have
16493 gotten billions of nice bug reports from them, filling me with joy,
16494 every single one of them.  Smooches.  The people on the list have been
16495 tried beyond endurance, what with my ``oh, that's a neat idea <type
16496 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16497 work at all <type type>, yup, I'll ship that one off right away <ship
16498 off> no, wait, that absolutely does not work'' policy for releases.
16499 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
16500 ``worser''? ``much worser''?  ``worsest''?)
16501
16502 I would like to take this opportunity to thank the Academy for...  oops,
16503 wrong show.
16504
16505 @itemize @bullet
16506
16507 @item
16508 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16509
16510 @item
16511 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16512 well as numerous other things).
16513
16514 @item
16515 Luis Fernandes---design and graphics.
16516
16517 @item
16518 Erik Naggum---help, ideas, support, code and stuff.
16519
16520 @item
16521 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
16522 connected with @sc{mime} and other types of en/decoding.
16523
16524 @item
16525 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16526 @dfn{picons} (@pxref{Picons}).
16527
16528 @item
16529 Kim-Minh Kaplan---further work on the picon code.
16530
16531 @item
16532 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16533 (@pxref{GroupLens}).
16534
16535 @item
16536 Sudish Joseph---innumerable bug fixes.
16537
16538 @item
16539 Ilja Weis---@file{gnus-topic.el}.
16540
16541 @item
16542 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16543
16544 @item
16545 Vladimir Alexiev---the refcard and reference booklets.
16546
16547 @item
16548 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16549 distribution by Felix Lee and JWZ.
16550
16551 @item
16552 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16553
16554 @item
16555 Peter Mutsaers---orphan article scoring code.
16556
16557 @item
16558 Ken Raeburn---POP mail support.
16559
16560 @item
16561 Hallvard B Furuseth---various bits and pieces, especially dealing with
16562 .newsrc files.
16563
16564 @item
16565 Brian Edmonds---@file{gnus-bbdb.el}.
16566
16567 @item
16568 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16569
16570 @item
16571 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16572
16573 @item
16574 François Pinard---many, many interesting and thorough bug reports, as
16575 well as autoconf support.
16576
16577 @end itemize
16578
16579 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16580 Borges, and Jost Krieger proof-reading parts of the manual.
16581
16582 The following people have contributed many patches and suggestions:
16583
16584 Christopher Davis,
16585 Andrew Eskilsson,
16586 Kai Grossjohann,
16587 David KÃ¥gedal,
16588 Richard Pieri,
16589 Fabrice Popineau,
16590 Daniel Quinlan,
16591 Jason L. Tibbitts, III,
16592 and
16593 Jack Vinson.
16594
16595 Also thanks to the following for patches and stuff:
16596
16597 Jari Aalto,
16598 Adrian Aichner,
16599 Vladimir Alexiev,
16600 Russ Allbery,
16601 Peter Arius,
16602 Matt Armstrong,
16603 Marc Auslander,
16604 Miles Bader,
16605 Frank Bennett,
16606 Robert Bihlmeyer,
16607 Chris Bone,
16608 Mark Borges,
16609 Mark Boyns,
16610 Lance A. Brown,
16611 Kees de Bruin,
16612 Martin Buchholz,
16613 Joe Buehler,
16614 Kevin Buhr,
16615 Alastair Burt,
16616 Joao Cachopo,
16617 Zlatko Calusic,
16618 Massimo Campostrini,
16619 Castor,
16620 David Charlap,
16621 Dan Christensen,
16622 Kevin Christian,
16623 Michael R. Cook,
16624 Glenn Coombs,
16625 Frank D. Cringle,
16626 Geoffrey T. Dairiki,
16627 Andre Deparade,
16628 Ulrik Dickow,
16629 Dave Disser,
16630 Rui-Tao Dong, @c ?
16631 Joev Dubach,
16632 Michael Welsh Duggan,
16633 Dave Edmondson,
16634 Paul Eggert,
16635 Karl Eichwalder,
16636 Enami Tsugutomo, @c Enami
16637 Michael Ernst,
16638 Luc Van Eycken,
16639 Sam Falkner,
16640 Nelson Jose dos Santos Ferreira,
16641 Sigbjorn Finne,
16642 Paul Fisher,
16643 Decklin Foster,
16644 Gary D. Foster,
16645 Paul Franklin,
16646 Guy Geens,
16647 Arne Georg Gleditsch,
16648 David S. Goldberg,
16649 Michelangelo Grigni,
16650 Dale Hagglund,
16651 D. Hall,
16652 Magnus Hammerin,
16653 Kenichi Handa, @c Handa
16654 Raja R. Harinath,
16655 Yoshiki Hayashi, @c ?
16656 P. E. Jareth Hein,
16657 Hisashige Kenji, @c Hisashige
16658 Marc Horowitz,
16659 Gunnar Horrigmo,
16660 Richard Hoskins,
16661 Brad Howes,
16662 François Felix Ingrand,
16663 Ishikawa Ichiro, @c Ishikawa
16664 Lee Iverson,
16665 Iwamuro Motonori, @c Iwamuro
16666 Rajappa Iyer,
16667 Andreas Jaeger,
16668 Randell Jesup,
16669 Fred Johansen,
16670 Gareth Jones,
16671 Simon Josefsson,
16672 Greg Klanderman,
16673 Karl Kleinpaste,
16674 Peter Skov Knudsen,
16675 Shuhei Kobayashi, @c Kobayashi
16676 Koseki Yoshinori, @c Koseki
16677 Thor Kristoffersen,
16678 Jens Lautenbacher,
16679 Martin Larose,
16680 Seokchan Lee, @c Lee
16681 Joerg Lenneis,
16682 Carsten Leonhardt,
16683 James LewisMoss,
16684 Christian Limpach,
16685 Markus Linnala,
16686 Dave Love,
16687 Mike McEwan,
16688 Tonny Madsen,
16689 Shlomo Mahlab,
16690 Nat Makarevitch,
16691 Istvan Marko,
16692 David Martin,
16693 Jason R. Mastaler,
16694 Gordon Matzigkeit,
16695 Timo Metzemakers,
16696 Richard Mlynarik,
16697 Lantz Moore,
16698 Morioka Tomohiko, @c Morioka
16699 Erik Toubro Nielsen,
16700 Hrvoje Niksic,
16701 Andy Norman,
16702 Fred Oberhauser,
16703 C. R. Oldham,
16704 Alexandre Oliva,
16705 Ken Olstad,
16706 Masaharu Onishi, @c Onishi
16707 Hideki Ono, @c Ono
16708 William Perry,
16709 Stephen Peters,
16710 Jens-Ulrik Holger Petersen,
16711 Ulrich Pfeifer,
16712 Matt Pharr,
16713 Andy Piper,
16714 John McClary Prevost,
16715 Bill Pringlemeir,
16716 Mike Pullen,
16717 Jim Radford,
16718 Colin Rafferty,
16719 Lasse Rasinen,
16720 Lars Balker Rasmussen,
16721 Joe Reiss,
16722 Renaud Rioboo,
16723 Roland B. Roberts,
16724 Bart Robinson,
16725 Christian von Roques,
16726 Markus Rost,
16727 Jason Rumney,
16728 Wolfgang Rupprecht,
16729 Jay Sachs,
16730 Dewey M. Sasser,
16731 Conrad Sauerwald,
16732 Loren Schall,
16733 Dan Schmidt,
16734 Ralph Schleicher,
16735 Philippe Schnoebelen,
16736 Andreas Schwab,
16737 Randal L. Schwartz,
16738 Justin Sheehy,
16739 Danny Siu,
16740 Matt Simmons,
16741 Paul D. Smith,
16742 Jeff Sparkes,
16743 Toby Speight,
16744 Michael Sperber,
16745 Darren Stalder,
16746 Richard Stallman,
16747 Greg Stark,
16748 Sam Steingold,
16749 Jonas Steverud,
16750 Paul Stodghill,
16751 Kurt Swanson,
16752 Samuel Tardieu,
16753 Teddy,
16754 Chuck Thompson,
16755 Philippe Troin,
16756 James Troup,
16757 Trung Tran-Duc,
16758 Aaron M. Ucko,
16759 Aki Vehtari,
16760 Didier Verna,
16761 Jan Vroonhof,
16762 Stefan Waldherr,
16763 Pete Ware,
16764 Barry A. Warsaw,
16765 Christoph Wedler,
16766 Joe Wells,
16767 Lee Willis,
16768 Katsumi Yamaoka @c Yamaoka
16769 and
16770 Lloyd Zusman.
16771
16772
16773 For a full overview of what each person has done, the ChangeLogs
16774 included in the Gnus alpha distributions should give ample reading
16775 (550kB and counting).
16776
16777 Apologies to everybody that I've forgotten, of which there are many, I'm
16778 sure.
16779
16780 Gee, that's quite a list of people.  I guess that must mean that there
16781 actually are people who are using Gnus.  Who'd'a thunk it!
16782
16783
16784 @node New Features
16785 @subsection New Features
16786 @cindex new features
16787
16788 @menu
16789 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
16790 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
16791 * Red Gnus::           Third time best---Gnus 5.4/5.5.
16792 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
16793 @end menu
16794
16795 These lists are, of course, just @emph{short} overviews of the
16796 @emph{most} important new features.  No, really.  There are tons more.
16797 Yes, we have feeping creaturism in full effect.
16798
16799
16800 @node ding Gnus
16801 @subsubsection (ding) Gnus
16802
16803 New features in Gnus 5.0/5.1:
16804
16805 @itemize @bullet
16806
16807 @item
16808 The look of all buffers can be changed by setting format-like variables
16809 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
16810
16811 @item
16812 Local spool and several @sc{nntp} servers can be used at once
16813 (@pxref{Select Methods}).
16814
16815 @item
16816 You can combine groups into virtual groups (@pxref{Virtual Groups}).
16817
16818 @item
16819 You can read a number of different mail formats (@pxref{Getting Mail}).
16820 All the mail backends implement a convenient mail expiry scheme
16821 (@pxref{Expiring Mail}).
16822
16823 @item
16824 Gnus can use various strategies for gathering threads that have lost
16825 their roots (thereby gathering loose sub-threads into one thread) or it
16826 can go back and retrieve enough headers to build a complete thread
16827 (@pxref{Customizing Threading}).
16828
16829 @item
16830 Killed groups can be displayed in the group buffer, and you can read
16831 them as well (@pxref{Listing Groups}).
16832
16833 @item
16834 Gnus can do partial group updates---you do not have to retrieve the
16835 entire active file just to check for new articles in a few groups
16836 (@pxref{The Active File}).
16837
16838 @item
16839 Gnus implements a sliding scale of subscribedness to groups
16840 (@pxref{Group Levels}).
16841
16842 @item
16843 You can score articles according to any number of criteria
16844 (@pxref{Scoring}).  You can even get Gnus to find out how to score
16845 articles for you (@pxref{Adaptive Scoring}).
16846
16847 @item
16848 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
16849 manner, so it should be difficult to lose much data on what you have
16850 read if your machine should go down (@pxref{Auto Save}).
16851
16852 @item
16853 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
16854 the @file{.emacs} file.
16855
16856 @item
16857 You can set the process mark on both groups and articles and perform
16858 operations on all the marked items (@pxref{Process/Prefix}).
16859
16860 @item
16861 You can grep through a subset of groups and create a group from the
16862 results (@pxref{Kibozed Groups}).
16863
16864 @item
16865 You can list subsets of groups according to, well, anything
16866 (@pxref{Listing Groups}).
16867
16868 @item
16869 You can browse foreign servers and subscribe to groups from those
16870 servers (@pxref{Browse Foreign Server}).
16871
16872 @item
16873 Gnus can fetch articles, asynchronously, on a second connection to the
16874 server (@pxref{Asynchronous Fetching}).
16875
16876 @item
16877 You can cache articles locally (@pxref{Article Caching}).
16878
16879 @item
16880 The uudecode functions have been expanded and generalized
16881 (@pxref{Decoding Articles}).
16882
16883 @item
16884 You can still post uuencoded articles, which was a little-known feature
16885 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
16886
16887 @item
16888 Fetching parents (and other articles) now actually works without
16889 glitches (@pxref{Finding the Parent}).
16890
16891 @item
16892 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
16893
16894 @item
16895 Digests (and other files) can be used as the basis for groups
16896 (@pxref{Document Groups}).
16897
16898 @item
16899 Articles can be highlighted and customized (@pxref{Customizing
16900 Articles}).
16901
16902 @item
16903 URLs and other external references can be buttonized (@pxref{Article
16904 Buttons}).
16905
16906 @item
16907 You can do lots of strange stuff with the Gnus window & frame
16908 configuration (@pxref{Windows Configuration}).
16909
16910 @item
16911 You can click on buttons instead of using the keyboard
16912 (@pxref{Buttons}).
16913
16914 @end itemize
16915
16916
16917 @node September Gnus
16918 @subsubsection September Gnus
16919
16920 @iftex
16921 @iflatex
16922 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
16923 @end iflatex
16924 @end iftex
16925
16926 New features in Gnus 5.2/5.3:
16927
16928 @itemize @bullet
16929
16930 @item
16931 A new message composition mode is used.  All old customization variables
16932 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
16933 now obsolete.
16934
16935 @item
16936 Gnus is now able to generate @dfn{sparse} threads---threads where
16937 missing articles are represented by empty nodes (@pxref{Customizing
16938 Threading}).
16939
16940 @lisp
16941 (setq gnus-build-sparse-threads 'some)
16942 @end lisp
16943
16944 @item
16945 Outgoing articles are stored on a special archive server
16946 (@pxref{Archived Messages}).
16947
16948 @item
16949 Partial thread regeneration now happens when articles are
16950 referred.
16951
16952 @item
16953 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
16954
16955 @item
16956 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
16957
16958 @item
16959 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
16960
16961 @lisp
16962 (setq gnus-use-trees t)
16963 @end lisp
16964
16965 @item
16966 An @code{nn}-like pick-and-read minor mode is available for the summary
16967 buffers (@pxref{Pick and Read}).
16968
16969 @lisp
16970 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
16971 @end lisp
16972
16973 @item
16974 In binary groups you can use a special binary minor mode (@pxref{Binary
16975 Groups}).
16976
16977 @item
16978 Groups can be grouped in a folding topic hierarchy (@pxref{Group
16979 Topics}).
16980
16981 @lisp
16982 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
16983 @end lisp
16984
16985 @item
16986 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
16987
16988 @item
16989 Groups can now have a score, and bubbling based on entry frequency
16990 is possible (@pxref{Group Score}).
16991
16992 @lisp
16993 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
16994 @end lisp
16995
16996 @item
16997 Groups can be process-marked, and commands can be performed on
16998 groups of groups (@pxref{Marking Groups}).
16999
17000 @item
17001 Caching is possible in virtual groups.
17002
17003 @item
17004 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
17005 news batches, ClariNet briefs collections, and just about everything
17006 else (@pxref{Document Groups}).
17007
17008 @item
17009 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
17010 (@pxref{SOUP}).
17011
17012 @item
17013 The Gnus cache is much faster.
17014
17015 @item
17016 Groups can be sorted according to many criteria (@pxref{Sorting
17017 Groups}).
17018
17019 @item
17020 New group parameters have been introduced to set list-addresses and
17021 expiry times (@pxref{Group Parameters}).
17022
17023 @item
17024 All formatting specs allow specifying faces to be used
17025 (@pxref{Formatting Fonts}).
17026
17027 @item
17028 There are several more commands for setting/removing/acting on process
17029 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
17030
17031 @item
17032 The summary buffer can be limited to show parts of the available
17033 articles based on a wide range of criteria.  These commands have been
17034 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
17035
17036 @item
17037 Articles can be made persistent with the @kbd{*} command
17038 (@pxref{Persistent Articles}).
17039
17040 @item
17041 All functions for hiding article elements are now toggles.
17042
17043 @item
17044 Article headers can be buttonized (@pxref{Article Washing}).
17045
17046 @item
17047 All mail backends support fetching articles by @code{Message-ID}.
17048
17049 @item
17050 Duplicate mail can now be treated properly (@pxref{Duplicates}).
17051
17052 @item
17053 All summary mode commands are available directly from the article
17054 buffer (@pxref{Article Keymap}).
17055
17056 @item
17057 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
17058 Configuration}).
17059
17060 @item
17061 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
17062 @iftex
17063 @iflatex
17064 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
17065 @end iflatex
17066 @end iftex
17067
17068 @item
17069 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
17070
17071 @lisp
17072 (setq gnus-use-nocem t)
17073 @end lisp
17074
17075 @item
17076 Groups can be made permanently visible (@pxref{Listing Groups}).
17077
17078 @lisp
17079 (setq gnus-permanently-visible-groups "^nnml:")
17080 @end lisp
17081
17082 @item
17083 Many new hooks have been introduced to make customizing easier.
17084
17085 @item
17086 Gnus respects the @code{Mail-Copies-To} header.
17087
17088 @item
17089 Threads can be gathered by looking at the @code{References} header
17090 (@pxref{Customizing Threading}).
17091
17092 @lisp
17093 (setq gnus-summary-thread-gathering-function
17094       'gnus-gather-threads-by-references)
17095 @end lisp
17096
17097 @item
17098 Read articles can be stored in a special backlog buffer to avoid
17099 refetching (@pxref{Article Backlog}).
17100
17101 @lisp
17102 (setq gnus-keep-backlog 50)
17103 @end lisp
17104
17105 @item
17106 A clean copy of the current article is always stored in a separate
17107 buffer to allow easier treatment.
17108
17109 @item
17110 Gnus can suggest where to save articles (@pxref{Saving Articles}).
17111
17112 @item
17113 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
17114 Articles}).
17115
17116 @lisp
17117 (setq gnus-prompt-before-saving t)
17118 @end lisp
17119
17120 @item
17121 @code{gnus-uu} can view decoded files asynchronously while fetching
17122 articles (@pxref{Other Decode Variables}).
17123
17124 @lisp
17125 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
17126 @end lisp
17127
17128 @item
17129 Filling in the article buffer now works properly on cited text
17130 (@pxref{Article Washing}).
17131
17132 @item
17133 Hiding cited text adds buttons to toggle hiding, and how much
17134 cited text to hide is now customizable (@pxref{Article Hiding}).
17135
17136 @lisp
17137 (setq gnus-cited-lines-visible 2)
17138 @end lisp
17139
17140 @item
17141 Boring headers can be hidden (@pxref{Article Hiding}).
17142
17143 @item
17144 Default scoring values can now be set from the menu bar.
17145
17146 @item
17147 Further syntax checking of outgoing articles have been added.
17148
17149 @end itemize
17150
17151
17152 @node Red Gnus
17153 @subsubsection Red Gnus
17154
17155 New features in Gnus 5.4/5.5:
17156
17157 @iftex
17158 @iflatex
17159 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
17160 @end iflatex
17161 @end iftex
17162
17163 @itemize @bullet
17164
17165 @item
17166 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
17167
17168 @item
17169 Article prefetching functionality has been moved up into
17170 Gnus (@pxref{Asynchronous Fetching}).
17171
17172 @item
17173 Scoring can now be performed with logical operators like @code{and},
17174 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
17175 Scoring}).
17176
17177 @item
17178 Article washing status can be displayed in the
17179 article mode line (@pxref{Misc Article}).
17180
17181 @item
17182 @file{gnus.el} has been split into many smaller files.
17183
17184 @item
17185 Suppression of duplicate articles based on Message-ID can be done
17186 (@pxref{Duplicate Suppression}).
17187
17188 @lisp
17189 (setq gnus-suppress-duplicates t)
17190 @end lisp
17191
17192 @item
17193 New variables for specifying what score and adapt files are to be
17194 considered home score and adapt files (@pxref{Home Score File}) have
17195 been added.
17196
17197 @item
17198 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17199 Server Internals}).
17200
17201 @item
17202 Groups can inherit group parameters from parent topics (@pxref{Topic
17203 Parameters}).
17204
17205 @item
17206 Article editing has been revamped and is now actually usable.
17207
17208 @item
17209 Signatures can be recognized in more intelligent fashions
17210 (@pxref{Article Signature}).
17211
17212 @item
17213 Summary pick mode has been made to look more @code{nn}-like.  Line
17214 numbers are displayed and the @kbd{.} command can be used to pick
17215 articles (@code{Pick and Read}).
17216
17217 @item
17218 Commands for moving the @file{.newsrc.eld} from one server to
17219 another have been added (@pxref{Changing Servers}).
17220
17221 @item
17222 There's a way now to specify that ``uninteresting'' fields be suppressed
17223 when generating lines in buffers (@pxref{Advanced Formatting}).
17224
17225 @item
17226 Several commands in the group buffer can be undone with @kbd{M-C-_}
17227 (@pxref{Undo}).
17228
17229 @item
17230 Scoring can be done on words using the new score type @code{w}
17231 (@pxref{Score File Format}).
17232
17233 @item
17234 Adaptive scoring can be done on a Subject word-by-word basis
17235 (@pxref{Adaptive Scoring}).
17236
17237 @lisp
17238 (setq gnus-use-adaptive-scoring '(word))
17239 @end lisp
17240
17241 @item
17242 Scores can be decayed (@pxref{Score Decays}).
17243
17244 @lisp
17245 (setq gnus-decay-scores t)
17246 @end lisp
17247
17248 @item
17249 Scoring can be performed using a regexp on the Date header.  The Date is
17250 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17251
17252 @item
17253 A new command has been added to remove all data on articles from
17254 the native server (@pxref{Changing Servers}).
17255
17256 @item
17257 A new command for reading collections of documents
17258 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17259 (@pxref{Really Various Summary Commands}).
17260
17261 @item
17262 Process mark sets can be pushed and popped (@pxref{Setting Process
17263 Marks}).
17264
17265 @item
17266 A new mail-to-news backend makes it possible to post even when the NNTP
17267 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17268
17269 @item
17270 A new backend for reading searches from Web search engines
17271 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17272 (@pxref{Web Searches}).
17273
17274 @item
17275 Groups inside topics can now be sorted using the standard sorting
17276 functions, and each topic can be sorted independently (@pxref{Topic
17277 Sorting}).
17278
17279 @item
17280 Subsets of the groups can be sorted independently (@code{Sorting
17281 Groups}).
17282
17283 @item
17284 Cached articles can be pulled into the groups (@pxref{Summary Generation
17285 Commands}).
17286 @iftex
17287 @iflatex
17288 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17289 @end iflatex
17290 @end iftex
17291
17292 @item
17293 Score files are now applied in a more reliable order (@pxref{Score
17294 Variables}).
17295
17296 @item
17297 Reports on where mail messages end up can be generated (@pxref{Splitting
17298 Mail}).
17299
17300 @item
17301 More hooks and functions have been added to remove junk from incoming
17302 mail before saving the mail (@pxref{Washing Mail}).
17303
17304 @item
17305 Emphasized text can be properly fontisized:
17306
17307 @end itemize
17308
17309
17310 @node Quassia Gnus
17311 @subsubsection Quassia Gnus
17312
17313 New features in Gnus 5.6:
17314
17315 @itemize @bullet
17316
17317 @item
17318 New functionality for using Gnus as an offline newsreader has been
17319 added.  A plethora of new commands and modes have been added.  See
17320 @pxref{Gnus Unplugged} for the full story.
17321
17322 @item
17323  The @code{nndraft} backend has returned, but works differently than
17324 before.  All Message buffers are now also articles in the @code{nndraft}
17325 group, which is created automatically.
17326
17327 @item
17328 @code{gnus-alter-header-function} can now be used to alter header
17329 values.
17330
17331 @item
17332  @code{gnus-summary-goto-article} now accept Message-ID's.
17333
17334 @item
17335  A new Message command for deleting text in the body of a message
17336 outside the region: @kbd{C-c C-v}.
17337
17338 @item
17339  You can now post to component group in @code{nnvirtual} groups with
17340 @kbd{C-u C-c C-c}.
17341
17342 @item
17343  @code{nntp-rlogin-program}---new variable to ease customization.
17344
17345 @item
17346  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17347 re-highlighting of the article buffer.
17348
17349 @item
17350  New element in @code{gnus-boring-article-headers}---@code{long-to}.
17351
17352 @item
17353  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
17354 Prefixes" in the Gnus manual for details.
17355
17356 @item
17357  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17358 @kbd{a} to add the score rule to the "all.SCORE" file.
17359
17360 @item
17361  @code{gnus-simplify-subject-functions} variable to allow greater
17362 control over simplification.
17363
17364 @item
17365  @kbd{A T}---new command for fetching the current thread.
17366
17367 @item
17368  @kbd{/ T}---new command for including the current thread in the
17369 limit.
17370
17371 @item
17372  @kbd{M-RET} is a new Message command for breaking cited text.
17373
17374 @item
17375  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17376
17377 @item
17378  The @code{custom-face-lookup} function has been removed.
17379 If you used this function in your initialization files, you must
17380 rewrite them to use @code{face-spec-set} instead.
17381
17382 @item
17383  Canceling now uses the current select method.  Symbolic prefix
17384 @kbd{a} forces normal posting method.
17385
17386 @item
17387  New command to translate M******** sm*rtq**t*s into proper
17388 text---@kbd{W d}.
17389
17390 @item
17391  For easier debugging of @code{nntp}, you can set
17392 @code{nntp-record-commands} to a non-@code{nil} value.
17393
17394 @item
17395  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17396 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17397
17398 @item
17399  A command for editing group parameters from the summary buffer
17400 has been added.
17401
17402 @item
17403  A history of where mails have been split is available.
17404
17405 @item
17406  A new article date command has been added---@code{article-date-iso8601}.
17407
17408 @item
17409  Subjects can be simplified when threading by setting
17410 @code{gnus-score-thread-simplify}.
17411
17412 @item
17413  A new function for citing in Message has been
17414 added---@code{message-cite-original-without-signature}.
17415
17416 @item
17417  @code{article-strip-all-blank-lines}---new article command.
17418
17419 @item
17420  A new Message command to kill to the end of the article has
17421 been added.
17422
17423 @item
17424  A minimum adaptive score can be specified by using the
17425 @code{gnus-adaptive-word-minimum} variable.
17426
17427 @item
17428  The "lapsed date" article header can be kept continually
17429 updated by the @code{gnus-start-date-timer} command.
17430
17431 @item
17432  Web listserv archives can be read with the @code{nnlistserv} backend.
17433
17434 @item
17435  Old dejanews archives can now be read by @code{nnweb}.
17436
17437 @end itemize
17438
17439
17440 @node Newest Features
17441 @subsection Newest Features
17442 @cindex todo
17443
17444 Also known as the @dfn{todo list}.  Sure to be implemented before the
17445 next millennium.
17446
17447 Be afraid.  Be very afraid.
17448
17449 (That a feature appears in this list doesn't necessarily mean that I've
17450 decided to actually implement it.  It just means that I think it sounds
17451 interesting.)
17452
17453 (Yes, this is the actual, up-to-the-second todo list.)
17454
17455 @itemize @bullet
17456
17457 @item
17458  I would like the zombie-page to contain an URL to the source of the
17459 latest version of gnus or some explanation on where to find it.
17460
17461 @item
17462  A way to continue editing the latest Message composition.
17463
17464 @item
17465  http://www.sonicnet.com/feature/ari3/
17466
17467 @item
17468  facep is not declared.
17469
17470 @item
17471  Include a section in the manual on why the number of articles
17472 isn't the same in the group buffer and on the SPC prompt.
17473
17474 @item
17475  Interacting with rmail fcc isn't easy.
17476
17477 @item
17478 @example
17479  Hypermail:
17480 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17481 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17482 <URL:http://homer.ncm.com/>
17483 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17484 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17485 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17486 http://www.miranova.com/gnus-list/
17487
17488 @end example
17489
17490 @item
17491 @samp{^-- } is made into - in LaTeX.
17492
17493 @item
17494  gnus-kill is much slower than it was in GNUS 4.1.3.
17495
17496 @item
17497  when expunging articles on low score, the sparse nodes keep hanging on?
17498 @item
17499  starting the first time seems to hang Gnus on some systems.  Does
17500 NEWGROUPS answer too fast?
17501 @item
17502  nndir doesn't read gzipped files.
17503 @item
17504  FAQ doesn't have an up node?
17505 @item
17506  when moving mail from a procmail spool to the crash-box,
17507 the crash-box is only appropriate to one specific group.
17508 @item
17509  `t' `t' makes X-Faces disappear.
17510 @item
17511  nnmh-be-safe means that crossposted articles will
17512 be marked as unread.
17513 @item
17514  Orphan score entries don't show on "V t" score trace
17515 @item
17516  when clearing out data, the cache data should also be reset.
17517 @item
17518  rewrite gnus-summary-limit-children to be non-recursive
17519 to avoid exceeding lisp nesting on huge groups.
17520 @item
17521  expunged articles are counted when computing scores.
17522 @item
17523  implement gnus-batch-brew-soup
17524 @item
17525  ticked articles aren't easy to read in pick mode -- `n' and
17526 stuff just skips past them.  Read articles are the same.
17527 @item
17528  topics that contain just groups with ticked
17529 articles aren't displayed.
17530 @item
17531  nndoc should always allocate unique Message-IDs.
17532 @item
17533  If there are mail groups the first time you use Gnus, Gnus'll
17534 make the mail groups killed.
17535 @item
17536  no "no news is good news" when using topics.
17537 @item
17538  when doing crosspost marking, the cache has to be consulted
17539 and articles have to be removed.
17540 @item
17541  nnweb should fetch complete articles when they are split into several
17542 parts.
17543 @item
17544  scoring on head immediate doesn't work.
17545 @item
17546  finding short score file names takes forever.
17547 @item
17548  canceling articles in foreign groups.
17549 @item
17550  nntp-open-rlogin no longer works.
17551 @item
17552  C-u C-x C-s (Summary) switches to the group buffer.
17553 @item
17554  move nnmail-split-history out to the backends.
17555 @item
17556  nnweb doesn't work properly.
17557 @item
17558  using a virtual server name as `gnus-select-method' doesn't work?
17559 @item
17560  when killing/yanking a group from one topic to another in a slave, the
17561 master will yank it first to one topic and then add it to another.
17562 Perhaps.
17563
17564 @item
17565  warn user about `=' redirection of a group in the active file?
17566 @item
17567  take over the XEmacs menubar and offer a toggle between the XEmacs
17568 bar and the Gnus bar.
17569 @item
17570 @example
17571  push active file and NOV file parsing down into C code.
17572 `(canonize-message-id id)'
17573 `(mail-parent-message-id references n)'
17574 `(parse-news-nov-line &optional dependency-hashtb)'
17575 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17576 `(parse-news-active-region beg end hashtb)'
17577
17578 @end example
17579
17580 @item
17581  nnml .overview directory with splits.
17582 @item
17583  asynchronous cache
17584 @item
17585  postponed commands.
17586 @item
17587  the selected article show have its Subject displayed in its summary line.
17588 @item
17589  when entering groups, get the real number of unread articles from
17590 the server?
17591 @item
17592  sort after gathering threads -- make false roots have the
17593 headers of the oldest orphan with a 0 article number?
17594 @item
17595  nndoc groups should inherit the score files of their parents?  Also
17596 inherit copy prompts and save files.
17597 @item
17598  command to start up Gnus (if not running) and enter a mail mode buffer.
17599 @item
17600  allow editing the group description from the group buffer
17601 for backends that support that.
17602 @item
17603 gnus-hide,show-all-topics
17604 @item
17605  groups and sub-topics should be allowed to mingle inside each topic,
17606 and not just list all subtopics at the end.
17607 @item
17608  a command to remove all read articles that are not needed to connect
17609 threads -- `gnus-summary-limit-to-sparse-unread'?
17610 @item
17611  a variable to turn off limiting/cutting of threads in the tree buffer.
17612 @item
17613  a variable to limit how many files are uudecoded.
17614 @item
17615  add zombie groups to a special "New Groups" topic.
17616 @item
17617  server mode command: close/open all connections
17618 @item
17619  put a file date in gnus-score-alist and check whether the file
17620 has been changed before using it.
17621 @item
17622  on exit from a digest group, go to the next article in the parent group.
17623 @item
17624  hide (sub)threads with low score.
17625 @item
17626  when expiring, remove all marks from expired articles.
17627 @item
17628  gnus-summary-limit-to-body
17629 @item
17630  a regexp alist that says what level groups are to be subscribed
17631 on.  Eg. -- `(("nnml:" . 1))'.
17632 @item
17633  easier interface to nnkiboze to create ephemeral groups that
17634 contain groups that match a regexp.
17635 @item
17636  allow newlines in <URL:> urls, but remove them before using
17637 the URL.
17638 @item
17639  If there is no From line, the mail backends should fudge one from the
17640 "From " line.
17641 @item
17642  fuzzy simplifying should strip all non-alpha-numerical info
17643 from subject lines.
17644 @item
17645  gnus-soup-brew-soup-with-high-scores.
17646 @item
17647  nntp-ping-before-connect
17648 @item
17649  command to check whether NOV is evil.  "list overview.fmt".
17650 @item
17651  when entering a group, Gnus should look through the score
17652 files very early for `local' atoms and set those local variables.
17653 @item
17654  message annotations.
17655 @item
17656  topics are always yanked before groups, and that's not good.
17657 @item
17658  (set-extent-property extent 'help-echo "String to display in minibuf")
17659 to display help in the minibuffer on buttons under XEmacs.
17660 @item
17661  allow group line format spec to say how many articles there
17662 are in the cache.
17663 @item
17664  AUTHINFO GENERIC
17665 @item
17666  support qmail maildir spools
17667 @item
17668  `run-with-idle-timer' in gnus-demon.
17669 @item
17670  stop using invisible text properties and start using overlays instead
17671 @item
17672  C-c C-f C-e to add an Expires header.
17673 @item
17674  go from one group to the next; everything is expunged; go to the
17675 next group instead of going to the group buffer.
17676 @item
17677  gnus-renumber-cache -- to renumber the cache using "low" numbers.
17678 @item
17679  record topic changes in the dribble buffer.
17680 @item
17681  `nnfolder-generate-active-file' should look at the folders it
17682 finds and generate proper active ranges.
17683 @item
17684  nneething-look-in-files-for-article-heads variable to control
17685 whether nneething should sniff all files in the directories.
17686 @item
17687  gnus-fetch-article -- start Gnus, enter group, display article
17688 @item
17689  gnus-dont-move-articles-to-same-group variable when respooling.
17690 @item
17691  when messages are crossposted between several auto-expirable groups,
17692 articles aren't properly marked as expirable.
17693 @item
17694  nneething should allow deletion/moving.
17695 @item
17696  TAB on the last button should go to the first button.
17697 @item
17698  if the car of an element in `mail-split-methods' is a function,
17699 and the function returns non-nil, use that as the name of the group(s) to
17700 save mail in.
17701 @item
17702  command for listing all score files that have been applied.
17703 @item
17704  a command in the article buffer to return to `summary' config.
17705 @item
17706  `gnus-always-post-using-current-server' -- variable to override
17707 `C-c C-c' when posting.
17708 @item
17709  nnmail-group-spool-alist -- says where each group should use
17710 as a spool file.
17711 @item
17712  when an article is crossposted to an auto-expirable group, the article
17713 should be marker as expirable.
17714 @item
17715  article mode command/menu for "send region as URL to browser".
17716 @item
17717  on errors, jump to info nodes that explain the error.  For instance,
17718 on invalid From headers, or on error messages from the nntp server.
17719 @item
17720  when gathering threads, make the article that has no "Re: " the parent.
17721 Also consult Date headers.
17722 @item
17723  a token in splits to call shrink-window-if-larger-than-buffer
17724 @item
17725  `1 0 A M' to do matches on the active hashtb.
17726 @item
17727  duplicates -- command to remove Gnus-Warning header, use the read
17728 Message-ID, delete the "original".
17729 @item
17730  when replying to several messages at once, put the "other" message-ids
17731 into a See-Also header.
17732 @item
17733  support setext: URL:http://www.bsdi.com/setext/
17734 @item
17735  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
17736 @item
17737  when browsing a foreign server, the groups that are already subscribed
17738 should be listed as such and not as "K".
17739 @item
17740  generate font names dynamically.
17741 @item
17742  score file mode auto-alist.
17743 @item
17744  allow nndoc to change/add/delete things from documents.  Implement
17745 methods for each format for adding an article to the document.
17746 @item
17747  `gnus-fetch-old-headers' `all' value to incorporate
17748 absolutely all headers there is.
17749 @item
17750  function like `|', but concatenate all marked articles
17751 and pipe them to the process.
17752 @item
17753  cache the list of killed (or active) groups in a separate file.  Update
17754 the file whenever we read the active file or the list
17755 of killed groups in the .eld file reaches a certain length.
17756 @item
17757  function for starting to edit a file to put into
17758 the current mail group.
17759 @item
17760  score-find-trace should display the total score of the article.
17761 @item
17762  "ghettozie" -- score on Xref header and nix it out after using it
17763 to avoid marking as read in other groups it has been crossposted to.
17764 @item
17765  look at procmail splitting.  The backends should create
17766 the groups automatically if a spool file exists for that group.
17767 @item
17768  function for backends to register themselves with Gnus.
17769 @item
17770  when replying to several process-marked articles,
17771 have all the From end up in Cc headers?  Variable to toggle.
17772 @item
17773  command to delete a crossposted mail article from all
17774 groups it has been mailed to.
17775 @item
17776  `B c' and `B m' should be crosspost aware.
17777 @item
17778  hide-pgp should also hide PGP public key blocks.
17779 @item
17780  Command in the group buffer to respool process-marked groups.
17781 @item
17782  `gnus-summary-find-matching' should accept
17783 pseudo-"headers" like "body", "head" and "all"
17784 @item
17785  When buttifying <URL: > things, all white space (including
17786 newlines) should be ignored.
17787 @item
17788  Process-marking all groups in a topic should process-mark
17789 groups in subtopics as well.
17790 @item
17791  Add non-native groups to the list of killed groups when killing them.
17792 @item
17793  nntp-suggest-kewl-config to probe the nntp server and suggest
17794 variable settings.
17795 @item
17796  add edit and forward secondary marks.
17797 @item
17798  nnml shouldn't visit its .overview files.
17799 @item
17800  allow customizing sorting within gathered threads.
17801 @item
17802  `B q' shouldn't select the current article.
17803 @item
17804  nnmbox should support a newsgroups file for descriptions.
17805 @item
17806  allow fetching mail from several pop servers.
17807 @item
17808  Be able to specify whether the saving commands save the original
17809 or the formatted article.
17810 @item
17811  a command to reparent with the child process-marked (cf. `T ^'.).
17812 @item
17813  I think the possibility to send a password with nntp-open-rlogin
17814 should be a feature in Red Gnus.
17815 @item
17816  The `Z n' command should be possible to execute from a mouse click.
17817 @item
17818  more limiting functions -- date, etc.
17819 @item
17820  be able to limit on a random header; on body; using reverse matches.
17821 @item
17822  a group parameter (`absofucking-total-expiry') that will make Gnus expire
17823 even unread articles.
17824 @item
17825  a command to print the article buffer as postscript.
17826 @item
17827  variable to disable password fetching when opening by nntp-open-telnet.
17828 @item
17829  manual: more example servers -- nntp with rlogin, telnet
17830 @item
17831  checking for bogus groups should clean topic alists as well.
17832 @item
17833  canceling articles in foreign groups.
17834 @item
17835  article number in folded topics isn't properly updated by
17836 Xref handling.
17837 @item
17838  Movement in the group buffer to the next unread group should go to the
17839 next closed topic with unread messages if no group can be found.
17840 @item
17841  Extensive info pages generated on the fly with help everywhere --
17842 in the "*Gnus edit*" buffers, for instance.
17843 @item
17844  Topic movement commands -- like thread movement.  Up, down, forward, next.
17845 @item
17846  a way to tick/mark as read Gcc'd articles.
17847 @item
17848  a way to say that all groups within a specific topic comes
17849 from a particular server?  Hm.
17850 @item
17851  `gnus-article-fill-if-long-lines' -- a function to fill
17852 the article buffer if there are any looong lines there.
17853 @item
17854  `T h' should jump to the parent topic and fold it.
17855 @item
17856  a command to create an ephemeral nndoc group out of a file,
17857 and then splitting it/moving it to some other group/backend.
17858 @item
17859  a group parameter for nnkiboze groups that says that
17860 all kibozed articles should be entered into the cache.
17861 @item
17862  It should also probably be possible to delimit what
17863 `gnus-jog-cache' does -- for instance, work on just some groups, or on
17864 some levels, and entering just articles that have a score higher than
17865 a certain number.
17866 @item
17867  nnfolder should append to the folder instead of re-writing
17868 the entire folder to disk when accepting new messages.
17869 @item
17870  allow all backends to do the proper thing with .gz files.
17871 @item
17872  a backend for reading collections of babyl files nnbabylfolder?
17873 @item
17874  a command for making the native groups into foreign groups.
17875 @item
17876  server mode command for clearing read marks from all groups
17877 from a server.
17878 @item
17879  when following up multiple articles, include all To, Cc, etc headers
17880 from all articles.
17881 @item
17882  a command for deciding what the total score of the current
17883 thread is.  Also a way to highlight based on this.
17884 @item
17885  command to show and edit group scores
17886 @item
17887  a gnus-tree-minimize-horizontal to minimize tree buffers
17888 horizontally.
17889 @item
17890  command to generate nnml overview file for one group.
17891 @item
17892  `C-u C-u a' -- prompt for many crossposted groups.
17893 @item
17894  keep track of which mail groups have received new articles (in this session).
17895 Be able to generate a report and perhaps do some marking in the group
17896 buffer.
17897 @item
17898  gnus-build-sparse-threads to a number -- build only sparse threads
17899 that are of that length.
17900 @item
17901  have nnmh respect mh's unseen sequence in .mh_profile.
17902 @item
17903  cache the newsgroups descriptions locally.
17904 @item
17905  asynchronous posting under nntp.
17906 @item
17907  be able to control word adaptive scoring from the score files.
17908 @item
17909  a variable to make `C-c C-c' post using the "current" select method.
17910 @item
17911  `limit-exclude-low-scored-articles'.
17912 @item
17913  if `gnus-summary-show-thread' is a number, hide threads that have
17914 a score lower than this number.
17915 @item
17916  split newsgroup subscription variable up into "order" and "method".
17917 @item
17918  buttonize ange-ftp file names.
17919 @item
17920  a command to make a duplicate copy of the current article
17921 so that each copy can be edited separately.
17922 @item
17923  nnweb should allow fetching from the local nntp server.
17924 @item
17925  record the sorting done in the summary buffer so that
17926 it can be repeated when limiting/regenerating the buffer.
17927 @item
17928  nnml-generate-nov-databses should generate for
17929 all nnml servers.
17930 @item
17931  when the user does commands in the group buffer, check
17932 the modification time of the .newsrc.eld file and use
17933 ask-user-about-supersession-threat.  Also warn when trying
17934 to save .newsrc.eld and it has changed.
17935 @item
17936  M-g on a topic will display all groups with 0 articles in
17937 the topic.
17938 @item
17939  command to remove all topic stuff.
17940 @item
17941  allow exploding incoming digests when reading incoming mail
17942 and splitting the resulting digests.
17943 @item
17944  nnsoup shouldn't set the `message-' variables.
17945 @item
17946  command to nix out all nnoo state information.
17947 @item
17948  nnmail-process-alist that calls functions if group names
17949 matches an alist -- before saving.
17950 @item
17951  use buffer-invisibility-spec everywhere for hiding text.
17952 @item
17953  variable to activate each group before entering them
17954 to get the (new) number of articles.  `gnus-activate-before-entering'.
17955 @item
17956  command to fetch a Message-ID from any buffer, even
17957 starting Gnus first if necessary.
17958 @item
17959  when posting and checking whether a group exists or not, just
17960 ask the nntp server instead of relying on the active hashtb.
17961 @item
17962  buttonize the output of `C-c C-a' in an apropos-like way.
17963 @item
17964  `G p' should understand process/prefix, and allow editing
17965 of several groups at once.
17966 @item
17967  command to create an ephemeral nnvirtual group that
17968 matches some regexp(s).
17969 @item
17970  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
17971 @item
17972  it should be possible to score "thread" on the From header.
17973 @item
17974  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
17975 @item
17976  `B i' should display the article at once in the summary buffer.
17977 @item
17978  remove the "*" mark at once when unticking an article.
17979 @item
17980  `M-s' should highlight the matching text.
17981 @item
17982  when checking for duplicated mails, use Resent-Message-ID if present.
17983 @item
17984  killing and yanking groups in topics should be better.  If killing one copy
17985 of a group that exists in multiple topics, only that copy should
17986 be removed.  Yanking should insert the copy, and yanking topics
17987 should be possible to be interspersed with the other yankings.
17988 @item
17989  command for enter a group just to read the cached articles.  A way to say
17990 "ignore the nntp connection; just read from the cache."
17991 @item
17992  `X u' should decode base64 articles.
17993 @item
17994  a way to hide all "inner" cited text, leaving just the most
17995 recently cited text.
17996 @item
17997  nnvirtual should be asynchronous.
17998 @item
17999  after editing an article, gnus-original-article-buffer should
18000 be invalidated.
18001 @item
18002  there should probably be a way to make Gnus not connect to the
18003 server and just read the articles in the server
18004 @item
18005  allow a `set-default' (or something) to change the default
18006 value of nnoo variables.
18007 @item
18008  a command to import group infos from a .newsrc.eld file.
18009 @item
18010  groups from secondary servers have the entire select method
18011 listed in each group info.
18012 @item
18013  a command for just switching from the summary buffer to the group
18014 buffer.
18015 @item
18016  a way to specify that some incoming mail washing functions
18017 should only be applied to some groups.
18018 @item
18019  Message `C-f C-t' should ask the user whether to heed
18020 mail-copies-to: never.
18021 @item
18022  new group parameter -- `post-to-server' that says to post
18023 using the current server.  Also a variable to do the same.
18024 @item
18025  the slave dribble files should auto-save to the slave file names.
18026 @item
18027  a group parameter that says what articles to display on group entry, based
18028 on article marks.
18029 @item
18030  a way to visually distinguish slave Gnusae from masters.  (Whip instead
18031 of normal logo?)
18032 @item
18033  Use DJ Bernstein "From " quoting/dequoting, where applicable.
18034 @item
18035  Why is hide-citation-maybe and hide-citation different?  Also
18036 clear up info.
18037 @item
18038  group user-defined meta-parameters.
18039
18040
18041
18042 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
18043 @item
18044  I like the option for trying to retrieve the FAQ for a group and I was
18045 thinking it would be great if for those newsgroups that had archives
18046 you could also try to read the archive for that group.  Part of the
18047 problem is that archives are spread all over the net, unlike FAQs.
18048 What would be best I suppose is to find the one closest to your site.
18049
18050 In any case, there is a list of general news group archives at @*
18051 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
18052
18053
18054
18055
18056 @item
18057 @example
18058 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
18059 (add-hook 'gnus-select-group-hook
18060   (lambda ()
18061     (gnus-group-add-parameter group
18062        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
18063
18064 (defun gnus-user-format-function-d (headers)
18065   "Return the date the group was last read."
18066   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
18067       (t "")))
18068 @end example
18069
18070 @item
18071  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
18072 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
18073 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
18074 hatt forskjellige serveres startup-filer forskjellige steder.
18075
18076
18077 @item
18078 LMI> Well, nnbabyl could alter the group info to heed labels like
18079 LMI> answered and read, I guess.
18080
18081 It could also keep them updated (the same for the Status: header of
18082 unix mbox files).
18083
18084 They could be used like this:
18085
18086
18087 @example
18088 `M l <name> RET' add label <name> to current message.
18089 `M u <name> RET' remove label <name> from current message.
18090 `/ l <expr> RET' limit summary buffer according to <expr>.
18091
18092 <expr> would be a boolean expression on the labels, e.g.
18093
18094 `/ l bug & !fixed RET'
18095 @end example
18096
18097 would show all the messages which are labeled `bug' but not labeled
18098 `fixed'.
18099
18100 One could also imagine the labels being used for highlighting, or
18101 affect the summary line format.
18102
18103
18104 @item
18105 Sender: abraham@@dina.kvl.dk
18106
18107 I'd like a gnus-find-file which work like find file, except that it
18108 would recognize things that looks like messages or folders:
18109
18110 - If it is a directory containing numbered files, create an nndir
18111 summary buffer.
18112
18113 - For other directories, create a nneething summary buffer.
18114
18115 - For files matching "\\`From ", create a nndoc/mbox summary.
18116
18117 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
18118
18119 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
18120
18121 - For other files, just find them normally.
18122
18123 I'd like `nneething' to use this function, so it would work on a
18124 directory potentially containing mboxes or babyl files.
18125
18126 @item
18127 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
18128 tell him what you are doing.
18129
18130 @item
18131 Currently, I get prompted:
18132
18133 decend into sci?
18134 - type y
18135 decend into sci.something ?
18136 - type n
18137 decend into ucd?
18138
18139 The problem above is that since there is really only one subsection of
18140 science, shouldn't it prompt you for only descending sci.something?  If
18141 there was a sci.somethingelse group or section, then it should prompt
18142 for sci? first the sci.something? then sci.somethingelse?...
18143
18144 @item
18145 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
18146 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
18147 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
18148 "no.all.SCORE", osv.
18149
18150 @item
18151 What i want is for Gnus to treat any sequence or combination of the following
18152 as a single spoiler warning and hide it all, replacing it with a "Next Page"
18153 button:
18154
18155
18156 ^L's
18157
18158 more than n blank lines
18159
18160 more than m identical lines
18161 (which should be replaced with button to show them)
18162
18163 any whitespace surrounding any of the above
18164
18165
18166 @item
18167 Well, we could allow a new value to `gnus-thread-ignore-subject' --
18168 `spaces', or something.  (We could even default to that.)  And then
18169 subjects that differ in white space only could be considered the
18170 "same" subject for threading purposes.
18171
18172 @item
18173 Modes to preprocess the contents (e.g. jka-compr) use the second form
18174 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
18175 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
18176 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
18177
18178 @item
18179  Under XEmacs -- do funny article marks:
18180 tick - thumb tack
18181 killed - skull
18182 soup - bowl of soup
18183 score below - dim light bulb
18184 score over - bright light bulb
18185
18186 @item
18187 Yes. I think the algorithm is as follows:
18188
18189 @example
18190 Group-mode
18191
18192    show-list-of-articles-in-group
18193         if (key-pressed == SPACE)
18194                 if (no-more-articles-in-group-to-select)
18195                         if (articles-selected)
18196                                 start-reading-selected-articles;
18197                         junk-unread-articles;
18198                         next-group;
18199                  else
18200                         show-next-page;
18201
18202          else if (key-pressed = '.')
18203                 if (consolidated-menus)         # same as hide-thread in Gnus
18204                         select-thread-under-cursor;
18205                 else
18206                         select-article-under-cursor;
18207
18208
18209 Article-mode
18210         if (key-pressed == SPACE)
18211                 if (more-pages-in-article)
18212                         next-page;
18213                 else if (more-selected-articles-to-read)
18214                         next-article;
18215                 else
18216                         next-group;
18217 @end example
18218
18219 @item
18220 My precise need here would have been to limit files to Incoming*.
18221 One could think of some `nneething-only-files' variable, but I guess
18222 it would have been unacceptable if one was using many unrelated such
18223 nneething groups.
18224
18225 A more useful approach would be to, in response to the `G D' prompt, be
18226 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18227 the top-level directory only (in case directories would be matched by
18228 the wildcard expression).
18229
18230 @item
18231 It would be nice if it also handled
18232
18233         <URL:news://sunsite.auc.dk/>
18234
18235 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18236
18237
18238 @item
18239
18240   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18241 really well.  Each menu is 'named' by a symbol that would be on a
18242 gnus-*-menus (where * would be whatever, but at least group, summary, and
18243 article versions) variable.
18244
18245   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18246
18247   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18248 the main menubar.  This approach works really well for Emacs-W3 and VM.
18249
18250
18251 @item
18252  nndoc should take care to create unique Message-IDs for all its
18253 articles.
18254 @item
18255  gnus-score-followup-article only works when you have a summary buffer
18256 active.  Make it work when posting from the group buffer as well.
18257 (message-sent-hook).
18258 @item
18259  rewrite gnus-demon to use run-with-idle-timers.
18260
18261 @item
18262  * Enhancements to Gnus:
18263
18264   Add two commands:
18265
18266   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18267     straight to the server buffer, without opening any connections to
18268     servers first.
18269
18270   * gnus-server-read-server-newsrc--produces a buffer very similar to
18271     the group buffer, but with only groups from that server listed;
18272     quitting this buffer returns to the server buffer.
18273
18274 @item
18275  add a command to check the integrity of an nnfolder folder --
18276 go through the article numbers and see that there are no duplicates,
18277 and stuff.
18278
18279 @item
18280  `unsmileyfy-buffer' to undo smileification.
18281
18282 @item
18283  a command to give all relevant info on an article, including all
18284 secondary marks.
18285
18286 @item
18287  when doing `-request-accept-article', the backends should do
18288 the nnmail duplicate checking.
18289
18290 @item
18291  allow `message-signature-file' to be a function to return the
18292 value of the signature file.
18293
18294 @item
18295  In addition, I would love it if I could configure message-tab so that it
18296 could call `bbdb-complete-name' in other headers.  So, some sort of
18297 interface like
18298
18299 (setq message-tab-alist
18300       '((message-header-regexp message-expand-group)
18301         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
18302
18303 then you could run the relevant function to complete the information in
18304 the header
18305
18306 @item
18307  cache the newsgroups file locally to avoid reloading it all the time.
18308
18309 @item
18310  a command to import a buffer into a group.
18311
18312 @item
18313  nnweb should allow fetching by Message-ID from servers.
18314
18315 @item
18316  point in the article buffer doesn't always go to the
18317 beginning of the buffer when selecting new articles.
18318
18319 @item
18320  a command to process mark all unread articles.
18321
18322 @item
18323  `gnus-gather-threads-by-references-and-subject' -- first
18324 do gathering by references, and then go through the dummy roots and
18325 do more gathering by subject.
18326
18327 @item
18328  gnus-uu-mark-in-numerical-order -- process mark articles in
18329 article numerical order.
18330
18331 @item
18332  (gnus-thread-total-score
18333  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18334 bind to a key.
18335
18336 @item
18337  sorting by score is wrong when using sparse threads.
18338
18339 @item
18340  a command to fetch an arbitrary article -- without having to be
18341 in the summary buffer.
18342
18343 @item
18344  a new nncvs backend.  Each group would show an article, using
18345 version branches as threading, checkin date as the date, etc.
18346
18347 @item
18348  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18349 This filter allows one to construct advance queries on the Dejanews
18350 database such as specifying start and end dates, subject, author,
18351 and/or newsgroup name.
18352
18353 @item
18354  new Date header scoring type -- older, newer
18355
18356 @item
18357  use the summary toolbar in the article buffer.
18358
18359 @item
18360  a command to fetch all articles that are less than X days old.
18361
18362 @item
18363  in pick mode, `q' should save the list of selected articles in the
18364 group info.  The next time the group is selected, these articles
18365 will automatically get the process mark.
18366
18367 @item
18368  Isn't it possible to (also?) allow M-^ to automatically try the
18369 default server if it fails on the current server?  (controlled by a
18370 user variable, (nil, t, 'ask)).
18371
18372 @item
18373  make it possible to cancel articles using the select method for the
18374 current group.
18375
18376 @item
18377  `gnus-summary-select-article-on-entry' or something.  It'll default
18378 to t and will select whatever article decided by `gnus-auto-select-first'.
18379
18380 @item
18381  a new variable to control which selection commands should be unselecting.
18382 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18383 candidates.
18384
18385 @item
18386  be able to select groups that have no articles in them
18387 to be able to post in them (using the current select method).
18388
18389 @item
18390  be able to post via DejaNews.
18391
18392 @item
18393  `x' should retain any sortings that have been performed.
18394
18395 @item
18396  allow the user to specify the precedence of the secondary marks.  Also
18397 allow them to be displayed separately.
18398
18399 @item
18400  gnus-summary-save-in-pipe should concatenate the results from
18401 the processes when doing a process marked pipe.
18402
18403 @item
18404  a new match type, like Followup, but which adds Thread matches on all
18405 articles that match a certain From header.
18406
18407 @item
18408  a function that can be read from kill-emacs-query-functions to offer
18409 saving living summary buffers.
18410
18411 @item
18412  a function for selecting a particular group which will contain
18413 the articles listed in a list of article numbers/id's.
18414
18415 @item
18416  a battery of character translation functions to translate common
18417 Mac, MS (etc) characters into ISO 8859-1.
18418
18419 @example
18420 (defun article-fix-m$word ()
18421   "Fix M$Word smartquotes in an article."
18422   (interactive)
18423   (save-excursion
18424     (let ((buffer-read-only nil))
18425       (goto-char (point-min))
18426       (while (search-forward "\221" nil t)
18427         (replace-match "`" t t))
18428       (goto-char (point-min))
18429       (while (search-forward "\222" nil t)
18430         (replace-match "'" t t))
18431       (goto-char (point-min))
18432       (while (search-forward "\223" nil t)
18433         (replace-match "\"" t t))
18434       (goto-char (point-min))
18435       (while (search-forward "\224" nil t)
18436         (replace-match "\"" t t)))))
18437 @end example
18438
18439 @item
18440 @example
18441  (add-hook 'gnus-exit-query-functions
18442 '(lambda ()
18443    (if (and (file-exists-p nnmail-spool-file)
18444             (> (nnheader-file-size nnmail-spool-file) 0))
18445        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
18446        (y-or-n-p "Are you sure you want to quit Gnus? "))))
18447 @end example
18448
18449 @item
18450  allow message-default-headers to be a function.
18451
18452 @item
18453  new Date score match types -- < > = (etc) that take floating point
18454 numbers and match on the age of the article.
18455
18456 @item
18457 @example
18458 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18459 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
18460 >  > > buffer in the frame that it was called from =:-O
18461 >
18462 >  > Hm.  How do you start up Gnus?  From the toolbar or with
18463 >  > `M-x gnus-other-frame'?
18464 >
18465 >    I normally start it up from the toolbar; at
18466 > least that's the way I've caught it doing the
18467 > deed before.
18468 @end example
18469
18470 @item
18471  all commands that react to the process mark should push
18472 the current process mark set onto the stack.
18473
18474 @item
18475  gnus-article-hide-pgp
18476 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
18477 @example
18478 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18479 @end example
18480 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
18481 er min type heuristikk og langt fra alles.
18482
18483 @item
18484  `gnus-subscribe-sorted' -- insert new groups where they would have been
18485 sorted to if `gnus-group-sort-function' were run.
18486
18487 @item
18488  gnus-(group,summary)-highlight should respect any `face' text props set
18489 on the lines.
18490
18491 @item
18492  use run-with-idle-timer for gnus-demon instead of the
18493 home-brewed stuff for better reliability.
18494
18495 @item
18496  add a way to select which NoCeM type to apply -- spam, troll, etc.
18497
18498 @item
18499  nndraft-request-group should tally auto-save files.
18500
18501 @item
18502  implement nntp-retry-on-break and nntp-command-timeout.
18503
18504 @item
18505  gnus-article-highlight-limit that says when not to highlight (long)
18506 articles.
18507
18508 @item
18509  (nnoo-set SERVER VARIABLE VALUE)
18510
18511 @item
18512  nn*-spool-methods
18513
18514 @item
18515  interrupitng agent fetching of articles should save articles.
18516
18517 @item
18518  command to open a digest group, and copy all the articles there to the
18519 current group.
18520
18521 @item
18522  a variable to disable article body highlights if there's more than
18523 X characters in the body.
18524
18525 @item
18526  handle 480/381 authinfo requests separately.
18527
18528 @item
18529  include the texi/dir file in the distribution.
18530
18531 @item
18532  format spec to "tab" to a position.
18533
18534 @item
18535  Move all prompting to the new `M-n' default style.
18536
18537 @item
18538  command to display all dormant articles.
18539
18540 @item
18541  gnus-auto-select-next makeover -- list of things it should do.
18542
18543 @item
18544  a score match type that adds scores matching on From if From has replied
18545 to something someone else has said.
18546
18547 @item
18548  Read Netscape discussion groups:
18549 snews://secnews.netscape.com/netscape.communicator.unix
18550
18551 @item
18552 One command to edit the original version if an article, and one to edit
18553 the displayed version.
18554
18555 @item
18556 @kbd{T v} -- make all process-marked articles the children of the
18557 current article.
18558
18559 @item
18560 Switch from initial text to the new default text mechanism.
18561
18562 @item
18563 How about making it possible to expire local articles?  Will it be
18564 possible to make various constraints on when an article can be
18565 expired, e.g. (read), (age > 14 days), or the more interesting (read
18566 & age > 14 days)?
18567
18568 @item
18569 New limit command---limit to articles that have a certain string
18570 in the head or body.
18571
18572 @item
18573 Allow breaking lengthy NNTP commands.
18574
18575 @item
18576 gnus-article-highlight-limit, to disable highlighting in big articles.
18577
18578 @item
18579 Editing an article should put the article to be edited
18580 in a special, unique buffer.
18581
18582 @item
18583 A command to send a mail to the admin-address group param.
18584
18585 @item
18586 A Date scoring type that will match if the article
18587 is less than a certain number of days old.
18588
18589 @item
18590 New spec: %~(tab 56) to put point on column 56
18591
18592 @item
18593 Allow Gnus Agent scoring to use normal score files.
18594
18595 @item
18596 Rething the Agent active file thing.  `M-g' doesn't update the active
18597 file, for instance.
18598
18599 @item
18600 With dummy roots, `^' and then selecing the first article
18601 in any other dummy thread will make gnus highlight the
18602 dummy root instead of the first article.
18603
18604 @item
18605 Propagate all group properties (marks, article numbers, etc) up to the
18606 topics for displaying.
18607
18608 @item
18609 `n' in the group buffer with topics should go to the next group
18610 with unread articles, even if that group is hidden in a topic.
18611
18612 @item
18613 gnus-posting-styles doesn't work in drafts.
18614
18615 @item
18616 gnus-summary-limit-include-cached is slow when there are
18617 many articles in the cache, since it regenerates big parts of the
18618 summary buffer for each article.
18619
18620 @item
18621 Implement gnus-batch-brew-soup.
18622
18623 @item
18624 Group parameters and summary commands for un/subscribing to mailing
18625 lists.
18626
18627 @item
18628 Introduce nnmail-home-directory.
18629
18630 @item
18631 gnus-fetch-group and friends should exit Gnus when the user
18632 exits the group.
18633
18634 @item
18635 The jingle is only played on the second invocation of Gnus.
18636
18637 @item
18638 Bouncing articles should do MIME.
18639
18640 @item
18641 Crossposted articles should "inherit" the % or @ mark from the other
18642 groups it has been crossposted to, or something.  (Agent.)
18643
18644 @item
18645 `S D r' should allow expansion of aliases.
18646
18647 @item
18648 If point is on a group that appears multiple times in topics, and
18649 you press `l', point will move to the first instance of the group.
18650
18651 @item
18652 The documentation should mention pop3.el, fetchmail, smtpmail and why
18653 po:username often fails.
18654
18655 @item
18656 Fetch by Message-ID from dejanews.
18657
18658 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
18659
18660 @item
18661 A spec for the group line format to display the number of
18662 agent-downloaded articles in the group.
18663
18664 @item
18665 Some nntp servers never respond when posting, so there should be a
18666 timeout for all commands.
18667
18668 @item
18669 Solve the halting problem.
18670
18671 @c TODO
18672 @end itemize
18673
18674 @iftex
18675
18676 @page
18677 @node The Manual
18678 @section The Manual
18679 @cindex colophon
18680 @cindex manual
18681
18682 This manual was generated from a TeXinfo file and then run through
18683 either @code{texi2dvi}
18684 @iflatex
18685 or my own home-brewed TeXinfo to \LaTeX\ transformer,
18686 and then run through @code{latex} and @code{dvips}
18687 @end iflatex
18688 to get what you hold in your hands now.
18689
18690 The following conventions have been used:
18691
18692 @enumerate
18693
18694 @item
18695 This is a @samp{string}
18696
18697 @item
18698 This is a @kbd{keystroke}
18699
18700 @item
18701 This is a @file{file}
18702
18703 @item
18704 This is a @code{symbol}
18705
18706 @end enumerate
18707
18708 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
18709 mean:
18710
18711 @lisp
18712 (setq flargnoze "yes")
18713 @end lisp
18714
18715 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
18716
18717 @lisp
18718 (setq flumphel 'yes)
18719 @end lisp
18720
18721 @samp{yes} and @code{yes} are two @emph{very} different things---don't
18722 ever get them confused.
18723
18724 @iflatex
18725 @c @head
18726 Of course, everything in this manual is of vital interest, so you should
18727 read it all.  Several times.  However, if you feel like skimming the
18728 manual, look for that gnu head you should see in the margin over
18729 there---it means that what's being discussed is of more importance than
18730 the rest of the stuff.  (On the other hand, if everything is infinitely
18731 important, how can anything be more important than that?  Just one more
18732 of the mysteries of this world, I guess.)
18733 @end iflatex
18734
18735 @end iftex
18736
18737
18738 @page
18739 @node Terminology
18740 @section Terminology
18741
18742 @cindex terminology
18743 @table @dfn
18744
18745 @item news
18746 @cindex news
18747 This is what you are supposed to use this thing for---reading news.
18748 News is generally fetched from a nearby @sc{nntp} server, and is
18749 generally publicly available to everybody.  If you post news, the entire
18750 world is likely to read just what you have written, and they'll all
18751 snigger mischievously.  Behind your back.
18752
18753 @item mail
18754 @cindex mail
18755 Everything that's delivered to you personally is mail.  Some news/mail
18756 readers (like Gnus) blur the distinction between mail and news, but
18757 there is a difference.  Mail is private.  News is public.  Mailing is
18758 not posting, and replying is not following up.
18759
18760 @item reply
18761 @cindex reply
18762 Send a mail to the person who has written what you are reading.
18763
18764 @item follow up
18765 @cindex follow up
18766 Post an article to the current newsgroup responding to the article you
18767 are reading.
18768
18769 @item backend
18770 @cindex backend
18771 Gnus gets fed articles from a number of backends, both news and mail
18772 backends.  Gnus does not handle the underlying media, so to speak---this
18773 is all done by the backends.
18774
18775 @item native
18776 @cindex native
18777 Gnus will always use one method (and backend) as the @dfn{native}, or
18778 default, way of getting news.
18779
18780 @item foreign
18781 @cindex foreign
18782 You can also have any number of foreign groups active at the same time.
18783 These are groups that use non-native non-secondary backends for getting
18784 news.
18785
18786 @item secondary
18787 @cindex secondary
18788 Secondary backends are somewhere half-way between being native and being
18789 foreign, but they mostly act like they are native.
18790
18791 @item article
18792 @cindex article
18793 A message that has been posted as news.
18794
18795 @item mail message
18796 @cindex mail message
18797 A message that has been mailed.
18798
18799 @item message
18800 @cindex message
18801 A mail message or news article
18802
18803 @item head
18804 @cindex head
18805 The top part of a message, where administrative information (etc.) is
18806 put.
18807
18808 @item body
18809 @cindex body
18810 The rest of an article.  Everything not in the head is in the
18811 body.
18812
18813 @item header
18814 @cindex header
18815 A line from the head of an article.
18816
18817 @item headers
18818 @cindex headers
18819 A collection of such lines, or a collection of heads.  Or even a
18820 collection of @sc{nov} lines.
18821
18822 @item @sc{nov}
18823 @cindex nov
18824 When Gnus enters a group, it asks the backend for the headers of all
18825 unread articles in the group.  Most servers support the News OverView
18826 format, which is more compact and much faster to read and parse than the
18827 normal @sc{head} format.
18828
18829 @item level
18830 @cindex levels
18831 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
18832 that have a lower level are ``more'' subscribed than the groups with a
18833 higher level.  In fact, groups on levels 1-5 are considered
18834 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
18835 are @dfn{killed}.  Commands for listing groups and scanning for new
18836 articles will all use the numeric prefix as @dfn{working level}.
18837
18838 @item killed groups
18839 @cindex killed groups
18840 No information on killed groups is stored or updated, which makes killed
18841 groups much easier to handle than subscribed groups.
18842
18843 @item zombie groups
18844 @cindex zombie groups
18845 Just like killed groups, only slightly less dead.
18846
18847 @item active file
18848 @cindex active file
18849 The news server has to keep track of what articles it carries, and what
18850 groups exist.  All this information in stored in the active file, which
18851 is rather large, as you might surmise.
18852
18853 @item bogus groups
18854 @cindex bogus groups
18855 A group that exists in the @file{.newsrc} file, but isn't known to the
18856 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
18857 This means that the group probably doesn't exist (any more).
18858
18859 @item activating
18860 @cindex activating groups
18861 The act of asking the server for info on a group and computing the
18862 number of unread articles is called @dfn{activating the group}.
18863 Un-activated groups are listed with @samp{*} in the group buffer.
18864
18865 @item server
18866 @cindex server
18867 A machine one can connect to and get news (or mail) from.
18868
18869 @item select method
18870 @cindex select method
18871 A structure that specifies the backend, the server and the virtual
18872 server settings.
18873
18874 @item virtual server
18875 @cindex virtual server
18876 A named select method.  Since a select method defines all there is to
18877 know about connecting to a (physical) server, taking the thing as a
18878 whole is a virtual server.
18879
18880 @item washing
18881 @cindex washing
18882 Taking a buffer and running it through a filter of some sort.  The
18883 result will (more often than not) be cleaner and more pleasing than the
18884 original.
18885
18886 @item ephemeral groups
18887 @cindex ephemeral groups
18888 Most groups store data on what articles you have read.  @dfn{Ephemeral}
18889 groups are groups that will have no data stored---when you exit the
18890 group, it'll disappear into the aether.
18891
18892 @item solid groups
18893 @cindex solid groups
18894 This is the opposite of ephemeral groups.  All groups listed in the
18895 group buffer are solid groups.
18896
18897 @item sparse articles
18898 @cindex sparse articles
18899 These are article placeholders shown in the summary buffer when
18900 @code{gnus-build-sparse-threads} has been switched on.
18901
18902 @item threading
18903 @cindex threading
18904 To put responses to articles directly after the articles they respond
18905 to---in a hierarchical fashion.
18906
18907 @item root
18908 @cindex root
18909 @cindex thread root
18910 The first article in a thread is the root.  It is the ancestor of all
18911 articles in the thread.
18912
18913 @item parent
18914 @cindex parent
18915 An article that has responses.
18916
18917 @item child
18918 @cindex child
18919 An article that responds to a different article---its parent.
18920
18921 @item digest
18922 @cindex digest
18923 A collection of messages in one file.  The most common digest format is
18924 specified by RFC1153.
18925
18926 @end table
18927
18928
18929 @page
18930 @node Customization
18931 @section Customization
18932 @cindex general customization
18933
18934 All variables are properly documented elsewhere in this manual.  This
18935 section is designed to give general pointers on how to customize Gnus
18936 for some quite common situations.
18937
18938 @menu
18939 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
18940 * Slow Terminal Connection::  You run a remote Emacs.
18941 * Little Disk Space::         You feel that having large setup files is icky.
18942 * Slow Machine::              You feel like buying a faster machine.
18943 @end menu
18944
18945
18946 @node Slow/Expensive Connection
18947 @subsection Slow/Expensive @sc{nntp} Connection
18948
18949 If you run Emacs on a machine locally, and get your news from a machine
18950 over some very thin strings, you want to cut down on the amount of data
18951 Gnus has to get from the @sc{nntp} server.
18952
18953 @table @code
18954
18955 @item gnus-read-active-file
18956 Set this to @code{nil}, which will inhibit Gnus from requesting the
18957 entire active file from the server.  This file is often v.  large.  You
18958 also have to set @code{gnus-check-new-newsgroups} and
18959 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
18960 doesn't suddenly decide to fetch the active file anyway.
18961
18962 @item gnus-nov-is-evil
18963 This one has to be @code{nil}.  If not, grabbing article headers from
18964 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
18965 support @sc{xover}; Gnus will detect this by itself.
18966 @end table
18967
18968
18969 @node Slow Terminal Connection
18970 @subsection Slow Terminal Connection
18971
18972 Let's say you use your home computer for dialing up the system that runs
18973 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
18974 possible) the amount of data sent over the wires.
18975
18976 @table @code
18977
18978 @item gnus-auto-center-summary
18979 Set this to @code{nil} to inhibit Gnus from re-centering the summary
18980 buffer all the time.  If it is @code{vertical}, do only vertical
18981 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
18982 horizontal and vertical recentering.
18983
18984 @item gnus-visible-headers
18985 Cut down on the headers included in the articles to the
18986 minimum.  You can, in fact, make do without them altogether---most of the
18987 useful data is in the summary buffer, anyway.  Set this variable to
18988 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
18989
18990 Set this hook to all the available hiding commands:
18991 @lisp
18992 (setq gnus-treat-hide-headers 'head
18993       gnus-treat-hide-signature t
18994       gnus-treat-hide-citation t)
18995 @end lisp
18996
18997 @item gnus-use-full-window
18998 By setting this to @code{nil}, you can make all the windows smaller.
18999 While this doesn't really cut down much generally, it means that you
19000 have to see smaller portions of articles before deciding that you didn't
19001 want to read them anyway.
19002
19003 @item gnus-thread-hide-subtree
19004 If this is non-@code{nil}, all threads in the summary buffer will be
19005 hidden initially.
19006
19007 @item gnus-updated-mode-lines
19008 If this is @code{nil}, Gnus will not put information in the buffer mode
19009 lines, which might save some time.
19010 @end table
19011
19012
19013 @node Little Disk Space
19014 @subsection Little Disk Space
19015 @cindex disk space
19016
19017 The startup files can get rather large, so you may want to cut their
19018 sizes a bit if you are running out of space.
19019
19020 @table @code
19021
19022 @item gnus-save-newsrc-file
19023 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
19024 only save @file{.newsrc.eld}.  This means that you will not be able to
19025 use any other newsreaders than Gnus.  This variable is @code{t} by
19026 default.
19027
19028 @item gnus-save-killed-list
19029 If this is @code{nil}, Gnus will not save the list of dead groups.  You
19030 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
19031 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
19032 variable to @code{nil}.  This variable is @code{t} by default.
19033
19034 @end table
19035
19036
19037 @node Slow Machine
19038 @subsection Slow Machine
19039 @cindex slow machine
19040
19041 If you have a slow machine, or are just really impatient, there are a
19042 few things you can do to make Gnus run faster.
19043
19044 Set @code{gnus-check-new-newsgroups} and
19045 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
19046
19047 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
19048 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
19049 summary buffer faster.
19050
19051
19052 @page
19053 @node Troubleshooting
19054 @section Troubleshooting
19055 @cindex troubleshooting
19056
19057 Gnus works @emph{so} well straight out of the box---I can't imagine any
19058 problems, really.
19059
19060 Ahem.
19061
19062 @enumerate
19063
19064 @item
19065 Make sure your computer is switched on.
19066
19067 @item
19068 Make sure that you really load the current Gnus version.  If you have
19069 been running @sc{gnus}, you need to exit Emacs and start it up again before
19070 Gnus will work.
19071
19072 @item
19073 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
19074 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
19075 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
19076 flee}, you have some old @file{.el} files lying around.  Delete these.
19077
19078 @item
19079 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
19080 how-to.
19081
19082 @item
19083 @vindex max-lisp-eval-depth
19084 Gnus works on many recursive structures, and in some extreme (and very
19085 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
19086 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
19087 something like that.
19088 @end enumerate
19089
19090 If all else fails, report the problem as a bug.
19091
19092 @cindex bugs
19093 @cindex reporting bugs
19094
19095 @kindex M-x gnus-bug
19096 @findex gnus-bug
19097 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
19098 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
19099 me the backtrace.  I will fix bugs, but I can only fix them if you send
19100 me a precise description as to how to reproduce the bug.
19101
19102 You really can never be too detailed in a bug report.  Always use the
19103 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
19104 a 10Kb mail each time you use it, and even if you have sent me your
19105 environment 500 times before.  I don't care.  I want the full info each
19106 time.
19107
19108 It is also important to remember that I have no memory whatsoever.  If
19109 you send a bug report, and I send you a reply, and then you just send
19110 back ``No, it's not! Moron!'', I will have no idea what you are
19111 insulting me about.  Always over-explain everything.  It's much easier
19112 for all of us---if I don't have all the information I need, I will just
19113 mail you and ask for more info, and everything takes more time.
19114
19115 If the problem you're seeing is very visual, and you can't quite explain
19116 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
19117 it somewhere it can be reached, and include the URL of the picture in
19118 the bug report.
19119
19120 If you just need help, you are better off asking on
19121 @samp{gnu.emacs.gnus}.  I'm not very helpful.
19122
19123 @cindex gnu.emacs.gnus
19124 @cindex ding mailing list
19125 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
19126 Write to @samp{ding-request@@gnus.org} to subscribe.
19127
19128
19129 @page
19130 @node Gnus Reference Guide
19131 @section Gnus Reference Guide
19132
19133 It is my hope that other people will figure out smart stuff that Gnus
19134 can do, and that other people will write those smart things as well.  To
19135 facilitate that I thought it would be a good idea to describe the inner
19136 workings of Gnus.  And some of the not-so-inner workings, while I'm at
19137 it.
19138
19139 You can never expect the internals of a program not to change, but I
19140 will be defining (in some details) the interface between Gnus and its
19141 backends (this is written in stone), the format of the score files
19142 (ditto), data structures (some are less likely to change than others)
19143 and general methods of operation.
19144
19145 @menu
19146 * Gnus Utility Functions::   Common functions and variable to use.
19147 * Backend Interface::        How Gnus communicates with the servers.
19148 * Score File Syntax::        A BNF definition of the score file standard.
19149 * Headers::                  How Gnus stores headers internally.
19150 * Ranges::                   A handy format for storing mucho numbers.
19151 * Group Info::               The group info format.
19152 * Extended Interactive::     Symbolic prefixes and stuff.
19153 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
19154 * Various File Formats::     Formats of files that Gnus use.
19155 @end menu
19156
19157
19158 @node Gnus Utility Functions
19159 @subsection Gnus Utility Functions
19160 @cindex Gnus utility functions
19161 @cindex utility functions
19162 @cindex functions
19163 @cindex internal variables
19164
19165 When writing small functions to be run from hooks (and stuff), it's
19166 vital to have access to the Gnus internal functions and variables.
19167 Below is a list of the most common ones.
19168
19169 @table @code
19170
19171 @item gnus-newsgroup-name
19172 @vindex gnus-newsgroup-name
19173 This variable holds the name of the current newsgroup.
19174
19175 @item gnus-find-method-for-group
19176 @findex gnus-find-method-for-group
19177 A function that returns the select method for @var{group}.
19178
19179 @item gnus-group-real-name
19180 @findex gnus-group-real-name
19181 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19182 name.
19183
19184 @item gnus-group-prefixed-name
19185 @findex gnus-group-prefixed-name
19186 Takes an unprefixed group name and a select method, and returns the full
19187 (prefixed) Gnus group name.
19188
19189 @item gnus-get-info
19190 @findex gnus-get-info
19191 Returns the group info list for @var{group}.
19192
19193 @item gnus-group-unread
19194 @findex gnus-group-unread
19195 The number of unread articles in @var{group}, or @code{t} if that is
19196 unknown.
19197
19198 @item gnus-active
19199 @findex gnus-active
19200 The active entry for @var{group}.
19201
19202 @item gnus-set-active
19203 @findex gnus-set-active
19204 Set the active entry for @var{group}.
19205
19206 @item gnus-add-current-to-buffer-list
19207 @findex gnus-add-current-to-buffer-list
19208 Adds the current buffer to the list of buffers to be killed on Gnus
19209 exit.
19210
19211 @item gnus-continuum-version
19212 @findex gnus-continuum-version
19213 Takes a Gnus version string as a parameter and returns a floating point
19214 number.  Earlier versions will always get a lower number than later
19215 versions.
19216
19217 @item gnus-group-read-only-p
19218 @findex gnus-group-read-only-p
19219 Says whether @var{group} is read-only or not.
19220
19221 @item gnus-news-group-p
19222 @findex gnus-news-group-p
19223 Says whether @var{group} came from a news backend.
19224
19225 @item gnus-ephemeral-group-p
19226 @findex gnus-ephemeral-group-p
19227 Says whether @var{group} is ephemeral or not.
19228
19229 @item gnus-server-to-method
19230 @findex gnus-server-to-method
19231 Returns the select method corresponding to @var{server}.
19232
19233 @item gnus-server-equal
19234 @findex gnus-server-equal
19235 Says whether two virtual servers are equal.
19236
19237 @item gnus-group-native-p
19238 @findex gnus-group-native-p
19239 Says whether @var{group} is native or not.
19240
19241 @item gnus-group-secondary-p
19242 @findex gnus-group-secondary-p
19243 Says whether @var{group} is secondary or not.
19244
19245 @item gnus-group-foreign-p
19246 @findex gnus-group-foreign-p
19247 Says whether @var{group} is foreign or not.
19248
19249 @item group-group-find-parameter
19250 @findex group-group-find-parameter
19251 Returns the parameter list of @var{group}.  If given a second parameter,
19252 returns the value of that parameter for @var{group}.
19253
19254 @item gnus-group-set-parameter
19255 @findex gnus-group-set-parameter
19256 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19257
19258 @item gnus-narrow-to-body
19259 @findex gnus-narrow-to-body
19260 Narrows the current buffer to the body of the article.
19261
19262 @item gnus-check-backend-function
19263 @findex gnus-check-backend-function
19264 Takes two parameters, @var{function} and @var{group}.  If the backend
19265 @var{group} comes from supports @var{function}, return non-@code{nil}.
19266
19267 @lisp
19268 (gnus-check-backend-function "request-scan" "nnml:misc")
19269 @result{} t
19270 @end lisp
19271
19272 @item gnus-read-method
19273 @findex gnus-read-method
19274 Prompts the user for a select method.
19275
19276 @end table
19277
19278
19279 @node Backend Interface
19280 @subsection Backend Interface
19281
19282 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19283 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
19284 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
19285 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
19286 examples of the latter we have @code{nntp-port-number} and
19287 @code{nnmbox-directory}.
19288
19289 When Gnus asks for information from a backend---say @code{nntp}---on
19290 something, it will normally include a virtual server name in the
19291 function parameters.  (If not, the backend should use the ``current''
19292 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
19293 server as its only (optional) parameter.  If this virtual server hasn't
19294 been opened, the function should fail.
19295
19296 Note that a virtual server name has no relation to some physical server
19297 name.  Take this example:
19298
19299 @lisp
19300 (nntp "odd-one"
19301       (nntp-address "ifi.uio.no")
19302       (nntp-port-number 4324))
19303 @end lisp
19304
19305 Here the virtual server name is @samp{odd-one} while the name of
19306 the physical server is @samp{ifi.uio.no}.
19307
19308 The backends should be able to switch between several virtual servers.
19309 The standard backends implement this by keeping an alist of virtual
19310 server environments that they pull down/push up when needed.
19311
19312 There are two groups of interface functions: @dfn{required functions},
19313 which must be present, and @dfn{optional functions}, which Gnus will
19314 always check for presence before attempting to call 'em.
19315
19316 All these functions are expected to return data in the buffer
19317 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19318 unfortunately named, but we'll have to live with it.  When I talk about
19319 @dfn{resulting data}, I always refer to the data in that buffer.  When I
19320 talk about @dfn{return value}, I talk about the function value returned by
19321 the function call.  Functions that fail should return @code{nil} as the
19322 return value.
19323
19324 Some backends could be said to be @dfn{server-forming} backends, and
19325 some might be said not to be.  The latter are backends that generally
19326 only operate on one group at a time, and have no concept of ``server''
19327 -- they have a group, and they deliver info on that group and nothing
19328 more.
19329
19330 In the examples and definitions I will refer to the imaginary backend
19331 @code{nnchoke}.
19332
19333 @cindex @code{nnchoke}
19334
19335 @menu
19336 * Required Backend Functions::        Functions that must be implemented.
19337 * Optional Backend Functions::        Functions that need not be implemented.
19338 * Error Messaging::                   How to get messages and report errors.
19339 * Writing New Backends::              Extending old backends.
19340 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
19341 * Mail-like Backends::                Some tips on mail backends.
19342 @end menu
19343
19344
19345 @node Required Backend Functions
19346 @subsubsection Required Backend Functions
19347
19348 @table @code
19349
19350 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19351
19352 @var{articles} is either a range of article numbers or a list of
19353 @code{Message-ID}s.  Current backends do not fully support either---only
19354 sequences (lists) of article numbers, and most backends do not support
19355 retrieval of @code{Message-ID}s.  But they should try for both.
19356
19357 The result data should either be HEADs or NOV lines, and the result
19358 value should either be @code{headers} or @code{nov} to reflect this.
19359 This might later be expanded to @code{various}, which will be a mixture
19360 of HEADs and NOV lines, but this is currently not supported by Gnus.
19361
19362 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19363 headers", in some meaning of the word.  This is generally done by
19364 fetching (at most) @var{fetch-old} extra headers less than the smallest
19365 article number in @code{articles}, and filling the gaps as well.  The
19366 presence of this parameter can be ignored if the backend finds it
19367 cumbersome to follow the request.  If this is non-@code{nil} and not a
19368 number, do maximum fetches.
19369
19370 Here's an example HEAD:
19371
19372 @example
19373 221 1056 Article retrieved.
19374 Path: ifi.uio.no!sturles
19375 From: sturles@@ifi.uio.no (Sturle Sunde)
19376 Newsgroups: ifi.discussion
19377 Subject: Re: Something very droll
19378 Date: 27 Oct 1994 14:02:57 +0100
19379 Organization: Dept. of Informatics, University of Oslo, Norway
19380 Lines: 26
19381 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19382 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19383 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19384 .
19385 @end example
19386
19387 So a @code{headers} return value would imply that there's a number of
19388 these in the data buffer.
19389
19390 Here's a BNF definition of such a buffer:
19391
19392 @example
19393 headers        = *head
19394 head           = error / valid-head
19395 error-message  = [ "4" / "5" ] 2number " " <error message> eol
19396 valid-head     = valid-message *header "." eol
19397 valid-message  = "221 " <number> " Article retrieved." eol
19398 header         = <text> eol
19399 @end example
19400
19401 If the return value is @code{nov}, the data buffer should contain
19402 @dfn{network overview database} lines.  These are basically fields
19403 separated by tabs.
19404
19405 @example
19406 nov-buffer = *nov-line
19407 nov-line   = 8*9 [ field <TAB> ] eol
19408 field      = <text except TAB>
19409 @end example
19410
19411 For a closer look at what should be in those fields,
19412 @pxref{Headers}.
19413
19414
19415 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
19416
19417 @var{server} is here the virtual server name.  @var{definitions} is a
19418 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
19419
19420 If the server can't be opened, no error should be signaled.  The backend
19421 may then choose to refuse further attempts at connecting to this
19422 server.  In fact, it should do so.
19423
19424 If the server is opened already, this function should return a
19425 non-@code{nil} value.  There should be no data returned.
19426
19427
19428 @item (nnchoke-close-server &optional SERVER)
19429
19430 Close connection to @var{server} and free all resources connected
19431 to it.  Return @code{nil} if the server couldn't be closed for some
19432 reason.
19433
19434 There should be no data returned.
19435
19436
19437 @item (nnchoke-request-close)
19438
19439 Close connection to all servers and free all resources that the backend
19440 have reserved.  All buffers that have been created by that backend
19441 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
19442 function is generally only called when Gnus is shutting down.
19443
19444 There should be no data returned.
19445
19446
19447 @item (nnchoke-server-opened &optional SERVER)
19448
19449 If @var{server} is the current virtual server, and the connection to the
19450 physical server is alive, then this function should return a
19451 non-@code{nil} vlue.  This function should under no circumstances
19452 attempt to reconnect to a server we have lost connection to.
19453
19454 There should be no data returned.
19455
19456
19457 @item (nnchoke-status-message &optional SERVER)
19458
19459 This function should return the last error message from @var{server}.
19460
19461 There should be no data returned.
19462
19463
19464 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19465
19466 The result data from this function should be the article specified by
19467 @var{article}.  This might either be a @code{Message-ID} or a number.
19468 It is optional whether to implement retrieval by @code{Message-ID}, but
19469 it would be nice if that were possible.
19470
19471 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19472 in this buffer instead of the normal data buffer.  This is to make it
19473 possible to avoid copying large amounts of data from one buffer to
19474 another, while Gnus mainly requests articles to be inserted directly
19475 into its article buffer.
19476
19477 If it is at all possible, this function should return a cons cell where
19478 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19479 the article number.  This will enable Gnus to find out what the real
19480 group and article numbers are when fetching articles by
19481 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
19482 on successful article retrieval.
19483
19484
19485 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19486
19487 Get data on @var{group}.  This function also has the side effect of
19488 making @var{group} the current group.
19489
19490 If @var{FAST}, don't bother to return useful data, just make @var{group}
19491 the current group.
19492
19493 Here's an example of some result data and a definition of the same:
19494
19495 @example
19496 211 56 1000 1059 ifi.discussion
19497 @end example
19498
19499 The first number is the status, which should be 211.  Next is the
19500 total number of articles in the group, the lowest article number, the
19501 highest article number, and finally the group name.  Note that the total
19502 number of articles may be less than one might think while just
19503 considering the highest and lowest article numbers, but some articles
19504 may have been canceled.  Gnus just discards the total-number, so
19505 whether one should take the bother to generate it properly (if that is a
19506 problem) is left as an exercise to the reader.
19507
19508 @example
19509 group-status = [ error / info ] eol
19510 error        = [ "4" / "5" ] 2<number> " " <Error message>
19511 info         = "211 " 3* [ <number> " " ] <string>
19512 @end example
19513
19514
19515 @item (nnchoke-close-group GROUP &optional SERVER)
19516
19517 Close @var{group} and free any resources connected to it.  This will be
19518 a no-op on most backends.
19519
19520 There should be no data returned.
19521
19522
19523 @item (nnchoke-request-list &optional SERVER)
19524
19525 Return a list of all groups available on @var{server}.  And that means
19526 @emph{all}.
19527
19528 Here's an example from a server that only carries two groups:
19529
19530 @example
19531 ifi.test 0000002200 0000002000 y
19532 ifi.discussion 3324 3300 n
19533 @end example
19534
19535 On each line we have a group name, then the highest article number in
19536 that group, the lowest article number, and finally a flag.
19537
19538 @example
19539 active-file = *active-line
19540 active-line = name " " <number> " " <number> " " flags eol
19541 name        = <string>
19542 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
19543 @end example
19544
19545 The flag says whether the group is read-only (@samp{n}), is moderated
19546 (@samp{m}), is dead (@samp{x}), is aliased to some other group
19547 (@samp{=other-group}) or none of the above (@samp{y}).
19548
19549
19550 @item (nnchoke-request-post &optional SERVER)
19551
19552 This function should post the current buffer.  It might return whether
19553 the posting was successful or not, but that's not required.  If, for
19554 instance, the posting is done asynchronously, it has generally not been
19555 completed by the time this function concludes.  In that case, this
19556 function should set up some kind of sentinel to beep the user loud and
19557 clear if the posting could not be completed.
19558
19559 There should be no result data from this function.
19560
19561 @end table
19562
19563
19564 @node Optional Backend Functions
19565 @subsubsection Optional Backend Functions
19566
19567 @table @code
19568
19569 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
19570
19571 @var{groups} is a list of groups, and this function should request data
19572 on all those groups.  How it does it is of no concern to Gnus, but it
19573 should attempt to do this in a speedy fashion.
19574
19575 The return value of this function can be either @code{active} or
19576 @code{group}, which says what the format of the result data is.  The
19577 former is in the same format as the data from
19578 @code{nnchoke-request-list}, while the latter is a buffer full of lines
19579 in the same format as @code{nnchoke-request-group} gives.
19580
19581 @example
19582 group-buffer = *active-line / *group-status
19583 @end example
19584
19585
19586 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
19587
19588 A Gnus group info (@pxref{Group Info}) is handed to the backend for
19589 alterations.  This comes in handy if the backend really carries all the
19590 information (as is the case with virtual and imap groups).  This
19591 function should destructively alter the info to suit its needs, and
19592 should return the (altered) group info.
19593
19594 There should be no result data from this function.
19595
19596
19597 @item (nnchoke-request-type GROUP &optional ARTICLE)
19598
19599 When the user issues commands for ``sending news'' (@kbd{F} in the
19600 summary buffer, for instance), Gnus has to know whether the article the
19601 user is following up on is news or mail.  This function should return
19602 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
19603 is mail and @code{unknown} if the type can't be decided.  (The
19604 @var{article} parameter is necessary in @code{nnvirtual} groups which
19605 might very well combine mail groups and news groups.)  Both @var{group}
19606 and @var{article} may be @code{nil}.
19607
19608 There should be no result data from this function.
19609
19610
19611 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
19612
19613 Set/remove/add marks on articles. Normally Gnus handles the article
19614 marks (such as read, ticked, expired etc) internally, and store them in
19615 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
19616 information about the articles on the server, so Gnus need to propagate
19617 the mark information to the server.
19618
19619 ACTION is a list of mark setting requests, having this format:
19620
19621 @example
19622 (RANGE ACTION MARK)
19623 @end example
19624
19625 Range is a range of articles you wish to update marks on. Action is
19626 @code{set}, @code{add} or @code{del}, respectively used for removing all
19627 existing marks and setting them as specified, adding (preserving the
19628 marks not mentioned) mark and removing (preserving the marks not
19629 mentioned) marks. Mark is a list of marks; where each mark is a
19630 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
19631 @code{expire}, @code{killed}, @code{dormant}, @code{save},
19632 @code{download} and @code{unsend}, but your backend should, if possible,
19633 not limit itself to theese.
19634
19635 Given contradictory actions, the last action in the list should be the
19636 effective one. That is, if your action contains a request to add the
19637 @code{tick} mark on article 1 and, later in the list, a request to
19638 remove the mark on the same article, the mark should in fact be removed.
19639
19640 An example action list:
19641
19642 @example
19643 (((5 12 30) 'del '(tick))
19644  ((10 . 90) 'add '(read expire))
19645  ((92 94) 'del '(read)))
19646 @end example
19647
19648 The function should return a range of articles it wasn't able to set the
19649 mark on (currently not used for anything).
19650
19651 There should be no result data from this function.
19652
19653 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
19654
19655 If the user tries to set a mark that the backend doesn't like, this
19656 function may change the mark.  Gnus will use whatever this function
19657 returns as the mark for @var{article} instead of the original
19658 @var{mark}.  If the backend doesn't care, it must return the original
19659 @var{mark}, and not @code{nil} or any other type of garbage.
19660
19661 The only use for this I can see is what @code{nnvirtual} does with
19662 it---if a component group is auto-expirable, marking an article as read
19663 in the virtual group should result in the article being marked as
19664 expirable.
19665
19666 There should be no result data from this function.
19667
19668
19669 @item (nnchoke-request-scan &optional GROUP SERVER)
19670
19671 This function may be called at any time (by Gnus or anything else) to
19672 request that the backend check for incoming articles, in one way or
19673 another.  A mail backend will typically read the spool file or query the
19674 POP server when this function is invoked.  The @var{group} doesn't have
19675 to be heeded---if the backend decides that it is too much work just
19676 scanning for a single group, it may do a total scan of all groups.  It
19677 would be nice, however, to keep things local if that's practical.
19678
19679 There should be no result data from this function.
19680
19681
19682 @item (nnchoke-request-group-description GROUP &optional SERVER)
19683
19684 The result data from this function should be a description of
19685 @var{group}.
19686
19687 @example
19688 description-line = name <TAB> description eol
19689 name             = <string>
19690 description      = <text>
19691 @end example
19692
19693 @item (nnchoke-request-list-newsgroups &optional SERVER)
19694
19695 The result data from this function should be the description of all
19696 groups available on the server.
19697
19698 @example
19699 description-buffer = *description-line
19700 @end example
19701
19702
19703 @item (nnchoke-request-newgroups DATE &optional SERVER)
19704
19705 The result data from this function should be all groups that were
19706 created after @samp{date}, which is in normal human-readable date
19707 format.  The data should be in the active buffer format.
19708
19709
19710 @item (nnchoke-request-create-group GROUP &optional SERVER)
19711
19712 This function should create an empty group with name @var{group}.
19713
19714 There should be no return data.
19715
19716
19717 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
19718
19719 This function should run the expiry process on all articles in the
19720 @var{articles} range (which is currently a simple list of article
19721 numbers.)  It is left up to the backend to decide how old articles
19722 should be before they are removed by this function.  If @var{force} is
19723 non-@code{nil}, all @var{articles} should be deleted, no matter how new
19724 they are.
19725
19726 This function should return a list of articles that it did not/was not
19727 able to delete.
19728
19729 There should be no result data returned.
19730
19731
19732 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
19733 &optional LAST)
19734
19735 This function should move @var{article} (which is a number) from
19736 @var{group} by calling @var{accept-form}.
19737
19738 This function should ready the article in question for moving by
19739 removing any header lines it has added to the article, and generally
19740 should ``tidy up'' the article.  Then it should @code{eval}
19741 @var{accept-form} in the buffer where the ``tidy'' article is.  This
19742 will do the actual copying.  If this @code{eval} returns a
19743 non-@code{nil} value, the article should be removed.
19744
19745 If @var{last} is @code{nil}, that means that there is a high likelihood
19746 that there will be more requests issued shortly, so that allows some
19747 optimizations.
19748
19749 The function should return a cons where the @code{car} is the group name and
19750 the @code{cdr} is the article number that the article was entered as.
19751
19752 There should be no data returned.
19753
19754
19755 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
19756
19757 This function takes the current buffer and inserts it into @var{group}.
19758 If @var{last} in @code{nil}, that means that there will be more calls to
19759 this function in short order.
19760
19761 The function should return a cons where the @code{car} is the group name and
19762 the @code{cdr} is the article number that the article was entered as.
19763
19764 There should be no data returned.
19765
19766
19767 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
19768
19769 This function should remove @var{article} (which is a number) from
19770 @var{group} and insert @var{buffer} there instead.
19771
19772 There should be no data returned.
19773
19774
19775 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
19776
19777 This function should delete @var{group}.  If @var{force}, it should
19778 really delete all the articles in the group, and then delete the group
19779 itself.  (If there is such a thing as ``the group itself''.)
19780
19781 There should be no data returned.
19782
19783
19784 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
19785
19786 This function should rename @var{group} into @var{new-name}.  All
19787 articles in @var{group} should move to @var{new-name}.
19788
19789 There should be no data returned.
19790
19791 @end table
19792
19793
19794 @node Error Messaging
19795 @subsubsection Error Messaging
19796
19797 @findex nnheader-report
19798 @findex nnheader-get-report
19799 The backends should use the function @code{nnheader-report} to report
19800 error conditions---they should not raise errors when they aren't able to
19801 perform a request.  The first argument to this function is the backend
19802 symbol, and the rest are interpreted as arguments to @code{format} if
19803 there are multiple of them, or just a string if there is one of them.
19804 This function must always returns @code{nil}.
19805
19806 @lisp
19807 (nnheader-report 'nnchoke "You did something totally bogus")
19808
19809 (nnheader-report 'nnchoke "Could not request group %s" group)
19810 @end lisp
19811
19812 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
19813 @code{nil} back from a server, and this function returns the most
19814 recently reported message for the backend in question.  This function
19815 takes one argument---the server symbol.
19816
19817 Internally, these functions access @var{backend}@code{-status-string},
19818 so the @code{nnchoke} backend will have its error message stored in
19819 @code{nnchoke-status-string}.
19820
19821
19822 @node Writing New Backends
19823 @subsubsection Writing New Backends
19824
19825 Many backends are quite similar.  @code{nnml} is just like
19826 @code{nnspool}, but it allows you to edit the articles on the server.
19827 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
19828 and it doesn't maintain overview databases.  @code{nndir} is just like
19829 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
19830 editing articles.
19831
19832 It would make sense if it were possible to ``inherit'' functions from
19833 backends when writing new backends.  And, indeed, you can do that if you
19834 want to.  (You don't have to if you don't want to, of course.)
19835
19836 All the backends declare their public variables and functions by using a
19837 package called @code{nnoo}.
19838
19839 To inherit functions from other backends (and allow other backends to
19840 inherit functions from the current backend), you should use the
19841 following macros:
19842
19843 @table @code
19844
19845 @item nnoo-declare
19846 This macro declares the first parameter to be a child of the subsequent
19847 parameters.  For instance:
19848
19849 @lisp
19850 (nnoo-declare nndir
19851   nnml nnmh)
19852 @end lisp
19853
19854 @code{nndir} has declared here that it intends to inherit functions from
19855 both @code{nnml} and @code{nnmh}.
19856
19857 @item defvoo
19858 This macro is equivalent to @code{defvar}, but registers the variable as
19859 a public server variable.  Most state-oriented variables should be
19860 declared with @code{defvoo} instead of @code{defvar}.
19861
19862 In addition to the normal @code{defvar} parameters, it takes a list of
19863 variables in the parent backends to map the variable to when executing
19864 a function in those backends.
19865
19866 @lisp
19867 (defvoo nndir-directory nil
19868   "Where nndir will look for groups."
19869   nnml-current-directory nnmh-current-directory)
19870 @end lisp
19871
19872 This means that @code{nnml-current-directory} will be set to
19873 @code{nndir-directory} when an @code{nnml} function is called on behalf
19874 of @code{nndir}.  (The same with @code{nnmh}.)
19875
19876 @item nnoo-define-basics
19877 This macro defines some common functions that almost all backends should
19878 have.
19879
19880 @example
19881 (nnoo-define-basics nndir)
19882 @end example
19883
19884 @item deffoo
19885 This macro is just like @code{defun} and takes the same parameters.  In
19886 addition to doing the normal @code{defun} things, it registers the
19887 function as being public so that other backends can inherit it.
19888
19889 @item nnoo-map-functions
19890 This macro allows mapping of functions from the current backend to
19891 functions from the parent backends.
19892
19893 @example
19894 (nnoo-map-functions nndir
19895   (nnml-retrieve-headers 0 nndir-current-group 0 0)
19896   (nnmh-request-article 0 nndir-current-group 0 0))
19897 @end example
19898
19899 This means that when @code{nndir-retrieve-headers} is called, the first,
19900 third, and fourth parameters will be passed on to
19901 @code{nnml-retrieve-headers}, while the second parameter is set to the
19902 value of @code{nndir-current-group}.
19903
19904 @item nnoo-import
19905 This macro allows importing functions from backends.  It should be the
19906 last thing in the source file, since it will only define functions that
19907 haven't already been defined.
19908
19909 @example
19910 (nnoo-import nndir
19911   (nnmh
19912    nnmh-request-list
19913    nnmh-request-newgroups)
19914   (nnml))
19915 @end example
19916
19917 This means that calls to @code{nndir-request-list} should just be passed
19918 on to @code{nnmh-request-list}, while all public functions from
19919 @code{nnml} that haven't been defined in @code{nndir} yet should be
19920 defined now.
19921
19922 @end table
19923
19924 Below is a slightly shortened version of the @code{nndir} backend.
19925
19926 @lisp
19927 ;;; nndir.el --- single directory newsgroup access for Gnus
19928 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
19929
19930 ;;; Code:
19931
19932 (require 'nnheader)
19933 (require 'nnmh)
19934 (require 'nnml)
19935 (require 'nnoo)
19936 (eval-when-compile (require 'cl))
19937
19938 (nnoo-declare nndir
19939   nnml nnmh)
19940
19941 (defvoo nndir-directory nil
19942   "Where nndir will look for groups."
19943   nnml-current-directory nnmh-current-directory)
19944
19945 (defvoo nndir-nov-is-evil nil
19946   "*Non-nil means that nndir will never retrieve NOV headers."
19947   nnml-nov-is-evil)
19948
19949 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
19950 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
19951 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
19952
19953 (defvoo nndir-status-string "" nil nnmh-status-string)
19954 (defconst nndir-version "nndir 1.0")
19955
19956 ;;; Interface functions.
19957
19958 (nnoo-define-basics nndir)
19959
19960 (deffoo nndir-open-server (server &optional defs)
19961   (setq nndir-directory
19962         (or (cadr (assq 'nndir-directory defs))
19963             server))
19964   (unless (assq 'nndir-directory defs)
19965     (push `(nndir-directory ,server) defs))
19966   (push `(nndir-current-group
19967           ,(file-name-nondirectory (directory-file-name nndir-directory)))
19968         defs)
19969   (push `(nndir-top-directory
19970           ,(file-name-directory (directory-file-name nndir-directory)))
19971         defs)
19972   (nnoo-change-server 'nndir server defs))
19973
19974 (nnoo-map-functions nndir
19975   (nnml-retrieve-headers 0 nndir-current-group 0 0)
19976   (nnmh-request-article 0 nndir-current-group 0 0)
19977   (nnmh-request-group nndir-current-group 0 0)
19978   (nnmh-close-group nndir-current-group 0))
19979
19980 (nnoo-import nndir
19981   (nnmh
19982    nnmh-status-message
19983    nnmh-request-list
19984    nnmh-request-newgroups))
19985
19986 (provide 'nndir)
19987 @end lisp
19988
19989
19990 @node Hooking New Backends Into Gnus
19991 @subsubsection Hooking New Backends Into Gnus
19992
19993 @vindex gnus-valid-select-methods
19994 Having Gnus start using your new backend is rather easy---you just
19995 declare it with the @code{gnus-declare-backend} functions.  This will
19996 enter the backend into the @code{gnus-valid-select-methods} variable.
19997
19998 @code{gnus-declare-backend} takes two parameters---the backend name and
19999 an arbitrary number of @dfn{abilities}.
20000
20001 Here's an example:
20002
20003 @lisp
20004 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
20005 @end lisp
20006
20007 The abilities can be:
20008
20009 @table @code
20010 @item mail
20011 This is a mailish backend---followups should (probably) go via mail.
20012 @item post
20013 This is a newsish backend---followups should (probably) go via news.
20014 @item post-mail
20015 This backend supports both mail and news.
20016 @item none
20017 This is neither a post nor mail backend---it's something completely
20018 different.
20019 @item respool
20020 It supports respooling---or rather, it is able to modify its source
20021 articles and groups.
20022 @item address
20023 The name of the server should be in the virtual server name.  This is
20024 true for almost all backends.
20025 @item prompt-address
20026 The user should be prompted for an address when doing commands like
20027 @kbd{B} in the group buffer.  This is true for backends like
20028 @code{nntp}, but not @code{nnmbox}, for instance.
20029 @end table
20030
20031
20032 @node Mail-like Backends
20033 @subsubsection Mail-like Backends
20034
20035 One of the things that separate the mail backends from the rest of the
20036 backends is the heavy dependence by the mail backends on common
20037 functions in @file{nnmail.el}.  For instance, here's the definition of
20038 @code{nnml-request-scan}:
20039
20040 @lisp
20041 (deffoo nnml-request-scan (&optional group server)
20042   (setq nnml-article-file-alist nil)
20043   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
20044 @end lisp
20045
20046 It simply calls @code{nnmail-get-new-mail} with a few parameters,
20047 and @code{nnmail} takes care of all the moving and splitting of the
20048 mail.
20049
20050 This function takes four parameters.
20051
20052 @table @var
20053 @item method
20054 This should be a symbol to designate which backend is responsible for
20055 the call.
20056
20057 @item exit-function
20058 This function should be called after the splitting has been performed.
20059
20060 @item temp-directory
20061 Where the temporary files should be stored.
20062
20063 @item group
20064 This optional argument should be a group name if the splitting is to be
20065 performed for one group only.
20066 @end table
20067
20068 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
20069 save each article.  @var{backend}@code{-active-number} will be called to
20070 find the article number assigned to this article.
20071
20072 The function also uses the following variables:
20073 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
20074 this backend); and @var{backend}@code{-group-alist} and
20075 @var{backend}@code{-active-file} to generate the new active file.
20076 @var{backend}@code{-group-alist} should be a group-active alist, like
20077 this:
20078
20079 @example
20080 (("a-group" (1 . 10))
20081  ("some-group" (34 . 39)))
20082 @end example
20083
20084
20085 @node Score File Syntax
20086 @subsection Score File Syntax
20087
20088 Score files are meant to be easily parseable, but yet extremely
20089 mallable.   It was decided that something that had the same read syntax
20090 as an Emacs Lisp list would fit that spec.
20091
20092 Here's a typical score file:
20093
20094 @lisp
20095 (("summary"
20096   ("win95" -10000 nil s)
20097   ("Gnus"))
20098  ("from"
20099   ("Lars" -1000))
20100  (mark -100))
20101 @end lisp
20102
20103 BNF definition of a score file:
20104
20105 @example
20106 score-file       = "" / "(" *element ")"
20107 element          = rule / atom
20108 rule             = string-rule / number-rule / date-rule
20109 string-rule      = "(" quote string-header quote space *string-match ")"
20110 number-rule      = "(" quote number-header quote space *number-match ")"
20111 date-rule        = "(" quote date-header quote space *date-match ")"
20112 quote            = <ascii 34>
20113 string-header    = "subject" / "from" / "references" / "message-id" /
20114                    "xref" / "body" / "head" / "all" / "followup"
20115 number-header    = "lines" / "chars"
20116 date-header      = "date"
20117 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
20118                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
20119 score            = "nil" / <integer>
20120 date             = "nil" / <natural number>
20121 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
20122                    "r" / "regex" / "R" / "Regex" /
20123                    "e" / "exact" / "E" / "Exact" /
20124                    "f" / "fuzzy" / "F" / "Fuzzy"
20125 number-match     = "(" <integer> [ "" / [ space score [ "" /
20126                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
20127 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
20128 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
20129                    space date [ "" / [ space date-match-t ] ] ] ] ")"
20130 date-match-t     = "nil" / "at" / "before" / "after"
20131 atom             = "(" [ required-atom / optional-atom ] ")"
20132 required-atom    = mark / expunge / mark-and-expunge / files /
20133                    exclude-files / read-only / touched
20134 optional-atom    = adapt / local / eval
20135 mark             = "mark" space nil-or-number
20136 nil-or-number    = "nil" / <integer>
20137 expunge          = "expunge" space nil-or-number
20138 mark-and-expunge = "mark-and-expunge" space nil-or-number
20139 files            = "files" *[ space <string> ]
20140 exclude-files    = "exclude-files" *[ space <string> ]
20141 read-only        = "read-only" [ space "nil" / space "t" ]
20142 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
20143 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
20144 local            = "local" *[ space "(" <string> space <form> ")" ]
20145 eval             = "eval" space <form>
20146 space            = *[ " " / <TAB> / <NEWLINE> ]
20147 @end example
20148
20149 Any unrecognized elements in a score file should be ignored, but not
20150 discarded.
20151
20152 As you can see, white space is needed, but the type and amount of white
20153 space is irrelevant.  This means that formatting of the score file is
20154 left up to the programmer---if it's simpler to just spew it all out on
20155 one looong line, then that's ok.
20156
20157 The meaning of the various atoms are explained elsewhere in this
20158 manual (@pxref{Score File Format}).
20159
20160
20161 @node Headers
20162 @subsection Headers
20163
20164 Internally Gnus uses a format for storing article headers that
20165 corresponds to the @sc{nov} format in a mysterious fashion.  One could
20166 almost suspect that the author looked at the @sc{nov} specification and
20167 just shamelessly @emph{stole} the entire thing, and one would be right.
20168
20169 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
20170 RFC1036 to talk about lines in the head of an article (e.g.,
20171 @code{From}).  It is used by many people as a synonym for
20172 ``head''---``the header and the body''.  (That should be avoided, in my
20173 opinion.)  And Gnus uses a format internally that it calls ``header'',
20174 which is what I'm talking about here.  This is a 9-element vector,
20175 basically, with each header (ouch) having one slot.
20176
20177 These slots are, in order: @code{number}, @code{subject}, @code{from},
20178 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
20179 @code{xref}, and @code{extra}.  There are macros for accessing and
20180 setting these slots---they all have predictable names beginning with
20181 @code{mail-header-} and @code{mail-header-set-}, respectively.
20182
20183 All these slots contain strings, except the @code{extra} slot, which
20184 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20185
20186
20187 @node Ranges
20188 @subsection Ranges
20189
20190 @sc{gnus} introduced a concept that I found so useful that I've started
20191 using it a lot and have elaborated on it greatly.
20192
20193 The question is simple: If you have a large amount of objects that are
20194 identified by numbers (say, articles, to take a @emph{wild} example)
20195 that you want to qualify as being ``included'', a normal sequence isn't
20196 very useful.  (A 200,000 length sequence is a bit long-winded.)
20197
20198 The solution is as simple as the question: You just collapse the
20199 sequence.
20200
20201 @example
20202 (1 2 3 4 5 6 10 11 12)
20203 @end example
20204
20205 is transformed into
20206
20207 @example
20208 ((1 . 6) (10 . 12))
20209 @end example
20210
20211 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20212 lonesome object, a @samp{13} is a valid element:
20213
20214 @example
20215 ((1 . 6) 7 (10 . 12))
20216 @end example
20217
20218 This means that comparing two ranges to find out whether they are equal
20219 is slightly tricky:
20220
20221 @example
20222 ((1 . 5) 7 8 (10 . 12))
20223 @end example
20224
20225 and
20226
20227 @example
20228 ((1 . 5) (7 . 8) (10 . 12))
20229 @end example
20230
20231 are equal.  In fact, any non-descending list is a range:
20232
20233 @example
20234 (1 2 3 4 5)
20235 @end example
20236
20237 is a perfectly valid range, although a pretty long-winded one.  This is
20238 also valid:
20239
20240 @example
20241 (1 . 5)
20242 @end example
20243
20244 and is equal to the previous range.
20245
20246 Here's a BNF definition of ranges.  Of course, one must remember the
20247 semantic requirement that the numbers are non-descending.  (Any number
20248 of repetition of the same number is allowed, but apt to disappear in
20249 range handling.)
20250
20251 @example
20252 range           = simple-range / normal-range
20253 simple-range    = "(" number " . " number ")"
20254 normal-range    = "(" start-contents ")"
20255 contents        = "" / simple-range *[ " " contents ] /
20256                   number *[ " " contents ]
20257 @end example
20258
20259 Gnus currently uses ranges to keep track of read articles and article
20260 marks.  I plan on implementing a number of range operators in C if The
20261 Powers That Be are willing to let me.  (I haven't asked yet, because I
20262 need to do some more thinking on what operators I need to make life
20263 totally range-based without ever having to convert back to normal
20264 sequences.)
20265
20266
20267 @node Group Info
20268 @subsection Group Info
20269
20270 Gnus stores all permanent info on groups in a @dfn{group info} list.
20271 This list is from three to six elements (or more) long and exhaustively
20272 describes the group.
20273
20274 Here are two example group infos; one is a very simple group while the
20275 second is a more complex one:
20276
20277 @example
20278 ("no.group" 5 ((1 . 54324)))
20279
20280 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20281                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20282                 (nnml "")
20283                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20284 @end example
20285
20286 The first element is the @dfn{group name}---as Gnus knows the group,
20287 anyway.  The second element is the @dfn{subscription level}, which
20288 normally is a small integer.  (It can also be the @dfn{rank}, which is a
20289 cons cell where the @code{car} is the level and the @code{cdr} is the
20290 score.)  The third element is a list of ranges of read articles.  The
20291 fourth element is a list of lists of article marks of various kinds.
20292 The fifth element is the select method (or virtual server, if you like).
20293 The sixth element is a list of @dfn{group parameters}, which is what
20294 this section is about.
20295
20296 Any of the last three elements may be missing if they are not required.
20297 In fact, the vast majority of groups will normally only have the first
20298 three elements, which saves quite a lot of cons cells.
20299
20300 Here's a BNF definition of the group info format:
20301
20302 @example
20303 info          = "(" group space ralevel space read
20304                 [ "" / [ space marks-list [ "" / [ space method [ "" /
20305                 space parameters ] ] ] ] ] ")"
20306 group         = quote <string> quote
20307 ralevel       = rank / level
20308 level         = <integer in the range of 1 to inf>
20309 rank          = "(" level "." score ")"
20310 score         = <integer in the range of 1 to inf>
20311 read          = range
20312 marks-lists   = nil / "(" *marks ")"
20313 marks         = "(" <string> range ")"
20314 method        = "(" <string> *elisp-forms ")"
20315 parameters    = "(" *elisp-forms ")"
20316 @end example
20317
20318 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
20319 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20320 in pseudo-BNF.
20321
20322 If you have a Gnus info and want to access the elements, Gnus offers a
20323 series of macros for getting/setting these elements.
20324
20325 @table @code
20326 @item gnus-info-group
20327 @itemx gnus-info-set-group
20328 @findex gnus-info-group
20329 @findex gnus-info-set-group
20330 Get/set the group name.
20331
20332 @item gnus-info-rank
20333 @itemx gnus-info-set-rank
20334 @findex gnus-info-rank
20335 @findex gnus-info-set-rank
20336 Get/set the group rank (@pxref{Group Score}).
20337
20338 @item gnus-info-level
20339 @itemx gnus-info-set-level
20340 @findex gnus-info-level
20341 @findex gnus-info-set-level
20342 Get/set the group level.
20343
20344 @item gnus-info-score
20345 @itemx gnus-info-set-score
20346 @findex gnus-info-score
20347 @findex gnus-info-set-score
20348 Get/set the group score (@pxref{Group Score}).
20349
20350 @item gnus-info-read
20351 @itemx gnus-info-set-read
20352 @findex gnus-info-read
20353 @findex gnus-info-set-read
20354 Get/set the ranges of read articles.
20355
20356 @item gnus-info-marks
20357 @itemx gnus-info-set-marks
20358 @findex gnus-info-marks
20359 @findex gnus-info-set-marks
20360 Get/set the lists of ranges of marked articles.
20361
20362 @item gnus-info-method
20363 @itemx gnus-info-set-method
20364 @findex gnus-info-method
20365 @findex gnus-info-set-method
20366 Get/set the group select method.
20367
20368 @item gnus-info-params
20369 @itemx gnus-info-set-params
20370 @findex gnus-info-params
20371 @findex gnus-info-set-params
20372 Get/set the group parameters.
20373 @end table
20374
20375 All the getter functions take one parameter---the info list.  The setter
20376 functions take two parameters---the info list and the new value.
20377
20378 The last three elements in the group info aren't mandatory, so it may be
20379 necessary to extend the group info before setting the element.  If this
20380 is necessary, you can just pass on a non-@code{nil} third parameter to
20381 the three final setter functions to have this happen automatically.
20382
20383
20384 @node Extended Interactive
20385 @subsection Extended Interactive
20386 @cindex interactive
20387 @findex gnus-interactive
20388
20389 Gnus extends the standard Emacs @code{interactive} specification
20390 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
20391 Prefixes}).  Here's an example of how this is used:
20392
20393 @lisp
20394 (defun gnus-summary-increase-score (&optional score symp)
20395   (interactive (gnus-interactive "P\ny"))
20396   ...
20397   )
20398 @end lisp
20399
20400 The best thing to do would have been to implement
20401 @code{gnus-interactive} as a macro which would have returned an
20402 @code{interactive} form, but this isn't possible since Emacs checks
20403 whether a function is interactive or not by simply doing an @code{assq}
20404 on the lambda form.  So, instead we have @code{gnus-interactive}
20405 function that takes a string and returns values that are usable to
20406 @code{interactive}.
20407
20408 This function accepts (almost) all normal @code{interactive} specs, but
20409 adds a few more.
20410
20411 @table @samp
20412 @item y
20413 @vindex gnus-current-prefix-symbol
20414 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
20415 variable.
20416
20417 @item Y
20418 @vindex gnus-current-prefix-symbols
20419 A list of the current symbolic prefixes---the
20420 @code{gnus-current-prefix-symbol} variable.
20421
20422 @item A
20423 The current article number---the @code{gnus-summary-article-number}
20424 function.
20425
20426 @item H
20427 The current article header---the @code{gnus-summary-article-header}
20428 function.
20429
20430 @item g
20431 The current group name---the @code{gnus-group-group-name}
20432 function.
20433
20434 @end table
20435
20436
20437 @node Emacs/XEmacs Code
20438 @subsection Emacs/XEmacs Code
20439 @cindex XEmacs
20440 @cindex Emacsen
20441
20442 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
20443 platforms must be the primary one.  I chose Emacs.  Not because I don't
20444 like XEmacs or Mule, but because it comes first alphabetically.
20445
20446 This means that Gnus will byte-compile under Emacs with nary a warning,
20447 while XEmacs will pump out gigabytes of warnings while byte-compiling.
20448 As I use byte-compilation warnings to help me root out trivial errors in
20449 Gnus, that's very useful.
20450
20451 I've also consistently used Emacs function interfaces, but have used
20452 Gnusey aliases for the functions.  To take an example:  Emacs defines a
20453 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
20454 function.  I then define a function called @code{gnus-run-at-time} that
20455 takes the same parameters as the Emacs @code{run-at-time}.  When running
20456 Gnus under Emacs, the former function is just an alias for the latter.
20457 However, when running under XEmacs, the former is an alias for the
20458 following function:
20459
20460 @lisp
20461 (defun gnus-xmas-run-at-time (time repeat function &rest args)
20462   (start-itimer
20463    "gnus-run-at-time"
20464    `(lambda ()
20465       (,function ,@@args))
20466    time repeat))
20467 @end lisp
20468
20469 This sort of thing has been done for bunches of functions.  Gnus does
20470 not redefine any native Emacs functions while running under XEmacs---it
20471 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
20472 all over.
20473
20474 In the cases where the XEmacs function interface was obviously cleaner,
20475 I used it instead.  For example @code{gnus-region-active-p} is an alias
20476 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
20477
20478 Of course, I could have chosen XEmacs as my native platform and done
20479 mapping functions the other way around.  But I didn't.  The performance
20480 hit these indirections impose on Gnus under XEmacs should be slight.
20481
20482
20483 @node Various File Formats
20484 @subsection Various File Formats
20485
20486 @menu
20487 * Active File Format::      Information on articles and groups available.
20488 * Newsgroups File Format::  Group descriptions.
20489 @end menu
20490
20491
20492 @node Active File Format
20493 @subsubsection Active File Format
20494
20495 The active file lists all groups available on the server in
20496 question.  It also lists the highest and lowest current article numbers
20497 in each group.
20498
20499 Here's an excerpt from a typical active file:
20500
20501 @example
20502 soc.motss 296030 293865 y
20503 alt.binaries.pictures.fractals 3922 3913 n
20504 comp.sources.unix 1605 1593 m
20505 comp.binaries.ibm.pc 5097 5089 y
20506 no.general 1000 900 y
20507 @end example
20508
20509 Here's a pseudo-BNF definition of this file:
20510
20511 @example
20512 active      = *group-line
20513 group-line  = group space high-number space low-number space flag <NEWLINE>
20514 group       = <non-white-space string>
20515 space       = " "
20516 high-number = <non-negative integer>
20517 low-number  = <positive integer>
20518 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
20519 @end example
20520
20521 For a full description of this file, see the manual pages for
20522 @samp{innd}, in particular @samp{active(5)}.
20523
20524
20525 @node Newsgroups File Format
20526 @subsubsection Newsgroups File Format
20527
20528 The newsgroups file lists groups along with their descriptions.  Not all
20529 groups on the server have to be listed,  and not all groups in the file
20530 have to exist on the server.  The file is meant purely as information to
20531 the user.
20532
20533 The format is quite simple; a group name, a tab, and the description.
20534 Here's the definition:
20535
20536 @example
20537 newsgroups    = *line
20538 line          = group tab description <NEWLINE>
20539 group         = <non-white-space string>
20540 tab           = <TAB>
20541 description   = <string>
20542 @end example
20543
20544
20545 @page
20546 @node Emacs for Heathens
20547 @section Emacs for Heathens
20548
20549 Believe it or not, but some people who use Gnus haven't really used
20550 Emacs much before they embarked on their journey on the Gnus Love Boat.
20551 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
20552 region'', and ``set @code{gnus-flargblossen} to an alist where the key
20553 is a regexp that is used for matching on the group name'' are magical
20554 phrases with little or no meaning, then this appendix is for you.  If
20555 you are already familiar with Emacs, just ignore this and go fondle your
20556 cat instead.
20557
20558 @menu
20559 * Keystrokes::      Entering text and executing commands.
20560 * Emacs Lisp::      The built-in Emacs programming language.
20561 @end menu
20562
20563
20564 @node Keystrokes
20565 @subsection Keystrokes
20566
20567 @itemize @bullet
20568 @item
20569 Q: What is an experienced Emacs user?
20570
20571 @item
20572 A: A person who wishes that the terminal had pedals.
20573 @end itemize
20574
20575 Yes, when you use Emacs, you are apt to use the control key, the shift
20576 key and the meta key a lot.  This is very annoying to some people
20577 (notably @code{vi}le users), and the rest of us just love the hell out
20578 of it.  Just give up and submit.  Emacs really does stand for
20579 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
20580 may have heard from other disreputable sources (like the Emacs author).
20581
20582 The shift keys are normally located near your pinky fingers, and are
20583 normally used to get capital letters and stuff.  You probably use it all
20584 the time.  The control key is normally marked ``CTRL'' or something like
20585 that.  The meta key is, funnily enough, never marked as such on any
20586 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
20587 which is the meta key on this keyboard.  It's usually located somewhere
20588 to the left hand side of the keyboard, usually on the bottom row.
20589
20590 Now, us Emacs people don't say ``press the meta-control-m key'',
20591 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
20592 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
20593 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
20594 down the control key, and hold it down while you press @kbd{k}''.
20595 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
20596 the control key and then press @kbd{k}''.  Simple, ay?
20597
20598 This is somewhat complicated by the fact that not all keyboards have a
20599 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
20600 means ``press escape, release escape, press @kbd{k}''.  That's much more
20601 work than if you have a meta key, so if that's the case, I respectfully
20602 suggest you get a real keyboard with a meta key.  You can't live without
20603 it.
20604
20605
20606
20607 @node Emacs Lisp
20608 @subsection Emacs Lisp
20609
20610 Emacs is the King of Editors because it's really a Lisp interpreter.
20611 Each and every key you tap runs some Emacs Lisp code snippet, and since
20612 Emacs Lisp is an interpreted language, that means that you can configure
20613 any key to run any arbitrary code.  You just, like, do it.
20614
20615 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
20616 functions.  (These are byte-compiled for speed, but it's still
20617 interpreted.)  If you decide that you don't like the way Gnus does
20618 certain things, it's trivial to have it do something a different way.
20619 (Well, at least if you know how to write Lisp code.)  However, that's
20620 beyond the scope of this manual, so we are simply going to talk about
20621 some common constructs that you normally use in your @file{.emacs} file
20622 to customize Gnus.
20623
20624 If you want to set the variable @code{gnus-florgbnize} to four (4), you
20625 write the following:
20626
20627 @lisp
20628 (setq gnus-florgbnize 4)
20629 @end lisp
20630
20631 This function (really ``special form'') @code{setq} is the one that can
20632 set a variable to some value.  This is really all you need to know.  Now
20633 you can go and fill your @code{.emacs} file with lots of these to change
20634 how Gnus works.
20635
20636 If you have put that thing in your @code{.emacs} file, it will be read
20637 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
20638 start Emacs.  If you want to change the variable right away, simply say
20639 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
20640 previous ``form'', which is a simple @code{setq} statement here.
20641
20642 Go ahead---just try it, if you're located at your Emacs.  After you
20643 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
20644 is the return value of the form you @code{eval}ed.
20645
20646 Some pitfalls:
20647
20648 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
20649 that means:
20650
20651 @lisp
20652 (setq gnus-read-active-file 'some)
20653 @end lisp
20654
20655 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
20656 @samp{nntp.ifi.uio.no}'', that means:
20657
20658 @lisp
20659 (setq gnus-nntp-server "nntp.ifi.uio.no")
20660 @end lisp
20661
20662 So be careful not to mix up strings (the latter) with symbols (the
20663 former).  The manual is unambiguous, but it can be confusing.
20664
20665 @page
20666 @include gnus-faq.texi
20667
20668 @node Index
20669 @chapter Index
20670 @printindex cp
20671
20672 @node Key Index
20673 @chapter Key Index
20674 @printindex ky
20675
20676 @summarycontents
20677 @contents
20678 @bye
20679
20680 @iftex
20681 @iflatex
20682 \end{document}
20683 @end iflatex
20684 @end iftex
20685
20686 @c End: