cf239a8279b40953ae7d2bb1f730a1b0000bdd62
[elisp/gnus.git-] / texi / gnus.texi
1 @c \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Semi-gnus 6.10.069 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 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
54
55 \newcommand{\gnusbullet}{{${\bullet}$}}
56 \newcommand{\gnusdollar}{\$}
57 \newcommand{\gnusampersand}{\&}
58 \newcommand{\gnuspercent}{\%}
59 \newcommand{\gnushash}{\#}
60 \newcommand{\gnushat}{\symbol{"5E}}
61 \newcommand{\gnusunderline}{\symbol{"5F}}
62 \newcommand{\gnusnot}{$\neg$}
63 \newcommand{\gnustilde}{\symbol{"7E}}
64 \newcommand{\gnusless}{{$<$}}
65 \newcommand{\gnusgreater}{{$>$}}
66 \newcommand{\gnusbraceleft}{{$>$}}
67 \newcommand{\gnusbraceright}{{$>$}}
68
69 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
70 \newcommand{\gnusinteresting}{
71 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
72 }
73
74 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
75
76 \newcommand{\gnuspagechapter}[1]{
77 {\mbox{}}
78 }
79
80 \newdimen{\gnusdimen}
81 \gnusdimen 0pt
82
83 \newcommand{\gnuschapter}[2]{
84 \gnuscleardoublepage
85 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
86 \chapter{#2}
87 \renewcommand{\gnussectionname}{}
88 \renewcommand{\gnuschaptername}{#2}
89 \thispagestyle{empty}
90 \hspace*{-2cm}
91 \begin{picture}(500,500)(0,0)
92 \put(480,350){\makebox(0,0)[tr]{#1}}
93 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
94 \end{picture}
95 \clearpage
96 }
97
98 \newcommand{\gnusfigure}[3]{
99 \begin{figure}
100 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
101 #3
102 \end{picture}
103 \caption{#1}
104 \end{figure}
105 }
106
107 \newcommand{\gnusicon}[1]{
108 \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}}}
109 }
110
111 \newcommand{\gnuspicon}[1]{
112 \margindex{\epsfig{figure=#1,width=2cm}}
113 }
114
115 \newcommand{\gnusxface}[2]{
116 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
117 }
118
119 \newcommand{\gnussmiley}[2]{
120 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
121 }
122
123 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
124
125 \newcommand{\gnussection}[1]{
126 \renewcommand{\gnussectionname}{#1}
127 \section{#1}
128 }
129
130 \newenvironment{codelist}%
131 {\begin{list}{}{
132 }
133 }{\end{list}}
134
135 \newenvironment{kbdlist}%
136 {\begin{list}{}{
137 \labelwidth=0cm
138 }
139 }{\end{list}}
140
141 \newenvironment{dfnlist}%
142 {\begin{list}{}{
143 }
144 }{\end{list}}
145
146 \newenvironment{stronglist}%
147 {\begin{list}{}{
148 }
149 }{\end{list}}
150
151 \newenvironment{samplist}%
152 {\begin{list}{}{
153 }
154 }{\end{list}}
155
156 \newenvironment{varlist}%
157 {\begin{list}{}{
158 }
159 }{\end{list}}
160
161 \newenvironment{emphlist}%
162 {\begin{list}{}{
163 }
164 }{\end{list}}
165
166 \newlength\gnusheadtextwidth
167 \setlength{\gnusheadtextwidth}{\headtextwidth}
168 \addtolength{\gnusheadtextwidth}{1cm}
169
170 \newpagestyle{gnuspreamble}%
171 {
172 {
173 \ifodd\count0
174 {
175 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
176 }
177 \else
178 {
179 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
180 }
181 }
182 \fi
183 }
184 }
185 {
186 \ifodd\count0
187 \mbox{} \hfill
188 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
189 \else
190 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
191 \hfill \mbox{}
192 \fi
193 }
194
195 \newpagestyle{gnusindex}%
196 {
197 {
198 \ifodd\count0
199 {
200 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
201 }
202 \else
203 {
204 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
205 }
206 \fi
207 }
208 }
209 {
210 \ifodd\count0
211 \mbox{} \hfill
212 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
213 \else
214 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
215 \hfill \mbox{}
216 \fi
217 }
218
219 \newpagestyle{gnus}%
220 {
221 {
222 \ifodd\count0
223 {
224 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
225 }
226 \else
227 {
228 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
229 }
230 \fi
231 }
232 }
233 {
234 \ifodd\count0
235 \mbox{} \hfill
236 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
237 \else
238 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
239 \hfill \mbox{}
240 \fi
241 }
242
243 \pagenumbering{roman}
244 \pagestyle{gnuspreamble}
245
246 @end iflatex
247 @end iftex
248
249 @iftex
250 @iflatex
251 \begin{titlepage}
252 {
253
254 %\addtolength{\oddsidemargin}{-5cm}
255 %\addtolength{\evensidemargin}{-5cm}
256 \parindent=0cm
257 \addtolength{\textheight}{2cm}
258
259 \gnustitle{\gnustitlename}\\
260 \rule{15cm}{1mm}\\
261 \vfill
262 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
263 \vfill
264 \rule{15cm}{1mm}\\
265 \gnusauthor{by Lars Magne Ingebrigtsen}
266 \newpage
267 }
268
269 \mbox{}
270 \vfill
271
272 \thispagestyle{empty}
273
274 Copyright \copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
275
276 Permission is granted to make and distribute verbatim copies of
277 this manual provided the copyright notice and this permission notice
278 are preserved on all copies.
279
280 Permission is granted to copy and distribute modified versions of this
281 manual under the conditions for verbatim copying, provided that the
282 entire resulting derived work is distributed under the terms of a
283 permission notice identical to this one.
284
285 Permission is granted to copy and distribute translations of this manual
286 into another language, under the above conditions for modified versions.
287
288 \newpage
289 \end{titlepage}
290 @end iflatex
291 @end iftex
292
293 @ifinfo
294
295 This file documents gnus, the GNU Emacs newsreader.
296
297 Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
298
299 Permission is granted to make and distribute verbatim copies of
300 this manual provided the copyright notice and this permission notice
301 are preserved on all copies.
302
303 @ignore
304 Permission is granted to process this file through Tex and print the
305 results, provided the printed document carries copying permission
306 notice identical to this one except for the removal of this paragraph
307 (this paragraph not being relevant to the printed manual).
308
309 @end ignore
310 Permission is granted to copy and distribute modified versions of this
311 manual under the conditions for verbatim copying, provided also that the
312 entire resulting derived work is distributed under the terms of a
313 permission notice identical to this one.
314
315 Permission is granted to copy and distribute translations of this manual
316 into another language, under the above conditions for modified versions.
317 @end ifinfo
318
319 @tex
320
321 @titlepage
322 @title Semi-gnus 6.10.069 Manual
323
324 @author by Lars Magne Ingebrigtsen
325 @page
326
327 @vskip 0pt plus 1filll
328 Copyright @copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
329
330 Permission is granted to make and distribute verbatim copies of
331 this manual provided the copyright notice and this permission notice
332 are preserved on all copies.
333
334 Permission is granted to copy and distribute modified versions of this
335 manual under the conditions for verbatim copying, provided that the
336 entire resulting derived work is distributed under the terms of a
337 permission notice identical to this one.
338
339 Permission is granted to copy and distribute translations of this manual
340 into another language, under the above conditions for modified versions.
341
342 @end titlepage
343 @page
344
345 @end tex
346
347
348 @node Top
349 @top The gnus Newsreader
350
351 @ifinfo
352
353 You can read news (and mail) from within Emacs by using gnus.  The news
354 can be gotten by any nefarious means you can think of---@sc{nntp}, local
355 spool or your mbox file.  All at the same time, if you want to push your
356 luck.
357
358 Semi-gnus provides MIME features based on SEMI API.  So Semi-gnus
359 supports your right to read strange messages including big images or
360 other various kinds of formats.  Semi-gnus also supports
361 internationalization/localization and multiscript features based on MULE
362 API.  So Semi-gnus does not discriminate various language communities.
363 Oh, if you are a Klingon, please wait Unicode Next Generation.
364
365 This manual corresponds to Semi-gnus 6.10.069.
366
367 @end ifinfo
368
369 @iftex
370
371 @iflatex
372 \tableofcontents
373 \gnuscleardoublepage
374 @end iflatex
375
376 Gnus is the advanced, self-documenting, customizable, extensible
377 unreal-time newsreader for GNU Emacs.
378
379 Oops.  That sounds oddly familiar, so let's start over again to avoid
380 being accused of plagiarism:
381
382 Gnus is a message-reading laboratory.  It will let you look at just
383 about anything as if it were a newsgroup.  You can read mail with it,
384 you can browse directories with it, you can @code{ftp} with it---you can
385 even read news with it!
386
387 Gnus tries to empower people who read news the same way Emacs empowers
388 people who edit text.  Gnus sets no limits to what the user should be
389 allowed to do.  Users are encouraged to extend gnus to make it behave
390 like they want it to behave.  A program should not control people;
391 people should be empowered to do what they want by using (or abusing)
392 the program.
393
394 @end iftex
395
396
397 @menu
398 * Starting Up::           Finding news can be a pain.
399 * The Group Buffer::      Selecting, subscribing and killing groups.
400 * The Summary Buffer::    Reading, saving and posting articles.
401 * The Article Buffer::    Displaying and handling articles.
402 * Composing Messages::    Information on sending mail and news.
403 * Select Methods::        Gnus reads all messages from various select methods.
404 * Scoring::               Assigning values to articles.
405 * Various::               General purpose settings.
406 * The End::               Farewell and goodbye.
407 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
408 * Index::                 Variable, function and concept index.
409 * Key Index::             Key Index.
410 @end menu
411
412 @node Starting Up
413 @chapter Starting gnus
414 @cindex starting up
415
416 @kindex M-x gnus
417 @findex gnus
418 If your system administrator has set things up properly, starting gnus
419 and reading news is extremely easy---you just type @kbd{M-x gnus} in
420 your Emacs.
421
422 @findex gnus-other-frame
423 @kindex M-x gnus-other-frame
424 If you want to start gnus in a different frame, you can use the command
425 @kbd{M-x gnus-other-frame} instead.
426
427 If things do not go smoothly at startup, you have to twiddle some
428 variables in your @file{~/.gnus} file.  This file is similar to
429 @file{~/.emacs}, but is read when gnus starts.
430
431 If you puzzle at any terms used in this manual, please refer to the
432 terminology section (@pxref{Terminology}).
433
434 @menu
435 * Finding the News::    Choosing a method for getting news.
436 * The First Time::      What does gnus do the first time you start it?
437 * The Server is Down::  How can I read my mail then?
438 * Slave Gnusae::        You can have more than one gnus active at a time.
439 * Fetching a Group::    Starting gnus just to read a group.
440 * New Groups::          What is gnus supposed to do with new groups?
441 * Startup Files::       Those pesky startup files---@file{.newsrc}.
442 * Auto Save::           Recovering from a crash.
443 * The Active File::     Reading the active file over a slow line Takes Time.
444 * Changing Servers::    You may want to move from one server to another.
445 * Startup Variables::   Other variables you might change.
446 @end menu
447
448
449 @node Finding the News
450 @section Finding the News
451 @cindex finding news
452
453 @vindex gnus-select-method
454 @c @head
455 The @code{gnus-select-method} variable says where gnus should look for
456 news.  This variable should be a list where the first element says
457 @dfn{how} and the second element says @dfn{where}.  This method is your
458 native method.  All groups not fetched with this method are
459 foreign groups.
460
461 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
462 you want to get your daily dosage of news from, you'd say:
463
464 @lisp
465 (setq gnus-select-method '(nntp "news.somewhere.edu"))
466 @end lisp
467
468 If you want to read directly from the local spool, say:
469
470 @lisp
471 (setq gnus-select-method '(nnspool ""))
472 @end lisp
473
474 If you can use a local spool, you probably should, as it will almost
475 certainly be much faster.
476
477 @vindex gnus-nntpserver-file
478 @cindex NNTPSERVER
479 @cindex @sc{nntp} server
480 If this variable is not set, gnus will take a look at the
481 @code{NNTPSERVER} environment variable.  If that variable isn't set,
482 gnus will see whether @code{gnus-nntpserver-file}
483 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
484 that fails as well, gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
485
486 @vindex gnus-nntp-server
487 If @code{gnus-nntp-server} is set, this variable will override
488 @code{gnus-select-method}.  You should therefore set
489 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
490
491 @vindex gnus-secondary-servers
492 @vindex gnus-nntp-server
493 You can also make gnus prompt you interactively for the name of an
494 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
495 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
496 in the @code{gnus-secondary-servers} list (if any).  You can also just
497 type in the name of any server you feel like visiting.  (Note that this
498 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
499 gnus} later in the same Emacs session, Gnus will contact the same
500 server.)
501
502 @findex gnus-group-browse-foreign-server
503 @kindex B (Group)
504 However, if you use one @sc{nntp} server regularly and are just
505 interested in a couple of groups from a different server, you would be
506 better served by using the @kbd{B} command in the group buffer.  It will
507 let you have a look at what groups are available, and you can subscribe
508 to any of the groups you want to.  This also makes @file{.newsrc}
509 maintenance much tidier.  @xref{Foreign Groups}.
510
511 @vindex gnus-secondary-select-methods
512 @c @head
513 A slightly different approach to foreign groups is to set the
514 @code{gnus-secondary-select-methods} variable.  The select methods
515 listed in this variable are in many ways just as native as the
516 @code{gnus-select-method} server.  They will also be queried for active
517 files during startup (if that's required), and new newsgroups that
518 appear on these servers will be subscribed (or not) just as native
519 groups are.
520
521 For instance, if you use the @code{nnmbox} backend to read your mail, you
522 would typically set this variable to
523
524 @lisp
525 (setq gnus-secondary-select-methods '((nnmbox "")))
526 @end lisp
527
528
529 @node The First Time
530 @section The First Time
531 @cindex first time usage
532
533 If no startup files exist, gnus will try to determine what groups should
534 be subscribed by default.
535
536 @vindex gnus-default-subscribed-newsgroups
537 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
538 will subscribe you to just those groups in that list, leaving the rest
539 killed.  Your system administrator should have set this variable to
540 something useful.
541
542 Since she hasn't, gnus will just subscribe you to a few arbitrarily
543 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
544 here as @dfn{whatever Lars thinks you should read}.)
545
546 You'll also be subscribed to the gnus documentation group, which should
547 help you with most common problems.
548
549 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
550 use the normal functions for handling new groups, and not do anything
551 special.
552
553
554 @node The Server is Down
555 @section The Server is Down
556 @cindex server errors
557
558 If the default server is down, gnus will understandably have some
559 problems starting.  However, if you have some mail groups in addition to
560 the news groups, you may want to start gnus anyway.
561
562 Gnus, being the trusting sort of program, will ask whether to proceed
563 without a native select method if that server can't be contacted.  This
564 will happen whether the server doesn't actually exist (i.e., you have
565 given the wrong address) or the server has just momentarily taken ill
566 for some reason or other.  If you decide to continue and have no foreign
567 groups, you'll find it difficult to actually do anything in the group
568 buffer.  But, hey, that's your problem.  Blllrph!
569
570 @findex gnus-no-server
571 @kindex M-x gnus-no-server
572 @c @head
573 If you know that the server is definitely down, or you just want to read
574 your mail without bothering with the server at all, you can use the
575 @code{gnus-no-server} command to start gnus.  That might come in handy
576 if you're in a hurry as well.  This command will not attempt to contact
577 your primary server---instead, it will just activate all groups on level
578 1 and 2.  (You should preferably keep no native groups on those two
579 levels.)
580
581
582 @node Slave Gnusae
583 @section Slave Gnusae
584 @cindex slave
585
586 You might want to run more than one Emacs with more than one gnus at the
587 same time.  If you are using different @file{.newsrc} files (e.g., if you
588 are using the two different gnusae to read from two different servers),
589 that is no problem whatsoever.  You just do it.
590
591 The problem appears when you want to run two Gnusae that use the same
592 @code{.newsrc} file.
593
594 To work around that problem some, we here at the Think-Tank at the gnus
595 Towers have come up with a new concept: @dfn{Masters} and
596 @dfn{slaves}.  (We have applied for a patent on this concept, and have
597 taken out a copyright on those words.  If you wish to use those words in
598 conjunction with each other, you have to send $1 per usage instance to
599 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
600 Applications}) will be much more expensive, of course.)
601
602 Anyways, you start one gnus up the normal way with @kbd{M-x gnus} (or
603 however you do it).  Each subsequent slave gnusae should be started with
604 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
605 files, but instead save @dfn{slave files} that contain information only
606 on what groups have been read in the slave session.  When a master gnus
607 starts, it will read (and delete) these slave files, incorporating all
608 information from them.  (The slave files will be read in the sequence
609 they were created, so the latest changes will have precedence.)
610
611 Information from the slave files has, of course, precedence over the
612 information in the normal (i.e., master) @code{.newsrc} file.
613
614
615 @node Fetching a Group
616 @section Fetching a Group
617 @cindex fetching a group
618
619 @findex gnus-fetch-group
620 It is sometimes convenient to be able to just say ``I want to read this
621 group and I don't care whether gnus has been started or not''.  This is
622 perhaps more useful for people who write code than for users, but the
623 command @code{gnus-fetch-group} provides this functionality in any case.
624 It takes the group name as a parameter.
625
626
627 @node New Groups
628 @section New Groups
629 @cindex new groups
630 @cindex subscription
631
632 @vindex gnus-check-new-newsgroups
633 If you are satisfied that you really never want to see any new groups,
634 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
635 also save you some time at startup.  Even if this variable is
636 @code{nil}, you can always subscribe to the new groups just by pressing
637 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
638 is @code{ask-server} by default.  If you set this variable to
639 @code{always}, then gnus will query the backends for new groups even
640 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
641
642 @menu
643 * Checking New Groups::      Determining what groups are new.
644 * Subscription Methods::     What gnus should do with new groups.
645 * Filtering New Groups::     Making gnus ignore certain new groups.
646 @end menu
647
648
649 @node Checking New Groups
650 @subsection Checking New Groups
651
652 Gnus normally determines whether a group is new or not by comparing the
653 list of groups from the active file(s) with the lists of subscribed and
654 dead groups.  This isn't a particularly fast method.  If
655 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
656 server for new groups since the last time.  This is both faster and
657 cheaper.  This also means that you can get rid of the list of killed
658 groups altogether, so you may set @code{gnus-save-killed-list} to
659 @code{nil}, which will save time both at startup, at exit, and all over.
660 Saves disk space, too.  Why isn't this the default, then?
661 Unfortunately, not all servers support this command.
662
663 I bet I know what you're thinking now: How do I find out whether my
664 server supports @code{ask-server}?  No?  Good, because I don't have a
665 fail-safe answer.  I would suggest just setting this variable to
666 @code{ask-server} and see whether any new groups appear within the next
667 few days.  If any do, then it works.  If none do, then it doesn't
668 work.  I could write a function to make gnus guess whether the server
669 supports @code{ask-server}, but it would just be a guess.  So I won't.
670 You could @code{telnet} to the server and say @code{HELP} and see
671 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
672 it does, then it might work.  (But there are servers that lists
673 @samp{NEWGROUPS} without supporting the function properly.)
674
675 This variable can also be a list of select methods.  If so, gnus will
676 issue an @code{ask-server} command to each of the select methods, and
677 subscribe them (or not) using the normal methods.  This might be handy
678 if you are monitoring a few servers for new groups.  A side effect is
679 that startup will take much longer, so you can meditate while waiting.
680 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
681
682
683 @node Subscription Methods
684 @subsection Subscription Methods
685
686 @vindex gnus-subscribe-newsgroup-method
687 What gnus does when it encounters a new group is determined by the
688 @code{gnus-subscribe-newsgroup-method} variable.
689
690 This variable should contain a function.  This function will be called
691 with the name of the new group as the only parameter.
692
693 Some handy pre-fab functions are:
694
695 @table @code
696
697 @item gnus-subscribe-zombies
698 @vindex gnus-subscribe-zombies
699 Make all new groups zombies.  This is the default.  You can browse the
700 zombies later (with @kbd{A z}) and either kill them all off properly
701 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
702
703 @item gnus-subscribe-randomly
704 @vindex gnus-subscribe-randomly
705 Subscribe all new groups in arbitrary order.  This really means that all
706 new groups will be added at ``the top'' of the group buffer.
707
708 @item gnus-subscribe-alphabetically
709 @vindex gnus-subscribe-alphabetically
710 Subscribe all new groups in alphabetical order.
711
712 @item gnus-subscribe-hierarchically
713 @vindex gnus-subscribe-hierarchically
714 Subscribe all new groups hierarchically.  The difference between this
715 function and @code{gnus-subscribe-alphabetically} is slight.
716 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
717 alphabetical fashion, while this function will enter groups into its
718 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
719 @samp{comp} hierarchy, this function will not mess that configuration
720 up.  Or something like that.
721
722 @item gnus-subscribe-interactively
723 @vindex gnus-subscribe-interactively
724 Subscribe new groups interactively.  This means that gnus will ask
725 you about @strong{all} new groups.  The groups you choose to subscribe
726 to will be subscribed hierarchically.
727
728 @item gnus-subscribe-killed
729 @vindex gnus-subscribe-killed
730 Kill all new groups.
731
732 @end table
733
734 @vindex gnus-subscribe-hierarchical-interactive
735 A closely related variable is
736 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
737 mouthful.)  If this variable is non-@code{nil}, gnus will ask you in a
738 hierarchical fashion whether to subscribe to new groups or not.  Gnus
739 will ask you for each sub-hierarchy whether you want to descend the
740 hierarchy or not.
741
742 One common mistake is to set the variable a few paragraphs above
743 (@code{gnus-subscribe-newsgroup-method}) to
744 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
745 will not work.  This is ga-ga.  So don't do it.
746
747
748 @node Filtering New Groups
749 @subsection Filtering New Groups
750
751 A nice and portable way to control which new newsgroups should be
752 subscribed (or ignored) is to put an @dfn{options} line at the start of
753 the @file{.newsrc} file.  Here's an example:
754
755 @example
756 options -n !alt.all !rec.all sci.all
757 @end example
758
759 @vindex gnus-subscribe-options-newsgroup-method
760 This line obviously belongs to a serious-minded intellectual scientific
761 person (or she may just be plain old boring), because it says that all
762 groups that have names beginning with @samp{alt} and @samp{rec} should
763 be ignored, and all groups with names beginning with @samp{sci} should
764 be subscribed.  Gnus will not use the normal subscription method for
765 subscribing these groups.
766 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
767 variable defaults to @code{gnus-subscribe-alphabetically}.
768
769 @vindex gnus-options-not-subscribe
770 @vindex gnus-options-subscribe
771 If you don't want to mess with your @file{.newsrc} file, you can just
772 set the two variables @code{gnus-options-subscribe} and
773 @code{gnus-options-not-subscribe}.  These two variables do exactly the
774 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
775 and if the new group matches the former, it will be unconditionally
776 subscribed, and if it matches the latter, it will be ignored.
777
778 @vindex gnus-auto-subscribed-groups
779 Yet another variable that meddles here is
780 @code{gnus-auto-subscribed-groups}.  It works exactly like
781 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
782 thought it would be nice to have two of these.  This variable is more
783 meant for setting some ground rules, while the other variable is used
784 more for user fiddling.  By default this variable makes all new groups
785 that come from mail backends (@code{nnml}, @code{nnbabyl},
786 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
787 don't like that, just set this variable to @code{nil}.
788
789 New groups that match this regexp are subscribed using
790 @code{gnus-subscribe-options-newsgroup-method}.
791
792
793 @node Changing Servers
794 @section Changing Servers
795 @cindex changing servers
796
797 Sometimes it is necessary to move from one @sc{nntp} server to another.
798 This happens very rarely, but perhaps you change jobs, or one server is
799 very flaky and you want to use another.
800
801 Changing the server is pretty easy, right?  You just change
802 @code{gnus-select-method} to point to the new server?
803
804 @emph{Wrong!}
805
806 Article numbers are not (in any way) kept synchronized between different
807 @sc{nntp} servers, and the only way Gnus keeps track of what articles
808 you have read is by keeping track of article numbers.  So when you
809 change @code{gnus-select-method}, your @file{.newsrc} file becomes
810 worthless.
811
812 Gnus provides a few functions to attempt to translate a @file{.newsrc}
813 file from one server to another.  They all have one thing in
814 common---they take a looong time to run.  You don't want to use these
815 functions more than absolutely necessary.
816
817 @kindex M-x gnus-change-server
818 @findex gnus-change-server
819 If you have access to both servers, Gnus can request the headers for all
820 the articles you have read and compare @code{Message-ID}s and map the
821 article numbers of the read articles and article marks.  The @kbd{M-x
822 gnus-change-server} command will do this for all your native groups.  It
823 will prompt for the method you want to move to.
824
825 @kindex M-x gnus-group-move-group-to-server
826 @findex gnus-group-move-group-to-server
827 You can also move individual groups with the @kbd{M-x
828 gnus-group-move-group-to-server} command.  This is useful if you want to
829 move a (foreign) group from one server to another.
830
831 @kindex M-x gnus-group-clear-data-on-native-groups
832 @findex gnus-group-clear-data-on-native-groups
833 If you don't have access to both the old and new server, all your marks
834 and read ranges have become worthless.  You can use the @kbd{M-x
835 gnus-group-clear-data-on-native-groups} command to clear out all data
836 that you have on your native groups.  Use with caution.
837
838 After changing servers, you @strong{must} move the cache hierarchy away,
839 since the cached articles will have wrong article numbers, which will
840 affect which articles Gnus thinks are read.
841
842
843 @node Startup Files
844 @section Startup Files
845 @cindex startup files
846 @cindex .newsrc
847 @cindex .newsrc.el
848 @cindex .newsrc.eld
849
850 Now, you all know about the @file{.newsrc} file.  All subscription
851 information is traditionally stored in this file.
852
853 Things got a bit more complicated with @sc{GNUS}.  In addition to
854 keeping the @file{.newsrc} file updated, it also used a file called
855 @file{.newsrc.el} for storing all the information that didn't fit into
856 the @file{.newsrc} file.  (Actually, it also duplicated everything in
857 the @file{.newsrc} file.)  @sc{GNUS} would read whichever one of these
858 files was the most recently saved, which enabled people to swap between
859 @sc{gnus} and other newsreaders.
860
861 That was kinda silly, so Gnus went one better: In addition to the
862 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
863 @file{.newsrc.eld}.  It will read whichever of these files that are most
864 recent, but it will never write a @file{.newsrc.el} file.  You should
865 never delete the @file{.newsrc.eld} file---it contains much information
866 not stored in the @file{.newsrc} file.
867
868 @vindex gnus-save-newsrc-file
869 @vindex gnus-read-newsrc-file
870 You can turn off writing the @file{.newsrc} file by setting
871 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
872 the file and save some space, as well as exiting from gnus faster.
873 However, this will make it impossible to use other newsreaders than
874 gnus.  But hey, who would want to, right?  Similarly, setting
875 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
876 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
877 convenient if you have a tendency to use Netscape once in a while.
878
879 @vindex gnus-save-killed-list
880 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
881 will not save the list of killed groups to the startup file.  This will
882 save both time (when starting and quitting) and space (on disk).  It
883 will also mean that Gnus has no record of what groups are new or old,
884 so the automatic new groups subscription methods become meaningless.
885 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
886 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
887 Groups}).  This variable can also be a regular expression.  If that's
888 the case, remove all groups that do not match this regexp before
889 saving.  This can be useful in certain obscure situations that involve
890 several servers where not all servers support @code{ask-server}.
891
892 @vindex gnus-startup-file
893 The @code{gnus-startup-file} variable says where the startup files are.
894 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
895 file being whatever that one is, with a @samp{.eld} appended.
896
897 @vindex gnus-save-newsrc-hook
898 @vindex gnus-save-quick-newsrc-hook
899 @vindex gnus-save-standard-newsrc-hook
900 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
901 files, while @code{gnus-save-quick-newsrc-hook} is called just before
902 saving the @file{.newsrc.eld} file, and
903 @code{gnus-save-standard-newsrc-hook} is called just before saving the
904 @file{.newsrc} file.  The latter two are commonly used to turn version
905 control on or off.  Version control is on by default when saving the
906 startup files.  If you want to turn backup creation off, say something like:
907
908 @lisp
909 (defun turn-off-backup ()
910   (set (make-local-variable 'backup-inhibited) t))
911
912 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
913 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
914 @end lisp
915
916 @vindex gnus-init-file
917 When gnus starts, it will read the @code{gnus-site-init-file}
918 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
919 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
920 and can be used to avoid cluttering your @file{~/.emacs} and
921 @file{site-init} files with gnus stuff.  Gnus will also check for files
922 with the same names as these, but with @file{.elc} and @file{.el}
923 suffixes.  In other words, if you have set @code{gnus-init-file} to
924 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
925 and finally @file{~/.gnus} (in this order).
926
927
928
929 @node Auto Save
930 @section Auto Save
931 @cindex dribble file
932 @cindex auto-save
933
934 Whenever you do something that changes the gnus data (reading articles,
935 catching up, killing/subscribing groups), the change is added to a
936 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
937 Emacs way.  If your Emacs should crash before you have saved the
938 @file{.newsrc} files, all changes you have made can be recovered from
939 this file.
940
941 If gnus detects this file at startup, it will ask the user whether to
942 read it.  The auto save file is deleted whenever the real startup file is
943 saved.
944
945 @vindex gnus-use-dribble-file
946 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
947 maintain a dribble buffer.  The default is @code{t}.
948
949 @vindex gnus-dribble-directory
950 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
951 this variable is @code{nil}, which it is by default, gnus will dribble
952 into the directory where the @file{.newsrc} file is located.  (This is
953 normally the user's home directory.)  The dribble file will get the same
954 file permissions as the @code{.newsrc} file.
955
956 @vindex gnus-always-read-dribble-file
957 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
958 read the dribble file on startup without querying the user.
959
960
961 @node The Active File
962 @section The Active File
963 @cindex active file
964 @cindex ignored groups
965
966 When gnus starts, or indeed whenever it tries to determine whether new
967 articles have arrived, it reads the active file.  This is a very large
968 file that lists all the active groups and articles on the server.
969
970 @vindex gnus-ignored-newsgroups
971 Before examining the active file, gnus deletes all lines that match the
972 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
973 any groups with bogus names, but you can use this variable to make gnus
974 ignore hierarchies you aren't ever interested in.  However, this is not
975 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
976 Groups} for an overview of other variables that can be used instead.
977
978 @c This variable is
979 @c @code{nil} by default, and will slow down active file handling somewhat
980 @c if you set it to anything else.
981
982 @vindex gnus-read-active-file
983 @c @head
984 The active file can be rather Huge, so if you have a slow network, you
985 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
986 reading the active file.  This variable is @code{some} by default.
987
988 Gnus will try to make do by getting information just on the groups that
989 you actually subscribe to.
990
991 Note that if you subscribe to lots and lots of groups, setting this
992 variable to @code{nil} will probably make gnus slower, not faster.  At
993 present, having this variable @code{nil} will slow gnus down
994 considerably, unless you read news over a 2400 baud modem.
995
996 This variable can also have the value @code{some}.  Gnus will then
997 attempt to read active info only on the subscribed groups.  On some
998 servers this is quite fast (on sparkling, brand new INN servers that
999 support the @code{LIST ACTIVE group} command), on others this isn't fast
1000 at all.  In any case, @code{some} should be faster than @code{nil}, and
1001 is certainly faster than @code{t} over slow lines.
1002
1003 Some news servers (Leafnode and old versions of INN, for instance) do
1004 not support the @code{LIST ACTIVE group}.  For these servers, @code{nil}
1005 is probably the most effficient value for this variable.
1006
1007 If this variable is @code{nil}, gnus will ask for group info in total
1008 lock-step, which isn't very fast.  If it is @code{some} and you use an
1009 @sc{nntp} server, gnus will pump out commands as fast as it can, and
1010 read all the replies in one swoop.  This will normally result in better
1011 performance, but if the server does not support the aforementioned
1012 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1013
1014 If you think that starting up Gnus takes too long, try all the three
1015 different values for this variable and see what works best for you. 
1016
1017 In any case, if you use @code{some} or @code{nil}, you should definitely
1018 kill all groups that you aren't interested in to speed things up.
1019
1020 Note that this variable also affects active file retrieval from
1021 secondary select methods.
1022
1023
1024 @node Startup Variables
1025 @section Startup Variables
1026
1027 @table @code
1028
1029 @item gnus-load-hook
1030 @vindex gnus-load-hook
1031 A hook run while gnus is being loaded.  Note that this hook will
1032 normally be run just once in each Emacs session, no matter how many
1033 times you start gnus.
1034
1035 @item gnus-before-startup-hook
1036 @vindex gnus-before-startup-hook
1037 A hook run after starting up gnus successfully.
1038
1039 @item gnus-startup-hook
1040 @vindex gnus-startup-hook
1041 A hook run as the very last thing after starting up gnus
1042
1043 @item gnus-started-hook
1044 @vindex gnus-started-hook
1045 A hook that is run as the very last thing after starting up gnus
1046 successfully.
1047
1048 @item gnus-setup-news-hook
1049 @vindex gnus-setup-news-hook
1050 A hook that is run after reading the @file{.newsrc} file(s), but before
1051 generating the group buffer.
1052
1053 @item gnus-check-bogus-newsgroups
1054 @vindex gnus-check-bogus-newsgroups
1055 If non-@code{nil}, gnus will check for and delete all bogus groups at
1056 startup.  A @dfn{bogus group} is a group that you have in your
1057 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1058 bogus groups can take quite a while, so to save time and resources it's
1059 best to leave this option off, and do the checking for bogus groups once
1060 in a while from the group buffer instead (@pxref{Group Maintenance}).
1061
1062 @item gnus-inhibit-startup-message
1063 @vindex gnus-inhibit-startup-message
1064 If non-@code{nil}, the startup message won't be displayed.  That way,
1065 your boss might not notice as easily that you are reading news instead
1066 of doing your job.  Note that this variable is used before
1067 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1068
1069 @item gnus-no-groups-message
1070 @vindex gnus-no-groups-message
1071 Message displayed by gnus when no groups are available.
1072
1073 @item gnus-play-startup-jingle
1074 @vindex gnus-play-startup-jingle
1075 If non-@code{nil}, play the gnus jingle at startup.
1076
1077 @item gnus-startup-jingle
1078 @vindex gnus-startup-jingle
1079 Jingle to be played if the above variable is non-@code{nil}.  The
1080 default is @samp{Tuxedomoon.Jingle4.au}.
1081
1082 @end table
1083
1084
1085 @node The Group Buffer
1086 @chapter The Group Buffer
1087 @cindex group buffer
1088
1089 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1090 is the first buffer shown when gnus starts, and will never be killed as
1091 long as gnus is active.
1092
1093 @iftex
1094 @iflatex
1095 \gnusfigure{The Group Buffer}{320}{
1096 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1097 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1098 \put(120,38){\vector(1,2){10}}
1099 \put(40,60){\makebox(0,0)[r]{Mode line}}
1100 \put(40,58){\vector(1,0){30}}
1101 \put(200,28){\makebox(0,0)[t]{Native select method}}
1102 \put(200,26){\vector(-1,2){15}}
1103 }
1104 @end iflatex
1105 @end iftex
1106
1107 @menu
1108 * Group Buffer Format::    Information listed and how you can change it.
1109 * Group Maneuvering::      Commands for moving in the group buffer.
1110 * Selecting a Group::      Actually reading news.
1111 * Group Data::             Changing the info for a group.
1112 * Subscription Commands::  Unsubscribing, killing, subscribing.
1113 * Group Levels::           Levels? What are those, then?
1114 * Group Score::            A mechanism for finding out what groups you like.
1115 * Marking Groups::         You can mark groups for later processing.
1116 * Foreign Groups::         Creating and editing groups.
1117 * Group Parameters::       Each group may have different parameters set.
1118 * Listing Groups::         Gnus can list various subsets of the groups.
1119 * Sorting Groups::         Re-arrange the group order.
1120 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1121 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1122 * Exiting Gnus::           Stop reading news and get some work done.
1123 * Group Topics::           A folding group mode divided into topics.
1124 * Misc Group Stuff::       Other stuff that you can to do.
1125 @end menu
1126
1127
1128 @node Group Buffer Format
1129 @section Group Buffer Format
1130
1131 @menu
1132 * Group Line Specification::       Deciding how the group buffer is to look.
1133 * Group Modeline Specification::   The group buffer modeline.
1134 * Group Highlighting::             Having nice colors in the group buffer.
1135 @end menu
1136
1137
1138 @node Group Line Specification
1139 @subsection Group Line Specification
1140 @cindex group buffer format
1141
1142 The default format of the group buffer is nice and dull, but you can
1143 make it as exciting and ugly as you feel like.
1144
1145 Here's a couple of example group lines:
1146
1147 @example
1148      25: news.announce.newusers
1149  *    0: alt.fan.andrea-dworkin
1150 @end example
1151
1152 Quite simple, huh?
1153
1154 You can see that there are 25 unread articles in
1155 @samp{news.announce.newusers}.  There are no unread articles, but some
1156 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1157 asterisk at the beginning of the line?).
1158
1159 @vindex gnus-group-line-format
1160 You can change that format to whatever you want by fiddling with the
1161 @code{gnus-group-line-format} variable.  This variable works along the
1162 lines of a @code{format} specification, which is pretty much the same as
1163 a @code{printf} specifications, for those of you who use (feh!) C.
1164 @xref{Formatting Variables}.
1165
1166 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1167
1168 There should always be a colon on the line; the cursor always moves to
1169 the colon after performing an operation.  Nothing else is required---not
1170 even the group name.  All displayed text is just window dressing, and is
1171 never examined by gnus.  Gnus stores all real information it needs using
1172 text properties.
1173
1174 (Note that if you make a really strange, wonderful, spreadsheet-like
1175 layout, everybody will believe you are hard at work with the accounting
1176 instead of wasting time reading news.)
1177
1178 Here's a list of all available format characters:
1179
1180 @table @samp
1181
1182 @item M
1183 An asterisk if the group only has marked articles.
1184
1185 @item S
1186 Whether the group is subscribed.
1187
1188 @item L
1189 Level of subscribedness.
1190
1191 @item N
1192 Number of unread articles.
1193
1194 @item I
1195 Number of dormant articles.
1196
1197 @item T
1198 Number of ticked articles.
1199
1200 @item R
1201 Number of read articles.
1202
1203 @item t
1204 Estimated total number of articles.  (This is really @var{max-number}
1205 minus @var{min-number} plus 1.)
1206
1207 @item y
1208 Number of unread, unticked, non-dormant articles.
1209
1210 @item i
1211 Number of ticked and dormant articles.
1212
1213 @item g
1214 Full group name.
1215
1216 @item G
1217 Group name.
1218
1219 @item D
1220 Newsgroup description.
1221
1222 @item o
1223 @samp{m} if moderated.
1224
1225 @item O
1226 @samp{(m)} if moderated.
1227
1228 @item s
1229 Select method.
1230
1231 @item n
1232 Select from where.
1233
1234 @item z
1235 A string that looks like @samp{<%s:%n>} if a foreign select method is
1236 used.
1237
1238 @item P
1239 Indentation based on the level of the topic (@pxref{Group Topics}).
1240
1241 @item c
1242 @vindex gnus-group-uncollapsed-levels
1243 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1244 variable says how many levels to leave at the end of the group name.
1245 The default is 1---this will mean that group names like
1246 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1247
1248 @item m
1249 @vindex gnus-new-mail-mark
1250 @cindex %
1251 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1252 the group lately.
1253
1254 @item d
1255 A string that says when you last read the group (@pxref{Group
1256 Timestamp}).
1257
1258 @item u
1259 User defined specifier.  The next character in the format string should
1260 be a letter.  Gnus will call the function
1261 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1262 following @samp{%u}.  The function will be passed a single dummy
1263 parameter as argument.  The function should return a string, which will
1264 be inserted into the buffer just like information from any other
1265 specifier.
1266 @end table
1267
1268 @cindex *
1269 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1270 if no info is available---for instance, if it is a non-activated foreign
1271 group, or a bogus native group.
1272
1273
1274 @node Group Modeline Specification
1275 @subsection Group Modeline Specification
1276 @cindex group modeline
1277
1278 @vindex gnus-group-mode-line-format
1279 The mode line can be changed by setting
1280 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1281 doesn't understand that many format specifiers:
1282
1283 @table @samp
1284 @item S
1285 The native news server.
1286 @item M
1287 The native select method.
1288 @end table
1289
1290
1291 @node Group Highlighting
1292 @subsection Group Highlighting
1293 @cindex highlighting
1294 @cindex group highlighting
1295
1296 @vindex gnus-group-highlight
1297 Highlighting in the group buffer is controlled by the
1298 @code{gnus-group-highlight} variable.  This is an alist with elements
1299 that look like @var{(form . face)}.  If @var{form} evaluates to
1300 something non-@code{nil}, the @var{face} will be used on the line.
1301
1302 Here's an example value for this variable that might look nice if the
1303 background is dark:
1304
1305 @lisp
1306 (face-spec-set 'my-group-face-1
1307                '((t (:foreground "Red" :bold t))))
1308 (face-spec-set 'my-group-face-2
1309                '((t (:foreground "SeaGreen" :bold t))))
1310 (face-spec-set 'my-group-face-3
1311                '((t (:foreground "SpringGreen" :bold t))))
1312 (face-spec-set 'my-group-face-4
1313                '((t (:foreground "SteelBlue" :bold t))))
1314 (face-spec-set 'my-group-face-5
1315                '((t (:foreground "SkyBlue" :bold t))))
1316
1317 (setq gnus-group-highlight
1318       '(((> unread 200) . my-group-face-1)
1319         ((and (< level 3) (zerop unread)) . my-group-face-2)
1320         ((< level 3) . my-group-face-3)
1321         ((zerop unread) . my-group-face-4)
1322         (t . my-group-face-5)))
1323 @end lisp
1324
1325 Also @pxref{Faces and Fonts}.
1326
1327 Variables that are dynamically bound when the forms are evaluated
1328 include:
1329
1330 @table @code
1331 @item group
1332 The group name.
1333 @item unread
1334 The number of unread articles in the group.
1335 @item method
1336 The select method.
1337 @item mailp
1338 Whether the group is a mail group.
1339 @item level
1340 The level of the group.
1341 @item score
1342 The score of the group.
1343 @item ticked
1344 The number of ticked articles in the group.
1345 @item total
1346 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1347 MIN-NUMBER plus one.
1348 @item topic
1349 When using the topic minor mode, this variable is bound to the current
1350 topic being inserted.
1351 @end table
1352
1353 When the forms are @code{eval}ed, point is at the beginning of the line
1354 of the group in question, so you can use many of the normal gnus
1355 functions for snarfing info on the group.
1356
1357 @vindex gnus-group-update-hook
1358 @findex gnus-group-highlight-line
1359 @code{gnus-group-update-hook} is called when a group line is changed.
1360 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1361 calls @code{gnus-group-highlight-line} by default.
1362
1363
1364 @node Group Maneuvering
1365 @section Group Maneuvering
1366 @cindex group movement
1367
1368 All movement commands understand the numeric prefix and will behave as
1369 expected, hopefully.
1370
1371 @table @kbd
1372
1373 @item n
1374 @kindex n (Group)
1375 @findex gnus-group-next-unread-group
1376 Go to the next group that has unread articles
1377 (@code{gnus-group-next-unread-group}).
1378
1379 @item p
1380 @itemx DEL
1381 @kindex DEL (Group)
1382 @kindex p (Group)
1383 @findex gnus-group-prev-unread-group
1384 Go to the previous group that has unread articles
1385 (@code{gnus-group-prev-unread-group}).
1386
1387 @item N
1388 @kindex N (Group)
1389 @findex gnus-group-next-group
1390 Go to the next group (@code{gnus-group-next-group}).
1391
1392 @item P
1393 @kindex P (Group)
1394 @findex gnus-group-prev-group
1395 Go to the previous group (@code{gnus-group-prev-group}).
1396
1397 @item M-n
1398 @kindex M-n (Group)
1399 @findex gnus-group-next-unread-group-same-level
1400 Go to the next unread group on the same (or lower) level
1401 (@code{gnus-group-next-unread-group-same-level}).
1402
1403 @item M-p
1404 @kindex M-p (Group)
1405 @findex gnus-group-prev-unread-group-same-level
1406 Go to the previous unread group on the same (or lower) level
1407 (@code{gnus-group-prev-unread-group-same-level}).
1408 @end table
1409
1410 Three commands for jumping to groups:
1411
1412 @table @kbd
1413
1414 @item j
1415 @kindex j (Group)
1416 @findex gnus-group-jump-to-group
1417 Jump to a group (and make it visible if it isn't already)
1418 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1419 like living groups.
1420
1421 @item ,
1422 @kindex , (Group)
1423 @findex gnus-group-best-unread-group
1424 Jump to the unread group with the lowest level
1425 (@code{gnus-group-best-unread-group}).
1426
1427 @item .
1428 @kindex . (Group)
1429 @findex gnus-group-first-unread-group
1430 Jump to the first group with unread articles
1431 (@code{gnus-group-first-unread-group}).
1432 @end table
1433
1434 @vindex gnus-group-goto-unread
1435 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1436 commands will move to the next group, not the next unread group.  Even
1437 the commands that say they move to the next unread group.  The default
1438 is @code{t}.
1439
1440
1441 @node Selecting a Group
1442 @section Selecting a Group
1443 @cindex group selection
1444
1445 @table @kbd
1446
1447 @item SPACE
1448 @kindex SPACE (Group)
1449 @findex gnus-group-read-group
1450 Select the current group, switch to the summary buffer and display the
1451 first unread article (@code{gnus-group-read-group}).  If there are no
1452 unread articles in the group, or if you give a non-numerical prefix to
1453 this command, gnus will offer to fetch all the old articles in this
1454 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1455 determines the number of articles gnus will fetch.  If @var{N} is
1456 positive, gnus fetches the @var{N} newest articles, if @var{N} is
1457 negative, gnus fetches the @var{abs(N)} oldest articles.
1458
1459 @item RET
1460 @kindex RET (Group)
1461 @findex gnus-group-select-group
1462 Select the current group and switch to the summary buffer
1463 (@code{gnus-group-select-group}).  Takes the same arguments as
1464 @code{gnus-group-read-group}---the only difference is that this command
1465 does not display the first unread article automatically upon group
1466 entry.
1467
1468 @item M-RET
1469 @kindex M-RET (Group)
1470 @findex gnus-group-quick-select-group
1471 This does the same as the command above, but tries to do it with the
1472 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1473 scoring/killing will be performed, there will be no highlights and no
1474 expunging.  This might be useful if you're in a real hurry and have to
1475 enter some humongous group.  If you give a 0 prefix to this command
1476 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
1477 which is useful if you want to toggle threading before generating the
1478 summary buffer (@pxref{Summary Generation Commands}).
1479
1480 @item M-SPACE
1481 @kindex M-SPACE (Group)
1482 @findex gnus-group-visible-select-group
1483 This is yet one more command that does the same as the @kbd{RET}
1484 command, but this one does it without expunging and hiding dormants
1485 (@code{gnus-group-visible-select-group}).
1486
1487 @item M-C-RET
1488 @kindex M-C-RET (Group)
1489 @findex gnus-group-select-group-ephemerally
1490 Finally, this command selects the current group ephemerally without
1491 doing any processing of its contents
1492 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1493 turned off.  Everything you do in the group after selecting it in this
1494 manner will have no permanent effects.
1495
1496 @end table
1497
1498 @vindex gnus-large-newsgroup
1499 The @code{gnus-large-newsgroup} variable says what gnus should consider
1500 to be a big group.  This is 200 by default.  If the group has more
1501 (unread and/or ticked) articles than this, gnus will query the user
1502 before entering the group.  The user can then specify how many articles
1503 should be fetched from the server.  If the user specifies a negative
1504 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1505 is positive, the @code{n} articles that have arrived most recently will
1506 be fetched.
1507
1508 @vindex gnus-select-group-hook
1509 @vindex gnus-auto-select-first
1510 @code{gnus-auto-select-first} control whether any articles are selected
1511 automatically when entering a group with the @kbd{SPACE} command.
1512
1513 @table @code
1514
1515 @item nil
1516 Don't select any articles when entering the group.  Just display the
1517 full summary buffer.
1518
1519 @item t
1520 Select the first unread article when entering the group.
1521
1522 @item best
1523 Select the highest scored article in the group when entering the
1524 group.
1525
1526 @end table
1527
1528 This variable can also be a function.  In that case, that function will
1529 be called to place point on a subject line, and/or select some article.
1530 Useful functions include:
1531
1532 @table @code
1533 @item gnus-summary-first-unread-subject
1534 Place point on the subject line of the first unread article, but
1535 don't select the article.
1536
1537 @item gnus-summary-first-unread-article
1538 Select the first unread article.
1539
1540 @item gnus-summary-best-unread-article
1541 Select the highest-scored unread article.
1542 @end table
1543
1544
1545 If you want to prevent automatic selection in some group (say, in a
1546 binary group with Huge articles) you can set this variable to @code{nil}
1547 in @code{gnus-select-group-hook}, which is called when a group is
1548 selected.
1549
1550
1551 @node Subscription Commands
1552 @section Subscription Commands
1553 @cindex subscription
1554
1555 @table @kbd
1556
1557 @item S t
1558 @itemx u
1559 @kindex S t (Group)
1560 @kindex u (Group)
1561 @findex gnus-group-unsubscribe-current-group
1562 @c @icon{gnus-group-unsubscribe}
1563 Toggle subscription to the current group
1564 (@code{gnus-group-unsubscribe-current-group}).
1565
1566 @item S s
1567 @itemx U
1568 @kindex S s (Group)
1569 @kindex U (Group)
1570 @findex gnus-group-unsubscribe-group
1571 Prompt for a group to subscribe, and then subscribe it.  If it was
1572 subscribed already, unsubscribe it instead
1573 (@code{gnus-group-unsubscribe-group}).
1574
1575 @item S k
1576 @itemx C-k
1577 @kindex S k (Group)
1578 @kindex C-k (Group)
1579 @findex gnus-group-kill-group
1580 @c @icon{gnus-group-kill-group}
1581 Kill the current group (@code{gnus-group-kill-group}).
1582
1583 @item S y
1584 @itemx C-y
1585 @kindex S y (Group)
1586 @kindex C-y (Group)
1587 @findex gnus-group-yank-group
1588 Yank the last killed group (@code{gnus-group-yank-group}).
1589
1590 @item C-x C-t
1591 @kindex C-x C-t (Group)
1592 @findex gnus-group-transpose-groups
1593 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1594 really a subscription command, but you can use it instead of a
1595 kill-and-yank sequence sometimes.
1596
1597 @item S w
1598 @itemx C-w
1599 @kindex S w (Group)
1600 @kindex C-w (Group)
1601 @findex gnus-group-kill-region
1602 Kill all groups in the region (@code{gnus-group-kill-region}).
1603
1604 @item S z
1605 @kindex S z (Group)
1606 @findex gnus-group-kill-all-zombies
1607 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1608
1609 @item S C-k
1610 @kindex S C-k (Group)
1611 @findex gnus-group-kill-level
1612 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1613 These groups can't be yanked back after killing, so this command should
1614 be used with some caution.  The only time where this command comes in
1615 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1616 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1617 kill off all unsubscribed groups that do not have message numbers in the
1618 @file{.newsrc} file.
1619
1620 @end table
1621
1622 Also @pxref{Group Levels}.
1623
1624
1625 @node Group Data
1626 @section Group Data
1627
1628 @table @kbd
1629
1630 @item c
1631 @kindex c (Group)
1632 @findex gnus-group-catchup-current
1633 @vindex gnus-group-catchup-group-hook
1634 @c @icon{gnus-group-catchup-current}
1635 Mark all unticked articles in this group as read
1636 (@code{gnus-group-catchup-current}).
1637 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1638 the group buffer.
1639
1640 @item C
1641 @kindex C (Group)
1642 @findex gnus-group-catchup-current-all
1643 Mark all articles in this group, even the ticked ones, as read
1644 (@code{gnus-group-catchup-current-all}).
1645
1646 @item M-c
1647 @kindex M-c (Group)
1648 @findex gnus-group-clear-data
1649 Clear the data from the current group---nix out marks and the list of
1650 read articles (@code{gnus-group-clear-data}).
1651
1652 @item M-x gnus-group-clear-data-on-native-groups
1653 @kindex M-x gnus-group-clear-data-on-native-groups
1654 @findex gnus-group-clear-data-on-native-groups
1655 If you have switched from one @sc{nntp} server to another, all your marks
1656 and read ranges have become worthless.  You can use this command to
1657 clear out all data that you have on your native groups.  Use with
1658 caution.
1659
1660 @end table
1661
1662
1663 @node Group Levels
1664 @section Group Levels
1665 @cindex group level
1666 @cindex level
1667
1668 All groups have a level of @dfn{subscribedness}.  For instance, if a
1669 group is on level 2, it is more subscribed than a group on level 5.  You
1670 can ask gnus to just list groups on a given level or lower
1671 (@pxref{Listing Groups}), or to just check for new articles in groups on
1672 a given level or lower (@pxref{Scanning New Messages}).
1673
1674 Remember:  The higher the level of the group, the less important it is.
1675
1676 @table @kbd
1677
1678 @item S l
1679 @kindex S l (Group)
1680 @findex gnus-group-set-current-level
1681 Set the level of the current group.  If a numeric prefix is given, the
1682 next @var{n} groups will have their levels set.  The user will be
1683 prompted for a level.
1684 @end table
1685
1686 @vindex gnus-level-killed
1687 @vindex gnus-level-zombie
1688 @vindex gnus-level-unsubscribed
1689 @vindex gnus-level-subscribed
1690 Gnus considers groups from levels 1 to
1691 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1692 @code{gnus-level-subscribed} (exclusive) and
1693 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1694 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1695 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1696 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1697 same, but zombie and killed groups have no information on what articles
1698 you have read, etc, stored.  This distinction between dead and living
1699 groups isn't done because it is nice or clever, it is done purely for
1700 reasons of efficiency.
1701
1702 It is recommended that you keep all your mail groups (if any) on quite
1703 low levels (e.g. 1 or 2).
1704
1705 If you want to play with the level variables, you should show some care.
1706 Set them once, and don't touch them ever again.  Better yet, don't touch
1707 them at all unless you know exactly what you're doing.
1708
1709 @vindex gnus-level-default-unsubscribed
1710 @vindex gnus-level-default-subscribed
1711 Two closely related variables are @code{gnus-level-default-subscribed}
1712 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1713 which are the levels that new groups will be put on if they are
1714 (un)subscribed.  These two variables should, of course, be inside the
1715 relevant valid ranges.
1716
1717 @vindex gnus-keep-same-level
1718 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1719 will only move to groups of the same level (or lower).  In
1720 particular, going from the last article in one group to the next group
1721 will go to the next group of the same level (or lower).  This might be
1722 handy if you want to read the most important groups before you read the
1723 rest.
1724
1725 @vindex gnus-group-default-list-level
1726 All groups with a level less than or equal to
1727 @code{gnus-group-default-list-level} will be listed in the group buffer
1728 by default.
1729
1730 @vindex gnus-group-list-inactive-groups
1731 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1732 groups will be listed along with the unread groups.  This variable is
1733 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1734 listed.
1735
1736 @vindex gnus-group-use-permanent-levels
1737 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1738 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1739 use this level as the ``work'' level.
1740
1741 @vindex gnus-activate-level
1742 Gnus will normally just activate (i. e., query the server about) groups
1743 on level @code{gnus-activate-level} or less.  If you don't want to
1744 activate unsubscribed groups, for instance, you might set this variable
1745 to 5.  The default is 6.
1746
1747
1748 @node Group Score
1749 @section Group Score
1750 @cindex group score
1751 @cindex group rank
1752 @cindex rank
1753
1754 You would normally keep important groups on high levels, but that scheme
1755 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1756 group buffer according to how often you read groups, perhaps?  Within
1757 reason?
1758
1759 This is what @dfn{group score} is for.  You can have Gnus assign a score
1760 to each group through the mechanism described below.  You can then sort
1761 the group buffer based on this score.  Alternatively, you can sort on
1762 score and then level.  (Taken together, the level and the score is
1763 called the @dfn{rank} of the group.  A group that is on level 4 and has
1764 a score of 1 has a higher rank than a group on level 5 that has a score
1765 of 300.  (The level is the most significant part and the score is the
1766 least significant part.))
1767
1768 @findex gnus-summary-bubble-group
1769 If you want groups you read often to get higher scores than groups you
1770 read seldom you can add the @code{gnus-summary-bubble-group} function to
1771 the @code{gnus-summary-exit-hook} hook.  This will result (after
1772 sorting) in a bubbling sort of action.  If you want to see that in
1773 action after each summary exit, you can add
1774 @code{gnus-group-sort-groups-by-rank} or
1775 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1776 slow things down somewhat.
1777
1778
1779 @node Marking Groups
1780 @section Marking Groups
1781 @cindex marking groups
1782
1783 If you want to perform some command on several groups, and they appear
1784 subsequently in the group buffer, you would normally just give a
1785 numerical prefix to the command.  Most group commands will then do your
1786 bidding on those groups.
1787
1788 However, if the groups are not in sequential order, you can still
1789 perform a command on several groups.  You simply mark the groups first
1790 with the process mark and then execute the command.
1791
1792 @table @kbd
1793
1794 @item #
1795 @kindex # (Group)
1796 @itemx M m
1797 @kindex M m (Group)
1798 @findex gnus-group-mark-group
1799 Set the mark on the current group (@code{gnus-group-mark-group}).
1800
1801 @item M-#
1802 @kindex M-# (Group)
1803 @itemx M u
1804 @kindex M u (Group)
1805 @findex gnus-group-unmark-group
1806 Remove the mark from the current group
1807 (@code{gnus-group-unmark-group}).
1808
1809 @item M U
1810 @kindex M U (Group)
1811 @findex gnus-group-unmark-all-groups
1812 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1813
1814 @item M w
1815 @kindex M w (Group)
1816 @findex gnus-group-mark-region
1817 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1818
1819 @item M b
1820 @kindex M b (Group)
1821 @findex gnus-group-mark-buffer
1822 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1823
1824 @item M r
1825 @kindex M r (Group)
1826 @findex gnus-group-mark-regexp
1827 Mark all groups that match some regular expression
1828 (@code{gnus-group-mark-regexp}).
1829 @end table
1830
1831 Also @pxref{Process/Prefix}.
1832
1833 @findex gnus-group-universal-argument
1834 If you want to execute some command on all groups that have been marked
1835 with the process mark, you can use the @kbd{M-&}
1836 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1837 the command to be executed.
1838
1839
1840 @node Foreign Groups
1841 @section Foreign Groups
1842 @cindex foreign groups
1843
1844 Below are some group mode commands for making and editing general foreign
1845 groups, as well as commands to ease the creation of a few
1846 special-purpose groups.  All these commands insert the newly created
1847 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1848 consulted.
1849
1850 @table @kbd
1851
1852 @item G m
1853 @kindex G m (Group)
1854 @findex gnus-group-make-group
1855 @cindex making groups
1856 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1857 for a name, a method and possibly an @dfn{address}.  For an easier way
1858 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1859
1860 @item G r
1861 @kindex G r (Group)
1862 @findex gnus-group-rename-group
1863 @cindex renaming groups
1864 Rename the current group to something else
1865 (@code{gnus-group-rename-group}).  This is valid only on some
1866 groups---mail groups mostly.  This command might very well be quite slow
1867 on some backends.
1868
1869 @item G c
1870 @kindex G c (Group)
1871 @cindex customizing
1872 @findex gnus-group-customize
1873 Customize the group parameters (@code{gnus-group-customize}).
1874
1875 @item G e
1876 @kindex G e (Group)
1877 @findex gnus-group-edit-group-method
1878 @cindex renaming groups
1879 Enter a buffer where you can edit the select method of the current
1880 group (@code{gnus-group-edit-group-method}).
1881
1882 @item G p
1883 @kindex G p (Group)
1884 @findex gnus-group-edit-group-parameters
1885 Enter a buffer where you can edit the group parameters
1886 (@code{gnus-group-edit-group-parameters}).
1887
1888 @item G E
1889 @kindex G E (Group)
1890 @findex gnus-group-edit-group
1891 Enter a buffer where you can edit the group info
1892 (@code{gnus-group-edit-group}).
1893
1894 @item G d
1895 @kindex G d (Group)
1896 @findex gnus-group-make-directory-group
1897 @cindex nndir
1898 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1899 for a directory name (@code{gnus-group-make-directory-group}).
1900
1901 @item G h
1902 @kindex G h (Group)
1903 @cindex help group
1904 @findex gnus-group-make-help-group
1905 Make the gnus help group (@code{gnus-group-make-help-group}).
1906
1907 @item G a
1908 @kindex G a (Group)
1909 @cindex (ding) archive
1910 @cindex archive group
1911 @findex gnus-group-make-archive-group
1912 @vindex gnus-group-archive-directory
1913 @vindex gnus-group-recent-archive-directory
1914 Make a gnus archive group (@code{gnus-group-make-archive-group}).  By
1915 default a group pointing to the most recent articles will be created
1916 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1917 group will be created from @code{gnus-group-archive-directory}.
1918
1919 @item G k
1920 @kindex G k (Group)
1921 @findex gnus-group-make-kiboze-group
1922 @cindex nnkiboze
1923 Make a kiboze group.  You will be prompted for a name, for a regexp to
1924 match groups to be ``included'' in the kiboze group, and a series of
1925 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1926 @xref{Kibozed Groups}.
1927
1928 @item G D
1929 @kindex G D (Group)
1930 @findex gnus-group-enter-directory
1931 @cindex nneething
1932 Read an arbitrary directory as if it were a newsgroup with the
1933 @code{nneething} backend (@code{gnus-group-enter-directory}).
1934 @xref{Anything Groups}.
1935
1936 @item G f
1937 @kindex G f (Group)
1938 @findex gnus-group-make-doc-group
1939 @cindex ClariNet Briefs
1940 @cindex nndoc
1941 Make a group based on some file or other
1942 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1943 command, you will be prompted for a file name and a file type.
1944 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1945 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1946 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
1947 If you run this command without a prefix, Gnus will guess at the file
1948 type.  @xref{Document Groups}.
1949
1950 @item G u
1951 @kindex G u (Group)
1952 @vindex gnus-useful-groups
1953 @findex gnus-group-make-useful-group
1954 Create one of the groups mentioned in @code{gnus-useful-groups}
1955 (@code{gnus-group-make-useful-group}).
1956
1957 @item G w
1958 @kindex G w (Group)
1959 @findex gnus-group-make-web-group
1960 @cindex DejaNews
1961 @cindex Alta Vista
1962 @cindex InReference
1963 @cindex nnweb
1964 Make an ephemeral group based on a web search
1965 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1966 command, make a solid group instead.  You will be prompted for the
1967 search engine type and the search string.  Valid search engine types
1968 include @code{dejanews}, @code{altavista} and @code{reference}.
1969 @xref{Web Searches}.
1970
1971 If you use the @code{dejanews} search engine, you can limit the search
1972 to a particular group by using a match string like
1973 @samp{~g alt.sysadmin.recovery shaving}.
1974
1975 @item G DEL
1976 @kindex G DEL (Group)
1977 @findex gnus-group-delete-group
1978 This function will delete the current group
1979 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1980 actually delete all the articles in the group, and forcibly remove the
1981 group itself from the face of the Earth.  Use a prefix only if you are
1982 absolutely sure of what you are doing.  This command can't be used on
1983 read-only groups (like @code{nntp} group), though.
1984
1985 @item G V
1986 @kindex G V (Group)
1987 @findex gnus-group-make-empty-virtual
1988 Make a new, fresh, empty @code{nnvirtual} group
1989 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1990
1991 @item G v
1992 @kindex G v (Group)
1993 @findex gnus-group-add-to-virtual
1994 Add the current group to an @code{nnvirtual} group
1995 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1996 @end table
1997
1998 @xref{Select Methods}, for more information on the various select
1999 methods.
2000
2001 @vindex gnus-activate-foreign-newsgroups
2002 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2003 gnus will check all foreign groups with this level or lower at startup.
2004 This might take quite a while, especially if you subscribe to lots of
2005 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
2006 @code{gnus-activate-level} also affects activation of foreign
2007 newsgroups.
2008
2009
2010 @node Group Parameters
2011 @section Group Parameters
2012 @cindex group parameters
2013
2014 The group parameters store information local to a particular group.
2015 Here's an example group parameter list:
2016
2017 @example
2018 ((to-address . "ding@@gnus.org")
2019  (auto-expire . t))
2020 @end example
2021
2022 We see that each element consists of a "dotted pair"---the thing before
2023 the dot is the key, while the thing after the dot is the value.  All the
2024 parameters have this form @emph{except} local variable specs, which are
2025 not dotted pairs, but proper lists.
2026
2027 The following group parameters can be used:
2028
2029 @table @code
2030 @item to-address
2031 @cindex to-address
2032 Address used by when doing followups and new posts.
2033
2034 @example
2035 (to-address .  "some@@where.com")
2036 @end example
2037
2038 This is primarily useful in mail groups that represent closed mailing
2039 lists---mailing lists where it's expected that everybody that writes to
2040 the mailing list is subscribed to it.  Since using this parameter
2041 ensures that the mail only goes to the mailing list itself, it means
2042 that members won't receive two copies of your followups.
2043
2044 Using @code{to-address} will actually work whether the group is foreign
2045 or not.  Let's say there's a group on the server that is called
2046 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2047 the articles from a mail-to-news gateway.  Posting directly to this
2048 group is therefore impossible---you have to send mail to the mailing
2049 list address instead.
2050
2051 @item to-list
2052 @cindex to-list
2053 Address used when doing a @kbd{a} in that group.
2054
2055 @example
2056 (to-list . "some@@where.com")
2057 @end example
2058
2059 It is totally ignored
2060 when doing a followup---except that if it is present in a news group,
2061 you'll get mail group semantics when doing @kbd{f}.
2062
2063 If you do an @kbd{a} command in a mail group and you have neither a
2064 @code{to-list} group parameter nor a @code{to-address} group parameter,
2065 then a @code{to-list} group parameter will be added automatically upon
2066 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2067 @vindex gnus-add-to-list
2068
2069 If you do an @kbd{a} command in a mail group and you don't have a
2070 @code{to-list} group parameter, one will be added automatically upon
2071 sending the message.
2072
2073 @item visible
2074 @cindex visible
2075 If the group parameter list has the element @code{(visible . t)},
2076 that group will always be visible in the Group buffer, regardless
2077 of whether it has any unread articles.
2078
2079 @item broken-reply-to
2080 @cindex broken-reply-to
2081 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2082 headers in this group are to be ignored.  This can be useful if you're
2083 reading a mailing list group where the listserv has inserted
2084 @code{Reply-To} headers that point back to the listserv itself.  This is
2085 broken behavior.  So there!
2086
2087 @item to-group
2088 @cindex to-group
2089 Elements like @code{(to-group . "some.group.name")} means that all
2090 posts in that group will be sent to @code{some.group.name}.
2091
2092 @item newsgroup
2093 @cindex newsgroup
2094 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2095 will treat all responses as if they were responses to news articles.
2096 This can be useful if you have a mail group that's really a mirror of a
2097 news group.
2098
2099 @item gcc-self
2100 @cindex gcc-self
2101 If @code{(gcc-self . t)} is present in the group parameter list, newly
2102 composed messages will be @code{Gcc}'d to the current group. If
2103 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2104 generated, if @code{(gcc-self . "string")} is present, this string will
2105 be inserted literally as a @code{gcc} header.  This parameter takes
2106 precedence over any default @code{Gcc} rules as described later
2107 (@pxref{Archived Messages}).
2108
2109 @item auto-expire
2110 @cindex auto-expire
2111 If the group parameter has an element that looks like @code{(auto-expire
2112 . t)}, all articles read will be marked as expirable.  For an
2113 alternative approach, @pxref{Expiring Mail}.
2114
2115 @item total-expire
2116 @cindex total-expire
2117 If the group parameter has an element that looks like
2118 @code{(total-expire . t)}, all read articles will be put through the
2119 expiry process, even if they are not marked as expirable.  Use with
2120 caution.  Unread, ticked and dormant articles are not eligible for
2121 expiry.
2122
2123 @item expiry-wait
2124 @cindex expiry-wait
2125 @vindex nnmail-expiry-wait-function
2126 If the group parameter has an element that looks like @code{(expiry-wait
2127 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2128 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2129 The value can either be a number of days (not necessarily an integer) or
2130 the symbols @code{never} or @code{immediate}.
2131
2132 @item score-file
2133 @cindex score file group parameter
2134 Elements that look like @code{(score-file . "file")} will make
2135 @file{file} into the current score file for the group in question.  All
2136 interactive score entries will be put into this file.
2137
2138 @item adapt-file
2139 @cindex adapt file group parameter
2140 Elements that look like @code{(adapt-file . "file")} will make
2141 @file{file} into the current adaptive file for the group in question.
2142 All adaptive score entries will be put into this file.
2143
2144 @item admin-address
2145 When unsubscribing from a mailing list you should never send the
2146 unsubscription notice to the mailing list itself.  Instead, you'd send
2147 messages to the administrative address.  This parameter allows you to
2148 put the admin address somewhere convenient.
2149
2150 @item display
2151 Elements that look like @code{(display . MODE)} say which articles to
2152 display on entering the group.  Valid values are:
2153
2154 @table @code
2155 @item all
2156 Display all articles, both read and unread.
2157
2158 @item default
2159 Display the default visible articles, which normally includes unread and
2160 ticked articles.
2161 @end table
2162
2163 @item comment
2164 Elements that look like @code{(comment . "This is a comment")}
2165 are arbitrary comments on the group.  They are currently ignored by
2166 gnus, but provide a place for you to store information on particular
2167 groups.
2168
2169 @item charset
2170 Elements that look like @code{(charset . iso-8859-1)} will make
2171 @code{iso-8859-1} the default charset; that is, the charset that will be
2172 used for all articles that do not specify a charset.
2173
2174 @item @var{(variable form)}
2175 You can use the group parameters to set variables local to the group you
2176 are entering.  If you want to turn threading off in @samp{news.answers},
2177 you could put @code{(gnus-show-threads nil)} in the group parameters of
2178 that group.  @code{gnus-show-threads} will be made into a local variable
2179 in the summary buffer you enter, and the form @code{nil} will be
2180 @code{eval}ed there.
2181
2182 This can also be used as a group-specific hook function, if you'd like.
2183 If you want to hear a beep when you enter a group, you could put
2184 something like @code{(dummy-variable (ding))} in the parameters of that
2185 group.  @code{dummy-variable} will be set to the result of the
2186 @code{(ding)} form, but who cares?
2187
2188 @item posting-style
2189 You can store additional posting style information for this group only
2190 here (@pxref{Posting Styles}). The format is that of an entry in the
2191 @code{gnus-posting-styles} alist, except that there's no regexp matching
2192 the group name (of course). Style elements in this group parameter will
2193 take precedence over the ones found in @code{gnus-posting-styles}.
2194
2195 For instance, if you want a funky name and signature in this group only,
2196 instead of hacking @code{gnus-posting-styles}, you could put something
2197 like this in the group parameters:
2198
2199 @example
2200 (posting-style
2201   (name "Funky Name")
2202   (signature "Funky Signature"))
2203 @end example
2204
2205 @end table
2206
2207 Use the @kbd{G p} command to edit group parameters of a group.  You
2208 might also be interested in reading about topic parameters (@pxref{Topic
2209 Parameters}).
2210
2211
2212 @node Listing Groups
2213 @section Listing Groups
2214 @cindex group listing
2215
2216 These commands all list various slices of the groups available.
2217
2218 @table @kbd
2219
2220 @item l
2221 @itemx A s
2222 @kindex A s (Group)
2223 @kindex l (Group)
2224 @findex gnus-group-list-groups
2225 List all groups that have unread articles
2226 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2227 command will list only groups of level ARG and lower.  By default, it
2228 only lists groups of level five (i. e.,
2229 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2230 groups).
2231
2232 @item L
2233 @itemx A u
2234 @kindex A u (Group)
2235 @kindex L (Group)
2236 @findex gnus-group-list-all-groups
2237 List all groups, whether they have unread articles or not
2238 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2239 this command will list only groups of level ARG and lower.  By default,
2240 it lists groups of level seven or lower (i.e., just subscribed and
2241 unsubscribed groups).
2242
2243 @item A l
2244 @kindex A l (Group)
2245 @findex gnus-group-list-level
2246 List all unread groups on a specific level
2247 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2248 with no unread articles.
2249
2250 @item A k
2251 @kindex A k (Group)
2252 @findex gnus-group-list-killed
2253 List all killed groups (@code{gnus-group-list-killed}).  If given a
2254 prefix argument, really list all groups that are available, but aren't
2255 currently (un)subscribed.  This could entail reading the active file
2256 from the server.
2257
2258 @item A z
2259 @kindex A z (Group)
2260 @findex gnus-group-list-zombies
2261 List all zombie groups (@code{gnus-group-list-zombies}).
2262
2263 @item A m
2264 @kindex A m (Group)
2265 @findex gnus-group-list-matching
2266 List all unread, subscribed groups with names that match a regexp
2267 (@code{gnus-group-list-matching}).
2268
2269 @item A M
2270 @kindex A M (Group)
2271 @findex gnus-group-list-all-matching
2272 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2273
2274 @item A A
2275 @kindex A A (Group)
2276 @findex gnus-group-list-active
2277 List absolutely all groups in the active file(s) of the
2278 server(s) you are connected to (@code{gnus-group-list-active}).  This
2279 might very well take quite a while.  It might actually be a better idea
2280 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2281 thing to match on.  Also note that this command may list groups that
2282 don't exist (yet)---these will be listed as if they were killed groups.
2283 Take the output with some grains of salt.
2284
2285 @item A a
2286 @kindex A a (Group)
2287 @findex gnus-group-apropos
2288 List all groups that have names that match a regexp
2289 (@code{gnus-group-apropos}).
2290
2291 @item A d
2292 @kindex A d (Group)
2293 @findex gnus-group-description-apropos
2294 List all groups that have names or descriptions that match a regexp
2295 (@code{gnus-group-description-apropos}).
2296
2297 @end table
2298
2299 @vindex gnus-permanently-visible-groups
2300 @cindex visible group parameter
2301 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2302 always be shown, whether they have unread articles or not.  You can also
2303 add the @code{visible} element to the group parameters in question to
2304 get the same effect.
2305
2306 @vindex gnus-list-groups-with-ticked-articles
2307 Groups that have just ticked articles in it are normally listed in the
2308 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2309 @code{nil}, these groups will be treated just like totally empty
2310 groups.  It is @code{t} by default.
2311
2312
2313 @node Sorting Groups
2314 @section Sorting Groups
2315 @cindex sorting groups
2316
2317 @kindex C-c C-s (Group)
2318 @findex gnus-group-sort-groups
2319 @vindex gnus-group-sort-function
2320 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2321 group buffer according to the function(s) given by the
2322 @code{gnus-group-sort-function} variable.  Available sorting functions
2323 include:
2324
2325 @table @code
2326
2327 @item gnus-group-sort-by-alphabet
2328 @findex gnus-group-sort-by-alphabet
2329 Sort the group names alphabetically.  This is the default.
2330
2331 @item gnus-group-sort-by-real-name
2332 @findex gnus-group-sort-by-real-name
2333 Sort the group alphabetically on the real (unprefixed) group names.
2334
2335 @item gnus-group-sort-by-level
2336 @findex gnus-group-sort-by-level
2337 Sort by group level.
2338
2339 @item gnus-group-sort-by-score
2340 @findex gnus-group-sort-by-score
2341 Sort by group score.  @xref{Group Score}.
2342
2343 @item gnus-group-sort-by-rank
2344 @findex gnus-group-sort-by-rank
2345 Sort by group score and then the group level.  The level and the score
2346 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2347
2348 @item gnus-group-sort-by-unread
2349 @findex gnus-group-sort-by-unread
2350 Sort by number of unread articles.
2351
2352 @item gnus-group-sort-by-method
2353 @findex gnus-group-sort-by-method
2354 Sort alphabetically on the select method.
2355
2356
2357 @end table
2358
2359 @code{gnus-group-sort-function} can also be a list of sorting
2360 functions.  In that case, the most significant sort key function must be
2361 the last one.
2362
2363
2364 There are also a number of commands for sorting directly according to
2365 some sorting criteria:
2366
2367 @table @kbd
2368 @item G S a
2369 @kindex G S a (Group)
2370 @findex gnus-group-sort-groups-by-alphabet
2371 Sort the group buffer alphabetically by group name
2372 (@code{gnus-group-sort-groups-by-alphabet}).
2373
2374 @item G S u
2375 @kindex G S u (Group)
2376 @findex gnus-group-sort-groups-by-unread
2377 Sort the group buffer by the number of unread articles
2378 (@code{gnus-group-sort-groups-by-unread}).
2379
2380 @item G S l
2381 @kindex G S l (Group)
2382 @findex gnus-group-sort-groups-by-level
2383 Sort the group buffer by group level
2384 (@code{gnus-group-sort-groups-by-level}).
2385
2386 @item G S v
2387 @kindex G S v (Group)
2388 @findex gnus-group-sort-groups-by-score
2389 Sort the group buffer by group score
2390 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2391
2392 @item G S r
2393 @kindex G S r (Group)
2394 @findex gnus-group-sort-groups-by-rank
2395 Sort the group buffer by group rank
2396 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2397
2398 @item G S m
2399 @kindex G S m (Group)
2400 @findex gnus-group-sort-groups-by-method
2401 Sort the group buffer alphabetically by backend name
2402 (@code{gnus-group-sort-groups-by-method}).
2403
2404 @end table
2405
2406 All the commands below obeys the process/prefix convention
2407 (@pxref{Process/Prefix}).
2408
2409 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2410 commands will sort in reverse order.
2411
2412 You can also sort a subset of the groups:
2413
2414 @table @kbd
2415 @item G P a
2416 @kindex G P a (Group)
2417 @findex gnus-group-sort-selected-groups-by-alphabet
2418 Sort the groups alphabetically by group name
2419 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2420
2421 @item G P u
2422 @kindex G P u (Group)
2423 @findex gnus-group-sort-selected-groups-by-unread
2424 Sort the groups by the number of unread articles
2425 (@code{gnus-group-sort-selected-groups-by-unread}).
2426
2427 @item G P l
2428 @kindex G P l (Group)
2429 @findex gnus-group-sort-selected-groups-by-level
2430 Sort the groups by group level
2431 (@code{gnus-group-sort-selected-groups-by-level}).
2432
2433 @item G P v
2434 @kindex G P v (Group)
2435 @findex gnus-group-sort-selected-groups-by-score
2436 Sort the groups by group score
2437 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2438
2439 @item G P r
2440 @kindex G P r (Group)
2441 @findex gnus-group-sort-selected-groups-by-rank
2442 Sort the groups by group rank
2443 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2444
2445 @item G P m
2446 @kindex G P m (Group)
2447 @findex gnus-group-sort-selected-groups-by-method
2448 Sort the groups alphabetically by backend name
2449 (@code{gnus-group-sort-selected-groups-by-method}).
2450
2451 @end table
2452
2453
2454
2455 @node Group Maintenance
2456 @section Group Maintenance
2457 @cindex bogus groups
2458
2459 @table @kbd
2460 @item b
2461 @kindex b (Group)
2462 @findex gnus-group-check-bogus-groups
2463 Find bogus groups and delete them
2464 (@code{gnus-group-check-bogus-groups}).
2465
2466 @item F
2467 @kindex F (Group)
2468 @findex gnus-group-find-new-groups
2469 Find new groups and process them (@code{gnus-group-find-new-groups}).
2470 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2471 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
2472 to query the server for new groups, and subscribe the new groups as
2473 zombies.
2474
2475 @item C-c C-x
2476 @kindex C-c C-x (Group)
2477 @findex gnus-group-expire-articles
2478 Run all expirable articles in the current group through the expiry
2479 process (if any) (@code{gnus-group-expire-articles}).
2480
2481 @item C-c M-C-x
2482 @kindex C-c M-C-x (Group)
2483 @findex gnus-group-expire-all-groups
2484 Run all articles in all groups through the expiry process
2485 (@code{gnus-group-expire-all-groups}).
2486
2487 @end table
2488
2489
2490 @node Browse Foreign Server
2491 @section Browse Foreign Server
2492 @cindex foreign servers
2493 @cindex browsing servers
2494
2495 @table @kbd
2496 @item B
2497 @kindex B (Group)
2498 @findex gnus-group-browse-foreign-server
2499 You will be queried for a select method and a server name.  Gnus will
2500 then attempt to contact this server and let you browse the groups there
2501 (@code{gnus-group-browse-foreign-server}).
2502 @end table
2503
2504 @findex gnus-browse-mode
2505 A new buffer with a list of available groups will appear.  This buffer
2506 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2507 a lot) like a normal group buffer.
2508
2509 Here's a list of keystrokes available in the browse mode:
2510
2511 @table @kbd
2512 @item n
2513 @kindex n (Browse)
2514 @findex gnus-group-next-group
2515 Go to the next group (@code{gnus-group-next-group}).
2516
2517 @item p
2518 @kindex p (Browse)
2519 @findex gnus-group-prev-group
2520 Go to the previous group (@code{gnus-group-prev-group}).
2521
2522 @item SPACE
2523 @kindex SPACE (Browse)
2524 @findex gnus-browse-read-group
2525 Enter the current group and display the first article
2526 (@code{gnus-browse-read-group}).
2527
2528 @item RET
2529 @kindex RET (Browse)
2530 @findex gnus-browse-select-group
2531 Enter the current group (@code{gnus-browse-select-group}).
2532
2533 @item u
2534 @kindex u (Browse)
2535 @findex gnus-browse-unsubscribe-current-group
2536 Unsubscribe to the current group, or, as will be the case here,
2537 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2538
2539 @item l
2540 @itemx q
2541 @kindex q (Browse)
2542 @kindex l (Browse)
2543 @findex gnus-browse-exit
2544 Exit browse mode (@code{gnus-browse-exit}).
2545
2546 @item ?
2547 @kindex ? (Browse)
2548 @findex gnus-browse-describe-briefly
2549 Describe browse mode briefly (well, there's not much to describe, is
2550 there) (@code{gnus-browse-describe-briefly}).
2551 @end table
2552
2553
2554 @node Exiting Gnus
2555 @section Exiting gnus
2556 @cindex exiting gnus
2557
2558 Yes, gnus is ex(c)iting.
2559
2560 @table @kbd
2561 @item z
2562 @kindex z (Group)
2563 @findex gnus-group-suspend
2564 Suspend gnus (@code{gnus-group-suspend}).  This doesn't really exit gnus,
2565 but it kills all buffers except the Group buffer.  I'm not sure why this
2566 is a gain, but then who am I to judge?
2567
2568 @item q
2569 @kindex q (Group)
2570 @findex gnus-group-exit
2571 @c @icon{gnus-group-exit}
2572 Quit gnus (@code{gnus-group-exit}).
2573
2574 @item Q
2575 @kindex Q (Group)
2576 @findex gnus-group-quit
2577 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2578 The dribble file will be saved, though (@pxref{Auto Save}).
2579 @end table
2580
2581 @vindex gnus-exit-gnus-hook
2582 @vindex gnus-suspend-gnus-hook
2583 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
2584 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
2585 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2586 exiting gnus.
2587
2588 @findex gnus-unload
2589 @cindex unloading
2590 If you wish to completely unload gnus and all its adherents, you can use
2591 the @code{gnus-unload} command.  This command is also very handy when
2592 trying to customize meta-variables.
2593
2594 Note:
2595
2596 @quotation
2597 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2598 numbly heavy and herself fall into a hazy trance as the boy sitting
2599 behind her drew repeated lines with his pencil across the back of her
2600 plastic chair.
2601 @end quotation
2602
2603
2604 @node Group Topics
2605 @section Group Topics
2606 @cindex topics
2607
2608 If you read lots and lots of groups, it might be convenient to group
2609 them hierarchically according to topics.  You put your Emacs groups over
2610 here, your sex groups over there, and the rest (what, two groups or so?)
2611 you put in some misc section that you never bother with anyway.  You can
2612 even group the Emacs sex groups as a sub-topic to either the Emacs
2613 groups or the sex groups---or both!  Go wild!
2614
2615 @iftex
2616 @iflatex
2617 \gnusfigure{Group Topics}{400}{
2618 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2619 }
2620 @end iflatex
2621 @end iftex
2622
2623 Here's an example:
2624
2625 @example
2626 Gnus
2627   Emacs -- I wuw it!
2628      3: comp.emacs
2629      2: alt.religion.emacs
2630     Naughty Emacs
2631      452: alt.sex.emacs
2632        0: comp.talk.emacs.recovery
2633   Misc
2634      8: comp.binaries.fractals
2635     13: comp.sources.unix
2636 @end example
2637
2638 @findex gnus-topic-mode
2639 @kindex t (Group)
2640 To get this @emph{fab} functionality you simply turn on (ooh!) the
2641 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2642 is a toggling command.)
2643
2644 Go ahead, just try it.  I'll still be here when you get back.  La de
2645 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2646 press @kbd{l}.  There.  All your groups are now listed under
2647 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2648 bothered?
2649
2650 If you want this permanently enabled, you should add that minor mode to
2651 the hook for the group mode:
2652
2653 @lisp
2654 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2655 @end lisp
2656
2657 @menu
2658 * Topic Variables::    How to customize the topics the Lisp Way.
2659 * Topic Commands::     Interactive E-Z commands.
2660 * Topic Sorting::      Sorting each topic individually.
2661 * Topic Topology::     A map of the world.
2662 * Topic Parameters::   Parameters that apply to all groups in a topic.
2663 @end menu
2664
2665
2666 @node Topic Variables
2667 @subsection Topic Variables
2668 @cindex topic variables
2669
2670 Now, if you select a topic, it will fold/unfold that topic, which is
2671 really neat, I think.
2672
2673 @vindex gnus-topic-line-format
2674 The topic lines themselves are created according to the
2675 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2676 Valid elements are:
2677
2678 @table @samp
2679 @item i
2680 Indentation.
2681 @item n
2682 Topic name.
2683 @item v
2684 Visibility.
2685 @item l
2686 Level.
2687 @item g
2688 Number of groups in the topic.
2689 @item a
2690 Number of unread articles in the topic.
2691 @item A
2692 Number of unread articles in the topic and all its subtopics.
2693 @end table
2694
2695 @vindex gnus-topic-indent-level
2696 Each sub-topic (and the groups in the sub-topics) will be indented with
2697 @code{gnus-topic-indent-level} times the topic level number of spaces.
2698 The default is 2.
2699
2700 @vindex gnus-topic-mode-hook
2701 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2702
2703 @vindex gnus-topic-display-empty-topics
2704 The @code{gnus-topic-display-empty-topics} says whether to display even
2705 topics that have no unread articles in them.  The default is @code{t}.
2706
2707
2708 @node Topic Commands
2709 @subsection Topic Commands
2710 @cindex topic commands
2711
2712 When the topic minor mode is turned on, a new @kbd{T} submap will be
2713 available.  In addition, a few of the standard keys change their
2714 definitions slightly.
2715
2716 @table @kbd
2717
2718 @item T n
2719 @kindex T n (Topic)
2720 @findex gnus-topic-create-topic
2721 Prompt for a new topic name and create it
2722 (@code{gnus-topic-create-topic}).
2723
2724 @item T m
2725 @kindex T m (Topic)
2726 @findex gnus-topic-move-group
2727 Move the current group to some other topic
2728 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2729 convention (@pxref{Process/Prefix}).
2730
2731 @item T c
2732 @kindex T c (Topic)
2733 @findex gnus-topic-copy-group
2734 Copy the current group to some other topic
2735 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2736 convention (@pxref{Process/Prefix}).
2737
2738 @item T D
2739 @kindex T D (Topic)
2740 @findex gnus-topic-remove-group
2741 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2742 This command is mainly useful if you have the same group in several
2743 topics and wish to remove it from one of the topics.  You may also
2744 remove a group from all topics, but in that case, Gnus will add it to
2745 the root topic the next time you start Gnus.  In fact, all new groups
2746 (which, naturally, don't belong to any topic) will show up in the root
2747 topic.
2748
2749 This command uses the process/prefix convention
2750 (@pxref{Process/Prefix}).
2751
2752 @item T M
2753 @kindex T M (Topic)
2754 @findex gnus-topic-move-matching
2755 Move all groups that match some regular expression to a topic
2756 (@code{gnus-topic-move-matching}).
2757
2758 @item T C
2759 @kindex T C (Topic)
2760 @findex gnus-topic-copy-matching
2761 Copy all groups that match some regular expression to a topic
2762 (@code{gnus-topic-copy-matching}).
2763
2764 @item T H
2765 @kindex T H (Topic)
2766 @findex gnus-topic-toggle-display-empty-topics
2767 Toggle hiding empty topics
2768 (@code{gnus-topic-toggle-display-empty-topics}).
2769
2770 @item T #
2771 @kindex T # (Topic)
2772 @findex gnus-topic-mark-topic
2773 Mark all groups in the current topic with the process mark
2774 (@code{gnus-topic-mark-topic}).
2775
2776 @item T M-#
2777 @kindex T M-# (Topic)
2778 @findex gnus-topic-unmark-topic
2779 Remove the process mark from all groups in the current topic
2780 (@code{gnus-topic-unmark-topic}).
2781
2782 @item T TAB
2783 @itemx TAB
2784 @kindex T TAB (Topic)
2785 @kindex TAB (Topic)
2786 @findex gnus-topic-indent
2787 ``Indent'' the current topic so that it becomes a sub-topic of the
2788 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2789 ``un-indent'' the topic instead.
2790
2791 @item M-TAB
2792 @kindex M-TAB (Topic)
2793 @findex gnus-topic-unindent
2794 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2795 parent of its current parent (@code{gnus-topic-unindent}).
2796
2797 @item RET
2798 @kindex RET (Topic)
2799 @findex gnus-topic-select-group
2800 @itemx SPACE
2801 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2802 When you perform this command on a group, you'll enter the group, as
2803 usual.  When done on a topic line, the topic will be folded (if it was
2804 visible) or unfolded (if it was folded already).  So it's basically a
2805 toggling command on topics.  In addition, if you give a numerical
2806 prefix, group on that level (and lower) will be displayed.
2807
2808 @item C-c C-x
2809 @kindex C-c C-x (Topic)
2810 @findex gnus-topic-expire-articles
2811 Run all expirable articles in the current group or topic through the expiry
2812 process (if any) (@code{gnus-topic-expire-articles}).
2813
2814 @item C-k
2815 @kindex C-k (Topic)
2816 @findex gnus-topic-kill-group
2817 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2818 topic will be removed along with the topic.
2819
2820 @item C-y
2821 @kindex C-y (Topic)
2822 @findex gnus-topic-yank-group
2823 Yank the previously killed group or topic
2824 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2825 before all groups.
2826
2827 @item T r
2828 @kindex T r (Topic)
2829 @findex gnus-topic-rename
2830 Rename a topic (@code{gnus-topic-rename}).
2831
2832 @item T DEL
2833 @kindex T DEL (Topic)
2834 @findex gnus-topic-delete
2835 Delete an empty topic (@code{gnus-topic-delete}).
2836
2837 @item A T
2838 @kindex A T (Topic)
2839 @findex gnus-topic-list-active
2840 List all groups that gnus knows about in a topics-ified way
2841 (@code{gnus-topic-list-active}).
2842
2843 @item G p
2844 @kindex G p (Topic)
2845 @findex gnus-topic-edit-parameters
2846 @cindex group parameters
2847 @cindex topic parameters
2848 @cindex parameters
2849 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2850 @xref{Topic Parameters}.
2851
2852 @end table
2853
2854
2855 @node Topic Sorting
2856 @subsection Topic Sorting
2857 @cindex topic sorting
2858
2859 You can sort the groups in each topic individually with the following
2860 commands:
2861
2862
2863 @table @kbd
2864 @item T S a
2865 @kindex T S a (Topic)
2866 @findex gnus-topic-sort-groups-by-alphabet
2867 Sort the current topic alphabetically by group name
2868 (@code{gnus-topic-sort-groups-by-alphabet}).
2869
2870 @item T S u
2871 @kindex T S u (Topic)
2872 @findex gnus-topic-sort-groups-by-unread
2873 Sort the current topic by the number of unread articles
2874 (@code{gnus-topic-sort-groups-by-unread}).
2875
2876 @item T S l
2877 @kindex T S l (Topic)
2878 @findex gnus-topic-sort-groups-by-level
2879 Sort the current topic by group level
2880 (@code{gnus-topic-sort-groups-by-level}).
2881
2882 @item T S v
2883 @kindex T S v (Topic)
2884 @findex gnus-topic-sort-groups-by-score
2885 Sort the current topic by group score
2886 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2887
2888 @item T S r
2889 @kindex T S r (Topic)
2890 @findex gnus-topic-sort-groups-by-rank
2891 Sort the current topic by group rank
2892 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2893
2894 @item T S m
2895 @kindex T S m (Topic)
2896 @findex gnus-topic-sort-groups-by-method
2897 Sort the current topic alphabetically by backend name
2898 (@code{gnus-topic-sort-groups-by-method}).
2899
2900 @end table
2901
2902 @xref{Sorting Groups}, for more information about group sorting.
2903
2904
2905 @node Topic Topology
2906 @subsection Topic Topology
2907 @cindex topic topology
2908 @cindex topology
2909
2910 So, let's have a look at an example group buffer:
2911
2912 @example
2913 Gnus
2914   Emacs -- I wuw it!
2915      3: comp.emacs
2916      2: alt.religion.emacs
2917     Naughty Emacs
2918      452: alt.sex.emacs
2919        0: comp.talk.emacs.recovery
2920   Misc
2921      8: comp.binaries.fractals
2922     13: comp.sources.unix
2923 @end example
2924
2925 So, here we have one top-level topic (@samp{Gnus}), two topics under
2926 that, and one sub-topic under one of the sub-topics.  (There is always
2927 just one (1) top-level topic).  This topology can be expressed as
2928 follows:
2929
2930 @lisp
2931 (("Gnus" visible)
2932  (("Emacs -- I wuw it!" visible)
2933   (("Naughty Emacs" visible)))
2934  (("Misc" visible)))
2935 @end lisp
2936
2937 @vindex gnus-topic-topology
2938 This is in fact how the variable @code{gnus-topic-topology} would look
2939 for the display above.  That variable is saved in the @file{.newsrc.eld}
2940 file, and shouldn't be messed with manually---unless you really want
2941 to.  Since this variable is read from the @file{.newsrc.eld} file,
2942 setting it in any other startup files will have no effect.
2943
2944 This topology shows what topics are sub-topics of what topics (right),
2945 and which topics are visible.  Two settings are currently
2946 allowed---@code{visible} and @code{invisible}.
2947
2948
2949 @node Topic Parameters
2950 @subsection Topic Parameters
2951 @cindex topic parameters
2952
2953 All groups in a topic will inherit group parameters from the parent (and
2954 ancestor) topic parameters.  All valid group parameters are valid topic
2955 parameters (@pxref{Group Parameters}).
2956
2957 Group parameters (of course) override topic parameters, and topic
2958 parameters in sub-topics override topic parameters in super-topics.  You
2959 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2960 verb, although you may feel free to disagree with me here.)
2961
2962 @example
2963 Gnus
2964   Emacs
2965      3: comp.emacs
2966      2: alt.religion.emacs
2967    452: alt.sex.emacs
2968     Relief
2969      452: alt.sex.emacs
2970        0: comp.talk.emacs.recovery
2971   Misc
2972      8: comp.binaries.fractals
2973     13: comp.sources.unix
2974    452: alt.sex.emacs
2975 @end example
2976
2977 The @samp{Emacs} topic has the topic parameter @code{(score-file
2978 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2979 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2980 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2981 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2982 . "religion.SCORE")}.
2983
2984 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2985 will get the @file{relief.SCORE} home score file.  If you enter the same
2986 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2987 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2988 get the @file{religion.SCORE} home score file.
2989
2990 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2991 there are some problems, especially with the @code{total-expiry}
2992 parameter.  Say you have a mail group in two topics; one with
2993 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2994 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2995 of these topics you mean to expire articles from, so anything may
2996 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2997 happens.  You just have to be careful if you do stuff like that.
2998
2999
3000 @node Misc Group Stuff
3001 @section Misc Group Stuff
3002
3003 @menu
3004 * Scanning New Messages:: Asking gnus to see whether new messages have arrived.
3005 * Group Information::     Information and help on groups and gnus.
3006 * Group Timestamp::       Making gnus keep track of when you last read a group.
3007 * File Commands::         Reading and writing the gnus files.
3008 @end menu
3009
3010 @table @kbd
3011
3012 @item ^
3013 @kindex ^ (Group)
3014 @findex gnus-group-enter-server-mode
3015 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3016 @xref{The Server Buffer}.
3017
3018 @item a
3019 @kindex a (Group)
3020 @findex gnus-group-post-news
3021 Post an article to a group (@code{gnus-group-post-news}).  If given a
3022 prefix, the current group name will be used as the default.
3023
3024 @item m
3025 @kindex m (Group)
3026 @findex gnus-group-mail
3027 Mail a message somewhere (@code{gnus-group-mail}).
3028
3029 @end table
3030
3031 Variables for the group buffer:
3032
3033 @table @code
3034
3035 @item gnus-group-mode-hook
3036 @vindex gnus-group-mode-hook
3037 is called after the group buffer has been
3038 created.
3039
3040 @item gnus-group-prepare-hook
3041 @vindex gnus-group-prepare-hook
3042 is called after the group buffer is
3043 generated.  It may be used to modify the buffer in some strange,
3044 unnatural way.
3045
3046 @item gnus-group-prepared-hook
3047 @vindex gnus-group-prepare-hook
3048 is called as the very last thing after the group buffer has been
3049 generated.  It may be used to move point around, for instance.
3050
3051 @item gnus-permanently-visible-groups
3052 @vindex gnus-permanently-visible-groups
3053 Groups matching this regexp will always be listed in the group buffer,
3054 whether they are empty or not.
3055
3056 @end table
3057
3058
3059 @node Scanning New Messages
3060 @subsection Scanning New Messages
3061 @cindex new messages
3062 @cindex scanning new news
3063
3064 @table @kbd
3065
3066 @item g
3067 @kindex g (Group)
3068 @findex gnus-group-get-new-news
3069 @c @icon{gnus-group-get-new-news}
3070 Check the server(s) for new articles.  If the numerical prefix is used,
3071 this command will check only groups of level @var{arg} and lower
3072 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
3073 command will force a total re-reading of the active file(s) from the
3074 backend(s).
3075
3076 @item M-g
3077 @kindex M-g (Group)
3078 @findex gnus-group-get-new-news-this-group
3079 @vindex gnus-goto-next-group-when-activating
3080 @c @icon{gnus-group-get-new-news-this-group}
3081 Check whether new articles have arrived in the current group
3082 (@code{gnus-group-get-new-news-this-group}).
3083 @code{gnus-goto-next-group-when-activating} says whether this command is
3084 to move point to the next group or not.  It is @code{t} by default.
3085
3086 @findex gnus-activate-all-groups
3087 @cindex activating groups
3088 @item C-c M-g
3089 @kindex C-c M-g (Group)
3090 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3091
3092 @item R
3093 @kindex R (Group)
3094 @cindex restarting
3095 @findex gnus-group-restart
3096 Restart gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3097 file(s), closes the connection to all servers, clears up all run-time
3098 gnus variables, and then starts gnus all over again.
3099
3100 @end table
3101
3102 @vindex gnus-get-new-news-hook
3103 @code{gnus-get-new-news-hook} is run just before checking for new news.
3104
3105 @vindex gnus-after-getting-new-news-hook
3106 @code{gnus-after-getting-new-news-hook} is run after checking for new
3107 news.
3108
3109
3110 @node Group Information
3111 @subsection Group Information
3112 @cindex group information
3113 @cindex information on groups
3114
3115 @table @kbd
3116
3117
3118 @item H f
3119 @kindex H f (Group)
3120 @findex gnus-group-fetch-faq
3121 @vindex gnus-group-faq-directory
3122 @cindex FAQ
3123 @cindex ange-ftp
3124 Try to fetch the FAQ for the current group
3125 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3126 @code{gnus-group-faq-directory}, which is usually a directory on a
3127 remote machine.  This variable can also be a list of directories.  In
3128 that case, giving a prefix to this command will allow you to choose
3129 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3130 for fetching the file.
3131
3132 If fetching from the first site is unsuccessful, gnus will attempt to go
3133 through @code{gnus-group-faq-directory} and try to open them one by one.
3134
3135 @item H d
3136 @itemx C-c C-d
3137 @c @icon{gnus-group-describe-group}
3138 @kindex H d (Group)
3139 @kindex C-c C-d (Group)
3140 @cindex describing groups
3141 @cindex group description
3142 @findex gnus-group-describe-group
3143 Describe the current group (@code{gnus-group-describe-group}).  If given
3144 a prefix, force Gnus to re-read the description from the server.
3145
3146 @item M-d
3147 @kindex M-d (Group)
3148 @findex gnus-group-describe-all-groups
3149 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3150 prefix, force gnus to re-read the description file from the server.
3151
3152 @item H v
3153 @itemx V
3154 @kindex V (Group)
3155 @kindex H v (Group)
3156 @cindex version
3157 @findex gnus-version
3158 Display current gnus version numbers (@code{gnus-version}).
3159
3160 @item ?
3161 @kindex ? (Group)
3162 @findex gnus-group-describe-briefly
3163 Give a very short help message (@code{gnus-group-describe-briefly}).
3164
3165 @item C-c C-i
3166 @kindex C-c C-i (Group)
3167 @cindex info
3168 @cindex manual
3169 @findex gnus-info-find-node
3170 Go to the gnus info node (@code{gnus-info-find-node}).
3171 @end table
3172
3173
3174 @node Group Timestamp
3175 @subsection Group Timestamp
3176 @cindex timestamps
3177 @cindex group timestamps
3178
3179 It can be convenient to let gnus keep track of when you last read a
3180 group.  To set the ball rolling, you should add
3181 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3182
3183 @lisp
3184 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3185 @end lisp
3186
3187 After doing this, each time you enter a group, it'll be recorded.
3188
3189 This information can be displayed in various ways---the easiest is to
3190 use the @samp{%d} spec in the group line format:
3191
3192 @lisp
3193 (setq gnus-group-line-format
3194       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3195 @end lisp
3196
3197 This will result in lines looking like:
3198
3199 @example
3200 *        0: mail.ding                                19961002T012943
3201          0: custom                                   19961002T012713
3202 @end example
3203
3204 As you can see, the date is displayed in compact ISO 8601 format.  This
3205 may be a bit too much, so to just display the date, you could say
3206 something like:
3207
3208 @lisp
3209 (setq gnus-group-line-format
3210       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3211 @end lisp
3212
3213
3214 @node File Commands
3215 @subsection File Commands
3216 @cindex file commands
3217
3218 @table @kbd
3219
3220 @item r
3221 @kindex r (Group)
3222 @findex gnus-group-read-init-file
3223 @vindex gnus-init-file
3224 @cindex reading init file
3225 Re-read the init file (@code{gnus-init-file}, which defaults to
3226 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3227
3228 @item s
3229 @kindex s (Group)
3230 @findex gnus-group-save-newsrc
3231 @cindex saving .newsrc
3232 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3233 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3234 file(s) whether Gnus thinks it is necessary or not.
3235
3236 @c @item Z
3237 @c @kindex Z (Group)
3238 @c @findex gnus-group-clear-dribble
3239 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3240
3241 @end table
3242
3243
3244 @node The Summary Buffer
3245 @chapter The Summary Buffer
3246 @cindex summary buffer
3247
3248 A line for each article is displayed in the summary buffer.  You can
3249 move around, read articles, post articles and reply to articles.
3250
3251 The most common way to a summary buffer is to select a group from the
3252 group buffer (@pxref{Selecting a Group}).
3253
3254 You can have as many summary buffers open as you wish.
3255
3256 @menu
3257 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3258 * Summary Maneuvering::         Moving around the summary buffer.
3259 * Choosing Articles::           Reading articles.
3260 * Paging the Article::          Scrolling the current article.
3261 * Reply Followup and Post::     Posting articles.
3262 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3263 * Marking Articles::            Marking articles as read, expirable, etc.
3264 * Limiting::                    You can limit the summary buffer.
3265 * Threading::                   How threads are made.
3266 * Sorting::                     How articles and threads are sorted.
3267 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3268 * Article Caching::             You may store articles in a cache.
3269 * Persistent Articles::         Making articles expiry-resistant.
3270 * Article Backlog::             Having already read articles hang around.
3271 * Saving Articles::             Ways of customizing article saving.
3272 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3273 * Article Treatment::           The article buffer can be mangled at will.
3274 * MIME Commands::               Doing MIMEy things with the articles.
3275 * Charsets::                    Character set issues.
3276 * Article Commands::            Doing various things with the article buffer.
3277 * Summary Sorting::             Sorting the summary buffer in various ways.
3278 * Finding the Parent::          No child support? Get the parent.
3279 * Alternative Approaches::      Reading using non-default summaries.
3280 * Tree Display::                A more visual display of threads.
3281 * Mail Group Commands::         Some commands can only be used in mail groups.
3282 * Various Summary Stuff::       What didn't fit anywhere else.
3283 * Exiting the Summary Buffer::  Returning to the Group buffer.
3284 * Crosspost Handling::          How crossposted articles are dealt with.
3285 * Duplicate Suppression::       An alternative when crosspost handling fails.
3286 @end menu
3287
3288
3289 @node Summary Buffer Format
3290 @section Summary Buffer Format
3291 @cindex summary buffer format
3292
3293 @iftex
3294 @iflatex
3295 \gnusfigure{The Summary Buffer}{180}{
3296 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3297 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3298 }
3299 @end iflatex
3300 @end iftex
3301
3302 @menu
3303 * Summary Buffer Lines::     You can specify how summary lines should look.
3304 * To From Newsgroups::       How to not display your own name.
3305 * Summary Buffer Mode Line:: You can say how the mode line should look.
3306 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3307 @end menu
3308
3309 @findex mail-extract-address-components
3310 @findex gnus-extract-address-components
3311 @vindex gnus-extract-address-components
3312 Gnus will use the value of the @code{gnus-extract-address-components}
3313 variable as a function for getting the name and address parts of a
3314 @code{From} header.  Three pre-defined functions exist:
3315 @code{gnus-extract-address-components}, which is the default, quite
3316 fast, and too simplistic solution;
3317 @code{mail-extract-address-components}, which works nicely, but is
3318 slower; and @code{std11-extract-address-components}, which works very
3319 nicely, but is slower.  The default function will return the wrong
3320 answer in 5% of the cases.  If this is unacceptable to you, use the
3321 other function instead:
3322
3323 @lisp
3324 (setq gnus-extract-address-components
3325       'mail-extract-address-components)
3326 @end lisp
3327
3328 @vindex gnus-summary-same-subject
3329 @code{gnus-summary-same-subject} is a string indicating that the current
3330 article has the same subject as the previous.  This string will be used
3331 with those specs that require it.  The default is @code{""}.
3332
3333
3334 @node Summary Buffer Lines
3335 @subsection Summary Buffer Lines
3336
3337 @vindex gnus-summary-line-format
3338 You can change the format of the lines in the summary buffer by changing
3339 the @code{gnus-summary-line-format} variable.  It works along the same
3340 lines as a normal @code{format} string, with some extensions
3341 (@pxref{Formatting Variables}).
3342
3343 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3344
3345 The following format specification characters are understood:
3346
3347 @table @samp
3348 @item N
3349 Article number.
3350 @item S
3351 Subject string.
3352 @item s
3353 Subject if the article is the root of the thread or the previous article
3354 had a different subject, @code{gnus-summary-same-subject} otherwise.
3355 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3356 @item F
3357 Full @code{From} header.
3358 @item n
3359 The name (from the @code{From} header).
3360 @item f
3361 The name, code @code{To} header or the @code{Newsgroups} header
3362 (@pxref{To From Newsgroups}).
3363 @item a
3364 The name (from the @code{From} header).  This differs from the @code{n}
3365 spec in that it uses the function designated by the
3366 @code{gnus-extract-address-components} variable, which is slower, but
3367 may be more thorough.
3368 @item A
3369 The address (from the @code{From} header).  This works the same way as
3370 the @code{a} spec.
3371 @item L
3372 Number of lines in the article.
3373 @item c
3374 Number of characters in the article.
3375 @item I
3376 Indentation based on thread level (@pxref{Customizing Threading}).
3377 @item T
3378 Nothing if the article is a root and lots of spaces if it isn't (it
3379 pushes everything after it off the screen).
3380 @item [
3381 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3382 for adopted articles (@pxref{Customizing Threading}).
3383 @item ]
3384 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3385 for adopted articles.
3386 @item >
3387 One space for each thread level.
3388 @item <
3389 Twenty minus thread level spaces.
3390 @item U
3391 Unread.
3392
3393 @item R
3394 This misleadingly named specifier is the @dfn{secondary mark}.  This
3395 mark will say whether the article has been replied to, has been cached,
3396 or has been saved.
3397
3398 @item i
3399 Score as a number (@pxref{Scoring}).
3400 @item z
3401 @vindex gnus-summary-zcore-fuzz
3402 Zcore, @samp{+} if above the default level and @samp{-} if below the
3403 default level.  If the difference between
3404 @code{gnus-summary-default-score} and the score is less than
3405 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3406 @item V
3407 Total thread score.
3408 @item x
3409 @code{Xref}.
3410 @item D
3411 @code{Date}.
3412 @item d
3413 The @code{Date} in @code{DD-MMM} format.
3414 @item o
3415 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3416 @item M
3417 @code{Message-ID}.
3418 @item r
3419 @code{References}.
3420 @item t
3421 Number of articles in the current sub-thread.  Using this spec will slow
3422 down summary buffer generation somewhat.
3423 @item e
3424 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3425 article has any children.
3426 @item P
3427 The line number.
3428 @item O
3429 Download mark.
3430 @item u
3431 User defined specifier.  The next character in the format string should
3432 be a letter.  Gnus will call the function
3433 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3434 following @samp{%u}.  The function will be passed the current header as
3435 argument.  The function should return a string, which will be inserted
3436 into the summary just like information from any other summary specifier.
3437 @end table
3438
3439 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3440 have to be handled with care.  For reasons of efficiency, gnus will
3441 compute what column these characters will end up in, and ``hard-code''
3442 that.  This means that it is invalid to have these specs after a
3443 variable-length spec.  Well, you might not be arrested, but your summary
3444 buffer will look strange, which is bad enough.
3445
3446 The smart choice is to have these specs as far to the left as possible.
3447 (Isn't that the case with everything, though?  But I digress.)
3448
3449 This restriction may disappear in later versions of gnus.
3450
3451
3452 @node To From Newsgroups
3453 @subsection To From Newsgroups
3454 @cindex To
3455 @cindex Newsgroups
3456
3457 In some groups (particularly in archive groups), the @code{From} header
3458 isn't very interesting, since all the articles there are written by
3459 you.  To display the information in the @code{To} or @code{Newsgroups}
3460 headers instead, you need to decide three things: What information to
3461 gather; where to display it; and when to display it.
3462
3463 @enumerate
3464 @item
3465 @vindex gnus-extra-headers
3466 The reading of extra header information is controlled by the
3467 @code{gnus-extra-headers}.  This is a list of header symbols.  For
3468 instance:
3469
3470 @lisp
3471 (setq gnus-extra-headers
3472       '(To Newsgroups X-Newsreader))
3473 @end lisp
3474
3475 This will result in Gnus trying to obtain these three headers, and
3476 storing it in header structures for later easy retrieval.
3477
3478 @item
3479 @findex gnus-extra-header
3480 The value of these extra headers can be accessed via the
3481 @code{gnus-extra-header} function.  Here's a format line spec that will
3482 access the @code{X-Newsreader} header:
3483
3484 @example
3485 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3486 @end example
3487
3488 @item
3489 @vindex gnus-ignored-from-addresses
3490 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3491 summary line spec returns the @code{To}, @code{Newsreader} or
3492 @code{From} header.  If this regexp matches the contents of the
3493 @code{From} header, the value of the @code{To} or @code{Newsreader}
3494 headers are used instead.
3495
3496 @end enumerate
3497
3498 @vindex nnmail-extra-headers
3499 A related variable is @code{nnmail-extra-headers}, which controls when
3500 to include extra headers when generating overview (@sc{nov}) files.  If
3501 you have old overview files, you should regenerate them after changing
3502 this variable.
3503
3504 @vindex gnus-summary-line-format
3505 You also have to instruct Gnus to display the data by changing the
3506 @code{%n} spec to the @code{%f} spec in the
3507 @code{gnus-summary-line-format} variable.
3508
3509 In summary, you'd typically do something like the following:
3510
3511 @lisp
3512 (setq gnus-extra-headers
3513       '(To Newsgroups))
3514 (setq nnmail-extra-headers gnus-extra-headers)
3515 (setq gnus-summary-line-format
3516       "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3517 (setq gnus-ignored-from-addresses
3518       "Your Name Here")
3519 @end lisp
3520
3521 Now, this is mostly useful for mail groups, where you have control over
3522 the @sc{nov} files that are created.  However, if you can persuade your
3523 nntp admin to add:
3524
3525 @example
3526 Newsgroups:full
3527 @end example
3528
3529 to the end of her @file{overview.fmt} file, then you can use that just
3530 as you would the extra headers from the mail groups.
3531
3532
3533 @node Summary Buffer Mode Line
3534 @subsection Summary Buffer Mode Line
3535
3536 @vindex gnus-summary-mode-line-format
3537 You can also change the format of the summary mode bar (@pxref{Mode Line
3538 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
3539 like.  The default is @samp{Gnus: %%b [%A] %Z}.
3540
3541 Here are the elements you can play with:
3542
3543 @table @samp
3544 @item G
3545 Group name.
3546 @item p
3547 Unprefixed group name.
3548 @item A
3549 Current article number.
3550 @item z
3551 Current article score.
3552 @item V
3553 Gnus version.
3554 @item U
3555 Number of unread articles in this group.
3556 @item e
3557 Number of unread articles in this group that aren't displayed in the
3558 summary buffer.
3559 @item Z
3560 A string with the number of unread and unselected articles represented
3561 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3562 articles, and just as @samp{<%U more>} if there are just unread articles
3563 and no unselected ones.
3564 @item g
3565 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3566 shortened to @samp{r.a.anime}.
3567 @item S
3568 Subject of the current article.
3569 @item u
3570 User-defined spec (@pxref{User-Defined Specs}).
3571 @item s
3572 Name of the current score file (@pxref{Scoring}).
3573 @item d
3574 Number of dormant articles (@pxref{Unread Articles}).
3575 @item t
3576 Number of ticked articles (@pxref{Unread Articles}).
3577 @item r
3578 Number of articles that have been marked as read in this session.
3579 @item E
3580 Number of articles expunged by the score files.
3581 @end table
3582
3583
3584 @node Summary Highlighting
3585 @subsection Summary Highlighting
3586
3587 @table @code
3588
3589 @item gnus-visual-mark-article-hook
3590 @vindex gnus-visual-mark-article-hook
3591 This hook is run after selecting an article.  It is meant to be used for
3592 highlighting the article in some way.  It is not run if
3593 @code{gnus-visual} is @code{nil}.
3594
3595 @item gnus-summary-update-hook
3596 @vindex gnus-summary-update-hook
3597 This hook is called when a summary line is changed.  It is not run if
3598 @code{gnus-visual} is @code{nil}.
3599
3600 @item gnus-summary-selected-face
3601 @vindex gnus-summary-selected-face
3602 This is the face (or @dfn{font} as some people call it) used to
3603 highlight the current article in the summary buffer.
3604
3605 @item gnus-summary-highlight
3606 @vindex gnus-summary-highlight
3607 Summary lines are highlighted according to this variable, which is a
3608 list where the elements are of the format @var{(FORM . FACE)}.  If you
3609 would, for instance, like ticked articles to be italic and high-scored
3610 articles to be bold, you could set this variable to something like
3611 @lisp
3612 (((eq mark gnus-ticked-mark) . italic)
3613  ((> score default) . bold))
3614 @end lisp
3615 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3616 @var{FACE} will be applied to the line.
3617 @end table
3618
3619
3620 @node Summary Maneuvering
3621 @section Summary Maneuvering
3622 @cindex summary movement
3623
3624 All the straight movement commands understand the numeric prefix and
3625 behave pretty much as you'd expect.
3626
3627 None of these commands select articles.
3628
3629 @table @kbd
3630 @item G M-n
3631 @itemx M-n
3632 @kindex M-n (Summary)
3633 @kindex G M-n (Summary)
3634 @findex gnus-summary-next-unread-subject
3635 Go to the next summary line of an unread article
3636 (@code{gnus-summary-next-unread-subject}).
3637
3638 @item G M-p
3639 @itemx M-p
3640 @kindex M-p (Summary)
3641 @kindex G M-p (Summary)
3642 @findex gnus-summary-prev-unread-subject
3643 Go to the previous summary line of an unread article
3644 (@code{gnus-summary-prev-unread-subject}).
3645
3646 @item G j
3647 @itemx j
3648 @kindex j (Summary)
3649 @kindex G j (Summary)
3650 @findex gnus-summary-goto-article
3651 Ask for an article number or @code{Message-ID}, and then go to that
3652 article (@code{gnus-summary-goto-article}).
3653
3654 @item G g
3655 @kindex G g (Summary)
3656 @findex gnus-summary-goto-subject
3657 Ask for an article number and then go to the summary line of that article
3658 without displaying the article (@code{gnus-summary-goto-subject}).
3659 @end table
3660
3661 If gnus asks you to press a key to confirm going to the next group, you
3662 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3663 buffer, searching for the next group to read without actually returning
3664 to the group buffer.
3665
3666 Variables related to summary movement:
3667
3668 @table @code
3669
3670 @vindex gnus-auto-select-next
3671 @item gnus-auto-select-next
3672 If you issue one of the movement commands (like @kbd{n}) and there are
3673 no more unread articles after the current one, gnus will offer to go to
3674 the next group.  If this variable is @code{t} and the next group is
3675 empty, gnus will exit summary mode and return to the group buffer.  If
3676 this variable is neither @code{t} nor @code{nil}, gnus will select the
3677 next group, no matter whether it has any unread articles or not.  As a
3678 special case, if this variable is @code{quietly}, gnus will select the
3679 next group without asking for confirmation.  If this variable is
3680 @code{almost-quietly}, the same will happen only if you are located on
3681 the last article in the group.  Finally, if this variable is
3682 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3683 without confirmation.  Also @pxref{Group Levels}.
3684
3685 @item gnus-auto-select-same
3686 @vindex gnus-auto-select-same
3687 If non-@code{nil}, all the movement commands will try to go to the next
3688 article with the same subject as the current.  (@dfn{Same} here might
3689 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3690 for details (@pxref{Customizing Threading}).)  If there are no more
3691 articles with the same subject, go to the first unread article.
3692
3693 This variable is not particularly useful if you use a threaded display.
3694
3695 @item gnus-summary-check-current
3696 @vindex gnus-summary-check-current
3697 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3698 to the next (or previous) article if the current article is unread.
3699 Instead, they will choose the current article.
3700
3701 @item gnus-auto-center-summary
3702 @vindex gnus-auto-center-summary
3703 If non-@code{nil}, gnus will keep the point in the summary buffer
3704 centered at all times.  This makes things quite tidy, but if you have a
3705 slow network connection, or simply do not like this un-Emacsism, you can
3706 set this variable to @code{nil} to get the normal Emacs scrolling
3707 action.  This will also inhibit horizontal re-centering of the summary
3708 buffer, which might make it more inconvenient to read extremely long
3709 threads.
3710
3711 This variable can also be a number.  In that case, center the window at
3712 the given number of lines from the top.
3713
3714 @end table
3715
3716
3717 @node Choosing Articles
3718 @section Choosing Articles
3719 @cindex selecting articles
3720
3721 @menu
3722 * Choosing Commands::        Commands for choosing articles.
3723 * Choosing Variables::       Variables that influence these commands.
3724 @end menu
3725
3726
3727 @node Choosing Commands
3728 @subsection Choosing Commands
3729
3730 None of the following movement commands understand the numeric prefix,
3731 and they all select and display an article.
3732
3733 @table @kbd
3734 @item SPACE
3735 @kindex SPACE (Summary)
3736 @findex gnus-summary-next-page
3737 Select the current article, or, if that one's read already, the next
3738 unread article (@code{gnus-summary-next-page}).
3739
3740 @item G n
3741 @itemx n
3742 @kindex n (Summary)
3743 @kindex G n (Summary)
3744 @findex gnus-summary-next-unread-article
3745 @c @icon{gnus-summary-next-unread}
3746 Go to next unread article (@code{gnus-summary-next-unread-article}).
3747
3748 @item G p
3749 @itemx p
3750 @kindex p (Summary)
3751 @findex gnus-summary-prev-unread-article
3752 @c @icon{gnus-summary-prev-unread}
3753 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3754
3755 @item G N
3756 @itemx N
3757 @kindex N (Summary)
3758 @kindex G N (Summary)
3759 @findex gnus-summary-next-article
3760 Go to the next article (@code{gnus-summary-next-article}).
3761
3762 @item G P
3763 @itemx P
3764 @kindex P (Summary)
3765 @kindex G P (Summary)
3766 @findex gnus-summary-prev-article
3767 Go to the previous article (@code{gnus-summary-prev-article}).
3768
3769 @item G C-n
3770 @kindex G C-n (Summary)
3771 @findex gnus-summary-next-same-subject
3772 Go to the next article with the same subject
3773 (@code{gnus-summary-next-same-subject}).
3774
3775 @item G C-p
3776 @kindex G C-p (Summary)
3777 @findex gnus-summary-prev-same-subject
3778 Go to the previous article with the same subject
3779 (@code{gnus-summary-prev-same-subject}).
3780
3781 @item G f
3782 @itemx .
3783 @kindex G f  (Summary)
3784 @kindex .  (Summary)
3785 @findex gnus-summary-first-unread-article
3786 Go to the first unread article
3787 (@code{gnus-summary-first-unread-article}).
3788
3789 @item G b
3790 @itemx ,
3791 @kindex G b (Summary)
3792 @kindex , (Summary)
3793 @findex gnus-summary-best-unread-article
3794 Go to the article with the highest score
3795 (@code{gnus-summary-best-unread-article}).
3796
3797 @item G l
3798 @itemx l
3799 @kindex l (Summary)
3800 @kindex G l (Summary)
3801 @findex gnus-summary-goto-last-article
3802 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3803
3804 @item G o
3805 @kindex G o (Summary)
3806 @findex gnus-summary-pop-article
3807 @cindex history
3808 @cindex article history
3809 Pop an article off the summary history and go to this article
3810 (@code{gnus-summary-pop-article}).  This command differs from the
3811 command above in that you can pop as many previous articles off the
3812 history as you like, while @kbd{l} toggles the two last read articles.
3813 For a somewhat related issue (if you use these commands a lot),
3814 @pxref{Article Backlog}.
3815 @end table
3816
3817
3818 @node Choosing Variables
3819 @subsection Choosing Variables
3820
3821 Some variables relevant for moving and selecting articles:
3822
3823 @table @code
3824 @item gnus-auto-extend-newsgroup
3825 @vindex gnus-auto-extend-newsgroup
3826 All the movement commands will try to go to the previous (or next)
3827 article, even if that article isn't displayed in the Summary buffer if
3828 this variable is non-@code{nil}.  Gnus will then fetch the article from
3829 the server and display it in the article buffer.
3830
3831 @item gnus-select-article-hook
3832 @vindex gnus-select-article-hook
3833 This hook is called whenever an article is selected.  By default it
3834 exposes any threads hidden under the selected article.
3835
3836 @item gnus-mark-article-hook
3837 @vindex gnus-mark-article-hook
3838 @findex gnus-summary-mark-unread-as-read
3839 @findex gnus-summary-mark-read-and-unread-as-read
3840 @findex gnus-unread-mark
3841 This hook is called whenever an article is selected.  It is intended to
3842 be used for marking articles as read.  The default value is
3843 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3844 mark of almost any article you read to @code{gnus-unread-mark}.  The
3845 only articles not affected by this function are ticked, dormant, and
3846 expirable articles.  If you'd instead like to just have unread articles
3847 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3848 instead.  It will leave marks like @code{gnus-low-score-mark},
3849 @code{gnus-del-mark} (and so on) alone.
3850
3851 @end table
3852
3853
3854 @node Paging the Article
3855 @section Scrolling the Article
3856 @cindex article scrolling
3857
3858 @table @kbd
3859
3860 @item SPACE
3861 @kindex SPACE (Summary)
3862 @findex gnus-summary-next-page
3863 Pressing @kbd{SPACE} will scroll the current article forward one page,
3864 or, if you have come to the end of the current article, will choose the
3865 next article (@code{gnus-summary-next-page}).
3866
3867 @item DEL
3868 @kindex DEL (Summary)
3869 @findex gnus-summary-prev-page
3870 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3871
3872 @item RET
3873 @kindex RET (Summary)
3874 @findex gnus-summary-scroll-up
3875 Scroll the current article one line forward
3876 (@code{gnus-summary-scroll-up}).
3877
3878 @item M-RET
3879 @kindex M-RET (Summary)
3880 @findex gnus-summary-scroll-down
3881 Scroll the current article one line backward
3882 (@code{gnus-summary-scroll-down}).
3883
3884 @item A g
3885 @itemx g
3886 @kindex A g (Summary)
3887 @kindex g (Summary)
3888 @findex gnus-summary-show-article
3889 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3890 given a prefix, fetch the current article, but don't run any of the
3891 article treatment functions.  This will give you a ``raw'' article, just
3892 the way it came from the server.
3893
3894 @item A <
3895 @itemx <
3896 @kindex < (Summary)
3897 @kindex A < (Summary)
3898 @findex gnus-summary-beginning-of-article
3899 Scroll to the beginning of the article
3900 (@code{gnus-summary-beginning-of-article}).
3901
3902 @item A >
3903 @itemx >
3904 @kindex > (Summary)
3905 @kindex A > (Summary)
3906 @findex gnus-summary-end-of-article
3907 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3908
3909 @item A s
3910 @itemx s
3911 @kindex A s (Summary)
3912 @kindex s (Summary)
3913 @findex gnus-summary-isearch-article
3914 Perform an isearch in the article buffer
3915 (@code{gnus-summary-isearch-article}).
3916
3917 @item h
3918 @kindex h (Summary)
3919 @findex gnus-summary-select-article-buffer
3920 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3921
3922 @end table
3923
3924
3925 @node Reply Followup and Post
3926 @section Reply, Followup and Post
3927
3928 @menu
3929 * Summary Mail Commands::            Sending mail.
3930 * Summary Post Commands::            Sending news.
3931 @end menu
3932
3933
3934 @node Summary Mail Commands
3935 @subsection Summary Mail Commands
3936 @cindex mail
3937 @cindex composing mail
3938
3939 Commands for composing a mail message:
3940
3941 @table @kbd
3942
3943 @item S r
3944 @itemx r
3945 @kindex S r (Summary)
3946 @kindex r (Summary)
3947 @findex gnus-summary-reply
3948 @c @icon{gnus-summary-mail-reply}
3949 @c @icon{gnus-summary-reply}
3950 Mail a reply to the author of the current article
3951 (@code{gnus-summary-reply}).
3952
3953 @item S R
3954 @itemx R
3955 @kindex R (Summary)
3956 @kindex S R (Summary)
3957 @findex gnus-summary-reply-with-original
3958 @c @icon{gnus-summary-reply-with-original}
3959 Mail a reply to the author of the current article and include the
3960 original message (@code{gnus-summary-reply-with-original}).  This
3961 command uses the process/prefix convention.
3962
3963 @item S w
3964 @kindex S w (Summary)
3965 @findex gnus-summary-wide-reply
3966 Mail a wide reply to the author of the current article
3967 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3968 goes out to all people listed in the @code{To}, @code{From} (or
3969 @code{Reply-to}) and @code{Cc} headers.
3970
3971 @item S W
3972 @kindex S W (Summary)
3973 @findex gnus-summary-wide-reply-with-original
3974 Mail a wide reply to the current article and include the original
3975 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
3976 the process/prefix convention.
3977
3978 @item S o m
3979 @kindex S o m (Summary)
3980 @findex gnus-summary-mail-forward
3981 @c @icon{gnus-summary-mail-forward}
3982 Forward the current article to some other person
3983 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3984 headers of the forwarded article.
3985
3986 @item S m
3987 @itemx m
3988 @kindex m (Summary)
3989 @kindex S m (Summary)
3990 @findex gnus-summary-mail-other-window
3991 @c @icon{gnus-summary-mail-originate}
3992 Send a mail to some other person
3993 (@code{gnus-summary-mail-other-window}).
3994
3995 @item S D b
3996 @kindex S D b (Summary)
3997 @findex gnus-summary-resend-bounced-mail
3998 @cindex bouncing mail
3999 If you have sent a mail, but the mail was bounced back to you for some
4000 reason (wrong address, transient failure), you can use this command to
4001 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
4002 will be popped into a mail buffer where you can edit the headers before
4003 sending the mail off again.  If you give a prefix to this command, and
4004 the bounced mail is a reply to some other mail, gnus will try to fetch
4005 that mail and display it for easy perusal of its headers.  This might
4006 very well fail, though.
4007
4008 @item S D r
4009 @kindex S D r (Summary)
4010 @findex gnus-summary-resend-message
4011 Not to be confused with the previous command,
4012 @code{gnus-summary-resend-message} will prompt you for an address to
4013 send the current message off to, and then send it to that place.  The
4014 headers of the message won't be altered---but lots of headers that say
4015 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
4016 means that you actually send a mail to someone that has a @code{To}
4017 header that (probably) points to yourself.  This will confuse people.
4018 So, natcherly you'll only do that if you're really eVIl.
4019
4020 This command is mainly used if you have several accounts and want to
4021 ship a mail to a different account of yours.  (If you're both
4022 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4023 to the @code{root} account, you may want to resend it to
4024 @code{postmaster}.  Ordnung muß sein!
4025
4026 This command understands the process/prefix convention
4027 (@pxref{Process/Prefix}).
4028
4029 @item S O m
4030 @kindex S O m (Summary)
4031 @findex gnus-uu-digest-mail-forward
4032 Digest the current series (@pxref{Decoding Articles}) and forward the
4033 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
4034 uses the process/prefix convention (@pxref{Process/Prefix}).
4035
4036 @item S M-c
4037 @kindex S M-c (Summary)
4038 @findex gnus-summary-mail-crosspost-complaint
4039 @cindex crossposting
4040 @cindex excessive crossposting
4041 Send a complaint about excessive crossposting to the author of the
4042 current article (@code{gnus-summary-mail-crosspost-complaint}).
4043
4044 @findex gnus-crosspost-complaint
4045 This command is provided as a way to fight back against the current
4046 crossposting pandemic that's sweeping Usenet.  It will compose a reply
4047 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
4048 command understands the process/prefix convention
4049 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4050
4051 @end table
4052
4053 Also @pxref{(message)Header Commands} for more information.
4054
4055
4056 @node Summary Post Commands
4057 @subsection Summary Post Commands
4058 @cindex post
4059 @cindex composing news
4060
4061 Commands for posting a news article:
4062
4063 @table @kbd
4064 @item S p
4065 @itemx a
4066 @kindex a (Summary)
4067 @kindex S p (Summary)
4068 @findex gnus-summary-post-news
4069 @c @icon{gnus-summary-post-news}
4070 Post an article to the current group
4071 (@code{gnus-summary-post-news}).
4072
4073 @item S f
4074 @itemx f
4075 @kindex f (Summary)
4076 @kindex S f (Summary)
4077 @findex gnus-summary-followup
4078 @c @icon{gnus-summary-followup}
4079 Post a followup to the current article (@code{gnus-summary-followup}).
4080
4081 @item S F
4082 @itemx F
4083 @kindex S F (Summary)
4084 @kindex F (Summary)
4085 @c @icon{gnus-summary-followup-with-original}
4086 @findex gnus-summary-followup-with-original
4087 Post a followup to the current article and include the original message
4088 (@code{gnus-summary-followup-with-original}).   This command uses the
4089 process/prefix convention.
4090
4091 @item S n
4092 @kindex S n (Summary)
4093 @findex gnus-summary-followup-to-mail
4094 Post a followup to the current article via news, even if you got the
4095 message through mail (@code{gnus-summary-followup-to-mail}).
4096
4097 @item S N
4098 @kindex S N (Summary)
4099 @findex gnus-summary-followup-to-mail-with-original
4100 Post a followup to the current article via news, even if you got the
4101 message through mail and include the original message
4102 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
4103 the process/prefix convention.
4104
4105 @item S o p
4106 @kindex S o p (Summary)
4107 @findex gnus-summary-post-forward
4108 Forward the current article to a newsgroup
4109 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
4110 headers of the forwarded article.
4111
4112 @item S O p
4113 @kindex S O p (Summary)
4114 @findex gnus-uu-digest-post-forward
4115 @cindex digests
4116 @cindex making digests
4117 Digest the current series and forward the result to a newsgroup
4118 (@code{gnus-uu-digest-mail-forward}).  This command uses the
4119 process/prefix convention.
4120
4121 @item S u
4122 @kindex S u (Summary)
4123 @findex gnus-uu-post-news
4124 @c @icon{gnus-uu-post-news}
4125 Uuencode a file, split it into parts, and post it as a series
4126 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4127 @end table
4128
4129 Also @pxref{(message)Header Commands} for more information.
4130
4131
4132 @node Canceling and Superseding
4133 @section Canceling Articles
4134 @cindex canceling articles
4135 @cindex superseding articles
4136
4137 Have you ever written something, and then decided that you really,
4138 really, really wish you hadn't posted that?
4139
4140 Well, you can't cancel mail, but you can cancel posts.
4141
4142 @findex gnus-summary-cancel-article
4143 @kindex C (Summary)
4144 @c @icon{gnus-summary-cancel-article}
4145 Find the article you wish to cancel (you can only cancel your own
4146 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
4147 c} (@code{gnus-summary-cancel-article}).  Your article will be
4148 canceled---machines all over the world will be deleting your article.
4149 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4150
4151 Be aware, however, that not all sites honor cancels, so your article may
4152 live on here and there, while most sites will delete the article in
4153 question.
4154
4155 Gnus will use the ``current'' select method when canceling.  If you
4156 want to use the standard posting method, use the @samp{a} symbolic
4157 prefix (@pxref{Symbolic Prefixes}).
4158
4159 If you discover that you have made some mistakes and want to do some
4160 corrections, you can post a @dfn{superseding} article that will replace
4161 your original article.
4162
4163 @findex gnus-summary-supersede-article
4164 @kindex S (Summary)
4165 Go to the original article and press @kbd{S s}
4166 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
4167 where you can edit the article all you want before sending it off the
4168 usual way.
4169
4170 The same goes for superseding as for canceling, only more so: Some
4171 sites do not honor superseding.  On those sites, it will appear that you
4172 have posted almost the same article twice.
4173
4174 If you have just posted the article, and change your mind right away,
4175 there is a trick you can use to cancel/supersede the article without
4176 waiting for the article to appear on your site first.  You simply return
4177 to the post buffer (which is called @code{*sent ...*}).  There you will
4178 find the article you just posted, with all the headers intact.  Change
4179 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4180 header by substituting one of those words for the word
4181 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
4182 you would do normally.  The previous article will be
4183 canceled/superseded.
4184
4185 Just remember, kids: There is no 'c' in 'supersede'.
4186
4187
4188 @node Marking Articles
4189 @section Marking Articles
4190 @cindex article marking
4191 @cindex article ticking
4192 @cindex marks
4193
4194 There are several marks you can set on an article.
4195
4196 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4197 neologism ohoy!) of the article.  Alphabetic marks generally mean
4198 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4199
4200 In addition, you also have marks that do not affect readedness.
4201
4202 @menu
4203 * Unread Articles::      Marks for unread articles.
4204 * Read Articles::        Marks for read articles.
4205 * Other Marks::          Marks that do not affect readedness.
4206 @end menu
4207
4208 @ifinfo
4209 There's a plethora of commands for manipulating these marks:
4210 @end ifinfo
4211
4212 @menu
4213 * Setting Marks::             How to set and remove marks.
4214 * Generic Marking Commands::  How to customize the marking.
4215 * Setting Process Marks::     How to mark articles for later processing.
4216 @end menu
4217
4218
4219 @node Unread Articles
4220 @subsection Unread Articles
4221
4222 The following marks mark articles as (kinda) unread, in one form or
4223 other.
4224
4225 @table @samp
4226 @item !
4227 @vindex gnus-ticked-mark
4228 Marked as ticked (@code{gnus-ticked-mark}).
4229
4230 @dfn{Ticked articles} are articles that will remain visible always.  If
4231 you see an article that you find interesting, or you want to put off
4232 reading it, or replying to it, until sometime later, you'd typically
4233 tick it.  However, articles can be expired, so if you want to keep an
4234 article forever, you'll have to make it persistent (@pxref{Persistent
4235 Articles}).
4236
4237 @item ?
4238 @vindex gnus-dormant-mark
4239 Marked as dormant (@code{gnus-dormant-mark}).
4240
4241 @dfn{Dormant articles} will only appear in the summary buffer if there
4242 are followups to it.  If you want to see them even if they don't have
4243 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4244
4245 @item SPACE
4246 @vindex gnus-unread-mark
4247 Marked as unread (@code{gnus-unread-mark}).
4248
4249 @dfn{Unread articles} are articles that haven't been read at all yet.
4250 @end table
4251
4252
4253 @node Read Articles
4254 @subsection Read Articles
4255 @cindex expirable mark
4256
4257 All the following marks mark articles as read.
4258
4259 @table @samp
4260
4261 @item r
4262 @vindex gnus-del-mark
4263 These are articles that the user has marked as read with the @kbd{d}
4264 command manually, more or less (@code{gnus-del-mark}).
4265
4266 @item R
4267 @vindex gnus-read-mark
4268 Articles that have actually been read (@code{gnus-read-mark}).
4269
4270 @item O
4271 @vindex gnus-ancient-mark
4272 Articles that were marked as read in previous sessions and are now
4273 @dfn{old} (@code{gnus-ancient-mark}).
4274
4275 @item K
4276 @vindex gnus-killed-mark
4277 Marked as killed (@code{gnus-killed-mark}).
4278
4279 @item X
4280 @vindex gnus-kill-file-mark
4281 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4282
4283 @item Y
4284 @vindex gnus-low-score-mark
4285 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4286
4287 @item C
4288 @vindex gnus-catchup-mark
4289 Marked as read by a catchup (@code{gnus-catchup-mark}).
4290
4291 @item G
4292 @vindex gnus-canceled-mark
4293 Canceled article (@code{gnus-canceled-mark})
4294
4295 @item F
4296 @vindex gnus-souped-mark
4297 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4298
4299 @item Q
4300 @vindex gnus-sparse-mark
4301 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4302 Threading}.
4303
4304 @item M
4305 @vindex gnus-duplicate-mark
4306 Article marked as read by duplicate suppression
4307 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4308
4309 @end table
4310
4311 All these marks just mean that the article is marked as read, really.
4312 They are interpreted differently when doing adaptive scoring, though.
4313
4314 One more special mark, though:
4315
4316 @table @samp
4317 @item E
4318 @vindex gnus-expirable-mark
4319 Marked as expirable (@code{gnus-expirable-mark}).
4320
4321 Marking articles as @dfn{expirable} (or have them marked as such
4322 automatically) doesn't make much sense in normal groups---a user doesn't
4323 control expiring of news articles, but in mail groups, for instance,
4324 articles marked as @dfn{expirable} can be deleted by gnus at
4325 any time.
4326 @end table
4327
4328
4329 @node Other Marks
4330 @subsection Other Marks
4331 @cindex process mark
4332 @cindex bookmarks
4333
4334 There are some marks that have nothing to do with whether the article is
4335 read or not.
4336
4337 @itemize @bullet
4338
4339 @item
4340 You can set a bookmark in the current article.  Say you are reading a
4341 long thesis on cats' urinary tracts, and have to go home for dinner
4342 before you've finished reading the thesis.  You can then set a bookmark
4343 in the article, and gnus will jump to this bookmark the next time it
4344 encounters the article.  @xref{Setting Marks}.
4345
4346 @item
4347 @vindex gnus-replied-mark
4348 All articles that you have replied to or made a followup to (i.e., have
4349 answered) will be marked with an @samp{A} in the second column
4350 (@code{gnus-replied-mark}).
4351
4352 @item
4353 @vindex gnus-cached-mark
4354 Articles stored in the article cache will be marked with an @samp{*} in
4355 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
4356
4357 @item
4358 @vindex gnus-saved-mark
4359 Articles ``saved'' (in some manner or other; not necessarily
4360 religiously) are marked with an @samp{S} in the second column
4361 (@code{gnus-saved-mark}).
4362
4363 @item
4364 @vindex gnus-not-empty-thread-mark
4365 @vindex gnus-empty-thread-mark
4366 If the @samp{%e} spec is used, the presence of threads or not will be
4367 marked with @code{gnus-not-empty-thread-mark} and
4368 @code{gnus-empty-thread-mark} in the third column, respectively.
4369
4370 @item
4371 @vindex gnus-process-mark
4372 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4373 variety of commands react to the presence of the process mark.  For
4374 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4375 all articles that have been marked with the process mark.  Articles
4376 marked with the process mark have a @samp{#} in the second column.
4377
4378 @end itemize
4379
4380 You might have noticed that most of these ``non-readedness'' marks
4381 appear in the second column by default.  So if you have a cached, saved,
4382 replied article that you have process-marked, what will that look like?
4383
4384 Nothing much.  The precedence rules go as follows: process -> cache ->
4385 replied -> saved.  So if the article is in the cache and is replied,
4386 you'll only see the cache mark and not the replied mark.
4387
4388
4389 @node Setting Marks
4390 @subsection Setting Marks
4391 @cindex setting marks
4392
4393 All the marking commands understand the numeric prefix.
4394
4395 @table @kbd
4396 @item M c
4397 @itemx M-u
4398 @kindex M c (Summary)
4399 @kindex M-u (Summary)
4400 @findex gnus-summary-clear-mark-forward
4401 @cindex mark as unread
4402 Clear all readedness-marks from the current article
4403 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
4404 article as unread.
4405
4406 @item M t
4407 @itemx !
4408 @kindex ! (Summary)
4409 @kindex M t (Summary)
4410 @findex gnus-summary-tick-article-forward
4411 Tick the current article (@code{gnus-summary-tick-article-forward}).
4412 @xref{Article Caching}.
4413
4414 @item M ?
4415 @itemx ?
4416 @kindex ? (Summary)
4417 @kindex M ? (Summary)
4418 @findex gnus-summary-mark-as-dormant
4419 Mark the current article as dormant
4420 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
4421
4422 @item M d
4423 @itemx d
4424 @kindex M d (Summary)
4425 @kindex d (Summary)
4426 @findex gnus-summary-mark-as-read-forward
4427 Mark the current article as read
4428 (@code{gnus-summary-mark-as-read-forward}).
4429
4430 @item D
4431 @kindex D (Summary)
4432 @findex gnus-summary-mark-as-read-backward
4433 Mark the current article as read and move point to the previous line
4434 (@code{gnus-summary-mark-as-read-backward}).
4435
4436 @item M k
4437 @itemx k
4438 @kindex k (Summary)
4439 @kindex M k (Summary)
4440 @findex gnus-summary-kill-same-subject-and-select
4441 Mark all articles that have the same subject as the current one as read,
4442 and then select the next unread article
4443 (@code{gnus-summary-kill-same-subject-and-select}).
4444
4445 @item M K
4446 @itemx C-k
4447 @kindex M K (Summary)
4448 @kindex C-k (Summary)
4449 @findex gnus-summary-kill-same-subject
4450 Mark all articles that have the same subject as the current one as read
4451 (@code{gnus-summary-kill-same-subject}).
4452
4453 @item M C
4454 @kindex M C (Summary)
4455 @findex gnus-summary-catchup
4456 @c @icon{gnus-summary-catchup}
4457 Mark all unread articles as read (@code{gnus-summary-catchup}).
4458
4459 @item M C-c
4460 @kindex M C-c (Summary)
4461 @findex gnus-summary-catchup-all
4462 Mark all articles in the group as read---even the ticked and dormant
4463 articles (@code{gnus-summary-catchup-all}).
4464
4465 @item M H
4466 @kindex M H (Summary)
4467 @findex gnus-summary-catchup-to-here
4468 Catchup the current group to point
4469 (@code{gnus-summary-catchup-to-here}).
4470
4471 @item C-w
4472 @kindex C-w (Summary)
4473 @findex gnus-summary-mark-region-as-read
4474 Mark all articles between point and mark as read
4475 (@code{gnus-summary-mark-region-as-read}).
4476
4477 @item M V k
4478 @kindex M V k (Summary)
4479 @findex gnus-summary-kill-below
4480 Kill all articles with scores below the default score (or below the
4481 numeric prefix) (@code{gnus-summary-kill-below}).
4482
4483 @item M e
4484 @itemx E
4485 @kindex M e (Summary)
4486 @kindex E (Summary)
4487 @findex gnus-summary-mark-as-expirable
4488 Mark the current article as expirable
4489 (@code{gnus-summary-mark-as-expirable}).
4490
4491 @item M b
4492 @kindex M b (Summary)
4493 @findex gnus-summary-set-bookmark
4494 Set a bookmark in the current article
4495 (@code{gnus-summary-set-bookmark}).
4496
4497 @item M B
4498 @kindex M B (Summary)
4499 @findex gnus-summary-remove-bookmark
4500 Remove the bookmark from the current article
4501 (@code{gnus-summary-remove-bookmark}).
4502
4503 @item M V c
4504 @kindex M V c (Summary)
4505 @findex gnus-summary-clear-above
4506 Clear all marks from articles with scores over the default score (or
4507 over the numeric prefix) (@code{gnus-summary-clear-above}).
4508
4509 @item M V u
4510 @kindex M V u (Summary)
4511 @findex gnus-summary-tick-above
4512 Tick all articles with scores over the default score (or over the
4513 numeric prefix) (@code{gnus-summary-tick-above}).
4514
4515 @item M V m
4516 @kindex M V m (Summary)
4517 @findex gnus-summary-mark-above
4518 Prompt for a mark, and mark all articles with scores over the default
4519 score (or over the numeric prefix) with this mark
4520 (@code{gnus-summary-clear-above}).
4521 @end table
4522
4523 @vindex gnus-summary-goto-unread
4524 The @code{gnus-summary-goto-unread} variable controls what action should
4525 be taken after setting a mark.  If non-@code{nil}, point will move to
4526 the next/previous unread article.  If @code{nil}, point will just move
4527 one line up or down.  As a special case, if this variable is
4528 @code{never}, all the marking commands as well as other commands (like
4529 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4530 The default is @code{t}.
4531
4532
4533 @node Generic Marking Commands
4534 @subsection Generic Marking Commands
4535
4536 Some people would like the command that ticks an article (@kbd{!}) go to
4537 the next article.  Others would like it to go to the next unread
4538 article.  Yet others would like it to stay on the current article.  And
4539 even though I haven't heard of anybody wanting it to go the the
4540 previous (unread) article, I'm sure there are people that want that as
4541 well.
4542
4543 Multiply these five behaviours with five different marking commands, and
4544 you get a potentially complex set of variable to control what each
4545 command should do.
4546
4547 To sidestep that mess, Gnus provides commands that do all these
4548 different things.  They can be found on the @kbd{M M} map in the summary
4549 buffer.  Type @kbd{M M C-h} to see them all---there are too many of them
4550 to list in this manual.
4551
4552 While you can use these commands directly, most users would prefer
4553 altering the summary mode keymap.  For instance, if you would like the
4554 @kbd{!} command to go the the next article instead of the next unread
4555 article, you could say something like:
4556
4557 @lisp
4558 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
4559 (defun my-alter-summary-map ()
4560   (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
4561 @end lisp
4562
4563 or
4564
4565 @lisp
4566 (defun my-alter-summary-map ()
4567   (local-set-key "!" "MM!n"))
4568 @end lisp
4569
4570
4571 @node Setting Process Marks
4572 @subsection Setting Process Marks
4573 @cindex setting process marks
4574
4575 @table @kbd
4576
4577 @item M P p
4578 @itemx #
4579 @kindex # (Summary)
4580 @kindex M P p (Summary)
4581 @findex gnus-summary-mark-as-processable
4582 Mark the current article with the process mark
4583 (@code{gnus-summary-mark-as-processable}).
4584 @findex gnus-summary-unmark-as-processable
4585
4586 @item M P u
4587 @itemx M-#
4588 @kindex M P u (Summary)
4589 @kindex M-# (Summary)
4590 Remove the process mark, if any, from the current article
4591 (@code{gnus-summary-unmark-as-processable}).
4592
4593 @item M P U
4594 @kindex M P U (Summary)
4595 @findex gnus-summary-unmark-all-processable
4596 Remove the process mark from all articles
4597 (@code{gnus-summary-unmark-all-processable}).
4598
4599 @item M P i
4600 @kindex M P i (Summary)
4601 @findex gnus-uu-invert-processable
4602 Invert the list of process marked articles
4603 (@code{gnus-uu-invert-processable}).
4604
4605 @item M P R
4606 @kindex M P R (Summary)
4607 @findex gnus-uu-mark-by-regexp
4608 Mark articles that have a @code{Subject} header that matches a regular
4609 expression (@code{gnus-uu-mark-by-regexp}).
4610
4611 @item M P r
4612 @kindex M P r (Summary)
4613 @findex gnus-uu-mark-region
4614 Mark articles in region (@code{gnus-uu-mark-region}).
4615
4616 @item M P t
4617 @kindex M P t (Summary)
4618 @findex gnus-uu-mark-thread
4619 Mark all articles in the current (sub)thread
4620 (@code{gnus-uu-mark-thread}).
4621
4622 @item M P T
4623 @kindex M P T (Summary)
4624 @findex gnus-uu-unmark-thread
4625 Unmark all articles in the current (sub)thread
4626 (@code{gnus-uu-unmark-thread}).
4627
4628 @item M P v
4629 @kindex M P v (Summary)
4630 @findex gnus-uu-mark-over
4631 Mark all articles that have a score above the prefix argument
4632 (@code{gnus-uu-mark-over}).
4633
4634 @item M P s
4635 @kindex M P s (Summary)
4636 @findex gnus-uu-mark-series
4637 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4638
4639 @item M P S
4640 @kindex M P S (Summary)
4641 @findex gnus-uu-mark-sparse
4642 Mark all series that have already had some articles marked
4643 (@code{gnus-uu-mark-sparse}).
4644
4645 @item M P a
4646 @kindex M P a (Summary)
4647 @findex gnus-uu-mark-all
4648 Mark all articles in series order (@code{gnus-uu-mark-series}).
4649
4650 @item M P b
4651 @kindex M P b (Summary)
4652 @findex gnus-uu-mark-buffer
4653 Mark all articles in the buffer in the order they appear
4654 (@code{gnus-uu-mark-buffer}).
4655
4656 @item M P k
4657 @kindex M P k (Summary)
4658 @findex gnus-summary-kill-process-mark
4659 Push the current process mark set onto the stack and unmark all articles
4660 (@code{gnus-summary-kill-process-mark}).
4661
4662 @item M P y
4663 @kindex M P y (Summary)
4664 @findex gnus-summary-yank-process-mark
4665 Pop the previous process mark set from the stack and restore it
4666 (@code{gnus-summary-yank-process-mark}).
4667
4668 @item M P w
4669 @kindex M P w (Summary)
4670 @findex gnus-summary-save-process-mark
4671 Push the current process mark set onto the stack
4672 (@code{gnus-summary-save-process-mark}).
4673
4674 @end table
4675
4676
4677 @node Limiting
4678 @section Limiting
4679 @cindex limiting
4680
4681 It can be convenient to limit the summary buffer to just show some
4682 subset of the articles currently in the group.  The effect most limit
4683 commands have is to remove a few (or many) articles from the summary
4684 buffer.
4685
4686 All limiting commands work on subsets of the articles already fetched
4687 from the servers.  None of these commands query the server for
4688 additional articles.
4689
4690 @table @kbd
4691
4692 @item / /
4693 @itemx / s
4694 @kindex / / (Summary)
4695 @findex gnus-summary-limit-to-subject
4696 Limit the summary buffer to articles that match some subject
4697 (@code{gnus-summary-limit-to-subject}).
4698
4699 @item / a
4700 @kindex / a (Summary)
4701 @findex gnus-summary-limit-to-author
4702 Limit the summary buffer to articles that match some author
4703 (@code{gnus-summary-limit-to-author}).
4704
4705 @item / x
4706 @kindex / x (Summary)
4707 @findex gnus-summary-limit-to-extra
4708 Limit the summary buffer to articles that match one of the ``extra''
4709 headers (@pxref{To From Newsgroups})
4710 (@code{gnus-summary-limit-to-author}).
4711
4712 @item / u
4713 @itemx x
4714 @kindex / u (Summary)
4715 @kindex x (Summary)
4716 @findex gnus-summary-limit-to-unread
4717 Limit the summary buffer to articles not marked as read
4718 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4719 buffer to articles strictly unread.  This means that ticked and
4720 dormant articles will also be excluded.
4721
4722 @item / m
4723 @kindex / m (Summary)
4724 @findex gnus-summary-limit-to-marks
4725 Ask for a mark and then limit to all articles that have been marked
4726 with that mark (@code{gnus-summary-limit-to-marks}).
4727
4728 @item / t
4729 @kindex / t (Summary)
4730 @findex gnus-summary-limit-to-age
4731 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4732 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4733 articles younger than that number of days.
4734
4735 @item / n
4736 @kindex / n (Summary)
4737 @findex gnus-summary-limit-to-articles
4738 Limit the summary buffer to the current article
4739 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4740 convention (@pxref{Process/Prefix}).
4741
4742 @item / w
4743 @kindex / w (Summary)
4744 @findex gnus-summary-pop-limit
4745 Pop the previous limit off the stack and restore it
4746 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4747 the stack.
4748
4749 @item / v
4750 @kindex / v (Summary)
4751 @findex gnus-summary-limit-to-score
4752 Limit the summary buffer to articles that have a score at or above some
4753 score (@code{gnus-summary-limit-to-score}).
4754
4755 @item / E
4756 @itemx M S
4757 @kindex M S (Summary)
4758 @kindex / E (Summary)
4759 @findex gnus-summary-limit-include-expunged
4760 Include all expunged articles in the limit
4761 (@code{gnus-summary-limit-include-expunged}).
4762
4763 @item / D
4764 @kindex / D (Summary)
4765 @findex gnus-summary-limit-include-dormant
4766 Include all dormant articles in the limit
4767 (@code{gnus-summary-limit-include-dormant}).
4768
4769 @item / *
4770 @kindex / * (Summary)
4771 @findex gnus-summary-limit-include-cached
4772 Include all cached articles in the limit
4773 (@code{gnus-summary-limit-include-cached}).
4774
4775 @item / d
4776 @kindex / d (Summary)
4777 @findex gnus-summary-limit-exclude-dormant
4778 Exclude all dormant articles from the limit
4779 (@code{gnus-summary-limit-exclude-dormant}).
4780
4781 @item / M
4782 @kindex / M (Summary)
4783 @findex gnus-summary-limit-exclude-marks
4784 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
4785
4786 @item / T
4787 @kindex / T (Summary)
4788 @findex gnus-summary-limit-include-thread
4789 Include all the articles in the current thread in the limit.
4790
4791 @item / c
4792 @kindex / c (Summary)
4793 @findex gnus-summary-limit-exclude-childless-dormant
4794 Exclude all dormant articles that have no children from the limit
4795 (@code{gnus-summary-limit-exclude-childless-dormant}).
4796
4797 @item / C
4798 @kindex / C (Summary)
4799 @findex gnus-summary-limit-mark-excluded-as-read
4800 Mark all excluded unread articles as read
4801 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4802 also mark excluded ticked and dormant articles as read.
4803
4804 @end table
4805
4806
4807 @node Threading
4808 @section Threading
4809 @cindex threading
4810 @cindex article threading
4811
4812 Gnus threads articles by default.  @dfn{To thread} is to put responses
4813 to articles directly after the articles they respond to---in a
4814 hierarchical fashion.
4815
4816 Threading is done by looking at the @code{References} headers of the
4817 articles.  In a perfect world, this would be enough to build pretty
4818 trees, but unfortunately, the @code{References} header is often broken
4819 or simply missing.  Weird news propagation excarcerbates the problem,
4820 so one has to employ other heuristics to get pleasing results.  A
4821 plethora of approaches exists, as detailed in horrible detail in
4822 @pxref{Customizing Threading}.
4823
4824 First, a quick overview of the concepts:
4825
4826 @table @dfn
4827 @item root
4828 The top-most article in a thread; the first article in the thread.
4829
4830 @item thread
4831 A tree-like article structure.
4832
4833 @item sub-thread
4834 A small(er) section of this tree-like structure.
4835
4836 @item loose threads
4837 Threads often lose their roots due to article expiry, or due to the root
4838 already having been read in a previous session, and not displayed in the
4839 summary buffer.  We then typically have many sub-threads that really
4840 belong to one thread, but are without connecting roots.  These are
4841 called loose threads.
4842
4843 @item thread gathering
4844 An attempt to gather loose threads into bigger threads.
4845
4846 @item sparse threads
4847 A thread where the missing articles have been ``guessed'' at, and are
4848 displayed as empty lines in the summary buffer.
4849
4850 @end table
4851
4852
4853 @menu
4854 * Customizing Threading::     Variables you can change to affect the threading.
4855 * Thread Commands::           Thread based commands in the summary buffer.
4856 @end menu
4857
4858
4859 @node Customizing Threading
4860 @subsection Customizing Threading
4861 @cindex customizing threading
4862
4863 @menu
4864 * Loose Threads::        How gnus gathers loose threads into bigger threads.
4865 * Filling In Threads::   Making the threads displayed look fuller.
4866 * More Threading::       Even more variables for fiddling with threads.
4867 * Low-Level Threading::  You thought it was over... but you were wrong!
4868 @end menu
4869
4870
4871 @node Loose Threads
4872 @subsubsection Loose Threads
4873 @cindex <
4874 @cindex >
4875 @cindex loose threads
4876
4877 @table @code
4878 @item gnus-summary-make-false-root
4879 @vindex gnus-summary-make-false-root
4880 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
4881 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4882 Yup.)  Loose subtrees occur when the real root has expired, or you've
4883 read or killed the root in a previous session.
4884
4885 When there is no real root of a thread, gnus will have to fudge
4886 something.  This variable says what fudging method gnus should use.
4887 There are four possible values:
4888
4889 @iftex
4890 @iflatex
4891 \gnusfigure{The Summary Buffer}{390}{
4892 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4893 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4894 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4895 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4896 }
4897 @end iflatex
4898 @end iftex
4899
4900 @cindex adopting articles
4901
4902 @table @code
4903
4904 @item adopt
4905 Gnus will make the first of the orphaned articles the parent.  This
4906 parent will adopt all the other articles.  The adopted articles will be
4907 marked as such by pointy brackets (@samp{<>}) instead of the standard
4908 square brackets (@samp{[]}).  This is the default method.
4909
4910 @item dummy
4911 @vindex gnus-summary-dummy-line-format
4912 Gnus will create a dummy summary line that will pretend to be the
4913 parent.  This dummy line does not correspond to any real article, so
4914 selecting it will just select the first real article after the dummy
4915 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4916 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4917 which is the subject of the article.  @xref{Formatting Variables}.
4918
4919 @item empty
4920 Gnus won't actually make any article the parent, but simply leave the
4921 subject field of all orphans except the first empty.  (Actually, it will
4922 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4923 Buffer Format}).)
4924
4925 @item none
4926 Don't make any article parent at all.  Just gather the threads and
4927 display them after one another.
4928
4929 @item nil
4930 Don't gather loose threads.
4931 @end table
4932
4933 @item gnus-summary-gather-subject-limit
4934 @vindex gnus-summary-gather-subject-limit
4935 Loose threads are gathered by comparing subjects of articles.  If this
4936 variable is @code{nil}, gnus requires an exact match between the
4937 subjects of the loose threads before gathering them into one big
4938 super-thread.  This might be too strict a requirement, what with the
4939 presence of stupid newsreaders that chop off long subject lines.  If
4940 you think so, set this variable to, say, 20 to require that only the
4941 first 20 characters of the subjects have to match.  If you set this
4942 variable to a really low number, you'll find that gnus will gather
4943 everything in sight into one thread, which isn't very helpful.
4944
4945 @cindex fuzzy article gathering
4946 If you set this variable to the special value @code{fuzzy}, gnus will
4947 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4948 Matching}).
4949
4950 @item gnus-simplify-subject-fuzzy-regexp
4951 @vindex gnus-simplify-subject-fuzzy-regexp
4952 This can either be a regular expression or list of regular expressions
4953 that match strings that will be removed from subjects if fuzzy subject
4954 simplification is used.
4955
4956 @item gnus-simplify-ignored-prefixes
4957 @vindex gnus-simplify-ignored-prefixes
4958 If you set @code{gnus-summary-gather-subject-limit} to something as low
4959 as 10, you might consider setting this variable to something sensible:
4960
4961 @c Written by Michael Ernst <mernst@cs.rice.edu>
4962 @lisp
4963 (setq gnus-simplify-ignored-prefixes
4964       (concat
4965        "\\`\\[?\\("
4966        (mapconcat
4967         'identity
4968         '("looking"
4969           "wanted" "followup" "summary\\( of\\)?"
4970           "help" "query" "problem" "question"
4971           "answer" "reference" "announce"
4972           "How can I" "How to" "Comparison of"
4973           ;; ...
4974           )
4975         "\\|")
4976        "\\)\\s *\\("
4977        (mapconcat 'identity
4978                   '("for" "for reference" "with" "about")
4979                   "\\|")
4980        "\\)?\\]?:?[ \t]*"))
4981 @end lisp
4982
4983 All words that match this regexp will be removed before comparing two
4984 subjects.
4985
4986 @item gnus-simplify-subject-functions
4987 @vindex gnus-simplify-subject-functions
4988 If non-@code{nil}, this variable overrides
4989 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4990 list of functions to apply to the @code{Subject} string iteratively to
4991 arrive at the simplified version of the string.
4992
4993 Useful functions to put in this list include:
4994
4995 @table @code
4996 @item gnus-simplify-subject-re
4997 @findex gnus-simplify-subject-re
4998 Strip the leading @samp{Re:}.
4999
5000 @item gnus-simplify-subject-fuzzy
5001 @findex gnus-simplify-subject-fuzzy
5002 Simplify fuzzily.
5003
5004 @item gnus-simplify-whitespace
5005 @findex gnus-simplify-whitespace
5006 Remove excessive whitespace.
5007 @end table
5008
5009 You may also write your own functions, of course.
5010
5011
5012 @item gnus-summary-gather-exclude-subject
5013 @vindex gnus-summary-gather-exclude-subject
5014 Since loose thread gathering is done on subjects only, that might lead
5015 to many false hits, especially with certain common subjects like
5016 @samp{} and @samp{(none)}.  To make the situation slightly better,
5017 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5018 what subjects should be excluded from the gathering process.@*
5019 The default is @samp{^ *$\\|^(none)$}.
5020
5021 @item gnus-summary-thread-gathering-function
5022 @vindex gnus-summary-thread-gathering-function
5023 Gnus gathers threads by looking at @code{Subject} headers.  This means
5024 that totally unrelated articles may end up in the same ``thread'', which
5025 is confusing.  An alternate approach is to look at all the
5026 @code{Message-ID}s in all the @code{References} headers to find matches.
5027 This will ensure that no gathered threads ever include unrelated
5028 articles, but it also means that people who have posted with broken
5029 newsreaders won't be gathered properly.  The choice is yours---plague or
5030 cholera:
5031
5032 @table @code
5033 @item gnus-gather-threads-by-subject
5034 @findex gnus-gather-threads-by-subject
5035 This function is the default gathering function and looks at
5036 @code{Subject}s exclusively.
5037
5038 @item gnus-gather-threads-by-references
5039 @findex gnus-gather-threads-by-references
5040 This function looks at @code{References} headers exclusively.
5041 @end table
5042
5043 If you want to test gathering by @code{References}, you could say
5044 something like:
5045
5046 @lisp
5047 (setq gnus-summary-thread-gathering-function
5048       'gnus-gather-threads-by-references)
5049 @end lisp
5050
5051 @end table
5052
5053
5054 @node Filling In Threads
5055 @subsubsection Filling In Threads
5056
5057 @table @code
5058 @item gnus-fetch-old-headers
5059 @vindex gnus-fetch-old-headers
5060 If non-@code{nil}, gnus will attempt to build old threads by fetching
5061 more old headers---headers to articles marked as read.  If you
5062 would like to display as few summary lines as possible, but still
5063 connect as many loose threads as possible, you should set this variable
5064 to @code{some} or a number.  If you set it to a number, no more than
5065 that number of extra old headers will be fetched.  In either case,
5066 fetching old headers only works if the backend you are using carries
5067 overview files---this would normally be @code{nntp}, @code{nnspool} and
5068 @code{nnml}.  Also remember that if the root of the thread has been
5069 expired by the server, there's not much gnus can do about that.
5070
5071 This variable can also be set to @code{invisible}.  This won't have any
5072 visible effects, but is useful if you use the @kbd{A T} command a lot
5073 (@pxref{Finding the Parent}).
5074
5075 @item gnus-build-sparse-threads
5076 @vindex gnus-build-sparse-threads
5077 Fetching old headers can be slow.  A low-rent similar effect can be
5078 gotten by setting this variable to @code{some}.  Gnus will then look at
5079 the complete @code{References} headers of all articles and try to string
5080 together articles that belong in the same thread.  This will leave
5081 @dfn{gaps} in the threading display where gnus guesses that an article
5082 is missing from the thread.  (These gaps appear like normal summary
5083 lines.  If you select a gap, gnus will try to fetch the article in
5084 question.)  If this variable is @code{t}, gnus will display all these
5085 ``gaps'' without regard for whether they are useful for completing the
5086 thread or not.  Finally, if this variable is @code{more}, gnus won't cut
5087 off sparse leaf nodes that don't lead anywhere.  This variable is
5088 @code{nil} by default.
5089
5090 @end table
5091
5092
5093 @node More Threading
5094 @subsubsection More Threading
5095
5096 @table @code
5097 @item gnus-show-threads
5098 @vindex gnus-show-threads
5099 If this variable is @code{nil}, no threading will be done, and all of
5100 the rest of the variables here will have no effect.  Turning threading
5101 off will speed group selection up a bit, but it is sure to make reading
5102 slower and more awkward.
5103
5104 @item gnus-thread-hide-subtree
5105 @vindex gnus-thread-hide-subtree
5106 If non-@code{nil}, all threads will be hidden when the summary buffer is
5107 generated.
5108
5109 @item gnus-thread-expunge-below
5110 @vindex gnus-thread-expunge-below
5111 All threads that have a total score (as defined by
5112 @code{gnus-thread-score-function}) less than this number will be
5113 expunged.  This variable is @code{nil} by default, which means that no
5114 threads are expunged.
5115
5116 @item gnus-thread-hide-killed
5117 @vindex gnus-thread-hide-killed
5118 if you kill a thread and this variable is non-@code{nil}, the subtree
5119 will be hidden.
5120
5121 @item gnus-thread-ignore-subject
5122 @vindex gnus-thread-ignore-subject
5123 Sometimes somebody changes the subject in the middle of a thread.  If
5124 this variable is non-@code{nil}, the subject change is ignored.  If it
5125 is @code{nil}, which is the default, a change in the subject will result
5126 in a new thread.
5127
5128 @item gnus-thread-indent-level
5129 @vindex gnus-thread-indent-level
5130 This is a number that says how much each sub-thread should be indented.
5131 The default is 4.
5132
5133 @end table
5134
5135
5136 @node Low-Level Threading
5137 @subsubsection Low-Level Threading
5138
5139 @table @code
5140
5141 @item gnus-parse-headers-hook
5142 @vindex gnus-parse-headers-hook
5143 Hook run before parsing any headers.  The default value is
5144 @code{(gnus-set-summary-default-charset)}, which sets up local value of
5145 @code{default-mime-charset} in summary buffer based on variable
5146 @code{gnus-newsgroup-default-charset-alist}.
5147
5148 @item gnus-alter-header-function
5149 @vindex gnus-alter-header-function
5150 If non-@code{nil}, this function will be called to allow alteration of
5151 article header structures.  The function is called with one parameter,
5152 the article header vector, which it may alter in any way.  For instance,
5153 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5154 in systematic ways (by adding prefixes and such), you can use this
5155 variable to un-scramble the @code{Message-ID}s so that they are more
5156 meaningful.  Here's one example:
5157
5158 @lisp
5159 (setq gnus-alter-header-function 'my-alter-message-id)
5160
5161 (defun my-alter-message-id (header)
5162   (let ((id (mail-header-id header)))
5163     (when (string-match
5164            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5165       (mail-header-set-id
5166        (concat (match-string 1 id) "@@" (match-string 2 id))
5167        header))))
5168 @end lisp
5169
5170 @end table
5171
5172
5173 @node Thread Commands
5174 @subsection Thread Commands
5175 @cindex thread commands
5176
5177 @table @kbd
5178
5179 @item T k
5180 @itemx M-C-k
5181 @kindex T k (Summary)
5182 @kindex M-C-k (Summary)
5183 @findex gnus-summary-kill-thread
5184 Mark all articles in the current (sub-)thread as read
5185 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
5186 remove all marks instead.  If the prefix argument is negative, tick
5187 articles instead.
5188
5189 @item T l
5190 @itemx M-C-l
5191 @kindex T l (Summary)
5192 @kindex M-C-l (Summary)
5193 @findex gnus-summary-lower-thread
5194 Lower the score of the current (sub-)thread
5195 (@code{gnus-summary-lower-thread}).
5196
5197 @item T i
5198 @kindex T i (Summary)
5199 @findex gnus-summary-raise-thread
5200 Increase the score of the current (sub-)thread
5201 (@code{gnus-summary-raise-thread}).
5202
5203 @item T #
5204 @kindex T # (Summary)
5205 @findex gnus-uu-mark-thread
5206 Set the process mark on the current (sub-)thread
5207 (@code{gnus-uu-mark-thread}).
5208
5209 @item T M-#
5210 @kindex T M-# (Summary)
5211 @findex gnus-uu-unmark-thread
5212 Remove the process mark from the current (sub-)thread
5213 (@code{gnus-uu-unmark-thread}).
5214
5215 @item T T
5216 @kindex T T (Summary)
5217 @findex gnus-summary-toggle-threads
5218 Toggle threading (@code{gnus-summary-toggle-threads}).
5219
5220 @item T s
5221 @kindex T s (Summary)
5222 @findex gnus-summary-show-thread
5223 Expose the (sub-)thread hidden under the current article, if any
5224 (@code{gnus-summary-show-thread}).
5225
5226 @item T h
5227 @kindex T h (Summary)
5228 @findex gnus-summary-hide-thread
5229 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5230
5231 @item T S
5232 @kindex T S (Summary)
5233 @findex gnus-summary-show-all-threads
5234 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5235
5236 @item T H
5237 @kindex T H (Summary)
5238 @findex gnus-summary-hide-all-threads
5239 Hide all threads (@code{gnus-summary-hide-all-threads}).
5240
5241 @item T t
5242 @kindex T t (Summary)
5243 @findex gnus-summary-rethread-current
5244 Re-thread the current article's thread
5245 (@code{gnus-summary-rethread-current}).  This works even when the
5246 summary buffer is otherwise unthreaded.
5247
5248 @item T ^
5249 @kindex T ^ (Summary)
5250 @findex gnus-summary-reparent-thread
5251 Make the current article the child of the marked (or previous) article
5252 (@code{gnus-summary-reparent-thread}).
5253
5254 @end table
5255
5256 The following commands are thread movement commands.  They all
5257 understand the numeric prefix.
5258
5259 @table @kbd
5260
5261 @item T n
5262 @kindex T n (Summary)
5263 @findex gnus-summary-next-thread
5264 Go to the next thread (@code{gnus-summary-next-thread}).
5265
5266 @item T p
5267 @kindex T p (Summary)
5268 @findex gnus-summary-prev-thread
5269 Go to the previous thread (@code{gnus-summary-prev-thread}).
5270
5271 @item T d
5272 @kindex T d (Summary)
5273 @findex gnus-summary-down-thread
5274 Descend the thread (@code{gnus-summary-down-thread}).
5275
5276 @item T u
5277 @kindex T u (Summary)
5278 @findex gnus-summary-up-thread
5279 Ascend the thread (@code{gnus-summary-up-thread}).
5280
5281 @item T o
5282 @kindex T o (Summary)
5283 @findex gnus-summary-top-thread
5284 Go to the top of the thread (@code{gnus-summary-top-thread}).
5285 @end table
5286
5287 @vindex gnus-thread-operation-ignore-subject
5288 If you ignore subject while threading, you'll naturally end up with
5289 threads that have several different subjects in them.  If you then issue
5290 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5291 wish to kill the entire thread, but just those parts of the thread that
5292 have the same subject as the current article.  If you like this idea,
5293 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
5294 is non-@code{nil} (which it is by default), subjects will be ignored
5295 when doing thread commands.  If this variable is @code{nil}, articles in
5296 the same thread with different subjects will not be included in the
5297 operation in question.  If this variable is @code{fuzzy}, only articles
5298 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5299 Matching}).
5300
5301
5302 @node Sorting
5303 @section Sorting
5304
5305 @findex gnus-thread-sort-by-total-score
5306 @findex gnus-thread-sort-by-date
5307 @findex gnus-thread-sort-by-score
5308 @findex gnus-thread-sort-by-subject
5309 @findex gnus-thread-sort-by-author
5310 @findex gnus-thread-sort-by-number
5311 @vindex gnus-thread-sort-functions
5312 If you are using a threaded summary display, you can sort the threads by
5313 setting @code{gnus-thread-sort-functions}, which can be either a single
5314 function, a list of functions, or a list containing functions and
5315 @code{(not some-function)} elements.
5316
5317 By default, sorting is done on article numbers.  Ready-made sorting
5318 predicate functions include @code{gnus-thread-sort-by-number},
5319 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5320 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5321 @code{gnus-thread-sort-by-total-score}.
5322
5323 Each function takes two threads and returns non-@code{nil} if the first
5324 thread should be sorted before the other.  Note that sorting really is
5325 normally done by looking only at the roots of each thread.
5326
5327 If you use more than one function, the primary sort key should be the
5328 last function in the list.  You should probably always include
5329 @code{gnus-thread-sort-by-number} in the list of sorting
5330 functions---preferably first.  This will ensure that threads that are
5331 equal with respect to the other sort criteria will be displayed in
5332 ascending article order.
5333
5334 If you would like to sort by reverse score, then by subject, and finally
5335 by number, you could do something like:
5336
5337 @lisp
5338 (setq gnus-thread-sort-functions
5339       '(gnus-thread-sort-by-number
5340         gnus-thread-sort-by-subject
5341         (not gnus-thread-sort-by-total-score)))
5342 @end lisp
5343
5344 The threads that have highest score will be displayed first in the
5345 summary buffer.  When threads have the same score, they will be sorted
5346 alphabetically.  The threads that have the same score and the same
5347 subject will be sorted by number, which is (normally) the sequence in
5348 which the articles arrived.
5349
5350 If you want to sort by score and then reverse arrival order, you could
5351 say something like:
5352
5353 @lisp
5354 (setq gnus-thread-sort-functions
5355       '((lambda (t1 t2)
5356           (not (gnus-thread-sort-by-number t1 t2)))
5357         gnus-thread-sort-by-score))
5358 @end lisp
5359
5360 @vindex gnus-thread-score-function
5361 The function in the @code{gnus-thread-score-function} variable (default
5362 @code{+}) is used for calculating the total score of a thread.  Useful
5363 functions might be @code{max}, @code{min}, or squared means, or whatever
5364 tickles your fancy.
5365
5366 @findex gnus-article-sort-functions
5367 @findex gnus-article-sort-by-date
5368 @findex gnus-article-sort-by-score
5369 @findex gnus-article-sort-by-subject
5370 @findex gnus-article-sort-by-author
5371 @findex gnus-article-sort-by-number
5372 If you are using an unthreaded display for some strange reason or other,
5373 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5374 It is very similar to the @code{gnus-thread-sort-functions}, except that
5375 it uses slightly different functions for article comparison.  Available
5376 sorting predicate functions are @code{gnus-article-sort-by-number},
5377 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5378 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5379
5380 If you want to sort an unthreaded summary display by subject, you could
5381 say something like:
5382
5383 @lisp
5384 (setq gnus-article-sort-functions
5385       '(gnus-article-sort-by-number
5386         gnus-article-sort-by-subject))
5387 @end lisp
5388
5389
5390
5391 @node Asynchronous Fetching
5392 @section Asynchronous Article Fetching
5393 @cindex asynchronous article fetching
5394 @cindex article pre-fetch
5395 @cindex pre-fetch
5396
5397 If you read your news from an @sc{nntp} server that's far away, the
5398 network latencies may make reading articles a chore.  You have to wait
5399 for a while after pressing @kbd{n} to go to the next article before the
5400 article appears.  Why can't gnus just go ahead and fetch the article
5401 while you are reading the previous one?  Why not, indeed.
5402
5403 First, some caveats.  There are some pitfalls to using asynchronous
5404 article fetching, especially the way gnus does it.
5405
5406 Let's say you are reading article 1, which is short, and article 2 is
5407 quite long, and you are not interested in reading that.  Gnus does not
5408 know this, so it goes ahead and fetches article 2.  You decide to read
5409 article 3, but since gnus is in the process of fetching article 2, the
5410 connection is blocked.
5411
5412 To avoid these situations, gnus will open two (count 'em two)
5413 connections to the server.  Some people may think this isn't a very nice
5414 thing to do, but I don't see any real alternatives.  Setting up that
5415 extra connection takes some time, so gnus startup will be slower.
5416
5417 Gnus will fetch more articles than you will read.  This will mean that
5418 the link between your machine and the @sc{nntp} server will become more
5419 loaded than if you didn't use article pre-fetch.  The server itself will
5420 also become more loaded---both with the extra article requests, and the
5421 extra connection.
5422
5423 Ok, so now you know that you shouldn't really use this thing...  unless
5424 you really want to.
5425
5426 @vindex gnus-asynchronous
5427 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
5428 happen automatically.
5429
5430 @vindex gnus-use-article-prefetch
5431 You can control how many articles are to be pre-fetched by setting
5432 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
5433 that when you read an article in the group, the backend will pre-fetch
5434 the next 30 articles.  If this variable is @code{t}, the backend will
5435 pre-fetch all the articles it can without bound.  If it is
5436 @code{nil}, no pre-fetching will be done.
5437
5438 @vindex gnus-async-prefetch-article-p
5439 @findex gnus-async-read-p
5440 There are probably some articles that you don't want to pre-fetch---read
5441 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
5442 return non-@code{nil} when the article in question is to be
5443 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
5444 @code{nil} on read articles.  The function is called with an article
5445 data structure as the only parameter.
5446
5447 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5448
5449 @lisp
5450 (defun my-async-short-unread-p (data)
5451   "Return non-nil for short, unread articles."
5452   (and (gnus-data-unread-p data)
5453        (< (mail-header-lines (gnus-data-header data))
5454           100)))
5455
5456 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5457 @end lisp
5458
5459 These functions will be called many, many times, so they should
5460 preferably be short and sweet to avoid slowing down gnus too much.
5461 It's probably a good idea to byte-compile things like this.
5462
5463 @vindex gnus-prefetched-article-deletion-strategy
5464 Articles have to be removed from the asynch buffer sooner or later.  The
5465 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5466 articles.  This is a list that may contain the following elements:
5467
5468 @table @code
5469 @item read
5470 Remove articles when they are read.
5471
5472 @item exit
5473 Remove articles when exiting the group.
5474 @end table
5475
5476 The default value is @code{(read exit)}.
5477
5478 @c @vindex gnus-use-header-prefetch
5479 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5480 @c from the next group.
5481
5482
5483 @node Article Caching
5484 @section Article Caching
5485 @cindex article caching
5486 @cindex caching
5487
5488 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5489 consider turning article caching on.  Each article will then be stored
5490 locally under your home directory.  As you may surmise, this could
5491 potentially use @emph{huge} amounts of disk space, as well as eat up all
5492 your inodes so fast it will make your head swim.  In vodka.
5493
5494 Used carefully, though, it could be just an easier way to save articles.
5495
5496 @vindex gnus-use-long-file-name
5497 @vindex gnus-cache-directory
5498 @vindex gnus-use-cache
5499 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
5500 all articles ticked or marked as dormant will then be copied
5501 over to your local cache (@code{gnus-cache-directory}).  Whether this
5502 cache is flat or hierarchal is controlled by the
5503 @code{gnus-use-long-file-name} variable, as usual.
5504
5505 When re-selecting a ticked or dormant article, it will be fetched from the
5506 cache instead of from the server.  As articles in your cache will never
5507 expire, this might serve as a method of saving articles while still
5508 keeping them where they belong.  Just mark all articles you want to save
5509 as dormant, and don't worry.
5510
5511 When an article is marked as read, is it removed from the cache.
5512
5513 @vindex gnus-cache-remove-articles
5514 @vindex gnus-cache-enter-articles
5515 The entering/removal of articles from the cache is controlled by the
5516 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5517 variables.  Both are lists of symbols.  The first is @code{(ticked
5518 dormant)} by default, meaning that ticked and dormant articles will be
5519 put in the cache.  The latter is @code{(read)} by default, meaning that
5520 articles marked as read are removed from the cache.  Possibly
5521 symbols in these two lists are @code{ticked}, @code{dormant},
5522 @code{unread} and @code{read}.
5523
5524 @findex gnus-jog-cache
5525 So where does the massive article-fetching and storing come into the
5526 picture?  The @code{gnus-jog-cache} command will go through all
5527 subscribed newsgroups, request all unread articles, score them, and
5528 store them in the cache.  You should only ever, ever ever ever, use this
5529 command if 1) your connection to the @sc{nntp} server is really, really,
5530 really slow and 2) you have a really, really, really huge disk.
5531 Seriously.  One way to cut down on the number of articles downloaded is
5532 to score unwanted articles down and have them marked as read.  They will
5533 not then be downloaded by this command.
5534
5535 @vindex gnus-uncacheable-groups
5536 @vindex gnus-cacheable-groups
5537 It is likely that you do not want caching on all groups.  For instance,
5538 if your @code{nnml} mail is located under your home directory, it makes no
5539 sense to cache it somewhere else under your home directory.  Unless you
5540 feel that it's neat to use twice as much space.
5541
5542 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5543 regexp of groups to cache, @samp{^nntp} for instance, or set the
5544 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5545 Both variables are @code{nil} by default. If a group matches both
5546 variables, the group is not cached.
5547
5548 @findex gnus-cache-generate-nov-databases
5549 @findex gnus-cache-generate-active
5550 @vindex gnus-cache-active-file
5551 The cache stores information on what articles it contains in its active
5552 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5553 of the cache) becomes all messed up for some reason or other, gnus
5554 offers two functions that will try to set things right.  @kbd{M-x
5555 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5556 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5557 file.
5558
5559
5560 @node Persistent Articles
5561 @section Persistent Articles
5562 @cindex persistent articles
5563
5564 Closely related to article caching, we have @dfn{persistent articles}.
5565 In fact, it's just a different way of looking at caching, and much more
5566 useful in my opinion.
5567
5568 Say you're reading a newsgroup, and you happen on to some valuable gem
5569 that you want to keep and treasure forever.  You'd normally just save it
5570 (using one of the many saving commands) in some file.  The problem with
5571 that is that it's just, well, yucky.  Ideally you'd prefer just having
5572 the article remain in the group where you found it forever; untouched by
5573 the expiry going on at the news server.
5574
5575 This is what a @dfn{persistent article} is---an article that just won't
5576 be deleted.  It's implemented using the normal cache functions, but
5577 you use two explicit commands for managing persistent articles:
5578
5579 @table @kbd
5580
5581 @item *
5582 @kindex * (Summary)
5583 @findex gnus-cache-enter-article
5584 Make the current article persistent (@code{gnus-cache-enter-article}).
5585
5586 @item M-*
5587 @kindex M-* (Summary)
5588 @findex gnus-cache-remove-article
5589 Remove the current article from the persistent articles
5590 (@code{gnus-cache-remove-article}).  This will normally delete the
5591 article.
5592 @end table
5593
5594 Both these commands understand the process/prefix convention.
5595
5596 To avoid having all ticked articles (and stuff) entered into the cache,
5597 you should set @code{gnus-use-cache} to @code{passive} if you're just
5598 interested in persistent articles:
5599
5600 @lisp
5601 (setq gnus-use-cache 'passive)
5602 @end lisp
5603
5604
5605 @node Article Backlog
5606 @section Article Backlog
5607 @cindex backlog
5608 @cindex article backlog
5609
5610 If you have a slow connection, but the idea of using caching seems
5611 unappealing to you (and it is, really), you can help the situation some
5612 by switching on the @dfn{backlog}.  This is where gnus will buffer
5613 already read articles so that it doesn't have to re-fetch articles
5614 you've already read.  This only helps if you are in the habit of
5615 re-selecting articles you've recently read, of course.  If you never do
5616 that, turning the backlog on will slow gnus down a little bit, and
5617 increase memory usage some.
5618
5619 @vindex gnus-keep-backlog
5620 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
5621 at most @var{n} old articles in a buffer for later re-fetching.  If this
5622 variable is non-@code{nil} and is not a number, gnus will store
5623 @emph{all} read articles, which means that your Emacs will grow without
5624 bound before exploding and taking your machine down with you.  I put
5625 that in there just to keep y'all on your toes.
5626
5627 This variable is @code{nil} by default.
5628
5629
5630 @node Saving Articles
5631 @section Saving Articles
5632 @cindex saving articles
5633
5634 Gnus can save articles in a number of ways.  Below is the documentation
5635 for saving articles in a fairly straight-forward fashion (i.e., little
5636 processing of the article is done before it is saved).  For a different
5637 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5638 (@pxref{Decoding Articles}).
5639
5640 @vindex gnus-save-all-headers
5641 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
5642 unwanted headers before saving the article.
5643
5644 @vindex gnus-saved-headers
5645 If the preceding variable is @code{nil}, all headers that match the
5646 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5647 deleted before saving.
5648
5649 @table @kbd
5650
5651 @item O o
5652 @itemx o
5653 @kindex O o (Summary)
5654 @kindex o (Summary)
5655 @findex gnus-summary-save-article
5656 @c @icon{gnus-summary-save-article}
5657 Save the current article using the default article saver
5658 (@code{gnus-summary-save-article}).
5659
5660 @item O m
5661 @kindex O m (Summary)
5662 @findex gnus-summary-save-article-mail
5663 Save the current article in mail format
5664 (@code{gnus-summary-save-article-mail}).
5665
5666 @item O r
5667 @kindex O r (Summary)
5668 @findex gnus-summary-save-article-rmail
5669 Save the current article in rmail format
5670 (@code{gnus-summary-save-article-rmail}).
5671
5672 @item O f
5673 @kindex O f (Summary)
5674 @findex gnus-summary-save-article-file
5675 @c @icon{gnus-summary-save-article-file}
5676 Save the current article in plain file format
5677 (@code{gnus-summary-save-article-file}).
5678
5679 @item O F
5680 @kindex O F (Summary)
5681 @findex gnus-summary-write-article-file
5682 Write the current article in plain file format, overwriting any previous
5683 file contents (@code{gnus-summary-write-article-file}).
5684
5685 @item O b
5686 @kindex O b (Summary)
5687 @findex gnus-summary-save-article-body-file
5688 Save the current article body in plain file format
5689 (@code{gnus-summary-save-article-body-file}).
5690
5691 @item O h
5692 @kindex O h (Summary)
5693 @findex gnus-summary-save-article-folder
5694 Save the current article in mh folder format
5695 (@code{gnus-summary-save-article-folder}).
5696
5697 @item O v
5698 @kindex O v (Summary)
5699 @findex gnus-summary-save-article-vm
5700 Save the current article in a VM folder
5701 (@code{gnus-summary-save-article-vm}).
5702
5703 @item O p
5704 @kindex O p (Summary)
5705 @findex gnus-summary-pipe-output
5706 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5707 the current article to a process (@code{gnus-summary-pipe-output}).
5708 @end table
5709
5710 @vindex gnus-prompt-before-saving
5711 All these commands use the process/prefix convention
5712 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5713 functions, you might get tired of being prompted for files to save each
5714 and every article in.  The prompting action is controlled by
5715 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5716 default, giving you that excessive prompting action you know and
5717 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5718 just once for each series of articles you save.  If you like to really
5719 have Gnus do all your thinking for you, you can even set this variable
5720 to @code{nil}, which means that you will never be prompted for files to
5721 save articles in.  Gnus will simply save all the articles in the default
5722 files.
5723
5724
5725 @vindex gnus-default-article-saver
5726 You can customize the @code{gnus-default-article-saver} variable to make
5727 gnus do what you want it to.  You can use any of the four ready-made
5728 functions below, or you can create your own.
5729
5730 @table @code
5731
5732 @item gnus-summary-save-in-rmail
5733 @findex gnus-summary-save-in-rmail
5734 @vindex gnus-rmail-save-name
5735 @findex gnus-plain-save-name
5736 This is the default format, @dfn{babyl}.  Uses the function in the
5737 @code{gnus-rmail-save-name} variable to get a file name to save the
5738 article in.  The default is @code{gnus-plain-save-name}.
5739
5740 @item gnus-summary-save-in-mail
5741 @findex gnus-summary-save-in-mail
5742 @vindex gnus-mail-save-name
5743 Save in a Unix mail (mbox) file.  Uses the function in the
5744 @code{gnus-mail-save-name} variable to get a file name to save the
5745 article in.  The default is @code{gnus-plain-save-name}.
5746
5747 @item gnus-summary-save-in-file
5748 @findex gnus-summary-save-in-file
5749 @vindex gnus-file-save-name
5750 @findex gnus-numeric-save-name
5751 Append the article straight to an ordinary file.  Uses the function in
5752 the @code{gnus-file-save-name} variable to get a file name to save the
5753 article in.  The default is @code{gnus-numeric-save-name}.
5754
5755 @item gnus-summary-save-body-in-file
5756 @findex gnus-summary-save-body-in-file
5757 Append the article body to an ordinary file.  Uses the function in the
5758 @code{gnus-file-save-name} variable to get a file name to save the
5759 article in.  The default is @code{gnus-numeric-save-name}.
5760
5761 @item gnus-summary-save-in-folder
5762 @findex gnus-summary-save-in-folder
5763 @findex gnus-folder-save-name
5764 @findex gnus-Folder-save-name
5765 @vindex gnus-folder-save-name
5766 @cindex rcvstore
5767 @cindex MH folders
5768 Save the article to an MH folder using @code{rcvstore} from the MH
5769 library.  Uses the function in the @code{gnus-folder-save-name} variable
5770 to get a file name to save the article in.  The default is
5771 @code{gnus-folder-save-name}, but you can also use
5772 @code{gnus-Folder-save-name}, which creates capitalized names.
5773
5774 @item gnus-summary-save-in-vm
5775 @findex gnus-summary-save-in-vm
5776 Save the article in a VM folder.  You have to have the VM mail
5777 reader to use this setting.
5778 @end table
5779
5780 @vindex gnus-article-save-directory
5781 All of these functions, except for the last one, will save the article
5782 in the @code{gnus-article-save-directory}, which is initialized from the
5783 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5784 default.
5785
5786 As you can see above, the functions use different functions to find a
5787 suitable name of a file to save the article in.  Below is a list of
5788 available functions that generate names:
5789
5790 @table @code
5791
5792 @item gnus-Numeric-save-name
5793 @findex gnus-Numeric-save-name
5794 File names like @file{~/News/Alt.andrea-dworkin/45}.
5795
5796 @item gnus-numeric-save-name
5797 @findex gnus-numeric-save-name
5798 File names like @file{~/News/alt.andrea-dworkin/45}.
5799
5800 @item gnus-Plain-save-name
5801 @findex gnus-Plain-save-name
5802 File names like @file{~/News/Alt.andrea-dworkin}.
5803
5804 @item gnus-plain-save-name
5805 @findex gnus-plain-save-name
5806 File names like @file{~/News/alt.andrea-dworkin}.
5807 @end table
5808
5809 @vindex gnus-split-methods
5810 You can have gnus suggest where to save articles by plonking a regexp into
5811 the @code{gnus-split-methods} alist.  For instance, if you would like to
5812 save articles related to gnus in the file @file{gnus-stuff}, and articles
5813 related to VM in @code{vm-stuff}, you could set this variable to something
5814 like:
5815
5816 @lisp
5817 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5818  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5819  (my-choosing-function "../other-dir/my-stuff")
5820  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5821 @end lisp
5822
5823 We see that this is a list where each element is a list that has two
5824 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5825 a string (in which case it is used as a regexp to match on the article
5826 head); it can be a symbol (which will be called as a function with the
5827 group name as a parameter); or it can be a list (which will be
5828 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5829 the @dfn{file} will be used as a default prompt.  In addition, the
5830 result of the operation itself will be used if the function or form
5831 called returns a string or a list of strings.
5832
5833 You basically end up with a list of file names that might be used when
5834 saving the current article.  (All ``matches'' will be used.)  You will
5835 then be prompted for what you really want to use as a name, with file
5836 name completion over the results from applying this variable.
5837
5838 This variable is @code{((gnus-article-archive-name))} by default, which
5839 means that gnus will look at the articles it saves for an
5840 @code{Archive-name} line and use that as a suggestion for the file
5841 name.
5842
5843 Here's an example function to clean up file names somewhat.  If you have
5844 lots of mail groups called things like
5845 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5846 these group names before creating the file name to save to.  The
5847 following will do just that:
5848
5849 @lisp
5850 (defun my-save-name (group)
5851   (when (string-match "^nnml:mail." group)
5852     (substring group (match-end 0))))
5853
5854 (setq gnus-split-methods
5855       '((gnus-article-archive-name)
5856         (my-save-name)))
5857 @end lisp
5858
5859
5860 @vindex gnus-use-long-file-name
5861 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5862 @code{nil}, all the preceding functions will replace all periods
5863 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5864 the functions will generate hierarchies of directories instead of having
5865 all the files in the top level directory
5866 (@file{~/News/alt/andrea-dworkin} instead of
5867 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5868 on most systems.  However, for historical reasons, this is @code{nil} on
5869 Xenix and usg-unix-v machines by default.
5870
5871 This function also affects kill and score file names.  If this variable
5872 is a list, and the list contains the element @code{not-score}, long file
5873 names will not be used for score files, if it contains the element
5874 @code{not-save}, long file names will not be used for saving, and if it
5875 contains the element @code{not-kill}, long file names will not be used
5876 for kill files.
5877
5878 If you'd like to save articles in a hierarchy that looks something like
5879 a spool, you could
5880
5881 @lisp
5882 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5883 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5884 @end lisp
5885
5886 Then just save with @kbd{o}.  You'd then read this hierarchy with
5887 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5888 the top level directory as the argument (@file{~/News/}).  Then just walk
5889 around to the groups/directories with @code{nneething}.
5890
5891
5892 @node Decoding Articles
5893 @section Decoding Articles
5894 @cindex decoding articles
5895
5896 Sometime users post articles (or series of articles) that have been
5897 encoded in some way or other.  Gnus can decode them for you.
5898
5899 @menu
5900 * Uuencoded Articles::    Uudecode articles.
5901 * Shell Archives::        Unshar articles.
5902 * PostScript Files::      Split PostScript.
5903 * Other Files::           Plain save and binhex.
5904 * Decoding Variables::    Variables for a happy decoding.
5905 * Viewing Files::         You want to look at the result of the decoding?
5906 @end menu
5907
5908 @cindex series
5909 @cindex article series
5910 All these functions use the process/prefix convention
5911 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5912 the extension that a ``single article'' means ``a single series''.  Gnus
5913 can find out by itself what articles belong to a series, decode all the
5914 articles and unpack/view/save the resulting file(s).
5915
5916 Gnus guesses what articles are in the series according to the following
5917 simplish rule: The subjects must be (nearly) identical, except for the
5918 last two numbers of the line.  (Spaces are largely ignored, however.)
5919
5920 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
5921 will find all the articles that match the regexp @samp{^cat.gif
5922 ([0-9]+/[0-9]+).*$}.
5923
5924 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5925 series}, will not be properly recognized by any of the automatic viewing
5926 commands, and you have to mark the articles manually with @kbd{#}.
5927
5928
5929 @node Uuencoded Articles
5930 @subsection Uuencoded Articles
5931 @cindex uudecode
5932 @cindex uuencoded articles
5933
5934 @table @kbd
5935
5936 @item X u
5937 @kindex X u (Summary)
5938 @findex gnus-uu-decode-uu
5939 @c @icon{gnus-uu-decode-uu}
5940 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5941
5942 @item X U
5943 @kindex X U (Summary)
5944 @findex gnus-uu-decode-uu-and-save
5945 Uudecodes and saves the current series
5946 (@code{gnus-uu-decode-uu-and-save}).
5947
5948 @item X v u
5949 @kindex X v u (Summary)
5950 @findex gnus-uu-decode-uu-view
5951 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5952
5953 @item X v U
5954 @kindex X v U (Summary)
5955 @findex gnus-uu-decode-uu-and-save-view
5956 Uudecodes, views and saves the current series
5957 (@code{gnus-uu-decode-uu-and-save-view}).
5958
5959 @end table
5960
5961 Remember that these all react to the presence of articles marked with
5962 the process mark.  If, for instance, you'd like to decode and save an
5963 entire newsgroup, you'd typically do @kbd{M P a}
5964 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5965 (@code{gnus-uu-decode-uu-and-save}).
5966
5967 All this is very much different from how @code{gnus-uu} worked with
5968 @sc{GNUS 4.1}, where you had explicit keystrokes for everything under
5969 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5970 articles in some way (@pxref{Setting Process Marks}) and then press
5971 @kbd{X u}.
5972
5973 @vindex gnus-uu-notify-files
5974 Note: When trying to decode articles that have names matching
5975 @code{gnus-uu-notify-files}, which is hard-coded to
5976 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5977 automatically post an article on @samp{comp.unix.wizards} saying that
5978 you have just viewed the file in question.  This feature can't be turned
5979 off.
5980
5981
5982 @node Shell Archives
5983 @subsection Shell Archives
5984 @cindex unshar
5985 @cindex shell archives
5986 @cindex shared articles
5987
5988 Shell archives (``shar files'') used to be a popular way to distribute
5989 sources, but it isn't used all that much today.  In any case, we have
5990 some commands to deal with these:
5991
5992 @table @kbd
5993
5994 @item X s
5995 @kindex X s (Summary)
5996 @findex gnus-uu-decode-unshar
5997 Unshars the current series (@code{gnus-uu-decode-unshar}).
5998
5999 @item X S
6000 @kindex X S (Summary)
6001 @findex gnus-uu-decode-unshar-and-save
6002 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6003
6004 @item X v s
6005 @kindex X v s (Summary)
6006 @findex gnus-uu-decode-unshar-view
6007 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6008
6009 @item X v S
6010 @kindex X v S (Summary)
6011 @findex gnus-uu-decode-unshar-and-save-view
6012 Unshars, views and saves the current series
6013 (@code{gnus-uu-decode-unshar-and-save-view}).
6014 @end table
6015
6016
6017 @node PostScript Files
6018 @subsection PostScript Files
6019 @cindex PostScript
6020
6021 @table @kbd
6022
6023 @item X p
6024 @kindex X p (Summary)
6025 @findex gnus-uu-decode-postscript
6026 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6027
6028 @item X P
6029 @kindex X P (Summary)
6030 @findex gnus-uu-decode-postscript-and-save
6031 Unpack and save the current PostScript series
6032 (@code{gnus-uu-decode-postscript-and-save}).
6033
6034 @item X v p
6035 @kindex X v p (Summary)
6036 @findex gnus-uu-decode-postscript-view
6037 View the current PostScript series
6038 (@code{gnus-uu-decode-postscript-view}).
6039
6040 @item X v P
6041 @kindex X v P (Summary)
6042 @findex gnus-uu-decode-postscript-and-save-view
6043 View and save the current PostScript series
6044 (@code{gnus-uu-decode-postscript-and-save-view}).
6045 @end table
6046
6047
6048 @node Other Files
6049 @subsection Other Files
6050
6051 @table @kbd
6052 @item X o
6053 @kindex X o (Summary)
6054 @findex gnus-uu-decode-save
6055 Save the current series
6056 (@code{gnus-uu-decode-save}).
6057
6058 @item X b
6059 @kindex X b (Summary)
6060 @findex gnus-uu-decode-binhex
6061 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
6062 doesn't really work yet.
6063 @end table
6064
6065
6066 @node Decoding Variables
6067 @subsection Decoding Variables
6068
6069 Adjective, not verb.
6070
6071 @menu
6072 * Rule Variables::          Variables that say how a file is to be viewed.
6073 * Other Decode Variables::  Other decode variables.
6074 * Uuencoding and Posting::  Variables for customizing uuencoding.
6075 @end menu
6076
6077
6078 @node Rule Variables
6079 @subsubsection Rule Variables
6080 @cindex rule variables
6081
6082 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
6083 variables are of the form
6084
6085 @lisp
6086       (list '(regexp1 command2)
6087             '(regexp2 command2)
6088             ...)
6089 @end lisp
6090
6091 @table @code
6092
6093 @item gnus-uu-user-view-rules
6094 @vindex gnus-uu-user-view-rules
6095 @cindex sox
6096 This variable is consulted first when viewing files.  If you wish to use,
6097 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6098 say something like:
6099 @lisp
6100 (setq gnus-uu-user-view-rules
6101       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6102 @end lisp
6103
6104 @item gnus-uu-user-view-rules-end
6105 @vindex gnus-uu-user-view-rules-end
6106 This variable is consulted if gnus couldn't make any matches from the
6107 user and default view rules.
6108
6109 @item gnus-uu-user-archive-rules
6110 @vindex gnus-uu-user-archive-rules
6111 This variable can be used to say what commands should be used to unpack
6112 archives.
6113 @end table
6114
6115
6116 @node Other Decode Variables
6117 @subsubsection Other Decode Variables
6118
6119 @table @code
6120 @vindex gnus-uu-grabbed-file-functions
6121
6122 @item gnus-uu-grabbed-file-functions
6123 All functions in this list will be called right after each file has been
6124 successfully decoded---so that you can move or view files right away,
6125 and don't have to wait for all files to be decoded before you can do
6126 anything.  Ready-made functions you can put in this list are:
6127
6128 @table @code
6129
6130 @item gnus-uu-grab-view
6131 @findex gnus-uu-grab-view
6132 View the file.
6133
6134 @item gnus-uu-grab-move
6135 @findex gnus-uu-grab-move
6136 Move the file (if you're using a saving function.)
6137 @end table
6138
6139 @item gnus-uu-be-dangerous
6140 @vindex gnus-uu-be-dangerous
6141 Specifies what to do if unusual situations arise during decoding.  If
6142 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
6143 that didn't work, and overwrite existing files.  Otherwise, ask each
6144 time.
6145
6146 @item gnus-uu-ignore-files-by-name
6147 @vindex gnus-uu-ignore-files-by-name
6148 Files with name matching this regular expression won't be viewed.
6149
6150 @item gnus-uu-ignore-files-by-type
6151 @vindex gnus-uu-ignore-files-by-type
6152 Files with a @sc{mime} type matching this variable won't be viewed.
6153 Note that Gnus tries to guess what type the file is based on the name.
6154 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6155 kludgey.
6156
6157 @item gnus-uu-tmp-dir
6158 @vindex gnus-uu-tmp-dir
6159 Where @code{gnus-uu} does its work.
6160
6161 @item gnus-uu-do-not-unpack-archives
6162 @vindex gnus-uu-do-not-unpack-archives
6163 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6164 looking for files to display.
6165
6166 @item gnus-uu-view-and-save
6167 @vindex gnus-uu-view-and-save
6168 Non-@code{nil} means that the user will always be asked to save a file
6169 after viewing it.
6170
6171 @item gnus-uu-ignore-default-view-rules
6172 @vindex gnus-uu-ignore-default-view-rules
6173 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6174 rules.
6175
6176 @item gnus-uu-ignore-default-archive-rules
6177 @vindex gnus-uu-ignore-default-archive-rules
6178 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6179 unpacking commands.
6180
6181 @item gnus-uu-kill-carriage-return
6182 @vindex gnus-uu-kill-carriage-return
6183 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6184 from articles.
6185
6186 @item gnus-uu-unmark-articles-not-decoded
6187 @vindex gnus-uu-unmark-articles-not-decoded
6188 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6189 decoded articles as unread.
6190
6191 @item gnus-uu-correct-stripped-uucode
6192 @vindex gnus-uu-correct-stripped-uucode
6193 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6194 uuencoded files that have had trailing spaces deleted.
6195
6196 @item gnus-uu-pre-uudecode-hook
6197 @vindex gnus-uu-pre-uudecode-hook
6198 Hook run before sending a message to @code{uudecode}.
6199
6200 @item gnus-uu-view-with-metamail
6201 @vindex gnus-uu-view-with-metamail
6202 @cindex metamail
6203 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6204 commands defined by the rule variables and just fudge a @sc{mime}
6205 content type based on the file name.  The result will be fed to
6206 @code{metamail} for viewing.
6207
6208 @item gnus-uu-save-in-digest
6209 @vindex gnus-uu-save-in-digest
6210 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6211 decoding, will save in digests.  If this variable is @code{nil},
6212 @code{gnus-uu} will just save everything in a file without any
6213 embellishments.  The digesting almost conforms to RFC1153---no easy way
6214 to specify any meaningful volume and issue numbers were found, so I
6215 simply dropped them.
6216
6217 @end table
6218
6219
6220 @node Uuencoding and Posting
6221 @subsubsection Uuencoding and Posting
6222
6223 @table @code
6224
6225 @item gnus-uu-post-include-before-composing
6226 @vindex gnus-uu-post-include-before-composing
6227 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6228 before you compose the article.  If this variable is @code{t}, you can
6229 either include an encoded file with @kbd{C-c C-i} or have one included
6230 for you when you post the article.
6231
6232 @item gnus-uu-post-length
6233 @vindex gnus-uu-post-length
6234 Maximum length of an article.  The encoded file will be split into how
6235 many articles it takes to post the entire file.
6236
6237 @item gnus-uu-post-threaded
6238 @vindex gnus-uu-post-threaded
6239 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6240 thread.  This may not be smart, as no other decoder I have seen is able
6241 to follow threads when collecting uuencoded articles.  (Well, I have
6242 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6243 think that counts...) Default is @code{nil}.
6244
6245 @item gnus-uu-post-separate-description
6246 @vindex gnus-uu-post-separate-description
6247 Non-@code{nil} means that the description will be posted in a separate
6248 article.  The first article will typically be numbered (0/x).  If this
6249 variable is @code{nil}, the description the user enters will be included
6250 at the beginning of the first article, which will be numbered (1/x).
6251 Default is @code{t}.
6252
6253 @end table
6254
6255
6256 @node Viewing Files
6257 @subsection Viewing Files
6258 @cindex viewing files
6259 @cindex pseudo-articles
6260
6261 After decoding, if the file is some sort of archive, gnus will attempt
6262 to unpack the archive and see if any of the files in the archive can be
6263 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
6264 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
6265 uncompress and de-tar the main file, and then view the two pictures.
6266 This unpacking process is recursive, so if the archive contains archives
6267 of archives, it'll all be unpacked.
6268
6269 Finally, gnus will normally insert a @dfn{pseudo-article} for each
6270 extracted file into the summary buffer.  If you go to these
6271 ``articles'', you will be prompted for a command to run (usually Gnus
6272 will make a suggestion), and then the command will be run.
6273
6274 @vindex gnus-view-pseudo-asynchronously
6275 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6276 until the viewing is done before proceeding.
6277
6278 @vindex gnus-view-pseudos
6279 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6280 the pseudo-articles into the summary buffer, but view them
6281 immediately.  If this variable is @code{not-confirm}, the user won't even
6282 be asked for a confirmation before viewing is done.
6283
6284 @vindex gnus-view-pseudos-separately
6285 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6286 pseudo-article will be created for each file to be viewed.  If
6287 @code{nil}, all files that use the same viewing command will be given as
6288 a list of parameters to that command.
6289
6290 @vindex gnus-insert-pseudo-articles
6291 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6292 pseudo-articles when decoding.  It is @code{t} by default.
6293
6294 So; there you are, reading your @emph{pseudo-articles} in your
6295 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6296 Why isn't anything real anymore? How did we get here?
6297
6298
6299 @node Article Treatment
6300 @section Article Treatment
6301
6302 Reading through this huge manual, you may have quite forgotten that the
6303 object of newsreaders is to actually, like, read what people have
6304 written.  Reading articles.  Unfortunately, people are quite bad at
6305 writing, so there are tons of functions and variables to make reading
6306 these articles easier.
6307
6308 @menu
6309 * Article Highlighting::    You want to make the article look like fruit salad.
6310 * Article Fontisizing::     Making emphasized text look nice.
6311 * Article Hiding::          You also want to make certain info go away.
6312 * Article Washing::         Lots of way-neat functions to make life better.
6313 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6314 * Article Date::            Grumble, UT!
6315 * Article Signature::       What is a signature?
6316 * Article Miscellania::     Various other stuff.
6317 @end menu
6318
6319
6320 @node Article Highlighting
6321 @subsection Article Highlighting
6322 @cindex highlighting
6323
6324 Not only do you want your article buffer to look like fruit salad, but
6325 you want it to look like technicolor fruit salad.
6326
6327 @table @kbd
6328
6329 @item W H a
6330 @kindex W H a (Summary)
6331 @findex gnus-article-highlight
6332 @findex gnus-article-maybe-highlight
6333 Do much highlighting of the current article
6334 (@code{gnus-article-highlight}).  This function highlights header, cited
6335 text, the signature, and adds buttons to the body and the head.
6336
6337 @item W H h
6338 @kindex W H h (Summary)
6339 @findex gnus-article-highlight-headers
6340 @vindex gnus-header-face-alist
6341 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6342 highlighting will be done according to the @code{gnus-header-face-alist}
6343 variable, which is a list where each element has the form @var{(regexp
6344 name content)}.  @var{regexp} is a regular expression for matching the
6345 header, @var{name} is the face used for highlighting the header name
6346 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6347 the header value.  The first match made will be used.  Note that
6348 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6349
6350 @item W H c
6351 @kindex W H c (Summary)
6352 @findex gnus-article-highlight-citation
6353 Highlight cited text (@code{gnus-article-highlight-citation}).
6354
6355 Some variables to customize the citation highlights:
6356
6357 @table @code
6358 @vindex gnus-cite-parse-max-size
6359
6360 @item gnus-cite-parse-max-size
6361 If the article size if bigger than this variable (which is 25000 by
6362 default), no citation highlighting will be performed.
6363
6364 @item gnus-cite-prefix-regexp
6365 @vindex gnus-cite-prefix-regexp
6366 Regexp matching the longest possible citation prefix on a line.
6367
6368 @item gnus-cite-max-prefix
6369 @vindex gnus-cite-max-prefix
6370 Maximum possible length for a citation prefix (default 20).
6371
6372 @item gnus-cite-face-list
6373 @vindex gnus-cite-face-list
6374 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6375 When there are citations from multiple articles in the same message,
6376 gnus will try to give each citation from each article its own face.
6377 This should make it easier to see who wrote what.
6378
6379 @item gnus-supercite-regexp
6380 @vindex gnus-supercite-regexp
6381 Regexp matching normal Supercite attribution lines.
6382
6383 @item gnus-supercite-secondary-regexp
6384 @vindex gnus-supercite-secondary-regexp
6385 Regexp matching mangled Supercite attribution lines.
6386
6387 @item gnus-cite-minimum-match-count
6388 @vindex gnus-cite-minimum-match-count
6389 Minimum number of identical prefixes we have to see before we believe
6390 that it's a citation.
6391
6392 @item gnus-cite-attribution-prefix
6393 @vindex gnus-cite-attribution-prefix
6394 Regexp matching the beginning of an attribution line.
6395
6396 @item gnus-cite-attribution-suffix
6397 @vindex gnus-cite-attribution-suffix
6398 Regexp matching the end of an attribution line.
6399
6400 @item gnus-cite-attribution-face
6401 @vindex gnus-cite-attribution-face
6402 Face used for attribution lines.  It is merged with the face for the
6403 cited text belonging to the attribution.
6404
6405 @end table
6406
6407
6408 @item W H s
6409 @kindex W H s (Summary)
6410 @vindex gnus-signature-separator
6411 @vindex gnus-signature-face
6412 @findex gnus-article-highlight-signature
6413 Highlight the signature (@code{gnus-article-highlight-signature}).
6414 Everything after @code{gnus-signature-separator} (@pxref{Article
6415 Signature}) in an article will be considered a signature and will be
6416 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6417 default.
6418
6419 @end table
6420
6421 @xref{Customizing Articles}, for how to highlight articles automatically.
6422
6423
6424 @node Article Fontisizing
6425 @subsection Article Fontisizing
6426 @cindex emphasis
6427 @cindex article emphasis
6428
6429 @findex gnus-article-emphasize
6430 @kindex W e (Summary)
6431 People commonly add emphasis to words in news articles by writing things
6432 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
6433 running the article through the @kbd{W e}
6434 (@code{gnus-article-emphasize}) command.
6435
6436 @vindex gnus-emphasis-alist
6437 How the emphasis is computed is controlled by the
6438 @code{gnus-emphasis-alist} variable.  This is an alist where the first
6439 element is a regular expression to be matched.  The second is a number
6440 that says what regular expression grouping is used to find the entire
6441 emphasized word.  The third is a number that says what regexp grouping
6442 should be displayed and highlighted.  (The text between these two
6443 groupings will be hidden.)  The fourth is the face used for
6444 highlighting.
6445
6446 @lisp
6447 (setq gnus-article-emphasis
6448       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6449         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6450 @end lisp
6451
6452 @vindex gnus-emphasis-underline
6453 @vindex gnus-emphasis-bold
6454 @vindex gnus-emphasis-italic
6455 @vindex gnus-emphasis-underline-bold
6456 @vindex gnus-emphasis-underline-italic
6457 @vindex gnus-emphasis-bold-italic
6458 @vindex gnus-emphasis-underline-bold-italic
6459 By default, there are seven rules, and they use the following faces:
6460 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6461 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6462 @code{gnus-emphasis-underline-italic},
6463 @code{gnus-emphasis-underline-bold}, and
6464 @code{gnus-emphasis-underline-bold-italic}.
6465
6466 If you want to change these faces, you can either use @kbd{M-x
6467 customize}, or you can use @code{copy-face}.  For instance, if you want
6468 to make @code{gnus-emphasis-italic} use a red face instead, you could
6469 say something like:
6470
6471 @lisp
6472 (copy-face 'red 'gnus-emphasis-italic)
6473 @end lisp
6474
6475 @vindex gnus-group-highlight-words-alist
6476
6477 If you want to highlight arbitrary words, you can use the
6478 @code{gnus-group-highlight-words-alist} variable, which uses the same
6479 syntax as @code{gnus-emphasis-alist}.  The @code{highlight-words} group
6480 parameter (@pxref{Group Parameters}) can also be used.
6481
6482 @xref{Customizing Articles}, for how to fontize articles automatically.
6483
6484
6485 @node Article Hiding
6486 @subsection Article Hiding
6487 @cindex article hiding
6488
6489 Or rather, hiding certain things in each article.  There usually is much
6490 too much cruft in most articles.
6491
6492 @table @kbd
6493
6494 @item W W a
6495 @kindex W W a (Summary)
6496 @findex gnus-article-hide
6497 Do quite a lot of hiding on the article buffer
6498 (@kbd{gnus-article-hide}).  In particular, this function will hide
6499 headers, PGP, cited text and the signature.
6500
6501 @item W W h
6502 @kindex W W h (Summary)
6503 @findex gnus-article-toggle-headers
6504 Toggle hiding of headers (@code{gnus-article-toggle-headers}).  @xref{Hiding
6505 Headers}.
6506
6507 @item W W b
6508 @kindex W W b (Summary)
6509 @findex gnus-article-hide-boring-headers
6510 Hide headers that aren't particularly interesting
6511 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
6512
6513 @item W W s
6514 @kindex W W s (Summary)
6515 @findex gnus-article-hide-signature
6516 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
6517 Signature}.
6518
6519 @item W W p
6520 @kindex W W p (Summary)
6521 @findex gnus-article-hide-pgp
6522 @vindex gnus-article-hide-pgp-hook
6523 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
6524 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6525 signature has been hidden.  For example, to automatically verify
6526 articles that have signatures in them do:
6527 @lisp
6528 ;;; Hide pgp cruft if any.
6529
6530 (setq gnus-treat-strip-pgp t)
6531
6532 ;;; After hiding pgp, verify the message;
6533 ;;; only happens if pgp signature is found.
6534
6535 (add-hook 'gnus-article-hide-pgp-hook
6536           (lambda ()
6537             (save-excursion
6538               (set-buffer gnus-original-article-buffer)
6539               (mc-verify))))
6540 @end lisp
6541
6542 @item W W P
6543 @kindex W W P (Summary)
6544 @findex gnus-article-hide-pem
6545 Hide @sc{pem} (privacy enhanced messages) cruft
6546 (@code{gnus-article-hide-pem}).
6547
6548 @item W W B
6549 @kindex W W B (Summary)
6550 @findex gnus-article-strip-banner
6551 Strip the banner specified by the @code{banner} group parameter
6552 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
6553 annoying banners and/or signatures that some mailing lists and moderated
6554 groups adds to all the messages.  The way to use this function is to add
6555 the @code{banner} group parameter (@pxref{Group Parameters}) to the
6556 group you want banners stripped from.  The parameter either be a string,
6557 which will be interpreted as a regular expression matching text to be
6558 removed, or the symbol @code{signature}, meaning that the (last)
6559 signature should be removed.
6560
6561 @item W W c
6562 @kindex W W c (Summary)
6563 @findex gnus-article-hide-citation
6564 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
6565 customizing the hiding:
6566
6567 @table @code
6568
6569 @item gnus-cited-opened-text-button-line-format
6570 @itemx gnus-cited-closed-text-button-line-format
6571 @vindex gnus-cited-closed-text-button-line-format
6572 @vindex gnus-cited-opened-text-button-line-format
6573 Gnus adds buttons to show where the cited text has been hidden, and to
6574 allow toggle hiding the text.  The format of the variable is specified
6575 by these format-like variable (@pxref{Formatting Variables}).  These
6576 specs are valid:
6577
6578 @table @samp
6579 @item b
6580 Starting point of the hidden text.
6581 @item e
6582 Ending point of the hidden text.
6583 @item l
6584 Number of characters in the hidden region.
6585 @item n
6586 Number of lines of hidden text.
6587 @end table
6588
6589 @item gnus-cited-lines-visible
6590 @vindex gnus-cited-lines-visible
6591 The number of lines at the beginning of the cited text to leave shown.
6592
6593 @end table
6594
6595 @item W W C-c
6596 @kindex W W C-c (Summary)
6597 @findex gnus-article-hide-citation-maybe
6598
6599 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6600 following two variables:
6601
6602 @table @code
6603 @item gnus-cite-hide-percentage
6604 @vindex gnus-cite-hide-percentage
6605 If the cited text is of a bigger percentage than this variable (default
6606 50), hide the cited text.
6607
6608 @item gnus-cite-hide-absolute
6609 @vindex gnus-cite-hide-absolute
6610 The cited text must have at least this length (default 10) before it
6611 is hidden.
6612 @end table
6613
6614 @item W W C
6615 @kindex W W C (Summary)
6616 @findex gnus-article-hide-citation-in-followups
6617 Hide cited text in articles that aren't roots
6618 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6619 useful as an interactive command, but might be a handy function to stick
6620 have happen automatically (@pxref{Customizing Articles}).
6621
6622 @end table
6623
6624 All these ``hiding'' commands are toggles, but if you give a negative
6625 prefix to these commands, they will show what they have previously
6626 hidden.  If you give a positive prefix, they will always hide.
6627
6628 Also @pxref{Article Highlighting} for further variables for
6629 citation customization.
6630
6631 @xref{Customizing Articles}, for how to hide article elements
6632 automatically.
6633
6634
6635 @node Article Washing
6636 @subsection Article Washing
6637 @cindex washing
6638 @cindex article washing
6639
6640 We call this ``article washing'' for a really good reason.  Namely, the
6641 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6642
6643 @dfn{Washing} is defined by us as ``changing something from something to
6644 something else'', but normally results in something looking better.
6645 Cleaner, perhaps.
6646
6647 @table @kbd
6648
6649 @item W l
6650 @kindex W l (Summary)
6651 @findex gnus-summary-stop-page-breaking
6652 Remove page breaks from the current article
6653 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
6654 delimiters.
6655
6656 @item W r
6657 @kindex W r (Summary)
6658 @findex gnus-summary-caesar-message
6659 @c @icon{gnus-summary-caesar-message}
6660 Do a Caesar rotate (rot13) on the article buffer
6661 (@code{gnus-summary-caesar-message}).
6662 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6663 (Typically offensive jokes and such.)
6664
6665 It's commonly called ``rot13'' because each letter is rotated 13
6666 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6667 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6668 is rumored to have employed this form of, uh, somewhat weak encryption.
6669
6670 @item W t
6671 @kindex W t (Summary)
6672 @findex gnus-summary-toggle-header
6673 Toggle whether to display all headers in the article buffer
6674 (@code{gnus-summary-toggle-header}).
6675
6676 @item W v
6677 @kindex W v (Summary)
6678 @findex gnus-summary-verbose-header
6679 Toggle whether to display all headers in the article buffer permanently
6680 (@code{gnus-summary-verbose-header}).
6681
6682 @item W m
6683 @kindex W m (Summary)
6684 @findex gnus-summary-toggle-mime
6685 Toggle whether to run the article through @sc{mime} before displaying
6686 (@code{gnus-summary-toggle-mime}).
6687
6688 @item W o
6689 @kindex W o (Summary)
6690 @findex gnus-article-treat-overstrike
6691 Treat overstrike (@code{gnus-article-treat-overstrike}).
6692
6693 @item W d
6694 @kindex W d (Summary)
6695 @findex gnus-article-treat-dumbquotes
6696 @vindex gnus-article-dumbquotes-map
6697 @cindex Smartquotes
6698 @cindex M******** sm*rtq**t*s
6699 @cindex Latin 1
6700 Treat M******** sm*rtq**t*s according to
6701 @code{gnus-article-dumbquotes-map}
6702 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
6703 whether a character is a sm*rtq**t* or not, so it should only be used
6704 interactively.
6705
6706 @item W w
6707 @kindex W w (Summary)
6708 @findex gnus-article-fill-cited-article
6709 Do word wrap (@code{gnus-article-fill-cited-article}).
6710
6711 You can give the command a numerical prefix to specify the width to use
6712 when filling.
6713
6714 @item W q
6715 @kindex W q (Summary)
6716 @findex gnus-article-fill-long-lines
6717 Fill long lines (@code{gnus-article-fill-long-lines}).
6718
6719 @item W C
6720 @kindex W C (Summary)
6721 @findex gnus-article-capitalize-sentencse
6722 Capitalize the first word in each sentence
6723 (@code{gnus-article-capitalize-sentences}).
6724
6725 @item W c
6726 @kindex W c (Summary)
6727 @findex gnus-article-remove-cr
6728 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6729 (this takes care of DOS line endings), and then translate any remaining
6730 CRs into LF (this takes care of Mac line endings)
6731 (@code{gnus-article-remove-cr}).
6732
6733 @item W f
6734 @kindex W f (Summary)
6735 @cindex x-face
6736 @findex gnus-article-display-x-face
6737 @findex gnus-article-x-face-command
6738 @vindex gnus-article-x-face-command
6739 @vindex gnus-article-x-face-too-ugly
6740 @iftex
6741 @iflatex
6742 \include{xface}
6743 @end iflatex
6744 @end iftex
6745 Look for and display any X-Face headers
6746 (@code{gnus-article-display-x-face}).  The command executed by this
6747 function is given by the @code{gnus-article-x-face-command} variable.
6748 If this variable is a string, this string will be executed in a
6749 sub-shell.  If it is a function, this function will be called with the
6750 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6751 is a regexp) matches the @code{From} header, the face will not be shown.
6752 The default action under Emacs is to fork off an @code{xv} to view the
6753 face; under XEmacs the default action is to display the face before the
6754 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6755 support---that will make display somewhat faster.  If there's no native
6756 X-Face support, Gnus will try to convert the @code{X-Face} header using
6757 external programs from the @code{pbmplus} package and friends.)  If you
6758 want to have this function in the display hook, it should probably come
6759 last.
6760
6761 @item W b
6762 @kindex W b (Summary)
6763 @findex gnus-article-add-buttons
6764 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6765 @xref{Article Buttons}.
6766
6767 @item W B
6768 @kindex W B (Summary)
6769 @findex gnus-article-add-buttons-to-head
6770 Add clickable buttons to the article headers
6771 (@code{gnus-article-add-buttons-to-head}).
6772
6773 @item W W H
6774 @kindex W W H (Summary)
6775 @findex gnus-article-strip-headers-from-body
6776 Strip headers like the @code{X-No-Archive} header from the beginning of
6777 article bodies (@code{gnus-article-strip-headers-from-body}).
6778
6779 @item W E l
6780 @kindex W E l (Summary)
6781 @findex gnus-article-strip-leading-blank-lines
6782 Remove all blank lines from the beginning of the article
6783 (@code{gnus-article-strip-leading-blank-lines}).
6784
6785 @item W E m
6786 @kindex W E m (Summary)
6787 @findex gnus-article-strip-multiple-blank-lines
6788 Replace all blank lines with empty lines and then all multiple empty
6789 lines with a single empty line.
6790 (@code{gnus-article-strip-multiple-blank-lines}).
6791
6792 @item W E t
6793 @kindex W E t (Summary)
6794 @findex gnus-article-remove-trailing-blank-lines
6795 Remove all blank lines at the end of the article
6796 (@code{gnus-article-remove-trailing-blank-lines}).
6797
6798 @item W E a
6799 @kindex W E a (Summary)
6800 @findex gnus-article-strip-blank-lines
6801 Do all the three commands above
6802 (@code{gnus-article-strip-blank-lines}).
6803
6804 @item W E A
6805 @kindex W E A (Summary)
6806 @findex gnus-article-strip-all-blank-lines
6807 Remove all blank lines
6808 (@code{gnus-article-strip-all-blank-lines}).
6809
6810 @item W E s
6811 @kindex W E s (Summary)
6812 @findex gnus-article-strip-leading-space
6813 Remove all white space from the beginning of all lines of the article
6814 body (@code{gnus-article-strip-leading-space}).
6815
6816 @item W E e
6817 @kindex W E e (Summary)
6818 @findex gnus-article-strip-trailing-space
6819 Remove all white space from the end of all lines of the article
6820 body (@code{gnus-article-strip-trailing-space}).
6821
6822 @end table
6823
6824 @xref{Customizing Articles}, for how to wash articles automatically.
6825
6826
6827 @node Article Buttons
6828 @subsection Article Buttons
6829 @cindex buttons
6830
6831 People often include references to other stuff in articles, and it would
6832 be nice if Gnus could just fetch whatever it is that people talk about
6833 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6834 button on these references.
6835
6836 Gnus adds @dfn{buttons} to certain standard references by default:
6837 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6838 two variables, one that handles article bodies and one that handles
6839 article heads:
6840
6841 @table @code
6842
6843 @item gnus-button-alist
6844 @vindex gnus-button-alist
6845 This is an alist where each entry has this form:
6846
6847 @lisp
6848 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6849 @end lisp
6850
6851 @table @var
6852
6853 @item regexp
6854 All text that match this regular expression will be considered an
6855 external reference.  Here's a typical regexp that matches embedded URLs:
6856 @samp{<URL:\\([^\n\r>]*\\)>}.
6857
6858 @item button-par
6859 Gnus has to know which parts of the matches is to be highlighted.  This
6860 is a number that says what sub-expression of the regexp is to be
6861 highlighted.  If you want it all highlighted, you use 0 here.
6862
6863 @item use-p
6864 This form will be @code{eval}ed, and if the result is non-@code{nil},
6865 this is considered a match.  This is useful if you want extra sifting to
6866 avoid false matches.
6867
6868 @item function
6869 This function will be called when you click on this button.
6870
6871 @item data-par
6872 As with @var{button-par}, this is a sub-expression number, but this one
6873 says which part of the match is to be sent as data to @var{function}.
6874
6875 @end table
6876
6877 So the full entry for buttonizing URLs is then
6878
6879 @lisp
6880 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6881 @end lisp
6882
6883 @item gnus-header-button-alist
6884 @vindex gnus-header-button-alist
6885 This is just like the other alist, except that it is applied to the
6886 article head only, and that each entry has an additional element that is
6887 used to say what headers to apply the buttonize coding to:
6888
6889 @lisp
6890 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6891 @end lisp
6892
6893 @var{HEADER} is a regular expression.
6894
6895 @item gnus-button-url-regexp
6896 @vindex gnus-button-url-regexp
6897 A regular expression that matches embedded URLs.  It is used in the
6898 default values of the variables above.
6899
6900 @item gnus-article-button-face
6901 @vindex gnus-article-button-face
6902 Face used on buttons.
6903
6904 @item gnus-article-mouse-face
6905 @vindex gnus-article-mouse-face
6906 Face used when the mouse cursor is over a button.
6907
6908 @end table
6909
6910 @xref{Customizing Articles}, for how to buttonize articles automatically.
6911
6912
6913 @node Article Date
6914 @subsection Article Date
6915
6916 The date is most likely generated in some obscure timezone you've never
6917 heard of, so it's quite nice to be able to find out what the time was
6918 when the article was sent.
6919
6920 @table @kbd
6921
6922 @item W T u
6923 @kindex W T u (Summary)
6924 @findex gnus-article-date-ut
6925 Display the date in UT (aka. GMT, aka ZULU)
6926 (@code{gnus-article-date-ut}).
6927
6928 @item W T i
6929 @kindex W T i (Summary)
6930 @findex gnus-article-date-iso8601
6931 @cindex ISO 8601
6932 Display the date in international format, aka. ISO 8601
6933 (@code{gnus-article-date-iso8601}).
6934
6935 @item W T l
6936 @kindex W T l (Summary)
6937 @findex gnus-article-date-local
6938 Display the date in the local timezone (@code{gnus-article-date-local}).
6939
6940 @item W T s
6941 @kindex W T s (Summary)
6942 @vindex gnus-article-time-format
6943 @findex gnus-article-date-user
6944 @findex format-time-string
6945 Display the date using a user-defined format
6946 (@code{gnus-article-date-user}).  The format is specified by the
6947 @code{gnus-article-time-format} variable, and is a string that's passed
6948 to @code{format-time-string}.  See the documentation of that variable
6949 for a list of possible format specs.
6950
6951 @item W T e
6952 @kindex W T e (Summary)
6953 @findex gnus-article-date-lapsed
6954 @findex gnus-start-date-timer
6955 @findex gnus-stop-date-timer
6956 Say how much time has elapsed between the article was posted and now
6957 (@code{gnus-article-date-lapsed}).  It looks something like:
6958
6959 @example
6960 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
6961 @end example
6962
6963 The value of @code{gnus-article-date-lapsed-new-header} determines
6964 whether this header will just be added below the old Date one, or will
6965 replace it.
6966
6967 An advantage of using Gnus to read mail is that it converts simple bugs
6968 into wonderful absurdities.
6969
6970 If you want to have this line updated continually, you can put
6971
6972 @lisp
6973 (gnus-start-date-timer)
6974 @end lisp
6975
6976 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6977 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6978 command.
6979
6980 @item W T o
6981 @kindex W T o (Summary)
6982 @findex gnus-article-date-original
6983 Display the original date (@code{gnus-article-date-original}).  This can
6984 be useful if you normally use some other conversion function and are
6985 worried that it might be doing something totally wrong.  Say, claiming
6986 that the article was posted in 1854.  Although something like that is
6987 @emph{totally} impossible.  Don't you trust me? *titter*
6988
6989 @end table
6990
6991 @xref{Customizing Articles}, for how to display the date in your
6992 preferred format automatically.
6993
6994
6995 @node Article Signature
6996 @subsection Article Signature
6997 @cindex signatures
6998 @cindex article signature
6999
7000 @vindex gnus-signature-separator
7001 Each article is divided into two parts---the head and the body.  The
7002 body can be divided into a signature part and a text part.  The variable
7003 that says what is to be considered a signature is
7004 @code{gnus-signature-separator}.  This is normally the standard
7005 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
7006 non-standard signature separators, so this variable can also be a list
7007 of regular expressions to be tested, one by one.  (Searches are done
7008 from the end of the body towards the beginning.)  One likely value is:
7009
7010 @lisp
7011 (setq gnus-signature-separator
7012       '("^-- $"         ; The standard
7013         "^-- *$"        ; A common mangling
7014         "^-------*$"    ; Many people just use a looong
7015                         ; line of dashes.  Shame!
7016         "^ *--------*$" ; Double-shame!
7017         "^________*$"   ; Underscores are also popular
7018         "^========*$")) ; Pervert!
7019 @end lisp
7020
7021 The more permissive you are, the more likely it is that you'll get false
7022 positives.
7023
7024 @vindex gnus-signature-limit
7025 @code{gnus-signature-limit} provides a limit to what is considered a
7026 signature.
7027
7028 @enumerate
7029 @item
7030 If it is an integer, no signature may be longer (in characters) than
7031 that integer.
7032 @item
7033 If it is a floating point number, no signature may be longer (in lines)
7034 than that number.
7035 @item
7036 If it is a function, the function will be called without any parameters,
7037 and if it returns @code{nil}, there is no signature in the buffer.
7038 @item
7039 If it is a string, it will be used as a regexp.  If it matches, the text
7040 in question is not a signature.
7041 @end enumerate
7042
7043 This variable can also be a list where the elements may be of the types
7044 listed above.  Here's an example:
7045
7046 @lisp
7047 (setq gnus-signature-limit
7048       '(200.0 "^---*Forwarded article"))
7049 @end lisp
7050
7051 This means that if there are more than 200 lines after the signature
7052 separator, or the text after the signature separator is matched by
7053 the regular expression @samp{^---*Forwarded article}, then it isn't a
7054 signature after all.
7055
7056
7057 @node Article Miscellania
7058 @subsection Article Miscellania
7059
7060 @table @kbd
7061 @item A t
7062 @kindex A t (Summary)
7063 @findex gnus-article-babel
7064 Translate the article from one language to another
7065 (@code{gnus-article-babel}). 
7066
7067 @end table
7068
7069
7070 @node MIME Commands
7071 @section @sc{mime} Commands
7072 @cindex MIME decoding
7073
7074 @table @kbd
7075 @item X m
7076 @kindex X m (Summary)
7077 @findex gnus-summary-save-parts
7078 Save all parts matching a @sc{mime} type to a directory
7079 (@code{gnus-summary-save-parts}).  Understands the process/prefix
7080 convention (@pxref{Process/Prefix}).
7081
7082 @item M-t
7083 @kindex M-t (Summary)
7084 @findex gnus-summary-display-buttonized
7085 Toggle the buttonized display of the article buffer
7086 (@code{gnus-summary-toggle-display-buttonized}).
7087
7088 @item W M w
7089 @kindex W M w (Summary)
7090 Decode RFC2047-encoded words in the article headers
7091 (@code{gnus-article-decode-mime-words}).
7092
7093 @item W M c
7094 @kindex W M c (Summary)
7095 Decode encoded article bodies as well as charsets
7096 (@code{gnus-article-decode-charset}).
7097
7098 This command looks in the @code{Content-Type} header to determine the
7099 charset.  If there is no such header in the article, you can give it a
7100 prefix, which will prompt for the charset to decode as.  In regional
7101 groups where people post using some common encoding (but do not include
7102 MIME headers), you can set the @code{charset} group/topic parameter to
7103 the required charset (@pxref{Group Parameters}).
7104
7105 @item W M v
7106 @kindex W M v (Summary)
7107 View all the @sc{mime} parts in the current article
7108 (@code{gnus-mime-view-all-parts}).
7109
7110 @end table
7111
7112 Relevant variables:
7113
7114 @table @code
7115 @item gnus-ignored-mime-types
7116 @vindex gnus-ignored-mime-types
7117 This is a list of regexps.  @sc{mime} types that match a regexp from
7118 this list will be completely ignored by Gnus.  The default value is
7119 @code{nil}.
7120
7121 To have all Vcards be ignored, you'd say something like this:
7122
7123 @lisp
7124 (setq gnus-ignored-mime-types
7125       '("text/x-vcard"))
7126 @end lisp
7127
7128 @item gnus-unbuttonized-mime-types
7129 @vindex gnus-unbuttonized-mime-types
7130 This is a list of regexps.  @sc{mime} types that match a regexp from
7131 this list won't have @sc{mime} buttons inserted unless they aren't
7132 displayed.  The default value is @code{(".*/.*")}.
7133
7134 @item gnus-article-mime-part-function
7135 @vindex gnus-article-mime-part-function
7136 For each @sc{mime} part, this function will be called with the @sc{mime}
7137 handle as the parameter.  The function is meant to be used to allow
7138 users to gather information from the article (e. g., add Vcard info to
7139 the bbdb database) or to do actions based on parts (e. g., automatically
7140 save all jpegs into some directory).
7141
7142 Here's an example function the does the latter:
7143
7144 @lisp
7145 (defun my-save-all-jpeg-parts (handle)
7146   (when (equal (car (mm-handle-type handle)) "image/jpeg")
7147     (with-temp-buffer
7148       (insert (mm-get-part handle))
7149       (write-region (point-min) (point-max)
7150                     (read-file-name "Save jpeg to: ")))))
7151 (setq gnus-article-mime-part-function
7152       'my-save-all-jpeg-parts)
7153 @end lisp
7154
7155 @vindex gnus-mime-multipart-functions
7156 @item gnus-mime-multipart-functions
7157 Alist of @sc{mime} multipart types and functions to handle them.
7158
7159 @end table
7160
7161
7162 @node Charsets
7163 @section Charsets
7164 @cindex charsets
7165
7166 People use different charsets, and we have @sc{mime} to let us know what
7167 charsets they use.  Or rather, we wish we had.  Many people use
7168 newsreaders and mailers that do not understand or use @sc{mime}, and
7169 just send out messages without saying what character sets they use.  To
7170 help a bit with this, some local news hierarchies have policies that say
7171 what character set is the default.  For instance, the @samp{fj}
7172 hierarchy uses @code{iso-2022-jp-2}.
7173
7174 @vindex gnus-group-charset-alist
7175 This knowledge is encoded in the @code{gnus-group-charset-alist}
7176 variable, which is an alist of regexps (to match group names) and
7177 default charsets to be used when reading these groups.
7178
7179 In addition, some people do use soi-disant @sc{mime}-aware agents that
7180 aren't.  These blitely mark messages as being in @code{iso-8859-1} even
7181 if they really are in @code{koi-8}.  To help here, the
7182 @code{gnus-newsgroup-ignored-charsets} variable can be used.  The
7183 charsets that are listed here will be ignored.  The variable can be set
7184 on a group-by-group basis using the group parameters (@pxref{Group
7185 Parameters}).  The default value is @code{(unknown-8bit)}, which is
7186 something some agents insist on having in there.
7187
7188
7189 @node Article Commands
7190 @section Article Commands
7191
7192 @table @kbd
7193
7194 @item A P
7195 @cindex PostScript
7196 @cindex printing
7197 @kindex A P (Summary)
7198 @vindex gnus-ps-print-hook
7199 @findex gnus-summary-print-article
7200 Generate and print a PostScript image of the article buffer
7201 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
7202 run just before printing the buffer.
7203
7204 @end table
7205
7206
7207 @node Summary Sorting
7208 @section Summary Sorting
7209 @cindex summary sorting
7210
7211 You can have the summary buffer sorted in various ways, even though I
7212 can't really see why you'd want that.
7213
7214 @table @kbd
7215
7216 @item C-c C-s C-n
7217 @kindex C-c C-s C-n (Summary)
7218 @findex gnus-summary-sort-by-number
7219 Sort by article number (@code{gnus-summary-sort-by-number}).
7220
7221 @item C-c C-s C-a
7222 @kindex C-c C-s C-a (Summary)
7223 @findex gnus-summary-sort-by-author
7224 Sort by author (@code{gnus-summary-sort-by-author}).
7225
7226 @item C-c C-s C-s
7227 @kindex C-c C-s C-s (Summary)
7228 @findex gnus-summary-sort-by-subject
7229 Sort by subject (@code{gnus-summary-sort-by-subject}).
7230
7231 @item C-c C-s C-d
7232 @kindex C-c C-s C-d (Summary)
7233 @findex gnus-summary-sort-by-date
7234 Sort by date (@code{gnus-summary-sort-by-date}).
7235
7236 @item C-c C-s C-l
7237 @kindex C-c C-s C-l (Summary)
7238 @findex gnus-summary-sort-by-lines
7239 Sort by lines (@code{gnus-summary-sort-by-lines}).
7240
7241 @item C-c C-s C-c
7242 @kindex C-c C-s C-c (Summary)
7243 @findex gnus-summary-sort-by-chars
7244 Sort by article length (@code{gnus-summary-sort-by-chars}).
7245
7246 @item C-c C-s C-i
7247 @kindex C-c C-s C-i (Summary)
7248 @findex gnus-summary-sort-by-score
7249 Sort by score (@code{gnus-summary-sort-by-score}).
7250 @end table
7251
7252 These functions will work both when you use threading and when you don't
7253 use threading.  In the latter case, all summary lines will be sorted,
7254 line by line.  In the former case, sorting will be done on a
7255 root-by-root basis, which might not be what you were looking for.  To
7256 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7257 Commands}).
7258
7259
7260 @node Finding the Parent
7261 @section Finding the Parent
7262 @cindex parent articles
7263 @cindex referring articles
7264
7265 @table @kbd
7266 @item ^
7267 @kindex ^ (Summary)
7268 @findex gnus-summary-refer-parent-article
7269 If you'd like to read the parent of the current article, and it is not
7270 displayed in the summary buffer, you might still be able to.  That is,
7271 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7272 and the @code{References} in the current article are not mangled, you
7273 can just press @kbd{^} or @kbd{A r}
7274 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
7275 you'll get the parent.  If the parent is already displayed in the
7276 summary buffer, point will just move to this article.
7277
7278 If given a positive numerical prefix, fetch that many articles back into
7279 the ancestry.  If given a negative numerical prefix, fetch just that
7280 ancestor.  So if you say @kbd{3 ^}, gnus will fetch the parent, the
7281 grandparent and the grandgrandparent of the current article.  If you say
7282 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
7283 article.
7284
7285 @item A R (Summary)
7286 @findex gnus-summary-refer-references
7287 @kindex A R (Summary)
7288 Fetch all articles mentioned in the @code{References} header of the
7289 article (@code{gnus-summary-refer-references}).
7290
7291 @item A T (Summary)
7292 @findex gnus-summary-refer-thread
7293 @kindex A T (Summary)
7294 Display the full thread where the current article appears
7295 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
7296 headers in the current group to work, so it usually takes a while.  If
7297 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7298 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
7299 visible effects normally, but it'll make this command work a whole lot
7300 faster.  Of course, it'll make group entry somewhat slow.
7301
7302 @vindex gnus-refer-thread-limit
7303 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7304 articles before the first displayed in the current group) headers to
7305 fetch when doing this command.  The default is 200.  If @code{t}, all
7306 the available headers will be fetched.  This variable can be overridden
7307 by giving the @kbd{A T} command a numerical prefix.
7308
7309 @item M-^ (Summary)
7310 @findex gnus-summary-refer-article
7311 @kindex M-^ (Summary)
7312 @cindex Message-ID
7313 @cindex fetching by Message-ID
7314 You can also ask the @sc{nntp} server for an arbitrary article, no
7315 matter what group it belongs to.  @kbd{M-^}
7316 (@code{gnus-summary-refer-article}) will ask you for a
7317 @code{Message-ID}, which is one of those long, hard-to-read thingies
7318 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
7319 have to get it all exactly right.  No fuzzy searches, I'm afraid.
7320 @end table
7321
7322 The current select method will be used when fetching by
7323 @code{Message-ID} from non-news select method, but you can override this
7324 by giving this command a prefix.
7325
7326 @vindex gnus-refer-article-method
7327 If the group you are reading is located on a backend that does not
7328 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7329 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
7330 would, perhaps, be best if the @sc{nntp} server you consult is the one
7331 updating the spool you are reading from, but that's not really
7332 necessary.
7333
7334 Most of the mail backends support fetching by @code{Message-ID}, but do
7335 not do a particularly excellent job at it.  That is, @code{nnmbox} and
7336 @code{nnbabyl} are able to locate articles from any groups, while
7337 @code{nnml} and @code{nnfolder} are only able to locate articles that
7338 have been posted to the current group.  (Anything else would be too time
7339 consuming.)  @code{nnmh} does not support this at all.
7340
7341
7342 @node Alternative Approaches
7343 @section Alternative Approaches
7344
7345 Different people like to read news using different methods.  This being
7346 gnus, we offer a small selection of minor modes for the summary buffers.
7347
7348 @menu
7349 * Pick and Read::               First mark articles and then read them.
7350 * Binary Groups::               Auto-decode all articles.
7351 @end menu
7352
7353
7354 @node Pick and Read
7355 @subsection Pick and Read
7356 @cindex pick and read
7357
7358 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7359 a two-phased reading interface.  The user first marks in a summary
7360 buffer the articles she wants to read.  Then she starts reading the
7361 articles with just an article buffer displayed.
7362
7363 @findex gnus-pick-mode
7364 @kindex M-x gnus-pick-mode
7365 Gnus provides a summary buffer minor mode that allows
7366 this---@code{gnus-pick-mode}.  This basically means that a few process
7367 mark commands become one-keystroke commands to allow easy marking, and
7368 it provides one additional command for switching to the summary buffer.
7369
7370 Here are the available keystrokes when using pick mode:
7371
7372 @table @kbd
7373 @item .
7374 @kindex . (Pick)
7375 @findex gnus-pick-article-or-thread
7376 Pick the article or thread on the current line
7377 (@code{gnus-pick-article-or-thread}).  If the variable
7378 @code{gnus-thread-hide-subtree} is true, then this key selects the
7379 entire thread when used at the first article of the thread.  Otherwise,
7380 it selects just the article. If given a numerical prefix, go to that
7381 thread or article and pick it.  (The line number is normally displayed
7382 at the beginning of the summary pick lines.)
7383
7384 @item SPACE
7385 @kindex SPACE (Pick)
7386 @findex gnus-pick-next-page
7387 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
7388 at the end of the buffer, start reading the picked articles.
7389
7390 @item u
7391 @kindex u (Pick)
7392 @findex gnus-pick-unmark-article-or-thread.
7393 Unpick the thread or article
7394 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
7395 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7396 thread if used at the first article of the thread.  Otherwise it unpicks
7397 just the article.  You can give this key a numerical prefix to unpick
7398 the thread or article at that line.
7399
7400 @item RET
7401 @kindex RET (Pick)
7402 @findex gnus-pick-start-reading
7403 @vindex gnus-pick-display-summary
7404 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
7405 given a prefix, mark all unpicked articles as read first.  If
7406 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7407 will still be visible when you are reading.
7408
7409 @end table
7410
7411 All the normal summary mode commands are still available in the
7412 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
7413 which is mapped to the same function
7414 @code{gnus-summary-tick-article-forward}.
7415
7416 If this sounds like a good idea to you, you could say:
7417
7418 @lisp
7419 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7420 @end lisp
7421
7422 @vindex gnus-pick-mode-hook
7423 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7424
7425 @vindex gnus-mark-unpicked-articles-as-read
7426 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7427 all unpicked articles as read.  The default is @code{nil}.
7428
7429 @vindex gnus-summary-pick-line-format
7430 The summary line format in pick mode is slightly different from the
7431 standard format.  At the beginning of each line the line number is
7432 displayed.  The pick mode line format is controlled by the
7433 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7434 Variables}).  It accepts the same format specs that
7435 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7436
7437
7438 @node Binary Groups
7439 @subsection Binary Groups
7440 @cindex binary groups
7441
7442 @findex gnus-binary-mode
7443 @kindex M-x gnus-binary-mode
7444 If you spend much time in binary groups, you may grow tired of hitting
7445 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
7446 is a minor mode for summary buffers that makes all ordinary Gnus article
7447 selection functions uudecode series of articles and display the result
7448 instead of just displaying the articles the normal way.
7449
7450 @kindex g (Binary)
7451 @findex gnus-binary-show-article
7452 The only way, in fact, to see the actual articles is the @kbd{g}
7453 command, when you have turned on this mode
7454 (@code{gnus-binary-show-article}).
7455
7456 @vindex gnus-binary-mode-hook
7457 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7458
7459
7460 @node Tree Display
7461 @section Tree Display
7462 @cindex trees
7463
7464 @vindex gnus-use-trees
7465 If you don't like the normal gnus summary display, you might try setting
7466 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
7467 additional @dfn{tree buffer}.  You can execute all summary mode commands
7468 in the tree buffer.
7469
7470 There are a few variables to customize the tree display, of course:
7471
7472 @table @code
7473 @item gnus-tree-mode-hook
7474 @vindex gnus-tree-mode-hook
7475 A hook called in all tree mode buffers.
7476
7477 @item gnus-tree-mode-line-format
7478 @vindex gnus-tree-mode-line-format
7479 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7480 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
7481 of valid specs, @pxref{Summary Buffer Mode Line}.
7482
7483 @item gnus-selected-tree-face
7484 @vindex gnus-selected-tree-face
7485 Face used for highlighting the selected article in the tree buffer.  The
7486 default is @code{modeline}.
7487
7488 @item gnus-tree-line-format
7489 @vindex gnus-tree-line-format
7490 A format string for the tree nodes.  The name is a bit of a misnomer,
7491 though---it doesn't define a line, but just the node.  The default value
7492 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7493 the name of the poster.  It is vital that all nodes are of the same
7494 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7495
7496 Valid specs are:
7497
7498 @table @samp
7499 @item n
7500 The name of the poster.
7501 @item f
7502 The @code{From} header.
7503 @item N
7504 The number of the article.
7505 @item [
7506 The opening bracket.
7507 @item ]
7508 The closing bracket.
7509 @item s
7510 The subject.
7511 @end table
7512
7513 @xref{Formatting Variables}.
7514
7515 Variables related to the display are:
7516
7517 @table @code
7518 @item gnus-tree-brackets
7519 @vindex gnus-tree-brackets
7520 This is used for differentiating between ``real'' articles and
7521 ``sparse'' articles.  The format is @var{((real-open . real-close)
7522 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7523 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7524
7525 @item gnus-tree-parent-child-edges
7526 @vindex gnus-tree-parent-child-edges
7527 This is a list that contains the characters used for connecting parent
7528 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
7529
7530 @end table
7531
7532 @item gnus-tree-minimize-window
7533 @vindex gnus-tree-minimize-window
7534 If this variable is non-@code{nil}, gnus will try to keep the tree
7535 buffer as small as possible to allow more room for the other gnus
7536 windows.  If this variable is a number, the tree buffer will never be
7537 higher than that number.  The default is @code{t}.  Note that if you
7538 have several windows displayed side-by-side in a frame and the tree
7539 buffer is one of these, minimizing the tree window will also resize all
7540 other windows displayed next to it.
7541
7542 @item gnus-generate-tree-function
7543 @vindex gnus-generate-tree-function
7544 @findex gnus-generate-horizontal-tree
7545 @findex gnus-generate-vertical-tree
7546 The function that actually generates the thread tree.  Two predefined
7547 functions are available: @code{gnus-generate-horizontal-tree} and
7548 @code{gnus-generate-vertical-tree} (which is the default).
7549
7550 @end table
7551
7552 Here's an example from a horizontal tree buffer:
7553
7554 @example
7555 @{***@}-(***)-[odd]-[Gun]
7556      |      \[Jan]
7557      |      \[odd]-[Eri]
7558      |      \(***)-[Eri]
7559      |            \[odd]-[Paa]
7560      \[Bjo]
7561      \[Gun]
7562      \[Gun]-[Jor]
7563 @end example
7564
7565 Here's the same thread displayed in a vertical tree buffer:
7566
7567 @example
7568 @{***@}
7569   |--------------------------\-----\-----\
7570 (***)                         [Bjo] [Gun] [Gun]
7571   |--\-----\-----\                          |
7572 [odd] [Jan] [odd] (***)                   [Jor]
7573   |           |     |--\
7574 [Gun]       [Eri] [Eri] [odd]
7575                           |
7576                         [Paa]
7577 @end example
7578
7579 If you're using horizontal trees, it might be nice to display the trees
7580 side-by-side with the summary buffer.  You could add something like the
7581 following to your @file{.gnus.el} file:
7582
7583 @lisp
7584 (setq gnus-use-trees t
7585       gnus-generate-tree-function 'gnus-generate-horizontal-tree
7586       gnus-tree-minimize-window nil)
7587 (gnus-add-configuration
7588  '(article
7589    (vertical 1.0
7590              (horizontal 0.25
7591                          (summary 0.75 point)
7592                          (tree 1.0))
7593              (article 1.0))))
7594 @end lisp
7595
7596 @xref{Windows Configuration}.
7597
7598
7599 @node Mail Group Commands
7600 @section Mail Group Commands
7601 @cindex mail group commands
7602
7603 Some commands only make sense in mail groups.  If these commands are
7604 invalid in the current group, they will raise a hell and let you know.
7605
7606 All these commands (except the expiry and edit commands) use the
7607 process/prefix convention (@pxref{Process/Prefix}).
7608
7609 @table @kbd
7610
7611 @item B e
7612 @kindex B e (Summary)
7613 @findex gnus-summary-expire-articles
7614 Expire all expirable articles in the group
7615 (@code{gnus-summary-expire-articles}).
7616
7617 @item B M-C-e
7618 @kindex B M-C-e (Summary)
7619 @findex gnus-summary-expire-articles-now
7620 Delete all the expirable articles in the group
7621 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
7622 articles eligible for expiry in the current group will
7623 disappear forever into that big @file{/dev/null} in the sky.
7624
7625 @item B DEL
7626 @kindex B DEL (Summary)
7627 @findex gnus-summary-delete-article
7628 @c @icon{gnus-summary-mail-delete}
7629 Delete the mail article.  This is ``delete'' as in ``delete it from your
7630 disk forever and ever, never to return again.'' Use with caution.
7631 (@code{gnus-summary-delete-article}).
7632
7633 @item B m
7634 @kindex B m (Summary)
7635 @cindex move mail
7636 @findex gnus-summary-move-article
7637 Move the article from one mail group to another
7638 (@code{gnus-summary-move-article}).
7639
7640 @item B c
7641 @kindex B c (Summary)
7642 @cindex copy mail
7643 @findex gnus-summary-copy-article
7644 @c @icon{gnus-summary-mail-copy}
7645 Copy the article from one group (mail group or not) to a mail group
7646 (@code{gnus-summary-copy-article}).
7647
7648 @item B B
7649 @kindex B B (Summary)
7650 @cindex crosspost mail
7651 @findex gnus-summary-crosspost-article
7652 Crosspost the current article to some other group
7653 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
7654 the article in the other group, and the Xref headers of the article will
7655 be properly updated.
7656
7657 @item B i
7658 @kindex B i (Summary)
7659 @findex gnus-summary-import-article
7660 Import an arbitrary file into the current mail newsgroup
7661 (@code{gnus-summary-import-article}).  You will be prompted for a file
7662 name, a @code{From} header and a @code{Subject} header.
7663
7664 @item B r
7665 @kindex B r (Summary)
7666 @findex gnus-summary-respool-article
7667 Respool the mail article (@code{gnus-summary-respool-article}).
7668 @code{gnus-summary-respool-default-method} will be used as the default
7669 select method when respooling.  This variable is @code{nil} by default,
7670 which means that the current group select method will be used instead.
7671
7672 @item B w
7673 @itemx e
7674 @kindex B w (Summary)
7675 @kindex e (Summary)
7676 @findex gnus-summary-edit-article
7677 @kindex C-c C-c (Article)
7678 Edit the current article (@code{gnus-summary-edit-article}).  To finish
7679 editing and make the changes permanent, type @kbd{C-c C-c}
7680 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
7681 @kbd{C-c C-c} command, gnus won't re-highlight the article.
7682
7683 @item B q
7684 @kindex B q (Summary)
7685 @findex gnus-summary-respool-query
7686 If you want to re-spool an article, you might be curious as to what group
7687 the article will end up in before you do the re-spooling.  This command
7688 will tell you (@code{gnus-summary-respool-query}).
7689
7690 @item B t
7691 @kindex B t (Summary)
7692 @findex gnus-summary-respool-trace
7693 Similarly, this command will display all fancy splitting patterns used
7694 when repooling, if any (@code{gnus-summary-respool-trace}).
7695
7696 @item B p
7697 @kindex B p (Summary)
7698 @findex gnus-summary-article-posted-p
7699 Some people have a tendency to send you "courtesy" copies when they
7700 follow up to articles you have posted.  These usually have a
7701 @code{Newsgroups} header in them, but not always.  This command
7702 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7703 article from your news server (or rather, from
7704 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7705 report back whether it found the article or not.  Even if it says that
7706 it didn't find the article, it may have been posted anyway---mail
7707 propagation is much faster than news propagation, and the news copy may
7708 just not have arrived yet.
7709
7710 @end table
7711
7712 @vindex gnus-move-split-methods
7713 @cindex moving articles
7714 If you move (or copy) articles regularly, you might wish to have gnus
7715 suggest where to put the articles.  @code{gnus-move-split-methods} is a
7716 variable that uses the same syntax as @code{gnus-split-methods}
7717 (@pxref{Saving Articles}).  You may customize that variable to create
7718 suggestions you find reasonable.
7719
7720 @lisp
7721 (setq gnus-move-split-methods
7722       '(("^From:.*Lars Magne" "nnml:junk")
7723         ("^Subject:.*gnus" "nnfolder:important")
7724         (".*" "nnml:misc")))
7725 @end lisp
7726
7727
7728 @node Various Summary Stuff
7729 @section Various Summary Stuff
7730
7731 @menu
7732 * Summary Group Information::         Information oriented commands.
7733 * Searching for Articles::            Multiple article commands.
7734 * Summary Generation Commands::       (Re)generating the summary buffer.
7735 * Really Various Summary Commands::   Those pesky non-conformant commands.
7736 @end menu
7737
7738 @table @code
7739 @vindex gnus-summary-mode-hook
7740 @item gnus-summary-mode-hook
7741 This hook is called when creating a summary mode buffer.
7742
7743 @vindex gnus-summary-generate-hook
7744 @item gnus-summary-generate-hook
7745 This is called as the last thing before doing the threading and the
7746 generation of the summary buffer.  It's quite convenient for customizing
7747 the threading variables based on what data the newsgroup has.  This hook
7748 is called from the summary buffer after most summary buffer variables
7749 have been set.
7750
7751 @vindex gnus-summary-prepare-hook
7752 @item gnus-summary-prepare-hook
7753 It is called after the summary buffer has been generated.  You might use
7754 it to, for instance, highlight lines or modify the look of the buffer in
7755 some other ungodly manner.  I don't care.
7756
7757 @vindex gnus-summary-prepared-hook
7758 @item gnus-summary-prepared-hook
7759 A hook called as the very last thing after the summary buffer has been
7760 generated.
7761
7762 @vindex gnus-summary-ignore-duplicates
7763 @item gnus-summary-ignore-duplicates
7764 When gnus discovers two articles that have the same @code{Message-ID},
7765 it has to do something drastic.  No articles are allowed to have the
7766 same @code{Message-ID}, but this may happen when reading mail from some
7767 sources.  Gnus allows you to customize what happens with this variable.
7768 If it is @code{nil} (which is the default), gnus will rename the
7769 @code{Message-ID} (for display purposes only) and display the article as
7770 any other article.  If this variable is @code{t}, it won't display the
7771 article---it'll be as if it never existed.
7772
7773 @end table
7774
7775
7776 @node Summary Group Information
7777 @subsection Summary Group Information
7778
7779 @table @kbd
7780
7781 @item H f
7782 @kindex H f (Summary)
7783 @findex gnus-summary-fetch-faq
7784 @vindex gnus-group-faq-directory
7785 Try to fetch the FAQ (list of frequently asked questions) for the
7786 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7787 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7788 on a remote machine.  This variable can also be a list of directories.
7789 In that case, giving a prefix to this command will allow you to choose
7790 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7791 be used for fetching the file.
7792
7793 @item H d
7794 @kindex H d (Summary)
7795 @findex gnus-summary-describe-group
7796 Give a brief description of the current group
7797 (@code{gnus-summary-describe-group}).  If given a prefix, force
7798 rereading the description from the server.
7799
7800 @item H h
7801 @kindex H h (Summary)
7802 @findex gnus-summary-describe-briefly
7803 Give an extremely brief description of the most important summary
7804 keystrokes (@code{gnus-summary-describe-briefly}).
7805
7806 @item H i
7807 @kindex H i (Summary)
7808 @findex gnus-info-find-node
7809 Go to the gnus info node (@code{gnus-info-find-node}).
7810 @end table
7811
7812
7813 @node Searching for Articles
7814 @subsection Searching for Articles
7815
7816 @table @kbd
7817
7818 @item M-s
7819 @kindex M-s (Summary)
7820 @findex gnus-summary-search-article-forward
7821 Search through all subsequent articles for a regexp
7822 (@code{gnus-summary-search-article-forward}).
7823
7824 @item M-r
7825 @kindex M-r (Summary)
7826 @findex gnus-summary-search-article-backward
7827 Search through all previous articles for a regexp
7828 (@code{gnus-summary-search-article-backward}).
7829
7830 @item &
7831 @kindex & (Summary)
7832 @findex gnus-summary-execute-command
7833 This command will prompt you for a header field, a regular expression to
7834 match on this field, and a command to be executed if the match is made
7835 (@code{gnus-summary-execute-command}).  If given a prefix, search
7836 backward instead.
7837
7838 @item M-&
7839 @kindex M-& (Summary)
7840 @findex gnus-summary-universal-argument
7841 Perform any operation on all articles that have been marked with
7842 the process mark (@code{gnus-summary-universal-argument}).
7843 @end table
7844
7845 @node Summary Generation Commands
7846 @subsection Summary Generation Commands
7847
7848 @table @kbd
7849
7850 @item Y g
7851 @kindex Y g (Summary)
7852 @findex gnus-summary-prepare
7853 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7854
7855 @item Y c
7856 @kindex Y c (Summary)
7857 @findex gnus-summary-insert-cached-articles
7858 Pull all cached articles (for the current group) into the summary buffer
7859 (@code{gnus-summary-insert-cached-articles}).
7860
7861 @end table
7862
7863
7864 @node Really Various Summary Commands
7865 @subsection Really Various Summary Commands
7866
7867 @table @kbd
7868
7869 @item A D
7870 @itemx C-d
7871 @kindex C-d (Summary)
7872 @kindex A D (Summary)
7873 @findex gnus-summary-enter-digest-group
7874 If the current article is a collection of other articles (for instance,
7875 a digest), you might use this command to enter a group based on the that
7876 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7877 guess what article type is currently displayed unless you give a prefix
7878 to this command, which forces a ``digest'' interpretation.  Basically,
7879 whenever you see a message that is a collection of other messages of
7880 some format, you @kbd{C-d} and read these messages in a more convenient
7881 fashion.
7882
7883 @item M-C-d
7884 @kindex M-C-d (Summary)
7885 @findex gnus-summary-read-document
7886 This command is very similar to the one above, but lets you gather
7887 several documents into one biiig group
7888 (@code{gnus-summary-read-document}).  It does this by opening several
7889 @code{nndoc} groups for each document, and then opening an
7890 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7891 command understands the process/prefix convention
7892 (@pxref{Process/Prefix}).
7893
7894 @item C-t
7895 @kindex C-t (Summary)
7896 @findex gnus-summary-toggle-truncation
7897 Toggle truncation of summary lines
7898 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7899 line centering function in the summary buffer, so it's not a good idea
7900 to have truncation switched off while reading articles.
7901
7902 @item =
7903 @kindex = (Summary)
7904 @findex gnus-summary-expand-window
7905 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7906 If given a prefix, force an @code{article} window configuration.
7907
7908 @item M-C-e
7909 @kindex M-C-e (Summary)
7910 @findex gnus-summary-edit-parameters
7911 Edit the group parameters (@pxref{Group Parameters}) of the current
7912 group (@code{gnus-summary-edit-parameters}).
7913
7914 @item M-C-g
7915 @kindex M-C-g (Summary)
7916 @findex gnus-summary-customize-parameters
7917 Customize the group parameters (@pxref{Group Parameters}) of the current
7918 group (@code{gnus-summary-customize-parameters}).
7919
7920 @end table
7921
7922
7923 @node Exiting the Summary Buffer
7924 @section Exiting the Summary Buffer
7925 @cindex summary exit
7926 @cindex exiting groups
7927
7928 Exiting from the summary buffer will normally update all info on the
7929 group and return you to the group buffer.
7930
7931 @table @kbd
7932
7933 @item Z Z
7934 @itemx q
7935 @kindex Z Z (Summary)
7936 @kindex q (Summary)
7937 @findex gnus-summary-exit
7938 @vindex gnus-summary-exit-hook
7939 @vindex gnus-summary-prepare-exit-hook
7940 @c @icon{gnus-summary-exit}
7941 Exit the current group and update all information on the group
7942 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7943 called before doing much of the exiting, which calls
7944 @code{gnus-summary-expire-articles} by default.
7945 @code{gnus-summary-exit-hook} is called after finishing the exit
7946 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7947 group mode having no more (unread) groups.
7948
7949 @item Z E
7950 @itemx Q
7951 @kindex Z E (Summary)
7952 @kindex Q (Summary)
7953 @findex gnus-summary-exit-no-update
7954 Exit the current group without updating any information on the group
7955 (@code{gnus-summary-exit-no-update}).
7956
7957 @item Z c
7958 @itemx c
7959 @kindex Z c (Summary)
7960 @kindex c (Summary)
7961 @findex gnus-summary-catchup-and-exit
7962 @c @icon{gnus-summary-catchup-and-exit}
7963 Mark all unticked articles in the group as read and then exit
7964 (@code{gnus-summary-catchup-and-exit}).
7965
7966 @item Z C
7967 @kindex Z C (Summary)
7968 @findex gnus-summary-catchup-all-and-exit
7969 Mark all articles, even the ticked ones, as read and then exit
7970 (@code{gnus-summary-catchup-all-and-exit}).
7971
7972 @item Z n
7973 @kindex Z n (Summary)
7974 @findex gnus-summary-catchup-and-goto-next-group
7975 Mark all articles as read and go to the next group
7976 (@code{gnus-summary-catchup-and-goto-next-group}).
7977
7978 @item Z R
7979 @kindex Z R (Summary)
7980 @findex gnus-summary-reselect-current-group
7981 Exit this group, and then enter it again
7982 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7983 all articles, both read and unread.
7984
7985 @item Z G
7986 @itemx M-g
7987 @kindex Z G (Summary)
7988 @kindex M-g (Summary)
7989 @findex gnus-summary-rescan-group
7990 @c @icon{gnus-summary-mail-get}
7991 Exit the group, check for new articles in the group, and select the
7992 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7993 articles, both read and unread.
7994
7995 @item Z N
7996 @kindex Z N (Summary)
7997 @findex gnus-summary-next-group
7998 Exit the group and go to the next group
7999 (@code{gnus-summary-next-group}).
8000
8001 @item Z P
8002 @kindex Z P (Summary)
8003 @findex gnus-summary-prev-group
8004 Exit the group and go to the previous group
8005 (@code{gnus-summary-prev-group}).
8006
8007 @item Z s
8008 @kindex Z s (Summary)
8009 @findex gnus-summary-save-newsrc
8010 Save the current number of read/marked articles in the dribble buffer
8011 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
8012 given a prefix, also save the @file{.newsrc} file(s).  Using this
8013 command will make exit without updating (the @kbd{Q} command) worthless.
8014 @end table
8015
8016 @vindex gnus-exit-group-hook
8017 @code{gnus-exit-group-hook} is called when you exit the current
8018 group.
8019
8020 @findex gnus-summary-wake-up-the-dead
8021 @findex gnus-dead-summary-mode
8022 @vindex gnus-kill-summary-on-exit
8023 If you're in the habit of exiting groups, and then changing your mind
8024 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8025 If you do that, gnus won't kill the summary buffer when you exit it.
8026 (Quelle surprise!)  Instead it will change the name of the buffer to
8027 something like @samp{*Dead Summary ... *} and install a minor mode
8028 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
8029 buffer, you'll find that all keys are mapped to a function called
8030 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
8031 summary buffer will result in a live, normal summary buffer.
8032
8033 There will never be more than one dead summary buffer at any one time.
8034
8035 @vindex gnus-use-cross-reference
8036 The data on the current group will be updated (which articles you have
8037 read, which articles you have replied to, etc.) when you exit the
8038 summary buffer.  If the @code{gnus-use-cross-reference} variable is
8039 @code{t} (which is the default), articles that are cross-referenced to
8040 this group and are marked as read, will also be marked as read in the
8041 other subscribed groups they were cross-posted to.  If this variable is
8042 neither @code{nil} nor @code{t}, the article will be marked as read in
8043 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8044
8045
8046 @node Crosspost Handling
8047 @section Crosspost Handling
8048
8049 @cindex velveeta
8050 @cindex spamming
8051 Marking cross-posted articles as read ensures that you'll never have to
8052 read the same article more than once.  Unless, of course, somebody has
8053 posted it to several groups separately.  Posting the same article to
8054 several groups (not cross-posting) is called @dfn{spamming}, and you are
8055 by law required to send nasty-grams to anyone who perpetrates such a
8056 heinous crime.  You may want to try NoCeM handling to filter out spam
8057 (@pxref{NoCeM}).
8058
8059 Remember: Cross-posting is kinda ok, but posting the same article
8060 separately to several groups is not.  Massive cross-posting (aka.
8061 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8062 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8063 excessive crossposting (@pxref{Summary Mail Commands}).
8064
8065 @cindex cross-posting
8066 @cindex Xref
8067 @cindex @sc{nov}
8068 One thing that may cause Gnus to not do the cross-posting thing
8069 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8070 (which is very nice, because it speeds things up considerably) which
8071 does not include the @code{Xref} header in its @sc{nov} lines.  This is
8072 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
8073 even with @sc{xover} by registering the @code{Xref} lines of all
8074 articles you actually read, but if you kill the articles, or just mark
8075 them as read without reading them, Gnus will not get a chance to snoop
8076 the @code{Xref} lines out of these articles, and will be unable to use
8077 the cross reference mechanism.
8078
8079 @cindex LIST overview.fmt
8080 @cindex overview.fmt
8081 To check whether your @sc{nntp} server includes the @code{Xref} header
8082 in its overview files, try @samp{telnet your.nntp.server nntp},
8083 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8084 overview.fmt}.  This may not work, but if it does, and the last line you
8085 get does not read @samp{Xref:full}, then you should shout and whine at
8086 your news admin until she includes the @code{Xref} header in the
8087 overview files.
8088
8089 @vindex gnus-nov-is-evil
8090 If you want Gnus to get the @code{Xref}s right all the time, you have to
8091 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8092 considerably.
8093
8094 C'est la vie.
8095
8096 For an alternative approach, @pxref{Duplicate Suppression}.
8097
8098
8099 @node Duplicate Suppression
8100 @section Duplicate Suppression
8101
8102 By default, gnus tries to make sure that you don't have to read the same
8103 article more than once by utilizing the crossposting mechanism
8104 (@pxref{Crosspost Handling}).  However, that simple and efficient
8105 approach may not work satisfactory for some users for various
8106 reasons.
8107
8108 @enumerate
8109 @item
8110 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
8111 is evil and not very common.
8112
8113 @item
8114 The @sc{nntp} server may fail to include the @code{Xref} header in the
8115 @file{.overview} data bases.  This is evil and all too common, alas.
8116
8117 @item
8118 You may be reading the same group (or several related groups) from
8119 different @sc{nntp} servers.
8120
8121 @item
8122 You may be getting mail that duplicates articles posted to groups.
8123 @end enumerate
8124
8125 I'm sure there are other situations where @code{Xref} handling fails as
8126 well, but these four are the most common situations.
8127
8128 If, and only if, @code{Xref} handling fails for you, then you may
8129 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
8130 will remember the @code{Message-ID}s of all articles you have read or
8131 otherwise marked as read, and then, as if by magic, mark them as read
8132 all subsequent times you see them---in @emph{all} groups.  Using this
8133 mechanism is quite likely to be somewhat inefficient, but not overly
8134 so.  It's certainly preferable to reading the same articles more than
8135 once.
8136
8137 Duplicate suppression is not a very subtle instrument.  It's more like a
8138 sledge hammer than anything else.  It works in a very simple
8139 fashion---if you have marked an article as read, it adds this Message-ID
8140 to a cache.  The next time it sees this Message-ID, it will mark the
8141 article as read with the @samp{M} mark.  It doesn't care what group it
8142 saw the article in.
8143
8144 @table @code
8145 @item gnus-suppress-duplicates
8146 @vindex gnus-suppress-duplicates
8147 If non-@code{nil}, suppress duplicates.
8148
8149 @item gnus-save-duplicate-list
8150 @vindex gnus-save-duplicate-list
8151 If non-@code{nil}, save the list of duplicates to a file.  This will
8152 make startup and shutdown take longer, so the default is @code{nil}.
8153 However, this means that only duplicate articles read in a single gnus
8154 session are suppressed.
8155
8156 @item gnus-duplicate-list-length
8157 @vindex gnus-duplicate-list-length
8158 This variable says how many @code{Message-ID}s to keep in the duplicate
8159 suppression list.  The default is 10000.
8160
8161 @item gnus-duplicate-file
8162 @vindex gnus-duplicate-file
8163 The name of the file to store the duplicate suppression list in.  The
8164 default is @file{~/News/suppression}.
8165 @end table
8166
8167 If you have a tendency to stop and start gnus often, setting
8168 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
8169 you leave gnus running for weeks on end, you may have it @code{nil}.  On
8170 the other hand, saving the list makes startup and shutdown much slower,
8171 so that means that if you stop and start gnus often, you should set
8172 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
8173 to you to figure out, I think.
8174
8175
8176 @node The Article Buffer
8177 @chapter The Article Buffer
8178 @cindex article buffer
8179
8180 The articles are displayed in the article buffer, of which there is only
8181 one.  All the summary buffers share the same article buffer unless you
8182 tell gnus otherwise.
8183
8184 @menu
8185 * Hiding Headers::        Deciding what headers should be displayed.
8186 * Using MIME::            Pushing to mime articles as @sc{mime} messages.
8187 * Customizing Articles::  Tailoring the look of the articles.
8188 * Article Keymap::        Keystrokes available in the article buffer.
8189 * Misc Article::          Other stuff.
8190 @end menu
8191
8192
8193 @node Hiding Headers
8194 @section Hiding Headers
8195 @cindex hiding headers
8196 @cindex deleting headers
8197
8198 The top section of each article is the @dfn{head}.  (The rest is the
8199 @dfn{body}, but you may have guessed that already.)
8200
8201 @vindex gnus-show-all-headers
8202 There is a lot of useful information in the head: the name of the person
8203 who wrote the article, the date it was written and the subject of the
8204 article.  That's well and nice, but there's also lots of information
8205 most people do not want to see---what systems the article has passed
8206 through before reaching you, the @code{Message-ID}, the
8207 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8208 of some of those lines.  If you want to keep all those lines in the
8209 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8210
8211 Gnus provides you with two variables for sifting headers:
8212
8213 @table @code
8214
8215 @item gnus-visible-headers
8216 @vindex gnus-visible-headers
8217 If this variable is non-@code{nil}, it should be a regular expression
8218 that says what headers you wish to keep in the article buffer.  All
8219 headers that do not match this variable will be hidden.
8220
8221 For instance, if you only want to see the name of the person who wrote
8222 the article and the subject, you'd say:
8223
8224 @lisp
8225 (setq gnus-visible-headers "^From:\\|^Subject:")
8226 @end lisp
8227
8228 This variable can also be a list of regexps to match headers to
8229 remain visible.
8230
8231 @item gnus-ignored-headers
8232 @vindex gnus-ignored-headers
8233 This variable is the reverse of @code{gnus-visible-headers}.  If this
8234 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8235 should be a regular expression that matches all lines that you want to
8236 hide.  All lines that do not match this variable will remain visible.
8237
8238 For instance, if you just want to get rid of the @code{References} field
8239 and the @code{Xref} field, you might say:
8240
8241 @lisp
8242 (setq gnus-ignored-headers "^References:\\|^Xref:")
8243 @end lisp
8244
8245 This variable can also be a list of regexps to match headers to
8246 be removed.
8247
8248 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8249 variable will have no effect.
8250
8251 @end table
8252
8253 @vindex gnus-sorted-header-list
8254 Gnus can also sort the headers for you.  (It does this by default.)  You
8255 can control the sorting by setting the @code{gnus-sorted-header-list}
8256 variable.  It is a list of regular expressions that says in what order
8257 the headers are to be displayed.
8258
8259 For instance, if you want the name of the author of the article first,
8260 and then the subject, you might say something like:
8261
8262 @lisp
8263 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8264 @end lisp
8265
8266 Any headers that are to remain visible, but are not listed in this
8267 variable, will be displayed in random order after all the headers listed in this variable.
8268
8269 @findex gnus-article-hide-boring-headers
8270 @vindex gnus-boring-article-headers
8271 You can hide further boring headers by setting
8272 @code{gnus-treat-hide-boring-headers} to @code{head}.  What this function
8273 does depends on the @code{gnus-boring-article-headers} variable.  It's a
8274 list, but this list doesn't actually contain header names.  Instead is
8275 lists various @dfn{boring conditions} that Gnus can check and remove
8276 from sight.
8277
8278 These conditions are:
8279 @table @code
8280 @item empty
8281 Remove all empty headers.
8282 @item followup-to
8283 Remove the @code{Followup-To} header if it is identical to the
8284 @code{Newsgroups} header.
8285 @item reply-to
8286 Remove the @code{Reply-To} header if it lists the same address as the
8287 @code{From} header.
8288 @item newsgroups
8289 Remove the @code{Newsgroups} header if it only contains the current group
8290 name.
8291 @item date
8292 Remove the @code{Date} header if the article is less than three days
8293 old.
8294 @item long-to
8295 Remove the @code{To} header if it is very long.
8296 @item many-to
8297 Remove all @code{To} headers if there are more than one.
8298 @end table
8299
8300 To include the four three elements, you could say something like;
8301
8302 @lisp
8303 (setq gnus-boring-article-headers
8304       '(empty followup-to reply-to))
8305 @end lisp
8306
8307 This is also the default value for this variable.
8308
8309
8310 @node Using MIME
8311 @section Using @sc{mime}
8312 @cindex @sc{mime}
8313
8314 Mime is a standard for waving your hands through the air, aimlessly,
8315 while people stand around yawning.
8316
8317 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8318 while all newsreaders die of fear.
8319
8320 @sc{mime} may specify what character set the article uses, the encoding
8321 of the characters, and it also makes it possible to embed pictures and
8322 other naughty stuff in innocent-looking articles.
8323
8324 @vindex gnus-show-mime
8325 @vindex gnus-article-display-method-for-mime
8326 @vindex gnus-strict-mime
8327 @findex gnus-article-display-mime-message
8328 Gnus handles @sc{mime} by pushing the articles through
8329 @code{gnus-article-display-method-for-mime}, which is
8330 @code{gnus-article-display-mime-message} by default.  This function
8331 calls the SEMI MIME-View program to actually do the work.  For more
8332 information on SEMI MIME-View, see its manual page (however it is not
8333 existed yet, sorry).
8334
8335 Set @code{gnus-show-mime} to @code{t} if you want to use
8336 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
8337 non-@code{nil}, the @sc{mime} method will only be used if there are
8338 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
8339 set, then you'll see some unfortunate display glitches in the article
8340 buffer.  These can't be avoided.
8341
8342 In GNUS or Gnus, it might be best to just use the toggling functions
8343 from the summary buffer to avoid getting nasty surprises. (For instance,
8344 you enter the group @samp{alt.sing-a-long} and, before you know it,
8345 @sc{mime} has decoded the sound file in the article and some horrible
8346 sing-a-long song comes screaming out your speakers, and you can't find
8347 the volume button, because there isn't one, and people are starting to
8348 look at you, and you try to stop the program, but you can't, and you
8349 can't find the program to control the volume, and everybody else in the
8350 room suddenly decides to look at you disdainfully, and you'll feel
8351 rather stupid.)
8352
8353 Any similarity to real events and people is purely coincidental.  Ahem.
8354
8355 To avoid such kind of situation, gnus stops to use
8356 @code{metamail-buffer}.  So now, you can set @code{gnus-show-mime} to
8357 non-@code{nil} every-time, then you can push button in the article
8358 buffer when there are nobody else.
8359
8360 Also see @pxref{MIME Commands}.
8361
8362
8363 @node Customizing Articles
8364 @section Customizing Articles
8365 @cindex article customization
8366
8367 A slew of functions for customizing how the articles are to look like
8368 exist.  You can call these functions interactively, or you can have them
8369 called automatically when you select the articles.
8370
8371 To have them called automatically, you should set the corresponding
8372 ``treatment'' variable.  For instance, to have headers hidden, you'd set
8373 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
8374 be set, but first we discuss the values these variables can have.
8375
8376 @enumerate
8377 @item
8378 @code{nil}: Don't do this treatment.
8379
8380 @item
8381 @code{t}: Do this treatment on all body parts.
8382
8383 @item
8384 @code{head}: Do the treatment on the headers.
8385
8386 @item
8387 @code{last}: Do this treatment on the last part.
8388
8389 @item
8390 An integer: Do this treatment on all body parts that have a length less
8391 than this number.
8392
8393 @item
8394 A list of strings: Do this treatment on all body parts that are in
8395 articles that are read in groups that have names that match one of the
8396 regexps in the list.
8397
8398 @item
8399 A list where the first element is not a string:
8400
8401 The list is evaluated recursively.  The first element of the list is a
8402 predicate.  The following predicates are recognized: @code{or},
8403 @code{and}, @code{not} and @code{typep}.  Here's an example:
8404
8405 @lisp
8406 (or last
8407     (typep "text/x-vcard"))
8408 @end lisp
8409
8410 @item
8411 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
8412 non-nil.
8413
8414 @end enumerate
8415
8416 You may have noticed that the word @dfn{part} is used here.  This refers
8417 to the fact that some messages are @sc{mime} multipart articles that may
8418 be divided into several parts.  Articles that are not multiparts are
8419 considered to contain just a single part.
8420
8421 @vindex gnus-article-treat-types
8422 Are the treatments applied to all sorts of multipart parts?  Yes, if you
8423 want to, but by default, only @samp{text/plain} parts are given the
8424 treatment.  This is controlled by the @code{gnus-article-treat-types}
8425 variable, which is a list of regular expressions that are matched to the
8426 type of the part.  This variable is ignored if the value of the
8427 controlling variable is a predicate list, as described above.
8428
8429 The following treatment options are available.  The easiest way to
8430 customize this is to examine the @code{gnus-article-treat} customization
8431 group.
8432
8433 @table @code
8434 @item gnus-treat-buttonize
8435 @item gnus-treat-buttonize-head
8436 @item gnus-treat-emphasize
8437 @item gnus-treat-fill-article
8438 @item gnus-treat-strip-cr
8439 @item gnus-treat-hide-headers
8440 @item gnus-treat-hide-boring-headers
8441 @item gnus-treat-hide-signature
8442 @item gnus-treat-hide-citation
8443 @item gnus-treat-strip-pgp
8444 @item gnus-treat-strip-pem
8445 @item gnus-treat-highlight-headers
8446 @item gnus-treat-highlight-citation
8447 @item gnus-treat-highlight-signature
8448 @item gnus-treat-date-ut
8449 @item gnus-treat-date-local
8450 @item gnus-treat-date-lapsed
8451 @item gnus-treat-date-original
8452 @item gnus-treat-strip-headers-in-body
8453 @item gnus-treat-strip-trailing-blank-lines
8454 @item gnus-treat-strip-leading-blank-lines
8455 @item gnus-treat-strip-multiple-blank-lines
8456 @item gnus-treat-strip-blank-lines
8457 @item gnus-treat-overstrike
8458 @item gnus-treat-display-xface
8459 @item gnus-treat-display-smileys
8460 @item gnus-treat-display-picons
8461 @item gnus-treat-capitalize-sentences
8462 @item gnus-treat-fill-long-lines
8463 @item gnus-treat-play-sounds
8464 @item gnus-treat-translate
8465 @item gnus-treat-decode-article-as-default-mime-charset
8466 @end table
8467
8468 @vindex gnus-part-display-hook
8469 You can, of course, write your own functions to be called from
8470 @code{gnus-part-display-hook}.  The functions are called narrowed to the
8471 part, and you can do anything you like, pretty much.  There is no
8472 information that you have to keep in the buffer---you can change
8473 everything.  However, you shouldn't delete any headers.  Instead make
8474 them invisible if you want to make them go away.
8475
8476
8477 @node Article Keymap
8478 @section Article Keymap
8479
8480 Most of the keystrokes in the summary buffer can also be used in the
8481 article buffer.  They should behave as if you typed them in the summary
8482 buffer, which means that you don't actually have to have a summary
8483 buffer displayed while reading.  You can do it all from the article
8484 buffer.
8485
8486 A few additional keystrokes are available:
8487
8488 @table @kbd
8489
8490 @item SPACE
8491 @kindex SPACE (Article)
8492 @findex gnus-article-next-page
8493 Scroll forwards one page (@code{gnus-article-next-page}).
8494
8495 @item DEL
8496 @kindex DEL (Article)
8497 @findex gnus-article-prev-page
8498 Scroll backwards one page (@code{gnus-article-prev-page}).
8499
8500 @item C-c ^
8501 @kindex C-c ^ (Article)
8502 @findex gnus-article-refer-article
8503 If point is in the neighborhood of a @code{Message-ID} and you press
8504 @kbd{C-c ^}, Gnus will try to get that article from the server
8505 (@code{gnus-article-refer-article}).
8506
8507 @item C-c C-m
8508 @kindex C-c C-m (Article)
8509 @findex gnus-article-mail
8510 Send a reply to the address near point (@code{gnus-article-mail}).  If
8511 given a prefix, include the mail.
8512
8513 @item s
8514 @kindex s (Article)
8515 @findex gnus-article-show-summary
8516 Reconfigure the buffers so that the summary buffer becomes visible
8517 (@code{gnus-article-show-summary}).
8518
8519 @item ?
8520 @kindex ? (Article)
8521 @findex gnus-article-describe-briefly
8522 Give a very brief description of the available keystrokes
8523 (@code{gnus-article-describe-briefly}).
8524
8525 @item TAB
8526 @kindex TAB (Article)
8527 @findex gnus-article-next-button
8528 Go to the next button, if any (@code{gnus-article-next-button}).  This
8529 only makes sense if you have buttonizing turned on.
8530
8531 @item M-TAB
8532 @kindex M-TAB (Article)
8533 @findex gnus-article-prev-button
8534 Go to the previous button, if any (@code{gnus-article-prev-button}).
8535
8536 @end table
8537
8538
8539 @node Misc Article
8540 @section Misc Article
8541
8542 @table @code
8543
8544 @item gnus-single-article-buffer
8545 @vindex gnus-single-article-buffer
8546 If non-@code{nil}, use the same article buffer for all the groups.
8547 (This is the default.)  If @code{nil}, each group will have its own
8548 article buffer.
8549
8550 @vindex gnus-article-decode-hook
8551 @item gnus-article-decode-hook
8552 @cindex MIME
8553 Hook used to decode @sc{mime} articles.  The default value is
8554 @code{(article-decode-charset article-decode-encoded-words)}
8555
8556 @vindex gnus-article-prepare-hook
8557 @item gnus-article-prepare-hook
8558 This hook is called right after the article has been inserted into the
8559 article buffer.  It is mainly intended for functions that do something
8560 depending on the contents; it should probably not be used for changing
8561 the contents of the article buffer.
8562
8563 @item gnus-article-mode-hook
8564 @vindex gnus-article-mode-hook
8565 Hook called in article mode buffers.
8566
8567 @item gnus-article-mode-syntax-table
8568 @vindex gnus-article-mode-syntax-table
8569 Syntax table used in article buffers.  It is initialized from
8570 @code{text-mode-syntax-table}.
8571
8572 @vindex gnus-article-mode-line-format
8573 @item gnus-article-mode-line-format
8574 This variable is a format string along the same lines as
8575 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
8576 accepts the same format specifications as that variable, with one
8577 extension:
8578
8579 @table @samp
8580 @item w
8581 The @dfn{wash status} of the article.  This is a short string with one
8582 character for each possible article wash operation that may have been
8583 performed.
8584 @item m
8585 The number of @sc{mime} parts in the article.
8586 @end table
8587
8588 @vindex gnus-break-pages
8589
8590 @item gnus-break-pages
8591 Controls whether @dfn{page breaking} is to take place.  If this variable
8592 is non-@code{nil}, the articles will be divided into pages whenever a
8593 page delimiter appears in the article.  If this variable is @code{nil},
8594 paging will not be done.
8595
8596 @item gnus-page-delimiter
8597 @vindex gnus-page-delimiter
8598 This is the delimiter mentioned above.  By default, it is @samp{^L}
8599 (formfeed).
8600 @end table
8601
8602
8603 @node Composing Messages
8604 @chapter Composing Messages
8605 @cindex composing messages
8606 @cindex messages
8607 @cindex mail
8608 @cindex sending mail
8609 @cindex reply
8610 @cindex followup
8611 @cindex post
8612
8613 @kindex C-c C-c (Post)
8614 All commands for posting and mailing will put you in a message buffer
8615 where you can edit the article all you like, before you send the article
8616 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
8617 Manual}.  If you are in a foreign news group, and you wish to post the
8618 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8619 to make gnus try to post using the foreign server.
8620
8621 @menu
8622 * Mail::                 Mailing and replying.
8623 * Post::                 Posting and following up.
8624 * Posting Server::       What server should you post via?
8625 * Mail and Post::        Mailing and posting at the same time.
8626 * Archived Messages::    Where gnus stores the messages you've sent.
8627 * Posting Styles::       An easier way to specify who you are.
8628 * Drafts::               Postponing messages and rejected messages.
8629 * Rejected Articles::    What happens if the server doesn't like your article?
8630 @end menu
8631
8632 Also see @pxref{Canceling and Superseding} for information on how to
8633 remove articles you shouldn't have posted.
8634
8635
8636 @node Mail
8637 @section Mail
8638
8639 Variables for customizing outgoing mail:
8640
8641 @table @code
8642 @item gnus-uu-digest-headers
8643 @vindex gnus-uu-digest-headers
8644 List of regexps to match headers included in digested messages.  The
8645 headers will be included in the sequence they are matched.
8646
8647 @item gnus-add-to-list
8648 @vindex gnus-add-to-list
8649 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8650 that have none when you do a @kbd{a}.
8651
8652 @end table
8653
8654
8655 @node Post
8656 @section Post
8657
8658 Variables for composing news articles:
8659
8660 @table @code
8661 @item gnus-sent-message-ids-file
8662 @vindex gnus-sent-message-ids-file
8663 Gnus will keep a @code{Message-ID} history file of all the mails it has
8664 sent.  If it discovers that it has already sent a mail, it will ask the
8665 user whether to re-send the mail.  (This is primarily useful when
8666 dealing with @sc{soup} packets and the like where one is apt to send the
8667 same packet multiple times.)  This variable says what the name of this
8668 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
8669 this variable to @code{nil} if you don't want gnus to keep a history
8670 file.
8671
8672 @item gnus-sent-message-ids-length
8673 @vindex gnus-sent-message-ids-length
8674 This variable says how many @code{Message-ID}s to keep in the history
8675 file.  It is 1000 by default.
8676
8677 @end table
8678
8679
8680 @node Posting Server
8681 @section Posting Server
8682
8683 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8684 (extremely intelligent, of course) article, where does it go?
8685
8686 Thank you for asking.  I hate you.
8687
8688 @vindex gnus-post-method
8689
8690 It can be quite complicated.  Normally, gnus will use the same native
8691 server.  However.  If your native server doesn't allow posting, just
8692 reading, you probably want to use some other server to post your
8693 (extremely intelligent and fabulously interesting) articles.  You can
8694 then set the @code{gnus-post-method} to some other method:
8695
8696 @lisp
8697 (setq gnus-post-method '(nnspool ""))
8698 @end lisp
8699
8700 Now, if you've done this, and then this server rejects your article, or
8701 this server is down, what do you do then?  To override this variable you
8702 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8703 the ``current'' server for posting.
8704
8705 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8706 gnus will prompt you for what method to use for posting.
8707
8708 You can also set @code{gnus-post-method} to a list of select methods.
8709 If that's the case, gnus will always prompt you for what method to use
8710 for posting.
8711
8712 Finally, if you want to always post using the same select method as
8713 you're reading from (which might be convenient if you're reading lots of
8714 groups from different private servers), you can set this variable to
8715 @code{current}.
8716
8717
8718 @node Mail and Post
8719 @section Mail and Post
8720
8721 Here's a list of variables relevant to both mailing and
8722 posting:
8723
8724 @table @code
8725 @item gnus-mailing-list-groups
8726 @findex gnus-mailing-list-groups
8727 @cindex mailing lists
8728
8729 If your news server offers groups that are really mailing lists
8730 gatewayed to the @sc{nntp} server, you can read those groups without
8731 problems, but you can't post/followup to them without some difficulty.
8732 One solution is to add a @code{to-address} to the group parameters
8733 (@pxref{Group Parameters}).  An easier thing to do is set the
8734 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8735 really are mailing lists.  Then, at least, followups to the mailing
8736 lists will work most of the time.  Posting to these groups (@kbd{a}) is
8737 still a pain, though.
8738
8739 @end table
8740
8741 You may want to do spell-checking on messages that you send out.  Or, if
8742 you don't want to spell-check by hand, you could add automatic
8743 spell-checking via the @code{ispell} package:
8744
8745 @cindex ispell
8746 @findex ispell-message
8747 @lisp
8748 (add-hook 'message-send-hook 'ispell-message)
8749 @end lisp
8750
8751
8752 @node Archived Messages
8753 @section Archived Messages
8754 @cindex archived messages
8755 @cindex sent messages
8756
8757 Gnus provides a few different methods for storing the mail and news you
8758 send.  The default method is to use the @dfn{archive virtual server} to
8759 store the messages.  If you want to disable this completely, the
8760 @code{gnus-message-archive-group} variable should be @code{nil}, which
8761 is the default.
8762
8763 @vindex gnus-message-archive-method
8764 @code{gnus-message-archive-method} says what virtual server gnus is to
8765 use to store sent messages.  The default is:
8766
8767 @lisp
8768 (nnfolder "archive"
8769           (nnfolder-directory   "~/Mail/archive")
8770           (nnfolder-active-file "~/Mail/archive/active")
8771           (nnfolder-get-new-mail nil)
8772           (nnfolder-inhibit-expiry t))
8773 @end lisp
8774
8775 You can, however, use any mail select method (@code{nnml},
8776 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
8777 for doing this sort of thing, though.  If you don't like the default
8778 directory chosen, you could say something like:
8779
8780 @lisp
8781 (setq gnus-message-archive-method
8782       '(nnfolder "archive"
8783                  (nnfolder-inhibit-expiry t)
8784                  (nnfolder-active-file "~/News/sent-mail/active")
8785                  (nnfolder-directory "~/News/sent-mail/")))
8786 @end lisp
8787
8788 @vindex gnus-message-archive-group
8789 @cindex Gcc
8790 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8791 to one or more group(s) on that server.  Which group to use is
8792 determined by the @code{gnus-message-archive-group} variable.
8793
8794 This variable can be used to do the following:
8795
8796 @itemize @bullet
8797 @item a string
8798 Messages will be saved in that group.
8799 @item a list of strings
8800 Messages will be saved in all those groups.
8801 @item an alist of regexps, functions and forms
8802 When a key ``matches'', the result is used.
8803 @item @code{nil}
8804 No message archiving will take place.  This is the default.
8805 @end itemize
8806
8807 Let's illustrate:
8808
8809 Just saving to a single group called @samp{MisK}:
8810 @lisp
8811 (setq gnus-message-archive-group "MisK")
8812 @end lisp
8813
8814 Saving to two groups, @samp{MisK} and @samp{safe}:
8815 @lisp
8816 (setq gnus-message-archive-group '("MisK" "safe"))
8817 @end lisp
8818
8819 Save to different groups based on what group you are in:
8820 @lisp
8821 (setq gnus-message-archive-group
8822       '(("^alt" "sent-to-alt")
8823         ("mail" "sent-to-mail")
8824         (".*" "sent-to-misc")))
8825 @end lisp
8826
8827 More complex stuff:
8828 @lisp
8829 (setq gnus-message-archive-group
8830       '((if (message-news-p)
8831             "misc-news"
8832           "misc-mail")))
8833 @end lisp
8834
8835 How about storing all news messages in one file, but storing all mail
8836 messages in one file per month:
8837
8838 @lisp
8839 (setq gnus-message-archive-group
8840       '((if (message-news-p)
8841             "misc-news"
8842           (concat "mail." (format-time-string
8843                            "%Y-%m" (current-time))))))
8844 @end lisp
8845
8846 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8847 use a different value for @code{gnus-message-archive-group} there.)
8848
8849 Now, when you send a message off, it will be stored in the appropriate
8850 group.  (If you want to disable storing for just one particular message,
8851 you can just remove the @code{Gcc} header that has been inserted.)  The
8852 archive group will appear in the group buffer the next time you start
8853 gnus, or the next time you press @kbd{F} in the group buffer.  You can
8854 enter it and read the articles in it just like you'd read any other
8855 group.  If the group gets really big and annoying, you can simply rename
8856 if (using @kbd{G r} in the group buffer) to something
8857 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8858 continue to be stored in the old (now empty) group.
8859
8860 That's the default method of archiving sent messages.  Gnus offers a
8861 different way for the people who don't like the default method.  In that
8862 case you should set @code{gnus-message-archive-group} to @code{nil};
8863 this will disable archiving.
8864
8865 @table @code
8866 @item gnus-outgoing-message-group
8867 @vindex gnus-outgoing-message-group
8868 All outgoing messages will be put in this group.  If you want to store
8869 all your outgoing mail and articles in the group @samp{nnml:archive},
8870 you set this variable to that value.  This variable can also be a list of
8871 group names.
8872
8873 If you want to have greater control over what group to put each
8874 message in, you can set this variable to a function that checks the
8875 current newsgroup name and then returns a suitable group name (or list
8876 of names).
8877
8878 This variable can be used instead of @code{gnus-message-archive-group},
8879 but the latter is the preferred method.
8880 @end table
8881
8882
8883 @node Posting Styles
8884 @section Posting Styles
8885 @cindex posting styles
8886 @cindex styles
8887
8888 All them variables, they make my head swim.
8889
8890 So what if you want a different @code{Organization} and signature based
8891 on what groups you post to?  And you post both from your home machine
8892 and your work machine, and you want different @code{From} lines, and so
8893 on?
8894
8895 @vindex gnus-posting-styles
8896 One way to do stuff like that is to write clever hooks that change the
8897 variables you need to have changed.  That's a bit boring, so somebody
8898 came up with the bright idea of letting the user specify these things in
8899 a handy alist.  Here's an example of a @code{gnus-posting-styles}
8900 variable:
8901
8902 @lisp
8903 ((".*"
8904   (signature "Peace and happiness")
8905   (organization "What me?"))
8906  ("^comp"
8907   (signature "Death to everybody"))
8908  ("comp.emacs.i-love-it"
8909   (organization "Emacs is it")))
8910 @end lisp
8911
8912 As you might surmise from this example, this alist consists of several
8913 @dfn{styles}.  Each style will be applicable if the first element
8914 ``matches'', in some form or other.  The entire alist will be iterated
8915 over, from the beginning towards the end, and each match will be
8916 applied, which means that attributes in later styles that match override
8917 the same attributes in earlier matching styles.  So
8918 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8919 signature and the @samp{What me?} @code{Organization} header.
8920
8921 The first element in each style is called the @code{match}.  If it's a
8922 string, then Gnus will try to regexp match it against the group name.
8923 If it's a function symbol, that function will be called with no
8924 arguments.  If it's a variable symbol, then the variable will be
8925 referenced.  If it's a list, then that list will be @code{eval}ed.  In
8926 any case, if this returns a non-@code{nil} value, then the style is said
8927 to @dfn{match}.
8928
8929 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8930 attribute consists of a @var{(name value)} pair.  The attribute name
8931 can be one of @code{signature}, @code{signature-file},
8932 @code{organization}, @code{address}, @code{name} or @code{body}.  The
8933 attribute name can also be a string.  In that case, this will be used as
8934 a header name, and the value will be inserted in the headers of the
8935 article.
8936
8937 The attribute value can be a string (used verbatim), a function (the
8938 return value will be used), a variable (its value will be used) or a
8939 list (it will be @code{eval}ed and the return value will be used).
8940
8941 If you wish to check whether the message you are about to compose is
8942 meant to be a news article or a mail message, you can check the values
8943 of the @code{message-news-p} and @code{message-mail-p} functions.
8944
8945 @findex message-mail-p
8946 @findex message-news-p
8947
8948 So here's a new example:
8949
8950 @lisp
8951 (setq gnus-posting-styles
8952       '((".*"
8953          (signature-file "~/.signature")
8954          (name "User Name")
8955          ("X-Home-Page" (getenv "WWW_HOME"))
8956          (organization "People's Front Against MWM"))
8957         ("^rec.humor"
8958          (signature my-funny-signature-randomizer))
8959         ((equal (system-name) "gnarly")
8960          (signature my-quote-randomizer))
8961         ((message-news-p)
8962          (signature my-news-signature))
8963         ((posting-from-work-p)
8964          (signature-file "~/.work-signature")
8965          (address "user@@bar.foo")
8966          (body "You are fired.\n\nSincerely, your boss.")
8967          (organization "Important Work, Inc"))
8968         ("^nn.+:"
8969          (signature-file "~/.mail-signature"))))
8970 @end lisp
8971
8972
8973 @node Drafts
8974 @section Drafts
8975 @cindex drafts
8976
8977 If you are writing a message (mail or news) and suddenly remember that
8978 you have a steak in the oven (or some pesto in the food processor, you
8979 craaazy vegetarians), you'll probably wish there was a method to save
8980 the message you are writing so that you can continue editing it some
8981 other day, and send it when you feel its finished.
8982
8983 Well, don't worry about it.  Whenever you start composing a message of
8984 some sort using the gnus mail and post commands, the buffer you get will
8985 automatically associate to an article in a special @dfn{draft} group.
8986 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8987 article will be saved there.  (Auto-save files also go to the draft
8988 group.)
8989
8990 @cindex nndraft
8991 @vindex nndraft-directory
8992 The draft group is a special group (which is implemented as an
8993 @code{nndraft} group, if you absolutely have to know) called
8994 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8995 @code{nndraft} is to store its files.  What makes this group special is
8996 that you can't tick any articles in it or mark any articles as
8997 read---all articles in the group are permanently unread.
8998
8999 If the group doesn't exist, it will be created and you'll be subscribed
9000 to it.  The only way to make it disappear from the Group buffer is to
9001 unsubscribe it.
9002
9003 @c @findex gnus-dissociate-buffer-from-draft
9004 @c @kindex C-c M-d (Mail)
9005 @c @kindex C-c M-d (Post)
9006 @c @findex gnus-associate-buffer-with-draft
9007 @c @kindex C-c C-d (Mail)
9008 @c @kindex C-c C-d (Post)
9009 @c If you're writing some super-secret message that you later want to
9010 @c encode with PGP before sending, you may wish to turn the auto-saving
9011 @c (and association with the draft group) off.  You never know who might be
9012 @c interested in reading all your extremely valuable and terribly horrible
9013 @c and interesting secrets.  The @kbd{C-c M-d}
9014 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9015 @c If you change your mind and want to turn the auto-saving back on again,
9016 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9017 @c
9018 @c @vindex gnus-use-draft
9019 @c To leave association with the draft group off by default, set
9020 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
9021
9022 @findex gnus-draft-edit-message
9023 @kindex D e (Draft)
9024 When you want to continue editing the article, you simply enter the
9025 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9026 that.  You will be placed in a buffer where you left off.
9027
9028 Rejected articles will also be put in this draft group (@pxref{Rejected
9029 Articles}).
9030
9031 @findex gnus-draft-send-all-messages
9032 @findex gnus-draft-send-message
9033 If you have lots of rejected messages you want to post (or mail) without
9034 doing further editing, you can use the @kbd{D s} command
9035 (@code{gnus-draft-send-message}).  This command understands the
9036 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
9037 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9038 in the buffer.
9039
9040 If you have some messages that you wish not to send, you can use the
9041 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9042 as unsendable.  This is a toggling command.
9043
9044
9045 @node Rejected Articles
9046 @section Rejected Articles
9047 @cindex rejected articles
9048
9049 Sometimes a news server will reject an article.  Perhaps the server
9050 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
9051 @emph{there be demons}.  Perhaps you have included too much cited text.
9052 Perhaps the disk is full.  Perhaps the server is down.
9053
9054 These situations are, of course, totally beyond the control of gnus.
9055 (Gnus, of course, loves the way you look, always feels great, has angels
9056 fluttering around inside of it, doesn't care about how much cited text
9057 you include, never runs full and never goes down.)  So gnus saves these
9058 articles until some later time when the server feels better.
9059
9060 The rejected articles will automatically be put in a special draft group
9061 (@pxref{Drafts}).  When the server comes back up again, you'd then
9062 typically enter that group and send all the articles off.
9063
9064
9065 @node Select Methods
9066 @chapter Select Methods
9067 @cindex foreign groups
9068 @cindex select methods
9069
9070 A @dfn{foreign group} is a group not read by the usual (or
9071 default) means.  It could be, for instance, a group from a different
9072 @sc{nntp} server, it could be a virtual group, or it could be your own
9073 personal mail group.
9074
9075 A foreign group (or any group, really) is specified by a @dfn{name} and
9076 a @dfn{select method}.  To take the latter first, a select method is a
9077 list where the first element says what backend to use (e.g. @code{nntp},
9078 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
9079 name}.  There may be additional elements in the select method, where the
9080 value may have special meaning for the backend in question.
9081
9082 One could say that a select method defines a @dfn{virtual server}---so
9083 we do just that (@pxref{The Server Buffer}).
9084
9085 The @dfn{name} of the group is the name the backend will recognize the
9086 group as.
9087
9088 For instance, the group @samp{soc.motss} on the @sc{nntp} server
9089 @samp{some.where.edu} will have the name @samp{soc.motss} and select
9090 method @code{(nntp "some.where.edu")}.  Gnus will call this group
9091 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
9092 backend just knows this group as @samp{soc.motss}.
9093
9094 The different methods all have their peculiarities, of course.
9095
9096 @menu
9097 * The Server Buffer::     Making and editing virtual servers.
9098 * Getting News::          Reading USENET news with Gnus.
9099 * Getting Mail::          Reading your personal mail with Gnus.
9100 * Other Sources::         Reading directories, files, SOUP packets.
9101 * Combined Groups::       Combining groups into one group.
9102 * Gnus Unplugged::        Reading news and mail offline.
9103 @end menu
9104
9105
9106 @node The Server Buffer
9107 @section The Server Buffer
9108
9109 Traditionally, a @dfn{server} is a machine or a piece of software that
9110 one connects to, and then requests information from.  Gnus does not
9111 connect directly to any real servers, but does all transactions through
9112 one backend or other.  But that's just putting one layer more between
9113 the actual media and Gnus, so we might just as well say that each
9114 backend represents a virtual server.
9115
9116 For instance, the @code{nntp} backend may be used to connect to several
9117 different actual @sc{nntp} servers, or, perhaps, to many different ports
9118 on the same actual @sc{nntp} server.  You tell Gnus which backend to
9119 use, and what parameters to set by specifying a @dfn{select method}.
9120
9121 These select method specifications can sometimes become quite
9122 complicated---say, for instance, that you want to read from the
9123 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9124 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
9125 Anyways, if you had to specify that for each group that used this
9126 server, that would be too much work, so Gnus offers a way of naming
9127 select methods, which is what you do in the server buffer.
9128
9129 To enter the server buffer, use the @kbd{^}
9130 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9131
9132 @menu
9133 * Server Buffer Format::      You can customize the look of this buffer.
9134 * Server Commands::           Commands to manipulate servers.
9135 * Example Methods::           Examples server specifications.
9136 * Creating a Virtual Server:: An example session.
9137 * Server Variables::          Which variables to set.
9138 * Servers and Methods::       You can use server names as select methods.
9139 * Unavailable Servers::       Some servers you try to contact may be down.
9140 @end menu
9141
9142 @vindex gnus-server-mode-hook
9143 @code{gnus-server-mode-hook} is run when creating the server buffer.
9144
9145
9146 @node Server Buffer Format
9147 @subsection Server Buffer Format
9148 @cindex server buffer format
9149
9150 @vindex gnus-server-line-format
9151 You can change the look of the server buffer lines by changing the
9152 @code{gnus-server-line-format} variable.  This is a @code{format}-like
9153 variable, with some simple extensions:
9154
9155 @table @samp
9156
9157 @item h
9158 How the news is fetched---the backend name.
9159
9160 @item n
9161 The name of this server.
9162
9163 @item w
9164 Where the news is to be fetched from---the address.
9165
9166 @item s
9167 The opened/closed/denied status of the server.
9168 @end table
9169
9170 @vindex gnus-server-mode-line-format
9171 The mode line can also be customized by using the
9172 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9173 Formatting}).  The following specs are understood:
9174
9175 @table @samp
9176 @item S
9177 Server name.
9178
9179 @item M
9180 Server method.
9181 @end table
9182
9183 Also @pxref{Formatting Variables}.
9184
9185
9186 @node Server Commands
9187 @subsection Server Commands
9188 @cindex server commands
9189
9190 @table @kbd
9191
9192 @item a
9193 @kindex a (Server)
9194 @findex gnus-server-add-server
9195 Add a new server (@code{gnus-server-add-server}).
9196
9197 @item e
9198 @kindex e (Server)
9199 @findex gnus-server-edit-server
9200 Edit a server (@code{gnus-server-edit-server}).
9201
9202 @item SPACE
9203 @kindex SPACE (Server)
9204 @findex gnus-server-read-server
9205 Browse the current server (@code{gnus-server-read-server}).
9206
9207 @item q
9208 @kindex q (Server)
9209 @findex gnus-server-exit
9210 Return to the group buffer (@code{gnus-server-exit}).
9211
9212 @item k
9213 @kindex k (Server)
9214 @findex gnus-server-kill-server
9215 Kill the current server (@code{gnus-server-kill-server}).
9216
9217 @item y
9218 @kindex y (Server)
9219 @findex gnus-server-yank-server
9220 Yank the previously killed server (@code{gnus-server-yank-server}).
9221
9222 @item c
9223 @kindex c (Server)
9224 @findex gnus-server-copy-server
9225 Copy the current server (@code{gnus-server-copy-server}).
9226
9227 @item l
9228 @kindex l (Server)
9229 @findex gnus-server-list-servers
9230 List all servers (@code{gnus-server-list-servers}).
9231
9232 @item s
9233 @kindex s (Server)
9234 @findex gnus-server-scan-server
9235 Request that the server scan its sources for new articles
9236 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
9237 servers.
9238
9239 @item g
9240 @kindex g (Server)
9241 @findex gnus-server-regenerate-server
9242 Request that the server regenerate all its data structures
9243 (@code{gnus-server-regenerate-server}).  This can be useful if you have
9244 a mail backend that has gotten out of synch.
9245
9246 @end table
9247
9248
9249 @node Example Methods
9250 @subsection Example Methods
9251
9252 Most select methods are pretty simple and self-explanatory:
9253
9254 @lisp
9255 (nntp "news.funet.fi")
9256 @end lisp
9257
9258 Reading directly from the spool is even simpler:
9259
9260 @lisp
9261 (nnspool "")
9262 @end lisp
9263
9264 As you can see, the first element in a select method is the name of the
9265 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9266 will.
9267
9268 After these two elements, there may be an arbitrary number of
9269 @var{(variable form)} pairs.
9270
9271 To go back to the first example---imagine that you want to read from
9272 port 15 on that machine.  This is what the select method should
9273 look like then:
9274
9275 @lisp
9276 (nntp "news.funet.fi" (nntp-port-number 15))
9277 @end lisp
9278
9279 You should read the documentation to each backend to find out what
9280 variables are relevant, but here's an @code{nnmh} example:
9281
9282 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
9283 you have two structures that you wish to access: One is your private
9284 mail spool, and the other is a public one.  Here's the possible spec for
9285 your private mail:
9286
9287 @lisp
9288 (nnmh "private" (nnmh-directory "~/private/mail/"))
9289 @end lisp
9290
9291 (This server is then called @samp{private}, but you may have guessed
9292 that.)
9293
9294 Here's the method for a public spool:
9295
9296 @lisp
9297 (nnmh "public"
9298       (nnmh-directory "/usr/information/spool/")
9299       (nnmh-get-new-mail nil))
9300 @end lisp
9301
9302 If you are behind a firewall and only have access to the @sc{nntp}
9303 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9304 on the firewall machine and telnet from there to the @sc{nntp} server.
9305 Doing this can be rather fiddly, but your virtual server definition
9306 should probably look something like this:
9307
9308 @lisp
9309 (nntp "firewall"
9310       (nntp-address "the.firewall.machine")
9311       (nntp-open-connection-function nntp-open-rlogin)
9312       (nntp-end-of-line "\n")
9313       (nntp-rlogin-parameters
9314        ("telnet" "the.real.nntp.host" "nntp")))
9315 @end lisp
9316
9317 If you want to use the wonderful @code{ssh} program to provide a
9318 compressed connection over the modem line, you could create a virtual
9319 server that would look something like this:
9320
9321 @lisp
9322 (nntp "news"
9323        (nntp-address "copper.uio.no")
9324        (nntp-rlogin-program "ssh")
9325        (nntp-open-connection-function nntp-open-rlogin)
9326        (nntp-end-of-line "\n")
9327        (nntp-rlogin-parameters
9328         ("telnet" "news.uio.no" "nntp")))
9329 @end lisp
9330
9331 This means that you have to have set up @code{ssh-agent} correctly to
9332 provide automatic authorization, of course.  And to get a compressed
9333 connection, you have to have the @samp{Compression} option in the
9334 @code{ssh} @file{config} file.
9335
9336
9337 @node Creating a Virtual Server
9338 @subsection Creating a Virtual Server
9339
9340 If you're saving lots of articles in the cache by using persistent
9341 articles, you may want to create a virtual server to read the cache.
9342
9343 First you need to add a new server.  The @kbd{a} command does that.  It
9344 would probably be best to use @code{nnspool} to read the cache.  You
9345 could also use @code{nnml} or @code{nnmh}, though.
9346
9347 Type @kbd{a nnspool RET cache RET}.
9348
9349 You should now have a brand new @code{nnspool} virtual server called
9350 @samp{cache}.  You now need to edit it to have the right definitions.
9351 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
9352 will contain the following:
9353
9354 @lisp
9355 (nnspool "cache")
9356 @end lisp
9357
9358 Change that to:
9359
9360 @lisp
9361 (nnspool "cache"
9362          (nnspool-spool-directory "~/News/cache/")
9363          (nnspool-nov-directory "~/News/cache/")
9364          (nnspool-active-file "~/News/cache/active"))
9365 @end lisp
9366
9367 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
9368 @kbd{RET} over this virtual server, you should be entered into a browse
9369 buffer, and you should be able to enter any of the groups displayed.
9370
9371
9372 @node Server Variables
9373 @subsection Server Variables
9374
9375 One sticky point when defining variables (both on backends and in Emacs
9376 in general) is that some variables are typically initialized from other
9377 variables when the definition of the variables is being loaded.  If you
9378 change the "base" variable after the variables have been loaded, you
9379 won't change the "derived" variables.
9380
9381 This typically affects directory and file variables.  For instance,
9382 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9383 directory variables are initialized from that variable, so
9384 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
9385 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9386 @code{nnml-directory}---you have to explicitly set all the file
9387 variables to be what you want them to be.  For a complete list of
9388 variables for each backend, see each backend's section later in this
9389 manual, but here's an example @code{nnml} definition:
9390
9391 @lisp
9392 (nnml "public"
9393       (nnml-directory "~/my-mail/")
9394       (nnml-active-file "~/my-mail/active")
9395       (nnml-newsgroups-file "~/my-mail/newsgroups"))
9396 @end lisp
9397
9398
9399 @node Servers and Methods
9400 @subsection Servers and Methods
9401
9402 Wherever you would normally use a select method
9403 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9404 when browsing a foreign server) you can use a virtual server name
9405 instead.  This could potentially save lots of typing.  And it's nice all
9406 over.
9407
9408
9409 @node Unavailable Servers
9410 @subsection Unavailable Servers
9411
9412 If a server seems to be unreachable, Gnus will mark that server as
9413 @code{denied}.  That means that any subsequent attempt to make contact
9414 with that server will just be ignored.  ``It can't be opened,'' Gnus
9415 will tell you, without making the least effort to see whether that is
9416 actually the case or not.
9417
9418 That might seem quite naughty, but it does make sense most of the time.
9419 Let's say you have 10 groups subscribed to on server
9420 @samp{nephelococcygia.com}.  This server is located somewhere quite far
9421 away from you and the machine is quite slow, so it takes 1 minute just
9422 to find out that it refuses connection to you today.  If Gnus were to
9423 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9424 attempt to do that.  Once it has gotten a single ``connection refused'',
9425 it will regard that server as ``down''.
9426
9427 So, what happens if the machine was only feeling unwell temporarily?
9428 How do you test to see whether the machine has come up again?
9429
9430 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9431 with the following commands:
9432
9433 @table @kbd
9434
9435 @item O
9436 @kindex O (Server)
9437 @findex gnus-server-open-server
9438 Try to establish connection to the server on the current line
9439 (@code{gnus-server-open-server}).
9440
9441 @item C
9442 @kindex C (Server)
9443 @findex gnus-server-close-server
9444 Close the connection (if any) to the server
9445 (@code{gnus-server-close-server}).
9446
9447 @item D
9448 @kindex D (Server)
9449 @findex gnus-server-deny-server
9450 Mark the current server as unreachable
9451 (@code{gnus-server-deny-server}).
9452
9453 @item M-o
9454 @kindex M-o (Server)
9455 @findex gnus-server-open-all-servers
9456 Open the connections to all servers in the buffer
9457 (@code{gnus-server-open-all-servers}).
9458
9459 @item M-c
9460 @kindex M-c (Server)
9461 @findex gnus-server-close-all-servers
9462 Close the connections to all servers in the buffer
9463 (@code{gnus-server-close-all-servers}).
9464
9465 @item R
9466 @kindex R (Server)
9467 @findex gnus-server-remove-denials
9468 Remove all marks to whether Gnus was denied connection from any servers
9469 (@code{gnus-server-remove-denials}).
9470
9471 @end table
9472
9473
9474 @node Getting News
9475 @section Getting News
9476 @cindex reading news
9477 @cindex news backends
9478
9479 A newsreader is normally used for reading news.  Gnus currently provides
9480 only two methods of getting news---it can read from an @sc{nntp} server,
9481 or it can read from a local spool.
9482
9483 @menu
9484 * NNTP::               Reading news from an @sc{nntp} server.
9485 * News Spool::         Reading news from the local spool.
9486 @end menu
9487
9488
9489 @node NNTP
9490 @subsection @sc{nntp}
9491 @cindex nntp
9492
9493 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9494 You just specify @code{nntp} as method and the address of the @sc{nntp}
9495 server as the, uhm, address.
9496
9497 If the @sc{nntp} server is located at a non-standard port, setting the
9498 third element of the select method to this port number should allow you
9499 to connect to the right port.  You'll have to edit the group info for
9500 that (@pxref{Foreign Groups}).
9501
9502 The name of the foreign group can be the same as a native group.  In
9503 fact, you can subscribe to the same group from as many different servers
9504 you feel like.  There will be no name collisions.
9505
9506 The following variables can be used to create a virtual @code{nntp}
9507 server:
9508
9509 @table @code
9510
9511 @item nntp-server-opened-hook
9512 @vindex nntp-server-opened-hook
9513 @cindex @sc{mode reader}
9514 @cindex authinfo
9515 @cindex authentification
9516 @cindex nntp authentification
9517 @findex nntp-send-authinfo
9518 @findex nntp-send-mode-reader
9519 is run after a connection has been made.  It can be used to send
9520 commands to the @sc{nntp} server after it has been contacted.  By
9521 default it sends the command @code{MODE READER} to the server with the
9522 @code{nntp-send-mode-reader} function.  This function should always be
9523 present in this hook.
9524
9525 @item nntp-authinfo-function
9526 @vindex nntp-authinfo-function
9527 @findex nntp-send-authinfo
9528 @vindex nntp-authinfo-file
9529 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9530 server.  The default function is @code{nntp-send-authinfo}, which looks
9531 through your @file{~/.authinfo} (or whatever you've set the
9532 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
9533 are found, it will prompt you for a login name and a password.  The
9534 format of the @file{~/.authinfo} file is (almost) the same as the
9535 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9536 manual page, but here are the salient facts:
9537
9538 @enumerate
9539 @item
9540 The file contains one or more line, each of which define one server.
9541
9542 @item
9543 Each line may contain an arbitrary number of token/value pairs.  The
9544 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9545 @samp{default} and @samp{force}.  (The latter is not a valid
9546 @file{.netrc}/@code{ftp} token, which is the only way the
9547 @file{.authinfo} file format deviates from the @file{.netrc} file
9548 format.)
9549
9550 @end enumerate
9551
9552 Here's an example file:
9553
9554 @example
9555 machine news.uio.no login larsi password geheimnis
9556 machine nntp.ifi.uio.no login larsi force yes
9557 @end example
9558
9559 The token/value pairs may appear in any order; @samp{machine} doesn't
9560 have to be first, for instance.
9561
9562 In this example, both login name and password have been supplied for the
9563 former server, while the latter has only the login name listed, and the
9564 user will be prompted for the password.  The latter also has the
9565 @samp{force} tag, which means that the authinfo will be sent to the
9566 @var{nntp} server upon connection; the default (i.e., when there is not
9567 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9568 until the @var{nntp} server asks for it.
9569
9570 You can also add @samp{default} lines that will apply to all servers
9571 that don't have matching @samp{machine} lines.
9572
9573 @example
9574 default force yes
9575 @end example
9576
9577 This will force sending @samp{AUTHINFO} commands to all servers not
9578 previously mentioned.
9579
9580 Remember to not leave the @file{~/.authinfo} file world-readable.
9581
9582 @item nntp-server-action-alist
9583 @vindex nntp-server-action-alist
9584 This is a list of regexps to match on server types and actions to be
9585 taken when matches are made.  For instance, if you want Gnus to beep
9586 every time you connect to innd, you could say something like:
9587
9588 @lisp
9589 (setq nntp-server-action-alist
9590       '(("innd" (ding))))
9591 @end lisp
9592
9593 You probably don't want to do that, though.
9594
9595 The default value is
9596
9597 @lisp
9598 '(("nntpd 1\\.5\\.11t"
9599    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9600 @end lisp
9601
9602 This ensures that Gnus doesn't send the @code{MODE READER} command to
9603 nntpd 1.5.11t, since that command chokes that server, I've been told.
9604
9605 @item nntp-maximum-request
9606 @vindex nntp-maximum-request
9607 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9608 will collect headers by sending a series of @code{head} commands.  To
9609 speed things up, the backend sends lots of these commands without
9610 waiting for reply, and then reads all the replies.  This is controlled
9611 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
9612 your network is buggy, you should set this to 1.
9613
9614 @item nntp-connection-timeout
9615 @vindex nntp-connection-timeout
9616 If you have lots of foreign @code{nntp} groups that you connect to
9617 regularly, you're sure to have problems with @sc{nntp} servers not
9618 responding properly, or being too loaded to reply within reasonable
9619 time.  This is can lead to awkward problems, which can be helped
9620 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
9621 that says how many seconds the @code{nntp} backend should wait for a
9622 connection before giving up.  If it is @code{nil}, which is the default,
9623 no timeouts are done.
9624
9625 @c @item nntp-command-timeout
9626 @c @vindex nntp-command-timeout
9627 @c @cindex PPP connections
9628 @c @cindex dynamic IP addresses
9629 @c If you're running Gnus on a machine that has a dynamically assigned
9630 @c address, Gnus may become confused.  If the address of your machine
9631 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9632 @c waiting forever for replies from the server.  To help with this
9633 @c unfortunate problem, you can set this command to a number.  Gnus will
9634 @c then, if it sits waiting for a reply from the server longer than that
9635 @c number of seconds, shut down the connection, start a new one, and resend
9636 @c the command.  This should hopefully be transparent to the user.  A
9637 @c likely number is 30 seconds.
9638 @c
9639 @c @item nntp-retry-on-break
9640 @c @vindex nntp-retry-on-break
9641 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9642 @c hangs.  This will have much the same effect as the command timeout
9643 @c described above.
9644
9645 @item nntp-server-hook
9646 @vindex nntp-server-hook
9647 This hook is run as the last step when connecting to an @sc{nntp}
9648 server.
9649
9650 @findex nntp-open-rlogin
9651 @findex nntp-open-telnet
9652 @findex nntp-open-network-stream
9653 @item nntp-open-connection-function
9654 @vindex nntp-open-connection-function
9655 This function is used to connect to the remote system.  Four pre-made
9656 functions are supplied:
9657
9658 @table @code
9659 @item nntp-open-network-stream
9660 This is the default, and simply connects to some port or other on the
9661 remote system.
9662
9663 @item nntp-open-rlogin
9664 Does an @samp{rlogin} on the
9665 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9666 available there.
9667
9668 @code{nntp-open-rlogin}-related variables:
9669
9670 @table @code
9671
9672 @item nntp-rlogin-program
9673 @vindex nntp-rlogin-program
9674 Program used to log in on remote machines.  The default is @samp{rsh},
9675 but @samp{ssh} is a popular alternative.
9676
9677 @item nntp-rlogin-parameters
9678 @vindex nntp-rlogin-parameters
9679 This list will be used as the parameter list given to @code{rsh}.
9680
9681 @item nntp-rlogin-user-name
9682 @vindex nntp-rlogin-user-name
9683 User name on the remote system.
9684
9685 @end table
9686
9687 @item nntp-open-telnet
9688 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9689 to get to the @sc{nntp} server.
9690
9691 @code{nntp-open-telnet}-related variables:
9692
9693 @table @code
9694 @item nntp-telnet-command
9695 @vindex nntp-telnet-command
9696 Command used to start @code{telnet}.
9697
9698 @item nntp-telnet-switches
9699 @vindex nntp-telnet-switches
9700 List of strings to be used as the switches to the @code{telnet} command.
9701
9702 @item nntp-telnet-user-name
9703 @vindex nntp-telnet-user-name
9704 User name for log in on the remote system.
9705
9706 @item nntp-telnet-passwd
9707 @vindex nntp-telnet-passwd
9708 Password to use when logging in.
9709
9710 @item nntp-telnet-parameters
9711 @vindex nntp-telnet-parameters
9712 A list of strings executed as a command after logging in
9713 via @code{telnet}.
9714
9715 @item nntp-telnet-shell-prompt
9716 @vindex nntp-telnet-shell-prompt
9717 Regexp matching the shell prompt on the remote machine.  The default is
9718 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9719
9720 @item nntp-open-telnet-envuser
9721 @vindex nntp-open-telnet-envuser
9722 If non-@code{nil}, the @code{telnet} session (client and server both)
9723 will support the @code{ENVIRON} option and not prompt for login name.
9724 This works for Solaris @code{telnet}, for instance.
9725
9726 @end table
9727
9728 @findex nntp-open-ssl-stream
9729 @item nntp-open-ssl-stream
9730 Opens a connection to a server over a @dfn{secure} channel.  To use this
9731 you must have SSLay installed
9732 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9733 @file{ssl.el} (from the W3 distributeion, for instance).  You then
9734 define a server as follows:
9735
9736 @lisp
9737 ;; Type `C-c C-c' after you've finished editing.
9738 ;;
9739 ;; "snews" is port 563 and is predefined in our /etc/services
9740 ;;
9741 (nntp "snews.bar.com"
9742       (nntp-open-connection-function nntp-open-ssl-stream)
9743       (nntp-port-number "snews")
9744       (nntp-address "snews.bar.com"))
9745 @end lisp
9746
9747 @end table
9748
9749 @item nntp-end-of-line
9750 @vindex nntp-end-of-line
9751 String to use as end-of-line marker when talking to the @sc{nntp}
9752 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
9753 using @code{rlogin} to talk to the server.
9754
9755 @item nntp-rlogin-user-name
9756 @vindex nntp-rlogin-user-name
9757 User name on the remote system when using the @code{rlogin} connect
9758 function.
9759
9760 @item nntp-address
9761 @vindex nntp-address
9762 The address of the remote system running the @sc{nntp} server.
9763
9764 @item nntp-port-number
9765 @vindex nntp-port-number
9766 Port number to connect to when using the @code{nntp-open-network-stream}
9767 connect function.
9768
9769 @item nntp-buggy-select
9770 @vindex nntp-buggy-select
9771 Set this to non-@code{nil} if your select routine is buggy.
9772
9773 @item nntp-nov-is-evil
9774 @vindex nntp-nov-is-evil
9775 If the @sc{nntp} server does not support @sc{nov}, you could set this
9776 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9777 can be used.
9778
9779 @item nntp-xover-commands
9780 @vindex nntp-xover-commands
9781 @cindex nov
9782 @cindex XOVER
9783 List of strings used as commands to fetch @sc{nov} lines from a
9784 server.  The default value of this variable is @code{("XOVER"
9785 "XOVERVIEW")}.
9786
9787 @item nntp-nov-gap
9788 @vindex nntp-nov-gap
9789 @code{nntp} normally sends just one big request for @sc{nov} lines to
9790 the server.  The server responds with one huge list of lines.  However,
9791 if you have read articles 2-5000 in the group, and only want to read
9792 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9793 lines that you will not need.  This variable says how
9794 big a gap between two consecutive articles is allowed to be before the
9795 @code{XOVER} request is split into several request.  Note that if your
9796 network is fast, setting this variable to a really small number means
9797 that fetching will probably be slower.  If this variable is @code{nil},
9798 @code{nntp} will never split requests.  The default is 5.
9799
9800 @item nntp-prepare-server-hook
9801 @vindex nntp-prepare-server-hook
9802 A hook run before attempting to connect to an @sc{nntp} server.
9803
9804 @item nntp-warn-about-losing-connection
9805 @vindex nntp-warn-about-losing-connection
9806 If this variable is non-@code{nil}, some noise will be made when a
9807 server closes connection.
9808
9809 @item nntp-record-commands
9810 @vindex nntp-record-commands
9811 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9812 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9813 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
9814 that doesn't seem to work.
9815
9816 @end table
9817
9818
9819 @node News Spool
9820 @subsection News Spool
9821 @cindex nnspool
9822 @cindex news spool
9823
9824 Subscribing to a foreign group from the local spool is extremely easy,
9825 and might be useful, for instance, to speed up reading groups that
9826 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9827 instance.
9828
9829 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9830 anything else) as the address.
9831
9832 If you have access to a local spool, you should probably use that as the
9833 native select method (@pxref{Finding the News}).  It is normally faster
9834 than using an @code{nntp} select method, but might not be.  It depends.
9835 You just have to try to find out what's best at your site.
9836
9837 @table @code
9838
9839 @item nnspool-inews-program
9840 @vindex nnspool-inews-program
9841 Program used to post an article.
9842
9843 @item nnspool-inews-switches
9844 @vindex nnspool-inews-switches
9845 Parameters given to the inews program when posting an article.
9846
9847 @item nnspool-spool-directory
9848 @vindex nnspool-spool-directory
9849 Where @code{nnspool} looks for the articles.  This is normally
9850 @file{/usr/spool/news/}.
9851
9852 @item nnspool-nov-directory
9853 @vindex nnspool-nov-directory
9854 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9855 @file{/usr/spool/news/over.view/}.
9856
9857 @item nnspool-lib-dir
9858 @vindex nnspool-lib-dir
9859 Where the news lib dir is (@file{/usr/lib/news/} by default).
9860
9861 @item nnspool-active-file
9862 @vindex nnspool-active-file
9863 The path to the active file.
9864
9865 @item nnspool-newsgroups-file
9866 @vindex nnspool-newsgroups-file
9867 The path to the group descriptions file.
9868
9869 @item nnspool-history-file
9870 @vindex nnspool-history-file
9871 The path to the news history file.
9872
9873 @item nnspool-active-times-file
9874 @vindex nnspool-active-times-file
9875 The path to the active date file.
9876
9877 @item nnspool-nov-is-evil
9878 @vindex nnspool-nov-is-evil
9879 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9880 that it finds.
9881
9882 @item nnspool-sift-nov-with-sed
9883 @vindex nnspool-sift-nov-with-sed
9884 @cindex sed
9885 If non-@code{nil}, which is the default, use @code{sed} to get the
9886 relevant portion from the overview file.  If nil, @code{nnspool} will
9887 load the entire file into a buffer and process it there.
9888
9889 @end table
9890
9891
9892 @node Getting Mail
9893 @section Getting Mail
9894 @cindex reading mail
9895 @cindex mail
9896
9897 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9898 course.
9899
9900 @menu
9901 * Mail in a Newsreader::         Important introductory notes.  
9902 * Getting Started Reading Mail:: A simple cookbook example.
9903 * Splitting Mail::               How to create mail groups.
9904 * Mail Sources::                 How to tell Gnus where to get mail from.
9905 * Mail Backend Variables::       Variables for customizing mail handling.
9906 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9907 * Incorporating Old Mail::       What about the old mail you have?
9908 * Expiring Mail::                Getting rid of unwanted mail.
9909 * Washing Mail::                 Removing gruft from the mail you get.
9910 * Duplicates::                   Dealing with duplicated mail.
9911 * Not Reading Mail::             Using mail backends for reading other files.
9912 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9913 @end menu
9914
9915
9916 @node Mail in a Newsreader
9917 @subsection Mail in a Newsreader
9918
9919 If you are used to traditional mail readers, but have decided to switch 
9920 to reading mail with Gnus, you may find yourself experiencing something
9921 of a culture shock.
9922
9923 Gnus does not behave like traditional mail readers.  If you want to make 
9924 it behave that way, you can, but it's an uphill battle.
9925
9926 Gnus, by default, handles all its group using the same approach.  This
9927 approach is very newsreaderly---you enter a group, see the new/unread
9928 messages, and when you read the messages, they get marked as read, and
9929 you don't see them any more.  (Unless you explicitly ask for them.)
9930
9931 In particular, you do not do anything explicitly to delete messages.
9932
9933 Does this mean that all the messages that have been marked as read are
9934 deleted?  How awful!
9935
9936 But, no, it means that old messages are @dfn{expired} according to some
9937 scheme or other.  For news messages, the expire process is controlled by 
9938 the news administrator; for mail, the expire process is controlled by
9939 you.  The expire process for mail is covered in depth in @pxref{Expiring
9940 Mail}.
9941
9942 What many Gnus users find, after using it a while for both news and
9943 mail, is that the transport becomes more and more irrelevant.  What
9944 becomes important is the size of the receiving audience.
9945
9946 Many people subscribe to several mailing lists.  These are transported
9947 via SMTP, and are therefore mail.  Some people have local news groups
9948 which have only a handful of readers.  These are transported via NNTP,
9949 and are therefore news.
9950
9951 The important distinction turns out to be not the transport mechanism,
9952 but whether the messages are @dfn{personal} or @dfn{public}.  Many users
9953 then subtly alter the behavior of Gnus according to these two
9954 categories.
9955
9956 Some users never get comfortable using the Gnus (ahem) paradigm and wish
9957 that Gnus should grow up and be a male, er, mail reader.  It is possible
9958 to whip Gnus into a more mailreaderly being, but, as said before, it's
9959 not easy.  People who prefer proper mail readers should try @sc{vm}
9960 instead, which is an excellent, and proper, mail reader.
9961
9962 I don't mean to scare anybody off, but I want to make it clear that you
9963 may be required to learn a new way of thinking about messages.  After
9964 you've been subjected to The Gnus Way, you will come to love it.  I can
9965 guarantee it.  (At least the guy who sold me the Emacs Subliminal
9966 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
9967 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
9968 You Do.)
9969
9970
9971 @node Getting Started Reading Mail
9972 @subsection Getting Started Reading Mail
9973
9974 It's quite easy to use Gnus to read your new mail.  You just plonk the
9975 mail backend of your choice into @code{gnus-secondary-select-methods},
9976 and things will happen automatically.
9977
9978 For instance, if you want to use @code{nnml} (which is a "one file per
9979 mail" backend), you could put the following in your @file{.gnus} file:
9980
9981 @lisp
9982 (setq gnus-secondary-select-methods
9983       '((nnml "private")))
9984 @end lisp
9985
9986 Now, the next time you start Gnus, this backend will be queried for new
9987 articles, and it will move all the messages in your spool file to its
9988 directory, which is @code{~/Mail/} by default.  The new group that will
9989 be created (@samp{mail.misc}) will be subscribed, and you can read it
9990 like any other group.
9991
9992 You will probably want to split the mail into several groups, though:
9993
9994 @lisp
9995 (setq nnmail-split-methods
9996       '(("junk" "^From:.*Lars Ingebrigtsen")
9997         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9998         ("other" "")))
9999 @end lisp
10000
10001 This will result in three new @code{nnml} mail groups being created:
10002 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
10003 mail that doesn't fit into the first two groups will be placed in the
10004 last group.
10005
10006 This should be sufficient for reading mail with Gnus.  You might want to
10007 give the other sections in this part of the manual a perusal, though.
10008 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10009
10010
10011 @node Splitting Mail
10012 @subsection Splitting Mail
10013 @cindex splitting mail
10014 @cindex mail splitting
10015
10016 @vindex nnmail-split-methods
10017 The @code{nnmail-split-methods} variable says how the incoming mail is
10018 to be split into groups.
10019
10020 @lisp
10021 (setq nnmail-split-methods
10022   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10023     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10024     ("mail.other" "")))
10025 @end lisp
10026
10027 This variable is a list of lists, where the first element of each of
10028 these lists is the name of the mail group (they do not have to be called
10029 something beginning with @samp{mail}, by the way), and the second
10030 element is a regular expression used on the header of each mail to
10031 determine if it belongs in this mail group.  The first string may
10032 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10033 insert sub-expressions from the matched text.  For instance:
10034
10035 @lisp
10036 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10037 @end lisp
10038
10039 The second element can also be a function.  In that case, it will be
10040 called narrowed to the headers with the first element of the rule as the
10041 argument.  It should return a non-@code{nil} value if it thinks that the
10042 mail belongs in that group.
10043
10044 The last of these groups should always be a general one, and the regular
10045 expression should @emph{always} be @samp{} so that it matches any mails
10046 that haven't been matched by any of the other regexps.  (These rules are
10047 processed from the beginning of the alist toward the end.  The first
10048 rule to make a match will "win", unless you have crossposting enabled.
10049 In that case, all matching rules will "win".)
10050
10051 If you like to tinker with this yourself, you can set this variable to a
10052 function of your choice.  This function will be called without any
10053 arguments in a buffer narrowed to the headers of an incoming mail
10054 message.  The function should return a list of group names that it
10055 thinks should carry this mail message.
10056
10057 Note that the mail backends are free to maul the poor, innocent,
10058 incoming headers all they want to.  They all add @code{Lines} headers;
10059 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10060 @code{From<SPACE>} line to something else.
10061
10062 @vindex nnmail-crosspost
10063 The mail backends all support cross-posting.  If several regexps match,
10064 the mail will be ``cross-posted'' to all those groups.
10065 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
10066 that no articles are crossposted to the general (@samp{}) group.
10067
10068 @vindex nnmail-crosspost-link-function
10069 @cindex crosspost
10070 @cindex links
10071 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10072 the crossposted articles.  However, not all file systems support hard
10073 links.  If that's the case for you, set
10074 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
10075 variable is @code{add-name-to-file} by default.)
10076
10077 @kindex M-x nnmail-split-history
10078 @kindex nnmail-split-history
10079 If you wish to see where the previous mail split put the messages, you
10080 can use the @kbd{M-x nnmail-split-history} command.
10081
10082 Gnus gives you all the opportunity you could possibly want for shooting
10083 yourself in the foot.  Let's say you create a group that will contain
10084 all the mail you get from your boss.  And then you accidentally
10085 unsubscribe from the group.  Gnus will still put all the mail from your
10086 boss in the unsubscribed group, and so, when your boss mails you ``Have
10087 that report ready by Monday or you're fired!'', you'll never see it and,
10088 come Tuesday, you'll still believe that you're gainfully employed while
10089 you really should be out collecting empty bottles to save up for next
10090 month's rent money.
10091
10092
10093 @node Mail Sources
10094 @subsection Mail Sources
10095
10096 Mail can be gotten from many different sources---the mail spool, from a
10097 POP mail server, or from a procmail directory, for instance.
10098
10099 @menu
10100 * Mail Source Specifiers::       How to specify what a mail source is.
10101 * Mail Source Customization::    Some variables that influence things.
10102 * Fetching Mail::                Using the mail source specifiers.
10103 @end menu
10104
10105
10106 @node Mail Source Specifiers
10107 @subsubsection Mail Source Specifiers
10108 @cindex POP
10109 @cindex mail server
10110 @cindex procmail
10111 @cindex mail spool
10112 @cindex mail source
10113
10114 You tell Gnus how to fetch mail by creating a @dfn{mail source
10115 specifier}.
10116
10117 Here's an example:
10118
10119 @lisp
10120 (pop :server "pop3.mailserver.com" :user "myname")
10121 @end lisp
10122
10123 As can be observed, a mail source specifier is a list where the first
10124 element is a @dfn{mail source type}, followed by an arbitrary number of
10125 @dfn{keywords}.  Keywords that are not explicitly specified are given
10126 default values.
10127
10128 The following mail source types are available:
10129
10130 @table @code
10131 @item file
10132 Get mail from a single file; typically from the mail spool.
10133
10134 Keywords:
10135
10136 @table @code
10137 @item :path
10138 The path of the file.  Defaults to the value of the @code{MAIL}
10139 environment variable or @file{/usr/mail/spool/user-name}.
10140 @end table
10141
10142 An example file mail source:
10143
10144 @lisp
10145 (file :path "/usr/spool/mail/user-name")
10146 @end lisp
10147
10148 Or using the default path:
10149
10150 @lisp
10151 (file)
10152 @end lisp
10153
10154 @item directory
10155 Get mail from several files in a directory.  This is typically used when
10156 you have procmail split the incoming mail into several files.
10157
10158 Keywords:
10159
10160 @table @code
10161 @item :path
10162 The path of the directory where the files are.  There is no default
10163 value.
10164
10165 @item :suffix
10166 Only files ending with this suffix are used.  The default is
10167 @samp{.spool}.
10168
10169 @item :predicate
10170 Only files that have this predicate return non-@code{nil} are returned.
10171 The default is @code{identity}.  This is used as an additional
10172 filter---only files that have the right suffix @emph{and} satisfy this
10173 predicate are considered.
10174
10175 @item :prescript
10176 @itemx :postscript
10177 Script run before/after fetching mail.
10178
10179 @end table
10180
10181 An example directory mail source:
10182
10183 @lisp
10184 (directory :path "/home/user-name/procmail-dir/"
10185            :suffix ".prcml")
10186 @end lisp
10187
10188 @item pop
10189 Get mail from a POP server.
10190
10191 Keywords:
10192
10193 @table @code
10194 @item :server
10195 The name of the POP server.  The default is taken from the
10196 @code{MAILHOST} environment variable.
10197
10198 @item :port
10199 The port number of the POP server.  The default is @samp{pop3}.
10200
10201 @item :user
10202 The user name to give to the POP server.  The default is the login
10203 name.
10204
10205 @item :password
10206 The password to give to the POP server.  If not specified, the user is
10207 prompted.
10208
10209 @item :program
10210 The program to use to fetch mail from the POP server.  This is should be
10211 a @code{format}-like string.  Here's an example:
10212
10213 @example
10214 fetchmail %u@@%s -P %p %t
10215 @end example
10216
10217 The valid format specifier characters are:
10218
10219 @table @samp
10220 @item t
10221 The name of the file the mail is to be moved to.  This must always be
10222 included in this string.
10223
10224 @item s
10225 The name of the server.
10226
10227 @item P
10228 The port number of the server.
10229
10230 @item u
10231 The user name to use.
10232
10233 @item p
10234 The password to use.
10235 @end table
10236
10237 The values used for these specs are taken from the values you give the
10238 corresponding keywords.
10239
10240 @item :prescript
10241 A script to be run before fetching the mail.  The syntax is the same as
10242 the @code{:program} keyword.  This can also be a function to be run.
10243
10244 @item :postscript
10245 A script to be run after fetching the mail.  The syntax is the same as
10246 the @code{:program} keyword.  This can also be a function to be run.
10247
10248 @item :function
10249 The function to use to fetch mail from the POP server.  The function is
10250 called with one parameter---the name of the file where the mail should
10251 be moved to.
10252
10253 @item :authentication
10254 This can be either the symbol @code{password} or the symbol @code{apop}
10255 and says what authentication scheme to use.  The default is
10256 @code{password}.
10257
10258 @end table
10259
10260 If the @code{:program} and @code{:function} keywords aren't specified,
10261 @code{pop3-movemail} will be used.
10262
10263 Here are some examples.  Fetch from the default POP server, using the
10264 default user name, and default fetcher:
10265
10266 @lisp
10267 (pop)
10268 @end lisp
10269
10270 Fetch from a named server with a named user and password:
10271
10272 @lisp
10273 (pop :server "my.pop.server"
10274      :user "user-name" :password "secret")
10275 @end lisp
10276
10277 Use @samp{movemail} to move the mail:
10278
10279 @lisp
10280 (pop :program "movemail po:%u %t %p")
10281 @end lisp
10282
10283 @item maildir
10284 Get mail from a maildir. This is a type of mailbox currently only
10285 supported by qmail, where each file in a special directory contains
10286 exactly one mail.
10287
10288 Keywords:
10289
10290 @table @code
10291 @item :path
10292 The path of the directory where the mails are stored.  The default is
10293 @samp{~/Maildir/new}.
10294
10295 If you sometimes look at your mail through a pop3 daemon before fetching
10296 them with Gnus, you may also have to fetch your mails from the
10297 @code{cur} directory inside the maildir, like in the following example.
10298
10299 @end table
10300
10301 An example maildir mail source:
10302
10303 @lisp
10304 (maildir :path "/home/user-name/Maildir/cur")
10305 @end lisp
10306
10307 @end table
10308
10309
10310 @node Mail Source Customization
10311 @subsubsection Mail Source Customization
10312
10313 The following is a list of variables that influence how the mail is
10314 fetched.  You would normally not need to set or change any of these
10315 variables.
10316
10317 @table @code
10318 @item mail-source-movemail-program
10319 @vindex mail-source-movemail-program
10320 A command to be executed to move mail from the inbox.  The default is
10321 @samp{movemail}.
10322
10323 This can also be a function.  In that case, the function will be
10324 called with two parameters -- the name of the INBOX file, and the file
10325 to be moved to.
10326
10327 @item mail-source-movemail-args
10328 @vindex mail-source-movemail-args
10329 Extra arguments to give to the command described above.
10330
10331 @item mail-source-crash-box
10332 @vindex mail-source-crash-box
10333 File where mail will be stored while processing it.  The default is
10334 @file{~/.emacs-mail-crash-box}.
10335
10336 @item mail-source-delete-incoming
10337 @vindex mail-source-delete-incoming
10338 If non-@code{nil}, delete incoming files after handling them.
10339
10340 @item mail-source-directory
10341 @vindex mail-source-directory
10342 Directory where files (if any) will be stored.  The default is
10343 @file{~/Mail/}.  At present, the only thing this is used for is to say
10344 where the incoming files will be stored if the previous variable is
10345 @code{nil}.
10346
10347 @item mail-source-default-file-modes
10348 @vindex mail-source-default-file-modes
10349 All new mail files will get this file mode.  The default is 384.
10350
10351 @end table
10352
10353
10354 @node Fetching Mail
10355 @subsubsection Fetching Mail
10356
10357 @vindex mail-sources
10358 @vindex nnmail-spool-file
10359 The way to actually tell Gnus where to get new mail from is to set
10360 @code{mail-sources} to a list of mail source specifiers
10361 (@pxref{Mail Source Specifiers}).
10362
10363 If this variable (and the obsolescent @code{nnmail-spool-file}) is
10364 @code{nil}, the mail backends will never attempt to fetch mail by
10365 themselves.
10366
10367 If you want to fetch mail both from your local spool as well as a POP
10368 mail server, you'd say something like:
10369
10370 @lisp
10371 (setq mail-sources
10372       '((file)
10373         (pop :server "pop3.mail.server"
10374              :password "secret")))
10375 @end lisp
10376
10377 Or, if you don't want to use any of the keyword defaults:
10378
10379 @lisp
10380 (setq mail-sources
10381       '((file :path "/var/spool/mail/user-name")
10382         (pop :server "pop3.mail.server"
10383              :user "user-name"
10384              :port "pop3"
10385              :password "secret")))
10386 @end lisp
10387
10388
10389 When you use a mail backend, Gnus will slurp all your mail from your
10390 inbox and plonk it down in your home directory.  Gnus doesn't move any
10391 mail if you're not using a mail backend---you have to do a lot of magic
10392 invocations first.  At the time when you have finished drawing the
10393 pentagram, lightened the candles, and sacrificed the goat, you really
10394 shouldn't be too surprised when Gnus moves your mail.
10395
10396
10397
10398 @node Mail Backend Variables
10399 @subsection Mail Backend Variables
10400
10401 These variables are (for the most part) pertinent to all the various
10402 mail backends.
10403
10404 @table @code
10405 @vindex nnmail-read-incoming-hook
10406 @item nnmail-read-incoming-hook
10407 The mail backends all call this hook after reading new mail.  You can
10408 use this hook to notify any mail watch programs, if you want to.
10409
10410 @vindex nnmail-split-hook
10411 @item nnmail-split-hook
10412 @findex article-decode-encoded-words
10413 @findex RFC1522 decoding
10414 @findex RFC2047 decoding
10415 Hook run in the buffer where the mail headers of each message is kept
10416 just before the splitting based on these headers is done.  The hook is
10417 free to modify the buffer contents in any way it sees fit---the buffer
10418 is discarded after the splitting has been done, and no changes performed
10419 in the buffer will show up in any files.
10420 @code{gnus-article-decode-encoded-words} is one likely function to add
10421 to this hook.
10422
10423 @vindex nnmail-pre-get-new-mail-hook
10424 @vindex nnmail-post-get-new-mail-hook
10425 @item nnmail-pre-get-new-mail-hook
10426 @itemx nnmail-post-get-new-mail-hook
10427 These are two useful hooks executed when treating new incoming
10428 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10429 starting to handle the new mail) and
10430 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10431 is done).  Here's and example of using these two hooks to change the
10432 default file modes the new mail files get:
10433
10434 @lisp
10435 (add-hook 'gnus-pre-get-new-mail-hook
10436           (lambda () (set-default-file-modes 511)))
10437
10438 (add-hook 'gnus-post-get-new-mail-hook
10439           (lambda () (set-default-file-modes 551)))
10440 @end lisp
10441
10442 @item nnmail-use-long-file-names
10443 @vindex nnmail-use-long-file-names
10444 If non-@code{nil}, the mail backends will use long file and directory
10445 names.  Groups like @samp{mail.misc} will end up in directories
10446 (assuming use of @code{nnml} backend) or files (assuming use of
10447 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
10448 the same group will end up in @file{mail/misc}.
10449
10450 @item nnmail-delete-file-function
10451 @vindex nnmail-delete-file-function
10452 @findex delete-file
10453 Function called to delete files.  It is @code{delete-file} by default.
10454
10455 @item nnmail-cache-accepted-message-ids
10456 @vindex nnmail-cache-accepted-message-ids
10457 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10458 the backend (via @code{Gcc}, for instance) into the mail duplication
10459 discovery cache.  The default is @code{nil}.
10460
10461 @end table
10462
10463
10464 @node Fancy Mail Splitting
10465 @subsection Fancy Mail Splitting
10466 @cindex mail splitting
10467 @cindex fancy mail splitting
10468
10469 @vindex nnmail-split-fancy
10470 @findex nnmail-split-fancy
10471 If the rather simple, standard method for specifying how to split mail
10472 doesn't allow you to do what you want, you can set
10473 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
10474 play with the @code{nnmail-split-fancy} variable.
10475
10476 Let's look at an example value of this variable first:
10477
10478 @lisp
10479 ;; Messages from the mailer daemon are not crossposted to any of
10480 ;; the ordinary groups.  Warnings are put in a separate group
10481 ;; from real errors.
10482 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10483                    "mail.misc"))
10484    ;; Non-error messages are crossposted to all relevant
10485    ;; groups, but we don't crosspost between the group for the
10486    ;; (ding) list and the group for other (ding) related mail.
10487    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10488          ("subject" "ding" "ding.misc"))
10489       ;; Other mailing lists...
10490       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10491       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10492       ;; People...
10493       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10494    ;; Unmatched mail goes to the catch all group.
10495    "misc.misc")
10496 @end lisp
10497
10498 This variable has the format of a @dfn{split}.  A split is a (possibly)
10499 recursive structure where each split may contain other splits.  Here are
10500 the five possible split syntaxes:
10501
10502 @enumerate
10503
10504 @item
10505 @samp{group}: If the split is a string, that will be taken as a group
10506 name.  Normal regexp match expansion will be done.  See below for
10507 examples.
10508
10509 @item
10510 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
10511 which is a string, then store the message as specified by SPLIT, if
10512 header FIELD (a regexp) contains VALUE (also a regexp).
10513
10514 @item
10515 @var{(| SPLIT...)}: If the split is a list, and the first element is
10516 @code{|} (vertical bar), then process each SPLIT until one of them
10517 matches.  A SPLIT is said to match if it will cause the mail message to
10518 be stored in one or more groups.
10519
10520 @item
10521 @var{(& SPLIT...)}: If the split is a list, and the first element is
10522 @code{&}, then process all SPLITs in the list.
10523
10524 @item
10525 @code{junk}: If the split is the symbol @code{junk}, then don't save
10526 this message. Use with extreme caution.
10527
10528 @item
10529 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
10530 element is @code{:}, then the second element will be called as a
10531 function with @var{args} given as arguments.  The function should return
10532 a SPLIT.
10533
10534 @item
10535 @var{(! FUNC SPLIT)}: If the split is a list, and the first element
10536 is @code{!}, then SPLIT will be processed, and FUNC will be called as a
10537 function with the result of SPLIT as argument. FUNC should return a split.
10538
10539 @item
10540 @code{nil}: If the split is @code{nil}, it is ignored.
10541
10542 @end enumerate
10543
10544 In these splits, @var{FIELD} must match a complete field name.
10545 @var{VALUE} must match a complete word according to the fundamental mode
10546 syntax table.  You can use @code{.*} in the regexps to match partial
10547 field names or words.  In other words, all @var{VALUE}'s are wrapped in
10548 @samp{\<} and @samp{\>} pairs.
10549
10550 @vindex nnmail-split-abbrev-alist
10551 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10552 are expanded as specified by the variable
10553 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
10554 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10555 value.
10556
10557 @vindex nnmail-split-fancy-syntax-table
10558 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10559 when all this splitting is performed.
10560
10561 If you want to have Gnus create groups dynamically based on some
10562 information in the headers (i.e., do @code{replace-match}-like
10563 substitutions in the group names), you can say things like:
10564
10565 @example
10566 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10567 @end example
10568
10569 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
10570 will be filed in @samp{mail.debian.foo}.
10571
10572 If the string contains the element @samp{\&}, then the previously
10573 matched string will be substituted.  Similarly, the elements @samp{\\1}
10574 up to @samp{\\9} will be substituted with the text matched by the
10575 groupings 1 through 9.
10576
10577
10578 @node Incorporating Old Mail
10579 @subsection Incorporating Old Mail
10580
10581 Most people have lots of old mail stored in various file formats.  If
10582 you have set up Gnus to read mail using one of the spiffy Gnus mail
10583 backends, you'll probably wish to have that old mail incorporated into
10584 your mail groups.
10585
10586 Doing so can be quite easy.
10587
10588 To take an example: You're reading mail using @code{nnml}
10589 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10590 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
10591 file filled with important, but old, mail.  You want to move it into
10592 your @code{nnml} groups.
10593
10594 Here's how:
10595
10596 @enumerate
10597 @item
10598 Go to the group buffer.
10599
10600 @item
10601 Type `G f' and give the path to the mbox file when prompted to create an
10602 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10603
10604 @item
10605 Type `SPACE' to enter the newly created group.
10606
10607 @item
10608 Type `M P b' to process-mark all articles in this group's buffer
10609 (@pxref{Setting Process Marks}).
10610
10611 @item
10612 Type `B r' to respool all the process-marked articles, and answer
10613 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10614 @end enumerate
10615
10616 All the mail messages in the mbox file will now also be spread out over
10617 all your @code{nnml} groups.  Try entering them and check whether things
10618 have gone without a glitch.  If things look ok, you may consider
10619 deleting the mbox file, but I wouldn't do that unless I was absolutely
10620 sure that all the mail has ended up where it should be.
10621
10622 Respooling is also a handy thing to do if you're switching from one mail
10623 backend to another.  Just respool all the mail in the old mail groups
10624 using the new mail backend.
10625
10626
10627 @node Expiring Mail
10628 @subsection Expiring Mail
10629 @cindex article expiry
10630
10631 Traditional mail readers have a tendency to remove mail articles when
10632 you mark them as read, in some way.  Gnus takes a fundamentally
10633 different approach to mail reading.
10634
10635 Gnus basically considers mail just to be news that has been received in
10636 a rather peculiar manner.  It does not think that it has the power to
10637 actually change the mail, or delete any mail messages.  If you enter a
10638 mail group, and mark articles as ``read'', or kill them in some other
10639 fashion, the mail articles will still exist on the system.  I repeat:
10640 Gnus will not delete your old, read mail.  Unless you ask it to, of
10641 course.
10642
10643 To make Gnus get rid of your unwanted mail, you have to mark the
10644 articles as @dfn{expirable}.  This does not mean that the articles will
10645 disappear right away, however.  In general, a mail article will be
10646 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10647 more than one week old.  If you do not mark an article as expirable, it
10648 will remain on your system until hell freezes over.  This bears
10649 repeating one more time, with some spurious capitalizations: IF you do
10650 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10651
10652 @vindex gnus-auto-expirable-newsgroups
10653 You do not have to mark articles as expirable by hand.  Groups that
10654 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10655 have all articles that you read marked as expirable automatically.  All
10656 articles marked as expirable have an @samp{E} in the first
10657 column in the summary buffer.
10658
10659 By default, if you have auto expiry switched on, Gnus will mark all the
10660 articles you read as expirable, no matter if they were read or unread
10661 before.  To avoid having articles marked as read marked as expirable
10662 automatically, you can put something like the following in your
10663 @file{.gnus} file:
10664
10665 @vindex gnus-mark-article-hook
10666 @lisp
10667 (remove-hook 'gnus-mark-article-hook
10668              'gnus-summary-mark-read-and-unread-as-read)
10669 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10670 @end lisp
10671
10672 Note that making a group auto-expirable doesn't mean that all read
10673 articles are expired---only the articles marked as expirable
10674 will be expired.  Also note that using the @kbd{d} command won't make
10675 groups expirable---only semi-automatic marking of articles as read will
10676 mark the articles as expirable in auto-expirable groups.
10677
10678 Let's say you subscribe to a couple of mailing lists, and you want the
10679 articles you have read to disappear after a while:
10680
10681 @lisp
10682 (setq gnus-auto-expirable-newsgroups
10683       "mail.nonsense-list\\|mail.nice-list")
10684 @end lisp
10685
10686 Another way to have auto-expiry happen is to have the element
10687 @code{auto-expire} in the group parameters of the group.
10688
10689 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10690 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
10691 don't really mix very well.
10692
10693 @vindex nnmail-expiry-wait
10694 The @code{nnmail-expiry-wait} variable supplies the default time an
10695 expirable article has to live.  Gnus starts counting days from when the
10696 message @emph{arrived}, not from when it was sent.  The default is seven
10697 days.
10698
10699 Gnus also supplies a function that lets you fine-tune how long articles
10700 are to live, based on what group they are in.  Let's say you want to
10701 have one month expiry period in the @samp{mail.private} group, a one day
10702 expiry period in the @samp{mail.junk} group, and a six day expiry period
10703 everywhere else:
10704
10705 @vindex nnmail-expiry-wait-function
10706 @lisp
10707 (setq nnmail-expiry-wait-function
10708       (lambda (group)
10709        (cond ((string= group "mail.private")
10710                31)
10711              ((string= group "mail.junk")
10712                1)
10713              ((string= group "important")
10714                'never)
10715              (t
10716                6))))
10717 @end lisp
10718
10719 The group names this function is fed are ``unadorned'' group
10720 names---no @samp{nnml:} prefixes and the like.
10721
10722 The @code{nnmail-expiry-wait} variable and
10723 @code{nnmail-expiry-wait-function} function can either be a number (not
10724 necessarily an integer) or one of the symbols @code{immediate} or
10725 @code{never}.
10726
10727 You can also use the @code{expiry-wait} group parameter to selectively
10728 change the expiry period (@pxref{Group Parameters}).
10729
10730 @vindex nnmail-keep-last-article
10731 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10732 expire the final article in a mail newsgroup.  This is to make life
10733 easier for procmail users.
10734
10735 @vindex gnus-total-expirable-newsgroups
10736 By the way: That line up there, about Gnus never expiring non-expirable
10737 articles, is a lie.  If you put @code{total-expire} in the group
10738 parameters, articles will not be marked as expirable, but all read
10739 articles will be put through the expiry process.  Use with extreme
10740 caution.  Even more dangerous is the
10741 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
10742 this regexp will have all read articles put through the expiry process,
10743 which means that @emph{all} old mail articles in the groups in question
10744 will be deleted after a while.  Use with extreme caution, and don't come
10745 crying to me when you discover that the regexp you used matched the
10746 wrong group and all your important mail has disappeared.  Be a
10747 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
10748 with!  So there!
10749
10750 Most people make most of their mail groups total-expirable, though.
10751
10752 @vindex gnus-inhibit-user-auto-expire
10753 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10754 commands will not mark an article as expirable, even if the group has
10755 auto-expire turned on.
10756
10757
10758 @node Washing Mail
10759 @subsection Washing Mail
10760 @cindex mail washing
10761 @cindex list server brain damage
10762 @cindex incoming mail treatment
10763
10764 Mailers and list servers are notorious for doing all sorts of really,
10765 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
10766 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10767 end of all lines passing through our server, so let's do that!!!!1!''
10768 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
10769 considered to be self-evident were not discussed.  So.  Here we are.
10770
10771 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
10772 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
10773 be shocked and dismayed by this, but I haven't got the energy.  It is to
10774 laugh.
10775
10776 Gnus provides a plethora of functions for washing articles while
10777 displaying them, but it might be nicer to do the filtering before
10778 storing the mail to disc.  For that purpose, we have three hooks and
10779 various functions that can be put in these hooks.
10780
10781 @table @code
10782 @item nnmail-prepare-incoming-hook
10783 @vindex nnmail-prepare-incoming-hook
10784 This hook is called before doing anything with the mail and is meant for
10785 grand, sweeping gestures.  It is called in a buffer that contains all
10786 the new, incoming mail.  Functions to be used include:
10787
10788 @table @code
10789 @item nnheader-ms-strip-cr
10790 @findex nnheader-ms-strip-cr
10791 Remove trailing carriage returns from each line.  This is default on
10792 Emacs running on MS machines.
10793
10794 @end table
10795
10796 @item nnmail-prepare-incoming-header-hook
10797 @vindex nnmail-prepare-incoming-header-hook
10798 This hook is called narrowed to each header.  It can be used when
10799 cleaning up the headers.  Functions that can be used include:
10800
10801 @table @code
10802 @item nnmail-remove-leading-whitespace
10803 @findex nnmail-remove-leading-whitespace
10804 Clear leading white space that ``helpful'' listservs have added to the
10805 headers to make them look nice.  Aaah.
10806
10807 @item nnmail-remove-list-identifiers
10808 @findex nnmail-remove-list-identifiers
10809 Some list servers add an identifier---for example, @samp{(idm)}---to the
10810 beginning of all @code{Subject} headers.  I'm sure that's nice for
10811 people who use stone age mail readers.  This function will remove
10812 strings that match the @code{nnmail-list-identifiers} regexp, which can
10813 also be a list of regexp.
10814
10815 For instance, if you want to remove the @samp{(idm)} and the
10816 @samp{nagnagnag} identifiers:
10817
10818 @lisp
10819 (setq nnmail-list-identifiers
10820       '("(idm)" "nagnagnag"))
10821 @end lisp
10822
10823 @item nnmail-remove-tabs
10824 @findex nnmail-remove-tabs
10825 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10826
10827 @item nnmail-fix-eudora-headers
10828 @findex nnmail-fix-eudora-headers
10829 @cindex Eudora
10830 Eudora produces broken @code{References} headers, but OK
10831 @code{In-Reply-To} headers.  This function will get rid of the
10832 @code{References} headers.
10833
10834 @end table
10835
10836 @item nnmail-prepare-incoming-message-hook
10837 @vindex nnmail-prepare-incoming-message-hook
10838 This hook is called narrowed to each message.  Functions to be used
10839 include:
10840
10841 @table @code
10842 @item article-de-quoted-unreadable
10843 @findex article-de-quoted-unreadable
10844 Decode Quoted Readable encoding.
10845
10846 @end table
10847 @end table
10848
10849
10850 @node Duplicates
10851 @subsection Duplicates
10852
10853 @vindex nnmail-treat-duplicates
10854 @vindex nnmail-message-id-cache-length
10855 @vindex nnmail-message-id-cache-file
10856 @cindex duplicate mails
10857 If you are a member of a couple of mailing lists, you will sometimes
10858 receive two copies of the same mail.  This can be quite annoying, so
10859 @code{nnmail} checks for and treats any duplicates it might find.  To do
10860 this, it keeps a cache of old @code{Message-ID}s---
10861 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10862 default.  The approximate maximum number of @code{Message-ID}s stored
10863 there is controlled by the @code{nnmail-message-id-cache-length}
10864 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10865 stored.) If all this sounds scary to you, you can set
10866 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10867 default), and @code{nnmail} won't delete duplicate mails.  Instead it
10868 will insert a warning into the head of the mail saying that it thinks
10869 that this is a duplicate of a different message.
10870
10871 This variable can also be a function.  If that's the case, the function
10872 will be called from a buffer narrowed to the message in question with
10873 the @code{Message-ID} as a parameter.  The function must return either
10874 @code{nil}, @code{warn}, or @code{delete}.
10875
10876 You can turn this feature off completely by setting the variable to
10877 @code{nil}.
10878
10879 If you want all the duplicate mails to be put into a special
10880 @dfn{duplicates} group, you could do that using the normal mail split
10881 methods:
10882
10883 @lisp
10884 (setq nnmail-split-fancy
10885       '(| ;; Messages duplicates go to a separate group.
10886           ("gnus-warning" "duplication of message" "duplicate")
10887           ;; Message from daemons, postmaster, and the like to another.
10888           (any mail "mail.misc")
10889           ;; Other rules.
10890           [ ... ] ))
10891 @end lisp
10892
10893 Or something like:
10894 @lisp
10895 (setq nnmail-split-methods
10896       '(("duplicates" "^Gnus-Warning:")
10897         ;; Other rules.
10898         [...]))
10899 @end lisp
10900
10901 Here's a neat feature: If you know that the recipient reads her mail
10902 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10903 @code{delete}, you can send her as many insults as you like, just by
10904 using a @code{Message-ID} of a mail that you know that she's already
10905 received.  Think of all the fun!  She'll never see any of it!  Whee!
10906
10907
10908 @node Not Reading Mail
10909 @subsection Not Reading Mail
10910
10911 If you start using any of the mail backends, they have the annoying
10912 habit of assuming that you want to read mail with them.  This might not
10913 be unreasonable, but it might not be what you want.
10914
10915 If you set @code{mail-sources} and @code{nnmail-spool-file} to
10916 @code{nil}, none of the backends will ever attempt to read incoming
10917 mail, which should help.
10918
10919 @vindex nnbabyl-get-new-mail
10920 @vindex nnmbox-get-new-mail
10921 @vindex nnml-get-new-mail
10922 @vindex nnmh-get-new-mail
10923 @vindex nnfolder-get-new-mail
10924 This might be too much, if, for instance, you are reading mail quite
10925 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10926 file you have stashed away with @code{nnbabyl}.  All backends have
10927 variables called backend-@code{get-new-mail}.  If you want to disable
10928 the @code{nnbabyl} mail reading, you edit the virtual server for the
10929 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10930
10931 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10932 narrowed to the article to be saved before saving it when reading
10933 incoming mail.
10934
10935
10936 @node Choosing a Mail Backend
10937 @subsection Choosing a Mail Backend
10938
10939 Gnus will read the mail spool when you activate a mail group.  The mail
10940 file is first copied to your home directory.  What happens after that
10941 depends on what format you want to store your mail in.
10942
10943 There are five different mail backends in the standard Gnus, and more
10944 backends are available separately.  The mail backend most people use
10945 (because it is the fastest and most flexible) is @code{nnml}
10946 (@pxref{Mail Spool}).
10947
10948 @menu
10949 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10950 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10951 * Mail Spool::                  Store your mail in a private spool?
10952 * MH Spool::                    An mhspool-like backend.
10953 * Mail Folders::                Having one file for each group.
10954 * Comparing Mail Backends::     An in-depth looks at pros and cons.
10955 @end menu
10956
10957
10958 @node Unix Mail Box
10959 @subsubsection Unix Mail Box
10960 @cindex nnmbox
10961 @cindex unix mail box
10962
10963 @vindex nnmbox-active-file
10964 @vindex nnmbox-mbox-file
10965 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10966 mail.  @code{nnmbox} will add extra headers to each mail article to say
10967 which group it belongs in.
10968
10969 Virtual server settings:
10970
10971 @table @code
10972 @item nnmbox-mbox-file
10973 @vindex nnmbox-mbox-file
10974 The name of the mail box in the user's home directory.
10975
10976 @item nnmbox-active-file
10977 @vindex nnmbox-active-file
10978 The name of the active file for the mail box.
10979
10980 @item nnmbox-get-new-mail
10981 @vindex nnmbox-get-new-mail
10982 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10983 into groups.
10984 @end table
10985
10986
10987 @node Rmail Babyl
10988 @subsubsection Rmail Babyl
10989 @cindex nnbabyl
10990 @cindex rmail mbox
10991
10992 @vindex nnbabyl-active-file
10993 @vindex nnbabyl-mbox-file
10994 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10995 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10996 article to say which group it belongs in.
10997
10998 Virtual server settings:
10999
11000 @table @code
11001 @item nnbabyl-mbox-file
11002 @vindex nnbabyl-mbox-file
11003 The name of the rmail mbox file.
11004
11005 @item nnbabyl-active-file
11006 @vindex nnbabyl-active-file
11007 The name of the active file for the rmail box.
11008
11009 @item nnbabyl-get-new-mail
11010 @vindex nnbabyl-get-new-mail
11011 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
11012 @end table
11013
11014
11015 @node Mail Spool
11016 @subsubsection Mail Spool
11017 @cindex nnml
11018 @cindex mail @sc{nov} spool
11019
11020 The @dfn{nnml} spool mail format isn't compatible with any other known
11021 format.  It should be used with some caution.
11022
11023 @vindex nnml-directory
11024 If you use this backend, Gnus will split all incoming mail into files,
11025 one file for each mail, and put the articles into the corresponding
11026 directories under the directory specified by the @code{nnml-directory}
11027 variable.  The default value is @file{~/Mail/}.
11028
11029 You do not have to create any directories beforehand; Gnus will take
11030 care of all that.
11031
11032 If you have a strict limit as to how many files you are allowed to store
11033 in your account, you should not use this backend.  As each mail gets its
11034 own file, you might very well occupy thousands of inodes within a few
11035 weeks.  If this is no problem for you, and it isn't a problem for you
11036 having your friendly systems administrator walking around, madly,
11037 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
11038 know that this is probably the fastest format to use.  You do not have
11039 to trudge through a big mbox file just to read your new mail.
11040
11041 @code{nnml} is probably the slowest backend when it comes to article
11042 splitting.  It has to create lots of files, and it also generates
11043 @sc{nov} databases for the incoming mails.  This makes it the fastest
11044 backend when it comes to reading mail.
11045
11046 Virtual server settings:
11047
11048 @table @code
11049 @item nnml-directory
11050 @vindex nnml-directory
11051 All @code{nnml} directories will be placed under this directory.
11052
11053 @item nnml-active-file
11054 @vindex nnml-active-file
11055 The active file for the @code{nnml} server.
11056
11057 @item nnml-newsgroups-file
11058 @vindex nnml-newsgroups-file
11059 The @code{nnml} group descriptions file.  @xref{Newsgroups File
11060 Format}.
11061
11062 @item nnml-get-new-mail
11063 @vindex nnml-get-new-mail
11064 If non-@code{nil}, @code{nnml} will read incoming mail.
11065
11066 @item nnml-nov-is-evil
11067 @vindex nnml-nov-is-evil
11068 If non-@code{nil}, this backend will ignore any @sc{nov} files.
11069
11070 @item nnml-nov-file-name
11071 @vindex nnml-nov-file-name
11072 The name of the @sc{nov} files.  The default is @file{.overview}.
11073
11074 @item nnml-prepare-save-mail-hook
11075 @vindex nnml-prepare-save-mail-hook
11076 Hook run narrowed to an article before saving.
11077
11078 @end table
11079
11080 @findex nnml-generate-nov-databases
11081 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
11082 you can do a complete update by typing @kbd{M-x
11083 nnml-generate-nov-databases}.  This command will trawl through the
11084 entire @code{nnml} hierarchy, looking at each and every article, so it
11085 might take a while to complete.  A better interface to this
11086 functionality can be found in the server buffer (@pxref{Server
11087 Commands}).
11088
11089
11090 @node MH Spool
11091 @subsubsection MH Spool
11092 @cindex nnmh
11093 @cindex mh-e mail spool
11094
11095 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
11096 @sc{nov} databases and it doesn't keep an active file.  This makes
11097 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
11098 makes it easier to write procmail scripts for.
11099
11100 Virtual server settings:
11101
11102 @table @code
11103 @item nnmh-directory
11104 @vindex nnmh-directory
11105 All @code{nnmh} directories will be located under this directory.
11106
11107 @item nnmh-get-new-mail
11108 @vindex nnmh-get-new-mail
11109 If non-@code{nil}, @code{nnmh} will read incoming mail.
11110
11111 @item nnmh-be-safe
11112 @vindex nnmh-be-safe
11113 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
11114 sure that the articles in the folder are actually what Gnus thinks they
11115 are.  It will check date stamps and stat everything in sight, so
11116 setting this to @code{t} will mean a serious slow-down.  If you never
11117 use anything but Gnus to read the @code{nnmh} articles, you do not have
11118 to set this variable to @code{t}.
11119 @end table
11120
11121
11122 @node Mail Folders
11123 @subsubsection Mail Folders
11124 @cindex nnfolder
11125 @cindex mbox folders
11126 @cindex mail folders
11127
11128 @code{nnfolder} is a backend for storing each mail group in a separate
11129 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
11130 will add extra headers to keep track of article numbers and arrival
11131 dates.
11132
11133 Virtual server settings:
11134
11135 @table @code
11136 @item nnfolder-directory
11137 @vindex nnfolder-directory
11138 All the @code{nnfolder} mail boxes will be stored under this directory.
11139
11140 @item nnfolder-active-file
11141 @vindex nnfolder-active-file
11142 The name of the active file.
11143
11144 @item nnfolder-newsgroups-file
11145 @vindex nnfolder-newsgroups-file
11146 The name of the group descriptions file.  @xref{Newsgroups File Format}.
11147
11148 @item nnfolder-get-new-mail
11149 @vindex nnfolder-get-new-mail
11150 If non-@code{nil}, @code{nnfolder} will read incoming mail.
11151
11152 @item nnfolder-save-buffer-hook
11153 @vindex nnfolder-save-buffer-hook
11154 @cindex backup files
11155 Hook run before saving the folders.  Note that Emacs does the normal
11156 backup renaming of files even with the @code{nnfolder} buffers.  If you
11157 wish to switch this off, you could say something like the following in
11158 your @file{.emacs} file:
11159
11160 @lisp
11161 (defun turn-off-backup ()
11162   (set (make-local-variable 'backup-inhibited) t))
11163
11164 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
11165 @end lisp
11166
11167 @item nnfolder-delete-mail-hook
11168 @vindex nnfolder-delete-mail-hook
11169 Hook run in a buffer narrowed to the message that is to be deleted.
11170 This function can be used to copy the message to somewhere else, or to
11171 extract some information from it before removing it.
11172
11173 @end table
11174
11175
11176 @findex nnfolder-generate-active-file
11177 @kindex M-x nnfolder-generate-active-file
11178 If you have lots of @code{nnfolder}-like files you'd like to read with
11179 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11180 command to make @code{nnfolder} aware of all likely files in
11181 @code{nnfolder-directory}.  This only works if you use long file names,
11182 though.
11183
11184 @node Comparing Mail Backends
11185 @subsubsection Comparing Mail Backends
11186
11187 First, just for terminology, the @dfn{backend} is the common word for a
11188 low-level access method---a transport, if you will, by which something
11189 is acquired.  The sense is that one's mail has to come from somewhere,
11190 and so selection of a suitable backend is required in order to get that
11191 mail within spitting distance of Gnus.
11192
11193 The same concept exists for Usenet itself: Though access to articles is
11194 typically done by NNTP these days, once upon a midnight dreary, everyone
11195 in the world got at Usenet by running a reader on the machine where the
11196 articles lay (the machine which today we call an NNTP server), and
11197 access was by the reader stepping into the articles' directory spool
11198 area directly.  One can still select between either the @code{nntp} or
11199 @code{nnspool} backends, to select between these methods, if one happens
11200 actually to live on the server (or can see its spool directly, anyway,
11201 via NFS).
11202
11203 The goal in selecting a mail backend is to pick one which
11204 simultaneously represents a suitable way of dealing with the original
11205 format plus leaving mail in a form that is convenient to use in the
11206 future.  Here are some high and low points on each:
11207
11208 @table @code
11209 @item nnmbox
11210
11211 UNIX systems have historically had a single, very common, and well-
11212 defined format.  All messages arrive in a single @dfn{spool file}, and
11213 they are delineated by a line whose regular expression matches
11214 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
11215 to make it clear in this instance that this is not the RFC-specified
11216 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
11217 historically from the Unix environment, it is simplest if one does not
11218 mess a great deal with the original mailbox format, so if one chooses
11219 this backend, Gnus' primary activity in getting mail from the real spool
11220 area to Gnus' preferred directory is simply to copy it, with no
11221 (appreciable) format change in the process.  It is the ``dumbest'' way
11222 to move mail into availability in the Gnus environment.  This makes it
11223 fast to move into place, but slow to parse, when Gnus has to look at
11224 what's where.
11225
11226 @item nnbabyl
11227
11228 Once upon a time, there was the DEC-10 and DEC-20, running operating
11229 systems called TOPS and related things, and the usual (only?) mail
11230 reading environment was a thing called Babyl.  I don't know what format
11231 was used for mail landing on the system, but Babyl had its own internal
11232 format to which mail was converted, primarily involving creating a
11233 spool-file-like entity with a scheme for inserting Babyl-specific
11234 headers and status bits above the top of each message in the file.
11235 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
11236 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
11237 to understand the mail files folks already had in existence.  Gnus (and
11238 VM, for that matter) continue to support this format because it's
11239 perceived as having some good qualities in those mailer-specific
11240 headers/status bits stuff.  RMAIL itself still exists as well, of
11241 course, and is still maintained by Stallman.
11242
11243 Both of the above forms leave your mail in a single file on your
11244 filesystem, and they must parse that entire file each time you take a
11245 look at your mail.
11246
11247 @item nnml
11248
11249 @code{nnml} is the backend which smells the most as though you were
11250 actually operating with an @code{nnspool}-accessed Usenet system.  (In
11251 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
11252 lo these years ago.)  One's mail is taken from the original spool file,
11253 and is then cut up into individual message files, 1:1.  It maintains a
11254 Usenet-style active file (analogous to what one finds in an INN- or
11255 CNews-based news system in (for instance) @file{/var/lib/news/active},
11256 or what is returned via the @samp{NNTP LIST} verb) and also creates
11257 @dfn{overview} files for efficient group entry, as has been defined for
11258 @sc{nntp} servers for some years now.  It is slower in mail-splitting,
11259 due to the creation of lots of files, updates to the @code{nnml} active
11260 file, and additions to overview files on a per-message basis, but it is
11261 extremely fast on access because of what amounts to the indexing support
11262 provided by the active file and overviews.
11263
11264 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
11265 resource which defines available places in the filesystem to put new
11266 files.  Sysadmins take a dim view of heavy inode occupation within
11267 tight, shared filesystems.  But if you live on a personal machine where
11268 the filesystem is your own and space is not at a premium, @code{nnml}
11269 wins big.
11270
11271 It is also problematic using this backend if you are living in a
11272 FAT16-based Windows world, since much space will be wasted on all these
11273 tiny files.
11274
11275 @item nnmh
11276
11277 The Rand MH mail-reading system has been around UNIX systems for a very
11278 long time; it operates by splitting one's spool file of messages into
11279 individual files, but with little or no indexing support -- @code{nnmh}
11280 is considered to be semantically equivalent to ``@code{nnml} without
11281 active file or overviews''.  This is arguably the worst choice, because
11282 one gets the slowness of individual file creation married to the
11283 slowness of access parsing when learning what's new in one's groups.
11284
11285 @item nnfolder
11286
11287 Basically the effetc of @code{nnfolder} is @code{nnmbox} (the first
11288 method described above) on a per-group basis.  That is, @code{nnmbox}
11289 itself puts *all* one's mail in one file; @code{nnfolder} provides a
11290 little bit of optimization to this so that each of one's mail groups has
11291 a Unix mail box file.  It's faster than @code{nnmbox} because each group
11292 can be parsed separately, and still provides the simple Unix mail box
11293 format requiring minimal effort in moving the mail around.  In addition, 
11294 it maintains an ``active'' file making it much faster for Gnus to figure 
11295 out how many messages there are in each separate group.
11296
11297 If you have groups that are expected to have a massive amount of
11298 messages, @code{nnfolder} is not the best choice, but if you receive
11299 only a moderate amount of mail, @code{nnfolder} is probably the most
11300 friendly mail backend all over.
11301
11302 @end table
11303
11304
11305
11306 @node Other Sources
11307 @section Other Sources
11308
11309 Gnus can do more than just read news or mail.  The methods described
11310 below allow Gnus to view directories and files as if they were
11311 newsgroups.
11312
11313 @menu
11314 * Directory Groups::      You can read a directory as if it was a newsgroup.
11315 * Anything Groups::       Dired?  Who needs dired?
11316 * Document Groups::       Single files can be the basis of a group.
11317 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
11318 * Web Searches::          Creating groups from articles that match a string.
11319 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
11320 @end menu
11321
11322
11323 @node Directory Groups
11324 @subsection Directory Groups
11325 @cindex nndir
11326 @cindex directory groups
11327
11328 If you have a directory that has lots of articles in separate files in
11329 it, you might treat it as a newsgroup.  The files have to have numerical
11330 names, of course.
11331
11332 This might be an opportune moment to mention @code{ange-ftp} (and its
11333 successor @code{efs}), that most wonderful of all wonderful Emacs
11334 packages.  When I wrote @code{nndir}, I didn't think much about it---a
11335 backend to read directories.  Big deal.
11336
11337 @code{ange-ftp} changes that picture dramatically.  For instance, if you
11338 enter the @code{ange-ftp} file name
11339 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11340 @code{ange-ftp} or @code{efs} will actually allow you to read this
11341 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
11342
11343 @code{nndir} will use @sc{nov} files if they are present.
11344
11345 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11346 articles with this method.  You can use @code{nnmh} or @code{nnml} for
11347 whatever you use @code{nndir} for, so you could switch to any of those
11348 methods if you feel the need to have a non-read-only @code{nndir}.
11349
11350
11351 @node Anything Groups
11352 @subsection Anything Groups
11353 @cindex nneething
11354
11355 From the @code{nndir} backend (which reads a single spool-like
11356 directory), it's just a hop and a skip to @code{nneething}, which
11357 pretends that any arbitrary directory is a newsgroup.  Strange, but
11358 true.
11359
11360 When @code{nneething} is presented with a directory, it will scan this
11361 directory and assign article numbers to each file.  When you enter such
11362 a group, @code{nneething} must create ``headers'' that Gnus can use.
11363 After all, Gnus is a newsreader, in case you're
11364 forgetting. @code{nneething} does this in a two-step process.  First, it
11365 snoops each file in question.  If the file looks like an article (i.e.,
11366 the first few lines look like headers), it will use this as the head.
11367 If this is just some arbitrary file without a head (e.g. a C source
11368 file), @code{nneething} will cobble up a header out of thin air.  It
11369 will use file ownership, name and date and do whatever it can with these
11370 elements.
11371
11372 All this should happen automatically for you, and you will be presented
11373 with something that looks very much like a newsgroup.  Totally like a
11374 newsgroup, to be precise.  If you select an article, it will be displayed
11375 in the article buffer, just as usual.
11376
11377 If you select a line that represents a directory, Gnus will pop you into
11378 a new summary buffer for this @code{nneething} group.  And so on.  You can
11379 traverse the entire disk this way, if you feel like, but remember that
11380 Gnus is not dired, really, and does not intend to be, either.
11381
11382 There are two overall modes to this action---ephemeral or solid.  When
11383 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11384 will not store information on what files you have read, and what files
11385 are new, and so on.  If you create a solid @code{nneething} group the
11386 normal way with @kbd{G m}, Gnus will store a mapping table between
11387 article numbers and file names, and you can treat this group like any
11388 other groups.  When you activate a solid @code{nneething} group, you will
11389 be told how many unread articles it contains, etc., etc.
11390
11391 Some variables:
11392
11393 @table @code
11394 @item nneething-map-file-directory
11395 @vindex nneething-map-file-directory
11396 All the mapping files for solid @code{nneething} groups will be stored
11397 in this directory, which defaults to @file{~/.nneething/}.
11398
11399 @item nneething-exclude-files
11400 @vindex nneething-exclude-files
11401 All files that match this regexp will be ignored.  Nice to use to exclude
11402 auto-save files and the like, which is what it does by default.
11403
11404 @item nneething-include-files
11405 @vindex nneething-include-files
11406 Regexp saying what files to include in the group.  If this variable is
11407 non-@code{nil}, only files matching this regexp will be included.
11408
11409 @item nneething-map-file
11410 @vindex nneething-map-file
11411 Name of the map files.
11412 @end table
11413
11414
11415 @node Document Groups
11416 @subsection Document Groups
11417 @cindex nndoc
11418 @cindex documentation group
11419 @cindex help group
11420
11421 @code{nndoc} is a cute little thing that will let you read a single file
11422 as a newsgroup.  Several files types are supported:
11423
11424 @table @code
11425 @cindex babyl
11426 @cindex rmail mbox
11427
11428 @item babyl
11429 The babyl (rmail) mail box.
11430 @cindex mbox
11431 @cindex Unix mbox
11432
11433 @item mbox
11434 The standard Unix mbox file.
11435
11436 @cindex MMDF mail box
11437 @item mmdf
11438 The MMDF mail box format.
11439
11440 @item news
11441 Several news articles appended into a file.
11442
11443 @item rnews
11444 @cindex rnews batch files
11445 The rnews batch transport format.
11446 @cindex forwarded messages
11447
11448 @item forward
11449 Forwarded articles.
11450
11451 @item nsmail
11452 Netscape mail boxes.
11453
11454 @item mime-parts
11455 MIME multipart messages.
11456
11457 @item standard-digest
11458 The standard (RFC 1153) digest format.
11459
11460 @item slack-digest
11461 Non-standard digest format---matches most things, but does it badly.
11462 @end table
11463
11464 You can also use the special ``file type'' @code{guess}, which means
11465 that @code{nndoc} will try to guess what file type it is looking at.
11466 @code{digest} means that @code{nndoc} should guess what digest type the
11467 file is.
11468
11469 @code{nndoc} will not try to change the file or insert any extra headers into
11470 it---it will simply, like, let you use the file as the basis for a
11471 group.  And that's it.
11472
11473 If you have some old archived articles that you want to insert into your
11474 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
11475 that.  Say you have an old @file{RMAIL} file with mail that you now want
11476 to split into your new @code{nnml} groups.  You look at that file using
11477 @code{nndoc} (using the @kbd{G f} command in the group buffer
11478 (@pxref{Foreign Groups})), set the process mark on all the articles in
11479 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
11480 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
11481 file is now also stored in lots of @code{nnml} directories, and you can
11482 delete that pesky @file{RMAIL} file.  If you have the guts!
11483
11484 Virtual server variables:
11485
11486 @table @code
11487 @item nndoc-article-type
11488 @vindex nndoc-article-type
11489 This should be one of @code{mbox}, @code{babyl}, @code{digest},
11490 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
11491 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
11492 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
11493
11494 @item nndoc-post-type
11495 @vindex nndoc-post-type
11496 This variable says whether Gnus is to consider the group a news group or
11497 a mail group.  There are two valid values:  @code{mail} (the default)
11498 and @code{news}.
11499 @end table
11500
11501 @menu
11502 * Document Server Internals::   How to add your own document types.
11503 @end menu
11504
11505
11506 @node Document Server Internals
11507 @subsubsection Document Server Internals
11508
11509 Adding new document types to be recognized by @code{nndoc} isn't
11510 difficult.  You just have to whip up a definition of what the document
11511 looks like, write a predicate function to recognize that document type,
11512 and then hook into @code{nndoc}.
11513
11514 First, here's an example document type definition:
11515
11516 @example
11517 (mmdf
11518  (article-begin .  "^\^A\^A\^A\^A\n")
11519  (body-end .  "^\^A\^A\^A\^A\n"))
11520 @end example
11521
11522 The definition is simply a unique @dfn{name} followed by a series of
11523 regexp pseudo-variable settings.  Below are the possible
11524 variables---don't be daunted by the number of variables; most document
11525 types can be defined with very few settings:
11526
11527 @table @code
11528 @item first-article
11529 If present, @code{nndoc} will skip past all text until it finds
11530 something that match this regexp.  All text before this will be
11531 totally ignored.
11532
11533 @item article-begin
11534 This setting has to be present in all document type definitions.  It
11535 says what the beginning of each article looks like.
11536
11537 @item head-begin-function
11538 If present, this should be a function that moves point to the head of
11539 the article.
11540
11541 @item nndoc-head-begin
11542 If present, this should be a regexp that matches the head of the
11543 article.
11544
11545 @item nndoc-head-end
11546 This should match the end of the head of the article.  It defaults to
11547 @samp{^$}---the empty line.
11548
11549 @item body-begin-function
11550 If present, this function should move point to the beginning of the body
11551 of the article.
11552
11553 @item body-begin
11554 This should match the beginning of the body of the article.  It defaults
11555 to @samp{^\n}.
11556
11557 @item body-end-function
11558 If present, this function should move point to the end of the body of
11559 the article.
11560
11561 @item body-end
11562 If present, this should match the end of the body of the article.
11563
11564 @item file-end
11565 If present, this should match the end of the file.  All text after this
11566 regexp will be totally ignored.
11567
11568 @end table
11569
11570 So, using these variables @code{nndoc} is able to dissect a document
11571 file into a series of articles, each with a head and a body.  However, a
11572 few more variables are needed since not all document types are all that
11573 news-like---variables needed to transform the head or the body into
11574 something that's palatable for Gnus:
11575
11576 @table @code
11577 @item prepare-body-function
11578 If present, this function will be called when requesting an article.  It
11579 will be called with point at the start of the body, and is useful if the
11580 document has encoded some parts of its contents.
11581
11582 @item article-transform-function
11583 If present, this function is called when requesting an article.  It's
11584 meant to be used for more wide-ranging transformation of both head and
11585 body of the article.
11586
11587 @item generate-head-function
11588 If present, this function is called to generate a head that Gnus can
11589 understand.  It is called with the article number as a parameter, and is
11590 expected to generate a nice head for the article in question.  It is
11591 called when requesting the headers of all articles.
11592
11593 @end table
11594
11595 Let's look at the most complicated example I can come up with---standard
11596 digests:
11597
11598 @example
11599 (standard-digest
11600  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11601  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11602  (prepare-body-function . nndoc-unquote-dashes)
11603  (body-end-function . nndoc-digest-body-end)
11604  (head-end . "^ ?$")
11605  (body-begin . "^ ?\n")
11606  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11607  (subtype digest guess))
11608 @end example
11609
11610 We see that all text before a 70-width line of dashes is ignored; all
11611 text after a line that starts with that @samp{^End of} is also ignored;
11612 each article begins with a 30-width line of dashes; the line separating
11613 the head from the body may contain a single space; and that the body is
11614 run through @code{nndoc-unquote-dashes} before being delivered.
11615
11616 To hook your own document definition into @code{nndoc}, use the
11617 @code{nndoc-add-type} function.  It takes two parameters---the first is
11618 the definition itself and the second (optional) parameter says where in
11619 the document type definition alist to put this definition.  The alist is
11620 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
11621 is of @code{mmdf} type, and so on.  These type predicates should return
11622 @code{nil} if the document is not of the correct type; @code{t} if it is
11623 of the correct type; and a number if the document might be of the
11624 correct type.  A high number means high probability; a low number means
11625 low probability with @samp{0} being the lowest valid number.
11626
11627
11628 @node SOUP
11629 @subsection SOUP
11630 @cindex SOUP
11631 @cindex offline
11632
11633 In the PC world people often talk about ``offline'' newsreaders.  These
11634 are thingies that are combined reader/news transport monstrosities.
11635 With built-in modem programs.  Yecchh!
11636
11637 Of course, us Unix Weenie types of human beans use things like
11638 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11639 transport things like Ghod intended.  And then we just use normal
11640 newsreaders.
11641
11642 However, it can sometimes be convenient to do something a that's a bit
11643 easier on the brain if you have a very slow modem, and you're not really
11644 that interested in doing things properly.
11645
11646 A file format called @sc{soup} has been developed for transporting news
11647 and mail from servers to home machines and back again.  It can be a bit
11648 fiddly.
11649
11650 First some terminology:
11651
11652 @table @dfn
11653
11654 @item server
11655 This is the machine that is connected to the outside world and where you
11656 get news and/or mail from.
11657
11658 @item home machine
11659 This is the machine that you want to do the actual reading and responding
11660 on.  It is typically not connected to the rest of the world in any way.
11661
11662 @item packet
11663 Something that contains messages and/or commands.  There are two kinds
11664 of packets:
11665
11666 @table @dfn
11667 @item message packets
11668 These are packets made at the server, and typically contain lots of
11669 messages for you to read.  These are called @file{SoupoutX.tgz} by
11670 default, where @var{X} is a number.
11671
11672 @item response packets
11673 These are packets made at the home machine, and typically contains
11674 replies that you've written.  These are called @file{SoupinX.tgz} by
11675 default, where @var{X} is a number.
11676
11677 @end table
11678
11679 @end table
11680
11681
11682 @enumerate
11683
11684 @item
11685 You log in on the server and create a @sc{soup} packet.  You can either
11686 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11687 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11688 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11689
11690 @item
11691 You transfer the packet home.  Rail, boat, car or modem will do fine.
11692
11693 @item
11694 You put the packet in your home directory.
11695
11696 @item
11697 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11698 the native or secondary server.
11699
11700 @item
11701 You read articles and mail and answer and followup to the things you
11702 want (@pxref{SOUP Replies}).
11703
11704 @item
11705 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11706 packet.
11707
11708 @item
11709 You transfer this packet to the server.
11710
11711 @item
11712 You use Gnus to mail this packet out with the @kbd{G s s} command.
11713
11714 @item
11715 You then repeat until you die.
11716
11717 @end enumerate
11718
11719 So you basically have a bipartite system---you use @code{nnsoup} for
11720 reading and Gnus for packing/sending these @sc{soup} packets.
11721
11722 @menu
11723 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
11724 * SOUP Groups::       A backend for reading @sc{soup} packets.
11725 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
11726 @end menu
11727
11728
11729 @node SOUP Commands
11730 @subsubsection SOUP Commands
11731
11732 These are commands for creating and manipulating @sc{soup} packets.
11733
11734 @table @kbd
11735 @item G s b
11736 @kindex G s b (Group)
11737 @findex gnus-group-brew-soup
11738 Pack all unread articles in the current group
11739 (@code{gnus-group-brew-soup}).  This command understands the
11740 process/prefix convention.
11741
11742 @item G s w
11743 @kindex G s w (Group)
11744 @findex gnus-soup-save-areas
11745 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11746
11747 @item G s s
11748 @kindex G s s (Group)
11749 @findex gnus-soup-send-replies
11750 Send all replies from the replies packet
11751 (@code{gnus-soup-send-replies}).
11752
11753 @item G s p
11754 @kindex G s p (Group)
11755 @findex gnus-soup-pack-packet
11756 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11757
11758 @item G s r
11759 @kindex G s r (Group)
11760 @findex nnsoup-pack-replies
11761 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11762
11763 @item O s
11764 @kindex O s (Summary)
11765 @findex gnus-soup-add-article
11766 This summary-mode command adds the current article to a @sc{soup} packet
11767 (@code{gnus-soup-add-article}).  It understands the process/prefix
11768 convention (@pxref{Process/Prefix}).
11769
11770 @end table
11771
11772
11773 There are a few variables to customize where Gnus will put all these
11774 thingies:
11775
11776 @table @code
11777
11778 @item gnus-soup-directory
11779 @vindex gnus-soup-directory
11780 Directory where Gnus will save intermediate files while composing
11781 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
11782
11783 @item gnus-soup-replies-directory
11784 @vindex gnus-soup-replies-directory
11785 This is what Gnus will use as a temporary directory while sending our
11786 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
11787
11788 @item gnus-soup-prefix-file
11789 @vindex gnus-soup-prefix-file
11790 Name of the file where Gnus stores the last used prefix.  The default is
11791 @samp{gnus-prefix}.
11792
11793 @item gnus-soup-packer
11794 @vindex gnus-soup-packer
11795 A format string command for packing a @sc{soup} packet.  The default is
11796 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11797
11798 @item gnus-soup-unpacker
11799 @vindex gnus-soup-unpacker
11800 Format string command for unpacking a @sc{soup} packet.  The default is
11801 @samp{gunzip -c %s | tar xvf -}.
11802
11803 @item gnus-soup-packet-directory
11804 @vindex gnus-soup-packet-directory
11805 Where Gnus will look for reply packets.  The default is @file{~/}.
11806
11807 @item gnus-soup-packet-regexp
11808 @vindex gnus-soup-packet-regexp
11809 Regular expression matching @sc{soup} reply packets in
11810 @code{gnus-soup-packet-directory}.
11811
11812 @end table
11813
11814
11815 @node SOUP Groups
11816 @subsubsection @sc{soup} Groups
11817 @cindex nnsoup
11818
11819 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
11820 read incoming packets, unpack them, and put them in a directory where
11821 you can read them at leisure.
11822
11823 These are the variables you can use to customize its behavior:
11824
11825 @table @code
11826
11827 @item nnsoup-tmp-directory
11828 @vindex nnsoup-tmp-directory
11829 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11830 directory.  (@file{/tmp/} by default.)
11831
11832 @item nnsoup-directory
11833 @vindex nnsoup-directory
11834 @code{nnsoup} then moves each message and index file to this directory.
11835 The default is @file{~/SOUP/}.
11836
11837 @item nnsoup-replies-directory
11838 @vindex nnsoup-replies-directory
11839 All replies will be stored in this directory before being packed into a
11840 reply packet.  The default is @file{~/SOUP/replies/"}.
11841
11842 @item nnsoup-replies-format-type
11843 @vindex nnsoup-replies-format-type
11844 The @sc{soup} format of the replies packets.  The default is @samp{?n}
11845 (rnews), and I don't think you should touch that variable.  I probably
11846 shouldn't even have documented it.  Drats!  Too late!
11847
11848 @item nnsoup-replies-index-type
11849 @vindex nnsoup-replies-index-type
11850 The index type of the replies packet.  The default is @samp{?n}, which
11851 means ``none''.  Don't fiddle with this one either!
11852
11853 @item nnsoup-active-file
11854 @vindex nnsoup-active-file
11855 Where @code{nnsoup} stores lots of information.  This is not an ``active
11856 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
11857 this file or mess it up in any way, you're dead.  The default is
11858 @file{~/SOUP/active}.
11859
11860 @item nnsoup-packer
11861 @vindex nnsoup-packer
11862 Format string command for packing a reply @sc{soup} packet.  The default
11863 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11864
11865 @item nnsoup-unpacker
11866 @vindex nnsoup-unpacker
11867 Format string command for unpacking incoming @sc{soup} packets.  The
11868 default is @samp{gunzip -c %s | tar xvf -}.
11869
11870 @item nnsoup-packet-directory
11871 @vindex nnsoup-packet-directory
11872 Where @code{nnsoup} will look for incoming packets.  The default is
11873 @file{~/}.
11874
11875 @item nnsoup-packet-regexp
11876 @vindex nnsoup-packet-regexp
11877 Regular expression matching incoming @sc{soup} packets.  The default is
11878 @samp{Soupout}.
11879
11880 @item nnsoup-always-save
11881 @vindex nnsoup-always-save
11882 If non-@code{nil}, save the replies buffer after each posted message.
11883
11884 @end table
11885
11886
11887 @node SOUP Replies
11888 @subsubsection SOUP Replies
11889
11890 Just using @code{nnsoup} won't mean that your postings and mailings end
11891 up in @sc{soup} reply packets automagically.  You have to work a bit
11892 more for that to happen.
11893
11894 @findex nnsoup-set-variables
11895 The @code{nnsoup-set-variables} command will set the appropriate
11896 variables to ensure that all your followups and replies end up in the
11897 @sc{soup} system.
11898
11899 In specific, this is what it does:
11900
11901 @lisp
11902 (setq message-send-news-function 'nnsoup-request-post)
11903 (setq message-send-mail-function 'nnsoup-request-mail)
11904 @end lisp
11905
11906 And that's it, really.  If you only want news to go into the @sc{soup}
11907 system you just use the first line.  If you only want mail to be
11908 @sc{soup}ed you use the second.
11909
11910
11911 @node Web Searches
11912 @subsection Web Searches
11913 @cindex nnweb
11914 @cindex DejaNews
11915 @cindex Alta Vista
11916 @cindex InReference
11917 @cindex Usenet searches
11918 @cindex searching the Usenet
11919
11920 It's, like, too neat to search the Usenet for articles that match a
11921 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11922 those, like, Web browsers, and you, like, have to, rilly, like, look at
11923 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11924 searches without having to use a browser.
11925
11926 The @code{nnweb} backend allows an easy interface to the mighty search
11927 engine.  You create an @code{nnweb} group, enter a search pattern, and
11928 then enter the group and read the articles like you would any normal
11929 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
11930 Groups}) will do this in an easy-to-use fashion.
11931
11932 @code{nnweb} groups don't really lend themselves to being solid
11933 groups---they have a very fleeting idea of article numbers.  In fact,
11934 each time you enter an @code{nnweb} group (not even changing the search
11935 pattern), you are likely to get the articles ordered in a different
11936 manner.  Not even using duplicate suppression (@pxref{Duplicate
11937 Suppression}) will help, since @code{nnweb} doesn't even know the
11938 @code{Message-ID} of the articles before reading them using some search
11939 engines (DejaNews, for instance).  The only possible way to keep track
11940 of which articles you've read is by scoring on the @code{Date}
11941 header---mark all articles posted before the last date you read the
11942 group as read.
11943
11944 If the search engine changes its output substantially, @code{nnweb}
11945 won't be able to parse it and will fail.  One could hardly fault the Web
11946 providers if they were to do this---their @emph{raison d'être} is to
11947 make money off of advertisements, not to provide services to the
11948 community.  Since @code{nnweb} washes the ads off all the articles, one
11949 might think that the providers might be somewhat miffed.  We'll see.
11950
11951 You must have the @code{url} and @code{w3} package installed to be able
11952 to use @code{nnweb}.
11953
11954 Virtual server variables:
11955
11956 @table @code
11957 @item nnweb-type
11958 @vindex nnweb-type
11959 What search engine type is being used.  The currently supported types
11960 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11961 @code{reference}.
11962
11963 @item nnweb-search
11964 @vindex nnweb-search
11965 The search string to feed to the search engine.
11966
11967 @item nnweb-max-hits
11968 @vindex nnweb-max-hits
11969 Advisory maximum number of hits per search to display.  The default is
11970 100.
11971
11972 @item nnweb-type-definition
11973 @vindex nnweb-type-definition
11974 Type-to-definition alist.  This alist says what @code{nnweb} should do
11975 with the various search engine types.  The following elements must be
11976 present:
11977
11978 @table @code
11979 @item article
11980 Function to decode the article and provide something that Gnus
11981 understands.
11982
11983 @item map
11984 Function to create an article number to message header and URL alist.
11985
11986 @item search
11987 Function to send the search string to the search engine.
11988
11989 @item address
11990 The address the aforementioned function should send the search string
11991 to.
11992
11993 @item id
11994 Format string URL to fetch an article by @code{Message-ID}.
11995 @end table
11996
11997 @end table
11998
11999
12000
12001 @node Mail-To-News Gateways
12002 @subsection Mail-To-News Gateways
12003 @cindex mail-to-news gateways
12004 @cindex gateways
12005
12006 If your local @code{nntp} server doesn't allow posting, for some reason
12007 or other, you can post using one of the numerous mail-to-news gateways.
12008 The @code{nngateway} backend provides the interface.
12009
12010 Note that you can't read anything from this backend---it can only be
12011 used to post with.
12012
12013 Server variables:
12014
12015 @table @code
12016 @item nngateway-address
12017 @vindex nngateway-address
12018 This is the address of the mail-to-news gateway.
12019
12020 @item nngateway-header-transformation
12021 @vindex nngateway-header-transformation
12022 News headers often have to be transformed in some odd way or other
12023 for the mail-to-news gateway to accept it.  This variable says what
12024 transformation should be called, and defaults to
12025 @code{nngateway-simple-header-transformation}.  The function is called
12026 narrowed to the headers to be transformed and with one parameter---the
12027 gateway address.
12028
12029 This default function just inserts a new @code{To} header based on the
12030 @code{Newsgroups} header and the gateway address.
12031 For instance, an article with this @code{Newsgroups} header:
12032
12033 @example
12034 Newsgroups: alt.religion.emacs
12035 @end example
12036
12037 will get this @code{From} header inserted:
12038
12039 @example
12040 To: alt-religion-emacs@@GATEWAY
12041 @end example
12042
12043 The following pre-defined functions exist:
12044
12045 @findex nngateway-simple-header-transformation
12046 @table @code
12047
12048 @item nngateway-simple-header-transformation
12049 Creates a @code{To} header that looks like
12050 @var{newsgroup}@@@code{nngateway-address}.
12051
12052 @findex nngateway-mail2news-header-transformation
12053
12054 @item nngateway-mail2news-header-transformation
12055 Creates a @code{To} header that looks like
12056 @code{nngateway-address}.
12057
12058 Here's an example:
12059
12060 @lisp
12061 (setq gnus-post-method
12062       '(nngateway "mail2news@@replay.com"
12063                   (nngateway-header-transformation
12064                    nngateway-mail2news-header-transformation)))
12065 @end lisp
12066
12067 @end table
12068
12069
12070 @end table
12071
12072 So, to use this, simply say something like:
12073
12074 @lisp
12075 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
12076 @end lisp
12077
12078
12079 @node Combined Groups
12080 @section Combined Groups
12081
12082 Gnus allows combining a mixture of all the other group types into bigger
12083 groups.
12084
12085 @menu
12086 * Virtual Groups::     Combining articles from many groups.
12087 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
12088 @end menu
12089
12090
12091 @node Virtual Groups
12092 @subsection Virtual Groups
12093 @cindex nnvirtual
12094 @cindex virtual groups
12095 @cindex merging groups
12096
12097 An @dfn{nnvirtual group} is really nothing more than a collection of
12098 other groups.
12099
12100 For instance, if you are tired of reading many small groups, you can
12101 put them all in one big group, and then grow tired of reading one
12102 big, unwieldy group.  The joys of computing!
12103
12104 You specify @code{nnvirtual} as the method.  The address should be a
12105 regexp to match component groups.
12106
12107 All marks in the virtual group will stick to the articles in the
12108 component groups.  So if you tick an article in a virtual group, the
12109 article will also be ticked in the component group from whence it came.
12110 (And vice versa---marks from the component groups will also be shown in
12111 the virtual group.)
12112
12113 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
12114 newsgroups into one, big, happy newsgroup:
12115
12116 @lisp
12117 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
12118 @end lisp
12119
12120 The component groups can be native or foreign; everything should work
12121 smoothly, but if your computer explodes, it was probably my fault.
12122
12123 Collecting the same group from several servers might actually be a good
12124 idea if users have set the Distribution header to limit distribution.
12125 If you would like to read @samp{soc.motss} both from a server in Japan
12126 and a server in Norway, you could use the following as the group regexp:
12127
12128 @example
12129 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
12130 @end example
12131
12132 (Remember, though, that if you're creating the group with @kbd{G m}, you
12133 shouldn't double the backslashes, and you should leave off the quote
12134 characters at the beginning and the end of the string.)
12135
12136 This should work kinda smoothly---all articles from both groups should
12137 end up in this one, and there should be no duplicates.  Threading (and
12138 the rest) will still work as usual, but there might be problems with the
12139 sequence of articles.  Sorting on date might be an option here
12140 (@pxref{Selecting a Group}).
12141
12142 One limitation, however---all groups included in a virtual
12143 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
12144 zombie groups can't be component groups for @code{nnvirtual} groups.
12145
12146 @vindex nnvirtual-always-rescan
12147 If the @code{nnvirtual-always-rescan} is non-@code{nil},
12148 @code{nnvirtual} will always scan groups for unread articles when
12149 entering a virtual group.  If this variable is @code{nil} (which is the
12150 default) and you read articles in a component group after the virtual
12151 group has been activated, the read articles from the component group
12152 will show up when you enter the virtual group.  You'll also see this
12153 effect if you have two virtual groups that have a component group in
12154 common.  If that's the case, you should set this variable to @code{t}.
12155 Or you can just tap @code{M-g} on the virtual group every time before
12156 you enter it---it'll have much the same effect.
12157
12158 @code{nnvirtual} can have both mail and news groups as component groups.
12159 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
12160 has to ask the backend of the component group the article comes from
12161 whether it is a news or mail backend.  However, when you do a @kbd{^},
12162 there is typically no sure way for the component backend to know this,
12163 and in that case @code{nnvirtual} tells Gnus that the article came from a
12164 not-news backend.  (Just to be on the safe side.)
12165
12166 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
12167 line from the article you respond to in these cases.
12168
12169
12170
12171 @node Kibozed Groups
12172 @subsection Kibozed Groups
12173 @cindex nnkiboze
12174 @cindex kibozing
12175
12176 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
12177 the news feed''.  @code{nnkiboze} is a backend that will do this for
12178 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
12179 with useless requests!  Oh happiness!
12180
12181 @kindex G k (Group)
12182 To create a kibozed group, use the @kbd{G k} command in the group
12183 buffer.
12184
12185 The address field of the @code{nnkiboze} method is, as with
12186 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
12187 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
12188 and @code{nnvirtual} end.
12189
12190 In addition to this regexp detailing component groups, an @code{nnkiboze} group
12191 must have a score file to say what articles are to be included in
12192 the group (@pxref{Scoring}).
12193
12194 @kindex M-x nnkiboze-generate-groups
12195 @findex nnkiboze-generate-groups
12196 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
12197 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
12198 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
12199 all the articles in all the component groups and run them through the
12200 scoring process to determine if there are any articles in the groups
12201 that are to be part of the @code{nnkiboze} groups.
12202
12203 Please limit the number of component groups by using restrictive
12204 regexps.  Otherwise your sysadmin may become annoyed with you, and the
12205 @sc{nntp} site may throw you off and never let you back in again.
12206 Stranger things have happened.
12207
12208 @code{nnkiboze} component groups do not have to be alive---they can be dead,
12209 and they can be foreign.  No restrictions.
12210
12211 @vindex nnkiboze-directory
12212 The generation of an @code{nnkiboze} group means writing two files in
12213 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
12214 contains the @sc{nov} header lines for all the articles in the group,
12215 and the other is an additional @file{.newsrc} file to store information
12216 on what groups have been searched through to find component articles.
12217
12218 Articles marked as read in the @code{nnkiboze} group will have
12219 their @sc{nov} lines removed from the @sc{nov} file.
12220
12221
12222 @node Gnus Unplugged
12223 @section Gnus Unplugged
12224 @cindex offline
12225 @cindex unplugged
12226 @cindex Agent
12227 @cindex Gnus Agent
12228 @cindex Gnus Unplugged
12229
12230 In olden times (ca. February '88), people used to run their newsreaders
12231 on big machines with permanent connections to the net.  News transport
12232 was dealt with by news servers, and all the newsreaders had to do was to
12233 read news.  Believe it or not.
12234
12235 Nowadays most people read news and mail at home, and use some sort of
12236 modem to connect to the net.  To avoid running up huge phone bills, it
12237 would be nice to have a way to slurp down all the news and mail, hang up
12238 the phone, read for several hours, and then upload any responses you
12239 have to make.  And then you repeat the procedure.
12240
12241 Of course, you can use news servers for doing this as well.  I've used
12242 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
12243 for some years, but doing that's a bore.  Moving the news server
12244 functionality up to the newsreader makes sense if you're the only person
12245 reading news on a machine.
12246
12247 Using Gnus as an ``offline'' newsreader is quite simple.
12248
12249 @itemize @bullet
12250 @item
12251 First, set up Gnus as you would do if you were running it on a machine
12252 that has full connection to the net.  Go ahead.  I'll still be waiting
12253 here.
12254
12255 @item
12256 Then, put the following magical incantation at the end of your
12257 @file{.gnus.el} file:
12258
12259 @lisp
12260 (gnus-agentize)
12261 @end lisp
12262 @end itemize
12263
12264 That's it.  Gnus is now an ``offline'' newsreader.
12265
12266 Of course, to use it as such, you have to learn a few new commands.
12267
12268 @menu
12269 * Agent Basics::           How it all is supposed to work.
12270 * Agent Categories::       How to tell the Gnus Agent what to download.
12271 * Agent Commands::         New commands for all the buffers.
12272 * Agent Expiry::           How to make old articles go away.
12273 * Outgoing Messages::      What happens when you post/mail something?
12274 * Agent Variables::        Customizing is fun.
12275 * Example Setup::          An example @file{.gnus.el} file for offline people.
12276 * Batching Agents::        How to fetch news from a @code{cron} job.
12277 * Agent Caveats::          What you think it'll do and what it does.
12278 @end menu
12279
12280
12281 @node Agent Basics
12282 @subsection Agent Basics
12283
12284 First, let's get some terminology out of the way.
12285
12286 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
12287 connection to the net (and notified the Agent that this is the case).
12288 When the connection to the net is up again (and Gnus knows this), the
12289 Agent is @dfn{plugged}.
12290
12291 The @dfn{local} machine is the one you're running on, and which isn't
12292 connected to the net continuously.
12293
12294 @dfn{Downloading} means fetching things from the net to your local
12295 machine.  @dfn{Uploading} is doing the opposite.
12296
12297 Let's take a typical Gnus session using the Agent.
12298
12299 @itemize @bullet
12300
12301 @item
12302 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
12303 Agent in a disconnected state.  You can read all the news that you have
12304 already fetched while in this mode.
12305
12306 @item
12307 You then decide to see whether any new news has arrived.  You connect
12308 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
12309 to make Gnus become @dfn{plugged}.
12310
12311 @item
12312 You can then read the new news immediately, or you can download the news
12313 onto your local machine.  If you want to do the latter, you press @kbd{J
12314 s} to fetch all the eligible articles in all the groups.  (To let Gnus
12315 know which articles you want to download, @pxref{Agent Categories}.)
12316
12317 @item
12318 After fetching the articles, you press @kbd{J j} to make Gnus become
12319 unplugged again, and you shut down the PPP thing (or whatever).  And
12320 then you read the news offline.
12321
12322 @item
12323 And then you go to step 2.
12324 @end itemize
12325
12326 Here are some things you should do the first time (or so) that you use
12327 the Agent.
12328
12329 @itemize @bullet
12330
12331 @item
12332 Decide which servers should be covered by the Agent.  If you have a mail
12333 backend, it would probably be nonsensical to have it covered by the
12334 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
12335 @kbd{J a} the server (or servers) that you wish to have covered by the
12336 Agent (@pxref{Server Agent Commands}).  This will typically be only the
12337 primary select method, which is listed on the bottom in the buffer.
12338
12339 @item
12340 Decide on download policy.  @xref{Agent Categories}.
12341
12342 @item
12343 Uhm... that's it.
12344 @end itemize
12345
12346
12347 @node Agent Categories
12348 @subsection Agent Categories
12349
12350 One of the main reasons to integrate the news transport layer into the
12351 newsreader is to allow greater control over what articles to download.
12352 There's not much point in downloading huge amounts of articles, just to
12353 find out that you're not interested in reading any of them.  It's better
12354 to be somewhat more conservative in choosing what to download, and then
12355 mark the articles for downloading manually if it should turn out that
12356 you're interested in the articles anyway.
12357
12358 The main way to control what is to be downloaded is to create a
12359 @dfn{category} and then assign some (or all) groups to this category.
12360 Groups that do not belong in any other category belong to the
12361 @code{default} category. Gnus has its own buffer for creating and
12362 managing categories.
12363
12364 @menu
12365 * Category Syntax::       What a category looks like.
12366 * The Category Buffer::   A buffer for maintaining categories.
12367 * Category Variables::    Customize'r'Us.
12368 @end menu
12369
12370
12371 @node Category Syntax
12372 @subsubsection Category Syntax
12373
12374 A category consists of two things.
12375
12376 @enumerate
12377 @item
12378 A predicate which (generally) gives a rough outline of which articles
12379 are eligible for downloading; and
12380
12381 @item
12382 a score rule which (generally) gives you a finer granularity when
12383 deciding what articles to download.  (Note that this @dfn{download
12384 score} is not necessarily related to normal scores.)
12385 @end enumerate
12386
12387 A predicate in its simplest form can be a single predicate such as
12388 @code{true} or @code{false}. These two will download every available
12389 article or nothing respectively. In the case of these two special
12390 predicates an additional score rule is superfluous.
12391
12392 Predicates of @code{high} or @code{low} download articles in respect of
12393 their scores in relationship to @code{gnus-agent-high-score} and
12394 @code{gnus-agent-low-score} as descibed below.
12395
12396 To gain even finer control of what is to be regarded eligible for
12397 download a predicate can consist of a number of predicates with logical
12398 operators sprinkled in between.
12399
12400 Perhaps some examples are in order.
12401
12402 Here's a simple predicate.  (It's the default predicate, in fact, used
12403 for all groups that don't belong to any other category.)
12404
12405 @lisp
12406 short
12407 @end lisp
12408
12409 Quite simple, eh?  This predicate is true if and only if the article is
12410 short (for some value of ``short'').
12411
12412 Here's a more complex predicate:
12413
12414 @lisp
12415 (or high
12416     (and
12417      (not low)
12418      (not long)))
12419 @end lisp
12420
12421 This means that an article should be downloaded if it has a high score,
12422 or if the score is not low and the article is not long.  You get the
12423 drift.
12424
12425 The available logical operators are @code{or}, @code{and} and
12426 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
12427 @samp{|}, @code{&} and @code{!} instead.)
12428
12429 The following predicates are pre-defined, but if none of these fit what
12430 you want to do, you can write your own.
12431
12432 @table @code
12433 @item short
12434 True iff the article is shorter than @code{gnus-agent-short-article}
12435 lines; default 100.
12436
12437 @item long
12438 True iff the article is longer than @code{gnus-agent-long-article}
12439 lines; default 200.
12440
12441 @item low
12442 True iff the article has a download score less than
12443 @code{gnus-agent-low-score}; default 0.
12444
12445 @item high
12446 True iff the article has a download score greater than
12447 @code{gnus-agent-high-score}; default 0.
12448
12449 @item spam
12450 True iff the Gnus Agent guesses that the article is spam.  The
12451 heuristics may change over time, but at present it just computes a
12452 checksum and sees whether articles match.
12453
12454 @item true
12455 Always true.
12456
12457 @item false
12458 Always false.
12459 @end table
12460
12461 If you want to create your own predicate function, here's what you have
12462 to know:  The functions are called with no parameters, but the
12463 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
12464 useful values.
12465
12466 For example, you could decide that you don't want to download articles
12467 that were posted more than a certain number of days ago (e.g. posted
12468 more than @code{gnus-agent-expire-days} ago) you might write a function
12469 something along the lines of the following:
12470
12471 @lisp
12472 (defun my-article-old-p ()
12473   "Say whether an article is old."
12474   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
12475      (- (time-to-days (current-time)) gnus-agent-expire-days)))
12476 @end lisp
12477
12478 with the predicate then defined as:
12479
12480 @lisp
12481 (not my-article-old-p)
12482 @end lisp
12483
12484 or you could append your predicate to the predefined
12485 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
12486 wherever.  (Note: this would have to be at a point *after*
12487 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
12488
12489 @lisp
12490 (defvar  gnus-category-predicate-alist
12491   (append gnus-category-predicate-alist
12492          '((old . my-article-old-p))))
12493 @end lisp
12494
12495 and simply specify your predicate as:
12496
12497 @lisp
12498 (not old)
12499 @end lisp
12500
12501 If/when using something like the above, be aware that there are many
12502 misconfigured systems/mailers out there and so an article's date is not
12503 always a reliable indication of when it was posted. Hell, some people
12504 just don't give a damm.
12505
12506
12507 The above predicates apply to *all* the groups which belong to the
12508 category. However, if you wish to have a specific predicate for an
12509 individual group within a category, or you're just too lazy to set up a
12510 new category, you can enter a group's individual predicate in it's group
12511 parameters like so:
12512
12513 @lisp
12514 (agent-predicate . short)
12515 @end lisp
12516
12517 This is the group parameter equivalent of the agent category
12518 default. Note that when specifying a single word predicate like this,
12519 the @code{agent-predicate} specification must be in dotted pair
12520 notation.
12521
12522 The equivalent of the longer example from above would be:
12523
12524 @lisp
12525 (agent-predicate or high (and (not low) (not long)))
12526 @end lisp
12527
12528 The outer parenthesis required in the category specification are not
12529 entered here as, not being in dotted pair notation, the value of the
12530 predicate is assumed to be a list.
12531
12532
12533 Now, the syntax of the download score is the same as the syntax of
12534 normal score files, except that all elements that require actually
12535 seeing the article itself are verboten.  This means that only the
12536 following headers can be scored on: @code{Subject}, @code{From},
12537 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12538 @code{Lines}, and @code{Xref}.
12539
12540 As with predicates, the specification of the @code{download score rule}
12541 to use in respect of a group can be in either the category definition if
12542 it's to be applicable to all groups in therein, or a group's parameters
12543 if it's to be specific to that group.
12544
12545 In both of these places the @code{download score rule} can take one of
12546 three forms:
12547
12548 @enumerate
12549 @item
12550 Score rule
12551
12552 This has the same syntax as a normal gnus score file except only a
12553 subset of scoring keywords are available as mentioned above.
12554
12555 example:
12556
12557 @itemize @bullet
12558 @item
12559 Category specification
12560
12561 @lisp
12562 (("from"
12563        ("Lars Ingebrigtsen" 1000000 nil s))
12564 ("lines"
12565        (500 -100 nil <)))
12566 @end lisp
12567
12568 @item
12569 Group Parameter specification
12570
12571 @lisp
12572 (agent-score ("from"
12573                    ("Lars Ingebrigtsen" 1000000 nil s))
12574              ("lines"
12575                    (500 -100 nil <)))
12576 @end lisp
12577
12578 Again, note the omission of the outermost parenthesis here.
12579 @end itemize
12580
12581 @item
12582 Agent score file
12583
12584 These score files must *only* contain the permitted scoring keywords
12585 stated above.
12586
12587 example:
12588
12589 @itemize @bullet
12590 @item
12591 Category specification
12592
12593 @lisp
12594 ("~/News/agent.SCORE")
12595 @end lisp
12596
12597 or perhaps
12598
12599 @lisp
12600 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12601 @end lisp
12602
12603 @item
12604 Group Parameter specification
12605
12606 @lisp
12607 (agent-score "~/News/agent.SCORE")
12608 @end lisp
12609
12610 Additional score files can be specified as above. Need I say anything
12611 about parenthesis.
12612 @end itemize
12613
12614 @item
12615 Use @code{normal} score files
12616
12617 If you dont want to maintain two sets of scoring rules for a group, and
12618 your desired @code{downloading} criteria for a group are the same as your
12619 @code{reading} criteria then you can tell the agent to refer to your
12620 @code{normal} score files when deciding what to download.
12621
12622 These directives in either the category definition or a group's
12623 parameters will cause the agent to read in all the applicable score
12624 files for a group, *filtering out* those those sections that do not
12625 relate to one of the permitted subset of scoring keywords.
12626
12627 @itemize @bullet
12628 @item
12629 Category Specification
12630
12631 @lisp
12632 file
12633 @end lisp
12634
12635 @item
12636 Group Parameter specification
12637
12638 @lisp
12639 (agent-score . file)
12640 @end lisp
12641 @end itemize
12642 @end enumerate
12643
12644 @node The Category Buffer
12645 @subsubsection The Category Buffer
12646
12647 You'd normally do all category maintenance from the category buffer.
12648 When you enter it for the first time (with the @kbd{J c} command from
12649 the group buffer), you'll only see the @code{default} category.
12650
12651 The following commands are available in this buffer:
12652
12653 @table @kbd
12654 @item q
12655 @kindex q (Category)
12656 @findex gnus-category-exit
12657 Return to the group buffer (@code{gnus-category-exit}).
12658
12659 @item k
12660 @kindex k (Category)
12661 @findex gnus-category-kill
12662 Kill the current category (@code{gnus-category-kill}).
12663
12664 @item c
12665 @kindex c (Category)
12666 @findex gnus-category-copy
12667 Copy the current category (@code{gnus-category-copy}).
12668
12669 @item a
12670 @kindex a (Category)
12671 @findex gnus-category-add
12672 Add a new category (@code{gnus-category-add}).
12673
12674 @item p
12675 @kindex p (Category)
12676 @findex gnus-category-edit-predicate
12677 Edit the predicate of the current category
12678 (@code{gnus-category-edit-predicate}).
12679
12680 @item g
12681 @kindex g (Category)
12682 @findex gnus-category-edit-groups
12683 Edit the list of groups belonging to the current category
12684 (@code{gnus-category-edit-groups}).
12685
12686 @item s
12687 @kindex s (Category)
12688 @findex gnus-category-edit-score
12689 Edit the download score rule of the current category
12690 (@code{gnus-category-edit-score}).
12691
12692 @item l
12693 @kindex l (Category)
12694 @findex gnus-category-list
12695 List all the categories (@code{gnus-category-list}).
12696 @end table
12697
12698
12699 @node Category Variables
12700 @subsubsection Category Variables
12701
12702 @table @code
12703 @item gnus-category-mode-hook
12704 @vindex gnus-category-mode-hook
12705 Hook run in category buffers.
12706
12707 @item gnus-category-line-format
12708 @vindex gnus-category-line-format
12709 Format of the lines in the category buffer (@pxref{Formatting
12710 Variables}).  Valid elements are:
12711
12712 @table @samp
12713 @item c
12714 The name of the category.
12715
12716 @item g
12717 The number of groups in the category.
12718 @end table
12719
12720 @item gnus-category-mode-line-format
12721 @vindex gnus-category-mode-line-format
12722 Format of the category mode line (@pxref{Mode Line Formatting}).
12723
12724 @item gnus-agent-short-article
12725 @vindex gnus-agent-short-article
12726 Articles that have fewer lines than this are short.  Default 100.
12727
12728 @item gnus-agent-long-article
12729 @vindex gnus-agent-long-article
12730 Articles that have more lines than this are long.  Default 200.
12731
12732 @item gnus-agent-low-score
12733 @vindex gnus-agent-low-score
12734 Articles that have a score lower than this have a low score.  Default
12735 0.
12736
12737 @item gnus-agent-high-score
12738 @vindex gnus-agent-high-score
12739 Articles that have a score higher than this have a high score.  Default
12740 0.
12741
12742 @end table
12743
12744
12745 @node Agent Commands
12746 @subsection Agent Commands
12747
12748 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
12749 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12750 toggles the plugged/unplugged state of the Gnus Agent.
12751
12752
12753 @menu
12754 * Group Agent Commands::
12755 * Summary Agent Commands::
12756 * Server Agent Commands::
12757 @end menu
12758
12759 You can run a complete batch fetch from the command line with the
12760 following incantation:
12761
12762 @cindex gnus-agent-batch-fetch
12763 @example
12764 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12765 @end example
12766
12767
12768
12769 @node Group Agent Commands
12770 @subsubsection Group Agent Commands
12771
12772 @table @kbd
12773 @item J u
12774 @kindex J u (Agent Group)
12775 @findex gnus-agent-fetch-groups
12776 Fetch all eligible articles in the current group
12777 (@code{gnus-agent-fetch-groups}).
12778
12779 @item J c
12780 @kindex J c (Agent Group)
12781 @findex gnus-enter-category-buffer
12782 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12783
12784 @item J s
12785 @kindex J s (Agent Group)
12786 @findex gnus-agent-fetch-session
12787 Fetch all eligible articles in all groups
12788 (@code{gnus-agent-fetch-session}).
12789
12790 @item J S
12791 @kindex J S (Agent Group)
12792 @findex gnus-group-send-drafts
12793 Send all sendable messages in the draft group
12794 (@code{gnus-agent-fetch-session}).  @xref{Drafts}.
12795
12796 @item J a
12797 @kindex J a (Agent Group)
12798 @findex gnus-agent-add-group
12799 Add the current group to an Agent category
12800 (@code{gnus-agent-add-group}).  This command understands the
12801 process/prefix convention (@pxref{Process/Prefix}).
12802
12803 @item J r
12804 @kindex J r (Agent Group)
12805 @findex gnus-agent-remove-group
12806 Remove the current group from its category, if any
12807 (@code{gnus-agent-remove-group}).  This command understands the
12808 process/prefix convention (@pxref{Process/Prefix}).
12809
12810 @end table
12811
12812
12813 @node Summary Agent Commands
12814 @subsubsection Summary Agent Commands
12815
12816 @table @kbd
12817 @item J #
12818 @kindex J # (Agent Summary)
12819 @findex gnus-agent-mark-article
12820 Mark the article for downloading (@code{gnus-agent-mark-article}).
12821
12822 @item J M-#
12823 @kindex J M-# (Agent Summary)
12824 @findex gnus-agent-unmark-article
12825 Remove the downloading mark from the article
12826 (@code{gnus-agent-unmark-article}).
12827
12828 @item @@
12829 @kindex @@ (Agent Summary)
12830 @findex gnus-agent-toggle-mark
12831 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12832
12833 @item J c
12834 @kindex J c (Agent Summary)
12835 @findex gnus-agent-catchup
12836 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12837
12838 @end table
12839
12840
12841 @node Server Agent Commands
12842 @subsubsection Server Agent Commands
12843
12844 @table @kbd
12845 @item J a
12846 @kindex J a (Agent Server)
12847 @findex gnus-agent-add-server
12848 Add the current server to the list of servers covered by the Gnus Agent
12849 (@code{gnus-agent-add-server}).
12850
12851 @item J r
12852 @kindex J r (Agent Server)
12853 @findex gnus-agent-remove-server
12854 Remove the current server from the list of servers covered by the Gnus
12855 Agent (@code{gnus-agent-remove-server}).
12856
12857 @end table
12858
12859
12860 @node Agent Expiry
12861 @subsection Agent Expiry
12862
12863 @vindex gnus-agent-expire-days
12864 @findex gnus-agent-expire
12865 @kindex M-x gnus-agent-expire
12866 @cindex Agent expiry
12867 @cindex Gnus Agent expiry
12868 @cindex expiry
12869
12870 @code{nnagent} doesn't handle expiry.  Instead, there's a special
12871 @code{gnus-agent-expire} command that will expire all read articles that
12872 are older than @code{gnus-agent-expire-days} days.  It can be run
12873 whenever you feel that you're running out of space.  It's not
12874 particularly fast or efficient, and it's not a particularly good idea to
12875 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12876
12877 @vindex gnus-agent-expire-all
12878 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12879 expire all articles---unread, read, ticked and dormant.  If @code{nil}
12880 (which is the default), only read articles are eligible for expiry, and
12881 unread, ticked and dormant articles will be kept indefinitely.
12882
12883
12884 @node Outgoing Messages
12885 @subsection Outgoing Messages
12886
12887 When Gnus is unplugged, all outgoing messages (both mail and news) are
12888 stored in the draft groups (@pxref{Drafts}).  You can view them there
12889 after posting, and edit them at will.
12890
12891 When Gnus is plugged again, you can send the messages either from the
12892 draft group with the special commands available there, or you can use
12893 the @kbd{J S} command in the group buffer to send all the sendable
12894 messages in the draft group.
12895
12896
12897
12898 @node Agent Variables
12899 @subsection Agent Variables
12900
12901 @table @code
12902 @item gnus-agent-directory
12903 @vindex gnus-agent-directory
12904 Where the Gnus Agent will store its files.  The default is
12905 @file{~/News/agent/}.
12906
12907 @item gnus-agent-handle-level
12908 @vindex gnus-agent-handle-level
12909 Groups on levels (@pxref{Group Levels}) higher than this variable will
12910 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
12911 which means that only subscribed group will be considered by the Agent
12912 by default.
12913
12914 @item gnus-agent-plugged-hook
12915 @vindex gnus-agent-plugged-hook
12916 Hook run when connecting to the network.
12917
12918 @item gnus-agent-unplugged-hook
12919 @vindex gnus-agent-unplugged-hook
12920 Hook run when disconnecting from the network.
12921
12922 @end table
12923
12924
12925 @node Example Setup
12926 @subsection Example Setup
12927
12928 If you don't want to read this manual, and you have a fairly standard
12929 setup, you may be able to use something like the following as your
12930 @file{.gnus.el} file to get started.
12931
12932 @lisp
12933 ;;; Define how Gnus is to fetch news.  We do this over NNTP
12934 ;;; from your ISP's server.
12935 (setq gnus-select-method '(nntp "news.your-isp.com"))
12936
12937 ;;; Define how Gnus is to read your mail.  We read mail from
12938 ;;; your ISP's POP server.
12939 (setq mail-sources '((pop :server "pop.your-isp.com")))
12940
12941 ;;; Say how Gnus is to store the mail.  We use nnml groups.
12942 (setq gnus-secondary-select-methods '((nnml "")))
12943
12944 ;;; Make Gnus into an offline newsreader.
12945 (gnus-agentize)
12946 @end lisp
12947
12948 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
12949 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12950 gnus}.
12951
12952 If this is the first time you've run Gnus, you will be subscribed
12953 automatically to a few default newsgroups.  You'll probably want to
12954 subscribe to more groups, and to do that, you have to query the
12955 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12956 command.  This usually takes quite a while, but you only have to do it
12957 once.
12958
12959 After reading and parsing a while, you'll be presented with a list of
12960 groups.  Subscribe to the ones you want to read with the @kbd{u}
12961 command.  @kbd{l} to make all the killed groups disappear after you've
12962 subscribe to all the groups you want to read.  (@kbd{A k} will bring
12963 back all the killed groups.)
12964
12965 You can now read the groups at once, or you can download the articles
12966 with the @kbd{J s} command.  And then read the rest of this manual to
12967 find out which of the other gazillion things you want to customize.
12968
12969
12970 @node Batching Agents
12971 @subsection Batching Agents
12972
12973 Having the Gnus Agent fetch articles (and post whatever messages you've
12974 written) is quite easy once you've gotten things set up properly.  The
12975 following shell script will do everything that is necessary:
12976
12977 @example
12978 #!/bin/sh
12979 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
12980 @end example
12981
12982
12983 @node Agent Caveats
12984 @subsection Agent Caveats
12985
12986 The Gnus Agent doesn't seem to work like most other offline
12987 newsreaders.  Here are some common questions that some imaginary people
12988 may ask:
12989
12990 @table @dfn
12991 @item If I read an article while plugged, do they get entered into the
12992 Agent?
12993
12994 @strong{No.}
12995
12996 @item If I read an article while plugged, and the article already exists
12997 in the Agent, will it get downloaded once more?
12998
12999 @strong{Yes.}
13000
13001 @end table
13002
13003 In short, when Gnus is unplugged, it only looks into the locally stored
13004 articles; when it's plugged, it only talks to your ISP.
13005
13006
13007 @node Scoring
13008 @chapter Scoring
13009 @cindex scoring
13010
13011 Other people use @dfn{kill files}, but we here at Gnus Towers like
13012 scoring better than killing, so we'd rather switch than fight.  They do
13013 something completely different as well, so sit up straight and pay
13014 attention!
13015
13016 @vindex gnus-summary-mark-below
13017 All articles have a default score (@code{gnus-summary-default-score}),
13018 which is 0 by default.  This score may be raised or lowered either
13019 interactively or by score files.  Articles that have a score lower than
13020 @code{gnus-summary-mark-below} are marked as read.
13021
13022 Gnus will read any @dfn{score files} that apply to the current group
13023 before generating the summary buffer.
13024
13025 There are several commands in the summary buffer that insert score
13026 entries based on the current article.  You can, for instance, ask Gnus to
13027 lower or increase the score of all articles with a certain subject.
13028
13029 There are two sorts of scoring entries: Permanent and temporary.
13030 Temporary score entries are self-expiring entries.  Any entries that are
13031 temporary and have not been used for, say, a week, will be removed
13032 silently to help keep the sizes of the score files down.
13033
13034 @menu
13035 * Summary Score Commands::   Adding score entries for the current group.
13036 * Group Score Commands::     General score commands.
13037 * Score Variables::          Customize your scoring.  (My, what terminology).
13038 * Score File Format::        What a score file may contain.
13039 * Score File Editing::       You can edit score files by hand as well.
13040 * Adaptive Scoring::         Big Sister Gnus knows what you read.
13041 * Home Score File::          How to say where new score entries are to go.
13042 * Followups To Yourself::    Having Gnus notice when people answer you.
13043 * Scoring Tips::             How to score effectively.
13044 * Reverse Scoring::          That problem child of old is not problem.
13045 * Global Score Files::       Earth-spanning, ear-splitting score files.
13046 * Kill Files::               They are still here, but they can be ignored.
13047 * Converting Kill Files::    Translating kill files to score files.
13048 * GroupLens::                Getting predictions on what you like to read.
13049 * Advanced Scoring::         Using logical expressions to build score rules.
13050 * Score Decays::             It can be useful to let scores wither away.
13051 @end menu
13052
13053
13054 @node Summary Score Commands
13055 @section Summary Score Commands
13056 @cindex score commands
13057
13058 The score commands that alter score entries do not actually modify real
13059 score files.  That would be too inefficient.  Gnus maintains a cache of
13060 previously loaded score files, one of which is considered the
13061 @dfn{current score file alist}.  The score commands simply insert
13062 entries into this list, and upon group exit, this list is saved.
13063
13064 The current score file is by default the group's local score file, even
13065 if no such score file actually exists.  To insert score commands into
13066 some other score file (e.g. @file{all.SCORE}), you must first make this
13067 score file the current one.
13068
13069 General score commands that don't actually change the score file:
13070
13071 @table @kbd
13072
13073 @item V s
13074 @kindex V s (Summary)
13075 @findex gnus-summary-set-score
13076 Set the score of the current article (@code{gnus-summary-set-score}).
13077
13078 @item V S
13079 @kindex V S (Summary)
13080 @findex gnus-summary-current-score
13081 Display the score of the current article
13082 (@code{gnus-summary-current-score}).
13083
13084 @item V t
13085 @kindex V t (Summary)
13086 @findex gnus-score-find-trace
13087 Display all score rules that have been used on the current article
13088 (@code{gnus-score-find-trace}).
13089
13090 @item V R
13091 @kindex V R (Summary)
13092 @findex gnus-summary-rescore
13093 Run the current summary through the scoring process
13094 (@code{gnus-summary-rescore}).  This might be useful if you're playing
13095 around with your score files behind Gnus' back and want to see the
13096 effect you're having.
13097
13098 @item V c
13099 @kindex V c (Summary)
13100 @findex gnus-score-change-score-file
13101 Make a different score file the current
13102 (@code{gnus-score-change-score-file}).
13103
13104 @item V e
13105 @kindex V e (Summary)
13106 @findex gnus-score-edit-current-scores
13107 Edit the current score file (@code{gnus-score-edit-current-scores}).
13108 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
13109 File Editing}).
13110
13111 @item V f
13112 @kindex V f (Summary)
13113 @findex gnus-score-edit-file
13114 Edit a score file and make this score file the current one
13115 (@code{gnus-score-edit-file}).
13116
13117 @item V F
13118 @kindex V F (Summary)
13119 @findex gnus-score-flush-cache
13120 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
13121 after editing score files.
13122
13123 @item V C
13124 @kindex V C (Summary)
13125 @findex gnus-score-customize
13126 Customize a score file in a visually pleasing manner
13127 (@code{gnus-score-customize}).
13128
13129 @end table
13130
13131 The rest of these commands modify the local score file.
13132
13133 @table @kbd
13134
13135 @item V m
13136 @kindex V m (Summary)
13137 @findex gnus-score-set-mark-below
13138 Prompt for a score, and mark all articles with a score below this as
13139 read (@code{gnus-score-set-mark-below}).
13140
13141 @item V x
13142 @kindex V x (Summary)
13143 @findex gnus-score-set-expunge-below
13144 Prompt for a score, and add a score rule to the current score file to
13145 expunge all articles below this score
13146 (@code{gnus-score-set-expunge-below}).
13147 @end table
13148
13149 The keystrokes for actually making score entries follow a very regular
13150 pattern, so there's no need to list all the commands.  (Hundreds of
13151 them.)
13152
13153 @findex gnus-summary-increase-score
13154 @findex gnus-summary-lower-score
13155
13156 @enumerate
13157 @item
13158 The first key is either @kbd{I} (upper case i) for increasing the score
13159 or @kbd{L} for lowering the score.
13160 @item
13161 The second key says what header you want to score on.  The following
13162 keys are available:
13163 @table @kbd
13164
13165 @item a
13166 Score on the author name.
13167
13168 @item s
13169 Score on the subject line.
13170
13171 @item x
13172 Score on the @code{Xref} line---i.e., the cross-posting line.
13173
13174 @item r
13175 Score on the @code{References} line.
13176
13177 @item d
13178 Score on the date.
13179
13180 @item l
13181 Score on the number of lines.
13182
13183 @item i
13184 Score on the @code{Message-ID} header.
13185
13186 @item f
13187 Score on followups---this matches the author name, and adds scores to
13188 the followups to this author.
13189
13190 @item b
13191 Score on the body.
13192
13193 @item h
13194 Score on the head.
13195
13196 @item t
13197 Score on thread.
13198
13199 @end table
13200
13201 @item
13202 The third key is the match type.  Which match types are valid depends on
13203 what headers you are scoring on.
13204
13205 @table @code
13206
13207 @item strings
13208
13209 @table @kbd
13210
13211 @item e
13212 Exact matching.
13213
13214 @item s
13215 Substring matching.
13216
13217 @item f
13218 Fuzzy matching (@pxref{Fuzzy Matching}).
13219
13220 @item r
13221 Regexp matching
13222 @end table
13223
13224 @item date
13225 @table @kbd
13226
13227 @item b
13228 Before date.
13229
13230 @item a
13231 After date.
13232
13233 @item n
13234 This date.
13235 @end table
13236
13237 @item number
13238 @table @kbd
13239
13240 @item <
13241 Less than number.
13242
13243 @item =
13244 Equal to number.
13245
13246 @item >
13247 Greater than number.
13248 @end table
13249 @end table
13250
13251 @item
13252 The fourth and final key says whether this is a temporary (i.e., expiring)
13253 score entry, or a permanent (i.e., non-expiring) score entry, or whether
13254 it is to be done immediately, without adding to the score file.
13255 @table @kbd
13256
13257 @item t
13258 Temporary score entry.
13259
13260 @item p
13261 Permanent score entry.
13262
13263 @item i
13264 Immediately scoring.
13265 @end table
13266
13267 @end enumerate
13268
13269 So, let's say you want to increase the score on the current author with
13270 exact matching permanently: @kbd{I a e p}.  If you want to lower the
13271 score based on the subject line, using substring matching, and make a
13272 temporary score entry: @kbd{L s s t}.  Pretty easy.
13273
13274 To make things a bit more complicated, there are shortcuts.  If you use
13275 a capital letter on either the second or third keys, Gnus will use
13276 defaults for the remaining one or two keystrokes.  The defaults are
13277 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
13278 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
13279
13280 These functions take both the numerical prefix and the symbolic prefix
13281 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
13282 (or increase) the score of the article.  A symbolic prefix of @code{a}
13283 says to use the @file{all.SCORE} file for the command instead of the
13284 current score file.
13285
13286 @vindex gnus-score-mimic-keymap
13287 The @code{gnus-score-mimic-keymap} says whether these commands will
13288 pretend they are keymaps or not.
13289
13290
13291 @node Group Score Commands
13292 @section Group Score Commands
13293 @cindex group score commands
13294
13295 There aren't many of these as yet, I'm afraid.
13296
13297 @table @kbd
13298
13299 @item W f
13300 @kindex W f (Group)
13301 @findex gnus-score-flush-cache
13302 Gnus maintains a cache of score alists to avoid having to reload them
13303 all the time.  This command will flush the cache
13304 (@code{gnus-score-flush-cache}).
13305
13306 @end table
13307
13308 You can do scoring from the command line by saying something like:
13309
13310 @findex gnus-batch-score
13311 @cindex batch scoring
13312 @example
13313 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
13314 @end example
13315
13316
13317 @node Score Variables
13318 @section Score Variables
13319 @cindex score variables
13320
13321 @table @code
13322
13323 @item gnus-use-scoring
13324 @vindex gnus-use-scoring
13325 If @code{nil}, Gnus will not check for score files, and will not, in
13326 general, do any score-related work.  This is @code{t} by default.
13327
13328 @item gnus-kill-killed
13329 @vindex gnus-kill-killed
13330 If this variable is @code{nil}, Gnus will never apply score files to
13331 articles that have already been through the kill process.  While this
13332 may save you lots of time, it also means that if you apply a kill file
13333 to a group, and then change the kill file and want to run it over you
13334 group again to kill more articles, it won't work.  You have to set this
13335 variable to @code{t} to do that.  (It is @code{t} by default.)
13336
13337 @item gnus-kill-files-directory
13338 @vindex gnus-kill-files-directory
13339 All kill and score files will be stored in this directory, which is
13340 initialized from the @code{SAVEDIR} environment variable by default.
13341 This is @file{~/News/} by default.
13342
13343 @item gnus-score-file-suffix
13344 @vindex gnus-score-file-suffix
13345 Suffix to add to the group name to arrive at the score file name
13346 (@samp{SCORE} by default.)
13347
13348 @item gnus-score-uncacheable-files
13349 @vindex gnus-score-uncacheable-files
13350 @cindex score cache
13351 All score files are normally cached to avoid excessive re-loading of
13352 score files.  However, if this might make you Emacs grow big and
13353 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
13354 @file{all.SCORE}, while it might be a good idea to not cache
13355 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
13356 variable is @samp{ADAPT$} by default, so no adaptive score files will
13357 be cached.
13358
13359 @item gnus-save-score
13360 @vindex gnus-save-score
13361 If you have really complicated score files, and do lots of batch
13362 scoring, then you might set this variable to @code{t}.  This will make
13363 Gnus save the scores into the @file{.newsrc.eld} file.
13364
13365 If you do not set this to @code{t}, then manual scores (like those set
13366 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
13367 across group visits.
13368
13369 @item gnus-score-interactive-default-score
13370 @vindex gnus-score-interactive-default-score
13371 Score used by all the interactive raise/lower commands to raise/lower
13372 score with.  Default is 1000, which may seem excessive, but this is to
13373 ensure that the adaptive scoring scheme gets enough room to play with.
13374 We don't want the small changes from the adaptive scoring to overwrite
13375 manually entered data.
13376
13377 @item gnus-summary-default-score
13378 @vindex gnus-summary-default-score
13379 Default score of an article, which is 0 by default.
13380
13381 @item gnus-summary-expunge-below
13382 @vindex gnus-summary-expunge-below
13383 Don't display the summary lines of articles that have scores lower than
13384 this variable.  This is @code{nil} by default, which means that no
13385 articles will be hidden.  This variable is local to the summary buffers,
13386 and has to be set from @code{gnus-summary-mode-hook}.
13387
13388 @item gnus-score-over-mark
13389 @vindex gnus-score-over-mark
13390 Mark (in the third column) used for articles with a score over the
13391 default.  Default is @samp{+}.
13392
13393 @item gnus-score-below-mark
13394 @vindex gnus-score-below-mark
13395 Mark (in the third column) used for articles with a score below the
13396 default.  Default is @samp{-}.
13397
13398 @item gnus-score-find-score-files-function
13399 @vindex gnus-score-find-score-files-function
13400 Function used to find score files for the current group.  This function
13401 is called with the name of the group as the argument.
13402
13403 Predefined functions available are:
13404 @table @code
13405
13406 @item gnus-score-find-single
13407 @findex gnus-score-find-single
13408 Only apply the group's own score file.
13409
13410 @item gnus-score-find-bnews
13411 @findex gnus-score-find-bnews
13412 Apply all score files that match, using bnews syntax.  This is the
13413 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
13414 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
13415 @file{gnu.all.SCORE} would all apply.  In short, the instances of
13416 @samp{all} in the score file names are translated into @samp{.*}, and
13417 then a regexp match is done.
13418
13419 This means that if you have some score entries that you want to apply to
13420 all groups, then you put those entries in the @file{all.SCORE} file.
13421
13422 The score files are applied in a semi-random order, although Gnus will
13423 try to apply the more general score files before the more specific score
13424 files.  It does this by looking at the number of elements in the score
13425 file names---discarding the @samp{all} elements.
13426
13427 @item gnus-score-find-hierarchical
13428 @findex gnus-score-find-hierarchical
13429 Apply all score files from all the parent groups.  This means that you
13430 can't have score files like @file{all.SCORE}, but you can have
13431 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
13432
13433 @end table
13434 This variable can also be a list of functions.  In that case, all these
13435 functions will be called, and all the returned lists of score files will
13436 be applied.  These functions can also return lists of score alists
13437 directly.  In that case, the functions that return these non-file score
13438 alists should probably be placed before the ``real'' score file
13439 functions, to ensure that the last score file returned is the local
13440 score file.  Phu.
13441
13442 @item gnus-score-expiry-days
13443 @vindex gnus-score-expiry-days
13444 This variable says how many days should pass before an unused score file
13445 entry is expired.  If this variable is @code{nil}, no score file entries
13446 are expired.  It's 7 by default.
13447
13448 @item gnus-update-score-entry-dates
13449 @vindex gnus-update-score-entry-dates
13450 If this variable is non-@code{nil}, matching score entries will have
13451 their dates updated.  (This is how Gnus controls expiry---all
13452 non-matching entries will become too old while matching entries will
13453 stay fresh and young.)  However, if you set this variable to @code{nil},
13454 even matching entries will grow old and will have to face that oh-so
13455 grim reaper.
13456
13457 @item gnus-score-after-write-file-function
13458 @vindex gnus-score-after-write-file-function
13459 Function called with the name of the score file just written.
13460
13461 @item gnus-score-thread-simplify
13462 @vindex gnus-score-thread-simplify
13463 If this variable is non-@code{nil}, article subjects will be simplified
13464 for subject scoring purposes in the same manner as with
13465 threading---according to the current value of
13466 gnus-simplify-subject-functions.  If the scoring entry uses
13467 @code{substring} or @code{exact} matching, the match will also be
13468 simplified in this manner.
13469
13470 @end table
13471
13472
13473 @node Score File Format
13474 @section Score File Format
13475 @cindex score file format
13476
13477 A score file is an @code{emacs-lisp} file that normally contains just a
13478 single form.  Casual users are not expected to edit these files;
13479 everything can be changed from the summary buffer.
13480
13481 Anyway, if you'd like to dig into it yourself, here's an example:
13482
13483 @lisp
13484 (("from"
13485   ("Lars Ingebrigtsen" -10000)
13486   ("Per Abrahamsen")
13487   ("larsi\\|lmi" -50000 nil R))
13488  ("subject"
13489   ("Ding is Badd" nil 728373))
13490  ("xref"
13491   ("alt.politics" -1000 728372 s))
13492  ("lines"
13493   (2 -100 nil <))
13494  (mark 0)
13495  (expunge -1000)
13496  (mark-and-expunge -10)
13497  (read-only nil)
13498  (orphan -10)
13499  (adapt t)
13500  (files "/hom/larsi/News/gnu.SCORE")
13501  (exclude-files "all.SCORE")
13502  (local (gnus-newsgroup-auto-expire t)
13503         (gnus-summary-make-false-root empty))
13504  (eval (ding)))
13505 @end lisp
13506
13507 This example demonstrates most score file elements.  For a different
13508 approach, see @pxref{Advanced Scoring}.
13509
13510 Even though this looks much like lisp code, nothing here is actually
13511 @code{eval}ed.  The lisp reader is used to read this form, though, so it
13512 has to be valid syntactically, if not semantically.
13513
13514 Six keys are supported by this alist:
13515
13516 @table @code
13517
13518 @item STRING
13519 If the key is a string, it is the name of the header to perform the
13520 match on.  Scoring can only be performed on these eight headers:
13521 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13522 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
13523 these headers, there are three strings to tell Gnus to fetch the entire
13524 article and do the match on larger parts of the article: @code{Body}
13525 will perform the match on the body of the article, @code{Head} will
13526 perform the match on the head of the article, and @code{All} will
13527 perform the match on the entire article.  Note that using any of these
13528 last three keys will slow down group entry @emph{considerably}.  The
13529 final ``header'' you can score on is @code{Followup}.  These score
13530 entries will result in new score entries being added for all follow-ups
13531 to articles that matches these score entries.
13532
13533 Following this key is a arbitrary number of score entries, where each
13534 score entry has one to four elements.
13535 @enumerate
13536
13537 @item
13538 The first element is the @dfn{match element}.  On most headers this will
13539 be a string, but on the Lines and Chars headers, this must be an
13540 integer.
13541
13542 @item
13543 If the second element is present, it should be a number---the @dfn{score
13544 element}.  This number should be an integer in the neginf to posinf
13545 interval.  This number is added to the score of the article if the match
13546 is successful.  If this element is not present, the
13547 @code{gnus-score-interactive-default-score} number will be used
13548 instead.  This is 1000 by default.
13549
13550 @item
13551 If the third element is present, it should be a number---the @dfn{date
13552 element}.  This date says when the last time this score entry matched,
13553 which provides a mechanism for expiring the score entries.  It this
13554 element is not present, the score entry is permanent.  The date is
13555 represented by the number of days since December 31, 1 BCE.
13556
13557 @item
13558 If the fourth element is present, it should be a symbol---the @dfn{type
13559 element}.  This element specifies what function should be used to see
13560 whether this score entry matches the article.  What match types that can
13561 be used depends on what header you wish to perform the match on.
13562 @table @dfn
13563
13564 @item From, Subject, References, Xref, Message-ID
13565 For most header types, there are the @code{r} and @code{R} (regexp), as
13566 well as @code{s} and @code{S} (substring) types, and @code{e} and
13567 @code{E} (exact match), and @code{w} (word match) types.  If this
13568 element is not present, Gnus will assume that substring matching should
13569 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
13570 that the matches will be done in a case-sensitive manner.  All these
13571 one-letter types are really just abbreviations for the @code{regexp},
13572 @code{string}, @code{exact}, and @code{word} types, which you can use
13573 instead, if you feel like.
13574
13575 @item Lines, Chars
13576 These two headers use different match types: @code{<}, @code{>},
13577 @code{=}, @code{>=} and @code{<=}.
13578
13579 These predicates are true if
13580
13581 @example
13582 (PREDICATE HEADER MATCH)
13583 @end example
13584
13585 evaluates to non-@code{nil}.  For instance, the advanced match
13586 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13587 following form:
13588
13589 @lisp
13590 (< header-value 4)
13591 @end lisp
13592
13593 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13594 the match, we get the score added if the article has less than 4 lines.
13595 (It's easy to get confused and think it's the other way around.  But
13596 it's not.  I think.)
13597
13598 When matching on @code{Lines}, be careful because some backends (like
13599 @code{nndir}) do not generate @code{Lines} header, so every article ends
13600 up being marked as having 0 lines.  This can lead to strange results if
13601 you happen to lower score of the articles with few lines.
13602
13603 @item Date
13604 For the Date header we have three kinda silly match types:
13605 @code{before}, @code{at} and @code{after}.  I can't really imagine this
13606 ever being useful, but, like, it would feel kinda silly not to provide
13607 this function.  Just in case.  You never know.  Better safe than sorry.
13608 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
13609 sex on a first date.  (I have been told that at least one person, and I
13610 quote, ``found this function indispensable'', however.)
13611
13612 @cindex ISO8601
13613 @cindex date
13614 A more useful match type is @code{regexp}.  With it, you can match the
13615 date string using a regular expression.  The date is normalized to
13616 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
13617 you want to match all articles that have been posted on April 1st in
13618 every year, you could use @samp{....0401.........} as a match string,
13619 for instance.  (Note that the date is kept in its original time zone, so
13620 this will match articles that were posted when it was April 1st where
13621 the article was posted from.  Time zones are such wholesome fun for the
13622 whole family, eh?)
13623
13624 @item Head, Body, All
13625 These three match keys use the same match types as the @code{From} (etc)
13626 header uses.
13627
13628 @item Followup
13629 This match key is somewhat special, in that it will match the
13630 @code{From} header, and affect the score of not only the matching
13631 articles, but also all followups to the matching articles.  This allows
13632 you e.g. increase the score of followups to your own articles, or
13633 decrease the score of followups to the articles of some known
13634 trouble-maker.  Uses the same match types as the @code{From} header
13635 uses.  (Using this match key will lead to creation of @file{ADAPT}
13636 files.)
13637
13638 @item Thread
13639 This match key works along the same lines as the @code{Followup} match
13640 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
13641 @samp{thread} match.  This will add a new @samp{thread} match for each
13642 article that has @var{X} in its @code{References} header.  (These new
13643 @samp{thread} matches will use the @code{Message-ID}s of these matching
13644 articles.)  This will ensure that you can raise/lower the score of an
13645 entire thread, even though some articles in the thread may not have
13646 complete @code{References} headers.  Note that using this may lead to
13647 undeterministic scores of the articles in the thread.  (Using this match
13648 key will lead to creation of @file{ADAPT} files.)
13649 @end table
13650 @end enumerate
13651
13652 @cindex Score File Atoms
13653 @item mark
13654 The value of this entry should be a number.  Any articles with a score
13655 lower than this number will be marked as read.
13656
13657 @item expunge
13658 The value of this entry should be a number.  Any articles with a score
13659 lower than this number will be removed from the summary buffer.
13660
13661 @item mark-and-expunge
13662 The value of this entry should be a number.  Any articles with a score
13663 lower than this number will be marked as read and removed from the
13664 summary buffer.
13665
13666 @item thread-mark-and-expunge
13667 The value of this entry should be a number.  All articles that belong to
13668 a thread that has a total score below this number will be marked as read
13669 and removed from the summary buffer.  @code{gnus-thread-score-function}
13670 says how to compute the total score for a thread.
13671
13672 @item files
13673 The value of this entry should be any number of file names.  These files
13674 are assumed to be score files as well, and will be loaded the same way
13675 this one was.
13676
13677 @item exclude-files
13678 The clue of this entry should be any number of files.  These files will
13679 not be loaded, even though they would normally be so, for some reason or
13680 other.
13681
13682 @item eval
13683 The value of this entry will be @code{eval}el.  This element will be
13684 ignored when handling global score files.
13685
13686 @item read-only
13687 Read-only score files will not be updated or saved.  Global score files
13688 should feature this atom (@pxref{Global Score Files}).  (Note:
13689 @dfn{Global} here really means @dfn{global}; not your personal
13690 apply-to-all-groups score files.)
13691
13692 @item orphan
13693 The value of this entry should be a number.  Articles that do not have
13694 parents will get this number added to their scores.  Imagine you follow
13695 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
13696 will only follow a few of the threads, also want to see any new threads.
13697
13698 You can do this with the following two score file entries:
13699
13700 @example
13701         (orphan -500)
13702         (mark-and-expunge -100)
13703 @end example
13704
13705 When you enter the group the first time, you will only see the new
13706 threads.  You then raise the score of the threads that you find
13707 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13708 rest.  Next time you enter the group, you will see new articles in the
13709 interesting threads, plus any new threads.
13710
13711 I.e.---the orphan score atom is for high-volume groups where there
13712 exist a few interesting threads which can't be found automatically by
13713 ordinary scoring rules.
13714
13715 @item adapt
13716 This entry controls the adaptive scoring.  If it is @code{t}, the
13717 default adaptive scoring rules will be used.  If it is @code{ignore}, no
13718 adaptive scoring will be performed on this group.  If it is a list, this
13719 list will be used as the adaptive scoring rules.  If it isn't present,
13720 or is something other than @code{t} or @code{ignore}, the default
13721 adaptive scoring rules will be used.  If you want to use adaptive
13722 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13723 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13724 not want adaptive scoring.  If you only want adaptive scoring in a few
13725 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13726 insert @code{(adapt t)} in the score files of the groups where you want
13727 it.
13728
13729 @item adapt-file
13730 All adaptive score entries will go to the file named by this entry.  It
13731 will also be applied when entering the group.  This atom might be handy
13732 if you want to adapt on several groups at once, using the same adaptive
13733 file for a number of groups.
13734
13735 @item local
13736 @cindex local variables
13737 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13738 Each @var{var} will be made buffer-local to the current summary buffer,
13739 and set to the value specified.  This is a convenient, if somewhat
13740 strange, way of setting variables in some groups if you don't like hooks
13741 much.  Note that the @var{value} won't be evaluated.
13742 @end table
13743
13744
13745 @node Score File Editing
13746 @section Score File Editing
13747
13748 You normally enter all scoring commands from the summary buffer, but you
13749 might feel the urge to edit them by hand as well, so we've supplied you
13750 with a mode for that.
13751
13752 It's simply a slightly customized @code{emacs-lisp} mode, with these
13753 additional commands:
13754
13755 @table @kbd
13756
13757 @item C-c C-c
13758 @kindex C-c C-c (Score)
13759 @findex gnus-score-edit-done
13760 Save the changes you have made and return to the summary buffer
13761 (@code{gnus-score-edit-done}).
13762
13763 @item C-c C-d
13764 @kindex C-c C-d (Score)
13765 @findex gnus-score-edit-insert-date
13766 Insert the current date in numerical format
13767 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
13768 you were wondering.
13769
13770 @item C-c C-p
13771 @kindex C-c C-p (Score)
13772 @findex gnus-score-pretty-print
13773 The adaptive score files are saved in an unformatted fashion.  If you
13774 intend to read one of these files, you want to @dfn{pretty print} it
13775 first.  This command (@code{gnus-score-pretty-print}) does that for
13776 you.
13777
13778 @end table
13779
13780 Type @kbd{M-x gnus-score-mode} to use this mode.
13781
13782 @vindex gnus-score-mode-hook
13783 @code{gnus-score-menu-hook} is run in score mode buffers.
13784
13785 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13786 e} to begin editing score files.
13787
13788
13789 @node Adaptive Scoring
13790 @section Adaptive Scoring
13791 @cindex adaptive scoring
13792
13793 If all this scoring is getting you down, Gnus has a way of making it all
13794 happen automatically---as if by magic.  Or rather, as if by artificial
13795 stupidity, to be precise.
13796
13797 @vindex gnus-use-adaptive-scoring
13798 When you read an article, or mark an article as read, or kill an
13799 article, you leave marks behind.  On exit from the group, Gnus can sniff
13800 these marks and add score elements depending on what marks it finds.
13801 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13802 @code{t} or @code{(line)}.  If you want score adaptively on separate
13803 words appearing in the subjects, you should set this variable to
13804 @code{(word)}.  If you want to use both adaptive methods, set this
13805 variable to @code{(word line)}.
13806
13807 @vindex gnus-default-adaptive-score-alist
13808 To give you complete control over the scoring process, you can customize
13809 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
13810 might look something like this:
13811
13812 @lisp
13813 (defvar gnus-default-adaptive-score-alist
13814   '((gnus-unread-mark)
13815     (gnus-ticked-mark (from 4))
13816     (gnus-dormant-mark (from 5))
13817     (gnus-del-mark (from -4) (subject -1))
13818     (gnus-read-mark (from 4) (subject 2))
13819     (gnus-expirable-mark (from -1) (subject -1))
13820     (gnus-killed-mark (from -1) (subject -3))
13821     (gnus-kill-file-mark)
13822     (gnus-ancient-mark)
13823     (gnus-low-score-mark)
13824     (gnus-catchup-mark (from -1) (subject -1))))
13825 @end lisp
13826
13827 As you see, each element in this alist has a mark as a key (either a
13828 variable name or a ``real'' mark---a character).  Following this key is
13829 a arbitrary number of header/score pairs.  If there are no header/score
13830 pairs following the key, no adaptive scoring will be done on articles
13831 that have that key as the article mark.  For instance, articles with
13832 @code{gnus-unread-mark} in the example above will not get adaptive score
13833 entries.
13834
13835 Each article can have only one mark, so just a single of these rules
13836 will be applied to each article.
13837
13838 To take @code{gnus-del-mark} as an example---this alist says that all
13839 articles that have that mark (i.e., are marked with @samp{D}) will have a
13840 score entry added to lower based on the @code{From} header by -4, and
13841 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
13842
13843 If you have marked 10 articles with the same subject with
13844 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13845 That means that that subject will get a score of ten times -1, which
13846 should be, unless I'm much mistaken, -10.
13847
13848 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13849 the read articles will be marked with the @samp{E} mark.  This'll
13850 probably make adaptive scoring slightly impossible, so auto-expiring and
13851 adaptive scoring doesn't really mix very well.
13852
13853 The headers you can score on are @code{from}, @code{subject},
13854 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13855 @code{chars} and @code{date}.  In addition, you can score on
13856 @code{followup}, which will create an adaptive score entry that matches
13857 on the @code{References} header using the @code{Message-ID} of the
13858 current article, thereby matching the following thread.
13859
13860 You can also score on @code{thread}, which will try to score all
13861 articles that appear in a thread.  @code{thread} matches uses a
13862 @code{Message-ID} to match on the @code{References} header of the
13863 article.  If the match is made, the @code{Message-ID} of the article is
13864 added to the @code{thread} rule.  (Think about it.  I'd recommend two
13865 aspirins afterwards.)
13866
13867 If you use this scheme, you should set the score file atom @code{mark}
13868 to something small---like -300, perhaps, to avoid having small random
13869 changes result in articles getting marked as read.
13870
13871 After using adaptive scoring for a week or so, Gnus should start to
13872 become properly trained and enhance the authors you like best, and kill
13873 the authors you like least, without you having to say so explicitly.
13874
13875 You can control what groups the adaptive scoring is to be performed on
13876 by using the score files (@pxref{Score File Format}).  This will also
13877 let you use different rules in different groups.
13878
13879 @vindex gnus-adaptive-file-suffix
13880 The adaptive score entries will be put into a file where the name is the
13881 group name with @code{gnus-adaptive-file-suffix} appended.  The default
13882 is @samp{ADAPT}.
13883
13884 @vindex gnus-score-exact-adapt-limit
13885 When doing adaptive scoring, substring or fuzzy matching would probably
13886 give you the best results in most cases.  However, if the header one
13887 matches is short, the possibility for false positives is great, so if
13888 the length of the match is less than
13889 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
13890 this variable is @code{nil}, exact matching will always be used to avoid
13891 this problem.
13892
13893 @vindex gnus-default-adaptive-word-score-alist
13894 As mentioned above, you can adapt either on individual words or entire
13895 headers.  If you adapt on words, the
13896 @code{gnus-default-adaptive-word-score-alist} variable says what score
13897 each instance of a word should add given a mark.
13898
13899 @lisp
13900 (setq gnus-default-adaptive-word-score-alist
13901       `((,gnus-read-mark . 30)
13902         (,gnus-catchup-mark . -10)
13903         (,gnus-killed-mark . -20)
13904         (,gnus-del-mark . -15)))
13905 @end lisp
13906
13907 This is the default value.  If you have adaption on words enabled, every
13908 word that appears in subjects of articles marked with
13909 @code{gnus-read-mark} will result in a score rule that increase the
13910 score with 30 points.
13911
13912 @vindex gnus-default-ignored-adaptive-words
13913 @vindex gnus-ignored-adaptive-words
13914 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13915 will be ignored.  If you wish to add more words to be ignored, use the
13916 @code{gnus-ignored-adaptive-words} list instead.
13917
13918 @vindex gnus-adaptive-word-syntax-table
13919 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13920 syntax table in effect.  It is similar to the standard syntax table, but
13921 it considers numbers to be non-word-constituent characters.
13922
13923 @vindex gnus-adaptive-word-minimum
13924 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13925 word scoring process will never bring down the score of an article to
13926 below this number.  The default is @code{nil}.
13927
13928 @vindex gnus-adaptive-word-no-group-words
13929 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13930 won't adaptively word score any of the words in the group name.  Useful
13931 for groups like @samp{comp.editors.emacs}, where most of the subject
13932 lines contain the word @samp{emacs}.
13933
13934 After using this scheme for a while, it might be nice to write a
13935 @code{gnus-psychoanalyze-user} command to go through the rules and see
13936 what words you like and what words you don't like.  Or perhaps not.
13937
13938 Note that the adaptive word scoring thing is highly experimental and is
13939 likely to change in the future.  Initial impressions seem to indicate
13940 that it's totally useless as it stands.  Some more work (involving more
13941 rigorous statistical methods) will have to be done to make this useful.
13942
13943
13944 @node Home Score File
13945 @section Home Score File
13946
13947 The score file where new score file entries will go is called the
13948 @dfn{home score file}.  This is normally (and by default) the score file
13949 for the group itself.  For instance, the home score file for
13950 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13951
13952 However, this may not be what you want.  It is often convenient to share
13953 a common home score file among many groups---all @samp{emacs} groups
13954 could perhaps use the same home score file.
13955
13956 @vindex gnus-home-score-file
13957 The variable that controls this is @code{gnus-home-score-file}.  It can
13958 be:
13959
13960 @enumerate
13961 @item
13962 A string.  Then this file will be used as the home score file for all
13963 groups.
13964
13965 @item
13966 A function. The result of this function will be used as the home score
13967 file.  The function will be called with the name of the group as the
13968 parameter.
13969
13970 @item
13971 A list.  The elements in this list can be:
13972
13973 @enumerate
13974 @item
13975 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
13976 the @var{file-name} will will be used as the home score file.
13977
13978 @item
13979 A function. If the function returns non-nil, the result will be used as
13980 the home score file.
13981
13982 @item
13983 A string.  Use the string as the home score file.
13984 @end enumerate
13985
13986 The list will be traversed from the beginning towards the end looking
13987 for matches.
13988
13989 @end enumerate
13990
13991 So, if you want to use just a single score file, you could say:
13992
13993 @lisp
13994 (setq gnus-home-score-file
13995       "my-total-score-file.SCORE")
13996 @end lisp
13997
13998 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
13999 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
14000
14001 @findex gnus-hierarchial-home-score-file
14002 @lisp
14003 (setq gnus-home-score-file
14004       'gnus-hierarchial-home-score-file)
14005 @end lisp
14006
14007 This is a ready-made function provided for your convenience.
14008 Other functions include
14009
14010 @table @code
14011 @item gnus-current-home-score-file
14012 @findex gnus-current-home-score-file
14013 Return the ``current'' regular score file.  This will make scoring
14014 commands add entry to the ``innermost'' matching score file.
14015
14016 @end table
14017
14018 If you want to have one score file for the @samp{emacs} groups and
14019 another for the @samp{comp} groups, while letting all other groups use
14020 their own home score files:
14021
14022 @lisp
14023 (setq gnus-home-score-file
14024       ;; All groups that match the regexp "\\.emacs"
14025       '(("\\.emacs" "emacs.SCORE")
14026         ;; All the comp groups in one score file
14027         ("^comp" "comp.SCORE")))
14028 @end lisp
14029
14030 @vindex gnus-home-adapt-file
14031 @code{gnus-home-adapt-file} works exactly the same way as
14032 @code{gnus-home-score-file}, but says what the home adaptive score file
14033 is instead.  All new adaptive file entries will go into the file
14034 specified by this variable, and the same syntax is allowed.
14035
14036 In addition to using @code{gnus-home-score-file} and
14037 @code{gnus-home-adapt-file}, you can also use group parameters
14038 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
14039 Parameters}) to achieve much the same.  Group and topic parameters take
14040 precedence over this variable.
14041
14042
14043 @node Followups To Yourself
14044 @section Followups To Yourself
14045
14046 Gnus offers two commands for picking out the @code{Message-ID} header in
14047 the current buffer.  Gnus will then add a score rule that scores using
14048 this @code{Message-ID} on the @code{References} header of other
14049 articles.  This will, in effect, increase the score of all articles that
14050 respond to the article in the current buffer.  Quite useful if you want
14051 to easily note when people answer what you've said.
14052
14053 @table @code
14054
14055 @item gnus-score-followup-article
14056 @findex gnus-score-followup-article
14057 This will add a score to articles that directly follow up your own
14058 article.
14059
14060 @item gnus-score-followup-thread
14061 @findex gnus-score-followup-thread
14062 This will add a score to all articles that appear in a thread ``below''
14063 your own article.
14064 @end table
14065
14066 @vindex message-sent-hook
14067 These two functions are both primarily meant to be used in hooks like
14068 @code{message-sent-hook}.
14069
14070 If you look closely at your own @code{Message-ID}, you'll notice that
14071 the first two or three characters are always the same.  Here's two of
14072 mine:
14073
14074 @example
14075 <x6u3u47icf.fsf@@eyesore.no>
14076 <x6sp9o7ibw.fsf@@eyesore.no>
14077 @end example
14078
14079 So ``my'' ident on this machine is @samp{x6}.  This can be
14080 exploited---the following rule will raise the score on all followups to
14081 myself:
14082
14083 @lisp
14084 ("references"
14085  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
14086   1000 nil r))
14087 @end lisp
14088
14089 Whether it's the first two or first three characters that are ``yours''
14090 is system-dependent.
14091
14092
14093 @node Scoring Tips
14094 @section Scoring Tips
14095 @cindex scoring tips
14096
14097 @table @dfn
14098
14099 @item Crossposts
14100 @cindex crossposts
14101 @cindex scoring crossposts
14102 If you want to lower the score of crossposts, the line to match on is
14103 the @code{Xref} header.
14104 @lisp
14105 ("xref" (" talk.politics.misc:" -1000))
14106 @end lisp
14107
14108 @item Multiple crossposts
14109 If you want to lower the score of articles that have been crossposted to
14110 more than, say, 3 groups:
14111 @lisp
14112 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
14113 @end lisp
14114
14115 @item Matching on the body
14116 This is generally not a very good idea---it takes a very long time.
14117 Gnus actually has to fetch each individual article from the server.  But
14118 you might want to anyway, I guess.  Even though there are three match
14119 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
14120 and stick with it in each score file.  If you use any two, each article
14121 will be fetched @emph{twice}.  If you want to match a bit on the
14122 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
14123 the matches.
14124
14125 @item Marking as read
14126 You will probably want to mark articles that has a score below a certain
14127 number as read.  This is most easily achieved by putting the following
14128 in your @file{all.SCORE} file:
14129 @lisp
14130 ((mark -100))
14131 @end lisp
14132 You may also consider doing something similar with @code{expunge}.
14133
14134 @item Negated character classes
14135 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
14136 That will match newlines, which might lead to, well, The Unknown.  Say
14137 @code{[^abcd\n]*} instead.
14138 @end table
14139
14140
14141 @node Reverse Scoring
14142 @section Reverse Scoring
14143 @cindex reverse scoring
14144
14145 If you want to keep just articles that have @samp{Sex with Emacs} in the
14146 subject header, and expunge all other articles, you could put something
14147 like this in your score file:
14148
14149 @lisp
14150 (("subject"
14151   ("Sex with Emacs" 2))
14152  (mark 1)
14153  (expunge 1))
14154 @end lisp
14155
14156 So, you raise all articles that match @samp{Sex with Emacs} and mark the
14157 rest as read, and expunge them to boot.
14158
14159
14160 @node Global Score Files
14161 @section Global Score Files
14162 @cindex global score files
14163
14164 Sure, other newsreaders have ``global kill files''.  These are usually
14165 nothing more than a single kill file that applies to all groups, stored
14166 in the user's home directory.  Bah!  Puny, weak newsreaders!
14167
14168 What I'm talking about here are Global Score Files.  Score files from
14169 all over the world, from users everywhere, uniting all nations in one
14170 big, happy score file union!  Ange-score!  New and untested!
14171
14172 @vindex gnus-global-score-files
14173 All you have to do to use other people's score files is to set the
14174 @code{gnus-global-score-files} variable.  One entry for each score file,
14175 or each score file directory.  Gnus will decide by itself what score
14176 files are applicable to which group.
14177
14178 Say you want to use the score file
14179 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
14180 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
14181
14182 @lisp
14183 (setq gnus-global-score-files
14184       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
14185         "/ftp@@ftp.some-where:/pub/score/"))
14186 @end lisp
14187
14188 @findex gnus-score-search-global-directories
14189 Simple, eh?  Directory names must end with a @samp{/}.  These
14190 directories are typically scanned only once during each Gnus session.
14191 If you feel the need to manually re-scan the remote directories, you can
14192 use the @code{gnus-score-search-global-directories} command.
14193
14194 Note that, at present, using this option will slow down group entry
14195 somewhat.  (That is---a lot.)
14196
14197 If you want to start maintaining score files for other people to use,
14198 just put your score file up for anonymous ftp and announce it to the
14199 world.  Become a retro-moderator!  Participate in the retro-moderator
14200 wars sure to ensue, where retro-moderators battle it out for the
14201 sympathy of the people, luring them to use their score files on false
14202 premises!  Yay!  The net is saved!
14203
14204 Here are some tips for the would-be retro-moderator, off the top of my
14205 head:
14206
14207 @itemize @bullet
14208
14209 @item
14210 Articles heavily crossposted are probably junk.
14211 @item
14212 To lower a single inappropriate article, lower by @code{Message-ID}.
14213 @item
14214 Particularly brilliant authors can be raised on a permanent basis.
14215 @item
14216 Authors that repeatedly post off-charter for the group can safely be
14217 lowered out of existence.
14218 @item
14219 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
14220 articles completely.
14221
14222 @item
14223 Use expiring score entries to keep the size of the file down.  You
14224 should probably have a long expiry period, though, as some sites keep
14225 old articles for a long time.
14226 @end itemize
14227
14228 ... I wonder whether other newsreaders will support global score files
14229 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
14230 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
14231 holding our breath yet?
14232
14233
14234 @node Kill Files
14235 @section Kill Files
14236 @cindex kill files
14237
14238 Gnus still supports those pesky old kill files.  In fact, the kill file
14239 entries can now be expiring, which is something I wrote before Daniel
14240 Quinlan thought of doing score files, so I've left the code in there.
14241
14242 In short, kill processing is a lot slower (and I do mean @emph{a lot})
14243 than score processing, so it might be a good idea to rewrite your kill
14244 files into score files.
14245
14246 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
14247 forms into this file, which means that you can use kill files as some
14248 sort of primitive hook function to be run on group entry, even though
14249 that isn't a very good idea.
14250
14251 Normal kill files look like this:
14252
14253 @lisp
14254 (gnus-kill "From" "Lars Ingebrigtsen")
14255 (gnus-kill "Subject" "ding")
14256 (gnus-expunge "X")
14257 @end lisp
14258
14259 This will mark every article written by me as read, and remove the
14260 marked articles from the summary buffer.  Very useful, you'll agree.
14261
14262 Other programs use a totally different kill file syntax.  If Gnus
14263 encounters what looks like a @code{rn} kill file, it will take a stab at
14264 interpreting it.
14265
14266 Two summary functions for editing a GNUS kill file:
14267
14268 @table @kbd
14269
14270 @item M-k
14271 @kindex M-k (Summary)
14272 @findex gnus-summary-edit-local-kill
14273 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
14274
14275 @item M-K
14276 @kindex M-K (Summary)
14277 @findex gnus-summary-edit-global-kill
14278 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
14279 @end table
14280
14281 Two group mode functions for editing the kill files:
14282
14283 @table @kbd
14284
14285 @item M-k
14286 @kindex M-k (Group)
14287 @findex gnus-group-edit-local-kill
14288 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
14289
14290 @item M-K
14291 @kindex M-K (Group)
14292 @findex gnus-group-edit-global-kill
14293 Edit the general kill file (@code{gnus-group-edit-global-kill}).
14294 @end table
14295
14296 Kill file variables:
14297
14298 @table @code
14299 @item gnus-kill-file-name
14300 @vindex gnus-kill-file-name
14301 A kill file for the group @samp{soc.motss} is normally called
14302 @file{soc.motss.KILL}.  The suffix appended to the group name to get
14303 this file name is detailed by the @code{gnus-kill-file-name} variable.
14304 The ``global'' kill file (not in the score file sense of ``global'', of
14305 course) is just called @file{KILL}.
14306
14307 @vindex gnus-kill-save-kill-file
14308 @item gnus-kill-save-kill-file
14309 If this variable is non-@code{nil}, Gnus will save the
14310 kill file after processing, which is necessary if you use expiring
14311 kills.
14312
14313 @item gnus-apply-kill-hook
14314 @vindex gnus-apply-kill-hook
14315 @findex gnus-apply-kill-file-unless-scored
14316 @findex gnus-apply-kill-file
14317 A hook called to apply kill files to a group.  It is
14318 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
14319 kill file if you have a score file for the same group, you can set this
14320 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
14321 kill files to be processed, you should set this variable to @code{nil}.
14322
14323 @item gnus-kill-file-mode-hook
14324 @vindex gnus-kill-file-mode-hook
14325 A hook called in kill-file mode buffers.
14326
14327 @end table
14328
14329
14330 @node Converting Kill Files
14331 @section Converting Kill Files
14332 @cindex kill files
14333 @cindex converting kill files
14334
14335 If you have loads of old kill files, you may want to convert them into
14336 score files.  If they are ``regular'', you can use
14337 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
14338 by hand.
14339
14340 The kill to score conversion package isn't included in Gnus by default.
14341 You can fetch it from
14342 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
14343
14344 If your old kill files are very complex---if they contain more
14345 non-@code{gnus-kill} forms than not, you'll have to convert them by
14346 hand.  Or just let them be as they are.  Gnus will still use them as
14347 before.
14348
14349
14350 @node GroupLens
14351 @section GroupLens
14352 @cindex GroupLens
14353
14354 GroupLens is a collaborative filtering system that helps you work
14355 together with other people to find the quality news articles out of the
14356 huge volume of news articles generated every day.
14357
14358 To accomplish this the GroupLens system combines your opinions about
14359 articles you have already read with the opinions of others who have done
14360 likewise and gives you a personalized prediction for each unread news
14361 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
14362 rate articles, and finds other people that rate articles the same way.
14363 Once it has found some people you agree with it tells you, in the form
14364 of a prediction, what they thought of the article.  You can use this
14365 prediction to help you decide whether or not you want to read the
14366 article.
14367
14368 @menu
14369 * Using GroupLens::          How to make Gnus use GroupLens.
14370 * Rating Articles::          Letting GroupLens know how you rate articles.
14371 * Displaying Predictions::   Displaying predictions given by GroupLens.
14372 * GroupLens Variables::      Customizing GroupLens.
14373 @end menu
14374
14375
14376 @node Using GroupLens
14377 @subsection Using GroupLens
14378
14379 To use GroupLens you must register a pseudonym with your local Better
14380 Bit Bureau (BBB).
14381 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
14382 better bit in town at the moment.
14383
14384 Once you have registered you'll need to set a couple of variables.
14385
14386 @table @code
14387
14388 @item gnus-use-grouplens
14389 @vindex gnus-use-grouplens
14390 Setting this variable to a non-@code{nil} value will make Gnus hook into
14391 all the relevant GroupLens functions.
14392
14393 @item grouplens-pseudonym
14394 @vindex grouplens-pseudonym
14395 This variable should be set to the pseudonym you got when registering
14396 with the Better Bit Bureau.
14397
14398 @item grouplens-newsgroups
14399 @vindex grouplens-newsgroups
14400 A list of groups that you want to get GroupLens predictions for.
14401
14402 @end table
14403
14404 That's the minimum of what you need to get up and running with GroupLens.
14405 Once you've registered, GroupLens will start giving you scores for
14406 articles based on the average of what other people think.  But, to get
14407 the real benefit of GroupLens you need to start rating articles
14408 yourself.  Then the scores GroupLens gives you will be personalized for
14409 you, based on how the people you usually agree with have already rated.
14410
14411
14412 @node Rating Articles
14413 @subsection Rating Articles
14414
14415 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
14416 Where 1 means something like this article is a waste of bandwidth and 5
14417 means that the article was really good.  The basic question to ask
14418 yourself is, "on a scale from 1 to 5 would I like to see more articles
14419 like this one?"
14420
14421 There are four ways to enter a rating for an article in GroupLens.
14422
14423 @table @kbd
14424
14425 @item r
14426 @kindex r (GroupLens)
14427 @findex bbb-summary-rate-article
14428 This function will prompt you for a rating on a scale of one to five.
14429
14430 @item k
14431 @kindex k (GroupLens)
14432 @findex grouplens-score-thread
14433 This function will prompt you for a rating, and rate all the articles in
14434 the thread.  This is really useful for some of those long running giant
14435 threads in rec.humor.
14436
14437 @end table
14438
14439 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
14440 the score of the article you're reading.
14441
14442 @table @kbd
14443
14444 @item 1-5 n
14445 @kindex n (GroupLens)
14446 @findex grouplens-next-unread-article
14447 Rate the article and go to the next unread article.
14448
14449 @item 1-5 ,
14450 @kindex , (GroupLens)
14451 @findex grouplens-best-unread-article
14452 Rate the article and go to the next unread article with the highest score.
14453
14454 @end table
14455
14456 If you want to give the current article a score of 4 and then go to the
14457 next article, just type @kbd{4 n}.
14458
14459
14460 @node Displaying Predictions
14461 @subsection Displaying Predictions
14462
14463 GroupLens makes a prediction for you about how much you will like a
14464 news article.  The predictions from GroupLens are on a scale from 1 to
14465 5, where 1 is the worst and 5 is the best.  You can use the predictions
14466 from GroupLens in one of three ways controlled by the variable
14467 @code{gnus-grouplens-override-scoring}.
14468
14469 @vindex gnus-grouplens-override-scoring
14470 There are three ways to display predictions in grouplens.  You may
14471 choose to have the GroupLens scores contribute to, or override the
14472 regular gnus scoring mechanism. override is the default; however, some
14473 people prefer to see the Gnus scores plus the grouplens scores.  To get
14474 the separate scoring behavior you need to set
14475 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
14476 GroupLens predictions combined with the grouplens scores set it to
14477 @code{'override} and to combine the scores set
14478 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
14479 the combine option you will also want to set the values for
14480 @code{grouplens-prediction-offset} and
14481 @code{grouplens-score-scale-factor}.
14482
14483 @vindex grouplens-prediction-display
14484 In either case, GroupLens gives you a few choices for how you would like
14485 to see your predictions displayed.  The display of predictions is
14486 controlled by the @code{grouplens-prediction-display} variable.
14487
14488 The following are valid values for that variable.
14489
14490 @table @code
14491 @item prediction-spot
14492 The higher the prediction, the further to the right an @samp{*} is
14493 displayed.
14494
14495 @item confidence-interval
14496 A numeric confidence interval.
14497
14498 @item prediction-bar
14499 The higher the prediction, the longer the bar.
14500
14501 @item confidence-bar
14502 Numerical confidence.
14503
14504 @item confidence-spot
14505 The spot gets bigger with more confidence.
14506
14507 @item prediction-num
14508 Plain-old numeric value.
14509
14510 @item confidence-plus-minus
14511 Prediction +/- confidence.
14512
14513 @end table
14514
14515
14516 @node GroupLens Variables
14517 @subsection GroupLens Variables
14518
14519 @table @code
14520
14521 @item gnus-summary-grouplens-line-format
14522 The summary line format used in GroupLens-enhanced summary buffers.  It
14523 accepts the same specs as the normal summary line format (@pxref{Summary
14524 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14525 %s\n}.
14526
14527 @item grouplens-bbb-host
14528 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
14529 default.
14530
14531 @item grouplens-bbb-port
14532 Port of the host running the bbbd server.  The default is 9000.
14533
14534 @item grouplens-score-offset
14535 Offset the prediction by this value.  In other words, subtract the
14536 prediction value by this number to arrive at the effective score.  The
14537 default is 0.
14538
14539 @item grouplens-score-scale-factor
14540 This variable allows the user to magnify the effect of GroupLens scores.
14541 The scale factor is applied after the offset.  The default is 1.
14542
14543 @end table
14544
14545
14546 @node Advanced Scoring
14547 @section Advanced Scoring
14548
14549 Scoring on Subjects and From headers is nice enough, but what if you're
14550 really interested in what a person has to say only when she's talking
14551 about a particular subject?  Or what if you really don't want to
14552 read what person A has to say when she's following up to person B, but
14553 want to read what she says when she's following up to person C?
14554
14555 By using advanced scoring rules you may create arbitrarily complex
14556 scoring patterns.
14557
14558 @menu
14559 * Advanced Scoring Syntax::     A definition.
14560 * Advanced Scoring Examples::   What they look like.
14561 * Advanced Scoring Tips::       Getting the most out of it.
14562 @end menu
14563
14564
14565 @node Advanced Scoring Syntax
14566 @subsection Advanced Scoring Syntax
14567
14568 Ordinary scoring rules have a string as the first element in the rule.
14569 Advanced scoring rules have a list as the first element.  The second
14570 element is the score to be applied if the first element evaluated to a
14571 non-@code{nil} value.
14572
14573 These lists may consist of three logical operators, one redirection
14574 operator, and various match operators.
14575
14576 Logical operators:
14577
14578 @table @code
14579 @item &
14580 @itemx and
14581 This logical operator will evaluate each of its arguments until it finds
14582 one that evaluates to @code{false}, and then it'll stop.  If all arguments
14583 evaluate to @code{true} values, then this operator will return
14584 @code{true}.
14585
14586 @item |
14587 @itemx or
14588 This logical operator will evaluate each of its arguments until it finds
14589 one that evaluates to @code{true}.  If no arguments are @code{true},
14590 then this operator will return @code{false}.
14591
14592 @item !
14593 @itemx not
14594 @itemx Â¬
14595 This logical operator only takes a single argument.  It returns the
14596 logical negation of the value of its argument.
14597
14598 @end table
14599
14600 There is an @dfn{indirection operator} that will make its arguments
14601 apply to the ancestors of the current article being scored.  For
14602 instance, @code{1-} will make score rules apply to the parent of the
14603 current article.  @code{2-} will make score rules apply to the
14604 grandparent of the current article.  Alternatively, you can write
14605 @code{^^}, where the number of @code{^}s (carets) says how far back into
14606 the ancestry you want to go.
14607
14608 Finally, we have the match operators.  These are the ones that do the
14609 real work.  Match operators are header name strings followed by a match
14610 and a match type.  A typical match operator looks like @samp{("from"
14611 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
14612 simple scoring, and the match types are also the same.
14613
14614
14615 @node Advanced Scoring Examples
14616 @subsection Advanced Scoring Examples
14617
14618 Let's say you want to increase the score of articles written by Lars
14619 when he's talking about Gnus:
14620
14621 @example
14622 ((&
14623   ("from" "Lars Ingebrigtsen")
14624   ("subject" "Gnus"))
14625  1000)
14626 @end example
14627
14628 Quite simple, huh?
14629
14630 When he writes long articles, he sometimes has something nice to say:
14631
14632 @example
14633 ((&
14634   ("from" "Lars Ingebrigtsen")
14635   (|
14636    ("subject" "Gnus")
14637    ("lines" 100 >)))
14638  1000)
14639 @end example
14640
14641 However, when he responds to things written by Reig Eigil Logge, you
14642 really don't want to read what he's written:
14643
14644 @example
14645 ((&
14646   ("from" "Lars Ingebrigtsen")
14647   (1- ("from" "Reig Eigir Logge")))
14648  -100000)
14649 @end example
14650
14651 Everybody that follows up Redmondo when he writes about disappearing
14652 socks should have their scores raised, but only when they talk about
14653 white socks.  However, when Lars talks about socks, it's usually not
14654 very interesting:
14655
14656 @example
14657 ((&
14658   (1-
14659    (&
14660     ("from" "redmondo@@.*no" r)
14661     ("body" "disappearing.*socks" t)))
14662   (! ("from" "Lars Ingebrigtsen"))
14663   ("body" "white.*socks"))
14664  1000)
14665 @end example
14666
14667 The possibilities are endless.
14668
14669
14670 @node Advanced Scoring Tips
14671 @subsection Advanced Scoring Tips
14672
14673 The @code{&} and @code{|} logical operators do short-circuit logic.
14674 That is, they stop processing their arguments when it's clear what the
14675 result of the operation will be.  For instance, if one of the arguments
14676 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14677 the rest of the arguments.  This means that you should put slow matches
14678 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14679 @samp{subject}) first.
14680
14681 The indirection arguments (@code{1-} and so on) will make their
14682 arguments work on previous generations of the thread.  If you say
14683 something like:
14684
14685 @example
14686 ...
14687 (1-
14688  (1-
14689   ("from" "lars")))
14690 ...
14691 @end example
14692
14693 Then that means "score on the from header of the grandparent of the
14694 current article".  An indirection is quite fast, but it's better to say:
14695
14696 @example
14697 (1-
14698  (&
14699   ("from" "Lars")
14700   ("subject" "Gnus")))
14701 @end example
14702
14703 than it is to say:
14704
14705 @example
14706 (&
14707  (1- ("from" "Lars"))
14708  (1- ("subject" "Gnus")))
14709 @end example
14710
14711
14712 @node Score Decays
14713 @section Score Decays
14714 @cindex score decays
14715 @cindex decays
14716
14717 You may find that your scores have a tendency to grow without
14718 bounds, especially if you're using adaptive scoring.  If scores get too
14719 big, they lose all meaning---they simply max out and it's difficult to
14720 use them in any sensible way.
14721
14722 @vindex gnus-decay-scores
14723 @findex gnus-decay-score
14724 @vindex gnus-decay-score-function
14725 Gnus provides a mechanism for decaying scores to help with this problem.
14726 When score files are loaded and @code{gnus-decay-scores} is
14727 non-@code{nil}, Gnus will run the score files through the decaying
14728 mechanism thereby lowering the scores of all non-permanent score rules.
14729 The decay itself if performed by the @code{gnus-decay-score-function}
14730 function, which is @code{gnus-decay-score} by default.  Here's the
14731 definition of that function:
14732
14733 @lisp
14734 (defun gnus-decay-score (score)
14735   "Decay SCORE.
14736 This is done according to `gnus-score-decay-constant'
14737 and `gnus-score-decay-scale'."
14738   (floor
14739    (- score
14740       (* (if (< score 0) 1 -1)
14741          (min (abs score)
14742               (max gnus-score-decay-constant
14743                    (* (abs score)
14744                       gnus-score-decay-scale)))))))
14745 @end lisp
14746
14747 @vindex gnus-score-decay-scale
14748 @vindex gnus-score-decay-constant
14749 @code{gnus-score-decay-constant} is 3 by default and
14750 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
14751
14752 @enumerate
14753 @item
14754 Scores between -3 and 3 will be set to 0 when this function is called.
14755
14756 @item
14757 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14758
14759 @item
14760 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14761 score.
14762 @end enumerate
14763
14764 If you don't like this decay function, write your own.  It is called
14765 with the score to be decayed as its only parameter, and it should return
14766 the new score, which should be an integer.
14767
14768 Gnus will try to decay scores once a day.  If you haven't run Gnus for
14769 four days, Gnus will decay the scores four times, for instance.
14770
14771
14772 @node Various
14773 @chapter Various
14774
14775 @menu
14776 * Process/Prefix::             A convention used by many treatment commands.
14777 * Interactive::                Making Gnus ask you many questions.
14778 * Symbolic Prefixes::          How to supply some Gnus functions with options.
14779 * Formatting Variables::       You can specify what buffers should look like.
14780 * Windows Configuration::      Configuring the Gnus buffer windows.
14781 * Faces and Fonts::            How to change how faces look.
14782 * Compilation::                How to speed Gnus up.
14783 * Mode Lines::                 Displaying information in the mode lines.
14784 * Highlighting and Menus::     Making buffers look all nice and cozy.
14785 * Buttons::                    Get tendonitis in ten easy steps!
14786 * Daemons::                    Gnus can do things behind your back.
14787 * NoCeM::                      How to avoid spam and other fatty foods.
14788 * Undo::                       Some actions can be undone.
14789 * Moderation::                 What to do if you're a moderator.
14790 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
14791 * Fuzzy Matching::             What's the big fuzz?
14792 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
14793 * Various Various::            Things that are really various.
14794 @end menu
14795
14796
14797 @node Process/Prefix
14798 @section Process/Prefix
14799 @cindex process/prefix convention
14800
14801 Many functions, among them functions for moving, decoding and saving
14802 articles, use what is known as the @dfn{Process/Prefix convention}.
14803
14804 This is a method for figuring out what articles the user wants the
14805 command to be performed on.
14806
14807 It goes like this:
14808
14809 If the numeric prefix is N, perform the operation on the next N
14810 articles, starting with the current one.  If the numeric prefix is
14811 negative, perform the operation on the previous N articles, starting
14812 with the current one.
14813
14814 @vindex transient-mark-mode
14815 If @code{transient-mark-mode} in non-@code{nil} and the region is
14816 active, all articles in the region will be worked upon.
14817
14818 If there is no numeric prefix, but some articles are marked with the
14819 process mark, perform the operation on the articles marked with
14820 the process mark.
14821
14822 If there is neither a numeric prefix nor any articles marked with the
14823 process mark, just perform the operation on the current article.
14824
14825 Quite simple, really, but it needs to be made clear so that surprises
14826 are avoided.
14827
14828 Commands that react to the process mark will push the current list of
14829 process marked articles onto a stack and will then clear all process
14830 marked articles.  You can restore the previous configuration with the
14831 @kbd{M P y} command (@pxref{Setting Process Marks}).
14832
14833 @vindex gnus-summary-goto-unread
14834 One thing that seems to shock & horrify lots of people is that, for
14835 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14836 Since each @kbd{d} (which marks the current article as read) by default
14837 goes to the next unread article after marking, this means that @kbd{3 d}
14838 will mark the next three unread articles as read, no matter what the
14839 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
14840 @code{nil} for a more straightforward action.
14841
14842
14843 @node Interactive
14844 @section Interactive
14845 @cindex interaction
14846
14847 @table @code
14848
14849 @item gnus-novice-user
14850 @vindex gnus-novice-user
14851 If this variable is non-@code{nil}, you are either a newcomer to the
14852 World of Usenet, or you are very cautious, which is a nice thing to be,
14853 really.  You will be given questions of the type ``Are you sure you want
14854 to do this?'' before doing anything dangerous.  This is @code{t} by
14855 default.
14856
14857 @item gnus-expert-user
14858 @vindex gnus-expert-user
14859 If this variable is non-@code{nil}, you will seldom be asked any
14860 questions by Gnus.  It will simply assume you know what you're doing, no
14861 matter how strange.
14862
14863 @item gnus-interactive-catchup
14864 @vindex gnus-interactive-catchup
14865 Require confirmation before catching up a group if non-@code{nil}.  It
14866 is @code{t} by default.
14867
14868 @item gnus-interactive-exit
14869 @vindex gnus-interactive-exit
14870 Require confirmation before exiting Gnus.  This variable is @code{t} by
14871 default.
14872 @end table
14873
14874
14875 @node Symbolic Prefixes
14876 @section Symbolic Prefixes
14877 @cindex symbolic prefixes
14878
14879 Quite a lot of Emacs commands react to the (numeric) prefix.  For
14880 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14881 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14882 rule of 900 to the current article.
14883
14884 This is all nice and well, but what if you want to give a command some
14885 additional information?  Well, what most commands do is interpret the
14886 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
14887 doesn't want a backup file to be created when saving the current buffer,
14888 for instance.  But what if you want to save without making a backup
14889 file, and you want Emacs to flash lights and play a nice tune at the
14890 same time?  You can't, and you're probably perfectly happy that way.
14891
14892 @kindex M-i (Summary)
14893 @findex gnus-symbolic-argument
14894 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
14895 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14896 character typed in is the value.  You can stack as many @kbd{M-i}
14897 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14898 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
14899 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14900 @code{b}''.  You get the drift.
14901
14902 Typing in symbolic prefixes to commands that don't accept them doesn't
14903 hurt, but it doesn't do any good either.  Currently not many Gnus
14904 functions make use of the symbolic prefix.
14905
14906 If you're interested in how Gnus implements this, @pxref{Extended
14907 Interactive}.
14908
14909
14910 @node Formatting Variables
14911 @section Formatting Variables
14912 @cindex formatting variables
14913
14914 Throughout this manual you've probably noticed lots of variables called
14915 things like @code{gnus-group-line-format} and
14916 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
14917 output lines in the various buffers.  There's quite a lot of them.
14918 Fortunately, they all use the same syntax, so there's not that much to
14919 be annoyed by.
14920
14921 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14922 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
14923 lots of percentages everywhere.
14924
14925 @menu
14926 * Formatting Basics::     A formatting variable is basically a format string.
14927 * Mode Line Formatting::  Some rules about mode line formatting variables.
14928 * Advanced Formatting::   Modifying output in various ways.
14929 * User-Defined Specs::    Having Gnus call your own functions.
14930 * Formatting Fonts::      Making the formatting look colorful and nice.
14931 @end menu
14932
14933 Currently Gnus uses the following formatting variables:
14934 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14935 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14936 @code{gnus-group-mode-line-format},
14937 @code{gnus-summary-mode-line-format},
14938 @code{gnus-article-mode-line-format},
14939 @code{gnus-server-mode-line-format}, and
14940 @code{gnus-summary-pick-line-format}.
14941
14942 All these format variables can also be arbitrary elisp forms.  In that
14943 case, they will be @code{eval}ed to insert the required lines.
14944
14945 @kindex M-x gnus-update-format
14946 @findex gnus-update-format
14947 Gnus includes a command to help you while creating your own format
14948 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
14949 update the spec in question and pop you to a buffer where you can
14950 examine the resulting lisp code to be run to generate the line.
14951
14952
14953
14954 @node Formatting Basics
14955 @subsection Formatting Basics
14956
14957 Each @samp{%} element will be replaced by some string or other when the
14958 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
14959 spec, and pad with spaces to get a 5-character field''.
14960
14961 As with normal C and Emacs Lisp formatting strings, the numerical
14962 modifier between the @samp{%} and the formatting type character will
14963 @dfn{pad} the output so that it is always at least that long.
14964 @samp{%5y} will make the field always (at least) five characters wide by
14965 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
14966 the right instead.
14967
14968 You may also wish to limit the length of the field to protect against
14969 particularly wide values.  For that you can say @samp{%4,6y}, which
14970 means that the field will never be more than 6 characters wide and never
14971 less than 4 characters wide.
14972
14973
14974 @node Mode Line Formatting
14975 @subsection Mode Line Formatting
14976
14977 Mode line formatting variables (e.g.,
14978 @code{gnus-summary-mode-line-format}) follow the same rules as other,
14979 buffer line oriented formatting variables (@pxref{Formatting Basics})
14980 with the following two differences:
14981
14982 @enumerate
14983
14984 @item
14985 There must be no newline (@samp{\n}) at the end.
14986
14987 @item
14988 The special @samp{%%b} spec can be used to display the buffer name.
14989 Well, it's no spec at all, really---@samp{%%} is just a way to quote
14990 @samp{%} to allow it to pass through the formatting machinery unmangled,
14991 so that Emacs receives @samp{%b}, which is something the Emacs mode line
14992 display interprets to mean ``show the buffer name''.  For a full list of
14993 mode line specs Emacs understands, see the documentation of the
14994 @code{mode-line-format} variable.
14995
14996 @end enumerate
14997
14998
14999 @node Advanced Formatting
15000 @subsection Advanced Formatting
15001
15002 It is frequently useful to post-process the fields in some way.
15003 Padding, limiting, cutting off parts and suppressing certain values can
15004 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
15005 look like @samp{%~(cut 3)~(ignore "0")y}.
15006
15007 These are the valid modifiers:
15008
15009 @table @code
15010 @item pad
15011 @itemx pad-left
15012 Pad the field to the left with spaces until it reaches the required
15013 length.
15014
15015 @item pad-right
15016 Pad the field to the right with spaces until it reaches the required
15017 length.
15018
15019 @item max
15020 @itemx max-left
15021 Cut off characters from the left until it reaches the specified length.
15022
15023 @item max-right
15024 Cut off characters from the right until it reaches the specified
15025 length.
15026
15027 @item cut
15028 @itemx cut-left
15029 Cut off the specified number of characters from the left.
15030
15031 @item cut-right
15032 Cut off the specified number of characters from the right.
15033
15034 @item ignore
15035 Return an empty string if the field is equal to the specified value.
15036
15037 @item form
15038 Use the specified form as the field value when the @samp{@@} spec is
15039 used.
15040 @end table
15041
15042 Let's take an example.  The @samp{%o} spec in the summary mode lines
15043 will return a date in compact ISO8601 format---@samp{19960809T230410}.
15044 This is quite a mouthful, so we want to shave off the century number and
15045 the time, leaving us with a six-character date.  That would be
15046 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
15047 maxing, and we need the padding to ensure that the date is never less
15048 than 6 characters to make it look nice in columns.)
15049
15050 Ignoring is done first; then cutting; then maxing; and then as the very
15051 last operation, padding.
15052
15053 If you use lots of these advanced thingies, you'll find that Gnus gets
15054 quite slow.  This can be helped enormously by running @kbd{M-x
15055 gnus-compile} when you are satisfied with the look of your lines.
15056 @xref{Compilation}.
15057
15058
15059 @node User-Defined Specs
15060 @subsection User-Defined Specs
15061
15062 All the specs allow for inserting user defined specifiers---@samp{u}.
15063 The next character in the format string should be a letter.  Gnus
15064 will call the function @code{gnus-user-format-function-}@samp{X}, where
15065 @samp{X} is the letter following @samp{%u}.  The function will be passed
15066 a single parameter---what the parameter means depends on what buffer
15067 it's being called from.  The function should return a string, which will
15068 be inserted into the buffer just like information from any other
15069 specifier.  This function may also be called with dummy values, so it
15070 should protect against that.
15071
15072 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
15073 much the same without defining new functions.  Here's an example:
15074 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
15075 given here will be evaluated to yield the current line number, and then
15076 inserted.
15077
15078
15079 @node Formatting Fonts
15080 @subsection Formatting Fonts
15081
15082 There are specs for highlighting, and these are shared by all the format
15083 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
15084 the special @code{mouse-face} property set, which means that it will be
15085 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
15086 over it.
15087
15088 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
15089 normal faces set using @code{gnus-face-0}, which is @code{bold} by
15090 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
15091 and so on.  Create as many faces as you wish.  The same goes for the
15092 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
15093 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
15094
15095 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
15096 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
15097 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
15098 @code{gnus-balloon-face-*} variables should be either strings or
15099 symbols naming functions that return a string. Under @code{balloon-help-mode},
15100 when the mouse passes over text with this property set, a balloon window
15101 will appear and display the string. Please refer to the doc string of
15102 @code{balloon-help-mode} for more information on this.
15103
15104 Here's an alternative recipe for the group buffer:
15105
15106 @lisp
15107 ;; Create three face types.
15108 (setq gnus-face-1 'bold)
15109 (setq gnus-face-3 'italic)
15110
15111 ;; We want the article count to be in
15112 ;; a bold and green face.  So we create
15113 ;; a new face called `my-green-bold'.
15114 (copy-face 'bold 'my-green-bold)
15115 ;; Set the color.
15116 (set-face-foreground 'my-green-bold "ForestGreen")
15117 (setq gnus-face-2 'my-green-bold)
15118
15119 ;; Set the new & fancy format.
15120 (setq gnus-group-line-format
15121       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
15122 @end lisp
15123
15124 I'm sure you'll be able to use this scheme to create totally unreadable
15125 and extremely vulgar displays.  Have fun!
15126
15127 Note that the @samp{%(} specs (and friends) do not make any sense on the
15128 mode-line variables.
15129
15130
15131 @node Windows Configuration
15132 @section Windows Configuration
15133 @cindex windows configuration
15134
15135 No, there's nothing here about X, so be quiet.
15136
15137 @vindex gnus-use-full-window
15138 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
15139 other windows and occupy the entire Emacs screen by itself.  It is
15140 @code{t} by default.
15141
15142 Setting this variable to @code{nil} kinda works, but there are
15143 glitches.  Use at your own peril.
15144
15145 @vindex gnus-buffer-configuration
15146 @code{gnus-buffer-configuration} describes how much space each Gnus
15147 buffer should be given.  Here's an excerpt of this variable:
15148
15149 @lisp
15150 ((group (vertical 1.0 (group 1.0 point)
15151                       (if gnus-carpal (group-carpal 4))))
15152  (article (vertical 1.0 (summary 0.25 point)
15153                         (article 1.0))))
15154 @end lisp
15155
15156 This is an alist.  The @dfn{key} is a symbol that names some action or
15157 other.  For instance, when displaying the group buffer, the window
15158 configuration function will use @code{group} as the key.  A full list of
15159 possible names is listed below.
15160
15161 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
15162 should occupy.  To take the @code{article} split as an example -
15163
15164 @lisp
15165 (article (vertical 1.0 (summary 0.25 point)
15166                        (article 1.0)))
15167 @end lisp
15168
15169 This @dfn{split} says that the summary buffer should occupy 25% of upper
15170 half of the screen, and that it is placed over the article buffer.  As
15171 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
15172 reaching for that calculator there).  However, the special number
15173 @code{1.0} is used to signal that this buffer should soak up all the
15174 rest of the space available after the rest of the buffers have taken
15175 whatever they need.  There should be only one buffer with the @code{1.0}
15176 size spec per split.
15177
15178 Point will be put in the buffer that has the optional third element
15179 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
15180 split where the tag @code{frame-focus} is a member (i.e. is the third or
15181 fourth element in the list, depending on whether the @code{point} tag is
15182 present) gets focus.
15183
15184 Here's a more complicated example:
15185
15186 @lisp
15187 (article (vertical 1.0 (group 4)
15188                        (summary 0.25 point)
15189                        (if gnus-carpal (summary-carpal 4))
15190                        (article 1.0)))
15191 @end lisp
15192
15193 If the size spec is an integer instead of a floating point number,
15194 then that number will be used to say how many lines a buffer should
15195 occupy, not a percentage.
15196
15197 If the @dfn{split} looks like something that can be @code{eval}ed (to be
15198 precise---if the @code{car} of the split is a function or a subr), this
15199 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
15200 be used as a split.  This means that there will be three buffers if
15201 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
15202 is non-@code{nil}.
15203
15204 Not complicated enough for you?  Well, try this on for size:
15205
15206 @lisp
15207 (article (horizontal 1.0
15208              (vertical 0.5
15209                  (group 1.0)
15210                  (gnus-carpal 4))
15211              (vertical 1.0
15212                  (summary 0.25 point)
15213                  (summary-carpal 4)
15214                  (article 1.0))))
15215 @end lisp
15216
15217 Whoops.  Two buffers with the mystery 100% tag.  And what's that
15218 @code{horizontal} thingie?
15219
15220 If the first element in one of the split is @code{horizontal}, Gnus will
15221 split the window horizontally, giving you two windows side-by-side.
15222 Inside each of these strips you may carry on all you like in the normal
15223 fashion.  The number following @code{horizontal} says what percentage of
15224 the screen is to be given to this strip.
15225
15226 For each split, there @emph{must} be one element that has the 100% tag.
15227 The splitting is never accurate, and this buffer will eat any leftover
15228 lines from the splits.
15229
15230 To be slightly more formal, here's a definition of what a valid split
15231 may look like:
15232
15233 @example
15234 split       = frame | horizontal | vertical | buffer | form
15235 frame       = "(frame " size *split ")"
15236 horizontal  = "(horizontal " size *split ")"
15237 vertical    = "(vertical " size *split ")"
15238 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
15239 size        = number | frame-params
15240 buffer-name = group | article | summary ...
15241 @end example
15242
15243 The limitations are that the @code{frame} split can only appear as the
15244 top-level split.  @var{form} should be an Emacs Lisp form that should
15245 return a valid split.  We see that each split is fully recursive, and
15246 may contain any number of @code{vertical} and @code{horizontal} splits.
15247
15248 @vindex gnus-window-min-width
15249 @vindex gnus-window-min-height
15250 @cindex window height
15251 @cindex window width
15252 Finding the right sizes can be a bit complicated.  No window may be less
15253 than @code{gnus-window-min-height} (default 1) characters high, and all
15254 windows must be at least @code{gnus-window-min-width} (default 1)
15255 characters wide.  Gnus will try to enforce this before applying the
15256 splits.  If you want to use the normal Emacs window width/height limit,
15257 you can just set these two variables to @code{nil}.
15258
15259 If you're not familiar with Emacs terminology, @code{horizontal} and
15260 @code{vertical} splits may work the opposite way of what you'd expect.
15261 Windows inside a @code{horizontal} split are shown side-by-side, and
15262 windows within a @code{vertical} split are shown above each other.
15263
15264 @findex gnus-configure-frame
15265 If you want to experiment with window placement, a good tip is to call
15266 @code{gnus-configure-frame} directly with a split.  This is the function
15267 that does all the real work when splitting buffers.  Below is a pretty
15268 nonsensical configuration with 5 windows; two for the group buffer and
15269 three for the article buffer.  (I said it was nonsensical.)  If you
15270 @code{eval} the statement below, you can get an idea of how that would
15271 look straight away, without going through the normal Gnus channels.
15272 Play with it until you're satisfied, and then use
15273 @code{gnus-add-configuration} to add your new creation to the buffer
15274 configuration list.
15275
15276 @lisp
15277 (gnus-configure-frame
15278  '(horizontal 1.0
15279     (vertical 10
15280       (group 1.0)
15281       (article 0.3 point))
15282     (vertical 1.0
15283       (article 1.0)
15284       (horizontal 4
15285         (group 1.0)
15286         (article 10)))))
15287 @end lisp
15288
15289 You might want to have several frames as well.  No prob---just use the
15290 @code{frame} split:
15291
15292 @lisp
15293 (gnus-configure-frame
15294  '(frame 1.0
15295          (vertical 1.0
15296                    (summary 0.25 point frame-focus)
15297                    (article 1.0))
15298          (vertical ((height . 5) (width . 15)
15299                     (user-position . t)
15300                     (left . -1) (top . 1))
15301                    (picon 1.0))))
15302
15303 @end lisp
15304
15305 This split will result in the familiar summary/article window
15306 configuration in the first (or ``main'') frame, while a small additional
15307 frame will be created where picons will be shown.  As you can see,
15308 instead of the normal @code{1.0} top-level spec, each additional split
15309 should have a frame parameter alist as the size spec.
15310 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
15311 Reference Manual}.  Under XEmacs, a frame property list will be
15312 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
15313 is such a plist.
15314 The list of all possible keys for @code{gnus-buffer-configuration} can
15315 be found in its default value.
15316
15317 Note that the @code{message} key is used for both
15318 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
15319 it is desirable to distinguish between the two, something like this
15320 might be used:
15321
15322 @lisp
15323 (message (horizontal 1.0
15324                      (vertical 1.0 (message 1.0 point))
15325                      (vertical 0.24
15326                                (if (buffer-live-p gnus-summary-buffer)
15327                                    '(summary 0.5))
15328                                (group 1.0)))))
15329 @end lisp
15330
15331 One common desire for a multiple frame split is to have a separate frame
15332 for composing mail and news while leaving the original frame intact.  To
15333 accomplish that, something like the following can be done:
15334
15335 @lisp
15336 (message (frame 1.0
15337                 (if (not (buffer-live-p gnus-summary-buffer))
15338                     (car (cdr (assoc 'group gnus-buffer-configuration)))
15339                   (car (cdr (assoc 'summary gnus-buffer-configuration))))
15340                 (vertical ((user-position . t) (top . 1) (left . 1)
15341                            (name . "Message"))
15342                           (message 1.0 point))))
15343 @end lisp
15344
15345 @findex gnus-add-configuration
15346 Since the @code{gnus-buffer-configuration} variable is so long and
15347 complicated, there's a function you can use to ease changing the config
15348 of a single setting: @code{gnus-add-configuration}.  If, for instance,
15349 you want to change the @code{article} setting, you could say:
15350
15351 @lisp
15352 (gnus-add-configuration
15353  '(article (vertical 1.0
15354                (group 4)
15355                (summary .25 point)
15356                (article 1.0))))
15357 @end lisp
15358
15359 You'd typically stick these @code{gnus-add-configuration} calls in your
15360 @file{.gnus.el} file or in some startup hook---they should be run after
15361 Gnus has been loaded.
15362
15363 @vindex gnus-always-force-window-configuration
15364 If all windows mentioned in the configuration are already visible, Gnus
15365 won't change the window configuration.  If you always want to force the
15366 ``right'' window configuration, you can set
15367 @code{gnus-always-force-window-configuration} to non-@code{nil}.
15368
15369 If you're using tree displays (@pxref{Tree Display}), and the tree
15370 window is displayed vertically next to another window, you may also want
15371 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
15372 windows resized.
15373
15374
15375 @node Faces and Fonts
15376 @section Faces and Fonts
15377 @cindex faces
15378 @cindex fonts
15379 @cindex colors
15380
15381 Fiddling with fonts and faces used to be very difficult, but these days
15382 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
15383 the face you want to alter, and alter it via the standard Customize
15384 interface.
15385
15386
15387 @node Compilation
15388 @section Compilation
15389 @cindex compilation
15390 @cindex byte-compilation
15391
15392 @findex gnus-compile
15393
15394 Remember all those line format specification variables?
15395 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
15396 on.  Now, Gnus will of course heed whatever these variables are, but,
15397 unfortunately, changing them will mean a quite significant slow-down.
15398 (The default values of these variables have byte-compiled functions
15399 associated with them, while the user-generated versions do not, of
15400 course.)
15401
15402 To help with this, you can run @kbd{M-x gnus-compile} after you've
15403 fiddled around with the variables and feel that you're (kind of)
15404 satisfied.  This will result in the new specs being byte-compiled, and
15405 you'll get top speed again.  Gnus will save these compiled specs in the
15406 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
15407 this function, though---you should compile them yourself by sticking
15408 them into the @code{.gnus.el} file and byte-compiling that file.)
15409
15410
15411 @node Mode Lines
15412 @section Mode Lines
15413 @cindex mode lines
15414
15415 @vindex gnus-updated-mode-lines
15416 @code{gnus-updated-mode-lines} says what buffers should keep their mode
15417 lines updated.  It is a list of symbols.  Supported symbols include
15418 @code{group}, @code{article}, @code{summary}, @code{server},
15419 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
15420 Gnus will keep that mode line updated with information that may be
15421 pertinent.  If this variable is @code{nil}, screen refresh may be
15422 quicker.
15423
15424 @cindex display-time
15425
15426 @vindex gnus-mode-non-string-length
15427 By default, Gnus displays information on the current article in the mode
15428 lines of the summary and article buffers.  The information Gnus wishes
15429 to display (e.g. the subject of the article) is often longer than the
15430 mode lines, and therefore have to be cut off at some point.  The
15431 @code{gnus-mode-non-string-length} variable says how long the other
15432 elements on the line is (i.e., the non-info part).  If you put
15433 additional elements on the mode line (e.g. a clock), you should modify
15434 this variable:
15435
15436 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
15437 @lisp
15438 (add-hook 'display-time-hook
15439           (lambda () (setq gnus-mode-non-string-length
15440                            (+ 21
15441                               (if line-number-mode 5 0)
15442                               (if column-number-mode 4 0)
15443                               (length display-time-string)))))
15444 @end lisp
15445
15446 If this variable is @code{nil} (which is the default), the mode line
15447 strings won't be chopped off, and they won't be padded either.  Note
15448 that the default is unlikely to be desirable, as even the percentage
15449 complete in the buffer may be crowded off the mode line; the user should
15450 configure this variable appropriately for her configuration.
15451
15452
15453 @node Highlighting and Menus
15454 @section Highlighting and Menus
15455 @cindex visual
15456 @cindex highlighting
15457 @cindex menus
15458
15459 @vindex gnus-visual
15460 The @code{gnus-visual} variable controls most of the Gnus-prettifying
15461 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
15462 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
15463 file.
15464
15465 This variable can be a list of visual properties that are enabled.  The
15466 following elements are valid, and are all included by default:
15467
15468 @table @code
15469 @item group-highlight
15470 Do highlights in the group buffer.
15471 @item summary-highlight
15472 Do highlights in the summary buffer.
15473 @item article-highlight
15474 Do highlights in the article buffer.
15475 @item highlight
15476 Turn on highlighting in all buffers.
15477 @item group-menu
15478 Create menus in the group buffer.
15479 @item summary-menu
15480 Create menus in the summary buffers.
15481 @item article-menu
15482 Create menus in the article buffer.
15483 @item browse-menu
15484 Create menus in the browse buffer.
15485 @item server-menu
15486 Create menus in the server buffer.
15487 @item score-menu
15488 Create menus in the score buffers.
15489 @item menu
15490 Create menus in all buffers.
15491 @end table
15492
15493 So if you only want highlighting in the article buffer and menus in all
15494 buffers, you could say something like:
15495
15496 @lisp
15497 (setq gnus-visual '(article-highlight menu))
15498 @end lisp
15499
15500 If you want highlighting only and no menus whatsoever, you'd say:
15501
15502 @lisp
15503 (setq gnus-visual '(highlight))
15504 @end lisp
15505
15506 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
15507 in all Gnus buffers.
15508
15509 Other general variables that influence the look of all buffers include:
15510
15511 @table @code
15512 @item gnus-mouse-face
15513 @vindex gnus-mouse-face
15514 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
15515 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15516
15517 @end table
15518
15519 There are hooks associated with the creation of all the different menus:
15520
15521 @table @code
15522
15523 @item gnus-article-menu-hook
15524 @vindex gnus-article-menu-hook
15525 Hook called after creating the article mode menu.
15526
15527 @item gnus-group-menu-hook
15528 @vindex gnus-group-menu-hook
15529 Hook called after creating the group mode menu.
15530
15531 @item gnus-summary-menu-hook
15532 @vindex gnus-summary-menu-hook
15533 Hook called after creating the summary mode menu.
15534
15535 @item gnus-server-menu-hook
15536 @vindex gnus-server-menu-hook
15537 Hook called after creating the server mode menu.
15538
15539 @item gnus-browse-menu-hook
15540 @vindex gnus-browse-menu-hook
15541 Hook called after creating the browse mode menu.
15542
15543 @item gnus-score-menu-hook
15544 @vindex gnus-score-menu-hook
15545 Hook called after creating the score mode menu.
15546
15547 @end table
15548
15549
15550 @node Buttons
15551 @section Buttons
15552 @cindex buttons
15553 @cindex mouse
15554 @cindex click
15555
15556 Those new-fangled @dfn{mouse} contraptions is very popular with the
15557 young, hep kids who don't want to learn the proper way to do things
15558 these days.  Why, I remember way back in the summer of '89, when I was
15559 using Emacs on a Tops 20 system.  Three hundred users on one single
15560 machine, and every user was running Simula compilers.  Bah!
15561
15562 Right.
15563
15564 @vindex gnus-carpal
15565 Well, you can make Gnus display bufferfuls of buttons you can click to
15566 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
15567 really.  Tell the chiropractor I sent you.
15568
15569
15570 @table @code
15571
15572 @item gnus-carpal-mode-hook
15573 @vindex gnus-carpal-mode-hook
15574 Hook run in all carpal mode buffers.
15575
15576 @item gnus-carpal-button-face
15577 @vindex gnus-carpal-button-face
15578 Face used on buttons.
15579
15580 @item gnus-carpal-header-face
15581 @vindex gnus-carpal-header-face
15582 Face used on carpal buffer headers.
15583
15584 @item gnus-carpal-group-buffer-buttons
15585 @vindex gnus-carpal-group-buffer-buttons
15586 Buttons in the group buffer.
15587
15588 @item gnus-carpal-summary-buffer-buttons
15589 @vindex gnus-carpal-summary-buffer-buttons
15590 Buttons in the summary buffer.
15591
15592 @item gnus-carpal-server-buffer-buttons
15593 @vindex gnus-carpal-server-buffer-buttons
15594 Buttons in the server buffer.
15595
15596 @item gnus-carpal-browse-buffer-buttons
15597 @vindex gnus-carpal-browse-buffer-buttons
15598 Buttons in the browse buffer.
15599 @end table
15600
15601 All the @code{buttons} variables are lists.  The elements in these list
15602 are either cons cells where the @code{car} contains a text to be displayed and
15603 the @code{cdr} contains a function symbol, or a simple string.
15604
15605
15606 @node Daemons
15607 @section Daemons
15608 @cindex demons
15609 @cindex daemons
15610
15611 Gnus, being larger than any program ever written (allegedly), does lots
15612 of strange stuff that you may wish to have done while you're not
15613 present.  For instance, you may want it to check for new mail once in a
15614 while.  Or you may want it to close down all connections to all servers
15615 when you leave Emacs idle.  And stuff like that.
15616
15617 Gnus will let you do stuff like that by defining various
15618 @dfn{handlers}.  Each handler consists of three elements:  A
15619 @var{function}, a @var{time}, and an @var{idle} parameter.
15620
15621 Here's an example of a handler that closes connections when Emacs has
15622 been idle for thirty minutes:
15623
15624 @lisp
15625 (gnus-demon-close-connections nil 30)
15626 @end lisp
15627
15628 Here's a handler that scans for PGP headers every hour when Emacs is
15629 idle:
15630
15631 @lisp
15632 (gnus-demon-scan-pgp 60 t)
15633 @end lisp
15634
15635 This @var{time} parameter and than @var{idle} parameter work together
15636 in a strange, but wonderful fashion.  Basically, if @var{idle} is
15637 @code{nil}, then the function will be called every @var{time} minutes.
15638
15639 If @var{idle} is @code{t}, then the function will be called after
15640 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
15641 the function will never be called.  But once Emacs goes idle, the
15642 function will be called every @var{time} minutes.
15643
15644 If @var{idle} is a number and @var{time} is a number, the function will
15645 be called every @var{time} minutes only when Emacs has been idle for
15646 @var{idle} minutes.
15647
15648 If @var{idle} is a number and @var{time} is @code{nil}, the function
15649 will be called once every time Emacs has been idle for @var{idle}
15650 minutes.
15651
15652 And if @var{time} is a string, it should look like @samp{07:31}, and
15653 the function will then be called once every day somewhere near that
15654 time.  Modified by the @var{idle} parameter, of course.
15655
15656 @vindex gnus-demon-timestep
15657 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15658 seconds.  This is 60 by default.  If you change that variable,
15659 all the timings in the handlers will be affected.)
15660
15661 So, if you want to add a handler, you could put something like this in
15662 your @file{.gnus} file:
15663
15664 @findex gnus-demon-add-handler
15665 @lisp
15666 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15667 @end lisp
15668
15669 @findex gnus-demon-add-nocem
15670 @findex gnus-demon-add-scanmail
15671 @findex gnus-demon-add-rescan
15672 @findex gnus-demon-add-scan-timestamps
15673 @findex gnus-demon-add-disconnection
15674 Some ready-made functions to do this have been created:
15675 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15676 @code{gnus-demon-add-nntp-close-connection},
15677 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15678 @code{gnus-demon-add-scanmail}.  Just put those functions in your
15679 @file{.gnus} if you want those abilities.
15680
15681 @findex gnus-demon-init
15682 @findex gnus-demon-cancel
15683 @vindex gnus-demon-handlers
15684 If you add handlers to @code{gnus-demon-handlers} directly, you should
15685 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
15686 daemons, you can use the @code{gnus-demon-cancel} function.
15687
15688 Note that adding daemons can be pretty naughty if you over do it.  Adding
15689 functions that scan all news and mail from all servers every two seconds
15690 is a sure-fire way of getting booted off any respectable system.  So
15691 behave.
15692
15693
15694 @node NoCeM
15695 @section NoCeM
15696 @cindex nocem
15697 @cindex spam
15698
15699 @dfn{Spamming} is posting the same article lots and lots of times.
15700 Spamming is bad.  Spamming is evil.
15701
15702 Spamming is usually canceled within a day or so by various anti-spamming
15703 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
15704 NoCeM is pronounced ``no see-'em'', and means what the name
15705 implies---these are messages that make the offending articles, like, go
15706 away.
15707
15708 What use are these NoCeM messages if the articles are canceled anyway?
15709 Some sites do not honor cancel messages and some sites just honor cancels
15710 from a select few people.  Then you may wish to make use of the NoCeM
15711 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15712
15713 Gnus can read and parse the messages in this group automatically, and
15714 this will make spam disappear.
15715
15716 There are some variables to customize, of course:
15717
15718 @table @code
15719 @item gnus-use-nocem
15720 @vindex gnus-use-nocem
15721 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
15722 by default.
15723
15724 @item gnus-nocem-groups
15725 @vindex gnus-nocem-groups
15726 Gnus will look for NoCeM messages in the groups in this list.  The
15727 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15728 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15729
15730 @item gnus-nocem-issuers
15731 @vindex gnus-nocem-issuers
15732 There are many people issuing NoCeM messages.  This list says what
15733 people you want to listen to.  The default is @code{("Automoose-1"
15734 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15735 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15736 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15737
15738 Known despammers that you can put in this list include:
15739
15740 @table @samp
15741 @item clewis@@ferret.ocunix.on.ca;
15742 @cindex Chris Lewis
15743 Chris Lewis---Major Canadian despammer who has probably canceled more
15744 usenet abuse than anybody else.
15745
15746 @item Automoose-1
15747 @cindex CancelMoose[tm]
15748 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
15749 Norwegian, and was the person(s) who invented NoCeM.
15750
15751 @item jem@@xpat.com;
15752 @cindex Jem
15753 John Milburn---despammer located in Korea who is getting very busy these
15754 days.
15755
15756 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15757 Richard E. Depew---lone American despammer.  He mostly cancels binary
15758 postings to non-binary groups and removes spews (regurgitated articles).
15759 @end table
15760
15761 You do not have to heed NoCeM messages from all these people---just the
15762 ones you want to listen to.  You also don't have to accept all NoCeM
15763 messages from the people you like.  Each NoCeM message has a @dfn{type}
15764 header that gives the message a (more or less, usually less) rigorous
15765 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15766 @samp{binary}, and @samp{troll}.  To specify this, you have to use
15767 @var{(issuer conditions ...)} elements in the list.  Each condition is
15768 either a string (which is a regexp that matches types you want to use)
15769 or a list on the form @code{(not STRING)}, where @var{string} is a
15770 regexp that matches types you don't want to use.
15771
15772 For instance, if you want all NoCeM messages from Chris Lewis except his
15773 @samp{troll} messages, you'd say:
15774
15775 @lisp
15776 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15777 @end lisp
15778
15779 On the other hand, if you just want nothing but his @samp{spam} and
15780 @samp{spew} messages, you'd say:
15781
15782 @lisp
15783 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15784 @end lisp
15785
15786 The specs are applied left-to-right.
15787
15788
15789 @item gnus-nocem-verifyer
15790 @vindex gnus-nocem-verifyer
15791 @findex mc-verify
15792 This should be a function for verifying that the NoCeM issuer is who she
15793 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
15794 function.  If this is too slow and you don't care for verification
15795 (which may be dangerous), you can set this variable to @code{nil}.
15796
15797 If you want signed NoCeM messages to be verified and unsigned messages
15798 not to be verified (but used anyway), you could do something like:
15799
15800 @lisp
15801 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15802
15803 (defun my-gnus-mc-verify ()
15804   (not (eq 'forged
15805            (ignore-errors
15806              (if (mc-verify)
15807                  t
15808                'forged)))))
15809 @end lisp
15810
15811 This might be dangerous, though.
15812
15813 @item gnus-nocem-directory
15814 @vindex gnus-nocem-directory
15815 This is where Gnus will store its NoCeM cache files.  The default is
15816 @file{~/News/NoCeM/}.
15817
15818 @item gnus-nocem-expiry-wait
15819 @vindex gnus-nocem-expiry-wait
15820 The number of days before removing old NoCeM entries from the cache.
15821 The default is 15.  If you make it shorter Gnus will be faster, but you
15822 might then see old spam.
15823
15824 @end table
15825
15826 Using NoCeM could potentially be a memory hog.  If you have many living
15827 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15828 big.  If this is a problem, you should kill off all (or most) of your
15829 unsubscribed groups (@pxref{Subscription Commands}).
15830
15831
15832 @node Undo
15833 @section Undo
15834 @cindex undo
15835
15836 It is very useful to be able to undo actions one has done.  In normal
15837 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15838 In Gnus buffers, however, it isn't that simple.
15839
15840 The things Gnus displays in its buffer is of no value whatsoever to
15841 Gnus---it's all just data designed to look nice to the user.
15842 Killing a group in the group buffer with @kbd{C-k} makes the line
15843 disappear, but that's just a side-effect of the real action---the
15844 removal of the group in question from the internal Gnus structures.
15845 Undoing something like that can't be done by the normal Emacs
15846 @code{undo} function.
15847
15848 Gnus tries to remedy this somewhat by keeping track of what the user
15849 does and coming up with actions that would reverse the actions the user
15850 takes.  When the user then presses the @code{undo} key, Gnus will run
15851 the code to reverse the previous action, or the previous actions.
15852 However, not all actions are easily reversible, so Gnus currently offers
15853 a few key functions to be undoable.  These include killing groups,
15854 yanking groups, and changing the list of read articles of groups.
15855 That's it, really.  More functions may be added in the future, but each
15856 added function means an increase in data to be stored, so Gnus will
15857 never be totally undoable.
15858
15859 @findex gnus-undo-mode
15860 @vindex gnus-use-undo
15861 @findex gnus-undo
15862 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
15863 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15864 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
15865 command, which should feel kinda like the normal Emacs @code{undo}
15866 command.
15867
15868
15869 @node Moderation
15870 @section Moderation
15871 @cindex moderation
15872
15873 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15874 It is not included in the standard Gnus package.  Write a mail to
15875 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15876 get a copy.
15877
15878 The moderation package is implemented as a minor mode for summary
15879 buffers.  Put
15880
15881 @lisp
15882 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15883 @end lisp
15884
15885 in your @file{.gnus.el} file.
15886
15887 If you are the moderator of @samp{rec.zoofle}, this is how it's
15888 supposed to work:
15889
15890 @enumerate
15891 @item
15892 You split your incoming mail by matching on
15893 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15894 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15895
15896 @item
15897 You enter that group once in a while and post articles using the @kbd{e}
15898 (edit-and-post) or @kbd{s} (just send unedited) commands.
15899
15900 @item
15901 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15902 articles that weren't approved by you, you can cancel them with the
15903 @kbd{c} command.
15904 @end enumerate
15905
15906 To use moderation mode in these two groups, say:
15907
15908 @lisp
15909 (setq gnus-moderated-list
15910       "^nnml:rec.zoofle$\\|^rec.zoofle$")
15911 @end lisp
15912
15913
15914 @node XEmacs Enhancements
15915 @section XEmacs Enhancements
15916 @cindex XEmacs
15917
15918 XEmacs is able to display pictures and stuff, so Gnus has taken
15919 advantage of that.
15920
15921 @menu
15922 * Picons::    How to display pictures of what your reading.
15923 * Smileys::   Show all those happy faces the way they were meant to be shown.
15924 * Toolbar::   Click'n'drool.
15925 * XVarious::  Other XEmacsy Gnusey variables.
15926 @end menu
15927
15928
15929 @node Picons
15930 @subsection Picons
15931
15932 @iftex
15933 @iflatex
15934 \include{picons}
15935 @end iflatex
15936 @end iftex
15937
15938 So...  You want to slow down your news reader even more!  This is a
15939 good way to do so.  Its also a great way to impress people staring
15940 over your shoulder as you read news.
15941
15942 @menu
15943 * Picon Basics::           What are picons and How do I get them.
15944 * Picon Requirements::     Don't go further if you aren't using XEmacs.
15945 * Easy Picons::            Displaying Picons---the easy way.
15946 * Hard Picons::            The way you should do it.  You'll learn something.
15947 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15948 @end menu
15949
15950
15951 @node Picon Basics
15952 @subsubsection Picon Basics
15953
15954 What are Picons?  To quote directly from the Picons Web site:
15955
15956 @iftex
15957 @iflatex
15958 \margindex{}
15959 @end iflatex
15960 @end iftex
15961
15962 @quotation
15963 @dfn{Picons} is short for ``personal icons''.  They're small,
15964 constrained images used to represent users and domains on the net,
15965 organized into databases so that the appropriate image for a given
15966 e-mail address can be found.  Besides users and domains, there are picon
15967 databases for Usenet newsgroups and weather forecasts.  The picons are
15968 in either monochrome @code{XBM} format or color @code{XPM} and
15969 @code{GIF} formats.
15970 @end quotation
15971
15972 @vindex gnus-picons-piconsearch-url
15973 If you have a permanent connection to the Internet you can use Steve
15974 Kinzler's Picons Search engine by setting
15975 @code{gnus-picons-piconsearch-url} to the string @*
15976 @file{http://www.cs.indiana.edu/picons/search.html}.
15977
15978 @vindex gnus-picons-database
15979 Otherwise you need a local copy of his database.  For instructions on
15980 obtaining and installing the picons databases, point your Web browser at @*
15981 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
15982 picons to be installed into a location pointed to by
15983 @code{gnus-picons-database}.
15984
15985
15986 @node Picon Requirements
15987 @subsubsection Picon Requirements
15988
15989 To have Gnus display Picons for you, you must be running XEmacs
15990 19.13 or greater since all other versions of Emacs aren't yet able to
15991 display images.
15992
15993 Additionally, you must have @code{x} support compiled into XEmacs.  To
15994 display color picons which are much nicer than the black & white one,
15995 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
15996
15997 @vindex gnus-picons-convert-x-face
15998 If you want to display faces from @code{X-Face} headers, you should have
15999 the @code{xface} support compiled into XEmacs.  Otherwise you must have
16000 the @code{netpbm} utilities installed, or munge the
16001 @code{gnus-picons-convert-x-face} variable to use something else.
16002
16003
16004 @node Easy Picons
16005 @subsubsection Easy Picons
16006
16007 To enable displaying picons, simply put the following line in your
16008 @file{~/.gnus} file and start Gnus.
16009
16010 @lisp
16011 (setq gnus-use-picons t)
16012 (setq gnus-treat-display-picons t)
16013 @end lisp
16014
16015 and make sure @code{gnus-picons-database} points to the directory
16016 containing the Picons databases.
16017
16018 Alternatively if you want to use the web piconsearch engine add this:
16019
16020 @lisp
16021 (setq gnus-picons-piconsearch-url
16022       "http://www.cs.indiana.edu:800/piconsearch")
16023 @end lisp
16024
16025
16026 @node Hard Picons
16027 @subsubsection Hard Picons
16028
16029 @iftex
16030 @iflatex
16031 \margindex{}
16032 @end iflatex
16033 @end iftex
16034
16035 Gnus can display picons for you as you enter and leave groups and
16036 articles.  It knows how to interact with three sections of the picons
16037 database.  Namely, it can display the picons newsgroup pictures,
16038 author's face picture(s), and the authors domain.  To enable this
16039 feature, you need to select where to get the picons from, and where to
16040 display them.
16041
16042 @table @code
16043
16044 @item gnus-picons-database
16045 @vindex gnus-picons-database
16046 The location of the picons database.  Should point to a directory
16047 containing the @file{news}, @file{domains}, @file{users} (and so on)
16048 subdirectories.  This is only useful if
16049 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
16050 @file{/usr/local/faces/}.
16051
16052 @item gnus-picons-piconsearch-url
16053 @vindex gnus-picons-piconsearch-url
16054 The URL for the web picons search engine.  The only currently known
16055 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
16056 workaround network delays, icons will be fetched in the background.  If
16057 this is @code{nil} 'the default), then picons are fetched from local
16058 database indicated by @code{gnus-picons-database}.
16059
16060 @item gnus-picons-display-where
16061 @vindex gnus-picons-display-where
16062 Where the picon images should be displayed.  It is @code{picons} by
16063 default (which by default maps to the buffer @samp{*Picons*}).  Other
16064 valid places could be @code{article}, @code{summary}, or
16065 @samp{*scratch*} for all I care.  Just make sure that you've made the
16066 buffer visible using the standard Gnus window configuration
16067 routines---@pxref{Windows Configuration}.
16068
16069 @item gnus-picons-group-excluded-groups
16070 @vindex gnus-picons-group-excluded-groups
16071 Groups that are matched by this regexp won't have their group icons
16072 displayed.
16073
16074 @end table
16075
16076 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
16077 window configuration for you to include the @code{picons} buffer.
16078
16079 Now that you've made those decision, you need to add the following
16080 functions to the appropriate hooks so these pictures will get displayed
16081 at the right time.
16082
16083 @vindex gnus-picons-display-where
16084 @table @code
16085 @item gnus-article-display-picons
16086 @findex gnus-article-display-picons
16087 Looks up and displays the picons for the author and the author's domain
16088 in the @code{gnus-picons-display-where} buffer.
16089
16090 @item gnus-picons-article-display-x-face
16091 @findex gnus-article-display-picons
16092 Decodes and displays the X-Face header if present.
16093
16094 @end table
16095
16096
16097
16098 @node Picon Useless Configuration
16099 @subsubsection Picon Useless Configuration
16100
16101 @iftex
16102 @iflatex
16103 \margindex{}
16104 @end iflatex
16105 @end iftex
16106
16107 The following variables offer further control over how things are
16108 done, where things are located, and other useless stuff you really
16109 don't need to worry about.
16110
16111 @table @code
16112
16113 @item gnus-picons-news-directories
16114 @vindex gnus-picons-news-directories
16115 List of subdirectories to search in @code{gnus-picons-database} for
16116 newsgroups faces.  @code{("news")} is the default.
16117
16118 @item gnus-picons-user-directories
16119 @vindex gnus-picons-user-directories
16120 List of subdirectories to search in @code{gnus-picons-database} for user
16121 faces.  @code{("local" "users" "usenix" "misc")} is the default.
16122
16123 @item gnus-picons-domain-directories
16124 @vindex gnus-picons-domain-directories
16125 List of subdirectories to search in @code{gnus-picons-database} for
16126 domain name faces.  Defaults to @code{("domains")}.  Some people may
16127 want to add @samp{"unknown"} to this list.
16128
16129 @item gnus-picons-convert-x-face
16130 @vindex gnus-picons-convert-x-face
16131 If you don't have @code{xface} support builtin XEmacs, this is the
16132 command to use to convert the @code{X-Face} header to an X bitmap
16133 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
16134 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
16135 gnus-picons-x-face-file-name)}
16136
16137 @item gnus-picons-x-face-file-name
16138 @vindex gnus-picons-x-face-file-name
16139 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
16140 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
16141
16142 @item gnus-picons-has-modeline-p
16143 @vindex gnus-picons-has-modeline-p
16144 If you have set @code{gnus-picons-display-where} to @code{picons}, your
16145 XEmacs frame will become really cluttered.  To alleviate this a bit you
16146 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
16147 remove the mode line from the Picons buffer.  This is only useful if
16148 @code{gnus-picons-display-where} is @code{picons}.
16149
16150 @item gnus-picons-refresh-before-display
16151 @vindex gnus-picons-refresh-before-display
16152 If non-nil, display the article buffer before computing the picons.
16153 Defaults to @code{nil}.
16154
16155 @item gnus-picons-display-as-address
16156 @vindex gnus-picons-display-as-address
16157 If @code{t} display textual email addresses along with pictures.
16158 Defaults to @code{t}.
16159
16160 @item gnus-picons-file-suffixes
16161 @vindex gnus-picons-file-suffixes
16162 Ordered list of suffixes on picon file names to try.  Defaults to
16163 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
16164
16165 @item gnus-picons-setup-hook
16166 @vindex gnus-picons-setup-hook
16167 Hook run in the picon buffer, if that is displayed.
16168
16169 @item gnus-picons-display-article-move-p
16170 @vindex gnus-picons-display-article-move-p
16171 Whether to move point to first empty line when displaying picons.  This
16172 has only an effect if `gnus-picons-display-where' has value `article'.
16173
16174 If @code{nil}, display the picons in the @code{From} and
16175 @code{Newsgroups} lines.  This is the defailt.
16176
16177 @item gnus-picons-clear-cache-on-shutdown
16178 @vindex gnus-picons-clear-cache-on-shutdown
16179 Whether to clear the picons cache when exiting gnus.  Gnus caches every
16180 picons it finds while it is running.  This saves some time in the search
16181 process but eats some memory.  If this variable is set to @code{nil},
16182 Gnus will never clear the cache itself; you will have to manually call
16183 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
16184 cleared every time you exit Gnus.  Defaults to @code{t}.
16185
16186 @iftex
16187 @iflatex
16188 \margindex{}
16189 @end iflatex
16190 @end iftex
16191
16192 @end table
16193
16194 @node Smileys
16195 @subsection Smileys
16196 @cindex smileys
16197
16198 @iftex
16199 @iflatex
16200 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
16201 \input{smiley}
16202 @end iflatex
16203 @end iftex
16204
16205 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
16206 currently the only package that uses Smiley, it is documented here.
16207
16208 In short---to use Smiley in Gnus, put the following in your
16209 @file{.gnus.el} file:
16210
16211 @lisp
16212 (setq gnus-treat-display-smiley t)
16213 @end lisp
16214
16215 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
16216 the like---to pictures and displays those instead of the text smiley
16217 faces.  The conversion is controlled by a list of regexps that matches
16218 text and maps that to file names.
16219
16220 @vindex smiley-nosey-regexp-alist
16221 @vindex smiley-deformed-regexp-alist
16222 Smiley supplies two example conversion alists by default:
16223 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
16224 and so on), and @code{smiley-nosey-regexp-alist} (which matches
16225 @samp{:-)}, @samp{:-(} and so on).
16226
16227 The alist used is specified by the @code{smiley-regexp-alist} variable,
16228 which defaults to the value of @code{smiley-deformed-regexp-alist}.
16229
16230 The first item in each element is the regexp to be matched; the second
16231 element is the regexp match group that is to be replaced by the picture;
16232 and the third element is the name of the file to be displayed.
16233
16234 The following variables customize where Smiley will look for these
16235 files, as well as the color to be used and stuff:
16236
16237 @table @code
16238
16239 @item smiley-data-directory
16240 @vindex smiley-data-directory
16241 Where Smiley will look for smiley faces files.
16242
16243 @item smiley-flesh-color
16244 @vindex smiley-flesh-color
16245 Skin color.  The default is @samp{yellow}, which is really racist.
16246
16247 @item smiley-features-color
16248 @vindex smiley-features-color
16249 Color of the features of the face.  The default is @samp{black}.
16250
16251 @item smiley-tongue-color
16252 @vindex smiley-tongue-color
16253 Color of the tongue.  The default is @samp{red}.
16254
16255 @item smiley-circle-color
16256 @vindex smiley-circle-color
16257 Color of the circle around the face.  The default is @samp{black}.
16258
16259 @item smiley-mouse-face
16260 @vindex smiley-mouse-face
16261 Face used for mouse highlighting over the smiley face.
16262
16263 @end table
16264
16265
16266 @node Toolbar
16267 @subsection Toolbar
16268
16269 @table @code
16270
16271 @iftex
16272 @iflatex
16273 \margindex{}
16274 @end iflatex
16275 @end iftex
16276
16277 @item gnus-use-toolbar
16278 @vindex gnus-use-toolbar
16279 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
16280 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
16281 @code{right-toolbar}, or @code{left-toolbar}.
16282
16283 @item gnus-group-toolbar
16284 @vindex gnus-group-toolbar
16285 The toolbar in the group buffer.
16286
16287 @item gnus-summary-toolbar
16288 @vindex gnus-summary-toolbar
16289 The toolbar in the summary buffer.
16290
16291 @item gnus-summary-mail-toolbar
16292 @vindex gnus-summary-mail-toolbar
16293 The toolbar in the summary buffer of mail groups.
16294
16295 @end table
16296
16297
16298 @node XVarious
16299 @subsection Various XEmacs Variables
16300
16301 @table @code
16302 @item gnus-xmas-glyph-directory
16303 @vindex gnus-xmas-glyph-directory
16304 This is where Gnus will look for pictures.  Gnus will normally
16305 auto-detect this directory, but you may set it manually if you have an
16306 unusual directory structure.
16307
16308 @item gnus-xmas-logo-color-alist
16309 @vindex gnus-xmas-logo-color-alist
16310 This is an alist where the key is a type symbol and the values are the
16311 foreground and background color of the splash page glyph.
16312
16313 @item gnus-xmas-logo-color-style
16314 @vindex gnus-xmas-logo-color-style
16315 This is the key used to look up the color in the alist described above.
16316 Valid values include @code{flame}, @code{pine}, @code{moss},
16317 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
16318 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
16319
16320 @item gnus-xmas-modeline-glyph
16321 @vindex gnus-xmas-modeline-glyph
16322 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
16323 default.
16324
16325 @iftex
16326 @iflatex
16327 \margindex{}
16328 @end iflatex
16329 @end iftex
16330
16331 @end table
16332
16333
16334
16335
16336 @node Fuzzy Matching
16337 @section Fuzzy Matching
16338 @cindex fuzzy matching
16339
16340 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
16341 things like scoring, thread gathering and thread comparison.
16342
16343 As opposed to regular expression matching, fuzzy matching is very fuzzy.
16344 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
16345 means, and the implementation has changed over time.
16346
16347 Basically, it tries to remove all noise from lines before comparing.
16348 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
16349 out of the strings before comparing the results.  This often leads to
16350 adequate results---even when faced with strings generated by text
16351 manglers masquerading as newsreaders.
16352
16353
16354 @node Thwarting Email Spam
16355 @section Thwarting Email Spam
16356 @cindex email spam
16357 @cindex spam
16358 @cindex UCE
16359 @cindex unsolicited commercial email
16360
16361 In these last days of the Usenet, commercial vultures are hanging about
16362 and grepping through news like crazy to find email addresses they can
16363 foist off their scams and products to.  As a reaction to this, many
16364 people have started putting nonsense addresses into their @code{From}
16365 lines.  I think this is counterproductive---it makes it difficult for
16366 people to send you legitimate mail in response to things you write, as
16367 well as making it difficult to see who wrote what.  This rewriting may
16368 perhaps be a bigger menace than the unsolicited commercial email itself
16369 in the end.
16370
16371 The biggest problem I have with email spam is that it comes in under
16372 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
16373 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
16374 mail group, only to find two pyramid schemes, seven advertisements
16375 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
16376 and one mail asking me to repent and find some god.
16377
16378 This is annoying.
16379
16380 The way to deal with this is having Gnus split out all spam into a
16381 @samp{spam} mail group (@pxref{Splitting Mail}).
16382
16383 First, pick one (1) valid mail address that you can be reached at, and
16384 put it in your @code{From} header of all your news articles.  (I've
16385 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
16386 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
16387 sysadm whether your sendmail installation accepts keywords in the local
16388 part of the mail address.)
16389
16390 @lisp
16391 (setq message-default-news-headers
16392       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
16393 @end lisp
16394
16395 Then put the following split rule in @code{nnmail-split-fancy}
16396 (@pxref{Fancy Mail Splitting}):
16397
16398 @lisp
16399 (
16400  ...
16401  (to "larsi@@trym.ifi.uio.no"
16402       (| ("subject" "re:.*" "misc")
16403          ("references" ".*@@.*" "misc")
16404          "spam"))
16405  ...
16406 )
16407 @end lisp
16408
16409 This says that all mail to this address is suspect, but if it has a
16410 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
16411 header, it's probably ok.  All the rest goes to the @samp{spam} group.
16412 (This idea probably comes from Tim Pierce.)
16413
16414 In addition, many mail spammers talk directly to your @code{smtp} server
16415 and do not include your email address explicitly in the @code{To}
16416 header.  Why they do this is unknown---perhaps it's to thwart this
16417 thwarting scheme?  In any case, this is trivial to deal with---you just
16418 put anything not addressed to you in the @samp{spam} group by ending
16419 your fancy split rule in this way:
16420
16421 @lisp
16422 (
16423  ...
16424  (to "larsi" "misc")
16425  "spam")
16426 @end lisp
16427
16428 In my experience, this will sort virtually everything into the right
16429 group.  You still have to check the @samp{spam} group from time to time to
16430 check for legitimate mail, though.  If you feel like being a good net
16431 citizen, you can even send off complaints to the proper authorities on
16432 each unsolicited commercial email---at your leisure.
16433
16434 If you are also a lazy net citizen, you will probably prefer complaining
16435 automatically with the @file{gnus-junk.el} package, available FOR FREE
16436 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
16437 Since most e-mail spam is sent automatically, this may reconcile the
16438 cosmic balance somewhat.
16439
16440 This works for me.  It allows people an easy way to contact me (they can
16441 just press @kbd{r} in the usual way), and I'm not bothered at all with
16442 spam.  It's a win-win situation.  Forging @code{From} headers to point
16443 to non-existent domains is yucky, in my opinion.
16444
16445
16446 @node Various Various
16447 @section Various Various
16448 @cindex mode lines
16449 @cindex highlights
16450
16451 @table @code
16452
16453 @item gnus-home-directory
16454 All Gnus path variables will be initialized from this variable, which
16455 defaults to @file{~/}.
16456
16457 @item gnus-directory
16458 @vindex gnus-directory
16459 Most Gnus storage path variables will be initialized from this variable,
16460 which defaults to the @samp{SAVEDIR} environment variable, or
16461 @file{~/News/} if that variable isn't set.
16462
16463 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
16464 This means that other directory variables that are initialized from this
16465 variable won't be set properly if you set this variable in
16466 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
16467
16468 @item gnus-default-directory
16469 @vindex gnus-default-directory
16470 Not related to the above variable at all---this variable says what the
16471 default directory of all Gnus buffers should be.  If you issue commands
16472 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
16473 default directory.  If this variable is @code{nil} (which is the
16474 default), the default directory will be the default directory of the
16475 buffer you were in when you started Gnus.
16476
16477 @item gnus-verbose
16478 @vindex gnus-verbose
16479 This variable is an integer between zero and ten.  The higher the value,
16480 the more messages will be displayed.  If this variable is zero, Gnus
16481 will never flash any messages, if it is seven (which is the default),
16482 most important messages will be shown, and if it is ten, Gnus won't ever
16483 shut up, but will flash so many messages it will make your head swim.
16484
16485 @item gnus-verbose-backends
16486 @vindex gnus-verbose-backends
16487 This variable works the same way as @code{gnus-verbose}, but it applies
16488 to the Gnus backends instead of Gnus proper.
16489
16490 @item nnheader-max-head-length
16491 @vindex nnheader-max-head-length
16492 When the backends read straight heads of articles, they all try to read
16493 as little as possible.  This variable (default 4096) specifies
16494 the absolute max length the backends will try to read before giving up
16495 on finding a separator line between the head and the body.  If this
16496 variable is @code{nil}, there is no upper read bound.  If it is
16497 @code{t}, the backends won't try to read the articles piece by piece,
16498 but read the entire articles.  This makes sense with some versions of
16499 @code{ange-ftp} or @code{efs}.
16500
16501 @item nnheader-head-chop-length
16502 @vindex nnheader-head-chop-length
16503 This variable (default 2048) says how big a piece of each article to
16504 read when doing the operation described above.
16505
16506 @item nnheader-file-name-translation-alist
16507 @vindex nnheader-file-name-translation-alist
16508 @cindex file names
16509 @cindex invalid characters in file names
16510 @cindex characters in file names
16511 This is an alist that says how to translate characters in file names.
16512 For instance, if @samp{:} is invalid as a file character in file names
16513 on your system (you OS/2 user you), you could say something like:
16514
16515 @lisp
16516 (setq nnheader-file-name-translation-alist
16517       '((?: . ?_)))
16518 @end lisp
16519
16520 In fact, this is the default value for this variable on OS/2 and MS
16521 Windows (phooey) systems.
16522
16523 @item gnus-hidden-properties
16524 @vindex gnus-hidden-properties
16525 This is a list of properties to use to hide ``invisible'' text.  It is
16526 @code{(invisible t intangible t)} by default on most systems, which
16527 makes invisible text invisible and intangible.
16528
16529 @item gnus-parse-headers-hook
16530 @vindex gnus-parse-headers-hook
16531 A hook called before parsing headers.  It can be used, for instance, to
16532 gather statistics on the headers fetched, or perhaps you'd like to prune
16533 some headers.  I don't see why you'd want that, though.
16534
16535 @item gnus-shell-command-separator
16536 @vindex gnus-shell-command-separator
16537 String used to separate two shell commands.  The default is @samp{;}.
16538
16539
16540 @end table
16541
16542
16543 @node The End
16544 @chapter The End
16545
16546 Well, that's the manual---you can get on with your life now.  Keep in
16547 touch.  Say hello to your cats from me.
16548
16549 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
16550
16551 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16552
16553 @quotation
16554 @strong{Te Deum}
16555
16556 @sp 1
16557 Not because of victories @*
16558 I sing,@*
16559 having none,@*
16560 but for the common sunshine,@*
16561 the breeze,@*
16562 the largess of the spring.
16563
16564 @sp 1
16565 Not for victory@*
16566 but for the day's work done@*
16567 as well as I was able;@*
16568 not for a seat upon the dais@*
16569 but at the common table.@*
16570 @end quotation
16571
16572
16573 @node Appendices
16574 @chapter Appendices
16575
16576 @menu
16577 * History::                        How Gnus got where it is today.
16578 * Terminology::                    We use really difficult, like, words here.
16579 * Customization::                  Tailoring Gnus to your needs.
16580 * Troubleshooting::                What you might try if things do not work.
16581 * Gnus Reference Guide::           Rilly, rilly technical stuff.
16582 * Emacs for Heathens::             A short introduction to Emacsian terms.
16583 * Frequently Asked Questions::     A question-and-answer session.
16584 @end menu
16585
16586
16587 @node History
16588 @section History
16589
16590 @cindex history
16591 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
16592 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16593
16594 If you want to investigate the person responsible for this outrage, you
16595 can point your (feh!) web browser to
16596 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
16597 distribution point for the new and spiffy versions of Gnus, and is known
16598 as The Site That Destroys Newsrcs And Drives People Mad.
16599
16600 During the first extended alpha period of development, the new Gnus was
16601 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
16602 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16603 (Besides, the ``Gnus'' in this abbreviation should probably be
16604 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16605 appropriate name, don't you think?)
16606
16607 In any case, after spending all that energy on coming up with a new and
16608 spunky name, we decided that the name was @emph{too} spunky, so we
16609 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
16610 ``@sc{gnus}''.  New vs. old.
16611
16612 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16613 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16614 plus 15 Gnus 5.0 releases).
16615
16616 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16617 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16618
16619 On July 28th 1996 work on Red Gnus was begun, and it was released on
16620 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16621
16622 On September 13th 1997, Quassia Gnus was started and lasted 37
16623 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
16624
16625 If you happen upon a version of Gnus that has a prefixed name --
16626 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16627 don't panic.  Don't let it know that you're frightened.  Back away.
16628 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
16629 out of its reach.  Find a proper released version of Gnus and snuggle up
16630 to that instead.
16631
16632 @menu
16633 * Why?::                What's the point of Gnus?
16634 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
16635 * Conformity::          Gnus tries to conform to all standards.
16636 * Emacsen::             Gnus can be run on a few modern Emacsen.
16637 * Gnus Development::    How Gnus is developed.
16638 * Contributors::        Oodles of people.
16639 * New Features::        Pointers to some of the new stuff in Gnus.
16640 * Newest Features::     Features so new that they haven't been written yet.
16641 @end menu
16642
16643
16644 @node Why?
16645 @subsection Why?
16646
16647 What's the point of Gnus?
16648
16649 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16650 newsreader, that lets you do anything you can think of.  That was my
16651 original motivation, but while working on Gnus, it has become clear to
16652 me that this generation of newsreaders really belong in the stone age.
16653 Newsreaders haven't developed much since the infancy of the net.  If the
16654 volume continues to rise with the current rate of increase, all current
16655 newsreaders will be pretty much useless.  How do you deal with
16656 newsgroups that have thousands of new articles each day?  How do you
16657 keep track of millions of people who post?
16658
16659 Gnus offers no real solutions to these questions, but I would very much
16660 like to see Gnus being used as a testing ground for new methods of
16661 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
16662 to separate the newsreader from the backends, Gnus now offers a simple
16663 interface for anybody who wants to write new backends for fetching mail
16664 and news from different sources.  I have added hooks for customizations
16665 everywhere I could imagine it being useful.  By doing so, I'm inviting
16666 every one of you to explore and invent.
16667
16668 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16669 @kbd{C-u 100 M-x all-hail-xemacs}.
16670
16671
16672 @node Compatibility
16673 @subsection Compatibility
16674
16675 @cindex compatibility
16676 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
16677 bindings have been kept.  More key bindings have been added, of course,
16678 but only in one or two obscure cases have old bindings been changed.
16679
16680 Our motto is:
16681 @quotation
16682 @cartouche
16683 @center In a cloud bones of steel.
16684 @end cartouche
16685 @end quotation
16686
16687 All commands have kept their names.  Some internal functions have changed
16688 their names.
16689
16690 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16691 Articles}.
16692
16693 One major compatibility question is the presence of several summary
16694 buffers.  All variables relevant while reading a group are
16695 buffer-local to the summary buffer they belong in.  Although many
16696 important variables have their values copied into their global
16697 counterparts whenever a command is executed in the summary buffer, this
16698 change might lead to incorrect values being used unless you are careful.
16699
16700 All code that relies on knowledge of @sc{gnus} internals will probably
16701 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
16702 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
16703 maintains a hash table that points to the entries in this alist (which
16704 speeds up many functions), and changing the alist directly will lead to
16705 peculiar results.
16706
16707 @cindex hilit19
16708 @cindex highlighting
16709 Old hilit19 code does not work at all.  In fact, you should probably
16710 remove all hilit code from all Gnus hooks
16711 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16712 Gnus provides various integrated functions for highlighting.  These are
16713 faster and more accurate.  To make life easier for everybody, Gnus will
16714 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
16715 Away!
16716
16717 Packages like @code{expire-kill} will no longer work.  As a matter of
16718 fact, you should probably remove all old @sc{gnus} packages (and other
16719 code) when you start using Gnus.  More likely than not, Gnus already
16720 does what you have written code to make @sc{gnus} do.  (Snicker.)
16721
16722 Even though old methods of doing things are still supported, only the
16723 new methods are documented in this manual.  If you detect a new method of
16724 doing something while reading this manual, that does not mean you have
16725 to stop doing it the old way.
16726
16727 Gnus understands all @sc{gnus} startup files.
16728
16729 @kindex M-x gnus-bug
16730 @findex gnus-bug
16731 @cindex reporting bugs
16732 @cindex bugs
16733 Overall, a casual user who hasn't written much code that depends on
16734 @sc{gnus} internals should suffer no problems.  If problems occur,
16735 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16736
16737 @vindex gnus-bug-create-help-buffer
16738 If you are in the habit of sending bug reports @emph{very} often, you
16739 may find the helpful help buffer annoying after a while.  If so, set
16740 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16741 up at you.
16742
16743
16744 @node Conformity
16745 @subsection Conformity
16746
16747 No rebels without a clue here, ma'am.  We conform to all standards known
16748 to (wo)man.  Except for those standards and/or conventions we disagree
16749 with, of course.
16750
16751 @table @strong
16752
16753 @item RFC 822
16754 @cindex RFC 822
16755 There are no known breaches of this standard.
16756
16757 @item RFC 1036
16758 @cindex RFC 1036
16759 There are no known breaches of this standard, either.
16760
16761 @item Son-of-RFC 1036
16762 @cindex Son-of-RFC 1036
16763 We do have some breaches to this one.
16764
16765 @table @emph
16766
16767 @item X-Newsreader
16768 @itemx User-Agent
16769 These are considered to be ``vanity headers'', while I consider them
16770 to be consumer information.  After seeing so many badly formatted
16771 articles coming from @code{tin} and @code{Netscape} I know not to use
16772 either of those for posting articles.  I would not have known that if
16773 it wasn't for the @code{X-Newsreader} header.
16774 @end table
16775
16776 @item USEFOR
16777 @cindex USEFOR
16778 USEFOR is an IETF working group writing a successor to RFC 1036, based
16779 on Son-of-RFC 1036.  They have produced a number of drafts proposing
16780 various changes to the format of news articles.  The Gnus towers will
16781 look into implementing the changes when the draft is accepted as an RFC.
16782
16783 @end table
16784
16785 If you ever notice Gnus acting non-compliant with regards to the texts
16786 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16787 know.
16788
16789
16790 @node Emacsen
16791 @subsection Emacsen
16792 @cindex Emacsen
16793 @cindex XEmacs
16794 @cindex Mule
16795 @cindex Emacs
16796
16797 Gnus should work on :
16798
16799 @itemize @bullet
16800
16801 @item
16802 Emacs 20.3 and up.
16803
16804 @item
16805 XEmacs 20.4 and up.
16806
16807 @end itemize
16808
16809 This Gnus version will absolutely not work on any Emacsen older than
16810 that.  Not reliably, at least.  Older versions of Gnus may work on older
16811 Emacs versions.
16812
16813 There are some vague differences between Gnus on the various
16814 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16815 other than that, things should look pretty much the same under all
16816 Emacsen.
16817
16818
16819 @node Gnus Development
16820 @subsection Gnus Development
16821
16822 Gnus is developed in a two-phased cycle.  The first phase involves much
16823 discussion on the @samp{ding@@gnus.org} mailing list, where people
16824 propose changes and new features, post patches and new backends.  This
16825 phase is called the @dfn{alpha} phase, since the Gnusae released in this
16826 phase are @dfn{alpha releases}, or (perhaps more commonly in other
16827 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
16828 unstable and should not be used by casual users.  Gnus alpha releases
16829 have names like ``Red Gnus'' and ``Quassia Gnus''.
16830
16831 After futzing around for 50-100 alpha releases, Gnus is declared
16832 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
16833 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
16834 supposed to be able to use these, and these are mostly discussed on the
16835 @samp{gnu.emacs.gnus} newsgroup.
16836
16837 @cindex Incoming*
16838 @vindex nnmail-delete-incoming
16839 Some variable defaults differ between alpha Gnusae and released Gnusae.
16840 In particular, @code{nnmail-delete-incoming} defaults to @code{nil} in
16841 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
16842 lossage of mail if an alpha release hiccups while handling the mail.
16843
16844 The division of discussion between the ding mailing list and the Gnus
16845 newsgroup is not purely based on publicity concerns.  It's true that
16846 having people write about the horrible things that an alpha Gnus release
16847 can do (sometimes) in a public forum may scare people off, but more
16848 importantly, talking about new experimental features that have been
16849 introduced may confuse casual users.  New features are frequently
16850 introduced, fiddled with, and judged to be found wanting, and then
16851 either discarded or totally rewritten.  People reading the mailing list
16852 usually keep up with these rapid changes, whille people on the newsgroup
16853 can't be assumed to do so.
16854
16855
16856
16857 @node Contributors
16858 @subsection Contributors
16859 @cindex contributors
16860
16861 The new Gnus version couldn't have been done without the help of all the
16862 people on the (ding) mailing list.  Every day for over a year I have
16863 gotten billions of nice bug reports from them, filling me with joy,
16864 every single one of them.  Smooches.  The people on the list have been
16865 tried beyond endurance, what with my ``oh, that's a neat idea <type
16866 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16867 work at all <type type>, yup, I'll ship that one off right away <ship
16868 off> no, wait, that absolutely does not work'' policy for releases.
16869 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
16870 ``worser''? ``much worser''?  ``worsest''?)
16871
16872 I would like to take this opportunity to thank the Academy for...  oops,
16873 wrong show.
16874
16875 @itemize @bullet
16876
16877 @item
16878 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16879
16880 @item
16881 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16882 well as numerous other things).
16883
16884 @item
16885 Luis Fernandes---design and graphics.
16886
16887 @item
16888 Erik Naggum---help, ideas, support, code and stuff.
16889
16890 @item
16891 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
16892 connected with @sc{mime} and other types of en/decoding.
16893
16894 @item
16895 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16896 @dfn{picons} (@pxref{Picons}).
16897
16898 @item
16899 Kim-Minh Kaplan---further work on the picon code.
16900
16901 @item
16902 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16903 (@pxref{GroupLens}).
16904
16905 @item
16906 Sudish Joseph---innumerable bug fixes.
16907
16908 @item
16909 Ilja Weis---@file{gnus-topic.el}.
16910
16911 @item
16912 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16913
16914 @item
16915 Vladimir Alexiev---the refcard and reference booklets.
16916
16917 @item
16918 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16919 distribution by Felix Lee and JWZ.
16920
16921 @item
16922 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16923
16924 @item
16925 Peter Mutsaers---orphan article scoring code.
16926
16927 @item
16928 Ken Raeburn---POP mail support.
16929
16930 @item
16931 Hallvard B Furuseth---various bits and pieces, especially dealing with
16932 .newsrc files.
16933
16934 @item
16935 Brian Edmonds---@file{gnus-bbdb.el}.
16936
16937 @item
16938 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16939
16940 @item
16941 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16942
16943 @item
16944 François Pinard---many, many interesting and thorough bug reports, as
16945 well as autoconf support.
16946
16947 @end itemize
16948
16949 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16950 Borges, and Jost Krieger proof-reading parts of the manual.
16951
16952 The following people have contributed many patches and suggestions:
16953
16954 Christopher Davis,
16955 Andrew Eskilsson,
16956 Kai Grossjohann,
16957 David KÃ¥gedal,
16958 Richard Pieri,
16959 Fabrice Popineau,
16960 Daniel Quinlan,
16961 Jason L. Tibbitts, III,
16962 and
16963 Jack Vinson.
16964
16965 Also thanks to the following for patches and stuff:
16966
16967 Jari Aalto,
16968 Adrian Aichner,
16969 Vladimir Alexiev,
16970 Russ Allbery,
16971 Peter Arius,
16972 Matt Armstrong,
16973 Marc Auslander,
16974 Miles Bader,
16975 Frank Bennett,
16976 Robert Bihlmeyer,
16977 Chris Bone,
16978 Mark Borges,
16979 Mark Boyns,
16980 Lance A. Brown,
16981 Kees de Bruin,
16982 Martin Buchholz,
16983 Joe Buehler,
16984 Kevin Buhr,
16985 Alastair Burt,
16986 Joao Cachopo,
16987 Zlatko Calusic,
16988 Massimo Campostrini,
16989 Castor,
16990 David Charlap,
16991 Dan Christensen,
16992 Kevin Christian,
16993 Michael R. Cook,
16994 Glenn Coombs,
16995 Frank D. Cringle,
16996 Geoffrey T. Dairiki,
16997 Andre Deparade,
16998 Ulrik Dickow,
16999 Dave Disser,
17000 Rui-Tao Dong, @c ?
17001 Joev Dubach,
17002 Michael Welsh Duggan,
17003 Dave Edmondson,
17004 Paul Eggert,
17005 Karl Eichwalder,
17006 Enami Tsugutomo, @c Enami
17007 Michael Ernst,
17008 Luc Van Eycken,
17009 Sam Falkner,
17010 Nelson Jose dos Santos Ferreira,
17011 Sigbjorn Finne,
17012 Paul Fisher,
17013 Decklin Foster,
17014 Gary D. Foster,
17015 Paul Franklin,
17016 Guy Geens,
17017 Arne Georg Gleditsch,
17018 David S. Goldberg,
17019 Michelangelo Grigni,
17020 Dale Hagglund,
17021 D. Hall,
17022 Magnus Hammerin,
17023 Kenichi Handa, @c Handa
17024 Raja R. Harinath,
17025 Yoshiki Hayashi, @c ?
17026 P. E. Jareth Hein,
17027 Hisashige Kenji, @c Hisashige
17028 Marc Horowitz,
17029 Gunnar Horrigmo,
17030 Richard Hoskins,
17031 Brad Howes,
17032 François Felix Ingrand,
17033 Ishikawa Ichiro, @c Ishikawa
17034 Lee Iverson,
17035 Iwamuro Motonori, @c Iwamuro
17036 Rajappa Iyer,
17037 Andreas Jaeger,
17038 Randell Jesup,
17039 Fred Johansen,
17040 Gareth Jones,
17041 Simon Josefsson,
17042 Greg Klanderman,
17043 Karl Kleinpaste,
17044 Peter Skov Knudsen,
17045 Shuhei Kobayashi, @c Kobayashi
17046 Koseki Yoshinori, @c Koseki
17047 Thor Kristoffersen,
17048 Jens Lautenbacher,
17049 Martin Larose,
17050 Seokchan Lee, @c Lee
17051 Joerg Lenneis,
17052 Carsten Leonhardt,
17053 James LewisMoss,
17054 Christian Limpach,
17055 Markus Linnala,
17056 Dave Love,
17057 Mike McEwan,
17058 Tonny Madsen,
17059 Shlomo Mahlab,
17060 Nat Makarevitch,
17061 Istvan Marko,
17062 David Martin,
17063 Jason R. Mastaler,
17064 Gordon Matzigkeit,
17065 Timo Metzemakers,
17066 Richard Mlynarik,
17067 Lantz Moore,
17068 Morioka Tomohiko, @c Morioka
17069 Erik Toubro Nielsen,
17070 Hrvoje Niksic,
17071 Andy Norman,
17072 Fred Oberhauser,
17073 C. R. Oldham,
17074 Alexandre Oliva,
17075 Ken Olstad,
17076 Masaharu Onishi, @c Onishi
17077 Hideki Ono, @c Ono
17078 William Perry,
17079 Stephen Peters,
17080 Jens-Ulrik Holger Petersen,
17081 Ulrich Pfeifer,
17082 Matt Pharr,
17083 Andy Piper,
17084 John McClary Prevost,
17085 Bill Pringlemeir,
17086 Mike Pullen,
17087 Jim Radford,
17088 Colin Rafferty,
17089 Lasse Rasinen,
17090 Lars Balker Rasmussen,
17091 Joe Reiss,
17092 Renaud Rioboo,
17093 Roland B. Roberts,
17094 Bart Robinson,
17095 Christian von Roques,
17096 Markus Rost,
17097 Jason Rumney,
17098 Wolfgang Rupprecht,
17099 Jay Sachs,
17100 Dewey M. Sasser,
17101 Conrad Sauerwald,
17102 Loren Schall,
17103 Dan Schmidt,
17104 Ralph Schleicher,
17105 Philippe Schnoebelen,
17106 Andreas Schwab,
17107 Randal L. Schwartz,
17108 Justin Sheehy,
17109 Danny Siu,
17110 Matt Simmons,
17111 Paul D. Smith,
17112 Jeff Sparkes,
17113 Toby Speight,
17114 Michael Sperber,
17115 Darren Stalder,
17116 Richard Stallman,
17117 Greg Stark,
17118 Sam Steingold,
17119 Jonas Steverud,
17120 Paul Stodghill,
17121 Kurt Swanson,
17122 Samuel Tardieu,
17123 Teddy,
17124 Chuck Thompson,
17125 Philippe Troin,
17126 James Troup,
17127 Trung Tran-Duc,
17128 Aaron M. Ucko,
17129 Aki Vehtari,
17130 Didier Verna,
17131 Jan Vroonhof,
17132 Stefan Waldherr,
17133 Pete Ware,
17134 Barry A. Warsaw,
17135 Christoph Wedler,
17136 Joe Wells,
17137 Lee Willis,
17138 Katsumi Yamaoka @c Yamaoka
17139 and
17140 Lloyd Zusman.
17141
17142
17143 For a full overview of what each person has done, the ChangeLogs
17144 included in the Gnus alpha distributions should give ample reading
17145 (550kB and counting).
17146
17147 Apologies to everybody that I've forgotten, of which there are many, I'm
17148 sure.
17149
17150 Gee, that's quite a list of people.  I guess that must mean that there
17151 actually are people who are using Gnus.  Who'd'a thunk it!
17152
17153
17154 @node New Features
17155 @subsection New Features
17156 @cindex new features
17157
17158 @menu
17159 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
17160 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
17161 * Red Gnus::           Third time best---Gnus 5.4/5.5.
17162 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
17163 @end menu
17164
17165 These lists are, of course, just @emph{short} overviews of the
17166 @emph{most} important new features.  No, really.  There are tons more.
17167 Yes, we have feeping creaturism in full effect.
17168
17169
17170 @node ding Gnus
17171 @subsubsection (ding) Gnus
17172
17173 New features in Gnus 5.0/5.1:
17174
17175 @itemize @bullet
17176
17177 @item
17178 The look of all buffers can be changed by setting format-like variables
17179 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
17180
17181 @item
17182 Local spool and several @sc{nntp} servers can be used at once
17183 (@pxref{Select Methods}).
17184
17185 @item
17186 You can combine groups into virtual groups (@pxref{Virtual Groups}).
17187
17188 @item
17189 You can read a number of different mail formats (@pxref{Getting Mail}).
17190 All the mail backends implement a convenient mail expiry scheme
17191 (@pxref{Expiring Mail}).
17192
17193 @item
17194 Gnus can use various strategies for gathering threads that have lost
17195 their roots (thereby gathering loose sub-threads into one thread) or it
17196 can go back and retrieve enough headers to build a complete thread
17197 (@pxref{Customizing Threading}).
17198
17199 @item
17200 Killed groups can be displayed in the group buffer, and you can read
17201 them as well (@pxref{Listing Groups}).
17202
17203 @item
17204 Gnus can do partial group updates---you do not have to retrieve the
17205 entire active file just to check for new articles in a few groups
17206 (@pxref{The Active File}).
17207
17208 @item
17209 Gnus implements a sliding scale of subscribedness to groups
17210 (@pxref{Group Levels}).
17211
17212 @item
17213 You can score articles according to any number of criteria
17214 (@pxref{Scoring}).  You can even get Gnus to find out how to score
17215 articles for you (@pxref{Adaptive Scoring}).
17216
17217 @item
17218 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
17219 manner, so it should be difficult to lose much data on what you have
17220 read if your machine should go down (@pxref{Auto Save}).
17221
17222 @item
17223 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
17224 the @file{.emacs} file.
17225
17226 @item
17227 You can set the process mark on both groups and articles and perform
17228 operations on all the marked items (@pxref{Process/Prefix}).
17229
17230 @item
17231 You can grep through a subset of groups and create a group from the
17232 results (@pxref{Kibozed Groups}).
17233
17234 @item
17235 You can list subsets of groups according to, well, anything
17236 (@pxref{Listing Groups}).
17237
17238 @item
17239 You can browse foreign servers and subscribe to groups from those
17240 servers (@pxref{Browse Foreign Server}).
17241
17242 @item
17243 Gnus can fetch articles, asynchronously, on a second connection to the
17244 server (@pxref{Asynchronous Fetching}).
17245
17246 @item
17247 You can cache articles locally (@pxref{Article Caching}).
17248
17249 @item
17250 The uudecode functions have been expanded and generalized
17251 (@pxref{Decoding Articles}).
17252
17253 @item
17254 You can still post uuencoded articles, which was a little-known feature
17255 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
17256
17257 @item
17258 Fetching parents (and other articles) now actually works without
17259 glitches (@pxref{Finding the Parent}).
17260
17261 @item
17262 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
17263
17264 @item
17265 Digests (and other files) can be used as the basis for groups
17266 (@pxref{Document Groups}).
17267
17268 @item
17269 Articles can be highlighted and customized (@pxref{Customizing
17270 Articles}).
17271
17272 @item
17273 URLs and other external references can be buttonized (@pxref{Article
17274 Buttons}).
17275
17276 @item
17277 You can do lots of strange stuff with the Gnus window & frame
17278 configuration (@pxref{Windows Configuration}).
17279
17280 @item
17281 You can click on buttons instead of using the keyboard
17282 (@pxref{Buttons}).
17283
17284 @end itemize
17285
17286
17287 @node September Gnus
17288 @subsubsection September Gnus
17289
17290 @iftex
17291 @iflatex
17292 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
17293 @end iflatex
17294 @end iftex
17295
17296 New features in Gnus 5.2/5.3:
17297
17298 @itemize @bullet
17299
17300 @item
17301 A new message composition mode is used.  All old customization variables
17302 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
17303 now obsolete.
17304
17305 @item
17306 Gnus is now able to generate @dfn{sparse} threads---threads where
17307 missing articles are represented by empty nodes (@pxref{Customizing
17308 Threading}).
17309
17310 @lisp
17311 (setq gnus-build-sparse-threads 'some)
17312 @end lisp
17313
17314 @item
17315 Outgoing articles are stored on a special archive server
17316 (@pxref{Archived Messages}).
17317
17318 @item
17319 Partial thread regeneration now happens when articles are
17320 referred.
17321
17322 @item
17323 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
17324
17325 @item
17326 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
17327
17328 @item
17329 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
17330
17331 @lisp
17332 (setq gnus-use-trees t)
17333 @end lisp
17334
17335 @item
17336 An @code{nn}-like pick-and-read minor mode is available for the summary
17337 buffers (@pxref{Pick and Read}).
17338
17339 @lisp
17340 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
17341 @end lisp
17342
17343 @item
17344 In binary groups you can use a special binary minor mode (@pxref{Binary
17345 Groups}).
17346
17347 @item
17348 Groups can be grouped in a folding topic hierarchy (@pxref{Group
17349 Topics}).
17350
17351 @lisp
17352 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
17353 @end lisp
17354
17355 @item
17356 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
17357
17358 @item
17359 Groups can now have a score, and bubbling based on entry frequency
17360 is possible (@pxref{Group Score}).
17361
17362 @lisp
17363 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
17364 @end lisp
17365
17366 @item
17367 Groups can be process-marked, and commands can be performed on
17368 groups of groups (@pxref{Marking Groups}).
17369
17370 @item
17371 Caching is possible in virtual groups.
17372
17373 @item
17374 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
17375 news batches, ClariNet briefs collections, and just about everything
17376 else (@pxref{Document Groups}).
17377
17378 @item
17379 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
17380 (@pxref{SOUP}).
17381
17382 @item
17383 The Gnus cache is much faster.
17384
17385 @item
17386 Groups can be sorted according to many criteria (@pxref{Sorting
17387 Groups}).
17388
17389 @item
17390 New group parameters have been introduced to set list-addresses and
17391 expiry times (@pxref{Group Parameters}).
17392
17393 @item
17394 All formatting specs allow specifying faces to be used
17395 (@pxref{Formatting Fonts}).
17396
17397 @item
17398 There are several more commands for setting/removing/acting on process
17399 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
17400
17401 @item
17402 The summary buffer can be limited to show parts of the available
17403 articles based on a wide range of criteria.  These commands have been
17404 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
17405
17406 @item
17407 Articles can be made persistent with the @kbd{*} command
17408 (@pxref{Persistent Articles}).
17409
17410 @item
17411 All functions for hiding article elements are now toggles.
17412
17413 @item
17414 Article headers can be buttonized (@pxref{Article Washing}).
17415
17416 @item
17417 All mail backends support fetching articles by @code{Message-ID}.
17418
17419 @item
17420 Duplicate mail can now be treated properly (@pxref{Duplicates}).
17421
17422 @item
17423 All summary mode commands are available directly from the article
17424 buffer (@pxref{Article Keymap}).
17425
17426 @item
17427 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
17428 Configuration}).
17429
17430 @item
17431 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
17432 @iftex
17433 @iflatex
17434 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
17435 @end iflatex
17436 @end iftex
17437
17438 @item
17439 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
17440
17441 @lisp
17442 (setq gnus-use-nocem t)
17443 @end lisp
17444
17445 @item
17446 Groups can be made permanently visible (@pxref{Listing Groups}).
17447
17448 @lisp
17449 (setq gnus-permanently-visible-groups "^nnml:")
17450 @end lisp
17451
17452 @item
17453 Many new hooks have been introduced to make customizing easier.
17454
17455 @item
17456 Gnus respects the @code{Mail-Copies-To} header.
17457
17458 @item
17459 Threads can be gathered by looking at the @code{References} header
17460 (@pxref{Customizing Threading}).
17461
17462 @lisp
17463 (setq gnus-summary-thread-gathering-function
17464       'gnus-gather-threads-by-references)
17465 @end lisp
17466
17467 @item
17468 Read articles can be stored in a special backlog buffer to avoid
17469 refetching (@pxref{Article Backlog}).
17470
17471 @lisp
17472 (setq gnus-keep-backlog 50)
17473 @end lisp
17474
17475 @item
17476 A clean copy of the current article is always stored in a separate
17477 buffer to allow easier treatment.
17478
17479 @item
17480 Gnus can suggest where to save articles (@pxref{Saving Articles}).
17481
17482 @item
17483 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
17484 Articles}).
17485
17486 @lisp
17487 (setq gnus-prompt-before-saving t)
17488 @end lisp
17489
17490 @item
17491 @code{gnus-uu} can view decoded files asynchronously while fetching
17492 articles (@pxref{Other Decode Variables}).
17493
17494 @lisp
17495 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
17496 @end lisp
17497
17498 @item
17499 Filling in the article buffer now works properly on cited text
17500 (@pxref{Article Washing}).
17501
17502 @item
17503 Hiding cited text adds buttons to toggle hiding, and how much
17504 cited text to hide is now customizable (@pxref{Article Hiding}).
17505
17506 @lisp
17507 (setq gnus-cited-lines-visible 2)
17508 @end lisp
17509
17510 @item
17511 Boring headers can be hidden (@pxref{Article Hiding}).
17512
17513 @item
17514 Default scoring values can now be set from the menu bar.
17515
17516 @item
17517 Further syntax checking of outgoing articles have been added.
17518
17519 @end itemize
17520
17521
17522 @node Red Gnus
17523 @subsubsection Red Gnus
17524
17525 New features in Gnus 5.4/5.5:
17526
17527 @iftex
17528 @iflatex
17529 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
17530 @end iflatex
17531 @end iftex
17532
17533 @itemize @bullet
17534
17535 @item
17536 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
17537
17538 @item
17539 Article prefetching functionality has been moved up into
17540 Gnus (@pxref{Asynchronous Fetching}).
17541
17542 @item
17543 Scoring can now be performed with logical operators like @code{and},
17544 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
17545 Scoring}).
17546
17547 @item
17548 Article washing status can be displayed in the
17549 article mode line (@pxref{Misc Article}).
17550
17551 @item
17552 @file{gnus.el} has been split into many smaller files.
17553
17554 @item
17555 Suppression of duplicate articles based on Message-ID can be done
17556 (@pxref{Duplicate Suppression}).
17557
17558 @lisp
17559 (setq gnus-suppress-duplicates t)
17560 @end lisp
17561
17562 @item
17563 New variables for specifying what score and adapt files are to be
17564 considered home score and adapt files (@pxref{Home Score File}) have
17565 been added.
17566
17567 @item
17568 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17569 Server Internals}).
17570
17571 @item
17572 Groups can inherit group parameters from parent topics (@pxref{Topic
17573 Parameters}).
17574
17575 @item
17576 Article editing has been revamped and is now actually usable.
17577
17578 @item
17579 Signatures can be recognized in more intelligent fashions
17580 (@pxref{Article Signature}).
17581
17582 @item
17583 Summary pick mode has been made to look more @code{nn}-like.  Line
17584 numbers are displayed and the @kbd{.} command can be used to pick
17585 articles (@code{Pick and Read}).
17586
17587 @item
17588 Commands for moving the @file{.newsrc.eld} from one server to
17589 another have been added (@pxref{Changing Servers}).
17590
17591 @item
17592 There's a way now to specify that ``uninteresting'' fields be suppressed
17593 when generating lines in buffers (@pxref{Advanced Formatting}).
17594
17595 @item
17596 Several commands in the group buffer can be undone with @kbd{M-C-_}
17597 (@pxref{Undo}).
17598
17599 @item
17600 Scoring can be done on words using the new score type @code{w}
17601 (@pxref{Score File Format}).
17602
17603 @item
17604 Adaptive scoring can be done on a Subject word-by-word basis
17605 (@pxref{Adaptive Scoring}).
17606
17607 @lisp
17608 (setq gnus-use-adaptive-scoring '(word))
17609 @end lisp
17610
17611 @item
17612 Scores can be decayed (@pxref{Score Decays}).
17613
17614 @lisp
17615 (setq gnus-decay-scores t)
17616 @end lisp
17617
17618 @item
17619 Scoring can be performed using a regexp on the Date header.  The Date is
17620 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17621
17622 @item
17623 A new command has been added to remove all data on articles from
17624 the native server (@pxref{Changing Servers}).
17625
17626 @item
17627 A new command for reading collections of documents
17628 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17629 (@pxref{Really Various Summary Commands}).
17630
17631 @item
17632 Process mark sets can be pushed and popped (@pxref{Setting Process
17633 Marks}).
17634
17635 @item
17636 A new mail-to-news backend makes it possible to post even when the NNTP
17637 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17638
17639 @item
17640 A new backend for reading searches from Web search engines
17641 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17642 (@pxref{Web Searches}).
17643
17644 @item
17645 Groups inside topics can now be sorted using the standard sorting
17646 functions, and each topic can be sorted independently (@pxref{Topic
17647 Sorting}).
17648
17649 @item
17650 Subsets of the groups can be sorted independently (@code{Sorting
17651 Groups}).
17652
17653 @item
17654 Cached articles can be pulled into the groups (@pxref{Summary Generation
17655 Commands}).
17656 @iftex
17657 @iflatex
17658 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17659 @end iflatex
17660 @end iftex
17661
17662 @item
17663 Score files are now applied in a more reliable order (@pxref{Score
17664 Variables}).
17665
17666 @item
17667 Reports on where mail messages end up can be generated (@pxref{Splitting
17668 Mail}).
17669
17670 @item
17671 More hooks and functions have been added to remove junk from incoming
17672 mail before saving the mail (@pxref{Washing Mail}).
17673
17674 @item
17675 Emphasized text can be properly fontisized:
17676
17677 @end itemize
17678
17679
17680 @node Quassia Gnus
17681 @subsubsection Quassia Gnus
17682
17683 New features in Gnus 5.6:
17684
17685 @itemize @bullet
17686
17687 @item
17688 New functionality for using Gnus as an offline newsreader has been
17689 added.  A plethora of new commands and modes have been added.  See
17690 @pxref{Gnus Unplugged} for the full story.
17691
17692 @item
17693  The @code{nndraft} backend has returned, but works differently than
17694 before.  All Message buffers are now also articles in the @code{nndraft}
17695 group, which is created automatically.
17696
17697 @item
17698 @code{gnus-alter-header-function} can now be used to alter header
17699 values.
17700
17701 @item
17702  @code{gnus-summary-goto-article} now accept Message-ID's.
17703
17704 @item
17705  A new Message command for deleting text in the body of a message
17706 outside the region: @kbd{C-c C-v}.
17707
17708 @item
17709  You can now post to component group in @code{nnvirtual} groups with
17710 @kbd{C-u C-c C-c}.
17711
17712 @item
17713  @code{nntp-rlogin-program}---new variable to ease customization.
17714
17715 @item
17716  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17717 re-highlighting of the article buffer.
17718
17719 @item
17720  New element in @code{gnus-boring-article-headers}---@code{long-to}.
17721
17722 @item
17723  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
17724 Prefixes" in the Gnus manual for details.
17725
17726 @item
17727  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17728 @kbd{a} to add the score rule to the "all.SCORE" file.
17729
17730 @item
17731  @code{gnus-simplify-subject-functions} variable to allow greater
17732 control over simplification.
17733
17734 @item
17735  @kbd{A T}---new command for fetching the current thread.
17736
17737 @item
17738  @kbd{/ T}---new command for including the current thread in the
17739 limit.
17740
17741 @item
17742  @kbd{M-RET} is a new Message command for breaking cited text.
17743
17744 @item
17745  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17746
17747 @item
17748  The @code{custom-face-lookup} function has been removed.
17749 If you used this function in your initialization files, you must
17750 rewrite them to use @code{face-spec-set} instead.
17751
17752 @item
17753  Canceling now uses the current select method.  Symbolic prefix
17754 @kbd{a} forces normal posting method.
17755
17756 @item
17757  New command to translate M******** sm*rtq**t*s into proper
17758 text---@kbd{W d}.
17759
17760 @item
17761  For easier debugging of @code{nntp}, you can set
17762 @code{nntp-record-commands} to a non-@code{nil} value.
17763
17764 @item
17765  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17766 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17767
17768 @item
17769  A command for editing group parameters from the summary buffer
17770 has been added.
17771
17772 @item
17773  A history of where mails have been split is available.
17774
17775 @item
17776  A new article date command has been added---@code{article-date-iso8601}.
17777
17778 @item
17779  Subjects can be simplified when threading by setting
17780 @code{gnus-score-thread-simplify}.
17781
17782 @item
17783  A new function for citing in Message has been
17784 added---@code{message-cite-original-without-signature}.
17785
17786 @item
17787  @code{article-strip-all-blank-lines}---new article command.
17788
17789 @item
17790  A new Message command to kill to the end of the article has
17791 been added.
17792
17793 @item
17794  A minimum adaptive score can be specified by using the
17795 @code{gnus-adaptive-word-minimum} variable.
17796
17797 @item
17798  The "lapsed date" article header can be kept continually
17799 updated by the @code{gnus-start-date-timer} command.
17800
17801 @item
17802  Web listserv archives can be read with the @code{nnlistserv} backend.
17803
17804 @item
17805  Old dejanews archives can now be read by @code{nnweb}.
17806
17807 @end itemize
17808
17809
17810 @node Newest Features
17811 @subsection Newest Features
17812 @cindex todo
17813
17814 Also known as the @dfn{todo list}.  Sure to be implemented before the
17815 next millennium.
17816
17817 Be afraid.  Be very afraid.
17818
17819 (That a feature appears in this list doesn't necessarily mean that I've
17820 decided to actually implement it.  It just means that I think it sounds
17821 interesting.)
17822
17823 (Yes, this is the actual, up-to-the-second todo list.)
17824
17825 @itemize @bullet
17826
17827 @item
17828  I would like the zombie-page to contain an URL to the source of the
17829 latest version of gnus or some explanation on where to find it.
17830
17831 @item
17832  A way to continue editing the latest Message composition.
17833
17834 @item
17835  http://www.sonicnet.com/feature/ari3/
17836
17837 @item
17838  facep is not declared.
17839
17840 @item
17841  Include a section in the manual on why the number of articles
17842 isn't the same in the group buffer and on the SPC prompt.
17843
17844 @item
17845  Interacting with rmail fcc isn't easy.
17846
17847 @item
17848 @example
17849  Hypermail:
17850 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17851 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17852 <URL:http://homer.ncm.com/>
17853 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17854 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17855 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17856 http://www.miranova.com/gnus-list/
17857
17858 @end example
17859
17860 @item
17861 @samp{^-- } is made into - in LaTeX.
17862
17863 @item
17864  gnus-kill is much slower than it was in GNUS 4.1.3.
17865
17866 @item
17867  when expunging articles on low score, the sparse nodes keep hanging on?
17868 @item
17869  starting the first time seems to hang Gnus on some systems.  Does
17870 NEWGROUPS answer too fast?
17871 @item
17872  nndir doesn't read gzipped files.
17873 @item
17874  FAQ doesn't have an up node?
17875 @item
17876  when moving mail from a procmail spool to the crash-box,
17877 the crash-box is only appropriate to one specific group.
17878 @item
17879  `t' `t' makes X-Faces disappear.
17880 @item
17881  nnmh-be-safe means that crossposted articles will
17882 be marked as unread.
17883 @item
17884  Orphan score entries don't show on "V t" score trace
17885 @item
17886  when clearing out data, the cache data should also be reset.
17887 @item
17888  rewrite gnus-summary-limit-children to be non-recursive
17889 to avoid exceeding lisp nesting on huge groups.
17890 @item
17891  expunged articles are counted when computing scores.
17892 @item
17893  implement gnus-batch-brew-soup
17894 @item
17895  ticked articles aren't easy to read in pick mode -- `n' and
17896 stuff just skips past them.  Read articles are the same.
17897 @item
17898  topics that contain just groups with ticked
17899 articles aren't displayed.
17900 @item
17901  nndoc should always allocate unique Message-IDs.
17902 @item
17903  If there are mail groups the first time you use Gnus, Gnus'll
17904 make the mail groups killed.
17905 @item
17906  no "no news is good news" when using topics.
17907 @item
17908  when doing crosspost marking, the cache has to be consulted
17909 and articles have to be removed.
17910 @item
17911  nnweb should fetch complete articles when they are split into several
17912 parts.
17913 @item
17914  scoring on head immediate doesn't work.
17915 @item
17916  finding short score file names takes forever.
17917 @item
17918  canceling articles in foreign groups.
17919 @item
17920  nntp-open-rlogin no longer works.
17921 @item
17922  C-u C-x C-s (Summary) switches to the group buffer.
17923 @item
17924  move nnmail-split-history out to the backends.
17925 @item
17926  nnweb doesn't work properly.
17927 @item
17928  using a virtual server name as `gnus-select-method' doesn't work?
17929 @item
17930  when killing/yanking a group from one topic to another in a slave, the
17931 master will yank it first to one topic and then add it to another.
17932 Perhaps.
17933
17934 @item
17935  warn user about `=' redirection of a group in the active file?
17936 @item
17937  take over the XEmacs menubar and offer a toggle between the XEmacs
17938 bar and the Gnus bar.
17939 @item
17940 @example
17941  push active file and NOV file parsing down into C code.
17942 `(canonize-message-id id)'
17943 `(mail-parent-message-id references n)'
17944 `(parse-news-nov-line &optional dependency-hashtb)'
17945 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17946 `(parse-news-active-region beg end hashtb)'
17947
17948 @end example
17949
17950 @item
17951  nnml .overview directory with splits.
17952 @item
17953  asynchronous cache
17954 @item
17955  postponed commands.
17956 @item
17957  the selected article show have its Subject displayed in its summary line.
17958 @item
17959  when entering groups, get the real number of unread articles from
17960 the server?
17961 @item
17962  sort after gathering threads -- make false roots have the
17963 headers of the oldest orphan with a 0 article number?
17964 @item
17965  nndoc groups should inherit the score files of their parents?  Also
17966 inherit copy prompts and save files.
17967 @item
17968  command to start up Gnus (if not running) and enter a mail mode buffer.
17969 @item
17970  allow editing the group description from the group buffer
17971 for backends that support that.
17972 @item
17973 gnus-hide,show-all-topics
17974 @item
17975  groups and sub-topics should be allowed to mingle inside each topic,
17976 and not just list all subtopics at the end.
17977 @item
17978  a command to remove all read articles that are not needed to connect
17979 threads -- `gnus-summary-limit-to-sparse-unread'?
17980 @item
17981  a variable to turn off limiting/cutting of threads in the tree buffer.
17982 @item
17983  a variable to limit how many files are uudecoded.
17984 @item
17985  add zombie groups to a special "New Groups" topic.
17986 @item
17987  server mode command: close/open all connections
17988 @item
17989  put a file date in gnus-score-alist and check whether the file
17990 has been changed before using it.
17991 @item
17992  on exit from a digest group, go to the next article in the parent group.
17993 @item
17994  hide (sub)threads with low score.
17995 @item
17996  when expiring, remove all marks from expired articles.
17997 @item
17998  gnus-summary-limit-to-body
17999 @item
18000  a regexp alist that says what level groups are to be subscribed
18001 on.  Eg. -- `(("nnml:" . 1))'.
18002 @item
18003  easier interface to nnkiboze to create ephemeral groups that
18004 contain groups that match a regexp.
18005 @item
18006  allow newlines in <URL:> urls, but remove them before using
18007 the URL.
18008 @item
18009  If there is no From line, the mail backends should fudge one from the
18010 "From " line.
18011 @item
18012  fuzzy simplifying should strip all non-alpha-numerical info
18013 from subject lines.
18014 @item
18015  gnus-soup-brew-soup-with-high-scores.
18016 @item
18017  nntp-ping-before-connect
18018 @item
18019  command to check whether NOV is evil.  "list overview.fmt".
18020 @item
18021  when entering a group, Gnus should look through the score
18022 files very early for `local' atoms and set those local variables.
18023 @item
18024  message annotations.
18025 @item
18026  topics are always yanked before groups, and that's not good.
18027 @item
18028  (set-extent-property extent 'help-echo "String to display in minibuf")
18029 to display help in the minibuffer on buttons under XEmacs.
18030 @item
18031  allow group line format spec to say how many articles there
18032 are in the cache.
18033 @item
18034  AUTHINFO GENERIC
18035 @item
18036  `run-with-idle-timer' in gnus-demon.
18037 @item
18038  stop using invisible text properties and start using overlays instead
18039 @item
18040  C-c C-f C-e to add an Expires header.
18041 @item
18042  go from one group to the next; everything is expunged; go to the
18043 next group instead of going to the group buffer.
18044 @item
18045  gnus-renumber-cache -- to renumber the cache using "low" numbers.
18046 @item
18047  record topic changes in the dribble buffer.
18048 @item
18049  `nnfolder-generate-active-file' should look at the folders it
18050 finds and generate proper active ranges.
18051 @item
18052  nneething-look-in-files-for-article-heads variable to control
18053 whether nneething should sniff all files in the directories.
18054 @item
18055  gnus-fetch-article -- start Gnus, enter group, display article
18056 @item
18057  gnus-dont-move-articles-to-same-group variable when respooling.
18058 @item
18059  when messages are crossposted between several auto-expirable groups,
18060 articles aren't properly marked as expirable.
18061 @item
18062  nneething should allow deletion/moving.
18063 @item
18064  TAB on the last button should go to the first button.
18065 @item
18066  if the car of an element in `mail-split-methods' is a function,
18067 and the function returns non-nil, use that as the name of the group(s) to
18068 save mail in.
18069 @item
18070  command for listing all score files that have been applied.
18071 @item
18072  a command in the article buffer to return to `summary' config.
18073 @item
18074  `gnus-always-post-using-current-server' -- variable to override
18075 `C-c C-c' when posting.
18076 @item
18077  nnmail-group-spool-alist -- says where each group should use
18078 as a spool file.
18079 @item
18080  when an article is crossposted to an auto-expirable group, the article
18081 should be marker as expirable.
18082 @item
18083  article mode command/menu for "send region as URL to browser".
18084 @item
18085  on errors, jump to info nodes that explain the error.  For instance,
18086 on invalid From headers, or on error messages from the nntp server.
18087 @item
18088  when gathering threads, make the article that has no "Re: " the parent.
18089 Also consult Date headers.
18090 @item
18091  a token in splits to call shrink-window-if-larger-than-buffer
18092 @item
18093  `1 0 A M' to do matches on the active hashtb.
18094 @item
18095  duplicates -- command to remove Gnus-Warning header, use the read
18096 Message-ID, delete the "original".
18097 @item
18098  when replying to several messages at once, put the "other" message-ids
18099 into a See-Also header.
18100 @item
18101  support setext: URL:http://www.bsdi.com/setext/
18102 @item
18103  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
18104 @item
18105  when browsing a foreign server, the groups that are already subscribed
18106 should be listed as such and not as "K".
18107 @item
18108  generate font names dynamically.
18109 @item
18110  score file mode auto-alist.
18111 @item
18112  allow nndoc to change/add/delete things from documents.  Implement
18113 methods for each format for adding an article to the document.
18114 @item
18115  `gnus-fetch-old-headers' `all' value to incorporate
18116 absolutely all headers there is.
18117 @item
18118  function like `|', but concatenate all marked articles
18119 and pipe them to the process.
18120 @item
18121  cache the list of killed (or active) groups in a separate file.  Update
18122 the file whenever we read the active file or the list
18123 of killed groups in the .eld file reaches a certain length.
18124 @item
18125  function for starting to edit a file to put into
18126 the current mail group.
18127 @item
18128  score-find-trace should display the total score of the article.
18129 @item
18130  "ghettozie" -- score on Xref header and nix it out after using it
18131 to avoid marking as read in other groups it has been crossposted to.
18132 @item
18133  look at procmail splitting.  The backends should create
18134 the groups automatically if a spool file exists for that group.
18135 @item
18136  function for backends to register themselves with Gnus.
18137 @item
18138  when replying to several process-marked articles,
18139 have all the From end up in Cc headers?  Variable to toggle.
18140 @item
18141  command to delete a crossposted mail article from all
18142 groups it has been mailed to.
18143 @item
18144  `B c' and `B m' should be crosspost aware.
18145 @item
18146  hide-pgp should also hide PGP public key blocks.
18147 @item
18148  Command in the group buffer to respool process-marked groups.
18149 @item
18150  `gnus-summary-find-matching' should accept
18151 pseudo-"headers" like "body", "head" and "all"
18152 @item
18153  When buttifying <URL: > things, all white space (including
18154 newlines) should be ignored.
18155 @item
18156  Process-marking all groups in a topic should process-mark
18157 groups in subtopics as well.
18158 @item
18159  Add non-native groups to the list of killed groups when killing them.
18160 @item
18161  nntp-suggest-kewl-config to probe the nntp server and suggest
18162 variable settings.
18163 @item
18164  add edit and forward secondary marks.
18165 @item
18166  nnml shouldn't visit its .overview files.
18167 @item
18168  allow customizing sorting within gathered threads.
18169 @item
18170  `B q' shouldn't select the current article.
18171 @item
18172  nnmbox should support a newsgroups file for descriptions.
18173 @item
18174  allow fetching mail from several pop servers.
18175 @item
18176  Be able to specify whether the saving commands save the original
18177 or the formatted article.
18178 @item
18179  a command to reparent with the child process-marked (cf. `T ^'.).
18180 @item
18181  I think the possibility to send a password with nntp-open-rlogin
18182 should be a feature in Red Gnus.
18183 @item
18184  The `Z n' command should be possible to execute from a mouse click.
18185 @item
18186  more limiting functions -- date, etc.
18187 @item
18188  be able to limit on a random header; on body; using reverse matches.
18189 @item
18190  a group parameter (`absofucking-total-expiry') that will make Gnus expire
18191 even unread articles.
18192 @item
18193  a command to print the article buffer as postscript.
18194 @item
18195  variable to disable password fetching when opening by nntp-open-telnet.
18196 @item
18197  manual: more example servers -- nntp with rlogin, telnet
18198 @item
18199  checking for bogus groups should clean topic alists as well.
18200 @item
18201  canceling articles in foreign groups.
18202 @item
18203  article number in folded topics isn't properly updated by
18204 Xref handling.
18205 @item
18206  Movement in the group buffer to the next unread group should go to the
18207 next closed topic with unread messages if no group can be found.
18208 @item
18209  Extensive info pages generated on the fly with help everywhere --
18210 in the "*Gnus edit*" buffers, for instance.
18211 @item
18212  Topic movement commands -- like thread movement.  Up, down, forward, next.
18213 @item
18214  a way to tick/mark as read Gcc'd articles.
18215 @item
18216  a way to say that all groups within a specific topic comes
18217 from a particular server?  Hm.
18218 @item
18219  `gnus-article-fill-if-long-lines' -- a function to fill
18220 the article buffer if there are any looong lines there.
18221 @item
18222  `T h' should jump to the parent topic and fold it.
18223 @item
18224  a command to create an ephemeral nndoc group out of a file,
18225 and then splitting it/moving it to some other group/backend.
18226 @item
18227  a group parameter for nnkiboze groups that says that
18228 all kibozed articles should be entered into the cache.
18229 @item
18230  It should also probably be possible to delimit what
18231 `gnus-jog-cache' does -- for instance, work on just some groups, or on
18232 some levels, and entering just articles that have a score higher than
18233 a certain number.
18234 @item
18235  nnfolder should append to the folder instead of re-writing
18236 the entire folder to disk when accepting new messages.
18237 @item
18238  allow all backends to do the proper thing with .gz files.
18239 @item
18240  a backend for reading collections of babyl files nnbabylfolder?
18241 @item
18242  a command for making the native groups into foreign groups.
18243 @item
18244  server mode command for clearing read marks from all groups
18245 from a server.
18246 @item
18247  when following up multiple articles, include all To, Cc, etc headers
18248 from all articles.
18249 @item
18250  a command for deciding what the total score of the current
18251 thread is.  Also a way to highlight based on this.
18252 @item
18253  command to show and edit group scores
18254 @item
18255  a gnus-tree-minimize-horizontal to minimize tree buffers
18256 horizontally.
18257 @item
18258  command to generate nnml overview file for one group.
18259 @item
18260  `C-u C-u a' -- prompt for many crossposted groups.
18261 @item
18262  keep track of which mail groups have received new articles (in this session).
18263 Be able to generate a report and perhaps do some marking in the group
18264 buffer.
18265 @item
18266  gnus-build-sparse-threads to a number -- build only sparse threads
18267 that are of that length.
18268 @item
18269  have nnmh respect mh's unseen sequence in .mh_profile.
18270 @item
18271  cache the newsgroups descriptions locally.
18272 @item
18273  asynchronous posting under nntp.
18274 @item
18275  be able to control word adaptive scoring from the score files.
18276 @item
18277  a variable to make `C-c C-c' post using the "current" select method.
18278 @item
18279  `limit-exclude-low-scored-articles'.
18280 @item
18281  if `gnus-summary-show-thread' is a number, hide threads that have
18282 a score lower than this number.
18283 @item
18284  split newsgroup subscription variable up into "order" and "method".
18285 @item
18286  buttonize ange-ftp file names.
18287 @item
18288  a command to make a duplicate copy of the current article
18289 so that each copy can be edited separately.
18290 @item
18291  nnweb should allow fetching from the local nntp server.
18292 @item
18293  record the sorting done in the summary buffer so that
18294 it can be repeated when limiting/regenerating the buffer.
18295 @item
18296  nnml-generate-nov-databses should generate for
18297 all nnml servers.
18298 @item
18299  when the user does commands in the group buffer, check
18300 the modification time of the .newsrc.eld file and use
18301 ask-user-about-supersession-threat.  Also warn when trying
18302 to save .newsrc.eld and it has changed.
18303 @item
18304  M-g on a topic will display all groups with 0 articles in
18305 the topic.
18306 @item
18307  command to remove all topic stuff.
18308 @item
18309  allow exploding incoming digests when reading incoming mail
18310 and splitting the resulting digests.
18311 @item
18312  nnsoup shouldn't set the `message-' variables.
18313 @item
18314  command to nix out all nnoo state information.
18315 @item
18316  nnmail-process-alist that calls functions if group names
18317 matches an alist -- before saving.
18318 @item
18319  use buffer-invisibility-spec everywhere for hiding text.
18320 @item
18321  variable to activate each group before entering them
18322 to get the (new) number of articles.  `gnus-activate-before-entering'.
18323 @item
18324  command to fetch a Message-ID from any buffer, even
18325 starting Gnus first if necessary.
18326 @item
18327  when posting and checking whether a group exists or not, just
18328 ask the nntp server instead of relying on the active hashtb.
18329 @item
18330  buttonize the output of `C-c C-a' in an apropos-like way.
18331 @item
18332  `G p' should understand process/prefix, and allow editing
18333 of several groups at once.
18334 @item
18335  command to create an ephemeral nnvirtual group that
18336 matches some regexp(s).
18337 @item
18338  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
18339 @item
18340  it should be possible to score "thread" on the From header.
18341 @item
18342  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
18343 @item
18344  `B i' should display the article at once in the summary buffer.
18345 @item
18346  remove the "*" mark at once when unticking an article.
18347 @item
18348  `M-s' should highlight the matching text.
18349 @item
18350  when checking for duplicated mails, use Resent-Message-ID if present.
18351 @item
18352  killing and yanking groups in topics should be better.  If killing one copy
18353 of a group that exists in multiple topics, only that copy should
18354 be removed.  Yanking should insert the copy, and yanking topics
18355 should be possible to be interspersed with the other yankings.
18356 @item
18357  command for enter a group just to read the cached articles.  A way to say
18358 "ignore the nntp connection; just read from the cache."
18359 @item
18360  `X u' should decode base64 articles.
18361 @item
18362  a way to hide all "inner" cited text, leaving just the most
18363 recently cited text.
18364 @item
18365  nnvirtual should be asynchronous.
18366 @item
18367  after editing an article, gnus-original-article-buffer should
18368 be invalidated.
18369 @item
18370  there should probably be a way to make Gnus not connect to the
18371 server and just read the articles in the server
18372 @item
18373  allow a `set-default' (or something) to change the default
18374 value of nnoo variables.
18375 @item
18376  a command to import group infos from a .newsrc.eld file.
18377 @item
18378  groups from secondary servers have the entire select method
18379 listed in each group info.
18380 @item
18381  a command for just switching from the summary buffer to the group
18382 buffer.
18383 @item
18384  a way to specify that some incoming mail washing functions
18385 should only be applied to some groups.
18386 @item
18387  Message `C-f C-t' should ask the user whether to heed
18388 mail-copies-to: never.
18389 @item
18390  new group parameter -- `post-to-server' that says to post
18391 using the current server.  Also a variable to do the same.
18392 @item
18393  the slave dribble files should auto-save to the slave file names.
18394 @item
18395  a group parameter that says what articles to display on group entry, based
18396 on article marks.
18397 @item
18398  a way to visually distinguish slave Gnusae from masters.  (Whip instead
18399 of normal logo?)
18400 @item
18401  Use DJ Bernstein "From " quoting/dequoting, where applicable.
18402 @item
18403  Why is hide-citation-maybe and hide-citation different?  Also
18404 clear up info.
18405 @item
18406  group user-defined meta-parameters.
18407
18408
18409
18410 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
18411 @item
18412  I like the option for trying to retrieve the FAQ for a group and I was
18413 thinking it would be great if for those newsgroups that had archives
18414 you could also try to read the archive for that group.  Part of the
18415 problem is that archives are spread all over the net, unlike FAQs.
18416 What would be best I suppose is to find the one closest to your site.
18417
18418 In any case, there is a list of general news group archives at @*
18419 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
18420
18421
18422
18423
18424 @item
18425 @example
18426 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
18427 (add-hook 'gnus-select-group-hook
18428   (lambda ()
18429     (gnus-group-add-parameter group
18430        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
18431
18432 (defun gnus-user-format-function-d (headers)
18433   "Return the date the group was last read."
18434   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
18435       (t "")))
18436 @end example
18437
18438 @item
18439  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
18440 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
18441 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
18442 hatt forskjellige serveres startup-filer forskjellige steder.
18443
18444
18445 @item
18446 LMI> Well, nnbabyl could alter the group info to heed labels like
18447 LMI> answered and read, I guess.
18448
18449 It could also keep them updated (the same for the Status: header of
18450 unix mbox files).
18451
18452 They could be used like this:
18453
18454
18455 @example
18456 `M l <name> RET' add label <name> to current message.
18457 `M u <name> RET' remove label <name> from current message.
18458 `/ l <expr> RET' limit summary buffer according to <expr>.
18459
18460 <expr> would be a boolean expression on the labels, e.g.
18461
18462 `/ l bug & !fixed RET'
18463 @end example
18464
18465 would show all the messages which are labeled `bug' but not labeled
18466 `fixed'.
18467
18468 One could also imagine the labels being used for highlighting, or
18469 affect the summary line format.
18470
18471
18472 @item
18473 Sender: abraham@@dina.kvl.dk
18474
18475 I'd like a gnus-find-file which work like find file, except that it
18476 would recognize things that looks like messages or folders:
18477
18478 - If it is a directory containing numbered files, create an nndir
18479 summary buffer.
18480
18481 - For other directories, create a nneething summary buffer.
18482
18483 - For files matching "\\`From ", create a nndoc/mbox summary.
18484
18485 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
18486
18487 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
18488
18489 - For other files, just find them normally.
18490
18491 I'd like `nneething' to use this function, so it would work on a
18492 directory potentially containing mboxes or babyl files.
18493
18494 @item
18495 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
18496 tell him what you are doing.
18497
18498 @item
18499 Currently, I get prompted:
18500
18501 decend into sci?
18502 - type y
18503 decend into sci.something ?
18504 - type n
18505 decend into ucd?
18506
18507 The problem above is that since there is really only one subsection of
18508 science, shouldn't it prompt you for only descending sci.something?  If
18509 there was a sci.somethingelse group or section, then it should prompt
18510 for sci? first the sci.something? then sci.somethingelse?...
18511
18512 @item
18513 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
18514 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
18515 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
18516 "no.all.SCORE", osv.
18517
18518 @item
18519 What i want is for Gnus to treat any sequence or combination of the following
18520 as a single spoiler warning and hide it all, replacing it with a "Next Page"
18521 button:
18522
18523
18524 ^L's
18525
18526 more than n blank lines
18527
18528 more than m identical lines
18529 (which should be replaced with button to show them)
18530
18531 any whitespace surrounding any of the above
18532
18533
18534 @item
18535 Well, we could allow a new value to `gnus-thread-ignore-subject' --
18536 `spaces', or something.  (We could even default to that.)  And then
18537 subjects that differ in white space only could be considered the
18538 "same" subject for threading purposes.
18539
18540 @item
18541 Modes to preprocess the contents (e.g. jka-compr) use the second form
18542 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
18543 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
18544 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
18545
18546 @item
18547  Under XEmacs -- do funny article marks:
18548 tick - thumb tack
18549 killed - skull
18550 soup - bowl of soup
18551 score below - dim light bulb
18552 score over - bright light bulb
18553
18554 @item
18555 Yes. I think the algorithm is as follows:
18556
18557 @example
18558 Group-mode
18559
18560    show-list-of-articles-in-group
18561         if (key-pressed == SPACE)
18562                 if (no-more-articles-in-group-to-select)
18563                         if (articles-selected)
18564                                 start-reading-selected-articles;
18565                         junk-unread-articles;
18566                         next-group;
18567                  else
18568                         show-next-page;
18569
18570          else if (key-pressed = '.')
18571                 if (consolidated-menus)         # same as hide-thread in Gnus
18572                         select-thread-under-cursor;
18573                 else
18574                         select-article-under-cursor;
18575
18576
18577 Article-mode
18578         if (key-pressed == SPACE)
18579                 if (more-pages-in-article)
18580                         next-page;
18581                 else if (more-selected-articles-to-read)
18582                         next-article;
18583                 else
18584                         next-group;
18585 @end example
18586
18587 @item
18588 My precise need here would have been to limit files to Incoming*.
18589 One could think of some `nneething-only-files' variable, but I guess
18590 it would have been unacceptable if one was using many unrelated such
18591 nneething groups.
18592
18593 A more useful approach would be to, in response to the `G D' prompt, be
18594 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18595 the top-level directory only (in case directories would be matched by
18596 the wildcard expression).
18597
18598 @item
18599 It would be nice if it also handled
18600
18601         <URL:news://sunsite.auc.dk/>
18602
18603 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18604
18605
18606 @item
18607
18608   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18609 really well.  Each menu is 'named' by a symbol that would be on a
18610 gnus-*-menus (where * would be whatever, but at least group, summary, and
18611 article versions) variable.
18612
18613   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18614
18615   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18616 the main menubar.  This approach works really well for Emacs-W3 and VM.
18617
18618
18619 @item
18620  nndoc should take care to create unique Message-IDs for all its
18621 articles.
18622 @item
18623  gnus-score-followup-article only works when you have a summary buffer
18624 active.  Make it work when posting from the group buffer as well.
18625 (message-sent-hook).
18626 @item
18627  rewrite gnus-demon to use run-with-idle-timers.
18628
18629 @item
18630  * Enhancements to Gnus:
18631
18632   Add two commands:
18633
18634   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18635     straight to the server buffer, without opening any connections to
18636     servers first.
18637
18638   * gnus-server-read-server-newsrc--produces a buffer very similar to
18639     the group buffer, but with only groups from that server listed;
18640     quitting this buffer returns to the server buffer.
18641
18642 @item
18643  add a command to check the integrity of an nnfolder folder --
18644 go through the article numbers and see that there are no duplicates,
18645 and stuff.
18646
18647 @item
18648  `unsmileyfy-buffer' to undo smileification.
18649
18650 @item
18651  a command to give all relevant info on an article, including all
18652 secondary marks.
18653
18654 @item
18655  when doing `-request-accept-article', the backends should do
18656 the nnmail duplicate checking.
18657
18658 @item
18659  allow `message-signature-file' to be a function to return the
18660 value of the signature file.
18661
18662 @item
18663  In addition, I would love it if I could configure message-tab so that it
18664 could call `bbdb-complete-name' in other headers.  So, some sort of
18665 interface like
18666
18667 (setq message-tab-alist
18668       '((message-header-regexp message-expand-group)
18669         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
18670
18671 then you could run the relevant function to complete the information in
18672 the header
18673
18674 @item
18675  cache the newsgroups file locally to avoid reloading it all the time.
18676
18677 @item
18678  a command to import a buffer into a group.
18679
18680 @item
18681  nnweb should allow fetching by Message-ID from servers.
18682
18683 @item
18684  point in the article buffer doesn't always go to the
18685 beginning of the buffer when selecting new articles.
18686
18687 @item
18688  a command to process mark all unread articles.
18689
18690 @item
18691  `gnus-gather-threads-by-references-and-subject' -- first
18692 do gathering by references, and then go through the dummy roots and
18693 do more gathering by subject.
18694
18695 @item
18696  gnus-uu-mark-in-numerical-order -- process mark articles in
18697 article numerical order.
18698
18699 @item
18700  (gnus-thread-total-score
18701  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18702 bind to a key.
18703
18704 @item
18705  sorting by score is wrong when using sparse threads.
18706
18707 @item
18708  a command to fetch an arbitrary article -- without having to be
18709 in the summary buffer.
18710
18711 @item
18712  a new nncvs backend.  Each group would show an article, using
18713 version branches as threading, checkin date as the date, etc.
18714
18715 @item
18716  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18717 This filter allows one to construct advance queries on the Dejanews
18718 database such as specifying start and end dates, subject, author,
18719 and/or newsgroup name.
18720
18721 @item
18722  new Date header scoring type -- older, newer
18723
18724 @item
18725  use the summary toolbar in the article buffer.
18726
18727 @item
18728  a command to fetch all articles that are less than X days old.
18729
18730 @item
18731  in pick mode, `q' should save the list of selected articles in the
18732 group info.  The next time the group is selected, these articles
18733 will automatically get the process mark.
18734
18735 @item
18736  Isn't it possible to (also?) allow M-^ to automatically try the
18737 default server if it fails on the current server?  (controlled by a
18738 user variable, (nil, t, 'ask)).
18739
18740 @item
18741  make it possible to cancel articles using the select method for the
18742 current group.
18743
18744 @item
18745  `gnus-summary-select-article-on-entry' or something.  It'll default
18746 to t and will select whatever article decided by `gnus-auto-select-first'.
18747
18748 @item
18749  a new variable to control which selection commands should be unselecting.
18750 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18751 candidates.
18752
18753 @item
18754  be able to select groups that have no articles in them
18755 to be able to post in them (using the current select method).
18756
18757 @item
18758  be able to post via DejaNews.
18759
18760 @item
18761  `x' should retain any sortings that have been performed.
18762
18763 @item
18764  allow the user to specify the precedence of the secondary marks.  Also
18765 allow them to be displayed separately.
18766
18767 @item
18768  gnus-summary-save-in-pipe should concatenate the results from
18769 the processes when doing a process marked pipe.
18770
18771 @item
18772  a new match type, like Followup, but which adds Thread matches on all
18773 articles that match a certain From header.
18774
18775 @item
18776  a function that can be read from kill-emacs-query-functions to offer
18777 saving living summary buffers.
18778
18779 @item
18780  a function for selecting a particular group which will contain
18781 the articles listed in a list of article numbers/id's.
18782
18783 @item
18784  a battery of character translation functions to translate common
18785 Mac, MS (etc) characters into ISO 8859-1.
18786
18787 @example
18788 (defun article-fix-m$word ()
18789   "Fix M$Word smartquotes in an article."
18790   (interactive)
18791   (save-excursion
18792     (let ((buffer-read-only nil))
18793       (goto-char (point-min))
18794       (while (search-forward "\221" nil t)
18795         (replace-match "`" t t))
18796       (goto-char (point-min))
18797       (while (search-forward "\222" nil t)
18798         (replace-match "'" t t))
18799       (goto-char (point-min))
18800       (while (search-forward "\223" nil t)
18801         (replace-match "\"" t t))
18802       (goto-char (point-min))
18803       (while (search-forward "\224" nil t)
18804         (replace-match "\"" t t)))))
18805 @end example
18806
18807 @item
18808 @example
18809  (add-hook 'gnus-exit-query-functions
18810 '(lambda ()
18811    (if (and (file-exists-p nnmail-spool-file)
18812             (> (nnheader-file-size nnmail-spool-file) 0))
18813        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
18814        (y-or-n-p "Are you sure you want to quit Gnus? "))))
18815 @end example
18816
18817 @item
18818  allow message-default-headers to be a function.
18819
18820 @item
18821  new Date score match types -- < > = (etc) that take floating point
18822 numbers and match on the age of the article.
18823
18824 @item
18825 @example
18826 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18827 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
18828 >  > > buffer in the frame that it was called from =:-O
18829 >
18830 >  > Hm.  How do you start up Gnus?  From the toolbar or with
18831 >  > `M-x gnus-other-frame'?
18832 >
18833 >    I normally start it up from the toolbar; at
18834 > least that's the way I've caught it doing the
18835 > deed before.
18836 @end example
18837
18838 @item
18839  all commands that react to the process mark should push
18840 the current process mark set onto the stack.
18841
18842 @item
18843  gnus-article-hide-pgp
18844 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
18845 @example
18846 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18847 @end example
18848 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
18849 er min type heuristikk og langt fra alles.
18850
18851 @item
18852  `gnus-subscribe-sorted' -- insert new groups where they would have been
18853 sorted to if `gnus-group-sort-function' were run.
18854
18855 @item
18856  gnus-(group,summary)-highlight should respect any `face' text props set
18857 on the lines.
18858
18859 @item
18860  use run-with-idle-timer for gnus-demon instead of the
18861 home-brewed stuff for better reliability.
18862
18863 @item
18864  add a way to select which NoCeM type to apply -- spam, troll, etc.
18865
18866 @item
18867  nndraft-request-group should tally auto-save files.
18868
18869 @item
18870  implement nntp-retry-on-break and nntp-command-timeout.
18871
18872 @item
18873  gnus-article-highlight-limit that says when not to highlight (long)
18874 articles.
18875
18876 @item
18877  (nnoo-set SERVER VARIABLE VALUE)
18878
18879 @item
18880  nn*-spool-methods
18881
18882 @item
18883  interrupitng agent fetching of articles should save articles.
18884
18885 @item
18886  command to open a digest group, and copy all the articles there to the
18887 current group.
18888
18889 @item
18890  a variable to disable article body highlights if there's more than
18891 X characters in the body.
18892
18893 @item
18894  handle 480/381 authinfo requests separately.
18895
18896 @item
18897  include the texi/dir file in the distribution.
18898
18899 @item
18900  format spec to "tab" to a position.
18901
18902 @item
18903  Move all prompting to the new `M-n' default style.
18904
18905 @item
18906  command to display all dormant articles.
18907
18908 @item
18909  gnus-auto-select-next makeover -- list of things it should do.
18910
18911 @item
18912  a score match type that adds scores matching on From if From has replied
18913 to something someone else has said.
18914
18915 @item
18916  Read Netscape discussion groups:
18917 snews://secnews.netscape.com/netscape.communicator.unix
18918
18919 @item
18920 One command to edit the original version if an article, and one to edit
18921 the displayed version.
18922
18923 @item
18924 @kbd{T v} -- make all process-marked articles the children of the
18925 current article.
18926
18927 @item
18928 Switch from initial text to the new default text mechanism.
18929
18930 @item
18931 How about making it possible to expire local articles?  Will it be
18932 possible to make various constraints on when an article can be
18933 expired, e.g. (read), (age > 14 days), or the more interesting (read
18934 & age > 14 days)?
18935
18936 @item
18937 New limit command---limit to articles that have a certain string
18938 in the head or body.
18939
18940 @item
18941 Allow breaking lengthy NNTP commands.
18942
18943 @item
18944 gnus-article-highlight-limit, to disable highlighting in big articles.
18945
18946 @item
18947 Editing an article should put the article to be edited
18948 in a special, unique buffer.
18949
18950 @item
18951 A command to send a mail to the admin-address group param.
18952
18953 @item
18954 A Date scoring type that will match if the article
18955 is less than a certain number of days old.
18956
18957 @item
18958 New spec: %~(tab 56) to put point on column 56
18959
18960 @item
18961 Allow Gnus Agent scoring to use normal score files.
18962
18963 @item
18964 Rething the Agent active file thing.  `M-g' doesn't update the active
18965 file, for instance.
18966
18967 @item
18968 With dummy roots, `^' and then selecing the first article
18969 in any other dummy thread will make gnus highlight the
18970 dummy root instead of the first article.
18971
18972 @item
18973 Propagate all group properties (marks, article numbers, etc) up to the
18974 topics for displaying.
18975
18976 @item
18977 `n' in the group buffer with topics should go to the next group
18978 with unread articles, even if that group is hidden in a topic.
18979
18980 @item
18981 gnus-posting-styles doesn't work in drafts.
18982
18983 @item
18984 gnus-summary-limit-include-cached is slow when there are
18985 many articles in the cache, since it regenerates big parts of the
18986 summary buffer for each article.
18987
18988 @item
18989 Implement gnus-batch-brew-soup.
18990
18991 @item
18992 Group parameters and summary commands for un/subscribing to mailing
18993 lists.
18994
18995 @item
18996 Introduce nnmail-home-directory.
18997
18998 @item
18999 gnus-fetch-group and friends should exit Gnus when the user
19000 exits the group.
19001
19002 @item
19003 The jingle is only played on the second invocation of Gnus.
19004
19005 @item
19006 Bouncing articles should do MIME.
19007
19008 @item
19009 Crossposted articles should "inherit" the % or @ mark from the other
19010 groups it has been crossposted to, or something.  (Agent.)
19011
19012 @item
19013 `S D r' should allow expansion of aliases.
19014
19015 @item
19016 If point is on a group that appears multiple times in topics, and
19017 you press `l', point will move to the first instance of the group.
19018
19019 @item
19020 Fetch by Message-ID from dejanews.
19021
19022 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
19023
19024 @item
19025 A spec for the group line format to display the number of
19026 agent-downloaded articles in the group.
19027
19028 @item
19029 Some nntp servers never respond when posting, so there should be a
19030 timeout for all commands.
19031
19032 @item
19033 When stading on a topic line and `t'-ing, point goes to the last line.
19034 It should go somewhere else.
19035
19036 @item
19037 I'm having trouble accessing a newsgroup with a "+" in its name with
19038 Gnus.  There is a new newsgroup on msnews.microsoft.com named
19039 "microsoft.public.multimedia.directx.html+time" that I'm trying to
19040 access as
19041 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
19042 but it gives an error that it cant access the group.
19043
19044 Is the "+" character illegal in newsgroup names?  Is there any way in
19045 Gnus to work around this?  (gnus 5.6.45 - XEmacs 20.4)
19046
19047 @item
19048
19049 When `#F', do:
19050
19051 @example
19052 Subject: Answer to your mails 01.01.1999-01.05.1999
19053  --text follows this line--
19054 Sorry I killfiled you...
19055
19056 Under the subject "foo", you wrote on 01.01.1999:
19057 > bar
19058 Under the subject "foo1", you wrote on 01.01.1999:
19059 > bar 1
19060 @end example
19061
19062 @item
19063 Allow "orphan" scores in the Agent scoring.
19064
19065 @item
19066 Solve the halting problem.
19067
19068 @c TODO
19069 @end itemize
19070
19071 @iftex
19072
19073 @page
19074 @node The Manual
19075 @section The Manual
19076 @cindex colophon
19077 @cindex manual
19078
19079 This manual was generated from a TeXinfo file and then run through
19080 either @code{texi2dvi}
19081 @iflatex
19082 or my own home-brewed TeXinfo to \LaTeX\ transformer,
19083 and then run through @code{latex} and @code{dvips}
19084 @end iflatex
19085 to get what you hold in your hands now.
19086
19087 The following conventions have been used:
19088
19089 @enumerate
19090
19091 @item
19092 This is a @samp{string}
19093
19094 @item
19095 This is a @kbd{keystroke}
19096
19097 @item
19098 This is a @file{file}
19099
19100 @item
19101 This is a @code{symbol}
19102
19103 @end enumerate
19104
19105 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
19106 mean:
19107
19108 @lisp
19109 (setq flargnoze "yes")
19110 @end lisp
19111
19112 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
19113
19114 @lisp
19115 (setq flumphel 'yes)
19116 @end lisp
19117
19118 @samp{yes} and @code{yes} are two @emph{very} different things---don't
19119 ever get them confused.
19120
19121 @iflatex
19122 @c @head
19123 Of course, everything in this manual is of vital interest, so you should
19124 read it all.  Several times.  However, if you feel like skimming the
19125 manual, look for that gnu head you should see in the margin over
19126 there---it means that what's being discussed is of more importance than
19127 the rest of the stuff.  (On the other hand, if everything is infinitely
19128 important, how can anything be more important than that?  Just one more
19129 of the mysteries of this world, I guess.)
19130 @end iflatex
19131
19132 @end iftex
19133
19134
19135 @page
19136 @node Terminology
19137 @section Terminology
19138
19139 @cindex terminology
19140 @table @dfn
19141
19142 @item news
19143 @cindex news
19144 This is what you are supposed to use this thing for---reading news.
19145 News is generally fetched from a nearby @sc{nntp} server, and is
19146 generally publicly available to everybody.  If you post news, the entire
19147 world is likely to read just what you have written, and they'll all
19148 snigger mischievously.  Behind your back.
19149
19150 @item mail
19151 @cindex mail
19152 Everything that's delivered to you personally is mail.  Some news/mail
19153 readers (like Gnus) blur the distinction between mail and news, but
19154 there is a difference.  Mail is private.  News is public.  Mailing is
19155 not posting, and replying is not following up.
19156
19157 @item reply
19158 @cindex reply
19159 Send a mail to the person who has written what you are reading.
19160
19161 @item follow up
19162 @cindex follow up
19163 Post an article to the current newsgroup responding to the article you
19164 are reading.
19165
19166 @item backend
19167 @cindex backend
19168 Gnus gets fed articles from a number of backends, both news and mail
19169 backends.  Gnus does not handle the underlying media, so to speak---this
19170 is all done by the backends.
19171
19172 @item native
19173 @cindex native
19174 Gnus will always use one method (and backend) as the @dfn{native}, or
19175 default, way of getting news.
19176
19177 @item foreign
19178 @cindex foreign
19179 You can also have any number of foreign groups active at the same time.
19180 These are groups that use non-native non-secondary backends for getting
19181 news.
19182
19183 @item secondary
19184 @cindex secondary
19185 Secondary backends are somewhere half-way between being native and being
19186 foreign, but they mostly act like they are native.
19187
19188 @item article
19189 @cindex article
19190 A message that has been posted as news.
19191
19192 @item mail message
19193 @cindex mail message
19194 A message that has been mailed.
19195
19196 @item message
19197 @cindex message
19198 A mail message or news article
19199
19200 @item head
19201 @cindex head
19202 The top part of a message, where administrative information (etc.) is
19203 put.
19204
19205 @item body
19206 @cindex body
19207 The rest of an article.  Everything not in the head is in the
19208 body.
19209
19210 @item header
19211 @cindex header
19212 A line from the head of an article.
19213
19214 @item headers
19215 @cindex headers
19216 A collection of such lines, or a collection of heads.  Or even a
19217 collection of @sc{nov} lines.
19218
19219 @item @sc{nov}
19220 @cindex nov
19221 When Gnus enters a group, it asks the backend for the headers of all
19222 unread articles in the group.  Most servers support the News OverView
19223 format, which is more compact and much faster to read and parse than the
19224 normal @sc{head} format.
19225
19226 @item level
19227 @cindex levels
19228 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
19229 that have a lower level are ``more'' subscribed than the groups with a
19230 higher level.  In fact, groups on levels 1-5 are considered
19231 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
19232 are @dfn{killed}.  Commands for listing groups and scanning for new
19233 articles will all use the numeric prefix as @dfn{working level}.
19234
19235 @item killed groups
19236 @cindex killed groups
19237 No information on killed groups is stored or updated, which makes killed
19238 groups much easier to handle than subscribed groups.
19239
19240 @item zombie groups
19241 @cindex zombie groups
19242 Just like killed groups, only slightly less dead.
19243
19244 @item active file
19245 @cindex active file
19246 The news server has to keep track of what articles it carries, and what
19247 groups exist.  All this information in stored in the active file, which
19248 is rather large, as you might surmise.
19249
19250 @item bogus groups
19251 @cindex bogus groups
19252 A group that exists in the @file{.newsrc} file, but isn't known to the
19253 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
19254 This means that the group probably doesn't exist (any more).
19255
19256 @item activating
19257 @cindex activating groups
19258 The act of asking the server for info on a group and computing the
19259 number of unread articles is called @dfn{activating the group}.
19260 Un-activated groups are listed with @samp{*} in the group buffer.
19261
19262 @item server
19263 @cindex server
19264 A machine one can connect to and get news (or mail) from.
19265
19266 @item select method
19267 @cindex select method
19268 A structure that specifies the backend, the server and the virtual
19269 server settings.
19270
19271 @item virtual server
19272 @cindex virtual server
19273 A named select method.  Since a select method defines all there is to
19274 know about connecting to a (physical) server, taking the thing as a
19275 whole is a virtual server.
19276
19277 @item washing
19278 @cindex washing
19279 Taking a buffer and running it through a filter of some sort.  The
19280 result will (more often than not) be cleaner and more pleasing than the
19281 original.
19282
19283 @item ephemeral groups
19284 @cindex ephemeral groups
19285 Most groups store data on what articles you have read.  @dfn{Ephemeral}
19286 groups are groups that will have no data stored---when you exit the
19287 group, it'll disappear into the aether.
19288
19289 @item solid groups
19290 @cindex solid groups
19291 This is the opposite of ephemeral groups.  All groups listed in the
19292 group buffer are solid groups.
19293
19294 @item sparse articles
19295 @cindex sparse articles
19296 These are article placeholders shown in the summary buffer when
19297 @code{gnus-build-sparse-threads} has been switched on.
19298
19299 @item threading
19300 @cindex threading
19301 To put responses to articles directly after the articles they respond
19302 to---in a hierarchical fashion.
19303
19304 @item root
19305 @cindex root
19306 @cindex thread root
19307 The first article in a thread is the root.  It is the ancestor of all
19308 articles in the thread.
19309
19310 @item parent
19311 @cindex parent
19312 An article that has responses.
19313
19314 @item child
19315 @cindex child
19316 An article that responds to a different article---its parent.
19317
19318 @item digest
19319 @cindex digest
19320 A collection of messages in one file.  The most common digest format is
19321 specified by RFC1153.
19322
19323 @end table
19324
19325
19326 @page
19327 @node Customization
19328 @section Customization
19329 @cindex general customization
19330
19331 All variables are properly documented elsewhere in this manual.  This
19332 section is designed to give general pointers on how to customize Gnus
19333 for some quite common situations.
19334
19335 @menu
19336 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
19337 * Slow Terminal Connection::  You run a remote Emacs.
19338 * Little Disk Space::         You feel that having large setup files is icky.
19339 * Slow Machine::              You feel like buying a faster machine.
19340 @end menu
19341
19342
19343 @node Slow/Expensive Connection
19344 @subsection Slow/Expensive @sc{nntp} Connection
19345
19346 If you run Emacs on a machine locally, and get your news from a machine
19347 over some very thin strings, you want to cut down on the amount of data
19348 Gnus has to get from the @sc{nntp} server.
19349
19350 @table @code
19351
19352 @item gnus-read-active-file
19353 Set this to @code{nil}, which will inhibit Gnus from requesting the
19354 entire active file from the server.  This file is often v.  large.  You
19355 also have to set @code{gnus-check-new-newsgroups} and
19356 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
19357 doesn't suddenly decide to fetch the active file anyway.
19358
19359 @item gnus-nov-is-evil
19360 This one has to be @code{nil}.  If not, grabbing article headers from
19361 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
19362 support @sc{xover}; Gnus will detect this by itself.
19363 @end table
19364
19365
19366 @node Slow Terminal Connection
19367 @subsection Slow Terminal Connection
19368
19369 Let's say you use your home computer for dialing up the system that runs
19370 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
19371 possible) the amount of data sent over the wires.
19372
19373 @table @code
19374
19375 @item gnus-auto-center-summary
19376 Set this to @code{nil} to inhibit Gnus from re-centering the summary
19377 buffer all the time.  If it is @code{vertical}, do only vertical
19378 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
19379 horizontal and vertical recentering.
19380
19381 @item gnus-visible-headers
19382 Cut down on the headers included in the articles to the
19383 minimum.  You can, in fact, make do without them altogether---most of the
19384 useful data is in the summary buffer, anyway.  Set this variable to
19385 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
19386
19387 Set this hook to all the available hiding commands:
19388 @lisp
19389 (setq gnus-treat-hide-headers 'head
19390       gnus-treat-hide-signature t
19391       gnus-treat-hide-citation t)
19392 @end lisp
19393
19394 @item gnus-use-full-window
19395 By setting this to @code{nil}, you can make all the windows smaller.
19396 While this doesn't really cut down much generally, it means that you
19397 have to see smaller portions of articles before deciding that you didn't
19398 want to read them anyway.
19399
19400 @item gnus-thread-hide-subtree
19401 If this is non-@code{nil}, all threads in the summary buffer will be
19402 hidden initially.
19403
19404 @item gnus-updated-mode-lines
19405 If this is @code{nil}, Gnus will not put information in the buffer mode
19406 lines, which might save some time.
19407 @end table
19408
19409
19410 @node Little Disk Space
19411 @subsection Little Disk Space
19412 @cindex disk space
19413
19414 The startup files can get rather large, so you may want to cut their
19415 sizes a bit if you are running out of space.
19416
19417 @table @code
19418
19419 @item gnus-save-newsrc-file
19420 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
19421 only save @file{.newsrc.eld}.  This means that you will not be able to
19422 use any other newsreaders than Gnus.  This variable is @code{t} by
19423 default.
19424
19425 @item gnus-read-newsrc-file
19426 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
19427 only read @file{.newsrc.eld}.  This means that you will not be able to
19428 use any other newsreaders than Gnus.  This variable is @code{t} by
19429 default.
19430
19431 @item gnus-save-killed-list
19432 If this is @code{nil}, Gnus will not save the list of dead groups.  You
19433 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
19434 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
19435 variable to @code{nil}.  This variable is @code{t} by default.
19436
19437 @end table
19438
19439
19440 @node Slow Machine
19441 @subsection Slow Machine
19442 @cindex slow machine
19443
19444 If you have a slow machine, or are just really impatient, there are a
19445 few things you can do to make Gnus run faster.
19446
19447 Set @code{gnus-check-new-newsgroups} and
19448 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
19449
19450 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
19451 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
19452 summary buffer faster.
19453
19454
19455 @page
19456 @node Troubleshooting
19457 @section Troubleshooting
19458 @cindex troubleshooting
19459
19460 Gnus works @emph{so} well straight out of the box---I can't imagine any
19461 problems, really.
19462
19463 Ahem.
19464
19465 @enumerate
19466
19467 @item
19468 Make sure your computer is switched on.
19469
19470 @item
19471 Make sure that you really load the current Gnus version.  If you have
19472 been running @sc{gnus}, you need to exit Emacs and start it up again before
19473 Gnus will work.
19474
19475 @item
19476 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
19477 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
19478 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
19479 flee}, you have some old @file{.el} files lying around.  Delete these.
19480
19481 @item
19482 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
19483 how-to.
19484
19485 @item
19486 @vindex max-lisp-eval-depth
19487 Gnus works on many recursive structures, and in some extreme (and very
19488 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
19489 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
19490 something like that.
19491 @end enumerate
19492
19493 If all else fails, report the problem as a bug.
19494
19495 @cindex bugs
19496 @cindex reporting bugs
19497
19498 @kindex M-x gnus-bug
19499 @findex gnus-bug
19500 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
19501 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
19502 me the backtrace.  I will fix bugs, but I can only fix them if you send
19503 me a precise description as to how to reproduce the bug.
19504
19505 You really can never be too detailed in a bug report.  Always use the
19506 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
19507 a 10Kb mail each time you use it, and even if you have sent me your
19508 environment 500 times before.  I don't care.  I want the full info each
19509 time.
19510
19511 It is also important to remember that I have no memory whatsoever.  If
19512 you send a bug report, and I send you a reply, and then you just send
19513 back ``No, it's not! Moron!'', I will have no idea what you are
19514 insulting me about.  Always over-explain everything.  It's much easier
19515 for all of us---if I don't have all the information I need, I will just
19516 mail you and ask for more info, and everything takes more time.
19517
19518 If the problem you're seeing is very visual, and you can't quite explain
19519 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
19520 it somewhere it can be reached, and include the URL of the picture in
19521 the bug report.
19522
19523 If you just need help, you are better off asking on
19524 @samp{gnu.emacs.gnus}.  I'm not very helpful.
19525
19526 @cindex gnu.emacs.gnus
19527 @cindex ding mailing list
19528 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
19529 Write to @samp{ding-request@@gnus.org} to subscribe.
19530
19531
19532 @page
19533 @node Gnus Reference Guide
19534 @section Gnus Reference Guide
19535
19536 It is my hope that other people will figure out smart stuff that Gnus
19537 can do, and that other people will write those smart things as well.  To
19538 facilitate that I thought it would be a good idea to describe the inner
19539 workings of Gnus.  And some of the not-so-inner workings, while I'm at
19540 it.
19541
19542 You can never expect the internals of a program not to change, but I
19543 will be defining (in some details) the interface between Gnus and its
19544 backends (this is written in stone), the format of the score files
19545 (ditto), data structures (some are less likely to change than others)
19546 and general methods of operation.
19547
19548 @menu
19549 * Gnus Utility Functions::   Common functions and variable to use.
19550 * Backend Interface::        How Gnus communicates with the servers.
19551 * Score File Syntax::        A BNF definition of the score file standard.
19552 * Headers::                  How Gnus stores headers internally.
19553 * Ranges::                   A handy format for storing mucho numbers.
19554 * Group Info::               The group info format.
19555 * Extended Interactive::     Symbolic prefixes and stuff.
19556 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
19557 * Various File Formats::     Formats of files that Gnus use.
19558 @end menu
19559
19560
19561 @node Gnus Utility Functions
19562 @subsection Gnus Utility Functions
19563 @cindex Gnus utility functions
19564 @cindex utility functions
19565 @cindex functions
19566 @cindex internal variables
19567
19568 When writing small functions to be run from hooks (and stuff), it's
19569 vital to have access to the Gnus internal functions and variables.
19570 Below is a list of the most common ones.
19571
19572 @table @code
19573
19574 @item gnus-newsgroup-name
19575 @vindex gnus-newsgroup-name
19576 This variable holds the name of the current newsgroup.
19577
19578 @item gnus-find-method-for-group
19579 @findex gnus-find-method-for-group
19580 A function that returns the select method for @var{group}.
19581
19582 @item gnus-group-real-name
19583 @findex gnus-group-real-name
19584 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19585 name.
19586
19587 @item gnus-group-prefixed-name
19588 @findex gnus-group-prefixed-name
19589 Takes an unprefixed group name and a select method, and returns the full
19590 (prefixed) Gnus group name.
19591
19592 @item gnus-get-info
19593 @findex gnus-get-info
19594 Returns the group info list for @var{group}.
19595
19596 @item gnus-group-unread
19597 @findex gnus-group-unread
19598 The number of unread articles in @var{group}, or @code{t} if that is
19599 unknown.
19600
19601 @item gnus-active
19602 @findex gnus-active
19603 The active entry for @var{group}.
19604
19605 @item gnus-set-active
19606 @findex gnus-set-active
19607 Set the active entry for @var{group}.
19608
19609 @item gnus-add-current-to-buffer-list
19610 @findex gnus-add-current-to-buffer-list
19611 Adds the current buffer to the list of buffers to be killed on Gnus
19612 exit.
19613
19614 @item gnus-continuum-version
19615 @findex gnus-continuum-version
19616 Takes a Gnus version string as a parameter and returns a floating point
19617 number.  Earlier versions will always get a lower number than later
19618 versions.
19619
19620 @item gnus-group-read-only-p
19621 @findex gnus-group-read-only-p
19622 Says whether @var{group} is read-only or not.
19623
19624 @item gnus-news-group-p
19625 @findex gnus-news-group-p
19626 Says whether @var{group} came from a news backend.
19627
19628 @item gnus-ephemeral-group-p
19629 @findex gnus-ephemeral-group-p
19630 Says whether @var{group} is ephemeral or not.
19631
19632 @item gnus-server-to-method
19633 @findex gnus-server-to-method
19634 Returns the select method corresponding to @var{server}.
19635
19636 @item gnus-server-equal
19637 @findex gnus-server-equal
19638 Says whether two virtual servers are equal.
19639
19640 @item gnus-group-native-p
19641 @findex gnus-group-native-p
19642 Says whether @var{group} is native or not.
19643
19644 @item gnus-group-secondary-p
19645 @findex gnus-group-secondary-p
19646 Says whether @var{group} is secondary or not.
19647
19648 @item gnus-group-foreign-p
19649 @findex gnus-group-foreign-p
19650 Says whether @var{group} is foreign or not.
19651
19652 @item group-group-find-parameter
19653 @findex group-group-find-parameter
19654 Returns the parameter list of @var{group}.  If given a second parameter,
19655 returns the value of that parameter for @var{group}.
19656
19657 @item gnus-group-set-parameter
19658 @findex gnus-group-set-parameter
19659 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19660
19661 @item gnus-narrow-to-body
19662 @findex gnus-narrow-to-body
19663 Narrows the current buffer to the body of the article.
19664
19665 @item gnus-check-backend-function
19666 @findex gnus-check-backend-function
19667 Takes two parameters, @var{function} and @var{group}.  If the backend
19668 @var{group} comes from supports @var{function}, return non-@code{nil}.
19669
19670 @lisp
19671 (gnus-check-backend-function "request-scan" "nnml:misc")
19672 @result{} t
19673 @end lisp
19674
19675 @item gnus-read-method
19676 @findex gnus-read-method
19677 Prompts the user for a select method.
19678
19679 @end table
19680
19681
19682 @node Backend Interface
19683 @subsection Backend Interface
19684
19685 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19686 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
19687 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
19688 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
19689 examples of the latter we have @code{nntp-port-number} and
19690 @code{nnmbox-directory}.
19691
19692 When Gnus asks for information from a backend---say @code{nntp}---on
19693 something, it will normally include a virtual server name in the
19694 function parameters.  (If not, the backend should use the ``current''
19695 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
19696 server as its only (optional) parameter.  If this virtual server hasn't
19697 been opened, the function should fail.
19698
19699 Note that a virtual server name has no relation to some physical server
19700 name.  Take this example:
19701
19702 @lisp
19703 (nntp "odd-one"
19704       (nntp-address "ifi.uio.no")
19705       (nntp-port-number 4324))
19706 @end lisp
19707
19708 Here the virtual server name is @samp{odd-one} while the name of
19709 the physical server is @samp{ifi.uio.no}.
19710
19711 The backends should be able to switch between several virtual servers.
19712 The standard backends implement this by keeping an alist of virtual
19713 server environments that they pull down/push up when needed.
19714
19715 There are two groups of interface functions: @dfn{required functions},
19716 which must be present, and @dfn{optional functions}, which Gnus will
19717 always check for presence before attempting to call 'em.
19718
19719 All these functions are expected to return data in the buffer
19720 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19721 unfortunately named, but we'll have to live with it.  When I talk about
19722 @dfn{resulting data}, I always refer to the data in that buffer.  When I
19723 talk about @dfn{return value}, I talk about the function value returned by
19724 the function call.  Functions that fail should return @code{nil} as the
19725 return value.
19726
19727 Some backends could be said to be @dfn{server-forming} backends, and
19728 some might be said not to be.  The latter are backends that generally
19729 only operate on one group at a time, and have no concept of ``server''
19730 -- they have a group, and they deliver info on that group and nothing
19731 more.
19732
19733 In the examples and definitions I will refer to the imaginary backend
19734 @code{nnchoke}.
19735
19736 @cindex @code{nnchoke}
19737
19738 @menu
19739 * Required Backend Functions::        Functions that must be implemented.
19740 * Optional Backend Functions::        Functions that need not be implemented.
19741 * Error Messaging::                   How to get messages and report errors.
19742 * Writing New Backends::              Extending old backends.
19743 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
19744 * Mail-like Backends::                Some tips on mail backends.
19745 @end menu
19746
19747
19748 @node Required Backend Functions
19749 @subsubsection Required Backend Functions
19750
19751 @table @code
19752
19753 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19754
19755 @var{articles} is either a range of article numbers or a list of
19756 @code{Message-ID}s.  Current backends do not fully support either---only
19757 sequences (lists) of article numbers, and most backends do not support
19758 retrieval of @code{Message-ID}s.  But they should try for both.
19759
19760 The result data should either be HEADs or NOV lines, and the result
19761 value should either be @code{headers} or @code{nov} to reflect this.
19762 This might later be expanded to @code{various}, which will be a mixture
19763 of HEADs and NOV lines, but this is currently not supported by Gnus.
19764
19765 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19766 headers", in some meaning of the word.  This is generally done by
19767 fetching (at most) @var{fetch-old} extra headers less than the smallest
19768 article number in @code{articles}, and filling the gaps as well.  The
19769 presence of this parameter can be ignored if the backend finds it
19770 cumbersome to follow the request.  If this is non-@code{nil} and not a
19771 number, do maximum fetches.
19772
19773 Here's an example HEAD:
19774
19775 @example
19776 221 1056 Article retrieved.
19777 Path: ifi.uio.no!sturles
19778 From: sturles@@ifi.uio.no (Sturle Sunde)
19779 Newsgroups: ifi.discussion
19780 Subject: Re: Something very droll
19781 Date: 27 Oct 1994 14:02:57 +0100
19782 Organization: Dept. of Informatics, University of Oslo, Norway
19783 Lines: 26
19784 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19785 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19786 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19787 .
19788 @end example
19789
19790 So a @code{headers} return value would imply that there's a number of
19791 these in the data buffer.
19792
19793 Here's a BNF definition of such a buffer:
19794
19795 @example
19796 headers        = *head
19797 head           = error / valid-head
19798 error-message  = [ "4" / "5" ] 2number " " <error message> eol
19799 valid-head     = valid-message *header "." eol
19800 valid-message  = "221 " <number> " Article retrieved." eol
19801 header         = <text> eol
19802 @end example
19803
19804 If the return value is @code{nov}, the data buffer should contain
19805 @dfn{network overview database} lines.  These are basically fields
19806 separated by tabs.
19807
19808 @example
19809 nov-buffer = *nov-line
19810 nov-line   = 8*9 [ field <TAB> ] eol
19811 field      = <text except TAB>
19812 @end example
19813
19814 For a closer look at what should be in those fields,
19815 @pxref{Headers}.
19816
19817
19818 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
19819
19820 @var{server} is here the virtual server name.  @var{definitions} is a
19821 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
19822
19823 If the server can't be opened, no error should be signaled.  The backend
19824 may then choose to refuse further attempts at connecting to this
19825 server.  In fact, it should do so.
19826
19827 If the server is opened already, this function should return a
19828 non-@code{nil} value.  There should be no data returned.
19829
19830
19831 @item (nnchoke-close-server &optional SERVER)
19832
19833 Close connection to @var{server} and free all resources connected
19834 to it.  Return @code{nil} if the server couldn't be closed for some
19835 reason.
19836
19837 There should be no data returned.
19838
19839
19840 @item (nnchoke-request-close)
19841
19842 Close connection to all servers and free all resources that the backend
19843 have reserved.  All buffers that have been created by that backend
19844 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
19845 function is generally only called when Gnus is shutting down.
19846
19847 There should be no data returned.
19848
19849
19850 @item (nnchoke-server-opened &optional SERVER)
19851
19852 If @var{server} is the current virtual server, and the connection to the
19853 physical server is alive, then this function should return a
19854 non-@code{nil} vlue.  This function should under no circumstances
19855 attempt to reconnect to a server we have lost connection to.
19856
19857 There should be no data returned.
19858
19859
19860 @item (nnchoke-status-message &optional SERVER)
19861
19862 This function should return the last error message from @var{server}.
19863
19864 There should be no data returned.
19865
19866
19867 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19868
19869 The result data from this function should be the article specified by
19870 @var{article}.  This might either be a @code{Message-ID} or a number.
19871 It is optional whether to implement retrieval by @code{Message-ID}, but
19872 it would be nice if that were possible.
19873
19874 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19875 in this buffer instead of the normal data buffer.  This is to make it
19876 possible to avoid copying large amounts of data from one buffer to
19877 another, while Gnus mainly requests articles to be inserted directly
19878 into its article buffer.
19879
19880 If it is at all possible, this function should return a cons cell where
19881 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19882 the article number.  This will enable Gnus to find out what the real
19883 group and article numbers are when fetching articles by
19884 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
19885 on successful article retrieval.
19886
19887
19888 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19889
19890 Get data on @var{group}.  This function also has the side effect of
19891 making @var{group} the current group.
19892
19893 If @var{FAST}, don't bother to return useful data, just make @var{group}
19894 the current group.
19895
19896 Here's an example of some result data and a definition of the same:
19897
19898 @example
19899 211 56 1000 1059 ifi.discussion
19900 @end example
19901
19902 The first number is the status, which should be 211.  Next is the
19903 total number of articles in the group, the lowest article number, the
19904 highest article number, and finally the group name.  Note that the total
19905 number of articles may be less than one might think while just
19906 considering the highest and lowest article numbers, but some articles
19907 may have been canceled.  Gnus just discards the total-number, so
19908 whether one should take the bother to generate it properly (if that is a
19909 problem) is left as an exercise to the reader.
19910
19911 @example
19912 group-status = [ error / info ] eol
19913 error        = [ "4" / "5" ] 2<number> " " <Error message>
19914 info         = "211 " 3* [ <number> " " ] <string>
19915 @end example
19916
19917
19918 @item (nnchoke-close-group GROUP &optional SERVER)
19919
19920 Close @var{group} and free any resources connected to it.  This will be
19921 a no-op on most backends.
19922
19923 There should be no data returned.
19924
19925
19926 @item (nnchoke-request-list &optional SERVER)
19927
19928 Return a list of all groups available on @var{server}.  And that means
19929 @emph{all}.
19930
19931 Here's an example from a server that only carries two groups:
19932
19933 @example
19934 ifi.test 0000002200 0000002000 y
19935 ifi.discussion 3324 3300 n
19936 @end example
19937
19938 On each line we have a group name, then the highest article number in
19939 that group, the lowest article number, and finally a flag.
19940
19941 @example
19942 active-file = *active-line
19943 active-line = name " " <number> " " <number> " " flags eol
19944 name        = <string>
19945 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
19946 @end example
19947
19948 The flag says whether the group is read-only (@samp{n}), is moderated
19949 (@samp{m}), is dead (@samp{x}), is aliased to some other group
19950 (@samp{=other-group}) or none of the above (@samp{y}).
19951
19952
19953 @item (nnchoke-request-post &optional SERVER)
19954
19955 This function should post the current buffer.  It might return whether
19956 the posting was successful or not, but that's not required.  If, for
19957 instance, the posting is done asynchronously, it has generally not been
19958 completed by the time this function concludes.  In that case, this
19959 function should set up some kind of sentinel to beep the user loud and
19960 clear if the posting could not be completed.
19961
19962 There should be no result data from this function.
19963
19964 @end table
19965
19966
19967 @node Optional Backend Functions
19968 @subsubsection Optional Backend Functions
19969
19970 @table @code
19971
19972 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
19973
19974 @var{groups} is a list of groups, and this function should request data
19975 on all those groups.  How it does it is of no concern to Gnus, but it
19976 should attempt to do this in a speedy fashion.
19977
19978 The return value of this function can be either @code{active} or
19979 @code{group}, which says what the format of the result data is.  The
19980 former is in the same format as the data from
19981 @code{nnchoke-request-list}, while the latter is a buffer full of lines
19982 in the same format as @code{nnchoke-request-group} gives.
19983
19984 @example
19985 group-buffer = *active-line / *group-status
19986 @end example
19987
19988
19989 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
19990
19991 A Gnus group info (@pxref{Group Info}) is handed to the backend for
19992 alterations.  This comes in handy if the backend really carries all the
19993 information (as is the case with virtual and imap groups).  This
19994 function should destructively alter the info to suit its needs, and
19995 should return the (altered) group info.
19996
19997 There should be no result data from this function.
19998
19999
20000 @item (nnchoke-request-type GROUP &optional ARTICLE)
20001
20002 When the user issues commands for ``sending news'' (@kbd{F} in the
20003 summary buffer, for instance), Gnus has to know whether the article the
20004 user is following up on is news or mail.  This function should return
20005 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
20006 is mail and @code{unknown} if the type can't be decided.  (The
20007 @var{article} parameter is necessary in @code{nnvirtual} groups which
20008 might very well combine mail groups and news groups.)  Both @var{group}
20009 and @var{article} may be @code{nil}.
20010
20011 There should be no result data from this function.
20012
20013
20014 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
20015
20016 Set/remove/add marks on articles. Normally Gnus handles the article
20017 marks (such as read, ticked, expired etc) internally, and store them in
20018 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
20019 information about the articles on the server, so Gnus need to propagate
20020 the mark information to the server.
20021
20022 ACTION is a list of mark setting requests, having this format:
20023
20024 @example
20025 (RANGE ACTION MARK)
20026 @end example
20027
20028 Range is a range of articles you wish to update marks on. Action is
20029 @code{set}, @code{add} or @code{del}, respectively used for removing all
20030 existing marks and setting them as specified, adding (preserving the
20031 marks not mentioned) mark and removing (preserving the marks not
20032 mentioned) marks. Mark is a list of marks; where each mark is a
20033 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
20034 @code{expire}, @code{killed}, @code{dormant}, @code{save},
20035 @code{download} and @code{unsend}, but your backend should, if possible,
20036 not limit itself to theese.
20037
20038 Given contradictory actions, the last action in the list should be the
20039 effective one. That is, if your action contains a request to add the
20040 @code{tick} mark on article 1 and, later in the list, a request to
20041 remove the mark on the same article, the mark should in fact be removed.
20042
20043 An example action list:
20044
20045 @example
20046 (((5 12 30) 'del '(tick))
20047  ((10 . 90) 'add '(read expire))
20048  ((92 94) 'del '(read)))
20049 @end example
20050
20051 The function should return a range of articles it wasn't able to set the
20052 mark on (currently not used for anything).
20053
20054 There should be no result data from this function.
20055
20056 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
20057
20058 If the user tries to set a mark that the backend doesn't like, this
20059 function may change the mark.  Gnus will use whatever this function
20060 returns as the mark for @var{article} instead of the original
20061 @var{mark}.  If the backend doesn't care, it must return the original
20062 @var{mark}, and not @code{nil} or any other type of garbage.
20063
20064 The only use for this I can see is what @code{nnvirtual} does with
20065 it---if a component group is auto-expirable, marking an article as read
20066 in the virtual group should result in the article being marked as
20067 expirable.
20068
20069 There should be no result data from this function.
20070
20071
20072 @item (nnchoke-request-scan &optional GROUP SERVER)
20073
20074 This function may be called at any time (by Gnus or anything else) to
20075 request that the backend check for incoming articles, in one way or
20076 another.  A mail backend will typically read the spool file or query the
20077 POP server when this function is invoked.  The @var{group} doesn't have
20078 to be heeded---if the backend decides that it is too much work just
20079 scanning for a single group, it may do a total scan of all groups.  It
20080 would be nice, however, to keep things local if that's practical.
20081
20082 There should be no result data from this function.
20083
20084
20085 @item (nnchoke-request-group-description GROUP &optional SERVER)
20086
20087 The result data from this function should be a description of
20088 @var{group}.
20089
20090 @example
20091 description-line = name <TAB> description eol
20092 name             = <string>
20093 description      = <text>
20094 @end example
20095
20096 @item (nnchoke-request-list-newsgroups &optional SERVER)
20097
20098 The result data from this function should be the description of all
20099 groups available on the server.
20100
20101 @example
20102 description-buffer = *description-line
20103 @end example
20104
20105
20106 @item (nnchoke-request-newgroups DATE &optional SERVER)
20107
20108 The result data from this function should be all groups that were
20109 created after @samp{date}, which is in normal human-readable date
20110 format.  The data should be in the active buffer format.
20111
20112
20113 @item (nnchoke-request-create-group GROUP &optional SERVER)
20114
20115 This function should create an empty group with name @var{group}.
20116
20117 There should be no return data.
20118
20119
20120 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
20121
20122 This function should run the expiry process on all articles in the
20123 @var{articles} range (which is currently a simple list of article
20124 numbers.)  It is left up to the backend to decide how old articles
20125 should be before they are removed by this function.  If @var{force} is
20126 non-@code{nil}, all @var{articles} should be deleted, no matter how new
20127 they are.
20128
20129 This function should return a list of articles that it did not/was not
20130 able to delete.
20131
20132 There should be no result data returned.
20133
20134
20135 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
20136 &optional LAST)
20137
20138 This function should move @var{article} (which is a number) from
20139 @var{group} by calling @var{accept-form}.
20140
20141 This function should ready the article in question for moving by
20142 removing any header lines it has added to the article, and generally
20143 should ``tidy up'' the article.  Then it should @code{eval}
20144 @var{accept-form} in the buffer where the ``tidy'' article is.  This
20145 will do the actual copying.  If this @code{eval} returns a
20146 non-@code{nil} value, the article should be removed.
20147
20148 If @var{last} is @code{nil}, that means that there is a high likelihood
20149 that there will be more requests issued shortly, so that allows some
20150 optimizations.
20151
20152 The function should return a cons where the @code{car} is the group name and
20153 the @code{cdr} is the article number that the article was entered as.
20154
20155 There should be no data returned.
20156
20157
20158 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
20159
20160 This function takes the current buffer and inserts it into @var{group}.
20161 If @var{last} in @code{nil}, that means that there will be more calls to
20162 this function in short order.
20163
20164 The function should return a cons where the @code{car} is the group name and
20165 the @code{cdr} is the article number that the article was entered as.
20166
20167 There should be no data returned.
20168
20169
20170 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
20171
20172 This function should remove @var{article} (which is a number) from
20173 @var{group} and insert @var{buffer} there instead.
20174
20175 There should be no data returned.
20176
20177
20178 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
20179
20180 This function should delete @var{group}.  If @var{force}, it should
20181 really delete all the articles in the group, and then delete the group
20182 itself.  (If there is such a thing as ``the group itself''.)
20183
20184 There should be no data returned.
20185
20186
20187 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
20188
20189 This function should rename @var{group} into @var{new-name}.  All
20190 articles in @var{group} should move to @var{new-name}.
20191
20192 There should be no data returned.
20193
20194 @end table
20195
20196
20197 @node Error Messaging
20198 @subsubsection Error Messaging
20199
20200 @findex nnheader-report
20201 @findex nnheader-get-report
20202 The backends should use the function @code{nnheader-report} to report
20203 error conditions---they should not raise errors when they aren't able to
20204 perform a request.  The first argument to this function is the backend
20205 symbol, and the rest are interpreted as arguments to @code{format} if
20206 there are multiple of them, or just a string if there is one of them.
20207 This function must always returns @code{nil}.
20208
20209 @lisp
20210 (nnheader-report 'nnchoke "You did something totally bogus")
20211
20212 (nnheader-report 'nnchoke "Could not request group %s" group)
20213 @end lisp
20214
20215 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
20216 @code{nil} back from a server, and this function returns the most
20217 recently reported message for the backend in question.  This function
20218 takes one argument---the server symbol.
20219
20220 Internally, these functions access @var{backend}@code{-status-string},
20221 so the @code{nnchoke} backend will have its error message stored in
20222 @code{nnchoke-status-string}.
20223
20224
20225 @node Writing New Backends
20226 @subsubsection Writing New Backends
20227
20228 Many backends are quite similar.  @code{nnml} is just like
20229 @code{nnspool}, but it allows you to edit the articles on the server.
20230 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
20231 and it doesn't maintain overview databases.  @code{nndir} is just like
20232 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
20233 editing articles.
20234
20235 It would make sense if it were possible to ``inherit'' functions from
20236 backends when writing new backends.  And, indeed, you can do that if you
20237 want to.  (You don't have to if you don't want to, of course.)
20238
20239 All the backends declare their public variables and functions by using a
20240 package called @code{nnoo}.
20241
20242 To inherit functions from other backends (and allow other backends to
20243 inherit functions from the current backend), you should use the
20244 following macros:
20245
20246 @table @code
20247
20248 @item nnoo-declare
20249 This macro declares the first parameter to be a child of the subsequent
20250 parameters.  For instance:
20251
20252 @lisp
20253 (nnoo-declare nndir
20254   nnml nnmh)
20255 @end lisp
20256
20257 @code{nndir} has declared here that it intends to inherit functions from
20258 both @code{nnml} and @code{nnmh}.
20259
20260 @item defvoo
20261 This macro is equivalent to @code{defvar}, but registers the variable as
20262 a public server variable.  Most state-oriented variables should be
20263 declared with @code{defvoo} instead of @code{defvar}.
20264
20265 In addition to the normal @code{defvar} parameters, it takes a list of
20266 variables in the parent backends to map the variable to when executing
20267 a function in those backends.
20268
20269 @lisp
20270 (defvoo nndir-directory nil
20271   "Where nndir will look for groups."
20272   nnml-current-directory nnmh-current-directory)
20273 @end lisp
20274
20275 This means that @code{nnml-current-directory} will be set to
20276 @code{nndir-directory} when an @code{nnml} function is called on behalf
20277 of @code{nndir}.  (The same with @code{nnmh}.)
20278
20279 @item nnoo-define-basics
20280 This macro defines some common functions that almost all backends should
20281 have.
20282
20283 @example
20284 (nnoo-define-basics nndir)
20285 @end example
20286
20287 @item deffoo
20288 This macro is just like @code{defun} and takes the same parameters.  In
20289 addition to doing the normal @code{defun} things, it registers the
20290 function as being public so that other backends can inherit it.
20291
20292 @item nnoo-map-functions
20293 This macro allows mapping of functions from the current backend to
20294 functions from the parent backends.
20295
20296 @example
20297 (nnoo-map-functions nndir
20298   (nnml-retrieve-headers 0 nndir-current-group 0 0)
20299   (nnmh-request-article 0 nndir-current-group 0 0))
20300 @end example
20301
20302 This means that when @code{nndir-retrieve-headers} is called, the first,
20303 third, and fourth parameters will be passed on to
20304 @code{nnml-retrieve-headers}, while the second parameter is set to the
20305 value of @code{nndir-current-group}.
20306
20307 @item nnoo-import
20308 This macro allows importing functions from backends.  It should be the
20309 last thing in the source file, since it will only define functions that
20310 haven't already been defined.
20311
20312 @example
20313 (nnoo-import nndir
20314   (nnmh
20315    nnmh-request-list
20316    nnmh-request-newgroups)
20317   (nnml))
20318 @end example
20319
20320 This means that calls to @code{nndir-request-list} should just be passed
20321 on to @code{nnmh-request-list}, while all public functions from
20322 @code{nnml} that haven't been defined in @code{nndir} yet should be
20323 defined now.
20324
20325 @end table
20326
20327 Below is a slightly shortened version of the @code{nndir} backend.
20328
20329 @lisp
20330 ;;; nndir.el --- single directory newsgroup access for Gnus
20331 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
20332
20333 ;;; Code:
20334
20335 (require 'nnheader)
20336 (require 'nnmh)
20337 (require 'nnml)
20338 (require 'nnoo)
20339 (eval-when-compile (require 'cl))
20340
20341 (nnoo-declare nndir
20342   nnml nnmh)
20343
20344 (defvoo nndir-directory nil
20345   "Where nndir will look for groups."
20346   nnml-current-directory nnmh-current-directory)
20347
20348 (defvoo nndir-nov-is-evil nil
20349   "*Non-nil means that nndir will never retrieve NOV headers."
20350   nnml-nov-is-evil)
20351
20352 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
20353 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
20354 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
20355
20356 (defvoo nndir-status-string "" nil nnmh-status-string)
20357 (defconst nndir-version "nndir 1.0")
20358
20359 ;;; Interface functions.
20360
20361 (nnoo-define-basics nndir)
20362
20363 (deffoo nndir-open-server (server &optional defs)
20364   (setq nndir-directory
20365         (or (cadr (assq 'nndir-directory defs))
20366             server))
20367   (unless (assq 'nndir-directory defs)
20368     (push `(nndir-directory ,server) defs))
20369   (push `(nndir-current-group
20370           ,(file-name-nondirectory (directory-file-name nndir-directory)))
20371         defs)
20372   (push `(nndir-top-directory
20373           ,(file-name-directory (directory-file-name nndir-directory)))
20374         defs)
20375   (nnoo-change-server 'nndir server defs))
20376
20377 (nnoo-map-functions nndir
20378   (nnml-retrieve-headers 0 nndir-current-group 0 0)
20379   (nnmh-request-article 0 nndir-current-group 0 0)
20380   (nnmh-request-group nndir-current-group 0 0)
20381   (nnmh-close-group nndir-current-group 0))
20382
20383 (nnoo-import nndir
20384   (nnmh
20385    nnmh-status-message
20386    nnmh-request-list
20387    nnmh-request-newgroups))
20388
20389 (provide 'nndir)
20390 @end lisp
20391
20392
20393 @node Hooking New Backends Into Gnus
20394 @subsubsection Hooking New Backends Into Gnus
20395
20396 @vindex gnus-valid-select-methods
20397 Having Gnus start using your new backend is rather easy---you just
20398 declare it with the @code{gnus-declare-backend} functions.  This will
20399 enter the backend into the @code{gnus-valid-select-methods} variable.
20400
20401 @code{gnus-declare-backend} takes two parameters---the backend name and
20402 an arbitrary number of @dfn{abilities}.
20403
20404 Here's an example:
20405
20406 @lisp
20407 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
20408 @end lisp
20409
20410 The abilities can be:
20411
20412 @table @code
20413 @item mail
20414 This is a mailish backend---followups should (probably) go via mail.
20415 @item post
20416 This is a newsish backend---followups should (probably) go via news.
20417 @item post-mail
20418 This backend supports both mail and news.
20419 @item none
20420 This is neither a post nor mail backend---it's something completely
20421 different.
20422 @item respool
20423 It supports respooling---or rather, it is able to modify its source
20424 articles and groups.
20425 @item address
20426 The name of the server should be in the virtual server name.  This is
20427 true for almost all backends.
20428 @item prompt-address
20429 The user should be prompted for an address when doing commands like
20430 @kbd{B} in the group buffer.  This is true for backends like
20431 @code{nntp}, but not @code{nnmbox}, for instance.
20432 @end table
20433
20434
20435 @node Mail-like Backends
20436 @subsubsection Mail-like Backends
20437
20438 One of the things that separate the mail backends from the rest of the
20439 backends is the heavy dependence by the mail backends on common
20440 functions in @file{nnmail.el}.  For instance, here's the definition of
20441 @code{nnml-request-scan}:
20442
20443 @lisp
20444 (deffoo nnml-request-scan (&optional group server)
20445   (setq nnml-article-file-alist nil)
20446   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
20447 @end lisp
20448
20449 It simply calls @code{nnmail-get-new-mail} with a few parameters,
20450 and @code{nnmail} takes care of all the moving and splitting of the
20451 mail.
20452
20453 This function takes four parameters.
20454
20455 @table @var
20456 @item method
20457 This should be a symbol to designate which backend is responsible for
20458 the call.
20459
20460 @item exit-function
20461 This function should be called after the splitting has been performed.
20462
20463 @item temp-directory
20464 Where the temporary files should be stored.
20465
20466 @item group
20467 This optional argument should be a group name if the splitting is to be
20468 performed for one group only.
20469 @end table
20470
20471 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
20472 save each article.  @var{backend}@code{-active-number} will be called to
20473 find the article number assigned to this article.
20474
20475 The function also uses the following variables:
20476 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
20477 this backend); and @var{backend}@code{-group-alist} and
20478 @var{backend}@code{-active-file} to generate the new active file.
20479 @var{backend}@code{-group-alist} should be a group-active alist, like
20480 this:
20481
20482 @example
20483 (("a-group" (1 . 10))
20484  ("some-group" (34 . 39)))
20485 @end example
20486
20487
20488 @node Score File Syntax
20489 @subsection Score File Syntax
20490
20491 Score files are meant to be easily parseable, but yet extremely
20492 mallable.   It was decided that something that had the same read syntax
20493 as an Emacs Lisp list would fit that spec.
20494
20495 Here's a typical score file:
20496
20497 @lisp
20498 (("summary"
20499   ("win95" -10000 nil s)
20500   ("Gnus"))
20501  ("from"
20502   ("Lars" -1000))
20503  (mark -100))
20504 @end lisp
20505
20506 BNF definition of a score file:
20507
20508 @example
20509 score-file       = "" / "(" *element ")"
20510 element          = rule / atom
20511 rule             = string-rule / number-rule / date-rule
20512 string-rule      = "(" quote string-header quote space *string-match ")"
20513 number-rule      = "(" quote number-header quote space *number-match ")"
20514 date-rule        = "(" quote date-header quote space *date-match ")"
20515 quote            = <ascii 34>
20516 string-header    = "subject" / "from" / "references" / "message-id" /
20517                    "xref" / "body" / "head" / "all" / "followup"
20518 number-header    = "lines" / "chars"
20519 date-header      = "date"
20520 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
20521                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
20522 score            = "nil" / <integer>
20523 date             = "nil" / <natural number>
20524 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
20525                    "r" / "regex" / "R" / "Regex" /
20526                    "e" / "exact" / "E" / "Exact" /
20527                    "f" / "fuzzy" / "F" / "Fuzzy"
20528 number-match     = "(" <integer> [ "" / [ space score [ "" /
20529                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
20530 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
20531 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
20532                    space date [ "" / [ space date-match-t ] ] ] ] ")"
20533 date-match-t     = "nil" / "at" / "before" / "after"
20534 atom             = "(" [ required-atom / optional-atom ] ")"
20535 required-atom    = mark / expunge / mark-and-expunge / files /
20536                    exclude-files / read-only / touched
20537 optional-atom    = adapt / local / eval
20538 mark             = "mark" space nil-or-number
20539 nil-or-number    = "nil" / <integer>
20540 expunge          = "expunge" space nil-or-number
20541 mark-and-expunge = "mark-and-expunge" space nil-or-number
20542 files            = "files" *[ space <string> ]
20543 exclude-files    = "exclude-files" *[ space <string> ]
20544 read-only        = "read-only" [ space "nil" / space "t" ]
20545 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
20546 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
20547 local            = "local" *[ space "(" <string> space <form> ")" ]
20548 eval             = "eval" space <form>
20549 space            = *[ " " / <TAB> / <NEWLINE> ]
20550 @end example
20551
20552 Any unrecognized elements in a score file should be ignored, but not
20553 discarded.
20554
20555 As you can see, white space is needed, but the type and amount of white
20556 space is irrelevant.  This means that formatting of the score file is
20557 left up to the programmer---if it's simpler to just spew it all out on
20558 one looong line, then that's ok.
20559
20560 The meaning of the various atoms are explained elsewhere in this
20561 manual (@pxref{Score File Format}).
20562
20563
20564 @node Headers
20565 @subsection Headers
20566
20567 Internally Gnus uses a format for storing article headers that
20568 corresponds to the @sc{nov} format in a mysterious fashion.  One could
20569 almost suspect that the author looked at the @sc{nov} specification and
20570 just shamelessly @emph{stole} the entire thing, and one would be right.
20571
20572 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
20573 RFC1036 to talk about lines in the head of an article (e.g.,
20574 @code{From}).  It is used by many people as a synonym for
20575 ``head''---``the header and the body''.  (That should be avoided, in my
20576 opinion.)  And Gnus uses a format internally that it calls ``header'',
20577 which is what I'm talking about here.  This is a 9-element vector,
20578 basically, with each header (ouch) having one slot.
20579
20580 These slots are, in order: @code{number}, @code{subject}, @code{from},
20581 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
20582 @code{xref}, and @code{extra}.  There are macros for accessing and
20583 setting these slots---they all have predictable names beginning with
20584 @code{mail-header-} and @code{mail-header-set-}, respectively.
20585
20586 All these slots contain strings, except the @code{extra} slot, which
20587 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20588
20589
20590 @node Ranges
20591 @subsection Ranges
20592
20593 @sc{gnus} introduced a concept that I found so useful that I've started
20594 using it a lot and have elaborated on it greatly.
20595
20596 The question is simple: If you have a large amount of objects that are
20597 identified by numbers (say, articles, to take a @emph{wild} example)
20598 that you want to qualify as being ``included'', a normal sequence isn't
20599 very useful.  (A 200,000 length sequence is a bit long-winded.)
20600
20601 The solution is as simple as the question: You just collapse the
20602 sequence.
20603
20604 @example
20605 (1 2 3 4 5 6 10 11 12)
20606 @end example
20607
20608 is transformed into
20609
20610 @example
20611 ((1 . 6) (10 . 12))
20612 @end example
20613
20614 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20615 lonesome object, a @samp{13} is a valid element:
20616
20617 @example
20618 ((1 . 6) 7 (10 . 12))
20619 @end example
20620
20621 This means that comparing two ranges to find out whether they are equal
20622 is slightly tricky:
20623
20624 @example
20625 ((1 . 5) 7 8 (10 . 12))
20626 @end example
20627
20628 and
20629
20630 @example
20631 ((1 . 5) (7 . 8) (10 . 12))
20632 @end example
20633
20634 are equal.  In fact, any non-descending list is a range:
20635
20636 @example
20637 (1 2 3 4 5)
20638 @end example
20639
20640 is a perfectly valid range, although a pretty long-winded one.  This is
20641 also valid:
20642
20643 @example
20644 (1 . 5)
20645 @end example
20646
20647 and is equal to the previous range.
20648
20649 Here's a BNF definition of ranges.  Of course, one must remember the
20650 semantic requirement that the numbers are non-descending.  (Any number
20651 of repetition of the same number is allowed, but apt to disappear in
20652 range handling.)
20653
20654 @example
20655 range           = simple-range / normal-range
20656 simple-range    = "(" number " . " number ")"
20657 normal-range    = "(" start-contents ")"
20658 contents        = "" / simple-range *[ " " contents ] /
20659                   number *[ " " contents ]
20660 @end example
20661
20662 Gnus currently uses ranges to keep track of read articles and article
20663 marks.  I plan on implementing a number of range operators in C if The
20664 Powers That Be are willing to let me.  (I haven't asked yet, because I
20665 need to do some more thinking on what operators I need to make life
20666 totally range-based without ever having to convert back to normal
20667 sequences.)
20668
20669
20670 @node Group Info
20671 @subsection Group Info
20672
20673 Gnus stores all permanent info on groups in a @dfn{group info} list.
20674 This list is from three to six elements (or more) long and exhaustively
20675 describes the group.
20676
20677 Here are two example group infos; one is a very simple group while the
20678 second is a more complex one:
20679
20680 @example
20681 ("no.group" 5 ((1 . 54324)))
20682
20683 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20684                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20685                 (nnml "")
20686                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20687 @end example
20688
20689 The first element is the @dfn{group name}---as Gnus knows the group,
20690 anyway.  The second element is the @dfn{subscription level}, which
20691 normally is a small integer.  (It can also be the @dfn{rank}, which is a
20692 cons cell where the @code{car} is the level and the @code{cdr} is the
20693 score.)  The third element is a list of ranges of read articles.  The
20694 fourth element is a list of lists of article marks of various kinds.
20695 The fifth element is the select method (or virtual server, if you like).
20696 The sixth element is a list of @dfn{group parameters}, which is what
20697 this section is about.
20698
20699 Any of the last three elements may be missing if they are not required.
20700 In fact, the vast majority of groups will normally only have the first
20701 three elements, which saves quite a lot of cons cells.
20702
20703 Here's a BNF definition of the group info format:
20704
20705 @example
20706 info          = "(" group space ralevel space read
20707                 [ "" / [ space marks-list [ "" / [ space method [ "" /
20708                 space parameters ] ] ] ] ] ")"
20709 group         = quote <string> quote
20710 ralevel       = rank / level
20711 level         = <integer in the range of 1 to inf>
20712 rank          = "(" level "." score ")"
20713 score         = <integer in the range of 1 to inf>
20714 read          = range
20715 marks-lists   = nil / "(" *marks ")"
20716 marks         = "(" <string> range ")"
20717 method        = "(" <string> *elisp-forms ")"
20718 parameters    = "(" *elisp-forms ")"
20719 @end example
20720
20721 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
20722 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20723 in pseudo-BNF.
20724
20725 If you have a Gnus info and want to access the elements, Gnus offers a
20726 series of macros for getting/setting these elements.
20727
20728 @table @code
20729 @item gnus-info-group
20730 @itemx gnus-info-set-group
20731 @findex gnus-info-group
20732 @findex gnus-info-set-group
20733 Get/set the group name.
20734
20735 @item gnus-info-rank
20736 @itemx gnus-info-set-rank
20737 @findex gnus-info-rank
20738 @findex gnus-info-set-rank
20739 Get/set the group rank (@pxref{Group Score}).
20740
20741 @item gnus-info-level
20742 @itemx gnus-info-set-level
20743 @findex gnus-info-level
20744 @findex gnus-info-set-level
20745 Get/set the group level.
20746
20747 @item gnus-info-score
20748 @itemx gnus-info-set-score
20749 @findex gnus-info-score
20750 @findex gnus-info-set-score
20751 Get/set the group score (@pxref{Group Score}).
20752
20753 @item gnus-info-read
20754 @itemx gnus-info-set-read
20755 @findex gnus-info-read
20756 @findex gnus-info-set-read
20757 Get/set the ranges of read articles.
20758
20759 @item gnus-info-marks
20760 @itemx gnus-info-set-marks
20761 @findex gnus-info-marks
20762 @findex gnus-info-set-marks
20763 Get/set the lists of ranges of marked articles.
20764
20765 @item gnus-info-method
20766 @itemx gnus-info-set-method
20767 @findex gnus-info-method
20768 @findex gnus-info-set-method
20769 Get/set the group select method.
20770
20771 @item gnus-info-params
20772 @itemx gnus-info-set-params
20773 @findex gnus-info-params
20774 @findex gnus-info-set-params
20775 Get/set the group parameters.
20776 @end table
20777
20778 All the getter functions take one parameter---the info list.  The setter
20779 functions take two parameters---the info list and the new value.
20780
20781 The last three elements in the group info aren't mandatory, so it may be
20782 necessary to extend the group info before setting the element.  If this
20783 is necessary, you can just pass on a non-@code{nil} third parameter to
20784 the three final setter functions to have this happen automatically.
20785
20786
20787 @node Extended Interactive
20788 @subsection Extended Interactive
20789 @cindex interactive
20790 @findex gnus-interactive
20791
20792 Gnus extends the standard Emacs @code{interactive} specification
20793 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
20794 Prefixes}).  Here's an example of how this is used:
20795
20796 @lisp
20797 (defun gnus-summary-increase-score (&optional score symp)
20798   (interactive (gnus-interactive "P\ny"))
20799   ...
20800   )
20801 @end lisp
20802
20803 The best thing to do would have been to implement
20804 @code{gnus-interactive} as a macro which would have returned an
20805 @code{interactive} form, but this isn't possible since Emacs checks
20806 whether a function is interactive or not by simply doing an @code{assq}
20807 on the lambda form.  So, instead we have @code{gnus-interactive}
20808 function that takes a string and returns values that are usable to
20809 @code{interactive}.
20810
20811 This function accepts (almost) all normal @code{interactive} specs, but
20812 adds a few more.
20813
20814 @table @samp
20815 @item y
20816 @vindex gnus-current-prefix-symbol
20817 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
20818 variable.
20819
20820 @item Y
20821 @vindex gnus-current-prefix-symbols
20822 A list of the current symbolic prefixes---the
20823 @code{gnus-current-prefix-symbol} variable.
20824
20825 @item A
20826 The current article number---the @code{gnus-summary-article-number}
20827 function.
20828
20829 @item H
20830 The current article header---the @code{gnus-summary-article-header}
20831 function.
20832
20833 @item g
20834 The current group name---the @code{gnus-group-group-name}
20835 function.
20836
20837 @end table
20838
20839
20840 @node Emacs/XEmacs Code
20841 @subsection Emacs/XEmacs Code
20842 @cindex XEmacs
20843 @cindex Emacsen
20844
20845 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
20846 platforms must be the primary one.  I chose Emacs.  Not because I don't
20847 like XEmacs or Mule, but because it comes first alphabetically.
20848
20849 This means that Gnus will byte-compile under Emacs with nary a warning,
20850 while XEmacs will pump out gigabytes of warnings while byte-compiling.
20851 As I use byte-compilation warnings to help me root out trivial errors in
20852 Gnus, that's very useful.
20853
20854 I've also consistently used Emacs function interfaces, but have used
20855 Gnusey aliases for the functions.  To take an example:  Emacs defines a
20856 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
20857 function.  I then define a function called @code{gnus-run-at-time} that
20858 takes the same parameters as the Emacs @code{run-at-time}.  When running
20859 Gnus under Emacs, the former function is just an alias for the latter.
20860 However, when running under XEmacs, the former is an alias for the
20861 following function:
20862
20863 @lisp
20864 (defun gnus-xmas-run-at-time (time repeat function &rest args)
20865   (start-itimer
20866    "gnus-run-at-time"
20867    `(lambda ()
20868       (,function ,@@args))
20869    time repeat))
20870 @end lisp
20871
20872 This sort of thing has been done for bunches of functions.  Gnus does
20873 not redefine any native Emacs functions while running under XEmacs---it
20874 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
20875 all over.
20876
20877 In the cases where the XEmacs function interface was obviously cleaner,
20878 I used it instead.  For example @code{gnus-region-active-p} is an alias
20879 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
20880
20881 Of course, I could have chosen XEmacs as my native platform and done
20882 mapping functions the other way around.  But I didn't.  The performance
20883 hit these indirections impose on Gnus under XEmacs should be slight.
20884
20885
20886 @node Various File Formats
20887 @subsection Various File Formats
20888
20889 @menu
20890 * Active File Format::      Information on articles and groups available.
20891 * Newsgroups File Format::  Group descriptions.
20892 @end menu
20893
20894
20895 @node Active File Format
20896 @subsubsection Active File Format
20897
20898 The active file lists all groups available on the server in
20899 question.  It also lists the highest and lowest current article numbers
20900 in each group.
20901
20902 Here's an excerpt from a typical active file:
20903
20904 @example
20905 soc.motss 296030 293865 y
20906 alt.binaries.pictures.fractals 3922 3913 n
20907 comp.sources.unix 1605 1593 m
20908 comp.binaries.ibm.pc 5097 5089 y
20909 no.general 1000 900 y
20910 @end example
20911
20912 Here's a pseudo-BNF definition of this file:
20913
20914 @example
20915 active      = *group-line
20916 group-line  = group space high-number space low-number space flag <NEWLINE>
20917 group       = <non-white-space string>
20918 space       = " "
20919 high-number = <non-negative integer>
20920 low-number  = <positive integer>
20921 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
20922 @end example
20923
20924 For a full description of this file, see the manual pages for
20925 @samp{innd}, in particular @samp{active(5)}.
20926
20927
20928 @node Newsgroups File Format
20929 @subsubsection Newsgroups File Format
20930
20931 The newsgroups file lists groups along with their descriptions.  Not all
20932 groups on the server have to be listed,  and not all groups in the file
20933 have to exist on the server.  The file is meant purely as information to
20934 the user.
20935
20936 The format is quite simple; a group name, a tab, and the description.
20937 Here's the definition:
20938
20939 @example
20940 newsgroups    = *line
20941 line          = group tab description <NEWLINE>
20942 group         = <non-white-space string>
20943 tab           = <TAB>
20944 description   = <string>
20945 @end example
20946
20947
20948 @page
20949 @node Emacs for Heathens
20950 @section Emacs for Heathens
20951
20952 Believe it or not, but some people who use Gnus haven't really used
20953 Emacs much before they embarked on their journey on the Gnus Love Boat.
20954 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
20955 region'', and ``set @code{gnus-flargblossen} to an alist where the key
20956 is a regexp that is used for matching on the group name'' are magical
20957 phrases with little or no meaning, then this appendix is for you.  If
20958 you are already familiar with Emacs, just ignore this and go fondle your
20959 cat instead.
20960
20961 @menu
20962 * Keystrokes::      Entering text and executing commands.
20963 * Emacs Lisp::      The built-in Emacs programming language.
20964 @end menu
20965
20966
20967 @node Keystrokes
20968 @subsection Keystrokes
20969
20970 @itemize @bullet
20971 @item
20972 Q: What is an experienced Emacs user?
20973
20974 @item
20975 A: A person who wishes that the terminal had pedals.
20976 @end itemize
20977
20978 Yes, when you use Emacs, you are apt to use the control key, the shift
20979 key and the meta key a lot.  This is very annoying to some people
20980 (notably @code{vi}le users), and the rest of us just love the hell out
20981 of it.  Just give up and submit.  Emacs really does stand for
20982 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
20983 may have heard from other disreputable sources (like the Emacs author).
20984
20985 The shift keys are normally located near your pinky fingers, and are
20986 normally used to get capital letters and stuff.  You probably use it all
20987 the time.  The control key is normally marked ``CTRL'' or something like
20988 that.  The meta key is, funnily enough, never marked as such on any
20989 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
20990 which is the meta key on this keyboard.  It's usually located somewhere
20991 to the left hand side of the keyboard, usually on the bottom row.
20992
20993 Now, us Emacs people don't say ``press the meta-control-m key'',
20994 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
20995 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
20996 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
20997 down the control key, and hold it down while you press @kbd{k}''.
20998 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
20999 the control key and then press @kbd{k}''.  Simple, ay?
21000
21001 This is somewhat complicated by the fact that not all keyboards have a
21002 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
21003 means ``press escape, release escape, press @kbd{k}''.  That's much more
21004 work than if you have a meta key, so if that's the case, I respectfully
21005 suggest you get a real keyboard with a meta key.  You can't live without
21006 it.
21007
21008
21009
21010 @node Emacs Lisp
21011 @subsection Emacs Lisp
21012
21013 Emacs is the King of Editors because it's really a Lisp interpreter.
21014 Each and every key you tap runs some Emacs Lisp code snippet, and since
21015 Emacs Lisp is an interpreted language, that means that you can configure
21016 any key to run any arbitrary code.  You just, like, do it.
21017
21018 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
21019 functions.  (These are byte-compiled for speed, but it's still
21020 interpreted.)  If you decide that you don't like the way Gnus does
21021 certain things, it's trivial to have it do something a different way.
21022 (Well, at least if you know how to write Lisp code.)  However, that's
21023 beyond the scope of this manual, so we are simply going to talk about
21024 some common constructs that you normally use in your @file{.emacs} file
21025 to customize Gnus.
21026
21027 If you want to set the variable @code{gnus-florgbnize} to four (4), you
21028 write the following:
21029
21030 @lisp
21031 (setq gnus-florgbnize 4)
21032 @end lisp
21033
21034 This function (really ``special form'') @code{setq} is the one that can
21035 set a variable to some value.  This is really all you need to know.  Now
21036 you can go and fill your @code{.emacs} file with lots of these to change
21037 how Gnus works.
21038
21039 If you have put that thing in your @code{.emacs} file, it will be read
21040 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
21041 start Emacs.  If you want to change the variable right away, simply say
21042 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
21043 previous ``form'', which is a simple @code{setq} statement here.
21044
21045 Go ahead---just try it, if you're located at your Emacs.  After you
21046 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
21047 is the return value of the form you @code{eval}ed.
21048
21049 Some pitfalls:
21050
21051 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
21052 that means:
21053
21054 @lisp
21055 (setq gnus-read-active-file 'some)
21056 @end lisp
21057
21058 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
21059 @samp{nntp.ifi.uio.no}'', that means:
21060
21061 @lisp
21062 (setq gnus-nntp-server "nntp.ifi.uio.no")
21063 @end lisp
21064
21065 So be careful not to mix up strings (the latter) with symbols (the
21066 former).  The manual is unambiguous, but it can be confusing.
21067
21068 @page
21069 @include gnus-faq.texi
21070
21071 @node Index
21072 @chapter Index
21073 @printindex cp
21074
21075 @node Key Index
21076 @chapter Key Index
21077 @printindex ky
21078
21079 @summarycontents
21080 @contents
21081 @bye
21082
21083 @iftex
21084 @iflatex
21085 \end{document}
21086 @end iflatex
21087 @end iftex
21088
21089 @c End: