Sync up with Pterodactyl Gnus v0.92.
[elisp/gnus.git-] / texi / gnus.texi
1 @c \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Semi-gnus 6.10.070 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.070 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.070.
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 groups 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 mechanism has very little to do with how
9944 they want to treat a message.
9945
9946 Many people subscribe to several mailing lists.  These are transported
9947 via SMTP, and are therefore mail.  But we might go for weeks without
9948 answering, or even reading these messages very carefully. We may not
9949 need to save them because if we should need to read one again, they are
9950 archived somewhere else.
9951
9952 Some people have local news groups which have only a handful of readers.
9953 These are transported via NNTP, and are therefore news.  But we may need
9954 to read and answer a large fraction of the messages very carefully in
9955 order to do our work.  And there may not be an archive, so we may need
9956 to save the interesting messages the same way we would personal mail.
9957
9958 The important distinction turns out to be not the transport mechanism,
9959 but other factors such as how interested we are in the subject matter,
9960 or how easy it is to retrieve the message if we need to read it again.
9961
9962 Gnus provides many options for sorting mail into ``groups'' which behave
9963 like newsgroups, and for treating each group (whether mail or news)
9964 differently.
9965
9966 Some users never get comfortable using the Gnus (ahem) paradigm and wish
9967 that Gnus should grow up and be a male, er, mail reader.  It is possible
9968 to whip Gnus into a more mailreaderly being, but, as said before, it's
9969 not easy.  People who prefer proper mail readers should try @sc{vm}
9970 instead, which is an excellent, and proper, mail reader.
9971
9972 I don't mean to scare anybody off, but I want to make it clear that you
9973 may be required to learn a new way of thinking about messages.  After
9974 you've been subjected to The Gnus Way, you will come to love it.  I can
9975 guarantee it.  (At least the guy who sold me the Emacs Subliminal
9976 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
9977 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
9978 You Do.)
9979
9980
9981 @node Getting Started Reading Mail
9982 @subsection Getting Started Reading Mail
9983
9984 It's quite easy to use Gnus to read your new mail.  You just plonk the
9985 mail backend of your choice into @code{gnus-secondary-select-methods},
9986 and things will happen automatically.
9987
9988 For instance, if you want to use @code{nnml} (which is a "one file per
9989 mail" backend), you could put the following in your @file{.gnus} file:
9990
9991 @lisp
9992 (setq gnus-secondary-select-methods
9993       '((nnml "private")))
9994 @end lisp
9995
9996 Now, the next time you start Gnus, this backend will be queried for new
9997 articles, and it will move all the messages in your spool file to its
9998 directory, which is @code{~/Mail/} by default.  The new group that will
9999 be created (@samp{mail.misc}) will be subscribed, and you can read it
10000 like any other group.
10001
10002 You will probably want to split the mail into several groups, though:
10003
10004 @lisp
10005 (setq nnmail-split-methods
10006       '(("junk" "^From:.*Lars Ingebrigtsen")
10007         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
10008         ("other" "")))
10009 @end lisp
10010
10011 This will result in three new @code{nnml} mail groups being created:
10012 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
10013 mail that doesn't fit into the first two groups will be placed in the
10014 last group.
10015
10016 This should be sufficient for reading mail with Gnus.  You might want to
10017 give the other sections in this part of the manual a perusal, though.
10018 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10019
10020
10021 @node Splitting Mail
10022 @subsection Splitting Mail
10023 @cindex splitting mail
10024 @cindex mail splitting
10025
10026 @vindex nnmail-split-methods
10027 The @code{nnmail-split-methods} variable says how the incoming mail is
10028 to be split into groups.
10029
10030 @lisp
10031 (setq nnmail-split-methods
10032   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10033     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10034     ("mail.other" "")))
10035 @end lisp
10036
10037 This variable is a list of lists, where the first element of each of
10038 these lists is the name of the mail group (they do not have to be called
10039 something beginning with @samp{mail}, by the way), and the second
10040 element is a regular expression used on the header of each mail to
10041 determine if it belongs in this mail group.  The first string may
10042 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10043 insert sub-expressions from the matched text.  For instance:
10044
10045 @lisp
10046 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10047 @end lisp
10048
10049 The second element can also be a function.  In that case, it will be
10050 called narrowed to the headers with the first element of the rule as the
10051 argument.  It should return a non-@code{nil} value if it thinks that the
10052 mail belongs in that group.
10053
10054 The last of these groups should always be a general one, and the regular
10055 expression should @emph{always} be @samp{} so that it matches any mails
10056 that haven't been matched by any of the other regexps.  (These rules are
10057 processed from the beginning of the alist toward the end.  The first
10058 rule to make a match will "win", unless you have crossposting enabled.
10059 In that case, all matching rules will "win".)
10060
10061 If you like to tinker with this yourself, you can set this variable to a
10062 function of your choice.  This function will be called without any
10063 arguments in a buffer narrowed to the headers of an incoming mail
10064 message.  The function should return a list of group names that it
10065 thinks should carry this mail message.
10066
10067 Note that the mail backends are free to maul the poor, innocent,
10068 incoming headers all they want to.  They all add @code{Lines} headers;
10069 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10070 @code{From<SPACE>} line to something else.
10071
10072 @vindex nnmail-crosspost
10073 The mail backends all support cross-posting.  If several regexps match,
10074 the mail will be ``cross-posted'' to all those groups.
10075 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
10076 that no articles are crossposted to the general (@samp{}) group.
10077
10078 @vindex nnmail-crosspost-link-function
10079 @cindex crosspost
10080 @cindex links
10081 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10082 the crossposted articles.  However, not all file systems support hard
10083 links.  If that's the case for you, set
10084 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
10085 variable is @code{add-name-to-file} by default.)
10086
10087 @kindex M-x nnmail-split-history
10088 @kindex nnmail-split-history
10089 If you wish to see where the previous mail split put the messages, you
10090 can use the @kbd{M-x nnmail-split-history} command.
10091
10092 Gnus gives you all the opportunity you could possibly want for shooting
10093 yourself in the foot.  Let's say you create a group that will contain
10094 all the mail you get from your boss.  And then you accidentally
10095 unsubscribe from the group.  Gnus will still put all the mail from your
10096 boss in the unsubscribed group, and so, when your boss mails you ``Have
10097 that report ready by Monday or you're fired!'', you'll never see it and,
10098 come Tuesday, you'll still believe that you're gainfully employed while
10099 you really should be out collecting empty bottles to save up for next
10100 month's rent money.
10101
10102
10103 @node Mail Sources
10104 @subsection Mail Sources
10105
10106 Mail can be gotten from many different sources---the mail spool, from a
10107 POP mail server, or from a procmail directory, for instance.
10108
10109 @menu
10110 * Mail Source Specifiers::       How to specify what a mail source is.
10111 * Mail Source Customization::    Some variables that influence things.
10112 * Fetching Mail::                Using the mail source specifiers.
10113 @end menu
10114
10115
10116 @node Mail Source Specifiers
10117 @subsubsection Mail Source Specifiers
10118 @cindex POP
10119 @cindex mail server
10120 @cindex procmail
10121 @cindex mail spool
10122 @cindex mail source
10123
10124 You tell Gnus how to fetch mail by setting @code{mail-sources}
10125 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
10126
10127 Here's an example:
10128
10129 @lisp
10130 (pop :server "pop3.mailserver.com" :user "myname")
10131 @end lisp
10132
10133 As can be observed, a mail source specifier is a list where the first
10134 element is a @dfn{mail source type}, followed by an arbitrary number of
10135 @dfn{keywords}.  Keywords that are not explicitly specified are given
10136 default values.
10137
10138 The following mail source types are available:
10139
10140 @table @code
10141 @item file
10142 Get mail from a single file; typically from the mail spool.
10143
10144 Keywords:
10145
10146 @table @code
10147 @item :path
10148 The path of the file.  Defaults to the value of the @code{MAIL}
10149 environment variable or @file{/usr/mail/spool/user-name}.
10150 @end table
10151
10152 An example file mail source:
10153
10154 @lisp
10155 (file :path "/usr/spool/mail/user-name")
10156 @end lisp
10157
10158 Or using the default path:
10159
10160 @lisp
10161 (file)
10162 @end lisp
10163
10164 @item directory
10165 Get mail from several files in a directory.  This is typically used when
10166 you have procmail split the incoming mail into several files.
10167
10168 Keywords:
10169
10170 @table @code
10171 @item :path
10172 The path of the directory where the files are.  There is no default
10173 value.
10174
10175 @item :suffix
10176 Only files ending with this suffix are used.  The default is
10177 @samp{.spool}.
10178
10179 @item :predicate
10180 Only files that have this predicate return non-@code{nil} are returned.
10181 The default is @code{identity}.  This is used as an additional
10182 filter---only files that have the right suffix @emph{and} satisfy this
10183 predicate are considered.
10184
10185 @item :prescript
10186 @itemx :postscript
10187 Script run before/after fetching mail.
10188
10189 @end table
10190
10191 An example directory mail source:
10192
10193 @lisp
10194 (directory :path "/home/user-name/procmail-dir/"
10195            :suffix ".prcml")
10196 @end lisp
10197
10198 @item pop
10199 Get mail from a POP server.
10200
10201 Keywords:
10202
10203 @table @code
10204 @item :server
10205 The name of the POP server.  The default is taken from the
10206 @code{MAILHOST} environment variable.
10207
10208 @item :port
10209 The port number of the POP server.  The default is @samp{pop3}.
10210
10211 @item :user
10212 The user name to give to the POP server.  The default is the login
10213 name.
10214
10215 @item :password
10216 The password to give to the POP server.  If not specified, the user is
10217 prompted.
10218
10219 @item :program
10220 The program to use to fetch mail from the POP server.  This is should be
10221 a @code{format}-like string.  Here's an example:
10222
10223 @example
10224 fetchmail %u@@%s -P %p %t
10225 @end example
10226
10227 The valid format specifier characters are:
10228
10229 @table @samp
10230 @item t
10231 The name of the file the mail is to be moved to.  This must always be
10232 included in this string.
10233
10234 @item s
10235 The name of the server.
10236
10237 @item P
10238 The port number of the server.
10239
10240 @item u
10241 The user name to use.
10242
10243 @item p
10244 The password to use.
10245 @end table
10246
10247 The values used for these specs are taken from the values you give the
10248 corresponding keywords.
10249
10250 @item :prescript
10251 A script to be run before fetching the mail.  The syntax is the same as
10252 the @code{:program} keyword.  This can also be a function to be run.
10253
10254 @item :postscript
10255 A script to be run after fetching the mail.  The syntax is the same as
10256 the @code{:program} keyword.  This can also be a function to be run.
10257
10258 @item :function
10259 The function to use to fetch mail from the POP server.  The function is
10260 called with one parameter---the name of the file where the mail should
10261 be moved to.
10262
10263 @item :authentication
10264 This can be either the symbol @code{password} or the symbol @code{apop}
10265 and says what authentication scheme to use.  The default is
10266 @code{password}.
10267
10268 @end table
10269
10270 If the @code{:program} and @code{:function} keywords aren't specified,
10271 @code{pop3-movemail} will be used.
10272
10273 Here are some examples.  Fetch from the default POP server, using the
10274 default user name, and default fetcher:
10275
10276 @lisp
10277 (pop)
10278 @end lisp
10279
10280 Fetch from a named server with a named user and password:
10281
10282 @lisp
10283 (pop :server "my.pop.server"
10284      :user "user-name" :password "secret")
10285 @end lisp
10286
10287 Use @samp{movemail} to move the mail:
10288
10289 @lisp
10290 (pop :program "movemail po:%u %t %p")
10291 @end lisp
10292
10293 @item maildir
10294 Get mail from a maildir. This is a type of mailbox currently only
10295 supported by qmail, where each file in a special directory contains
10296 exactly one mail.
10297
10298 Keywords:
10299
10300 @table @code
10301 @item :path
10302 The path of the directory where the mails are stored.  The default is
10303 @samp{~/Maildir/new}.
10304
10305 If you sometimes look at your mail through a pop3 daemon before fetching
10306 them with Gnus, you may also have to fetch your mails from the
10307 @code{cur} directory inside the maildir, like in the following example.
10308
10309 @end table
10310
10311 An example maildir mail source:
10312
10313 @lisp
10314 (maildir :path "/home/user-name/Maildir/cur")
10315 @end lisp
10316
10317 @end table
10318
10319
10320 @node Mail Source Customization
10321 @subsubsection Mail Source Customization
10322
10323 The following is a list of variables that influence how the mail is
10324 fetched.  You would normally not need to set or change any of these
10325 variables.
10326
10327 @table @code
10328 @item mail-source-crash-box
10329 @vindex mail-source-crash-box
10330 File where mail will be stored while processing it.  The default is
10331 @file{~/.emacs-mail-crash-box}.
10332
10333 @item mail-source-delete-incoming
10334 @vindex mail-source-delete-incoming
10335 If non-@code{nil}, delete incoming files after handling them.
10336
10337 @item mail-source-directory
10338 @vindex mail-source-directory
10339 Directory where files (if any) will be stored.  The default is
10340 @file{~/Mail/}.  At present, the only thing this is used for is to say
10341 where the incoming files will be stored if the previous variable is
10342 @code{nil}.
10343
10344 @item mail-source-default-file-modes
10345 @vindex mail-source-default-file-modes
10346 All new mail files will get this file mode.  The default is 384.
10347
10348 @end table
10349
10350
10351 @node Fetching Mail
10352 @subsubsection Fetching Mail
10353
10354 @vindex mail-sources
10355 @vindex nnmail-spool-file
10356 The way to actually tell Gnus where to get new mail from is to set
10357 @code{mail-sources} to a list of mail source specifiers
10358 (@pxref{Mail Source Specifiers}).
10359
10360 If this variable (and the obsolescent @code{nnmail-spool-file}) is
10361 @code{nil}, the mail backends will never attempt to fetch mail by
10362 themselves.
10363
10364 If you want to fetch mail both from your local spool as well as a POP
10365 mail server, you'd say something like:
10366
10367 @lisp
10368 (setq mail-sources
10369       '((file)
10370         (pop :server "pop3.mail.server"
10371              :password "secret")))
10372 @end lisp
10373
10374 Or, if you don't want to use any of the keyword defaults:
10375
10376 @lisp
10377 (setq mail-sources
10378       '((file :path "/var/spool/mail/user-name")
10379         (pop :server "pop3.mail.server"
10380              :user "user-name"
10381              :port "pop3"
10382              :password "secret")))
10383 @end lisp
10384
10385
10386 When you use a mail backend, Gnus will slurp all your mail from your
10387 inbox and plonk it down in your home directory.  Gnus doesn't move any
10388 mail if you're not using a mail backend---you have to do a lot of magic
10389 invocations first.  At the time when you have finished drawing the
10390 pentagram, lightened the candles, and sacrificed the goat, you really
10391 shouldn't be too surprised when Gnus moves your mail.
10392
10393
10394
10395 @node Mail Backend Variables
10396 @subsection Mail Backend Variables
10397
10398 These variables are (for the most part) pertinent to all the various
10399 mail backends.
10400
10401 @table @code
10402 @vindex nnmail-read-incoming-hook
10403 @item nnmail-read-incoming-hook
10404 The mail backends all call this hook after reading new mail.  You can
10405 use this hook to notify any mail watch programs, if you want to.
10406
10407 @vindex nnmail-split-hook
10408 @item nnmail-split-hook
10409 @findex article-decode-encoded-words
10410 @findex RFC1522 decoding
10411 @findex RFC2047 decoding
10412 Hook run in the buffer where the mail headers of each message is kept
10413 just before the splitting based on these headers is done.  The hook is
10414 free to modify the buffer contents in any way it sees fit---the buffer
10415 is discarded after the splitting has been done, and no changes performed
10416 in the buffer will show up in any files.
10417 @code{gnus-article-decode-encoded-words} is one likely function to add
10418 to this hook.
10419
10420 @vindex nnmail-pre-get-new-mail-hook
10421 @vindex nnmail-post-get-new-mail-hook
10422 @item nnmail-pre-get-new-mail-hook
10423 @itemx nnmail-post-get-new-mail-hook
10424 These are two useful hooks executed when treating new incoming
10425 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10426 starting to handle the new mail) and
10427 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10428 is done).  Here's and example of using these two hooks to change the
10429 default file modes the new mail files get:
10430
10431 @lisp
10432 (add-hook 'gnus-pre-get-new-mail-hook
10433           (lambda () (set-default-file-modes 511)))
10434
10435 (add-hook 'gnus-post-get-new-mail-hook
10436           (lambda () (set-default-file-modes 551)))
10437 @end lisp
10438
10439 @item nnmail-use-long-file-names
10440 @vindex nnmail-use-long-file-names
10441 If non-@code{nil}, the mail backends will use long file and directory
10442 names.  Groups like @samp{mail.misc} will end up in directories
10443 (assuming use of @code{nnml} backend) or files (assuming use of
10444 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
10445 the same group will end up in @file{mail/misc}.
10446
10447 @item nnmail-delete-file-function
10448 @vindex nnmail-delete-file-function
10449 @findex delete-file
10450 Function called to delete files.  It is @code{delete-file} by default.
10451
10452 @item nnmail-cache-accepted-message-ids
10453 @vindex nnmail-cache-accepted-message-ids
10454 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10455 the backend (via @code{Gcc}, for instance) into the mail duplication
10456 discovery cache.  The default is @code{nil}.
10457
10458 @end table
10459
10460
10461 @node Fancy Mail Splitting
10462 @subsection Fancy Mail Splitting
10463 @cindex mail splitting
10464 @cindex fancy mail splitting
10465
10466 @vindex nnmail-split-fancy
10467 @findex nnmail-split-fancy
10468 If the rather simple, standard method for specifying how to split mail
10469 doesn't allow you to do what you want, you can set
10470 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
10471 play with the @code{nnmail-split-fancy} variable.
10472
10473 Let's look at an example value of this variable first:
10474
10475 @lisp
10476 ;; Messages from the mailer daemon are not crossposted to any of
10477 ;; the ordinary groups.  Warnings are put in a separate group
10478 ;; from real errors.
10479 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10480                    "mail.misc"))
10481    ;; Non-error messages are crossposted to all relevant
10482    ;; groups, but we don't crosspost between the group for the
10483    ;; (ding) list and the group for other (ding) related mail.
10484    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10485          ("subject" "ding" "ding.misc"))
10486       ;; Other mailing lists...
10487       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10488       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10489       ;; Both lists below have the same suffix, so prevent
10490       ;; cross-posting to mkpkg.list of messages posted only to 
10491       ;; the bugs- list, but allow cross-posting when the
10492       ;; message was really cross-posted.
10493       (any "bugs-mypackage@@somewhere" "mypkg.bugs")
10494       (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
10495       ;; People...
10496       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10497    ;; Unmatched mail goes to the catch all group.
10498    "misc.misc")
10499 @end lisp
10500
10501 This variable has the format of a @dfn{split}.  A split is a (possibly)
10502 recursive structure where each split may contain other splits.  Here are
10503 the five possible split syntaxes:
10504
10505 @enumerate
10506
10507 @item
10508 @samp{group}: If the split is a string, that will be taken as a group
10509 name.  Normal regexp match expansion will be done.  See below for
10510 examples.
10511
10512 @item
10513 @var{(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT)}: If the split
10514 is a list, the first element of which is a string, then store the
10515 message as specified by SPLIT, if header FIELD (a regexp) contains VALUE
10516 (also a regexp).  If RESTRICT (yet another regexp) matches some string
10517 after FIELD and before the end of the matched VALUE, the SPLIT is
10518 ignored.  If none of the RESTRICT clauses match, SPLIT is processed.
10519
10520 @item
10521 @var{(| SPLIT...)}: If the split is a list, and the first element is
10522 @code{|} (vertical bar), then process each SPLIT until one of them
10523 matches.  A SPLIT is said to match if it will cause the mail message to
10524 be stored in one or more groups.
10525
10526 @item
10527 @var{(& SPLIT...)}: If the split is a list, and the first element is
10528 @code{&}, then process all SPLITs in the list.
10529
10530 @item
10531 @code{junk}: If the split is the symbol @code{junk}, then don't save
10532 this message. Use with extreme caution.
10533
10534 @item
10535 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
10536 element is @code{:}, then the second element will be called as a
10537 function with @var{args} given as arguments.  The function should return
10538 a SPLIT.
10539
10540 @item
10541 @var{(! FUNC SPLIT)}: If the split is a list, and the first element
10542 is @code{!}, then SPLIT will be processed, and FUNC will be called as a
10543 function with the result of SPLIT as argument. FUNC should return a split.
10544
10545 @item
10546 @code{nil}: If the split is @code{nil}, it is ignored.
10547
10548 @end enumerate
10549
10550 In these splits, @var{FIELD} must match a complete field name.
10551 @var{VALUE} must match a complete word according to the fundamental mode
10552 syntax table.  You can use @code{.*} in the regexps to match partial
10553 field names or words.  In other words, all @var{VALUE}'s are wrapped in
10554 @samp{\<} and @samp{\>} pairs.
10555
10556 @vindex nnmail-split-abbrev-alist
10557 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10558 are expanded as specified by the variable
10559 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
10560 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10561 value.
10562
10563 @vindex nnmail-split-fancy-syntax-table
10564 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10565 when all this splitting is performed.
10566
10567 If you want to have Gnus create groups dynamically based on some
10568 information in the headers (i.e., do @code{replace-match}-like
10569 substitutions in the group names), you can say things like:
10570
10571 @example
10572 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10573 @end example
10574
10575 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
10576 will be filed in @samp{mail.debian.foo}.
10577
10578 If the string contains the element @samp{\&}, then the previously
10579 matched string will be substituted.  Similarly, the elements @samp{\\1}
10580 up to @samp{\\9} will be substituted with the text matched by the
10581 groupings 1 through 9.
10582
10583
10584 @node Incorporating Old Mail
10585 @subsection Incorporating Old Mail
10586
10587 Most people have lots of old mail stored in various file formats.  If
10588 you have set up Gnus to read mail using one of the spiffy Gnus mail
10589 backends, you'll probably wish to have that old mail incorporated into
10590 your mail groups.
10591
10592 Doing so can be quite easy.
10593
10594 To take an example: You're reading mail using @code{nnml}
10595 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10596 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
10597 file filled with important, but old, mail.  You want to move it into
10598 your @code{nnml} groups.
10599
10600 Here's how:
10601
10602 @enumerate
10603 @item
10604 Go to the group buffer.
10605
10606 @item
10607 Type `G f' and give the path to the mbox file when prompted to create an
10608 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10609
10610 @item
10611 Type `SPACE' to enter the newly created group.
10612
10613 @item
10614 Type `M P b' to process-mark all articles in this group's buffer
10615 (@pxref{Setting Process Marks}).
10616
10617 @item
10618 Type `B r' to respool all the process-marked articles, and answer
10619 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10620 @end enumerate
10621
10622 All the mail messages in the mbox file will now also be spread out over
10623 all your @code{nnml} groups.  Try entering them and check whether things
10624 have gone without a glitch.  If things look ok, you may consider
10625 deleting the mbox file, but I wouldn't do that unless I was absolutely
10626 sure that all the mail has ended up where it should be.
10627
10628 Respooling is also a handy thing to do if you're switching from one mail
10629 backend to another.  Just respool all the mail in the old mail groups
10630 using the new mail backend.
10631
10632
10633 @node Expiring Mail
10634 @subsection Expiring Mail
10635 @cindex article expiry
10636
10637 Traditional mail readers have a tendency to remove mail articles when
10638 you mark them as read, in some way.  Gnus takes a fundamentally
10639 different approach to mail reading.
10640
10641 Gnus basically considers mail just to be news that has been received in
10642 a rather peculiar manner.  It does not think that it has the power to
10643 actually change the mail, or delete any mail messages.  If you enter a
10644 mail group, and mark articles as ``read'', or kill them in some other
10645 fashion, the mail articles will still exist on the system.  I repeat:
10646 Gnus will not delete your old, read mail.  Unless you ask it to, of
10647 course.
10648
10649 To make Gnus get rid of your unwanted mail, you have to mark the
10650 articles as @dfn{expirable}.  This does not mean that the articles will
10651 disappear right away, however.  In general, a mail article will be
10652 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10653 more than one week old.  If you do not mark an article as expirable, it
10654 will remain on your system until hell freezes over.  This bears
10655 repeating one more time, with some spurious capitalizations: IF you do
10656 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10657
10658 @vindex gnus-auto-expirable-newsgroups
10659 You do not have to mark articles as expirable by hand.  Groups that
10660 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10661 have all articles that you read marked as expirable automatically.  All
10662 articles marked as expirable have an @samp{E} in the first
10663 column in the summary buffer.
10664
10665 By default, if you have auto expiry switched on, Gnus will mark all the
10666 articles you read as expirable, no matter if they were read or unread
10667 before.  To avoid having articles marked as read marked as expirable
10668 automatically, you can put something like the following in your
10669 @file{.gnus} file:
10670
10671 @vindex gnus-mark-article-hook
10672 @lisp
10673 (remove-hook 'gnus-mark-article-hook
10674              'gnus-summary-mark-read-and-unread-as-read)
10675 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10676 @end lisp
10677
10678 Note that making a group auto-expirable doesn't mean that all read
10679 articles are expired---only the articles marked as expirable
10680 will be expired.  Also note that using the @kbd{d} command won't make
10681 groups expirable---only semi-automatic marking of articles as read will
10682 mark the articles as expirable in auto-expirable groups.
10683
10684 Let's say you subscribe to a couple of mailing lists, and you want the
10685 articles you have read to disappear after a while:
10686
10687 @lisp
10688 (setq gnus-auto-expirable-newsgroups
10689       "mail.nonsense-list\\|mail.nice-list")
10690 @end lisp
10691
10692 Another way to have auto-expiry happen is to have the element
10693 @code{auto-expire} in the group parameters of the group.
10694
10695 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10696 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
10697 don't really mix very well.
10698
10699 @vindex nnmail-expiry-wait
10700 The @code{nnmail-expiry-wait} variable supplies the default time an
10701 expirable article has to live.  Gnus starts counting days from when the
10702 message @emph{arrived}, not from when it was sent.  The default is seven
10703 days.
10704
10705 Gnus also supplies a function that lets you fine-tune how long articles
10706 are to live, based on what group they are in.  Let's say you want to
10707 have one month expiry period in the @samp{mail.private} group, a one day
10708 expiry period in the @samp{mail.junk} group, and a six day expiry period
10709 everywhere else:
10710
10711 @vindex nnmail-expiry-wait-function
10712 @lisp
10713 (setq nnmail-expiry-wait-function
10714       (lambda (group)
10715        (cond ((string= group "mail.private")
10716                31)
10717              ((string= group "mail.junk")
10718                1)
10719              ((string= group "important")
10720                'never)
10721              (t
10722                6))))
10723 @end lisp
10724
10725 The group names this function is fed are ``unadorned'' group
10726 names---no @samp{nnml:} prefixes and the like.
10727
10728 The @code{nnmail-expiry-wait} variable and
10729 @code{nnmail-expiry-wait-function} function can either be a number (not
10730 necessarily an integer) or one of the symbols @code{immediate} or
10731 @code{never}.
10732
10733 You can also use the @code{expiry-wait} group parameter to selectively
10734 change the expiry period (@pxref{Group Parameters}).
10735
10736 @vindex nnmail-keep-last-article
10737 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10738 expire the final article in a mail newsgroup.  This is to make life
10739 easier for procmail users.
10740
10741 @vindex gnus-total-expirable-newsgroups
10742 By the way: That line up there, about Gnus never expiring non-expirable
10743 articles, is a lie.  If you put @code{total-expire} in the group
10744 parameters, articles will not be marked as expirable, but all read
10745 articles will be put through the expiry process.  Use with extreme
10746 caution.  Even more dangerous is the
10747 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
10748 this regexp will have all read articles put through the expiry process,
10749 which means that @emph{all} old mail articles in the groups in question
10750 will be deleted after a while.  Use with extreme caution, and don't come
10751 crying to me when you discover that the regexp you used matched the
10752 wrong group and all your important mail has disappeared.  Be a
10753 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
10754 with!  So there!
10755
10756 Most people make most of their mail groups total-expirable, though.
10757
10758 @vindex gnus-inhibit-user-auto-expire
10759 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10760 commands will not mark an article as expirable, even if the group has
10761 auto-expire turned on.
10762
10763
10764 @node Washing Mail
10765 @subsection Washing Mail
10766 @cindex mail washing
10767 @cindex list server brain damage
10768 @cindex incoming mail treatment
10769
10770 Mailers and list servers are notorious for doing all sorts of really,
10771 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
10772 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10773 end of all lines passing through our server, so let's do that!!!!1!''
10774 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
10775 considered to be self-evident were not discussed.  So.  Here we are.
10776
10777 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
10778 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
10779 be shocked and dismayed by this, but I haven't got the energy.  It is to
10780 laugh.
10781
10782 Gnus provides a plethora of functions for washing articles while
10783 displaying them, but it might be nicer to do the filtering before
10784 storing the mail to disc.  For that purpose, we have three hooks and
10785 various functions that can be put in these hooks.
10786
10787 @table @code
10788 @item nnmail-prepare-incoming-hook
10789 @vindex nnmail-prepare-incoming-hook
10790 This hook is called before doing anything with the mail and is meant for
10791 grand, sweeping gestures.  It is called in a buffer that contains all
10792 the new, incoming mail.  Functions to be used include:
10793
10794 @table @code
10795 @item nnheader-ms-strip-cr
10796 @findex nnheader-ms-strip-cr
10797 Remove trailing carriage returns from each line.  This is default on
10798 Emacs running on MS machines.
10799
10800 @end table
10801
10802 @item nnmail-prepare-incoming-header-hook
10803 @vindex nnmail-prepare-incoming-header-hook
10804 This hook is called narrowed to each header.  It can be used when
10805 cleaning up the headers.  Functions that can be used include:
10806
10807 @table @code
10808 @item nnmail-remove-leading-whitespace
10809 @findex nnmail-remove-leading-whitespace
10810 Clear leading white space that ``helpful'' listservs have added to the
10811 headers to make them look nice.  Aaah.
10812
10813 @item nnmail-remove-list-identifiers
10814 @findex nnmail-remove-list-identifiers
10815 Some list servers add an identifier---for example, @samp{(idm)}---to the
10816 beginning of all @code{Subject} headers.  I'm sure that's nice for
10817 people who use stone age mail readers.  This function will remove
10818 strings that match the @code{nnmail-list-identifiers} regexp, which can
10819 also be a list of regexp.
10820
10821 For instance, if you want to remove the @samp{(idm)} and the
10822 @samp{nagnagnag} identifiers:
10823
10824 @lisp
10825 (setq nnmail-list-identifiers
10826       '("(idm)" "nagnagnag"))
10827 @end lisp
10828
10829 @item nnmail-remove-tabs
10830 @findex nnmail-remove-tabs
10831 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10832
10833 @item nnmail-fix-eudora-headers
10834 @findex nnmail-fix-eudora-headers
10835 @cindex Eudora
10836 Eudora produces broken @code{References} headers, but OK
10837 @code{In-Reply-To} headers.  This function will get rid of the
10838 @code{References} headers.
10839
10840 @end table
10841
10842 @item nnmail-prepare-incoming-message-hook
10843 @vindex nnmail-prepare-incoming-message-hook
10844 This hook is called narrowed to each message.  Functions to be used
10845 include:
10846
10847 @table @code
10848 @item article-de-quoted-unreadable
10849 @findex article-de-quoted-unreadable
10850 Decode Quoted Readable encoding.
10851
10852 @end table
10853 @end table
10854
10855
10856 @node Duplicates
10857 @subsection Duplicates
10858
10859 @vindex nnmail-treat-duplicates
10860 @vindex nnmail-message-id-cache-length
10861 @vindex nnmail-message-id-cache-file
10862 @cindex duplicate mails
10863 If you are a member of a couple of mailing lists, you will sometimes
10864 receive two copies of the same mail.  This can be quite annoying, so
10865 @code{nnmail} checks for and treats any duplicates it might find.  To do
10866 this, it keeps a cache of old @code{Message-ID}s---
10867 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10868 default.  The approximate maximum number of @code{Message-ID}s stored
10869 there is controlled by the @code{nnmail-message-id-cache-length}
10870 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10871 stored.) If all this sounds scary to you, you can set
10872 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10873 default), and @code{nnmail} won't delete duplicate mails.  Instead it
10874 will insert a warning into the head of the mail saying that it thinks
10875 that this is a duplicate of a different message.
10876
10877 This variable can also be a function.  If that's the case, the function
10878 will be called from a buffer narrowed to the message in question with
10879 the @code{Message-ID} as a parameter.  The function must return either
10880 @code{nil}, @code{warn}, or @code{delete}.
10881
10882 You can turn this feature off completely by setting the variable to
10883 @code{nil}.
10884
10885 If you want all the duplicate mails to be put into a special
10886 @dfn{duplicates} group, you could do that using the normal mail split
10887 methods:
10888
10889 @lisp
10890 (setq nnmail-split-fancy
10891       '(| ;; Messages duplicates go to a separate group.
10892           ("gnus-warning" "duplication of message" "duplicate")
10893           ;; Message from daemons, postmaster, and the like to another.
10894           (any mail "mail.misc")
10895           ;; Other rules.
10896           [ ... ] ))
10897 @end lisp
10898
10899 Or something like:
10900 @lisp
10901 (setq nnmail-split-methods
10902       '(("duplicates" "^Gnus-Warning:")
10903         ;; Other rules.
10904         [...]))
10905 @end lisp
10906
10907 Here's a neat feature: If you know that the recipient reads her mail
10908 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10909 @code{delete}, you can send her as many insults as you like, just by
10910 using a @code{Message-ID} of a mail that you know that she's already
10911 received.  Think of all the fun!  She'll never see any of it!  Whee!
10912
10913
10914 @node Not Reading Mail
10915 @subsection Not Reading Mail
10916
10917 If you start using any of the mail backends, they have the annoying
10918 habit of assuming that you want to read mail with them.  This might not
10919 be unreasonable, but it might not be what you want.
10920
10921 If you set @code{mail-sources} and @code{nnmail-spool-file} to
10922 @code{nil}, none of the backends will ever attempt to read incoming
10923 mail, which should help.
10924
10925 @vindex nnbabyl-get-new-mail
10926 @vindex nnmbox-get-new-mail
10927 @vindex nnml-get-new-mail
10928 @vindex nnmh-get-new-mail
10929 @vindex nnfolder-get-new-mail
10930 This might be too much, if, for instance, you are reading mail quite
10931 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10932 file you have stashed away with @code{nnbabyl}.  All backends have
10933 variables called backend-@code{get-new-mail}.  If you want to disable
10934 the @code{nnbabyl} mail reading, you edit the virtual server for the
10935 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10936
10937 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10938 narrowed to the article to be saved before saving it when reading
10939 incoming mail.
10940
10941
10942 @node Choosing a Mail Backend
10943 @subsection Choosing a Mail Backend
10944
10945 Gnus will read the mail spool when you activate a mail group.  The mail
10946 file is first copied to your home directory.  What happens after that
10947 depends on what format you want to store your mail in.
10948
10949 There are five different mail backends in the standard Gnus, and more
10950 backends are available separately.  The mail backend most people use
10951 (because it is the fastest and most flexible) is @code{nnml}
10952 (@pxref{Mail Spool}).
10953
10954 @menu
10955 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
10956 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
10957 * Mail Spool::                  Store your mail in a private spool?
10958 * MH Spool::                    An mhspool-like backend.
10959 * Mail Folders::                Having one file for each group.
10960 * Comparing Mail Backends::     An in-depth looks at pros and cons.
10961 @end menu
10962
10963
10964 @node Unix Mail Box
10965 @subsubsection Unix Mail Box
10966 @cindex nnmbox
10967 @cindex unix mail box
10968
10969 @vindex nnmbox-active-file
10970 @vindex nnmbox-mbox-file
10971 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10972 mail.  @code{nnmbox} will add extra headers to each mail article to say
10973 which group it belongs in.
10974
10975 Virtual server settings:
10976
10977 @table @code
10978 @item nnmbox-mbox-file
10979 @vindex nnmbox-mbox-file
10980 The name of the mail box in the user's home directory.
10981
10982 @item nnmbox-active-file
10983 @vindex nnmbox-active-file
10984 The name of the active file for the mail box.
10985
10986 @item nnmbox-get-new-mail
10987 @vindex nnmbox-get-new-mail
10988 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10989 into groups.
10990 @end table
10991
10992
10993 @node Rmail Babyl
10994 @subsubsection Rmail Babyl
10995 @cindex nnbabyl
10996 @cindex rmail mbox
10997
10998 @vindex nnbabyl-active-file
10999 @vindex nnbabyl-mbox-file
11000 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
11001 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
11002 article to say which group it belongs in.
11003
11004 Virtual server settings:
11005
11006 @table @code
11007 @item nnbabyl-mbox-file
11008 @vindex nnbabyl-mbox-file
11009 The name of the rmail mbox file.
11010
11011 @item nnbabyl-active-file
11012 @vindex nnbabyl-active-file
11013 The name of the active file for the rmail box.
11014
11015 @item nnbabyl-get-new-mail
11016 @vindex nnbabyl-get-new-mail
11017 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
11018 @end table
11019
11020
11021 @node Mail Spool
11022 @subsubsection Mail Spool
11023 @cindex nnml
11024 @cindex mail @sc{nov} spool
11025
11026 The @dfn{nnml} spool mail format isn't compatible with any other known
11027 format.  It should be used with some caution.
11028
11029 @vindex nnml-directory
11030 If you use this backend, Gnus will split all incoming mail into files,
11031 one file for each mail, and put the articles into the corresponding
11032 directories under the directory specified by the @code{nnml-directory}
11033 variable.  The default value is @file{~/Mail/}.
11034
11035 You do not have to create any directories beforehand; Gnus will take
11036 care of all that.
11037
11038 If you have a strict limit as to how many files you are allowed to store
11039 in your account, you should not use this backend.  As each mail gets its
11040 own file, you might very well occupy thousands of inodes within a few
11041 weeks.  If this is no problem for you, and it isn't a problem for you
11042 having your friendly systems administrator walking around, madly,
11043 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
11044 know that this is probably the fastest format to use.  You do not have
11045 to trudge through a big mbox file just to read your new mail.
11046
11047 @code{nnml} is probably the slowest backend when it comes to article
11048 splitting.  It has to create lots of files, and it also generates
11049 @sc{nov} databases for the incoming mails.  This makes it the fastest
11050 backend when it comes to reading mail.
11051
11052 Virtual server settings:
11053
11054 @table @code
11055 @item nnml-directory
11056 @vindex nnml-directory
11057 All @code{nnml} directories will be placed under this directory.
11058
11059 @item nnml-active-file
11060 @vindex nnml-active-file
11061 The active file for the @code{nnml} server.
11062
11063 @item nnml-newsgroups-file
11064 @vindex nnml-newsgroups-file
11065 The @code{nnml} group descriptions file.  @xref{Newsgroups File
11066 Format}.
11067
11068 @item nnml-get-new-mail
11069 @vindex nnml-get-new-mail
11070 If non-@code{nil}, @code{nnml} will read incoming mail.
11071
11072 @item nnml-nov-is-evil
11073 @vindex nnml-nov-is-evil
11074 If non-@code{nil}, this backend will ignore any @sc{nov} files.
11075
11076 @item nnml-nov-file-name
11077 @vindex nnml-nov-file-name
11078 The name of the @sc{nov} files.  The default is @file{.overview}.
11079
11080 @item nnml-prepare-save-mail-hook
11081 @vindex nnml-prepare-save-mail-hook
11082 Hook run narrowed to an article before saving.
11083
11084 @end table
11085
11086 @findex nnml-generate-nov-databases
11087 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
11088 you can do a complete update by typing @kbd{M-x
11089 nnml-generate-nov-databases}.  This command will trawl through the
11090 entire @code{nnml} hierarchy, looking at each and every article, so it
11091 might take a while to complete.  A better interface to this
11092 functionality can be found in the server buffer (@pxref{Server
11093 Commands}).
11094
11095
11096 @node MH Spool
11097 @subsubsection MH Spool
11098 @cindex nnmh
11099 @cindex mh-e mail spool
11100
11101 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
11102 @sc{nov} databases and it doesn't keep an active file.  This makes
11103 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
11104 makes it easier to write procmail scripts for.
11105
11106 Virtual server settings:
11107
11108 @table @code
11109 @item nnmh-directory
11110 @vindex nnmh-directory
11111 All @code{nnmh} directories will be located under this directory.
11112
11113 @item nnmh-get-new-mail
11114 @vindex nnmh-get-new-mail
11115 If non-@code{nil}, @code{nnmh} will read incoming mail.
11116
11117 @item nnmh-be-safe
11118 @vindex nnmh-be-safe
11119 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
11120 sure that the articles in the folder are actually what Gnus thinks they
11121 are.  It will check date stamps and stat everything in sight, so
11122 setting this to @code{t} will mean a serious slow-down.  If you never
11123 use anything but Gnus to read the @code{nnmh} articles, you do not have
11124 to set this variable to @code{t}.
11125 @end table
11126
11127
11128 @node Mail Folders
11129 @subsubsection Mail Folders
11130 @cindex nnfolder
11131 @cindex mbox folders
11132 @cindex mail folders
11133
11134 @code{nnfolder} is a backend for storing each mail group in a separate
11135 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
11136 will add extra headers to keep track of article numbers and arrival
11137 dates.
11138
11139 Virtual server settings:
11140
11141 @table @code
11142 @item nnfolder-directory
11143 @vindex nnfolder-directory
11144 All the @code{nnfolder} mail boxes will be stored under this directory.
11145
11146 @item nnfolder-active-file
11147 @vindex nnfolder-active-file
11148 The name of the active file.
11149
11150 @item nnfolder-newsgroups-file
11151 @vindex nnfolder-newsgroups-file
11152 The name of the group descriptions file.  @xref{Newsgroups File Format}.
11153
11154 @item nnfolder-get-new-mail
11155 @vindex nnfolder-get-new-mail
11156 If non-@code{nil}, @code{nnfolder} will read incoming mail.
11157
11158 @item nnfolder-save-buffer-hook
11159 @vindex nnfolder-save-buffer-hook
11160 @cindex backup files
11161 Hook run before saving the folders.  Note that Emacs does the normal
11162 backup renaming of files even with the @code{nnfolder} buffers.  If you
11163 wish to switch this off, you could say something like the following in
11164 your @file{.emacs} file:
11165
11166 @lisp
11167 (defun turn-off-backup ()
11168   (set (make-local-variable 'backup-inhibited) t))
11169
11170 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
11171 @end lisp
11172
11173 @item nnfolder-delete-mail-hook
11174 @vindex nnfolder-delete-mail-hook
11175 Hook run in a buffer narrowed to the message that is to be deleted.
11176 This function can be used to copy the message to somewhere else, or to
11177 extract some information from it before removing it.
11178
11179 @end table
11180
11181
11182 @findex nnfolder-generate-active-file
11183 @kindex M-x nnfolder-generate-active-file
11184 If you have lots of @code{nnfolder}-like files you'd like to read with
11185 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11186 command to make @code{nnfolder} aware of all likely files in
11187 @code{nnfolder-directory}.  This only works if you use long file names,
11188 though.
11189
11190 @node Comparing Mail Backends
11191 @subsubsection Comparing Mail Backends
11192
11193 First, just for terminology, the @dfn{backend} is the common word for a
11194 low-level access method---a transport, if you will, by which something
11195 is acquired.  The sense is that one's mail has to come from somewhere,
11196 and so selection of a suitable backend is required in order to get that
11197 mail within spitting distance of Gnus.
11198
11199 The same concept exists for Usenet itself: Though access to articles is
11200 typically done by NNTP these days, once upon a midnight dreary, everyone
11201 in the world got at Usenet by running a reader on the machine where the
11202 articles lay (the machine which today we call an NNTP server), and
11203 access was by the reader stepping into the articles' directory spool
11204 area directly.  One can still select between either the @code{nntp} or
11205 @code{nnspool} backends, to select between these methods, if one happens
11206 actually to live on the server (or can see its spool directly, anyway,
11207 via NFS).
11208
11209 The goal in selecting a mail backend is to pick one which
11210 simultaneously represents a suitable way of dealing with the original
11211 format plus leaving mail in a form that is convenient to use in the
11212 future.  Here are some high and low points on each:
11213
11214 @table @code
11215 @item nnmbox
11216
11217 UNIX systems have historically had a single, very common, and well-
11218 defined format.  All messages arrive in a single @dfn{spool file}, and
11219 they are delineated by a line whose regular expression matches
11220 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
11221 to make it clear in this instance that this is not the RFC-specified
11222 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
11223 historically from the Unix environment, it is simplest if one does not
11224 mess a great deal with the original mailbox format, so if one chooses
11225 this backend, Gnus' primary activity in getting mail from the real spool
11226 area to Gnus' preferred directory is simply to copy it, with no
11227 (appreciable) format change in the process.  It is the ``dumbest'' way
11228 to move mail into availability in the Gnus environment.  This makes it
11229 fast to move into place, but slow to parse, when Gnus has to look at
11230 what's where.
11231
11232 @item nnbabyl
11233
11234 Once upon a time, there was the DEC-10 and DEC-20, running operating
11235 systems called TOPS and related things, and the usual (only?) mail
11236 reading environment was a thing called Babyl.  I don't know what format
11237 was used for mail landing on the system, but Babyl had its own internal
11238 format to which mail was converted, primarily involving creating a
11239 spool-file-like entity with a scheme for inserting Babyl-specific
11240 headers and status bits above the top of each message in the file.
11241 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
11242 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
11243 to understand the mail files folks already had in existence.  Gnus (and
11244 VM, for that matter) continue to support this format because it's
11245 perceived as having some good qualities in those mailer-specific
11246 headers/status bits stuff.  RMAIL itself still exists as well, of
11247 course, and is still maintained by Stallman.
11248
11249 Both of the above forms leave your mail in a single file on your
11250 filesystem, and they must parse that entire file each time you take a
11251 look at your mail.
11252
11253 @item nnml
11254
11255 @code{nnml} is the backend which smells the most as though you were
11256 actually operating with an @code{nnspool}-accessed Usenet system.  (In
11257 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
11258 lo these years ago.)  One's mail is taken from the original spool file,
11259 and is then cut up into individual message files, 1:1.  It maintains a
11260 Usenet-style active file (analogous to what one finds in an INN- or
11261 CNews-based news system in (for instance) @file{/var/lib/news/active},
11262 or what is returned via the @samp{NNTP LIST} verb) and also creates
11263 @dfn{overview} files for efficient group entry, as has been defined for
11264 @sc{nntp} servers for some years now.  It is slower in mail-splitting,
11265 due to the creation of lots of files, updates to the @code{nnml} active
11266 file, and additions to overview files on a per-message basis, but it is
11267 extremely fast on access because of what amounts to the indexing support
11268 provided by the active file and overviews.
11269
11270 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
11271 resource which defines available places in the filesystem to put new
11272 files.  Sysadmins take a dim view of heavy inode occupation within
11273 tight, shared filesystems.  But if you live on a personal machine where
11274 the filesystem is your own and space is not at a premium, @code{nnml}
11275 wins big.
11276
11277 It is also problematic using this backend if you are living in a
11278 FAT16-based Windows world, since much space will be wasted on all these
11279 tiny files.
11280
11281 @item nnmh
11282
11283 The Rand MH mail-reading system has been around UNIX systems for a very
11284 long time; it operates by splitting one's spool file of messages into
11285 individual files, but with little or no indexing support -- @code{nnmh}
11286 is considered to be semantically equivalent to ``@code{nnml} without
11287 active file or overviews''.  This is arguably the worst choice, because
11288 one gets the slowness of individual file creation married to the
11289 slowness of access parsing when learning what's new in one's groups.
11290
11291 @item nnfolder
11292
11293 Basically the effetc of @code{nnfolder} is @code{nnmbox} (the first
11294 method described above) on a per-group basis.  That is, @code{nnmbox}
11295 itself puts *all* one's mail in one file; @code{nnfolder} provides a
11296 little bit of optimization to this so that each of one's mail groups has
11297 a Unix mail box file.  It's faster than @code{nnmbox} because each group
11298 can be parsed separately, and still provides the simple Unix mail box
11299 format requiring minimal effort in moving the mail around.  In addition, 
11300 it maintains an ``active'' file making it much faster for Gnus to figure 
11301 out how many messages there are in each separate group.
11302
11303 If you have groups that are expected to have a massive amount of
11304 messages, @code{nnfolder} is not the best choice, but if you receive
11305 only a moderate amount of mail, @code{nnfolder} is probably the most
11306 friendly mail backend all over.
11307
11308 @end table
11309
11310
11311
11312 @node Other Sources
11313 @section Other Sources
11314
11315 Gnus can do more than just read news or mail.  The methods described
11316 below allow Gnus to view directories and files as if they were
11317 newsgroups.
11318
11319 @menu
11320 * Directory Groups::      You can read a directory as if it was a newsgroup.
11321 * Anything Groups::       Dired?  Who needs dired?
11322 * Document Groups::       Single files can be the basis of a group.
11323 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
11324 * Web Searches::          Creating groups from articles that match a string.
11325 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
11326 @end menu
11327
11328
11329 @node Directory Groups
11330 @subsection Directory Groups
11331 @cindex nndir
11332 @cindex directory groups
11333
11334 If you have a directory that has lots of articles in separate files in
11335 it, you might treat it as a newsgroup.  The files have to have numerical
11336 names, of course.
11337
11338 This might be an opportune moment to mention @code{ange-ftp} (and its
11339 successor @code{efs}), that most wonderful of all wonderful Emacs
11340 packages.  When I wrote @code{nndir}, I didn't think much about it---a
11341 backend to read directories.  Big deal.
11342
11343 @code{ange-ftp} changes that picture dramatically.  For instance, if you
11344 enter the @code{ange-ftp} file name
11345 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11346 @code{ange-ftp} or @code{efs} will actually allow you to read this
11347 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
11348
11349 @code{nndir} will use @sc{nov} files if they are present.
11350
11351 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11352 articles with this method.  You can use @code{nnmh} or @code{nnml} for
11353 whatever you use @code{nndir} for, so you could switch to any of those
11354 methods if you feel the need to have a non-read-only @code{nndir}.
11355
11356
11357 @node Anything Groups
11358 @subsection Anything Groups
11359 @cindex nneething
11360
11361 From the @code{nndir} backend (which reads a single spool-like
11362 directory), it's just a hop and a skip to @code{nneething}, which
11363 pretends that any arbitrary directory is a newsgroup.  Strange, but
11364 true.
11365
11366 When @code{nneething} is presented with a directory, it will scan this
11367 directory and assign article numbers to each file.  When you enter such
11368 a group, @code{nneething} must create ``headers'' that Gnus can use.
11369 After all, Gnus is a newsreader, in case you're
11370 forgetting. @code{nneething} does this in a two-step process.  First, it
11371 snoops each file in question.  If the file looks like an article (i.e.,
11372 the first few lines look like headers), it will use this as the head.
11373 If this is just some arbitrary file without a head (e.g. a C source
11374 file), @code{nneething} will cobble up a header out of thin air.  It
11375 will use file ownership, name and date and do whatever it can with these
11376 elements.
11377
11378 All this should happen automatically for you, and you will be presented
11379 with something that looks very much like a newsgroup.  Totally like a
11380 newsgroup, to be precise.  If you select an article, it will be displayed
11381 in the article buffer, just as usual.
11382
11383 If you select a line that represents a directory, Gnus will pop you into
11384 a new summary buffer for this @code{nneething} group.  And so on.  You can
11385 traverse the entire disk this way, if you feel like, but remember that
11386 Gnus is not dired, really, and does not intend to be, either.
11387
11388 There are two overall modes to this action---ephemeral or solid.  When
11389 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11390 will not store information on what files you have read, and what files
11391 are new, and so on.  If you create a solid @code{nneething} group the
11392 normal way with @kbd{G m}, Gnus will store a mapping table between
11393 article numbers and file names, and you can treat this group like any
11394 other groups.  When you activate a solid @code{nneething} group, you will
11395 be told how many unread articles it contains, etc., etc.
11396
11397 Some variables:
11398
11399 @table @code
11400 @item nneething-map-file-directory
11401 @vindex nneething-map-file-directory
11402 All the mapping files for solid @code{nneething} groups will be stored
11403 in this directory, which defaults to @file{~/.nneething/}.
11404
11405 @item nneething-exclude-files
11406 @vindex nneething-exclude-files
11407 All files that match this regexp will be ignored.  Nice to use to exclude
11408 auto-save files and the like, which is what it does by default.
11409
11410 @item nneething-include-files
11411 @vindex nneething-include-files
11412 Regexp saying what files to include in the group.  If this variable is
11413 non-@code{nil}, only files matching this regexp will be included.
11414
11415 @item nneething-map-file
11416 @vindex nneething-map-file
11417 Name of the map files.
11418 @end table
11419
11420
11421 @node Document Groups
11422 @subsection Document Groups
11423 @cindex nndoc
11424 @cindex documentation group
11425 @cindex help group
11426
11427 @code{nndoc} is a cute little thing that will let you read a single file
11428 as a newsgroup.  Several files types are supported:
11429
11430 @table @code
11431 @cindex babyl
11432 @cindex rmail mbox
11433
11434 @item babyl
11435 The babyl (rmail) mail box.
11436 @cindex mbox
11437 @cindex Unix mbox
11438
11439 @item mbox
11440 The standard Unix mbox file.
11441
11442 @cindex MMDF mail box
11443 @item mmdf
11444 The MMDF mail box format.
11445
11446 @item news
11447 Several news articles appended into a file.
11448
11449 @item rnews
11450 @cindex rnews batch files
11451 The rnews batch transport format.
11452 @cindex forwarded messages
11453
11454 @item forward
11455 Forwarded articles.
11456
11457 @item nsmail
11458 Netscape mail boxes.
11459
11460 @item mime-parts
11461 MIME multipart messages.
11462
11463 @item standard-digest
11464 The standard (RFC 1153) digest format.
11465
11466 @item slack-digest
11467 Non-standard digest format---matches most things, but does it badly.
11468 @end table
11469
11470 You can also use the special ``file type'' @code{guess}, which means
11471 that @code{nndoc} will try to guess what file type it is looking at.
11472 @code{digest} means that @code{nndoc} should guess what digest type the
11473 file is.
11474
11475 @code{nndoc} will not try to change the file or insert any extra headers into
11476 it---it will simply, like, let you use the file as the basis for a
11477 group.  And that's it.
11478
11479 If you have some old archived articles that you want to insert into your
11480 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
11481 that.  Say you have an old @file{RMAIL} file with mail that you now want
11482 to split into your new @code{nnml} groups.  You look at that file using
11483 @code{nndoc} (using the @kbd{G f} command in the group buffer
11484 (@pxref{Foreign Groups})), set the process mark on all the articles in
11485 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
11486 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
11487 file is now also stored in lots of @code{nnml} directories, and you can
11488 delete that pesky @file{RMAIL} file.  If you have the guts!
11489
11490 Virtual server variables:
11491
11492 @table @code
11493 @item nndoc-article-type
11494 @vindex nndoc-article-type
11495 This should be one of @code{mbox}, @code{babyl}, @code{digest},
11496 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
11497 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
11498 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
11499
11500 @item nndoc-post-type
11501 @vindex nndoc-post-type
11502 This variable says whether Gnus is to consider the group a news group or
11503 a mail group.  There are two valid values:  @code{mail} (the default)
11504 and @code{news}.
11505 @end table
11506
11507 @menu
11508 * Document Server Internals::   How to add your own document types.
11509 @end menu
11510
11511
11512 @node Document Server Internals
11513 @subsubsection Document Server Internals
11514
11515 Adding new document types to be recognized by @code{nndoc} isn't
11516 difficult.  You just have to whip up a definition of what the document
11517 looks like, write a predicate function to recognize that document type,
11518 and then hook into @code{nndoc}.
11519
11520 First, here's an example document type definition:
11521
11522 @example
11523 (mmdf
11524  (article-begin .  "^\^A\^A\^A\^A\n")
11525  (body-end .  "^\^A\^A\^A\^A\n"))
11526 @end example
11527
11528 The definition is simply a unique @dfn{name} followed by a series of
11529 regexp pseudo-variable settings.  Below are the possible
11530 variables---don't be daunted by the number of variables; most document
11531 types can be defined with very few settings:
11532
11533 @table @code
11534 @item first-article
11535 If present, @code{nndoc} will skip past all text until it finds
11536 something that match this regexp.  All text before this will be
11537 totally ignored.
11538
11539 @item article-begin
11540 This setting has to be present in all document type definitions.  It
11541 says what the beginning of each article looks like.
11542
11543 @item head-begin-function
11544 If present, this should be a function that moves point to the head of
11545 the article.
11546
11547 @item nndoc-head-begin
11548 If present, this should be a regexp that matches the head of the
11549 article.
11550
11551 @item nndoc-head-end
11552 This should match the end of the head of the article.  It defaults to
11553 @samp{^$}---the empty line.
11554
11555 @item body-begin-function
11556 If present, this function should move point to the beginning of the body
11557 of the article.
11558
11559 @item body-begin
11560 This should match the beginning of the body of the article.  It defaults
11561 to @samp{^\n}.
11562
11563 @item body-end-function
11564 If present, this function should move point to the end of the body of
11565 the article.
11566
11567 @item body-end
11568 If present, this should match the end of the body of the article.
11569
11570 @item file-end
11571 If present, this should match the end of the file.  All text after this
11572 regexp will be totally ignored.
11573
11574 @end table
11575
11576 So, using these variables @code{nndoc} is able to dissect a document
11577 file into a series of articles, each with a head and a body.  However, a
11578 few more variables are needed since not all document types are all that
11579 news-like---variables needed to transform the head or the body into
11580 something that's palatable for Gnus:
11581
11582 @table @code
11583 @item prepare-body-function
11584 If present, this function will be called when requesting an article.  It
11585 will be called with point at the start of the body, and is useful if the
11586 document has encoded some parts of its contents.
11587
11588 @item article-transform-function
11589 If present, this function is called when requesting an article.  It's
11590 meant to be used for more wide-ranging transformation of both head and
11591 body of the article.
11592
11593 @item generate-head-function
11594 If present, this function is called to generate a head that Gnus can
11595 understand.  It is called with the article number as a parameter, and is
11596 expected to generate a nice head for the article in question.  It is
11597 called when requesting the headers of all articles.
11598
11599 @end table
11600
11601 Let's look at the most complicated example I can come up with---standard
11602 digests:
11603
11604 @example
11605 (standard-digest
11606  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11607  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11608  (prepare-body-function . nndoc-unquote-dashes)
11609  (body-end-function . nndoc-digest-body-end)
11610  (head-end . "^ ?$")
11611  (body-begin . "^ ?\n")
11612  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11613  (subtype digest guess))
11614 @end example
11615
11616 We see that all text before a 70-width line of dashes is ignored; all
11617 text after a line that starts with that @samp{^End of} is also ignored;
11618 each article begins with a 30-width line of dashes; the line separating
11619 the head from the body may contain a single space; and that the body is
11620 run through @code{nndoc-unquote-dashes} before being delivered.
11621
11622 To hook your own document definition into @code{nndoc}, use the
11623 @code{nndoc-add-type} function.  It takes two parameters---the first is
11624 the definition itself and the second (optional) parameter says where in
11625 the document type definition alist to put this definition.  The alist is
11626 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
11627 is of @code{mmdf} type, and so on.  These type predicates should return
11628 @code{nil} if the document is not of the correct type; @code{t} if it is
11629 of the correct type; and a number if the document might be of the
11630 correct type.  A high number means high probability; a low number means
11631 low probability with @samp{0} being the lowest valid number.
11632
11633
11634 @node SOUP
11635 @subsection SOUP
11636 @cindex SOUP
11637 @cindex offline
11638
11639 In the PC world people often talk about ``offline'' newsreaders.  These
11640 are thingies that are combined reader/news transport monstrosities.
11641 With built-in modem programs.  Yecchh!
11642
11643 Of course, us Unix Weenie types of human beans use things like
11644 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11645 transport things like Ghod intended.  And then we just use normal
11646 newsreaders.
11647
11648 However, it can sometimes be convenient to do something a that's a bit
11649 easier on the brain if you have a very slow modem, and you're not really
11650 that interested in doing things properly.
11651
11652 A file format called @sc{soup} has been developed for transporting news
11653 and mail from servers to home machines and back again.  It can be a bit
11654 fiddly.
11655
11656 First some terminology:
11657
11658 @table @dfn
11659
11660 @item server
11661 This is the machine that is connected to the outside world and where you
11662 get news and/or mail from.
11663
11664 @item home machine
11665 This is the machine that you want to do the actual reading and responding
11666 on.  It is typically not connected to the rest of the world in any way.
11667
11668 @item packet
11669 Something that contains messages and/or commands.  There are two kinds
11670 of packets:
11671
11672 @table @dfn
11673 @item message packets
11674 These are packets made at the server, and typically contain lots of
11675 messages for you to read.  These are called @file{SoupoutX.tgz} by
11676 default, where @var{X} is a number.
11677
11678 @item response packets
11679 These are packets made at the home machine, and typically contains
11680 replies that you've written.  These are called @file{SoupinX.tgz} by
11681 default, where @var{X} is a number.
11682
11683 @end table
11684
11685 @end table
11686
11687
11688 @enumerate
11689
11690 @item
11691 You log in on the server and create a @sc{soup} packet.  You can either
11692 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11693 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11694 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11695
11696 @item
11697 You transfer the packet home.  Rail, boat, car or modem will do fine.
11698
11699 @item
11700 You put the packet in your home directory.
11701
11702 @item
11703 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11704 the native or secondary server.
11705
11706 @item
11707 You read articles and mail and answer and followup to the things you
11708 want (@pxref{SOUP Replies}).
11709
11710 @item
11711 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11712 packet.
11713
11714 @item
11715 You transfer this packet to the server.
11716
11717 @item
11718 You use Gnus to mail this packet out with the @kbd{G s s} command.
11719
11720 @item
11721 You then repeat until you die.
11722
11723 @end enumerate
11724
11725 So you basically have a bipartite system---you use @code{nnsoup} for
11726 reading and Gnus for packing/sending these @sc{soup} packets.
11727
11728 @menu
11729 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
11730 * SOUP Groups::       A backend for reading @sc{soup} packets.
11731 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
11732 @end menu
11733
11734
11735 @node SOUP Commands
11736 @subsubsection SOUP Commands
11737
11738 These are commands for creating and manipulating @sc{soup} packets.
11739
11740 @table @kbd
11741 @item G s b
11742 @kindex G s b (Group)
11743 @findex gnus-group-brew-soup
11744 Pack all unread articles in the current group
11745 (@code{gnus-group-brew-soup}).  This command understands the
11746 process/prefix convention.
11747
11748 @item G s w
11749 @kindex G s w (Group)
11750 @findex gnus-soup-save-areas
11751 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11752
11753 @item G s s
11754 @kindex G s s (Group)
11755 @findex gnus-soup-send-replies
11756 Send all replies from the replies packet
11757 (@code{gnus-soup-send-replies}).
11758
11759 @item G s p
11760 @kindex G s p (Group)
11761 @findex gnus-soup-pack-packet
11762 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11763
11764 @item G s r
11765 @kindex G s r (Group)
11766 @findex nnsoup-pack-replies
11767 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11768
11769 @item O s
11770 @kindex O s (Summary)
11771 @findex gnus-soup-add-article
11772 This summary-mode command adds the current article to a @sc{soup} packet
11773 (@code{gnus-soup-add-article}).  It understands the process/prefix
11774 convention (@pxref{Process/Prefix}).
11775
11776 @end table
11777
11778
11779 There are a few variables to customize where Gnus will put all these
11780 thingies:
11781
11782 @table @code
11783
11784 @item gnus-soup-directory
11785 @vindex gnus-soup-directory
11786 Directory where Gnus will save intermediate files while composing
11787 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
11788
11789 @item gnus-soup-replies-directory
11790 @vindex gnus-soup-replies-directory
11791 This is what Gnus will use as a temporary directory while sending our
11792 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
11793
11794 @item gnus-soup-prefix-file
11795 @vindex gnus-soup-prefix-file
11796 Name of the file where Gnus stores the last used prefix.  The default is
11797 @samp{gnus-prefix}.
11798
11799 @item gnus-soup-packer
11800 @vindex gnus-soup-packer
11801 A format string command for packing a @sc{soup} packet.  The default is
11802 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11803
11804 @item gnus-soup-unpacker
11805 @vindex gnus-soup-unpacker
11806 Format string command for unpacking a @sc{soup} packet.  The default is
11807 @samp{gunzip -c %s | tar xvf -}.
11808
11809 @item gnus-soup-packet-directory
11810 @vindex gnus-soup-packet-directory
11811 Where Gnus will look for reply packets.  The default is @file{~/}.
11812
11813 @item gnus-soup-packet-regexp
11814 @vindex gnus-soup-packet-regexp
11815 Regular expression matching @sc{soup} reply packets in
11816 @code{gnus-soup-packet-directory}.
11817
11818 @end table
11819
11820
11821 @node SOUP Groups
11822 @subsubsection @sc{soup} Groups
11823 @cindex nnsoup
11824
11825 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
11826 read incoming packets, unpack them, and put them in a directory where
11827 you can read them at leisure.
11828
11829 These are the variables you can use to customize its behavior:
11830
11831 @table @code
11832
11833 @item nnsoup-tmp-directory
11834 @vindex nnsoup-tmp-directory
11835 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11836 directory.  (@file{/tmp/} by default.)
11837
11838 @item nnsoup-directory
11839 @vindex nnsoup-directory
11840 @code{nnsoup} then moves each message and index file to this directory.
11841 The default is @file{~/SOUP/}.
11842
11843 @item nnsoup-replies-directory
11844 @vindex nnsoup-replies-directory
11845 All replies will be stored in this directory before being packed into a
11846 reply packet.  The default is @file{~/SOUP/replies/"}.
11847
11848 @item nnsoup-replies-format-type
11849 @vindex nnsoup-replies-format-type
11850 The @sc{soup} format of the replies packets.  The default is @samp{?n}
11851 (rnews), and I don't think you should touch that variable.  I probably
11852 shouldn't even have documented it.  Drats!  Too late!
11853
11854 @item nnsoup-replies-index-type
11855 @vindex nnsoup-replies-index-type
11856 The index type of the replies packet.  The default is @samp{?n}, which
11857 means ``none''.  Don't fiddle with this one either!
11858
11859 @item nnsoup-active-file
11860 @vindex nnsoup-active-file
11861 Where @code{nnsoup} stores lots of information.  This is not an ``active
11862 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
11863 this file or mess it up in any way, you're dead.  The default is
11864 @file{~/SOUP/active}.
11865
11866 @item nnsoup-packer
11867 @vindex nnsoup-packer
11868 Format string command for packing a reply @sc{soup} packet.  The default
11869 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11870
11871 @item nnsoup-unpacker
11872 @vindex nnsoup-unpacker
11873 Format string command for unpacking incoming @sc{soup} packets.  The
11874 default is @samp{gunzip -c %s | tar xvf -}.
11875
11876 @item nnsoup-packet-directory
11877 @vindex nnsoup-packet-directory
11878 Where @code{nnsoup} will look for incoming packets.  The default is
11879 @file{~/}.
11880
11881 @item nnsoup-packet-regexp
11882 @vindex nnsoup-packet-regexp
11883 Regular expression matching incoming @sc{soup} packets.  The default is
11884 @samp{Soupout}.
11885
11886 @item nnsoup-always-save
11887 @vindex nnsoup-always-save
11888 If non-@code{nil}, save the replies buffer after each posted message.
11889
11890 @end table
11891
11892
11893 @node SOUP Replies
11894 @subsubsection SOUP Replies
11895
11896 Just using @code{nnsoup} won't mean that your postings and mailings end
11897 up in @sc{soup} reply packets automagically.  You have to work a bit
11898 more for that to happen.
11899
11900 @findex nnsoup-set-variables
11901 The @code{nnsoup-set-variables} command will set the appropriate
11902 variables to ensure that all your followups and replies end up in the
11903 @sc{soup} system.
11904
11905 In specific, this is what it does:
11906
11907 @lisp
11908 (setq message-send-news-function 'nnsoup-request-post)
11909 (setq message-send-mail-function 'nnsoup-request-mail)
11910 @end lisp
11911
11912 And that's it, really.  If you only want news to go into the @sc{soup}
11913 system you just use the first line.  If you only want mail to be
11914 @sc{soup}ed you use the second.
11915
11916
11917 @node Web Searches
11918 @subsection Web Searches
11919 @cindex nnweb
11920 @cindex DejaNews
11921 @cindex Alta Vista
11922 @cindex InReference
11923 @cindex Usenet searches
11924 @cindex searching the Usenet
11925
11926 It's, like, too neat to search the Usenet for articles that match a
11927 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11928 those, like, Web browsers, and you, like, have to, rilly, like, look at
11929 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11930 searches without having to use a browser.
11931
11932 The @code{nnweb} backend allows an easy interface to the mighty search
11933 engine.  You create an @code{nnweb} group, enter a search pattern, and
11934 then enter the group and read the articles like you would any normal
11935 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
11936 Groups}) will do this in an easy-to-use fashion.
11937
11938 @code{nnweb} groups don't really lend themselves to being solid
11939 groups---they have a very fleeting idea of article numbers.  In fact,
11940 each time you enter an @code{nnweb} group (not even changing the search
11941 pattern), you are likely to get the articles ordered in a different
11942 manner.  Not even using duplicate suppression (@pxref{Duplicate
11943 Suppression}) will help, since @code{nnweb} doesn't even know the
11944 @code{Message-ID} of the articles before reading them using some search
11945 engines (DejaNews, for instance).  The only possible way to keep track
11946 of which articles you've read is by scoring on the @code{Date}
11947 header---mark all articles posted before the last date you read the
11948 group as read.
11949
11950 If the search engine changes its output substantially, @code{nnweb}
11951 won't be able to parse it and will fail.  One could hardly fault the Web
11952 providers if they were to do this---their @emph{raison d'être} is to
11953 make money off of advertisements, not to provide services to the
11954 community.  Since @code{nnweb} washes the ads off all the articles, one
11955 might think that the providers might be somewhat miffed.  We'll see.
11956
11957 You must have the @code{url} and @code{w3} package installed to be able
11958 to use @code{nnweb}.
11959
11960 Virtual server variables:
11961
11962 @table @code
11963 @item nnweb-type
11964 @vindex nnweb-type
11965 What search engine type is being used.  The currently supported types
11966 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11967 @code{reference}.
11968
11969 @item nnweb-search
11970 @vindex nnweb-search
11971 The search string to feed to the search engine.
11972
11973 @item nnweb-max-hits
11974 @vindex nnweb-max-hits
11975 Advisory maximum number of hits per search to display.  The default is
11976 100.
11977
11978 @item nnweb-type-definition
11979 @vindex nnweb-type-definition
11980 Type-to-definition alist.  This alist says what @code{nnweb} should do
11981 with the various search engine types.  The following elements must be
11982 present:
11983
11984 @table @code
11985 @item article
11986 Function to decode the article and provide something that Gnus
11987 understands.
11988
11989 @item map
11990 Function to create an article number to message header and URL alist.
11991
11992 @item search
11993 Function to send the search string to the search engine.
11994
11995 @item address
11996 The address the aforementioned function should send the search string
11997 to.
11998
11999 @item id
12000 Format string URL to fetch an article by @code{Message-ID}.
12001 @end table
12002
12003 @end table
12004
12005
12006
12007 @node Mail-To-News Gateways
12008 @subsection Mail-To-News Gateways
12009 @cindex mail-to-news gateways
12010 @cindex gateways
12011
12012 If your local @code{nntp} server doesn't allow posting, for some reason
12013 or other, you can post using one of the numerous mail-to-news gateways.
12014 The @code{nngateway} backend provides the interface.
12015
12016 Note that you can't read anything from this backend---it can only be
12017 used to post with.
12018
12019 Server variables:
12020
12021 @table @code
12022 @item nngateway-address
12023 @vindex nngateway-address
12024 This is the address of the mail-to-news gateway.
12025
12026 @item nngateway-header-transformation
12027 @vindex nngateway-header-transformation
12028 News headers often have to be transformed in some odd way or other
12029 for the mail-to-news gateway to accept it.  This variable says what
12030 transformation should be called, and defaults to
12031 @code{nngateway-simple-header-transformation}.  The function is called
12032 narrowed to the headers to be transformed and with one parameter---the
12033 gateway address.
12034
12035 This default function just inserts a new @code{To} header based on the
12036 @code{Newsgroups} header and the gateway address.
12037 For instance, an article with this @code{Newsgroups} header:
12038
12039 @example
12040 Newsgroups: alt.religion.emacs
12041 @end example
12042
12043 will get this @code{From} header inserted:
12044
12045 @example
12046 To: alt-religion-emacs@@GATEWAY
12047 @end example
12048
12049 The following pre-defined functions exist:
12050
12051 @findex nngateway-simple-header-transformation
12052 @table @code
12053
12054 @item nngateway-simple-header-transformation
12055 Creates a @code{To} header that looks like
12056 @var{newsgroup}@@@code{nngateway-address}.
12057
12058 @findex nngateway-mail2news-header-transformation
12059
12060 @item nngateway-mail2news-header-transformation
12061 Creates a @code{To} header that looks like
12062 @code{nngateway-address}.
12063
12064 Here's an example:
12065
12066 @lisp
12067 (setq gnus-post-method
12068       '(nngateway "mail2news@@replay.com"
12069                   (nngateway-header-transformation
12070                    nngateway-mail2news-header-transformation)))
12071 @end lisp
12072
12073 @end table
12074
12075
12076 @end table
12077
12078 So, to use this, simply say something like:
12079
12080 @lisp
12081 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
12082 @end lisp
12083
12084
12085 @node Combined Groups
12086 @section Combined Groups
12087
12088 Gnus allows combining a mixture of all the other group types into bigger
12089 groups.
12090
12091 @menu
12092 * Virtual Groups::     Combining articles from many groups.
12093 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
12094 @end menu
12095
12096
12097 @node Virtual Groups
12098 @subsection Virtual Groups
12099 @cindex nnvirtual
12100 @cindex virtual groups
12101 @cindex merging groups
12102
12103 An @dfn{nnvirtual group} is really nothing more than a collection of
12104 other groups.
12105
12106 For instance, if you are tired of reading many small groups, you can
12107 put them all in one big group, and then grow tired of reading one
12108 big, unwieldy group.  The joys of computing!
12109
12110 You specify @code{nnvirtual} as the method.  The address should be a
12111 regexp to match component groups.
12112
12113 All marks in the virtual group will stick to the articles in the
12114 component groups.  So if you tick an article in a virtual group, the
12115 article will also be ticked in the component group from whence it came.
12116 (And vice versa---marks from the component groups will also be shown in
12117 the virtual group.)
12118
12119 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
12120 newsgroups into one, big, happy newsgroup:
12121
12122 @lisp
12123 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
12124 @end lisp
12125
12126 The component groups can be native or foreign; everything should work
12127 smoothly, but if your computer explodes, it was probably my fault.
12128
12129 Collecting the same group from several servers might actually be a good
12130 idea if users have set the Distribution header to limit distribution.
12131 If you would like to read @samp{soc.motss} both from a server in Japan
12132 and a server in Norway, you could use the following as the group regexp:
12133
12134 @example
12135 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
12136 @end example
12137
12138 (Remember, though, that if you're creating the group with @kbd{G m}, you
12139 shouldn't double the backslashes, and you should leave off the quote
12140 characters at the beginning and the end of the string.)
12141
12142 This should work kinda smoothly---all articles from both groups should
12143 end up in this one, and there should be no duplicates.  Threading (and
12144 the rest) will still work as usual, but there might be problems with the
12145 sequence of articles.  Sorting on date might be an option here
12146 (@pxref{Selecting a Group}).
12147
12148 One limitation, however---all groups included in a virtual
12149 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
12150 zombie groups can't be component groups for @code{nnvirtual} groups.
12151
12152 @vindex nnvirtual-always-rescan
12153 If the @code{nnvirtual-always-rescan} is non-@code{nil},
12154 @code{nnvirtual} will always scan groups for unread articles when
12155 entering a virtual group.  If this variable is @code{nil} (which is the
12156 default) and you read articles in a component group after the virtual
12157 group has been activated, the read articles from the component group
12158 will show up when you enter the virtual group.  You'll also see this
12159 effect if you have two virtual groups that have a component group in
12160 common.  If that's the case, you should set this variable to @code{t}.
12161 Or you can just tap @code{M-g} on the virtual group every time before
12162 you enter it---it'll have much the same effect.
12163
12164 @code{nnvirtual} can have both mail and news groups as component groups.
12165 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
12166 has to ask the backend of the component group the article comes from
12167 whether it is a news or mail backend.  However, when you do a @kbd{^},
12168 there is typically no sure way for the component backend to know this,
12169 and in that case @code{nnvirtual} tells Gnus that the article came from a
12170 not-news backend.  (Just to be on the safe side.)
12171
12172 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
12173 line from the article you respond to in these cases.
12174
12175
12176
12177 @node Kibozed Groups
12178 @subsection Kibozed Groups
12179 @cindex nnkiboze
12180 @cindex kibozing
12181
12182 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
12183 the news feed''.  @code{nnkiboze} is a backend that will do this for
12184 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
12185 with useless requests!  Oh happiness!
12186
12187 @kindex G k (Group)
12188 To create a kibozed group, use the @kbd{G k} command in the group
12189 buffer.
12190
12191 The address field of the @code{nnkiboze} method is, as with
12192 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
12193 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
12194 and @code{nnvirtual} end.
12195
12196 In addition to this regexp detailing component groups, an @code{nnkiboze} group
12197 must have a score file to say what articles are to be included in
12198 the group (@pxref{Scoring}).
12199
12200 @kindex M-x nnkiboze-generate-groups
12201 @findex nnkiboze-generate-groups
12202 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
12203 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
12204 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
12205 all the articles in all the component groups and run them through the
12206 scoring process to determine if there are any articles in the groups
12207 that are to be part of the @code{nnkiboze} groups.
12208
12209 Please limit the number of component groups by using restrictive
12210 regexps.  Otherwise your sysadmin may become annoyed with you, and the
12211 @sc{nntp} site may throw you off and never let you back in again.
12212 Stranger things have happened.
12213
12214 @code{nnkiboze} component groups do not have to be alive---they can be dead,
12215 and they can be foreign.  No restrictions.
12216
12217 @vindex nnkiboze-directory
12218 The generation of an @code{nnkiboze} group means writing two files in
12219 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
12220 contains the @sc{nov} header lines for all the articles in the group,
12221 and the other is an additional @file{.newsrc} file to store information
12222 on what groups have been searched through to find component articles.
12223
12224 Articles marked as read in the @code{nnkiboze} group will have
12225 their @sc{nov} lines removed from the @sc{nov} file.
12226
12227
12228 @node Gnus Unplugged
12229 @section Gnus Unplugged
12230 @cindex offline
12231 @cindex unplugged
12232 @cindex Agent
12233 @cindex Gnus Agent
12234 @cindex Gnus Unplugged
12235
12236 In olden times (ca. February '88), people used to run their newsreaders
12237 on big machines with permanent connections to the net.  News transport
12238 was dealt with by news servers, and all the newsreaders had to do was to
12239 read news.  Believe it or not.
12240
12241 Nowadays most people read news and mail at home, and use some sort of
12242 modem to connect to the net.  To avoid running up huge phone bills, it
12243 would be nice to have a way to slurp down all the news and mail, hang up
12244 the phone, read for several hours, and then upload any responses you
12245 have to make.  And then you repeat the procedure.
12246
12247 Of course, you can use news servers for doing this as well.  I've used
12248 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
12249 for some years, but doing that's a bore.  Moving the news server
12250 functionality up to the newsreader makes sense if you're the only person
12251 reading news on a machine.
12252
12253 Using Gnus as an ``offline'' newsreader is quite simple.
12254
12255 @itemize @bullet
12256 @item
12257 First, set up Gnus as you would do if you were running it on a machine
12258 that has full connection to the net.  Go ahead.  I'll still be waiting
12259 here.
12260
12261 @item
12262 Then, put the following magical incantation at the end of your
12263 @file{.gnus.el} file:
12264
12265 @lisp
12266 (gnus-agentize)
12267 @end lisp
12268 @end itemize
12269
12270 That's it.  Gnus is now an ``offline'' newsreader.
12271
12272 Of course, to use it as such, you have to learn a few new commands.
12273
12274 @menu
12275 * Agent Basics::           How it all is supposed to work.
12276 * Agent Categories::       How to tell the Gnus Agent what to download.
12277 * Agent Commands::         New commands for all the buffers.
12278 * Agent Expiry::           How to make old articles go away.
12279 * Outgoing Messages::      What happens when you post/mail something?
12280 * Agent Variables::        Customizing is fun.
12281 * Example Setup::          An example @file{.gnus.el} file for offline people.
12282 * Batching Agents::        How to fetch news from a @code{cron} job.
12283 * Agent Caveats::          What you think it'll do and what it does.
12284 @end menu
12285
12286
12287 @node Agent Basics
12288 @subsection Agent Basics
12289
12290 First, let's get some terminology out of the way.
12291
12292 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
12293 connection to the net (and notified the Agent that this is the case).
12294 When the connection to the net is up again (and Gnus knows this), the
12295 Agent is @dfn{plugged}.
12296
12297 The @dfn{local} machine is the one you're running on, and which isn't
12298 connected to the net continuously.
12299
12300 @dfn{Downloading} means fetching things from the net to your local
12301 machine.  @dfn{Uploading} is doing the opposite.
12302
12303 Let's take a typical Gnus session using the Agent.
12304
12305 @itemize @bullet
12306
12307 @item
12308 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
12309 Agent in a disconnected state.  You can read all the news that you have
12310 already fetched while in this mode.
12311
12312 @item
12313 You then decide to see whether any new news has arrived.  You connect
12314 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
12315 to make Gnus become @dfn{plugged}.
12316
12317 @item
12318 You can then read the new news immediately, or you can download the news
12319 onto your local machine.  If you want to do the latter, you press @kbd{J
12320 s} to fetch all the eligible articles in all the groups.  (To let Gnus
12321 know which articles you want to download, @pxref{Agent Categories}.)
12322
12323 @item
12324 After fetching the articles, you press @kbd{J j} to make Gnus become
12325 unplugged again, and you shut down the PPP thing (or whatever).  And
12326 then you read the news offline.
12327
12328 @item
12329 And then you go to step 2.
12330 @end itemize
12331
12332 Here are some things you should do the first time (or so) that you use
12333 the Agent.
12334
12335 @itemize @bullet
12336
12337 @item
12338 Decide which servers should be covered by the Agent.  If you have a mail
12339 backend, it would probably be nonsensical to have it covered by the
12340 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
12341 @kbd{J a} the server (or servers) that you wish to have covered by the
12342 Agent (@pxref{Server Agent Commands}).  This will typically be only the
12343 primary select method, which is listed on the bottom in the buffer.
12344
12345 @item
12346 Decide on download policy.  @xref{Agent Categories}.
12347
12348 @item
12349 Uhm... that's it.
12350 @end itemize
12351
12352
12353 @node Agent Categories
12354 @subsection Agent Categories
12355
12356 One of the main reasons to integrate the news transport layer into the
12357 newsreader is to allow greater control over what articles to download.
12358 There's not much point in downloading huge amounts of articles, just to
12359 find out that you're not interested in reading any of them.  It's better
12360 to be somewhat more conservative in choosing what to download, and then
12361 mark the articles for downloading manually if it should turn out that
12362 you're interested in the articles anyway.
12363
12364 The main way to control what is to be downloaded is to create a
12365 @dfn{category} and then assign some (or all) groups to this category.
12366 Groups that do not belong in any other category belong to the
12367 @code{default} category. Gnus has its own buffer for creating and
12368 managing categories.
12369
12370 @menu
12371 * Category Syntax::       What a category looks like.
12372 * The Category Buffer::   A buffer for maintaining categories.
12373 * Category Variables::    Customize'r'Us.
12374 @end menu
12375
12376
12377 @node Category Syntax
12378 @subsubsection Category Syntax
12379
12380 A category consists of two things.
12381
12382 @enumerate
12383 @item
12384 A predicate which (generally) gives a rough outline of which articles
12385 are eligible for downloading; and
12386
12387 @item
12388 a score rule which (generally) gives you a finer granularity when
12389 deciding what articles to download.  (Note that this @dfn{download
12390 score} is not necessarily related to normal scores.)
12391 @end enumerate
12392
12393 A predicate in its simplest form can be a single predicate such as
12394 @code{true} or @code{false}. These two will download every available
12395 article or nothing respectively. In the case of these two special
12396 predicates an additional score rule is superfluous.
12397
12398 Predicates of @code{high} or @code{low} download articles in respect of
12399 their scores in relationship to @code{gnus-agent-high-score} and
12400 @code{gnus-agent-low-score} as descibed below.
12401
12402 To gain even finer control of what is to be regarded eligible for
12403 download a predicate can consist of a number of predicates with logical
12404 operators sprinkled in between.
12405
12406 Perhaps some examples are in order.
12407
12408 Here's a simple predicate.  (It's the default predicate, in fact, used
12409 for all groups that don't belong to any other category.)
12410
12411 @lisp
12412 short
12413 @end lisp
12414
12415 Quite simple, eh?  This predicate is true if and only if the article is
12416 short (for some value of ``short'').
12417
12418 Here's a more complex predicate:
12419
12420 @lisp
12421 (or high
12422     (and
12423      (not low)
12424      (not long)))
12425 @end lisp
12426
12427 This means that an article should be downloaded if it has a high score,
12428 or if the score is not low and the article is not long.  You get the
12429 drift.
12430
12431 The available logical operators are @code{or}, @code{and} and
12432 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
12433 @samp{|}, @code{&} and @code{!} instead.)
12434
12435 The following predicates are pre-defined, but if none of these fit what
12436 you want to do, you can write your own.
12437
12438 @table @code
12439 @item short
12440 True iff the article is shorter than @code{gnus-agent-short-article}
12441 lines; default 100.
12442
12443 @item long
12444 True iff the article is longer than @code{gnus-agent-long-article}
12445 lines; default 200.
12446
12447 @item low
12448 True iff the article has a download score less than
12449 @code{gnus-agent-low-score}; default 0.
12450
12451 @item high
12452 True iff the article has a download score greater than
12453 @code{gnus-agent-high-score}; default 0.
12454
12455 @item spam
12456 True iff the Gnus Agent guesses that the article is spam.  The
12457 heuristics may change over time, but at present it just computes a
12458 checksum and sees whether articles match.
12459
12460 @item true
12461 Always true.
12462
12463 @item false
12464 Always false.
12465 @end table
12466
12467 If you want to create your own predicate function, here's what you have
12468 to know:  The functions are called with no parameters, but the
12469 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
12470 useful values.
12471
12472 For example, you could decide that you don't want to download articles
12473 that were posted more than a certain number of days ago (e.g. posted
12474 more than @code{gnus-agent-expire-days} ago) you might write a function
12475 something along the lines of the following:
12476
12477 @lisp
12478 (defun my-article-old-p ()
12479   "Say whether an article is old."
12480   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
12481      (- (time-to-days (current-time)) gnus-agent-expire-days)))
12482 @end lisp
12483
12484 with the predicate then defined as:
12485
12486 @lisp
12487 (not my-article-old-p)
12488 @end lisp
12489
12490 or you could append your predicate to the predefined
12491 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
12492 wherever.  (Note: this would have to be at a point *after*
12493 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
12494
12495 @lisp
12496 (defvar  gnus-category-predicate-alist
12497   (append gnus-category-predicate-alist
12498          '((old . my-article-old-p))))
12499 @end lisp
12500
12501 and simply specify your predicate as:
12502
12503 @lisp
12504 (not old)
12505 @end lisp
12506
12507 If/when using something like the above, be aware that there are many
12508 misconfigured systems/mailers out there and so an article's date is not
12509 always a reliable indication of when it was posted. Hell, some people
12510 just don't give a damm.
12511
12512
12513 The above predicates apply to *all* the groups which belong to the
12514 category. However, if you wish to have a specific predicate for an
12515 individual group within a category, or you're just too lazy to set up a
12516 new category, you can enter a group's individual predicate in it's group
12517 parameters like so:
12518
12519 @lisp
12520 (agent-predicate . short)
12521 @end lisp
12522
12523 This is the group parameter equivalent of the agent category
12524 default. Note that when specifying a single word predicate like this,
12525 the @code{agent-predicate} specification must be in dotted pair
12526 notation.
12527
12528 The equivalent of the longer example from above would be:
12529
12530 @lisp
12531 (agent-predicate or high (and (not low) (not long)))
12532 @end lisp
12533
12534 The outer parenthesis required in the category specification are not
12535 entered here as, not being in dotted pair notation, the value of the
12536 predicate is assumed to be a list.
12537
12538
12539 Now, the syntax of the download score is the same as the syntax of
12540 normal score files, except that all elements that require actually
12541 seeing the article itself are verboten.  This means that only the
12542 following headers can be scored on: @code{Subject}, @code{From},
12543 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12544 @code{Lines}, and @code{Xref}.
12545
12546 As with predicates, the specification of the @code{download score rule}
12547 to use in respect of a group can be in either the category definition if
12548 it's to be applicable to all groups in therein, or a group's parameters
12549 if it's to be specific to that group.
12550
12551 In both of these places the @code{download score rule} can take one of
12552 three forms:
12553
12554 @enumerate
12555 @item
12556 Score rule
12557
12558 This has the same syntax as a normal gnus score file except only a
12559 subset of scoring keywords are available as mentioned above.
12560
12561 example:
12562
12563 @itemize @bullet
12564 @item
12565 Category specification
12566
12567 @lisp
12568 (("from"
12569        ("Lars Ingebrigtsen" 1000000 nil s))
12570 ("lines"
12571        (500 -100 nil <)))
12572 @end lisp
12573
12574 @item
12575 Group Parameter specification
12576
12577 @lisp
12578 (agent-score ("from"
12579                    ("Lars Ingebrigtsen" 1000000 nil s))
12580              ("lines"
12581                    (500 -100 nil <)))
12582 @end lisp
12583
12584 Again, note the omission of the outermost parenthesis here.
12585 @end itemize
12586
12587 @item
12588 Agent score file
12589
12590 These score files must *only* contain the permitted scoring keywords
12591 stated above.
12592
12593 example:
12594
12595 @itemize @bullet
12596 @item
12597 Category specification
12598
12599 @lisp
12600 ("~/News/agent.SCORE")
12601 @end lisp
12602
12603 or perhaps
12604
12605 @lisp
12606 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12607 @end lisp
12608
12609 @item
12610 Group Parameter specification
12611
12612 @lisp
12613 (agent-score "~/News/agent.SCORE")
12614 @end lisp
12615
12616 Additional score files can be specified as above. Need I say anything
12617 about parenthesis.
12618 @end itemize
12619
12620 @item
12621 Use @code{normal} score files
12622
12623 If you dont want to maintain two sets of scoring rules for a group, and
12624 your desired @code{downloading} criteria for a group are the same as your
12625 @code{reading} criteria then you can tell the agent to refer to your
12626 @code{normal} score files when deciding what to download.
12627
12628 These directives in either the category definition or a group's
12629 parameters will cause the agent to read in all the applicable score
12630 files for a group, *filtering out* those those sections that do not
12631 relate to one of the permitted subset of scoring keywords.
12632
12633 @itemize @bullet
12634 @item
12635 Category Specification
12636
12637 @lisp
12638 file
12639 @end lisp
12640
12641 @item
12642 Group Parameter specification
12643
12644 @lisp
12645 (agent-score . file)
12646 @end lisp
12647 @end itemize
12648 @end enumerate
12649
12650 @node The Category Buffer
12651 @subsubsection The Category Buffer
12652
12653 You'd normally do all category maintenance from the category buffer.
12654 When you enter it for the first time (with the @kbd{J c} command from
12655 the group buffer), you'll only see the @code{default} category.
12656
12657 The following commands are available in this buffer:
12658
12659 @table @kbd
12660 @item q
12661 @kindex q (Category)
12662 @findex gnus-category-exit
12663 Return to the group buffer (@code{gnus-category-exit}).
12664
12665 @item k
12666 @kindex k (Category)
12667 @findex gnus-category-kill
12668 Kill the current category (@code{gnus-category-kill}).
12669
12670 @item c
12671 @kindex c (Category)
12672 @findex gnus-category-copy
12673 Copy the current category (@code{gnus-category-copy}).
12674
12675 @item a
12676 @kindex a (Category)
12677 @findex gnus-category-add
12678 Add a new category (@code{gnus-category-add}).
12679
12680 @item p
12681 @kindex p (Category)
12682 @findex gnus-category-edit-predicate
12683 Edit the predicate of the current category
12684 (@code{gnus-category-edit-predicate}).
12685
12686 @item g
12687 @kindex g (Category)
12688 @findex gnus-category-edit-groups
12689 Edit the list of groups belonging to the current category
12690 (@code{gnus-category-edit-groups}).
12691
12692 @item s
12693 @kindex s (Category)
12694 @findex gnus-category-edit-score
12695 Edit the download score rule of the current category
12696 (@code{gnus-category-edit-score}).
12697
12698 @item l
12699 @kindex l (Category)
12700 @findex gnus-category-list
12701 List all the categories (@code{gnus-category-list}).
12702 @end table
12703
12704
12705 @node Category Variables
12706 @subsubsection Category Variables
12707
12708 @table @code
12709 @item gnus-category-mode-hook
12710 @vindex gnus-category-mode-hook
12711 Hook run in category buffers.
12712
12713 @item gnus-category-line-format
12714 @vindex gnus-category-line-format
12715 Format of the lines in the category buffer (@pxref{Formatting
12716 Variables}).  Valid elements are:
12717
12718 @table @samp
12719 @item c
12720 The name of the category.
12721
12722 @item g
12723 The number of groups in the category.
12724 @end table
12725
12726 @item gnus-category-mode-line-format
12727 @vindex gnus-category-mode-line-format
12728 Format of the category mode line (@pxref{Mode Line Formatting}).
12729
12730 @item gnus-agent-short-article
12731 @vindex gnus-agent-short-article
12732 Articles that have fewer lines than this are short.  Default 100.
12733
12734 @item gnus-agent-long-article
12735 @vindex gnus-agent-long-article
12736 Articles that have more lines than this are long.  Default 200.
12737
12738 @item gnus-agent-low-score
12739 @vindex gnus-agent-low-score
12740 Articles that have a score lower than this have a low score.  Default
12741 0.
12742
12743 @item gnus-agent-high-score
12744 @vindex gnus-agent-high-score
12745 Articles that have a score higher than this have a high score.  Default
12746 0.
12747
12748 @end table
12749
12750
12751 @node Agent Commands
12752 @subsection Agent Commands
12753
12754 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
12755 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12756 toggles the plugged/unplugged state of the Gnus Agent.
12757
12758
12759 @menu
12760 * Group Agent Commands::
12761 * Summary Agent Commands::
12762 * Server Agent Commands::
12763 @end menu
12764
12765 You can run a complete batch fetch from the command line with the
12766 following incantation:
12767
12768 @cindex gnus-agent-batch-fetch
12769 @example
12770 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12771 @end example
12772
12773
12774
12775 @node Group Agent Commands
12776 @subsubsection Group Agent Commands
12777
12778 @table @kbd
12779 @item J u
12780 @kindex J u (Agent Group)
12781 @findex gnus-agent-fetch-groups
12782 Fetch all eligible articles in the current group
12783 (@code{gnus-agent-fetch-groups}).
12784
12785 @item J c
12786 @kindex J c (Agent Group)
12787 @findex gnus-enter-category-buffer
12788 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12789
12790 @item J s
12791 @kindex J s (Agent Group)
12792 @findex gnus-agent-fetch-session
12793 Fetch all eligible articles in all groups
12794 (@code{gnus-agent-fetch-session}).
12795
12796 @item J S
12797 @kindex J S (Agent Group)
12798 @findex gnus-group-send-drafts
12799 Send all sendable messages in the draft group
12800 (@code{gnus-agent-fetch-session}).  @xref{Drafts}.
12801
12802 @item J a
12803 @kindex J a (Agent Group)
12804 @findex gnus-agent-add-group
12805 Add the current group to an Agent category
12806 (@code{gnus-agent-add-group}).  This command understands the
12807 process/prefix convention (@pxref{Process/Prefix}).
12808
12809 @item J r
12810 @kindex J r (Agent Group)
12811 @findex gnus-agent-remove-group
12812 Remove the current group from its category, if any
12813 (@code{gnus-agent-remove-group}).  This command understands the
12814 process/prefix convention (@pxref{Process/Prefix}).
12815
12816 @end table
12817
12818
12819 @node Summary Agent Commands
12820 @subsubsection Summary Agent Commands
12821
12822 @table @kbd
12823 @item J #
12824 @kindex J # (Agent Summary)
12825 @findex gnus-agent-mark-article
12826 Mark the article for downloading (@code{gnus-agent-mark-article}).
12827
12828 @item J M-#
12829 @kindex J M-# (Agent Summary)
12830 @findex gnus-agent-unmark-article
12831 Remove the downloading mark from the article
12832 (@code{gnus-agent-unmark-article}).
12833
12834 @item @@
12835 @kindex @@ (Agent Summary)
12836 @findex gnus-agent-toggle-mark
12837 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12838
12839 @item J c
12840 @kindex J c (Agent Summary)
12841 @findex gnus-agent-catchup
12842 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12843
12844 @end table
12845
12846
12847 @node Server Agent Commands
12848 @subsubsection Server Agent Commands
12849
12850 @table @kbd
12851 @item J a
12852 @kindex J a (Agent Server)
12853 @findex gnus-agent-add-server
12854 Add the current server to the list of servers covered by the Gnus Agent
12855 (@code{gnus-agent-add-server}).
12856
12857 @item J r
12858 @kindex J r (Agent Server)
12859 @findex gnus-agent-remove-server
12860 Remove the current server from the list of servers covered by the Gnus
12861 Agent (@code{gnus-agent-remove-server}).
12862
12863 @end table
12864
12865
12866 @node Agent Expiry
12867 @subsection Agent Expiry
12868
12869 @vindex gnus-agent-expire-days
12870 @findex gnus-agent-expire
12871 @kindex M-x gnus-agent-expire
12872 @cindex Agent expiry
12873 @cindex Gnus Agent expiry
12874 @cindex expiry
12875
12876 @code{nnagent} doesn't handle expiry.  Instead, there's a special
12877 @code{gnus-agent-expire} command that will expire all read articles that
12878 are older than @code{gnus-agent-expire-days} days.  It can be run
12879 whenever you feel that you're running out of space.  It's not
12880 particularly fast or efficient, and it's not a particularly good idea to
12881 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12882
12883 @vindex gnus-agent-expire-all
12884 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12885 expire all articles---unread, read, ticked and dormant.  If @code{nil}
12886 (which is the default), only read articles are eligible for expiry, and
12887 unread, ticked and dormant articles will be kept indefinitely.
12888
12889
12890 @node Outgoing Messages
12891 @subsection Outgoing Messages
12892
12893 When Gnus is unplugged, all outgoing messages (both mail and news) are
12894 stored in the draft groups (@pxref{Drafts}).  You can view them there
12895 after posting, and edit them at will.
12896
12897 When Gnus is plugged again, you can send the messages either from the
12898 draft group with the special commands available there, or you can use
12899 the @kbd{J S} command in the group buffer to send all the sendable
12900 messages in the draft group.
12901
12902
12903
12904 @node Agent Variables
12905 @subsection Agent Variables
12906
12907 @table @code
12908 @item gnus-agent-directory
12909 @vindex gnus-agent-directory
12910 Where the Gnus Agent will store its files.  The default is
12911 @file{~/News/agent/}.
12912
12913 @item gnus-agent-handle-level
12914 @vindex gnus-agent-handle-level
12915 Groups on levels (@pxref{Group Levels}) higher than this variable will
12916 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
12917 which means that only subscribed group will be considered by the Agent
12918 by default.
12919
12920 @item gnus-agent-plugged-hook
12921 @vindex gnus-agent-plugged-hook
12922 Hook run when connecting to the network.
12923
12924 @item gnus-agent-unplugged-hook
12925 @vindex gnus-agent-unplugged-hook
12926 Hook run when disconnecting from the network.
12927
12928 @end table
12929
12930
12931 @node Example Setup
12932 @subsection Example Setup
12933
12934 If you don't want to read this manual, and you have a fairly standard
12935 setup, you may be able to use something like the following as your
12936 @file{.gnus.el} file to get started.
12937
12938 @lisp
12939 ;;; Define how Gnus is to fetch news.  We do this over NNTP
12940 ;;; from your ISP's server.
12941 (setq gnus-select-method '(nntp "news.your-isp.com"))
12942
12943 ;;; Define how Gnus is to read your mail.  We read mail from
12944 ;;; your ISP's POP server.
12945 (setq mail-sources '((pop :server "pop.your-isp.com")))
12946
12947 ;;; Say how Gnus is to store the mail.  We use nnml groups.
12948 (setq gnus-secondary-select-methods '((nnml "")))
12949
12950 ;;; Make Gnus into an offline newsreader.
12951 (gnus-agentize)
12952 @end lisp
12953
12954 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
12955 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12956 gnus}.
12957
12958 If this is the first time you've run Gnus, you will be subscribed
12959 automatically to a few default newsgroups.  You'll probably want to
12960 subscribe to more groups, and to do that, you have to query the
12961 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12962 command.  This usually takes quite a while, but you only have to do it
12963 once.
12964
12965 After reading and parsing a while, you'll be presented with a list of
12966 groups.  Subscribe to the ones you want to read with the @kbd{u}
12967 command.  @kbd{l} to make all the killed groups disappear after you've
12968 subscribe to all the groups you want to read.  (@kbd{A k} will bring
12969 back all the killed groups.)
12970
12971 You can now read the groups at once, or you can download the articles
12972 with the @kbd{J s} command.  And then read the rest of this manual to
12973 find out which of the other gazillion things you want to customize.
12974
12975
12976 @node Batching Agents
12977 @subsection Batching Agents
12978
12979 Having the Gnus Agent fetch articles (and post whatever messages you've
12980 written) is quite easy once you've gotten things set up properly.  The
12981 following shell script will do everything that is necessary:
12982
12983 @example
12984 #!/bin/sh
12985 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
12986 @end example
12987
12988
12989 @node Agent Caveats
12990 @subsection Agent Caveats
12991
12992 The Gnus Agent doesn't seem to work like most other offline
12993 newsreaders.  Here are some common questions that some imaginary people
12994 may ask:
12995
12996 @table @dfn
12997 @item If I read an article while plugged, do they get entered into the
12998 Agent?
12999
13000 @strong{No.}
13001
13002 @item If I read an article while plugged, and the article already exists
13003 in the Agent, will it get downloaded once more?
13004
13005 @strong{Yes.}
13006
13007 @end table
13008
13009 In short, when Gnus is unplugged, it only looks into the locally stored
13010 articles; when it's plugged, it only talks to your ISP.
13011
13012
13013 @node Scoring
13014 @chapter Scoring
13015 @cindex scoring
13016
13017 Other people use @dfn{kill files}, but we here at Gnus Towers like
13018 scoring better than killing, so we'd rather switch than fight.  They do
13019 something completely different as well, so sit up straight and pay
13020 attention!
13021
13022 @vindex gnus-summary-mark-below
13023 All articles have a default score (@code{gnus-summary-default-score}),
13024 which is 0 by default.  This score may be raised or lowered either
13025 interactively or by score files.  Articles that have a score lower than
13026 @code{gnus-summary-mark-below} are marked as read.
13027
13028 Gnus will read any @dfn{score files} that apply to the current group
13029 before generating the summary buffer.
13030
13031 There are several commands in the summary buffer that insert score
13032 entries based on the current article.  You can, for instance, ask Gnus to
13033 lower or increase the score of all articles with a certain subject.
13034
13035 There are two sorts of scoring entries: Permanent and temporary.
13036 Temporary score entries are self-expiring entries.  Any entries that are
13037 temporary and have not been used for, say, a week, will be removed
13038 silently to help keep the sizes of the score files down.
13039
13040 @menu
13041 * Summary Score Commands::   Adding score entries for the current group.
13042 * Group Score Commands::     General score commands.
13043 * Score Variables::          Customize your scoring.  (My, what terminology).
13044 * Score File Format::        What a score file may contain.
13045 * Score File Editing::       You can edit score files by hand as well.
13046 * Adaptive Scoring::         Big Sister Gnus knows what you read.
13047 * Home Score File::          How to say where new score entries are to go.
13048 * Followups To Yourself::    Having Gnus notice when people answer you.
13049 * Scoring Tips::             How to score effectively.
13050 * Reverse Scoring::          That problem child of old is not problem.
13051 * Global Score Files::       Earth-spanning, ear-splitting score files.
13052 * Kill Files::               They are still here, but they can be ignored.
13053 * Converting Kill Files::    Translating kill files to score files.
13054 * GroupLens::                Getting predictions on what you like to read.
13055 * Advanced Scoring::         Using logical expressions to build score rules.
13056 * Score Decays::             It can be useful to let scores wither away.
13057 @end menu
13058
13059
13060 @node Summary Score Commands
13061 @section Summary Score Commands
13062 @cindex score commands
13063
13064 The score commands that alter score entries do not actually modify real
13065 score files.  That would be too inefficient.  Gnus maintains a cache of
13066 previously loaded score files, one of which is considered the
13067 @dfn{current score file alist}.  The score commands simply insert
13068 entries into this list, and upon group exit, this list is saved.
13069
13070 The current score file is by default the group's local score file, even
13071 if no such score file actually exists.  To insert score commands into
13072 some other score file (e.g. @file{all.SCORE}), you must first make this
13073 score file the current one.
13074
13075 General score commands that don't actually change the score file:
13076
13077 @table @kbd
13078
13079 @item V s
13080 @kindex V s (Summary)
13081 @findex gnus-summary-set-score
13082 Set the score of the current article (@code{gnus-summary-set-score}).
13083
13084 @item V S
13085 @kindex V S (Summary)
13086 @findex gnus-summary-current-score
13087 Display the score of the current article
13088 (@code{gnus-summary-current-score}).
13089
13090 @item V t
13091 @kindex V t (Summary)
13092 @findex gnus-score-find-trace
13093 Display all score rules that have been used on the current article
13094 (@code{gnus-score-find-trace}).
13095
13096 @item V R
13097 @kindex V R (Summary)
13098 @findex gnus-summary-rescore
13099 Run the current summary through the scoring process
13100 (@code{gnus-summary-rescore}).  This might be useful if you're playing
13101 around with your score files behind Gnus' back and want to see the
13102 effect you're having.
13103
13104 @item V c
13105 @kindex V c (Summary)
13106 @findex gnus-score-change-score-file
13107 Make a different score file the current
13108 (@code{gnus-score-change-score-file}).
13109
13110 @item V e
13111 @kindex V e (Summary)
13112 @findex gnus-score-edit-current-scores
13113 Edit the current score file (@code{gnus-score-edit-current-scores}).
13114 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
13115 File Editing}).
13116
13117 @item V f
13118 @kindex V f (Summary)
13119 @findex gnus-score-edit-file
13120 Edit a score file and make this score file the current one
13121 (@code{gnus-score-edit-file}).
13122
13123 @item V F
13124 @kindex V F (Summary)
13125 @findex gnus-score-flush-cache
13126 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
13127 after editing score files.
13128
13129 @item V C
13130 @kindex V C (Summary)
13131 @findex gnus-score-customize
13132 Customize a score file in a visually pleasing manner
13133 (@code{gnus-score-customize}).
13134
13135 @end table
13136
13137 The rest of these commands modify the local score file.
13138
13139 @table @kbd
13140
13141 @item V m
13142 @kindex V m (Summary)
13143 @findex gnus-score-set-mark-below
13144 Prompt for a score, and mark all articles with a score below this as
13145 read (@code{gnus-score-set-mark-below}).
13146
13147 @item V x
13148 @kindex V x (Summary)
13149 @findex gnus-score-set-expunge-below
13150 Prompt for a score, and add a score rule to the current score file to
13151 expunge all articles below this score
13152 (@code{gnus-score-set-expunge-below}).
13153 @end table
13154
13155 The keystrokes for actually making score entries follow a very regular
13156 pattern, so there's no need to list all the commands.  (Hundreds of
13157 them.)
13158
13159 @findex gnus-summary-increase-score
13160 @findex gnus-summary-lower-score
13161
13162 @enumerate
13163 @item
13164 The first key is either @kbd{I} (upper case i) for increasing the score
13165 or @kbd{L} for lowering the score.
13166 @item
13167 The second key says what header you want to score on.  The following
13168 keys are available:
13169 @table @kbd
13170
13171 @item a
13172 Score on the author name.
13173
13174 @item s
13175 Score on the subject line.
13176
13177 @item x
13178 Score on the @code{Xref} line---i.e., the cross-posting line.
13179
13180 @item r
13181 Score on the @code{References} line.
13182
13183 @item d
13184 Score on the date.
13185
13186 @item l
13187 Score on the number of lines.
13188
13189 @item i
13190 Score on the @code{Message-ID} header.
13191
13192 @item f
13193 Score on followups---this matches the author name, and adds scores to
13194 the followups to this author.
13195
13196 @item b
13197 Score on the body.
13198
13199 @item h
13200 Score on the head.
13201
13202 @item t
13203 Score on thread.
13204
13205 @end table
13206
13207 @item
13208 The third key is the match type.  Which match types are valid depends on
13209 what headers you are scoring on.
13210
13211 @table @code
13212
13213 @item strings
13214
13215 @table @kbd
13216
13217 @item e
13218 Exact matching.
13219
13220 @item s
13221 Substring matching.
13222
13223 @item f
13224 Fuzzy matching (@pxref{Fuzzy Matching}).
13225
13226 @item r
13227 Regexp matching
13228 @end table
13229
13230 @item date
13231 @table @kbd
13232
13233 @item b
13234 Before date.
13235
13236 @item a
13237 After date.
13238
13239 @item n
13240 This date.
13241 @end table
13242
13243 @item number
13244 @table @kbd
13245
13246 @item <
13247 Less than number.
13248
13249 @item =
13250 Equal to number.
13251
13252 @item >
13253 Greater than number.
13254 @end table
13255 @end table
13256
13257 @item
13258 The fourth and final key says whether this is a temporary (i.e., expiring)
13259 score entry, or a permanent (i.e., non-expiring) score entry, or whether
13260 it is to be done immediately, without adding to the score file.
13261 @table @kbd
13262
13263 @item t
13264 Temporary score entry.
13265
13266 @item p
13267 Permanent score entry.
13268
13269 @item i
13270 Immediately scoring.
13271 @end table
13272
13273 @end enumerate
13274
13275 So, let's say you want to increase the score on the current author with
13276 exact matching permanently: @kbd{I a e p}.  If you want to lower the
13277 score based on the subject line, using substring matching, and make a
13278 temporary score entry: @kbd{L s s t}.  Pretty easy.
13279
13280 To make things a bit more complicated, there are shortcuts.  If you use
13281 a capital letter on either the second or third keys, Gnus will use
13282 defaults for the remaining one or two keystrokes.  The defaults are
13283 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
13284 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
13285
13286 These functions take both the numerical prefix and the symbolic prefix
13287 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
13288 (or increase) the score of the article.  A symbolic prefix of @code{a}
13289 says to use the @file{all.SCORE} file for the command instead of the
13290 current score file.
13291
13292 @vindex gnus-score-mimic-keymap
13293 The @code{gnus-score-mimic-keymap} says whether these commands will
13294 pretend they are keymaps or not.
13295
13296
13297 @node Group Score Commands
13298 @section Group Score Commands
13299 @cindex group score commands
13300
13301 There aren't many of these as yet, I'm afraid.
13302
13303 @table @kbd
13304
13305 @item W f
13306 @kindex W f (Group)
13307 @findex gnus-score-flush-cache
13308 Gnus maintains a cache of score alists to avoid having to reload them
13309 all the time.  This command will flush the cache
13310 (@code{gnus-score-flush-cache}).
13311
13312 @end table
13313
13314 You can do scoring from the command line by saying something like:
13315
13316 @findex gnus-batch-score
13317 @cindex batch scoring
13318 @example
13319 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
13320 @end example
13321
13322
13323 @node Score Variables
13324 @section Score Variables
13325 @cindex score variables
13326
13327 @table @code
13328
13329 @item gnus-use-scoring
13330 @vindex gnus-use-scoring
13331 If @code{nil}, Gnus will not check for score files, and will not, in
13332 general, do any score-related work.  This is @code{t} by default.
13333
13334 @item gnus-kill-killed
13335 @vindex gnus-kill-killed
13336 If this variable is @code{nil}, Gnus will never apply score files to
13337 articles that have already been through the kill process.  While this
13338 may save you lots of time, it also means that if you apply a kill file
13339 to a group, and then change the kill file and want to run it over you
13340 group again to kill more articles, it won't work.  You have to set this
13341 variable to @code{t} to do that.  (It is @code{t} by default.)
13342
13343 @item gnus-kill-files-directory
13344 @vindex gnus-kill-files-directory
13345 All kill and score files will be stored in this directory, which is
13346 initialized from the @code{SAVEDIR} environment variable by default.
13347 This is @file{~/News/} by default.
13348
13349 @item gnus-score-file-suffix
13350 @vindex gnus-score-file-suffix
13351 Suffix to add to the group name to arrive at the score file name
13352 (@samp{SCORE} by default.)
13353
13354 @item gnus-score-uncacheable-files
13355 @vindex gnus-score-uncacheable-files
13356 @cindex score cache
13357 All score files are normally cached to avoid excessive re-loading of
13358 score files.  However, if this might make you Emacs grow big and
13359 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
13360 @file{all.SCORE}, while it might be a good idea to not cache
13361 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
13362 variable is @samp{ADAPT$} by default, so no adaptive score files will
13363 be cached.
13364
13365 @item gnus-save-score
13366 @vindex gnus-save-score
13367 If you have really complicated score files, and do lots of batch
13368 scoring, then you might set this variable to @code{t}.  This will make
13369 Gnus save the scores into the @file{.newsrc.eld} file.
13370
13371 If you do not set this to @code{t}, then manual scores (like those set
13372 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
13373 across group visits.
13374
13375 @item gnus-score-interactive-default-score
13376 @vindex gnus-score-interactive-default-score
13377 Score used by all the interactive raise/lower commands to raise/lower
13378 score with.  Default is 1000, which may seem excessive, but this is to
13379 ensure that the adaptive scoring scheme gets enough room to play with.
13380 We don't want the small changes from the adaptive scoring to overwrite
13381 manually entered data.
13382
13383 @item gnus-summary-default-score
13384 @vindex gnus-summary-default-score
13385 Default score of an article, which is 0 by default.
13386
13387 @item gnus-summary-expunge-below
13388 @vindex gnus-summary-expunge-below
13389 Don't display the summary lines of articles that have scores lower than
13390 this variable.  This is @code{nil} by default, which means that no
13391 articles will be hidden.  This variable is local to the summary buffers,
13392 and has to be set from @code{gnus-summary-mode-hook}.
13393
13394 @item gnus-score-over-mark
13395 @vindex gnus-score-over-mark
13396 Mark (in the third column) used for articles with a score over the
13397 default.  Default is @samp{+}.
13398
13399 @item gnus-score-below-mark
13400 @vindex gnus-score-below-mark
13401 Mark (in the third column) used for articles with a score below the
13402 default.  Default is @samp{-}.
13403
13404 @item gnus-score-find-score-files-function
13405 @vindex gnus-score-find-score-files-function
13406 Function used to find score files for the current group.  This function
13407 is called with the name of the group as the argument.
13408
13409 Predefined functions available are:
13410 @table @code
13411
13412 @item gnus-score-find-single
13413 @findex gnus-score-find-single
13414 Only apply the group's own score file.
13415
13416 @item gnus-score-find-bnews
13417 @findex gnus-score-find-bnews
13418 Apply all score files that match, using bnews syntax.  This is the
13419 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
13420 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
13421 @file{gnu.all.SCORE} would all apply.  In short, the instances of
13422 @samp{all} in the score file names are translated into @samp{.*}, and
13423 then a regexp match is done.
13424
13425 This means that if you have some score entries that you want to apply to
13426 all groups, then you put those entries in the @file{all.SCORE} file.
13427
13428 The score files are applied in a semi-random order, although Gnus will
13429 try to apply the more general score files before the more specific score
13430 files.  It does this by looking at the number of elements in the score
13431 file names---discarding the @samp{all} elements.
13432
13433 @item gnus-score-find-hierarchical
13434 @findex gnus-score-find-hierarchical
13435 Apply all score files from all the parent groups.  This means that you
13436 can't have score files like @file{all.SCORE}, but you can have
13437 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
13438
13439 @end table
13440 This variable can also be a list of functions.  In that case, all these
13441 functions will be called, and all the returned lists of score files will
13442 be applied.  These functions can also return lists of score alists
13443 directly.  In that case, the functions that return these non-file score
13444 alists should probably be placed before the ``real'' score file
13445 functions, to ensure that the last score file returned is the local
13446 score file.  Phu.
13447
13448 @item gnus-score-expiry-days
13449 @vindex gnus-score-expiry-days
13450 This variable says how many days should pass before an unused score file
13451 entry is expired.  If this variable is @code{nil}, no score file entries
13452 are expired.  It's 7 by default.
13453
13454 @item gnus-update-score-entry-dates
13455 @vindex gnus-update-score-entry-dates
13456 If this variable is non-@code{nil}, matching score entries will have
13457 their dates updated.  (This is how Gnus controls expiry---all
13458 non-matching entries will become too old while matching entries will
13459 stay fresh and young.)  However, if you set this variable to @code{nil},
13460 even matching entries will grow old and will have to face that oh-so
13461 grim reaper.
13462
13463 @item gnus-score-after-write-file-function
13464 @vindex gnus-score-after-write-file-function
13465 Function called with the name of the score file just written.
13466
13467 @item gnus-score-thread-simplify
13468 @vindex gnus-score-thread-simplify
13469 If this variable is non-@code{nil}, article subjects will be simplified
13470 for subject scoring purposes in the same manner as with
13471 threading---according to the current value of
13472 gnus-simplify-subject-functions.  If the scoring entry uses
13473 @code{substring} or @code{exact} matching, the match will also be
13474 simplified in this manner.
13475
13476 @end table
13477
13478
13479 @node Score File Format
13480 @section Score File Format
13481 @cindex score file format
13482
13483 A score file is an @code{emacs-lisp} file that normally contains just a
13484 single form.  Casual users are not expected to edit these files;
13485 everything can be changed from the summary buffer.
13486
13487 Anyway, if you'd like to dig into it yourself, here's an example:
13488
13489 @lisp
13490 (("from"
13491   ("Lars Ingebrigtsen" -10000)
13492   ("Per Abrahamsen")
13493   ("larsi\\|lmi" -50000 nil R))
13494  ("subject"
13495   ("Ding is Badd" nil 728373))
13496  ("xref"
13497   ("alt.politics" -1000 728372 s))
13498  ("lines"
13499   (2 -100 nil <))
13500  (mark 0)
13501  (expunge -1000)
13502  (mark-and-expunge -10)
13503  (read-only nil)
13504  (orphan -10)
13505  (adapt t)
13506  (files "/hom/larsi/News/gnu.SCORE")
13507  (exclude-files "all.SCORE")
13508  (local (gnus-newsgroup-auto-expire t)
13509         (gnus-summary-make-false-root empty))
13510  (eval (ding)))
13511 @end lisp
13512
13513 This example demonstrates most score file elements.  For a different
13514 approach, see @pxref{Advanced Scoring}.
13515
13516 Even though this looks much like lisp code, nothing here is actually
13517 @code{eval}ed.  The lisp reader is used to read this form, though, so it
13518 has to be valid syntactically, if not semantically.
13519
13520 Six keys are supported by this alist:
13521
13522 @table @code
13523
13524 @item STRING
13525 If the key is a string, it is the name of the header to perform the
13526 match on.  Scoring can only be performed on these eight headers:
13527 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13528 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
13529 these headers, there are three strings to tell Gnus to fetch the entire
13530 article and do the match on larger parts of the article: @code{Body}
13531 will perform the match on the body of the article, @code{Head} will
13532 perform the match on the head of the article, and @code{All} will
13533 perform the match on the entire article.  Note that using any of these
13534 last three keys will slow down group entry @emph{considerably}.  The
13535 final ``header'' you can score on is @code{Followup}.  These score
13536 entries will result in new score entries being added for all follow-ups
13537 to articles that matches these score entries.
13538
13539 Following this key is a arbitrary number of score entries, where each
13540 score entry has one to four elements.
13541 @enumerate
13542
13543 @item
13544 The first element is the @dfn{match element}.  On most headers this will
13545 be a string, but on the Lines and Chars headers, this must be an
13546 integer.
13547
13548 @item
13549 If the second element is present, it should be a number---the @dfn{score
13550 element}.  This number should be an integer in the neginf to posinf
13551 interval.  This number is added to the score of the article if the match
13552 is successful.  If this element is not present, the
13553 @code{gnus-score-interactive-default-score} number will be used
13554 instead.  This is 1000 by default.
13555
13556 @item
13557 If the third element is present, it should be a number---the @dfn{date
13558 element}.  This date says when the last time this score entry matched,
13559 which provides a mechanism for expiring the score entries.  It this
13560 element is not present, the score entry is permanent.  The date is
13561 represented by the number of days since December 31, 1 BCE.
13562
13563 @item
13564 If the fourth element is present, it should be a symbol---the @dfn{type
13565 element}.  This element specifies what function should be used to see
13566 whether this score entry matches the article.  What match types that can
13567 be used depends on what header you wish to perform the match on.
13568 @table @dfn
13569
13570 @item From, Subject, References, Xref, Message-ID
13571 For most header types, there are the @code{r} and @code{R} (regexp), as
13572 well as @code{s} and @code{S} (substring) types, and @code{e} and
13573 @code{E} (exact match), and @code{w} (word match) types.  If this
13574 element is not present, Gnus will assume that substring matching should
13575 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
13576 that the matches will be done in a case-sensitive manner.  All these
13577 one-letter types are really just abbreviations for the @code{regexp},
13578 @code{string}, @code{exact}, and @code{word} types, which you can use
13579 instead, if you feel like.
13580
13581 @item Lines, Chars
13582 These two headers use different match types: @code{<}, @code{>},
13583 @code{=}, @code{>=} and @code{<=}.
13584
13585 These predicates are true if
13586
13587 @example
13588 (PREDICATE HEADER MATCH)
13589 @end example
13590
13591 evaluates to non-@code{nil}.  For instance, the advanced match
13592 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13593 following form:
13594
13595 @lisp
13596 (< header-value 4)
13597 @end lisp
13598
13599 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13600 the match, we get the score added if the article has less than 4 lines.
13601 (It's easy to get confused and think it's the other way around.  But
13602 it's not.  I think.)
13603
13604 When matching on @code{Lines}, be careful because some backends (like
13605 @code{nndir}) do not generate @code{Lines} header, so every article ends
13606 up being marked as having 0 lines.  This can lead to strange results if
13607 you happen to lower score of the articles with few lines.
13608
13609 @item Date
13610 For the Date header we have three kinda silly match types:
13611 @code{before}, @code{at} and @code{after}.  I can't really imagine this
13612 ever being useful, but, like, it would feel kinda silly not to provide
13613 this function.  Just in case.  You never know.  Better safe than sorry.
13614 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
13615 sex on a first date.  (I have been told that at least one person, and I
13616 quote, ``found this function indispensable'', however.)
13617
13618 @cindex ISO8601
13619 @cindex date
13620 A more useful match type is @code{regexp}.  With it, you can match the
13621 date string using a regular expression.  The date is normalized to
13622 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
13623 you want to match all articles that have been posted on April 1st in
13624 every year, you could use @samp{....0401.........} as a match string,
13625 for instance.  (Note that the date is kept in its original time zone, so
13626 this will match articles that were posted when it was April 1st where
13627 the article was posted from.  Time zones are such wholesome fun for the
13628 whole family, eh?)
13629
13630 @item Head, Body, All
13631 These three match keys use the same match types as the @code{From} (etc)
13632 header uses.
13633
13634 @item Followup
13635 This match key is somewhat special, in that it will match the
13636 @code{From} header, and affect the score of not only the matching
13637 articles, but also all followups to the matching articles.  This allows
13638 you e.g. increase the score of followups to your own articles, or
13639 decrease the score of followups to the articles of some known
13640 trouble-maker.  Uses the same match types as the @code{From} header
13641 uses.  (Using this match key will lead to creation of @file{ADAPT}
13642 files.)
13643
13644 @item Thread
13645 This match key works along the same lines as the @code{Followup} match
13646 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
13647 @samp{thread} match.  This will add a new @samp{thread} match for each
13648 article that has @var{X} in its @code{References} header.  (These new
13649 @samp{thread} matches will use the @code{Message-ID}s of these matching
13650 articles.)  This will ensure that you can raise/lower the score of an
13651 entire thread, even though some articles in the thread may not have
13652 complete @code{References} headers.  Note that using this may lead to
13653 undeterministic scores of the articles in the thread.  (Using this match
13654 key will lead to creation of @file{ADAPT} files.)
13655 @end table
13656 @end enumerate
13657
13658 @cindex Score File Atoms
13659 @item mark
13660 The value of this entry should be a number.  Any articles with a score
13661 lower than this number will be marked as read.
13662
13663 @item expunge
13664 The value of this entry should be a number.  Any articles with a score
13665 lower than this number will be removed from the summary buffer.
13666
13667 @item mark-and-expunge
13668 The value of this entry should be a number.  Any articles with a score
13669 lower than this number will be marked as read and removed from the
13670 summary buffer.
13671
13672 @item thread-mark-and-expunge
13673 The value of this entry should be a number.  All articles that belong to
13674 a thread that has a total score below this number will be marked as read
13675 and removed from the summary buffer.  @code{gnus-thread-score-function}
13676 says how to compute the total score for a thread.
13677
13678 @item files
13679 The value of this entry should be any number of file names.  These files
13680 are assumed to be score files as well, and will be loaded the same way
13681 this one was.
13682
13683 @item exclude-files
13684 The clue of this entry should be any number of files.  These files will
13685 not be loaded, even though they would normally be so, for some reason or
13686 other.
13687
13688 @item eval
13689 The value of this entry will be @code{eval}el.  This element will be
13690 ignored when handling global score files.
13691
13692 @item read-only
13693 Read-only score files will not be updated or saved.  Global score files
13694 should feature this atom (@pxref{Global Score Files}).  (Note:
13695 @dfn{Global} here really means @dfn{global}; not your personal
13696 apply-to-all-groups score files.)
13697
13698 @item orphan
13699 The value of this entry should be a number.  Articles that do not have
13700 parents will get this number added to their scores.  Imagine you follow
13701 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
13702 will only follow a few of the threads, also want to see any new threads.
13703
13704 You can do this with the following two score file entries:
13705
13706 @example
13707         (orphan -500)
13708         (mark-and-expunge -100)
13709 @end example
13710
13711 When you enter the group the first time, you will only see the new
13712 threads.  You then raise the score of the threads that you find
13713 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13714 rest.  Next time you enter the group, you will see new articles in the
13715 interesting threads, plus any new threads.
13716
13717 I.e.---the orphan score atom is for high-volume groups where there
13718 exist a few interesting threads which can't be found automatically by
13719 ordinary scoring rules.
13720
13721 @item adapt
13722 This entry controls the adaptive scoring.  If it is @code{t}, the
13723 default adaptive scoring rules will be used.  If it is @code{ignore}, no
13724 adaptive scoring will be performed on this group.  If it is a list, this
13725 list will be used as the adaptive scoring rules.  If it isn't present,
13726 or is something other than @code{t} or @code{ignore}, the default
13727 adaptive scoring rules will be used.  If you want to use adaptive
13728 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13729 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13730 not want adaptive scoring.  If you only want adaptive scoring in a few
13731 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13732 insert @code{(adapt t)} in the score files of the groups where you want
13733 it.
13734
13735 @item adapt-file
13736 All adaptive score entries will go to the file named by this entry.  It
13737 will also be applied when entering the group.  This atom might be handy
13738 if you want to adapt on several groups at once, using the same adaptive
13739 file for a number of groups.
13740
13741 @item local
13742 @cindex local variables
13743 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13744 Each @var{var} will be made buffer-local to the current summary buffer,
13745 and set to the value specified.  This is a convenient, if somewhat
13746 strange, way of setting variables in some groups if you don't like hooks
13747 much.  Note that the @var{value} won't be evaluated.
13748 @end table
13749
13750
13751 @node Score File Editing
13752 @section Score File Editing
13753
13754 You normally enter all scoring commands from the summary buffer, but you
13755 might feel the urge to edit them by hand as well, so we've supplied you
13756 with a mode for that.
13757
13758 It's simply a slightly customized @code{emacs-lisp} mode, with these
13759 additional commands:
13760
13761 @table @kbd
13762
13763 @item C-c C-c
13764 @kindex C-c C-c (Score)
13765 @findex gnus-score-edit-done
13766 Save the changes you have made and return to the summary buffer
13767 (@code{gnus-score-edit-done}).
13768
13769 @item C-c C-d
13770 @kindex C-c C-d (Score)
13771 @findex gnus-score-edit-insert-date
13772 Insert the current date in numerical format
13773 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
13774 you were wondering.
13775
13776 @item C-c C-p
13777 @kindex C-c C-p (Score)
13778 @findex gnus-score-pretty-print
13779 The adaptive score files are saved in an unformatted fashion.  If you
13780 intend to read one of these files, you want to @dfn{pretty print} it
13781 first.  This command (@code{gnus-score-pretty-print}) does that for
13782 you.
13783
13784 @end table
13785
13786 Type @kbd{M-x gnus-score-mode} to use this mode.
13787
13788 @vindex gnus-score-mode-hook
13789 @code{gnus-score-menu-hook} is run in score mode buffers.
13790
13791 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13792 e} to begin editing score files.
13793
13794
13795 @node Adaptive Scoring
13796 @section Adaptive Scoring
13797 @cindex adaptive scoring
13798
13799 If all this scoring is getting you down, Gnus has a way of making it all
13800 happen automatically---as if by magic.  Or rather, as if by artificial
13801 stupidity, to be precise.
13802
13803 @vindex gnus-use-adaptive-scoring
13804 When you read an article, or mark an article as read, or kill an
13805 article, you leave marks behind.  On exit from the group, Gnus can sniff
13806 these marks and add score elements depending on what marks it finds.
13807 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13808 @code{t} or @code{(line)}.  If you want score adaptively on separate
13809 words appearing in the subjects, you should set this variable to
13810 @code{(word)}.  If you want to use both adaptive methods, set this
13811 variable to @code{(word line)}.
13812
13813 @vindex gnus-default-adaptive-score-alist
13814 To give you complete control over the scoring process, you can customize
13815 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
13816 might look something like this:
13817
13818 @lisp
13819 (defvar gnus-default-adaptive-score-alist
13820   '((gnus-unread-mark)
13821     (gnus-ticked-mark (from 4))
13822     (gnus-dormant-mark (from 5))
13823     (gnus-del-mark (from -4) (subject -1))
13824     (gnus-read-mark (from 4) (subject 2))
13825     (gnus-expirable-mark (from -1) (subject -1))
13826     (gnus-killed-mark (from -1) (subject -3))
13827     (gnus-kill-file-mark)
13828     (gnus-ancient-mark)
13829     (gnus-low-score-mark)
13830     (gnus-catchup-mark (from -1) (subject -1))))
13831 @end lisp
13832
13833 As you see, each element in this alist has a mark as a key (either a
13834 variable name or a ``real'' mark---a character).  Following this key is
13835 a arbitrary number of header/score pairs.  If there are no header/score
13836 pairs following the key, no adaptive scoring will be done on articles
13837 that have that key as the article mark.  For instance, articles with
13838 @code{gnus-unread-mark} in the example above will not get adaptive score
13839 entries.
13840
13841 Each article can have only one mark, so just a single of these rules
13842 will be applied to each article.
13843
13844 To take @code{gnus-del-mark} as an example---this alist says that all
13845 articles that have that mark (i.e., are marked with @samp{D}) will have a
13846 score entry added to lower based on the @code{From} header by -4, and
13847 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
13848
13849 If you have marked 10 articles with the same subject with
13850 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13851 That means that that subject will get a score of ten times -1, which
13852 should be, unless I'm much mistaken, -10.
13853
13854 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13855 the read articles will be marked with the @samp{E} mark.  This'll
13856 probably make adaptive scoring slightly impossible, so auto-expiring and
13857 adaptive scoring doesn't really mix very well.
13858
13859 The headers you can score on are @code{from}, @code{subject},
13860 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13861 @code{chars} and @code{date}.  In addition, you can score on
13862 @code{followup}, which will create an adaptive score entry that matches
13863 on the @code{References} header using the @code{Message-ID} of the
13864 current article, thereby matching the following thread.
13865
13866 You can also score on @code{thread}, which will try to score all
13867 articles that appear in a thread.  @code{thread} matches uses a
13868 @code{Message-ID} to match on the @code{References} header of the
13869 article.  If the match is made, the @code{Message-ID} of the article is
13870 added to the @code{thread} rule.  (Think about it.  I'd recommend two
13871 aspirins afterwards.)
13872
13873 If you use this scheme, you should set the score file atom @code{mark}
13874 to something small---like -300, perhaps, to avoid having small random
13875 changes result in articles getting marked as read.
13876
13877 After using adaptive scoring for a week or so, Gnus should start to
13878 become properly trained and enhance the authors you like best, and kill
13879 the authors you like least, without you having to say so explicitly.
13880
13881 You can control what groups the adaptive scoring is to be performed on
13882 by using the score files (@pxref{Score File Format}).  This will also
13883 let you use different rules in different groups.
13884
13885 @vindex gnus-adaptive-file-suffix
13886 The adaptive score entries will be put into a file where the name is the
13887 group name with @code{gnus-adaptive-file-suffix} appended.  The default
13888 is @samp{ADAPT}.
13889
13890 @vindex gnus-score-exact-adapt-limit
13891 When doing adaptive scoring, substring or fuzzy matching would probably
13892 give you the best results in most cases.  However, if the header one
13893 matches is short, the possibility for false positives is great, so if
13894 the length of the match is less than
13895 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
13896 this variable is @code{nil}, exact matching will always be used to avoid
13897 this problem.
13898
13899 @vindex gnus-default-adaptive-word-score-alist
13900 As mentioned above, you can adapt either on individual words or entire
13901 headers.  If you adapt on words, the
13902 @code{gnus-default-adaptive-word-score-alist} variable says what score
13903 each instance of a word should add given a mark.
13904
13905 @lisp
13906 (setq gnus-default-adaptive-word-score-alist
13907       `((,gnus-read-mark . 30)
13908         (,gnus-catchup-mark . -10)
13909         (,gnus-killed-mark . -20)
13910         (,gnus-del-mark . -15)))
13911 @end lisp
13912
13913 This is the default value.  If you have adaption on words enabled, every
13914 word that appears in subjects of articles marked with
13915 @code{gnus-read-mark} will result in a score rule that increase the
13916 score with 30 points.
13917
13918 @vindex gnus-default-ignored-adaptive-words
13919 @vindex gnus-ignored-adaptive-words
13920 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13921 will be ignored.  If you wish to add more words to be ignored, use the
13922 @code{gnus-ignored-adaptive-words} list instead.
13923
13924 @vindex gnus-adaptive-word-syntax-table
13925 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13926 syntax table in effect.  It is similar to the standard syntax table, but
13927 it considers numbers to be non-word-constituent characters.
13928
13929 @vindex gnus-adaptive-word-minimum
13930 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13931 word scoring process will never bring down the score of an article to
13932 below this number.  The default is @code{nil}.
13933
13934 @vindex gnus-adaptive-word-no-group-words
13935 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13936 won't adaptively word score any of the words in the group name.  Useful
13937 for groups like @samp{comp.editors.emacs}, where most of the subject
13938 lines contain the word @samp{emacs}.
13939
13940 After using this scheme for a while, it might be nice to write a
13941 @code{gnus-psychoanalyze-user} command to go through the rules and see
13942 what words you like and what words you don't like.  Or perhaps not.
13943
13944 Note that the adaptive word scoring thing is highly experimental and is
13945 likely to change in the future.  Initial impressions seem to indicate
13946 that it's totally useless as it stands.  Some more work (involving more
13947 rigorous statistical methods) will have to be done to make this useful.
13948
13949
13950 @node Home Score File
13951 @section Home Score File
13952
13953 The score file where new score file entries will go is called the
13954 @dfn{home score file}.  This is normally (and by default) the score file
13955 for the group itself.  For instance, the home score file for
13956 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13957
13958 However, this may not be what you want.  It is often convenient to share
13959 a common home score file among many groups---all @samp{emacs} groups
13960 could perhaps use the same home score file.
13961
13962 @vindex gnus-home-score-file
13963 The variable that controls this is @code{gnus-home-score-file}.  It can
13964 be:
13965
13966 @enumerate
13967 @item
13968 A string.  Then this file will be used as the home score file for all
13969 groups.
13970
13971 @item
13972 A function. The result of this function will be used as the home score
13973 file.  The function will be called with the name of the group as the
13974 parameter.
13975
13976 @item
13977 A list.  The elements in this list can be:
13978
13979 @enumerate
13980 @item
13981 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
13982 the @var{file-name} will will be used as the home score file.
13983
13984 @item
13985 A function. If the function returns non-nil, the result will be used as
13986 the home score file.
13987
13988 @item
13989 A string.  Use the string as the home score file.
13990 @end enumerate
13991
13992 The list will be traversed from the beginning towards the end looking
13993 for matches.
13994
13995 @end enumerate
13996
13997 So, if you want to use just a single score file, you could say:
13998
13999 @lisp
14000 (setq gnus-home-score-file
14001       "my-total-score-file.SCORE")
14002 @end lisp
14003
14004 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
14005 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
14006
14007 @findex gnus-hierarchial-home-score-file
14008 @lisp
14009 (setq gnus-home-score-file
14010       'gnus-hierarchial-home-score-file)
14011 @end lisp
14012
14013 This is a ready-made function provided for your convenience.
14014 Other functions include
14015
14016 @table @code
14017 @item gnus-current-home-score-file
14018 @findex gnus-current-home-score-file
14019 Return the ``current'' regular score file.  This will make scoring
14020 commands add entry to the ``innermost'' matching score file.
14021
14022 @end table
14023
14024 If you want to have one score file for the @samp{emacs} groups and
14025 another for the @samp{comp} groups, while letting all other groups use
14026 their own home score files:
14027
14028 @lisp
14029 (setq gnus-home-score-file
14030       ;; All groups that match the regexp "\\.emacs"
14031       '(("\\.emacs" "emacs.SCORE")
14032         ;; All the comp groups in one score file
14033         ("^comp" "comp.SCORE")))
14034 @end lisp
14035
14036 @vindex gnus-home-adapt-file
14037 @code{gnus-home-adapt-file} works exactly the same way as
14038 @code{gnus-home-score-file}, but says what the home adaptive score file
14039 is instead.  All new adaptive file entries will go into the file
14040 specified by this variable, and the same syntax is allowed.
14041
14042 In addition to using @code{gnus-home-score-file} and
14043 @code{gnus-home-adapt-file}, you can also use group parameters
14044 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
14045 Parameters}) to achieve much the same.  Group and topic parameters take
14046 precedence over this variable.
14047
14048
14049 @node Followups To Yourself
14050 @section Followups To Yourself
14051
14052 Gnus offers two commands for picking out the @code{Message-ID} header in
14053 the current buffer.  Gnus will then add a score rule that scores using
14054 this @code{Message-ID} on the @code{References} header of other
14055 articles.  This will, in effect, increase the score of all articles that
14056 respond to the article in the current buffer.  Quite useful if you want
14057 to easily note when people answer what you've said.
14058
14059 @table @code
14060
14061 @item gnus-score-followup-article
14062 @findex gnus-score-followup-article
14063 This will add a score to articles that directly follow up your own
14064 article.
14065
14066 @item gnus-score-followup-thread
14067 @findex gnus-score-followup-thread
14068 This will add a score to all articles that appear in a thread ``below''
14069 your own article.
14070 @end table
14071
14072 @vindex message-sent-hook
14073 These two functions are both primarily meant to be used in hooks like
14074 @code{message-sent-hook}.
14075
14076 If you look closely at your own @code{Message-ID}, you'll notice that
14077 the first two or three characters are always the same.  Here's two of
14078 mine:
14079
14080 @example
14081 <x6u3u47icf.fsf@@eyesore.no>
14082 <x6sp9o7ibw.fsf@@eyesore.no>
14083 @end example
14084
14085 So ``my'' ident on this machine is @samp{x6}.  This can be
14086 exploited---the following rule will raise the score on all followups to
14087 myself:
14088
14089 @lisp
14090 ("references"
14091  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
14092   1000 nil r))
14093 @end lisp
14094
14095 Whether it's the first two or first three characters that are ``yours''
14096 is system-dependent.
14097
14098
14099 @node Scoring Tips
14100 @section Scoring Tips
14101 @cindex scoring tips
14102
14103 @table @dfn
14104
14105 @item Crossposts
14106 @cindex crossposts
14107 @cindex scoring crossposts
14108 If you want to lower the score of crossposts, the line to match on is
14109 the @code{Xref} header.
14110 @lisp
14111 ("xref" (" talk.politics.misc:" -1000))
14112 @end lisp
14113
14114 @item Multiple crossposts
14115 If you want to lower the score of articles that have been crossposted to
14116 more than, say, 3 groups:
14117 @lisp
14118 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
14119 @end lisp
14120
14121 @item Matching on the body
14122 This is generally not a very good idea---it takes a very long time.
14123 Gnus actually has to fetch each individual article from the server.  But
14124 you might want to anyway, I guess.  Even though there are three match
14125 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
14126 and stick with it in each score file.  If you use any two, each article
14127 will be fetched @emph{twice}.  If you want to match a bit on the
14128 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
14129 the matches.
14130
14131 @item Marking as read
14132 You will probably want to mark articles that has a score below a certain
14133 number as read.  This is most easily achieved by putting the following
14134 in your @file{all.SCORE} file:
14135 @lisp
14136 ((mark -100))
14137 @end lisp
14138 You may also consider doing something similar with @code{expunge}.
14139
14140 @item Negated character classes
14141 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
14142 That will match newlines, which might lead to, well, The Unknown.  Say
14143 @code{[^abcd\n]*} instead.
14144 @end table
14145
14146
14147 @node Reverse Scoring
14148 @section Reverse Scoring
14149 @cindex reverse scoring
14150
14151 If you want to keep just articles that have @samp{Sex with Emacs} in the
14152 subject header, and expunge all other articles, you could put something
14153 like this in your score file:
14154
14155 @lisp
14156 (("subject"
14157   ("Sex with Emacs" 2))
14158  (mark 1)
14159  (expunge 1))
14160 @end lisp
14161
14162 So, you raise all articles that match @samp{Sex with Emacs} and mark the
14163 rest as read, and expunge them to boot.
14164
14165
14166 @node Global Score Files
14167 @section Global Score Files
14168 @cindex global score files
14169
14170 Sure, other newsreaders have ``global kill files''.  These are usually
14171 nothing more than a single kill file that applies to all groups, stored
14172 in the user's home directory.  Bah!  Puny, weak newsreaders!
14173
14174 What I'm talking about here are Global Score Files.  Score files from
14175 all over the world, from users everywhere, uniting all nations in one
14176 big, happy score file union!  Ange-score!  New and untested!
14177
14178 @vindex gnus-global-score-files
14179 All you have to do to use other people's score files is to set the
14180 @code{gnus-global-score-files} variable.  One entry for each score file,
14181 or each score file directory.  Gnus will decide by itself what score
14182 files are applicable to which group.
14183
14184 Say you want to use the score file
14185 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
14186 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
14187
14188 @lisp
14189 (setq gnus-global-score-files
14190       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
14191         "/ftp@@ftp.some-where:/pub/score/"))
14192 @end lisp
14193
14194 @findex gnus-score-search-global-directories
14195 Simple, eh?  Directory names must end with a @samp{/}.  These
14196 directories are typically scanned only once during each Gnus session.
14197 If you feel the need to manually re-scan the remote directories, you can
14198 use the @code{gnus-score-search-global-directories} command.
14199
14200 Note that, at present, using this option will slow down group entry
14201 somewhat.  (That is---a lot.)
14202
14203 If you want to start maintaining score files for other people to use,
14204 just put your score file up for anonymous ftp and announce it to the
14205 world.  Become a retro-moderator!  Participate in the retro-moderator
14206 wars sure to ensue, where retro-moderators battle it out for the
14207 sympathy of the people, luring them to use their score files on false
14208 premises!  Yay!  The net is saved!
14209
14210 Here are some tips for the would-be retro-moderator, off the top of my
14211 head:
14212
14213 @itemize @bullet
14214
14215 @item
14216 Articles heavily crossposted are probably junk.
14217 @item
14218 To lower a single inappropriate article, lower by @code{Message-ID}.
14219 @item
14220 Particularly brilliant authors can be raised on a permanent basis.
14221 @item
14222 Authors that repeatedly post off-charter for the group can safely be
14223 lowered out of existence.
14224 @item
14225 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
14226 articles completely.
14227
14228 @item
14229 Use expiring score entries to keep the size of the file down.  You
14230 should probably have a long expiry period, though, as some sites keep
14231 old articles for a long time.
14232 @end itemize
14233
14234 ... I wonder whether other newsreaders will support global score files
14235 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
14236 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
14237 holding our breath yet?
14238
14239
14240 @node Kill Files
14241 @section Kill Files
14242 @cindex kill files
14243
14244 Gnus still supports those pesky old kill files.  In fact, the kill file
14245 entries can now be expiring, which is something I wrote before Daniel
14246 Quinlan thought of doing score files, so I've left the code in there.
14247
14248 In short, kill processing is a lot slower (and I do mean @emph{a lot})
14249 than score processing, so it might be a good idea to rewrite your kill
14250 files into score files.
14251
14252 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
14253 forms into this file, which means that you can use kill files as some
14254 sort of primitive hook function to be run on group entry, even though
14255 that isn't a very good idea.
14256
14257 Normal kill files look like this:
14258
14259 @lisp
14260 (gnus-kill "From" "Lars Ingebrigtsen")
14261 (gnus-kill "Subject" "ding")
14262 (gnus-expunge "X")
14263 @end lisp
14264
14265 This will mark every article written by me as read, and remove the
14266 marked articles from the summary buffer.  Very useful, you'll agree.
14267
14268 Other programs use a totally different kill file syntax.  If Gnus
14269 encounters what looks like a @code{rn} kill file, it will take a stab at
14270 interpreting it.
14271
14272 Two summary functions for editing a GNUS kill file:
14273
14274 @table @kbd
14275
14276 @item M-k
14277 @kindex M-k (Summary)
14278 @findex gnus-summary-edit-local-kill
14279 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
14280
14281 @item M-K
14282 @kindex M-K (Summary)
14283 @findex gnus-summary-edit-global-kill
14284 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
14285 @end table
14286
14287 Two group mode functions for editing the kill files:
14288
14289 @table @kbd
14290
14291 @item M-k
14292 @kindex M-k (Group)
14293 @findex gnus-group-edit-local-kill
14294 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
14295
14296 @item M-K
14297 @kindex M-K (Group)
14298 @findex gnus-group-edit-global-kill
14299 Edit the general kill file (@code{gnus-group-edit-global-kill}).
14300 @end table
14301
14302 Kill file variables:
14303
14304 @table @code
14305 @item gnus-kill-file-name
14306 @vindex gnus-kill-file-name
14307 A kill file for the group @samp{soc.motss} is normally called
14308 @file{soc.motss.KILL}.  The suffix appended to the group name to get
14309 this file name is detailed by the @code{gnus-kill-file-name} variable.
14310 The ``global'' kill file (not in the score file sense of ``global'', of
14311 course) is just called @file{KILL}.
14312
14313 @vindex gnus-kill-save-kill-file
14314 @item gnus-kill-save-kill-file
14315 If this variable is non-@code{nil}, Gnus will save the
14316 kill file after processing, which is necessary if you use expiring
14317 kills.
14318
14319 @item gnus-apply-kill-hook
14320 @vindex gnus-apply-kill-hook
14321 @findex gnus-apply-kill-file-unless-scored
14322 @findex gnus-apply-kill-file
14323 A hook called to apply kill files to a group.  It is
14324 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
14325 kill file if you have a score file for the same group, you can set this
14326 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
14327 kill files to be processed, you should set this variable to @code{nil}.
14328
14329 @item gnus-kill-file-mode-hook
14330 @vindex gnus-kill-file-mode-hook
14331 A hook called in kill-file mode buffers.
14332
14333 @end table
14334
14335
14336 @node Converting Kill Files
14337 @section Converting Kill Files
14338 @cindex kill files
14339 @cindex converting kill files
14340
14341 If you have loads of old kill files, you may want to convert them into
14342 score files.  If they are ``regular'', you can use
14343 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
14344 by hand.
14345
14346 The kill to score conversion package isn't included in Gnus by default.
14347 You can fetch it from
14348 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
14349
14350 If your old kill files are very complex---if they contain more
14351 non-@code{gnus-kill} forms than not, you'll have to convert them by
14352 hand.  Or just let them be as they are.  Gnus will still use them as
14353 before.
14354
14355
14356 @node GroupLens
14357 @section GroupLens
14358 @cindex GroupLens
14359
14360 GroupLens is a collaborative filtering system that helps you work
14361 together with other people to find the quality news articles out of the
14362 huge volume of news articles generated every day.
14363
14364 To accomplish this the GroupLens system combines your opinions about
14365 articles you have already read with the opinions of others who have done
14366 likewise and gives you a personalized prediction for each unread news
14367 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
14368 rate articles, and finds other people that rate articles the same way.
14369 Once it has found some people you agree with it tells you, in the form
14370 of a prediction, what they thought of the article.  You can use this
14371 prediction to help you decide whether or not you want to read the
14372 article.
14373
14374 @menu
14375 * Using GroupLens::          How to make Gnus use GroupLens.
14376 * Rating Articles::          Letting GroupLens know how you rate articles.
14377 * Displaying Predictions::   Displaying predictions given by GroupLens.
14378 * GroupLens Variables::      Customizing GroupLens.
14379 @end menu
14380
14381
14382 @node Using GroupLens
14383 @subsection Using GroupLens
14384
14385 To use GroupLens you must register a pseudonym with your local Better
14386 Bit Bureau (BBB).
14387 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
14388 better bit in town at the moment.
14389
14390 Once you have registered you'll need to set a couple of variables.
14391
14392 @table @code
14393
14394 @item gnus-use-grouplens
14395 @vindex gnus-use-grouplens
14396 Setting this variable to a non-@code{nil} value will make Gnus hook into
14397 all the relevant GroupLens functions.
14398
14399 @item grouplens-pseudonym
14400 @vindex grouplens-pseudonym
14401 This variable should be set to the pseudonym you got when registering
14402 with the Better Bit Bureau.
14403
14404 @item grouplens-newsgroups
14405 @vindex grouplens-newsgroups
14406 A list of groups that you want to get GroupLens predictions for.
14407
14408 @end table
14409
14410 That's the minimum of what you need to get up and running with GroupLens.
14411 Once you've registered, GroupLens will start giving you scores for
14412 articles based on the average of what other people think.  But, to get
14413 the real benefit of GroupLens you need to start rating articles
14414 yourself.  Then the scores GroupLens gives you will be personalized for
14415 you, based on how the people you usually agree with have already rated.
14416
14417
14418 @node Rating Articles
14419 @subsection Rating Articles
14420
14421 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
14422 Where 1 means something like this article is a waste of bandwidth and 5
14423 means that the article was really good.  The basic question to ask
14424 yourself is, "on a scale from 1 to 5 would I like to see more articles
14425 like this one?"
14426
14427 There are four ways to enter a rating for an article in GroupLens.
14428
14429 @table @kbd
14430
14431 @item r
14432 @kindex r (GroupLens)
14433 @findex bbb-summary-rate-article
14434 This function will prompt you for a rating on a scale of one to five.
14435
14436 @item k
14437 @kindex k (GroupLens)
14438 @findex grouplens-score-thread
14439 This function will prompt you for a rating, and rate all the articles in
14440 the thread.  This is really useful for some of those long running giant
14441 threads in rec.humor.
14442
14443 @end table
14444
14445 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
14446 the score of the article you're reading.
14447
14448 @table @kbd
14449
14450 @item 1-5 n
14451 @kindex n (GroupLens)
14452 @findex grouplens-next-unread-article
14453 Rate the article and go to the next unread article.
14454
14455 @item 1-5 ,
14456 @kindex , (GroupLens)
14457 @findex grouplens-best-unread-article
14458 Rate the article and go to the next unread article with the highest score.
14459
14460 @end table
14461
14462 If you want to give the current article a score of 4 and then go to the
14463 next article, just type @kbd{4 n}.
14464
14465
14466 @node Displaying Predictions
14467 @subsection Displaying Predictions
14468
14469 GroupLens makes a prediction for you about how much you will like a
14470 news article.  The predictions from GroupLens are on a scale from 1 to
14471 5, where 1 is the worst and 5 is the best.  You can use the predictions
14472 from GroupLens in one of three ways controlled by the variable
14473 @code{gnus-grouplens-override-scoring}.
14474
14475 @vindex gnus-grouplens-override-scoring
14476 There are three ways to display predictions in grouplens.  You may
14477 choose to have the GroupLens scores contribute to, or override the
14478 regular gnus scoring mechanism. override is the default; however, some
14479 people prefer to see the Gnus scores plus the grouplens scores.  To get
14480 the separate scoring behavior you need to set
14481 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
14482 GroupLens predictions combined with the grouplens scores set it to
14483 @code{'override} and to combine the scores set
14484 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
14485 the combine option you will also want to set the values for
14486 @code{grouplens-prediction-offset} and
14487 @code{grouplens-score-scale-factor}.
14488
14489 @vindex grouplens-prediction-display
14490 In either case, GroupLens gives you a few choices for how you would like
14491 to see your predictions displayed.  The display of predictions is
14492 controlled by the @code{grouplens-prediction-display} variable.
14493
14494 The following are valid values for that variable.
14495
14496 @table @code
14497 @item prediction-spot
14498 The higher the prediction, the further to the right an @samp{*} is
14499 displayed.
14500
14501 @item confidence-interval
14502 A numeric confidence interval.
14503
14504 @item prediction-bar
14505 The higher the prediction, the longer the bar.
14506
14507 @item confidence-bar
14508 Numerical confidence.
14509
14510 @item confidence-spot
14511 The spot gets bigger with more confidence.
14512
14513 @item prediction-num
14514 Plain-old numeric value.
14515
14516 @item confidence-plus-minus
14517 Prediction +/- confidence.
14518
14519 @end table
14520
14521
14522 @node GroupLens Variables
14523 @subsection GroupLens Variables
14524
14525 @table @code
14526
14527 @item gnus-summary-grouplens-line-format
14528 The summary line format used in GroupLens-enhanced summary buffers.  It
14529 accepts the same specs as the normal summary line format (@pxref{Summary
14530 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14531 %s\n}.
14532
14533 @item grouplens-bbb-host
14534 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
14535 default.
14536
14537 @item grouplens-bbb-port
14538 Port of the host running the bbbd server.  The default is 9000.
14539
14540 @item grouplens-score-offset
14541 Offset the prediction by this value.  In other words, subtract the
14542 prediction value by this number to arrive at the effective score.  The
14543 default is 0.
14544
14545 @item grouplens-score-scale-factor
14546 This variable allows the user to magnify the effect of GroupLens scores.
14547 The scale factor is applied after the offset.  The default is 1.
14548
14549 @end table
14550
14551
14552 @node Advanced Scoring
14553 @section Advanced Scoring
14554
14555 Scoring on Subjects and From headers is nice enough, but what if you're
14556 really interested in what a person has to say only when she's talking
14557 about a particular subject?  Or what if you really don't want to
14558 read what person A has to say when she's following up to person B, but
14559 want to read what she says when she's following up to person C?
14560
14561 By using advanced scoring rules you may create arbitrarily complex
14562 scoring patterns.
14563
14564 @menu
14565 * Advanced Scoring Syntax::     A definition.
14566 * Advanced Scoring Examples::   What they look like.
14567 * Advanced Scoring Tips::       Getting the most out of it.
14568 @end menu
14569
14570
14571 @node Advanced Scoring Syntax
14572 @subsection Advanced Scoring Syntax
14573
14574 Ordinary scoring rules have a string as the first element in the rule.
14575 Advanced scoring rules have a list as the first element.  The second
14576 element is the score to be applied if the first element evaluated to a
14577 non-@code{nil} value.
14578
14579 These lists may consist of three logical operators, one redirection
14580 operator, and various match operators.
14581
14582 Logical operators:
14583
14584 @table @code
14585 @item &
14586 @itemx and
14587 This logical operator will evaluate each of its arguments until it finds
14588 one that evaluates to @code{false}, and then it'll stop.  If all arguments
14589 evaluate to @code{true} values, then this operator will return
14590 @code{true}.
14591
14592 @item |
14593 @itemx or
14594 This logical operator will evaluate each of its arguments until it finds
14595 one that evaluates to @code{true}.  If no arguments are @code{true},
14596 then this operator will return @code{false}.
14597
14598 @item !
14599 @itemx not
14600 @itemx Â¬
14601 This logical operator only takes a single argument.  It returns the
14602 logical negation of the value of its argument.
14603
14604 @end table
14605
14606 There is an @dfn{indirection operator} that will make its arguments
14607 apply to the ancestors of the current article being scored.  For
14608 instance, @code{1-} will make score rules apply to the parent of the
14609 current article.  @code{2-} will make score rules apply to the
14610 grandparent of the current article.  Alternatively, you can write
14611 @code{^^}, where the number of @code{^}s (carets) says how far back into
14612 the ancestry you want to go.
14613
14614 Finally, we have the match operators.  These are the ones that do the
14615 real work.  Match operators are header name strings followed by a match
14616 and a match type.  A typical match operator looks like @samp{("from"
14617 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
14618 simple scoring, and the match types are also the same.
14619
14620
14621 @node Advanced Scoring Examples
14622 @subsection Advanced Scoring Examples
14623
14624 Let's say you want to increase the score of articles written by Lars
14625 when he's talking about Gnus:
14626
14627 @example
14628 ((&
14629   ("from" "Lars Ingebrigtsen")
14630   ("subject" "Gnus"))
14631  1000)
14632 @end example
14633
14634 Quite simple, huh?
14635
14636 When he writes long articles, he sometimes has something nice to say:
14637
14638 @example
14639 ((&
14640   ("from" "Lars Ingebrigtsen")
14641   (|
14642    ("subject" "Gnus")
14643    ("lines" 100 >)))
14644  1000)
14645 @end example
14646
14647 However, when he responds to things written by Reig Eigil Logge, you
14648 really don't want to read what he's written:
14649
14650 @example
14651 ((&
14652   ("from" "Lars Ingebrigtsen")
14653   (1- ("from" "Reig Eigir Logge")))
14654  -100000)
14655 @end example
14656
14657 Everybody that follows up Redmondo when he writes about disappearing
14658 socks should have their scores raised, but only when they talk about
14659 white socks.  However, when Lars talks about socks, it's usually not
14660 very interesting:
14661
14662 @example
14663 ((&
14664   (1-
14665    (&
14666     ("from" "redmondo@@.*no" r)
14667     ("body" "disappearing.*socks" t)))
14668   (! ("from" "Lars Ingebrigtsen"))
14669   ("body" "white.*socks"))
14670  1000)
14671 @end example
14672
14673 The possibilities are endless.
14674
14675
14676 @node Advanced Scoring Tips
14677 @subsection Advanced Scoring Tips
14678
14679 The @code{&} and @code{|} logical operators do short-circuit logic.
14680 That is, they stop processing their arguments when it's clear what the
14681 result of the operation will be.  For instance, if one of the arguments
14682 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14683 the rest of the arguments.  This means that you should put slow matches
14684 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14685 @samp{subject}) first.
14686
14687 The indirection arguments (@code{1-} and so on) will make their
14688 arguments work on previous generations of the thread.  If you say
14689 something like:
14690
14691 @example
14692 ...
14693 (1-
14694  (1-
14695   ("from" "lars")))
14696 ...
14697 @end example
14698
14699 Then that means "score on the from header of the grandparent of the
14700 current article".  An indirection is quite fast, but it's better to say:
14701
14702 @example
14703 (1-
14704  (&
14705   ("from" "Lars")
14706   ("subject" "Gnus")))
14707 @end example
14708
14709 than it is to say:
14710
14711 @example
14712 (&
14713  (1- ("from" "Lars"))
14714  (1- ("subject" "Gnus")))
14715 @end example
14716
14717
14718 @node Score Decays
14719 @section Score Decays
14720 @cindex score decays
14721 @cindex decays
14722
14723 You may find that your scores have a tendency to grow without
14724 bounds, especially if you're using adaptive scoring.  If scores get too
14725 big, they lose all meaning---they simply max out and it's difficult to
14726 use them in any sensible way.
14727
14728 @vindex gnus-decay-scores
14729 @findex gnus-decay-score
14730 @vindex gnus-decay-score-function
14731 Gnus provides a mechanism for decaying scores to help with this problem.
14732 When score files are loaded and @code{gnus-decay-scores} is
14733 non-@code{nil}, Gnus will run the score files through the decaying
14734 mechanism thereby lowering the scores of all non-permanent score rules.
14735 The decay itself if performed by the @code{gnus-decay-score-function}
14736 function, which is @code{gnus-decay-score} by default.  Here's the
14737 definition of that function:
14738
14739 @lisp
14740 (defun gnus-decay-score (score)
14741   "Decay SCORE.
14742 This is done according to `gnus-score-decay-constant'
14743 and `gnus-score-decay-scale'."
14744   (floor
14745    (- score
14746       (* (if (< score 0) 1 -1)
14747          (min (abs score)
14748               (max gnus-score-decay-constant
14749                    (* (abs score)
14750                       gnus-score-decay-scale)))))))
14751 @end lisp
14752
14753 @vindex gnus-score-decay-scale
14754 @vindex gnus-score-decay-constant
14755 @code{gnus-score-decay-constant} is 3 by default and
14756 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
14757
14758 @enumerate
14759 @item
14760 Scores between -3 and 3 will be set to 0 when this function is called.
14761
14762 @item
14763 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14764
14765 @item
14766 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14767 score.
14768 @end enumerate
14769
14770 If you don't like this decay function, write your own.  It is called
14771 with the score to be decayed as its only parameter, and it should return
14772 the new score, which should be an integer.
14773
14774 Gnus will try to decay scores once a day.  If you haven't run Gnus for
14775 four days, Gnus will decay the scores four times, for instance.
14776
14777
14778 @node Various
14779 @chapter Various
14780
14781 @menu
14782 * Process/Prefix::             A convention used by many treatment commands.
14783 * Interactive::                Making Gnus ask you many questions.
14784 * Symbolic Prefixes::          How to supply some Gnus functions with options.
14785 * Formatting Variables::       You can specify what buffers should look like.
14786 * Windows Configuration::      Configuring the Gnus buffer windows.
14787 * Faces and Fonts::            How to change how faces look.
14788 * Compilation::                How to speed Gnus up.
14789 * Mode Lines::                 Displaying information in the mode lines.
14790 * Highlighting and Menus::     Making buffers look all nice and cozy.
14791 * Buttons::                    Get tendonitis in ten easy steps!
14792 * Daemons::                    Gnus can do things behind your back.
14793 * NoCeM::                      How to avoid spam and other fatty foods.
14794 * Undo::                       Some actions can be undone.
14795 * Moderation::                 What to do if you're a moderator.
14796 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
14797 * Fuzzy Matching::             What's the big fuzz?
14798 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
14799 * Various Various::            Things that are really various.
14800 @end menu
14801
14802
14803 @node Process/Prefix
14804 @section Process/Prefix
14805 @cindex process/prefix convention
14806
14807 Many functions, among them functions for moving, decoding and saving
14808 articles, use what is known as the @dfn{Process/Prefix convention}.
14809
14810 This is a method for figuring out what articles the user wants the
14811 command to be performed on.
14812
14813 It goes like this:
14814
14815 If the numeric prefix is N, perform the operation on the next N
14816 articles, starting with the current one.  If the numeric prefix is
14817 negative, perform the operation on the previous N articles, starting
14818 with the current one.
14819
14820 @vindex transient-mark-mode
14821 If @code{transient-mark-mode} in non-@code{nil} and the region is
14822 active, all articles in the region will be worked upon.
14823
14824 If there is no numeric prefix, but some articles are marked with the
14825 process mark, perform the operation on the articles marked with
14826 the process mark.
14827
14828 If there is neither a numeric prefix nor any articles marked with the
14829 process mark, just perform the operation on the current article.
14830
14831 Quite simple, really, but it needs to be made clear so that surprises
14832 are avoided.
14833
14834 Commands that react to the process mark will push the current list of
14835 process marked articles onto a stack and will then clear all process
14836 marked articles.  You can restore the previous configuration with the
14837 @kbd{M P y} command (@pxref{Setting Process Marks}).
14838
14839 @vindex gnus-summary-goto-unread
14840 One thing that seems to shock & horrify lots of people is that, for
14841 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14842 Since each @kbd{d} (which marks the current article as read) by default
14843 goes to the next unread article after marking, this means that @kbd{3 d}
14844 will mark the next three unread articles as read, no matter what the
14845 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
14846 @code{nil} for a more straightforward action.
14847
14848
14849 @node Interactive
14850 @section Interactive
14851 @cindex interaction
14852
14853 @table @code
14854
14855 @item gnus-novice-user
14856 @vindex gnus-novice-user
14857 If this variable is non-@code{nil}, you are either a newcomer to the
14858 World of Usenet, or you are very cautious, which is a nice thing to be,
14859 really.  You will be given questions of the type ``Are you sure you want
14860 to do this?'' before doing anything dangerous.  This is @code{t} by
14861 default.
14862
14863 @item gnus-expert-user
14864 @vindex gnus-expert-user
14865 If this variable is non-@code{nil}, you will seldom be asked any
14866 questions by Gnus.  It will simply assume you know what you're doing, no
14867 matter how strange.
14868
14869 @item gnus-interactive-catchup
14870 @vindex gnus-interactive-catchup
14871 Require confirmation before catching up a group if non-@code{nil}.  It
14872 is @code{t} by default.
14873
14874 @item gnus-interactive-exit
14875 @vindex gnus-interactive-exit
14876 Require confirmation before exiting Gnus.  This variable is @code{t} by
14877 default.
14878 @end table
14879
14880
14881 @node Symbolic Prefixes
14882 @section Symbolic Prefixes
14883 @cindex symbolic prefixes
14884
14885 Quite a lot of Emacs commands react to the (numeric) prefix.  For
14886 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14887 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14888 rule of 900 to the current article.
14889
14890 This is all nice and well, but what if you want to give a command some
14891 additional information?  Well, what most commands do is interpret the
14892 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
14893 doesn't want a backup file to be created when saving the current buffer,
14894 for instance.  But what if you want to save without making a backup
14895 file, and you want Emacs to flash lights and play a nice tune at the
14896 same time?  You can't, and you're probably perfectly happy that way.
14897
14898 @kindex M-i (Summary)
14899 @findex gnus-symbolic-argument
14900 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
14901 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14902 character typed in is the value.  You can stack as many @kbd{M-i}
14903 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14904 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
14905 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14906 @code{b}''.  You get the drift.
14907
14908 Typing in symbolic prefixes to commands that don't accept them doesn't
14909 hurt, but it doesn't do any good either.  Currently not many Gnus
14910 functions make use of the symbolic prefix.
14911
14912 If you're interested in how Gnus implements this, @pxref{Extended
14913 Interactive}.
14914
14915
14916 @node Formatting Variables
14917 @section Formatting Variables
14918 @cindex formatting variables
14919
14920 Throughout this manual you've probably noticed lots of variables called
14921 things like @code{gnus-group-line-format} and
14922 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
14923 output lines in the various buffers.  There's quite a lot of them.
14924 Fortunately, they all use the same syntax, so there's not that much to
14925 be annoyed by.
14926
14927 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14928 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
14929 lots of percentages everywhere.
14930
14931 @menu
14932 * Formatting Basics::     A formatting variable is basically a format string.
14933 * Mode Line Formatting::  Some rules about mode line formatting variables.
14934 * Advanced Formatting::   Modifying output in various ways.
14935 * User-Defined Specs::    Having Gnus call your own functions.
14936 * Formatting Fonts::      Making the formatting look colorful and nice.
14937 @end menu
14938
14939 Currently Gnus uses the following formatting variables:
14940 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14941 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14942 @code{gnus-group-mode-line-format},
14943 @code{gnus-summary-mode-line-format},
14944 @code{gnus-article-mode-line-format},
14945 @code{gnus-server-mode-line-format}, and
14946 @code{gnus-summary-pick-line-format}.
14947
14948 All these format variables can also be arbitrary elisp forms.  In that
14949 case, they will be @code{eval}ed to insert the required lines.
14950
14951 @kindex M-x gnus-update-format
14952 @findex gnus-update-format
14953 Gnus includes a command to help you while creating your own format
14954 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
14955 update the spec in question and pop you to a buffer where you can
14956 examine the resulting lisp code to be run to generate the line.
14957
14958
14959
14960 @node Formatting Basics
14961 @subsection Formatting Basics
14962
14963 Each @samp{%} element will be replaced by some string or other when the
14964 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
14965 spec, and pad with spaces to get a 5-character field''.
14966
14967 As with normal C and Emacs Lisp formatting strings, the numerical
14968 modifier between the @samp{%} and the formatting type character will
14969 @dfn{pad} the output so that it is always at least that long.
14970 @samp{%5y} will make the field always (at least) five characters wide by
14971 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
14972 the right instead.
14973
14974 You may also wish to limit the length of the field to protect against
14975 particularly wide values.  For that you can say @samp{%4,6y}, which
14976 means that the field will never be more than 6 characters wide and never
14977 less than 4 characters wide.
14978
14979
14980 @node Mode Line Formatting
14981 @subsection Mode Line Formatting
14982
14983 Mode line formatting variables (e.g.,
14984 @code{gnus-summary-mode-line-format}) follow the same rules as other,
14985 buffer line oriented formatting variables (@pxref{Formatting Basics})
14986 with the following two differences:
14987
14988 @enumerate
14989
14990 @item
14991 There must be no newline (@samp{\n}) at the end.
14992
14993 @item
14994 The special @samp{%%b} spec can be used to display the buffer name.
14995 Well, it's no spec at all, really---@samp{%%} is just a way to quote
14996 @samp{%} to allow it to pass through the formatting machinery unmangled,
14997 so that Emacs receives @samp{%b}, which is something the Emacs mode line
14998 display interprets to mean ``show the buffer name''.  For a full list of
14999 mode line specs Emacs understands, see the documentation of the
15000 @code{mode-line-format} variable.
15001
15002 @end enumerate
15003
15004
15005 @node Advanced Formatting
15006 @subsection Advanced Formatting
15007
15008 It is frequently useful to post-process the fields in some way.
15009 Padding, limiting, cutting off parts and suppressing certain values can
15010 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
15011 look like @samp{%~(cut 3)~(ignore "0")y}.
15012
15013 These are the valid modifiers:
15014
15015 @table @code
15016 @item pad
15017 @itemx pad-left
15018 Pad the field to the left with spaces until it reaches the required
15019 length.
15020
15021 @item pad-right
15022 Pad the field to the right with spaces until it reaches the required
15023 length.
15024
15025 @item max
15026 @itemx max-left
15027 Cut off characters from the left until it reaches the specified length.
15028
15029 @item max-right
15030 Cut off characters from the right until it reaches the specified
15031 length.
15032
15033 @item cut
15034 @itemx cut-left
15035 Cut off the specified number of characters from the left.
15036
15037 @item cut-right
15038 Cut off the specified number of characters from the right.
15039
15040 @item ignore
15041 Return an empty string if the field is equal to the specified value.
15042
15043 @item form
15044 Use the specified form as the field value when the @samp{@@} spec is
15045 used.
15046 @end table
15047
15048 Let's take an example.  The @samp{%o} spec in the summary mode lines
15049 will return a date in compact ISO8601 format---@samp{19960809T230410}.
15050 This is quite a mouthful, so we want to shave off the century number and
15051 the time, leaving us with a six-character date.  That would be
15052 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
15053 maxing, and we need the padding to ensure that the date is never less
15054 than 6 characters to make it look nice in columns.)
15055
15056 Ignoring is done first; then cutting; then maxing; and then as the very
15057 last operation, padding.
15058
15059 If you use lots of these advanced thingies, you'll find that Gnus gets
15060 quite slow.  This can be helped enormously by running @kbd{M-x
15061 gnus-compile} when you are satisfied with the look of your lines.
15062 @xref{Compilation}.
15063
15064
15065 @node User-Defined Specs
15066 @subsection User-Defined Specs
15067
15068 All the specs allow for inserting user defined specifiers---@samp{u}.
15069 The next character in the format string should be a letter.  Gnus
15070 will call the function @code{gnus-user-format-function-}@samp{X}, where
15071 @samp{X} is the letter following @samp{%u}.  The function will be passed
15072 a single parameter---what the parameter means depends on what buffer
15073 it's being called from.  The function should return a string, which will
15074 be inserted into the buffer just like information from any other
15075 specifier.  This function may also be called with dummy values, so it
15076 should protect against that.
15077
15078 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
15079 much the same without defining new functions.  Here's an example:
15080 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
15081 given here will be evaluated to yield the current line number, and then
15082 inserted.
15083
15084
15085 @node Formatting Fonts
15086 @subsection Formatting Fonts
15087
15088 There are specs for highlighting, and these are shared by all the format
15089 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
15090 the special @code{mouse-face} property set, which means that it will be
15091 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
15092 over it.
15093
15094 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
15095 normal faces set using @code{gnus-face-0}, which is @code{bold} by
15096 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
15097 and so on.  Create as many faces as you wish.  The same goes for the
15098 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
15099 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
15100
15101 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
15102 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
15103 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
15104 @code{gnus-balloon-face-*} variables should be either strings or
15105 symbols naming functions that return a string. Under @code{balloon-help-mode},
15106 when the mouse passes over text with this property set, a balloon window
15107 will appear and display the string. Please refer to the doc string of
15108 @code{balloon-help-mode} for more information on this.
15109
15110 Here's an alternative recipe for the group buffer:
15111
15112 @lisp
15113 ;; Create three face types.
15114 (setq gnus-face-1 'bold)
15115 (setq gnus-face-3 'italic)
15116
15117 ;; We want the article count to be in
15118 ;; a bold and green face.  So we create
15119 ;; a new face called `my-green-bold'.
15120 (copy-face 'bold 'my-green-bold)
15121 ;; Set the color.
15122 (set-face-foreground 'my-green-bold "ForestGreen")
15123 (setq gnus-face-2 'my-green-bold)
15124
15125 ;; Set the new & fancy format.
15126 (setq gnus-group-line-format
15127       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
15128 @end lisp
15129
15130 I'm sure you'll be able to use this scheme to create totally unreadable
15131 and extremely vulgar displays.  Have fun!
15132
15133 Note that the @samp{%(} specs (and friends) do not make any sense on the
15134 mode-line variables.
15135
15136
15137 @node Windows Configuration
15138 @section Windows Configuration
15139 @cindex windows configuration
15140
15141 No, there's nothing here about X, so be quiet.
15142
15143 @vindex gnus-use-full-window
15144 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
15145 other windows and occupy the entire Emacs screen by itself.  It is
15146 @code{t} by default.
15147
15148 Setting this variable to @code{nil} kinda works, but there are
15149 glitches.  Use at your own peril.
15150
15151 @vindex gnus-buffer-configuration
15152 @code{gnus-buffer-configuration} describes how much space each Gnus
15153 buffer should be given.  Here's an excerpt of this variable:
15154
15155 @lisp
15156 ((group (vertical 1.0 (group 1.0 point)
15157                       (if gnus-carpal (group-carpal 4))))
15158  (article (vertical 1.0 (summary 0.25 point)
15159                         (article 1.0))))
15160 @end lisp
15161
15162 This is an alist.  The @dfn{key} is a symbol that names some action or
15163 other.  For instance, when displaying the group buffer, the window
15164 configuration function will use @code{group} as the key.  A full list of
15165 possible names is listed below.
15166
15167 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
15168 should occupy.  To take the @code{article} split as an example -
15169
15170 @lisp
15171 (article (vertical 1.0 (summary 0.25 point)
15172                        (article 1.0)))
15173 @end lisp
15174
15175 This @dfn{split} says that the summary buffer should occupy 25% of upper
15176 half of the screen, and that it is placed over the article buffer.  As
15177 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
15178 reaching for that calculator there).  However, the special number
15179 @code{1.0} is used to signal that this buffer should soak up all the
15180 rest of the space available after the rest of the buffers have taken
15181 whatever they need.  There should be only one buffer with the @code{1.0}
15182 size spec per split.
15183
15184 Point will be put in the buffer that has the optional third element
15185 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
15186 split where the tag @code{frame-focus} is a member (i.e. is the third or
15187 fourth element in the list, depending on whether the @code{point} tag is
15188 present) gets focus.
15189
15190 Here's a more complicated example:
15191
15192 @lisp
15193 (article (vertical 1.0 (group 4)
15194                        (summary 0.25 point)
15195                        (if gnus-carpal (summary-carpal 4))
15196                        (article 1.0)))
15197 @end lisp
15198
15199 If the size spec is an integer instead of a floating point number,
15200 then that number will be used to say how many lines a buffer should
15201 occupy, not a percentage.
15202
15203 If the @dfn{split} looks like something that can be @code{eval}ed (to be
15204 precise---if the @code{car} of the split is a function or a subr), this
15205 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
15206 be used as a split.  This means that there will be three buffers if
15207 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
15208 is non-@code{nil}.
15209
15210 Not complicated enough for you?  Well, try this on for size:
15211
15212 @lisp
15213 (article (horizontal 1.0
15214              (vertical 0.5
15215                  (group 1.0)
15216                  (gnus-carpal 4))
15217              (vertical 1.0
15218                  (summary 0.25 point)
15219                  (summary-carpal 4)
15220                  (article 1.0))))
15221 @end lisp
15222
15223 Whoops.  Two buffers with the mystery 100% tag.  And what's that
15224 @code{horizontal} thingie?
15225
15226 If the first element in one of the split is @code{horizontal}, Gnus will
15227 split the window horizontally, giving you two windows side-by-side.
15228 Inside each of these strips you may carry on all you like in the normal
15229 fashion.  The number following @code{horizontal} says what percentage of
15230 the screen is to be given to this strip.
15231
15232 For each split, there @emph{must} be one element that has the 100% tag.
15233 The splitting is never accurate, and this buffer will eat any leftover
15234 lines from the splits.
15235
15236 To be slightly more formal, here's a definition of what a valid split
15237 may look like:
15238
15239 @example
15240 split       = frame | horizontal | vertical | buffer | form
15241 frame       = "(frame " size *split ")"
15242 horizontal  = "(horizontal " size *split ")"
15243 vertical    = "(vertical " size *split ")"
15244 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
15245 size        = number | frame-params
15246 buffer-name = group | article | summary ...
15247 @end example
15248
15249 The limitations are that the @code{frame} split can only appear as the
15250 top-level split.  @var{form} should be an Emacs Lisp form that should
15251 return a valid split.  We see that each split is fully recursive, and
15252 may contain any number of @code{vertical} and @code{horizontal} splits.
15253
15254 @vindex gnus-window-min-width
15255 @vindex gnus-window-min-height
15256 @cindex window height
15257 @cindex window width
15258 Finding the right sizes can be a bit complicated.  No window may be less
15259 than @code{gnus-window-min-height} (default 1) characters high, and all
15260 windows must be at least @code{gnus-window-min-width} (default 1)
15261 characters wide.  Gnus will try to enforce this before applying the
15262 splits.  If you want to use the normal Emacs window width/height limit,
15263 you can just set these two variables to @code{nil}.
15264
15265 If you're not familiar with Emacs terminology, @code{horizontal} and
15266 @code{vertical} splits may work the opposite way of what you'd expect.
15267 Windows inside a @code{horizontal} split are shown side-by-side, and
15268 windows within a @code{vertical} split are shown above each other.
15269
15270 @findex gnus-configure-frame
15271 If you want to experiment with window placement, a good tip is to call
15272 @code{gnus-configure-frame} directly with a split.  This is the function
15273 that does all the real work when splitting buffers.  Below is a pretty
15274 nonsensical configuration with 5 windows; two for the group buffer and
15275 three for the article buffer.  (I said it was nonsensical.)  If you
15276 @code{eval} the statement below, you can get an idea of how that would
15277 look straight away, without going through the normal Gnus channels.
15278 Play with it until you're satisfied, and then use
15279 @code{gnus-add-configuration} to add your new creation to the buffer
15280 configuration list.
15281
15282 @lisp
15283 (gnus-configure-frame
15284  '(horizontal 1.0
15285     (vertical 10
15286       (group 1.0)
15287       (article 0.3 point))
15288     (vertical 1.0
15289       (article 1.0)
15290       (horizontal 4
15291         (group 1.0)
15292         (article 10)))))
15293 @end lisp
15294
15295 You might want to have several frames as well.  No prob---just use the
15296 @code{frame} split:
15297
15298 @lisp
15299 (gnus-configure-frame
15300  '(frame 1.0
15301          (vertical 1.0
15302                    (summary 0.25 point frame-focus)
15303                    (article 1.0))
15304          (vertical ((height . 5) (width . 15)
15305                     (user-position . t)
15306                     (left . -1) (top . 1))
15307                    (picon 1.0))))
15308
15309 @end lisp
15310
15311 This split will result in the familiar summary/article window
15312 configuration in the first (or ``main'') frame, while a small additional
15313 frame will be created where picons will be shown.  As you can see,
15314 instead of the normal @code{1.0} top-level spec, each additional split
15315 should have a frame parameter alist as the size spec.
15316 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
15317 Reference Manual}.  Under XEmacs, a frame property list will be
15318 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
15319 is such a plist.
15320 The list of all possible keys for @code{gnus-buffer-configuration} can
15321 be found in its default value.
15322
15323 Note that the @code{message} key is used for both
15324 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
15325 it is desirable to distinguish between the two, something like this
15326 might be used:
15327
15328 @lisp
15329 (message (horizontal 1.0
15330                      (vertical 1.0 (message 1.0 point))
15331                      (vertical 0.24
15332                                (if (buffer-live-p gnus-summary-buffer)
15333                                    '(summary 0.5))
15334                                (group 1.0)))))
15335 @end lisp
15336
15337 One common desire for a multiple frame split is to have a separate frame
15338 for composing mail and news while leaving the original frame intact.  To
15339 accomplish that, something like the following can be done:
15340
15341 @lisp
15342 (message (frame 1.0
15343                 (if (not (buffer-live-p gnus-summary-buffer))
15344                     (car (cdr (assoc 'group gnus-buffer-configuration)))
15345                   (car (cdr (assoc 'summary gnus-buffer-configuration))))
15346                 (vertical ((user-position . t) (top . 1) (left . 1)
15347                            (name . "Message"))
15348                           (message 1.0 point))))
15349 @end lisp
15350
15351 @findex gnus-add-configuration
15352 Since the @code{gnus-buffer-configuration} variable is so long and
15353 complicated, there's a function you can use to ease changing the config
15354 of a single setting: @code{gnus-add-configuration}.  If, for instance,
15355 you want to change the @code{article} setting, you could say:
15356
15357 @lisp
15358 (gnus-add-configuration
15359  '(article (vertical 1.0
15360                (group 4)
15361                (summary .25 point)
15362                (article 1.0))))
15363 @end lisp
15364
15365 You'd typically stick these @code{gnus-add-configuration} calls in your
15366 @file{.gnus.el} file or in some startup hook---they should be run after
15367 Gnus has been loaded.
15368
15369 @vindex gnus-always-force-window-configuration
15370 If all windows mentioned in the configuration are already visible, Gnus
15371 won't change the window configuration.  If you always want to force the
15372 ``right'' window configuration, you can set
15373 @code{gnus-always-force-window-configuration} to non-@code{nil}.
15374
15375 If you're using tree displays (@pxref{Tree Display}), and the tree
15376 window is displayed vertically next to another window, you may also want
15377 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
15378 windows resized.
15379
15380
15381 @node Faces and Fonts
15382 @section Faces and Fonts
15383 @cindex faces
15384 @cindex fonts
15385 @cindex colors
15386
15387 Fiddling with fonts and faces used to be very difficult, but these days
15388 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
15389 the face you want to alter, and alter it via the standard Customize
15390 interface.
15391
15392
15393 @node Compilation
15394 @section Compilation
15395 @cindex compilation
15396 @cindex byte-compilation
15397
15398 @findex gnus-compile
15399
15400 Remember all those line format specification variables?
15401 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
15402 on.  Now, Gnus will of course heed whatever these variables are, but,
15403 unfortunately, changing them will mean a quite significant slow-down.
15404 (The default values of these variables have byte-compiled functions
15405 associated with them, while the user-generated versions do not, of
15406 course.)
15407
15408 To help with this, you can run @kbd{M-x gnus-compile} after you've
15409 fiddled around with the variables and feel that you're (kind of)
15410 satisfied.  This will result in the new specs being byte-compiled, and
15411 you'll get top speed again.  Gnus will save these compiled specs in the
15412 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
15413 this function, though---you should compile them yourself by sticking
15414 them into the @code{.gnus.el} file and byte-compiling that file.)
15415
15416
15417 @node Mode Lines
15418 @section Mode Lines
15419 @cindex mode lines
15420
15421 @vindex gnus-updated-mode-lines
15422 @code{gnus-updated-mode-lines} says what buffers should keep their mode
15423 lines updated.  It is a list of symbols.  Supported symbols include
15424 @code{group}, @code{article}, @code{summary}, @code{server},
15425 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
15426 Gnus will keep that mode line updated with information that may be
15427 pertinent.  If this variable is @code{nil}, screen refresh may be
15428 quicker.
15429
15430 @cindex display-time
15431
15432 @vindex gnus-mode-non-string-length
15433 By default, Gnus displays information on the current article in the mode
15434 lines of the summary and article buffers.  The information Gnus wishes
15435 to display (e.g. the subject of the article) is often longer than the
15436 mode lines, and therefore have to be cut off at some point.  The
15437 @code{gnus-mode-non-string-length} variable says how long the other
15438 elements on the line is (i.e., the non-info part).  If you put
15439 additional elements on the mode line (e.g. a clock), you should modify
15440 this variable:
15441
15442 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
15443 @lisp
15444 (add-hook 'display-time-hook
15445           (lambda () (setq gnus-mode-non-string-length
15446                            (+ 21
15447                               (if line-number-mode 5 0)
15448                               (if column-number-mode 4 0)
15449                               (length display-time-string)))))
15450 @end lisp
15451
15452 If this variable is @code{nil} (which is the default), the mode line
15453 strings won't be chopped off, and they won't be padded either.  Note
15454 that the default is unlikely to be desirable, as even the percentage
15455 complete in the buffer may be crowded off the mode line; the user should
15456 configure this variable appropriately for her configuration.
15457
15458
15459 @node Highlighting and Menus
15460 @section Highlighting and Menus
15461 @cindex visual
15462 @cindex highlighting
15463 @cindex menus
15464
15465 @vindex gnus-visual
15466 The @code{gnus-visual} variable controls most of the Gnus-prettifying
15467 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
15468 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
15469 file.
15470
15471 This variable can be a list of visual properties that are enabled.  The
15472 following elements are valid, and are all included by default:
15473
15474 @table @code
15475 @item group-highlight
15476 Do highlights in the group buffer.
15477 @item summary-highlight
15478 Do highlights in the summary buffer.
15479 @item article-highlight
15480 Do highlights in the article buffer.
15481 @item highlight
15482 Turn on highlighting in all buffers.
15483 @item group-menu
15484 Create menus in the group buffer.
15485 @item summary-menu
15486 Create menus in the summary buffers.
15487 @item article-menu
15488 Create menus in the article buffer.
15489 @item browse-menu
15490 Create menus in the browse buffer.
15491 @item server-menu
15492 Create menus in the server buffer.
15493 @item score-menu
15494 Create menus in the score buffers.
15495 @item menu
15496 Create menus in all buffers.
15497 @end table
15498
15499 So if you only want highlighting in the article buffer and menus in all
15500 buffers, you could say something like:
15501
15502 @lisp
15503 (setq gnus-visual '(article-highlight menu))
15504 @end lisp
15505
15506 If you want highlighting only and no menus whatsoever, you'd say:
15507
15508 @lisp
15509 (setq gnus-visual '(highlight))
15510 @end lisp
15511
15512 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
15513 in all Gnus buffers.
15514
15515 Other general variables that influence the look of all buffers include:
15516
15517 @table @code
15518 @item gnus-mouse-face
15519 @vindex gnus-mouse-face
15520 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
15521 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15522
15523 @end table
15524
15525 There are hooks associated with the creation of all the different menus:
15526
15527 @table @code
15528
15529 @item gnus-article-menu-hook
15530 @vindex gnus-article-menu-hook
15531 Hook called after creating the article mode menu.
15532
15533 @item gnus-group-menu-hook
15534 @vindex gnus-group-menu-hook
15535 Hook called after creating the group mode menu.
15536
15537 @item gnus-summary-menu-hook
15538 @vindex gnus-summary-menu-hook
15539 Hook called after creating the summary mode menu.
15540
15541 @item gnus-server-menu-hook
15542 @vindex gnus-server-menu-hook
15543 Hook called after creating the server mode menu.
15544
15545 @item gnus-browse-menu-hook
15546 @vindex gnus-browse-menu-hook
15547 Hook called after creating the browse mode menu.
15548
15549 @item gnus-score-menu-hook
15550 @vindex gnus-score-menu-hook
15551 Hook called after creating the score mode menu.
15552
15553 @end table
15554
15555
15556 @node Buttons
15557 @section Buttons
15558 @cindex buttons
15559 @cindex mouse
15560 @cindex click
15561
15562 Those new-fangled @dfn{mouse} contraptions is very popular with the
15563 young, hep kids who don't want to learn the proper way to do things
15564 these days.  Why, I remember way back in the summer of '89, when I was
15565 using Emacs on a Tops 20 system.  Three hundred users on one single
15566 machine, and every user was running Simula compilers.  Bah!
15567
15568 Right.
15569
15570 @vindex gnus-carpal
15571 Well, you can make Gnus display bufferfuls of buttons you can click to
15572 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
15573 really.  Tell the chiropractor I sent you.
15574
15575
15576 @table @code
15577
15578 @item gnus-carpal-mode-hook
15579 @vindex gnus-carpal-mode-hook
15580 Hook run in all carpal mode buffers.
15581
15582 @item gnus-carpal-button-face
15583 @vindex gnus-carpal-button-face
15584 Face used on buttons.
15585
15586 @item gnus-carpal-header-face
15587 @vindex gnus-carpal-header-face
15588 Face used on carpal buffer headers.
15589
15590 @item gnus-carpal-group-buffer-buttons
15591 @vindex gnus-carpal-group-buffer-buttons
15592 Buttons in the group buffer.
15593
15594 @item gnus-carpal-summary-buffer-buttons
15595 @vindex gnus-carpal-summary-buffer-buttons
15596 Buttons in the summary buffer.
15597
15598 @item gnus-carpal-server-buffer-buttons
15599 @vindex gnus-carpal-server-buffer-buttons
15600 Buttons in the server buffer.
15601
15602 @item gnus-carpal-browse-buffer-buttons
15603 @vindex gnus-carpal-browse-buffer-buttons
15604 Buttons in the browse buffer.
15605 @end table
15606
15607 All the @code{buttons} variables are lists.  The elements in these list
15608 are either cons cells where the @code{car} contains a text to be displayed and
15609 the @code{cdr} contains a function symbol, or a simple string.
15610
15611
15612 @node Daemons
15613 @section Daemons
15614 @cindex demons
15615 @cindex daemons
15616
15617 Gnus, being larger than any program ever written (allegedly), does lots
15618 of strange stuff that you may wish to have done while you're not
15619 present.  For instance, you may want it to check for new mail once in a
15620 while.  Or you may want it to close down all connections to all servers
15621 when you leave Emacs idle.  And stuff like that.
15622
15623 Gnus will let you do stuff like that by defining various
15624 @dfn{handlers}.  Each handler consists of three elements:  A
15625 @var{function}, a @var{time}, and an @var{idle} parameter.
15626
15627 Here's an example of a handler that closes connections when Emacs has
15628 been idle for thirty minutes:
15629
15630 @lisp
15631 (gnus-demon-close-connections nil 30)
15632 @end lisp
15633
15634 Here's a handler that scans for PGP headers every hour when Emacs is
15635 idle:
15636
15637 @lisp
15638 (gnus-demon-scan-pgp 60 t)
15639 @end lisp
15640
15641 This @var{time} parameter and than @var{idle} parameter work together
15642 in a strange, but wonderful fashion.  Basically, if @var{idle} is
15643 @code{nil}, then the function will be called every @var{time} minutes.
15644
15645 If @var{idle} is @code{t}, then the function will be called after
15646 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
15647 the function will never be called.  But once Emacs goes idle, the
15648 function will be called every @var{time} minutes.
15649
15650 If @var{idle} is a number and @var{time} is a number, the function will
15651 be called every @var{time} minutes only when Emacs has been idle for
15652 @var{idle} minutes.
15653
15654 If @var{idle} is a number and @var{time} is @code{nil}, the function
15655 will be called once every time Emacs has been idle for @var{idle}
15656 minutes.
15657
15658 And if @var{time} is a string, it should look like @samp{07:31}, and
15659 the function will then be called once every day somewhere near that
15660 time.  Modified by the @var{idle} parameter, of course.
15661
15662 @vindex gnus-demon-timestep
15663 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15664 seconds.  This is 60 by default.  If you change that variable,
15665 all the timings in the handlers will be affected.)
15666
15667 So, if you want to add a handler, you could put something like this in
15668 your @file{.gnus} file:
15669
15670 @findex gnus-demon-add-handler
15671 @lisp
15672 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15673 @end lisp
15674
15675 @findex gnus-demon-add-nocem
15676 @findex gnus-demon-add-scanmail
15677 @findex gnus-demon-add-rescan
15678 @findex gnus-demon-add-scan-timestamps
15679 @findex gnus-demon-add-disconnection
15680 Some ready-made functions to do this have been created:
15681 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15682 @code{gnus-demon-add-nntp-close-connection},
15683 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15684 @code{gnus-demon-add-scanmail}.  Just put those functions in your
15685 @file{.gnus} if you want those abilities.
15686
15687 @findex gnus-demon-init
15688 @findex gnus-demon-cancel
15689 @vindex gnus-demon-handlers
15690 If you add handlers to @code{gnus-demon-handlers} directly, you should
15691 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
15692 daemons, you can use the @code{gnus-demon-cancel} function.
15693
15694 Note that adding daemons can be pretty naughty if you over do it.  Adding
15695 functions that scan all news and mail from all servers every two seconds
15696 is a sure-fire way of getting booted off any respectable system.  So
15697 behave.
15698
15699
15700 @node NoCeM
15701 @section NoCeM
15702 @cindex nocem
15703 @cindex spam
15704
15705 @dfn{Spamming} is posting the same article lots and lots of times.
15706 Spamming is bad.  Spamming is evil.
15707
15708 Spamming is usually canceled within a day or so by various anti-spamming
15709 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
15710 NoCeM is pronounced ``no see-'em'', and means what the name
15711 implies---these are messages that make the offending articles, like, go
15712 away.
15713
15714 What use are these NoCeM messages if the articles are canceled anyway?
15715 Some sites do not honor cancel messages and some sites just honor cancels
15716 from a select few people.  Then you may wish to make use of the NoCeM
15717 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15718
15719 Gnus can read and parse the messages in this group automatically, and
15720 this will make spam disappear.
15721
15722 There are some variables to customize, of course:
15723
15724 @table @code
15725 @item gnus-use-nocem
15726 @vindex gnus-use-nocem
15727 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
15728 by default.
15729
15730 @item gnus-nocem-groups
15731 @vindex gnus-nocem-groups
15732 Gnus will look for NoCeM messages in the groups in this list.  The
15733 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15734 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15735
15736 @item gnus-nocem-issuers
15737 @vindex gnus-nocem-issuers
15738 There are many people issuing NoCeM messages.  This list says what
15739 people you want to listen to.  The default is @code{("Automoose-1"
15740 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15741 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15742 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15743
15744 Known despammers that you can put in this list include:
15745
15746 @table @samp
15747 @item clewis@@ferret.ocunix.on.ca;
15748 @cindex Chris Lewis
15749 Chris Lewis---Major Canadian despammer who has probably canceled more
15750 usenet abuse than anybody else.
15751
15752 @item Automoose-1
15753 @cindex CancelMoose[tm]
15754 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
15755 Norwegian, and was the person(s) who invented NoCeM.
15756
15757 @item jem@@xpat.com;
15758 @cindex Jem
15759 John Milburn---despammer located in Korea who is getting very busy these
15760 days.
15761
15762 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15763 Richard E. Depew---lone American despammer.  He mostly cancels binary
15764 postings to non-binary groups and removes spews (regurgitated articles).
15765 @end table
15766
15767 You do not have to heed NoCeM messages from all these people---just the
15768 ones you want to listen to.  You also don't have to accept all NoCeM
15769 messages from the people you like.  Each NoCeM message has a @dfn{type}
15770 header that gives the message a (more or less, usually less) rigorous
15771 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15772 @samp{binary}, and @samp{troll}.  To specify this, you have to use
15773 @var{(issuer conditions ...)} elements in the list.  Each condition is
15774 either a string (which is a regexp that matches types you want to use)
15775 or a list on the form @code{(not STRING)}, where @var{string} is a
15776 regexp that matches types you don't want to use.
15777
15778 For instance, if you want all NoCeM messages from Chris Lewis except his
15779 @samp{troll} messages, you'd say:
15780
15781 @lisp
15782 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15783 @end lisp
15784
15785 On the other hand, if you just want nothing but his @samp{spam} and
15786 @samp{spew} messages, you'd say:
15787
15788 @lisp
15789 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15790 @end lisp
15791
15792 The specs are applied left-to-right.
15793
15794
15795 @item gnus-nocem-verifyer
15796 @vindex gnus-nocem-verifyer
15797 @findex mc-verify
15798 This should be a function for verifying that the NoCeM issuer is who she
15799 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
15800 function.  If this is too slow and you don't care for verification
15801 (which may be dangerous), you can set this variable to @code{nil}.
15802
15803 If you want signed NoCeM messages to be verified and unsigned messages
15804 not to be verified (but used anyway), you could do something like:
15805
15806 @lisp
15807 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15808
15809 (defun my-gnus-mc-verify ()
15810   (not (eq 'forged
15811            (ignore-errors
15812              (if (mc-verify)
15813                  t
15814                'forged)))))
15815 @end lisp
15816
15817 This might be dangerous, though.
15818
15819 @item gnus-nocem-directory
15820 @vindex gnus-nocem-directory
15821 This is where Gnus will store its NoCeM cache files.  The default is
15822 @file{~/News/NoCeM/}.
15823
15824 @item gnus-nocem-expiry-wait
15825 @vindex gnus-nocem-expiry-wait
15826 The number of days before removing old NoCeM entries from the cache.
15827 The default is 15.  If you make it shorter Gnus will be faster, but you
15828 might then see old spam.
15829
15830 @end table
15831
15832 Using NoCeM could potentially be a memory hog.  If you have many living
15833 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15834 big.  If this is a problem, you should kill off all (or most) of your
15835 unsubscribed groups (@pxref{Subscription Commands}).
15836
15837
15838 @node Undo
15839 @section Undo
15840 @cindex undo
15841
15842 It is very useful to be able to undo actions one has done.  In normal
15843 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15844 In Gnus buffers, however, it isn't that simple.
15845
15846 The things Gnus displays in its buffer is of no value whatsoever to
15847 Gnus---it's all just data designed to look nice to the user.
15848 Killing a group in the group buffer with @kbd{C-k} makes the line
15849 disappear, but that's just a side-effect of the real action---the
15850 removal of the group in question from the internal Gnus structures.
15851 Undoing something like that can't be done by the normal Emacs
15852 @code{undo} function.
15853
15854 Gnus tries to remedy this somewhat by keeping track of what the user
15855 does and coming up with actions that would reverse the actions the user
15856 takes.  When the user then presses the @code{undo} key, Gnus will run
15857 the code to reverse the previous action, or the previous actions.
15858 However, not all actions are easily reversible, so Gnus currently offers
15859 a few key functions to be undoable.  These include killing groups,
15860 yanking groups, and changing the list of read articles of groups.
15861 That's it, really.  More functions may be added in the future, but each
15862 added function means an increase in data to be stored, so Gnus will
15863 never be totally undoable.
15864
15865 @findex gnus-undo-mode
15866 @vindex gnus-use-undo
15867 @findex gnus-undo
15868 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
15869 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15870 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
15871 command, which should feel kinda like the normal Emacs @code{undo}
15872 command.
15873
15874
15875 @node Moderation
15876 @section Moderation
15877 @cindex moderation
15878
15879 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15880 It is not included in the standard Gnus package.  Write a mail to
15881 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15882 get a copy.
15883
15884 The moderation package is implemented as a minor mode for summary
15885 buffers.  Put
15886
15887 @lisp
15888 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15889 @end lisp
15890
15891 in your @file{.gnus.el} file.
15892
15893 If you are the moderator of @samp{rec.zoofle}, this is how it's
15894 supposed to work:
15895
15896 @enumerate
15897 @item
15898 You split your incoming mail by matching on
15899 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15900 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15901
15902 @item
15903 You enter that group once in a while and post articles using the @kbd{e}
15904 (edit-and-post) or @kbd{s} (just send unedited) commands.
15905
15906 @item
15907 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15908 articles that weren't approved by you, you can cancel them with the
15909 @kbd{c} command.
15910 @end enumerate
15911
15912 To use moderation mode in these two groups, say:
15913
15914 @lisp
15915 (setq gnus-moderated-list
15916       "^nnml:rec.zoofle$\\|^rec.zoofle$")
15917 @end lisp
15918
15919
15920 @node XEmacs Enhancements
15921 @section XEmacs Enhancements
15922 @cindex XEmacs
15923
15924 XEmacs is able to display pictures and stuff, so Gnus has taken
15925 advantage of that.
15926
15927 @menu
15928 * Picons::    How to display pictures of what your reading.
15929 * Smileys::   Show all those happy faces the way they were meant to be shown.
15930 * Toolbar::   Click'n'drool.
15931 * XVarious::  Other XEmacsy Gnusey variables.
15932 @end menu
15933
15934
15935 @node Picons
15936 @subsection Picons
15937
15938 @iftex
15939 @iflatex
15940 \include{picons}
15941 @end iflatex
15942 @end iftex
15943
15944 So...  You want to slow down your news reader even more!  This is a
15945 good way to do so.  Its also a great way to impress people staring
15946 over your shoulder as you read news.
15947
15948 @menu
15949 * Picon Basics::           What are picons and How do I get them.
15950 * Picon Requirements::     Don't go further if you aren't using XEmacs.
15951 * Easy Picons::            Displaying Picons---the easy way.
15952 * Hard Picons::            The way you should do it.  You'll learn something.
15953 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15954 @end menu
15955
15956
15957 @node Picon Basics
15958 @subsubsection Picon Basics
15959
15960 What are Picons?  To quote directly from the Picons Web site:
15961
15962 @iftex
15963 @iflatex
15964 \margindex{}
15965 @end iflatex
15966 @end iftex
15967
15968 @quotation
15969 @dfn{Picons} is short for ``personal icons''.  They're small,
15970 constrained images used to represent users and domains on the net,
15971 organized into databases so that the appropriate image for a given
15972 e-mail address can be found.  Besides users and domains, there are picon
15973 databases for Usenet newsgroups and weather forecasts.  The picons are
15974 in either monochrome @code{XBM} format or color @code{XPM} and
15975 @code{GIF} formats.
15976 @end quotation
15977
15978 @vindex gnus-picons-piconsearch-url
15979 If you have a permanent connection to the Internet you can use Steve
15980 Kinzler's Picons Search engine by setting
15981 @code{gnus-picons-piconsearch-url} to the string @*
15982 @file{http://www.cs.indiana.edu/picons/search.html}.
15983
15984 @vindex gnus-picons-database
15985 Otherwise you need a local copy of his database.  For instructions on
15986 obtaining and installing the picons databases, point your Web browser at @*
15987 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
15988 picons to be installed into a location pointed to by
15989 @code{gnus-picons-database}.
15990
15991
15992 @node Picon Requirements
15993 @subsubsection Picon Requirements
15994
15995 To have Gnus display Picons for you, you must be running XEmacs
15996 19.13 or greater since all other versions of Emacs aren't yet able to
15997 display images.
15998
15999 Additionally, you must have @code{x} support compiled into XEmacs.  To
16000 display color picons which are much nicer than the black & white one,
16001 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
16002
16003 @vindex gnus-picons-convert-x-face
16004 If you want to display faces from @code{X-Face} headers, you should have
16005 the @code{xface} support compiled into XEmacs.  Otherwise you must have
16006 the @code{netpbm} utilities installed, or munge the
16007 @code{gnus-picons-convert-x-face} variable to use something else.
16008
16009
16010 @node Easy Picons
16011 @subsubsection Easy Picons
16012
16013 To enable displaying picons, simply put the following line in your
16014 @file{~/.gnus} file and start Gnus.
16015
16016 @lisp
16017 (setq gnus-use-picons t)
16018 (setq gnus-treat-display-picons t)
16019 @end lisp
16020
16021 and make sure @code{gnus-picons-database} points to the directory
16022 containing the Picons databases.
16023
16024 Alternatively if you want to use the web piconsearch engine add this:
16025
16026 @lisp
16027 (setq gnus-picons-piconsearch-url
16028       "http://www.cs.indiana.edu:800/piconsearch")
16029 @end lisp
16030
16031
16032 @node Hard Picons
16033 @subsubsection Hard Picons
16034
16035 @iftex
16036 @iflatex
16037 \margindex{}
16038 @end iflatex
16039 @end iftex
16040
16041 Gnus can display picons for you as you enter and leave groups and
16042 articles.  It knows how to interact with three sections of the picons
16043 database.  Namely, it can display the picons newsgroup pictures,
16044 author's face picture(s), and the authors domain.  To enable this
16045 feature, you need to select where to get the picons from, and where to
16046 display them.
16047
16048 @table @code
16049
16050 @item gnus-picons-database
16051 @vindex gnus-picons-database
16052 The location of the picons database.  Should point to a directory
16053 containing the @file{news}, @file{domains}, @file{users} (and so on)
16054 subdirectories.  This is only useful if
16055 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
16056 @file{/usr/local/faces/}.
16057
16058 @item gnus-picons-piconsearch-url
16059 @vindex gnus-picons-piconsearch-url
16060 The URL for the web picons search engine.  The only currently known
16061 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
16062 workaround network delays, icons will be fetched in the background.  If
16063 this is @code{nil} 'the default), then picons are fetched from local
16064 database indicated by @code{gnus-picons-database}.
16065
16066 @item gnus-picons-display-where
16067 @vindex gnus-picons-display-where
16068 Where the picon images should be displayed.  It is @code{picons} by
16069 default (which by default maps to the buffer @samp{*Picons*}).  Other
16070 valid places could be @code{article}, @code{summary}, or
16071 @samp{*scratch*} for all I care.  Just make sure that you've made the
16072 buffer visible using the standard Gnus window configuration
16073 routines---@pxref{Windows Configuration}.
16074
16075 @item gnus-picons-group-excluded-groups
16076 @vindex gnus-picons-group-excluded-groups
16077 Groups that are matched by this regexp won't have their group icons
16078 displayed.
16079
16080 @end table
16081
16082 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
16083 window configuration for you to include the @code{picons} buffer.
16084
16085 Now that you've made those decision, you need to add the following
16086 functions to the appropriate hooks so these pictures will get displayed
16087 at the right time.
16088
16089 @vindex gnus-picons-display-where
16090 @table @code
16091 @item gnus-article-display-picons
16092 @findex gnus-article-display-picons
16093 Looks up and displays the picons for the author and the author's domain
16094 in the @code{gnus-picons-display-where} buffer.
16095
16096 @item gnus-picons-article-display-x-face
16097 @findex gnus-article-display-picons
16098 Decodes and displays the X-Face header if present.
16099
16100 @end table
16101
16102
16103
16104 @node Picon Useless Configuration
16105 @subsubsection Picon Useless Configuration
16106
16107 @iftex
16108 @iflatex
16109 \margindex{}
16110 @end iflatex
16111 @end iftex
16112
16113 The following variables offer further control over how things are
16114 done, where things are located, and other useless stuff you really
16115 don't need to worry about.
16116
16117 @table @code
16118
16119 @item gnus-picons-news-directories
16120 @vindex gnus-picons-news-directories
16121 List of subdirectories to search in @code{gnus-picons-database} for
16122 newsgroups faces.  @code{("news")} is the default.
16123
16124 @item gnus-picons-user-directories
16125 @vindex gnus-picons-user-directories
16126 List of subdirectories to search in @code{gnus-picons-database} for user
16127 faces.  @code{("local" "users" "usenix" "misc")} is the default.
16128
16129 @item gnus-picons-domain-directories
16130 @vindex gnus-picons-domain-directories
16131 List of subdirectories to search in @code{gnus-picons-database} for
16132 domain name faces.  Defaults to @code{("domains")}.  Some people may
16133 want to add @samp{"unknown"} to this list.
16134
16135 @item gnus-picons-convert-x-face
16136 @vindex gnus-picons-convert-x-face
16137 If you don't have @code{xface} support builtin XEmacs, this is the
16138 command to use to convert the @code{X-Face} header to an X bitmap
16139 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
16140 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
16141 gnus-picons-x-face-file-name)}
16142
16143 @item gnus-picons-x-face-file-name
16144 @vindex gnus-picons-x-face-file-name
16145 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
16146 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
16147
16148 @item gnus-picons-has-modeline-p
16149 @vindex gnus-picons-has-modeline-p
16150 If you have set @code{gnus-picons-display-where} to @code{picons}, your
16151 XEmacs frame will become really cluttered.  To alleviate this a bit you
16152 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
16153 remove the mode line from the Picons buffer.  This is only useful if
16154 @code{gnus-picons-display-where} is @code{picons}.
16155
16156 @item gnus-picons-refresh-before-display
16157 @vindex gnus-picons-refresh-before-display
16158 If non-nil, display the article buffer before computing the picons.
16159 Defaults to @code{nil}.
16160
16161 @item gnus-picons-display-as-address
16162 @vindex gnus-picons-display-as-address
16163 If @code{t} display textual email addresses along with pictures.
16164 Defaults to @code{t}.
16165
16166 @item gnus-picons-file-suffixes
16167 @vindex gnus-picons-file-suffixes
16168 Ordered list of suffixes on picon file names to try.  Defaults to
16169 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
16170
16171 @item gnus-picons-setup-hook
16172 @vindex gnus-picons-setup-hook
16173 Hook run in the picon buffer, if that is displayed.
16174
16175 @item gnus-picons-display-article-move-p
16176 @vindex gnus-picons-display-article-move-p
16177 Whether to move point to first empty line when displaying picons.  This
16178 has only an effect if `gnus-picons-display-where' has value `article'.
16179
16180 If @code{nil}, display the picons in the @code{From} and
16181 @code{Newsgroups} lines.  This is the defailt.
16182
16183 @item gnus-picons-clear-cache-on-shutdown
16184 @vindex gnus-picons-clear-cache-on-shutdown
16185 Whether to clear the picons cache when exiting gnus.  Gnus caches every
16186 picons it finds while it is running.  This saves some time in the search
16187 process but eats some memory.  If this variable is set to @code{nil},
16188 Gnus will never clear the cache itself; you will have to manually call
16189 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
16190 cleared every time you exit Gnus.  Defaults to @code{t}.
16191
16192 @iftex
16193 @iflatex
16194 \margindex{}
16195 @end iflatex
16196 @end iftex
16197
16198 @end table
16199
16200 @node Smileys
16201 @subsection Smileys
16202 @cindex smileys
16203
16204 @iftex
16205 @iflatex
16206 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
16207 \input{smiley}
16208 @end iflatex
16209 @end iftex
16210
16211 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
16212 currently the only package that uses Smiley, it is documented here.
16213
16214 In short---to use Smiley in Gnus, put the following in your
16215 @file{.gnus.el} file:
16216
16217 @lisp
16218 (setq gnus-treat-display-smiley t)
16219 @end lisp
16220
16221 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
16222 the like---to pictures and displays those instead of the text smiley
16223 faces.  The conversion is controlled by a list of regexps that matches
16224 text and maps that to file names.
16225
16226 @vindex smiley-nosey-regexp-alist
16227 @vindex smiley-deformed-regexp-alist
16228 Smiley supplies two example conversion alists by default:
16229 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
16230 and so on), and @code{smiley-nosey-regexp-alist} (which matches
16231 @samp{:-)}, @samp{:-(} and so on).
16232
16233 The alist used is specified by the @code{smiley-regexp-alist} variable,
16234 which defaults to the value of @code{smiley-deformed-regexp-alist}.
16235
16236 The first item in each element is the regexp to be matched; the second
16237 element is the regexp match group that is to be replaced by the picture;
16238 and the third element is the name of the file to be displayed.
16239
16240 The following variables customize where Smiley will look for these
16241 files, as well as the color to be used and stuff:
16242
16243 @table @code
16244
16245 @item smiley-data-directory
16246 @vindex smiley-data-directory
16247 Where Smiley will look for smiley faces files.
16248
16249 @item smiley-flesh-color
16250 @vindex smiley-flesh-color
16251 Skin color.  The default is @samp{yellow}, which is really racist.
16252
16253 @item smiley-features-color
16254 @vindex smiley-features-color
16255 Color of the features of the face.  The default is @samp{black}.
16256
16257 @item smiley-tongue-color
16258 @vindex smiley-tongue-color
16259 Color of the tongue.  The default is @samp{red}.
16260
16261 @item smiley-circle-color
16262 @vindex smiley-circle-color
16263 Color of the circle around the face.  The default is @samp{black}.
16264
16265 @item smiley-mouse-face
16266 @vindex smiley-mouse-face
16267 Face used for mouse highlighting over the smiley face.
16268
16269 @end table
16270
16271
16272 @node Toolbar
16273 @subsection Toolbar
16274
16275 @table @code
16276
16277 @iftex
16278 @iflatex
16279 \margindex{}
16280 @end iflatex
16281 @end iftex
16282
16283 @item gnus-use-toolbar
16284 @vindex gnus-use-toolbar
16285 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
16286 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
16287 @code{right-toolbar}, or @code{left-toolbar}.
16288
16289 @item gnus-group-toolbar
16290 @vindex gnus-group-toolbar
16291 The toolbar in the group buffer.
16292
16293 @item gnus-summary-toolbar
16294 @vindex gnus-summary-toolbar
16295 The toolbar in the summary buffer.
16296
16297 @item gnus-summary-mail-toolbar
16298 @vindex gnus-summary-mail-toolbar
16299 The toolbar in the summary buffer of mail groups.
16300
16301 @end table
16302
16303
16304 @node XVarious
16305 @subsection Various XEmacs Variables
16306
16307 @table @code
16308 @item gnus-xmas-glyph-directory
16309 @vindex gnus-xmas-glyph-directory
16310 This is where Gnus will look for pictures.  Gnus will normally
16311 auto-detect this directory, but you may set it manually if you have an
16312 unusual directory structure.
16313
16314 @item gnus-xmas-logo-color-alist
16315 @vindex gnus-xmas-logo-color-alist
16316 This is an alist where the key is a type symbol and the values are the
16317 foreground and background color of the splash page glyph.
16318
16319 @item gnus-xmas-logo-color-style
16320 @vindex gnus-xmas-logo-color-style
16321 This is the key used to look up the color in the alist described above.
16322 Valid values include @code{flame}, @code{pine}, @code{moss},
16323 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
16324 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
16325
16326 @item gnus-xmas-modeline-glyph
16327 @vindex gnus-xmas-modeline-glyph
16328 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
16329 default.
16330
16331 @iftex
16332 @iflatex
16333 \margindex{}
16334 @end iflatex
16335 @end iftex
16336
16337 @end table
16338
16339
16340
16341
16342 @node Fuzzy Matching
16343 @section Fuzzy Matching
16344 @cindex fuzzy matching
16345
16346 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
16347 things like scoring, thread gathering and thread comparison.
16348
16349 As opposed to regular expression matching, fuzzy matching is very fuzzy.
16350 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
16351 means, and the implementation has changed over time.
16352
16353 Basically, it tries to remove all noise from lines before comparing.
16354 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
16355 out of the strings before comparing the results.  This often leads to
16356 adequate results---even when faced with strings generated by text
16357 manglers masquerading as newsreaders.
16358
16359
16360 @node Thwarting Email Spam
16361 @section Thwarting Email Spam
16362 @cindex email spam
16363 @cindex spam
16364 @cindex UCE
16365 @cindex unsolicited commercial email
16366
16367 In these last days of the Usenet, commercial vultures are hanging about
16368 and grepping through news like crazy to find email addresses they can
16369 foist off their scams and products to.  As a reaction to this, many
16370 people have started putting nonsense addresses into their @code{From}
16371 lines.  I think this is counterproductive---it makes it difficult for
16372 people to send you legitimate mail in response to things you write, as
16373 well as making it difficult to see who wrote what.  This rewriting may
16374 perhaps be a bigger menace than the unsolicited commercial email itself
16375 in the end.
16376
16377 The biggest problem I have with email spam is that it comes in under
16378 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
16379 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
16380 mail group, only to find two pyramid schemes, seven advertisements
16381 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
16382 and one mail asking me to repent and find some god.
16383
16384 This is annoying.
16385
16386 The way to deal with this is having Gnus split out all spam into a
16387 @samp{spam} mail group (@pxref{Splitting Mail}).
16388
16389 First, pick one (1) valid mail address that you can be reached at, and
16390 put it in your @code{From} header of all your news articles.  (I've
16391 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
16392 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
16393 sysadm whether your sendmail installation accepts keywords in the local
16394 part of the mail address.)
16395
16396 @lisp
16397 (setq message-default-news-headers
16398       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
16399 @end lisp
16400
16401 Then put the following split rule in @code{nnmail-split-fancy}
16402 (@pxref{Fancy Mail Splitting}):
16403
16404 @lisp
16405 (
16406  ...
16407  (to "larsi@@trym.ifi.uio.no"
16408       (| ("subject" "re:.*" "misc")
16409          ("references" ".*@@.*" "misc")
16410          "spam"))
16411  ...
16412 )
16413 @end lisp
16414
16415 This says that all mail to this address is suspect, but if it has a
16416 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
16417 header, it's probably ok.  All the rest goes to the @samp{spam} group.
16418 (This idea probably comes from Tim Pierce.)
16419
16420 In addition, many mail spammers talk directly to your @code{smtp} server
16421 and do not include your email address explicitly in the @code{To}
16422 header.  Why they do this is unknown---perhaps it's to thwart this
16423 thwarting scheme?  In any case, this is trivial to deal with---you just
16424 put anything not addressed to you in the @samp{spam} group by ending
16425 your fancy split rule in this way:
16426
16427 @lisp
16428 (
16429  ...
16430  (to "larsi" "misc")
16431  "spam")
16432 @end lisp
16433
16434 In my experience, this will sort virtually everything into the right
16435 group.  You still have to check the @samp{spam} group from time to time to
16436 check for legitimate mail, though.  If you feel like being a good net
16437 citizen, you can even send off complaints to the proper authorities on
16438 each unsolicited commercial email---at your leisure.
16439
16440 If you are also a lazy net citizen, you will probably prefer complaining
16441 automatically with the @file{gnus-junk.el} package, available FOR FREE
16442 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
16443 Since most e-mail spam is sent automatically, this may reconcile the
16444 cosmic balance somewhat.
16445
16446 This works for me.  It allows people an easy way to contact me (they can
16447 just press @kbd{r} in the usual way), and I'm not bothered at all with
16448 spam.  It's a win-win situation.  Forging @code{From} headers to point
16449 to non-existent domains is yucky, in my opinion.
16450
16451
16452 @node Various Various
16453 @section Various Various
16454 @cindex mode lines
16455 @cindex highlights
16456
16457 @table @code
16458
16459 @item gnus-home-directory
16460 All Gnus path variables will be initialized from this variable, which
16461 defaults to @file{~/}.
16462
16463 @item gnus-directory
16464 @vindex gnus-directory
16465 Most Gnus storage path variables will be initialized from this variable,
16466 which defaults to the @samp{SAVEDIR} environment variable, or
16467 @file{~/News/} if that variable isn't set.
16468
16469 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
16470 This means that other directory variables that are initialized from this
16471 variable won't be set properly if you set this variable in
16472 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
16473
16474 @item gnus-default-directory
16475 @vindex gnus-default-directory
16476 Not related to the above variable at all---this variable says what the
16477 default directory of all Gnus buffers should be.  If you issue commands
16478 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
16479 default directory.  If this variable is @code{nil} (which is the
16480 default), the default directory will be the default directory of the
16481 buffer you were in when you started Gnus.
16482
16483 @item gnus-verbose
16484 @vindex gnus-verbose
16485 This variable is an integer between zero and ten.  The higher the value,
16486 the more messages will be displayed.  If this variable is zero, Gnus
16487 will never flash any messages, if it is seven (which is the default),
16488 most important messages will be shown, and if it is ten, Gnus won't ever
16489 shut up, but will flash so many messages it will make your head swim.
16490
16491 @item gnus-verbose-backends
16492 @vindex gnus-verbose-backends
16493 This variable works the same way as @code{gnus-verbose}, but it applies
16494 to the Gnus backends instead of Gnus proper.
16495
16496 @item nnheader-max-head-length
16497 @vindex nnheader-max-head-length
16498 When the backends read straight heads of articles, they all try to read
16499 as little as possible.  This variable (default 4096) specifies
16500 the absolute max length the backends will try to read before giving up
16501 on finding a separator line between the head and the body.  If this
16502 variable is @code{nil}, there is no upper read bound.  If it is
16503 @code{t}, the backends won't try to read the articles piece by piece,
16504 but read the entire articles.  This makes sense with some versions of
16505 @code{ange-ftp} or @code{efs}.
16506
16507 @item nnheader-head-chop-length
16508 @vindex nnheader-head-chop-length
16509 This variable (default 2048) says how big a piece of each article to
16510 read when doing the operation described above.
16511
16512 @item nnheader-file-name-translation-alist
16513 @vindex nnheader-file-name-translation-alist
16514 @cindex file names
16515 @cindex invalid characters in file names
16516 @cindex characters in file names
16517 This is an alist that says how to translate characters in file names.
16518 For instance, if @samp{:} is invalid as a file character in file names
16519 on your system (you OS/2 user you), you could say something like:
16520
16521 @lisp
16522 (setq nnheader-file-name-translation-alist
16523       '((?: . ?_)))
16524 @end lisp
16525
16526 In fact, this is the default value for this variable on OS/2 and MS
16527 Windows (phooey) systems.
16528
16529 @item gnus-hidden-properties
16530 @vindex gnus-hidden-properties
16531 This is a list of properties to use to hide ``invisible'' text.  It is
16532 @code{(invisible t intangible t)} by default on most systems, which
16533 makes invisible text invisible and intangible.
16534
16535 @item gnus-parse-headers-hook
16536 @vindex gnus-parse-headers-hook
16537 A hook called before parsing headers.  It can be used, for instance, to
16538 gather statistics on the headers fetched, or perhaps you'd like to prune
16539 some headers.  I don't see why you'd want that, though.
16540
16541 @item gnus-shell-command-separator
16542 @vindex gnus-shell-command-separator
16543 String used to separate two shell commands.  The default is @samp{;}.
16544
16545
16546 @end table
16547
16548
16549 @node The End
16550 @chapter The End
16551
16552 Well, that's the manual---you can get on with your life now.  Keep in
16553 touch.  Say hello to your cats from me.
16554
16555 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
16556
16557 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16558
16559 @quotation
16560 @strong{Te Deum}
16561
16562 @sp 1
16563 Not because of victories @*
16564 I sing,@*
16565 having none,@*
16566 but for the common sunshine,@*
16567 the breeze,@*
16568 the largess of the spring.
16569
16570 @sp 1
16571 Not for victory@*
16572 but for the day's work done@*
16573 as well as I was able;@*
16574 not for a seat upon the dais@*
16575 but at the common table.@*
16576 @end quotation
16577
16578
16579 @node Appendices
16580 @chapter Appendices
16581
16582 @menu
16583 * History::                        How Gnus got where it is today.
16584 * Terminology::                    We use really difficult, like, words here.
16585 * Customization::                  Tailoring Gnus to your needs.
16586 * Troubleshooting::                What you might try if things do not work.
16587 * Gnus Reference Guide::           Rilly, rilly technical stuff.
16588 * Emacs for Heathens::             A short introduction to Emacsian terms.
16589 * Frequently Asked Questions::     A question-and-answer session.
16590 @end menu
16591
16592
16593 @node History
16594 @section History
16595
16596 @cindex history
16597 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
16598 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16599
16600 If you want to investigate the person responsible for this outrage, you
16601 can point your (feh!) web browser to
16602 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
16603 distribution point for the new and spiffy versions of Gnus, and is known
16604 as The Site That Destroys Newsrcs And Drives People Mad.
16605
16606 During the first extended alpha period of development, the new Gnus was
16607 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
16608 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16609 (Besides, the ``Gnus'' in this abbreviation should probably be
16610 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16611 appropriate name, don't you think?)
16612
16613 In any case, after spending all that energy on coming up with a new and
16614 spunky name, we decided that the name was @emph{too} spunky, so we
16615 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
16616 ``@sc{gnus}''.  New vs. old.
16617
16618 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16619 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16620 plus 15 Gnus 5.0 releases).
16621
16622 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16623 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16624
16625 On July 28th 1996 work on Red Gnus was begun, and it was released on
16626 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16627
16628 On September 13th 1997, Quassia Gnus was started and lasted 37
16629 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
16630
16631 If you happen upon a version of Gnus that has a prefixed name --
16632 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16633 don't panic.  Don't let it know that you're frightened.  Back away.
16634 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
16635 out of its reach.  Find a proper released version of Gnus and snuggle up
16636 to that instead.
16637
16638 @menu
16639 * Why?::                What's the point of Gnus?
16640 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
16641 * Conformity::          Gnus tries to conform to all standards.
16642 * Emacsen::             Gnus can be run on a few modern Emacsen.
16643 * Gnus Development::    How Gnus is developed.
16644 * Contributors::        Oodles of people.
16645 * New Features::        Pointers to some of the new stuff in Gnus.
16646 * Newest Features::     Features so new that they haven't been written yet.
16647 @end menu
16648
16649
16650 @node Why?
16651 @subsection Why?
16652
16653 What's the point of Gnus?
16654
16655 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16656 newsreader, that lets you do anything you can think of.  That was my
16657 original motivation, but while working on Gnus, it has become clear to
16658 me that this generation of newsreaders really belong in the stone age.
16659 Newsreaders haven't developed much since the infancy of the net.  If the
16660 volume continues to rise with the current rate of increase, all current
16661 newsreaders will be pretty much useless.  How do you deal with
16662 newsgroups that have thousands of new articles each day?  How do you
16663 keep track of millions of people who post?
16664
16665 Gnus offers no real solutions to these questions, but I would very much
16666 like to see Gnus being used as a testing ground for new methods of
16667 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
16668 to separate the newsreader from the backends, Gnus now offers a simple
16669 interface for anybody who wants to write new backends for fetching mail
16670 and news from different sources.  I have added hooks for customizations
16671 everywhere I could imagine it being useful.  By doing so, I'm inviting
16672 every one of you to explore and invent.
16673
16674 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16675 @kbd{C-u 100 M-x all-hail-xemacs}.
16676
16677
16678 @node Compatibility
16679 @subsection Compatibility
16680
16681 @cindex compatibility
16682 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
16683 bindings have been kept.  More key bindings have been added, of course,
16684 but only in one or two obscure cases have old bindings been changed.
16685
16686 Our motto is:
16687 @quotation
16688 @cartouche
16689 @center In a cloud bones of steel.
16690 @end cartouche
16691 @end quotation
16692
16693 All commands have kept their names.  Some internal functions have changed
16694 their names.
16695
16696 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16697 Articles}.
16698
16699 One major compatibility question is the presence of several summary
16700 buffers.  All variables relevant while reading a group are
16701 buffer-local to the summary buffer they belong in.  Although many
16702 important variables have their values copied into their global
16703 counterparts whenever a command is executed in the summary buffer, this
16704 change might lead to incorrect values being used unless you are careful.
16705
16706 All code that relies on knowledge of @sc{gnus} internals will probably
16707 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
16708 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
16709 maintains a hash table that points to the entries in this alist (which
16710 speeds up many functions), and changing the alist directly will lead to
16711 peculiar results.
16712
16713 @cindex hilit19
16714 @cindex highlighting
16715 Old hilit19 code does not work at all.  In fact, you should probably
16716 remove all hilit code from all Gnus hooks
16717 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16718 Gnus provides various integrated functions for highlighting.  These are
16719 faster and more accurate.  To make life easier for everybody, Gnus will
16720 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
16721 Away!
16722
16723 Packages like @code{expire-kill} will no longer work.  As a matter of
16724 fact, you should probably remove all old @sc{gnus} packages (and other
16725 code) when you start using Gnus.  More likely than not, Gnus already
16726 does what you have written code to make @sc{gnus} do.  (Snicker.)
16727
16728 Even though old methods of doing things are still supported, only the
16729 new methods are documented in this manual.  If you detect a new method of
16730 doing something while reading this manual, that does not mean you have
16731 to stop doing it the old way.
16732
16733 Gnus understands all @sc{gnus} startup files.
16734
16735 @kindex M-x gnus-bug
16736 @findex gnus-bug
16737 @cindex reporting bugs
16738 @cindex bugs
16739 Overall, a casual user who hasn't written much code that depends on
16740 @sc{gnus} internals should suffer no problems.  If problems occur,
16741 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16742
16743 @vindex gnus-bug-create-help-buffer
16744 If you are in the habit of sending bug reports @emph{very} often, you
16745 may find the helpful help buffer annoying after a while.  If so, set
16746 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16747 up at you.
16748
16749
16750 @node Conformity
16751 @subsection Conformity
16752
16753 No rebels without a clue here, ma'am.  We conform to all standards known
16754 to (wo)man.  Except for those standards and/or conventions we disagree
16755 with, of course.
16756
16757 @table @strong
16758
16759 @item RFC 822
16760 @cindex RFC 822
16761 There are no known breaches of this standard.
16762
16763 @item RFC 1036
16764 @cindex RFC 1036
16765 There are no known breaches of this standard, either.
16766
16767 @item Son-of-RFC 1036
16768 @cindex Son-of-RFC 1036
16769 We do have some breaches to this one.
16770
16771 @table @emph
16772
16773 @item X-Newsreader
16774 @itemx User-Agent
16775 These are considered to be ``vanity headers'', while I consider them
16776 to be consumer information.  After seeing so many badly formatted
16777 articles coming from @code{tin} and @code{Netscape} I know not to use
16778 either of those for posting articles.  I would not have known that if
16779 it wasn't for the @code{X-Newsreader} header.
16780 @end table
16781
16782 @item USEFOR
16783 @cindex USEFOR
16784 USEFOR is an IETF working group writing a successor to RFC 1036, based
16785 on Son-of-RFC 1036.  They have produced a number of drafts proposing
16786 various changes to the format of news articles.  The Gnus towers will
16787 look into implementing the changes when the draft is accepted as an RFC.
16788
16789 @end table
16790
16791 If you ever notice Gnus acting non-compliant with regards to the texts
16792 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16793 know.
16794
16795
16796 @node Emacsen
16797 @subsection Emacsen
16798 @cindex Emacsen
16799 @cindex XEmacs
16800 @cindex Mule
16801 @cindex Emacs
16802
16803 Gnus should work on :
16804
16805 @itemize @bullet
16806
16807 @item
16808 Emacs 20.3 and up.
16809
16810 @item
16811 XEmacs 20.4 and up.
16812
16813 @end itemize
16814
16815 This Gnus version will absolutely not work on any Emacsen older than
16816 that.  Not reliably, at least.  Older versions of Gnus may work on older
16817 Emacs versions.
16818
16819 There are some vague differences between Gnus on the various
16820 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16821 other than that, things should look pretty much the same under all
16822 Emacsen.
16823
16824
16825 @node Gnus Development
16826 @subsection Gnus Development
16827
16828 Gnus is developed in a two-phased cycle.  The first phase involves much
16829 discussion on the @samp{ding@@gnus.org} mailing list, where people
16830 propose changes and new features, post patches and new backends.  This
16831 phase is called the @dfn{alpha} phase, since the Gnusae released in this
16832 phase are @dfn{alpha releases}, or (perhaps more commonly in other
16833 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
16834 unstable and should not be used by casual users.  Gnus alpha releases
16835 have names like ``Red Gnus'' and ``Quassia Gnus''.
16836
16837 After futzing around for 50-100 alpha releases, Gnus is declared
16838 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
16839 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
16840 supposed to be able to use these, and these are mostly discussed on the
16841 @samp{gnu.emacs.gnus} newsgroup.
16842
16843 @cindex Incoming*
16844 @vindex nnmail-delete-incoming
16845 Some variable defaults differ between alpha Gnusae and released Gnusae.
16846 In particular, @code{nnmail-delete-incoming} defaults to @code{nil} in
16847 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
16848 lossage of mail if an alpha release hiccups while handling the mail.
16849
16850 The division of discussion between the ding mailing list and the Gnus
16851 newsgroup is not purely based on publicity concerns.  It's true that
16852 having people write about the horrible things that an alpha Gnus release
16853 can do (sometimes) in a public forum may scare people off, but more
16854 importantly, talking about new experimental features that have been
16855 introduced may confuse casual users.  New features are frequently
16856 introduced, fiddled with, and judged to be found wanting, and then
16857 either discarded or totally rewritten.  People reading the mailing list
16858 usually keep up with these rapid changes, whille people on the newsgroup
16859 can't be assumed to do so.
16860
16861
16862
16863 @node Contributors
16864 @subsection Contributors
16865 @cindex contributors
16866
16867 The new Gnus version couldn't have been done without the help of all the
16868 people on the (ding) mailing list.  Every day for over a year I have
16869 gotten billions of nice bug reports from them, filling me with joy,
16870 every single one of them.  Smooches.  The people on the list have been
16871 tried beyond endurance, what with my ``oh, that's a neat idea <type
16872 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16873 work at all <type type>, yup, I'll ship that one off right away <ship
16874 off> no, wait, that absolutely does not work'' policy for releases.
16875 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
16876 ``worser''? ``much worser''?  ``worsest''?)
16877
16878 I would like to take this opportunity to thank the Academy for...  oops,
16879 wrong show.
16880
16881 @itemize @bullet
16882
16883 @item
16884 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16885
16886 @item
16887 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16888 well as numerous other things).
16889
16890 @item
16891 Luis Fernandes---design and graphics.
16892
16893 @item
16894 Erik Naggum---help, ideas, support, code and stuff.
16895
16896 @item
16897 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
16898 connected with @sc{mime} and other types of en/decoding.
16899
16900 @item
16901 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16902 @dfn{picons} (@pxref{Picons}).
16903
16904 @item
16905 Kim-Minh Kaplan---further work on the picon code.
16906
16907 @item
16908 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16909 (@pxref{GroupLens}).
16910
16911 @item
16912 Sudish Joseph---innumerable bug fixes.
16913
16914 @item
16915 Ilja Weis---@file{gnus-topic.el}.
16916
16917 @item
16918 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16919
16920 @item
16921 Vladimir Alexiev---the refcard and reference booklets.
16922
16923 @item
16924 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16925 distribution by Felix Lee and JWZ.
16926
16927 @item
16928 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16929
16930 @item
16931 Peter Mutsaers---orphan article scoring code.
16932
16933 @item
16934 Ken Raeburn---POP mail support.
16935
16936 @item
16937 Hallvard B Furuseth---various bits and pieces, especially dealing with
16938 .newsrc files.
16939
16940 @item
16941 Brian Edmonds---@file{gnus-bbdb.el}.
16942
16943 @item
16944 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16945
16946 @item
16947 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16948
16949 @item
16950 François Pinard---many, many interesting and thorough bug reports, as
16951 well as autoconf support.
16952
16953 @end itemize
16954
16955 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16956 Borges, and Jost Krieger proof-reading parts of the manual.
16957
16958 The following people have contributed many patches and suggestions:
16959
16960 Christopher Davis,
16961 Andrew Eskilsson,
16962 Kai Grossjohann,
16963 David KÃ¥gedal,
16964 Richard Pieri,
16965 Fabrice Popineau,
16966 Daniel Quinlan,
16967 Jason L. Tibbitts, III,
16968 and
16969 Jack Vinson.
16970
16971 Also thanks to the following for patches and stuff:
16972
16973 Jari Aalto,
16974 Adrian Aichner,
16975 Vladimir Alexiev,
16976 Russ Allbery,
16977 Peter Arius,
16978 Matt Armstrong,
16979 Marc Auslander,
16980 Miles Bader,
16981 Alexei V. Barantsev,
16982 Frank Bennett,
16983 Robert Bihlmeyer,
16984 Chris Bone,
16985 Mark Borges,
16986 Mark Boyns,
16987 Lance A. Brown,
16988 Rob Browning,
16989 Kees de Bruin,
16990 Martin Buchholz,
16991 Joe Buehler,
16992 Kevin Buhr,
16993 Alastair Burt,
16994 Joao Cachopo,
16995 Zlatko Calusic,
16996 Massimo Campostrini,
16997 Castor,
16998 David Charlap,
16999 Dan Christensen,
17000 Kevin Christian,
17001 Jae-you Chung, @c ?
17002 James H. Cloos, Jr.,
17003 Laura Conrad,
17004 Michael R. Cook,
17005 Glenn Coombs,
17006 Andrew J. Cosgriff,
17007 Neil Crellin,
17008 Frank D. Cringle,
17009 Geoffrey T. Dairiki,
17010 Andre Deparade,
17011 Ulrik Dickow,
17012 Dave Disser,
17013 Rui-Tao Dong, @c ?
17014 Joev Dubach,
17015 Michael Welsh Duggan,
17016 Dave Edmondson,
17017 Paul Eggert,
17018 Mark W. Eichin,
17019 Karl Eichwalder,
17020 Enami Tsugutomo, @c Enami
17021 Michael Ernst,
17022 Luc Van Eycken,
17023 Sam Falkner,
17024 Nelson Jose dos Santos Ferreira,
17025 Sigbjorn Finne,
17026 Sven Fischer,
17027 Paul Fisher,
17028 Decklin Foster,
17029 Gary D. Foster,
17030 Paul Franklin,
17031 Guy Geens,
17032 Arne Georg Gleditsch,
17033 David S. Goldberg,
17034 Michelangelo Grigni,
17035 Dale Hagglund,
17036 D. Hall,
17037 Magnus Hammerin,
17038 Kenichi Handa, @c Handa
17039 Raja R. Harinath,
17040 Yoshiki Hayashi, @c ?
17041 P. E. Jareth Hein,
17042 Hisashige Kenji, @c Hisashige
17043 Scott Hofmann,
17044 Marc Horowitz,
17045 Gunnar Horrigmo,
17046 Richard Hoskins,
17047 Brad Howes,
17048 Miguel de Icaza,
17049 François Felix Ingrand,
17050 Tatsuya Ichikawa, @c ?
17051 Ishikawa Ichiro, @c Ishikawa
17052 Lee Iverson,
17053 Iwamuro Motonori, @c Iwamuro
17054 Rajappa Iyer,
17055 Andreas Jaeger,
17056 Adam P. Jenkins,
17057 Randell Jesup,
17058 Fred Johansen,
17059 Gareth Jones,
17060 Simon Josefsson,
17061 Greg Klanderman,
17062 Karl Kleinpaste,
17063 Michael Klingbeil,
17064 Peter Skov Knudsen,
17065 Shuhei Kobayashi, @c Kobayashi
17066 Petr Konecny,
17067 Koseki Yoshinori, @c Koseki
17068 Thor Kristoffersen,
17069 Jens Lautenbacher,
17070 Martin Larose,
17071 Seokchan Lee, @c Lee
17072 Joerg Lenneis,
17073 Carsten Leonhardt,
17074 James LewisMoss,
17075 Christian Limpach,
17076 Markus Linnala,
17077 Dave Love,
17078 Mike McEwan,
17079 Tonny Madsen,
17080 Shlomo Mahlab,
17081 Nat Makarevitch,
17082 Istvan Marko,
17083 David Martin,
17084 Jason R. Mastaler,
17085 Gordon Matzigkeit,
17086 Timo Metzemakers,
17087 Richard Mlynarik,
17088 Lantz Moore,
17089 Morioka Tomohiko, @c Morioka
17090 Erik Toubro Nielsen,
17091 Hrvoje Niksic,
17092 Andy Norman,
17093 Fred Oberhauser,
17094 C. R. Oldham,
17095 Alexandre Oliva,
17096 Ken Olstad,
17097 Masaharu Onishi, @c Onishi
17098 Hideki Ono, @c Ono
17099 Ettore Perazzoli,
17100 William Perry,
17101 Stephen Peters,
17102 Jens-Ulrik Holger Petersen,
17103 Ulrich Pfeifer,
17104 Matt Pharr,
17105 Andy Piper,
17106 John McClary Prevost,
17107 Bill Pringlemeir,
17108 Mike Pullen,
17109 Jim Radford,
17110 Colin Rafferty,
17111 Lasse Rasinen,
17112 Lars Balker Rasmussen,
17113 Joe Reiss,
17114 Renaud Rioboo,
17115 Roland B. Roberts,
17116 Bart Robinson,
17117 Christian von Roques,
17118 Markus Rost,
17119 Jason Rumney,
17120 Wolfgang Rupprecht,
17121 Jay Sachs,
17122 Dewey M. Sasser,
17123 Conrad Sauerwald,
17124 Loren Schall,
17125 Dan Schmidt,
17126 Ralph Schleicher,
17127 Philippe Schnoebelen,
17128 Andreas Schwab,
17129 Randal L. Schwartz,
17130 Justin Sheehy,
17131 Danny Siu,
17132 Matt Simmons,
17133 Paul D. Smith,
17134 Jeff Sparkes,
17135 Toby Speight,
17136 Michael Sperber,
17137 Darren Stalder,
17138 Richard Stallman,
17139 Greg Stark,
17140 Sam Steingold,
17141 Paul Stevenson,
17142 Jonas Steverud,
17143 Paul Stodghill,
17144 Kiyokazu Suto, @c Suto
17145 Kurt Swanson,
17146 Samuel Tardieu,
17147 Teddy,
17148 Chuck Thompson,
17149 Tozawa Akihiko, @c Tozawa
17150 Philippe Troin,
17151 James Troup,
17152 Trung Tran-Duc,
17153 Jack Twilley,
17154 Aaron M. Ucko,
17155 Aki Vehtari,
17156 Didier Verna,
17157 Vladimir Volovich,
17158 Jan Vroonhof,
17159 Stefan Waldherr,
17160 Pete Ware,
17161 Barry A. Warsaw,
17162 Christoph Wedler,
17163 Joe Wells,
17164 Lee Willis,
17165 Katsumi Yamaoka @c Yamaoka
17166 and
17167 Lloyd Zusman.
17168
17169
17170 For a full overview of what each person has done, the ChangeLogs
17171 included in the Gnus alpha distributions should give ample reading
17172 (550kB and counting).
17173
17174 Apologies to everybody that I've forgotten, of which there are many, I'm
17175 sure.
17176
17177 Gee, that's quite a list of people.  I guess that must mean that there
17178 actually are people who are using Gnus.  Who'd'a thunk it!
17179
17180
17181 @node New Features
17182 @subsection New Features
17183 @cindex new features
17184
17185 @menu
17186 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
17187 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
17188 * Red Gnus::           Third time best---Gnus 5.4/5.5.
17189 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
17190 @end menu
17191
17192 These lists are, of course, just @emph{short} overviews of the
17193 @emph{most} important new features.  No, really.  There are tons more.
17194 Yes, we have feeping creaturism in full effect.
17195
17196
17197 @node ding Gnus
17198 @subsubsection (ding) Gnus
17199
17200 New features in Gnus 5.0/5.1:
17201
17202 @itemize @bullet
17203
17204 @item
17205 The look of all buffers can be changed by setting format-like variables
17206 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
17207
17208 @item
17209 Local spool and several @sc{nntp} servers can be used at once
17210 (@pxref{Select Methods}).
17211
17212 @item
17213 You can combine groups into virtual groups (@pxref{Virtual Groups}).
17214
17215 @item
17216 You can read a number of different mail formats (@pxref{Getting Mail}).
17217 All the mail backends implement a convenient mail expiry scheme
17218 (@pxref{Expiring Mail}).
17219
17220 @item
17221 Gnus can use various strategies for gathering threads that have lost
17222 their roots (thereby gathering loose sub-threads into one thread) or it
17223 can go back and retrieve enough headers to build a complete thread
17224 (@pxref{Customizing Threading}).
17225
17226 @item
17227 Killed groups can be displayed in the group buffer, and you can read
17228 them as well (@pxref{Listing Groups}).
17229
17230 @item
17231 Gnus can do partial group updates---you do not have to retrieve the
17232 entire active file just to check for new articles in a few groups
17233 (@pxref{The Active File}).
17234
17235 @item
17236 Gnus implements a sliding scale of subscribedness to groups
17237 (@pxref{Group Levels}).
17238
17239 @item
17240 You can score articles according to any number of criteria
17241 (@pxref{Scoring}).  You can even get Gnus to find out how to score
17242 articles for you (@pxref{Adaptive Scoring}).
17243
17244 @item
17245 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
17246 manner, so it should be difficult to lose much data on what you have
17247 read if your machine should go down (@pxref{Auto Save}).
17248
17249 @item
17250 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
17251 the @file{.emacs} file.
17252
17253 @item
17254 You can set the process mark on both groups and articles and perform
17255 operations on all the marked items (@pxref{Process/Prefix}).
17256
17257 @item
17258 You can grep through a subset of groups and create a group from the
17259 results (@pxref{Kibozed Groups}).
17260
17261 @item
17262 You can list subsets of groups according to, well, anything
17263 (@pxref{Listing Groups}).
17264
17265 @item
17266 You can browse foreign servers and subscribe to groups from those
17267 servers (@pxref{Browse Foreign Server}).
17268
17269 @item
17270 Gnus can fetch articles, asynchronously, on a second connection to the
17271 server (@pxref{Asynchronous Fetching}).
17272
17273 @item
17274 You can cache articles locally (@pxref{Article Caching}).
17275
17276 @item
17277 The uudecode functions have been expanded and generalized
17278 (@pxref{Decoding Articles}).
17279
17280 @item
17281 You can still post uuencoded articles, which was a little-known feature
17282 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
17283
17284 @item
17285 Fetching parents (and other articles) now actually works without
17286 glitches (@pxref{Finding the Parent}).
17287
17288 @item
17289 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
17290
17291 @item
17292 Digests (and other files) can be used as the basis for groups
17293 (@pxref{Document Groups}).
17294
17295 @item
17296 Articles can be highlighted and customized (@pxref{Customizing
17297 Articles}).
17298
17299 @item
17300 URLs and other external references can be buttonized (@pxref{Article
17301 Buttons}).
17302
17303 @item
17304 You can do lots of strange stuff with the Gnus window & frame
17305 configuration (@pxref{Windows Configuration}).
17306
17307 @item
17308 You can click on buttons instead of using the keyboard
17309 (@pxref{Buttons}).
17310
17311 @end itemize
17312
17313
17314 @node September Gnus
17315 @subsubsection September Gnus
17316
17317 @iftex
17318 @iflatex
17319 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
17320 @end iflatex
17321 @end iftex
17322
17323 New features in Gnus 5.2/5.3:
17324
17325 @itemize @bullet
17326
17327 @item
17328 A new message composition mode is used.  All old customization variables
17329 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
17330 now obsolete.
17331
17332 @item
17333 Gnus is now able to generate @dfn{sparse} threads---threads where
17334 missing articles are represented by empty nodes (@pxref{Customizing
17335 Threading}).
17336
17337 @lisp
17338 (setq gnus-build-sparse-threads 'some)
17339 @end lisp
17340
17341 @item
17342 Outgoing articles are stored on a special archive server
17343 (@pxref{Archived Messages}).
17344
17345 @item
17346 Partial thread regeneration now happens when articles are
17347 referred.
17348
17349 @item
17350 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
17351
17352 @item
17353 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
17354
17355 @item
17356 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
17357
17358 @lisp
17359 (setq gnus-use-trees t)
17360 @end lisp
17361
17362 @item
17363 An @code{nn}-like pick-and-read minor mode is available for the summary
17364 buffers (@pxref{Pick and Read}).
17365
17366 @lisp
17367 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
17368 @end lisp
17369
17370 @item
17371 In binary groups you can use a special binary minor mode (@pxref{Binary
17372 Groups}).
17373
17374 @item
17375 Groups can be grouped in a folding topic hierarchy (@pxref{Group
17376 Topics}).
17377
17378 @lisp
17379 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
17380 @end lisp
17381
17382 @item
17383 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
17384
17385 @item
17386 Groups can now have a score, and bubbling based on entry frequency
17387 is possible (@pxref{Group Score}).
17388
17389 @lisp
17390 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
17391 @end lisp
17392
17393 @item
17394 Groups can be process-marked, and commands can be performed on
17395 groups of groups (@pxref{Marking Groups}).
17396
17397 @item
17398 Caching is possible in virtual groups.
17399
17400 @item
17401 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
17402 news batches, ClariNet briefs collections, and just about everything
17403 else (@pxref{Document Groups}).
17404
17405 @item
17406 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
17407 (@pxref{SOUP}).
17408
17409 @item
17410 The Gnus cache is much faster.
17411
17412 @item
17413 Groups can be sorted according to many criteria (@pxref{Sorting
17414 Groups}).
17415
17416 @item
17417 New group parameters have been introduced to set list-addresses and
17418 expiry times (@pxref{Group Parameters}).
17419
17420 @item
17421 All formatting specs allow specifying faces to be used
17422 (@pxref{Formatting Fonts}).
17423
17424 @item
17425 There are several more commands for setting/removing/acting on process
17426 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
17427
17428 @item
17429 The summary buffer can be limited to show parts of the available
17430 articles based on a wide range of criteria.  These commands have been
17431 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
17432
17433 @item
17434 Articles can be made persistent with the @kbd{*} command
17435 (@pxref{Persistent Articles}).
17436
17437 @item
17438 All functions for hiding article elements are now toggles.
17439
17440 @item
17441 Article headers can be buttonized (@pxref{Article Washing}).
17442
17443 @item
17444 All mail backends support fetching articles by @code{Message-ID}.
17445
17446 @item
17447 Duplicate mail can now be treated properly (@pxref{Duplicates}).
17448
17449 @item
17450 All summary mode commands are available directly from the article
17451 buffer (@pxref{Article Keymap}).
17452
17453 @item
17454 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
17455 Configuration}).
17456
17457 @item
17458 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
17459 @iftex
17460 @iflatex
17461 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
17462 @end iflatex
17463 @end iftex
17464
17465 @item
17466 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
17467
17468 @lisp
17469 (setq gnus-use-nocem t)
17470 @end lisp
17471
17472 @item
17473 Groups can be made permanently visible (@pxref{Listing Groups}).
17474
17475 @lisp
17476 (setq gnus-permanently-visible-groups "^nnml:")
17477 @end lisp
17478
17479 @item
17480 Many new hooks have been introduced to make customizing easier.
17481
17482 @item
17483 Gnus respects the @code{Mail-Copies-To} header.
17484
17485 @item
17486 Threads can be gathered by looking at the @code{References} header
17487 (@pxref{Customizing Threading}).
17488
17489 @lisp
17490 (setq gnus-summary-thread-gathering-function
17491       'gnus-gather-threads-by-references)
17492 @end lisp
17493
17494 @item
17495 Read articles can be stored in a special backlog buffer to avoid
17496 refetching (@pxref{Article Backlog}).
17497
17498 @lisp
17499 (setq gnus-keep-backlog 50)
17500 @end lisp
17501
17502 @item
17503 A clean copy of the current article is always stored in a separate
17504 buffer to allow easier treatment.
17505
17506 @item
17507 Gnus can suggest where to save articles (@pxref{Saving Articles}).
17508
17509 @item
17510 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
17511 Articles}).
17512
17513 @lisp
17514 (setq gnus-prompt-before-saving t)
17515 @end lisp
17516
17517 @item
17518 @code{gnus-uu} can view decoded files asynchronously while fetching
17519 articles (@pxref{Other Decode Variables}).
17520
17521 @lisp
17522 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
17523 @end lisp
17524
17525 @item
17526 Filling in the article buffer now works properly on cited text
17527 (@pxref{Article Washing}).
17528
17529 @item
17530 Hiding cited text adds buttons to toggle hiding, and how much
17531 cited text to hide is now customizable (@pxref{Article Hiding}).
17532
17533 @lisp
17534 (setq gnus-cited-lines-visible 2)
17535 @end lisp
17536
17537 @item
17538 Boring headers can be hidden (@pxref{Article Hiding}).
17539
17540 @item
17541 Default scoring values can now be set from the menu bar.
17542
17543 @item
17544 Further syntax checking of outgoing articles have been added.
17545
17546 @end itemize
17547
17548
17549 @node Red Gnus
17550 @subsubsection Red Gnus
17551
17552 New features in Gnus 5.4/5.5:
17553
17554 @iftex
17555 @iflatex
17556 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
17557 @end iflatex
17558 @end iftex
17559
17560 @itemize @bullet
17561
17562 @item
17563 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
17564
17565 @item
17566 Article prefetching functionality has been moved up into
17567 Gnus (@pxref{Asynchronous Fetching}).
17568
17569 @item
17570 Scoring can now be performed with logical operators like @code{and},
17571 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
17572 Scoring}).
17573
17574 @item
17575 Article washing status can be displayed in the
17576 article mode line (@pxref{Misc Article}).
17577
17578 @item
17579 @file{gnus.el} has been split into many smaller files.
17580
17581 @item
17582 Suppression of duplicate articles based on Message-ID can be done
17583 (@pxref{Duplicate Suppression}).
17584
17585 @lisp
17586 (setq gnus-suppress-duplicates t)
17587 @end lisp
17588
17589 @item
17590 New variables for specifying what score and adapt files are to be
17591 considered home score and adapt files (@pxref{Home Score File}) have
17592 been added.
17593
17594 @item
17595 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17596 Server Internals}).
17597
17598 @item
17599 Groups can inherit group parameters from parent topics (@pxref{Topic
17600 Parameters}).
17601
17602 @item
17603 Article editing has been revamped and is now actually usable.
17604
17605 @item
17606 Signatures can be recognized in more intelligent fashions
17607 (@pxref{Article Signature}).
17608
17609 @item
17610 Summary pick mode has been made to look more @code{nn}-like.  Line
17611 numbers are displayed and the @kbd{.} command can be used to pick
17612 articles (@code{Pick and Read}).
17613
17614 @item
17615 Commands for moving the @file{.newsrc.eld} from one server to
17616 another have been added (@pxref{Changing Servers}).
17617
17618 @item
17619 There's a way now to specify that ``uninteresting'' fields be suppressed
17620 when generating lines in buffers (@pxref{Advanced Formatting}).
17621
17622 @item
17623 Several commands in the group buffer can be undone with @kbd{M-C-_}
17624 (@pxref{Undo}).
17625
17626 @item
17627 Scoring can be done on words using the new score type @code{w}
17628 (@pxref{Score File Format}).
17629
17630 @item
17631 Adaptive scoring can be done on a Subject word-by-word basis
17632 (@pxref{Adaptive Scoring}).
17633
17634 @lisp
17635 (setq gnus-use-adaptive-scoring '(word))
17636 @end lisp
17637
17638 @item
17639 Scores can be decayed (@pxref{Score Decays}).
17640
17641 @lisp
17642 (setq gnus-decay-scores t)
17643 @end lisp
17644
17645 @item
17646 Scoring can be performed using a regexp on the Date header.  The Date is
17647 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17648
17649 @item
17650 A new command has been added to remove all data on articles from
17651 the native server (@pxref{Changing Servers}).
17652
17653 @item
17654 A new command for reading collections of documents
17655 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17656 (@pxref{Really Various Summary Commands}).
17657
17658 @item
17659 Process mark sets can be pushed and popped (@pxref{Setting Process
17660 Marks}).
17661
17662 @item
17663 A new mail-to-news backend makes it possible to post even when the NNTP
17664 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17665
17666 @item
17667 A new backend for reading searches from Web search engines
17668 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17669 (@pxref{Web Searches}).
17670
17671 @item
17672 Groups inside topics can now be sorted using the standard sorting
17673 functions, and each topic can be sorted independently (@pxref{Topic
17674 Sorting}).
17675
17676 @item
17677 Subsets of the groups can be sorted independently (@code{Sorting
17678 Groups}).
17679
17680 @item
17681 Cached articles can be pulled into the groups (@pxref{Summary Generation
17682 Commands}).
17683 @iftex
17684 @iflatex
17685 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17686 @end iflatex
17687 @end iftex
17688
17689 @item
17690 Score files are now applied in a more reliable order (@pxref{Score
17691 Variables}).
17692
17693 @item
17694 Reports on where mail messages end up can be generated (@pxref{Splitting
17695 Mail}).
17696
17697 @item
17698 More hooks and functions have been added to remove junk from incoming
17699 mail before saving the mail (@pxref{Washing Mail}).
17700
17701 @item
17702 Emphasized text can be properly fontisized:
17703
17704 @end itemize
17705
17706
17707 @node Quassia Gnus
17708 @subsubsection Quassia Gnus
17709
17710 New features in Gnus 5.6:
17711
17712 @itemize @bullet
17713
17714 @item
17715 New functionality for using Gnus as an offline newsreader has been
17716 added.  A plethora of new commands and modes have been added.  See
17717 @pxref{Gnus Unplugged} for the full story.
17718
17719 @item
17720  The @code{nndraft} backend has returned, but works differently than
17721 before.  All Message buffers are now also articles in the @code{nndraft}
17722 group, which is created automatically.
17723
17724 @item
17725 @code{gnus-alter-header-function} can now be used to alter header
17726 values.
17727
17728 @item
17729  @code{gnus-summary-goto-article} now accept Message-ID's.
17730
17731 @item
17732  A new Message command for deleting text in the body of a message
17733 outside the region: @kbd{C-c C-v}.
17734
17735 @item
17736  You can now post to component group in @code{nnvirtual} groups with
17737 @kbd{C-u C-c C-c}.
17738
17739 @item
17740  @code{nntp-rlogin-program}---new variable to ease customization.
17741
17742 @item
17743  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17744 re-highlighting of the article buffer.
17745
17746 @item
17747  New element in @code{gnus-boring-article-headers}---@code{long-to}.
17748
17749 @item
17750  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
17751 Prefixes" in the Gnus manual for details.
17752
17753 @item
17754  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17755 @kbd{a} to add the score rule to the "all.SCORE" file.
17756
17757 @item
17758  @code{gnus-simplify-subject-functions} variable to allow greater
17759 control over simplification.
17760
17761 @item
17762  @kbd{A T}---new command for fetching the current thread.
17763
17764 @item
17765  @kbd{/ T}---new command for including the current thread in the
17766 limit.
17767
17768 @item
17769  @kbd{M-RET} is a new Message command for breaking cited text.
17770
17771 @item
17772  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17773
17774 @item
17775  The @code{custom-face-lookup} function has been removed.
17776 If you used this function in your initialization files, you must
17777 rewrite them to use @code{face-spec-set} instead.
17778
17779 @item
17780  Canceling now uses the current select method.  Symbolic prefix
17781 @kbd{a} forces normal posting method.
17782
17783 @item
17784  New command to translate M******** sm*rtq**t*s into proper
17785 text---@kbd{W d}.
17786
17787 @item
17788  For easier debugging of @code{nntp}, you can set
17789 @code{nntp-record-commands} to a non-@code{nil} value.
17790
17791 @item
17792  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17793 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17794
17795 @item
17796  A command for editing group parameters from the summary buffer
17797 has been added.
17798
17799 @item
17800  A history of where mails have been split is available.
17801
17802 @item
17803  A new article date command has been added---@code{article-date-iso8601}.
17804
17805 @item
17806  Subjects can be simplified when threading by setting
17807 @code{gnus-score-thread-simplify}.
17808
17809 @item
17810  A new function for citing in Message has been
17811 added---@code{message-cite-original-without-signature}.
17812
17813 @item
17814  @code{article-strip-all-blank-lines}---new article command.
17815
17816 @item
17817  A new Message command to kill to the end of the article has
17818 been added.
17819
17820 @item
17821  A minimum adaptive score can be specified by using the
17822 @code{gnus-adaptive-word-minimum} variable.
17823
17824 @item
17825  The "lapsed date" article header can be kept continually
17826 updated by the @code{gnus-start-date-timer} command.
17827
17828 @item
17829  Web listserv archives can be read with the @code{nnlistserv} backend.
17830
17831 @item
17832  Old dejanews archives can now be read by @code{nnweb}.
17833
17834 @end itemize
17835
17836
17837 @node Newest Features
17838 @subsection Newest Features
17839 @cindex todo
17840
17841 Also known as the @dfn{todo list}.  Sure to be implemented before the
17842 next millennium.
17843
17844 Be afraid.  Be very afraid.
17845
17846 (That a feature appears in this list doesn't necessarily mean that I've
17847 decided to actually implement it.  It just means that I think it sounds
17848 interesting.)
17849
17850 (Yes, this is the actual, up-to-the-second todo list.)
17851
17852 @itemize @bullet
17853
17854 @item
17855  I would like the zombie-page to contain an URL to the source of the
17856 latest version of gnus or some explanation on where to find it.
17857
17858 @item
17859  A way to continue editing the latest Message composition.
17860
17861 @item
17862  http://www.sonicnet.com/feature/ari3/
17863
17864 @item
17865  facep is not declared.
17866
17867 @item
17868  Include a section in the manual on why the number of articles
17869 isn't the same in the group buffer and on the SPC prompt.
17870
17871 @item
17872  Interacting with rmail fcc isn't easy.
17873
17874 @item
17875 @example
17876  Hypermail:
17877 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17878 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17879 <URL:http://homer.ncm.com/>
17880 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17881 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17882 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17883 http://www.miranova.com/gnus-list/
17884
17885 @end example
17886
17887 @item
17888 @samp{^-- } is made into - in LaTeX.
17889
17890 @item
17891  gnus-kill is much slower than it was in GNUS 4.1.3.
17892
17893 @item
17894  when expunging articles on low score, the sparse nodes keep hanging on?
17895 @item
17896  starting the first time seems to hang Gnus on some systems.  Does
17897 NEWGROUPS answer too fast?
17898 @item
17899  nndir doesn't read gzipped files.
17900 @item
17901  FAQ doesn't have an up node?
17902 @item
17903  when moving mail from a procmail spool to the crash-box,
17904 the crash-box is only appropriate to one specific group.
17905 @item
17906  `t' `t' makes X-Faces disappear.
17907 @item
17908  nnmh-be-safe means that crossposted articles will
17909 be marked as unread.
17910 @item
17911  Orphan score entries don't show on "V t" score trace
17912 @item
17913  when clearing out data, the cache data should also be reset.
17914 @item
17915  rewrite gnus-summary-limit-children to be non-recursive
17916 to avoid exceeding lisp nesting on huge groups.
17917 @item
17918  expunged articles are counted when computing scores.
17919 @item
17920  implement gnus-batch-brew-soup
17921 @item
17922  ticked articles aren't easy to read in pick mode -- `n' and
17923 stuff just skips past them.  Read articles are the same.
17924 @item
17925  topics that contain just groups with ticked
17926 articles aren't displayed.
17927 @item
17928  nndoc should always allocate unique Message-IDs.
17929 @item
17930  If there are mail groups the first time you use Gnus, Gnus'll
17931 make the mail groups killed.
17932 @item
17933  no "no news is good news" when using topics.
17934 @item
17935  when doing crosspost marking, the cache has to be consulted
17936 and articles have to be removed.
17937 @item
17938  nnweb should fetch complete articles when they are split into several
17939 parts.
17940 @item
17941  scoring on head immediate doesn't work.
17942 @item
17943  finding short score file names takes forever.
17944 @item
17945  canceling articles in foreign groups.
17946 @item
17947  nntp-open-rlogin no longer works.
17948 @item
17949  C-u C-x C-s (Summary) switches to the group buffer.
17950 @item
17951  move nnmail-split-history out to the backends.
17952 @item
17953  nnweb doesn't work properly.
17954 @item
17955  using a virtual server name as `gnus-select-method' doesn't work?
17956 @item
17957  when killing/yanking a group from one topic to another in a slave, the
17958 master will yank it first to one topic and then add it to another.
17959 Perhaps.
17960
17961 @item
17962  warn user about `=' redirection of a group in the active file?
17963 @item
17964  take over the XEmacs menubar and offer a toggle between the XEmacs
17965 bar and the Gnus bar.
17966 @item
17967 @example
17968  push active file and NOV file parsing down into C code.
17969 `(canonize-message-id id)'
17970 `(mail-parent-message-id references n)'
17971 `(parse-news-nov-line &optional dependency-hashtb)'
17972 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17973 `(parse-news-active-region beg end hashtb)'
17974
17975 @end example
17976
17977 @item
17978  nnml .overview directory with splits.
17979 @item
17980  asynchronous cache
17981 @item
17982  postponed commands.
17983 @item
17984  the selected article show have its Subject displayed in its summary line.
17985 @item
17986  when entering groups, get the real number of unread articles from
17987 the server?
17988 @item
17989  sort after gathering threads -- make false roots have the
17990 headers of the oldest orphan with a 0 article number?
17991 @item
17992  nndoc groups should inherit the score files of their parents?  Also
17993 inherit copy prompts and save files.
17994 @item
17995  command to start up Gnus (if not running) and enter a mail mode buffer.
17996 @item
17997  allow editing the group description from the group buffer
17998 for backends that support that.
17999 @item
18000 gnus-hide,show-all-topics
18001 @item
18002  groups and sub-topics should be allowed to mingle inside each topic,
18003 and not just list all subtopics at the end.
18004 @item
18005  a command to remove all read articles that are not needed to connect
18006 threads -- `gnus-summary-limit-to-sparse-unread'?
18007 @item
18008  a variable to turn off limiting/cutting of threads in the tree buffer.
18009 @item
18010  a variable to limit how many files are uudecoded.
18011 @item
18012  add zombie groups to a special "New Groups" topic.
18013 @item
18014  server mode command: close/open all connections
18015 @item
18016  put a file date in gnus-score-alist and check whether the file
18017 has been changed before using it.
18018 @item
18019  on exit from a digest group, go to the next article in the parent group.
18020 @item
18021  hide (sub)threads with low score.
18022 @item
18023  when expiring, remove all marks from expired articles.
18024 @item
18025  gnus-summary-limit-to-body
18026 @item
18027  a regexp alist that says what level groups are to be subscribed
18028 on.  Eg. -- `(("nnml:" . 1))'.
18029 @item
18030  easier interface to nnkiboze to create ephemeral groups that
18031 contain groups that match a regexp.
18032 @item
18033  allow newlines in <URL:> urls, but remove them before using
18034 the URL.
18035 @item
18036  If there is no From line, the mail backends should fudge one from the
18037 "From " line.
18038 @item
18039  fuzzy simplifying should strip all non-alpha-numerical info
18040 from subject lines.
18041 @item
18042  gnus-soup-brew-soup-with-high-scores.
18043 @item
18044  nntp-ping-before-connect
18045 @item
18046  command to check whether NOV is evil.  "list overview.fmt".
18047 @item
18048  when entering a group, Gnus should look through the score
18049 files very early for `local' atoms and set those local variables.
18050 @item
18051  message annotations.
18052 @item
18053  topics are always yanked before groups, and that's not good.
18054 @item
18055  (set-extent-property extent 'help-echo "String to display in minibuf")
18056 to display help in the minibuffer on buttons under XEmacs.
18057 @item
18058  allow group line format spec to say how many articles there
18059 are in the cache.
18060 @item
18061  AUTHINFO GENERIC
18062 @item
18063  `run-with-idle-timer' in gnus-demon.
18064 @item
18065  stop using invisible text properties and start using overlays instead
18066 @item
18067  C-c C-f C-e to add an Expires header.
18068 @item
18069  go from one group to the next; everything is expunged; go to the
18070 next group instead of going to the group buffer.
18071 @item
18072  gnus-renumber-cache -- to renumber the cache using "low" numbers.
18073 @item
18074  record topic changes in the dribble buffer.
18075 @item
18076  `nnfolder-generate-active-file' should look at the folders it
18077 finds and generate proper active ranges.
18078 @item
18079  nneething-look-in-files-for-article-heads variable to control
18080 whether nneething should sniff all files in the directories.
18081 @item
18082  gnus-fetch-article -- start Gnus, enter group, display article
18083 @item
18084  gnus-dont-move-articles-to-same-group variable when respooling.
18085 @item
18086  when messages are crossposted between several auto-expirable groups,
18087 articles aren't properly marked as expirable.
18088 @item
18089  nneething should allow deletion/moving.
18090 @item
18091  TAB on the last button should go to the first button.
18092 @item
18093  if the car of an element in `mail-split-methods' is a function,
18094 and the function returns non-nil, use that as the name of the group(s) to
18095 save mail in.
18096 @item
18097  command for listing all score files that have been applied.
18098 @item
18099  a command in the article buffer to return to `summary' config.
18100 @item
18101  `gnus-always-post-using-current-server' -- variable to override
18102 `C-c C-c' when posting.
18103 @item
18104  nnmail-group-spool-alist -- says where each group should use
18105 as a spool file.
18106 @item
18107  when an article is crossposted to an auto-expirable group, the article
18108 should be marker as expirable.
18109 @item
18110  article mode command/menu for "send region as URL to browser".
18111 @item
18112  on errors, jump to info nodes that explain the error.  For instance,
18113 on invalid From headers, or on error messages from the nntp server.
18114 @item
18115  when gathering threads, make the article that has no "Re: " the parent.
18116 Also consult Date headers.
18117 @item
18118  a token in splits to call shrink-window-if-larger-than-buffer
18119 @item
18120  `1 0 A M' to do matches on the active hashtb.
18121 @item
18122  duplicates -- command to remove Gnus-Warning header, use the read
18123 Message-ID, delete the "original".
18124 @item
18125  when replying to several messages at once, put the "other" message-ids
18126 into a See-Also header.
18127 @item
18128  support setext: URL:http://www.bsdi.com/setext/
18129 @item
18130  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
18131 @item
18132  when browsing a foreign server, the groups that are already subscribed
18133 should be listed as such and not as "K".
18134 @item
18135  generate font names dynamically.
18136 @item
18137  score file mode auto-alist.
18138 @item
18139  allow nndoc to change/add/delete things from documents.  Implement
18140 methods for each format for adding an article to the document.
18141 @item
18142  `gnus-fetch-old-headers' `all' value to incorporate
18143 absolutely all headers there is.
18144 @item
18145  function like `|', but concatenate all marked articles
18146 and pipe them to the process.
18147 @item
18148  cache the list of killed (or active) groups in a separate file.  Update
18149 the file whenever we read the active file or the list
18150 of killed groups in the .eld file reaches a certain length.
18151 @item
18152  function for starting to edit a file to put into
18153 the current mail group.
18154 @item
18155  score-find-trace should display the total score of the article.
18156 @item
18157  "ghettozie" -- score on Xref header and nix it out after using it
18158 to avoid marking as read in other groups it has been crossposted to.
18159 @item
18160  look at procmail splitting.  The backends should create
18161 the groups automatically if a spool file exists for that group.
18162 @item
18163  function for backends to register themselves with Gnus.
18164 @item
18165  when replying to several process-marked articles,
18166 have all the From end up in Cc headers?  Variable to toggle.
18167 @item
18168  command to delete a crossposted mail article from all
18169 groups it has been mailed to.
18170 @item
18171  `B c' and `B m' should be crosspost aware.
18172 @item
18173  hide-pgp should also hide PGP public key blocks.
18174 @item
18175  Command in the group buffer to respool process-marked groups.
18176 @item
18177  `gnus-summary-find-matching' should accept
18178 pseudo-"headers" like "body", "head" and "all"
18179 @item
18180  When buttifying <URL: > things, all white space (including
18181 newlines) should be ignored.
18182 @item
18183  Process-marking all groups in a topic should process-mark
18184 groups in subtopics as well.
18185 @item
18186  Add non-native groups to the list of killed groups when killing them.
18187 @item
18188  nntp-suggest-kewl-config to probe the nntp server and suggest
18189 variable settings.
18190 @item
18191  add edit and forward secondary marks.
18192 @item
18193  nnml shouldn't visit its .overview files.
18194 @item
18195  allow customizing sorting within gathered threads.
18196 @item
18197  `B q' shouldn't select the current article.
18198 @item
18199  nnmbox should support a newsgroups file for descriptions.
18200 @item
18201  allow fetching mail from several pop servers.
18202 @item
18203  Be able to specify whether the saving commands save the original
18204 or the formatted article.
18205 @item
18206  a command to reparent with the child process-marked (cf. `T ^'.).
18207 @item
18208  I think the possibility to send a password with nntp-open-rlogin
18209 should be a feature in Red Gnus.
18210 @item
18211  The `Z n' command should be possible to execute from a mouse click.
18212 @item
18213  more limiting functions -- date, etc.
18214 @item
18215  be able to limit on a random header; on body; using reverse matches.
18216 @item
18217  a group parameter (`absofucking-total-expiry') that will make Gnus expire
18218 even unread articles.
18219 @item
18220  a command to print the article buffer as postscript.
18221 @item
18222  variable to disable password fetching when opening by nntp-open-telnet.
18223 @item
18224  manual: more example servers -- nntp with rlogin, telnet
18225 @item
18226  checking for bogus groups should clean topic alists as well.
18227 @item
18228  canceling articles in foreign groups.
18229 @item
18230  article number in folded topics isn't properly updated by
18231 Xref handling.
18232 @item
18233  Movement in the group buffer to the next unread group should go to the
18234 next closed topic with unread messages if no group can be found.
18235 @item
18236  Extensive info pages generated on the fly with help everywhere --
18237 in the "*Gnus edit*" buffers, for instance.
18238 @item
18239  Topic movement commands -- like thread movement.  Up, down, forward, next.
18240 @item
18241  a way to tick/mark as read Gcc'd articles.
18242 @item
18243  a way to say that all groups within a specific topic comes
18244 from a particular server?  Hm.
18245 @item
18246  `gnus-article-fill-if-long-lines' -- a function to fill
18247 the article buffer if there are any looong lines there.
18248 @item
18249  `T h' should jump to the parent topic and fold it.
18250 @item
18251  a command to create an ephemeral nndoc group out of a file,
18252 and then splitting it/moving it to some other group/backend.
18253 @item
18254  a group parameter for nnkiboze groups that says that
18255 all kibozed articles should be entered into the cache.
18256 @item
18257  It should also probably be possible to delimit what
18258 `gnus-jog-cache' does -- for instance, work on just some groups, or on
18259 some levels, and entering just articles that have a score higher than
18260 a certain number.
18261 @item
18262  nnfolder should append to the folder instead of re-writing
18263 the entire folder to disk when accepting new messages.
18264 @item
18265  allow all backends to do the proper thing with .gz files.
18266 @item
18267  a backend for reading collections of babyl files nnbabylfolder?
18268 @item
18269  a command for making the native groups into foreign groups.
18270 @item
18271  server mode command for clearing read marks from all groups
18272 from a server.
18273 @item
18274  when following up multiple articles, include all To, Cc, etc headers
18275 from all articles.
18276 @item
18277  a command for deciding what the total score of the current
18278 thread is.  Also a way to highlight based on this.
18279 @item
18280  command to show and edit group scores
18281 @item
18282  a gnus-tree-minimize-horizontal to minimize tree buffers
18283 horizontally.
18284 @item
18285  command to generate nnml overview file for one group.
18286 @item
18287  `C-u C-u a' -- prompt for many crossposted groups.
18288 @item
18289  keep track of which mail groups have received new articles (in this session).
18290 Be able to generate a report and perhaps do some marking in the group
18291 buffer.
18292 @item
18293  gnus-build-sparse-threads to a number -- build only sparse threads
18294 that are of that length.
18295 @item
18296  have nnmh respect mh's unseen sequence in .mh_profile.
18297 @item
18298  cache the newsgroups descriptions locally.
18299 @item
18300  asynchronous posting under nntp.
18301 @item
18302  be able to control word adaptive scoring from the score files.
18303 @item
18304  a variable to make `C-c C-c' post using the "current" select method.
18305 @item
18306  `limit-exclude-low-scored-articles'.
18307 @item
18308  if `gnus-summary-show-thread' is a number, hide threads that have
18309 a score lower than this number.
18310 @item
18311  split newsgroup subscription variable up into "order" and "method".
18312 @item
18313  buttonize ange-ftp file names.
18314 @item
18315  a command to make a duplicate copy of the current article
18316 so that each copy can be edited separately.
18317 @item
18318  nnweb should allow fetching from the local nntp server.
18319 @item
18320  record the sorting done in the summary buffer so that
18321 it can be repeated when limiting/regenerating the buffer.
18322 @item
18323  nnml-generate-nov-databses should generate for
18324 all nnml servers.
18325 @item
18326  when the user does commands in the group buffer, check
18327 the modification time of the .newsrc.eld file and use
18328 ask-user-about-supersession-threat.  Also warn when trying
18329 to save .newsrc.eld and it has changed.
18330 @item
18331  M-g on a topic will display all groups with 0 articles in
18332 the topic.
18333 @item
18334  command to remove all topic stuff.
18335 @item
18336  allow exploding incoming digests when reading incoming mail
18337 and splitting the resulting digests.
18338 @item
18339  nnsoup shouldn't set the `message-' variables.
18340 @item
18341  command to nix out all nnoo state information.
18342 @item
18343  nnmail-process-alist that calls functions if group names
18344 matches an alist -- before saving.
18345 @item
18346  use buffer-invisibility-spec everywhere for hiding text.
18347 @item
18348  variable to activate each group before entering them
18349 to get the (new) number of articles.  `gnus-activate-before-entering'.
18350 @item
18351  command to fetch a Message-ID from any buffer, even
18352 starting Gnus first if necessary.
18353 @item
18354  when posting and checking whether a group exists or not, just
18355 ask the nntp server instead of relying on the active hashtb.
18356 @item
18357  buttonize the output of `C-c C-a' in an apropos-like way.
18358 @item
18359  `G p' should understand process/prefix, and allow editing
18360 of several groups at once.
18361 @item
18362  command to create an ephemeral nnvirtual group that
18363 matches some regexp(s).
18364 @item
18365  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
18366 @item
18367  it should be possible to score "thread" on the From header.
18368 @item
18369  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
18370 @item
18371  `B i' should display the article at once in the summary buffer.
18372 @item
18373  remove the "*" mark at once when unticking an article.
18374 @item
18375  `M-s' should highlight the matching text.
18376 @item
18377  when checking for duplicated mails, use Resent-Message-ID if present.
18378 @item
18379  killing and yanking groups in topics should be better.  If killing one copy
18380 of a group that exists in multiple topics, only that copy should
18381 be removed.  Yanking should insert the copy, and yanking topics
18382 should be possible to be interspersed with the other yankings.
18383 @item
18384  command for enter a group just to read the cached articles.  A way to say
18385 "ignore the nntp connection; just read from the cache."
18386 @item
18387  `X u' should decode base64 articles.
18388 @item
18389  a way to hide all "inner" cited text, leaving just the most
18390 recently cited text.
18391 @item
18392  nnvirtual should be asynchronous.
18393 @item
18394  after editing an article, gnus-original-article-buffer should
18395 be invalidated.
18396 @item
18397  there should probably be a way to make Gnus not connect to the
18398 server and just read the articles in the server
18399 @item
18400  allow a `set-default' (or something) to change the default
18401 value of nnoo variables.
18402 @item
18403  a command to import group infos from a .newsrc.eld file.
18404 @item
18405  groups from secondary servers have the entire select method
18406 listed in each group info.
18407 @item
18408  a command for just switching from the summary buffer to the group
18409 buffer.
18410 @item
18411  a way to specify that some incoming mail washing functions
18412 should only be applied to some groups.
18413 @item
18414  Message `C-f C-t' should ask the user whether to heed
18415 mail-copies-to: never.
18416 @item
18417  new group parameter -- `post-to-server' that says to post
18418 using the current server.  Also a variable to do the same.
18419 @item
18420  the slave dribble files should auto-save to the slave file names.
18421 @item
18422  a group parameter that says what articles to display on group entry, based
18423 on article marks.
18424 @item
18425  a way to visually distinguish slave Gnusae from masters.  (Whip instead
18426 of normal logo?)
18427 @item
18428  Use DJ Bernstein "From " quoting/dequoting, where applicable.
18429 @item
18430  Why is hide-citation-maybe and hide-citation different?  Also
18431 clear up info.
18432 @item
18433  group user-defined meta-parameters.
18434
18435
18436
18437 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
18438 @item
18439  I like the option for trying to retrieve the FAQ for a group and I was
18440 thinking it would be great if for those newsgroups that had archives
18441 you could also try to read the archive for that group.  Part of the
18442 problem is that archives are spread all over the net, unlike FAQs.
18443 What would be best I suppose is to find the one closest to your site.
18444
18445 In any case, there is a list of general news group archives at @*
18446 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
18447
18448
18449
18450
18451 @item
18452 @example
18453 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
18454 (add-hook 'gnus-select-group-hook
18455   (lambda ()
18456     (gnus-group-add-parameter group
18457        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
18458
18459 (defun gnus-user-format-function-d (headers)
18460   "Return the date the group was last read."
18461   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
18462       (t "")))
18463 @end example
18464
18465 @item
18466  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
18467 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
18468 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
18469 hatt forskjellige serveres startup-filer forskjellige steder.
18470
18471
18472 @item
18473 LMI> Well, nnbabyl could alter the group info to heed labels like
18474 LMI> answered and read, I guess.
18475
18476 It could also keep them updated (the same for the Status: header of
18477 unix mbox files).
18478
18479 They could be used like this:
18480
18481
18482 @example
18483 `M l <name> RET' add label <name> to current message.
18484 `M u <name> RET' remove label <name> from current message.
18485 `/ l <expr> RET' limit summary buffer according to <expr>.
18486
18487 <expr> would be a boolean expression on the labels, e.g.
18488
18489 `/ l bug & !fixed RET'
18490 @end example
18491
18492 would show all the messages which are labeled `bug' but not labeled
18493 `fixed'.
18494
18495 One could also imagine the labels being used for highlighting, or
18496 affect the summary line format.
18497
18498
18499 @item
18500 Sender: abraham@@dina.kvl.dk
18501
18502 I'd like a gnus-find-file which work like find file, except that it
18503 would recognize things that looks like messages or folders:
18504
18505 - If it is a directory containing numbered files, create an nndir
18506 summary buffer.
18507
18508 - For other directories, create a nneething summary buffer.
18509
18510 - For files matching "\\`From ", create a nndoc/mbox summary.
18511
18512 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
18513
18514 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
18515
18516 - For other files, just find them normally.
18517
18518 I'd like `nneething' to use this function, so it would work on a
18519 directory potentially containing mboxes or babyl files.
18520
18521 @item
18522 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
18523 tell him what you are doing.
18524
18525 @item
18526 Currently, I get prompted:
18527
18528 decend into sci?
18529 - type y
18530 decend into sci.something ?
18531 - type n
18532 decend into ucd?
18533
18534 The problem above is that since there is really only one subsection of
18535 science, shouldn't it prompt you for only descending sci.something?  If
18536 there was a sci.somethingelse group or section, then it should prompt
18537 for sci? first the sci.something? then sci.somethingelse?...
18538
18539 @item
18540 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
18541 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
18542 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
18543 "no.all.SCORE", osv.
18544
18545 @item
18546 What i want is for Gnus to treat any sequence or combination of the following
18547 as a single spoiler warning and hide it all, replacing it with a "Next Page"
18548 button:
18549
18550
18551 ^L's
18552
18553 more than n blank lines
18554
18555 more than m identical lines
18556 (which should be replaced with button to show them)
18557
18558 any whitespace surrounding any of the above
18559
18560
18561 @item
18562 Well, we could allow a new value to `gnus-thread-ignore-subject' --
18563 `spaces', or something.  (We could even default to that.)  And then
18564 subjects that differ in white space only could be considered the
18565 "same" subject for threading purposes.
18566
18567 @item
18568 Modes to preprocess the contents (e.g. jka-compr) use the second form
18569 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
18570 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
18571 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
18572
18573 @item
18574  Under XEmacs -- do funny article marks:
18575 tick - thumb tack
18576 killed - skull
18577 soup - bowl of soup
18578 score below - dim light bulb
18579 score over - bright light bulb
18580
18581 @item
18582 Yes. I think the algorithm is as follows:
18583
18584 @example
18585 Group-mode
18586
18587    show-list-of-articles-in-group
18588         if (key-pressed == SPACE)
18589                 if (no-more-articles-in-group-to-select)
18590                         if (articles-selected)
18591                                 start-reading-selected-articles;
18592                         junk-unread-articles;
18593                         next-group;
18594                  else
18595                         show-next-page;
18596
18597          else if (key-pressed = '.')
18598                 if (consolidated-menus)         # same as hide-thread in Gnus
18599                         select-thread-under-cursor;
18600                 else
18601                         select-article-under-cursor;
18602
18603
18604 Article-mode
18605         if (key-pressed == SPACE)
18606                 if (more-pages-in-article)
18607                         next-page;
18608                 else if (more-selected-articles-to-read)
18609                         next-article;
18610                 else
18611                         next-group;
18612 @end example
18613
18614 @item
18615 My precise need here would have been to limit files to Incoming*.
18616 One could think of some `nneething-only-files' variable, but I guess
18617 it would have been unacceptable if one was using many unrelated such
18618 nneething groups.
18619
18620 A more useful approach would be to, in response to the `G D' prompt, be
18621 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18622 the top-level directory only (in case directories would be matched by
18623 the wildcard expression).
18624
18625 @item
18626 It would be nice if it also handled
18627
18628         <URL:news://sunsite.auc.dk/>
18629
18630 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18631
18632
18633 @item
18634
18635   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18636 really well.  Each menu is 'named' by a symbol that would be on a
18637 gnus-*-menus (where * would be whatever, but at least group, summary, and
18638 article versions) variable.
18639
18640   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18641
18642   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18643 the main menubar.  This approach works really well for Emacs-W3 and VM.
18644
18645
18646 @item
18647  nndoc should take care to create unique Message-IDs for all its
18648 articles.
18649 @item
18650  gnus-score-followup-article only works when you have a summary buffer
18651 active.  Make it work when posting from the group buffer as well.
18652 (message-sent-hook).
18653 @item
18654  rewrite gnus-demon to use run-with-idle-timers.
18655
18656 @item
18657  * Enhancements to Gnus:
18658
18659   Add two commands:
18660
18661   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18662     straight to the server buffer, without opening any connections to
18663     servers first.
18664
18665   * gnus-server-read-server-newsrc--produces a buffer very similar to
18666     the group buffer, but with only groups from that server listed;
18667     quitting this buffer returns to the server buffer.
18668
18669 @item
18670  add a command to check the integrity of an nnfolder folder --
18671 go through the article numbers and see that there are no duplicates,
18672 and stuff.
18673
18674 @item
18675  `unsmileyfy-buffer' to undo smileification.
18676
18677 @item
18678  a command to give all relevant info on an article, including all
18679 secondary marks.
18680
18681 @item
18682  when doing `-request-accept-article', the backends should do
18683 the nnmail duplicate checking.
18684
18685 @item
18686  allow `message-signature-file' to be a function to return the
18687 value of the signature file.
18688
18689 @item
18690  In addition, I would love it if I could configure message-tab so that it
18691 could call `bbdb-complete-name' in other headers.  So, some sort of
18692 interface like
18693
18694 (setq message-tab-alist
18695       '((message-header-regexp message-expand-group)
18696         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
18697
18698 then you could run the relevant function to complete the information in
18699 the header
18700
18701 @item
18702  cache the newsgroups file locally to avoid reloading it all the time.
18703
18704 @item
18705  a command to import a buffer into a group.
18706
18707 @item
18708  nnweb should allow fetching by Message-ID from servers.
18709
18710 @item
18711  point in the article buffer doesn't always go to the
18712 beginning of the buffer when selecting new articles.
18713
18714 @item
18715  a command to process mark all unread articles.
18716
18717 @item
18718  `gnus-gather-threads-by-references-and-subject' -- first
18719 do gathering by references, and then go through the dummy roots and
18720 do more gathering by subject.
18721
18722 @item
18723  gnus-uu-mark-in-numerical-order -- process mark articles in
18724 article numerical order.
18725
18726 @item
18727  (gnus-thread-total-score
18728  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18729 bind to a key.
18730
18731 @item
18732  sorting by score is wrong when using sparse threads.
18733
18734 @item
18735  a command to fetch an arbitrary article -- without having to be
18736 in the summary buffer.
18737
18738 @item
18739  a new nncvs backend.  Each group would show an article, using
18740 version branches as threading, checkin date as the date, etc.
18741
18742 @item
18743  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18744 This filter allows one to construct advance queries on the Dejanews
18745 database such as specifying start and end dates, subject, author,
18746 and/or newsgroup name.
18747
18748 @item
18749  new Date header scoring type -- older, newer
18750
18751 @item
18752  use the summary toolbar in the article buffer.
18753
18754 @item
18755  a command to fetch all articles that are less than X days old.
18756
18757 @item
18758  in pick mode, `q' should save the list of selected articles in the
18759 group info.  The next time the group is selected, these articles
18760 will automatically get the process mark.
18761
18762 @item
18763  Isn't it possible to (also?) allow M-^ to automatically try the
18764 default server if it fails on the current server?  (controlled by a
18765 user variable, (nil, t, 'ask)).
18766
18767 @item
18768  make it possible to cancel articles using the select method for the
18769 current group.
18770
18771 @item
18772  `gnus-summary-select-article-on-entry' or something.  It'll default
18773 to t and will select whatever article decided by `gnus-auto-select-first'.
18774
18775 @item
18776  a new variable to control which selection commands should be unselecting.
18777 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18778 candidates.
18779
18780 @item
18781  be able to select groups that have no articles in them
18782 to be able to post in them (using the current select method).
18783
18784 @item
18785  be able to post via DejaNews.
18786
18787 @item
18788  `x' should retain any sortings that have been performed.
18789
18790 @item
18791  allow the user to specify the precedence of the secondary marks.  Also
18792 allow them to be displayed separately.
18793
18794 @item
18795  gnus-summary-save-in-pipe should concatenate the results from
18796 the processes when doing a process marked pipe.
18797
18798 @item
18799  a new match type, like Followup, but which adds Thread matches on all
18800 articles that match a certain From header.
18801
18802 @item
18803  a function that can be read from kill-emacs-query-functions to offer
18804 saving living summary buffers.
18805
18806 @item
18807  a function for selecting a particular group which will contain
18808 the articles listed in a list of article numbers/id's.
18809
18810 @item
18811  a battery of character translation functions to translate common
18812 Mac, MS (etc) characters into ISO 8859-1.
18813
18814 @example
18815 (defun article-fix-m$word ()
18816   "Fix M$Word smartquotes in an article."
18817   (interactive)
18818   (save-excursion
18819     (let ((buffer-read-only nil))
18820       (goto-char (point-min))
18821       (while (search-forward "\221" nil t)
18822         (replace-match "`" t t))
18823       (goto-char (point-min))
18824       (while (search-forward "\222" nil t)
18825         (replace-match "'" t t))
18826       (goto-char (point-min))
18827       (while (search-forward "\223" nil t)
18828         (replace-match "\"" t t))
18829       (goto-char (point-min))
18830       (while (search-forward "\224" nil t)
18831         (replace-match "\"" t t)))))
18832 @end example
18833
18834 @item
18835 @example
18836  (add-hook 'gnus-exit-query-functions
18837 '(lambda ()
18838    (if (and (file-exists-p nnmail-spool-file)
18839             (> (nnheader-file-size nnmail-spool-file) 0))
18840        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
18841        (y-or-n-p "Are you sure you want to quit Gnus? "))))
18842 @end example
18843
18844 @item
18845  allow message-default-headers to be a function.
18846
18847 @item
18848  new Date score match types -- < > = (etc) that take floating point
18849 numbers and match on the age of the article.
18850
18851 @item
18852 @example
18853 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18854 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
18855 >  > > buffer in the frame that it was called from =:-O
18856 >
18857 >  > Hm.  How do you start up Gnus?  From the toolbar or with
18858 >  > `M-x gnus-other-frame'?
18859 >
18860 >    I normally start it up from the toolbar; at
18861 > least that's the way I've caught it doing the
18862 > deed before.
18863 @end example
18864
18865 @item
18866  all commands that react to the process mark should push
18867 the current process mark set onto the stack.
18868
18869 @item
18870  gnus-article-hide-pgp
18871 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
18872 @example
18873 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18874 @end example
18875 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
18876 er min type heuristikk og langt fra alles.
18877
18878 @item
18879  `gnus-subscribe-sorted' -- insert new groups where they would have been
18880 sorted to if `gnus-group-sort-function' were run.
18881
18882 @item
18883  gnus-(group,summary)-highlight should respect any `face' text props set
18884 on the lines.
18885
18886 @item
18887  use run-with-idle-timer for gnus-demon instead of the
18888 home-brewed stuff for better reliability.
18889
18890 @item
18891  add a way to select which NoCeM type to apply -- spam, troll, etc.
18892
18893 @item
18894  nndraft-request-group should tally auto-save files.
18895
18896 @item
18897  implement nntp-retry-on-break and nntp-command-timeout.
18898
18899 @item
18900  gnus-article-highlight-limit that says when not to highlight (long)
18901 articles.
18902
18903 @item
18904  (nnoo-set SERVER VARIABLE VALUE)
18905
18906 @item
18907  nn*-spool-methods
18908
18909 @item
18910  interrupitng agent fetching of articles should save articles.
18911
18912 @item
18913  command to open a digest group, and copy all the articles there to the
18914 current group.
18915
18916 @item
18917  a variable to disable article body highlights if there's more than
18918 X characters in the body.
18919
18920 @item
18921  handle 480/381 authinfo requests separately.
18922
18923 @item
18924  include the texi/dir file in the distribution.
18925
18926 @item
18927  format spec to "tab" to a position.
18928
18929 @item
18930  Move all prompting to the new `M-n' default style.
18931
18932 @item
18933  command to display all dormant articles.
18934
18935 @item
18936  gnus-auto-select-next makeover -- list of things it should do.
18937
18938 @item
18939  a score match type that adds scores matching on From if From has replied
18940 to something someone else has said.
18941
18942 @item
18943  Read Netscape discussion groups:
18944 snews://secnews.netscape.com/netscape.communicator.unix
18945
18946 @item
18947 One command to edit the original version if an article, and one to edit
18948 the displayed version.
18949
18950 @item
18951 @kbd{T v} -- make all process-marked articles the children of the
18952 current article.
18953
18954 @item
18955 Switch from initial text to the new default text mechanism.
18956
18957 @item
18958 How about making it possible to expire local articles?  Will it be
18959 possible to make various constraints on when an article can be
18960 expired, e.g. (read), (age > 14 days), or the more interesting (read
18961 & age > 14 days)?
18962
18963 @item
18964 New limit command---limit to articles that have a certain string
18965 in the head or body.
18966
18967 @item
18968 Allow breaking lengthy NNTP commands.
18969
18970 @item
18971 gnus-article-highlight-limit, to disable highlighting in big articles.
18972
18973 @item
18974 Editing an article should put the article to be edited
18975 in a special, unique buffer.
18976
18977 @item
18978 A command to send a mail to the admin-address group param.
18979
18980 @item
18981 A Date scoring type that will match if the article
18982 is less than a certain number of days old.
18983
18984 @item
18985 New spec: %~(tab 56) to put point on column 56
18986
18987 @item
18988 Allow Gnus Agent scoring to use normal score files.
18989
18990 @item
18991 Rething the Agent active file thing.  `M-g' doesn't update the active
18992 file, for instance.
18993
18994 @item
18995 With dummy roots, `^' and then selecing the first article
18996 in any other dummy thread will make gnus highlight the
18997 dummy root instead of the first article.
18998
18999 @item
19000 Propagate all group properties (marks, article numbers, etc) up to the
19001 topics for displaying.
19002
19003 @item
19004 `n' in the group buffer with topics should go to the next group
19005 with unread articles, even if that group is hidden in a topic.
19006
19007 @item
19008 gnus-posting-styles doesn't work in drafts.
19009
19010 @item
19011 gnus-summary-limit-include-cached is slow when there are
19012 many articles in the cache, since it regenerates big parts of the
19013 summary buffer for each article.
19014
19015 @item
19016 Implement gnus-batch-brew-soup.
19017
19018 @item
19019 Group parameters and summary commands for un/subscribing to mailing
19020 lists.
19021
19022 @item
19023 Introduce nnmail-home-directory.
19024
19025 @item
19026 gnus-fetch-group and friends should exit Gnus when the user
19027 exits the group.
19028
19029 @item
19030 The jingle is only played on the second invocation of Gnus.
19031
19032 @item
19033 Bouncing articles should do MIME.
19034
19035 @item
19036 Crossposted articles should "inherit" the % or @ mark from the other
19037 groups it has been crossposted to, or something.  (Agent.)
19038
19039 @item
19040 `S D r' should allow expansion of aliases.
19041
19042 @item
19043 If point is on a group that appears multiple times in topics, and
19044 you press `l', point will move to the first instance of the group.
19045
19046 @item
19047 Fetch by Message-ID from dejanews.
19048
19049 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
19050
19051 @item
19052 A spec for the group line format to display the number of
19053 agent-downloaded articles in the group.
19054
19055 @item
19056 Some nntp servers never respond when posting, so there should be a
19057 timeout for all commands.
19058
19059 @item
19060 When stading on a topic line and `t'-ing, point goes to the last line.
19061 It should go somewhere else.
19062
19063 @item
19064 I'm having trouble accessing a newsgroup with a "+" in its name with
19065 Gnus.  There is a new newsgroup on msnews.microsoft.com named
19066 "microsoft.public.multimedia.directx.html+time" that I'm trying to
19067 access as
19068 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
19069 but it gives an error that it cant access the group.
19070
19071 Is the "+" character illegal in newsgroup names?  Is there any way in
19072 Gnus to work around this?  (gnus 5.6.45 - XEmacs 20.4)
19073
19074 @item
19075
19076 When `#F', do:
19077
19078 @example
19079 Subject: Answer to your mails 01.01.1999-01.05.1999
19080  --text follows this line--
19081 Sorry I killfiled you...
19082
19083 Under the subject "foo", you wrote on 01.01.1999:
19084 > bar
19085 Under the subject "foo1", you wrote on 01.01.1999:
19086 > bar 1
19087 @end example
19088
19089 @item
19090 Allow "orphan" scores in the Agent scoring.
19091
19092 @item
19093 @example
19094     - Edit article's summary line. 
19095     - End edit
19096     - Sort lines in buffer by subject
19097
19098     --> the old subject line appears in Summary buffer, not the one that was
19099     just changed to.
19100 @end example
19101
19102 @item
19103 Solve the halting problem.
19104
19105 @c TODO
19106 @end itemize
19107
19108 @iftex
19109
19110 @page
19111 @node The Manual
19112 @section The Manual
19113 @cindex colophon
19114 @cindex manual
19115
19116 This manual was generated from a TeXinfo file and then run through
19117 either @code{texi2dvi}
19118 @iflatex
19119 or my own home-brewed TeXinfo to \LaTeX\ transformer,
19120 and then run through @code{latex} and @code{dvips}
19121 @end iflatex
19122 to get what you hold in your hands now.
19123
19124 The following conventions have been used:
19125
19126 @enumerate
19127
19128 @item
19129 This is a @samp{string}
19130
19131 @item
19132 This is a @kbd{keystroke}
19133
19134 @item
19135 This is a @file{file}
19136
19137 @item
19138 This is a @code{symbol}
19139
19140 @end enumerate
19141
19142 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
19143 mean:
19144
19145 @lisp
19146 (setq flargnoze "yes")
19147 @end lisp
19148
19149 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
19150
19151 @lisp
19152 (setq flumphel 'yes)
19153 @end lisp
19154
19155 @samp{yes} and @code{yes} are two @emph{very} different things---don't
19156 ever get them confused.
19157
19158 @iflatex
19159 @c @head
19160 Of course, everything in this manual is of vital interest, so you should
19161 read it all.  Several times.  However, if you feel like skimming the
19162 manual, look for that gnu head you should see in the margin over
19163 there---it means that what's being discussed is of more importance than
19164 the rest of the stuff.  (On the other hand, if everything is infinitely
19165 important, how can anything be more important than that?  Just one more
19166 of the mysteries of this world, I guess.)
19167 @end iflatex
19168
19169 @end iftex
19170
19171
19172 @page
19173 @node Terminology
19174 @section Terminology
19175
19176 @cindex terminology
19177 @table @dfn
19178
19179 @item news
19180 @cindex news
19181 This is what you are supposed to use this thing for---reading news.
19182 News is generally fetched from a nearby @sc{nntp} server, and is
19183 generally publicly available to everybody.  If you post news, the entire
19184 world is likely to read just what you have written, and they'll all
19185 snigger mischievously.  Behind your back.
19186
19187 @item mail
19188 @cindex mail
19189 Everything that's delivered to you personally is mail.  Some news/mail
19190 readers (like Gnus) blur the distinction between mail and news, but
19191 there is a difference.  Mail is private.  News is public.  Mailing is
19192 not posting, and replying is not following up.
19193
19194 @item reply
19195 @cindex reply
19196 Send a mail to the person who has written what you are reading.
19197
19198 @item follow up
19199 @cindex follow up
19200 Post an article to the current newsgroup responding to the article you
19201 are reading.
19202
19203 @item backend
19204 @cindex backend
19205 Gnus gets fed articles from a number of backends, both news and mail
19206 backends.  Gnus does not handle the underlying media, so to speak---this
19207 is all done by the backends.
19208
19209 @item native
19210 @cindex native
19211 Gnus will always use one method (and backend) as the @dfn{native}, or
19212 default, way of getting news.
19213
19214 @item foreign
19215 @cindex foreign
19216 You can also have any number of foreign groups active at the same time.
19217 These are groups that use non-native non-secondary backends for getting
19218 news.
19219
19220 @item secondary
19221 @cindex secondary
19222 Secondary backends are somewhere half-way between being native and being
19223 foreign, but they mostly act like they are native.
19224
19225 @item article
19226 @cindex article
19227 A message that has been posted as news.
19228
19229 @item mail message
19230 @cindex mail message
19231 A message that has been mailed.
19232
19233 @item message
19234 @cindex message
19235 A mail message or news article
19236
19237 @item head
19238 @cindex head
19239 The top part of a message, where administrative information (etc.) is
19240 put.
19241
19242 @item body
19243 @cindex body
19244 The rest of an article.  Everything not in the head is in the
19245 body.
19246
19247 @item header
19248 @cindex header
19249 A line from the head of an article.
19250
19251 @item headers
19252 @cindex headers
19253 A collection of such lines, or a collection of heads.  Or even a
19254 collection of @sc{nov} lines.
19255
19256 @item @sc{nov}
19257 @cindex nov
19258 When Gnus enters a group, it asks the backend for the headers of all
19259 unread articles in the group.  Most servers support the News OverView
19260 format, which is more compact and much faster to read and parse than the
19261 normal @sc{head} format.
19262
19263 @item level
19264 @cindex levels
19265 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
19266 that have a lower level are ``more'' subscribed than the groups with a
19267 higher level.  In fact, groups on levels 1-5 are considered
19268 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
19269 are @dfn{killed}.  Commands for listing groups and scanning for new
19270 articles will all use the numeric prefix as @dfn{working level}.
19271
19272 @item killed groups
19273 @cindex killed groups
19274 No information on killed groups is stored or updated, which makes killed
19275 groups much easier to handle than subscribed groups.
19276
19277 @item zombie groups
19278 @cindex zombie groups
19279 Just like killed groups, only slightly less dead.
19280
19281 @item active file
19282 @cindex active file
19283 The news server has to keep track of what articles it carries, and what
19284 groups exist.  All this information in stored in the active file, which
19285 is rather large, as you might surmise.
19286
19287 @item bogus groups
19288 @cindex bogus groups
19289 A group that exists in the @file{.newsrc} file, but isn't known to the
19290 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
19291 This means that the group probably doesn't exist (any more).
19292
19293 @item activating
19294 @cindex activating groups
19295 The act of asking the server for info on a group and computing the
19296 number of unread articles is called @dfn{activating the group}.
19297 Un-activated groups are listed with @samp{*} in the group buffer.
19298
19299 @item server
19300 @cindex server
19301 A machine one can connect to and get news (or mail) from.
19302
19303 @item select method
19304 @cindex select method
19305 A structure that specifies the backend, the server and the virtual
19306 server settings.
19307
19308 @item virtual server
19309 @cindex virtual server
19310 A named select method.  Since a select method defines all there is to
19311 know about connecting to a (physical) server, taking the thing as a
19312 whole is a virtual server.
19313
19314 @item washing
19315 @cindex washing
19316 Taking a buffer and running it through a filter of some sort.  The
19317 result will (more often than not) be cleaner and more pleasing than the
19318 original.
19319
19320 @item ephemeral groups
19321 @cindex ephemeral groups
19322 Most groups store data on what articles you have read.  @dfn{Ephemeral}
19323 groups are groups that will have no data stored---when you exit the
19324 group, it'll disappear into the aether.
19325
19326 @item solid groups
19327 @cindex solid groups
19328 This is the opposite of ephemeral groups.  All groups listed in the
19329 group buffer are solid groups.
19330
19331 @item sparse articles
19332 @cindex sparse articles
19333 These are article placeholders shown in the summary buffer when
19334 @code{gnus-build-sparse-threads} has been switched on.
19335
19336 @item threading
19337 @cindex threading
19338 To put responses to articles directly after the articles they respond
19339 to---in a hierarchical fashion.
19340
19341 @item root
19342 @cindex root
19343 @cindex thread root
19344 The first article in a thread is the root.  It is the ancestor of all
19345 articles in the thread.
19346
19347 @item parent
19348 @cindex parent
19349 An article that has responses.
19350
19351 @item child
19352 @cindex child
19353 An article that responds to a different article---its parent.
19354
19355 @item digest
19356 @cindex digest
19357 A collection of messages in one file.  The most common digest format is
19358 specified by RFC1153.
19359
19360 @end table
19361
19362
19363 @page
19364 @node Customization
19365 @section Customization
19366 @cindex general customization
19367
19368 All variables are properly documented elsewhere in this manual.  This
19369 section is designed to give general pointers on how to customize Gnus
19370 for some quite common situations.
19371
19372 @menu
19373 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
19374 * Slow Terminal Connection::  You run a remote Emacs.
19375 * Little Disk Space::         You feel that having large setup files is icky.
19376 * Slow Machine::              You feel like buying a faster machine.
19377 @end menu
19378
19379
19380 @node Slow/Expensive Connection
19381 @subsection Slow/Expensive @sc{nntp} Connection
19382
19383 If you run Emacs on a machine locally, and get your news from a machine
19384 over some very thin strings, you want to cut down on the amount of data
19385 Gnus has to get from the @sc{nntp} server.
19386
19387 @table @code
19388
19389 @item gnus-read-active-file
19390 Set this to @code{nil}, which will inhibit Gnus from requesting the
19391 entire active file from the server.  This file is often v.  large.  You
19392 also have to set @code{gnus-check-new-newsgroups} and
19393 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
19394 doesn't suddenly decide to fetch the active file anyway.
19395
19396 @item gnus-nov-is-evil
19397 This one has to be @code{nil}.  If not, grabbing article headers from
19398 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
19399 support @sc{xover}; Gnus will detect this by itself.
19400 @end table
19401
19402
19403 @node Slow Terminal Connection
19404 @subsection Slow Terminal Connection
19405
19406 Let's say you use your home computer for dialing up the system that runs
19407 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
19408 possible) the amount of data sent over the wires.
19409
19410 @table @code
19411
19412 @item gnus-auto-center-summary
19413 Set this to @code{nil} to inhibit Gnus from re-centering the summary
19414 buffer all the time.  If it is @code{vertical}, do only vertical
19415 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
19416 horizontal and vertical recentering.
19417
19418 @item gnus-visible-headers
19419 Cut down on the headers included in the articles to the
19420 minimum.  You can, in fact, make do without them altogether---most of the
19421 useful data is in the summary buffer, anyway.  Set this variable to
19422 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
19423
19424 Set this hook to all the available hiding commands:
19425 @lisp
19426 (setq gnus-treat-hide-headers 'head
19427       gnus-treat-hide-signature t
19428       gnus-treat-hide-citation t)
19429 @end lisp
19430
19431 @item gnus-use-full-window
19432 By setting this to @code{nil}, you can make all the windows smaller.
19433 While this doesn't really cut down much generally, it means that you
19434 have to see smaller portions of articles before deciding that you didn't
19435 want to read them anyway.
19436
19437 @item gnus-thread-hide-subtree
19438 If this is non-@code{nil}, all threads in the summary buffer will be
19439 hidden initially.
19440
19441 @item gnus-updated-mode-lines
19442 If this is @code{nil}, Gnus will not put information in the buffer mode
19443 lines, which might save some time.
19444 @end table
19445
19446
19447 @node Little Disk Space
19448 @subsection Little Disk Space
19449 @cindex disk space
19450
19451 The startup files can get rather large, so you may want to cut their
19452 sizes a bit if you are running out of space.
19453
19454 @table @code
19455
19456 @item gnus-save-newsrc-file
19457 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
19458 only save @file{.newsrc.eld}.  This means that you will not be able to
19459 use any other newsreaders than Gnus.  This variable is @code{t} by
19460 default.
19461
19462 @item gnus-read-newsrc-file
19463 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
19464 only read @file{.newsrc.eld}.  This means that you will not be able to
19465 use any other newsreaders than Gnus.  This variable is @code{t} by
19466 default.
19467
19468 @item gnus-save-killed-list
19469 If this is @code{nil}, Gnus will not save the list of dead groups.  You
19470 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
19471 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
19472 variable to @code{nil}.  This variable is @code{t} by default.
19473
19474 @end table
19475
19476
19477 @node Slow Machine
19478 @subsection Slow Machine
19479 @cindex slow machine
19480
19481 If you have a slow machine, or are just really impatient, there are a
19482 few things you can do to make Gnus run faster.
19483
19484 Set @code{gnus-check-new-newsgroups} and
19485 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
19486
19487 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
19488 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
19489 summary buffer faster.
19490
19491
19492 @page
19493 @node Troubleshooting
19494 @section Troubleshooting
19495 @cindex troubleshooting
19496
19497 Gnus works @emph{so} well straight out of the box---I can't imagine any
19498 problems, really.
19499
19500 Ahem.
19501
19502 @enumerate
19503
19504 @item
19505 Make sure your computer is switched on.
19506
19507 @item
19508 Make sure that you really load the current Gnus version.  If you have
19509 been running @sc{gnus}, you need to exit Emacs and start it up again before
19510 Gnus will work.
19511
19512 @item
19513 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
19514 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
19515 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
19516 flee}, you have some old @file{.el} files lying around.  Delete these.
19517
19518 @item
19519 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
19520 how-to.
19521
19522 @item
19523 @vindex max-lisp-eval-depth
19524 Gnus works on many recursive structures, and in some extreme (and very
19525 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
19526 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
19527 something like that.
19528 @end enumerate
19529
19530 If all else fails, report the problem as a bug.
19531
19532 @cindex bugs
19533 @cindex reporting bugs
19534
19535 @kindex M-x gnus-bug
19536 @findex gnus-bug
19537 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
19538 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
19539 me the backtrace.  I will fix bugs, but I can only fix them if you send
19540 me a precise description as to how to reproduce the bug.
19541
19542 You really can never be too detailed in a bug report.  Always use the
19543 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
19544 a 10Kb mail each time you use it, and even if you have sent me your
19545 environment 500 times before.  I don't care.  I want the full info each
19546 time.
19547
19548 It is also important to remember that I have no memory whatsoever.  If
19549 you send a bug report, and I send you a reply, and then you just send
19550 back ``No, it's not! Moron!'', I will have no idea what you are
19551 insulting me about.  Always over-explain everything.  It's much easier
19552 for all of us---if I don't have all the information I need, I will just
19553 mail you and ask for more info, and everything takes more time.
19554
19555 If the problem you're seeing is very visual, and you can't quite explain
19556 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
19557 it somewhere it can be reached, and include the URL of the picture in
19558 the bug report.
19559
19560 If you just need help, you are better off asking on
19561 @samp{gnu.emacs.gnus}.  I'm not very helpful.
19562
19563 @cindex gnu.emacs.gnus
19564 @cindex ding mailing list
19565 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
19566 Write to @samp{ding-request@@gnus.org} to subscribe.
19567
19568
19569 @page
19570 @node Gnus Reference Guide
19571 @section Gnus Reference Guide
19572
19573 It is my hope that other people will figure out smart stuff that Gnus
19574 can do, and that other people will write those smart things as well.  To
19575 facilitate that I thought it would be a good idea to describe the inner
19576 workings of Gnus.  And some of the not-so-inner workings, while I'm at
19577 it.
19578
19579 You can never expect the internals of a program not to change, but I
19580 will be defining (in some details) the interface between Gnus and its
19581 backends (this is written in stone), the format of the score files
19582 (ditto), data structures (some are less likely to change than others)
19583 and general methods of operation.
19584
19585 @menu
19586 * Gnus Utility Functions::   Common functions and variable to use.
19587 * Backend Interface::        How Gnus communicates with the servers.
19588 * Score File Syntax::        A BNF definition of the score file standard.
19589 * Headers::                  How Gnus stores headers internally.
19590 * Ranges::                   A handy format for storing mucho numbers.
19591 * Group Info::               The group info format.
19592 * Extended Interactive::     Symbolic prefixes and stuff.
19593 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
19594 * Various File Formats::     Formats of files that Gnus use.
19595 @end menu
19596
19597
19598 @node Gnus Utility Functions
19599 @subsection Gnus Utility Functions
19600 @cindex Gnus utility functions
19601 @cindex utility functions
19602 @cindex functions
19603 @cindex internal variables
19604
19605 When writing small functions to be run from hooks (and stuff), it's
19606 vital to have access to the Gnus internal functions and variables.
19607 Below is a list of the most common ones.
19608
19609 @table @code
19610
19611 @item gnus-newsgroup-name
19612 @vindex gnus-newsgroup-name
19613 This variable holds the name of the current newsgroup.
19614
19615 @item gnus-find-method-for-group
19616 @findex gnus-find-method-for-group
19617 A function that returns the select method for @var{group}.
19618
19619 @item gnus-group-real-name
19620 @findex gnus-group-real-name
19621 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19622 name.
19623
19624 @item gnus-group-prefixed-name
19625 @findex gnus-group-prefixed-name
19626 Takes an unprefixed group name and a select method, and returns the full
19627 (prefixed) Gnus group name.
19628
19629 @item gnus-get-info
19630 @findex gnus-get-info
19631 Returns the group info list for @var{group}.
19632
19633 @item gnus-group-unread
19634 @findex gnus-group-unread
19635 The number of unread articles in @var{group}, or @code{t} if that is
19636 unknown.
19637
19638 @item gnus-active
19639 @findex gnus-active
19640 The active entry for @var{group}.
19641
19642 @item gnus-set-active
19643 @findex gnus-set-active
19644 Set the active entry for @var{group}.
19645
19646 @item gnus-add-current-to-buffer-list
19647 @findex gnus-add-current-to-buffer-list
19648 Adds the current buffer to the list of buffers to be killed on Gnus
19649 exit.
19650
19651 @item gnus-continuum-version
19652 @findex gnus-continuum-version
19653 Takes a Gnus version string as a parameter and returns a floating point
19654 number.  Earlier versions will always get a lower number than later
19655 versions.
19656
19657 @item gnus-group-read-only-p
19658 @findex gnus-group-read-only-p
19659 Says whether @var{group} is read-only or not.
19660
19661 @item gnus-news-group-p
19662 @findex gnus-news-group-p
19663 Says whether @var{group} came from a news backend.
19664
19665 @item gnus-ephemeral-group-p
19666 @findex gnus-ephemeral-group-p
19667 Says whether @var{group} is ephemeral or not.
19668
19669 @item gnus-server-to-method
19670 @findex gnus-server-to-method
19671 Returns the select method corresponding to @var{server}.
19672
19673 @item gnus-server-equal
19674 @findex gnus-server-equal
19675 Says whether two virtual servers are equal.
19676
19677 @item gnus-group-native-p
19678 @findex gnus-group-native-p
19679 Says whether @var{group} is native or not.
19680
19681 @item gnus-group-secondary-p
19682 @findex gnus-group-secondary-p
19683 Says whether @var{group} is secondary or not.
19684
19685 @item gnus-group-foreign-p
19686 @findex gnus-group-foreign-p
19687 Says whether @var{group} is foreign or not.
19688
19689 @item group-group-find-parameter
19690 @findex group-group-find-parameter
19691 Returns the parameter list of @var{group}.  If given a second parameter,
19692 returns the value of that parameter for @var{group}.
19693
19694 @item gnus-group-set-parameter
19695 @findex gnus-group-set-parameter
19696 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19697
19698 @item gnus-narrow-to-body
19699 @findex gnus-narrow-to-body
19700 Narrows the current buffer to the body of the article.
19701
19702 @item gnus-check-backend-function
19703 @findex gnus-check-backend-function
19704 Takes two parameters, @var{function} and @var{group}.  If the backend
19705 @var{group} comes from supports @var{function}, return non-@code{nil}.
19706
19707 @lisp
19708 (gnus-check-backend-function "request-scan" "nnml:misc")
19709 @result{} t
19710 @end lisp
19711
19712 @item gnus-read-method
19713 @findex gnus-read-method
19714 Prompts the user for a select method.
19715
19716 @end table
19717
19718
19719 @node Backend Interface
19720 @subsection Backend Interface
19721
19722 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19723 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
19724 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
19725 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
19726 examples of the latter we have @code{nntp-port-number} and
19727 @code{nnmbox-directory}.
19728
19729 When Gnus asks for information from a backend---say @code{nntp}---on
19730 something, it will normally include a virtual server name in the
19731 function parameters.  (If not, the backend should use the ``current''
19732 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
19733 server as its only (optional) parameter.  If this virtual server hasn't
19734 been opened, the function should fail.
19735
19736 Note that a virtual server name has no relation to some physical server
19737 name.  Take this example:
19738
19739 @lisp
19740 (nntp "odd-one"
19741       (nntp-address "ifi.uio.no")
19742       (nntp-port-number 4324))
19743 @end lisp
19744
19745 Here the virtual server name is @samp{odd-one} while the name of
19746 the physical server is @samp{ifi.uio.no}.
19747
19748 The backends should be able to switch between several virtual servers.
19749 The standard backends implement this by keeping an alist of virtual
19750 server environments that they pull down/push up when needed.
19751
19752 There are two groups of interface functions: @dfn{required functions},
19753 which must be present, and @dfn{optional functions}, which Gnus will
19754 always check for presence before attempting to call 'em.
19755
19756 All these functions are expected to return data in the buffer
19757 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19758 unfortunately named, but we'll have to live with it.  When I talk about
19759 @dfn{resulting data}, I always refer to the data in that buffer.  When I
19760 talk about @dfn{return value}, I talk about the function value returned by
19761 the function call.  Functions that fail should return @code{nil} as the
19762 return value.
19763
19764 Some backends could be said to be @dfn{server-forming} backends, and
19765 some might be said not to be.  The latter are backends that generally
19766 only operate on one group at a time, and have no concept of ``server''
19767 -- they have a group, and they deliver info on that group and nothing
19768 more.
19769
19770 In the examples and definitions I will refer to the imaginary backend
19771 @code{nnchoke}.
19772
19773 @cindex @code{nnchoke}
19774
19775 @menu
19776 * Required Backend Functions::        Functions that must be implemented.
19777 * Optional Backend Functions::        Functions that need not be implemented.
19778 * Error Messaging::                   How to get messages and report errors.
19779 * Writing New Backends::              Extending old backends.
19780 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
19781 * Mail-like Backends::                Some tips on mail backends.
19782 @end menu
19783
19784
19785 @node Required Backend Functions
19786 @subsubsection Required Backend Functions
19787
19788 @table @code
19789
19790 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19791
19792 @var{articles} is either a range of article numbers or a list of
19793 @code{Message-ID}s.  Current backends do not fully support either---only
19794 sequences (lists) of article numbers, and most backends do not support
19795 retrieval of @code{Message-ID}s.  But they should try for both.
19796
19797 The result data should either be HEADs or NOV lines, and the result
19798 value should either be @code{headers} or @code{nov} to reflect this.
19799 This might later be expanded to @code{various}, which will be a mixture
19800 of HEADs and NOV lines, but this is currently not supported by Gnus.
19801
19802 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19803 headers", in some meaning of the word.  This is generally done by
19804 fetching (at most) @var{fetch-old} extra headers less than the smallest
19805 article number in @code{articles}, and filling the gaps as well.  The
19806 presence of this parameter can be ignored if the backend finds it
19807 cumbersome to follow the request.  If this is non-@code{nil} and not a
19808 number, do maximum fetches.
19809
19810 Here's an example HEAD:
19811
19812 @example
19813 221 1056 Article retrieved.
19814 Path: ifi.uio.no!sturles
19815 From: sturles@@ifi.uio.no (Sturle Sunde)
19816 Newsgroups: ifi.discussion
19817 Subject: Re: Something very droll
19818 Date: 27 Oct 1994 14:02:57 +0100
19819 Organization: Dept. of Informatics, University of Oslo, Norway
19820 Lines: 26
19821 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19822 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19823 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19824 .
19825 @end example
19826
19827 So a @code{headers} return value would imply that there's a number of
19828 these in the data buffer.
19829
19830 Here's a BNF definition of such a buffer:
19831
19832 @example
19833 headers        = *head
19834 head           = error / valid-head
19835 error-message  = [ "4" / "5" ] 2number " " <error message> eol
19836 valid-head     = valid-message *header "." eol
19837 valid-message  = "221 " <number> " Article retrieved." eol
19838 header         = <text> eol
19839 @end example
19840
19841 If the return value is @code{nov}, the data buffer should contain
19842 @dfn{network overview database} lines.  These are basically fields
19843 separated by tabs.
19844
19845 @example
19846 nov-buffer = *nov-line
19847 nov-line   = 8*9 [ field <TAB> ] eol
19848 field      = <text except TAB>
19849 @end example
19850
19851 For a closer look at what should be in those fields,
19852 @pxref{Headers}.
19853
19854
19855 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
19856
19857 @var{server} is here the virtual server name.  @var{definitions} is a
19858 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
19859
19860 If the server can't be opened, no error should be signaled.  The backend
19861 may then choose to refuse further attempts at connecting to this
19862 server.  In fact, it should do so.
19863
19864 If the server is opened already, this function should return a
19865 non-@code{nil} value.  There should be no data returned.
19866
19867
19868 @item (nnchoke-close-server &optional SERVER)
19869
19870 Close connection to @var{server} and free all resources connected
19871 to it.  Return @code{nil} if the server couldn't be closed for some
19872 reason.
19873
19874 There should be no data returned.
19875
19876
19877 @item (nnchoke-request-close)
19878
19879 Close connection to all servers and free all resources that the backend
19880 have reserved.  All buffers that have been created by that backend
19881 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
19882 function is generally only called when Gnus is shutting down.
19883
19884 There should be no data returned.
19885
19886
19887 @item (nnchoke-server-opened &optional SERVER)
19888
19889 If @var{server} is the current virtual server, and the connection to the
19890 physical server is alive, then this function should return a
19891 non-@code{nil} vlue.  This function should under no circumstances
19892 attempt to reconnect to a server we have lost connection to.
19893
19894 There should be no data returned.
19895
19896
19897 @item (nnchoke-status-message &optional SERVER)
19898
19899 This function should return the last error message from @var{server}.
19900
19901 There should be no data returned.
19902
19903
19904 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19905
19906 The result data from this function should be the article specified by
19907 @var{article}.  This might either be a @code{Message-ID} or a number.
19908 It is optional whether to implement retrieval by @code{Message-ID}, but
19909 it would be nice if that were possible.
19910
19911 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19912 in this buffer instead of the normal data buffer.  This is to make it
19913 possible to avoid copying large amounts of data from one buffer to
19914 another, while Gnus mainly requests articles to be inserted directly
19915 into its article buffer.
19916
19917 If it is at all possible, this function should return a cons cell where
19918 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19919 the article number.  This will enable Gnus to find out what the real
19920 group and article numbers are when fetching articles by
19921 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
19922 on successful article retrieval.
19923
19924
19925 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19926
19927 Get data on @var{group}.  This function also has the side effect of
19928 making @var{group} the current group.
19929
19930 If @var{FAST}, don't bother to return useful data, just make @var{group}
19931 the current group.
19932
19933 Here's an example of some result data and a definition of the same:
19934
19935 @example
19936 211 56 1000 1059 ifi.discussion
19937 @end example
19938
19939 The first number is the status, which should be 211.  Next is the
19940 total number of articles in the group, the lowest article number, the
19941 highest article number, and finally the group name.  Note that the total
19942 number of articles may be less than one might think while just
19943 considering the highest and lowest article numbers, but some articles
19944 may have been canceled.  Gnus just discards the total-number, so
19945 whether one should take the bother to generate it properly (if that is a
19946 problem) is left as an exercise to the reader.
19947
19948 @example
19949 group-status = [ error / info ] eol
19950 error        = [ "4" / "5" ] 2<number> " " <Error message>
19951 info         = "211 " 3* [ <number> " " ] <string>
19952 @end example
19953
19954
19955 @item (nnchoke-close-group GROUP &optional SERVER)
19956
19957 Close @var{group} and free any resources connected to it.  This will be
19958 a no-op on most backends.
19959
19960 There should be no data returned.
19961
19962
19963 @item (nnchoke-request-list &optional SERVER)
19964
19965 Return a list of all groups available on @var{server}.  And that means
19966 @emph{all}.
19967
19968 Here's an example from a server that only carries two groups:
19969
19970 @example
19971 ifi.test 0000002200 0000002000 y
19972 ifi.discussion 3324 3300 n
19973 @end example
19974
19975 On each line we have a group name, then the highest article number in
19976 that group, the lowest article number, and finally a flag.
19977
19978 @example
19979 active-file = *active-line
19980 active-line = name " " <number> " " <number> " " flags eol
19981 name        = <string>
19982 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
19983 @end example
19984
19985 The flag says whether the group is read-only (@samp{n}), is moderated
19986 (@samp{m}), is dead (@samp{x}), is aliased to some other group
19987 (@samp{=other-group}) or none of the above (@samp{y}).
19988
19989
19990 @item (nnchoke-request-post &optional SERVER)
19991
19992 This function should post the current buffer.  It might return whether
19993 the posting was successful or not, but that's not required.  If, for
19994 instance, the posting is done asynchronously, it has generally not been
19995 completed by the time this function concludes.  In that case, this
19996 function should set up some kind of sentinel to beep the user loud and
19997 clear if the posting could not be completed.
19998
19999 There should be no result data from this function.
20000
20001 @end table
20002
20003
20004 @node Optional Backend Functions
20005 @subsubsection Optional Backend Functions
20006
20007 @table @code
20008
20009 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
20010
20011 @var{groups} is a list of groups, and this function should request data
20012 on all those groups.  How it does it is of no concern to Gnus, but it
20013 should attempt to do this in a speedy fashion.
20014
20015 The return value of this function can be either @code{active} or
20016 @code{group}, which says what the format of the result data is.  The
20017 former is in the same format as the data from
20018 @code{nnchoke-request-list}, while the latter is a buffer full of lines
20019 in the same format as @code{nnchoke-request-group} gives.
20020
20021 @example
20022 group-buffer = *active-line / *group-status
20023 @end example
20024
20025
20026 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
20027
20028 A Gnus group info (@pxref{Group Info}) is handed to the backend for
20029 alterations.  This comes in handy if the backend really carries all the
20030 information (as is the case with virtual and imap groups).  This
20031 function should destructively alter the info to suit its needs, and
20032 should return the (altered) group info.
20033
20034 There should be no result data from this function.
20035
20036
20037 @item (nnchoke-request-type GROUP &optional ARTICLE)
20038
20039 When the user issues commands for ``sending news'' (@kbd{F} in the
20040 summary buffer, for instance), Gnus has to know whether the article the
20041 user is following up on is news or mail.  This function should return
20042 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
20043 is mail and @code{unknown} if the type can't be decided.  (The
20044 @var{article} parameter is necessary in @code{nnvirtual} groups which
20045 might very well combine mail groups and news groups.)  Both @var{group}
20046 and @var{article} may be @code{nil}.
20047
20048 There should be no result data from this function.
20049
20050
20051 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
20052
20053 Set/remove/add marks on articles. Normally Gnus handles the article
20054 marks (such as read, ticked, expired etc) internally, and store them in
20055 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
20056 information about the articles on the server, so Gnus need to propagate
20057 the mark information to the server.
20058
20059 ACTION is a list of mark setting requests, having this format:
20060
20061 @example
20062 (RANGE ACTION MARK)
20063 @end example
20064
20065 Range is a range of articles you wish to update marks on. Action is
20066 @code{set}, @code{add} or @code{del}, respectively used for removing all
20067 existing marks and setting them as specified, adding (preserving the
20068 marks not mentioned) mark and removing (preserving the marks not
20069 mentioned) marks. Mark is a list of marks; where each mark is a
20070 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
20071 @code{expire}, @code{killed}, @code{dormant}, @code{save},
20072 @code{download} and @code{unsend}, but your backend should, if possible,
20073 not limit itself to theese.
20074
20075 Given contradictory actions, the last action in the list should be the
20076 effective one. That is, if your action contains a request to add the
20077 @code{tick} mark on article 1 and, later in the list, a request to
20078 remove the mark on the same article, the mark should in fact be removed.
20079
20080 An example action list:
20081
20082 @example
20083 (((5 12 30) 'del '(tick))
20084  ((10 . 90) 'add '(read expire))
20085  ((92 94) 'del '(read)))
20086 @end example
20087
20088 The function should return a range of articles it wasn't able to set the
20089 mark on (currently not used for anything).
20090
20091 There should be no result data from this function.
20092
20093 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
20094
20095 If the user tries to set a mark that the backend doesn't like, this
20096 function may change the mark.  Gnus will use whatever this function
20097 returns as the mark for @var{article} instead of the original
20098 @var{mark}.  If the backend doesn't care, it must return the original
20099 @var{mark}, and not @code{nil} or any other type of garbage.
20100
20101 The only use for this I can see is what @code{nnvirtual} does with
20102 it---if a component group is auto-expirable, marking an article as read
20103 in the virtual group should result in the article being marked as
20104 expirable.
20105
20106 There should be no result data from this function.
20107
20108
20109 @item (nnchoke-request-scan &optional GROUP SERVER)
20110
20111 This function may be called at any time (by Gnus or anything else) to
20112 request that the backend check for incoming articles, in one way or
20113 another.  A mail backend will typically read the spool file or query the
20114 POP server when this function is invoked.  The @var{group} doesn't have
20115 to be heeded---if the backend decides that it is too much work just
20116 scanning for a single group, it may do a total scan of all groups.  It
20117 would be nice, however, to keep things local if that's practical.
20118
20119 There should be no result data from this function.
20120
20121
20122 @item (nnchoke-request-group-description GROUP &optional SERVER)
20123
20124 The result data from this function should be a description of
20125 @var{group}.
20126
20127 @example
20128 description-line = name <TAB> description eol
20129 name             = <string>
20130 description      = <text>
20131 @end example
20132
20133 @item (nnchoke-request-list-newsgroups &optional SERVER)
20134
20135 The result data from this function should be the description of all
20136 groups available on the server.
20137
20138 @example
20139 description-buffer = *description-line
20140 @end example
20141
20142
20143 @item (nnchoke-request-newgroups DATE &optional SERVER)
20144
20145 The result data from this function should be all groups that were
20146 created after @samp{date}, which is in normal human-readable date
20147 format.  The data should be in the active buffer format.
20148
20149
20150 @item (nnchoke-request-create-group GROUP &optional SERVER)
20151
20152 This function should create an empty group with name @var{group}.
20153
20154 There should be no return data.
20155
20156
20157 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
20158
20159 This function should run the expiry process on all articles in the
20160 @var{articles} range (which is currently a simple list of article
20161 numbers.)  It is left up to the backend to decide how old articles
20162 should be before they are removed by this function.  If @var{force} is
20163 non-@code{nil}, all @var{articles} should be deleted, no matter how new
20164 they are.
20165
20166 This function should return a list of articles that it did not/was not
20167 able to delete.
20168
20169 There should be no result data returned.
20170
20171
20172 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
20173 &optional LAST)
20174
20175 This function should move @var{article} (which is a number) from
20176 @var{group} by calling @var{accept-form}.
20177
20178 This function should ready the article in question for moving by
20179 removing any header lines it has added to the article, and generally
20180 should ``tidy up'' the article.  Then it should @code{eval}
20181 @var{accept-form} in the buffer where the ``tidy'' article is.  This
20182 will do the actual copying.  If this @code{eval} returns a
20183 non-@code{nil} value, the article should be removed.
20184
20185 If @var{last} is @code{nil}, that means that there is a high likelihood
20186 that there will be more requests issued shortly, so that allows some
20187 optimizations.
20188
20189 The function should return a cons where the @code{car} is the group name and
20190 the @code{cdr} is the article number that the article was entered as.
20191
20192 There should be no data returned.
20193
20194
20195 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
20196
20197 This function takes the current buffer and inserts it into @var{group}.
20198 If @var{last} in @code{nil}, that means that there will be more calls to
20199 this function in short order.
20200
20201 The function should return a cons where the @code{car} is the group name and
20202 the @code{cdr} is the article number that the article was entered as.
20203
20204 There should be no data returned.
20205
20206
20207 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
20208
20209 This function should remove @var{article} (which is a number) from
20210 @var{group} and insert @var{buffer} there instead.
20211
20212 There should be no data returned.
20213
20214
20215 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
20216
20217 This function should delete @var{group}.  If @var{force}, it should
20218 really delete all the articles in the group, and then delete the group
20219 itself.  (If there is such a thing as ``the group itself''.)
20220
20221 There should be no data returned.
20222
20223
20224 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
20225
20226 This function should rename @var{group} into @var{new-name}.  All
20227 articles in @var{group} should move to @var{new-name}.
20228
20229 There should be no data returned.
20230
20231 @end table
20232
20233
20234 @node Error Messaging
20235 @subsubsection Error Messaging
20236
20237 @findex nnheader-report
20238 @findex nnheader-get-report
20239 The backends should use the function @code{nnheader-report} to report
20240 error conditions---they should not raise errors when they aren't able to
20241 perform a request.  The first argument to this function is the backend
20242 symbol, and the rest are interpreted as arguments to @code{format} if
20243 there are multiple of them, or just a string if there is one of them.
20244 This function must always returns @code{nil}.
20245
20246 @lisp
20247 (nnheader-report 'nnchoke "You did something totally bogus")
20248
20249 (nnheader-report 'nnchoke "Could not request group %s" group)
20250 @end lisp
20251
20252 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
20253 @code{nil} back from a server, and this function returns the most
20254 recently reported message for the backend in question.  This function
20255 takes one argument---the server symbol.
20256
20257 Internally, these functions access @var{backend}@code{-status-string},
20258 so the @code{nnchoke} backend will have its error message stored in
20259 @code{nnchoke-status-string}.
20260
20261
20262 @node Writing New Backends
20263 @subsubsection Writing New Backends
20264
20265 Many backends are quite similar.  @code{nnml} is just like
20266 @code{nnspool}, but it allows you to edit the articles on the server.
20267 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
20268 and it doesn't maintain overview databases.  @code{nndir} is just like
20269 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
20270 editing articles.
20271
20272 It would make sense if it were possible to ``inherit'' functions from
20273 backends when writing new backends.  And, indeed, you can do that if you
20274 want to.  (You don't have to if you don't want to, of course.)
20275
20276 All the backends declare their public variables and functions by using a
20277 package called @code{nnoo}.
20278
20279 To inherit functions from other backends (and allow other backends to
20280 inherit functions from the current backend), you should use the
20281 following macros:
20282
20283 @table @code
20284
20285 @item nnoo-declare
20286 This macro declares the first parameter to be a child of the subsequent
20287 parameters.  For instance:
20288
20289 @lisp
20290 (nnoo-declare nndir
20291   nnml nnmh)
20292 @end lisp
20293
20294 @code{nndir} has declared here that it intends to inherit functions from
20295 both @code{nnml} and @code{nnmh}.
20296
20297 @item defvoo
20298 This macro is equivalent to @code{defvar}, but registers the variable as
20299 a public server variable.  Most state-oriented variables should be
20300 declared with @code{defvoo} instead of @code{defvar}.
20301
20302 In addition to the normal @code{defvar} parameters, it takes a list of
20303 variables in the parent backends to map the variable to when executing
20304 a function in those backends.
20305
20306 @lisp
20307 (defvoo nndir-directory nil
20308   "Where nndir will look for groups."
20309   nnml-current-directory nnmh-current-directory)
20310 @end lisp
20311
20312 This means that @code{nnml-current-directory} will be set to
20313 @code{nndir-directory} when an @code{nnml} function is called on behalf
20314 of @code{nndir}.  (The same with @code{nnmh}.)
20315
20316 @item nnoo-define-basics
20317 This macro defines some common functions that almost all backends should
20318 have.
20319
20320 @example
20321 (nnoo-define-basics nndir)
20322 @end example
20323
20324 @item deffoo
20325 This macro is just like @code{defun} and takes the same parameters.  In
20326 addition to doing the normal @code{defun} things, it registers the
20327 function as being public so that other backends can inherit it.
20328
20329 @item nnoo-map-functions
20330 This macro allows mapping of functions from the current backend to
20331 functions from the parent backends.
20332
20333 @example
20334 (nnoo-map-functions nndir
20335   (nnml-retrieve-headers 0 nndir-current-group 0 0)
20336   (nnmh-request-article 0 nndir-current-group 0 0))
20337 @end example
20338
20339 This means that when @code{nndir-retrieve-headers} is called, the first,
20340 third, and fourth parameters will be passed on to
20341 @code{nnml-retrieve-headers}, while the second parameter is set to the
20342 value of @code{nndir-current-group}.
20343
20344 @item nnoo-import
20345 This macro allows importing functions from backends.  It should be the
20346 last thing in the source file, since it will only define functions that
20347 haven't already been defined.
20348
20349 @example
20350 (nnoo-import nndir
20351   (nnmh
20352    nnmh-request-list
20353    nnmh-request-newgroups)
20354   (nnml))
20355 @end example
20356
20357 This means that calls to @code{nndir-request-list} should just be passed
20358 on to @code{nnmh-request-list}, while all public functions from
20359 @code{nnml} that haven't been defined in @code{nndir} yet should be
20360 defined now.
20361
20362 @end table
20363
20364 Below is a slightly shortened version of the @code{nndir} backend.
20365
20366 @lisp
20367 ;;; nndir.el --- single directory newsgroup access for Gnus
20368 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
20369
20370 ;;; Code:
20371
20372 (require 'nnheader)
20373 (require 'nnmh)
20374 (require 'nnml)
20375 (require 'nnoo)
20376 (eval-when-compile (require 'cl))
20377
20378 (nnoo-declare nndir
20379   nnml nnmh)
20380
20381 (defvoo nndir-directory nil
20382   "Where nndir will look for groups."
20383   nnml-current-directory nnmh-current-directory)
20384
20385 (defvoo nndir-nov-is-evil nil
20386   "*Non-nil means that nndir will never retrieve NOV headers."
20387   nnml-nov-is-evil)
20388
20389 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
20390 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
20391 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
20392
20393 (defvoo nndir-status-string "" nil nnmh-status-string)
20394 (defconst nndir-version "nndir 1.0")
20395
20396 ;;; Interface functions.
20397
20398 (nnoo-define-basics nndir)
20399
20400 (deffoo nndir-open-server (server &optional defs)
20401   (setq nndir-directory
20402         (or (cadr (assq 'nndir-directory defs))
20403             server))
20404   (unless (assq 'nndir-directory defs)
20405     (push `(nndir-directory ,server) defs))
20406   (push `(nndir-current-group
20407           ,(file-name-nondirectory (directory-file-name nndir-directory)))
20408         defs)
20409   (push `(nndir-top-directory
20410           ,(file-name-directory (directory-file-name nndir-directory)))
20411         defs)
20412   (nnoo-change-server 'nndir server defs))
20413
20414 (nnoo-map-functions nndir
20415   (nnml-retrieve-headers 0 nndir-current-group 0 0)
20416   (nnmh-request-article 0 nndir-current-group 0 0)
20417   (nnmh-request-group nndir-current-group 0 0)
20418   (nnmh-close-group nndir-current-group 0))
20419
20420 (nnoo-import nndir
20421   (nnmh
20422    nnmh-status-message
20423    nnmh-request-list
20424    nnmh-request-newgroups))
20425
20426 (provide 'nndir)
20427 @end lisp
20428
20429
20430 @node Hooking New Backends Into Gnus
20431 @subsubsection Hooking New Backends Into Gnus
20432
20433 @vindex gnus-valid-select-methods
20434 Having Gnus start using your new backend is rather easy---you just
20435 declare it with the @code{gnus-declare-backend} functions.  This will
20436 enter the backend into the @code{gnus-valid-select-methods} variable.
20437
20438 @code{gnus-declare-backend} takes two parameters---the backend name and
20439 an arbitrary number of @dfn{abilities}.
20440
20441 Here's an example:
20442
20443 @lisp
20444 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
20445 @end lisp
20446
20447 The abilities can be:
20448
20449 @table @code
20450 @item mail
20451 This is a mailish backend---followups should (probably) go via mail.
20452 @item post
20453 This is a newsish backend---followups should (probably) go via news.
20454 @item post-mail
20455 This backend supports both mail and news.
20456 @item none
20457 This is neither a post nor mail backend---it's something completely
20458 different.
20459 @item respool
20460 It supports respooling---or rather, it is able to modify its source
20461 articles and groups.
20462 @item address
20463 The name of the server should be in the virtual server name.  This is
20464 true for almost all backends.
20465 @item prompt-address
20466 The user should be prompted for an address when doing commands like
20467 @kbd{B} in the group buffer.  This is true for backends like
20468 @code{nntp}, but not @code{nnmbox}, for instance.
20469 @end table
20470
20471
20472 @node Mail-like Backends
20473 @subsubsection Mail-like Backends
20474
20475 One of the things that separate the mail backends from the rest of the
20476 backends is the heavy dependence by the mail backends on common
20477 functions in @file{nnmail.el}.  For instance, here's the definition of
20478 @code{nnml-request-scan}:
20479
20480 @lisp
20481 (deffoo nnml-request-scan (&optional group server)
20482   (setq nnml-article-file-alist nil)
20483   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
20484 @end lisp
20485
20486 It simply calls @code{nnmail-get-new-mail} with a few parameters,
20487 and @code{nnmail} takes care of all the moving and splitting of the
20488 mail.
20489
20490 This function takes four parameters.
20491
20492 @table @var
20493 @item method
20494 This should be a symbol to designate which backend is responsible for
20495 the call.
20496
20497 @item exit-function
20498 This function should be called after the splitting has been performed.
20499
20500 @item temp-directory
20501 Where the temporary files should be stored.
20502
20503 @item group
20504 This optional argument should be a group name if the splitting is to be
20505 performed for one group only.
20506 @end table
20507
20508 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
20509 save each article.  @var{backend}@code{-active-number} will be called to
20510 find the article number assigned to this article.
20511
20512 The function also uses the following variables:
20513 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
20514 this backend); and @var{backend}@code{-group-alist} and
20515 @var{backend}@code{-active-file} to generate the new active file.
20516 @var{backend}@code{-group-alist} should be a group-active alist, like
20517 this:
20518
20519 @example
20520 (("a-group" (1 . 10))
20521  ("some-group" (34 . 39)))
20522 @end example
20523
20524
20525 @node Score File Syntax
20526 @subsection Score File Syntax
20527
20528 Score files are meant to be easily parseable, but yet extremely
20529 mallable.   It was decided that something that had the same read syntax
20530 as an Emacs Lisp list would fit that spec.
20531
20532 Here's a typical score file:
20533
20534 @lisp
20535 (("summary"
20536   ("win95" -10000 nil s)
20537   ("Gnus"))
20538  ("from"
20539   ("Lars" -1000))
20540  (mark -100))
20541 @end lisp
20542
20543 BNF definition of a score file:
20544
20545 @example
20546 score-file       = "" / "(" *element ")"
20547 element          = rule / atom
20548 rule             = string-rule / number-rule / date-rule
20549 string-rule      = "(" quote string-header quote space *string-match ")"
20550 number-rule      = "(" quote number-header quote space *number-match ")"
20551 date-rule        = "(" quote date-header quote space *date-match ")"
20552 quote            = <ascii 34>
20553 string-header    = "subject" / "from" / "references" / "message-id" /
20554                    "xref" / "body" / "head" / "all" / "followup"
20555 number-header    = "lines" / "chars"
20556 date-header      = "date"
20557 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
20558                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
20559 score            = "nil" / <integer>
20560 date             = "nil" / <natural number>
20561 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
20562                    "r" / "regex" / "R" / "Regex" /
20563                    "e" / "exact" / "E" / "Exact" /
20564                    "f" / "fuzzy" / "F" / "Fuzzy"
20565 number-match     = "(" <integer> [ "" / [ space score [ "" /
20566                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
20567 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
20568 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
20569                    space date [ "" / [ space date-match-t ] ] ] ] ")"
20570 date-match-t     = "nil" / "at" / "before" / "after"
20571 atom             = "(" [ required-atom / optional-atom ] ")"
20572 required-atom    = mark / expunge / mark-and-expunge / files /
20573                    exclude-files / read-only / touched
20574 optional-atom    = adapt / local / eval
20575 mark             = "mark" space nil-or-number
20576 nil-or-number    = "nil" / <integer>
20577 expunge          = "expunge" space nil-or-number
20578 mark-and-expunge = "mark-and-expunge" space nil-or-number
20579 files            = "files" *[ space <string> ]
20580 exclude-files    = "exclude-files" *[ space <string> ]
20581 read-only        = "read-only" [ space "nil" / space "t" ]
20582 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
20583 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
20584 local            = "local" *[ space "(" <string> space <form> ")" ]
20585 eval             = "eval" space <form>
20586 space            = *[ " " / <TAB> / <NEWLINE> ]
20587 @end example
20588
20589 Any unrecognized elements in a score file should be ignored, but not
20590 discarded.
20591
20592 As you can see, white space is needed, but the type and amount of white
20593 space is irrelevant.  This means that formatting of the score file is
20594 left up to the programmer---if it's simpler to just spew it all out on
20595 one looong line, then that's ok.
20596
20597 The meaning of the various atoms are explained elsewhere in this
20598 manual (@pxref{Score File Format}).
20599
20600
20601 @node Headers
20602 @subsection Headers
20603
20604 Internally Gnus uses a format for storing article headers that
20605 corresponds to the @sc{nov} format in a mysterious fashion.  One could
20606 almost suspect that the author looked at the @sc{nov} specification and
20607 just shamelessly @emph{stole} the entire thing, and one would be right.
20608
20609 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
20610 RFC1036 to talk about lines in the head of an article (e.g.,
20611 @code{From}).  It is used by many people as a synonym for
20612 ``head''---``the header and the body''.  (That should be avoided, in my
20613 opinion.)  And Gnus uses a format internally that it calls ``header'',
20614 which is what I'm talking about here.  This is a 9-element vector,
20615 basically, with each header (ouch) having one slot.
20616
20617 These slots are, in order: @code{number}, @code{subject}, @code{from},
20618 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
20619 @code{xref}, and @code{extra}.  There are macros for accessing and
20620 setting these slots---they all have predictable names beginning with
20621 @code{mail-header-} and @code{mail-header-set-}, respectively.
20622
20623 All these slots contain strings, except the @code{extra} slot, which
20624 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20625
20626
20627 @node Ranges
20628 @subsection Ranges
20629
20630 @sc{gnus} introduced a concept that I found so useful that I've started
20631 using it a lot and have elaborated on it greatly.
20632
20633 The question is simple: If you have a large amount of objects that are
20634 identified by numbers (say, articles, to take a @emph{wild} example)
20635 that you want to qualify as being ``included'', a normal sequence isn't
20636 very useful.  (A 200,000 length sequence is a bit long-winded.)
20637
20638 The solution is as simple as the question: You just collapse the
20639 sequence.
20640
20641 @example
20642 (1 2 3 4 5 6 10 11 12)
20643 @end example
20644
20645 is transformed into
20646
20647 @example
20648 ((1 . 6) (10 . 12))
20649 @end example
20650
20651 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20652 lonesome object, a @samp{13} is a valid element:
20653
20654 @example
20655 ((1 . 6) 7 (10 . 12))
20656 @end example
20657
20658 This means that comparing two ranges to find out whether they are equal
20659 is slightly tricky:
20660
20661 @example
20662 ((1 . 5) 7 8 (10 . 12))
20663 @end example
20664
20665 and
20666
20667 @example
20668 ((1 . 5) (7 . 8) (10 . 12))
20669 @end example
20670
20671 are equal.  In fact, any non-descending list is a range:
20672
20673 @example
20674 (1 2 3 4 5)
20675 @end example
20676
20677 is a perfectly valid range, although a pretty long-winded one.  This is
20678 also valid:
20679
20680 @example
20681 (1 . 5)
20682 @end example
20683
20684 and is equal to the previous range.
20685
20686 Here's a BNF definition of ranges.  Of course, one must remember the
20687 semantic requirement that the numbers are non-descending.  (Any number
20688 of repetition of the same number is allowed, but apt to disappear in
20689 range handling.)
20690
20691 @example
20692 range           = simple-range / normal-range
20693 simple-range    = "(" number " . " number ")"
20694 normal-range    = "(" start-contents ")"
20695 contents        = "" / simple-range *[ " " contents ] /
20696                   number *[ " " contents ]
20697 @end example
20698
20699 Gnus currently uses ranges to keep track of read articles and article
20700 marks.  I plan on implementing a number of range operators in C if The
20701 Powers That Be are willing to let me.  (I haven't asked yet, because I
20702 need to do some more thinking on what operators I need to make life
20703 totally range-based without ever having to convert back to normal
20704 sequences.)
20705
20706
20707 @node Group Info
20708 @subsection Group Info
20709
20710 Gnus stores all permanent info on groups in a @dfn{group info} list.
20711 This list is from three to six elements (or more) long and exhaustively
20712 describes the group.
20713
20714 Here are two example group infos; one is a very simple group while the
20715 second is a more complex one:
20716
20717 @example
20718 ("no.group" 5 ((1 . 54324)))
20719
20720 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20721                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20722                 (nnml "")
20723                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20724 @end example
20725
20726 The first element is the @dfn{group name}---as Gnus knows the group,
20727 anyway.  The second element is the @dfn{subscription level}, which
20728 normally is a small integer.  (It can also be the @dfn{rank}, which is a
20729 cons cell where the @code{car} is the level and the @code{cdr} is the
20730 score.)  The third element is a list of ranges of read articles.  The
20731 fourth element is a list of lists of article marks of various kinds.
20732 The fifth element is the select method (or virtual server, if you like).
20733 The sixth element is a list of @dfn{group parameters}, which is what
20734 this section is about.
20735
20736 Any of the last three elements may be missing if they are not required.
20737 In fact, the vast majority of groups will normally only have the first
20738 three elements, which saves quite a lot of cons cells.
20739
20740 Here's a BNF definition of the group info format:
20741
20742 @example
20743 info          = "(" group space ralevel space read
20744                 [ "" / [ space marks-list [ "" / [ space method [ "" /
20745                 space parameters ] ] ] ] ] ")"
20746 group         = quote <string> quote
20747 ralevel       = rank / level
20748 level         = <integer in the range of 1 to inf>
20749 rank          = "(" level "." score ")"
20750 score         = <integer in the range of 1 to inf>
20751 read          = range
20752 marks-lists   = nil / "(" *marks ")"
20753 marks         = "(" <string> range ")"
20754 method        = "(" <string> *elisp-forms ")"
20755 parameters    = "(" *elisp-forms ")"
20756 @end example
20757
20758 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
20759 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20760 in pseudo-BNF.
20761
20762 If you have a Gnus info and want to access the elements, Gnus offers a
20763 series of macros for getting/setting these elements.
20764
20765 @table @code
20766 @item gnus-info-group
20767 @itemx gnus-info-set-group
20768 @findex gnus-info-group
20769 @findex gnus-info-set-group
20770 Get/set the group name.
20771
20772 @item gnus-info-rank
20773 @itemx gnus-info-set-rank
20774 @findex gnus-info-rank
20775 @findex gnus-info-set-rank
20776 Get/set the group rank (@pxref{Group Score}).
20777
20778 @item gnus-info-level
20779 @itemx gnus-info-set-level
20780 @findex gnus-info-level
20781 @findex gnus-info-set-level
20782 Get/set the group level.
20783
20784 @item gnus-info-score
20785 @itemx gnus-info-set-score
20786 @findex gnus-info-score
20787 @findex gnus-info-set-score
20788 Get/set the group score (@pxref{Group Score}).
20789
20790 @item gnus-info-read
20791 @itemx gnus-info-set-read
20792 @findex gnus-info-read
20793 @findex gnus-info-set-read
20794 Get/set the ranges of read articles.
20795
20796 @item gnus-info-marks
20797 @itemx gnus-info-set-marks
20798 @findex gnus-info-marks
20799 @findex gnus-info-set-marks
20800 Get/set the lists of ranges of marked articles.
20801
20802 @item gnus-info-method
20803 @itemx gnus-info-set-method
20804 @findex gnus-info-method
20805 @findex gnus-info-set-method
20806 Get/set the group select method.
20807
20808 @item gnus-info-params
20809 @itemx gnus-info-set-params
20810 @findex gnus-info-params
20811 @findex gnus-info-set-params
20812 Get/set the group parameters.
20813 @end table
20814
20815 All the getter functions take one parameter---the info list.  The setter
20816 functions take two parameters---the info list and the new value.
20817
20818 The last three elements in the group info aren't mandatory, so it may be
20819 necessary to extend the group info before setting the element.  If this
20820 is necessary, you can just pass on a non-@code{nil} third parameter to
20821 the three final setter functions to have this happen automatically.
20822
20823
20824 @node Extended Interactive
20825 @subsection Extended Interactive
20826 @cindex interactive
20827 @findex gnus-interactive
20828
20829 Gnus extends the standard Emacs @code{interactive} specification
20830 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
20831 Prefixes}).  Here's an example of how this is used:
20832
20833 @lisp
20834 (defun gnus-summary-increase-score (&optional score symp)
20835   (interactive (gnus-interactive "P\ny"))
20836   ...
20837   )
20838 @end lisp
20839
20840 The best thing to do would have been to implement
20841 @code{gnus-interactive} as a macro which would have returned an
20842 @code{interactive} form, but this isn't possible since Emacs checks
20843 whether a function is interactive or not by simply doing an @code{assq}
20844 on the lambda form.  So, instead we have @code{gnus-interactive}
20845 function that takes a string and returns values that are usable to
20846 @code{interactive}.
20847
20848 This function accepts (almost) all normal @code{interactive} specs, but
20849 adds a few more.
20850
20851 @table @samp
20852 @item y
20853 @vindex gnus-current-prefix-symbol
20854 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
20855 variable.
20856
20857 @item Y
20858 @vindex gnus-current-prefix-symbols
20859 A list of the current symbolic prefixes---the
20860 @code{gnus-current-prefix-symbol} variable.
20861
20862 @item A
20863 The current article number---the @code{gnus-summary-article-number}
20864 function.
20865
20866 @item H
20867 The current article header---the @code{gnus-summary-article-header}
20868 function.
20869
20870 @item g
20871 The current group name---the @code{gnus-group-group-name}
20872 function.
20873
20874 @end table
20875
20876
20877 @node Emacs/XEmacs Code
20878 @subsection Emacs/XEmacs Code
20879 @cindex XEmacs
20880 @cindex Emacsen
20881
20882 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
20883 platforms must be the primary one.  I chose Emacs.  Not because I don't
20884 like XEmacs or Mule, but because it comes first alphabetically.
20885
20886 This means that Gnus will byte-compile under Emacs with nary a warning,
20887 while XEmacs will pump out gigabytes of warnings while byte-compiling.
20888 As I use byte-compilation warnings to help me root out trivial errors in
20889 Gnus, that's very useful.
20890
20891 I've also consistently used Emacs function interfaces, but have used
20892 Gnusey aliases for the functions.  To take an example:  Emacs defines a
20893 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
20894 function.  I then define a function called @code{gnus-run-at-time} that
20895 takes the same parameters as the Emacs @code{run-at-time}.  When running
20896 Gnus under Emacs, the former function is just an alias for the latter.
20897 However, when running under XEmacs, the former is an alias for the
20898 following function:
20899
20900 @lisp
20901 (defun gnus-xmas-run-at-time (time repeat function &rest args)
20902   (start-itimer
20903    "gnus-run-at-time"
20904    `(lambda ()
20905       (,function ,@@args))
20906    time repeat))
20907 @end lisp
20908
20909 This sort of thing has been done for bunches of functions.  Gnus does
20910 not redefine any native Emacs functions while running under XEmacs---it
20911 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
20912 all over.
20913
20914 In the cases where the XEmacs function interface was obviously cleaner,
20915 I used it instead.  For example @code{gnus-region-active-p} is an alias
20916 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
20917
20918 Of course, I could have chosen XEmacs as my native platform and done
20919 mapping functions the other way around.  But I didn't.  The performance
20920 hit these indirections impose on Gnus under XEmacs should be slight.
20921
20922
20923 @node Various File Formats
20924 @subsection Various File Formats
20925
20926 @menu
20927 * Active File Format::      Information on articles and groups available.
20928 * Newsgroups File Format::  Group descriptions.
20929 @end menu
20930
20931
20932 @node Active File Format
20933 @subsubsection Active File Format
20934
20935 The active file lists all groups available on the server in
20936 question.  It also lists the highest and lowest current article numbers
20937 in each group.
20938
20939 Here's an excerpt from a typical active file:
20940
20941 @example
20942 soc.motss 296030 293865 y
20943 alt.binaries.pictures.fractals 3922 3913 n
20944 comp.sources.unix 1605 1593 m
20945 comp.binaries.ibm.pc 5097 5089 y
20946 no.general 1000 900 y
20947 @end example
20948
20949 Here's a pseudo-BNF definition of this file:
20950
20951 @example
20952 active      = *group-line
20953 group-line  = group space high-number space low-number space flag <NEWLINE>
20954 group       = <non-white-space string>
20955 space       = " "
20956 high-number = <non-negative integer>
20957 low-number  = <positive integer>
20958 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
20959 @end example
20960
20961 For a full description of this file, see the manual pages for
20962 @samp{innd}, in particular @samp{active(5)}.
20963
20964
20965 @node Newsgroups File Format
20966 @subsubsection Newsgroups File Format
20967
20968 The newsgroups file lists groups along with their descriptions.  Not all
20969 groups on the server have to be listed,  and not all groups in the file
20970 have to exist on the server.  The file is meant purely as information to
20971 the user.
20972
20973 The format is quite simple; a group name, a tab, and the description.
20974 Here's the definition:
20975
20976 @example
20977 newsgroups    = *line
20978 line          = group tab description <NEWLINE>
20979 group         = <non-white-space string>
20980 tab           = <TAB>
20981 description   = <string>
20982 @end example
20983
20984
20985 @page
20986 @node Emacs for Heathens
20987 @section Emacs for Heathens
20988
20989 Believe it or not, but some people who use Gnus haven't really used
20990 Emacs much before they embarked on their journey on the Gnus Love Boat.
20991 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
20992 region'', and ``set @code{gnus-flargblossen} to an alist where the key
20993 is a regexp that is used for matching on the group name'' are magical
20994 phrases with little or no meaning, then this appendix is for you.  If
20995 you are already familiar with Emacs, just ignore this and go fondle your
20996 cat instead.
20997
20998 @menu
20999 * Keystrokes::      Entering text and executing commands.
21000 * Emacs Lisp::      The built-in Emacs programming language.
21001 @end menu
21002
21003
21004 @node Keystrokes
21005 @subsection Keystrokes
21006
21007 @itemize @bullet
21008 @item
21009 Q: What is an experienced Emacs user?
21010
21011 @item
21012 A: A person who wishes that the terminal had pedals.
21013 @end itemize
21014
21015 Yes, when you use Emacs, you are apt to use the control key, the shift
21016 key and the meta key a lot.  This is very annoying to some people
21017 (notably @code{vi}le users), and the rest of us just love the hell out
21018 of it.  Just give up and submit.  Emacs really does stand for
21019 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
21020 may have heard from other disreputable sources (like the Emacs author).
21021
21022 The shift keys are normally located near your pinky fingers, and are
21023 normally used to get capital letters and stuff.  You probably use it all
21024 the time.  The control key is normally marked ``CTRL'' or something like
21025 that.  The meta key is, funnily enough, never marked as such on any
21026 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
21027 which is the meta key on this keyboard.  It's usually located somewhere
21028 to the left hand side of the keyboard, usually on the bottom row.
21029
21030 Now, us Emacs people don't say ``press the meta-control-m key'',
21031 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
21032 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
21033 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
21034 down the control key, and hold it down while you press @kbd{k}''.
21035 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
21036 the control key and then press @kbd{k}''.  Simple, ay?
21037
21038 This is somewhat complicated by the fact that not all keyboards have a
21039 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
21040 means ``press escape, release escape, press @kbd{k}''.  That's much more
21041 work than if you have a meta key, so if that's the case, I respectfully
21042 suggest you get a real keyboard with a meta key.  You can't live without
21043 it.
21044
21045
21046
21047 @node Emacs Lisp
21048 @subsection Emacs Lisp
21049
21050 Emacs is the King of Editors because it's really a Lisp interpreter.
21051 Each and every key you tap runs some Emacs Lisp code snippet, and since
21052 Emacs Lisp is an interpreted language, that means that you can configure
21053 any key to run any arbitrary code.  You just, like, do it.
21054
21055 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
21056 functions.  (These are byte-compiled for speed, but it's still
21057 interpreted.)  If you decide that you don't like the way Gnus does
21058 certain things, it's trivial to have it do something a different way.
21059 (Well, at least if you know how to write Lisp code.)  However, that's
21060 beyond the scope of this manual, so we are simply going to talk about
21061 some common constructs that you normally use in your @file{.emacs} file
21062 to customize Gnus.
21063
21064 If you want to set the variable @code{gnus-florgbnize} to four (4), you
21065 write the following:
21066
21067 @lisp
21068 (setq gnus-florgbnize 4)
21069 @end lisp
21070
21071 This function (really ``special form'') @code{setq} is the one that can
21072 set a variable to some value.  This is really all you need to know.  Now
21073 you can go and fill your @code{.emacs} file with lots of these to change
21074 how Gnus works.
21075
21076 If you have put that thing in your @code{.emacs} file, it will be read
21077 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
21078 start Emacs.  If you want to change the variable right away, simply say
21079 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
21080 previous ``form'', which is a simple @code{setq} statement here.
21081
21082 Go ahead---just try it, if you're located at your Emacs.  After you
21083 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
21084 is the return value of the form you @code{eval}ed.
21085
21086 Some pitfalls:
21087
21088 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
21089 that means:
21090
21091 @lisp
21092 (setq gnus-read-active-file 'some)
21093 @end lisp
21094
21095 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
21096 @samp{nntp.ifi.uio.no}'', that means:
21097
21098 @lisp
21099 (setq gnus-nntp-server "nntp.ifi.uio.no")
21100 @end lisp
21101
21102 So be careful not to mix up strings (the latter) with symbols (the
21103 former).  The manual is unambiguous, but it can be confusing.
21104
21105 @page
21106 @include gnus-faq.texi
21107
21108 @node Index
21109 @chapter Index
21110 @printindex cp
21111
21112 @node Key Index
21113 @chapter Key Index
21114 @printindex ky
21115
21116 @summarycontents
21117 @contents
21118 @bye
21119
21120 @iftex
21121 @iflatex
21122 \end{document}
21123 @end iflatex
21124 @end iftex
21125
21126 @c End: